Skip to content

Commit 7087350

Browse files
committed
DOCS-11363: clarify TLS
1 parent ac0ea12 commit 7087350

18 files changed

+78
-77
lines changed

source/administration/production-notes.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -637,8 +637,8 @@ the MongoDB log:
637637

638638
.. code-block:: none
639639

640-
<path to SSL libs>/libssl.so.<version>: no version information available (required by /usr/bin/mongod)
641-
<path to SSL libs>/libcrypto.so.<version>: no version information available (required by /usr/bin/mongod)
640+
<path to TLS/SSL libs>/libssl.so.<version>: no version information available (required by /usr/bin/mongod)
641+
<path to TLS/SSL libs>/libcrypto.so.<version>: no version information available (required by /usr/bin/mongod)
642642

643643
These warnings indicate that the system's TLS/SSL libraries are different
644644
from the TLS/SSL libraries that the :binary:`~bin.mongod` was compiled against.

source/core/security-transport-encryption.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,17 @@ MongoDB supports TLS/SSL (Transport Layer Security/Secure Sockets Layer)
1919
to encrypt all of MongoDB's network traffic. TLS/SSL ensures that MongoDB
2020
network traffic is only readable by the intended client.
2121

22-
MongoDB TLS/SSL implementation uses OpenSSL libraries. MongoDB's SSL
23-
encryption only allows use of strong SSL ciphers with a minimum of
22+
MongoDB TLS/SSL implementation uses OpenSSL libraries. MongoDB's TLS/SSL
23+
encryption only allows use of strong TLS/SSL ciphers with a minimum of
2424
128-bit key length for all connections.
2525

2626
Certificates
2727
------------
2828

29-
Before you can use SSL, you must have a :file:`.pem` file containing a
29+
Before you can use TLS/SSL, you must have a :file:`.pem` file containing a
3030
public key certificate and its associated private key.
3131

32-
MongoDB can use any valid SSL certificate issued by a certificate
32+
MongoDB can use any valid TLS/SSL certificate issued by a certificate
3333
authority or a self-signed certificate. If you use a self-signed
3434
certificate, although the communications channel will be encrypted,
3535
there will be *no* validation of server identity. Although such a
@@ -43,7 +43,7 @@ For example, see :doc:`/tutorial/configure-ssl-clients`.
4343
Identity Verification
4444
---------------------
4545

46-
In addition to encrypting connections, SSL allows for authentication
46+
In addition to encrypting connections, TLS/SSL allows for authentication
4747
using certificates, both for :doc:`client authentication
4848
</core/authentication>` and for :doc:`internal authentication
4949
</core/security-internal-authentication>` of members of replica sets and

source/includes/extracts-mongo-ssl-options-base.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ content: |
1919
2020
.. warning::
2121
22-
For SSL connections (``--ssl``) to :binary:`~bin.mongod` and
22+
For TLS/SSL connections (``--ssl``) to :binary:`~bin.mongod` and
2323
:binary:`~bin.mongos`, if the {{program}} runs with the
2424
``--sslAllowInvalidCertificates`` option , the {{program}} will
2525
not attempt to validate the server certificates. This creates a

source/includes/extracts-mongo-ssl-options.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ replacement:
1414
program: ":binary:`~bin.mongo`"
1515
instance: ":binary:`~bin.mongod` or :binary:`~bin.mongos`"
1616
post: |
17-
If your MongoDB deployment uses SSL, you must also specify the ``--host`` option.
17+
If your MongoDB deployment uses TLS/SSL, you must also specify the ``--host`` option.
1818
{{program}} verifies that the
1919
hostname of the {{instance}} to which you are connecting matches
2020
the CN or SAN of the {{instance}}'s ``--sslPEMKeyFile`` certificate.

source/includes/extracts-x509-certificate.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ content: |
9595
ref: x509-member-auth-configuration
9696
content: |
9797
To specify x.509 for internal authentication, in addition to the other
98-
SSL configurations appropriate for your deployment, for each member of
98+
TLS/SSL configurations appropriate for your deployment, for each member of
9999
the replica set or sharded cluster, include either:
100100
101101
- :setting:`security.clusterAuthMode` and :setting:`net.ssl.clusterFile`
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
For production use, your MongoDB deployment should use valid certificates
22
generated and signed by a single certificate authority. You or your
33
organization can generate and maintain an independent certificate
4-
authority, or use certificates generated by a third-party SSL
4+
authority, or use certificates generated by a third-party TLS/SSL
55
vendor. Obtaining and managing certificates is beyond the scope of
66
this documentation.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. note:: FIPS-compatible SSL is
1+
.. note:: FIPS-compatible TLS/SSL is
22
available only in `MongoDB Enterprise
33
<http://www.mongodb.com/products/mongodb-enterprise?jmp=docs>`_. See
44
:doc:`/tutorial/configure-fips` for more information.
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
.. note::
22

3-
Although TLS is the successor to SSL, this page uses the more
4-
familiar term SSL to refer to TLS/SSL.
3+
TLS is the successor to SSL.

source/includes/options-mongo.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,8 @@ description: |
7979
options. The ``authSource`` and ``replicaSet`` options, if included in
8080
the connection string, will override any corresponding DNS-configured options
8181
set in the TXT record. Use of the ``mongodb+srv:`` connection string implicitly
82-
enables SSL (normally set with ``ssl=true``) for the client connection. The
83-
SSL option can be turned off by setting ``ssl=false`` in the query string.
82+
enables TLS/SSL (normally set with ``ssl=true``) for the client connection. The
83+
TLS/SSL option can be turned off by setting ``ssl=false`` in the query string.
8484
8585
Example:
8686

source/includes/options-mongod.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1416,7 +1416,7 @@ directive: option
14161416
description: |
14171417
.. versionadded:: 3.0.7
14181418
1419-
Prevents a MongoDB server running with SSL from accepting incoming
1419+
Prevents a MongoDB server running with TLS/SSL from accepting incoming
14201420
connections that use a specific protocol or protocols. {{role}}
14211421
recognizes the following protocols: ``TLS1_0``, ``TLS1_1``, and
14221422
``TLS1_2``. Specifying an unrecognized protocol will prevent the

source/includes/options-shared.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ description: |
146146
147147
.. warning::
148148
149-
**Version 3.2 and earlier:** For SSL connections (``--ssl``) to
149+
**Version 3.2 and earlier:** For TLS/SSL connections (``--ssl``) to
150150
:binary:`~bin.mongod` and :binary:`~bin.mongos`, if the {{program}} runs without the
151151
{{role}}, {{program}} will not attempt
152152
to validate the server certificates. This creates a vulnerability

source/includes/steps-starting-compass.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ action:
2020
- Kerberos
2121
- LDAP
2222
23-
d. SSL: Whether or not Compass should connect to the target host with SSL.
24-
Several SSL options are available:
23+
d. SSL: Whether or not Compass should connect to the target host with TLS/SSL.
24+
Several TLS/SSL options are available:
2525
2626
- Unvalidated: If this option is used, the server cerficiate is not
2727
validated and no client certificate will be provided. The server must be

source/release-notes/3.6.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -828,7 +828,7 @@ Known Issues in 3.6.0
828828
- :issue:`TOOLS-1827`:
829829
When using a URI with SRV, fetched TXT records will be ignored if
830830
no query parameters are specified in the command line URI. To get
831-
around this, explicitly specify the SSL setting used to
831+
around this, explicitly specify the TLS/SSL setting used to
832832
communicate with the database (either ssl=true or ssl=false) in
833833
the URI query string.
834834

source/tutorial/configure-ssl-clients.txt

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ Clients must have support for TLS/SSL to work with a :binary:`~bin.mongod` or a
2525

2626
.. _mongo-shell-ssl-connect:
2727

28-
``mongo`` Shell SSL Configuration
29-
---------------------------------
28+
``mongo`` Shell Configuration
29+
-----------------------------
3030

3131
.. note::
3232
The *Linux 64-bit legacy x64* builds of MongoDB do **not** include
@@ -38,7 +38,7 @@ settings, including:
3838
- :option:`--ssl <mongo --ssl>`
3939

4040
- :option:`--sslPEMKeyFile <mongo --sslPEMKeyFile>` with the name of the
41-
:file:`.pem` file that contains the SSL certificate and key.
41+
:file:`.pem` file that contains the TLS/SSL certificate and key.
4242

4343
- :option:`--sslPEMKeyPassword <mongo --sslPEMKeyPassword>` option if the
4444
client certificate-key file is encrypted.
@@ -50,15 +50,14 @@ settings, including:
5050

5151
.. include:: /includes/extracts/clients-warning-sslCAFile.rst
5252

53-
54-
For a complete list of the :binary:`~bin.mongo` shell's SSL settings, see
53+
For a complete list of the :binary:`~bin.mongo` shell's TLS/SSL settings, see
5554
:ref:`mongo-shell-ssl`.
5655

57-
Connect to MongoDB Instance with SSL Encryption
58-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
56+
Connect to MongoDB Instance Using Encryption
57+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5958

6059
To connect to a :binary:`~bin.mongod` or :binary:`~bin.mongos` instance that
61-
requires :ref:`only a SSL encryption mode <ssl-mongod-ssl-cert-key>`,
60+
requires :ref:`encrypted communication <ssl-mongod-ssl-cert-key>`,
6261
start :binary:`~bin.mongo` shell with :option:`--ssl <mongo --ssl>` and
6362
include the :option:`--sslCAFile <mongo --sslCAFile>` to validate the
6463
server certificates.
@@ -118,12 +117,13 @@ connect to that :binary:`~bin.mongod`:
118117
|MMS| and Ops Manager Monitoring Agent
119118
--------------------------------------
120119

121-
The |MMS| Monitoring agent will also have to connect via SSL in order to
122-
gather its statistics. Because the agent already utilizes SSL for its
123-
communications to the |MMS| servers, this is just a matter of enabling
124-
SSL support in |MMS| itself on a per host basis.
120+
The |MMS| and Ops Manager Monitoring agents will also have to use
121+
encrypted communication in order to gather its statistics. Because the
122+
agents already encrypted communications to the |MMS|/Ops Manager servers,
123+
this is just a matter of enabling TLS/SSL support in |MMS|/Ops Manager on a per
124+
host basis.
125125

126-
See the |mms-docs| for more information about SSL
126+
See the |mms-docs| for more information about TLS/SSL
127127
configuration.
128128

129129
For Ops Manager, see :opsmgr:`Ops Manager documentation </>`.
@@ -133,7 +133,7 @@ For Ops Manager, see :opsmgr:`Ops Manager documentation </>`.
133133
MongoDB Drivers
134134
---------------
135135

136-
The MongoDB Drivers support for connection to SSL enabled MongoDB. See:
136+
The MongoDB Drivers support encrypted communication. See:
137137

138138
- `C Driver <http://api.mongodb.org/c/current/advanced-connections.html>`_
139139
- `C++ Driver <https://mongodb.github.io/mongo-cxx-driver/>`_
@@ -153,7 +153,7 @@ MongoDB Tools
153153

154154
.. versionchanged:: 2.6
155155

156-
Various MongoDB utility programs supports SSL. These tools include:
156+
Various MongoDB utility programs support encrypted communication. These tools include:
157157

158158
- :binary:`~bin.mongodump`
159159
- :binary:`~bin.mongoexport`
@@ -163,5 +163,5 @@ Various MongoDB utility programs supports SSL. These tools include:
163163
- :binary:`~bin.mongostat`
164164
- :binary:`~bin.mongotop`
165165

166-
To use SSL connections with these tools, use the same SSL options as
166+
To use encrypted communication with these tools, use the same TLS/SSL options as
167167
the :binary:`~bin.mongo` shell. See :ref:`mongo-shell-ssl-connect`.

0 commit comments

Comments
 (0)