arachni-rpc 0.1

data/LICENSE.md

@@ -0,0 +1,341 @@
+# License
+
+            GNU GENERAL PUBLIC LICENSE
+               Version 2, June 1991
+
+     Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+     Everyone is permitted to copy and distribute verbatim copies
+     of this license document, but changing it is not allowed.
+
+              Preamble
+
+      The licenses for most software are designed to take away your
+    freedom to share and change it.  By contrast, the GNU General Public
+    License is intended to guarantee your freedom to share and change free
+    software--to make sure the software is free for all its users.  This
+    General Public License applies to most of the Free Software
+    Foundation's software and to any other program whose authors commit to
+    using it.  (Some other Free Software Foundation software is covered by
+    the GNU Lesser General Public License instead.)  You can apply it to
+    your programs, too.
+
+      When we speak of free software, we are referring to freedom, not
+    price.  Our General Public Licenses are designed to make sure that you
+    have the freedom to distribute copies of free software (and charge for
+    this service if you wish), that you receive source code or can get it
+    if you want it, that you can change the software or use pieces of it
+    in new free programs; and that you know you can do these things.
+
+      To protect your rights, we need to make restrictions that forbid
+    anyone to deny you these rights or to ask you to surrender the rights.
+    These restrictions translate to certain responsibilities for you if you
+    distribute copies of the software, or if you modify it.
+
+      For example, if you distribute copies of such a program, whether
+    gratis or for a fee, you must give the recipients all the rights that
+    you have.  You must make sure that they, too, receive or can get the
+    source code.  And you must show them these terms so they know their
+    rights.
+
+      We protect your rights with two steps: (1) copyright the software, and
+    (2) offer you this license which gives you legal permission to copy,
+    distribute and/or modify the software.
+
+      Also, for each author's protection and ours, we want to make certain
+    that everyone understands that there is no warranty for this free
+    software.  If the software is modified by someone else and passed on, we
+    want its recipients to know that what they have is not the original, so
+    that any problems introduced by others will not reflect on the original
+    authors' reputations.
+
+      Finally, any free program is threatened constantly by software
+    patents.  We wish to avoid the danger that redistributors of a free
+    program will individually obtain patent licenses, in effect making the
+    program proprietary.  To prevent this, we have made it clear that any
+    patent must be licensed for everyone's free use or not licensed at all.
+
+      The precise terms and conditions for copying, distribution and
+    modification follow.
+
+            GNU GENERAL PUBLIC LICENSE
+       TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+      0. This License applies to any program or other work which contains
+    a notice placed by the copyright holder saying it may be distributed
+    under the terms of this General Public License.  The "Program", below,
+    refers to any such program or work, and a "work based on the Program"
+    means either the Program or any derivative work under copyright law:
+    that is to say, a work containing the Program or a portion of it,
+    either verbatim or with modifications and/or translated into another
+    language.  (Hereinafter, translation is included without limitation in
+    the term "modification".)  Each licensee is addressed as "you".
+
+    Activities other than copying, distribution and modification are not
+    covered by this License; they are outside its scope.  The act of
+    running the Program is not restricted, and the output from the Program
+    is covered only if its contents constitute a work based on the
+    Program (independent of having been made by running the Program).
+    Whether that is true depends on what the Program does.
+
+      1. You may copy and distribute verbatim copies of the Program's
+    source code as you receive it, in any medium, provided that you
+    conspicuously and appropriately publish on each copy an appropriate
+    copyright notice and disclaimer of warranty; keep intact all the
+    notices that refer to this License and to the absence of any warranty;
+    and give any other recipients of the Program a copy of this License
+    along with the Program.
+
+    You may charge a fee for the physical act of transferring a copy, and
+    you may at your option offer warranty protection in exchange for a fee.
+
+      2. You may modify your copy or copies of the Program or any portion
+    of it, thus forming a work based on the Program, and copy and
+    distribute such modifications or work under the terms of Section 1
+    above, provided that you also meet all of these conditions:
+
+        a) You must cause the modified files to carry prominent notices
+        stating that you changed the files and the date of any change.
+
+        b) You must cause any work that you distribute or publish, that in
+        whole or in part contains or is derived from the Program or any
+        part thereof, to be licensed as a whole at no charge to all third
+        parties under the terms of this License.
+
+        c) If the modified program normally reads commands interactively
+        when run, you must cause it, when started running for such
+        interactive use in the most ordinary way, to print or display an
+        announcement including an appropriate copyright notice and a
+        notice that there is no warranty (or else, saying that you provide
+        a warranty) and that users may redistribute the program under
+        these conditions, and telling the user how to view a copy of this
+        License.  (Exception: if the Program itself is interactive but
+        does not normally print such an announcement, your work based on
+        the Program is not required to print an announcement.)
+
+    These requirements apply to the modified work as a whole.  If
+    identifiable sections of that work are not derived from the Program,
+    and can be reasonably considered independent and separate works in
+    themselves, then this License, and its terms, do not apply to those
+    sections when you distribute them as separate works.  But when you
+    distribute the same sections as part of a whole which is a work based
+    on the Program, the distribution of the whole must be on the terms of
+    this License, whose permissions for other licensees extend to the
+    entire whole, and thus to each and every part regardless of who wrote it.
+
+    Thus, it is not the intent of this section to claim rights or contest
+    your rights to work written entirely by you; rather, the intent is to
+    exercise the right to control the distribution of derivative or
+    collective works based on the Program.
+
+    In addition, mere aggregation of another work not based on the Program
+    with the Program (or with a work based on the Program) on a volume of
+    a storage or distribution medium does not bring the other work under
+    the scope of this License.
+
+      3. You may copy and distribute the Program (or a work based on it,
+    under Section 2) in object code or executable form under the terms of
+    Sections 1 and 2 above provided that you also do one of the following:
+
+        a) Accompany it with the complete corresponding machine-readable
+        source code, which must be distributed under the terms of Sections
+        1 and 2 above on a medium customarily used for software interchange; or,
+
+        b) Accompany it with a written offer, valid for at least three
+        years, to give any third party, for a charge no more than your
+        cost of physically performing source distribution, a complete
+        machine-readable copy of the corresponding source code, to be
+        distributed under the terms of Sections 1 and 2 above on a medium
+        customarily used for software interchange; or,
+
+        c) Accompany it with the information you received as to the offer
+        to distribute corresponding source code.  (This alternative is
+        allowed only for noncommercial distribution and only if you
+        received the program in object code or executable form with such
+        an offer, in accord with Subsection b above.)
+
+    The source code for a work means the preferred form of the work for
+    making modifications to it.  For an executable work, complete source
+    code means all the source code for all modules it contains, plus any
+    associated interface definition files, plus the scripts used to
+    control compilation and installation of the executable.  However, as a
+    special exception, the source code distributed need not include
+    anything that is normally distributed (in either source or binary
+    form) with the major components (compiler, kernel, and so on) of the
+    operating system on which the executable runs, unless that component
+    itself accompanies the executable.
+
+    If distribution of executable or object code is made by offering
+    access to copy from a designated place, then offering equivalent
+    access to copy the source code from the same place counts as
+    distribution of the source code, even though third parties are not
+    compelled to copy the source along with the object code.
+
+      4. You may not copy, modify, sublicense, or distribute the Program
+    except as expressly provided under this License.  Any attempt
+    otherwise to copy, modify, sublicense or distribute the Program is
+    void, and will automatically terminate your rights under this License.
+    However, parties who have received copies, or rights, from you under
+    this License will not have their licenses terminated so long as such
+    parties remain in full compliance.
+
+      5. You are not required to accept this License, since you have not
+    signed it.  However, nothing else grants you permission to modify or
+    distribute the Program or its derivative works.  These actions are
+    prohibited by law if you do not accept this License.  Therefore, by
+    modifying or distributing the Program (or any work based on the
+    Program), you indicate your acceptance of this License to do so, and
+    all its terms and conditions for copying, distributing or modifying
+    the Program or works based on it.
+
+      6. Each time you redistribute the Program (or any work based on the
+    Program), the recipient automatically receives a license from the
+    original licensor to copy, distribute or modify the Program subject to
+    these terms and conditions.  You may not impose any further
+    restrictions on the recipients' exercise of the rights granted herein.
+    You are not responsible for enforcing compliance by third parties to
+    this License.
+
+      7. If, as a consequence of a court judgment or allegation of patent
+    infringement or for any other reason (not limited to patent issues),
+    conditions are imposed on you (whether by court order, agreement or
+    otherwise) that contradict the conditions of this License, they do not
+    excuse you from the conditions of this License.  If you cannot
+    distribute so as to satisfy simultaneously your obligations under this
+    License and any other pertinent obligations, then as a consequence you
+    may not distribute the Program at all.  For example, if a patent
+    license would not permit royalty-free redistribution of the Program by
+    all those who receive copies directly or indirectly through you, then
+    the only way you could satisfy both it and this License would be to
+    refrain entirely from distribution of the Program.
+
+    If any portion of this section is held invalid or unenforceable under
+    any particular circumstance, the balance of the section is intended to
+    apply and the section as a whole is intended to apply in other
+    circumstances.
+
+    It is not the purpose of this section to induce you to infringe any
+    patents or other property right claims or to contest validity of any
+    such claims; this section has the sole purpose of protecting the
+    integrity of the free software distribution system, which is
+    implemented by public license practices.  Many people have made
+    generous contributions to the wide range of software distributed
+    through that system in reliance on consistent application of that
+    system; it is up to the author/donor to decide if he or she is willing
+    to distribute software through any other system and a licensee cannot
+    impose that choice.
+
+    This section is intended to make thoroughly clear what is believed to
+    be a consequence of the rest of this License.
+
+      8. If the distribution and/or use of the Program is restricted in
+    certain countries either by patents or by copyrighted interfaces, the
+    original copyright holder who places the Program under this License
+    may add an explicit geographical distribution limitation excluding
+    those countries, so that distribution is permitted only in or among
+    countries not thus excluded.  In such case, this License incorporates
+    the limitation as if written in the body of this License.
+
+      9. The Free Software Foundation may publish revised and/or new versions
+    of the General Public License from time to time.  Such new versions will
+    be similar in spirit to the present version, but may differ in detail to
+    address new problems or concerns.
+
+    Each version is given a distinguishing version number.  If the Program
+    specifies a version number of this License which applies to it and "any
+    later version", you have the option of following the terms and conditions
+    either of that version or of any later version published by the Free
+    Software Foundation.  If the Program does not specify a version number of
+    this License, you may choose any version ever published by the Free Software
+    Foundation.
+
+      10. If you wish to incorporate parts of the Program into other free
+    programs whose distribution conditions are different, write to the author
+    to ask for permission.  For software which is copyrighted by the Free
+    Software Foundation, write to the Free Software Foundation; we sometimes
+    make exceptions for this.  Our decision will be guided by the two goals
+    of preserving the free status of all derivatives of our free software and
+    of promoting the sharing and reuse of software generally.
+
+              NO WARRANTY
+
+      11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+    FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+    OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+    PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+    OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+    MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+    TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+    PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+    REPAIR OR CORRECTION.
+
+      12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+    WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+    REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+    INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+    OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+    TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+    YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+    PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+    POSSIBILITY OF SUCH DAMAGES.
+
+             END OF TERMS AND CONDITIONS
+
+          How to Apply These Terms to Your New Programs
+
+      If you develop a new program, and you want it to be of the greatest
+    possible use to the public, the best way to achieve this is to make it
+    free software which everyone can redistribute and change under these terms.
+
+      To do so, attach the following notices to the program.  It is safest
+    to attach them to the start of each source file to most effectively
+    convey the exclusion of warranty; and each file should have at least
+    the "copyright" line and a pointer to where the full notice is found.
+
+        <one line to give the program's name and a brief idea of what it does.>
+        Copyright (C) <year>  <name of author>
+
+        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 Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+    Also add information on how to contact you by electronic and paper mail.
+
+    If the program is interactive, make it output a short notice like this
+    when it starts in an interactive mode:
+
+        Gnomovision version 69, Copyright (C) year name of author
+        Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+        This is free software, and you are welcome to redistribute it
+        under certain conditions; type `show c' for details.
+
+    The hypothetical commands `show w' and `show c' should show the appropriate
+    parts of the General Public License.  Of course, the commands you use may
+    be called something other than `show w' and `show c'; they could even be
+    mouse-clicks or menu items--whatever suits your program.
+
+    You should also get your employer (if you work as a programmer) or your
+    school, if any, to sign a "copyright disclaimer" for the program, if
+    necessary.  Here is a sample; alter the names:
+
+      Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+      `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+      <signature of Ty Coon>, 1 April 1989
+      Ty Coon, President of Vice
+
+    This General Public License does not permit incorporating your program into
+    proprietary programs.  If your program is a subroutine library, you may
+    consider it more useful to permit linking proprietary applications with the
+    library.  If this is what you want to do, use the GNU Lesser General
+    Public License instead of this License.

data/README.md

@@ -0,0 +1,89 @@
+# Arachni-RPC
+<table>
+    <tr>
+        <th>Version</th>
+        <td>0.1</td>
+    </tr>
+    <tr>
+        <th>Github page</th>
+        <td><a href="http://github.com/Arachni/arachni-rpc">http://github.com/Arachni/arachni-rpc</a></td>
+     <tr/>
+    <tr>
+        <th>Code Documentation</th>
+        <td><a href="http://rubydoc.info/github/Arachni/arachni-rpc/">http://rubydoc.info/github/Arachni/arachni-rpc/</a></td>
+    </tr>
+    <tr>
+       <th>Author</th>
+       <td><a href="mailto:tasos.laskos@gmail.com">Tasos</a> "<a href="mailto:zapotek@segfault.gr">Zapotek</a>" <a href="mailto:tasos.laskos@gmail.com">Laskos</a></td>
+    </tr>
+    <tr>
+        <th>Twitter</th>
+        <td><a href="http://twitter.com/Zap0tek">@Zap0tek</a></td>
+    </tr>
+    <tr>
+        <th>Copyright</th>
+        <td>2011</td>
+    </tr>
+    <tr>
+        <th>License</th>
+        <td><a href="file.LICENSE.html">GNU General Public License v2</a></td>
+    </tr>
+</table>
+
+## Synopsis
+
+Arachni-RPC is a simple and lightweight Remote Procedure Call protocol which provides the basis for <a href="http://arachni.segfault.gr">Arachni</a>'s Grid infrastructure.
+
+This repository holds *only* the protocol specification although there currently are 2 (more like 1.5) available implementations:
+
+ - <a href="http://github.com/Arachni/arachni-rpc-em">Arachni-RPC EM</a> -- Uses EventMachine for network related operations and provides both a client and a server, this is the one used by Arachni.
+ - <a href="http://github.com/Arachni/arachni-rpc-pure">Arachni-RPC Pure</a> -- Provides a synchronous client using pure Ruby OpenSSL sockets and has no 3rd party dependencies.
+
+## Features
+
+It is:
+
+ - extremely lightweight
+ - very simple design
+ - provides token-based authentication
+
+## Installation
+
+I can't think of a lot of uses for manually installing the protocol specification
+(it'll most likely be installed as a dependency for some other project) but in case you want to some instructions follow.
+
+### Gem
+
+The Gem hasn't been pushed yet, the system is still under development.
+
+### Source
+
+If you want to clone the repository and work with the source code:
+
+    git co git://github.com/arachni/arachni-rpc.git
+    cd arachni-rpc
+    rake install
+
+
+## Running the Specs
+
+In order to run the specs you must first install RSpec:
+    gem install rspec
+
+Then:
+
+    rake spec
+
+## Protocol specifications
+
+You can find that information in the [Wiki](https://github.com/Arachni/arachni-rpc/wiki).
+
+## Bug reports/Feature requests
+Please send your feedback using Github's issue system at
+[http://github.com/arachni/arachni-rpc/issues](http://github.com/arachni/arachni-rpc/issues).
+
+
+## License
+Arachni is licensed under the GNU General Public License v2.<br/>
+See the [LICENSE](file.LICENSE.html) file for more information.
+

data/Rakefile

@@ -0,0 +1,80 @@
+=begin
+                  Arachni
+  Copyright (c) 2010-2011 Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+
+  This is free software; you can copy and distribute and modify
+  this program under the term of the GPL v2.0 License
+  (See LICENSE file for details)
+
+=end
+
+require 'rubygems'
+
+begin
+    require 'rspec'
+    require 'rspec/core/rake_task'
+
+    RSpec::Core::RakeTask.new do |t|
+      t.rspec_opts = ['--options', "\"#{File.dirname(__FILE__)}/spec/spec.opts\""]
+    end
+rescue
+end
+
+desc "Generate docs"
+
+task :docs do
+
+    outdir = "../arachni-rpc-pages"
+    sh "mkdir #{outdir}" if !File.directory?( outdir )
+
+    sh "yardoc --verbose --title \
+      \"Arachni-RPC\" \
+       lib/* -o #{outdir} \
+      - CHANGELOG.md LICENSE.md"
+
+
+    sh "rm -rf .yard*"
+end
+
+
+#
+# Cleans reports and logs
+#
+desc "Cleaning..."
+task :clean do
+    sh "rm *.gem || true"
+end
+
+
+
+#
+# Building
+#
+desc "Build the arachni-rpc gem."
+task :build => [ :clean ] do
+    sh "gem build arachni-rpc.gemspec"
+end
+
+
+#
+# Installing
+#
+desc "Build and install the arachni gem."
+task :install  => [ :build ] do
+
+    require File.expand_path( File.dirname( __FILE__ ) ) + '/lib/arachni/rpc/version'
+
+    sh "gem install arachni-rpc-#{Arachni::RPC::VERSION}.gem"
+end
+
+
+#
+# Publishing
+#
+desc "Push a new version to Gemcutter"
+task :publish => [ :build ] do
+
+    require File.expand_path( File.dirname( __FILE__ ) ) + '/lib/arachni/rpc/version'
+
+    sh "gem push arachni-rpc-#{Arachni::RPC::VERSION}.gem"
+end

data/lib/arachni/rpc.rb

@@ -0,0 +1,20 @@
+=begin
+                  Arachni
+  Copyright (c) 2010-2011 Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+
+  This is free software; you can copy and distribute and modify
+  this program under the term of the GPL v2.0 License
+  (See LICENSE file for details)
+
+=end
+
+require 'set'
+require 'yaml'
+
+require File.join( File.expand_path( File.dirname( __FILE__ ) ), 'rpc', 'version' )
+require File.join( File.expand_path( File.dirname( __FILE__ ) ), 'rpc', 'exceptions' )
+require File.join( File.expand_path( File.dirname( __FILE__ ) ), 'rpc', 'message' )
+require File.join( File.expand_path( File.dirname( __FILE__ ) ), 'rpc', 'request' )
+require File.join( File.expand_path( File.dirname( __FILE__ ) ), 'rpc', 'response' )
+require File.join( File.expand_path( File.dirname( __FILE__ ) ), 'rpc', 'remote_object_mapper' )
+

data/lib/arachni/rpc/exceptions.rb

@@ -0,0 +1,178 @@
+=begin
+                  Arachni-RPC
+  Copyright (c) 2011 Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+
+  This is free software; you can copy and distribute and modify
+  this program under the term of the GPL v2.0 License
+  (See LICENSE file for details)
+
+=end
+
+#
+# RPC Exceptions have methods that help identify them based on type.
+#
+# So in order to allow evaluations like:
+#
+#    my_object.rpc_connection_error?
+#
+# to be possible on all objects these helper methods need to be available for
+# all objects.
+#
+# By default they'll return false, individual RPC Exceptions will overwrite them to
+# return true when applicable.
+#
+class Object
+
+    # @return   [Bool]  false
+    def rpc_connection_error?
+        false
+    end
+
+    # @return   [Bool]  false
+    def rpc_remote_exception?
+        false
+    end
+
+    # @return   [Bool]  false
+    def rpc_invalid_object_error?
+        false
+    end
+
+    # @return   [Bool]  false
+    def rpc_invalid_method_error?
+        false
+    end
+
+    # @return   [Bool]  false
+    def rpc_invalid_token_error?
+        false
+    end
+
+    # @return   [Bool]  false
+    def rpc_exception?
+        false
+    end
+
+end
+
+module Arachni
+module RPC
+module Exceptions
+
+    #
+    # Returns an exception based on the response object.
+    #
+    # @param    [Arachni::RPC::Response]    response
+    #
+    # @return   [Exception]
+    #
+    def self.from_response( response )
+        obj = response.obj
+        klass = Arachni::RPC::Exceptions.const_get( obj['type'].to_sym )
+        e = klass.new( obj['exception'] )
+        e.set_backtrace( obj['backtrace'] )
+        return e
+    end
+
+    class Base < ::Exception
+        #
+        # @return   [Bool]  true
+        #
+        def rpc_exception?
+            true
+        end
+    end
+
+    #
+    # Signifies an abruptly terminated connection.
+    #
+    # Look for network or SSL errors or a dead server or a mistyped server address/port.
+    #
+    class ConnectionError < Base
+
+        #
+        # @return   [Bool]  true
+        #
+        def rpc_connection_error?
+            true
+        end
+    end
+
+    #
+    # Signifies an exception that occurred on the server-side.
+    #
+    # Look errors on the remote method and review the server output for more details.
+    #
+    class RemoteException < Base
+
+        #
+        # @return   [Bool]  true
+        #
+        def rpc_remote_exception?
+            true
+        end
+    end
+
+    #
+    # An invalid object has been called.
+    #
+    # Make sure that there is a server-side handler for the object you called.
+    #
+    class InvalidObject < Base
+
+        #
+        # @return   [Bool]  true
+        #
+        def rpc_invalid_object_error?
+            true
+        end
+
+    end
+
+    #
+    # An invalid method has been called.
+    #
+    # Occurs when a remote method doesn't exist or isn't public.
+    #
+    class InvalidMethod < Base
+
+        #
+        # @return   [Bool]  true
+        #
+        def rpc_invalid_method_error?
+            true
+        end
+
+    end
+
+    #
+    # Signifies an authentication token mismatch between the client and the server.
+    #
+    class InvalidToken  < Base
+
+        #
+        # @return   [Bool]  true
+        #
+        def rpc_invalid_token_error?
+            true
+        end
+
+    end
+
+    #
+    # Signifies an authentication token mismatch between the client and the server.
+    #
+    class SSLPeerVerificationFailed  < ConnectionError
+
+        #
+        # @return   [Bool]  true
+        #
+        def rpc_ssl_error?
+            true
+        end
+
+    end
+
+end
+end
+end

data/lib/arachni/rpc/message.rb

@@ -0,0 +1,87 @@
+=begin
+                  Arachni-RPC
+  Copyright (c) 2011 Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+
+  This is free software; you can copy and distribute and modify
+  this program under the term of the GPL v2.0 License
+  (See LICENSE file for details)
+
+=end
+
+require File.join( File.expand_path( File.dirname( __FILE__ ) ), '../', 'rpc' )
+
+module Arachni
+module RPC
+
+#
+# Represents an RPC message, serves as the basis for {Request} and {Response}.
+#
+# @author: Tasos "Zapotek" Laskos
+#                                      <tasos.laskos@gmail.com>
+#                                      <zapotek@segfault.gr>
+# @version: 0.1
+#
+class Message
+
+    #
+    # @param    [Hash]   opts   sets instance attributes
+    #
+    def initialize( opts = {} )
+        opts.each_pair {
+            |k, v|
+            instance_variable_set( "@#{k}".to_sym, v )
+        }
+    end
+
+    #
+    # Merges the attributes of another message with self.
+    #
+    # (The param doesn't *really* have to be a message, any object will do.)
+    #
+    # @param    [Message]   message
+    #
+    def merge!( message )
+        message.instance_variables.each {
+            |var|
+            val = message.instance_variable_get( var )
+            instance_variable_set( var, val )
+        }
+    end
+
+    #
+    # Prepares the message for transmission (i.e. converts the message to a Hash).
+    #
+    # Attributes that should not be included can be skipped by implementing
+    # {#transmit?} and returning the appropriate value.
+    #
+    # @return   [Hash]
+    #
+    def prepare_for_tx
+        hash = {}
+        instance_variables.each {
+            |k|
+            next if !transmit?( k )
+            hash[normalize( k )] = instance_variable_get( k )
+        }
+        return hash
+    end
+
+    #
+    # Decides which attributes should be skipped by {#prepare_for_tx}.
+    #
+    # @param    [Symbol]    attr    attribute symbol (i.e. :@token)
+    #
+    def transmit?( attr )
+        return true
+    end
+
+    private
+
+    def normalize( attr )
+        attr.to_s.gsub( '@', '' )
+    end
+
+end
+
+end
+end

data/lib/arachni/rpc/remote_object_mapper.rb

@@ -0,0 +1,70 @@
+=begin
+                  Arachni-RPC
+  Copyright (c) 2011 Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+
+  This is free software; you can copy and distribute and modify
+  this program under the term of the GPL v2.0 License
+  (See LICENSE file for details)
+
+=end
+
+require File.join( File.expand_path( File.dirname( __FILE__ ) ), '../', 'rpc' )
+
+module Arachni
+module RPC
+
+#
+# Maps the methods of remote objects to local ones.
+# (Well, not really, it just passes the message along to the remote end.)
+#
+# You start like:
+#
+#    server = Arachni::RPC::EM::Client.new( :host => 'localhost', :port => 7331 )
+#    bench  = Arachni::RPC::EM::Client::Mapper.new( server, 'bench' )
+#
+# And it allows you to do this:
+#
+#    res = bench.foo( 1, 2, 3 )
+#
+# Instead of:
+#
+#    res = client.call( 'bench.foo', 1, 2, 3 )
+#
+#
+#
+# The server on the other end must have an appropriate handler set, like:
+#
+#    class Bench
+#        def foo( i = 0 )
+#            return i
+#        end
+#    end
+#
+#    server = Arachni::RPC::EM::Server.new( :host => 'localhost', :port => 7331 )
+#    server.add_handler( 'bench', Bench.new )
+#
+# @author: Tasos "Zapotek" Laskos
+#                                      <tasos.laskos@gmail.com>
+#                                      <zapotek@segfault.gr>
+# @version: 0.1
+#
+class RemoteObjectMapper
+
+    def initialize( server, remote )
+        @server = server
+        @remote = remote
+    end
+
+    private
+    #
+    # Used to provide the illusion of locality for remote methods
+    #
+    def method_missing( sym, *args, &block )
+        call = "#{@remote}.#{sym.to_s}"
+        @server.call( call, *args, &block )
+    end
+
+end
+
+end
+end

data/lib/arachni/rpc/request.rb

@@ -0,0 +1,95 @@
+=begin
+                  Arachni-RPC
+  Copyright (c) 2011 Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+
+  This is free software; you can copy and distribute and modify
+  this program under the term of the GPL v2.0 License
+  (See LICENSE file for details)
+
+=end
+
+require File.join( File.expand_path( File.dirname( __FILE__ ) ), '../', 'rpc' )
+
+module Arachni
+module RPC
+
+#
+# Represents an RPC request.
+#
+# It's here only for formalization purposes,
+# it's not actually sent over the wire.
+#
+# What is sent is a hash generated by {#prepare_for_tx}.
+# which is in the form of:
+#
+#
+#    {
+#        'message'     => msg, # RPC message in the form of 'handler.method'
+#        'args'        => args, # optional array of arguments for the remote method
+#        'token'       => token, # optional authentication token
+#    }
+#
+# Any client that has SSL support and can serialize a Hash
+# just like the one above can communicate with the RPC server.
+#
+# @author: Tasos "Zapotek" Laskos
+#                                      <tasos.laskos@gmail.com>
+#                                      <zapotek@segfault.gr>
+# @version: 0.1
+#
+class Request < Message
+
+    #
+    # RPC message in the form of 'handler.method'.
+    #
+    # @return   [String]
+    #
+    attr_accessor :message
+
+    #
+    # Optional array of arguments for the remote method.
+    #
+    # @return   [Array]
+    #
+    attr_accessor :args
+
+    #
+    # Optional authentication token.
+    #
+    # @return   [String]
+    #
+    attr_accessor :token
+
+    #
+    # Callback to be invoked on the response.
+    #
+    # @return   [Proc]
+    #
+    attr_accessor :callback
+
+    # @see Message#initialize
+    def initialize( * )
+        super
+    end
+
+    def do_not_defer!
+        @defer = false
+    end
+
+    def defer?
+        @defer.nil? ? true : @defer
+    end
+
+    private
+
+    def transmit?( attr )
+        ![
+            :@defer,
+            :@callback
+        ].include?( attr )
+    end
+
+end
+
+end
+end

data/lib/arachni/rpc/response.rb

@@ -0,0 +1,86 @@
+=begin
+                  Arachni-RPC
+  Copyright (c) 2011 Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+
+  This is free software; you can copy and distribute and modify
+  this program under the term of the GPL v2.0 License
+  (See LICENSE file for details)
+
+=end
+
+require File.join( File.expand_path( File.dirname( __FILE__ ) ), '../', 'rpc' )
+
+module Arachni
+module RPC
+
+#
+# Represents an RPC response.
+#
+# It's here only for formalization purposes, it's not actually sent over the wire.
+#
+# What is sent is a hash generated by {#prepare_for_tx}
+# which is in the form of:
+#
+#
+#    {
+#        # result of the RPC call
+#        'obj'       => object
+#    }
+#
+# @author: Tasos "Zapotek" Laskos
+#                                      <tasos.laskos@gmail.com>
+#                                      <zapotek@segfault.gr>
+# @version: 0.1
+#
+class Response < Message
+
+    #
+    # Return object of the {Request#message}.
+    #
+    # If there was an exception it will hold a Hash like:
+    #
+    #    {
+    #        "exception" => "Trying to access non-existent object 'blah'.",
+    #        "backtrace" => [
+    #            [0] "/home/zapotek/workspace/arachni-rpc/lib/arachni/rpc/server.rb:285:in `call'",
+    #            [1] "/home/zapotek/workspace/arachni-rpc/lib/arachni/rpc/server.rb:85:in `block in receive_object'",
+    #            [2] "/home/zapotek/.rvm/gems/ruby-1.9.2-p180/gems/eventmachine-1.0.0.beta.3/lib/eventmachine.rb:1009:in `call'",
+    #            [3] "/home/zapotek/.rvm/gems/ruby-1.9.2-p180/gems/eventmachine-1.0.0.beta.3/lib/eventmachine.rb:1009:in `block in spawn_threadpool'"
+    #        ],
+    #             "type" => "InvalidObject"
+    #    }
+    #
+    # For all available exception types look at {Exceptions}.
+    #
+    # @return   [Object]
+    #
+    attr_accessor :obj
+
+    # @see Message#initialize
+    def initialize( * )
+        super
+
+        @async = false
+    end
+
+    def async?
+        @async
+    end
+
+    def async!
+        @async = true
+    end
+
+    private
+
+    def transmit?( attr )
+        ![
+            :@async
+        ].include?( attr )
+    end
+
+
+end
+
+end
+end

data/lib/arachni/rpc/version.rb

@@ -0,0 +1,15 @@
+=begin
+                  Arachni-RPC
+  Copyright (c) 2011 Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+
+  This is free software; you can copy and distribute and modify
+  this program under the term of the GPL v2.0 License
+  (See LICENSE file for details)
+
+=end
+
+module Arachni
+module RPC
+    VERSION = '0.1'
+end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: arachni-rpc
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Tasos Laskos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-14 00:00:00.000000000 Z
+dependencies: []
+description: ! "        Arachni-RPC is a simple and lightweight Remote Procedure Call
+  protocol\n        used to provide the basis for Arachni's Grid infrastructure.\n"
+email: tasos.laskos@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.md
+- CHANGELOG.md
+files:
+- README.md
+- Rakefile
+- LICENSE.md
+- CHANGELOG.md
+- lib/arachni/rpc/response.rb
+- lib/arachni/rpc/version.rb
+- lib/arachni/rpc/remote_object_mapper.rb
+- lib/arachni/rpc/exceptions.rb
+- lib/arachni/rpc/request.rb
+- lib/arachni/rpc/message.rb
+- lib/arachni/rpc.rb
+homepage: https://github.com/Arachni/arachni-rpc
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: The RPC protocol specification of the Arachni WebAppSec scanner Grid.
+test_files: []
+has_rdoc: