@ISA = qw(Exporter);
@EXPORT = qw();
%EXPORT_TAGS = ( ); # eg: TAG => [ qw!name1 name2! ],
-
- @EXPORT_OK = qw();
}
our @EXPORT_OK;
sub get_params ($) {
my ($r) = @_;
- my %p;
my $c = $r->{Cgi};
- foreach my $name ($c->param()) {
- $p{$name} = [ $c->param($name) ];
+ my $vars = $c->Vars();
+ my %p;
+ foreach my $name (keys %$vars) {
+ $p{$name} = [ split "\0", $vars->{$name} ];
}
return \%p;
}
sub gen_srcdump_link_html ($$$$) {
my ($c,$r,$anchor,$specval) = @_;
my %params = ($r->{S}{srcdump_param_name} => [ $specval ]);
- return '<a href="'.escapeHTML($r->url_with_query_params(\%params)).'">'.
- $anchor."</a>";
+ return '<a href="'.
+ escapeHTML($r->url_with_query_params(\%params,'SRCDUMP')).
+ '">'.$anchor."</a>";
}
sub gen_plain_licence_link_html ($$) {
my ($c,$r) = @_;
sub srcdump_byvcs ($$$$$$) {
my ($c, $v, $dumpdir, $dir, $outfn, $vcs) = @_;
#print STDERR "BYVCS GIT $dir\n";
- return srcdump_dir_cpio($c,$v,$dumpdir,$dir,$outfn,$vcs,
- $v->{S}{"srcdump_vcsscript_$vcs"});
+ my $script = $v->{S}{"srcdump_vcsscript"}{$vcs};
+ die "no script for vcs $vcs" unless defined $script;
+ return srcdump_dir_cpio($c,$v,$dumpdir,$dir,$outfn,$vcs,$script);
}
sub srcdump_file ($$$$) {
};
my %dirsdone;
foreach my $item ($v->_ch('srcdump_listitems')) {
+ next unless defined $item;
if ($item eq '.' && $v->{S}{srcdump_filter_cwd}) {
my @bad = grep { !m#^/# } values %INC;
die "filtering . from srcdump items and \@INC but already".
close $reportfh or die $!;
srcdump_install($c,$v, $dumpdir, 'licence', 'text/plain');
$!=0;
- my @cmd = (qw(tar -zvvcf), "$dumpdir/source.tmp",
+ my @cmd = (qw(sh -ec), 'exec >&2 "$@"', qw(x),
+ qw(tar -zvvcf), "$dumpdir/source.tmp",
"-C", $dumpdir, qw( --), @srcfiles);
my $r = system(@cmd);
if ($r) {
my $verifier = {
S => {
dir => undef,
- assocdb_dbh => undef, # must have AutoCommit=0, RaiseError=1
- assocdb_path => 'caf-assocs.db',
+ db_dbh => undef, # must have AutoCommit=0, RaiseError=1
+ db_path => 'caf.db',
keys_path => 'caf-keys',
srcdump_path => 'caf-srcdump',
- assocdb_dsn => undef,
- assocdb_user => '',
- assocdb_password => '',
- assocdb_table => 'caf_assocs',
+ db_dsn => undef,
+ db_user => '',
+ db_password => '',
+ db_prefix => 'caf',
random_source => '/dev/urandom',
secretbits => 128, # bits
hash_algorithm => "SHA-256",
get_path_info => sub { $_[0]->path_info() },
get_cookie => sub { $_[0]->cookie($_[1]->{S}{cookie_name}) },
get_method => sub { $_[0]->request_method() },
- check_https => sub { !!$_[0]->https() },
+ is_https => sub { !!$_[0]->https() },
get_url => sub { $_[0]->url(); },
is_login => sub { defined $_[1]->_rp('password_param_name') },
login_ok => \&login_ok_password,
username_password_error => sub { die },
is_logout => sub { $_[1]->has_a_param('logout_param_names') },
is_loggedout => sub { $_[1]->has_a_param('loggedout_param_names') },
- is_page => sub { return 1 },
handle_divert => sub { return 0 },
do_redirect => \&do_redirect_cgi, # this hook is allowed to throw
cookie_path => "/",
$_[2] =~ m#^/etc/|^/usr/(?!local/)(?!lib/cgi)#;
},
srcdump_process_item => \&srcdump_process_item,
- srcdump_vcs_dirs => [qw(.git .hg .bzr .svn CVS)],
- srcdump_vcsscript_git => "
+ srcdump_vcs_dirs => [qw(.git .hg .bzr .svn)],
+ srcdump_vcsscript => {git => "
git ls-files -z
git ls-files -z --others --exclude-from=.gitignore
find .git -print0
- ",
- srcdump_vcsscript_hg => "false hg",
- srcdump_vcsscript_bzr => "false bzr",
- srcdump_vcsscript_svn => "false svn",
- srcdump_vcsscript_cvs => "false cvs",
+ "},
srcdump_byvcs => \&srcdump_byvcs,
srcdump_novcs => \&srcdump_novcs,
srcdump_excludes => [qw(*~ *.bak *.tmp), '#*#'],
};
my ($k,$v);
while (($k,$v,@_) = @_) {
- die "unknown setting $k" unless exists $verifier->{S}{$k};
+ die "unknown setting $k" unless
+ $k =~ m/^promise_/ or
+ exists $verifier->{S}{$k};
$verifier->{S}{$k} = $v;
}
+ $verifier->{S}{db_setup_stmts} //=
+ ["CREATE TABLE $verifier->{S}{db_prefix}_assocs (".
+ " assochash VARCHAR PRIMARY KEY,".
+ " username VARCHAR NOT NULL,".
+ " last INTEGER NOT NULL".
+ ")"
+ ,
+ "CREATE INDEX $verifier->{S}{db_prefix}_assocs_timeout_index".
+ " ON $verifier->{S}{db_prefix}_assocs".
+ " (last)"
+ ];
bless $verifier, $class;
$verifier->_dbopen();
$verifier->_ch('srcdump_prepare');
my $dbh = $v->{Dbh};
return $dbh if $dbh;
- $dbh = $v->{S}{assocdb_dbh};
+ $dbh = $v->{S}{db_dbh};
if ($dbh) {
die if $dbh->{AutoCommit};
die unless $dbh->{RaiseError};
} else {
- $v->{S}{assocdb_dsn} ||= "dbi:SQLite:dbname=".$v->_get_path('assocdb');
- my $dsn = $v->{S}{assocdb_dsn};
+ $v->{S}{db_dsn} ||= "dbi:SQLite:dbname=".$v->_get_path('db');
+ my $dsn = $v->{S}{db_dsn};
my $u = umask 077;
- $dbh = DBI->connect($dsn, $v->{S}{assocdb_user},
- $v->{S}{assocdb_password}, {
+ $dbh = DBI->connect($dsn, $v->{S}{db_user},
+ $v->{S}{db_password}, {
AutoCommit => 0,
RaiseError => 1,
ShowErrorStatement => 1,
}
$v->{Dbh} = $dbh;
- $v->_db_setup_do("CREATE TABLE $v->{S}{assocdb_table} (".
- " assochash VARCHAR PRIMARY KEY,".
- " username VARCHAR NOT NULL,".
- " last INTEGER NOT NULL".
- ")");
- $v->_db_setup_do("CREATE INDEX $v->{S}{assocdb_table}_timeout_index".
- " ON $v->{S}{assocdb_table}".
- " (last)");
+ foreach my $stmt (@{ $v->{S}{db_setup_stmts} }) {
+ $v->_db_setup_do($stmt);
+ }
return $dbh;
}
my ($r, $cooks) = @_;
return undef unless $cooks;
my $c = $r->{Cgi};
-my @ca = (-name => $r->{S}{cookie_name},
- -value => $cooks,
- -path => $r->{S}{cookie_path},
- -domain => $r->_ch('get_cookie_domain'),
- -expires => '+'.$r->{S}{login_timeout}.'s',
- -secure => $r->{S}{encrypted_only});
+ my @ca = (
+ -name => $r->{S}{cookie_name},
+ -value => $cooks,
+ -path => $r->{S}{cookie_path},
+ -domain => $r->_ch('get_cookie_domain'),
+ -expires => '+'.$r->{S}{login_timeout}.'s',
+ -secure => $r->{S}{encrypted_only}
+ );
my $cookie = $c->cookie(@ca);
#print STDERR "CC $r $c $cooks $cookie (@ca).\n";
return $cookie;
# pages/param-sets are
# n normal non-mutating page
-# r retrieval of information for JS, non-mutating
+# r retrieval of information for JS etc., non-mutating
# m mutating page
-# u update of information by JS, mutating
+# u update of information by JS etc., mutating
# i login
# o logout
# O "you have just logged out" page load
# 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 nrmu bug or attack, fail
#
# - - GET O "just logged out" page
# (any other) O bug or attack, fail
# revoke y2
# treat as y1 n POST
#
- # y n GET n intra-site link from stale page,
+ # y nt 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
+ # y nt 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
+ # y nt GET r intra-site request from stale page
# fail
#
- # y n POST r u intra-site request from stale page
+ # y nt POST r u intra-site request from stale page
# fail
#
- # -/n y2 GET nr intra-site link from cleared session
+ # -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
+ # -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
+ # -nt -nt GET n cross-site link but user not logged in
# show login form with redirect to orig params
# generate fresh cookie
#
- # -/n n GET rmu user not logged in
+ # -nt nt GET rmu user not logged in
# fail
#
- # -/n n POST n m user not logged in
+ # -nt nt POST n m user not logged in
# show login form
#
- # -/n n POST r u user not logged in
+ # -nt nt POST r u user not logged in
# fail
sub _check_divert_core ($) {
die if $srcdump =~ m/\W/;
return ({ Kind => 'SRCDUMP-'.uc $srcdump,
Message => undef,
- CookieSecret => undef,
+ _CookieRaw => undef,
Params => { } });
}
- my $cooks = $r->_ch('get_cookie');
+ my $cooksraw = $r->_ch('get_cookie');
+ my $cooks = $r->_unblind($cooksraw);
- if ($r->{S}{encrypted_only} && !$r->_ch('check_https')) {
+ if ($r->{S}{encrypted_only} && !$r->_ch('is_https')) {
return ({ Kind => 'REDIRECT-HTTPS',
Message => $r->_gt("Redirecting to secure server..."),
- CookieSecret => undef,
+ _CookieRaw => undef,
Params => { } });
}
my $meth = $r->_ch('get_method');
- my $parmh = $r->_rp('assoc_param_name');
+ my $parmhraw = $r->_rp('assoc_param_name');
+ my $parmh = $r->_unblind($parmhraw);
my $cookh = defined $cooks ? $r->hash($cooks) : undef;
my ($cookt,$cooku) = $r->_identify($cookh, $cooks);
$r->_db_revoke($parmh);
return ({ Kind => 'REDIRECT-LOGGEDOUT',
Message => $r->_gt("Logging out..."),
- CookieSecret => '',
- Params => { } });
+ _CookieRaw => '',
+ Params => {
+ $r->{S}{loggedout_param_names}[0] => [ 1 ],
+ } });
}
if ($r->_ch('is_loggedout')) {
die unless $meth eq 'GET';
die if $parmt;
return ({ Kind => 'SMALLPAGE-LOGGEDOUT',
Message => $r->_gt("You have been logged out."),
- CookieSecret => '',
+ _CookieRaw => '',
Params => { } });
}
if ($r->_ch('is_login')) {
Message => $r->_gt("You do not seem to have cookies".
" enabled. You must enable cookies".
" as we use them for login."),
- CookieSecret => $r->_fresh_secret(),
+ _CookieRaw => $r->_fresh_secret(),
Params => $r->chain_params() })
}
if (!$cookt || $cookt eq 'n' || $cookh ne $parmh) {
return ({ Kind => 'LOGIN-STALE',
Message => $r->_gt("Stale session;".
" you need to log in again."),
- CookieSecret => $r->_fresh_secret(),
+ _CookieRaw => $r->_fresh_secret(),
Params => { } })
}
die unless $parmt eq 't' || $parmt eq 'y';
if !$login_errormessage;
return ({ Kind => 'LOGIN-BAD',
Message => $login_errormessage,
- CookieSecret => $cooks,
+ _CookieRaw => $cooks,
Params => $r->chain_params() })
}
$r->_db_record_login_ok($parmh,$username);
return ({ Kind => 'REDIRECT-LOGGEDIN',
Message => $r->_gt("Logging in..."),
- CookieSecret => $cooks,
+ _CookieRaw => $cooks,
Params => $r->chain_params() });
}
if ($cookt eq 't') {
$cookt = '';
}
- die if $parmt eq 't';
if ($cookt eq 'y' && $parmt eq 'y' && $cookh ne $parmh) {
$r->_db_revoke($parmh) if $meth eq 'POST';
if ($cookt ne 'y') {
die unless !$cookt || $cookt eq 'n';
- die unless !$parmt || $parmt eq 'n' || $parmt eq 'y';
+ die unless !$parmt || $parmt eq 't' || $parmt eq 'n' || $parmt eq 'y';
my $news = $r->_fresh_secret();
if ($meth eq 'GET') {
return ({ Kind => 'LOGIN-INCOMINGLINK',
Message => $r->_gt("You need to log in."),
- CookieSecret => $news,
+ _CookieRaw => $news,
Params => $r->chain_params() });
} else {
$r->_db_revoke($parmh);
return ({ Kind => 'LOGIN-FRESH',
Message => $r->_gt("You need to log in."),
- CookieSecret => $news,
+ _CookieRaw => $news,
Params => { } });
}
}
if ($meth ne 'POST') {
return ({ Kind => 'MAINPAGEONLY',
Message => $r->_gt('Entering via cross-site link.'),
- CookieSecret => $cooks,
+ _CookieRaw => $cooks,
Params => { } });
# NB caller must then ignore params & path!
# if this is too hard they can spit out a small form
die unless $cookt eq 'y';
unless ($r->{S}{promise_check_mutate} && $meth eq 'GET') {
+ if ($parmt eq 't' || $parmt eq 'n') {
+ return ({ Kind => 'STALE',
+ Message => $r->_gt("Login session interrupted."),
+ _CookieRaw => $cooks,
+ Params => { } });
+ }
die unless $parmt eq 'y';
die unless $cookh eq $parmh;
}
- $r->{AssocSecret} = $cooks;
+ $r->_db_update_last($cooku,$parmh);
+
+ $r->{ParmT} = $parmt;
+ $r->{AssocRaw} = $cooks;
$r->{UserOK} = $cooku;
#print STDERR "C-D-C OK\n";
return undef;
my $dbh = $r->{Dbh};
- $dbh->do("DELETE FROM $r->{S}{assocdb_table}".
+ $dbh->do("DELETE FROM $r->{S}{db_prefix}_assocs".
" WHERE last < ?", {},
time - $r->{S}{login_timeout});
my $row = $dbh->selectrow_arrayref("SELECT username, last".
- " FROM $r->{S}{assocdb_table}".
+ " FROM $r->{S}{db_prefix}_assocs".
" WHERE assochash = ?", {}, $h);
if (defined $row) {
#print STDERR "_identify h=$h s=$s YES @$row\n";
my $dbh = $r->{Dbh};
- $dbh->do("DELETE FROM $r->{S}{assocdb_table}".
+ $dbh->do("DELETE FROM $r->{S}{db_prefix}_assocs".
" WHERE assochash = ?", {}, $h);
}
my ($r,$h,$user) = @_;
$r->_db_revoke($h);
my $dbh = $r->{Dbh};
- $dbh->do("INSERT INTO $r->{S}{assocdb_table}".
+ $dbh->do("INSERT INTO $r->{S}{db_prefix}_assocs".
" (assochash, username, last) VALUES (?,?,?)", {},
$h, $user, time);
}
+sub _db_update_last ($$) {
+ # revokes $h if it's valid; no-op if it's not
+ my ($r,$user,$h) = @_;
+ my $dbh = $r->{Dbh};
+ $dbh->do("UPDATE $r->{S}{db_prefix}_assocs".
+ " SET last = ?".
+ " WHERE username = ? AND assochash = ?", {},
+ time, $user, $h);
+}
+
sub check_divert ($) {
my ($r) = @_;
if (exists $r->{Divert}) {
my $dbh = $r->{Dbh};
$r->{Divert} = $r->_db_transaction(sub { $r->_check_divert_core(); });
$dbh->commit();
- $r->_debug(Data::Dumper->Dump([$r->{Divert}],[qw(divert)]));
- return $r->{Divert};
+
+ my $divert = $r->{Divert};
+ my $cookraw = $divert && $divert->{_CookieRaw};
+ if ($cookraw) {
+ $divert->{CookieSecret} = $r->_blind($cookraw);
+ $divert->{Params}{$r->{S}{assoc_param_name}} = [
+ $r->_blind($r->hash($cookraw))
+ ];
+ }
+
+ $r->_debug(Data::Dumper->Dump([$divert],[qw(divert)]));
+ return $divert;
}
sub get_divert ($) {
return $r->{UserOK};
}
-sub url_with_query_params ($$) {
- my ($r, $params) = @_;
+sub url_with_query_params ($$;$) {
+ my ($r, $params, $nonpagetype) = @_;
#print STDERR "PARAMS ",Dumper($params);
my $uri = URI->new($r->_ch('get_url'));
$uri->path($uri->path() . $params->{''}[0]) if $params->{''};
- $uri->query_form(flatten_params($params));
+ my @flatparams = flatten_params($params);
+ if (defined $nonpagetype && $r->need_add_hidden('GET',$nonpagetype)) {
+ push @flatparams, $r->{S}{assoc_param_name}, $r->secret_hidden_val();
+ }
+ $uri->query_form(@flatparams);
return $uri->as_string();
}
}
if ($kind =~ m/^REDIRECT-/) {
- # for redirects, we honour stored NextParams and SetCookie,
+ # for redirects, we honour stored Params and Cookie,
# as we would for non-divert
if ($kind eq 'REDIRECT-LOGGEDOUT') {
- $params->{$r->{S}{loggedout_param_names}[0]} = [ 1 ];
- } elsif ($kind eq 'REDIRECT-LOGOUT') {
- $params->{$r->{S}{logout_param_names}[0]} = [ 1 ];
} elsif ($kind =~ m/REDIRECT-(?:LOGGEDIN|HTTPS)/) {
} else {
die;
return 0;
}
- if (defined $cookiesecret) {
- $params->{$r->{S}{assoc_param_name}} = [ $r->hash($cookiesecret) ];
- }
-
my ($title, @body);
if ($kind =~ m/^LOGIN-/) {
$title = $r->_gt('Login');
$title = $r->_gt('Not logged in');
push @body, $divert->{Message};
push @body, $r->_ch('gen_login_link', $params);
+ } elsif ($kind =~ m/^STALE/) {
+ $title = $r->_gt('Re-entering secure site.');
+ push @body, $divert->{Message};
+ push @body, $r->_ch('gen_postmainpage_form', $params);
} elsif ($kind =~ m/^MAINPAGEONLY$/) {
$title = $r->_gt('Entering secure site.');
push @body, $divert->{Message};
return $out;
}
+sub _blind_len ($$) {
+ my ($r, $str) = @_;
+ return length($str =~ y/0-9a-f//cdr);
+}
+
+sub _blind_combine ($$$) {
+ my ($r, $in, $mask) = @_;
+ my @mask = split //, $mask;
+ $in =~ s{[0-9a-f]}{
+ my $m = shift @mask;
+ sprintf "%x", hex($m) ^ hex($&);
+ }ge;
+ return $in;
+}
+
+sub _blind ($$) {
+ my ($r, $in) = @_;
+ return $in unless $in;
+ my $l = $r->_blind_len($in);
+ my $mask = $r->_random(($l+1)>>1);
+ $mask = substr $mask, 0, $l;
+ my $blound = $r->_blind_combine($in, $mask);
+ return "$blound.$mask";
+}
+
+sub _unblind ($$) {
+ my ($r, $in) = @_;
+ return $in unless $in;
+ my ($blound,$mask) = ($in =~ m#^(.*)\.([0-9a-f]+)$#) or die "$in ?";
+ my $l = $r->_blind_len($blound);
+ $l == length($mask) or die "$in ?";
+ return $r->_blind_combine($blound, $mask);
+}
+
sub _random_key ($) {
my ($r) = @_;
#print STDERR "_random_key\n";
$r->_must_be_post();
}
-sub mutate_ok ($) {
- my ($r) = @_;
+our %_resource_get_needs_secret_hidden =
+ (map { $_ => 0 } qw(PAGE FRAME IFRAME SRCDUMP STYLESHEET FAVICON ROBOTS),
+ map { $_ => 1 } qw(IMAGE SCRIPT AJAX-XML AJAX-JSON AJAX-OTHER));
+
+sub update_get_need_add_hidden ($$;$) {
+ my ($r, $reqtype, $value, $force) = @_;
+ my $hash = ref $r
+ ? ($r->{GetNeedsSecretHidden} ||= { })
+ : \%_resource_get_needs_secret_hidden;
+ return if !$force &&
+ (exists $_resource_get_needs_secret_hidden{$reqtype} ||
+ exists $hash->{$reqtype});
+ $hash->{$reqtype} = $value;
+}
+
+sub need_add_hidden ($$) {
+ my ($r, $method, $reqtype) = @_;
+ return 1 if $method ne 'GET';
+ if (ref $r) {
+ my $ent = $r->{GetNeedsSecretHidden}{$reqtype};
+ return $ent if defined $ent;
+ }
+ my $ent = $_resource_get_needs_secret_hidden{$reqtype};
+ return $ent if defined $ent;
+ die "unsupported nonpage GET type $reqtype";
+}
+
+sub check_nonpage ($$) {
+ my ($r, $reqtype) = @_;
$r->_assert_checked();
- die if $r->{Divert};
- return $r->_is_post();
+ return unless $r->resource_get_needs_secret_hidden($reqtype);
+ return if $r->{ParmT} eq 'y';
+ die "missing hidden secret parameter on nonpage request $reqtype";
}
#---------- output ----------
sub secret_cookie_val ($) {
my ($r) = @_;
$r->_assert_checked();
- return defined $r->{AssocSecret} ? $r->{AssocSecret} : '';
+ return defined $r->{AssocRaw} ? $r->_blind($r->{AssocRaw}) : '';
}
sub secret_hidden_val ($) {
my ($r) = @_;
$r->_assert_checked();
- return defined $r->{AssocSecret} ? $r->hash($r->{AssocSecret}) : '';
+ return defined $r->{AssocRaw} ? $r->_blind($r->hash($r->{AssocRaw})) : '';
}
sub secret_hidden_html ($) {
}
1;
-
-__END__
-
-=head1 NAME
-
-CGI::Auth::Flexible - web authentication optionally using cookies
-
-=head1 SYNOPSYS
-
- my $verifier = CGI::Auth::Flexible->new_verifier(setting => value,...);
- my $authreq = $verifier->new_request($cgi_query_object);
-
- # simple applications
- $authreq->check_ok() or return;
-
- # sophisticated applications
- my $divert_kind = $authreq->check_divert();
- if ($divert_kind) { ... print diversion page and quit ... }
-
- # while handling the request
- $user = $authreq->get_username();
- $authreq->check_mutate();
-
-=head1 DESCRIPTION
-
-CGI::Auth::Flexible is a library which you can use to add a
-forms/cookie-based login facility to a Perl web application.
-
-CGI::Auth::Flexible doesn't interfere with your application's URL path
-namespace and just needs a few (configurable) form parameter and
-cookie name(s) for its own use. It tries to avoid making assumptions
-about the implementation structure of your application.
-
-Because CGI::Auth::Flexible is licenced under the AGPLv3, you will
-probably need to provide a facility to allow users (even ones not
-logged in) to download the source code for your web app. Conveniently
-by default CGI::Auth::Flexible provides (for pure Perl webapps) a
-mechanism for users to get the source.
-
-CGI::Auth::Flexible is designed to try to stop you accidentally
-granting access by misunderstanding the API. (Also it, of course,
-guards against cross-site scripting.) You do need to make sure to
-call CGI::Auth::Flexible before answering AJAX requests as well as
-before generating HTML pages, of course, and to call it in every
-entrypoint to your system.
-
-=head2 INITIALISATION
-
-Your application should, on startup (eg, when it is loaded by
-mod_perl) do
-C<< $verifier = CGI::Auth::Flexible->new_verifier(settings...) >>.
-This call can be expensive and is best amortised.
-
-The resulting verifier object can be used to process individual
-requests, in each case with
-C<< $authreq = CGI::Auth::Flexible->new_request($cgi_query) >>.
-
-=head2 SIMPLE APPLICATIONS
-
-The simplist usage is to call C<< $request->check_ok() >> which will
-check the user's authentication. If the user is not logged in it will
-generate a login form (or redirection or other appropriate page) and
-return false; your application should not then processing that request
-any further. If the user is logged in it will return true.
-
-After calling C<check_ok> you can use C<< $request->get_username >>
-to find out which user the request came from.
-
-=head2 SOPHISTICATED APPLICATIONS
-
-If you want to handle the flow control and to generate login forms,
-redirections, etc., yourself, you can say
-C<< $divert = $request->check_divert >>. This returns undef if
-the user is logged in, or I<divert spec> if some kind of login
-page or diversion should be generated.
-
-=head2 GENERATING (MUTATING) FORMS AND AJAX QUERIES
-
-When you generate a C<POST> form or AJAX request you need to include a
-special secret hidden form parameter for the benefit of
-CGI::Auth::Generic. This form parameter will be checked by
-C<check_ok>/C<check_divert> and should be ignored by your application.
-
-By default its name is C<caf_assochash>. After calling C<check_ok> or
-C<check_divert> the value to put in your form can be obtained from
-C<secret_hidden_val>; C<secret_hidden_html> will generate the whole
-HTML C<< <input...> >> element.
-
-Do not put the secret value in URLs for C<GET> requests.
-
-=head2 MUTATING OPERATIONS AND EXTERNAL LINKS INTO YOUR SITE
-
-By default CGI::Auth::Flexible does not permit external links into
-your site. All GET requests give a "click to continue" page which
-submits a form. In this configuration all your application's forms
-and AJAX requests should use C<POST>.
-
-This is because the alternative (for complicated reasons relating to
-the web security architecture) is to require your application to make
-a special and different check when the incoming request is going to do
-some kind of action (such as modifying the user's setup, purchasing
-goods, or whatever) rather than just display HTML pages.
-
-To support external links, and C<GET> requests, pass C<<
-promise_check_mutate => 1 >> in I<settings>, and then call C<<
-$authreq->check_mutate() >> before taking any actions. If the
-incoming request is not suitable then C<< $authreq->check_mutate() >>
-will call C<die>. If you do this you must make sure that you have no
-mutating C<GET> requests in your application - but you shouldn't have
-any of those anyway.
-
-=head2 DATA STORAGE
-
-CGI::Auth::Flexible needs to store various information in plain files;
-it does this in the directory specified by the C<dir> parameter.
-
-It also needs to record state relating to user sessions in a database.
-There is no particular reason for this
-
-=head1 SOURCE CODE DOWNLOAD
-
-By default, CGI::Auth::Flexible provides a facility for users to
-download the source code for the running version of your web
-application.
-
-This facility makes a number of important assumptions which you need
-to check. Note that if the provided facility is not sufficient
-because your application is more sophisticated than it copes with (or
-if you disable the builtin facility), you may need to implement a
-functioning alternative to avoid violating the AGPLv3 licence.
-
-Here are the most important (default) assumptions:
-
-=over
-
-=item *
-
-Your app's source code is available by looking at @INC, $0 and
-S<$ENV{'SCRIPT_FILENAME'}> (the B<source items>). See
-C<srcdump_listitems>. Where these point to files or directories under
-revision control, the source item is the whole containing vcs tree.
-
-=item *
-
-Specifically, there are no compiled or autogenerated Perl
-files, Javascript resources, etc., which are not contained in one of
-the source item directories. (Files which came with your operating
-system install don't need to be shipped as they fall under the system
-library exceptio.)
-
-=item *
-
-You have not installed any modified versions of system
-libraries (including system-supplied) Perl modules in C</usr> outside
-C</usr/local>. See C<srcdump_system_dir>.
-
-=item *
-
-For each source item in a dvcs, the entire dvcs history does
-not contain anything confidential (or libellous). Also, all files which
-contain secrets are in the dvcs's C<.ignore> file. See
-C<srcdump_vcsscript_git> et al.
-
-=item *
-
-For each source item NOT in a dvcs, there are no confidential
-files with the world-readable bit set (being in a world-inaccessible
-directory is not sufficient). See C<srcdump_excludes>.
-
-=item *
-
-You have none of your app's source code in C</etc>.
-
-=item *
-
-You don't regard pathnames on your server as secret.
-
-=item *
-
-You don't intentionally load Perl code by virtule of C<.>
-being in C<@INC> by default. (See C<srcdump_filter_cwd>.)
-
-=back
-
-=head1 MAIN FUNCTIONS AND METHODS
-
-=over
-
-=item C<< CGI::Auth::Flexible->new_verifier(setting => value, ...) >>
-
-Initialises an instance and returns a verifier object.
-The arguments are setting pairs like a hash initialiser.
-See L</SETTINGS> below.
-
-=item C<< $verifier->new_request($cgi_query) >>
-
-Prepares to process a request. C<$cgi_query> should normally
-be the query object from L<CGI(3perl)>. Most of the default
-hook methods assume that it is; however if you replace enough of
-the hook methods then you can pass any value you like and it
-will be passed to your hooks.
-
-The return value is the authentication request object (C<$authreq>)
-which is used to check the incoming request and will contain
-information about its credentials.
-
-=item C<< $authreq->check_divert() >>
-
-Checks whether the user is logged in. Returns undef if the user is
-logged in and we should service the request. Otherwise returns a
-divert spec (see L</DIVERT SPEC>) saying what should happen instead.
-
-This method may die if it doesn't like the request, in which case
-the request needs to be rejected.
-
-=item C<< $authreq->check_ok() >>
-
-Checks whether the user is logged in. Returns true if the user is
-logged in and we should service the request.
-
-Otherwise it handles the request itself, generating any appropriate
-redirect, login form, or continuation page. It then returns false and
-the application should not process the request further.
-
-=item C<< $authreq->disconnect() >>
-
-Disconnects from the
-
-=back
~ian / cgi-auth-flexible.git / blobdiff