Skip to content

Commit 12ef344

Browse files
kay-kimkay-kim
committed
DOCS-4295 DOCS-5272 include TLS when mentioning SSL
1 parent 4a1d720 commit 12ef344

40 files changed

+166
-157
lines changed

‎source/administration/install-on-linux.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Recommended
1212

1313
For the best installation experience, MongoDB provides packages for popular
1414
Linux distributions. These packages, which support
15-
specific platforms and provide improved performance and SSL
15+
specific platforms and provide improved performance and TLS/SSL
1616
support, are the preferred way to run MongoDB. The following guides
1717
detail the installation process for these systems:
1818

@@ -25,7 +25,7 @@ Manual Installation
2525
-------------------
2626

2727
For Linux systems without supported packages, MongoDB provides a
28-
generic Linux release. These versions of MongoDB don't include SSL,
28+
generic Linux release. These versions of MongoDB don't include TLS/SSL,
2929
and may not perform as well as the targeted packages, but are
3030
compatible on most contemporary Linux systems. See the
3131
following guides for installation:

‎source/administration/production-notes.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -492,8 +492,8 @@ For all MongoDB deployments:
492492
- Use the Network Time Protocol (NTP) to synchronize time among
493493
your hosts. This is especially important in sharded clusters.
494494

495-
MongoDB and SSL Libraries
496-
`````````````````````````
495+
MongoDB and TLS/SSL Libraries
496+
`````````````````````````````
497497

498498
On Linux platforms, you may observe one of the following statements in
499499
the MongoDB log:
@@ -503,8 +503,8 @@ the MongoDB log:
503503
<path to SSL libs>/libssl.so.<version>: no version information available (required by /usr/bin/mongod)
504504
<path to SSL libs>/libcrypto.so.<version>: no version information available (required by /usr/bin/mongod)
505505

506-
These warnings indicate that the system's SSL libraries are different
507-
from the SSL libraries that the :program:`mongod` was compiled against.
506+
These warnings indicate that the system's TLS/SSL libraries are different
507+
from the TLS/SSL libraries that the :program:`mongod` was compiled against.
508508
Typically these messages do not require intervention; however, you can
509509
use the following operations to determine the symbol versions that
510510
:program:`mongod` expects:
@@ -528,8 +528,8 @@ operations to detect symbol version mismatches:
528528

529529
.. code-block:: sh
530530

531-
objdump -T <path to SSL libs>/libssl.so.1*
532-
objdump -T <path to SSL libs>/libcrypto.so.1*
531+
objdump -T <path to TLS/SSL libs>/libssl.so.1*
532+
objdump -T <path to TLS/SSL libs>/libcrypto.so.1*
533533

534534
This procedure is neither exact nor exhaustive: many symbols used by
535535
:program:`mongod` from the ``libcrypto`` library do not begin with

‎source/administration/security-checklist.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,10 @@ See :doc:`/core/authorization`, :doc:`/tutorial/define-roles`,
3838
Encrypt Communication
3939
---------------------
4040

41-
Configure MongoDB to use SSL for all incoming and outgoing
42-
connections. Use SSL to encrypt communication between
41+
Configure MongoDB to use TLS/SSL for all incoming and outgoing
42+
connections. Use TLS/SSL to encrypt communication between
4343
:program:`mongod` and :program:`mongos` components of a MongoDB
44-
client, as well as between all applications and MongoDB.
44+
client as well as between all applications and MongoDB.
4545

4646
See :doc:`/tutorial/configure-ssl`.
4747

‎source/core/authentication.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ x.509 Certificate Authentication
181181
.. versionadded:: 2.6
182182

183183
MongoDB supports x.509 certificate authentication for use with a secure
184-
:doc:`SSL connection </tutorial/configure-ssl>`.
184+
:doc:`TLS/SSL connection </tutorial/configure-ssl>`.
185185

186186
To authenticate to servers, clients can use x.509 certificates instead
187187
of usernames and passwords. See :ref:`x509-client-authentication` for

‎source/core/replica-set-arbiter.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ The only communication between arbiters and other set members are:
5959
votes during elections, heartbeats, and configuration data. These
6060
exchanges are not encrypted.
6161

62-
**However**, if your MongoDB deployment uses SSL, MongoDB will encrypt
62+
**However**, if your MongoDB deployment uses TLS/SSL, MongoDB will encrypt
6363
*all* communication between replica set members. See
6464
:doc:`/tutorial/configure-ssl` for more information.
6565

‎source/core/security-introduction.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,9 @@ Encryption
7676
Transport Encryption
7777
~~~~~~~~~~~~~~~~~~~~
7878

79-
You can use SSL to encrypt all of MongoDB's network traffic. SSL
80-
ensures that MongoDB network traffic is only readable by the intended
81-
client.
79+
You can use TLS/SSL (Transport Layer Security/Secure Sockets Layer) to
80+
encrypt all of MongoDB's network traffic. TLS/SSL ensures that MongoDB
81+
network traffic is only readable by the intended client.
8282

8383
See :doc:`/tutorial/configure-ssl` for more information.
8484

‎source/core/security-network.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ Virtual Private Networks
140140

141141
Virtual private networks, or VPNs, make it possible to link two
142142
networks over an encrypted and limited-access trusted
143-
network. Typically MongoDB users who use VPNs use SSL rather than
143+
network. Typically, MongoDB users who use VPNs use TLS/SSL rather than
144144
IPSEC VPNs for performance issues.
145145

146146
Depending on configuration and implementation, VPNs provide for

‎source/faq/replica-sets.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -206,9 +206,9 @@ following data with the rest of the replica set:
206206
- Replica set configuration data and voting data. This information is
207207
not encrypted. Only credential exchanges are encrypted.
208208

209-
If your MongoDB deployment uses SSL, then all communications between
210-
arbiters and the other members of the replica set are secure. See the
211-
documentation for :doc:`/tutorial/configure-ssl` for more
209+
If your MongoDB deployment uses TLS/SSL, then all communications
210+
between arbiters and the other members of the replica set are secure.
211+
See the documentation for :doc:`/tutorial/configure-ssl` for more
212212
information. Run all arbiters on secure networks, as with all MongoDB
213213
components.
214214

‎source/includes/admonition-saslauthd-ldap-considerations.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ Use secure encrypted or trusted connections between clients and the server,
88
as well as between ``saslauthd`` and the LDAP server. The LDAP server uses
99
the ``SASL PLAIN`` mechanism, sending and receiving data in **plain text**.
1010
You should use only a trusted channel such as a VPN, a connection encrypted
11-
with SSL, or a trusted wired network.
11+
with TLS/SSL, or a trusted wired network.

‎source/includes/extracts-security-prereq.yaml

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,52 +3,52 @@ inherit:
33
ref: _security-prereq
44
file: extracts-security-prereq-base.yaml
55
replacement:
6-
unscoped: "A full description of SSL, PKI (Public Key Infrastructure) certificates, and Certificate Authority"
6+
unscoped: "A full description of TLS/SSL, PKI (Public Key Infrastructure) certificates, and Certificate Authority"
77
page: page
8-
prereq: "SSL as well as access to valid certificates"
8+
prereq: "TLS/SSL as well as access to valid certificates"
99
---
1010
ref: security-prereq-configure-ssl-clients
1111
inherit:
1212
ref: _security-prereq
1313
file: extracts-security-prereq-base.yaml
1414
replacement:
15-
unscoped: "A full description of SSL, PKI (Public Key Infrastructure) certificates, and Certificate Authority"
15+
unscoped: "A full description of TLS/SSL, PKI (Public Key Infrastructure) certificates, and Certificate Authority"
1616
page: page
17-
prereq: "SSL as well as access to valid certificates"
17+
prereq: "TLS/SSL as well as access to valid certificates"
1818
---
1919
ref: security-prereq-upgrade-cluster-to-ssl
2020
inherit:
2121
ref: _security-prereq
2222
file: extracts-security-prereq-base.yaml
2323
replacement:
24-
unscoped: "A full description of SSL, PKI (Public Key Infrastructure) certificates, and Certificate Authority"
24+
unscoped: "A full description of TLS/SSL, PKI (Public Key Infrastructure) certificates, and Certificate Authority"
2525
page: tutorial
26-
prereq: "SSL as well as access to valid certificates"
26+
prereq: "TLS/SSL as well as access to valid certificates"
2727
---
2828
ref: security-prereq-configure-fips
2929
inherit:
3030
ref: _security-prereq
3131
file: extracts-security-prereq-base.yaml
3232
replacement:
33-
unscoped: "A full description of FIPS and SSL"
33+
unscoped: "A full description of FIPS and TLS/SSL"
3434
page: tutorial
35-
prereq: "FIPS and SSL"
35+
prereq: "FIPS and TLS/SSL"
3636
---
3737
ref: security-prereq-configure-x509-client-authentication
3838
inherit:
3939
ref: _security-prereq
4040
file: extracts-security-prereq-base.yaml
4141
replacement:
42-
unscoped: "A full description of SSL, PKI (Public Key Infrastructure) certificates, in particular x.509 certificates, and Certificate Authority"
42+
unscoped: "A full description of TLS/SSL, PKI (Public Key Infrastructure) certificates, in particular x.509 certificates, and Certificate Authority"
4343
page: tutorial
44-
prereq: "SSL as well as access to valid x.509 certificates"
44+
prereq: "TLS/SSL as well as access to valid x.509 certificates"
4545
---
4646
ref: security-prereq-configure-x509-member-authentication
4747
inherit:
4848
ref: _security-prereq
4949
file: extracts-security-prereq-base.yaml
5050
replacement:
51-
unscoped: "A full description of SSL, PKI (Public Key Infrastructure) certificates, in particular x.509 certificates, and Certificate Authority"
51+
unscoped: "A full description of TLS/SSL, PKI (Public Key Infrastructure) certificates, in particular x.509 certificates, and Certificate Authority"
5252
page: tutorial
53-
prereq: "SSL as well as access to valid x.509 certificates"
53+
prereq: "TLS/SSL as well as access to valid x.509 certificates"
5454
...

‎source/includes/fact-ssl-supported.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.. versionchanged:: 3.0
22

3-
Most MongoDB distributions now include support for SSL. See
4-
:doc:`/tutorial/configure-ssl` for more information about SSL and
3+
Most MongoDB distributions now include support for TLS/SSL. See
4+
:doc:`/tutorial/configure-ssl` for more information about TLS/SSL and
55
MongoDB.

‎source/includes/note-tls-ssl-terminology.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.. note::
2+
3+
Although TLS is the successor to SSL, this page uses the more
4+
familiar term SSL to refer to TLS/SSL.

‎source/includes/options-conf.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -794,7 +794,7 @@ description: |
794794
795795
* - :ref:`MONGODB-X509 <security-auth-x509>`
796796
797-
- MongoDB SSL certificate authentication.
797+
- MongoDB TLS/SSL certificate authentication.
798798
799799
* - :ref:`GSSAPI <security-auth-kerberos>` (Kerberos)
800800
@@ -1481,7 +1481,7 @@ description: |
14811481
.. versionadded:: 3.0
14821482
14831483
When {{role}} is ``true``, MongoDB disables the validation of the
1484-
hostnames in SSL certificates, allowing {{program}} to connect to
1484+
hostnames in TLS/SSL certificates, allowing {{program}} to connect to
14851485
MongoDB instances if the hostname their certificates do not match the
14861486
specified hostname.
14871487

‎source/includes/options-mongo.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ description: |
207207
.. versionadded:: 2.2
208208
209209
Enables connection to a :program:`mongod` or :program:`mongos` that has
210-
SSL support enabled.
210+
TLS/SSL support enabled.
211211
212212
.. include:: /includes/fact-ssl-supported.rst
213213
optional: true
@@ -219,7 +219,7 @@ directive: option
219219
description: |
220220
.. versionadded:: 2.4
221221
222-
Specifies the :file:`.pem` file that contains both the SSL certificate
222+
Specifies the :file:`.pem` file that contains both the TLS/SSL certificate
223223
and key. Specify the file name of the :file:`.pem` file using relative
224224
or absolute paths.
225225

‎source/includes/options-mongod.yaml

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1182,9 +1182,9 @@ directive: option
11821182
description: |
11831183
.. deprecated:: 2.6
11841184
1185-
{{verb}} SSL for {{program}}.
1185+
{{verb}} TLS/SSL for {{program}}.
11861186
1187-
With {{role}}, a {{program}} requires SSL encryption for all
1187+
With {{role}}, a {{program}} requires TLS/SSL encryption for all
11881188
connections on the default MongoDB port, or the port specified by
11891189
:option:`--port`. By default, :option:`--sslOnNormalPorts` is
11901190
disabled.
@@ -1201,7 +1201,7 @@ directive: option
12011201
description: |
12021202
.. versionadded:: 2.6
12031203
1204-
{{verb}} SSL or mixed SSL used for all network connections. The
1204+
{{verb}} TLS/SSL or mixed TLS/SSL used for all network connections. The
12051205
argument to the {{role}} {{directive}} can be one of the following:
12061206
12071207
.. list-table::
@@ -1214,21 +1214,21 @@ description: |
12141214
12151215
* - ``disabled``
12161216
1217-
- The server does not use SSL.
1217+
- The server does not use TLS/SSL.
12181218
12191219
* - ``allowSSL``
12201220
1221-
- Connections between servers do not use SSL. For incoming
1222-
connections, the server accepts both SSL and non-SSL.
1221+
- Connections between servers do not use TLS/SSL. For incoming
1222+
connections, the server accepts both TLS/SSL and non-TLS/non-SSL.
12231223
12241224
* - ``preferSSL``
12251225
1226-
- Connections between servers use SSL. For incoming
1227-
connections, the server accepts both SSL and non-SSL.
1226+
- Connections between servers use TLS/SSL. For incoming
1227+
connections, the server accepts both TLS/SSL and non-TLS/non-SSL.
12281228
12291229
* - ``requireSSL``
12301230
1231-
- The server uses and accepts only SSL encrypted connections.
1231+
- The server uses and accepts only TLS/SSL encrypted connections.
12321232
12331233
.. include:: /includes/fact-ssl-supported.rst
12341234
@@ -1244,11 +1244,11 @@ directive: option
12441244
description: |
12451245
.. versionadded:: 2.2
12461246
1247-
{{intro}} :file:`.pem` file that contains both the SSL certificate
1247+
{{intro}} :file:`.pem` file that contains both the TLS/SSL certificate
12481248
and key. Specify the file name of the :file:`.pem` file using relative
12491249
or absolute paths.
12501250
1251-
You must specify {{role}} when SSL is enabled.
1251+
You must specify {{role}} when TLS/SSL is enabled.
12521252
12531253
.. include:: /includes/fact-ssl-supported.rst
12541254
optional: true
@@ -1362,7 +1362,7 @@ directive: option
13621362
description: |
13631363
.. versionadded:: 2.6
13641364
1365-
{{verb}} the validation checks for SSL certificates on other servers
1365+
{{verb}} the validation checks for TLS/SSL certificates on other servers
13661366
in the cluster and allows the use of invalid certificates.
13671367
13681368
When using
@@ -1387,7 +1387,7 @@ pre: |
13871387
{{old_name}}, but all users should
13881388
update their configuration files.
13891389
description: |
1390-
{{verb}} the requirement for SSL certificate validation that
1390+
{{verb}} the requirement for TLS/SSL certificate validation that
13911391
{{sslCA_option}} enables. With the {{role}} option, the {{program}}
13921392
will accept connections when the client does not present a certificate
13931393
when establishing the connection.
@@ -1414,7 +1414,7 @@ directive: option
14141414
description: |
14151415
.. versionadded:: 3.0
14161416
1417-
Disables the validation of the hostnames in SSL certificates, when
1417+
Disables the validation of the hostnames in TLS/SSL certificates, when
14181418
connecting to other {{program}} instances for inter-process
14191419
authentication. This allows {{program}} to connect to other
14201420
{{program}} instances if the hostnames in their certificates do not

‎source/includes/options-shared.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ description: |
120120
.. versionadded:: 2.6
121121
122122
Enables connection to a :program:`mongod` or :program:`mongos` that has
123-
SSL support enabled.
123+
TLS/SSL support enabled.
124124
125125
.. include:: /includes/fact-ssl-supported.rst
126126
optional: true
@@ -150,7 +150,7 @@ directive: option
150150
description: |
151151
.. versionadded:: 2.6
152152
153-
Specifies the :file:`.pem` file that contains both the SSL certificate
153+
Specifies the :file:`.pem` file that contains both the TLS/SSL certificate
154154
and key. Specify the file name of the :file:`.pem` file using relative
155155
or absolute paths.
156156
@@ -223,7 +223,7 @@ directive: option
223223
description: |
224224
.. versionadded:: 3.0
225225
226-
Disables the validation of the hostnames in SSL certificates. Allows
226+
Disables the validation of the hostnames in TLS/SSL certificates. Allows
227227
{{program}} to connect to MongoDB instances if the hostname their
228228
certificates do not match the specified hostname.
229229
@@ -323,7 +323,7 @@ description: |
323323
324324
* - :ref:`MONGODB-X509 <security-auth-x509>`
325325
326-
- MongoDB SSL certificate authentication.
326+
- MongoDB TLS/SSL certificate authentication.
327327
328328
* - :ref:`GSSAPI <security-auth-kerberos>` (Kerberos)
329329

‎source/includes/steps-authenticate-through-ldap.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,5 @@ action:
2424
)
2525
post:
2626
The server forwards the password in plain text. In general, use only on
27-
a trusted channel (VPN, SSL, trusted wired network).
27+
a trusted channel (VPN, TLS/SSL, trusted wired network).
2828
...

‎source/includes/steps-configure-ldap-mongodb.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,6 @@ action:
105105
)
106106
post: |
107107
The server forwards the password in plain text. In general, use only on
108-
a trusted channel (VPN, SSL, trusted wired network). See
108+
a trusted channel (VPN, TLS/SSL, trusted wired network). See
109109
Considerations.
110110
...

‎source/includes/steps-configure-ldap-saslauthd-openldap.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ action:
3030
The ``ldap_servers`` specifies the uri of the LDAP server used
3131
for authentication. In general, for OpenLDAP installed on the
3232
local machine, you can specify the value ``ldap://localhost:389``
33-
or if using LDAP over SSL, you can specify the value
33+
or if using LDAP over TLS/SSL, you can specify the value
3434
``ldaps://localhost:636``.
3535
3636
The ``ldap_search_base`` specifies distinguished name to which

0 commit comments

Comments
 (0)