arachni 0.2.2.1

data/lib/module/base.rb

@@ -0,0 +1,188 @@
+=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
+
+require 'set'
+require Arachni::Options.instance.dir['lib'] + 'module/output'
+require Arachni::Options.instance.dir['lib'] + 'module/utilities'
+require Arachni::Options.instance.dir['lib'] + 'module/trainer'
+require Arachni::Options.instance.dir['lib'] + 'module/auditor'
+
+module Arachni
+module Module
+
+
+#
+# Arachni's base module class<br/>
+# To be extended by Arachni::Modules.
+#
+# Defines basic structure and provides utilities to modules.
+#
+# @author: Tasos "Zapotek" Laskos
+#                                      <tasos.laskos@gmail.com>
+#                                      <zapotek@segfault.gr>
+# @version: 0.2
+# @abstract
+#
+class Base
+
+    # get output module
+    include Output
+
+    include Auditor
+
+    #
+    # Arachni::HTTP instance for the modules
+    #
+    # @return [Arachni::Module::HTTP]
+    #
+    attr_reader :http
+
+    #
+    # Arachni::Page instance
+    #
+    # @return [Page]
+    #
+    attr_reader :page
+
+    #
+    # Initializes the module attributes, HTTP client and {Trainer}
+    #
+    # @see Trainer
+    # @see HTTP
+    #
+    # @param  [Page]  page
+    #
+    def initialize( page )
+
+        @page  = page
+        @http  = Arachni::HTTP.instance
+        @http.trainer.page = @page.dup
+
+        # update the cookies
+        if( !@page.cookiejar.empty? )
+            @http.update_cookies( @page.cookiejar )
+        end
+
+        #
+        # This is slightly tricky...
+        #
+        # Each loaded module is instantiated for each page,
+        # however modules share the elements of each page and access them
+        # via the ElementsDB.
+        #
+        # Since the ElementDB is dynamically updated by the Trainer
+        # during the audit, is should only be initialized *once*
+        # for each page and not overwritten every single time a module is instantiated.
+        #
+        @@__last_url ||= ''
+        if( @@__last_url != @page.url )
+            @http.trainer.page = @page.dup
+            @http.trainer.init_forms( @page.forms )
+            @http.trainer.init_links( @page.links )
+            @http.trainer.init_cookies( @page.cookies )
+            @@__last_url = @page.url
+        end
+    end
+
+    #
+    # ABSTRACT - OPTIONAL
+    #
+    # It provides you with a way to setup your module's data and methods.
+    #
+    def prepare( )
+    end
+
+    #
+    # ABSTRACT - REQUIRED
+    #
+    # This is used to deliver the module's payload whatever it may be.
+    #
+    def run( )
+    end
+
+    #
+    # ABSTRACT - OPTIONAL
+    #
+    # This is called right before an [Arachni::Parser::Element]
+    # is submitted/auditted and is used to determine whether to skip it or not.
+    #
+    # Implementation details are left up to the running module.
+    #
+    # @param    [Arachni::Parser::Element]  elem
+    #
+    def skip?( elem )
+        return false
+    end
+
+    #
+    # ABSTRACT - OPTIONAL
+    #
+    # This is called after run() has finished executing,
+    #
+    def clean_up( )
+    end
+
+    #
+    # ABSTRACT - REQUIRED
+    #
+    # Provides information about the module.
+    # Don't take this lightly and don't ommit any of the info.
+    #
+    def self.info
+        {
+            :name           => 'Base module abstract class',
+            :description    => %q{Provides an abstract class the modules should implement.},
+            #
+            # Arachni needs to know what elements the module plans to audit
+            # before invoking it.
+            # If a page doesn't have any of those elements
+            # there's no point in instantiating the module.
+            #
+            # If you want the module to run no-matter what leave the array
+            # empty.
+            #
+            # 'Elements'       => [
+            #     Issue::Element::FORM,
+            #     Issue::Element::LINK,
+            #     Issue::Element::COOKIE,
+            #     Issue::Element::HEADER
+            # ],
+            :elements       => [],
+            :author         => 'zapotek',
+            :version        => '0.1',
+            :references     => {
+            },
+            :targets        => { 'Generic' => 'all' },
+            :issue   => {
+                :description => %q{},
+                :cwe         => '',
+                #
+                # Severity can be:
+                #
+                # Issue::Severity::HIGH
+                # Issue::Severity::MEDIUM
+                # Issue::Severity::LOW
+                # Issue::Severity::INFORMATIONAL
+                #
+                :severity    => '',
+                :cvssv2       => '',
+                :remedy_guidance    => '',
+                :remedy_code => '',
+            }
+        }
+    end
+
+    def register_results( results )
+        Arachni::Module::Manager.register_results( results )
+    end
+
+end
+end
+end

data/lib/module/element_db.rb

@@ -0,0 +1,158 @@
+=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 Module
+
+#
+# Holds a database of all auditable elements of the current page,<br/>
+# including elements that have appeared dynamically during the audit.
+#
+# The database is updated by the {Trainer}.
+#
+# For each page that is audited the database is reset.
+#
+# @author: Tasos "Zapotek" Laskos
+#                                      <tasos.laskos@gmail.com>
+#                                      <zapotek@segfault.gr>
+# @version: 0.2.1
+#
+module ElementDB
+
+    include Arachni::Module::Utilities
+
+    #
+    # page forms
+    #
+    @@forms    ||= Set.new
+
+    #
+    # page links
+    #
+    @@links    ||= Set.new
+
+    #
+    # page cookies
+    #
+    @@cookies  ||= Set.new
+
+    #
+    # Initializes @@forms with the cookies found during the crawl/analysis
+    #
+    def init_forms( forms )
+      @@forms |= forms.map { |form| form.id }
+    end
+
+    #
+    # Initializes @@links with the links found during the crawl/analysis
+    #
+    def init_links( links )
+      @@links |= links.map { |link| link.id }
+    end
+
+    #
+    # Initializes @@cookies with the cookies found during the crawl/analysis
+    #
+    def init_cookies( cookies )
+      @@cookies = cookies
+    end
+
+    #
+    # Updates @@forms wth new forms that may have dynamically appeared<br/>
+    # after analyzing the HTTP responses during the audit.
+    #
+    # @param    [Array<Element::Form>] forms
+    #
+    def update_forms( forms )
+
+        return [], 0 if forms.size == 0
+
+        form_cnt = 0
+        new_forms ||= []
+
+        forms.each {
+            |form|
+
+            next if form.action.include?( seed )
+            next if form.auditable.size == 0
+
+            if !@@forms.include?( form.id )
+                @@forms << form.id
+                new_forms << form
+                form_cnt += 1
+            end
+        }
+
+        return new_forms, form_cnt
+    end
+
+    #
+    # Updates @@links wth new links that may have dynamically appeared<br/>
+    # after analyzing the HTTP responses during the audit.
+    #
+    # @param    [Array<Element::Link>]    links
+    #
+    def update_links( links )
+      return [], 0 if links.size == 0
+
+      link_cnt = 0
+      new_links ||= []
+      links.each {
+          |link|
+
+          next if !link
+          next if link.action.include?( seed )
+
+          if !@@links.include?( link.id )
+              @@links    << link.id
+              new_links << link
+              link_cnt += 1
+          end
+      }
+
+      return new_links, link_cnt
+    end
+
+    #
+    # Updates @@cookies wth new cookies that may have dynamically appeared<br/>
+    # after analyzing the HTTP responses during the audit.
+    #
+    # @param    [Array<Element::Cookie>]   cookies
+    #
+    def update_cookies( cookies )
+        return [], 0 if cookies.size == 0
+
+        cookie_cnt = 0
+        @new_cookies ||= []
+
+        cookies.each_with_index {
+            |cookie|
+
+            @@cookies.each_with_index {
+                |page_cookie, i|
+
+                if( page_cookie.raw['name'] == cookie.raw['name'] )
+                    @@cookies[i] = cookie
+                else
+                    @new_cookies << cookie
+                    cookie_cnt += 1
+                end
+            }
+        }
+
+        @@cookies.flatten!
+        @@cookies |= @new_cookies
+
+        return [ @@cookies, cookie_cnt ]
+    end
+
+end
+
+end
+end

data/lib/module/key_filler.rb

@@ -0,0 +1,87 @@
+=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 Module
+
+#
+# KeyFiller class
+#
+# Included by {Module::Auditor}.<br/>
+# Tries to fill in webapp parameters with values of proper type
+# based on their name.
+#
+# @author: Tasos "Zapotek" Laskos
+#                                      <tasos.laskos@gmail.com>
+#                                      <zapotek@segfault.gr>
+# @version: 0.1.1
+#
+class KeyFiller
+  
+    # Hash of regexps for the parameter keys
+    # and the values to to fill in
+    #
+    # @return  [Hash]
+    #
+    @@regexps = {
+        'name'    => 'arachni_name',
+        'user'    => 'arachni_user',
+        'usr'     => 'arachni_user',
+        'pass'    => '5543!%arachni_secret',
+        'txt'     => 'arachni_text',
+        'num'     => '132',
+        'amount'  => '100',
+        'mail'    => 'arachni@email.gr',
+        'account' => '12',
+        'id'      => '1'
+    }
+        
+    #
+    # Tries to fill a hash with values of appropriate type<br/>
+    # based on the key of the parameter.
+    #
+    # @param  [Hash]  hash   hash of name=>value pairs
+    #
+    # @return   [Hash]
+    #
+    def self.fill( hash )
+        
+        hash.keys.each{
+            |key|
+            
+            next if hash[key] && !hash[key].empty?
+            
+            if val = self.match?( key )
+                hash[key] = val
+            end
+            
+            # moronic default value...
+            # will figure  out ssomething better in the future...
+            hash[key] = '1' if( !hash[key] || hash[key].empty? )
+        }
+        
+        return hash
+    end
+    
+    private
+    
+    def self.match?( str )
+      @@regexps.keys.each {
+        |key|
+        return @@regexps[key] if( str =~ Regexp.new( key, 'i' ) )
+        
+      }
+      return false
+    end
+    
+end
+
+end
+end

data/lib/module/manager.rb

@@ -0,0 +1,87 @@
+=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 Modules
+
+    #
+    # Resets the namespace unloading all module classes
+    #
+    def self.reset
+        constants.each {
+            |const|
+            remove_const( const )
+        }
+    end
+end
+
+module Module
+
+#
+# Arachni::Module::Manager class
+#
+# Holds and manages the modules and their results.
+#
+# @author: Tasos "Zapotek" Laskos
+#                                      <tasos.laskos@gmail.com>
+#                                      <zapotek@segfault.gr>
+# @version: 0.1
+#
+class Manager < Arachni::ComponentManager
+
+    include Arachni::UI::Output
+
+    #
+    # @param    [Arachni::Options]  opts
+    #
+    def initialize( opts )
+        super( opts.dir['modules'], Arachni::Modules )
+        @opts = opts
+        @@results  = []
+    end
+
+    #
+    # Class method
+    #
+    # Registers module results with...well..us.
+    #
+    # @param    [Array]
+    #
+    def self.register_results( results )
+        @@results |= results
+    end
+
+    #
+    # Class method
+    #
+    # Gets module results
+    #
+    # @param    [Array]
+    #
+    def self.results( )
+        @@results
+    end
+
+    def results
+        @@results
+    end
+
+    def self.reset
+        @@results.clear
+        Arachni::Modules.reset
+    end
+
+end
+end
+end