Skip to content

Commit 944710f

Browse files
committed
DOCS-12092: clarify --kmipServerName and KMIP server certificate
1 parent 38b5d24 commit 944710f

File tree

2 files changed

+18
-3
lines changed

2 files changed

+18
-3
lines changed

source/includes/options-mongod.yaml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2562,6 +2562,13 @@ description: |
25622562
Hostname or IP address of key management solution running a KMIP
25632563
server. Requires :setting:`enableEncryption` to be true.
25642564
2565+
When connecting to the KMIP server, the :binary:`~bin.mongod`
2566+
verifies that the specified {{role}} matches the ``SAN`` (or, if
2567+
``SAN`` is not present, the ``CN``) in the certificate presented by
2568+
the KMIP server. If ``SAN`` is present, :binary:`~bin.mongod` does
2569+
not match against the ``CN``. If the hostname does not match the
2570+
``SAN`` (or ``CN``), the :binary:`~bin.mongod` will fail to connect.
2571+
25652572
.. include:: /includes/fact-enterprise-only-admonition.rst
25662573
---
25672574
program: mongod

source/tutorial/configure-encryption.txt

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,15 +86,23 @@ To create a new key, connect :binary:`~bin.mongod` to the key manager by startin
8686

8787
.. include:: /includes/extracts/default-bind-ip-security-additional-command-line.rst
8888

89+
The following operation creates a new master key in your key manager which
90+
:binary:`~bin.mongod` uses to encrypt the keys :binary:`~bin.mongod` generates
91+
for each database.
92+
8993
.. code-block:: sh
9094

9195
mongod --enableEncryption --kmipServerName <KMIP Server HostName> \
9296
--kmipPort <KMIP server port> --kmipServerCAFile ca.pem \
9397
--kmipClientCertificateFile client.pem
9498

95-
This operation creates a new master key in your key manager which
96-
:binary:`~bin.mongod` uses to encrypt the keys :binary:`~bin.mongod` generates
97-
for each database.
99+
When connecting to the KMIP server, the :binary:`~bin.mongod` verifies
100+
that the specified :option:`--kmipServerName <mongod --kmipServerName>`
101+
matches the ``SAN`` (or, if ``SAN`` is not present, the ``CN``) in the
102+
certificate presented by the KMIP server. If ``SAN`` is present,
103+
:binary:`~bin.mongod` does not match against the ``CN``. If the
104+
hostname does not match the ``SAN`` (or ``CN``), the
105+
:binary:`~bin.mongod` will fail to connect.
98106

99107
To verify that the key creation and usage was successful, check the log
100108
file. If successful, the process will log the following messages:

0 commit comments

Comments
 (0)