ronin 0.0.9

data/lib/ronin/cache/overlay_cache.rb

@@ -0,0 +1,228 @@
+#
+#--
+# Ronin - A Ruby platform designed for information security and data
+# exploration tasks.
+#
+# Copyright (c) 2006-2008 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
+#++
+#
+
+require 'ronin/cache/exceptions/overlay_cached'
+require 'ronin/cache/exceptions/overlay_not_found'
+require 'ronin/cache/overlay'
+require 'ronin/cache/config'
+
+require 'yaml'
+
+module Ronin
+  module Cache
+    class OverlayCache < Hash
+
+      # Path of cache file
+      attr_reader :path
+
+      #
+      # Create a new Cache object with the specified _path_. The _path_
+      # defaults to <tt>Config::REPOSITORY_CACHE_PATH</tt>. If a _block_ is
+      # given, it will be passed the newly created Cache object.
+      #
+      def initialize(path=Config::REPOSITORY_CACHE_PATH,&block)
+        super()
+
+        @path = File.expand_path(path)
+
+        if File.file?(@path)
+          File.open(@path) do |file|
+            descriptions = YAML.load(file)
+
+            if descriptions.kind_of?(Array)
+              descriptions.each do |repo|
+                if repo.kind_of?(Hash)
+                  add(Overlay.new(repo[:path],repo[:media],repo[:uri]))
+                end
+              end
+            end
+          end
+        end
+
+        block.call(self) if block
+      end
+
+      #
+      # Returns the names of the overlays within the cache.
+      #
+      def names
+        keys
+      end
+
+      #
+      # Returns the overlays within the cache.
+      #
+      def overlays
+        values
+      end
+
+      #
+      # Iterates over each overlay in the overlay cache, passing
+      # each to the given specified _block_.
+      #
+      def each_overlay(&block)
+        each_value(&block)
+      end
+
+      #
+      # Returns the Ovlerays which match the specified _block_.
+      #
+      #   cache.overlays_with do |repo|
+      #     repo.author == 'the dude'
+      #   end
+      #
+      def overlays_with(&block)
+        values.select(&block)
+      end
+
+      #
+      # Returns +true+ if the cache contains the Overlay with the
+      # matching _name_, returns +false+ otherwise.
+      #
+      def has_overlay?(name)
+        has_key?(name.to_s)
+      end
+
+      #
+      # Returns the Overlay with the matching _name_.
+      #
+      def get_overlay(name)
+        name = name.to_s
+
+        unless has_overlay?(name)
+          raise(OverlayNotFound,"overlay #{name.dump} is not present in cache #{self.to_s.dump}",caller)
+        end
+
+        return self[name]
+      end
+
+      #
+      # Returns the paths of the Overlays contained in the cache.
+      #
+      def paths
+        overlays.map { |repo| repo.path }
+      end
+
+      #
+      # Adds the _repo_ to the cache. If a _block_ is given, it will
+      # be passed the cache after the _repo_ is added. The _repo_
+      # will be returned.
+      #
+      #   cache.add(repo) # => Overlay
+      #
+      #   cache.add(repo) do |cache|
+      #     puts "Overlay #{repo} added"
+      #   end
+      #
+      def add(repo,&block)
+        if has_overlay?(repo.name)
+          raise(OverlayCached,"overlay #{repo.to_s.dump} already present in the cache #{self.to_s.dump}",caller)
+        end
+
+        self[repo.name.to_s] = repo
+
+        block.call(self) if block
+        return self
+      end
+
+      #
+      # Removes the _repo_ from the cache. If a _block_ is given, it
+      # will be passed the cache. The cache will be returned, after the
+      # _repo_ is removed.
+      #
+      #   cache.remove(repo) # => Cache
+      #
+      #   cache.remove(repo) do |cache|
+      #     puts "Overlay #{repo} removed"
+      #   end
+      #
+      def remove(repo,&block)
+        unless has_overlay?(repo.name)
+          raise(OverlayNotFound,"overlay #{repo.to_s.dump} is not present in the cache #{to_s.dump}",caller)
+        end
+
+        delete_if { |key,value| key==repo.name }
+
+        block.call(self) if block
+        return self
+      end
+
+      #
+      # Updates all the cached Overlays. If a _block_ is given it will
+      # be passed the cache.
+      #
+      #   update # => Cache
+      #
+      #   update do |cache|
+      #     puts "#{cache} is updated"
+      #   end
+      #
+      def update(&block)
+        repos.each { |repo| repo.update }
+
+        block.call(self) if block
+        return self
+      end
+
+      #
+      # Saves the cache to the given _output_path_, where _output_path_
+      # defaults to +@path+. If a _block_ is given, it will be passed
+      # the cache before the cache has been saved.
+      #
+      def save(output_path=@path,&block)
+        parent_dir = File.dirname(output_path)
+
+        unless File.directory?(parent_dir)
+          FileUtils.mkdir_p(parent_dir)
+        end
+
+        block.call(self) if block
+
+        File.open(output_path,'w') do |output|
+          descriptions = overlays.map do |repo|
+            {:media_type => repo.media_type, :path => repo.path, :uri => repo.uri}
+          end
+
+          YAML.dump(descriptions,output)
+        end
+
+        return self
+      end
+
+      #
+      # Adds the specified _repo_ to the cache.
+      #
+      def <<(repo)
+        self[repo.name.to_s] = repo
+      end
+
+      #
+      # Returns the +path+ of the cache.
+      #
+      def to_s
+        @path.to_s
+      end
+
+    end
+  end
+end

data/lib/ronin/cache/ronin.rb

@@ -0,0 +1,50 @@
+#
+#--
+# Ronin - A Ruby platform designed for information security and data
+# exploration tasks.
+#
+# Copyright (c) 2006-2008 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
+#++
+#
+
+require 'ronin/cache/cache'
+
+module Ronin
+  protected
+
+  #
+  # Provides transparent access to Cache.extension.
+  #
+  #   Ronin.shellcode # => Cache::Extension
+  #
+  #   Ronin.shellcode do |ext|
+  #     ...
+  #   end
+  #
+  def Ronin.method_missing(sym,*args,&block)
+    if args.length==0
+      name = sym.id2name
+
+      # return an extension if available
+      if Cache.has_extension?(name)
+        return Cache.extension(name,&block)
+      end
+    end
+
+    return super(sym,*args,&block)
+  end
+end

data/lib/ronin/chars.rb

@@ -0,0 +1,25 @@
+#
+#--
+# Ronin - A Ruby platform designed for information security and data
+# exploration tasks.
+#
+# Copyright (c) 2006-2008 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
+#++
+#
+
+require 'ronin/chars/char_set'
+require 'ronin/chars/chars'

data/lib/ronin/chars/char_set.rb

@@ -0,0 +1,121 @@
+#
+#--
+# Ronin - A Ruby platform designed for information security and data
+# exploration tasks.
+#
+# Copyright (c) 2006-2008 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
+#++
+#
+
+module Ronin
+  module Chars
+    class CharSet < Array
+
+      #
+      # Creates a new CharSet object with the given _characters_.
+      #
+      def initialize(*characters)
+        format_char = lambda { |char|
+          if char.kind_of?(Integer)
+            char.chr
+          else
+            char.to_s
+          end
+        }
+
+        characters = characters.flatten.map do |char|
+          if char.kind_of?(Range)
+            char.to_a.map(&format_char)
+          else
+            format_char.call(char)
+          end
+        end
+
+        super(characters.flatten.uniq)
+      end
+
+      #
+      # Create a new CharSet object containing the characters that match
+      # the given _block_.
+      #
+      def select(&block)
+        CharSet.new(super(&block))
+      end
+
+      #
+      # Creates a new CharSet object by passing each character to the
+      # specified _block_.
+      #
+      def map(&block)
+        CharSet.new(super(&block))
+      end
+
+      #
+      # Returns a random char from the character set.
+      #
+      def random_char
+        self[rand(self.length)]
+      end
+
+      #
+      # Pass a random character to the specified _block_, _n_ times.
+      #
+      def each_random_char(n,&block)
+        n.to_i.times { block.call(random_char) }
+      end
+
+      #
+      # Returns an Array of the specified _length_ containing
+      # random characters from the character set.
+      #
+      def random_array(length)
+        if length.kind_of?(Range)
+          return Array.new(length.sort_by { rand }.first) { random_char }
+        else
+          return Array.new(length.to_i) { random_char }
+        end
+      end
+
+      #
+      # Returns a String of the specified _length_ containing
+      # random characters from the character set.
+      #
+      def random_string(length)
+        random_array(length).join
+      end
+
+      #
+      # Return a new CharSet that is the union of the character set and the
+      # specified _other_set_.
+      #
+      def |(other_set)
+        CharSet.new(self,other_set)
+      end
+
+      alias + |
+
+      #
+      # Returns a new CharSet that is the intersection of the character set
+      # and the specified _other_set_.
+      #
+      def -(other_set)
+        CharSet.new(super(other_set.to_a))
+      end
+
+    end
+  end
+end

data/lib/ronin/chars/chars.rb

@@ -0,0 +1,180 @@
+#
+#--
+# Ronin - A Ruby platform designed for information security and data
+# exploration tasks.
+#
+# Copyright (c) 2006-2008 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
+#++
+#
+
+require 'ronin/chars/char_set'
+
+module Ronin
+  module Chars
+    # The numeric decimal character set
+    NUMERIC = CharSet.new('0'..'9')
+
+    # The octal character set
+    OCTAL = CharSet.new('0'..'7')
+
+    # The upper-case hexadecimal character set
+    UPPERCASE_HEXADECIMAL = NUMERIC + ('A'..'F')
+
+    # The lower-case hexadecimal character set
+    LOWERCASE_HEXADECIMAL = NUMERIC + ('a'..'f')
+
+    # The hexadecimal character set
+    HEXADECIMAL = UPPERCASE_HEXADECIMAL + LOWERCASE_HEXADECIMAL
+
+    # The upper-case alpha character set
+    UPPERCASE_ALPHA = CharSet.new('A'..'Z')
+
+    # The lower-case alpha character set
+    LOWERCASE_ALPHA = CharSet.new('a'..'z')
+
+    # The alpha character set
+    ALPHA = UPPERCASE_ALPHA + LOWERCASE_ALPHA
+
+    # The alpha-numeric character set
+    ALPHA_NUMERIC = ALPHA + NUMERIC
+
+    # The space character set
+    SPACE = CharSet.new(' ', "\f", "\n", "\r", "\t", "\v")
+
+    # The punctuation character set
+    PUNCTUATION = CharSet.new(' ', '\'', '"', '`', ',', ';', ':', '~', '-',
+                              '(', ')', '[', ']', '{', '}', '.', '?', '!')
+
+    # The symbolic character set
+    SYMBOLS = PUNCTUATION + ['@', '#', '$', '%', '^', '&', '*', '_', '+',
+                             '=', '|', '\\', '<', '>', '/']
+
+    # The control-char character set
+    CONTROL = CharSet.new(0..0x1f, 0x7f)
+
+    # The ASCII character set
+    ASCII = CharSet.new(0..0x7f)
+
+    # The full 8-bit character set
+    ALL = CharSet.new(0..0xff)
+
+    #
+    # The numeric decimal character set.
+    #
+    def Chars.numeric
+      NUMERIC
+    end
+
+    #
+    # The octal character set.
+    #
+    def Chars.octal
+      OCTAL
+    end
+
+    #
+    # The upper-case hexadecimal character set.
+    #
+    def Chars.uppercase_hexadecimal
+      UPPERCASE_HEXADECIMAL
+    end
+
+    #
+    # The lower-case hexadecimal character set.
+    #
+    def Chars.lowercase_hexadecimal
+      LOWERCASE_HEXADECIMAL
+    end
+
+    #
+    # The hexadecimal character set.
+    #
+    def Chars.hexadecimal
+      HEXADECIMAL
+    end
+
+    #
+    # The upper-case alpha character set.
+    #
+    def Chars.uppercase_alpha
+      UPPERCASE_ALPHA
+    end
+
+    #
+    # The lower-case alpha character set.
+    #
+    def Chars.lowercase_alpha
+      LOWERCASE_ALPHA
+    end
+
+    #
+    # The alpha character set.
+    #
+    def Chars.alpha
+      ALPHA
+    end
+
+    #
+    # The alpha-numeric character set.
+    #
+    def Chars.alpha_numeric
+      ALPHA_NUMERIC
+    end
+
+    #
+    # The space character set.
+    #
+    def Chars.space
+      SPACE
+    end
+
+    #
+    # The punctuation character set.
+    #
+    def Chars.puncation
+      PUNCTUATION
+    end
+
+    #
+    # The symbolic character set.
+    #
+    def Chars.symbols
+      SYMBOLS
+    end
+
+    #
+    # The control-char character set.
+    #
+    def Chars.control
+      CONTROL
+    end
+
+    #
+    # The ASCII character set.
+    #
+    def Chars.ascii
+      ASCII
+    end
+
+    #
+    # The full 8-bit character set.
+    #
+    def Chars.all
+      ALL
+    end
+  end
+end