arachni 0.4.2 → 0.4.3

data/lib/arachni/plugin.rb

@@ -1,4 +1,20 @@
+=begin
+    Copyright 2010-2013 Tasos Laskos <tasos.laskos@gmail.com>
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+=end
+
 lib = Arachni::Options.dir['lib']
-require lib. + 'component/manager'
+require lib + 'component/manager'
 require lib + 'plugin/base'
 require lib + 'plugin/manager'

data/lib/arachni/plugin/manager.rb

@@ -38,12 +38,13 @@ class Manager < Arachni::Component::Manager
     include Utilities
     extend  Utilities
 
+    # Namespace under which all plugins reside.
     NAMESPACE = Arachni::Plugins
+
+    # Expressions matching default plugins.
     DEFAULT   = %w(defaults/*)
 
-    #
-    # @param    [Arachni::Framework]    framework   framework instance
-    #
+    # @param    [Arachni::Framework]    framework   Framework instance.
     def initialize( framework )
         super( framework.opts.dir['plugins'], NAMESPACE )
         @framework = framework
@@ -51,19 +52,24 @@ class Manager < Arachni::Component::Manager
         @jobs = []
     end
 
+    # Loads the default plugins.
+    #
+    # @see DEFAULT
     def load_default
         load DEFAULT
     end
     alias :load_defaults :load_default
 
+    # @return   [Array<String>] Components to load, by name.
     def default
         parse DEFAULT
     end
     alias :defaults :default
 
-    #
     # Runs each plug-in in its own thread.
     #
+    # @raise [Error::UnsatisfiedDependency]
+    #   If the environment is {#sane_env? not sane}.
     def run
         ordered   = []
         unordered = []
@@ -87,12 +93,12 @@ class Manager < Arachni::Component::Manager
             if( ret = sane_env?( plugin ) ) != true
                 deps = ''
                 if !ret[:gem_errors].empty?
-                    print_bad( "[#{name}] The following plug-in dependencies aren't satisfied:" )
-                    ret[:gem_errors].each { |gem| print_bad( "\t* #{gem}" ) }
+                    print_bad "[#{name}] The following plug-in dependencies aren't satisfied:"
+                    ret[:gem_errors].each { |gem| print_bad "\t* #{gem}" }
 
                     deps = ret[:gem_errors].join( ' ' )
-                    print_bad( "Try installing them by running:" )
-                    print_bad( "\tgem install #{deps}" )
+                    print_bad 'Try installing them by running:'
+                    print_bad "\tgem install #{deps}"
                 end
 
                 fail Error::UnsatisfiedDependency,
@@ -116,12 +122,16 @@ class Manager < Arachni::Component::Manager
             }
         end
 
-        if @jobs.size > 0
-            print_status( 'Waiting for plugins to settle...' )
-            ::IO::select( nil, nil, nil, 1 )
-        end
+        return if @jobs.empty?
+
+        print_status 'Waiting for plugins to settle...'
+        ::IO::select( nil, nil, nil, 1 )
     end
 
+    # Checks whether or not the environment satisfies all plugin dependencies.
+    #
+    # @return   [TrueClass, Hash]
+    #   `true` if the environment is sane, a hash with errors otherwise.
     def sane_env?( plugin )
         gem_errors = []
 
@@ -141,50 +151,38 @@ class Manager < Arachni::Component::Manager
         self[name].new( @framework, opts )
     end
 
-    #
     # Blocks until all plug-ins have finished executing.
-    #
     def block
         while !@jobs.empty?
             print_debug
-            print_debug( "Waiting on the following (#{@jobs.size}) plugins to finish:" )
-            print_debug( job_names.join( ', ' ) )
+            print_debug "Waiting on the following (#{@jobs.size}) plugins to finish:"
+            print_debug job_names.join( ', ' )
             print_debug
 
             @jobs.delete_if { |j| !j.alive? }
             ::IO::select( nil, nil, nil, 1 )
         end
+        nil
     end
 
-    #
-    # Will return false if all plug-ins have finished executing.
-    #
     # @return   [Bool]
-    #
+    #   `false` if all plug-ins have finished executing, `true` otherwise.
     def busy?
         !@jobs.reject{ |j| j.alive? }.empty?
     end
 
-    #
-    # Returns the names of the running plug-ins.
-    #
-    # @return   [Array]
-    #
+    # @return   [Array] Names of all running plug-ins.
     def job_names
         @jobs.map{ |j| j[:name] }
     end
 
-    #
-    # Returns all the running threads.
-    #
-    # @return   [Array<Thread>]
-    #
+    # @return   [Array<Thread>] All the running threads.
     def jobs
         @jobs
     end
 
     #
-    # Kills a plug-in by name.
+    # Kills a plug-in by `name`.
     #
     # @param    [String]    name
     #
@@ -207,9 +205,9 @@ class Manager < Arachni::Component::Manager
     end
 
     #
-    # Registers plugin results
+    # Registers plugin results.
     #
-    # @param    [Arachni::Plugin::Base]    plugin   instance of a plugin
+    # @param    [Arachni::Plugin::Base]    plugin   Instance of a plugin.
     # @param    [Object]    results
     #
     def register_results( plugin, results )
@@ -223,7 +221,8 @@ class Manager < Arachni::Component::Manager
             end
 
             return if !name
-            self.class.results[name] = { results: results }.merge( plugin.class.info )
+            self.class.results[name] =
+                { results: results }.merge( plugin.class.info )
         }
     end
 
@@ -235,14 +234,14 @@ class Manager < Arachni::Component::Manager
     end
 
     def self.results
-        @@results ||= {}
+        @results ||= {}
     end
     def results
         self.class.results
     end
 
     def self.results=( v )
-        @@results = v
+        @results = v
     end
     def results=( v )
         self.class.results = v

data/lib/arachni/processes.rb

@@ -0,0 +1,27 @@
+=begin
+    Copyright 2010-2013 Tasos Laskos <tasos.laskos@gmail.com>
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+=end
+
+require 'singleton'
+require 'ostruct'
+
+lib = Arachni::Options.dir['lib']
+require lib + 'rpc/client/instance'
+require lib + 'rpc/client/dispatcher'
+
+lib = Arachni::Options.dir['lib'] + 'processes/'
+require lib + 'manager'
+require lib + 'dispatchers'
+require lib + 'instances'

data/lib/arachni/processes/dispatchers.rb

@@ -0,0 +1,149 @@
+=begin
+    Copyright 2010-2013 Tasos Laskos <tasos.laskos@gmail.com>
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+=end
+
+module Arachni
+module Processes
+
+#
+# Helper for managing {RPC::Server::Dispatcher} processes.
+#
+# @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+#
+class Dispatchers
+    include Singleton
+    include Utilities
+
+    # @return   [Array<String>] URLs of all running Dispatchers.
+    attr_reader :list
+
+    def initialize
+        @list = []
+        @dispatcher_connections = {}
+    end
+
+    #
+    # Connects to a Dispatcher by URL.
+    #
+    # @param    [String]    url URL of the Dispatcher.
+    # @param    [Hash]    options Options for the RPC client.
+    #
+    # @return   [RPC::Client::Dispatcher]
+    #
+    def connect( url, options = { } )
+        opts = OpenStruct.new( options )
+        @dispatcher_connections[url] ||= RPC::Client::Dispatcher.new( opts, url )
+    end
+
+    # @param    [Block] block   Block to pass an RPC client for each Dispatcher.
+    def each( &block )
+        @list.each do |url|
+            block.call connect( url )
+        end
+    end
+
+    #
+    # Spawns a {RPC::Server::Dispatcher} process.
+    #
+    # @param    [Hash]  options
+    #   To be passed to {Arachni::Options#set}. Allows `address` instead of
+    #   `rpc_address` and `port` instead of `rpc_port`.
+    #
+    # @param    [Block] block
+    #   Passed {Arachni::Options} to configure the Dispatcher options.
+    #
+    # @return   [RPC::Client::Dispatcher]
+    #
+    def spawn( options = {}, &block )
+        options = Options.to_hash.symbolize_keys( false ).merge( options )
+
+        options[:rpc_port]    = options.delete( :port ) if options.include?( :port )
+        options[:rpc_address] = options.delete( :address ) if options.include?( :address )
+
+        options[:rpc_port]    ||= available_port
+
+        url = "#{options[:rpc_address]}:#{options[:rpc_port]}"
+
+        Manager.fork_em do
+            Options.set( options )
+            block.call( Options.instance ) if block_given?
+
+            require "#{Arachni::Options.dir['lib']}/rpc/server/dispatcher"
+
+            RPC::Server::Dispatcher.new
+        end
+
+        begin
+            Timeout.timeout( 10 ) do
+                while sleep( 0.1 )
+                    begin
+                        connect( url, max_retries: 1 ).alive?
+                        break
+                    rescue Exception
+                    end
+                end
+            end
+        rescue Timeout::Error
+            abort "Dispatcher '#{url}' never started!"
+        end
+
+        @list << url
+        connect( url )
+    end
+
+    # Same as {#spawn} but sets the pool size to `1`.
+    def light_spawn( options = {}, &block )
+        spawn( options.merge( pool_size: 1 ), &block )
+    end
+
+    # @note Will also kill all Instances started by the Dispatcher.
+    #
+    # @param    [String]    url URL of the Dispatcher to kill.
+    def kill( url )
+        dispatcher = connect( url )
+        Manager.kill_many dispatcher.stats['consumed_pids']
+        Manager.kill dispatcher.proc_info['pid'].to_i
+    rescue => e
+        #ap e
+        #ap e.backtrace
+        nil
+    ensure
+        @list.delete( url )
+        @dispatcher_connections.delete( url )
+    end
+
+    # Kills all {Dispatchers #list}.
+    def killall
+        @list.dup.each do |url|
+            kill url
+        end
+    end
+
+    def self.method_missing( sym, *args, &block )
+        if instance.respond_to?( sym )
+            instance.send( sym, *args, &block )
+        elsif
+        super( sym, *args, &block )
+        end
+    end
+
+    def self.respond_to?( m )
+        super( m ) || instance.respond_to?( m )
+    end
+
+end
+
+end
+end

data/lib/arachni/processes/helpers.rb

@@ -0,0 +1,19 @@
+=begin
+    Copyright 2010-2013 Tasos Laskos <tasos.laskos@gmail.com>
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+=end
+
+require_relative 'helpers/processes'
+require_relative 'helpers/dispatchers'
+require_relative 'helpers/instances'

data/lib/arachni/processes/helpers/dispatchers.rb

@@ -0,0 +1,45 @@
+=begin
+    Copyright 2010-2013 Tasos Laskos <tasos.laskos@gmail.com>
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+=end
+
+# @param (see Arachni::Processes::Dispatchers#spawn)
+# @return (see Arachni::Processes::Dispatchers#spawn)
+def dispatcher_spawn( *args )
+    Arachni::Processes::Dispatchers.spawn( *args )
+end
+
+# @param (see Arachni::Processes::Dispatchers#light_spawn)
+# @return (see Arachni::Processes::Dispatchers#light_spawn)
+def dispatcher_light_spawn( *args )
+    Arachni::Processes::Dispatchers.light_spawn( *args )
+end
+
+# @param (see Arachni::Processes::Dispatchers#kill)
+# @return (see Arachni::Processes::Dispatchers#kill)
+def dispatcher_kill( *args )
+    Arachni::Processes::Dispatchers.kill( *args )
+end
+
+# @param (see Arachni::Processes::Dispatchers#killall)
+# @return (see Arachni::Processes::Dispatchers#killall)
+def dispatcher_killall
+    Arachni::Processes::Dispatchers.killall
+end
+
+# @param (see Arachni::Processes::Dispatchers#connect)
+# @return (see Arachni::Processes::Dispatchers#connect)
+def dispatcher_connect( *args )
+    Arachni::Processes::Dispatchers.connect( *args )
+end

data/lib/arachni/processes/helpers/instances.rb

@@ -0,0 +1,51 @@
+=begin
+    Copyright 2010-2013 Tasos Laskos <tasos.laskos@gmail.com>
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+=end
+
+# @param (see Arachni::Processes::Instances#spawn)
+# @return (see Arachni::Processes::Instances#spawn)
+def instance_spawn( *args )
+    Arachni::Processes::Instances.spawn( *args )
+end
+
+# @param (see Arachni::Processes::Instances#grid_spawn)
+# @return (see Arachni::Processes::Instances#grid_spawn)
+def instance_grid_spawn( *args )
+    Arachni::Processes::Instances.grid_spawn( *args )
+end
+
+# @param (see Arachni::Processes::Instances#dispatcher_spawn)
+# @return (see Arachni::Processes::Instances#dispatcher_spawn)
+def instance_dispatcher_spawn( *args )
+    Arachni::Processes::Instances.dispatcher_spawn( *args )
+end
+
+# @param (see Arachni::Processes::Instances#killall)
+# @return (see Arachni::Processes::Instances#killall)
+def instance_killall
+    Arachni::Processes::Instances.killall
+end
+
+# @param (see Arachni::Processes::Instances#connect)
+# @return (see Arachni::Processes::Instances#connect)
+def instance_connect( *args )
+    Arachni::Processes::Instances.connect( *args )
+end
+
+# @param (see Arachni::Processes::Instances#token_for)
+# @return (see Arachni::Processes::Instances#token_for)
+def instance_token_for( *args )
+    Arachni::Processes::Instances.token_for( *args )
+end