ronin 0.0.9

data/lib/ronin/rpc/client.rb

@@ -0,0 +1,91 @@
+#
+#--
+# 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/rpc/exceptions/not_implemented'
+require 'ronin/rpc/exceptions/unknown_service'
+require 'ronin/rpc/service'
+require 'ronin/extensions/meta'
+
+module Ronin
+  module RPC
+    class Client
+
+      #
+      # Calls the specified _function_ hosted on the RPC Server with the
+      # given _arguments_. Returns the return-value of the RPC function call.
+      #
+      def call(function,*arguments)
+        return_value(send_call(create_call(function,*arguments)))
+      end
+
+      protected
+
+      #
+      # Defines a Service offered by the Client with the specified _name_
+      # and _class_type_.
+      #
+      def self.service(name,class_type)
+        name = name.to_sym
+
+        class_def(name) do
+          class_type.new(name,self)
+        end
+      end
+
+      #
+      # Default method which creates a Call object for the specified
+      # _function_ and the given _arguments_. By default create_call raises
+      # a NotImplemented exception.
+      #
+      def create_call(function,*arguments)
+        raise(NotImplemented,"the \"create_call\" method is not implemented in #{self.class}",caller)
+      end
+
+      #
+      # Default method which sends the _call_object_ to the RPC Server and 
+      # returns the response of the Server. By default send_call raises
+      # a NotImplemented exception.
+      #
+      def send_call(call_object)
+        raise(NotImplemented,"the \"send_call\" method is not implemented in #{self.class}",caller)
+      end
+
+      #
+      # Default method which extracts the return-value and output generated
+      # by the RPC function call from the specified _response_ data. By
+      # default return_value raises a NotImplemented exception.
+      #
+      def return_value(response)
+        raise(NotImplemented,"the \"return_value\" method is not implemented in #{self.class}",caller)
+      end
+
+      #
+      # Relays missing methods to call.
+      #
+      def method_missing(sym,*args)
+        call(sym,*args)
+      end
+
+    end
+  end
+end

data/lib/ronin/rpc/console.rb

@@ -0,0 +1,79 @@
+#
+#--
+# 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/rpc/service'
+require 'ronin/rpc/interactive_console'
+
+module Ronin
+  module RPC
+    class Console < Service
+
+      #
+      # Invoke the the specified _method_ with the given _arguments_.
+      # Returns the result of the method call.
+      #
+      def invoke(method,*arguments)
+        call(:invoke,method,arguments)
+      end
+
+      #
+      # Evaluates the specified _string_ of code. Returns the result of the
+      # evaluated code.
+      #
+      def eval(string)
+        invoke(:eval,string)
+      end
+
+      #
+      # If _expression_ is given it will be evaluated and it's return value
+      # will be returned as a natively formatted String. If _expression_ is
+      # not given, the Object inspect method will be called.
+      #
+      def inspect(expression=nil)
+        if expression
+          return call(:inspect,expression)
+        else
+          return super()
+        end
+      end
+
+      #
+      # Starts an InteractiveConsole that allows a user to evaluate code
+      # and inspect the return-value.
+      #
+      def interact
+        InteractiveConsole.start(self)
+      end
+
+      protected
+
+      #
+      # Relays missing methods to invoke.
+      #
+      def method_missing(sym,*args)
+        invoke(sym,*args)
+      end
+
+    end
+  end
+end

data/lib/ronin/rpc/exceptions.rb

@@ -0,0 +1,25 @@
+#
+#--
+# 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/rpc/exceptions/not_implemented'
+require 'ronin/rpc/exceptions/response_missing'

data/lib/ronin/rpc/exceptions/not_implemented.rb

@@ -0,0 +1,29 @@
+#
+#--
+# 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 RPC
+    class NotImplemented < RuntimeError
+    end
+  end
+end

data/lib/ronin/rpc/exceptions/response_missing.rb

@@ -0,0 +1,29 @@
+#
+#--
+# 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 RPC
+    class ResponseMissing < RuntimeError
+    end
+  end
+end

data/lib/ronin/rpc/interactive.rb

@@ -0,0 +1,55 @@
+#
+#--
+# 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/shell'
+
+module Ronin
+  module RPC
+    class Interactive < Ronin::Shell
+
+      # The service to interactive with
+      attr_reader :service
+
+      #
+      # Creates a new Interactive object using the specified _service_ and
+      # the given _options_. If a _block_ is given it will be passed the
+      # newly created Interactive object.
+      #
+      def initialize(service,options={},&block)
+        @service = service
+
+        super(options,&block)
+      end
+
+      #
+      # Starts a newly created Interactive object with the specified
+      # _service_ with the given _options_. If a _block_ is given, it will
+      # be passed the newly created Interactive object, before it is started.
+      #
+      def Interactive.start(service,options={},&block)
+        Interactive.new(service,options,&block).start
+      end
+
+    end
+  end
+end

data/lib/ronin/rpc/interactive_console.rb

@@ -0,0 +1,58 @@
+#
+#--
+# 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/rpc/interactive'
+require 'ronin/rpc/console'
+
+module Ronin
+  module RPC
+    class InteractiveConsole < Interactive
+
+      #
+      # Creates a new InteractiveConsole object with the specified _console_
+      # service. If a _block_ is given it will be
+      #
+      def initialize(console,&block)
+        super(console,:prompt => '>>',&block)
+      end
+
+      #
+      # Starts a newly created InteractiveConsole object with the specified
+      # _service_. If a _block_ is given, it will be passed the newly
+      # created InteractiveShell object, before it is started.
+      #
+      def self.start(console,&block)
+        self.new(console,&block).start
+      end
+
+      #
+      # Evaluates the specified _code_ through the Console service and
+      # prints the natively formated return-value.
+      #
+      def process_command(code)
+        puts "=> #{@service.inspect(code)}"
+      end
+
+    end
+  end
+end

data/lib/ronin/rpc/interactive_shell.rb

@@ -0,0 +1,59 @@
+#
+#--
+# 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/rpc/interactive'
+require 'ronin/shell'
+
+module Ronin
+  module RPC
+    class InteractiveShell < Interactive
+
+      #
+      # Creates a new InteractiveShell object with the specified _shell_
+      # service. If a _block_ is given it will be passed the newly created
+      # InteractiveShell object.
+      #
+      def initialize(shell,&block)
+        super(shell,:prompt => '$',&block)
+      end
+
+      #
+      # Starts a newly created InteractiveShell object using the specified
+      # _shell_ service. If a _block_ is given, it will be passed the newly
+      # created InteractiveShell before it is started.
+      #
+      def self.start(shell,&block)
+        self.new(shell,&block).start
+      end
+
+      #
+      # Executes the specified _command_ through the Shell service
+      # and prints the output of the command.
+      #
+      def process_command(command)
+        @service.system(command)
+      end
+
+    end
+  end
+end

data/lib/ronin/rpc/response.rb

@@ -0,0 +1,57 @@
+#
+#--
+# 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/rpc/exceptions/not_implemented'
+
+module Ronin
+  module RPC
+    class Response
+
+      # Contents of the response
+      attr_reader :contents
+
+      #
+      # Creates a new Response object with the specified _contents_.
+      #
+      def initialize(contents)
+        @contents = contents
+      end
+
+      #
+      # Default method which decodes response data from the contes of the
+      # RPC response.
+      #
+      def decode
+        raise(NotImplemented,"the \"decode\" method is not implemented in #{self.class}",caller)
+      end
+
+      #
+      # Returns the String form of the contents of the RPC response.
+      #
+      def to_s
+        @contents.to_s
+      end
+
+    end
+  end
+end