mod_remoteip.html.en revision 59877c2b4bb77f563370d7fb238f4a6d7a0e7f44
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" />
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen<link href="/style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen<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="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p>
d229f940abfb2490dee17979e9a5ff31b7012eb5rbowen<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>
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>
b43f840409794ed298e8634f6284741f193b6c4ftakashi<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Replaces the original peer IP address for the connection
11495c9f0bd33e51a25b4d532beadfbcf9b944a3nilgunwith the client 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>
b43f840409794ed298e8634f6284741f193b6c4ftakashi<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>remoteip_module</td></tr>
b43f840409794ed298e8634f6284741f193b6c4ftakashi<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 client which initiated the
6ae232055d4d8a97267517c5e50074c2c819941and request as the originating client as identified by httpd for the
6ae232055d4d8a97267517c5e50074c2c819941and purposes of authorization and logging, even where that client is
6ae232055d4d8a97267517c5e50074c2c819941and behind a load balancer, front end server, or proxy server.</p>
6ae232055d4d8a97267517c5e50074c2c819941and <p>The module overrides the peer IP address for the connection
6ae232055d4d8a97267517c5e50074c2c819941and with the client 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 client 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 peer 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 client to impersonate another client.</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<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 client with the connection's
6ae232055d4d8a97267517c5e50074c2c819941and peer_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 peer IP of the connection with the
6ae232055d4d8a97267517c5e50074c2c819941and advertised client 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 client IP, even though the underlying peer IP
6ae232055d4d8a97267517c5e50074c2c819941and address of the load balancer remains unchanged.</p>
6ae232055d4d8a97267517c5e50074c2c819941and <p>When multiple, comma delimited client IP addresses are listed in the
6ae232055d4d8a97267517c5e50074c2c819941and header value, they are processed in Right-to-Left order. Processing
6ae232055d4d8a97267517c5e50074c2c819941and halts when a given client 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 client 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 client IP address, or list
6ae232055d4d8a97267517c5e50074c2c819941and of intermediate client 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
6ae232055d4d8a97267517c5e50074c2c819941and hosts presenting a <code class="directive">RemoteIPHeader</code> IP value.</p>
6ae232055d4d8a97267517c5e50074c2c819941and <div class="example"><h3>Internal (Load Balancer) Example</h3><p><code>
6ae232055d4d8a97267517c5e50074c2c819941and RemoteIPHeader X-Client-IP
6ae232055d4d8a97267517c5e50074c2c819941and RemoteIPHeader X-Forwarded-For
b43f840409794ed298e8634f6284741f193b6c4ftakashi<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
11495c9f0bd33e51a25b4d532beadfbcf9b944a3nilgun<div class="directive-section"><h2><a name="RemoteIPInternalProxy" id="RemoteIPInternalProxy">RemoteIPInternalProxy</a> <a name="remoteipinternalproxy" id="remoteipinternalproxy">Directive</a></h2>
f086b4b402fa9a2fefc7dda85de2a3cc1cd0a654rjung<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>
727872d18412fc021f03969b8641810d8896820bhumbedooh<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>
0d0ba3a410038e179b695446bb149cce6264e0abnd<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
727872d18412fc021f03969b8641810d8896820bhumbedooh<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
727872d18412fc021f03969b8641810d8896820bhumbedooh<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_remoteip</td></tr>
727872d18412fc021f03969b8641810d8896820bhumbedooh <p>The <code class="directive">RemoteIPInternalProxy</code> directive adds one
888cb40bdeec5abf452bd85d6bf63b26d5913d4chumbedooh or more addresses (or address blocks) to trust as presenting a valid
727872d18412fc021f03969b8641810d8896820bhumbedooh RemoteIPHeader value of the client IP. Unlike the
0d0ba3a410038e179b695446bb149cce6264e0abnd <code class="directive">RemoteIPTrustedProxy</code> directive, any IP address
0d0ba3a410038e179b695446bb149cce6264e0abnd presented in this header, including private intranet addresses, are
0d0ba3a410038e179b695446bb149cce6264e0abnd trusted when passed from these proxies.</p>
0d0ba3a410038e179b695446bb149cce6264e0abnd <div class="example"><h3>Internal (Load Balancer) Example</h3><p><code>
0d0ba3a410038e179b695446bb149cce6264e0abnd RemoteIPHeader X-Client-IP<br />
727872d18412fc021f03969b8641810d8896820bhumbedooh RemoteIPTrustedProxy gateway.localdomain
b43f840409794ed298e8634f6284741f193b6c4ftakashi<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
d229f940abfb2490dee17979e9a5ff31b7012eb5rbowen<div class="directive-section"><h2><a name="RemoteIPInternalProxyList" id="RemoteIPInternalProxyList">RemoteIPInternalProxyList</a> <a name="remoteipinternalproxylist" id="remoteipinternalproxylist">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>
7fec19672a491661b2fe4b29f685bc7f4efa64d4nd<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RemoteIPInternalProxyList <var>filename</var></code></td></tr>
7fec19672a491661b2fe4b29f685bc7f4efa64d4nd<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>
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 2011 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="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div>