From: Glen Choo <chooglen@google.com>
To: Jeff King <peff@peff.net>,
Glen Choo via GitGitGadget <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org, Taylor Blau <me@ttaylorr.com>,
Emily Shaffer <nasamuffin@google.com>
Subject: Re: [PATCH v2] http: redact curl h2h3 headers in info
Date: Fri, 11 Nov 2022 09:55:34 -0800 [thread overview]
Message-ID: <kl6ly1sh1ill.fsf@chooglen-macbookpro.roam.corp.google.com> (raw)
In-Reply-To: <Y221kGaQUfZJznO9@coredump.intra.peff.net>
Jeff King <peff@peff.net> writes:
> On Thu, Nov 10, 2022 at 10:57:34PM +0000, Glen Choo via GitGitGadget wrote:
>
>> +/* Redact headers in info */
>> +static void redact_sensitive_info_header(struct strbuf *header)
>> +{
>> + const char *sensitive_header;
>> +
>> + /*
>> + * curl's h2h3 prints headers in info, e.g.:
>> + * h2h3 [<header-name>: <header-val>]
>> + */
>> + if (trace_curl_redact &&
>> + skip_iprefix(header->buf, "h2h3 [", &sensitive_header)) {
>> + struct strbuf inner = STRBUF_INIT;
>> +
>> + /* Drop the trailing "]" */
>> + strbuf_add(&inner, sensitive_header, strlen(sensitive_header) - 1);
>
> This will misbehave if fed the string "h2h3 [", because that strlen()
> becomes 0, and the subtraction underflows.
>
> Unlikely, since we are being fed by curl, but possibly worth asserting
> (though see below for an alternative which drops this line).
>
>> + if (redact_sensitive_header(&inner)) {
>> + strbuf_setlen(header, strlen("h2h3 ["));
>
> This strlen may be better spelled as:
>
> sensitive_header - header->buf
>
> which IMHO makes it more clear that our intent is to truncate based on
> the pointer we computed by skipping (and has no chance of getting out of
> sync with the earlier copy of the string).
>
> It's also a little more robust, in that it doesn't depend on "h2h3"
> being at the beginning of the string (though in practice it must be,
> because that's where skip_iprefix() is checking). See below on that.
>
>> + strbuf_addbuf(header, &inner);
>> + strbuf_addch(header, ']');
>> + }
>> +
>> + strbuf_release(&inner);
>
> This will do a new allocation/free for each info line, even if it's not
> redacted. It's probably premature optimization to worry about it, but
> you could do it all in the original strbuf, if we inform
> redact_sensitive_header() of the offset at which it should look for the
> header (and because it uses "sensitive_header - header->buf" for the
> truncation, it handles the extra "h2h3" at the beginning just fine).
> Something like:
>
> diff --git a/http.c b/http.c
> index 8135fac283..8a5ba3f477 100644
> --- a/http.c
> +++ b/http.c
> @@ -561,14 +561,14 @@ static void set_curl_keepalive(CURL *c)
> #endif
>
> /* Return 1 if redactions have been made, 0 otherwise. */
> -static int redact_sensitive_header(struct strbuf *header)
> +static int redact_sensitive_header(struct strbuf *header, size_t offset)
> {
> int ret = 0;
> const char *sensitive_header;
>
> if (trace_curl_redact &&
> - (skip_iprefix(header->buf, "Authorization:", &sensitive_header) ||
> - skip_iprefix(header->buf, "Proxy-Authorization:", &sensitive_header))) {
> + (skip_iprefix(header->buf + offset, "Authorization:", &sensitive_header) ||
> + skip_iprefix(header->buf + offset, "Proxy-Authorization:", &sensitive_header))) {
> /* The first token is the type, which is OK to log */
> while (isspace(*sensitive_header))
> sensitive_header++;
> @@ -579,7 +579,7 @@ static int redact_sensitive_header(struct strbuf *header)
> strbuf_addstr(header, " <redacted>");
> ret = 1;
> } else if (trace_curl_redact &&
> - skip_iprefix(header->buf, "Cookie:", &sensitive_header)) {
> + skip_iprefix(header->buf + offset, "Cookie:", &sensitive_header)) {
> struct strbuf redacted_header = STRBUF_INIT;
> const char *cookie;
>
> @@ -631,17 +631,10 @@ static void redact_sensitive_info_header(struct strbuf *header)
> */
> if (trace_curl_redact &&
> skip_iprefix(header->buf, "h2h3 [", &sensitive_header)) {
> - struct strbuf inner = STRBUF_INIT;
> -
> - /* Drop the trailing "]" */
> - strbuf_add(&inner, sensitive_header, strlen(sensitive_header) - 1);
> - if (redact_sensitive_header(&inner)) {
> - strbuf_setlen(header, strlen("h2h3 ["));
> - strbuf_addbuf(header, &inner);
> + if (redact_sensitive_header(header, sensitive_header - header->buf)) {
> + /* redaction ate our closing bracket */
> strbuf_addch(header, ']');
> }
> -
> - strbuf_release(&inner);
> }
> }
>
> @@ -659,7 +652,7 @@ static void curl_dump_header(const char *text, unsigned char *ptr, size_t size,
>
> for (header = headers; *header; header++) {
> if (hide_sensitive_header)
> - redact_sensitive_header(*header);
> + redact_sensitive_header(*header, 0);
> strbuf_insertstr((*header), 0, text);
> strbuf_insertstr((*header), strlen(text), ": ");
> strbuf_rtrim((*header));
As someone who's still trying to wrap my head around pointer
manipulations, these suggestions are very welcome, thanks!
I'll take these suggestions along with the HTTP2 one.
next prev parent reply other threads:[~2022-11-11 17:55 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-11-09 0:52 [PATCH] http: redact curl h2h3 headers in info Glen Choo via GitGitGadget
2022-11-10 2:52 ` Taylor Blau
2022-11-10 17:48 ` Glen Choo
2022-11-10 21:50 ` Jeff King
2022-11-10 22:53 ` Glen Choo
2022-11-11 2:29 ` Jeff King
2022-11-11 2:31 ` Taylor Blau
2022-11-11 14:49 ` [PATCH] t: run t5551 tests with both HTTP and HTTP/2 Jeff King
2022-11-11 15:06 ` Ævar Arnfjörð Bjarmason
2022-11-11 15:19 ` Jeff King
2022-11-11 15:20 ` Jeff King
2022-11-10 21:57 ` [PATCH] http: redact curl h2h3 headers in info Emily Shaffer
2022-11-10 22:14 ` Glen Choo
2022-11-11 2:35 ` Taylor Blau
2022-11-10 22:57 ` [PATCH v2] " Glen Choo via GitGitGadget
2022-11-11 2:36 ` Taylor Blau
2022-11-11 2:38 ` Jeff King
2022-11-11 2:39 ` Taylor Blau
2022-11-11 17:55 ` Glen Choo [this message]
2022-11-11 22:35 ` [PATCH v3 0/2] " Glen Choo via GitGitGadget
2022-11-11 22:35 ` [PATCH v3 1/2] t: run t5551 tests with both HTTP and HTTP/2 Jeff King via GitGitGadget
2022-11-11 22:35 ` [PATCH v3 2/2] http: redact curl h2h3 headers in info Glen Choo via GitGitGadget
2022-11-14 22:33 ` [PATCH v3 0/2] " Jeff King
2022-11-14 22:43 ` Taylor Blau
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=kl6ly1sh1ill.fsf@chooglen-macbookpro.roam.corp.google.com \
--to=chooglen@google.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=me@ttaylorr.com \
--cc=nasamuffin@google.com \
--cc=peff@peff.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).