Make git-send-email git-credential
cover Make git-send-email git-credential
From: Michal Nazarewicz <[email protected]>
As discussed on the list, adding git-credential interface to Git.pm (sort of copied from git-remote-mediawiki) and making git-send-email use it.
I see git-remote-mediawiki does not have “use Git” so I did not touch it. On top of that I'd have no way to tests the changes anyway.
Michal Nazarewicz (4):
Git.pm: Allow command_close_bidi_pipe() to be called as method Git.pm: Allow pipes to be closed prior to calling
command_close_bidi_pipe
Git.pm: Add interface for git credential command.
git-send-email: Use git credential to obtain password.
Documentation/git-send-email.txt | 4 +- git-send-email.perl | 59 +++++++++++--------- perl/Git.pm | 116 ++++++++++++++++++++++++++++++++++++++- 3 files changed, 149 insertions(+), 30 deletions(-)
Signature · 1 line
1.8.1.2.549.g4fa355e
PATCH 1/4 Git.pm: Allow command_close_bidi_pipe() to be called as method
From: Michal Nazarewicz <[email protected]>
The documentation of command_close_bidi_pipe() claims that it can be called as a method, but it does not check whether the first argument is $self or not assuming the latter. Using _maybe_self() fixes this.
--- perl/Git.pm | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
perl/Git.pm +1 -1
@@ -430,7 +430,7 @@ have more complicated structure. sub command_close_bidi_pipe { local $?; - my ($pid, $in, $out, $ctx) = @_; + my ($self, $pid, $in, $out, $ctx) = _maybe_self(@_); foreach my $fh ($in, $out) { unless (close $fh) { if ($!) {
Signature · 1 line
1.8.1.2.549.g4fa355e
PATCH 2/4 Git.pm: Allow pipes to be closed prior to calling command_close_bidi_pipe
In reply to Michal NazarewiczFrom: Michal Nazarewicz <[email protected]>
The command_close_bidi_pipe() function will insist on closing both input and output pipes returned by command_bidi_pipe(). With this change it is possible to close one of the pipes in advance and pass undef as an argument.
This allows for something like:
my ($pid, $in, $out, $ctx) = command_bidi_pipe(...); print $out "write data"; close $out; # ... do stuff with $in command_close_bidi_pipe($pid, $in, undef, $ctx);
--- perl/Git.pm | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
perl/Git.pm +1 -1
@@ -432,7 +432,7 @@ sub command_close_bidi_pipe { local $?; my ($self, $pid, $in, $out, $ctx) = _maybe_self(@_); foreach my $fh ($in, $out) { - unless (close $fh) { + if (defined $fh && !close $fh) { if ($!) { carp "error closing pipe: $!"; } elsif ($? >> 8) {
Signature · 1 line
1.8.1.2.549.g4fa355e
Re: [PATCH 2/4] Git.pm: Allow pipes to be closed prior to calling command_close_bidi_pipe
Quoted 7 lines · Michal Nazarewicz
From: Michal Nazarewicz <[email protected]>
The
command_close_bidi_pipe()function will insist on closing both input and output pipes returned bycommand_bidi_pipe(). With this change it is possible to close one of the pipes in advance and pass undef as an argument.
Quoted 7 lines
This allows for something like:
my ($pid, $in, $out, $ctx) = command_bidi_pipe(...); print $out "write data"; close $out; # ... do stuff with $in command_close_bidi_pipe($pid, $in, undef, $ctx);
Should this part go into the documentation for command_close_bidi_pipe in Git.pm?
-Peff
Re: [PATCH 2/4] Git.pm: Allow pipes to be closed prior to calling command_close_bidi_pipe
Quoted 11 lines · Jeff King
Quoted 9 lines · Michal Nazarewicz
From: Michal Nazarewicz <[email protected]>
The
command_close_bidi_pipe()function will insist on closing both input and output pipes returned bycommand_bidi_pipe(). With this change it is possible to close one of the pipes in advance and pass undef as an argument.This allows for something like:
Quoted 8 lines
Quoted 5 lines
my ($pid, $in, $out, $ctx) = command_bidi_pipe(...); print $out "write data"; close $out; # ... do stuff with $in command_close_bidi_pipe($pid, $in, undef, $ctx);Should this part go into the documentation for
command_close_bidi_pipein Git.pm?
Yeah, it probably should.
PATCH 3/4 Git.pm: Add interface for git credential command.
In reply to Michal NazarewiczFrom: Michal Nazarewicz <[email protected]>
Add a credential() function which is an interface to the git credential command.
--- perl/Git.pm | 112 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 111 insertions(+), 1 deletion(-)
perl/Git.pm +111 -1
@@ -59,7 +59,8 @@ require Exporter; command_bidi_pipe command_close_bidi_pipe version exec_path html_path hash_object git_cmd_try remote_refs prompt - temp_acquire temp_release temp_reset temp_path); + temp_acquire temp_release temp_reset temp_path + credential); =head1 DESCRIPTION
@@ -1000,6 +1001,115 @@ sub _close_cat_blob { } +sub _credential_read { + my %credential; + my ($reader, $op) = (@_); + while (<$reader>) { + chomp; + my ($key, $value) = /([^=]*)=(.*)/; + if (not defined $key) { + throw Error::Simple("unable to parse git credential $op response:\n$_\n"); + } + $credential{$key} = $value; + } + return %credential; +} + +sub _credential_write { + my ($credential, $writer) = @_; + + for my $key (sort { + # url overwrites other fields, so it must come first + return -1 if $a eq 'url'; + return 1 if $b eq 'url'; + return $a cmp $b; + } keys %$credential) { + if (defined $credential->{$key} && length $credential->{$key}) { + print $writer $key, '=', $credential->{$key}, "\n"; + } + } + print $writer "\n"; +} + +sub _credential_run { + my ($self, $credential, $op) = _maybe_self(@_); + + my ($pid, $reader, $writer, $ctx) = command_bidi_pipe('credential', $op); + + _credential_write $credential, $writer; + close $writer; + + if ($op eq "fill") { + %$credential = _credential_read $reader, $op; + } elsif (<$reader>) { + throw Error::Simple("unexpected output from git credential $op response:\n$_\n"); + } + + command_close_bidi_pipe($pid, $reader, undef, $ctx); +} + +=item credential( CREDENTIAL_HASH [, OPERATION ] ) + +=item credential( CREDENTIAL_HASH, CODE ) + +Executes C<git credential> for a given set of credentials and +specified operation. In both form C<CREDENTIAL_HASH> needs to be +a reference to a hash which stores credentials. Under certain +conditions the hash can change. + +In the first form, C<OPERATION> can be C<'fill'> (or omitted), +C<'approve'> or C<'reject'>, and function will execute corresponding +C<git credential> sub-command. In case of C<'fill'> the values stored +in C<CREDENTIAL_HASH> will be changed to the ones returned by the +C<git credential> command. The usual usage would look something like: + + my %cred = ( + 'protocol' => 'https', + 'host' => 'example.com', + 'username' => 'bob' + ); + Git::credential \%cred; + if (try_to_authenticate($cred{'username'}, $cred{'password'})) { + Git::credential \%cred, 'approve'; + ... do more stuff ... + } else { + Git::credential \%cred, 'reject'; + } + +In the second form, C<CODE> needs to be a reference to a subroutine. +The function will execute C<git credential fill> to fill provided +credential hash, than call C<CODE> with C<CREDENTIAL> as the sole +argument, and finally depending on C<CODE>'s return value execute +C<git credential approve> (if return value yields true) or C<git +credential reject> (otherwise). The return value is the same as what +C<CODE> returned. With this form, the usage might look as follows: + + if (Git::credential { + 'protocol' => 'https', + 'host' => 'example.com', + 'username' => 'bob' + }, sub { + my $cred = shift; + return try_to_authenticate($cred->{'username'}, $cred->{'password'}); + }) { + ... do more stuff ... + } + +=cut + +sub credential { + my ($self, $credential, $op_or_code) = (_maybe_self(@_), 'fill'); + + if ('CODE' eq ref $op_or_code) { + _credential_run $credential, 'fill'; + my $ret = $op_or_code->($credential); + _credential_run $credential, $ret ? 'approve' : 'reject'; + return $ret; + } else { + _credential_run $credential, $op_or_code; + } +} + { # %TEMP_* Lexical Context my (%TEMP_FILEMAP, %TEMP_FILES);
Signature · 1 line
1.8.1.2.549.g4fa355e
Re: [PATCH 3/4] Git.pm: Add interface for git credential command.
perl/Git.pm sub _close_cat_blob { · line 1009
Quoted 6 lines · Michal Nazarewicz
perl/Git.pm +6
-0+sub _credential_read { + my %credential; + my ($reader, $op) = (@_); + while (<$reader>) { + chomp; + my ($key, $value) = /([^=]*)=(.*)/;
Empty keys are not valid. Can we make this:
/^([^=]+)=(.*)/
to fail the regex? Otherwise, I think this check:
perl/Git.pm sub _close_cat_blob { · line 1012
Quoted 3 lines
perl/Git.pm +3
-0+ if (not defined $key) { + throw Error::Simple("unable to parse git credential $op response:\n$_\n"); + }
would not pass because $key would be the empty string.
perl/Git.pm sub _close_cat_blob { · line 1030
Quoted 13 lines
perl/Git.pm +13
-0+sub _credential_write { + my ($credential, $writer) = @_; + + for my $key (sort { + # url overwrites other fields, so it must come first + return -1 if $a eq 'url'; + return 1 if $b eq 'url'; + return $a cmp $b; + } keys %$credential) { + if (defined $credential->{$key} && length $credential->{$key}) { + print $writer $key, '=', $credential->{$key}, "\n"; + } + }
There are a few disallowed characters, like "\n" in key or value, and "=" in a key. They should never happen unless the caller is buggy, but should we check and catch them here?
perl/Git.pm sub _close_cat_blob { · line 1085
Quoted 7 lines
perl/Git.pm +7
-0+In the second form, C<CODE> needs to be a reference to a subroutine. +The function will execute C<git credential fill> to fill provided +credential hash, than call C<CODE> with C<CREDENTIAL> as the sole +argument, and finally depending on C<CODE>'s return value execute +C<git credential approve> (if return value yields true) or C<git +credential reject> (otherwise). The return value is the same as what +C<CODE> returned. With this form, the usage might look as follows:
This is a nice touch. It makes the normal calling code a lot simpler.
-Peff
PATCH 4/4 git-send-email: Use git credential to obtain password.
In reply to Michal NazarewiczFrom: Michal Nazarewicz <[email protected]>
If smtp_user is provided but smtp_pass is not, instead of prompting for password, make git-send-email use git credential command instead.
--- Documentation/git-send-email.txt | 4 +-- git-send-email.perl | 59 +++++++++++++++++++++++----------------- 2 files changed, 36 insertions(+), 27 deletions(-)
Documentation/git-send-email.txt +2 -2
@@ -164,8 +164,8 @@ Sending Furthermore, passwords need not be specified in configuration files or on the command line. If a username has been specified (with '--smtp-user' or a 'sendemail.smtpuser'), but no password has been -specified (with '--smtp-pass' or 'sendemail.smtppass'), then the -user is prompted for a password while the input is masked for privacy. +specified (with '--smtp-pass' or 'sendemail.smtppass'), then +a password is obtained using 'git-credential'. --smtp-server=<host>:: If set, specifies the outgoing SMTP server to use (e.g.
git-send-email.perl +34 -25
71 lines not on this page · raw message
Signature · 1 line
1.8.1.2.549.g4fa355e
Re: [PATCH 4/4] git-send-email: Use git credential to obtain password.
Quoted 11 lines · Michal Nazarewicz
From: Michal Nazarewicz <[email protected]>
If
smtp_useris provided butsmtp_passis not, instead of prompting for password, make git-send-email use git credential command instead.Signed-off-by Michal Nazarewicz <[email protected]>--- Documentation/git-send-email.txt | 4 +-- git-send-email.perl | 59 +++++++++++++++++++++++----------------- 2 files changed, 36 insertions(+), 27 deletions(-)
Nice. I don't see anything obviously wrong with the code, but I didn't try it myself. I wonder how hard it would be to have some tests in t9001. It looks like we don't test the smtp code paths at all, since we would have to implement a fake smtp server. Which probably means the answer is is "pretty hard", unless there is an easy-to-use CPAN smtp server module we can plug in.
-Peff
Re: [PATCH 3/4] Git.pm: Add interface for git credential command.
In reply to Michal NazarewiczQuoted 1 line · Michal Nazarewicz
Subject: [PATCH 3/4] Git.pm: Add interface for git credential command.
Ah, just a nitpick: usually we write the message without capital after ":" and without the final ".".
Signature · 2 lines
Matthieu Moy http://www-verimag.imag.fr/~moy/
Re: [PATCH 3/4] Git.pm: Add interface for git credential command.
In reply to Michal NazarewiczQuoted 4 lines · Michal Nazarewicz
From: Michal Nazarewicz <[email protected]>
Add a
credential()function which is an interface to the git credential command.
Nice.
I think you should credit git-remote-mediawiki for the code in the commit message. Perhaps have a first "copy/paste" commit, and then an "adaptation" commit to add sort, ^ anchor in regexp, doc and your callback mechanism, but I won't insist on that.
Other than that, it all looks good, thanks. I'll take care of deleting the old code in git-remote-mediawiki and use Git.pm instead.
Signature · 2 lines
Matthieu Moy http://www-verimag.imag.fr/~moy/