3 # This is part of CGI::Auth::Hybrid, a perl CGI authentication module.
4 # Copyright (C) 2012 Ian Jackson.
5 # Copyright (C) 2012 Citrix.
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.
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.
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/>.
23 package CGI::Auth::Hybrid;
28 our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
33 %EXPORT_TAGS = ( ); # eg: TAG => [ qw!name1 name2! ],
35 @EXPORT_OK = qw(setup);
40 use CGI qw/escapeHTML/;
45 #---------- public utilities ----------
47 sub flatten_params ($) {
50 foreach my $k (keys %$p) {
51 foreach my $v (@{ $p->{$k} }) {
58 #---------- default callbacks ----------
60 sub has_a_param ($$) {
62 foreach my $pn (@{ $r->{S}{$cn} }) {
63 return 1 if $r->_ch('get_param',$pn);
72 foreach my $name ($c->param()) {
73 $p{$name} = [ $c->param($name) ];
78 sub get_cookie_domain ($$$) {
80 my $uri = new URI $r->_ch('get_url');
84 sub login_ok_password ($$) {
86 my $username_params = $r->{S}{username_param_names};
87 my $username = $r->_ch('get_param',$username_params->[0]);
88 my $password = $r->_rp('password_param_name');
89 return $r->_ch('username_password_ok', $username, $password);
92 sub do_redirect_cgi ($$$$) {
93 my ($c, $r, $new_url, $cookie) = @_;
94 my @ha = ('text/html',
95 -status => '303 See other',
96 -location => $new_url);
97 push @ha, (-cookie => $cookie) if defined $cookie;
98 $r->_print($c->header(@ha),
99 $r->_ch('gen_start_html',$r->_gt('Redirection')),
100 '<a href="'.escapeHTML($new_url).'">',
101 $r->_gt("If you aren't redirected, click to continue."),
103 $c->_ch('gen_end_html'));
106 sub gen_plain_login_form ($$) {
107 my ($c,$r, $params) = @_;
109 push @form, ('<form method="POST" action="'.
110 escapeHTML($r->_ch('get_url')).'>'.
112 my $sz = 'size="'.$r->{S}{form_entry_size}.'"';
113 foreach my $up (@{ $r->{S}{username_param_names}}) {
114 push @form, ('<tr><td>',$r->_gt(ucfirst $up),'</td>',
115 '<td><input type="text" ',$sz.
116 ' name=',$up,'></td></tr>');
118 push @form, ('<tr><td>'.$r->_gt('Password'),'</td>',
119 '<td><input type="password" '.$sz.
120 ' name="'.$r->{S}{password_param_name}.'"></td></tr>');
121 push @form, ('<tr><td colspan="2">',
122 '<input type="submit"'.
123 ' name="'.$r->{S}{login_submit_name}.'"'.
124 ' value="'.$r->_gt('Login').'"></td></tr>',
126 foreach my $n (keys %$params) {
127 push @form, ('<input type="hidden"'.
129 ' value="'.$params->{$n}.'">');
131 push @form, ('</form>');
132 return join "\n", @form;
135 sub gen_login_link ($$) {
136 my ($c,$r, $params) = @_;
137 my $url = $r->url_with_query_params($params);
138 return ('<a href="'.escapeHTML($url).'">'.
139 $r->_gt('Log in again to continue.').
143 #---------- verifier object methods ----------
149 assocdb_path => 'cah-assocs.db',
150 assocdb_dsn => undef,
152 assocdb_password => '',
153 assocdb_table => 'assocs',
154 random_source => '/dev/urandom',
155 associdlen => 128, # bits
156 login_timeout => 86400, # seconds
157 assoc_param_name => 'cah_associd',
158 password_param_name => 'password',
159 username_param_names => [qw(username)],
160 form_entry_size => 60,
161 logout_param_names => [qw(cah_logout)],
162 login_submit_name => [qw(cah_login)],
163 loggedout_param_names => [qw(cah_loggedout)],
164 promise_check_mutate => 0,
165 get_param => sub { $_[0]->param($_[2]) },
166 get_params => sub { $_[1]->get_params() },
167 get_cookie => sub { $_[0]->cookie($_[1]->{S}{cookie_name}) },
168 get_method => sub { $_[0]->request_method() },
169 get_url => sub { $_[0]->url(); },
170 is_login => sub { defined $_[1]->_rp('password_param_name') },
171 login_ok => \&login_ok_password,
172 username_password_ok => sub { die },
173 is_logout => sub { $_[1]->has_a_param('logout_param_names') },
174 is_loggedout => sub { $_[1]->has_a_param('loggedout_param_names') },
175 is_page => sub { return 1 },
176 handle_divert => sub { return 0 },
177 do_redirect => \&do_redirect_cgi, # this hook is allowed to throw
179 get_cookie_domain => \&get_cookie_domain,
181 gen_start_html => sub { $_[0]->start_html($_[2]); },
182 gen_end_html => sub { $_[0]->end_html(); },
183 gen_login_form => \&gen_plain_login_form,
184 gen_login_link => \&gen_plain_login_link,
185 gettext => sub { gettext($_[2]); },
186 print => sub { print $_[2] or die $!; },
191 while (($k,$v,@_) = @_) {
192 die "unknown setting $k" unless exists $verifier->{S}{$k};
193 $verifier->{S}{$k} = $v;
195 bless $verifier, $class;
196 $verifier->_dbopen();
205 $v->{S}{assocdb_dsn} ||= "dbi:SQLite:dbname=$v->{S}{assocdb_path}";
206 my $dsn = $v->{S}{assocdb_dsn};
209 $dbh = DBI->connect($dsn, $v->{S}{assocdb_user},
210 $v->{S}{assocdb_password}, {
213 ShowErrorStatement => 1,
215 die "$dsn $! ?" unless $dbh;
219 $v->_db_transaction(sub {
220 local ($dbh->{PrintError}) = 0;
221 $dbh->do("CREATE TABLE $v->{S}{assocdb_table} (".
222 " associd VARCHAR PRIMARY KEY,".
223 " username VARCHAR,".
224 " last INTEGER NOT NULL".
238 sub _db_transaction ($$) {
243 print STDERR "DT entry\n";
245 print STDERR "DT loop\n";
248 print STDERR "DT fn ok\n";
251 print STDERR "DT fn error\n";
252 { local ($@); $dbh->rollback(); }
253 print STDERR "DT fn throwing\n";
256 print STDERR "DT fn eval ok\n";
259 print STDERR "DT commit ok\n";
262 print STDERR "DT commit eval ok $rv\n";
265 print STDERR "DT commit throw?\n";
266 die $@ if !--$retries;
267 print STDERR "DT loop again\n";
271 #---------- request object methods ----------
274 my ($classbase, $cgi, @extra) = @_;
275 if (!ref $classbase) {
276 $classbase = $classbase->new_verifier(@extra);
282 S => $classbase->{S},
283 Dbh => $classbase->{Dbh},
286 bless $r, ref $classbase;
289 sub _ch ($$@) { # calls an application hook
290 my ($r,$methname, @args) = @_;
291 my $methfunc = $r->{S}{$methname};
292 die "$methname ?" unless $methfunc;
293 return $methfunc->($r->{Cgi}, $r, @args);
298 my $pn = $r->{S}{$pnvb};
299 my $p = scalar $r->_ch('get_param',$pn)
302 sub _gt ($$) { my ($r, $t) = @_; return $r->_ch('gettext',$t); }
303 sub _print ($$) { my ($r, @t) = @_; return $r->_ch('print', join '', @t); }
305 sub construct_cookie ($$$) {
306 my ($r, $cookv) = @_;
307 return undef unless $cookv;
309 my $cookt = $c->cookie(-name => $r->{S}{cookie_name},
311 -path => $r->{S}{cookie_path},
312 -domain => $r->_ch('get_cookie_domain'),
313 -expires => '+'.$r->{S}{login_timeout}.'s',
314 -secure => $r->{S}{encrypted_only});
315 print STDERR "CC $r $c $cookv $cookt\n";
319 # pages/param-sets are
320 # n normal non-mutating page
321 # r retrieval of information for JS, non-mutating
323 # u update of information by JS, mutating
326 # O "you have just logged out" page load
329 # a, aN anything including -
330 # t, tN temporary value (in our db, no logged in user yet)
331 # y, yN value corresponds to logged-in user
332 # n, nN value not in our db
334 # - no value supplied
335 # if N differs the case applies only when the two values differ
336 # (eg, a1 y2 does not apply when the logged-in value is supplied twice)
338 # "stale session" means request originates from a page from a login
339 # session which has been revoked (eg by logout); "cleared session"
340 # means request originates from a browser which has a different (or
343 # Case analysis, cookie mode, app promises re mutate:
344 # cook parm meth form
346 # any - POST nrmuoi bug or attack, fail
347 # any - GET rmuoi bug or attack, fail
348 # any any GET muoi bug or attack, fail
349 # any t any nrmu bug or attack, fail
351 # - - GET O "just logged out" page
352 # (any other) O bug or attack, fail
354 # a1 a2 POST o logout
355 # if a1 is valid, revoke it
356 # if a2 is valid, revoke it
358 # redirect to "just logged out" page
359 # (which contains link to login form)
361 # - t POST i complain about cookies being disabled
362 # (with link to login form)
364 # any n POST i complain about stale login form
365 # show new login form
367 # x1 t2 POST i login (or switch user)
369 # show new login form
371 # revoke x1 if it was valid and !=t2
372 # upgrade t2 to y2 in our db (setting username)
374 # redirect to GET of remaining params
376 # t1 a2 ANY nrmu treat as - a2 ANY
378 # y - GET n cross-site link
381 # y y GET nr fine, show page or send data
382 # y y POST nrmu mutation is OK, do operation
384 # y1 y2 GET nr request from stale page
385 # do not revoke y2 as not RESTful
388 # y1 y2 POST nrmu request from stale page
392 # y n GET n intra-site link from stale page,
393 # treat as cross-site link, show data
395 # y n POST n m intra-site form submission from stale page
396 # show "session interrupted"
397 # with link to main data page
399 # y n GET r intra-site request from stale page
402 # y n POST r u intra-site request from stale page
405 # -/n y2 GET nr intra-site link from cleared session
406 # do not revoke y2 as not RESTful
409 # -/n y2 POST nrmu request from cleared session
411 # treat as -/n n POST
413 # -/n n GET n cross-site link but user not logged in
414 # show login form with redirect to orig params
416 # -/n n GET rmu user not logged in
419 # -/n n POST n m user not logged in
422 # -/n n POST r u user not logged in
425 sub _check_divert_core ($) {
428 my $meth = $r->_ch('get_method');
429 my $cookv = $r->_ch('get_cookie');
430 my $parmv = $r->_rp('assoc_param_name');
432 my ($cookt,$cooku) = $r->_db_lookup($cookv);
433 my $parmt = $r->_db_lookup($parmv);
435 if ($r->_ch('is_logout')) {
438 $r->_db_revoke($cookv);
439 $r->_db_revoke($parmv);
440 return ({ Kind => 'REDIRECT-LOGGEDOUT',
441 Message => "Logging out...",
445 if ($r->_ch('is_loggedout')) {
446 die unless $meth eq 'GET';
449 return ({ Kind => 'SMALLPAGE-LOGGEDOUT',
450 Message => "You have been logged out.",
454 if ($r->_ch('is_login')) {
456 return ({ Kind => 'LOGIN-STALE',
457 Message => "Stale session; you need to log in again.",
458 CookieVal => $r->_fresh_cookie(),
461 die unless $parmt eq 't' || $parmt eq 'y';
462 return ({ Kind => 'SMALLPAGE-NOCOOKIE',
463 Message => "You do not seem to have cookies enabled. ".
464 "You must enable cookies as we use them for login.",
465 CookieVal => $r->_fresh_cookie(),
466 Params => $r->_chain_params() })
467 if !$cookt && $parmt eq 't';
468 my $username = $r->_ch('login_ok');
469 return ({ Kind => 'LOGIN-BAD',
470 Message => "Incorrect username/password.",
472 Params => $r->_chain_params() })
473 unless defined $username && length $username;
474 $r->_db_revoke($cookv)
475 if defined $cookv && !(defined $parmv && $cookv eq $parmv);
476 $r->_db_record_login_ok($parmv,$username);
477 return ({ Kind => 'REDIRECT-LOGGEDIN',
478 Message => "Logging in...",
480 Params => $r->_chain_params() });
485 die if $parmt eq 't';
487 if ($cookt eq 'y' && $parmt eq 'y' && $cookv ne $parmv) {
488 $r->_db_revoke($parmv) if $meth eq 'POST';
493 die unless !$cookt || $cookt eq 'n';
494 die unless !$parmt || $parmt eq 'n' || $parmt eq 'y';
495 if ($meth eq 'GET') {
496 return ({ Kind => 'LOGIN-INCOMINGLINK',
497 Message => "You need to log in again.",
499 Params => $r->_chain_params() });
501 return ({ Kind => 'LOGIN-FRESH',
502 Message => "You need to log in again.",
508 if (!$r->{S}{promise_check_mutate}) {
509 if ($meth ne 'POST') {
510 return ({ Kind => 'MAINPAGEONLY',
511 Message => 'Entering via cross-site link.',
514 # NB caller must then ignore params & path!
515 # if this is too hard they can spit out a small form
516 # with a "click to continue"
520 die unless $cookt eq 'y';
521 die unless $parmt eq 'y';
522 die unless $cookv eq $parmv;
523 $r->{Assoc} = $cookv;
524 $r->{UserOK} = $cooku;
525 print STDERR "C-D-C OK\n";
529 sub _chain_params ($) {
531 my %p = %{ $r->_ch('get_params') };
532 foreach my $pncn (keys %{ $r->{S} }) {
534 if ($pncn =~ m/_param_name$/) {
535 my $name = $r->{S}{$pncn};
536 die "$pncn ?" if ref $name;
538 } elsif ($pncn =~ m/_param_names$/) {
539 $names = $r->{S}{$pncn};
543 foreach my $name (@$names) {
550 sub _db_lookup ($$) {
552 # returns ($t,$username)
553 # where $t is one of "t" "y" "n", or "" (for -)
557 my $row = $dbh->selectrow_arrayref("SELECT username, last".
558 " FROM $r->{S}{assocdb_table}".
559 " WHERE associd = ?", {}, $v);
560 return ('') unless defined $row;
562 my ($nusername, $nlast) = @$row;
564 my $timeout = $r->{S}{login_timeout};
565 return ('n') unless !defined $timeout || time <= $nlast + $timeout;
567 return ('t') unless defined $nusername;
570 return ('y', $nusername);
573 sub _db_revoke ($$) {
574 # revokes $v if it's valid; no-op if it's not
579 $dbh->do("DELETE FROM $r->{S}{assocdb_table}".
580 " WHERE associd = ?", {}, $v);
583 sub _db_record_login_ok ($$$) {
584 my ($r,$v,$user) = @_;
587 $dbh->do("INSERT INTO $r->{S}{assocdb_table}".
588 " (associd, username, last) VALUES (?,?,?)", {},
592 sub check_divert ($) {
594 if (exists $r->{Divert}) {
598 $r->{Divert} = $r->_db_transaction(sub { $r->_check_divert_core(); });
600 print STDERR Dumper($r->{Divert});
606 die "unchecked" unless exists $r->{Divert};
610 sub get_username ($) {
612 my $divert = $r->get_divert();
613 return undef if $divert;
617 sub url_with_query_params ($$) {
618 my ($r, $params) = @_;
619 my $uri = URI->new($r->_ch('get_url'));
620 $uri->query_form(flatten_params($params));
621 return $uri->as_string();
627 my ($divert) = $r->check_divert();
628 return 1 if !$divert;
630 my $handled = $r->_ch('handle_divert',$divert);
631 return 0 if $handled;
633 my $kind = $divert->{Kind};
634 my $cookieval = $divert->{CookieVal};
635 my $params = $divert->{Params};
637 if ($kind =~ m/^REDIRECT-/) {
638 # for redirects, we honour stored NextParams and SetCookie,
639 # as we would for non-divert
640 if ($kind eq 'REDIRECT-LOGGEDOUT') {
641 $params->{$r->{S}{loggedout_param_names}[0]} = 1;
642 } elsif ($kind eq 'REDIRECT-LOGOUT') {
643 $params->{$r->{S}{logout_param_names}[0]} = 1;
644 } elsif ($kind eq 'REDIRECT-LOGGEDIN') {
648 my $new_url = $r->url_with_query_params($params);
649 my $cookie = $r->construct_cookie($r, $cookieval);
650 $r->_ch('do_redirect',$new_url, $cookie);
655 if ($kind =~ m/^LOGIN-/) {
656 $title = $r->_gt('Login');
657 push @body, $r->_gt($divert->{Message});
658 push @body, $r->_ch('gen_login_form', $params);
659 } elsif ($kind =~ m/^SMALLPAGE-/) {
660 $title = $r->_gt('Not logged in');
661 push @body, $r->_gt($divert->{Message});
662 push @body, $r->_ch('gen_login_link');
667 $r->_print($r->{Cgi}->header('text/html'),
668 $r->_ch('gen_start_html',$title),
670 $r->_ch('gen_end_html'));
675 my ($r, $bytes) = @_;
677 my $rsf = $v->{RandomHandle};
678 my $rsp = $r->{S}{random_source};
680 $v->{RandomHandle} = $rsf = new IO::File $rsp, '<' or die "$rsp $!";
684 read($rsf,$bin,$bytes) == $bytes or die "$rsp $!";
686 return unpack "H*", $bin;
689 sub _fresh_cookie ($) {
691 my $bytes = ($r->{S}{associdlen} + 7) >> 3;
692 return $r->_random($bytes);
695 sub _assert_checked ($) {
697 die "unchecked" unless exists $r->{Divert};
700 sub check_mutate ($) {
702 $r->_assert_checked();
704 my $meth = $r->_ch('get_method');
705 die "mutating non-POST" if $meth ne 'POST';
708 #---------- output ----------
712 $r->_assert_checked();
713 return defined $r->{Assoc} ? $r->{Assoc} : '';
716 sub secret_hidden_html ($) {
718 return $r->{Cgi}->hidden(-name => $r->{S}{assoc_param_name},
719 -default => $r->secret_val());
722 sub secret_cookie ($) {
724 #print STDERR "SC\n";
725 my $cookv = $r->construct_cookie($r->secret_val());
726 #print STDERR "SC=$cookv\n";
734 CGI::Auth::Hybrid - web authentication optionally using cookies
738 my $verifier = CGI::Auth::Hybrid->new_verifier(setting => value,...);
739 my $authreq = $verifier->new_request($cgi_request_object);
741 my $authreq = CGI::Auth::Hybrid->new_request($cgi_request_object,
742 setting => value,...);
744 =head1 USAGE PATTERN FOR SIMPLE APPLICATIONS
746 $authreq->check_ok() or return;
749 $authreq->check_mutate();
752 =head1 USAGE PATTERN FOR FANCY APPLICATIONS
754 my $divert_kind = $authreq->check_divert();
756 if ($divert_kind eq 'LOGGEDOUT') {
757 print "goodbye you are now logged out" and quit
758 } elsif ($divert_kind eq 'NOCOOKIES') {
759 print "you need cookies" and quit
765 $authreq->check_mutate();