mod_remoteip.html.en revision 888cb40bdeec5abf452bd85d6bf63b26d5913d4c
6ae232055d4d8a97267517c5e50074c2c819941and<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
6ae232055d4d8a97267517c5e50074c2c819941and<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
6ae232055d4d8a97267517c5e50074c2c819941and XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
6ae232055d4d8a97267517c5e50074c2c819941and This file is generated from xml source: DO NOT EDIT
6ae232055d4d8a97267517c5e50074c2c819941and XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
6ae232055d4d8a97267517c5e50074c2c819941and<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
6ae232055d4d8a97267517c5e50074c2c819941and<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
6ae232055d4d8a97267517c5e50074c2c819941and<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" />
6ae232055d4d8a97267517c5e50074c2c819941and<script src="/style/scripts/prettify.js" type="text/javascript">
6ae232055d4d8a97267517c5e50074c2c819941and<link href="/images/favicon.ico" rel="shortcut icon" /></head>
6ae232055d4d8a97267517c5e50074c2c819941and<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p>
6ae232055d4d8a97267517c5e50074c2c819941and<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div>
6ae232055d4d8a97267517c5e50074c2c819941and<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>
4b3a8afbfcea8b265d179a122bf40dfedd1ce280takashi<div id="preamble"><h1>Apache Module mod_remoteip</h1>
6ae232055d4d8a97267517c5e50074c2c819941and<p><span>Available Languages: </span><a href="/en/mod/mod_remoteip.html" title="English"> en </a> |
6ae232055d4d8a97267517c5e50074c2c819941and<a href="/fr/mod/mod_remoteip.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a></p>
6ae232055d4d8a97267517c5e50074c2c819941and<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Replaces the original client IP address for the connection
6ae232055d4d8a97267517c5e50074c2c819941andwith the useragent IP address list presented by a proxies or a load balancer
6ae232055d4d8a97267517c5e50074c2c819941andvia the request headers.
6ae232055d4d8a97267517c5e50074c2c819941and<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
6ae232055d4d8a97267517c5e50074c2c819941and<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>remoteip_module</td></tr>
6ae232055d4d8a97267517c5e50074c2c819941and<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_remoteip.c</td></tr></table>
6ae232055d4d8a97267517c5e50074c2c819941and <p>This module is used to treat the useragent which initiated the
6ae232055d4d8a97267517c5e50074c2c819941and request as the originating useragent as identified by httpd for the
6ae232055d4d8a97267517c5e50074c2c819941and purposes of authorization and logging, even where that useragent is
6ae232055d4d8a97267517c5e50074c2c819941and behind a load balancer, front end server, or proxy server.</p>
6ae232055d4d8a97267517c5e50074c2c819941and <p>The module overrides the client IP address for the connection
6ae232055d4d8a97267517c5e50074c2c819941and with the useragent IP address reported in the request header configured
6ae232055d4d8a97267517c5e50074c2c819941and with the <code class="directive">RemoteIPHeader</code> directive.</p>
6ae232055d4d8a97267517c5e50074c2c819941and <p>Once replaced as instructed, this overridden useragent IP address is
6ae232055d4d8a97267517c5e50074c2c819941and then used for the <code class="module"><a href="/mod/mod_authz_host.html">mod_authz_host</a></code>
6ae232055d4d8a97267517c5e50074c2c819941and <code class="directive"><a href="/mod/mod_authz_host.html#require ip"><Require ip></a></code>
6ae232055d4d8a97267517c5e50074c2c819941and feature, is reported by <code class="module"><a href="/mod/mod_status.html">mod_status</a></code>, and is recorded by
6ae232055d4d8a97267517c5e50074c2c819941and <code class="module"><a href="/mod/mod_log_config.html">mod_log_config</a></code> <code>%a</code> and <code class="module"><a href="/mod/core.html">core</a></code>
6ae232055d4d8a97267517c5e50074c2c819941and <code>%a</code> format strings. The underlying client IP of the connection
6ae232055d4d8a97267517c5e50074c2c819941and is available in the <code>%{c}a</code> format string.</p>
6ae232055d4d8a97267517c5e50074c2c819941and <div class="warning">It is critical to only enable this behavior from
6ae232055d4d8a97267517c5e50074c2c819941and intermediate hosts (proxies, etc) which are trusted by this server, since
6ae232055d4d8a97267517c5e50074c2c819941and it is trivial for the remote useragent to impersonate another
6ae232055d4d8a97267517c5e50074c2c819941and useragent.</div>
6ae232055d4d8a97267517c5e50074c2c819941and<div id="quickview"><h3 class="directives">Directives</h3>
6ae232055d4d8a97267517c5e50074c2c819941and<li><img alt="" src="/images/down.gif" /> <a href="#remoteipheader">RemoteIPHeader</a></li>
6ae232055d4d8a97267517c5e50074c2c819941and<li><img alt="" src="/images/down.gif" /> <a href="#remoteipinternalproxy">RemoteIPInternalProxy</a></li>
6ae232055d4d8a97267517c5e50074c2c819941and<li><img alt="" src="/images/down.gif" /> <a href="#remoteipinternalproxylist">RemoteIPInternalProxyList</a></li>
6ae232055d4d8a97267517c5e50074c2c819941and<li><img alt="" src="/images/down.gif" /> <a href="#remoteipproxiesheader">RemoteIPProxiesHeader</a></li>
6ae232055d4d8a97267517c5e50074c2c819941and<li><img alt="" src="/images/down.gif" /> <a href="#remoteiptrustedproxy">RemoteIPTrustedProxy</a></li>
6ae232055d4d8a97267517c5e50074c2c819941and<li><img alt="" src="/images/down.gif" /> <a href="#remoteiptrustedproxylist">RemoteIPTrustedProxyList</a></li>
6ae232055d4d8a97267517c5e50074c2c819941and<li><img alt="" src="/images/down.gif" /> <a href="#processing">Remote IP Processing</a></li>
6ae232055d4d8a97267517c5e50074c2c819941and<li><code class="module"><a href="/mod/mod_authz_host.html">mod_authz_host</a></code></li>
6ae232055d4d8a97267517c5e50074c2c819941and<li><code class="module"><a href="/mod/mod_status.html">mod_status</a></code></li>
6ae232055d4d8a97267517c5e50074c2c819941and<li><code class="module"><a href="/mod/mod_log_config.html">mod_log_config</a></code></li>
6ae232055d4d8a97267517c5e50074c2c819941and</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
6ae232055d4d8a97267517c5e50074c2c819941and<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
6ae232055d4d8a97267517c5e50074c2c819941and<h2><a name="processing" id="processing">Remote IP Processing</a></h2>
6ae232055d4d8a97267517c5e50074c2c819941and <p>Apache by default identifies the useragent with the connection's
6ae232055d4d8a97267517c5e50074c2c819941and client_ip value, and the connection remote_host and remote_logname are
6ae232055d4d8a97267517c5e50074c2c819941and derived from this value. These fields play a role in authentication,
6ae232055d4d8a97267517c5e50074c2c819941and authorization and logging and other purposes by other loadable
6ae232055d4d8a97267517c5e50074c2c819941and modules.</p>
6ae232055d4d8a97267517c5e50074c2c819941and <p>mod_remoteip overrides the client IP of the connection with the
6ae232055d4d8a97267517c5e50074c2c819941and advertised useragent IP as provided by a proxy or load balancer, for
6ae232055d4d8a97267517c5e50074c2c819941and the duration of the request. A load balancer might establish a long
6ae232055d4d8a97267517c5e50074c2c819941and lived keepalive connection with the server, and each request will
6ae232055d4d8a97267517c5e50074c2c819941and have the correct useragent IP, even though the underlying client IP
6ae232055d4d8a97267517c5e50074c2c819941and address of the load balancer remains unchanged.</p>
6ae232055d4d8a97267517c5e50074c2c819941and <p>When multiple, comma delimited useragent IP addresses are listed in the
6ae232055d4d8a97267517c5e50074c2c819941and header value, they are processed in Right-to-Left order. Processing
6ae232055d4d8a97267517c5e50074c2c819941and halts when a given useragent IP address is not trusted to present the
6ae232055d4d8a97267517c5e50074c2c819941and preceding IP address. The header field is updated to this remaining
6ae232055d4d8a97267517c5e50074c2c819941and list of unconfirmed IP addresses, or if all IP addresses were trusted,
6ae232055d4d8a97267517c5e50074c2c819941and this header is removed from the request altogether.</p>
6ae232055d4d8a97267517c5e50074c2c819941and <p>In overriding the client IP, the module stores the list of intermediate
6ae232055d4d8a97267517c5e50074c2c819941and hosts in a remoteip-proxy-ip-list note, which <code class="module"><a href="/mod/mod_log_config.html">mod_log_config</a></code>
6ae232055d4d8a97267517c5e50074c2c819941and can record using the <code>%{remoteip-proxy-ip-list}n</code> format token.
6ae232055d4d8a97267517c5e50074c2c819941and If the administrator needs to store this as an additional header, this
6ae232055d4d8a97267517c5e50074c2c819941and same value can also be recording as a header using the directive
6ae232055d4d8a97267517c5e50074c2c819941and <code class="directive">RemoteIPProxiesHeader</code>.</p>
6ae232055d4d8a97267517c5e50074c2c819941and <div class="note"><h3>IPv4-over-IPv6 Mapped Addresses</h3>
6ae232055d4d8a97267517c5e50074c2c819941and As with httpd in general, any IPv4-over-IPv6 mapped addresses are recorded
6ae232055d4d8a97267517c5e50074c2c819941and in their IPv4 representation.</div>
6ae232055d4d8a97267517c5e50074c2c819941and All internal addresses 10/8, 172.16/12, 192.168/16, 169.254/16 and 127/8
6ae232055d4d8a97267517c5e50074c2c819941and blocks (and IPv6 addresses outside of the public 2000::/3 block) are only
6ae232055d4d8a97267517c5e50074c2c819941and evaluated by mod_remoteip when <code class="directive">RemoteIPInternalProxy</code>
6ae232055d4d8a97267517c5e50074c2c819941and internal (intranet) proxies are registered.</div>
6ae232055d4d8a97267517c5e50074c2c819941and<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
6ae232055d4d8a97267517c5e50074c2c819941and<div class="directive-section"><h2><a name="RemoteIPHeader" id="RemoteIPHeader">RemoteIPHeader</a> <a name="remoteipheader" id="remoteipheader">Directive</a></h2>
6ae232055d4d8a97267517c5e50074c2c819941and<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Declare the header field which should be parsed for useragent IP addresses</td></tr>
6ae232055d4d8a97267517c5e50074c2c819941and<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RemoteIPHeader <var>header-field</var></code></td></tr>
6ae232055d4d8a97267517c5e50074c2c819941and<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
6ae232055d4d8a97267517c5e50074c2c819941and<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
6ae232055d4d8a97267517c5e50074c2c819941and<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_remoteip</td></tr>
6ae232055d4d8a97267517c5e50074c2c819941and <p>The <code class="directive">RemoteIPHeader</code> directive triggers
6ae232055d4d8a97267517c5e50074c2c819941and <code class="module"><a href="/mod/mod_remoteip.html">mod_remoteip</a></code> to treat the value of the specified
6ae232055d4d8a97267517c5e50074c2c819941and <var>header-field</var> header as the useragent IP address, or list
6ae232055d4d8a97267517c5e50074c2c819941and of intermediate useragent IP addresses, subject to further configuration
6ae232055d4d8a97267517c5e50074c2c819941and of the <code class="directive">RemoteIPInternalProxy</code> and
6ae232055d4d8a97267517c5e50074c2c819941and <code class="directive">RemoteIPTrustedProxy</code> directives. Unless these
6ae232055d4d8a97267517c5e50074c2c819941and other directives are used, <code class="module"><a href="/mod/mod_remoteip.html">mod_remoteip</a></code> will trust all
4b3a8afbfcea8b265d179a122bf40dfedd1ce280takashi hosts presenting a <code class="directive">RemoteIPHeader</code> IP value.</p>
6ae232055d4d8a97267517c5e50074c2c819941and <div class="example"><h3>Internal (Load Balancer) Example</h3><pre class="prettyprint lang-config">
6ae232055d4d8a97267517c5e50074c2c819941and RemoteIPHeader X-Client-IP
<div class="directive-section"><h2><a name="RemoteIPInternalProxy" id="RemoteIPInternalProxy">RemoteIPInternalProxy</a> <a name="remoteipinternalproxy" id="remoteipinternalproxy">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Declare client intranet IP addresses trusted to present the RemoteIPHeader value</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RemoteIPInternalProxy <var>proxy-ip</var>|<var>proxy-ip/subnet</var>|<var>hostname</var> ...</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
RemoteIPInternalProxy gateway.localdomain
<div class="directive-section"><h2><a name="RemoteIPInternalProxyList" id="RemoteIPInternalProxyList">RemoteIPInternalProxyList</a> <a name="remoteipinternalproxylist" id="remoteipinternalproxylist">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Declare client intranet IP addresses trusted to present the RemoteIPHeader value</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RemoteIPInternalProxyList <var>filename</var></code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
gateway.localdomain #The front end balancer
<div class="directive-section"><h2><a name="RemoteIPProxiesHeader" id="RemoteIPProxiesHeader">RemoteIPProxiesHeader</a> <a name="remoteipproxiesheader" id="remoteipproxiesheader">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Declare the header field which will record all intermediate IP addresses</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RemoteIPProxiesHeader <var>HeaderFieldName</var></code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
a header into which <code class="module"><a href="/mod/mod_remoteip.html">mod_remoteip</a></code> will collect a list of
<div class="directive-section"><h2><a name="RemoteIPTrustedProxy" id="RemoteIPTrustedProxy">RemoteIPTrustedProxy</a> <a name="remoteiptrustedproxy" id="remoteiptrustedproxy">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Declare client intranet IP addresses trusted to present the RemoteIPHeader value</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RemoteIPTrustedProxy <var>proxy-ip</var>|<var>proxy-ip/subnet</var>|<var>hostname</var> ...</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
RemoteIPTrustedProxy proxy.example.com
<div class="directive-section"><h2><a name="RemoteIPTrustedProxyList" id="RemoteIPTrustedProxyList">RemoteIPTrustedProxyList</a> <a name="remoteiptrustedproxylist" id="remoteiptrustedproxylist">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Declare client intranet IP addresses trusted to present the RemoteIPHeader value</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RemoteIPTrustedProxyList <var>filename</var></code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
proxy.isp.example.com #some well known ISP
<p><span>Available Languages: </span><a href="/en/mod/mod_remoteip.html" title="English"> en </a> |
<a href="/fr/mod/mod_remoteip.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a></p>
</div><div class="top"><a href="#page-header"><img src="/images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>This section is experimental!</strong><br />Comments placed here should not be expected
to last beyond the testing phase of this system, nor do we in any way guarantee that we'll read them.</div>
var disqus_identifier = 'http://httpd.apache.org/docs/2.4/mod/mod_remoteip.html.en';
if (w.location.hostname.toLowerCase() == "httpd.apache.org" && disabled !== true) {
d.write('<div id="disqus_thread"><\/div>');
var s = d.createElement('script');
s.type = 'text/javascript';
s.async = true;
s.src = 'http' + '://' + disqus_shortname + '.disqus.com/embed.js';
(d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
d.write('<div id="disqus_thread">Comments are disabled for this page at the moment.<\/div>');
<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>
<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--