ronin-recon 0.1.0.rc1

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

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+#
+# ronin-recon - A micro-framework and tool for performing reconnaissance.
+#
+# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
+#
+# ronin-recon is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-recon 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-recon.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/core/output_formats/output_dir'
+require 'ronin/recon/values'
+
+require 'set'
+
+module Ronin
+  module Recon
+    module OutputFormats
+      #
+      # Represents an output directory.
+      #
+      class Dir < Core::OutputFormats::OutputDir
+
+        # The opened filenames and files within the output directory.
+        #
+        # @return [Hash{Class<Values::Value> => File}]
+        attr_reader :files
+
+        # Mapping of value classes to file names.
+        VALUE_FILE_NAMES = {
+          Values::Domain       => 'domains.txt',
+          Values::Mailserver   => 'mailservers.txt',
+          Values::Nameserver   => 'nameservers.txt',
+          Values::Host         => 'hosts.txt',
+          Values::Wildcard     => 'wildcards.txt',
+          Values::IP           => 'ips.txt',
+          Values::IPRange      => 'ip_ranges.txt',
+          Values::OpenPort     => 'open_ports.txt',
+          Values::Cert         => 'certs.txt',
+          Values::EmailAddress => 'email_addresses.txt',
+          Values::URL          => 'urls.txt',
+          Values::Website      => 'websites.txt'
+        }
+
+        #
+        # Initializes the list output format.
+        #
+        # @param [String] path
+        #   The output file path.
+        #
+        def initialize(path)
+          super(path)
+
+          @files = VALUE_FILE_NAMES.transform_values do |file_name|
+            File.open(File.join(@path,file_name),'w')
+          end
+        end
+
+        #
+        # Writes a new value to it's specific file.
+        #
+        # @param [Values::Value] value
+        #   The value to write.
+        #
+        def <<(value)
+          file = @files.fetch(value.class) do
+            raise(NotImplementedError,"unsupported value class: #{value.inspect}")
+          end
+
+          file.puts(value)
+          file.flush
+        end
+
+        #
+        # Closes the output files.
+        #
+        def close
+          @files.each_value(&:close)
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+#
+# ronin-recon - A micro-framework and tool for performing reconnaissance.
+#
+# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
+#
+# ronin-recon is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-recon 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-recon.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/core/output_formats/output_file'
+require 'ronin/recon/output_formats/graph_format'
+require 'ronin/recon/values/domain'
+require 'ronin/recon/values/mailserver'
+require 'ronin/recon/values/nameserver'
+require 'ronin/recon/values/host'
+require 'ronin/recon/values/ip'
+require 'ronin/recon/values/ip_range'
+require 'ronin/recon/values/open_port'
+require 'ronin/recon/values/email_address'
+require 'ronin/recon/values/cert'
+require 'ronin/recon/values/url'
+require 'ronin/recon/values/website'
+require 'ronin/recon/values/wildcard'
+
+require 'set'
+
+module Ronin
+  module Recon
+    module OutputFormats
+      #
+      # Represents a GraphViz DOT (`.dot`) output format.
+      #
+      class Dot < Core::OutputFormats::OutputFile
+
+        include GraphFormat
+
+        #
+        # Initializes the GraphViz DOT (`.dot`) output format.
+        #
+        # @param [IO] io
+        #   The output stream to write to.
+        #
+        def initialize(io)
+          super(io)
+
+          @io.puts "digraph {"
+        end
+
+        #
+        # Returns the descriptive type name for the value object.
+        #
+        # @param [Values::Value] value
+        #   The value object.
+        #
+        # @return [String]
+        #   The type name for the value object.
+        #
+        # @raise [NotImplementedError]
+        #   The given value object was not supported.
+        #
+        def value_type(value)
+          case value
+          when Values::Domain       then "Domain"
+          when Values::Mailserver   then "Mailserver"
+          when Values::Nameserver   then "Nameserver"
+          when Values::Host         then "Host"
+          when Values::IP           then "IP address"
+          when Values::IPRange      then "IP range"
+          when Values::OpenPort     then "Open #{value.protocol.upcase} Port"
+          when Values::EmailAddress then "Email Address"
+          when Values::Cert         then "SSL/TLS Cert"
+          when Values::URL          then "URL"
+          when Values::Website      then "Website"
+          when Values::Wildcard     then "Wildcard"
+          else
+            raise(NotImplementedError,"value class #{value.class} not supported")
+          end
+        end
+
+        #
+        # Returns the body text for the value object.
+        #
+        # @param [Values::Value] value
+        #   The value object.
+        #
+        # @return [String]
+        #   The body text for the value object.
+        #
+        def value_text(value)
+          case value
+          when Values::URL
+            "#{value.status} #{value}"
+          when Values::Cert
+            value.subject.to_h.map { |k,v| "#{k}: #{v}\n" }.join
+          else
+            value.to_s
+          end
+        end
+
+        #
+        # Writes a value to the GraphViz DOT output stream as a node
+        # declaration.
+        #
+        # @param [Values::Value] value
+        #   The value object to write.
+        #
+        def <<(value)
+          name  = value.to_s
+          label = "#{value_type(value)}\n#{value_text(value)}"
+
+          @io.puts "\t#{name.inspect} [label=#{label.inspect}]"
+          @io.flush
+        end
+
+        #
+        # Appends a value and it's parent value to the GraphViz DOT output
+        # stream.
+        #
+        # @param [Values::Value] value
+        #   The value to append.
+        #
+        # @param [Values::Value] parent
+        #   The parent value of the given value.
+        #
+        # @return [self]
+        #
+        def []=(value,parent)
+          @io.puts "\t#{parent.to_s.inspect} -> #{value.to_s.inspect}"
+          @io.flush
+        end
+
+        #
+        # Writes the complete JSON Array of values and closes the IO stream.
+        #
+        def close
+          @io.puts "}"
+
+          super
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+#
+# ronin-recon - A micro-framework and tool for performing reconnaissance.
+#
+# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
+#
+# ronin-recon is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-recon 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-recon.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+module Ronin
+  module Recon
+    module OutputFormats
+      #
+      # Indicates that an output format can contain graph information.
+      #
+      module GraphFormat
+        #
+        # Appends a value and it's parent value to the GraphViz DOT output
+        # stream.
+        #
+        # @param [Values::Value] value
+        #   The value to append.
+        #
+        # @param [Values::Value] parent
+        #   The parent value of the given value.
+        #
+        # @return [self]
+        #
+        # @abstract
+        #
+        def []=(value,parent)
+          raise(NotImplementedError,"#{self.class}#[]= was not implemented")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+#
+# ronin-recon - A micro-framework and tool for performing reconnaissance.
+#
+# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
+#
+# ronin-recon is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-recon 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-recon.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/core/output_formats/output_file'
+require 'ronin/recon/output_formats/graph_format'
+require 'ronin/recon/output_formats/dot'
+
+require 'tempfile'
+
+module Ronin
+  module Recon
+    module OutputFormats
+      #
+      # Represents a GraphViz output format.
+      #
+      class GraphvizFormat < Core::OutputFormats::OutputFile
+
+        include GraphFormat
+
+        # The `.dot` output file.
+        #
+        # @return [Tempfile]
+        attr_reader :dot_file
+
+        # The DOT output format.
+        #
+        # @return [Dot]
+        attr_reader :dot_output
+
+        #
+        # Initializes the GraphViz output format.
+        #
+        # @param [IO] io
+        #   The output stream to write to.
+        #
+        def initialize(io)
+          super(io)
+
+          @dot_file   = Tempfile.new(['ronin-recon',"#{format}"])
+          @dot_output = Dot.new(@dot_file)
+        end
+
+        #
+        # The desired GraphViz output format.
+        #
+        # @return [Symbol]
+        #   The output format name.
+        #
+        # @abstract
+        #
+        def format
+          raise(NotImplementedError,"#{self.class}#format was not defined!")
+        end
+
+        #
+        # Writes a value to the GraphViz output stream as a node declaration.
+        #
+        # @param [Values::Value] value
+        #   The value object to write.
+        #
+        def <<(value)
+          @dot_output << value
+        end
+
+        #
+        # Appends a value and it's parent value to the GraphViz output stream.
+        #
+        # @param [Values::Value] value
+        #   The value to append.
+        #
+        # @param [Values::Value] parent
+        #   The parent value of the given value.
+        #
+        # @return [self]
+        #
+        def []=(value,parent)
+          @dot_output[value] = parent
+          return self
+        end
+
+        #
+        # Closes and generates the GraphViz output file.
+        #
+        def close
+          @dot_output.close
+
+          IO.popen(['dot',"-T#{format}",@dot_file.path]) do |dot_io|
+            # relay the `dot` output to the output stream.
+            @io.write(dot_io.readpartial(4096)) until dot_io.eof?
+          end
+
+          super
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+#
+# ronin-recon - A micro-framework and tool for performing reconnaissance.
+#
+# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
+#
+# ronin-recon is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-recon 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-recon.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/recon/output_formats/graphviz_format'
+
+module Ronin
+  module Recon
+    module OutputFormats
+      #
+      # Represents a GraphViz PDF (`.pdf`) output format.
+      #
+      class PDF < GraphvizFormat
+
+        #
+        # The desired GraphViz output format.
+        #
+        # @return [:pdf]
+        #
+        def format
+          :pdf
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+#
+# ronin-recon - A micro-framework and tool for performing reconnaissance.
+#
+# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
+#
+# ronin-recon is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-recon 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-recon.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/recon/output_formats/graphviz_format'
+
+module Ronin
+  module Recon
+    module OutputFormats
+      #
+      # Represents a GraphViz PNG (`.png`) output format.
+      #
+      class PNG < GraphvizFormat
+
+        #
+        # The desired GraphViz output format.
+        #
+        # @return [:png]
+        #
+        def format
+          :png
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+#
+# ronin-recon - A micro-framework and tool for performing reconnaissance.
+#
+# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
+#
+# ronin-recon is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-recon 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-recon.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/recon/output_formats/graphviz_format'
+
+module Ronin
+  module Recon
+    module OutputFormats
+      #
+      # Represents a GraphViz SVG (`.svg`) output format.
+      #
+      class SVG < GraphvizFormat
+
+        #
+        # The desired GraphViz output format.
+        #
+        # @return [:svg]
+        #
+        def format
+          :svg
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/recon/output_formats.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+#
+# ronin-recon - A micro-framework and tool for performing reconnaissance.
+#
+# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
+#
+# ronin-recon is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-recon 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-recon.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/core/output_formats'
+require 'ronin/recon/output_formats/dir'
+require 'ronin/recon/output_formats/dot'
+require 'ronin/recon/output_formats/svg'
+require 'ronin/recon/output_formats/png'
+require 'ronin/recon/output_formats/pdf'
+
+module Ronin
+  module Recon
+    #
+    # Contains the supported output formats for saving {Ronin::Recon::Values}
+    # object to output files.
+    #
+    module OutputFormats
+      include Core::OutputFormats
+
+      register :txt,    '.txt',    TXT
+      register :csv,    '.csv',    CSV
+      register :json,   '.json',   JSON
+      register :ndjson, '.ndjson', NDJSON
+      register :dir,    '',        Dir
+      register :dot,    '.dot',    Dot
+      register :svg,    '.svg',    SVG
+      register :png,    '.png',    PNG
+      register :pdf,    '.pdf',    PDF
+    end
+  end
+end

data/lib/ronin/recon/registry.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+#
+# ronin-recon - A micro-framework and tool for performing reconnaissance.
+#
+# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
+#
+# ronin-recon is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-recon 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-recon.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/core/class_registry'
+require 'ronin/repos/class_dir'
+
+module Ronin
+  #
+  # Namespace for various worker classes.
+  #
+  module Recon
+    include Core::ClassRegistry
+    include Repos::ClassDir
+
+    class_dir "#{__dir__}/builtin"
+    repo_class_dir 'recon'
+  end
+end

data/lib/ronin/recon/root.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+#
+# ronin-recon - A micro-framework and tool for performing reconnaissance.
+#
+# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
+#
+# ronin-recon is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-recon 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-recon.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+module Ronin
+  module Recon
+    # Path to `ronin-recon` root directory.
+    #
+    # @api private
+    ROOT = File.expand_path(File.join(__dir__,'..','..','..'))
+
+    # Path to wordlists directory
+    #
+    # @api private
+    WORDLISTS_DIR = File.join(ROOT, "data", "wordlists")
+  end
+end