ronin 0.0.9 → 0.1.0

data/FAQ.txt

@@ -0,0 +1,103 @@
+= FAQ
+
+Q:: Is Ronin a Framework?
+A:: Ronin is not a framework. Instead, we like to call it a Platform, since
+    Ronin was designed for developing code on top of it. Besides,
+    "framework" is totally the developer buzz-word of the 2000s.
+
+Q:: How well documented is Ronin?
+A:: Ronin has extensive RDoc documentation of it's API. Various Tutorials
+    and HOWTOs are always in the works.
+
+Q:: How readable is Ronin's code-base?
+A:: Other projects have been criticized for having poor programming
+    conventions or a lack of documentation. To avoid this, Ronin enforces a
+    set of coding style guidelines to ensure that all source-code is clean
+    and readable. The coding style guidelines can be reviewed here:
+    http://ronin.rubyforge.org/style.html
+
+Q:: Does Ronin have a test-suite so that I can ensure that Ronin is bug
+    free?
+A:: Yes, Ronin comes with extensive RSpec specification tests.
+
+Q:: Ronin comes with code which can be used to scan for and exploit
+    security vulnerabilities, aren't you making everyone less secure by
+    doing so?
+A:: Yeah, so? There are plenty of similar projects which are freely
+    available on-line, that can be used to scan and exploit vulnerabilities.
+
+Q:: By publishing a hacking tool, aren't you helping to support the
+    TERRORISTS!!!1111oneoneone
+A:: Technically we're helping everyone, since Ronin is freely available
+    for download. What people choose to do with Ronin is their own ethical
+    responsibility. If you are scared of Hackers or TERRORISTS, we suggest
+    you help raise awareness of bad programming habits which helped to
+    create all those vulnerabilities in the first place. Perhaps you could
+    stand outside Computer Science departments holding up signs such as:
+
+      "Parametrize your SQL data"
+
+    Or the classic:
+
+      "Don't use strcpy!"
+
+Q:: Does Ronin ship with 0day?
+A:: Ronin was never intended to ship with any built-in exploits or
+    payloads. Ronin's design allows user to checkout various
+    overlays of exploits, payloads and extensions. This design choice
+    allows for users to selectively choose which overlay they want to
+    use, update them when they like and possibly even create their own
+    overlays.
+
+Q:: What exactly are overlays?
+A:: Overlays are directories which can contain objects (such as exploits or
+    payloads) or extensions which can be used by Ronin. An overlay also
+    contains a small XML file called <tt>ronin.xml</tt> which describes
+    the overlay, it's authors and it's licensing.
+
+Q:: How are overlays hosted?
+A:: An overlay can be hosed on any Subversion (SVN), CVS, Git or Rsync
+    server.
+
+Q:: How can I install an Overlay?
+A:: Simply pass the URL of the overlay to the +ronin+ +install+ sub-command.
+    
+      $ ronin install svn://www.example.com/overlay
+
+    If you have previously checked out an overlay, then simply pass the
+    path of the local overlay to the +ronin+ +add+ sub-command.
+
+      $ ronin add path/to/local/overlay
+
+Q:: Does Ronin have a GUI or Web-interface?
+A:: Not currently. The developers of Ronin are considering creating a GUI
+    using JRuby + Swing or possibly Shoes. A Web-interface would be possible
+    once Merb becomes stable.
+
+Q:: I don't know a lot of Ruby, is there a command-line interface to the
+    various libraries of Ronin?
+A:: Why yes. Ronin's design allows for the libraries of Ronin to add various
+    sub-commands to the main +ronin+ command. To view all available commands
+    simply run the following command:
+
+      $ ronin help
+
+    To view help information on a specific command:
+
+      $ ronin help command_here
+
+Q:: Does Ronin offer certification or special training courses?
+A:: No, we're not that kind of project. Besides, you shouldn't need a
+    certificate to feel good about yourself.
+
+Q:: What is Ronin licensed under?
+A:: GPL-2.
+
+Q:: Can I include Ronin in my (companies) commercial product?
+A:: No, you cannot. Ronin is licensed under the GPL-2 license.
+
+Q:: But we are a struggling Information Security company, could we purchase
+    the rights to Ronin?
+A:: Go struggle somewhere else. No one is selling Ronin, we don't want to
+    see it become another Nessus.
+

data/History.txt

@@ -1,4 +1,13 @@
-== 0.0.9 / 2008-08-20
+=== 0.1.0 / 2008-09-28
+
+* Changed how Sessions are setup.
+* Have Ronin use it's own DataMapper Repository name-space to avoid
+  conflicts with other DataMapper libraries.
+* Added the Parameters#set_params methods.
+* Added specs.
+* Fixed various trivial bugs.
+
+=== 0.0.9 / 2008-08-20
 
 * Initial release.
 * Supports installing/updating/uninstalling of Overlays.

data/Manifest.txt

@@ -2,6 +2,7 @@ History.txt
 COPYING.txt
 Manifest.txt
 README.txt
+FAQ.txt
 TODO.txt
 Rakefile
 bin/ronin
@@ -155,3 +156,28 @@ lib/ronin/version.rb
 tasks/spec.rb
 spec/helpers/
 spec/spec_helper.rb
+spec/arch_spec.rb
+spec/author_spec.rb
+spec/chars/chars_spec.rb
+spec/context/context_spec.rb
+spec/context/helpers/book_context.rb
+spec/context/helpers/book_review_context.rb
+spec/context/helpers/contexts/snow_crash.rb
+spec/context/helpers/contexts/neuromancer_review.rb
+spec/extensions/hash_spec.rb
+spec/extensions/string_spec.rb
+spec/extensions/uri/http_spec.rb
+spec/extensions/uri/query_params_spec.rb
+spec/formatting/binary_spec.rb
+spec/formatting/digest_spec.rb
+spec/formatting/html_spec.rb
+spec/formatting/http_spec.rb
+spec/formatting/text_spec.rb
+spec/license_spec.rb
+spec/path_spec.rb
+spec/platform_spec.rb
+spec/product_spec.rb
+spec/target_spec.rb
+spec/parameters/parameters_spec.rb
+spec/sessions/session_spec.rb
+spec/ronin_spec.rb

data/Rakefile

@@ -8,6 +8,7 @@ require './lib/ronin/version.rb'
 Hoe.new('ronin', Ronin::VERSION) do |p|
   p.rubyforge_name = 'ronin'
   p.developer('Postmodern Modulus III','postmodern.mod3@gmail.com')
+  p.remote_rdoc_dir = 'docs/ronin'
   p.extra_deps = ['hpricot',
                   'mechanize',
                   ['dm-core', '>=0.9.3'],
@@ -16,6 +17,7 @@ Hoe.new('ronin', Ronin::VERSION) do |p|
                   ['dm-types', '>=0.9.3'],
                   ['dm-serializer', '>=0.9.3'],
                   ['dm-aggregates', '>=0.9.3'],
+                  ['dm-validations', '>=0.9.3'],
                   ['reverserequire', '>=0.1.0'],
                   ['repertoire', '>=0.1.2']]
 end

data/TODO.txt

@@ -1,6 +1,13 @@
-== Ronin 0.1.0:
+== TODO
+
+=== Ronin 0.1.0:
+
+* Ensure that an ObjectContext can be loaded from a file and have all of
+  it's properties and associations loaded from the Database.
+* Create an Overlay Genetor for creating basic Overlays.
+
+=== Ronin 0.2.0:
 
 * Create an IO proxy class and RPC Service for proxying io.
 * Create a module for pivoting.
-* Process user-requests and bug-fixes
 

data/lib/ronin/arch.rb

@@ -41,6 +41,14 @@ module Ronin
     # Address length of the architecture
     property :address_length, Integer
 
+    # Validates
+    validates_present :name, :endian, :address_length
+    validates_is_unique :name
+    validates_format :endian, :with => lambda { |endian|
+      endian == 'big' || endian == 'little'
+    }
+    validates_is_number :address_length
+
     #
     # Returns the name of the arch as a String.
     #
@@ -50,8 +58,7 @@ module Ronin
 
     #
     # Defines a new builtin Arch with the specified _name_ and the given
-    # _opts_. If _block_ is given, it will be passed the newly created
-    # Arch.
+    # _options_.
     #
     def Arch.define(name,options={})
       name = name.to_s

data/lib/ronin/author.rb

@@ -55,28 +55,27 @@ module Ronin
     property :biography, Text
 
     #
-    # Creates a new Author object with the given _name_ and _info_. The
-    # _name_ defaults to ANONYMOUSE. If _block_ is given, it will be passed
-    # the newly created Author object.
+    # Creates a new Author object with the given _options_. If _block_ is
+    # given, it will be passed the newly created Author object.
     #
     # _info_ may contain the following keys:
+    # <tt>:name</tt>:: The name of the author. Defaults to +ANONYMOUSE+.
     # <tt>:organization</tt>:: The organization of the author.
     # <tt>:pgp_signature</tt>:: The PGP signature of the author.
     # <tt>:email</tt>:: The email address of the author.
     # <tt>:url</tt>:: The URL for the author.
     # <tt>:biography</tt>:: The biography of the author.
     #
-    def initialize(name=ANONYMOUSE,info={},&block)
-      @name = name
-      @organization= info[:organization]
-      @pgp_signature = info[:pgp_signature]
-      @email = info[:email]
-      @url = info[:url]
-      @biography = info[:biography]
+    def initialize(options={},&block)
+      super(options)
 
       block.call(self) if block
     end
 
+    def name
+      @name || ANONYMOUSE
+    end
+
     #
     # Returns the name of the author.
     #

data/lib/ronin/chars/chars.rb

@@ -145,7 +145,7 @@ module Ronin
     #
     # The punctuation character set.
     #
-    def Chars.puncation
+    def Chars.punctuation
       PUNCTUATION
     end
 

data/lib/ronin/console.rb

@@ -32,35 +32,35 @@ module Ronin
     # Returns the default Console prompt style
     #
     def Console.prompt
-      @@console_prompt ||= :SIMPLE
+      @@ronin_console_prompt ||= :SIMPLE
     end
 
     #
     # Sets the default Console prompt style to the specified _style_.
     #
     def Console.prompt=(style)
-      @@console_prompt = style
+      @@ronin_console_prompt = style
     end
 
     #
     # Returns the default Console indent setting.
     #
     def Console.indent
-      @@console_indent ||= true
+      @@ronin_console_indent ||= true
     end
 
     #
     # Sets the default Console indent setting.
     #
     def Console.indent=(value)
-      @@console_indent = value
+      @@ronin_console_indent = value
     end
 
     #
     # Returns the Array of files to require when the Console starts.
     #
     def Console.auto_load
-      @@console_auto_load ||= []
+      @@ronin_console_auto_load ||= []
     end
 
     #

data/lib/ronin/context.rb

@@ -37,7 +37,7 @@ module Ronin
         class_def(:context_name) { name }
 
         meta_def(:load_context) do |path,*args|
-          Context.load_context(path,self.context_name,*args)
+          Context.load_context(self.context_name,path,*args)
         end
 
         # define the top-level context wrappers

data/lib/ronin/database.rb

@@ -24,6 +24,11 @@
 require 'ronin/exceptions/invalid_database_config'
 require 'ronin/extensions/kernel'
 require 'ronin/config'
+require 'ronin/arch'
+require 'ronin/platform'
+require 'ronin/author'
+require 'ronin/license'
+require 'ronin/product'
 
 require 'yaml'
 require 'dm-core'
@@ -42,7 +47,7 @@ module Ronin
     # Default configuration of the database
     DEFAULT_CONFIG = {
       :adapter => :sqlite3,
-      :database => File.join(Config::PATH,'ronin.db')
+      :database => File.join(Config::PATH,'database.sqlite3')
     }
 
     #
@@ -100,7 +105,7 @@ module Ronin
     #
     def Database.setup(configuration=Database.config,&block)
       Database.setup_log
-      DataMapper.setup(:default, configuration)
+      DataMapper.setup(Model::REPOSITORY_NAME, configuration)
 
       block.call if block
 
@@ -115,7 +120,7 @@ module Ronin
         model.relationships.each_value { |r| r.child_key if r.child_model == model }
       end
 
-      DataMapper.auto_upgrade!
+      DataMapper.auto_upgrade!(Model::REPOSITORY_NAME)
       return nil
     end
   end

data/lib/ronin/extensions/string.rb

@@ -31,7 +31,7 @@ class String
   #   'Ronin::Arch' # => "ronin_arch"
   #
   def to_method_name
-    downcase.gsub(/(::|[ \-])/,'_')
+    downcase.gsub(/(::|[\s\-])/,'_')
   end
 
 end

data/lib/ronin/extensions/uri/http.rb

@@ -65,7 +65,7 @@ module URI
     def test_query_params(value,options={},&block)
       results = {}
 
-      explode_query_params(value,options) do |url|
+      explode_query_params(value,options) do |param,url|
         result = block.call(param,url)
 
         results[param] = result if result

data/lib/ronin/license.rb

@@ -40,6 +40,10 @@ module Ronin
     # URL of the License document
     property :url, String
 
+    # Validations
+    validates_present :name, :description
+    validates_is_unique :name
+
     #
     # Returns the name of the license as a String.
     #

data/lib/ronin/model.rb

@@ -27,16 +27,24 @@ require 'dm-core'
 require 'dm-types'
 require 'dm-serializer'
 require 'dm-aggregates'
+require 'dm-validations'
 
 module Ronin
   module Model
     include DataMapper::Types
 
+    # Name of Ronin's DataMapper repository
+    REPOSITORY_NAME = :ronin
+
     def self.included(base)
       base.module_eval do
         include DataMapper::Resource
         include DataMapper::AutoMigrations
 
+        def self.default_repository_name
+          Model::REPOSITORY_NAME
+        end
+
         property :type, Discriminator
       end
     end

data/lib/ronin/models.rb

@@ -23,12 +23,5 @@
 
 require 'ronin/extensions/kernel'
 require 'ronin/model'
-require 'ronin/arch'
-require 'ronin/platform'
-require 'ronin/author'
-require 'ronin/license'
-require 'ronin/product'
 
-module Ronin
-  ronin_require 'ronin/models'
-end
+ronin_require 'ronin/models'

data/lib/ronin/network/extensions/telnet/net.rb

@@ -33,8 +33,9 @@ module Net
   # the newly created Telnet object.
   #
   # _options_ may contain the following keys:
-  # <tt>:port</tt>:: The port to connect to. Defaults to +DEFAULT_PORT+,
-  #                  if not given.
+  # <tt>:port</tt>:: The port to connect to. Defaults to
+  #                  <tt>Ronin::Network::Telnet.default_port</tt>, if not
+  #                  given.
   # <tt>:binmode</tt>:: Indicates that newline substitution shall not
   #                     be performed.
   # <tt>:output_log</tt>:: The name of the file to write connection
@@ -45,7 +46,8 @@ module Net
   # <tt>:prompt</tt>:: A regular expression matching the host's
   #                    command-line prompt sequence, used to determine
   #                    when a command has finished. Defaults to
-  #                    +DEFAULT_PROMPT+, if not given.
+  #                    <tt>Ronin::Network::Telnet.default_prompt</tt>, if
+  #                    not given.
   # <tt>:telnet</tt>:: Indicates that the connection shall behave as a
   #                    telnet connection. Defaults to +true+.
   # <tt>:plain</tt>:: Indicates that the connection shall behave as a
@@ -53,16 +55,19 @@ module Net
   # <tt>:timeout</tt>:: The number of seconds to wait before timing out
   #                     both the initial attempt to connect to host,
   #                     and all attempts to read data from the host.
-  #                     Defaults to +DEFAULT_TIMEOUT+, if not given.
+  #                     Defaults to
+  #                     <tt>Ronin::Network::Telnet.default_timeout</tt>,
+  #                     if not given.
   # <tt>:wait_time</tt>:: The amount of time to wait after seeing what
   #                       looks like a prompt.
   # <tt>:proxy</tt>:: A proxy object to used instead of opening a
   #                   direct connection to the host. Must be either
   #                   another telnet object or an IO object.
-  #                   Defaults to Telnet.proxy, if not given.
+  #                   Defaults to
+  #                   <tt>Ronin::Network::Telnet.proxy</tt>, if not given.
   # <tt>:user</tt>:: The user to login with.
   # <tt>:password</tt>:: The password to login with.
-  # <tt>:ssl</tt>:: A +Hash+ of SSL information to use for a SSLed
+  # <tt>:ssl</tt>:: A Hash of SSL information to use for a SSLed
   #                 Telnet session. This hash must contain the following
   #                 keys.
   #                 <tt>:certfile</tt>:: The SSL Certfile to use.