Remote Keystore
vStor 4.15 introduces support for external key management using the Key Management Interoperability Protocol (KMIP). In addition to the built-in SSH-based keystore, the system can now securely store and manage encryption passphrases in an enterprise-grade KMIP-compatible key management system. This allows your organization to integrate vStor with centralized security infrastructure while preserving existing workflows and compatibility.
Users can select the desired keystore backend β KMIP (default) or SSH (legacy) β through system preferences. When KMIP is enabled, all key management operations, including storing, retrieving, listing, and deleting passphrases, behave identically to the SSH backend. Passphrases are never stored in plaintext and remain encrypted by vStor at all times. The system provides tools to configure KMIP connection parameters, verify connectivity and permissions, and view the key status for all encrypted volumes.
To learn how to configure your remote keystore, see Encryption Keystore.
Managing Encryption Passwordsβ
Adding Passwords to Keystoreβ
You can add encryption passwords to the Encryption Keystore in two ways:
- During volume creation, switch on the Save key in Encryption Keystore toggle.
- In the key management interface for existing volumes, if the Enable encryption toggle was on during volume creation and the volume key has not been saved in the keystore.
To add a password for an existing volume:
- Navigate to System > System Settings tab > Encryption Keystore pane.
![[image expected here]](/assets/images/system-system_settings-encryption_keystore_highlighted-486b70028bb7c05d4be8b5a80a0e8e12.png)
- Click Manage keys. The Manage Keys dialog will open.
![[image expected here]](/assets/images/system-encryption_keystore-manage_keys_dialog-5d33d0eb1404d68fddbbb9eff32e5a00.png)
If the Manage keys button is disabled, configure your Encryption Keystore first. See Encryption Keystore.
- Hover over the volume for which you want to add the encryption key and click the + symbol.
The Add Encryption Key dialog will open.
![[image expected here]](/assets/images/add_encryption_key_dialog-a5411b6a96171a33c790e833a6862c75.png)
- Type the encryption key specified when creating the volume.
- Click Save.
Deleting Keys from Keystoreβ
To remove a stored key:
- Click Manage keys in the Encryption Keystore pane.
- Hover over the desired volume.
- Click the
button next to the volume name.
![[image expected here]](/assets/images/system-encryption_keystore-manage_keys_dialog-delete-c2201162c2015549a593bbba127eaf84.png)
To delete all keys, use the Delete all keys button. You will be prompted to confirm your decision.
Copying Keys from Keystoreβ
If you replicate an encrypted volume, accessing the data on the replica will require providing the key. Encryption Keystore allows you to retrieve the encryption key in case you need it to decrypt such a replica.
To retrieve an encryption key:
- Hover over the desired volume.
- Click the key symbol to retrieve the encryption key. The Retrieve Key confirmation dialog window will open.
![[image expected here]](/assets/images/system-encryption_keystore-manage_keys_dialog-retrieve-b4bacf9d2fc7d70b80ed27da8464b626.png)
- Type your vStor password and the verification code, then click Retrieve key.
![[image expected here]](/assets/images/system-encryption_keystore-manage_keys_dialog-retrieve_key_dialog_1-83b0477ba4f3fdf7e318b209e0d3fe3c.png)
- After a short while, the encryption key will be ready for retrieval. Click Copy key to copy the encryption key to clipboard, then close the dialog.
![[image expected here]](/assets/images/system-encryption_keystore-manage_keys_dialog-retrieve_key_dialog-key_retrieved-b0de496fffefbb28a1577627a588c080.png)
Resetting the Encryption Keystoreβ
To reset the Encryption Keystore, use the Reset button.
![[image expected here]](/assets/images/system_settings-encryption_keystore-reset_button_red_highlight-379e616380375809f7ec1d942babd6a4.png)
You will be prompted to confirm your choice.
![[image expected here]](/assets/images/system_settings-encryption_keystore-reset-confirm_dialog-b96f1767557e40184809a6fcad3efe8e.png)
Use the Delete all associated keys toggle to delete all keys in the Keystore. This feature requires additional confirmation with your vStor password.
Unlocking Encrypted Volumesβ
To unlock a volume whose encryption key is stored in the Encryption Keystore:
- Select the volume from the volumes list.
- Select Unlock.
The Volume Unlock dialog will open. - Instead of specifying the volumeβs encryption key, select Unlock using stored key.
![[image expected here]](/assets/images/volume_unlock-0edfad420fa3238afaf7fc00200d27d6.png)
If you prefer not to use the stored password, you can still unlock volumes by entering the encryption password manually.
Security Considerationsβ
- The Encryption Keystore must be properly configured before storing or using encryption passwords.
- Removing a password from the keystore does not affect the volumeβs encryption settings.
- All passwords stored in the Encryption Keystore are encrypted.
Always maintain secure backups of your encryption passwords, even when using the Encryption Keystore.