ronin-exploits 1.0.4 → 1.1.0.rc1

data/man/ronin-exploits-new.1.md

@@ -1,5 +1,9 @@
 # ronin-exploits-new 1 "2023-02-01" Ronin "User Manuals"
 
+## NAME
+
+ronin-exploits-new - Creates a new exploit file
+
 ## SYNOPSIS
 
 `ronin-exploits new` [*options*] *PATH*
@@ -11,58 +15,58 @@ Creates a new exploit file.
 ## ARGUMENTS
 
 *PATH*
-  The path to the exploit file to generate.
+: The path to the exploit file to generate.
 
 ## OPTIONS
 
-`-t`, `--type` `exploit`\|`heap_overflow`\|`stack_overflow`\|`web`\|`open_redirect`\|`lfi`\|`rfi`\|`sqli`\|`ssti`\|`xss`
-  The type for the new exploit.
+`-t`, `--type` `exploit`\|`heap-overflow`\|`stack-overflow`\|`command-injection`\|`web`\|`open-redirect`\|`lfi`\|`rfi`\|`sqli`\|`ssti`\|`xss`
+: The type for the new exploit.
 
 `-a`, `--author` *NAME*
-  The name of the author. Defaults to the configured git author name or the
+: The name of the author. Defaults to the configured git author name or the
   `USERNAME` environment variable.
 
 `-e`, `--author-email` *EMAIL*
-  The email address of the author. Defaults to the configured git author email.
+: The email address of the author. Defaults to the configured git author email.
 
 `-s`, `--summary` *TEXT*
-  One sentence summary for the exploit.
+: One sentence summary for the exploit.
 
 `-d`, `--description` *TEXT*
-  Longer description for the exploit.
+: Longer description for the exploit.
 
 `-I`, `--advisory-id` *ID*
-  Add the advisory ID to the exploit.
+: Add the advisory ID to the exploit.
 
 `-R`, `--reference` *URL*
-  Adds a reference to the exploit.
+: Adds a reference to the exploit.
 
 `-P`, `--has-payload` `payload`\|`asm`\|`shellcode`\|`c`\|`command`\|`shell`\|`powershell`\|`html`\|`javascript`\|`typescript`\|`java`\|`sql`\|`php`\|`nodejs`
-  The payload type the exploit uses.
+: The payload type the exploit uses.
 
-`-N`, `--networking` `remote_tcp`\|`remote_udp`\|`http`
-  The networking mixin to use.
+`-N`, `--networking` `remote-tcp`\|`remote-udp`\|`http`
+: The networking mixin to use.
 
 `-A`, `--arch` `x86`\|`x86-64`\|`amd64`\|`ia64`\|`ppc`\|`ppc64`\|`arm`\|`armbe`\|`arm64`\|`arm64be`\|`mips`\|`mipsle`\|`mips64`\|`mips64le`
-  The architecture to target.
+: The architecture to target.
 
 `-O`, `--os` `linux`\|`macos`\|`windows`\|`freebsd`\|`openbsd`\|`netbsd`
-  The Operating System (OS) to target.
+: The Operating System (OS) to target.
 
 `--os-version` *VERSION*
-  The OS version to target.
+: The OS version to target.
 
 `-S`, `--software` *NAME*
-  The software to target.
+: The software to target.
 
 `-V`, `--software-version` *VERSION*
-  The software version to target.
+: The software version to target.
 
 `-L`, `--loot`
-  Adds the loot mixin.
+: Adds the loot mixin.
 
 `-h`, `--help`
-  Print help information
+: Print help information
 
 ## AUTHOR
 
@@ -70,4 +74,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-exploits-show(1) ronin-exploits-run(1)
+[ronin-exploits-show](ronin-exploits-show.1.md) [ronin-exploits-run](ronin-exploits-run.1.md)

data/man/ronin-exploits-run.1

@@ -1,117 +1,93 @@
-.\" Generated by kramdown-man 0.1.9
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-exploits-run 1 "2023-02-01" Ronin "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-exploits\-run \- Runs an exploit
 .SH SYNOPSIS
-.LP
 .PP
-\fBronin-exploits run\fR \[lB]\fIoptions\fP\[rB] \[lC]\fINAME\fP \[or] \fB--file\fR \fIFILE\fP\[rC]
-.LP
+\fBronin\-exploits run\fR \[lB]\fIoptions\fP\[rB] \[lC]\fINAME\fP \[or] \fB\-\-file\fR \fIFILE\fP\[rC]
 .SH DESCRIPTION
-.LP
 .PP
 Loads and runs an exploit\.
-.LP
 .SH ARGUMENTS
-.LP
 .TP
 \fINAME\fP
 The name of the exploit to load\.
-.LP
 .SH OPTIONS
-.LP
 .TP
-\fB-f\fR, \fB--file\fR \fIFILE\fP
+\fB\-f\fR, \fB\-\-file\fR \fIFILE\fP
 The exploit file to load\.
-.LP
 .TP
-\fB-p\fR, \fB--param\fR \fINAME\fP\[eq]\fIVALUE\fP
+\fB\-p\fR, \fB\-\-param\fR \fINAME\fP\[eq]\fIVALUE\fP
 Sets a param for the exploit\.
-.LP
 .TP
-\fB-D\fR, \fB--dry-run\fR
+\fB\-D\fR, \fB\-\-dry\-run\fR
 Builds the exploit but does not launch it\.
-.LP
 .TP
-\fB--payload-file\fR \fIFILE\fP
+\fB\-T\fR, \fB\-\-test\fR
+Runs only the exploit test\.
+.TP
+\fB\-\-payload\-file\fR \fIFILE\fP
 Load the payload from the given Ruby file\.
-.LP
 .TP
-\fB--read-payload\fR \fIFILE\fP
+\fB\-\-read\-payload\fR \fIFILE\fP
 Reads the payload string from the file\.
-.LP
 .TP
-\fB--payload-string\fR \fISTRING\fP
+\fB\-\-payload\-string\fR \fISTRING\fP
 Uses the raw payload string instead\.
-.LP
 .TP
-\fB-P\fR, \fB--payload\fR \fINAME\fP
+\fB\-P\fR, \fB\-\-payload\fR \fINAME\fP
 The payload to load and use\.
-.LP
 .TP
-\fB--payload-param\fR \fINAME\fP\[eq]\fIVALUE\fP
+\fB\-\-payload\-param\fR \fINAME\fP\[eq]\fIVALUE\fP
 Sets a param in the payload\.
-.LP
 .TP
-\fB--encoder-file\fR \fIFILE\fP
+\fB\-\-encoder\-file\fR \fIFILE\fP
 Load the payload encoder from the Ruby file\.
-.LP
 .TP
-\fB-E\fR, \fB--encoder\fR \fINAME\fP
+\fB\-E\fR, \fB\-\-encoder\fR \fINAME\fP
 Loads the payload encoder by name\.
-.LP
 .TP
-\fB--encoder-param\fR \fIENCODER\fP\.\fINAME\fP\[eq]\fIVALUE\fP
+\fB\-\-encoder\-param\fR \fIENCODER\fP\.\fINAME\fP\[eq]\fIVALUE\fP
 Sets a param for the ENCODER\.
-.LP
 .TP
-\fB-t\fR, \fB--target\fR \fIINDEX\fP
+\fB\-t\fR, \fB\-\-target\fR \fIINDEX\fP
 Selects the target by index\.
-.LP
 .TP
-\fB-A\fR, \fB--target-arch\fR \fBx86\fR\[or]\fBx86-64\fR\[or]\fBamd64\fR\[or]\fBia64\fR\[or]\fBppc\fR\[or]\fBppc64\fR\[or]\fBarm\fR\[or]\fBarmbe\fR\[or]\fBarm64\fR\[or]\fBarm64be\fR\[or]\fBmips\fR\[or]\fBmipsle\fR\[or]\fBmips64\fR\[or]\fBmips64le\fR
+\fB\-A\fR, \fB\-\-target\-arch\fR \fBx86\fR\[or]\fBx86\-64\fR\[or]\fBamd64\fR\[or]\fBia64\fR\[or]\fBppc\fR\[or]\fBppc64\fR\[or]\fBarm\fR\[or]\fBarmbe\fR\[or]\fBarm64\fR\[or]\fBarm64be\fR\[or]\fBmips\fR\[or]\fBmipsle\fR\[or]\fBmips64\fR\[or]\fBmips64le\fR
 Selects the target with the matching arch\.
-.LP
 .TP
-\fB-O\fR, \fB--target-os\fR \fBlinux\fR\[or]\fBmacos\fR\[or]\fBwindows\fR\[or]\fBfreebsd\fR\[or]\fBopenbsd\fR\[or]\fBnetbsd\fR
+\fB\-O\fR, \fB\-\-target\-os\fR \fBlinux\fR\[or]\fBmacos\fR\[or]\fBwindows\fR\[or]\fBfreebsd\fR\[or]\fBopenbsd\fR\[or]\fBnetbsd\fR
 Selects the target with the matching OS\.
-.LP
 .TP
-\fB--target-os-version\fR \fIVERSION\fP
+\fB\-\-target\-os\-version\fR \fIVERSION\fP
 Selects the target with the matching OS version\.
-.LP
 .TP
-\fB-S\fR, \fB--target-software\fR \fINAME\fP
+\fB\-S\fR, \fB\-\-target\-software\fR \fINAME\fP
 Selects the target with the matching software name\.
-.LP
 .TP
-\fB-V\fR, \fB--target-version\fR \fIVERSION\fP
+\fB\-V\fR, \fB\-\-target\-version\fR \fIVERSION\fP
 Selects the target with the matching software version\.
-.LP
 .TP
-\fB-L\fR, \fB--save-loot\fR \fIDIR\fP
+\fB\-L\fR, \fB\-\-save\-loot\fR \fIDIR\fP
 Saves any found loot to the \fIDIR\fP\.
-.LP
 .TP
-\fB-D\fR, \fB--debug\fR
+\fB\-d\fR, \fB\-\-debug\fR
 Enables debugging messages\.
-.LP
 .TP
-\fB--irb\fR
+\fB\-\-irb\fR
 Open an interactive Ruby shell inside the exploit\.
-.LP
 .TP
-\fB-h\fR, \fB--help\fR
+\fB\-h\fR, \fB\-\-help\fR
 Print help information
-.LP
 .SH AUTHOR
-.LP
 .PP
 Postmodern 
 .MT postmodern\.mod3\[at]gmail\.com
 .ME
-.LP
 .SH SEE ALSO
-.LP
 .PP
-ronin\-exploits\-list(1) ronin\-exploits\-show(1) ronin\-exploits\-new(1)
+.BR ronin\-exploits\-list (1)
+.BR ronin\-exploits\-show (1)
+.BR ronin\-exploits\-new (1)

data/man/ronin-exploits-run.1.md

@@ -1,5 +1,9 @@
 # ronin-exploits-run 1 "2023-02-01" Ronin "User Manuals"
 
+## NAME
+
+ronin-exploits-run - Runs an exploit
+
 ## SYNOPSIS
 
 `ronin-exploits run` [*options*] {*NAME* \| `--file` *FILE*}
@@ -11,72 +15,75 @@ Loads and runs an exploit.
 ## ARGUMENTS
 
 *NAME*
-  The name of the exploit to load.
+: The name of the exploit to load.
 
 ## OPTIONS
 
 `-f`, `--file` *FILE*
-  The exploit file to load.
+: The exploit file to load.
 
 `-p`, `--param` *NAME*=*VALUE*
-  Sets a param for the exploit.
+: Sets a param for the exploit.
 
 `-D`, `--dry-run`
-  Builds the exploit but does not launch it.
+: Builds the exploit but does not launch it.
+
+`-T`, `--test`
+: Runs only the exploit test.
 
 `--payload-file` *FILE*
-  Load the payload from the given Ruby file.
+: Load the payload from the given Ruby file.
 
 `--read-payload` *FILE*
-  Reads the payload string from the file.
+: Reads the payload string from the file.
 
 `--payload-string` *STRING*
-  Uses the raw payload string instead.
+: Uses the raw payload string instead.
 
 `-P`, `--payload` *NAME*
-  The payload to load and use.
+: The payload to load and use.
 
 `--payload-param` *NAME*=*VALUE*
-  Sets a param in the payload.
+: Sets a param in the payload.
 
 `--encoder-file` *FILE*
-  Load the payload encoder from the Ruby file.
+: Load the payload encoder from the Ruby file.
 
 `-E`, `--encoder` *NAME*
-  Loads the payload encoder by name.
+: Loads the payload encoder by name.
 
 `--encoder-param` *ENCODER*.*NAME*=*VALUE*
-  Sets a param for the ENCODER.
+: Sets a param for the ENCODER.
 
 `-t`, `--target` *INDEX*
-  Selects the target by index.
+: Selects the target by index.
 
 `-A`, `--target-arch` `x86`\|`x86-64`\|`amd64`\|`ia64`\|`ppc`\|`ppc64`\|`arm`\|`armbe`\|`arm64`\|`arm64be`\|`mips`\|`mipsle`\|`mips64`\|`mips64le`
-  Selects the target with the matching arch.
+: Selects the target with the matching arch.
 
 `-O`, `--target-os` `linux`\|`macos`\|`windows`\|`freebsd`\|`openbsd`\|`netbsd`
-  Selects the target with the matching OS.
+: Selects the target with the matching OS.
 
 `--target-os-version` *VERSION*
-  Selects the target with the matching OS version.
+: Selects the target with the matching OS version.
 
 `-S`, `--target-software` *NAME*
-  Selects the target with the matching software name.
+: Selects the target with the matching software name.
 
 `-V`, `--target-version` *VERSION*
-  Selects the target with the matching software version.
+: Selects the target with the matching software version.
 
 `-L`, `--save-loot` *DIR*
-  Saves any found loot to the *DIR*.
+: Saves any found loot to the *DIR*.
 
-`-D`, `--debug`
-  Enables debugging messages.
+`-d`, `--debug`
+: Enables debugging messages.
 
 `--irb`
-  Open an interactive Ruby shell inside the exploit.
+: Open an interactive Ruby shell inside the exploit.
 
 `-h`, `--help`
-  Print help information
+: Print help information
 
 ## AUTHOR
 
@@ -84,4 +91,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-exploits-list(1) ronin-exploits-show(1) ronin-exploits-new(1)
+[ronin-exploits-list](ronin-exploits-list.1.md) [ronin-exploits-show](ronin-exploits-show.1.md) [ronin-exploits-new](ronin-exploits-new.1.md)

data/man/ronin-exploits-show.1

@@ -1,45 +1,35 @@
-.\" Generated by kramdown-man 0.1.9
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-exploits-show 1 "2023-02-01" Ronin "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-exploits\-show \- Prints information about an exploit
 .SH SYNOPSIS
-.LP
 .PP
-\fBronin-exploits show\fR \[lB]\fIoptions\fP\[rB] \[lC]\fINAME\fP \[or] \-\-file \fIFILE\fP\[rC]
-.LP
+\fBronin\-exploits show\fR \[lB]\fIoptions\fP\[rB] \[lC]\fINAME\fP \[or] \-\-file \fIFILE\fP\[rC]
 .SH DESCRIPTION
-.LP
 .PP
 Prints information about an exploit\.
-.LP
 .SH ARGUMENTS
-.LP
 .TP
 \fINAME\fP
 The name of the exploit to load\.
-.LP
 .SH OPTIONS
-.LP
 .TP
-\fB-v\fR, \fB--verbose\fR
+\fB\-v\fR, \fB\-\-verbose\fR
 Prints additional information about the exploit\.
-.LP
 .TP
-\fB-f\fR, \fB--file\fR \fIFILE\fP
+\fB\-f\fR, \fB\-\-file\fR \fIFILE\fP
 Optionally loads the exploit from the file\.
-.LP
 .TP
-\fB-h\fR, \fB--help\fR
+\fB\-h\fR, \fB\-\-help\fR
 Print help information
-.LP
 .SH AUTHOR
-.LP
 .PP
 Postmodern 
 .MT postmodern\.mod3\[at]gmail\.com
 .ME
-.LP
 .SH SEE ALSO
-.LP
 .PP
-ronin\-exploits\-list(1) ronin\-exploits\-run(1)
+.BR ronin\-exploits\-list (1)
+.BR ronin\-exploits\-run (1)

data/man/ronin-exploits-show.1.md

@@ -1,5 +1,9 @@
 # ronin-exploits-show 1 "2023-02-01" Ronin "User Manuals"
 
+## NAME
+
+ronin-exploits-show - Prints information about an exploit
+
 ## SYNOPSIS
 
 `ronin-exploits show` [*options*] {*NAME* \| --file *FILE*}
@@ -11,18 +15,18 @@ Prints information about an exploit.
 ## ARGUMENTS
 
 *NAME*
-  The name of the exploit to load.
+: The name of the exploit to load.
 
 ## OPTIONS
 
 `-v`, `--verbose`
-  Prints additional information about the exploit.
+: Prints additional information about the exploit.
 
 `-f`, `--file` *FILE*
-  Optionally loads the exploit from the file.
+: Optionally loads the exploit from the file.
 
 `-h`, `--help`
-  Print help information
+: Print help information
 
 ## AUTHOR
 
@@ -30,4 +34,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-exploits-list(1) ronin-exploits-run(1)
+[ronin-exploits-list](ronin-exploits-list.1.md) [ronin-exploits-run](ronin-exploits-run.1.md)

data/man/ronin-exploits.1

@@ -1,55 +1,43 @@
-.\" Generated by kramdown-man 0.1.9
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-exploits 1 "2023-02-01" Ronin "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-exploits \- A Ruby micro\-framework for writing and running exploits and payloads
 .SH SYNOPSIS
-.LP
 .PP
-\fBronin-exploits\fR \[lB]\fIoptions\fP\[rB] \[lB]\fICOMMAND\fP \[lB]\.\.\.\[rB]\[rB]
-.LP
+\fBronin\-exploits\fR \[lB]\fIoptions\fP\[rB] \[lB]\fICOMMAND\fP \[lB]\.\.\.\[rB]\[rB]
 .SH DESCRIPTION
-.LP
 .PP
-Runs a \fBronin-exploits\fR \fICOMMAND\fP\.
-.LP
+Runs a \fBronin\-exploits\fR \fICOMMAND\fP\.
 .SH ARGUMENTS
-.LP
 .TP
 \fICOMMAND\fP
-The \fBronin-exploits\fR command to execute\.
-.LP
+The \fBronin\-exploits\fR command to execute\.
 .SH OPTIONS
-.LP
 .TP
-\fB-h\fR, \fB--help\fR
+\fB\-h\fR, \fB\-\-help\fR
 Print help information
-.LP
 .SH COMMANDS
-.LP
 .TP
 \fBirb\fR
 Starts ronin\-exploits interactive Ruby shell\.
-.LP
 .TP
 \fBlist\fR
 Lists available exploits\.
-.LP
 .TP
 \fBrun\fR
 Runs an exploit\.
-.LP
 .TP
 \fBhelp\fR
 Lists available commands or shows help about a specific command\.
-.LP
 .SH AUTHOR
-.LP
 .PP
 Postmodern 
 .MT postmodern\.mod3\[at]gmail\.com
 .ME
-.LP
 .SH SEE ALSO
-.LP
 .PP
-ronin\-exploits\-console(1) ronin\-exploits\-list(1) ronin\-exploits\-run(1)
+.BR ronin\-exploits\-irb (1)
+.BR ronin\-exploits\-list (1)
+.BR ronin\-exploits\-run (1)

data/man/ronin-exploits.1.md

@@ -1,5 +1,9 @@
 # ronin-exploits 1 "2023-02-01" Ronin "User Manuals"
 
+## NAME
+
+ronin-exploits - A Ruby micro-framework for writing and running exploits and payloads
+
 ## SYNOPSIS
 
 `ronin-exploits` [*options*] [*COMMAND* [...]]
@@ -11,26 +15,26 @@ Runs a `ronin-exploits` *COMMAND*.
 ## ARGUMENTS
 
 *COMMAND*
-	The `ronin-exploits` command to execute.
+: The `ronin-exploits` command to execute.
 
 ## OPTIONS
 
 `-h`, `--help`
-  Print help information
+: Print help information
 
 ## COMMANDS
 
 `irb`
-  Starts ronin-exploits interactive Ruby shell.
+: Starts ronin-exploits interactive Ruby shell.
 
 `list`
-  Lists available exploits.
+: Lists available exploits.
 
 `run`
-  Runs an exploit.
+: Runs an exploit.
 
 `help`
-  Lists available commands or shows help about a specific command.
+: Lists available commands or shows help about a specific command.
 
 ## AUTHOR
 
@@ -38,4 +42,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-exploits-console(1) ronin-exploits-list(1) ronin-exploits-run(1)
+[ronin-exploits-irb](ronin-exploits-irb.1.md) [ronin-exploits-list](ronin-exploits-list.1.md) [ronin-exploits-run](ronin-exploits-run.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'!"