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
8 <title>mod_access_compat - 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" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
12 <script src="../style/scripts/prettify.js" type="text/javascript">
15 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
17 <div id="page-header">
18 <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>
19 <p class="apache">Apache HTTP Server Version 2.5</p>
20 <img alt="" src="../images/feather.gif" /></div>
21 <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
23 <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.5</a> > <a href="./">Modules</a></div>
24 <div id="page-content">
25 <div id="preamble"><h1>Apache Module mod_access_compat</h1>
27 <p><span>Available Languages: </span><a href="../en/mod/mod_access_compat.html" title="English"> en </a> |
28 <a href="../fr/mod/mod_access_compat.html" hreflang="fr" rel="alternate" title="Français"> fr </a> |
29 <a href="../ja/mod/mod_access_compat.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a></p>
31 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Group authorizations based on host (name or IP
33 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
34 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>access_compat_module</td></tr>
35 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_access_compat.c</td></tr>
36 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache HTTP Server 2.3 as a compatibility module with
37 previous versions of Apache httpd 2.x. The directives provided by this module
38 have been deprecated by the new authz refactoring. Please see
39 <code class="module"><a href="../mod/mod_authz_host.html">mod_authz_host</a></code></td></tr></table>
42 <p>The directives provided by <code class="module"><a href="../mod/mod_access_compat.html">mod_access_compat</a></code> are
43 used in <code class="directive"><a href="../mod/core.html#directory"><Directory></a></code>,
44 <code class="directive"><a href="../mod/core.html#files"><Files></a></code>, and
45 <code class="directive"><a href="../mod/core.html#location"><Location></a></code> sections
46 as well as <code><a href="core.html#accessfilename">.htaccess</a>
47 </code> files to control access to particular parts of the server.
48 Access can be controlled based on the client hostname, IP address, or
49 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
50 specify which clients are or are not allowed access to the server,
51 while the <code class="directive"><a href="#order">Order</a></code>
52 directive sets the default access state, and configures how the
53 <code class="directive"><a href="#allow">Allow</a></code> and <code class="directive"><a href="#deny">Deny</a></code> directives interact with each
56 <p>Both host-based access restrictions and password-based
57 authentication may be implemented simultaneously. In that case,
58 the <code class="directive"><a href="#satisfy">Satisfy</a></code> directive is used
59 to determine how the two sets of restrictions interact.</p>
61 <div class="warning"><h3>Note</h3>
62 <p>The directives provided by <code class="module"><a href="../mod/mod_access_compat.html">mod_access_compat</a></code> have
63 been deprecated by the new authz refactoring. Please see
64 <code class="module"><a href="../mod/mod_authz_host.html">mod_authz_host</a></code>.</p>
67 <p>In general, access restriction directives apply to all
68 access methods (<code>GET</code>, <code>PUT</code>,
69 <code>POST</code>, etc). This is the desired behavior in most
70 cases. However, it is possible to restrict some methods, while
71 leaving other methods unrestricted, by enclosing the directives
72 in a <code class="directive"><a href="../mod/core.html#limit"><Limit></a></code> section.</p>
74 <div class="note"> <h3>Merging of configuration sections</h3>
75 <p>When any directive provided by this module is used in a new
76 configuration section, no directives provided by this module are
77 inherited from previous configuration sections.</p>
81 <div id="quickview"><h3 class="directives">Directives</h3>
83 <li><img alt="" src="../images/down.gif" /> <a href="#allow">Allow</a></li>
84 <li><img alt="" src="../images/down.gif" /> <a href="#deny">Deny</a></li>
85 <li><img alt="" src="../images/down.gif" /> <a href="#order">Order</a></li>
86 <li><img alt="" src="../images/down.gif" /> <a href="#satisfy">Satisfy</a></li>
90 <li><code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code></li>
91 <li><code class="module"><a href="../mod/mod_authz_host.html">mod_authz_host</a></code></li>
92 <li><code class="module"><a href="../mod/mod_authz_core.html">mod_authz_core</a></code></li>
95 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
96 <div class="directive-section"><h2><a name="Allow" id="Allow">Allow</a> <a name="allow" id="allow">Directive</a></h2>
97 <table class="directive">
98 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Controls which hosts can access an area of the
100 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code> Allow from all|<var>host</var>|env=[!]<var>env-variable</var>
101 [<var>host</var>|env=[!]<var>env-variable</var>] ...</code></td></tr>
102 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
103 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Limit</td></tr>
104 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
105 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_access_compat</td></tr>
107 <p>The <code class="directive">Allow</code> directive affects which hosts can
108 access an area of the server. Access can be controlled by
109 hostname, IP address, IP address range, or by other
110 characteristics of the client request captured in environment
113 <p>The first argument to this directive is always
114 <code>from</code>. The subsequent arguments can take three
115 different forms. If <code>Allow from all</code> is specified, then
116 all hosts are allowed access, subject to the configuration of the
117 <code class="directive"><a href="#deny">Deny</a></code> and <code class="directive"><a href="#order">Order</a></code> directives as discussed
118 below. To allow only particular hosts or groups of hosts to access
119 the server, the <em>host</em> can be specified in any of the
120 following formats:</p>
123 <dt>A (partial) domain-name</dt>
126 <pre class="prettyprint lang-config">
127 Allow from example.org
128 Allow from .net example.edu
131 <p>Hosts whose names match, or end in, this string are allowed
132 access. Only complete components are matched, so the above
133 example will match <code>foo.example.org</code> but it will not
134 match <code>fooexample.org</code>. This configuration will cause
135 Apache httpd to perform a double DNS lookup on the client IP
136 address, regardless of the setting of the <code class="directive"><a href="../mod/core.html#hostnamelookups">HostnameLookups</a></code> directive. It will do
137 a reverse DNS lookup on the IP address to find the associated
138 hostname, and then do a forward lookup on the hostname to assure
139 that it matches the original IP address. Only if the forward
140 and reverse DNS are consistent and the hostname matches will
141 access be allowed.</p></dd>
143 <dt>A full IP address</dt>
146 <pre class="prettyprint lang-config">
148 Allow from 192.168.1.104 192.168.1.205
151 <p>An IP address of a host allowed access</p></dd>
153 <dt>A partial IP address</dt>
156 <pre class="prettyprint lang-config">
158 Allow from 10 172.20 192.168.2
161 <p>The first 1 to 3 bytes of an IP address, for subnet
162 restriction.</p></dd>
164 <dt>A network/netmask pair</dt>
167 <pre class="prettyprint lang-config">
168 Allow from 10.1.0.0/255.255.0.0
171 <p>A network a.b.c.d, and a netmask w.x.y.z. For more
172 fine-grained subnet restriction.</p></dd>
174 <dt>A network/nnn CIDR specification</dt>
177 <pre class="prettyprint lang-config">
178 Allow from 10.1.0.0/16
181 <p>Similar to the previous case, except the netmask consists of
182 nnn high-order 1 bits.</p></dd>
185 <p>Note that the last three examples above match exactly the
186 same set of hosts.</p>
188 <p>IPv6 addresses and IPv6 subnets can be specified as shown
191 <pre class="prettyprint lang-config">
192 Allow from 2001:db8::a00:20ff:fea7:ccea
193 Allow from 2001:db8::a00:20ff:fea7:ccea/10
197 <p>The third format of the arguments to the
198 <code class="directive">Allow</code> directive allows access to the server
199 to be controlled based on the existence of an <a href="../env.html">environment variable</a>. When <code>Allow from
200 env=<var>env-variable</var></code> is specified, then the request is
201 allowed access if the environment variable <var>env-variable</var>
202 exists. When <code>Allow from env=!<var>env-variable</var></code> is
203 specified, then the request is allowed access if the environment
204 variable <var>env-variable</var> doesn't exist.
205 The server provides the ability to set environment
206 variables in a flexible way based on characteristics of the client
207 request using the directives provided by
208 <code class="module"><a href="../mod/mod_setenvif.html">mod_setenvif</a></code>. Therefore, this directive can be
209 used to allow access based on such factors as the clients
210 <code>User-Agent</code> (browser type), <code>Referer</code>, or
211 other HTTP request header fields.</p>
213 <pre class="prettyprint lang-config">
214 SetEnvIf User-Agent ^KnockKnock/2\.0 let_me_in
215 <Directory /docroot>
218 Allow from env=let_me_in
223 <p>In this case, browsers with a user-agent string beginning
224 with <code>KnockKnock/2.0</code> will be allowed access, and all
225 others will be denied.</p>
227 <div class="note"> <h3>Merging of configuration sections</h3>
228 <p>When any directive provided by this module is used in a new
229 configuration section, no directives provided by this module are
230 inherited from previous configuration sections.</p>
235 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
236 <div class="directive-section"><h2><a name="Deny" id="Deny">Deny</a> <a name="deny" id="deny">Directive</a></h2>
237 <table class="directive">
238 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Controls which hosts are denied access to the
240 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code> Deny from all|<var>host</var>|env=[!]<var>env-variable</var>
241 [<var>host</var>|env=[!]<var>env-variable</var>] ...</code></td></tr>
242 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
243 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Limit</td></tr>
244 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
245 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_access_compat</td></tr>
247 <p>This directive allows access to the server to be restricted
248 based on hostname, IP address, or environment variables. The
249 arguments for the <code class="directive">Deny</code> directive are
250 identical to the arguments for the <code class="directive"><a href="#allow">Allow</a></code> directive.</p>
253 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
254 <div class="directive-section"><h2><a name="Order" id="Order">Order</a> <a name="order" id="order">Directive</a></h2>
255 <table class="directive">
256 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Controls the default access state and the order in which
257 <code class="directive">Allow</code> and <code class="directive">Deny</code> are
259 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code> Order <var>ordering</var></code></td></tr>
260 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Order Deny,Allow</code></td></tr>
261 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
262 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Limit</td></tr>
263 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
264 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_access_compat</td></tr>
267 <p>The <code class="directive">Order</code> directive, along with the
268 <code class="directive"><a href="#allow">Allow</a></code> and
269 <code class="directive"><a href="#deny">Deny</a></code> directives,
270 controls a three-pass access control system. The first pass
271 processes either all <code class="directive"><a href="#allow">Allow</a></code> or all <code class="directive"><a href="#deny">Deny</a></code> directives, as specified
272 by the <code class="directive"><a href="#order">Order</a></code>
273 directive. The second pass parses the rest of the directives
274 (<code class="directive"><a href="#deny">Deny</a></code> or
275 <code class="directive"><a href="#allow">Allow</a></code>). The third
276 pass applies to all requests which do not match either of the first
279 <p>Note that all <code class="directive"><a href="#allow">Allow</a></code> and <code class="directive"><a href="#deny">Deny</a></code> directives are
280 processed, unlike a typical firewall, where only the first match is
281 used. The last match is effective (also unlike a typical firewall).
282 Additionally, the order in which lines appear in the configuration
283 files is not significant -- all <code class="directive"><a href="#allow">Allow</a></code> lines are processed as
284 one group, all <code class="directive"><a href="#deny">Deny</a></code> lines are considered as
285 another, and the default state is considered by itself.</p>
287 <p><em>Ordering</em> is one of:</p>
290 <dt><code>Allow,Deny</code></dt>
292 <dd>First, all <code class="directive"><a href="#allow">Allow</a></code> directives are
293 evaluated; at least one must match, or the request is rejected.
294 Next, all <code class="directive"><a href="#deny">Deny</a></code>
295 directives are evaluated. If any matches, the request is rejected.
296 Last, any requests which do not match an <code class="directive"><a href="#allow">Allow</a></code> or a <code class="directive"><a href="#deny">Deny</a></code> directive are denied
299 <dt><code>Deny,Allow</code></dt>
301 <dd>First, all <code class="directive"><a href="#deny">Deny</a></code> directives are
302 evaluated; if any match, the request is denied
303 <strong>unless</strong> it also matches an <code class="directive"><a href="#allow">Allow</a></code> directive. Any
304 requests which do not match any <code class="directive"><a href="#allow">Allow</a></code> or <code class="directive"><a href="#deny">Deny</a></code> directives are
307 <dt><code>Mutual-failure</code></dt>
309 <dd>This order has the same effect as <code>Order
310 Allow,Deny</code> and is deprecated in its favor.</dd>
313 <p>Keywords may only be separated by a comma; <em>no whitespace</em>
314 is allowed between them.</p>
316 <table class="bordered">
319 <th>Allow,Deny result</th>
320 <th>Deny,Allow result</th>
322 <th>Match Allow only</th>
323 <td>Request allowed</td>
324 <td>Request allowed</td>
326 <th>Match Deny only</th>
327 <td>Request denied</td>
328 <td>Request denied</td>
331 <td>Default to second directive: Denied</td>
332 <td>Default to second directive: Allowed</td>
334 <th>Match both Allow & Deny</th>
335 <td>Final match controls: Denied</td>
336 <td>Final match controls: Allowed</td>
340 <p>In the following example, all hosts in the example.org domain
341 are allowed access; all other hosts are denied access.</p>
343 <pre class="prettyprint lang-config">
346 Allow from example.org
350 <p>In the next example, all hosts in the example.org domain are
351 allowed access, except for the hosts which are in the
352 foo.example.org subdomain, who are denied access. All hosts not
353 in the example.org domain are denied access because the default
354 state is to <code class="directive"><a href="#deny">Deny</a></code>
355 access to the server.</p>
357 <pre class="prettyprint lang-config">
359 Allow from example.org
360 Deny from foo.example.org
364 <p>On the other hand, if the <code class="directive">Order</code> in the
365 last example is changed to <code>Deny,Allow</code>, all hosts will
366 be allowed access. This happens because, regardless of the actual
367 ordering of the directives in the configuration file, the
368 <code>Allow from example.org</code> will be evaluated last and will
369 override the <code>Deny from foo.example.org</code>. All hosts not in
370 the <code>example.org</code> domain will also be allowed access
371 because the default state is <code class="directive"><a href="#allow">Allow</a></code>.</p>
373 <p>The presence of an <code class="directive">Order</code> directive can
374 affect access to a part of the server even in the absence of
375 accompanying <code class="directive"><a href="#allow">Allow</a></code>
376 and <code class="directive"><a href="#deny">Deny</a></code>
377 directives because of its effect on the default access state. For
380 <pre class="prettyprint lang-config">
381 <Directory /www>
387 <p>will Deny all access to the <code>/www</code> directory
388 because the default access state is set to
389 <code class="directive"><a href="#deny">Deny</a></code>.</p>
391 <p>The <code class="directive">Order</code> directive controls the order of access
392 directive processing only within each phase of the server's
393 configuration processing. This implies, for example, that an
394 <code class="directive"><a href="#allow">Allow</a></code> or <code class="directive"><a href="#deny">Deny</a></code> directive occurring in a
395 <code class="directive"><a href="../mod/core.html#location"><Location></a></code> section will
396 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
397 <code class="directive"><a href="../mod/core.html#directory"><Directory></a></code> section or
398 <code>.htaccess</code> file, regardless of the setting of the
399 <code class="directive">Order</code> directive. For details on the merging
400 of configuration sections, see the documentation on <a href="../sections.html">How Directory, Location and Files sections
403 <div class="note"> <h3>Merging of configuration sections</h3>
404 <p>When any directive provided by this module is used in a new
405 configuration section, no directives provided by this module are
406 inherited from previous configuration sections.</p>
411 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
412 <div class="directive-section"><h2><a name="Satisfy" id="Satisfy">Satisfy</a> <a name="satisfy" id="satisfy">Directive</a></h2>
413 <table class="directive">
414 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Interaction between host-level access control and
415 user authentication</td></tr>
416 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Satisfy Any|All</code></td></tr>
417 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Satisfy All</code></td></tr>
418 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
419 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
420 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
421 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_access_compat</td></tr>
422 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Influenced by <code class="directive"><a href="../mod/core.html#limit"><Limit></a></code> and <code class="directive"><a href="../mod/core.html#limitexcept"><LimitExcept></a></code> in version 2.0.51 and
425 <p>Access policy if both <code class="directive"><a href="#allow">Allow</a></code> and <code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code> used. The parameter can be
426 either <code>All</code> or <code>Any</code>. This directive is only
427 useful if access to a particular area is being restricted by both
428 username/password <em>and</em> client host address. In this case
429 the default behavior (<code>All</code>) is to require that the client
430 passes the address access restriction <em>and</em> enters a valid
431 username and password. With the <code>Any</code> option the client will be
432 granted access if they either pass the host restriction or enter a
433 valid username and password. This can be used to password restrict
434 an area, but to let clients from particular addresses in without
435 prompting for a password.</p>
437 <p>For example, if you wanted to let people on your network have
438 unrestricted access to a portion of your website, but require that
439 people outside of your network provide a password, you could use a
440 configuration similar to the following:</p>
442 <pre class="prettyprint lang-config">
450 Another frequent use of the <code class="directive">Satisfy</code> directive
451 is to relax access restrictions for a subdirectory:
454 <pre class="prettyprint lang-config">
455 <Directory /var/www/private>
459 <Directory /var/www/private/public>
466 <p>In the above example, authentication will be required for the
467 <code>/var/www/private</code> directory, but will not be required
468 for the <code>/var/www/private/public</code> directory.</p>
470 <p>Since version 2.0.51 <code class="directive">Satisfy</code> directives can
471 be restricted to particular methods by <code class="directive"><a href="../mod/core.html#limit"><Limit></a></code> and <code class="directive"><a href="../mod/core.html#limitexcept"><LimitExcept></a></code> sections.</p>
473 <div class="note"> <h3>Merging of configuration sections</h3>
474 <p>When any directive provided by this module is used in a new
475 configuration section, no directives provided by this module are
476 inherited from previous configuration sections.</p>
482 <li><code class="directive"><a href="#allow">Allow</a></code></li>
483 <li><code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code></li>
487 <div class="bottomlang">
488 <p><span>Available Languages: </span><a href="../en/mod/mod_access_compat.html" title="English"> en </a> |
489 <a href="../fr/mod/mod_access_compat.html" hreflang="fr" rel="alternate" title="Français"> fr </a> |
490 <a href="../ja/mod/mod_access_compat.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a></p>
491 </div><div id="footer">
492 <p class="apache">Copyright 2012 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>
493 <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><script type="text/javascript"><!--//--><![CDATA[//><!--
494 if (typeof(prettyPrint) !== undefined) {