rack-ip-authorizer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 993db83818bbc2e86eea1a34d2e7cc95df985c54
+  data.tar.gz: f2fc88991a8a11152171af536ec2ec4c29b35912
+SHA512:
+  metadata.gz: 45726c05a235d93659029324833ecac8bbc5fffdf8ee66e9a6c7525e06c28fd724cc1fba81cb61d2e2dde7bb2dfbecff1586752561f6717108160554630b04cb
+  data.tar.gz: bcc60a36e4e451cbf53fcaf54f28bad1f27ab47dbe799cc06b5c48df9b3935e6d096568f45b1a7a1a3ec15a97ee32521baee8647226e1197388c6e3a52739a1a

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 telzamek
+
+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,50 @@
+# Rack::Ip::Authorizer
+
+Basic Rack middleware for checking Rails3 request remote IP
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-ip-authorizer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-ip-authorizer
+
+## Usage
+
+### Rails 3 apps
+
+1. Create a file named "ip_authorizations.yml" in the config directory
+2. Fill it with key as path and values as IPs:
+
+```yaml
+admin:
+    - 192.168.0.1
+    - 192.168.0.2
+    - 192.168.0.3
+superadmin:
+    - 192.168.0.1
+    - 192.168.0.2
+```
+
+Environment filter
+
+Create an initializer and fill it with:
+
+```ruby
+Rack::IpAuthorizer.env_to_check = ['staging','development']
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch
+3. Commit your changes
+4. Push to the branch
+5. Create new Pull Request

data/lib/rack-ip-authorizer.rb

@@ -0,0 +1,21 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), 'rack/ip_authorizer')
+require 'yaml'
+
+if defined? Rails
+  case Rails::VERSION::MAJOR
+    when 3
+      path = File.join(File.expand_path('config'), '/ip_authorizations.yml')
+
+      if File.exists?(path)
+        ip_authorizations_by_path = YAML.load_file(path)
+      else
+        raise "config/ip_authorizations.yml is missing"
+      end
+
+      class Rack::IpAuthorizer::Railtie < Rails::Railtie
+        initializer('rack-ip-authorizer.append') { |app|
+          app.config.middleware.insert_after(ActionDispatch::RemoteIp, Rack::IpAuthorizer, ip_authorizations_by_path)
+        }
+      end
+  end
+end

data/lib/rack/ip_authorizer.rb

@@ -0,0 +1,39 @@
+require "rack/version"
+
+module Rack
+  class IpAuthorizer
+    @env_to_check = ["production"]
+    class << self
+      attr_accessor :env_to_check
+    end
+
+    def initialize(app, ip_authorizations_by_path)
+      @app, @ip_authorizations_by_path = app, ip_authorizations_by_path
+    end
+
+    def call(env)
+      if Rack::IpAuthorizer.env_to_check.include? Rails.env
+        req = Rack::Request.new(env)
+
+        @ip_authorizations_by_path.each do |protected_url, authorized_ips|
+          if req.path.start_with?("/#{protected_url}") && !authorized_ips.include?(req.env['REMOTE_ADDR'])
+            return forbidden
+          end
+        end
+      end
+
+      @app.call(env)
+    end
+
+    private
+
+    def forbidden
+      [403,
+       {'Content-Type' => 'text/plain',
+        'Content-Length' => '0'},
+       []
+      ]
+    end
+
+  end
+end

data/lib/rack/version.rb

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

data/spec/rake_ip_authorizer_spec.rb

@@ -0,0 +1,52 @@
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'rack/test'
+require 'minitest/autorun'
+require 'rack/ip_authorizer'
+
+class Rails
+  def self.env
+  end
+end
+
+class IpAuthorizerTest < MiniTest::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    inner_app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, ['Hello']] }
+    Rack::IpAuthorizer.new(inner_app, {'test' => ['1.1.1.1', '1.1.1.2'], 'admin' => ['2.2.2.2']})
+  end
+
+  def setup
+    Rack::IpAuthorizer.env_to_check = ['development']
+  end
+
+  def check_ip_for_path(path, ip, expected_result = 200, env = 'development')
+    Rails.stub :env, env do
+      get path, {}, {'REMOTE_ADDR' => ip}
+      assert last_response.status == expected_result
+    end
+  end
+
+  def test_env_checked
+    check_ip_for_path('/test', '1.1.1.1')
+  end
+
+  def test_env_ignored
+    Rack::IpAuthorizer.env_to_check = ['staging']
+    check_ip_for_path('/test', '1.1.1.1', 200, 'staging')
+  end
+
+  def test_ip_allowed
+    check_ip_for_path('/test', '1.1.1.1')
+    check_ip_for_path('/test', '1.1.1.2')
+    check_ip_for_path('/admin', '2.2.2.2')
+  end
+
+  def test_ip_refused
+    check_ip_for_path('/test', '2.2.2.2', 403)
+    check_ip_for_path('/admin', '1.1.1.1', 403)
+    check_ip_for_path('/admin', '1.1.1.2', 403)
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: rack-ip-authorizer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Thibault El Zamek, Cédric Darné, Lionel Oto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  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: 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: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+description: Basic Rack middleware for checking Rails3 request remote ip
+email:
+- thibault.elzamek@c4mprod.com, cedric.darne@c4mprod.com, lionel.oto@c4mprod.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/rack/version.rb
+- lib/rack/ip_authorizer.rb
+- lib/rack-ip-authorizer.rb
+- spec/rake_ip_authorizer_spec.rb
+homepage: ''
+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: Basic Rack middleware for checking Rails3 request remote ip
+test_files:
+- spec/rake_ip_authorizer_spec.rb