ronin 0.2.4 → 0.3.0

data/lib/ronin/ui/shell.rb

@@ -1,7 +1,5 @@
 #
-#--
-# 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)
 #
@@ -18,7 +16,6 @@
 # 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
@@ -31,11 +28,25 @@ module Ronin
     # Creates and starts a new Shell object with the specified _options_.
     # If a _block_ is given, it will be passed every command.
     #
-    # _options_ may contain the following keys:
-    # <tt>:name</tt>:: Name of the shell.
-    # <tt>:prompt</tt>:: Prompt to use for the shell, defaults to
-    #                    +DEFAULT_PROMPT+.
+    # @param [Hash] options
+    #   Additional options.
     #
+    # @option options [String] :name ('')
+    #   The shell-name to use before the prompt.
+    #
+    # @option options [String] :prompt (DEFAULT_PROMPT)
+    #   The prompt to use for the shell.
+    #
+    # @yield [shell, line]
+    #   The block that will be passed every command entered.
+    #
+    # @yieldparam [Shell] shell
+    #   The shell to use for output.
+    #
+    # @yieldparam [String] line
+    #   The command entered into the shell.
+    #
+    # @example
     #   Shell.start(:prompt => '$') { |shell,line| system(line) }
     #
     def Shell.start(options={},&block)
@@ -66,28 +77,43 @@ module Ronin
     end
 
     #
-    # Equivalent to <tt>STDOUT.putc(char)</tt>.
+    # Print a character to the shell.
+    #
+    # @param [String] char
+    #   The character to print.
     #
     def Shell.putc(char)
       STDOUT.putc(char)
     end
 
     #
-    # Equivalent to <tt>STDOUT.print(string)</tt>.
+    # Print a String to the shell.
+    #
+    # @param [String] string
+    #   The String to print.
     #
     def Shell.print(string)
       STDOUT.print(string)
     end
 
     #
-    # Equivalent to <tt>STDOUT.puts(string)</tt>.
+    # Print a String and a new-line character to the shell.
+    #
+    # @param [String] string
+    #   The String to print.
     #
     def Shell.puts(string)
       STDOUT.puts(string)
     end
 
     #
-    # Equivalent to <tt>STDOUT.printf(string,*objects)</tt>.
+    # Render the format-string and print the result to the shell.
+    #
+    # @param [String] string
+    #   The format-string to render.
+    #
+    # @param [Array] objects
+    #   Additional objects to use in the format-string.
     #
     def Shell.printf(string,*objects)
       STDOUT.printf(string,*objects)

data/lib/ronin/version.rb

@@ -1,7 +1,5 @@
 #
-#--
-# 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)
 #
@@ -18,10 +16,9 @@
 # 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
   # Ronin version 
-  VERSION = '0.2.4'
+  VERSION = '0.3.0'
 end

data/lib/ronin/{sessions/exceptions/variable_missing.rb → yard.rb}

@@ -1,7 +1,5 @@
 #
-#--
-# Ronin - A ruby development 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)
 #
@@ -18,12 +16,6 @@
 # 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 Sessions
-    class VariableMissing < RuntimeError
-    end
-  end
-end
+require 'ronin/yard/handlers'

data/lib/ronin/{ronin.rb → yard/handlers.rb}

@@ -1,7 +1,5 @@
 #
-#--
-# 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)
 #
@@ -18,17 +16,9 @@
 # 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/ui/console'
-
-module Ronin
-  #
-  # Starts Ronin's console with the given _script_. If a _block_ is given
-  # it will be ran within the console.
-  #
-  def Ronin.console(script=nil,&block)
-    UI::Console.start(script,&block)
-  end
-end
+require 'dm-predefined/yard/handlers'
+require 'contextify/yard/handlers'
+require 'parameters/yard/handlers'
+require 'ronin/yard/handlers/ruby'

data/lib/ronin/yard/handlers/ruby.rb

@@ -0,0 +1,27 @@
+#
+# 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
+# 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/yard/handlers/ruby/eval_block_handler'
+require 'ronin/yard/handlers/ruby/metaclass_eval_handler'
+require 'ronin/yard/handlers/ruby/property_handler'
+require 'ronin/yard/handlers/ruby/has_handler'
+require 'ronin/yard/handlers/ruby/belongs_to_handler'
+require 'ronin/yard/handlers/ruby/scanner_handler'
+require 'ronin/yard/handlers/ruby/legacy'

data/lib/ronin/yard/handlers/ruby/base.rb

@@ -0,0 +1,27 @@
+require 'yard'
+
+module YARD
+  module Handlers
+    module Ruby
+      class Base < Handlers::Base
+
+        protected
+
+        def effected_namespace
+          if statement.type == :command_call
+            context = statement.jump(:var_ref)
+
+            unless context.source == 'self'
+              return ensure_loaded!(
+                Registry.resolve(namespace,context.source)
+              )
+            end
+          end
+
+          return namespace
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/yard/handlers/ruby/belongs_to_handler.rb

@@ -0,0 +1,45 @@
+require 'yard'
+
+require 'ronin/yard/handlers/ruby/base'
+
+module YARD
+  module Handlers
+    module Ruby
+      class BelongsToHandler < Base
+
+        handles method_call(:belongs_to)
+
+        def process
+          nobj = effected_namespace
+          mscope = scope
+          name = statement.parameters[0].last
+          
+          if name.type == :symbol
+            name = name.source[1..-1]
+
+            register MethodObject.new(nobj, name, :class) do |o|
+              o.visibility = :public
+              o.source = statement.source
+              o.signature = "def self.#{name}"
+              o.parameters = [['repository', 'nil']]
+            end
+
+            register MethodObject.new(nobj, name, mscope) do |o|
+              o.visibility = :public
+              o.source = statement.source
+              o.signature = "def #{name}"
+            end
+
+            register MethodObject.new(nobj, "#{name}=", mscope) do |o|
+              o.visibility = :public
+              o.source = statement.source
+              o.signature = "def #{name}=(resource)"
+              o.parameters = [['resource', nil]]
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/yard/handlers/ruby/eval_block_handler.rb

@@ -0,0 +1,18 @@
+require 'yard'
+
+module YARD
+  module Handlers
+    module Ruby
+      class EvalBlockHandler < YARD::Handlers::Ruby::Base
+
+        handles method_call(:module_eval), method_call(:class_eval), method_call(:instance_eval)
+
+        def process
+          if (block = statement.jump(:brace_block, :do_block).last)
+            parse_block(block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ronin/yard/handlers/ruby/has_handler.rb

@@ -0,0 +1,49 @@
+require 'yard'
+
+require 'ronin/yard/handlers/ruby/base'
+
+module YARD
+  module Handlers
+    module Ruby
+      class HasHandler < Base
+
+        handles method_call(:has)
+
+        def process
+          args = statement.parameters
+          n = args[0].last
+          name = args[1].last
+
+          if (name.type == :symbol &&
+              ((n.type == :int && n.source =~ /^[0-9]\d*$/) ||
+              (n.type == :ident && n.source == 'n')))
+            nobj = effected_namespace
+            mscope = scope
+            name = name.source[1..-1]
+
+            register MethodObject.new(nobj, name, :class) do |o|
+              o.visibility = :public
+              o.source = statement.source
+              o.signature = "def self.#{name}"
+              o.parameters = [['repository', 'nil']]
+            end
+
+            register MethodObject.new(nobj, name, mscope) do |o|
+              o.visibility = :public
+              o.source = statement.source
+              o.signature = "def #{name}"
+            end
+
+            register MethodObject.new(nobj, "#{name}=", mscope) do |o|
+              o.visibility = :public
+              o.source = statement.source
+              o.signature = "def #{name}="
+              o.parameters = [["new_#{name}", nil]]
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/yard/handlers/ruby/legacy.rb

@@ -0,0 +1,26 @@
+#
+# 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
+# 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/yard/handlers/ruby/legacy/eval_block_handler'
+require 'ronin/yard/handlers/ruby/legacy/metaclass_eval_handler'
+require 'ronin/yard/handlers/ruby/legacy/property_handler'
+require 'ronin/yard/handlers/ruby/legacy/has_handler'
+require 'ronin/yard/handlers/ruby/legacy/belongs_to_handler'
+require 'ronin/yard/handlers/ruby/legacy/scanner_handler'

data/lib/ronin/yard/handlers/ruby/legacy/belongs_to_handler.rb

@@ -0,0 +1,41 @@
+require 'yard'
+
+module YARD
+  module Handlers
+    module Ruby
+      module Legacy
+        class BelongsToHandler < Base
+
+          handles /\Abelongs_to\s/
+
+          def process
+            nobj = namespace
+            mscope = scope
+            name = statement.tokens[2,1].to_s[1..-1]
+
+            register MethodObject.new(nobj, name, :class) do |o|
+              o.visibility = :public
+              o.source = statement.source
+              o.signature = "def self.#{name}"
+              o.parameters = [['repository', 'nil']]
+            end
+
+            register MethodObject.new(nobj, name, mscope) do |o|
+              o.visibility = :public
+              o.source = statement.source
+              o.signature = "def #{name}"
+            end
+
+            register MethodObject.new(nobj, "#{name}=", mscope) do |o|
+              o.visibility = :public
+              o.source = statement.source
+              o.signature = "def #{name}=(resource)"
+              o.parameters = [['resource', nil]]
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/yard/handlers/ruby/legacy/eval_block_handler.rb

@@ -0,0 +1,19 @@
+require 'yard/handlers/ruby/legacy/base'
+
+module YARD
+  module Handlers
+    module Ruby
+      module Legacy
+        class EvalBlockHandler < Base
+
+          handles /(\A|\.)(module|class|instance)_eval(\s+|\()/
+
+          def process
+            parse_block if statement.block
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/yard/handlers/ruby/legacy/has_handler.rb

@@ -0,0 +1,34 @@
+require 'yard'
+
+module YARD
+  module Handlers
+    module Ruby
+      module Legacy
+        class HasHandler < Base
+
+          handles /\Ahas\s+([1-9]\d*|n|(0|1)\.\.n),\s/
+
+          def process
+            nobj = namespace
+            mscope = scope
+            name = statement.tokens[2..-1].to_s[/:[^,]+/][1..-1]
+
+            register MethodObject.new(nobj, name, :class) do |o|
+              o.visibility = :public
+              o.source = statement.source
+              o.signature = "def self.#{name}"
+              o.parameters = [['repository', 'nil']]
+            end
+
+            register MethodObject.new(nobj, name, mscope) do |o|
+              o.visibility = :public
+              o.source = statement.source
+              o.signature = "def #{name}"
+            end
+          end
+
+        end
+      end
+    end
+  end
+end