git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Jeff King <peff@peff.net>
To: Junio C Hamano <gitster@pobox.com>
Cc: douglas.fuller@gmail.com, git@vger.kernel.org
Subject: [PATCH v2 2/2] gitcredentials(7): make shell-snippet example more realistic
Date: Fri, 1 May 2020 03:33:11 -0400	[thread overview]
Message-ID: <20200501073311.GB27675@coredump.intra.peff.net> (raw)
In-Reply-To: <20200501073222.GB27392@coredump.intra.peff.net>

There's an example of using your own bit of shell to act as a credential
helper, but it's not very realistic:

 - It's stupid to hand out your secret password to _every_ host. In the
   real world you'd use the config-matcher to limit it to a particular
   host.

 - We never provided a username. We can easily do that in another config
   option (you can do it in the helper, too, but this is much more
   readable).

 - We were sending the secret even for store/erase operations. This
   is OK because Git would just ignore it, but a real system would
   probably be unlocking a password store, which you wouldn't want to do
   more than necessary.

Signed-off-by: Jeff King <peff@peff.net>
---
 Documentation/gitcredentials.txt | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/Documentation/gitcredentials.txt b/Documentation/gitcredentials.txt
index 8127dfcd2f..0d0f7149bd 100644
--- a/Documentation/gitcredentials.txt
+++ b/Documentation/gitcredentials.txt
@@ -233,8 +233,9 @@ Here are some example specifications:
 	helper = "/path/to/my/helper --with-arguments"
 
 # or you can specify your own shell snippet
-[credential]
-	helper = "!f() { echo \"password=$(cat $HOME/.secret)\"; }; f"
+[credential "https://example.com"]
+	username = your_user
+	helper = "!f() { test \"$1\" = get && echo \"password=$(cat $HOME/.secret)\"; }; f"
 ----------------------------------------------------
 
 Generally speaking, rule (3) above is the simplest for users to specify.
-- 
2.26.2.933.gdf62622942

  parent reply	other threads:[~2020-05-01  7:33 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-04-30 14:36 [PATCH] doc: fix quoting bug in credential cache example douglas.fuller
2020-04-30 18:09 ` Junio C Hamano
2020-05-01  5:57   ` Jeff King
2020-05-01  6:19     ` Jeff King
2020-05-01  6:20       ` [PATCH 1/2] gitcredentials(7): clarify quoting of helper examples Jeff King
2020-05-01  7:19         ` Andreas Schwab
2020-05-01  7:31           ` Jeff King
2020-05-01  6:23       ` [PATCH 2/2] gitcredentials(7): make shell-snippet example more realistic Jeff King
2020-05-01  6:26         ` Junio C Hamano
2020-05-01  6:32           ` Jeff King
2020-05-01  6:35             ` Jeff King
2020-05-01  7:32               ` Jeff King
2020-05-01  7:33                 ` [PATCH v2 1/2] gitcredentials(7): clarify quoting of helper examples Jeff King
2020-05-01  7:33                 ` Jeff King [this message]
2020-05-01 15:11               ` [PATCH 2/2] gitcredentials(7): make shell-snippet example more realistic Junio C Hamano
2020-05-01 14:40       ` [PATCH] doc: fix quoting bug in credential cache example douglas.fuller
2020-05-01  6:20     ` Junio C Hamano
2020-05-01  6:25       ` Jeff King

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=20200501073311.GB27675@coredump.intra.peff.net \
    --to=peff@peff.net \
    --cc=douglas.fuller@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    /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).