Implement the GIT_TRACE_CURL environment variable to allow a greater degree of detail of GIT_CURL_VERBOSE, in particular the complete transport header and all the data payload exchanged. It might be useful if a particular situation could require a more thorough debugging analysis. Document the new GIT_TRACE_CURL environment variable.
Helped-by: Torsten Bögershausen <[email protected]> Helped-by: Ramsay Jones <[email protected]> Helped-by: Junio C Hamano <[email protected]> Helped-by: Eric Sunshine <[email protected]> Helped-by: Jeff King <[email protected]> Signed-off-by: Elia Pinto <[email protected]> --- Documentation/git.txt | 8 ++++ http.c | 124 +++++++++++++++++++++++++++++++++++++++++++++++++- http.h | 2 + 3 files changed, 132 insertions(+), 2 deletions(-) diff --git a/Documentation/git.txt b/Documentation/git.txt index dd6dbf7..a46a356 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -1077,6 +1077,14 @@ of clones and fetches. cloning of shallow repositories. See 'GIT_TRACE' for available trace output options. +'GIT_TRACE_CURL':: + Enables a curl full trace dump of all incoming and outgoing data, + including descriptive information, of the git transport protocol. + This is similar to doing curl --trace-ascii on the command line. + This option overrides setting the GIT_CURL_VERBOSE environment + variable. + See 'GIT_TRACE' for available trace output options. + 'GIT_LITERAL_PATHSPECS':: Setting this variable to `1` will cause Git to treat all pathspecs literally, rather than as glob patterns. For example, diff --git a/http.c b/http.c index df6dd01..ba32bac 100644 --- a/http.c +++ b/http.c @@ -11,6 +11,7 @@ #include "gettext.h" #include "transport.h" +static struct trace_key trace_curl = TRACE_KEY_INIT(CURL); #if LIBCURL_VERSION_NUM >= 0x070a08 long int git_curl_ipresolve = CURL_IPRESOLVE_WHATEVER; #else @@ -477,6 +478,125 @@ static void set_curl_keepalive(CURL *c) } #endif +static void curl_dump_header(const char *text, unsigned char *ptr, size_t size, int nopriv_header) +{ + struct strbuf out = STRBUF_INIT; + const char *header; + struct strbuf **header_list, **ptr_list; + + strbuf_addf(&out, "%s, %10.10ld bytes (0x%8.8lx)\n", + text, (long)size, (long)size); + trace_strbuf(&trace_curl, &out); + strbuf_reset(&out); + strbuf_add(&out,ptr,size); + header_list = strbuf_split_max(&out, '\n', 0); + + for (ptr_list = header_list; *ptr_list; ptr_list++) { + /* + * if we are called with nopriv_header substitute a dummy value + * in the Authorization or Proxy-Authorization http header if + * present. + */ + if (nopriv_header && + (skip_prefix((*ptr_list)->buf , "Authorization:", &header) + || skip_prefix((*ptr_list)->buf , "Proxy-Authorization:", &header))) { + /* The first token is the type, which is OK to log */ + while (isspace(*header)) + header++; + while (*header && !isspace(*header)) + header++; + /* Everything else is opaque and possibly sensitive */ + strbuf_setlen((*ptr_list), header - (*ptr_list)->buf ); + strbuf_addstr((*ptr_list), " <redacted>"); + } + strbuf_insert((*ptr_list), 0, text, strlen(text)); + strbuf_insert((*ptr_list), strlen(text), ": ", 2); + strbuf_rtrim((*ptr_list)); + strbuf_addch((*ptr_list), '\n'); + trace_strbuf(&trace_curl, (*ptr_list)); + } + strbuf_list_free(header_list); + strbuf_release(&out); +} +static void curl_dump_data(const char *text, unsigned char *ptr, size_t size) +{ + size_t i; + struct strbuf out = STRBUF_INIT; + unsigned int width = 80; + + strbuf_addf(&out, "%s, %10.10ld bytes (0x%8.8lx)\n", + text, (long)size, (long)size); + trace_strbuf(&trace_curl, &out); + + for (i = 0; i < size; i += width) { + size_t w; + + strbuf_reset(&out); + strbuf_addf(&out, "%s: ", text); + for (w = 0; (w < width) && (i + w < size); w++) { + strbuf_addch(&out, (ptr[i + w] >= 0x20) + && (ptr[i + w] < 0x80) ? ptr[i + w] : '.'); + } + strbuf_addch(&out, '\n'); + trace_strbuf(&trace_curl, &out); + } + strbuf_release(&out); +} + +static int curl_trace(CURL *handle, curl_infotype type, char *data, size_t size, void *userp) +{ + const char *text; + int nopriv_header = 0; /* + * default: there are no sensitive data + * in the trace to be skipped + */ + + switch (type) { + case CURLINFO_TEXT: + trace_printf_key(&trace_curl, "== Info: %s", data); + default: /* we ignore unknown types by default */ + return 0; + + case CURLINFO_HEADER_OUT: + text = "=> Send header"; + nopriv_header = 1; + curl_dump_header(text, (unsigned char *)data, size, nopriv_header); + break; + case CURLINFO_DATA_OUT: + text = "=> Send data"; + curl_dump_data(text, (unsigned char *)data, size); + break; + case CURLINFO_SSL_DATA_OUT: + text = "=> Send SSL data"; + curl_dump_data(text, (unsigned char *)data, size); + break; + case CURLINFO_HEADER_IN: + text = "<= Recv header"; + nopriv_header = 0; + curl_dump_header(text, (unsigned char *)data, size, nopriv_header); + break; + case CURLINFO_DATA_IN: + text = "<= Recv data"; + curl_dump_data(text, (unsigned char *)data, size); + break; + case CURLINFO_SSL_DATA_IN: + text = "<= Recv SSL data"; + curl_dump_data(text, (unsigned char *)data, size); + break; + } + return 0; +} + +void setup_curl_trace(CURL *handle) +{ + if (!trace_want(&trace_curl)) + return; + curl_easy_setopt(handle, CURLOPT_VERBOSE, 1L); + curl_easy_setopt(handle, CURLOPT_DEBUGFUNCTION, curl_trace); + curl_easy_setopt(handle, CURLOPT_DEBUGDATA, NULL); +} + + static CURL *get_curl_handle(void) { CURL *result = curl_easy_init(); @@ -575,9 +695,9 @@ static CURL *get_curl_handle(void) warning("protocol restrictions not applied to curl redirects because\n" "your curl version is too old (>= 7.19.4)"); #endif - if (getenv("GIT_CURL_VERBOSE")) - curl_easy_setopt(result, CURLOPT_VERBOSE, 1); + curl_easy_setopt(result, CURLOPT_VERBOSE, 1L); + setup_curl_trace(result); curl_easy_setopt(result, CURLOPT_USERAGENT, user_agent ? user_agent : git_user_agent()); diff --git a/http.h b/http.h index 36f558b..5ab9d9c 100644 --- a/http.h +++ b/http.h @@ -225,4 +225,6 @@ extern int finish_http_object_request(struct http_object_request *freq); extern void abort_http_object_request(struct http_object_request *freq); extern void release_http_object_request(struct http_object_request *freq); +/* setup routine for curl_easy_setopt CURLOPT_DEBUGFUNCTION */ +void setup_curl_trace(CURL *handle); #endif /* HTTP_H */ -- 2.8.2.435.g7c6234f.dirty -- To unsubscribe from this list: send the line "unsubscribe git" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html
