cgi-auth-flexible.pm

   1 # -*- perl -*-
   2
   3 # This is part of CGI::Auth::Flexible, a perl CGI authentication module.
   4 # Copyright (C) 2012 Ian Jackson.
   5 # Copyright (C) 2012 Citrix.
   6 #
   7 # This program is free software: you can redistribute it and/or modify
   8 # it under the terms of the GNU Affero General Public License as published by
   9 # the Free Software Foundation, either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # This program is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 # GNU Affero General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU Affero General Public License
  18 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20 use strict;
  21 use warnings FATAL => 'all';
  22
  23 package CGI::Auth::Flexible;
  24 require Exporter;
  25
  26 BEGIN {
  27     use Exporter   ();
  28     our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
  29
  30     $VERSION     = 1.00;
  31     @ISA         = qw(Exporter);
  32     @EXPORT      = qw();
  33     %EXPORT_TAGS = ( );     # eg: TAG => [ qw!name1 name2! ],
  34
  35     @EXPORT_OK   = qw();
  36 }
  37 our @EXPORT_OK;
  38
  39 use DBI;
  40 use CGI qw/escapeHTML/;
  41 use Locale::gettext;
  42 use URI;
  43 use IO::File;
  44 use Fcntl qw(:flock);
  45 use POSIX;
  46 use Digest;
  47 use Digest::HMAC;
  48 use Digest::SHA;
  49 use Data::Dumper;
  50 use File::Copy;
  51 use Cwd qw/realpath/;
  52
  53
  54 #---------- public utilities ----------
  55
  56 sub flatten_params ($) {
  57     my ($p) = @_;
  58     my @p;
  59     foreach my $k (keys %$p) {
  60         next if $k eq '';
  61         foreach my $v (@{ $p->{$k} }) {
  62             push @p, $k, $v;
  63         }
  64     }
  65     return @p;
  66 }
  67
  68 #---------- default callbacks ----------
  69
  70 sub has_a_param ($$) {
  71     my ($r,$cn) = @_;
  72     foreach my $pn (@{ $r->{S}{$cn} }) {
  73         return 1 if $r->_ch('get_param',$pn);
  74     }
  75     return 0;
  76 }
  77
  78 sub get_params ($) {
  79     my ($r) = @_;
  80     my $c = $r->{Cgi};
  81     my $vars = $c->Vars();
  82     my %p;
  83     foreach my $name (keys %$vars) {
  84         $p{$name} = [ split "\0", $vars->{$name} ];
  85     }
  86     return \%p;
  87 }
  88
  89 sub get_cookie_domain ($$$) {
  90     my ($c,$r) = @_;
  91     my $uri = new URI $r->_ch('get_url');
  92     return $uri->host();
  93 }
  94
  95 sub login_ok_password ($$) {
  96     my ($c, $r) = @_;
  97     my $username_params = $r->{S}{username_param_names};
  98     my $username = $r->_ch('get_param',$username_params->[0]);
  99     my $password = $r->_rp('password_param_name');
 100     my $error = $r->_ch('username_password_error', $username, $password);
 101     return defined($error) ? (undef,$error) : ($username,undef);
 102 }
 103
 104 sub do_redirect_cgi ($$$$) {
 105     my ($c, $r, $new_url, $cookie) = @_;
 106     $r->_print($c->header($r->_cgi_header_args($cookie,
 107                                                -status => '303 See other',
 108                                                -location => $new_url)),
 109                $r->_ch('gen_start_html',$r->_gt('Redirection')),
 110                '<a href="'.escapeHTML($new_url).'">',
 111                $r->_gt("If you aren't redirected, click to continue."),
 112                "</a>",
 113                $r->_ch('gen_end_html'));
 114 }
 115
 116 sub gen_some_form ($$) {
 117     my ($r, $params, $bodyfn) = @_;
 118     # Calls $bodyfn->($c,$r) which returns @formbits
 119     my $c = $r->{Cgi};
 120     my @form;
 121     my $pathinfo = '';
 122     $pathinfo .= $params->{''}[0] if $params->{''};
 123     push @form, ('<form method="POST" action="'.
 124                  escapeHTML($r->_ch('get_url').$pathinfo).'">');
 125     push @form, $bodyfn->($c,$r);
 126     foreach my $n (keys %$params) {
 127         next if $n eq '';
 128         foreach my $val (@{ $params->{$n} }) {
 129             push @form, ('<input type="hidden"'.
 130                          ' name="'.escapeHTML($n).'"'.
 131                          ' value="'.escapeHTML($val).'">');
 132         }
 133     }
 134     push @form, ('</form>');
 135     return join "\n", @form;
 136 }
 137
 138 sub gen_plain_login_form ($$) {
 139     my ($c,$r, $params) = @_;
 140     return $r->gen_some_form($params, sub {
 141         my @form;
 142         push @form, ('<table>');
 143         my $sz = 'size="'.$r->{S}{form_entry_size}.'"';
 144         foreach my $up (@{ $r->{S}{username_param_names}}) {
 145             push @form, ('<tr><td>',$r->_gt(ucfirst $up),'</td>',
 146                          '<td><input type="text" '.$sz.
 147                          ' name='.$up.'></td></tr>');
 148         }
 149         push @form, ('<tr><td>'.$r->_gt('Password').'</td>',
 150                      '<td><input type="password" '.$sz.
 151                      ' name="'.$r->{S}{password_param_name}.'"></td></tr>');
 152         push @form, ('<tr><td colspan="2">',
 153                      '<input type="submit"'.
 154                      ' name="'.$r->{S}{dummy_param_name_prefix}.'login"'.
 155                      ' value="'.$r->_gt('Login').'"></td></tr>',
 156                      '</table>');
 157         return @form;
 158     });
 159 }
 160
 161 sub gen_postmainpage_form ($$$) {
 162     my ($c,$r, $params) = @_;
 163     return $r->gen_some_form($params, sub {
 164         my @form;
 165         push @form, ('<input type="submit"',
 166                      ' name="'.$r->{S}{dummy_param_name_prefix}.'submit"'.
 167                      ' value="'.$r->_gt('Continue').'">');
 168         return @form;
 169     });
 170 }
 171
 172 sub gen_plain_login_link ($$) {
 173     my ($c,$r, $params) = @_;
 174     my $url = $r->url_with_query_params($params);
 175     return ('<a href="'.escapeHTML($url).'">'.
 176             $r->_gt('Log in again to continue.').
 177             '</a>');
 178 }
 179
 180 sub gen_srcdump_link_html ($$$$) {
 181     my ($c,$r,$anchor,$specval) = @_;
 182     my %params = ($r->{S}{srcdump_param_name} => [ $specval ]);
 183     return '<a href="'.
 184         escapeHTML($r->url_with_query_params(\%params,'SRCDUMP')).
 185         '">'.$anchor."</a>";
 186 }
 187 sub gen_plain_licence_link_html ($$) {
 188     my ($c,$r) = @_;
 189     gen_srcdump_link_html($c,$r, 'GNU Affero GPL', 'licence');
 190 }
 191 sub gen_plain_source_link_html ($$) {
 192     my ($c,$r) = @_;
 193     gen_srcdump_link_html($c,$r, 'Source available', 'source');
 194 }
 195
 196 sub gen_plain_footer_html ($$) {
 197     my ($c,$r) = @_;
 198     return ('<hr><address>',
 199             ("Powered by Free / Libre / Open Source Software".
 200              " according to the ".$r->_ch('gen_licence_link_html')."."),
 201             $r->_ch('gen_source_link_html').".",
 202             '</address>');
 203 }
 204
 205 #---------- licence and source code ----------
 206
 207 sub srcdump_dump ($$$) {
 208     my ($c,$r, $thing) = @_;
 209     die if $thing =~ m/\W/ || $thing !~ m/\w/;
 210     my $path = $r->_get_path('srcdump');
 211     my $ctf = new IO::File "$path/$thing.ctype", 'r'
 212         or die "$path/$thing.ctype $!";
 213     my $ct = <$ctf>;
 214     chomp $ct or die "$path/$thing ?";
 215     $ctf->close or die "$path/$thing $!";
 216     my $df = new IO::File "$path/$thing.data", 'r'
 217         or die "$path/$thing.data $!";
 218     $r->_ch('dump', $ct, $df);
 219 }
 220
 221 sub dump_plain ($$$$) {
 222     my ($c, $r, $ct, $df) = @_;
 223     $r->_print($c->header('-type' => $ct));
 224     my $buffer;
 225     for (;;) {
 226         my $got = read $df, $buffer, 65536;
 227         die $! unless defined $got;
 228         return if !$got;
 229         $r->_print($buffer);
 230     }
 231 }
 232
 233 sub srcdump_process_item ($$$$$$) {
 234     my ($c, $v, $dumpdir, $item, $outfn, $needlicence, $dirsdone) = @_;
 235     if ($v->_ch('srcdump_system_dir', $item)) {
 236         $outfn->("srcdump_process_item: srcdump_system_dir, skipping $item");
 237         return;
 238     }
 239     my $upwards = $item;
 240     for (;;) {
 241         $upwards =~ s#/+$##;
 242         $upwards =~ s#/+\.$##;
 243         last unless $upwards =~ m#[^/]#;
 244         foreach my $try (@{ $v->{S}{srcdump_vcs_dirs} }) {
 245 #print STDERR "TRY $item $upwards $try\n";
 246             if (!stat "$upwards/$try") {
 247                 $!==&ENOENT or $!==&ENOTDIR or die "check $upwards/$try $!";
 248                 next;
 249             }
 250 #print STDERR "VCS $item $upwards $try\n";
 251             if ($dirsdone->{$upwards}++) {
 252                 $outfn->("srcdump_process_item: did $upwards,".
 253                          " skipping $item");
 254                 return;
 255             }
 256 #print STDERR "VCS $item $upwards $try GO\n";
 257             $try =~ m/\w+/ or die;
 258             return $v->_ch('srcdump_byvcs', $dumpdir, $upwards, $outfn, lc $&);
 259         }
 260         $upwards =~ s#/*[^/]+$##;
 261     }
 262     return $v->_ch('srcdump_novcs', $dumpdir, $item, $outfn);
 263 }
 264
 265 sub srcdump_novcs ($$$$$) {
 266     my ($c, $v, $dumpdir, $item, $outfn) = @_;
 267     stat $item or die "$item $!";
 268     if (-d _) {
 269         my $script = 'find -type f -perm +004';
 270         foreach my $excl (@{ $v->{S}{srcdump_excludes} }) {
 271             $script .= " \\! -name '$excl'";
 272         }
 273         $script .= " -print0";
 274         return srcdump_dir_cpio($c,$v,$dumpdir,$item,$outfn,'novcs',$script);
 275     } elsif (-f _) {
 276         return srcdump_file($c,$v,$dumpdir,$item,$outfn);
 277     } else {
 278         die "$item not file or directory";
 279     }
 280 }
 281
 282 sub srcdump_byvcs ($$$$$$) {
 283     my ($c, $v, $dumpdir, $dir, $outfn, $vcs) = @_;
 284 #print STDERR "BYVCS GIT $dir\n";
 285     return srcdump_dir_cpio($c,$v,$dumpdir,$dir,$outfn,$vcs,
 286                             $v->{S}{"srcdump_vcsscript_$vcs"});
 287 }
 288
 289 sub srcdump_file ($$$$) {
 290     my ($c,$v,$dumpdir,$file,$outfn) = @_;
 291     my $outfile = $outfn->("srcdump_file saved $file", "src");
 292     copy($file,$outfile) or die "$file $outfile $!";
 293 }
 294
 295 sub srcdump_dir_cpio ($$$$$$$) {
 296     my ($c,$v,$dumpdir,$dir,$outfn,$how,$script) = @_;
 297     my $outfile = $outfn->("srcdump_dir_cpio $how saved $dir", "tar");
 298 #print STDERR "CPIO $dir >$script<\n";
 299     my $pid = fork();
 300     defined $pid or die $!;
 301     if (!$pid) {
 302         $SIG{__DIE__} = sub {
 303             print STDERR "CGI::Auth::Flexible srcdump error: $@\n";
 304             exit 127;
 305         };
 306         open STDOUT, ">", $outfile or die "$outfile $!";
 307         chdir $dir or die "chdir $dir: $!";
 308         exec '/bin/bash','-ec',"
 309             set -o pipefail
 310             (
 311              $script
 312             ) | (
 313              cpio -Hustar -o --quiet -0 -R 1000:1000 || \
 314              cpio -Hustar -o --quiet -0
 315             )
 316             ";
 317         die $!;
 318     }
 319     $!=0; (waitpid $pid, 0) == $pid or die "$!";
 320     die "$dir ($how $script) $outfile $?" if $?;
 321 }
 322
 323 sub srcdump_dirscan_prepare ($$) {
 324     my ($c, $v) = @_;
 325     my $dumpdir = $v->_get_path('srcdump');
 326     mkdir $dumpdir or $!==&EEXIST or die "mkdir $dumpdir $!";
 327     my $lockf = new IO::File "$dumpdir/generate.lock", 'w+'
 328         or die "$dumpdir/generate.lock $!";
 329     flock $lockf, LOCK_EX or die "$dumpdir/generate.lock $!";
 330     my $needlicence = "$dumpdir/licence.tmp";
 331     unlink $needlicence or $!==&ENOENT or die "rm $needlicence $!";
 332     if (defined $v->{S}{srcdump_licence_path}) {
 333         copy($v->{S}{srcdump_licence_path}, $needlicence)
 334             or die "$v->{S}{srcdump_licence_path} $!";
 335         $needlicence = undef;
 336     }
 337     unlink <"$dumpdir/s.[a-z][a-z][a-z].*">;
 338     my @srcfiles = qw(licence.data manifest.txt);
 339     my $srcoutcounter = 'aaa';
 340
 341     my $reportfh = new IO::File "$dumpdir/manifest.txt", 'w' or die $!;
 342     my $outfn = sub {
 343         my ($message, $extension) = @_;
 344         if (defined $extension) {
 345             my $leaf = "s.$srcoutcounter.$extension";
 346             $srcoutcounter++;
 347             push @srcfiles, $leaf;
 348             print $reportfh "$leaf: $message\n" or die $!;
 349             return "$dumpdir/$leaf";
 350         } else {
 351             print $reportfh "none: $message\n" or die $!;
 352             return undef;
 353         }
 354     };
 355     my %dirsdone;
 356     foreach my $item ($v->_ch('srcdump_listitems')) {
 357         if ($item eq '.' && $v->{S}{srcdump_filter_cwd}) {
 358             my @bad = grep { !m#^/# } values %INC;
 359             die "filtering . from srcdump items and \@INC but already".
 360                 " included @bad " if @bad;
 361             @INC = grep { $_ ne '.' } @INC;
 362             next;
 363         }
 364         if (!lstat "$item") {
 365             die "stat $item $!" unless $!==&ENOENT;
 366             $outfn->("srcdump_dirscan_prepare stat ENOENT, skipping $item");
 367             next;
 368         };
 369         if (-l _) {
 370             $item = realpath($item);
 371             if (!defined $item) {
 372                 die "realpath $item $!" unless $!==&ENOENT;
 373                 $outfn->("srcdump_dirscan_prepare realpath ENOENT,".
 374                          " skipping $item");
 375             }
 376         }
 377         if (defined $needlicence) {
 378             foreach my $try (@{ $v->{S}{srcdump_licence_files} }) {
 379                 last if copy("$item/$try", $needlicence);
 380                 $!==&ENOENT or $!==&ENOTDIR or die "copy $item/$try $!";
 381             }
 382         }
 383         $v->_ch('srcdump_process_item', $dumpdir, $item,
 384                 $outfn, \$needlicence, \%dirsdone);
 385         $dirsdone{$item}++;
 386     }
 387     close $reportfh or die $!;
 388     srcdump_install($c,$v, $dumpdir, 'licence', 'text/plain');
 389     $!=0;
 390     my @cmd = (qw(tar -zvvcf), "$dumpdir/source.tmp",
 391                "-C", $dumpdir, qw(  --), @srcfiles);
 392     my $r = system(@cmd);
 393     if ($r) {
 394         print STDERR "CGI::Auth::Flexible tar failed ($r $!) @cmd\n";
 395         die "tar failed";
 396     }
 397     die "licence file not found" unless defined $needlicence;
 398     srcdump_install($c,$v, $dumpdir, 'source', 'application/octet-stream');
 399     close $lockf or die $!;
 400 }
 401
 402 sub srcdump_install ($$$$$) {
 403     my ($c,$v, $dumpdir, $which, $ctype) = @_;
 404     rename "$dumpdir/$which.tmp", "$dumpdir/$which.data"
 405         or die "$dumpdir/$which.data $!";
 406     my $ctf = new IO::File "$dumpdir/$which.tmp", 'w'
 407         or die "$dumpdir/$which.tmp $!";
 408     print $ctf $ctype, "\n" or die $!;
 409     close $ctf or die $!;
 410     rename "$dumpdir/$which.tmp", "$dumpdir/$which.ctype"
 411         or die "$dumpdir/$which.ctype $!";
 412 }
 413
 414 #---------- verifier object methods ----------
 415
 416 sub new_verifier {
 417     my $class = shift;
 418     my $verifier = {
 419         S => {
 420             dir => undef,
 421             assocdb_dbh => undef, # must have AutoCommit=0, RaiseError=1
 422             assocdb_path => 'caf-assocs.db',
 423             keys_path => 'caf-keys',
 424             srcdump_path => 'caf-srcdump',
 425             assocdb_dsn => undef,
 426             assocdb_user => '',
 427             assocdb_password => '',
 428             assocdb_table => 'caf_assocs',
 429             random_source => '/dev/urandom',
 430             secretbits => 128, # bits
 431             hash_algorithm => "SHA-256",
 432             login_timeout => 86400, # seconds
 433             login_form_timeout => 3600, # seconds
 434             key_rollover => 86400, # seconds
 435             assoc_param_name => 'caf_assochash',
 436             dummy_param_name_prefix => 'caf__',
 437             cookie_name => "caf_assocsecret",
 438             password_param_name => 'password',
 439             srcdump_param_name => 'caf_srcdump',
 440             username_param_names => [qw(username)],
 441             form_entry_size => 60,
 442             logout_param_names => [qw(caf_logout)],
 443             loggedout_param_names => [qw(caf_loggedout)],
 444             promise_check_mutate => 0,
 445             get_param => sub { $_[0]->param($_[2]) },
 446             get_params => sub { $_[1]->get_params() },
 447             get_path_info => sub { $_[0]->path_info() },
 448             get_cookie => sub { $_[0]->cookie($_[1]->{S}{cookie_name}) },
 449             get_method => sub { $_[0]->request_method() },
 450             is_https => sub { !!$_[0]->https() },
 451             get_url => sub { $_[0]->url(); },
 452             is_login => sub { defined $_[1]->_rp('password_param_name') },
 453             login_ok => \&login_ok_password,
 454             username_password_error => sub { die },
 455             is_logout => sub { $_[1]->has_a_param('logout_param_names') },
 456             is_loggedout => sub { $_[1]->has_a_param('loggedout_param_names') },
 457             handle_divert => sub { return 0 },
 458             do_redirect => \&do_redirect_cgi, # this hook is allowed to throw
 459             cookie_path => "/",
 460             get_cookie_domain => \&get_cookie_domain,
 461             encrypted_only => 1,
 462             gen_start_html => sub { $_[0]->start_html($_[2]); },
 463             gen_footer_html => \&gen_plain_footer_html,
 464             gen_licence_link_html => \&gen_plain_licence_link_html,
 465             gen_source_link_html => \&gen_plain_source_link_html,
 466             gen_end_html => sub { $_[0]->end_html(); },
 467             gen_login_form => \&gen_plain_login_form,
 468             gen_login_link => \&gen_plain_login_link,
 469             gen_postmainpage_form => \&gen_postmainpage_form,
 470             srcdump_dump => \&srcdump_dump,
 471             srcdump_prepare => \&srcdump_dirscan_prepare,
 472             srcdump_licence_path => undef,
 473             srcdump_licence_files => [qw(AGPLv3 CGI/Auth/Flexible/AGPLv3)],
 474             srcdump_listitems => sub { (@INC, $ENV{'SCRIPT_FILENAME'}, $0); },
 475             srcdump_filter_cwd => 1,
 476             srcdump_system_dir => sub {
 477                 $_[2] =~ m#^/etc/|^/usr/(?!local/)(?!lib/cgi)#;
 478             },
 479             srcdump_process_item => \&srcdump_process_item,
 480             srcdump_vcs_dirs => [qw(.git .hg .bzr .svn)],
 481             srcdump_vcsscript_git => "
 482                  git ls-files -z
 483                  git ls-files -z --others --exclude-from=.gitignore
 484                  find .git -print0
 485                             ",
 486             srcdump_vcsscript_hg => "false hg",
 487             srcdump_vcsscript_bzr => "false bzr",
 488             srcdump_vcsscript_svn => "false svn",
 489             srcdump_byvcs => \&srcdump_byvcs,
 490             srcdump_novcs => \&srcdump_novcs,
 491             srcdump_excludes => [qw(*~ *.bak *.tmp), '#*#'],
 492             dump => \&dump_plain,
 493             gettext => sub { gettext($_[2]); },
 494             print => sub { print $_[2] or die $!; },
 495             debug => sub { }, # like print; msgs contain trailing \n
 496         },
 497         Dbh => undef,
 498     };
 499     my ($k,$v);
 500     while (($k,$v,@_) = @_) {
 501         die "unknown setting $k" unless
 502             $k =~ m/^promise_/ or
 503             exists $verifier->{S}{$k};
 504         $verifier->{S}{$k} = $v;
 505     }
 506     bless $verifier, $class;
 507     $verifier->_dbopen();
 508     $verifier->_ch('srcdump_prepare');
 509     return $verifier;
 510 }
 511
 512 sub _db_setup_do ($$) {
 513     my ($v, $sql) = @_;
 514     my $dbh = $v->{Dbh};
 515     eval {
 516         $v->_db_transaction(sub {
 517             local ($dbh->{PrintError}) = 0;
 518             $dbh->do($sql);
 519         });
 520     };
 521 }
 522
 523 sub _dbopen ($) {
 524     my ($v) = @_;
 525     my $dbh = $v->{Dbh};
 526     return $dbh if $dbh;
 527
 528     $dbh = $v->{S}{assocdb_dbh};
 529     if ($dbh) {
 530         die if $dbh->{AutoCommit};
 531         die unless $dbh->{RaiseError};
 532     } else {
 533         $v->{S}{assocdb_dsn} ||= "dbi:SQLite:dbname=".$v->_get_path('assocdb');
 534         my $dsn = $v->{S}{assocdb_dsn};
 535
 536         my $u = umask 077;
 537         $dbh = DBI->connect($dsn, $v->{S}{assocdb_user},
 538                             $v->{S}{assocdb_password}, {
 539                                 AutoCommit => 0,
 540                                 RaiseError => 1,
 541                                 ShowErrorStatement => 1,
 542                             });
 543         umask $u;
 544         die "$dsn $! ?" unless $dbh;
 545     }
 546     $v->{Dbh} = $dbh;
 547
 548     $v->_db_setup_do("CREATE TABLE $v->{S}{assocdb_table} (".
 549                      " assochash VARCHAR PRIMARY KEY,".
 550                      " username VARCHAR NOT NULL,".
 551                      " last INTEGER NOT NULL".
 552                      ")");
 553     $v->_db_setup_do("CREATE INDEX $v->{S}{assocdb_table}_timeout_index".
 554                      " ON $v->{S}{assocdb_table}".
 555                      " (last)");
 556     return $dbh;
 557 }
 558
 559 sub disconnect ($) {
 560     my ($v) = @_;
 561     my $dbh = $v->{Dbh};
 562     return unless $dbh;
 563     $dbh->disconnect();
 564 }
 565
 566 sub _db_transaction ($$) {
 567     my ($v, $fn) = @_;
 568     my $retries = 10;
 569     my $rv;
 570     my $dbh = $v->{Dbh};
 571 #print STDERR "DT entry\n";
 572     for (;;) {
 573 #print STDERR "DT loop\n";
 574         if (!eval {
 575             $rv = $fn->();
 576 #print STDERR "DT fn ok\n";
 577             1;
 578         }) {
 579 #print STDERR "DT fn error\n";
 580             { local ($@); $dbh->rollback(); }
 581 #print STDERR "DT fn throwing\n";
 582             die $@;
 583         }
 584 #print STDERR "DT fn eval ok\n";
 585         if (eval {
 586             $dbh->commit();
 587 #print STDERR "DT commit ok\n";
 588             1;
 589         }) {
 590 #print STDERR "DT commit eval ok ",Dumper($rv);
 591             return $rv;
 592         }
 593 #print STDERR "DT commit throw?\n";
 594         die $@ if !--$retries;
 595 #print STDERR "DT loop again\n";
 596     }
 597 }
 598
 599 #---------- request object methods ----------
 600
 601 sub new_request {
 602     my ($classbase, $cgi, @extra) = @_;
 603     if (!ref $classbase) {
 604         $classbase = $classbase->new_verifier(@extra);
 605     } else {
 606         die if @extra;
 607     }
 608     my $r = {
 609         V => $classbase,
 610         S => $classbase->{S},
 611         Dbh => $classbase->{Dbh},
 612         Cgi => $cgi,
 613     };
 614     bless $r, ref $classbase;
 615 }
 616
 617 sub _ch ($$@) { # calls an application hook
 618     my ($r,$methname, @args) = @_;
 619     my $methfunc = $r->{S}{$methname};
 620     die "$methname ?" unless $methfunc;
 621     return $methfunc->($r->{Cgi}, $r, @args);
 622 }
 623
 624 sub _rp ($$@) {
 625     my ($r,$pnvb) = @_;
 626     my $pn = $r->{S}{$pnvb};
 627     my $p = scalar $r->_ch('get_param',$pn)
 628 }
 629
 630 sub _debug ($@) {
 631     my ($r,@args) = @_;
 632     $r->_ch('debug',@args);
 633 }
 634
 635 sub _get_path ($$) {
 636     my ($r,$keybase) = @_;
 637     my $leaf = $r->{S}{"${keybase}_path"};
 638     return $r->_absify_path($leaf);
 639 }
 640
 641 sub _absify_path ($$) {
 642     my ($v,$leaf) = @_;
 643     return $leaf if $leaf =~ m,^/,;
 644     my $dir = $v->{S}{dir};
 645     die "relying on cwd by default ?!  set dir" unless defined $dir;
 646     return "$dir/$leaf";
 647 }
 648
 649 sub _gt ($$) { my ($r, $t) = @_; return $r->_ch('gettext',$t); }
 650 sub _print ($$) { my ($r, @t) = @_; return $r->_ch('print', join '', @t); }
 651
 652 sub construct_cookie ($$$) {
 653     my ($r, $cooks) = @_;
 654     return undef unless $cooks;
 655     my $c = $r->{Cgi};
 656 my @ca = (-name => $r->{S}{cookie_name},
 657                              -value => $cooks,
 658                              -path => $r->{S}{cookie_path},
 659                              -domain => $r->_ch('get_cookie_domain'),
 660                              -expires => '+'.$r->{S}{login_timeout}.'s',
 661                              -secure => $r->{S}{encrypted_only});
 662     my $cookie = $c->cookie(@ca);
 663 #print STDERR "CC $r $c $cooks $cookie (@ca).\n";
 664     return $cookie;
 665 }
 666
 667 # pages/param-sets are
 668 #   n normal non-mutating page
 669 #   r retrieval of information for JS etc., non-mutating
 670 #   m mutating page
 671 #   u update of information by JS etc., mutating
 672 #   i login
 673 #   o logout
 674 #   O "you have just logged out" page load
 675
 676 # in cook and par,
 677 #    -         no value supplied (represented in code as $cookt='')
 678 #    n, nN     value not in our db
 679 #    t, tN     temporary value (in our db, no logged in user yet)
 680 #    y, yN     value corresponds to logged-in user
 681 # and, aggregated conditions:
 682 #    a, aN     anything including -
 683 #    x, xN     t or y
 684 # if N differs the case applies only when the two values differ
 685 # (eg,   a1 y2   does not apply when the logged-in value is supplied twice)
 686
 687 # "stale session" means request originates from a page from a login
 688 # session which has been revoked (eg by logout); "cleared session"
 689 # means request originates from a browser which has a different (or
 690 # no) cookie.
 691
 692     # Case analysis, cookie mode, app promises re mutate:
 693     # cook parm meth form
 694     #
 695     #  any -   POST  nrmuoi   bug or attack, fail
 696     #  any -   GET    rmuoi   bug or attack, fail
 697     #  any any GET     muoi   bug or attack, fail
 698     #  any t   any   nrmu     bug or attack, fail
 699     #
 700     #  -   -   GET         O  "just logged out" page
 701     #  (any other)         O  bug or attack, fail
 702     #
 703     #  a1  a2  POST      o    logout
 704     #                           if a1 is valid, revoke it
 705     #                           if a2 is valid, revoke it
 706     #                           delete cookie
 707     #                           redirect to "just logged out" page
 708     #                             (which contains link to login form)
 709     #
 710     #  -   t   POST       i   complain about cookies being disabled
 711     #                           (with link to login form)
 712     #
 713     #  t1  t1  POST       i   login (or switch user)
 714     #                           if bad
 715     #                             show new login form
 716     #                           if good
 717     #                             upgrade t1 to y1 in our db (setting username)
 718     #                             redirect to GET of remaining params
 719     #
 720     #  y1  a2  POST       i   complain about stale login form
 721     #                           revoke y1
 722     #                           show new login form
 723     #
 724     #  (other) POST       i   complain about stale login form
 725     #                           show new login form
 726     #
 727     #  t1  a2  ANY   nrmu     treat as  - a2 ANY
 728     #
 729     #  y   -   GET   n        cross-site link
 730     #                           show data
 731     #
 732     #  y   y   GET   nr       fine, show page or send data
 733     #  y   y   POST  nrmu     mutation is OK, do operation
 734     #
 735     #  y1  y2  GET   nr       request from stale page
 736     #                           do not revoke y2 as not RESTful
 737     #                           treat as   y1 n GET
 738     #
 739     #  y1  y2  POST  nrmu     request from stale page
 740     #                           revoke y2
 741     #                           treat as   y1 n POST
 742     #
 743     #  y   n   GET   n        intra-site link from stale page,
 744     #                           treat as cross-site link, show data
 745     #
 746     #  y   n   POST  n m      intra-site form submission from stale page
 747     #                           show "session interrupted"
 748     #                           with link to main data page
 749     #
 750     #  y   n   GET    r       intra-site request from stale page
 751     #                           fail
 752     #
 753     #  y   n   POST   r u     intra-site request from stale page
 754     #                           fail
 755     #
 756     #  -/n y2  GET   nr       intra-site link from cleared session
 757     #                           do not revoke y2 as not RESTful
 758     #                           treat as   -/n n GET
 759     #
 760     #  -/n y2  POST  nrmu     request from cleared session
 761     #                           revoke y2
 762     #                           treat as   -/n n POST
 763     #
 764     #  -/n -/n GET   n        cross-site link but user not logged in
 765     #                           show login form with redirect to orig params
 766     #                           generate fresh cookie
 767     #
 768     #  -/n n   GET    rmu     user not logged in
 769     #                           fail
 770     #
 771     #  -/n n   POST  n m      user not logged in
 772     #                           show login form
 773     #
 774     #  -/n n   POST   r u     user not logged in
 775     #                           fail
 776
 777 sub _check_divert_core ($) {
 778     my ($r) = @_;
 779
 780     my $srcdump = $r->_rp('srcdump_param_name');
 781     if ($srcdump) {
 782         die if $srcdump =~ m/\W/;
 783         return ({ Kind => 'SRCDUMP-'.uc $srcdump,
 784                   Message => undef,
 785                   CookieSecret => undef,
 786                   Params => { } });
 787     }
 788
 789     my $cooks = $r->_ch('get_cookie');
 790
 791     if ($r->{S}{encrypted_only} && !$r->_ch('is_https')) {
 792         return ({ Kind => 'REDIRECT-HTTPS',
 793                   Message => $r->_gt("Redirecting to secure server..."),
 794                   CookieSecret => undef,
 795                   Params => { } });
 796     }
 797
 798     my $meth = $r->_ch('get_method');
 799     my $parmh = $r->_rp('assoc_param_name');
 800     my $cookh = defined $cooks ? $r->hash($cooks) : undef;
 801
 802     my ($cookt,$cooku) = $r->_identify($cookh, $cooks);
 803     my $parms = (defined $cooks && defined $parmh && $parmh eq $cookh)
 804         ? $cooks : undef;
 805     my ($parmt) = $r->_identify($parmh, $parms);
 806
 807     $r->_debug("_c_d_c cookt=$cookt parmt=$parmt\n");
 808
 809     if ($r->_ch('is_logout')) {
 810         $r->_must_be_post();
 811         die unless $parmt;
 812         $r->_db_revoke($cookh);
 813         $r->_db_revoke($parmh);
 814         return ({ Kind => 'REDIRECT-LOGGEDOUT',
 815                   Message => $r->_gt("Logging out..."),
 816                   CookieSecret => '',
 817                   Params => { } });
 818     }
 819     if ($r->_ch('is_loggedout')) {
 820         die unless $meth eq 'GET';
 821         die if $cookt eq 'y';
 822         die if $parmt;
 823         return ({ Kind => 'SMALLPAGE-LOGGEDOUT',
 824                   Message => $r->_gt("You have been logged out."),
 825                   CookieSecret => '',
 826                   Params => { } });
 827     }
 828     if ($r->_ch('is_login')) {
 829         $r->_must_be_post();
 830         die unless $parmt;
 831         if (!$cookt && $parmt eq 'n') {
 832             return ({ Kind => 'SMALLPAGE-NOCOOKIE',
 833                       Message => $r->_gt("You do not seem to have cookies".
 834                                          " enabled.  You must enable cookies".
 835                                          " as we use them for login."),
 836                       CookieSecret => $r->_fresh_secret(),
 837                       Params => $r->chain_params() })
 838         }
 839         if (!$cookt || $cookt eq 'n' || $cookh ne $parmh) {
 840             $r->_db_revoke($cookh);
 841             return ({ Kind => 'LOGIN-STALE',
 842                       Message => $r->_gt("Stale session;".
 843                                          " you need to log in again."),
 844                       CookieSecret => $r->_fresh_secret(),
 845                       Params => { } })
 846         }
 847         die unless $parmt eq 't' || $parmt eq 'y';
 848         my ($username, $login_errormessage) = $r->_ch('login_ok');
 849         unless (defined $username && length $username) {
 850             $login_errormessage = $r->_gt("Incorrect username/password.")
 851                 if !$login_errormessage;
 852             return ({ Kind => 'LOGIN-BAD',
 853                       Message => $login_errormessage,
 854                       CookieSecret => $cooks,
 855                       Params => $r->chain_params() })
 856         }
 857         $r->_db_record_login_ok($parmh,$username);
 858         return ({ Kind => 'REDIRECT-LOGGEDIN',
 859                   Message => $r->_gt("Logging in..."),
 860                   CookieSecret => $cooks,
 861                   Params => $r->chain_params() });
 862     }
 863     if ($cookt eq 't') {
 864         $cookt = '';
 865     }
 866     die if $parmt eq 't';
 867
 868     if ($cookt eq 'y' && $parmt eq 'y' && $cookh ne $parmh) {
 869         $r->_db_revoke($parmh) if $meth eq 'POST';
 870         $parmt = 'n';
 871     }
 872
 873     if ($cookt ne 'y') {
 874         die unless !$cookt || $cookt eq 'n';
 875         die unless !$parmt || $parmt eq 'n' || $parmt eq 'y';
 876         my $news = $r->_fresh_secret();
 877         if ($meth eq 'GET') {
 878             return ({ Kind => 'LOGIN-INCOMINGLINK',
 879                       Message => $r->_gt("You need to log in."),
 880                       CookieSecret => $news,
 881                       Params => $r->chain_params() });
 882         } else {
 883             $r->_db_revoke($parmh);
 884             return ({ Kind => 'LOGIN-FRESH',
 885                       Message => $r->_gt("You need to log in."),
 886                       CookieSecret => $news,
 887                       Params => { } });
 888         }
 889     }
 890
 891     if (!$r->{S}{promise_check_mutate}) {
 892         if ($meth ne 'POST') {
 893             return ({ Kind => 'MAINPAGEONLY',
 894                       Message => $r->_gt('Entering via cross-site link.'),
 895                       CookieSecret => $cooks,
 896                       Params => { } });
 897             # NB caller must then ignore params & path!
 898             # if this is too hard they can spit out a small form
 899             # with a "click to continue"
 900         }
 901     }
 902
 903     die unless $cookt eq 'y';
 904     unless ($r->{S}{promise_check_mutate} && $meth eq 'GET') {
 905         die unless $parmt eq 'y';
 906         die unless $cookh eq $parmh;
 907     }
 908     $r->{ParmT} = $parmt;
 909     $r->{AssocSecret} = $cooks;
 910     $r->{UserOK} = $cooku;
 911 #print STDERR "C-D-C OK\n";
 912     return undef;
 913 }
 914
 915 sub chain_params ($) {
 916     my ($r) = @_;
 917     my %p = %{ $r->_ch('get_params') };
 918     foreach my $pncn (keys %{ $r->{S} }) {
 919         my $names;
 920         if ($pncn =~ m/_param_name$/) {
 921             my $name = $r->{S}{$pncn};
 922             die "$pncn ?" if ref $name;
 923             $names = [ $name ];
 924         } elsif ($pncn =~ m/_param_names$/) {
 925             $names = $r->{S}{$pncn};
 926         } else {
 927             next;
 928         }
 929         foreach my $name (@$names) {
 930             delete $p{$name};
 931         }
 932     }
 933     my $dummy_prefix = $r->{S}{dummy_param_name_prefix};
 934     foreach my $name (grep /^$dummy_prefix/, keys %p) {
 935         delete $p{$name};
 936     }
 937     die if exists $p{''};
 938     $p{''} = [ $r->_ch('get_path_info') ];
 939     return \%p;
 940 }
 941
 942 sub _identify ($$) {
 943     my ($r,$h,$s) = @_;
 944     # returns ($t,$username)
 945     # where $t is one of "t" "y" "n", or "" (for -)
 946     # either $s must be undef, or $h eq $r->hash($s)
 947
 948 #print STDERR "_identify\n";
 949     return '' unless defined $h && length $h;
 950 #print STDERR "_identify h=$h s=".(defined $s ? $s : '<undef>')."\n";
 951
 952     my $dbh = $r->{Dbh};
 953
 954     $dbh->do("DELETE FROM $r->{S}{assocdb_table}".
 955              " WHERE last < ?", {},
 956              time - $r->{S}{login_timeout});
 957
 958     my $row = $dbh->selectrow_arrayref("SELECT username, last".
 959                               " FROM $r->{S}{assocdb_table}".
 960                               " WHERE assochash = ?", {}, $h);
 961     if (defined $row) {
 962 #print STDERR "_identify h=$h s=$s YES @$row\n";
 963         my ($nusername, $nlast) = @$row;
 964         return ('y', $nusername);
 965     }
 966
 967     # Well, it's not in the database.  But maybe it's a hash of a
 968     # temporary secret.
 969
 970     return 'n' unless defined $s;
 971
 972     my ($keyt, $signature, $message, $noncet, $nonce) =
 973         $s =~ m/^(\d+)\.(\w+)\.((\d+)\.(\w+))$/ or die;
 974
 975     return 'n' if time > $noncet + $r->{S}{login_form_timeout};
 976
 977 #print STDERR "_identify noncet=$noncet ok\n";
 978
 979     my $keys = $r->_open_keys();
 980     while (my ($rkeyt, $rkey, $line) = $r->_read_key($keys)) {
 981 #print STDERR "_identify  search rkeyt=$rkeyt rkey=$rkey\n";
 982         last if $rkeyt < $keyt; # too far down in the file
 983         my $trysignature = $r->_hmac($rkey, $message);
 984 #print STDERR "_identify  search rkeyt=$rkeyt rkey=$rkey try=$trysignature\n";
 985         return 't' if $trysignature eq $signature;
 986     }
 987     # oh well
 988 #print STDERR "_identify NO\n";
 989
 990     $keys->error and die $!;
 991     return 'n';
 992 }
 993
 994 sub _db_revoke ($$) {
 995     # revokes $h if it's valid; no-op if it's not
 996     my ($r,$h) = @_;
 997
 998     my $dbh = $r->{Dbh};
 999
1000     $dbh->do("DELETE FROM $r->{S}{assocdb_table}".
1001              " WHERE assochash = ?", {}, $h);
1002 }
1003
1004 sub _db_record_login_ok ($$$) {
1005     my ($r,$h,$user) = @_;
1006     $r->_db_revoke($h);
1007     my $dbh = $r->{Dbh};
1008     $dbh->do("INSERT INTO $r->{S}{assocdb_table}".
1009              " (assochash, username, last) VALUES (?,?,?)", {},
1010              $h, $user, time);
1011 }
1012
1013 sub check_divert ($) {
1014     my ($r) = @_;
1015     if (exists $r->{Divert}) {
1016         return $r->{Divert};
1017     }
1018     my $dbh = $r->{Dbh};
1019     $r->{Divert} = $r->_db_transaction(sub { $r->_check_divert_core(); });
1020     $dbh->commit();
1021     $r->_debug(Data::Dumper->Dump([$r->{Divert}],[qw(divert)]));
1022     return $r->{Divert};
1023 }
1024
1025 sub get_divert ($) {
1026     my ($r) = @_;
1027     die "unchecked" unless exists $r->{Divert};
1028     return $r->{Divert};
1029 }
1030
1031 sub get_username ($) {
1032     my ($r) = @_;
1033     my $divert = $r->get_divert();
1034     return undef if $divert;
1035     return $r->{UserOK};
1036 }
1037
1038 sub url_with_query_params ($$;$) {
1039     my ($r, $params, $nonpagetype) = @_;
1040 #print STDERR "PARAMS ",Dumper($params);
1041     my $uri = URI->new($r->_ch('get_url'));
1042     $uri->path($uri->path() . $params->{''}[0]) if $params->{''};
1043     my @flatparams = flatten_params($params);
1044     if (defined $nonpagetype && $r->need_add_hidden('GET',$nonpagetype)) {
1045         push @flatparams, $r->{S}{assoc_param_name}, $r->secret_hidden_val();
1046     }
1047     $uri->query_form(@flatparams);
1048     return $uri->as_string();
1049 }
1050
1051 sub _cgi_header_args ($$@) {
1052     my ($r, $cookie, @ha) = @_;
1053     unshift @ha, qw(-type text/html);
1054     push @ha, (-cookie => $cookie) if defined $cookie;
1055 #print STDERR "_cgi_header_args ",join('|',@ha),".\n";
1056     return @ha;
1057 }
1058
1059 sub check_ok ($) {
1060     my ($r) = @_;
1061
1062     my ($divert) = $r->check_divert();
1063     return 1 if !$divert;
1064
1065     my $handled = $r->_ch('handle_divert',$divert);
1066     return 0 if $handled;
1067
1068     my $kind = $divert->{Kind};
1069     my $cookiesecret = $divert->{CookieSecret};
1070     my $params = $divert->{Params};
1071     my $cookie = $r->construct_cookie($cookiesecret);
1072
1073     if ($kind =~ m/^SRCDUMP-(\w+)$/) {
1074         $r->_ch('srcdump_dump', (lc $1));
1075         return 0;
1076     }
1077
1078     if ($kind =~ m/^REDIRECT-/) {
1079         # for redirects, we honour stored Params and Cookie,
1080         # as we would for non-divert
1081         if ($kind eq 'REDIRECT-LOGGEDOUT') {
1082             $params->{$r->{S}{loggedout_param_names}[0]} = [ 1 ];
1083         } elsif ($kind eq 'REDIRECT-LOGOUT') {
1084             $params->{$r->{S}{logout_param_names}[0]} = [ 1 ];
1085         } elsif ($kind =~ m/REDIRECT-(?:LOGGEDIN|HTTPS)/) {
1086         } else {
1087             die;
1088         }
1089         my $new_url = $r->url_with_query_params($params);
1090         if ($kind eq 'REDIRECT-HTTPS') {
1091             my $uri = URI->new($new_url);
1092             die unless $uri->scheme eq 'http';
1093             $uri->scheme('https');
1094             $new_url = $uri->as_string();
1095         }
1096         $r->_ch('do_redirect',$new_url, $cookie);
1097         return 0;
1098     }
1099
1100     if (defined $cookiesecret) {
1101         $params->{$r->{S}{assoc_param_name}} = [ $r->hash($cookiesecret) ];
1102     }
1103
1104     my ($title, @body);
1105     if ($kind =~ m/^LOGIN-/) {
1106         $title = $r->_gt('Login');
1107         push @body, $divert->{Message};
1108         push @body, $r->_ch('gen_login_form', $params);
1109     } elsif ($kind =~ m/^SMALLPAGE-/) {
1110         $title = $r->_gt('Not logged in');
1111         push @body, $divert->{Message};
1112         push @body, $r->_ch('gen_login_link', $params);
1113     } elsif ($kind =~ m/^MAINPAGEONLY$/) {
1114         $title = $r->_gt('Entering secure site.');
1115         push @body, $divert->{Message};
1116         push @body, $r->_ch('gen_postmainpage_form', $params);
1117     } else {
1118         die $kind;
1119     }
1120
1121     $r->_print($r->{Cgi}->header($r->_cgi_header_args($cookie)),
1122                $r->_ch('gen_start_html',$title),
1123                (join "\n", (@body,
1124                             $r->_ch('gen_footer_html'),
1125                             $r->_ch('gen_end_html'))));
1126     return 0;
1127 }
1128
1129 sub _random ($$) {
1130     my ($r, $bytes) = @_;
1131     my $v = $r->{V};
1132     my $rsf = $v->{RandomHandle};
1133     my $rsp = $r->{S}{random_source};
1134     if (!$rsf) {
1135         $v->{RandomHandle} = $rsf = new IO::File $rsp, '<' or die "$rsp $!";
1136 #print STDERR "RH $rsf\n";
1137     }
1138     my $bin;
1139     $!=0;
1140     read($rsf,$bin,$bytes) == $bytes or die "$rsp $!";
1141     my $out = unpack "H*", $bin;
1142 #print STDERR "_random out $out\n";
1143     return $out;
1144 }
1145
1146 sub _random_key ($) {
1147     my ($r) = @_;
1148 #print STDERR "_random_key\n";
1149     my $bytes = ($r->{S}{secretbits} + 7) >> 3;
1150     return $r->_random($bytes);
1151 }
1152
1153 sub _read_key ($$) {
1154     my ($r, $keys) = @_;
1155     # returns $gen_time_t, $key_value_in_hex, $complete_line
1156     while (<$keys>) {
1157         my ($gen, $k) = m/^(\d+) (\S+)$/ or die "$_ ?";
1158         my $age = time - $gen;
1159         next if $age > $r->{S}{key_rollover} &&
1160             $age > $r->{S}{login_form_timeout}*2;
1161         return ($gen, $k, $_);
1162     }
1163     return ();
1164 }
1165
1166 sub _open_keys ($) {
1167     my ($r) = @_;
1168     my $spath = $r->_get_path('keys');
1169     for (;;) {
1170 #print STDERR "_open_keys\n";
1171         my $keys = new IO::File $spath, 'r+';
1172         if ($keys) {
1173 #print STDERR "_open_keys open\n";
1174             stat $keys or die $!; # NB must not disturb stat _
1175             my $size = (stat _)[7];
1176             my $age = time - (stat _)[9];
1177 #print STDERR "_open_keys open size=$size age=$age\n";
1178             return $keys
1179                 if $size && $age <= $r->{S}{key_rollover} / 2;
1180 #print STDERR "_open_keys open bad\n";
1181         }
1182         # file doesn't exist, or is empty or too old
1183         if (!$keys) {
1184 #print STDERR "_open_keys closed\n";
1185             die "$spath $!" unless $!==&ENOENT;
1186             # doesn't exist, so create it just so we can lock it
1187             $keys = new IO::File $spath, 'a+';
1188             die "$keys $!" unless $keys;
1189             stat $keys or die $!; # NB must not disturb stat _
1190             my $size = (stat _)[7];
1191 #print STDERR "_open_keys created size=$size\n";
1192             next if $size; # oh someone else has done it, reopen and read it
1193         }
1194         # file now exists is empty or too old, we must try to replace it
1195         my $our_inum = (stat _)[1]; # last use of that stat _
1196         flock $keys, LOCK_EX or die "$spath $!";
1197         stat $spath or die "$spath $!";
1198         my $path_inum = (stat _)[1];
1199 #print STDERR "_open_keys locked our=$our_inum path=$path_inum\n";
1200         next if $our_inum != $path_inum; # someone else has done it
1201         # We now hold the lock!
1202 #print STDERR "_open_keys creating\n";
1203         my $newkeys = new IO::Handle;
1204         sysopen $newkeys, "$spath.new", O_CREAT|O_TRUNC|O_WRONLY, 0600
1205             or die "$spath.new $!";
1206         # we add the new key to the front which means it's always sorted
1207         print $newkeys time, ' ', $r->_random_key(), "\n" or die $!;
1208         while (my ($gen,$key,$line) = $r->_read_key($keys)) {
1209 #print STDERR "_open_keys copy1\n";
1210             print $newkeys, $line or die $!;
1211         }
1212         $keys->error and die $!;
1213         close $newkeys or die "$spath.new $!";
1214         rename "$spath.new", "$spath" or die "$spath: $!";
1215 #print STDERR "_open_keys installed\n";
1216         # that rename effective unlocks, since it makes the name refer
1217         #  to the new file which we haven't locked
1218         # we go round again opening the file at the beginning
1219         #  so that our caller gets a fresh handle onto the existing key file
1220     }
1221 }
1222
1223 sub _fresh_secret ($) {
1224     my ($r) = @_;
1225 #print STDERR "_fresh_secret\n";
1226
1227     my $keys = $r->_open_keys();
1228     my ($keyt, $key) = $r->_read_key($keys);
1229     die unless defined $keyt;
1230
1231     my $nonce = $r->_random_key();
1232     my $noncet = time;
1233     my $message = "$noncet.$nonce";
1234
1235     my $signature = $r->_hmac($key, $message);
1236     my $secret = "$keyt.$signature.$message";
1237 #print STDERR "FRESH $secret\n";
1238     return $secret;
1239 }
1240
1241 sub _hmac ($$$) {
1242     my ($r, $keyhex, $message) = @_;
1243     my $keybin = pack "H*", $keyhex;
1244     my $alg = $r->{S}{hash_algorithm};
1245 #print STDERR "hmac $alg\n";
1246     my $base = new Digest $alg;
1247 #print STDERR "hmac $alg $base\n";
1248     my $digest = new Digest::HMAC $keybin, $base;
1249 #print STDERR "hmac $alg $base $digest\n";
1250     $digest->add($message);
1251     return $digest->hexdigest();
1252 }
1253
1254 sub hash ($$) {
1255     my ($r, $message) = @_;
1256     my $alg = $r->{S}{hash_algorithm};
1257 #print STDERR "hash $alg\n";
1258     my $digest = new Digest $alg;
1259     $digest->add($message);
1260     return $digest->hexdigest();
1261 }
1262
1263 sub _assert_checked ($) {
1264     my ($r) = @_;
1265     die "unchecked" unless exists $r->{Divert};
1266 }
1267
1268 sub _is_post ($) {
1269     my ($r) = @_;
1270     my $meth = $r->_ch('get_method');
1271     return $meth eq 'POST';
1272 }
1273
1274 sub _must_be_post ($) {
1275     my ($r) = @_;
1276     my $meth = $r->_ch('get_method');
1277     die "mutating non-POST" if $meth ne 'POST';
1278 }
1279
1280 sub check_mutate ($) {
1281     my ($r) = @_;
1282     $r->_assert_checked();
1283     die if $r->{Divert};
1284     $r->_must_be_post();
1285 }
1286
1287 our %_resource_get_needs_secret_hidden =
1288     (map { $_ => 0 } qw(PAGE FRAME IFRAME SRCDUMP STYLESHEET FAVICON ROBOTS),
1289      map { $_ => 1 } qw(IMAGE SCRIPT AJAX-XML AJAX-JSON AJAX-OTHER));
1290
1291 sub update_get_need_add_hidden ($$;$) {
1292     my ($r, $reqtype, $value, $force) = @_;
1293     my $hash = ref $r
1294         ? ($r->{GetNeedsSecretHidden} ||= { })
1295         : \%_resource_get_needs_secret_hidden;
1296     return if !$force &&
1297         (exists $_resource_get_needs_secret_hidden{$reqtype} ||
1298          exists $hash->{$reqtype});
1299     $hash->{$reqtype} = $value;
1300 }
1301
1302 sub need_add_hidden ($$) {
1303     my ($r, $method, $reqtype) = @_;
1304     return 1 if $method ne 'GET';
1305     if (ref $r) {
1306         my $ent = $r->{GetNeedsSecretHidden}{$reqtype};
1307         return $ent if defined $ent;
1308     }
1309     my $ent = $_resource_get_needs_secret_hidden{$reqtype};
1310     return $ent if defined $ent;
1311     die "unsupported nonpage GET type $reqtype";
1312 }
1313
1314 sub check_nonpage ($$) {
1315     my ($r, $reqtype) = @_;
1316     $r->_assert_checked();
1317     return unless $r->resource_get_needs_secret_hidden($nonpagetype);
1318     return if $r->{ParmT};
1319     die "missing hidden secret parameter on nonpage request $nonpagetype";
1320 }
1321
1322 #---------- output ----------
1323
1324 sub secret_cookie_val ($) {
1325     my ($r) = @_;
1326     $r->_assert_checked();
1327     return defined $r->{AssocSecret} ? $r->{AssocSecret} : '';
1328 }
1329
1330 sub secret_hidden_val ($) {
1331     my ($r) = @_;
1332     $r->_assert_checked();
1333     return defined $r->{AssocSecret} ? $r->hash($r->{AssocSecret}) : '';
1334 }
1335
1336 sub secret_hidden_html ($) {
1337     my ($r) = @_;
1338     return $r->{Cgi}->hidden(-name => $r->{S}{assoc_param_name},
1339                              -default => $r->secret_hidden_val());
1340 }
1341
1342 sub secret_cookie ($) {
1343     my ($r) = @_;
1344     my $secret = $r->secret_cookie_val();
1345     return undef if !defined $secret;
1346 #print STDERR "SC\n";
1347     my $cookv = $r->construct_cookie($secret);
1348 #print STDERR "SC=$cookv\n";
1349     return $cookv;
1350 }
1351
1352 1;