|
|
allow_methodsallow_optionsallow_overridesallow_override_optsauth_nameauth_typeget_basic_auth_pwget_remote_lognamenote_auth_failurenote_basic_auth_failurenote_digest_auth_failurerequiressatisfiessome_auth_required
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|docs::2.0::api::Apache2::RequestRec|/Description.
Apache2::Access provides the following functions and/or methods:
allow_methodsSpecify which HTTP methods are allowed
$r->allow_methods($reset); $r->allow_methods($reset, @methods);
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
The current request
$reset ( boolean )
If a true value is passed all the previously allowed methods are removed. Otherwise the list is left intact.
@methods ( array of strings )
a list of HTTP methods to be allowed (e.g. GET and 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_optionsRetrieve the value of Options for this request
$options = $r->allow_options();
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
The current request
$options ( integer )
the Options bitmask. Normally used with bitlogic operators against
Apache2::Const :options
constants|docs::2.0::api::Apache2::Const/C__options_>.
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_overridesRetrieve the value of AllowOverride for this request
$allow_override = $r->allow_overrides();
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
The current request
$allow_override ( integer )
the AllowOverride bitmask. Normally used with bitlogic operators
against Apache2::Const :override
constants|docs::2.0::api::Apache2::Const/C__override_>.
For example if the configuration for the current request was:
AllowOverride AuthConfig
The following applies:
use Apache2::Const -compile => qw(:override); $r->allow_overrides & Apache2::Const::OR_AUTHCFG; # TRUE $r->allow_overrides & Apache2::Const::OR_LIMIT; # FALSE
allow_override_optsRetrieve the bitmask of allowed Options set by AllowOverride Options=...
for this request
$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|docs::2.0::api::Apache2::Const/C_Apache2__Const__OPT_UNSET_ |
Apache2::Const::OPT_ALL|docs::2.0::api::Apache2::Const/C_Apache2__Const__OPT_ALL_ |
Apache2::Const::OPT_INCNOEXEC|docs::2.0::api::Apache2::Const/C_Apache2__Const__OPT_INCNOEXEC_ |
Apache2::Const::OPT_SYM_OWNER|docs::2.0::api::Apache2::Const/C_Apache2__Const__OPT_SYM_OWNER_ |
Apache2::Const::OPT_MULTI|docs::2.0::api::Apache2::Const/C_Apache2__Const__OPT_MULTI_,
which corresponds to the default value (if not set) for Apache 2.2.
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
The current request
$override_opts ( integer )
the override options bitmask. Normally used with bitlogic operators
against Apache2::Const :options
constants|docs::2.0::api::Apache2::Const/C__options_>.
For example if the configuration for the current request was:
AllowOverride Options=Indexes,ExecCGI
The following applies:
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_nameGet/set the current Authorization realm (the per directory
configuration directive AuthName):
$auth_name = $r->auth_name(); $auth_name = $r->auth_name($new_auth_name);
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
The current request
$new_auth_name ( string )
If $new_auth_name is passed a new AuthName value is set
$ ( integer )
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.
auth_typeGet/set the type of authorization required for this request (the per
directory configuration directive AuthType):
$auth_type = $r->auth_type(); $auth_type = $r->auth_type($new_auth_type);
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
The current request
$new_auth_type ( string )
If $new_auth_type is passed a new AuthType value is set
$ ( integer )
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.
get_basic_auth_pwGet the password from the request headers
my ($rc, $passwd) = $r->get_basic_auth_pw();
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
The current request
$rc
( Apache2::Const constant|docs::2.0::api::Apache2::Const )
Apache2::Const::OK if the $passwd value is set (and assured a correct
value in
$r->user|docs::2.0::api::Apache2::RequestRec/C_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).
$ret (string)
The password as set in the headers (decoded)
If AuthType|/C_auth_type_ is not set, this handler first sets it
to Basic.
get_remote_lognameRetrieve the login name of the remote user (RFC1413)
$remote_logname = $r->get_remote_logname();
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
The current request
$remote_logname ( string )
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|docs::2.0::api::Apache2::RequestRec/C_user_, which
provides the username provided by the user during the server
authentication.
note_auth_failureSetup 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();
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
The current request
This method requires AuthType to be set to Basic or
Digest. Depending on the setting it'll call either
$r->note_basic_auth_failure|/C_note_basic_auth_failure_ or
$r->note_digest_auth_failure|/C_note_digest_auth_failure_.
note_basic_auth_failureSetup 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();
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
The current request
note_digest_auth_failureSetup 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();
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
The current request
requiresRetrieve information about all of the requires directives for this request
$requires = $r->requires
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
The current request
$requires ( ARRAY ref )
Returns an array reference of hash references, containing information
related to the require directive.
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 user goo bar
Require group bar tar
<Limit POST>
Require valid-user
</Limit>
and the request method was POST, $r->requires will return:
[
{
'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:
[
{
'method_mask' => -1,
'requirement' => 'user goo bar'
},
{
'method_mask' => -1,
'requirement' => 'group bar tar'
}
];
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:
'group' => 'bar tar', 'user' => 'goo bar', 'valid-user' => '',
satisfiesHow the requires lines must be met. What's the applicable value of the
Satisfy directive:
$satisfy = $r->satisfies();
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
The current request
$satisfy ( integer )
How the requirements must be met. One of the Apache2::Const
:satisfy constants|docs::2.0::api::Apache2::Const/C__satisfy_>:
Apache2::Const::SATISFY_ANY|docs::2.0::api::Apache2::Const/C_Apache2__Const__SATISFY_ANY_,
Apache2::Const::SATISFY_ALL|docs::2.0::api::Apache2::Const/C_Apache2__Const__SATISFY_ALL_
and
Apache2::Const::SATISFY_NOSPEC|docs::2.0::api::Apache2::Const/C_Apache2__Const__SATISFY_NOSPEC_.
See the documentation for the Satisfy directive in the Apache
documentation.
some_auth_requiredCan be used within any handler to determine if any authentication is required for the current request:
$need_auth = $r->some_auth_required();
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
The current request
$need_auth ( boolean )
TRUE if authentication is required, FALSE otherwise
mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 2.0.