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