Class: Arachni::Plugins::EmailNotify

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

Overview

Uses the Pony gem send a notification (and optionally report) at the end of the scan over SMTP.

Author:

Constant Summary collapse

TRIES =
5

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, 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

.infoObject


82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
# File 'components/plugins/email_notify.rb', line 82

def self.info
    {
        name:        'E-mail notify',
        description: %q{Sends a notification (and optionally a report) over SMTP at the end of the scan.},
        author:      'Tasos "Zapotek" Laskos <[email protected]>',
        version:     '0.1.7',
        options:     [
            Options::String.new( :to,
                required:    true,
                description: 'E-mail address of the receiver.'
            ),
            Options::String.new( :cc,
                description: 'E-mail address to which to send a carbon copy of the notification.'
            ),
            Options::String.new( :bcc,
                description: 'E-mail address for a blind carbon copy.'
            ),
            Options::String.new( :from,
                required:    true,
                description: 'E-mail address of the sender.'
            ),
            Options::Address.new( :server_address,
                required:    true,
                description: 'Address of the SMTP server to use.'
            ),
            Options::Port.new( :server_port,
                required:    true,
                description: 'SMTP port.'
            ),
            Options::Bool.new( :tls,
                description: 'Use TLS/SSL?.'
            ),
            Options::String.new( :username,
                description: 'SMTP username.'
            ),
            Options::String.new( :password,
                description: 'SMTP password.'
            ),
            Options::String.new( :domain,
                description: 'Domain.',
                default:     'localhost.localdomain'
            ),
            Options::MultipleChoice.new( :authentication,
                description: 'Authentication.',
                default:     '',
                choices:     ['plain', 'login', 'cram_md5', '']
            ),
            Options::MultipleChoice.new( :report,
                description: 'Report format to send as an attachment.',
                default:     'afr',
                choices:     ['xml', 'html', 'json', 'yaml', 'marshal', 'afr', 'none']
            )
        ]

    }
end

Instance Method Details

#clean_upObject


23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# File 'components/plugins/email_notify.rb', line 23

def clean_up
    report = framework.report

    opts = {
        subject:     "Scan for #{framework.options.url} finished in #{report.delta_time}",
        body:        "Found #{report.issues.size} unique issues.",
        to:          options[:to],
        cc:          options[:cc],
        bcc:         options[:bcc],
        from:        options[:from],
        via:         :smtp,
        via_options: {
            address:              options[:server_address],
            port:                 options[:server_port],
            enable_starttls_auto: options[:tls],
            user_name:            !options[:username].empty? ? options[:username] : nil,
            password:             !options[:password].empty? ? options[:password] : nil,
            authentication:       !options[:authentication].empty? ? options[:authentication].to_sym : nil,
            domain:               options[:domain]
        }
    }

    if options[:report] == 'afr'
        opts[:attachments] = {
            'report.afr' => framework.report.to_afr
        }
    elsif options[:report] != 'none'
        extension = framework.reporters[options[:report]].
            outfile_option.default.split( '.', 2 ).last
        framework.reporters.delete( options[:report] )

        opts[:attachments] = {
            "report.#{extension}" => framework.report_as( options[:report] )
        }
    end

    print_status 'Sending the notification...'

    sent      = false
    exception = nil
    TRIES.times do |i|
        begin
            Pony.mail( opts )
            sent = true
            break
        rescue => e
            exception = e
            print_bad "Attempt ##{i} failed, retrying..."
        end
    end

    if sent
        print_status 'Done.'
    else
        print_error "Failed after #{TRIES} tries."
        print_exception exception
    end
end

#runObject


19
20
21
# File 'components/plugins/email_notify.rb', line 19

def run
    wait_while_framework_running
end