mod_remoteip.html.en revision af33a4994ae2ff15bc67d19ff1a7feb906745bf8
0066eddda7203f6345b56f77d146a759298dc635gryzor<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
0066eddda7203f6345b56f77d146a759298dc635gryzor<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
0066eddda7203f6345b56f77d146a759298dc635gryzor XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
0066eddda7203f6345b56f77d146a759298dc635gryzor This file is generated from xml source: DO NOT EDIT
0066eddda7203f6345b56f77d146a759298dc635gryzor XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
0066eddda7203f6345b56f77d146a759298dc635gryzor<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
0066eddda7203f6345b56f77d146a759298dc635gryzor<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen<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" />
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen<script src="/style/scripts/prettify.js" type="text/javascript">
0066eddda7203f6345b56f77d146a759298dc635gryzor<link href="/images/favicon.ico" rel="shortcut icon" /></head>
d229f940abfb2490dee17979e9a5ff31b7012eb5rbowen<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/quickreference.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>
0066eddda7203f6345b56f77d146a759298dc635gryzor<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div>
3f08db06526d6901aa08c110b5bc7dde6bc39905nd<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>
0066eddda7203f6345b56f77d146a759298dc635gryzor<div id="preamble"><h1>Apache Module mod_remoteip</h1>
0066eddda7203f6345b56f77d146a759298dc635gryzor<p><span>Available Languages: </span><a href="/en/mod/mod_remoteip.html" title="English"> en </a> |
0066eddda7203f6345b56f77d146a759298dc635gryzor<a href="/fr/mod/mod_remoteip.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a></p>
f086b4b402fa9a2fefc7dda85de2a3cc1cd0a654rjung<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Replaces the original client IP address for the connection
0066eddda7203f6345b56f77d146a759298dc635gryzorwith the useragent IP address list presented by a proxies or a load balancer
0066eddda7203f6345b56f77d146a759298dc635gryzorvia the request headers.
0066eddda7203f6345b56f77d146a759298dc635gryzor<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
0066eddda7203f6345b56f77d146a759298dc635gryzor<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>remoteip_module</td></tr>
0066eddda7203f6345b56f77d146a759298dc635gryzor<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_remoteip.c</td></tr></table>
0066eddda7203f6345b56f77d146a759298dc635gryzor <p>This module is used to treat the useragent which initiated the
0066eddda7203f6345b56f77d146a759298dc635gryzor request as the originating useragent as identified by httpd for the
0066eddda7203f6345b56f77d146a759298dc635gryzor purposes of authorization and logging, even where that useragent is
0066eddda7203f6345b56f77d146a759298dc635gryzor behind a load balancer, front end server, or proxy server.</p>
0066eddda7203f6345b56f77d146a759298dc635gryzor <p>The module overrides the client IP address for the connection
0066eddda7203f6345b56f77d146a759298dc635gryzor with the useragent IP address reported in the request header configured
0066eddda7203f6345b56f77d146a759298dc635gryzor with the <code class="directive">RemoteIPHeader</code> directive.</p>
0066eddda7203f6345b56f77d146a759298dc635gryzor <p>Once replaced as instructed, this overridden useragent IP address is
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh then used for the <code class="module"><a href="/mod/mod_authz_host.html">mod_authz_host</a></code>
0066eddda7203f6345b56f77d146a759298dc635gryzor <code class="directive"><a href="/mod/mod_authz_host.html#require ip"><Require ip></a></code>
0066eddda7203f6345b56f77d146a759298dc635gryzor feature, is reported by <code class="module"><a href="/mod/mod_status.html">mod_status</a></code>, and is recorded by
0066eddda7203f6345b56f77d146a759298dc635gryzor <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>
0066eddda7203f6345b56f77d146a759298dc635gryzor <code>%a</code> format strings. The underlying client IP of the connection
0066eddda7203f6345b56f77d146a759298dc635gryzor is available in the <code>%{c}a</code> format string.</p>
0066eddda7203f6345b56f77d146a759298dc635gryzor <div class="warning">It is critical to only enable this behavior from
0066eddda7203f6345b56f77d146a759298dc635gryzor intermediate hosts (proxies, etc) which are trusted by this server, since
0066eddda7203f6345b56f77d146a759298dc635gryzor it is trivial for the remote useragent to impersonate another
0066eddda7203f6345b56f77d146a759298dc635gryzor useragent.</div>
0066eddda7203f6345b56f77d146a759298dc635gryzor<div id="quickview"><h3 class="directives">Directives</h3>
0066eddda7203f6345b56f77d146a759298dc635gryzor<li><img alt="" src="/images/down.gif" /> <a href="#remoteipheader">RemoteIPHeader</a></li>
0066eddda7203f6345b56f77d146a759298dc635gryzor<li><img alt="" src="/images/down.gif" /> <a href="#remoteipinternalproxy">RemoteIPInternalProxy</a></li>
0066eddda7203f6345b56f77d146a759298dc635gryzor<li><img alt="" src="/images/down.gif" /> <a href="#remoteipinternalproxylist">RemoteIPInternalProxyList</a></li>
0066eddda7203f6345b56f77d146a759298dc635gryzor<li><img alt="" src="/images/down.gif" /> <a href="#remoteipproxiesheader">RemoteIPProxiesHeader</a></li>
0066eddda7203f6345b56f77d146a759298dc635gryzor<li><img alt="" src="/images/down.gif" /> <a href="#remoteiptrustedproxy">RemoteIPTrustedProxy</a></li>
0066eddda7203f6345b56f77d146a759298dc635gryzor<li><img alt="" src="/images/down.gif" /> <a href="#remoteiptrustedproxylist">RemoteIPTrustedProxyList</a></li>
0066eddda7203f6345b56f77d146a759298dc635gryzor<li><img alt="" src="/images/down.gif" /> <a href="#processing">Remote IP Processing</a></li>
0066eddda7203f6345b56f77d146a759298dc635gryzor<li><code class="module"><a href="/mod/mod_authz_host.html">mod_authz_host</a></code></li>
0066eddda7203f6345b56f77d146a759298dc635gryzor<li><code class="module"><a href="/mod/mod_status.html">mod_status</a></code></li>
0066eddda7203f6345b56f77d146a759298dc635gryzor<li><code class="module"><a href="/mod/mod_log_config.html">mod_log_config</a></code></li>
0066eddda7203f6345b56f77d146a759298dc635gryzor</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
0066eddda7203f6345b56f77d146a759298dc635gryzor<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
0066eddda7203f6345b56f77d146a759298dc635gryzor<h2><a name="processing" id="processing">Remote IP Processing</a></h2>
0066eddda7203f6345b56f77d146a759298dc635gryzor <p>Apache by default identifies the useragent with the connection's
0066eddda7203f6345b56f77d146a759298dc635gryzor client_ip value, and the connection remote_host and remote_logname are
0066eddda7203f6345b56f77d146a759298dc635gryzor derived from this value. These fields play a role in authentication,
0066eddda7203f6345b56f77d146a759298dc635gryzor authorization and logging and other purposes by other loadable
0066eddda7203f6345b56f77d146a759298dc635gryzor modules.</p>
0066eddda7203f6345b56f77d146a759298dc635gryzor <p>mod_remoteip overrides the client IP of the connection with the
0066eddda7203f6345b56f77d146a759298dc635gryzor advertised useragent IP as provided by a proxy or load balancer, for
0066eddda7203f6345b56f77d146a759298dc635gryzor the duration of the request. A load balancer might establish a long
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh lived keepalive connection with the server, and each request will
0066eddda7203f6345b56f77d146a759298dc635gryzor have the correct useragent IP, even though the underlying client IP
0066eddda7203f6345b56f77d146a759298dc635gryzor address of the load balancer remains unchanged.</p>
0066eddda7203f6345b56f77d146a759298dc635gryzor <p>When multiple, comma delimited useragent IP addresses are listed in the
0066eddda7203f6345b56f77d146a759298dc635gryzor header value, they are processed in Right-to-Left order. Processing
0066eddda7203f6345b56f77d146a759298dc635gryzor halts when a given useragent IP address is not trusted to present the
0066eddda7203f6345b56f77d146a759298dc635gryzor preceding IP address. The header field is updated to this remaining
0066eddda7203f6345b56f77d146a759298dc635gryzor list of unconfirmed IP addresses, or if all IP addresses were trusted,
0066eddda7203f6345b56f77d146a759298dc635gryzor this header is removed from the request altogether.</p>
0066eddda7203f6345b56f77d146a759298dc635gryzor <p>In overriding the client IP, the module stores the list of intermediate
0066eddda7203f6345b56f77d146a759298dc635gryzor hosts in a remoteip-proxy-ip-list note, which <code class="module"><a href="/mod/mod_log_config.html">mod_log_config</a></code>
0066eddda7203f6345b56f77d146a759298dc635gryzor can record using the <code>%{remoteip-proxy-ip-list}n</code> format token.
0066eddda7203f6345b56f77d146a759298dc635gryzor If the administrator needs to store this as an additional header, this
0066eddda7203f6345b56f77d146a759298dc635gryzor same value can also be recording as a header using the directive
0066eddda7203f6345b56f77d146a759298dc635gryzor <code class="directive">RemoteIPProxiesHeader</code>.</p>
0066eddda7203f6345b56f77d146a759298dc635gryzor <div class="note"><h3>IPv4-over-IPv6 Mapped Addresses</h3>
0066eddda7203f6345b56f77d146a759298dc635gryzor As with httpd in general, any IPv4-over-IPv6 mapped addresses are recorded
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh in their IPv4 representation.</div>
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh <div class="note"><h3>Internal (Private) Addresses</h3>
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh All internal addresses 10/8, 172.16/12, 192.168/16, 169.254/16 and 127/8
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh blocks (and IPv6 addresses outside of the public 2000::/3 block) are only
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh evaluated by mod_remoteip when <code class="directive">RemoteIPInternalProxy</code>
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh internal (intranet) proxies are registered.</div>
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
0066eddda7203f6345b56f77d146a759298dc635gryzor<div class="directive-section"><h2><a name="RemoteIPHeader" id="RemoteIPHeader">RemoteIPHeader</a> <a name="remoteipheader" id="remoteipheader">Directive</a></h2>
0066eddda7203f6345b56f77d146a759298dc635gryzor<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>
0066eddda7203f6345b56f77d146a759298dc635gryzor<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RemoteIPHeader <var>header-field</var></code></td></tr>
0066eddda7203f6345b56f77d146a759298dc635gryzor<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
0066eddda7203f6345b56f77d146a759298dc635gryzor<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
0066eddda7203f6345b56f77d146a759298dc635gryzor<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_remoteip</td></tr>
0066eddda7203f6345b56f77d146a759298dc635gryzor <p>The <code class="directive">RemoteIPHeader</code> directive triggers
0066eddda7203f6345b56f77d146a759298dc635gryzor <code class="module"><a href="/mod/mod_remoteip.html">mod_remoteip</a></code> to treat the value of the specified
0066eddda7203f6345b56f77d146a759298dc635gryzor <var>header-field</var> header as the useragent IP address, or list
0066eddda7203f6345b56f77d146a759298dc635gryzor of intermediate useragent IP addresses, subject to further configuration
0066eddda7203f6345b56f77d146a759298dc635gryzor of the <code class="directive">RemoteIPInternalProxy</code> and
0066eddda7203f6345b56f77d146a759298dc635gryzor <code class="directive">RemoteIPTrustedProxy</code> directives. Unless these
0066eddda7203f6345b56f77d146a759298dc635gryzor other directives are used, <code class="module"><a href="/mod/mod_remoteip.html">mod_remoteip</a></code> will trust all
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh hosts presenting a <code class="directive">RemoteIPHeader</code> IP value.</p>
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh <div class="example"><h3>Internal (Load Balancer) Example</h3><pre class="prettyprint lang-config">
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh RemoteIPHeader X-Client-IP
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh <div class="example"><h3>Proxy Example</h3><pre class="prettyprint lang-config">
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh RemoteIPHeader X-Forwarded-For
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh<div class="directive-section"><h2><a name="RemoteIPInternalProxy" id="RemoteIPInternalProxy">RemoteIPInternalProxy</a> <a name="remoteipinternalproxy" id="remoteipinternalproxy">Directive</a></h2>
0066eddda7203f6345b56f77d146a759298dc635gryzor<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>
0066eddda7203f6345b56f77d146a759298dc635gryzor<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>
0066eddda7203f6345b56f77d146a759298dc635gryzor<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
0066eddda7203f6345b56f77d146a759298dc635gryzor<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
0066eddda7203f6345b56f77d146a759298dc635gryzor<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_remoteip</td></tr>
f086b4b402fa9a2fefc7dda85de2a3cc1cd0a654rjung <p>The <code class="directive">RemoteIPInternalProxy</code> directive adds one
727872d18412fc021f03969b8641810d8896820bhumbedooh or more addresses (or address blocks) to trust as presenting a valid
0d0ba3a410038e179b695446bb149cce6264e0abnd RemoteIPHeader value of the useragent IP. Unlike the
727872d18412fc021f03969b8641810d8896820bhumbedooh <code class="directive">RemoteIPTrustedProxy</code> directive, any IP address
cc7e1025de9ac63bd4db6fe7f71c158b2cf09fe4humbedooh presented in this header, including private intranet addresses, are
0d0ba3a410038e179b695446bb149cce6264e0abnd trusted when passed from these proxies.</p>
727872d18412fc021f03969b8641810d8896820bhumbedooh <div class="example"><h3>Internal (Load Balancer) Example</h3><pre class="prettyprint lang-config">
0d0ba3a410038e179b695446bb149cce6264e0abndRemoteIPHeader X-Client-IP
0d0ba3a410038e179b695446bb149cce6264e0abndRemoteIPInternalProxy gateway.localdomain
727872d18412fc021f03969b8641810d8896820bhumbedooh<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
0d0ba3a410038e179b695446bb149cce6264e0abnd<div class="directive-section"><h2><a name="RemoteIPInternalProxyList" id="RemoteIPInternalProxyList">RemoteIPInternalProxyList</a> <a name="remoteipinternalproxylist" id="remoteipinternalproxylist">Directive</a></h2>
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh<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>
5effc8b39fae5cd169d17f342bfc265705840014rbowen<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RemoteIPInternalProxyList <var>filename</var></code></td></tr>
d229f940abfb2490dee17979e9a5ff31b7012eb5rbowen<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
0d0ba3a410038e179b695446bb149cce6264e0abnd<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
7fec19672a491661b2fe4b29f685bc7f4efa64d4nd<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_remoteip</td></tr>
7fec19672a491661b2fe4b29f685bc7f4efa64d4nd <p>The <code class="directive">RemoteIPInternalProxyList</code> directive specifies
0066eddda7203f6345b56f77d146a759298dc635gryzor a file parsed at startup, and builds a list of addresses (or address blocks)
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>Notice:</strong><br />This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_remoteip.html';
if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
d.write('<div id="comments_thread"><\/div>');
var s = d.createElement('script');
s.type = 'text/javascript';
s.async = true;
s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
(d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
<p class="apache">Copyright 2013 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/quickreference.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[//><!--