ronin-recon 0.1.0.rc1

data/lib/ronin/recon/cli/commands/workers.rb

@@ -0,0 +1,80 @@
+# 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/cli/command'
+require 'ronin/recon/registry'
+
+module Ronin
+  module Recon
+    class CLI
+      module Commands
+        #
+        # Lists the available recon workers.
+        #
+        # ## Usage
+        #
+        #    ronin-recon help [options]
+        #
+        # ## Options
+        #
+        #    -h, --help                       Print help information
+        #
+        # ## Arguments
+        #
+        #    [COMMAND]                        Command name to lookup
+        #
+        class Workers < Command
+
+          usage '[options] [DIR]'
+
+          argument :dir, required: false,
+                         desc:     'The optional recon worker directory to list'
+
+          description 'Lists the available recon workers'
+
+          man_page 'ronin-workers-list.1'
+
+          #
+          # Runs the `ronin-recon workers` command.
+          #
+          # @param [String, nil] dir
+          #   The optional recon worker directory to list.
+          #
+          def run(dir=nil)
+            files = if dir
+                      dir = "#{dir}/" unless dir.end_with?('/')
+
+                      Ronin::Recon.list_files.select do |file|
+                        file.start_with?(dir)
+                      end
+                    else
+                      Ronin::Recon.list_files
+                    end
+
+            files.each do |file|
+              puts "  #{file}"
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/recon/cli/debug_option.rb

@@ -0,0 +1,45 @@
+# 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 'console'
+
+module Ronin
+  module Recon
+    class CLI
+      #
+      # Adds a `-D,--debug` option to the command that enables debugging output.
+      #
+      module DebugOption
+        #
+        # Adds the `-D,--debug` option to the including command class.
+        #
+        # @param [Class<Command>] command
+        #   The command class which is including {DebugOption}.
+        #
+        def self.included(command)
+          command.option :debug, short: '-D',
+                                 desc:  'Enable debugging output' do
+                                   Console.logger.level = Console::Logger::DEBUG
+                                 end
+        end
+      end
+    end
+  end
+end

data/lib/ronin/recon/cli/printing.rb

@@ -0,0 +1,122 @@
+# 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/values'
+require 'ronin/core/cli/logging'
+
+module Ronin
+  module Recon
+    class CLI
+      #
+      # Helper methods for printing {Values Value} objects.
+      #
+      module Printing
+        include Core::CLI::Logging
+
+        # Mapping of {Value} classes to printable names.
+        VALUE_CLASS_NAMES = {
+          Values::Domain       => 'domain',
+          Values::Host         => 'host',
+          Values::IP           => 'IP address',
+          Values::IPRange      => 'IP range',
+          Values::Mailserver   => 'mailserver',
+          Values::Nameserver   => 'nameserver',
+          Values::OpenPort     => 'open port',
+          Values::Cert         => 'SSL/TLS certificate',
+          Values::EmailAddress => 'email addresse',
+          Values::URL          => 'URL',
+          Values::Website      => 'website',
+          Values::Wildcard     => 'wildcard host name'
+        }
+
+        #
+        # Converts the value class into a printable name.
+        #
+        # @param [Class<Value>] value_class
+        #   The value class.
+        #
+        # @return [String]
+        #   The descriptive name for the value class.
+        #
+        # @raise [NotImplementedError]
+        #
+        def value_class_name(value_class)
+          VALUE_CLASS_NAMES.fetch(value_class) do
+            raise(NotImplementedError,"unknown value class: #{value_class.inspect}")
+          end
+        end
+
+        #
+        # Formats a value object into a human readable string.
+        #
+        # @param [Values::Value] value
+        #   The value object to format.
+        #
+        # @return [String]
+        #   The formatted value.
+        #
+        # @raise [NotImplementedError]
+        #   The given value object was not supported.
+        #
+        def format_value(value)
+          case value
+          when Values::Domain     then "domain #{value}"
+          when Values::Mailserver then "mailserver #{value}"
+          when Values::Nameserver then "nameserver #{value}"
+          when Values::Host       then "host #{value}"
+          when Values::IP         then "IP address #{value}"
+          when Values::IPRange    then "IP range #{value}"
+          when Values::OpenPort   then "open #{value.protocol.upcase} port #{value}"
+          when Values::Cert       then "SSL/TLS certificate #{value.subject}"
+          when Values::URL        then "URL #{value}"
+          when Values::Website    then "website #{value}"
+          when Values::Wildcard   then "wildcard host name #{value}"
+          else
+            raise(NotImplementedError,"value class #{value.class} not supported")
+          end
+        end
+
+        #
+        # Prints a newly discovered value.
+        #
+        # @param [Values::Value] value
+        #   The value to print.
+        #
+        # @param [Value, nil] parent
+        #   The optional parent value.
+        #
+        # @raise [NotImplementedError]
+        #   The given value object was not supported.
+        #
+        def print_value(value,parent=nil)
+          if stdout.tty?
+            if parent
+              log_info "Found new #{format_value(value)} for #{format_value(parent)}"
+            else
+              log_info "Found new #{format_value(value)}"
+            end
+          else
+            puts value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ronin/recon/cli/ruby_shell.rb

@@ -0,0 +1,51 @@
+# 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/cli/ruby_shell'
+
+module Ronin
+  module Recon
+    class CLI
+      #
+      # The interactive Ruby shell for {Ronin::Recon}.
+      #
+      class RubyShell < Core::CLI::RubyShell
+
+        #
+        # Initializes the `ronin-recon` Ruby shell.
+        #
+        # @param [String] name
+        #   The name of the IRB shell.
+        #
+        # @param [Object] context
+        #   Custom context to launch IRB from within.
+        #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional keyword arguments for
+        #   `Ronin::Core::CLI::RubyShell#initialize`.
+        #
+        def initialize(name: 'ronin-recon', context: Recon, **kwargs)
+          super(name: name, context: context, **kwargs)
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/recon/cli/worker_command.rb

@@ -0,0 +1,105 @@
+# 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/cli/command'
+require 'ronin/recon/registry'
+
+module Ronin
+  module Recon
+    class CLI
+      #
+      # Base class for commands which load an individual worker.
+      #
+      class WorkerCommand < Command
+
+        usage '[options] {--file FILE | NAME}'
+
+        option :file, short: '-f',
+                      value: {
+                        type:  String,
+                        usage: 'FILE'
+                      },
+                      desc: 'The recon worker file to load'
+
+        argument :name, required: false,
+                        desc:     'The recon worker to load'
+
+        # The loaded worker class.
+        #
+        # @return [Class<Worker>, nil]
+        attr_reader :worker_class
+
+        #
+        # Loads the recon worker class.
+        #
+        # @param [String, nil] name
+        #   The optional recon worker name to load.
+        #
+        # @return [Class<Worker>]
+        #   The loaded recon worker class.
+        #
+        def run(name=nil)
+          if name              then load_worker(name)
+          elsif options[:file] then load_worker_from(options[:file])
+          else
+            print_error("must specify --file or a NAME")
+            exit(-1)
+          end
+        end
+
+        #
+        # Loads the recon worker class and sets {#worker_class}.
+        #
+        # @param [String] id
+        #   The recon worker name to load.
+        #
+        def load_worker(id)
+          @worker_class = Recon.load_class(id)
+        rescue Recon::ClassNotFound => error
+          print_error(error.message)
+          exit(1)
+        rescue => error
+          print_exception(error)
+          print_error("an unhandled exception occurred while loading recon worker #{id}")
+          exit(-1)
+        end
+
+        #
+        # Loads the recon worker class from the given file and sets
+        # {#worker_class}.
+        #
+        # @param [String] file
+        #   The file to load the recon worker class from.
+        #
+        def load_worker_from(file)
+          @worker_class = Recon.load_class_from_file(file)
+        rescue Recon::ClassNotFound => error
+          print_error(error.message)
+          exit(1)
+        rescue => error
+          print_exception(error)
+          print_error("an unhandled exception occurred while loading recon worker from file #{file}")
+          exit(-1)
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/recon/cli.rb

@@ -0,0 +1,50 @@
+# 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/version'
+require 'ronin/core/cli/help/banner'
+
+require 'command_kit/commands'
+require 'command_kit/commands/auto_load'
+require 'command_kit/options/version'
+
+module Ronin
+  module Recon
+    #
+    # The `ronin-recon` command-line interface (CLI).
+    #
+    # @api private
+    #
+    class CLI
+
+      include CommandKit::Commands
+      include CommandKit::Commands::AutoLoad.new(
+        dir:       "#{__dir__}/cli/commands",
+        namespace: "#{self}::Commands"
+      )
+      include CommandKit::Options::Version
+      include Core::CLI::Help::Banner
+
+      command_name 'ronin-recon'
+      version Ronin::Recon::VERSION
+
+    end
+  end
+end