Move signature deletion into its own function
[pgp-tools.git] / caff / caff
index a9112482d510c29559316f34cc66816911d8bcd2..ea31d78bee9f68bda69c6fa2f883d5a8f53a0630 100755 (executable)
--- a/caff/caff
+++ b/caff/caff
@@ -55,15 +55,19 @@ sigs and sigs done by you.
 
 =over
 
-=item B<-m> B<-M>
+=item B<-m>, B<--mail>
 
-Send/do not send mail after signing. Default is to ask the user for each uid.
+Send mail after signing. Default is to ask the user for each uid.
 
-=item B<-R>
+=item B<-M>, B<--no-mail>
+
+Do not send mail after signing. Default is to ask the user for each uid.
+
+=item B<-R>, B<--no-download>
 
 Do not retrieve the key to be signed from a keyserver.
 
-=item B<-u> I<yourkeyid>
+=item B<-u> I<yourkeyid>, B<--local-user> I<yourkeyid>
 
 Select the key that is used for signing, in case you have more than one key.
 
@@ -150,6 +154,28 @@ Default: B<0>.
 
 If true, then skip the signing step. Default: B<0>.
 
+=item B<mail-template> [string]
+
+Email template which is used as the body text for the email sent out.
+instead of the default text if specified. The following perl variables
+can be used in the template:
+
+=over
+
+=item B<{owner}> [string]
+
+Your name as specified in the L<B<owner>|/item_owner__5bstring_5d> setting.
+
+=item B<{key}> [string]
+
+The keyid of the key you signed.
+
+=item B<{@uids}> [array]
+
+The UIDs for which signatures are included in the mail.
+
+=back
+
 =back
 
 =head1 AUTHOR
@@ -167,10 +193,11 @@ use IO::Handle;
 use English;
 use File::Path;
 use File::Temp qw{tempdir};
+use Text::Template;
 use MIME::Entity;
 use Fcntl;
 use IO::Select;
-use Getopt::Std;
+use Getopt::Long;
 use GnuPG::Interface;
 
 my %CONFIG;
@@ -202,6 +229,24 @@ sub load_config() {
        $CONFIG{'secret-keyring'} = $ENV{'HOME'}.'/.gnupg/secring.gpg' unless defined $CONFIG{'secret-keyring'};
        $CONFIG{'no-download'} = 0 unless defined $CONFIG{'no-download'};
        $CONFIG{'no-sign'} = 0 unless defined $CONFIG{'no-sign'};
+       $CONFIG{'mail-template'} = <<'EOM' unless defined $CONFIG{'mail-template'};
+Hi,
+
+please find attached the user id{(scalar @uids >= 2 ? 's' : '')}.
+{foreach $uid (@uids) {
+    $OUT .= "\t".$uid."\n";
+};} of your key {$key} signed by me.
+
+Note that I did not upload your key to any keyservers. If you want this
+new signature to be available to others, please upload it yourself.
+With GnuPG this can be done using
+       gpg --keyserver subkeys.pgp.net --send-key {$key}
+
+If you have any questions, don't hesitate to ask.
+
+Regards,
+{$owner}
+EOM
 };
 
 sub notice($) {
@@ -240,7 +285,7 @@ sub readwrite_gpg($$$$$%) {
 
        trace("Entering readwrite_gpg.");
 
-       my ($first_line, $dummy) = split /\n/, $in;
+       my ($first_line, undef) = split /\n/, $in;
        debug("readwrite_gpg sends ".(defined $first_line ? $first_line : "<nothing>"));
 
        local $INPUT_RECORD_SEPARATOR = undef;
@@ -375,12 +420,22 @@ my  ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime($NOW);
 my $DATE_STRING = sprintf("%04d-%02d-%02d", $year+1900, $mon+1, $mday);
 
 
-sub usage() {
-       print STDERR "caff $VERSION - (c) 2004, 2005 Peter Palfrader\n";
-       print STDERR "Usage: $PROGRAM_NAME [-mMR] [-u <yourkeyid>] <keyid> [<keyid> ...]\n";
-       exit 1;
+sub version($) {
+       my ($fd) = @_;
+       print $fd "caff $VERSION - (c) 2004, 2005 Peter Palfrader\n";
 };
 
+sub usage($$) {
+       my ($fd, $exitcode) = @_;
+       version($fd);
+       print $fd "Usage: $PROGRAM_NAME [-mMR] [-u <yourkeyid>] <keyid> [<keyid> ...]\n";
+       print $fd "Consult the manual page for more information.\n";
+       exit $exitcode;
+};
+
+######
+# export key $keyid from $gnupghome
+######
 sub export_key($$) {
        my ($gnupghome, $keyid) = @_;
 
@@ -398,28 +453,50 @@ sub export_key($$) {
        return $stdout;
 };
 
+######
+# import a key from the scalar $asciikey into a gpg homedirectory in $tempdir
+######
+sub import_key($$) {
+       ($gnupghome, $asciikey) = @_;
+
+       my $gpg = GnuPG::Interface->new();
+       $gpg->call( $CONFIG{'gpg'} );
+       $gpg->options->hash_init( 'homedir' => $gnupghome );
+       $gpg->options->meta_interactive( 0 );
+       my ($inputfd, $stdoutfd, $stderrfd, $statusfd, $handles) = make_gpg_fds();
+       my $pid = $gpg->import_keys(handles => $handles);
+       my ($stdout, $stderr, $status) = readwrite_gpg($asciikey, $inputfd, $stdoutfd, $stderrfd, $statusfd);
+       waitpid $pid, 0;
+
+       if ($status !~ /^\[GNUPG:\] IMPORT_OK/m) {
+               return undef;
+       };
+       return 1;
+};
+
+
+######
+# Send an email to $address.  If $can_encrypt is true then the mail
+# will be PGP/MIME encrypted to $longkeyid.
+#
+# $longkeyid, $uid, and @attached will be used in the email and the template.
+######
 #send_mail($address, $can_encrypt, $longkeyid, $uid, @attached);
 sub send_mail($$$@) {
        my ($address, $can_encrypt, $key_id, @keys) = @_;
 
-       my $message = "Hi,\n\n";
+       my $template = Text::Template->new(TYPE => 'STRING', SOURCE => $CONFIG{'mail-template'})
+           or die "Error creating template: $Text::Template::ERROR";
 
-       $message .= 'please find attached the user id'.(scalar @keys >= 2 ? 's' : '')."\n";
+       my @uids;
        for my $key (@keys) {
-               $message .= "\t".$key->{'text'}."\n";
+           push @uids, $key->{'text'};
        };
-       $message .= qq{of your key $key_id signed by me.
-
-Note that I did not upload your key to any keyservers. If you want this
-new signature to be available to others, please upload it yourself.
-With GnuPG this can be done using
-       gpg --keyserver subkeys.pgp.net --send-key $key_id
+       my $message = $template->fill_in(HASH => { key => $key_id,
+                                                  uids => \@uids,
+                                                  owner => $CONFIG{'owner'}})
+           or die "Error filling template in: $Text::Template::ERROR";
 
-If you have any questions, don't hesitate to ask.
-
-Regards,
-$CONFIG{'owner'}
-};
        my $message_entity = MIME::Entity->build(
                Type        => "text/plain",
                Charset     => "utf-8",
@@ -483,6 +560,9 @@ $CONFIG{'owner'}
        $message_entity->stringify();
 };
 
+######
+# clean up a UID so that it can be used on the FS.
+######
 sub sanitize_uid($) {
        my ($uid) = @_;
 
@@ -492,31 +572,97 @@ sub sanitize_uid($) {
        return $good_uid;
 };
 
+sub delete_signatures($$$$$) {
+       my ($inputfd, $stdoutfd, $stderrfd, $statusfd, $keyids) =@_;
+
+       my ($stdout, $stderr, $status) =
+               readwrite_gpg("delsig\n", $inputfd, $stdoutfd, $stderrfd, $statusfd, exitwhenstatusmatches => $KEYEDIT_DELSIG_PROMPT, nocloseinput => 1);
+
+       while($status =~ /$KEYEDIT_DELSIG_PROMPT/m) {
+               # sig:?::17:EA2199412477CAF8:1058095214:::::13x:
+               my @sigline = grep { /^sig/ } (split /\n/, $stdout);
+               $stdout =~ s/\n/\\n/g;
+               notice("[sigremoval] why are there ".(scalar @sigline)." siglines in that part of the dialog!? got: $stdout") if scalar @sigline >= 2; # XXX
+               my $line = pop @sigline;
+               my $answer = "no";
+               if (defined $line) { # only if we found a sig here - we never remove revocation packets for instance
+                       debug("[sigremoval] doing line $line.");
+                       my (undef, undef, undef, undef, $signer, $created, undef, undef, undef) = split /:/, $line;
+                       if ($signer eq $longkeyid) {
+                               debug("[sigremoval] selfsig ($signer).");
+                               $answer = "no";
+                       } elsif (grep { $signer eq $_ } @{$keyids}) {
+                               debug("[sigremoval] signed by us ($signer).");
+                               $answer = "no";
+                               $signed_by_me = $signed_by_me > $created ? $signed_by_me : $created;
+                       } else {
+                               debug("[sigremoval] not interested in that sig ($signer).");
+                               $answer = "yes";
+                       };
+               } else {
+                       debug("[sigremoval] no sig line here, only got: ".$stdout);
+               };
+               ($stdout, $stderr, $status) =
+                       readwrite_gpg($answer."\n", $inputfd, $stdoutfd, $stderrfd, $statusfd, exitwhenstatusmatches => $KEYEDIT_KEYEDIT_OR_DELSIG_PROMPT, nocloseinput => 1);
+       };
+};
+
+
+
 my $USER;
 my @KEYIDS;
-my %opt;
+my $params;
+
+Getopt::Long::config('bundling');
+if (!GetOptions (
+       '-h'              =>  \$params->{'help'},
+       '--help'          =>  \$params->{'help'},
+       '--version'       =>  \$params->{'version'},
+       '-V'              =>  \$params->{'version'},
+       '-u=s'            =>  \$params->{'local-user'},
+       '--local-user=s'  =>  \$params->{'local-user'},
+       '-m'              =>  \$params->{'mail'},
+       '--mail'          =>  \$params->{'mail'},
+       '-M'              =>  \$params->{'no-mail'},
+       '--no-mail'       =>  \$params->{'no-mail'},
+       '-R'              =>  \$params->{'no-download'},
+       '--no-download'   =>  \$params->{'no-download'},
+       )) {
+       usage(\*STDERR, 1);
+};
+if ($params->{'help'}) {
+       usage(\*STDOUT, 0);
+};
+if ($params->{'version'}) {
+       version(\*STDOUT);
+       exit(0);
+};
+usage(\*STDERR, 1) unless scalar @ARGV >= 1;
+
 
-getopts('mMRu:', \%opt);
 
-usage() unless scalar @ARGV >= 1;
-if ($opt{u}) {
-       $USER = $opt{u};
+if ($params->{'local-user'}) {
+       $USER = $params->{'local-user'};
        $USER =~ s/^0x//i;
        unless ($USER =~ /^[A-Za-z0-9]{8,8}([A-Za-z0-9]{8})?$/) {
                print STDERR "-u $USER is not a keyid.\n";
-               usage();
+               usage(\*STDERR, 1);
        };
        $USER = uc($USER);
 };
+
 for my $keyid (@ARGV) {
        $keyid =~ s/^0x//i;
-       unless ($keyid =~ /^[A-Za-z0-9]{8}([A-Za-z0-9]{8})?$/) {
+       unless ($keyid =~ /^[A-Za-z0-9]{8}([A-Za-z0-9]{8}|[A-Za-z0-9]{32})?$/) {
                print STDERR "$keyid is not a keyid.\n";
-               usage();
+               usage(\*STDERR, 1);
        };
        push @KEYIDS, uc($keyid);
 };
 
+$CONFIG{'no-download'} = $params->{'no-download'} if defined $params->{'no-download'};
+$CONFIG{'no-mail'}     = $params->{'no-mail'}     if defined $params->{'no-mail'};
+$CONFIG{'mail'}        = $params->{'mail'}        if defined $params->{'mail'};
 
 
 #################
@@ -549,7 +695,7 @@ for my $keyid (@ARGV) {
 #############################
 my @keyids_ok;
 my @keyids_failed;
-if ($CONFIG{'no-download'} or $opt{R}) {
+if ($CONFIG{'no-download'}) {
        @keyids_ok = @KEYIDS;
 } else {
        my $gpg = GnuPG::Interface->new();
@@ -573,19 +719,29 @@ if ($CONFIG{'no-download'} or $opt{R}) {
 # [GNUPG:] IMPORT_OK 0 25FC1614B8F87B52FF2F99B962AF4031C82E0039
                my $handled = 0;
                for my $line (split /\n/, $status) {
-                       if ($line =~ /^\[GNUPG:\] IMPORT_OK/) {
-                               push @keyids_ok, shift @KEYIDS;
+                       if ($line =~ /^\[GNUPG:\] IMPORT_OK \d+ ([0-9A-F]{40})/) {
+                               my $imported_key = $1;
+                               if ($keyid ne $imported_key &&
+                                   $keyid ne substr($imported_key, -16) &&
+                                   $keyid ne substr($imported_key, -8)) {
+                                   warn("Imported unexpected key.  expected: $keyid; got: $imported_key.\n");
+                                   next;
+                               };
+                               push @keyids_ok, $keyid;
+                               shift @KEYIDS;
                                $handled = 1;
                                last;
                        } elsif ($line =~ /^\[GNUPG:\] NODATA/) {
-                               push @keyids_failed, shift @KEYIDS;
+                               push @keyids_failed, $keyid;
+                               shift @KEYIDS;
                                $handled = 1;
                                last;
                        };
                };
                unless ($handled) {
                        notice ("Huh, what's up with $keyid?");
-                       push @keyids_failed, shift @KEYIDS;
+                       push @keyids_failed, $keyid;
+                       shift @KEYIDS;
                };
        };
        die ("Still keys in \@KEYIDS.  This should not happen.") if scalar @KEYIDS;
@@ -630,14 +786,25 @@ for my $keyid (@keyids_ok) {
                warn ("No data from gpg for list-key $keyid\n");
                next;
        };
-       my $keyinfo = $stdout;
        my @publine = grep { /^pub/ } (split /\n/, $stdout);
-       my ($dummy1, $dummy2, $dummy3, $dummy4, $longkeyid, $dummy6, $dummy7, $dummy8, $dummy9, $dummy10, $dummy11, $flags) = split /:/, pop @publine;
-       my $can_encrypt = $flags =~ /E/;
+       if (scalar @publine == 0) {
+               warn ("No public keys found with list-key $keyid (note that caff uses its own keyring in $GNUPGHOME).\n");
+               next;
+       };
+       my (undef, undef, undef, undef, $longkeyid, undef, undef, undef, undef, undef, undef, $flags) = split /:/, pop @publine;
+       if (scalar @publine > 0) {
+               warn ("More than one key matched $keyid.  Try to specify the long keyid or fingerprint\n");
+               next;
+       };
        unless (defined $longkeyid) {
-               warn ("Didn't find public keyid in edit dialog of key $keyid.\n");
+               warn ("Didn't find public keyid in --list-key of key $keyid.\n");
+               next;
+       };
+       unless (defined $flags) {
+               warn ("Didn't find flags in --list-key of key $keyid.\n");
                next;
        };
+       my $can_encrypt = $flags =~ /E/;
 
        # export the key
        ################
@@ -653,20 +820,12 @@ for my $keyid (@keyids_ok) {
                my $this_uid_text = '';
                $uid_number++;
                debug("Doing key $keyid, uid $uid_number");
+               my $tempdir = tempdir( "caff-$keyid-XXXXX", DIR => '/tmp/', CLEANUP => 1);
 
                # import into temporary gpghome
                ###############################
-               my $tempdir = tempdir( "caff-$keyid-XXXXX", DIR => '/tmp/', CLEANUP => 1);
-               my $gpg = GnuPG::Interface->new();
-               $gpg->call( $CONFIG{'gpg'} );
-               $gpg->options->hash_init( 'homedir' => $tempdir );
-               $gpg->options->meta_interactive( 0 );
-               my ($inputfd, $stdoutfd, $stderrfd, $statusfd, $handles) = make_gpg_fds();
-               my $pid = $gpg->import_keys(handles => $handles);
-               my ($stdout, $stderr, $status) = readwrite_gpg($asciikey, $inputfd, $stdoutfd, $stderrfd, $statusfd);
-               waitpid $pid, 0;
-
-               if ($status !~ /^\[GNUPG:\] IMPORT_OK/m) {
+               my $result = import_key($tempdir, $asciikey);
+               unless ($result) {
                        warn ("Could not import $keyid into temporary gnupg.\n");
                        next;
                };
@@ -697,7 +856,7 @@ for my $keyid (@keyids_ok) {
                debug("Parsing stdout output.");
                for my $line (split /\n/, $stdout) {
                        debug("Checking line $line");
-                       my ($type, $dummy2, $dummy3, $dummy4, $dummy5, $dummy6, $dummy7, $dummy8, $dummy9, $uidtext) = split /:/, $line;
+                       my ($type, undef, undef, undef, undef, undef, undef, undef, undef, $uidtext) = split /:/, $line;
                        if ($type eq 'sub') {
                                $number_of_subkeys++;
                        };
@@ -745,42 +904,16 @@ for my $keyid (@keyids_ok) {
                ###################
                my $signed_by_me = 0;
                readwrite_gpg("1\n", $inputfd, $stdoutfd, $stderrfd, $statusfd, exitwhenstatusmatches => $KEYEDIT_PROMPT, nocloseinput => 1);
-               ($stdout, $stderr, $status) =
-                       readwrite_gpg("delsig\n", $inputfd, $stdoutfd, $stderrfd, $statusfd, exitwhenstatusmatches => $KEYEDIT_DELSIG_PROMPT, nocloseinput => 1);
-
-               while($status =~ /$KEYEDIT_DELSIG_PROMPT/m) {
-                       # sig:?::17:EA2199412477CAF8:1058095214:::::13x:
-                       my @sigline = grep { /^sig/ } (split /\n/, $stdout);
-                       $stdout =~ s/\n/\\n/g;
-                       notice("[sigremoval] why are there ".(scalar @sigline)." siglines in that part of the dialog!? got: $stdout") if scalar @sigline >= 2; # XXX
-                       my $line = pop @sigline;
-                       my $answer = "no";
-                       if (defined $line) { # only if we found a sig here - we never remove revocation packets for instance
-                               debug("[sigremoval] doing line $line.");
-                               my ($dummy1, $dummy2, $dummy3, $dummy4, $signer, $created, $dummy7, $dummy8, $dummy9) = split /:/, $line;
-                               if ($signer eq $longkeyid) {
-                                       debug("[sigremoval] selfsig ($signer).");
-                                       $answer = "no";
-                               } elsif (grep { $signer eq $_ } @{$CONFIG{'keyid'}}) {
-                                       debug("[sigremoval] signed by us ($signer).");
-                                       $answer = "no";
-                                       $signed_by_me = $signed_by_me > $created ? $signed_by_me : $created;
-                               } else {
-                                       debug("[sigremoval] not interested in that sig ($signer).");
-                                       $answer = "yes";
-                               };
-                       } else {
-                               debug("[sigremoval] no sig line here, only got: ".$stdout);
-                       };
-                       ($stdout, $stderr, $status) =
-                               readwrite_gpg($answer."\n", $inputfd, $stdoutfd, $stderrfd, $statusfd, exitwhenstatusmatches => $KEYEDIT_KEYEDIT_OR_DELSIG_PROMPT, nocloseinput => 1);
-               };
+               delete_signatures($inputfd, $stdoutfd, $stderrfd, $statusfd, $CONFIG{'keyid'});
+
+
+
                readwrite_gpg("save\n", $inputfd, $stdoutfd, $stderrfd, $statusfd);
                waitpid $pid, 0;
 
-               my $asciikey = export_key($tempdir, $longkeyid);
+               my $asciikey = export_key($tempdir, $keyid);
                if ($asciikey eq '') {
-                       warn ("No data from gpg for export $longkeyid\n");
+                       warn ("No data from gpg for export $keyid\n");
                        next;
                };
 
@@ -793,7 +926,7 @@ for my $keyid (@keyids_ok) {
                        -d $keydir  || mkpath($keydir , 0, 0700) or die ("Cannot create $keydir $!\n");
 
                        my $keyfile = "$keydir/$longkeyid.key.$uid_number.".sanitize_uid($this_uid_text).".asc";
-                       open (KEY, ">$keyfile") or die ("Cannot open $keyfile\n");
+                       open (KEY, ">$keyfile") or die ("Cannot open $keyfile: $!\n");
                        print KEY $asciikey;
                        close KEY;
 
@@ -808,7 +941,7 @@ for my $keyid (@keyids_ok) {
        if (scalar @UIDS == 0) {
                info("found no signed uids for $keyid");
        } else {
-               next if $opt{M}; # do not send mail
+               next if $CONFIG{'no-mail'}; # do not send mail
 
                my @attached;
                for my $uid (@UIDS) {
@@ -824,12 +957,12 @@ for my $keyid (@keyids_ok) {
                        if ($uid->{'text'} =~ /@/) {
                                my $address = $uid->{'text'};
                                $address =~ s/.*<(.*)>.*/$1/;
-                               if ($opt{m} or ask("Send mail to '$address' for $uid->{'text'}?", 1)) {
+                               if ($CONFIG{'mail'} or ask("Send mail to '$address' for $uid->{'text'}?", 1)) {
                                        my $mail = send_mail($address, $can_encrypt, $longkeyid, $uid, @attached);
 
                                        my $keydir = "$KEYSBASE/$DATE_STRING";
                                        my $mailfile = "$keydir/$longkeyid.mail.".$uid->{'serial'}.".".sanitize_uid($uid->{'text'});
-                                       open (KEY, ">$mailfile") or die ("Cannot open $mailfile\n");
+                                       open (KEY, ">$mailfile") or die ("Cannot open $mailfile: $!\n");
                                        print KEY $mail;
                                        close KEY;
                                };
@@ -838,59 +971,3 @@ for my $keyid (@keyids_ok) {
        };
 
 };
-
-
-
-
-###############################################################3
-#### old fork gpg --edit
-=cut
-               my ($stdin_read, $stdin_write);
-               my ($stdout_read, $stdout_write);
-               my ($stderr_read, $stderr_write);
-               my ($status_read, $status_write);
-               pipe $stdin_read, $stdin_write;
-               pipe $stdout_read, $stdout_write;
-               pipe $stderr_read, $stderr_write;
-               pipe $status_read, $status_write;
-
-               $pid = fork();
-               unless ($pid) { # child
-                       close $stdin_write;
-                       close $stdout_read;
-                       close $stderr_read;
-                       close $status_read;
-
-                       my @call;
-                       push @call, $CONFIG{'gpg-delsig'};
-                       push @call, "--homedir=$tempdir";
-                       push @call, '--with-colons';
-                       push @call, '--fixed-list-mode';
-                       push @call, '--command-fd=0';
-                       push @call, "--status-fd=".fileno($status_write);
-                       push @call, "--no-tty";
-                       push @call, "--edit";
-                       push @call, $keyid;
-
-                       close STDIN;
-                       close STDOUT;
-                       close STDERR;
-                       open (STDIN, "<&".fileno($stdin_read)) or die ("Cannot reopen stdin: $!\n");
-                       open (STDOUT, ">&".fileno($stdout_write)) or die ("Cannot reopen stdout: $!\n");
-                       open (STDERR, ">&".fileno($stderr_write)) or die ("Cannot reopen stderr: $!\n");
-
-                       fcntl $status_write, F_SETFD, 0;
-
-                       exec (@call);
-                       exit;
-               };
-               close $stdin_read;
-               close $stdout_write;
-               close $stderr_write;
-               close $status_write;
-
-               $inputfd = $stdin_write;
-               $stdoutfd = $stdout_read;
-               $stderrfd = $stderr_read;
-               $statusfd = $status_read;
-=cut