Class: Arachni::Plugins::CookieCollector

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

Overview

Simple cookie collector

Author:

Version:

  • 0.2.1

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, distributable, distributable?, #framework_abort, #framework_pause, #framework_resume, gems, #http, #info, #initialize, is_distributable, #register_results, #session, #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


76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
# File 'components/plugins/cookie_collector.rb', line 76

def self.info
    {
        name:        'Cookie collector',
        description: %q{
Monitors and collects cookies while establishing a timeline of changes.

**WARNING**: Highly discouraged when the audit includes cookies. It will log
thousands of results leading to a huge report, highly increased memory
consumption and CPU usage.
},
        author:      'Tasos "Zapotek" Laskos <[email protected]>',
        version:     '0.2.1',
        options:     [
            Options::String.new( :filter,
                description: 'Pattern to use to determine which cookies to ' +
                              'log, based on cookie name.'
            )
        ]
    }
end

.merge(results) ⇒ Object


72
73
74
# File 'components/plugins/cookie_collector.rb', line 72

def self.merge( results )
    results.flatten
end

Instance Method Details

#clean_upObject


61
62
63
# File 'components/plugins/cookie_collector.rb', line 61

def clean_up
    register_results( @cookies )
end

#filter(cookies) ⇒ Object


65
66
67
68
69
70
# File 'components/plugins/cookie_collector.rb', line 65

def filter( cookies )
    @filter ||= Regexp.new( options[:filter] ) if options[:filter]

    return cookies if !@filter
    cookies.select { |name, _| name =~ @filter }
end

#prepareObject


17
18
19
# File 'components/plugins/cookie_collector.rb', line 17

def prepare
    @cookies = []
end

#restore(cookies) ⇒ Object


25
26
27
# File 'components/plugins/cookie_collector.rb', line 25

def restore( cookies )
    @cookies = cookies
end

#runObject


29
30
31
32
33
34
35
36
# File 'components/plugins/cookie_collector.rb', line 29

def run
    http.on_new_cookies do |cookies, response|
        cookies_hash = cookies.inject({}) { |h, c| h.merge!( c.simple ); h }
        update( filter( cookies_hash ), response )
    end

    wait_while_framework_running
end

#suspendObject


21
22
23
# File 'components/plugins/cookie_collector.rb', line 21

def suspend
    @cookies
end

#update(cookies, response) ⇒ Object


38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# File 'components/plugins/cookie_collector.rb', line 38

def update( cookies, response )
    return if cookies.empty? || !update?( cookies )

    response_hash = response.to_h
    response_hash.delete( :body )
    response_hash.delete( :headers_string )

    r_h = response_hash.my_stringify_keys
    r_h['headers']['Set-Cookie'] = [r_h['headers']['Set-Cookie']].flatten.compact

    @cookies << {
        'time'     => Time.now.to_s,
        'response' => r_h,
        'cookies'  => cookies
    }
end

#update?(cookies) ⇒ Boolean

Returns:

  • (Boolean)

55
56
57
58
59
# File 'components/plugins/cookie_collector.rb', line 55

def update?( cookies )
    return true if @cookies.empty?
    cookies.each { |k, v| return true if @cookies.last['cookies'][k] != v }
    false
end