arachni 0.4.0.4 → 0.4.1

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

@@ -1,23 +1,27 @@
 =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 Options.instance.dir['lib'] + 'rpc/client/instance'
-require Options.instance.dir['lib'] + 'rpc/client/dispatcher'
-
-require Options.instance.dir['lib'] + 'rpc/server/base'
-require Options.instance.dir['lib'] + 'rpc/server/output'
-require Options.instance.dir['lib'] + 'rpc/server/options'
+require Options.dir['lib'] + 'rpc/client/instance'
+require Options.dir['lib'] + 'rpc/client/dispatcher'
 
-require Options.instance.dir['lib'] + 'rpc/server/framework'
+require Options.dir['lib'] + 'rpc/server/base'
+require Options.dir['lib'] + 'rpc/server/output'
+require Options.dir['lib'] + 'rpc/server/framework'
 
 module RPC
 class Server
@@ -28,18 +32,13 @@ class Server
 # Provides an RPC server to assist with general integration and UI development.
 #
 # Only instantiated by the Dispatcher to provide support for multiple
-# and concurent RPC clients/scans.
+# and concurrent RPC clients/scans.
 #
-# @author: Tasos "Zapotek" Laskos
-#                                      <tasos.laskos@gmail.com>
-#                                      <zapotek@segfault.gr>
-# @version: 0.1.5
+# @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
 #
 class Instance
-
-    # the output interface for RPC
-    include Arachni::UI::Output
-    include Arachni::Module::Utilities
+    include UI::Output
+    include Utilities
 
     #
     # Initializes the RPC interface, the HTTP(S) server and the framework.
@@ -55,14 +54,15 @@ class Instance
         @token = token
         @server = Base.new( @opts, token )
 
-        @opts.datastore[:token] = token
+        @server.logger.level = @opts.datastore[:log_level] if @opts.datastore[:log_level]
 
-        debug! if @opts.debug
+        @opts.datastore[:token] = token
 
+        debug if @opts.debug
 
-        if logfile = @opts.reroute_to_logfile
+        if @opts.reroute_to_logfile
             reroute_to_file( @opts.dir['logs'] +
-                "Instance - #{Process.pid}-#{@opts.rpc_port}.log" )
+                "/Instance - #{Process.pid}-#{@opts.rpc_port}.log" )
         else
             reroute_to_file( false )
         end
@@ -70,10 +70,9 @@ class Instance
         set_handlers
 
         # trap interrupts and exit cleanly when required
-        [ 'QUIT', 'INT' ].each {
-            |signal|
+        %w(QUIT INT).each do |signal|
             trap( signal ){ shutdown } if Signal.list.has_key?( signal )
-        }
+        end
 
         run
     end
@@ -96,20 +95,16 @@ class Instance
         print_status( 'Shutting down...' )
 
         t = []
-        @framework.instances.each {
-            |instance|
-            # Don't know why but this works better than EM's stuff
-            t << Thread.new {
-                @framework.instance_eval{
-                    connect_to_instance( instance ).service.shutdown!
-                }
-            }
+        @framework.instance_eval {
+            @instances.each do |instance|
+                # Don't know why but this works better than EM's stuff
+                t << Thread.new { connect_to_instance( instance ).service.shutdown! }
+            end
         }
-
         t.join
 
         @server.shutdown
-        return true
+        true
     end
     alias :shutdown! :shutdown
 
@@ -130,14 +125,14 @@ class Instance
 
     def dispatcher
         @dispatcher ||=
-            Arachni::RPC::Client::Dispatcher.new( @opts, @opts.datastore[:dispatcher_url] )
+            Client::Dispatcher.new( @opts, @opts.datastore[:dispatcher_url] )
     end
 
     #
     # Initialises the RPC framework.
     #
     def prep_framework
-        @framework = Arachni::RPC::Server::Framework.new( Options.instance )
+        @framework = Server::Framework.new( Options.instance )
     end
 
     #
@@ -145,18 +140,9 @@ class Instance
     # Displays version number, revision number, author details etc.
     #
     def banner
-
-        puts 'Arachni - Web Application Security Scanner Framework v' +
-            @framework.version + ' [' + @framework.revision + ']
-       Author: Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
-                                      <zapotek@segfault.gr>
-               (With the support of the community and the Arachni Team.)
-
-       Website:       http://github.com/Zapotek/arachni
-       Documentation: http://github.com/Zapotek/arachni/wiki'
+        puts BANNER
         puts
         puts
-
     end
 
     #
@@ -164,11 +150,10 @@ class Instance
     # It also prepares all the RPC handlers.
     #
     def set_handlers
-        @server.add_async_check {
-            |method|
+        @server.add_async_check do |method|
             # methods that expect a block are async
             method.parameters.flatten.include?( :block )
-        }
+        end
 
         @server.add_handler( "service",   self )
         @server.add_handler( "framework", @framework )

data/lib/arachni/rpc/server/module/manager.rb

@@ -1,44 +1,41 @@
 =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 Options.instance.dir['lib'] + 'module/manager'
+require Options.dir['lib'] + 'module/manager'
 
 module RPC
 class Server
-
 module Module
 
 #
-# We need to extend the original Manager and redeclare its inherited methods
+# We need to extend the original Manager and re-declare its inherited methods
 # which are required over RPC.
 #
-# @author: Tasos "Zapotek" Laskos
-#                                      <tasos.laskos@gmail.com>
-#                                      <zapotek@segfault.gr>
-# @version: 0.1.1
+# @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
 #
 class Manager < ::Arachni::Module::Manager
 
     # make these inherited methods visible again
-    private :load, :available
-    public :load, :available
-
-    def initialize( opts )
-        super( opts )
-    end
+    private :load, :available, :loaded, :load_all
+    public :load, :available, :loaded, :load_all
 
     def load( mods )
-        super( mods )
-        @opts.mods = mods
+        @opts.mods = super( mods )
     end
 
 end

data/lib/arachni/rpc/server/output.rb

@@ -1,50 +1,47 @@
 =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
 
+# get some basics from the CLI UI's output interface
+require Options.dir['lib'] + 'ui/cli/output'
+
 module UI
 
 #
-# RPC deamon Output module
+# RPC Output module
 #
 # It basically classifies and buffers all system messages until it's time to
 # flush the buffer and send them over the wire.
 #
-# @author: Tasos "Zapotek" Laskos
-#                                      <tasos.laskos@gmail.com>
-#                                      <zapotek@segfault.gr>
-# @version: 0.1.1
+# @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
 #
 module Output
 
-    # verbosity flag
-    #
-    # if it's on verbose messages will be enabled
-    @@verbose = false
-
-    # debug flag
-    #
-    # if it's on debugging messages will be enabled
-    @@debug   = false
-
-    # only_positives flag
-    #
-    # if it's on status messages will be disabled
-    @@only_positives  = false
-
-    @@reroute_to_file = false
+    class << self
+        alias :old_reset_output_options :reset_output_options
+    end
 
-    @@buffer_cap = 30
+    def self.reset_output_options
+        old_reset_output_options
+        @@output_buffer_cap = 30
+        @@output_buffer ||= []
+    end
 
-    @@buffer ||= []
+    reset_output_options
 
     #
     # Empties the output buffer and returns all messages.
@@ -54,32 +51,17 @@ module Output
     # @return   [Array<Hash>]
     #
     def flush_buffer
-        buf = @@buffer.dup
-        @@buffer.clear
-        return buf
+        buf = @@output_buffer.dup
+        @@output_buffer.clear
+        buf
     end
 
-    def buffer( msg )
-        if file = @@reroute_to_file
-            File.open( file, 'a+' ) {
-                |f|
-
-                type = msg.keys[0]
-                str  = msg.values[0]
-                next if str.empty?
-
-                f.write( "[#{Time.now.asctime}] [#{type}]  #{str}\n" )
-            }
-        else
-            @@buffer << msg
-            if @@buffer_cap.is_a? Integer
-                @@buffer.slice!( (@@buffer.size - @@buffer_cap)..@@buffer.size  )
-            end
-        end
+    def set_buffer_cap( cap )
+        @@output_buffer_cap = cap
     end
 
-    def uncap_buffer!
-        @@buffer_cap = nil
+    def uncap_buffer
+        @@output_buffer_cap = nil
     end
 
     # Prints an error message
@@ -87,11 +69,11 @@ module Output
     # It ignores all flags, error messages will be output under all
     # circumstances.
     #
-    # @param    [String]    error string
+    # @param    [String]    str    error string
     # @return    [void]
     #
     def print_error( str = '' )
-        buffer( :error => str )
+        push_to_output_buffer( :error => str )
         print_color( '[-]', 31, str, $stderr )
     end
     def print_error_backtrace( e )
@@ -104,10 +86,10 @@ module Output
     # Used mainly to draw attention to something that didn't behave as expected
     # rather than display an actual error.
     #
-    # @param    [String]    error string
+    # @param    [String]    str
     #
     def print_bad( str = '' )
-        buffer( :red => str )
+        push_to_output_buffer( bad: str )
     end
 
     # Prints a status message
@@ -115,14 +97,14 @@ module Output
     # Obeys {@@only_positives}
     #
     # @see #only_positives?
-    # @see #only_positives!
+    # @see #only_positives
     #
-    # @param    [String]    status string
+    # @param    [String]    str
     # @return    [void]
     #
     def print_status( str = '' )
-        if @@only_positives then return end
-        buffer( :status => str )
+        return if only_positives?
+        push_to_output_buffer( status: str )
     end
 
     # Prints an info message
@@ -130,14 +112,14 @@ module Output
     # Obeys {@@only_positives}
     #
     # @see #only_positives?
-    # @see #only_positives!
+    # @see #only_positives
     #
-    # @param    [String]    info string
+    # @param    [String]    str
     # @return    [void]
     #
     def print_info( str = '' )
-        if @@only_positives then return end
-        buffer( :info => str )
+        return if only_positives?
+        push_to_output_buffer( info: str )
     end
 
     # Prints a good message, something that went very very right,
@@ -145,11 +127,11 @@ module Output
     #
     # Disregards all flags.
     #
-    # @param    [String]    ok string
+    # @param    [String]    str
     # @return    [void]
     #
     def print_ok( str = '' )
-        buffer( :ok => str )
+        push_to_output_buffer( ok: str )
     end
 
     # Prints a debugging message
@@ -157,65 +139,34 @@ module Output
     # Obeys {@@debug}
     #
     # @see #debug?
-    # @see #debug!
+    # @see #debug
     #
-    # @param    [String]    debugging string
+    # @param    [String]    str
     # @return    [void]
     #
     def print_debug( str = '' )
-        if !@@debug then return end
+        return if !debug?
 
         if reroute_to_file?
-            buffer( :debug => str )
+            push_to_output_buffer( debug: str )
         else
             print_color( '[!]', 36, str, $stderr )
         end
     end
 
-    # Pretty prints an object, used for debugging,
-    # needs some improvement but it'll do for now
-    #
-    # Obeys {@@debug}
-    #
-    # @see #debug?
-    # @see #debug!
-    #
-    # @param    [Object]
-    # @return    [void]
-    #
-    def print_debug_pp( obj = nil )
-        if !@@debug then return end
-        pp obj
-    end
-
-    # Prints the backtrace of an exception
-    #
-    # Obeys {@@debug}
-    #
-    # @see #debug?
-    # @see #debug!
-    #
-    # @param    [Exception]
-    # @return    [void]
-    #
-    def print_debug_backtrace( e = nil )
-        if !@@debug then return end
-        e.backtrace.each{ |line| print_debug( line ) }
-    end
-
     # Prints a verbose message
     #
     # Obeys {@@verbose}
     #
     # @see #verbose?
-    # @see #verbose!
+    # @see #verbose
     #
-    # @param    [String]    verbose string
+    # @param    [String]    str
     # @return    [void]
     #
     def print_verbose( str = '' )
-        if !@@verbose then return end
-        buffer( :verbose => str )
+        return if !verbose?
+        push_to_output_buffer( verbose: str )
     end
 
     # Prints a line of message
@@ -223,74 +174,14 @@ module Output
     # Obeys {@@only_positives}
     #
     # @see #only_positives?
-    # @see #only_positives!
+    # @see #only_positives
     #
-    # @param    [String]    string
+    # @param    [String]    str
     # @return    [void]
     #
     def print_line( str = '' )
-        if @@only_positives then return end
-        buffer( :line => str )
-    end
-
-    # Sets the {@@verbose} flag to true
-    #
-    # @see #verbose?
-    #
-    # @return    [void]
-    #
-    def verbose!
-        @@verbose = true
-    end
-
-    # Returns the {@@verbose} flag
-    #
-    # @see #verbose!
-    #
-    # @return    [Bool]    @@verbose
-    #
-    def verbose?
-        @@verbose
-    end
-
-    # Sets the {@@debug} flag to true
-    #
-    # @see #debug?
-    #
-    # @return    [void]
-    #
-    def debug!
-        @@debug = true
-    end
-
-    # Returns the {@@debug} flag
-    #
-    # @see #debug!
-    #
-    # @return    [Bool]    @@debug
-    #
-    def debug?
-        @@debug
-    end
-
-    # Sets the {@@only_positives} flag to true
-    #
-    # @see #only_positives?
-    #
-    # @return    [void]
-    #
-    def only_positives!
-        @@only_positives = true
-    end
-
-    # Returns the {@@only_positives} flag
-    #
-    # @see #only_positives!
-    #
-    # @return    [Bool]    @@only_positives
-    #
-    def only_positives?
-        @@only_positives
+        return if only_positives?
+        push_to_output_buffer( line: str )
     end
 
     def reroute_to_file( file )
@@ -303,18 +194,21 @@ module Output
 
     private
 
-    # Prints a message prefixed with a colored sign.
-    #
-    # Disregards all flags.
-    #
-    # @param    [String]    sign
-    # @param    [Integer]   shell color number
-    # @param    [String]    the string to output
-    #
-    # @return    [void]
-    #
-    def print_color( sign, color, string, out = $stdout )
-        out.print "\033[1;#{color.to_s}m #{sign}\033[1;00m #{string}\n";
+    def push_to_output_buffer( msg )
+        if file = @@reroute_to_file
+            File.open( file, 'a+' ) do |f|
+                type = msg.keys[0]
+                str  = msg.values[0]
+                next if str.empty?
+
+                f.write( "[#{Time.now.asctime}] [#{type}]  #{str}\n" )
+            end
+        else
+            @@output_buffer << msg
+            if @@output_buffer_cap.is_a?( Integer )
+                @@output_buffer.slice!( (@@output_buffer.size - @@output_buffer_cap)..@@output_buffer.size )
+            end
+        end
     end
 
     extend self