You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by mi...@apache.org on 2011/12/14 02:36:30 UTC
svn commit: r1214023 - in /httpd/httpd/branches/2.4.x/docs/manual:
developer/new_api_2_4.html.en mod/index.html.en mod/mod_remoteip.html.en
mod/quickreference.html.en
Author: minfrin
Date: Wed Dec 14 01:36:30 2011
New Revision: 1214023
URL: http://svn.apache.org/viewvc?rev=1214023&view=rev
Log:
Update transformations.
Modified:
httpd/httpd/branches/2.4.x/docs/manual/developer/new_api_2_4.html.en
httpd/httpd/branches/2.4.x/docs/manual/mod/index.html.en
httpd/httpd/branches/2.4.x/docs/manual/mod/mod_remoteip.html.en
httpd/httpd/branches/2.4.x/docs/manual/mod/quickreference.html.en
Modified: httpd/httpd/branches/2.4.x/docs/manual/developer/new_api_2_4.html.en
URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/developer/new_api_2_4.html.en?rev=1214023&r1=1214022&r2=1214023&view=diff
==============================================================================
--- httpd/httpd/branches/2.4.x/docs/manual/developer/new_api_2_4.html.en (original)
+++ httpd/httpd/branches/2.4.x/docs/manual/developer/new_api_2_4.html.en Wed Dec 14 01:36:30 2011
@@ -153,9 +153,9 @@
<li>Modules that load other modules later than the EXEC_ON_READ config
reading stage need to call ap_reserve_module_slots() or
ap_reserve_module_slots_directive() in their pre_config hook.</li>
- <li>The client IP address per request can now be specified independently
- of the peer IP address of the connection for the benefit of load
- balancers</li>
+ <li>The useragent IP address per request can now be specified
+ independently of the client IP address of the connection for
+ the benefit of load balancers</li>
</ul>
@@ -459,22 +459,22 @@
<dd>This has been renamed to ap_unixd_config.</dd>
<dt><code>conn_rec->remote_ip and conn_rec->remote_addr</code></dt>
- <dd>In order to distinguish between the peer IP address of the
- connection, and the client IP address of the request potentially
+ <dd>In order to distinguish between the client IP address of the
+ connection, and the useragent IP address of the request potentially
overridden by a load balancer or proxy, the above variables have
been renamed. If a module makes reference to either of the above
variables, they need to be replaced with one of the following two
options as appropriate for the module:
<ul>
- <li>When you require the IP address of the client, which might
- be connected directly to the server, or might optionally be
+ <li>When you require the IP address of the user agent, which
+ might be connected directly to the server, or might optionally be
separated from the server by a transparent load balancer or
- proxy, use request_rec->client_ip and
- request_rec->client_addr.</li>
- <li>When you require the IP address of the peer that is
- connected directly to the server, which might be the client or
+ proxy, use request_rec->useragent_ip and
+ request_rec->useragent_addr.</li>
+ <li>When you require the IP address of the client that is
+ connected directly to the server, which might be the useragent or
might be the load balancer or proxy itself, use
- conn_rec->peer_ip and conn_rec->peer_addr.</li>
+ conn_rec->client_ip and conn_rec->client_addr.</li>
</ul>
</dd>
</dl>
Modified: httpd/httpd/branches/2.4.x/docs/manual/mod/index.html.en
URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/index.html.en?rev=1214023&r1=1214022&r2=1214023&view=diff
==============================================================================
--- httpd/httpd/branches/2.4.x/docs/manual/mod/index.html.en (original)
+++ httpd/httpd/branches/2.4.x/docs/manual/mod/index.html.en Wed Dec 14 01:36:30 2011
@@ -185,8 +185,8 @@ from Clients' networks in a proxy contex
<dt><a href="mod_proxy_scgi.html">mod_proxy_scgi</a></dt><dd>SCGI gateway module for <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code></dd>
<dt><a href="mod_ratelimit.html" id="R" name="R">mod_ratelimit</a></dt><dd>Bandwidth Rate Limiting for Clients</dd>
<dt><a href="mod_reflector.html">mod_reflector</a></dt><dd>Reflect a request body as a response via the output filter stack.</dd>
-<dt><a href="mod_remoteip.html">mod_remoteip</a></dt><dd>Replaces the original peer IP address for the connection
-with the client IP address list presented by a proxies or a load balancer
+<dt><a href="mod_remoteip.html">mod_remoteip</a></dt><dd>Replaces the original client IP address for the connection
+with the useragent IP address list presented by a proxies or a load balancer
via the request headers.
</dd>
<dt><a href="mod_reqtimeout.html">mod_reqtimeout</a></dt><dd>Set timeout and minimum data rate for receiving requests
Modified: httpd/httpd/branches/2.4.x/docs/manual/mod/mod_remoteip.html.en
URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/mod_remoteip.html.en?rev=1214023&r1=1214022&r2=1214023&view=diff
==============================================================================
--- httpd/httpd/branches/2.4.x/docs/manual/mod/mod_remoteip.html.en (original)
+++ httpd/httpd/branches/2.4.x/docs/manual/mod/mod_remoteip.html.en Wed Dec 14 01:36:30 2011
@@ -24,8 +24,8 @@
<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>
-<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Replaces the original peer IP address for the connection
-with the client IP address list presented by a proxies or a load balancer
+<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Replaces the original client IP address for the connection
+with the useragent IP address list presented by a proxies or a load balancer
via the request headers.
</td></tr>
<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
@@ -33,26 +33,27 @@ via the request headers.
<tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_remoteip.c</td></tr></table>
<h3>Summary</h3>
- <p>This module is used to treat the client which initiated the
- request as the originating client as identified by httpd for the
- purposes of authorization and logging, even where that client is
+ <p>This module is used to treat the useragent which initiated the
+ request as the originating useragent as identified by httpd for the
+ purposes of authorization and logging, even where that useragent is
behind a load balancer, front end server, or proxy server.</p>
- <p>The module overrides the peer IP address for the connection
- with the client IP address reported in the request header configured
+ <p>The module overrides the client IP address for the connection
+ with the useragent IP address reported in the request header configured
with the <code class="directive">RemoteIPHeader</code> directive.</p>
- <p>Once replaced as instructed, this overridden client IP address is
+ <p>Once replaced as instructed, this overridden useragent IP address is
then used for the <code class="module"><a href="../mod/mod_authz_host.html">mod_authz_host</a></code>
<code class="directive"><a href="../mod/mod_authz_host.html#require ip"><Require ip></a></code>
feature, is reported by <code class="module"><a href="../mod/mod_status.html">mod_status</a></code>, and is recorded by
<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>
- <code>%a</code> format strings. The underlying peer IP of the connection
+ <code>%a</code> format strings. The underlying client IP of the connection
is available in the <code>%{c}a</code> format string.</p>
<div class="warning">It is critical to only enable this behavior from
intermediate hosts (proxies, etc) which are trusted by this server, since
- it is trivial for the remote client to impersonate another client.</div>
+ it is trivial for the remote useragent to impersonate another
+ useragent.</div>
</div>
<div id="quickview"><h3 class="directives">Directives</h3>
<ul id="toc">
@@ -76,22 +77,22 @@ via the request headers.
<div class="section">
<h2><a name="processing" id="processing">Remote IP Processing</a></h2>
- <p>Apache by default identifies the client with the connection's
- peer_ip value, and the connection remote_host and remote_logname are
+ <p>Apache by default identifies the useragent with the connection's
+ client_ip value, and the connection remote_host and remote_logname are
derived from this value. These fields play a role in authentication,
authorization and logging and other purposes by other loadable
modules.</p>
- <p>mod_remoteip overrides the peer IP of the connection with the
- advertised client IP as provided by a proxy or load balancer, for
+ <p>mod_remoteip overrides the client IP of the connection with the
+ advertised useragent IP as provided by a proxy or load balancer, for
the duration of the request. A load balancer might establish a long
lived keepalive connection with the server, and each request will
- have the correct client IP, even though the underlying peer IP
+ have the correct useragent IP, even though the underlying client IP
address of the load balancer remains unchanged.</p>
- <p>When multiple, comma delimited client IP addresses are listed in the
+ <p>When multiple, comma delimited useragent IP addresses are listed in the
header value, they are processed in Right-to-Left order. Processing
- halts when a given client IP address is not trusted to present the
+ halts when a given useragent IP address is not trusted to present the
preceding IP address. The header field is updated to this remaining
list of unconfirmed IP addresses, or if all IP addresses were trusted,
this header is removed from the request altogether.</p>
@@ -117,7 +118,7 @@ via the request headers.
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="RemoteIPHeader" id="RemoteIPHeader">RemoteIPHeader</a> <a name="remoteipheader" id="remoteipheader">Directive</a></h2>
<table class="directive">
-<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>
+<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>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RemoteIPHeader <var>header-field</var></code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
@@ -125,8 +126,8 @@ via the request headers.
</table>
<p>The <code class="directive">RemoteIPHeader</code> directive triggers
<code class="module"><a href="../mod/mod_remoteip.html">mod_remoteip</a></code> to treat the value of the specified
- <var>header-field</var> header as the client IP address, or list
- of intermediate client IP addresses, subject to further configuration
+ <var>header-field</var> header as the useragent IP address, or list
+ of intermediate useragent IP addresses, subject to further configuration
of the <code class="directive">RemoteIPInternalProxy</code> and
<code class="directive">RemoteIPTrustedProxy</code> directives. Unless these
other directives are used, <code class="module"><a href="../mod/mod_remoteip.html">mod_remoteip</a></code> will trust all
@@ -152,7 +153,7 @@ via the request headers.
</table>
<p>The <code class="directive">RemoteIPInternalProxy</code> directive adds one
or more addresses (or address blocks) to trust as presenting a valid
- RemoteIPHeader value of the client IP. Unlike the
+ RemoteIPHeader value of the useragent IP. Unlike the
<code class="directive">RemoteIPTrustedProxy</code> directive, any IP address
presented in this header, including private intranet addresses, are
trusted when passed from these proxies.</p>
@@ -175,7 +176,7 @@ via the request headers.
</table>
<p>The <code class="directive">RemoteIPInternalProxyList</code> directive specifies
a file parsed at startup, and builds a list of addresses (or address blocks)
- to trust as presenting a valid RemoteIPHeader value of the client IP.</p>
+ to trust as presenting a valid RemoteIPHeader value of the useragent IP.</p>
<p>The '<code>#</code>' hash character designates a comment line, otherwise
each whitespace or newline separated entry is processed identically to
@@ -204,7 +205,7 @@ via the request headers.
</table>
<p>The <code class="directive">RemoteIPProxiesHeader</code> directive specifies
a header into which <code class="module"><a href="../mod/mod_remoteip.html">mod_remoteip</a></code> will collect a list of
- all of the intermediate client IP addresses trusted to resolve the client
+ all of the intermediate client IP addresses trusted to resolve the useragent
IP of the request. Note that intermediate
<code class="directive">RemoteIPTrustedProxy</code> addresses are recorded in
this header, while any intermediate
@@ -227,11 +228,11 @@ via the request headers.
</table>
<p>The <code class="directive">RemoteIPTrustedProxy</code> directive adds one
or more addresses (or address blocks) to trust as presenting a valid
- RemoteIPHeader value of the client IP. Unlike the
+ RemoteIPHeader value of the useragent IP. Unlike the
<code class="directive">RemoteIPInternalProxy</code> directive, any intranet
or private IP address reported by such proxies, including the 10/8, 172.16/12,
192.168/16, 169.254/16 and 127/8 blocks (or outside of the IPv6 public
- 2000::/3 block) are not trusted as the client IP, and are left in the
+ 2000::/3 block) are not trusted as the useragent IP, and are left in the
<code class="directive">RemoteIPHeader</code> header's value.</p>
<div class="example"><h3>Trusted (Load Balancer) Example</h3><p><code>
@@ -252,7 +253,7 @@ via the request headers.
</table>
<p>The <code class="directive">RemoteIPTrustedProxyList</code> directive specifies
a file parsed at startup, and builds a list of addresses (or address blocks)
- to trust as presenting a valid RemoteIPHeader value of the client IP.</p>
+ to trust as presenting a valid RemoteIPHeader value of the useragent IP.</p>
<p>The '<code>#</code>' hash character designates a comment line, otherwise
each whitespace or newline seperated entry is processed identically to
Modified: httpd/httpd/branches/2.4.x/docs/manual/mod/quickreference.html.en
URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/quickreference.html.en?rev=1214023&r1=1214022&r2=1214023&view=diff
==============================================================================
--- httpd/httpd/branches/2.4.x/docs/manual/mod/quickreference.html.en (original)
+++ httpd/httpd/branches/2.4.x/docs/manual/mod/quickreference.html.en Wed Dec 14 01:36:30 2011
@@ -704,7 +704,7 @@ a different URL</td></tr>
<tr class="odd"><td><a href="mod_alias.html#redirecttemp">RedirectTemp <var>URL-path</var> <var>URL</var></a></td><td></td><td>svdh</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Sends an external temporary redirect asking the client to fetch
a different URL</td></tr>
<tr><td><a href="mod_reflector.html#reflectorheader">ReflectorHeader <var>inputheader</var> <var>[outputheader]</var></a></td><td></td><td>svdh</td><td>B</td></tr><tr><td class="descr" colspan="4">Reflect an input header to the output headers</td></tr>
-<tr class="odd"><td><a href="mod_remoteip.html#remoteipheader">RemoteIPHeader <var>header-field</var></a></td><td></td><td>sv</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Declare the header field which should be parsed for client IP addresses</td></tr>
+<tr class="odd"><td><a href="mod_remoteip.html#remoteipheader">RemoteIPHeader <var>header-field</var></a></td><td></td><td>sv</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Declare the header field which should be parsed for useragent IP addresses</td></tr>
<tr><td><a href="mod_remoteip.html#remoteipinternalproxy">RemoteIPInternalProxy <var>proxy-ip</var>|<var>proxy-ip/subnet</var>|<var>hostname</var> ...</a></td><td></td><td>sv</td><td>B</td></tr><tr><td class="descr" colspan="4">Declare client intranet IP addresses trusted to present the RemoteIPHeader value</td></tr>
<tr class="odd"><td><a href="mod_remoteip.html#remoteipinternalproxylist">RemoteIPInternalProxyList <var>filename</var></a></td><td></td><td>sv</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Declare client intranet IP addresses trusted to present the RemoteIPHeader value</td></tr>
<tr><td><a href="mod_remoteip.html#remoteipproxiesheader">RemoteIPProxiesHeader <var>HeaderFieldName</var></a></td><td></td><td>sv</td><td>B</td></tr><tr><td class="descr" colspan="4">Declare the header field which will record all intermediate IP addresses</td></tr>