X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ian/git?p=cgi-auth-flexible.git;a=blobdiff_plain;f=cgi-auth-hybrid.pm;h=2e0623d71a7db71b9f7a2504ef1cb87819995841;hp=2993bc239c54ddb0a4cb78731a726bc52e9702cc;hb=017d2716636658b54c7b41fe9cc6ef55fc971971;hpb=cf94209ee946720f8bc41ed99c018fc84ebf41eb diff --git a/cgi-auth-hybrid.pm b/cgi-auth-hybrid.pm index 2993bc2..2e0623d 100644 --- a/cgi-auth-hybrid.pm +++ b/cgi-auth-hybrid.pm @@ -136,7 +136,7 @@ sub record_login ($$) { $r->{A} = $nassoc; } -sub _check ($) { +sub _check_core ($) { my ($r) = @_; my $qassoc = $r->_cm('get_param'); my ($nassoc,$nmutate); @@ -160,6 +160,103 @@ sub _check ($) { $nmutate = 0; } } + +# pages/param-sets are +# n normal non-mutating page +# r retrieval of information for JS, non-mutating +# m mutating page +# u update of information by JS, mutating +# i login +# o logout + + +# in cook and par, +# a, aN anything including - +# t, tN temporary value (in our db, no logged in user yet) +# y, yN value corresponds to logged-in user +# n, nN value not in our db +# x, xN t or y +# - no value supplied +# if N differs the case applies only when the two values differ +# (eg, a1 y2 does not apply when the logged-in value is supplied twice) + +# "stale session" means request originates from a page from a login +# session which has been revoked (eg by logout); "cleared session" +# means request originates from a browser which has a different (or +# no) cookie. + + # Case analysis, cookie mode, app promises re mutate: + # cook par meth form + # + # any - POST nrmuoi bug or attack, fail + # any - GET rmuoi bug or attack, fail + # any any GET muoi bug or attack, fail + # any t any nrmuo bug or attack, fail + # + # a1 a2 POST o logout + # if a1 is valid, revoke it + # if a2 is valid, revoke it + # delete cookie + # redirect to "just logged out" page + # (which contains link to login form) + # + # - t POST i complain about cookies being disabled + # + # - n POST i complain about stale login form + # show new login form + # + # x1 x2 POST i login (or switch user) + # revoke x1 if it was valid and !=x2 + # upgrade x2 to y2 in our db (setting username) + # set cookie to x2 + # redirect to GET of remaining params + # + # t1 a2 ANY nrmu treat as - a2 ANY + # + # y - GET n cross-site link + # show data + # + # y y GET nr fine, show page or send data + # y y POST nrmu mutation is OK, do operation + # + # y1 y2 GET nr request from stale page + # do not revoke y2 as not RESTful + # treat as y1 n GET + # + # y1 y2 POST nrmu request from stale page + # revoke y2 + # treat as y1 n POST + # + # y n GET n intra-site link from stale page, + # treat as cross-site link, show data + # + # y n POST n m intra-site form submission from stale page + # show "session interrupted" + # with link to main data page + # + # y n GET r intra-site request from stale page + # fail + # + # y n POST r u intra-site request from stale page + # fail + # + # -/n y2 GET nr intra-site link from cleared session + # do not revoke y2 as not RESTful + # treat as -/n n GET + # + # -/n y2 POST nrmu request from cleared session + # revoke y2 + # treat as -/n n POST + # + # -/n n GET n cross-site link but user not logged in + # show login form with redirect to orig params + # + # -/n n GET rmu user not logged in + # fail + # + # -/n n POST nrmu user not logged in + # fail + my $dbh = $r->{Dbh}; my ($nusername, $nlast) = $dbh->selectrow_array("SELECT username, last". @@ -173,24 +270,18 @@ sub _check ($) { return ($nusername, $nassoc, $nmutate); } -sub check ($) { +sub _check ($) { my ($r) = @_; - my ($nusername, $nassoc, $nmutate) = $r->_check() or return undef; - - $dbh->do("UPDATE $r->{S}{assocdb_table}". - " SET last = ?". - " WHERE associd = ?", {}, time, $nassoc); - $dbh->do("COMMIT"); + return if exists $r->{Username}; + ($r->{Username}, $r->{Assoc}, $r->{Mutate}) = $r->_check(); - $r->{Username} = $nusername; - $r->{Assoc} = $nassoc; - $r->{Mutate} = $nmutate; - return $nusername; -} - -sub check_mutate ($) { - my ($r) = @_; + if (defined $r->{Assoc}) { + $dbh->do("UPDATE $r->{S}{assocdb_table}". + " SET last = ?". + " WHERE associd = ?", {}, time, $nassoc); + $dbh->do("COMMIT"); + } } sub logout ($) { @@ -204,15 +295,31 @@ sub logout ($) { return $nusername; } +sub check ($) { + my ($r) = @_; + $r->_check(); + return !!defined $r->{Username}; +} + +sub check_mutate ($) { + my ($r) = @_; + $r->check(); + return $r->{Mutate}; +} + sub username ($) { my ($r) = @_; + $r->check(); return $r->{Username}; sub hidden_val ($) { my ($r) = @_; + $r->check(); return defined $r->{Assoc} ? $r->{Assoc} : ''; } +#---------- simple wrappers ---------- + sub hidden_hargs ($) { my ($r) = @_; return (-name => $r->{S}{param_name}, @@ -229,3 +336,58 @@ sub cookiea_cargs ($) { return (-name => $r->{S}{cookie_name}, -value => hidden_val()); } + +__END__ + +=head1 NAME + +CGI::Auth::Hybrid - web authentication optionally using cookies + +=head1 SYNOPSYS + + my $verifier = CGI::Auth::Hybrid->new_verifier(setting => value,...); + my $authreq = $verifier->new_request($cgi_request_object); + + my $authreq = CGI::Auth::Hybrid->new_request($cgi_request_object, + setting => value,...); + +=head1 USAGE PATTERN FOR SIMPLE APPLICATIONS + + if ( form submission is login request ) { + check login details, if wrong print error and quit + $authreq->record_login(...username...); + } + if ( form submission is logout request ) { + my $logged_out_user = $authreq->logout(); + if (!defined $logged_out_user) { + print "you are not logged in" error and quit + } else { + print "goodbye $username you are now logged out" and quit + } + } + if ( !$authreq->check() ) { + display login form, quit + + +=head1 USAGE PATTERN FOR FANCY APPLICATIONS + + if ( form submission is login request ) { + check login details, if wrong print error and quit + $authreq->record_login(...username...); + } + if ( !$authreq->check() ) { + display login form, quit + if ( form submission is logout request ) { + die unless $authreq->mutate(); + my $logged_out_user = $authreq->logout(); + if (!defined $logged_out_user) { + print "you are not logged in" error and quit + } else { + print "goodbye $username you are now logged out" and quit + } + } + + +advantages of cookie + - user can sort of log out by clearing cookies + - sophisticated applications can have get-requests