cms_scanner 0.0.41.10 → 0.0.42.0

data/lib/cms_scanner/browser/options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CMSScanner
   # Options available in the Browser
   class Browser

data/lib/cms_scanner/cache/file_store.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CMSScanner
   module Cache
     # Cache Implementation using files

data/lib/cms_scanner/cache/typhoeus.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cms_scanner/cache/file_store'
 
 module CMSScanner

data/lib/cms_scanner/controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CMSScanner
   module Controller
     # Base Controller

data/lib/cms_scanner/controllers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CMSScanner
   # Controllers Container
   class Controllers < Array
@@ -39,7 +41,7 @@ module CMSScanner
 
       redirect_output_to_file(parsed_options[:output]) if parsed_options[:output]
 
-      Timeout.timeout(parsed_options[:max_scan_duration], NS::MaxScanDurationReachedError) do
+      Timeout.timeout(parsed_options[:max_scan_duration], NS::Error::MaxScanDurationReached) do
         each(&:before_scan)
         each(&:run)
         # Reverse is used here as the app/controllers/core#after_scan finishes the output

data/lib/cms_scanner/errors.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CMSScanner
+  module Error
+    class Standard < StandardError
+    end
+  end
+end
+
+require_relative 'errors/http'
+require_relative 'errors/scan'

data/lib/cms_scanner/errors/http.rb

@@ -1,70 +1,71 @@
+# frozen_string_literal: true
+
 module CMSScanner
-  class Error < StandardError
-  end
+  module Error
+    # Target Down Error
+    class TargetDown < Standard
+      attr_reader :response
 
-  # Target Down Error
-  class TargetDownError < Error
-    attr_reader :response
+      def initialize(response)
+        @response = response
+      end
 
-    def initialize(response)
-      @response = response
+      def to_s
+        "The url supplied '#{response.request.url}' seems to be down (#{response.return_message})"
+      end
     end
 
-    def to_s
-      "The url supplied '#{response.request.url}' seems to be down (#{response.return_message})"
-    end
-  end
-
-  # HTTP Authentication Required Error
-  class HTTPAuthRequiredError < Error
-    # :nocov:
-    def to_s
-      'HTTP authentication required (or was invalid), please provide it with --http-auth'
+    # HTTP Authentication Required Error
+    class HTTPAuthRequired < Standard
+      # :nocov:
+      def to_s
+        'HTTP authentication required (or was invalid), please provide it with --http-auth'
+      end
+      # :nocov:
     end
-    # :nocov:
-  end
 
-  # Proxy Authentication Required Error
-  class ProxyAuthRequiredError < Error
-    # :nocov:
-    def to_s
-      'Proxy authentication required (or was invalid), please provide it with --proxy-auth'
+    # Proxy Authentication Required Error
+    class ProxyAuthRequired < Standard
+      # :nocov:
+      def to_s
+        'Proxy authentication required (or was invalid), please provide it with --proxy-auth'
+      end
+      # :nocov:
     end
-    # :nocov:
-  end
 
-  # Access Forbidden Error
-  class AccessForbiddenError < Error
-    attr_reader :random_user_agent_used
+    # Access Forbidden Error
+    class AccessForbidden < Standard
+      attr_reader :random_user_agent_used
 
-    # @param [ Boolean ] random_user_agent_used
-    def initialize(random_user_agent_used)
-      @random_user_agent_used = random_user_agent_used
-    end
+      # @param [ Boolean ] random_user_agent_used
+      def initialize(random_user_agent_used)
+        @random_user_agent_used = random_user_agent_used
+      end
 
-    def to_s
-      msg = if random_user_agent_used
-              'Well... --random-user-agent didn\'t work, you\'re on your own now!'
-            else
-              'Please re-try with --random-user-agent'
-            end
+      def to_s
+        msg = if random_user_agent_used
+                'Well... --random-user-agent didn\'t work, you\'re on your own now!'
+              else
+                'Please re-try with --random-user-agent'
+              end
 
-      "The target is responding with a 403, this might be due to a WAF. #{msg}"
+        "The target is responding with a 403, this might be due to a WAF. #{msg}"
+      end
     end
-  end
 
-  # HTTP Redirect Error
-  class HTTPRedirectError < Error
-    attr_reader :redirect_uri
+    # HTTP Redirect Error
+    class HTTPRedirect < Standard
+      attr_reader :redirect_uri
 
-    # @param [ String ] url
-    def initialize(url)
-      @redirect_uri = Addressable::URI.parse(url).normalize
-    end
+      # @param [ String ] url
+      def initialize(url)
+        @redirect_uri = Addressable::URI.parse(url).normalize
+      end
 
-    def to_s
-      "The URL supplied redirects to #{redirect_uri}. Use the --ignore-main-redirect "\
-      'option to ignore the redirection and scan the target.'
+      def to_s
+        "The URL supplied redirects to #{redirect_uri}. Use the --ignore-main-redirect "\
+        'option to ignore the redirection and scan the target.'
+      end
     end
   end
 end

data/lib/cms_scanner/errors/scan.rb

@@ -1,10 +1,14 @@
+# frozen_string_literal: true
+
 module CMSScanner
-  # Used instead of the Timeout::Error
-  class MaxScanDurationReachedError < Error
-    # :nocov:
-    def to_s
-      'Max Scan Duration Reached'
+  module Error
+    # Used instead of the Timeout::Error
+    class MaxScanDurationReached < Standard
+      # :nocov:
+      def to_s
+        'Max Scan Duration Reached'
+      end
+      # :nocov:
     end
-    # :nocov:
   end
 end

data/lib/cms_scanner/exit_code.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CMSScanner
   # Exit Code Values
   module ExitCode

data/lib/cms_scanner/finders.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cms_scanner/finders/finder'
 require 'cms_scanner/finders/finding'
 require 'cms_scanner/finders/findings'

data/lib/cms_scanner/finders/base_finders.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CMSScanner
   module Finders
     # Base class container for the Finders (i.e IndependentFinders etc)

data/lib/cms_scanner/finders/finder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cms_scanner/finders/finder/smart_url_checker'
 require 'cms_scanner/finders/finder/enumerator'
 require 'cms_scanner/finders/finder/fingerprinter'
@@ -8,7 +10,7 @@ module CMSScanner
     # Finder
     class Finder
       # Constants for common found_by
-      DIRECT_ACCESS = 'Direct Access (Aggressive Detection)'.freeze
+      DIRECT_ACCESS = 'Direct Access (Aggressive Detection)'
 
       attr_accessor :target, :progress_bar
 

data/lib/cms_scanner/finders/finder/breadth_first_dictionary_attack.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module CMSScanner
   module Finders
     class Finder
       # Module to provide an easy way to perform password attacks
       module BreadthFirstDictionaryAttack
-        # @param [ Array<CMSScanner::User> ] users
+        # @param [ Array<CMSScanner::Model::User> ] users
         # @param [ Array<String> ] passwords
         # @param [ Hash ] opts
         # @option opts [ Boolean ] :show_progression

data/lib/cms_scanner/finders/finder/enumerator.rb

@@ -1,30 +1,46 @@
+# frozen_string_literal: true
+
 module CMSScanner
   module Finders
     class Finder
       # Module to provide an easy way to enumerate items such as plugins, themes etc
       module Enumerator
+        # @return [ Hash ]
+        def head_or_get_request_params
+          # Disabling the cache, as it causes a 'stack level too deep' exception
+          # with a large number of requests.
+          # See https://github.com/typhoeus/typhoeus/issues/408
+          @head_or_get_request_params ||= target.head_or_get_params.merge(cache_ttl: 0)
+        end
+
+        # @return [ Array<Integer> ]
+        def valid_response_codes
+          @valid_response_codes ||= [200]
+        end
+
         # @param [ Hash ] The target urls
         # @param [ Hash ] opts
         # @option opts [ Boolean ] :show_progression Wether or not to display the progress bar
         # @option opts [ Regexp ] :exclude_content
+        # @option opts [ Boolean, Array, String ] :check_full_response
         #
         # @yield [ Typhoeus::Response, String ]
-        def enumerate(target_urls, opts = {})
-          create_progress_bar(opts.merge(total: target_urls.size))
+        def enumerate(urls, opts = {})
+          create_progress_bar(opts.merge(total: urls.size))
 
-          target_urls.each do |url, id|
-            request = browser.forge_request(url, request_params)
+          urls.each do |url, id|
+            request = browser.forge_request(url, head_or_get_request_params)
 
-            request.on_complete do |res|
+            request.on_complete do |head_res|
               progress_bar.increment
 
-              next if target.homepage_or_404?(res)
+              next unless valid_response_codes.include?(head_res.code)
+
+              next if opts[:exclude_content] && head_res.response_headers&.match(opts[:exclude_content])
 
-              if opts[:exclude_content]
-                next if res.response_headers&.match(opts[:exclude_content]) || res.body.match(opts[:exclude_content])
-              end
+              head_or_full_res = maybe_get_full_response(head_res, opts)
 
-              yield res, id
+              yield head_or_full_res, id if head_or_full_res
             end
 
             hydra.queue(request)
@@ -33,12 +49,25 @@ module CMSScanner
           hydra.run
         end
 
+        # @param [ Typhoeus::Response ] head_res
+        # @param [ Hash ] opts
+        #
+        # @return [ Typhoeus::Response, nil ]
+        def maybe_get_full_response(head_res, opts)
+          return head_res unless opts[:check_full_response] == true ||
+                                 [*opts[:check_full_response]].include?(head_res.code)
+
+          full_res = NS::Browser.get(head_res.effective_url, full_request_params)
+
+          return if target.homepage_or_404?(full_res) ||
+                    opts[:exclude_content] && full_res.body&.match(opts[:exclude_content])
+
+          full_res
+        end
+
         # @return [ Hash ]
-        def request_params
-          # disabling the cache, as it causes a 'stack level too deep' exception
-          # with a large number of requests :/
-          # See https://github.com/typhoeus/typhoeus/issues/408
-          { cache_ttl: 0 }
+        def full_request_params
+          @full_request_params ||= {}
         end
       end
     end

data/lib/cms_scanner/finders/finder/fingerprinter.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 module CMSScanner
   module Finders
     class Finder
       # Module to provide an easy way to fingerprint things such as versions
       module Fingerprinter
+        include Enumerator
+
         # @param [ Hash ] fingerprints The fingerprints
         # Format should be like the following:
         # {
@@ -23,31 +27,15 @@ module CMSScanner
         # @yield [ Mixed, String, String ] version/s, url, hash The version associated to the
         #                                                       fingerprint of the url
         def fingerprint(fingerprints, opts = {})
-          create_progress_bar(opts.merge(total: fingerprints.size))
-
-          fingerprints.each do |path, f|
-            url     = target.url(path.dup)
-            request = browser.forge_request(url, request_params)
-
-            request.on_complete do |res|
-              progress_bar.increment
+          enum_opts = opts.merge(check_full_response: 200)
 
-              md5sum = hexdigest(res.body)
+          enumerate(fingerprints.transform_keys { |k| target.url(k) }, enum_opts) do |res, fingerprint|
+            md5sum = hexdigest(res.body)
 
-              next unless f.key?(md5sum)
+            next unless fingerprint.key?(md5sum)
 
-              yield f[md5sum], url, md5sum
-            end
-
-            hydra.queue(request)
+            yield fingerprint[md5sum], res.effective_url, md5sum
           end
-
-          hydra.run
-        end
-
-        # @return [ Hash ]
-        def request_params
-          {}
         end
 
         # @return [ String ] The hashed value for the given body

data/lib/cms_scanner/finders/finder/smart_url_checker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cms_scanner/finders/finder/smart_url_checker/findings'
 
 module CMSScanner

data/lib/cms_scanner/finders/finder/smart_url_checker/findings.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CMSScanner
   module Finders
     class Finder

data/lib/cms_scanner/finders/finding.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CMSScanner
   module Finders
     # Finding

data/lib/cms_scanner/finders/findings.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CMSScanner
   module Finders
     # Findings container

data/lib/cms_scanner/finders/independent_finder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CMSScanner
   module Finders
     # Independent Finder

data/lib/cms_scanner/finders/independent_finders.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CMSScanner
   module Finders
     # This class is designed to handle independent results

data/lib/cms_scanner/finders/same_type_finder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CMSScanner
   module Finders
     # Same Type Finder

data/lib/cms_scanner/finders/same_type_finders.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CMSScanner
   module Finders
     # This class is designed to handle same type results, such as enumeration of plugins,