DOCSP-18653: remove username from x509 example #640
Merged
Conversation
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
ccho-mongodb
approved these changes
Apr 4, 2023
| .. note:: | ||
|
|
||
| You do not need to specify a username when authenticating with this | ||
| mechanism. However, if you provide a username, you must encode it so |
There was a problem hiding this comment.
Suggested change
| mechanism. However, if you provide a username, you must encode it so | |
| mechanism. However, if you provide a username, you must URI encode it so |
There was a problem hiding this comment.
N/A because removing note
|
|
||
| .. literalinclude:: /code-snippets/authentication/x509.js | ||
| :language: javascript | ||
|
|
||
| .. note:: |
There was a problem hiding this comment.
Suggestion:
Based on the comments on the ticket, it's not needed for all the versions of the Node.js driver docs we maintain. I would omit this since it might cause users to ask why they might include it.
There was a problem hiding this comment.
Good call. I wasn't sure because the ticket says we might want to tell users that it is optional but requires URI encoding... But if there's really no use case where users need to supply the user, best to not reference it at all
| the X.509 certificate, see the MongoDB manual :manual:`X.509 tutorial | ||
| </tutorial/configure-x509-client-authentication/#add-x-509-certificate-subject-as-a-user>`. | ||
| authenticate by retrieving the distinguished name (DN) from the | ||
| client certificate. |
There was a problem hiding this comment.
Question:
I thought the removed sentence provides information that helps the user determine the certificate is the one that corresponds to their MongoDB user? Is there enough info in this section on how to set up x.509 authentication without it?
There was a problem hiding this comment.
It was my understanding that since username is no longer required, users do not need to know how to retrieve the subject from their certificate.
There was a problem hiding this comment.
Ok. It wasn't clear to me whether the link was trying to confirm the certificate was for the user or to extract the subject/username.
rustagir
added a commit
that referenced
this pull request
Apr 4, 2023
* DOCSP-18653: remove username from x509 example * CC suggestions (cherry picked from commit 40939c7)
rustagir
added a commit
that referenced
this pull request
Apr 4, 2023
* DOCSP-18653: remove username from x509 example * CC suggestions (cherry picked from commit 40939c7)
rustagir
added a commit
that referenced
this pull request
Apr 4, 2023
* DOCSP-18653: remove username from x509 example * CC suggestions (cherry picked from commit 40939c7)
rustagir
added a commit
that referenced
this pull request
Apr 4, 2023
* DOCSP-18653: remove username from x509 example * CC suggestions (cherry picked from commit 40939c7)
rustagir
added a commit
that referenced
this pull request
Apr 4, 2023
* DOCSP-18653: remove username from x509 example * CC suggestions (cherry picked from commit 40939c7)
rustagir
added a commit
that referenced
this pull request
Apr 4, 2023
* DOCSP-18653: remove username from x509 example * CC suggestions (cherry picked from commit 40939c7)
rustagir
added a commit
that referenced
this pull request
Apr 4, 2023
* DOCSP-18653: remove username from x509 example * CC suggestions (cherry picked from commit 40939c7)
rustagir
added a commit
that referenced
this pull request
Apr 4, 2023
* DOCSP-18653: remove username from x509 example * CC suggestions (cherry picked from commit 40939c7)
rustagir
added a commit
that referenced
this pull request
Apr 4, 2023
* DOCSP-18653: remove username from x509 example * CC suggestions (cherry picked from commit 40939c7)
rustagir
added a commit
that referenced
this pull request
Apr 4, 2023
* DOCSP-18653: remove username from x509 example * CC suggestions (cherry picked from commit 40939c7)
rustagir
added a commit
that referenced
this pull request
Apr 4, 2023
* DOCSP-18653: remove username from x509 example * CC suggestions (cherry picked from commit 40939c7)
rustagir
added a commit
that referenced
this pull request
Apr 4, 2023
* DOCSP-18653: remove username from x509 example * CC suggestions (cherry picked from commit 40939c7)
rustagir
added a commit
that referenced
this pull request
Apr 4, 2023
* DOCSP-18653: remove username from x509 example * CC suggestions (cherry picked from commit 40939c7)
rustagir
added a commit
that referenced
this pull request
Apr 4, 2023
* DOCSP-18653: remove username from x509 example * CC suggestions (cherry picked from commit 40939c7)
rustagir
added a commit
that referenced
this pull request
Apr 4, 2023
* DOCSP-18653: remove username from x509 example * CC suggestions (cherry picked from commit 40939c7)
rustagir
added a commit
that referenced
this pull request
Apr 4, 2023
* DOCSP-18653: remove username from x509 example * CC suggestions (cherry picked from commit 40939c7)
rustagir
added a commit
that referenced
this pull request
Apr 4, 2023
* DOCSP-18653: remove username from x509 example * CC suggestions (cherry picked from commit 40939c7)
rustagir
added a commit
that referenced
this pull request
Apr 4, 2023
* DOCSP-18653: remove username from x509 example * CC suggestions (cherry picked from commit 40939c7)
rustagir
added a commit
that referenced
this pull request
Apr 4, 2023
* DOCSP-18653: remove username from x509 example * CC suggestions (cherry picked from commit 40939c7)
jordan-smith721
pushed a commit
to jordan-smith721/docs-node
that referenced
this pull request
Jul 24, 2023
* DOCSP-18653: remove username from x509 example * CC suggestions (cherry picked from commit 40939c7)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-18653
Staging
Self-Review Checklist