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" />
12 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
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.3</p>
17 <img alt="" src="../images/feather.gif" /></div>
18 <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
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/">Documentation</a> > <a href="../">Version 2.3</a> > <a href="./">Modules</a></div>
21 <div id="page-content">
22 <div id="preamble"><h1>Apache Module mod_access_compat</h1>
24 <p><span>Available Languages: </span><a href="../en/mod/mod_access_compat.html" title="English"> en </a> |
25 <a href="../ja/mod/mod_access_compat.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a></p>
27 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Group authorizations based on host (name or IP
29 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
30 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>access_compat_module</td></tr>
31 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_access_compat.c</td></tr>
32 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.3 as a compatibility module with
33 previous versions of Apache 2.x. The directives provided by this module
34 have been deprecated by the new authz refactoring. Please see
35 <code class="module"><a href="../mod/mod_authz_host.html">mod_authz_host</a></code></td></tr></table>
38 <p>The directives provided by <code class="module"><a href="../mod/mod_access_compat.html">mod_access_compat</a></code> are
39 used in <code class="directive"><a href="../mod/core.html#directory"><Directory></a></code>,
40 <code class="directive"><a href="../mod/core.html#files"><Files></a></code>, and
41 <code class="directive"><a href="../mod/core.html#location"><Location></a></code> sections
42 as well as <code><a href="core.html#accessfilename">.htaccess</a>
43 </code> files to control access to particular parts of the server.
44 Access can be controlled based on the client hostname, IP address, or
45 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
46 specify which clients are or are not allowed access to the server,
47 while the <code class="directive"><a href="#order">Order</a></code>
48 directive sets the default access state, and configures how the
49 <code class="directive"><a href="#allow">Allow</a></code> and <code class="directive"><a href="#deny">Deny</a></code> directives interact with each
52 <p>Both host-based access restrictions and password-based
53 authentication may be implemented simultaneously. In that case,
54 the <code class="directive"><a href="#satisfy">Satisfy</a></code> directive is used
55 to determine how the two sets of restrictions interact.</p>
57 <div class="warning"><h3>Note</h3>
58 <p>The directives provided by <code class="module"><a href="../mod/mod_access_compat.html">mod_access_compat</a></code> have
59 been deprecated by the new authz refactoring. Please see
60 <code class="module"><a href="../mod/mod_authz_host.html">mod_authz_host</a></code>. The module
61 <code class="module"><a href="../mod/mod_authz_default.html">mod_authz_default</a></code> must also be loaded to provide for
62 default authorization handling.</p>
65 <p>In general, access restriction directives apply to all
66 access methods (<code>GET</code>, <code>PUT</code>,
67 <code>POST</code>, etc). This is the desired behavior in most
68 cases. However, it is possible to restrict some methods, while
69 leaving other methods unrestricted, by enclosing the directives
70 in a <code class="directive"><a href="../mod/core.html#limit"><Limit></a></code> section.</p>
72 <div id="quickview"><h3 class="directives">Directives</h3>
74 <li><img alt="" src="../images/down.gif" /> <a href="#allow">Allow</a></li>
75 <li><img alt="" src="../images/down.gif" /> <a href="#deny">Deny</a></li>
76 <li><img alt="" src="../images/down.gif" /> <a href="#order">Order</a></li>
77 <li><img alt="" src="../images/down.gif" /> <a href="#satisfy">Satisfy</a></li>
81 <li><code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code></li>
82 <li><code class="module"><a href="../mod/mod_authz_host.html">mod_authz_host</a></code></li>
83 <li><code class="module"><a href="../mod/mod_authz_core.html">mod_authz_core</a></code></li>
86 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
87 <div class="directive-section"><h2><a name="Allow" id="Allow">Allow</a> <a name="allow" id="allow">Directive</a></h2>
88 <table class="directive">
89 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Controls which hosts can access an area of the
91 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code> Allow from all|<var>host</var>|env=<var>env-variable</var>
92 [<var>host</var>|env=<var>env-variable</var>] ...</code></td></tr>
93 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
94 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Limit</td></tr>
95 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
96 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_access_compat</td></tr>
98 <p>The <code class="directive">Allow</code> directive affects which hosts can
99 access an area of the server. Access can be controlled by
100 hostname, IP address, IP address range, or by other
101 characteristics of the client request captured in environment
104 <p>The first argument to this directive is always
105 <code>from</code>. The subsequent arguments can take three
106 different forms. If <code>Allow from all</code> is specified, then
107 all hosts are allowed access, subject to the configuration of the
108 <code class="directive"><a href="#deny">Deny</a></code> and <code class="directive"><a href="#order">Order</a></code> directives as discussed
109 below. To allow only particular hosts or groups of hosts to access
110 the server, the <em>host</em> can be specified in any of the
111 following formats:</p>
114 <dt>A (partial) domain-name</dt>
117 <div class="example"><h3>Example:</h3><p><code>
118 Allow from apache.org<br />
119 Allow from .net example.edu
121 <p>Hosts whose names match, or end in, this string are allowed
122 access. Only complete components are matched, so the above
123 example will match <code>foo.apache.org</code> but it will not
124 match <code>fooapache.org</code>. This configuration will cause
125 Apache to perform a double reverse DNS lookup on the client IP
126 address, regardless of the setting of the <code class="directive"><a href="../mod/core.html#hostnamelookups">HostnameLookups</a></code> directive. It will do
127 a reverse DNS lookup on the IP address to find the associated
128 hostname, and then do a forward lookup on the hostname to assure
129 that it matches the original IP address. Only if the forward
130 and reverse DNS are consistent and the hostname matches will
131 access be allowed.</p></dd>
133 <dt>A full IP address</dt>
136 <div class="example"><h3>Example:</h3><p><code>
137 Allow from 10.1.2.3<br />
138 Allow from 192.168.1.104 192.168.1.205
140 <p>An IP address of a host allowed access</p></dd>
142 <dt>A partial IP address</dt>
145 <div class="example"><h3>Example:</h3><p><code>
146 Allow from 10.1<br />
147 Allow from 10 172.20 192.168.2
149 <p>The first 1 to 3 bytes of an IP address, for subnet
150 restriction.</p></dd>
152 <dt>A network/netmask pair</dt>
155 <div class="example"><h3>Example:</h3><p><code>
156 Allow from 10.1.0.0/255.255.0.0
158 <p>A network a.b.c.d, and a netmask w.x.y.z. For more
159 fine-grained subnet restriction.</p></dd>
161 <dt>A network/nnn CIDR specification</dt>
164 <div class="example"><h3>Example:</h3><p><code>
165 Allow from 10.1.0.0/16
167 <p>Similar to the previous case, except the netmask consists of
168 nnn high-order 1 bits.</p></dd>
171 <p>Note that the last three examples above match exactly the
172 same set of hosts.</p>
174 <p>IPv6 addresses and IPv6 subnets can be specified as shown
177 <div class="example"><p><code>
178 Allow from 2001:db8::a00:20ff:fea7:ccea<br />
179 Allow from 2001:db8::a00:20ff:fea7:ccea/10
182 <p>The third format of the arguments to the
183 <code class="directive">Allow</code> directive allows access to the server
184 to be controlled based on the existence of an <a href="../env.html">environment variable</a>. When <code>Allow from
185 env=<var>env-variable</var></code> is specified, then the request is
186 allowed access if the environment variable <var>env-variable</var>
187 exists. The server provides the ability to set environment
188 variables in a flexible way based on characteristics of the client
189 request using the directives provided by
190 <code class="module"><a href="../mod/mod_setenvif.html">mod_setenvif</a></code>. Therefore, this directive can be
191 used to allow access based on such factors as the clients
192 <code>User-Agent</code> (browser type), <code>Referer</code>, or
193 other HTTP request header fields.</p>
195 <div class="example"><h3>Example:</h3><p><code>
196 SetEnvIf User-Agent ^KnockKnock/2\.0 let_me_in<br />
197 <Directory /docroot><br />
198 <span class="indent">
199 Order Deny,Allow<br />
201 Allow from env=let_me_in<br />
206 <p>In this case, browsers with a user-agent string beginning
207 with <code>KnockKnock/2.0</code> will be allowed access, and all
208 others will be denied.</p>
211 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
212 <div class="directive-section"><h2><a name="Deny" id="Deny">Deny</a> <a name="deny" id="deny">Directive</a></h2>
213 <table class="directive">
214 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Controls which hosts are denied access to the
216 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code> Deny from all|<var>host</var>|env=<var>env-variable</var>
217 [<var>host</var>|env=<var>env-variable</var>] ...</code></td></tr>
218 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
219 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Limit</td></tr>
220 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
221 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_access_compat</td></tr>
223 <p>This directive allows access to the server to be restricted
224 based on hostname, IP address, or environment variables. The
225 arguments for the <code class="directive">Deny</code> directive are
226 identical to the arguments for the <code class="directive"><a href="#allow">Allow</a></code> directive.</p>
229 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
230 <div class="directive-section"><h2><a name="Order" id="Order">Order</a> <a name="order" id="order">Directive</a></h2>
231 <table class="directive">
232 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Controls the default access state and the order in which
233 <code class="directive">Allow</code> and <code class="directive">Deny</code> are
235 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code> Order <var>ordering</var></code></td></tr>
236 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Order Deny,Allow</code></td></tr>
237 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
238 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Limit</td></tr>
239 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
240 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_access_compat</td></tr>
243 <p>The <code class="directive">Order</code> directive, along with the
244 <code class="directive"><a href="#allow">Allow</a></code> and
245 <code class="directive"><a href="#deny">Deny</a></code> directives,
246 controls a three-pass access control system. The first pass
247 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
248 by the <code class="directive"><a href="#order">Order</a></code>
249 directive. The second pass parses the rest of the directives
250 (<code class="directive"><a href="#deny">Deny</a></code> or
251 <code class="directive"><a href="#allow">Allow</a></code>). The third
252 pass applies to all requests which do not match either of the first
255 <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
256 processed, unlike a typical firewall, where only the first match is
257 used. The last match is effective (also unlike a typical firewall).
258 Additionally, the order in which lines appear in the configuration
259 files is not significant -- all <code class="directive"><a href="#allow">Allow</a></code> lines are processed as
260 one group, all <code class="directive"><a href="#deny">Deny</a></code> lines are considered as
261 another, and the default state is considered by itself.</p>
263 <p><em>Ordering</em> is one of:</p>
266 <dt><code>Allow,Deny</code></dt>
268 <dd>First, all <code class="directive"><a href="#allow">Allow</a></code> directives are
269 evaluated; at least one must match, or the request is rejected.
270 Next, all <code class="directive"><a href="#deny">Deny</a></code>
271 directives are evaluated. If any matches, the request is rejected.
272 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
275 <dt><code>Deny,Allow</code></dt>
277 <dd>First, all <code class="directive"><a href="#deny">Deny</a></code> directives are
278 evaluated; if any match, the request is denied
279 <strong>unless</strong> it also matches an <code class="directive"><a href="#allow">Allow</a></code> directive. Any
280 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
283 <dt><code>Mutual-failure</code></dt>
285 <dd>This order has the same effect as <code class="directive">Order
286 Allow,Deny</code> and is deprecated in its favor.</dd>
289 <p>Keywords may only be separated by a comma; <em>no whitespace</em>
290 is allowed between them.</p>
292 <table class="bordered">
295 <th>Allow,Deny result</th>
296 <th>Deny,Allow result</th>
298 <th>Match Allow only</th>
299 <td>Request allowed</td>
300 <td>Request allowed</td>
302 <th>Match Deny only</th>
303 <td>Request denied</td>
304 <td>Request denied</td>
307 <td>Default to second directive: Denied</td>
308 <td>Default to second directive: Allowed</td>
310 <th>Match both Allow & Deny</th>
311 <td>Final match controls: Denied</td>
312 <td>Final match controls: Allowed</td>
316 <p>In the following example, all hosts in the apache.org domain
317 are allowed access; all other hosts are denied access.</p>
319 <div class="example"><p><code>
320 Order Deny,Allow<br />
322 Allow from apache.org
325 <p>In the next example, all hosts in the apache.org domain are
326 allowed access, except for the hosts which are in the
327 foo.apache.org subdomain, who are denied access. All hosts not
328 in the apache.org domain are denied access because the default
329 state is to <code class="directive"><a href="#deny">Deny</a></code>
330 access to the server.</p>
332 <div class="example"><p><code>
333 Order Allow,Deny<br />
334 Allow from apache.org<br />
335 Deny from foo.apache.org
338 <p>On the other hand, if the <code class="directive">Order</code> in the
339 last example is changed to <code>Deny,Allow</code>, all hosts will
340 be allowed access. This happens because, regardless of the actual
341 ordering of the directives in the configuration file, the
342 <code>Allow from apache.org</code> will be evaluated last and will
343 override the <code>Deny from foo.apache.org</code>. All hosts not in
344 the <code>apache.org</code> domain will also be allowed access
345 because the default state is <code class="directive"><a href="#allow">Allow</a></code>.</p>
347 <p>The presence of an <code class="directive">Order</code> directive can
348 affect access to a part of the server even in the absence of
349 accompanying <code class="directive"><a href="#allow">Allow</a></code>
350 and <code class="directive"><a href="#deny">Deny</a></code>
351 directives because of its effect on the default access state. For
354 <div class="example"><p><code>
355 <Directory /www><br />
356 <span class="indent">
357 Order Allow,Deny<br />
362 <p>will Deny all access to the <code>/www</code> directory
363 because the default access state is set to
364 <code class="directive"><a href="#deny">Deny</a></code>.</p>
366 <p>The <code class="directive">Order</code> directive controls the order of access
367 directive processing only within each phase of the server's
368 configuration processing. This implies, for example, that an
369 <code class="directive"><a href="#allow">Allow</a></code> or <code class="directive"><a href="#deny">Deny</a></code> directive occurring in a
370 <code class="directive"><a href="../mod/core.html#location"><Location></a></code> section will
371 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
372 <code class="directive"><a href="../mod/core.html#directory"><Directory></a></code> section or
373 <code>.htaccess</code> file, regardless of the setting of the
374 <code class="directive">Order</code> directive. For details on the merging
375 of configuration sections, see the documentation on <a href="../sections.html">How Directory, Location and Files sections
379 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
380 <div class="directive-section"><h2><a name="Satisfy" id="Satisfy">Satisfy</a> <a name="satisfy" id="satisfy">Directive</a></h2>
381 <table class="directive">
382 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Interaction between host-level access control and
383 user authentication</td></tr>
384 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Satisfy Any|All</code></td></tr>
385 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Satisfy All</code></td></tr>
386 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
387 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
388 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
389 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_access_compat</td></tr>
390 <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
393 <p>Access policy if both <code class="directive"><a href="../mod/mod_authz_host.html#allow">Allow</a></code> and <code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code> used. The parameter can be
394 either <code>All</code> or <code>Any</code>. This directive is only
395 useful if access to a particular area is being restricted by both
396 username/password <em>and</em> client host address. In this case
397 the default behavior (<code>All</code>) is to require that the client
398 passes the address access restriction <em>and</em> enters a valid
399 username and password. With the <code>Any</code> option the client will be
400 granted access if they either pass the host restriction or enter a
401 valid username and password. This can be used to password restrict
402 an area, but to let clients from particular addresses in without
403 prompting for a password.</p>
405 <p>For example, if you wanted to let people on your network have
406 unrestricted access to a portion of your website, but require that
407 people outside of your network provide a password, you could use a
408 configuration similar to the following:</p>
410 <div class="example"><p><code>
411 Require valid-user<br />
412 Allow from 192.168.1<br />
416 <p>Since version 2.0.51 <code class="directive">Satisfy</code> directives can
417 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>
421 <li><code class="directive"><a href="#allow">Allow</a></code></li>
422 <li><code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code></li>
426 <div class="bottomlang">
427 <p><span>Available Languages: </span><a href="../en/mod/mod_access_compat.html" title="English"> en </a> |
428 <a href="../ja/mod/mod_access_compat.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a></p>
429 </div><div id="footer">
430 <p class="apache">Copyright 2007 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>
431 <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>