fidius-common 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+doc/
+.yardoc/

data/.yardopts

@@ -0,0 +1,6 @@
+--title 'FIDIUS Common libraries'
+--private
+--protected
+--readme 'README.md'
+lib/**/*.rb -
+LICENSE CREDITS.md

data/CREDITS.md

@@ -0,0 +1,5 @@
+Third-party tools
+
+* `lib/fidius-common/ip-helper.rb`: `get_my_ip` methods
+  * Credit goes to Coderr
+  * https://coderrr.wordpress.com/2008/05/28/get-your-local-ip-address/

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,57 @@
+The Simplified BSD License
+
+Copyright (C) 2010-2011  FIDIUS Intrusion Detection with Intelligent
+User Support (FIDIUS). All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY FIDIUS ``AS IS'' AND ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL FIDIUS OR CONTRIBUTORS BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+
+The views and conclusions contained in the software and documentation
+are those of the authors and should not be interpreted as representing
+official policies, either expressed or implied, of FIDIUS.
+
+
+*OR*
+
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+Copyright (C) 2010-2011  FIDIUS Intrusion Detection with Intelligent
+User Suppport.
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+A digital copy is also available for download here:
+http://www.gnu.org/licenses/gpl-2.0.txt.

data/README.md

@@ -0,0 +1,45 @@
+# FIDIUS Common libraries
+
+This RubyGem is a small collection of some commonly used methods and
+module extensions of the FIDIUS project. These methods are meant to run
+standalone (i.e. without setting up a FIDIUS C&C server).
+
+
+## Installation
+
+Simply install this package with RubyGems:
+
+    $ gem install fidius-common
+
+
+## Example of use
+
+You can use this library as any other RubyGem:
+
+    require 'rubygems' if RUBY_VERSION < '1.9'
+    require 'fidius-common'
+
+For an overview of the provided methods, have a look into the
+[API documentation](http://rubydoc.info/gems/fidius-common/frames).
+Currently, there is no special sorting, but that may change in future.
+
+
+## Authors and Contact
+
+The common library was written by
+
+* FIDIUS Intrusion Detection with Intelligent User Support
+  <grp-fidius+fidicom@tzi.de>, <http://fidius.me>
+* in particular:
+  * Dominik Menke <dmke+fidicom@tzi.de>
+  * Bernd Katzmarski <bkatzm+fidicom@tzi.de>
+
+If you have any questions, remarks, suggestion, improvements,
+etc. feel free to drop a line at the addresses given above.
+You might also join `#fidius` on Freenode or use the contact
+form on our [website](http://fidius.me/en/contact).
+
+
+## License
+
+Simplified BSD License and GNU GPLv2. See also the file LICENSE.

data/Rakefile

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+
+begin
+  require 'yard'
+
+  YARD::Rake::YardocTask.new(:doc) do |t|
+    t.files = ['lib/**/*.rb']
+    static_files = 'LICENSE,CREDITS.md'
+    t.options += [
+      '--title', 'FIDIUS Common libraries',
+      '--private',   # include private methods
+      '--protected', # include protected methods
+      '--files', static_files,
+      '--readme', 'README.md'
+    ]
+  end
+rescue LoadError
+  puts 'YARD not installed (gem install yard), http://yardoc.org'
+end

data/fidius-common.gemspec

@@ -0,0 +1,28 @@
+# encoding: utf-8
+$:.push File.expand_path("../lib", __FILE__)
+require "fidius-common/version"
+
+Gem::Specification.new do |s|
+  s.name        = "fidius-common"
+  s.version     = FIDIUS::Common::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Dominik Menke", "Bernd Katzmarski"]
+  s.email       = ["dmke+fidicom@tzi.org", "bkatzm+fidicom@tzi.org"]
+  s.homepage    = ""
+  s.summary     = "Common useful libraries and methods for the FIDIUS C&C server, the FIDIUS 'architecture' and maybe other components."
+  s.description = s.summary + "\n\nThese gem and its classes/modules/methods are meant to run stand-alone, e.g. in non-FIDIUS components."
+
+  s.rubyforge_project = ""
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_runtime_dependency 'active_support', '>= 3.0.0'
+
+  s.rdoc_options << '--title' << s.name <<
+                    '--main'  << 'README.md' << '--show-hash' <<
+                    `git ls-files -- lib/*`.split("\n") <<
+                    'README.md' << 'LICENSE' << 'CREDITS.md'
+end

data/lib/fidius-common/ip-helper.rb

@@ -0,0 +1,32 @@
+require 'ipaddr' # Used to gain a single address from an IP range.
+require 'socket' # Used to determine this host's IP address.
+
+module FIDIUS
+  module Common
+
+    # Returns the IP address of that interface, which would connect to
+    # an address of the given +iprange+.
+    #
+    # Thanks to Coderrr (https://coderrr.wordpress.com) for this
+    # implementation.
+    # 
+    # @see https://coderrr.wordpress.com/2008/05/28/get-your-local-ip-address/
+    #
+    # @param [String] iprange  The target IP range, e.g. +127.0.0.0/8+
+    #                          or +127.0.0.1+.
+    # @return [String]  Your (local) IP address.
+    def self.get_my_ip(iprange)
+      # backup setting
+      orig, Socket.do_not_reverse_lookup = Socket.do_not_reverse_lookup, true
+      UDPSocket.open do |s|
+        # udp is stateless, so there is no real connect
+        s.connect IPAddr.new(iprange).to_s, 1
+        s.addr.last
+      end
+    ensure
+      # restore backup
+      Socket.do_not_reverse_lookup = orig
+    end
+
+  end # module Common
+end # FIDIUS

data/lib/fidius-common/json_symbol_addon.rb

@@ -0,0 +1,114 @@
+# These changes are necessary to extend json encoding & decoding
+# for ruby-symbols. Tricky parts are symbols in Arrays or Hashes.
+
+require 'active_support'
+require 'active_support/json'
+
+# Part of the JSON Symbol Addon.
+# @see FIDIUS::Common.install_json_symbol_addon
+class Symbol
+  # Encodes symbols as +String+, prefixed with ":".
+  # 
+  # @param [Hash] options  Ingnored.
+  # @return [String]  The converted +Symbol+.
+  def as_json(options = nil)
+    ":" + to_s
+  end
+end
+
+# Part of the JSON Symbol Addon.
+# @see FIDIUS::Common.install_json_symbol_addon
+class Hash
+  # JSON-encodes +self+.
+  #
+  # @param [Hash] options  An options-hash. Keys maybe +:only+, +:exept+
+  #                        or +:encoder+.
+  # @return [String]  The JSON-encoded string of +self+.
+  def as_json(options = nil)
+    # create a subset of the hash by applying :only or :except
+    subset = if options
+      if attrs = options[:only]
+        slice(*Array.wrap(attrs))
+      elsif attrs = options[:except]
+        except(*Array.wrap(attrs))
+      else
+        self
+      end
+    else
+      self
+    end
+
+    # use encoder as a proxy to call as_json on all values in the subset, to protect from circular references
+    encoder = options && options[:encoder] || ActiveSupport::JSON::Encoding::Encoder.new(options)
+    
+    # FIDIUS changed here to from k.to_s to k.as_json to decode strings with : as symbols
+    pairs = subset.map do |k, v|
+      [k.as_json, encoder.as_json(v)]
+    end
+    result = if self.is_a?(ActiveSupport::OrderedHash)
+      ActiveSupport::OrderedHash.new
+    else
+      Hash.new
+    end
+    pairs.inject(result) do |hash, pair|
+      hash[pair.first] = pair.last; hash
+    end
+  end
+
+  # Converts each key to a symbol, if the key is a +String+ and its
+  # first character is a +:+.
+  #
+  # @return [Hash]  The converted hash.
+  def symbolize_keys_if_needed
+    to_add = Hash.new
+    self.each_pair do |k,v|
+      if v.respond_to?("symbolize_keys_if_needed")
+        v.symbolize_keys_if_needed
+      end
+      if k[0] == ":"
+        self.delete(k)
+        to_add[k[1..-1].to_sym] = v
+      end
+    end
+    to_add.each_pair do |k,v|
+      self[k] = v
+    end
+  end
+end
+
+# Part of the JSON Symbol Addon.
+# @see FIDIUS::Common.install_json_symbol_addon
+class Array
+  # [1,":aa",:asa].symbolize_keys_if_needed
+  #  => [1, :aa, :asa] 
+  def symbolize_keys_if_needed
+    self.each_with_index do |e,i|
+      e.symbolize_keys_if_needed if e.respond_to?("symbolize_keys_if_needed")
+      if self[i].to_s[0] == ":"
+        self[i] = e[1..-1].to_sym
+      end
+    end
+  end
+end
+
+# Part of the JSON Symbol Addon.
+# @see FIDIUS::Common.install_json_symbol_addon
+# @see http://rubyonrails.org
+# @see http://api.rubyonrails.org
+module ActiveSupport
+  # ActiveSupports JSON module
+  # @see http://api.rubyonrails.org/classes/ActiveSupport/JSON.html
+  module JSON
+    # Parses a JSON string or IO and convert it into an object. Any
+    # strings of that object will be converted, if they are prefixed
+    # with a +:+.
+    #
+    # @param [String, IO] json  Any JSON formatted object.
+    # @return [Object]  The converted object.
+    def self.decode(json)
+      set_default_backend unless defined?(@backend)
+      result = @backend.decode(json)
+      result.symbolize_keys_if_needed
+    end
+  end
+end

data/lib/fidius-common/version.rb

@@ -0,0 +1,8 @@
+module FIDIUS
+  module Common
+
+    # Current version number
+    VERSION = "0.0.1"
+
+  end # module Common
+end # module FIDIUS

data/lib/fidius-common.rb

@@ -0,0 +1,29 @@
+require 'fidius-common/ip-helper'
+
+# FIDIUS Intrusion Detection with Intelligent User Support.
+# @see http://fidius.me
+module FIDIUS
+  # Common used methods and libraries. You might use these also in a
+  # non-FIDIUS context, since there are no other FIDIUS-related
+  # dependencies.
+  module Common
+  
+    autoload :VERSION, './fidius-common/version'
+    
+    # Since this addon changes behaviour of +to_json+, you have to
+    # require it explicitly either with this helper method or manually
+    # with
+    #
+    #  require 'fidius-common/json_symbol_addon'
+    #
+    # Important note: Both variants will also load and require
+    # +active_support+.
+    #
+    # @return [Boolean]  true if the addon was loaded successfully or
+    #                    false if the addon is already loaded.
+    def self.install_json_symbol_addon
+      require 'fidius-common/json_symbol_addon'
+    end
+  
+  end # module Common
+end # module FIDIUS

data/test/test_iphelper.rb

@@ -0,0 +1,25 @@
+require 'fidius-common/ip-helper'
+require 'test/unit'
+
+class IPHelperTest < Test::Unit::TestCase
+  def test_get_localhost
+    ip = FIDIUS::Common.get_my_ip '127.0.0.1'
+    assert_equal '127.0.0.1', ip
+  end
+  
+  def test_get_invalid_host
+    assert_raise ArgumentError do
+      FIDIUS::Common.get_my_ip '300.0.0.0'
+    end
+  end
+  
+  def test_get_google_dns
+    begin
+      # run `ifconfig` to determine possible addresses?
+      ip = FIDIUS::Common.get_my_ip '8.8.8.8'
+      assert_not_nil ip
+    rescue Errno::ENETUNREACH
+      puts "Skipped get_google_dns, since network is not reachable"
+    end
+  end
+end

data/test/test_json_addon.rb

@@ -0,0 +1,31 @@
+require 'fidius-common/json_symbol_addon'
+require 'test/unit'
+
+
+class JSONSymbolAddonTest < Test::Unit::TestCase
+  SIMPLE_HASH_SAMPLE = { :a => 1, :b => 2 }
+  SIMPLE_ARRAY_SAMPLE = [ :a, 1, :b, 2 ]
+  
+  def test_simple_hash
+    json = JSON.parse(SIMPLE_HASH_SAMPLE.to_json)
+    assert_not_equal SIMPLE_HASH_SAMPLE, json
+    assert_equal SIMPLE_HASH_SAMPLE, json.symbolize_keys_if_needed
+  end
+  
+  def test_simple_array
+    json = JSON.parse(SIMPLE_ARRAY_SAMPLE.to_json)
+    assert_not_equal SIMPLE_ARRAY_SAMPLE, json
+    assert_equal SIMPLE_ARRAY_SAMPLE, json.symbolize_keys_if_needed
+  end
+  
+  def test_complex_sample
+    sample = {
+      :array => SIMPLE_ARRAY_SAMPLE,
+      :hash  => SIMPLE_HASH_SAMPLE
+    }
+    json = JSON.parse(sample.to_json)
+    assert_not_equal sample, json
+    assert_equal sample, json.symbolize_keys_if_needed
+  end
+
+end # class JSONSymbolAddonTest

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: fidius-common
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Dominik Menke
+- Bernd Katzmarski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-17 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: active_support
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+description: |-
+  Common useful libraries and methods for the FIDIUS C&C server, the FIDIUS 'architecture' and maybe other components.
+  
+  These gem and its classes/modules/methods are meant to run stand-alone, e.g. in non-FIDIUS components.
+email: 
+- dmke+fidicom@tzi.org
+- bkatzm+fidicom@tzi.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .yardopts
+- CREDITS.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fidius-common.gemspec
+- lib/fidius-common.rb
+- lib/fidius-common/ip-helper.rb
+- lib/fidius-common/json_symbol_addon.rb
+- lib/fidius-common/version.rb
+- test/test_iphelper.rb
+- test/test_json_addon.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --title
+- fidius-common
+- --main
+- README.md
+- --show-hash
+- - lib/fidius-common.rb
+  - lib/fidius-common/ip-helper.rb
+  - lib/fidius-common/json_symbol_addon.rb
+  - lib/fidius-common/version.rb
+- README.md
+- LICENSE
+- CREDITS.md
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: ""
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Common useful libraries and methods for the FIDIUS C&C server, the FIDIUS 'architecture' and maybe other components.
+test_files: []
+