ronin 2.0.5 → 2.1.0

data/man/ronin.1

@@ -1,55 +1,234 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin 1 "2023-02-01" Ronin "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin \- A Ruby toolkit for security research and development
 .SH SYNOPSIS
-.LP
-.HP
+.PP
 \fBronin\fR \[lB]\fIoptions\fP\[rB] \[lB]\fICOMMAND\fP \[lB]\.\.\.\[rB]\[rB]
-.LP
 .SH DESCRIPTION
-.LP
 .PP
 Runs a Ronin \fICOMMAND\fP\.
-.LP
 .SH ARGUMENTS
-.LP
 .TP
 \fICOMMAND\fP
 The Ronin command to execute\.
-.LP
 .SH OPTIONS
-.LP
 .TP
-\fB-h\fR, \fB--help\fR
+\fB\-V\fR, \fB\-\-version\fR
+Prints the Ronin version and exits\.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
 Print help information
-.LP
 .SH COMMANDS
-.LP
 .TP
-\fIconsole\fP
-Starts ronin\[cq]s interactive ruby console\.
-.LP
+\fIasn\fP
+Queries or searches for ASN information
+.TP
+\fIbanner\-grab\fP
+Fetches the banner from one or more TCP services
+.TP
+\fIbitflip\fP
+Prints every bit\-flip of the given string(s)
+.TP
+\fIbitsquat\fP
+Finds bit\-flips of a domain
+.TP
+\fIcert\-dump\fP
+Prints SSL\[sl]TLS certificate information
+.TP
+\fIcert\-gen\fP
+Generates a new X509 certificate
+.TP
+\fIcert\-grab\fP
+Downloads SSL\[sl]TLS certificates
+.TP
+\fIcompletion\fP
+Manages the shell completion rules for ronin and all other ronin\-* commands
+.TP
+\fIdecode\fP, \fIdec\fP
+Decodes each character of data from a variety of encodings
+.TP
+\fIdecrypt\fP
+Decrypts data
+.TP
+\fIdns\fP
+Performs a variety of DNS queries
+.TP
+\fIdns\-proxy\fP
+Starts a DNS proxy
+.TP
+\fIemail\-addr\fP
+Processes email addresses
+.TP
+\fIencode\fP, \fIenc\fP
+Encodes each character of data into a variety of encodings
+.TP
+\fIencrypt\fP
+Encrypts data
+.TP
+\fIentropy\fP
+Filters lines by their entropy
+.TP
+\fIescape\fP
+Escapes each special character for a variety of encodings
+.TP
+\fIextract\fP
+Extracts common patterns from files\[sl]input
+.TP
+\fIgrep\fP
+Searches files\[sl]input for common patterns
+.TP
+\fIhexdump\fP
+Hexdumps data in a variaty of encodings and formats
+.TP
+\fIhighlight\fP
+Syntax highlights file(s)\.
+.TP
+\fIhmac\fP
+Calculates a Hash\-based Message Authentication Code (HMAC)
+.TP
+\fIhomoglyph\fP
+Generates homoglyph equivalent words
+.TP
+\fIhost\fP
+Processes hostname(s)
+.TP
+\fIhttp\fP
+Send HTTP requests or spawn an interactive HTTP shell
+.TP
+\fIip\fP
+Queries or processes IP addresses
+.TP
+\fIiprange\fP
+Enumerates over IP ranges
+.TP
+\fIirb\fP
+Start ronin\[cq]s interactive Ruby shell
+.TP
+\fImd5\fP
+Calculates MD5 hashes of data
+.TP
+\fInetcat\fP, \fInc\fP
+A netcat clone command
+.TP
+\fInew\fP
+Creates a new Ruby project or a script
+.TP
+\fIpack\fP
+Packs values into binary data
+.TP
+\fIproxy\fP
+Starts a TCP\[sl]UDP\[sl]SSL\[sl]TLS intercept proxy server
+.TP
+\fIpublic\-suffix\-list\fP, \fIpublic\-suffixes\fP
+Updates and parses the public suffix list file
+.TP
+\fIquote\fP
+Produces quoted a string for a variety of programming languages
+.TP
+\fIrot\fP
+Rotates each character of data within an alphabet
+.TP
+\fIsha1\fP
+Calculates SHA1 hashes of data
+.TP
+\fIsha256\fP
+Calculates SHA256 hashes of data
+.TP
+\fIsha512\fP
+Calculates SHA512 hashes
+.TP
+\fIstrings\fP
+Prints all strings within a file\[sl]stream belonging to the given character set
+.TP
+\fItips\fP
+Prints a random tip on how to use ronin
+.TP
+\fItld\-list\fP, \fItlds\fP
+Updates and parses the TLD list file
+.TP
+\fItypo\fP
+Generates typos in words
+.TP
+\fItyposquat\fP
+Finds typo squatted domains
+.TP
+\fIunescape\fP
+Unescapes each escaped character from a variety of encodings
+.TP
+\fIunhexdump\fP
+Decodes a hexdump back into raw data
+.TP
+\fIunpack\fP
+Unpacks binary data
 .TP
-\fIexec\fP
-Executes a script or binary from a ronin repo\.
-.LP
+\fIunquote\fP
+Unquotes a double\[sl]single quoted string
 .TP
-\fIhelp\fP
-Lists available commands or shows help about a specific command\.
-.LP
+\fIurl\fP
+Parses URLs
 .TP
-\fInet\-proxy\fP
-Starts a TCP\[sl]UDP intercept proxy\.
-.LP
+\fIxor\fP
+XORs each character of data with a key\.
 .SH AUTHOR
-.LP
 .PP
 Postmodern 
 .MT postmodern\.mod3\[at]gmail\.com
 .ME
-.LP
 .SH SEE ALSO
-.LP
 .PP
-ronin\-help(1)
+.BR ronin\-help (1)
+.BR ronin\-archive (1)
+.BR ronin\-asn (1)
+.BR ronin\-banner\-grab (1)
+.BR ronin\-bitflip (1)
+.BR ronin\-bitsquat (1)
+.BR ronin\-cert\-dump (1)
+.BR ronin\-cert\-gen (1)
+.BR ronin\-cert\-grab (1)
+.BR ronin\-completion (1)
+.BR ronin\-decode (1)
+.BR ronin\-decrypt (1)
+.BR ronin\-dns (1)
+.BR ronin\-dns\-proxy (1)
+.BR ronin\-email\-addr (1)
+.BR ronin\-encode (1)
+.BR ronin\-encrypt (1)
+.BR ronin\-entropy (1)
+.BR ronin\-escape (1)
+.BR ronin\-extract (1)
+.BR ronin\-grep (1)
+.BR ronin\-hexdump (1)
+.BR ronin\-highlight (1)
+.BR ronin\-hmac (1)
+.BR ronin\-homoglyph (1)
+.BR ronin\-host (1)
+.BR ronin\-http (1)
+.BR ronin\-ip (1)
+.BR ronin\-iprange (1)
+.BR ronin\-irb (1)
+.BR ronin\-md5 (1)
+.BR ronin\-netcat (1)
+.BR ronin\-new (1)
+.BR ronin\-pack (1)
+.BR ronin\-proxy (1)
+.BR ronin\-public\-suffix\-list (1)
+.BR ronin\-quote (1)
+.BR ronin\-rot (1)
+.BR ronin\-sha1 (1)
+.BR ronin\-sha256 (1)
+.BR ronin\-sha512 (1)
+.BR ronin\-strings (1)
+.BR ronin\-tips (1)
+.BR ronin\-tld\-list (1)
+.BR ronin\-typo (1)
+.BR ronin\-typosquat (1)
+.BR ronin\-unarchive (1)
+.BR ronin\-unescape (1)
+.BR ronin\-unhexdump (1)
+.BR ronin\-unpack (1)
+.BR ronin\-unquote (1)
+.BR ronin\-url (1)
+.BR ronin\-xor (1)

data/man/ronin.1.md

@@ -1,5 +1,9 @@
 # ronin 1 "2023-02-01" Ronin "User Manuals"
 
+## NAME
+
+ronin - A Ruby toolkit for security research and development
+
 ## SYNOPSIS
 
 `ronin` [*options*] [*COMMAND* [...]]
@@ -11,26 +15,167 @@ Runs a Ronin *COMMAND*.
 ## ARGUMENTS
 
 *COMMAND*
-	The Ronin command to execute.
+: The Ronin command to execute.
 
 ## OPTIONS
 
+`-V`, `--version`
+: Prints the Ronin version and exits.
+
 `-h`, `--help`
-  Print help information
+: Print help information
 
 ## COMMANDS
 
-*console*
-  Starts ronin's interactive ruby console.
+*asn*
+: Queries or searches for ASN information
+
+*banner-grab*
+: Fetches the banner from one or more TCP services
+
+*bitflip*
+: Prints every bit-flip of the given string(s)
+
+*bitsquat*
+: Finds bit-flips of a domain
+
+*cert-dump*
+: Prints SSL/TLS certificate information
+
+*cert-gen*
+: Generates a new X509 certificate
+
+*cert-grab*
+: Downloads SSL/TLS certificates
+
+*completion*
+: Manages the shell completion rules for ronin and all other ronin-* commands
+
+*decode*, *dec*
+: Decodes each character of data from a variety of encodings
+
+*decrypt*
+: Decrypts data
+
+*dns*
+: Performs a variety of DNS queries
+
+*dns-proxy*
+: Starts a DNS proxy
+
+*email-addr*
+: Processes email addresses
+
+*encode*, *enc*
+: Encodes each character of data into a variety of encodings
+
+*encrypt*
+: Encrypts data
+
+*entropy*
+: Filters lines by their entropy
+
+*escape*
+: Escapes each special character for a variety of encodings
+
+*extract*
+: Extracts common patterns from files/input
+
+*grep*
+: Searches files/input for common patterns
+
+*hexdump*
+: Hexdumps data in a variaty of encodings and formats
+
+*highlight*
+: Syntax highlights file(s).
+
+*hmac*
+: Calculates a Hash-based Message Authentication Code (HMAC)
+
+*homoglyph*
+: Generates homoglyph equivalent words
+
+*host*
+: Processes hostname(s)
+
+*http*
+: Send HTTP requests or spawn an interactive HTTP shell
+
+*ip*
+: Queries or processes IP addresses
+
+*iprange*
+: Enumerates over IP ranges
+
+*irb*
+: Start ronin's interactive Ruby shell
+
+*md5*
+: Calculates MD5 hashes of data
+
+*netcat*, *nc*
+: A netcat clone command
+
+*new*
+: Creates a new Ruby project or a script
+
+*pack*
+: Packs values into binary data
+
+*proxy*
+: Starts a TCP/UDP/SSL/TLS intercept proxy server
+
+*public-suffix-list*, *public-suffixes*
+: Updates and parses the public suffix list file
+
+*quote*
+: Produces quoted a string for a variety of programming languages
+
+*rot*
+: Rotates each character of data within an alphabet
+
+*sha1*
+: Calculates SHA1 hashes of data
+
+*sha256*
+: Calculates SHA256 hashes of data
+
+*sha512*
+: Calculates SHA512 hashes
+
+*strings*
+: Prints all strings within a file/stream belonging to the given character set
+
+*tips*
+: Prints a random tip on how to use ronin
+
+*tld-list*, *tlds*
+: Updates and parses the TLD list file
+
+*typo*
+: Generates typos in words
+
+*typosquat*
+: Finds typo squatted domains
+
+*unescape*
+: Unescapes each escaped character from a variety of encodings
+
+*unhexdump*
+: Decodes a hexdump back into raw data
+
+*unpack*
+: Unpacks binary data
 
-*exec*
-  Executes a script or binary from a ronin repo.
+*unquote*
+: Unquotes a double/single quoted string
 
-*help*
-  Lists available commands or shows help about a specific command.
+*url*
+: Parses URLs
 
-*net-proxy*
-  Starts a TCP/UDP intercept proxy.
+*xor*
+: XORs each character of data with a key.
 
 ## AUTHOR
 
@@ -38,4 +183,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-help(1)
+[ronin-help](ronin-help.1.md) [ronin-archive](ronin-archive.1.md) [ronin-asn](ronin-asn.1.md) [ronin-banner-grab](ronin-banner-grab.1.md) [ronin-bitflip](ronin-bitflip.1.md) [ronin-bitsquat](ronin-bitsquat.1.md) [ronin-cert-dump](ronin-cert-dump.1.md) [ronin-cert-gen](ronin-cert-gen.1.md) [ronin-cert-grab](ronin-cert-grab.1.md) [ronin-completion](ronin-completion.1.md) [ronin-decode](ronin-decode.1.md) [ronin-decrypt](ronin-decrypt.1.md) [ronin-dns](ronin-dns.1.md) [ronin-dns-proxy](ronin-dns-proxy.1.md) [ronin-email-addr](ronin-email-addr.1.md) [ronin-encode](ronin-encode.1.md) [ronin-encrypt](ronin-encrypt.1.md) [ronin-entropy](ronin-entropy.1.md) [ronin-escape](ronin-escape.1.md) [ronin-extract](ronin-extract.1.md) [ronin-grep](ronin-grep.1.md) [ronin-hexdump](ronin-hexdump.1.md) [ronin-highlight](ronin-highlight.1.md) [ronin-hmac](ronin-hmac.1.md) [ronin-homoglyph](ronin-homoglyph.1.md) [ronin-host](ronin-host.1.md) [ronin-http](ronin-http.1.md) [ronin-ip](ronin-ip.1.md) [ronin-iprange](ronin-iprange.1.md) [ronin-irb](ronin-irb.1.md) [ronin-md5](ronin-md5.1.md) [ronin-netcat](ronin-netcat.1.md) [ronin-new](ronin-new.1.md) [ronin-pack](ronin-pack.1.md) [ronin-proxy](ronin-proxy.1.md) [ronin-public-suffix-list](ronin-public-suffix-list.1.md) [ronin-quote](ronin-quote.1.md) [ronin-rot](ronin-rot.1.md) [ronin-sha1](ronin-sha1.1.md) [ronin-sha256](ronin-sha256.1.md) [ronin-sha512](ronin-sha512.1.md) [ronin-strings](ronin-strings.1.md) [ronin-tips](ronin-tips.1.md) [ronin-tld-list](ronin-tld-list.1.md) [ronin-typo](ronin-typo.1.md) [ronin-typosquat](ronin-typosquat.1.md) [ronin-unarchive](ronin-unarchive.1.md) [ronin-unescape](ronin-unescape.1.md) [ronin-unhexdump](ronin-unhexdump.1.md) [ronin-unpack](ronin-unpack.1.md) [ronin-unquote](ronin-unquote.1.md) [ronin-url](ronin-url.1.md) [ronin-xor](ronin-xor.1.md)

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'!"