1 package Apache2
::Authen
::Passphrase
;
6 use parent qw
/Exporter/;
7 use subs qw
/OK HTTP_UNAUTHORIZED/;
9 our $VERSION = 0.002001;
11 use constant USER_REGEX
=> qr/^\w{2,20}$/pas;
12 use constant PASSPHRASE_VERSION
=> 1;
13 use constant INVALID_USER
=> "invalid-user\n";
14 use constant BAD_PASSWORD
=> "bad-password\n";
16 use if $ENV{MOD_PERL
}, 'Apache2::RequestRec';
17 use if $ENV{MOD_PERL
}, 'Apache2::Access';
18 use if $ENV{MOD_PERL
}, 'Apache2::Const' => qw
/OK HTTP_UNAUTHORIZED/;
19 use Authen
::Passphrase
;
20 use Authen
::Passphrase
::BlowfishCrypt
;
21 use YAML
::Any qw
/LoadFile DumpFile/;
23 our @EXPORT_OK = qw
/pwset pwcheck pwhash USER_REGEX PASSPHRASE_VERSION INVALID_USER BAD_PASSWORD/;
25 ##################################################
28 $rootdir //= $ENV{AAP_ROOTDIR
};
33 my $ppr=Authen
::Passphrase
::BlowfishCrypt
->new(
45 my $file = "$rootdir/$user.yml";
46 my $conf = eval { LoadFile
$file } // undef;
47 $conf->{passphrase
}=pwhash
$pass;
48 $conf->{passphrase_version
}=PASSPHRASE_VERSION
;
49 DumpFile
$file, $conf;
56 die INVALID_USER
unless $user =~ USER_REGEX
; ## no critic (RequireCarping)
57 $user=${^MATCH
};# Make taint shut up
58 my $conf=LoadFile
"$rootdir/$user.yml";
60 ## no critic (RequireCarping)
61 die BAD_PASSWORD
unless keys $conf;# Empty hash means no such user
62 die BAD_PASSWORD
unless Authen
::Passphrase
->from_rfc2307($conf->{passphrase
})->match($pass);
64 pwset
$user, $pass if $conf->{passphrase_version
} < PASSPHRASE_VERSION
69 local $rootdir = $r->dir_config('AuthenPassphraseRootdir');
71 my ($rc, $pass) = $r->get_basic_auth_pw;
72 return $rc unless $rc == OK
;
75 unless (eval { pwcheck
$user, $pass; 1 }) {
76 $r->note_basic_auth_failure;
77 return HTTP_UNAUTHORIZED
88 Apache2::Authen::Passphrase - basic authentication with Authen::Passphrase
92 use Apache2::Authen::Passphrase qw/pwcheck pwset pwhash/;
93 $Apache2::Authen::Passphrase::rootdir = "/path/to/user/directory"
94 my $hash = pwhash $username, $password;
95 pwset $username, "pass123";
96 eval { pwcheck $username, "pass123" };
100 PerlAuthenHandler Apache2::Authen::Passphrase
101 PerlSetVar AuthenPassphraseRootdir /path/to/user/directory
108 Apache2::Authen::Passphrase is a perl module which provides easy-to-use Apache2 authentication. It exports some utility functions and it contains a PerlAuthenHandler.
110 The password hashes are stored in YAML files in an directory (called the C<rootdir>), one file per user.
112 Set the C<rootdir> like this:
114 $Apache2::Authen::Passphrase::rootdir = '/path/to/rootdir';
116 or by setting the C<AAP_ROOTDIR> enviroment variable to the desired value.
124 Takes the password as a single argument and returns the password hash.
126 =item B<pwset>(I<$username>, I<$password>)
128 Sets the password of $username to $password.
130 =item B<pwcheck>(I<$username>, I<$password>)
132 Checks the given username and password, throwing an exception if the username is invalid or the password is incorrect.
136 The PerlAuthenHandler for use in apache2. It uses Basic Access Authentication.
140 A regex that matches valid usernames. Usernames must be at least 2 characters, at most 20 characters, and they may only contain word characters (C<[A-Za-z0-9_]>).
142 =item B<INVALID_USER>
144 Exception thrown if the username does not match C<USER_REGEX>.
146 =item B<BAD_PASSWORD>
148 Exception thrown if the password is different from the one stored in the user's yml file.
150 =item B<PASSPHRASE_VERSION>
152 The version of the passphrase. It is incremented each time the passphrase hashing scheme is changed. Versions so far:
156 =item Version 1 B<(current)>
158 Uses C<Authen::Passphrase::BlowfishCrypt> with a cost factor of 10
170 If the C<rootdir> is not explicitly set, it is taken from this environment variable.
176 Marius Gavrilescu, E<lt>marius@ieval.roE<gt>
178 =head1 COPYRIGHT AND LICENSE
180 Copyright (C) 2013 by Marius Gavrilescu
182 This library is free software; you can redistribute it and/or modify
183 it under the same terms as Perl itself, either Perl version 5.14.2 or,
184 at your option, any later version of Perl 5 you may have available.