ronin 1.0.0 → 1.1.0.rc1

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

@@ -18,6 +18,8 @@
 #
 
 require 'ronin/network/imap'
+require 'ronin/ui/output/helpers'
+require 'ronin/mixin'
 
 require 'parameters'
 
@@ -27,39 +29,46 @@ module Ronin
       #
       # Adds IMAP convenience methods and connection parameters to a class.
       #
+      # Defines the following parameters:
+      #
+      # * `host` (`String`) - IMAP host.
+      # * `port` (`Integer`) - IMAP port.
+      # * `imap_auth` (`String`) - IMAP authentication method.
+      # * `imap_user` (`String`) - IMAP user to login as.
+      # * `imap_password` (`String`) - IMAP password to login with.
+      #
       module IMAP
-        include Parameters
+        include Mixin
+
+        mixin UI::Output::Helpers, Parameters
 
-        # IMAP host
-        parameter :host,
-                  :type => String,
-                  :description => 'IMAP host'
+        mixin do
+          # IMAP host
+          parameter :host, :type => String,
+                           :description => 'IMAP host'
 
-        # IMAP port
-        parameter :port,
-                  :type => Integer,
-                  :description => 'IMAP port'
+          # IMAP port
+          parameter :port, :type => Integer,
+                           :description => 'IMAP port'
 
-        # IMAP auth
-        parameter :imap_auth,
-                  :type => String,
-                  :description => 'IMAP authentication method'
+          # IMAP auth
+          parameter :imap_auth, :type => String,
+                                :description => 'IMAP authentication method'
 
-        # IMAP user to login as
-        parameter :imap_user,
-                  :type => String,
-                  :description => 'IMAP user to login as'
+          # IMAP user to login as
+          parameter :imap_user, :type => String,
+                                :description => 'IMAP user to login as'
 
-        # IMAP password to login with
-        parameter :imap_password,
-                  :type => String,
-                  :description => 'IMAP password to login with'
+          # IMAP password to login with
+          parameter :imap_password, :type => String,
+                                    :description => 'IMAP password to login with'
+        end
 
         protected
 
         #
-        # Creates a connection to the IMAP server. The {#host}, {#port},
-        # {#imap_auth}, {#imap_user} and {#imap_password} parameters
+        # Creates a connection to the IMAP server. The `host`, `port`,
+        # `imap_auth`, `imap_user` and `imap_password` parameters
         # will also be used to make the connection.
         #
         # @param [Hash] options
@@ -86,6 +95,8 @@ module Ronin
         #   Indicates wether or not to use SSL when connecting to the
         #   server.
         #
+        # @api public
+        #
         def imap_connect(options={},&block)
           options[:port] ||= self.port
           options[:auth] ||= self.imap_auth
@@ -102,8 +113,8 @@ module Ronin
         end
 
         #
-        # Starts a session with the IMAP server. The {#host}, {#port},
-        # {#imap_auth}, {#imap_user} and {#imap_password} parameters
+        # Starts a session with the IMAP server. The `host`, `port`,
+        # `imap_auth`, `imap_user` and `imap_password` parameters
         # will also be used to make the connection.
         #
         # @yield [session]
@@ -116,6 +127,8 @@ module Ronin
         #
         # @see imap_connect
         #
+        # @api public
+        #
         def imap_session(options={})
           imap_connect(options) do |sess|
             yield sess if block_given?

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

@@ -18,6 +18,8 @@
 #
 
 require 'ronin/network/pop3'
+require 'ronin/ui/output/helpers'
+require 'ronin/mixin'
 
 require 'parameters'
 
@@ -27,34 +29,41 @@ module Ronin
       #
       # Adds POP3 convenience methods and connection parameters to a class.
       #
+      # Defines the following parameters:
+      #
+      # * `host` (`String`) - POP3 host.
+      # * `port` (`Integer`) - POP3 port.
+      # * `pop3_user` (`String`) - POP3 user to login as.
+      # * `pop3_password` (`String`) - POP3 password to login with.
+      #
       module POP3
-        include Parameters
+        include Mixin
+
+        mixin UI::Output::Helpers, Parameters
 
-        # POP3 host
-        parameter :host,
-                  :type => String,
-                  :description => 'POP3 host'
+        mixin do
+          # POP3 host
+          parameter :host, :type => String,
+                           :description => 'POP3 host'
 
-        # POP3 port
-        parameter :port,
-                  :type => Integer,
-                  :description => 'POP3 port'
+          # POP3 port
+          parameter :port, :type => Integer,
+                           :description => 'POP3 port'
 
-        # POP3 user
-        parameter :pop3_user,
-                  :type => String,
-                  :description => 'POP3 user to login as'
+          # POP3 user
+          parameter :pop3_user, :type => String,
+                                :description => 'POP3 user to login as'
 
-        # POP3 password
-        parameter :pop3_password,
-                  :type => String,
-                  :description => 'POP3 password to login with'
+          # POP3 password
+          parameter :pop3_password, :type => String,
+                                    :description => 'POP3 password to login with'
+        end
 
         protected
 
         #
-        # Creates a connection to the POP3 server. The {#host}, {#port},
-        # {#pop3_user} and {#pop3_password} parameters will also be used
+        # Creates a connection to the POP3 server. The `host}, `port`,
+        # `pop3_user` and `pop3_password` parameters will also be used
         # to connect to the server.
         #
         # @param [Hash] options
@@ -81,6 +90,8 @@ module Ronin
         # @return [Net::POP3]
         #   The newly created POP3 session.
         #
+        # @api public
+        #
         def pop3_connect(options={},&block)
           options[:port] ||= self.port
           options[:user] ||= self.pop3_user
@@ -96,8 +107,8 @@ module Ronin
         end
 
         #
-        # Starts a session with the POP3 server. The {#host}, {#port},
-        # {#pop3_user} and {#pop3_password} parameters will also be used
+        # Starts a session with the POP3 server. The `host`, `port`,
+        # `pop3_user` and `pop3_password` parameters will also be used
         # to connect to the server.
         #
         # @yield [session]
@@ -110,6 +121,8 @@ module Ronin
         #
         # @see pop3_connect
         #
+        # @api public
+        #
         def pop3_session(options={})
           pop3_connect(options) do |sess|
             yield sess if block_given?

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

@@ -18,6 +18,8 @@
 #
 
 require 'ronin/network/smtp'
+require 'ronin/ui/output/helpers'
+require 'ronin/mixin'
 
 require 'parameters'
 
@@ -27,46 +29,55 @@ module Ronin
       #
       # Adds SMTP convenience methods and connection parameters to a class.
       #
+      # Defines the following parameters:
+      #
+      # * `host` (`String`) - SMTP host.
+      # * `port` (`Integer`) - SMTP port.
+      # * `smtp_login` (`String`) - SMTP authentication method.
+      # * `smtp_user` (`String`) - SMTP user to login as.
+      # * `smtp_password` (`String`) - SMTP password to login with.
+      #
       module SMTP
-        include Parameters
+        include Mixin
 
-        # SMTP host
-        parameter :host,
-                  :type => String,
-                  :description => 'SMTP host'
+        mixin UI::Output::Helpers, Parameters
 
-        # SMTP port
-        parameter :port,
-                  :type => Integer,
-                  :description => 'SMTP port'
+        mixin do
+          # SMTP host
+          parameter :host, :type => String,
+                           :description => 'SMTP host'
 
-        # SMTP authentication method
-        parameter :smtp_login,
-                  :type => String,
-                  :description => 'SMTP authentication method'
+          # SMTP port
+          parameter :port, :type => Integer,
+                           :description => 'SMTP port'
 
-        # SMTP user to login as
-        parameter :smtp_user,
-                  :type => String,
-                  :description => 'SMTP user to login as'
+          # SMTP authentication method
+          parameter :smtp_login, :type => String,
+                                 :description => 'SMTP authentication method'
 
-        # SMTP user to login with
-        parameter :smtp_password,
-                  :type => String,
-                  :description => 'SMTP password to login with'
+          # SMTP user to login as
+          parameter :smtp_user, :type => String,
+                                :description => 'SMTP user to login as'
+
+          # SMTP user to login with
+          parameter :smtp_password, :type => String,
+                                    :description => 'SMTP password to login with'
+        end
 
         protected
 
         #
         # @see Ronin::Network::SMTP.message
         #
+        # @api public
+        #
         def smtp_message(options={},&block)
           Network::SMTP.message(options,&block)
         end
 
         #
-        # Creates a connection to the SMTP server. The {#host}, {#port},
-        # {#smtp_login}, {#smtp_user} and {#smtp_password} parameters
+        # Creates a connection to the SMTP server. The `host`, `port`,
+        # `smtp_login`, `smtp_user` and `smtp_password` parameters
         # will also be used to connect to the server.
         #
         # @param [Hash] options
@@ -97,6 +108,8 @@ module Ronin
         # @return [Net::SMTP]
         #   The SMTP session.
         #
+        # @api public
+        #
         def smtp_connect(options={},&block)
           options[:port] ||= self.port
           options[:login] ||= self.smtp_login
@@ -113,8 +126,8 @@ module Ronin
         end
 
         #
-        # Starts a session with the SMTP server. The {#host}, {#port},
-        # {#smtp_login}, {#smtp_user} and {#smtp_password} parameters
+        # Starts a session with the SMTP server. The `host`, `port`,
+        # `smtp_login`, `smtp_user` and `smtp_password` parameters
         # will also be used to connect to the server.
         #
         # @yield [session]
@@ -126,6 +139,8 @@ module Ronin
         #
         # @see smtp_connect
         #
+        # @api public
+        #
         def smtp_session(options={},&block)
           smtp_connect(options) do |sess|
             yield sess if block_given?

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

@@ -18,6 +18,8 @@
 #
 
 require 'ronin/network/tcp'
+require 'ronin/ui/output/helpers'
+require 'ronin/mixin'
 
 require 'parameters'
 
@@ -27,45 +29,52 @@ module Ronin
       #
       # Adds TCP convenience methods and connection parameters to a class.
       #
+      # Defines the following parameters:
+      #
+      # * `host` (`String`) - TCP host.
+      # * `port` (`Integer`) - TCP port.
+      # * `local_host` (`String`) - TCP local host.
+      # * `local_port` (`Integer`) - TCP local port.
+      # * `server_host` (`String`) - TCP server host.
+      # * `server_port` (`Integer`) - TCP server port.
+      #
       module TCP
-        include Parameters
-
-        # TCP host
-        parameter :host,
-                  :type => String,
-                  :description => 'TCP host'
-
-        # TCP port
-        parameter :port,
-                  :type => Integer,
-                  :description => 'TCP port'
-
-        # TCP local host
-        parameter :local_host,
-                  :type => String,
-                  :description => 'TCP local host'
-
-        # TCP local port
-        parameter :local_port,
-                  :type => Integer,
-                  :description => 'TCP local port'
-
-        # TCP server host
-        parameter :server_host,
-                  :type => String,
-                  :description => 'TCP server host'
-
-        # TCP server port
-        parameter :server_port,
-                  :type => Integer,
-                  :description => 'TCP server port'
+        include Mixin
+
+        mixin UI::Output::Helpers, Parameters
+
+        mixin do
+          # TCP host
+          parameter :host, :type => String,
+                           :description => 'TCP host'
+
+          # TCP port
+          parameter :port, :type => Integer,
+                           :description => 'TCP port'
+
+          # TCP local host
+          parameter :local_host, :type => String,
+                                 :description => 'TCP local host'
+
+          # TCP local port
+          parameter :local_port, :type => Integer,
+                                 :description => 'TCP local port'
+
+          # TCP server host
+          parameter :server_host, :type => String,
+                                  :description => 'TCP server host'
+
+          # TCP server port
+          parameter :server_port, :type => Integer,
+                                  :description => 'TCP server port'
+        end
 
         protected
 
         #
         # Opens a TCP 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 TCP connection.
         #
         # @yield [socket]
@@ -87,6 +96,8 @@ module Ronin
         #     sock.close
         #   end
         #
+        # @api public
+        #
         def tcp_connect(&block)
           print_info "Connecting to #{self.host}:#{self.port} ..."
 
@@ -94,7 +105,7 @@ module Ronin
         end
 
         #
-        # Connects to the host and port specified by the {#host} and {#port}
+        # Connects to the host and port specified by the `host` and `port`
         # parameters, then sends the given data.
         #
         # @param [String] data
@@ -109,6 +120,8 @@ module Ronin
         # @return [TCPSocket]
         #   The newly created TCPSocket object.
         #
+        # @api public
+        #
         def tcp_connect_and_send(data,&block)
           print_info "Connecting to #{self.host}:#{self.port} ..."
           print_debug "Sending data: #{data.inspect}"
@@ -118,7 +131,7 @@ module Ronin
 
         #
         # Creates a TCP session to the host and port specified by the
-        # {#host} and {#port} parameters.
+        # `host` and `port` parameters.
         #
         # @yield [socket]
         #   If a block is given, it will be passed the newly created socket.
@@ -129,6 +142,8 @@ module Ronin
         #
         # @return [nil]
         #
+        # @api public
+        #
         def tcp_session(&block)
           print_info "Connecting to #{self.host}:#{self.port} ..."
 
@@ -139,7 +154,7 @@ module Ronin
         end
 
         #
-        # Connects to the host and port specified by the {#host} and {#port}
+        # Connects to the host and port specified by the `host` and `port`
         # parameters, reads the banner then closes the connection.
         #
         # @yield [banner]
@@ -155,6 +170,8 @@ module Ronin
         #   tcp_banner
         #   # => "220 mx.google.com ESMTP c20sm3096959rvf.1"
         #
+        # @api public
+        #
         def tcp_banner(&block)
           print_debug "Grabbing banner from #{self.host}:#{self.port}"
 
@@ -162,7 +179,7 @@ module Ronin
         end
 
         #
-        # Connects to the host and port specified by the {#host} and {#port}
+        # Connects to the host and port specified by the `host` and `port`
         # parameters, sends the given data and then disconnects.
         #
         # @return [true]
@@ -173,6 +190,8 @@ module Ronin
         #   Net.tcp_send(buffer)
         #   # => true
         #
+        # @api public
+        #
         def tcp_send(data)
           print_info "Connecting to #{self.host}:#{self.port} ..."
           print_debug "Sending data: #{data.inspect}"
@@ -184,8 +203,8 @@ module Ronin
         end
 
         #
-        # Creates a new TCPServer object listening on the {#server_host}
-        # and {#server_port} parameters.
+        # Creates a new TCPServer object listening on the `server_host`
+        # and `server_port` parameters.
         #
         # @yield [server]
         #   The given block will be passed the newly created server.
@@ -199,6 +218,8 @@ module Ronin
         # @example
         #   tcp_server
         #
+        # @api public
+        #
         def tcp_server(&block)
           if self.server_host
             print_info "Listening on #{self.server_host}:#{self.server_port} ..."
@@ -211,7 +232,7 @@ module Ronin
 
         #
         # Creates a new temporary TCPServer 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.
@@ -233,6 +254,8 @@ module Ronin
         #     client2.close
         #   end
         #
+        # @api public
+        #
         def tcp_server_session(&block)
           if self.server_host
             print_info "Listening on #{self.server_host}:#{self.server_port} ..."
@@ -253,7 +276,7 @@ module Ronin
 
         #
         # Creates a new temporary TCPServer object listening on
-        # {#server_host} and {#server_port} parameters.
+        # `server_host` and `server_port` parameters.
         # The TCPServer will accepting one client, pass the newly connected
         # client to a given block, disconnects the client and stops
         # listening.
@@ -273,6 +296,8 @@ module Ronin
         #     client.puts 'lol'
         #   end
         #
+        # @api public
+        #
         def tcp_single_server(&block)
           if self.server_host
             print_info "Listening on #{self.server_host}:#{self.server_port} ..."