Skip to content

DOCS-12092: clarify --kmipServerName and KMIP server certificate #3484

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Nov 13, 2018
Merged

DOCS-12092: clarify --kmipServerName and KMIP server certificate #3484

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
170438b
DOCS-12092: clarify --kmipServerName and KMIP server certificate
kay-kim Nov 13, 2018
5f64552
DOCS-12092: spell out SAN and CN
kay-kim Nov 13, 2018
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
8 changes: 8 additions & 0 deletions source/includes/options-mongod.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2562,6 +2562,14 @@ description: |
Hostname or IP address of key management solution running a KMIP
server. Requires :setting:`enableEncryption` to be true.

When connecting to the KMIP server, the :binary:`~bin.mongod`
verifies that the specified {{role}} matches the Subject Alternative
Name ``SAN`` (or, if ``SAN`` is not present, the Common Name ``CN``)
in the certificate presented by the KMIP server. If ``SAN`` is
present, :binary:`~bin.mongod` does not match against the ``CN``. If
the hostname does not match the ``SAN`` (or ``CN``), the
:binary:`~bin.mongod` will fail to connect.

.. include:: /includes/fact-enterprise-only-admonition.rst
---
program: mongod
Expand Down
14 changes: 11 additions & 3 deletions source/tutorial/configure-encryption.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,15 +86,23 @@ To create a new key, connect :binary:`~bin.mongod` to the key manager by startin

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

The following operation creates a new master key in your key manager which
:binary:`~bin.mongod` uses to encrypt the keys :binary:`~bin.mongod` generates
for each database.

.. code-block:: sh

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

This operation creates a new master key in your key manager which
:binary:`~bin.mongod` uses to encrypt the keys :binary:`~bin.mongod` generates
for each database.
When connecting to the KMIP server, the :binary:`~bin.mongod` verifies
that the specified :option:`--kmipServerName <mongod --kmipServerName>`
matches the Subject Alternative Name ``SAN`` (or, if ``SAN`` is not
present, the Common Name ``CN``) in the certificate presented by the
KMIP server. If ``SAN`` is present, :binary:`~bin.mongod` does not
match against the ``CN``. If the hostname does not match the ``SAN``
(or ``CN``), the :binary:`~bin.mongod` will fail to connect.

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