ronin 0.3.0 → 1.0.0.pre1

data/lib/ronin/network/{helpers → mixins}/http.rb

@@ -1,39 +1,76 @@
 #
 # Ronin - A Ruby platform for exploit development and security research.
 #
-# Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2010 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
+# This library 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 2.1 of the License, or (at your option) any later version.
 #
-# This program is distributed in the hope that it will be useful,
+# This library 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 General Public License for more details.
+# 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 General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor,
+# Boston, MA  02110-1301  USA
 #
 
-require 'ronin/network/helpers/helper'
 require 'ronin/network/http'
 
+require 'parameters'
+
 module Ronin
   module Network
-    module Helpers
+    module Mixins
+      #
+      # Adds HTTP convenience methods and connection parameters to a class.
+      #
       module HTTP
-        include Helper
+        include Parameters
+
+        # HTTP host
+        parameter :host,
+                  :type => String,
+                  :description => 'HTTP host'
+
+        # HTTP port
+        parameter :port,
+                  :type => Integer,
+                  :description => 'HTTP port'
+
+        # 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 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 `User-Agent` header to send
+        parameter :http_user_agent,
+                  :type => String,
+                  :description => 'HTTP User-Agent header to send'
 
         protected
 
         #
         # Resets the HTTP proxy settings.
         #
-        # @since 0.3.0
-        #
         def disable_http_proxy
           @http_proxy = nil
         end
@@ -74,15 +111,12 @@ module Ronin
         # @return [Net::HTTP]
         #   The HTTP session object.
         #
-        # @since 0.3.0
-        #
         def http_session(options={},&block)
           Net.http_session(http_merge_options(options),&block)
         end
 
         #
-        # Connects to the HTTP server and sends an HTTP Request using the
-        # given _options_.
+        # Connects to the HTTP server and sends an HTTP Request.
         #
         # @param [Hash] options
         #   Additional options.
@@ -95,26 +129,25 @@ module Ronin
         # @yield [request, (options)]
         #   If a block is given, it will be passed the HTTP request object.
         #   If the block has an arity of 2, it will also be passed the
-        #   expanded version of the given _options_.
+        #   expanded version of the given options.
         #
         # @yieldparam [Net::HTTP::Request] request
         #   The HTTP request object to use in the request.
         #
         # @yieldparam [Hash] options
-        #   The expanded version of the given _options_.
+        #   The expanded version of the given options.
         #
         # @return [Net::HTTP::Response]
         #   The response of the HTTP request.
         #
         # @see http_session
-        # @since 0.3.0
         #
         def http_request(options={},&block)
           Net.http_request(http_merge_options(options),&block)
         end
 
         #
-        # Performes an HTTP Copy request with the given _options_.
+        # Performs an HTTP Copy request.
         #
         # @yield [response]
         #   If a block is given, it will be passed the response received
@@ -127,14 +160,13 @@ module Ronin
         #   The response of the HTTP request.
         #
         # @see http_request
-        # @since 0.3.0
         #
         def http_copy(options={},&block)
           Net.http_copy(http_merge_options(options),&block)
         end
 
         #
-        # Performes an HTTP Delete request with the given _options_.
+        # Performs an HTTP Delete request.
         #
         # @yield [response]
         #   If a block is given, it will be passed the response received
@@ -147,14 +179,13 @@ module Ronin
         #   The response of the HTTP request.
         #
         # @see http_request
-        # @since 0.3.0
         #
         def http_delete(options={},&block)
           Net.http_delete(http_merge_options(options),&block)
         end
 
         #
-        # Performes an HTTP Get request with the given _options_.
+        # Performs an HTTP Get request.
         #
         # @yield [response]
         #   If a block is given, it will be passed the response received
@@ -167,14 +198,13 @@ module Ronin
         #   The response of the HTTP request.
         #
         # @see http_request
-        # @since 0.3.0
         #
         def http_get(options={},&block)
           Net.http_get(http_merge_options(options),&block)
         end
 
         #
-        # Performes an HTTP Get request with the given _options_.
+        # Performs an HTTP Get request.
         #
         # @yield [response]
         #   If a block is given, it will be passed the response received
@@ -187,14 +217,13 @@ module Ronin
         #   The body of the HTTP Get request.
         #
         # @see http_get
-        # @since 0.3.0
         #
         def http_get_body(options={},&block)
           Net.http_get_body(http_merge_options(options),&block)
         end
 
         #
-        # Performes an HTTP Head request with the given _options_.
+        # Performs an HTTP Head request.
         #
         # @yield [response]
         #   If a block is given, it will be passed the response received
@@ -207,14 +236,13 @@ module Ronin
         #   The response of the HTTP request.
         #
         # @see http_request
-        # @since 0.3.0
         #
         def http_head(options={},&block)
           Net.http_head(http_merge_options(options),&block)
         end
 
         #
-        # Performes an HTTP Lock request with the given _options_.
+        # Performs an HTTP Lock request.
         #
         # @yield [response]
         #   If a block is given, it will be passed the response received
@@ -227,14 +255,13 @@ module Ronin
         #   The response of the HTTP request.
         #
         # @see http_request
-        # @since 0.3.0
         #
         def http_lock(options={},&block)
           Net.http_lock(http_merge_options(options),&block)
         end
 
         #
-        # Performes an HTTP Mkcol request with the given _options_.
+        # Performs an HTTP Mkcol request.
         #
         # @yield [response]
         #   If a block is given, it will be passed the response received
@@ -247,14 +274,13 @@ module Ronin
         #   The response of the HTTP request.
         #
         # @see http_request
-        # @since 0.3.0
         #
         def http_mkcol(options={},&block)
           Net.http_mkcol(http_merge_options(options),&block)
         end
 
         #
-        # Performes an HTTP Move request with the given _options_.
+        # Performs an HTTP Move request.
         #
         # @yield [response]
         #   If a block is given, it will be passed the response received
@@ -267,14 +293,13 @@ module Ronin
         #   The response of the HTTP request.
         #
         # @see http_request
-        # @since 0.3.0
         #
         def http_move(options={},&block)
           Net.http_move(http_merge_options(options),&block)
         end
 
         #
-        # Performes an HTTP Options request with the given _options_.
+        # Performs an HTTP Options request.
         #
         # @yield [response]
         #   If a block is given, it will be passed the response received
@@ -287,20 +312,19 @@ module Ronin
         #   The response of the HTTP request.
         #
         # @see http_request
-        # @since 0.3.0
         #
         def http_options(options={},&block)
           Net.http_options(http_merge_options(options),&block)
         end
 
         #
-        # Performes an HTTP Post request with the given _options_.
+        # Performs an HTTP Post request.
         #
         # @param [Hash] options
         #   Additional options.
         #
         # @option options [String] :post_data
-        #   The +POSTDATA+ to send with the HTTP Post request.
+        #   The `POSTDATA` to send with the HTTP Post request.
         #
         # @yield [response]
         #   If a block is given, it will be passed the response received
@@ -313,14 +337,13 @@ module Ronin
         #   The response of the HTTP request.
         #
         # @see http_request
-        # @since 0.3.0
         #
         def http_post(options={},&block)
           Net.http_post(http_merge_options(options),&block)
         end
 
         #
-        # Performes an HTTP Post request with the given _options_.
+        # Performs an HTTP Post request.
         #
         # @yield [response]
         #   If a block is given, it will be passed the response received
@@ -333,14 +356,13 @@ module Ronin
         #   The body of the Post request.
         #
         # @see http_post
-        # @since 0.3.0
         #
         def http_post_body(options={},&block)
           Net.http_post_body(http_merge_options(options),&block)
         end
 
         #
-        # Performes an HTTP Propfind request with the given _options_.
+        # Performs an HTTP Propfind request.
         #
         # @yield [response]
         #   If a block is given, it will be passed the response received
@@ -353,14 +375,13 @@ module Ronin
         #   The response of the HTTP request.
         #
         # @see http_request
-        # @since 0.3.0
         #
         def http_prop_find(options={},&block)
           Net.http_prop_find(http_merge_options(options),&block)
         end
 
         #
-        # Performes an HTTP Proppatch request with the given _options_.
+        # Performs an HTTP Proppatch request.
         #
         # @yield [response]
         #   If a block is given, it will be passed the response received
@@ -373,14 +394,13 @@ module Ronin
         #   The response of the HTTP request.
         #
         # @see http_request
-        # @since 0.3.0
         #
         def http_prop_patch(options={},&block)
           Net.http_prop_patch(http_merge_options(options),&block)
         end
 
         #
-        # Performes an HTTP Trace request with the given _options_.
+        # Performs an HTTP Trace request.
         #
         # @yield [response]
         #   If a block is given, it will be passed the response received
@@ -393,14 +413,13 @@ module Ronin
         #   The response of the HTTP request.
         #
         # @see http_request
-        # @since 0.3.0
         #
         def http_trace(options={},&block)
           Net.http_trace(http_merge_options(options),&block)
         end
 
         #
-        # Performes an HTTP Unlock request with the given _options_.
+        # Performs an HTTP Unlock request.
         #
         # @yield [response]
         #   If a block is given, it will be passed the response received
@@ -413,7 +432,6 @@ module Ronin
         #   The response of the HTTP request.
         #
         # @see http_request
-        # @since 0.3.0
         #
         def http_unlock(options={},&block)
           Net.http_unlock(http_merge_options(options),&block)
@@ -422,19 +440,19 @@ module Ronin
         private
 
         def http_merge_options(options={})
-          options[:host] ||= @host if @host
-          options[:port] ||= @port if @port
+          options[:host] ||= self.host if self.host
+          options[:port] ||= self.port if self.port
 
           options[:headers] ||= {}
           headers = options[:headers]
 
-          headers[:host] ||= @http_vhost if @http_vhost
+          headers[:host] ||= self.http_vhost if self.http_vhost
 
-          options[:user] ||= @http_user if @http_user
-          options[:password] ||= @http_password if @http_password
+          options[:user] ||= self.http_user if self.http_user
+          options[:password] ||= self.http_password if self.http_password
 
-          options[:proxy] ||= @http_proxy if @http_proxy
-          options[:user_agent] ||= @http_user_agent if @http_user_agent
+          options[:proxy] ||= self.http_proxy if self.http_proxy
+          options[:user_agent] ||= self.http_user_agent if self.http_user_agent
 
           return options
         end

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

@@ -0,0 +1,140 @@
+#
+# Ronin - A Ruby platform for exploit development and security research.
+#
+# Copyright (c) 2006-2010 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This library 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 2.1 of the License, or (at your option) any later version.
+#
+# This library 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 this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor,
+# Boston, MA  02110-1301  USA
+#
+
+require 'ronin/network/imap'
+
+require 'parameters'
+
+module Ronin
+  module Network
+    module Mixins
+      #
+      # Adds IMAP convenience methods and connection parameters to a class.
+      #
+      module IMAP
+        include Parameters
+
+        # IMAP host
+        parameter :host,
+                  :type => String,
+                  :description => 'IMAP host'
+
+        # IMAP port
+        parameter :port,
+                  :type => Integer,
+                  :description => 'IMAP port'
+
+        # 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 password to login with
+        parameter :imap_password,
+                  :type => String,
+                  :description => 'IMAP password to login with'
+
+        protected
+
+        #
+        # 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
+        #   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.
+        #
+        # @option options [Boolean]
+        #   Indicates wether or not to use SSL when connecting to the
+        #   server.
+        #
+        def imap_connect(options={},&block)
+          options[:port] ||= self.port
+          options[:auth] ||= self.imap_auth
+          options[:user] ||= self.imap_user
+          options[:password] ||= self.imap_password
+
+          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)
+        end
+
+        #
+        # 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]
+        #   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.
+        #
+        # @see imap_connect
+        #
+        def imap_session(options={})
+          imap_connect(options) do |sess|
+            yield sess if block_given?
+
+            print_info "Logging out ..."
+
+            sess.close
+            sess.logout
+
+            if self.port
+              print_info "Disconnecting from #{self.host}:#{self.port}"
+            else
+              print_info "Disconnecting from #{self.host}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,130 @@
+#
+# Ronin - A Ruby platform for exploit development and security research.
+#
+# Copyright (c) 2006-2010 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This library 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 2.1 of the License, or (at your option) any later version.
+#
+# This library 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 this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor,
+# Boston, MA  02110-1301  USA
+#
+
+require 'ronin/network/pop3'
+
+require 'parameters'
+
+module Ronin
+  module Network
+    module Mixins
+      #
+      # Adds POP3 convenience methods and connection parameters to a class.
+      #
+      module POP3
+        include Parameters
+
+        # POP3 host
+        parameter :host,
+                  :type => String,
+                  :description => 'POP3 host'
+
+        # POP3 port
+        parameter :port,
+                  :type => Integer,
+                  :description => 'POP3 port'
+
+        # 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'
+
+        protected
+
+        #
+        # 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
+        #   Additional options.
+        #
+        # @option options [Integer] :port (Ronin::Network::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.
+        #
+        def pop3_connect(options={},&block)
+          options[:port] ||= self.port
+          options[:user] ||= self.pop3_user
+          options[:password] ||= self.pop3_password
+
+          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)
+        end
+
+        #
+        # 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]
+        #   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.
+        #
+        # @see pop3_connect
+        #
+        def pop3_session(options={})
+          pop3_connect(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
+          end
+        end
+      end
+    end
+  end
+end