ronin-support 0.3.0 → 0.4.0.rc1

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

@@ -17,11 +17,8 @@
 # along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
 #
 
+require 'ronin/network/mixins/mixin'
 require 'ronin/network/telnet'
-require 'ronin/ui/output/helpers'
-require 'ronin/mixin'
-
-require 'parameters'
 
 module Ronin
   module Network
@@ -40,34 +37,30 @@ module Ronin
       # * `telnet_ssl` (`Boolean`) - Enable Telnet over SSL. Defaults to `true`.
       #
       module Telnet
-        include Mixin
-
-        mixin UI::Output::Helpers, Parameters
+        include Mixin, Network::Telnet
 
-        mixin do
-          # Telnet host
-          parameter :host, :type => String,
-                           :description => 'Telnet host'
+        # 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'
-        end
+        # Enable Telnet SSL
+        parameter :telnet_ssl, :type => true,
+                               :description => 'Enable Telnet over SSL'
 
         protected
 
@@ -80,7 +73,7 @@ module Ronin
         # @param [Hash] options
         #   Additional options.
         #
-        # @option options [Integer] :port (Ronin::Network::Telnet.default_port)
+        # @option options [Integer] :port (Network::Telnet.default_port)
         #   The port to connect to.
         #
         # @option options [Boolean] :binmode
@@ -94,7 +87,7 @@ module Ronin
         #   Similar to the `:output_log` option, but connection output
         #   is also written in hexdump format.
         #
-        # @option options [Regexp] :prompt (Ronin::Network::Telnet.default_prompt)
+        # @option options [Regexp] :prompt (Network::Telnet.default_prompt)
         #   A regular expression matching the host command-line prompt
         #   sequence, used to determine when a command has finished.
         #
@@ -106,7 +99,7 @@ module Ronin
         #   Indicates that the connection shall behave as a normal TCP
         #   connection.
         #
-        # @option options [Integer] :timeout (Ronin::Network::Telnet.default_timeout)
+        # @option options [Integer] :timeout (Network::Telnet.default_timeout)
         #   The number of seconds to wait before timing out both the
         #   initial attempt to connect to host, and all attempts to read
         #   data from the host.
@@ -115,7 +108,7 @@ module Ronin
         #   The amount of time to wait after seeing what looks like
         #   a prompt.
         #
-        # @option options [Net::Telnet, IO] :proxy (Ronin::Network::Telnet.proxy)
+        # @option options [Net::Telnet, IO] :proxy (Network::Telnet.proxy)
         #   A proxy object to used instead of opening a direct connection
         #   to the host.
         #
@@ -142,20 +135,9 @@ module Ronin
         # @api public
         #
         def telnet_connect(options={},&block)
-          options[:port] ||= self.port
-          options[:user] ||= self.telnet_user
-          options[:password] ||= self.telnet_password
-
-          options[:proxy] ||= self.telnet_proxy
-          options[:ssl] ||= self.telnet_ssl
+          print_info "Connecting to #{host_port} ..."
 
-          if self.port
-            print_info "Connecting to #{self.host}:#{self.port} ..."
-          else
-            print_info "Connecting to #{self.host} ..."
-          end
-
-          return ::Net.telnet_connect(self.host,options,&block)
+          return super(self.host,telnet_merge_options(options),&block)
         end
 
         #
@@ -182,16 +164,41 @@ module Ronin
         # @api public
         #
         def telnet_session(options={},&block)
-          return telnet_connect(options) do |sess|
+          super(telnet_merge_options(options)) do |sess|
             yield sess if block_given?
-            sess.close
 
-            if self.port
-              print_info "Disconnecting to #{self.host}:#{self.port}"
-            else
-              print_info "Disconnecting to #{self.host}"
-            end
+            print "Logging out ..."
           end
+
+          print_info "Disconnected to #{host_port}"
+          return nil
+        end
+
+        private
+
+        #
+        # Merges the Telnet parameters into the options for {Network::Telnet}
+        # methods.
+        #
+        # @param [Hash] options
+        #   The original options.
+        #
+        # @return [Hash]
+        #   The merged options.
+        #
+        # @since 0.4.0
+        #
+        # @api private
+        #   
+        def telnet_merge_options(options={})
+          options[:port]     ||= self.port
+          options[:user]     ||= self.telnet_user
+          options[:password] ||= self.telnet_password
+
+          options[:proxy] ||= self.telnet_proxy
+          options[:ssl]   ||= self.telnet_ssl
+
+          return options
         end
       end
     end

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

@@ -17,11 +17,8 @@
 # along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
 #
 
+require 'ronin/network/mixins/mixin'
 require 'ronin/network/udp'
-require 'ronin/ui/output/helpers'
-require 'ronin/mixin'
-
-require 'parameters'
 
 module Ronin
   module Network
@@ -39,35 +36,31 @@ module Ronin
       # * `server_port` (`Integer`) - UDP server port.
       #
       module UDP
-        include Mixin
-
-        mixin UI::Output::Helpers, Parameters
+        include Mixin, Network::UDP
 
-        mixin do
-          # UDP host
-          parameter :host, :type => String,
-                           :description => 'UDP host'
+        # UDP host
+        parameter :host, :type => String,
+                         :description => 'UDP host'
 
-          # UDP port
-          parameter :port, :type => Integer,
-                           :description => 'UDP port'
+        # UDP port
+        parameter :port, :type => Integer,
+                         :description => 'UDP port'
 
-          # UDP local host
-          parameter :local_host, :type => String,
-                                 :description => 'UDP local host'
+        # 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 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 host
+        parameter :server_host, :type => String,
+                                :description => 'UDP server host'
 
-          # UDP server port
-          parameter :server_port, :type => Integer,
-                                  :description => 'UDP server port'
-        end
+        # UDP server port
+        parameter :server_port, :type => Integer,
+                                :description => 'UDP server port'
 
         protected
 
@@ -98,9 +91,9 @@ module Ronin
         # @api public
         #
         def udp_connect(&block)
-          print_info "Connecting to #{self.host}:#{self.port} ..."
+          print_info "Connecting to #{host_port} ..."
 
-          return ::Net.udp_connect(self.host,self.port,self.local_host,self.local_port,&block)
+          return super(self.host,self.port,self.local_host,self.local_port,&block)
         end
 
         #
@@ -124,10 +117,10 @@ module Ronin
         # @api public
         #
         def udp_connect_and_send(data,&block)
-          print_info "Connecting to #{self.host}:#{self.port} ..."
+          print_info "Connecting to #{host_port} ..."
           print_debug "Sending data: #{data.inspect}"
 
-          return ::Net.udp_connect_and_send(data,self.host,self.port,self.local_host,self.local_port,&block)
+          return super(data,self.host,self.port,self.local_host,self.local_port,&block)
         end
 
         #
@@ -148,11 +141,11 @@ module Ronin
         # @api public
         #
         def udp_session(&block)
-          print_info "Connecting to #{self.host}:#{self.port} ..."
+          print_info "Connecting to #{host_port} ..."
 
-          ::Net.udp_session(self.host,self.port,self.local_host,self.local_port,&block)
+          super(self.host,self.port,self.local_host,self.local_port,&block)
 
-          print_info "Disconnected from #{self.host}:#{self.port}"
+          print_info "Disconnected from #{host_port}"
           return nil
         end
 
@@ -175,13 +168,9 @@ module Ronin
         # @api public
         #
         def udp_server(&block)
-          if self.server_host
-            print_info "Listening on #{self.server_host}:#{self.server_port} ..."
-          else
-            print_info "Listening on #{self.server_port} ..."
-          end
+          print_info "Listening on #{server_host_port} ..."
 
-          return ::Net.udp_server(self.server_port,self.server_host,&block)
+          return super(self.server_port,self.server_host,&block)
         end
 
         #
@@ -205,22 +194,29 @@ module Ronin
         # @api public
         #
         def udp_server_session(&block)
-          if self.server_host
-            print_info "Listening on #{self.server_host}:#{self.server_port} ..."
-          else
-            print_info "Listening on #{self.server_port} ..."
-          end
+          print_info "Listening on #{self.server_host_port} ..."
 
-          ::Net.udp_server_session(&block)
-
-          if self.server_host
-            print_info "Closed #{self.server_host}:#{self.server_port}"
-          else
-            print_info "Closed #{self.server_port}"
-          end
+          super(self.server_port,self.server_host,&block)
 
+          print_info "Closed #{self.server_host_port}"
           return nil
         end
+
+        private
+
+        #
+        # The server host/port parameters.
+        #
+        # @return [String]
+        #   The server host/port parameters in String form.
+        #
+        # @since 0.4.0
+        #
+        # @api private
+        #
+        def server_host_port
+          "#{self.server_host}:#{self.server_port}"
+        end
       end
     end
   end

data/lib/ronin/network/network.rb

@@ -27,6 +27,7 @@ module Ronin
   # Network helper methods.
   #
   module Network
+    # The URL used for determining the external IP Address.
     IP_URL = URI.parse('http://checkip.dyndns.org/')
 
     #

data/lib/ronin/network/pop3.rb

@@ -17,12 +17,12 @@
 # along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-require 'ronin/network/extensions/pop3'
+require 'net/pop'
 
 module Ronin
   module Network
     #
-    # Global settings for accessing POP3.
+    # Provides helper methods for communicating with POP3 services.
     #
     module POP3
       # Default POP3 port
@@ -49,6 +49,76 @@ module Ronin
       def POP3.default_port=(port)
         @default_port = port
       end
+
+      #
+      # Creates a connection to the POP3 server.
+      #
+      # @param [String] host
+      #   The host to connect to.
+      #
+      # @param [Hash] options
+      #   Additional options.
+      #
+      # @option options [Integer] :port (POP3.default_port)
+      #   The port the POP3 server is running on.
+      #
+      # @option options [String] :user
+      #   The user to authenticate with when connecting to the POP3 server.
+      #
+      # @option options [String] :password
+      #   The password to authenticate with when connecting to the POP3 server.
+      #
+      # @yield [session]
+      #   If a block is given, it will be passed the newly created POP3 session.
+      #
+      # @yieldparam [Net::POP3] session
+      #   The newly created POP3 session.
+      #
+      # @return [Net::POP3]
+      #   The newly created POP3 session.
+      #
+      # @api public
+      #
+      def pop3_connect(host,options={})
+        host = host.to_s
+        port = (options[:port] || POP3.default_port)
+        user = options[:user]
+        password = options[:password]
+
+        session = Net::POP3.start(host,port,user,password)
+
+        yield session if block_given?
+        return session
+      end
+
+      #
+      # Starts a session with the POP3 server.
+      #
+      # @param [String] host
+      #   The host to connect to.
+      #
+      # @param [Hash] options
+      #   Additional options.
+      #
+      # @yield [session]
+      #   If a block is given, it will be passed the newly created POP3 session.
+      #   After the block has returned, the session will be closed.
+      #
+      # @yieldparam [Net::POP3] session
+      #   The newly created POP3 session.
+      #
+      # @return [nil]
+      #
+      # @api public
+      #
+      def pop3_session(host,options={})
+        session = pop3_connect(host,options)
+
+        yield session if block_given?
+
+        session.finish
+        return nil
+      end
     end
   end
 end

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

@@ -25,6 +25,7 @@ module Ronin
       #
       class Email
 
+        # The CR-LF String
         CRLF = "\n\r"
 
         # Sender of the email

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

@@ -19,10 +19,12 @@
 
 require 'ronin/network/smtp/email'
 
+require 'net/smtp'
+
 module Ronin
   module Network
     #
-    # Global settings for accessing STMP.
+    # Provides helper methods for communicating with SMTP services.
     #
     module SMTP
       # Default SMTP port
@@ -57,19 +59,173 @@ module Ronin
       #   If a block is given, it will be passed the newly created Email
       #   object.
       #
-      # @yieldparam [Ronin::Network::Email::SMTP] email
+      # @yieldparam [Email] email
       #   The new Email object.
       #
       # @return [String]
       #   Formatted SMTP email.
       #
-      # @see Ronin::Network::SMTP::Email
+      # @see SMTP::Email
       #
       # @api public
       #
       def SMTP.message(options={},&block)
         Email.new(options,&block).to_s
       end
+
+      #
+      # Creates a new email message.
+      #
+      # @param [Hash] options
+      #   Additional options for the email.
+      #
+      # @yield [email]
+      #   The given block will be passed the new email.
+      #
+      # @yieldparam [Email] email
+      #   The new email.
+      #
+      # @see Email.new
+      #
+      # @api public
+      #
+      def smtp_message(options={},&block)
+        Email.new(options,&block)
+      end
+
+      #
+      # Creates a connection to the SMTP server.
+      #
+      # @param [String] host
+      #   The host to connect to.
+      #
+      # @param [Hash] options
+      #   Additional options.
+      #
+      # @option options [Integer] :port (SMTP.default_port)
+      #   The port to connect to.
+      #
+      # @option options [String] :helo
+      #   The HELO domain.
+      #
+      # @option options [Symbol] :auth
+      #   The type of authentication to use. Can be either `:login`, `:plain`,
+      #   or `:cram_md5`.
+      #
+      # @option options [String] :user
+      #   The user-name to authenticate with.
+      #
+      # @option options [String] :password
+      #   The password to authenticate with.
+      #
+      # @yield [session]
+      #   If a block is given, it will be passed an SMTP session object.
+      #
+      # @yieldparam [Net::SMTP] session
+      #   The SMTP session.
+      #
+      # @return [Net::SMTP]
+      #   The SMTP session.
+      #
+      # @example
+      #   smtp_connect('www.example.com', :user => 'joe')
+      #
+      # @api public
+      #
+      def smtp_connect(host,options={})
+        host = host.to_s
+        port = (options[:port] || SMTP.default_port)
+
+        helo = options[:helo]
+
+        auth = options[:auth]
+        user = options[:user]
+        password = options[:password]
+
+        session = Net::SMTP.start(host,port,helo,user,password,auth)
+
+        yield session if block_given?
+        return session
+      end
+
+      #
+      # Starts a session with the SMTP server.
+      #
+      # @param [String] host
+      #   The host to connect to.
+      #
+      # @param [Hash] options
+      #   Additional options.
+      #
+      # @yield [session]
+      #   If a block is given, it will be passed an SMTP session object.
+      #   After the block has returned, the session will be closed.
+      #
+      # @yieldparam [Net::SMTP] session
+      #   The SMTP session.
+      #
+      # @example
+      #   smtp_session('www.example.com', :user => 'joe') do |smtp|
+      #     # ...
+      #   end
+      #
+      # @see smtp_connect
+      #
+      # @api public
+      #
+      def smtp_session(host,options={})
+        session = smtp_connect(host,options)
+
+        yield session if block_given?
+
+        session.finish
+        return nil
+      end
+
+      #
+      # @since 0.2.0
+      #
+      # @param [String] host
+      #   The host to connect to.
+      #
+      # @param [Hash] options
+      #   Additional SMTP and Email options.
+      #
+      # @yield [email]
+      #   The given block will be passed the new email to be sent.
+      #
+      # @yieldparam [SMTP::Email] email
+      #   The new email to be sent.
+      #
+      # @see smtp_session
+      #
+      # @example
+      #   smtp_send_message 'www.example.com', :to => 'joe@example.com',
+      #                                        :from => 'eve@example.com',
+      #                                        :subject => 'Hello',
+      #                                        :message_id => 'XXXX',
+      #                                        :body => 'Hello'
+      #
+      # @example Using the block.
+      #   smtp_send_message('www.example.com') do |email|
+      #     email.to = 'joe@example.com'
+      #     email.from 'eve@example.com'
+      #     email.subject = 'Hello'
+      #     email.message_id = 'XXXXXXXXXX'
+      #     email.body << 'Hello!'
+      #   end
+      #
+      # @since 0.2.0
+      #
+      # @api public
+      #
+      def smtp_send_message(host,options={},&block)
+        email = smtp_message(options,&block)
+
+        smtp_session(host,options) do |smtp|
+          smtp.send_message(email.to_s, email.from, email.to)
+        end
+      end
     end
   end
 end