README.txt in ronin-0.2.4 vs README.txt in ronin-0.3.0
- old
+ new
@@ -1,100 +1,83 @@
= Ronin
* 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:
* Supports installing/updating/uninstalling of Overlays.
* Supports accessing Overlays from various media types:
* Subversion (SVN)
* Mercurial (Hg)
* 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
* Text
* HTTP
* URIs
* Generating random text.
* 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.
+ * print_info, print_error, print_warning and print_debug output helper
+ methods with color-output.
+* Provides an extendable command-line interface based on Thor.
-== 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
-
== SYNOPSIS:
* Install an Overlay:
- $ ronin install svn://example.com/var/svn/overlay
+ $ ronin install svn://example.com/path/to/overlay
* List installed Overlays:
$ ronin list
@@ -112,10 +95,40 @@
* Start the Ronin console:
$ 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
* http://ronin.rubyforge.org/asm/
@@ -172,11 +185,10 @@
Ronin Web is a Ruby library for Ronin that provides support for web
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)
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by