| <?xml version="1.0" encoding="ISO-8859-1"?> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!-- |
| XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| This file is generated from xml source: DO NOT EDIT |
| XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| --> |
| <title>mod_authz_core - Apache HTTP Server</title> |
| <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /> |
| <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" /> |
| <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /> |
| <link href="../images/favicon.ico" rel="shortcut icon" /></head> |
| <body> |
| <div id="page-header"> |
| <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p> |
| <p class="apache">Apache HTTP Server Version 2.3</p> |
| <img alt="" src="../images/feather.gif" /></div> |
| <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div> |
| <div id="path"> |
| <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.3</a> > <a href="./">Modules</a></div> |
| <div id="page-content"> |
| <div id="preamble"><h1>Apache Module mod_authz_core</h1> |
| <div class="toplang"> |
| <p><span>Available Languages: </span><a href="../en/mod/mod_authz_core.html" title="English"> en </a></p> |
| </div> |
| <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Core Authorization</td></tr> |
| <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr> |
| <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>authz_core_module</td></tr> |
| <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_authz_core.c</td></tr> |
| <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.3 and later</td></tr></table> |
| <h3>Summary</h3> |
| |
| <p>This module provides core authorization capabilities so that |
| authenticated users can be allowed or denied access to portions |
| of the web site. <code class="module"><a href="../mod/mod_authz_core.html">mod_authz_core</a></code> provides the |
| functionality to register various authorization providers. It is |
| usually used in conjunction with an authentication |
| provider module such as <code class="module"><a href="../mod/mod_authn_file.html">mod_authn_file</a></code> and an |
| authorization module such as <code class="module"><a href="../mod/mod_authz_user.html">mod_authz_user</a></code>. It |
| also allows for advanced logic to be applied to the |
| authorization processing.</p> |
| </div> |
| <div id="quickview"><h3 class="directives">Directives</h3> |
| <ul id="toc"> |
| <li><img alt="" src="../images/down.gif" /> <a href="#authzprovideralias"><AuthzProviderAlias></a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#match">Match</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#matchall"><MatchAll></a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#matchany"><MatchAny></a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#matchnotall"><MatchNotAll></a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#matchnotany"><MatchNotAny></a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#mergeauthz">MergeAuthz</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#require">Require</a></li> |
| </ul> |
| <h3>Topics</h3> |
| <ul id="topics"> |
| <li><img alt="" src="../images/down.gif" /> <a href="#authzalias">Creating Authorization Provider Aliases</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#logic">Authorization Containers</a></li> |
| </ul></div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="section"> |
| <h2><a name="authzalias" id="authzalias">Creating Authorization Provider Aliases</a></h2> |
| |
| <p>Extended authorization providers can be created within the configuration |
| file and assigned an alias name. The alias providers can then be referenced |
| through the <code class="directive"><a href="#require">Require</a></code> and |
| <code class="directive"><a href="#match">Match</a></code> directives |
| in the same way as a base authorization provider. Besides the ability to |
| create and alias an extended provider, it also allows the same extended |
| authorization provider to be reference by multiple locations. |
| </p> |
| |
| <h3><a name="example" id="example">Example</a></h3> |
| <p>The example below creates two different ldap authorization provider |
| aliases based on the ldap-group authorization provider. This example |
| allows a single authorization location to check group membership within |
| multiple ldap hosts: |
| </p> |
| |
| <div class="example"><h3>Example</h3><p><code> |
| <AuthzProviderAlias ldap-group ldap-group-alias1 cn=my-group,o=ctx><br /> |
| <span class="indent"> |
| AuthLDAPBindDN cn=youruser,o=ctx<br /> |
| AuthLDAPBindPassword yourpassword<br /> |
| AuthLDAPURL ldap://ldap.host/o=ctx<br /> |
| </span> |
| </AuthzProviderAlias><br /><br /> |
| <AuthzProviderAlias ldap-group ldap-group-alias2 |
| cn=my-other-group,o=dev><br /> |
| <span class="indent"> |
| AuthLDAPBindDN cn=yourotheruser,o=dev<br /> |
| AuthLDAPBindPassword yourotherpassword<br /> |
| AuthLDAPURL ldap://other.ldap.host/o=dev?cn<br /> |
| </span> |
| </AuthzProviderAlias><br /><br /> |
| |
| Alias /secure /webpages/secure<br /> |
| <Directory /webpages/secure><br /> |
| <span class="indent"> |
| Order deny,allow<br /> |
| Allow from all<br /><br /> |
| |
| AuthBasicProvider file<br /><br /> |
| |
| AuthType Basic<br /> |
| AuthName LDAP_Protected_Place<br /><br /> |
| |
| #implied OR operation<br /> |
| Require alias1-ldap-group<br /> |
| Require alias2-ldap-group<br /> |
| </span> </Directory><br /> |
| </code></p></div> |
| |
| |
| </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="section"> |
| <h2><a name="logic" id="logic">Authorization Containers</a></h2> |
| |
| <p>The authorization container directives |
| <code class="directive"><a href="#matchall"><MatchAll></a></code>, |
| <code class="directive"><a href="#matchany"><MatchAny></a></code>, |
| <code class="directive"><a href="#matchnotall"><MatchNotAll></a></code> |
| and |
| <code class="directive"><a href="#matchnotany"><MatchNotAny></a></code> |
| may be combined with each other and with the |
| <code class="directive"><a href="#match">Match</a></code> |
| directive to express complex authorization logic.</p> |
| |
| <p>The example below expresses the following authorization logic. |
| In order to access the resource, the user must either be the |
| <code>superadmin</code> user, or belong to both the |
| <code>admins</code> group and the <code>Administrators</code> LDAP |
| group and either belong to the <code>sales</code> group or |
| have the LDAP <code>dept</code> attribute <code>sales</code>. |
| Furthermore, in order to access the resource, the user must |
| not belong to either the <code>temps</code> group or the |
| LDAP group <code>Temporary Employees</code>.</p> |
| |
| <div class="example"><p><code> |
| <Directory /www/mydocs> |
| <span class="indent"> |
| <MatchAny> |
| <span class="indent"> |
| Match user superadmin<br /> |
| <MatchAll> |
| <span class="indent"> |
| Match group admins<br /> |
| Match ldap-group cn=Administrators,o=Airius<br /> |
| <MatchAny> |
| <span class="indent"> |
| Match group sales<br /> |
| Match ldap-attribute dept="sales" |
| </span> |
| </MatchAny> |
| </span> |
| </MatchAll> |
| </span> |
| </MatchAny><br /> |
| <MatchNotAny> |
| <span class="indent"> |
| Match group temps<br /> |
| Match ldap-group cn=Temporary Employees,o=Airius |
| </span> |
| </MatchNotAny> |
| </span> |
| </Directory> |
| </code></p></div> |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="AuthzProviderAlias" id="AuthzProviderAlias"><AuthzProviderAlias></a> <a name="authzprovideralias" id="authzprovideralias">Directive</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enclose a group of directives that represent an |
| extension of a base authorization provider and referenced by the specified |
| alias</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code><AuthzProviderAlias <var>baseProvider Alias Require-Parameters</var>> |
| ... </AuthzProviderAlias> |
| </code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authz_core</td></tr> |
| </table> |
| <p><code class="directive"><AuthzProviderAlias></code> and |
| <code></AuthzProviderAlias></code> are used to enclose a group of |
| authorization directives that can be referenced by the alias name using the |
| directive <code class="directive"><a href="#require">Require</a></code>.</p> |
| |
| |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="Match" id="Match">Match</a> <a name="match" id="match">Directive</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Tests whether an authenticated user is authorized by |
| an authorization provider.</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Match [not] <var>entity-name</var> |
| [<var>entity-name</var>] ...</code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> |
| <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authz_core</td></tr> |
| </table> |
| <p>This directive is similar to the |
| <code class="directive"><a href="#require">Require</a></code> directive; |
| it tests whether an authenticated user is authorized according to |
| a particular authorization provider and the specified restrictions.</p> |
| |
| <p>Unlike the <code class="directive"><a href="#require">Require</a></code> |
| directive, it may be used with and inside authorization container |
| directives such as |
| <code class="directive"><a href="#matchall"><MatchAll></a></code>.</p> |
| |
| <p>Furthermore, its result may be negated through the use of the |
| <code>not</code> option. As with other negated authorization directives, |
| in this case the <code class="directive">Match</code> directive may only |
| either fail or return a neutral result, and can therefore never |
| independently authorize a request.</p> |
| |
| <p>In the following example, all users in the <code>alpha</code> |
| and <code>beta</code> groups are authorized, except for those who |
| are also in the <code>reject</code> group.</p> |
| |
| <div class="example"><p><code> |
| <Directory /www/docs> |
| <span class="indent"> |
| Match group alpha beta<br /> |
| Match not group reject |
| </span> |
| </Directory> |
| </code></p></div> |
| |
| <p>When multiple <code class="directive">Match</code> directives are |
| used in a single |
| <a href="../sections.html#mergin">configuration section</a> |
| and are not contained in another authorization directive like |
| <code class="directive"><a href="#matchany"><MatchAny></a></code>, |
| they are implicitly contained within a |
| <code class="directive"><a href="#matchall"><MatchAll></a></code> |
| directive. Thus for the user to be authorized, all such |
| <code class="directive">Match</code> directives must not fail, and |
| at least one must be successful.</p> |
| |
| <div class="note"><code class="directive">Match</code> directives may not be combined |
| with the <code class="directive"><a href="#require">Require</a></code> |
| directive.</div> |
| |
| <h3>See also</h3> |
| <ul> |
| <li><code class="directive"><a href="#require">Require</a></code></li> |
| <li><a href="#logic">Authorization Containers</a></li> |
| <li><a href="../howto/auth.html">Authentication, Authorization, |
| and Access Control</a></li> |
| </ul> |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="MatchAll" id="MatchAll"><MatchAll></a> <a name="matchall" id="matchall">Directive</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enclose a group of authorization directives of which none |
| must fail and at least one must succeed for the enclosing directive to |
| succeed.</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code><MatchAll> |
| ... </MatchAll></code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> |
| <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authz_core</td></tr> |
| </table> |
| <p><code class="directive"><MatchAll></code> and |
| <code></MatchAll></code> are used to enclose a group of |
| authorization directives of which none must fail and at least one |
| must succeed in order for |
| the <code class="directive"><MatchAll></code> directive to |
| succeed.</p> |
| |
| <p>If none of the directives contained within the |
| <code class="directive"><MatchAll></code> directive fails, |
| and at least one succeeds, then the |
| <code class="directive"><MatchAll></code> directive |
| succeeds. If none succeed and none fail, then it returns a |
| neutral result. In all other cases, it fails.</p> |
| |
| <h3>See also</h3> |
| <ul> |
| <li><a href="#logic">Authorization Containers</a></li> |
| <li><a href="../howto/auth.html">Authentication, Authorization, |
| and Access Control</a></li> |
| </ul> |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="MatchAny" id="MatchAny"><MatchAny></a> <a name="matchany" id="matchany">Directive</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enclose a group of authorization directives of which one |
| must succeed for the enclosing directive to succeed.</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code><MatchAny> |
| ... </MatchAny></code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> |
| <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authz_core</td></tr> |
| </table> |
| <p><code class="directive"><MatchAny></code> and |
| <code></MatchAny></code> are used to enclose a group of |
| authorization directives of which one must succeed in order for |
| the <code class="directive"><MatchAny></code> directive to |
| succeed.</p> |
| |
| <p>If one or more of the directives contained within the |
| <code class="directive"><MatchAny></code> directive succeed, |
| then the <code class="directive"><MatchAny></code> directive |
| succeeds. If none succeed and none fail, then it returns a |
| neutral result. In all other cases, it fails.</p> |
| |
| <div class="note">Because negated authorization directives are unable to |
| return a successful result, they can not significantly influence |
| the result of a <code class="directive"><MatchAny></code> |
| directive. (At most they could cause the directive to fail in |
| the case where they failed and all other directives returned a |
| neutral value.) Therefore negated authorization directives |
| are not permitted within a <code class="directive"><MatchAny></code> |
| directive.</div> |
| |
| <h3>See also</h3> |
| <ul> |
| <li><a href="#logic">Authorization Containers</a></li> |
| <li><a href="../howto/auth.html">Authentication, Authorization, |
| and Access Control</a></li> |
| </ul> |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="MatchNotAll" id="MatchNotAll"><MatchNotAll></a> <a name="matchnotall" id="matchnotall">Directive</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enclose a group of authorization directives of which some |
| must fail or none must succeed for the enclosing directive to |
| not fail.</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code><MatchNotAll> |
| ... </MatchNotAll></code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> |
| <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authz_core</td></tr> |
| </table> |
| <p><code class="directive"><MatchNotAll></code> and |
| <code></MatchNotAll></code> are used to enclose a group of |
| authorization directives of which some must fail or none must succeed |
| in order for the |
| <code class="directive"><MatchNotAll></code> directive to |
| not fail.</p> |
| |
| <p>If none of the directives contained within the |
| <code class="directive"><MatchNotAll></code> directive |
| fail, and one or more succeed, then the |
| <code class="directive"><MatchNotAll></code> directive fails. |
| In all other cases, it returns a neutral result. Thus as with |
| the other negated authorization directives, it can never independently |
| authorize a request because it can never return a successful result. |
| It can be used, however, to restrict the set of users who are |
| authorized to access a resource.</p> |
| |
| <h3>See also</h3> |
| <ul> |
| <li><a href="#logic">Authorization Containers</a></li> |
| <li><a href="../howto/auth.html">Authentication, Authorization, |
| and Access Control</a></li> |
| </ul> |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="MatchNotAny" id="MatchNotAny"><MatchNotAny></a> <a name="matchnotany" id="matchnotany">Directive</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enclose a group of authorization directives of which none |
| none must succeed for the enclosing directive to not fail.</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code><MatchNotAny> |
| ... </MatchNotAny></code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> |
| <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authz_core</td></tr> |
| </table> |
| <p><code class="directive"><MatchNotAny></code> and |
| <code></MatchNotAny></code> are used to enclose a group of |
| authorization directives of which none must succeed |
| in order for the |
| <code class="directive"><MatchNotAny></code> directive to |
| not fail.</p> |
| |
| <p>If one or more of the directives contained within the |
| <code class="directive"><MatchNotAny></code> directive succeed, |
| then the <code class="directive"><MatchNotAny></code> directive |
| fails. In all other cases, it returns a neutral result. Thus as with |
| the other negated authorization directives, it can never independently |
| authorize a request because it can never return a successful result. |
| It can be used, however, to restrict the set of users who are |
| authorized to access a resource.</p> |
| |
| <div class="note">Because negated authorization directives are unable to |
| return a successful result, they can not significantly influence |
| the result of a <code class="directive"><MatchNotAny></code> |
| directive. Therefore negated authorization directives |
| are not permitted within a |
| <code class="directive"><MatchNotAny></code> directive.</div> |
| |
| <h3>See also</h3> |
| <ul> |
| <li><a href="#logic">Authorization Containers</a></li> |
| <li><a href="../howto/auth.html">Authentication, Authorization, |
| and Access Control</a></li> |
| </ul> |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="MergeAuthz" id="MergeAuthz">MergeAuthz</a> <a name="mergeauthz" id="mergeauthz">Directive</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Controls the manner in which each configuration section's |
| authorization logic is combined with that of preceding configuration |
| sections.</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>MergeAuthz Off | MatchAll | MatchAny</code></td></tr> |
| <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>MergeAuthz Off</code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> |
| <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authz_core</td></tr> |
| </table> |
| <p>When authorization is enabled, it is normally inherited by each |
| subsequent <a href="../sections.html#mergin">configuration section</a>, |
| unless a different set of authorization directives are specified. |
| This is the default action, which corresponds to an explicit setting |
| of <code>MergeAuthz Off</code>.</p> |
| |
| <p>However, there may be circumstances in which is it desirable |
| for a configuration section's authorization to be combined with |
| that of its predecessor while configuration sections are being |
| merged. Two options are available for this case, <code>MatchAll</code> |
| and <code>MatchAny</code>.</p> |
| |
| <p>When a configuration section contains <code>AuthzMerge MatchAll</code> |
| or <code>AuthzMerge MatchAny</code>, |
| its authorization logic is combined with that of the nearest |
| predecessor (according to the overall order of configuration sections) |
| which also contains authorization logic as if the two sections |
| were jointly contained within a |
| <code class="directive"><a href="#matchall"><MatchAll></a></code> or |
| <code class="directive"><a href="#matchany"><MatchAny></a></code> |
| directive, respectively.</p> |
| |
| <div class="note">The setting of <code class="directive">AuthzMerge</code> is not |
| inherited outside of the configuration section in which it appears. |
| In the following example, only users belonging to group <code>alpha</code> |
| may access <code>/www/docs</code>. Users belonging to either |
| groups <code>alpha</code> or <code>beta</code> may access |
| <code>/www/docs/ab</code>. However, the default <code>Off</code> |
| setting of <code class="directive">AuthzMerge</code> applies to the |
| <code class="directive"><a href="../mod/core.html#directory"><Directory></a></code> |
| configuration section for <code>/www/docs/ab/gamma</code>, so |
| that section's authorization directives override those of the |
| preceding sections. Thus only users belong to the group |
| <code>gamma</code> may access <code>/www/docs/ab/gamma</code>.</div> |
| |
| <div class="example"><p><code> |
| <Directory /www/docs> |
| <span class="indent"> |
| AuthType Basic<br /> |
| AuthName Documents<br /> |
| AuthBasicProvider file<br /> |
| AuthUserFile /usr/local/apache/passwd/passwords<br /> |
| Match group alpha |
| </span> |
| </Directory><br /> |
| <br /> |
| <Directory /www/docs/ab> |
| <span class="indent"> |
| AuthzMerge MatchAny<br /> |
| Match group beta |
| </span> |
| </Directory><br /> |
| <br /> |
| <Directory /www/docs/ab/gamma> |
| <span class="indent"> |
| Match group gamma |
| </span> |
| </Directory> |
| </code></p></div> |
| |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="Require" id="Require">Require</a> <a name="require" id="require">Directive</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Tests whether an authenticated user is authorized by |
| an authorization provider.</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Require <var>entity-name</var> [<var>entity-name</var>] ...</code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> |
| <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authz_core</td></tr> |
| </table> |
| <p>This directive tests whether an authenticated user is authorized |
| according to a particular authorization provider and the specified |
| restrictions. Some of the allowed syntaxes provided by |
| <code class="module"><a href="../mod/mod_authz_user.html">mod_authz_user</a></code> and |
| <code class="module"><a href="../mod/mod_authz_groupfile.html">mod_authz_groupfile</a></code> are:</p> |
| |
| <dl> |
| <dt><code>Require user <var>userid</var> [<var>userid</var>] |
| ...</code></dt> |
| <dd>Only the named users can access the resource.</dd> |
| |
| <dt><code>Require group <var>group-name</var> [<var>group-name</var>] |
| ...</code></dt> |
| <dd>Only users in the named groups can access the resource.</dd> |
| |
| <dt><code>Require valid-user</code></dt> |
| <dd>All valid users can access the resource.</dd> |
| </dl> |
| |
| <p>Other authorization modules that implement require options |
| include <code class="module"><a href="../mod/mod_authnz_ldap.html">mod_authnz_ldap</a></code>, |
| <code class="module"><a href="../mod/mod_authz_dbm.html">mod_authz_dbm</a></code>, <code class="module"><a href="../mod/mod_authz_dbd.html">mod_authz_dbd</a></code>, |
| <code class="module"><a href="../mod/mod_authz_host.html">mod_authz_host</a></code>, and |
| <code class="module"><a href="../mod/mod_authz_owner.html">mod_authz_owner</a></code>.</p> |
| |
| <p>For a complete authentication and authorization configuration, |
| <code class="directive">Require</code> must be accompanied by |
| <code class="directive"><a href="../mod/mod_authn_core.html#authname">AuthName</a></code>, <code class="directive"><a href="../mod/mod_authn_core.html#authtype">AuthType</a></code> and |
| <code class="directive"><a href="../mod/mod_auth_basic.html#authbasicprovider">AuthBasicProvider</a></code> or |
| <code class="directive"><a href="../mod/mod_auth_digest.html#authdigestprovider">AuthDigestProvider</a></code> |
| directives, and directives such as |
| <code class="directive"><a href="../mod/mod_authn_file.html#authuserfile">AuthUserFile</a></code> |
| and <code class="directive"><a href="../mod/mod_authz_groupfile.html#authgroupfile">AuthGroupFile</a></code> (to |
| define users and groups) in order to work correctly. Example:</p> |
| |
| <div class="example"><p><code> |
| AuthType Basic<br /> |
| AuthName "Restricted Resource"<br /> |
| AuthBasicProvider file<br /> |
| AuthUserFile /web/users<br /> |
| AuthGroupFile /web/groups<br /> |
| Require group admin |
| </code></p></div> |
| |
| <p>Access controls which are applied in this way are effective for |
| <strong>all</strong> methods. <strong>This is what is normally |
| desired.</strong> If you wish to apply access controls only to |
| specific methods, while leaving other methods unprotected, then |
| place the <code class="directive">Require</code> statement into a |
| <code class="directive"><a href="../mod/core.html#limit"><Limit></a></code> |
| section.</p> |
| |
| <p>When multiple <code class="directive">Require</code> directives are |
| used in a single |
| <a href="../sections.html#mergin">configuration section</a>, |
| the first one to authorize a user authorizes the entire request, |
| and subsequent <code class="directive">Require</code> directives are |
| ignored. In other words, all <code class="directive">Require</code> directives |
| are enclosed in an implied <code class="directive"><a href="#matchany"><MatchAny></a></code> directive.</p> |
| |
| <div class="note"><code class="directive">Require</code> directives may not be combined |
| with the <code class="directive"><a href="#match">Match</a></code> directive |
| or any authorization container directives, such as |
| <code class="directive"><a href="#matchall"><MatchAll></a></code>.</div> |
| |
| <h3>See also</h3> |
| <ul> |
| <li><a href="../howto/auth.html">Authentication, Authorization, |
| and Access Control</a></li> |
| <li><code class="module"><a href="../mod/mod_authn_core.html">mod_authn_core</a></code></li> |
| <li><code class="module"><a href="../mod/mod_authz_host.html">mod_authz_host</a></code></li> |
| </ul> |
| </div> |
| </div> |
| <div class="bottomlang"> |
| <p><span>Available Languages: </span><a href="../en/mod/mod_authz_core.html" title="English"> en </a></p> |
| </div><div id="footer"> |
| <p class="apache">Copyright 2008 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p> |
| <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div> |
| </body></html> |
