-package Apache2::Authen::Passphrase 0.001;
+package Apache2::Authen::Passphrase;
+
+our $VERSION = 0.002;
use 5.014000;
use strict;
use warnings;
use parent qw/Exporter/;
+use subs qw/OK HTTP_UNAUTHORIZED/;
use constant +{
USER_REGEX => qr/^\w{2,20}$/pa,
BAD_PASSWORD => "bad-password\n",
};
-use Apache2::RequestRec;
-use Apache2::Access;
-use Apache2::Const qw/OK HTTP_UNAUTHORIZED/;
+use if $ENV{MOD_PERL}, 'Apache2::RequestRec';
+use if $ENV{MOD_PERL}, 'Apache2::Access';
+use if $ENV{MOD_PERL}, 'Apache2::Const' => qw/OK HTTP_UNAUTHORIZED/;
use Authen::Passphrase;
use Authen::Passphrase::BlowfishCrypt;
use YAML::Any qw/LoadFile DumpFile/;
##################################################
-our $rootdir;
+our $rootdir //= $ENV{AAP_ROOTDIR};
sub pwhash{
my ($pass)=@_;
sub pwset{
my ($user, $pass)=@_;
- my $file = "$rootdir/us/$user.yml";
+ my $file = "$rootdir/$user.yml";
my $conf = eval { LoadFile $file } // undef;
$conf->{passphrase}=pwhash $pass;
$conf->{passphrase_version}=PASSPHRASE_VERSION;
my ($user, $pass)=@_;
die INVALID_USER unless $user =~ USER_REGEX;
$user=${^MATCH};# Make taint shut up
- my $conf=LoadFile "$rootdir/us/$user.yml";
+ my $conf=LoadFile "$rootdir/$user.yml";
die BAD_PASSWORD unless keys $conf;# Empty hash means no such user
die BAD_PASSWORD unless Authen::Passphrase->from_rfc2307($conf->{passphrase})->match($pass);
sub handler{
my $r=shift;
+ local $rootdir = $r->dir_config('AuthenPassphraseRootdir');
my ($rc, $pass) = $r->get_basic_auth_pw;
return $rc unless $rc == OK;
=head1 SYNOPSIS
use Apache2::Authen::Passphrase qw/pwcheck pwset pwhash/;
+ $Apache2::Authen::Passphrase::rootdir = "/path/to/user/directory"
my $hash = pwhash $username, $password;
pwset $username, "pass123";
eval { pwcheck $username, "pass123" };
# In Apache2 config
<Location /secret>
PerlAuthenHandler Apache2::Authen::Passphrase
+ PerlSetVar AuthenPassphraseRootdir /path/to/user/directory
AuthName MyAuth
Require valid-user
</Location>
Apache2::Authen::Passphrase is a perl module which provides easy-to-use Apache2 authentication. It exports some utility functions and it contains a PerlAuthenHandler.
+The password hashes are stored in YAML files in an directory (called the C<rootdir>), one file per user.
+
+Set the C<rootdir> like this:
+
+ $Apache2::Authen::Passphrase::rootdir = '/path/to/rootdir';
+
+or by setting the C<AAP_ROOTDIR> enviroment variable to the desired value.
+
=head1 FUNCTIONS
=over
=back
+=head1 ENVIRONMENT
+
+=over
+
+=item AAP_ROOTDIR
+
+If the C<rootdir> is not explicitly set, it is taken from this environment variable.
+
+=back
+
=head1 AUTHOR
Marius Gavrilescu, E<lt>marius@ieval.roE<gt>