ronin-web 0.2.1 → 0.3.0.pre1

data/lib/ronin/web/middleware/proxy_request.rb

@@ -0,0 +1,262 @@
+#
+# Ronin Web - A Ruby library for Ronin that provides support for web
+# scraping and spidering functionality.
+#
+# Copyright (c) 2006-2011 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of Ronin Web.
+#
+# Ronin 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 3 of the License, or
+# (at your option) any later version.
+#
+# Ronin 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.
+#
+# 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/web/middleware/request'
+
+module Ronin
+  module Web
+    module Middleware
+      class ProxyRequest < Request
+
+        #
+        # Changes the HTTP Host header of the request.
+        #
+        # @param [String] new_host
+        #   The new value of the HTTP Host header.
+        #
+        # @return [String]
+        #   The new HTTP Host header.
+        #
+        # @since 0.3.0
+        #
+        # @api public
+        #
+        def host=(new_host)
+          @env['HTTP_HOST'] = new_host
+        end
+
+        #
+        # Changes the port the request is being sent to.
+        #
+        # @param [Integer] new_port
+        #   The new port the request will be sent to.
+        #
+        # @return [Integer]
+        #   The new port the request will be sent to.
+        #
+        # @since 0.3.0
+        #   
+        # @api public
+        #
+        def port=(new_port)
+          @env['SERVER_PORT'] = new_port
+        end
+
+        #
+        # Changes the URI scheme of the request.
+        #
+        # @param [String] new_port
+        #   The new URI scheme for the request.
+        #
+        # @return [String]
+        #   The new URI scheme of the request.
+        #
+        # @since 0.3.0
+        #   
+        # @api public
+        #
+        def scheme=(new_scheme)
+          @env['rack.url_scheme'] = new_scheme
+        end
+
+        #
+        # Causes the request to be proxied over SSL.
+        #
+        # @return [ProxyRequest]
+        #   The proxy request.
+        #
+        # @since 0.3.0
+        #
+        # @api public
+        #
+        def ssl!
+          self.port = 443
+          self.scheme = 'https'
+
+          return self
+        end
+
+        #
+        # Changes the HTTP Request Method of the request.
+        #
+        # @param [String] new_method
+        #   The new HTTP Request Method.
+        #
+        # @return [String]
+        #   The new HTTP Request Method.
+        #
+        # @since 0.3.0
+        #
+        # @api public
+        #
+        def request_method=(new_method)
+          @env['REQUEST_METHOD'] = new_method
+        end
+
+        alias path= path_info=
+
+        #
+        # Changes the HTTP Query String of the request.
+        #
+        # @param [String] new_query
+        #   The new HTTP Query String for the request.
+        #
+        # @return [String]
+        #   The new HTTP Query String of the request.
+        #
+        # @since 0.3.0
+        #
+        # @api public
+        #
+        def query_string=(new_query)
+          @env['QUERY_STRING'] = new_query
+        end
+
+        #
+        # Determines if the request is an XML-HTTP Request.
+        #
+        # @return [Boolean]
+        #   Specifies whether the request is XML-HTTP.
+        #
+        # @since 0.3.0
+        #
+        # @api public
+        #
+        def xhr?
+          @env['HTTP_X_REQUESTED_WITH'] == 'XMLHttpRequest'
+        end
+
+        #
+        # Specifies that the request is a XML HTTP Request.
+        #
+        # @yield [request]
+        #   If a block is given, it will be passed the request
+        #   for further modification.
+        #
+        # @yieldparam [ProxyRequest] request
+        #   The proxy request.
+        #
+        # @return [ProxyRequest]
+        #   The request.
+        #
+        # @since 0.3.0
+        #
+        # @api public
+        #
+        def xhr!
+          @env['HTTP_X_REQUESTED_WITH'] = 'XMLHttpRequest'
+
+          yield self if block_given?
+          return self
+        end
+
+        #
+        # Changes the HTTP Content-Type header of the request.
+        #
+        # @param [String] new_content_type
+        #   The new HTTP Content-Type for the request.
+        #
+        # @return [String]
+        #   The new HTTP Content-Type of the request.
+        #
+        # @since 0.3.0
+        #
+        # @api public
+        #
+        def content_type=(new_content_type)
+          @env['CONTENT_TYPE'] = new_content_type
+        end
+
+        #
+        # Changes the HTTP Accept-Encoding header of the request.
+        #
+        # @param [String] new_encoding
+        #   The new HTTP Accept-Encoding for the request.
+        #
+        # @return [String]
+        #   The new HTTP Accept-Encoding of the request.
+        #
+        # @since 0.3.0
+        #
+        # @api public
+        #
+        def accept_encoding=(new_encoding)
+          @env['HTTP_ACCEPT_ENCODING'] = new_encoding
+        end
+
+        #
+        # Sets the HTTP User-Agent header of the request.
+        #
+        # @param [String] new_user_agent
+        #   The new User-Agent header to use.
+        #
+        # @return [String]
+        #   The new User-Agent header.
+        #
+        # @since 0.3.0
+        #
+        # @api public
+        #
+        def user_agent=(new_user_agent)
+          @env['HTTP_USER_AGENT'] = new_user_agent
+        end
+
+        #
+        # Changes the HTTP Referer header of the request.
+        #
+        # @param [String] new_referer
+        #   The new HTTP Referer for the request.
+        #
+        # @return [String]
+        #   The new HTTP Referer of the request.
+        #
+        # @since 0.3.0
+        #
+        # @api public
+        #
+        def referer=(new_referer)
+          @env['HTTP_REFERER'] = new_referer
+        end
+
+        alias referrer= referer=
+
+        #
+        # Changes the body of the request.
+        #
+        # @param [String] new_body
+        #   The new body for the request.
+        #
+        # @return [String]
+        #   The new body of the request.
+        #
+        # @since 0.3.0
+        #
+        # @api public
+        #
+        def body=(new_body)
+          @env['rack.input'] = new_body
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/web/middleware/request.rb

@@ -0,0 +1,58 @@
+#
+# Ronin Web - A Ruby library for Ronin that provides support for web
+# scraping and spidering functionality.
+#
+# Copyright (c) 2006-2011 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of Ronin Web.
+#
+# Ronin 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 3 of the License, or
+# (at your option) any later version.
+#
+# Ronin 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.
+#
+# 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/http'
+
+require 'rack'
+
+module Ronin
+  module Web
+    module Middleware
+      class Request < Rack::Request
+
+        #
+        # The HTTP Headers for the request.
+        #
+        # @return [Hash{String => String}]
+        #   The HTTP Headers of the request.
+        #
+        # @since 0.3.0
+        #
+        # @api public
+        #
+        def headers
+          headers = {}
+
+          self.env.each do |name,value|
+            if name =~ /^HTTP_/
+              header_name = Network::HTTP.header_name(name.sub('HTTP_',''))
+              headers[header_name] = value
+            end
+          end
+
+          return headers
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/web/middleware/response.rb

@@ -0,0 +1,33 @@
+#
+# Ronin Web - A Ruby library for Ronin that provides support for web
+# scraping and spidering functionality.
+#
+# Copyright (c) 2006-2011 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of Ronin Web.
+#
+# Ronin 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 3 of the License, or
+# (at your option) any later version.
+#
+# Ronin 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.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require 'rack'
+
+module Ronin
+  module Web
+    module Middleware
+      class Response < Rack::Response
+
+      end
+    end
+  end
+end

data/lib/ronin/web/middleware/router.rb

@@ -0,0 +1,167 @@
+#
+# Ronin Web - A Ruby library for Ronin that provides support for web
+# scraping and spidering functionality.
+#
+# Copyright (c) 2006-2011 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of Ronin Web.
+#
+# Ronin 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 3 of the License, or
+# (at your option) any later version.
+#
+# Ronin 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.
+#
+# 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/web/middleware/rule'
+require 'ronin/web/middleware/base'
+
+module Ronin
+  module Web
+    module Middleware
+      #
+      # A Rack middleware for routing requests based on predefined rules.
+      #
+      #     use Ronin::Web::Middleware::Router do |router|
+      #       # route requests by source IP address
+      #       router.draw :ip => '212.18.45.0/24', :to => BannedApp
+      #       router.draw :ip => '192.168.0.0/16' do |request|
+      #         response ['Nothing here'], 404
+      #       end
+      #
+      #       # route requests by Referer URL
+      #       router.draw :referer => 'http://www.sexy.com/', :to => TrapApp
+      #       router.draw :referer => /\.google\./ do |request|
+      #         response ['Nothing to see here.'], 404
+      #       end
+      #
+      #       # route requests by User-Agent
+      #       router.draw :user_agent => /Microsoft/, :to => IEApp
+      #
+      #       # mix route options together
+      #       router.draw :ip => '212.18.45.0/24',
+      #                   :user_agent => /Microsoft/, :to => PwnApp
+      #     end
+      #
+      class Router < Base
+
+        # The routes of the router
+        attr_reader :routes
+
+        #
+        # Creates a new Router middleware.
+        #
+        # @param [#call] app
+        #   The application that the router sits in front of.
+        #
+        # @param [Hash] options
+        #   Additional options.
+        #
+        # @yield [router]
+        #   If a block is given, it will be passed the newly created
+        #   router middleware.
+        #
+        # @yieldparam [Router] router
+        #   The new router middleware object.
+        #
+        # @since 0.3.0
+        #
+        # @api public
+        #
+        def initialize(app,options={},&block)
+          @routes = {}
+
+          super(app,options,&block)
+        end
+
+        #
+        # Defines a rule to route requests by.
+        #
+        # @param [Hash] options
+        #   Filter options.
+        #
+        # @option options [String] :campaign
+        #   The name of the campaign who's targetted hosts will be routed.
+        #
+        # @option options [String, Regexp] :vhost
+        #   The Virtual-Host to route.
+        #
+        # @option options [String, IPAddr] :ip
+        #   The IP address or IP range to route.
+        #
+        # @option options [String, Regexp] :referer
+        #   The Referer URL or pattern to route.
+        #
+        # @option options [String, Regexp] :user_agent
+        #   The User-Agent string to route.
+        #
+        # @option options [Proc] :when
+        #   Custom logic to route requests by.
+        #
+        # @option options [#call] :to
+        #   The application that will receive routed requests.
+        #
+        # @yield [request]
+        #   If a block is given, it will receive routed requests.
+        #
+        # @yieldparam [Rack::Request] request
+        #   A routed request.
+        #
+        # @return [#call]
+        #   The application that is being routed.
+        #
+        # @example Route requests going to an application.
+        #   router.draw :ip => '210.18.0.0/16', :to => BannedApp
+        #
+        # @example Accept routed requests using a block.
+        #   router.draw :ip => '210.18.0.0/16' do |request|
+        #     response ['Banned!']
+        #   end
+        #
+        # @since 0.3.0
+        #
+        # @api public
+        #
+        def draw(options={},&block)
+          app = (options.delete(:to) || block)
+
+          return @routes[Rule.new(options)] = app
+        end
+
+        #
+        # Filters requests based on the defined routes.
+        #
+        # @param [Hash, Rack::Request] env
+        #   An incoming request.
+        #
+        # @return [Array, Response]
+        #   A response.
+        #
+        # @since 0.3.0
+        #
+        # @api public
+        #
+        def call(env)
+          request = Request.new(env)
+
+          @routes.each do |rule,app|
+            if rule.match?(request)
+              print_info "Routing #{request.url}"
+              return app.call(env)
+            end
+          end
+
+          super(env)
+        end
+
+      end
+    end
+  end
+end