gem-firewall 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b5e2e4ad290ed5bb5ef7adcdd549701d7d8901c3
+  data.tar.gz: 48f19cceb8e5351adeb9b1af4f333b7280e069b3
+SHA512:
+  metadata.gz: a7bfaf925c05c9118a72d9a284d21c1d50dcd2ea70d731d8dc09ba80a806ea7ba546ef610f798c907e205c11d060f452728012857fa00aee9f0ad498c7a7bd44
+  data.tar.gz: 19f0976a2f7107cd38cfdd0b53e68919a48ac4443c3d2bfa936f0142984b93423e491c9db4976798c005e4670573af683e22aa23e866dd6c0a830d174ce23ec4

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Terranova David
+
+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,72 @@
+# Firewall
+
+Very simple firewall
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'firewall'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install firewall
+
+## Basic usage
+
+- Create a firewall instance
+
+```
+fw = Firewall::Firewall.new(false) # reject by default
+```
+
+- Add some rules
+
+```
+r = Firewall::Rule.new("192.168.1.0/24", true) # allow network
+fw.add_rule(r)
+```
+
+- Let's check
+
+```
+fw.allowed?("192.168.1.15") # true
+fw.allowed?("127.0.0.1") # false
+```
+
+## Advanced rules
+
+Lets assume you have an object that can do some checks
+
+```
+class Deletest
+
+  def complex_check
+    true
+  end
+
+end
+```
+
+```
+delegate = Deletest.new
+
+fw = Firewall::Firewall.new(false)
+r = Firewall::ComplexRule.new("192.168.1.1", true, {delegate: delegate, method: :complex_check})
+fw.add_rule(r)
+
+fw.allowed?("192.168.1.1", true) # true
+fw.allowed?("192.168.1.1", false) # false
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/davidterranova/firewall/fork )
+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,10 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/*_test.rb"
+end
+
+desc "Run tests"
+task :default => :test

data/firewall.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'firewall/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gem-firewall"
+  spec.version       = Firewall::VERSION
+  spec.authors       = ["Terranova David"]
+  spec.email         = ["dterranova@adhara-cybersecurity.com"]
+  spec.summary       = %q{IP based authorisation system}
+  spec.description   = %q{IP based authorisation system}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "minitest", "~> 4.7.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "debugger2"
+
+  spec.add_dependency "ipaddress", "~> 0.8.0"
+end

data/lib/complex_rule.rb

@@ -0,0 +1,22 @@
+module Firewall
+  class ComplexRule < Rule
+
+    def initialize(ip, allowed, check = {delegate: nil, method: nil})
+      super(ip, allowed)
+      @delegate = check[:delegate]
+      @method = check[:method]
+    end
+
+    def pass?(ip, value = nil)
+      pass = false
+      if @delegate
+        pass = (super(ip) and (value == @delegate.send(@method)))
+      else
+        pass = super(ip)
+      end
+
+      pass
+    end
+
+  end
+end

data/lib/firewall/version.rb

@@ -0,0 +1,3 @@
+module Firewall
+  VERSION = "0.0.5"
+end

data/lib/firewall.rb

@@ -0,0 +1,37 @@
+require "firewall/version"
+require "ipaddress"
+require "rule"
+require "complex_rule"
+
+module Firewall
+  class Firewall
+
+    def initialize(default = false)
+      @default = default
+      @rules = []
+    end
+
+    def rules
+      @rules
+    end
+
+    def add_rule rule
+      @rules << rule
+    end
+
+    def allowed? *args
+      allowed = @default
+      @rules.each do |rule|
+        if rule.kind_of? ComplexRule
+          value = (args.length > 1) ? args[1] : nil
+          allowed = (allowed || rule.pass?(args[0], value))
+        else
+          allowed = (allowed || rule.pass?(args[0]))
+        end
+      end
+
+      allowed
+    end
+
+  end
+end

data/lib/rule.rb

@@ -0,0 +1,38 @@
+module Firewall
+  class Rule
+
+    def initialize(ip, allowed)
+      @ip = IPAddress.parse ip
+      @allowed = allowed
+    end
+
+    def ip
+      @ip
+    end
+
+    def allowed
+      @allowed
+    end
+
+    def pass? str_ip
+      value = false
+      ip = IPAddress.parse str_ip
+      if @ip.prefix == 32 or ! @ip.network? # single address
+        if @ip.address == ip.address
+          value = @allowed
+        end
+      else # network
+        if @ip.include?(ip)
+          value = @allowed
+        end
+      end
+
+      value
+    end
+
+    def to_s
+      "#{@ip.to_string} - #{@allowed}"
+    end
+
+  end
+end

data/test/complex_rule_test.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+class ComplexRuleTest < Minitest::Unit::TestCase
+
+  class Deletest
+
+    def return_true
+      true
+    end
+
+  end
+
+
+  def test_with_delegate_allowed
+    ip = "192.168.1.10/24"
+    ip2 = "192.168.1.10"
+
+    dt = Deletest.new
+
+    r1 = Firewall::ComplexRule.new(ip, true, {delegate: dt, method: :return_true})
+    assert_equal r1.pass?(ip2, true), true
+  end
+
+  def test_with_delegate_blocked
+    ip = "192.168.1.10/24"
+    ip2 = "192.168.1.10"
+
+    dt = Deletest.new
+
+    r1 = Firewall::ComplexRule.new(ip, true, {delegate: dt, method: :return_true})
+    assert_equal false, r1.pass?(ip2, false)
+  end
+
+  def test_complex_rule_as_normal_rule_allowed
+    ip = "192.168.1.10/24"
+    ip2 = "192.168.1.10"
+
+    dt = Deletest.new
+
+    r1 = Firewall::ComplexRule.new(ip, true)
+    assert_equal r1.pass?(ip2), true
+  end
+
+  def test_complex_rule_as_normal_rule_blocked
+    ip = "192.168.1.10/24"
+    ip2 = "192.168.1.10"
+
+    dt = Deletest.new
+
+    r1 = Firewall::ComplexRule.new(ip, false)
+    assert_equal r1.pass?(ip2), false
+  end
+
+
+end

data/test/firewall_test.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+
+class FirewallTest < Minitest::Unit::TestCase
+
+  def setup
+    @fw = Firewall::Firewall.new
+  end
+
+  def test_no_rule
+    ip = "192.168.1.10/32"
+
+    assert_equal @fw.allowed?(ip), false
+  end
+
+  def test_no_rule_true
+    @fw = Firewall::Firewall.new(true)
+    ip = "192.168.1.10/32"
+
+    assert_equal @fw.allowed?(ip), true
+  end
+
+  def test_same_ip_pass
+    ip = "192.168.1.10/32"
+    r1 = Firewall::Rule.new(ip, true)
+    @fw.add_rule r1
+
+    assert_equal @fw.allowed?(ip), true
+  end
+
+  def test_same_ip_block
+    ip = "192.168.1.10/32"
+    r1 = Firewall::Rule.new(ip, false)
+    @fw.add_rule r1
+
+    assert_equal @fw.allowed?(ip), false
+  end
+
+  def test_network_blocked
+    network = "192.168.1.0/24"
+    ips = IPAddress.parse(network).hosts
+
+    r1 = Firewall::Rule.new(network, false)
+    @fw.add_rule r1
+
+    ips.each do |ip|
+      assert_equal @fw.allowed?(ip.to_string), false
+    end
+  end
+
+  def test_network_pass
+    network = "192.168.1.0/24"
+    ips = IPAddress.parse(network).hosts
+
+    ip = "192.168.1.10/24"
+
+    r1 = Firewall::Rule.new(network, true)
+    @fw.add_rule r1
+
+    ips.each do |ip|
+      assert_equal @fw.allowed?(ip.to_string), true
+    end
+  end
+
+  def test_out_of_network_blocked
+    network = "192.168.1.0/24"
+    ip = "192.168.2.10/24"
+
+    r1 = Firewall::Rule.new(network, true)
+    @fw.add_rule r1
+
+    assert_equal @fw.allowed?(ip), false
+  end
+
+  def test_out_of_network_blocked_2
+    network = "192.168.1.0/24"
+    ip = "192.168.2.10/24"
+
+    r1 = Firewall::Rule.new(network, false)
+    @fw.add_rule r1
+
+    assert_equal @fw.allowed?(ip), false
+  end
+
+  def test_block_allowed
+    network = "192.168.1.0/24"
+    ip = "192.168.1.10"
+
+    r1 = Firewall::Rule.new(network, false)
+    r2 = Firewall::Rule.new(network, true)
+    @fw.add_rule r1
+    @fw.add_rule r2
+
+    assert_equal @fw.allowed?(ip), true
+  end
+
+  def test_block_allowed_2
+    network = "192.168.1.0/24"
+    ip = "192.168.1.10"
+
+    r1 = Firewall::Rule.new(network, false)
+    r2 = Firewall::Rule.new(network, true)
+    @fw.add_rule r2
+    @fw.add_rule r1
+
+    assert_equal @fw.allowed?(ip), true
+  end
+
+  def test_multiple_rules
+    network = "192.168.1.0/24"
+    ip = "192.168.1.10"
+
+    r1 = Firewall::Rule.new(network, false)
+    r2 = Firewall::ComplexRule.new(network, true)
+    @fw.add_rule r2
+    @fw.add_rule r1
+
+    assert_equal @fw.allowed?(ip), true
+  end
+
+end

data/test/rule_test.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+class RuleTest < Minitest::Unit::TestCase
+
+  def test_same_ip_pass
+    ip = "192.168.1.10/32"
+    r1 = Firewall::Rule.new(ip, true)
+
+    assert_equal r1.pass?(ip), true
+  end
+
+  def test_same_ip_block
+    ip = "192.168.1.10/32"
+    r1 = Firewall::Rule.new(ip, false)
+
+    assert_equal r1.pass?(ip), false
+  end
+
+  def test_network_blocked
+    network = "192.168.1.0/24"
+    ips = IPAddress.parse(network).hosts
+
+    r1 = Firewall::Rule.new(network, false)
+
+    ips.each do |ip|
+      assert_equal r1.pass?(ip.to_string), false
+    end
+  end
+
+  def test_network_pass
+    network = "192.168.1.0/24"
+    ips = IPAddress.parse(network).hosts
+
+    ip = "192.168.1.10/24"
+
+    r1 = Firewall::Rule.new(network, true)
+
+    ips.each do |ip|
+      assert_equal r1.pass?(ip.to_string), true
+    end
+  end
+
+  def test_out_of_network_blocked
+    network = "192.168.1.0/24"
+    ip = "192.168.2.10/24"
+
+    r1 = Firewall::Rule.new(network, true)
+
+    assert_equal r1.pass?(ip), false
+  end
+
+  def test_out_of_network_blocked_2
+    network = "192.168.1.0/24"
+    ip = "192.168.2.10/24"
+
+    r1 = Firewall::Rule.new(network, false)
+
+    assert_equal r1.pass?(ip), false
+  end
+
+  def test_out_of_ip_blocked
+    ip = "192.168.1.10/24"
+    ip2 = "192.168.1.11/24"
+
+    r1 = Firewall::Rule.new(ip, false)
+    assert_equal r1.pass?(ip2), false
+  end
+
+  def test_out_of_ip_blocked_2
+    ip = "192.168.1.10/24"
+    ip2 = "192.168.2.10/24"
+
+    r1 = Firewall::Rule.new(ip, false)
+    assert_equal r1.pass?(ip2), false
+  end
+
+  def test_out_of_ip_blocked_3
+    ip = "192.168.1.10/24"
+    ip2 = "192.168.1.11"
+
+    r1 = Firewall::Rule.new(ip, false)
+    assert_equal r1.pass?(ip2), false
+  end
+
+  def test_in_network_allowed
+    ip = "192.168.1.10/24"
+    ip2 = "192.168.1.10"
+
+    r1 = Firewall::Rule.new(ip, true)
+    assert_equal r1.pass?(ip2), true
+  end
+
+end

data/test/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'firewall'
+require 'minitest/unit'
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'debugger'

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: gem-firewall
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Terranova David
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.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: debugger2
+  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: ipaddress
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+description: IP based authorisation system
+email:
+- dterranova@adhara-cybersecurity.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- firewall.gemspec
+- lib/complex_rule.rb
+- lib/firewall.rb
+- lib/firewall/version.rb
+- lib/rule.rb
+- test/complex_rule_test.rb
+- test/firewall_test.rb
+- test/rule_test.rb
+- test/spec_helper.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.2.2
+signing_key: 
+specification_version: 4
+summary: IP based authorisation system
+test_files:
+- test/complex_rule_test.rb
+- test/firewall_test.rb
+- test/rule_test.rb
+- test/spec_helper.rb