CSHARP-6206: KMS master key exposure via unredacted credential serialization in driver settings string (port to main branch) - #2113
Open
papafe wants to merge 1 commit into
Open
Conversation
…ization in driver settings string (port to main branch)
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The change is narrowly scoped to string serialization, includes targeted test updates/additions, and effectively prevents credential exposure without affecting operational encryption behavior.
Pull request overview
This PR addresses a security issue in the C# driver’s settings string representation by ensuring KMS provider credentials are not serialized in AutoEncryptionOptions.ToString() (which is surfaced via MongoClientSettings.ToString()), preventing accidental leakage of sensitive key material into logs/telemetry.
Changes:
- Redacts all KMS provider option values in
AutoEncryptionOptions.ToString()while retaining provider names. - Updates the existing
ToString_should_return_expected_resulttest to match the redacted output. - Adds tests to verify KMS provider credentials are not exposed and that empty
kmsProvidersare rendered correctly.
File summaries
| File | Description |
|---|---|
src/MongoDB.Driver/AutoEncryptionOptions.cs |
Changes ToString() to emit KmsProviders as { "<provider>" : "<hidden>" } for each provider, preventing credential/key leakage. |
tests/MongoDB.Driver.Tests/Encryption/AutoEncryptionOptionsTests.cs |
Updates/extends ToString() assertions to validate redaction behavior and empty-provider formatting. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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
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.
https://jira.mongodb.org/browse/CSHARP-6206