Skip to content

PSMDB-1633 Documented how to check encryption status #1039

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: 7.0
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 5 additions & 9 deletions docs/data-at-rest-encryption.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,9 @@
# Data at rest encryption

Data at rest encryption for the WiredTiger storage engine in MongoDB was
introduced in MongoDB Enterprise version 3.2 to ensure that encrypted data
files can be decrypted and read by parties with the decryption key.
Data encryption at rest was introduced in Percona Server for MongoDB 3.6 to maintain compatibility with MongoDB's encryption interface. Percona Server for MongoDB does not support Amazon AWS Key Management Service (KMS). Instead, it offers the following key management integrations:

## Differences from upstream

The data encryption at rest in Percona Server for MongoDB is introduced in version 3.6 to be compatible with data encryption at rest interface in MongoDB. In the current release of Percona Server for MongoDB, the data encryption at rest does not include support for Amazon AWS key management service. Instead, Percona Server for MongoDB is [integrated with HashiCorp Vault](vault.md).

Starting with release 6.0.2-1, Percona Server for MongoDB supports the secure transfer of keys using [Key Management Interoperability Protocol (KMIP)](kmip.md). This allows users to store encryption keys in their favorite KMIP-compatible key manager when they set up encryption at rest.
* [Integration with HashiCorp Vault](vault.md) for secure key management.
* [Support of secure key transfer via the Key Management Interoperability Protocol (KMIP)](kmip.md). It allows users to store encryption keys in their favorite KMIP-compatible key manager when they set up encryption at rest.


## Workflow
Expand Down Expand Up @@ -55,7 +50,7 @@ $ mongod ... --encryptionCipherMode AES256-GCM

## Encryption of rollback files

Starting from version 3.6, Percona Server for MongoDB also encrypts rollback files when data at rest encryption is enabled. To inspect the contents of these files, use **perconadecrypt**. This is a tool that you run from the command line as follows:
Percona Server for MongoDB encrypts rollback files when data at rest encryption is enabled. To inspect the contents of these files, use **perconadecrypt**. This is a tool that you run from the command line as follows:

```{.bash data-prompt="$"}
$ perconadecrypt --encryptionKeyFile FILE --inputPath FILE --outputPath FILE [--encryptionCipherMode MODE]
Expand All @@ -75,3 +70,4 @@ the encryption. By default, the `--encryptionCipherMode` option uses the
| `--outputPath` | The path to save the decrypted rollback file |


--8<-- "encryption-status.md"
1 change: 1 addition & 0 deletions docs/kmip.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,7 @@ To enable data-at-rest encryption in Percona Server for MongoDB using KMIP, the
--kmipKeyIdentifier <kmip_identifier>
```

--8<-- "encryption-status.md"

## Upgrade considerations

Expand Down
1 change: 1 addition & 0 deletions docs/vault.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,3 +135,4 @@ If the number of secrets reaches the maximum, Percona Server for MongoDB logs an

To continue, increase the maximum versions for the secret or the entire secrets engine on the Vault server, then restart Percona Server for MongoDB. To check the number of secrets on the Vault server, ensure Percona Server for MongoDB has [read permissions for the secret’s metadata and the secrets engine configuration](#config-file-example).

--8<-- "encryption-status.md"
17 changes: 17 additions & 0 deletions snippets/encryption-status.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## Check encryption status

You can check the encryption status and the current configuration using the following command:

```{.javascript data-prompt=">"}
> db.serverStatus().encryptionAtRest
```

??? example "Expected output"

```{.text .no-copy}
{
encryptionEnabled: true,
encryptionCipherMode: 'AES256-CBC',
encryptionKeyId: 'local'
}
```