feat: add dictionary-based redaction for secrets in logs #508
+3,113
−1,717
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
This sets up a Keychain, a holder of known secrets. When a new secret is created it should be registered in the keychain so loggers can redact them and avoid leaking secrets into our logs.
There was a problem hiding this comment.
Pull Request Overview
This PR implements a dictionary-based redaction system for secrets in logs by introducing a Keychain class that stores known secrets and integrates with the MongoDB redact library to automatically redact sensitive information from log messages.
- Adds a
Keychainclass to manage and register secrets with their types (user, password, url) - Integrates the keychain with all logger classes to enable automatic redaction using the updated mongodb-redact library
- Registers known secrets from configuration and user input automatically in the keychain
Reviewed Changes
Copilot reviewed 13 out of 15 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/common/keychain.ts | New keychain class implementing secret storage and management |
| src/common/logger.ts | Updates all logger classes to accept and use keychain for redaction |
| src/common/config.ts | Adds function to register configuration secrets in root keychain |
| src/common/session.ts | Adds keychain property to session for per-session secret management |
| src/transports/base.ts | Updates logger instantiation to pass keychain instances |
| src/tools/atlas/create/createDBUser.ts | Registers username and password in keychain when creating database users |
| src/tools/atlas/connect/connectCluster.ts | Registers credentials in keychain when connecting to clusters |
| src/index.ts | Updates emergency logger to use keychain |
| package.json | Updates mongodb-redact dependency to version 1.2.0 |
| tests/ | Comprehensive test coverage for keychain functionality and integration |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
It hides the idea of having a root keychain for external users.
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.
Proposed changes
This sets up a Keychain, a holder of known secrets. When a new secret is created it should be registered in the keychain so loggers can redact them and avoid leaking secrets into our logs.
Checklist