This documentation is for the end of life version of Percona Server for MongoDB and is no longer supported. You may want to see the current documentation.

HashiCorp Vault Integration

Percona Server for MongoDB is integrated with HashiCorp Vault. HashiCorp Vault supports different secrets engines. Percona Server for MongoDB only supports the HashiCorp Vault back end with KV Secrets Engine - Version 2 (API) with versioning enabled.

See also

Percona Blog: Using Vault to Store the Master Key for Data at Rest Encryption on Percona Server for MongoDB

HashiCorp Vault Documentation: How to configure the KV Engine

HashiCorp Vault Parameters

Command line	Config file	Type	Description
vaultServerName	security.vault.serverName	string	The IP address of the Vault server
vaultPort	security.vault.port	int	The port on the Vault server
vaultTokenFile	security.vault.tokenFile	string	The path to the vault token file. The token file is used by MongoDB to access HashiCorp Vault. The vault token file consists of the raw vault token and does not include any additional strings or parameters. Example of a vault token file: s.uTrHtzsZnEE7KyHeA797CkWA
vaultSecret	security.vault.secret	string	The path to the vault secret. Every replica set member must have its own distinct vault secret. It is recommended to use different secret paths for every database node. Note that vault secrets path format must be: <vault_secret_mount>/data/<custom_path> where: <vault_secret_mount> is your Vault KV Secrets Engine; data is the mandatory path prefix required by Version 2 API; <custom_path> is your secrets path Example: secret_v2/data/psmdb-test/rs1-27017
vaultRotateMasterKey	security.vault.rotateMasterKey	switch	Enables master key rotation
vaultServerCAFile	security.vault.serverCAFile	string	The path to the TLS certificate file
vaultDisableTLSForTesting	security.vault.disableTLSForTesting	switch	Disables secure connection to HashiCorp Vault using SSL/TLS client certificates

Config file example

security:
  enableEncryption: true
  vault:
    serverName: 127.0.0.1
    port: 8200
    tokenFile: /home/user/path/token
    secret: secret/data/hello

During the first run of the Percona Server for MongoDB, the process generates a secure key and writes the key to the vault.

During the subsequent start, the server tries to read the master key from the vault. If the configured secret does not exist, vault responds with HTTP 404 error.

Namespaces

Namespaces are isolated environments in Vault that allow for separate secret key and policy management.

You can use Vault namespaces with Percona Server for MongoDB. Specify the namespace(s) for the security.vault.secret option value as follows:

<namespace>/secret/data/<secret_path>

For example, the path to secret keys for namespace test on the secrets engine secret will be test/secret/<my_secret_path>.

Note

You have the following options of how to target a particular namespace when configuring Vault:

1. Set the VAULT_NAMESPACE environment variable so that all subsequent commands are executed against that namespace. Use the following command to set the environment variable for the namespace test:

$ export VAULT_NAMESPACE=test

2. Provide the namespace with the -namespace flag in commands

See also

HashiCorp Vault Documentation:

• Namespaces

  https://www.vaultproject.io/docs/enterprise/namespaces

• Secure Multi-Tenancy with Namespaces

  https://learn.hashicorp.com/tutorials/vault/namespaces

Key Rotation

Key rotation is replacing the old master key with a new one. This process helps to comply with regulatory requirements.

To rotate the keys for a single mongod instance, do the following:

1. Stop the mongod process

2. Add --vaultRotateMasterKey option via the command line or security.vault.rotateMasterKey to the config file.

3. Run the mongod process with the selected option, the process will perform the key rotation and exit.

4. Remove the selected option from the startup command or the config file.

5. Start mongod again.

Rotating the master key process also re-encrypts the keystore using the new master key. The new master key is stored in the vault. The entire dataset is not re-encrypted.

Key rotation in replica sets

Every mongod node in a replica set must have its own master key. The key rotation steps are the following:

1. Rotate the master key for the secondary nodes one by one.

2. Step down the primary and wait for another primary to be elected.

3. Rotate the master key for the previous primary node.