ronin 0.1.1 → 0.1.2

data/FAQ.txt

@@ -1,103 +0,0 @@
-= 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/lib/ronin/environment.rb

@@ -1,39 +0,0 @@
-#
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
-#
-# Copyright (c) 2006-2008 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
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
-#++
-#
-
-require 'ronin/config'
-
-module Ronin
-  module Environment
-    # Ronin environment file
-    ENVIRONMENT_FILE = File.join(Config::PATH,'environment.rb')
-
-    #
-    # Requires the environment configuration file at the given _path_.
-    # If _path_ is not given, it will default to <tt>ENVIRONMENT_FILE</tt>.
-    #
-    def Environment.load(path=ENVIRONMENT_FILE)
-      require path if File.file?(path)
-    end
-  end
-end

data/lib/ronin/objects.rb

@@ -1,27 +0,0 @@
-#
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
-#
-# Copyright (c) 2006-2008 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
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
-#++
-#
-
-require 'ronin/extensions/kernel'
-require 'ronin/object_context'
-
-ronin_require 'ronin/objects'

data/lib/ronin/parameters.rb

@@ -1,27 +0,0 @@
-#
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
-#
-# Copyright (c) 2006-2008 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
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
-#++
-#
-
-require 'ronin/parameters/param'
-require 'ronin/parameters/class_param'
-require 'ronin/parameters/instance_param'
-require 'ronin/parameters/parameters'

data/lib/ronin/parameters/exceptions.rb

@@ -1,25 +0,0 @@
-#
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
-#
-# Copyright (c) 2006-2008 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
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
-#++
-#
-
-require 'ronin/parameters/exceptions/param_not_found'
-require 'ronin/parameters/exceptions/missing_param'

data/lib/ronin/parameters/exceptions/param_not_found.rb

@@ -1,29 +0,0 @@
-#
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
-#
-# Copyright (c) 2006-2008 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
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
-#++
-#
-
-module Ronin
-  module Parameters
-    class ParamNotFound < RuntimeError
-    end
-  end
-end

data/lib/ronin/parameters/parameters.rb

@@ -1,286 +0,0 @@
-#
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
-#
-# Copyright (c) 2006-2008 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
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
-#++
-#
-
-require 'ronin/parameters/class_param'
-require 'ronin/parameters/instance_param'
-require 'ronin/parameters/exceptions'
-require 'ronin/extensions/meta'
-
-module Ronin
-  module Parameters
-    def self.included(base) # :nodoc:
-      base.metaclass_eval do
-        #
-        # Returns the +Hash+ of parameters for the class.
-        #
-        def params
-          @params ||= {}
-        end
-
-        #
-        # Adds a new parameters with the specified _name_ and the given
-        # _options_ to the Class.
-        #
-        #   parameter 'var'
-        #
-        #   parameter 'var', :default => 3, :description => 'my variable' 
-        #
-        def parameter(name,options={})
-          name = name.to_sym
-
-          # add the parameter to the class params list
-          params[name] = ClassParam.new(name,options[:description],options[:default])
-
-          # define the reader class method for the parameter
-          meta_def(name) do
-            params[name].value
-          end
-
-          # define the writer class method for the parameter
-          meta_def("#{name}=") do |value|
-            params[name].value = value
-          end
-
-          # define the getter/setter instance methods for the parameter
-          attr_accessor(name)
-        end
-
-        #
-        # Returns the class parameter with the specified _name_. If no
-        # such class parameter exists, a ParamNotFound exception will be
-        # raised.
-        #
-        def get_param(name)
-          name = name.to_sym
-
-          ancestors.each do |ancestor|
-            if ancestor.include?(Parameters)
-              if ancestor.params.has_key?(name)
-                return ancestor.params[name]
-              end
-            end
-          end
-
-          raise(ParamNotFound,"parameter #{name.to_s.dump} was not found in class #{self.name.dump}",caller)
-        end
-
-        #
-        # Returns +true+ if a class parameters with the specified _name_
-        # exists, returns +false+ otherwise.
-        #
-        def has_param?(name)
-          name = name.to_sym
-
-          ancestors.each do |ancestor|
-            if ancestor.include?(Parameters)
-              return true if ancestor.params.has_key?(name)
-            end
-          end
-
-          return false
-        end
-
-        #
-        # Iterates over all class parameters, passing each one to the
-        # specified _block_.
-        #
-        def each_param(&block)
-          ancestors.each do |ancestor|
-            if ancestor.include?(Parameters)
-              ancestor.params.each_value(&block)
-            end
-          end
-
-          return self
-        end
-
-        #
-        # Returns the description of the class parameters with the
-        # specified _name_. If no such class parameter exists, a
-        # ParamNotFound exception will be raised.
-        #
-        def describe_param(name)
-          get_param(name).description
-        end
-
-        #
-        # Returns the value of the class parameters with the specified
-        # _name_. If no such class parameter exists, a ParamNotFound
-        # exception will be raised.
-        #
-        def param_value(name)
-          get_param(name).value
-        end
-      end
-    end
-
-    #
-    # Calls initialize_parameters and then proceeds to call the
-    # super-classes initialize.
-    #
-    def initialize(*args,&block)
-      initialize_parameters()
-
-      super(*args,&block)
-    end
-
-    #
-    # Initializes all instance parameters based off the class parameter's
-    # descriptions and default values.
-    #
-    def initialize_parameters
-      # import the class parameters
-      self.class.each_param { |param| initialize_param(param) }
-    end
-
-    #
-    # Adds a new parameters with the specified _name_ and the given
-    # _options_ to the object.
-    #
-    #   obj.parameter('var')
-    #
-    #   obj.parameter('var',:default => 3, :description => 'my variable')
-    #
-    def parameter(name,options={})
-      name = name.to_sym
-
-      # set the instance variable
-      instance_variable_set("@#{name}",options[:default])
-
-      # add the new parameter
-      params[name] = InstanceParam.new(self,name,options[:description])
-
-      # define the reader method for the parameter
-      instance_eval %{
-        def #{name}
-          instance_variable_get("@#{name}")
-        end
-      }
-
-      # define the writer method for the parameter
-      instance_eval %{
-        def #{name}=(value)
-          instance_variable_set("@#{name}",value)
-        end
-      }
-
-      return params[name]
-    end
-
-    #
-    # Returns a Hash of the classes params.
-    #
-    def class_params
-      self.class.params
-    end
-
-    #
-    # Returns a +Hash+ of the instance parameters.
-    #
-    def params
-      @params ||= {}
-    end
-
-    #
-    # Returns +true+ if the a parameter with the specified _name_ exists,
-    # returns +false+ otherwise.
-    #
-    #   obj.has_param?('rhost') # => true
-    #
-    def has_param?(name)
-      params.has_key?(name.to_sym)
-    end
-
-    #
-    # Returns the parameter with the specified _name_. If no such parameter
-    # exists, a ParamNotFound exception will be raised.
-    #
-    #   obj.get_param('var') # => InstanceParam
-    #
-    def get_param(name)
-      name = name.to_sym
-
-      unless has_param?(name)
-        raise(ParamNotFound,"parameter #{name.to_s.dump} was not found within #{self.to_s.dump}",caller)
-      end
-
-      return params[name]
-    end
-
-    #
-    # Returns the description of the parameter with the specified _name_.
-    # If no such parameter exists, a ParamNotFound exception will be raised.
-    #
-    #   obj.describe_param('rhost') # => "remote host"
-    #
-    def describe_param(name)
-      get_param(name).description
-    end
-
-    #
-    # Returns the value of the parameter with the specified _name_. If no
-    # such parameter exists, a ParamNotFound exception will be raised.
-    #
-    #   obj.value_param('rhost') # => 80
-    #
-    def param_value(name)
-      get_param(name).value
-    end
-
-    #
-    # Sets the values of the parameters listed in the specified _values_.
-    #
-    #   obj.set_params(:rhost => 'www.example.com', :rport => 80)
-    #   # => {:rhost=>"www.example.com", :rport=>80}
-    #
-    def set_params(values={})
-      values.each do |name,value|
-        get_param(name).value = value
-      end
-    end
-
-    protected
-
-    #
-    # Initializes the specified class _param_.
-    #
-    def initialize_param(param)
-      # set the instance variable if the param has a value
-      if param.value
-        # do not override existing instance value if present
-        unless instance_variable_get("@#{param.name}")
-          begin
-            value = param.value.clone
-          rescue TypeError
-            value = param.value
-          end
-
-          instance_variable_set("@#{param.name}",value)
-        end
-      end
-
-      params[param.name] = InstanceParam.new(self,param.name,param.description)
-      return params[param.name]
-    end
-  end
-end