[PATCH v2] clone/fetch: anonymize URLs in the reflog
- From
Johannes Schindelin via GitGitGadget <gitgitgadget@gmail.com>
- Date
- Jun 4, 2020, 20:08 UTC
- Message-ID
- <pull.797.v2.git.git.1591301309308.gitgitgadget@gmail.com>
- In-Reply-To
- <pull.797.git.git.1591039202561.gitgitgadget@gmail.com>
From: Johannes Schindelin <johannes.schindelin@gmx.de>
Even if we strongly discourage putting credentials into the URLs passed via the command-line, there _is_ support for that, and users _do_ do that.
Let's scrub them before writing them to the reflog.
Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
---
Anonymize URLs in the reflog
This came up in an internal audit, but we do not consider this to be a
big deal: the reflog is local and not really shared with anybody.
Changes since v1:
* Changed the if...else if...else cadence to move the die() to the last
arm
* Stopped the memory leak of display_repo (allocated by
transport_anonymize_url())Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-797%2Fdscho%2Fanonymize-clone-reflog-v2 Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-797/dscho/anonymize-clone-reflog-v2 Pull-Request: https://github.com/git/git/pull/797
Range-diff vs v1:
1: 11c0d47c95e ! 1: 933a7353847 clone/fetch: anonymize URLs in the reflog
@@ Commit message
Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
## builtin/clone.c ##
-@@ builtin/clone.c: static int path_exists(const char *path)
- int cmd_clone(int argc, const char **argv, const char *prefix)
+@@ builtin/clone.c: int cmd_clone(int argc, const char **argv, const char *prefix)
{
int is_bundle = 0, is_local;
-- const char *repo_name, *repo, *work_tree, *git_dir;
-+ const char *repo_name, *repo, *display_repo, *work_tree, *git_dir;
- char *path, *dir;
+ const char *repo_name, *repo, *work_tree, *git_dir;
+- char *path, *dir;
++ char *path, *dir, *display_repo = NULL;
int dest_exists;
const struct ref *refs, *remote_head;
+ const struct ref *remote_head_points_at;
@@ builtin/clone.c: int cmd_clone(int argc, const char **argv, const char *prefix)
-
path = get_repo_path(repo_name, &is_bundle);
if (path)
-- repo = absolute_pathdup(repo_name);
-+ display_repo = repo = absolute_pathdup(repo_name);
- else if (!strchr(repo_name, ':'))
- die(_("repository '%s' does not exist"), repo_name);
+ repo = absolute_pathdup(repo_name);
+- else if (!strchr(repo_name, ':'))
+- die(_("repository '%s' does not exist"), repo_name);
- else
-+ else {
++ else if (strchr(repo_name, ':')) {
repo = repo_name;
+ display_repo = transport_anonymize_url(repo);
-+ }
++ } else
++ die(_("repository '%s' does not exist"), repo_name);
/* no need to be strict, transport_set_option() will validate it again */
if (option_depth && atoi(option_depth) < 1)
@@ builtin/clone.c: int cmd_clone(int argc, const char **argv, const char *prefix)
"an empty directory."), dir);
- strbuf_addf(&reflog_msg, "clone: from %s", repo);
-+ strbuf_addf(&reflog_msg, "clone: from %s", display_repo);
++ strbuf_addf(&reflog_msg, "clone: from %s",
++ display_repo ? display_repo : repo);
++ free(display_repo);
if (option_bare)
work_tree = NULL;builtin/clone.c | 13 ++++++++----- builtin/fetch.c | 9 +++++++-- t/t5541-http-push-smart.sh | 15 +++++++++++++++ 3 files changed, 30 insertions(+), 7 deletions(-)
diff --git a/builtin/clone.c b/builtin/clone.c index 1ad26f4d8c8..002d23ab0a2 100644 --- a/builtin/clone.c +++ b/builtin/clone.c @@ -939,7 +939,7 @@ int cmd_clone(int argc, const char **argv, const char *prefix) { int is_bundle = 0, is_local; const char *repo_name, *repo, *work_tree, *git_dir; - char *path, *dir; + char *path, *dir, *display_repo = NULL; int dest_exists; const struct ref *refs, *remote_head; const struct ref *remote_head_points_at; @@ -994,10 +994,11 @@ int cmd_clone(int argc, const char **argv, const char *prefix) path = get_repo_path(repo_name, &is_bundle); if (path) repo = absolute_pathdup(repo_name); - else if (!strchr(repo_name, ':')) - die(_("repository '%s' does not exist"), repo_name); - else + else if (strchr(repo_name, ':')) { repo = repo_name; + display_repo = transport_anonymize_url(repo); + } else + die(_("repository '%s' does not exist"), repo_name); /* no need to be strict, transport_set_option() will validate it again */ if (option_depth && atoi(option_depth) < 1) @@ -1014,7 +1015,9 @@ int cmd_clone(int argc, const char **argv, const char *prefix) die(_("destination path '%s' already exists and is not " "an empty directory."), dir); - strbuf_addf(&reflog_msg, "clone: from %s", repo); + strbuf_addf(&reflog_msg, "clone: from %s", + display_repo ? display_repo : repo); + free(display_repo); if (option_bare) work_tree = NULL; diff --git a/builtin/fetch.c b/builtin/fetch.c index bf6bab80fab..d58b7572114 100644 --- a/builtin/fetch.c +++ b/builtin/fetch.c @@ -1765,8 +1765,13 @@ int cmd_fetch(int argc, const char **argv, const char *prefix) /* Record the command line for the reflog */ strbuf_addstr(&default_rla, "fetch"); - for (i = 1; i < argc; i++) - strbuf_addf(&default_rla, " %s", argv[i]); + for (i = 1; i < argc; i++) { + /* This handles non-URLs gracefully */ + char *anon = transport_anonymize_url(argv[i]); + + strbuf_addf(&default_rla, " %s", anon); + free(anon); + } fetch_config_from_gitmodules(&submodule_fetch_jobs_config, &recurse_submodules); diff --git a/t/t5541-http-push-smart.sh b/t/t5541-http-push-smart.sh index 23be8ce92d6..2d60381a5e7 100755 --- a/t/t5541-http-push-smart.sh +++ b/t/t5541-http-push-smart.sh @@ -456,6 +456,21 @@ test_expect_success 'push status output scrubs password' ' grep "^To $HTTPD_URL/smart/test_repo.git" status ' +test_expect_success 'clone/fetch scrubs password from reflogs' ' + cd "$ROOT_PATH" && + git clone "$HTTPD_URL_USER_PASS/smart/test_repo.git" \ + reflog-test && + cd reflog-test && + test_commit prepare-for-force-fetch && + git switch -c away && + git fetch "$HTTPD_URL_USER_PASS/smart/test_repo.git" \ + +master:master && + # should have been scrubbed down to vanilla URL + git log -g master >reflog && + grep "$HTTPD_URL" reflog && + ! grep "$HTTPD_URL_USER_PASS" reflog +' + test_expect_success 'colorize errors/hints' ' cd "$ROOT_PATH"/test_repo_clone && test_must_fail git -c color.transport=always -c color.advice=always \ base-commit: af6b65d45ef179ed52087e80cb089f6b2349f4ec
-- gitgitgadget