3b582311a3895adfdbd7d47b24266628e88eeed3
[monkeysphere-validation-agent.git] / Crypt / Monkeysphere / MSVA.pm
1 # Monkeysphere Validation Agent, Perl version
2 # Copyright © 2010 Daniel Kahn Gillmor <dkg@fifthhorseman.net>,
3 #                  Jameson Rollins <jrollins@finestructure.net>
4 #
5 # This program is free software: you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation, either version 3 of the License, or
8 # (at your option) any later version.
9 #
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 # GNU General Public License for more details.
14 #
15 # You should have received a copy of the GNU General Public License
16 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
17
18 { package Crypt::Monkeysphere::MSVA;
19
20   use strict;
21   use warnings;
22   use vars qw($VERSION);
23
24   use parent qw(HTTP::Server::Simple::CGI);
25   require Crypt::X509;
26   use Regexp::Common qw /net/;
27   use Convert::ASN1;
28   use MIME::Base64;
29   use IO::Socket;
30   use IO::File;
31   use Socket;
32   use File::Spec;
33   use File::HomeDir;
34   use Config::General;
35   use Crypt::Monkeysphere::MSVA::MarginalUI;
36   use Crypt::Monkeysphere::MSVA::Logger;
37   use Crypt::Monkeysphere::MSVA::Monitor;
38
39   use JSON;
40   use POSIX qw(strftime);
41   # we need the version of GnuPG::Interface that knows about pubkey_data, etc:
42   use GnuPG::Interface 0.42.02;
43
44   $VERSION = '0.8';
45
46   my $gnupg = GnuPG::Interface::->new();
47   $gnupg->options->quiet(1);
48   $gnupg->options->batch(1);
49
50   my %dispatch = (
51                   '/' => { handler => \&noop,
52                            methods => { 'GET' => 1 },
53                          },
54                   '/reviewcert' => { handler => \&reviewcert,
55                                      methods => { 'POST' => 1 },
56                                    },
57                   '/extracerts' => { handler => \&extracerts,
58                                      methods => { 'POST' => 1 },
59                                    },
60                  );
61
62   my $default_keyserver = 'hkp://pool.sks-keyservers.net';
63   my $default_keyserver_policy = 'unlessvalid';
64
65   my $logger = Crypt::Monkeysphere::MSVA::Logger::->new($ENV{MSVA_LOG_LEVEL});
66   sub logger {
67     return $logger;
68   }
69
70   my $rsa_decoder = Convert::ASN1::->new();
71   $rsa_decoder->prepare(q<
72
73    SEQUENCE {
74         modulus INTEGER,
75         exponent INTEGER
76    }
77           >);
78
79   sub net_server {
80     return 'Net::Server::MSVA';
81   };
82
83   sub msvalog {
84     return $logger->log(@_);
85   };
86
87   sub new {
88     my $class = shift;
89
90     my $port = 0;
91     if (exists $ENV{MSVA_PORT} and $ENV{MSVA_PORT} ne '') {
92       msvalog('debug', "MSVA_PORT set to %s\n", $ENV{MSVA_PORT});
93       $port = $ENV{MSVA_PORT} + 0;
94       die sprintf("not a reasonable port %d", $port) if (($port >= 65536) || $port <= 0);
95     }
96     # start the server on requested port
97     my $self = $class->SUPER::new($port);
98     if (! exists $ENV{MSVA_PORT}) {
99       # we can't pass port 0 to the constructor because it evaluates
100       # to false, so HTTP::Server::Simple just uses its internal
101       # default of 8080.  But if we want to select an arbitrary open
102       # port, we *can* set it here.
103       $self->port(0);
104     }
105
106     $self->{allowed_uids} = {};
107     if (exists $ENV{MSVA_ALLOWED_USERS} and $ENV{MSVA_ALLOWED_USERS} ne '') {
108       msvalog('verbose', "MSVA_ALLOWED_USERS environment variable is set.\nLimiting access to specified users.\n");
109       foreach my $user (split(/ +/, $ENV{MSVA_ALLOWED_USERS})) {
110         my ($name, $passwd, $uid);
111         if ($user =~ /^[0-9]+$/) {
112           $uid = $user + 0; # force to integer
113         } else {
114           ($name,$passwd,$uid) = getpwnam($user);
115         }
116         if (defined $uid) {
117           msvalog('verbose', "Allowing access from user ID %d\n", $uid);
118           $self->{allowed_uids}->{$uid} = $user;
119         } else {
120           msvalog('error', "Could not find user '%d'; not allowing\n", $user);
121         }
122       }
123     } else {
124       # default is to allow access only to the current user
125       $self->{allowed_uids}->{POSIX::getuid()} = 'self';
126     }
127
128     bless ($self, $class);
129     return $self;
130   }
131
132   sub noop {
133     my $self = shift;
134     my $cgi = shift;
135     return '200 OK', { available => JSON::true,
136                        protoversion => 1,
137                      };
138   }
139
140   # return an arrayref of processes which we can detect that have the
141   # given socket open (the socket is specified with its inode)
142   sub getpidswithsocketinode {
143     my $sockid = shift;
144
145     if (! defined ($sockid)) {
146       msvalog('verbose', "No client socket ID to check.  The MSVA is probably not running as a service.\n");
147       return [];
148     }
149     # this appears to be how Linux symlinks open sockets in /proc/*/fd,
150     # as of at least 2.6.26:
151     my $socktarget = sprintf('socket:[%d]', $sockid);
152     my @pids;
153
154     my $procfs;
155     if (opendir($procfs, '/proc')) {
156       foreach my $pid (grep { /^\d+$/ } readdir($procfs)) {
157         my $procdir = sprintf('/proc/%d', $pid);
158         if (-d $procdir) {
159           my $procfds;
160           if (opendir($procfds, sprintf('/proc/%d/fd', $pid))) {
161             foreach my $procfd (grep { /^\d+$/ } readdir($procfds)) {
162               my $fd = sprintf('/proc/%d/fd/%d', $pid, $procfd);
163               if (-l $fd) {
164                 #my ($dev,$ino,$mode,$nlink,$uid,$gid) = lstat($fd);
165                 my $targ = readlink($fd);
166                 push @pids, $pid
167                   if ($targ eq $socktarget);
168               }
169             }
170             closedir($procfds);
171           }
172         }
173       }
174       closedir($procfs);
175     }
176
177     # FIXME: this whole business is very linux-specific, i think.  i
178     # wonder how to get this info in other OSes?
179
180     return \@pids;
181   }
182
183   # return {uid => X, inode => Y}, meaning the numeric ID of the peer
184   # on the other end of $socket, "socket inode" identifying the peer's
185   # open network socket.  each value could be undef if unknown.
186   sub get_client_info {
187     my $socket = shift;
188
189     my $sock = IO::Socket::->new_from_fd($socket, 'r');
190     # check SO_PEERCRED -- if this was a TCP socket, Linux
191     # might not be able to support SO_PEERCRED (even on the loopback),
192     # though apparently some kernels (Solaris?) are able to.
193
194     my $clientid;
195     my $remotesocketinode;
196     my $socktype = $sock->sockopt(SO_TYPE) or die "could not get SO_TYPE info";
197     if (defined $socktype) {
198       msvalog('debug', "sockopt(SO_TYPE) = %d\n", $socktype);
199     } else {
200       msvalog('verbose', "sockopt(SO_TYPE) returned undefined.\n");
201     }
202
203     my $peercred = $sock->sockopt(SO_PEERCRED) or die "could not get SO_PEERCRED info";
204     my $client = $sock->peername();
205     my $family = sockaddr_family($client); # should be AF_UNIX (a.k.a. AF_LOCAL) or AF_INET
206
207     msvalog('verbose', "socket family: %d\nsocket type: %d\n", $family, $socktype);
208
209     if ($peercred) {
210       # FIXME: on i386 linux, this appears to be three ints, according to
211       # /usr/include/linux/socket.h.  What about other platforms?
212       my ($pid, $uid, $gid) = unpack('iii', $peercred);
213
214       msvalog('verbose', "SO_PEERCRED: pid: %u, uid: %u, gid: %u\n",
215               $pid, $uid, $gid,
216              );
217       if ($pid != 0 && $uid != 0) { # then we can accept it:
218         $clientid = $uid;
219       }
220       # FIXME: can we get the socket inode as well this way?
221     }
222
223     # another option in Linux would be to parse the contents of
224     # /proc/net/tcp to find the uid of the peer process based on that
225     # information.
226     if (! defined $clientid) {
227       msvalog('verbose', "SO_PEERCRED failed, digging around in /proc/net/tcp\n");
228       my $proto;
229       if ($family == AF_INET) {
230         $proto = '';
231       } elsif ($family == AF_INET6) {
232         $proto = '6';
233       }
234       if (defined $proto) {
235         if ($socktype == &SOCK_STREAM) {
236           $proto = 'tcp'.$proto;
237         } elsif ($socktype == &SOCK_DGRAM) {
238           $proto = 'udp'.$proto;
239         } else {
240           undef $proto;
241         }
242         if (defined $proto) {
243           my ($port, $iaddr) = unpack_sockaddr_in($client);
244           my $iaddrstring = unpack("H*", reverse($iaddr));
245           msvalog('verbose', "Port: %04x\nAddr: %s\n", $port, $iaddrstring);
246           my $remmatch = lc(sprintf("%s:%04x", $iaddrstring, $port));
247           my $infofile = '/proc/net/'.$proto;
248           my $f = IO::File::->new();
249           if ( $f->open('< '.$infofile)) {
250             my @header = split(/ +/, <$f>);
251             my ($localaddrix, $uidix, $inodeix);
252             my $ix = 0;
253             my $skipcount = 0;
254             while ($ix <= $#header) {
255               $localaddrix = $ix - $skipcount if (lc($header[$ix]) eq 'local_address');
256               $uidix = $ix - $skipcount if (lc($header[$ix]) eq 'uid');
257               $inodeix = $ix - $skipcount if (lc($header[$ix]) eq 'inode');
258               $skipcount++ if (lc($header[$ix]) eq 'tx_queue') or (lc($header[$ix]) eq 'tr'); # these headers don't actually result in a new column during the data rows
259               $ix++;
260             }
261             if (!defined $localaddrix) {
262               msvalog('info', "Could not find local_address field in %s; unable to determine peer UID\n",
263                       $infofile);
264             } elsif (!defined $uidix) {
265               msvalog('info', "Could not find uid field in %s; unable to determine peer UID\n",
266                       $infofile);
267             } elsif (!defined $inodeix) {
268               msvalog('info', "Could not find inode field in %s; unable to determine peer network socket inode\n",
269                       $infofile);
270             } else {
271               msvalog('debug', "local_address: %d; uid: %d\n", $localaddrix,$uidix);
272               while (my @line = split(/ +/,<$f>)) {
273                 if (lc($line[$localaddrix]) eq $remmatch) {
274                   if (defined $clientid) {
275                     msvalog('error', "Warning! found more than one remote uid! (%s and %s\n", $clientid, $line[$uidix]);
276                   } else {
277                     $clientid = $line[$uidix];
278                     $remotesocketinode = $line[$inodeix];
279                     msvalog('info', "remote peer is uid %d (inode %d)\n",
280                             $clientid, $remotesocketinode);
281                   }
282                 }
283               }
284             msvalog('error', "Warning! could not find peer information in %s.  Not verifying.\n", $infofile) unless defined $clientid;
285             }
286           } else { # FIXME: we couldn't read the file.  what should we
287                    # do besides warning?
288             msvalog('info', "Could not read %s; unable to determine peer UID\n",
289                     $infofile);
290           }
291         }
292       }
293     }
294     return { 'uid' => $clientid,
295              'inode' => $remotesocketinode };
296   }
297
298   sub handle_request {
299     my $self = shift;
300     my $cgi  = shift;
301
302     # This is part of a spawned child process.  We don't want the
303     # child process to destroy the update monitor when it terminates.
304     $self->{updatemonitor}->forget();
305     my $clientinfo = get_client_info(select);
306     my $clientuid = $clientinfo->{uid};
307
308     if (defined $clientuid) {
309       # test that this is an allowed user:
310       if (exists $self->{allowed_uids}->{$clientuid}) {
311         msvalog('verbose', "Allowing access from uid %d (%s)\n", $clientuid, $self->{allowed_uids}->{$clientuid});
312       } else {
313         msvalog('error', "MSVA client connection from uid %d, forbidden.\n", $clientuid);
314         printf("HTTP/1.0 403 Forbidden -- peer does not match local user ID\r\nContent-Type: text/plain\r\nDate: %s\r\n\r\nHTTP/1.1 403 Not Found -- peer does not match the local user ID.  Are you sure the agent is running as the same user?\r\n",
315                strftime("%a, %d %b %Y %H:%M:%S %z", localtime(time())),);
316         return;
317       }
318     }
319
320     my $path = $cgi->path_info();
321     my $handler = $dispatch{$path};
322
323     if (ref($handler) eq "HASH") {
324       if (! exists $handler->{methods}->{$cgi->request_method()}) {
325         printf("HTTP/1.0 405 Method not allowed\r\nAllow: %s\r\nDate: %s\r\n",
326                join(', ', keys(%{$handler->{methods}})),
327                strftime("%a, %d %b %Y %H:%M:%S %z", localtime(time())));
328       } elsif (ref($handler->{handler}) ne "CODE") {
329         printf("HTTP/1.0 500 Server Error\r\nDate: %s\r\n",
330                strftime("%a, %d %b %Y %H:%M:%S %z", localtime(time())));
331       } else {
332         my $data = {};
333         my $ctype = $cgi->content_type();
334         msvalog('verbose', "Got %s %s (Content-Type: %s)\n", $cgi->request_method(), $path, defined $ctype ? $ctype : '**none supplied**');
335         if (defined $ctype) {
336           my @ctypes = split(/; */, $ctype);
337           $ctype = shift @ctypes;
338           if ($ctype eq 'application/json') {
339             $data = from_json($cgi->param('POSTDATA'));
340           }
341         };
342
343         my ($status, $object) = $handler->{handler}($data, $clientinfo);
344         if (ref($object) eq 'HASH' &&
345             ! defined $object->{server}) {
346           $object->{server} = sprintf("MSVA-Perl %s", $VERSION);
347         }
348
349         my $ret = to_json($object);
350         msvalog('info', "returning: %s\n", $ret);
351         printf("HTTP/1.0 %s\r\nDate: %s\r\nContent-Type: application/json\r\n\r\n%s",
352                $status,
353                strftime("%a, %d %b %Y %H:%M:%S %z", localtime(time())),
354                $ret);
355       }
356     } else {
357       printf("HTTP/1.0 404 Not Found -- not handled by Monkeysphere validation agent\r\nContent-Type: text/plain\r\nDate: %s\r\n\r\nHTTP/1.0 404 Not Found -- the path:\r\n   %s\r\nis not handled by the MonkeySphere validation agent.\r\nPlease try one of the following paths instead:\r\n\r\n%s\r\n",
358              strftime("%a, %d %b %Y %H:%M:%S %z", localtime(time())),
359              $path, ' * '.join("\r\n * ", keys %dispatch) );
360     }
361   }
362
363   sub keycomp {
364     my $rsakey = shift;
365     my $gpgkey = shift;
366
367     if ($gpgkey->algo_num != 1) {
368       msvalog('verbose', "Monkeysphere only does RSA keys.  This key is algorithm #%d\n", $gpgkey->algo_num);
369     } else {
370       if ($rsakey->{exponent}->bcmp($gpgkey->pubkey_data->[1]) == 0 &&
371           $rsakey->{modulus}->bcmp($gpgkey->pubkey_data->[0]) == 0) {
372         return 1;
373       }
374     }
375     return 0;
376   }
377
378   sub get_keyserver_policy {
379     if (exists $ENV{MSVA_KEYSERVER_POLICY} and $ENV{MSVA_KEYSERVER_POLICY} ne '') {
380       if ($ENV{MSVA_KEYSERVER_POLICY} =~ /^(always|never|unlessvalid)$/) {
381         return $1;
382       }
383       msvalog('error', "Not a valid MSVA_KEYSERVER_POLICY):\n  %s\n", $ENV{MSVA_KEYSERVER_POLICY});
384     }
385     return $default_keyserver_policy;
386   }
387
388   sub get_keyserver {
389     # We should read from (first hit wins):
390     # the environment
391     if (exists $ENV{MSVA_KEYSERVER} and $ENV{MSVA_KEYSERVER} ne '') {
392       if ($ENV{MSVA_KEYSERVER} =~ /^(((hkps?|hkpms|finger|ldap):\/\/)?$RE{net}{domain})$/) {
393         return $1;
394       }
395       msvalog('error', "Not a valid keyserver (from MSVA_KEYSERVER):\n  %s\n", $ENV{MSVA_KEYSERVER});
396     }
397
398     # FIXME: some msva.conf or monkeysphere.conf file (system and user?)
399
400     # or else read from the relevant gnupg.conf:
401     my $gpghome;
402     if (exists $ENV{GNUPGHOME} and $ENV{GNUPGHOME} ne '') {
403       $gpghome = untaint($ENV{GNUPGHOME});
404     } else {
405       $gpghome = File::Spec->catfile(File::HomeDir->my_home, '.gnupg');
406     }
407     my $gpgconf = File::Spec->catfile($gpghome, 'gpg.conf');
408     if (-f $gpgconf) {
409       if (-r $gpgconf) {
410         my %gpgconfig = Config::General::ParseConfig($gpgconf);
411         if ($gpgconfig{keyserver} =~ /^(((hkps?|hkpms|finger|ldap):\/\/)?$RE{net}{domain})$/) {
412           msvalog('debug', "Using keyserver %s from the GnuPG configuration file (%s)\n", $1, $gpgconf);
413           return $1;
414         } else {
415           msvalog('error', "Not a valid keyserver (from gpg config %s):\n  %s\n", $gpgconf, $gpgconfig{keyserver});
416         }
417       } else {
418         msvalog('error', "The GnuPG configuration file (%s) is not readable\n", $gpgconf);
419       }
420     } else {
421       msvalog('info', "Did not find GnuPG configuration file while looking for keyserver '%s'\n", $gpgconf);
422     }
423
424     # the default_keyserver
425     return $default_keyserver;
426   }
427
428   sub fetch_uid_from_keyserver {
429     my $uid = shift;
430
431     my $cmd = IO::Handle::->new();
432     my $out = IO::Handle::->new();
433     my $nul = IO::File::->new("< /dev/null");
434
435     my $ks = get_keyserver();
436     msvalog('debug', "start ks query to %s for UserID: %s\n", $ks, $uid);
437     my $pid = $gnupg->wrap_call
438       ( handles => GnuPG::Handles::->new( command => $cmd, stdout => $out, stderr => $nul ),
439         command_args => [ '='.$uid ],
440         commands => [ '--keyserver',
441                       $ks,
442                       qw( --no-tty --with-colons --search ) ]
443       );
444     while (my $line = $out->getline()) {
445       msvalog('debug', "from ks query: (%d) %s", $cmd->fileno, $line);
446       if ($line =~ /^info:(\d+):(\d+)/ ) {
447         $cmd->print(join(' ', ($1..$2))."\n");
448         msvalog('debug', 'to ks query: '.join(' ', ($1..$2))."\n");
449         last;
450       }
451     }
452     # FIXME: can we do something to avoid hanging forever?
453     waitpid($pid, 0);
454     msvalog('debug', "ks query returns %d\n", POSIX::WEXITSTATUS($?));
455   }
456
457 ##################################################
458 ## PKC KEY EXTRACTION ############################
459
460   sub pkcextractkey {
461     my $data = shift;
462     my $key;
463
464     if (lc($data->{pkc}->{type}) eq 'x509der') {
465       $key = der2key(join('', map(chr, @{$data->{pkc}->{data}})));
466     } elsif (lc($data->{pkc}->{type}) eq 'x509pem') {
467       $key = der2key(pem2der($data->{pkc}->{data}));
468     } elsif (lc($data->{pkc}->{type}) eq 'opensshpubkey') {
469       $key = opensshpubkey2key($data->{pkc}->{data});
470     } elsif (lc($data->{pkc}->{type}) eq 'rfc4716') {
471       $key = rfc47162key($data->{pkc}->{data});
472     } else {
473       $key->{error} = sprintf("Don't know this public key carrier type: %s", $data->{pkc}->{type});
474     }
475
476     # make sure that the returned integers are Math::BigInts:
477     $key->{exponent} = Math::BigInt::->new($key->{exponent}) unless (ref($key->{exponent}));
478     $key->{modulus} = Math::BigInt::->new($key->{modulus}) unless (ref($key->{modulus}));
479     msvalog('debug', "pubkey info:\nmodulus: %s\nexponent: %s\n",
480             $key->{modulus}->as_hex(),
481             $key->{exponent}->as_hex(),
482            );
483
484     if ($key->{modulus}->copy()->blog(2) < 1000) {
485       $key->{error} = sprintf('Public key size is less than 1000 bits (was: %d bits)', $key->{modulus}->copy()->blog(2));
486     }
487     return $key;
488   }
489
490   sub der2key {
491     my $rawdata = shift;
492
493     my $cert = Crypt::X509::->new(cert => $rawdata);
494
495     my $key = {error => 'I do not know what happened here'};
496
497     if ($cert->error) {
498       $key->{error} = sprintf("Error decoding X.509 certificate: %s", $cert->error);
499     } else {
500       msvalog('verbose', "cert subject: %s\n", $cert->subject_cn());
501       msvalog('verbose', "cert issuer: %s\n", $cert->issuer_cn());
502       msvalog('verbose', "cert pubkey algo: %s\n", $cert->PubKeyAlg());
503       msvalog('verbose', "cert pubkey: %s\n", unpack('H*', $cert->pubkey()));
504
505       if ($cert->PubKeyAlg() ne 'RSA') {
506         $key->{error} = sprintf('public key was algo "%s" (OID %s).  MSVA.pl only supports RSA',
507                                 $cert->PubKeyAlg(), $cert->pubkey_algorithm);
508       } else {
509         msvalog('debug', "decoding ASN.1 pubkey\n");
510         $key = $rsa_decoder->decode($cert->pubkey());
511         if (! defined $key) {
512           msvalog('verbose', "failed to decode %s\n", unpack('H*', $cert->pubkey()));
513           $key = {error => 'failed to decode the public key'};
514         }
515       }
516     }
517     return $key;
518   }
519
520   sub pem2der {
521     my $pem = shift;
522     my @lines = split(/\n/, $pem);
523     my @goodlines = ();
524     my $ready = 0;
525     foreach my $line (@lines) {
526       if ($line eq '-----END CERTIFICATE-----') {
527         last;
528       } elsif ($ready) {
529         push @goodlines, $line;
530       } elsif ($line eq '-----BEGIN CERTIFICATE-----') {
531         $ready = 1;
532       }
533     }
534     msvalog('debug', "%d lines of base64:\n%s\n", $#goodlines + 1, join("\n", @goodlines));
535     return decode_base64(join('', @goodlines));
536   }
537
538   sub opensshpubkey2key {
539     my $data = shift;
540     # FIXME: do we care that the label matches the type of key?
541     my ($label, $prop) = split(/ +/, $data);
542
543     my $out = parse_rfc4716body($prop);
544
545     return $out;
546   }
547
548   sub rfc47162key {
549     my $data = shift;
550
551     my @goodlines;
552     my $continuation = '';
553     my $state = 'outside';
554     foreach my $line (split(/\n/, $data)) {
555       last if ($state eq 'body' && $line eq '---- END SSH2 PUBLIC KEY ----');
556       if ($state eq 'outside' && $line eq '---- BEGIN SSH2 PUBLIC KEY ----') {
557         $state = 'header';
558         next;
559       }
560       if ($state eq 'header') {
561         $line = $continuation.$line;
562         $continuation = '';
563         if ($line =~ /^(.*)\\$/) {
564           $continuation = $1;
565           next;
566         }
567         if (! ($line =~ /:/)) {
568           $state = 'body';
569         }
570       }
571       push(@goodlines, $line) if ($state eq 'body');
572     }
573
574     msvalog('debug', "Found %d lines of RFC4716 body:\n%s\n",
575             scalar(@goodlines),
576             join("\n", @goodlines));
577     my $out = parse_rfc4716body(join('', @goodlines));
578
579     return $out;
580   }
581
582   sub parse_rfc4716body {
583     my $data = shift;
584
585     return undef
586       unless defined($data);
587     $data = decode_base64($data) or return undef;
588
589     msvalog('debug', "key properties: %s\n", unpack('H*', $data));
590     my $out = [ ];
591     while (length($data) > 4) {
592       my $size = unpack('N', substr($data, 0, 4));
593       msvalog('debug', "size: 0x%08x\n", $size);
594       return undef if (length($data) < $size + 4);
595       push(@{$out}, substr($data, 4, $size));
596       $data = substr($data, 4 + $size);
597     }
598
599     if ($out->[0] ne "ssh-rsa") {
600       return {error => 'Not an RSA key'};
601     }
602
603     if (scalar(@{$out}) != 3) {
604       return {error => 'Does not contain the right number of bigints for RSA'};
605     }
606
607     return { exponent => Math::BigInt->from_hex('0x'.unpack('H*', $out->[1])),
608              modulus => Math::BigInt->from_hex('0x'.unpack('H*', $out->[2])),
609            } ;
610   }
611
612 ## PKC KEY EXTRACTION ############################
613 ##################################################
614
615   sub reviewcert {
616     my $data  = shift;
617     my $clientinfo  = shift;
618     return if !ref $data;
619
620     msvalog('verbose', "reviewing data...\n");
621
622     my $status = '200 OK';
623     my $ret =  { valid => JSON::false,
624                  message => 'Unknown failure',
625                };
626
627     # check context string
628     if ($data->{context} =~ /^(https|ssh|smtp|ike|postgresql|imaps|imap|submission)$/) {
629         $data->{context} = $1;
630     } else {
631         msvalog('error', "invalid context: %s\n", $data->{context});
632         $ret->{message} = sprintf("Invalid/unknown context: %s", $data->{context});
633         return $status,$ret;
634     }
635     msvalog('verbose', "context: %s\n", $data->{context});
636
637     # checkout peer string
638     # old-style just passed a string as a peer, rather than 
639     # peer: { name: 'whatever', 'type': 'client' }
640     $data->{peer} = { name => $data->{peer} }
641       if (ref($data->{peer}) ne 'HASH');
642
643     if (defined($data->{peer}->{type})) {
644       if ($data->{peer}->{type} =~ /^(client|server|peer)$/) {
645         $data->{peer}->{type} = $1;
646       } else {
647         msvalog('error', "invalid peer type string: %s\n", $data->{peer}->{type});
648         $ret->{message} = sprintf("Invalid peer type string: %s", $data->{peer}->{type});
649         return $status,$ret;
650       }
651     }
652
653     my $prefix = $data->{context}.'://';
654     if (defined $data->{peer}->{type} &&
655         $data->{peer}->{type} eq 'client' &&
656         # ike and smtp clients are effectively other servers, so we'll
657         # exclude them:
658         $data->{context} !~ /^(ike|smtp)$/) {
659       $prefix = '';
660       # clients can have any one-line User ID without NULL characters
661       # and leading or trailing whitespace
662       if ($data->{peer}->{name} =~ /^([^[:space:]][^\n\0]*[^[:space:]]|[^\0[:space:]])$/) {
663         $data->{peer}->{name} = $1;
664       } else {
665         msvalog('error', "invalid client peer name string: %s\n", $data->{peer}->{name});
666         $ret->{message} = sprintf("Invalid client peer name string: %s", $data->{peer}->{name});
667         return $status,$ret;
668       }
669     } elsif ($data->{peer}->{name} =~ /^($RE{net}{domain}(:[[:digit:]]+)?)$/) {
670       $data->{peer}->{name} = $1;
671     } else {
672       msvalog('error', "invalid peer name string: %s\n", $data->{peer}->{name});
673       $ret->{message} = sprintf("Invalid peer name string: %s", $data->{peer}->{name});
674       return $status,$ret;
675     }
676
677     msvalog('verbose', "peer: %s\n", $data->{peer}->{name});
678
679     # generate uid string
680     my $uid = $prefix.$data->{peer}->{name};
681     msvalog('verbose', "user ID: %s\n", $uid);
682
683     # extract key from PKC
684     my $key;
685     $key = pkcextractkey($data);
686     if (exists $key->{error}) {
687       $ret->{message} = $key->{error};
688       return $status,$ret;
689     }
690
691     # setup variables
692     $ret->{message} = sprintf('Failed to validate "%s" through the OpenPGP Web of Trust.', $uid);
693     my $lastloop = 0;
694     my $foundvalid = 0;
695
696     # determine keyserver policy
697     my $kspolicy;
698     if (defined $data->{keyserverpolicy} &&
699         $data->{keyserverpolicy} =~ /^(always|never|unlessvalid)$/) {
700       $kspolicy = $1;
701       msvalog("verbose", "using requested keyserver policy: %s\n", $1);
702     } else {
703       $kspolicy = get_keyserver_policy();
704     }
705     msvalog('debug', "keyserver policy: %s\n", $kspolicy);
706     # needed because $gnupg spawns child processes
707     $ENV{PATH} = '/usr/local/bin:/usr/bin:/bin';
708     if ($kspolicy eq 'always') {
709       fetch_uid_from_keyserver($uid);
710       $lastloop = 1;
711     } elsif ($kspolicy eq 'never') {
712       $lastloop = 1;
713     }
714
715     # fingerprints of keys that are not fully-valid for this User ID, but match
716     # the key from the queried certificate:
717     my @subvalid_key_fprs;
718
719     while (1) {
720       foreach my $gpgkey ($gnupg->get_public_keys('='.$uid)) {
721         my $validity = '-';
722         foreach my $tryuid ($gpgkey->user_ids) {
723           if ($tryuid->as_string eq $uid) {
724             $validity = $tryuid->validity;
725           }
726         }
727         # treat primary keys just like subkeys:
728         foreach my $subkey ($gpgkey, @{$gpgkey->subkeys}) {
729           my $primarymatch = keycomp($key, $subkey);
730           if ($primarymatch) {
731             if ($subkey->usage_flags =~ /a/) {
732               msvalog('verbose', "key matches, and 0x%s is authentication-capable\n", $subkey->hex_id);
733               if ($validity =~ /^[fu]$/) {
734                 $foundvalid = 1;
735                 msvalog('verbose', "...and it matches!\n");
736                 $ret->{valid} = JSON::true;
737                 $ret->{message} = sprintf('Successfully validated "%s" through the OpenPGP Web of Trust.', $uid);
738               } else {
739                 push(@subvalid_key_fprs, { fpr => $subkey->fingerprint, val => $validity }) if $lastloop;
740               }
741             } else {
742               msvalog('verbose', "key matches, but 0x%s is not authentication-capable\n", $subkey->hex_id);
743             }
744           }
745         }
746       }
747       if ($lastloop) {
748         last;
749       } else {
750         fetch_uid_from_keyserver($uid) if (!$foundvalid);
751         $lastloop = 1;
752       }
753     }
754
755     # only show the marginal UI if the UID of the corresponding
756     # key is not fully valid.
757     if (!$foundvalid) {
758       my $resp = Crypt::Monkeysphere::MSVA::MarginalUI->ask_the_user($gnupg,
759                                                                      $uid,
760                                                                      \@subvalid_key_fprs,
761                                                                      getpidswithsocketinode($clientinfo->{inode}),
762                                                                      $logger);
763       msvalog('info', "response: %s\n", $resp);
764       if ($resp) {
765         $ret->{valid} = JSON::true;
766         $ret->{message} = sprintf('Manually validated "%s" through the OpenPGP Web of Trust.', $uid);
767       }
768     }
769
770     return $status,$ret;
771   }
772
773   sub pre_loop_hook {
774     my $self = shift;
775     my $server = shift;
776
777     $self->spawn_master_subproc($server);
778   }
779
780   sub master_subprocess_died {
781     my $self = shift;
782     my $server = shift;
783     my $subproc_return = shift;
784
785     my $exitstatus = POSIX::WEXITSTATUS($subproc_return);
786     msvalog('verbose', "Subprocess %d terminated; exiting %d.\n", $self->{child_pid}, $exitstatus);
787     $server->set_exit_status($exitstatus);
788     $server->server_close();
789   }
790
791   sub child_dies {
792     my $self = shift;
793     my $pid = shift;
794     my $server = shift;
795
796     msvalog('debug', "Subprocess %d terminated.\n", $pid);
797
798     if (exists $self->{updatemonitor} &&
799         defined $self->{updatemonitor}->getchildpid() &&
800         $self->{updatemonitor}->getchildpid() == $pid) {
801       my $exitstatus = POSIX::WEXITSTATUS($?);
802       msvalog('verbose', "Update monitoring process (%d) terminated with code %d.\n", $pid, $exitstatus);
803       if (0 == $exitstatus) {
804         msvalog('info', "Reloading MSVA due to update request.\n");
805         # sending self a SIGHUP:
806         kill(1, $$);
807       } else {
808         msvalog('error', "Update monitoring process (%d) died unexpectedly with code %d.\nNo longer monitoring for updates; please send HUP manually.\n", $pid, $exitstatus);
809         # it died for some other weird reason; should we respawn it?
810
811         # FIXME: i'm worried that re-spawning would create a
812         # potentially abusive loop, if there are legit, repeatable
813         # reasons for the failure.
814
815 #        $self->{updatemonitor}->spawn();
816
817         # instead, we'll just avoid trying to kill the next process with this PID:
818         $self->{updatemonitor}->forget();
819       }
820     } elsif (exists $self->{child_pid} &&
821              ($self->{child_pid} == 0 ||
822               $self->{child_pid} == $pid)) {
823       $self->master_subprocess_died($server, $?);
824     }
825   }
826
827   # use sparingly!  We want to keep taint mode around for the data we
828   # get over the network.  this is only here because we want to treat
829   # the command line arguments differently for the subprocess.
830   sub untaint {
831     my $x = shift;
832     $x =~ /^(.*)$/ ;
833     return $1;
834   }
835
836   sub post_bind_hook {
837     my $self = shift;
838     my $server = shift;
839
840     $server->{server}->{leave_children_open_on_hup} = 1;
841
842     my $socketcount = @{ $server->{server}->{sock} };
843     if ( $socketcount != 1 ) {
844       msvalog('error', "%d sockets open; should have been 1.\n", $socketcount);
845       $server->set_exit_status(10);
846       $server->server_close();
847     }
848     my $port = @{ $server->{server}->{sock} }[0]->sockport();
849     if ((! defined $port) || ($port < 1) || ($port >= 65536)) {
850       msvalog('error', "got nonsense port: %d.\n", $port);
851       $server->set_exit_status(11);
852       $server->server_close();
853     }
854     if ((exists $ENV{MSVA_PORT}) && (($ENV{MSVA_PORT} + 0) != $port)) {
855       msvalog('error', "Explicitly requested port %d, but got port: %d.", ($ENV{MSVA_PORT}+0), $port);
856       $server->set_exit_status(13);
857       $server->server_close();
858     }
859     $self->port($port);
860     $self->{updatemonitor} = Crypt::Monkeysphere::MSVA::Monitor::->new($logger);
861   }
862
863   sub spawn_master_subproc {
864     my $self = shift;
865     my $server = shift;
866
867     if ((exists $ENV{MSVA_CHILD_PID}) && ($ENV{MSVA_CHILD_PID} ne '')) {
868       # this is most likely a re-exec.
869       msvalog('info', "This appears to be a re-exec, continuing with child pid %d\n", $ENV{MSVA_CHILD_PID});
870       $self->{child_pid} = $ENV{MSVA_CHILD_PID} + 0;
871     } elsif ($#ARGV >= 0) {
872       $self->{child_pid} = 0; # indicate that we are planning to fork.
873       # avoid ignoring SIGCHLD right before we fork.
874       $SIG{CHLD} = sub {
875         my $val;
876         while (defined($val = POSIX::waitpid(-1, POSIX::WNOHANG)) && $val > 0) {
877           $self->child_dies($val, $server);
878         }
879       };
880       my $fork = fork();
881       if (! defined $fork) {
882         msvalog('error', "could not fork\n");
883       } else {
884         if ($fork) {
885           msvalog('debug', "Child process has PID %d\n", $fork);
886           $self->{child_pid} = $fork;
887           $ENV{MSVA_CHILD_PID} = $fork;
888         } else {
889           msvalog('verbose', "PID %d executing: \n", $$);
890           for my $arg (@ARGV) {
891             msvalog('verbose', " %s\n", $arg);
892           }
893           # untaint the environment for the subprocess
894           # see: https://labs.riseup.net/code/issues/2461
895           foreach my $e (keys %ENV) {
896             $ENV{$e} = untaint($ENV{$e});
897           }
898           my @args;
899           foreach (@ARGV) {
900             push @args, untaint($_);
901           }
902           # restore default SIGCHLD handling:
903           $SIG{CHLD} = 'DEFAULT';
904           $ENV{MONKEYSPHERE_VALIDATION_AGENT_SOCKET} = sprintf('http://localhost:%d', $self->port);
905           exec(@args) or exit 111;
906         }
907       }
908     } else {
909       printf("MONKEYSPHERE_VALIDATION_AGENT_SOCKET=http://localhost:%d;\nexport MONKEYSPHERE_VALIDATION_AGENT_SOCKET;\n", $self->port);
910       # FIXME: consider daemonizing here to behave more like
911       # ssh-agent.  maybe avoid backgrounding by setting
912       # MSVA_NO_BACKGROUND.
913     };
914   }
915
916   sub extracerts {
917     my $data = shift;
918
919     return '500 not yet implemented', { };
920   }
921
922   1;
923 }