Skip to main content
Before performing the following steps, install the CyberArk PAS solution. For instructions, refer to the CyberArk online documentation: https://docs.cyberark.com/Product-Doc/OnlineHelp/PAS/Latest/en/Content/PAS%20INST/InstallationOverview.htm
After you install and start the CyberArk Vault, you can generate a new Server Key on the KMES Series 3. The Server Key opens the Vault, similarly to the key of a physical vault. Use the key to start the Vault, and remove it until you need to restart the server. When you stop the Vault, the information stored in the Vault is completely inaccessible without that key.

​
Configure the Vault initially

Perform the following steps to configure the Vault initially:
1
To use a KMES-attached to the network, configure the firewall to allow communication to the KMES device. In DBParm.ini, configure the AllowNonStandardFWAdresses parameter to open the firewall and allow access to the device, as shown in this example:
None
AllowNonStandardFWAddresses=[HSM-IP],Yes,1024:inbound/tcp,1024:outbound/tcp
If you use a cloud KMES that is accessible through the internet (rather than a physical KMES connected to the local network), do not define AllowNonStandardFWAddresses in the DBParm.ini file.
2
Configure the PKCS #11 provider DLL and specify it in the PKCS11ProviderPath parameter in DBParm.ini, as shown:
None
PKCS11ProviderPath=<path to PKCS#11 provider dll>
3
Save DBParm.ini and close it.
4
Define the PIN/passphrase that the Vault uses when accessing a KMES device. From a command line, run the following command, specifying the password of the identity created on the KMES for this integration:
Shell
CAVaultManager SecureSecretFiles /SecretType HSM /Secret <hsmpincode>
Replace <hsmpincode> with the password of the identity created on the KMES for this integration.
The PIN/passphrase cannot being with ”/”
5
Open DBParm.ini and ensure you added the HSMPinCode parameter with the encrypted value of the PIN/passcode.
6
Restart the PrivateArk server to apply the new firewall rules.
7
Shut down the PrivateArk server.

​
Load the Server Key into the KMES Series 3

The following process installs and stores the Server Key on the KMES Series 3. After you complete this process, the Server Key is stored as a non-exportable key on the KMES, and the Vault can use it.

​
Generate the Server key

Perform the following steps to generate the Server key in the KMES:
1
Ensure that the Vault Server is stopped.
2
Run the following CAVaultManager command to generate the server key on the KMES:
Shell
CAVaultManager.exe GenerateKeyOnHSM /ServerKey
This command generates a new key for the Vault server, stores it in the KMES Series 3, and returns the key generation keyword. For example: HSM#5.Each time you create a key generation, the keyword allocated is one number higher than the current server key generation specified in DBParm.ini. To create additional key generations successfully, you must manually delete the first generation of the server key. Otherwise, an error occurs. If the ServerKey parameter in the CAVaultManager command specifies a path instead of an HSM keyword, the first key generation is created (such as HSM#1).
3
Re-encrypt the Vault data and metadata with the newly generated keys on the KMES. Run the following ChangeServerKeys command to change the encryption keys used for the Vault server:
Shell
ChangeServerKeys PathToKeys PathToEmergencyFile HSMKeyword
For example, the following command re-encrypts the Vault data and metadata with the encryption keys in K:\PrivateArk\Keys, and the HSM#1 key becomes the server key.
None
ChangeServerKeys K:\PrivateArk\Keys K:\PrivateArk\Keys\VaultEmergency.pass HSM#1
4
Open DBParm.ini and specify in the ServerKey parameter the value of the key generation version returned by the preceding CAVaultManager command, as shown in the following output example:
None
ServerKey=HSM#1
5
Start the Vault server and make sure you can log into the Vault.