class ActionDispatch::RemoteIp - actionpack-4.2.4 Documentation

# class ActionDispatch::RemoteIp

This middleware calculates the IP address of the remote client that is making the request. It does this by checking various headers that could contain the address, and then picking the last-set address that is not on the list of trusted IPs. This follows the precedent set by e.g. the Tomcat server, with reasoning explained at length by @gingerlime. A more detailed explanation of the algorithm is given at ActionDispatch::RemoteIp::GetIp#calculate_ip.

Some Rack servers concatenate repeated headers, like HTTP RFC 2616 requires. Some Rack servers simply drop preceding headers, and only report the value that was given in the last header. If you are behind multiple proxy servers (like NGINX to HAProxy to Unicorn) then you should test your Rack server to make sure your data is good.

IF YOU DON'T USE A PROXY, THIS MAKES YOU VULNERABLE TO IP SPOOFING. This middleware assumes that there is at least one proxy sitting around and setting headers with the client's remote IP address. If you don't use a proxy, because you are hosted on e.g. Heroku without SSL, any client can claim to have any IP address by setting the X-Forwarded-For header. If you care about that, then you need to explicitly drop or ignore those headers sometime before this middleware runs.

### Constants

TRUSTED_PROXIES

  The default trusted IPs list simply includes IP addresses that are guaranteed by the IP specification to be private addresses. Those will not be the ultimate client IP in production, and so are discarded. See en.wikipedia.org/wiki/Private_network for details.

### Attributes

check_ip[R]
proxies[R]

### Public Class Methods

new(app, check_ip_spoofing = true, custom_proxies = nil) click to toggle source

Create a new `RemoteIp` middleware instance.

The `check_ip_spoofing` option is on by default. When on, an exception is raised if it looks like the client is trying to lie about its own IP address. It makes sense to turn off this check on sites aimed at non-IP clients (like WAP devices), or behind proxies that set headers in an incorrect or confusing way (like AWS ELB).

The `custom_proxies` argument can take an Array of string, IPAddr, or Regexp objects which will be used instead of `TRUSTED_PROXIES`. If a single string, IPAddr, or Regexp object is provided, it will be used in addition to `TRUSTED_PROXIES`. Any proxy setup will put the value you want in the middle (or at the beginning) of the X-Forwarded-For list, with your proxy servers after it. If your proxies aren't removed, pass them in via the `custom_proxies` parameter. That way, the middleware will ignore those IP addresses, and return the one that you want.

    # File lib/action_dispatch/middleware/remote_ip.rb, line 60
    def initialize(app, check_ip_spoofing = true, custom_proxies = nil)
      @app = app
      @check_ip = check_ip_spoofing
      @proxies = if custom_proxies.blank?
        TRUSTED_PROXIES
      elsif custom_proxies.respond_to?(:any?)
        custom_proxies
      else
        Array(custom_proxies) + TRUSTED_PROXIES
      end
    end

### Public Instance Methods

call(env) click to toggle source

Since the IP address may not be needed, we store the object here without calculating the IP to keep from slowing down the majority of requests. For those requests that do need to know the IP, the ActionDispatch::RemoteIp::GetIp#calculate_ip method will calculate the memoized client IP address.

    # File lib/action_dispatch/middleware/remote_ip.rb, line 76
    def call(env)
      env["action_dispatch.remote_ip"] = GetIp.new(env, self)
      @app.call(env)
    end