ronin-support 0.3.0 → 0.4.0.rc1

data/lib/ronin/network/imap.rb

@@ -17,12 +17,14 @@
 # along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-require 'ronin/network/extensions/imap'
+require 'ronin/network/ssl'
+
+require 'net/imap'
 
 module Ronin
   module Network
     #
-    # Global settings for accessing IMAP.
+    # Provides helper methods for communicating with IMAP services.
     #
     module IMAP
       # Default IMAP port
@@ -49,6 +51,107 @@ module Ronin
       def IMAP.default_port=(port)
         @default_port = port
       end
+
+      #
+      # Creates a connection to the IMAP server.
+      #
+      # @param [String] host
+      #   The host to connect to.
+      #
+      # @param [Hash] options
+      #   Additional options.
+      #
+      # @option options [Integer] :port (IMAP.default_port)
+      #   The port the IMAP server is running on.
+      #
+      # @option options [String] :certs
+      #   The path to the file containing CA certs of the server.
+      #
+      # @option options [Symbol] :auth
+      #   The type of authentication to perform when connecting to the server.
+      #   May be either `:login` or `:cram_md5`.
+      #
+      # @option options [String] :user
+      #   The user to authenticate as when connecting to the server.
+      #
+      # @option options [String] :password
+      #   The password to authenticate with when connecting to the server.
+      #
+      # @yield [session]
+      #   If a block is given, it will be passed the newly created IMAP
+      #   session.
+      #
+      # @yieldparam [Net::IMAP] session
+      #   The newly created IMAP session object.
+      #
+      # @return [Net::IMAP]
+      #   The newly created IMAP session object.
+      #
+      # @api public
+      #
+      def imap_connect(host,options={})
+        host = host.to_s
+        port = (options[:port] || IMAP.default_port)
+        certs = options[:certs]
+        auth = options[:auth]
+        user = options[:user]
+        passwd = options[:password]
+
+        if options[:ssl]
+          ssl = true
+          ssl_certs = options[:ssl][:certs]
+          ssl_verify = SSL::VERIFY[options[:ssl][:verify]]
+        else
+          ssl = false
+          ssl_verify = false
+        end
+
+        session = Net::IMAP.new(host,port,ssl,ssl_certs,ssl_verify)
+
+        if user
+          if auth == :cram_md5
+            session.authenticate('CRAM-MD5',user,passwd)
+          else
+            session.authenticate('LOGIN',user,passwd)
+          end
+        end
+
+        yield session if block_given?
+        return session
+      end
+
+      #
+      # Starts an IMAP session with the IMAP 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 IMAP
+      #   session. After the block has returned, the session will be closed.
+      #
+      # @yieldparam [Net::IMAP] session
+      #   The newly created IMAP session object.
+      #
+      # @return [nil]
+      #
+      # @see imap_connect
+      #
+      # @api public
+      #
+      def imap_session(host,options={})
+        session = imap_connect(host,options)
+
+        yield session if block_given?
+
+        session.logout if options[:user]
+        session.close
+        session.disconnect
+        return nil
+      end
     end
   end
 end

data/lib/ronin/network/mixins.rb

@@ -24,4 +24,4 @@ require 'ronin/network/mixins/esmtp'
 require 'ronin/network/mixins/pop3'
 require 'ronin/network/mixins/imap'
 require 'ronin/network/mixins/telnet'
-require 'ronin/network/mixins/web'
+require 'ronin/network/mixins/http'

data/lib/ronin/network/mixins/esmtp.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/esmtp'
-require 'ronin/ui/output/helpers'
-require 'ronin/mixin'
-
-require 'parameters'
 
 module Ronin
   module Network
@@ -38,43 +35,30 @@ module Ronin
       # * `esmtp_password` (`String`) - ESMTP password to login with.
       #
       module ESMTP
-        include Mixin
-
-        mixin UI::Output::Helpers, Parameters
+        include Mixin, Network::ESMTP
 
-        mixin do
-          # ESMTP host
-          parameter :host, :type => String,
-                           :description => 'ESMTP host'
+        # ESMTP host
+        parameter :host, :type => String,
+                         :description => 'ESMTP host'
 
-          # ESMTP port
-          parameter :port, :type => Integer,
-                           :description => 'ESMTP port'
+        # ESMTP port
+        parameter :port, :type => Integer,
+                         :description => 'ESMTP port'
 
-          # ESMTP authentication method to use
-          parameter :esmtp_login, :type => String,
-                                  :description => 'ESMTP authentication method to use'
+        # ESMTP authentication method to use
+        parameter :esmtp_login, :type => String,
+                                :description => 'ESMTP authentication method to use'
 
-          # ESMTP user to login as
-          parameter :esmtp_user, :type => String,
-                                 :description => 'ESMTP user to login as'
+        # ESMTP user to login as
+        parameter :esmtp_user, :type => String,
+                               :description => 'ESMTP user to login as'
 
-          # ESMTP password to login with
-          parameter :esmtp_password, :type => String,
-                                     :description => 'ESMTP password to login with'
-        end
+        # ESMTP password to login with
+        parameter :esmtp_password, :type => String,
+                                   :description => 'ESMTP password to login with'
 
         protected
 
-        #
-        # @see Ronin::Network::SMTP.message.
-        #
-        # @api public
-        #
-        def esmtp_message(options={},&block)
-          Network::SMTP.message(options,&block)
-        end
-
         #
         # Creates a connection to the ESMTP server. The `host`, `port`,
         # `esmtp_login`, `esmtp_user` and `esmtp_password` parameters
@@ -112,18 +96,9 @@ module Ronin
         # @api public
         #
         def esmtp_connect(options={},&block)
-          options[:port] ||= self.port
-          options[:login] ||= self.esmtp_login
-          options[:user] ||= self.esmtp_user
-          options[:password] ||= self.esmtp_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.esmtp_connect(self.host,options,&block)
+          return super(self.host,esmtp_merge_options(options),&block)
         end
 
         #
@@ -147,17 +122,39 @@ module Ronin
         # @api public
         #
         def esmtp_session(options={})
-          esmtp_connect(options) do |sess|
+          super(esmtp_merge_options(options)) do |sess|
             yield sess if block_given?
 
-            sess.close
-
-            if self.port
-              print_info "Disconnecting from #{self.host}:#{self.port}"
-            else
-              print_info "Disconnecting from #{self.host}"
-            end
+            print_info "Logging out ..."
           end
+
+          print_info "Disconnected from #{host_port}"
+          return nil
+        end
+
+        private
+
+        #
+        # Merges the ESMTP parameters into the options for {Network::ESMTP}
+        # methods.
+        #
+        # @param [Hash] options
+        #   The original options.
+        #
+        # @return [Hash]
+        #   The merged options.
+        #
+        # @since 0.4.0
+        #
+        # @api private
+        #   
+        def esmtp_merge_options(options={})
+          options[:port]     ||= self.port
+          options[:login]    ||= self.esmtp_login
+          options[:user]     ||= self.esmtp_user
+          options[:password] ||= self.esmtp_password
+
+          return options
         end
       end
     end

data/lib/ronin/network/mixins/http.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/http'
-require 'ronin/ui/output/helpers'
-require 'ronin/mixin'
-
-require 'parameters'
 
 module Ronin
   module Network
@@ -40,38 +37,34 @@ module Ronin
       # * `http_user_agent` (`String`) - HTTP User-Agent header to send.
       #
       module HTTP
-        include Mixin
-
-        mixin UI::Output::Helpers, Parameters
+        include Mixin, Network::HTTP
 
-        mixin do
-          # HTTP host
-          parameter :host, :type => String,
-                           :description => 'HTTP host'
+        # HTTP host
+        parameter :host, :type => String,
+                         :description => 'HTTP host'
 
-          # HTTP port
-          parameter :port, :default => Net::HTTP.default_port,
-                           :description => 'HTTP port'
+        # HTTP port
+        parameter :port, :default => Net::HTTP.default_port,
+                         :description => 'HTTP port'
 
-          # HTTP `Host` header to send
-          parameter :http_vhost, :type => String,
-                                 :description => 'HTTP Host header to send'
+        # HTTP `Host` header to send
+        parameter :http_vhost, :type => String,
+                               :description => 'HTTP Host header to send'
 
-          # HTTP user to authenticate as
-          parameter :http_user, :type => String,
-                                :description => 'HTTP user to authenticate as'
+        # HTTP user to authenticate as
+        parameter :http_user, :type => String,
+                              :description => 'HTTP user to authenticate as'
 
-          # HTTP password to authenticate with
-          parameter :http_password, :type => String,
-                                    :description => 'HTTP password to authenticate with'
+        # HTTP password to authenticate with
+        parameter :http_password, :type => String,
+                                  :description => 'HTTP password to authenticate with'
 
-          # HTTP proxy information
-          parameter :http_proxy, :description => 'HTTP proxy information'
+        # HTTP proxy information
+        parameter :http_proxy, :description => 'HTTP proxy information'
 
-          # HTTP `User-Agent` header to send
-          parameter :http_user_agent, :type => String,
-                                      :description => 'HTTP User-Agent header to send'
-        end
+        # HTTP `User-Agent` header to send
+        parameter :http_user_agent, :type => String,
+                                    :description => 'HTTP User-Agent header to send'
 
         protected
 
@@ -122,14 +115,17 @@ module Ronin
         #
         # @api public
         #
-        def http_session(options={})
+        def http_session(options={},&block)
           options = http_merge_options(options)
-          host_port = "#{options[:host]}:#{options[:port]}"
 
-          Net.http_session(options) do |http|
+          super(options) do |http,expanded_options|
             print_info "Starting HTTP Session with #{host_port}"
 
-            yield http
+            if block.arity == 2
+              block.call(sess,expanded_options)
+            else
+              block.call(sess)
+            end
 
             print_info "Closing HTTP Session with #{host_port}"
           end
@@ -168,7 +164,7 @@ module Ronin
           options = http_merge_options(options)
           print_info "HTTP #{options[:method]} #{http_options_to_s(options)}"
 
-          return Net.http_request(options,&block)
+          return super(options,&block)
         end
 
         #
@@ -192,7 +188,7 @@ module Ronin
         def http_status(options={})
           options = http_merge_options(options)
 
-          if (result = Net.http_status(options))
+          if (result = super(options))
             print_debug "HTTP #{result} #{http_options_to_s(options)}"
           end
 
@@ -220,7 +216,7 @@ module Ronin
         def http_ok?(options={})
           options = http_merge_options(options)
 
-          if (result = Net.http_ok?(options))
+          if (result = super(options))
             print_debug "HTTP 200 OK #{http_options_to_s(options)}"
           end
 
@@ -248,7 +244,7 @@ module Ronin
         def http_server(options={})
           options = http_merge_options(options)
 
-          if (result = Net.http_server(options))
+          if (result = super(options))
             print_debug "HTTP Server: #{result}"
           end
 
@@ -276,7 +272,7 @@ module Ronin
         def http_powered_by(options={})
           options = http_merge_options(options)
 
-          if (result = Net.http_powered_by(options))
+          if (result = super(options))
             print_debug "HTTP X-Powered-By: #{result}"
           end
 
@@ -304,7 +300,7 @@ module Ronin
           options = http_merge_options(options)
           print_info "HTTP COPY #{http_options_to_s(options)}"
 
-          return Net.http_copy(options,&block)
+          return super(options,&block)
         end
 
         #
@@ -328,7 +324,7 @@ module Ronin
           options = http_merge_options(options)
           print_info "HTTP DELETE #{http_options_to_s(options)}"
 
-          return Net.http_delete(options,&block)
+          return super(options,&block)
         end
 
         #
@@ -352,7 +348,7 @@ module Ronin
           options = http_merge_options(options)
           print_info "HTTP GET #{http_options_to_s(options)}"
 
-          return Net.http_get(options,&block)
+          return super(options,&block)
         end
 
         #
@@ -376,7 +372,7 @@ module Ronin
           options = http_merge_options(options)
           print_info "HTTP GET #{http_options_to_s(options)}"
 
-          return Net.http_get_body(options,&block)
+          return super(options,&block)
         end
 
         #
@@ -400,7 +396,7 @@ module Ronin
           options = http_merge_options(options)
           print_info "HTTP HEAD #{http_options_to_s(options)}"
 
-          return Net.http_head(options,&block)
+          return super(options,&block)
         end
 
         #
@@ -424,7 +420,7 @@ module Ronin
           options = http_merge_options(options)
           print_info "HTTP LOCK #{http_options_to_s(options)}"
 
-          return Net.http_lock(options,&block)
+          return super(options,&block)
         end
 
         #
@@ -448,7 +444,7 @@ module Ronin
           options = http_merge_options(options)
           print_info "HTTP MKCOL #{http_options_to_s(options)}"
 
-          return Net.http_mkcol(options,&block)
+          return super(options,&block)
         end
 
         #
@@ -472,7 +468,7 @@ module Ronin
           options = http_merge_options(options)
           print_info "HTTP MOVE #{http_options_to_s(options)}"
 
-          return Net.http_move(options,&block)
+          return super(options,&block)
         end
 
         #
@@ -496,7 +492,7 @@ module Ronin
           options = http_merge_options(options)
           print_info "HTTP OPTIONS #{http_options_to_s(options)}"
 
-          return Net.http_options(options,&block)
+          return super(options,&block)
         end
 
         #
@@ -526,7 +522,7 @@ module Ronin
           options = http_merge_options(options)
           print_info "HTTP POST #{http_options_to_s(options)}"
 
-          return Net.http_post(options,&block)
+          return super(options,&block)
         end
 
         #
@@ -550,7 +546,7 @@ module Ronin
           options = http_merge_options(options)
           print_info "HTTP POST #{http_options_to_s(options)}"
 
-          return Net.http_post_body(options,&block)
+          return super(options,&block)
         end
 
         #
@@ -574,7 +570,7 @@ module Ronin
           options = http_merge_options(options)
           print_info "HTTP PROPFIND #{http_options_to_s(options)}"
 
-          return Net.http_prop_find(options,&block)
+          return super(options,&block)
         end
 
         #
@@ -598,7 +594,7 @@ module Ronin
           options = http_merge_options(options)
           print_info "HTTP PROPPATCH #{http_options_to_s(options)}"
 
-          return Net.http_prop_patch(options,&block)
+          return super(options,&block)
         end
 
         #
@@ -622,7 +618,7 @@ module Ronin
           options = http_merge_options(options)
           print_info "HTTP TRACE #{http_options_to_s(options)}"
 
-          return Net.http_trace(options,&block)
+          return super(options,&block)
         end
 
         #
@@ -646,7 +642,7 @@ module Ronin
           options = http_merge_options(options)
           print_info "HTTP UNLOCK #{http_options_to_s(options)}"
 
-          return Net.http_unlock(options,&block)
+          return super(options,&block)
         end
 
         private