ronin 0.2.4 → 0.3.0

data/History.txt

@@ -1,3 +1,98 @@
+=== 0.3.0 / 2009-09-24
+
+* Require yard >= 0.2.3.5.
+* Require nokogiri >= 1.3.3.
+* Require extlib >= 0.9.13.
+* Require data_objects >= 0.10.0.
+* Require do_sqlite3 >= 0.10.0.
+* Require dm-core >= 0.10.0.
+* Require dm-types >= 0.10.0.
+* Require dm-validations >= 0.10.0.
+* Require dm-predefined >= 0.2.0.
+* Require chars >= 0.1.2.
+* Require parameters >= 0.1.8.
+* Require contextify >= 0.1.3.
+* Require repertoire >= 0.2.3.
+* Require thor >= 0.11.5.
+* Require rspec >= 1.1.12.
+* Moved to YARD based documentation.
+* Added YARD handlers for detecting DataMapper property, has and belongs_to
+  method-calles.
+* Added YARD handlers for detecting Ronin::Scanners::Scanner.scanner
+  method-calles.
+* Added Ronin::Config.tmp_dir.
+* Added Kernel.require_within.
+* Added Net.tcp_server.
+* Added Net.tcp_server_session.
+* Added Net.tcp_single_server.
+* Added Net.udp_server.
+* Added Net.udp_server_session.
+* Added Ronin::Network::HTTP::Proxy.
+* Added Ronin::Model#humanize_attributes.
+* Added Ronin::Model::HasVersion.revision.
+* Added Ronin::Templates::Template.
+* Added Ronin::Platform::Overlays#gems.
+* Added attr_reader, attr_writer and attr_accessor instance methods to
+  Ronin::Platform::Extension.
+* Added Ronin::Platform::Overlay#load!.
+* Added Ronin::Platform::Overlay#reload!.
+* Added Ronin::Platform::Extension#tmp_dir.
+* Added Ronin::Platform::ExtensionCache#reload!.
+* Added Ronin::Platform.reload!.
+* Added Ronin::UI::Output.verbose=.
+* Added Ronin::UI::Output.verbose?.
+* Added Ronin::UI::Output.quiet=.
+* Added Ronin::UI::Output.quiet?.
+* Added Ronin::UI::Output.silent=.
+* Added Ronin::UI::Output.silent?.
+* Added Ronin::UI::Output::Helpers.
+* Added Ronin::UI::CommandLine::Command#indent.
+* Added Ronin::UI::CommandLine::Command#print_title.
+* Added Ronin::UI::CommandLine::Command#print_array.
+* Added Ronin::UI::CommandLine::Command#print_hash.
+* Renamed Ronin::License.gpl_2 to Ronin::License.gpl2.
+* Renamed Ronin::License.gpl_3 to Ronin::License.gpl3.
+* Renamed Ronin::License.lgpl_3 to Ronin::License.lgpl3.
+* Renamed the :post_data option to :postdata for the Net.http_post and
+  Net.http_post_body methods.
+* Renamed Ronin::Sessions to Ronin::Network::Helpers.
+* Renamed Ronin::Platform::ExtensionCache#has_extension? to
+  Ronin::Platform::ExtensionCache#has?.
+* Renamed Ronin::Platform::ExtensionCache#extension_with to
+  Ronin::Platform::ExtensionCache#with.
+* Renamed Ronin::UI::Diagnostics to Ronin::UI::Output.
+* Removed Hash#explode.
+* Removed URI::HTTP#explode_query_params and URI::HTTP#test_query_params.
+* Removed Ronin::Model.first_or_new, since it is provided by
+  dm-core 0.10.0.
+* Removed Ronin.console.
+* Removed Ronin::License.predefine.
+* Updated the summary and 3-point description of Ronin.
+* Aliased Integer#char to Integer#chr.
+* Changed Ronin::Database::DEFAULT_CONFIG to be a String, for printability.
+* Overrode Ronin::Model.allocate so that the initialize method of models
+  is always called when resources are allocated.
+* Improved the white-space removal in Ronin::Model::HasDescription.
+* Have Ronin::Model::HasLicense auto-define a relationship with
+  Ronin::License.
+* Fixed formatting issue in Ronin::Product#to_s.
+* Allow Ronin::Cacheable.load_first to accept a block.
+* Make sure Ronin::Static.directory raises a RuntimeError if the given
+  directory is missing or not a directory.
+* Allow the :proxy option passed to Net.http_* methods to be a String,
+  Hash or Ronin::Network::HTTP::Proxy.
+* Make sure Ronin::Network::Helpers::Helper.require_variable raises
+  a RuntimeError if the required instance variable is not set.
+* Merged Ronin::Platform::Extension.load into
+  Ronin::Platform::ExtensionCache#load_extension.
+* Updated the overlay.xsl used to render the ronin.xml files within
+  Overlays.
+* Merged Ronin::UI::Verbose into Ronin::UI::Output.
+* Rewrote Ronin::UI::CommandLine::Command to inherit from Thor.
+* Rewrote the Ronin::UI::CommandLine commands to use Thor options.
+* Include Ronin::UI::Output::Helpers into Ronin::Sessions::Session.
+* Include Ronin::UI::Output::Helpers into Ronin::Console sessions.
+
 === 0.2.4 / 2009-07-02
 
 * Require Hoe >= 2.0.0

data/Manifest.txt

@@ -2,7 +2,6 @@ History.txt
 COPYING.txt
 Manifest.txt
 README.txt
-TODO.txt
 Rakefile
 bin/ronin
 bin/ronin-add
@@ -19,13 +18,13 @@ lib/ronin/static.rb
 lib/ronin/static/static.rb
 lib/ronin/static/finders.rb
 lib/ronin/templates.rb
+lib/ronin/templates/template.rb
 lib/ronin/templates/erb.rb
 lib/ronin/extensions.rb
 lib/ronin/extensions/meta.rb
 lib/ronin/extensions/meta/object.rb
 lib/ronin/extensions/kernel.rb
 lib/ronin/extensions/array.rb
-lib/ronin/extensions/hash.rb
 lib/ronin/extensions/uri.rb
 lib/ronin/extensions/uri/query_params.rb
 lib/ronin/extensions/uri/http.rb
@@ -68,6 +67,16 @@ lib/ronin/network/extensions/telnet.rb
 lib/ronin/network/extensions/telnet/net.rb
 lib/ronin/network/extensions/http.rb
 lib/ronin/network/extensions/http/net.rb
+lib/ronin/network/helpers.rb
+lib/ronin/network/helpers/helper.rb
+lib/ronin/network/helpers/tcp.rb
+lib/ronin/network/helpers/udp.rb
+lib/ronin/network/helpers/smtp.rb
+lib/ronin/network/helpers/esmtp.rb
+lib/ronin/network/helpers/pop3.rb
+lib/ronin/network/helpers/imap.rb
+lib/ronin/network/helpers/telnet.rb
+lib/ronin/network/helpers/http.rb
 lib/ronin/network/tcp.rb
 lib/ronin/network/udp.rb
 lib/ronin/network/smtp.rb
@@ -80,6 +89,8 @@ lib/ronin/network/telnet.rb
 lib/ronin/network/http.rb
 lib/ronin/network/http/exceptions.rb
 lib/ronin/network/http/exceptions/unknown_request.rb
+lib/ronin/network/http/proxy.rb
+lib/ronin/network/http/http.rb
 lib/ronin/code/emittable.rb
 lib/ronin/code/token.rb
 lib/ronin/code/reference.rb
@@ -98,18 +109,6 @@ lib/ronin/scanners.rb
 lib/ronin/scanners/exceptions.rb
 lib/ronin/scanners/exceptions/unknown_category.rb
 lib/ronin/scanners/scanner.rb
-lib/ronin/sessions.rb
-lib/ronin/sessions/exceptions.rb
-lib/ronin/sessions/exceptions/variable_missing.rb
-lib/ronin/sessions/session.rb
-lib/ronin/sessions/tcp.rb
-lib/ronin/sessions/udp.rb
-lib/ronin/sessions/smtp.rb
-lib/ronin/sessions/esmtp.rb
-lib/ronin/sessions/pop3.rb
-lib/ronin/sessions/imap.rb
-lib/ronin/sessions/telnet.rb
-lib/ronin/sessions/http.rb
 lib/ronin/database.rb
 lib/ronin/database/exceptions.rb
 lib/ronin/database/exceptions/invalid_config.rb
@@ -142,8 +141,10 @@ lib/ronin/platform/extension.rb
 lib/ronin/platform/platform.rb
 lib/ronin/platform/ronin.rb
 lib/ronin/ui.rb
-lib/ronin/ui/verbose.rb
-lib/ronin/ui/diagnostics.rb
+lib/ronin/ui/output.rb
+lib/ronin/ui/output/handler.rb
+lib/ronin/ui/output/helpers.rb
+lib/ronin/ui/output/output.rb
 lib/ronin/ui/hexdump.rb
 lib/ronin/ui/hexdump/hexdump.rb
 lib/ronin/ui/hexdump/extensions.rb
@@ -155,7 +156,6 @@ lib/ronin/ui/command_line.rb
 lib/ronin/ui/command_line/exceptions.rb
 lib/ronin/ui/command_line/exceptions/unknown_command.rb
 lib/ronin/ui/command_line/command.rb
-lib/ronin/ui/command_line/options.rb
 lib/ronin/ui/command_line/commands/console.rb
 lib/ronin/ui/command_line/commands/add.rb
 lib/ronin/ui/command_line/commands/install.rb
@@ -165,9 +165,26 @@ lib/ronin/ui/command_line/commands/remove.rb
 lib/ronin/ui/command_line/commands/uninstall.rb
 lib/ronin/ui/command_line/commands/help.rb
 lib/ronin/ui/command_line/command_line.rb
-lib/ronin/ronin.rb
+lib/ronin/yard.rb
+lib/ronin/yard/handlers.rb
+lib/ronin/yard/handlers/ruby.rb
+lib/ronin/yard/handlers/ruby/base.rb
+lib/ronin/yard/handlers/ruby/eval_block_handler.rb
+lib/ronin/yard/handlers/ruby/metaclass_eval_handler.rb
+lib/ronin/yard/handlers/ruby/property_handler.rb
+lib/ronin/yard/handlers/ruby/belongs_to_handler.rb
+lib/ronin/yard/handlers/ruby/has_handler.rb
+lib/ronin/yard/handlers/ruby/scanner_handler.rb
+lib/ronin/yard/handlers/ruby/legacy.rb
+lib/ronin/yard/handlers/ruby/legacy/eval_block_handler.rb
+lib/ronin/yard/handlers/ruby/legacy/metaclass_eval_handler.rb
+lib/ronin/yard/handlers/ruby/legacy/property_handler.rb
+lib/ronin/yard/handlers/ruby/legacy/belongs_to_handler.rb
+lib/ronin/yard/handlers/ruby/legacy/has_handler.rb
+lib/ronin/yard/handlers/ruby/legacy/scanner_handler.rb
 lib/ronin/version.rb
 tasks/spec.rb
+tasks/yard.rb
 spec/spec_helper.rb
 spec/classes/cacheable_model.rb
 spec/helpers/database.rb
@@ -180,13 +197,18 @@ spec/static/helpers/static2/dir/two.txt
 spec/static/helpers/static.rb
 spec/static/finders_spec.rb
 spec/static/static_spec.rb
-spec/templates/classes/uses_erb.rb
+spec/templates/classes/example_template.rb
+spec/templates/classes/example_erb.rb
+spec/templates/helpers/static.rb
+spec/templates/helpers/static/templates/example.erb
+spec/templates/helpers/static/templates/_relative.erb
+spec/templates/template_spec.rb
 spec/templates/erb_spec.rb
 spec/arch_spec.rb
 spec/author_spec.rb
+spec/extensions/classes/some_class.rb
 spec/extensions/kernel_spec.rb
 spec/extensions/array_spec.rb
-spec/extensions/hash_spec.rb
 spec/extensions/string_spec.rb
 spec/extensions/ip_addr_spec.rb
 spec/extensions/uri/http_spec.rb
@@ -218,11 +240,20 @@ spec/formatting/digest/string_spec.rb
 spec/formatting/http/string_spec.rb
 spec/formatting/text/string_spec.rb
 spec/formatting/text/array_spec.rb
-spec/network/http_spec.rb
+spec/network/helpers/classes/test_helper.rb
+spec/network/helpers/classes/uses_test_helper.rb
+spec/network/helpers/helper_spec.rb
+spec/network/http/proxy_spec.rb
+spec/network/http/http_spec.rb
 spec/code/classes/thing.rb
 spec/code/reference_spec.rb
 spec/code/symbol_table_spec.rb
+spec/model/classes/basic_model.rb
+spec/model/classes/custom_model.rb
+spec/model/classes/described_model.rb
 spec/model/classes/licensed_model.rb
+spec/model/model_spec.rb
+spec/model/has_description_spec.rb
 spec/model/has_license_spec.rb
 spec/license_spec.rb
 spec/path_spec.rb
@@ -232,9 +263,6 @@ spec/cacheable_spec.rb
 spec/scanners/classes/example_scanner.rb
 spec/scanners/classes/another_scanner.rb
 spec/scanners/scanner_spec.rb
-spec/sessions/classes/test_session.rb
-spec/sessions/classes/uses_test_session.rb
-spec/sessions/session_spec.rb
 spec/platform/helpers/overlays.rb
 spec/platform/helpers/overlays.yaml.erb
 spec/platform/helpers/overlays/test1/ronin.xml
@@ -255,6 +283,8 @@ spec/platform/overlay_cache_spec.rb
 spec/platform/extension_cache_spec.rb
 spec/platform/platform_spec.rb
 spec/platform/ronin_spec.rb
-spec/ui/verbose_spec.rb
+spec/ui/output_spec.rb
+spec/ui/command_line/classes/test_command.rb
+spec/ui/command_line/command_spec.rb
 spec/ronin_spec.rb
 static/ronin/platform/overlay.xsl

data/README.txt

@@ -2,37 +2,35 @@
 
 * http://ronin.rubyforge.org/
 * http://github.com/postmodern/ronin
-* irc.freenode.net ##ronin
+* irc.freenode.net #ronin
 * Postmodern (postmodern.mod3 at gmail.com)
 
 == DESCRIPTION:
 
-Ronin is a Ruby platform designed for information security and data
-exploration tasks. Ronin allows for the rapid development and distribution
-of code over many of the common Source-Code-Management (SCM) systems.
+Ronin is a Ruby platform for exploit development and security research.
+Ronin allows for the rapid development and distribution of code, exploits
+or payloads over many common Source-Code-Management (SCM) systems.
 
-=== Free
+=== Ruby
 
-All source code within Ronin is licensed under the GPL-2, therefore no user
-will ever have to pay for Ronin or updates to Ronin. Not only is the
-source code free, the Ronin project will not sell enterprise grade security
-snake-oil solutions, give private training classes or later turn Ronin into
-commercial software.
+Ronin's Ruby environment allows security researchers to leverage Ruby with
+ease. The Ruby environment contains a multitude of convenience methods
+for working with data in Ruby, a Ruby Object Database, a customized Ruby
+Console and an extendable command-line interface.
 
-=== Modular
+=== Extend
 
-Ronin was not designed as one monolithic framework but instead as a
-collection of libraries which can be individually installed. This allows
-users to pick and choose what functionality they want in Ronin.
+Ronin's more specialized features are provided by additional Ronin
+libraries, which users can choose to install. These libraries can allow
+one to write and run Exploits and Payloads, scan for PHP vulnerabilities,
+perform Google Dorks  or run 3rd party scanners.
 
-=== Decentralized
+=== Publish
 
-Ronin does not have a central repository of exploits and payloads which
-all developers contribute to. Instead Ronin has Overlays, repositories of
-code that can be hosted on any SVN/Hg/Git/Rsync server. Users can then use
-Ronin to quickly install or update Overlays. This allows developers and
-users to form their own communities, independent of the main developers
-of Ronin.
+Ronin allows users to publish and share code, exploits, payloads or other
+data via Overlays. Overlays are directories of code and data that can be
+hosted on any SVN, Hg, Git or Rsync server. Ronin makes it easy to create,
+install or update Overlays.
 
 == FEATURES:
 
@@ -43,8 +41,8 @@ of Ronin.
     * Git
     * Rsync
 * Allows for the loading of Extensions from one or more Overlays.
-* Provides persistent storage of objects using DataMapper.
-* Caches and mirrors objects stored in Overlays using DataMapper.
+* Provides Object Database using DataMapper.
+* Caches and mirrors Objects stored in Overlays using DataMapper.
 * Provides convenience methods for:
   * Formatting data:
     * Binary
@@ -55,44 +53,29 @@ of Ronin.
   * Networking:
     * TCP
     * UDP
-    * SMTP
-    * POP
+    * SMTP / ESMTP
+    * POP3
     * Imap
     * Telnet
     * HTTP / HTTPS
-* Provides an IRB styled console with:
+  * Enumerating IP ranges:
+    * IPv4 / IPv6 addresses.
+    * CIDR / globbed ranges.
+  * (Un-)Hexdumping data.
+  * Handling exceptions.
+* Provides a customized Ruby Console with:
   * Tab-completion enabled.
   * Auto-indentation enabled.
   * Pretty-Print loaded.
-
-== REQUIREMENTS:
-
-* {libxml2}[http://xmlsoft.org/]
-* {libsqlite3}[http://sqlite.org/]
-* {nokogiri}[http://nokogiri.rubyforge.org/] >= 1.2.0
-* {DataMapper}[http://datamapper.org/]:
-  * extlib >= 0.9.12
-  * dm-core >= 0.9.11
-  * data_objects >= 0.9.11
-  * do_sqlite3 >= 0.9.11
-  * dm-types >= 0.9.11
-  * dm-serializer >= 0.9.11
-  * dm-validations >= 0.9.11
-* {dm-prefined}[http://dm-predefined.rubyforge.org/] >= 0.1.0
-* {parameters}[http://parameters.rubyforge.org/] >= 0.1.5
-* {contextify}[http://contextify.rubyforge.org/] >= 0.1.2
-* {reverse-require}[http://reverserequire.rubyforge.org/] >= 0.3.1
-* {repertoire}[http://repertoire.rubyforge.org/] >= 0.2.1
-
-== INSTALL:
-
-  $ sudo gem install ronin
+  * print_info, print_error, print_warning and print_debug output helper
+    methods with color-output.
+* Provides an extendable command-line interface based on Thor.
 
 == SYNOPSIS:
 
 * Install an Overlay:
 
-    $ ronin install svn://example.com/var/svn/overlay
+    $ ronin install svn://example.com/path/to/overlay
 
 * List installed Overlays:
 
@@ -114,6 +97,36 @@ of Ronin.
 
     $ ronin
 
+* View available commands:
+
+    $ ronin help
+
+== REQUIREMENTS:
+
+* {yard}[http://yard.soen.ca/] >= 0.2.3.5
+* {nokogiri}[http://nokogiri.rubyforge.org/] >= 1.3.3
+  * {libxml2}[http://xmlsoft.org/]
+  * {libxslt1}[http://xmlsoft.org/XSLT/]
+* {DataMapper}[http://datamapper.org/]:
+  * extlib >= 0.9.13
+  * dm-core >= 0.10.0
+  * data_objects >= 0.10.0
+  * do_sqlite3 >= 0.10.0
+    * {libsqlite3}[http://sqlite.org/]
+  * dm-types >= 0.10.0
+  * dm-validations >= 0.10.0
+* {dm-predefined}[http://dm-predefined.rubyforge.org/] >= 0.2.0
+* {chars}[http://chars.rubyforge.org/] >= 0.1.2
+* {parameters}[http://parameters.rubyforge.org/] >= 0.1.8
+* {contextify}[http://contextify.rubyforge.org/] >= 0.1.3
+* {reverse-require}[http://reverserequire.rubyforge.org/] >= 0.3.1
+* {repertoire}[http://repertoire.rubyforge.org/] >= 0.2.3
+* thor >= 0.11.5
+
+== INSTALL:
+
+  $ sudo gem install ronin
+
 == RONIN LIBRARIES:
 
 === Ronin ASM
@@ -174,8 +187,7 @@ scraping and spidering functionality.
 
 == LICENSE:
 
-Ronin - A Ruby platform designed for information security and data
-exploration tasks.
+Ronin - A Ruby platform for exploit development and security research.
 
 Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
 

data/Rakefile

@@ -4,28 +4,35 @@ require 'rubygems'
 require 'hoe'
 require 'hoe/signing'
 require './tasks/spec.rb'
+require './tasks/yard.rb'
 
 Hoe.spec('ronin') do
   self.rubyforge_name = 'ronin'
   self.developer('Postmodern','postmodern.mod3@gmail.com')
   self.remote_rdoc_dir = 'docs/ronin'
   self.extra_deps = [
-    ['hoe', '>=2.0.0'],
-    ['nokogiri', '>=1.2.0'],
-    ['addressable', '=2.0.2'],
-    ['extlib', '>=0.9.12'],
-    ['data_objects', '>=0.9.12'],
-    ['do_sqlite3', '>=0.9.12'],
-    ['dm-core', '>=0.9.11'],
-    ['dm-types', '>=0.9.11'],
-    ['dm-validations', '>=0.9.11'],
-    ['dm-predefined', '>=0.1.1'],
-    ['chars', '>=0.1.1'],
-    ['parameters', '>=0.1.7'],
-    ['contextify', '>=0.1.2'],
+    ['yard', '>=0.2.3.5'],
+    ['nokogiri', '>=1.3.3'],
+    ['extlib', '>=0.9.13'],
+    ['data_objects', '>=0.10.0'],
+    ['do_sqlite3', '>=0.10.0'],
+    ['dm-core', '>=0.10.0'],
+    ['dm-types', '>=0.10.0'],
+    ['dm-validations', '>=0.10.0'],
+    ['dm-predefined', '>=0.2.0'],
+    ['chars', '>=0.1.2'],
+    ['parameters', '>=0.1.8'],
+    ['contextify', '>=0.1.3'],
     ['reverse-require', '>=0.3.1'],
-    ['repertoire', '>=0.2.1']
+    ['repertoire', '>=0.2.3'],
+    ['thor', '>=0.11.5']
   ]
+
+  self.extra_dev_deps = [
+    ['rspec', '>=1.1.12']
+  ]
+
+  self.spec_extras = {:has_rdoc => 'yard'}
 end
 
 # vim: syntax=Ruby