Add JDBC URL sanitizer to prevent credential exposure in logs #1136
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
Implements SecurityUtil.sanitizeJdbcUrl() to redact sensitive parameters (passwords, tokens, secrets, etc.) from JDBC URLs before logging or including them in exception messages. Changes: - Created SecurityUtil class with comprehensive pattern matching for all sensitive parameters from DatabricksJdbcUrlParams (15+ credential types) - Updated Driver.java exception messages to sanitize URLs - Updated DatabricksConnectionContext.java exception messages to sanitize URLs - Updated test files (LoggingTest.java, SSLTest.java) to use sanitizer - Added 20 comprehensive unit tests in SecurityUtilTest All sensitive parameters are redacted including: PASSWORD, PWD, CLIENT_SECRET, AUTH_ACCESS_TOKEN, OAUTH_REFRESH_TOKEN, PROXY credentials, JWT passphrases, SSL store passwords, TOKEN_CACHE_PASS_PHRASE, and UID. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
UID is an identifier (like CLIENT_ID) rather than a secret credential. Keeping it visible in logs helps with debugging while still protecting truly sensitive data (passwords, tokens, secrets). Changes: - Removed UID from CREDENTIAL_PATTERN regex - Updated isCredentialParameter() to not treat UID as sensitive - Updated all tests to verify UID is preserved in sanitized URLs - All 20 tests pass 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
| + "|CLIENT_?SECRET|OAUTH2SECRET" | ||
| + "|AUTH_?ACCESS_?TOKEN" | ||
| + "|AUTH_?REFRESH_?TOKEN|OAUTH_?REFRESH_?TOKEN" | ||
| + "|PROXY_?PWD|CF_?PROXY_?PWD" |
Collaborator
There was a problem hiding this comment.
can we limit to actual values in URL params, for ex: there is no proxy_pwd, only proxypwd. similar for other like truststore/keystore where the key is SSLTrustStorePwd but we check for underscores, full form of password etc.
| * @param parameterName the parameter name to check, case-insensitive | ||
| * @return true if the parameter represents a credential, false otherwise | ||
| */ | ||
| public static boolean isCredentialParameter(String parameterName) { |
Collaborator
There was a problem hiding this comment.
looks like this is not used anywhere?
…ed method
- Use exact JDBC parameter names from DatabricksJdbcUrlParams (no wildcards)
- password, pwd, OAuth2Secret, Auth_AccessToken, Auth_RefreshToken,
OAuthRefreshToken, proxyuid, proxypwd, cfproxyuid, cfproxypwd,
Auth_JWT_Key_Passphrase, SSLTrustStorePwd, SSLKeyStorePwd, TokenCachePassPhrase
- Remove unused isCredentialParameter() method (only used in tests)
- Remove corresponding test for removed method
- Keep UID unredacted (it's an identifier, not a secret)
- All 19 tests passing
Addresses comments from @vikrantpuppala
| + "|Auth_JWT_Key_Passphrase" | ||
| + "|SSLTrustStorePwd|SSLKeyStorePwd" | ||
| + "|TokenCachePassPhrase" | ||
| + ")=[^;&]*", |
Collaborator
There was a problem hiding this comment.
can we use the enums to build this pattern matching string so that we do not have to make changes at multiple places?
Collaborator
There was a problem hiding this comment.
how can we also further ensure that folks add newer connection params containing credentials to this list?
|
|
||
| private SecurityUtil() { | ||
| // Utility class, prevent instantiation | ||
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
Implements a comprehensive JDBC URL sanitizer to prevent accidental exposure of sensitive credentials (passwords, tokens, secrets) in log files and exception messages.
Changes
sanitizeJdbcUrl()method that redacts all sensitive parametersSensitive Parameters Covered
The sanitizer redacts 15+ credential types from DatabricksJdbcUrlParams:
Test Results
All 20 unit tests pass successfully:
Example
Before:
After:
🤖 Generated with Claude Code