rack-ip_blocker 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e1cde53db8f74081aaae9d3d7c5dc1bed5f48f67
+  data.tar.gz: 536d91be4862c8c7749f26f82a79d8ed3d3d1f96
+SHA512:
+  metadata.gz: 531b70a316c92fd1fb6a02be98cbd2cf362560b43b5826c4c5e505e9a6e4543eb5fcb4587fb63424d28bb85a4cc73fa4e1225b6bb124776181137d6ccdf26b4a
+  data.tar.gz: 38deb075a87340677217fdc32c97892136d30bf0f452027ef632688ff433de1de95ede3ebe792aa488392a67c0028975d0123e86eddd1549d5fa542ed532c242

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org/>

data/README.md

@@ -0,0 +1,53 @@
+# IP Blocker Middleware
+
+`IpBlocker::Middleware` provides a simple manner of blocking specific
+IP's from ever reaching your Rack/Rails application. It does this by
+reading from a list of IP's specified in a plain text file.
+
+## Installation
+
+Put this in your Gemfile:
+
+```ruby
+gem "rack-ip_blocker", require: "ip_blocker"
+```
+
+Create your blacklist file:
+
+```sh
+touch config/blocked_ips.txt
+```
+
+## Usage and configuration
+
+### Rails
+
+When using IpBlocker with Rails, the middleware is automatically loaded.
+By default, IpBlocker will try to read blocked IP's from `config/blocked_ips.txt`.
+
+To specify the location of your IP blacklist file, put this in your
+enviroment files (`config/environments/production.rb`, etc):
+
+```ruby
+YourApp::Application.configure do
+
+  # ...
+
+  config.ip_blocker.file_path = Rails.root.join("config/my_blacklist.txt").to_s
+
+  # ...
+
+end
+```
+
+### Other Rack applications
+
+The middleware can be manually included like so:
+
+```ruby
+use IpBlocker::Middleware, file_path: "/path/to/my/blacklist.txt"
+```
+
+## License
+
+See LICENSE.

data/Rakefile

@@ -0,0 +1,29 @@
+require "bundler/gem_tasks"
+require_relative "lib/ip_blocker/version"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+desc 'Builds the gem'
+task :build do
+  sh 'gem build rack-ip_blocker.gemspec'
+end
+
+desc 'Builds and installs the gem'
+task :install => :build do
+  sh "gem install rack-ip_blocker-#{IpBlocker::VERSION}"
+end
+
+desc 'Tags version, pushes to remote, and pushes gem'
+task :release => :build do
+  sh "git tag v#{IpBlocker::VERSION}"
+  sh 'git push origin master'
+  sh "git push origin v#{IpBlocker::VERSION}"
+  sh "gem push rack-ip_blocker-#{IpBlocker::VERSION}.gem"
+end

data/lib/ip_blocker.rb

@@ -0,0 +1,5 @@
+module IpBlocker
+end
+
+require "ip_blocker/middleware"
+require "ip_blocker/railtie" if defined?(Rails)

data/lib/ip_blocker/middleware.rb

@@ -0,0 +1,65 @@
+module IpBlocker
+  class Middleware
+    # List of blocked IPs. Use Set instead of Array for faster
+    # +include?+ lookups, as order or uniqueness doesn't matter here.
+    @@blocked_ips = nil
+    def self.blocked_ips(file_path)
+      @@blocked_ips ||= Set.new(
+        # Remove newlines at the end of each line.
+        File.readlines(file_path).map { |line|
+          line.chomp.strip
+        }.reject { |line|
+          # Skip empty lines or comments.
+          line.empty? || line.start_with?("#")
+        }.freeze.map(&:freeze)
+      )
+    rescue Errno::ENOENT
+      warn "IpBlocker: File with blocked IP's '#{file_path}' doesn't exist. " \
+        "Not blocking anything."
+      @@blocked_ips = []
+    end
+
+    # Response to return when the request IP is blocked.
+    BLOCKED_RESPONSE = [
+      403,
+      {"Content-Type".freeze => "text/html".freeze},
+      ["<h1>403 Forbidden</h1>".freeze]
+    ]
+    RACK_IP_ENV_KEY  = "REMOTE_ADDR".freeze
+    RAILS_IP_ENV_KEY = "action_dispatch.remote_ip".freeze
+
+    def initialize(app, options = {})
+      @app = app
+      @options = options
+
+      if rails?
+        @options[:file_path] ||= Rails.configuration.ip_blocker.file_path
+      end
+    end
+
+    def call(env)
+      ip = env.fetch(
+        rails? ? RAILS_IP_ENV_KEY : RACK_IP_ENV_KEY,
+        "".freeze
+      ).to_s
+
+      # IP is blocked, return the blocked response.
+      if blocked_ips.include?(ip)
+        BLOCKED_RESPONSE
+      # Let the request through.
+      else
+        @app.call(env)
+      end
+    end
+
+  protected
+
+    def blocked_ips
+      self.class.blocked_ips(@options[:file_path])
+    end
+
+    def rails?
+      defined?(Rails)
+    end
+  end
+end

data/lib/ip_blocker/railtie.rb

@@ -0,0 +1,14 @@
+module IpBlocker
+  class Railtie < Rails::Railtie
+    config.ip_blocker = ActiveSupport::OrderedOptions.new
+
+    initializer :"ip_blocker.set_default_file_path" do
+      config.ip_blocker.file_path ||= Rails.root.join("config/blocked_ips.txt").to_s
+    end
+
+    initializer :"ip_blocker.insert_middleware" do |app|
+      app.middleware.insert_after ActionDispatch::RemoteIp,
+        IpBlocker::Middleware
+    end
+  end
+end

data/lib/ip_blocker/version.rb

@@ -0,0 +1,3 @@
+module IpBlocker
+  VERSION = "1.0.0".freeze
+end

data/rack-ip_blocker.gemspec

@@ -0,0 +1,22 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'ip_blocker/version'
+
+Gem::Specification.new do |s|
+  s.name        = "rack-ip_blocker"
+  s.version     = IpBlocker::VERSION
+  s.authors     = ["Kenneth De Winter"]
+  s.email       = ["kdwinter@protonmail.com"]
+  s.homepage    = "https://gitlab.com/gigamo/ip_blocker"
+  s.summary     = "Simple Rack middleware that blocks manually blacklisted IP's."
+  s.description = s.summary
+
+  s.files         = `git ls-files`.split($/).reject { |f| f == '.gitignore' or f =~ /^examples/ }
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "bundler", "~> 1.3"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "minitest", ">= 5.3.0"
+  s.add_development_dependency "rack-test", ">= 0"
+end

data/test/blacklist_empty.txt

@@ -0,0 +1 @@
+# Nothing in here.

data/test/blacklist_localhost.txt

@@ -0,0 +1,2 @@
+# Localhost should be blocked in here.
+127.0.0.1

data/test/ip_blocker_test.rb

@@ -0,0 +1,41 @@
+require "ip_blocker"
+require "minitest/autorun"
+require "rack/test"
+
+describe IpBlocker::Middleware do
+  include Rack::Test::Methods
+
+  def load_app(file_path)
+    Rack::Builder.new do
+      use IpBlocker::Middleware, file_path: File.join(Dir.pwd, file_path)
+      map("/") do
+        run ->(env) { [200, {"Content-Type" => "text/plain"}, ["OK"]] }
+      end
+    end
+  end
+
+  def teardown
+    # Don't cache
+    IpBlocker::Middleware.class_variable_set(:@@blocked_ips, nil)
+  end
+
+  describe "with IP not in blacklist" do
+    let(:app) { load_app("test/blacklist_empty.txt") }
+
+    it "should let requests through" do
+      get "/"
+      assert_equal 200, last_response.status
+      assert_equal "OK", last_response.body
+    end
+  end
+
+  describe "with IP in blacklist" do
+    let(:app) { load_app("test/blacklist_localhost.txt") }
+
+    it "should block requests" do
+      get "/"
+      assert_equal 403, last_response.status
+      assert_equal "<h1>403 Forbidden</h1>", last_response.body
+    end
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: rack-ip_blocker
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kenneth De Winter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-15 00:00:00.000000000 Z
+dependencies:
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.3.0
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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: Simple Rack middleware that blocks manually blacklisted IP's.
+email:
+- kdwinter@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/ip_blocker.rb
+- lib/ip_blocker/middleware.rb
+- lib/ip_blocker/railtie.rb
+- lib/ip_blocker/version.rb
+- rack-ip_blocker.gemspec
+- test/blacklist_empty.txt
+- test/blacklist_localhost.txt
+- test/ip_blocker_test.rb
+homepage: https://gitlab.com/gigamo/ip_blocker
+licenses: []
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Simple Rack middleware that blocks manually blacklisted IP's.
+test_files:
+- test/blacklist_empty.txt
+- test/blacklist_localhost.txt
+- test/ip_blocker_test.rb