Class: Arachni::OptionGroups::BrowserCluster

Inherits:
Arachni::OptionGroup show all
Defined in:
lib/arachni/option_groups/browser_cluster.rb

Overview

Options for the BrowserCluster and its BrowserCluster::Workers.

Author:

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Arachni::OptionGroup

#==, attr_accessor, attributes, #attributes, #defaults, defaults, #hash, #initialize, #merge, set_defaults, #to_h, #to_hash, #update, #validate

Constructor Details

This class inherits a constructor from Arachni::OptionGroup

Instance Attribute Details

#ignore_imagesBool

Returns Should the browser's avoid loading images?.

Returns:

  • (Bool)

    Should the browser's avoid loading images?


43
44
45
# File 'lib/arachni/option_groups/browser_cluster.rb', line 43

def ignore_images
  @ignore_images
end

#job_timeoutInteger

Returns Maximum allowed time for jobs in seconds.

Returns:

  • (Integer)

    Maximum allowed time for jobs in seconds.


35
36
37
# File 'lib/arachni/option_groups/browser_cluster.rb', line 35

def job_timeout
  @job_timeout
end

#local_storageHash

Returns Data to be set in the browser's localStorage.

Returns:

  • (Hash)

    Data to be set in the browser's localStorage.


18
19
20
# File 'lib/arachni/option_groups/browser_cluster.rb', line 18

def local_storage
  @local_storage
end

#pool_sizeInteger

Returns Amount of BrowserCluster::Worker to keep in the pool and put to work.

Returns:


31
32
33
# File 'lib/arachni/option_groups/browser_cluster.rb', line 31

def pool_size
  @pool_size
end

#screen_heightBool

Returns Screen height.

Returns:

  • (Bool)

    Screen height.


51
52
53
# File 'lib/arachni/option_groups/browser_cluster.rb', line 51

def screen_height
  @screen_height
end

#screen_widthBool

Returns Screen width.

Returns:

  • (Bool)

    Screen width.


47
48
49
# File 'lib/arachni/option_groups/browser_cluster.rb', line 47

def screen_width
  @screen_width
end

#session_storageHash

Returns Data to be set in the browser's sessionStorage.

Returns:

  • (Hash)

    Data to be set in the browser's sessionStorage.


22
23
24
# File 'lib/arachni/option_groups/browser_cluster.rb', line 22

def session_storage
  @session_storage
end

#wait_for_elementsHash<Regexp,String>

Returns When the page URL matched the key Regexp, wait until the String CSS selector in the value matches an element.

Returns:

  • (Hash<Regexp,String>)

    When the page URL matched the key Regexp, wait until the String CSS selector in the value matches an element.


27
28
29
# File 'lib/arachni/option_groups/browser_cluster.rb', line 27

def wait_for_elements
  @wait_for_elements
end

#wait_for_timersBool

Returns Shall we wait for the max timer to fire on the page?.

Returns:

  • (Bool)

    Shall we wait for the max timer to fire on the page?


55
56
57
# File 'lib/arachni/option_groups/browser_cluster.rb', line 55

def wait_for_timers
  @wait_for_timers
end

#worker_time_to_liveInteger

Returns Re-spawn the browser every #worker_time_to_live jobs.

Returns:


39
40
41
# File 'lib/arachni/option_groups/browser_cluster.rb', line 39

def worker_time_to_live
  @worker_time_to_live
end

Instance Method Details

#css_to_wait_for(url) ⇒ Object


98
99
100
101
102
103
# File 'lib/arachni/option_groups/browser_cluster.rb', line 98

def css_to_wait_for( url )
    wait_for_elements.map do |pattern, css|
        next if !(url =~ pattern)
        css
    end.compact
end

#to_rpc_dataObject


117
118
119
120
121
122
123
124
125
126
127
# File 'lib/arachni/option_groups/browser_cluster.rb', line 117

def to_rpc_data
    d = super

    d['wait_for_elements'] = d['wait_for_elements'].dup

    d['wait_for_elements'].dup.each do |k, v|
        d['wait_for_elements'][k.source] = d['wait_for_elements'].delete(k)
    end

    d
end

#wait_for_timers?Boolean

Returns:

  • (Boolean)

74
75
76
# File 'lib/arachni/option_groups/browser_cluster.rb', line 74

def wait_for_timers?
    !!@wait_for_timers
end