caff: support using a SMTP-server to send out the mails instead
[pgp-tools.git] / caff / caff
index 35be431932aa20e283b390fb3599820552896a9b..bb687a289b97768ce8aa38bc0d385bb0b4c19ab3 100755 (executable)
--- a/caff/caff
+++ b/caff/caff
@@ -50,7 +50,8 @@ CA Fire and Forget is a script that helps you in keysigning.  It takes a list
 of keyids on the command line, fetches them from a keyserver and calls GnuPG so
 that you can sign it.  It then mails each key to all its email addresses - only
 including the one UID that we send to in each mail, pruned from all but self
-sigs and sigs done by you.
+sigs and sigs done by you.  The mailed key is encrypted with itself as a means
+to verify that key belongs to the recipient.
 
 =head1 OPTIONS
 
@@ -97,11 +98,20 @@ Import keys from file. Can be supplied more than once.
 
 =item $HOME/.caffrc  -  configuration file
 
+=item $HOME/.caff/keys/yyyy-mm-dd/  -  processed keys
+
+=item $HOME/.caff/gnupghome/  -  caff's working dir for gpg
+
+=item $HOME/.caff/gnupghome/gpg.conf  -  gpg configuration
+
+useful options include use-agent, default-cert-level, etc.
+
 =back
 
 =head1 CONFIGURATION FILE OPTIONS
 
 The configuration file is a perl script that sets values in the hash B<%CONFIG>.
+The file is generated when it does not exist.
 
 Example:
 
@@ -226,11 +236,24 @@ The UIDs for which signatures are included in the mail.
 
 =back
 
+=item B<reply-to> [string]
+
+Add a Reply-To: header to messages sent. Default: none.
+
 =item B<bcc> [string]
 
 Address to send blind carbon copies to when sending mail.
 Default: none.
 
+=item B<smtp-server> [string]
+
+Send mail through specified SMTP server. Default: none (uses
+sendmail).
+
+=item B<smtp-port> [string]
+
+Use specified port for sending mail to SMTP server. Default : 25.
+
 =back
 
 =head1 AUTHORS
@@ -247,6 +270,10 @@ Default: none.
 
 http://pgp-tools.alioth.debian.org/
 
+=head1 SEE ALSO
+
+gpg(1), pgp-clean(1), /usr/share/doc/signing-party/caff/caffrc.sample.
+
 =cut
 
 use strict;
@@ -266,73 +293,134 @@ my $REVISION = '$Rev$';
 my ($REVISION_NUMER) = $REVISION =~ /(\d+)/;
 my $VERSION = "0.0.0.$REVISION_NUMER";
 
-sub generate_config() {
-       die "Error: \$LOGNAME is not set.\n" unless $ENV{LOGNAME};
-       my $gecos = (getpwnam($ENV{LOGNAME}))[6];
-       $gecos =~ s/,.*//;
 
-       my $gpg = GnuPG::Interface->new();
-       $gpg->call( 'gpg' );
-       $gpg->options->hash_init(
-               'extra_args' => [ qw{ --no-auto-check-trustdb --trust-model=always --with-colons --fixed-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 => [ $gecos ]);
-       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.
-       };
+sub notice($) {
+       my ($line) = @_;
+       print "[NOTICE] $line\n";
+};
+sub info($) {
+       my ($line) = @_;
+       print "[INFO] $line\n";
+};
+sub debug($) {
+       my ($line) = @_;
+       #print "[DEBUG] $line\n";
+};
+sub trace($) {
+       my ($line) = @_;
+       #print "[trace] $line\n";
+};
+sub trace2($) {
+       my ($line) = @_;
+       #print "[trace2] $line\n";
+};
+
 
+sub generate_config() {
+       notice("Error: \$LOGNAME is not set.\n") unless defined $ENV{'LOGNAME'};
+       my $gecos = defined $ENV{'LOGNAME'} ? (getpwnam($ENV{LOGNAME}))[6] : undef;
+       my $email;
        my @keys;
-       unless (@keys = ($stdout =~ /^pub:[^r:]*:(?:[^:]*:){2,2}([^:]+):/mg)) {
-               die "Error: No keys were found using \"gpg --list-public-keys '$gecos'\".\n";
-       }
-       unless ($stdout =~ /^uid:.*<(.+@.+)>.*:/m) {
-               die "Error: No email address was found using \"gpg --list-public-keys '$gecos'\".\n";
-       }
-       my $email = $1;
+       my $hostname = `hostname -f`;
+       chomp $hostname;
+       my ($Cgecos,$Cemail,$Ckeys) = ('','','');
+       if (defined $gecos) {
+               $gecos =~ s/,.*//;
+
+               my $gpg = GnuPG::Interface->new();
+               $gpg->call( 'gpg' );
+               $gpg->options->hash_init(
+                       'extra_args' => [ qw{ --no-auto-check-trustdb --trust-model=always --with-colons --fixed-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 => [ $gecos ]);
+               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.
+               };
+
+               @keys = ($stdout =~ /^pub:[^r:]*:(?:[^:]*:){2,2}([^:]+):/mg);
+               unless (scalar @keys) {
+                       info("Error: No keys were found using \"gpg --list-public-keys '$gecos'\".");
+                       @keys = qw{0123456789abcdef 89abcdef76543210};
+                       $Ckeys = '#';
+               }
+               ($email) =  ($stdout =~ /^uid:.*<(.+?@.+?)>.*:/m);
+               unless (defined $email) {
+                       info("Error: No email address was found using \"gpg --list-public-keys '$gecos'\".");
+                       $email = $ENV{'LOGNAME'}.'@'.$hostname;
+                       $Cemail = '#';
+               }
+       } else {
+               $gecos = 'Unknown Caff User';
+               $email = $ENV{'LOGNAME'}.'@'.$hostname;
+               @keys = qw{0123456789abcdef 89abcdef76543210};
+               ($Cgecos,$Cemail,$Ckeys) = ('#','#','#');
+       };
 
        return <<EOT;
 # .caffrc -- vim:syntax=perl:
 # This file is in perl(1) format - see caff(1) for details.
 
-\$CONFIG{'owner'}       = '$gecos';
-\$CONFIG{'email'}       = '$email';
+$Cgecos\$CONFIG{'owner'}       = '$gecos';
+$Cemail\$CONFIG{'email'}       = '$email';
 
 # you can get your long keyid from
 #   gpg --with-colons --list-key <yourkeyid|name|emailaddress..>
 #
 # if you have a v4 key, it will simply be the last 16 digits of
 # your fingerprint.
+#
+# Example:
+#   \$CONFIG{'keyid'}       = [ qw{FEDCBA9876543210} ];
+#  or, if you have more than one key:
+#   \$CONFIG{'keyid'}       = [ qw{0123456789ABCDEF 89ABCDEF76543210} ];
 
-\$CONFIG{'keyid'}       = [ qw{@keys} ];
+$Ckeys\$CONFIG{'keyid'}       = [ qw{@keys} ];
 EOT
 };
 
+sub check_executable($$) {
+       # (GnuPG::Interface gives lousy errors when the gpg binary isn't found,
+       # so we want to check manually.)
+       my ($purpose, $fn) = @_;
+       # Only check provided fnames with a slash in them.
+       return unless defined $fn;
+       if ($fn =~ m!/!) {
+               die ("$PROGRAM_NAME: $purpose executable '$fn' not found.\n") unless -x $fn;
+       } else {
+               for my $p (split(':', $ENV{PATH})) {
+                       return if -x "$p/$fn";
+               };
+               die ("$PROGRAM_NAME: $purpose executable '$fn' not found on path.\n") unless -x $fn;
+       };
+};
+
 sub load_config() {
        my $config = $ENV{'HOME'} . '/.caffrc';
        unless (-f $config) {
                print "No configfile $config present, I will use this template:\n";
                my $template = generate_config();
-               print "$template\nPress enter to continue.";
-               <STDIN>;
+               print "$template\nPlease edit $config and run caff again.\n";
                open F, ">$config" or die "$config: $!";
                print F $template;
                close F;
+               exit(1);
        }
        unless (scalar eval `cat $config`) {
                die "Couldn't parse $config: $EVAL_ERROR\n" if $EVAL_ERROR;
        };
 
        $CONFIG{'caffhome'}=$ENV{'HOME'}.'/.caff' unless defined $CONFIG{'caffhome'};
-       die ("owner is not defined.\n") unless defined $CONFIG{'owner'};
-       die ("email is not defined.\n") unless defined $CONFIG{'email'};
-       die ("keyid is not defined.\n") unless defined $CONFIG{'keyid'};
-       die ("keyid is not an array ref\n") unless (ref $CONFIG{'keyid'} eq 'ARRAY');
+       die ("$PROGRAM_NAME: owner is not defined in $config.\n") unless defined $CONFIG{'owner'};
+       die ("$PROGRAM_NAME: email is not defined in $config.\n") unless defined $CONFIG{'email'};
+       die ("$PROGRAM_NAME: keyid is not defined in $config.\n") unless defined $CONFIG{'keyid'};
+       die ("$PROGRAM_NAME: keyid is not an array ref in $config.\n") unless (ref $CONFIG{'keyid'} eq 'ARRAY');
        for my $keyid (@{$CONFIG{'keyid'}}) {
-               $keyid =~ /^[A-F0-9]{16}$/i or die ("key $keyid is not a long (16 digit) keyid.\n");
+               $keyid =~ /^[A-F0-9]{16}$/i or die ("$PROGRAM_NAME: key $keyid is not a long (16 digit) keyid in $config.\n");
        };
        @{$CONFIG{'keyid'}} = map { uc } @{$CONFIG{'keyid'}};
        $CONFIG{'export-sig-age'}= 24*60*60 unless defined $CONFIG{'export-sig-age'};
@@ -340,6 +428,9 @@ sub load_config() {
        $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'};
+       check_executable("gpg", $CONFIG{'gpg'});
+       check_executable("gpg-sign", $CONFIG{'gpg-sign'});
+       check_executable("gpg-delsig", $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'};
@@ -368,27 +459,6 @@ Regards,
 EOM
 };
 
-sub notice($) {
-       my ($line) = @_;
-       print "[NOTICE] $line\n";
-};
-sub info($) {
-       my ($line) = @_;
-       print "[INFO] $line\n";
-};
-sub debug($) {
-       my ($line) = @_;
-       #print "[DEBUG] $line\n";
-};
-sub trace($) {
-       my ($line) = @_;
-       #print "[trace] $line\n";
-};
-sub trace2($) {
-       my ($line) = @_;
-       #print "[trace2] $line\n";
-};
-
 sub make_gpg_fds() {
        my %fds = (
                stdin => IO::Handle->new(),
@@ -686,7 +756,8 @@ sub send_mail($$$@) {
                $message = $stdout;
 
                $message_entity = MIME::Entity->build(
-                       Type        => 'multipart/encrypted; protocol="application/pgp-encrypted"');
+                       Type        => 'multipart/encrypted; protocol="application/pgp-encrypted"',
+                       Encoding    => '7bit');
 
                $message_entity->attach(
                        Type        => "application/pgp-encrypted",
@@ -705,9 +776,17 @@ sub send_mail($$$@) {
        $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("Reply-To", $CONFIG{'reply-to'}) if defined $CONFIG{'reply-to'};
        $message_entity->head->add("Bcc", $CONFIG{'bcc'}) if defined $CONFIG{'bcc'};
        $message_entity->head->add("User-Agent", $USER_AGENT);
-       $message_entity->send();
+
+       if($CONFIG{'smtp-server'}) {
+               $message_entity->smtpsend(Host => $CONFIG{'smtp-server'},
+                       ($CONFIG{'smtp-port'} ? (Port => $CONFIG{'smtp-port'}) : ()),
+                       MailFrom => $CONFIG{'email'});
+       } else {
+               $message_entity->send();
+       }
        $message_entity->stringify();
 };
 
@@ -909,6 +988,7 @@ if ($CONFIG{'no-download'}) {
 # [GNUPG:] NODATA 1
 # [GNUPG:] IMPORT_OK 0 25FC1614B8F87B52FF2F99B962AF4031C82E0039
        my %local_keyids = map { $_ => 1 } @KEYIDS;
+       my $had_v3_keys = 0;
        for my $line (split /\n/, $status) {
                if ($line =~ /^\[GNUPG:\] IMPORT_OK \d+ ([0-9A-F]{40})/) {
                        my $imported_key = $1;
@@ -927,12 +1007,16 @@ if ($CONFIG{'no-download'}) {
                        delete $local_keyids{$speced_key};
                        unshift @keyids_ok, $imported_key;
                } elsif ($line =~ /^\[GNUPG:\] (NODATA|IMPORT_RES|IMPORTED) /) {
+               } elsif ($line =~ /^\[GNUPG:\] IMPORT_OK \d+ ([0-9A-F]{32})/) {
+                       my $imported_key = $1;
+                       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.");
+                       $had_v3_keys = 1;
                } else {
                        notice ("got unknown reply from gpg: $line");
                }
        };
        if (scalar %local_keyids) {
-               notice ("Import failed for: ". (join ' ', keys %local_keyids).".");
+               notice ("Import failed for: ". (join ' ', keys %local_keyids)."." . ($had_v3_keys ? " (Or maybe it's one of those ugly v3 keys?)" :  ""));
                exit 1 unless ask ("Some keys could not be imported - continue anyway?", 0);
        }
 };