ronin 0.1.4 → 0.2.0

data/lib/ronin/platform/platform.rb

@@ -0,0 +1,195 @@
+#
+#--
+# Ronin - A Ruby platform designed for information security and data
+# exploration tasks.
+#
+# Copyright (c) 2006-2009 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/platform/exceptions/overlay_not_found'
+require 'ronin/platform/overlay_cache'
+require 'ronin/platform/object_cache'
+require 'ronin/platform/extension_cache'
+
+module Ronin
+  module Platform
+    #
+    # Load the overlay cache from the given _path_. If a _block_ is
+    # given it will be passed the current overlay cache.
+    #
+    #   Overlay.load_overlays('/custom/overlays/cache.yaml')
+    #   # => #<Ronin::Platform::OverlayCache: ...>
+    #
+    def Platform.load_overlays(path)
+      @@ronin_overlay_cache = OverlayCache.new(path)
+    end
+
+    #
+    # Returns the current overlay cache, or loads the default overlay
+    # cache if not already loaded.
+    #
+    def Platform.overlays
+      @@ronin_overlay_cache ||= OverlayCache.new
+    end
+
+    #
+    # Adds a new Overlay with the given _options_. If a _block_ is given
+    # it will be passed the newly added overlay.
+    #
+    # _options_ must contain the following key:
+    # <tt>:path</tt>:: The path of the overlay.
+    #
+    # _options_ may contain the following key:
+    # <tt>:media</tt>:: The media of the overlay.
+    # <tt>:uri</tt>:: The URI of the overlay.
+    #
+    def Platform.add(options={},&block)
+      path = options[:path]
+
+      unless path
+        raise(ArgumentError,":path must be passed to Platform.add",caller)
+      end
+
+      path = path.to_s
+
+      unless File.directory?(path)
+        raise(OverlayNotFound,"overlay #{path.dump} cannot be found",caller)
+      end
+
+      media = options[:media]
+      uri = options[:uri]
+
+      overlay = Overlay.new(path,media,uri)
+
+      Platform.overlays.add(overlay) do
+        ObjectCache.cache(overlay.objects_dir)
+      end
+
+      return overlay
+    end
+
+    #
+    # Installs an Overlay specified by _options_ into the
+    # OverlayCache::CACHE_DIR. If a _block_ is given, it will be
+    # passed the newly created overlay after it has been added to
+    # the overlay cache.
+    #
+    # _options_ must contain the following key:
+    # <tt>:uri</tt>:: The URI of the overlay.
+    #
+    # _options_ may contain the following key:
+    # <tt>:media</tt>:: The media of the overlay.
+    #
+    def Platform.install(options={},&block)
+      options = options.merge(:into => OverlayCache::CACHE_DIR)
+
+      Repertoire.checkout(options) do |path,media,uri|
+        return Platform.add(:path => path, :media => media, :uri => uri)
+      end
+    end
+
+    #
+    # Updates all previously installed overlays. If a _block_ is given
+    # it will be called after the overlays have been updated.
+    #
+    def Platform.update(&block)
+      Platform.overlays.update do |overlay|
+        ObjectCache.mirror(overlay.objects_dir)
+      end
+
+      block.call if block
+      return nil
+    end
+
+    #
+    # Removes the overlay with the specified _name_. If no overlay
+    # has the specified _name_, an OverlayNotFound exception will be
+    # raised. If a _block_ is given, it will be called after the overlay
+    # has been removed.
+    #
+    def Platform.remove(name,&block)
+      Platform.overlays.remove(name,&block)
+      return nil
+    end
+
+    #
+    # Uninstalls the overlay with the specified _name_. If no overlay
+    # has the specified _name_, an OverlayNotFound exception will be
+    # raised. If a _block_ is given, it will be called after the overlay
+    # has been uninstalled.
+    #
+    def Platform.uninstall(name,&block)
+      Platform.remove(name) do |overlay|
+        ObjectCache.expunge(overlay.objects_dir)
+      end
+
+      block.call if block
+      return nil
+    end
+
+    #
+    # Returns the names of all extensions within the overlay cache.
+    #
+    def Platform.extension_names
+      names = []
+
+      Platform.overlays.each_overlay do |overlay|
+        overlay.extensions.each do |name|
+          names << name unless names.include?(name)
+        end
+      end
+
+      return names
+    end
+
+    #
+    # Returns +true+ if the cache has the extension with the matching
+    # _name_, returns +false+ otherwise.
+    #
+    def Platform.has_extension?(name)
+      Platform.overlays.each_overlay do |overlay|
+        return true if overlay.has_extension?(name)
+      end
+
+      return false
+    end
+
+    #
+    # Returns a +Hash+ of all loaded extensions. Extensions can be loaded
+    # on-the-fly by accessing the +Hash+.
+    #
+    #   Platform.extensions['shellcode']
+    #   # => #<Ronin::Platform::Extension: ...>
+    #
+    def Platform.extensions
+      @@ronin_extension_cache ||= ExtensionCache.new
+    end
+
+    #
+    # Loads the extension with the specified _name_. If a _block_ is given
+    # it will be passed the loaded extension. If the extension cannot be
+    # loaded, an ExtensionNotFound exception will be raised.
+    #
+    def Platform.extension(name,&block)
+      ext = Platform.extensions[name]
+
+      block.call(ext) if block
+      return ext
+    end
+  end
+end

data/lib/ronin/{cache → platform}/ronin.rb

@@ -21,27 +21,28 @@
 #++
 #
 
-require 'ronin/cache/cache'
+require 'ronin/platform/platform'
 
 module Ronin
   protected
 
   #
-  # Provides transparent access to Cache.extension.
+  # Provides transparent access to Platform.extension.
   #
-  #   Ronin.shellcode # => Cache::Extension
+  #   Ronin.shellcode
+  #   # => #<Ronin::Platform::Extension: ...>
   #
   #   Ronin.shellcode do |ext|
   #     ...
   #   end
   #
   def Ronin.method_missing(sym,*args,&block)
-    if args.length==0
+    if args.length == 0
       name = sym.id2name
 
       # return an extension if available
-      if Cache.has_extension?(name)
-        return Cache.extension(name,&block)
+      if Platform.has_extension?(name)
+        return Platform.extension(name,&block)
       end
     end
 

data/lib/ronin/target.rb

@@ -20,7 +20,7 @@
 #
 
 require 'ronin/model'
-require 'ronin/platform'
+require 'ronin/os'
 require 'ronin/arch'
 
 module Ronin
@@ -31,14 +31,14 @@ module Ronin
     # Primary key
     property :id, Serial
 
-    # Targeted platform
-    belongs_to :platform
-
     # Targeted architecture
     belongs_to :arch
 
+    # Targeted OS
+    belongs_to :os, :class_name => 'OS'
+
     # Validates
-    validates_present :platform, :arch
+    validates_present :arch, :os
 
   end
 end

data/lib/ronin/ui.rb

@@ -21,5 +21,8 @@
 #++
 #
 
-require 'ronin/ui/console'
+require 'ronin/ui/diagnostics'
 require 'ronin/ui/hexdump'
+require 'ronin/ui/console'
+require 'ronin/ui/shell'
+

data/lib/ronin/ui/command_line/command_line.rb

@@ -21,7 +21,6 @@
 #++
 #
 
-require 'ronin/ui/command_line/command'
 require 'ronin/ui/command_line/commands/default'
 require 'ronin/ui/command_line/exceptions/unknown_command'
 require 'ronin/ui/console'

data/lib/ronin/ui/command_line/commands/add.rb

@@ -22,7 +22,7 @@
 #
 
 require 'ronin/ui/command_line/command'
-require 'ronin/cache/overlay'
+require 'ronin/platform/overlay'
 
 module Ronin
   module UI
@@ -31,10 +31,22 @@ module Ronin
 
         command :add
 
+        def initialize
+          @cache = nil
+          @media = nil
+          @uri = nil
+
+          super
+        end
+
         def define_options(opts)
           opts.usage = 'PATH [options]'
 
           opts.options do
+            opts.on('-C','--cache DIR','Specify an alternate overlay cache') do |dir|
+              @cache = dir
+            end
+
             opts.on('-m','--media MEDIA','Spedify the media-type of the overlay') do |media|
               @media = media
             end
@@ -60,12 +72,15 @@ module Ronin
             fail('only one overlay path maybe specified')
           end
 
-          path = args.first
+          Platform.load_overlays(@cache) if @cache
 
-          Cache::Overlay.save_cache do
-            Cache::Overlay.add(path,@media,@uri) do |overlay|
-              puts "Overlay #{overlay.name.dump} added."
-            end
+          overlay_options = {:path => path.first}
+
+          overlay_options[:media] = @media if @media
+          overlay_options[:uri] = @uri if @uri
+
+          Platform.add(overlay_options) do |overlay|
+            puts "Overlay #{overlay.name.dump} added."
           end
         end
 

data/lib/ronin/ui/command_line/commands/default.rb

@@ -22,7 +22,8 @@
 #
 
 require 'ronin/ui/command_line/command'
-require 'ronin/cache/overlay'
+require 'ronin/ui/console'
+require 'ronin/database'
 
 module Ronin
   module UI
@@ -32,6 +33,10 @@ module Ronin
         def define_options(opts)
           opts.usage = '<command> [options]'
           opts.options do
+            opts.on('-d','--database URI','The URI for the Database') do |uri|
+              Database.config = uri.to_s
+            end
+
             opts.on('-r','--require LIB','require the specified library or path') do |lib|
               Console.auto_load << lib.to_s
             end

data/lib/ronin/ui/command_line/commands/extension.rb

@@ -22,7 +22,7 @@
 #
 
 require 'ronin/ui/command_line/command'
-require 'ronin/cache/extension'
+require 'ronin/platform/extension'
 require 'ronin/config'
 
 require 'fileutils'
@@ -54,8 +54,8 @@ module Ronin
         def arguments(*args)
           args.each do |path|
             path = File.expand_path(path)
-            extension_path = File.join(path,Cache::Extension::EXTENSION_FILE)
-            lib_dir = File.join(path,Cache::Extension::LIB_DIR)
+            extension_path = File.join(path,Platform::Extension::EXTENSION_FILE)
+            lib_dir = File.join(path,Platform::Extension::LIB_DIR)
             template_path = File.join(Config::STATIC_DIR,'extension.rb')
 
             FileUtils.mkdir_p(path)

data/lib/ronin/ui/command_line/commands/install.rb

@@ -22,7 +22,7 @@
 #
 
 require 'ronin/ui/command_line/command'
-require 'ronin/cache/overlay'
+require 'ronin/platform/overlay'
 
 module Ronin
   module UI
@@ -31,10 +31,21 @@ module Ronin
 
         command :install
 
+        def initialize
+          @cache = nil
+          @media = nil
+
+          super
+        end
+
         def define_options(opts)
           opts.usage = 'URI [options]'
 
           opts.options do
+            opts.on('-C','--cache DIR','Specify an alternate overlay cache') do |dir|
+              @cache = dir
+            end
+
             opts.on('-m','--media [MEDIA]','Spedify the media-type of the overlay') do |media|
               @media = media
             end
@@ -54,10 +65,10 @@ module Ronin
 
           uri = args.first
 
-          Cache::Overlay.save_cache do
-            Cache::Overlay.install(:uri => uri, :media => @media) do |overlay|
-              puts "Overlay #{overlay.name.dump} has been installed."
-            end
+          Platform.load_overlays(@cache) if @cache
+
+          Platform.install(:uri => uri, :media => @media) do |overlay|
+            puts "Overlay #{overlay.name.dump} has been installed."
           end
         end
 

data/lib/ronin/ui/command_line/commands/list.rb

@@ -22,7 +22,7 @@
 #
 
 require 'ronin/ui/command_line/command'
-require 'ronin/cache/overlay'
+require 'ronin/platform/overlay'
 
 module Ronin
   module UI
@@ -31,10 +31,21 @@ module Ronin
 
         command :list, :ls
 
+        def initialize
+          @cache = nil
+          @verbose = false
+
+          super
+        end
+
         def define_options(opts)
           opts.usage = '[NAME ...] [options]'
 
           opts.options do
+            opts.on('-C','--cache DIR','Specify an alternate overlay cache') do |dir|
+              @cache = dir
+            end
+
             opts.on('-v','--verbose','Enable verbose output') do
               @verbose = true
             end
@@ -48,15 +59,20 @@ module Ronin
         end
 
         def arguments(*args)
+          Platform.load_overlays(@cache) if @cache
+
           if args.empty?
-            # list all repositories by name
-            Cache::Overlay.each { |overlay| puts "  #{overlay}" }
+            # list all overlays by name
+            Platform.overlays.each_overlay do |overlay|
+              puts "  #{overlay}"
+            end
+
             return
           end
 
-          # list specified repositories
+          # list specified overlays
           args.each do |name|
-            overlay = Cache::Overlay.get(name)
+            overlay = Platform.overlays.get(name)
 
             puts "[ #{overlay.name} ]\n\n"
 
@@ -65,6 +81,12 @@ module Ronin
             puts "  URI: #{overlay.uri}" if overlay.uri
 
             if @verbose
+              putc "\n"
+
+              if overlay.title
+                puts "  Title: #{overlay.title}"
+              end
+
               if overlay.source
                 puts "  Source URI: #{overlay.source}"
               end
@@ -79,16 +101,17 @@ module Ronin
 
               unless overlay.extensions.empty?
                 puts "  Extensions:\n\n"
-                overlay.each_extension { |ext| puts "    #{ext}" }
+                overlay.extensions.each { |ext| puts "    #{ext}" }
+                putc "\n"
               end
 
               if overlay.description
                 puts "  Description:\n\n    #{overlay.description}\n\n"
               else
-                puts "\n"
+                putc "\n"
               end
             else
-              puts "\n"
+              putc "\n"
             end
           end
         end