ronin-payloads 0.1.4 → 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 +4 -3
  3. data/.gitignore +1 -0
  4. data/ChangeLog.md +62 -0
  5. data/Gemfile +6 -4
  6. data/README.md +31 -8
  7. data/Rakefile +10 -0
  8. data/data/completions/ronin-payloads +127 -0
  9. data/data/completions/ronin-payloads.yml +16 -0
  10. data/gemspec.yml +5 -1
  11. data/lib/ronin/payloads/asm_payload.rb +1 -1
  12. data/lib/ronin/payloads/binary_payload.rb +1 -1
  13. data/lib/ronin/payloads/builtin/bin/unix/reverse_shell.c +61 -0
  14. data/lib/ronin/payloads/builtin/bin/unix/reverse_shell.rb +84 -0
  15. data/lib/ronin/payloads/builtin/bin/windows/reverse_shell.c +63 -0
  16. data/lib/ronin/payloads/builtin/bin/windows/reverse_shell.rb +87 -0
  17. data/lib/ronin/payloads/builtin/cmd/awk/reverse_shell.rb +1 -1
  18. data/lib/ronin/payloads/builtin/cmd/bash/reverse_shell.rb +1 -1
  19. data/lib/ronin/payloads/builtin/cmd/lua/reverse_shell.rb +1 -1
  20. data/lib/ronin/payloads/builtin/cmd/netcat/bind_shell.rb +51 -0
  21. data/lib/ronin/payloads/builtin/cmd/node/reverse_shell.rb +2 -2
  22. data/lib/ronin/payloads/builtin/cmd/openssl/reverse_shell.rb +1 -1
  23. data/lib/ronin/payloads/builtin/cmd/perl/reverse_shell.rb +1 -1
  24. data/lib/ronin/payloads/builtin/cmd/php/reverse_shell.rb +1 -1
  25. data/lib/ronin/payloads/builtin/cmd/ping.rb +52 -0
  26. data/lib/ronin/payloads/builtin/cmd/powershell/reverse_shell.rb +1 -1
  27. data/lib/ronin/payloads/builtin/cmd/python/reverse_shell.rb +1 -1
  28. data/lib/ronin/payloads/builtin/cmd/ruby/reverse_shell.rb +1 -1
  29. data/lib/ronin/payloads/builtin/cmd/sleep.rb +49 -0
  30. data/lib/ronin/payloads/builtin/cmd/touch.rb +49 -0
  31. data/lib/ronin/payloads/builtin/cmd/windows/download.rb +70 -0
  32. data/lib/ronin/payloads/builtin/cmd/zsh/reverse_shell.rb +55 -0
  33. data/lib/ronin/payloads/builtin/groovy/reverse_shell.rb +54 -0
  34. data/lib/ronin/payloads/builtin/java/reverse_shell.rb +1 -1
  35. data/lib/ronin/payloads/builtin/js/nashorn/reverse_shell.rb +63 -0
  36. data/lib/ronin/payloads/builtin/js/node/reverse_shell.rb +55 -0
  37. data/lib/ronin/payloads/builtin/php/cmd_exec.rb +1 -1
  38. data/lib/ronin/payloads/builtin/php/download_exec.php.erb +96 -0
  39. data/lib/ronin/payloads/builtin/php/download_exec.rb +54 -0
  40. data/lib/ronin/payloads/builtin/shellcode/freebsd/x86/bind_shell.rb +1 -1
  41. data/lib/ronin/payloads/builtin/shellcode/freebsd/x86/exec_shell.rb +1 -1
  42. data/lib/ronin/payloads/builtin/shellcode/freebsd/x86/reverse_shell.rb +1 -1
  43. data/lib/ronin/payloads/builtin/shellcode/freebsd/x86_64/exec_shell.rb +1 -1
  44. data/lib/ronin/payloads/builtin/shellcode/linux/arm/bind_shell.rb +1 -1
  45. data/lib/ronin/payloads/builtin/shellcode/linux/arm/exec_shell.rb +1 -1
  46. data/lib/ronin/payloads/builtin/shellcode/linux/arm/reverse_shell.rb +1 -1
  47. data/lib/ronin/payloads/builtin/shellcode/linux/mips/bind_shell.rb +1 -1
  48. data/lib/ronin/payloads/builtin/shellcode/linux/mips/exec_shell.rb +1 -1
  49. data/lib/ronin/payloads/builtin/shellcode/linux/mips/reverse_shell.rb +1 -1
  50. data/lib/ronin/payloads/builtin/shellcode/linux/ppc/exec_shell.rb +1 -1
  51. data/lib/ronin/payloads/builtin/shellcode/linux/ppc/reverse_shell.rb +1 -1
  52. data/lib/ronin/payloads/builtin/shellcode/linux/x86/bind_shell.rb +1 -1
  53. data/lib/ronin/payloads/builtin/shellcode/linux/x86/exec_shell.rb +1 -1
  54. data/lib/ronin/payloads/builtin/shellcode/linux/x86/reverse_shell.rb +1 -1
  55. data/lib/ronin/payloads/builtin/shellcode/linux/x86_64/bind_shell.rb +1 -1
  56. data/lib/ronin/payloads/builtin/shellcode/linux/x86_64/exec_shell.rb +1 -1
  57. data/lib/ronin/payloads/builtin/shellcode/linux/x86_64/reverse_shell.rb +1 -1
  58. data/lib/ronin/payloads/builtin/shellcode/macos/x86_64/exec_shell.rb +1 -1
  59. data/lib/ronin/payloads/builtin/shellcode/macos/x86_64/reverse_shell.rb +1 -1
  60. data/lib/ronin/payloads/builtin/shellcode/netbsd/x86/exec_shell.rb +1 -1
  61. data/lib/ronin/payloads/builtin/shellcode/netbsd/x86/reverse_shell.rb +1 -1
  62. data/lib/ronin/payloads/builtin/shellcode/openbsd/x86/bind_shell.rb +1 -1
  63. data/lib/ronin/payloads/builtin/shellcode/openbsd/x86/exec_shell.rb +1 -1
  64. data/lib/ronin/payloads/builtin/shellcode/windows/x86_64/cmd.rb +1 -1
  65. data/lib/ronin/payloads/builtin/test/cmd.rb +53 -0
  66. data/lib/ronin/payloads/builtin/test/open_redirect.rb +1 -1
  67. data/lib/ronin/payloads/builtin/test/url.rb +53 -0
  68. data/lib/ronin/payloads/builtin/test/xss.rb +1 -1
  69. data/lib/ronin/payloads/c_payload.rb +4 -60
  70. data/lib/ronin/payloads/cli/command.rb +1 -1
  71. data/lib/ronin/payloads/cli/commands/build.rb +3 -3
  72. data/lib/ronin/payloads/cli/commands/completion.rb +64 -0
  73. data/lib/ronin/payloads/cli/commands/encode.rb +1 -1
  74. data/lib/ronin/payloads/cli/commands/encoder.rb +1 -1
  75. data/lib/ronin/payloads/cli/commands/encoders.rb +1 -1
  76. data/lib/ronin/payloads/cli/commands/irb.rb +1 -1
  77. data/lib/ronin/payloads/cli/commands/launch.rb +1 -1
  78. data/lib/ronin/payloads/cli/commands/list.rb +1 -1
  79. data/lib/ronin/payloads/cli/commands/new.rb +3 -6
  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 +4 -2
  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 +17 -31
  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 +13 -25
  152. data/man/ronin-payloads-encode.1.md +12 -8
  153. data/man/ronin-payloads-encoder.1 +10 -19
  154. data/man/ronin-payloads-encoder.1.md +8 -4
  155. data/man/ronin-payloads-encoders.1 +9 -17
  156. data/man/ronin-payloads-encoders.1.md +7 -3
  157. data/man/ronin-payloads-irb.1 +9 -16
  158. data/man/ronin-payloads-irb.1.md +6 -2
  159. data/man/ronin-payloads-launch.1 +12 -21
  160. data/man/ronin-payloads-launch.1.md +9 -5
  161. data/man/ronin-payloads-list.1 +10 -17
  162. data/man/ronin-payloads-list.1.md +7 -3
  163. data/man/ronin-payloads-new.1.md +15 -11
  164. data/man/ronin-payloads-show.1 +12 -21
  165. data/man/ronin-payloads-show.1.md +9 -5
  166. data/man/ronin-payloads.1 +19 -27
  167. data/man/ronin-payloads.1.md +17 -10
  168. data/scripts/setup +58 -0
  169. metadata +34 -9
data/man/ronin-payloads-encoders.1 CHANGED
@@ -1,37 +1,29 @@
1
- .\" Generated by kramdown-man 0.1.8
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
- .HP
8
- \fBronin-payloads encoders\fR \[lB]\fIoptions\fP\[rB] \fIDIR\fP
9
- .LP
8
+ .PP
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)
data/man/ronin-payloads-encoders.1.md CHANGED
@@ -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)
data/man/ronin-payloads-irb.1 CHANGED
@@ -1,31 +1,24 @@
1
- .\" Generated by kramdown-man 0.1.8
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
- .HP
8
- \fBronin-payloads irb\fR \[lB]\fIoptions\fP\[rB]
9
- .LP
8
+ .PP
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)
data/man/ronin-payloads-irb.1.md CHANGED
@@ -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)
data/man/ronin-payloads-launch.1 CHANGED
@@ -1,45 +1,36 @@
1
- .\" Generated by kramdown-man 0.1.8
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
- .HP
8
- \fBronin-payloads launch\fR \[lB]\fIoptions\fP\[rB] \[lC]\fB--file\fR \fIFILE\fP \[or] \fINAME\fP\[rC]
9
- .LP
8
+ .PP
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)
data/man/ronin-payloads-launch.1.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # ronin-payloads-launch 1 "2023-02-01" Ronin "User Manuals"
2
2
 
3
+ ## NAME
4
+
5
+ ronin-payloads-launch - Launches a payload
6
+
3
7
  ## SYNOPSIS
4
8
 
5
9
  `ronin-payloads launch` [*options*] {`--file` *FILE* \| *NAME*}
@@ -11,18 +15,18 @@ Launches 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
  `-D`, `--debug`
22
- Enables debugging messages.
26
+ : Enables debugging messages.
23
27
 
24
28
  `-h`, `--help`
25
- Print help information
29
+ : Print help information
26
30
 
27
31
  ## AUTHOR
28
32
 
@@ -30,4 +34,4 @@ Postmodern <postmodern.mod3@gmail.com>
30
34
 
31
35
  ## SEE ALSO
32
36
 
33
- ronin-payloads-list(1) ronin-payloads-show(1) ronin-payloads-build(1)
37
+ [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 CHANGED
@@ -1,37 +1,30 @@
1
- .\" Generated by kramdown-man 0.1.8
1
+ .\" Generated by kramdown-man 1.0.1
2
2
  .\" https://github.com/postmodern/kramdown-man#readme
3
3
  .TH ronin-payloads-list 1 "2023-02-01" Ronin "User Manuals"
4
- .LP
4
+ .SH NAME
5
+ .PP
6
+ ronin\-payloads\-list \- Lists the available payloads
5
7
  .SH SYNOPSIS
6
- .LP
7
- .HP
8
- \fBronin-payloads list\fR \[lB]\fIoptions\fP\[rB] \fIDIR\fP
9
- .LP
8
+ .PP
9
+ \fBronin\-payloads list\fR \[lB]\fIoptions\fP\[rB] \fIDIR\fP
10
10
  .SH DESCRIPTION
11
- .LP
12
11
  .PP
13
12
  Lists available payloads\.
14
- .LP
15
13
  .SH ARGUMENTS
16
- .LP
17
14
  .TP
18
15
  \fIDIR\fP
19
16
  The optional directory to list payloads 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\-show(1) ronin\-payloads\-build(1) ronin\-payloads\-launch(1)
28
+ .BR ronin\-payloads\-show (1)
29
+ .BR ronin\-payloads\-build (1)
30
+ .BR ronin\-payloads\-launch (1)
data/man/ronin-payloads-list.1.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # ronin-payloads-list 1 "2023-02-01" Ronin "User Manuals"
2
2
 
3
+ ## NAME
4
+
5
+ ronin-payloads-list - Lists the available payloads
6
+
3
7
  ## SYNOPSIS
4
8
 
5
9
  `ronin-payloads list` [*options*] *DIR*
@@ -11,12 +15,12 @@ Lists available payloads.
11
15
  ## ARGUMENTS
12
16
 
13
17
  *DIR*
14
- The optional directory to list payloads from.
18
+ : The optional directory to list payloads 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-show(1) ronin-payloads-build(1) ronin-payloads-launch(1)
31
+ [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 CHANGED
@@ -1,8 +1,12 @@
1
1
  # ronin-payloads-new 1 "May 2022" Ronin "User Manuals"
2
2
 
3
+ ## NAME
4
+
5
+ ronin-payloads-new - Creates a new payload file
6
+
3
7
  ## SYNOPSIS
4
8
 
5
- `ronin-payloads new` [*options*] *FILE*
9
+ `ronin-payloads new` [*options*] *PATH*
6
10
 
7
11
  ## DESCRIPTION
8
12
 
@@ -10,32 +14,32 @@ Generates a new payload file.
10
14
 
11
15
  ## ARGUMENTS
12
16
 
13
- *FILE*
14
- The path to the new payload file to generate.
17
+ *PATH*
18
+ : The path to the new payload file to generate.
15
19
 
16
20
  ## OPTIONS
17
21
 
18
22
  `-t`, `--type` `asm`\|`shellcode`\|`c`\|`go`\|`rust`\|`command`\|`shell`\|`powershell`\|`html`\|`javascript`\|`typescript`\|`java`\|`sql`\|`php`\|`python`\|`ruby`\|`nodejs`
19
- The type of payload to generate.
23
+ : The type of payload to generate.
20
24
 
21
25
  `-a`, `--author` *NAME*
22
- The name of the author. Defaults to the configured git author name or the
26
+ : The name of the author. Defaults to the configured git author name or the
23
27
  `USERNAME` environment variable.
24
28
 
25
29
  `-e`, `--author-email` *EMAIL*
26
- The email address of the author. Defaults to the configured git author email.
30
+ : The email address of the author. Defaults to the configured git author email.
27
31
 
28
32
  `-S`, `--summary` *TEXT*
29
- The summary text for the new payload.
33
+ : The summary text for the new payload.
30
34
 
31
35
  `-D`, `--description` *TEXT*
32
- The description text for the new payload.
36
+ : The description text for the new payload.
33
37
 
34
38
  `-R`, `--reference` *URL*
35
- Adds a reference URL to the new payload.
39
+ : Adds a reference URL to the new payload.
36
40
 
37
41
  `-h`, `--help`
38
- Print help information
42
+ : Print help information
39
43
 
40
44
  ## AUTHOR
41
45
 
@@ -43,4 +47,4 @@ Postmodern <postmodern.mod3@gmail.com>
43
47
 
44
48
  ## SEE ALSO
45
49
 
46
- ronin-payloads-list(1) ronin-payloads-show(1) ronin-payloads-build(1) ronin-payloads-launch(1)
50
+ [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 CHANGED
@@ -1,45 +1,36 @@
1
- .\" Generated by kramdown-man 0.1.8
1
+ .\" Generated by kramdown-man 1.0.1
2
2
  .\" https://github.com/postmodern/kramdown-man#readme
3
3
  .TH ronin-payloads-show 1 "May 2022" Ronin "User Manuals"
4
- .LP
4
+ .SH NAME
5
+ .PP
6
+ ronin\-payloads\-show \- Prints information about a payload
5
7
  .SH SYNOPSIS
6
- .LP
7
- .HP
8
- \fBronin-payloads show\fR \[lB]\fIoptions\fP\[rB] \[lC]\fB--file\fR \fIFILE\fP \[or] \fINAME\fP\[rC]
9
- .LP
8
+ .PP
9
+ \fBronin\-payloads show\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
  Prints information about 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-v\fR, \fB--verbose\fR
19
+ \fB\-v\fR, \fB\-\-verbose\fR
25
20
  Prints additional information about the payload\.
26
- .LP
27
21
  .TP
28
- \fB-f\fR, \fB--file\fR \fIFILE\fP
22
+ \fB\-f\fR, \fB\-\-file\fR \fIFILE\fP
29
23
  Optionally loads the payload from the file\.
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\-build(1) ronin\-payloads\-launch(1)
34
+ .BR ronin\-payloads\-list (1)
35
+ .BR ronin\-payloads\-build (1)
36
+ .BR ronin\-payloads\-launch (1)
data/man/ronin-payloads-show.1.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # ronin-payloads-show 1 "May 2022" Ronin "User Manuals"
2
2
 
3
+ ## NAME
4
+
5
+ ronin-payloads-show - Prints information about a payload
6
+
3
7
  ## SYNOPSIS
4
8
 
5
9
  `ronin-payloads show` [*options*] {`--file` *FILE* \| *NAME*}
@@ -11,18 +15,18 @@ Prints information about 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
  `-v`, `--verbose`
19
- Prints additional information about the payload.
23
+ : Prints additional information about the payload.
20
24
 
21
25
  `-f`, `--file` *FILE*
22
- Optionally loads the payload from the file.
26
+ : Optionally loads the payload from the file.
23
27
 
24
28
  `-h`, `--help`
25
- Print help information
29
+ : Print help information
26
30
 
27
31
  ## AUTHOR
28
32
 
@@ -30,4 +34,4 @@ Postmodern <postmodern.mod3@gmail.com>
30
34
 
31
35
  ## SEE ALSO
32
36
 
33
- ronin-payloads-list(1) ronin-payloads-build(1) ronin-payloads-launch(1)
37
+ [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 CHANGED
@@ -1,67 +1,59 @@
1
- .\" Generated by kramdown-man 0.1.8
1
+ .\" Generated by kramdown-man 1.0.1
2
2
  .\" https://github.com/postmodern/kramdown-man#readme
3
3
  .TH ronin-payloads 1 "2023-02-01" Ronin "User Manuals"
4
- .LP
4
+ .SH NAME
5
+ .PP
6
+ ronin\-payloads \- A Ruby micro\-framework for writing and running exploit payloads
5
7
  .SH SYNOPSIS
6
- .LP
7
- .HP
8
- \fBronin-payloads\fR \[lB]\fIoptions\fP\[rB] \[lB]\fICOMMAND\fP \[lB]\.\.\.\[rB]\[rB]
9
- .LP
8
+ .PP
9
+ \fBronin\-payloads\fR \[lB]\fIoptions\fP\[rB] \[lB]\fICOMMAND\fP \[lB]\.\.\.\[rB]\[rB]
10
10
  .SH DESCRIPTION
11
- .LP
12
11
  .PP
13
- Runs a \fBronin-payloads\fR \fICOMMAND\fP\.
14
- .LP
12
+ Runs a \fBronin\-payloads\fR \fICOMMAND\fP\.
15
13
  .SH ARGUMENTS
16
- .LP
17
14
  .TP
18
15
  \fICOMMAND\fP
19
- The \fBronin-payloads\fR command to execute\.
20
- .LP
16
+ The \fBronin\-payloads\fR command to execute\.
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 COMMANDS
28
- .LP
29
22
  .TP
30
23
  \fBbuild\fR
31
24
  Builds a payload\.
32
- .LP
25
+ .TP
26
+ \fBcompletion\fR
27
+ Manages the shell completion rules for \fBronin\-payloads\fR\.
33
28
  .TP
34
29
  \fBencode\fR
35
30
  Encodes a payload with one or more payload encoders\.
36
- .LP
37
31
  .TP
38
32
  \fBencoders\fR
39
33
  Lists available encoders\.
40
- .LP
41
34
  .TP
42
35
  \fBirb\fR
43
36
  Starts ronin\-payload\[cq]s interactive Ruby shell\.
44
- .LP
45
37
  .TP
46
38
  \fBlaunch\fR
47
39
  Launches a payload\.
48
- .LP
49
40
  .TP
50
41
  \fBlist\fR
51
42
  Lists available payloads\.
52
- .LP
53
43
  .TP
54
44
  \fBhelp\fR
55
45
  Lists available commands or shows help about a specific command\.
56
- .LP
57
46
  .SH AUTHOR
58
- .LP
59
47
  .PP
60
48
  Postmodern
61
49
  .MT postmodern\.mod3\[at]gmail\.com
62
50
  .ME
63
- .LP
64
51
  .SH SEE ALSO
65
- .LP
66
52
  .PP
67
- ronin\-payloads\-irb(1) ronin\-payloads\-build(1) ronin\-payloads\-encode(1) ronin\-payloads\-encoders(1) ronin\-payloads\-launch(1) ronin\-payloads\-list(1)
53
+ .BR ronin\-payloads\-irb (1)
54
+ .BR ronin\-payloads\-build (1)
55
+ .BR ronin\-payloads\-completion (1)
56
+ .BR ronin\-payloads\-encode (1)
57
+ .BR ronin\-payloads\-encoders (1)
58
+ .BR ronin\-payloads\-launch (1)
59
+ .BR ronin\-payloads\-list (1)
data/man/ronin-payloads.1.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # ronin-payloads 1 "2023-02-01" Ronin "User Manuals"
2
2
 
3
+ ## NAME
4
+
5
+ ronin-payloads - A Ruby micro-framework for writing and running exploit payloads
6
+
3
7
  ## SYNOPSIS
4
8
 
5
9
  `ronin-payloads` [*options*] [*COMMAND* [...]]
@@ -11,35 +15,38 @@ Runs a `ronin-payloads` *COMMAND*.
11
15
  ## ARGUMENTS
12
16
 
13
17
  *COMMAND*
14
- The `ronin-payloads` command to execute.
18
+ : The `ronin-payloads` command to execute.
15
19
 
16
20
  ## OPTIONS
17
21
 
18
22
  `-h`, `--help`
19
- Print help information
23
+ : Print help information
20
24
 
21
25
  ## COMMANDS
22
26
 
23
27
  `build`
24
- Builds a payload.
28
+ : Builds a payload.
29
+
30
+ `completion`
31
+ : Manages the shell completion rules for `ronin-payloads`.
25
32
 
26
33
  `encode`
27
- Encodes a payload with one or more payload encoders.
34
+ : Encodes a payload with one or more payload encoders.
28
35
 
29
36
  `encoders`
30
- Lists available encoders.
37
+ : Lists available encoders.
31
38
 
32
39
  `irb`
33
- Starts ronin-payload's interactive Ruby shell.
40
+ : Starts ronin-payload's interactive Ruby shell.
34
41
 
35
42
  `launch`
36
- Launches a payload.
43
+ : Launches a payload.
37
44
 
38
45
  `list`
39
- Lists available payloads.
46
+ : Lists available payloads.
40
47
 
41
48
  `help`
42
- Lists available commands or shows help about a specific command.
49
+ : Lists available commands or shows help about a specific command.
43
50
 
44
51
  ## AUTHOR
45
52
 
@@ -47,4 +54,4 @@ Postmodern <postmodern.mod3@gmail.com>
47
54
 
48
55
  ## SEE ALSO
49
56
 
50
- ronin-payloads-irb(1) ronin-payloads-build(1) ronin-payloads-encode(1) ronin-payloads-encoders(1) ronin-payloads-launch(1) ronin-payloads-list(1)
57
+ [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 ADDED
@@ -0,0 +1,58 @@
1
+ #!/usr/bin/env bash
2
+
3
+ #
4
+ # Prints a log message.
5
+ #
6
+ function log()
7
+ {
8
+ if [[ -t 1 ]]; then
9
+ echo -e "\x1b[1m\x1b[32m>>>\x1b[0m \x1b[1m$1\x1b[0m"
10
+ else
11
+ echo ">>> $1"
12
+ fi
13
+ }
14
+
15
+ #
16
+ # Prints a warn message.
17
+ #
18
+ function warn()
19
+ {
20
+ if [[ -t 1 ]]; then
21
+ echo -e "\x1b[1m\x1b[33m***\x1b[0m \x1b[1m$1\x1b[0m" >&2
22
+ else
23
+ echo "*** $1" >&2
24
+ fi
25
+ }
26
+
27
+ #
28
+ # Prints an error message.
29
+ #
30
+ function error()
31
+ {
32
+ if [[ -t 1 ]]; then
33
+ echo -e "\x1b[1m\x1b[31m!!!\x1b[0m \x1b[1m$1\x1b[0m" >&2
34
+ else
35
+ echo "!!! $1" >&2
36
+ fi
37
+ }
38
+
39
+ #
40
+ # Prints an error message and exists with -1.
41
+ #
42
+ function fail()
43
+ {
44
+ error "$@"
45
+ exit -1
46
+ }
47
+
48
+ # default to installing gems into vendor/bundle
49
+ if [[ ! -f .bundle/config ]]; then
50
+ bundle config set --local path vendor/bundle >/dev/null || \
51
+ fail "Failed to run 'bundle config'"
52
+ fi
53
+
54
+ log "Installing gems ..."
55
+ bundle install || fail "Failed to run 'bundle install'!"
56
+
57
+ log "Setting up the project ..."
58
+ bundle exec rake setup || "Failed to run 'rake setup'!"