PYTHON-5927 Redact TLS keyfile password from client repr#2830
Open
dfgvaetyj3456356-hash wants to merge 2 commits into
Open
PYTHON-5927 Redact TLS keyfile password from client repr#2830dfgvaetyj3456356-hash wants to merge 2 commits into
dfgvaetyj3456356-hash wants to merge 2 commits into
Conversation
Signed-off-by: dfgvaetyj3456356-hash <185460949+dfgvaetyj3456356-hash@users.noreply.github.com>
|
Assigned |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR prevents accidental secret disclosure by redacting the TLS client key passphrase (tlsCertificateKeyFilePassword / tlscertificatekeyfilepassword) from MongoClient and AsyncMongoClient repr() output, while keeping the option visible for debugging. It adds regression tests to ensure the passphrase no longer appears in repr(client).
Changes:
- Redact
tlscertificatekeyfilepasswordinMongoClient/AsyncMongoClientrepr rendering. - Add sync + async unit tests asserting
repr()contains'<redacted>'and does not contain the raw passphrase.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| test/test_client.py | Adds a unit test verifying TLS keyfile passphrase is redacted from MongoClient.__repr__. |
| test/asynchronous/test_client.py | Adds a unit test verifying TLS keyfile passphrase is redacted from AsyncMongoClient.__repr__. |
| pymongo/synchronous/mongo_client.py | Implements repr redaction for tlscertificatekeyfilepassword. |
| pymongo/asynchronous/mongo_client.py | Implements repr redaction for tlscertificatekeyfilepassword. |
Comment on lines
+1310
to
+1311
| if option in {"tlscertificatekeyfilepassword"}: | ||
| return f"{option}='<redacted>'" |
Comment on lines
+1310
to
+1311
| if option in {"tlscertificatekeyfilepassword"}: | ||
| return f"{option}='<redacted>'" |
Contributor
|
Hi, thanks for your contribution. Please update your pull request to be in line with out pull request template guidelines. |
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.
Summary
tlsCertificateKeyFilePasswordwhen renderingMongoClient/AsyncMongoClientrepr outputWhy
tlsCertificateKeyFilePasswordis a passphrase for encrypted client certificate key files. Before this change, creating a client with that option and logging or inspectingrepr(client)included the raw passphrase. This keeps the option visible for debugging while avoiding disclosure of the secret value.This is intentionally scoped to the TLS keyfile passphrase and does not touch
authMechanismProperties, which is already covered by a separate open PR.Test