Github credentials leak in logs

alanbover commented 8 months ago

Community Note

Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request. Searching for pre-existing feature requests helps us consolidate datapoints for identical requirements into a single place, thank you!
Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.
If you are interested in working on this issue or have submitted a pull request, please leave a comment.

Overview of the Issue

Atlantis can leaks Github credentials in logs. See an example of a log leaking some:

getting remote update failed: error: could not lock config file .git/config: File exists
fatal: could not set 'remote.head.url' to 'https://<redacted>:ghp_<redacted>@github.com/<redacted>/<redacted>.git'

This happens because, when using a github user and token, the remote is being configured as https://<GH_user>:<GH Token>@github.com/<org>/<repo>.git , and logged git command errors that reference to this remote will end up accidentally leaking the credentials.

Here we can see how the command error is directly logged https://github.com/runatlantis/atlantis/blob/1035d9263a687e6a43a102fa44030f3f4c93f579/server/events/working_dir.go#L188

Atlantis should parse the output first and figure out if the token is being leaked. In that case, it should redact it.

Reproduction Steps

I don't have specific instructions to reproduce the problem. The specific error we see (getting remote update failed: error: could not lock config file .git/config: File exists) seems to happen due to a non-parallelizable git operation, so I guess it happens when many plans are created for the same PR.

Logs

Environment details

Atlantis version: 0.27.0
Deployment method: k8s objects directly (kustomize)
If not running the latest Atlantis version have you tried to reproduce this issue on the latest version:
Atlantis flags:

Additional Context

nitrocode commented 8 months ago

Please fill out the rest of the template. It would be good to know if this impacts the latest version

marco-m commented 8 months ago

In case you are interested, we have code to avoid leaking passwords encoded in URLs: https://github.com/Pix4D/cogito/blob/master/github/url.go

nnovaeshc commented 7 months ago

This seems to duplicate https://github.com/runatlantis/atlantis/issues/4060

runatlantis / atlantis