Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix _cast_urlstr to use unquote vs unquote_plus #357

Closed
KyleKaniecki opened this issue Dec 13, 2021 · 1 comment
Closed

Fix _cast_urlstr to use unquote vs unquote_plus #357

KyleKaniecki opened this issue Dec 13, 2021 · 1 comment
Assignees
Labels
bug Something isn't working

Comments

@KyleKaniecki
Copy link
Contributor

Currently, Env.db_url_config uses _cast_urlstr to url unquote the username and password from database connection URIs. The underlying problem occurs when you try to use a + in your postgres password.

_cast_urlstr uses unquote_plus, (introduced in this PR here), which which will turn plus signs into spaces when unquoted. This is undesired, as plus signs should only be replaced for spaces in HTML form values that are URL encoded, not in connection URIs.

Unquote docs
unquote vs unquote_plus

This bug was discovered when using CrunchyData's PGO on kubernetes. The PGO autogenerates postgres URIs for users and stores them inside of a kubernetes secret. An example URI is shown below:

postgresql://myuser:Le-%7BFsIaYnaQw%7Da2B%2F%[email protected]:5432/mydb

Using the different unquotes to decode the password:

>>> unquote('Le-%7BFsIaYnaQw%7Da2B%2F%5BV8bS+')
'Le-{FsIaYnaQw}a2B/[V8bS+'

>>> unquote_plus('Le-%7BFsIaYnaQw%7Da2B%2F%5BV8bS+')
'Le-{FsIaYnaQw}a2B/[V8bS '

The first one can be used to sign into the database using both psql and psycopg2.connect, while the second gives an auth error.

I ran the test suite for django-environ using both unquote_plus and unquote and all tests passed, regardless of which implementation is used, so I believe moving to unquote shouldn't be a huge change. I'll open a PR with changes and link them to this issue.

@sergeyklay sergeyklay self-assigned this Jan 2, 2022
@sergeyklay sergeyklay added the bug Something isn't working label Jan 2, 2022
@sergeyklay
Copy link
Collaborator

Fixed in #358. Thank you for contributing!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants