LEEF

SyslogPro~ LEEF

A class to work with IBM LEEF (Log Event Extended Format) messages this form of system messages are designed to work with security systems. Messages can be saved to file (Saving to file if not part of this module but a LEEF formated mesage produced by this module can be saved externaly to it) or sent via Syslog.

Constructor

new LEEF(optionsopt)

Source:

index.js, line 1669

Version:

0.0.0

Since:

0.0.0

Construct a new LEEF object with user options

Parameters:

Name Type Attributes Description

options

object

<optional>

Options object

Properties

Name	Type	Attributes	Default	Description
`vendor`	string	<optional>	`'unknown'`	The vendor of the system that genrated the event being reported
`product`	string	<optional>	`'unknown'`	The product name of the system that genrated the event being reported
`version`	string	<optional>	`'unknown'`	The version name of the system that genrated the event being reported
`eventId`	string	<optional>	`'unknown'`	The eventId of the system that genrated the event being reported
`attrabute`	object	<optional>		LEEF message attrabutes which defualts to all base attrabutes with null values, new attrabutes should be added as new elements to this object
`syslogHeader`	boolean	<optional>	`'true'`	Should the LEEF message include a Syslog header with Timestamp and source
`server`	Syslog	<optional>	`false`	A Syslog server connection that should be used to send messages directly from this class. @see SyslogPro~Syslog

Requires:

module:moment

Requires

module:moment

Members

attrabutes :object

Source:

index.js, line 1707

Type:

object

(private) constructor__

Source:

index.js, line 1693

eventId :string

Source:

index.js, line 1702

Type:

string

product :string

Source:

index.js, line 1698

Type:

string

(private) server

Source:

index.js, line 1758

syslogHeader :boolean

Source:

index.js, line 1704

Type:

boolean

vendor :string

Source:

index.js, line 1696

Type:

string

version :string

Source:

index.js, line 1700

Type:

string

Methods

buildMessage() → {Promise}

Source:

index.js, line 1769

Build a formated message

Returns:

- string with formated message

Type: Promise

send(optionsopt)

Source:

index.js, line 1797

Parameters:

Name	Type	Attributes	Default	Description
`options`	Syslog	<optional>	`false`	A Syslog server connection that should be used to send messages directly from this class. @see SyslogPro~Syslog