Use getopt long
[pgp-tools.git] / caff / caff
index fe5fd9778d9e0dee3d99cc3485b07edf8486665b..53d76c318a83412a1545540602e89fc5f16a2c10 100755 (executable)
--- a/caff/caff
+++ b/caff/caff
@@ -39,7 +39,7 @@ caff -- CA - Fire and Forget
 
 =over
 
-=item B<caff> [-u I<yourkeyid>] I<keyid> [I<keyid> ..]
+=item B<caff> [-mMR] [-u I<yourkeyid>] I<keyid> [I<keyid> ..]
 
 =back
 
@@ -55,7 +55,19 @@ sigs and sigs done by you.
 
 =over
 
-=item B<-u> I<yourkeyid>
+=item B<-m>, B<--mail>
+
+Send mail after signing. Default is to ask the user for each uid.
+
+=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>, B<--local-user> I<yourkeyid>
 
 Select the key that is used for signing, in case you have more than one key.
 
@@ -121,9 +133,9 @@ B<gpg> is set to.
 
 =item B<gpg-delsig> [string]
 
-Path to the GnuPG binary which is used to split off signatures.  This is
-needed while the upstream GnuPG is not fixed  (there are 2 bugs in the
-Debian Bug Tracking System).  Default: what B<gpg> is set to.
+Path to the GnuPG binary which is used to split off signatures.  This was
+needed while the upstream GnuPG was not fixed.  Default: what B<gpg>
+is set to.
 
 =item B<secret-keyring> [string]
 
@@ -142,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
@@ -159,9 +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::Long;
 use GnuPG::Interface;
 
 my %CONFIG;
@@ -193,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($) {
@@ -231,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;
@@ -366,10 +420,17 @@ 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 [-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;
 };
 
 sub export_key($$) {
@@ -393,24 +454,18 @@ sub export_key($$) {
 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.
+       my $message = $template->fill_in(HASH => { key => $key_id,
+                                                  uids => \@uids,
+                                                  owner => $CONFIG{'owner'}})
+           or die "Error filling template in: $Text::Template::ERROR";
 
-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
-
-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",
@@ -485,28 +540,58 @@ sub sanitize_uid($) {
 
 my $USER;
 my @KEYIDS;
+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;
 
-usage() unless scalar @ARGV >= 1;
-if ($ARGV[0] eq '-u') {
-       usage() unless scalar @ARGV >= 3;
-       shift @ARGV;
-       $USER = shift @ARGV;
+
+
+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'};
 
 
 #################
@@ -563,19 +648,29 @@ if ($CONFIG{'no-download'}) {
 # [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;
@@ -620,14 +715,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
        ################
@@ -687,7 +793,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++;
                        };
@@ -747,7 +853,7 @@ for my $keyid (@keyids_ok) {
                        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;
+                               my (undef, undef, undef, undef, $signer, $created, undef, undef, undef) = split /:/, $line;
                                if ($signer eq $longkeyid) {
                                        debug("[sigremoval] selfsig ($signer).");
                                        $answer = "no";
@@ -768,9 +874,9 @@ for my $keyid (@keyids_ok) {
                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;
                };
 
@@ -783,7 +889,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;
 
@@ -798,7 +904,9 @@ for my $keyid (@keyids_ok) {
        if (scalar @UIDS == 0) {
                info("found no signed uids for $keyid");
        } else {
-               my @attached ;
+               next if $CONFIG{'no-mail'}; # do not send mail
+
+               my @attached;
                for my $uid (@UIDS) {
                        trace("UID: $uid->{'text'}\n");
                        unless ($uid->{'text'} =~ /@/) {
@@ -812,13 +920,12 @@ for my $keyid (@keyids_ok) {
                        if ($uid->{'text'} =~ /@/) {
                                my $address = $uid->{'text'};
                                $address =~ s/.*<(.*)>.*/$1/;
-                               my $send = ask("Send mail to '$address' for $uid->{'text'}?", 1);
-                               if ($send) {
+                               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;
                                };