You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/auth/auth.rst
+20-17Lines changed: 20 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -74,7 +74,7 @@ Drivers SHOULD contain a type called `MongoCredential`. It SHOULD contain some o
74
74
75
75
username (string)
76
76
* Applies to all mechanisms.
77
-
* Optional for MONGODB-X509 and MONGODB-IAM.
77
+
* Optional for MONGODB-X509 and MONGODB-AWS.
78
78
source (string)
79
79
* Applies to all mechanisms.
80
80
* Always '$external' for GSSAPI and MONGODB-X509.
@@ -709,17 +709,17 @@ mechanism
709
709
mechanism_properties
710
710
MUST NOT be specified.
711
711
712
-
MONGODB-IAM
712
+
MONGODB-AWS
713
713
~~~~~~~~~~~
714
714
715
715
:since: 4.4
716
716
717
-
MONGODB-IAM authenticates using AWS IAM credentials (an access key ID and a secret access key), `temporary IAM credentials <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html>`_ obtained from an
717
+
MONGODB-AWS authenticates using AWS IAM credentials (an access key ID and a secret access key), `temporary AWS IAM credentials <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html>`_ obtained from an
718
718
`AWS Security Token Service (STS) <https://docs.aws.amazon.com/STS/latest/APIReference/Welcome.html>`_
719
719
`Assume Role <https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html>`_ request,
720
-
or temporary IAM credentials assigned to an `EC2 instance <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html>`_ or ECS task. Temporary credentials, in addition to an access key ID and a secret access key, includes a security (or session) token.
720
+
or temporary AWS IAM credentials assigned to an `EC2 instance <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html>`_ or ECS task. Temporary credentials, in addition to an access key ID and a secret access key, includes a security (or session) token.
721
721
722
-
MONGODB-IAM requires that a client create a randomly generated nonce. It is
722
+
MONGODB-AWS requires that a client create a randomly generated nonce. It is
723
723
imperative, for security sake, that this be as secure and truly random as possible.
724
724
725
725
All messages between MongoDB clients and servers are sent as BSON V1.1 Objects in the payload field of saslStart and saslContinue.
@@ -752,7 +752,7 @@ Drivers must also validate that the host is greater than 0 and less than or equa
752
752
`RFC 1035 <https://tools.ietf.org/html/rfc1035>`_. Drivers MUST reject FQDN names with empty labels, e.g., "abc..def", and error on any
753
753
additional fields. Drivers MUST respond to the server's message with an ``authorization header`` and a ``date``.
754
754
755
-
As an example, given a client nonce value of "dzw1U2IwSEtgaWI0IUxZMVJqc2xuQzNCcUxBc05wZjI=", a MONGODB-IAM conversation decoded from
755
+
As an example, given a client nonce value of "dzw1U2IwSEtgaWI0IUxZMVJqc2xuQzNCcUxBc05wZjI=", a MONGODB-AWS conversation decoded from
Sets the Mechanism property on the MongoCredential. When not set, the default will be one of SCRAM-SHA-256, SCRAM-SHA-1 or MONGODB-CR, following the auth spec default mechanism rules.
983
983
984
984
authSource
985
985
Sets the Source property on the MongoCredential.
986
986
987
-
For GSSAPI, MONGODB-X509 and MONGODB-IAM authMechanisms the authSource defaults to ``$external``.
987
+
For GSSAPI, MONGODB-X509 and MONGODB-AWS authMechanisms the authSource defaults to ``$external``.
988
988
For PLAIN the authSource defaults to the database name if supplied on the connection string or ``$external``.
989
989
For MONGODB-CR, SCRAM-SHA-1 and SCRAM-SHA-256 authMechanisms, the authSource defaults to the database name if supplied on the connection string or ``admin``.
990
990
@@ -1193,6 +1193,9 @@ Q: Why does SCRAM sometimes SASLprep and sometimes not?
1193
1193
Version History
1194
1194
===============
1195
1195
1196
+
Version 1.10.1 Changes
1197
+
* Rename MONGODB-IAM to MONGODB-AWS
1198
+
1196
1199
Version 1.10.0 Changes
1197
1200
* Support shorter SCRAM conversation starting in version 4.4 of the server.
0 commit comments