ronin-support 0.3.0 → 0.4.0.rc1

data/lib/ronin/network/mixins/imap.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/imap'
-require 'ronin/ui/output/helpers'
-require 'ronin/mixin'
-
-require 'parameters'
 
 module Ronin
   module Network
@@ -38,31 +35,27 @@ module Ronin
       # * `imap_password` (`String`) - IMAP password to login with.
       #
       module IMAP
-        include Mixin
-
-        mixin UI::Output::Helpers, Parameters
+        include Mixin, Network::IMAP
 
-        mixin do
-          # IMAP host
-          parameter :host, :type => String,
-                           :description => 'IMAP host'
+        # 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'
-        end
+        # IMAP password to login with
+        parameter :imap_password, :type => String,
+                                  :description => 'IMAP password to login with'
 
         protected
 
@@ -98,18 +91,9 @@ module Ronin
         # @api public
         #
         def imap_connect(options={},&block)
-          options[:port] ||= self.port
-          options[:auth] ||= self.imap_auth
-          options[:user] ||= self.imap_user
-          options[:password] ||= self.imap_password
+          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.imap_connect(self.host,options,&block)
+          return super(self.host,imap_merge_options(options),&block)
         end
 
         #
@@ -130,20 +114,39 @@ module Ronin
         # @api public
         #
         def imap_session(options={})
-          imap_connect(options) do |sess|
+          super(imap_merge_options(options)) do |sess|
             yield sess if block_given?
 
             print_info "Logging out ..."
+          end
 
-            sess.close
-            sess.logout
+          print_info "Disconnected from #{host_port}"
+          return il
+        end
 
-            if self.port
-              print_info "Disconnecting from #{self.host}:#{self.port}"
-            else
-              print_info "Disconnecting from #{self.host}"
-            end
-          end
+        private
+
+        #
+        # Merges the IMAP parameters into the options for {Network::IMAP}
+        # methods.
+        #
+        # @param [Hash] options
+        #   The original options.
+        #
+        # @return [Hash]
+        #   The merged options.
+        #
+        # @since 0.4.0
+        #
+        # @api private
+        #   
+        def imap_merge_options(options={})
+          options[:port]     ||= self.port
+          options[:auth]     ||= self.imap_auth
+          options[:user]     ||= self.imap_user
+          options[:password] ||= self.imap_password
+
+          return options
         end
       end
     end

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

@@ -0,0 +1,58 @@
+#
+# Copyright (c) 2006-2011 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of Ronin Support.
+#
+# Ronin Support is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ronin Support is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require 'ronin/ui/output/helpers'
+
+require 'parameters'
+
+module Ronin
+  module Network
+    module Mixins
+      #
+      # @since 0.4.0
+      #
+      module Mixin
+        include Parameters,
+                UI::Output::Helpers
+
+        parameter :host, :type => String
+
+        parameter :port, :type => Integer
+
+        protected
+
+        #
+        # The host/port parameters.
+        #
+        # @return [String]
+        #   The host/port parameters in String form.
+        #
+        # @api semipublic
+        #
+        def host_port
+          if self.port
+            "#{self.host}:#{self.port}"
+          else
+            "#{self.host}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ronin/network/mixins/pop3.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/pop3'
-require 'ronin/ui/output/helpers'
-require 'ronin/mixin'
-
-require 'parameters'
 
 module Ronin
   module Network
@@ -37,27 +34,23 @@ module Ronin
       # * `pop3_password` (`String`) - POP3 password to login with.
       #
       module POP3
-        include Mixin
-
-        mixin UI::Output::Helpers, Parameters
+        include Mixin, Network::POP3
 
-        mixin do
-          # POP3 host
-          parameter :host, :type => String,
-                           :description => 'POP3 host'
+        # 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'
-        end
+        # POP3 password
+        parameter :pop3_password, :type => String,
+                                  :description => 'POP3 password to login with'
 
         protected
 
@@ -93,17 +86,9 @@ module Ronin
         # @api public
         #
         def pop3_connect(options={},&block)
-          options[:port] ||= self.port
-          options[:user] ||= self.pop3_user
-          options[:password] ||= self.pop3_password
+          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.pop3_connect(self.host,options,&block)
+          return super(self.host,pop3_merge_options(options),&block)
         end
 
         #
@@ -124,16 +109,37 @@ module Ronin
         # @api public
         #
         def pop3_session(options={})
-          pop3_connect(options) do |sess|
+          super(options) do |sess|
             yield sess if block_given?
-            sess.finish
 
-            if @port
-              print_info "Disconnecting to #{self.host}:#{self.port}"
-            else
-              print_info "Disconnecting to #{self.host}"
-            end
+            print_info "Logging out ..."
           end
+
+          print_info "Disconnected to #{host_port}"
+        end
+
+        private
+
+        #
+        # Merges the POP3 parameters into the options for {Network::POP3}
+        # methods.
+        #
+        # @param [Hash] options
+        #   The original options.
+        #
+        # @return [Hash]
+        #   The merged options.
+        #
+        # @since 0.4.0
+        #
+        # @api private
+        #   
+        def pop3_merge_options(options={})
+          options[:port]     ||= self.port
+          options[:user]     ||= self.pop3_user
+          options[:password] ||= self.pop3_password
+
+          return options
         end
       end
     end

data/lib/ronin/network/mixins/smtp.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/smtp'
-require 'ronin/ui/output/helpers'
-require 'ronin/mixin'
-
-require 'parameters'
 
 module Ronin
   module Network
@@ -38,43 +35,30 @@ module Ronin
       # * `smtp_password` (`String`) - SMTP password to login with.
       #
       module SMTP
-        include Mixin
-
-        mixin UI::Output::Helpers, Parameters
+        include Mixin, Network::SMTP
 
-        mixin do
-          # SMTP host
-          parameter :host, :type => String,
-                           :description => 'SMTP host'
+        # SMTP host
+        parameter :host, :type => String,
+                         :description => 'SMTP host'
 
-          # SMTP port
-          parameter :port, :type => Integer,
-                           :description => 'SMTP port'
+        # SMTP port
+        parameter :port, :type => Integer,
+                         :description => 'SMTP port'
 
-          # SMTP authentication method
-          parameter :smtp_login, :type => String,
-                                 :description => 'SMTP authentication method'
+        # SMTP authentication method
+        parameter :smtp_login, :type => String,
+                               :description => 'SMTP authentication method'
 
-          # SMTP user to login as
-          parameter :smtp_user, :type => String,
-                                :description => 'SMTP user to login as'
+        # 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
+        # SMTP user to login with
+        parameter :smtp_password, :type => String,
+                                  :description => 'SMTP password to login with'
 
         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
@@ -111,18 +95,9 @@ module Ronin
         # @api public
         #
         def smtp_connect(options={},&block)
-          options[:port] ||= self.port
-          options[:login] ||= self.smtp_login
-          options[:user] ||= self.smtp_user
-          options[:password] ||= self.smtp_password
-
-          if self.port
-            print_info "Connecting to #{self.host}:#{self.port} ..."
-          else
-            print_info "Connecting to #{self.host} ..."
-          end
+          print_info "Connecting to #{host_port} ..."
 
-          return ::Net.smtp_connect(self.host,options,&block)
+          return super(self.host,smtp_merge_options(options),&block)
         end
 
         #
@@ -142,16 +117,39 @@ module Ronin
         # @api public
         #
         def smtp_session(options={},&block)
-          smtp_connect(options) do |sess|
+          super(smtp_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_info "Logging out ..."
           end
+
+          print_info "Disconnected to #{host_port}"
+          return nil
+        end
+
+        private
+
+        #
+        # Merges the SMTP parameters into the options for {Network::SMTP}
+        # methods.
+        #
+        # @param [Hash] options
+        #   The original options.
+        #
+        # @return [Hash]
+        #   The merged options.
+        #
+        # @since 0.4.0
+        #
+        # @api private
+        #   
+        def smtp_merge_options(options={})
+          options[:port]     ||= self.port
+          options[:login]    ||= self.smtp_login
+          options[:user]     ||= self.smtp_user
+          options[:password] ||= self.smtp_password
+
+          return options
         end
       end
     end

data/lib/ronin/network/mixins/tcp.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/tcp'
-require 'ronin/ui/output/helpers'
-require 'ronin/mixin'
-
-require 'parameters'
 
 module Ronin
   module Network
@@ -39,35 +36,31 @@ module Ronin
       # * `server_port` (`Integer`) - TCP server port.
       #
       module TCP
-        include Mixin
-
-        mixin UI::Output::Helpers, Parameters
+        include Mixin, Network::TCP
 
-        mixin do
-          # TCP host
-          parameter :host, :type => String,
-                           :description => 'TCP host'
+        # TCP host
+        parameter :host, :type => String,
+                         :description => 'TCP host'
 
-          # TCP port
-          parameter :port, :type => Integer,
-                           :description => 'TCP port'
+        # TCP port
+        parameter :port, :type => Integer,
+                         :description => 'TCP port'
 
-          # TCP local host
-          parameter :local_host, :type => String,
-                                 :description => 'TCP local host'
+        # 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 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 host
+        parameter :server_host, :type => String,
+                                :description => 'TCP server host'
 
-          # TCP server port
-          parameter :server_port, :type => Integer,
-                                  :description => 'TCP server port'
-        end
+        # TCP server port
+        parameter :server_port, :type => Integer,
+                                :description => 'TCP server port'
 
         protected
 
@@ -99,9 +92,9 @@ module Ronin
         # @api public
         #
         def tcp_connect(&block)
-          print_info "Connecting to #{self.host}:#{self.port} ..."
+          print_info "Connecting to #{host_port} ..."
 
-          return ::Net.tcp_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
 
         #
@@ -123,10 +116,10 @@ module Ronin
         # @api public
         #
         def tcp_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.tcp_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
 
         #
@@ -145,11 +138,11 @@ module Ronin
         # @api public
         #
         def tcp_session(&block)
-          print_info "Connecting to #{self.host}:#{self.port} ..."
+          print_info "Connecting to #{host_port} ..."
 
           Net.tcp_session(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
 
@@ -173,9 +166,9 @@ module Ronin
         # @api public
         #
         def tcp_banner(&block)
-          print_debug "Grabbing banner from #{self.host}:#{self.port}"
+          print_debug "Grabbing banner from #{host_port}"
 
-          return ::Net.tcp_banner(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
 
         #
@@ -193,12 +186,12 @@ module Ronin
         # @api public
         #
         def tcp_send(data)
-          print_info "Connecting to #{self.host}:#{self.port} ..."
+          print_info "Connecting to #{host_port} ..."
           print_debug "Sending data: #{data.inspect}"
 
-          ::Net.tcp_send(data,self.host,self.port,self.local_host,self.local_port)
+          super(data,self.host,self.port,self.local_host,self.local_port)
 
-          print_info "Disconnected from #{self.host}:#{self.port}"
+          print_info "Disconnected from #{host_port}"
           return true
         end
 
@@ -221,13 +214,9 @@ module Ronin
         # @api public
         #
         def tcp_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 #{self.server_host_port} ..."
 
-          return ::Net.tcp_server(self.server_port,self.server_host,&block)
+          return super(self.server_port,self.server_host,&block)
         end
 
         #
@@ -257,20 +246,11 @@ module Ronin
         # @api public
         #
         def tcp_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 #{server_host_port} ..."
 
-          ::Net.tcp_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 #{server_host_port}"
           return nil
         end
 
@@ -299,13 +279,9 @@ module Ronin
         # @api public
         #
         def tcp_single_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} ..."
 
-          ::Net.tcp_single_server do |client|
+          super(self.server_port,self.server_host) do |client|
             client_addr = client.peeraddr
             client_host = (client_addr[2] || client_addr[3])
             client_port = client_addr[1]
@@ -314,17 +290,28 @@ module Ronin
 
             yield client if block_given?
 
-            print_info "Disconnecting client #{client_host}:#{client_port}"
-          end
-
-          if self.server_host
-            print_info "Closed #{self.server_host}:#{self.server_port}"
-          else
-            print_info "Closed #{self.server_port}"
+            print_info "Disconnected client #{client_host}:#{client_port}"
           end
 
+          print_info "Closed #{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