# caff -- CA - Fire and Forget
# $Id$
#
-# Copyright (c) 2004 Peter Palfrader <peter@palfrader.org>
+# Copyright (c) 2004
, 2005 Peter Palfrader <peter@palfrader.org>
#
# All rights reserved.
#
=over
-=item B<caff> [-u I<yourkeyid>] I<keyid> [I<keyid> ..]
+=item B<caff> [-mMR] [-u I<yourkeyid>] I<keyid> [I<keyid> ..]
=back
=over
+=item B<-m> B<-M>
+
+Send/do not send mail after signing. Default is to ask the user for each uid.
+
+=item B<-R>
+
+Do not retrieve the key to be signed from a keyserver.
+
=item B<-u> I<yourkeyid>
Select the key that is used for signing, in case you have more than one key.
Example:
- $CONFIG{'owner'} = 'Peter Palfrader';
- $CONFIG{'email'} = 'peter@palfrader.org';
+ $CONFIG{owner} = q{Peter Palfrader};
+ $CONFIG{email} = q{peter@palfrader.org};
+ $CONFIG{keyid} = [ qw{DE7AAF6E94C09C7F 62AF4031C82E0039} ];
=head2 Valid keys
Path to the GnuPG binary which is used to sign keys. Default: what
B<gpg> is set to.
-=item B<gpg-sdelsig> [string]
+=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]
Path to your secret keyring. Default: B<$HOME/.gnupg/secring.gpg>.
+=item B<also-encrypt-to> [keyid]
+
+An additional keyid to encrypt messages to. Default: none.
+
+=item B<no-download> [boolean]
+
+If true, then skip the step of fetching keys from the keyserver.
+Default: B<0>.
+
+=item B<no-sign> [boolean]
+
+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
Peter Palfrader <peter@palfrader.org>
+=head1 WEBSITE
+
+http://pgp-tools.alioth.debian.org/
+
=cut
use strict;
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 GnuPG::Interface;
my %CONFIG;
sub load_config() {
my $config = $ENV{'HOME'} . '/.caffrc';
- -f $config or die "No file $config present. See caffrc(5).\n";
+ -f $config or die "No file $config present. See caff(1).\n";
unless (scalar eval `cat $config`) {
die "Couldn't parse $config: $EVAL_ERROR\n" if $EVAL_ERROR;
};
$CONFIG{'gpg-sign'} = $CONFIG{'gpg'} unless defined $CONFIG{'gpg-sign'};
$CONFIG{'gpg-delsig'} = $CONFIG{'gpg'} unless defined $CONFIG{'gpg-delsig'};
$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($) {
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;
my ($stdout, $stderr, $status) = ("", "", "");
my $exitwhenstatusmatches = $options{'exitwhenstatusmatches'};
- trace("doign stuff until we find $exitwhenstatusmatches") if defined $exitwhenstatusmatches;
+ trace("doing stuff until we find $exitwhenstatusmatches") if defined $exitwhenstatusmatches;
+ my $readwrote_stuff_this_time = 0;
+ my $do_not_wait_on_select = 0;
my ($readyr, $readyw, $written);
while ($sout->count() > 0 || (defined($sin) && ($sin->count() > 0))) {
if (defined $exitwhenstatusmatches) {
if ($status =~ /$exitwhenstatusmatches/m) {
trace("readwrite_gpg found match on $exitwhenstatusmatches");
- last;
+ if ($readwrote_stuff_this_time) {
+ trace("read/write some more\n");
+ $do_not_wait_on_select = 1;
+ } else {
+ trace("that's it in our while loop.\n");
+ last;
+ }
};
};
+ $readwrote_stuff_this_time = 0;
trace("select waiting for ".($sout->count())." fds.");
- ($readyr, $readyw, undef) = IO::Select::select($sout, $sin, undef, 1);
+ ($readyr, $readyw, undef) = IO::Select::select($sout, $sin, undef, $do_not_wait_on_select ? 0 : 1);
trace("ready: write: ".(defined $readyw ? scalar @$readyw : 0 )."; read: ".(defined $readyr ? scalar @$readyr : 0));
for my $wfd (@$readyw) {
+ $readwrote_stuff_this_time = 1;
if (length($in) != $offset) {
trace("writing to $wfd.");
$written = $wfd->syswrite($in, length($in) - $offset, $offset);
next unless (defined(@$readyr)); # Wait some more.
for my $rfd (@$readyr) {
+ $readwrote_stuff_this_time = 1;
if ($rfd->eof) {
trace("reading from $rfd done.");
$sout->remove($rfd);
my $KEYEDIT_DELSUBKEY_PROMPT = '^\[GNUPG:\] GET_BOOL keyedit.remove.subkey';
load_config;
-my $USER_AGENT = "caff $VERSION - (c) 2004 Peter Palfrader";
+my $USER_AGENT = "caff $VERSION - (c) 2004, 2005 Peter Palfrader";
my $KEYSBASE = $CONFIG{'caffhome'}.'/keys';
my $GNUPGHOME = $CONFIG{'caffhome'}.'/gnupghome';
sub usage() {
- print STDERR "caff $VERSION - (c) 2004 Peter Palfrader\n";
- print STDERR "Usage: $PROGRAM_NAME [-u <yourkeyid] <keyid> [<keyid> ...]\n";
+ print STDERR "caff $VERSION - (c) 2004, 2005 Peter Palfrader\n";
+ print STDERR "Usage: $PROGRAM_NAME [-mMR] [-u <yourkeyid>] <keyid> [<keyid> ...]\n";
exit 1;
};
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",
$message_entity->head->add("Subject", "Your signed PGP key 0x$key_id");
$message_entity->head->add("To", $address);
- $message_entity->head->add("From", $CONFIG{'owner'}.' <'.$CONFIG{'email'}.'>');
+ $message_entity->head->add("From", '"'.$CONFIG{'owner'}.'" <'.$CONFIG{'email'}.'>');
$message_entity->head->add("User-Agent", $USER_AGENT);
$message_entity->send();
$message_entity->stringify();
sub sanitize_uid($) {
my ($uid) = @_;
- my $good_uid =~ tr#/:\\#_#;
+ my $good_uid = $uid;
+ $good_uid =~ tr#/:\\#_#;
trace2("[sanitize_uid] changed UID from $uid to $good_uid.\n") if $good_uid ne $uid;
return $good_uid;
};
my $USER;
my @KEYIDS;
+my %opt;
+
+getopts('mMRu:', \%opt);
usage() unless scalar @ARGV >= 1;
-if ($ARGV[0] eq '-u') {
- usage() unless scalar @ARGV >= 3;
- shift @ARGV;
- $USER = shift @ARGV;
+if ($opt{u}) {
+ $USER = $opt{u};
+ $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();
$USER = uc($USER);
};
for my $keyid (@ARGV) {
- unless ($keyid =~ /^[A-Za-z0-9]{8}([A-Za-z0-9]{8})?$/) {
+ $keyid =~ s/^0x//i;
+ 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();
};
};
+
+#################
+# import own keys
+#################
+ my $gpg = GnuPG::Interface->new();
+ $gpg->call( $CONFIG{'gpg'} );
+ $gpg->options->hash_init(
+ 'homedir' => $GNUPGHOME,
+ 'extra_args' => '--keyserver='.$CONFIG{'keyserver'} );
+ $gpg->options->meta_interactive( 0 );
+ my ($inputfd, $stdoutfd, $stderrfd, $statusfd, $handles) = make_gpg_fds();
+ $gpg->options->hash_init( 'extra_args' => [ '--with-colons', '--fixed-list-mode' ] );
+ my $pid = $gpg->list_public_keys(handles => $handles, command_args => $CONFIG{'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");
+ next;
+ };
+ foreach my $keyid (@{$CONFIG{'keyid'}}) {
+ unless ($stdout =~ /^pub:(?:[^:]*:){3,3}$keyid:/m) {
+ info("Importing $keyid");
+ system "gpg --export $keyid | gpg --import --homedir $GNUPGHOME";
+ }
+ }
+
#############################
# receive keys from keyserver
#############################
-my $gpg = GnuPG::Interface->new();
-$gpg->call( $CONFIG{'gpg'} );
-$gpg->options->hash_init(
- 'homedir' => $GNUPGHOME,
- 'extra_args' => '--keyserver='.$CONFIG{'keyserver'} );
-$gpg->options->meta_interactive( 0 );
-my ($inputfd, $stdoutfd, $stderrfd, $statusfd, $handles) = make_gpg_fds();
-my $pid = $gpg->recv_keys(handles => $handles, command_args => [ @KEYIDS ]);
-my ($stdout, $stderr, $status) = readwrite_gpg('', $inputfd, $stdoutfd, $stderrfd, $statusfd);
-waitpid $pid, 0;
-
my @keyids_ok;
my @keyids_failed;
+if ($CONFIG{'no-download'} or $opt{R}) {
+ @keyids_ok = @KEYIDS;
+} else {
+ my $gpg = GnuPG::Interface->new();
+ $gpg->call( $CONFIG{'gpg'} );
+ $gpg->options->hash_init(
+ 'homedir' => $GNUPGHOME,
+ 'extra_args' => '--keyserver='.$CONFIG{'keyserver'} );
+ $gpg->options->meta_interactive( 0 );
+ my ($inputfd, $stdoutfd, $stderrfd, $statusfd, $handles) = make_gpg_fds();
+
+ my @local_keyids = @KEYIDS;
+ for my $keyid (@local_keyids) {
+ info ("fetching $keyid...");
+ my $pid = $gpg->recv_keys(handles => $handles, command_args => [ $keyid ]);
+ my ($stdout, $stderr, $status) = readwrite_gpg('', $inputfd, $stdoutfd, $stderrfd, $statusfd);
+ waitpid $pid, 0;
+
# [GNUPG:] IMPORT_OK 0 5B00C96D5D54AEE1206BAF84DE7AAF6E94C09C7F
# [GNUPG:] NODATA 1
# [GNUPG:] NODATA 1
# [GNUPG:] IMPORT_OK 0 25FC1614B8F87B52FF2F99B962AF4031C82E0039
-for my $line (split /\n/, $status) {
- if ($line =~ /^\[GNUPG:\] IMPORT_OK/) {
- push @keyids_ok, shift @KEYIDS;
- } elsif ($line =~ /^\[GNUPG:\] NODATA/) {
- push @keyids_failed, shift @KEYIDS;
+ my $handled = 0;
+ for my $line (split /\n/, $status) {
+ 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, $keyid;
+ shift @KEYIDS;
+ $handled = 1;
+ last;
+ };
+ };
+ unless ($handled) {
+ notice ("Huh, what's up with $keyid?");
+ push @keyids_failed, $keyid;
+ shift @KEYIDS;
+ };
};
-}
-die ("Still keys in \@KEYIDS. This should not happen.") if scalar @KEYIDS;
-notice ("Import failed for: ". (join ' ', @keyids_failed).".") if scalar @keyids_failed;
+ die ("Still keys in \@KEYIDS. This should not happen.") if scalar @KEYIDS;
+ notice ("Import failed for: ". (join ' ', @keyids_failed).".") if scalar @keyids_failed;
+};
###########
# sign keys
###########
-info("Sign the following keys according to your policy...");
-for my $keyid (@keyids_ok) {
- my @command;
- push @command, $CONFIG{'gpg-sign'};
- push @command, '--local-user', $USER if (defined $USER);
- push @command, "--homedir=$GNUPGHOME";
- push @command, '--secret-keyring', $CONFIG{'secret-keyring'};
- push @command, '--sign-key', $keyid;
- print join(' ', @command),"\n";
- system (@command);
+unless ($CONFIG{'no-sign'}) {
+ info("Sign the following keys according to your policy, then exit gpg with 'save' after signing each key");
+ for my $keyid (@keyids_ok) {
+ my @command;
+ push @command, $CONFIG{'gpg-sign'};
+ push @command, '--local-user', $USER if (defined $USER);
+ push @command, "--homedir=$GNUPGHOME";
+ push @command, '--secret-keyring', $CONFIG{'secret-keyring'};
+ push @command, '--edit', $keyid;
+ push @command, 'sign';
+ print join(' ', @command),"\n";
+ system (@command);
+ };
};
##################
for my $keyid (@keyids_ok) {
# get key listing
#################
- $gpg = GnuPG::Interface->new();
+ my $gpg = GnuPG::Interface->new();
$gpg->call( $CONFIG{'gpg'} );
$gpg->options->hash_init( 'homedir' => $GNUPGHOME );
$gpg->options->meta_interactive( 0 );
- ($inputfd, $stdoutfd, $stderrfd, $statusfd, $handles) = make_gpg_fds();
+ my ($inputfd, $stdoutfd, $stderrfd, $statusfd, $handles) = make_gpg_fds();
$gpg->options->hash_init( 'extra_args' => [ '--with-colons', '--fixed-list-mode' ] );
- $pid = $gpg->list_public_keys(handles => $handles, command_args => [ $keyid ]);
- ($stdout, $stderr, $status) = readwrite_gpg('', $inputfd, $stdoutfd, $stderrfd, $statusfd);
+ 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 $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
################
while (1) {
my $this_uid_text = '';
$uid_number++;
- info("Doing key $keyid, uid $uid_number");
+ debug("Doing key $keyid, uid $uid_number");
# import into temporary gpghome
###############################
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++;
};
next;
};
unless ($have_one) {
+ debug("Uid ".($uid_number-1)." was the last, there is no $uid_number.");
info("key $keyid done.");
last;
};
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
- my ($dummy1, $dummy2, $dummy3, $dummy4, $signer, $created, $dummy7, $dummy8, $dummy9) = split /:/, $line;
+ 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 $_ } @{$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);
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;
};
-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;
if (scalar @UIDS == 0) {
info("found no signed uids for $keyid");
} else {
- my @attached ;
+ next if $opt{M}; # do not send mail
+
+ my @attached;
for my $uid (@UIDS) {
trace("UID: $uid->{'text'}\n");
unless ($uid->{'text'} =~ /@/) {
my $attach = ask("UID $uid->{'text'} is no email address, attach it to every email sent?", 1);
- push @attached, $uid;
+ push @attached, $uid if $attach;
};
};
if ($uid->{'text'} =~ /@/) {
my $address = $uid->{'text'};
$address =~ s/.*<(.*)>.*/$1/;
- my $send = ask("Send mail to '$address' for $uid->{'text'}?", 1);
- if ($send) {
+ if ($opt{m} 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;
};
projects / pgp-tools.git / blobdiff