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