cgi-auth-hybrid.pm

   1 # -*- perl -*-
   2
   3 # This is part of CGI::Auth::Hybrid, 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;
  22
  23 package CGI::Auth::Hybrid;
  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(setup);
  36 }
  37 our @EXPORT_OK;
  38
  39 use DBI;
  40 use CGI;
  41 use Locale::gettext;
  42
  43 #---------- public utilities ----------
  44
  45 sub flatten_params ($) {
  46     my ($p) = @_;
  47     my @p;
  48     foreach my $k (keys %$p) {
  49         foreach my $v (@{ $p->{$k} }) {
  50             push @p, $k, $v;
  51         }
  52     }
  53     return @p;
  54 }
  55
  56 #---------- default callbacks ----------
  57
  58 sub has_a_param ($$) {
  59     my ($r,$cn) = @_;
  60     foreach my $pn (@{ $r->{S}{$cn} }) {
  61         return 1 if $r->_cm('get_param',$pn);
  62     }
  63     return 0;
  64 }
  65
  66 sub get_params ($) {
  67     my ($r) = @_;
  68     my %p;
  69     my $c = $r->{Cgi};
  70     foreach my $name ($c->param()) {
  71         $p{$name} = [ $c->param($name) ];
  72     }
  73     return \%p;
  74 }
  75
  76 sub get_cookie_domain ($$$) {
  77     my ($c,$r) = @_;
  78     my $uri = new URI $r->_ch('get_url');
  79     return $uri->host();
  80 }
  81
  82 sub login_ok_password ($$) {
  83     my ($c, $r) = @_;
  84     my $username_params = $r->{S}{username_param_names};
  85     my $username = $r->_ch('get_param',$username_params->[0]);
  86     my $password = $r->_rp('password_param_name');
  87     return $r->_ch('username_password_ok', $username, $password);
  88 }
  89
  90 sub do_redirect_cgi ($$$$) {
  91     my ($c, $r, $new_url, $cookie) = @_;
  92     my @ha = ('text/html',
  93               -status => '303 See other',
  94               -location => $new_url);
  95     push @ha, (-cookie => $cookie) if defined $cookie;
  96     $r->_print($c->header(@ha),
  97                $r->_ch('gen_start_html',$r->_gt('Redirection')),
  98                '<a href="'.escapeHTML($new_url).'">',
  99                $r->_gt("If you aren't redirected, click to continue."),
 100                "</a>",
 101                $c->_ch('gen_end_html'));
 102 }
 103
 104 sub gen_plain_login_form ($$) {
 105     my ($c,$r, $params) = @_;
 106     my @form;
 107     push @form, ('<form method="POST" action="'.
 108                  escapeHTML($r->_ch('get_url')).'>'.
 109                  '<table>');
 110     my $sz = 'size="'.$r->{S}{form_entry_size}.'"';
 111     foreach my $up (@{ $r->{S}{username_param_names}}) {
 112         push @form, ('<tr><td>',$r->_gt(ucfirst $up),'</td>',
 113                      '<td><input type="text" ',$sz.
 114                      ' name=',$up,'></td></tr>');
 115     }
 116     push @form, ('<tr><td>'.$r->_gt('Password'),'</td>',
 117                  '<td><input type="password" '.$sz.
 118                  ' name="'.$r->{S}{password_param_name}.'"></td></tr>');
 119     push @form, ('<tr><td colspan="2">',
 120                  '<input type="submit"'.
 121                  ' name="'.$r->{S}{login_submit_name}.'"'.
 122                  ' value="'.$r->_gt('Login').'"></td></tr>',
 123                  '</table>');
 124     foreach my $n (keys %$params) {
 125         push @form, ('<input type="hidden"'.
 126                      ' name="'.$n.'"'.
 127                      ' value="'.$params->{$n}.'">');
 128     }
 129     push @form, ('</form>');
 130     return join "\n", @form;
 131 }
 132
 133 sub gen_login_link ($$) {
 134     my ($c,$r, $params) = @_;
 135     my $url = $r->url_with_query_params($params);
 136     return ('<a href="'.escapeHTML($url).'">'.
 137             $r->_gt('Log in again to continue.').
 138             '</a>');
 139 }
 140
 141 #---------- verifier object methods ----------
 142
 143 sub new_verifier {
 144     my $class = shift;
 145     my $verifier = {
 146         S => {
 147             assocdb_path => 'cah-assocs.db',
 148             assocdb_dsn => undef,
 149             assocdb_user => '',
 150             assocdb_password => '',
 151             assocdb_table => 'assocs',
 152             random_source => '/dev/urandom',
 153             associdlen => 128, # bits
 154             login_timeout => 86400, # seconds
 155             assoc_param_name => 'cah_associd',
 156             password_param_name => 'password',
 157             username_param_names => [qw(username)],
 158             form_entry_size => 60,
 159             logout_param_names => [qw(cah_logout)],
 160             login_submit_name => [qw(cah_login)],
 161             loggedout_param_names => [qw(cah_loggedout)],
 162             promise_check_mutate => 0,
 163             get_param => sub { $_[0]->param($_[2]) },
 164             get_params => sub { $_[1]->get_params() },
 165             get_cookie => sub { $_[0]->cookie($_[1]->{S}{cookie_name}) },
 166             get_method => sub { $_[0]->request_method() },
 167             get_url => sub { $_[0]->url(); },
 168             is_login => sub { defined $_[1]->_rp('password_param_name') },
 169             login_ok => \&login_ok_password,
 170             username_password_ok => sub { die },
 171             is_logout => sub { $_[1]->has_a_param('logout_param_names') },
 172             is_loggedout => sub { $_[1]->has_a_param('loggedout_param_names') },
 173             is_page => sub { return 1 },
 174             handle_divert => sub { return 0 },
 175             do_redirect => \&do_redirect_cgi, # this hook is allowed to throw
 176             cookie_path => "/",
 177             get_cookie_domain => \&get_cookie_domain,
 178             encrypted_only => 0,
 179             gen_start_html => sub { $_[0]->start_html($_[2]); },
 180             gen_end_html => sub { $_[0]->end_html(); },
 181             gen_login_form => \&gen_plain_login_form,
 182             gen_login_link => \&gen_plain_login_link,
 183             gettext => sub { gettext($_[2]); },
 184         },
 185         Dbh => undef,
 186     };
 187     my ($k,$v);
 188     while (($k,$v,@_) = @_) {
 189         die "unknown setting $k" unless exists $verifier->{S}{$k};
 190         $verifier->{S}{$k} = $v;
 191     }
 192     bless $verifier, $class;
 193     $verifier->_dbopen();
 194     return $verifier;
 195 }
 196
 197 sub _dbopen ($) {
 198     my ($v) = @_;
 199     my $dbh = $v->{Dbh};
 200     return $dbh if $dbh;
 201
 202     $v->{S}{assocdb_dsn} ||= "dbi:SQLite:dbname=$v->{S}{assocdb_path}";
 203     my $dsn = $v->{S}{assocdb_dsn};
 204
 205     my $u = umask 077;
 206     $dbh = DBI->connect($dsn, $v->{S}{assocdb_user},
 207                         $v->{S}{assocdb_password}, {
 208                             AutoCommit => 0, RaiseError => 1,
 209                         });
 210     die "$dsn $! ?" unless $dbh;
 211     $v->{Dbh} = $dbh;
 212
 213     eval {
 214         $v->_db_transaction(sub {
 215             $dbh->do("CREATE TABLE $v->{S}{assocdb_table} (".
 216                      " associd VARCHAR PRIMARY KEY,".
 217                      " username VARCHAR,".
 218                      " last INTEGER NOT NULL".
 219                      ")");
 220         });
 221     };
 222     return $dbh;
 223 }
 224
 225 sub disconnect ($) {
 226     my ($v) = @_;
 227     my $dbh = $v->{Dbh};
 228     return unless $dbh;
 229     $dbh->disconnect();
 230 }
 231
 232 sub _db_transaction ($$) {
 233     my ($v, $fn) = @_;
 234     my $retries = 10;
 235     my $rv;
 236     my $dbh = $v->{Dbh};
 237     for (;;) {
 238         if (!eval {
 239             $rv = $fn->();
 240             1;
 241         }) {
 242             { local ($@); $dbh->rollback(); }
 243             die $@;
 244         }
 245         if (eval {
 246             $dbh->commit();
 247             1;
 248         }) {
 249             return $rv;
 250         }
 251         die $@ if !--$retries;
 252     }
 253 }
 254
 255 #---------- request object methods ----------
 256
 257 sub new_request {
 258     my ($classbase, $cgi, @extra) = @_;
 259     if (!ref $classbase) {
 260         $classbase = $classbase->new_verifier(@extra);
 261     } else {
 262         die if @extra;
 263     }
 264     my $r = {
 265         V => $classbase,
 266         S => $classbase->{S},
 267         Dbh => $classbase->{Dbh},
 268         Cgi => $cgi,
 269     };
 270     bless $r, ref $classbase;
 271 }
 272
 273 sub _ch ($$@) { # calls an application hook
 274     my ($r,$methname, @args) = @_;
 275     my $methfunc = $r->{S}{$methname};
 276     return $methfunc->($r->{Cgi}, $r, @args);
 277 }
 278
 279 sub _rp ($$@) {
 280     my ($r,$pnvb) = @_;
 281     my $pn = $r->{S}{$pnvb};
 282     my $p = scalar $r->_ch('get_param',$pn)
 283 }
 284
 285 sub _gt ($$) { my ($r, $t) = @_; return $r->_ch('gettext',$t); }
 286 sub _print ($$) { my ($r, @t) = @_; return $r->_ch('print', join '', @t); }
 287
 288 sub construct_cookie ($$$) {
 289     my ($r, $cookv) = @_;
 290     return $r->{Cgi}->cookie(-name => $r->{S}{cookie_name},
 291                              -value => $cookv,
 292                              -path => $r->{S}{cookie_path},
 293                              -domain => $r->_ch('get_cookie_domain'),
 294                              -expires => '+'.$r->{S}{login_timeout}.'s',
 295                              -secure => $r->{S}{encrypted_only});
 296 }
 297
 298 # pages/param-sets are
 299 #   n normal non-mutating page
 300 #   r retrieval of information for JS, non-mutating
 301 #   m mutating page
 302 #   u update of information by JS, mutating
 303 #   i login
 304 #   o logout
 305 #   O "you have just logged out" page load
 306
 307 # in cook and par,
 308 #    a, aN     anything including -
 309 #    t, tN     temporary value (in our db, no logged in user yet)
 310 #    y, yN     value corresponds to logged-in user
 311 #    n, nN     value not in our db
 312 #    x, xN     t or y
 313 #    -         no value supplied
 314 # if N differs the case applies only when the two values differ
 315 # (eg,   a1 y2   does not apply when the logged-in value is supplied twice)
 316
 317 # "stale session" means request originates from a page from a login
 318 # session which has been revoked (eg by logout); "cleared session"
 319 # means request originates from a browser which has a different (or
 320 # no) cookie.
 321
 322     # Case analysis, cookie mode, app promises re mutate:
 323     # cook parm meth form
 324     #
 325     #  any -   POST  nrmuoi   bug or attack, fail
 326     #  any -   GET    rmuoi   bug or attack, fail
 327     #  any any GET     muoi   bug or attack, fail
 328     #  any t   any   nrmu     bug or attack, fail
 329     #
 330     #  -   -   GET         O  "just logged out" page
 331     #  (any other)         O  bug or attack, fail
 332     #
 333     #  a1  a2  POST      o    logout
 334     #                           if a1 is valid, revoke it
 335     #                           if a2 is valid, revoke it
 336     #                           delete cookie
 337     #                           redirect to "just logged out" page
 338     #                             (which contains link to login form)
 339     #
 340     #  -   t   POST       i   complain about cookies being disabled
 341     #                           (with link to login form)
 342     #
 343     #  any n   POST       i   complain about stale login form
 344     #                           show new login form
 345     #
 346     #  x1  t2  POST       i   login (or switch user)
 347     #                           if bad
 348     #                             show new login form
 349     #                           if good
 350     #                             revoke x1 if it was valid and !=t2
 351     #                             upgrade t2 to y2 in our db (setting username)
 352     #                             set cookie to t2
 353     #                             redirect to GET of remaining params
 354     #
 355     #  t1  a2  ANY   nrmu     treat as  - a2 ANY
 356     #
 357     #  y   -   GET   n        cross-site link
 358     #                           show data
 359     #
 360     #  y   y   GET   nr       fine, show page or send data
 361     #  y   y   POST  nrmu     mutation is OK, do operation
 362     #
 363     #  y1  y2  GET   nr       request from stale page
 364     #                           do not revoke y2 as not RESTful
 365     #                           treat as   y1 n GET
 366     #
 367     #  y1  y2  POST  nrmu     request from stale page
 368     #                           revoke y2
 369     #                           treat as   y1 n POST
 370     #
 371     #  y   n   GET   n        intra-site link from stale page,
 372     #                           treat as cross-site link, show data
 373     #
 374     #  y   n   POST  n m      intra-site form submission from stale page
 375     #                           show "session interrupted"
 376     #                           with link to main data page
 377     #
 378     #  y   n   GET    r       intra-site request from stale page
 379     #                           fail
 380     #
 381     #  y   n   POST   r u     intra-site request from stale page
 382     #                           fail
 383     #
 384     #  -/n y2  GET   nr       intra-site link from cleared session
 385     #                           do not revoke y2 as not RESTful
 386     #                           treat as   -/n n GET
 387     #
 388     #  -/n y2  POST  nrmu     request from cleared session
 389     #                           revoke y2
 390     #                           treat as   -/n n POST
 391     #
 392     #  -/n n   GET   n        cross-site link but user not logged in
 393     #                           show login form with redirect to orig params
 394     #
 395     #  -/n n   GET    rmu     user not logged in
 396     #                           fail
 397     #
 398     #  -/n n   POST  n m      user not logged in
 399     #                           show login form
 400     #
 401     #  -/n n   POST   r u     user not logged in
 402     #                           fail
 403
 404 sub _check_divert_core ($) {
 405     my ($r) = @_;
 406
 407     my $meth = $r->_ch('get_method');
 408     my $cookv = $r->_ch('get_cookie');
 409     my $parmv = $r->_rp('assoc_param_name');
 410
 411     my ($cookt,$cooku) = $r->_db_lookup($cookv);
 412     my $parmt = $r->_db_lookup($parmv);
 413
 414     if ($r->_ch('is_logout')) {
 415         $r->_must_be_post();
 416         die unless $parmt;
 417         $r->_db_revoke($cookv);
 418         $r->_db_revoke($parmv);
 419         return ({ Kind => 'REDIRECT-LOGGEDOUT',
 420                   Message => "Logging out...",
 421                   CookieVal => '',
 422                   Params => { } });
 423     }
 424     if ($r->_ch('is_loggedout')) {
 425         die unless $meth eq 'GET';
 426         die unless $cookt;
 427         die unless $parmt;
 428         return ({ Kind => 'SMALLPAGE-LOGGEDOUT',
 429                   Message => "You have been logged out.",
 430                   CookieVal => '',
 431                   Params => { } });
 432     }
 433     if ($r->_ch('is_login')) {
 434         $r->_must_be_post();
 435         return ({ Kind => 'LOGIN-STALE',
 436                   Message => "Stale session; you need to log in again.",
 437                   CookieVal => $r->_fresh_cookie(),
 438                   Params => { } })
 439             if $parmt eq 'n';
 440         die unless $parmt eq 't' || $parmt eq 'y';
 441         return ({ Kind => 'SMALLPAGE-NOCOOKIE',
 442                   Message => "You do not seem to have cookies enabled.  ".
 443                       "You must enable cookies as we use them for login.",
 444                   CookieVal => $r->_fresh_cookie(),
 445                   Params => $r->_chain_params() })
 446             if !$cookt && $parmt eq 't';
 447         my $username = $r->_ch('login_ok');
 448         return ({ Kind => 'LOGIN-BAD',
 449                   Message => "Incorrect username/password.",
 450                   CookieVal => $cookv,
 451                   Params => $r->_chain_params() })
 452             unless defined $username && length $username;
 453         $r->_db_revoke($cookv)
 454             if defined $cookv && !(defined $parmv && $cookv eq $parmv);
 455         $r->_db_record_login_ok($parmv,$username);
 456         return ({ Kind => 'REDIRECT-LOGGEDIN',
 457                   Message => "Logging in...",
 458                   CookieVal => $parmv,
 459                   Params => $r->_chain_params() });
 460     }
 461     if ($cookt eq 't') {
 462         $cookt = '';
 463     }
 464     die if $parmt eq 't';
 465
 466     if ($cookt eq 'y' && $parmt eq 'y' && $cookv ne $parmv) {
 467         $r->_db_revoke($parmv) if $meth eq 'POST';
 468         $parmt = 'n';
 469     }
 470
 471     if ($cookt ne 'y') {
 472         die unless !$cookt || $cookt eq 'n';
 473         die unless !$parmt || $parmt eq 'n' || $parmt eq 'y';
 474         if ($meth eq 'GET') {
 475             return ({ Kind => 'LOGIN-INCOMINGLINK',
 476                       Message => "You need to log in again.",
 477                       CookieVal => $parmv,
 478                       Params => $r->_chain_params() });
 479         } else {
 480             return ({ Kind => 'LOGIN-FRESH',
 481                       Message => "You need to log in again.",
 482                       CookieVal => $parmv,
 483                       Params => { } });
 484         }
 485     }
 486
 487     if (!$r->{S}{promise_check_mutate}) {
 488         if ($meth ne 'POST') {
 489             return ({ Kind => 'MAINPAGEONLY',
 490                       Message => 'Entering via cross-site link.',
 491                       CookieVal => $cookv,
 492                       Params => { } });
 493             # NB caller must then ignore params & path!
 494             # if this is too hard they can spit out a small form
 495             # with a "click to continue"
 496         }
 497     }
 498
 499     die unless $cookt eq 'y';
 500     die unless $parmt eq 'y';
 501     die unless $cookv eq $parmv;
 502     $r->{Assoc} = $cookv;
 503     $r->{UserOK} = $cooku;
 504     return undef;
 505 }
 506
 507 sub _chain_params ($) {
 508     my ($r) = @_;
 509     my %p = %{ $r->_ch('get_params') };
 510     foreach my $pncn (keys %{ $r->{S} }) {
 511         my $names;
 512         if ($pncn =~ m/_param_name$/) {
 513             my $name = $r->{S}{$pncn};
 514             die "$pncn ?" if ref $name;
 515             $names = [ $name ];
 516         } elsif ($pncn =~ m/_param_names$/) {
 517             $names = $r->{S}{$pncn};
 518         } else {
 519             next;
 520         }
 521         foreach my $name (@$names) {
 522             delete $p{$name};
 523         }
 524     }
 525     return \%p;
 526 }
 527
 528 sub _db_lookup ($$) {
 529     my ($r,$v) = @_;
 530     # returns ($t,$username)
 531     # where $t is one of "t" "y" "n", or "" (for -)
 532
 533     my $dbh = $r->{Dbh};
 534
 535     my $row = $dbh->selectrow_arrayref("SELECT username, last".
 536                               " FROM $r->{S}{assocdb_table}".
 537                               " WHERE associd = ?", {}, $v);
 538     return ('') unless defined $row;
 539
 540     my ($nusername, $nlast) = @$row;
 541
 542     my $timeout = $r->{S}{login_timeout};
 543     return ('n') unless !defined $timeout || time <= $nlast + $timeout;
 544
 545     return ('t') unless defined $nusername;
 546
 547     # hooray
 548     return ('y', $nusername);
 549 }
 550
 551 sub _db_revoke ($$) {
 552     # revokes $v if it's valid; no-op if it's not
 553     my ($r,$v) = @_;
 554
 555     my $dbh = $r->{Dbh};
 556
 557     $dbh->do("DELETE FROM $r->{S}{assocdb_table}".
 558              " WHERE associd = ?", {}, $v);
 559 }
 560
 561 sub _db_record_login_ok ($$$) {
 562     my ($r,$v,$user) = @_;
 563     $r->_db_revoke($v);
 564     my $dbh = $r->{Dbh};
 565     $dbh->do("INSERT INTO $r->{S}{assocdb_table}".
 566              " (associd, username, last) VALUES (?,?,?)", {},
 567              $v, $user, time);
 568 }
 569
 570 sub check_divert ($) {
 571     my ($r) = @_;
 572     my $divert;
 573     if (exists $r->{Divert}) {
 574         return $r->{Divert};
 575     }
 576     my $dbh = $r->{Dbh};
 577     $r->{Divert} = $r->_db_transaction(sub { $r->_check_divert_core(); });
 578     $dbh->commit();
 579     return $divert;
 580 }
 581
 582 sub get_divert ($) {
 583     my ($r) = @_;
 584     die "unchecked" unless exists $r->{Divert};
 585     return $r->{Divert};
 586 }
 587
 588 sub get_username ($) {
 589     my ($r) = @_;
 590     my $divert = $r->get_divert();
 591     return undef if $divert;
 592     return $r->{UserOK};
 593 }
 594
 595 sub url_with_query_params ($$) {
 596     my ($r, $params) = @_;
 597     my $uri = URI->new($r->_ch('get_url'));
 598     $uri->query_form(flatten_params($params));
 599     return $uri->as_string();
 600 }
 601
 602 sub check_ok ($) {
 603     my ($r) = @_;
 604
 605     my ($divert) = $r->check_divert();
 606     return 1 if $divert;
 607
 608     my $handled = $r->_ch('handle_divert',$divert);
 609     return 0 if $handled;
 610
 611     my $kind = $divert->{Kind};
 612     my $cookieval = $divert->{CookieVal};
 613     my $params = $divert->{Params};
 614
 615     if ($kind =~ m/^REDIRECT-/) {
 616         # for redirects, we honour stored NextParams and SetCookie,
 617         # as we would for non-divert
 618         if ($kind eq 'REDIRECT-LOGGEDOUT') {
 619             $params->{$r->{S}{loggedout_param_names}[0]} = 1;
 620         } elsif ($kind eq 'REDIRECT-LOGOUT') {
 621             $params->{$r->{S}{logout_param_names}[0]} = 1;
 622         } elsif ($kind eq 'REDIRECT-LOGGEDIN') {
 623         } else {
 624             die;
 625         }
 626         my $new_url = $r->url_with_query_params($params);
 627         my $cookie = $r->construct_cookie($r, $cookieval);
 628         $r->_ch('do_redirect',$new_url, $cookie);
 629         return 0;
 630     }
 631
 632     my ($title, @body);
 633     if ($kind =~ m/^LOGIN-/) {
 634         $title = $r->_gt('Login');
 635         push @body, $r->_gt($divert->{Message});
 636         push @body, $r->_ch('gen_login_form', $params);
 637     } elsif ($kind =~ m/^SMALLPAGE-/) {
 638         $title = $r->_gt('Not logged in');
 639         push @body, $r->_gt($divert->{Message});
 640         push @body, $r->_ch('gen_login_link');
 641     } else {
 642         die $kind;
 643     }
 644
 645     $r->_print($r->_ch('start_html',$title),
 646                @body,
 647                $r->_ch('end_html'));
 648     return 0;
 649 }
 650
 651 sub _random ($$) {
 652     my ($r, $bytes) = @_;
 653     my $v = $r->{V};
 654     my $rsf = $v->{RandomHandle};
 655     my $rsp = $r->{S}{random_source};
 656     if (!$rsf) {
 657         $v->{RandomHandle} = $rsf = new IO::File $rsp, '<' or die "$rsp $!";
 658     }
 659     my $bin;
 660     $!=0;
 661     read($rsf,$bin,$bytes) == $bytes or die "$rsp $!";
 662     close $rsf;
 663     return unpack "H*", $bin;
 664 }
 665
 666 sub _fresh_cookie ($) {
 667     my ($r) = @_;
 668     my $bytes = ($r->{S}{associdlen} + 7) >> 3;
 669     return $r->_random($bytes);
 670 }
 671
 672 sub check_mutate ($) {
 673     my ($r) = @_;
 674     die "unchecked" unless exists $r->{Divert};
 675     die if $r->{Divert};
 676     my $meth = $r->_ch('get_method');
 677     die "mutating non-POST" if $meth ne 'POST';
 678 }
 679
 680 #---------- output ----------
 681
 682 sub secret_val ($) {
 683     my ($r) = @_;
 684     $r->check();
 685     return defined $r->{Assoc} ? $r->{Assoc} : '';
 686 }
 687
 688 sub secret_hidden_html ($) {
 689     my ($r) = @_;
 690     return $r->{Cgi}->hidden(-name => $r->{S}{assoc_param_name},
 691                              -default => $r->secret_val());
 692 }
 693
 694 sub secret_cookie ($) {
 695     my ($r) = @_;
 696     return $r->construct_cookie($r->secret_val());
 697 }
 698
 699 __END__
 700
 701 =head1 NAME
 702
 703 CGI::Auth::Hybrid - web authentication optionally using cookies
 704
 705 =head1 SYNOPSYS
 706
 707  my $verifier = CGI::Auth::Hybrid->new_verifier(setting => value,...);
 708  my $authreq = $verifier->new_request($cgi_request_object);
 709
 710  my $authreq = CGI::Auth::Hybrid->new_request($cgi_request_object,
 711                                               setting => value,...);
 712
 713 =head1 USAGE PATTERN FOR SIMPLE APPLICATIONS
 714
 715  $authreq->check_ok() or return;
 716
 717  blah blah blah
 718  $authreq->check_mutate();
 719  blah blah blah
 720
 721 =head1 USAGE PATTERN FOR FANCY APPLICATIONS
 722
 723  my $divert_kind = $authreq->check_divert();
 724  if ($divert_kind) {
 725      if ($divert_kind eq 'LOGGEDOUT') {
 726          print "goodbye you are now logged out" and quit
 727      } elsif ($divert_kind eq 'NOCOOKIES') {
 728          print "you need cookies" and quit
 729      ... etc.
 730      }
 731  }
 732
 733  blah blah blah
 734  $authreq->check_mutate();
 735  blah blah blah