Fix sqlalchemy password leakage #408
Open
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
Switches away from using `str(engine_instance.engine)` for rendering connection strings, in order to prevent passwords containing characters such as `#` from leaking. The name of the segment will contain the password if this character is used, likely others as well. See: https://bugs.python.org/issue18140 and encode/database#145 The code in question is here: sqlalchemy/sqlalchemy/blob/aea28a9/lib/sqlalchemy/engine/url.py#L597-L630
This uses the same technique of extracting the engine url from the correctly sanitized `__str__()` representation of the engine that the `ext.sqlalchemy.util.decorators.py` module relies on, which does not leak passwords in manner outlined in 9f22fff.
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.
Issue #, if available:
No issue created.
Description of changes:
I attempted to add tests to demonstrate this, but the
testing.postgresdependency uses the default username without a password in a manner that I couldn't easily override. If you are interested in setting up a reproduction case, use a password that contains the character#in it and send the generated sqlalchemy segments to AWS. The name of the segment will include the password in it.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.