arachni 0.3 → 0.4

data/lib/{plugin → arachni/plugin}/base.rb

@@ -1,6 +1,6 @@
 =begin
                   Arachni
-  Copyright (c) 2010-2011 Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+  Copyright (c) 2010-2012 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
@@ -24,7 +24,8 @@ class Formatter
     include Arachni::UI::Output
 
     def initialize( plugin_data )
-
+        @results     = plugin_data[:results]
+        @description = plugin_data[:description]
     end
 
     def run
@@ -42,13 +43,14 @@ end
 # @author: Tasos "Zapotek" Laskos
 #                                      <tasos.laskos@gmail.com>
 #                                      <zapotek@segfault.gr>
-# @version: 0.1
+# @version: 0.1.1
 # @abstract
 #
 class Base
 
     # get the output interface
     include Arachni::Module::Output
+    include Arachni::Module::Utilities
 
     #
     # @param    [Arachni::Framework]    framework
@@ -81,14 +83,46 @@ class Base
 
     end
 
-    def register_results( results )
-        @framework.plugin_store( self, results )
+    def wait_while_framework_running
+        ::IO.select( nil, nil, nil, 1 ) while( @framework.running? )
+    end
+
+    def self.gems
+        [ ]
+    end
+
+    #
+    # OPTIONAL
+    #
+    # Only used when in Grid mode.
+    #
+    # Should the plug-in be distributed
+    # across all instances or only run by the master
+    # prior to any distributed operations?
+    #
+    # For example, if a plug-in dynamically modifies the framework options
+    # in any way and wants these changes to be identical
+    # across instances this method should return 'false'.
+    #
+    def self.distributable?
+        false
+    end
+
+    #
+    # REQUIRED IF self.distributable? RETURNS 'TRUE'
+    #
+    # Only used when in Grid mode.
+    #
+    # Merges an array of results as gathered by the plug-in when run
+    # by multiple instances.
+    #
+    def self.merge( results )
     end
 
     #
     # REQUIRED
     #
-    # Do not ommit any of the info.
+    # Do not omit any of the info.
     #
     def self.info
         {
@@ -104,6 +138,9 @@ class Base
         }
     end
 
+    def register_results( results )
+        @framework.plugin_store( self, results )
+    end
 end
 
 end

data/lib/{plugin → arachni/plugin}/manager.rb

@@ -1,6 +1,6 @@
 =begin
                   Arachni
-  Copyright (c) 2010-2011 Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+  Copyright (c) 2010-2012 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
@@ -14,16 +14,6 @@ module Arachni
 # The namespace under which all plugins exist
 #
 module Plugins
-
-    #
-    # Resets the namespace unloading all module classes
-    #
-    def self.reset
-        constants.each {
-            |const|
-            remove_const( const )
-        }
-    end
 end
 
 module Plugin
@@ -40,7 +30,9 @@ class Manager < Arachni::ComponentManager
 
     include Arachni::Module::Utilities
 
-    ALWAYS_ON = [ 'metamodules', 'content_types', 'healthmap' ]
+    DEFAULT = [
+        'defaults/*'
+    ]
 
     #
     # @param    [Arachni::Framework]    framework   framework instance
@@ -53,7 +45,7 @@ class Manager < Arachni::ComponentManager
     end
 
     def load_defaults!
-        load( ALWAYS_ON )
+        load( DEFAULT )
     end
 
     #
@@ -64,6 +56,21 @@ class Manager < Arachni::ComponentManager
         each {
             |name, plugin|
 
+            if( ret = sane_env?( plugin ) ) != true
+                if !ret[:gem_errors].empty?
+                    print_error( "[#{name}] The following plug-in dependencies aren't satisfied:" )
+                    ret[:gem_errors].each {
+                       |gem|
+                        print_info( "\t* #{gem}" )
+                    }
+
+                    print_info( "Try installing them by running:" )
+                    print_info( "\tgem install #{ret[:gem_errors].join( ' ' )}" )
+                end
+
+                raise
+            end
+
             @jobs << Thread.new {
 
                 exception_jail {
@@ -86,6 +93,25 @@ class Manager < Arachni::ComponentManager
         end
     end
 
+    def sane_env?( plugin )
+        gem_errors = []
+
+        plugin.gems.each {
+            |gem|
+            begin
+                require gem
+            rescue Exception => e
+                gem_errors << gem
+            end
+        }
+
+        return {
+            :gem_errors => gem_errors
+        } if !gem_errors.empty?
+
+        return true
+    end
+
     def create( name )
         opts = @framework.opts.plugins[name]
         self[name].new( @framework, prep_opts( name, self[name], opts ) )
@@ -154,6 +180,7 @@ class Manager < Arachni::ComponentManager
     #
     def get( name )
         @jobs.each { |job| return job if job[:name] == name }
+        return
     end
 
 

data/lib/{report → arachni/report}/base.rb

@@ -1,6 +1,6 @@
 =begin
                   Arachni
-  Copyright (c) 2010-2011 Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+  Copyright (c) 2010-2012 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
@@ -11,6 +11,37 @@
 module Arachni
 module Report
 
+#
+# Provides some common options for the reports
+#
+#
+# @author: Tasos "Zapotek" Laskos
+#                                      <tasos.laskos@gmail.com>
+#                                      <zapotek@segfault.gr>
+# @version: 0.1
+#
+module Options
+
+    #
+    # Returns a string option named 'outfile'.
+    #
+    # Default value is:
+    #   year-month-day hour.minute.second +timezone.extension
+    #
+    # @param    [String]    ext     extension for the outfile
+    # @param    [String]    desc    description of the option
+    #
+    # @return   [Arachni::OptString]
+    #
+    def outfile( ext = '', desc = 'Where to save the report.' )
+        Arachni::OptString.new( 'outfile', [ false, desc,
+            Time.now.to_s.gsub( ':', '.' ) + ext ] )
+    end
+
+    extend self
+end
+
+
 class FormatterManager < ComponentManager
 
     def paths
@@ -45,6 +76,15 @@ class Base
 
     end
 
+    #
+    # @param    [AuditStore]  audit_store
+    # @param    [Hash]        options       options passed to the report
+    #
+    def initialize( audit_store, options )
+        @audit_store   = audit_store
+        @options       = options
+    end
+
     #
     # REQUIRED
     #
@@ -59,6 +99,8 @@ class Base
     # @param    [AuditStore#plugins]      plugins   plugin data/results
     #
     def format_plugin_results( plugins )
+        formatted = {}
+        return formatted if !plugins
 
         # get the object that extends this class (i.e. the running report)
         ancestor = self.class.ancestors[0]
@@ -82,7 +124,6 @@ class Base
         @@formatters[ancestor].load( ['*'] ) if @@formatters[ancestor].empty?
 
         # run the formatters and gather the formatted data they return
-        formatted = {}
         @@formatters[ancestor].each_pair {
             |name, formatter|
             plugin_results = plugins[name]

data/lib/{report → arachni/report}/manager.rb

@@ -1,6 +1,6 @@
 =begin
                   Arachni
-  Copyright (c) 2010-2011 Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+  Copyright (c) 2010-2012 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
@@ -14,16 +14,6 @@ module Arachni
 # The namespace under which all modules exist
 #
 module Reports
-
-    #
-    # Resets the namespace unloading all module classes
-    #
-    def self.reset
-        constants.each {
-            |const|
-            remove_const( const )
-        }
-    end
 end
 
 module Report
@@ -56,13 +46,16 @@ class Manager < Arachni::ComponentManager
     # @param  [AuditStore]  audit_store
     #
     def run( audit_store, run_afr = true )
+        if run_afr
+            # run the default report first
+            run_one( 'afr', audit_store.deep_clone )
+            delete( 'afr' )
+        end
+
         self.each {
             |name, report|
             run_one( name, audit_store.deep_clone )
         }
-
-        # run the default report
-        run_one( 'afr', audit_store.deep_clone ) if run_afr
     end
 
     def run_one( name, audit_store )
@@ -78,10 +71,6 @@ class Manager < Arachni::ComponentManager
     end
 
 
-    def self.reset
-        Arachni::Reports.reset
-    end
-
     def extension
         return EXTENSION
     end

data/lib/arachni/rpc/client/base.rb

@@ -0,0 +1,42 @@
+=begin
+                  Arachni
+  Copyright (c) 2010-2012 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 'arachni/rpc/em'
+
+module Arachni
+module RPC
+
+class Client
+
+#
+# @author: Tasos "Zapotek" Laskos
+#                                      <tasos.laskos@gmail.com>
+#                                      <zapotek@segfault.gr>
+# @version: 0.1
+#
+class Base < ::Arachni::RPC::EM::Client
+
+    def initialize( opts, url, token = nil )
+        host, port = url.split( ':' )
+        super(
+            :host  => host,
+            :port  => port,
+            :token => token,
+            :keep_alive => false,
+            :ssl_ca     => opts.ssl_ca,
+            :ssl_pkey   => opts.node_ssl_pkey || opts.ssl_pkey,
+            :ssl_cert   => opts.node_ssl_cert || opts.ssl_cert
+        )
+    end
+
+end
+end
+end
+end

data/lib/{rpc/xml → arachni/rpc}/client/dispatcher.rb

@@ -1,6 +1,6 @@
 =begin
                   Arachni
-  Copyright (c) 2010-2011 Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+  Copyright (c) 2010-2012 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
@@ -8,29 +8,29 @@
 
 =end
 
-require 'xmlrpc/client'
-require 'openssl'
-
 module Arachni
 
-require Arachni::Options.instance.dir['lib'] + 'rpc/xml/client/base'
+require Arachni::Options.instance.dir['lib'] + 'rpc/client/base'
 
 module RPC
-module XML
-module Client
+class Client
 
 #
-# XMLRPC Dispatcher client
+# RPC Dispatcher client
 #
 # @author: Tasos "Zapotek" Laskos
 #                                      <tasos.laskos@gmail.com>
 #                                      <zapotek@segfault.gr>
-# @version: 0.1.2
+# @version: 0.1.3
 #
-class Dispatcher < Base
+class Dispatcher
+
+    attr_reader :node
 
     def initialize( opts, url )
-        super( opts, url )
+        @client = Base.new( opts, url )
+
+        @node = RemoteObjectMapper.new( @client, 'node' )
     end
 
     private
@@ -38,7 +38,7 @@ class Dispatcher < Base
     # Used to provide the illusion of locality for remote methods
     #
     def method_missing( sym, *args, &block )
-        call( "dispatcher.#{sym.to_s}", *args )
+        @client.call( "dispatcher.#{sym.to_s}", *args, &block )
     end
 
 end
@@ -46,4 +46,3 @@ end
 end
 end
 end
-end

data/lib/arachni/rpc/client/instance.rb

@@ -0,0 +1,62 @@
+=begin
+                  Arachni
+  Copyright (c) 2010-2012 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
+
+require Arachni::Options.instance.dir['lib'] + 'rpc/client/base'
+
+module RPC
+class Client
+
+#
+# RPC client for remote instances spawned by a remote dispatcher
+#
+# @author: Tasos "Zapotek" Laskos
+#                                      <tasos.laskos@gmail.com>
+#                                      <zapotek@segfault.gr>
+# @version: 0.1.3
+#
+class Instance
+
+    attr_reader :opts
+    attr_reader :framework
+    attr_reader :modules
+    attr_reader :plugins
+    attr_reader :service
+
+    #
+    # Used to make remote option attributes look like setter methods
+    #
+    class OptsMapper < RemoteObjectMapper
+
+        def method_missing( sym, *args, &block )
+            return super( sym, *args, &block ) if sym == :set
+
+            call = "#{@remote}.#{sym.to_s}="
+            @server.call( call, *args, &block )
+        end
+
+    end
+
+    def initialize( opts, url, token = nil )
+        @client = Base.new( opts, url, token )
+
+        @opts      = OptsMapper.new( @client, 'opts' )
+        @framework = RemoteObjectMapper.new( @client, 'framework' )
+        @modules   = RemoteObjectMapper.new( @client, 'modules' )
+        @plugins   = RemoteObjectMapper.new( @client, 'plugins' )
+        @service   = RemoteObjectMapper.new( @client, 'service' )
+    end
+
+end
+
+end
+end
+end