mod_remoteip.html.en revision 53c8c4e968f092ac29976710db5829444e4c11fa
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
a78048ccbdb6256da15e6b0e7e95355e480c2301nd XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
a78048ccbdb6256da15e6b0e7e95355e480c2301nd This file is generated from xml source: DO NOT EDIT
a78048ccbdb6256da15e6b0e7e95355e480c2301nd XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<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" />
2e545ce2450a9953665f701bb05350f0d3f26275nd<script src="/style/scripts/prettify.js" type="text/javascript">
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<link href="/images/favicon.ico" rel="shortcut icon" /></head>
af33a4994ae2ff15bc67d19ff1a7feb906745bf8rbowen<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>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<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>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<p><span>Available Languages: </span><a href="/en/mod/mod_remoteip.html" title="English"> en </a> |
053bfa8a288528fafab2b7a032c15116bb5de711nd<a href="/fr/mod/mod_remoteip.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a></p>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Replaces the original client IP address for the connection
4b575a6b6704b516f22d65a3ad35696d7b9ba372rpluemwith the useragent IP address list presented by a proxies or a load balancer
4b575a6b6704b516f22d65a3ad35696d7b9ba372rpluemvia the request headers.
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>remoteip_module</td></tr>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_remoteip.c</td></tr></table>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <p>This module is used to treat the useragent which initiated the
a78048ccbdb6256da15e6b0e7e95355e480c2301nd request as the originating useragent as identified by httpd for the
a78048ccbdb6256da15e6b0e7e95355e480c2301nd purposes of authorization and logging, even where that useragent is
a78048ccbdb6256da15e6b0e7e95355e480c2301nd behind a load balancer, front end server, or proxy server.</p>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <p>The module overrides the client IP address for the connection
a78048ccbdb6256da15e6b0e7e95355e480c2301nd with the useragent IP address reported in the request header configured
a78048ccbdb6256da15e6b0e7e95355e480c2301nd with the <code class="directive">RemoteIPHeader</code> directive.</p>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <p>Once replaced as instructed, this overridden useragent IP address is
a78048ccbdb6256da15e6b0e7e95355e480c2301nd then used for the <code class="module"><a href="/mod/mod_authz_host.html">mod_authz_host</a></code>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <code class="directive"><a href="/mod/mod_authz_host.html#require ip"><Require ip></a></code>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd feature, is reported by <code class="module"><a href="/mod/mod_status.html">mod_status</a></code>, and is recorded by
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <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>
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh <code>%a</code> format strings. The underlying client IP of the connection
a78048ccbdb6256da15e6b0e7e95355e480c2301nd is available in the <code>%{c}a</code> format string.</p>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <div class="warning">It is critical to only enable this behavior from
a78048ccbdb6256da15e6b0e7e95355e480c2301nd intermediate hosts (proxies, etc) which are trusted by this server, since
a78048ccbdb6256da15e6b0e7e95355e480c2301nd it is trivial for the remote useragent to impersonate another
a78048ccbdb6256da15e6b0e7e95355e480c2301nd useragent.</div>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<div id="quickview"><h3 class="directives">Directives</h3>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<li><img alt="" src="/images/down.gif" /> <a href="#remoteipheader">RemoteIPHeader</a></li>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<li><img alt="" src="/images/down.gif" /> <a href="#remoteipinternalproxy">RemoteIPInternalProxy</a></li>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<li><img alt="" src="/images/down.gif" /> <a href="#remoteipinternalproxylist">RemoteIPInternalProxyList</a></li>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<li><img alt="" src="/images/down.gif" /> <a href="#remoteipproxiesheader">RemoteIPProxiesHeader</a></li>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<li><img alt="" src="/images/down.gif" /> <a href="#remoteiptrustedproxy">RemoteIPTrustedProxy</a></li>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<li><img alt="" src="/images/down.gif" /> <a href="#remoteiptrustedproxylist">RemoteIPTrustedProxyList</a></li>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<li><img alt="" src="/images/down.gif" /> <a href="#processing">Remote IP Processing</a></li>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<li><code class="module"><a href="/mod/mod_authz_host.html">mod_authz_host</a></code></li>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<li><code class="module"><a href="/mod/mod_status.html">mod_status</a></code></li>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<li><code class="module"><a href="/mod/mod_log_config.html">mod_log_config</a></code></li>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<h2><a name="processing" id="processing">Remote IP Processing</a></h2>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <p>Apache by default identifies the useragent with the connection's
a78048ccbdb6256da15e6b0e7e95355e480c2301nd client_ip value, and the connection remote_host and remote_logname are
a78048ccbdb6256da15e6b0e7e95355e480c2301nd derived from this value. These fields play a role in authentication,
a78048ccbdb6256da15e6b0e7e95355e480c2301nd authorization and logging and other purposes by other loadable
a78048ccbdb6256da15e6b0e7e95355e480c2301nd modules.</p>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <p>mod_remoteip overrides the client IP of the connection with the
a78048ccbdb6256da15e6b0e7e95355e480c2301nd advertised useragent IP as provided by a proxy or load balancer, for
a78048ccbdb6256da15e6b0e7e95355e480c2301nd the duration of the request. A load balancer might establish a long
a78048ccbdb6256da15e6b0e7e95355e480c2301nd lived keepalive connection with the server, and each request will
a78048ccbdb6256da15e6b0e7e95355e480c2301nd have the correct useragent IP, even though the underlying client IP
a78048ccbdb6256da15e6b0e7e95355e480c2301nd address of the load balancer remains unchanged.</p>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <p>When multiple, comma delimited useragent IP addresses are listed in the
a78048ccbdb6256da15e6b0e7e95355e480c2301nd header value, they are processed in Right-to-Left order. Processing
a78048ccbdb6256da15e6b0e7e95355e480c2301nd halts when a given useragent IP address is not trusted to present the
a78048ccbdb6256da15e6b0e7e95355e480c2301nd preceding IP address. The header field is updated to this remaining
a78048ccbdb6256da15e6b0e7e95355e480c2301nd list of unconfirmed IP addresses, or if all IP addresses were trusted,
a78048ccbdb6256da15e6b0e7e95355e480c2301nd this header is removed from the request altogether.</p>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <p>In overriding the client IP, the module stores the list of intermediate
a78048ccbdb6256da15e6b0e7e95355e480c2301nd hosts in a remoteip-proxy-ip-list note, which <code class="module"><a href="/mod/mod_log_config.html">mod_log_config</a></code>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd can record using the <code>%{remoteip-proxy-ip-list}n</code> format token.
a78048ccbdb6256da15e6b0e7e95355e480c2301nd If the administrator needs to store this as an additional header, this
a78048ccbdb6256da15e6b0e7e95355e480c2301nd same value can also be recording as a header using the directive
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <code class="directive">RemoteIPProxiesHeader</code>.</p>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <div class="note"><h3>IPv4-over-IPv6 Mapped Addresses</h3>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd As with httpd in general, any IPv4-over-IPv6 mapped addresses are recorded
a78048ccbdb6256da15e6b0e7e95355e480c2301nd in their IPv4 representation.</div>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd All internal addresses 10/8, 172.16/12, 192.168/16, 169.254/16 and 127/8
a78048ccbdb6256da15e6b0e7e95355e480c2301nd blocks (and IPv6 addresses outside of the public 2000::/3 block) are only
a78048ccbdb6256da15e6b0e7e95355e480c2301nd evaluated by mod_remoteip when <code class="directive">RemoteIPInternalProxy</code>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd internal (intranet) proxies are registered.</div>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<div class="directive-section"><h2><a name="RemoteIPHeader" id="RemoteIPHeader">RemoteIPHeader</a> <a name="remoteipheader" id="remoteipheader">Directive</a></h2>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<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>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RemoteIPHeader <var>header-field</var></code></td></tr>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
053bfa8a288528fafab2b7a032c15116bb5de711nd<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_remoteip</td></tr>
727872d18412fc021f03969b8641810d8896820bhumbedooh <p>The <code class="directive">RemoteIPHeader</code> directive triggers
0d0ba3a410038e179b695446bb149cce6264e0abnd <code class="module"><a href="/mod/mod_remoteip.html">mod_remoteip</a></code> to treat the value of the specified
727872d18412fc021f03969b8641810d8896820bhumbedooh <var>header-field</var> header as the useragent IP address, or list
cc7e1025de9ac63bd4db6fe7f71c158b2cf09fe4humbedooh of intermediate useragent IP addresses, subject to further configuration
0d0ba3a410038e179b695446bb149cce6264e0abnd of the <code class="directive">RemoteIPInternalProxy</code> and
cc7e1025de9ac63bd4db6fe7f71c158b2cf09fe4humbedooh <code class="directive">RemoteIPTrustedProxy</code> directives. Unless these
727872d18412fc021f03969b8641810d8896820bhumbedooh other directives are used, <code class="module"><a href="/mod/mod_remoteip.html">mod_remoteip</a></code> will trust all
0d0ba3a410038e179b695446bb149cce6264e0abnd hosts presenting a <code class="directive">RemoteIPHeader</code> IP value.</p>
0d0ba3a410038e179b695446bb149cce6264e0abnd <div class="example"><h3>Internal (Load Balancer) Example</h3><pre class="prettyprint lang-config">
ac082aefa89416cbdc9a1836eaf3bed9698201c8humbedooh RemoteIPHeader X-Client-IP
727872d18412fc021f03969b8641810d8896820bhumbedooh <div class="example"><h3>Proxy Example</h3><pre class="prettyprint lang-config">
0d0ba3a410038e179b695446bb149cce6264e0abnd RemoteIPHeader X-Forwarded-For
0d0ba3a410038e179b695446bb149cce6264e0abnd<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
7fec19672a491661b2fe4b29f685bc7f4efa64d4nd<div class="directive-section"><h2><a name="RemoteIPInternalProxy" id="RemoteIPInternalProxy">RemoteIPInternalProxy</a> <a name="remoteipinternalproxy" id="remoteipinternalproxy">Directive</a></h2>
7fec19672a491661b2fe4b29f685bc7f4efa64d4nd<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>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<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>
<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[//><!--