Class: Arachni::Element::Link::DOM

Inherits:
DOM show all
Includes:
Capabilities::Submittable, Capabilities::WithNode, DOM::Capabilities::Auditable, DOM::Capabilities::Inputtable, DOM::Capabilities::Locatable, DOM::Capabilities::Mutable
Defined in:
lib/arachni/element/link/dom.rb,
lib/arachni/element/link/dom/capabilities/submittable.rb

Overview

Provides access to DOM operations for links.

Author:

Defined Under Namespace

Modules: Capabilities

Constant Summary

Constants included from Capabilities::Auditable

Capabilities::Auditable::OPTIONS

Constants included from DOM::Capabilities::Inputtable

DOM::Capabilities::Inputtable::INVALID_INPUT_DATA

Constants included from Capabilities::Inputtable

Capabilities::Inputtable::INPUTTABLE_CACHE

Constants included from Capabilities::Mutable

Capabilities::Mutable::EXTRA_NAME, Capabilities::Mutable::FUZZ_NAME, Capabilities::Mutable::FUZZ_NAME_VALUE, Capabilities::Mutable::MUTATION_OPTIONS

Constants inherited from Base

Base::MAX_SIZE

Instance Attribute Summary collapse

Attributes included from Capabilities::Auditable

#audit_options

Attributes included from Capabilities::WithAuditor

#auditor

Attributes included from Capabilities::Inputtable

#default_inputs, #inputs, #raw_inputs

Attributes included from Capabilities::Mutable

#affected_input_name, #format, #seed

Attributes included from Capabilities::WithSource

#source

Attributes inherited from DOM

#action, #browser, #parent

Attributes inherited from Base

#initialization_options, #page

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Capabilities::Submittable

#action, #action=, #dup, #http, #http_request, #id, #method, #method=, #platforms, #submit, #to_h

Methods included from DOM::Capabilities::Auditable

audit_handle_submit, audit_handle_submit_cb, handle_submission_result, #submit_and_process, #with_browser, #with_browser_cluster

Methods included from Capabilities::Auditable

#audit, #audit_id, #audit_status_message, #audit_status_message_action, #audit_verbose_message, #coverage_hash, #coverage_id, #dup, #matches_skip_like_blocks?, #reset, reset, #skip?, skip_like

Methods included from Capabilities::WithAuditor

#dup, #marshal_dump, #orphan?, #prepare_for_report, #remove_auditor

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 DOM::Capabilities::Inputtable

#valid_input_data?

Methods included from Capabilities::Inputtable

#[], #[]=, #changes, #dup, #has_inputs?, #inputtable_id, inputtable_id, #raw_input?, #reset, #to_h, #try_input, #update, #updated?, #valid_input_data?, #valid_input_name_data?, #valid_input_value?, #valid_input_value_data?

Methods included from Capabilities::Mutable

#affected_input_value, #affected_input_value=, #dup, #each_mutation, #immutables, #inspect, #mutation?, #mutations, #parameter_name_audit?, #reset, #switch_method, #to_h, #to_rpc_data, #with_raw_payload, #with_raw_payload?

Methods included from DOM::Capabilities::Locatable

#locate, #locator

Methods included from Capabilities::WithNode

#node

Methods included from Capabilities::WithSource

#dup, #to_h, #to_rpc_data

Methods inherited from DOM

decode, #decode, #dup, encode, #encode, #initialization_options, #marshal_dump, #page, #prepare_for_report, #url=

Methods inherited from Base

#==, #action, #dup, from_rpc_data, #id, #marshal_dump, #marshal_load, #persistent_hash, #prepare_for_report, #reset, #to_h, #to_hash, #to_rpc_data, too_big?, #url, #url=

Methods included from Capabilities::WithScope

#scope

Constructor Details

#initialize ⇒ DOM

Returns a new instance of DOM.



54
55
56
57
58
59
 
# File 'lib/arachni/element/link/dom.rb', line 54

def initialize(*)
    super

    prepare_data_from_node
    @method = :get
end

Instance Attribute Details

#fragment ⇒ String? (readonly)

Returns URL fragment.

http://test.com/stuff#/path/in/fragment?with-input=too => /path/in/fragment?with-input=too.

Returns:

  • (String, nil) —

    URL fragment.

    http://test.com/stuff#/path/in/fragment?with-input=too => /path/in/fragment?with-input=too



38
39
40
 
# File 'lib/arachni/element/link/dom.rb', line 38

def fragment
  @fragment
end

#fragment_path ⇒ String? (readonly)

Returns Path extracted from the #fragment.

http://test.com/stuff#/path/in/fragment?with-input=too => /path/in/fragment.

Returns:

  • (String, nil) —

    Path extracted from the #fragment.

    http://test.com/stuff#/path/in/fragment?with-input=too => /path/in/fragment



45
46
47
 
# File 'lib/arachni/element/link/dom.rb', line 45

def fragment_path
  @fragment_path
end

#fragment_query ⇒ String? (readonly)

Returns Query extracted from the #fragment.

http://test.com/stuff#/path/in/fragment?with-input=too => with-input=too.

Returns:

  • (String, nil) —

    Query extracted from the #fragment.

    http://test.com/stuff#/path/in/fragment?with-input=too => with-input=too



52
53
54
 
# File 'lib/arachni/element/link/dom.rb', line 52

def fragment_query
  @fragment_query
end

Class Method Details

.data_from_node(node) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/arachni/element/link/dom.rb', line 89

def self.data_from_node( node )
    fragment_path = fragment = nil

    href = node.attributes['href'].to_s
    return if !href.include? '#'

    fragment = href.split( '#', 2 ).last
    fragment_path, fragment_query = fragment.split( '?', 2 )

    inputs = uri_parse_query( "?#{fragment_query}" )
    return if inputs.empty?

    {
        inputs:         inputs,
        fragment:       fragment.freeze,
        fragment_path:  fragment_path.freeze,
        fragment_query: fragment_query.freeze,
    }
end

.type ⇒ Object 



85
86
87
 
# File 'lib/arachni/element/link/dom.rb', line 85

def self.type
    :link_dom
end

Instance Method Details

#hash ⇒ Object 



109
110
111
 
# File 'lib/arachni/element/link/dom.rb', line 109

def hash
    to_s.hash
end

#message_action ⇒ Object 



78
79
80
 
# File 'lib/arachni/element/link/dom.rb', line 78

def message_action
    "#{@action}##{fragment}"
end

#to_s ⇒ String

Returns URL including the DOM Capabilities::Inputtable#inputs.

Returns:



72
73
74
75
76
 
# File 'lib/arachni/element/link/dom.rb', line 72

def to_s
    "#{@action}##{fragment_path}?" << inputs.
        map { |k, v| "#{encode(k)}=#{encode(v)}" }.
        join( '&' )
end

#trigger ⇒ Object

Loads the page with the Capabilities::Inputtable#inputs in the #fragment.



62
63
64
 
# File 'lib/arachni/element/link/dom.rb', line 62

def trigger
    [ browser.goto( to_s, take_snapshot: false, update_transitions: false ) ]
end

#type ⇒ Object 



82
83
84
 
# File 'lib/arachni/element/link/dom.rb', line 82

def type
    self.class.type
end

#valid_input_name?(name) ⇒ Boolean

Returns:

  • (Boolean) 


66
67
68
 
# File 'lib/arachni/element/link/dom.rb', line 66

def valid_input_name?( name )
    @valid_input_names.include? name
end