Apache2::Access - A Perl API for Apache request object: Access, Authentication and Authorization.
use Apache2::Access (); # allow only GET method $r->allow_methods(1, qw(GET)); # Apache Options value $options = $r->allow_options(); # Apache AllowOverride value $allow_override = $r->allow_overrides(); # which Options are allowed by AllowOverride (since Apache 2.2) $allow_override_opts = $r->allow_override_opts(); # auth name ("foo bar") $auth_name = $r->auth_name(); # auth type $auth_type = $r->auth_type(); $r->auth_type("Digest"); # Basic authentication process my ($rc, $passwd) = $r->get_basic_auth_pw(); # the login name of the remote user (RFC1413) $remote_logname = $r->get_remote_logname(); # dynamically figure out which auth has failed $r->note_auth_failure(); # note Basic auth failure $r->note_basic_auth_failure(); # note Digest auth failure $r->note_digest_auth_failure(); # Apache Request value(s) $requires = $r->requires(); # Apache Satisfy value (as a number) $satisfy = $r->satisfies(); # check whether some auth is configured $need_auth = $r->some_auth_required();
The API provided by this module deals with access, authentication and authorization phases.
Apache2::Access extends Apache2::RequestRec.
Apache2::Access
Apache2::RequestRec
Apache2::Access provides the following functions and/or methods:
allow_methods
Specify which HTTP methods are allowed
$r->allow_methods($reset); $r->allow_methods($reset, @methods);
$r
Apache2::RequestRec object
The current request
$reset
If a true value is passed all the previously allowed methods are removed. Otherwise the list is left intact.
@methods
a list of HTTP methods to be allowed (e.g. GET and POST)
GET
POST
For example: here is how to allow only GET and POST methods, regardless to what was the previous setting:
$r->allow_methods(1, qw(GET POST));
allow_options
Retrieve the value of Options for this request
Options
$options = $r->allow_options();
$options
the Options bitmask. Normally used with bitlogic operators against Apache2::Const :options constants.
Apache2::Const :options constants
For example if the configuration for the current request was:
Options None Options Indexes FollowSymLinks
The following applies:
use Apache2::Const -compile => qw(:options); $r->allow_options & Apache2::Const::OPT_INDEXES; # TRUE $r->allow_options & Apache2::Const::OPT_SYM_LINKS; # TRUE $r->allow_options & Apache2::Const::OPT_EXECCGI; # FALSE
allow_overrides
Retrieve the value of AllowOverride for this request
AllowOverride
$allow_override = $r->allow_overrides();
$allow_override
the AllowOverride bitmask. Normally used with bitlogic operators against Apache2::Const :override constants.
Apache2::Const :override constants
AllowOverride AuthConfig
use Apache2::Const -compile => qw(:override); $r->allow_overrides & Apache2::Const::OR_AUTHCFG; # TRUE $r->allow_overrides & Apache2::Const::OR_LIMIT; # FALSE
allow_override_opts
Retrieve the bitmask of allowed Options set by AllowOverride Options=... for this request
AllowOverride Options=...
$override_opts = $r->allow_override_opts();
Enabling single options was introduced in Apache 2.2. For Apache 2.0 this function returns Apache2::Const::OPT_UNSET | Apache2::Const::OPT_ALL | Apache2::Const::OPT_INCNOEXEC | Apache2::Const::OPT_SYM_OWNER | Apache2::Const::OPT_MULTI, which corresponds to the default value (if not set) for Apache 2.2.
Apache2::Const::OPT_UNSET
Apache2::Const::OPT_ALL
Apache2::Const::OPT_INCNOEXEC
Apache2::Const::OPT_SYM_OWNER
Apache2::Const::OPT_MULTI
$override_opts
the override options bitmask. Normally used with bitlogic operators against Apache2::Const :options constants.
AllowOverride Options=Indexes,ExecCGI
use Apache2::Const -compile => qw(:options); $r->allow_override_opts & Apache2::Const::OPT_EXECCGI; # TRUE $r->allow_override_opts & Apache2::Const::OPT_SYM_LINKS; # FALSE
auth_name
Get/set the current Authorization realm (the per directory configuration directive AuthName):
AuthName
$auth_name = $r->auth_name(); $auth_name = $r->auth_name($new_auth_name);
$new_auth_name
If $new_auth_name is passed a new AuthName value is set
$
The current value of AuthName
The AuthName directive creates protection realm within the server document space. To quote RFC 1945 "These realms allow the protected resources on a server to be partitioned into a set of protection spaces, each with its own authentication scheme and/or authorization database." The client uses the root URL of the server to determine which authentication credentials to send with each HTTP request. These credentials are tagged with the name of the authentication realm that created them. Then during the authentication stage the server uses the current authentication realm, from $r->auth_name, to determine which set of credentials to authenticate.
$r->auth_name
auth_type
Get/set the type of authorization required for this request (the per directory configuration directive AuthType):
AuthType
$auth_type = $r->auth_type(); $auth_type = $r->auth_type($new_auth_type);
$new_auth_type
If $new_auth_type is passed a new AuthType value is set
The current value of AuthType
Normally AuthType would be set to Basic to use the basic authentication scheme defined in RFC 1945, Hypertext Transfer Protocol -- HTTP/1.0. However, you could set to something else and implement your own authentication scheme.
Basic
get_basic_auth_pw
Get the password from the request headers
my ($rc, $passwd) = $r->get_basic_auth_pw();
$rc
Apache2::Const constant
Apache2::Const::OK if the $passwd value is set (and assured a correct value in $r->user); otherwise it returns an error code, either Apache2::Const::HTTP_INTERNAL_SERVER_ERROR if things are really confused, Apache2::Const::HTTP_UNAUTHORIZED if no authentication at all seemed to be in use, or Apache2::Const::DECLINED if there was authentication, but it wasn't Basic (in which case, the caller should presumably decline as well).
Apache2::Const::OK
$passwd
$r->user
Apache2::Const::HTTP_INTERNAL_SERVER_ERROR
Apache2::Const::HTTP_UNAUTHORIZED
Apache2::Const::DECLINED
$ret
The password as set in the headers (decoded)
If AuthType is not set, this handler first sets it to Basic.
get_remote_logname
Retrieve the login name of the remote user (RFC1413)
$remote_logname = $r->get_remote_logname();
$remote_logname
The username of the user logged in to the client machine, or an empty string if it could not be determined via RFC1413, which involves querying the client's identd or auth daemon.
Do not confuse this method with $r->user, which provides the username provided by the user during the server authentication.
note_auth_failure
Setup the output headers so that the client knows how to authenticate itself the next time, if an authentication request failed. This function works for both basic and digest authentication
$r->note_auth_failure();
This method requires AuthType to be set to Basic or Digest. Depending on the setting it'll call either $r->note_basic_auth_failure or $r->note_digest_auth_failure.
Digest
$r->note_basic_auth_failure
$r->note_digest_auth_failure
note_basic_auth_failure
Setup the output headers so that the client knows how to authenticate itself the next time, if an authentication request failed. This function works only for basic authentication
$r->note_basic_auth_failure();
note_digest_auth_failure
Setup the output headers so that the client knows how to authenticate itself the next time, if an authentication request failed. This function works only for digest authentication.
$r->note_digest_auth_failure();
requires
Retrieve information about all of the requires directives for this request
$requires = $r->requires
$requires
Returns an array reference of hash references, containing information related to the require directive.
require
This is normally used for access control.
For example if the configuration had the following require directives:
Require user goo bar Require group bar tar
this method will return the following datastructure:
[ { 'method_mask' => -1, 'requirement' => 'user goo bar' }, { 'method_mask' => -1, 'requirement' => 'group bar tar' } ];
The requirement field is what was passed to the Require directive. The method_mask field is a bitmask which can be modified by the Limit directive, but normally it can be safely ignored as it's mostly used internally. For example if the configuration was:
Require
Limit
Require user goo bar Require group bar tar <Limit POST> Require valid-user </Limit>
and the request method was POST, $r->requires will return:
$r->requires
[ { 'method_mask' => -1, 'requirement' => 'user goo bar' }, { 'method_mask' => -1, 'requirement' => 'group bar tar' } { 'method_mask' => 4, 'requirement' => 'valid-user' } ];
But if the request method was GET, it will return only:
As you can see Apache gives you the requirements relevant for the current request, so the method_mask is irrelevant.
It is also a good time to remind that in the general case, access control directives should not be placed within a <Limit> section. Refer to the Apache documentation for more information.
Using the same configuration and assuming that the request was of type POST, the following code inside an Auth handler:
my %require = map { my ($k, $v) = split /\s+/, $_->{requirement}, 2; ($k, $v||'') } @{ $r->requires };
will populate %require with the following pairs:
%require
'group' => 'bar tar', 'user' => 'goo bar', 'valid-user' => '',
satisfies
How the requires lines must be met. What's the applicable value of the Satisfy directive:
Satisfy
$satisfy = $r->satisfies();
$satisfy
How the requirements must be met. One of the Apache2::Const :satisfy constants:
Apache2::Const :satisfy constants
Apache2::Const::SATISFY_ANY, Apache2::Const::SATISFY_ALL and Apache2::Const::SATISFY_NOSPEC.
Apache2::Const::SATISFY_ANY
Apache2::Const::SATISFY_ALL
Apache2::Const::SATISFY_NOSPEC
See the documentation for the Satisfy directive in the Apache documentation.
some_auth_required
Can be used within any handler to determine if any authentication is required for the current request:
$need_auth = $r->some_auth_required();
$need_auth
TRUE if authentication is required, FALSE otherwise
mod_perl 2.0 documentation.
mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 2.0.
The mod_perl development team and numerous contributors.
To install Apache2::Access, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Apache2::Access
CPAN shell
perl -MCPAN -e shell install Apache2::Access
For more information on module installation, please visit the detailed CPAN module installation guide.