fix: Secure token storage to prevent memory exposure #12
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 commit addresses critical security vulnerabilities related to token exposure in memory by implementing a hybrid approach that combines secure storage with on-demand connection string building. **Security Issues Fixed:** - Token stored in cached connection strings (indefinite memory exposure) - Plain std::string storage susceptible to memory dumps - Tokens potentially visible in error messages and logs - No secure zeroing of sensitive data after use **Changes:** 1. **SecureString Implementation** (include/databricks/internal/secure_string.h) - Custom allocator with memory locking (mlock/VirtualLock) - Secure zeroing using volatile writes to prevent compiler optimization - Platform-specific implementations (Windows/Linux/macOS) - Utility functions for safe token handling 2. **AuthConfig Security Enhancement** (include/databricks/core/config.h) - Added private SecureString secure_token_ member - Added set_token() and get_secure_token() methods - Maintained backward compatibility with public token field - Updated config loading to use secure storage 3. **Connection String Caching Removed** (src/core/client.cpp) - Removed cached_connection_string member - Build connection strings on-demand only - Secure zero immediately after SQLDriverConnect() call - Clear ODBC output buffer that may contain sensitive data 4. **Token Sanitization** (src/core/client.cpp) - Added sanitize_error_message() to redact tokens from logs - Pattern matching to remove PWD=<value> from error strings - Applied to all error logging locations 5. **PoolKey Security** (src/internal/pool_manager.h/cpp) - Changed token storage from std::string to SecureString - Updated hash computation and equality operators 6. **Security Test Suite** (tests/unit/core/security_test.cpp) - 12 comprehensive test cases - Validates secure zeroing, token handling, and backward compatibility **Backward Compatibility:** - No breaking API changes - Public token field still works - Gradual migration path available - Suitable for minor version bump (v0.2.5 or v0.3.0) **Testing:** - All 120 tests pass (108 existing + 12 new security tests) - No regressions introduced - Verified on macOS with AppleClang 17.0.0 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This commit addresses critical security vulnerabilities related to token exposure in memory by implementing a hybrid approach that combines secure storage with on-demand connection string building.
Description
Security Issues Fixed:
Backward Compatibility:
Testing:
Type of Change
Testing
Introduced 12 new unit tests ensuring the security of token exposure with the SDK.
Checklist