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