ronin-web 0.2.1 → 0.3.0.pre1

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

@@ -0,0 +1,142 @@
+#
+# 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
+              print_info "Returning file #{local_path.dump}"
+              return response_for(local_path)
+            end
+          end
+
+          super(env)
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+#
+# 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/ip_filter'
+require 'ronin/web/middleware/filters/campaign_filter'
+require 'ronin/web/middleware/filters/path_filter'
+require 'ronin/web/middleware/filters/vhost_filter'
+require 'ronin/web/middleware/filters/referer_filter'
+require 'ronin/web/middleware/filters/user_agent_filter'

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

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

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

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

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

@@ -0,0 +1,71 @@
+#
+# 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 based on their HTTP Referer URL.
+        #
+        class RefererFilter
+
+          #
+          # Creates a new HTTP Referer filter.
+          #
+          # @param [String, Regexp] referer
+          #   The HTTP Referer URL pattern to match against.
+          #
+          # @since 0.3.0
+          #
+          # @api private
+          #
+          def initialize(referer)
+            @referer = referer
+          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 @referer.kind_of?(Regexp)
+              !((request.referer =~ @referer).nil?)
+            else
+              request.referer == @referer
+            end
+          end
+
+        end
+      end
+    end
+  end
+end