ronin 0.3.0 → 1.0.0.pre1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (465) hide show
  1. data/.document +4 -0
  2. data/.rspec +1 -0
  3. data/.yardopts +5 -0
  4. data/{History.txt → ChangeLog.md} +15 -15
  5. data/Gemfile +42 -0
  6. data/README.md +224 -0
  7. data/Rakefile +65 -33
  8. data/bin/ronin +18 -5
  9. data/bin/ronin-campaigns +25 -0
  10. data/bin/ronin-console +18 -5
  11. data/bin/ronin-creds +25 -0
  12. data/bin/ronin-database +25 -0
  13. data/bin/ronin-emails +25 -0
  14. data/bin/ronin-exec +25 -0
  15. data/bin/ronin-help +18 -5
  16. data/bin/ronin-hosts +25 -0
  17. data/bin/ronin-ips +25 -0
  18. data/bin/ronin-repos +25 -0
  19. data/bin/ronin-urls +25 -0
  20. data/gemspec.yml +71 -0
  21. data/lib/ronin/address.rb +93 -0
  22. data/lib/ronin/arch.rb +30 -25
  23. data/lib/ronin/author.rb +12 -42
  24. data/lib/ronin/bootstrap.rb +26 -0
  25. data/lib/ronin/cached_file.rb +249 -0
  26. data/lib/ronin/campaign.rb +130 -0
  27. data/lib/ronin/class_methods.rb +27 -0
  28. data/lib/ronin/config.rb +23 -17
  29. data/lib/ronin/credential.rb +114 -0
  30. data/lib/ronin/database/database.rb +180 -52
  31. data/lib/ronin/database/exceptions/invalid_config.rb +2 -2
  32. data/lib/ronin/{platform/exceptions/extension_not_found.rb → database/exceptions/unknown_repository.rb} +3 -3
  33. data/lib/ronin/database/exceptions.rb +2 -1
  34. data/lib/ronin/database/migrations/create_addresses_table.rb +52 -0
  35. data/lib/ronin/database/migrations/create_arches_table.rb +44 -0
  36. data/lib/ronin/database/migrations/create_authors_table.rb +47 -0
  37. data/lib/ronin/database/migrations/create_cached_files_table.rb +47 -0
  38. data/lib/ronin/database/migrations/create_campaigns_table.rb +42 -0
  39. data/lib/ronin/database/migrations/create_countries_table.rb +44 -0
  40. data/lib/ronin/database/migrations/create_credentials_table.rb +59 -0
  41. data/lib/ronin/database/migrations/create_email_addresses_table.rb +51 -0
  42. data/lib/ronin/database/migrations/create_host_name_ip_addresses_table.rb +45 -0
  43. data/lib/ronin/database/migrations/create_ip_address_mac_addresses_table.rb +45 -0
  44. data/lib/ronin/database/migrations/create_licenses_table.rb +44 -0
  45. data/lib/ronin/database/migrations/create_open_ports_table.rb +55 -0
  46. data/lib/ronin/database/migrations/create_organizations_table.rb +47 -0
  47. data/lib/ronin/database/migrations/create_os_guesses_table.rb +45 -0
  48. data/lib/ronin/database/migrations/create_os_table.rb +43 -0
  49. data/lib/ronin/{extensions/array.rb → database/migrations/create_passwords_table.rb} +17 -23
  50. data/lib/ronin/{ui/command_line/commands/uninstall.rb → database/migrations/create_ports_table.rb} +20 -24
  51. data/lib/ronin/database/migrations/create_proxies_table.rb +55 -0
  52. data/lib/ronin/database/migrations/create_remote_files_table.rb +53 -0
  53. data/lib/ronin/database/migrations/create_repositories_table.rb +61 -0
  54. data/lib/ronin/{ui/command_line/commands/remove.rb → database/migrations/create_services_table.rb} +20 -24
  55. data/lib/ronin/database/migrations/create_softwares_table.rb +46 -0
  56. data/lib/ronin/database/migrations/create_taggings_table.rb +46 -0
  57. data/lib/ronin/database/migrations/create_tags_table.rb +42 -0
  58. data/lib/ronin/database/migrations/create_targets_table.rb +50 -0
  59. data/lib/ronin/{network/imap.rb → database/migrations/create_url_query_params_table.rb} +16 -22
  60. data/lib/ronin/database/migrations/create_url_schemes_table.rb +40 -0
  61. data/lib/ronin/database/migrations/create_urls_table.rb +61 -0
  62. data/lib/ronin/{network/pop3.rb → database/migrations/create_user_names_table.rb} +16 -21
  63. data/lib/ronin/database/migrations/create_vendors_table.rb +42 -0
  64. data/lib/ronin/database/migrations/exceptions/duplicate_migration.rb +30 -0
  65. data/lib/ronin/{network/http/exceptions/unknown_request.rb → database/migrations/exceptions/unknown_migration.rb} +4 -4
  66. data/lib/ronin/{platform → database/migrations}/exceptions.rb +3 -3
  67. data/lib/ronin/database/migrations/graph.rb +278 -0
  68. data/lib/ronin/database/migrations/migration.rb +67 -0
  69. data/lib/ronin/database/migrations/migrations.rb +186 -0
  70. data/lib/ronin/database/migrations.rb +55 -0
  71. data/lib/ronin/database.rb +2 -1
  72. data/lib/ronin/email_address.rb +133 -0
  73. data/lib/ronin/engine/buildable.rb +125 -0
  74. data/lib/ronin/engine/class_methods.rb +133 -0
  75. data/lib/ronin/engine/deployable.rb +180 -0
  76. data/lib/ronin/engine/engine.rb +69 -0
  77. data/lib/ronin/{rpc/exceptions/response_missing.rb → engine/exceptions/deploy_failed.rb} +3 -3
  78. data/lib/ronin/{rpc/exceptions/not_implemented.rb → engine/exceptions/not_built.rb} +3 -3
  79. data/lib/ronin/{platform/exceptions/overlay_cached.rb → engine/exceptions/verification_failed.rb} +3 -3
  80. data/lib/ronin/{rpc → engine}/exceptions.rb +4 -3
  81. data/lib/ronin/engine/instance_methods.rb +95 -0
  82. data/lib/ronin/engine/verifiable.rb +334 -0
  83. data/lib/ronin/{yard.rb → engine.rb} +2 -2
  84. data/lib/ronin/environment.rb +5 -14
  85. data/lib/ronin/{platform/exceptions/overlay_not_found.rb → exceptions/duplicate_repository.rb} +2 -4
  86. data/lib/ronin/exceptions/repository_not_found.rb +24 -0
  87. data/lib/ronin/{network/http/exceptions.rb → exceptions.rb} +3 -2
  88. data/lib/ronin/host_name.rb +181 -0
  89. data/lib/ronin/host_name_ip_address.rb +42 -0
  90. data/lib/ronin/installation.rb +169 -0
  91. data/lib/ronin/ip_address.rb +273 -0
  92. data/lib/ronin/ip_address_mac_address.rb +42 -0
  93. data/lib/ronin/license.rb +17 -20
  94. data/lib/ronin/mac_address.rb +68 -0
  95. data/lib/ronin/model/cacheable/cacheable.rb +280 -0
  96. data/lib/ronin/model/cacheable/class_methods.rb +61 -0
  97. data/lib/ronin/model/cacheable.rb +22 -0
  98. data/lib/ronin/{rpc/response.rb → model/class_methods.rb} +17 -21
  99. data/lib/ronin/{code/emittable.rb → model/has_authors/class_methods.rb} +27 -34
  100. data/lib/ronin/model/has_authors/has_authors.rb +63 -0
  101. data/lib/ronin/model/has_authors.rb +22 -0
  102. data/lib/ronin/model/has_description/class_methods.rb +44 -0
  103. data/lib/ronin/model/has_description/has_description.rb +42 -0
  104. data/lib/ronin/model/has_description.rb +3 -59
  105. data/lib/ronin/{network/helpers/helper.rb → model/has_license/class_methods.rb} +16 -22
  106. data/lib/ronin/model/has_license/has_license.rb +64 -0
  107. data/lib/ronin/model/has_license.rb +3 -38
  108. data/lib/ronin/model/has_name/class_methods.rb +47 -0
  109. data/lib/ronin/model/has_name/has_name.rb +53 -0
  110. data/lib/ronin/model/has_name.rb +3 -33
  111. data/lib/ronin/model/has_title/class_methods.rb +43 -0
  112. data/lib/ronin/model/has_title/has_title.rb +41 -0
  113. data/lib/ronin/model/has_title.rb +22 -0
  114. data/lib/ronin/model/has_unique_name.rb +52 -0
  115. data/lib/ronin/model/has_version/class_methods.rb +47 -0
  116. data/lib/ronin/model/has_version/has_version.rb +41 -0
  117. data/lib/ronin/model/has_version.rb +3 -37
  118. data/lib/ronin/model/model.rb +27 -32
  119. data/lib/ronin/model/types/description.rb +60 -0
  120. data/lib/ronin/{extensions/meta.rb → model/types.rb} +2 -2
  121. data/lib/ronin/model.rb +1 -1
  122. data/lib/ronin/network/mixins/esmtp.rb +152 -0
  123. data/lib/ronin/network/{helpers → mixins}/http.rb +79 -61
  124. data/lib/ronin/network/mixins/imap.rb +140 -0
  125. data/lib/ronin/network/mixins/pop3.rb +130 -0
  126. data/lib/ronin/network/mixins/smtp.rb +146 -0
  127. data/lib/ronin/network/{helpers → mixins}/tcp.rb +97 -98
  128. data/lib/ronin/network/{helpers → mixins}/telnet.rb +71 -41
  129. data/lib/ronin/network/mixins/udp.rb +210 -0
  130. data/lib/ronin/network/mixins.rb +29 -0
  131. data/lib/ronin/open_port.rb +112 -0
  132. data/lib/ronin/organization.rb +49 -0
  133. data/lib/ronin/os.rb +61 -11
  134. data/lib/ronin/os_guess.rb +42 -0
  135. data/lib/ronin/password.rb +126 -0
  136. data/lib/ronin/port.rb +71 -0
  137. data/lib/ronin/proxy.rb +179 -0
  138. data/lib/ronin/proxy_credential.rb +30 -0
  139. data/lib/ronin/remote_file.rb +150 -0
  140. data/lib/ronin/repository.rb +681 -0
  141. data/lib/ronin/ronin.rb +31 -0
  142. data/lib/ronin/service.rb +52 -0
  143. data/lib/ronin/service_credential.rb +30 -0
  144. data/lib/ronin/{product.rb → software.rb} +12 -34
  145. data/lib/ronin/spec/database.rb +42 -0
  146. data/lib/ronin/{extensions/uri/http.rb → spec/ui/output.rb} +6 -8
  147. data/lib/ronin/target.rb +78 -0
  148. data/lib/ronin/tcp_port.rb +41 -0
  149. data/lib/ronin/udp_port.rb +37 -0
  150. data/lib/ronin/ui/async_console.rb +130 -0
  151. data/lib/ronin/ui/cli/cli.rb +147 -0
  152. data/lib/ronin/ui/cli/command.rb +316 -0
  153. data/lib/ronin/ui/cli/commands/campaigns.rb +130 -0
  154. data/lib/ronin/ui/{command_line → cli}/commands/console.rb +27 -22
  155. data/lib/ronin/ui/cli/commands/creds.rb +87 -0
  156. data/lib/ronin/ui/cli/commands/database.rb +179 -0
  157. data/lib/ronin/ui/cli/commands/emails.rb +108 -0
  158. data/lib/ronin/ui/cli/commands/exec.rb +124 -0
  159. data/lib/ronin/ui/{command_line → cli}/commands/help.rb +17 -14
  160. data/lib/ronin/ui/cli/commands/hosts.rb +177 -0
  161. data/lib/ronin/ui/cli/commands/ips.rb +172 -0
  162. data/lib/ronin/ui/cli/commands/repos.rb +236 -0
  163. data/lib/ronin/ui/cli/commands/urls.rb +144 -0
  164. data/lib/ronin/ui/cli/commands.rb +37 -0
  165. data/lib/ronin/ui/cli/engine_command.rb +104 -0
  166. data/lib/ronin/ui/{command_line → cli}/exceptions/unknown_command.rb +2 -2
  167. data/lib/ronin/{formatting/digest.rb → ui/cli/exceptions.rb} +2 -2
  168. data/lib/ronin/ui/cli/model_command.rb +247 -0
  169. data/lib/ronin/{formatting/binary.rb → ui/cli.rb} +3 -2
  170. data/lib/ronin/ui/console.rb +104 -109
  171. data/lib/ronin/ui/hexdump/extensions/file.rb +1 -1
  172. data/lib/ronin/ui/hexdump/extensions/kernel.rb +1 -1
  173. data/lib/ronin/ui/hexdump/extensions.rb +1 -1
  174. data/lib/ronin/ui/hexdump/hexdump.rb +5 -3
  175. data/lib/ronin/ui/hexdump.rb +1 -1
  176. data/lib/ronin/ui/output/helpers.rb +97 -9
  177. data/lib/ronin/ui/output/output.rb +30 -54
  178. data/lib/ronin/ui/output/terminal/color.rb +97 -0
  179. data/lib/ronin/ui/output/terminal/raw.rb +91 -0
  180. data/lib/ronin/{extensions/uri.rb → ui/output/terminal.rb} +3 -2
  181. data/lib/ronin/ui/output.rb +1 -1
  182. data/lib/ronin/ui/shell.rb +55 -90
  183. data/lib/ronin/ui.rb +1 -1
  184. data/lib/ronin/url.rb +343 -0
  185. data/lib/ronin/url_query_param.rb +40 -0
  186. data/lib/ronin/url_scheme.rb +37 -0
  187. data/lib/ronin/user_name.rb +45 -0
  188. data/lib/ronin/vendor.rb +40 -0
  189. data/lib/ronin/version.rb +2 -2
  190. data/lib/ronin/web_credential.rb +32 -0
  191. data/lib/ronin.rb +2 -2
  192. data/ronin.gemspec +10 -0
  193. data/spec/arch_spec.rb +1 -2
  194. data/spec/author_spec.rb +18 -2
  195. data/spec/cached_file_spec.rb +211 -0
  196. data/spec/campaign_spec.rb +30 -0
  197. data/spec/database_spec.rb +5 -0
  198. data/spec/email_address_spec.rb +35 -0
  199. data/spec/engine/buildable_spec.rb +51 -0
  200. data/spec/engine/classes/buildable_class.rb +15 -0
  201. data/spec/engine/classes/deployable_class.rb +13 -0
  202. data/spec/engine/classes/engine_class.rb +19 -0
  203. data/spec/engine/classes/verifiable_class.rb +19 -0
  204. data/spec/engine/deployable_spec.rb +55 -0
  205. data/spec/engine/engine_spec.rb +55 -0
  206. data/spec/engine/verifiable_spec.rb +117 -0
  207. data/spec/{static/helpers/static1/dir/two.txt → helpers/repos/hello/cache/.keep} +0 -0
  208. data/spec/helpers/repos/hello/lib/init.rb +1 -0
  209. data/spec/{platform/helpers/overlays → helpers/repos}/hello/lib/stuff/another_test.rb +0 -0
  210. data/spec/{platform/helpers/overlays → helpers/repos}/hello/lib/stuff/test.rb +0 -0
  211. data/spec/helpers/repos/hello/ronin.yml +7 -0
  212. data/spec/{static/helpers/static1/one.txt → helpers/repos/random/cache/.keep} +0 -0
  213. data/spec/helpers/repos/random/ronin.yml +7 -0
  214. data/spec/helpers/repos/test1/cache/cacheable_model/one.rb +15 -0
  215. data/spec/helpers/repos/test1/ronin.yml +7 -0
  216. data/spec/helpers/repos/test2/cache/cacheable_model/exceptions.rb +7 -0
  217. data/spec/helpers/repos/test2/cache/cacheable_model/load_errors.rb +9 -0
  218. data/spec/helpers/repos/test2/cache/cacheable_model/no_method_errors.rb +9 -0
  219. data/spec/helpers/repos/test2/cache/cacheable_model/syntax_errors.rb +7 -0
  220. data/spec/helpers/repos/test2/cache/cacheable_model/two.rb +15 -0
  221. data/spec/helpers/repos/test2/cache/cacheable_model/validation_errors.rb +9 -0
  222. data/spec/helpers/repos/test2/ronin.yml +7 -0
  223. data/spec/helpers/repositories.rb +11 -0
  224. data/spec/host_name_spec.rb +51 -0
  225. data/spec/installation_spec.rb +45 -0
  226. data/spec/ip_address.rb +67 -0
  227. data/spec/license_spec.rb +1 -2
  228. data/spec/mac_address_spec.rb +18 -0
  229. data/spec/model/cacheable_spec.rb +93 -0
  230. data/spec/model/has_description_spec.rb +45 -26
  231. data/spec/model/has_license_spec.rb +18 -17
  232. data/spec/model/has_name_spec.rb +35 -0
  233. data/spec/model/has_title_spec.rb +27 -0
  234. data/spec/model/model_spec.rb +27 -19
  235. data/spec/model/{classes → models}/basic_model.rb +0 -0
  236. data/spec/model/models/cacheable_model.rb +15 -0
  237. data/spec/model/{classes → models}/custom_model.rb +1 -1
  238. data/spec/model/{classes → models}/described_model.rb +0 -0
  239. data/spec/model/models/lazy_model.rb +9 -0
  240. data/spec/model/{classes → models}/licensed_model.rb +0 -0
  241. data/spec/model/models/named_model.rb +10 -0
  242. data/spec/model/models/titled_model.rb +10 -0
  243. data/spec/model/spec_helper.rb +22 -0
  244. data/spec/os_spec.rb +1 -2
  245. data/spec/password_spec.rb +35 -0
  246. data/spec/repository_spec.rb +291 -0
  247. data/spec/ronin_spec.rb +19 -5
  248. data/spec/software_spec.rb +23 -0
  249. data/spec/spec_helper.rb +35 -4
  250. data/spec/support/inflector_spec.rb +20 -0
  251. data/spec/ui/cli/classes/test_command.rb +11 -0
  252. data/spec/ui/cli/command_spec.rb +21 -0
  253. data/spec/ui/output_spec.rb +20 -17
  254. data/spec/url_spec.rb +111 -0
  255. data/spec/vendor_spec.rb +18 -0
  256. metadata +761 -421
  257. data/Manifest.txt +0 -290
  258. data/README.txt +0 -206
  259. data/bin/ronin-add +0 -12
  260. data/bin/ronin-install +0 -12
  261. data/bin/ronin-list +0 -12
  262. data/bin/ronin-remove +0 -12
  263. data/bin/ronin-uninstall +0 -12
  264. data/bin/ronin-update +0 -12
  265. data/lib/ronin/cacheable.rb +0 -307
  266. data/lib/ronin/code/reference.rb +0 -130
  267. data/lib/ronin/code/symbol_table.rb +0 -100
  268. data/lib/ronin/code/token.rb +0 -69
  269. data/lib/ronin/extensions/file.rb +0 -38
  270. data/lib/ronin/extensions/ip_addr.rb +0 -147
  271. data/lib/ronin/extensions/kernel.rb +0 -97
  272. data/lib/ronin/extensions/meta/object.rb +0 -24
  273. data/lib/ronin/extensions/string.rb +0 -119
  274. data/lib/ronin/extensions/uri/query_params.rb +0 -126
  275. data/lib/ronin/extensions.rb +0 -26
  276. data/lib/ronin/formatting/extensions/binary/file.rb +0 -35
  277. data/lib/ronin/formatting/extensions/binary/integer.rb +0 -106
  278. data/lib/ronin/formatting/extensions/binary/string.rb +0 -285
  279. data/lib/ronin/formatting/extensions/binary.rb +0 -22
  280. data/lib/ronin/formatting/extensions/digest/string.rb +0 -87
  281. data/lib/ronin/formatting/extensions/digest.rb +0 -21
  282. data/lib/ronin/formatting/extensions/http/string.rb +0 -88
  283. data/lib/ronin/formatting/extensions/http.rb +0 -21
  284. data/lib/ronin/formatting/extensions/text/array.rb +0 -77
  285. data/lib/ronin/formatting/extensions/text/string.rb +0 -162
  286. data/lib/ronin/formatting/extensions/text.rb +0 -22
  287. data/lib/ronin/formatting/extensions.rb +0 -22
  288. data/lib/ronin/formatting/http.rb +0 -21
  289. data/lib/ronin/formatting/text.rb +0 -21
  290. data/lib/ronin/formatting.rb +0 -25
  291. data/lib/ronin/network/esmtp.rb +0 -21
  292. data/lib/ronin/network/extensions/esmtp/net.rb +0 -96
  293. data/lib/ronin/network/extensions/esmtp.rb +0 -21
  294. data/lib/ronin/network/extensions/http/net.rb +0 -607
  295. data/lib/ronin/network/extensions/http.rb +0 -21
  296. data/lib/ronin/network/extensions/imap/net.rb +0 -119
  297. data/lib/ronin/network/extensions/imap.rb +0 -21
  298. data/lib/ronin/network/extensions/pop3/net.rb +0 -88
  299. data/lib/ronin/network/extensions/pop3.rb +0 -21
  300. data/lib/ronin/network/extensions/smtp/net.rb +0 -108
  301. data/lib/ronin/network/extensions/smtp.rb +0 -21
  302. data/lib/ronin/network/extensions/tcp/net.rb +0 -313
  303. data/lib/ronin/network/extensions/tcp.rb +0 -21
  304. data/lib/ronin/network/extensions/telnet/net.rb +0 -151
  305. data/lib/ronin/network/extensions/telnet.rb +0 -21
  306. data/lib/ronin/network/extensions/udp/net.rb +0 -224
  307. data/lib/ronin/network/extensions/udp.rb +0 -21
  308. data/lib/ronin/network/extensions.rb +0 -28
  309. data/lib/ronin/network/helpers/esmtp.rb +0 -129
  310. data/lib/ronin/network/helpers/imap.rb +0 -115
  311. data/lib/ronin/network/helpers/pop3.rb +0 -110
  312. data/lib/ronin/network/helpers/smtp.rb +0 -123
  313. data/lib/ronin/network/helpers/udp.rb +0 -197
  314. data/lib/ronin/network/helpers.rb +0 -29
  315. data/lib/ronin/network/http/http.rb +0 -214
  316. data/lib/ronin/network/http/proxy.rb +0 -308
  317. data/lib/ronin/network/http.rb +0 -23
  318. data/lib/ronin/network/smtp/email.rb +0 -142
  319. data/lib/ronin/network/smtp/smtp.rb +0 -67
  320. data/lib/ronin/network/smtp.rb +0 -23
  321. data/lib/ronin/network/tcp.rb +0 -21
  322. data/lib/ronin/network/telnet.rb +0 -108
  323. data/lib/ronin/network/udp.rb +0 -21
  324. data/lib/ronin/network.rb +0 -28
  325. data/lib/ronin/path.rb +0 -90
  326. data/lib/ronin/platform/extension.rb +0 -446
  327. data/lib/ronin/platform/extension_cache.rb +0 -143
  328. data/lib/ronin/platform/maintainer.rb +0 -69
  329. data/lib/ronin/platform/object_cache.rb +0 -124
  330. data/lib/ronin/platform/overlay.rb +0 -353
  331. data/lib/ronin/platform/overlay_cache.rb +0 -447
  332. data/lib/ronin/platform/platform.rb +0 -304
  333. data/lib/ronin/platform/ronin.rb +0 -97
  334. data/lib/ronin/platform/tasks/spec.rb +0 -9
  335. data/lib/ronin/platform.rb +0 -24
  336. data/lib/ronin/rpc/call.rb +0 -72
  337. data/lib/ronin/rpc/client.rb +0 -88
  338. data/lib/ronin/rpc/console.rb +0 -78
  339. data/lib/ronin/rpc/service.rb +0 -66
  340. data/lib/ronin/rpc/shell.rb +0 -63
  341. data/lib/ronin/rpc.rb +0 -24
  342. data/lib/ronin/scanners/exceptions/unknown_category.rb +0 -26
  343. data/lib/ronin/scanners/exceptions.rb +0 -21
  344. data/lib/ronin/scanners/scanner.rb +0 -295
  345. data/lib/ronin/scanners.rb +0 -22
  346. data/lib/ronin/static/finders.rb +0 -165
  347. data/lib/ronin/static/static.rb +0 -62
  348. data/lib/ronin/static.rb +0 -22
  349. data/lib/ronin/templates/erb.rb +0 -70
  350. data/lib/ronin/templates/template.rb +0 -130
  351. data/lib/ronin/templates.rb +0 -22
  352. data/lib/ronin/ui/command_line/command.rb +0 -216
  353. data/lib/ronin/ui/command_line/command_line.rb +0 -151
  354. data/lib/ronin/ui/command_line/commands/add.rb +0 -79
  355. data/lib/ronin/ui/command_line/commands/install.rb +0 -69
  356. data/lib/ronin/ui/command_line/commands/list.rb +0 -105
  357. data/lib/ronin/ui/command_line/commands/update.rb +0 -59
  358. data/lib/ronin/ui/command_line/exceptions.rb +0 -21
  359. data/lib/ronin/ui/command_line.rb +0 -22
  360. data/lib/ronin/ui/output/handler.rb +0 -121
  361. data/lib/ronin/yard/handlers/ruby/base.rb +0 -27
  362. data/lib/ronin/yard/handlers/ruby/belongs_to_handler.rb +0 -45
  363. data/lib/ronin/yard/handlers/ruby/eval_block_handler.rb +0 -18
  364. data/lib/ronin/yard/handlers/ruby/has_handler.rb +0 -49
  365. data/lib/ronin/yard/handlers/ruby/legacy/belongs_to_handler.rb +0 -41
  366. data/lib/ronin/yard/handlers/ruby/legacy/eval_block_handler.rb +0 -19
  367. data/lib/ronin/yard/handlers/ruby/legacy/has_handler.rb +0 -34
  368. data/lib/ronin/yard/handlers/ruby/legacy/metaclass_eval_handler.rb +0 -21
  369. data/lib/ronin/yard/handlers/ruby/legacy/property_handler.rb +0 -41
  370. data/lib/ronin/yard/handlers/ruby/legacy/scanner_handler.rb +0 -61
  371. data/lib/ronin/yard/handlers/ruby/legacy.rb +0 -26
  372. data/lib/ronin/yard/handlers/ruby/metaclass_eval_handler.rb +0 -18
  373. data/lib/ronin/yard/handlers/ruby/property_handler.rb +0 -45
  374. data/lib/ronin/yard/handlers/ruby/scanner_handler.rb +0 -66
  375. data/lib/ronin/yard/handlers/ruby.rb +0 -27
  376. data/lib/ronin/yard/handlers.rb +0 -24
  377. data/spec/cacheable_spec.rb +0 -150
  378. data/spec/classes/cacheable_model.rb +0 -15
  379. data/spec/code/classes/thing.rb +0 -17
  380. data/spec/code/reference_spec.rb +0 -63
  381. data/spec/code/symbol_table_spec.rb +0 -45
  382. data/spec/extensions/array_spec.rb +0 -34
  383. data/spec/extensions/classes/some_class.rb +0 -2
  384. data/spec/extensions/ip_addr_spec.rb +0 -44
  385. data/spec/extensions/kernel_spec.rb +0 -76
  386. data/spec/extensions/string_spec.rb +0 -103
  387. data/spec/extensions/uri/http_spec.rb +0 -9
  388. data/spec/extensions/uri/query_params_spec.rb +0 -46
  389. data/spec/formatting/binary/helpers/hexdumps/hexdump_decimal_shorts.txt +0 -17
  390. data/spec/formatting/binary/helpers/hexdumps/hexdump_hex_bytes.txt +0 -17
  391. data/spec/formatting/binary/helpers/hexdumps/hexdump_hex_shorts.txt +0 -17
  392. data/spec/formatting/binary/helpers/hexdumps/hexdump_octal_bytes.txt +0 -17
  393. data/spec/formatting/binary/helpers/hexdumps/hexdump_octal_shorts.txt +0 -17
  394. data/spec/formatting/binary/helpers/hexdumps/hexdump_repeated.txt +0 -6
  395. data/spec/formatting/binary/helpers/hexdumps/od_decimal_bytes.txt +0 -17
  396. data/spec/formatting/binary/helpers/hexdumps/od_decimal_ints.txt +0 -17
  397. data/spec/formatting/binary/helpers/hexdumps/od_decimal_quads.txt +0 -17
  398. data/spec/formatting/binary/helpers/hexdumps/od_decimal_shorts.txt +0 -17
  399. data/spec/formatting/binary/helpers/hexdumps/od_hex_bytes.txt +0 -17
  400. data/spec/formatting/binary/helpers/hexdumps/od_hex_ints.txt +0 -17
  401. data/spec/formatting/binary/helpers/hexdumps/od_hex_quads.txt +0 -17
  402. data/spec/formatting/binary/helpers/hexdumps/od_hex_shorts.txt +0 -17
  403. data/spec/formatting/binary/helpers/hexdumps/od_octal_bytes.txt +0 -17
  404. data/spec/formatting/binary/helpers/hexdumps/od_octal_ints.txt +0 -17
  405. data/spec/formatting/binary/helpers/hexdumps/od_octal_quads.txt +0 -17
  406. data/spec/formatting/binary/helpers/hexdumps/od_octal_shorts.txt +0 -17
  407. data/spec/formatting/binary/helpers/hexdumps/od_repeated.txt +0 -6
  408. data/spec/formatting/binary/helpers/hexdumps/repeated.bin +0 -1
  409. data/spec/formatting/binary/helpers/hexdumps.rb +0 -14
  410. data/spec/formatting/binary/integer_spec.rb +0 -131
  411. data/spec/formatting/binary/string_spec.rb +0 -251
  412. data/spec/formatting/digest/string_spec.rb +0 -80
  413. data/spec/formatting/http/string_spec.rb +0 -80
  414. data/spec/formatting/text/array_spec.rb +0 -64
  415. data/spec/formatting/text/string_spec.rb +0 -147
  416. data/spec/helpers/cacheable.rb +0 -7
  417. data/spec/helpers/contexts/ronin_cacheable_model.rb +0 -13
  418. data/spec/helpers/database.rb +0 -5
  419. data/spec/network/helpers/classes/test_helper.rb +0 -11
  420. data/spec/network/helpers/classes/uses_test_helper.rb +0 -10
  421. data/spec/network/helpers/helper_spec.rb +0 -25
  422. data/spec/network/http/http_spec.rb +0 -197
  423. data/spec/network/http/proxy_spec.rb +0 -116
  424. data/spec/path_spec.rb +0 -32
  425. data/spec/platform/extension_cache_spec.rb +0 -64
  426. data/spec/platform/extension_spec.rb +0 -73
  427. data/spec/platform/helpers/overlays/hello/hello/extension.rb +0 -7
  428. data/spec/platform/helpers/overlays/hello/lib/init.rb +0 -1
  429. data/spec/platform/helpers/overlays/hello/ronin.xml +0 -26
  430. data/spec/platform/helpers/overlays/random/random/extension.rb +0 -7
  431. data/spec/platform/helpers/overlays/random/ronin.xml +0 -26
  432. data/spec/platform/helpers/overlays/test1/ronin.xml +0 -26
  433. data/spec/platform/helpers/overlays/test1/test/extension.rb +0 -7
  434. data/spec/platform/helpers/overlays/test2/ronin.xml +0 -26
  435. data/spec/platform/helpers/overlays/test2/test/extension.rb +0 -7
  436. data/spec/platform/helpers/overlays.rb +0 -18
  437. data/spec/platform/helpers/overlays.yaml.erb +0 -13
  438. data/spec/platform/maintainer_spec.rb +0 -30
  439. data/spec/platform/overlay_cache_spec.rb +0 -65
  440. data/spec/platform/overlay_spec.rb +0 -63
  441. data/spec/platform/platform_spec.rb +0 -22
  442. data/spec/platform/ronin_spec.rb +0 -34
  443. data/spec/product_spec.rb +0 -23
  444. data/spec/scanners/classes/another_scanner.rb +0 -16
  445. data/spec/scanners/classes/example_scanner.rb +0 -22
  446. data/spec/scanners/scanner_spec.rb +0 -148
  447. data/spec/static/classes/static_class.rb +0 -7
  448. data/spec/static/finders_spec.rb +0 -55
  449. data/spec/static/helpers/static.rb +0 -10
  450. data/spec/static/helpers/static2/dir/two.txt +0 -0
  451. data/spec/static/static_spec.rb +0 -25
  452. data/spec/templates/classes/example_erb.rb +0 -11
  453. data/spec/templates/classes/example_template.rb +0 -21
  454. data/spec/templates/erb_spec.rb +0 -20
  455. data/spec/templates/helpers/static/templates/_relative.erb +0 -1
  456. data/spec/templates/helpers/static/templates/example.erb +0 -1
  457. data/spec/templates/helpers/static.rb +0 -5
  458. data/spec/templates/template_spec.rb +0 -41
  459. data/spec/ui/command_line/classes/test_command.rb +0 -23
  460. data/spec/ui/command_line/command_spec.rb +0 -31
  461. data/static/ronin/platform/overlay.xsl +0 -203
  462. data/tasks/spec.rb +0 -10
  463. data/tasks/yard.rb +0 -18
  464. data.tar.gz.sig +0 -0
  465. metadata.gz.sig +0 -0
@@ -1,214 +0,0 @@
1
- #
2
- # Ronin - A Ruby platform for exploit development and security research.
3
- #
4
- # Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
5
- #
6
- # This program 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 2 of the License, or
9
- # (at your option) any later version.
10
- #
11
- # This program 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 this program; if not, write to the Free Software
18
- # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19
- #
20
-
21
- require 'ronin/network/http/exceptions/unknown_request'
22
- require 'ronin/network/http/proxy'
23
- require 'ronin/network/extensions/http'
24
-
25
- module Ronin
26
- module Network
27
- module HTTP
28
- #
29
- # @return [Proxy]
30
- # The Ronin HTTP proxy hash.
31
- #
32
- def HTTP.proxy
33
- @@http_proxy ||= Proxy.new
34
- end
35
-
36
- #
37
- # @return [String, nil]
38
- # The default Ronin HTTP User-Agent.
39
- #
40
- def HTTP.user_agent
41
- @@http_user_agent ||= nil
42
- end
43
-
44
- #
45
- # Sets the default Ronin HTTP User-Agent.
46
- #
47
- # @param [String] agent
48
- # The new User-Agent string to use.
49
- #
50
- def HTTP.user_agent=(agent)
51
- @@http_user_agent = agent
52
- end
53
-
54
- #
55
- # Expands the given HTTP _options_.
56
- #
57
- # @param [Hash] options
58
- # HTTP options.
59
- #
60
- # @option options [String, URI::HTTP, URI::HTTPS] :url
61
- # The URL to request.
62
- #
63
- # @option options [String] :host
64
- # The host to connect to.
65
- #
66
- # @option options [String] :port (::Net::HTTP.default_port)
67
- # The port to connect to.
68
- #
69
- # @option options [String] :user
70
- # The user to authenticate as.
71
- #
72
- # @option options [String] :password
73
- # The password to authenticate with.
74
- #
75
- # @option options [String] :path ('/')
76
- # The path to request.
77
- #
78
- # @option options [String, Hash] :proxy (Ronin::Network::HTTP.proxy)
79
- # The Proxy information.
80
- #
81
- # @return [Hash]
82
- # The expanded version of _options_.
83
- #
84
- def HTTP.expand_options(options={})
85
- new_options = options.dup
86
-
87
- if new_options[:url]
88
- url = URI(new_options.delete(:url).to_s)
89
-
90
- new_options[:host] = url.host
91
- new_options[:port] = url.port
92
-
93
- new_options[:user] = url.user if url.user
94
- new_options[:password] = url.password if url.password
95
-
96
- unless url.path.empty?
97
- new_options[:path] = url.path
98
- else
99
- new_options[:path] = '/'
100
- end
101
-
102
- new_options[:path] << "?#{url.query}" if url.query
103
- else
104
- new_options[:port] ||= ::Net::HTTP.default_port
105
- new_options[:path] ||= '/'
106
- end
107
-
108
- if (proxy = new_options[:proxy])
109
- unless proxy.kind_of?(Hash)
110
- new_options[:proxy] = Ronin::Network::HTTP::Proxy.parse(proxy)
111
- end
112
- else
113
- new_options[:proxy] = Ronin::Network::HTTP.proxy
114
- end
115
-
116
- return new_options
117
- end
118
-
119
- #
120
- # Converts underscored, dashed, lowercase and uppercase HTTP headers
121
- # to standard camel-cased HTTP headers.
122
- #
123
- # @param [Hash{Symbol,String => String}] options
124
- # Ronin HTTP headers.
125
- #
126
- # @return [Hash]
127
- # The camel-cased HTTP headers created from the given _options_.
128
- #
129
- def HTTP.headers(options={})
130
- headers = {}
131
-
132
- if HTTP.user_agent
133
- headers['User-Agent'] = HTTP.user_agent
134
- end
135
-
136
- if options
137
- options.each do |name,value|
138
- header_name = name.to_s.split(/[\s+_-]/).map { |word|
139
- word.capitalize
140
- }.join('-')
141
-
142
- headers[header_name] = value.to_s
143
- end
144
- end
145
-
146
- return headers
147
- end
148
-
149
- #
150
- # Creates an HTTP request object with the specified _type_ and
151
- # given _options_. If type does not represent the name of an Net:HTTP
152
- # Request Class an UnknownRequest exception will be raised.
153
- #
154
- # @param [Hash] options
155
- # The HTTP options for the request.
156
- #
157
- # @option options [Symbol, String] :method
158
- # The HTTP method to use for the request.
159
- #
160
- # @option options [String] :path ('/')
161
- # The path to request.
162
- #
163
- # @option options [String] :user
164
- # The user to authenticate as.
165
- #
166
- # @option options [String] :password
167
- # The password to authenticate with.
168
- #
169
- # @option options [Hash{Symbol,String => String}] :headers
170
- # Additional HTTP headers to use for the request.
171
- #
172
- # @return [HTTP::Request]
173
- # The new HTTP Request object.
174
- #
175
- # @raise [ArgumentError]
176
- # The +:method+ option must be specified.
177
- #
178
- # @raise [UnknownRequest]
179
- # The +:method+ option did not match a known Net::HTTP request
180
- # class.
181
- #
182
- # @see HTTP.expand_options
183
- #
184
- def HTTP.request(options={})
185
- unless options[:method]
186
- raise(ArgumentError,"the :method option must be specified",caller)
187
- end
188
-
189
- name = options[:method].to_s.capitalize
190
-
191
- unless Net::HTTP.const_defined?(name)
192
- raise(UnknownRequest,"unknown HTTP request type #{name.dump}",caller)
193
- end
194
-
195
- headers = HTTP.headers(options[:headers])
196
- path = (options[:path] || '/').to_s
197
-
198
- request = Net::HTTP.const_get(name).new(path,headers)
199
-
200
- if (user = options.delete(:user))
201
- user = user.to_s
202
-
203
- if (password = options.delete(:password))
204
- password = password.to_s
205
- end
206
-
207
- request.basic_auth(user,password)
208
- end
209
-
210
- return request
211
- end
212
- end
213
- end
214
- end
@@ -1,308 +0,0 @@
1
- #
2
- # Ronin - A Ruby platform for exploit development and security research.
3
- #
4
- # Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
5
- #
6
- # This program 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 2 of the License, or
9
- # (at your option) any later version.
10
- #
11
- # This program 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 this program; if not, write to the Free Software
18
- # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19
- #
20
-
21
- module Ronin
22
- module Network
23
- module HTTP
24
- class Proxy < Hash
25
-
26
- # The default port of proxies
27
- DEFAULT_PORT = 8080
28
-
29
- #
30
- # Creates a new Proxy object that represents a proxy to connect to.
31
- #
32
- # @param [Hash] options
33
- # Additional options for the proxy.
34
- #
35
- # @option options [String] :host
36
- # The host-name of the proxy.
37
- #
38
- # @option options [Integer] :port (DEFAULT_PORT)
39
- # The port that the proxy is running on.
40
- # @option options [String] :user
41
- # The user-name to authenticate as.
42
- # @option options [String] :password
43
- # The password to authenticate with.
44
- #
45
- def initialize(options={})
46
- super()
47
-
48
- self[:host] = options[:host]
49
- self[:port] = (options[:port] || DEFAULT_PORT)
50
- self[:user] = options[:user]
51
- self[:password] = options[:password]
52
- end
53
-
54
- #
55
- # Parses a proxy URL.
56
- #
57
- # @param [String, URI::HTTP] proxy
58
- # The proxy URL in String form.
59
- #
60
- # @return [Proxy]
61
- # The parsed proxy information.
62
- #
63
- # @example
64
- # Proxy.parse('217.31.51.77:443')
65
- #
66
- # @example
67
- # Proxy.parse('joe:lol@127.0.0.1:8080')
68
- #
69
- # @example
70
- # Proxy.parse('http://201.26.192.61:8080')
71
- #
72
- def Proxy.parse(proxy)
73
- proxy = proxy.to_s.gsub(/^http(s)?:\/*/,'')
74
-
75
- if proxy.include?('@')
76
- auth, proxy = proxy.split('@',2)
77
- user, password = auth.split(':')
78
- else
79
- user = nil
80
- password = nil
81
- end
82
-
83
- host, port = proxy.split(':',2)
84
- port = port.to_i if port
85
-
86
- return Proxy.new(
87
- :host => host,
88
- :port => port,
89
- :user => user,
90
- :password => password
91
- )
92
- end
93
-
94
- #
95
- # Tests the proxy.
96
- #
97
- # @return [Boolean]
98
- # Specifies if the proxy can proxy requests.
99
- #
100
- def valid?
101
- begin
102
- Net.http_get_body(
103
- :url => 'http://www.example.com/',
104
- :proxy => self
105
- ).include?('Example Web Page')
106
- rescue Timeout::Error, StandardError
107
- return false
108
- end
109
- end
110
-
111
- #
112
- # Measures the lag of the proxy.
113
- #
114
- # @return [Float]
115
- # The extra number of seconds it takes the proxy to process the
116
- # request.
117
- #
118
- def lag
119
- time = lambda { |proxy|
120
- t1 = Time.now
121
- Net.http_head(
122
- :url => 'http://www.example.com/',
123
- :proxy => proxy
124
- )
125
- t2 = Time.now
126
-
127
- (t2 - t1)
128
- }
129
-
130
- begin
131
- return (time.call(self) - time.call(nil))
132
- rescue Timeout::Error, StandardError
133
- return (1.0/0)
134
- end
135
- end
136
-
137
- #
138
- # Disables the Proxy object.
139
- #
140
- def disable!
141
- self[:host] = nil
142
- self[:port] = DEFAULT_PORT
143
- self[:user] = nil
144
- self[:password] = nil
145
-
146
- return self
147
- end
148
-
149
- #
150
- # Specifies whether the proxy object is usable.
151
- #
152
- # @return [Boolean]
153
- # Specifies whether the proxy object is usable by
154
- # Net::HTTP::Proxy.
155
- #
156
- def enabled?
157
- !(self[:host].nil? || self[:port].nil?)
158
- end
159
-
160
- #
161
- # @return [String, nil]
162
- # The host-name to connect when using the proxy.
163
- #
164
- def host
165
- self[:host]
166
- end
167
-
168
- #
169
- # Set the host-name of the proxy.
170
- #
171
- # @param [String] new_host
172
- # The new host-name to use.
173
- #
174
- # @return [String]
175
- # The new host-name to use.
176
- #
177
- def host=(new_host)
178
- self[:host] = new_host.to_s
179
- end
180
-
181
- #
182
- # @return [Integer]
183
- # The port to connect when using the proxy.
184
- #
185
- def port
186
- self[:port]
187
- end
188
-
189
- #
190
- # Set the port of the proxy.
191
- #
192
- # @param [Integer] new_port
193
- # The new port to use.
194
- #
195
- # @return [Integer]
196
- # The new port to use.
197
- #
198
- def port=(new_port)
199
- self[:port] = new_port.to_i
200
- end
201
-
202
- #
203
- # @return [String, nil]
204
- # The user-name to authenticate as, when using the proxy.
205
- #
206
- def user
207
- self[:user]
208
- end
209
-
210
- #
211
- # Set the user-name to authenticate as with the proxy.
212
- #
213
- # @param [String] new_user
214
- # The new user-name to use.
215
- #
216
- # @return [Integer]
217
- # The new user-name to use.
218
- #
219
- def user=(new_user)
220
- self[:user] = new_user.to_s
221
- end
222
-
223
- #
224
- # @return [String, nil]
225
- # The password to authenticate with, when using the proxy.
226
- #
227
- def password
228
- self[:password]
229
- end
230
-
231
- #
232
- # Set the password to authenticate with for the proxy.
233
- #
234
- # @param [String] new_user
235
- # The new user-name to use.
236
- #
237
- # @return [Integer]
238
- # The new user-name to use.
239
- #
240
- def password=(new_password)
241
- self[:password] = new_password.to_s
242
- end
243
-
244
- #
245
- # Builds a HTTP URI from the proxy information.
246
- #
247
- # @return [URI::HTTP, nil]
248
- # The HTTP URI representing the proxy. If the proxy is disabled,
249
- # then +nil+ will be returned.
250
- #
251
- def url
252
- return nil unless enabled?
253
-
254
- userinfo = if self[:user]
255
- if self[:password]
256
- "#{self[:user]}:#{self[:password]}"
257
- else
258
- self[:user]
259
- end
260
- end
261
-
262
- return URI::HTTP.build({
263
- :userinfo => userinfo,
264
- :host => self[:host],
265
- :port => self[:port]
266
- })
267
- end
268
-
269
- #
270
- # Converts the proxy object to a String.
271
- #
272
- # @return [String]
273
- # The host-name of the proxy.
274
- #
275
- def to_s
276
- self[:host].to_s
277
- end
278
-
279
- #
280
- # Inspects the proxy object.
281
- #
282
- # @return [String]
283
- # The inspection of the proxy object.
284
- #
285
- def inspect
286
- unless (self[:host] || self[:port])
287
- str = 'disabled'
288
- else
289
- str = "#{self[:host]}:#{self[:port]}"
290
-
291
- if self[:user]
292
- auth_str = self[:user]
293
-
294
- if self[:password]
295
- auth_str = "#{auth_str}:#{self[:password]}"
296
- end
297
-
298
- str = "#{auth_str}@#{str}"
299
- end
300
- end
301
-
302
- return "#<#{self.class}: #{str}>"
303
- end
304
-
305
- end
306
- end
307
- end
308
- end
@@ -1,23 +0,0 @@
1
- #
2
- # Ronin - A Ruby platform for exploit development and security research.
3
- #
4
- # Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
5
- #
6
- # This program 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 2 of the License, or
9
- # (at your option) any later version.
10
- #
11
- # This program 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 this program; if not, write to the Free Software
18
- # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19
- #
20
-
21
- require 'ronin/network/http/exceptions'
22
- require 'ronin/network/http/http'
23
- require 'ronin/network/extensions/http'
@@ -1,142 +0,0 @@
1
- #
2
- # Ronin - A Ruby platform for exploit development and security research.
3
- #
4
- # Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
5
- #
6
- # This program 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 2 of the License, or
9
- # (at your option) any later version.
10
- #
11
- # This program 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 this program; if not, write to the Free Software
18
- # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19
- #
20
-
21
- module Ronin
22
- module Network
23
- module SMTP
24
- class Email
25
-
26
- # Sender of the email
27
- attr_accessor :from
28
-
29
- # Recipient of the email
30
- attr_accessor :to
31
-
32
- # Subject of the email
33
- attr_accessor :subject
34
-
35
- # Date of the email
36
- attr_accessor :date
37
-
38
- # Unique message-id string
39
- attr_accessor :message_id
40
-
41
- # Body of the email
42
- attr_accessor :body
43
-
44
- #
45
- # Creates a new Email object.
46
- #
47
- # @param [Hash] options
48
- # Additional options.
49
- #
50
- # @option options [String] :from
51
- # The address the email is from.
52
- #
53
- # @option options [String] :to
54
- # The address that the email should be sent to.
55
- #
56
- # @option options [String] :subject
57
- # The subject of the email.
58
- #
59
- # @option options [String] :message_id
60
- # Message-ID of the email.
61
- #
62
- # @option options [String, Time] :date (Time.now)
63
- # The date the email was sent on.
64
- #
65
- # @option options [String, Array<String>] :body
66
- # The body of the email.
67
- #
68
- # @yield [email]
69
- # If a block is given, it will be passed the newly created email
70
- # object.
71
- #
72
- # @yieldparam [Email] email
73
- # The newly created email object.
74
- #
75
- def initialize(options={},&block)
76
- @from = options[:from]
77
- @to = options[:to]
78
- @subject = options[:subject]
79
- @date = options[:date] || Time.now
80
- @message_id = options[:message_id]
81
- @body = []
82
-
83
- if options[:body].kind_of?(Array)
84
- @body += options[:body]
85
- else
86
- @body << options[:body]
87
- end
88
-
89
- block.call(self) if block
90
- end
91
-
92
- #
93
- # Formats the email into a SMTP message.
94
- #
95
- # @return [String]
96
- # Properly formatted SMTP message.
97
- #
98
- # @see http://www.ruby-doc.org/stdlib/libdoc/net/smtp/rdoc/classes/Net/SMTP.html
99
- #
100
- def to_s
101
- address = lambda { |info|
102
- if info.kind_of?(Array)
103
- return "#{info[0]} <#{info[1]}>"
104
- elsif info.kind_of?(Hash)
105
- return "#{info[:name]} <#{info[:email]}>"
106
- else
107
- return info
108
- end
109
- }
110
-
111
- message = []
112
-
113
- if @from
114
- message << "From: #{address.call(@from)}"
115
- end
116
-
117
- if @to
118
- message << "To: #{address.call(@to)}"
119
- end
120
-
121
- if @subject
122
- message << "Subject: #{@subject}"
123
- end
124
-
125
- if @date
126
- message << "Date: #{@date}"
127
- end
128
-
129
- if @message_id
130
- message << "Message-Id: <#{@message_id}>"
131
- end
132
-
133
- message << ''
134
- message += @body
135
-
136
- return message.join("\n")
137
- end
138
-
139
- end
140
- end
141
- end
142
- end