ronin-exploits 0.2.1 → 0.3.0

data/lib/ronin/exploits/http.rb

@@ -1,5 +1,4 @@
 #
-#--
 # Ronin Exploits - A Ruby library for Ronin that provides exploitation and
 # payload crafting functionality.
 #
@@ -18,11 +17,10 @@
 # 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/exploits/remote_tcp'
-require 'ronin/sessions/http'
+require 'ronin/network/helpers/http'
 
 module Ronin
   module Exploits
@@ -31,8 +29,15 @@ module Ronin
       # Default port to connect to
       DEFAULT_PORT = 80
 
-      include Sessions::HTTP
+      include Network::Helpers::HTTP
 
+      #
+      # Creates a new Ronin::Exploits::HTTP object using the given _block_.
+      #
+      #   ronin_http_exploit do
+      #     ...
+      #   end
+      #
       contextify :ronin_http_exploit
 
       # Default port to connect to

data/lib/ronin/exploits/local.rb

@@ -1,5 +1,4 @@
 #
-#--
 # Ronin Exploits - A Ruby library for Ronin that provides exploitation and
 # payload crafting functionality.
 #
@@ -18,7 +17,6 @@
 # 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/exploits/exploit'
@@ -27,6 +25,14 @@ module Ronin
   module Exploits
     class Local < Exploit
 
+      #
+      # Creates a new Ronin::Exploits::Local object using the given
+      # _block_.
+      #
+      #   ronin_local_exploit do
+      #     ...
+      #   end
+      #
       contextify :ronin_local_exploit
 
     end

data/lib/ronin/exploits/remote.rb

@@ -1,5 +1,4 @@
 #
-#--
 # Ronin Exploits - A Ruby library for Ronin that provides exploitation and
 # payload crafting functionality.
 #
@@ -18,7 +17,6 @@
 # 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/exploits/exploit'
@@ -27,6 +25,14 @@ module Ronin
   module Exploits
     class Remote < Exploit
 
+      #
+      # Creates a new Ronin::Exploits::Remote object using the given
+      # _block_.
+      #
+      #   ronin_remote_exploit do
+      #     ...
+      #   end
+      #
       contextify :ronin_remote_exploit
 
     end

data/lib/ronin/exploits/remote_tcp.rb

@@ -1,5 +1,4 @@
 #
-#--
 # Ronin Exploits - A Ruby library for Ronin that provides exploitation and
 # payload crafting functionality.
 #
@@ -18,32 +17,39 @@
 # 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/exploits/remote'
 require 'ronin/model/has_default_port'
-require 'ronin/sessions/tcp'
+require 'ronin/network/helpers/tcp'
 
 module Ronin
   module Exploits
     class RemoteTCP < Remote
 
       include Model::HasDefaultPort
-      include Sessions::TCP
+      include Network::Helpers::TCP
 
+      #
+      # Creates a new Ronin::Exploits::RemoteTCP object using the given
+      # _block_.
+      #
+      #   ronin_remote_tcp_exploit do
+      #     ...
+      #   end
+      #
       contextify :ronin_remote_tcp_exploit
 
-      # remote host to connect to
+      # Remote host to connect to
       parameter :host, :description => 'TCP remote host'
 
-      # remote port to connect to
+      # Remote port to connect to
       parameter :port, :description => 'TCP remote port'
 
-      # local host to bind to
+      # Local host to bind to
       parameter :local_host, :description => 'TCP local host'
 
-      # local port to bind to
+      # Local port to bind to
       parameter :local_port, :description => 'TCP local port'
 
       #
@@ -58,6 +64,18 @@ module Ronin
       #
       # Verifies and deploys the TCP remote exploit.
       #
+      # @yield [exploit]
+      #   If a block is given, it will be passed the deployed exploit.
+      #
+      # @yieldparam [RemoteTCP] exploit
+      #   The deployed exploit.
+      #
+      # @return [RemoteTCP]
+      #   The deployed exploit.
+      #
+      # @raise [ExploitNotBuilt]
+      #   The exploit has not been built, and cannot be deployed.
+      #
       def deploy!(&block)
         @port ||= self.default_port
 

data/lib/ronin/exploits/remote_udp.rb

@@ -1,5 +1,4 @@
 #
-#--
 # Ronin Exploits - A Ruby library for Ronin that provides exploitation and
 # payload crafting functionality.
 #
@@ -18,32 +17,39 @@
 # 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/exploits/remote'
 require 'ronin/model/has_default_port'
-require 'ronin/sessions/udp'
+require 'ronin/network/helpers/udp'
 
 module Ronin
   module Exploits
     class RemoteUDP < Remote
 
       include Model::HasDefaultPort
-      include Sessions::UDP
+      include Network::Helpers::UDP
 
+      #
+      # Creates a new Ronin::Exploits::RemoteUDP object using the given
+      # _block_.
+      #
+      #   ronin_remote_udp_exploit do
+      #     ...
+      #   end
+      #
       contextify :ronin_remote_udp_exploit
 
-      # remote host to connect to
+      # Remote host to connect to
       parameter :host, :description => 'UDP remote host'
 
-      # remote port to connect to
+      # Remote port to connect to
       parameter :port, :description => 'UDP remote port'
 
-      # local host to bind to
+      # Local host to bind to
       parameter :local_host, :description => 'UDP local host'
 
-      # local port to bind to
+      # Local port to bind to
       parameter :local_port, :description => 'UDP local port'
 
       #
@@ -58,6 +64,18 @@ module Ronin
       #
       # Verifies and deploys the UDP remote exploit.
       #
+      # @yield [exploit]
+      #   If a block is given, it will be passed the deployed exploit.
+      #
+      # @yieldparam [RemoteUDP] exploit
+      #   The deployed exploit.
+      #
+      # @return [RemoteUDP]
+      #   The deployed exploit.
+      #
+      # @raise [ExploitNotBuilt]
+      #   The exploit has not been built, and cannot be deployed.
+      #
       def deploy!(&block)
         @port ||= self.default_port
 

data/lib/ronin/exploits/target.rb

@@ -1,5 +1,4 @@
 #
-#--
 # Ronin Exploits - A Ruby library for Ronin that provides exploitation and
 # payload crafting functionality.
 #
@@ -18,13 +17,12 @@
 # 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/exploits/exceptions/target_data_missing'
-require 'ronin/exploits/product'
 require 'ronin/model/targets_arch'
 require 'ronin/model/targets_os'
+require 'ronin/model/targets_product'
 require 'ronin/model'
 
 require 'dm-types/yaml'
@@ -36,6 +34,7 @@ module Ronin
       include Model
       include Model::TargetsArch
       include Model::TargetsOS
+      include Model::TargetsProduct
 
       # Primary key
       property :id, Serial
@@ -43,9 +42,6 @@ module Ronin
       # Target comments
       property :description, String
 
-      # Targeted product
-      belongs_to :product
-
       # The exploit the target belongs to
       belongs_to :exploit
 
@@ -53,8 +49,16 @@ module Ronin
       property :data, Yaml, :default => {}
 
       #
-      # Creates a new ExploitTarget object with the given _attributes_
-      # and the given _block_.
+      # Creates a new ExploitTarget object
+      #
+      # @param [Hash] attributes
+      #   Additional attributes to create the target with.
+      #
+      # @yield [target]
+      #   If a block is given, it will be passed the new target object.
+      #
+      # @yieldparam [Target] target
+      #   The newly created target object.
       #
       def initialize(attributes={},&block)
         super(attributes)
@@ -63,42 +67,39 @@ module Ronin
       end
 
       #
-      # Returns the Product if no _arguments_ are given. If _arguments_ are
-      # given, a new Product object will be created from the given
-      # _arguments_ and associated with the target.
+      # Searches for target data with the matching name.
       #
-      #   target.product
-      #   # => nil
-      #
-      #   target.product(:name => 'Apache', :version => '1.3.3.7')
-      #   # => #<Ronin::Product type=Ronin::Product id=nil name="Apache"
-      #   # version="1.3.3.7" vendor="Apache">
-      #
-      def product(*arguments)
-        unless arguments.empty?
-          return self.product = Product.first_or_create(*arguments)
-        else
-          return product_association
-        end
-      end
-
+      # @param [Symbol, String] name
+      #   The name to search for.
       #
-      # Returns +true+ if the target contains data with the specified
-      # _name_, returns +false+ otherwise.
+      # @return [Boolean]
+      #   Specifies whether the target contains data with the matching name.
       #
       def has?(name)
         self.data.has_key?(name.to_sym)
       end
 
       #
-      # Returns the target data with the specified _name_.
+      # Returns the target data with the matching name.
+      #
+      # @param [Symbol, String] name
+      #   The name of the target data to retrieve.
+      #
+      # @return [Object, nil]
+      #   The target data.
       #
       def [](name)
         self.data[name.to_sym]
       end
 
       #
-      # Sets the target data with the specified _name_ and _value_.
+      # Sets the target data with the matching name.
+      #
+      # @param [Symbol, String] name
+      #   The name of the target data to set.
+      #
+      # @param [Object] value
+      #   The value to set for the target data.
       #
       def []=(name,value)
         self.data[name.to_sym] = value
@@ -109,6 +110,16 @@ module Ronin
       #
       # Provides transparent access to the target data Hash.
       #
+      # @raise [TargetDataMissing]
+      #   The target does not have data associated with the specified name.
+      #
+      # @example
+      #   target.ip
+      #   # => 0xff8025a0
+      #
+      # @example
+      #   target.ip = 0x41414141
+      #
       def method_missing(name,*arguments,&block)
         unless block
           name = name.to_s

data/lib/ronin/exploits/targets.rb

@@ -1,5 +1,4 @@
 #
-#--
 # Ronin Exploits - A Ruby library for Ronin that provides exploitation and
 # payload crafting functionality.
 #
@@ -18,7 +17,6 @@
 # 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/exploits/targets/buffer_overflow'

data/lib/ronin/exploits/targets/buffer_overflow.rb

@@ -1,5 +1,4 @@
 #
-#--
 # Ronin Exploits - A Ruby library for Ronin that provides exploitation and
 # payload crafting functionality.
 #
@@ -18,7 +17,6 @@
 # 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/exploits/target'

data/lib/ronin/exploits/targets/format_string.rb

@@ -1,5 +1,4 @@
 #
-#--
 # Ronin Exploits - A Ruby library for Ronin that provides exploitation and
 # payload crafting functionality.
 #
@@ -18,7 +17,6 @@
 # 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/exploits/target'

data/lib/ronin/exploits/verifiers.rb

@@ -1,5 +1,4 @@
 #
-#--
 # Ronin Exploits - A Ruby library for Ronin that provides exploitation and
 # payload crafting functionality.
 #
@@ -18,15 +17,19 @@
 # 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 Exploits
     module Verifiers
       #
-      # Verifies that a target has been selected. If a target has not been
-      # selected, a TargetUnspecified exception will be raised, otherwise
-      # +true+ will be returned.
+      # Verifies that a target has been selected.
+      #
+      # @return [true]
+      #   Specifies that a target has been selected.
+      #
+      # @raise [TargetUnspecified]
+      #   No suitable target was provided.
       #
       def verify_target!
         if target.nil?
@@ -38,43 +41,69 @@ module Ronin
 
       #
       # Verifies that the selected target has an arch property.
-      # If the selected target does not have an arch property, a
-      # TargetDataMissing exception will be raised, otherwise
-      # +true+ will be return.
+      #
+      # @return [true]
+      #   Specifies that an architecture is being targeted by the currently
+      #   selected target.
+      #
+      # @raise [TargetDataMissing]
+      #   A valid Arch was expected from the current target.
       #
       def verify_arch!
         if arch.nil?
           raise(TargetDataMissing,"no suitable arch was provided",caller)
         end
+
+        return true
       end
 
       #
       # Verifies that the selected target has an os property.
-      # If the selected target does not have an os property, a
-      # TargetDataMissing exception will be raised, otherwise
-      # +true+ will be return.
+      #
+      # @return [true]
+      #   Specifies that an OS is being targeted by the currently selected
+      #   target.
+      #
+      # @raise [TargetDataMissing]
+      #   A valid OS was expected from the current target.
       #
       def verify_os!
         if os.nil?
           raise(TargetDataMissing,"no suitable os was provided",caller)
         end
+
+        return true
       end
 
       #
       # Verifies that the selected target has an product property.
-      # If the selected target does not have an product property, a
-      # TargetDataMissing exception will be raised, otherwise
-      # +true+ will be return.
+      #
+      # @return [true]
+      #   Specifies that a product is being targeted by the currently
+      #   selected target.
+      #
+      # @raise [TargetDataMissing]
+      #   A valid product was expected from the current target.
       #
       def verify_product!
         if product.nil?
           raise(TargetDataMissing,"no suitable product was provided",caller)
         end
+
+        return true
       end
 
       #
-      # Raises a RestrictedChar exception if the specified _text_ contains
-      # any restricted characters, returns +true+ otherwise.
+      # Reviews text for restricted characters.
+      #
+      # @param [String] text
+      #   The text to review for restricted characters.
+      #
+      # @return [true]
+      #   Specifies that the text does not contain restricted characters.
+      #
+      # @raise [RestrictedChar]
+      #   A restricted character was found in the specified text.
       #
       def verify_restricted!(text)
         found = @restricted_chars.select { |char|