@ISA = qw(Exporter);
@EXPORT = qw();
%EXPORT_TAGS = ( ); # eg: TAG => [ qw!name1 name2! ],
-
- @EXPORT_OK = qw(setup);
}
our @EXPORT_OK;
use Digest::HMAC;
use Digest::SHA;
use Data::Dumper;
+use File::Copy;
+use Cwd qw/realpath/;
+
#---------- public utilities ----------
my ($p) = @_;
my @p;
foreach my $k (keys %$p) {
+ next if $k eq '';
foreach my $v (@{ $p->{$k} }) {
push @p, $k, $v;
}
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;
}
my $username_params = $r->{S}{username_param_names};
my $username = $r->_ch('get_param',$username_params->[0]);
my $password = $r->_rp('password_param_name');
- return undef unless $r->_ch('username_password_ok', $username, $password);
- return $username;
+ my $error = $r->_ch('username_password_error', $username, $password);
+ return defined($error) ? (undef,$error) : ($username,undef);
}
sub do_redirect_cgi ($$$$) {
# Calls $bodyfn->($c,$r) which returns @formbits
my $c = $r->{Cgi};
my @form;
+ my $pathinfo = '';
+ $pathinfo .= $params->{''}[0] if $params->{''};
push @form, ('<form method="POST" action="'.
- escapeHTML($r->_ch('get_url')).'">');
+ escapeHTML($r->_ch('get_url').$pathinfo).'">');
push @form, $bodyfn->($c,$r);
foreach my $n (keys %$params) {
+ next if $n eq '';
foreach my $val (@{ $params->{$n} }) {
push @form, ('<input type="hidden"'.
' name="'.escapeHTML($n).'"'.
' name="'.$r->{S}{password_param_name}.'"></td></tr>');
push @form, ('<tr><td colspan="2">',
'<input type="submit"'.
- ' name="'.$r->{S}{login_submit_name}[0].'"'.
+ ' name="'.$r->{S}{dummy_param_name_prefix}.'login"'.
' value="'.$r->_gt('Login').'"></td></tr>',
'</table>');
return @form;
return $r->gen_some_form($params, sub {
my @form;
push @form, ('<input type="submit"',
- ' name="'.$r->{S}{dummy_param_name}.'_submit"'.
+ ' name="'.$r->{S}{dummy_param_name_prefix}.'submit"'.
' value="'.$r->_gt('Continue').'">');
return @form;
});
'</a>');
}
+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,'SRCDUMP')).
+ '">'.$anchor."</a>";
+}
+sub gen_plain_licence_link_html ($$) {
+ my ($c,$r) = @_;
+ gen_srcdump_link_html($c,$r, 'GNU Affero GPL', 'licence');
+}
+sub gen_plain_source_link_html ($$) {
+ my ($c,$r) = @_;
+ gen_srcdump_link_html($c,$r, 'Source available', 'source');
+}
+
+sub gen_plain_footer_html ($$) {
+ my ($c,$r) = @_;
+ return ('<hr><address>',
+ ("Powered by Free / Libre / Open Source Software".
+ " according to the ".$r->_ch('gen_licence_link_html')."."),
+ $r->_ch('gen_source_link_html').".",
+ '</address>');
+}
+
+#---------- licence and source code ----------
+
+sub srcdump_dump ($$$) {
+ my ($c,$r, $thing) = @_;
+ die if $thing =~ m/\W/ || $thing !~ m/\w/;
+ my $path = $r->_get_path('srcdump');
+ my $ctf = new IO::File "$path/$thing.ctype", 'r'
+ or die "$path/$thing.ctype $!";
+ my $ct = <$ctf>;
+ chomp $ct or die "$path/$thing ?";
+ $ctf->close or die "$path/$thing $!";
+ my $df = new IO::File "$path/$thing.data", 'r'
+ or die "$path/$thing.data $!";
+ $r->_ch('dump', $ct, $df);
+}
+
+sub dump_plain ($$$$) {
+ my ($c, $r, $ct, $df) = @_;
+ $r->_print($c->header('-type' => $ct));
+ my $buffer;
+ for (;;) {
+ my $got = read $df, $buffer, 65536;
+ die $! unless defined $got;
+ return if !$got;
+ $r->_print($buffer);
+ }
+}
+
+sub srcdump_process_item ($$$$$$) {
+ my ($c, $v, $dumpdir, $item, $outfn, $needlicence, $dirsdone) = @_;
+ if ($v->_ch('srcdump_system_dir', $item)) {
+ $outfn->("srcdump_process_item: srcdump_system_dir, skipping $item");
+ return;
+ }
+ my $upwards = $item;
+ for (;;) {
+ $upwards =~ s#/+$##;
+ $upwards =~ s#/+\.$##;
+ last unless $upwards =~ m#[^/]#;
+ foreach my $try (@{ $v->{S}{srcdump_vcs_dirs} }) {
+#print STDERR "TRY $item $upwards $try\n";
+ if (!stat "$upwards/$try") {
+ $!==&ENOENT or $!==&ENOTDIR or die "check $upwards/$try $!";
+ next;
+ }
+#print STDERR "VCS $item $upwards $try\n";
+ if ($dirsdone->{$upwards}++) {
+ $outfn->("srcdump_process_item: did $upwards,".
+ " skipping $item");
+ return;
+ }
+#print STDERR "VCS $item $upwards $try GO\n";
+ $try =~ m/\w+/ or die;
+ return $v->_ch('srcdump_byvcs', $dumpdir, $upwards, $outfn, lc $&);
+ }
+ $upwards =~ s#/*[^/]+$##;
+ }
+ return $v->_ch('srcdump_novcs', $dumpdir, $item, $outfn);
+}
+
+sub srcdump_novcs ($$$$$) {
+ my ($c, $v, $dumpdir, $item, $outfn) = @_;
+ stat $item or die "$item $!";
+ if (-d _) {
+ my $script = 'find -type f -perm +004';
+ foreach my $excl (@{ $v->{S}{srcdump_excludes} }) {
+ $script .= " \\! -name '$excl'";
+ }
+ $script .= " -print0";
+ return srcdump_dir_cpio($c,$v,$dumpdir,$item,$outfn,'novcs',$script);
+ } elsif (-f _) {
+ return srcdump_file($c,$v,$dumpdir,$item,$outfn);
+ } else {
+ die "$item not file or directory";
+ }
+}
+
+sub srcdump_byvcs ($$$$$$) {
+ my ($c, $v, $dumpdir, $dir, $outfn, $vcs) = @_;
+#print STDERR "BYVCS GIT $dir\n";
+ 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 ($c,$v,$dumpdir,$file,$outfn) = @_;
+ my $outfile = $outfn->("srcdump_file saved $file", "src");
+ copy($file,$outfile) or die "$file $outfile $!";
+}
+
+sub srcdump_dir_cpio ($$$$$$$) {
+ my ($c,$v,$dumpdir,$dir,$outfn,$how,$script) = @_;
+ my $outfile = $outfn->("srcdump_dir_cpio $how saved $dir", "tar");
+#print STDERR "CPIO $dir >$script<\n";
+ my $pid = fork();
+ defined $pid or die $!;
+ if (!$pid) {
+ $SIG{__DIE__} = sub {
+ print STDERR "CGI::Auth::Flexible srcdump error: $@\n";
+ exit 127;
+ };
+ open STDOUT, ">", $outfile or die "$outfile $!";
+ chdir $dir or die "chdir $dir: $!";
+ exec '/bin/bash','-ec',"
+ set -o pipefail
+ (
+ $script
+ ) | (
+ cpio -Hustar -o --quiet -0 -R 1000:1000 || \
+ cpio -Hustar -o --quiet -0
+ )
+ ";
+ die $!;
+ }
+ $!=0; (waitpid $pid, 0) == $pid or die "$!";
+ die "$dir ($how $script) $outfile $?" if $?;
+}
+
+sub srcdump_dirscan_prepare ($$) {
+ my ($c, $v) = @_;
+ my $dumpdir = $v->_get_path('srcdump');
+ mkdir $dumpdir or $!==&EEXIST or die "mkdir $dumpdir $!";
+ my $lockf = new IO::File "$dumpdir/generate.lock", 'w+'
+ or die "$dumpdir/generate.lock $!";
+ flock $lockf, LOCK_EX or die "$dumpdir/generate.lock $!";
+ my $needlicence = "$dumpdir/licence.tmp";
+ unlink $needlicence or $!==&ENOENT or die "rm $needlicence $!";
+ if (defined $v->{S}{srcdump_licence_path}) {
+ copy($v->{S}{srcdump_licence_path}, $needlicence)
+ or die "$v->{S}{srcdump_licence_path} $!";
+ $needlicence = undef;
+ }
+ unlink <"$dumpdir/s.[a-z][a-z][a-z].*">;
+ my @srcfiles = qw(licence.data manifest.txt);
+ my $srcoutcounter = 'aaa';
+
+ my $reportfh = new IO::File "$dumpdir/manifest.txt", 'w' or die $!;
+ my $outfn = sub {
+ my ($message, $extension) = @_;
+ if (defined $extension) {
+ my $leaf = "s.$srcoutcounter.$extension";
+ $srcoutcounter++;
+ push @srcfiles, $leaf;
+ print $reportfh "$leaf: $message\n" or die $!;
+ return "$dumpdir/$leaf";
+ } else {
+ print $reportfh "none: $message\n" or die $!;
+ return undef;
+ }
+ };
+ 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".
+ " included @bad " if @bad;
+ @INC = grep { $_ ne '.' } @INC;
+ next;
+ }
+ if (!lstat "$item") {
+ die "stat $item $!" unless $!==&ENOENT;
+ $outfn->("srcdump_dirscan_prepare stat ENOENT, skipping $item");
+ next;
+ };
+ if (-l _) {
+ $item = realpath($item);
+ if (!defined $item) {
+ die "realpath $item $!" unless $!==&ENOENT;
+ $outfn->("srcdump_dirscan_prepare realpath ENOENT,".
+ " skipping $item");
+ }
+ }
+ if (defined $needlicence) {
+ foreach my $try (@{ $v->{S}{srcdump_licence_files} }) {
+ last if copy("$item/$try", $needlicence);
+ $!==&ENOENT or $!==&ENOTDIR or die "copy $item/$try $!";
+ }
+ }
+ $v->_ch('srcdump_process_item', $dumpdir, $item,
+ $outfn, \$needlicence, \%dirsdone);
+ $dirsdone{$item}++;
+ }
+ close $reportfh or die $!;
+ srcdump_install($c,$v, $dumpdir, 'licence', 'text/plain');
+ $!=0;
+ my @cmd = (qw(tar -zvvcf), "$dumpdir/source.tmp",
+ "-C", $dumpdir, qw( --), @srcfiles);
+ my $r = system(@cmd);
+ if ($r) {
+ print STDERR "CGI::Auth::Flexible tar failed ($r $!) @cmd\n";
+ die "tar failed";
+ }
+ die "licence file not found" unless defined $needlicence;
+ srcdump_install($c,$v, $dumpdir, 'source', 'application/octet-stream');
+ close $lockf or die $!;
+}
+
+sub srcdump_install ($$$$$) {
+ my ($c,$v, $dumpdir, $which, $ctype) = @_;
+ rename "$dumpdir/$which.tmp", "$dumpdir/$which.data"
+ or die "$dumpdir/$which.data $!";
+ my $ctf = new IO::File "$dumpdir/$which.tmp", 'w'
+ or die "$dumpdir/$which.tmp $!";
+ print $ctf $ctype, "\n" or die $!;
+ close $ctf or die $!;
+ rename "$dumpdir/$which.tmp", "$dumpdir/$which.ctype"
+ or die "$dumpdir/$which.ctype $!";
+}
+
#---------- verifier object methods ----------
sub new_verifier {
my $verifier = {
S => {
dir => undef,
- assocdb_path => 'caf-assocs.db',
+ db_dbh => undef, # must have AutoCommit=0, RaiseError=1
+ db_path => 'caf.db',
keys_path => 'caf-keys',
- assocdb_dsn => undef,
- assocdb_user => '',
- assocdb_password => '',
- assocdb_table => 'caf_assocs',
+ srcdump_path => 'caf-srcdump',
+ db_dsn => undef,
+ db_user => '',
+ db_password => '',
+ db_prefix => 'caf',
random_source => '/dev/urandom',
secretbits => 128, # bits
hash_algorithm => "SHA-256",
login_form_timeout => 3600, # seconds
key_rollover => 86400, # seconds
assoc_param_name => 'caf_assochash',
- dummy_param_name => 'caf_dummy',
+ dummy_param_name_prefix => 'caf__',
cookie_name => "caf_assocsecret",
password_param_name => 'password',
+ srcdump_param_name => 'caf_srcdump',
username_param_names => [qw(username)],
form_entry_size => 60,
logout_param_names => [qw(caf_logout)],
- login_submit_name => [qw(caf_login)],
loggedout_param_names => [qw(caf_loggedout)],
promise_check_mutate => 0,
get_param => sub { $_[0]->param($_[2]) },
get_params => sub { $_[1]->get_params() },
+ get_path_info => sub { $_[0]->path_info() },
get_cookie => sub { $_[0]->cookie($_[1]->{S}{cookie_name}) },
get_method => sub { $_[0]->request_method() },
+ 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_ok => sub { die },
+ 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 => "/",
get_cookie_domain => \&get_cookie_domain,
encrypted_only => 1,
gen_start_html => sub { $_[0]->start_html($_[2]); },
+ gen_footer_html => \&gen_plain_footer_html,
+ gen_licence_link_html => \&gen_plain_licence_link_html,
+ gen_source_link_html => \&gen_plain_source_link_html,
gen_end_html => sub { $_[0]->end_html(); },
gen_login_form => \&gen_plain_login_form,
gen_login_link => \&gen_plain_login_link,
gen_postmainpage_form => \&gen_postmainpage_form,
+ srcdump_dump => \&srcdump_dump,
+ srcdump_prepare => \&srcdump_dirscan_prepare,
+ srcdump_licence_path => undef,
+ srcdump_licence_files => [qw(AGPLv3 CGI/Auth/Flexible/AGPLv3)],
+ srcdump_listitems => sub { (@INC, $ENV{'SCRIPT_FILENAME'}, $0); },
+ srcdump_filter_cwd => 1,
+ srcdump_system_dir => sub {
+ $_[2] =~ m#^/etc/|^/usr/(?!local/)(?!lib/cgi)#;
+ },
+ srcdump_process_item => \&srcdump_process_item,
+ 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_byvcs => \&srcdump_byvcs,
+ srcdump_novcs => \&srcdump_novcs,
+ srcdump_excludes => [qw(*~ *.bak *.tmp), '#*#'],
+ dump => \&dump_plain,
gettext => sub { gettext($_[2]); },
print => sub { print $_[2] or die $!; },
+ debug => sub { }, # like print; msgs contain trailing \n
},
Dbh => undef,
};
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');
return $verifier;
}
my $dbh = $v->{Dbh};
return $dbh if $dbh;
- $v->{S}{assocdb_dsn} ||= "dbi:SQLite:dbname=".$v->_get_path('assocdb');
- my $dsn = $v->{S}{assocdb_dsn};
-
- my $u = umask 077;
- $dbh = DBI->connect($dsn, $v->{S}{assocdb_user},
- $v->{S}{assocdb_password}, {
- AutoCommit => 0,
- RaiseError => 1,
- ShowErrorStatement => 1,
- });
- die "$dsn $! ?" unless $dbh;
+ $dbh = $v->{S}{db_dbh};
+ if ($dbh) {
+ die if $dbh->{AutoCommit};
+ die unless $dbh->{RaiseError};
+ } else {
+ $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}{db_user},
+ $v->{S}{db_password}, {
+ AutoCommit => 0,
+ RaiseError => 1,
+ ShowErrorStatement => 1,
+ });
+ umask $u;
+ die "$dsn $! ?" unless $dbh;
+ }
$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 $retries = 10;
my $rv;
my $dbh = $v->{Dbh};
-print STDERR "DT entry\n";
+#print STDERR "DT entry\n";
for (;;) {
-print STDERR "DT loop\n";
+#print STDERR "DT loop\n";
if (!eval {
$rv = $fn->();
-print STDERR "DT fn ok\n";
+#print STDERR "DT fn ok\n";
1;
}) {
-print STDERR "DT fn error\n";
+#print STDERR "DT fn error\n";
{ local ($@); $dbh->rollback(); }
-print STDERR "DT fn throwing\n";
+#print STDERR "DT fn throwing\n";
die $@;
}
-print STDERR "DT fn eval ok\n";
+#print STDERR "DT fn eval ok\n";
if (eval {
$dbh->commit();
-print STDERR "DT commit ok\n";
+#print STDERR "DT commit ok\n";
1;
}) {
-print STDERR "DT commit eval ok ",Dumper($rv);
+#print STDERR "DT commit eval ok ",Dumper($rv);
return $rv;
}
-print STDERR "DT commit throw?\n";
+#print STDERR "DT commit throw?\n";
die $@ if !--$retries;
-print STDERR "DT loop again\n";
+#print STDERR "DT loop again\n";
}
}
my $p = scalar $r->_ch('get_param',$pn)
}
+sub _debug ($@) {
+ my ($r,@args) = @_;
+ $r->_ch('debug',@args);
+}
+
sub _get_path ($$) {
- my ($v,$keybase) = @_;
- my $leaf = $v->{S}{"${keybase}_path"};
- my $dir = $v->{S}{dir};
+ my ($r,$keybase) = @_;
+ my $leaf = $r->{S}{"${keybase}_path"};
+ return $r->_absify_path($leaf);
+}
+
+sub _absify_path ($$) {
+ my ($v,$leaf) = @_;
return $leaf if $leaf =~ m,^/,;
+ my $dir = $v->{S}{dir};
die "relying on cwd by default ?! set dir" unless defined $dir;
return "$dir/$leaf";
}
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";
+#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
sub _check_divert_core ($) {
my ($r) = @_;
- my $meth = $r->_ch('get_method');
+ my $srcdump = $r->_rp('srcdump_param_name');
+ if ($srcdump) {
+ die if $srcdump =~ m/\W/;
+ return ({ Kind => 'SRCDUMP-'.uc $srcdump,
+ Message => undef,
+ CookieSecret => undef,
+ Params => { } });
+ }
+
my $cooks = $r->_ch('get_cookie');
+
+ if ($r->{S}{encrypted_only} && !$r->_ch('is_https')) {
+ return ({ Kind => 'REDIRECT-HTTPS',
+ Message => $r->_gt("Redirecting to secure server..."),
+ CookieSecret => undef,
+ Params => { } });
+ }
+
+ my $meth = $r->_ch('get_method');
my $parmh = $r->_rp('assoc_param_name');
my $cookh = defined $cooks ? $r->hash($cooks) : undef;
? $cooks : undef;
my ($parmt) = $r->_identify($parmh, $parms);
- print STDERR "_c_d_c cookt=$cookt parmt=$parmt\n";
+ $r->_debug("_c_d_c cookt=$cookt parmt=$parmt\n");
if ($r->_ch('is_logout')) {
$r->_must_be_post();
$r->_db_revoke($cookh);
$r->_db_revoke($parmh);
return ({ Kind => 'REDIRECT-LOGGEDOUT',
- Message => "Logging out...",
+ Message => $r->_gt("Logging out..."),
CookieSecret => '',
Params => { } });
}
if ($r->_ch('is_loggedout')) {
die unless $meth eq 'GET';
- die unless $cookt;
- die unless $parmt;
+ die if $cookt eq 'y';
+ die if $parmt;
return ({ Kind => 'SMALLPAGE-LOGGEDOUT',
- Message => "You have been logged out.",
+ Message => $r->_gt("You have been logged out."),
CookieSecret => '',
Params => { } });
}
if ($r->_ch('is_login')) {
$r->_must_be_post();
die unless $parmt;
- if (!$cookt && $parmt eq 't') {
+ if (!$cookt && $parmt eq 'n') {
return ({ Kind => 'SMALLPAGE-NOCOOKIE',
- Message => "You do not seem to have cookies enabled. ".
- "You must enable cookies as we use them for login.",
- CookieSecret => $r->_fresh_secret(),
- Params => $r->_chain_params() })
+ 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(),
+ Params => $r->_chain_params() })
}
if (!$cookt || $cookt eq 'n' || $cookh ne $parmh) {
$r->_db_revoke($cookh);
return ({ Kind => 'LOGIN-STALE',
- Message => "Stale session; you need to log in again.",
+ Message => $r->_gt("Stale session;".
+ " you need to log in again."),
CookieSecret => $r->_fresh_secret(),
Params => { } })
}
die unless $parmt eq 't' || $parmt eq 'y';
- my $username = $r->_ch('login_ok');
+ my ($username, $login_errormessage) = $r->_ch('login_ok');
unless (defined $username && length $username) {
+ $login_errormessage = $r->_gt("Incorrect username/password.")
+ if !$login_errormessage;
return ({ Kind => 'LOGIN-BAD',
- Message => "Incorrect username/password.",
+ Message => $login_errormessage,
CookieSecret => $cooks,
Params => $r->_chain_params() })
}
$r->_db_record_login_ok($parmh,$username);
return ({ Kind => 'REDIRECT-LOGGEDIN',
- Message => "Logging in...",
+ Message => $r->_gt("Logging in..."),
CookieSecret => $cooks,
Params => $r->_chain_params() });
}
my $news = $r->_fresh_secret();
if ($meth eq 'GET') {
return ({ Kind => 'LOGIN-INCOMINGLINK',
- Message => "You need to log in.",
+ Message => $r->_gt("You need to log in."),
CookieSecret => $news,
Params => $r->_chain_params() });
} else {
$r->_db_revoke($parmh);
return ({ Kind => 'LOGIN-FRESH',
- Message => "You need to log in.",
+ Message => $r->_gt("You need to log in."),
CookieSecret => $news,
Params => { } });
}
if (!$r->{S}{promise_check_mutate}) {
if ($meth ne 'POST') {
return ({ Kind => 'MAINPAGEONLY',
- Message => 'Entering via cross-site link.',
+ Message => $r->_gt('Entering via cross-site link.'),
CookieSecret => $cooks,
Params => { } });
# NB caller must then ignore params & path!
}
die unless $cookt eq 'y';
- die unless $parmt eq 'y';
- die unless $cookh eq $parmh;
+ unless ($r->{S}{promise_check_mutate} && $meth eq 'GET') {
+ die unless $parmt eq 'y';
+ die unless $cookh eq $parmh;
+ }
+ $r->{ParmT} = $parmt;
$r->{AssocSecret} = $cooks;
$r->{UserOK} = $cooku;
- print STDERR "C-D-C OK\n";
+#print STDERR "C-D-C OK\n";
return undef;
}
sub _chain_params ($) {
+# =item C<< $authreq->_chain_params() >>
+#
+# Returns a hash of the "relevant" parameters to this request, in a form
+# used by C<url_with_query_params>. This is all of the query parameters
+# which are not related to CGI::Auth::Flexible. The PATH_INFO from the
+# request is returned as the parameter C<< '' >>.
+
my ($r) = @_;
my %p = %{ $r->_ch('get_params') };
foreach my $pncn (keys %{ $r->{S} }) {
delete $p{$name};
}
}
+ my $dummy_prefix = $r->{S}{dummy_param_name_prefix};
+ foreach my $name (grep /^$dummy_prefix/, keys %p) {
+ delete $p{$name};
+ }
+ die if exists $p{''};
+ $p{''} = [ $r->_ch('get_path_info') ];
return \%p;
}
# where $t is one of "t" "y" "n", or "" (for -)
# either $s must be undef, or $h eq $r->hash($s)
-print STDERR "_identify\n";
+#print STDERR "_identify\n";
return '' unless defined $h && length $h;
-print STDERR "_identify h=$h s=".(defined $s ? $s : '<undef>')."\n";
+#print STDERR "_identify h=$h s=".(defined $s ? $s : '<undef>')."\n";
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";
+#print STDERR "_identify h=$h s=$s YES @$row\n";
my ($nusername, $nlast) = @$row;
return ('y', $nusername);
}
return 'n' if time > $noncet + $r->{S}{login_form_timeout};
-print STDERR "_identify noncet=$noncet ok\n";
+#print STDERR "_identify noncet=$noncet ok\n";
my $keys = $r->_open_keys();
while (my ($rkeyt, $rkey, $line) = $r->_read_key($keys)) {
-print STDERR "_identify search rkeyt=$rkeyt rkey=$rkey\n";
+#print STDERR "_identify search rkeyt=$rkeyt rkey=$rkey\n";
last if $rkeyt < $keyt; # too far down in the file
my $trysignature = $r->_hmac($rkey, $message);
-print STDERR "_identify search rkeyt=$rkeyt rkey=$rkey trysig=$trysignature\n";
+#print STDERR "_identify search rkeyt=$rkeyt rkey=$rkey try=$trysignature\n";
return 't' if $trysignature eq $signature;
}
# oh well
-print STDERR "_identify NO\n";
+#print STDERR "_identify NO\n";
$keys->error and die $!;
return '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);
}
my $dbh = $r->{Dbh};
$r->{Divert} = $r->_db_transaction(sub { $r->_check_divert_core(); });
$dbh->commit();
- print STDERR Dumper($r->{Divert});
+ $r->_debug(Data::Dumper->Dump([$r->{Divert}],[qw(divert)]));
return $r->{Divert};
}
return $r->{UserOK};
}
-sub url_with_query_params ($$) {
- my ($r, $params) = @_;
-print STDERR "PARAMS ",Dumper($params);
+sub url_with_query_params ($$;$) {
+ my ($r, $params, $nonpagetype) = @_;
+#print STDERR "PARAMS ",Dumper($params);
my $uri = URI->new($r->_ch('get_url'));
- $uri->query_form(flatten_params($params));
+ $uri->path($uri->path() . $params->{''}[0]) if $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();
}
my ($r, $cookie, @ha) = @_;
unshift @ha, qw(-type text/html);
push @ha, (-cookie => $cookie) if defined $cookie;
- print STDERR "_cgi_header_args ",join('|',@ha),".\n";
+#print STDERR "_cgi_header_args ",join('|',@ha),".\n";
return @ha;
}
my $params = $divert->{Params};
my $cookie = $r->construct_cookie($cookiesecret);
- if (defined $cookiesecret) {
- $params->{$r->{S}{assoc_param_name}} = [ $r->hash($cookiesecret) ];
+ if ($kind =~ m/^SRCDUMP-(\w+)$/) {
+ $r->_ch('srcdump_dump', (lc $1));
+ return 0;
}
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 eq 'REDIRECT-LOGGEDIN') {
+ } elsif ($kind =~ m/REDIRECT-(?:LOGGEDIN|HTTPS)/) {
} else {
die;
}
my $new_url = $r->url_with_query_params($params);
+ if ($kind eq 'REDIRECT-HTTPS') {
+ my $uri = URI->new($new_url);
+ die unless $uri->scheme eq 'http';
+ $uri->scheme('https');
+ $new_url = $uri->as_string();
+ }
$r->_ch('do_redirect',$new_url, $cookie);
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');
- push @body, $r->_gt($divert->{Message});
+ push @body, $divert->{Message};
push @body, $r->_ch('gen_login_form', $params);
} elsif ($kind =~ m/^SMALLPAGE-/) {
$title = $r->_gt('Not logged in');
- push @body, $r->_gt($divert->{Message});
+ push @body, $divert->{Message};
push @body, $r->_ch('gen_login_link', $params);
} elsif ($kind =~ m/^MAINPAGEONLY$/) {
$title = $r->_gt('Entering secure site.');
- push @body, $r->_gt($divert->{Message});
+ push @body, $divert->{Message};
push @body, $r->_ch('gen_postmainpage_form', $params);
} else {
die $kind;
$r->_print($r->{Cgi}->header($r->_cgi_header_args($cookie)),
$r->_ch('gen_start_html',$title),
- (join "\n", @body),
- $r->_ch('gen_end_html'));
+ (join "\n", (@body,
+ $r->_ch('gen_footer_html'),
+ $r->_ch('gen_end_html'))));
return 0;
}
my $rsp = $r->{S}{random_source};
if (!$rsf) {
$v->{RandomHandle} = $rsf = new IO::File $rsp, '<' or die "$rsp $!";
-print STDERR "RH $rsf\n";
+#print STDERR "RH $rsf\n";
}
my $bin;
$!=0;
read($rsf,$bin,$bytes) == $bytes or die "$rsp $!";
my $out = unpack "H*", $bin;
- print STDERR "_random out $out\n";
+#print STDERR "_random out $out\n";
return $out;
}
sub _random_key ($) {
my ($r) = @_;
- print STDERR "_random_key\n";
+#print STDERR "_random_key\n";
my $bytes = ($r->{S}{secretbits} + 7) >> 3;
return $r->_random($bytes);
}
my ($r) = @_;
my $spath = $r->_get_path('keys');
for (;;) {
- print STDERR "_open_keys\n";
+#print STDERR "_open_keys\n";
my $keys = new IO::File $spath, 'r+';
if ($keys) {
- print STDERR "_open_keys open\n";
+#print STDERR "_open_keys open\n";
stat $keys or die $!; # NB must not disturb stat _
my $size = (stat _)[7];
my $age = time - (stat _)[9];
- print STDERR "_open_keys open size=$size age=$age\n";
+#print STDERR "_open_keys open size=$size age=$age\n";
return $keys
if $size && $age <= $r->{S}{key_rollover} / 2;
- print STDERR "_open_keys open bad\n";
+#print STDERR "_open_keys open bad\n";
}
# file doesn't exist, or is empty or too old
if (!$keys) {
- print STDERR "_open_keys closed\n";
+#print STDERR "_open_keys closed\n";
die "$spath $!" unless $!==&ENOENT;
# doesn't exist, so create it just so we can lock it
$keys = new IO::File $spath, 'a+';
die "$keys $!" unless $keys;
stat $keys or die $!; # NB must not disturb stat _
my $size = (stat _)[7];
- print STDERR "_open_keys created size=$size\n";
+#print STDERR "_open_keys created size=$size\n";
next if $size; # oh someone else has done it, reopen and read it
}
# file now exists is empty or too old, we must try to replace it
flock $keys, LOCK_EX or die "$spath $!";
stat $spath or die "$spath $!";
my $path_inum = (stat _)[1];
- print STDERR "_open_keys locked our=$our_inum path=$path_inum\n";
+#print STDERR "_open_keys locked our=$our_inum path=$path_inum\n";
next if $our_inum != $path_inum; # someone else has done it
# We now hold the lock!
- print STDERR "_open_keys creating\n";
+#print STDERR "_open_keys creating\n";
my $newkeys = new IO::Handle;
sysopen $newkeys, "$spath.new", O_CREAT|O_TRUNC|O_WRONLY, 0600
or die "$spath.new $!";
# we add the new key to the front which means it's always sorted
print $newkeys time, ' ', $r->_random_key(), "\n" or die $!;
while (my ($gen,$key,$line) = $r->_read_key($keys)) {
- print STDERR "_open_keys copy1\n";
+#print STDERR "_open_keys copy1\n";
print $newkeys, $line or die $!;
}
$keys->error and die $!;
close $newkeys or die "$spath.new $!";
rename "$spath.new", "$spath" or die "$spath: $!";
- print STDERR "_open_keys installed\n";
+#print STDERR "_open_keys installed\n";
# that rename effective unlocks, since it makes the name refer
# to the new file which we haven't locked
# we go round again opening the file at the beginning
sub _fresh_secret ($) {
my ($r) = @_;
- print STDERR "_fresh_secret\n";
+#print STDERR "_fresh_secret\n";
my $keys = $r->_open_keys();
my ($keyt, $key) = $r->_read_key($keys);
my $signature = $r->_hmac($key, $message);
my $secret = "$keyt.$signature.$message";
- print STDERR "FRESH $secret\n";
+#print STDERR "FRESH $secret\n";
return $secret;
}
my ($r, $keyhex, $message) = @_;
my $keybin = pack "H*", $keyhex;
my $alg = $r->{S}{hash_algorithm};
-print STDERR "hmac $alg\n";
+#print STDERR "hmac $alg\n";
my $base = new Digest $alg;
-print STDERR "hmac $alg $base\n";
+#print STDERR "hmac $alg $base\n";
my $digest = new Digest::HMAC $keybin, $base;
-print STDERR "hmac $alg $base $digest\n";
+#print STDERR "hmac $alg $base $digest\n";
$digest->add($message);
return $digest->hexdigest();
}
sub hash ($$) {
my ($r, $message) = @_;
my $alg = $r->{S}{hash_algorithm};
-print STDERR "hash $alg\n";
+#print STDERR "hash $alg\n";
my $digest = new Digest $alg;
$digest->add($message);
return $digest->hexdigest();
die "unchecked" unless exists $r->{Divert};
}
+sub _is_post ($) {
+ my ($r) = @_;
+ my $meth = $r->_ch('get_method');
+ return $meth eq 'POST';
+}
+
sub _must_be_post ($) {
my ($r) = @_;
my $meth = $r->_ch('get_method');
$r->_must_be_post();
}
+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();
+ return unless $r->resource_get_needs_secret_hidden($reqtype);
+ return if $r->{ParmT};
+ die "missing hidden secret parameter on nonpage request $reqtype";
+}
+
#---------- output ----------
sub secret_cookie_val ($) {
return $cookv;
}
-__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_request_object);
-
- my $authreq = CGI::Auth::Flexible->new_request($cgi_request_object,
- setting => value,...);
-
-=head1 USAGE PATTERN FOR SIMPLE APPLICATIONS
-
- $authreq->check_ok() or return;
-
- blah blah blah
- $authreq->check_mutate();
- blah blah blah
-
-=head1 USAGE PATTERN FOR FANCY APPLICATIONS
-
- my $divert_kind = $authreq->check_divert();
- if ($divert_kind) {
- if ($divert_kind eq 'LOGGEDOUT') {
- print "goodbye you are now logged out" and quit
- } elsif ($divert_kind eq 'NOCOOKIES') {
- print "you need cookies" and quit
- ... etc.
- }
- }
-
- blah blah blah
- $authreq->check_mutate();
- blah blah blah
+1;
~ian / cgi-auth-flexible.git / blobdiff