security_guard 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+.DS_Store
+*.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/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Fred Wu
+
+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,57 @@
+# SecurityGuard
+
+This gem is a collection of useful tools for auditing data and performing security checks.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'security_guard'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install security_guard
+
+## Usage
+
+### Executable
+
+There is an `sguard` command if you intend to use security_guard as a command line tool. Please refer to the help option for its usage.
+
+    sguard -h
+
+### Country IPs
+
+Returns a list of the IPs from given country and IP dictionaries. Useful for auditing IPs from higher risk nations.
+
+```ruby
+country_ips = SecurityGuard::CountryIps.new
+country_ips.countries = ['Australia', 'United States']
+country_ips.ips = ['4.4.4.4', '8.8.8.8', '203.206.0.1']
+country_ips.result # => ['203.206.0.1']
+```
+
+You may also pass country and IP data as a line-delimited file by appending `_from_file` at the end of the attributes:
+
+```ruby
+country_ips.countries_from_file = '/path/to/the/file'
+country_ips.ips_from_file = '/path/to/the/file'
+```
+
+## Contributing
+
+1. Fork it
+2. Make sure you add documentation to README.md
+3. Make sure you test all your code
+4. Do your magic!
+5. Create a new Pull Request
+
+## Author
+
+- [Fred Wu](http://fredwu.me/)
+
+Brought to you by [SitePoint](http://www.sitepoint.com/).

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push 'lib'
+  t.test_files = FileList['specs/**/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/bin/sguard

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+
+require 'clamp'
+require 'awesome_print'
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'security_guard'
+
+module SecurityGuard
+  class CountryIpsCommand < Clamp::Command
+    parameter 'ip_addresses_path', 'path to a line-delimited file of IP addresses'
+    parameter 'countries_path', 'path to a line-delimited file of countries'
+    parameter '[output_path]', 'output the results in a text file'
+
+    def execute
+      country_ips = SecurityGuard::CountryIps.new
+
+      country_ips.ips_from_file       = ip_addresses_path
+      country_ips.countries_from_file = countries_path
+
+      if output_path
+        MainCommand.output_result(country_ips.result, output_path)
+      else
+        ap country_ips.result
+      end
+    end
+  end
+
+  class MainCommand < Clamp::Command
+    def self.output_result(result, output_path)
+      `echo #{result} > #{output_path}`
+      ap "Results published to '#{output_path}'."
+    end
+
+    subcommand 'country_ips',
+               'Returns a list of the IPs from given country and IP dictionaries.',
+               SecurityGuard::CountryIpsCommand
+  end
+end
+
+SecurityGuard::MainCommand.run

data/lib/security_guard.rb

@@ -0,0 +1,5 @@
+require 'security_guard/version'
+require 'security_guard/utils/files'
+require 'security_guard/utils/accepts_from_file'
+require 'security_guard/utils/geo_ips'
+require 'security_guard/country_ips'

data/lib/security_guard/country_ips.rb

@@ -0,0 +1,20 @@
+module SecurityGuard
+  class CountryIps
+    include Utils::AcceptsFromFile
+
+    accepts_from_file :countries, :ips
+
+    def initialize
+      @geoip ||= Utils::GeoIps.new(Utils::Files.load('GeoIP.dat'))
+    end
+
+    def result
+      country_ips = []
+      ips.each do |ip|
+        @geoip.ip_address = ip
+        country_ips << ip if countries.include?(@geoip.country_name)
+      end
+      country_ips.sort
+    end
+  end
+end

data/lib/security_guard/utils/accepts_from_file.rb

@@ -0,0 +1,20 @@
+module SecurityGuard
+  module Utils
+    module AcceptsFromFile
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      module ClassMethods
+        def accepts_from_file(*attributes)
+          attributes.each do |attribute|
+            self.send :attr_accessor, attribute
+            self.send :define_method, "#{attribute}_from_file=", lambda { |file|
+              self.send "#{attribute}=", SecurityGuard::Utils::Files.to_array(file)
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/security_guard/utils/files.rb

@@ -0,0 +1,13 @@
+module SecurityGuard
+  module Utils
+    class Files
+      def self.load(filename)
+        File.expand_path("../../../../data/#{filename}", __FILE__)
+      end
+
+      def self.to_array(line_delimited_file)
+        File.readlines(line_delimited_file).map{ |line| line.sub("\n", '') }
+      end
+    end
+  end
+end

data/lib/security_guard/utils/geo_ips.rb

@@ -0,0 +1,22 @@
+require 'geoip'
+
+module SecurityGuard
+  module Utils
+    class GeoIps
+      attr_accessor :ip_address
+
+      def initialize(geo_data_file, ip_address = nil)
+        @geoip ||= GeoIP.new(geo_data_file)
+        self.ip_address = ip_address
+      end
+
+      def country
+        @geoip.country(ip_address)
+      end
+
+      def country_name
+        country.country_name
+      end
+    end
+  end
+end

data/lib/security_guard/version.rb

@@ -0,0 +1,3 @@
+module SecurityGuard
+  VERSION = '0.0.1'
+end

data/security_guard.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/security_guard/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Fred Wu']
+  gem.email         = ['fred.wu@sitepoint.com']
+  gem.summary       = %q{A collection of useful tools for auditing data and performing security checks.}
+  gem.description   = gem.summary
+  gem.homepage      = 'https://github.com/sitepoint/security_guard'
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = 'security_guard'
+  gem.require_paths = ['lib']
+  gem.version       = SecurityGuard::VERSION
+
+  gem.add_dependency 'clamp'
+  gem.add_dependency 'awesome_print'
+  gem.add_dependency 'geoip'
+  gem.add_development_dependency 'simplecov'
+end

data/specs/country_ips_spec.rb

@@ -0,0 +1,17 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe SecurityGuard::CountryIps do
+  before do
+    @country_ips = SecurityGuard::CountryIps.new
+    @country_ips.countries = ['Australia']
+    @country_ips.ips = ['4.4.4.4', '8.8.8.8', '203.206.0.1']
+  end
+
+  it 'contains GeoIP data' do
+    @country_ips.instance_variable_get(:@geoip).must_be_instance_of SecurityGuard::Utils::GeoIps
+  end
+
+  it 'returns all IPs from the given country and IP dictionaries' do
+    @country_ips.result.must_equal ['203.206.0.1']
+  end
+end

data/specs/fixtures/countries.txt

@@ -0,0 +1,3 @@
+Australia
+United States
+United Kingdom

data/specs/fixtures/ip_addresses.txt

@@ -0,0 +1,3 @@
+4.4.4.4
+8.8.8.8
+203.206.0.1

data/specs/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'minitest/autorun'
+require 'minitest/spec'
+
+require File.expand_path('../../lib/security_guard', __FILE__)
+
+def data_file(filename)
+  SecurityGuard::Utils::Files.load(filename)
+end
+
+def fixture_file(filename)
+  File.expand_path("../fixtures/#{filename}", __FILE__)
+end

data/specs/utils/accepts_from_file_spec.rb

@@ -0,0 +1,22 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+class TestA
+  include SecurityGuard::Utils::AcceptsFromFile
+  accepts_from_file :test_attribute
+end
+
+describe SecurityGuard::Utils::AcceptsFromFile do
+  before do
+    @test = TestA.new
+  end
+
+  it 'has #test_attribute as an accessor' do
+    @test.test_attribute = 'test'
+    @test.test_attribute.must_equal 'test'
+  end
+
+  it 'converts data from a file into an array' do
+    @test.test_attribute_from_file = fixture_file('countries.txt')
+    @test.test_attribute.must_equal ['Australia', 'United States', 'United Kingdom']
+  end
+end

data/specs/utils/files_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe SecurityGuard::Utils::Files do
+  describe 'SecurityGuard::Utils::Files#load' do
+    it 'points to the correct file' do
+      SecurityGuard::Utils::Files.load('GeoIP.dat').must_match 'security_guard/data/GeoIP.dat'
+    end
+  end
+
+  describe 'SecurityGuard::Utils::Files#to_array' do
+    it 'returns an array of the line delimited data' do
+      SecurityGuard::Utils::Files.to_array(fixture_file('countries.txt')).must_equal ['Australia', 'United States', 'United Kingdom']
+    end
+  end
+end

data/specs/utils/geo_ips_spec.rb

@@ -0,0 +1,45 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe SecurityGuard::Utils::GeoIps do
+  describe 'initialise without an ip' do
+    before do
+      @geoip = SecurityGuard::Utils::GeoIps.new(data_file('GeoIP.dat'))
+    end
+
+    it 'initialises with a geo ip database' do
+      @geoip.must_be_instance_of SecurityGuard::Utils::GeoIps
+    end
+
+    it 'sets an ip address' do
+      @geoip.ip_address = '8.8.8.8'
+      @geoip.ip_address.must_equal '8.8.8.8'
+    end
+  end
+
+  describe 'initialise with an ip' do
+    before do
+      @geoip = SecurityGuard::Utils::GeoIps.new(data_file('GeoIP.dat'), '8.8.8.8')
+    end
+
+    it 'has an ip address' do
+      @geoip.ip_address.must_equal '8.8.8.8'
+    end
+
+    it 'detects the country' do
+      @geoip.country.must_be_kind_of Struct
+      @geoip.country.to_hash.must_equal({
+        :request        => '8.8.8.8',
+        :ip             => '8.8.8.8',
+        :country_code   => 225,
+        :country_code2  => 'US',
+        :country_code3  => 'USA',
+        :country_name   => 'United States',
+        :continent_code => 'NA'
+      })
+    end
+
+    it 'detects the country name' do
+      @geoip.country_name.must_equal 'United States'
+    end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: security_guard
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Fred Wu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: clamp
+  requirement: &70177434013380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70177434013380
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: &70177434012840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70177434012840
+- !ruby/object:Gem::Dependency
+  name: geoip
+  requirement: &70177434012420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70177434012420
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70177434011980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70177434011980
+description: A collection of useful tools for auditing data and performing security
+  checks.
+email:
+- fred.wu@sitepoint.com
+executables:
+- sguard
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/sguard
+- data/GeoIP.dat
+- lib/security_guard.rb
+- lib/security_guard/country_ips.rb
+- lib/security_guard/utils/accepts_from_file.rb
+- lib/security_guard/utils/files.rb
+- lib/security_guard/utils/geo_ips.rb
+- lib/security_guard/version.rb
+- security_guard.gemspec
+- specs/country_ips_spec.rb
+- specs/fixtures/countries.txt
+- specs/fixtures/ip_addresses.txt
+- specs/spec_helper.rb
+- specs/utils/accepts_from_file_spec.rb
+- specs/utils/files_spec.rb
+- specs/utils/geo_ips_spec.rb
+homepage: https://github.com/sitepoint/security_guard
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A collection of useful tools for auditing data and performing security checks.
+test_files: []