fix(helpers): mask credentials in git URL debug logs#1445
Open
snoopuppy582 wants to merge 1 commit into
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
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.
Purpose
Fixes #1426 by preventing credentials embedded in HTTPS git remotes from being written to debug logs when
parse_git_url()starts parsing a URL.Rationale
The parser should still receive and return the original URL data, but the log message does not need to include userinfo from the URL netloc. This changes only the value passed to the debug log call, replacing any
user[:password]@hostsection with<credentials>@hostwhile leaving parsing behavior unchanged.How did you test?
https://x-oauth-basic:<token>@github.example.com/owner/project.git, confirms parsing still succeeds, and confirms the token/username are absent from captured logs.python -m pytest tests/unit/semantic_release/test_helpers.py -q.ruff check src/semantic_release/helpers.py tests/unit/semantic_release/test_helpers.py.ruff format --check src/semantic_release/helpers.py tests/unit/semantic_release/test_helpers.py.How to Verify
python -m pytest tests/unit/semantic_release/test_helpers.py -q.-vvagainst an HTTPS remote containing userinfo and confirm theParsing git urldebug line shows<credentials>@hostinstead of the raw credential-bearing URL.PR Completion Checklist
Reviewed & followed the Contributor Guidelines
Changes Implemented & Validation pipeline succeeds
Commits follow the Conventional Commits standard
and are separated into the proper commit type and scope (recommended order: test, build, feat/fix, docs)
Appropriate Unit tests added/updated
Appropriate End-to-End tests added/updated
Appropriate Documentation added/updated and syntax validated for sphinx build (see Contributor Guidelines)