Fix pod syntax problems in caff (Closes: #485653).
[pgp-tools.git] / caff / caff
index 8ec09e3c7c2198cee41b797473a2d7f2d8c758b2..440816c7251efab19c75cf09d565f89672a4441d 100755 (executable)
--- a/caff/caff
+++ b/caff/caff
@@ -40,7 +40,7 @@ caff -- CA - Fire and Forget
 
 =over
 
 
 =over
 
-=item B<caff> [-eEmMRS] [-u I<yourkeyid>] I<keyid> [I<keyid> ..]
+=item B<caff> [-eERS] [-m I<yes|ask-yes|ask-no|no>] [-u I<yourkeyid>] I<keyid> [I<keyid> ..]
 
 =back
 
 
 =back
 
@@ -66,13 +66,10 @@ Export old signatures. Default is to ask the user for each old signature.
 Do not export old signatures. Default is to ask the user for each old
 signature.
 
 Do not export old signatures. Default is to ask the user for each old
 signature.
 
-=item B<-m>, B<--mail>
+=item B<-m>, B<--mail> I<yes|ask-yes|ask-no|no>
 
 
-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.
+Whether to send mail after signing. Default is to ask, for each uid,
+with a default value of yes.
 
 =item B<-R>, B<--no-download>
 
 
 =item B<-R>, B<--no-download>
 
@@ -138,14 +135,22 @@ A list of your keys.  This is used to determine which signatures to keep
 in the pruning step.  If you select a key using B<-u> it has to be in
 this list.  B<REQUIRED>.
 
 in the pruning step.  If you select a key using B<-u> it has to be in
 this list.  B<REQUIRED>.
 
+=back
+
 =head2 General settings
 
 =head2 General settings
 
+=over
+
 =item B<caffhome> [string]
 
 Base directory for the files caff stores.  Default: B<$HOME/.caff/>.
 
 =item B<caffhome> [string]
 
 Base directory for the files caff stores.  Default: B<$HOME/.caff/>.
 
+=back
+
 =head2 GnuPG settings
 
 =head2 GnuPG settings
 
+=over
+
 =item B<gpg> [string]
 
 Path to the GnuPG binary.  Default: B<gpg>.
 =item B<gpg> [string]
 
 Path to the GnuPG binary.  Default: B<gpg>.
@@ -174,8 +179,12 @@ Additional keyids to encrypt messages to. Default: none.
 Additional commands to pass to gpg after the "sign" command.
 Default: none.
 
 Additional commands to pass to gpg after the "sign" command.
 Default: none.
 
+=back
+
 =head2 Keyserver settings
 
 =head2 Keyserver settings
 
+=over
+
 =item B<keyserver> [string]
 
 Keyserver to download keys from.  Default: B<subkeys.pgp.net>.
 =item B<keyserver> [string]
 
 Keyserver to download keys from.  Default: B<subkeys.pgp.net>.
@@ -189,8 +198,12 @@ Default: B<0>.
 
 A list of files containing keys to be imported.
 
 
 A list of files containing keys to be imported.
 
+=back
+
 =head2 Signing settings
 
 =head2 Signing settings
 
+=over
+
 =item B<no-sign> [boolean]
 
 If true, then skip the signing step. Default: B<0>.
 =item B<no-sign> [boolean]
 
 If true, then skip the signing step. Default: B<0>.
@@ -210,16 +223,19 @@ than this age.  Default: B<24*60*60> (i.e. one day).
 Select the key that is used for signing, in case you have more than one key.
 With multiple keyids, sign with each key in turn.
 
 Select the key that is used for signing, in case you have more than one key.
 With multiple keyids, sign with each key in turn.
 
+=back
+
 =head2 Mail settings
 
 =head2 Mail settings
 
-=item B<mail> [boolean]
+=over
 
 
-Do not prompt for sending mail, just do it. Default: B<0>.
+=item B<mail> [boolean]
 
 
-=item B<no-mail> [boolean]
+Whether to send mails. This is a quad-option, with which you can set the
+behaviour: yes always sends, no never sends; ask-yes and ask-no asks, for
+each uid, with according defaults for the question. Default: B<ask-yes>.
 
 
-Do not prompt for sending mail. The messages are still written to
-$CONFIG{'caffhome'}/keys/. Default: B<0>.
+In any case, the messages are also written to $CONFIG{'caffhome'}/keys/
 
 =item B<mail-template> [string]
 
 
 =item B<mail-template> [string]
 
@@ -477,6 +493,9 @@ sub load_config() {
        unless (defined $CONFIG{'mail-template'}) {
                $CONFIG{'mail-template'} .= $_ foreach <DATA>;
        }
        unless (defined $CONFIG{'mail-template'}) {
                $CONFIG{'mail-template'} .= $_ foreach <DATA>;
        }
+       if ((defined $CONFIG{'also-encrypt-to'}) && ! (ref($CONFIG{'also-encrypt-to'}) eq 'ARRAY')) {
+               $CONFIG{'also-encrypt-to'} = [ $CONFIG{'also-encrypt-to'} ];
+       };
 };
 
 sub make_gpg_fds() {
 };
 
 sub make_gpg_fds() {
@@ -659,7 +678,7 @@ sub version($) {
 sub usage($$) {
        my ($fd, $exitcode) = @_;
        version($fd);
 sub usage($$) {
        my ($fd, $exitcode) = @_;
        version($fd);
-       print $fd "Usage: $PROGRAM_NAME [-eEmMRS] [-u <yourkeyid>] <keyid> [<keyid> ...]\n";
+       print $fd "Usage: $PROGRAM_NAME [-eERS] [-m <yes|ask-yes|ask-no|no>] [-u <yourkeyid>] <keyid> [<keyid> ...]\n";
        print $fd "Consult the manual page for more information.\n";
        exit $exitcode;
 };
        print $fd "Consult the manual page for more information.\n";
        exit $exitcode;
 };
@@ -766,19 +785,26 @@ sub send_mail($$$@) {
                my ($inputfd, $stdoutfd, $stderrfd, $statusfd, $handles) = make_gpg_fds();
                $gpg->options->push_recipients( $key_id );
                if (defined $CONFIG{'also-encrypt-to'}) {
                my ($inputfd, $stdoutfd, $stderrfd, $statusfd, $handles) = make_gpg_fds();
                $gpg->options->push_recipients( $key_id );
                if (defined $CONFIG{'also-encrypt-to'}) {
-                       if (ref($CONFIG{'also-encrypt-to'})) {
-                               $gpg->options->push_recipients($_)
-                                       foreach @{$CONFIG{'also-encrypt-to'}};
-                       } else {
-                               $gpg->options->push_recipients($CONFIG{'also-encrypt-to'});
-                       }
+                       $gpg->options->push_recipients($_) foreach @{$CONFIG{'also-encrypt-to'}};
                }
                my $pid = $gpg->encrypt(handles => $handles);
                my ($stdout, $stderr, $status) = readwrite_gpg($message, $inputfd, $stdoutfd, $stderrfd, $statusfd);
                waitpid $pid, 0;
                if ($stdout eq '') {
                }
                my $pid = $gpg->encrypt(handles => $handles);
                my ($stdout, $stderr, $status) = readwrite_gpg($message, $inputfd, $stdoutfd, $stderrfd, $statusfd);
                waitpid $pid, 0;
                if ($stdout eq '') {
-                       warn ("No data from gpg for list-key $key_id\n");
-                       next;
+                       if (($status =~ /^\[GNUPG:\] INV_RECP ([0-9]+) ([0-9A-F]+)/m) and
+                           (defined $CONFIG{'also-encrypt-to'})) {
+                               my $reason = $1;
+                               my $keyid = $2;
+                               if (grep { $_ eq $keyid } @{$CONFIG{'also-encrypt-to'}}) {
+                                       warn("Could not encrypt to $keyid, specified in CONFIG{'also-encrypt-to'}.\n".
+                                            "Try to update the key using gpg --homedir=$GNUPGHOME --import <exported key>\n".
+                                            "or try the following if you are slightly more daring:\n".
+                                            " gpg --export $keyid | gpg --homedir=$GNUPGHOME --import\n");
+                                       return;
+                               };
+                       };
+                       warn ("No data from gpg for encrypting mail.  STDERR was:\n$stderr\nstatus output was:\n$status\n");
+                       return;
                };
                $message = $stdout;
 
                };
                $message = $stdout;
 
@@ -788,6 +814,7 @@ sub send_mail($$$@) {
 
                $message_entity->attach(
                        Type        => "application/pgp-encrypted",
 
                $message_entity->attach(
                        Type        => "application/pgp-encrypted",
+                       Filename    => "signedkey.msg",
                        Disposition => 'attachment',
                        Encoding    => "7bit",
                        Data        => "Version: 1\n");
                        Disposition => 'attachment',
                        Encoding    => "7bit",
                        Data        => "Version: 1\n");
@@ -881,8 +908,8 @@ if (!GetOptions (
        '--export-old'    =>  \$params->{'export-old'},
        '-E'              =>  \$params->{'no-export-old'},
        '--no-export-old' =>  \$params->{'no-export-old'},
        '--export-old'    =>  \$params->{'export-old'},
        '-E'              =>  \$params->{'no-export-old'},
        '--no-export-old' =>  \$params->{'no-export-old'},
-       '-m'              =>  \$params->{'mail'},
-       '--mail'          =>  \$params->{'mail'},
+       '-m:s'              =>  \$params->{'mail'},
+       '--mail:s'          =>  \$params->{'mail'},
        '-M'              =>  \$params->{'no-mail'},
        '--no-mail'       =>  \$params->{'no-mail'},
        '-R'              =>  \$params->{'no-download'},
        '-M'              =>  \$params->{'no-mail'},
        '--no-mail'       =>  \$params->{'no-mail'},
        '-R'              =>  \$params->{'no-download'},
@@ -904,13 +931,26 @@ usage(\*STDERR, 1) unless scalar @ARGV >= 1;
 
 $CONFIG{'local-user'}  = $params->{'local-user'}  if defined $params->{'local-user'};
 $CONFIG{'no-download'} = $params->{'no-download'} if defined $params->{'no-download'};
 
 $CONFIG{'local-user'}  = $params->{'local-user'}  if defined $params->{'local-user'};
 $CONFIG{'no-download'} = $params->{'no-download'} if defined $params->{'no-download'};
+$CONFIG{'no-sign'}     = $params->{'no-sign'}     if defined $params->{'no-sign'};
+
+# If old 'no-mail' parameter, or if the 'mail' parameter is set to 'no'
+if ( $CONFIG{'no-mail'} || defined $params->{'no-mail'} ||
+       ( defined $params->{'mail'} && $params->{'mail'}  eq 'no' ) ) {
+       $CONFIG{'mail'} = 'no';
+} elsif ( defined $params->{'mail'} ) {
+       $CONFIG{'mail'} = $params->{'mail'};
+} else {
+       $CONFIG{'mail'} = 'ask-yes';
+}
+
 $CONFIG{'no-mail'}     = $params->{'no-mail'}     if defined $params->{'no-mail'};
 $CONFIG{'mail'}        = $params->{'mail'}        if defined $params->{'mail'};
 $CONFIG{'no-mail'}     = $params->{'no-mail'}     if defined $params->{'no-mail'};
 $CONFIG{'mail'}        = $params->{'mail'}        if defined $params->{'mail'};
-$CONFIG{'no-sign'}     = $params->{'no-sign'}     if defined $params->{'no-sign'};
+
 push @{$CONFIG{'key-files'}}, @{$params->{'key-files'}} if defined $params->{'key-files'};
 
 push @{$CONFIG{'key-files'}}, @{$params->{'key-files'}} if defined $params->{'key-files'};
 
-for my $keyid (@ARGV) {
+for my $keyid (map { split /\n/ } @ARGV) { # caff "`cat txt`" is a single argument
        $keyid =~ s/^0x//i;
        $keyid =~ s/^0x//i;
+       $keyid =~ s/ //g; # gpg --fingerprint includes spaces
        if ($keyid =~ /^[A-F0-9]{32}$/i) {
                info("Ignoring v3 fingerprint $keyid.  v3 keys are obsolete.");
                next;
        if ($keyid =~ /^[A-F0-9]{32}$/i) {
                info("Ignoring v3 fingerprint $keyid.  v3 keys are obsolete.");
                next;
@@ -926,22 +966,7 @@ for my $keyid (@ARGV) {
 # import own keys
 #################
 for my $keyid (@{$CONFIG{'keyid'}}) {
 # import own keys
 #################
 for my $keyid (@{$CONFIG{'keyid'}}) {
-       my $gpg = GnuPG::Interface->new();
-       $gpg->call( $CONFIG{'gpg'} );
-       $gpg->options->hash_init(
-               'homedir' => $GNUPGHOME,
-               'extra_args' => [ qw{ --no-auto-check-trustdb --trust-model=always --with-colons --fixed-list-mode --fast-list-mode } ] );
-       $gpg->options->meta_interactive( 0 );
-       my ($inputfd, $stdoutfd, $stderrfd, $statusfd, $handles) = make_gpg_fds();
-       my $pid = $gpg->list_public_keys(handles => $handles, command_args => $keyid);
-       my ($stdout, $stderr, $status) = readwrite_gpg('', $inputfd, $stdoutfd, $stderrfd, $statusfd);
-       waitpid $pid, 0;
-
-       if ($stdout eq '') {
-               warn ("No data from gpg for list-key\n"); # There should be at least 'tru:' everywhere.
-       };
-       unless ($stdout =~ /^pub:(?:[^:]*:){3,3}$keyid:/m) {
-               info("Key $keyid not found in caff's home.  Getting it from your normal GnuPGHome.");
+               info("Importing key $keyid from your normal GnuPGHome.");
                my $key = export_key(undef, $keyid);
                if (!defined $key || $key eq '') {
                        warn ("Did not get key $keyid from your normal GnuPGHome\n");
                my $key = export_key(undef, $keyid);
                if (!defined $key || $key eq '') {
                        warn ("Did not get key $keyid from your normal GnuPGHome\n");
@@ -952,7 +977,6 @@ for my $keyid (@{$CONFIG{'keyid'}}) {
                        warn ("Could not import $keyid into caff's gnupghome.\n");
                        next;
                };
                        warn ("Could not import $keyid into caff's gnupghome.\n");
                        next;
                };
-       }
 }
 
 ########################
 }
 
 ########################
@@ -1286,7 +1310,7 @@ for my $keyid (@keyids_ok) {
        if (scalar @UIDS == 0) {
                info("found no signed uids for $keyid");
        } else {
        if (scalar @UIDS == 0) {
                info("found no signed uids for $keyid");
        } else {
-               next if $CONFIG{'no-mail'}; # do not send mail
+               next if ($CONFIG{'mail'} eq 'no'); # do not send mail
 
                my @attached;
                for my $uid (@UIDS) {
 
                my @attached;
                for my $uid (@UIDS) {
@@ -1305,14 +1329,17 @@ for my $keyid (@keyids_ok) {
                        if (!$uid->{'is_uat'} && ($uid->{'text'} =~ /@/)) {
                                my $address = $uid->{'text'};
                                $address =~ s/.*<(.*)>.*/$1/;
                        if (!$uid->{'is_uat'} && ($uid->{'text'} =~ /@/)) {
                                my $address = $uid->{'text'};
                                $address =~ s/.*<(.*)>.*/$1/;
-                               if (ask("Mail signature for $uid->{'text'} to '$address'?", 1, $CONFIG{'mail'})) {
+                               if (ask("Mail signature for $uid->{'text'} to '$address'?", $CONFIG{'mail'} ne 'ask-no', $CONFIG{'mail'} eq 'yes')) {
                                        my $mail = send_mail($address, $can_encrypt, $longkeyid, $uid, @attached);
                                        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");
-                                       print KEY $mail;
-                                       close KEY;
+                                       if (defined $mail) {
+                                               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");
+                                               print KEY $mail;
+                                               close KEY;
+                                       } else {
+                                               warn "Generating mail failed.\n";
+                                       };
                                };
                        };
                };
                                };
                        };
                };