ronin-recon 0.1.0.rc1

data/man/ronin-recon.1.md

@@ -0,0 +1,57 @@
+# ronin-recon 1 "2024-01-01" Ronin Recon "User Manuals"
+
+## NAME
+
+ronin-recon - A micro-framework and tool for performing reconnaissance.
+
+## SYNOPSIS
+
+`ronin-recon` [*options*] [*COMMAND* [...]]
+
+## DESCRIPTION
+
+Runs a `ronin-recon` *COMMAND*.
+
+## ARGUMENTS
+
+*COMMAND*
+: The `ronin-recon` command to execute.
+
+## OPTIONS
+
+`-V`, `--version`
+: Prints the `ronin-recon` version and exits.
+
+`-h`, `--help`
+: Print help information
+
+## COMMANDS
+
+*completion*
+: Manages the shell completion rules for `ronin-recon`.
+
+*help*
+: Lists available commands or shows help about a specific command.
+
+*irb*
+: Starts an interactive Ruby shell with ronin-recon loaded.
+
+*new*
+: Creates a new recon worker file.
+
+*test*
+: Loads an individual worker and tests it.
+
+*worker*
+: Prints information about a recon worker.
+
+*workers*
+: Lists the available recon workers.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+
+## SEE ALSO
+
+[ronin-recon-completion](ronin-recon-completion.1.md) [ronin-recon-new](ronin-recon-new.1.md) [ronin-recon-test](ronin-recon-test.1.md) [ronin-recon-worker](ronin-recon-worker.1.md) [ronin-recon-workers](ronin-recon-workers.1.md)

data/ronin-recon.gemspec

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+Gem::Specification.new do |gem|
+  gemspec = YAML.load_file('gemspec.yml')
+
+  gem.name    = gemspec.fetch('name')
+  gem.version = gemspec.fetch('version') do
+                  lib_dir = File.join(File.dirname(__FILE__),'lib')
+                  $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+
+                  require 'ronin/recon/version'
+                  Ronin::Recon::VERSION
+                end
+
+  gem.summary     = gemspec['summary']
+  gem.description = gemspec['description']
+  gem.licenses    = Array(gemspec['license'])
+  gem.authors     = Array(gemspec['authors'])
+  gem.email       = gemspec['email']
+  gem.homepage    = gemspec['homepage']
+  gem.metadata    = gemspec['metadata'] if gemspec['metadata']
+
+  glob = ->(patterns) { gem.files & Dir[*patterns] }
+
+  gem.files  = `git ls-files`.split($/)
+  gem.files  = glob[gemspec['files']] if gemspec['files']
+  gem.files += Array(gemspec['generated_files'])
+  # exclude test files from the packages gem
+  gem.files -= glob[gemspec['test_files'] || 'spec/{**/}*']
+
+  gem.executables = gemspec.fetch('executables') do
+    glob['bin/*'].map { |path| File.basename(path) }
+  end
+
+  gem.extensions       = glob[gemspec['extensions'] || 'ext/**/extconf.rb']
+  gem.extra_rdoc_files = glob[gemspec['extra_doc_files'] || '*.{txt,md}']
+
+  gem.require_paths = Array(gemspec.fetch('require_paths') {
+    %w[ext lib].select { |dir| File.directory?(dir) }
+  })
+
+  gem.requirements              = gemspec['requirements']
+  gem.required_ruby_version     = gemspec['required_ruby_version']
+  gem.required_rubygems_version = gemspec['required_rubygems_version']
+  gem.post_install_message      = gemspec['post_install_message']
+
+  split = ->(string) { string.split(/,\s*/) }
+
+  if gemspec['dependencies']
+    gemspec['dependencies'].each do |name,versions|
+      gem.add_dependency(name,split[versions])
+    end
+  end
+
+  if gemspec['development_dependencies']
+    gemspec['development_dependencies'].each do |name,versions|
+      gem.add_development_dependency(name,split[versions])
+    end
+  end
+end

data/scripts/setup

@@ -0,0 +1,58 @@
+#!/usr/bin/env bash
+
+#
+# Prints a log message.
+#
+function log()
+{
+	if [[ -t 1 ]]; then
+		echo -e "\x1b[1m\x1b[32m>>>\x1b[0m \x1b[1m$1\x1b[0m"
+	else
+		echo ">>> $1"
+	fi
+}
+
+#
+# Prints a warn message.
+#
+function warn()
+{
+	if [[ -t 1 ]]; then
+		echo -e "\x1b[1m\x1b[33m***\x1b[0m \x1b[1m$1\x1b[0m" >&2
+	else
+		echo "*** $1" >&2
+	fi
+}
+
+#
+# Prints an error message.
+#
+function error()
+{
+	if [[ -t 1 ]]; then
+		echo -e "\x1b[1m\x1b[31m!!!\x1b[0m \x1b[1m$1\x1b[0m" >&2
+	else
+		echo "!!! $1" >&2
+	fi
+}
+
+#
+# Prints an error message and exists with -1.
+#
+function fail()
+{
+	error "$@"
+	exit -1
+}
+
+# default to installing gems into vendor/bundle
+if [[ ! -f .bundle/config ]]; then
+	bundle config set --local path vendor/bundle >/dev/null || \
+	  fail "Failed to run 'bundle config'"
+fi
+
+log "Installing gems ..."
+bundle install || fail "Failed to run 'bundle install'!"
+
+log "Setting up the project ..."
+bundle exec rake setup || "Failed to run 'rake setup'!"

metadata

@@ -0,0 +1,364 @@
+--- !ruby/object:Gem::Specification
+name: ronin-recon
+version: !ruby/object:Gem::Version
+  version: 0.1.0.rc1
+platform: ruby
+authors:
+- Postmodern
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thread-local
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: async-io
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: async-dns
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: async-http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.60'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.60'
+- !ruby/object:Gem::Dependency
+  name: wordlist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: ronin-support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0.rc1
+- !ruby/object:Gem::Dependency
+  name: ronin-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0.rc1
+- !ruby/object:Gem::Dependency
+  name: ronin-db
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0.rc1
+- !ruby/object:Gem::Dependency
+  name: ronin-repos
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: ronin-masscan
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0.rc1
+- !ruby/object:Gem::Dependency
+  name: ronin-nmap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0.rc1
+- !ruby/object:Gem::Dependency
+  name: ronin-web-spider
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0.rc1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: |
+  ronin-recon is a micro-framework and tool for performing reconnaissance.
+  ronin-recon uses multiple workers which process different data types
+  (IP, host, URL, etc) and produce new values. ronin-recon contains built-in
+  recon workers and supports loading additional 3rd-party workers from Ruby
+  files or 3rd-party git repositories. ronin-recon has a unique queue design
+  and uses asynchronous I/O to maximize efficiency. ronin-recon can lookup
+  IPs addresses, nameservers, mailservers, bruteforce sub-domains, port scan
+  IPs, discover services, and spider websites.
+email: postmodern.mod3@gmail.com
+executables:
+- ronin-recon
+extensions: []
+extra_rdoc_files:
+- COPYING.txt
+- ChangeLog.md
+- README.md
+files:
+- ".document"
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".yardopts"
+- COPYING.txt
+- ChangeLog.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/ronin-recon
+- data/completions/ronin-recon
+- data/templates/worker.rb.erb
+- data/wordlists/raft-small-directories.txt.gz
+- data/wordlists/subdomains-1000.txt.gz
+- examples/recon.rb
+- gemspec.yml
+- lib/ronin/recon.rb
+- lib/ronin/recon/builtin.rb
+- lib/ronin/recon/builtin/dns/lookup.rb
+- lib/ronin/recon/builtin/dns/mailservers.rb
+- lib/ronin/recon/builtin/dns/nameservers.rb
+- lib/ronin/recon/builtin/dns/reverse_lookup.rb
+- lib/ronin/recon/builtin/dns/srv_enum.rb
+- lib/ronin/recon/builtin/dns/subdomain_enum.rb
+- lib/ronin/recon/builtin/dns/suffix_enum.rb
+- lib/ronin/recon/builtin/net/ip_range_enum.rb
+- lib/ronin/recon/builtin/net/port_scan.rb
+- lib/ronin/recon/builtin/net/service_id.rb
+- lib/ronin/recon/builtin/ssl/cert_enum.rb
+- lib/ronin/recon/builtin/ssl/cert_grab.rb
+- lib/ronin/recon/builtin/ssl/cert_sh.rb
+- lib/ronin/recon/builtin/web/dir_enum.rb
+- lib/ronin/recon/builtin/web/email_addresses.rb
+- lib/ronin/recon/builtin/web/spider.rb
+- lib/ronin/recon/cli.rb
+- lib/ronin/recon/cli/command.rb
+- lib/ronin/recon/cli/commands/completion.rb
+- lib/ronin/recon/cli/commands/irb.rb
+- lib/ronin/recon/cli/commands/new.rb
+- lib/ronin/recon/cli/commands/run.rb
+- lib/ronin/recon/cli/commands/test.rb
+- lib/ronin/recon/cli/commands/worker.rb
+- lib/ronin/recon/cli/commands/workers.rb
+- lib/ronin/recon/cli/debug_option.rb
+- lib/ronin/recon/cli/printing.rb
+- lib/ronin/recon/cli/ruby_shell.rb
+- lib/ronin/recon/cli/worker_command.rb
+- lib/ronin/recon/config.rb
+- lib/ronin/recon/dns_worker.rb
+- lib/ronin/recon/engine.rb
+- lib/ronin/recon/exceptions.rb
+- lib/ronin/recon/graph.rb
+- lib/ronin/recon/importer.rb
+- lib/ronin/recon/input_file.rb
+- lib/ronin/recon/message/job_completed.rb
+- lib/ronin/recon/message/job_failed.rb
+- lib/ronin/recon/message/job_started.rb
+- lib/ronin/recon/message/shutdown.rb
+- lib/ronin/recon/message/value.rb
+- lib/ronin/recon/message/worker_started.rb
+- lib/ronin/recon/message/worker_stopped.rb
+- lib/ronin/recon/mixins.rb
+- lib/ronin/recon/mixins/dns.rb
+- lib/ronin/recon/mixins/http.rb
+- lib/ronin/recon/output_formats.rb
+- lib/ronin/recon/output_formats/dir.rb
+- lib/ronin/recon/output_formats/dot.rb
+- lib/ronin/recon/output_formats/graph_format.rb
+- lib/ronin/recon/output_formats/graphviz_format.rb
+- lib/ronin/recon/output_formats/pdf.rb
+- lib/ronin/recon/output_formats/png.rb
+- lib/ronin/recon/output_formats/svg.rb
+- lib/ronin/recon/registry.rb
+- lib/ronin/recon/root.rb
+- lib/ronin/recon/scope.rb
+- lib/ronin/recon/value.rb
+- lib/ronin/recon/value/parser.rb
+- lib/ronin/recon/value_status.rb
+- lib/ronin/recon/values.rb
+- lib/ronin/recon/values/cert.rb
+- lib/ronin/recon/values/domain.rb
+- lib/ronin/recon/values/email_address.rb
+- lib/ronin/recon/values/host.rb
+- lib/ronin/recon/values/ip.rb
+- lib/ronin/recon/values/ip_range.rb
+- lib/ronin/recon/values/mailserver.rb
+- lib/ronin/recon/values/nameserver.rb
+- lib/ronin/recon/values/open_port.rb
+- lib/ronin/recon/values/url.rb
+- lib/ronin/recon/values/website.rb
+- lib/ronin/recon/values/wildcard.rb
+- lib/ronin/recon/version.rb
+- lib/ronin/recon/web_worker.rb
+- lib/ronin/recon/worker.rb
+- lib/ronin/recon/worker_pool.rb
+- lib/ronin/recon/workers.rb
+- man/ronin-recon-completion.1
+- man/ronin-recon-completion.1.md
+- man/ronin-recon-irb.1
+- man/ronin-recon-irb.1.md
+- man/ronin-recon-new.1
+- man/ronin-recon-new.1.md
+- man/ronin-recon-run.1
+- man/ronin-recon-run.1.md
+- man/ronin-recon-test.1
+- man/ronin-recon-test.1.md
+- man/ronin-recon-worker.1
+- man/ronin-recon-worker.1.md
+- man/ronin-recon-workers.1
+- man/ronin-recon-workers.1.md
+- man/ronin-recon.1
+- man/ronin-recon.1.md
+- ronin-recon.gemspec
+- scripts/setup
+homepage: https://ronin-rb.dev/
+licenses:
+- LGPL-3.0
+metadata:
+  documentation_uri: https://ronin-rb.dev/docs/ronin-recon
+  source_code_uri: https://github.com/ronin-rb/ronin-recon
+  bug_tracker_uri: https://github.com/ronin-rb/ronin-recon/issues
+  changelog_uri: https://github.com/ronin-rb/ronin-recon/blob/main/ChangeLog.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.27
+signing_key:
+specification_version: 4
+summary: A micro-framework and tool for performing reconnaissance.
+test_files: []