arachni 0.4.0.4 → 0.4.1

data/lib/arachni/report.rb

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

data/lib/arachni/report/base.rb

@@ -1,11 +1,17 @@
 =begin
-                  Arachni
-  Copyright (c) 2010-2012 Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+    Copyright 2010-2012 Tasos 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)
+    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
@@ -15,12 +21,10 @@ module Report
 # Provides some common options for the reports
 #
 #
-# @author: Tasos "Zapotek" Laskos
-#                                      <tasos.laskos@gmail.com>
-#                                      <zapotek@segfault.gr>
-# @version: 0.1
+# @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
 #
 module Options
+    include Component::Options
 
     #
     # Returns a string option named 'outfile'.
@@ -34,7 +38,7 @@ module Options
     # @return   [Arachni::OptString]
     #
     def outfile( ext = '', desc = 'Where to save the report.' )
-        Arachni::OptString.new( 'outfile', [ false, desc,
+        Options::String.new( 'outfile', [ false, desc,
             Time.now.to_s.gsub( ':', '.' ) + ext ] )
     end
 
@@ -42,55 +46,57 @@ module Options
 end
 
 
-class FormatterManager < ComponentManager
+class FormatterManager < Component::Manager
 
     def paths
-        cpaths = paths = Dir.glob( File.join( "#{@lib}", "*.rb" ) )
-        return paths.reject { |path| helper?( path ) }
+        Dir.glob( File.join( "#{@lib}", "*.rb" ) ).reject { |path| helper?( path ) }
     end
 
 end
 
 #
-# Arachni::Report::Base class
+# An abstract class for the reports, all reports must extend this.
 #
-# An abstract class for the reports.<br/>
-# All reports must extend this.
+# @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
 #
-# @author: Tasos "Zapotek" Laskos
-#                                      <tasos.laskos@gmail.com>
-#                                      <zapotek@segfault.gr>
-# @version: 0.1.1
 # @abstract
 #
 class Base
+    # I hate keep typing this all the time...
+    include Arachni
 
     # get the output interface
-    include Arachni::UI::Output
-    include Arachni::Module::Utilities
+    include UI::Output
+    include Module::Utilities
 
-    # where to report false positives <br/>
-    # info about this should be included in all templates
-    REPORT_FP = 'http://github.com/Zapotek/arachni/issues'
+    include Report
 
-    module PluginFormatters
+    # where to report false positives info about this should be included in all templates
+    REPORT_FP = 'http://github.com/Arachni/arachni/issues'
 
+    module PluginFormatters
     end
 
+    attr_reader :options
+    attr_reader :auditstore
+
     #
-    # @param    [AuditStore]  audit_store
+    # @param    [AuditStore]  auditstore
     # @param    [Hash]        options       options passed to the report
     #
-    def initialize( audit_store, options )
-        @audit_store   = audit_store
-        @options       = options
+    def initialize( auditstore, options )
+        @auditstore = auditstore
+        @options    = options
     end
 
     #
     # REQUIRED
     #
     def run
+    end
 
+    def outfile
+        options['outfile']
     end
 
     #
@@ -99,7 +105,7 @@ class Base
     #
     # @param    [AuditStore#plugins]      plugins   plugin data/results
     #
-    def format_plugin_results( plugins )
+    def format_plugin_results( plugins = auditstore.plugins, &block )
         formatted = {}
         return formatted if !plugins
 
@@ -107,11 +113,11 @@ class Base
         ancestor = self.class.ancestors[0]
 
         # add the PluginFormatters module to the report
-        eval( "class " + ancestor.to_s + "\n module  PluginFormatters end \n end" )
+        eval "class #{ancestor}; module PluginFormatters end; 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]
+        report_path = ::Kernel.caller.first.split( ':' ).first
 
         # prepare the directory of the formatters for the running report
         lib = File.dirname( report_path ) + '/plugin_formatters/' + File.basename( report_path, '.rb' ) +  '/'
@@ -125,35 +131,44 @@ class Base
         @@formatters[ancestor].load( ['*'] ) if @@formatters[ancestor].empty?
 
         # run the formatters and gather the formatted data they return
-        @@formatters[ancestor].each_pair {
-            |name, formatter|
+        @@formatters[ancestor].each do |name, formatter|
             plugin_results = plugins[name]
             next if !plugin_results || plugin_results[:results].empty?
 
             exception_jail( false ) {
-                formatted[name] = formatter.new( plugin_results.deep_clone ).run
+                cr = plugin_results.clone
+                block.call( cr ) if block_given?
+                formatted[name] = formatter.new( cr ).run
             }
-        }
+        end
+
+        formatted
+    end
 
-        return formatted
+    def self.has_outfile?
+        (info[:options] || {}).each { |opt| return true if opt.name == Options.outfile.name }
+        false
+    end
+    def has_outfile?
+        self.class.has_outfile?
     end
 
     #
     # REQUIRED
     #
-    # Do not ommit any of the info.
+    # Do not omit any of the info.
     #
     def self.info
         {
-            :name           => 'Report abstract class.',
-            :options        => [
+            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.1',
+            description: %q{This class should be extended by all reports.},
+            author:      'zapotek',
+            version:     '0.1.1',
         }
     end
 

data/lib/arachni/report/manager.rb

@@ -1,11 +1,17 @@
 =begin
-                  Arachni
-  Copyright (c) 2010-2012 Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+    Copyright 2010-2012 Tasos 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)
+    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
@@ -23,20 +29,16 @@ module Report
 #
 # Holds and manages the registry of the reports.
 #
-# @author: Tasos "Zapotek" Laskos
-#                                      <tasos.laskos@gmail.com>
-#                                      <zapotek@segfault.gr> <br/>
-# @version: 0.1.1
+# @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
 #
-class Manager < Arachni::ComponentManager
-
-    include Arachni::Module::Utilities
+class Manager < Arachni::Component::Manager
+    include Utilities
+    extend  Utilities
 
-    # the extension of the Arachni Framework Report files
-    EXTENSION   = '.afr'
+    NAMESPACE = Arachni::Reports
 
     def initialize( opts )
-        super( opts.dir['reports'], Arachni::Reports )
+        super( opts.dir['reports'], NAMESPACE )
         @opts = opts
     end
 
@@ -54,31 +56,30 @@ class Manager < Arachni::ComponentManager
             delete( 'afr' )
         end
 
-        self.each {
-            |name, report|
-            exception_jail( false ){
-                run_one( name, audit_store.deep_clone )
-            }
-        }
+        loaded.each do |name|
+            exception_jail( false ){ run_one( name, audit_store.deep_clone ) }
+        end
     end
 
-    def run_one( name, audit_store )
-        report = self.[](name).new( audit_store.deep_clone,
-            prep_opts( name, self.[](name), @opts.reports[name] ) )
+    def run_one( name, audit_store, opts = {} )
+        report = self[name].new( audit_store.deep_clone,
+            prep_opts( name, self[name], opts.empty? ? @opts.reports[name] : opts ) )
 
-        report.run( )
+        report.run
+        report
     end
 
-    def paths
-        cpaths = paths = Dir.glob( File.join( "#{@lib}", "*.rb" ) )
-        return paths.reject { |path| helper?( path ) }
+    def self.reset
+        remove_constants( NAMESPACE )
     end
-
-
-    def extension
-        return EXTENSION
+    def reset
+        self.class.reset
     end
 
+    private
+    def paths
+        Dir.glob( File.join( "#{@lib}", "*.rb" ) ).reject { |path| helper?( path ) }
+    end
 end
 
 end

data/lib/arachni/rpc/client.rb

@@ -0,0 +1,2 @@
+require_relative 'client/instance'
+require_relative 'client/dispatcher'

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

@@ -1,11 +1,17 @@
 =begin
-                  Arachni
-  Copyright (c) 2010-2012 Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+    Copyright 2010-2012 Tasos 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)
+    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 'arachni/rpc/em'
@@ -16,27 +22,34 @@ module RPC
 class Client
 
 #
-# @author: Tasos "Zapotek" Laskos
-#                                      <tasos.laskos@gmail.com>
-#                                      <zapotek@segfault.gr>
-# @version: 0.1
+# @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
 #
 class Base < ::Arachni::RPC::EM::Client
-
+    attr_reader :url
+
+    #
+    # @param    [Arachni::Options]   opts   relevant options:
+    #                                          * ssl_ca -- CA file (.pem)
+    #                                          * node_ssl_pkey OR ssl_pkey -- private key file (.pem)
+    #                                          * node_ssl_cert OR ssl_cert -- cert file file (.pem)
+    # @param    [String]    url       server URL in <host>:<port> format
+    # @param    [String]    token     optional authentication token
+    #
     def initialize( opts, url, token = nil )
+        @url = url
         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
+            host:        host,
+            port:        port,
+            token:       token,
+            max_retries: opts.max_retries,
+            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
+end

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

@@ -1,16 +1,22 @@
 =begin
-                  Arachni
-  Copyright (c) 2010-2012 Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+    Copyright 2010-2012 Tasos 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)
+    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
 
-require Arachni::Options.instance.dir['lib'] + 'rpc/client/base'
+require Options.dir['lib'] + 'rpc/client/base'
 
 module RPC
 class Client
@@ -18,10 +24,7 @@ class Client
 #
 # RPC Dispatcher client
 #
-# @author: Tasos "Zapotek" Laskos
-#                                      <tasos.laskos@gmail.com>
-#                                      <zapotek@segfault.gr>
-# @version: 0.1.3
+# @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
 #
 class Dispatcher
 
@@ -29,8 +32,15 @@ class Dispatcher
 
     def initialize( opts, url )
         @client = Base.new( opts, url )
-
         @node = RemoteObjectMapper.new( @client, 'node' )
+
+        # map Dispatcher handlers
+        Dir.glob( "#{Options.dir['rpcd_handlers']}*.rb" ).each do |handler|
+            name = File.basename( handler, '.rb' )
+
+            self.class.send( :attr_reader, name.to_sym )
+            instance_variable_set( "@#{name}".to_sym, RemoteObjectMapper.new( @client, name ) )
+        end
     end
 
     private
@@ -41,6 +51,9 @@ class Dispatcher
         @client.call( "dispatcher.#{sym.to_s}", *args, &block )
     end
 
+    def url
+        @client.url
+    end
 end
 
 end

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

@@ -1,16 +1,22 @@
 =begin
-                  Arachni
-  Copyright (c) 2010-2012 Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+    Copyright 2010-2012 Tasos 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)
+    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
 
-require Arachni::Options.instance.dir['lib'] + 'rpc/client/base'
+require Options.dir['lib'] + 'rpc/client/base'
 
 module RPC
 class Client
@@ -18,10 +24,7 @@ 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
+# @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
 #
 class Instance
 
@@ -39,7 +42,13 @@ class Instance
         def method_missing( sym, *args, &block )
             return super( sym, *args, &block ) if sym == :set
 
-            call = "#{@remote}.#{sym.to_s}="
+            call  = "#{@remote}.#{sym.to_s}"
+
+            if !args.empty? && !sym.to_s.end_with?( '=' ) &&
+                Options.instance.methods.include?( "#{sym}=".to_sym  )
+                call += '='
+            end
+
             @server.call( call, *args, &block )
         end
 
@@ -55,6 +64,10 @@ class Instance
         @service   = RemoteObjectMapper.new( @client, 'service' )
     end
 
+    def url
+        @client.url
+    end
+
 end
 
 end