Documentation for mod_access_compat (Allow,Deny,Order,Satisfy directives)

<?xml version="1.0"?>

<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">

<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>

<!-- $LastChangedRevision: 327999 $ -->

<!--

 Copyright 2002-2005 The Apache Software Foundation or its licensors, as

 applicable.

 Licensed under the Apache License, Version 2.0 (the "License");

 you may not use this file except in compliance with the License.

 You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software

 distributed under the License is distributed on an "AS IS" BASIS,

 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 See the License for the specific language governing permissions and

 limitations under the License.

-->

<modulesynopsis metafile="mod_access_compat.xml.meta">

<name>mod_access_compat</name> 

<description>Group authorizations based on host (name or IP

address)</description>

<status>Extension</status>

<sourcefile>mod_access_compat.c</sourcefile>

<identifier>access_compat_module</identifier>

<compatibility>Available in Apache 2.3 as a compatibility module with 

previous versions of Apache 2.x.  The directives provided by this module

have been deprecated by the new authz refactoring.  Please see 

<module>mod_authz_host</module></compatibility>

<summary>

    <p>The directives provided by <module>mod_access_compat</module> are

    used in <directive module="core" type="section">Directory</directive>,

    <directive module="core" type="section">Files</directive>, and

    <directive module="core" type="section">Location</directive> sections

    as well as <code><a href="core.html#accessfilename">.htaccess</a>

    </code> files to control access to particular parts of the server.

    Access can be controlled based on the client hostname, IP address, or

    other characteristics of the client request, as captured in <a

    href="../env.html">environment variables</a>. The <directive

    module="mod_access_compat">Allow</directive> and <directive

    module="mod_access_compat">Deny</directive> directives are used to

    specify which clients are or are not allowed access to the server,

    while the <directive module="mod_access_compat">Order</directive>

    directive sets the default access state, and configures how the

    <directive module="mod_access_compat">Allow</directive> and <directive

    module="mod_access_compat">Deny</directive> directives interact with each

    other.</p>

    <p>Both host-based access restrictions and password-based

    authentication may be implemented simultaneously. In that case,

    the <directive module="core">Satisfy</directive> directive is used

    to determine how the two sets of restrictions interact.</p>

    <note type="warning"><title>Note</title>

      <p>The directives provided by <module>mod_access_compat</module> have

      been deprecated by the new authz refactoring. Please see 

      <module>mod_authz_host</module>.  The module 

      <module>mod_authz_default</module> must also be loaded to provide for

      default authorization handling.</p>

    </note>

    <p>In general, access restriction directives apply to all

    access methods (<code>GET</code>, <code>PUT</code>,

    <code>POST</code>, etc). This is the desired behavior in most

    cases. However, it is possible to restrict some methods, while

    leaving other methods unrestricted, by enclosing the directives

    in a <directive module="core" type="section">Limit</directive> section.</p>

</summary>

<seealso><directive module="mod_authz_core">Require</directive></seealso>

<seealso><module>mod_authz_host</module></seealso>

<seealso><module>mod_authz_core</module></seealso>

<directivesynopsis>

<name>Allow</name>

<description>Controls which hosts can access an area of the

server</description>

<syntax> Allow from all|<var>host</var>|env=<var>env-variable</var>

[<var>host</var>|env=<var>env-variable</var>] ...</syntax>

<contextlist><context>directory</context><context>.htaccess</context>

</contextlist>

<override>Limit</override>

<usage>

    <p>The <directive>Allow</directive> directive affects which hosts can

    access an area of the server. Access can be controlled by

    hostname, IP Address, IP Address range, or by other

    characteristics of the client request captured in environment

    variables.</p>

    <p>The first argument to this directive is always

    <code>from</code>. The subsequent arguments can take three

    different forms. If <code>Allow from all</code> is specified, then

    all hosts are allowed access, subject to the configuration of the

    <directive module="mod_access_compat">Deny</directive> and <directive

    module="mod_access_compat">Order</directive> directives as discussed

    below. To allow only particular hosts or groups of hosts to access

    the server, the <em>host</em> can be specified in any of the

    following formats:</p>

    <dl>

      <dt>A (partial) domain-name</dt>

      <dd>

      <example><title>Example:</title>

        Allow from apache.org<br />

        Allow from .net example.edu

      </example>

      <p>Hosts whose names match, or end in, this string are allowed

      access. Only complete components are matched, so the above

      example will match <code>foo.apache.org</code> but it will not

      match <code>fooapache.org</code>. This configuration will cause

      Apache to perform a double reverse DNS lookup on the client IP

      address, regardless of the setting of the <directive

      module="core">HostnameLookups</directive> directive.  It will do

      a reverse DNS lookup on the IP address to find the associated

      hostname, and then do a forward lookup on the hostname to assure

      that it matches the original IP address.  Only if the forward

      and reverse DNS are consistent and the hostname matches will

      access be allowed.</p></dd>

      <dt>A full IP address</dt>

      <dd>

      <example><title>Example:</title>

        Allow from 10.1.2.3<br />

        Allow from 192.168.1.104 192.168.1.205

      </example>

      <p>An IP address of a host allowed access</p></dd>

      <dt>A partial IP address</dt>

      <dd>

      <example><title>Example:</title>

        Allow from 10.1<br />

        Allow from 10 172.20 192.168.2

      </example>

      <p>The first 1 to 3 bytes of an IP address, for subnet

      restriction.</p></dd>

      <dt>A network/netmask pair</dt>

      <dd>

      <example><title>Example:</title>

        Allow from 10.1.0.0/255.255.0.0

      </example>

      <p>A network a.b.c.d, and a netmask w.x.y.z. For more

      fine-grained subnet restriction.</p></dd>

      <dt>A network/nnn CIDR specification</dt>

      <dd>

      <example><title>Example:</title>

        Allow from 10.1.0.0/16

      </example>

      <p>Similar to the previous case, except the netmask consists of

      nnn high-order 1 bits.</p></dd>

    </dl>

    <p>Note that the last three examples above match exactly the

    same set of hosts.</p>

    <p>IPv6 addresses and IPv6 subnets can be specified as shown

    below:</p>

    <example>

       Allow from 2001:db8::a00:20ff:fea7:ccea<br />

       Allow from 2001:db8::a00:20ff:fea7:ccea/10

    </example>

    <p>The third format of the arguments to the

    <directive>Allow</directive> directive allows access to the server

    to be controlled based on the existence of an <a

    href="../env.html">environment variable</a>. When <code>Allow from

    env=<var>env-variable</var></code> is specified, then the request is

    allowed access if the environment variable <var>env-variable</var>

    exists. The server provides the ability to set environment

    variables in a flexible way based on characteristics of the client

    request using the directives provided by

    <module>mod_setenvif</module>. Therefore, this directive can be

    used to allow access based on such factors as the clients

    <code>User-Agent</code> (browser type), <code>Referer</code>, or

    other HTTP request header fields.</p>

    <example><title>Example:</title>

      SetEnvIf User-Agent ^KnockKnock/2\.0 let_me_in<br />

      &lt;Directory /docroot&gt;<br />

      <indent>

        Order Deny,Allow<br />

        Deny from all<br />

        Allow from env=let_me_in<br />

      </indent>

      </Directory>

    </example>

    <p>In this case, browsers with a user-agent string beginning

    with <code>KnockKnock/2.0</code> will be allowed access, and all

    others will be denied.</p>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>Deny</name>

<description>Controls which hosts are denied access to the

server</description>

<syntax> Deny from all|<var>host</var>|env=<var>env-variable</var>

[<var>host</var>|env=<var>env-variable</var>] ...</syntax>

<contextlist><context>directory</context><context>.htaccess</context>

</contextlist>

<override>Limit</override>

<usage>

    <p>This directive allows access to the server to be restricted

    based on hostname, IP address, or environment variables. The

    arguments for the <directive>Deny</directive> directive are

    identical to the arguments for the <directive

    module="mod_access_compat">Allow</directive> directive.</p>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>Order</name>

<description>Controls the default access state and the order in which

<directive>Allow</directive> and <directive>Deny</directive> are

evaluated.</description>

<syntax> Order <var>ordering</var></syntax>

<default>Order Deny,Allow</default>

<contextlist><context>directory</context><context>.htaccess</context>

</contextlist>

<override>Limit</override>

<usage>

    <p>The <directive>Order</directive> directive controls the default

    access state and the order in which <directive

    module="mod_access_compat">Allow</directive> and <directive

    module="mod_access_compat">Deny</directive> directives are evaluated.

    <var>Ordering</var> is one of</p>

    <dl>

      <dt><code>Deny,Allow</code></dt>

      <dd>The <directive module="mod_access_compat">Deny</directive> directives

      are evaluated before the <directive

      module="mod_access_compat">Allow</directive> directives. Access is

      allowed by default. Any client which does not match a

      <directive module="mod_access_compat">Deny</directive> directive or does

      match an <directive module="mod_access_compat">Allow</directive>

      directive will be allowed access to the server.</dd>

      <dt><code>Allow,Deny</code></dt>

      <dd>The <directive module="mod_access_compat">Allow</directive>

      directives are evaluated before the <directive

      module="mod_access_compat">Deny</directive> directives. Access is denied

      by default. Any client which does not match an <directive

      module="mod_access_compat">Allow</directive> directive or does match a

      <directive module="mod_access_compat">Deny</directive> directive will be

      denied access to the server.</dd>

      <dt><code>Mutual-failure</code></dt>

      <dd>Only those hosts which appear on the <directive

      module="mod_access_compat">Allow</directive> list and do not appear on

      the <directive module="mod_access_compat">Deny</directive> list are

      granted access. This ordering has the same effect as <code>Order

      Allow,Deny</code> and is deprecated in favor of that

      configuration.</dd>

    </dl>

    <p>Keywords may only be separated by a comma; <em>no whitespace</em> is

    allowed between them. Note that in all cases every <directive

    module="mod_access_compat">Allow</directive> and <directive

    module="mod_access_compat">Deny</directive> statement is evaluated.</p>

    <p>In the following example, all hosts in the apache.org domain

    are allowed access; all other hosts are denied access.</p>

    <example>

      Order Deny,Allow<br />

      Deny from all<br />

      Allow from apache.org

    </example>

    <p>In the next example, all hosts in the apache.org domain are

    allowed access, except for the hosts which are in the

    foo.apache.org subdomain, who are denied access. All hosts not

    in the apache.org domain are denied access because the default

    state is to deny access to the server.</p>

    <example>

      Order Allow,Deny<br />

      Allow from apache.org<br />

      Deny from foo.apache.org

    </example>

    <p>On the other hand, if the <directive>Order</directive> in the last

    example is changed to <code>Deny,Allow</code>, all hosts will

    be allowed access. This happens because, regardless of the

    actual ordering of the directives in the configuration file,

    the <code>Allow from apache.org</code> will be evaluated last

    and will override the <code>Deny from foo.apache.org</code>.

    All hosts not in the <code>apache.org</code> domain will also

    be allowed access because the default state will change to

    <em>allow</em>.</p>

    <p>The presence of an <directive>Order</directive> directive can affect

    access to a part of the server even in the absence of accompanying

    <directive module="mod_access_compat">Allow</directive> and <directive

    module="mod_access_compat">Deny</directive> directives because of its effect

    on the default access state. For example,</p>

    <example>

      &lt;Directory /www&gt;<br />

      <indent>

        Order Allow,Deny<br />

      </indent>

      </Directory>

    </example>

    <p>will deny all access to the <code>/www</code> directory

    because the default access state will be set to

    <em>deny</em>.</p>

    <p>The <directive>Order</directive> directive controls the order of access

    directive processing only within each phase of the server's

    configuration processing. This implies, for example, that an

    <directive module="mod_access_compat">Allow</directive> or <directive

    module="mod_access_compat">Deny</directive> directive occurring in a

    <directive module="core" type="section">Location</directive> section will

    always be evaluated after an <directive

    module="mod_access_compat">Allow</directive> or <directive

    module="mod_access_compat">Deny</directive> directive occurring in a

    <directive module="core" type="section">Directory</directive> section or

    <code>.htaccess</code> file, regardless of the setting of the

    <directive>Order</directive> directive. For details on the merging

    of configuration sections, see the documentation on <a

    href="../sections.html">How Directory, Location and Files sections

    work</a>.</p>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>Satisfy</name>

<description>Interaction between host-level access control and

user authentication</description>

<syntax>Satisfy Any|All</syntax>

<default>Satisfy All</default>

<contextlist><context>directory</context><context>.htaccess</context>

</contextlist>

<override>AuthConfig</override>

<compatibility>Influenced by <directive module="core" type="section"

>Limit</directive> and <directive module="core"

type="section">LimitExcept</directive> in version 2.0.51 and

later</compatibility>

<usage>

    <p>Access policy if both <directive

    module="mod_authz_host">Allow</directive> and <directive

    module="mod_authz_core">Require</directive> used. The parameter can be

    either <code>All</code> or <code>Any</code>. This directive is only

    useful if access to a particular area is being restricted by both

    username/password <em>and</em> client host address. In this case

    the default behavior (<code>All</code>) is to require that the client

    passes the address access restriction <em>and</em> enters a valid

    username and password. With the <code>Any</code> option the client will be

    granted access if they either pass the host restriction or enter a

    valid username and password. This can be used to password restrict

    an area, but to let clients from particular addresses in without

    prompting for a password.</p>

    <p>For example, if you wanted to let people on your network have

    unrestricted access to a portion of your website, but require that

    people outside of your network provide a password, you could use a

    configuration similar to the following:</p>

    <example>

      Require valid-user<br />

      Allow from 192.168.1<br />

      Satisfy Any

    </example>

    <p>Since version 2.0.51 <directive>Satisfy</directive> directives can

    be restricted to particular methods by <directive module="core"

    type="section">Limit</directive> and <directive module="core" type="section"

    >LimitExcept</directive> sections.</p>

</usage>

   <seealso><directive module="mod_access_compat">Allow</directive></seealso>

   <seealso><directive module="mod_authz_core">Require</directive></seealso>

</directivesynopsis>

</modulesynopsis>

<?xml version="1.0" encoding="UTF-8" ?>

<metafile>

  <basename>mod_access_compat</basename>

  <path>/mod/</path>

  <relpath>..</relpath>

  <variants>

    <variant>en</variant>

    <variant outdated="yes">ja</variant>

    <variant outdated="yes">ko</variant>

  </variants>

</metafile>