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