Skip to content

Commit 772fe49

Browse files
DOCSP-33129 Recommend keyVersion field for dataKeyOpts with Azure KV (#4960) (#5121)
* Recommended usage of keyVersion field for dataKeyOpts when using Azure as the KMS * Moved disclaimer after table rather than within * Externalized Azure KV warning to an include * Fixed MongoDB to Azure KV for which performs encryption
1 parent 02bb691 commit 772fe49

File tree

4 files changed

+17
-4
lines changed

4 files changed

+17
-4
lines changed

source/core/queryable-encryption/fundamentals/manage-keys.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ Procedure
6868
documentation:
6969

7070
- AWS: `Rotating AWS KMS Keys <https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html>`__
71-
- Azure: `Configure cryptographic key auto-rotation in Azure key
72-
vault <https://learn.microsoft.com/en-us/azure/key-vault/keys/how-to-configure-key-rotation>`__
71+
- Azure: `Configure cryptographic key auto-rotation in Azure Key
72+
Vault <https://learn.microsoft.com/en-us/azure/key-vault/keys/how-to-configure-key-rotation>`__
7373
- GCP: `Rotate a key <https://cloud.google.com/kms/docs/rotate-key>`__
7474

7575
Once you rotate the {+cmk-abbr+}, MongoDB uses it to wrap all new
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. warning::
2+
3+
If you do not include a ``keyVersion`` field, {+azure-kv+} attempts
4+
to decrypt {+dek-long+}s using the latest {+cmk-long+}. If you
5+
rotate the {+cmk-abbr+} but do not :ref:`rewrap the
6+
{+dek-long+}s <qe-fundamentals-manage-keys>` with the new
7+
master key, attempting to decrypt an existing {+dek-abbr+}
8+
fails, since the {+dek-abbr+} is encrypted with the previous
9+
version of the {+cmk-abbr+}.

source/includes/queryable-encryption/reference/kms-providers/azure.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,11 @@ Azure Key Vault:
6868
- Name of the master key
6969

7070
* - keyVersion
71-
- No
71+
- No, but strongly recommended
7272
- Version of the master key
7373

7474
* - keyVaultEndpoint
7575
- Yes
7676
- URL of the key vault. E.g. myVaultName.vault.azure.net
77+
78+
.. include:: /includes/queryable-encryption/qe-csfle-warning-azure-keyversion.rst

source/includes/reference/kms-providers/azure.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,11 @@ Azure Key Vault:
6868
- Name of the master key
6969

7070
* - keyVersion
71-
- No
71+
- No, but strongly recommended
7272
- Version of the master key
7373

7474
* - keyVaultEndpoint
7575
- Yes
7676
- URL of the key vault. E.g. myVaultName.vault.azure.net
77+
78+
.. include:: /includes/queryable-encryption/qe-csfle-warning-azure-keyversion.rst

0 commit comments

Comments
 (0)