Class: Arachni::Plugins::HealthMap

Inherits:
Arachni::Plugin::Base show all
Defined in:
components/plugins/defaults/healthmap.rb

Overview

Generates a simple list of safe/unsafe URLs.

Author:

Constant Summary

Constants included from Arachni

BANNER, Cookie, Form, Header, JSON, Link, LinkTemplate, Severity, UIForm, UIInput, VERSION, WEBSITE, WIKI, XML

Instance Attribute Summary

Attributes inherited from Arachni::Plugin::Base

#framework, #options

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Arachni::Plugin::Base

#browser_cluster, #clean_up, distributable, distributable?, #framework_abort, #framework_pause, #framework_resume, gems, #http, #info, #initialize, is_distributable, #prepare, #register_results, #restore, #session, #suspend, #wait_while_framework_running, #with_browser

Methods inherited from Component::Base

author, description, fullname, #shortname, shortname, shortname=, version

Methods included from Component::Output

#depersonalize_output, #depersonalize_output?, #intercept_print_message

Methods included from UI::Output

#caller_location, #debug?, #debug_level, #debug_level_1?, #debug_level_2?, #debug_level_3?, #debug_level_4?, #debug_off, #debug_on, #disable_only_positives, #error_buffer, #error_log_fd, #error_logfile, #has_error_log?, #included, #log_error, #mute, #muted?, #only_positives, #only_positives?, #print_bad, #print_debug, #print_debug_backtrace, #print_debug_exception, #print_debug_level_1, #print_debug_level_2, #print_debug_level_3, #print_debug_level_4, #print_error, #print_error_backtrace, #print_exception, #print_info, #print_line, #print_ok, #print_status, #print_verbose, #reroute_to_file, #reroute_to_file?, reset_output_options, #set_error_logfile, #unmute, #verbose?, #verbose_off, #verbose_on

Methods included from Component::Utilities

#read_file

Methods included from Utilities

#available_port, available_port_mutex, #bytes_to_kilobytes, #bytes_to_megabytes, #caller_name, #caller_path, #cookie_decode, #cookie_encode, #cookies_from_file, #cookies_from_parser, #cookies_from_response, #exception_jail, #exclude_path?, #follow_protocol?, #form_decode, #form_encode, #forms_from_parser, #forms_from_response, #full_and_absolute_url?, #generate_token, #get_path, #hms_to_seconds, #html_decode, #html_encode, #include_path?, #links_from_parser, #links_from_response, #normalize_url, #page_from_response, #page_from_url, #parse_set_cookie, #path_in_domain?, #path_too_deep?, #port_available?, #rand_port, #random_seed, #redundant_path?, #regexp_array_match, #remove_constants, #request_parse_body, #seconds_to_hms, #skip_page?, #skip_path?, #skip_resource?, #skip_response?, #to_absolute, #uri_decode, #uri_encode, #uri_parse, #uri_parse_query, #uri_parser, #uri_rewrite

Methods included from Arachni

URI, collect_young_objects, #get_long_win32_filename, jruby?, null_device, profile?, windows?

Constructor Details

This class inherits a constructor from Arachni::Plugin::Base

Class Method Details

.infoObject


72
73
74
75
76
77
78
79
# File 'components/plugins/defaults/healthmap.rb', line 72

def self.info
    {
        name:        'Health map',
        description: %q{Generates a simple list of safe/unsafe URLs.},
        author:      'Tasos "Zapotek" Laskos <[email protected]>',
        version:     '0.1.5'
    }
end

.merge(results) ⇒ Object


48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# File 'components/plugins/defaults/healthmap.rb', line 48

def self.merge( results )
    merged = {
        'map'              => [],
        'total'            => 0,
        'without_issues'   => 0,
        'with_issues'      => 0,
        'issue_percentage' => 0
    }

    results.each do |healthmap|
        merged['map']            |= healthmap['map']
        merged['total']          += healthmap['total']
        merged['without_issues'] += healthmap['without_issues']
        merged['with_issues']    += healthmap['with_issues']
    end

    merged['issue_percentage'] =
        ( ( merged['with_issues'].to_f / merged['total'].to_f ) * 100 ).round

    merged['map'] = merged['map'].sort_by { h.values.first }

    merged
end

Instance Method Details

#runObject


16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# File 'components/plugins/defaults/healthmap.rb', line 16

def run
    wait_while_framework_running

    report = framework.report

    sitemap  = report.sitemap.keys.map { |url| url.split( '?' ).first }.uniq
    sitemap |= issue_urls = report.issues.map { |issue| issue.vector.action }.uniq

    return if sitemap.size == 0

    issue_cnt = 0
    map = []
    sitemap.sort.each do |url|
        next if !url

        if issue_urls.include?( url )
            map << { 'with_issues' => url }
            issue_cnt += 1
        else
            map << { 'without_issues' => url }
        end
    end

    register_results(
        'map'              => map,
        'total'            => map.size,
        'without_issues'   => map.size - issue_cnt,
        'with_issues'      => issue_cnt,
        'issue_percentage' => ((issue_cnt.to_f / map.size.to_f) * 100).round
    )
end