arachni 0.2.2.1

data/lib/plugin.rb

@@ -0,0 +1,4 @@
+opts = Arachni::Options.instance
+require opts.dir['lib'] + 'component_manager'
+require opts.dir['lib'] + 'plugin/base'
+require opts.dir['lib'] + 'plugin/manager'

data/lib/plugin/base.rb

@@ -0,0 +1,110 @@
+=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
+
+module Arachni
+module Plugin
+
+#
+# Will be extended by plugin formatters which provide plugin data formatting
+# for the reports.
+#
+# Plugin formatters will be in turn ran by [Arachni::Report::Bas#format_plugin_results].
+#
+#
+class Formatter
+
+    # get the output interface
+    include Arachni::UI::Output
+
+    def initialize( plugin_data )
+
+    end
+
+    def run
+
+    end
+
+end
+
+#
+# Arachni::Plugin::Base class
+#
+# An abstract class for the plugins.<br/>
+# All plugins must extend this.
+#
+# @author: Tasos "Zapotek" Laskos
+#                                      <tasos.laskos@gmail.com>
+#                                      <zapotek@segfault.gr>
+# @version: 0.1
+# @abstract
+#
+class Base
+
+    # get the output interface
+    include Arachni::Module::Output
+
+    #
+    # @param    [Arachni::Framework]    framework
+    # @param    [Hash]        options    options passed to the plugin
+    #
+    def initialize( framework, options )
+        @framework = framework
+        @options   = options
+    end
+
+
+    #
+    # OPTIONAL
+    #
+    def prepare( )
+
+    end
+
+    #
+    # REQUIRED
+    #
+    def run( )
+
+    end
+
+    #
+    # OPTIONAL
+    #
+    def clean_up( )
+
+    end
+
+    def register_results( results )
+        @framework.plugin_store( self, results )
+    end
+
+    #
+    # REQUIRED
+    #
+    # Do not ommit any of the info.
+    #
+    def self.info
+        {
+            :name           => 'Abstract plugin class',
+            :description    => %q{Abstract plugin class.},
+            :author         => 'Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>',
+            :version        => '0.1',
+            :options        => [
+                #                        option name       required?       description                     default
+                # Arachni::OptBool.new( 'print_framework', [ false, 'Do you want to print the framework?', false ] ),
+                # Arachni::OptString.new( 'my_name_is',    [ false, 'What\'s you name?', 'Tasos' ] ),
+            ]
+        }
+    end
+
+end
+
+end
+end

data/lib/plugin/manager.rb

@@ -0,0 +1,162 @@
+=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
+
+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
+
+#
+# Holds and manages the plugins.
+#
+# @author: Tasos "Zapotek" Laskos
+#                                      <tasos.laskos@gmail.com>
+#                                      <zapotek@segfault.gr>
+# @version: 0.1
+#
+class Manager < Arachni::ComponentManager
+
+    include Arachni::Module::Utilities
+
+    ALWAYS_ON = [ 'metamodules', 'content_types', 'healthmap' ]
+
+    #
+    # @param    [Arachni::Framework]    framework   framework instance
+    #
+    def initialize( framework )
+        super( framework.opts.dir['plugins'], Arachni::Plugins )
+        @framework = framework
+
+        @jobs = []
+    end
+
+    def load_defaults!
+        load( ALWAYS_ON )
+    end
+
+    #
+    # Runs each plug-in in its own thread.
+    #
+    def run
+        i = 0
+        each {
+            |name, plugin|
+
+            @jobs << Thread.new {
+
+                exception_jail {
+                    Thread.current[:name] = name
+
+                    plugin_new = create( name )
+                    plugin_new.prepare
+                    plugin_new.run
+                    plugin_new.clean_up
+                }
+
+            }
+
+            i += 1
+        }
+
+        if i > 0
+            print_status( 'Waiting for plugins to settle...' )
+            ::IO::select( nil, nil, nil, 1 )
+        end
+    end
+
+    def create( name )
+        opts = @framework.opts.plugins[name]
+        self[name].new( @framework, prep_opts( name, self[name], 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
+
+            @jobs.delete_if { |j| !j.alive? }
+            ::IO::select( nil, nil, nil, 1 )
+        end
+    end
+
+    #
+    # Will return false if all plug-ins have finished executing.
+    #
+    # @return   [Bool]
+    #
+    def busy?
+        !@jobs.reject{ |j| j.alive? }.empty?
+    end
+
+    #
+    # Returns the names of the running plug-ins.
+    #
+    # @return   [Array]
+    #
+    def job_names
+        @jobs.map{ |j| j[:name] }
+    end
+
+    #
+    # Returns all the running threads.
+    #
+    # @return   [Array<Thread>]
+    #
+    def jobs
+        @jobs
+    end
+
+    #
+    # Kills a plug-in by name.
+    #
+    # @param    [String]    name
+    #
+    def kill( name )
+        job = get( name )
+        return job.kill if job
+        return nil
+    end
+
+    #
+    # Gets a running plug-in by name.
+    #
+    # @param    [String]    name
+    #
+    # @return   [Thread]
+    #
+    def get( name )
+        @jobs.each { |job| return job if job[:name] == name }
+    end
+
+
+end
+end
+end

data/lib/report.rb

@@ -0,0 +1,4 @@
+opts = Arachni::Options.instance
+require opts.dir['lib'] + 'component_manager'
+require opts.dir['lib'] + 'report/base'
+require opts.dir['lib'] + 'report/manager'

data/lib/report/base.rb

@@ -0,0 +1,119 @@
+=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
+
+module Arachni
+module Report
+
+class FormatterManager < ComponentManager
+
+    def paths
+        cpaths = paths = Dir.glob( File.join( "#{@lib}", "*.rb" ) )
+        return paths.reject { |path| helper?( path ) }
+    end
+
+end
+
+#
+# Arachni::Report::Base class
+#
+# An abstract class for the reports.<br/>
+# All reports must extend this.
+#
+# @author: Tasos "Zapotek" Laskos
+#                                      <tasos.laskos@gmail.com>
+#                                      <zapotek@segfault.gr>
+# @version: 0.1
+# @abstract
+#
+class Base
+
+    # get the output interface
+    include Arachni::UI::Output
+
+    # where to report false positives <br/>
+    # info about this should be included in all templates
+    REPORT_FP = 'http://github.com/Zapotek/arachni/issues'
+
+    module PluginFormatters
+
+    end
+
+    #
+    # REQUIRED
+    #
+    def run( )
+
+    end
+
+    #
+    # Runs plugin formatters for the running report and returns a hash
+    # with the prepared/formatted results.
+    #
+    # @param    [AuditStore#plugins]      plugins   plugin data/results
+    #
+    def format_plugin_results( plugins )
+
+        # get the object that extends this class (i.e. the running report)
+        ancestor = self.class.ancestors[0]
+
+        # add the PluginFormatters module to the report
+        eval( "class " + ancestor.to_s + "\n module  PluginFormatters end \n end" )
+
+        # get the path to the report file
+        # this is a very bad way to do it...
+        report_path = ::Kernel.caller[0].match( /^(.+?):(\d+)(?::in `(.*)')?/ )[1]
+
+        # prepare the directory of the formatters for the running report
+        lib = File.dirname( report_path ) + '/plugin_formatters/' + File.basename( report_path, '.rb' ) +  '/'
+
+        @@formatters ||= {}
+
+        # initialize a new component manager to handle the plugin formatters
+        @@formatters[ancestor] ||= FormatterManager.new( lib, ancestor.const_get( 'PluginFormatters' ) )
+
+        # load all the formatters
+        @@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]
+            next if !plugin_results || plugin_results[:results].empty?
+
+            formatted[name] = formatter.new( plugin_results.deep_clone ).run
+        }
+
+        return formatted
+    end
+
+    #
+    # REQUIRED
+    #
+    # Do not ommit any of the info.
+    #
+    def self.info
+        {
+            :name           => 'Report abstract class.',
+            :options        => [
+                #                    option name    required?       description                         default
+                # Arachni::OptBool.new( 'html',    [ false, 'Include the HTML responses in the report?', true ] ),
+                # Arachni::OptBool.new( 'headers', [ false, 'Include the headers in the report?', true ] ),
+            ],
+            :description    => %q{This class should be extended by all reports.},
+            :author         => 'zapotek',
+            :version        => '0.1',
+        }
+    end
+
+end
+
+end
+end

data/lib/report/manager.rb

@@ -0,0 +1,92 @@
+=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
+
+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
+
+#
+# Arachni::Report::Manager class
+#
+# Holds and manages the registry of the reports.
+#
+# @author: Tasos "Zapotek" Laskos
+#                                      <tasos.laskos@gmail.com>
+#                                      <zapotek@segfault.gr> <br/>
+# @version: 0.1
+#
+class Manager < Arachni::ComponentManager
+
+    # the extension of the Arachni Framework Report files
+    EXTENSION   = '.afr'
+
+    def initialize( opts )
+        super( opts.dir['reports'], Arachni::Reports )
+        @opts = opts
+    end
+
+    #
+    # Takes care of report execution
+    #
+    # @see AuditStore
+    #
+    # @param  [AuditStore]  audit_store
+    #
+    def run( audit_store, run_afr = true )
+        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 )
+        report = self.[](name).new( audit_store.deep_clone,
+            prep_opts( name, self.[](name), @opts.reports[name] ) )
+
+        report.run( )
+    end
+
+    def paths
+        cpaths = paths = Dir.glob( File.join( "#{@lib}", "*.rb" ) )
+        return paths.reject { |path| helper?( path ) }
+    end
+
+
+    def self.reset
+        Arachni::Reports.reset
+    end
+
+    def extension
+        return EXTENSION
+    end
+
+end
+
+end
+end