ronin-payloads 0.1.6 → 0.2.0.rc1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (169) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/ruby.yml +1 -1
  3. data/.gitignore +1 -0
  4. data/.rubocop.yml +0 -3
  5. data/ChangeLog.md +41 -3
  6. data/Gemfile +6 -4
  7. data/README.md +26 -6
  8. data/Rakefile +10 -0
  9. data/data/completions/ronin-payloads +127 -0
  10. data/data/completions/ronin-payloads.yml +16 -0
  11. data/gemspec.yml +3 -1
  12. data/lib/ronin/payloads/asm_payload.rb +1 -1
  13. data/lib/ronin/payloads/binary_payload.rb +1 -1
  14. data/lib/ronin/payloads/builtin/bin/unix/reverse_shell.c +61 -0
  15. data/lib/ronin/payloads/builtin/bin/unix/reverse_shell.rb +84 -0
  16. data/lib/ronin/payloads/builtin/bin/windows/reverse_shell.c +63 -0
  17. data/lib/ronin/payloads/builtin/bin/windows/reverse_shell.rb +87 -0
  18. data/lib/ronin/payloads/builtin/cmd/awk/reverse_shell.rb +1 -1
  19. data/lib/ronin/payloads/builtin/cmd/bash/reverse_shell.rb +1 -1
  20. data/lib/ronin/payloads/builtin/cmd/lua/reverse_shell.rb +1 -1
  21. data/lib/ronin/payloads/builtin/cmd/netcat/bind_shell.rb +51 -0
  22. data/lib/ronin/payloads/builtin/cmd/node/reverse_shell.rb +1 -1
  23. data/lib/ronin/payloads/builtin/cmd/openssl/reverse_shell.rb +1 -1
  24. data/lib/ronin/payloads/builtin/cmd/perl/reverse_shell.rb +1 -1
  25. data/lib/ronin/payloads/builtin/cmd/php/reverse_shell.rb +1 -1
  26. data/lib/ronin/payloads/builtin/cmd/ping.rb +52 -0
  27. data/lib/ronin/payloads/builtin/cmd/powershell/reverse_shell.rb +1 -1
  28. data/lib/ronin/payloads/builtin/cmd/python/reverse_shell.rb +1 -1
  29. data/lib/ronin/payloads/builtin/cmd/ruby/reverse_shell.rb +1 -1
  30. data/lib/ronin/payloads/builtin/cmd/sleep.rb +49 -0
  31. data/lib/ronin/payloads/builtin/cmd/touch.rb +49 -0
  32. data/lib/ronin/payloads/builtin/cmd/windows/download.rb +70 -0
  33. data/lib/ronin/payloads/builtin/cmd/zsh/reverse_shell.rb +55 -0
  34. data/lib/ronin/payloads/builtin/groovy/reverse_shell.rb +54 -0
  35. data/lib/ronin/payloads/builtin/java/reverse_shell.rb +1 -1
  36. data/lib/ronin/payloads/builtin/js/nashorn/reverse_shell.rb +63 -0
  37. data/lib/ronin/payloads/builtin/js/node/reverse_shell.rb +55 -0
  38. data/lib/ronin/payloads/builtin/php/cmd_exec.rb +1 -1
  39. data/lib/ronin/payloads/builtin/php/download_exec.php.erb +96 -0
  40. data/lib/ronin/payloads/builtin/php/download_exec.rb +54 -0
  41. data/lib/ronin/payloads/builtin/shellcode/freebsd/x86/bind_shell.rb +2 -3
  42. data/lib/ronin/payloads/builtin/shellcode/freebsd/x86/exec_shell.rb +2 -3
  43. data/lib/ronin/payloads/builtin/shellcode/freebsd/x86/reverse_shell.rb +2 -3
  44. data/lib/ronin/payloads/builtin/shellcode/freebsd/x86_64/exec_shell.rb +2 -3
  45. data/lib/ronin/payloads/builtin/shellcode/linux/arm/bind_shell.rb +2 -3
  46. data/lib/ronin/payloads/builtin/shellcode/linux/arm/exec_shell.rb +2 -3
  47. data/lib/ronin/payloads/builtin/shellcode/linux/arm/reverse_shell.rb +2 -3
  48. data/lib/ronin/payloads/builtin/shellcode/linux/mips/bind_shell.rb +2 -3
  49. data/lib/ronin/payloads/builtin/shellcode/linux/mips/exec_shell.rb +13 -14
  50. data/lib/ronin/payloads/builtin/shellcode/linux/mips/reverse_shell.rb +2 -3
  51. data/lib/ronin/payloads/builtin/shellcode/linux/ppc/exec_shell.rb +15 -16
  52. data/lib/ronin/payloads/builtin/shellcode/linux/ppc/reverse_shell.rb +2 -3
  53. data/lib/ronin/payloads/builtin/shellcode/linux/x86/bind_shell.rb +2 -3
  54. data/lib/ronin/payloads/builtin/shellcode/linux/x86/exec_shell.rb +2 -3
  55. data/lib/ronin/payloads/builtin/shellcode/linux/x86/reverse_shell.rb +2 -3
  56. data/lib/ronin/payloads/builtin/shellcode/linux/x86_64/bind_shell.rb +2 -3
  57. data/lib/ronin/payloads/builtin/shellcode/linux/x86_64/exec_shell.rb +11 -12
  58. data/lib/ronin/payloads/builtin/shellcode/linux/x86_64/reverse_shell.rb +2 -3
  59. data/lib/ronin/payloads/builtin/shellcode/macos/x86_64/exec_shell.rb +2 -3
  60. data/lib/ronin/payloads/builtin/shellcode/macos/x86_64/reverse_shell.rb +2 -3
  61. data/lib/ronin/payloads/builtin/shellcode/netbsd/x86/exec_shell.rb +2 -3
  62. data/lib/ronin/payloads/builtin/shellcode/netbsd/x86/reverse_shell.rb +1 -1
  63. data/lib/ronin/payloads/builtin/shellcode/openbsd/x86/bind_shell.rb +2 -3
  64. data/lib/ronin/payloads/builtin/shellcode/openbsd/x86/exec_shell.rb +13 -14
  65. data/lib/ronin/payloads/builtin/shellcode/windows/x86_64/cmd.rb +21 -22
  66. data/lib/ronin/payloads/builtin/test/cmd.rb +53 -0
  67. data/lib/ronin/payloads/builtin/test/open_redirect.rb +1 -1
  68. data/lib/ronin/payloads/builtin/test/url.rb +53 -0
  69. data/lib/ronin/payloads/builtin/test/xss.rb +1 -1
  70. data/lib/ronin/payloads/c_payload.rb +4 -60
  71. data/lib/ronin/payloads/cli/command.rb +1 -1
  72. data/lib/ronin/payloads/cli/commands/build.rb +3 -3
  73. data/lib/ronin/payloads/cli/commands/completion.rb +64 -0
  74. data/lib/ronin/payloads/cli/commands/encode.rb +1 -1
  75. data/lib/ronin/payloads/cli/commands/encoder.rb +1 -1
  76. data/lib/ronin/payloads/cli/commands/encoders.rb +1 -1
  77. data/lib/ronin/payloads/cli/commands/irb.rb +1 -1
  78. data/lib/ronin/payloads/cli/commands/launch.rb +1 -1
  79. data/lib/ronin/payloads/cli/commands/list.rb +1 -1
  80. data/lib/ronin/payloads/cli/commands/show.rb +44 -1
  81. data/lib/ronin/payloads/cli/encoder_methods.rb +1 -1
  82. data/lib/ronin/payloads/cli/format_option.rb +1 -1
  83. data/lib/ronin/payloads/cli/payload_command.rb +1 -1
  84. data/lib/ronin/payloads/cli/payload_methods.rb +1 -1
  85. data/lib/ronin/payloads/cli/printing.rb +5 -2
  86. data/lib/ronin/payloads/cli/ruby_shell.rb +1 -1
  87. data/lib/ronin/payloads/cli.rb +1 -1
  88. data/lib/ronin/payloads/coldfusion_payload.rb +1 -1
  89. data/lib/ronin/payloads/command_payload.rb +1 -1
  90. data/lib/ronin/payloads/encoders/builtin/html/encode.rb +1 -1
  91. data/lib/ronin/payloads/encoders/builtin/js/encode.rb +1 -1
  92. data/lib/ronin/payloads/encoders/builtin/powershell/encode.rb +1 -1
  93. data/lib/ronin/payloads/encoders/builtin/shell/encode.rb +1 -1
  94. data/lib/ronin/payloads/encoders/builtin/sql/encode.rb +1 -1
  95. data/lib/ronin/payloads/encoders/builtin/xml/encode.rb +1 -1
  96. data/lib/ronin/payloads/encoders/encoder.rb +1 -1
  97. data/lib/ronin/payloads/encoders/exceptions.rb +1 -1
  98. data/lib/ronin/payloads/encoders/html_encoder.rb +1 -1
  99. data/lib/ronin/payloads/encoders/javascript_encoder.rb +1 -1
  100. data/lib/ronin/payloads/encoders/pipeline.rb +1 -1
  101. data/lib/ronin/payloads/encoders/powershell_encoder.rb +1 -1
  102. data/lib/ronin/payloads/encoders/registry.rb +1 -1
  103. data/lib/ronin/payloads/encoders/shell_encoder.rb +1 -1
  104. data/lib/ronin/payloads/encoders/sql_encoder.rb +1 -1
  105. data/lib/ronin/payloads/encoders/xml_encoder.rb +1 -1
  106. data/lib/ronin/payloads/encoders.rb +1 -1
  107. data/lib/ronin/payloads/exceptions.rb +1 -1
  108. data/lib/ronin/payloads/go_payload.rb +6 -2
  109. data/lib/ronin/payloads/groovy_payload.rb +49 -0
  110. data/lib/ronin/payloads/html_payload.rb +1 -1
  111. data/lib/ronin/payloads/java_payload.rb +6 -2
  112. data/lib/ronin/payloads/javascript_payload.rb +1 -1
  113. data/lib/ronin/payloads/jsp_payload.rb +1 -1
  114. data/lib/ronin/payloads/metadata/arch.rb +1 -1
  115. data/lib/ronin/payloads/metadata/os.rb +1 -1
  116. data/lib/ronin/payloads/mixins/binary.rb +1 -1
  117. data/lib/ronin/payloads/mixins/bind_shell.rb +1 -1
  118. data/lib/ronin/payloads/mixins/build_dir.rb +1 -1
  119. data/lib/ronin/payloads/mixins/c_compiler.rb +250 -0
  120. data/lib/ronin/payloads/mixins/erb.rb +1 -1
  121. data/lib/ronin/payloads/mixins/network.rb +1 -1
  122. data/lib/ronin/payloads/mixins/post_ex.rb +1 -1
  123. data/lib/ronin/payloads/mixins/resolve_host.rb +1 -1
  124. data/lib/ronin/payloads/mixins/reverse_shell.rb +3 -1
  125. data/lib/ronin/payloads/mixins/tempfile.rb +1 -1
  126. data/lib/ronin/payloads/mixins/typescript.rb +6 -2
  127. data/lib/ronin/payloads/nashorn_payload.rb +51 -0
  128. data/lib/ronin/payloads/node_js_payload.rb +1 -1
  129. data/lib/ronin/payloads/payload.rb +1 -1
  130. data/lib/ronin/payloads/php_payload.rb +1 -1
  131. data/lib/ronin/payloads/powershell_payload.rb +1 -1
  132. data/lib/ronin/payloads/python_payload.rb +1 -1
  133. data/lib/ronin/payloads/registry.rb +1 -1
  134. data/lib/ronin/payloads/root.rb +1 -1
  135. data/lib/ronin/payloads/ruby_payload.rb +1 -1
  136. data/lib/ronin/payloads/rust_payload.rb +6 -2
  137. data/lib/ronin/payloads/shell_payload.rb +1 -1
  138. data/lib/ronin/payloads/shellcode/bind_shell_payload.rb +1 -1
  139. data/lib/ronin/payloads/shellcode/exec_shell_payload.rb +1 -1
  140. data/lib/ronin/payloads/shellcode/reverse_shell_payload.rb +1 -1
  141. data/lib/ronin/payloads/shellcode_payload.rb +1 -1
  142. data/lib/ronin/payloads/sql_payload.rb +1 -1
  143. data/lib/ronin/payloads/url_payload.rb +1 -1
  144. data/lib/ronin/payloads/version.rb +2 -2
  145. data/lib/ronin/payloads/xml_payload.rb +1 -1
  146. data/lib/ronin/payloads.rb +1 -1
  147. data/man/ronin-payloads-build.1 +16 -30
  148. data/man/ronin-payloads-build.1.md +15 -11
  149. data/man/ronin-payloads-completion.1 +76 -0
  150. data/man/ronin-payloads-completion.1.md +78 -0
  151. data/man/ronin-payloads-encode.1 +12 -24
  152. data/man/ronin-payloads-encode.1.md +11 -7
  153. data/man/ronin-payloads-encoder.1 +9 -18
  154. data/man/ronin-payloads-encoder.1.md +8 -4
  155. data/man/ronin-payloads-encoders.1 +8 -16
  156. data/man/ronin-payloads-encoders.1.md +7 -3
  157. data/man/ronin-payloads-irb.1 +8 -15
  158. data/man/ronin-payloads-irb.1.md +6 -2
  159. data/man/ronin-payloads-launch.1 +11 -20
  160. data/man/ronin-payloads-launch.1.md +9 -5
  161. data/man/ronin-payloads-list.1 +9 -16
  162. data/man/ronin-payloads-list.1.md +7 -3
  163. data/man/ronin-payloads-new.1.md +13 -9
  164. data/man/ronin-payloads-show.1 +11 -20
  165. data/man/ronin-payloads-show.1.md +9 -5
  166. data/man/ronin-payloads.1 +18 -26
  167. data/man/ronin-payloads.1.md +17 -10
  168. data/scripts/setup +58 -0
  169. metadata +30 -4
@@ -1,65 +1,51 @@
1
- .\" Generated by kramdown-man 0.1.9
1
+ .\" Generated by kramdown-man 1.0.1
2
2
  .\" https://github.com/postmodern/kramdown-man#readme
3
3
  .TH ronin-payloads-build 1 "2023-02-01" Ronin "User Manuals"
4
- .LP
4
+ .SH NAME
5
+ .PP
6
+ ronin\-payloads\-build \- Loads and builds a payload
5
7
  .SH SYNOPSIS
6
- .LP
7
8
  .PP
8
- \fBronin-payloads build\fR \[lB]\fIoptions\fP\[rB] \[lC]\fB--file\fR \fIFILE\fP \[or] \fINAME\fP\[rC]
9
- .LP
9
+ \fBronin\-payloads build\fR \[lB]\fIoptions\fP\[rB] \[lC]\fB\-\-file\fR \fIFILE\fP \[or] \fINAME\fP\[rC]
10
10
  .SH DESCRIPTION
11
- .LP
12
11
  .PP
13
12
  Loads and builds a payload\.
14
- .LP
15
13
  .SH ARGUMENTS
16
- .LP
17
14
  .TP
18
15
  \fINAME\fP
19
16
  The name of the payload to load\.
20
- .LP
21
17
  .SH OPTIONS
22
- .LP
23
18
  .TP
24
- \fB-f\fR, \fB--file\fR \fIFILE\fP
19
+ \fB\-f\fR, \fB\-\-file\fR \fIFILE\fP
25
20
  Optionally loads the payload from the file\.
26
- .LP
27
21
  .TP
28
- \fB-F\fR, \fB--format\fR \fBhex\fR\[or]\fBc\fR\[or]\fBshell\fR\[or]\fBpowershell\fR\[or]\fBxml\fR\[or]\fBhtml\fR\[or]\fBjs\fR\[or]\fBruby\fR
22
+ \fB\-F\fR, \fB\-\-format\fR \fBhex\fR\[or]\fBc\fR\[or]\fBshell\fR\[or]\fBpowershell\fR\[or]\fBxml\fR\[or]\fBhtml\fR\[or]\fBjs\fR\[or]\fBruby\fR
29
23
  Formats the built payload for another programming language\.
30
- .LP
31
24
  .TP
32
- \fB-p\fR, \fB--param\fR \fINAME\fP\fB=\fR\fIVALUE\fP
25
+ \fB\-p\fR, \fB\-\-param\fR \fINAME\fP\fB\[eq]\fR\fIVALUE\fP
33
26
  Sets a param for the payload\.
34
- .LP
35
27
  .TP
36
- \fB-o\fR, \fB--output\fR \fIFILE\fP
28
+ \fB\-o\fR, \fB\-\-output\fR \fIFILE\fP
37
29
  Writes the built payload to the given file instead of printing it to stdout\.
38
- .LP
39
30
  .TP
40
- \fB-e\fR, \fB--encoder\fR \fIENCODER\fP
31
+ \fB\-E\fR, \fB\-\-encoder\fR \fIENCODER\fP
41
32
  Adds the encoder to the payload\[cq]s encoder pipeline\.
42
- .LP
43
33
  .TP
44
- \fB--encoder-param\fR \fIENCODER\fP\fB.\fR\fINAME\fP\fB.\fR\fIVALUE\fP
34
+ \fB\-\-encoder\-param\fR \fIENCODER\fP\fB\.\fR\fINAME\fP\fB\.\fR\fIVALUE\fP
45
35
  Sets a param on the given encoder\.
46
- .LP
47
36
  .TP
48
- \fB-D\fR, \fB--debug\fR
37
+ \fB\-D\fR, \fB\-\-debug\fR
49
38
  Enables debugging messages\.
50
- .LP
51
39
  .TP
52
- \fB-h\fR, \fB--help\fR
40
+ \fB\-h\fR, \fB\-\-help\fR
53
41
  Print help information
54
- .LP
55
42
  .SH AUTHOR
56
- .LP
57
43
  .PP
58
44
  Postmodern
59
45
  .MT postmodern\.mod3\[at]gmail\.com
60
46
  .ME
61
- .LP
62
47
  .SH SEE ALSO
63
- .LP
64
48
  .PP
65
- ronin\-payloads\-list(1) ronin\-payloads\-show(1) ronin\-payloads\-launch(1)
49
+ .BR ronin\-payloads\-list (1)
50
+ .BR ronin\-payloads\-show (1)
51
+ .BR ronin\-payloads\-launch (1)
@@ -1,5 +1,9 @@
1
1
  # ronin-payloads-build 1 "2023-02-01" Ronin "User Manuals"
2
2
 
3
+ ## NAME
4
+
5
+ ronin-payloads-build - Loads and builds a payload
6
+
3
7
  ## SYNOPSIS
4
8
 
5
9
  `ronin-payloads build` [*options*] {`--file` *FILE* \| *NAME*}
@@ -11,33 +15,33 @@ Loads and builds a payload.
11
15
  ## ARGUMENTS
12
16
 
13
17
  *NAME*
14
- The name of the payload to load.
18
+ : The name of the payload to load.
15
19
 
16
20
  ## OPTIONS
17
21
 
18
22
  `-f`, `--file` *FILE*
19
- Optionally loads the payload from the file.
23
+ : Optionally loads the payload from the file.
20
24
 
21
25
  `-F`, `--format` `hex`\|`c`\|`shell`\|`powershell`\|`xml`\|`html`\|`js`\|`ruby`
22
- Formats the built payload for another programming language.
26
+ : Formats the built payload for another programming language.
23
27
 
24
28
  `-p`, `--param` *NAME*`=`*VALUE*
25
- Sets a param for the payload.
29
+ : Sets a param for the payload.
26
30
 
27
31
  `-o`, `--output` *FILE*
28
- Writes the built payload to the given file instead of printing it to stdout.
32
+ : Writes the built payload to the given file instead of printing it to stdout.
29
33
 
30
- `-e`, `--encoder` *ENCODER*
31
- Adds the encoder to the payload's encoder pipeline.
34
+ `-E`, `--encoder` *ENCODER*
35
+ : Adds the encoder to the payload's encoder pipeline.
32
36
 
33
37
  `--encoder-param` *ENCODER*`.`*NAME*`.`*VALUE*
34
- Sets a param on the given encoder.
38
+ : Sets a param on the given encoder.
35
39
 
36
40
  `-D`, `--debug`
37
- Enables debugging messages.
41
+ : Enables debugging messages.
38
42
 
39
43
  `-h`, `--help`
40
- Print help information
44
+ : Print help information
41
45
 
42
46
  ## AUTHOR
43
47
 
@@ -45,4 +49,4 @@ Postmodern <postmodern.mod3@gmail.com>
45
49
 
46
50
  ## SEE ALSO
47
51
 
48
- ronin-payloads-list(1) ronin-payloads-show(1) ronin-payloads-launch(1)
52
+ [ronin-payloads-list](ronin-payloads-list.1.md) [ronin-payloads-show](ronin-payloads-show.1.md) [ronin-payloads-launch](ronin-payloads-launch.1.md)
@@ -0,0 +1,76 @@
1
+ .\" Generated by kramdown-man 1.0.1
2
+ .\" https://github.com/postmodern/kramdown-man#readme
3
+ .TH ronin-payloads-completion 1 "2024-01-01" Ronin Payloads "User Manuals"
4
+ .SH NAME
5
+ .PP
6
+ ronin\-payloads\-completion \- Manages shell completion rules for \fBronin\-payloads\fR
7
+ .SH SYNOPSIS
8
+ .PP
9
+ \fBronin\-payloads completion\fR \[lB]\fIoptions\fP\[rB]
10
+ .SH DESCRIPTION
11
+ .PP
12
+ The \fBronin\-payloads completion\fR command can print, install, or uninstall shell
13
+ completion rules for the \fBronin\-payloads\fR command\.
14
+ .PP
15
+ Supports installing completion rules for Bash or Zsh shells\.
16
+ Completion rules for the Fish shell is currently not supported\.
17
+ .SS ZSH SUPPORT
18
+ .PP
19
+ Zsh users will have to add the following lines to their \fB\[ti]\[sl]\.zshrc\fR file in
20
+ order to enable Zsh\[cq]s Bash completion compatibility layer:
21
+ .PP
22
+ .RS 4
23
+ .EX
24
+ autoload \-Uz \[pl]X compinit && compinit
25
+ autoload \-Uz \[pl]X bashcompinit && bashcompinit
26
+ .EE
27
+ .RE
28
+ .SH OPTIONS
29
+ .TP
30
+ \fB\-\-print\fR
31
+ Prints the shell completion file\.
32
+ .TP
33
+ \fB\-\-install\fR
34
+ Installs the shell completion file\.
35
+ .TP
36
+ \fB\-\-uninstall\fR
37
+ Uninstalls the shell completion file\.
38
+ .TP
39
+ \fB\-h\fR, \fB\-\-help\fR
40
+ Prints help information\.
41
+ .SH ENVIRONMENT
42
+ .TP
43
+ \fIPREFIX\fP
44
+ Specifies the root prefix for the file system\.
45
+ .TP
46
+ \fIHOME\fP
47
+ Specifies the home directory of the user\. Ronin will search for the
48
+ \fB\[ti]\[sl]\.cache\[sl]ronin\-payloads\fR cache directory within the home directory\.
49
+ .TP
50
+ \fIXDG\[ru]DATA\[ru]HOME\fP
51
+ Specifies the data directory to use\. Defaults to \fB\[Do]HOME\[sl]\.local\[sl]share\fR\.
52
+ .SH FILES
53
+ .TP
54
+ \fB\[ti]\[sl]\.local\[sl]share\[sl]bash\-completion\[sl]completions\[sl]\fR
55
+ The user\-local installation directory for Bash completion files\.
56
+ .TP
57
+ \fB\[sl]usr\[sl]local\[sl]share\[sl]bash\-completion\[sl]completions\[sl]\fR
58
+ The system\-wide installation directory for Bash completions files\.
59
+ .TP
60
+ \fB\[sl]usr\[sl]local\[sl]share\[sl]zsh\[sl]site\-functions\[sl]\fR
61
+ The installation directory for Zsh completion files\.
62
+ .SH EXAMPLES
63
+ .TP
64
+ \fBronin\-payloads completion \-\-print\fR
65
+ Prints the shell completion rules instead of installing them\.
66
+ .TP
67
+ \fBronin\-payloads completion \-\-install\fR
68
+ Installs the shell completion rules for \fBronin\-payloads\fR\.
69
+ .TP
70
+ \fBronin\-payloads completion \-\-uninstall\fR
71
+ Uninstalls the shell completion rules for \fBronin\-payloads\fR\.
72
+ .SH AUTHOR
73
+ .PP
74
+ Postmodern
75
+ .MT postmodern\.mod3\[at]gmail\.com
76
+ .ME
@@ -0,0 +1,78 @@
1
+ # ronin-payloads-completion 1 "2024-01-01" Ronin Payloads "User Manuals"
2
+
3
+ ## NAME
4
+
5
+ ronin-payloads-completion - Manages shell completion rules for `ronin-payloads`
6
+
7
+ ## SYNOPSIS
8
+
9
+ `ronin-payloads completion` [*options*]
10
+
11
+ ## DESCRIPTION
12
+
13
+ The `ronin-payloads completion` command can print, install, or uninstall shell
14
+ completion rules for the `ronin-payloads` command.
15
+
16
+ Supports installing completion rules for Bash or Zsh shells.
17
+ Completion rules for the Fish shell is currently not supported.
18
+
19
+ ### ZSH SUPPORT
20
+
21
+ Zsh users will have to add the following lines to their `~/.zshrc` file in
22
+ order to enable Zsh's Bash completion compatibility layer:
23
+
24
+ autoload -Uz +X compinit && compinit
25
+ autoload -Uz +X bashcompinit && bashcompinit
26
+
27
+ ## OPTIONS
28
+
29
+ `--print`
30
+ : Prints the shell completion file.
31
+
32
+ `--install`
33
+ : Installs the shell completion file.
34
+
35
+ `--uninstall`
36
+ : Uninstalls the shell completion file.
37
+
38
+ `-h`, `--help`
39
+ : Prints help information.
40
+
41
+ ## ENVIRONMENT
42
+
43
+ *PREFIX*
44
+ : Specifies the root prefix for the file system.
45
+
46
+ *HOME*
47
+ : Specifies the home directory of the user. Ronin will search for the
48
+ `~/.cache/ronin-payloads` cache directory within the home directory.
49
+
50
+ *XDG_DATA_HOME*
51
+ : Specifies the data directory to use. Defaults to `$HOME/.local/share`.
52
+
53
+ ## FILES
54
+
55
+ `~/.local/share/bash-completion/completions/`
56
+ : The user-local installation directory for Bash completion files.
57
+
58
+ `/usr/local/share/bash-completion/completions/`
59
+ : The system-wide installation directory for Bash completions files.
60
+
61
+ `/usr/local/share/zsh/site-functions/`
62
+ : The installation directory for Zsh completion files.
63
+
64
+ ## EXAMPLES
65
+
66
+ `ronin-payloads completion --print`
67
+ : Prints the shell completion rules instead of installing them.
68
+
69
+ `ronin-payloads completion --install`
70
+ : Installs the shell completion rules for `ronin-payloads`.
71
+
72
+ `ronin-payloads completion --uninstall`
73
+ : Uninstalls the shell completion rules for `ronin-payloads`.
74
+
75
+ ## AUTHOR
76
+
77
+ Postmodern <postmodern.mod3@gmail.com>
78
+
@@ -1,53 +1,41 @@
1
- .\" Generated by kramdown-man 0.1.9
1
+ .\" Generated by kramdown-man 1.0.1
2
2
  .\" https://github.com/postmodern/kramdown-man#readme
3
3
  .TH ronin-payloads-encoder 1 "2023-02-01" Ronin "User Manuals"
4
- .LP
4
+ .SH NAME
5
+ .PP
6
+ ronin\-payloads\-encode \- Encodes data using the encoder(s)
5
7
  .SH SYNOPSIS
6
- .LP
7
8
  .PP
8
- \fBronin-payloads encoder\fR \[lB]\fIoptions\fP\[rB] \[lC]\fB--string\fR \fISTRING\fP \[or] \fIFILE\fP\[rC]
9
- .LP
9
+ \fBronin\-payloads encoder\fR \[lB]\fIoptions\fP\[rB] \[lC]\fB\-\-string\fR \fISTRING\fP \[or] \fIFILE\fP\[rC]
10
10
  .SH DESCRIPTION
11
- .LP
12
11
  .PP
13
12
  Encodes data using one or more encoders\.
14
- .LP
15
13
  .SH ARGUMENTS
16
- .LP
17
14
  .TP
18
15
  \fIFILE\fP
19
16
  The optional file to read the data to encode from\.
20
- .LP
21
17
  .SH OPTIONS
22
- .LP
23
18
  .TP
24
- \fB-F\fR, \fB--format\fR \fBhex\fR\[or]\fBc\fR\[or]\fBshell\fR\[or]\fBpowershell\fR\[or]\fBxml\fR\[or]\fBhtml\fR\[or]\fBjs\fR\[or]\fBruby\fR
19
+ \fB\-F\fR, \fB\-\-format\fR \fBhex\fR\[or]\fBc\fR\[or]\fBshell\fR\[or]\fBpowershell\fR\[or]\fBxml\fR\[or]\fBhtml\fR\[or]\fBjs\fR\[or]\fBruby\fR
25
20
  Formats the encoded data\.
26
- .LP
27
21
  .TP
28
- \fB-E\fR, \fB--encoder\fR \fIENCODER\fP
22
+ \fB\-E\fR, \fB\-\-encoder\fR \fIENCODER\fP
29
23
  Loads the encoder with the given name\.
30
- .LP
31
24
  .TP
32
- \fB-p\fR, \fB--param\fR \fIENCODER\fP\fB.\fR\fINAME\fP\fB=\fR\fIVALUE\fP
25
+ \fB\-p\fR, \fB\-\-param\fR \fIENCODER\fP\fB\.\fR\fINAME\fP\fB\[eq]\fR\fIVALUE\fP
33
26
  Sets a param on one of the loaded encoders\.
34
- .LP
35
27
  .TP
36
- \fB-s\fR, \fB--string\fR \fISTRING\fP
28
+ \fB\-s\fR, \fB\-\-string\fR \fISTRING\fP
37
29
  Encodes the given string\.
38
- .LP
39
30
  .TP
40
- \fB-h\fR, \fB--help\fR
31
+ \fB\-h\fR, \fB\-\-help\fR
41
32
  Print help information
42
- .LP
43
33
  .SH AUTHOR
44
- .LP
45
34
  .PP
46
35
  Postmodern
47
36
  .MT postmodern\.mod3\[at]gmail\.com
48
37
  .ME
49
- .LP
50
38
  .SH SEE ALSO
51
- .LP
52
39
  .PP
53
- ronin\-payloads\-encoders(1) ronin\-payloads\-encoder(1)
40
+ .BR ronin\-payloads\-encoders (1)
41
+ .BR ronin\-payloads\-encoder (1)
@@ -1,5 +1,9 @@
1
1
  # ronin-payloads-encoder 1 "2023-02-01" Ronin "User Manuals"
2
2
 
3
+ ## NAME
4
+
5
+ ronin-payloads-encode - Encodes data using the encoder(s)
6
+
3
7
  ## SYNOPSIS
4
8
 
5
9
  `ronin-payloads encoder` [*options*] {`--string` *STRING* \| *FILE*}
@@ -11,24 +15,24 @@ Encodes data using one or more encoders.
11
15
  ## ARGUMENTS
12
16
 
13
17
  *FILE*
14
- The optional file to read the data to encode from.
18
+ : The optional file to read the data to encode from.
15
19
 
16
20
  ## OPTIONS
17
21
 
18
22
  `-F`, `--format` `hex`\|`c`\|`shell`\|`powershell`\|`xml`\|`html`\|`js`\|`ruby`
19
- Formats the encoded data.
23
+ : Formats the encoded data.
20
24
 
21
25
  `-E`, `--encoder` *ENCODER*
22
- Loads the encoder with the given name.
26
+ : Loads the encoder with the given name.
23
27
 
24
28
  `-p`, `--param` *ENCODER*`.`*NAME*`=`*VALUE*
25
- Sets a param on one of the loaded encoders.
29
+ : Sets a param on one of the loaded encoders.
26
30
 
27
31
  `-s`, `--string` *STRING*
28
- Encodes the given string.
32
+ : Encodes the given string.
29
33
 
30
34
  `-h`, `--help`
31
- Print help information
35
+ : Print help information
32
36
 
33
37
  ## AUTHOR
34
38
 
@@ -36,4 +40,4 @@ Postmodern <postmodern.mod3@gmail.com>
36
40
 
37
41
  ## SEE ALSO
38
42
 
39
- ronin-payloads-encoders(1) ronin-payloads-encoder(1)
43
+ [ronin-payloads-encoders](ronin-payloads-encoders.1.md) [ronin-payloads-encoder](ronin-payloads-encoder.1.md)
@@ -1,41 +1,32 @@
1
- .\" Generated by kramdown-man 0.1.9
1
+ .\" Generated by kramdown-man 1.0.1
2
2
  .\" https://github.com/postmodern/kramdown-man#readme
3
3
  .TH ronin-payloads-encoder 1 "2023-02-01" Ronin "User Manuals"
4
- .LP
4
+ .SH NAME
5
+ .PP
6
+ ronin\-payloads\-encoder \- Prints information about an encoder
5
7
  .SH SYNOPSIS
6
- .LP
7
8
  .PP
8
- \fBronin-payloads encoder\fR \[lB]\fIoptions\fP\[rB] \fINAME\fP
9
- .LP
9
+ \fBronin\-payloads encoder\fR \[lB]\fIoptions\fP\[rB] \fINAME\fP
10
10
  .SH DESCRIPTION
11
- .LP
12
11
  .PP
13
12
  Prints information about a particular payload encoder\.
14
- .LP
15
13
  .SH ARGUMENTS
16
- .LP
17
14
  .TP
18
15
  \fINAME\fP
19
16
  The name of the payload encoder to load\.
20
- .LP
21
17
  .SH OPTIONS
22
- .LP
23
18
  .TP
24
- \fB-f\fR, \fB--file\fR \fIFILE\fP
19
+ \fB\-f\fR, \fB\-\-file\fR \fIFILE\fP
25
20
  The optional file to load the payload encoder from\.
26
- .LP
27
21
  .TP
28
- \fB-h\fR, \fB--help\fR
22
+ \fB\-h\fR, \fB\-\-help\fR
29
23
  Print help information
30
- .LP
31
24
  .SH AUTHOR
32
- .LP
33
25
  .PP
34
26
  Postmodern
35
27
  .MT postmodern\.mod3\[at]gmail\.com
36
28
  .ME
37
- .LP
38
29
  .SH SEE ALSO
39
- .LP
40
30
  .PP
41
- ronin\-payloads\-encoders(1) ronin\-payloads\-encode(1)
31
+ .BR ronin\-payloads\-encoders (1)
32
+ .BR ronin\-payloads\-encode (1)
@@ -1,5 +1,9 @@
1
1
  # ronin-payloads-encoder 1 "2023-02-01" Ronin "User Manuals"
2
2
 
3
+ ## NAME
4
+
5
+ ronin-payloads-encoder - Prints information about an encoder
6
+
3
7
  ## SYNOPSIS
4
8
 
5
9
  `ronin-payloads encoder` [*options*] *NAME*
@@ -11,15 +15,15 @@ Prints information about a particular payload encoder.
11
15
  ## ARGUMENTS
12
16
 
13
17
  *NAME*
14
- The name of the payload encoder to load.
18
+ : The name of the payload encoder to load.
15
19
 
16
20
  ## OPTIONS
17
21
 
18
22
  `-f`, `--file` *FILE*
19
- The optional file to load the payload encoder from.
23
+ : The optional file to load the payload encoder from.
20
24
 
21
25
  `-h`, `--help`
22
- Print help information
26
+ : Print help information
23
27
 
24
28
  ## AUTHOR
25
29
 
@@ -27,4 +31,4 @@ Postmodern <postmodern.mod3@gmail.com>
27
31
 
28
32
  ## SEE ALSO
29
33
 
30
- ronin-payloads-encoders(1) ronin-payloads-encode(1)
34
+ [ronin-payloads-encoders](ronin-payloads-encoders.1.md) [ronin-payloads-encode](ronin-payloads-encode.1.md)
@@ -1,37 +1,29 @@
1
- .\" Generated by kramdown-man 0.1.9
1
+ .\" Generated by kramdown-man 1.0.1
2
2
  .\" https://github.com/postmodern/kramdown-man#readme
3
3
  .TH ronin-payloads-encoders 1 "2023-02-01" Ronin "User Manuals"
4
- .LP
4
+ .SH NAME
5
+ .PP
6
+ ronin\-payloads\-encoders \- Lists available anecoders or a specific encoder
5
7
  .SH SYNOPSIS
6
- .LP
7
8
  .PP
8
- \fBronin-payloads encoders\fR \[lB]\fIoptions\fP\[rB] \fIDIR\fP
9
- .LP
9
+ \fBronin\-payloads encoders\fR \[lB]\fIoptions\fP\[rB] \fIDIR\fP
10
10
  .SH DESCRIPTION
11
- .LP
12
11
  .PP
13
12
  Lists available payload encoders\.
14
- .LP
15
13
  .SH ARGUMENTS
16
- .LP
17
14
  .TP
18
15
  \fIDIR\fP
19
16
  The optional directory to list encoders from\.
20
- .LP
21
17
  .SH OPTIONS
22
- .LP
23
18
  .TP
24
- \fB-h\fR, \fB--help\fR
19
+ \fB\-h\fR, \fB\-\-help\fR
25
20
  Print help information
26
- .LP
27
21
  .SH AUTHOR
28
- .LP
29
22
  .PP
30
23
  Postmodern
31
24
  .MT postmodern\.mod3\[at]gmail\.com
32
25
  .ME
33
- .LP
34
26
  .SH SEE ALSO
35
- .LP
36
27
  .PP
37
- ronin\-payloads\-encoder(1) ronin\-payloads\-encode(1)
28
+ .BR ronin\-payloads\-encoder (1)
29
+ .BR ronin\-payloads\-encode (1)
@@ -1,5 +1,9 @@
1
1
  # ronin-payloads-encoders 1 "2023-02-01" Ronin "User Manuals"
2
2
 
3
+ ## NAME
4
+
5
+ ronin-payloads-encoders - Lists available anecoders or a specific encoder
6
+
3
7
  ## SYNOPSIS
4
8
 
5
9
  `ronin-payloads encoders` [*options*] *DIR*
@@ -11,12 +15,12 @@ Lists available payload encoders.
11
15
  ## ARGUMENTS
12
16
 
13
17
  *DIR*
14
- The optional directory to list encoders from.
18
+ : The optional directory to list encoders from.
15
19
 
16
20
  ## OPTIONS
17
21
 
18
22
  `-h`, `--help`
19
- Print help information
23
+ : Print help information
20
24
 
21
25
  ## AUTHOR
22
26
 
@@ -24,4 +28,4 @@ Postmodern <postmodern.mod3@gmail.com>
24
28
 
25
29
  ## SEE ALSO
26
30
 
27
- ronin-payloads-encoder(1) ronin-payloads-encode(1)
31
+ [ronin-payloads-encoder](ronin-payloads-encoder.1.md) [ronin-payloads-encode](ronin-payloads-encode.1.md)
@@ -1,31 +1,24 @@
1
- .\" Generated by kramdown-man 0.1.9
1
+ .\" Generated by kramdown-man 1.0.1
2
2
  .\" https://github.com/postmodern/kramdown-man#readme
3
3
  .TH ronin-payloads-irb 1 "2023-02-01" Ronin "User Manuals"
4
- .LP
4
+ .SH NAME
5
+ .PP
6
+ ronin\-payloads\-irb \- Start an interactive Ruby shell
5
7
  .SH SYNOPSIS
6
- .LP
7
8
  .PP
8
- \fBronin-payloads irb\fR \[lB]\fIoptions\fP\[rB]
9
- .LP
9
+ \fBronin\-payloads irb\fR \[lB]\fIoptions\fP\[rB]
10
10
  .SH DESCRIPTION
11
- .LP
12
11
  .PP
13
- Starts an interactive Ruby shell with \fBronin/payloads\fR loaded\.
14
- .LP
12
+ Starts an interactive Ruby shell with \fBronin\[sl]payloads\fR loaded\.
15
13
  .SH OPTIONS
16
- .LP
17
14
  .TP
18
- \fB-h\fR, \fB--help\fR
15
+ \fB\-h\fR, \fB\-\-help\fR
19
16
  Print help information
20
- .LP
21
17
  .SH AUTHOR
22
- .LP
23
18
  .PP
24
19
  Postmodern
25
20
  .MT postmodern\.mod3\[at]gmail\.com
26
21
  .ME
27
- .LP
28
22
  .SH SEE ALSO
29
- .LP
30
23
  .PP
31
- ronin\-payloads(1)
24
+ .BR ronin\-payloads (1)
@@ -1,5 +1,9 @@
1
1
  # ronin-payloads-irb 1 "2023-02-01" Ronin "User Manuals"
2
2
 
3
+ ## NAME
4
+
5
+ ronin-payloads-irb - Start an interactive Ruby shell
6
+
3
7
  ## SYNOPSIS
4
8
 
5
9
  `ronin-payloads irb` [*options*]
@@ -11,7 +15,7 @@ Starts an interactive Ruby shell with `ronin/payloads` loaded.
11
15
  ## OPTIONS
12
16
 
13
17
  `-h`, `--help`
14
- Print help information
18
+ : Print help information
15
19
 
16
20
  ## AUTHOR
17
21
 
@@ -19,4 +23,4 @@ Postmodern <postmodern.mod3@gmail.com>
19
23
 
20
24
  ## SEE ALSO
21
25
 
22
- ronin-payloads(1)
26
+ [ronin-payloads](ronin-payloads.1.md)
@@ -1,45 +1,36 @@
1
- .\" Generated by kramdown-man 0.1.9
1
+ .\" Generated by kramdown-man 1.0.1
2
2
  .\" https://github.com/postmodern/kramdown-man#readme
3
3
  .TH ronin-payloads-launch 1 "2023-02-01" Ronin "User Manuals"
4
- .LP
4
+ .SH NAME
5
+ .PP
6
+ ronin\-payloads\-launch \- Launches a payload
5
7
  .SH SYNOPSIS
6
- .LP
7
8
  .PP
8
- \fBronin-payloads launch\fR \[lB]\fIoptions\fP\[rB] \[lC]\fB--file\fR \fIFILE\fP \[or] \fINAME\fP\[rC]
9
- .LP
9
+ \fBronin\-payloads launch\fR \[lB]\fIoptions\fP\[rB] \[lC]\fB\-\-file\fR \fIFILE\fP \[or] \fINAME\fP\[rC]
10
10
  .SH DESCRIPTION
11
- .LP
12
11
  .PP
13
12
  Launches a payload\.
14
- .LP
15
13
  .SH ARGUMENTS
16
- .LP
17
14
  .TP
18
15
  \fINAME\fP
19
16
  The name of the payload to load\.
20
- .LP
21
17
  .SH OPTIONS
22
- .LP
23
18
  .TP
24
- \fB-f\fR, \fB--file\fR \fIFILE\fP
19
+ \fB\-f\fR, \fB\-\-file\fR \fIFILE\fP
25
20
  Optionally loads the payload from the file\.
26
- .LP
27
21
  .TP
28
- \fB-D\fR, \fB--debug\fR
22
+ \fB\-D\fR, \fB\-\-debug\fR
29
23
  Enables debugging messages\.
30
- .LP
31
24
  .TP
32
- \fB-h\fR, \fB--help\fR
25
+ \fB\-h\fR, \fB\-\-help\fR
33
26
  Print help information
34
- .LP
35
27
  .SH AUTHOR
36
- .LP
37
28
  .PP
38
29
  Postmodern
39
30
  .MT postmodern\.mod3\[at]gmail\.com
40
31
  .ME
41
- .LP
42
32
  .SH SEE ALSO
43
- .LP
44
33
  .PP
45
- ronin\-payloads\-list(1) ronin\-payloads\-show(1) ronin\-payloads\-build(1)
34
+ .BR ronin\-payloads\-list (1)
35
+ .BR ronin\-payloads\-show (1)
36
+ .BR ronin\-payloads\-build (1)