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