Skip to content

Commit 1e326b2

Browse files
authored
DOCSP-36188 KMIP on Windows admonition (#7373)
* DOCSP-36188 KMIP on Windows admonition * internal review * external review
1 parent b1ef095 commit 1e326b2

File tree

4 files changed

+24
-5
lines changed

4 files changed

+24
-5
lines changed
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.. important::
2+
3+
Enabling encryption using a KMIP server on Windows fails when using
4+
|kmip-client-cert-file| and the KMIP server enforces TLS 1.2.
5+
6+
To enable encryption at rest with KMIP on Windows, you must:
7+
8+
- Import the client certificate into the Windows Certificate Store.
9+
- Use the |kmip-client-cert-selector| option.
10+

source/reference/configuration-options.txt

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2893,11 +2893,10 @@ Key Management Configuration Options
28932893
To use this setting, you must also specify the
28942894
:setting:`security.kmip.serverName` setting.
28952895

2896-
.. note::
2897-
2898-
Starting in 4.0, on macOS or Windows, you can use a certificate
2899-
from the operating system's secure store instead of a PEM key
2900-
file. See :setting:`security.kmip.clientCertificateSelector`.
2896+
.. |kmip-client-cert-file| replace:: ``security.kmip.clientCertificateFile``
2897+
.. |kmip-client-cert-selector| replace:: :setting:`security.kmip.clientCertificateSelector`
2898+
2899+
.. include:: /includes/enable-KMIP-on-windows.rst
29012900

29022901
.. include:: /includes/fact-enterprise-only-admonition.rst
29032902

source/reference/program/mongod.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3048,6 +3048,11 @@ Encryption Key Management Options
30483048

30493049
To use this option, you must also specify the
30503050
:option:`--kmipServerName` option.
3051+
3052+
.. |kmip-client-cert-file| replace:: ``--kmipClientCertificateFile``
3053+
.. |kmip-client-cert-selector| replace:: :option:`--kmipClientCertificateSelector`
3054+
3055+
.. include:: /includes/enable-KMIP-on-windows.rst
30513056

30523057
.. note::
30533058

source/tutorial/configure-encryption.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,11 @@ following options to start ``mongod``:
9595

9696
.. include:: /includes/extracts/default-bind-ip-security-additional-command-line.rst
9797

98+
.. |kmip-client-cert-file| replace:: :option:`--kmipClientCertificateFile`
99+
.. |kmip-client-cert-selector| replace:: :option:`--kmipClientCertificateSelector`
100+
101+
.. include:: /includes/enable-KMIP-on-windows.rst
102+
98103
The following operation creates a new master key in your key manager.
99104
``mongod`` uses the master key to encrypt the keys that ``mongod``
100105
generates for each database.

0 commit comments

Comments
 (0)