clone/fetch: anonymize URLs in the reflog
PATCH 1/1 clone/fetch: anonymize URLs in the reflog
From: Johannes Schindelin <[email protected]>
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.
---
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.
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-797%2Fdscho%2Fanonymize-clone-reflog-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-797/dscho/anonymize-clone-reflog-v1
Pull-Request: https://github.com/git/git/pull/797
builtin/clone.c | 10 ++++++---- builtin/fetch.c | 9 +++++++-- t/t5541-http-push-smart.sh | 15 +++++++++++++++ 3 files changed, 28 insertions(+), 6 deletions(-)
builtin/clone.c +6 -4
@@ -938,7 +938,7 @@ static int path_exists(const char *path)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;int dest_exists;const struct ref *refs, *remote_head;
@@ -993,11 +993,13 @@ 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); -else +else { repo = repo_name; + display_repo =transport_anonymize_url (repo); + }/* no need to be strict, transport_set_option() will validate it again */ if (option_depth &&atoi (option_depth) <1 )
@@ -1014,7 +1016,7 @@ 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);if (option_bare) work_tree =NULL ;
builtin/fetch.c +7 -2
@@ -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);
t/t5541-http-push-smart.sh +15 -0
@@ -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
Signature · 1 line
gitgitgadget
Quoted 7 lines · Johannes Schindelin via GitGitGadget
From: Johannes Schindelin <[email protected]>
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.
Good idea.
Quoted 2 lines
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.
Agreed.
Quoted 3 lines
builtin/clone.c | 10 ++++++---- builtin/fetch.c | 9 +++++++-- t/t5541-http-push-smart.sh | 15 +++++++++++++++
The patch itself looks very neatly done.
builtin/clone.c int cmd_clone(int argc, const char **argv, const char *prefix) · line 1002
Quoted 13 lines
builtin/clone.c +4
-2@@ -993,11 +993,13 @@ 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); -else +else { repo = repo_name; + display_repo =transport_anonymize_url (repo); + }
Not introduced by your patch, but I had to read this a few times to make sure we always end up with repo and display_repo set. IMHO it would be easier to read as:
if (this) {
repo = ...;
display_repo = ...;
} else if (that) {
repo = ...;
display_repo = ...;
} else {
die(...);
}instead of sticking the die() in the middle. Maybe just personal preference, though. :)
t/t5541-http-push-smart.sh test_expect_success 'push status output scrubs password' ' · line 472
Quoted 5 lines
t/t5541-http-push-smart.sh +5
-0+ # should have been scrubbed down to vanilla URL + git log -g master >reflog && + grep "$HTTPD_URL" reflog && + ! grep "$HTTPD_URL_USER_PASS" reflog +'
And you make sure we retain the username. Nice.
-Peff
Quoted 8 lines · Jeff King
Quoted 6 lines · Johannes Schindelin via GitGitGadget
From: Johannes Schindelin <[email protected]>
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.
Quoted 8 lines
Quoted 1 line
Let's scrub them before writing them to the reflog.
Good idea.
Quoted 2 lines
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.
Agreed.
Nice.
Quoted 34 lines
Quoted 3 lines
builtin/clone.c | 10 ++++++---- builtin/fetch.c | 9 +++++++-- t/t5541-http-push-smart.sh | 15 +++++++++++++++The patch itself looks very neatly done.
builtin/clone.c int cmd_clone(int argc, const char **argv, const char *prefix) · line 1002
Quoted 13 lines
builtin/clone.c +4
-2@@ -993,11 +993,13 @@ 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); -else +else { repo = repo_name; + display_repo =transport_anonymize_url (repo); + }Not introduced by your patch, but I had to read this a few times to make sure we always end up with repo and
display_reposet. IMHO it would be easier to read as:if (this) { repo = ...; display_repo = ...; } else if (that) { repo = ...; display_repo = ...; } else { die(...); }
Quoted 2 lines
instead of sticking the
die()in the middle. Maybe just personal preference, though. :)
For a if/elseif cascade of few-liner blocks each, I do not think it would matter, but if a block were larger, having the die() case at the beginning or at the end would indeed make it easier to spot any anomalies.
Quoted 7 lines
t/t5541-http-push-smart.sh test_expect_success 'push status output scrubs password' ' · line 472
Quoted 5 lines
t/t5541-http-push-smart.sh +5
-0+ # should have been scrubbed down to vanilla URL + git log -g master >reflog && + grep "$HTTPD_URL" reflog && + ! grep "$HTTPD_URL_USER_PASS" reflog +'And you make sure we retain the username. Nice.
PATCH v2 1/1 clone/fetch: anonymize URLs in the reflog
In reply to Johannes Schindelin via GitGitGadgetFrom: Johannes Schindelin <[email protected]>
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.
---
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 <[email protected]>
## 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(-)
builtin/clone.c +8 -5
@@ -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 ;
builtin/fetch.c +7 -2
@@ -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);
t/t5541-http-push-smart.sh +15 -0
@@ -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
Signature · 1 line
gitgitgadget
"Johannes Schindelin via GitGitGadget" <[email protected]>
Quoted 29 lines · writes:
builtin/clone.c +5
-4@@ -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 )
builtin/clone.c int cmd_clone(int argc, const char **argv, const char *prefix) · line 1020
Quoted 7 lines
builtin/clone.c +3
-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);
The new patch is easier to see because display_repo becomes non NULL only when anonymization was necessary and done. Makes sense.
Will queue. Thanks.