ronin-web 0.3.0.rc1 → 1.0.0.beta1

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

@@ -1,79 +0,0 @@
-#
-# 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
-
-        #
-        # Returns the remote IP address and port for the request.
-        #
-        # @param [Hash] env
-        #   The request env Hash.
-        #
-        # @return [String]
-        #   The IP address and port number.
-        #
-        # @since 0.3.0
-        #
-        # @api semipublic
-        #
-        def address
-          if env.has_key?('REMOTE_PORT')
-            "#{ip}:#{env['REMOTE_PORT']}"
-          else
-            ip
-          end
-        end
-
-        #
-        # 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 = {}
-
-          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

@@ -1,33 +0,0 @@
-#
-# 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

@@ -1,167 +0,0 @@
-#
-# 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} for #{request.address}"
-              return app.call(env)
-            end
-          end
-
-          super(env)
-        end
-
-      end
-    end
-  end
-end

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

@@ -1,103 +0,0 @@
-#
-# 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/filters'
-
-module Ronin
-  module Web
-    module Middleware
-      #
-      # Matches requests against one or more filters.
-      #
-      class Rule
-
-        # Registered filters
-        FILTERS = {
-          :ip => Filters::IPFilter,
-          :campaign => Filters::CampaignFilter,
-          :path => Filters::PathFilter,
-          :vhost => Filters::VHostFilter,
-          :referer => Filters::RefererFilter,
-          :user_agent => Filters::UserAgentFilter
-        }
-
-        #
-        # Creates a new rule.
-        #
-        # @param [Hash] options
-        #   Additional filtering options for the rule.
-        #
-        # @option options [String] :campaign
-        #   The name of the campaign who's targetted hosts will be
-        #   filtered by.
-        #
-        # @option options [String, Regexp] :vhost
-        #   The Virtual-Host to filter.
-        #
-        # @option options [String, IPAddr] :ip
-        #   The IP address or IP range to filter.
-        #
-        # @option options [String, Regexp] :referer
-        #   The Referer URL or pattern to filter.
-        #
-        # @option options [String, Regexp] :user_agent
-        #   The User-Agent string to filter.
-        #
-        # @option options [Proc] :when
-        #   Custom logic to filter requests by.
-        #
-        # @since 0.3.0
-        #
-        # @api public
-        #
-        def initialize(options={},&block)
-          @filters = []
-          @when_block = options.delete(:when)
-
-          options.each do |name,value|
-            if FILTERS.has_key?(name)
-              @filters << FILTERS[name].new(value)
-            end
-          end
-        end
-
-        #
-        # Matches a request against the rule.
-        #
-        # @param [Rack::Request] request
-        #   The request to match.
-        #
-        # @return [Boolean]
-        #   Specifies if the request matches all of the filters.
-        #
-        # @api public
-        #
-        def match?(request)
-          @filters.all? { |filter| 
-            filter.match?(request)
-          } && (@when_block.nil? || (@when_block.call(request) ? true : false))
-        end
-
-      end
-    end
-  end
-end

data/lib/ronin/web/middleware.rb

@@ -1,27 +0,0 @@
-#
-# 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/base'
-require 'ronin/web/middleware/files'
-require 'ronin/web/middleware/directories'
-require 'ronin/web/middleware/router'
-require 'ronin/web/middleware/proxy'

data/lib/ronin/web/proxy/app.rb

@@ -1,32 +0,0 @@
-#
-# 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/proxy/base'
-
-module Ronin
-  module Web
-    module Proxy
-      class App < Base
-      end
-    end
-  end
-end

data/lib/ronin/web/proxy/base.rb

@@ -1,46 +0,0 @@
-#
-# 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/server/base'
-require 'ronin/web/middleware/proxy'
-
-module Ronin
-  module Web
-    module Proxy
-      #
-      # The base-class for all Ronin Web Proxies. Extends
-      # [Sinatra::Base](http://rubydoc.info/gems/sinatra/Sinatra/Base)
-      # with {Middleware::Proxy}.
-      #
-      class Base < Server::Base
-
-        # The default port to run the Web Proxy on
-        DEFAULT_PORT = 8080
-
-        set :port, DEFAULT_PORT
-
-        use Middleware::Proxy
-
-      end
-    end
-  end
-end

data/lib/ronin/web/proxy/web.rb

@@ -1,46 +0,0 @@
-#
-# 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/proxy/app'
-
-module Ronin
-  module Web
-    #
-    # Returns the Ronin Web Proxy. When called for the first time
-    # the proxy will be started in the background.
-    #
-    # @see Server::Base.run!
-    #
-    # @api public
-    #
-    def Web.proxy_server(options={},&block)
-      unless class_variable_defined?('@@ronin_web_proxy')
-        @@ronin_web_proxy = Proxy::App
-        @@ronin_web_proxy.run!(options.merge(:background => true))
-      end
-
-      @@ronin_web_proxy.class_eval(&block)
-
-      return @@ronin_web_proxy
-    end
-  end
-end

data/lib/ronin/web/proxy.rb

@@ -1,25 +0,0 @@
-#
-# 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/proxy/base'
-require 'ronin/web/proxy/app'
-require 'ronin/web/proxy/web'

data/lib/ronin/web/server/app.rb

@@ -1,32 +0,0 @@
-#
-# 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/server/base'
-
-module Ronin
-  module Web
-    module Server
-      class App < Base
-      end
-    end
-  end
-end