3 # caff -- CA - Fire and Forget
6 # Copyright (c) 2004, 2005 Peter Palfrader <peter@palfrader.org>
7 # Copyright (c) 2005, 2006 Christoph Berg <cb@df7cb.de>
11 # Redistribution and use in source and binary forms, with or without
12 # modification, are permitted provided that the following conditions
14 # 1. Redistributions of source code must retain the above copyright
15 # notice, this list of conditions and the following disclaimer.
16 # 2. Redistributions in binary form must reproduce the above copyright
17 # notice, this list of conditions and the following disclaimer in the
18 # documentation and/or other materials provided with the distribution.
19 # 3. The name of the author may not be used to endorse or promote products
20 # derived from this software without specific prior written permission.
22 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
23 # IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24 # OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25 # IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
26 # INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27 # NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31 # THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 caff -- CA - Fire and Forget
43 =item B<caff> [-eEmMRS] [-u I<yourkeyid>] I<keyid> [I<keyid> ..]
49 CA Fire and Forget is a script that helps you in keysigning. It takes a list
50 of keyids on the command line, fetches them from a keyserver and calls GnuPG so
51 that you can sign it. It then mails each key to all its email addresses - only
52 including the one UID that we send to in each mail, pruned from all but self
53 sigs and sigs done by you. The mailed key is encrypted with itself as a means
54 to verify that key belongs to the recipient.
60 =item B<-e>, B<--export-old>
62 Export old signatures. Default is to ask the user for each old signature.
64 =item B<-E>, B<--no-export-old>
66 Do not export old signatures. Default is to ask the user for each old
69 =item B<-m>, B<--mail>
71 Send mail after signing. Default is to ask the user for each uid.
73 =item B<-M>, B<--no-mail>
75 Do not send mail after signing. Default is to ask the user for each uid.
77 =item B<-R>, B<--no-download>
79 Do not retrieve the key to be signed from a keyserver.
81 =item B<-S>, B<--no-sign>
85 =item B<-u> I<yourkeyid>, B<--local-user> I<yourkeyid>
87 Select the key that is used for signing, in case you have more than one key.
89 =item B<--key-file> I<file>
91 Import keys from file. Can be supplied more than once.
99 =item $HOME/.caffrc - configuration file
101 =item $HOME/.caff/keys/yyyy-mm-dd/ - processed keys
103 =item $HOME/.caff/gnupghome/ - caff's working dir for gpg
105 =item $HOME/.caff/gnupghome/gpg.conf - gpg configuration
107 useful options include use-agent, default-cert-level, etc.
111 =head1 CONFIGURATION FILE OPTIONS
113 The configuration file is a perl script that sets values in the hash B<%CONFIG>.
114 The file is generated when it does not exist.
118 $CONFIG{owner} = q{Peter Palfrader};
119 $CONFIG{email} = q{peter@palfrader.org};
120 $CONFIG{keyid} = [ qw{DE7AAF6E94C09C7F 62AF4031C82E0039} ];
122 =head2 Required basic settings
126 =item B<owner> [string]
128 Your name. B<REQUIRED>.
130 =item B<email> [string]
132 Your email address, used in From: lines. B<REQUIRED>.
134 =item B<keyid> [list of keyids]
136 A list of your keys. This is used to determine which signatures to keep
137 in the pruning step. If you select a key using B<-u> it has to be in
138 this list. B<REQUIRED>.
140 =head2 General settings
142 =item B<caffhome> [string]
144 Base directory for the files caff stores. Default: B<$HOME/.caff/>.
146 =head2 GnuPG settings
148 =item B<gpg> [string]
150 Path to the GnuPG binary. Default: B<gpg>.
152 =item B<gpg-sign> [string]
154 Path to the GnuPG binary which is used to sign keys. Default: what
157 =item B<gpg-delsig> [string]
159 Path to the GnuPG binary which is used to split off signatures. This was
160 needed while the upstream GnuPG was not fixed. Default: what B<gpg>
163 =item B<secret-keyring> [string]
165 Path to your secret keyring. Default: B<$HOME/.gnupg/secring.gpg>.
167 =item B<also-encrypt-to> [keyid]
169 An additional keyid to encrypt messages to. Default: none.
171 =item B<gpg-sign-args> [string]
173 Additional arguments to pass to gpg. Default: none.
175 =head2 Keyserver settings
177 =item B<keyserver> [string]
179 Keyserver to download keys from. Default: B<subkeys.pgp.net>.
181 =item B<no-download> [boolean]
183 If true, then skip the step of fetching keys from the keyserver.
186 =item B<key-files> [list of files]
188 A list of files containing keys to be imported.
190 =head2 Signing settings
192 =item B<no-sign> [boolean]
194 If true, then skip the signing step. Default: B<0>.
196 =item B<ask-sign> [boolean]
198 If true, then pause before continuing to the signing step.
199 This is useful for offline signing. Default: B<0>.
201 =item B<export-sig-age> [seconds]
203 Don't export UIDs by default, on which your latest signature is older
204 than this age. Default: B<24*60*60> (i.e. one day).
206 =item B<local-user> [string]
208 Select the key that is used for signing, in case you have more than one key.
212 =item B<mail> [boolean]
214 Do not prompt for sending mail, just do it. Default: B<0>.
216 =item B<no-mail> [boolean]
218 Do not prompt for sending mail. The messages are still written to
219 $CONFIG{caffhome}/keys/. Default: B<0>.
221 =item B<mail-template> [string]
223 Email template which is used as the body text for the email sent out
224 instead of the default text if specified. The following perl variables
225 can be used in the template:
229 =item B<{owner}> [string]
231 Your name as specified in the L<B<owner>|/item_owner__5bstring_5d> setting.
233 =item B<{key}> [string]
235 The keyid of the key you signed.
237 =item B<{@uids}> [array]
239 The UIDs for which signatures are included in the mail.
243 =item B<reply-to> [string]
245 Add a Reply-To: header to messages sent. Default: none.
247 =item B<bcc> [string]
249 Address to send blind carbon copies to when sending mail.
252 =item B<mailer-send> [array]
254 Parameters to pass to Mail::Mailer.
255 This could for example be
257 $CONFIG{mailer-send} = [ 'smtp', Server => 'mail.server', Auth => ['user', 'pass'] ]
259 to use the perl SMTP client or
261 $CONFIG{mailer-send} = [ 'sendmail', '-o8' ]
263 to pass arguments to the sendmail program.
264 For more information run C<< perldoc Mail::Mailer >>.
265 Setting this option is strongly discouraged. Fix your local MTA
275 =item Peter Palfrader <peter@palfrader.org>
277 =item Christoph Berg <cb@df7cb.de>
283 http://pgp-tools.alioth.debian.org/
287 gpg(1), pgp-clean(1), /usr/share/doc/signing-party/caff/caffrc.sample.
295 use File
::Temp
qw{tempdir
};
301 use GnuPG
::Interface
;
304 my $REVISION = '$Rev$';
305 my ($REVISION_NUMER) = $REVISION =~ /(\d+)/;
306 my $VERSION = "0.0.0.$REVISION_NUMER";
312 print "[WARN] $line\n";
316 print "[NOTICE] $line\n";
320 print "[INFO] $line\n";
324 #print "[DEBUG] $line\n";
328 #print "[trace] $line\n";
332 #print "[trace2] $line\n";
336 sub generate_config
() {
337 notice
("Error: \$LOGNAME is not set.\n") unless defined $ENV{'LOGNAME'};
338 my $gecos = defined $ENV{'LOGNAME'} ?
(getpwnam($ENV{LOGNAME
}))[6] : undef;
341 # BSD does not have hostname -f, so we try without -f first
342 my $hostname = `hostname`;
343 $hostname = `hostname -f` unless $hostname =~ /\./;
345 my ($Cgecos,$Cemail,$Ckeys) = ('','','');
347 if (defined $gecos) {
350 my $gpg = GnuPG
::Interface
->new();
352 $gpg->options->hash_init(
353 'extra_args' => [ qw{ --no-auto
-check
-trustdb
--trust
-model
=always
--with
-colons
--fixed
-list
-mode
} ] );
354 $gpg->options->meta_interactive( 0 );
355 my ($inputfd, $stdoutfd, $stderrfd, $statusfd, $handles) = make_gpg_fds
();
356 my $pid = $gpg->list_public_keys(handles
=> $handles, command_args
=> [ $gecos ]);
357 my ($stdout, $stderr, $status) = readwrite_gpg
('', $inputfd, $stdoutfd, $stderrfd, $statusfd);
361 warn ("No data from gpg for list-key\n"); # There should be at least 'tru:' everywhere.
364 @keys = ($stdout =~ /^pub:[^r:]*:(?:[^:]*:){2,2}([^:]+):/mg);
365 unless (scalar @keys) {
366 info
("Error: No keys were found using \"gpg --list-public-keys '$gecos'\".");
367 @keys = qw{0123456789abcdef
89abcdef76543210
};
370 ($email) = ($stdout =~ /^uid:.*<(.+?@.+?)>.*:/m);
371 unless (defined $email) {
372 info
("Error: No email address was found using \"gpg --list-public-keys '$gecos'\".");
373 $email = $ENV{'LOGNAME'}.'@'.$hostname;
377 $gecos = 'Unknown Caff User';
378 $email = $ENV{'LOGNAME'}.'@'.$hostname;
379 @keys = qw{0123456789abcdef
89abcdef76543210
};
380 ($Cgecos,$Cemail,$Ckeys) = ('#','#','#');
384 # .caffrc -- vim:syntax=perl:
385 # This file is in perl(1) format - see caff(1) for details.
387 $Cgecos\$CONFIG{'owner'} = '$gecos';
388 $Cemail\$CONFIG{'email'} = '$email';
390 # you can get your long keyid from
391 # gpg --with-colons --list-key <yourkeyid|name|emailaddress..>
393 # if you have a v4 key, it will simply be the last 16 digits of
397 # \$CONFIG{'keyid'} = [ qw{FEDCBA9876543210} ];
398 # or, if you have more than one key:
399 # \$CONFIG{'keyid'} = [ qw{0123456789ABCDEF 89ABCDEF76543210} ];
401 $Ckeys\$CONFIG{'keyid'} = [ qw{@keys} ];
405 sub check_executable
($$) {
406 # (GnuPG::Interface gives lousy errors when the gpg binary isn't found,
407 # so we want to check manually.)
408 my ($purpose, $fn) = @_;
409 # Only check provided fnames with a slash in them.
410 return unless defined $fn;
412 die ("$PROGRAM_NAME: $purpose executable '$fn' not found.\n") unless -x
$fn;
414 for my $p (split(':', $ENV{PATH
})) {
415 return if -x
"$p/$fn";
417 die ("$PROGRAM_NAME: $purpose executable '$fn' not found on path.\n") unless -x
$fn;
422 my $config = $ENV{'HOME'} . '/.caffrc';
423 unless (-f
$config) {
424 print "No configfile $config present, I will use this template:\n";
425 my $template = generate_config
();
426 print "$template\nPlease edit $config and run caff again.\n";
427 open F
, ">$config" or die "$config: $!";
432 unless (scalar eval `cat $config`) {
433 die "Couldn't parse $config: $EVAL_ERROR\n" if $EVAL_ERROR;
436 $CONFIG{'caffhome'}=$ENV{'HOME'}.'/.caff' unless defined $CONFIG{'caffhome'};
437 die ("$PROGRAM_NAME: owner is not defined in $config.\n") unless defined $CONFIG{'owner'};
438 die ("$PROGRAM_NAME: email is not defined in $config.\n") unless defined $CONFIG{'email'};
439 die ("$PROGRAM_NAME: keyid is not defined in $config.\n") unless defined $CONFIG{'keyid'};
440 die ("$PROGRAM_NAME: keyid is not an array ref in $config.\n") unless (ref $CONFIG{'keyid'} eq 'ARRAY');
441 for my $keyid (@
{$CONFIG{'keyid'}}) {
442 $keyid =~ /^[A-F0-9]{16}$/i or die ("$PROGRAM_NAME: key $keyid is not a long (16 digit) keyid in $config.\n");
444 @
{$CONFIG{'keyid'}} = map { uc } @
{$CONFIG{'keyid'}};
445 $CONFIG{'export-sig-age'}= 24*60*60 unless defined $CONFIG{'export-sig-age'};
446 $CONFIG{'keyserver'} = 'subkeys.pgp.net' unless defined $CONFIG{'keyserver'};
447 $CONFIG{'gpg'} = 'gpg' unless defined $CONFIG{'gpg'};
448 $CONFIG{'gpg-sign'} = $CONFIG{'gpg'} unless defined $CONFIG{'gpg-sign'};
449 $CONFIG{'gpg-delsig'} = $CONFIG{'gpg'} unless defined $CONFIG{'gpg-delsig'};
450 check_executable
("gpg", $CONFIG{'gpg'});
451 check_executable
("gpg-sign", $CONFIG{'gpg-sign'});
452 check_executable
("gpg-delsig", $CONFIG{'gpg-delsig'});
453 $CONFIG{'secret-keyring'} = $ENV{'HOME'}.'/.gnupg/secring.gpg' unless defined $CONFIG{'secret-keyring'};
454 $CONFIG{'no-download'} = 0 unless defined $CONFIG{'no-download'};
455 $CONFIG{'no-sign'} = 0 unless defined $CONFIG{'no-sign'};
456 $CONFIG{'key-files'} = () unless defined $CONFIG{'key-files'};
457 $CONFIG{'mailer-send'} = [] unless defined $CONFIG{'mailer-send'};
458 die ("$PROGRAM_NAME: mailer-send is not an array ref in $config.\n") unless (ref $CONFIG{'mailer-send'} eq 'ARRAY');
459 $CONFIG{'mail-template'} = <<'EOM' unless defined $CONFIG{'mail-template'};
462 please find attached the user id{(scalar @uids >= 2 ? 's' : '')}.
463 {foreach $uid (@uids) {
464 $OUT .= "\t".$uid."\n";
465 };} of your key {$key} signed by me.
467 Note that I did not upload your key to any keyservers.
468 If you have multiple user ids, I sent the signature for each user id
469 separately to that user id's associated email address. You can import
470 the signatures by running each through `gpg --import`.
472 If you want this new signature to be available to others, please upload
473 it yourself. With GnuPG this can be done using
474 gpg --keyserver subkeys.pgp.net --send-key {$key}
476 If you have any questions, don't hesitate to ask.
485 stdin
=> IO
::Handle
->new(),
486 stdout
=> IO
::Handle
->new(),
487 stderr
=> IO
::Handle
->new(),
488 status
=> IO
::Handle
->new() );
489 my $handles = GnuPG
::Handles
->new( %fds );
490 return ($fds{'stdin'}, $fds{'stdout'}, $fds{'stderr'}, $fds{'status'}, $handles);
493 sub readwrite_gpg
($$$$$%) {
494 my ($in, $inputfd, $stdoutfd, $stderrfd, $statusfd, %options) = @_;
496 trace
("Entering readwrite_gpg.");
498 my ($first_line, undef) = split /\n/, $in;
499 debug
("readwrite_gpg sends ".(defined $first_line ?
$first_line : "<nothing>"));
501 local $INPUT_RECORD_SEPARATOR = undef;
502 my $sout = IO
::Select
->new();
503 my $sin = IO
::Select
->new();
506 trace
("input is $inputfd; output is $stdoutfd; err is $stderrfd; status is ".(defined $statusfd ?
$statusfd : 'undef').".");
508 $inputfd->blocking(0);
509 $stdoutfd->blocking(0);
510 $statusfd->blocking(0) if defined $statusfd;
511 $stderrfd->blocking(0);
512 $sout->add($stdoutfd);
513 $sout->add($stderrfd);
514 $sout->add($statusfd) if defined $statusfd;
517 my ($stdout, $stderr, $status) = ("", "", "");
518 my $exitwhenstatusmatches = $options{'exitwhenstatusmatches'};
519 trace
("doing stuff until we find $exitwhenstatusmatches") if defined $exitwhenstatusmatches;
521 my $readwrote_stuff_this_time = 0;
522 my $do_not_wait_on_select = 0;
523 my ($readyr, $readyw, $written);
524 while ($sout->count() > 0 || (defined($sin) && ($sin->count() > 0))) {
525 if (defined $exitwhenstatusmatches) {
526 if ($status =~ /$exitwhenstatusmatches/m) {
527 trace
("readwrite_gpg found match on $exitwhenstatusmatches");
528 if ($readwrote_stuff_this_time) {
529 trace
("read/write some more\n");
530 $do_not_wait_on_select = 1;
532 trace
("that's it in our while loop.\n");
538 $readwrote_stuff_this_time = 0;
539 trace
("select waiting for ".($sout->count())." fds.");
540 ($readyr, $readyw, undef) = IO
::Select
::select($sout, $sin, undef, $do_not_wait_on_select ?
0 : 1);
541 trace
("ready: write: ".(defined $readyw ?
scalar @
$readyw : 0 )."; read: ".(defined $readyr ?
scalar @
$readyr : 0));
542 for my $wfd (@
$readyw) {
543 $readwrote_stuff_this_time = 1;
544 if (length($in) != $offset) {
545 trace
("writing to $wfd.");
546 $written = $wfd->syswrite($in, length($in) - $offset, $offset);
549 if ($offset == length($in)) {
550 trace
("writing to $wfd done.");
551 unless ($options{'nocloseinput'}) {
553 trace
("$wfd closed.");
560 next unless (defined(@
$readyr)); # Wait some more.
562 for my $rfd (@
$readyr) {
563 $readwrote_stuff_this_time = 1;
565 trace
("reading from $rfd done.");
570 trace
("reading from $rfd.");
571 if ($rfd == $stdoutfd) {
573 trace2
("stdout is now $stdout\n================");
576 if (defined $statusfd && $rfd == $statusfd) {
578 trace2
("status is now $status\n================");
581 if ($rfd == $stderrfd) {
583 trace2
("stderr is now $stderr\n================");
588 trace
("readwrite_gpg done.");
589 return ($stdout, $stderr, $status);
593 my ($question, $default, $forceyes, $forceno) = @_;
595 my $yn = $default ?
'[Y/n]' : '[y/N]';
597 print $question,' ',$yn, ' ';
598 if ($forceyes && $forceno) {
599 print "$default (from config/command line)\n";
603 print "YES (from config/command line)\n";
607 print "NO (from config/command line)\n";
612 if (!defined $answer) {
613 $OUTPUT_AUTOFLUSH = 1;
615 "End of STDIN reached. Are you using xargs? Caff wants to read from STDIN,\n".
616 "so you can't really use it with xargs. A patch against caff to read from\n".
617 "the terminal would be appreciated.\n".
618 "For now instead of cat keys | xargs caff do caff `cat keys`\n";
621 last if ((length $answer == 0) || ($answer =~ m/^[yYnN]$/) );
622 print "What about $yn is so hard to understand?\nAnswer with either 'n' or 'y' or just press enter for the default.\n";
625 my $result = $default;
626 $result = 1 if $answer =~ /y/i;
627 $result = 0 if $answer =~ /n/i;
635 my $KEYEDIT_PROMPT = '^\[GNUPG:\] GET_LINE keyedit.prompt';
636 my $KEYEDIT_DELUID_PROMPT = '^\[GNUPG:\] GET_BOOL keyedit.remove.uid.okay';
637 my $KEYEDIT_DELSIG_PROMPT = '^\[GNUPG:\] GET_BOOL keyedit.delsig';
638 my $KEYEDIT_KEYEDIT_OR_DELSIG_PROMPT = '^\[GNUPG:\] (GET_BOOL keyedit.delsig|GET_LINE keyedit.prompt)';
639 my $KEYEDIT_DELSUBKEY_PROMPT = '^\[GNUPG:\] GET_BOOL keyedit.remove.subkey';
642 my $USER_AGENT = "caff $VERSION - http://pgp-tools.alioth.debian.org/";
644 my $KEYSBASE = $CONFIG{'caffhome'}.'/keys';
645 my $GNUPGHOME = $CONFIG{'caffhome'}.'/gnupghome';
647 -d
$KEYSBASE || mkpath
($KEYSBASE , 0, 0700) or die ("Cannot create $KEYSBASE: $!\n");
648 -d
$GNUPGHOME || mkpath
($GNUPGHOME, 0, 0700) or die ("Cannot create $GNUPGHOME: $!\n");
651 my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime($NOW);
652 my $DATE_STRING = sprintf("%04d-%02d-%02d", $year+1900, $mon+1, $mday);
657 print $fd "caff $VERSION - (c) 2004, 2005, 2006 Peter Palfrader et al.\n";
661 my ($fd, $exitcode) = @_;
663 print $fd "Usage: $PROGRAM_NAME [-eEmMRS] [-u <yourkeyid>] <keyid> [<keyid> ...]\n";
664 print $fd "Consult the manual page for more information.\n";
669 # export key $keyid from $gnupghome
672 my ($gnupghome, $keyid) = @_;
674 my $gpg = GnuPG
::Interface
->new();
675 $gpg->call( $CONFIG{'gpg'} );
676 if (defined $gnupghome) {
677 $gpg->options->hash_init(
678 'homedir' => $gnupghome,
679 'extra_args' => [ qw{ --no-auto
-check
-trustdb
--trust
-model
=always
} ],
682 $gpg->options->hash_init(
683 'extra_args' => [ qw{ --no-auto
-check
-trustdb
--trust
-model
=always
} ],
686 $gpg->options->meta_interactive( 0 );
687 my ($inputfd, $stdoutfd, $stderrfd, $statusfd, $handles) = make_gpg_fds
();
688 my $pid = $gpg->export_keys(handles
=> $handles, command_args
=> [ $keyid ]);
689 my ($stdout, $stderr, $status) = readwrite_gpg
('', $inputfd, $stdoutfd, $stderrfd, $statusfd);
696 # import a key from the scalar $asciikey into a gpg homedirectory in $tempdir
699 my ($gnupghome, $asciikey) = @_;
701 my $gpg = GnuPG
::Interface
->new();
702 $gpg->call( $CONFIG{'gpg'} );
703 $gpg->options->hash_init(
704 'homedir' => $gnupghome,
705 'extra_args' => [ qw{ --no-auto
-check
-trustdb
--trust
-model
=always
} ] );
706 $gpg->options->meta_interactive( 0 );
707 my ($inputfd, $stdoutfd, $stderrfd, $statusfd, $handles) = make_gpg_fds
();
708 my $pid = $gpg->import_keys(handles
=> $handles);
709 my ($stdout, $stderr, $status) = readwrite_gpg
($asciikey, $inputfd, $stdoutfd, $stderrfd, $statusfd);
712 if ($status !~ /^\[GNUPG:\] IMPORT_OK/m) {
720 # Send an email to $address. If $can_encrypt is true then the mail
721 # will be PGP/MIME encrypted to $longkeyid.
723 # $longkeyid, $uid, and @attached will be used in the email and the template.
725 #send_mail($address, $can_encrypt, $longkeyid, $uid, @attached);
726 sub send_mail
($$$@
) {
727 my ($address, $can_encrypt, $key_id, @keys) = @_;
729 my $template = Text
::Template
->new(TYPE
=> 'STRING', SOURCE
=> $CONFIG{'mail-template'})
730 or die "Error creating template: $Text::Template::ERROR";
733 for my $key (@keys) {
734 push @uids, $key->{'text'};
736 my $message = $template->fill_in(HASH
=> { key
=> $key_id,
738 owner
=> $CONFIG{'owner'}})
739 or die "Error filling template in: $Text::Template::ERROR";
741 my $message_entity = MIME
::Entity
->build(
742 Type
=> "text/plain",
744 Disposition
=> 'inline',
748 for my $key (@keys) {
749 $message_entity->attach(
750 Type
=> "application/pgp-keys",
751 Disposition
=> 'attachment',
753 Description
=> "PGP Key 0x$key_id, uid ".($key->{'text'}).' ('.($key->{'serial'}).'), signed by 0x'.$CONFIG{'keyid'}[0],
754 Data
=> $key->{'key'},
755 Filename
=> "0x$key_id.".$key->{'serial'}.".signed-by-0x".$CONFIG{'keyid'}[0].".asc");
759 my $message = $message_entity->stringify();
761 my $gpg = GnuPG
::Interface
->new();
762 $gpg->call( $CONFIG{'gpg'} );
763 $gpg->options->hash_init( 'homedir' => $GNUPGHOME,
764 'extra_args' => [ qw{ --no-auto
-check
-trustdb
--trust
-model
=always
} ],
766 $gpg->options->meta_interactive( 0 );
767 my ($inputfd, $stdoutfd, $stderrfd, $statusfd, $handles) = make_gpg_fds
();
768 $gpg->options->push_recipients( $key_id );
769 $gpg->options->push_recipients( $CONFIG{'also-encrypt-to'} ) if defined $CONFIG{'also-encrypt-to'};
770 my $pid = $gpg->encrypt(handles
=> $handles);
771 my ($stdout, $stderr, $status) = readwrite_gpg
($message, $inputfd, $stdoutfd, $stderrfd, $statusfd);
774 warn ("No data from gpg for list-key $key_id\n");
779 $message_entity = MIME
::Entity
->build(
780 Type
=> 'multipart/encrypted; protocol="application/pgp-encrypted"',
783 $message_entity->attach(
784 Type
=> "application/pgp-encrypted",
785 Disposition
=> 'attachment',
787 Data
=> "Version: 1\n");
789 $message_entity->attach(
790 Type
=> "application/octet-stream",
791 Filename
=> 'msg.asc',
792 Disposition
=> 'inline',
797 $message_entity->head->add("Subject", "Your signed PGP key 0x$key_id");
798 $message_entity->head->add("To", $address);
799 $message_entity->head->add("From", '"'.$CONFIG{'owner'}.'" <'.$CONFIG{'email'}.'>');
800 $message_entity->head->add("Reply-To", $CONFIG{'reply-to'}) if defined $CONFIG{'reply-to'};
801 $message_entity->head->add("Bcc", $CONFIG{'bcc'}) if defined $CONFIG{'bcc'};
802 $message_entity->head->add("User-Agent", $USER_AGENT);
803 mywarn
("You have set arguments to pass to Mail::Mailer. Better fix your MTA. (Also, Mail::Mailer's error reporting is non existant, so it won't tell you when it doesn't work.)") if (scalar @
{$CONFIG{'mailer-send'}} > 0);
804 $message_entity->send(@
{$CONFIG{'mailer-send'}});
805 $message_entity->stringify();
809 # clean up a UID so that it can be used on the FS.
811 sub sanitize_uid
($) {
815 $good_uid =~ tr
#/:\\#_#;
816 trace2
("[sanitize_uid] changed UID from $uid to $good_uid.\n") if $good_uid ne $uid;
820 sub delete_signatures
($$$$$$) {
821 my ($inputfd, $stdoutfd, $stderrfd, $statusfd, $longkeyid, $keyids) =@_;
823 my $signed_by_me = 0;
825 my ($stdout, $stderr, $status) =
826 readwrite_gpg
("delsig\n", $inputfd, $stdoutfd, $stderrfd, $statusfd, exitwhenstatusmatches
=> $KEYEDIT_DELSIG_PROMPT, nocloseinput
=> 1);
828 while($status =~ /$KEYEDIT_DELSIG_PROMPT/m) {
829 # sig:?::17:EA2199412477CAF8:1058095214:::::13x:
830 my @sigline = grep { /^sig/ } (split /\n/, $stdout);
831 $stdout =~ s/\n/\\n/g;
832 notice
("[sigremoval] why are there ".(scalar @sigline)." siglines in that part of the dialog!? got: $stdout") if scalar @sigline >= 2; # XXX
833 my $line = pop @sigline;
835 if (defined $line) { # only if we found a sig here - we never remove revocation packets for instance
836 debug
("[sigremoval] doing line $line.");
837 my (undef, undef, undef, undef, $signer, $created, undef, undef, undef) = split /:/, $line;
838 if ($signer eq $longkeyid) {
839 debug
("[sigremoval] selfsig ($signer).");
841 } elsif (grep { $signer eq $_ } @
{$keyids}) {
842 debug
("[sigremoval] signed by us ($signer).");
844 $signed_by_me = $signed_by_me > $created ?
$signed_by_me : $created;
846 debug
("[sigremoval] not interested in that sig ($signer).");
850 debug
("[sigremoval] no sig line here, only got: ".$stdout);
852 ($stdout, $stderr, $status) =
853 readwrite_gpg
($answer."\n", $inputfd, $stdoutfd, $stderrfd, $statusfd, exitwhenstatusmatches
=> $KEYEDIT_KEYEDIT_OR_DELSIG_PROMPT, nocloseinput
=> 1);
856 return $signed_by_me;
865 Getopt
::Long
::config
('bundling');
867 '-h' => \
$params->{'help'},
868 '--help' => \
$params->{'help'},
869 '--version' => \
$params->{'version'},
870 '-V' => \
$params->{'version'},
871 '-u=s' => \
$params->{'local-user'},
872 '--local-user=s' => \
$params->{'local-user'},
873 '-e' => \
$params->{'export-old'},
874 '--export-old' => \
$params->{'export-old'},
875 '-E' => \
$params->{'no-export-old'},
876 '--no-export-old' => \
$params->{'no-export-old'},
877 '-m' => \
$params->{'mail'},
878 '--mail' => \
$params->{'mail'},
879 '-M' => \
$params->{'no-mail'},
880 '--no-mail' => \
$params->{'no-mail'},
881 '-R' => \
$params->{'no-download'},
882 '--no-download' => \
$params->{'no-download'},
883 '-S' => \
$params->{'no-sign'},
884 '--no-sign' => \
$params->{'no-sign'},
885 '--key-file=s@' => \
$params->{'key-files'},
889 if ($params->{'help'}) {
892 if ($params->{'version'}) {
896 usage
(\
*STDERR
, 1) unless scalar @ARGV >= 1;
898 $CONFIG{'local-user'} = $params->{'local-user'} if defined $params->{'local-user'};
899 $CONFIG{'no-download'} = $params->{'no-download'} if defined $params->{'no-download'};
900 $CONFIG{'no-mail'} = $params->{'no-mail'} if defined $params->{'no-mail'};
901 $CONFIG{'mail'} = $params->{'mail'} if defined $params->{'mail'};
902 $CONFIG{'no-sign'} = $params->{'no-sign'} if defined $params->{'no-sign'};
903 push @
{$CONFIG{'key-files'}}, @
{$params->{'key-files'}} if defined $params->{'key-files'};
905 if ($CONFIG{'local-user'}) {
906 $USER = $CONFIG{'local-user'};
908 unless ($USER =~ /^([A-F0-9]{8}|[A-F0-9]{16}|[A-F0-9]{40})$/i) {
909 print STDERR
"Local-user $USER is not a keyid.\n";
915 for my $keyid (@ARGV) {
917 unless ($keyid =~ /^([A-F0-9]{8}|[A-F0-9]{16}||[A-F0-9]{40})$/i) {
918 if ($keyid =~ /^[A-F0-9]{32}$/) {
919 info
("Ignoring v3 fingerprint $keyid. v3 keys are obsolete.");
922 print STDERR
"$keyid is not a keyid.\n";
925 push @KEYIDS, uc($keyid);
931 for my $keyid (@
{$CONFIG{'keyid'}}) {
932 my $gpg = GnuPG
::Interface
->new();
933 $gpg->call( $CONFIG{'gpg'} );
934 $gpg->options->hash_init(
935 'homedir' => $GNUPGHOME,
936 'extra_args' => [ qw{ --no-auto
-check
-trustdb
--trust
-model
=always
--with
-colons
--fixed
-list
-mode
--fast
-list
-mode
} ] );
937 $gpg->options->meta_interactive( 0 );
938 my ($inputfd, $stdoutfd, $stderrfd, $statusfd, $handles) = make_gpg_fds
();
939 my $pid = $gpg->list_public_keys(handles
=> $handles, command_args
=> $keyid);
940 my ($stdout, $stderr, $status) = readwrite_gpg
('', $inputfd, $stdoutfd, $stderrfd, $statusfd);
944 warn ("No data from gpg for list-key\n"); # There should be at least 'tru:' everywhere.
946 unless ($stdout =~ /^pub:(?:[^:]*:){3,3}$keyid:/m) {
947 info
("Key $keyid not found in caff's home. Getting it from your normal GnuPGHome.");
948 my $key = export_key
(undef, $keyid);
949 if (!defined $key || $key eq '') {
950 warn ("Did not get key $keyid from your normal GnuPGHome\n");
953 my $result = import_key
($GNUPGHOME, $key);
955 warn ("Could not import $keyid into caff's gnupghome.\n");
961 ########################
962 # import keys from files
963 ########################
964 foreach my $keyfile (@
{$CONFIG{'key-files'}}) {
965 my $gpg = GnuPG
::Interface
->new();
966 $gpg->call( $CONFIG{'gpg'} );
967 $gpg->options->hash_init('homedir' => $GNUPGHOME);
968 $gpg->options->meta_interactive( 0 );
969 my ($inputfd, $stdoutfd, $stderrfd, $statusfd, $handles) = make_gpg_fds
();
970 my $pid = $gpg->import_keys(handles
=> $handles, command_args
=> $keyfile);
971 my ($stdout, $stderr, $status) = readwrite_gpg
('', $inputfd, $stdoutfd, $stderrfd, $statusfd);
972 info
("Importing keys from $keyfile");
974 if ($status !~ /^\[GNUPG:\] IMPORT_OK/m) {
979 #############################
980 # receive keys from keyserver
981 #############################
983 if ($CONFIG{'no-download'}) {
984 @keyids_ok = @KEYIDS;
986 info
("fetching keys, this will take a while...");
988 my $gpg = GnuPG
::Interface
->new();
989 $gpg->call( $CONFIG{'gpg'} );
990 $gpg->options->hash_init(
991 'homedir' => $GNUPGHOME,
992 'extra_args' => [ qw{ --no-auto
-check
-trustdb
--trust
-model
=always
}, '--keyserver='.$CONFIG{'keyserver'} ] );
993 $gpg->options->meta_interactive( 0 );
994 my ($inputfd, $stdoutfd, $stderrfd, $statusfd, $handles) = make_gpg_fds
();
995 my $pid = $gpg->recv_keys(handles
=> $handles, command_args
=> [ @KEYIDS ]);
996 my ($stdout, $stderr, $status) = readwrite_gpg
('', $inputfd, $stdoutfd, $stderrfd, $statusfd);
999 # [GNUPG:] IMPORT_OK 0 5B00C96D5D54AEE1206BAF84DE7AAF6E94C09C7F
1002 # [GNUPG:] IMPORT_OK 0 25FC1614B8F87B52FF2F99B962AF4031C82E0039
1003 my %local_keyids = map { $_ => 1 } @KEYIDS;
1004 my $had_v3_keys = 0;
1005 for my $line (split /\n/, $status) {
1006 if ($line =~ /^\[GNUPG:\] IMPORT_OK \d+ ([0-9A-F]{40})/) {
1007 my $imported_key = $1;
1008 my $whole_fpr = $imported_key;
1009 my $long_keyid = substr($imported_key, -16);
1010 my $short_keyid = substr($imported_key, -8);
1012 for my $spec (($whole_fpr, $long_keyid, $short_keyid)) {
1013 $speced_key = $spec if $local_keyids{$spec};
1015 unless ($speced_key) {
1016 notice
("Imported unexpected key; got: $imported_key\n");
1019 debug
("Imported $imported_key for $speced_key");
1020 delete $local_keyids{$speced_key};
1021 unshift @keyids_ok, $imported_key;
1022 } elsif ($line =~ /^\[GNUPG:\] (NODATA|IMPORT_RES|IMPORTED) /) {
1023 } elsif ($line =~ /^\[GNUPG:\] IMPORT_OK \d+ ([0-9A-F]{32})/) {
1024 my $imported_key = $1;
1025 notice
("Imported key $1 is a version 3 key. Version 3 keys are obsolete, should not be used, and are not and will not be properly supported.");
1028 notice
("got unknown reply from gpg: $line");
1031 if (scalar %local_keyids) {
1032 notice
("Import failed for: ". (join ' ', keys %local_keyids)."." . ($had_v3_keys ?
" (Or maybe it's one of those ugly v3 keys?)" : ""));
1033 exit 1 unless ask
("Some keys could not be imported - continue anyway?", 0);
1034 if (scalar %local_keyids == 1) {
1035 mywarn
("Assuming ". (join ' ', keys %local_keyids)." is a fine keyid.");
1037 mywarn
("Assuming ". (join ' ', keys %local_keyids)." are fine keyids.");
1039 push @keyids_ok, keys %local_keyids;
1043 unless (@keyids_ok) {
1044 notice
("No keys to sign found");
1051 if ($CONFIG{'ask-sign'} && ! $CONFIG{'no-sign'}) {
1052 $CONFIG{'no-sign'} = ! ask
("Continue with signing?", 1);
1055 unless ($CONFIG{'no-sign'}) {
1056 info
("Sign the following keys according to your policy, then exit gpg with 'save' after signing each key");
1057 for my $keyid (@keyids_ok) {
1059 push @command, $CONFIG{'gpg-sign'};
1060 push @command, '--local-user', $USER if (defined $USER);
1061 push @command, "--homedir=$GNUPGHOME";
1062 push @command, '--secret-keyring', $CONFIG{'secret-keyring'};
1063 push @command, '--no-auto-check-trustdb';
1064 push @command, '--trust-model=always';
1065 push @command, '--edit', $keyid;
1066 push @command, 'sign';
1067 push @command, split ' ', $CONFIG{'gpg-sign-args'} || "";
1068 print join(' ', @command),"\n";
1077 for my $keyid (@keyids_ok) {
1080 my $gpg = GnuPG
::Interface
->new();
1081 $gpg->call( $CONFIG{'gpg'} );
1082 $gpg->options->hash_init(
1083 'homedir' => $GNUPGHOME,
1084 'extra_args' => [ qw{ --no-auto
-check
-trustdb
--trust
-model
=always
--with
-colons
--fixed
-list
-mode
} ] );
1085 $gpg->options->meta_interactive( 0 );
1086 my ($inputfd, $stdoutfd, $stderrfd, $statusfd, $handles) = make_gpg_fds
();
1087 my $pid = $gpg->list_public_keys(handles
=> $handles, command_args
=> [ $keyid ]);
1088 my ($stdout, $stderr, $status) = readwrite_gpg
('', $inputfd, $stdoutfd, $stderrfd, $statusfd);
1090 if ($stdout eq '') {
1091 warn ("No data from gpg for list-key $keyid\n");
1094 my @publine = grep { /^pub/ } (split /\n/, $stdout);
1095 if (scalar @publine == 0) {
1096 warn ("No public keys found with list-key $keyid (note that caff uses its own keyring in $GNUPGHOME).\n");
1099 my (undef, undef, undef, undef, $longkeyid, undef, undef, undef, undef, undef, undef, $flags) = split /:/, pop @publine;
1100 if (scalar @publine > 0) {
1101 warn ("More than one key matched $keyid. Try to specify the long keyid or fingerprint\n");
1104 unless (defined $longkeyid) {
1105 warn ("Didn't find public keyid in --list-key of key $keyid.\n");
1108 unless (defined $flags) {
1109 warn ("Didn't find flags in --list-key of key $keyid.\n");
1112 my $can_encrypt = $flags =~ /E/;
1116 my $asciikey = export_key
($GNUPGHOME, $keyid);
1117 if ($asciikey eq '') {
1118 warn ("No data from gpg for export $keyid\n");
1125 my $this_uid_text = '';
1127 debug
("Doing key $keyid, uid $uid_number");
1128 my $tempdir = tempdir
( "caff-$keyid-XXXXX", DIR
=> '/tmp/', CLEANUP
=> 1);
1130 # import into temporary gpghome
1131 ###############################
1132 my $result = import_key
($tempdir, $asciikey);
1134 warn ("Could not import $keyid into temporary gnupg.\n");
1140 $gpg = GnuPG
::Interface
->new();
1141 $gpg->call( $CONFIG{'gpg-delsig'} );
1142 $gpg->options->hash_init(
1143 'homedir' => $tempdir,
1144 'extra_args' => [ qw{ --no-auto
-check
-trustdb
--trust
-model
=always
--with
-colons
--fixed
-list
-mode
--command
-fd
=0 --no-tty
} ] );
1145 ($inputfd, $stdoutfd, $stderrfd, $statusfd, $handles) = make_gpg_fds
();
1146 $pid = $gpg->wrap_call(
1147 commands
=> [ '--edit' ],
1148 command_args
=> [ $keyid ],
1149 handles
=> $handles );
1151 debug
("Starting edit session");
1152 ($stdout, $stderr, $status) = readwrite_gpg
('', $inputfd, $stdoutfd, $stderrfd, $statusfd, exitwhenstatusmatches
=> $KEYEDIT_PROMPT, nocloseinput
=> 1);
1156 my $number_of_subkeys = 0;
1160 my $delete_some = 0;
1161 debug
("Parsing stdout output.");
1162 for my $line (split /\n/, $stdout) {
1163 debug
("Checking line $line");
1164 my ($type, undef, undef, undef, undef, undef, undef, undef, undef, $uidtext) = split /:/, $line;
1165 if ($type eq 'sub') {
1166 $number_of_subkeys++;
1168 next unless ($type eq 'uid' || $type eq 'uat');
1169 debug
("line is interesting.");
1170 if ($uid_number != $i) {
1171 debug
("mark for deletion.");
1172 readwrite_gpg
("$i\n", $inputfd, $stdoutfd, $stderrfd, $statusfd, exitwhenstatusmatches
=> $KEYEDIT_PROMPT, nocloseinput
=> 1);
1177 $this_uid_text = ($type eq 'uid') ?
$uidtext : '[attribute]';
1178 $is_uat = $type eq 'uat';
1182 debug
("Parsing stdout output done.");
1183 unless ($have_one) {
1184 debug
("Uid ".($uid_number-1)." was the last, there is no $uid_number.");
1185 info
("key $keyid done.");
1189 my $prune_some_sigs_on_uid;
1190 my $prune_all_sigs_on_uid;
1192 debug
("handling attribute userid of key $keyid.");
1193 if ($uid_number == 1) {
1194 debug
(" attribute userid is #1, unmarking #2 for deletion.");
1195 readwrite_gpg
("2\n", $inputfd, $stdoutfd, $stderrfd, $statusfd, exitwhenstatusmatches
=> $KEYEDIT_PROMPT, nocloseinput
=> 1);
1197 $prune_some_sigs_on_uid = 1;
1198 $prune_all_sigs_on_uid = 2;
1200 debug
("attribute userid is not #1, unmarking #1 for deletion.");
1201 readwrite_gpg
("1\n", $inputfd, $stdoutfd, $stderrfd, $statusfd, exitwhenstatusmatches
=> $KEYEDIT_PROMPT, nocloseinput
=> 1);
1203 $prune_some_sigs_on_uid = 2;
1204 $prune_all_sigs_on_uid = 1;
1207 $prune_some_sigs_on_uid = 1;
1211 debug
("need to delete $delete_some uids.");
1212 readwrite_gpg
("deluid\n", $inputfd, $stdoutfd, $stderrfd, $statusfd, exitwhenstatusmatches
=> $KEYEDIT_DELUID_PROMPT, nocloseinput
=> 1);
1213 readwrite_gpg
("yes\n", $inputfd, $stdoutfd, $stderrfd, $statusfd, exitwhenstatusmatches
=> $KEYEDIT_PROMPT, nocloseinput
=> 1);
1218 if ($number_of_subkeys > 0) {
1219 for (my $i=1; $i<=$number_of_subkeys; $i++) {
1220 readwrite_gpg
("key $i\n", $inputfd, $stdoutfd, $stderrfd, $statusfd, exitwhenstatusmatches
=> $KEYEDIT_PROMPT, nocloseinput
=> 1);
1222 readwrite_gpg
("delkey\n", $inputfd, $stdoutfd, $stderrfd, $statusfd, exitwhenstatusmatches
=> $KEYEDIT_DELSUBKEY_PROMPT, nocloseinput
=> 1);
1223 readwrite_gpg
("yes\n", $inputfd, $stdoutfd, $stderrfd, $statusfd, exitwhenstatusmatches
=> $KEYEDIT_PROMPT, nocloseinput
=> 1);
1228 readwrite_gpg
("$prune_some_sigs_on_uid\n", $inputfd, $stdoutfd, $stderrfd, $statusfd, exitwhenstatusmatches
=> $KEYEDIT_PROMPT, nocloseinput
=> 1); # mark uid for delsig
1229 my $signed_by_me = delete_signatures
($inputfd, $stdoutfd, $stderrfd, $statusfd, $longkeyid, $CONFIG{'keyid'});
1230 readwrite_gpg
("$prune_some_sigs_on_uid\n", $inputfd, $stdoutfd, $stderrfd, $statusfd, exitwhenstatusmatches
=> $KEYEDIT_PROMPT, nocloseinput
=> 1); # unmark uid from delsig
1231 if (defined $prune_all_sigs_on_uid) {
1232 readwrite_gpg
("$prune_all_sigs_on_uid\n", $inputfd, $stdoutfd, $stderrfd, $statusfd, exitwhenstatusmatches
=> $KEYEDIT_PROMPT, nocloseinput
=> 1); # mark uid for delsig
1233 delete_signatures
($inputfd, $stdoutfd, $stderrfd, $statusfd, $longkeyid, []);
1234 readwrite_gpg
("$prune_all_sigs_on_uid\n", $inputfd, $stdoutfd, $stderrfd, $statusfd, exitwhenstatusmatches
=> $KEYEDIT_PROMPT, nocloseinput
=> 1); # unmark uid from delsig
1238 readwrite_gpg
("save\n", $inputfd, $stdoutfd, $stderrfd, $statusfd);
1241 my $asciikey = export_key
($tempdir, $keyid);
1242 if ($asciikey eq '') {
1243 warn ("No data from gpg for export $keyid\n");
1247 if ($signed_by_me) {
1248 if ($NOW - $signed_by_me > $CONFIG{'export-sig-age'} ) {
1249 my $write = ask
("Signature on $this_uid_text is old. Export?", 0, $params->{'export-old'}, $params->{'no-export-old'});
1252 my $keydir = "$KEYSBASE/$DATE_STRING";
1253 -d
$keydir || mkpath
($keydir , 0, 0700) or die ("Cannot create $keydir $!\n");
1255 my $keyfile = "$keydir/$longkeyid.key.$uid_number.".sanitize_uid
($this_uid_text).".asc";
1256 open (KEY
, ">$keyfile") or die ("Cannot open $keyfile: $!\n");
1257 print KEY
$asciikey;
1260 push @UIDS, { text
=> $this_uid_text, key
=> $asciikey, serial
=> $uid_number, "is_uat" => $is_uat };
1262 info
("$longkeyid $uid_number $this_uid_text done.");
1264 info
("$longkeyid $uid_number $this_uid_text is not signed by me, not writing.");
1268 if (scalar @UIDS == 0) {
1269 info
("found no signed uids for $keyid");
1271 next if $CONFIG{'no-mail'}; # do not send mail
1274 for my $uid (@UIDS) {
1275 trace
("UID: $uid->{'text'}\n");
1276 if ($uid->{'is_uat'}) {
1277 my $attach = ask
("UID $uid->{'text'} is an attribute UID, attach it to every email sent?", 1);
1278 push @attached, $uid if $attach;
1279 } elsif ($uid->{'text'} !~ /@/) {
1280 my $attach = ask
("UID $uid->{'text'} is no email address, attach it to every email sent?", 1);
1281 push @attached, $uid if $attach;
1285 notice
("Key has no encryption capabilities, mail will be sent unencrypted") unless $can_encrypt;
1286 for my $uid (@UIDS) {
1287 if (!$uid->{'is_uat'} && ($uid->{'text'} =~ /@/)) {
1288 my $address = $uid->{'text'};
1289 $address =~ s/.*<(.*)>.*/$1/;
1290 if (ask
("Mail signature for $uid->{'text'} to '$address'?", 1, $CONFIG{'mail'})) {
1291 my $mail = send_mail
($address, $can_encrypt, $longkeyid, $uid, @attached);
1293 my $keydir = "$KEYSBASE/$DATE_STRING";
1294 my $mailfile = "$keydir/$longkeyid.mail.".$uid->{'serial'}.".".sanitize_uid
($uid->{'text'});
1295 open (KEY
, ">$mailfile") or die ("Cannot open $mailfile: $!\n");