Class: Arachni::Plugins::WebhookNotify

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

Overview

Send a webhook notification and payload after scan.

Author:

Version:

  • 0.1

Constant Summary

Constants included from Arachni

BANNER, Cookie, Form, Header, JSON, Link, LinkTemplate, NestedCookie, 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, merge, #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

.info ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'components/plugins/webhook_notify.rb', line 59

def self.info
    {
        name:        'Webhook notify',
        description: %q{
Sends a webhook payload over HTTP/HTTPS at the end of the scan.

Valid payload variables to use in the payload:

* $SEED$ -- Unique seed used for the scan.
* $URL$  -- Targeted URL.
* $MAX_SEVERITY$ -- Maximum severity of the identified issues.
* $ISSUE_COUNT$ -- Amount of identified issues.
* $DURATION$ -- Scan duration.
},
        author:      [
            'Sean Handley <[email protected]>',
            'Tasos Laskos <[email protected]>'
        ],
        version:     '0.1',
        options:     [
            Options::URL.new( :url,
                required:    true,
                description: 'Webhook URL (fully qualified including scheme)'
            ),
            Options::MultipleChoice.new( :content_type,
                description: 'Content type of payload (XML or JSON).',
                required:    true,
                default:     'json',
                choices:     %w(json xml)
            ),
            Options::String.new( :payload,
                required:    true,
                description: 'Either XML or JSON payload. Must be well-formed ' <<
                             'and valid. You can interpolate variables with $VARIABLE_NAME$'
            )
        ]

    }
end

Instance Method Details

#interpolate_variables(data) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'components/plugins/webhook_notify.rb', line 41

def interpolate_variables( data )
    report = framework.report

    data = data.gsub( '$URL$', framework.options.url )

    data.gsub!( '$SEED$', random_seed )
    data.gsub!( '$ISSUE_COUNT$', report.issues.size.to_s )

    max_severity = ''
    if (max_severity_issue = report.issues.sort.first)
        max_severity = max_severity_issue.severity.to_s
    end
    data.gsub!( '$MAX_SEVERITY$', max_severity )

    data.gsub!( '$DURATION$', report.delta_time )
    data
end

#run ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'components/plugins/webhook_notify.rb', line 16

def run
    wait_while_framework_running

    print_status 'Sending the notification...'

    response = http.request( options[:url].to_s,
        method:  :post,
        body:    interpolate_variables( options[:payload] ),
        mode:    :sync,
        headers: {
            'Content-Type' => "application/#{options[:content_type]}"
        }
    )

    register_results(
        'success'  => response.ok?,
        'status'   => response.return_code.to_s,
        'message'  => response.return_message,
        'response' => response.to_s
    )

    print_status "Done with HTTP code #{response.code}: " <<
                 "[#{response.return_code}] #{response.return_message}"
end