Class: Nexpose::HTMLForms

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

Overview

When using htmlform, this represents the login form information.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from XMLUtils

#make_xml, #parse_xml

Constructor Details

#initialize(parentpage, soft403, webapproot) ⇒ HTMLForms

Returns a new instance of HTMLForms.



293
294
295
296
297
298
 
# File 'lib/nexpose/creds.rb', line 293

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

Instance Attribute Details

#html_forms ⇒ Object (readonly)

The forms to authenticate with



291
292
293
 
# File 'lib/nexpose/creds.rb', line 291

def html_forms
  @html_forms
end

#parentpage ⇒ Object (readonly)

The URL of the login page containing the login form.



284
285
286
 
# File 'lib/nexpose/creds.rb', line 284

def parentpage
  @parentpage
end

#soft403 ⇒ Object (readonly)

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



287
288
289
 
# File 'lib/nexpose/creds.rb', line 287

def soft403
  @soft403
end

#webapproot ⇒ Object (readonly)

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



289
290
291
 
# File 'lib/nexpose/creds.rb', line 289

def webapproot
  @webapproot
end

Instance Method Details

#add_html_form(html_form) ⇒ Object 



300
301
302
 
# File 'lib/nexpose/creds.rb', line 300

def add_html_form(html_form)
  @html_forms << html_form
end

#to_xml_elem ⇒ Object 



304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/nexpose/creds.rb', line 304

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

  xml = make_xml('HTMLForms', attributes)

  html_forms.each() do |html_form|
    xml.add_element(html_form.to_xml_elem)
  end
  xml
end