UPEA tool syntax and parameters

Applies to: On premises On Cloud

The UPEA tool defines the parameters of the password encryption algorithm.

UPEA syntax

The syntax of the UPEA tool is detailed in the following section:

UpdatePasswordEncryptionAlgorithm 
   -Mode [CA|CK] 
   -AlgorithmName [AES|PBKDF2]
   -ProviderName BC 
   -ProviderClass org.bouncycastle.jce.provider.BouncyCastleProvider
   -Username <OpenPagesAdministrator> 
   -Password <OpenPagesAdministrator password> 
   [-KeySize 128|256] 
   [-TempPassword <password>] 
   [-?]
Note the following recent name changes:
  • bcprov-jdk14-145.jar is bcprov-jdk15to18-1.nn.jar in 8.2.0.2 or later
  • org.bouncycastle145.jce.provider.BouncyCastleProvider is org.bouncycastle.jce.provider.BouncyCastleProvider in 8.2.0.2 or later
  • CAMCryptoBC is BC in 8.2.0.2 or later

The following table describes the parameters of the UPEA tool.

Table 1. UPEA parameters
Parameter Description
-Mode Required. Use to specify the mode in which the tool should run.

Possible modes are:

  • CA (for Change Algorithm) — used to switch the encryption algorithm from 3DES to AES or from AES to PBKDF2.
  • CK (for Change Key) — used to change the AES encryption key.
-AlgorithmName Required. Use to specify the type of encryption algorithm to use.

The valid values are AES or PBKDF2.
-ProviderName Required.

Has only one valid value: BC.
-ProviderClass Required.

Has only one valid value: org.bouncycastle.jce.provider.
BouncyCastleProvider
-Username Required. Use to specify the user name to use when you modify the user passwords. Must be the same as the user specified in the Platform|Security|Password|Encryption| Encryption Administrator setting.
-Password Required. Use to specify the password of the Encryption Administrator account.
-KeySize Optional. Use to specify the length of the encryption key.

For PBKDF2, the only valid value is 256.

For AES, the only valid value is 128.
–TempPassword Sets a temporary password for users.

When users next log in, they must use this temporary password, and then set a new password.
-? Optional. Displays the on-screen help for the UPEA tool.