ronin 1.0.0.pre4 → 1.0.0.rc1

data/lib/ronin/model/types/description.rb

@@ -22,10 +22,15 @@ require 'dm-core'
 module Ronin
   module Model
     module Types
+      #
+      # The Description property type is similar to the `Text` type,
+      # but automatically strips all leading and tailing white-space
+      # from every line.
+      #
       class Description < DataMapper::Property::Text
 
         #
-        # Typecasts the description.
+        # Type-casts the description.
         #
         # @param [Object] value
         #   The text of the description.
@@ -34,7 +39,7 @@ module Ronin
         #   The description property.
         #
         # @return [String, nil]
-        #   The typecasted description.
+        #   The type-casted description.
         #
         # @since 1.0.0
         #

data/lib/ronin/open_port.rb

@@ -27,6 +27,9 @@ require 'dm-timestamps'
 require 'dm-tags'
 
 module Ronin
+  #
+  # Represents a open port at a specified IP address.
+  #
   class OpenPort
 
     include Model

data/lib/ronin/organization.rb

@@ -26,6 +26,9 @@ require 'dm-timestamps'
 require 'dm-tags'
 
 module Ronin
+  #
+  # Represents an Organization which owns {Address}es.
+  #
   class Organization
 
     include Model

data/lib/ronin/os.rb

@@ -25,7 +25,7 @@ require 'ronin/extensions/meta'
 
 module Ronin
   #
-  # Represents an Operating System and predefines other common ones
+  # Represents an Operating System and pre-defines other common ones
   # ({linux}, {freebsd}, {openbsd}, {netbsd}, {osx}, {solaris}, {windows}
   # and {unix}).
   #
@@ -109,7 +109,7 @@ module Ronin
     # Defines a new predefined OS.
     #
     # @param [Symbol, String] name
-    #   The method name to define for the builtin OS.
+    #   The method name to define for the predefined OS.
     #
     # @param [String] os_name
     #   The name of the OS.

data/lib/ronin/os_guess.rb

@@ -24,6 +24,9 @@ require 'ronin/model'
 require 'dm-timestamps'
 
 module Ronin
+  #
+  # Represents a guess about what {OS} an {IPAddress} might be running.
+  #
   class OSGuess
 
     include Model

data/lib/ronin/password.rb

@@ -23,6 +23,9 @@ require 'ronin/model'
 require 'digest'
 
 module Ronin
+  #
+  # Represents a password that can be stored in the {Database}.
+  #
   class Password
 
     include Model
@@ -59,7 +62,7 @@ module Ronin
     #   The hex-digest of the hashed password.
     #
     # @raise [ArgumentError]
-    #   Unknown Digest alogrithm.
+    #   Unknown Digest algorithm.
     #
     # @example
     #   pass = Password.new(:clear_text => 'secret')

data/lib/ronin/port.rb

@@ -21,6 +21,9 @@ require 'ronin/open_port'
 require 'ronin/model'
 
 module Ronin
+  #
+  # Represents a TCP or UDP port.
+  #
   class Port
 
     include Model
@@ -28,13 +31,15 @@ module Ronin
     # Primary key of the port
     property :id, Serial
 
-    # The protocol of the port (tcp/udp)
+    # The protocol of the port (either `'tcp'` / `'udp'`)
     property :protocol, String, :set => ['tcp', 'udp'],
                                 :required => true,
                                 :unique_index => :protocol_port
 
     # The port number
     property :number, Integer, :required => true,
+                               :min => 1,
+                               :max => 65535,
                                :unique_index => :protocol_port
 
     # The open ports

data/lib/ronin/ronin.rb

@@ -24,6 +24,14 @@ require 'open_namespace'
 module Ronin
   include OpenNamespace
 
+  #
+  # Includes {ClassMethods} when {Ronin} is included.
+  #
+  # @param [Class, Module] base
+  #   The class or module that {Ronin} is being included into.
+  #
+  # @since 1.0.0
+  #
   def self.included(base)
     base.send :extend, ClassMethods
   end

data/lib/ronin/service.rb

@@ -22,6 +22,9 @@ require 'ronin/model'
 require 'ronin/model/has_unique_name'
 
 module Ronin
+  #
+  # Represents a TCP/UDP Service that runs on various common ports.
+  #
   class Service
 
     include Model

data/lib/ronin/service_credential.rb

@@ -21,6 +21,9 @@ require 'ronin/credential'
 require 'ronin/open_port'
 
 module Ronin
+  #
+  # Represents Credentials used to access a TCP/UDP {Service}.
+  #
   class ServiceCredential < Credential
 
     belongs_to :open_port, :required => false

data/lib/ronin/target.rb

@@ -19,12 +19,14 @@
 
 require 'ronin/campaign'
 require 'ronin/address'
-require 'ronin/remote_file'
 require 'ronin/model'
 
 require 'fileutils'
 
 module Ronin
+  #
+  # Represents an {Address} targeted by a {Campaign}.
+  #
   class Target
 
     include Model
@@ -41,9 +43,6 @@ module Ronin
     # The organization that is being targeted
     has 1, :organization, :through => :address
 
-    # The remote files recovered from the target
-    has 0..n, :remote_files
-
     # Validates the uniqueness of the address and the campaign.
     validates_uniqueness_of :address, :scope => [:campaign]
 

data/lib/ronin/tcp_port.rb

@@ -21,6 +21,9 @@ require 'ronin/port'
 require 'ronin/url'
 
 module Ronin
+  #
+  # Represents a TCP {Port}.
+  #
   class TCPPort < Port
 
     # The URLs that use the port
@@ -30,7 +33,7 @@ module Ronin
     # Creates a new {TCPPort} resource.
     #
     # @param [Hash] attributes
-    #   The attribute names and values to initialize the tcp port with.
+    #   The attribute names and values to initialize the TCP port with.
     #
     def initialize(attributes={})
       super(attributes.merge(:protocol => 'tcp'))

data/lib/ronin/udp_port.rb

@@ -20,13 +20,16 @@
 require 'ronin/port'
 
 module Ronin
+  #
+  # Represents a UDP {Port}.
+  #
   class UDPPort < Port
 
     #
     # Creates a new {UDPPort} resource.
     #
     # @param [Hash] attributes
-    #   The attribute names and values to initialize the udp port with.
+    #   The attribute names and values to initialize the UDP port with.
     #
     def initialize(attributes={})
       super(attributes.merge(:protocol => 'udp'))

data/lib/ronin/ui/cli/cli.rb

@@ -24,7 +24,7 @@ require 'ronin/installation'
 module Ronin
   module UI
     #
-    # The {CLI} provides an extendable Command Line Interface (CLI)
+    # The {CLI} provides an extensible Command Line Interface (CLI)
     # for Ronin. The {CLI} can load any sub-command using the
     # {command} method, from the `ronin/ui/cli/commands`
     # directory.

data/lib/ronin/ui/cli/command.rb

@@ -117,6 +117,12 @@ module Ronin
         class_option :color, :type => :boolean, :default => true
         class_option :no_color, :type => :boolean, :default => false
 
+        #
+        # Sets the namespace of a new {Command} class.
+        #
+        # @param [Class] super_class
+        #   The new {Command} class.
+        #
         def self.inherited(super_class)
           super_class.namespace(super_class.command_name)
         end

data/lib/ronin/ui/cli/commands/repos.rb

@@ -53,6 +53,9 @@ module Ronin
 
           argument :name, :type => :string, :required => false
 
+          #
+          # Executes the command.
+          #
           def execute
             Database.setup
 
@@ -71,6 +74,12 @@ module Ronin
 
           protected
 
+          #
+          # The selected SCM.
+          #
+          # @return [Symbol]
+          #   The name of the selected SCM.
+          #
           def scm
             @scm ||= if options[:scm]
                        options[:scm].to_sym
@@ -106,6 +115,9 @@ module Ronin
             end
           end
 
+          #
+          # Lists installed or added Repositories.
+          #
           def list
             unless name
               print_array Repository.all
@@ -177,6 +189,12 @@ module Ronin
             end
           end
 
+          #
+          # Adds a Repository.
+          #
+          # @param [String] path
+          #   The path of the local repository.
+          #
           def add(path)
             repo = begin
                      Repository.add!(:path => path, :scm => @scm)
@@ -188,6 +206,12 @@ module Ronin
             print_info "Repository #{repo} added."
           end
 
+          #
+          # Installs a Repository.
+          #
+          # @param [String, URI] uri
+          #   The URI of the remote repository.
+          #
           def install(uri)
             repo = begin
                      Repository.install!(:uri => uri, :scm => scm)
@@ -200,6 +224,9 @@ module Ronin
             print_info "Repository #{repo} has been installed."
           end
 
+          #
+          # Updates installed Repositories.
+          #
           def update
             repos = if name
                       begin
@@ -222,6 +249,12 @@ module Ronin
             end
           end
 
+          #
+          # Uninstalls a Repository.
+          #
+          # @param [String] name
+          #   The name of the repository.
+          #
           def uninstall(name)
             repo = Repository.uninstall!(name)
 

data/lib/ronin/ui/cli/engine_command.rb

@@ -23,6 +23,9 @@ require 'ronin/engine'
 module Ronin
   module UI
     module CLI
+      #
+      # A base-command for querying and loading {Engine}s.
+      #
       class EngineCommand < ModelCommand
 
         class_option :file, :type => :string, :aliases => '-f'

data/lib/ronin/ui/cli/model_command.rb

@@ -25,6 +25,9 @@ require 'set'
 module Ronin
   module UI
     module CLI
+      #
+      # A base-command for querying and exporting {Model}s.
+      #
       class ModelCommand < Command
 
         class_option :csv, :type => :boolean

data/lib/ronin/ui/console.rb

@@ -29,6 +29,10 @@ require 'ripl/auto_indent'
 
 module Ronin
   module UI
+    #
+    # An interactive Ruby {Console} using
+    # [Ripl](https://github.com/cldwalker/ripl).
+    #
     class Console
 
       # The history file for the Console session
@@ -67,7 +71,7 @@ module Ronin
       end
 
       #
-      # Determines whenter one-line errors will be printed, instead of full
+      # Determines whether one-line errors will be printed, instead of full
       # backtraces.
       #
       # @return [Boolean]

data/lib/ronin/ui/hexdump/hexdump.rb

@@ -19,6 +19,9 @@
 
 module Ronin
   module UI
+    #
+    # Methods for hexdumping data.
+    #
     module Hexdump
       #
       # Hexdumps an object.

data/lib/ronin/ui/output/helpers.rb

@@ -22,6 +22,9 @@ require 'ronin/ui/output/output'
 module Ronin
   module UI
     module Output
+      #
+      # Helper methods for printing output.
+      #
       module Helpers
         #
         # Writes data unless output has been silenced.
@@ -30,7 +33,7 @@ module Ronin
         #   The data to write.
         #
         # @return [Integer, nil]
-        #   The number of bytes writen.
+        #   The number of bytes written.
         #
         # @since 1.0.0
         #
@@ -101,22 +104,25 @@ module Ronin
         end
 
         #
-        # Prints one or more messages as `info` output.
+        # Prints an `info` message.
         #
-        # @param [Array] messages
-        #   The messages to print.
+        # @param [Array] message
+        #   The message to print.
         #
         # @return [Boolean]
         #   Specifies whether the messages were successfully printed.
         #
         # @example
-        #   print_info 'Connecting ...'
+        #   print_info "Connecting ..."
+        #
+        # @example Print a formatted message.
+        #   print_info "Connected to %s", host
         #
         # @since 0.3.0
         #
-        def print_info(*messages)
+        def print_info(*message)
           unless Output.silent?
-            Output.handler.print_info(*messages)
+            Output.handler.print_info(format_message(message))
             return true
           end
 
@@ -124,22 +130,22 @@ module Ronin
         end
 
         #
-        # Prints one or more messages as `debug` output.
+        # Prints a `debug` message.
         #
-        # @param [Array] messages
-        #   The messages to print.
+        # @param [Array, String] message
+        #   The message to print.
         #
         # @return [Boolean]
         #   Specifies whether the messages were successfully printed.
         #
-        # @example
-        #   print_debug "var1: #{var1.inspect}"
+        # @example Print a formatted message.
+        #   print_debug "vars: %p %p", vars[0], vars[1]
         #
         # @since 0.3.0
         #
-        def print_debug(*messages)
+        def print_debug(*message)
           if (Output.verbose? && !(Output.silent?))
-            Output.handler.print_debug(*messages)
+            Output.handler.print_debug(format_message(message))
             return true
           end
 
@@ -147,22 +153,25 @@ module Ronin
         end
 
         #
-        # Prints one or more messages as `warning` output.
+        # Prints a `warning` message.
         #
-        # @param [Array] messages
-        #   The messages to print.
+        # @param [Array, String] message
+        #   The message to print.
         #
         # @return [Boolean]
         #   Specifies whether the messages were successfully printed.
         #
         # @example
-        #   print_warning 'Detecting a restricted character in the buffer'
+        #   print_warning "Detecting a restricted character in the buffer"
+        #
+        # @example Print a formatted message.
+        #   print_warning "Malformed input detected: %p", user_input
         #
         # @since 0.3.0
         #
-        def print_warning(*messages)
+        def print_warning(*message)
           if (Output.verbose? && !(Output.silent?))
-            Output.handler.print_warning(*messages)
+            Output.handler.print_warning(format_message(message))
             return true
           end
           
@@ -170,27 +179,51 @@ module Ronin
         end
 
         #
-        # Prints one or more messages as `error` output.
+        # Prints an `error` message.
         #
-        # @param [Array] messages
-        #   The messages to print.
+        # @param [Array, String] message
+        #   The message to print.
         #
         # @return [Boolean]
         #   Specifies whether the messages were successfully printed.
         #
         # @example
-        #   print_error 'Could not connect!'
+        #   print_error "Could not connect!"
+        #
+        # @example Print a formatted message.
+        #   print_error "%p: %s", error.class, error.message
         #
         # @since 0.3.0
         #
-        def print_error(*messages)
+        def print_error(*message)
           unless Output.silent?
-            Output.handler.print_error(*messages)
+            Output.handler.print_error(format_message(message))
             return true
           end
 
           return false
         end
+
+        protected
+
+        #
+        # Formats a message to be printed.
+        #
+        # @param [Array] message
+        #   The message and additional Objects to format.
+        #
+        # @return [String]
+        #   The formatted message.
+        #
+        # @since 1.0.0
+        #
+        def format_message(message)
+          if message.length == 1
+            message[0]
+          else
+            message[0] % message[1..-1]
+          end
+        end
       end
     end
   end