From a78fbb4fb6c69d96cb91dee9d4733d2326c6d019 Mon Sep 17 00:00:00 2001 From: Jeff King Date: Sat, 10 Dec 2011 05:31:34 -0500 Subject: [PATCH] credential: make relevance of http path configurable When parsing a URL into a credential struct, we carefully record each part of the URL, including the path on the remote host, and use the result as part of the credential context. This had two practical implications: 1. Credential helpers which store a credential for later access are likely to use the "path" portion as part of the storage key. That means that a request to https://example.com/foo.git would not use the same credential that was stored in an earlier request for: https://example.com/bar.git 2. The prompt shown to the user includes all relevant context, including the path. In most cases, however, users will have a single password per host. The behavior in (1) will be inconvenient, and the prompt in (2) will be overly long. This patch introduces a config option to toggle the relevance of http paths. When turned on, we use the path as before. When turned off, we drop the path component from the context: helpers don't see it, and it does not appear in the prompt. This is nothing you couldn't do with a clever credential helper at the start of your stack, like: [credential "http://"] helper = "!f() { grep -v ^path= ; }; f" helper = your_real_helper But doing this: [credential] useHttpPath = false is way easier and more readable. Furthermore, since most users will want the "off" behavior, that is the new default. Users who want it "on" can set the variable (either for all credentials, or just for a subset using credential.*.useHttpPath). Signed-off-by: Jeff King Signed-off-by: Junio C Hamano --- credential.c | 14 ++++++++++++++ credential.h | 3 ++- t/t0300-credentials.sh | 29 +++++++++++++++++++++++++++++ t/t5550-http-fetch.sh | 2 +- 4 files changed, 46 insertions(+), 2 deletions(-) diff --git a/credential.c b/credential.c index 3c17ea1973..a17eafea58 100644 --- a/credential.c +++ b/credential.c @@ -69,16 +69,30 @@ static int credential_config_callback(const char *var, const char *value, if (!c->username) c->username = xstrdup(value); } + else if (!strcmp(key, "usehttppath")) + c->use_http_path = git_config_bool(var, value); return 0; } +static int proto_is_http(const char *s) +{ + if (!s) + return 0; + return !strcmp(s, "https") || !strcmp(s, "http"); +} + static void credential_apply_config(struct credential *c) { if (c->configured) return; git_config(credential_config_callback, c); c->configured = 1; + + if (!c->use_http_path && proto_is_http(c->protocol)) { + free(c->path); + c->path = NULL; + } } static void credential_describe(struct credential *c, struct strbuf *out) diff --git a/credential.h b/credential.h index e5042723a8..96ea41bd1c 100644 --- a/credential.h +++ b/credential.h @@ -6,7 +6,8 @@ struct credential { struct string_list helpers; unsigned approved:1, - configured:1; + configured:1, + use_http_path:1; char *username; char *password; diff --git a/t/t0300-credentials.sh b/t/t0300-credentials.sh index 53e94bc038..885af8fb62 100755 --- a/t/t0300-credentials.sh +++ b/t/t0300-credentials.sh @@ -247,4 +247,33 @@ test_expect_success 'pull username from config' ' EOF ' +test_expect_success 'http paths can be part of context' ' + check fill "verbatim foo bar" <<-\EOF && + protocol=https + host=example.com + path=foo.git + -- + username=foo + password=bar + -- + verbatim: get + verbatim: protocol=https + verbatim: host=example.com + EOF + test_config credential.https://example.com.useHttpPath true && + check fill "verbatim foo bar" <<-\EOF + protocol=https + host=example.com + path=foo.git + -- + username=foo + password=bar + -- + verbatim: get + verbatim: protocol=https + verbatim: host=example.com + verbatim: path=foo.git + EOF +' + test_done diff --git a/t/t5550-http-fetch.sh b/t/t5550-http-fetch.sh index 3262f903e1..95a133d697 100755 --- a/t/t5550-http-fetch.sh +++ b/t/t5550-http-fetch.sh @@ -53,7 +53,7 @@ test_expect_success 'setup askpass helpers' ' ' expect_askpass() { - dest=$HTTPD_DEST/auth/repo.git + dest=$HTTPD_DEST { case "$1" in none) -- 2.43.2