Class: Nexpose::SyslogAlert

Inherits:
Object
  • Object
show all
Includes:
Sanitize
Defined in:
lib/nexpose/site.rb

Overview

Description

Object that represents a Syslog Alert.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Sanitize

#replace_entities

Constructor Details

#initialize(name, server, enabled = 1) ⇒ SyslogAlert

Returns a new instance of SyslogAlert.



538
539
540
541
542
543
544
545
546
 
# File 'lib/nexpose/site.rb', line 538

def initialize(name, server, enabled = 1)
  @type = :syslog
  @name = name
  @server = server
  @enabled = enabled
  # Sets default vuln filter - All Events
  setVulnFilter(VulnFilter.new("50790400", 1))

end

Instance Attribute Details

#enabled ⇒ Object (readonly)

If this alert is enabled or not



530
531
532
 
# File 'lib/nexpose/site.rb', line 530

def enabled
  @enabled
end

#name ⇒ Object (readonly)

A unique name for this alert



528
529
530
 
# File 'lib/nexpose/site.rb', line 528

def name
  @name
end

#server ⇒ Object (readonly)

The Syslog server to sent this alert



532
533
534
 
# File 'lib/nexpose/site.rb', line 532

def server
  @server
end

#type ⇒ Object (readonly)

The alert type



536
537
538
 
# File 'lib/nexpose/site.rb', line 536

def type
  @type
end

#vulnFilter ⇒ Object (readonly)

The vulnerability filter to trigger the alert



534
535
536
 
# File 'lib/nexpose/site.rb', line 534

def vulnFilter
  @vulnFilter
end

Instance Method Details

#setVulnFilter(vulnFilter) ⇒ Object

Sets the Vulnerability Filter for this alert.



549
550
551
 
# File 'lib/nexpose/site.rb', line 549

def setVulnFilter(vulnFilter)
  @vulnFilter = vulnFilter
end

#to_xml ⇒ Object 



555
556
557
558
559
560
561
562
563
 
# File 'lib/nexpose/site.rb', line 555

def to_xml
  xml = "<syslogAlert"
  xml << %Q{ name="#{replace_entities(name)}"}
  xml << %Q{ enabled="#{replace_entities(enabled)}"}
  xml << %Q{ server="#{replace_entities(server)}">}
  xml << vulnFilter.to_xml
  xml << "</syslogAlert>"
  xml
end