Skip to content

Authentication refactor #284

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
merged 17 commits into from
Nov 27, 2024
Merged

Authentication refactor #284

merged 17 commits into from
Nov 27, 2024

Conversation

mongoKart
Copy link
Collaborator

@mongoKart mongoKart commented Oct 31, 2024

PR changes:

  • Moves each mechanism to its own page
  • Adds API links to each page
  • Removes Enterprise Authentication section
  • Adds table on product compatibility to Auth landing page
  • Small fixes mentioned in DOCSP-43931
  • Other small improvements on placeholders, troubleshooting, wording

Pull Request Info

PR Reviewing Guidelines

JIRA:

Staging Links

  • fundamentals/authentication/aws-iam
  • fundamentals/authentication/kerberos
  • fundamentals/authentication/ldap
  • fundamentals/authentication/oidc
  • fundamentals/authentication/scram
  • fundamentals/authentication/x509
  • connection-troubleshooting
  • fundamentals
  • fundamentals/authentication
  • Self-Review Checklist

    • Is this free of any warnings or errors in the RST?
    • Did you run a spell-check?
    • Did you run a grammar-check?
    • Are all the links working?
    • Are the facets and meta keywords accurate?

    @mongoKart mongoKart marked this pull request as ready for review October 31, 2024 15:47
    Copy link

    netlify bot commented Oct 31, 2024

    Deploy Preview for mongodb-docs-csharp ready!

    Name Link
    🔨 Latest commit 90e03b3
    🔍 Latest deploy log https://app.netlify.com/sites/mongodb-docs-csharp/deploys/673f49844a92aa0008ab63a4
    😎 Deploy Preview https://deploy-preview-284--mongodb-docs-csharp.netlify.app
    📱 Preview on mobile
    Toggle QR Code...

    QR Code

    Use your smartphone camera to open QR code link.

    To edit notification comments on pull requests, go to your Netlify site configuration.

    Copy link
    Contributor

    @rustagir rustagir left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    looks good!

    @rishitb-mongodb
    Copy link
    Collaborator

    @mongoKart

    • The new SCRAM page doesn't tell the user how to use SCRAM 256 vs SCRAM 1? Unlike the older page, is this intentional?
    • I didn't see a callout for not needing a port number when connecting to Atlas.

    Everything else looks good. Thank you for the updates!


    .. code-block:: csharp

    var connectionString = "mongodb://<hostname>[:<port>]/?authMechanism=MONGODB-X509";
    Copy link
    Collaborator Author

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Note to tech reviewer: Rishit got a timeout exception when using this code sample to connect to his deployment. Is the code sample correct?

    Copy link
    Member

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    The time-out problem related to wrong connection string (it should be mongo+srv for Atlas)

    Copy link
    Member

    @sanych-sun sanych-sun Nov 18, 2024

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    I've provided list of additional steps to successful connection to Atlas with x509 certificate via Slack, we can discuss if some of the steps should be incorporated into the page.

    ----------------------------------------------

    To use SCRAM to authenticate your MongoDB user, specify your
    MongoDB credentials, but don't specify an authentication mechanism.
    Copy link
    Collaborator Author

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Question for tech reviewer: Do we need to show how to explicitly specify SCRAM-1 or SCRAM-256? I assumed users would want to use the best one supported by their deployment.

    Copy link
    Member

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    User can specify SCRAM-1 or SCRAM-256 explicitly by setting authMechanism parameter. However if authMechanism is omitted: driver tries to use more secure mechanism (SCRAM-256) if server supports it.

    Copy link
    Collaborator Author

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    If the user omits authMechanism and the server doesn't support SCRAM-256, does the driver default to SCRAM-1?

    I'm wondering if the user would ever need to explicitly specify SCRAM-1, or if the driver would automatically negotiate the most secure SCRAM protocol.

    @mongoKart mongoKart requested review from sanych-sun and removed request for rishitb-mongodb November 4, 2024 18:56
    Copy link
    Member

    @sanych-sun sanych-sun left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    LGTM

    @mongoKart mongoKart merged commit bf67d80 into mongodb:master Nov 27, 2024
    11 checks passed
    @mongoKart mongoKart deleted the auth-changes branch November 27, 2024 15:13
    Copy link

    The backport to v3.0 failed:

    The process '/usr/bin/git' failed with exit code 1
    

    To backport manually, run these commands in your terminal:

    # Fetch latest updates from GitHub
    git fetch
    # Create a new working tree
    git worktree add .worktrees/backport-v3.0 v3.0
    # Navigate to the new working tree
    cd .worktrees/backport-v3.0
    # Create a new branch
    git switch --create backport-284-to-v3.0
    # Cherry-pick the merged commit of this pull request and resolve the conflicts
    git cherry-pick -x --mainline 1 bf67d808c3dc903d669f0891e611a57cd803f610
    # Push it to GitHub
    git push --set-upstream origin backport-284-to-v3.0
    # Go back to the original working tree
    cd ../..
    # Delete the working tree
    git worktree remove .worktrees/backport-v3.0

    Then, create a pull request where the base branch is v3.0 and the compare/head branch is backport-284-to-v3.0.

    Copy link

    The backport to v2.30 failed:

    The process '/usr/bin/git' failed with exit code 1
    

    To backport manually, run these commands in your terminal:

    # Fetch latest updates from GitHub
    git fetch
    # Create a new working tree
    git worktree add .worktrees/backport-v2.30 v2.30
    # Navigate to the new working tree
    cd .worktrees/backport-v2.30
    # Create a new branch
    git switch --create backport-284-to-v2.30
    # Cherry-pick the merged commit of this pull request and resolve the conflicts
    git cherry-pick -x --mainline 1 bf67d808c3dc903d669f0891e611a57cd803f610
    # Push it to GitHub
    git push --set-upstream origin backport-284-to-v2.30
    # Go back to the original working tree
    cd ../..
    # Delete the working tree
    git worktree remove .worktrees/backport-v2.30

    Then, create a pull request where the base branch is v2.30 and the compare/head branch is backport-284-to-v2.30.

    Copy link

    The backport to v2.29 failed:

    The process '/usr/bin/git' failed with exit code 1
    

    To backport manually, run these commands in your terminal:

    # Fetch latest updates from GitHub
    git fetch
    # Create a new working tree
    git worktree add .worktrees/backport-v2.29 v2.29
    # Navigate to the new working tree
    cd .worktrees/backport-v2.29
    # Create a new branch
    git switch --create backport-284-to-v2.29
    # Cherry-pick the merged commit of this pull request and resolve the conflicts
    git cherry-pick -x --mainline 1 bf67d808c3dc903d669f0891e611a57cd803f610
    # Push it to GitHub
    git push --set-upstream origin backport-284-to-v2.29
    # Go back to the original working tree
    cd ../..
    # Delete the working tree
    git worktree remove .worktrees/backport-v2.29

    Then, create a pull request where the base branch is v2.29 and the compare/head branch is backport-284-to-v2.29.

    Copy link

    The backport to v2.28 failed:

    The process '/usr/bin/git' failed with exit code 1
    

    To backport manually, run these commands in your terminal:

    # Fetch latest updates from GitHub
    git fetch
    # Create a new working tree
    git worktree add .worktrees/backport-v2.28 v2.28
    # Navigate to the new working tree
    cd .worktrees/backport-v2.28
    # Create a new branch
    git switch --create backport-284-to-v2.28
    # Cherry-pick the merged commit of this pull request and resolve the conflicts
    git cherry-pick -x --mainline 1 bf67d808c3dc903d669f0891e611a57cd803f610
    # Push it to GitHub
    git push --set-upstream origin backport-284-to-v2.28
    # Go back to the original working tree
    cd ../..
    # Delete the working tree
    git worktree remove .worktrees/backport-v2.28

    Then, create a pull request where the base branch is v2.28 and the compare/head branch is backport-284-to-v2.28.

    Copy link

    The backport to v2.27 failed:

    The process '/usr/bin/git' failed with exit code 1
    

    To backport manually, run these commands in your terminal:

    # Fetch latest updates from GitHub
    git fetch
    # Create a new working tree
    git worktree add .worktrees/backport-v2.27 v2.27
    # Navigate to the new working tree
    cd .worktrees/backport-v2.27
    # Create a new branch
    git switch --create backport-284-to-v2.27
    # Cherry-pick the merged commit of this pull request and resolve the conflicts
    git cherry-pick -x --mainline 1 bf67d808c3dc903d669f0891e611a57cd803f610
    # Push it to GitHub
    git push --set-upstream origin backport-284-to-v2.27
    # Go back to the original working tree
    cd ../..
    # Delete the working tree
    git worktree remove .worktrees/backport-v2.27

    Then, create a pull request where the base branch is v2.27 and the compare/head branch is backport-284-to-v2.27.

    Copy link

    The backport to v2.26 failed:

    The process '/usr/bin/git' failed with exit code 1
    

    To backport manually, run these commands in your terminal:

    # Fetch latest updates from GitHub
    git fetch
    # Create a new working tree
    git worktree add .worktrees/backport-v2.26 v2.26
    # Navigate to the new working tree
    cd .worktrees/backport-v2.26
    # Create a new branch
    git switch --create backport-284-to-v2.26
    # Cherry-pick the merged commit of this pull request and resolve the conflicts
    git cherry-pick -x --mainline 1 bf67d808c3dc903d669f0891e611a57cd803f610
    # Push it to GitHub
    git push --set-upstream origin backport-284-to-v2.26
    # Go back to the original working tree
    cd ../..
    # Delete the working tree
    git worktree remove .worktrees/backport-v2.26

    Then, create a pull request where the base branch is v2.26 and the compare/head branch is backport-284-to-v2.26.

    mongoKart added a commit that referenced this pull request Nov 27, 2024
    Co-authored-by: Rea Rustagi <[email protected]>
    (cherry picked from commit bf67d80)
    mongoKart added a commit to mongoKart/docs-csharp that referenced this pull request Nov 27, 2024
    Co-authored-by: Rea Rustagi <[email protected]>
    (cherry picked from commit bf67d80)
    mongoKart added a commit that referenced this pull request Nov 27, 2024
    * Authentication refactor (#284)
    
    Co-authored-by: Rea Rustagi <[email protected]>
    (cherry picked from commit bf67d80)
    mongoKart added a commit that referenced this pull request Nov 27, 2024
    * Authentication refactor (#284)
    
    Co-authored-by: Rea Rustagi <[email protected]>
    (cherry picked from commit bf67d80)
    (cherry picked from commit 3999260)
    mongoKart added a commit that referenced this pull request Nov 27, 2024
    * Authentication refactor (#284)
    
    Co-authored-by: Rea Rustagi <[email protected]>
    (cherry picked from commit bf67d80)
    (cherry picked from commit 3999260)
    mongoKart added a commit that referenced this pull request Nov 27, 2024
    * Authentication refactor (#284)
    
    Co-authored-by: Rea Rustagi <[email protected]>
    (cherry picked from commit bf67d80)
    (cherry picked from commit 3999260)
    mongoKart added a commit to mongoKart/docs-csharp that referenced this pull request Nov 27, 2024
    * Authentication refactor (mongodb#284)
    
    Co-authored-by: Rea Rustagi <[email protected]>
    (cherry picked from commit bf67d80)
    (cherry picked from commit 3999260)
    (cherry picked from commit a162754)
    mongoKart added a commit that referenced this pull request Nov 27, 2024
    Co-authored-by: Rea Rustagi <[email protected]>
    (cherry picked from commit a162754)
    mongoKart added a commit to mongoKart/docs-csharp that referenced this pull request Nov 27, 2024
    Co-authored-by: Rea Rustagi <[email protected]>
    (cherry picked from commit a162754)
    
    (cherry picked from commit 6f96497)
    mongoKart added a commit that referenced this pull request Nov 27, 2024
    Co-authored-by: Rea Rustagi <[email protected]>
    (cherry picked from commit 6f96497)
    mongoKart added a commit to mongoKart/docs-csharp that referenced this pull request Nov 27, 2024
    …ngodb#327)
    
    Co-authored-by: Rea Rustagi <[email protected]>
    (cherry picked from commit 6f96497)
    (cherry picked from commit f3eb7fc)
    mongoKart added a commit to mongoKart/docs-csharp that referenced this pull request Nov 27, 2024
    …ngodb#327)
    
    Co-authored-by: Rea Rustagi <[email protected]>
    (cherry picked from commit 6f96497)
    (cherry picked from commit f3eb7fc)
    mongoKart added a commit to mongoKart/docs-csharp that referenced this pull request Nov 27, 2024
    Co-authored-by: Rea Rustagi <[email protected]>
    (cherry picked from commit bf67d80)
    mongoKart added a commit that referenced this pull request Dec 20, 2024
    * Authentication refactor (#284)
    
    Co-authored-by: Rea Rustagi <[email protected]>
    (cherry picked from commit bf67d80)
    (cherry picked from commit 3999260)
    mongoKart added a commit to mongoKart/docs-csharp that referenced this pull request May 16, 2025
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants