Skip to content

Commit

Permalink
gitcredentials(7): make shell-snippet example more realistic
Browse files Browse the repository at this point in the history
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>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
peff authored and gitster committed May 1, 2020
1 parent dbe80f9 commit 177681a
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions Documentation/gitcredentials.txt
Expand Up @@ -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.
Expand Down

0 comments on commit 177681a

Please sign in to comment.