http: hoist credential request out of handle_curl_result

When we are handling a curl response code in http_request or in the remote-curl RPC code, we use the handle_curl_result helper to translate curl's response into an easy-to-use code. When we see an HTTP 401, we do one of two things: 1. If we already had a filled-in credential, we mark it as rejected, and then return HTTP_NOAUTH to indicate to the caller that we failed. 2. If we didn't, then we ask for a new credential and tell the caller HTTP_REAUTH to indicate that they may want to try again. Rejecting in the first case makes sense; it is the natural result of the request we just made. However, prompting for more credentials in the second step does not always make sense. We do not know for sure that the caller is going to make a second request, and nor are we sure that it will be to the same URL. Logically, the prompt belongs not to the request we just finished, but to the request we are (maybe) about to make. In practice, it is very hard to trigger any bad behavior. Currently, if we make a second request, it will always be to the same URL (even in the face of redirects, because curl handles the redirects internally). And we almost always retry on HTTP_REAUTH these days. The one exception is if we are streaming a large RPC request to the server (e.g., a pushed packfile), in which case we cannot restart. It's extremely unlikely to see a 401 response at this stage, though, as we would typically have seen it when we sent a probe request, before streaming the data. This patch drops the automatic prompt out of case 2, and instead requires the caller to do it. This is a few extra lines of code, and the bug it fixes is unlikely to come up in practice. But it is conceptually cleaner, and paves the way for better handling of credentials across redirects. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>

Jeff King committed Sep 28, 2013 at 04:31 UTC 2501aff8b7516115c409cb34cc50305cdde40a47
3 files changed +11 -3
http.c
+4 -2
@@ -45,7 +45,7 @@ static long curl_low_speed_time = -1;
45 static int curl_ftp_no_epsv;
46 static const char *curl_http_proxy;
47 static const char *curl_cookie_file;
48 -static struct credential http_auth = CREDENTIAL_INIT;
48 +struct credential http_auth = CREDENTIAL_INIT;
49 static int http_proactive_auth;
50 static const char *user_agent;
51
@@ -806,7 +806,6 @@ int handle_curl_result(struct slot_results *results)
806 credential_reject(&http_auth);
807 return HTTP_NOAUTH;
808 } else {
809 - credential_fill(&http_auth);
809 return HTTP_REAUTH;
810 }
811 } else {
@@ -924,6 +923,9 @@ static int http_request_reauth(const char *url,
923 die("BUG: HTTP_KEEP_ERROR is only supported with strbufs");
924 }
925 }
926 +
927 + credential_fill(&http_auth);
928 +
929 return http_request(url, result, target, options);
930 }
931
http.h
+1
@@ -102,6 +102,7 @@ extern void http_cleanup(void);
102 extern int active_requests;
103 extern int http_is_verbose;
104 extern size_t http_post_buffer;
105 +extern struct credential http_auth;
106
107 extern char curl_errorstr[CURL_ERROR_SIZE];
108
remote-curl.c
+6 -1
@@ -8,6 +8,7 @@
8 #include "pkt-line.h"
9 #include "sideband.h"
10 #include "argv-array.h"
11 +#include "credential.h"
12
13 static struct remote *remote;
14 static const char *url; /* always ends with a trailing slash */
@@ -449,6 +450,8 @@ static int post_rpc(struct rpc_state *rpc)
450 if (large_request) {
451 do {
452 err = probe_rpc(rpc);
453 + if (err == HTTP_REAUTH)
454 + credential_fill(&http_auth);
455 } while (err == HTTP_REAUTH);
456 if (err != HTTP_OK)
457 return -1;
@@ -548,8 +551,10 @@ retry:
551 curl_easy_setopt(slot->curl, CURLOPT_FILE, rpc);
552
553 err = run_slot(slot);
551 - if (err == HTTP_REAUTH && !large_request)
554 + if (err == HTTP_REAUTH && !large_request) {
555 + credential_fill(&http_auth);
556 goto retry;
557 + }
558 if (err != HTTP_OK)
559 err = -1;
560