From patchwork Wed Apr 29 23:23:22 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Carlo_Marcelo_Arenas_Bel=C3=B3n?= X-Patchwork-Id: 11518943 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 72C3081 for ; Wed, 29 Apr 2020 23:23:42 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 536622082E for ; Wed, 29 Apr 2020 23:23:42 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="BPOJXvt7" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726852AbgD2XXl (ORCPT ); Wed, 29 Apr 2020 19:23:41 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:60710 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726164AbgD2XXk (ORCPT ); Wed, 29 Apr 2020 19:23:40 -0400 Received: from mail-pg1-x541.google.com (mail-pg1-x541.google.com [IPv6:2607:f8b0:4864:20::541]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id AF187C03C1AE for ; Wed, 29 Apr 2020 16:23:40 -0700 (PDT) Received: by mail-pg1-x541.google.com with SMTP id s8so1806613pgq.1 for ; Wed, 29 Apr 2020 16:23:40 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=3KwnQ7TxZWVIiVbFXcudkbkE+P/G59nvW51KAbo6gCg=; b=BPOJXvt7L5JaSKOWhWY2Knllc0m863Zof1g326zn9HKgeR/fXWLq1UQJEOZ7BVwtDp 5CD5NTO8nv45zwg2Uu7PBUsf1iaEmfSVStMEJPcEectxdv/xvTHWEA6by2ZYkT+6Tv43 wQDYXkGO6OLpwNQzMHOGsdQJy4xcy9uHH8AIjDTR/36bHKVlLsxhFgHH3EQMkjjqwUbh 6PDrA7DtdG009wqJ09xLwpdeTz/40EeYkhiUEOdE4NWxHeqKjsNKnnrtKN+bADKTchkL 3cOXw2BArrMGdeNWGlGcAO8futJnSGcJjF1zw5ecVocmHiDLIZLx+XsVLS/NtKRdlnI1 I9kw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=3KwnQ7TxZWVIiVbFXcudkbkE+P/G59nvW51KAbo6gCg=; b=E8ZL0bcNc0jsM07X0o0zYZT3ct1KCCEL3vfWc0H4OlfEC/VZoQFDvtPN2bQ+oZxGRn k+SIekdYL1jldKaDyFltxauLgCqNl3qgm/s+0jWqlZoo/ulfJ2NiTcys9CGTG7RY0tbu I329vl/CwTA5zwQdQz11Hj/mAWxEil6XMufK6MvJRXUiJNtWQkVaWXjBc+8H/j6YgwrG dFrXAg1zfN2PODIUu9M7ToOlkV9ZoD6me+cHud5iXu4eQ2+fgCfLLD8+Pk9bUFyJG0po cwkEaU9BwUZzmN3Dc3oJGXmY45QvsJj3yPh+XpgJFyRFHVp+2cGOYNuIQluv4VCyC+rv 84AA== X-Gm-Message-State: AGi0PubxrmrdogTW1z/NuqxFCTkBGT6nFtEbFE3INt4ByGuEaSU/Q9zg 7qia2F+fkDAbDF59IQhLOl18alYx X-Google-Smtp-Source: APiQypJF9W6uvkUlBeZY6ik78Xg1FKF7HQHg3lVl3tPlXNJ/lsIYA39KWLiMGyHBC4B4xiYTDQ6YPA== X-Received: by 2002:a63:1414:: with SMTP id u20mr594054pgl.47.1588202619510; Wed, 29 Apr 2020 16:23:39 -0700 (PDT) Received: from localhost.localdomain (c-67-188-192-166.hsd1.ca.comcast.net. [67.188.192.166]) by smtp.gmail.com with ESMTPSA id d14sm1927587pfr.35.2020.04.29.16.23.38 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Wed, 29 Apr 2020 16:23:38 -0700 (PDT) From: =?utf-8?q?Carlo_Marcelo_Arenas_Bel=C3=B3n?= To: git@vger.kernel.org Cc: dirk@ed4u.de, sunshine@sunshineco.com, peff@peff.net, gitster@pobox.com, jrnieder@gmail.com, =?utf-8?q?Carlo_Marcelo_Arenas_Bel=C3=B3n?= Subject: [PATCH v6] credential-store: warn instead of fatal for bogus lines from store Date: Wed, 29 Apr 2020 16:23:22 -0700 Message-Id: <20200429232322.68038-1-carenas@gmail.com> X-Mailer: git-send-email 2.26.2.569.g1d74ac4d14 In-Reply-To: <20200429203546.56753-1-carenas@gmail.com> References: <20200429203546.56753-1-carenas@gmail.com> MIME-Version: 1.0 Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org with the added checks for invalid URLs in credentials, any locally modified store files which might have empty lines or even comments were reported[1] failing to parse as valid credentials. instead of doing a hard check for credentials, do a soft one and warn the user so any invalid entries could be corrected. make sure that the credential to use is complete before calling credential_match by confirming it has all fields set as expected by the updated rules. [1] https://stackoverflow.com/a/61420852/5005936 Reported-by: Dirk Helped-by: Eric Sunshine Based-on-patch-by: Jonathan Nieder Signed-off-by: Carlo Marcelo Arenas Belón --- v6: * get rid of redacter and only use line number for context in warning * make validation more strict to also catch incomplete credentials * reorder check as suggested by Junio v5: * q_to_tab this round, with a single echo to make sure empty line is covered, as that seems to be a popular issue * rebase on top of jc/credential-store-file-format-doc * implement a redacter for credentials to use on errors to avoid leaking passwords v4: * use credential_from_url_gently instead as shown by Jonathan * add documentation to clarify "comments" is not a supported feature v3: * avoid using q_to_cr as suggested by Peff * a more verbose commit message and slightly more complete documentation v2: * use a here-doc for clarity as suggested by Eric * improve commit message and include documentation Documentation/git-credential-store.txt | 11 +++- credential-store.c | 26 +++++++-- t/t0302-credential-store.sh | 80 ++++++++++++++++++++++++++ 3 files changed, 111 insertions(+), 6 deletions(-) base-commit: 272281efcc18fcedd248597b8859f343cae1c5a0 diff --git a/Documentation/git-credential-store.txt b/Documentation/git-credential-store.txt index 76b0798856..122e238eb2 100644 --- a/Documentation/git-credential-store.txt +++ b/Documentation/git-credential-store.txt @@ -95,8 +95,15 @@ https://user:pass@example.com ------------------------------ No other kinds of lines (e.g. empty lines or comment lines) are -allowed in the file, even though some may be silently ignored. Do -not view or edit the file with editors. +allowed in the file, even though historically the parser was very +lenient and some might had been silently ignored. + +Do not view or edit the file with editors as it could compromise the +validity of your credentials by sometimes subtle formatting issues, +like spaces, line wrapping or text encoding. + +An unparseable or otherwise invalid line is ignored, and a warning +message points out the problematic line number and file it appears in. When Git needs authentication for a particular URL context, credential-store will consider that context a pattern to match against diff --git a/credential-store.c b/credential-store.c index c010497cb2..4d3c9e8000 100644 --- a/credential-store.c +++ b/credential-store.c @@ -6,6 +6,15 @@ static struct lock_file credential_lock; +/* + * entry->protocol comes validated from credential_from_url_gently + */ +static int valid_credential(struct credential *entry) +{ + return (entry->username && entry->password && + ((entry->host && *entry->host) || entry->path)); +} + static int parse_credential_file(const char *fn, struct credential *c, void (*match_cb)(struct credential *), @@ -15,6 +24,7 @@ static int parse_credential_file(const char *fn, struct strbuf line = STRBUF_INIT; struct credential entry = CREDENTIAL_INIT; int found_credential = 0; + int lineno = 0; fh = fopen(fn, "r"); if (!fh) { @@ -24,16 +34,24 @@ static int parse_credential_file(const char *fn, } while (strbuf_getline_lf(&line, fh) != EOF) { - credential_from_url(&entry, line.buf); - if (entry.username && entry.password && - credential_match(c, &entry)) { + lineno++; + + if (credential_from_url_gently(&entry, line.buf, 1) || + !valid_credential(&entry)) { + warning(_("%s:%d: ignoring invalid credential"), + fn, lineno); + } + else if (credential_match(c, &entry)) + { found_credential = 1; if (match_cb) { match_cb(&entry); break; } + continue; } - else if (other_cb) + + if (other_cb) other_cb(&line); } diff --git a/t/t0302-credential-store.sh b/t/t0302-credential-store.sh index d6b54e8c65..3150f304cb 100755 --- a/t/t0302-credential-store.sh +++ b/t/t0302-credential-store.sh @@ -120,4 +120,84 @@ test_expect_success 'erase: erase matching credentials from both xdg and home fi test_must_be_empty "$HOME/.config/git/credentials" ' +test_expect_success 'get: credentials without scheme are invalid' ' + echo "://user:pass@example.com" >"$HOME/.git-credentials" && + cat >expect-stdout <<-\STDOUT && + protocol=https + host=example.com + username=askpass-username + password=askpass-password + STDOUT + test_config credential.helper store && + git credential fill <<-\EOF >stdout 2>stderr && + protocol=https + host=example.com + EOF + test_cmp expect-stdout stdout && + grep "askpass: Username for '\''https://example.com'\'':" stderr && + grep "askpass: Password for '\''https://askpass-username@example.com'\'':" stderr && + test_i18ngrep "ignoring invalid credential" stderr +' + +test_expect_success 'get: credentials without valid host/path are invalid' ' + echo "https://user:pass@" >"$HOME/.git-credentials" && + cat >expect-stdout <<-\STDOUT && + protocol=https + host=example.com + username=askpass-username + password=askpass-password + STDOUT + test_config credential.helper store && + git credential fill <<-\EOF >stdout 2>stderr && + protocol=https + host=example.com + EOF + test_cmp expect-stdout stdout && + grep "askpass: Username for '\''https://example.com'\'':" stderr && + grep "askpass: Password for '\''https://askpass-username@example.com'\'':" stderr && + test_i18ngrep "ignoring invalid credential" stderr +' + +test_expect_success 'get: credentials without username/password are invalid' ' + echo "https://pass@example.com" >"$HOME/.git-credentials" && + cat >expect-stdout <<-\STDOUT && + protocol=https + host=example.com + username=askpass-username + password=askpass-password + STDOUT + test_config credential.helper store && + git credential fill <<-\EOF >stdout 2>stderr && + protocol=https + host=example.com + EOF + test_cmp expect-stdout stdout && + grep "askpass: Username for '\''https://example.com'\'':" stderr && + grep "askpass: Password for '\''https://askpass-username@example.com'\'':" stderr && + test_i18ngrep "ignoring invalid credential" stderr +' + +test_expect_success 'get: store file can contain empty/bogus lines' ' + echo "" > "$HOME/.git-credentials" && + q_to_tab <<-\CONFIG >>"$HOME/.git-credentials" && + #comment + Q + https://user:pass@example.com + CONFIG + cat >expect-stdout <<-\STDOUT && + protocol=https + host=example.com + username=user + password=pass + STDOUT + test_config credential.helper store && + git credential fill <<-\EOF >stdout 2>stderr && + protocol=https + host=example.com + EOF + test_cmp expect-stdout stdout && + test_i18ngrep "ignoring invalid credential" stderr && + test_line_count = 3 stderr +' + test_done