x-real-ip 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b561d1e4fa4fdd9c722ece5e7ce58558e58eb2b9
+  data.tar.gz: 637b074b29879b157c8e01ac4faf57378a5b3639
+SHA512:
+  metadata.gz: a2827351dd92c5d2c1207d3f8ab30a13d20c1bdb7347315e2215c92f4f948c013c5e2f080eb13b8ddef492d5fb384062709b370ad2079700bfbfe0b04d249f52
+  data.tar.gz: 3789046ff9da42656a33f4195beacd21d3c72acee0396f73ee370cb27a793d931bf13a0e37fd088e413d045d0a85dff2ecc062cf84c978a704ce65290baa0256

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-gemset

@@ -0,0 +1 @@
+x-real-ip

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p353

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in x-real-ip.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 glebtv
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# X::Real::Ip
+
+Replace REMOTE_IP with X-Real-Ip if it's trusted (useful for Nginx)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'x-real-ip'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install x-real-ip
+
+## Usage
+
+For rails just add it to Gemfile
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/x-real-ip.rb

@@ -0,0 +1,20 @@
+require "x-real-ip/version"
+require "rpatricia"
+require "ipaddr"
+require "active_support/core_ext/module/attribute_accessors"
+
+module XRealIp
+  mattr_accessor :trusted4, :trusted6
+  self.trusted4 = Patricia.new()
+  %w(10.0.0.0/8 172.16.0.0/12 192.168.0.0/16 127.0.0.0/8).each do |a|
+    self.trusted4.add(a)
+  end
+  self.trusted6 = Patricia.new(:AF_INET6)
+  %w(::1/128).each do |a|
+    self.trusted6.add(a)
+  end
+end
+
+require "x-real-ip/railtie" if defined? Rails
+
+require "x-real-ip/middleware"

data/lib/x-real-ip/middleware.rb

@@ -0,0 +1,53 @@
+module XRealIp
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def is_trusted?(str)
+      ip = IPAddr.new(str)
+      if ip.ipv4?
+        XRealIp.trusted4.include?(ip.to_s)
+      else
+        XRealIp.trusted6.include?(ip.to_s)
+      end
+    end
+    
+    def call(env)
+      real_ips  = env["HTTP_X_REAL_IP"]
+      if real_ips
+        begin
+          proxies = []
+          list = real_ips.split(',')
+          return @app.call(env) if list.empty?
+          list.push env["REMOTE_ADDR"]
+          while tmp = list.pop
+            addr = tmp
+            if is_trusted?(tmp)
+              proxies.push tmp
+            else
+              break
+            end
+          end
+          
+          if addr
+            env["x.proxies"] = proxies.join(',')
+            env["REMOTE_ADDR"] = addr
+            proto = env["HTTP_X_FORWARDED_PROTO"] || env['HTTP_X_REAL_PROTO']
+            if (proto && proto == 'https')
+              env["rack.url_scheme"] = 'https'
+            end
+          end
+
+          @app.call(env)
+        rescue => e
+          $stderr.puts "Error in x-real-ip: #{$!}"
+          $stderr.puts "Backtrace:\n\t#{e.backtrace.join("\n\t")}"
+          @app.call(env)
+        end
+      else
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/x-real-ip/railtie.rb

@@ -0,0 +1,7 @@
+module XRealIp
+  class Railtie < Rails::Railtie
+    initializer "railtie.configure_rails_initialization" do |app|
+      app.config.middleware.use XRealIp::Middleware
+    end
+  end
+end

data/lib/x-real-ip/version.rb

@@ -0,0 +1,3 @@
+module XRealIp
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+# coding: utf-8
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require 'rack'
+require 'x-real-ip'
+
+SUPPORT = File.join(File.dirname(__FILE__), "support")
+Dir["#{SUPPORT}/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+
+end

data/spec/x_real_ip_spec.rb

@@ -0,0 +1,168 @@
+# coding: utf-8
+require 'spec_helper'
+
+describe XRealIp do
+  before :each do
+    app = lambda { |env| @env = env; [ 200, {}, [] ] }
+    @req = Rack::MockRequest.new(XRealIp::Middleware.new(app))
+  end
+
+  context 'no proxy' do
+    context 'local ip' do
+      context 'http' do
+        before :each do
+          env = {
+            "REMOTE_ADDR" => "127.0.0.1",
+          }
+          @resp = @req.get("http://example.com/", env)
+        end
+        it 'sets ip' do
+          @env["REMOTE_ADDR"].should eq '127.0.0.1'
+        end
+        it 'sets proxy ip' do
+          @env["x.proxies"].should be_nil
+        end
+        it 'keeps http' do
+          @env["rack.url_scheme"].should eq 'http'
+        end
+      end
+      context 'https' do
+        before :each do
+          env = {
+            "HTTP_X_FORWARDED_PROTO" => "https",
+            "REMOTE_ADDR" => "127.0.0.1",
+          }
+          @resp = @req.get("http://test.com/", env)
+        end
+        it 'sets ip' do
+          @env["REMOTE_ADDR"].should eq '127.0.0.1'
+        end
+        it 'sets proxy ip' do
+          @env["x.proxies"].should be_nil
+        end
+        it 'keeps http' do
+          @env["rack.url_scheme"].should eq 'http'
+        end
+      end
+    end
+  end
+
+  context 'one proxy' do
+    context 'local ip' do
+      context 'http' do
+        before :each do
+          env = {
+            "HTTP_X_REAL_IP" => "1.1.1.1",
+            "REMOTE_ADDR" => "127.0.0.1",
+          }
+          @resp = @req.get("http://test.com/", env)
+        end
+        it 'sets ip' do
+          @env["REMOTE_ADDR"].should eq '1.1.1.1'
+        end
+        it 'sets proxy ip' do
+          @env["x.proxies"].should eq '127.0.0.1'
+        end
+        it 'keeps http' do
+          @env["rack.url_scheme"].should eq 'http'
+        end
+      end
+      context 'https' do
+        before :each do
+          env = {
+            "HTTP_X_REAL_IP" => "1.1.1.1",
+            "HTTP_X_FORWARDED_PROTO" => "https",
+            "REMOTE_ADDR" => "127.0.0.1",
+          }
+          @resp = @req.get("http://test.com/", env)
+        end
+        it 'sets ip' do
+          @env["REMOTE_ADDR"].should eq '1.1.1.1'
+        end
+        it 'sets proxy ip' do
+          @env["x.proxies"].should eq '127.0.0.1'
+        end
+        it 'sets url scheme to https' do
+          @env["rack.url_scheme"].should eq 'https'
+        end
+      end
+    end
+  end
+
+  context '2 proxies' do
+    context 'http' do
+      before :each do
+        env = {
+          "HTTP_X_REAL_IP" => "1.1.1.1,10.0.0.1",
+          "REMOTE_ADDR" => "127.0.0.1",
+        }
+        @resp = @req.get("http://test.com/", env)
+      end
+      it 'sets ip' do
+        @env["REMOTE_ADDR"].should eq '1.1.1.1'
+      end
+      it 'sets proxy ip' do
+        @env["x.proxies"].should eq '127.0.0.1,10.0.0.1'
+      end
+      it 'keeps http' do
+        @env["rack.url_scheme"].should eq 'http'
+      end
+    end
+    context 'https' do
+      before :each do
+        env = {
+          "HTTP_X_REAL_IP" => "1.1.1.1,10.0.0.1",
+          "HTTP_X_FORWARDED_PROTO" => "https",
+          "REMOTE_ADDR" => "127.0.0.1",
+        }
+        @resp = @req.get("http://test.com/", env)
+      end
+      it 'sets ip' do
+        @env["REMOTE_ADDR"].should eq '1.1.1.1'
+      end
+      it 'sets proxy ip' do
+        @env["x.proxies"].should eq '127.0.0.1,10.0.0.1'
+      end
+      it 'sets url scheme to https' do
+        @env["rack.url_scheme"].should eq 'https'
+      end
+    end
+  end
+
+  context 'spoofed' do
+    context 'one' do
+      before :each do
+        env = {
+          "HTTP_X_REAL_IP" => "1.1.1.1,2.2.2.2",
+          "REMOTE_ADDR" => "3.3.3.3",
+        }
+        @resp = @req.get("http://test.com/", env)
+      end
+      it 'sets ip' do
+        @env["REMOTE_ADDR"].should eq '3.3.3.3'
+      end
+      it 'doesnt st proxy ip' do
+        @env["x.proxies"].should eq ''
+      end
+    end
+    context 'chain' do
+      before :each do
+        env = {
+          "HTTP_X_REAL_IP" => "1.1.1.1,2.2.2.2",
+          "REMOTE_ADDR" => "127.0.0.1",
+        }
+        @resp = @req.get("http://test.com/", env)
+      end
+      it 'sets ip' do
+        @env["REMOTE_ADDR"].should eq '2.2.2.2'
+      end
+      it 'sets proxy ip' do
+        @env["x.proxies"].should eq '127.0.0.1'
+      end
+      it 'keeps http' do
+        @env["rack.url_scheme"].should eq 'http'
+      end
+    end
+  end
+
+end

data/x-real-ip.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'x-real-ip/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "x-real-ip"
+  spec.version       = XRealIp::VERSION
+  spec.authors       = ["55ideas"]
+  spec.email         = ["info@55ideas.ru"]
+  spec.description   = %q{Replace REMOTE_IP with X-Real-Ip if it's trusted (useful for Nginx)}
+  spec.summary       = %q{Replace REMOTE_IP with X-Real-Ip if it's trusted (useful for Nginx)}
+  spec.homepage      = "https://github.com/55ideas/x-real-ip"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  
+  spec.add_dependency "rpatricia", "~> 1.0"
+  spec.add_dependency "rack"
+  spec.add_dependency "activesupport"
+  
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: x-real-ip
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- 55ideas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rpatricia
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Replace REMOTE_IP with X-Real-Ip if it's trusted (useful for Nginx)
+email:
+- info@55ideas.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/x-real-ip.rb
+- lib/x-real-ip/middleware.rb
+- lib/x-real-ip/railtie.rb
+- lib/x-real-ip/version.rb
+- spec/spec_helper.rb
+- spec/x_real_ip_spec.rb
+- x-real-ip.gemspec
+homepage: https://github.com/55ideas/x-real-ip
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Replace REMOTE_IP with X-Real-Ip if it's trusted (useful for Nginx)
+test_files:
+- spec/spec_helper.rb
+- spec/x_real_ip_spec.rb