rack-exclusive-verbs 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f72c1f274f61ec40a559d42df8543e70f3d24154
+  data.tar.gz: 38d0d006ef0ea505790add8acf9b9805b4775d7a
+SHA512:
+  metadata.gz: fc87b22c2ecf08a6a270b9622fd29cddb1b14d315f621047b8cb81fe00228f8f68a80c476c92eb49b34429ffc8256b1176dd3a97e67ca438ff3d4e9d8cd5a531
+  data.tar.gz: f32b4c689db4fd506509465cbd2e239191e9041cb323555024f4ac5695a3b7040de7bcd83f3c0eb727185ca5457655b0206822fb70e14c8f69cd21c1793d1e94

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+script: rspec spec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-exclusive-verbs.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Steve Jabour <steve@jabour.me>
+
+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,51 @@
+# Rack::ExclusiveVerbs [![Build Status](https://travis-ci.org/atsjj/rack-exclusive-verbs.svg?branch=master)](https://travis-ci.org/atsjj/rack-exclusive-verbs)
+
+Rack middleware implementing an IP whitelist of HTTP verbs.
+
+## Usage:
+
+```ruby
+require 'rack/exclusive_verbs'
+
+use Rack::ExclusiveVerbs do
+  resolver { Socket.ip_address_list.select { |addr| addr.ipv4_private? }.collect(&:ip_address) } ## optional
+  allow only: '10.0.0.1', to: [:put, :post]
+  allow only: '10.0.0.1', to: :post
+  allow only: '10.0.0.1', to: :be_safe ## get, head, options, trace
+  allow only: '10.0.0.1', to: :be_unsafe ## delete, patch, post, put
+  allow range: '10.0.0.0/24', to: [:put, :post]
+  allow range: '10.0.0.0/24', to: :post
+  allow range: '10.0.0.0/24', to: :be_safe ## get, head, options, trace
+  allow range: '10.0.0.0/24', to: :be_unsafe ## delete, patch, post, put
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-exclusive-verbs'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-exclusive-verbs
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/atsjj/rack-exclusive-verbs )
+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 a new Pull Request

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rack/exclusive/verbs"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rack/exclusive_verbs.rb

@@ -0,0 +1,100 @@
+require 'ipaddr'
+require 'set'
+
+module Rack
+  # Rack middleware implementing an IP whitelist of HTTP verbs
+  #
+  # Usage:
+  #  use Rack::ExclusiveVerbs do
+  #    resolver { Socket.ip_address_list.select { |addr| addr.ipv4_private? }.collect(&:ip_address) }
+  #    allow only: '10.0.0.1', to: [:put, :post]
+  #    allow only: '10.0.0.1', to: :post
+  #    allow only: '10.0.0.1', to: :be_safe ## get, head, options, trace
+  #    allow only: '10.0.0.1', to: :be_unsafe ## delete, patch, post, put
+  #    allow range: '10.0.0.0/24', to: [:put, :post]
+  #    allow range: '10.0.0.0/24', to: :post
+  #    allow range: '10.0.0.0/24', to: :be_safe ## get, head, options, trace
+  #    allow range: '10.0.0.0/24', to: :be_unsafe ## delete, patch, post, put
+  #  end
+  #
+  class ExclusiveVerbs
+    def initialize(app, &block)
+      @app = app
+      @rules = {}
+      @resolve = Proc.new { |request| [IPAddr.new(request.ip)] }
+      instance_eval(&block)
+    end
+
+    def call(env)
+      if is_allowed?(env)
+        @app.call(env)
+      else
+        [403, {"Content-Type" => "text/plain"}, ["403 Forbidden"]]
+      end
+    end
+
+    protected
+
+    def is_allowed?(env)
+      request = Rack::Request.new(env)
+
+      verb = request.request_method.downcase.to_sym
+      ips = [@resolve.call(request)].flatten.map do |ip|
+        if ip.kind_of?(IPAddr)
+          ip
+        else
+          IPAddr.new(ip)
+        end
+      end
+
+      if @rules.has_key?(verb)
+        return @rules[verb].any? { |rule| ips.any? { |ip| rule.include?(ip) } }
+      else
+        return false
+      end
+    end
+
+    def allow(config)
+      options = {
+        only: nil,
+        range: nil,
+        to: [:head, :get, :options, :trace]
+      }.merge(config)
+
+      compound_verbs = {
+        be_safe: [:get, :head, :options, :trace],
+        be_unsafe: [:delete, :patch, :post, :put]
+      }
+
+      # Use options[:only] as a syntax sugar, prefer options[:range]
+      options[:range] ||= options[:only]
+
+      # Replace options[:to] values of :be_unsafe or :be_safe with real verbs
+      if compound_verbs.has_key?(options[:to])
+        options[:to] = compound_verbs[options[:to]]
+      end
+
+      # Wrap options[:to] in an array, if only a symbol was passed
+      unless options[:to].kind_of?(Array)
+        options[:to] = [options[:to]]
+      end
+
+      options[:to].each do |verb|
+        unless @rules.has_key?(verb.to_sym)
+          @rules[verb.to_sym] = Set.new
+        end
+
+        ip = IPAddr.new(options[:range])
+        @rules[verb.to_sym].add(ip)
+      end
+    end
+
+    def resolver(&block)
+      @resolve = block;
+    end
+
+    class << self
+      def VERSION; "1.0.0"; end
+    end
+  end
+end

data/rack-exclusive-verbs.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/exclusive_verbs'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-exclusive-verbs"
+  spec.version       = Rack::ExclusiveVerbs.VERSION
+  spec.authors       = ["Steve Jabour"]
+  spec.email         = ["steve@jabour.me"]
+  spec.license       = 'MIT'
+
+  spec.summary       = %q{Rack middleware implementing an IP whitelist of HTTP verbs.}
+  spec.description   = %q{Rack middleware implementing an IP whitelist of HTTP verbs.}
+  spec.homepage      = "https://github.com/atsjj/rack-exclusive-verbs"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rack', '>= 0.9.1'
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: rack-exclusive-verbs
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Steve Jabour
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Rack middleware implementing an IP whitelist of HTTP verbs.
+email:
+- steve@jabour.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack/exclusive_verbs.rb
+- rack-exclusive-verbs.gemspec
+homepage: https://github.com/atsjj/rack-exclusive-verbs
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Rack middleware implementing an IP whitelist of HTTP verbs.
+test_files: []