-
Notifications
You must be signed in to change notification settings - Fork 34
DOCSP-13829 authentication mechanism #18
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
kyuan-mongodb
merged 10 commits into
mongodb:master
from
kyuan-mongodb:DOCSP-13829-AuthMechanisms
Aug 16, 2021
Merged
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
31b993f
added authentication mechanism page
kyuan-mongodb cecf88d
proofread
kyuan-mongodb b8d5245
proofread 2
kyuan-mongodb 41b7c6d
added section to explain how autenticating works
kyuan-mongodb 7baea67
TS suggestions
kyuan-mongodb 9cb0cfc
proofread
kyuan-mongodb efa048d
clarified intros
kyuan-mongodb d8f4145
BR suggestions
kyuan-mongodb 9f1b2bd
fixed MongoDB-CR versioning
kyuan-mongodb 252e8eb
removed mention about using MONGODB-CR
kyuan-mongodb File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -28,8 +28,9 @@ The Go Driver establishes a connection with an authentication mechanism | |
through a `Client <https://pkg.go.dev/go.mongodb.org/[email protected]/mongo#Client>`__ | ||
type. The ``Client`` type specifies the mechanism and credentials to use | ||
as connection options in a `Credential <https://pkg.go.dev/go.mongodb.org/[email protected]/mongo/options#Credential>`__ | ||
type . To configure these options, pass a ``Credential`` type to a `ClientOptions | ||
<https://pkg.go.dev/go.mongodb.org/[email protected]/mongo/options#ClientOptions>`__ | ||
type . To configure these options, pass a ``Credential`` type to the | ||
`SetAuth() <https://pkg.go.dev/go.mongodb.org/[email protected]/mongo/options#ClientOptions.SetAuth>`__ | ||
function of the `ClientOptions <https://pkg.go.dev/go.mongodb.org/[email protected]/mongo/options#ClientOptions>`__ | ||
type. | ||
|
||
The following sections demonstrate this process with the five | ||
|
@@ -72,7 +73,7 @@ mechanisms depending on what MongoDB versions your server supports: | |
- MongoDB 3.0, 3.2, 3.4, and 3.6 | ||
|
||
* - ``MONGODB-CR`` | ||
- MongoDB 3.6 and earlier | ||
- MongoDB 3.6 and earlier if the server doesn't support``SCRAM-SHA-1`` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This still isn't correct. This table is for the default it looks like. MongoDB 3.0 changed the default from |
||
|
||
To specify the default authentication mechanism, omit the | ||
``AuthMechanism`` option: | ||
|
@@ -106,7 +107,7 @@ see the :manual:`SCRAM </core/security-scram/>` section of the server manual. | |
algorithm, to authenticate your user. | ||
|
||
To specify the ``SCRAM-SHA-256`` authentication mechanism, assign the | ||
``AuthMechanism`` option the value ``SCRAM-SHA-256``: | ||
``AuthMechanism`` option the value ``"SCRAM-SHA-256"``: | ||
|
||
.. code-block:: go | ||
:emphasize-lines: 2 | ||
|
@@ -137,16 +138,16 @@ username and password, encrypted with the ``SHA-1`` algorithm, to authenticate | |
your user. | ||
|
||
To specify the ``SCRAM-SHA-1`` authentication mechanism, assign the | ||
``AuthMechanism`` option the value ``SCRAM-SHA-1``: | ||
``AuthMechanism`` option the value ``"SCRAM-SHA-1"``: | ||
|
||
.. code-block:: go | ||
:emphasize-lines: 2 | ||
|
||
credential := options.Credential{ | ||
AuthMechanism: "SCRAM-SHA-1", | ||
AuthSource: "<authenticationDb>", | ||
Username: "<username>", | ||
Password: "<password>", | ||
Username: "<username>", | ||
Password: "<password>", | ||
} | ||
clientOpts := options.Client().ApplyURI("mongodb://<hostname>:<port>"). | ||
SetAuth(credential) | ||
|
@@ -191,8 +192,8 @@ following: | |
awsCredential := options.Credential{ | ||
AuthMechanism: "MONGODB-AWS", | ||
AuthSource: "<authenticationDb>", | ||
Username: accessKeyID, | ||
Password: secretAccessKey, | ||
Username: "<accessKeyID>", | ||
Password: "<secretAccessKey>", | ||
} | ||
awsIAMClient, err := mongo.Connect( | ||
context.TODO(), | ||
|
@@ -215,10 +216,10 @@ option the value of your ``sessionToken``: | |
assumeRoleCredential := options.Credential{ | ||
AuthMechanism: "MONGODB-AWS", | ||
AuthSource: "<authenticationDb>", | ||
Username: accessgKeyID, | ||
Password: secretAccessKey, | ||
Username: "<accessKeyID>", | ||
Password: "<secretAccessKey>", | ||
AuthMechanismProperties: map[string]string{ | ||
"AWS_SESSION_TOKEN": sessionToken, | ||
"AWS_SESSION_TOKEN": "<sessionToken>", | ||
}, | ||
} | ||
assumeRoleClient, err := mongo.Connect(context.TODO(), | ||
|
@@ -242,7 +243,7 @@ following: | |
|
||
- Assign the ``tlsCAFile`` the path to its file in the connection string | ||
- Assign the ``tlsCertificateKeyFile`` the path to its file in the connection string | ||
- Assign the ``AuthMechanism`` option the value ``X.509`` | ||
- Assign the ``AuthMechanism`` option the value ``"MONGODB-X509"`` | ||
|
||
.. code-block:: go | ||
:emphasize-lines: 4-5, 7 | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.