home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 November / CMCD1104.ISO / Software / Complet / Apache / apache_2.0.52-win32-x86-no_ssl.msi / Data.Cab / F277972_mod_access.html.en < prev    next >
Extensible Markup Language  |  2004-02-20  |  19KB  |  331 lines

  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
  4.         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  5.               This file is generated from xml source: DO NOT EDIT
  6.         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  7.       -->
  8. <title>mod_access - Apache HTTP Server</title>
  9. <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10. <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11. <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
  12. <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13. <body>
  14. <div id="page-header">
  15. <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>
  16. <p class="apache">Apache HTTP Server Version 2.0</p>
  17. <img alt="" src="../images/feather.gif" /></div>
  18. <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
  19. <div id="path">
  20. <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs-project/">Documentation</a> > <a href="../">Version 2.0</a> > <a href="./">Modules</a></div>
  21. <div id="page-content">
  22. <div id="preamble"><h1>Apache Module mod_access</h1>
  23. <div class="toplang">
  24. <p><span>Available Languages: </span><a href="../en/mod/mod_access.html" title="English"> en </a> |
  25. <a href="../ja/mod/mod_access.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a></p>
  26. </div>
  27. <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Provides access control based on client hostname, IP
  28. address, or other characteristics of the client request.</td></tr>
  29. <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
  30. <tr><th><a href="module-dict.html#ModuleIdentifier">ModuleáIdentifier:</a></th><td>access_module</td></tr>
  31. <tr><th><a href="module-dict.html#SourceFile">SourceáFile:</a></th><td>mod_access.c</td></tr>
  32. <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available only in versions prior to 2.1</td></tr></table>
  33. <h3>Summary</h3>
  34.  
  35.     <p>The directives provided by <code class="module"><a href="../mod/mod_access.html">mod_access</a></code> are used
  36.     in <code class="directive"><a href="../mod/core.html#directory"><Directory></a></code>,
  37.     <code class="directive"><a href="../mod/core.html#files"><Files></a></code>, and
  38.     <code class="directive"><a href="../mod/core.html#location"><Location></a></code> sections
  39.     as well as <code><a href="core.html#accessfilename">.htaccess</a></code>
  40.     files to control access to particular parts of the server. Access
  41.     can be controlled based on the client hostname, IP address, or
  42.     other characteristics of the client request, as captured in <a href="../env.html">environment variables</a>. The <code class="directive"><a href="#allow">Allow</a></code> and <code class="directive"><a href="#deny">Deny</a></code> directives are used to
  43.     specify which clients are or are not allowed access to the server,
  44.     while the <code class="directive"><a href="#order">Order</a></code>
  45.     directive sets the default access state, and configures how the
  46.     <code class="directive"><a href="#allow">Allow</a></code> and <code class="directive"><a href="#deny">Deny</a></code> directives interact with each
  47.     other.</p>
  48.  
  49.     <p>Both host-based access restrictions and password-based
  50.     authentication may be implemented simultaneously. In that case,
  51.     the <code class="directive"><a href="../mod/core.html#satisfy">Satisfy</a></code> directive is used
  52.     to determine how the two sets of restrictions interact.</p>
  53.  
  54.     <p>In general, access restriction directives apply to all
  55.     access methods (<code>GET</code>, <code>PUT</code>,
  56.     <code>POST</code>, etc). This is the desired behavior in most
  57.     cases. However, it is possible to restrict some methods, while
  58.     leaving other methods unrestricted, by enclosing the directives
  59.     in a <code class="directive"><a href="../mod/core.html#limit"><Limit></a></code> section.</p>
  60. </div>
  61. <div id="quickview"><h3 class="directives">Directives</h3>
  62. <ul id="toc">
  63. <li><img alt="" src="../images/down.gif" /> <a href="#allow">Allow</a></li>
  64. <li><img alt="" src="../images/down.gif" /> <a href="#deny">Deny</a></li>
  65. <li><img alt="" src="../images/down.gif" /> <a href="#order">Order</a></li>
  66. </ul>
  67. <h3>See also</h3>
  68. <ul class="seealso">
  69. <li><code class="directive"><a href="../mod/core.html#satisfy">Satisfy</a></code></li>
  70. <li><code class="directive"><a href="../mod/core.html#require">Require</a></code></li>
  71. </ul></div>
  72.  
  73. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  74. <div class="directive-section"><h2><a name="Allow" id="Allow">Allow</a> <a name="allow" id="allow">Directive</a></h2>
  75. <table class="directive">
  76. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Controls which hosts can access an area of the
  77. server</td></tr>
  78. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code> Allow from
  79.     all|<var>host</var>|env=<var>env-variable</var>
  80.     [<var>host</var>|env=<var>env-variable</var>] ...</code></td></tr>
  81. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
  82. <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Limit</td></tr>
  83. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
  84. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_access</td></tr>
  85. </table>
  86.  
  87.     <p>The <code class="directive">Allow</code> directive affects which hosts can
  88.     access an area of the server. Access can be controlled by
  89.     hostname, IP Address, IP Address range, or by other
  90.     characteristics of the client request captured in environment
  91.     variables.</p>
  92.  
  93.     <p>The first argument to this directive is always
  94.     <code>from</code>. The subsequent arguments can take three
  95.     different forms. If <code>Allow from all</code> is specified, then
  96.     all hosts are allowed access, subject to the configuration of the
  97.     <code class="directive"><a href="#deny">Deny</a></code> and <code class="directive"><a href="#order">Order</a></code> directives as discussed
  98.     below. To allow only particular hosts or groups of hosts to access
  99.     the server, the <var>host</var> can be specified in any of the
  100.     following formats:</p>
  101.  
  102.     <dl>
  103.       <dt>A (partial) domain-name</dt>
  104.  
  105.       <dd>
  106.       <div class="example"><h3>Example:</h3><p><code>
  107.         Allow from apache.org
  108.       </code></p></div>
  109.       <p>Hosts whose names match, or end in, this string are allowed
  110.       access. Only complete components are matched, so the above
  111.       example will match <code>foo.apache.org</code> but it will not
  112.       match <code>fooapache.org</code>. This configuration will cause
  113.       Apache to perform a double reverse DNS lookup on the client IP
  114.       address, regardless of the setting of the <code class="directive"><a href="../mod/core.html#hostnamelookups">HostnameLookups</a></code> directive.  It will do
  115.       a reverse DNS lookup on the IP address to find the associated
  116.       hostname, and then do a forward lookup on the hostname to assure
  117.       that it matches the original IP address.  Only if the forward
  118.       and reverse DNS are consistent and the hostname matches will
  119.       access be allowed.</p></dd>
  120.  
  121.       <dt>A full IP address</dt>
  122.  
  123.       <dd>
  124.       <div class="example"><h3>Example:</h3><p><code>
  125.         Allow from 10.1.2.3
  126.       </code></p></div>
  127.       <p>An IP address of a host allowed access</p></dd>
  128.  
  129.       <dt>A partial IP address</dt>
  130.  
  131.       <dd>
  132.       <div class="example"><h3>Example:</h3><p><code>
  133.         Allow from 10.1
  134.       </code></p></div>
  135.       <p>The first 1 to 3 bytes of an IP address, for subnet
  136.       restriction.</p></dd>
  137.  
  138.       <dt>A network/netmask pair</dt>
  139.  
  140.       <dd>
  141.       <div class="example"><h3>Example:</h3><p><code>
  142.         Allow from 10.1.0.0/255.255.0.0
  143.       </code></p></div>
  144.       <p>A network a.b.c.d, and a netmask w.x.y.z. For more
  145.       fine-grained subnet restriction.</p></dd>
  146.  
  147.       <dt>A network/nnn CIDR specification</dt>
  148.  
  149.       <dd>
  150.       <div class="example"><h3>Example:</h3><p><code>
  151.         Allow from 10.1.0.0/16
  152.       </code></p></div>
  153.       <p>Similar to the previous case, except the netmask consists of
  154.       nnn high-order 1 bits.</p></dd>
  155.     </dl>
  156.  
  157.     <p>Note that the last three examples above match exactly the
  158.     same set of hosts.</p>
  159.  
  160.     <p>IPv6 addresses and IPv6 subnets can be specified as shown
  161.     below:</p>
  162.  
  163.     <div class="example"><p><code>
  164.        Allow from fe80::a00:20ff:fea7:ccea<br />
  165.        Allow from fe80::a00:20ff:fea7:ccea/10
  166.     </code></p></div>
  167.  
  168.     <p>The third format of the arguments to the
  169.     <code class="directive">Allow</code> directive allows access to the server
  170.     to be controlled based on the existence of an <a href="../env.html">environment variable</a>. When <code>Allow from
  171.     env=<var>env-variable</var></code> is specified, then the request is
  172.     allowed access if the environment variable <var>env-variable</var>
  173.     exists. The server provides the ability to set environment
  174.     variables in a flexible way based on characteristics of the client
  175.     request using the directives provided by
  176.     <code class="module"><a href="../mod/mod_setenvif.html">mod_setenvif</a></code>.  Therefore, this directive can be
  177.     used to allow access based on such factors as the clients
  178.     <code>User-Agent</code> (browser type), <code>Referer</code>, or
  179.     other HTTP request header fields.</p>
  180.  
  181.     <div class="example"><h3>Example:</h3><p><code>
  182.       SetEnvIf User-Agent ^KnockKnock/2\.0 let_me_in<br />
  183.       <Directory /docroot><br />
  184.       <span class="indent">
  185.         Order Deny,Allow<br />
  186.         Deny from all<br />
  187.         Allow from env=let_me_in<br />
  188.       </span>
  189.       </Directory>
  190.     </code></p></div>
  191.  
  192.     <p>In this case, browsers with a user-agent string beginning
  193.     with <code>KnockKnock/2.0</code> will be allowed access, and all
  194.     others will be denied.</p>
  195.  
  196. </div>
  197. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  198. <div class="directive-section"><h2><a name="Deny" id="Deny">Deny</a> <a name="deny" id="deny">Directive</a></h2>
  199. <table class="directive">
  200. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Controls which hosts are denied access to the
  201. server</td></tr>
  202. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code> Deny from all|<var>host</var>|env=<var>env-variable</var>
  203. [<var>host</var>|env=<var>env-variable</var>] ...</code></td></tr>
  204. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
  205. <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Limit</td></tr>
  206. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
  207. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_access</td></tr>
  208. </table>
  209.     <p>This directive allows access to the server to be restricted
  210.     based on hostname, IP address, or environment variables. The
  211.     arguments for the <code class="directive">Deny</code> directive are
  212.     identical to the arguments for the <code class="directive"><a href="#allow">Allow</a></code> directive.</p>
  213.  
  214. </div>
  215. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  216. <div class="directive-section"><h2><a name="Order" id="Order">Order</a> <a name="order" id="order">Directive</a></h2>
  217. <table class="directive">
  218. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Controls the default access state and the order in which
  219. Allow and Deny are
  220. evaluated.</td></tr>
  221. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code> Order <var>ordering</var></code></td></tr>
  222. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Order Deny,Allow</code></td></tr>
  223. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
  224. <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Limit</td></tr>
  225. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
  226. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_access</td></tr>
  227. </table>
  228.  
  229.     <p>The <code class="directive">Order</code> directive controls the default
  230.     access state and the order in which <code class="directive"><a href="#allow">Allow</a></code> and <code class="directive"><a href="#deny">Deny</a></code> directives are evaluated.
  231.     <var>Ordering</var> is one of</p>
  232.  
  233.     <dl>
  234.       <dt><code>Deny,Allow</code></dt>
  235.  
  236.       <dd>The <code class="directive"><a href="#deny">Deny</a></code> directives
  237.       are evaluated before the <code class="directive"><a href="#allow">Allow</a></code> directives. Access is
  238.       allowed by default.  Any client which does not match a
  239.       <code class="directive"><a href="#deny">Deny</a></code> directive or does
  240.       match an <code class="directive"><a href="#allow">Allow</a></code>
  241.       directive will be allowed access to the server.</dd>
  242.  
  243.       <dt><code>Allow,Deny</code></dt>
  244.  
  245.       <dd>The <code class="directive"><a href="#allow">Allow</a></code>
  246.       directives are evaluated before the <code class="directive"><a href="#deny">Deny</a></code> directives. Access is denied
  247.       by default. Any client which does not match an <code class="directive"><a href="#allow">Allow</a></code> directive or does match a
  248.       <code class="directive"><a href="#deny">Deny</a></code> directive will be
  249.       denied access to the server.</dd>
  250.  
  251.       <dt><code>Mutual-failure</code></dt>
  252.  
  253.       <dd>Only those hosts which appear on the <code class="directive"><a href="#allow">Allow</a></code> list and do not appear on
  254.       the <code class="directive"><a href="#deny">Deny</a></code> list are
  255.       granted access. This ordering has the same effect as <code>Order
  256.       Allow,Deny</code> and is deprecated in favor of that
  257.       configuration.</dd>
  258.     </dl>
  259.  
  260.     <p>Keywords may only be separated by a comma; <em>no whitespace</em> is
  261.     allowed between them. Note that in all cases every <code class="directive"><a href="#allow">Allow</a></code> and <code class="directive"><a href="#deny">Deny</a></code> statement is evaluated.</p>
  262.  
  263.     <p>In the following example, all hosts in the apache.org domain
  264.     are allowed access; all other hosts are denied access.</p>
  265.  
  266.     <div class="example"><p><code>
  267.       Order Deny,Allow<br />
  268.       Deny from all<br />
  269.       Allow from apache.org
  270.     </code></p></div>
  271.  
  272.     <p>In the next example, all hosts in the apache.org domain are
  273.     allowed access, except for the hosts which are in the
  274.     foo.apache.org subdomain, who are denied access. All hosts not
  275.     in the apache.org domain are denied access because the default
  276.     state is to deny access to the server.</p>
  277.  
  278.     <div class="example"><p><code>
  279.       Order Allow,Deny<br />
  280.       Allow from apache.org<br />
  281.       Deny from foo.apache.org
  282.     </code></p></div>
  283.  
  284.     <p>On the other hand, if the <code class="directive">Order</code> in the last
  285.     example is changed to <code>Deny,Allow</code>, all hosts will
  286.     be allowed access. This happens because, regardless of the
  287.     actual ordering of the directives in the configuration file,
  288.     the <code>Allow from apache.org</code> will be evaluated last
  289.     and will override the <code>Deny from foo.apache.org</code>.
  290.     All hosts not in the <code>apache.org</code> domain will also
  291.     be allowed access because the default state will change to
  292.     <var>allow</var>.</p>
  293.  
  294.     <p>The presence of an <code class="directive">Order</code> directive can affect
  295.     access to a part of the server even in the absence of accompanying
  296.     <code class="directive"><a href="#allow">Allow</a></code> and <code class="directive"><a href="#deny">Deny</a></code> directives because of its effect
  297.     on the default access state.  For example,</p>
  298.  
  299.     <div class="example"><p><code>
  300.       <Directory /www><br />
  301.       <span class="indent">
  302.         Order Allow,Deny<br />
  303.       </span>
  304.       </Directory>
  305.     </code></p></div>
  306.  
  307.     <p>will deny all access to the <code>/www</code> directory
  308.     because the default access state will be set to
  309.     <var>deny</var>.</p>
  310.  
  311.     <p>The <code class="directive">Order</code> directive controls the order of access
  312.     directive processing only within each phase of the server's
  313.     configuration processing. This implies, for example, that an
  314.     <code class="directive"><a href="#allow">Allow</a></code> or <code class="directive"><a href="#deny">Deny</a></code> directive occurring in a
  315.     <code class="directive"><a href="../mod/core.html#location"><Location></a></code> section will
  316.     always be evaluated after an <code class="directive"><a href="#allow">Allow</a></code> or <code class="directive"><a href="#deny">Deny</a></code> directive occurring in a
  317.     <code class="directive"><a href="../mod/core.html#directory"><Directory></a></code> section or
  318.     <code>.htaccess</code> file, regardless of the setting of the
  319.     <code class="directive">Order</code> directive. For details on the merging
  320.     of configuration sections, see the documentation on <a href="../sections.html">How Directory, Location and Files sections
  321.     work</a>.</p>
  322.  
  323. </div>
  324. </div>
  325. <div class="bottomlang">
  326. <p><span>Available Languages: </span><a href="../en/mod/mod_access.html" title="English"> en </a> |
  327. <a href="../ja/mod/mod_access.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a></p>
  328. </div><div id="footer">
  329. <p class="apache">Copyright 1999-2004 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>
  330. <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>
  331. </body></html>