Module: Arachni::Element::Capabilities::Submittable

Included in:
Auditable, Form, Form::Capabilities::Submittable, Link, Link::Capabilities::Submittable
Defined in:
lib/arachni/element/capabilities/submittable.rb

Overview

Author:

Instance Method Summary collapse

Instance Method Details

#action ⇒ String

Note:

Ex. ‘href’ for links, ‘action’ for forms, etc.

Returns URI to which the element points and should be audited against.

Returns:

  • (String) —

    URI to which the element points and should be audited against.



51
52
53
 
# File 'lib/arachni/element/capabilities/submittable.rb', line 51

def action
    @action.freeze
end

#action=(url) ⇒ Object

See Also:



56
57
58
 
# File 'lib/arachni/element/capabilities/submittable.rb', line 56

def action=( url )
    @action = self.url ? to_absolute( url, self.url ) : normalize_url( url )
end

#dup ⇒ Object 



111
112
113
114
115
116
 
# File 'lib/arachni/element/capabilities/submittable.rb', line 111

def dup
    new = super
    new.method = self.method
    new.action = self.action
    new
end

#http ⇒ Arachni::HTTP

Returns:



99
100
101
 
# File 'lib/arachni/element/capabilities/submittable.rb', line 99

def http
    HTTP::Client
end

#http_request(opts, &block) ⇒ HTTP::Request

This method is abstract.

Must be implemented by the including class and perform the appropriate HTTP request (get/post/whatever) for the current element.

Invoked by #submit to submit the object.

Parameters:

  • opts (Hash)
  • block (Block) —

    Callback to be passed the HTTP response.

Returns:

See Also:



94
95
96
 
# File 'lib/arachni/element/capabilities/submittable.rb', line 94

def http_request( opts, &block )
    fail NotImplementedError
end

#id ⇒ String

Note:

Differences in input values will be taken into consideration.

Returns String uniquely identifying self.

Returns:

  • (String) —

    String uniquely identifying self.



107
108
109
 
# File 'lib/arachni/element/capabilities/submittable.rb', line 107

def id
    "#{type}:#{method}:#{action}:#{inputtable_id}"
end

#initialize(options) ⇒ Object 



15
16
17
18
19
 
# File 'lib/arachni/element/capabilities/submittable.rb', line 15

def initialize( options )
    super
    self.method ||= options[:method] || :get
    self.action ||= options[:action] || self.url
end

#method(*args) ⇒ Symbol Also known as: http_method

Should represent a method in Check::HTTP.

Ex. get, post, cookie, header

Returns:

  • (Symbol) —

    HTTP request method for the element.

See Also:

  • Check::HTTP


35
36
37
38
 
# File 'lib/arachni/element/capabilities/submittable.rb', line 35

def method( *args )
    return super( *args ) if args.any?
    @method.freeze
end

#method=(method) ⇒ Object Also known as: http_method=

See Also:



42
43
44
 
# File 'lib/arachni/element/capabilities/submittable.rb', line 42

def method=( method )
    @method = method.to_s.downcase.to_sym
end

#platforms ⇒ Platform

Returns Applicable platforms for the #action resource.

Returns:



23
24
25
 
# File 'lib/arachni/element/capabilities/submittable.rb', line 23

def platforms
    Platform::Manager[@action]
end

#submit(options = {}, &block) ⇒ Object

Note:

Sets ‘self` as the HTTP::Request#performer.

Submits ‘self` to the #action URL with the appropriate parameters.

Parameters:

  • options (Hash) (defaults to: {})
  • block (Block) —

    Callback to be passed the HTTP::Response.

See Also:



70
71
72
73
74
75
76
77
78
79
 
# File 'lib/arachni/element/capabilities/submittable.rb', line 70

def submit( options = {}, &block )
    options                   = options.dup
    options[:parameters]      = @inputs.dup
    options[:follow_location] = true if !options.include?( :follow_location )

    @auditor ||= options.delete( :auditor )

    options[:performer]      ||= self
    http_request( options, &block )
end

#to_h ⇒ Object 



118
119
120
121
122
123
124
 
# File 'lib/arachni/element/capabilities/submittable.rb', line 118

def to_h
    (defined?( super ) ? super : {}).merge(
        url:    url,
        action: action,
        method: method
    )
end