chiark / gitweb /
49b3303464278cb56b45f30f947adfcccc16030f
[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
51 #---------- public utilities ----------
52
53 sub flatten_params ($) {
54     my ($p) = @_;
55     my @p;
56     foreach my $k (keys %$p) {
57         next if $k eq '';
58         foreach my $v (@{ $p->{$k} }) {
59             push @p, $k, $v;
60         }
61     }
62     return @p;
63 }
64
65 #---------- default callbacks ----------
66
67 sub has_a_param ($$) {
68     my ($r,$cn) = @_;
69     foreach my $pn (@{ $r->{S}{$cn} }) {
70         return 1 if $r->_ch('get_param',$pn);
71     }
72     return 0;
73 }
74
75 sub get_params ($) {
76     my ($r) = @_;
77     my %p;
78     my $c = $r->{Cgi};
79     foreach my $name ($c->param()) {
80         $p{$name} = [ $c->param($name) ];
81     }
82     return \%p;
83 }
84
85 sub get_cookie_domain ($$$) {
86     my ($c,$r) = @_;
87     my $uri = new URI $r->_ch('get_url');
88     return $uri->host();
89 }
90
91 sub login_ok_password ($$) {
92     my ($c, $r) = @_;
93     my $username_params = $r->{S}{username_param_names};
94     my $username = $r->_ch('get_param',$username_params->[0]);
95     my $password = $r->_rp('password_param_name');
96     my $error = $r->_ch('username_password_error', $username, $password);
97     return defined($error) ? (undef,$error) : ($username,undef);
98 }
99
100 sub do_redirect_cgi ($$$$) {
101     my ($c, $r, $new_url, $cookie) = @_;
102     $r->_print($c->header($r->_cgi_header_args($cookie,
103                                                -status => '303 See other',
104                                                -location => $new_url)),
105                $r->_ch('gen_start_html',$r->_gt('Redirection')),
106                '<a href="'.escapeHTML($new_url).'">',
107                $r->_gt("If you aren't redirected, click to continue."),
108                "</a>",
109                $r->_ch('gen_end_html'));
110 }
111
112 sub gen_some_form ($$) {
113     my ($r, $params, $bodyfn) = @_;
114     # Calls $bodyfn->($c,$r) which returns @formbits
115     my $c = $r->{Cgi};
116     my @form;
117     my $pathinfo = '';
118     $pathinfo .= $params->{''}[0] if $params->{''};
119     push @form, ('<form method="POST" action="'.
120                  escapeHTML($r->_ch('get_url').$pathinfo).'">');
121     push @form, $bodyfn->($c,$r);
122     foreach my $n (keys %$params) {
123         next if $n eq '';
124         foreach my $val (@{ $params->{$n} }) {
125             push @form, ('<input type="hidden"'.
126                          ' name="'.escapeHTML($n).'"'.
127                          ' value="'.escapeHTML($val).'">');
128         }
129     }
130     push @form, ('</form>');
131     return join "\n", @form;
132 }
133
134 sub gen_plain_login_form ($$) {
135     my ($c,$r, $params) = @_;
136     return $r->gen_some_form($params, sub {
137         my @form;
138         push @form, ('<table>');
139         my $sz = 'size="'.$r->{S}{form_entry_size}.'"';
140         foreach my $up (@{ $r->{S}{username_param_names}}) {
141             push @form, ('<tr><td>',$r->_gt(ucfirst $up),'</td>',
142                          '<td><input type="text" '.$sz.
143                          ' name='.$up.'></td></tr>');
144         }
145         push @form, ('<tr><td>'.$r->_gt('Password').'</td>',
146                      '<td><input type="password" '.$sz.
147                      ' name="'.$r->{S}{password_param_name}.'"></td></tr>');
148         push @form, ('<tr><td colspan="2">',
149                      '<input type="submit"'.
150                      ' name="'.$r->{S}{dummy_param_name_prefix}.'login"'.
151                      ' value="'.$r->_gt('Login').'"></td></tr>',
152                      '</table>');
153         return @form;
154     });
155 }
156
157 sub gen_postmainpage_form ($$$) {
158     my ($c,$r, $params) = @_;
159     return $r->gen_some_form($params, sub {
160         my @form;
161         push @form, ('<input type="submit"',
162                      ' name="'.$r->{S}{dummy_param_name_prefix}.'submit"'.
163                      ' value="'.$r->_gt('Continue').'">');
164         return @form;
165     });
166 }
167
168 sub gen_plain_login_link ($$) {
169     my ($c,$r, $params) = @_;
170     my $url = $r->url_with_query_params($params);
171     return ('<a href="'.escapeHTML($url).'">'.
172             $r->_gt('Log in again to continue.').
173             '</a>');
174 }
175
176 #---------- verifier object methods ----------
177
178 sub new_verifier {
179     my $class = shift;
180     my $verifier = {
181         S => {
182             dir => undef,
183             assocdb_path => 'caf-assocs.db',
184             keys_path => 'caf-keys',
185             assocdb_dsn => undef,
186             assocdb_user => '',
187             assocdb_password => '',
188             assocdb_table => 'caf_assocs',
189             random_source => '/dev/urandom',
190             secretbits => 128, # bits
191             hash_algorithm => "SHA-256",
192             login_timeout => 86400, # seconds
193             login_form_timeout => 3600, # seconds
194             key_rollover => 86400, # seconds
195             assoc_param_name => 'caf_assochash',
196             dummy_param_name_prefix => 'caf__',
197             cookie_name => "caf_assocsecret",
198             password_param_name => 'password',
199             username_param_names => [qw(username)],
200             form_entry_size => 60,
201             logout_param_names => [qw(caf_logout)],
202             loggedout_param_names => [qw(caf_loggedout)],
203             promise_check_mutate => 0,
204             get_param => sub { $_[0]->param($_[2]) },
205             get_params => sub { $_[1]->get_params() },
206             get_path_info => sub { $_[0]->path_info() },
207             get_cookie => sub { $_[0]->cookie($_[1]->{S}{cookie_name}) },
208             get_method => sub { $_[0]->request_method() },
209             get_url => sub { $_[0]->url(); },
210             is_login => sub { defined $_[1]->_rp('password_param_name') },
211             login_ok => \&login_ok_password,
212             username_password_error => sub { die },
213             is_logout => sub { $_[1]->has_a_param('logout_param_names') },
214             is_loggedout => sub { $_[1]->has_a_param('loggedout_param_names') },
215             is_page => sub { return 1 },
216             handle_divert => sub { return 0 },
217             do_redirect => \&do_redirect_cgi, # this hook is allowed to throw
218             cookie_path => "/",
219             get_cookie_domain => \&get_cookie_domain,
220             encrypted_only => 1,
221             gen_start_html => sub { $_[0]->start_html($_[2]); },
222             gen_end_html => sub { $_[0]->end_html(); },
223             gen_login_form => \&gen_plain_login_form,
224             gen_login_link => \&gen_plain_login_link,
225             gen_postmainpage_form => \&gen_postmainpage_form,
226             gettext => sub { gettext($_[2]); },
227             print => sub { print $_[2] or die $!; },
228         },
229         Dbh => undef,
230     };
231     my ($k,$v);
232     while (($k,$v,@_) = @_) {
233         die "unknown setting $k" unless exists $verifier->{S}{$k};
234         $verifier->{S}{$k} = $v;
235     }
236     bless $verifier, $class;
237     $verifier->_dbopen();
238     return $verifier;
239 }
240
241 sub _db_setup_do ($$) {
242     my ($v, $sql) = @_;
243     my $dbh = $v->{Dbh};
244     eval {
245         $v->_db_transaction(sub {
246             local ($dbh->{PrintError}) = 0;
247             $dbh->do($sql);
248         });
249     };
250 }
251
252 sub _dbopen ($) {
253     my ($v) = @_;
254     my $dbh = $v->{Dbh};
255     return $dbh if $dbh; 
256
257     $v->{S}{assocdb_dsn} ||= "dbi:SQLite:dbname=".$v->_get_path('assocdb');
258     my $dsn = $v->{S}{assocdb_dsn};
259
260     my $u = umask 077;
261     $dbh = DBI->connect($dsn, $v->{S}{assocdb_user}, 
262                         $v->{S}{assocdb_password}, { 
263                             AutoCommit => 0,
264                             RaiseError => 1,
265                             ShowErrorStatement => 1,
266                         });
267     die "$dsn $! ?" unless $dbh;
268     $v->{Dbh} = $dbh;
269
270     $v->_db_setup_do("CREATE TABLE $v->{S}{assocdb_table} (".
271                      " assochash VARCHAR PRIMARY KEY,".
272                      " username VARCHAR NOT NULL,".
273                      " last INTEGER NOT NULL".
274                      ")");
275     $v->_db_setup_do("CREATE INDEX $v->{S}{assocdb_table}_timeout_index".
276                      " ON $v->{S}{assocdb_table}".
277                      " (last)");
278     return $dbh;
279 }
280
281 sub disconnect ($) {
282     my ($v) = @_;
283     my $dbh = $v->{Dbh};
284     return unless $dbh;
285     $dbh->disconnect();
286 }
287
288 sub _db_transaction ($$) {
289     my ($v, $fn) = @_;
290     my $retries = 10;
291     my $rv;
292     my $dbh = $v->{Dbh};
293 print STDERR "DT entry\n";
294     for (;;) {
295 print STDERR "DT loop\n";
296         if (!eval {
297             $rv = $fn->();
298 print STDERR "DT fn ok\n";
299             1;
300         }) {
301 print STDERR "DT fn error\n";
302             { local ($@); $dbh->rollback(); }
303 print STDERR "DT fn throwing\n";
304             die $@;
305         }
306 print STDERR "DT fn eval ok\n";
307         if (eval {
308             $dbh->commit();
309 print STDERR "DT commit ok\n";
310             1;
311         }) {
312 print STDERR "DT commit eval ok ",Dumper($rv);
313             return $rv;
314         }
315 print STDERR "DT commit throw?\n";
316         die $@ if !--$retries;
317 print STDERR "DT loop again\n";
318     }
319 }
320
321 #---------- request object methods ----------
322
323 sub new_request {
324     my ($classbase, $cgi, @extra) = @_;
325     if (!ref $classbase) {
326         $classbase = $classbase->new_verifier(@extra);
327     } else {
328         die if @extra;
329     }
330     my $r = {
331         V => $classbase,
332         S => $classbase->{S},
333         Dbh => $classbase->{Dbh},
334         Cgi => $cgi,
335     };
336     bless $r, ref $classbase;
337 }
338
339 sub _ch ($$@) { # calls an application hook
340     my ($r,$methname, @args) = @_;
341     my $methfunc = $r->{S}{$methname};
342     die "$methname ?" unless $methfunc;
343     return $methfunc->($r->{Cgi}, $r, @args);
344 }
345
346 sub _rp ($$@) {
347     my ($r,$pnvb) = @_;
348     my $pn = $r->{S}{$pnvb};
349     my $p = scalar $r->_ch('get_param',$pn)
350 }
351
352 sub _get_path ($$) {
353     my ($v,$keybase) = @_;
354     my $leaf = $v->{S}{"${keybase}_path"};
355     my $dir = $v->{S}{dir};
356     return $leaf if $leaf =~ m,^/,;
357     die "relying on cwd by default ?!  set dir" unless defined $dir;
358     return "$dir/$leaf";
359 }
360
361 sub _gt ($$) { my ($r, $t) = @_; return $r->_ch('gettext',$t); }
362 sub _print ($$) { my ($r, @t) = @_; return $r->_ch('print', join '', @t); }
363
364 sub construct_cookie ($$$) {
365     my ($r, $cooks) = @_;
366     return undef unless $cooks;
367     my $c = $r->{Cgi};
368 my @ca = (-name => $r->{S}{cookie_name},
369                              -value => $cooks,
370                              -path => $r->{S}{cookie_path},
371                              -domain => $r->_ch('get_cookie_domain'),
372                              -expires => '+'.$r->{S}{login_timeout}.'s',
373                              -secure => $r->{S}{encrypted_only});
374     my $cookie = $c->cookie(@ca);
375 print STDERR "CC $r $c $cooks $cookie (@ca).\n";
376     return $cookie;
377 }
378
379 # pages/param-sets are
380 #   n normal non-mutating page
381 #   r retrieval of information for JS, non-mutating
382 #   m mutating page
383 #   u update of information by JS, mutating
384 #   i login
385 #   o logout
386 #   O "you have just logged out" page load
387
388 # in cook and par,
389 #    -         no value supplied (represented in code as $cookt='')
390 #    n, nN     value not in our db
391 #    t, tN     temporary value (in our db, no logged in user yet)
392 #    y, yN     value corresponds to logged-in user
393 # and, aggregated conditions:
394 #    a, aN     anything including -
395 #    x, xN     t or y
396 # if N differs the case applies only when the two values differ
397 # (eg,   a1 y2   does not apply when the logged-in value is supplied twice)
398
399 # "stale session" means request originates from a page from a login
400 # session which has been revoked (eg by logout); "cleared session"
401 # means request originates from a browser which has a different (or
402 # no) cookie.
403
404     # Case analysis, cookie mode, app promises re mutate:
405     # cook parm meth form
406     #                      
407     #  any -   POST  nrmuoi   bug or attack, fail
408     #  any -   GET    rmuoi   bug or attack, fail
409     #  any any GET     muoi   bug or attack, fail
410     #  any t   any   nrmu     bug or attack, fail
411     #
412     #  -   -   GET         O  "just logged out" page
413     #  (any other)         O  bug or attack, fail
414     #
415     #  a1  a2  POST      o    logout
416     #                           if a1 is valid, revoke it
417     #                           if a2 is valid, revoke it
418     #                           delete cookie
419     #                           redirect to "just logged out" page
420     #                             (which contains link to login form)
421     #
422     #  -   t   POST       i   complain about cookies being disabled
423     #                           (with link to login form)
424     #
425     #  t1  t1  POST       i   login (or switch user)
426     #                           if bad
427     #                             show new login form
428     #                           if good
429     #                             upgrade t1 to y1 in our db (setting username)
430     #                             redirect to GET of remaining params
431     #
432     #  y1  a2  POST       i   complain about stale login form
433     #                           revoke y1
434     #                           show new login form
435     #                           
436     #  (other) POST       i   complain about stale login form
437     #                           show new login form
438     #
439     #  t1  a2  ANY   nrmu     treat as  - a2 ANY
440     #
441     #  y   -   GET   n        cross-site link
442     #                           show data
443     #
444     #  y   y   GET   nr       fine, show page or send data
445     #  y   y   POST  nrmu     mutation is OK, do operation
446     #
447     #  y1  y2  GET   nr       request from stale page
448     #                           do not revoke y2 as not RESTful
449     #                           treat as   y1 n GET
450     #
451     #  y1  y2  POST  nrmu     request from stale page
452     #                           revoke y2
453     #                           treat as   y1 n POST
454     #
455     #  y   n   GET   n        intra-site link from stale page,
456     #                           treat as cross-site link, show data
457     #
458     #  y   n   POST  n m      intra-site form submission from stale page
459     #                           show "session interrupted"
460     #                           with link to main data page
461     #
462     #  y   n   GET    r       intra-site request from stale page
463     #                           fail
464     #
465     #  y   n   POST   r u     intra-site request from stale page
466     #                           fail
467     #
468     #  -/n y2  GET   nr       intra-site link from cleared session
469     #                           do not revoke y2 as not RESTful
470     #                           treat as   -/n n GET
471     #
472     #  -/n y2  POST  nrmu     request from cleared session
473     #                           revoke y2
474     #                           treat as   -/n n POST
475     #
476     #  -/n -/n GET   n        cross-site link but user not logged in
477     #                           show login form with redirect to orig params
478     #                           generate fresh cookie
479     #
480     #  -/n n   GET    rmu     user not logged in
481     #                           fail
482     #
483     #  -/n n   POST  n m      user not logged in
484     #                           show login form
485     #
486     #  -/n n   POST   r u     user not logged in
487     #                           fail
488
489 sub _check_divert_core ($) {
490     my ($r) = @_;
491
492     my $meth = $r->_ch('get_method');
493     my $cooks = $r->_ch('get_cookie');
494     my $parmh = $r->_rp('assoc_param_name');
495     my $cookh = defined $cooks ? $r->hash($cooks) : undef;
496
497     my ($cookt,$cooku) = $r->_identify($cookh, $cooks);
498     my $parms = (defined $cooks && defined $parmh && $parmh eq $cookh)
499         ? $cooks : undef;
500     my ($parmt) = $r->_identify($parmh, $parms);
501
502     print STDERR "_c_d_c cookt=$cookt parmt=$parmt\n";
503
504     if ($r->_ch('is_logout')) {
505         $r->_must_be_post();
506         die unless $parmt;
507         $r->_db_revoke($cookh);
508         $r->_db_revoke($parmh);
509         return ({ Kind => 'REDIRECT-LOGGEDOUT',
510                   Message => $r->_gt("Logging out..."),
511                   CookieSecret => '',
512                   Params => { } });
513     }
514     if ($r->_ch('is_loggedout')) {
515         die unless $meth eq 'GET';
516         die unless $cookt;
517         die unless $parmt;
518         return ({ Kind => 'SMALLPAGE-LOGGEDOUT',
519                   Message => $r->_gt("You have been logged out."),
520                   CookieSecret => '',
521                   Params => { } });
522     }
523     if ($r->_ch('is_login')) {
524         $r->_must_be_post();
525         die unless $parmt;
526         if (!$cookt && $parmt eq 't') {
527             return ({ Kind => 'SMALLPAGE-NOCOOKIE',
528                       Message => $r->_gt("You do not seem to have cookies".
529                                          " enabled.  You must enable cookies".
530                                          " as we use them for login."),
531                       CookieSecret => $r->_fresh_secret(),
532                       Params => $r->chain_params() })
533         }
534         if (!$cookt || $cookt eq 'n' || $cookh ne $parmh) {
535             $r->_db_revoke($cookh);
536             return ({ Kind => 'LOGIN-STALE',
537                       Message => $r->_gt("Stale session;".
538                                          " you need to log in again."),
539                       CookieSecret => $r->_fresh_secret(),
540                       Params => { } })
541         }
542         die unless $parmt eq 't' || $parmt eq 'y';
543         my ($username, $login_errormessage) = $r->_ch('login_ok');
544         unless (defined $username && length $username) {
545             $login_errormessage = $r->_gt("Incorrect username/password.")
546                 if !$login_errormessage;
547             return ({ Kind => 'LOGIN-BAD',
548                       Message => $login_errormessage,
549                       CookieSecret => $cooks,
550                       Params => $r->chain_params() })
551         }
552         $r->_db_record_login_ok($parmh,$username);
553         return ({ Kind => 'REDIRECT-LOGGEDIN',
554                   Message => $r->_gt("Logging in..."),
555                   CookieSecret => $cooks,
556                   Params => $r->chain_params() });
557     }
558     if ($cookt eq 't') {
559         $cookt = '';
560     }
561     die if $parmt eq 't';
562
563     if ($cookt eq 'y' && $parmt eq 'y' && $cookh ne $parmh) {
564         $r->_db_revoke($parmh) if $meth eq 'POST';
565         $parmt = 'n';
566     }
567
568     if ($cookt ne 'y') {
569         die unless !$cookt || $cookt eq 'n';
570         die unless !$parmt || $parmt eq 'n' || $parmt eq 'y';
571         my $news = $r->_fresh_secret();
572         if ($meth eq 'GET') {
573             return ({ Kind => 'LOGIN-INCOMINGLINK',
574                       Message => $r->_gt("You need to log in."),
575                       CookieSecret => $news,
576                       Params => $r->chain_params() });
577         } else {
578             $r->_db_revoke($parmh);
579             return ({ Kind => 'LOGIN-FRESH',
580                       Message => $r->_gt("You need to log in."),
581                       CookieSecret => $news,
582                       Params => { } });
583         }
584     }
585
586     if (!$r->{S}{promise_check_mutate}) {
587         if ($meth ne 'POST') {
588             return ({ Kind => 'MAINPAGEONLY',
589                       Message => $r->_gt('Entering via cross-site link.'),
590                       CookieSecret => $cooks,
591                       Params => { } });
592             # NB caller must then ignore params & path!
593             # if this is too hard they can spit out a small form
594             # with a "click to continue"
595         }
596     }
597
598     die unless $cookt eq 'y';
599     unless ($r->{S}{promise_check_mutate} && $meth eq 'GET') {
600         die unless $parmt eq 'y';
601         die unless $cookh eq $parmh;
602     }
603     $r->{AssocSecret} = $cooks;
604     $r->{UserOK} = $cooku;
605     print STDERR "C-D-C OK\n";
606     return undef;
607 }
608
609 sub chain_params ($) {
610     my ($r) = @_;
611     my %p = %{ $r->_ch('get_params') };
612     foreach my $pncn (keys %{ $r->{S} }) {
613         my $names;
614         if ($pncn =~ m/_param_name$/) {
615             my $name = $r->{S}{$pncn};
616             die "$pncn ?" if ref $name;
617             $names = [ $name ];
618         } elsif ($pncn =~ m/_param_names$/) {
619             $names = $r->{S}{$pncn};
620         } else {
621             next;
622         }
623         foreach my $name (@$names) {
624             delete $p{$name};
625         }
626     }
627     my $dummy_prefix = $r->{S}{dummy_param_name_prefix};
628     foreach my $name (grep /^$dummy_prefix/, keys %p) {
629         delete $p{$name};
630     }
631     die if exists $p{''};
632     $p{''} = [ $r->_ch('get_path_info') ];
633     return \%p;
634 }
635
636 sub _identify ($$) {
637     my ($r,$h,$s) = @_;
638     # returns ($t,$username)
639     # where $t is one of "t" "y" "n", or "" (for -)
640     # either $s must be undef, or $h eq $r->hash($s)
641
642 print STDERR "_identify\n";
643     return '' unless defined $h && length $h;
644 print STDERR "_identify h=$h s=".(defined $s ? $s : '<undef>')."\n";
645
646     my $dbh = $r->{Dbh};
647
648     $dbh->do("DELETE FROM $r->{S}{assocdb_table}".
649              " WHERE last < ?", {},
650              time - $r->{S}{login_timeout});
651
652     my $row = $dbh->selectrow_arrayref("SELECT username, last".
653                               " FROM $r->{S}{assocdb_table}".
654                               " WHERE assochash = ?", {}, $h);
655     if (defined $row) {
656 print STDERR "_identify h=$h s=$s YES @$row\n";
657         my ($nusername, $nlast) = @$row;
658         return ('y', $nusername);
659     }
660
661     # Well, it's not in the database.  But maybe it's a hash of a
662     # temporary secret.
663
664     return 'n' unless defined $s;
665
666     my ($keyt, $signature, $message, $noncet, $nonce) =
667         $s =~ m/^(\d+)\.(\w+)\.((\d+)\.(\w+))$/ or die;
668
669     return 'n' if time > $noncet + $r->{S}{login_form_timeout};
670
671 print STDERR "_identify noncet=$noncet ok\n";
672
673     my $keys = $r->_open_keys();
674     while (my ($rkeyt, $rkey, $line) = $r->_read_key($keys)) {
675 print STDERR "_identify  search rkeyt=$rkeyt rkey=$rkey\n";
676         last if $rkeyt < $keyt; # too far down in the file
677         my $trysignature = $r->_hmac($rkey, $message);
678 print STDERR "_identify  search rkeyt=$rkeyt rkey=$rkey trysig=$trysignature\n";
679         return 't' if $trysignature eq $signature;
680     }
681     # oh well
682 print STDERR "_identify NO\n";
683
684     $keys->error and die $!;
685     return 'n';
686 }
687
688 sub _db_revoke ($$) {
689     # revokes $h if it's valid; no-op if it's not
690     my ($r,$h) = @_;
691
692     my $dbh = $r->{Dbh};
693
694     $dbh->do("DELETE FROM $r->{S}{assocdb_table}".
695              " WHERE assochash = ?", {}, $h);
696 }
697
698 sub _db_record_login_ok ($$$) {
699     my ($r,$h,$user) = @_;
700     $r->_db_revoke($h);
701     my $dbh = $r->{Dbh};
702     $dbh->do("INSERT INTO $r->{S}{assocdb_table}".
703              " (assochash, username, last) VALUES (?,?,?)", {},
704              $h, $user, time);
705 }
706
707 sub check_divert ($) {
708     my ($r) = @_;
709     if (exists $r->{Divert}) {
710         return $r->{Divert};
711     }
712     my $dbh = $r->{Dbh};
713     $r->{Divert} = $r->_db_transaction(sub { $r->_check_divert_core(); });
714     $dbh->commit();
715     print STDERR Dumper($r->{Divert});
716     return $r->{Divert};
717 }
718
719 sub get_divert ($) {
720     my ($r) = @_;
721     die "unchecked" unless exists $r->{Divert};
722     return $r->{Divert};
723 }
724
725 sub get_username ($) {
726     my ($r) = @_;
727     my $divert = $r->get_divert();
728     return undef if $divert;
729     return $r->{UserOK};
730 }
731
732 sub url_with_query_params ($$) {
733     my ($r, $params) = @_;
734 print STDERR "PARAMS ",Dumper($params);
735     my $uri = URI->new($r->_ch('get_url'));
736     $uri->path($uri->path() . $params->{''}[0]) if $params->{''};
737     $uri->query_form(flatten_params($params));
738     return $uri->as_string();
739 }
740
741 sub _cgi_header_args ($$@) {
742     my ($r, $cookie, @ha) = @_;
743     unshift @ha, qw(-type text/html);
744     push @ha, (-cookie => $cookie) if defined $cookie;
745     print STDERR "_cgi_header_args ",join('|',@ha),".\n";
746     return @ha;
747 }
748
749 sub check_ok ($) {
750     my ($r) = @_;
751
752     my ($divert) = $r->check_divert();
753     return 1 if !$divert;
754
755     my $handled = $r->_ch('handle_divert',$divert);
756     return 0 if $handled;
757
758     my $kind = $divert->{Kind};
759     my $cookiesecret = $divert->{CookieSecret};
760     my $params = $divert->{Params};
761     my $cookie = $r->construct_cookie($cookiesecret);
762
763     if ($kind =~ m/^REDIRECT-/) {
764         # for redirects, we honour stored NextParams and SetCookie,
765         # as we would for non-divert
766         if ($kind eq 'REDIRECT-LOGGEDOUT') {
767             $params->{$r->{S}{loggedout_param_names}[0]} = [ 1 ];
768         } elsif ($kind eq 'REDIRECT-LOGOUT') {
769             $params->{$r->{S}{logout_param_names}[0]} = [ 1 ];
770         } elsif ($kind eq 'REDIRECT-LOGGEDIN') {
771         } else {
772             die;
773         }
774         my $new_url = $r->url_with_query_params($params);
775         $r->_ch('do_redirect',$new_url, $cookie);
776         return 0;
777     }
778
779     if (defined $cookiesecret) {
780         $params->{$r->{S}{assoc_param_name}} = [ $r->hash($cookiesecret) ];
781     }
782
783     my ($title, @body);
784     if ($kind =~ m/^LOGIN-/) {
785         $title = $r->_gt('Login');
786         push @body, $divert->{Message};
787         push @body, $r->_ch('gen_login_form', $params);
788     } elsif ($kind =~ m/^SMALLPAGE-/) {
789         $title = $r->_gt('Not logged in');
790         push @body, $divert->{Message};
791         push @body, $r->_ch('gen_login_link', $params);
792     } elsif ($kind =~ m/^MAINPAGEONLY$/) {
793         $title = $r->_gt('Entering secure site.');
794         push @body, $divert->{Message};
795         push @body, $r->_ch('gen_postmainpage_form', $params);
796     } else {
797         die $kind;
798     }
799
800     $r->_print($r->{Cgi}->header($r->_cgi_header_args($cookie)),
801                $r->_ch('gen_start_html',$title),
802                (join "\n", @body),
803                $r->_ch('gen_end_html'));
804     return 0;
805 }
806
807 sub _random ($$) {
808     my ($r, $bytes) = @_;
809     my $v = $r->{V};
810     my $rsf = $v->{RandomHandle};
811     my $rsp = $r->{S}{random_source};
812     if (!$rsf) {
813         $v->{RandomHandle} = $rsf = new IO::File $rsp, '<' or die "$rsp $!";
814 print STDERR "RH $rsf\n";
815     }
816     my $bin;
817     $!=0;
818     read($rsf,$bin,$bytes) == $bytes or die "$rsp $!";
819     my $out = unpack "H*", $bin;
820     print STDERR "_random out $out\n";
821     return $out;
822 }
823
824 sub _random_key ($) {
825     my ($r) = @_;
826     print STDERR "_random_key\n";
827     my $bytes = ($r->{S}{secretbits} + 7) >> 3;
828     return $r->_random($bytes);
829 }
830
831 sub _read_key ($$) {
832     my ($r, $keys) = @_;
833     # returns $gen_time_t, $key_value_in_hex, $complete_line
834     while (<$keys>) {
835         my ($gen, $k) = m/^(\d+) (\S+)$/ or die "$_ ?";
836         my $age = time - $gen;
837         next if $age > $r->{S}{key_rollover} &&
838             $age > $r->{S}{login_form_timeout}*2;
839         return ($gen, $k, $_);
840     }
841     return ();
842 }
843
844 sub _open_keys ($) {
845     my ($r) = @_;
846     my $spath = $r->_get_path('keys');
847     for (;;) {
848  print STDERR "_open_keys\n";
849         my $keys = new IO::File $spath, 'r+';
850         if ($keys) {
851  print STDERR "_open_keys open\n";
852             stat $keys or die $!; # NB must not disturb stat _
853             my $size = (stat _)[7];
854             my $age = time - (stat _)[9];
855  print STDERR "_open_keys open size=$size age=$age\n";
856             return $keys
857                 if $size && $age <= $r->{S}{key_rollover} / 2;
858  print STDERR "_open_keys open bad\n";
859         }
860         # file doesn't exist, or is empty or too old
861         if (!$keys) {
862  print STDERR "_open_keys closed\n";
863             die "$spath $!" unless $!==&ENOENT;
864             # doesn't exist, so create it just so we can lock it
865             $keys = new IO::File $spath, 'a+';
866             die "$keys $!" unless $keys;
867             stat $keys or die $!; # NB must not disturb stat _
868             my $size = (stat _)[7];
869  print STDERR "_open_keys created size=$size\n";
870             next if $size; # oh someone else has done it, reopen and read it
871         }
872         # file now exists is empty or too old, we must try to replace it
873         my $our_inum = (stat _)[1]; # last use of that stat _
874         flock $keys, LOCK_EX or die "$spath $!";
875         stat $spath or die "$spath $!";
876         my $path_inum = (stat _)[1];
877  print STDERR "_open_keys locked our=$our_inum path=$path_inum\n";
878         next if $our_inum != $path_inum; # someone else has done it
879         # We now hold the lock!
880  print STDERR "_open_keys creating\n";
881         my $newkeys = new IO::Handle;
882         sysopen $newkeys, "$spath.new", O_CREAT|O_TRUNC|O_WRONLY, 0600
883             or die "$spath.new $!";
884         # we add the new key to the front which means it's always sorted
885         print $newkeys time, ' ', $r->_random_key(), "\n" or die $!;
886         while (my ($gen,$key,$line) = $r->_read_key($keys)) {
887  print STDERR "_open_keys copy1\n";
888             print $newkeys, $line or die $!;
889         }
890         $keys->error and die $!;
891         close $newkeys or die "$spath.new $!";
892         rename "$spath.new", "$spath" or die "$spath: $!";
893  print STDERR "_open_keys installed\n";
894         # that rename effective unlocks, since it makes the name refer
895         #  to the new file which we haven't locked
896         # we go round again opening the file at the beginning
897         #  so that our caller gets a fresh handle onto the existing key file
898     }
899 }
900
901 sub _fresh_secret ($) {
902     my ($r) = @_;
903     print STDERR "_fresh_secret\n";
904
905     my $keys = $r->_open_keys();
906     my ($keyt, $key) = $r->_read_key($keys);
907     die unless defined $keyt;
908
909     my $nonce = $r->_random_key();
910     my $noncet = time;
911     my $message = "$noncet.$nonce";
912
913     my $signature = $r->_hmac($key, $message);
914     my $secret = "$keyt.$signature.$message";
915     print STDERR "FRESH $secret\n";
916     return $secret;
917 }
918
919 sub _hmac ($$$) {
920     my ($r, $keyhex, $message) = @_;
921     my $keybin = pack "H*", $keyhex;
922     my $alg = $r->{S}{hash_algorithm};
923 print STDERR "hmac $alg\n";
924     my $base = new Digest $alg;
925 print STDERR "hmac $alg $base\n";
926     my $digest = new Digest::HMAC $keybin, $base;
927 print STDERR "hmac $alg $base $digest\n";
928     $digest->add($message);
929     return $digest->hexdigest();
930 }
931
932 sub hash ($$) {
933     my ($r, $message) = @_;
934     my $alg = $r->{S}{hash_algorithm};
935 print STDERR "hash $alg\n";
936     my $digest = new Digest $alg;
937     $digest->add($message);
938     return $digest->hexdigest();
939 }
940
941 sub _assert_checked ($) {
942     my ($r) = @_;
943     die "unchecked" unless exists $r->{Divert};
944 }
945
946 sub _is_post ($) {
947     my ($r) = @_;
948     my $meth = $r->_ch('get_method');
949     return $meth eq 'POST';
950 }
951
952 sub _must_be_post ($) {
953     my ($r) = @_;
954     my $meth = $r->_ch('get_method');
955     die "mutating non-POST" if $meth ne 'POST';
956 }
957
958 sub check_mutate ($) {
959     my ($r) = @_;
960     $r->_assert_checked();
961     die if $r->{Divert};
962     $r->_must_be_post();
963 }
964
965 sub mutate_ok ($) {
966     my ($r) = @_;
967     $r->_assert_checked();
968     die if $r->{Divert};
969     return $r->_is_post();
970 }
971
972 #---------- output ----------
973
974 sub secret_cookie_val ($) {
975     my ($r) = @_;
976     $r->_assert_checked();
977     return defined $r->{AssocSecret} ? $r->{AssocSecret} : '';
978 }
979
980 sub secret_hidden_val ($) {
981     my ($r) = @_;
982     $r->_assert_checked();
983     return defined $r->{AssocSecret} ? $r->hash($r->{AssocSecret}) : '';
984 }
985
986 sub secret_hidden_html ($) {
987     my ($r) = @_;
988     return $r->{Cgi}->hidden(-name => $r->{S}{assoc_param_name},
989                              -default => $r->secret_hidden_val());
990 }
991
992 sub secret_cookie ($) {
993     my ($r) = @_;
994     my $secret = $r->secret_cookie_val();
995     return undef if !defined $secret;
996 #print STDERR "SC\n";
997     my $cookv = $r->construct_cookie($secret); 
998 #print STDERR "SC=$cookv\n";
999     return $cookv;
1000 }
1001
1002 __END__
1003
1004 =head1 NAME
1005
1006 CGI::Auth::Flexible - web authentication optionally using cookies
1007
1008 =head1 SYNOPSYS
1009
1010  my $verifier = CGI::Auth::Flexible->new_verifier(setting => value,...);
1011  my $authreq = $verifier->new_request($cgi_request_object);
1012
1013  my $authreq = CGI::Auth::Flexible->new_request($cgi_request_object,
1014                                               setting => value,...);
1015
1016 =head1 USAGE PATTERN FOR SIMPLE APPLICATIONS
1017
1018  $authreq->check_ok() or return;
1019
1020  blah blah blah
1021  $authreq->check_mutate();
1022  blah blah blah
1023
1024 =head1 USAGE PATTERN FOR FANCY APPLICATIONS
1025
1026  my $divert_kind = $authreq->check_divert();
1027  if ($divert_kind) {
1028      if ($divert_kind eq 'LOGGEDOUT') {
1029          print "goodbye you are now logged out" and quit
1030      } elsif ($divert_kind eq 'NOCOOKIES') {
1031          print "you need cookies" and quit
1032      ... etc.
1033      }
1034  }
1035
1036  blah blah blah
1037  $authreq->check_mutate();
1038  blah blah blah