ronin 1.5.1 → 2.0.0.beta1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (499) hide show
  1. checksums.yaml +4 -4
  2. data/.document +0 -1
  3. data/.github/workflows/ruby.yml +4 -5
  4. data/.gitignore +1 -0
  5. data/.mailmap +1 -0
  6. data/.ruby-version +1 -1
  7. data/.yardopts +0 -2
  8. data/ChangeLog.md +239 -148
  9. data/Gemfile +58 -45
  10. data/README.md +147 -178
  11. data/Rakefile +3 -50
  12. data/bin/ronin +2 -3
  13. data/data/new/project/.gitignore +15 -0
  14. data/data/new/project/.ruby-version.erb +1 -0
  15. data/data/new/project/Dockerfile.erb +9 -0
  16. data/data/new/project/Gemfile.erb +16 -0
  17. data/data/new/project/Rakefile +43 -0
  18. data/data/new/project/project.rb.erb +14 -0
  19. data/data/new/script.rb.erb +6 -0
  20. data/data/tips/cli/console.txt +4 -0
  21. data/data/tips/cli/help.txt +12 -0
  22. data/data/tips/ruby/array_join.txt +5 -0
  23. data/data/tips/ruby/binary_string.txt +4 -0
  24. data/data/tips/ruby/file_binread.txt +4 -0
  25. data/data/tips/ruby/file_each_line.txt +6 -0
  26. data/data/tips/ruby/force_encoding.txt +4 -0
  27. data/data/tips/ruby/integer_binary_format.txt +10 -0
  28. data/data/tips/ruby/integer_chr.txt +5 -0
  29. data/data/tips/ruby/integer_hex_format.txt +10 -0
  30. data/data/tips/ruby/string_bytes.txt +17 -0
  31. data/data/tips/ruby/string_chars.txt +17 -0
  32. data/data/tips/ruby/string_ord.txt +5 -0
  33. data/data/tips/ruby/string_split.txt +13 -0
  34. data/data/tips/scripting/array_pack.txt +5 -0
  35. data/data/tips/scripting/base64_decode.txt +5 -0
  36. data/data/tips/scripting/base64_encode.txt +5 -0
  37. data/data/tips/scripting/build_wordlist.txt +9 -0
  38. data/data/tips/scripting/chars.txt +8 -0
  39. data/data/tips/scripting/chars_strings_in.txt +12 -0
  40. data/data/tips/scripting/dir_traversal.txt +5 -0
  41. data/data/tips/scripting/dns_get_address.txt +5 -0
  42. data/data/tips/scripting/dns_get_addresses.txt +5 -0
  43. data/data/tips/scripting/extract_ips.txt +6 -0
  44. data/data/tips/scripting/file_each_row.txt +6 -0
  45. data/data/tips/scripting/file_hexdump.txt +4 -0
  46. data/data/tips/scripting/float_pack.txt +5 -0
  47. data/data/tips/scripting/ftp_connect.txt +14 -0
  48. data/data/tips/scripting/generate_self_signed_cert.txt +20 -0
  49. data/data/tips/scripting/http_get_body.txt +5 -0
  50. data/data/tips/scripting/http_get_headers.txt +17 -0
  51. data/data/tips/scripting/integer_pack.txt +5 -0
  52. data/data/tips/scripting/ip_range_cidr.txt +6 -0
  53. data/data/tips/scripting/ip_range_glob.txt +6 -0
  54. data/data/tips/scripting/load_cert.txt +5 -0
  55. data/data/tips/scripting/md5.txt +5 -0
  56. data/data/tips/scripting/printing_messages.txt +11 -0
  57. data/data/tips/scripting/random_alpha.txt +5 -0
  58. data/data/tips/scripting/random_alpha_numeric.txt +5 -0
  59. data/data/tips/scripting/random_hex.txt +5 -0
  60. data/data/tips/scripting/read_wordlist.txt +7 -0
  61. data/data/tips/scripting/ronin_support.txt +5 -0
  62. data/data/tips/scripting/sha1.txt +5 -0
  63. data/data/tips/scripting/sha256.txt +5 -0
  64. data/data/tips/scripting/sha512.txt +5 -0
  65. data/data/tips/scripting/ssl_cert.txt +10 -0
  66. data/data/tips/scripting/ssl_socket.txt +12 -0
  67. data/data/tips/scripting/string_hexdump.txt +5 -0
  68. data/data/tips/scripting/string_random_case.txt +5 -0
  69. data/data/tips/scripting/string_unpack.txt +5 -0
  70. data/data/tips/scripting/tcp_accept.txt +6 -0
  71. data/data/tips/scripting/tcp_banner.txt +5 -0
  72. data/data/tips/scripting/tcp_connect.txt +12 -0
  73. data/data/tips/scripting/tcp_open.txt +5 -0
  74. data/data/tips/scripting/tcp_send.txt +5 -0
  75. data/data/tips/scripting/tcp_server_loop.txt +6 -0
  76. data/data/tips/scripting/try.txt +4 -0
  77. data/data/tips/scripting/udp_connect.txt +8 -0
  78. data/data/tips/scripting/udp_open.txt +5 -0
  79. data/data/tips/scripting/udp_recv.txt +7 -0
  80. data/data/tips/scripting/udp_send.txt +5 -0
  81. data/data/tips/scripting/udp_server_loop.txt +7 -0
  82. data/data/tips/scripting/unix_accept.txt +7 -0
  83. data/data/tips/scripting/unix_connect.txt +12 -0
  84. data/data/tips/scripting/zlib_deflate.txt +5 -0
  85. data/data/tips/scripting/zlib_inflate.txt +5 -0
  86. data/gemspec.yml +73 -57
  87. data/lib/ronin/cli/char_set_options.rb +181 -0
  88. data/lib/ronin/cli/cipher_command.rb +149 -0
  89. data/lib/ronin/{script/exceptions/build_failed.rb → cli/command.rb} +11 -6
  90. data/lib/ronin/cli/commands/asn.rb +284 -0
  91. data/lib/ronin/cli/commands/banner_grab.rb +84 -0
  92. data/lib/ronin/cli/commands/bitflip.rb +132 -0
  93. data/lib/ronin/cli/commands/cert_dump.rb +285 -0
  94. data/lib/ronin/cli/commands/cert_gen.rb +395 -0
  95. data/lib/ronin/cli/commands/cert_grab.rb +128 -0
  96. data/lib/ronin/cli/commands/decode.rb +143 -0
  97. data/lib/ronin/cli/commands/decrypt.rb +67 -0
  98. data/lib/ronin/cli/commands/dns.rb +183 -0
  99. data/lib/ronin/cli/commands/email_addr.rb +127 -0
  100. data/lib/ronin/cli/commands/encode.rb +143 -0
  101. data/lib/ronin/cli/commands/encrypt.rb +67 -0
  102. data/lib/ronin/cli/commands/entropy.rb +75 -0
  103. data/lib/ronin/cli/commands/escape.rb +121 -0
  104. data/lib/ronin/cli/commands/extract.rb +138 -0
  105. data/lib/ronin/cli/commands/grep.rb +238 -0
  106. data/lib/ronin/cli/commands/hexdump.rb +475 -0
  107. data/lib/ronin/cli/commands/highlight.rb +121 -0
  108. data/lib/ronin/cli/commands/hmac.rb +102 -0
  109. data/lib/ronin/cli/commands/homoglyph.rb +98 -0
  110. data/lib/ronin/cli/commands/host.rb +305 -0
  111. data/lib/ronin/cli/commands/http.rb +354 -0
  112. data/lib/ronin/cli/commands/ip.rb +242 -0
  113. data/lib/ronin/cli/commands/iprange.rb +138 -0
  114. data/lib/ronin/cli/commands/irb.rb +106 -0
  115. data/lib/ronin/cli/commands/md5.rb +67 -0
  116. data/lib/ronin/cli/commands/netcat.rb +419 -0
  117. data/lib/ronin/cli/commands/new/project.rb +119 -0
  118. data/lib/ronin/cli/commands/new/script.rb +68 -0
  119. data/lib/ronin/cli/commands/new.rb +65 -0
  120. data/lib/ronin/cli/commands/proxy.rb +519 -0
  121. data/lib/ronin/cli/commands/public_suffix_list.rb +118 -0
  122. data/lib/ronin/cli/commands/quote.rb +114 -0
  123. data/lib/ronin/cli/commands/rot.rb +114 -0
  124. data/lib/ronin/cli/commands/sha1.rb +58 -0
  125. data/lib/ronin/cli/commands/sha256.rb +67 -0
  126. data/lib/ronin/cli/commands/sha512.rb +67 -0
  127. data/lib/ronin/cli/commands/strings.rb +151 -0
  128. data/lib/ronin/cli/commands/tips.rb +190 -0
  129. data/lib/ronin/cli/commands/tld_list.rb +118 -0
  130. data/lib/ronin/cli/commands/typo.rb +80 -0
  131. data/lib/ronin/cli/commands/typosquat.rb +123 -0
  132. data/lib/ronin/cli/commands/unescape.rb +121 -0
  133. data/lib/ronin/cli/commands/unhexdump.rb +213 -0
  134. data/lib/ronin/cli/commands/unquote.rb +114 -0
  135. data/lib/ronin/cli/commands/url.rb +151 -0
  136. data/lib/ronin/cli/commands/xor.rb +91 -0
  137. data/lib/ronin/cli/file_processor_command.rb +94 -0
  138. data/lib/ronin/cli/http_shell.rb +362 -0
  139. data/lib/ronin/cli/key_options.rb +61 -0
  140. data/lib/ronin/cli/method_options.rb +71 -0
  141. data/lib/ronin/cli/pattern_options.rb +343 -0
  142. data/lib/ronin/cli/printing/http.rb +153 -0
  143. data/lib/ronin/cli/printing/syntax_highlighting.rb +96 -0
  144. data/lib/ronin/{ui/cli/commands.rb → cli/string_methods_command.rb} +23 -12
  145. data/lib/ronin/cli/string_processor_command.rb +185 -0
  146. data/lib/ronin/cli/typo_options.rb +80 -0
  147. data/lib/ronin/cli/value_processor_command.rb +97 -0
  148. data/lib/ronin/cli.rb +70 -0
  149. data/lib/ronin/config.rb +2 -10
  150. data/lib/ronin/{database/exceptions/invalid_config.rb → root.rb} +6 -7
  151. data/lib/ronin/ui.rb +4 -4
  152. data/lib/ronin/version.rb +3 -4
  153. data/lib/ronin.rb +9 -5
  154. data/man/ronin-asn.1 +124 -0
  155. data/man/ronin-asn.1.md +86 -0
  156. data/man/ronin-banner-grab.1 +45 -0
  157. data/man/ronin-banner-grab.1.md +33 -0
  158. data/man/ronin-bitflip.1 +123 -0
  159. data/man/ronin-bitflip.1.md +92 -0
  160. data/man/ronin-cert-dump.1 +99 -0
  161. data/man/ronin-cert-dump.1.md +68 -0
  162. data/man/ronin-cert-gen.1 +144 -0
  163. data/man/ronin-cert-gen.1.md +104 -0
  164. data/man/ronin-cert-grab.1 +68 -0
  165. data/man/ronin-cert-grab.1.md +47 -0
  166. data/man/ronin-decode.1 +103 -0
  167. data/man/ronin-decode.1.md +77 -0
  168. data/man/ronin-decrypt.1 +75 -0
  169. data/man/ronin-decrypt.1.md +56 -0
  170. data/man/ronin-dns.1 +45 -0
  171. data/man/ronin-dns.1.md +33 -0
  172. data/man/ronin-email-addr.1 +76 -0
  173. data/man/ronin-email-addr.1.md +54 -0
  174. data/man/ronin-encode.1 +103 -0
  175. data/man/ronin-encode.1.md +77 -0
  176. data/man/ronin-encrypt.1 +75 -0
  177. data/man/ronin-encrypt.1.md +56 -0
  178. data/man/ronin-entropy.1 +43 -0
  179. data/man/ronin-entropy.1.md +32 -0
  180. data/man/ronin-escape.1 +94 -0
  181. data/man/ronin-escape.1.md +70 -0
  182. data/man/ronin-extract.1 +263 -0
  183. data/man/ronin-extract.1.md +197 -0
  184. data/man/ronin-grep.1 +275 -0
  185. data/man/ronin-grep.1.md +206 -0
  186. data/man/ronin-help.1 +3 -15
  187. data/man/ronin-help.1.md +3 -12
  188. data/man/ronin-hexdump.1 +323 -0
  189. data/man/ronin-hexdump.1.md +197 -0
  190. data/man/ronin-highlight.1 +42 -0
  191. data/man/ronin-highlight.1.md +31 -0
  192. data/man/ronin-hmac.1 +66 -0
  193. data/man/ronin-hmac.1.md +49 -0
  194. data/man/ronin-homoglyph.1 +49 -0
  195. data/man/ronin-homoglyph.1.md +36 -0
  196. data/man/ronin-host.1 +99 -0
  197. data/man/ronin-host.1.md +74 -0
  198. data/man/ronin-http.1 +141 -0
  199. data/man/ronin-http.1.md +105 -0
  200. data/man/ronin-ip.1 +145 -0
  201. data/man/ronin-ip.1.md +103 -0
  202. data/man/ronin-iprange.1 +46 -0
  203. data/man/ronin-iprange.1.md +34 -0
  204. data/man/ronin-irb.1 +35 -0
  205. data/man/ronin-irb.1.md +25 -0
  206. data/man/ronin-md5.1 +54 -0
  207. data/man/ronin-md5.1.md +40 -0
  208. data/man/ronin-netcat.1 +110 -0
  209. data/man/ronin-netcat.1.md +82 -0
  210. data/man/ronin-new-project.1 +54 -0
  211. data/man/ronin-new-project.1.md +40 -0
  212. data/man/ronin-new-script.1 +37 -0
  213. data/man/ronin-new-script.1.md +27 -0
  214. data/man/ronin-new.1 +51 -0
  215. data/man/ronin-new.1.md +38 -0
  216. data/man/{ronin-net-proxy.1 → ronin-proxy.1} +45 -37
  217. data/man/{ronin-net-proxy.1.md → ronin-proxy.1.md} +39 -32
  218. data/man/ronin-public-suffix-list.1 +55 -0
  219. data/man/ronin-public-suffix-list.1.md +41 -0
  220. data/man/ronin-quote.1 +78 -0
  221. data/man/ronin-quote.1.md +58 -0
  222. data/man/ronin-rot.1 +62 -0
  223. data/man/ronin-rot.1.md +46 -0
  224. data/man/ronin-sha1.1 +54 -0
  225. data/man/ronin-sha1.1.md +40 -0
  226. data/man/ronin-sha256.1 +54 -0
  227. data/man/ronin-sha256.1.md +40 -0
  228. data/man/ronin-sha512.1 +54 -0
  229. data/man/ronin-sha512.1.md +40 -0
  230. data/man/ronin-strings.1 +115 -0
  231. data/man/ronin-strings.1.md +86 -0
  232. data/man/ronin-tips.1 +35 -0
  233. data/man/ronin-tips.1.md +25 -0
  234. data/man/ronin-tld-list.1 +55 -0
  235. data/man/ronin-tld-list.1.md +41 -0
  236. data/man/ronin-typo.1 +61 -0
  237. data/man/ronin-typo.1.md +45 -0
  238. data/man/ronin-typosquat.1 +65 -0
  239. data/man/ronin-typosquat.1.md +48 -0
  240. data/man/ronin-unescape.1 +94 -0
  241. data/man/ronin-unescape.1.md +70 -0
  242. data/man/ronin-unhexdump.1 +187 -0
  243. data/man/ronin-unhexdump.1.md +107 -0
  244. data/man/ronin-unquote.1 +78 -0
  245. data/man/ronin-unquote.1.md +58 -0
  246. data/man/ronin-url.1 +85 -0
  247. data/man/ronin-url.1.md +63 -0
  248. data/man/ronin-xor.1 +62 -0
  249. data/man/ronin-xor.1.md +46 -0
  250. data/man/ronin.1 +25 -6
  251. data/man/ronin.1.md +20 -5
  252. data/ronin.gemspec +1 -1
  253. data/spec/cli/command_spec.rb +10 -0
  254. data/spec/cli/commands/decode_spec.rb +152 -0
  255. data/spec/cli/commands/encode_spec.rb +152 -0
  256. data/spec/cli/commands/escape_spec.rb +128 -0
  257. data/spec/cli/commands/quote_spec.rb +76 -0
  258. data/spec/cli/commands/unescape_spec.rb +128 -0
  259. data/spec/cli/commands/unquote_spec.rb +80 -0
  260. data/spec/cli/fixtures/file.txt +3 -0
  261. data/spec/cli/fixtures/file2.txt +3 -0
  262. data/spec/cli/key_options_spec.rb +56 -0
  263. data/spec/cli/method_options_spec.rb +71 -0
  264. data/spec/cli/string_methods_command_spec.rb +25 -0
  265. data/spec/cli/string_processor_command_spec.rb +258 -0
  266. data/spec/cli/value_processor_command_spec.rb +127 -0
  267. data/spec/spec_helper.rb +2 -57
  268. data/spec/version_spec.rb +11 -0
  269. metadata +301 -455
  270. data/bin/ronin-campaigns +0 -20
  271. data/bin/ronin-console +0 -20
  272. data/bin/ronin-creds +0 -20
  273. data/bin/ronin-database +0 -20
  274. data/bin/ronin-emails +0 -20
  275. data/bin/ronin-exec +0 -20
  276. data/bin/ronin-fuzzer +0 -20
  277. data/bin/ronin-help +0 -20
  278. data/bin/ronin-hosts +0 -20
  279. data/bin/ronin-install +0 -20
  280. data/bin/ronin-ips +0 -20
  281. data/bin/ronin-net-proxy +0 -20
  282. data/bin/ronin-repos +0 -20
  283. data/bin/ronin-uninstall +0 -20
  284. data/bin/ronin-update +0 -20
  285. data/bin/ronin-urls +0 -20
  286. data/bin/ronin-wordlist +0 -20
  287. data/lib/bond/completions/ronin.rb +0 -154
  288. data/lib/ronin/address.rb +0 -124
  289. data/lib/ronin/arch.rb +0 -136
  290. data/lib/ronin/author.rb +0 -66
  291. data/lib/ronin/auto_load.rb +0 -91
  292. data/lib/ronin/bootstrap.rb +0 -27
  293. data/lib/ronin/campaign.rb +0 -129
  294. data/lib/ronin/credential.rb +0 -119
  295. data/lib/ronin/database/database.rb +0 -325
  296. data/lib/ronin/database/exceptions/unknown_repository.rb +0 -25
  297. data/lib/ronin/database/exceptions.rb +0 -21
  298. data/lib/ronin/database/migrations/1.0.0.rb +0 -569
  299. data/lib/ronin/database/migrations/1.1.0.rb +0 -125
  300. data/lib/ronin/database/migrations/exceptions/duplicate_migration.rb +0 -29
  301. data/lib/ronin/database/migrations/exceptions/unknown_migration.rb +0 -27
  302. data/lib/ronin/database/migrations/exceptions.rb +0 -21
  303. data/lib/ronin/database/migrations/graph.rb +0 -300
  304. data/lib/ronin/database/migrations/migration.rb +0 -66
  305. data/lib/ronin/database/migrations/migrations.rb +0 -185
  306. data/lib/ronin/database/migrations.rb +0 -22
  307. data/lib/ronin/database.rb +0 -21
  308. data/lib/ronin/email_address.rb +0 -257
  309. data/lib/ronin/environment.rb +0 -30
  310. data/lib/ronin/exceptions/duplicate_repository.rb +0 -23
  311. data/lib/ronin/exceptions/repository_not_found.rb +0 -23
  312. data/lib/ronin/exceptions.rb +0 -21
  313. data/lib/ronin/host_name.rb +0 -271
  314. data/lib/ronin/host_name_ip_address.rb +0 -45
  315. data/lib/ronin/installation.rb +0 -225
  316. data/lib/ronin/ip_address.rb +0 -348
  317. data/lib/ronin/ip_address_mac_address.rb +0 -45
  318. data/lib/ronin/license.rb +0 -121
  319. data/lib/ronin/mac_address.rb +0 -111
  320. data/lib/ronin/model/has_authors.rb +0 -111
  321. data/lib/ronin/model/has_description.rb +0 -73
  322. data/lib/ronin/model/has_license.rb +0 -129
  323. data/lib/ronin/model/has_name.rb +0 -91
  324. data/lib/ronin/model/has_title.rb +0 -71
  325. data/lib/ronin/model/has_unique_name.rb +0 -127
  326. data/lib/ronin/model/has_version.rb +0 -77
  327. data/lib/ronin/model/importable.rb +0 -65
  328. data/lib/ronin/model/model.rb +0 -165
  329. data/lib/ronin/model/types/description.rb +0 -60
  330. data/lib/ronin/model/types.rb +0 -20
  331. data/lib/ronin/model.rb +0 -20
  332. data/lib/ronin/open_port.rb +0 -112
  333. data/lib/ronin/organization.rb +0 -46
  334. data/lib/ronin/os.rb +0 -157
  335. data/lib/ronin/os_guess.rb +0 -45
  336. data/lib/ronin/password.rb +0 -165
  337. data/lib/ronin/port.rb +0 -126
  338. data/lib/ronin/repositories.rb +0 -23
  339. data/lib/ronin/repository.rb +0 -771
  340. data/lib/ronin/ronin.rb +0 -43
  341. data/lib/ronin/script/buildable.rb +0 -156
  342. data/lib/ronin/script/deployable.rb +0 -202
  343. data/lib/ronin/script/exceptions/deploy_failed.rb +0 -27
  344. data/lib/ronin/script/exceptions/exception.rb +0 -25
  345. data/lib/ronin/script/exceptions/not_built.rb +0 -27
  346. data/lib/ronin/script/exceptions/test_failed.rb +0 -27
  347. data/lib/ronin/script/exceptions.rb +0 -24
  348. data/lib/ronin/script/path.rb +0 -293
  349. data/lib/ronin/script/script.rb +0 -384
  350. data/lib/ronin/script/testable.rb +0 -365
  351. data/lib/ronin/script.rb +0 -21
  352. data/lib/ronin/service.rb +0 -39
  353. data/lib/ronin/service_credential.rb +0 -31
  354. data/lib/ronin/software.rb +0 -55
  355. data/lib/ronin/spec/database.rb +0 -56
  356. data/lib/ronin/target.rb +0 -66
  357. data/lib/ronin/tcp_port.rb +0 -36
  358. data/lib/ronin/udp_port.rb +0 -32
  359. data/lib/ronin/ui/cli/class_command.rb +0 -137
  360. data/lib/ronin/ui/cli/cli.rb +0 -148
  361. data/lib/ronin/ui/cli/command.rb +0 -649
  362. data/lib/ronin/ui/cli/commands/campaigns.rb +0 -165
  363. data/lib/ronin/ui/cli/commands/console.rb +0 -106
  364. data/lib/ronin/ui/cli/commands/creds.rb +0 -108
  365. data/lib/ronin/ui/cli/commands/database.rb +0 -204
  366. data/lib/ronin/ui/cli/commands/emails.rb +0 -86
  367. data/lib/ronin/ui/cli/commands/exec.rb +0 -127
  368. data/lib/ronin/ui/cli/commands/fuzzer.rb +0 -306
  369. data/lib/ronin/ui/cli/commands/help.rb +0 -87
  370. data/lib/ronin/ui/cli/commands/hosts.rb +0 -177
  371. data/lib/ronin/ui/cli/commands/install.rb +0 -136
  372. data/lib/ronin/ui/cli/commands/ips.rb +0 -178
  373. data/lib/ronin/ui/cli/commands/net/proxy.rb +0 -411
  374. data/lib/ronin/ui/cli/commands/repos.rb +0 -164
  375. data/lib/ronin/ui/cli/commands/uninstall.rb +0 -90
  376. data/lib/ronin/ui/cli/commands/update.rb +0 -125
  377. data/lib/ronin/ui/cli/commands/urls.rb +0 -141
  378. data/lib/ronin/ui/cli/commands/wordlist.rb +0 -181
  379. data/lib/ronin/ui/cli/exceptions/unknown_command.rb +0 -27
  380. data/lib/ronin/ui/cli/exceptions.rb +0 -20
  381. data/lib/ronin/ui/cli/model_command.rb +0 -182
  382. data/lib/ronin/ui/cli/printing.rb +0 -167
  383. data/lib/ronin/ui/cli/resources_command.rb +0 -117
  384. data/lib/ronin/ui/cli/script_command.rb +0 -212
  385. data/lib/ronin/ui/cli.rb +0 -21
  386. data/lib/ronin/ui/console/commands.rb +0 -86
  387. data/lib/ronin/ui/console/console.rb +0 -215
  388. data/lib/ronin/ui/console/context.rb +0 -106
  389. data/lib/ronin/ui/console/shell.rb +0 -184
  390. data/lib/ronin/ui/console.rb +0 -22
  391. data/lib/ronin/url.rb +0 -546
  392. data/lib/ronin/url_query_param.rb +0 -73
  393. data/lib/ronin/url_query_param_name.rb +0 -89
  394. data/lib/ronin/url_scheme.rb +0 -53
  395. data/lib/ronin/user_name.rb +0 -47
  396. data/lib/ronin/vendor.rb +0 -39
  397. data/lib/ronin/web_credential.rb +0 -76
  398. data/man/ronin-campaigns.1 +0 -105
  399. data/man/ronin-campaigns.1.md +0 -78
  400. data/man/ronin-console.1 +0 -96
  401. data/man/ronin-console.1.md +0 -72
  402. data/man/ronin-creds.1 +0 -89
  403. data/man/ronin-creds.1.md +0 -66
  404. data/man/ronin-database.1 +0 -111
  405. data/man/ronin-database.1.md +0 -82
  406. data/man/ronin-emails.1 +0 -97
  407. data/man/ronin-emails.1.md +0 -72
  408. data/man/ronin-exec.1 +0 -65
  409. data/man/ronin-exec.1.md +0 -49
  410. data/man/ronin-fuzzer.1 +0 -95
  411. data/man/ronin-fuzzer.1.md +0 -73
  412. data/man/ronin-hosts.1 +0 -105
  413. data/man/ronin-hosts.1.md +0 -78
  414. data/man/ronin-install.1 +0 -104
  415. data/man/ronin-install.1.md +0 -79
  416. data/man/ronin-ips.1 +0 -109
  417. data/man/ronin-ips.1.md +0 -81
  418. data/man/ronin-repos.1 +0 -102
  419. data/man/ronin-repos.1.md +0 -77
  420. data/man/ronin-uninstall.1 +0 -88
  421. data/man/ronin-uninstall.1.md +0 -67
  422. data/man/ronin-update.1 +0 -88
  423. data/man/ronin-update.1.md +0 -67
  424. data/man/ronin-urls.1 +0 -113
  425. data/man/ronin-urls.1.md +0 -84
  426. data/man/ronin-wordlist.1 +0 -71
  427. data/man/ronin-wordlist.1.md +0 -54
  428. data/spec/arch_spec.rb +0 -77
  429. data/spec/author_spec.rb +0 -26
  430. data/spec/campaign_spec.rb +0 -13
  431. data/spec/classes/my_script.rb +0 -21
  432. data/spec/credential_spec.rb +0 -29
  433. data/spec/database_spec.rb +0 -28
  434. data/spec/email_address_spec.rb +0 -83
  435. data/spec/helpers/repos/installed/ronin.yml +0 -7
  436. data/spec/helpers/repos/installed/scripts/.keep +0 -0
  437. data/spec/helpers/repos/local/lib/init.rb +0 -1
  438. data/spec/helpers/repos/local/lib/stuff/another_test.rb +0 -6
  439. data/spec/helpers/repos/local/lib/stuff/test.rb +0 -4
  440. data/spec/helpers/repos/local/ronin.yml +0 -7
  441. data/spec/helpers/repos/local/scripts/.keep +0 -0
  442. data/spec/helpers/repos/remote/ronin.yml +0 -7
  443. data/spec/helpers/repos/remote/scripts/.keep +0 -0
  444. data/spec/helpers/repos/scripts/ronin.yml +0 -7
  445. data/spec/helpers/repos/scripts/scripts/cached/cached.rb +0 -10
  446. data/spec/helpers/repos/scripts/scripts/cached/missing.rb +0 -10
  447. data/spec/helpers/repos/scripts/scripts/cached/modified.rb +0 -10
  448. data/spec/helpers/repos/scripts/scripts/cached/unmodified.rb +0 -10
  449. data/spec/helpers/repos/scripts/scripts/failures/exceptions.rb +0 -11
  450. data/spec/helpers/repos/scripts/scripts/failures/load_errors.rb +0 -11
  451. data/spec/helpers/repos/scripts/scripts/failures/name_errors.rb +0 -8
  452. data/spec/helpers/repos/scripts/scripts/failures/no_method_errors.rb +0 -10
  453. data/spec/helpers/repos/scripts/scripts/failures/syntax_errors.rb +0 -11
  454. data/spec/helpers/repos/scripts/scripts/failures/validation_errors.rb +0 -11
  455. data/spec/helpers/repos/scripts/scripts/my_scripts/test.rb +0 -16
  456. data/spec/helpers/repositories.rb +0 -11
  457. data/spec/host_name_spec.rb +0 -92
  458. data/spec/installation_spec.rb +0 -40
  459. data/spec/ip_address_spec.rb +0 -109
  460. data/spec/license_spec.rb +0 -25
  461. data/spec/mac_address_spec.rb +0 -47
  462. data/spec/model/has_authors_spec.rb +0 -79
  463. data/spec/model/has_description_spec.rb +0 -76
  464. data/spec/model/has_license_spec.rb +0 -73
  465. data/spec/model/has_name_spec.rb +0 -54
  466. data/spec/model/has_title_spec.rb +0 -42
  467. data/spec/model/has_version_spec.rb +0 -87
  468. data/spec/model/model_spec.rb +0 -98
  469. data/spec/model/models/authored_model.rb +0 -11
  470. data/spec/model/models/base_model.rb +0 -13
  471. data/spec/model/models/described_model.rb +0 -9
  472. data/spec/model/models/inherited_model.rb +0 -16
  473. data/spec/model/models/licensed_model.rb +0 -11
  474. data/spec/model/models/named_model.rb +0 -9
  475. data/spec/model/models/titled_model.rb +0 -9
  476. data/spec/model/models/versioned_model.rb +0 -11
  477. data/spec/os_spec.rb +0 -48
  478. data/spec/password_spec.rb +0 -47
  479. data/spec/port_spec.rb +0 -51
  480. data/spec/repository_spec.rb +0 -270
  481. data/spec/ronin_spec.rb +0 -25
  482. data/spec/script/buildable_spec.rb +0 -51
  483. data/spec/script/classes/buildable_class.rb +0 -15
  484. data/spec/script/classes/deployable_class.rb +0 -13
  485. data/spec/script/classes/script_class.rb +0 -19
  486. data/spec/script/classes/testable_class.rb +0 -19
  487. data/spec/script/deployable_spec.rb +0 -55
  488. data/spec/script/path_spec.rb +0 -185
  489. data/spec/script/script_spec.rb +0 -128
  490. data/spec/script/testable_spec.rb +0 -117
  491. data/spec/service_spec.rb +0 -24
  492. data/spec/software_spec.rb +0 -46
  493. data/spec/ui/cli/classes/test_command.rb +0 -26
  494. data/spec/ui/cli/cli_spec.rb +0 -34
  495. data/spec/ui/cli/command_spec.rb +0 -291
  496. data/spec/url_query_param_spec.rb +0 -41
  497. data/spec/url_scheme_spec.rb +0 -21
  498. data/spec/url_spec.rb +0 -179
  499. data/spec/vendor_spec.rb +0 -25
@@ -1,649 +0,0 @@
1
- #
2
- # Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
3
- #
4
- # This file is part of ronin.
5
- #
6
- # Ronin is free software: you can redistribute it and/or modify
7
- # it under the terms of the GNU General Public License as published by
8
- # the Free Software Foundation, either version 3 of the License, or
9
- # (at your option) any later version.
10
- #
11
- # Ronin is distributed in the hope that it will be useful,
12
- # but WITHOUT ANY WARRANTY; without even the implied warranty of
13
- # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14
- # GNU General Public License for more details.
15
- #
16
- # You should have received a copy of the GNU General Public License
17
- # along with Ronin. If not, see <https://www.gnu.org/licenses/>.
18
- #
19
-
20
- require 'ronin/ui/cli/printing'
21
- require 'ronin/ui/output'
22
- require 'ronin/support/inflector'
23
-
24
- require 'parameters'
25
- require 'parameters/options'
26
-
27
- module Ronin
28
- module UI
29
- module CLI
30
- #
31
- # The {Command} provides a base-class for defining commands for the {CLI}.
32
- #
33
- # # Extending
34
- #
35
- # To create a new command one can inherit the {Command} class.
36
- # The new command can define multiple `class_options` and `arguments`
37
- # which `Thor::Group` will use to parse command-line arguments.
38
- #
39
- # require 'ronin/ui/cli/command'
40
- #
41
- # module Ronin
42
- # module UI
43
- # module CLI
44
- # module Commands
45
- # class MyCommand < Command
46
- #
47
- # summary 'My command'
48
- #
49
- # option :enable, :type => true,
50
- # :flag => '-e',
51
- # :description => 'Enables stuff'
52
- #
53
- # option :syntax, :type => Symbol,
54
- # :flag => '-S',
55
- # :description => 'Syntax to use'
56
- #
57
- # option :includes, :type => Array[String],
58
- # :default => [],
59
- # :flag => '-I',
60
- # :usage => 'FILE [...]',
61
- # :description => 'Files to include'
62
- #
63
- # option :params, :type => Hash[Symbol => Object],
64
- # :flag => '-P',
65
- # :description => 'Additional params'
66
- #
67
- # argument :path
68
- #
69
- # #
70
- # # Executes the command.
71
- # #
72
- # def execute
73
- # print_info "Stuff enabled" if enable?
74
- #
75
- # if syntax?
76
- # print_info "Using syntax #{@syntax}"
77
- # end
78
- #
79
- # if includes?
80
- # print_info "Including:"
81
- # print_array @includes
82
- # end
83
- # end
84
- #
85
- # end
86
- # end
87
- # end
88
- # end
89
- # end
90
- #
91
- # # Running
92
- #
93
- # To run the command from Ruby, with raw command-line options, one
94
- # can call the `start` class method:
95
- #
96
- # MyCommand.start([
97
- # '--stuff', 'true', '--syntax', 'bla', '--includes', 'other',
98
- # 'some/file.txt'
99
- # ])
100
- #
101
- # Note: If `MyCommand.start` is not given any arguments, it will use
102
- # `ARGV` instead.
103
- #
104
- # To ensure that your command is accessible to the `ronin` command,
105
- # make sure that the ruby file the command is defined within is in
106
- # the `ronin/ui/cli/commands` directory of a Ronin library.
107
- # If the command class is named 'MyCommand' it's ruby file must also
108
- # be named 'my_command.rb'.
109
- #
110
- # To run the command using the `ronin` command, simply specify it's
111
- # underscored name:
112
- #
113
- # ronin my_command some/file.txt --stuff --syntax bla \
114
- # --includes one two
115
- #
116
- class Command
117
-
118
- include Parameters
119
- include Printing
120
-
121
- #
122
- # Initializes the command object.
123
- #
124
- # @param [Hash{Symbol => Object}] options
125
- # Options for the command.
126
- #
127
- # @api semipublic
128
- #
129
- def initialize(options={})
130
- super()
131
-
132
- initialize_params(options)
133
- end
134
-
135
- #
136
- # Returns the name of the command.
137
- #
138
- # @api semipublic
139
- #
140
- def self.command_name
141
- @command_name ||= Support::Inflector.underscore(
142
- self.name.sub('Ronin::UI::CLI::Commands::','').gsub('::',':')
143
- )
144
- end
145
-
146
- #
147
- # Runs the command.
148
- #
149
- # @param [Array<String>] argv
150
- # The arguments for the command to parse.
151
- #
152
- # @return [true]
153
- # Specifies that the command successfully executed.
154
- #
155
- # @note
156
- # If the command raises an Exception, the process will exit with
157
- # status code `-1`.
158
- #
159
- # @since 1.0.0
160
- #
161
- # @api public
162
- #
163
- def self.start(argv=ARGV)
164
- new().start(argv)
165
- end
166
-
167
- #
168
- # Runs the command with the given options.
169
- #
170
- # @param [Hash{Symbol => Object}] options
171
- # Options for the command.
172
- #
173
- # @return [true]
174
- # Specifies that the command successfully executed.
175
- #
176
- # @raise [Exception]
177
- # An exception raised within the command.
178
- #
179
- # @api public
180
- #
181
- def self.run(options={})
182
- new().run(options)
183
- end
184
-
185
- #
186
- # Starts the command with the given command-line arguments.
187
- #
188
- # @param [Array<String>] argv
189
- # The given command-line arguments.
190
- #
191
- # @return [true]
192
- # Specifies whether the command executed successfully.
193
- #
194
- # @note
195
- # If the command raises an Exception, the process will exit with
196
- # status code `-1`.
197
- #
198
- # @since 1.4.0
199
- #
200
- # @api semipublic
201
- #
202
- def start(argv=ARGV)
203
- arguments = option_parser.parse(argv)
204
-
205
- # set additional arguments
206
- self.class.each_argument do |name|
207
- # no more arguments left
208
- break if arguments.empty?
209
-
210
- param = get_param(name)
211
-
212
- if param.type <= Parameters::Types::Array
213
- # allow Array/Set arguments to collect all remaining args
214
- param.value = arguments.shift(arguments.length)
215
- else
216
- param.value = arguments.shift
217
- end
218
- end
219
-
220
- unless arguments.empty?
221
- print_error "Too many arguments. Please consult --help"
222
- exit -1
223
- end
224
-
225
- begin
226
- run
227
- rescue Interrupt
228
- # Ctrl^C
229
- exit 130
230
- rescue Errno::EPIPE
231
- # STDOUT was closed
232
- rescue => error
233
- print_exception(error)
234
- exit -1
235
- end
236
-
237
- return true
238
- end
239
-
240
- #
241
- # Sets up and executes the command.
242
- #
243
- # @param [Hash{Symbol => Object}] options
244
- # Additional options to run the command with.
245
- #
246
- # @return [true]
247
- # Specifies that the command exited successfully.
248
- #
249
- # @see #setup
250
- # @see #execute
251
- #
252
- # @since 1.4.0
253
- #
254
- # @api semipublic
255
- #
256
- def run(options={})
257
- self.params = options
258
-
259
- setup
260
- execute
261
-
262
- return true
263
- ensure
264
- cleanup
265
- end
266
-
267
- #
268
- # Default method to call before {#execute}.
269
- #
270
- # @since 1.1.0
271
- #
272
- # @api semipublic
273
- #
274
- def setup
275
- Output.verbose! if verbose?
276
- Output.quiet! if quiet?
277
- Output.silent! if silent?
278
-
279
- Output.handler = if color? then Output::Terminal::Color
280
- else Output::Terminal::Raw
281
- end
282
- end
283
-
284
- #
285
- # Default method to call after the options have been parsed.
286
- #
287
- # @api semipublic
288
- #
289
- def execute
290
- end
291
-
292
- #
293
- # Default method to call after the command has finished.
294
- #
295
- # @since 1.5.0
296
- #
297
- # @api semipublic
298
- #
299
- def cleanup
300
- end
301
-
302
- protected
303
-
304
- #
305
- # The usage for the command.
306
- #
307
- # @param [String] new_usage
308
- # The new usage for the command.
309
- #
310
- # @return [String]
311
- # The usage string.
312
- #
313
- # @since 1.4.0
314
- #
315
- # @api semipublic
316
- #
317
- def self.usage(new_usage=nil)
318
- if new_usage
319
- @usage = new_usage
320
- else
321
- @usage ||= if superclass < Command
322
- superclass.usage
323
- else
324
- '[options]'
325
- end
326
- end
327
- end
328
-
329
- #
330
- # The summary for the command.
331
- #
332
- # @param [String] new_summary
333
- # The new summary for the command.
334
- #
335
- # @return [String]
336
- # The summary string.
337
- #
338
- # @since 1.4.0
339
- #
340
- # @api semipublic
341
- #
342
- def self.summary(new_summary=nil)
343
- if new_summary
344
- @summary = new_summary
345
- else
346
- @summary ||= if superclass < Command
347
- superclass.summary
348
- end
349
- end
350
- end
351
-
352
- #
353
- # Example usages for the command.
354
- #
355
- # @param [Array<String>] new_examples
356
- # The new examples for the command.
357
- #
358
- # @return [Array]
359
- # Example commands.
360
- #
361
- # @since 1.5.0
362
- #
363
- # @api semipublic
364
- #
365
- def self.examples(new_examples=nil)
366
- if new_examples
367
- @examples = new_examples
368
- else
369
- @examples ||= if superclass < Command
370
- superclass.examples.dup
371
- else
372
- []
373
- end
374
- end
375
- end
376
-
377
- #
378
- # The options for the parameters.
379
- #
380
- # @return [Hash{Symbol => Hash}]
381
- # The banner string.
382
- #
383
- # @since 1.4.0
384
- #
385
- # @api semipublic
386
- #
387
- def self.options
388
- @options ||= {}
389
- end
390
-
391
- #
392
- # Defines an option for the command.
393
- #
394
- # @param [Symbol] name
395
- # The name of the option.
396
- #
397
- # @param [Hash] options
398
- # Additional options for the option.
399
- #
400
- # @option options [Hash{Class => Class}, Set<Class>, Array<Class>, Class, true] :type
401
- # The type of the options.
402
- #
403
- # @option options [Object, Proc] :default
404
- # The default value for the options.
405
- #
406
- # @option options [String] :flag
407
- # The short-flag for the option.
408
- #
409
- # @option options [String] :usage
410
- # The usage for the option.
411
- #
412
- # @option options [String] :description
413
- # The description of the option.
414
- #
415
- # @return [Parameters::ClassParam]
416
- # The parameter that will contain the value of the option.
417
- #
418
- # @example
419
- # option :output, :type => String,
420
- # :flag => '-f',
421
- # :usage => 'PATH',
422
- # :description => 'The path to write the output to'
423
- #
424
- # @since 1.4.0
425
- #
426
- # @api semipublic
427
- #
428
- def self.option(name,options={})
429
- self.options[name] = {
430
- :flag => options[:flag],
431
- :usage => options[:usage],
432
- }
433
-
434
- return parameter(name,options)
435
- end
436
-
437
- option :verbose, :type => true,
438
- :flag => '-v',
439
- :description => 'Enable verbose output'
440
-
441
- option :quiet, :type => true,
442
- :flag => '-q',
443
- :description => 'Disable verbose output'
444
-
445
- option :silent, :type => true,
446
- :description => 'Silence all output'
447
-
448
- option :color, :type => true,
449
- :default => proc { $stdout.tty? },
450
- :description => 'Enables color output'
451
-
452
- #
453
- # Enumerates through the options define by every sub-class.
454
- #
455
- # @yield [name,options]
456
- # The given block will be passed each option.
457
- #
458
- # @yieldparam [Symbol] name
459
- # The name of the option.
460
- #
461
- # @yieldparam [Hash] options
462
- # Additional options associated with the option.
463
- #
464
- # @return [Enumerator]
465
- # If no block is given, an Enumerator will be returned.
466
- #
467
- # @since 1.4.0
468
- #
469
- # @api private
470
- #
471
- def self.each_option(&block)
472
- return enum_for(__method__) unless block
473
-
474
- ancestors.reverse_each do |ancestor|
475
- if ancestor <= Command
476
- ancestor.options.each(&block)
477
- end
478
- end
479
- end
480
-
481
- #
482
- # Determines if there are any options defined by the command.
483
- #
484
- # @return [Boolean]
485
- # Specifies if there are any options defined by the command.
486
- #
487
- # @since 1.4.0
488
- #
489
- # @api semipublic
490
- #
491
- def self.options?
492
- each_option.any?
493
- end
494
-
495
- #
496
- # The additional arguments of the command.
497
- #
498
- # @return [Array<Symbol>]
499
- # The names of the arguments.
500
- #
501
- # @since 1.4.0
502
- #
503
- # @api semipublic
504
- #
505
- def self.arguments
506
- @arguments ||= []
507
- end
508
-
509
- #
510
- # Defines an argument for the command.
511
- #
512
- # @param [Symbol] name
513
- # The name of the argument.
514
- #
515
- # @param [Hash] options
516
- # Additional options for the argument.
517
- #
518
- # @option options [Hash{Class => Class}, Set<Class>, Array<Class>, Class, true] :type (String)
519
- # The type of the argument.
520
- #
521
- # @option options [Object, Proc] :default
522
- # The default value for the argument.
523
- #
524
- # @return [Parameters::ClassParam]
525
- # The parameter that will contain the value of the argument.
526
- #
527
- # @example
528
- # argument :file, :type => String,
529
- # :description => "The file to process"
530
- #
531
- # @since 1.4.0
532
- #
533
- # @api semipublic
534
- #
535
- def self.argument(name,options={})
536
- self.arguments << name.to_sym
537
-
538
- return parameter(name,options)
539
- end
540
-
541
- #
542
- # Enumerates through the arguments define by every sub-class.
543
- #
544
- # @yield [name]
545
- # The given block will be passed each argument name.
546
- #
547
- # @yieldparam [Symbol] name
548
- # The name of the argument.
549
- #
550
- # @return [Enumerator]
551
- # If no block is given, an Enumerator will be returned.
552
- #
553
- # @since 1.4.0
554
- #
555
- # @api semipublic
556
- #
557
- def self.each_argument(&block)
558
- return enum_for(__method__) unless block
559
-
560
- ancestors.reverse_each do |ancestor|
561
- if ancestor <= Command
562
- ancestor.arguments.each(&block)
563
- end
564
- end
565
- end
566
-
567
- #
568
- # Determines if there are any arguments defined by the command.
569
- #
570
- # @return [Boolean]
571
- # Specifies if there are any arguments defined by the command.
572
- #
573
- # @since 1.4.0
574
- #
575
- # @api semipublic
576
- #
577
- def self.arguments?
578
- each_argument.any?
579
- end
580
-
581
- #
582
- # Creates an OptionParser for the command.
583
- #
584
- # @yield [opts]
585
- # The given block will be passed the new OptionParser, after
586
- # all options have been defined, but before the Arguments have
587
- # been listed.
588
- #
589
- # @yieldparam [OptionParser] opts
590
- # The newly created OptionParser.
591
- #
592
- # @return [OptionParser]
593
- # The new configured OptionParser.
594
- #
595
- # @since 1.4.0
596
- #
597
- # @api semipublic
598
- #
599
- def option_parser
600
- OptionParser.new do |opts|
601
- opts.banner = "Usage: ronin #{self.class.command_name} #{self.class.usage}"
602
-
603
- # append the arguments to the banner
604
- self.class.each_argument do |name|
605
- opts.banner << " #{name.to_s.upcase}"
606
- end
607
-
608
- opts.separator ''
609
- opts.separator 'Options:'
610
-
611
- self.class.each_option do |name,options|
612
- Parameters::Options.define(opts,get_param(name),options)
613
- end
614
-
615
- yield opts if block_given?
616
-
617
- if self.class.arguments?
618
- opts.separator ''
619
- opts.separator 'Arguments:'
620
-
621
- self.class.each_argument do |name|
622
- param = get_param(name)
623
- name = name.to_s.upcase
624
- desc = param.description
625
-
626
- opts.separator " #{name.ljust(33)}#{desc}"
627
- end
628
- end
629
-
630
- unless self.class.examples.empty?
631
- opts.separator ''
632
- opts.separator 'Examples:'
633
-
634
- self.class.examples.each do |example|
635
- opts.separator " #{example}"
636
- end
637
- end
638
-
639
- if self.class.summary
640
- opts.separator ''
641
- opts.separator self.class.summary
642
- end
643
- end
644
- end
645
-
646
- end
647
- end
648
- end
649
- end