ronin-recon 0.1.0.rc1 → 0.1.0

data/lib/ronin/recon/engine.rb

@@ -88,10 +88,10 @@ module Ronin
       #
       # Initializes the recon engine.
       #
-      # @param [Array<Values::Value>] values
+      # @param [Array<Value>] values
       #   The values to start performing recon on.
       #
-      # @param [Array<Values::Value>] ignore
+      # @param [Array<Value>] ignore
       #   The values to ignore while performing recon.
       #
       # @param [Integer, nil] max_depth
@@ -118,7 +118,7 @@ module Ronin
       # @yieldparam [Engine] self
       #   The newly initialized engine.
       #
-      # @yieldparam [Values::Value] parent
+      # @yieldparam [Value] parent
       #   The parent value which is associated to the discovered value.
       #
       # @api public
@@ -186,10 +186,10 @@ module Ronin
       #   If the block accepts two arguments the value and it's parent value
       #   will be passed to the block.
       #
-      # @yieldparam [Values::Value] value
+      # @yieldparam [Value] value
       #   A value discovered by one of the recon workers.
       #
-      # @yieldparam [Values::Value] parent
+      # @yieldparam [Value] parent
       #   The parent value which is associated to the discovered value.
       #
       # @return [Engine]
@@ -293,10 +293,10 @@ module Ronin
       #   If `:job_failed` is given, then any exception raised by a worker will
       #   be passed to the given block.
       #
-      # @yieldparam [Values::Value] value
+      # @yieldparam [Value] value
       #   A discovered value value.
       #
-      # @yieldparam [Values::Value] parent
+      # @yieldparam [Value] parent
       #   The parent value of the value.
       #
       # @yieldparam [Class<Worker>] worker_class
@@ -327,7 +327,7 @@ module Ronin
       # @param [Worker] worker
       #   The worker that is processing the value.
       #
-      # @param [Values::Value] value
+      # @param [Value] value
       #   The value that is being processed.
       #
       # @api private
@@ -344,7 +344,7 @@ module Ronin
       # @param [Worker] worker
       #   The worker that processed the value.
       #
-      # @param [Values::Value] value
+      # @param [Value] value
       #   The value that was processed.
       #
       # @api private
@@ -361,7 +361,7 @@ module Ronin
       # @param [Worker] worker
       #   The worker that raised the exception.
       #
-      # @param [Values::Value] value
+      # @param [Value] value
       #   The value that was being processed.
       #
       # @param [RuntimeError] exception
@@ -381,10 +381,10 @@ module Ronin
       # @param [Worker] worker
       #   The worker that discovered the value.
       #
-      # @param [Values::Value] value
+      # @param [Value] value
       #   The newly discovered value.
       #
-      # @param [Values::Value] parent
+      # @param [Value] parent
       #   The parent value associated with the new value.
       #
       # @api private
@@ -405,10 +405,10 @@ module Ronin
       # @param [Worker] worker
       #   The worker that discovered the value.
       #
-      # @param [Values::Value] value
+      # @param [Value] value
       #   The discovered value.
       #
-      # @param [Values::Value] parent
+      # @param [Value] parent
       #   The parent value associated with the value.
       #
       # @api private
@@ -610,7 +610,7 @@ module Ronin
       #
       # Sends a new value into the recon engine for processing.
       #
-      # @param [Values::Value] value
+      # @param [Value] value
       #   The value object to enqueue.
       #
       # @api private

data/lib/ronin/recon/graph.rb

@@ -50,7 +50,7 @@ module Ronin
       #
       # Adds a value to the graph, if it already hasn't been added.
       #
-      # @param [Values::Value] new_value
+      # @param [Value] new_value
       #   The new value node to add.
       #
       # @return [Boolean]
@@ -66,7 +66,7 @@ module Ronin
       #
       # Adds a value to the graph, if it already hasn't been added.
       #
-      # @param [Values::Value] new_value
+      # @param [Value] new_value
       #   The new value node to add.
       #
       # @param [Value, nil] parent_value
@@ -89,7 +89,7 @@ module Ronin
       #
       # Determines if the value is in the graph.
       #
-      # @param [Values::Value] value
+      # @param [Value] value
       #   The value node.
       #
       # @return [Boolean]
@@ -102,7 +102,7 @@ module Ronin
       #
       # Fetches the parent value nodes for the value.
       #
-      # @param [Values::Value] value
+      # @param [Value] value
       #   The value node to lookup.
       #
       # @return [Set<Value>, nil]

data/lib/ronin/recon/importer.rb

@@ -49,10 +49,10 @@ module Ronin
       #
       # Imports the connection between two values.
       #
-      # @param [Values::Value] value
+      # @param [Value] value
       #   A discovered recon value to import.
       #
-      # @param [Values::Value] parent
+      # @param [Value] parent
       #   The parent value of the discovered recon value.
       #
       # @return [(Ronin::DB::Model, Ronin::DB::Model)]
@@ -78,7 +78,7 @@ module Ronin
       #
       # Imports a value into the database.
       #
-      # @param [Values::Value] value
+      # @param [Value] value
       #   A discovered recon value to import.
       #
       # @return [Ronin::DB::HostName,

data/lib/ronin/recon/message/job_completed.rb

@@ -35,7 +35,7 @@ module Ronin
 
         # The input value object.
         #
-        # @return [Values::Value]
+        # @return [Value]
         attr_reader :value
 
         #
@@ -44,7 +44,7 @@ module Ronin
         # @param [Worker] worker
         #   The worker object.
         #
-        # @param [Values::Value] value
+        # @param [Value] value
         #   The input value for the job.
         #
         def initialize(worker,value)

data/lib/ronin/recon/message/job_failed.rb

@@ -35,7 +35,7 @@ module Ronin
 
         # The input value object.
         #
-        # @return [Values::Value]
+        # @return [Value]
         attr_reader :value
 
         # The exception.
@@ -49,7 +49,7 @@ module Ronin
         # @param [Worker] worker
         #   The worker object.
         #
-        # @param [Values::Value] value
+        # @param [Value] value
         #   The input value object.
         #
         # @param [StandardError] exception

data/lib/ronin/recon/message/job_started.rb

@@ -35,7 +35,7 @@ module Ronin
 
         # The input value object.
         #
-        # @return [Values::Value]
+        # @return [Value]
         attr_reader :value
 
         #
@@ -44,7 +44,7 @@ module Ronin
         # @param [Worker] worker
         #   The worker object.
         #
-        # @param [Values::Value] value
+        # @param [Value] value
         #   The input value object.
         #
         def initialize(worker,value)

data/lib/ronin/recon/mixins/http.rb

@@ -43,7 +43,6 @@ module Ronin
           208, # Already Reported
           226, # IM Used
           405, # Method Not Allowed
-          406, # Not Acceptable
           409, # Conflict
           415, # Unsupported Media Type
           422, # Unprocessable Content

data/lib/ronin/recon/output_formats/dir.rb

@@ -33,7 +33,7 @@ module Ronin
 
         # The opened filenames and files within the output directory.
         #
-        # @return [Hash{Class<Values::Value> => File}]
+        # @return [Hash{Class<Value> => File}]
         attr_reader :files
 
         # Mapping of value classes to file names.
@@ -69,7 +69,7 @@ module Ronin
         #
         # Writes a new value to it's specific file.
         #
-        # @param [Values::Value] value
+        # @param [Value] value
         #   The value to write.
         #
         def <<(value)

data/lib/ronin/recon/output_formats/dot.rb

@@ -60,7 +60,7 @@ module Ronin
         #
         # Returns the descriptive type name for the value object.
         #
-        # @param [Values::Value] value
+        # @param [Value] value
         #   The value object.
         #
         # @return [String]
@@ -91,7 +91,7 @@ module Ronin
         #
         # Returns the body text for the value object.
         #
-        # @param [Values::Value] value
+        # @param [Value] value
         #   The value object.
         #
         # @return [String]
@@ -112,7 +112,7 @@ module Ronin
         # Writes a value to the GraphViz DOT output stream as a node
         # declaration.
         #
-        # @param [Values::Value] value
+        # @param [Value] value
         #   The value object to write.
         #
         def <<(value)
@@ -127,10 +127,10 @@ module Ronin
         # Appends a value and it's parent value to the GraphViz DOT output
         # stream.
         #
-        # @param [Values::Value] value
+        # @param [Value] value
         #   The value to append.
         #
-        # @param [Values::Value] parent
+        # @param [Value] parent
         #   The parent value of the given value.
         #
         # @return [self]

data/lib/ronin/recon/output_formats/graph_format.rb

@@ -29,10 +29,10 @@ module Ronin
         # Appends a value and it's parent value to the GraphViz DOT output
         # stream.
         #
-        # @param [Values::Value] value
+        # @param [Value] value
         #   The value to append.
         #
-        # @param [Values::Value] parent
+        # @param [Value] parent
         #   The parent value of the given value.
         #
         # @return [self]

data/lib/ronin/recon/output_formats/graphviz_format.rb

@@ -72,7 +72,7 @@ module Ronin
         #
         # Writes a value to the GraphViz output stream as a node declaration.
         #
-        # @param [Values::Value] value
+        # @param [Value] value
         #   The value object to write.
         #
         def <<(value)
@@ -82,10 +82,10 @@ module Ronin
         #
         # Appends a value and it's parent value to the GraphViz output stream.
         #
-        # @param [Values::Value] value
+        # @param [Value] value
         #   The value to append.
         #
-        # @param [Values::Value] parent
+        # @param [Value] parent
         #   The parent value of the given value.
         #
         # @return [self]

data/lib/ronin/recon/scope.rb

@@ -23,6 +23,8 @@ require 'ronin/recon/values/domain'
 require 'ronin/recon/values/host'
 require 'ronin/recon/values/ip_range'
 require 'ronin/recon/values/ip'
+require 'ronin/recon/values/url'
+require 'ronin/recon/values/email_address'
 
 module Ronin
   module Recon
@@ -46,7 +48,7 @@ module Ronin
       #
       # Initializes the scope.
       #
-      # @param [Array<Values::Wildcard, Values::Domain, Values::Host, Values::IPRange, Values::IP>] values
+      # @param [Array<Values::Wildcard, Values::Domain, Values::Host, Values::Website, Values::IPRange, Values::IP>] values
       #   The list of "in scope" values.
       #
       # @param [Array<Value>] ignore
@@ -64,7 +66,7 @@ module Ronin
 
         values.each do |value|
           case value
-          when Values::Wildcard, Values::Domain, Values::Host
+          when Values::Wildcard, Values::Domain, Values::Host, Values::Website
             @host_values << value
           when Values::IP, Values::IPRange
             @ip_values << value
@@ -91,7 +93,9 @@ module Ronin
                        when Values::Wildcard,
                             Values::Domain,
                             Values::Host,
-                            Values::URL
+                            Values::Website,
+                            Values::URL,
+                            Values::EmailAddress
                          @host_values
                        when Values::IP,
                             Values::IPRange

data/lib/ronin/recon/value_status.rb

@@ -34,7 +34,7 @@ module Ronin
       #
       # Records that a value was enqueued for the given worker class.
       #
-      # @param [Values::Value] value
+      # @param [Value] value
       #
       # @param [Class<Worker>] worker_class
       #
@@ -45,7 +45,7 @@ module Ronin
       #
       # Records that a worker has dequeued the value and started processing it.
       #
-      # @param [Values::Value] value
+      # @param [Value] value
       #
       # @param [Class<Worker>] worker_class
       #
@@ -56,7 +56,7 @@ module Ronin
       #
       # Records that a worker has completed processing the value.
       #
-      # @param [Values::Value] value
+      # @param [Value] value
       #
       # @param [Class<Worker>] worker_class
       #

data/lib/ronin/recon/values/domain.rb

@@ -22,6 +22,7 @@ require 'ronin/recon/values/host'
 require 'ronin/recon/values/ip'
 require 'ronin/recon/values/website'
 require 'ronin/recon/values/url'
+require 'ronin/recon/values/email_address'
 
 module Ronin
   module Recon
@@ -52,6 +53,9 @@ module Ronin
             if (other_host = other.host)
               other_host == @name || other_host.end_with?(".#{@name}")
             end
+          when EmailAddress
+            other.address.end_with?("@#{@name}") ||
+              other.address.end_with?(".#{@name}")
           else
             false
           end

data/lib/ronin/recon/values/email_address.rb

@@ -48,7 +48,7 @@ module Ronin
         #
         # Compares the value to another value.
         #
-        # @param [Values::Value] other
+        # @param [Value] other
         #   The other value to compare.
         #
         # @return [Boolean]

data/lib/ronin/recon/values/host.rb

@@ -22,6 +22,7 @@ require 'ronin/recon/value'
 require 'ronin/recon/values/ip'
 require 'ronin/recon/values/website'
 require 'ronin/recon/values/url'
+require 'ronin/recon/values/email_address'
 
 module Ronin
   module Recon
@@ -51,7 +52,7 @@ module Ronin
         #
         # Compares the value to another value.
         #
-        # @param [Values::Value] other
+        # @param [Value] other
         #   The other value to compare.
         #
         # @return [Boolean]
@@ -79,6 +80,8 @@ module Ronin
             @name == other.name
           when IP, Website, URL
             @name == other.host
+          when EmailAddress
+            other.address.end_with?("@#{@name}")
           else
             false
           end

data/lib/ronin/recon/values/ip.rb

@@ -57,7 +57,7 @@ module Ronin
         #
         # Compares the value to another value.
         #
-        # @param [Values::Value] other
+        # @param [Value] other
         #   The other value to compare.
         #
         # @return [Boolean]

data/lib/ronin/recon/values/ip_range.rb

@@ -94,7 +94,7 @@ module Ronin
         #
         # Compares the value to another value.
         #
-        # @param [Values::Value] other
+        # @param [Value] other
         #
         # @return [Boolean]
         #

data/lib/ronin/recon/values/open_port.rb

@@ -105,7 +105,7 @@ module Ronin
         #
         # Compares the value to another value.
         #
-        # @param [Values::Value] other
+        # @param [Value] other
         #
         # @return [Boolean]
         #

data/lib/ronin/recon/values/url.rb

@@ -149,7 +149,7 @@ module Ronin
         #
         # Compares the value to another value.
         #
-        # @param [Values::Value] other
+        # @param [Value] other
         #
         # @return [Boolean]
         #
@@ -192,7 +192,6 @@ module Ronin
 
           hash[:status]  = @status  if @status
           hash[:headers] = @headers if @headers
-          hash[:body]    = @body    if @body
 
           return hash
         end

data/lib/ronin/recon/values/website.rb

@@ -19,6 +19,8 @@
 #
 
 require 'ronin/recon/value'
+require 'ronin/recon/values/url'
+require 'ronin/recon/values/email_address'
 
 require 'uri'
 
@@ -34,7 +36,7 @@ module Ronin
 
         # Indicates whether the website uses `http://` or `https://`.
         #
-        # @return [:http, :https]
+        # @return ['http', 'https']
         attr_reader :scheme
 
         # The website's host name.
@@ -50,7 +52,7 @@ module Ronin
         #
         # Initializes the website.
         #
-        # @param [:http, :https] scheme
+        # @param ['http', 'https'] scheme
         #   Indicates whether the website uses `http://` or `https://`.
         #
         # @param [String] host
@@ -78,7 +80,7 @@ module Ronin
         #   The new website value.
         #
         def self.http(host,port=80)
-          new(:http,host,port)
+          new('http',host,port)
         end
 
         #
@@ -94,7 +96,7 @@ module Ronin
         #   The new website value.
         #
         def self.https(host,port=443)
-          new(:https,host,port)
+          new('https',host,port)
         end
 
         #
@@ -109,13 +111,13 @@ module Ronin
         def self.parse(url)
           uri = URI.parse(url)
 
-          Values::Website.new(uri.scheme.to_sym,uri.host,uri.port)
+          Values::Website.new(uri.scheme,uri.host,uri.port)
         end
 
         #
         # Compares the value to another value.
         #
-        # @param [Values::Value] other
+        # @param [Value] other
         #
         # @return [Boolean]
         #
@@ -126,6 +128,32 @@ module Ronin
             @port   == other.port
         end
 
+        #
+        # Case equality method used for fuzzy matching.
+        #
+        # @param [Value] other
+        #   The other value to compare.
+        #
+        # @return [Boolean]
+        #   Imdicates whether the other value is either the same {Website} or
+        #   a {URL} with the same {#scheme}, {#host}, and {#port} as the
+        #   website.
+        #
+        def ===(other)
+          case other
+          when Website
+            self == other
+          when URL
+            @scheme == other.scheme &&
+              @host == other.host &&
+              @port == other.port
+          when EmailAddress
+            other.address.end_with?("@#{@host}")
+          else
+            false
+          end
+        end
+
         #
         # The "hash" value of the wildcard host name.
         #
@@ -140,8 +168,8 @@ module Ronin
         #
         # @api private
         URI_CLASSES = {
-          https: URI::HTTPS,
-          http:  URI::HTTP
+          'https' => URI::HTTPS,
+          'http'  => URI::HTTP
         }
 
         #
@@ -161,8 +189,8 @@ module Ronin
         #   The base URL value for the website.
         #
         def to_s
-          if ((@scheme == :https) && (@port != 443)) ||
-             ((@scheme == :http)  && (@port != 80))
+          if ((@scheme == 'https') && (@port != 443)) ||
+             ((@scheme == 'http')  && (@port != 80))
             "#{@scheme}://#{@host}:#{@port}"
           else
             "#{@scheme}://#{@host}"

data/lib/ronin/recon/values/wildcard.rb

@@ -52,7 +52,7 @@ module Ronin
         #
         # Compares the value to another value.
         #
-        # @param [Values::Value] other
+        # @param [Value] other
         #
         # @return [Boolean]
         #

data/lib/ronin/recon/version.rb

@@ -21,6 +21,6 @@
 module Ronin
   module Recon
     # ronin-recon version
-    VERSION = '0.1.0.rc1'
+    VERSION = '0.1.0'
   end
 end

data/lib/ronin/recon/worker.rb

@@ -392,7 +392,7 @@ module Ronin
       #
       # Initializes the worker and runs it with the single value.
       #
-      # @param [Values::Value] value
+      # @param [Value] value
       #   The input value to process.
       #
       # @param [Hash{Symbol => Object}] kwargs
@@ -413,13 +413,13 @@ module Ronin
       #
       # Calls the recon worker with the given input value.
       #
-      # @param [Values::Value] value
+      # @param [Value] value
       #   The input value.
       #
       # @yield [new_value]
       #   The `call` method can then `yield` one or more newly discovered values
       #
-      # @yieldparam [Values::Value] new_value
+      # @yieldparam [Value] new_value
       #   An newly discovered output value from the input value.
       #
       # @abstract

data/man/ronin-recon-run.1

@@ -57,7 +57,7 @@ Sets a param value for the given worker\.
 Overrides the concurrency for the given worker\.
 .TP
 \fB\-\-max\-depth\fR \fINUM\fP
-The maximum recon depth\. Defaults to depth of \fB3\fR if the option is not
+The maximum recon depth\. Defaults to depth of \fB10\fR if the option is not
 specified\.
 .TP
 \fB\-o\fR, \fB\-\-output\fR \fIFILE\fP

data/man/ronin-recon-run.1.md

@@ -60,7 +60,7 @@ Runs the recon engine with one or more initial values.
 : Overrides the concurrency for the given worker.
 
 `--max-depth` *NUM*
-: The maximum recon depth. Defaults to depth of `3` if the option is not
+: The maximum recon depth. Defaults to depth of `10` if the option is not
   specified.
 
 `-o`, `--output` *FILE*