ronin-masscan 0.1.0.rc1

data/man/ronin-masscan-scan.1

@@ -0,0 +1,86 @@
+.\" Generated by kramdown-man 1.0.1
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-masscan-convert 1 "2023-03-01" Ronin Masscan "User Manuals"
+.SH NAME
+.PP
+ronin\-masscan\-scan \- Runs masscan and outputs data as JSON or CSV or imports into the database
+.SH SYNOPSIS
+.PP
+\fBronin\-masscan scan\fR \[lB]options\[rB] \fB\-\-\fR \fImasscan\[ru]options\fP \.\.\.
+.SH DESCRIPTION
+.PP
+Runs \fBmasscan\fR and outputs data as JSON or CSV or imports into the database\.
+.SH ARGUMENTS
+.TP
+\fImasscan\[ru]options\fP
+Additional options for the \fBmasscan\fR command\.
+.SH OPTIONS
+.TP
+\fB\-\-db\fR \fINAME\fP
+The database name to connect to\. Defaults to \fBdefault\fR if not given\.
+.TP
+\fB\-\-db\-uri\fR \fIURI\fP
+The explicit database URI to connect to
+(ex: \fBpostgres:\[sl]\[sl]user:password\[at]host\[sl]db\fR)\.
+.TP
+\fB\-\-db\-file\fR \fIPATH\fP
+The sqlite3 database file to use\.
+.TP
+\fB\-\-sudo\fR
+Explicitly run \fBmasscan\fR under \fBsudo\fR\. If the option is not given, then
+\fBsudo\fR will automatically be enabled if the \fImasscan\[ru]options\fP includes a
+privileged option (ex: \fB\-sS\fR, \fB\-O\fR, etc)\.
+.TP
+\fB\-o\fR, \fB\-\-output\fR \fIFILE\fP
+Sets the output file to save the \fBmasscan\fR scan results to\. May be a \fB\.xml\fR,
+\fB\.json\fR, or \fB\.csv\fR file\.
+.TP
+\fB\-F\fR, \fB\-\-output\-format\fR \fBjson\fR\[or]\fBcsv\fR
+Explicitly specify the output format to JSON or CSV\. If the option is
+not given, the output format Will be inferred from the \fB\-\-output\fR \fIFILE\fP file
+extension\.
+.TP
+\fB\-\-import\fR
+Imports the \fBmasscan\fR scan results into the Ronin database\.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print help information
+.SH ENVIRONMENT
+.TP
+\fIHOME\fP
+The user\[cq]s home directory\.
+.TP
+\fIXDG\[ru]CONFIG\[ru]HOME\fP
+Alternate location for the \fB\[ti]\[sl]\.config\fR directory\.
+.TP
+\fIXDG\[ru]DATA\[ru]HOME\fP
+Alternate location for the \fB\[ti]\[sl]\.local\[sl]share\fR directory\.
+.SH FILES
+.TP
+\fB\[ti]\[sl]\.local\[sl]share\[sl]ronin\-db\[sl]database\.sqlite3\fR
+The default sqlite3 database file\.
+.TP
+\fB\[ti]\[sl]\.config\[sl]ronin\-db\[sl]database\.yml\fR
+Optional database configuration\.
+.SH EXAMPLES
+.PP
+Port scans \fB192\.168\.1\.1\fR and save the scan results to a JSON file:
+.PP
+.RS 4
+.EX
+\[Do] ronin\-masscan scan \-o scan\.json \-\- 192\.168\.1\.1 \-p80,443,\.\.\.
+.EE
+.RE
+.PP
+Service scans \fB192\.168\.1\.1\fR and saves the scan results to the Ronin database:
+.PP
+.RS 4
+.EX
+\[Do] ronin\-masscan scan \-\-import \-\- 192\.168\.1\.1 \-p80,443,\.\.\.
+.EE
+.RE
+.SH AUTHOR
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME

data/man/ronin-masscan-scan.1.md

@@ -0,0 +1,84 @@
+# ronin-masscan-convert 1 "2023-03-01" Ronin Masscan "User Manuals"
+
+## NAME
+
+ronin-masscan-scan - Runs masscan and outputs data as JSON or CSV or imports into the database
+
+## SYNOPSIS
+
+`ronin-masscan scan` [options] `--` *masscan_options* ...
+
+## DESCRIPTION
+
+Runs `masscan` and outputs data as JSON or CSV or imports into the database.
+
+## ARGUMENTS
+
+*masscan_options*
+: Additional options for the `masscan` command.
+
+## OPTIONS
+
+`--db` *NAME*
+: The database name to connect to. Defaults to `default` if not given.
+
+`--db-uri` *URI*
+: The explicit database URI to connect to
+  (ex: `postgres://user:password@host/db`).
+
+`--db-file` *PATH*
+: The sqlite3 database file to use.
+
+`--sudo`
+: Explicitly run `masscan` under `sudo`. If the option is not given, then
+  `sudo` will automatically be enabled if the *masscan_options* includes a
+  privileged option (ex: `-sS`, `-O`, etc).
+
+`-o`, `--output` *FILE*
+: Sets the output file to save the `masscan` scan results to. May be a `.xml`,
+  `.json`, or `.csv` file.
+
+`-F`, `--output-format` `json`|`csv`
+: Explicitly specify the output format to JSON or CSV. If the option is
+  not given, the output format Will be inferred from the `--output` *FILE* file
+  extension.
+
+`--import`
+: Imports the `masscan` scan results into the Ronin database.
+
+`-h`, `--help`
+: Print help information
+
+## ENVIRONMENT
+
+*HOME*
+: The user's home directory.
+
+*XDG_CONFIG_HOME*
+: Alternate location for the `~/.config` directory.
+
+*XDG_DATA_HOME*
+: Alternate location for the `~/.local/share` directory.
+
+## FILES
+
+`~/.local/share/ronin-db/database.sqlite3`
+: The default sqlite3 database file.
+
+`~/.config/ronin-db/database.yml`
+: Optional database configuration.
+
+## EXAMPLES
+
+Port scans `192.168.1.1` and save the scan results to a JSON file:
+
+    $ ronin-masscan scan -o scan.json -- 192.168.1.1 -p80,443,...
+
+Service scans `192.168.1.1` and saves the scan results to the Ronin database:
+
+    $ ronin-masscan scan --import -- 192.168.1.1 -p80,443,...
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+

data/man/ronin-masscan.1

@@ -0,0 +1,61 @@
+.\" Generated by kramdown-man 1.0.1
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-masscan 1 "2024-01-01" Ronin Masscan "User Manuals"
+.SH NAME
+.PP
+ronin\-masscan \- A CLI for working with masscan
+.SH SYNOPSIS
+.PP
+\fBronin\-masscan\fR \[lB]\fIoptions\fP\[rB] \[lB]\fICOMMAND\fP \[lB]\.\.\.\[rB]\[rB]
+.SH DESCRIPTION
+.PP
+\fBronin\-masscan\fR provides various commands for automating \fBmasscan\fR, parsing
+scan output files, and importing scan data into the database\.
+.SH ARGUMENTS
+.TP
+\fICOMMAND\fP
+The \fBronin\-masscan\fR command to execute\.
+.SH OPTIONS
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print help information
+.SH COMMANDS
+.TP
+\fIcompletion\fP
+Manages the shell completion rules for \fBronin\-masscan\fR\.
+.TP
+\fIconvert\fP
+Converts an masscan scan file to JSON or CSV\.
+.TP
+\fIdump\fP
+Dumps the scanned ports from masscan scan files\.
+.TP
+\fIgrep\fP
+Greps the scanned services from masscan scan file(s)\.
+.TP
+\fIimport\fP
+Imports a masscan scan file into ronin\-db\.
+.TP
+\fInew\fP
+Generates a new masscan Ruby script\.
+.TP
+\fIprint\fP
+Prints the scanned IPs and ports from masscan scan file(s)\.
+.TP
+\fIscan\fP
+Runs masscan and outputs data as JSON or CSV or imports into the database\.
+.SH AUTHOR
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME
+.SH SEE ALSO
+.PP
+.BR ronin\-masscan\-completion (1)
+.BR ronin\-masscan\-convert (1)
+.BR ronin\-masscan\-dump (1)
+.BR ronin\-masscan\-grep (1)
+.BR ronin\-masscan\-import (1)
+.BR ronin\-masscan\-new (1)
+.BR ronin\-masscan\-print (1)
+.BR ronin\-masscan\-scan (1)

data/man/ronin-masscan.1.md

@@ -0,0 +1,58 @@
+# ronin-masscan 1 "2024-01-01" Ronin Masscan "User Manuals"
+
+## NAME
+
+ronin-masscan - A CLI for working with masscan
+
+## SYNOPSIS
+
+`ronin-masscan` [*options*] [*COMMAND* [...]]
+
+## DESCRIPTION
+
+`ronin-masscan` provides various commands for automating `masscan`, parsing
+scan output files, and importing scan data into the database.
+
+## ARGUMENTS
+
+*COMMAND*
+: The `ronin-masscan` command to execute.
+
+## OPTIONS
+
+`-h`, `--help`
+: Print help information
+
+## COMMANDS
+
+*completion*
+: Manages the shell completion rules for `ronin-masscan`.
+
+*convert*
+: Converts an masscan scan file to JSON or CSV.
+
+*dump*
+: Dumps the scanned ports from masscan scan files.
+
+*grep*
+: Greps the scanned services from masscan scan file(s).
+
+*import*
+: Imports a masscan scan file into ronin-db.
+
+*new*
+: Generates a new masscan Ruby script.
+
+*print*
+: Prints the scanned IPs and ports from masscan scan file(s).
+
+*scan*
+: Runs masscan and outputs data as JSON or CSV or imports into the database.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+
+## SEE ALSO
+
+[ronin-masscan-completion](ronin-masscan-completion.1.md) [ronin-masscan-convert](ronin-masscan-convert.1.md) [ronin-masscan-dump](ronin-masscan-dump.1.md) [ronin-masscan-grep](ronin-masscan-grep.1.md) [ronin-masscan-import](ronin-masscan-import.1.md) [ronin-masscan-new](ronin-masscan-new.1.md) [ronin-masscan-print](ronin-masscan-print.1.md) [ronin-masscan-scan](ronin-masscan-scan.1.md)

data/ronin-masscan.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/masscan/version'
+                  Ronin::Masscan::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,161 @@
+#!/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
+}
+
+#
+# Sets os_platform and os_arch.
+#
+function detect_os()
+{
+	os_platform="$(uname -s)"
+	os_arch="$(uname -m)"
+}
+
+#
+# Auto-detect the package manager.
+#
+function detect_package_manager()
+{
+	case "$os_platform" in
+		Linux)
+			if [[ -f /etc/redhat-release ]]; then
+				if   command -v dnf >/dev/null; then
+					package_manager="dnf"
+				elif command -v yum >/dev/null; then
+					package_manager="yum"
+				fi
+			elif [[ -f /etc/debian_version ]]; then
+				if command -v apt-get >/dev/null; then
+					package_manager="apt"
+				fi
+			elif [[ -f /etc/SuSE-release ]]; then
+				if command -v zypper >/dev/null; then
+					package_manager="zypper"
+				fi
+			elif [[ -f /etc/arch-release ]]; then
+				if command -v pacman >/dev/null; then
+					package_manager="pacman"
+				fi
+			elif [[ -f /etc/os-release ]]; then
+				if command -v pacman >/dev/null; then
+					package_manager="pacman"
+				elif command -v zypper >/dev/null; then
+					package_manager="zypper"
+				fi
+			elif [[ "$HOME" == *"com.termux"* ]]; then
+				package_manager="termux"
+			fi
+			;;
+		Darwin)
+			if   command -v brew >/dev/null; then
+				package_manager="brew"
+			elif command -v port >/dev/null; then
+				package_manager="port"
+			fi
+			;;
+		*BSD)
+			if command -v pkg >/dev/null; then
+				package_manager="pkg"
+			fi
+			;;
+	esac
+}
+
+#
+# Detects the system.
+#
+function detect_system()
+{
+	detect_os
+	detect_package_manager
+}
+
+#
+# Installs a list of package names using the detected package manager.
+#
+function install_packages()
+{
+	case "$package_manager" in
+		apt)	$sudo apt-get install -y "$@" || return $? ;;
+		dnf|yum)$sudo $package_manager install -y "$@" || return $?     ;;
+		port)   $sudo port install "$@" || return $?       ;;
+		pkg)	$sudo pkg install -y "$@" || return $?     ;;
+		brew)
+			local brew_owner="$(/usr/bin/stat -f %Su "$(command -v brew)")"
+			sudo -u "$brew_owner" brew install "$@" ||
+			sudo -u "$brew_owner" brew upgrade "$@" || return $?
+			;;
+		pacman)
+			local missing_pkgs=($(pacman -T "$@"))
+
+			if (( ${#missing_pkgs[@]} > 0 )); then
+				$sudo pacman -Sy --noconfirm "${missing_pkgs[@]}" || return $?
+			fi
+			;;
+		zypper) $sudo zypper -n in -l $* || return $? ;;
+		termux)	pkg install -y "$@" || return $? ;;
+		"")	warn "Could not determine Package Manager. Proceeding anyway." ;;
+	esac
+}
+
+if ! command -v masscan >/dev/null; then
+	detect_system
+
+	log "Installing masscan ..."
+	install_packages masscan || warn "Could not install masscan. Proceeding anyways ..."
+fi
+
+# 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,168 @@
+--- !ruby/object:Gem::Specification
+name: ronin-masscan
+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: ruby-masscan
+  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-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: 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-masscan is a Ruby library for working with masscan. ronin-masscan can
+  parse masscan scan files, convert masscan files into JSON or CSV, or import
+  masscan scan data into the ronin-db database.
+email: postmodern.mod3@gmail.com
+executables:
+- ronin-masscan
+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-masscan
+- data/completions/ronin-masscan
+- data/templates/script.rb.erb
+- gemspec.yml
+- lib/ronin/masscan.rb
+- lib/ronin/masscan/cli.rb
+- lib/ronin/masscan/cli/command.rb
+- lib/ronin/masscan/cli/commands/completion.rb
+- lib/ronin/masscan/cli/commands/convert.rb
+- lib/ronin/masscan/cli/commands/dump.rb
+- lib/ronin/masscan/cli/commands/grep.rb
+- lib/ronin/masscan/cli/commands/import.rb
+- lib/ronin/masscan/cli/commands/new.rb
+- lib/ronin/masscan/cli/commands/print.rb
+- lib/ronin/masscan/cli/commands/scan.rb
+- lib/ronin/masscan/cli/filtering_options.rb
+- lib/ronin/masscan/cli/importable.rb
+- lib/ronin/masscan/cli/port_list.rb
+- lib/ronin/masscan/converter.rb
+- lib/ronin/masscan/converters.rb
+- lib/ronin/masscan/converters/csv.rb
+- lib/ronin/masscan/converters/json.rb
+- lib/ronin/masscan/exceptions.rb
+- lib/ronin/masscan/importer.rb
+- lib/ronin/masscan/root.rb
+- lib/ronin/masscan/version.rb
+- man/ronin-masscan-completion.1
+- man/ronin-masscan-completion.1.md
+- man/ronin-masscan-convert.1
+- man/ronin-masscan-convert.1.md
+- man/ronin-masscan-dump.1
+- man/ronin-masscan-dump.1.md
+- man/ronin-masscan-grep.1
+- man/ronin-masscan-grep.1.md
+- man/ronin-masscan-import.1
+- man/ronin-masscan-import.1.md
+- man/ronin-masscan-new.1
+- man/ronin-masscan-new.1.md
+- man/ronin-masscan-print.1
+- man/ronin-masscan-print.1.md
+- man/ronin-masscan-scan.1
+- man/ronin-masscan-scan.1.md
+- man/ronin-masscan.1
+- man/ronin-masscan.1.md
+- ronin-masscan.gemspec
+- scripts/setup
+homepage: https://ronin-rb.dev/
+licenses:
+- LGPL-3.0
+metadata:
+  documentation_uri: https://ronin-rb.dev/docs/ronin-masscan
+  source_code_uri: https://github.com/ronin-rb/ronin-masscan
+  bug_tracker_uri: https://github.com/ronin-rb/ronin-masscan/issues
+  changelog_uri: https://github.com/ronin-rb/ronin-masscan/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.0.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 Ruby library and CLI for working with masscan.
+test_files: []