Skip to content

DOCSP-42150: CSFLE standardization #102

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 11 commits into from
Feb 10, 2025

Conversation

norareidy
Copy link
Collaborator

@norareidy norareidy commented Feb 3, 2025

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-42150

Staging Links

  • include-link
  • security
  • security/in-use-encryption
  • 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?

    Copy link

    netlify bot commented Feb 3, 2025

    Deploy Preview for docs-cpp ready!

    Name Link
    🔨 Latest commit 70116c8
    🔍 Latest deploy log https://app.netlify.com/sites/docs-cpp/deploys/67aa5fd85c0b8f0008ad6bd0
    😎 Deploy Preview https://deploy-preview-102--docs-cpp.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
    Collaborator

    @stephmarie17 stephmarie17 left a comment

    Choose a reason for hiding this comment

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

    LGTM with some comments 🚀

    To learn more about encryption schemas, see
    :manual:`CSFLE Encryption Schemas </core/csfle/reference/encryption-schemas/>`
    in the {+mdb-server+}
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    Suggested change
    in the {+mdb-server+}
    in the {+mdb-server+} manual.

    Then, apply these options to your client.

    The following example creates a ``options::auto_encryption`` instance
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    Suggested change
    The following example creates a ``options::auto_encryption`` instance
    The following example creates an ``options::auto_encryption`` instance

    to configure explicit encryption with automatic decryption,
    then passes this options instance to the ``auto_encryption_opts`` field
    of a ``options::client``. This creates a client configured to
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    Suggested change
    of a ``options::client``. This creates a client configured to
    of an ``options::client``. This creates a client configured to

    @norareidy norareidy requested review from a team and rcsanchez97 and removed request for a team February 4, 2025 19:26
    @kevinAlbs kevinAlbs requested review from kevinAlbs and removed request for rcsanchez97 February 5, 2025 13:46
    @norareidy norareidy requested a review from kevinAlbs February 10, 2025 16:38
    Automatic encryption allows you to perform encrypted read and write operations
    without specifying how to encrypt fields. To enable automatic encryption, use
    one of the following libraries:
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    Suggested change
    one of the following libraries:
    one of the following:

    Suggest removing "library". Filed DOCSP-47133 to update elsewhere.

    Copy link
    Collaborator Author

    Choose a reason for hiding this comment

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

    Ah okay, thanks for making that ticket

    @norareidy norareidy merged commit f8fbbf5 into mongodb:master Feb 10, 2025
    5 of 6 checks passed
    @norareidy norareidy deleted the DOCSP-42150-csfle-standard branch February 10, 2025 20:49
    norareidy added a commit that referenced this pull request Feb 10, 2025
    * DOCSP-42150: CSFLE standardization
    
    * edits
    
    * code
    
    * edits
    
    * edits
    
    * fix build errors
    
    * SA feedback
    
    * remove
    
    * KA feedback
    
    * link
    
    * KA feedback 2
    
    (cherry picked from commit f8fbbf5)
    norareidy added a commit that referenced this pull request Feb 10, 2025
    * DOCSP-42150: CSFLE standardization
    
    * edits
    
    * code
    
    * edits
    
    * edits
    
    * fix build errors
    
    * SA feedback
    
    * remove
    
    * KA feedback
    
    * link
    
    * KA feedback 2
    
    (cherry picked from commit f8fbbf5)
    (cherry picked from commit 43afbb1)
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    None yet
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants