Class: Arachni::Element::Header

Inherits:

Base

Object
Base
Arachni::Element::Header

show all

Includes:: Capabilities::Analyzable, Capabilities::Auditable, Capabilities::Auditable::Buffered, Capabilities::Auditable::LineBuffered, Capabilities::Inputtable, Capabilities::Inputtable, Capabilities::Mutable, Capabilities::Submittable

Defined in:: lib/arachni/element/header.rb,
lib/arachni/element/header/capabilities/mutable.rb,
lib/arachni/element/header/capabilities/inputtable.rb

Overview

Represents an auditable request header element

Author:

Tasos “Zapotek” Laskos <tasos.laskos@arachni-scanner.com>

Defined Under Namespace

Modules: Capabilities

Constant Summary collapse

ENCODE_CHARACTERS =

["\n", "\r"]

ENCODE_CHARACTERS_LIST =

ENCODE_CHARACTERS.join

ENCODE_CACHE =

Arachni::Support::Cache::LeastRecentlyPushed.new( 1_000 )

DECODE_CACHE =

Arachni::Support::Cache::LeastRecentlyPushed.new( 1_000 )

Instance Attribute Summary

Attributes included from Capabilities::Inputtable

#default_inputs, #inputs, #raw_inputs

Attributes included from Capabilities::Mutable

#affected_input_name, #format, #seed

Attributes included from Capabilities::Analyzable::Differential

#differential_analysis_options

Attributes included from Capabilities::Analyzable::Timeout

#timing_attack_remark_data

Attributes included from Capabilities::Auditable

#audit_options

Attributes included from Capabilities::WithAuditor

#auditor

Attributes inherited from Base

#initialization_options, #page

Instance Method Summary collapse

#decode(header) ⇒ Object
#encode(header) ⇒ Object
#initialize(options) ⇒ Header constructor

A new instance of Header.
#name ⇒ String

Header name.
#simple ⇒ Object
#value ⇒ String

Header value.

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?, #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 Capabilities::Analyzable

has_timeout_candidates?, reset, timeout_audit_run

Methods included from Capabilities::Analyzable::Differential

#differential_analysis, #dup, reset, #to_rpc_data

Methods included from Capabilities::Analyzable::Timeout

add_phase_2_candidate, candidates_include?, deduplicate, deduplicate?, do_not_deduplicate, #dup, #ensure_responsiveness, has_candidates?, payload_delay_from_options, reset, run, #timeout_analysis, timeout_from_options, #timeout_id, #timing_attack_probe, #timing_attack_verify, #to_rpc_data

Methods included from Capabilities::Analyzable::Signature

#get_matches, #signature_analysis

Methods included from Capabilities::Submittable

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

Methods included from Capabilities::Auditable::LineBuffered

#line_buffered_audit

Methods included from Capabilities::Auditable::Buffered

#buffered_audit

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 inherited from Base

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

Methods included from Capabilities::WithScope

#scope

Constructor Details

#initialize(options) ⇒ `Header`

Returns a new instance of Header.

# File 'lib/arachni/element/header.rb', line 40

def initialize( options )
    super( options )

    self.inputs = options[:inputs]

    @default_inputs = self.inputs.dup.freeze
end

Class Method Details

.decode(header) ⇒ `Object`

# File 'lib/arachni/element/header.rb', line 77

def decode( header )
    header = header.to_s

    DECODE_CACHE.fetch( header ) do
        ::URI.decode( header )
    end
end

.encode(str) ⇒ `Object`

# File 'lib/arachni/element/header.rb', line 65

def encode( str )
    str = str.to_s

    ENCODE_CACHE.fetch( str ) do
        if !ENCODE_CHARACTERS.find { |c| str.include? c }
            str
        else
            ::URI.encode( str, ENCODE_CHARACTERS_LIST )
        end
    end
end

Instance Method Details

#decode(header) ⇒ `Object`



90
91
92

# File 'lib/arachni/element/header.rb', line 90

def decode( header )
    self.class.decode( header )
end

#encode(header) ⇒ `Object`



86
87
88

# File 'lib/arachni/element/header.rb', line 86

def encode( header )
    self.class.encode( header )
end

#name ⇒ `String`

Returns Header name.

Returns:

(String) —

Header name.



54
55
56

# File 'lib/arachni/element/header.rb', line 54

def name
    @inputs.first.first
end

#simple ⇒ `Object`



48
49
50

# File 'lib/arachni/element/header.rb', line 48

def simple
    @inputs.dup
end

#value ⇒ `String`

Returns Header value.