ronin-web 0.3.0.pre2 → 1.0.0.beta1

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

@@ -1,144 +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/helpers'
-require 'ronin/ui/output/helpers'
-
-module Ronin
-  module Web
-    module Middleware
-      #
-      # Baase-class for all Ronin Web Middleware.
-      #
-      class Base
-
-        include Helpers
-        include UI::Output::Helpers
-
-        # The default status code to return
-        DEFAULT_STATUS = 200
-
-        # The status code to return
-        attr_accessor :default_status
-
-        # The default headers to return
-        attr_reader :default_headers
-
-        #
-        # Creates a new middleware object.
-        #
-        # @param [#call] app
-        #   The application the middleware will sit in front of.
-        #
-        # @param [Hash] options
-        #   Additional options.
-        #
-        # @option options [Integer] :default_status (DEFAULT_STATUS)
-        #   The status code to return.
-        #
-        # @option options [Hash] :default_headers
-        #   The headers to return.
-        #
-        # @yield [middleware]
-        #   If a block is given, it will be passed the new middleware.
-        #
-        # @yieldparam [Base] middleware
-        #   The new middleware object.
-        #
-        # @since 0.3.0
-        #
-        # @api semipublic
-        #
-        def initialize(app,options={})
-          @app = app
-
-          @default_status = (options[:default_status] || DEFAULT_STATUS)
-          @default_headers = {}
-
-          if options.has_key?(:default_headers)
-            @default_headers.merge!(options[:default_headers])
-          end
-
-          yield self if block_given?
-        end
-
-        #
-        # Passes the request to the application.
-        #
-        # @param [Hash, Rack::Request] env
-        #   The request.
-        #
-        # @return [Rack::Response]
-        #   The response.
-        #
-        # @since 0.3.0
-        #
-        # @api semipublic
-        #
-        def call(env)
-          @app.call(env)
-        end
-
-        protected
-
-        #
-        # Creates a new response.
-        #
-        # @param [String, Array, IO] body
-        #   The body for the response.
-        #
-        # @param [Hash] headers
-        #   Additional headers for the response.
-        #
-        # @param [Integer] status
-        #   The HTTP Status Code for the response.
-        #
-        # @yield [response]
-        #   If a block is given, it will be passed the new response.
-        #
-        # @yieldparam [Response] response
-        #   The new response.
-        #
-        # @return [Array]
-        #   The new response.
-        #
-        # @example Create a response.
-        #   response ['Hello'], {'Content-Type' => 'text/txt'}, 200
-        #
-        # @example Create a response with just a String.
-        #   response 'Hello'
-        #
-        # @since 0.3.0
-        #
-        # @api semipublic
-        #
-        def response(body=[],headers={},status=nil)
-          status ||= @default_status
-          headers = @default_headers.merge(headers)
-
-          return super(body,headers,status)
-        end
-
-      end
-    end
-  end
-end

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

@@ -1,179 +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 'set'
-
-module Ronin
-  module Web
-    module Middleware
-      #
-      # A Rack middleware to host local directories at specific remote
-      # paths.
-      #
-      #     use Ronin::Web::Middleware::Directories do |dirs|
-      #       dirs.map '/downloads', '/tmp/ronin_downloads'
-      #     end
-      #
-      class Directories < Base
-
-        # The predefined index file names
-        INDEX_NAMES = %w[index.html index.xhtml index.htm]
-
-        # The mapping of remote paths to local directories 
-        attr_reader :paths
-
-        #
-        # Creates a new {Directories} middleware.
-        #
-        # @param [#call] app
-        #   The application the middleware sits in front of.
-        #
-        # @param [Hash] options
-        #   Additional options.
-        #
-        # @option options [Hash{String => String}] :paths
-        #   The mapping of remote paths to local directories.
-        #
-        # @yield [directories]
-        #   If a block is given, it will be passed the new directories
-        #   middleware.
-        #
-        # @yieldparam [Directories] directories
-        #   The new directories middleware object.
-        #
-        # @since 0.3.0
-        #
-        # @api public
-        #
-        def initialize(app,options={},&block)
-          @paths = {}
-          @paths_order = []
-
-          if options.has_key?(:paths)
-            options[:paths].each do |remote_path,local_dir|
-              map(remote_path,local_dir)
-            end
-          end
-
-          super(app,&block)
-        end
-
-        #
-        # The names of index files.
-        #
-        # @return [Set]
-        #   The set of index file names.
-        #
-        # @since 0.3.0
-        #
-        # @api public
-        #
-        def Directories.index_names
-          @@directories_index_names ||= Set.new(INDEX_NAMES)
-        end
-
-        #
-        # Maps a remote path to a local directory.
-        #
-        # @param [String] remote_path
-        #   The remote path to map.
-        #
-        # @param [String] local_dir
-        #   The local directory that the remote path will map to.
-        #
-        # @return [true]
-        #
-        # @since 0.3.0
-        #
-        # @api public
-        #
-        def map(remote_path,local_dir)
-          @paths[remote_path] = local_dir
-          
-          # sort paths by number of sub-directories
-          @paths_order = @paths.keys.sort_by do |path|
-            -(path.split('/').length)
-          end
-
-          return true
-        end
-
-        #
-        # Returns a file from a local directory, if the directory
-        # was mapped to a remote path.
-        #
-        # @param [Hash, Rack::Request] env
-        #   The request.
-        #
-        # @return [Array, Response]
-        #   The response.
-        #
-        # @since 0.3.0
-        #
-        # @api public
-        #
-        def call(env)
-          path = sanitize_path(env['PATH_INFO'])
-
-          # finds the remote directory that the paths starts with or is
-          # equal to.
-          remote_path = @paths_order.find do |remote_path|
-                          if remote_path == '/'
-                            true
-                          elsif path[0,remote_path.length] == remote_path
-                            (path[remote_path.length] == '/') ||
-                            (path.length == remote_path.length)
-                          end
-                        end
-
-          if remote_path
-            local_dir = @paths[remote_path]
-            sub_path = path[remote_path.length..-1]
-
-            return_file = proc { |local_path|
-              if File.file?(local_path)
-                request = Request.new(env)
-
-                print_info "Returning file #{local_path.dump} for #{request.address}"
-                return response_for(local_path)
-              end
-            }
-
-            if sub_path.empty?
-              # attempt to find an index file in the directory
-              Directories.index_names.each do |index|
-                return_file.call(File.join(local_dir,index))
-              end
-            else
-              return_file.call(File.join(local_dir,sub_path))
-            end
-          end
-
-          super(env)
-        end
-
-      end
-    end
-  end
-end

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

@@ -1,144 +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'
-
-module Ronin
-  module Web
-    module Middleware
-      #
-      # A Rack middleware to host local files at specific remote paths.
-      #
-      #     use Ronin::Web::Middleware::Files do |files|
-      #       files.map '/foo.txt', 'foo.txt'
-      #       files.map /\.exe$/, 'trojan.exe'
-      #     end
-      #
-      class Files < Base
-
-        # The mapping of remote paths to local paths
-        attr_reader :paths
-
-        #
-        # Creates a new {Files} middleware.
-        #
-        # @param [#call] app
-        #   The application the middleware sits in front of.
-        #
-        # @param [Hash] options
-        #   Additional options.
-        #
-        # @option options [Integer] :status (200)
-        #   The status code to return.
-        #
-        # @option options [Hash] :headers
-        #   The headers to return.
-        #
-        # @option options [Hash] :paths
-        #   The mapping of remote paths to local paths.
-        #
-        # @yield [files]
-        #   If a block is given, it will be passed the new files middleware.
-        #
-        # @yieldparam [Files] files
-        #   The new files middleware object.
-        #
-        # @since 0.3.0
-        #
-        # @api public
-        #
-        def initialize(app,options={},&block)
-          @paths = {}
-
-          if options.has_key?(:paths)
-            options[:paths].each do |remote_path,local_path|
-              map(remote_path,local_path)
-            end
-          end
-
-          super(app,&block)
-        end
-
-        #
-        # Maps the local path to a remote path.
-        #
-        # @param [Regexp, String] remote_path
-        #   The remote path to expose.
-        #
-        # @param [String] local_path
-        #   The local path to host.
-        #
-        # @return [true]
-        #
-        # @example Mapping a path
-        #   map '/foo.txt', 'foo.txt'
-        #
-        # @example Mapping multiple paths using a regular expression
-        #   map /\.exe$/, 'trojan.exe'
-        #
-        # @since 0.3.0
-        #
-        # @api public
-        #
-        def map(remote_path,local_path)
-          @paths[remote_path] = local_path
-          return true
-        end
-
-        #
-        # Returns a local file if it was mapped to a remote path.
-        #
-        # @param [Hash, Rack::Request] env
-        #   The request.
-        #
-        # @return [Array, Response]
-        #   The response.
-        #
-        # @since 0.3.0
-        #
-        # @api public
-        #
-        def call(env)
-          path = sanitize_path(env['PATH_INFO'])
-
-          @paths.each do |pattern,local_path|
-            matched = if pattern.kind_of?(Regexp)
-                        path =~ pattern
-                      else
-                        path == pattern
-                      end
-
-            if matched
-              request = Request.new(env)
-
-              print_info "Returning file #{local_path.dump} for #{request.address}"
-              return response_for(local_path)
-            end
-          end
-
-          super(env)
-        end
-
-      end
-    end
-  end
-end

data/lib/ronin/web/middleware/filters/campaign_filter.rb

@@ -1,77 +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/campaign'
-require 'ronin/ip_address'
-
-module Ronin
-  module Web
-    module Middleware
-      module Filters
-        #
-        # A Filter used to match requests coming from IP Addresses that are
-        # targeted by a specified Campaign.
-        #
-        class CampaignFilter
-
-          #
-          # Creates a new campaign filter.
-          #
-          # @param [String] name
-          #   The name of the campaign to match against.
-          #
-          # @raise [RuntimeError]
-          #   No campaign with the given name.
-          #
-          # @since 0.3.0
-          #
-          # @api private
-          #
-          def initialize(name)
-            @name = name.to_s
-          end
-
-          #
-          # Matches the filter against the request.
-          #
-          # @param [Rack::Request] request
-          #   The incoming request.
-          #
-          # @return [Boolean]
-          #   Specifies whether the filter matched the request.
-          #
-          # @since 0.3.0
-          #
-          # @api private
-          #
-          def match?(request)
-            Campaign.count(
-              :name => @name,
-              Campaign.addresses.address => request.ip
-            ) == 1
-          end
-
-        end
-      end
-    end
-  end
-end

data/lib/ronin/web/middleware/filters/ip_filter.rb

@@ -1,73 +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 'ipaddr'
-
-module Ronin
-  module Web
-    module Middleware
-      module Filters
-        #
-        # A Filter to match requests based on their IP Address.
-        #
-        class IPFilter
-
-          #
-          # Creates a new IP filter.
-          #
-          # @param [String, IPAddr] ip
-          #   The IP Address to match against.
-          #
-          # @since 0.3.0
-          #
-          # @api private
-          #
-          def initialize(ip)
-            @ip = unless ip.kind_of?(IPAddr)
-                    IPAddr.new(ip.to_s)
-                  else
-                    ip
-                  end
-          end
-
-          #
-          # Matches the filter against the request.
-          #
-          # @param [Rack::Request] request
-          #   The incoming request.
-          #
-          # @return [Boolean]
-          #   Specifies whether the filter matched the request.
-          #
-          # @since 0.3.0
-          #
-          # @api private
-          #
-          def match?(request)
-            @ip.include?(request.ip)
-          end
-
-        end
-      end
-    end
-  end
-end

data/lib/ronin/web/middleware/filters/path_filter.rb

@@ -1,73 +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/>.
-#
-
-module Ronin
-  module Web
-    module Middleware
-      module Filters
-        #
-        # A Filter to match requests by their path.
-        #
-        class PathFilter
-
-          #
-          # Creates a new path filter.
-          #
-          # @param [String, Regexp] path
-          #   The path pattern to match against.
-          #
-          # @since 0.3.0
-          #
-          # @api private
-          #
-          def initialize(path)
-            @path = path
-          end
-
-          #
-          # Matches the filter against the request.
-          #
-          # @param [Rack::Request] request
-          #   The incoming request.
-          #
-          # @return [Boolean]
-          #   Specifies whether the filter matched the request.
-          #
-          # @since 0.3.0
-          #
-          # @api private
-          #
-          def match?(request)
-            if @path.kind_of?(Regexp)
-              !((request.path =~ @path).nil?)
-            elsif @path[0,1] == '/'
-              request.path[0,@path.length] == @path
-            else
-              request.path.include?(@path)
-            end
-          end
-
-        end
-      end
-    end
-  end
-end