X-Git-Url: https://git.sthu.org/?a=blobdiff_plain;f=caff%2Fcaff;h=362ff95ff17fdc63ed1b7a15af2b07f621db4c00;hb=b8faf2bc7b76f47e6cc494c81c0225ff1c4e8527;hp=9ce3a966b8c1a91e8133e642778b80ae8b28548f;hpb=79a0077e9b7b5c4e2c9304492f55b3fe50fb39a9;p=pgp-tools.git diff --git a/caff/caff b/caff/caff index 9ce3a96..362ff95 100755 --- a/caff/caff +++ b/caff/caff @@ -40,7 +40,7 @@ caff -- CA - Fire and Forget =over -=item B [-eEmMRS] [-u I] I [I ..] +=item B [-eERS] [-m I] [-u I] I [I ..] =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. -=item B<-m>, B<--mail> +=item B<-m>, B<--mail> I -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> @@ -85,7 +82,9 @@ Do not sign the keys. =item B<-u> I, B<--local-user> I Select the key that is used for signing, in case you have more than one key. -To sign with multiple keys at once, separate multiple keyids by comma. +To sign with multiple keys at once, separate multiple keyids by comma. This +option requires the key(s) to be defined through the keyid variable in the +configuration file. =item B<--key-file> I @@ -138,14 +137,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. +=back + =head2 General settings +=over + =item B [string] Base directory for the files caff stores. Default: B<$HOME/.caff/>. +=back + =head2 GnuPG settings +=over + =item B [string] Path to the GnuPG binary. Default: B. @@ -174,11 +181,15 @@ Additional keyids to encrypt messages to. Default: none. Additional commands to pass to gpg after the "sign" command. Default: none. +=back + =head2 Keyserver settings +=over + =item B [string] -Keyserver to download keys from. Default: B. +Keyserver to download keys from. Default: B. =item B [boolean] @@ -189,8 +200,12 @@ Default: B<0>. A list of files containing keys to be imported. +=back + =head2 Signing settings +=over + =item B [boolean] If true, then skip the signing step. Default: B<0>. @@ -210,16 +225,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. +=back + =head2 Mail settings -=item B [boolean] +=over -Do not prompt for sending mail, just do it. Default: B<0>. +=item B [boolean] -=item B [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. -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 [string] @@ -310,6 +328,17 @@ my ($REVISION_NUMER) = $REVISION =~ /(\d+)/; my $VERSION = "0.0.0.$REVISION_NUMER"; +## +# Display an error message on STDERR and then exit. +# +# @param $exitcode exit code status to use to end the program +# @param $line error message to display on STDERR +# +sub myerror($$) { + my ($exitcode, $line) = @_; + print "[ERROR] $line\n"; + exit $exitcode; +}; sub mywarn($) { my ($line) = @_; @@ -460,7 +489,7 @@ sub load_config() { }; @{$CONFIG{'keyid'}} = map { uc } @{$CONFIG{'keyid'}}; $CONFIG{'export-sig-age'}= 24*60*60 unless defined $CONFIG{'export-sig-age'}; - $CONFIG{'keyserver'} = 'subkeys.pgp.net' unless defined $CONFIG{'keyserver'}; + $CONFIG{'keyserver'} = 'pool.sks-keyservers.net' unless defined $CONFIG{'keyserver'}; $CONFIG{'gpg'} = 'gpg' unless defined $CONFIG{'gpg'}; $CONFIG{'gpg-sign'} = $CONFIG{'gpg'} unless defined $CONFIG{'gpg-sign'}; $CONFIG{'gpg-delsig'} = $CONFIG{'gpg'} unless defined $CONFIG{'gpg-delsig'}; @@ -662,7 +691,7 @@ sub version($) { sub usage($$) { my ($fd, $exitcode) = @_; version($fd); - print $fd "Usage: $PROGRAM_NAME [-eEmMRS] [-u ] [ ...]\n"; + print $fd "Usage: $PROGRAM_NAME [-eERS] [-m ] [-u ] [ ...]\n"; print $fd "Consult the manual page for more information.\n"; exit $exitcode; }; @@ -779,8 +808,11 @@ sub send_mail($$$@) { (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, spezified in CONFIG{'also-encrypt-to'}. Try to update the key using gpg --homedir=\$HOME/caff/gnupghome --import ."); + 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 \n". + "or try the following if you are slightly more daring:\n". + " gpg --export $keyid | gpg --homedir=$GNUPGHOME --import\n"); return; }; }; @@ -795,6 +827,7 @@ sub send_mail($$$@) { $message_entity->attach( Type => "application/pgp-encrypted", + Filename => "signedkey.msg", Disposition => 'attachment', Encoding => "7bit", Data => "Version: 1\n"); @@ -869,6 +902,63 @@ sub delete_signatures($$$$$$) { return $signed_by_me; }; +## +# Check the local user keys. +# +# This function checks if the keyids defined through the --local-user +# command line option or set in .caffrc are valid and known to be one of the +# keyids listed in ./caffrc. The last check ensure we have those keyids +# available in the caff's gnupghome directory. +# +# @return an array containing the local user keys\n +# (undef) if no key has been specified +# +sub get_local_user_keys() +{ + my @local_user = (); + my @key_list; + + # No user-defined key id has been specified by the user, no need for + # further checks + if (!$CONFIG{'local-user'}) { + return (undef); + } + + # Parse the list of keys + if (ref($CONFIG{'local-user'})) { + @key_list = @{$CONFIG{'local-user'}}; + } + else { + @key_list = split /\s*,\s*/, $CONFIG{'local-user'}; + } + + # Check every key defined by the user... + for my $user_key (@key_list) { + + $user_key =~ s/^0x//i; + $user_key = uc($user_key); + + unless ($user_key =~ m/^([A-F0-9]{8}|[A-F0-9]{16}|[A-F0-9]{40})$/) { + mywarn "Local-user $user_key is not a valid keyid."; + next; + } + + unless (grep (/$user_key$/, @{$CONFIG{'keyid'}})) { + mywarn "Local-user $user_key is not defined as one of your keyid in ./caffrc (it will not be used)."; + next; + } + + push (@local_user, $user_key); + } + + # If no local-user key are valid, there is no need to go further + unless (defined $local_user[0]) { + myerror (1, "None of the local-user keys seem to be known as a keyid listed in ./caffrc."); + } + + return @local_user; +} + ################### # argument handling @@ -888,8 +978,8 @@ if (!GetOptions ( '--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'}, @@ -911,9 +1001,20 @@ 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{'no-sign'} = $params->{'no-sign'} if defined $params->{'no-sign'}; + $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'}; + +# If old 'no-mail' parameter, or if the 'mail' parameter is set to 'no' +if ( defined $CONFIG{'no-mail'} || + ( defined $CONFIG{'mail'} && $CONFIG{'mail'} eq 'no' ) ) { + $CONFIG{'mail'} = 'no'; + +} elsif ( !defined $CONFIG{'mail'} ) { + $CONFIG{'mail'} = 'ask-yes'; +} + push @{$CONFIG{'key-files'}}, @{$params->{'key-files'}} if defined $params->{'key-files'}; for my $keyid (map { split /\n/ } @ARGV) { # caff "`cat txt`" is a single argument @@ -934,22 +1035,7 @@ for my $keyid (map { split /\n/ } @ARGV) { # caff "`cat txt`" is a single argume # 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"); @@ -960,7 +1046,6 @@ for my $keyid (@{$CONFIG{'keyid'}}) { warn ("Could not import $keyid into caff's gnupghome.\n"); next; }; - } } ######################## @@ -1057,25 +1142,9 @@ if ($CONFIG{'ask-sign'} && ! $CONFIG{'no-sign'}) { $CONFIG{'no-sign'} = ! ask("Continue with signing?", 1); } -unless ($CONFIG{'no-sign'}) { - my @local_user; - if ($CONFIG{'local-user'}) { - if (ref($CONFIG{'local-user'})) { - @local_user = @{$CONFIG{'local-user'}}; - } else { - @local_user = split /\s*,\s*/, $CONFIG{'local-user'}; - }; - foreach (@local_user) { - s/^0x//i; - unless (/^([A-F0-9]{8}|[A-F0-9]{16}|[A-F0-9]{40})$/i) { - print STDERR "Local-user $_ is not a keyid.\n"; - usage(\*STDERR, 1); - }; - $_ = uc($_); - }; - } else { - @local_user = (undef); - }; +unless ($CONFIG{'no-sign'}) +{ + my @local_user = &get_local_user_keys(); info("Sign the following keys according to your policy, then exit gpg with 'save' after signing each key"); for my $keyid (@keyids_ok) { @@ -1294,7 +1363,7 @@ for my $keyid (@keyids_ok) { 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) { @@ -1313,14 +1382,17 @@ for my $keyid (@keyids_ok) { 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 $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"; + }; }; }; }; @@ -1347,7 +1419,7 @@ the signatures by running each through `gpg --import`. 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} + gpg --keyserver pool.sks-keyservers.net --send-key {$key} If you have any questions, don't hesitate to ask.