@EXPORT = qw();
%EXPORT_TAGS = ( ); # eg: TAG => [ qw!name1 name2! ],
- @EXPORT_OK = qw();
+ @EXPORT_OK = qw(@default_db_setup_stmts);
}
our @EXPORT_OK;
use Digest::SHA;
use Data::Dumper;
use File::Copy;
+use Cwd qw/realpath/;
+
#---------- public utilities ----------
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) = @_;
'</address>');
}
+our @default_db_setup_stmts =
+ ("CREATE TABLE $v->{S}{db_prefix}_assocs (".
+ " assochash VARCHAR PRIMARY KEY,".
+ " username VARCHAR NOT NULL,".
+ " last INTEGER NOT NULL".
+ ")"
+ ,
+ "CREATE INDEX $v->{S}{db_prefix}_assocs_timeout_index".
+ " ON $v->{S}{db_prefix}_assocs".
+ " (last)"
+ );
+
#---------- licence and source code ----------
sub srcdump_dump ($$$) {
}
}
-sub srcdump_process_dir ($$$$$$) {
- my ($c, $v, $dumpdir, $incdir, $tarballcounter,
- $needlicence, $dirsdone) = @_;
- return () if $v->_ch('srcdump_system_dir', $incdir);
- my $upwards = $incdir;
+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#/+$##;
+ $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 die "check $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 if $dirsdone->{$upwards}++;
- return $v->_ch(('srcdump_byvcs_'.lc $try),
- $dumpdir, $upwards, $tarballcounter);
+ return $v->_ch('srcdump_byvcs', $dumpdir, $upwards, $outfn, lc $&);
}
- $upwards =~ s#/*[^/]+##;
+ $upwards =~ s#/*[^/]+$##;
}
- return $v->_ch('srcdump_novcs', $dumpdir, $incdir, $tarballcounter);
+ return $v->_ch('srcdump_novcs', $dumpdir, $item, $outfn);
}
sub srcdump_novcs ($$$$$) {
- my ($c, $v, $dumpdir, $dir, $tarballcounter) = @_;
- my $script = 'find -type f -perm +004';
- foreach my $excl (@{ $v->{S}{srcdump_excludes} }) {
- $script .= " \\! -name '$excl'";
+ 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";
}
- $script .= " -print0";
- return srcdump_dir_cpio($c,$v,$dumpdir,$dir,$tarballcounter,$script);
}
-sub srcdump_byvcs_git ($$$$$) {
- my ($c, $v, $dumpdir, $dir, $tarballcounter) = @_;
- return srcdump_dir_cpio($c,$v,$dumpdir,$dir,$tarballcounter,"
- git-ls-files -z;
- git-ls-files -z --others --exclude-from=.gitignore;
- find .git -print0
- ");
+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_dir_cpio ($$$$$) {
- my ($c,$v,$dumpdir,$dir,$tarballcounter,$script) = @_;
- my $outfile = "$dumpdir/$$tarballcounter.tar";
+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','',"
+ exec '/bin/bash','-ec',"
set -o pipefail
(
$script
die $!;
}
$!=0; (waitpid $pid, 0) == $pid or die "$!";
- die "$dir ($script) $outfile $?" if $?;
- print STDERR
- "CGI::Auth::Flexible srcdump_dir_cpio saved $dir into $outfile\n"
- or die $!;
- $$tarballcounter++;
- return $outfile;
+ die "$dir ($how $script) $outfile $?" if $?;
}
sub srcdump_dirscan_prepare ($$) {
or die "$v->{S}{srcdump_licence_path} $!";
$needlicence = undef;
}
- my $srctarballcounter = 'aaa';
+ 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;
- my @srcfiles = ("$dumpdir/licence.data");
- foreach my $incdir ($v->_ch('srcdump_includedirs')) {
+ foreach my $item ($v->_ch('srcdump_listitems')) {
+ 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("$incdir/$try", $needlicence);
- $!==&ENOENT or die "copy $incdir/$try $!";
+ last if copy("$item/$try", $needlicence);
+ $!==&ENOENT or $!==&ENOTDIR or die "copy $item/$try $!";
}
}
- push @srcfiles, $v->_ch('srcdump_process_dir', $dumpdir, $incdir,
- \$srctarballcounter, \$needlicence, \%dirsdone);
- $dirsdone{$incdir}++;
+ $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 $r = system qw(tar -zvvc -f), "$dumpdir/source.tmp", '--', @srcfiles;
- die "tar $r $!" if $r;
+ 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, 'licence', 'text/plain');
srcdump_install($c,$v, $dumpdir, 'source', 'application/octet-stream');
close $lockf or die $!;
}
assocdb_dsn => undef,
assocdb_user => '',
assocdb_password => '',
- assocdb_table => 'caf_assocs',
+ db_prefix => 'caf',
+ assocdb_setup_stmts => [@_default_db_setup_statements],
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 => "/",
srcdump_prepare => \&srcdump_dirscan_prepare,
srcdump_licence_path => undef,
srcdump_licence_files => [qw(AGPLv3 CGI/Auth/Flexible/AGPLv3)],
- srcdump_includedirs => sub { return @INC; },
- srcdump_system_dir => sub { $_[2] =~ m#^/etc/|^/usr/(?!local/)#; },
- srcdump_process_dir => \&srcdump_process_dir,
- srcdump_vcs_dirs => [qw(.git .hg .svn CVS)],
- srcdump_byvcs_git => \&srcdump_byvcs_git,
- srcdump_byvcs_hg => \&srcdump_byvcs_hg,
- srcdump_byvcs_svn => \&srcdump_byvcs_svn,
- srcdump_byvcs_cvs => \&srcdump_byvcs_cvs,
+ 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,
};
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;
}
bless $verifier, $class;
}
$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 (@default_db_setup_stmts) {
+ $v->_db_setup_do($stmt);
+ }
return $dbh;
}
# 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
my $cooks = $r->_ch('get_cookie');
- 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,
" enabled. You must enable cookies".
" as we use them for login."),
CookieSecret => $r->_fresh_secret(),
- Params => $r->chain_params() })
+ Params => $r->_chain_params() })
}
if (!$cookt || $cookt eq 'n' || $cookh ne $parmh) {
$r->_db_revoke($cookh);
return ({ Kind => 'LOGIN-BAD',
Message => $login_errormessage,
CookieSecret => $cooks,
- Params => $r->chain_params() })
+ Params => $r->_chain_params() })
}
$r->_db_record_login_ok($parmh,$username);
return ({ Kind => 'REDIRECT-LOGGEDIN',
Message => $r->_gt("Logging in..."),
CookieSecret => $cooks,
- Params => $r->chain_params() });
+ Params => $r->_chain_params() });
}
if ($cookt eq 't') {
$cookt = '';
return ({ Kind => 'LOGIN-INCOMINGLINK',
Message => $r->_gt("You need to log in."),
CookieSecret => $news,
- Params => $r->chain_params() });
+ Params => $r->_chain_params() });
} else {
$r->_db_revoke($parmh);
return ({ Kind => 'LOGIN-FRESH',
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";
return undef;
}
-sub chain_params ($) {
+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} }) {
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);
}
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 ];
$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($nonpagetype);
+ return if $r->{ParmT};
+ die "missing hidden secret parameter on nonpage request $nonpagetype";
}
#---------- output ----------
}
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_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