ronin 0.3.0 → 1.0.0.pre1

data/lib/ronin/platform/platform.rb

@@ -1,304 +0,0 @@
-#
-# Ronin - A Ruby platform for exploit development and security research.
-#
-# 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'
-
-require 'uri'
-
-module Ronin
-  module Platform
-    #
-    # Load the overlay cache.
-    #
-    # @param [String] path
-    #   The optional path to the overlay cache file.
-    #
-    # @return [OverlayCache]
-    #   The newly loaded overlay cache.
-    #
-    # @example
-    #   Overlay.load_overlays
-    #   # => #<Ronin::Platform::OverlayCache: ...>
-    #
-    # @example
-    #   Overlay.load_overlays('/custom/overlays/cache.yaml')
-    #   # => #<Ronin::Platform::OverlayCache: ...>
-    #
-    def Platform.load_overlays(path=OverlayCache::CACHE_FILE)
-      @@ronin_overlay_cache = OverlayCache.new(path)
-    end
-
-    #
-    # @return [OverlayCache]
-    #   The current overlay cache. If no overlay cache is present, the
-    #   default overlay will be loaded.
-    #
-    def Platform.overlays
-      @@ronin_overlay_cache ||= OverlayCache.new
-    end
-
-    #
-    # Adds a new overlay to the overlay cache.
-    #
-    # @param [Hash] options
-    #   Additional options.
-    #
-    # @option options [String] :path
-    #   A pre-existing path to the overlay.
-    #
-    # @option options [Symbol] :media
-    #   The media type of the overlay, may be either +:git+, +:hg+,
-    #   +:svn+ or +:rsync+.
-    #
-    # @option options [String, URI::HTTP, URI::HTTPS] uri
-    #   The URI of the overlay.
-    #
-    # @yield [overlay]
-    #   If a block is given, it will be passed the overlay after it has
-    #   been added to the cache.
-    #
-    # @yieldparam [Overlay] overlay
-    #   The newly added overlay.
-    #
-    # @return [Overlay]
-    #   The newly added overlay.
-    #
-    # @raise [ArgumentError]
-    #   The +:path+ option was not specified.
-    #
-    # @raise [OverlayNotFound]
-    #   The +:path+ option did not represent a valid directory.
-    #
-    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 |overlay|
-        ObjectCache.cache(overlay.objects_dir)
-      end
-
-      block.call(overlay) if block
-      return overlay
-    end
-
-    #
-    # Installs an overlay into the OverlayCache::CACHE_DIR and adds it
-    # to the overlay cache.
-    #
-    # @param [Hash] options
-    #   Additional options.
-    #
-    # @option options [String, URI::HTTP, URI::HTTPS] :uri
-    #   The URI to the overlay.
-    #
-    # @option options [Symbol] :media
-    #   The media type of the overlay, may be either +:git+, +:hg+,
-    #   +:svn+ or +:rsync+.
-    #
-    # @yield [overlay]
-    #   If a block is given, it will be passed the overlay, after it has
-    #   been installed.
-    #
-    # @yieldparam [Overlay] overlay
-    #   The newly installed overlay.
-    #
-    # @return [Overlay]
-    #   The newly installed overlay.
-    #
-    # @raise [ArgumentError]
-    #   The +:uri+ option must be specified.
-    #
-    def Platform.install(options={},&block)
-      unless options[:uri]
-        raise(ArgumentError,":uri must be passed to Platform.install",caller)
-      end
-
-      uri = options[:uri].to_s
-      host = (URI(uri).host || 'localhost')
-      host_dir = File.join(OverlayCache::CACHE_DIR,host)
-      options = options.merge(:into => host_dir)
-
-      Repertoire.checkout(options) do |repo|
-        return Platform.add(
-          :path => repo.path,
-          :media => repo.media_name,
-          :uri => uri,
-          &block
-        )
-      end
-    end
-
-    #
-    # Updates all previously installed overlays within the overlay cache.
-    #
-    # @yield []
-    #   If a block is given, it will be called after all overlays have been
-    #   updated within the cache.
-    #
-    def Platform.update(&block)
-      Platform.overlays.update do |overlay|
-        ObjectCache.mirror(overlay.objects_dir)
-      end
-
-      block.call if block
-      return nil
-    end
-
-    #
-    # Removes an overlay from the overlay cache, but leaves the contents
-    # of the overlay intact.
-    #
-    # @param [String] name
-    #   The name of the overlay to remove.
-    #
-    # @yield [overlay]
-    #   If a block is given, it will be passed the overlay after it has
-    #   been removed.
-    #
-    # @yieldparam [Overlay] overlay
-    #   The removed overlay.
-    #
-    # @raise [OverlayNotFound]
-    #   The overlay with the specified _name_ could not be found in the
-    #   overlay cache.
-    #
-    def Platform.remove(name,&block)
-      Platform.overlays.remove(name,&block)
-      return nil
-    end
-
-    #
-    # Uninstalls an overlay from the overlay cache, and deletes the
-    # contents of the overlay.
-    #
-    # @param [String] name
-    #   The name of the overlay to uninstall.
-    #
-    # @yield []
-    #   If a block is given, it will be called after the overlay has been
-    #   uninstalled.
-    #
-    # @raise [OverlayNotFound]
-    #   The overlay with the specified _name_ could not be found in the
-    #   overlay cache.
-    #
-    def Platform.uninstall(name,&block)
-      Platform.overlays.uninstall(name) do |overlay|
-        ObjectCache.clean(overlay.objects_dir)
-      end
-
-      block.call() if block
-      return nil
-    end
-
-    #
-    # @return [Array]
-    #   The names of all extensions within the overlays in the overlay
-    #   cache.
-    #
-    def Platform.extension_names
-      Platform.overlays.extensions
-    end
-
-    #
-    # Searches for the extension with the specified _name_, in all
-    # overlays within the overlay cache.
-    #
-    # @param [String] name
-    #   The name of the extension to search for.
-    #
-    # @return [Boolean]
-    #   Specifies whether the overlay cache contains the extension with
-    #   the matching _name_.
-    #
-    def Platform.has_extension?(name)
-      Platform.overlays.has_extension?(name)
-    end
-
-    #
-    # The extension cache.
-    #
-    # @return [ExtensionCache]
-    #   The extension cache of all currently loaded extensions.
-    #
-    # @example
-    #   Platform.extensions['shellcode']
-    #   # => #<Ronin::Platform::Extension: ...>
-    #
-    def Platform.extensions
-      @@ronin_extension_cache ||= ExtensionCache.new
-    end
-
-    #
-    # Loads an extension into the extension cache, if it has yet to be
-    # loaded.
-    #
-    # @param [String] name
-    #   The name of the desired extension.
-    #
-    # @yield [ext]
-    #   If a block is given, it will be passed the extension with the
-    #   matching _name_.
-    #
-    # @yieldparam [Extension] ext
-    #   The desired extension.
-    #
-    # @return [Extension]
-    #   The desired extension.
-    #
-    # @raise [ExtensionNotFound]
-    #   The extension with the specified _name_ could not be found in any
-    #   of the overlays or in the extension cache.
-    #
-    def Platform.extension(name,&block)
-      ext = Platform.extensions[name]
-
-      block.call(ext) if block
-      return ext
-    end
-
-    #
-    # Reloads the overlay cache and the extension cache.
-    #
-    # @return [Boolean]
-    #   Specifies whether the reload was successful or not.
-    #
-    def Platform.reload!
-      Platform.overlays.reload! && Platform.extensions.reload!
-    end
-  end
-end

data/lib/ronin/platform/ronin.rb

@@ -1,97 +0,0 @@
-#
-# Ronin - A Ruby platform for exploit development and security research.
-#
-# 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/platform'
-
-require 'extlib'
-
-module Ronin
-  protected
-
-  #
-  # Provides transparent access to Platform.extension via constants.
-  #
-  # @param [String] name
-  #   The constant name to map to an extension in the extension cache.
-  #
-  # @return [Extension]
-  #   The extension that maps to the constant _name_.
-  #
-  # @raise [NameError]
-  #   No extension could be found in the extension cache, that maps to the
-  #   constant _name_.
-  #
-  # @example
-  #   Ronin::Shellcode
-  #   # => #<Ronin::Platform::Extension: @name="shellcode" ...>
-  #
-  def Ronin.const_missing(name)
-    name = name.to_s
-    ext_name = name.snake_case
-
-    if Platform.has_extension?(ext_name)
-      return Platform.extension(ext_name)
-    end
-
-    return super(name)
-  end
-
-  #
-  # Provides transparent access to Platform.extension via methods.
-  #
-  # @param [Symbol, String] name
-  #   The name of the extension to search for within the extension cache.
-  #
-  # @yield [ext]
-  #   If a block is given, it will be passed the extension which has the
-  #   matching _name_.
-  #
-  # @yieldparam [Extension] ext
-  #   The matching extension.
-  #
-  # @return [Extension]
-  #   The matching extension.
-  #
-  # @raise [NoMethodError]
-  #   No extension could be found in the extension cache with the
-  #   matching _name_.
-  #
-  # @example
-  #   shellcode
-  #   # => #<Ronin::Platform::Extension: ...>
-  #
-  # @example
-  #   shellcode do |ext|
-  #     puts ext.exposed_methods
-  #   end
-  #
-  def method_missing(name,*args,&block)
-    if args.length == 0
-      ext_name = name.id2name
-
-      # return an extension if available
-      if Platform.has_extension?(ext_name)
-        return Platform.extension(ext_name,&block)
-      end
-    end
-
-    return super(name,*args,&block)
-  end
-end

data/lib/ronin/platform/tasks/spec.rb

@@ -1,9 +0,0 @@
-require 'spec/rake/spectask'
-
-desc "Run all specifications"
-Spec::Rake::SpecTask.new(:spec) do |t|
-  t.libs += ['lib'] + Dir['**/lib'] + ['spec']
-  t.spec_opts = ['--colour', '--format', 'specdoc']
-end
-
-task :default => :spec

data/lib/ronin/platform.rb

@@ -1,24 +0,0 @@
-#
-# Ronin - A Ruby platform for exploit development and security research.
-#
-# 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'
-require 'ronin/platform/extension'
-require 'ronin/platform/overlay'
-require 'ronin/platform/ronin'

data/lib/ronin/rpc/call.rb

@@ -1,72 +0,0 @@
-#
-# Ronin - A Ruby platform for exploit development and security research.
-#
-# 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/rpc/exceptions/not_implemented'
-
-module Ronin
-  module RPC
-    class Call
-
-      # Name of the function to call
-      attr_reader :name
-
-      # Arguments to call with the function
-      attr_reader :arguments
-
-      #
-      # Creates a new Call object with the specified _name_ and the given
-      # _arguments_.
-      #
-      def initialize(name,*arguments)
-        @name = name
-        @arguments = arguments
-      end
-
-      #
-      # Default method which encodes the call object into a format parsable
-      # by the RPC Server. By default encode raises a NotImplemented
-      # exception.
-      #
-      def encode
-        raise(NotImplemented,"the \"encode\" method is not implemented in #{self.class}",caller)
-      end
-
-      #
-      # Returns the String form of the call object.
-      #
-      def to_s
-        args = @arguments.map { |arg|
-          if (arg.kind_of?(Hash) || arg.kind_of?(Array))
-            arg.inspect
-          elsif arg.kind_of?(String)
-            arg.dump
-          else
-            arg
-          end
-        }
-
-        "#{@name}(" + args.join(', ') + ')'
-      end
-
-      alias inspect to_s
-
-    end
-  end
-end

data/lib/ronin/rpc/client.rb

@@ -1,88 +0,0 @@
-#
-# Ronin - A Ruby platform for exploit development and security research.
-#
-# 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/rpc/exceptions/not_implemented'
-require 'ronin/rpc/exceptions/response_missing'
-require 'ronin/rpc/service'
-require 'ronin/extensions/meta'
-
-module Ronin
-  module RPC
-    class Client
-
-      #
-      # Calls the specified _function_ hosted on the RPC Server with the
-      # given _arguments_. Returns the return-value of the RPC function call.
-      #
-      def call(function,*arguments)
-        return_value(send_call(create_call(function,*arguments)))
-      end
-
-      protected
-
-      #
-      # Defines a Service offered by the Client with the specified _name_
-      # and _class_type_.
-      #
-      def self.service(name,class_type)
-        name = name.to_sym
-
-        class_def(name) do
-          class_type.new(name,self)
-        end
-      end
-
-      #
-      # Default method which creates a Call object for the specified
-      # _function_ and the given _arguments_. By default create_call raises
-      # a NotImplemented exception.
-      #
-      def create_call(function,*arguments)
-        raise(NotImplemented,"the \"create_call\" method is not implemented in #{self.class}",caller)
-      end
-
-      #
-      # Default method which sends the _call_object_ to the RPC Server and 
-      # returns the response of the Server. By default send_call raises
-      # a NotImplemented exception.
-      #
-      def send_call(call_object)
-        raise(NotImplemented,"the \"send_call\" method is not implemented in #{self.class}",caller)
-      end
-
-      #
-      # Default method which extracts the return-value and output generated
-      # by the RPC function call from the specified _response_ data. By
-      # default return_value raises a NotImplemented exception.
-      #
-      def return_value(response)
-        raise(NotImplemented,"the \"return_value\" method is not implemented in #{self.class}",caller)
-      end
-
-      #
-      # Relays missing methods to call.
-      #
-      def method_missing(sym,*args)
-        call(sym,*args)
-      end
-
-    end
-  end
-end

data/lib/ronin/rpc/console.rb

@@ -1,78 +0,0 @@
-#
-# Ronin - A Ruby platform for exploit development and security research.
-#
-# 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/rpc/service'
-require 'ronin/ui/shell'
-
-module Ronin
-  module RPC
-    class Console < Service
-
-      #
-      # Invoke the the specified _method_ with the given _arguments_.
-      # Returns the result of the method call.
-      #
-      def invoke(method,*arguments)
-        call(:invoke,method,arguments)
-      end
-
-      #
-      # Evaluates the specified _string_ of code. Returns the result of the
-      # evaluated code.
-      #
-      def eval(string)
-        invoke(:eval,string)
-      end
-
-      #
-      # If _expression_ is given it will be evaluated and it's return value
-      # will be returned as a natively formatted String. If _expression_ is
-      # not given, the Object inspect method will be called.
-      #
-      def inspect(expression=nil)
-        if expression
-          return call(:inspect,expression)
-        else
-          return super()
-        end
-      end
-
-      #
-      # Starts a Shell that allows a user to execute PHP expressions and
-      # observe their results.
-      #
-      def interact
-        UI::Shell.start(:prompt => '>>') do |shell,line|
-          shell.puts "=> #{inspect(line)}"
-        end
-      end
-
-      protected
-
-      #
-      # Relays missing methods to invoke.
-      #
-      def method_missing(sym,*args)
-        invoke(sym,*args)
-      end
-
-    end
-  end
-end