ronin-support 0.1.0.pre1

data/lib/ronin/support.rb

@@ -0,0 +1,28 @@
+#
+# Ronin Support - A support library for Ronin.
+#
+# Copyright (c) 2010 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library 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
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor,
+# Boston, MA  02110-1301  USA
+#
+
+require 'ronin/extensions'
+require 'ronin/formatting'
+require 'ronin/network'
+require 'ronin/path'
+require 'ronin/templates'
+require 'ronin/support/inflector'
+require 'ronin/support/version'

data/lib/ronin/support/inflector.rb

@@ -0,0 +1,40 @@
+#
+# Ronin Support - A support library for Ronin.
+#
+# Copyright (c) 2010 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# 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 St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+
+begin
+  require 'active_support/inflector'
+rescue LoadError
+  begin
+    require 'extlib/inflection'
+  rescue LoadError
+    raise(LoadError,"unable to load 'active_support/inflector' or 'extlib/inflection'",caller)
+  end
+end
+
+module Ronin
+  module Support
+    # The inflector that Ronin will use.
+    Inflector = if Object.const_defined?(:ActiveSupport)
+                  ActiveSupport::Inflector
+                else
+                  Extlib::Inflection
+                end
+  end
+end

data/lib/ronin/support/version.rb

@@ -0,0 +1,27 @@
+#
+# Ronin Support - A support library for Ronin.
+#
+# Copyright (c) 2010 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library 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
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor,
+# Boston, MA  02110-1301  USA
+#
+
+module Ronin
+  module Support
+    # ronin-support version
+    VERSION = '0.1.0.pre1'
+  end
+end

data/lib/ronin/templates.rb

@@ -0,0 +1,23 @@
+#
+# Ronin - A Ruby platform for exploit development and security research.
+#
+# Copyright (c) 2006-2010 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library 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
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor,
+# Boston, MA  02110-1301  USA
+#
+
+require 'ronin/templates/template'
+require 'ronin/templates/erb'

data/lib/ronin/templates/erb.rb

@@ -0,0 +1,75 @@
+#
+# Ronin - A Ruby platform for exploit development and security research.
+#
+# Copyright (c) 2006-2010 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library 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
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor,
+# Boston, MA  02110-1301  USA
+#
+
+require 'ronin/templates/template'
+
+require 'erb'
+
+module Ronin
+  module Templates
+    #
+    # The {Erb} module uses the {Template} module to find and render
+    # Embedded Ruby (ERb) templates.
+    #
+    module Erb
+      include Template
+      #
+      # Renders the inline ERB template in the scope of the object.
+      #
+      # @param [String] template
+      #   Source of the ERB template.
+      #
+      # @return [String]
+      #   Result of the rendered template.
+      #
+      # @example
+      #   @user = 'lolcats'
+      #
+      #   erb %{
+      #   USER: <%= @user %>
+      #   PASSWORD: <%= @user.reverse %>
+      #   }
+      #   # => "\nUSER: lolcats\nPASSWORD: staclol\n"
+      #
+      def erb(template)
+        ERB.new(template).result(binding)
+      end
+
+      #
+      # Renders an ERB template file in the scope of the object.
+      #
+      # @param [String] template_path
+      #   The relative path of the ERB template.
+      #
+      # @return [String]
+      #   Result of the rendered template.
+      #
+      # @example
+      #   erb_file 'path/to/template.erb'
+      #
+      def erb_file(template_path)
+        read_template(template_path) do |template|
+          erb(template)
+        end
+      end
+    end
+  end
+end

data/lib/ronin/templates/template.rb

@@ -0,0 +1,161 @@
+#
+# Ronin - A Ruby platform for exploit development and security research.
+#
+# Copyright (c) 2006-2010 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library 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
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor,
+# Boston, MA  02110-1301  USA
+#
+
+require 'data_paths/finders'
+
+module Ronin
+  module Templates
+    #
+    # The {Template} module allows a class to find templates and manage
+    # multiple template directories. The {Template} module also can find
+    # templates within `data/` directories using `DataPaths::Finders`.
+    #
+    module Template
+      include DataPaths::Finders
+
+      protected
+
+      #
+      # A stack of directories to search for other templates within.
+      #
+      # @return [Array]
+      #   The stack of directory paths.
+      #
+      def template_dirs
+        @template_dirs ||= []
+      end
+
+      #
+      # The first path in {#template_dirs}, that will be used to search for
+      # other templates in.
+      #
+      # @return [String, nil]
+      #   Returns the first path in template_dirs, or `nil` if
+      #   template_dirs is empty.
+      #
+      def template_dir
+        template_dirs.first
+      end
+
+      #
+      # Finds the template within the {#template_dir} or uses
+      # `DataPaths::Finders#find_data_file` to search through all
+      # `data/` directories for the template.
+      #
+      # @param [String] sub_path
+      #   The relative path of the template to find.
+      #
+      # @return [String, nil]
+      #   Returns the absolute path to the template, or `nil` if the
+      #   template could not be found.
+      #
+      # @example
+      #   find_template 'sub/path/template.erb'
+      #
+      def find_template(sub_path)
+        sub_path = sub_path.to_s
+
+        if template_dir
+          path = File.expand_path(File.join(template_dir,sub_path))
+
+          return path if File.file?(path)
+        end
+
+        return find_data_file(sub_path)
+      end
+
+      #
+      # Finds the template, pushing the directory that the template resides
+      # within to {#template_dirs}, calls the given block and then pops
+      # the directory off of {#template_dirs}.
+      #
+      # @param [String] sub_path
+      #   The relative path of the template to find.
+      #
+      # @yield [path]
+      #   The block to be called after the directory of the template has
+      #   been pushed onto {#template_dirs}. After the block has returned,
+      #   the directory will be popped off of {#template_dirs}.
+      #
+      # @yieldparam [String] path
+      #   The absolute path of the template.
+      #
+      # @return [Object]
+      #   Result of the given block.
+      #
+      # @raise [RuntimeError]
+      #   The template was not found.
+      #
+      # @example
+      #   enter_template('sub/path/template.erb') do |path|
+      #     # do stuff with the full path
+      #   end
+      #
+      def enter_template(sub_path)
+        sub_path = sub_path.to_s
+
+        unless (path = find_template(sub_path))
+          raise(RuntimeError,"could not find template #{sub_path.dump}")
+        end
+
+        template_dirs.unshift(File.dirname(path))
+
+        result = yield(path)
+
+        template_dirs.shift
+        return result
+      end
+
+      #
+      # Finds and reads the contents of a template.
+      #
+      # @param [String] template_path
+      #   The relative path to the template.
+      #
+      # @yield [template]
+      #   The given block will receive the contents of the template.
+      #
+      # @yieldparam [String] template
+      #   The contents of the template.
+      #
+      # @example
+      #   read_template 'path/to/_include.txt'
+      #   # => "..."
+      #
+      # @example Calling read_template with a block
+      #   read_template 'path/to/_include.txt' do |contents|
+      #     # ...
+      #   end
+      #
+      def read_template(template_path)
+        enter_template(template_path) do |path|
+          contents = File.read(path)
+
+          if block_given?
+            yield(contents)
+          else
+            contents
+          end
+        end
+      end
+    end
+  end
+end

data/ronin-support.gemspec

@@ -0,0 +1,10 @@
+# -*- encoding: utf-8 -*-
+
+begin
+  Ore::Specification.new do |gemspec|
+    # custom logic here
+  end
+rescue NameError
+  STDERR.puts "The 'ronin-support.gemspec' file requires Ore."
+  STDERR.puts "Run `gem install ore-core` to install Ore."
+end

data/spec/extensions/file_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'ronin/extensions/file'
+
+describe File do
+  subject { File }
+
+  it "should provide File.escape_path" do
+    subject.should respond_to(:escape_path)
+  end
+
+  describe "escape_path" do
+    it "should remove null-bytes" do
+      File.escape_path("hello\0world\0").should == "helloworld"
+    end
+
+    it "should escape home-dir expansions" do
+      File.escape_path("hello/~world").should == "hello/\\~world"
+    end
+
+    it "should remove '.' and '..' directories" do
+      File.escape_path("hello/./../world").should == "world"
+    end
+  end
+end

data/spec/extensions/ip_addr_spec.rb

@@ -0,0 +1,171 @@
+require 'spec_helper'
+require 'ronin/extensions/ip_addr'
+
+describe IPAddr do
+  describe "extract" do
+    context "ipv4" do
+      it "should extract a single IPv4 address" do
+        addr = '127.0.0.1'
+
+        IPAddr.extract(addr,:ipv4).should == [addr]
+      end
+
+      it "should extract multiple IPv4 addresses" do
+        addrs = %w[127.0.0.1 192.168.0.1]
+        text = "#{addrs[0]} #{addrs[1]}"
+
+        IPAddr.extract(text,:ipv4).should == addrs
+      end
+
+      it "should extract IPv4 addresses from text" do
+        addr = '127.0.0.1'
+        text = "ip (#{addr})"
+
+        IPAddr.extract(text,:ipv4).should == [addr]
+      end
+
+      it "should ignore leading periods" do
+        addr = '127.0.0.1'
+        text = ".#{addr}"
+
+        IPAddr.extract(text,:ipv4).should == [addr]
+      end
+
+      it "should ignore tailing periods" do
+        addr = '127.0.0.1'
+        text = "#{addr}."
+
+        IPAddr.extract(text,:ipv4).should == [addr]
+      end
+
+      it "should ignore less than 3 octet IPv4 addresses" do
+        text = '127.0.0. 1'
+
+        IPAddr.extract(text,:ipv4).should be_empty
+      end
+
+      it "should ignore IPv4 addresses with more than 3 diget octets" do
+        text = '127.1111.0.1'
+
+        IPAddr.extract(text,:ipv4).should be_empty
+      end
+    end
+
+    context "ipv6" do
+      it "should extract a single IPv6 address" do
+        addr = 'fe80:0000:0000:0000:0204:61ff:fe9d:f156'
+
+        IPAddr.extract(addr,:ipv6).should == [addr]
+      end
+
+      it "should extract multiple IPv6 addresses" do
+        addrs = %w[::1 fe80:0000:0000:0000:0204:61ff:fe9d:f156]
+        text = "#{addrs[0]} #{addrs[1]}"
+
+        IPAddr.extract(text,:ipv6).should == addrs
+      end
+
+      it "should extract collapsed IPv6 addresses" do
+        addr = 'fe80::0204:61ff:fe9d:f156'
+        text = ":: #{addr} ::"
+
+        IPAddr.extract(text,:ipv6).should == [addr]
+      end
+
+      it "should extract IPv6 addresses from text" do
+        addr = 'fe80:0000:0000:0000:0204:61ff:fe9d:f156'
+        text = "hello #{addr} world"
+
+        IPAddr.extract(text,:ipv6).should == [addr]
+      end
+
+      it "should extract trailing IPv4 suffixes" do
+        addr = 'fe80:0000:0000:0000:0204:61ff:fe9d:f156:222.1.1.1'
+        text = "#{addr} 1.1.1.1"
+
+        IPAddr.extract(text,:ipv6).should == [addr]
+      end
+
+      it "should extract short-hand IPv6 addresses" do
+        addr = '::f0:0d'
+        text = "ipv6: #{addr}"
+
+        IPAddr.extract(text,:ipv6).should == [addr]
+      end
+    end
+
+    it "should extract both IPv4 and IPv6 addresses" do
+      ipv4 = '127.0.0.1'
+      ipv6 = '::1'
+      text = "ipv4: #{ipv4}, ipv6: #{ipv6}"
+
+      IPAddr.extract(text).should == [ipv4, ipv6]
+    end
+
+    it "should ignore non-IP addresses" do
+      text = 'one :: two.three.'
+
+      IPAddr.extract(text).should be_empty
+    end
+  end
+
+  describe "CIDR addresses" do
+    let(:fixed_addr) { IPAddr.new('10.1.1.2') }
+    let(:class_c) { IPAddr.new('10.1.1.2/24') }
+
+    it "should only iterate over one IP address for an address" do
+      addresses = fixed_addr.map { |ip| IPAddr.new(ip) }
+
+      addresses.length.should == 1
+      fixed_addr.should include(addresses.first)
+    end
+
+    it "should iterate over all IP addresses contained within the IP range" do
+      class_c.each do |ip|
+        class_c.should include(IPAddr.new(ip))
+      end
+    end
+
+    it "should return an Enumerator when no block is given" do
+      class_c.each.all? { |ip|
+        class_c.include?(IPAddr.new(ip))
+      }.should == true
+    end
+  end
+
+  describe "globbed addresses" do
+    let(:ipv4_range) { '10.1.1-5.1' }
+    let(:ipv6_range) { '::ff::02-0a::c3' }
+
+    it "should iterate over all IP addresses in an IPv4 range" do
+      IPAddr.each(ipv4_range) do |ip|
+        ip.should =~ /^10\.1\.[1-5]\.1$/
+      end
+    end
+
+    it "should iterate over all IP addresses in an IPv6 range" do
+      IPAddr.each(ipv6_range) do |ip|
+        ip.should =~ /^::ff::0[2-9a]::c3$/
+      end
+    end
+
+    it "should return an Enumerator when no block is given" do
+      ips = IPAddr.each(ipv4_range)
+      
+      ips.all? { |ip| ip =~ /^10\.1\.[1-5]\.1$/ }.should == true
+    end
+  end
+
+  let(:ip) { IPAddr.new(Resolv.getaddress('www.example.com')) }
+  let(:bad_ip) { IPAddr.new('0.0.0.0') }
+
+  describe "lookup" do
+    it "should lookup the host-name for an IP" do
+      ip.lookup.should == ['www.example.com']
+    end
+
+    it "should return an empty Array for unknown IP addresses" do
+      bad_ip.lookup.should be_empty
+    end
+  end
+end