Class: Nexpose::Headers

Inherits:
Object
  • Object
show all
Includes:
XMLUtils
Defined in:
lib/nexpose/creds.rb

Overview

Object that represents Headers, associated with Web Session Authentication.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from XMLUtils

#make_xml, #parse_xml

Constructor Details

#initialize(webapproot, soft403) ⇒ Headers

Returns a new instance of Headers.



164
165
166
167
168
 
# File 'lib/nexpose/creds.rb', line 164

def initialize(webapproot, soft403)
  @headers = []
  @webapproot = webapproot
  @soft403 = soft403
end

Instance Attribute Details

#headers ⇒ Object (readonly)

When using httpheaders, this represents the set of headers to pass with the authentication request.



162
163
164
 
# File 'lib/nexpose/creds.rb', line 162

def headers
  @headers
end

#soft403 ⇒ Object (readonly)

A regular expression used to match against the response to identify authentication failures.



158
159
160
 
# File 'lib/nexpose/creds.rb', line 158

def soft403
  @soft403
end

#webapproot ⇒ Object (readonly)

Base URL of the application for which the form authentication applies.



160
161
162
 
# File 'lib/nexpose/creds.rb', line 160

def webapproot
  @webapproot
end

Instance Method Details

#add_header(header) ⇒ Object 



170
171
172
 
# File 'lib/nexpose/creds.rb', line 170

def add_header(header)
  @headers.push(header)
end

#to_xml_elem ⇒ Object 



174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/nexpose/creds.rb', line 174

def to_xml_elem
  attributes = {}
  attributes['webapproot'] = @webapproot
  attributes['soft403'] = @soft403

  xml = make_xml('Headers', attributes)
  @headers.each do |header|
    xml.add_element(header.to_xml_elem)
  end
  xml
end