Skip to content

Commit 0eee3f6

Browse files
Isabella Siukay-kim
authored andcommitted
DOCS-11908 Alias server options starting with 'ssl' to parameters starting with 'tls'
1 parent a03308a commit 0eee3f6

File tree

6 files changed

+755
-14
lines changed

6 files changed

+755
-14
lines changed
Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
ref: tls-facts-x509-invalid-certificate
2+
content: |
3+
4+
If you specify
5+
``--tlsAllowInvalidCertificates`` or ``tls.allowInvalidCertificates:
6+
true`` when using x.509 authentication, an invalid certificate is
7+
only sufficient to establish a TLS connection but is
8+
*insufficient* for authentication.
9+
10+
---
11+
# This is separate from the mongo shell ca file extract since the version is different.
12+
ref: tls-facts-ca-file
13+
content: |
14+
15+
If ``--tlsCAFile`` or ``tls.CAFile`` is not
16+
specified and you are not using x.509 authentication, the
17+
system-wide CA certificate store will be used when connecting to an
18+
TLS-enabled server.
19+
20+
.. include:: /includes/extracts/tls-facts-x509-ca-file.rst
21+
22+
---
23+
ref: tls-facts-x509-ca-file
24+
content: |
25+
26+
If using x.509 authentication, ``--tlsCAFile`` or ``tls.CAFile``
27+
must be specified unless using :option:`--tlsCertificateSelector <mongod --tlsCertificateSelector>`.
28+
29+
---
30+
ref: tls-facts-see-more
31+
content: |
32+
For more information about TLS and MongoDB, see
33+
:doc:`/tutorial/configure-ssl` and
34+
:doc:`/tutorial/configure-ssl-clients` .
35+
---
36+
# This is separate from the mongod/mongos ca file extract since the version is different.
37+
ref: tls-facts-mongo-shell-ca
38+
content: |
39+
40+
If ``--tlsCAFile`` or ``tls.CAFile`` is
41+
not specified, the system-wide CA certificate store will be used
42+
when connecting to an TLS-enabled server. In previous versions
43+
of MongoDB, the :binary:`~bin.mongo` shell exited with an error that
44+
it could not validate the certificate.
45+
46+
.. include:: /includes/extracts/tls-facts-x509-ca-file.rst
47+
---
48+
ref: tls-facts-invalid-cert-warning-clients
49+
content: |
50+
51+
.. warning::
52+
53+
For TLS connections to :binary:`~bin.mongod` and
54+
:binary:`~bin.mongos`, avoid using
55+
``--tlsAllowInvalidCertificates`` if possible and only use
56+
``--tlsAllowInvalidCertificates`` on systems where intrusion is
57+
not possible.
58+
59+
If the :binary:`~bin.mongo` shell (and other
60+
:ref:`mongodb-tools-support-tls`) runs with the
61+
``--tlsAllowInvalidCertificates`` option, the
62+
:binary:`~bin.mongo` shell (and other
63+
:ref:`mongodb-tools-support-tls`) will not attempt to validate
64+
the server certificates. This creates a vulnerability to expired
65+
:binary:`~bin.mongod` and :binary:`~bin.mongos` certificates as
66+
well as to foreign processes posing as valid
67+
:binary:`~bin.mongod` or :binary:`~bin.mongos` instances.
68+
If you only need to disable the validation of the hostname in
69+
the TLS certificates, see ``--tlsAllowInvalidHostnames``.
70+
71+
---
72+
ref: tls-facts-mongo-tls-options-configure
73+
content: |
74+
75+
To connect to a :binary:`~bin.mongod` or :binary:`~bin.mongos` that
76+
uses TLS, you must also specify the ``--host`` option for the
77+
:binary:`~bin.mongo` shell if you haven't specified a connect
78+
string. The :binary:`~bin.mongo` shell verifies that the hostname of
79+
the :binary:`~bin.mongod` or :binary:`~bin.mongos` matches the CN or
80+
SAN of ``--tlsPEMKeyFile`` certificate presented by the
81+
:binary:`~bin.mongod` or :binary:`~bin.mongos`. If the hostname does
82+
not match the CN/SAN, :binary:`~bin.mongo` will fail to connect.
83+
---
84+
ref: tls-facts-certificate-selector-properties
85+
content: |
86+
87+
.. list-table::
88+
:header-rows: 1
89+
90+
* - Property
91+
- Value type
92+
- Description
93+
94+
* - ``subject``
95+
- ASCII string
96+
- Subject name or common name on certificate
97+
98+
* - ``thumbprint``
99+
- hex string
100+
101+
- A sequence of bytes, expressed as hexadecimal, used to
102+
identify a public key by its SHA-1 digest.
103+
104+
The ``thumbprint`` is sometimes referred to as a
105+
``fingerprint``.
106+
107+
...

0 commit comments

Comments
 (0)