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.



143
144
145
146
147
 
# File 'lib/nexpose/creds.rb', line 143

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.



141
142
143
 
# File 'lib/nexpose/creds.rb', line 141

def headers
  @headers
end

#soft403 ⇒ Object (readonly)

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



137
138
139
 
# File 'lib/nexpose/creds.rb', line 137

def soft403
  @soft403
end

#webapproot ⇒ Object (readonly)

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



139
140
141
 
# File 'lib/nexpose/creds.rb', line 139

def webapproot
  @webapproot
end

Instance Method Details

#add_header(header) ⇒ Object 



149
150
151
 
# File 'lib/nexpose/creds.rb', line 149

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

#to_xml_elem ⇒ Object 



153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/nexpose/creds.rb', line 153

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