Please enable JavaScript to view this site.

Manage Encryption Keys

Description

The encryption key is used to encrypt data entries (connections, private vaults, documentation and attachments). The encryption keys are generated and stored in the encryption.config file on the server only. To encrypt the data stored in the database, we use our open-source cryptography library, which can be found at https://github.com/Devolutions/devolutions-crypto.

ShieldNotice48x48

We recommend to do a backup of the SQL database before any operation that could modify the information of the SQL database (Import or Regenerate). During this operation, all users must be in offline mode or disconnected from the Devolutions Server data source to avoid data loss.

BadgeInfo48x48

The encryption keys must be the same of each Devolutions Server instances of your High Availability/Load Balancing Topology that are using the same SQL database or for a migration operation.

Export the Encryption Keys

1.Open the Devolutions Server Console.

2.Go in the Tools tab and click on the Export button.

KB4382

3.Select a destination file name and path. Then set a password to protect the file and on the OK button.

ShieldCaution48x48

We strongly recommend storing the Encryption keys file in a secure storage outside of Devolutions Server like Password Hub Business, Azure Key Vault or AWS Key Management Service.

KB4384

Import the Encryption Keys

4.Open the Devolutions Server Console on the server. Then, go in the Tools tab and click on the Import button.

KB8107

5.Select the encryption keys file, set the password and click on the OK button.

KB4387

6.Once the operation completed, the new encryption keys have been applied on the data of the database.

 

Regenerate the Encryption Keys

BadgeCaution48x48

The Regenerate operation will alter and re-encrypt the inner data of the SQL database of the Devolutions Server . This operation must be treated with the utmost care.

 

There may be scenarios where you need to regenerate the encryption keys, such as if you suspect that your data base has been breached. The following instructions explain how to complete this operation.

1.Make a full database backup and ensure this backup is fully operational.

2.Make a backup of the Devolutions Server web application folder.

3.Export the existing Encryption Keys. See above steps 1 to 3.

4.Switch the Devolutions Server instance to offline mode using the Go Offline button.

Devolutions Server Console - Go Offline

Devolutions Server Console - Go Offline

5.Go in the Tools menu and click on the Regenerate button.

Devolutions Server Console - Tools - Regenerate

Devolutions Server Console - Tools - Regenerate

6.Select a destination file name and path. Then set a password to protect the file and on the OK button.

ShieldCaution48x48

We strongly recommend storing the Encryption keys file in a secure storage outside of Devolutions Server like Password Hub Business, Azure Key Vault or AWS Key Management Service.

Backup the new Encryption Keys

Backup the new Encryption Keys

7.A last warning will be displayed before launching the Regenerate process. Click on OK to start it.

Start Regenerate process

Start Regenerate process

8.Once completed, the following process status should be displayed.

Regenerate Encryption Keys process status report

Regenerate Encryption Keys process status report

9.If any error occurs during the Regenerate process, please follow these instructions to recover the Devolutions Server instance to its previous state.

Recovering instructions

Recovering instructions