manual/mod/mod_access.html

	mod_access.html revision d030d579df50673f566f5dbcd1904fd59cd310e0
1N/A<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
1N/A<HTML>
1N/A<HEAD>
1N/A<TITLE>Apache module mod_access</TITLE>
1N/A</HEAD>
1N/A
1N/A<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
1N/A<BODY
1N/A BGCOLOR="#FFFFFF"
1N/A TEXT="#000000"
1N/A LINK="#0000FF"
1N/A VLINK="#000080"
1N/A ALINK="#FF0000"
1N/A>
1N/A<!--#include virtual="header.html" -->
1N/A
1N/A<H1 ALIGN="CENTER">Module mod_access</H1>
1N/A<P>
1N/AThis module is contained in the <CODE>mod_access.c</CODE> file, and
1N/Ais compiled in by default. It provides access control based on client
1N/Ahostname or IP address.
1N/A</P>
1N/A
1N/A<UL>
1N/A<LI><A HREF="#allow">allow</A>
1N/A<LI><A HREF="#allowfromenv">allow from env=</A>
1N/A<LI><A HREF="#deny">deny</A>
1N/A<LI><A HREF="#denyfromenv">deny from env=</A>
1N/A<LI><A HREF="#order">order</A>
1N/A</UL>
1N/A<HR>
1N/A
1N/A
1N/A<H2><A NAME="allow">allow directive</A></H2>
1N/A<P>
1N/A<!--%plaintext &lt;?INDEX {\tt allow} directive&gt; -->
1N/A<A
1N/A HREF="directive-dict.html#Syntax"
1N/A REL="Help"
1N/A><STRONG>Syntax:</STRONG></A> allow from <EM>host host ...</EM><BR>
1N/A<A
1N/A HREF="directive-dict.html#Context"
1N/A REL="Help"
1N/A><STRONG>Context:</STRONG></A> directory, .htaccess<BR>
1N/A<A
1N/A HREF="directive-dict.html#Override"
1N/A REL="Help"
1N/A><STRONG>Override:</STRONG></A> Limit<BR>
1N/A<A
1N/A HREF="directive-dict.html#Status"
1N/A REL="Help"
1N/A><STRONG>Status:</STRONG></A> Base<BR>
1N/A<A
1N/A HREF="directive-dict.html#Module"
1N/A REL="Help"
1N/A><STRONG>Module:</STRONG></A> mod_access
1N/A</P>
1N/A<P>
1N/AThe allow directive affects which hosts can access a given directory.
1N/A<EM>Host</EM> is one of the following:
1N/A</P>
1N/A<DL>
1N/A<DT><CODE>all</CODE>
1N/A<DD>All hosts are allowed access
1N/A<DT>A (partial) domain-name
1N/A<DD>Hosts whose names match, or end in, this string are allowed access.
1N/A<DT>A full IP address
1N/A<DD>An IP address of a host allowed access
1N/A<DT>A partial IP address
1N/A<DD>The first 1 to 3 bytes of an IP address, for subnet restriction.
1N/A<DT>A network/netmask pair (<STRONG>Apache 1.3 and later</STRONG>)
1N/A<DD>A network a.b.c.d, and a netmask w.x.y.z.  For more fine-grained subnet
1N/A    restriction.  (i.e. 10.1.0.0/255.255.0.0)
1N/A<DT>A network/nnn CIDR specification (<STRONG>Apache 1.3 and later</STRONG>)
1N/A<DD>Similar to the previous case, except the netmask consists of nnn
1N/A    high-order 1 bits.  (i.e. 10.1.0.0/16 is the same as 10.1.0.0/255.255.0.0)
1N/A</DL>
1N/A<P>
1N/AExample:
1N/A</P>
1N/A<BLOCKQUOTE><CODE>allow from .ncsa.uiuc.edu</CODE></BLOCKQUOTE>
1N/A<P>
1N/AAll hosts in the specified domain are allowed access.
1N/A</P>
1N/A<P>
1N/ANote that this compares whole components; <CODE>bar.edu</CODE>
1N/Awould not match <CODE>foobar.edu</CODE>.
1N/A</P>
1N/A<P>
1N/ASee also <A HREF="#deny">deny</A>, <A HREF="#order">order</A>, and
1N/A<A HREF="mod_browser.html#browsermatch">BrowserMatch</A>.
1N/A</P>
1N/A
1N/A<P>
1N/A<A NAME="allowfromenv"><STRONG>Syntax:</STRONG> allow from
1N/A env=<EM>variablename</EM></A><BR>
1N/A<A
1N/A HREF="directive-dict.html#Context"
1N/A REL="Help"
1N/A><STRONG>Context:</STRONG></A> directory, .htaccess<BR>
1N/A<A
1N/A HREF="directive-dict.html#Override"
1N/A REL="Help"
1N/A><STRONG>Override:</STRONG></A> Limit<BR>
1N/A<A
1N/A HREF="directive-dict.html#Status"
1N/A REL="Help"
1N/A><STRONG>Status:</STRONG></A> Base<BR>
1N/A<A
1N/A HREF="directive-dict.html#Module"
1N/A REL="Help"
1N/A><STRONG>Module:</STRONG></A> mod_access<BR>
1N/A<A
1N/A HREF="directive-dict.html#Compatibility"
1N/A REL="Help"
1N/A><STRONG>Compatibility:</STRONG></A> Apache 1.2 and above
1N/A</P>
1N/A<P>
1N/AThe allow from env directive controls access to a directory by the
1N/Aexistence (or non-existence) of an environment variable.
1N/A</P>
1N/A<P>
1N/AExample:
1N/A</P>
1N/A<BLOCKQUOTE><PRE>
1N/ABrowserMatch ^KnockKnock/2.0 let_me_in
1N/A&lt;Directory /docroot&gt;
1N/A    order deny,allow
1N/A    deny from all
1N/A    allow from env=let_me_in
1N/A&lt;/Directory&gt;
1N/A</PRE></BLOCKQUOTE>
1N/AIn this case browsers with the user-agent string <TT>KnockKnock/2.0</TT> will
1N/Abe allowed access, and all others will be denied.
1N/A<P>
1N/ASee also <A HREF="#denyfromenv">deny from env</A>
1N/Aand <A HREF="#order">order</A>.
1N/A</P>
1N/A<HR>
1N/A
1N/A<H2><A NAME="deny">deny directive</A></H2>
1N/A<P>
1N/A<!--%plaintext &lt;?INDEX {\tt deny} directive&gt; -->
1N/A<A
1N/A HREF="directive-dict.html#Syntax"
1N/A REL="Help"
1N/A><STRONG>Syntax:</STRONG></A> deny from <EM>host host ...</EM><BR>
1N/A<A
1N/A HREF="directive-dict.html#Context"
1N/A REL="Help"
1N/A><STRONG>Context:</STRONG></A> directory, .htaccess<BR>
1N/A<A
1N/A HREF="directive-dict.html#Override"
1N/A REL="Help"
1N/A><STRONG>Override:</STRONG></A> Limit<BR>
1N/A<A
1N/A HREF="directive-dict.html#Status"
1N/A REL="Help"
1N/A><STRONG>Status:</STRONG></A> Base<BR>
1N/A<A
1N/A HREF="directive-dict.html#Module"
1N/A REL="Help"
1N/A><STRONG>Module:</STRONG></A> mod_access
1N/A</P>
1N/A<P>
1N/AThe deny directive affects which hosts can access a given directory.
1N/A<EM>Host</EM> is one of the following:
1N/A</P>
1N/A<DL>
1N/A<DT><CODE>all</CODE>
1N/A<DD>all hosts are denied access
1N/A<DT>A (partial) domain-name
1N/A<DD>host whose name is, or ends in, this string are denied access.
1N/A<DT>A full IP address
1N/A<DD>An IP address of a host denied access
1N/A<DT>A partial IP address
1N/A<DD>The first 1 to 3 bytes of an IP address, for subnet restriction.
1N/A<DT>A network/netmask pair (<STRONG>Apache 1.3 and later</STRONG>)
1N/A<DD>A network a.b.c.d, and a netmask w.x.y.z.  For more fine-grained subnet
1N/A    restriction.  (i.e. 10.1.0.0/255.255.0.0)
1N/A<DT>A network/nnn CIDR specification (<STRONG>Apache 1.3 and later</STRONG>)
1N/A<DD>Similar to the previous case, except the netmask consists of nnn
1N/A    high-order 1 bits.  (i.e. 10.1.0.0/16 is the same as 10.1.0.0/255.255.0.0)
1N/A</DL>
1N/A<P>
1N/AExample:
1N/A</P>
1N/A<BLOCKQUOTE><CODE>deny from 16</CODE></BLOCKQUOTE>
1N/A<P>
1N/AAll hosts in the specified network are denied access.
1N/A</P>
1N/A<P>
1N/ANote that this compares whole components; <CODE>bar.edu</CODE>
1N/Awould not match <CODE>foobar.edu</CODE>.
1N/A</P>
1N/A<P>
1N/ASee also <A HREF="#allow">allow</A> and <A HREF="#order">order</A>.
1N/A</P>
1N/A
1N/A<P>
1N/A<A NAME="denyfromenv"><STRONG>Syntax:</STRONG> deny from
1N/A env=<EM>variablename</EM></A><BR>
1N/A<A
1N/A HREF="directive-dict.html#Context"
1N/A REL="Help"
1N/A><STRONG>Context:</STRONG></A> directory, .htaccess<BR>
1N/A<A
1N/A HREF="directive-dict.html#Override"
1N/A REL="Help"
1N/A><STRONG>Override:</STRONG></A> Limit<BR>
1N/A<A
1N/A HREF="directive-dict.html#Status"
1N/A REL="Help"
1N/A><STRONG>Status:</STRONG></A> Base<BR>
1N/A<A
1N/A HREF="directive-dict.html#Module"
1N/A REL="Help"
1N/A><STRONG>Module:</STRONG></A> mod_access<BR>
1N/A<A
1N/A HREF="directive-dict.html#Compatibility"
1N/A REL="Help"
1N/A><STRONG>Compatibility:</STRONG></A> Apache 1.2 and above
1N/A</P>
1N/A<P>
1N/AThe deny from env directive controls access to a directory by the
1N/Aexistence (or non-existence) of an environment variable.
1N/A</P>
1N/A<P>
1N/AExample:
1N/A</P>
1N/A<BLOCKQUOTE><PRE>
1N/ABrowserMatch ^BadRobot/0.9 go_away
1N/A&lt;Directory /docroot&gt;
1N/A    order allow,deny
1N/A    allow from all
1N/A    deny from env=go_away
1N/A&lt;/Directory&gt;
1N/A</PRE></BLOCKQUOTE>
1N/AIn this case browsers with the user-agent string <TT>BadRobot/0.9</TT> will
1N/Abe denied access, and all others will be allowed.
1N/A
1N/A<P>
1N/ASee also <A HREF="#allowfromenv">allow from env</A>
1N/Aand <A HREF="#order">order</A>.
1N/A</P>
1N/A<HR>
1N/A
1N/A<H2><A NAME="order">order directive</A></H2>
1N/A<P>
1N/A<!--%plaintext &lt;?INDEX {\tt order} directive&gt; -->
1N/A<A
1N/A HREF="directive-dict.html#Syntax"
1N/A REL="Help"
1N/A><STRONG>Syntax:</STRONG></A> order <EM>ordering</EM><BR>
1N/A<A
 HREF="directive-dict.html#Default"
 REL="Help"
><STRONG>Default:</STRONG></A> <CODE>order deny,allow</CODE><BR>
<A
 HREF="directive-dict.html#Context"
 REL="Help"
><STRONG>Context:</STRONG></A> directory, .htaccess<BR>
<A
 HREF="directive-dict.html#Override"
 REL="Help"
><STRONG>Override:</STRONG></A> Limit<BR>
<A
 HREF="directive-dict.html#Status"
 REL="Help"
><STRONG>Status:</STRONG></A> Base<BR>
<A
 HREF="directive-dict.html#Module"
 REL="Help"
><STRONG>Module:</STRONG></A> mod_access
</P>
<P>
The order directive controls the order in which <A HREF="#allow">allow</A> and
<A HREF="#deny">deny</A> directives are evaluated. <EM>Ordering</EM> is one
of
</P>
<DL>
<DT>deny,allow
<DD>the deny directives are evaluated before the allow directives.  (The
initial state is OK.)
<DT>allow,deny
<DD>the allow directives are evaluated before the deny directives.  (The
initial state is FORBIDDEN.)
<DT>mutual-failure
<DD>Only those hosts which appear on the allow list and do not appear
on the deny list are granted access.  (The initial state is irrelevant.)
</DL>
<P>
<STRONG>Note that in all cases every <CODE>allow</CODE> and <CODE>deny</CODE>
statement is evaluated, there is no &quot;short-circuiting&quot;.</STRONG>
</P>
<P>
Example:
</P>
<BLOCKQUOTE><CODE>
    order deny,allow<BR>
    deny from all<BR>
    allow from .ncsa.uiuc.edu<BR>
</CODE></BLOCKQUOTE>
<P>
Hosts in the ncsa.uiuc.edu domain are allowed access; all other hosts are
denied access.
</P>
<!--#include virtual="footer.html" -->
</BODY>
</HTML>