ronin 1.0.0 → 1.1.0.rc1

data/lib/ronin/{engine.rb → script.rb}

@@ -17,4 +17,5 @@
 # along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-require 'ronin/engine/engine'
+require 'ronin/script/exceptions'
+require 'ronin/script/script'

data/lib/ronin/{engine → script}/buildable.rb

@@ -17,24 +17,30 @@
 # along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-require 'ronin/engine/exceptions/not_built'
-require 'ronin/engine/verifiable'
+require 'ronin/script/exceptions/not_built'
+require 'ronin/script/testable'
+require 'ronin/ui/output/helpers'
 
 module Ronin
-  module Engine
+  module Script
     #
-    # Adds building methods to an {Engine}.
+    # Adds building methods to an {Script}.
+    #
+    # @since 1.1.0
     #
     module Buildable
-      include Verifiable
+      include Testable,
+              UI::Output::Helpers
 
       #
-      # Initializes the buildable engine.
+      # Initializes the buildable script.
       #
       # @param [Hash] attributes
-      #   Additional attributes for the engine.
+      #   Additional attributes for the script.
+      #
+      # @since 1.1.0
       #
-      # @since 1.0.0
+      # @api semipublic
       #
       def initialize(attributes={})
         super(attributes)
@@ -44,62 +50,68 @@ module Ronin
       end
 
       #
-      # Determines whether the engine has been built.
+      # Determines whether the script has been built.
       #
       # @return [Boolean]
-      #   Specifies whether the engine is built.
+      #   Specifies whether the script is built.
+      #
+      # @since 1.1.0
       #
-      # @since 1.0.0
+      # @api semipublic
       #
       def built?
         @built == true
       end
 
       #
-      # Builds the engine.
+      # Builds the script.
       #
       # @param [Hash] options
       #   Additional options to also use as parameters.
       #
       # @yield []
-      #   The given block will be called after the engine has been built.
+      #   The given block will be called after the script has been built.
       #
       # @see #build
       #
-      # @since 1.0.0
+      # @since 1.1.0
+      #
+      # @api semipublic
       #
       def build!(options={})
         self.params = options
-        print_debug "#{engine_name} #{self} parameters: #{self.params.inspect}"
+        print_debug "#{script_type} #{self} parameters: #{self.params.inspect}"
 
-        print_info "Building #{engine_name} #{self} ..."
+        print_info "Building #{script_type} #{self} ..."
 
         @built = false
         @build_blocks.each { |block| block.call() }
         @built = true
 
-        print_info "#{engine_name} #{self} built!"
+        print_info "#{script_type} #{self} built!"
 
         yield if block_given?
         return self
       end
 
       #
-      # Verifies that the engine has been built and is properly configured.
+      # Tests that the script has been built and is properly configured.
       #
       # @return [true]
-      #   The engine has been verified.
+      #   The script has been tested.
       #
       # @raise [NotBuilt]
-      #   The engine has not been built, and cannot be verified.
+      #   The script has not been built, and cannot be verified.
+      #
+      # @see #test
       #
-      # @see #verify
+      # @since 1.1.0
       #
-      # @since 1.0.0
+      # @api semipublic
       #
-      def verify!
+      def test!
         unless built?
-          raise(NotBuilt,"cannot verify an unbuilt #{engine_name}")
+          raise(NotBuilt,"cannot verify an unbuilt #{script_type}")
         end
 
         super
@@ -108,15 +120,17 @@ module Ronin
       protected
 
       #
-      # Registers a given block to be called when the engine is built.
+      # Registers a given block to be called when the script is built.
       #
       # @yield []
-      #   The given block will be called when the engine is being built.
+      #   The given block will be called when the script is being built.
+      #
+      # @return [Script]
+      #   The script.
       #
-      # @return [Engine]
-      #   The engine.
+      # @since 1.1.0
       #
-      # @since 1.0.0
+      # @api public
       #
       def build(&block)
         @build_blocks << block

data/lib/ronin/script/class_methods.rb

@@ -0,0 +1,84 @@
+#
+# Copyright (c) 2006-2011 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of Ronin.
+#
+# Ronin 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 3 of the License, or
+# (at your option) any later version.
+#
+# Ronin 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 Ronin.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+module Ronin
+  module Script
+    #
+    # @since 1.1.0
+    #
+    module ClassMethods
+      #
+      # Loads the {Script} of the same class.
+      #
+      # @param [String] path
+      #   The path to load the script from.
+      #
+      # @return [Script]
+      #   The loaded script.
+      #
+      # @example
+      #   Exploits::HTTP.load_from('mod_php_exploit.rb')
+      #   # => #<Ronin::Exploits::HTTP: ...>
+      #
+      # @since 1.1.0
+      #
+      def load_from(path)
+        load_object(path)
+      end
+
+      #
+      # Loads all objects with the matching attributes.
+      #
+      # @param [Hash] attributes
+      #   Attributes to search for.
+      #
+      # @since 1.1.0
+      #
+      # @api public
+      #
+      def load_all(attributes={})
+        resources = all(attributes)
+        resources.each { |resource| resource.load_script! }
+
+        return resources
+      end
+
+      #
+      # Loads the first object with matching attributes.
+      #
+      # @param [Hash] attributes
+      #   Attributes to search for.
+      #
+      # @return [Cacheable]
+      #   The loaded cached objects.
+      #
+      # @since 1.1.0
+      #
+      # @api public
+      #
+      def load_first(attributes={})
+        if (resource = first(attributes))
+          resource.load_script!
+        end
+
+        return resource
+      end
+    end
+  end
+end

data/lib/ronin/{engine → script}/deployable.rb

@@ -17,24 +17,30 @@
 # along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-require 'ronin/engine/exceptions/deploy_failed'
-require 'ronin/engine/verifiable'
+require 'ronin/script/exceptions/deploy_failed'
+require 'ronin/script/testable'
+require 'ronin/ui/output/helpers'
 
 module Ronin
-  module Engine
+  module Script
     #
-    # Adds deployment methods to an {Engine}.
+    # Adds deployment methods to an {Script}.
+    #
+    # @since 1.1.0
     #
     module Deployable
-      include Verifiable
+      include Testable,
+              UI::Output::Helpers
 
       #
-      # Initializes the deployable engine.
+      # Initializes the deployable script.
       #
       # @param [Hash] attributes
-      #   Additional attributes for the engine.
+      #   Additional attributes for the script.
+      #
+      # @since 1.1.0
       #
-      # @since 1.0.0
+      # @api semipublic
       #
       def initialize(attributes={})
         super(attributes)
@@ -47,84 +53,93 @@ module Ronin
       end
 
       #
-      # Determines whether the engine was deployed.
+      # Determines whether the script was deployed.
       #
       # @return [Boolean]
-      #   Specifies whether the engine was previously deployed.
+      #   Specifies whether the script was previously deployed.
+      #
+      # @since 1.1.0
       #
-      # @since 1.0.0
+      # @api semipublic
       #
       def deployed?
         @deployed == true
       end
 
       #
-      # Verifies then deploys the exploit. If a payload has been set,
+      # Tests and then deploys the exploit. If a payload has been set,
       # the payload will also be deployed.
       #
       # @yield []
-      #   If a block is given, it will be passed the deployed engine.
+      #   If a block is given, it will be passed the deployed script
+      #   after a successful deploy.
       #
-      # @return [Engine]
-      #   The deployed engine.
+      # @return [Script]
+      #   The deployed script.
       #
       # @see deploy
       #
-      # @since 1.0.0
+      # @since 1.1.0
+      #
+      # @api semipublic
       #
       def deploy!
-        verify!
+        test!
 
-        print_info "Deploying #{engine_name} #{self} ..."
+        print_info "Deploying #{script_type} #{self} ..."
 
         @deployed = false
         @deploy_blocks.each { |block| block.call() }
         @deployed = true
         @evacuated = false
 
-        print_info "#{engine_name} #{self} deployed!"
+        print_info "#{script_type} #{self} deployed!"
 
         yield if block_given?
         return self
       end
 
       #
-      # Determines whether the engine was evacuated.
+      # Determines whether the script was evacuated.
       #
       # @return [Boolean]
-      #   Specifies whether the engine has been evacuated.
+      #   Specifies whether the script has been evacuated.
+      #
+      # @since 1.1.0
       #
-      # @since 1.0.0
+      # @api semipublic
       #
       def evacuated?
         @evacuated == true
       end
 
       #
-      # Evacuates the deployed engine.
+      # Evacuates the deployed script.
       #
       # @yield []
-      #   If a block is given, it will be called before the engine is
+      #   If a block is given, it will be called before the script is
       #   evacuated.
       #
-      # @return [Engine]
-      #   The evacuated engine.
+      # @return [Script]
+      #   The evacuated script.
       #
       # @see #evacuate
       #
-      # @since 1.0.0
+      # @since 1.1.0
+      #
+      # @api semipublic
       #
       def evacuate!
         yield if block_given?
 
-        print_info "Evauating #{engine_name} #{self} ..."
+        print_info "Evauating #{script_type} #{self} ..."
 
         @evacuated = false
         @evacuate_blocks.each { |block| block.call() }
         @evacuated = true
         @deployed = false
 
-        print_info "#{engine_name} #{self} evacuated."
+        print_info "#{script_type} #{self} evacuated."
         return self
       end
 
@@ -136,24 +151,28 @@ module Ronin
       # @raise [DeployFailed]
       #   The deployment of the exploit failed.
       #
-      # @since 1.0.0
+      # @since 1.1.0
+      #
+      # @api public
       #
       def deploy_failed!(message)
         raise(DeployFailed,message)
       end
 
       #
-      # Registers a given block to be called when the engine is being
+      # Registers a given block to be called when the script is being
       # deployed.
       #
       # @yield []
-      #   The given block will be called when the engine is being
+      #   The given block will be called when the script is being
       #   deployed.
       #
-      # @return [Engine]
-      #   The engine.
+      # @return [Script]
+      #   The script.
       #
-      # @since 1.0.0
+      # @since 1.1.0
+      #
+      # @api public
       #
       def deploy(&block)
         @deploy_blocks << block
@@ -161,17 +180,19 @@ module Ronin
       end
 
       #
-      # Registers a given block to be called when the engine is being
+      # Registers a given block to be called when the script is being
       # evacuated.
       #
       # @yield []
-      #   The given block will be called when the engine is being
+      #   The given block will be called when the script is being
       #   evacuated.
       #
-      # @return [Engine]
-      #   The engine.
+      # @return [Script]
+      #   The script.
+      #
+      # @since 1.1.0
       #
-      # @since 1.0.0
+      # @api public
       #
       def evacuate(&block)
         @evacuate_blocks.unshift(block)