@@ -33,7 +33,6 @@ The Go driver supports the following authentication mechanisms:
33
33
34
34
* :ref:`SCRAM-SHA-256 <golang_sha_256>`
35
35
* :ref:`SCRAM-SHA-1 <golang-sha-1>`
36
- * :ref:`MONGODB-CR <golang-mongodb-cr>`
37
36
* :ref:`MongoDB-AWS <golang-mongodb-aws>`
38
37
* :ref:`X.509 <golang-x509>`
39
38
@@ -63,33 +62,17 @@ Each authentication mechanism contains the following placeholders:
63
62
authentication data. If you omit this option, the driver uses the
64
63
default value ``admin``.
65
64
65
+ .. _golang_sha_256:
66
66
.. _golang-default-auth-mechanism:
67
67
68
- Default
69
- ~~~~~~~
70
-
71
- The default mechanism uses one of the following authentication
72
- mechanisms depending on what MongoDB versions your server supports:
73
-
74
- .. list-table::
75
- :header-rows: 1
76
- :stub-columns: 1
77
- :class: compatibility-large
78
-
79
- * - Mechanism
80
- - Versions
81
-
82
- * - ``SCRAM-SHA-256``
83
- - MongoDB 4.0 and later
84
-
85
- * - ``SCRAM-SHA-1``
86
- - MongoDB 3.0, 3.2, 3.4, and 3.6
68
+ ``SCRAM-SHA-256``
69
+ ~~~~~~~~~~~~~~~~~
87
70
88
- * - ``MONGODB-CR``
89
- - MongoDB 2.6 and earlier
71
+ ``SCRAM-SHA-256`` is a salted challenge-response authentication mechanism
72
+ (SCRAM) that uses your database username and password, encrypted with the ``SHA-256``
73
+ algorithm, to authenticate your user. This is the default authentication mechanism.
90
74
91
- To specify the default authentication mechanism, omit the
92
- ``AuthMechanism`` option:
75
+ To specify this default authentication mechanism, omit the ``AuthMechanism`` option:
93
76
94
77
.. code-block:: go
95
78
@@ -103,26 +86,8 @@ To specify the default authentication mechanism, omit the
103
86
104
87
client, err := mongo.Connect(clientOpts)
105
88
106
- To learn more about the challenge-response (CR) and salted
107
- challenge-response authentication mechanisms (SCRAM) that MongoDB supports,
108
- see the :manual:`SCRAM </core/security-scram/>` section of the server manual.
109
-
110
- .. _golang_sha_256:
111
-
112
- ``SCRAM-SHA-256``
113
- ~~~~~~~~~~~~~~~~~
114
-
115
- .. important::
116
-
117
- ``SCRAM-SHA-256`` is the default authentication method for MongoDB starting
118
- in MongoDB 4.0.
119
-
120
- ``SCRAM-SHA-256`` is a salted challenge-response authentication mechanism
121
- (SCRAM) that uses your database username and password, encrypted with the ``SHA-256``
122
- algorithm, to authenticate your user.
123
-
124
- To specify the ``SCRAM-SHA-256`` authentication mechanism, assign the
125
- ``AuthMechanism`` option the value ``"SCRAM-SHA-256"``:
89
+ You can also explicitly specify the ``SCRAM-SHA-256`` authentication mechanism
90
+ by assigning the ``AuthMechanism`` option the value ``"SCRAM-SHA-256"``:
126
91
127
92
.. code-block:: go
128
93
:emphasize-lines: 2
@@ -138,17 +103,15 @@ To specify the ``SCRAM-SHA-256`` authentication mechanism, assign the
138
103
139
104
client, err := mongo.Connect(clientOpts)
140
105
106
+ To learn more about the challenge-response authentication mechanisms (SCRAM) that MongoDB supports,
107
+ see the :manual:`SCRAM </core/security-scram/>` section of the Server manual.
108
+
141
109
.. _golang-scram-sha-1-auth-mechanism:
142
110
.. _golang-sha-1:
143
111
144
112
``SCRAM-SHA-1``
145
113
~~~~~~~~~~~~~~~
146
114
147
- .. important::
148
-
149
- ``SCRAM-SHA-1`` is the default authentication method for MongoDB versions
150
- 3.0, 3.2, 3.4, and 3.6.
151
-
152
115
``SCRAM-SHA-1`` is a salted challenge-response mechanism (SCRAM) that uses your
153
116
username and password, encrypted using the ``SHA-1`` algorithm, to authenticate
154
117
your user.
@@ -170,29 +133,11 @@ To specify the ``SCRAM-SHA-1`` authentication mechanism, assign the
170
133
171
134
client, err := mongo.Connect(clientOpts)
172
135
173
- .. _golang-mongodb-cr:
174
-
175
- ``MONGODB-CR``
176
- ~~~~~~~~~~~~~~
177
-
178
- ``MONGODB-CR`` is a challenge-response authentication mechanism that uses your
179
- username and password to authenticate your user.
180
-
181
- .. important::
182
-
183
- This authentication mechanism was deprecated starting in MongoDB 3.6
184
- and is no longer supported as of MongoDB 4.0.
185
-
186
136
.. _golang-mongodb-aws:
187
137
188
138
``MONGODB-AWS``
189
139
~~~~~~~~~~~~~~~
190
140
191
- .. important::
192
-
193
- The MONGODB-AWS authentication mechanism is available only in MongoDB
194
- versions 4.4 and later.
195
-
196
141
The ``MONGODB-AWS`` authentication mechanism uses your Amazon Web Services
197
142
Identity and Access Management (AWS IAM) credentials to authenticate your
198
143
user.
0 commit comments