ronin 1.0.0 → 1.1.0.rc1

data/lib/ronin/network/mixins/telnet.rb

@@ -18,6 +18,8 @@
 #
 
 require 'ronin/network/telnet'
+require 'ronin/ui/output/helpers'
+require 'ronin/mixin'
 
 require 'parameters'
 
@@ -28,44 +30,51 @@ module Ronin
       # Adds Telnet convenience methods and connection parameters to a
       # class.
       #
+      # Defines the following parameters:
+      #
+      # * `host` (`String`) - Telnet host.
+      # * `port` (`Integer`) - Telnet port.
+      # * `telnet_user` (`String`) - Telnet user to login as.
+      # * `telnet_password` (`String`) - Telnet password to login with.
+      # * `telnet_proxy` (`String`) - Telnet proxy.
+      # * `telnet_ssl` (`Boolean`) - Enable Telnet over SSL. Defaults to `true`.
+      #
       module Telnet
-        include Parameters
+        include Mixin
+
+        mixin UI::Output::Helpers, Parameters
 
-        # Telnet host
-        parameter :host,
-                  :type => String,
-                  :description => 'Telnet host'
+        mixin do
+          # Telnet host
+          parameter :host, :type => String,
+                           :description => 'Telnet host'
 
-        # Telnet port
-        parameter :port,
-                  :type => Integer,
-                  :description => 'Telnet port'
+          # Telnet port
+          parameter :port, :type => Integer,
+                           :description => 'Telnet port'
 
-        # Telnet user
-        parameter :telnet_user,
-                  :type => String,
-                  :description => 'Telnet user to login as'
+          # Telnet user
+          parameter :telnet_user, :type => String,
+                                  :description => 'Telnet user to login as'
 
-        # Telnet password
-        parameter :telnet_password,
-                  :type => String,
-                  :description => 'Telnet password to login with'
+          # Telnet password
+          parameter :telnet_password, :type => String,
+                                      :description => 'Telnet password to login with'
 
-        # Telnet proxy
-        parameter :telnet_proxy,
-                  :description => 'Telnet proxy'
+          # Telnet proxy
+          parameter :telnet_proxy, :description => 'Telnet proxy'
 
-        # Enable Telnet SSL
-        parameter :telnet_ssl,
-                  :type => true,
-                  :description => 'Enable Telnet over SSL'
+          # Enable Telnet SSL
+          parameter :telnet_ssl, :type => true,
+                                 :description => 'Enable Telnet over SSL'
+        end
 
         protected
 
         #
-        # Creates a connection to a Telnet server. The {#host}, {#port},
-        # {#telnet_user}, {#telnet_password}, {#telnet_proxy} and
-        # {#telnet_ssl} parameters will also be used to connect to the
+        # Creates a connection to a Telnet server. The `host`, `port`,
+        # `telnet_user`, `telnet_password`, `telnet_proxy` and
+        # `telnet_ssl` parameters will also be used to connect to the
         # Telnet server.
         #
         # @param [Hash] options
@@ -130,6 +139,8 @@ module Ronin
         #   telnet_connect
         #   # => Net::Telnet
         #
+        # @api public
+        #
         def telnet_connect(options={},&block)
           options[:port] ||= self.port
           options[:user] ||= self.telnet_user
@@ -148,9 +159,9 @@ module Ronin
         end
 
         #
-        # Starts a session with a Telnet server. The {#host}, {#port},
-        # {#telnet_user}, {#telnet_password}, {#telnet_proxy} and
-        # {#telnet_ssl} parameters will also be used to connect to the
+        # Starts a session with a Telnet server. The `host`, `port`,
+        # `telnet_user`, `telnet_password`, `telnet_proxy` and
+        # `telnet_ssl` parameters will also be used to connect to the
         # Telnet server.
         #
         # @yield [session]
@@ -168,6 +179,8 @@ module Ronin
         #
         # @see telnet_connect
         #
+        # @api public
+        #
         def telnet_session(options={},&block)
           return telnet_connect(options) do |sess|
             yield sess if block_given?

data/lib/ronin/network/mixins/udp.rb

@@ -18,6 +18,8 @@
 #
 
 require 'ronin/network/udp'
+require 'ronin/ui/output/helpers'
+require 'ronin/mixin'
 
 require 'parameters'
 
@@ -27,45 +29,52 @@ module Ronin
       #
       # Adds UDP convenience methods and connection parameters to a class.
       #
+      # Defines the following parameters:
+      #
+      # * `host` (`String`) - UDP host.
+      # * `port` (`Integer`) - UDP port.
+      # * `local_host` (`String`) - UDP local host.
+      # * `local_port` (`Integer`) - UDP local port.
+      # * `server_host` (`String`) - UDP server host.
+      # * `server_port` (`Integer`) - UDP server port.
+      #
       module UDP
-        include Parameters
-
-        # UDP host
-        parameter :host,
-                  :type => String,
-                  :description => 'UDP host'
-
-        # UDP port
-        parameter :port,
-                  :type => Integer,
-                  :description => 'UDP port'
-
-        # UDP local host
-        parameter :local_host,
-                  :type => String,
-                  :description => 'UDP local host'
-
-        # UDP local port
-        parameter :local_port,
-                  :type => Integer,
-                  :description => 'UDP local port'
-
-        # UDP server host
-        parameter :server_host,
-                  :type => String,
-                  :description => 'UDP server host'
-
-        # UDP server port
-        parameter :server_port,
-                  :type => Integer,
-                  :description => 'UDP server port'
+        include Mixin
+
+        mixin UI::Output::Helpers, Parameters
+
+        mixin do
+          # UDP host
+          parameter :host, :type => String,
+                           :description => 'UDP host'
+
+          # UDP port
+          parameter :port, :type => Integer,
+                           :description => 'UDP port'
+
+          # UDP local host
+          parameter :local_host, :type => String,
+                                 :description => 'UDP local host'
+
+          # UDP local port
+          parameter :local_port, :type => Integer,
+                                 :description => 'UDP local port'
+
+          # UDP server host
+          parameter :server_host, :type => String,
+                                  :description => 'UDP server host'
+
+          # UDP server port
+          parameter :server_port, :type => Integer,
+                                  :description => 'UDP server port'
+        end
 
         protected
 
         #
         # Opens a UDP connection to the host and port specified by the
-        # {#host} and {#port} parameters. If the {#local_host} and
-        # {#local_port} parameters are set, they will be used for
+        # `host` and `port` parameters. If the `local_host` and
+        # `local_port` parameters are set, they will be used for
         # the local host and port of the UDP connection.
         #
         # @yield [socket]
@@ -86,6 +95,8 @@ module Ronin
         #     puts sock.readlines
         #   end
         #
+        # @api public
+        #
         def udp_connect(&block)
           print_info "Connecting to #{self.host}:#{self.port} ..."
 
@@ -93,9 +104,9 @@ module Ronin
         end
 
         #
-        # Connects to the host and port specified by the {#host} and {#port}
-        # parameters, then sends the given data. If the {#local_host} and
-        # {#local_port} instance methods are set, they will be used for the
+        # Connects to the host and port specified by the `host` and `port`
+        # parameters, then sends the given data. If the `local_host` and
+        # `local_port` instance methods are set, they will be used for the
         # local host and port of the UDP connection.
         #
         # @param [String] data
@@ -110,6 +121,8 @@ module Ronin
         # @return [UDPSocket]
         #   The newly created UDPSocket object.
         #
+        # @api public
+        #
         def udp_connect_and_send(data,&block)
           print_info "Connecting to #{self.host}:#{self.port} ..."
           print_debug "Sending data: #{data.inspect}"
@@ -119,7 +132,7 @@ module Ronin
 
         #
         # Creates a UDP session to the host and port specified by the
-        # {#host} and {#port} parameters. If the {#local_host} and {#local_port}
+        # `host` and `port` parameters. If the `local_host` and `local_port`
         # parameters are set, they will be used for the local host and port
         # of the UDP connection.
         #
@@ -132,6 +145,8 @@ module Ronin
         #
         # @return [nil]
         #
+        # @api public
+        #
         def udp_session(&block)
           print_info "Connecting to #{self.host}:#{self.port} ..."
 
@@ -142,8 +157,8 @@ module Ronin
         end
 
         #
-        # Creates a new UDPServer object listening on {#server_host} and
-        # {#server_port} parameters.
+        # Creates a new UDPServer object listening on `server_host` and
+        # `server_port` parameters.
         #
         # @yield [server]
         #   The given block will be passed the newly created server.
@@ -157,6 +172,8 @@ module Ronin
         # @example
         #   udp_server
         #
+        # @api public
+        #
         def udp_server(&block)
           if self.server_host
             print_info "Listening on #{self.server_host}:#{self.server_port} ..."
@@ -169,7 +186,7 @@ module Ronin
 
         #
         # Creates a new temporary UDPServer object listening on the
-        # {#server_host} and {#server_port} parameters.
+        # `server_host` and `server_port` parameters.
         #
         # @yield [server]
         #   The given block will be passed the newly created server.
@@ -185,6 +202,8 @@ module Ronin
         #     data, sender = server.recvfrom(1024)
         #   end
         #
+        # @api public
+        #
         def udp_server_session(&block)
           if self.server_host
             print_info "Listening on #{self.server_host}:#{self.server_port} ..."

data/lib/ronin/open_port.rb

@@ -18,15 +18,14 @@
 #
 
 require 'ronin/model'
+require 'ronin/ip_address'
+require 'ronin/port'
+require 'ronin/service'
+require 'ronin/service_credential'
 
 require 'dm-timestamps'
 
 module Ronin
-  autoload :ServiceCredential, 'ronin/service_credential'
-  autoload :Port, 'ronin/port'
-  autoload :Service, 'ronin/service'
-  autoload :IPAddress, 'ronin/ip_address'
-
   #
   # Represents a open port at a specified IP address.
   #
@@ -64,6 +63,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def address
       self.ip_address.address
     end
@@ -76,6 +77,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def number
       self.port.number
     end
@@ -88,6 +91,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def to_i
       self.port.to_i
     end
@@ -100,6 +105,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def to_s
       if self.service
         "#{self.port} (#{self.service})"

data/lib/ronin/organization.rb

@@ -20,12 +20,11 @@
 require 'ronin/model'
 require 'ronin/model/has_unique_name'
 require 'ronin/model/has_description'
+require 'ronin/address'
 
 require 'dm-timestamps'
 
 module Ronin
-  autoload :Address, 'ronin/address'
-
   #
   # Represents an Organization which owns {Address}es.
   #

data/lib/ronin/os.rb

@@ -19,12 +19,11 @@
 
 require 'ronin/model'
 require 'ronin/model/has_name'
+require 'ronin/os_guess'
+require 'ronin/ip_address'
 require 'ronin/extensions/meta'
 
 module Ronin
-  autoload :OSGuess, 'ronin/os_guess'
-  autoload :IPAddress, 'ronin/ip_address'
-
   #
   # Represents an Operating System and pre-defines other common ones
   # ({linux}, {freebsd}, {openbsd}, {netbsd}, {osx}, {solaris}, {windows}
@@ -59,6 +58,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def recent_ip_address
       relation = self.os_guesses.first(:order => [:created_at.desc])
 
@@ -77,6 +78,8 @@ module Ronin
     #   os = OS.new(:name => 'Linux', :version => '2.6.11')
     #   os.to_s # => "Linux 2.6.11"
     #
+    # @api public
+    #
     def to_s
       if self.version
         "#{self.name} #{self.version}"
@@ -102,6 +105,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def to_ary
       [self.name, self.version]
     end
@@ -120,6 +125,8 @@ module Ronin
     # @example
     #   OS.predefine :freebsd, 'FreeBSD'
     #
+    # @api private
+    #
     def OS.predefine(name,os_name)
       os_name = os_name.to_s
 

data/lib/ronin/os_guess.rb

@@ -18,13 +18,12 @@
 #
 
 require 'ronin/model'
+require 'ronin/os'
+require 'ronin/ip_address'
 
 require 'dm-timestamps'
 
 module Ronin
-  autoload :IPAddress, 'ronin/ip_address'
-  autoload :OS, 'ronin/os'
-
   #
   # Represents a guess about what {OS} an {IPAddress} might be running.
   #

data/lib/ronin/password.rb

@@ -18,12 +18,11 @@
 #
 
 require 'ronin/model'
+require 'ronin/credential'
 
 require 'digest'
 
 module Ronin
-  autoload :Credential, 'ronin/credential'
-
   #
   # Represents a password that can be stored in the {Database}.
   #
@@ -35,7 +34,8 @@ module Ronin
     property :id, Serial
 
     # The clear-text of the password
-    property :clear_text, String, :required => true,
+    property :clear_text, String, :length => 256,
+                                  :required => true,
                                   :unique => true
 
     # The credentials which use the password
@@ -79,6 +79,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def digest(algorithm,options={})
       digest_class = begin
                        Digest.const_get(algorithm.to_s.upcase)
@@ -109,6 +111,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def count
       self.credentials.count
     end
@@ -121,6 +125,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def to_s
       self.clear_text
     end
@@ -133,6 +139,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def inspect
       "#<#{self.class}: #{self.clear_text}>"
     end