Skip to content

Commit 234a530

Browse files
ravindk89kay-kim
authored andcommitted
DOCS-11415: Use TLS to mitigate cleartext passwords
1 parent 6363a78 commit 234a530

File tree

7 files changed

+34
-21
lines changed

7 files changed

+34
-21
lines changed

source/includes/fact-auth-restrictions-array-contents.rst

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
.. versionadded:: 3.6
22

3-
The ``authenticationRestrictions`` document can contain the
4-
following fields:
3+
The ``authenticationRestrictions`` document can contain *only* the
4+
following fields. The server throws an error if the
5+
``authenticationRestrictions`` document contains an unrecognized field:
56

67
.. list-table::
78
:header-rows: 1
@@ -30,13 +31,6 @@ following fields:
3031

3132
.. important::
3233

33-
These are the only fields recognized by the server in the
34-
``authenticationRestrictions`` document. When creating a user,
35-
if the server does not recognize a field contained within the
36-
``authenticationRestrictions`` document, it throws an error.
37-
38-
.. warning::
39-
4034
If a user inherits multiple roles with incompatible authentication
4135
restrictions, that user becomes unusable.
4236

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.. warning::
2+
3+
By default, |command| sends all specified data to the MongoDB
4+
instance in cleartext. Use TLS transport encryption to protect
5+
communications between clients and the server,
6+
including the password sent by |command|. For
7+
instructions on enabling TLS transport encryption, see
8+
:doc:`/tutorial/configure-ssl`.
9+
10+
MongoDB does not store the password in cleartext. The password
11+
is only vulnerable in transit between the client and the
12+
server, and only if TLS transport encryption is not enabled.

source/reference/command/createUser.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,9 @@ Behavior
5858
Encryption
5959
~~~~~~~~~~
6060

61-
:dbcommand:`createUser` sends password to the MongoDB instance in
62-
cleartext. To encrypt the password in transit, use :doc:`TLS/SSL
63-
</tutorial/configure-ssl>`.
61+
.. |command| replace:: :dbcommand:`createUser`
62+
63+
.. include:: /includes/fact-cleartext-passwords-tls.rst
6464

6565
External Credentials
6666
~~~~~~~~~~~~~~~~~~~~

source/reference/command/updateUser.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,9 @@ Authentication Restrictions
6464
Behavior
6565
--------
6666

67-
:dbcommand:`updateUser` sends the password to the MongoDB instance in
68-
cleartext. To encrypt the password in transit, use :doc:`TLS/SSL
69-
</tutorial/configure-ssl>`.
67+
.. |command| replace:: :dbcommand:`updateUser`
68+
69+
.. include:: /includes/fact-cleartext-passwords-tls.rst
7070

7171
Required Access
7272
---------------

source/reference/method/db.changeUserPassword.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,13 @@ Required Access
2626

2727
.. include:: /includes/access-change-password.rst
2828

29+
Behavior
30+
--------
31+
32+
.. |command| replace:: :method:`db.changeUserPassword()`
33+
34+
.. include:: /includes/fact-cleartext-passwords-tls.rst
35+
2936
Example
3037
-------
3138

source/reference/method/db.createUser.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,9 @@ Behavior
6868
Encryption
6969
~~~~~~~~~~
7070

71-
:method:`db.createUser()` sends password to the MongoDB instance
72-
*without* encryption. To encrypt the password during transmission,
73-
use :doc:`TLS/SSL </tutorial/configure-ssl>`.
71+
.. |command| replace:: :method:`db.createUser()`
72+
73+
.. include:: /includes/fact-cleartext-passwords-tls.rst
7474

7575
External Credentials
7676
~~~~~~~~~~~~~~~~~~~~

source/reference/method/db.updateUser.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,9 @@ command.
7979
Behavior
8080
--------
8181

82-
:method:`db.updateUser()` sends password to the MongoDB instance
83-
*without* encryption. To encrypt the password during transmission,
84-
use :doc:`TLS/SSL </tutorial/configure-ssl>`.
82+
.. |command| replace:: :method:`db.updateUser()`
83+
84+
.. include:: /includes/fact-cleartext-passwords-tls.rst
8585

8686
Required Access
8787
---------------

0 commit comments

Comments
 (0)