lib/ronin/network/mixins/http.rb in ronin-1.0.0 vs lib/ronin/network/mixins/http.rb in ronin-1.1.0.rc1

@@ -16,61 +16,72 @@
 # You should have received a copy of the GNU General Public License
 # along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 require 'ronin/network/http'
+require 'ronin/ui/output/helpers'
+require 'ronin/mixin'
 
 require 'parameters'
 
 module Ronin
   module Network
     module Mixins
       #
       # Adds HTTP convenience methods and connection parameters to a class.
       #
+      # Defines the following parameters:
+      #
+      # * `host` (`String`) - HTTP host.
+      # * `port` (`Integer`) - HTTP port. Defaults to `Net::HTTP.default_port`.
+      # * `http_vhost` (`String`) - HTTP Host header to send.
+      # * `http_user` (`String`) - HTTP user to authenticate as.
+      # * `http_password` (`String`) - HTTP password to authenticate with.
+      # * `http_proxy` - HTTP proxy information.
+      # * `http_user_agent` (`String`) - HTTP User-Agent header to send.
+      #
       module HTTP
-        include Parameters
+        include Mixin
 
-        # HTTP host
-        parameter :host,
-                  :type => String,
-                  :description => 'HTTP host'
+        mixin UI::Output::Helpers, Parameters
 
-        # HTTP port
-        parameter :port,
-                  :type => Integer,
-                  :description => 'HTTP port'
+        mixin do
+          # HTTP host
+          parameter :host, :type => String,
+                           :description => 'HTTP host'
 
-        # HTTP `Host` header to send
-        parameter :http_vhost,
-                  :type => String,
-                  :description => 'HTTP Host header to send'
+          # HTTP port
+          parameter :port, :default => Net::HTTP.default_port,
+                           :description => 'HTTP port'
 
-        # HTTP user to authenticate as
-        parameter :http_user,
-                  :type => String,
-                  :description => 'HTTP user to authenticate as'
+          # HTTP `Host` header to send
+          parameter :http_vhost, :type => String,
+                                 :description => 'HTTP Host header to send'
 
-        # HTTP password to authenticate with
-        parameter :http_password,
-                  :type => String,
-                  :description => 'HTTP password to authenticate with'
+          # HTTP user to authenticate as
+          parameter :http_user, :type => String,
+                                :description => 'HTTP user to authenticate as'
 
-        # HTTP proxy information
-        parameter :http_proxy,
-                  :description => 'HTTP proxy information'
+          # HTTP password to authenticate with
+          parameter :http_password, :type => String,
+                                    :description => 'HTTP password to authenticate with'
 
-        # HTTP `User-Agent` header to send
-        parameter :http_user_agent,
-                  :type => String,
-                  :description => 'HTTP User-Agent header to send'
+          # 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
+
         protected
 
         #
         # Resets the HTTP proxy settings.
         #
+        # @api public
+        #
         def disable_http_proxy
           @http_proxy = nil
         end
 
         #
@@ -107,12 +118,23 @@
         #   The newly created HTTP session.
         #
         # @return [Net::HTTP]
         #   The HTTP session object.
         #
-        def http_session(options={},&block)
-          Net.http_session(http_merge_options(options),&block)
+        # @api public
+        #
+        def http_session(options={})
+          options = http_merge_options(options)
+          host_port = "#{options[:host]}:#{options[:port]}"
+
+          Net.http_session(options) do |http|
+            print_info "Starting HTTP Session with #{host_port}"
+
+            yield http
+
+            print_info "Closing HTTP Session with #{host_port}"
+          end
         end
 
         #
         # Connects to the HTTP server and sends an HTTP Request.
         #
@@ -136,17 +158,134 @@
         #   The expanded version of the given options.
         #
         # @return [Net::HTTP::Response]
         #   The response of the HTTP request.
         #
-        # @see http_session
+        # @see #http_session
         #
+        # @api public
+        #
         def http_request(options={},&block)
-          Net.http_request(http_merge_options(options),&block)
+          options = http_merge_options(options)
+          print_info "HTTP #{options[:method]} #{http_options_to_s(options)}"
+
+          return Net.http_request(options,&block)
         end
 
         #
+        # Returns the Status Code of the Response.
+        #
+        # @param [Hash] options
+        #   Additional options.
+        #
+        # @option options [Symbol, String] :method (:head)
+        #   The method to use for the request.
+        #
+        # @return [Integer]
+        #   The HTTP Response Status.
+        #
+        # @see #http_request
+        #
+        # @since 1.1.0
+        #
+        # @api public
+        #
+        def http_status(options={})
+          options = http_merge_options(options)
+
+          if (result = Net.http_status(options))
+            print_debug "HTTP #{result} #{http_options_to_s(options)}"
+          end
+
+          return result
+        end
+
+        #
+        # Checks if the response has an HTTP OK status code.
+        #
+        # @param [Hash] options
+        #   Additional options.
+        #
+        # @option options [Symbol, String] :method (:head)
+        #   The method to use for the request.
+        #
+        # @return [Boolean]
+        #   Specifies wether the response had an HTTP OK status code or not.
+        #
+        # @see #http_status
+        #
+        # @since 1.1.0
+        #
+        # @api public
+        #
+        def http_ok?(options={})
+          options = http_merge_options(options)
+
+          if (result = Net.http_ok?(options))
+            print_debug "HTTP 200 OK #{http_options_to_s(options)}"
+          end
+
+          return result
+        end
+
+        #
+        # Sends a HTTP Head request and returns the HTTP Server header.
+        #
+        # @param [Hash] options
+        #   Additional options.
+        #
+        # @option options [Symbol, String] :method (:head)
+        #   The method to use for the request.
+        #
+        # @return [String]
+        #   The HTTP `Server` header.
+        #
+        # @see #http_request
+        #
+        # @since 1.1.0
+        #
+        # @api public
+        #
+        def http_server(options={})
+          options = http_merge_options(options)
+
+          if (result = Net.http_server(options))
+            print_debug "HTTP Server: #{result}"
+          end
+
+          return result
+        end
+
+        #
+        # Sends an HTTP Head request and returns the HTTP X-Powered-By header.
+        #
+        # @param [Hash] options
+        #   Additional options.
+        #
+        # @option options [Symbol, String] :method (:get)
+        #   The method to use for the request.
+        #
+        # @return [String]
+        #   The HTTP `X-Powered-By` header.
+        #
+        # @see #http_request
+        #
+        # @since 1.1.0
+        #
+        # @api public
+        #
+        def http_powered_by(options={})
+          options = http_merge_options(options)
+
+          if (result = Net.http_powered_by(options))
+            print_debug "HTTP X-Powered-By: #{result}"
+          end
+
+          return result
+        end
+
+        #
         # Performs an HTTP Copy request.
         #
         # @yield [response]
         #   If a block is given, it will be passed the response received
         #   from the request.
@@ -155,14 +294,19 @@
         #   The HTTP response object.
         #
         # @return [Net::HTTP::Response]
         #   The response of the HTTP request.
         #
-        # @see http_request
+        # @see #http_request
         #
+        # @api public
+        #
         def http_copy(options={},&block)
-          Net.http_copy(http_merge_options(options),&block)
+          options = http_merge_options(options)
+          print_info "HTTP COPY #{http_options_to_s(options)}"
+
+          return Net.http_copy(options,&block)
         end
 
         #
         # Performs an HTTP Delete request.
         #
@@ -174,14 +318,19 @@
         #   The HTTP response object.
         #
         # @return [Net::HTTP::Response]
         #   The response of the HTTP request.
         #
-        # @see http_request
+        # @see #http_request
         #
+        # @api public
+        #
         def http_delete(options={},&block)
-          Net.http_delete(http_merge_options(options),&block)
+          options = http_merge_options(options)
+          print_info "HTTP DELETE #{http_options_to_s(options)}"
+
+          return Net.http_delete(options,&block)
         end
 
         #
         # Performs an HTTP Get request.
         #
@@ -193,14 +342,19 @@
         #   The HTTP response object.
         #
         # @return [Net::HTTP::Response]
         #   The response of the HTTP request.
         #
-        # @see http_request
+        # @see #http_request
         #
+        # @api public
+        #
         def http_get(options={},&block)
-          Net.http_get(http_merge_options(options),&block)
+          options = http_merge_options(options)
+          print_info "HTTP GET #{http_options_to_s(options)}"
+
+          return Net.http_get(options,&block)
         end
 
         #
         # Performs an HTTP Get request.
         #
@@ -212,14 +366,19 @@
         #   The HTTP response object.
         #
         # @return [String]
         #   The body of the HTTP Get request.
         #
-        # @see http_get
+        # @see #http_get
         #
+        # @api public
+        #
         def http_get_body(options={},&block)
-          Net.http_get_body(http_merge_options(options),&block)
+          options = http_merge_options(options)
+          print_info "HTTP GET #{http_options_to_s(options)}"
+
+          return Net.http_get_body(options,&block)
         end
 
         #
         # Performs an HTTP Head request.
         #
@@ -231,14 +390,19 @@
         #   The HTTP response object.
         #
         # @return [Net::HTTP::Response]
         #   The response of the HTTP request.
         #
-        # @see http_request
+        # @see #http_request
         #
+        # @api public
+        #
         def http_head(options={},&block)
-          Net.http_head(http_merge_options(options),&block)
+          options = http_merge_options(options)
+          print_info "HTTP HEAD #{http_options_to_s(options)}"
+
+          return Net.http_head(options,&block)
         end
 
         #
         # Performs an HTTP Lock request.
         #
@@ -250,14 +414,19 @@
         #   The HTTP response object.
         #
         # @return [Net::HTTP::Response]
         #   The response of the HTTP request.
         #
-        # @see http_request
+        # @see #http_request
         #
+        # @api public
+        #
         def http_lock(options={},&block)
-          Net.http_lock(http_merge_options(options),&block)
+          options = http_merge_options(options)
+          print_info "HTTP LOCK #{http_options_to_s(options)}"
+
+          return Net.http_lock(options,&block)
         end
 
         #
         # Performs an HTTP Mkcol request.
         #
@@ -269,14 +438,19 @@
         #   The HTTP response object.
         #
         # @return [Net::HTTP::Response]
         #   The response of the HTTP request.
         #
-        # @see http_request
+        # @see #http_request
         #
+        # @api public
+        #
         def http_mkcol(options={},&block)
-          Net.http_mkcol(http_merge_options(options),&block)
+          options = http_merge_options(options)
+          print_info "HTTP MKCOL #{http_options_to_s(options)}"
+
+          return Net.http_mkcol(options,&block)
         end
 
         #
         # Performs an HTTP Move request.
         #
@@ -288,14 +462,19 @@
         #   The HTTP response object.
         #
         # @return [Net::HTTP::Response]
         #   The response of the HTTP request.
         #
-        # @see http_request
+        # @see #http_request
         #
+        # @api public
+        #
         def http_move(options={},&block)
-          Net.http_move(http_merge_options(options),&block)
+          options = http_merge_options(options)
+          print_info "HTTP MOVE #{http_options_to_s(options)}"
+
+          return Net.http_move(options,&block)
         end
 
         #
         # Performs an HTTP Options request.
         #
@@ -307,14 +486,19 @@
         #   The HTTP response object.
         #
         # @return [Net::HTTP::Response]
         #   The response of the HTTP request.
         #
-        # @see http_request
+        # @see #http_request
         #
+        # @api public
+        #
         def http_options(options={},&block)
-          Net.http_options(http_merge_options(options),&block)
+          options = http_merge_options(options)
+          print_info "HTTP OPTIONS #{http_options_to_s(options)}"
+
+          return Net.http_options(options,&block)
         end
 
         #
         # Performs an HTTP Post request.
         #
@@ -332,14 +516,19 @@
         #   The HTTP response object.
         #
         # @return [Net::HTTP::Response]
         #   The response of the HTTP request.
         #
-        # @see http_request
+        # @see #http_request
         #
+        # @api public
+        #
         def http_post(options={},&block)
-          Net.http_post(http_merge_options(options),&block)
+          options = http_merge_options(options)
+          print_info "HTTP POST #{http_options_to_s(options)}"
+
+          return Net.http_post(options,&block)
         end
 
         #
         # Performs an HTTP Post request.
         #
@@ -351,14 +540,19 @@
         #   The HTTP response object.
         #
         # @return [String]
         #   The body of the Post request.
         #
-        # @see http_post
+        # @see #http_post
         #
+        # @api public
+        #
         def http_post_body(options={},&block)
-          Net.http_post_body(http_merge_options(options),&block)
+          options = http_merge_options(options)
+          print_info "HTTP POST #{http_options_to_s(options)}"
+
+          return Net.http_post_body(options,&block)
         end
 
         #
         # Performs an HTTP Propfind request.
         #
@@ -370,14 +564,19 @@
         #   The HTTP response object.
         #
         # @return [Net::HTTP::Response]
         #   The response of the HTTP request.
         #
-        # @see http_request
+        # @see #http_request
         #
+        # @api public
+        #
         def http_prop_find(options={},&block)
-          Net.http_prop_find(http_merge_options(options),&block)
+          options = http_merge_options(options)
+          print_info "HTTP PROPFIND #{http_options_to_s(options)}"
+
+          return Net.http_prop_find(options,&block)
         end
 
         #
         # Performs an HTTP Proppatch request.
         #
@@ -389,14 +588,19 @@
         #   The HTTP response object.
         #
         # @return [Net::HTTP::Response]
         #   The response of the HTTP request.
         #
-        # @see http_request
+        # @see #http_request
         #
+        # @api public
+        #
         def http_prop_patch(options={},&block)
-          Net.http_prop_patch(http_merge_options(options),&block)
+          options = http_merge_options(options)
+          print_info "HTTP PROPPATCH #{http_options_to_s(options)}"
+
+          return Net.http_prop_patch(options,&block)
         end
 
         #
         # Performs an HTTP Trace request.
         #
@@ -408,14 +612,19 @@
         #   The HTTP response object.
         #
         # @return [Net::HTTP::Response]
         #   The response of the HTTP request.
         #
-        # @see http_request
+        # @see #http_request
         #
+        # @api public
+        #
         def http_trace(options={},&block)
-          Net.http_trace(http_merge_options(options),&block)
+          options = http_merge_options(options)
+          print_info "HTTP TRACE #{http_options_to_s(options)}"
+
+          return Net.http_trace(options,&block)
         end
 
         #
         # Performs an HTTP Unlock request.
         #
@@ -427,34 +636,88 @@
         #   The HTTP response object.
         #
         # @return [Net::HTTP::Response]
         #   The response of the HTTP request.
         #
-        # @see http_request
+        # @see #http_request
         #
+        # @api public
+        #
         def http_unlock(options={},&block)
-          Net.http_unlock(http_merge_options(options),&block)
+          options = http_merge_options(options)
+          print_info "HTTP UNLOCK #{http_options_to_s(options)}"
+
+          return Net.http_unlock(options,&block)
         end
 
         private
 
+        #
+        # Merges the HTTP parameters into the HTTP options.
+        #
+        # @param [Hash] options
+        #   The HTTP options to merge into.
+        #
+        # @return [Hash]
+        #   The merged HTTP options.
+        #
+        # @since 1.0.0
+        #
+        # @api private
+        #
         def http_merge_options(options={})
           options[:host] ||= self.host if self.host
           options[:port] ||= self.port if self.port
 
-          options[:headers] ||= {}
-          headers = options[:headers]
+          if (self.http_vhost || self.http_user_agent)
+            headers = options.fetch(:headers,{})
 
-          headers[:host] ||= self.http_vhost if self.http_vhost
+            headers[:host] ||= self.http_vhost if self.http_vhost
+            headers[:user_agent] ||= self.http_user_agent if self.http_user_agent
 
+            options[:headers] = headers
+          end
+
           options[:user] ||= self.http_user if self.http_user
           options[:password] ||= self.http_password if self.http_password
 
           options[:proxy] ||= self.http_proxy if self.http_proxy
-          options[:user_agent] ||= self.http_user_agent if self.http_user_agent
 
           return options
         end
+
+        #
+        # Converts the HTTP options to a printable String.
+        #
+        # @param [Hash] options
+        #   HTTP options.
+        #
+        # @return [String]
+        #   The printable String.
+        #
+        # @since 1.1.0
+        #
+        # @api private
+        #
+        def http_options_to_s(options)
+          fields = ["#{options[:host]}:#{options[:port]}"]
+
+          if (options[:user] || options[:password])
+            fields << "#{options[:user]}:#{options[:password]}"
+          end
+
+          path = options[:path]
+          path += "?#{options[:query]}" if options[:query]
+
+          fields << path
+
+          if options[:headers]
+            fields << ("%p" % options[:headers])
+          end
+
+          return fields.join(' ')
+        end
+
       end
     end
   end
 end