From e97cbd93e0011a5b4673e22a37f9bd8ac7467f11 Mon Sep 17 00:00:00 2001 From: Graham Leggett Date: Wed, 14 Dec 2011 01:36:30 +0000 Subject: [PATCH] Update transformations. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x@1214023 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/developer/new_api_2_4.html.en | 24 +++++----- docs/manual/mod/index.html.en | 4 +- docs/manual/mod/mod_remoteip.html.en | 53 ++++++++++++----------- docs/manual/mod/quickreference.html.en | 2 +- 4 files changed, 42 insertions(+), 41 deletions(-) diff --git a/docs/manual/developer/new_api_2_4.html.en b/docs/manual/developer/new_api_2_4.html.en index 4f16fc0979..19b778c5ca 100644 --- a/docs/manual/developer/new_api_2_4.html.en +++ b/docs/manual/developer/new_api_2_4.html.en @@ -153,9 +153,9 @@
  • 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.
    • -
  • 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
    • +
  • 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
    • @@ -459,22 +459,22 @@
    This has been renamed to ap_unixd_config.
    conn_rec->remote_ip and conn_rec->remote_addr
    -
    In order to distinguish between the peer IP address of the - connection, and the client IP address of the request potentially +
    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:
    diff --git a/docs/manual/mod/index.html.en b/docs/manual/mod/index.html.en index 57e6066243..a8cd183af2 100644 --- a/docs/manual/mod/index.html.en +++ b/docs/manual/mod/index.html.en @@ -185,8 +185,8 @@ from Clients' networks in a proxy context.
    mod_proxy_scgi
    SCGI gateway module for mod_proxy
    mod_ratelimit
    Bandwidth Rate Limiting for Clients
    mod_reflector
    Reflect a request body as a response via the output filter stack.
    -
    mod_remoteip
    Replaces the original peer IP address for the connection -with the client IP address list presented by a proxies or a load balancer +
    mod_remoteip
    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.
    mod_reqtimeout
    Set timeout and minimum data rate for receiving requests diff --git a/docs/manual/mod/mod_remoteip.html.en b/docs/manual/mod/mod_remoteip.html.en index 773ecc01c2..5998a5213e 100644 --- a/docs/manual/mod/mod_remoteip.html.en +++ b/docs/manual/mod/mod_remoteip.html.en @@ -24,8 +24,8 @@

    Available Languages:  en  |  fr 

    -
    Description:Replaces the original peer IP address for the connection -with the client IP address list presented by a proxies or a load balancer + @@ -33,26 +33,27 @@ via the request headers.
    Description: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.
    Status:Base
    Source File:mod_remoteip.c

    Summary

    -

    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 +

    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.

    -

    The module overrides the peer IP address for the connection - with the client IP address reported in the request header configured +

    The module overrides the client IP address for the connection + with the useragent IP address reported in the request header configured with the RemoteIPHeader directive.

    -

    Once replaced as instructed, this overridden client IP address is +

    Once replaced as instructed, this overridden useragent IP address is then used for the mod_authz_host <Require ip> feature, is reported by mod_status, and is recorded by mod_log_config %a and core - %a format strings. The underlying peer IP of the connection + %a format strings. The underlying client IP of the connection is available in the %{c}a format string.

    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.
    + it is trivial for the remote useragent to impersonate another + useragent.

    Directives

      @@ -76,22 +77,22 @@ via the request headers.

      Remote IP Processing

      -

      Apache by default identifies the client with the connection's - peer_ip value, and the connection remote_host and remote_logname are +

      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.

      -

      mod_remoteip overrides the peer IP of the connection with the - advertised client IP as provided by a proxy or load balancer, for +

      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.

      -

      When multiple, comma delimited client IP addresses are listed in the +

      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.

      @@ -117,7 +118,7 @@ via the request headers.
      top

      RemoteIPHeader Directive

      - + @@ -125,8 +126,8 @@ via the request headers.
      Description:Declare the header field which should be parsed for client IP addresses
      Description:Declare the header field which should be parsed for useragent IP addresses
      Syntax:RemoteIPHeader header-field
      Context:server config, virtual host
      Status:Base

      The RemoteIPHeader directive triggers mod_remoteip to treat the value of the specified - header-field header as the client IP address, or list - of intermediate client IP addresses, subject to further configuration + header-field header as the useragent IP address, or list + of intermediate useragent IP addresses, subject to further configuration of the RemoteIPInternalProxy and RemoteIPTrustedProxy directives. Unless these other directives are used, mod_remoteip will trust all @@ -152,7 +153,7 @@ via the request headers.

    The RemoteIPInternalProxy 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 RemoteIPTrustedProxy directive, any IP address presented in this header, including private intranet addresses, are trusted when passed from these proxies.

    @@ -175,7 +176,7 @@ via the request headers.

    The RemoteIPInternalProxyList 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.

    + to trust as presenting a valid RemoteIPHeader value of the useragent IP.

    The '#' 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.

    The RemoteIPProxiesHeader directive specifies a header into which mod_remoteip 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 RemoteIPTrustedProxy addresses are recorded in this header, while any intermediate @@ -227,11 +228,11 @@ via the request headers.

    The RemoteIPTrustedProxy 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 RemoteIPInternalProxy 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 RemoteIPHeader header's value.

    Trusted (Load Balancer) Example

    @@ -252,7 +253,7 @@ via the request headers.

    The RemoteIPTrustedProxyList 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.

    + to trust as presenting a valid RemoteIPHeader value of the useragent IP.

    The '#' hash character designates a comment line, otherwise each whitespace or newline seperated entry is processed identically to diff --git a/docs/manual/mod/quickreference.html.en b/docs/manual/mod/quickreference.html.en index 1ba7a0575f..4e41354ec3 100644 --- a/docs/manual/mod/quickreference.html.en +++ b/docs/manual/mod/quickreference.html.en @@ -704,7 +704,7 @@ a different URL RedirectTemp URL-path URLsvdhBSends an external temporary redirect asking the client to fetch a different URL ReflectorHeader inputheader [outputheader]svdhBReflect an input header to the output headers -RemoteIPHeader header-fieldsvBDeclare the header field which should be parsed for client IP addresses +RemoteIPHeader header-fieldsvBDeclare the header field which should be parsed for useragent IP addresses RemoteIPInternalProxy proxy-ip|proxy-ip/subnet|hostname ...svBDeclare client intranet IP addresses trusted to present the RemoteIPHeader value RemoteIPInternalProxyList filenamesvBDeclare client intranet IP addresses trusted to present the RemoteIPHeader value RemoteIPProxiesHeader HeaderFieldNamesvBDeclare the header field which will record all intermediate IP addresses -- 2.40.0