ronin-payloads 0.1.6 → 0.2.0.rc1

data/man/ronin-payloads-launch.1.md

@@ -1,5 +1,9 @@
 # ronin-payloads-launch 1 "2023-02-01" Ronin "User Manuals"
 
+## NAME
+
+ronin-payloads-launch - Launches a payload
+
 ## SYNOPSIS
 
 `ronin-payloads launch` [*options*] {`--file` *FILE* \| *NAME*}
@@ -11,18 +15,18 @@ Launches a payload.
 ## ARGUMENTS
 
 *NAME*
-  The name of the payload to load.
+: The name of the payload to load.
 
 ## OPTIONS
 
 `-f`, `--file` *FILE*
-  Optionally loads the payload from the file.
+: Optionally loads the payload from the file.
 
 `-D`, `--debug`
-  Enables debugging messages.
+: Enables debugging messages.
 
 `-h`, `--help`
-  Print help information
+: Print help information
 
 ## AUTHOR
 
@@ -30,4 +34,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-payloads-list(1) ronin-payloads-show(1) ronin-payloads-build(1)
+[ronin-payloads-list](ronin-payloads-list.1.md) [ronin-payloads-show](ronin-payloads-show.1.md) [ronin-payloads-build](ronin-payloads-build.1.md)

data/man/ronin-payloads-list.1

@@ -1,37 +1,30 @@
-.\" Generated by kramdown-man 0.1.9
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-payloads-list 1 "2023-02-01" Ronin "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-payloads\-list \- Lists the available payloads
 .SH SYNOPSIS
-.LP
 .PP
-\fBronin-payloads list\fR \[lB]\fIoptions\fP\[rB] \fIDIR\fP
-.LP
+\fBronin\-payloads list\fR \[lB]\fIoptions\fP\[rB] \fIDIR\fP
 .SH DESCRIPTION
-.LP
 .PP
 Lists available payloads\.
-.LP
 .SH ARGUMENTS
-.LP
 .TP
 \fIDIR\fP
 The optional directory to list payloads from\.
-.LP
 .SH OPTIONS
-.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\-payloads\-show(1) ronin\-payloads\-build(1) ronin\-payloads\-launch(1)
+.BR ronin\-payloads\-show (1)
+.BR ronin\-payloads\-build (1)
+.BR ronin\-payloads\-launch (1)

data/man/ronin-payloads-list.1.md

@@ -1,5 +1,9 @@
 # ronin-payloads-list 1 "2023-02-01" Ronin "User Manuals"
 
+## NAME
+
+ronin-payloads-list - Lists the available payloads
+
 ## SYNOPSIS
 
 `ronin-payloads list` [*options*] *DIR*
@@ -11,12 +15,12 @@ Lists available payloads.
 ## ARGUMENTS
 
 *DIR*
-  The optional directory to list payloads from.
+: The optional directory to list payloads from.
 
 ## OPTIONS
 
 `-h`, `--help`
-  Print help information
+: Print help information
 
 ## AUTHOR
 
@@ -24,4 +28,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-payloads-show(1) ronin-payloads-build(1) ronin-payloads-launch(1)
+[ronin-payloads-show](ronin-payloads-show.1.md) [ronin-payloads-build](ronin-payloads-build.1.md) [ronin-payloads-launch](ronin-payloads-launch.1.md)

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

@@ -1,5 +1,9 @@
 # ronin-payloads-new 1 "May 2022" Ronin "User Manuals"
 
+## NAME
+
+ronin-payloads-new - Creates a new payload file
+
 ## SYNOPSIS
 
 `ronin-payloads new` [*options*] *PATH*
@@ -11,31 +15,31 @@ Generates a new payload file.
 ## ARGUMENTS
 
 *PATH*
-  The path to the new payload file to generate.
+: The path to the new payload file to generate.
 
 ## OPTIONS
 
 `-t`, `--type` `asm`\|`shellcode`\|`c`\|`go`\|`rust`\|`command`\|`shell`\|`powershell`\|`html`\|`javascript`\|`typescript`\|`java`\|`sql`\|`php`\|`python`\|`ruby`\|`nodejs`
-  The type of payload to generate.
+: The type of payload to generate.
 
 `-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*
-  The summary text for the new payload.
+: The summary text for the new payload.
 
 `-D`, `--description` *TEXT*
-  The description text for the new payload.
+: The description text for the new payload.
 
 `-R`, `--reference` *URL*
-  Adds a reference URL to the new payload.
+: Adds a reference URL to the new payload.
 
 `-h`, `--help`
-  Print help information
+: Print help information
 
 ## AUTHOR
 
@@ -43,4 +47,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-payloads-list(1) ronin-payloads-show(1) ronin-payloads-build(1) ronin-payloads-launch(1)
+[ronin-payloads-list](ronin-payloads-list.1.md) [ronin-payloads-show](ronin-payloads-show.1.md) [ronin-payloads-build](ronin-payloads-build.1.md) [ronin-payloads-launch](ronin-payloads-launch.1.md)

data/man/ronin-payloads-show.1

@@ -1,45 +1,36 @@
-.\" Generated by kramdown-man 0.1.9
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-payloads-show 1 "May 2022" Ronin "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-payloads\-show \- Prints information about a payload
 .SH SYNOPSIS
-.LP
 .PP
-\fBronin-payloads show\fR \[lB]\fIoptions\fP\[rB] \[lC]\fB--file\fR \fIFILE\fP \[or] \fINAME\fP\[rC]
-.LP
+\fBronin\-payloads show\fR \[lB]\fIoptions\fP\[rB] \[lC]\fB\-\-file\fR \fIFILE\fP \[or] \fINAME\fP\[rC]
 .SH DESCRIPTION
-.LP
 .PP
 Prints information about a payload\.
-.LP
 .SH ARGUMENTS
-.LP
 .TP
 \fINAME\fP
 The name of the payload to load\.
-.LP
 .SH OPTIONS
-.LP
 .TP
-\fB-v\fR, \fB--verbose\fR
+\fB\-v\fR, \fB\-\-verbose\fR
 Prints additional information about the payload\.
-.LP
 .TP
-\fB-f\fR, \fB--file\fR \fIFILE\fP
+\fB\-f\fR, \fB\-\-file\fR \fIFILE\fP
 Optionally loads the payload 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\-payloads\-list(1) ronin\-payloads\-build(1) ronin\-payloads\-launch(1)
+.BR ronin\-payloads\-list (1)
+.BR ronin\-payloads\-build (1)
+.BR ronin\-payloads\-launch (1)

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

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

data/man/ronin-payloads.1

@@ -1,67 +1,59 @@
-.\" Generated by kramdown-man 0.1.9
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-payloads 1 "2023-02-01" Ronin "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-payloads \- A Ruby micro\-framework for writing and running exploit payloads
 .SH SYNOPSIS
-.LP
 .PP
-\fBronin-payloads\fR \[lB]\fIoptions\fP\[rB] \[lB]\fICOMMAND\fP \[lB]\.\.\.\[rB]\[rB]
-.LP
+\fBronin\-payloads\fR \[lB]\fIoptions\fP\[rB] \[lB]\fICOMMAND\fP \[lB]\.\.\.\[rB]\[rB]
 .SH DESCRIPTION
-.LP
 .PP
-Runs a \fBronin-payloads\fR \fICOMMAND\fP\.
-.LP
+Runs a \fBronin\-payloads\fR \fICOMMAND\fP\.
 .SH ARGUMENTS
-.LP
 .TP
 \fICOMMAND\fP
-The \fBronin-payloads\fR command to execute\.
-.LP
+The \fBronin\-payloads\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
 \fBbuild\fR
 Builds a payload\.
-.LP
+.TP
+\fBcompletion\fR
+Manages the shell completion rules for \fBronin\-payloads\fR\.
 .TP
 \fBencode\fR
 Encodes a payload with one or more payload encoders\.
-.LP
 .TP
 \fBencoders\fR
 Lists available encoders\.
-.LP
 .TP
 \fBirb\fR
 Starts ronin\-payload\[cq]s interactive Ruby shell\.
-.LP
 .TP
 \fBlaunch\fR
 Launches a payload\.
-.LP
 .TP
 \fBlist\fR
 Lists available payloads\.
-.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\-payloads\-irb(1) ronin\-payloads\-build(1) ronin\-payloads\-encode(1) ronin\-payloads\-encoders(1) ronin\-payloads\-launch(1) ronin\-payloads\-list(1)
+.BR ronin\-payloads\-irb (1)
+.BR ronin\-payloads\-build (1)
+.BR ronin\-payloads\-completion (1)
+.BR ronin\-payloads\-encode (1)
+.BR ronin\-payloads\-encoders (1)
+.BR ronin\-payloads\-launch (1)
+.BR ronin\-payloads\-list (1)

data/man/ronin-payloads.1.md

@@ -1,5 +1,9 @@
 # ronin-payloads 1 "2023-02-01" Ronin "User Manuals"
 
+## NAME
+
+ronin-payloads - A Ruby micro-framework for writing and running exploit payloads
+
 ## SYNOPSIS
 
 `ronin-payloads` [*options*] [*COMMAND* [...]]
@@ -11,35 +15,38 @@ Runs a `ronin-payloads` *COMMAND*.
 ## ARGUMENTS
 
 *COMMAND*
-	The `ronin-payloads` command to execute.
+: The `ronin-payloads` command to execute.
 
 ## OPTIONS
 
 `-h`, `--help`
-  Print help information
+: Print help information
 
 ## COMMANDS
 
 `build`
-  Builds a payload.
+: Builds a payload.
+
+`completion`
+: Manages the shell completion rules for `ronin-payloads`.
 
 `encode`
-  Encodes a payload with one or more payload encoders.
+: Encodes a payload with one or more payload encoders.
 
 `encoders`
-  Lists available encoders.
+: Lists available encoders.
 
 `irb`
-  Starts ronin-payload's interactive Ruby shell.
+: Starts ronin-payload's interactive Ruby shell.
 
 `launch`
-  Launches a payload.
+: Launches a payload.
 
 `list`
-  Lists available payloads.
+: Lists available payloads.
 
 `help`
-  Lists available commands or shows help about a specific command.
+: Lists available commands or shows help about a specific command.
 
 ## AUTHOR
 
@@ -47,4 +54,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-payloads-irb(1) ronin-payloads-build(1) ronin-payloads-encode(1) ronin-payloads-encoders(1) ronin-payloads-launch(1) ronin-payloads-list(1)
+[ronin-payloads-irb](ronin-payloads-irb.1.md) [ronin-payloads-build](ronin-payloads-build.1.md) [ronin-payloads-completion](ronin-payloads-completion.1.md) [ronin-payloads-encode](ronin-payloads-encode.1.md) [ronin-payloads-encoders](ronin-payloads-encoders.1.md) [ronin-payloads-launch](ronin-payloads-launch.1.md) [ronin-payloads-list](ronin-payloads-list.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'!"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ronin-payloads
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0.rc1
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-03 00:00:00.000000000 Z
+date: 2024-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ronin-support
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.2.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.2.0.rc1
 - !ruby/object:Gem::Dependency
   name: ronin-repos
   requirement: !ruby/object:Gem::Requirement
@@ -119,25 +119,42 @@ files:
 - README.md
 - Rakefile
 - bin/ronin-payloads
+- data/completions/ronin-payloads
+- data/completions/ronin-payloads.yml
 - data/templates/payload.rb.erb
 - examples/bin_sh.rb
 - gemspec.yml
 - lib/ronin/payloads.rb
 - lib/ronin/payloads/asm_payload.rb
 - lib/ronin/payloads/binary_payload.rb
+- lib/ronin/payloads/builtin/bin/unix/reverse_shell.c
+- lib/ronin/payloads/builtin/bin/unix/reverse_shell.rb
+- lib/ronin/payloads/builtin/bin/windows/reverse_shell.c
+- lib/ronin/payloads/builtin/bin/windows/reverse_shell.rb
 - lib/ronin/payloads/builtin/cmd/awk/reverse_shell.rb
 - lib/ronin/payloads/builtin/cmd/bash/reverse_shell.rb
 - lib/ronin/payloads/builtin/cmd/lua/reverse_shell.rb
+- lib/ronin/payloads/builtin/cmd/netcat/bind_shell.rb
 - lib/ronin/payloads/builtin/cmd/node/reverse_shell.rb
 - lib/ronin/payloads/builtin/cmd/openssl/reverse_shell.rb
 - lib/ronin/payloads/builtin/cmd/perl/reverse_shell.rb
 - lib/ronin/payloads/builtin/cmd/php/reverse_shell.rb
+- lib/ronin/payloads/builtin/cmd/ping.rb
 - lib/ronin/payloads/builtin/cmd/powershell/reverse_shell.rb
 - lib/ronin/payloads/builtin/cmd/python/reverse_shell.rb
 - lib/ronin/payloads/builtin/cmd/ruby/reverse_shell.rb
+- lib/ronin/payloads/builtin/cmd/sleep.rb
+- lib/ronin/payloads/builtin/cmd/touch.rb
+- lib/ronin/payloads/builtin/cmd/windows/download.rb
+- lib/ronin/payloads/builtin/cmd/zsh/reverse_shell.rb
+- lib/ronin/payloads/builtin/groovy/reverse_shell.rb
 - lib/ronin/payloads/builtin/java/reverse_shell.rb
 - lib/ronin/payloads/builtin/java/reverse_shell/Payload.java.erb
+- lib/ronin/payloads/builtin/js/nashorn/reverse_shell.rb
+- lib/ronin/payloads/builtin/js/node/reverse_shell.rb
 - lib/ronin/payloads/builtin/php/cmd_exec.rb
+- lib/ronin/payloads/builtin/php/download_exec.php.erb
+- lib/ronin/payloads/builtin/php/download_exec.rb
 - lib/ronin/payloads/builtin/shellcode/freebsd/x86/bind_shell.rb
 - lib/ronin/payloads/builtin/shellcode/freebsd/x86/exec_shell.rb
 - lib/ronin/payloads/builtin/shellcode/freebsd/x86/reverse_shell.rb
@@ -163,12 +180,15 @@ files:
 - lib/ronin/payloads/builtin/shellcode/openbsd/x86/bind_shell.rb
 - lib/ronin/payloads/builtin/shellcode/openbsd/x86/exec_shell.rb
 - lib/ronin/payloads/builtin/shellcode/windows/x86_64/cmd.rb
+- lib/ronin/payloads/builtin/test/cmd.rb
 - lib/ronin/payloads/builtin/test/open_redirect.rb
+- lib/ronin/payloads/builtin/test/url.rb
 - lib/ronin/payloads/builtin/test/xss.rb
 - lib/ronin/payloads/c_payload.rb
 - lib/ronin/payloads/cli.rb
 - lib/ronin/payloads/cli/command.rb
 - lib/ronin/payloads/cli/commands/build.rb
+- lib/ronin/payloads/cli/commands/completion.rb
 - lib/ronin/payloads/cli/commands/encode.rb
 - lib/ronin/payloads/cli/commands/encoder.rb
 - lib/ronin/payloads/cli/commands/encoders.rb
@@ -205,6 +225,7 @@ files:
 - lib/ronin/payloads/encoders/xml_encoder.rb
 - lib/ronin/payloads/exceptions.rb
 - lib/ronin/payloads/go_payload.rb
+- lib/ronin/payloads/groovy_payload.rb
 - lib/ronin/payloads/html_payload.rb
 - lib/ronin/payloads/java_payload.rb
 - lib/ronin/payloads/javascript_payload.rb
@@ -214,6 +235,7 @@ files:
 - lib/ronin/payloads/mixins/binary.rb
 - lib/ronin/payloads/mixins/bind_shell.rb
 - lib/ronin/payloads/mixins/build_dir.rb
+- lib/ronin/payloads/mixins/c_compiler.rb
 - lib/ronin/payloads/mixins/erb.rb
 - lib/ronin/payloads/mixins/network.rb
 - lib/ronin/payloads/mixins/post_ex.rb
@@ -221,6 +243,7 @@ files:
 - lib/ronin/payloads/mixins/reverse_shell.rb
 - lib/ronin/payloads/mixins/tempfile.rb
 - lib/ronin/payloads/mixins/typescript.rb
+- lib/ronin/payloads/nashorn_payload.rb
 - lib/ronin/payloads/node_js_payload.rb
 - lib/ronin/payloads/payload.rb
 - lib/ronin/payloads/php_payload.rb
@@ -241,6 +264,8 @@ files:
 - lib/ronin/payloads/xml_payload.rb
 - man/ronin-payloads-build.1
 - man/ronin-payloads-build.1.md
+- man/ronin-payloads-completion.1
+- man/ronin-payloads-completion.1.md
 - man/ronin-payloads-encode.1
 - man/ronin-payloads-encode.1.md
 - man/ronin-payloads-encoder.1
@@ -259,6 +284,7 @@ files:
 - man/ronin-payloads.1
 - man/ronin-payloads.1.md
 - ronin-payloads.gemspec
+- scripts/setup
 homepage: https://ronin-rb.dev/
 licenses:
 - LGPL-3.0