Mask URL credentials in the build log #1238
Open
+285
−3
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 PR allows credentials in URLs written to the build log by the Git CLI client to be masked. The JGit client is not affected. The functionality is controlled by a system property,
org.jenkinsci.plugins.gitclient.CliGitAPIImpl.maskUrlCredentials
, and is disabled by default. When enabled, the first occurrence of a URL with credentials will have the credentials replaced byxxxxx
before being written to the build log. URLs that appear in error messages are not masked to aid in pipeline troubleshooting.For example, a URL of
https://foo:[email protected]/git/my-repo.git
will be written to the build log ashttps://[email protected]/git/my-repo.git
.Testing done
Unit tests were added to cover new and modified code, confirmed by the Jacoco report.
The change was manually tested using a pipeline that:
password
parameter, used in the URL for SCM operationsSubmitter checklist