diff --git a/README.md b/README.md index 486da3c..544f4dc 100644 --- a/README.md +++ b/README.md @@ -18,10 +18,18 @@ Structured Data is also included in the module. All 28 standard CEF Extensions are included in the default CEF class. All 45 standard LEEF Attributes are included in the default LEEF class. It is the goal of this project is for every release to offer full code coverage unit testing and documentation. -[Please see the full documentation for usage and options: + +[Please see the full JSDoc for usage and options: https://cyamato.github.io/SyslogPro/](https://cyamato.github.io/SyslogPro/). -## Installation +### News +* ⚠ Please note that at present, the 0.1.x version of the SDK +[requires Node 10.6 or later](https://github.com/nodejs/LTS). +* This module makes use of [ECMA-262 Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) +and the [DNS Promises API](https://nodejs.org/api/dns.html#dns_dns_promises_api). +* APIs do not support the callback model and only return promises. + +### Installation ```shell npm install --save SyslogPro ``` @@ -110,7 +118,12 @@ https://cyamato.github.io/SyslogPro/](https://cyamato.github.io/SyslogPro/). console.log(error); }); ``` - + +## API +For more details see: +* [JSDoc](https://cyamato.github.io/SyslogPro/) +* [api.md](./docs/api.md) + ## Test ```shell npm test @@ -118,4 +131,9 @@ https://cyamato.github.io/SyslogPro/](https://cyamato.github.io/SyslogPro/). ## Contributing -Please try to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code. \ No newline at end of file +Please try to maintain the existing coding style. Add unit tests for any new or +changed functionality. Lint and test your code. + +* [Repository](https://github.com/cyamato/SyslogPro.git) +* [Bug Reporting](https://github.com/cyamato/SyslogPro/issues) +* [Wiki](https://github.com/cyamato/SyslogPro/wiki) \ No newline at end of file diff --git a/docs/api.md b/docs/api.md new file mode 100644 index 0000000..f96c87e --- /dev/null +++ b/docs/api.md @@ -0,0 +1,1257 @@ +API +========================== + +- back to [README.md](../README.md) + +API convention +== + + + +## SyslogPro +The SyslogPro module for sending syslog messages +Most APIs will return a promise. These APIs can be used using +`then(...)/catch(...)` + +Syslog formating classes can be used as input into a Syslog class to be used +simultatniusly to the same Syslog server. The Syslog Class with a configured +Syslog server target can also be used as the input into each of the formating +classes so that they may run independtly. + +**Version**: 0.1.0 +**Author**: Craig Yamato +**Copyright**: (c) 2018 - Craig Yamato + +* [SyslogPro](#module_SyslogPro) + * [~Syslog](#module_SyslogPro..Syslog) + * [new Syslog([options])](#new_module_SyslogPro..Syslog_new) + * [.target](#module_SyslogPro..Syslog+target) : string + * [.protocol](#module_SyslogPro..Syslog+protocol) : string + * [.port](#module_SyslogPro..Syslog+port) : number + * [.tcpTimeout](#module_SyslogPro..Syslog+tcpTimeout) : number + * [.tlsServerCerts](#module_SyslogPro..Syslog+tlsServerCerts) : Array.<string> + * [.tlsClientCert](#module_SyslogPro..Syslog+tlsClientCert) : string + * [.tlsClientKey](#module_SyslogPro..Syslog+tlsClientKey) : string + * [.format](#module_SyslogPro..Syslog+format) : string + * [.rfc3164](#module_SyslogPro..Syslog+rfc3164) : RFC3164 + * [.rfc5424](#module_SyslogPro..Syslog+rfc5424) : RFC5424 + * [.leef](#module_SyslogPro..Syslog+leef) : LEEF + * [.cef](#module_SyslogPro..Syslog+cef) : CEF + * [~RFC3164](#module_SyslogPro..RFC3164) + * [new RFC3164([options])](#new_module_SyslogPro..RFC3164_new) + * [.color](#module_SyslogPro..RFC3164+color) : boolean + * [.extendedColor](#module_SyslogPro..RFC3164+extendedColor) : boolean + * [.setColor()](#module_SyslogPro..RFC3164+setColor) + * [.buildMessage(msg, [options])](#module_SyslogPro..RFC3164+buildMessage) ⇒ Promise + * [.send(msg, [options])](#module_SyslogPro..RFC3164+send) ⇒ Promise + * [.emergency(msg)](#module_SyslogPro..RFC3164+emergency) ⇒ Promise + * [.emer(msg)](#module_SyslogPro..RFC3164+emer) ⇒ Promise + * [.alert(msg)](#module_SyslogPro..RFC3164+alert) ⇒ Promise + * [.critical(msg)](#module_SyslogPro..RFC3164+critical) ⇒ Promise + * [.crit(msg)](#module_SyslogPro..RFC3164+crit) ⇒ Promise + * [.error(msg)](#module_SyslogPro..RFC3164+error) ⇒ Promise + * [.err(msg)](#module_SyslogPro..RFC3164+err) ⇒ Promise + * [.warning(msg)](#module_SyslogPro..RFC3164+warning) ⇒ Promise + * [.warn(msg)](#module_SyslogPro..RFC3164+warn) ⇒ Promise + * [.notice(msg)](#module_SyslogPro..RFC3164+notice) ⇒ Promise + * [.note(msg)](#module_SyslogPro..RFC3164+note) ⇒ Promise + * [.informational(msg)](#module_SyslogPro..RFC3164+informational) ⇒ Promise + * [.info(msg)](#module_SyslogPro..RFC3164+info) ⇒ Promise + * [.log(msg)](#module_SyslogPro..RFC3164+log) ⇒ Promise + * [.debug(msg)](#module_SyslogPro..RFC3164+debug) ⇒ Promise + * [~RFC5424](#module_SyslogPro..RFC5424) + * [new RFC5424([options])](#new_module_SyslogPro..RFC5424_new) + * [.timestamp](#module_SyslogPro..RFC5424+timestamp) : boolean + * [.timestampUTC](#module_SyslogPro..RFC5424+timestampUTC) : boolean + * [.timestampTZ](#module_SyslogPro..RFC5424+timestampTZ) : boolean + * [.timestampMS](#module_SyslogPro..RFC5424+timestampMS) : boolean + * [.encludeStructuredData](#module_SyslogPro..RFC5424+encludeStructuredData) : boolean + * [.utf8BOM](#module_SyslogPro..RFC5424+utf8BOM) : boolean + * [.color](#module_SyslogPro..RFC5424+color) : boolean + * [.extendedColor](#module_SyslogPro..RFC5424+extendedColor) : boolean + * [.setColor()](#module_SyslogPro..RFC5424+setColor) + * [.buildMessage(msg, [options])](#module_SyslogPro..RFC5424+buildMessage) ⇒ Promise + * [.send(msg)](#module_SyslogPro..RFC5424+send) ⇒ Promise + * [.emergency(msg)](#module_SyslogPro..RFC5424+emergency) ⇒ Promise + * [.emer(msg)](#module_SyslogPro..RFC5424+emer) ⇒ Promise + * [.alert(msg)](#module_SyslogPro..RFC5424+alert) ⇒ Promise + * [.critical(msg)](#module_SyslogPro..RFC5424+critical) ⇒ Promise + * [.crit(msg)](#module_SyslogPro..RFC5424+crit) ⇒ Promise + * [.error(msg)](#module_SyslogPro..RFC5424+error) ⇒ Promise + * [.err(msg)](#module_SyslogPro..RFC5424+err) ⇒ Promise + * [.warning(msg)](#module_SyslogPro..RFC5424+warning) ⇒ Promise + * [.warn(msg)](#module_SyslogPro..RFC5424+warn) ⇒ Promise + * [.notice(msg)](#module_SyslogPro..RFC5424+notice) ⇒ Promise + * [.note(msg)](#module_SyslogPro..RFC5424+note) ⇒ Promise + * [.informational(msg)](#module_SyslogPro..RFC5424+informational) ⇒ Promise + * [.info(msg)](#module_SyslogPro..RFC5424+info) ⇒ Promise + * [.log(msg)](#module_SyslogPro..RFC5424+log) ⇒ Promise + * [.debug(msg)](#module_SyslogPro..RFC5424+debug) ⇒ Promise + * [~LEEF](#module_SyslogPro..LEEF) + * [new LEEF([options])](#new_module_SyslogPro..LEEF_new) + * [.vendor](#module_SyslogPro..LEEF+vendor) : string + * [.product](#module_SyslogPro..LEEF+product) : string + * [.version](#module_SyslogPro..LEEF+version) : string + * [.eventId](#module_SyslogPro..LEEF+eventId) : string + * [.syslogHeader](#module_SyslogPro..LEEF+syslogHeader) : boolean + * [.attrabutes](#module_SyslogPro..LEEF+attrabutes) : object + * [.buildMessage()](#module_SyslogPro..LEEF+buildMessage) ⇒ Promise + * [.send([options])](#module_SyslogPro..LEEF+send) + * [~CEF](#module_SyslogPro..CEF) + * [new CEF([options])](#new_module_SyslogPro..CEF_new) + * [.deviceVendor](#module_SyslogPro..CEF+deviceVendor) : string + * [.deviceProduct](#module_SyslogPro..CEF+deviceProduct) : string + * [.deviceVersion](#module_SyslogPro..CEF+deviceVersion) : string + * [.deviceEventClassId](#module_SyslogPro..CEF+deviceEventClassId) : string + * [.name](#module_SyslogPro..CEF+name) : string + * [.severity](#module_SyslogPro..CEF+severity) : string + * [.extensions](#module_SyslogPro..CEF+extensions) : object + * [.validate()](#module_SyslogPro..CEF+validate) ⇒ Promise + * [.buildMessage()](#module_SyslogPro..CEF+buildMessage) ⇒ Promise + * [.send([options])](#module_SyslogPro..CEF+send) + + + +### SyslogPro~Syslog +A class to work with syslog messages using UDP, TCP, or TLS transport. +There is suport for Syslog message formating RFC-3164, RFC-5424 including +Structured Data, IBM LEEF (Log Event Extended Format), and HP CEF (Common +Event Format). +Syslog formating classes can be used as input into a Syslog class to be used +simultatniusly to the same Syslog server. * + +**Kind**: inner class of [SyslogPro](#module_SyslogPro) +**Requires**: module:moment +**Since**: 0.0.0 +**Version**: 0.0.0 + +* [~Syslog](#module_SyslogPro..Syslog) + * [new Syslog([options])](#new_module_SyslogPro..Syslog_new) + * [.target](#module_SyslogPro..Syslog+target) : string + * [.protocol](#module_SyslogPro..Syslog+protocol) : string + * [.port](#module_SyslogPro..Syslog+port) : number + * [.tcpTimeout](#module_SyslogPro..Syslog+tcpTimeout) : number + * [.tlsServerCerts](#module_SyslogPro..Syslog+tlsServerCerts) : Array.<string> + * [.tlsClientCert](#module_SyslogPro..Syslog+tlsClientCert) : string + * [.tlsClientKey](#module_SyslogPro..Syslog+tlsClientKey) : string + * [.format](#module_SyslogPro..Syslog+format) : string + * [.rfc3164](#module_SyslogPro..Syslog+rfc3164) : RFC3164 + * [.rfc5424](#module_SyslogPro..Syslog+rfc5424) : RFC5424 + * [.leef](#module_SyslogPro..Syslog+leef) : LEEF + * [.cef](#module_SyslogPro..Syslog+cef) : CEF + + + +#### new Syslog([options]) +Construct a new Syslog transport object with user options + + +| Param | Type | Default | Description | +| --- | --- | --- | --- | +| [options] | object | | Options object >>>Transport Configuraton | +| [options.target] | string | "'localhost'" | The IP Address|FQDN of the Syslog Server, this option if set will take prasdents over any target set in a formating object | +| [options.protocol] | string | "'udp'" | L4 transport portocol (udp|tcp|tls), this option if set will take prasdents over any transport set in a formating object | +| [options.port] | number | 514 | IP port, this option if set will take prasdents over any IP Port set in a formating object | +| [options.tcpTimeout] | number | 10000 | Ignored for all other transports, this option if set will take prasdents over any timeout set in a formating object | +| [options.tlsServerCerts] | Array.<string> | | Array of authrized TLS server certificates file locations, this option if set will take prasdents over any certificates set in a formating object | +| [options.tlsClientCert] | string | | Client TLS certificate file location that this client should use, this option if set will take prasdents over any certificates set in a formating object | +| [options.tlsClientKey] | string | | Client TLS key file location that this client should use, this option if set will take prasdents over any certificates set in a formating object >>>Syslog Format Settings | +| [options.format] | string | "'none'" | Valid syslog format options for this module are 'none', 'rfc3164', 'rfc5424', 'leef', 'cef' | +| [options.rfc5424] | RFC3164 | | {@link module:SyslogPro~RFC5424| RFC5424 related settings} | +| [options.rfc5424] | RFC5424 | | {@link module:SyslogPro~RFC5424| RFC5424 related settings} | +| [options.leef] | LEEF | | {@link module:SyslogPro~LEEF|IBM LEEF (Log Event Extended Format) object} | +| [options.cef] | CEF | | {@link module:SyslogPro~CEF|HP CEF (Common Event Format) formating object} | + + + +#### syslog.target : string +**Kind**: instance property of [Syslog](#module_SyslogPro..Syslog) + + +#### syslog.protocol : string +**Kind**: instance property of [Syslog](#module_SyslogPro..Syslog) + + +#### syslog.port : number +**Kind**: instance property of [Syslog](#module_SyslogPro..Syslog) + + +#### syslog.tcpTimeout : number +**Kind**: instance property of [Syslog](#module_SyslogPro..Syslog) + + +#### syslog.tlsServerCerts : Array.<string> +**Kind**: instance property of [Syslog](#module_SyslogPro..Syslog) + + +#### syslog.tlsClientCert : string +**Kind**: instance property of [Syslog](#module_SyslogPro..Syslog) + + +#### syslog.tlsClientKey : string +**Kind**: instance property of [Syslog](#module_SyslogPro..Syslog) + + +#### syslog.format : string +**Kind**: instance property of [Syslog](#module_SyslogPro..Syslog) + + +#### syslog.rfc3164 : RFC3164 +**Kind**: instance property of [Syslog](#module_SyslogPro..Syslog) + + +#### syslog.rfc5424 : RFC5424 +**Kind**: instance property of [Syslog](#module_SyslogPro..Syslog) + + +#### syslog.leef : LEEF +**Kind**: instance property of [Syslog](#module_SyslogPro..Syslog) + + +#### syslog.cef : CEF +**Kind**: instance property of [Syslog](#module_SyslogPro..Syslog) + + +### SyslogPro~RFC3164 +A class to work with RFC3164 formated syslog messages. The meesaging is fully configurabule and Ansi foreground +colors can be added. Both ANSI 8 and ANSI 256 color are fully suported. +Most APIs will return a promise. These APIs can be used using +`then(...)/catch(...)` + +A Syslog class with a configured +Syslog server target can also be used as the input into the formating +classes so that it may run independtly. + +The RFC3164 Syslog logging format is ment to be used as a stream of log data +from a service or applacation. This class is designed to be used in this +fashion where new messages are writen to the class as needed. + +**Kind**: inner class of [SyslogPro](#module_SyslogPro) +**Requires**: module:moment +**Since**: 0.0.0 +**Version**: 0.0.0 + +* [~RFC3164](#module_SyslogPro..RFC3164) + * [new RFC3164([options])](#new_module_SyslogPro..RFC3164_new) + * [.color](#module_SyslogPro..RFC3164+color) : boolean + * [.extendedColor](#module_SyslogPro..RFC3164+extendedColor) : boolean + * [.setColor()](#module_SyslogPro..RFC3164+setColor) + * [.buildMessage(msg, [options])](#module_SyslogPro..RFC3164+buildMessage) ⇒ Promise + * [.send(msg, [options])](#module_SyslogPro..RFC3164+send) ⇒ Promise + * [.emergency(msg)](#module_SyslogPro..RFC3164+emergency) ⇒ Promise + * [.emer(msg)](#module_SyslogPro..RFC3164+emer) ⇒ Promise + * [.alert(msg)](#module_SyslogPro..RFC3164+alert) ⇒ Promise + * [.critical(msg)](#module_SyslogPro..RFC3164+critical) ⇒ Promise + * [.crit(msg)](#module_SyslogPro..RFC3164+crit) ⇒ Promise + * [.error(msg)](#module_SyslogPro..RFC3164+error) ⇒ Promise + * [.err(msg)](#module_SyslogPro..RFC3164+err) ⇒ Promise + * [.warning(msg)](#module_SyslogPro..RFC3164+warning) ⇒ Promise + * [.warn(msg)](#module_SyslogPro..RFC3164+warn) ⇒ Promise + * [.notice(msg)](#module_SyslogPro..RFC3164+notice) ⇒ Promise + * [.note(msg)](#module_SyslogPro..RFC3164+note) ⇒ Promise + * [.informational(msg)](#module_SyslogPro..RFC3164+informational) ⇒ Promise + * [.info(msg)](#module_SyslogPro..RFC3164+info) ⇒ Promise + * [.log(msg)](#module_SyslogPro..RFC3164+log) ⇒ Promise + * [.debug(msg)](#module_SyslogPro..RFC3164+debug) ⇒ Promise + + + +#### new RFC3164([options]) +Construct a new RFC3164 formated Syslog object with user options + + +| Param | Type | Default | Description | +| --- | --- | --- | --- | +| [options] | object | | Options object | +| [options.applacationName] | string | "'NodeJSLogger'" | Applacation | +| [options.hostname] | string | "os.hostname" | The name of this server | +| [options.facility] | number | 23 | Facility code to use sending this message | +| [options.color] | boolean | false | Apply color coding encoding tag with syslog message text | +| [options.extendedColor] | boolean | false | Use the extedned ANSI color set encoding tag with syslog message text | +| [options.colors] | object | | User defended colors for severites | +| [options.colors.emergencyColor] | string | | A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended) | +| [options.colors.alertColor] | string | | A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended) | +| [options.colors.criticalColor] | string | | A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended) | +| [options.colors.errorColor] | string | | A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended) | +| [options.colors.warningColor] | string | | A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended) | +| [options.colors.noticeColor] | string | | A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended) | +| [options.colors.informationalColor] | string | | A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended) | +| [options.colors.debugColor] | string | | A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended) | +| [options.server] | Syslog | false | A {@link module:SyslogPro~Syslog| Syslog server connection} that should be used to send messages directly from this class. @see SyslogPro~Syslog | + + + +#### rfC3164.color : boolean +**Kind**: instance property of [RFC3164](#module_SyslogPro..RFC3164) + + +#### rfC3164.extendedColor : boolean +**Kind**: instance property of [RFC3164](#module_SyslogPro..RFC3164) + + +#### rfC3164.setColor() +Sets the color to be used for messages at a set priority + +**Kind**: instance method of [RFC3164](#module_SyslogPro..RFC3164) +**Throws**: + +- Error A standard error object + +**Access**: public + +| Param | Type | Description | +| --- | --- | --- | +| [colors.emergencyColor] | string | A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended) | +| [colors.alertColor] | string | A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended) | +| [colors.criticalColor] | string | A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended) | +| [colors.errorColor] | string | A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended) | +| [colors.warningColor] | string | A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended) | +| [colors.noticeColor] | string | A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended) | +| [colors.informationalColor] | string | A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended) | +| [colors.debugColor] | string | A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended) | + + + +#### rfC3164.buildMessage(msg, [options]) ⇒ Promise +Building a formated message. Returns a promise with a formated message + +**Kind**: instance method of [RFC3164](#module_SyslogPro..RFC3164) +**Returns**: Promise - A Syslog formated string acording to the selected RFC +**Throws**: + +- Error A standard error object + +**Access**: public + +| Param | Type | Default | Description | +| --- | --- | --- | --- | +| msg | string | | The Syslog Message | +| [options] | object | | Options object | +| [options.severity] | number | 7 | An array of structure | +| [options.colorCode] | number | 36 | The ANSI color code to use if message coloration is selected | + + + +#### rfC3164.send(msg, [options]) ⇒ Promise +send a RFC5424 formated message. Returns a promise with the formated + message that was sent. If no server connection was defined when the + class was created a defualt Syslog connector will be used. + +**Kind**: instance method of [RFC3164](#module_SyslogPro..RFC3164) +**Returns**: Promise - A Syslog formated string acording to the selected RFC +**Throws**: + +- Error A standard error object + +**Access**: public +**See**: SyslogPro~Syslog + +| Param | Type | Default | Description | +| --- | --- | --- | --- | +| msg | string | | The unformated Syslog message to send | +| [options] | object | | Options object | +| [options.severity] | number | 7 | An array of structure | +| [options.colorCode] | number | 36 | The ANSI color code to use if | + + + +#### rfC3164.emergency(msg) ⇒ Promise +Send a syslog message with a secerity level of 0 (Emergency) + +**Kind**: instance method of [RFC3164](#module_SyslogPro..RFC3164) +**Returns**: Promise - - The formated syslog message sent to the Syslog server +**Throws**: + +- Error - Any bubbled up error + +**Access**: public + +| Param | Type | Description | +| --- | --- | --- | +| msg | string | The emergancy message to send to the Syslog server | + + + +#### rfC3164.emer(msg) ⇒ Promise +Send a syslog message with a secerity level of 0 (Emergency) + +**Kind**: instance method of [RFC3164](#module_SyslogPro..RFC3164) +**Returns**: Promise - - The formated syslog message sent to the Syslog server +**Throws**: + +- Error - Any bubbled up error + +**Access**: public + +| Param | Type | Description | +| --- | --- | --- | +| msg | string | The emergancy message to send to the Syslog server | + + + +#### rfC3164.alert(msg) ⇒ Promise +Send a syslog message with a secerity level of 1 (Alert) + +**Kind**: instance method of [RFC3164](#module_SyslogPro..RFC3164) +**Returns**: Promise - - The formated syslog message sent to the Syslog server +**Throws**: + +- Error - Any bubbled up error + +**Access**: public + +| Param | Type | Description | +| --- | --- | --- | +| msg | string | The alert message to send to the Syslog server | + + + +#### rfC3164.critical(msg) ⇒ Promise +Send a syslog message with a secerity level of 2 (Critical) + +**Kind**: instance method of [RFC3164](#module_SyslogPro..RFC3164) +**Returns**: Promise - - The formated syslog message sent to the Syslog server +**Throws**: + +- Error - Any bubbled up error + +**Access**: public + +| Param | Type | Description | +| --- | --- | --- | +| msg | string | The critical message to send to the Syslog server | + + + +#### rfC3164.crit(msg) ⇒ Promise +Send a syslog message with a secerity level of 2 (Critical) + +**Kind**: instance method of [RFC3164](#module_SyslogPro..RFC3164) +**Returns**: Promise - - The formated syslog message sent to the Syslog server +**Throws**: + +- Error - Any bubbled up error + +**Access**: public + +| Param | Type | Description | +| --- | --- | --- | +| msg | string | The critical message to send to the Syslog server | + + + +#### rfC3164.error(msg) ⇒ Promise +Send a syslog message with a secerity level of 3 (Error) + +**Kind**: instance method of [RFC3164](#module_SyslogPro..RFC3164) +**Returns**: Promise - - The formated syslog message sent to the Syslog server +**Throws**: + +- Error - Any bubbled up error + +**Access**: public + +| Param | Type | Description | +| --- | --- | --- | +| msg | string | The error message to send to the Syslog server | + + + +#### rfC3164.err(msg) ⇒ Promise +Send a syslog message with a secerity level of 3 (Error) + +**Kind**: instance method of [RFC3164](#module_SyslogPro..RFC3164) +**Returns**: Promise - - The formated syslog message sent to the Syslog server +**Throws**: + +- Error - Any bubbled up error + +**Access**: public + +| Param | Type | Description | +| --- | --- | --- | +| msg | string | The error message to send to the Syslog server | + + + +#### rfC3164.warning(msg) ⇒ Promise +Send a syslog message with a secerity level of 4 (Warning) + +**Kind**: instance method of [RFC3164](#module_SyslogPro..RFC3164) +**Returns**: Promise - - The formated syslog message sent to the Syslog server +**Throws**: + +- Error - Any bubbled up error + +**Access**: public + +| Param | Type | Description | +| --- | --- | --- | +| msg | string | The warning message to send to the Syslog server | + + + +#### rfC3164.warn(msg) ⇒ Promise +Send a syslog message with a secerity level of 4 (Warning) + +**Kind**: instance method of [RFC3164](#module_SyslogPro..RFC3164) +**Returns**: Promise - - The formated syslog message sent to the Syslog server +**Throws**: + +- Error - Any bubbled up error + +**Access**: public + +| Param | Type | Description | +| --- | --- | --- | +| msg | string | The warning message to send to the Syslog server | + + + +#### rfC3164.notice(msg) ⇒ Promise +Send a syslog message with a secerity level of 5 (Notice) + +**Kind**: instance method of [RFC3164](#module_SyslogPro..RFC3164) +**Returns**: Promise - - The formated syslog message sent to the Syslog server +**Throws**: + +- Error - Any bubbled up error + +**Access**: public + +| Param | Type | Description | +| --- | --- | --- | +| msg | string | The notice message to send to the Syslog server | + + + +#### rfC3164.note(msg) ⇒ Promise +Send a syslog message with a secerity level of 5 (Notice) + +**Kind**: instance method of [RFC3164](#module_SyslogPro..RFC3164) +**Returns**: Promise - - The formated syslog message sent to the Syslog server +**Throws**: + +- Error - Any bubbled up error + +**Access**: public + +| Param | Type | Description | +| --- | --- | --- | +| msg | string | The notice message to send to the Syslog server | + + + +#### rfC3164.informational(msg) ⇒ Promise +Send a syslog message with a secerity level of 6 (Informational) + +**Kind**: instance method of [RFC3164](#module_SyslogPro..RFC3164) +**Returns**: Promise - - The formated syslog message sent to the Syslog server +**Throws**: + +- Error - Any bubbled up error + +**Access**: public + +| Param | Type | Description | +| --- | --- | --- | +| msg | string | The informational message to send to the Syslog server | + + + +#### rfC3164.info(msg) ⇒ Promise +Send a syslog message with a secerity level of 6 (Informational) + +**Kind**: instance method of [RFC3164](#module_SyslogPro..RFC3164) +**Returns**: Promise - - The formated syslog message sent to the Syslog server +**Throws**: + +- Error - Any bubbled up error + +**Access**: public + +| Param | Type | Description | +| --- | --- | --- | +| msg | string | The informational message to send to the Syslog server | + + + +#### rfC3164.log(msg) ⇒ Promise +Send a syslog message with a secerity level of 6 (Informational) + +**Kind**: instance method of [RFC3164](#module_SyslogPro..RFC3164) +**Returns**: Promise - - The formated syslog message sent to the Syslog server +**Throws**: + +- Error - Any bubbled up error + +**Access**: public + +| Param | Type | Description | +| --- | --- | --- | +| msg | string | The informational message to send to the Syslog server | + + + +#### rfC3164.debug(msg) ⇒ Promise +Send a syslog message with a secerity level of 7 (Debug) + +**Kind**: instance method of [RFC3164](#module_SyslogPro..RFC3164) +**Returns**: Promise - - The formated syslog message sent to the Syslog server +**Throws**: + +- Error - Any bubbled up error + +**Access**: public + +| Param | Type | Description | +| --- | --- | --- | +| msg | string | The debug message to send to the Syslog server | + + + +### SyslogPro~RFC5424 +A class to work with RFC5424 formated syslog messages. The meesaging is fully configurabule and Ansi foreground +colors can be added. Both ANSI 8 and ANSI 256 color are fully suported. +Most APIs will return a promise. These APIs can be used using +`then(...)/catch(...)` + +A Syslog class with a configured +Syslog server target can also be used as the input into the formating +classes so that it may run independtly. + +The RFC5424 Syslog logging format is ment to be used as a stream of log data +from a service or applacation. This class is designed to be used in this +fashion where new messages are writen to the class as needed. + +**Kind**: inner class of [SyslogPro](#module_SyslogPro) +**Requires**: module:moment +**Since**: 0.0.0 +**Version**: 0.0.0 + +* [~RFC5424](#module_SyslogPro..RFC5424) + * [new RFC5424([options])](#new_module_SyslogPro..RFC5424_new) + * [.timestamp](#module_SyslogPro..RFC5424+timestamp) : boolean + * [.timestampUTC](#module_SyslogPro..RFC5424+timestampUTC) : boolean + * [.timestampTZ](#module_SyslogPro..RFC5424+timestampTZ) : boolean + * [.timestampMS](#module_SyslogPro..RFC5424+timestampMS) : boolean + * [.encludeStructuredData](#module_SyslogPro..RFC5424+encludeStructuredData) : boolean + * [.utf8BOM](#module_SyslogPro..RFC5424+utf8BOM) : boolean + * [.color](#module_SyslogPro..RFC5424+color) : boolean + * [.extendedColor](#module_SyslogPro..RFC5424+extendedColor) : boolean + * [.setColor()](#module_SyslogPro..RFC5424+setColor) + * [.buildMessage(msg, [options])](#module_SyslogPro..RFC5424+buildMessage) ⇒ Promise + * [.send(msg)](#module_SyslogPro..RFC5424+send) ⇒ Promise + * [.emergency(msg)](#module_SyslogPro..RFC5424+emergency) ⇒ Promise + * [.emer(msg)](#module_SyslogPro..RFC5424+emer) ⇒ Promise + * [.alert(msg)](#module_SyslogPro..RFC5424+alert) ⇒ Promise + * [.critical(msg)](#module_SyslogPro..RFC5424+critical) ⇒ Promise + * [.crit(msg)](#module_SyslogPro..RFC5424+crit) ⇒ Promise + * [.error(msg)](#module_SyslogPro..RFC5424+error) ⇒ Promise + * [.err(msg)](#module_SyslogPro..RFC5424+err) ⇒ Promise + * [.warning(msg)](#module_SyslogPro..RFC5424+warning) ⇒ Promise + * [.warn(msg)](#module_SyslogPro..RFC5424+warn) ⇒ Promise + * [.notice(msg)](#module_SyslogPro..RFC5424+notice) ⇒ Promise + * [.note(msg)](#module_SyslogPro..RFC5424+note) ⇒ Promise + * [.informational(msg)](#module_SyslogPro..RFC5424+informational) ⇒ Promise + * [.info(msg)](#module_SyslogPro..RFC5424+info) ⇒ Promise + * [.log(msg)](#module_SyslogPro..RFC5424+log) ⇒ Promise + * [.debug(msg)](#module_SyslogPro..RFC5424+debug) ⇒ Promise + + + +#### new RFC5424([options]) +Construct a new RFC5424 formated Syslog object with user options + + +| Param | Type | Default | Description | +| --- | --- | --- | --- | +| [options] | object | | Options object | +| [options.applacationName] | string | "'NodeJSLogger'" | Applacation | +| [options.hostname] | string | "os.hostname" | The name of this server | +| [options.timestamp] | boolean | false | Included a Timestamp | +| [options.timestampUTC] | boolean | false | RFC tandard is for local time | +| [options.timestampMS] | boolean | false | Timestamp with ms resoltuion | +| [options.timestampTZ] | boolean | true | Should the timestamp included timezone | +| [options.encludeStructuredData] | boolean | false | Included any provided structured data | +| [options.utf8BOM] | boolean | true | Included the UTF8 | +| [options.color] | boolean | false | Included the UTF8 | +| [options.extendedColor] | boolean | false | Included the UTF8 encoding tag with syslog message text | +| [options.colors] | object | | User defended colors for severites | +| [options.colors.emergencyColor] | string | | A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended) | +| [options.colors.alertColor] | string | | A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended) | +| [options.colors.criticalColor] | string | | A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended) | +| [options.colors.errorColor] | string | | A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended) | +| [options.colors.warningColor] | string | | A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended) | +| [options.colors.noticeColor] | string | | A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended) | +| [options.colors.informationalColor] | string | | A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended) | +| [options.colors.debugColor] | string | | A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended) | +| [options.server] | Syslog | false | A {@link module:SyslogPro~Syslog| Syslog server connection} that should be used to send messages directly from this class. @see SyslogPro~Syslog | + + + +#### rfC5424.timestamp : boolean +**Kind**: instance property of [RFC5424](#module_SyslogPro..RFC5424) + + +#### rfC5424.timestampUTC : boolean +**Kind**: instance property of [RFC5424](#module_SyslogPro..RFC5424) + + +#### rfC5424.timestampTZ : boolean +**Kind**: instance property of [RFC5424](#module_SyslogPro..RFC5424) + + +#### rfC5424.timestampMS : boolean +**Kind**: instance property of [RFC5424](#module_SyslogPro..RFC5424) + + +#### rfC5424.encludeStructuredData : boolean +**Kind**: instance property of [RFC5424](#module_SyslogPro..RFC5424) + + +#### rfC5424.utf8BOM : boolean +**Kind**: instance property of [RFC5424](#module_SyslogPro..RFC5424) + + +#### rfC5424.color : boolean +**Kind**: instance property of [RFC5424](#module_SyslogPro..RFC5424) + + +#### rfC5424.extendedColor : boolean +**Kind**: instance property of [RFC5424](#module_SyslogPro..RFC5424) + + +#### rfC5424.setColor() +Sets the color to be used for messages at a set priority + +**Kind**: instance method of [RFC5424](#module_SyslogPro..RFC5424) +**Throws**: + +- Error A standard error object + +**Access**: public + +| Param | Type | Description | +| --- | --- | --- | +| [colors.emergencyColor] | string | A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended) | +| [colors.alertColor] | string | A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended) | +| [colors.criticalColor] | string | A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended) | +| [colors.errorColor] | string | A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended) | +| [colors.warningColor] | string | A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended) | +| [colors.noticeColor] | string | A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended) | +| [colors.informationalColor] | string | A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended) | +| [colors.debugColor] | string | A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended) | + + + +#### rfC5424.buildMessage(msg, [options]) ⇒ Promise +Building a formated message. Returns a promise with a formated message + +**Kind**: instance method of [RFC5424](#module_SyslogPro..RFC5424) +**Returns**: Promise - A Syslog formated string acording to the selected RFC +**Throws**: + +- Error A standard error object + +**Access**: public + +| Param | Type | Default | Description | +| --- | --- | --- | --- | +| msg | string | | The Syslog Message | +| [options] | object | | Options object | +| [options.severity] | number | 7 | An array of structure | +| [options.facility] | number | 23 | Facility code to use sending this message | +| [options.pid] | string | "'-'" | The process id of the service sending this message | +| [options.structuredData] | Array.<string> | | An array of structure data strings conforming to the IETF/IANA defined SD-IDs or IANA registred SMI Network Management Private Enterprise Code SD-ID conforming to the format [name@ parameter=value] | +| [options.colorCode] | number | 36 | The ANSI color code to use if message coloration is selected | + + + +#### rfC5424.send(msg) ⇒ Promise +send a RFC5424 formated message. Returns a promise with the formated + message that was sent. If no server connection was defined when the + class was created a defualt Syslog connector will be used. + +**Kind**: instance method of [RFC5424](#module_SyslogPro..RFC5424) +**Returns**: Promise - A Syslog formated string acording to the selected RFC +**Throws**: + +- Error A standard error object + +**Access**: public +**See**: SyslogPro~Syslog + +| Param | Type | Description | +| --- | --- | --- | +| msg | string | The unformated Syslog message to send | + + + +#### rfC5424.emergency(msg) ⇒ Promise +Send a syslog message with a secerity level of 0 (Emergency) + +**Kind**: instance method of [RFC5424](#module_SyslogPro..RFC5424) +**Returns**: Promise - - The formated syslog message sent to the Syslog server +**Throws**: + +- Error - Any bubbled up error + +**Access**: public + +| Param | Type | Description | +| --- | --- | --- | +| msg | string | The emergancy message to send to the Syslog server | + + + +#### rfC5424.emer(msg) ⇒ Promise +Send a syslog message with a secerity level of 0 (Emergency) + +**Kind**: instance method of [RFC5424](#module_SyslogPro..RFC5424) +**Returns**: Promise - - The formated syslog message sent to the Syslog server +**Throws**: + +- Error - Any bubbled up error + +**Access**: public + +| Param | Type | Description | +| --- | --- | --- | +| msg | string | The emergancy message to send to the Syslog server | + + + +#### rfC5424.alert(msg) ⇒ Promise +Send a syslog message with a secerity level of 1 (Alert) + +**Kind**: instance method of [RFC5424](#module_SyslogPro..RFC5424) +**Returns**: Promise - - The formated syslog message sent to the Syslog server +**Throws**: + +- Error - Any bubbled up error + +**Access**: public + +| Param | Type | Description | +| --- | --- | --- | +| msg | string | The alert message to send to the Syslog server | + + + +#### rfC5424.critical(msg) ⇒ Promise +Send a syslog message with a secerity level of 2 (Critical) + +**Kind**: instance method of [RFC5424](#module_SyslogPro..RFC5424) +**Returns**: Promise - - The formated syslog message sent to the Syslog server +**Throws**: + +- Error - Any bubbled up error + +**Access**: public + +| Param | Type | Description | +| --- | --- | --- | +| msg | string | The critical message to send to the Syslog server | + + + +#### rfC5424.crit(msg) ⇒ Promise +Send a syslog message with a secerity level of 2 (Critical) + +**Kind**: instance method of [RFC5424](#module_SyslogPro..RFC5424) +**Returns**: Promise - - The formated syslog message sent to the Syslog server +**Throws**: + +- Error - Any bubbled up error + +**Access**: public + +| Param | Type | Description | +| --- | --- | --- | +| msg | string | The critical message to send to the Syslog server | + + + +#### rfC5424.error(msg) ⇒ Promise +Send a syslog message with a secerity level of 3 (Error) + +**Kind**: instance method of [RFC5424](#module_SyslogPro..RFC5424) +**Returns**: Promise - - The formated syslog message sent to the Syslog server +**Throws**: + +- Error - Any bubbled up error + +**Access**: public + +| Param | Type | Description | +| --- | --- | --- | +| msg | string | The error message to send to the Syslog server | + + + +#### rfC5424.err(msg) ⇒ Promise +Send a syslog message with a secerity level of 3 (Error) + +**Kind**: instance method of [RFC5424](#module_SyslogPro..RFC5424) +**Returns**: Promise - - The formated syslog message sent to the Syslog server +**Throws**: + +- Error - Any bubbled up error + +**Access**: public + +| Param | Type | Description | +| --- | --- | --- | +| msg | string | The error message to send to the Syslog server | + + + +#### rfC5424.warning(msg) ⇒ Promise +Send a syslog message with a secerity level of 4 (Warning) + +**Kind**: instance method of [RFC5424](#module_SyslogPro..RFC5424) +**Returns**: Promise - - The formated syslog message sent to the Syslog server +**Throws**: + +- Error - Any bubbled up error + +**Access**: public + +| Param | Type | Description | +| --- | --- | --- | +| msg | string | The warning message to send to the Syslog server | + + + +#### rfC5424.warn(msg) ⇒ Promise +Send a syslog message with a secerity level of 4 (Warning) + +**Kind**: instance method of [RFC5424](#module_SyslogPro..RFC5424) +**Returns**: Promise - - The formated syslog message sent to the Syslog server +**Throws**: + +- Error - Any bubbled up error + +**Access**: public + +| Param | Type | Description | +| --- | --- | --- | +| msg | string | The warning message to send to the Syslog server | + + + +#### rfC5424.notice(msg) ⇒ Promise +Send a syslog message with a secerity level of 5 (Notice) + +**Kind**: instance method of [RFC5424](#module_SyslogPro..RFC5424) +**Returns**: Promise - - The formated syslog message sent to the Syslog server +**Throws**: + +- Error - Any bubbled up error + +**Access**: public + +| Param | Type | Description | +| --- | --- | --- | +| msg | string | The notice message to send to the Syslog server | + + + +#### rfC5424.note(msg) ⇒ Promise +Send a syslog message with a secerity level of 5 (Notice) + +**Kind**: instance method of [RFC5424](#module_SyslogPro..RFC5424) +**Returns**: Promise - - The formated syslog message sent to the Syslog server +**Throws**: + +- Error - Any bubbled up error + +**Access**: public + +| Param | Type | Description | +| --- | --- | --- | +| msg | string | The notice message to send to the Syslog server | + + + +#### rfC5424.informational(msg) ⇒ Promise +Send a syslog message with a secerity level of 6 (Informational) + +**Kind**: instance method of [RFC5424](#module_SyslogPro..RFC5424) +**Returns**: Promise - - The formated syslog message sent to the Syslog server +**Throws**: + +- Error - Any bubbled up error + +**Access**: public + +| Param | Type | Description | +| --- | --- | --- | +| msg | string | The informational message to send to the Syslog server | + + + +#### rfC5424.info(msg) ⇒ Promise +Send a syslog message with a secerity level of 6 (Informational) + +**Kind**: instance method of [RFC5424](#module_SyslogPro..RFC5424) +**Returns**: Promise - - The formated syslog message sent to the Syslog server +**Throws**: + +- Error - Any bubbled up error + +**Access**: public + +| Param | Type | Description | +| --- | --- | --- | +| msg | string | The informational message to send to the Syslog server | + + + +#### rfC5424.log(msg) ⇒ Promise +Send a syslog message with a secerity level of 6 (Informational) + +**Kind**: instance method of [RFC5424](#module_SyslogPro..RFC5424) +**Returns**: Promise - - The formated syslog message sent to the Syslog server +**Throws**: + +- Error - Any bubbled up error + +**Access**: public + +| Param | Type | Description | +| --- | --- | --- | +| msg | string | The informational message to send to the Syslog server | + + + +#### rfC5424.debug(msg) ⇒ Promise +Send a syslog message with a secerity level of 7 (Debug) + +**Kind**: instance method of [RFC5424](#module_SyslogPro..RFC5424) +**Returns**: Promise - - The formated syslog message sent to the Syslog server +**Throws**: + +- Error - Any bubbled up error + +**Access**: public + +| Param | Type | Description | +| --- | --- | --- | +| msg | string | The debug message to send to the Syslog server | + + + +### 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. +Most APIs will return a promise. These APIs can be used using +`then(...)/catch(...)` + +A Syslog class with a configured Syslog server target can also be used as +the input into the formating classes so that it may run independtly. The +LEEF format is designed to send event data to a SIEM system and should not +be as a logging stream. This class is ment to be used once per message. + +**Kind**: inner class of [SyslogPro](#module_SyslogPro) +**Requires**: module:moment +**Since**: 0.0.0 +**Version**: 0.0.0 + +* [~LEEF](#module_SyslogPro..LEEF) + * [new LEEF([options])](#new_module_SyslogPro..LEEF_new) + * [.vendor](#module_SyslogPro..LEEF+vendor) : string + * [.product](#module_SyslogPro..LEEF+product) : string + * [.version](#module_SyslogPro..LEEF+version) : string + * [.eventId](#module_SyslogPro..LEEF+eventId) : string + * [.syslogHeader](#module_SyslogPro..LEEF+syslogHeader) : boolean + * [.attrabutes](#module_SyslogPro..LEEF+attrabutes) : object + * [.buildMessage()](#module_SyslogPro..LEEF+buildMessage) ⇒ Promise + * [.send([options])](#module_SyslogPro..LEEF+send) + + + +#### new LEEF([options]) +Construct a new LEEF formating object with user options + + +| Param | Type | Default | Description | +| --- | --- | --- | --- | +| [options] | object | | Options object | +| [options.vendor] | string | "'unknown'" | The vendor of the system that genrated the event being reported | +| [options.product] | string | "'unknown'" | The product name of the system that genrated the event being reported | +| [options.version] | string | "'unknown'" | The version name of the system that genrated the event being reported | +| [options.eventId] | string | "'unknown'" | The eventId of the system that genrated the event being reported | +| [options.attrabute] | object | | LEEF message attrabutes which defualts to all base attrabutes with null values, new attrabutes should be added as new elements to this object | +| [options.syslogHeader] | boolean | 'true' | Should the LEEF message include a Syslog header with Timestamp and source | +| [options.server] | Syslog | false | A {@link module:SyslogPro~Syslog| Syslog server connection} that should be used to send messages directly from this class. @see SyslogPro~Syslog | + + + +#### leeF.vendor : string +**Kind**: instance property of [LEEF](#module_SyslogPro..LEEF) + + +#### leeF.product : string +**Kind**: instance property of [LEEF](#module_SyslogPro..LEEF) + + +#### leeF.version : string +**Kind**: instance property of [LEEF](#module_SyslogPro..LEEF) + + +#### leeF.eventId : string +**Kind**: instance property of [LEEF](#module_SyslogPro..LEEF) + + +#### leeF.syslogHeader : boolean +**Kind**: instance property of [LEEF](#module_SyslogPro..LEEF) + + +#### leeF.attrabutes : object +**Kind**: instance property of [LEEF](#module_SyslogPro..LEEF) + + +#### leeF.buildMessage() ⇒ Promise +Build a formated message + +**Kind**: instance method of [LEEF](#module_SyslogPro..LEEF) +**Returns**: Promise - - string with formated message +**Access**: public + + +#### leeF.send([options]) +**Kind**: instance method of [LEEF](#module_SyslogPro..LEEF) +**Access**: public + +| Param | Type | Default | Description | +| --- | --- | --- | --- | +| [options] | Syslog | false | A {@link module:SyslogPro~Syslog| Syslog server connection} that should be used to send messages directly from this class. @see SyslogPro~Syslog | + + + +### SyslogPro~CEF +A class to work with HP CEF (Common Event 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 CEF +formated mesage produced by this module can be saved externaly to it) or +sent via Syslog. +Most APIs will return a promise. These APIs can be used using +`then(...)/catch(...)` + +A Syslog class with a configured Syslog server target can also be used as +the input into the formating classes so that it may run independtly. The CEF +format is designed to send event data to a SIEM system and should not be as +a logging stream. This class is ment to be used once per message. + +**Kind**: inner class of [SyslogPro](#module_SyslogPro) +**Requires**: module:moment +**Since**: 0.0.0 +**Version**: 0.0.0 + +* [~CEF](#module_SyslogPro..CEF) + * [new CEF([options])](#new_module_SyslogPro..CEF_new) + * [.deviceVendor](#module_SyslogPro..CEF+deviceVendor) : string + * [.deviceProduct](#module_SyslogPro..CEF+deviceProduct) : string + * [.deviceVersion](#module_SyslogPro..CEF+deviceVersion) : string + * [.deviceEventClassId](#module_SyslogPro..CEF+deviceEventClassId) : string + * [.name](#module_SyslogPro..CEF+name) : string + * [.severity](#module_SyslogPro..CEF+severity) : string + * [.extensions](#module_SyslogPro..CEF+extensions) : object + * [.validate()](#module_SyslogPro..CEF+validate) ⇒ Promise + * [.buildMessage()](#module_SyslogPro..CEF+buildMessage) ⇒ Promise + * [.send([options])](#module_SyslogPro..CEF+send) + + + +#### new CEF([options]) +Construct a new CEF formating object with user options + + +| Param | Type | Default | Description | +| --- | --- | --- | --- | +| [options] | object | | Options object | +| [options.deviceVendor] | string | "'unknown'" | The vendor of the system that genrated the event being reported | +| [options.deviceProduct] | string | "'unknown'" | The product name of the system that genrated the event being reported | +| [options.deviceVersion] | string | "'unknown'" | The version name of the system that genrated the event being reported | +| [options.deviceEventClassId] | string | "'unknown'" | The eventId of the system that genrated the event being reported | +| [options.name] | string | "'unknown'" | Name of the service genrating the notice | +| [options.severity] | string | "'unknown'" | Severity of the notification | +| [options.extensions] | string | "{}" | Any CEF Key=Value extentions | +| [options.server] | Syslog | false | A {@link module:SyslogPro~Syslog| Syslog server connection} that should be used to send messages directly from this class. @see SyslogPro~Syslog | + + + +#### ceF.deviceVendor : string +**Kind**: instance property of [CEF](#module_SyslogPro..CEF) + + +#### ceF.deviceProduct : string +**Kind**: instance property of [CEF](#module_SyslogPro..CEF) + + +#### ceF.deviceVersion : string +**Kind**: instance property of [CEF](#module_SyslogPro..CEF) + + +#### ceF.deviceEventClassId : string +**Kind**: instance property of [CEF](#module_SyslogPro..CEF) + + +#### ceF.name : string +**Kind**: instance property of [CEF](#module_SyslogPro..CEF) + + +#### ceF.severity : string +**Kind**: instance property of [CEF](#module_SyslogPro..CEF) + + +#### ceF.extensions : object +**Kind**: instance property of [CEF](#module_SyslogPro..CEF) + + +#### ceF.validate() ⇒ Promise +Validate this CEF object + +**Kind**: instance method of [CEF](#module_SyslogPro..CEF) +**Returns**: Promise - - True if valadated +**Throws**: + +- Error - First element to fail valadation + +**Access**: public + + +#### ceF.buildMessage() ⇒ Promise +Build a CEF formated string + +**Kind**: instance method of [CEF](#module_SyslogPro..CEF) +**Returns**: Promise - - String with formated message +**Access**: public + + +#### ceF.send([options]) +**Kind**: instance method of [CEF](#module_SyslogPro..CEF) +**Access**: public + +| Param | Type | Default | Description | +| --- | --- | --- | --- | +| [options] | Syslog | false | A {@link module:SyslogPro~Syslog| Syslog server connection} that should be used to send messages directly from this class. @see SyslogPro~Syslog | + + +*docs autogenerated via [jsdoc2md] +(https://github.com/jsdoc2md/jsdoc-to-markdown)* + +## Test +```shell + npm test +``` + +## Contributing + +Please try to maintain the existing coding style. Add unit tests for any new or +changed functionality. Lint and test your code. diff --git a/docs/docco/README.md b/docs/docco/README.md new file mode 100644 index 0000000..2b4032a --- /dev/null +++ b/docs/docco/README.md @@ -0,0 +1,2699 @@ + + + + + + + + +``` +/** Copyright (c) 2018 Craig Yamato */ + +/** + * @fileoverview The SyslogPro module for sending syslog messages + * Most APIs will return a promise. These APIs can be used using + * `then(...)/catch(...)` + * + * Syslog formating classes can be used as input into a Syslog class to be used + * simultatniusly to the same Syslog server. The Syslog Class with a configured + * Syslog server target can also be used as the input into each of the formating + * classes so that they may run independtly. + * @author Craig Yamato + * @copyright (c) 2018 - Craig Yamato + * @version 0.1.0 + * @exports Syslog + * @exports LEEF + * @exports CEF + * @module SyslogPro + */ +"use strict"; +const moment = require('moment'); +const os = require("os"); +const dns = require('dns'); +let dnsPromises = dns.promises; +const fs = require("fs"); + +/** + * Format the ANSI foreground color code from a RGB hex code or ANSI color code + * @private + * @param {string} hex - The color hex code in the form of #FFFFFF or Number of + * the ANSI color code (30-37 Standard & 0-255 Extended) + * @returns {Promise} - The formated ANSI color code + * @throws {Error} - A Format Error + */ +function rgbToAnsi (hex, extendedColor) { + return new Promise((resolve, reject) => { + let colorCode = 0; // Var to hold color code + +``` + + + + + + + +Break HEX Code up into RGB + + + + +``` + const hexParts = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(hex); + if (hexParts || typeof hex === 'number') { + if (typeof hex === 'number') { + if (extendedColor && hex < 256) { + resolve(hex); + } else if ((hex > 29 && hex < 38) || (hex > 89 && hex < 98)) { + resolve(hex); + } else { + reject (new Error('FORMAT ERROR: Color code not in range')); + } + } else { + const r = parseInt(hexParts[1], 16); + const g = parseInt(hexParts[2], 16); + const b = parseInt(hexParts[3], 16); + if (extendedColor) { + if (r === g && g === b) { + +``` + + + + + + + +Gray Scale Color + + + + +``` + if (r < 8) { + colorCode = 16; + } else if (r > 248) { + colorCode = 231; + } else { + colorCode = Math.round(((r - 8) / 247) * 24) + 232; + } + } else { + colorCode = 16 + + (36 * Math.round(r / 255 * 5)) + + (6 * Math.round(g / 255 * 5)) + + Math.round(b / 255 * 5); + } + } else { + colorCode = 30; + const red = r / 255; + const green = g / 255; + const blue = b / 255; + let v = Math.max(red, green, blue) * 100; + v = Math.round(v / 50); + if (v === 1) { + colorCode += ((Math.round(b / 255) << 2) + | (Math.round(g / 255) << 1) + | Math.round(r / 255)); + } + if (v === 2) { + colorCode += 60; + } + } + } + resolve(colorCode); + return; + } else { + reject(new Error('TYPE ERROR: Not in RGB color hex or color code')); + return; + } + }); +} + +/** + * A class to work with syslog messages using UDP, TCP, or TLS transport. + * There is suport for Syslog message formating RFC-3164, RFC-5424 including + * Structured Data, IBM LEEF (Log Event Extended Format), and HP CEF (Common + * Event Format). + * Syslog formating classes can be used as input into a Syslog class to be used + * simultatniusly to the same Syslog server. * + * @requires moment + * @version 0.0.0 + * @since 0.0.0 + */ +class Syslog { + /** + * Construct a new Syslog transport object with user options + * @public + * @version 0.0.0 + * @since 0.0.0 + * @this Syslog + * @param {object} [options] - Options object + * >>>Transport Configuraton + * @param {string} [options.target='localhost'] - The IP Address|FQDN of the + * Syslog Server, this option if set will take prasdents over any target + * set in a formating object + * @param {string} [options.protocol='udp'] - L4 transport portocol + * (udp|tcp|tls), this option if set will take prasdents over any transport + * set in a formating object + * @param {number} [options.port=514] - IP port, this option if set will take + * prasdents over any IP Port set in a formating object + * @param {number} [options.tcpTimeout=10000] - Ignored for all other + * transports, this option if set will take prasdents over any timeout + * set in a formating object + * @param {string[]} [options.tlsServerCerts] - Array of authrized TLS server + * certificates file locations, this option if set will take prasdents + * over any certificates set in a formating object + * @param {string} [options.tlsClientCert] - Client TLS certificate file + * location that this client should use, this option if set will take + * prasdents over any certificates set in a formating object + * @param {string} [options.tlsClientKey] - Client TLS key file + * location that this client should use, this option if set will take + * prasdents over any certificates set in a formating object + * >>>Syslog Format Settings + * @param {string} [options.format='none'] - Valid syslog format options for + * this module are 'none', 'rfc3164', 'rfc5424', 'leef', 'cef' + * @param {RFC3164} [options.rfc5424] - {@link module:SyslogPro~RFC5424| + * RFC5424 related settings} + * @param {RFC5424} [options.rfc5424] - {@link module:SyslogPro~RFC5424| + * RFC5424 related settings} + * @param {LEEF} [options.leef] - {@link module:SyslogPro~LEEF|IBM LEEF + * (Log Event Extended Format) object} + * @param {CEF} [options.cef] - {@link module:SyslogPro~CEF|HP CEF + * (Common Event Format) formating object} + */ + constructor (options) { + this.constructor__ = true; + if (!options) { + options = {}; + } + +``` + + + + + + + +Basic transport setup + + + + +``` + /** @type {string} */ + this.target = options.target || 'localhost'; + /** @type {string} */ + this.protocol = options.protocol || 'udp'; + this.protocol = this.protocol.toLowerCase(); + /** @type {number} */ + this.port = options.port || 514; + /** @type {number} */ + this.tcpTimeout = options.tcpTimeout || 10000; + if ((typeof options.tlsServerCerts === 'object' + && Array.isArray(options.tlsServerCerts)) + || typeof options.tlsServerCerts === 'string') { + this.addTlsServerCerts(options.tlsServerCerts); + } else { + /** @type {string[]} */ + this.tlsServerCerts = []; + } + if (options.tlsClientCert) { + /** @type {string} */ + this.tlsClientCert = options.tlsClientCert; + } + if (options.tlsClientKey) { + /** @type {string} */ + this.tlsClientKey = options.tlsClientKey; + } + +``` + + + + + + + +Syslog Format + + + + +``` + if (typeof options.format === 'string') { + /** @type {string} */ + this.format = options.format.toLowerCase(); + } else { + this.format = options.format || 'none'; + } + if (options.rfc3164) { + if (options.rfc3164.constructor__) { + /** @type {RFC3164} */ + this.rfc3164 = options.rfc3164; + } else { + this.rfc3164 = new RFC3164(options); + } + } + if (options.rfc5424) { + if (options.rfc5424.constructor__) { + /** @type {RFC5424} */ + this.rfc5424 = options.rfc5424; + } else { + this.rfc5424 = new RFC5424(options); + } + } + if (options.leef) { + if (options.leef.constructor__) { + /** @type {LEEF} */ + this.leef = options.leef; + } else { + this.leef = new LEEF(options); + } + } + if (options.cef) { + if (options.cef.constructor__) { + /** @type {CEF} */ + this.cef = options.cef; + } else { + this.cef = new CEF(options); + } + } + if (this.format === 'rfc3164' && !this.rfc3164) { + this.rfc3164 = new RFC3164(); + } + if (this.format === 'rfc5424' && !this.rfc5424) { + this.rfc5424 = new RFC5424(); + } + if (this.format === 'leef' && !this.leef) { + this.leef = new LEEF(); + } + if (this.format === 'cef' && !this.cef) { + this.cef = new CEF(); + } + } + + /** + * Add a TLS server certificate which can be used to authentacat the server + * this syslog client is connecting too. This function will valadate the + * input as a file location straing and add it to an array of certificates + * @private + * @version 0.0.0 + * @since 0.0.0 + * @param {string|string[]} certs - File location of the certificate(s) + * @returns {Promise} - True + * @throws {Error} - A Type Error + */ + addTlsServerCerts (certs) { + return new Promise((resolve, reject) => { + if (typeof certs === 'object' && Array.isArray(certs)) { + /** @private @type {string[]} */ + this.tlsServerCerts = certs; + } else if (typeof certs === 'string') { + this.tlsServerCerts = [certs]; + } else { + let errMsg = 'TYPE ERROR: Server Cert file loctions shoudl be a string'; + errMsg += ' or array of strings'; + reject(new Error(errMsg)); + } + resolve(true); + }); + } + /** + * Send the Syslog message over UDP + * @private + * @param {string} msg - The formated Syslog Message + * @returns {Promise} - The Syslog formated string sent + * @throws {Error} - Network Error + */ + udpMessage (msg) { + return new Promise((resolve, reject) => { + const dgram = require('dgram');// Test for target DNS and Address Family (IPv4/6) by looking up the DNS + const dnsOptions = { + verbatim: true + }; + dnsPromises.lookup(this.target, dnsOptions) + .then((result) => { + const udpType = result.family === 4 ? 'udp4' : 'udp6'; + let client = dgram.createSocket(udpType); + +``` + + + + + + + +Turn msg in to a UTF8 buffer + + + + +``` + let msgBuffer = Buffer.from(msg, 'utf8'); + client.send(msgBuffer, this.port, this.target, (error) => { + client.close(); + resolve(msg); + }); + }) + .catch((error) => { + reject(error); // Reject out of the sendMessage function promise + }); + }); + } + /** + * Send the Syslog message over TCP + * @private + * @param {string} msg - The formated Syslog Message + * @returns {Promise} - The Syslog formated string sent + * @throws {Error} - Timeout error for TCP and TLS connections + * @throws {Error} - Network Error + */ + tcpMessage (msg) { + return new Promise((resolve, reject) => { + const net = require('net'); + const dnsOptions = { + verbatim: true + }; + dnsPromises.lookup(this.target, dnsOptions) + .then((result) => { + const tcpOptions = { + host: this.target, + port: this.port, + family: result.family + }; + const client = net.createConnection(tcpOptions, () => { + +``` + + + + + + + +Turn msg in to a UTF8 buffer + + + + +``` + let msgBuffer = Buffer.from(msg, 'utf8'); + client.write(msgBuffer, () => { + client.end(); + }); + }); + client.setTimeout(this.tcpTimeout); + client.on('end', () => { + resolve(msg); + }); + client.on('timeout', () => { + client.end(); + reject(new Error('TIMEOUT ERROR: Syslog server TCP timeout')); + }); + client.on('error', (error) => { + client.destroy(); + reject(error); + }); + }) + .catch((error) => { + reject(error); + }); + }); + } + /** + * Send the Syslog message over TLS + * @private + * @param {string} msg - The formated Syslog Message + * @returns {Promise} - The Syslog formated string sent + * @throws {Error} - Timeout error for TCP and TLS connections + * @throws {Error} - Network Error + */ + tlsMessage (msg) { + return new Promise((resolve, reject) => { + const tls = require('tls'); + const tlsOptions = { + host: this.target, + port: this.port, + }; + +``` + + + + + + + +Load client cert and key if requested + + + + +``` + if (typeof this.tlsClientKey === 'string' + && typeof this.tlsClientCert === 'string') { + tlsOptions.key = fs.readFileSync(this.tlsClientKey); + tlsOptions.cert = fs.readFileSync(this.tlsClientCert); + } else if (typeof this.tlsClientKey !== 'string' + && typeof this.tlsClientKey !== 'undefined') { + let errMsg = 'TYPE ERROR: TLS Client Key is not a file'; + errMsg += 'location string'; + reject(new Error(errMsg)); + return; + } else if (typeof this.tlsClientCert !== 'string' + && typeof this.tlsClientCert !== 'undefined') { + let errMsg = 'TYPE ERROR: TLS Client Cert is not a file'; + errMsg += 'location string'; + reject(new Error(errMsg)); + return; + } + +``` + + + + + + + +Load any server certs if provided + + + + +``` + let tlsCerts = this.tlsServerCerts.length; + if (tlsCerts > 0) { + let tlsOptionsCerts = []; + for (let certIndex=0; certIndex { + +``` + + + + + + + +Turn msg in to a UTF8 buffer + + + + +``` + let msgBuffer = Buffer.from(msg, 'utf8'); + client.write(msgBuffer, () => { + client.end(); + }); + }); + client.setTimeout(this.tcpTimeout); + +``` + + + + + + + +client.on('data', (data) => {}); + + + + +``` + client.on('end', () => { + resolve(msg); + }); + client.on('timeout', () => { + client.end(); + reject(new Error('TIMEOUT ERROR: Syslog server TLS timeout')); + }); + client.on('error', (error) => { + client.destroy(); + reject(error); + }); + }); + } + /** + * Send the Syslog message to the selected target Syslog server using the + * selected transport. + * @private + * @param {string} msg - The formated Syslog Message + * @returns {Promise} - The Syslog formated string sent + * @throws {Error} - Timeout error for TCP and TLS connections + * @throws {Error} - Network Error + */ + send (msg) { + return new Promise((resolve, reject) => { + if (typeof msg !== 'string') { + reject(new Error("TYPE ERROR: Syslog message must be a string")); + return; + } + this.protocol = this.protocol.toLowerCase(); + if (this.protocol === 'udp') { + this.udpMessage(msg) + .then((result) => { + resolve(result); + }) + .catch((reson) => { + reject(reson); + }); + } else if (this.protocol === 'tcp') { + this.tcpMessage(msg) + .then((result) => { + resolve(result); + }) + .catch((reson) => { + reject(reson); + }); + } else if (this.protocol === 'tls') { + this.tlsMessage(msg) + .then((result) => { + resolve(result); + }) + .catch((reson) => { + reject(reson); + }); + } else { + let errorMsg = 'FORMAT ERROR: Protocol not reconized, should be '; + errorMsg += 'udp|tcp|tls'; + reject(new Error(errorMsg)); + } + }); + } +} + +/** + * A class to work with RFC3164 formated syslog messages. The meesaging is fully configurabule and Ansi foreground + * colors can be added. Both ANSI 8 and ANSI 256 color are fully suported. + * Most APIs will return a promise. These APIs can be used using + * `then(...)/catch(...)` + * + * A Syslog class with a configured + * Syslog server target can also be used as the input into the formating + * classes so that it may run independtly. + * + * The RFC3164 Syslog logging format is ment to be used as a stream of log data + * from a service or applacation. This class is designed to be used in this + * fashion where new messages are writen to the class as needed. + * @requires moment + * @version 0.0.0 + * @since 0.0.0 + */ +class RFC3164 { + /** + * Construct a new RFC3164 formated Syslog object with user options + * @public + * @this RFC3164 + * @param {object} [options] - Options object + * @param {string} [options.applacationName='NodeJSLogger'] - Applacation + * @param {string} [options.hostname=os.hostname] - The name of this server + * @param {number} [options.facility=23] - Facility code to use sending this + * message + * @param {boolean} [options.color=false] - Apply color coding encoding tag + * with syslog message text + * @param {boolean} [options.extendedColor=false] - Use the extedned ANSI + * color set encoding tag with syslog message text + * @param {object} [options.colors] - User defended colors for + * severites + * @param {string} [options.colors.emergencyColor] - A RGB Hex coded color in the form + * of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 + * Extended) + * @param {string} [options.colors.alertColor] - A RGB Hex coded color in the form + * of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 + * Extended) + * @param {string} [options.colors.criticalColor] - A RGB Hex coded color in the form + * of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 + * Extended) + * @param {string} [options.colors.errorColor] - A RGB Hex coded color in the form + * of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 + * Extended) + * @param {string} [options.colors.warningColor] - A RGB Hex coded color in the form + * of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 + * Extended) + * @param {string} [options.colors.noticeColor] - A RGB Hex coded color in the form + * of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 + * Extended) + * @param {string} [options.colors.informationalColor] - A RGB Hex coded color in the form + * of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 + * Extended) + * @param {string} [options.colors.debugColor] - A RGB Hex coded color in the form + * of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 + * Extended) + * @param {Syslog} [options.server=false] - A {@link module:SyslogPro~Syslog| + * Syslog server connection} that should be used to send messages directly + * from this class. @see SyslogPro~Syslog + */ + constructor (options) { + /** @private @type {boolean} */ + this.constructor__ = true; + options = options || {}; + this.hostname = options.hostname || os.hostname(); + this.applacationName = options.applacationName || ''; + this.facility = options.facility || 23; + if (options.color) { + /** @type {boolean} */ + this.color = true; + } else { + this.color = false; + } + if (options.extendedColor) { + /** @type {boolean} */ + this.extendedColor = true; + } else { + this.extendedColor = false; + } + if (options.server) { + if (!options.server.constructor__) { + /** @private @type {Syslog} */ + this.server = new Syslog(options.server); + } else { + this.server = options.server; + } + } + if (this.extendedColor) { + /** @private @type {number} */ + this.emergencyColor = 1; // Red foreground color + /** @private @type {number} */ + this.alertColor = 202; // Dark Orange foreground color + /** @private @type {number} */ + this.criticalColor = 208; // Orange foreground color + /** @private @type {number} */ + this.errorColor = 178; // Light Orange foreground color + /** @private @type {number} */ + this.warningColor = 226; // Yellow foreground color + /** @private @type {number} */ + this.noticeColor = 117; // Light Blue foreground color + /** @private @type {number} */ + this.informationalColor = 45; // Blue foreground color + /** @private @type {number} */ + this.debugColor = 27; // Dark Blue foreground color + } else { + this.emergencyColor = 31; // Red foreground color + this.alertColor = 31; // Red foreground color + this.criticalColor = 31; // Red foreground color + this.errorColor = 33; // Yellow foreground color + this.warningColor = 33; // Yellow foreground color + this.noticeColor = 36; // Blue foreground color + this.informationalColor = 36; // Blue foreground color + this.debugColor = 34; // Dark Blue foreground color + } + if (typeof options.colors === 'object') { + this.setColor(options.colors, this.extendedColor); + } + } + /** + * Sets the color to be used for messages at a set priority + * @public + * @param {string} [colors.emergencyColor] - A RGB Hex coded color in the form + * of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 + * Extended) + * @param {string} [colors.alertColor] - A RGB Hex coded color in the form + * of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 + * Extended) + * @param {string} [colors.criticalColor] - A RGB Hex coded color in the form + * of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 + * Extended) + * @param {string} [colors.errorColor] - A RGB Hex coded color in the form + * of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 + * Extended) + * @param {string} [colors.warningColor] - A RGB Hex coded color in the form + * of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 + * Extended) + * @param {string} [colors.noticeColor] - A RGB Hex coded color in the form + * of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 + * Extended) + * @param {string} [colors.informationalColor] - A RGB Hex coded color in the form + * of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 + * Extended) + * @param {string} [colors.debugColor] - A RGB Hex coded color in the form + * of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 + * Extended) + * @throws {Error} A standard error object + */ + setColor (colors, extendedColor) { + return new Promise((resolve, reject) => { + let colorPromises = []; + if (colors.emergencyColor) { + colorPromises.push( + new Promise((resolve,reject) => { + rgbToAnsi(colors.emergencyColor, this.extendedColor) + .then((result) => { + this.emergencyColor = result; + resolve(true); + }) + .catch((reson) => { + reson.message = 'TYPE ERROR: '; + reson.message += 'emergencyColor'; + reson.message += ' Not in RGB color hex or color code'; + reject(reson); + }); + })); + } + if (colors.alertColor) { + colorPromises.push( + new Promise((resolve,reject) => { + rgbToAnsi(colors.alertColor, this.extendedColor) + .then((result) => { + this.alertColor = result; + resolve(true); + }) + .catch((reson) => { + reson.message = 'TYPE ERROR: '; + reson.message += 'alertColor'; + reson.message += ' Not in RGB color hex or color code'; + reject(reson); + }); + })); + } + if (colors.criticalColor) { + colorPromises.push( + new Promise((resolve,reject) => { + rgbToAnsi(colors.criticalColor, this.extendedColor) + .then((result) => { + this.criticalColor = result; + resolve(true); + }) + .catch((reson) => { + reson.message = 'TYPE ERROR: '; + reson.message += 'criticalColor'; + reson.message += ' Not in RGB color hex or color code'; + reject(reson); + }); + })); + } + if (colors.errorColor) { + colorPromises.push( + new Promise((resolve,reject) => { + rgbToAnsi(colors.errorColor, this.extendedColor) + .then((result) => { + this.errorColor = result; + resolve(true); + }) + .catch((reson) => { + reson.message = 'TYPE ERROR: '; + reson.message += 'errorColor'; + reson.message += ' Not in RGB color hex or color code'; + reject(reson); + }); + })); + } + if (colors.warningColor) { + colorPromises.push( + new Promise((resolve,reject) => { + rgbToAnsi(colors.warningColor, this.extendedColor) + .then((result) => { + this.warningColor = result; + resolve(true); + }) + .catch((reson) => { + reson.message = 'TYPE ERROR: '; + reson.message += 'warningColor'; + reson.message += ' Not in RGB color hex or color code'; + reject(reson); + }); + })); + } + if (colors.noticeColor) { + colorPromises.push( + new Promise((resolve,reject) => { + rgbToAnsi(colors.noticeColor, this.extendedColor) + .then((result) => { + this.noticeColor = result; + resolve(true); + }) + .catch((reson) => { + reson.message = 'TYPE ERROR: '; + reson.message += 'noticeColor'; + reson.message += ' Not in RGB color hex or color code'; + reject(reson); + }); + })); + } + if (colors.informationalColor) { + colorPromises.push( + new Promise((resolve,reject) => { + rgbToAnsi(colors.informationalColor, this.extendedColor) + .then((result) => { + this.informationalColor = result; + resolve(true); + }) + .catch((reson) => { + reson.message = 'TYPE ERROR: '; + reson.message += 'informationalColor'; + reson.message += ' Not in RGB color hex or color code'; + reject(reson); + }); + })); + } + if (colors.debugColor) { + colorPromises.push( + new Promise((resolve,reject) => { + rgbToAnsi(colors.debugColor, this.extendedColor) + .then((result) => { + this.debugColor = result; + resolve(true); + }) + .catch((reson) => { + reson.message = 'TYPE ERROR: '; + reson.message += 'debugColor'; + reson.message += ' Not in RGB color hex or color code'; + reject(reson); + }); + })); + } + Promise.all(colorPromises) + .then((results) => { + resolve(true); + }) + .catch((reson) => { + reject(reson); + }); + }); + } + /** + * Building a formated message. Returns a promise with a formated message + * @public + * @param {string} msg - The Syslog Message + * @param {object} [options] - Options object + * @param {number} [options.severity=7] - An array of structure + * @param {number} [options.colorCode=36] - The ANSI color code to use if + * message coloration is selected + * @returns {Promise} A Syslog formated string acording to the selected RFC + * @throws {Error} A standard error object + */ + buildMessage (msg, options) { + return new Promise((resolve, reject) => { + options = options || {}; + let severity = typeof options.severity === 'number' ? + options.severity : 6; + if (typeof msg !== 'string' || options.msgSeverity > 7) { + let errMsg = 'FORMAT ERROR: Syslog message must be a string'; + errMsg += ' msgSeverity must be a number between 0 and 7'; + reject(new Error(errMsg)); + return; + } + let fmtMsg = ''; // Formated Syslog message string var + const newLine = '\n'; + const newLineRegEx = /(\r|\n|(\r\n))/; + const escapeCode = '\u001B'; + const resetColor = '\u001B[0m'; + +``` + + + + + + + +The PRI is common to both RFC formats + + + + +``` + const pri = (this.facility * 8) + severity; + +``` + + + + + + + +Remove any newline character + + + + +``` + msg = msg.replace(newLineRegEx, ''); + +``` + + + + + + + +Add requested color + + + + +``` + if (this.color) { + options.msgColor = options.msgColor || 36; + let colorCode = '['; + if (this.extendedColor) { + colorCode += '38;5;'; // Extended 256 Colors ANSI Code + } + if (typeof options.msgColor === 'number') { + colorCode += options.msgColor; + colorCode += 'm'; // ANSI Color Closer + } else { + colorCode = '[39m'; // Use terminal's defualt color + } + msg = escapeCode + colorCode + msg + resetColor; + } + +``` + + + + + + + +RegEx to find a leading 0 in the day of a DateTime for RFC3164 +RFC3164 uses BSD timeformat + + + + +``` + const rfc3164DateRegEx = /((A|D|F|J|M|N|O|S)(a|c|e|p|o|u)(b|c|g|l|n|p|r|t|v|y)\s)0(\d\s\d\d:\d\d:\d\d)/; + const timestamp = moment() + .format('MMM DD hh:mm:ss') + .replace(rfc3164DateRegEx, '$1 $5'); + +``` + + + + + + + +Build message + + + + +``` + fmtMsg = '<' + pri + '>'; + fmtMsg += timestamp; + fmtMsg += ' ' + this.hostname; + fmtMsg += ' ' + this.applacationName; + fmtMsg += ' ' + msg; + fmtMsg += newLine; + resolve(fmtMsg); + }); + } + /** + * send a RFC5424 formated message. Returns a promise with the formated + * message that was sent. If no server connection was defined when the + * class was created a defualt Syslog connector will be used. + * @see SyslogPro~Syslog + * @public + * @param {string} msg - The unformated Syslog message to send + * @param {object} [options] - Options object + * @param {number} [options.severity=7] - An array of structure + * @param {number} [options.colorCode=36] - The ANSI color code to use if + * @returns {Promise} A Syslog formated string acording to the selected RFC + * @throws {Error} A standard error object + */ + send (msg, options) { + return new Promise((resolve, reject) => { + if (!this.server) { + this.server = new Syslog(); + } + this.buildMessage(msg, options) + .then((result) => { + this.server.send(result) + .then((sendResult) => { + resolve(sendResult); + }) + .catch((error) => { + reject(error); + }); + }) + .catch((error) => { + reject(error); + }); + }); + } + /** + * Send a syslog message with a secerity level of 0 (Emergency) + * @public + * @param {string} msg - The emergancy message to send to the Syslog server + * @returns {Promise} - The formated syslog message sent to the Syslog server + * @throws {Error} - Any bubbled up error + */ + emergency (msg) { + return this.send(msg, { + severity: 0, + colorCode: this.emergencyColor + }); + } + /** + * Send a syslog message with a secerity level of 0 (Emergency) + * @public + * @param {string} msg - The emergancy message to send to the Syslog server + * @returns {Promise} - The formated syslog message sent to the Syslog server + * @throws {Error} - Any bubbled up error + */ + emer (msg) { + return this.emergency(msg); + } + /** + * Send a syslog message with a secerity level of 1 (Alert) + * @public + * @param {string} msg - The alert message to send to the Syslog server + * @returns {Promise} - The formated syslog message sent to the Syslog server + * @throws {Error} - Any bubbled up error + */ + alert (msg) { + return this.send(msg, { + severity: 1, + colorCode: this.alertColor + }); + } + /** + * Send a syslog message with a secerity level of 2 (Critical) + * @public + * @param {string} msg - The critical message to send to the Syslog server + * @returns {Promise} - The formated syslog message sent to the Syslog server + * @throws {Error} - Any bubbled up error + */ + critical (msg) { + return this.send(msg, { + severity: 2, + colorCode: this.criticalColor + }); + } + /** + * Send a syslog message with a secerity level of 2 (Critical) + * @public + * @param {string} msg - The critical message to send to the Syslog server + * @returns {Promise} - The formated syslog message sent to the Syslog server + * @throws {Error} - Any bubbled up error + */ + crit (msg) { + return this.critical(msg); + } + /** + * Send a syslog message with a secerity level of 3 (Error) + * @public + * @param {string} msg - The error message to send to the Syslog server + * @returns {Promise} - The formated syslog message sent to the Syslog server + * @throws {Error} - Any bubbled up error + */ + error (msg) { + return this.send(msg, { + severity: 3, + colorCode: this.errorColor + }); + } + /** + * Send a syslog message with a secerity level of 3 (Error) + * @public + * @param {string} msg - The error message to send to the Syslog server + * @returns {Promise} - The formated syslog message sent to the Syslog server + * @throws {Error} - Any bubbled up error + */ + err (msg) { + return this.error(msg); + } + /** + * Send a syslog message with a secerity level of 4 (Warning) + * @public + * @param {string} msg - The warning message to send to the Syslog server + * @returns {Promise} - The formated syslog message sent to the Syslog server + * @throws {Error} - Any bubbled up error + */ + warning (msg) { + return this.send(msg, { + severity: 4, + colorCode: this.warningColor + }); + } + /** + * Send a syslog message with a secerity level of 4 (Warning) + * @public + * @param {string} msg - The warning message to send to the Syslog server + * @returns {Promise} - The formated syslog message sent to the Syslog server + * @throws {Error} - Any bubbled up error + */ + warn (msg) { + return this.warning(msg); + } + /** + * Send a syslog message with a secerity level of 5 (Notice) + * @public + * @param {string} msg - The notice message to send to the Syslog server + * @returns {Promise} - The formated syslog message sent to the Syslog server + * @throws {Error} - Any bubbled up error + */ + notice (msg) { + return this.send(msg, { + severity: 5, + colorCode: this.noticeColor + }); + } + /** + * Send a syslog message with a secerity level of 5 (Notice) + * @public + * @param {string} msg - The notice message to send to the Syslog server + * @returns {Promise} - The formated syslog message sent to the Syslog server + * @throws {Error} - Any bubbled up error + */ + note (msg) { + return this.notice(msg); + } + /** + * Send a syslog message with a secerity level of 6 (Informational) + * @public + * @param {string} msg - The informational message to send to the Syslog server + * @returns {Promise} - The formated syslog message sent to the Syslog server + * @throws {Error} - Any bubbled up error + */ + informational (msg) { + return this.send(msg, { + severity: 6, + colorCode: this.informationalColor + }); + } + /** + * Send a syslog message with a secerity level of 6 (Informational) + * @public + * @param {string} msg - The informational message to send to the Syslog server + * @returns {Promise} - The formated syslog message sent to the Syslog server + * @throws {Error} - Any bubbled up error + */ + info (msg) { + return this.informational(msg); + } + /** + * Send a syslog message with a secerity level of 6 (Informational) + * @public + * @param {string} msg - The informational message to send to the Syslog server + * @returns {Promise} - The formated syslog message sent to the Syslog server + * @throws {Error} - Any bubbled up error + */ + log (msg) { + return this.informational(msg); + } + /** + * Send a syslog message with a secerity level of 7 (Debug) + * @public + * @param {string} msg - The debug message to send to the Syslog server + * @returns {Promise} - The formated syslog message sent to the Syslog server + * @throws {Error} - Any bubbled up error + */ + debug (msg) { + return this.send(msg, { + severity: 7, + colorCode: this.debugColor + }); + } +} + +/** + * A class to work with RFC5424 formated syslog messages. The meesaging is fully configurabule and Ansi foreground + * colors can be added. Both ANSI 8 and ANSI 256 color are fully suported. + * Most APIs will return a promise. These APIs can be used using + * `then(...)/catch(...)` + * + * A Syslog class with a configured + * Syslog server target can also be used as the input into the formating + * classes so that it may run independtly. + * + * The RFC5424 Syslog logging format is ment to be used as a stream of log data + * from a service or applacation. This class is designed to be used in this + * fashion where new messages are writen to the class as needed. + * @requires moment + * @version 0.0.0 + * @since 0.0.0 + */ +class RFC5424 { + /** + * Construct a new RFC5424 formated Syslog object with user options + * @public + * @this RFC5424 + * @param {object} [options] - Options object + * @param {string} [options.applacationName='NodeJSLogger'] - Applacation + * @param {string} [options.hostname=os.hostname] - The name of this server + * @param {boolean} [options.timestamp=false] - Included a Timestamp + * @param {boolean} [options.timestampUTC=false] - RFC tandard is for + * local time + * @param {boolean} [options.timestampMS=false] - Timestamp with ms + * resoltuion + * @param {boolean} [options.timestampTZ=true] - Should the timestamp + * included timezone + * @param {boolean} [options.encludeStructuredData=false] - Included + * any provided structured data + * @param {boolean} [options.utf8BOM=true] - Included the UTF8 + * @param {boolean} [options.color=false] - Included the UTF8 + * @param {boolean} [options.extendedColor=false] - Included the UTF8 + * encoding tag with syslog message text + * @param {object} [options.colors] - User defended colors for + * severites + * @param {string} [options.colors.emergencyColor] - A RGB Hex coded color in the form + * of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 + * Extended) + * @param {string} [options.colors.alertColor] - A RGB Hex coded color in the form + * of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 + * Extended) + * @param {string} [options.colors.criticalColor] - A RGB Hex coded color in the form + * of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 + * Extended) + * @param {string} [options.colors.errorColor] - A RGB Hex coded color in the form + * of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 + * Extended) + * @param {string} [options.colors.warningColor] - A RGB Hex coded color in the form + * of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 + * Extended) + * @param {string} [options.colors.noticeColor] - A RGB Hex coded color in the form + * of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 + * Extended) + * @param {string} [options.colors.informationalColor] - A RGB Hex coded color in the form + * of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 + * Extended) + * @param {string} [options.colors.debugColor] - A RGB Hex coded color in the form + * of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 + * Extended) + * @param {Syslog} [options.server=false] - A {@link module:SyslogPro~Syslog| + * Syslog server connection} that should be used to send messages directly + * from this class. @see SyslogPro~Syslog + */ + constructor (options) { + /** @private @type {boolean} */ + this.constructor__ = true; + options = options || {}; + this.hostname = options.hostname || os.hostname(); + this.applacationName = options.applacationName || ''; + if (typeof options.timestamp === 'undefined' || options.timestamp) { + /** @type {boolean} */ + this.timestamp = true; + } else { + this.timestamp = false; + } + if (options.timestampUTC) { + /** @type {boolean} */ + this.timestampUTC = true; + } else { + this.timestampUTC = false; + } + if (typeof options.timestampTZ === 'undefined' || options.timestampTZ) { + /** @type {boolean} */ + this.timestampTZ = true; + } else { + this.timestampTZ = false; + } + if (options.timestampMS) { + /** @type {boolean} */ + this.timestampMS = true; + } else { + this.timestampMS = false; + } + if (options.encludeStructuredData) { + /** @type {boolean} */ + this.encludeStructuredData = true; + } else { + this.encludeStructuredData = false; + } + if (typeof options.utf8BOM === 'undefined' || options.utf8BOM) { + /** @type {boolean} */ + this.utf8BOM = true; + } else { + this.utf8BOM = false; + } + if (options.color) { + /** @type {boolean} */ + this.color = true; + } else { + this.color = false; + } + if (options.extendedColor) { + /** @type {boolean} */ + this.extendedColor = true; + } else { + this.extendedColor = false; + } + if (options.server) { + if (!options.server.constructor__) { + /** @private @type {Syslog} */ + this.server = new Syslog(options.server); + } else { + this.server = options.server; + } + } + if (this.extendedColor) { + /** @private @type {number} */ + this.emergencyColor = 1; // Red foreground color + /** @private @type {number} */ + this.alertColor = 202; // Dark Orange foreground color + /** @private @type {number} */ + this.criticalColor = 208; // Orange foreground color + /** @private @type {number} */ + this.errorColor = 178; // Light Orange foreground color + /** @private @type {number} */ + this.warningColor = 226; // Yellow foreground color + /** @private @type {number} */ + this.noticeColor = 117; // Light Blue foreground color + /** @private @type {number} */ + this.informationalColor = 45; // Blue foreground color + /** @private @type {number} */ + this.debugColor = 27; // Dark Blue foreground color + } else { + this.emergencyColor = 31; // Red foreground color + this.alertColor = 31; // Red foreground color + this.criticalColor = 31; // Red foreground color + this.errorColor = 33; // Yellow foreground color + this.warningColor = 33; // Yellow foreground color + this.noticeColor = 36; // Blue foreground color + this.informationalColor = 36; // Blue foreground color + this.debugColor = 34; // Dark Blue foreground color + } + if (typeof options.colors === 'object') { + this.setColor(options.colors, this.extendedColor); + } + } + /** + * Sets the color to be used for messages at a set priority + * @public + * @param {string} [colors.emergencyColor] - A RGB Hex coded color in the form + * of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 + * Extended) + * @param {string} [colors.alertColor] - A RGB Hex coded color in the form + * of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 + * Extended) + * @param {string} [colors.criticalColor] - A RGB Hex coded color in the form + * of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 + * Extended) + * @param {string} [colors.errorColor] - A RGB Hex coded color in the form + * of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 + * Extended) + * @param {string} [colors.warningColor] - A RGB Hex coded color in the form + * of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 + * Extended) + * @param {string} [colors.noticeColor] - A RGB Hex coded color in the form + * of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 + * Extended) + * @param {string} [colors.informationalColor] - A RGB Hex coded color in the form + * of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 + * Extended) + * @param {string} [colors.debugColor] - A RGB Hex coded color in the form + * of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 + * Extended) + * @throws {Error} A standard error object + */ + setColor (colors, extendedColor) { + return new Promise((resolve, reject) => { + let colorPromises = []; + if (colors.emergencyColor) { + colorPromises.push( + new Promise((resolve,reject) => { + rgbToAnsi(colors.emergencyColor, this.extendedColor) + .then((result) => { + this.emergencyColor = result; + resolve(true); + }) + .catch((reson) => { + reson.message = 'TYPE ERROR: '; + reson.message += 'emergencyColor'; + reson.message += ' Not in RGB color hex or color code'; + reject(reson); + }); + })); + } + if (colors.alertColor) { + colorPromises.push( + new Promise((resolve,reject) => { + rgbToAnsi(colors.alertColor, this.extendedColor) + .then((result) => { + this.alertColor = result; + resolve(true); + }) + .catch((reson) => { + reson.message = 'TYPE ERROR: '; + reson.message += 'alertColor'; + reson.message += ' Not in RGB color hex or color code'; + reject(reson); + }); + })); + } + if (colors.criticalColor) { + colorPromises.push( + new Promise((resolve,reject) => { + rgbToAnsi(colors.criticalColor, this.extendedColor) + .then((result) => { + this.criticalColor = result; + resolve(true); + }) + .catch((reson) => { + reson.message = 'TYPE ERROR: '; + reson.message += 'criticalColor'; + reson.message += ' Not in RGB color hex or color code'; + reject(reson); + }); + })); + } + if (colors.errorColor) { + colorPromises.push( + new Promise((resolve,reject) => { + rgbToAnsi(colors.errorColor, this.extendedColor) + .then((result) => { + this.errorColor = result; + resolve(true); + }) + .catch((reson) => { + reson.message = 'TYPE ERROR: '; + reson.message += 'errorColor'; + reson.message += ' Not in RGB color hex or color code'; + reject(reson); + }); + })); + } + if (colors.warningColor) { + colorPromises.push( + new Promise((resolve,reject) => { + rgbToAnsi(colors.warningColor, this.extendedColor) + .then((result) => { + this.warningColor = result; + resolve(true); + }) + .catch((reson) => { + reson.message = 'TYPE ERROR: '; + reson.message += 'warningColor'; + reson.message += ' Not in RGB color hex or color code'; + reject(reson); + }); + })); + } + if (colors.noticeColor) { + colorPromises.push( + new Promise((resolve,reject) => { + rgbToAnsi(colors.noticeColor, this.extendedColor) + .then((result) => { + this.noticeColor = result; + resolve(true); + }) + .catch((reson) => { + reson.message = 'TYPE ERROR: '; + reson.message += 'noticeColor'; + reson.message += ' Not in RGB color hex or color code'; + reject(reson); + }); + })); + } + if (colors.informationalColor) { + colorPromises.push( + new Promise((resolve,reject) => { + rgbToAnsi(colors.informationalColor, this.extendedColor) + .then((result) => { + this.informationalColor = result; + resolve(true); + }) + .catch((reson) => { + reson.message = 'TYPE ERROR: '; + reson.message += 'informationalColor'; + reson.message += ' Not in RGB color hex or color code'; + reject(reson); + }); + })); + } + if (colors.debugColor) { + colorPromises.push( + new Promise((resolve,reject) => { + rgbToAnsi(colors.debugColor, this.extendedColor) + .then((result) => { + this.debugColor = result; + resolve(true); + }) + .catch((reson) => { + reson.message = 'TYPE ERROR: '; + reson.message += 'debugColor'; + reson.message += ' Not in RGB color hex or color code'; + reject(reson); + }); + })); + } + Promise.all(colorPromises) + .then((results) => { + resolve(true); + }) + .catch((reson) => { + reject(reson); + }); + }); + } + /** + * Building a formated message. Returns a promise with a formated message + * @public + * @param {string} msg - The Syslog Message + * @param {object} [options] - Options object + * @param {number} [options.severity=7] - An array of structure + * @param {number} [options.facility=23] - Facility code to use sending this + * message + * @param {string} [options.pid='-'] - The process id of the service sending + * this message + * @param {string[]} [options.structuredData] - An array of structure + * data strings conforming to the IETF/IANA defined SD-IDs or IANA + * registred SMI Network Management Private Enterprise Code SD-ID + * conforming to the format + * [name@ parameter=value] + * @param {number} [options.colorCode=36] - The ANSI color code to use if + * message coloration is selected + * @returns {Promise} A Syslog formated string acording to the selected RFC + * @throws {Error} A standard error object + */ + buildMessage (msg, options) { + return new Promise((resolve, reject) => { + options = options || {}; + let severity = typeof options.severity === 'number' ? + options.severity : 6; + if (typeof msg !== 'string' || options.severity > 7) { + let errMsg = 'FORMAT ERROR: Syslog message must be a string'; + errMsg += ' msgSeverity must be a number between 0 and 7'; + reject(new Error(errMsg)); + return; + } + let facility = options.facility || 23; + let pid = options.pid || '-'; + let id = options.id || '-'; + let msgStructuredData = options.msgStructuredData || []; + let fmtMsg = ''; // Formated Syslog message string var + const newLine = '\n'; + const newLineRegEx = /(\r|\n|(\r\n))/; + const escapeCode = '\u001B'; + const resetColor = '\u001B[0m'; + +``` + + + + + + + +The PRI is common to both RFC formats + + + + +``` + const pri = (facility * 8) + severity; + +``` + + + + + + + +Remove any newline character + + + + +``` + msg = msg.replace(newLineRegEx, ''); + +``` + + + + + + + +Add requested color + + + + +``` + if (this.color) { + options.msgColor = options.msgColor || 36; + let colorCode = '['; + if (this.extendedColor) { + colorCode += '38;5;'; // Extended 256 Colors ANSI Code + } + if (typeof options.msgColor === 'number') { + colorCode += options.msgColor; + colorCode += 'm'; // ANSI Color Closer + } else { + colorCode = '[39m'; // Use terminal's defualt color + } + msg = escapeCode + colorCode + msg + resetColor; + } + +``` + + + + + + + +RFC5424 timestamp formating + + + + +``` + let timestamp = '-'; + if (this.timestamp) { + let timeQuality = '[timeQuality'; + if (this.timestampUTC) { + timeQuality += ' tzKnown=1'; + if (this.timestampMS) { + if (this.timestampTZ) { + timestamp = moment().utc().format('YYYY-MM-DDThh:mm:ss.SSSSSSZ'); + } else { + timestamp = moment().utc().format('YYYY-MM-DDThh:mm:ss.SSSSSS'); + } + } else { + if (this.timestampTZ) { + timestamp = moment().utc().format('YYYY-MM-DDThh:mm:ssZ'); + } else { + timestamp = moment().utc().format('YYYY-MM-DDThh:mm:ss'); + } + } + } else { + if (this.timestampTZ) { + timeQuality += ' tzKnown=1'; + if (this.timestampMS) { + timeQuality += ' isSynced=1'; + timeQuality += ' syncAccuracy=0'; + timestamp = moment().format('YYYY-MM-DDThh:mm:ss.SSSSSSZ'); + } else { + timestamp = moment().format('YYYY-MM-DDThh:mm:ssZ'); + } + } else { + timeQuality += ' tzKnown=0'; + if (this.timestampMS) { + timeQuality += ' isSynced=1'; + timeQuality += ' syncAccuracy=0'; + timestamp = moment().format('YYYY-MM-DDThh:mm:ss.SSSSSS'); + } else { + timestamp = moment().format('YYYY-MM-DDThh:mm:ss'); + } + } + } + timeQuality += ']'; + msgStructuredData.push(timeQuality); + } + +``` + + + + + + + +Build Structured Data string + + + + +``` + let structuredData = '-'; + const sdElementCount = msgStructuredData.length; + if (this.encludeStructuredData && sdElementCount > 0) { + let sdElementNames = []; + let sdElements = []; + const sdElementNameRegEx = /(\[)(\S*)(\s|\])/; + +``` + + + + + + + +Loop to drop duplicates of the same SD Element name + + + + +``` + for (let elementIndex=0; + elementIndex'; + fmtMsg += '1'; // Version number + fmtMsg += ' ' + timestamp; + fmtMsg += ' ' + this.hostname; + fmtMsg += ' ' + this.applacationName; + fmtMsg += ' ' + pid; + fmtMsg += ' ' + id; + fmtMsg += ' ' + structuredData; + if (this.utf8BOM) { + fmtMsg += ' BOM' + msg; + } else { + fmtMsg += ' ' + msg; + } + fmtMsg += newLine; + resolve(fmtMsg); + }); + } + /** + * send a RFC5424 formated message. Returns a promise with the formated + * message that was sent. If no server connection was defined when the + * class was created a defualt Syslog connector will be used. + * @see SyslogPro~Syslog + * @public + * @param {string} msg - The unformated Syslog message to send + * @returns {Promise} A Syslog formated string acording to the selected RFC + * @throws {Error} A standard error object + */ + send (msg, options) { + return new Promise((resolve, reject) => { + if (!this.server) { + this.server = new Syslog(); + } + this.buildMessage(msg, options) + .then((result) => { + this.server.send(result) + .then((sendResult) => { + resolve(sendResult); + }) + .catch((error) => { + reject(error); + }); + }) + .catch((error) => { + reject(error); + }); + }); + } + /** + * Send a syslog message with a secerity level of 0 (Emergency) + * @public + * @param {string} msg - The emergancy message to send to the Syslog server + * @returns {Promise} - The formated syslog message sent to the Syslog server + * @throws {Error} - Any bubbled up error + */ + emergency (msg) { + return this.send(msg, { + severity: 0, + colorCode: this.emergencyColor + }); + } + /** + * Send a syslog message with a secerity level of 0 (Emergency) + * @public + * @param {string} msg - The emergancy message to send to the Syslog server + * @returns {Promise} - The formated syslog message sent to the Syslog server + * @throws {Error} - Any bubbled up error + */ + emer (msg) { + return this.emergency(msg); + } + /** + * Send a syslog message with a secerity level of 1 (Alert) + * @public + * @param {string} msg - The alert message to send to the Syslog server + * @returns {Promise} - The formated syslog message sent to the Syslog server + * @throws {Error} - Any bubbled up error + */ + alert (msg) { + return this.send(msg, { + severity: 1, + colorCode: this.alertColor + }); + } + /** + * Send a syslog message with a secerity level of 2 (Critical) + * @public + * @param {string} msg - The critical message to send to the Syslog server + * @returns {Promise} - The formated syslog message sent to the Syslog server + * @throws {Error} - Any bubbled up error + */ + critical (msg) { + return this.send(msg, { + severity: 2, + colorCode: this.criticalColor + }); + } + /** + * Send a syslog message with a secerity level of 2 (Critical) + * @public + * @param {string} msg - The critical message to send to the Syslog server + * @returns {Promise} - The formated syslog message sent to the Syslog server + * @throws {Error} - Any bubbled up error + */ + crit (msg) { + return this.critical(msg); + } + /** + * Send a syslog message with a secerity level of 3 (Error) + * @public + * @param {string} msg - The error message to send to the Syslog server + * @returns {Promise} - The formated syslog message sent to the Syslog server + * @throws {Error} - Any bubbled up error + */ + error (msg) { + return this.send(msg, { + severity: 3, + colorCode: this.errorColor + }); + } + /** + * Send a syslog message with a secerity level of 3 (Error) + * @public + * @param {string} msg - The error message to send to the Syslog server + * @returns {Promise} - The formated syslog message sent to the Syslog server + * @throws {Error} - Any bubbled up error + */ + err (msg) { + return this.error(msg); + } + /** + * Send a syslog message with a secerity level of 4 (Warning) + * @public + * @param {string} msg - The warning message to send to the Syslog server + * @returns {Promise} - The formated syslog message sent to the Syslog server + * @throws {Error} - Any bubbled up error + */ + warning (msg) { + return this.send(msg, { + severity: 4, + colorCode: this.warningColor + }); + } + /** + * Send a syslog message with a secerity level of 4 (Warning) + * @public + * @param {string} msg - The warning message to send to the Syslog server + * @returns {Promise} - The formated syslog message sent to the Syslog server + * @throws {Error} - Any bubbled up error + */ + warn (msg) { + return this.warning(msg); + } + /** + * Send a syslog message with a secerity level of 5 (Notice) + * @public + * @param {string} msg - The notice message to send to the Syslog server + * @returns {Promise} - The formated syslog message sent to the Syslog server + * @throws {Error} - Any bubbled up error + */ + notice (msg) { + return this.send(msg, { + severity: 5, + colorCode: this.noticeColor + }); + } + /** + * Send a syslog message with a secerity level of 5 (Notice) + * @public + * @param {string} msg - The notice message to send to the Syslog server + * @returns {Promise} - The formated syslog message sent to the Syslog server + * @throws {Error} - Any bubbled up error + */ + note (msg) { + return this.notice(msg); + } + /** + * Send a syslog message with a secerity level of 6 (Informational) + * @public + * @param {string} msg - The informational message to send to the Syslog server + * @returns {Promise} - The formated syslog message sent to the Syslog server + * @throws {Error} - Any bubbled up error + */ + informational (msg) { + return this.send(msg, { + severity: 6, + colorCode: this.informationalColor + }); + } + /** + * Send a syslog message with a secerity level of 6 (Informational) + * @public + * @param {string} msg - The informational message to send to the Syslog server + * @returns {Promise} - The formated syslog message sent to the Syslog server + * @throws {Error} - Any bubbled up error + */ + info (msg) { + return this.informational(msg); + } + /** + * Send a syslog message with a secerity level of 6 (Informational) + * @public + * @param {string} msg - The informational message to send to the Syslog server + * @returns {Promise} - The formated syslog message sent to the Syslog server + * @throws {Error} - Any bubbled up error + */ + log (msg) { + return this.informational(msg); + } + /** + * Send a syslog message with a secerity level of 7 (Debug) + * @public + * @param {string} msg - The debug message to send to the Syslog server + * @returns {Promise} - The formated syslog message sent to the Syslog server + * @throws {Error} - Any bubbled up error + */ + debug (msg) { + return this.send(msg, { + severity: 7, + colorCode: this.debugColor + }); + } +} + +/** + * 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. + * Most APIs will return a promise. These APIs can be used using + * `then(...)/catch(...)` + * + * A Syslog class with a configured Syslog server target can also be used as + * the input into the formating classes so that it may run independtly. The + * LEEF format is designed to send event data to a SIEM system and should not + * be as a logging stream. This class is ment to be used once per message. + * @requires moment + * @version 0.0.0 + * @since 0.0.0 + */ +class LEEF { + /** + * Construct a new LEEF formating object with user options + * @public + * @param {object} [options] - Options object + * @param {string} [options.vendor='unknown'] - The vendor of the system that + * genrated the event being reported + * @param {string} [options.product='unknown'] - The product name of the + * system that genrated the event being reported + * @param {string} [options.version='unknown'] - The version name of the + * system that genrated the event being reported + * @param {string} [options.eventId='unknown'] - The eventId of the + * system that genrated the event being reported + * @param {object} [options.attrabute] - LEEF message attrabutes which + * defualts to all base attrabutes with null values, new attrabutes should + * be added as new elements to this object + * @param {boolean} [options.syslogHeader='true'] - Should the LEEF message + * include a Syslog header with Timestamp and source + * @param {Syslog} [options.server=false] - A {@link module:SyslogPro~Syslog| + * Syslog server connection} that should be used to send messages directly + * from this class. @see SyslogPro~Syslog + */ + constructor (options) { + /** @private @type {boolean} */ + this.constructor__ = true; + options = options || {}; + /** @type {string} */ + this.vendor = options.vendor || 'unknown'; + /** @type {string} */ + this.product = options.product || 'unknown'; + /** @type {string} */ + this.version = options.version || 'unknown'; + /** @type {string} */ + this.eventId = options.eventId || 'unknown'; + /** @type {boolean} */ + this.syslogHeader = typeof options.syslogHeader === 'boolean' + ? options.syslogHeader : true; + /** @type {object} */ + this.attrabutes = options.attrabutes || { + cat: null, + devTime: null, + devTimeFormat: null, + proto: null, + sev: null, + src: null, + dst: null, + srcPort: null, + dstPort: null, + srcPreNAT: null, + dstPreNAT: null, + srcPostNAT: null, + dstPostNAT: null, + usrName: null, + srcMAC: null, + dstMAC: null, + srcPreNATPort: null, + dstPreNATPort: null, + srcPostNATPort: null, + dstPostNATPort: null, + identSrc: null, + identHostName: null, + identNetBios: null, + identGrpName: null, + identMAC: null, + vSrc: null, + vSrcName: null, + accountName: null, + srcBytes: null, + dstBytes: null, + srcPackets: null, + dstPackets: null, + totalPackets: null, + role: null, + realm: null, + policy: null, + resource: null, + url: null, + groupID: null, + domain: null, + isLoginEvent: null, + isLogoutEvent: null, + identSecondlp: null, + calLanguage: null, + AttributeLimits: null, + calCountryOrRegion: null, + }; + if (options.server) { + if (options.server.constructor__) { + /** @private @type {Syslog} */ + this.server = options.server; + } else { + this.server = new Syslog(options.server); + } + } + } + /** + *Build a formated message + * @public + * @return {Promise} - string with formated message + */ + buildMessage () { + return new Promise((resolve, reject) => { + let fmtMsg = 'LEEF:2.0'; + fmtMsg += '|' + this.vendor; + fmtMsg += '|' + this.product; + fmtMsg += '|' + this.version; + fmtMsg += '|' + this.eventId; + fmtMsg += '|'; + + +``` + + + + + + + +Build LEEF Attrabuites + + + + +``` + const Tab = '\x09'; + const leefAttribs = Object.entries(this.attrabutes); + const leefAttribsLen = leefAttribs.length; + for (let attrib = 0; attrib < leefAttribsLen; attrib++) { + if (leefAttribs[attrib][1] !== null) { + fmtMsg += leefAttribs[attrib][0] + '=' + leefAttribs[attrib][1] + Tab; + } + } + resolve(fmtMsg); + }); + } + + /** + * @public + * @param {Syslog} [options=false] - A {@link module:SyslogPro~Syslog| + * Syslog server connection} that should be used to send messages directly + * from this class. @see SyslogPro~Syslog + */ + send (options) { + return new Promise((resolve, reject) => { + this.buildMessage() + .then((result) => { + if (!this.server) { + this.server = new Syslog(options); + } + this.server.send(result) + .then((sendResult) => { + resolve(sendResult); + }) + .catch((reson) => { + reject(reson); + }); + }); + }); + } +} + +/** + * A class to work with HP CEF (Common Event 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 CEF + * formated mesage produced by this module can be saved externaly to it) or + * sent via Syslog. + * Most APIs will return a promise. These APIs can be used using + * `then(...)/catch(...)` + * + * A Syslog class with a configured Syslog server target can also be used as + * the input into the formating classes so that it may run independtly. The CEF + * format is designed to send event data to a SIEM system and should not be as + * a logging stream. This class is ment to be used once per message. + * @requires moment + * @version 0.0.0 + * @since 0.0.0 + */ +class CEF { + /** + * Construct a new CEF formating object with user options + * @public + * @param {object} [options] - Options object + * @param {string} [options.deviceVendor='unknown'] - The vendor of the system + * that genrated the event being reported + * @param {string} [options.deviceProduct='unknown'] - The product name of the + * system that genrated the event being reported + * @param {string} [options.deviceVersion='unknown'] - The version name of the + * system that genrated the event being reported + * @param {string} [options.deviceEventClassId='unknown'] - The eventId of the + * system that genrated the event being reported + * @param {string} [options.name='unknown'] - Name of the service genrating + * the notice + * @param {string} [options.severity='unknown'] - Severity of the notification + * @param {string} [options.extensions={}] - Any CEF Key=Value extentions + * @param {Syslog} [options.server=false] - A {@link module:SyslogPro~Syslog| + * Syslog server connection} that should be used to send messages directly + * from this class. @see SyslogPro~Syslog + */ + constructor (options) { + /** @private @type {boolean} */ + this.constructor__ = true; + options = options || {}; + /** @type {string} */ + this.deviceVendor = options.deviceVendor || 'Unknown'; + /** @type {string} */ + this.deviceProduct = options.deviceProduct || 'Unknown'; + /** @type {string} */ + this.deviceVersion = options.deviceVersion || 'Unknown'; + /** @type {string} */ + this.deviceEventClassId = options.deviceEventClassId || 'Unknown'; + /** @type {string} */ + this.name = options.name || 'Unknown'; + /** @type {string} */ + this.severity = options.severity || 'Unknown'; + /** @type {object} */ + this.extensions = options.extensions || { + 'deviceAction': null, + 'applicationProtocol': null, + 'deviceCustomIPv6Address1': null, + 'deviceCustomIPv6 Address1Label': null, + 'deviceCustomIPv6Address3': null, + 'deviceCustomIPv6Address3 Label': null, + 'deviceCustomIPv6 Address4': null, + 'deviceCustomIPv6 Address4Label': null, + 'deviceEventCategory': null, + 'deviceCustomFloatingPoint1': null, + 'deviceCustom FloatingPoint1Label': null, + 'deviceCustomFloatingPoint2': null, + 'deviceCustomFloatingPoint2 Label': null, + 'deviceCustomFloatingPoint3': null, + 'deviceCustom FloatingPoint3Label': null, + 'deviceCustomFloatingPoint4': null, + 'deviceCustom FloatingPoint4Label': null, + 'deviceCustomNumber1': null, + 'deviceCustomNumber1Label': null, + 'DeviceCustomNumber2': null, + 'deviceCustomNumber2Label': null, + 'deviceCustomNumber3': null, + 'deviceCustomNumber3Label': null, + 'baseEventCount': null, + 'deviceCustomString1': null, + 'deviceCustomString1Label': null, + 'deviceCustomString2': null, + 'deviceCustomString2Label': null, + 'deviceCustomString3': null, + 'deviceCustomString3Label': null, + 'deviceCustomString4': null, + 'deviceCustomString4Label': null, + 'deviceCustomString5': null, + 'deviceCustomString5Label': null, + 'deviceCustomString6': null, + 'deviceCustomString6Label': null, + 'destinationDnsDomain': null, + 'destinationServiceName': null, + 'destinationTranslated Address': null, + 'destinationTranslatedPort': null, + 'deviceCustomDate1': null, + 'deviceCustomDate1Label': null, + 'deviceCustomDate2': null, + 'deviceCustomDate2Label': null, + 'deviceDirection': null, + 'deviceDnsDomain': null, + 'deviceExternalId': null, + 'deviceFacility': null, + 'deviceInboundInterface': null, + 'deviceNtDomain': null, + 'deviceOutboundInterface': null, + 'devicePayloadId': null, + 'deviceProcessName': null, + 'deviceTranslatedAddress': null, + 'destinationHostName': null, + 'destinationMacAddress': null, + 'destinationNtDomain': null, + 'destinationProcessId': null, + 'destinationUserPrivileges': null, + 'destinationProcessName': null, + 'destinationPort': null, + 'destinationAddress': null, + 'deviceTimeZone': null, + 'destinationUserId': null, + 'destinationUserName': null, + 'deviceAddress': null, + 'deviceHostName': null, + 'deviceMacAddress': null, + 'deviceProcessId': null, + 'endTime': null, + 'externalId': null, + 'fileCreateTime': null, + 'fileHash': null, + 'fileId': null, + 'fileModificationTime': null, + 'filePath': null, + 'filePermission': null, + 'fileType': null, + 'flexDate1': null, + 'flexDate1Label': null, + 'flexString1': null, + 'flexString1Label': null, + 'flexString2': null, + 'flexString2Label': null, + 'filename': null, + 'fileSize': null, + 'bytesIn': null, + 'message': null, + 'oldFileCreateTime': null, + 'oldFileHash': null, + 'oldFileId': null, + 'oldFileModificationTime': null, + 'oldFileName': null, + 'oldFilePath': null, + 'oldFileSize': null, + 'oldFileType': null, + 'bytesOut': null, + 'eventOutcome': null, + 'transportProtocol': null, + 'Reason': null, + 'requestUrl': null, + 'requestClientApplication': null, + 'requestContext': null, + 'requestCookies': null, + 'requestMethod': null, + 'deviceReceiptTime': null, + 'sourceHostName': null, + 'sourceMacAddress': null, + 'sourceNtDomain': null, + 'sourceDnsDomain': null, + 'sourceServiceName': null, + 'sourceTranslatedAddress': null, + 'sourceTranslatedPort': null, + 'sourceProcessId': null, + 'sourceUserPrivileges': null, + 'sourceProcessName': null, + 'sourcePort': null, + 'sourceAddress': null, + 'startTime': null, + 'sourceUserId': null, + 'sourceUserName': null, + 'type': null, + 'agentDnsDomain': null, + 'agentNtDomain': null, + 'agentTranslatedAddress': null, + 'agentTranslatedZone ExternalID': null, + 'agentTranslatedZoneURI': null, + 'agentZoneExternalID': null, + 'agentZoneURI': null, + 'agentAddress': null, + 'agentHostName': null, + 'agentId': null, + 'agentMacAddress': null, + 'agentReceiptTime': null, + 'agentType': null, + 'agentTimeZone': null, + 'agentVersion': null, + 'customerExternalID': null, + 'customerURI': null, + 'destinationTranslated ZoneExternalID': null, + 'destinationTranslated ZoneURI': null, + 'destinationZoneExternalID': null, + 'destinationZoneURI': null, + 'deviceTranslatedZone ExternalID': null, + 'deviceTranslatedZoneURI': null, + 'deviceZoneExternalID': null, + 'deviceZoneURI': null, + 'destinationGeoLatitude': null, + 'destinationGeoLongitude': null, + 'eventId': null, + 'rawEvent': null, + 'sourceGeoLatitude': null, + 'sourceGeoLongitude': null, + 'sourceTranslatedZone ExternalID': null, + 'sourceTranslatedZoneURI': null, + 'sourceZoneExternalID': null, + 'sourceZoneURI': null, + }; + if (options.server) { + if (options.server.constructor__) { + /** @private @type {Syslog} */ + this.server = options.server; + } else { + this.server = new Syslog(options.server); + } + } + } + /** + * Validate this CEF object + * @public + * @return {Promise} - True if valadated + * @throws {Error} - First element to fail valadation + */ + validate () { + return new Promise ((resolve, reject) => { + const Extensions = { + 'deviceAction': {key: 'act', type:'String', len:63, discription: 'Action taken by the device.'}, + 'applicationProtocol': {key: 'app', type:'String', len:31, discription: 'Application level protocol, example values are HTTP, HTTPS, SSHv2, Telnet, POP, IMPA, IMAPS, and so on.'}, + 'deviceCustomIPv6Address1': {key: 'c6a1', type:'String', len:null, discription: 'One of four IPv6 address fields available to map fields that do not apply to any other in this dictionary. TIP: See the guidelines under “User-Defined Extensions” for tips on using these fields.'}, + 'deviceCustomIPv6 Address1Label': {key: 'c6a1Label', type:'String', len:1023, discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'}, + 'deviceCustomIPv6Address3': {key: 'c6a3', type:'String', len:null, discription: 'One of four IPv6 address fields available to map fields that do not apply to any other in this dictionary. TIP: See the guidelines under “User-Defined Extensions” for tips on using these fields.'}, + 'deviceCustomIPv6Address3 Label': {key: 'c6a3Label', type:'String', len:1023, discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'}, + 'deviceCustomIPv6 Address4': {key: 'c6a4', type:'String', len:null, discription: 'One of four IPv6 address fields available to map fields that do not apply to any other in this dictionary. TIP: See the guidelines under “User-Defined Extensions” for tips on using these fields.'}, + 'deviceCustomIPv6 Address4Label': {key: 'C6a4Label', type:'String', len:1023, discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'}, + 'deviceEventCategory': {key: 'cat', type:'String', len:1023, discription: 'Represents the category assigned by the originating device. Devices often use their own categorization schema to classify event. Example: “/Monitor/Disk/Read”'}, + 'deviceCustomFloatingPoint1': {key: 'cfp1', type:'Number', len:null, discription: 'One of four floating point fields available to map fields that do not apply to any other in this dictionary.'}, + 'deviceCustom FloatingPoint1Label': {key: 'cfp1Label', type:'String', len:1023, discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'}, + 'deviceCustomFloatingPoint2': {key: 'cfp2', type:'Number', len:null, discription: 'One of four floating point fields available to map fields that do not apply to any other in this dictionary.'}, + 'deviceCustomFloatingPoint2 Label': {key: 'cfp2Label', type:'String', len:1023, discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'}, + 'deviceCustomFloatingPoint3': {key: 'cfp3', type:'Number', len:null, discription: 'One of four floating point fields available to map fields that do not apply to any other in this dictionary.'}, + 'deviceCustom FloatingPoint3Label': {key: 'cfp3Label', type:'String', len:1023, discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'}, + 'deviceCustomFloatingPoint4': {key: 'cfp4', type:'Number', len:null, discription: 'One of four floating point fields available to map fields that do not apply to any other in this dictionary.'}, + 'deviceCustom FloatingPoint4Label': {key: 'cfp4Label', type:'String', len:1023, discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'}, + 'deviceCustomNumber1': {key: 'cn1', type:'Number', len:null, discription: 'One of three number fields available to map fields that do not apply to any other in this dictionary. Use sparingly and seek a more specific, dictionary supplied field when possible.'}, + 'deviceCustomNumber1Label': {key: 'cn1Label', type:'String', len:1023, discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'}, + 'DeviceCustomNumber2': {key: 'cn2', type:'Number', len:null, discription: 'One of three number fields available to map fields that do not apply to any other in this dictionary. Use sparingly and seek a more specific, dictionary supplied field when possible.'}, + 'deviceCustomNumber2Label': {key: 'cn2Label', type:'String', len:1023, discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'}, + 'deviceCustomNumber3': {key: 'cn3', type:'Number', len:null, discription: 'One of three number fields available to map fields that do not apply to any other in this dictionary. Use sparingly and seek a more specific, dictionary supplied field when possible.'}, + 'deviceCustomNumber3Label': {key: 'cn3Label', type:'String', len:1023, discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'}, + 'baseEventCount': {key: 'cnt', type:'Number', len:null, discription: 'A count associated with this event. How many times was this same event observed? Count can be omitted if it is 1.'}, + 'deviceCustomString1': {key: 'cs1', type:'String', len:4000, discription: 'One of six strings available to map fields that do not apply to any other in this dictionary. Use sparingly and seek a more specific, dictionary supplied field when possible. TIP: See the guidelines under “User-Defined Extensions” for tips on using these fields.'}, + 'deviceCustomString1Label': {key: 'cs1Label', type:'String', len:1023, discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'}, + 'deviceCustomString2': {key: 'cs2', type:'String', len:4000, discription: 'One of six strings available to map fields that do not apply to any other in this dictionary. Use sparingly and seek a more specific, dictionary supplied field when possible. TIP: See the guidelines under “User-Defined Extensions” for tips on using these fields.'}, + 'deviceCustomString2Label': {key: 'cs2Label', type:'String', len:1023, discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'}, + 'deviceCustomString3': {key: 'cs3', type:'String', len:4000, discription: 'One of six strings available to map fields that do not apply to any other in this dictionary. Use sparingly and seek a more specific, dictionary supplied field when possible. TIP: See the guidelines under “User-Defined Extensions” for tips on using these fields.'}, + 'deviceCustomString3Label': {key: 'cs3Label', type:'String', len:1023, discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'}, + 'deviceCustomString4': {key: 'cs4', type:'String', len:4000, discription: 'One of six strings available to map fields that do not apply to any other in this dictionary. Use sparingly and seek a more specific, dictionary supplied field when possible. TIP: See the guidelines under “User-Defined Extensions” for tips on using these fields.'}, + 'deviceCustomString4Label': {key: 'cs4Label', type:'String', len:1023, discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'}, + 'deviceCustomString5': {key: 'cs5', type:'String', len:4000, discription: 'One of six strings available to map fields that do not apply to any other in this dictionary. Use sparingly and seek a more specific, dictionary supplied field when possible. TIP: See the guidelines under “User-Defined Extensions” for tips on using these fields.'}, + 'deviceCustomString5Label': {key: 'cs5Label', type:'String', len:1023, discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'}, + 'deviceCustomString6': {key: 'cs6', type:'String', len:4000, discription: 'One of six strings available to map fields that do not apply to any other in this dictionary. Use sparingly and seek a more specific, dictionary supplied field when possible. TIP: See the guidelines under “User-Defined Extensions” for tips on using these fields.'}, + 'deviceCustomString6Label': {key: 'cs6Label', type:'String', len:1023, discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'}, + 'destinationDnsDomain': {key: 'destination DnsDomain', type:'String', len:255, discription: 'The DNS domain part of the complete fully qualified domain name (FQDN).'}, + 'destinationServiceName': {key: 'destination ServiceName', type:'String', len:1023, discription: 'The service targeted by this event. Example: “sshd”'}, + 'destinationTranslated Address': {key: 'Destination Translated Address', type:'String', len:null, discription: 'Identifies the translated destination that the event refers to in an IP network. The format is an IPv4 address. Example: “192.168.10.1”'}, + 'destinationTranslatedPort': {key: 'Destination TranslatedPort', type:'Number', len:null, discription: 'Port after it was translated; for example, a firewall. Valid port numbers are 0 to 65535.'}, + 'deviceCustomDate1': {key: 'deviceCustom Date1', type:'String', len:null, discription: 'One of two timestamp fields available to map fields that do not apply to any other in this dictionary. Use sparingly and seek a more specific, dictionary supplied field when possible. TIP: See the guidelines under “User-Defined Extensions” for tips on using these fields.'}, + 'deviceCustomDate1Label': {key: 'deviceCustom Date1Label', type:'String', len:1023, discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'}, + 'deviceCustomDate2': {key: 'deviceCustom Date2', type:'String', len:null, discription: 'One of two timestamp fields available to map fields that do not apply to any other in this dictionary. Use sparingly and seek a more specific, dictionary supplied field when possible. TIP: See the guidelines under “User-Defined Extensions” for tips on using these fields.'}, + 'deviceCustomDate2Label': {key: 'deviceCustom Date2Label', type:'String', len:1023, discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'}, + 'deviceDirection': {key: 'deviceDirection', type:'Number', len:null, discription: 'Any information about what direction the observed communication has taken. The following values are supported: “0” for inbound or “1” for outbound'}, + 'deviceDnsDomain': {key: 'deviceDns Domain', type:'String', len:255, discription: 'The DNS domain part of the complete fully qualified domain name (FQDN).'}, + 'deviceExternalId': {key: 'device ExternalId', type:'String', len:255, discription: 'A name that uniquely identifies the device generating this event.'}, + 'deviceFacility': {key: 'deviceFacility', type:'String', len:1023, discription: 'The facility generating this event. For example, Syslog has an explicit facility associated with every event.'}, + 'deviceInboundInterface': {key: 'deviceInbound Interface', type:'String', len:128, discription: 'Interface on which the packet or data entered the device.'}, + 'deviceNtDomain': {key: 'deviceNt Domain', type:'String', len:255, discription: 'The Windows domain name of the device address.'}, + 'deviceOutboundInterface': {key: 'Device Outbound Interface', type:'String', len:128, discription: 'Interface on which the packet or data left the device.'}, + 'devicePayloadId': {key: 'Device PayloadId', type:'String', len:128, discription: 'Unique identifier for the payload associated with the event.'}, + 'deviceProcessName': {key: 'deviceProcess Name', type:'String', len:1023, discription: 'Process name associated with the event. An example might be the process generating the syslog entry in UNIX.'}, + 'deviceTranslatedAddress': {key: 'device Translated Address', type:'String', len:null, discription: 'Identifies the translated device address that the event refers to in an IP network. The format is an IPv4 address. Example: “192.168.10.1”'}, + 'destinationHostName': {key: 'dhost', type:'String', len:1023, discription: 'Identifies the destination that an event refers to in an IP network. The format should be a fully qualified domain name (FQDN) associated with the destination node, when a node is available. Examples: “host.domain.com” or “host”.'}, + 'destinationMacAddress': {key: 'dmac', type:'String', len:null, discription: 'Six colon-seperated hexadecimal numbers. Example: “00:0D:60:AF:1B:61”'}, + 'destinationNtDomain': {key: 'dntdom', type:'String', len:255, discription: 'The Windows domain name of the destination address.'}, + 'destinationProcessId': {key: 'dpid', type:'Number', len:null, discription: 'Provides the ID of the destination process associated with the event. For example, if an event contains process ID 105, “105” is the process ID.'}, + 'destinationUserPrivileges': {key: 'dpriv', type:'String', len:1023, discription: 'The typical values are “Administrator”, “User”, and “Guest”. This identifies the destination user’s privileges. In UNIX, for example, activity executed on the root user would be identified with destinationUser Privileges of “Administrator”.'}, + 'destinationProcessName': {key: 'dproc', type:'String', len:1023, discription: 'The name of the event’s destination process. Example: “telnetd” or “sshd”.'}, + 'destinationPort': {key: 'dpt', type:'Number', len:null, discription: 'The valid port numbers are between 0 and 65535.'}, + 'destinationAddress': {key: 'dst', type:'String', len:null, discription: 'Identifies the destination address that the event refers to in an IP network. The format is an IPv4 address. Example: “192.168.10.1”'}, + 'deviceTimeZone': {key: 'dtz', type:'String', len:255, discription: 'The timezone for the device generating the event.'}, + 'destinationUserId': {key: 'duid', type:'String', len:1023, discription: 'Identifies the destination user by ID. For example, in UNIX, the root user is generally associated with user ID 0.'}, + 'destinationUserName': {key: 'duser', type:'String', len:1023, discription: 'Identifies the destination user by name. This is the user associated with the event’s destination. Email addresses are often mapped into the UserName fields. The recipient is a candidate to put into this field.'}, + 'deviceAddress': {key: 'dvc', type:'String', len:null, discription: 'Identifies the device address that an event refers to in an IP network. The format is an IPv4 address. Example: “192.168.10.1”.'}, + 'deviceHostName': {key: 'dvchost', type:'String', len:100, discription: 'The format should be a fully qualified domain name (FQDN) associated with the device node, when a node is available. Example: “host.domain.com” or “host”.'}, + 'deviceMacAddress': {key: 'dvcmac', type:'String', len:null, discription: 'Six colon-separated hexadecimal numbers. Example: “00:0D:60:AF:1B:61”'}, + 'deviceProcessId': {key: 'dvcpid', type:'Number', len:null, discription: 'Provides the ID of the process on the device generating the event.'}, + 'endTime': {key: 'end', type:'String', len:null, discription: 'The time at which the activity related to the event ended. The format is MMM dd yyyy HH:mm:ss or milliseconds since epoch (Jan 1st1970). An example would be reporting the end of a session.'}, + 'externalId': {key: 'externalId', type:'String', len:40, discription: 'The ID used by an originating device. They are usually increasing numbers, associated with events.'}, + 'fileCreateTime': {key: 'fileCreateTime', type:'String', len:null, discription: 'Time when the file was created.'}, + 'fileHash': {key: 'fileHash', type:'String', len:255, discription: 'Hash of a file.'}, + 'fileId': {key: 'fileId', type:'String', len:1023, discription: 'An ID associated with a file could be the inode.'}, + 'fileModificationTime': {key: 'fileModification Time', type:'String', len:null, discription: 'Time when the file was last modified.'}, + 'filePath': {key: 'filePath', type:'String', len:1023, discription: 'Full path to the file, including file name itself. Example: C:\Program Files \WindowsNT\Accessories\ wordpad.exe or /usr/bin/zip'}, + 'filePermission': {key: 'filePermission', type:'String', len:1023, discription: 'Permissions of the file.'}, + 'fileType': {key: 'fileType', type:'String', len:1023, discription: 'Type of file (pipe, socket, etc.)'}, + 'flexDate1': {key: 'flexDate1', type:'String', len:null, discription: 'A timestamp field available to map a timestamp that does not apply to any other defined timestamp field in this dictionary. Use all flex fields sparingly and seek a more specific, dictionary supplied field when possible. These fields are typically reserved for customer use and should not be set by vendors unless necessary.'}, + 'flexDate1Label': {key: 'flexDate1Label', type:'String', len:128, discription: 'The label field is a string and describes the purpose of the flex field.'}, + 'flexString1': {key: 'flexString1', type:'String', len:1023, discription: 'One of four floating point fields available to map fields that do not apply to any other in this dictionary. Use sparingly and seek a more specific, dictionary supplied field when possible. These fields are typically reserved for customer use and should not be set by vendors unless necessary.'}, + 'flexString1Label': {key: 'flexString1 Label', type:'String', len:128, discription: 'The label field is a string and describes the purpose of the flex field.'}, + 'flexString2': {key: 'flexString2', type:'String', len:1023, discription: 'One of four floating point fields available to map fields that do not apply to any other in this dictionary. Use sparingly and seek a more specific, dictionary supplied field when possible. These fields are typically reserved for customer use and should not be set by vendors unless necessary.'}, + 'flexString2Label': {key: 'flex String2Label', type:'String', len:128, discription: 'The label field is a string and describes the purpose of the flex field.'}, + 'filename': {key: 'fname', type:'String', len:1023, discription: 'Name of the file only (without its path).'}, + 'fileSize': {key: 'fsize', type:'Number', len:null, discription: 'Size of the file.'}, + 'bytesIn': {key: 'in', type:'Number', len:null, discription: 'Number of bytes transferred inbound, relative to the source to destination relationship, meaning that data was flowing from source to destination.'}, + 'message': {key: 'msg', type:'String', len:1023, discription: 'An arbitrary message giving more details about the event. Multi-line entries can be produced by using \n as the new line separator.'}, + 'oldFileCreateTime': {key: 'oldFileCreate Time', type:'String', len:null, discription: 'Time when old file was created.'}, + 'oldFileHash': {key: 'oldFileHash', type:'String', len:255, discription: 'Hash of the old file.'}, + 'oldFileId': {key: 'oldFileId', type:'String', len:1023, discription: 'An ID associated with the old file could be the inode.'}, + 'oldFileModificationTime': {key: 'oldFile Modification Time', type:'String', len:null, discription: 'Time when old file was last modified.'}, + 'oldFileName': {key: 'oldFileName', type:'String', len:1023, discription: 'Name of the old file.'}, + 'oldFilePath': {key: 'oldFilePath', type:'String', len:1023, discription: 'Full path to the old fiWindowsNT\Accessories le, including the file name itself. Examples: c:\Program Files\wordpad.exe or /usr/bin/zip'}, + 'oldFileSize': {key: 'oldFileSize', type:'Number', len:null, discription: 'Size of the old file.'}, + 'oldFileType': {key: 'oldFileType', type:'String', len:1023, discription: 'Type of the old file (pipe, socket, etc.)'}, + 'bytesOut': {key: 'out', type:'Number', len:null, discription: 'Number of bytes transferred outbound relative to the source to destination relationship. For example, the byte number of data flowing from the destination to the source.'}, + 'eventOutcome': {key: 'outcome', type:'String', len:63, discription: 'Displays the outcome, usually as ‘success’ or ‘failure’.'}, + 'transportProtocol': {key: 'proto', type:'String', len:31, discription: 'Identifies the Layer-4 protocol used. The possible values are protocols such as TCP or UDP.'}, + 'Reason': {key: 'reason', type:'String', len:1023, discription: 'The reason an audit event was generated. For example “badd password” or “unknown user”. This could also be an error or return code. Example: “0x1234”'}, + 'requestUrl': {key: 'request', type:'String', len:1023, discription: 'In the case of an HTTP request, this field contains the URL accessed. The URL should contain the protocol as well. Example: “http://www/secure.com”'}, + 'requestClientApplication': {key: 'requestClient Application', type:'String', len:1023, discription: 'The User-Agent associated with the request.'}, + 'requestContext': {key: 'requestContext', type:'String', len:2048, discription: 'Description of the content from which the request originated (for example, HTTP Referrer)'}, + 'requestCookies': {key: 'requestCookies', type:'String', len:1023, discription: 'Cookies associated with the request.'}, + 'requestMethod': {key: 'requestMethod', type:'String', len:1023, discription: 'The method used to access a URL. Possible values: “POST”, “GET”, etc.'}, + 'deviceReceiptTime': {key: 'rt', type:'String', len:null, discription: 'The time at which the event related to the activity was received. The format is MMM dd yyyy HH:mm:ss or milliseconds since epoch (Jan 1st 1970)'}, + 'sourceHostName': {key: 'shost', type:'String', len:1023, discription: 'Identifies the source that an event refers to in an IP network. The format should be a fully qualified domain name (DQDN) associated with the source node, when a mode is available. Examples: “host” or “host.domain.com”.'}, + 'sourceMacAddress': {key: 'smac', type:'String', len:null, discription: 'Six colon-separated hexadecimal numbers. Example: “00:0D:60:AF:1B:61”'}, + 'sourceNtDomain': {key: 'sntdom', type:'String', len:255, discription: 'The Windows domain name for the source address.'}, + 'sourceDnsDomain': {key: 'sourceDns Domain', type:'String', len:255, discription: 'The DNS domain part of the complete fully qualified domain name (FQDN).'}, + 'sourceServiceName': {key: 'source ServiceName', type:'String', len:1023, discription: 'The service that is responsible for generating this event.'}, + 'sourceTranslatedAddress': {key: 'source Translated Address', type:'String', len:null, discription: 'Identifies the translated source that the event refers to in an IP network. The format is an IPv4 address. Example: “192.168.10.1”.'}, + 'sourceTranslatedPort': {key: 'source TranslatedPort', type:'Number', len:null, discription: 'A port number after being translated by, for example, a firewall. Valid port numbers are 0 to 65535.'}, + 'sourceProcessId': {key: 'spid', type:'Number', len:null, discription: 'The ID of the source process associated with the event.'}, + 'sourceUserPrivileges': {key: 'spriv', type:'String', len:1023, discription: 'The typical values are “Administrator”, “User”, and “Guest”. It identifies the source user’s privileges. In UNIX, for example, activity executed by the root user would be identified with “Administrator”.'}, + 'sourceProcessName': {key: 'sproc', type:'String', len:1023, discription: 'The name of the event’s source process.'}, + 'sourcePort': {key: 'spt', type:'Number', len:null, discription: 'The valid port numbers are 0 to 65535.'}, + 'sourceAddress': {key: 'src', type:'String', len:null, discription: 'Identifies the source that an event refers to in an IP network. The format is an IPv4 address. Example: “192.168.10.1”.'}, + 'startTime': {key: 'start', type:'String', len:null, discription: 'The time when the activity the event referred to started. The format is MMM dd yyyy HH:mm:ss or milliseconds since epoch (Jan 1st 1970)'}, + 'sourceUserId': {key: 'suid', type:'String', len:1023, discription: 'Identifies the source user by ID. This is the user associated with the source of the event. For example, in UNIX, the root user is generally associated with user ID 0.'}, + 'sourceUserName': {key: 'suser', type:'String', len:1023, discription: 'Identifies the source user by name. Email addresses are also mapped into the UserName fields. The sender is a candidate to put into this field.'}, + 'type': {key: 'type', type:'Number', len:null, discription: '0 means base event, 1 means aggregated, 2 means correlation, and 3 means action. This field can be omitted for base events (type 0).'}, + 'agentDnsDomain': {key: 'agentDns Domain', type:'String', len:255, discription: 'The DNS domain name of the ArcSight connector that processed the event.'}, + 'agentNtDomain': {key: 'agentNtDomain', type:'String', len:255, discription: ''}, + 'agentTranslatedAddress': {key: 'agentTranslated Address', type:'String', len:null, discription: ''}, + 'agentTranslatedZone ExternalID': {key: 'agentTranslated ZoneExternalID', type:'String', len:200, discription: ''}, + 'agentTranslatedZoneURI': {key: 'agentTranslated Zone URI', type:'String', len:2048, discription: ''}, + 'agentZoneExternalID': {key: 'agentZone ExternalID', type:'String', len:200, discription: ''}, + 'agentZoneURI': {key: 'agentZoneURI', type:'String', len:2048, discription: ''}, + 'agentAddress': {key: 'agt', type:'String', len:null, discription: 'The IP address of the ArcSight connector that processed the event.'}, + 'agentHostName': {key: 'ahost', type:'String', len:1023, discription: 'The hostname of the ArcSight connector that processed the event.'}, + 'agentId': {key: 'aid', type:'String', len:40, discription: 'The agent ID of the ArcSight connector that processed the event.'}, + 'agentMacAddress': {key: 'amac', type:'String', len:null, discription: 'The MAC address of the ArcSight connector that processed the event.'}, + 'agentReceiptTime': {key: 'art', type:'String', len:null, discription: 'The time at which information about the event was received by the ArcSight connector.'}, + 'agentType': {key: 'at', type:'String', len:63, discription: 'The agent type of the ArcSight connector that processed the event'}, + 'agentTimeZone': {key: 'atz', type:'String', len:255, discription: 'The agent time zone of the ArcSight connector that processed the event.'}, + 'agentVersion': {key: 'av', type:'String', len:31, discription: 'The version of the ArcSight connector that processed the event.'}, + 'customerExternalID': {key: 'customer ExternalID', type:'String', len:200, discription: ''}, + 'customerURI': {key: 'customerURI', type:'String', len:2048, discription: ''}, + 'destinationTranslated ZoneExternalID': {key: 'destination TranslatedZone ExternalID', type:'String', len:200, discription: ''}, + 'destinationTranslated ZoneURI': {key: 'destination Translated ZoneURI', type:'String', len:2048, discription: 'The URI for the Translated Zone that the destination asset has been assigned to in ArcSight.'}, + 'destinationZoneExternalID': {key: 'destinationZone ExternalID', type:'String', len:200, discription: ''}, + 'destinationZoneURI': {key: 'destinationZone URI', type:'String', len:2048, discription: 'The URI for the Zone that the destination asset has been assigned to in ArcSight.'}, + 'deviceTranslatedZone ExternalID': {key: 'device TranslatedZone ExternalID', type:'String', len:200, discription: ''}, + 'deviceTranslatedZoneURI': {key: 'device TranslatedZone URI', type:'String', len:2048, discription: 'The URI for the Translated Zone that the device asset has been assigned to in ArcSight.'}, + 'deviceZoneExternalID': {key: 'deviceZone ExternalID', type:'String', len:200, discription: ''}, + 'deviceZoneURI': {key: 'deviceZoneURI', type:'String', len:2048, discription: 'Thee URI for the Zone that the device asset has been assigned to in ArcSight.'}, + 'destinationGeoLatitude': {key: 'dlat', type:'Number', len:null, discription: 'The latitudinal value from which the destination’s IP address belongs.'}, + 'destinationGeoLongitude': {key: 'dlong', type:'Number', len:null, discription: 'The longitudinal value from which the destination’s IP address belongs.'}, + 'eventId': {key: 'eventId', type:'Number', len:null, discription: 'This is a unique ID that ArcSight assigns to each event.'}, + 'rawEvent': {key: 'rawEvent', type:'String', len:4000, discription: ''}, + 'sourceGeoLatitude': {key: 'slat', type:'Number', len:null, discription: ''}, + 'sourceGeoLongitude': {key: 'slong', type:'Number', len:null, discription: ''}, + 'sourceTranslatedZone ExternalID': {key: 'source TranslatedZone ExternalID', type:'String', len:200, discription: ''}, + 'sourceTranslatedZoneURI': {key: 'source TranslatedZone URI', type:'String', len:2048, discription: 'The URI for the Translated Zone that the destination asset has been assigned to in ArcSight.'}, + 'sourceZoneExternalID': {key: 'sourceZone ExternalID', type:'String', len:200, discription: ''}, + 'sourceZoneURI': {key: 'sourceZoneURI', type:'String', len:2048, discription: 'The URI for the Zone that the source asset has been assigned to in ArcSight.'}, + }; + if (typeof this.deviceVendor !== 'string' + || typeof this.deviceProduct !== 'string' + || typeof this.deviceVersion !== 'string' + ) { + reject(new Error('TYPE ERROR: CEF Device Info must be a string')); + } + if (this.severity + && ( + ( + typeof this.severity === 'string' + && ( + this.severity !== 'Unknown' + && this.severity !== 'Low' + && this.severity !== 'Medium' + && this.severity !== 'High' + && this.severity !== 'Very-High' + ) + ) + || ( + typeof this.severity === 'number' + && ( + this.severity < 0 + || this.severity > 10 + ) + ) + ) + ) { + reject(new Error('TYPE ERROR: CEF Severity not set correctly')); + } + const cefExts = Object.entries(this.extensions); + const cefExtsLen = cefExts.length; + for (let ext = 0; ext < cefExtsLen; ext++) { + if (cefExts[ext][1] !== null) { + if(Extensions[cefExts[ext][0]]) { + if (typeof cefExts[ext][1] === Extensions[cefExts[ext][0]] + .type + .toLowerCase()) { + if (Extensions[cefExts[ext][0]].len > 0 + && typeof cefExts[ext][1] === 'string' + && cefExts[ext][1].length > Extensions[cefExts[ext][0]].len){ + let errMsg = 'FORMAT ERROR:'; + errMsg += ' CEF Extention Key'; + errMsg += ' ' + cefExts[ext][0]; + errMsg += ' value length is to long;'; + errMsg += ' max length is'; + errMsg += ' ' + Extensions[cefExts[ext][0]].len; + reject(new Error(errMsg)); + } + } else { + let errMsg = 'TYPE ERROR:'; + errMsg += ' CEF Key'; + errMsg += ' ' + cefExts[ext][0]; + errMsg += ' value type was expected to be'; + errMsg += ' ' + Extensions[cefExts[ext][0]].type.toLowerCase(); + reject(new Error(errMsg)); + } + } + } + } + resolve(true); + }); + } + /** + * Build a CEF formated string + * @public + * @return {Promise} - String with formated message + */ + buildMessage () { + return new Promise((resolve, reject) => { + let fmtMsg = 'CEF:0'; + fmtMsg += '|' + this.deviceVendor; + fmtMsg += '|' + this.deviceProduct; + fmtMsg += '|' + this.deviceVersion; + fmtMsg += '|' + this.deviceEventClassId; + fmtMsg += '|' + this.name; + fmtMsg += '|' + this.severity; + fmtMsg += '|'; + + const cefExts = Object.entries(this.extensions); + const cefExtsLen = cefExts.length; + for (let ext = 0; ext < cefExtsLen; ext++) { + if (cefExts[ext][1] !== null) { + fmtMsg += cefExts[ext][0] + '=' + cefExts[ext][1] + ' '; + } + } + resolve(fmtMsg); + }); + } + /** + * @public + * @param {Syslog} [options=false] - A {@link module:SyslogPro~Syslog| + * Syslog server connection} that should be used to send messages directly + * from this class. @see SyslogPro~Syslog + */ + send (options) { + return new Promise((resolve, reject) => { + this.buildMessage() + .then((result) => { + if (!this.server) { + this.server = new Syslog(options); + } + this.server.send(result) + .then((sendResult) => { + resolve(sendResult); + }) + .catch((reson) => { + reject(reson); + }); + }); + }); + } +} + +module.exports = { + RgbToAnsi: rgbToAnsi, + RFC3164: RFC3164, + RFC5424:RFC5424, + LEEF: LEEF, + CEF: CEF, + Syslog: Syslog +}; + +``` + + + + diff --git a/docs/docco/docco.css b/docs/docco/docco.css new file mode 100644 index 0000000..b60f6fa --- /dev/null +++ b/docs/docco/docco.css @@ -0,0 +1,518 @@ +/*--------------------- Typography ----------------------------*/ + +@font-face { + font-family: 'aller-light'; + src: url('public/fonts/aller-light.eot'); + src: url('public/fonts/aller-light.eot?#iefix') format('embedded-opentype'), + url('public/fonts/aller-light.woff') format('woff'), + url('public/fonts/aller-light.ttf') format('truetype'); + font-weight: normal; + font-style: normal; +} + +@font-face { + font-family: 'aller-bold'; + src: url('public/fonts/aller-bold.eot'); + src: url('public/fonts/aller-bold.eot?#iefix') format('embedded-opentype'), + url('public/fonts/aller-bold.woff') format('woff'), + url('public/fonts/aller-bold.ttf') format('truetype'); + font-weight: normal; + font-style: normal; +} + +@font-face { + font-family: 'roboto-black'; + src: url('public/fonts/roboto-black.eot'); + src: url('public/fonts/roboto-black.eot?#iefix') format('embedded-opentype'), + url('public/fonts/roboto-black.woff') format('woff'), + url('public/fonts/roboto-black.ttf') format('truetype'); + font-weight: normal; + font-style: normal; +} + +/*--------------------- Layout ----------------------------*/ +html { height: 100%; } +body { + font-family: "aller-light"; + font-size: 14px; + line-height: 18px; + color: #30404f; + margin: 0; padding: 0; + height:100%; +} +#container { min-height: 100%; } + +a { + color: #000; +} + +b, strong { + font-weight: normal; + font-family: "aller-bold"; +} + +p { + margin: 15px 0 0px; +} + .annotation ul, .annotation ol { + margin: 25px 0; + } + .annotation ul li, .annotation ol li { + font-size: 14px; + line-height: 18px; + margin: 10px 0; + } + +h1, h2, h3, h4, h5, h6 { + color: #112233; + line-height: 1em; + font-weight: normal; + font-family: "roboto-black"; + text-transform: uppercase; + margin: 30px 0 15px 0; +} + +h1 { + margin-top: 40px; +} +h2 { + font-size: 1.26em; +} + +hr { + border: 0; + background: 1px #ddd; + height: 1px; + margin: 20px 0; +} + +pre, tt, code { + font-size: 12px; line-height: 16px; + font-family: Menlo, Monaco, Consolas, "Lucida Console", monospace; + margin: 0; padding: 0; +} + .annotation pre { + display: block; + margin: 0; + padding: 7px 10px; + background: #fcfcfc; + -moz-box-shadow: inset 0 0 10px rgba(0,0,0,0.1); + -webkit-box-shadow: inset 0 0 10px rgba(0,0,0,0.1); + box-shadow: inset 0 0 10px rgba(0,0,0,0.1); + overflow-x: auto; + } + .annotation pre code { + border: 0; + padding: 0; + background: transparent; + } + + +blockquote { + border-left: 5px solid #ccc; + margin: 0; + padding: 1px 0 1px 1em; +} + .sections blockquote p { + font-family: Menlo, Consolas, Monaco, monospace; + font-size: 12px; line-height: 16px; + color: #999; + margin: 10px 0 0; + white-space: pre-wrap; + } + +ul.sections { + list-style: none; + padding:0 0 5px 0;; + margin:0; +} + +/* + Force border-box so that % widths fit the parent + container without overlap because of margin/padding. + + More Info : http://www.quirksmode.org/css/box.html +*/ +ul.sections > li > div { + -moz-box-sizing: border-box; /* firefox */ + -ms-box-sizing: border-box; /* ie */ + -webkit-box-sizing: border-box; /* webkit */ + -khtml-box-sizing: border-box; /* konqueror */ + box-sizing: border-box; /* css3 */ +} + + +/*---------------------- Jump Page -----------------------------*/ +#jump_to, #jump_page { + margin: 0; + background: white; + -webkit-box-shadow: 0 0 25px #777; -moz-box-shadow: 0 0 25px #777; + -webkit-border-bottom-left-radius: 5px; -moz-border-radius-bottomleft: 5px; + font: 16px Arial; + cursor: pointer; + text-align: right; + list-style: none; +} + +#jump_to a { + text-decoration: none; +} + +#jump_to a.large { + display: none; +} +#jump_to a.small { + font-size: 22px; + font-weight: bold; + color: #676767; +} + +#jump_to, #jump_wrapper { + position: fixed; + right: 0; top: 0; + padding: 10px 15px; + margin:0; +} + +#jump_wrapper { + display: none; + padding:0; +} + +#jump_to:hover #jump_wrapper { + display: block; +} + +#jump_page_wrapper{ + position: fixed; + right: 0; + top: 0; + bottom: 0; +} + +#jump_page { + padding: 5px 0 3px; + margin: 0 0 25px 25px; + max-height: 100%; + overflow: auto; +} + +#jump_page .source { + display: block; + padding: 15px; + text-decoration: none; + border-top: 1px solid #eee; +} + +#jump_page .source:hover { + background: #f5f5ff; +} + +#jump_page .source:first-child { +} + +/*---------------------- Low resolutions (> 320px) ---------------------*/ +@media only screen and (min-width: 320px) { + .pilwrap { display: none; } + + ul.sections > li > div { + display: block; + padding:5px 10px 0 10px; + } + + ul.sections > li > div.annotation ul, ul.sections > li > div.annotation ol { + padding-left: 30px; + } + + ul.sections > li > div.content { + overflow-x:auto; + -webkit-box-shadow: inset 0 0 5px #e5e5ee; + box-shadow: inset 0 0 5px #e5e5ee; + border: 1px solid #dedede; + margin:5px 10px 5px 10px; + padding-bottom: 5px; + } + + ul.sections > li > div.annotation pre { + margin: 7px 0 7px; + padding-left: 15px; + } + + ul.sections > li > div.annotation p tt, .annotation code { + background: #f8f8ff; + border: 1px solid #dedede; + font-size: 12px; + padding: 0 0.2em; + } +} + +/*---------------------- (> 481px) ---------------------*/ +@media only screen and (min-width: 481px) { + #container { + position: relative; + } + body { + background-color: #F5F5FF; + font-size: 15px; + line-height: 21px; + } + pre, tt, code { + line-height: 18px; + } + p, ul, ol { + margin: 0 0 15px; + } + + + #jump_to { + padding: 5px 10px; + } + #jump_wrapper { + padding: 0; + } + #jump_to, #jump_page { + font: 10px Arial; + text-transform: uppercase; + } + #jump_page .source { + padding: 5px 10px; + } + #jump_to a.large { + display: inline-block; + } + #jump_to a.small { + display: none; + } + + + + #background { + position: absolute; + top: 0; bottom: 0; + width: 350px; + background: #fff; + border-right: 1px solid #e5e5ee; + z-index: -1; + } + + ul.sections > li > div.annotation ul, ul.sections > li > div.annotation ol { + padding-left: 40px; + } + + ul.sections > li { + white-space: nowrap; + } + + ul.sections > li > div { + display: inline-block; + } + + ul.sections > li > div.annotation { + max-width: 350px; + min-width: 350px; + min-height: 5px; + padding: 13px; + overflow-x: hidden; + white-space: normal; + vertical-align: top; + text-align: left; + } + ul.sections > li > div.annotation pre { + margin: 15px 0 15px; + padding-left: 15px; + } + + ul.sections > li > div.content { + padding: 13px; + vertical-align: top; + border: none; + -webkit-box-shadow: none; + box-shadow: none; + } + + .pilwrap { + position: relative; + display: inline; + } + + .pilcrow { + font: 12px Arial; + text-decoration: none; + color: #454545; + position: absolute; + top: 3px; left: -20px; + padding: 1px 2px; + opacity: 0; + -webkit-transition: opacity 0.2s linear; + } + .for-h1 .pilcrow { + top: 47px; + } + .for-h2 .pilcrow, .for-h3 .pilcrow, .for-h4 .pilcrow { + top: 35px; + } + + ul.sections > li > div.annotation:hover .pilcrow { + opacity: 1; + } +} + +/*---------------------- (> 1025px) ---------------------*/ +@media only screen and (min-width: 1025px) { + + body { + font-size: 16px; + line-height: 24px; + } + + #background { + width: 525px; + } + ul.sections > li > div.annotation { + max-width: 525px; + min-width: 525px; + padding: 10px 25px 1px 50px; + } + ul.sections > li > div.content { + padding: 9px 15px 16px 25px; + } +} + +/*---------------------- Syntax Highlighting -----------------------------*/ + +td.linenos { background-color: #f0f0f0; padding-right: 10px; } +span.lineno { background-color: #f0f0f0; padding: 0 5px 0 5px; } +/* + +github.com style (c) Vasily Polovnyov + +*/ + +pre code { + display: block; padding: 0.5em; + color: #000; + background: #f8f8ff +} + +pre .hljs-comment, +pre .hljs-template_comment, +pre .hljs-diff .hljs-header, +pre .hljs-javadoc { + color: #408080; + font-style: italic +} + +pre .hljs-keyword, +pre .hljs-assignment, +pre .hljs-literal, +pre .hljs-css .hljs-rule .hljs-keyword, +pre .hljs-winutils, +pre .hljs-javascript .hljs-title, +pre .hljs-lisp .hljs-title, +pre .hljs-subst { + color: #954121; + /*font-weight: bold*/ +} + +pre .hljs-number, +pre .hljs-hexcolor { + color: #40a070 +} + +pre .hljs-string, +pre .hljs-tag .hljs-value, +pre .hljs-phpdoc, +pre .hljs-tex .hljs-formula { + color: #219161; +} + +pre .hljs-title, +pre .hljs-id { + color: #19469D; +} +pre .hljs-params { + color: #00F; +} + +pre .hljs-javascript .hljs-title, +pre .hljs-lisp .hljs-title, +pre .hljs-subst { + font-weight: normal +} + +pre .hljs-class .hljs-title, +pre .hljs-haskell .hljs-label, +pre .hljs-tex .hljs-command { + color: #458; + font-weight: bold +} + +pre .hljs-tag, +pre .hljs-tag .hljs-title, +pre .hljs-rules .hljs-property, +pre .hljs-django .hljs-tag .hljs-keyword { + color: #000080; + font-weight: normal +} + +pre .hljs-attribute, +pre .hljs-variable, +pre .hljs-instancevar, +pre .hljs-lisp .hljs-body { + color: #008080 +} + +pre .hljs-regexp { + color: #B68 +} + +pre .hljs-class { + color: #458; + font-weight: bold +} + +pre .hljs-symbol, +pre .hljs-ruby .hljs-symbol .hljs-string, +pre .hljs-ruby .hljs-symbol .hljs-keyword, +pre .hljs-ruby .hljs-symbol .hljs-keymethods, +pre .hljs-lisp .hljs-keyword, +pre .hljs-tex .hljs-special, +pre .hljs-input_number { + color: #990073 +} + +pre .hljs-builtin, +pre .hljs-constructor, +pre .hljs-built_in, +pre .hljs-lisp .hljs-title { + color: #0086b3 +} + +pre .hljs-preprocessor, +pre .hljs-pi, +pre .hljs-doctype, +pre .hljs-shebang, +pre .hljs-cdata { + color: #999; + font-weight: bold +} + +pre .hljs-deletion { + background: #fdd +} + +pre .hljs-addition { + background: #dfd +} + +pre .hljs-diff .hljs-change { + background: #0086b3 +} + +pre .hljs-chunk { + color: #aaa +} + +pre .hljs-tex .hljs-formula { + opacity: 0.5; +} diff --git a/docs/docco/index.html b/docs/docco/index.html new file mode 100644 index 0000000..96292a4 --- /dev/null +++ b/docs/docco/index.html @@ -0,0 +1,2699 @@ + + + + + index.js + + + + + +
+
+ +
    + +
  • +
    +

    index.js

    +
    +
    • + + + +
  • +
    + +
    + +
    + +
    + + 
    /** Copyright (c) 2018 Craig Yamato */
+
+/**
+ * @fileoverview The SyslogPro module for sending syslog messages
+ * Most APIs will return a promise. These APIs can be used using 
+ * `then(...)/catch(...)`
+ *
+ * Syslog formating classes can be used as input into a Syslog class to be used 
+ * simultatniusly to the same Syslog server.  The Syslog Class with a configured
+ * Syslog server target can also be used as the input into each of the formating 
+ * classes so that they may run independtly.
+ * @author Craig Yamato <craig@kentik.com>
+ * @copyright (c) 2018 - Craig Yamato
+ * @version 0.1.0
+ * @exports Syslog
+ * @exports LEEF
+ * @exports CEF
+ * @module SyslogPro
+ */
+"use strict";
+const moment = require('moment');
+const os = require("os");
+const dns = require('dns');
+let dnsPromises = dns.promises;
+const fs = require("fs");
+
+/**
+ * Format the ANSI foreground color code from a RGB hex code or ANSI color code
+ * @private
+ * @param {string} hex - The color hex code in the form of #FFFFFF or Number of
+ *     the ANSI color code (30-37 Standard & 0-255 Extended)
+ * @returns {Promise} - The formated ANSI color code
+ * @throws {Error} - A Format Error
+ */
+function rgbToAnsi (hex, extendedColor) {
+  return new Promise((resolve, reject) => {
+    let colorCode = 0;  // Var to hold color code
    + +
    • + + +
  • +
    + +
    + +
    +

    Break HEX Code up into RGB

    + +
    + + 
        const hexParts = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(hex);
+    if (hexParts || typeof hex === 'number') {
+      if (typeof hex === 'number') {
+        if (extendedColor && hex < 256) {
+          resolve(hex);
+        } else if ((hex > 29 && hex < 38) || (hex > 89 && hex < 98)) {
+          resolve(hex);
+        } else {
+          reject (new Error('FORMAT ERROR: Color code not in range')); 
+        }
+      } else {
+        const r = parseInt(hexParts[1], 16);
+        const g = parseInt(hexParts[2], 16);
+        const b = parseInt(hexParts[3], 16);
+        if (extendedColor) {
+          if (r === g && g === b) {
    + +
    • + + +
  • +
    + +
    + +
    +

    Gray Scale Color

    + +
    + + 
      	        if (r < 8) {
+  		        colorCode = 16;
+  	        } else if (r > 248) {
+  		        colorCode = 231;
+  	        } else {
+  	          colorCode = Math.round(((r - 8) / 247) * 24) + 232;
+  	        }
+          } else {
+            colorCode = 16
+  	            + (36 * Math.round(r / 255 * 5))
+  	            + (6 * Math.round(g / 255 * 5))
+  	            + Math.round(b / 255 * 5);
+          }
+        } else {
+          colorCode = 30;
+          const red = r / 255;
+          const green = g / 255;
+          const blue = b / 255;
+          let v = Math.max(red, green, blue) * 100;
+          v = Math.round(v / 50);
+          if (v === 1) {
+            colorCode += ((Math.round(b / 255) << 2)
+                | (Math.round(g / 255) << 1)
+                | Math.round(r / 255));
+          }
+          if (v === 2) {
+            colorCode += 60;
+          }
+        }
+      }
+      resolve(colorCode);
+      return;
+    } else {
+      reject(new Error('TYPE ERROR: Not in RGB color hex or color code'));
+      return;
+    }
+  });
+}
+
+/**
+ * A class to work with syslog messages using UDP, TCP, or TLS transport.  
+ * There is suport for Syslog message formating RFC-3164, RFC-5424 including 
+ * Structured Data, IBM LEEF (Log Event Extended Format), and HP CEF (Common
+ * Event Format).
+ * Syslog formating classes can be used as input into a Syslog class to be used 
+ * simultatniusly to the same Syslog server. * 
+ * @requires moment
+ * @version 0.0.0
+ * @since 0.0.0
+ */
+class Syslog {
+  /**
+   * Construct a new Syslog transport object with user options 
+   * @public
+   * @version 0.0.0
+   * @since 0.0.0
+   * @this Syslog
+   * @param {object} [options] - Options object
+   * >>>Transport Configuraton
+   * @param {string} [options.target='localhost'] - The IP Address|FQDN of the 
+   *    Syslog Server, this option if set will take prasdents over any target 
+   *    set in a formating object
+   * @param {string} [options.protocol='udp'] - L4 transport portocol 
+   *    (udp|tcp|tls), this option if set will take prasdents over any transport 
+   *    set in a formating object
+   * @param {number} [options.port=514] - IP port, this option if set will take 
+   *    prasdents over any IP Port set in a formating object
+   * @param {number} [options.tcpTimeout=10000] - Ignored for all other 
+   *    transports, this option if set will take prasdents over any timeout 
+   *    set in a formating object
+   * @param {string[]} [options.tlsServerCerts] - Array of authrized TLS server
+   *    certificates file locations, this option if set will take prasdents 
+   *    over any certificates set in a formating object
+   * @param {string} [options.tlsClientCert] - Client TLS certificate file 
+   *    location that this client should use, this option if set will take 
+   *    prasdents over any certificates set in a formating object
+   * @param {string} [options.tlsClientKey] - Client TLS key file 
+   *    location that this client should use, this option if set will take 
+   *    prasdents over any certificates set in a formating object
+   * >>>Syslog Format Settings
+   * @param {string} [options.format='none'] - Valid syslog format options for 
+   *    this module are 'none', 'rfc3164', 'rfc5424', 'leef', 'cef'
+   * @param {RFC3164} [options.rfc5424] - {@link module:SyslogPro~RFC5424|
+   *    RFC5424 related settings}
+   * @param {RFC5424} [options.rfc5424] - {@link module:SyslogPro~RFC5424|
+   *    RFC5424 related settings}
+   * @param {LEEF} [options.leef] - {@link module:SyslogPro~LEEF|IBM LEEF 
+   *    (Log Event Extended Format) object} 
+   * @param {CEF} [options.cef] - {@link module:SyslogPro~CEF|HP CEF 
+   *    (Common Event Format) formating object} 
+   */
+  constructor (options) {
+    this.constructor__ = true;
+    if (!options) {
+      options = {};
+    }
    + +
    • + + +
  • +
    + +
    + +
    +

    Basic transport setup

    + +
    + + 
        /** @type {string} */
+    this.target = options.target || 'localhost';
+    /** @type {string} */
+    this.protocol = options.protocol || 'udp';
+    this.protocol = this.protocol.toLowerCase();
+    /** @type {number} */
+    this.port = options.port || 514;
+    /** @type {number} */
+    this.tcpTimeout = options.tcpTimeout || 10000;
+    if ((typeof options.tlsServerCerts === 'object' 
+        && Array.isArray(options.tlsServerCerts))
+        || typeof options.tlsServerCerts === 'string') {
+      this.addTlsServerCerts(options.tlsServerCerts);  
+    } else {
+      /** @type {string[]} */
+      this.tlsServerCerts = [];
+    }
+    if (options.tlsClientCert) {
+      /** @type {string} */
+      this.tlsClientCert = options.tlsClientCert; 
+    }
+    if (options.tlsClientKey) {
+      /** @type {string} */
+      this.tlsClientKey = options.tlsClientKey; 
+    }
    + +
    • + + +
  • +
    + +
    + +
    +

    Syslog Format

    + +
    + + 
        if (typeof options.format === 'string') {
+      /** @type {string} */
+      this.format = options.format.toLowerCase();
+    } else {
+      this.format = options.format || 'none';
+    }
+    if (options.rfc3164) {
+      if (options.rfc3164.constructor__) {
+        /** @type {RFC3164} */
+        this.rfc3164 = options.rfc3164;
+      } else {
+        this.rfc3164 = new RFC3164(options);
+      }
+    }
+    if (options.rfc5424) {
+      if (options.rfc5424.constructor__) {
+        /** @type {RFC5424} */
+        this.rfc5424 = options.rfc5424;
+      } else {
+        this.rfc5424 = new RFC5424(options);
+      }
+    }
+    if (options.leef) {
+      if (options.leef.constructor__) {
+        /** @type {LEEF} */
+        this.leef = options.leef;
+      } else {
+        this.leef = new LEEF(options);
+      }
+    }
+    if (options.cef) {
+      if (options.cef.constructor__) {
+        /** @type {CEF} */
+        this.cef = options.cef;
+      } else {
+        this.cef = new CEF(options);
+      }
+    }
+    if (this.format === 'rfc3164' && !this.rfc3164) {
+      this.rfc3164 = new RFC3164();
+    }
+    if (this.format === 'rfc5424' && !this.rfc5424) {
+      this.rfc5424 = new RFC5424();
+    }
+    if (this.format === 'leef' && !this.leef) {
+      this.leef = new LEEF();
+    }
+    if (this.format === 'cef' && !this.cef) {
+      this.cef = new CEF();
+    }
+  }
+  
+  /**
+   * Add a TLS server certificate which can be used to authentacat the server 
+   * this syslog client is connecting too.  This function will valadate the
+   * input as a file location straing and add it to an array of certificates
+   * @private
+   * @version 0.0.0
+   * @since 0.0.0
+   * @param {string|string[]} certs - File location of the certificate(s)
+   * @returns {Promise} - True
+   * @throws {Error} - A Type Error
+   */
+  addTlsServerCerts (certs) {
+    return new Promise((resolve, reject) => {
+      if (typeof certs === 'object' && Array.isArray(certs)) {
+        /** @private @type {string[]} */
+        this.tlsServerCerts = certs;
+      } else if (typeof certs === 'string') {
+        this.tlsServerCerts = [certs];
+      } else {
+        let errMsg = 'TYPE ERROR: Server Cert file loctions shoudl be a string';
+        errMsg += ' or array of strings';
+        reject(new Error(errMsg));
+      }
+      resolve(true);
+    });
+  }
+  /**
+   * Send the Syslog message over UDP
+   * @private
+   * @param {string} msg - The formated Syslog Message
+   * @returns {Promise} - The Syslog formated string sent
+   * @throws {Error} - Network Error
+   */
+  udpMessage (msg) {
+    return new Promise((resolve, reject) => {
+      const dgram = require('dgram');// Test for target DNS and Address Family (IPv4/6) by looking up the DNS
+      const dnsOptions = {
+        verbatim: true
+      };
+      dnsPromises.lookup(this.target, dnsOptions)
+          .then((result) => {
+            const udpType = result.family === 4 ? 'udp4' : 'udp6';
+            let client = dgram.createSocket(udpType);
    + +
    • + + +
  • +
    + +
    + +
    +

    Turn msg in to a UTF8 buffer

    + +
    + + 
                let msgBuffer = Buffer.from(msg, 'utf8');
+            client.send(msgBuffer, this.port, this.target, (error) => {
+              client.close();
+              resolve(msg);
+            });
+          })
+          .catch((error) => {
+            reject(error); // Reject out of the sendMessage function promise
+          });
+    });
+  }
+  /**
+   * Send the Syslog message over TCP
+   * @private
+   * @param {string} msg - The formated Syslog Message
+   * @returns {Promise} - The Syslog formated string sent
+   * @throws {Error} - Timeout error for TCP and TLS connections
+   * @throws {Error} - Network Error
+   */
+  tcpMessage (msg) {
+    return new Promise((resolve, reject) => {
+      const net = require('net');
+      const dnsOptions = {
+        verbatim: true
+      };
+      dnsPromises.lookup(this.target, dnsOptions)
+          .then((result) => {
+            const tcpOptions = {
+              host: this.target,
+              port: this.port,
+              family: result.family
+            };
+            const client = net.createConnection(tcpOptions, () => {
    + +
    • + + +
  • +
    + +
    + +
    +

    Turn msg in to a UTF8 buffer

    + +
    + + 
                  let msgBuffer = Buffer.from(msg, 'utf8');
+              client.write(msgBuffer, () => {
+                client.end();
+              });
+            });
+            client.setTimeout(this.tcpTimeout);
+            client.on('end', () => {
+              resolve(msg);
+            });
+            client.on('timeout', () => {
+              client.end();
+              reject(new Error('TIMEOUT ERROR: Syslog server TCP timeout'));
+            });
+            client.on('error', (error) => {
+              client.destroy();
+              reject(error);
+            });
+          })
+          .catch((error) => {
+            reject(error);
+          });
+    });
+  }
+  /**
+   * Send the Syslog message over TLS
+   * @private
+   * @param {string} msg - The formated Syslog Message
+   * @returns {Promise} - The Syslog formated string sent
+   * @throws {Error} - Timeout error for TCP and TLS connections
+   * @throws {Error} - Network Error
+   */
+  tlsMessage (msg) {
+    return new Promise((resolve, reject) => {
+      const tls = require('tls');
+      const tlsOptions = {
+        host: this.target,
+        port: this.port,
+      };
    + +
    • + + +
  • +
    + +
    + +
    +

    Load client cert and key if requested

    + +
    + + 
          if (typeof this.tlsClientKey === 'string' 
+          && typeof this.tlsClientCert === 'string') {
+        tlsOptions.key = fs.readFileSync(this.tlsClientKey);
+        tlsOptions.cert = fs.readFileSync(this.tlsClientCert);      
+      } else if (typeof this.tlsClientKey !== 'string' 
+          && typeof this.tlsClientKey !== 'undefined') {
+        let errMsg = 'TYPE ERROR: TLS Client Key is not a file';
+        errMsg += 'location string';
+        reject(new Error(errMsg));
+        return;
+      } else if (typeof this.tlsClientCert !== 'string' 
+          && typeof this.tlsClientCert !== 'undefined') {
+        let errMsg = 'TYPE ERROR: TLS Client Cert is not a file';
+        errMsg += 'location string';
+        reject(new Error(errMsg));
+        return;
+      }
    + +
    • + + +
  • +
    + +
    + +
    +

    Load any server certs if provided

    + +
    + + 
          let tlsCerts = this.tlsServerCerts.length;
+      if (tlsCerts > 0) {
+        let tlsOptionsCerts = [];
+        for (let certIndex=0; certIndex<tlsCerts; certIndex++) {
+          if (typeof this.tlsServerCerts[certIndex] !== 'string') {
+            let errMsg = 'TYPE ERROR: TLS Server Cert is not a file';
+            errMsg += 'location string';
+            reject(new Error(errMsg));
+          }
+          let cert = fs.readFileSync(this.tlsServerCerts[certIndex]);
+          tlsOptionsCerts.push(cert);
+        }
+        tlsOptions.ca = tlsOptionsCerts;
+        tlsOptions.rejectUnauthorized = true;
+      }
+      const client = tls.connect(tlsOptions, () => {
    + +
    • + + +
  • +
    + +
    + +
    +

    Turn msg in to a UTF8 buffer

    + +
    + + 
            let msgBuffer = Buffer.from(msg, 'utf8');
+        client.write(msgBuffer, () => {
+          client.end();
+        });
+      });
+      client.setTimeout(this.tcpTimeout);
    + +
    • + + +
  • +
    + +
    + +
    +

    client.on(‘data’, (data) => {});

    + +
    + + 
          client.on('end', () => {
+        resolve(msg);
+      });
+      client.on('timeout', () => {
+        client.end();
+        reject(new Error('TIMEOUT ERROR: Syslog server TLS timeout'));
+      });
+      client.on('error', (error) => {
+        client.destroy();
+        reject(error);
+      });   
+    });
+  }
+  /**
+   * Send the Syslog message to the selected target Syslog server using the 
+   * selected transport.
+   * @private
+   * @param {string} msg - The formated Syslog Message
+   * @returns {Promise} - The Syslog formated string sent
+   * @throws {Error} - Timeout error for TCP and TLS connections
+   * @throws {Error} - Network Error
+   */
+  send (msg) {
+    return new Promise((resolve, reject) => {
+      if (typeof msg !== 'string') {
+        reject(new Error("TYPE ERROR: Syslog message must be a string"));
+        return;
+      }
+      this.protocol = this.protocol.toLowerCase();
+      if (this.protocol === 'udp') {
+        this.udpMessage(msg)
+            .then((result) => {
+              resolve(result);
+            })
+            .catch((reson) => {
+              reject(reson);
+            });
+      } else if (this.protocol === 'tcp') {
+        this.tcpMessage(msg)
+            .then((result) => {
+              resolve(result);
+            })
+            .catch((reson) => {
+              reject(reson);
+            });
+      } else if (this.protocol === 'tls') {
+        this.tlsMessage(msg)
+            .then((result) => {
+              resolve(result);
+            })
+            .catch((reson) => {
+              reject(reson);
+            });
+      } else {
+        let errorMsg = 'FORMAT ERROR: Protocol not reconized, should be ';
+        errorMsg += 'udp|tcp|tls';
+        reject(new Error(errorMsg));
+      }
+    });
+  }
+}
+ 
+/**
+ * A class to work with RFC3164 formated syslog messages. The meesaging is fully configurabule and Ansi foreground 
+ * colors can be added.  Both ANSI 8 and ANSI 256 color are fully suported.
+ * Most APIs will return a promise. These APIs can be used using 
+ * `then(...)/catch(...)`
+ * 
+ * A Syslog class with a configured
+ * Syslog server target can also be used as the input into the formating 
+ * classes so that it may run independtly.
+ * 
+ * The RFC3164 Syslog logging format is ment to be used as a stream of log data 
+ * from a service or applacation. This class is designed to be used in this
+ * fashion where new messages are writen to the class as needed.
+ * @requires moment
+ * @version 0.0.0
+ * @since 0.0.0
+ */
+class RFC3164 {
+  /**
+   * Construct a new RFC3164 formated Syslog object with user options 
+   * @public
+   * @this RFC3164
+   * @param {object} [options] - Options object
+   * @param {string} [options.applacationName='NodeJSLogger'] - Applacation
+   * @param {string} [options.hostname=os.hostname] - The name of this server
+   * @param {number} [options.facility=23] - Facility code to use sending this 
+   *    message 
+   * @param {boolean} [options.color=false] - Apply color coding encoding tag 
+   *    with syslog message text 
+   * @param {boolean} [options.extendedColor=false] - Use the extedned ANSI 
+   *    color set encoding tag with syslog message text 
+   * @param {object} [options.colors] - User defended colors for 
+   *    severites
+   * @param {string} [options.colors.emergencyColor] - A RGB Hex coded color in the form 
+   *    of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 
+   *    Extended)
+   * @param {string} [options.colors.alertColor] - A RGB Hex coded color in the form 
+   *    of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 
+   *    Extended)
+   * @param {string} [options.colors.criticalColor] - A RGB Hex coded color in the form 
+   *    of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 
+   *    Extended)
+   * @param {string} [options.colors.errorColor] - A RGB Hex coded color in the form 
+   *    of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 
+   *    Extended)
+   * @param {string} [options.colors.warningColor] - A RGB Hex coded color in the form 
+   *    of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 
+   *    Extended)
+   * @param {string} [options.colors.noticeColor] - A RGB Hex coded color in the form 
+   *    of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 
+   *    Extended)
+   * @param {string} [options.colors.informationalColor] - A RGB Hex coded color in the form 
+   *    of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 
+   *    Extended)
+   * @param {string} [options.colors.debugColor] - A RGB Hex coded color in the form 
+   *    of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 
+   *    Extended)
+   * @param {Syslog} [options.server=false] - A {@link module:SyslogPro~Syslog|
+   *    Syslog server connection} that should be used to send messages directly 
+   *    from this class. @see SyslogPro~Syslog
+   */
+  constructor (options) {
+    /** @private @type {boolean} */
+    this.constructor__ = true;
+    options = options || {};
+    this.hostname = options.hostname || os.hostname();
+    this.applacationName = options.applacationName || '';
+    this.facility = options.facility || 23;
+    if (options.color) {
+      /** @type {boolean} */
+      this.color = true;
+    } else {
+      this.color = false;
+    }
+    if (options.extendedColor) {
+      /** @type {boolean} */
+      this.extendedColor = true;
+    } else {
+      this.extendedColor = false;
+    }
+    if (options.server) {
+      if (!options.server.constructor__) {
+        /** @private @type {Syslog} */
+        this.server = new Syslog(options.server);
+      } else {
+        this.server = options.server;
+      }
+    }
+    if (this.extendedColor) {
+      /** @private @type {number} */
+      this.emergencyColor = 1; // Red foreground color
+      /** @private @type {number} */
+      this.alertColor = 202; // Dark Orange foreground color
+      /** @private @type {number} */
+      this.criticalColor = 208; // Orange foreground color
+      /** @private @type {number} */
+      this.errorColor = 178; // Light Orange foreground color
+      /** @private @type {number} */
+      this.warningColor = 226; // Yellow foreground color
+      /** @private @type {number} */
+      this.noticeColor = 117; // Light Blue foreground color
+      /** @private @type {number} */
+      this.informationalColor = 45; // Blue foreground color
+      /** @private @type {number} */
+      this.debugColor = 27; // Dark Blue foreground color
+    } else {
+      this.emergencyColor = 31; // Red foreground color
+      this.alertColor = 31; // Red foreground color
+      this.criticalColor = 31; // Red foreground color
+      this.errorColor = 33; // Yellow foreground color
+      this.warningColor = 33; // Yellow foreground color
+      this.noticeColor = 36; // Blue foreground color
+      this.informationalColor = 36; // Blue foreground color
+      this.debugColor = 34; // Dark Blue foreground color
+    }
+    if (typeof options.colors === 'object') {
+      this.setColor(options.colors, this.extendedColor);
+    }
+  }
+  /**
+   * Sets the color to be used for messages at a set priority
+   * @public   
+   * @param {string} [colors.emergencyColor] - A RGB Hex coded color in the form 
+   *    of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 
+   *    Extended)
+   * @param {string} [colors.alertColor] - A RGB Hex coded color in the form 
+   *    of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 
+   *    Extended)
+   * @param {string} [colors.criticalColor] - A RGB Hex coded color in the form 
+   *    of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 
+   *    Extended)
+   * @param {string} [colors.errorColor] - A RGB Hex coded color in the form 
+   *    of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 
+   *    Extended)
+   * @param {string} [colors.warningColor] - A RGB Hex coded color in the form 
+   *    of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 
+   *    Extended)
+   * @param {string} [colors.noticeColor] - A RGB Hex coded color in the form 
+   *    of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 
+   *    Extended)
+   * @param {string} [colors.informationalColor] - A RGB Hex coded color in the form 
+   *    of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 
+   *    Extended)
+   * @param {string} [colors.debugColor] - A RGB Hex coded color in the form 
+   *    of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 
+   *    Extended)
+   * @throws {Error} A standard error object
+   */
+  setColor (colors, extendedColor) {
+    return new Promise((resolve, reject) => {
+      let colorPromises = [];
+      if (colors.emergencyColor) {
+        colorPromises.push(
+            new Promise((resolve,reject) => {
+              rgbToAnsi(colors.emergencyColor, this.extendedColor)
+                  .then((result) => {
+                    this.emergencyColor = result;
+                    resolve(true);
+                  })
+                  .catch((reson) => {
+                    reson.message = 'TYPE ERROR: '; 
+                    reson.message += 'emergencyColor';
+                    reson.message += ' Not in RGB color hex or color code';
+                    reject(reson);
+                  });
+        }));
+      }
+      if (colors.alertColor) {
+        colorPromises.push(
+            new Promise((resolve,reject) => {
+              rgbToAnsi(colors.alertColor, this.extendedColor)
+                  .then((result) => {
+                    this.alertColor = result;
+                    resolve(true);
+                  })
+                  .catch((reson) => {
+                    reson.message = 'TYPE ERROR: '; 
+                    reson.message += 'alertColor';
+                    reson.message += ' Not in RGB color hex or color code';
+                    reject(reson);
+                  });
+        }));
+      }
+      if (colors.criticalColor) {
+        colorPromises.push(
+            new Promise((resolve,reject) => {
+              rgbToAnsi(colors.criticalColor, this.extendedColor)
+                  .then((result) => {
+                    this.criticalColor = result;
+                    resolve(true);
+                  })
+                  .catch((reson) => {
+                    reson.message = 'TYPE ERROR: '; 
+                    reson.message += 'criticalColor';
+                    reson.message += ' Not in RGB color hex or color code';
+                    reject(reson);
+                  });
+        }));
+      }
+      if (colors.errorColor) {
+        colorPromises.push(
+            new Promise((resolve,reject) => {
+              rgbToAnsi(colors.errorColor, this.extendedColor)
+                  .then((result) => {
+                    this.errorColor = result;
+                    resolve(true);
+                  })
+                  .catch((reson) => {
+                    reson.message = 'TYPE ERROR: '; 
+                    reson.message += 'errorColor';
+                    reson.message += ' Not in RGB color hex or color code';
+                    reject(reson);
+                  });
+        }));
+      }
+      if (colors.warningColor) {
+        colorPromises.push(
+            new Promise((resolve,reject) => {
+              rgbToAnsi(colors.warningColor, this.extendedColor)
+                  .then((result) => {
+                    this.warningColor = result;
+                    resolve(true);
+                  })
+                  .catch((reson) => {
+                    reson.message = 'TYPE ERROR: '; 
+                    reson.message += 'warningColor';
+                    reson.message += ' Not in RGB color hex or color code';
+                    reject(reson);
+                  });
+        }));
+      }
+      if (colors.noticeColor) {
+        colorPromises.push(
+            new Promise((resolve,reject) => {
+              rgbToAnsi(colors.noticeColor, this.extendedColor)
+                  .then((result) => {
+                    this.noticeColor = result;
+                    resolve(true);
+                  })
+                  .catch((reson) => {
+                    reson.message = 'TYPE ERROR: '; 
+                    reson.message += 'noticeColor';
+                    reson.message += ' Not in RGB color hex or color code';
+                    reject(reson);
+                  });
+        }));
+      }
+      if (colors.informationalColor) {
+        colorPromises.push(
+            new Promise((resolve,reject) => {
+              rgbToAnsi(colors.informationalColor, this.extendedColor)
+                  .then((result) => {
+                    this.informationalColor = result;
+                    resolve(true);
+                  })
+                  .catch((reson) => {
+                    reson.message = 'TYPE ERROR: '; 
+                    reson.message += 'informationalColor';
+                    reson.message += ' Not in RGB color hex or color code';
+                    reject(reson);
+                  });
+        }));
+      }
+      if (colors.debugColor) {
+        colorPromises.push(
+            new Promise((resolve,reject) => {
+              rgbToAnsi(colors.debugColor, this.extendedColor)
+                  .then((result) => {
+                    this.debugColor = result;
+                    resolve(true);
+                  })
+                  .catch((reson) => {
+                    reson.message = 'TYPE ERROR: '; 
+                    reson.message += 'debugColor';
+                    reson.message += ' Not in RGB color hex or color code';
+                    reject(reson);
+                  });
+        }));
+      }
+      Promise.all(colorPromises)
+          .then((results) => {
+            resolve(true);
+          })
+          .catch((reson) => {
+            reject(reson);
+          });
+    });
+  }
+  /**
+   * Building a formated message.  Returns a promise with a formated message 
+   * @public
+   * @param {string} msg - The Syslog Message
+   * @param {object} [options] - Options object
+   * @param {number} [options.severity=7] - An array of structure 
+   * @param {number} [options.colorCode=36] - The ANSI color code to use if 
+   *    message coloration is selected
+   * @returns {Promise} A Syslog formated string acording to the selected RFC
+   * @throws {Error} A standard error object
+   */
+  buildMessage (msg, options) {
+    return new Promise((resolve, reject) => {
+      options = options || {};
+      let severity = typeof options.severity === 'number' ? 
+          options.severity : 6;
+      if (typeof msg !== 'string' || options.msgSeverity > 7) {
+        let errMsg = 'FORMAT ERROR: Syslog message must be a string';
+        errMsg += ' msgSeverity must be a number between 0 and 7';
+        reject(new Error(errMsg));
+        return;
+      }
+      let fmtMsg = ''; // Formated Syslog message string var
+      const newLine = '\n';
+      const newLineRegEx = /(\r|\n|(\r\n))/;
+      const escapeCode = '\u001B';
+      const resetColor = '\u001B[0m';
    + +
    • + + +
  • +
    + +
    + +
    +

    The PRI is common to both RFC formats

    + +
    + + 
          const pri = (this.facility * 8) + severity;
    + +
    • + + +
  • +
    + +
    + +
    +

    Remove any newline character

    + +
    + + 
          msg = msg.replace(newLineRegEx, '');
    + +
    • + + +
  • +
    + +
    + +
    +

    Add requested color

    + +
    + + 
          if (this.color) {
+        options.msgColor = options.msgColor || 36;
+        let colorCode = '[';
+        if (this.extendedColor) {
+          colorCode += '38;5;'; // Extended 256 Colors ANSI Code
+        }
+        if (typeof options.msgColor === 'number') {
+          colorCode += options.msgColor;
+          colorCode += 'm'; // ANSI Color Closer
+        } else {
+          colorCode = '[39m';  // Use terminal's defualt color
+        }
+        msg = escapeCode + colorCode + msg + resetColor;
+      }
    + +
    • + + +
  • +
    + +
    + +
    +

    RegEx to find a leading 0 in the day of a DateTime for RFC3164 +RFC3164 uses BSD timeformat

    + +
    + + 
          const rfc3164DateRegEx = /((A|D|F|J|M|N|O|S)(a|c|e|p|o|u)(b|c|g|l|n|p|r|t|v|y)\s)0(\d\s\d\d:\d\d:\d\d)/;
+      const timestamp = moment()
+          .format('MMM DD hh:mm:ss')
+          .replace(rfc3164DateRegEx, '$1 $5');
    + +
    • + + +
  • +
    + +
    + +
    +

    Build message

    + +
    + + 
          fmtMsg = '<' + pri + '>';
+      fmtMsg += timestamp;
+      fmtMsg += ' ' + this.hostname;
+      fmtMsg += ' ' + this.applacationName;
+      fmtMsg += ' ' + msg;
+      fmtMsg += newLine;
+      resolve(fmtMsg);
+    });
+  }
+  /**
+   * send a RFC5424 formated message.  Returns a promise with the formated 
+   *    message that was sent.  If no server connection was defined when the 
+   *    class was created a defualt Syslog connector will be used.  
+   *    @see SyslogPro~Syslog
+   * @public
+   * @param {string} msg - The unformated Syslog message to send
+   * @param {object} [options] - Options object
+   * @param {number} [options.severity=7] - An array of structure 
+   * @param {number} [options.colorCode=36] - The ANSI color code to use if 
+   * @returns {Promise} A Syslog formated string acording to the selected RFC
+   * @throws {Error} A standard error object
+   */
+  send (msg, options) {
+    return new Promise((resolve, reject) => {
+      if (!this.server) {
+        this.server = new Syslog();
+      }
+      this.buildMessage(msg, options)
+        .then((result) => {
+          this.server.send(result)
+            .then((sendResult) => {
+              resolve(sendResult);
+            })
+            .catch((error) => {
+              reject(error);
+            });
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  } 
+  /**
+   * Send a syslog message with a secerity level of 0 (Emergency)
+   * @public
+   * @param {string} msg - The emergancy message to send to the Syslog server
+   * @returns {Promise} - The formated syslog message sent to the Syslog server
+   * @throws {Error} - Any bubbled up error
+   */
+  emergency (msg) {
+    return this.send(msg, {
+      severity: 0, 
+      colorCode: this.emergencyColor
+    });
+  }
+  /**
+   * Send a syslog message with a secerity level of 0 (Emergency)
+   * @public
+   * @param {string} msg - The emergancy message to send to the Syslog server
+   * @returns {Promise} - The formated syslog message sent to the Syslog server
+   * @throws {Error} - Any bubbled up error
+   */
+  emer (msg) {
+    return this.emergency(msg);
+  }
+  /**
+   * Send a syslog message with a secerity level of 1 (Alert)
+   * @public
+   * @param {string} msg - The alert message to send to the Syslog server
+   * @returns {Promise} - The formated syslog message sent to the Syslog server
+   * @throws {Error} - Any bubbled up error
+   */
+  alert (msg) {
+    return this.send(msg, {
+      severity: 1, 
+      colorCode: this.alertColor
+    });
+  }
+  /**
+   * Send a syslog message with a secerity level of 2 (Critical)
+   * @public
+   * @param {string} msg - The critical message to send to the Syslog server
+   * @returns {Promise} - The formated syslog message sent to the Syslog server
+   * @throws {Error} - Any bubbled up error
+   */
+  critical (msg) {
+    return this.send(msg, {
+      severity: 2, 
+      colorCode: this.criticalColor
+    });
+  }
+  /**
+   * Send a syslog message with a secerity level of 2 (Critical)
+   * @public
+   * @param {string} msg - The critical message to send to the Syslog server
+   * @returns {Promise} - The formated syslog message sent to the Syslog server
+   * @throws {Error} - Any bubbled up error
+   */
+  crit (msg) {
+    return this.critical(msg);
+  }
+  /**
+   * Send a syslog message with a secerity level of 3 (Error)
+   * @public
+   * @param {string} msg - The error message to send to the Syslog server
+   * @returns {Promise} - The formated syslog message sent to the Syslog server
+   * @throws {Error} - Any bubbled up error
+   */
+  error (msg) {
+    return this.send(msg, {
+      severity: 3, 
+      colorCode: this.errorColor
+    });
+  }
+  /**
+   * Send a syslog message with a secerity level of 3 (Error)
+   * @public
+   * @param {string} msg - The error message to send to the Syslog server
+   * @returns {Promise} - The formated syslog message sent to the Syslog server
+   * @throws {Error} - Any bubbled up error
+   */
+  err (msg) {
+    return this.error(msg);
+  }
+  /**
+   * Send a syslog message with a secerity level of 4 (Warning)
+   * @public
+   * @param {string} msg - The warning message to send to the Syslog server
+   * @returns {Promise} - The formated syslog message sent to the Syslog server
+   * @throws {Error} - Any bubbled up error
+   */
+  warning (msg) {
+    return this.send(msg, {
+      severity: 4, 
+      colorCode: this.warningColor
+    });
+  }
+  /**
+   * Send a syslog message with a secerity level of 4 (Warning)
+   * @public
+   * @param {string} msg - The warning message to send to the Syslog server
+   * @returns {Promise} - The formated syslog message sent to the Syslog server
+   * @throws {Error} - Any bubbled up error
+   */
+  warn (msg) {
+    return this.warning(msg);
+  }
+  /**
+   * Send a syslog message with a secerity level of 5 (Notice)
+   * @public
+   * @param {string} msg - The notice message to send to the Syslog server
+   * @returns {Promise} - The formated syslog message sent to the Syslog server
+   * @throws {Error} - Any bubbled up error
+   */
+  notice (msg) {
+    return this.send(msg, {
+      severity: 5, 
+      colorCode: this.noticeColor
+    });
+  }
+  /**
+   * Send a syslog message with a secerity level of 5 (Notice)
+   * @public
+   * @param {string} msg - The notice message to send to the Syslog server
+   * @returns {Promise} - The formated syslog message sent to the Syslog server
+   * @throws {Error} - Any bubbled up error
+   */
+  note (msg) {
+    return this.notice(msg);
+  }
+  /**
+   * Send a syslog message with a secerity level of 6 (Informational)
+   * @public
+   * @param {string} msg - The informational message to send to the Syslog server
+   * @returns {Promise} - The formated syslog message sent to the Syslog server
+   * @throws {Error} - Any bubbled up error
+   */
+  informational (msg) {
+    return this.send(msg, {
+      severity: 6, 
+      colorCode: this.informationalColor
+    });
+  }
+  /**
+   * Send a syslog message with a secerity level of 6 (Informational)
+   * @public
+   * @param {string} msg - The informational message to send to the Syslog server
+   * @returns {Promise} - The formated syslog message sent to the Syslog server
+   * @throws {Error} - Any bubbled up error
+   */
+  info (msg) {
+    return this.informational(msg);
+  }
+  /**
+   * Send a syslog message with a secerity level of 6 (Informational)
+   * @public
+   * @param {string} msg - The informational message to send to the Syslog server
+   * @returns {Promise} - The formated syslog message sent to the Syslog server
+   * @throws {Error} - Any bubbled up error
+   */
+  log (msg) {
+    return this.informational(msg);
+  }
+  /**
+   * Send a syslog message with a secerity level of 7 (Debug)
+   * @public
+   * @param {string} msg - The debug message to send to the Syslog server
+   * @returns {Promise} - The formated syslog message sent to the Syslog server
+   * @throws {Error} - Any bubbled up error
+   */
+  debug (msg) {
+    return this.send(msg, {
+      severity: 7, 
+      colorCode: this.debugColor
+    });
+  }
+}
+
+/**
+ * A class to work with RFC5424 formated syslog messages. The meesaging is fully configurabule and Ansi foreground 
+ * colors can be added.  Both ANSI 8 and ANSI 256 color are fully suported.
+ * Most APIs will return a promise. These APIs can be used using 
+ * `then(...)/catch(...)`
+ * 
+ * A Syslog class with a configured
+ * Syslog server target can also be used as the input into the formating 
+ * classes so that it may run independtly.
+ * 
+ * The RFC5424 Syslog logging format is ment to be used as a stream of log data 
+ * from a service or applacation. This class is designed to be used in this
+ * fashion where new messages are writen to the class as needed.
+ * @requires moment
+ * @version 0.0.0
+ * @since 0.0.0
+ */
+class RFC5424 {
+  /**
+   * Construct a new RFC5424 formated Syslog object with user options 
+   * @public
+   * @this RFC5424
+   * @param {object} [options] - Options object
+   * @param {string} [options.applacationName='NodeJSLogger'] - Applacation
+   * @param {string} [options.hostname=os.hostname] - The name of this server
+   * @param {boolean} [options.timestamp=false] - Included a Timestamp
+   * @param {boolean} [options.timestampUTC=false] - RFC tandard is for 
+   *    local time
+   * @param {boolean} [options.timestampMS=false] - Timestamp with ms 
+   *    resoltuion
+   * @param {boolean} [options.timestampTZ=true] - Should the timestamp
+   *    included timezone
+   * @param {boolean} [options.encludeStructuredData=false] - Included 
+   *    any provided structured data
+   * @param {boolean} [options.utf8BOM=true] - Included the UTF8 
+   * @param {boolean} [options.color=false] - Included the UTF8 
+   * @param {boolean} [options.extendedColor=false] - Included the UTF8 
+   *    encoding tag with syslog message text 
+   * @param {object} [options.colors] - User defended colors for 
+   *    severites
+   * @param {string} [options.colors.emergencyColor] - A RGB Hex coded color in the form 
+   *    of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 
+   *    Extended)
+   * @param {string} [options.colors.alertColor] - A RGB Hex coded color in the form 
+   *    of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 
+   *    Extended)
+   * @param {string} [options.colors.criticalColor] - A RGB Hex coded color in the form 
+   *    of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 
+   *    Extended)
+   * @param {string} [options.colors.errorColor] - A RGB Hex coded color in the form 
+   *    of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 
+   *    Extended)
+   * @param {string} [options.colors.warningColor] - A RGB Hex coded color in the form 
+   *    of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 
+   *    Extended)
+   * @param {string} [options.colors.noticeColor] - A RGB Hex coded color in the form 
+   *    of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 
+   *    Extended)
+   * @param {string} [options.colors.informationalColor] - A RGB Hex coded color in the form 
+   *    of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 
+   *    Extended)
+   * @param {string} [options.colors.debugColor] - A RGB Hex coded color in the form 
+   *    of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 
+   *    Extended)
+   * @param {Syslog} [options.server=false] - A {@link module:SyslogPro~Syslog|
+   *    Syslog server connection} that should be used to send messages directly 
+   *    from this class. @see SyslogPro~Syslog
+   */
+  constructor (options) {
+    /** @private @type {boolean} */
+    this.constructor__ = true;
+    options = options || {};
+    this.hostname = options.hostname || os.hostname();
+    this.applacationName = options.applacationName || '';
+    if (typeof options.timestamp === 'undefined' || options.timestamp) {
+      /** @type {boolean} */
+      this.timestamp = true;
+    } else {
+      this.timestamp = false;
+    }
+    if (options.timestampUTC) {
+      /** @type {boolean} */
+      this.timestampUTC = true;
+    } else {
+      this.timestampUTC = false;
+    }
+    if (typeof options.timestampTZ === 'undefined' || options.timestampTZ) {
+      /** @type {boolean} */
+      this.timestampTZ = true;
+    } else {
+      this.timestampTZ = false;
+    }
+    if (options.timestampMS) {
+      /** @type {boolean} */
+      this.timestampMS = true;
+    } else {
+      this.timestampMS = false;
+    }
+    if (options.encludeStructuredData) {
+      /** @type {boolean} */
+      this.encludeStructuredData = true;
+    } else {
+      this.encludeStructuredData = false;
+    }
+    if (typeof options.utf8BOM === 'undefined' || options.utf8BOM) {
+      /** @type {boolean} */
+      this.utf8BOM = true;
+    } else {
+      this.utf8BOM = false;
+    }
+    if (options.color) {
+      /** @type {boolean} */
+      this.color = true;
+    } else {
+      this.color = false;
+    }
+    if (options.extendedColor) {
+      /** @type {boolean} */
+      this.extendedColor = true;
+    } else {
+      this.extendedColor = false;
+    }
+    if (options.server) {
+      if (!options.server.constructor__) {
+        /** @private @type {Syslog} */
+        this.server = new Syslog(options.server);
+      } else {
+        this.server = options.server;
+      }
+    }
+    if (this.extendedColor) {
+      /** @private @type {number} */
+      this.emergencyColor = 1; // Red foreground color
+      /** @private @type {number} */
+      this.alertColor = 202; // Dark Orange foreground color
+      /** @private @type {number} */
+      this.criticalColor = 208; // Orange foreground color
+      /** @private @type {number} */
+      this.errorColor = 178; // Light Orange foreground color
+      /** @private @type {number} */
+      this.warningColor = 226; // Yellow foreground color
+      /** @private @type {number} */
+      this.noticeColor = 117; // Light Blue foreground color
+      /** @private @type {number} */
+      this.informationalColor = 45; // Blue foreground color
+      /** @private @type {number} */
+      this.debugColor = 27; // Dark Blue foreground color
+    } else {
+      this.emergencyColor = 31; // Red foreground color
+      this.alertColor = 31; // Red foreground color
+      this.criticalColor = 31; // Red foreground color
+      this.errorColor = 33; // Yellow foreground color
+      this.warningColor = 33; // Yellow foreground color
+      this.noticeColor = 36; // Blue foreground color
+      this.informationalColor = 36; // Blue foreground color
+      this.debugColor = 34; // Dark Blue foreground color
+    }
+    if (typeof options.colors === 'object') {
+      this.setColor(options.colors, this.extendedColor);
+    }
+  }
+  /**
+   * Sets the color to be used for messages at a set priority
+   * @public   
+   * @param {string} [colors.emergencyColor] - A RGB Hex coded color in the form 
+   *    of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 
+   *    Extended)
+   * @param {string} [colors.alertColor] - A RGB Hex coded color in the form 
+   *    of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 
+   *    Extended)
+   * @param {string} [colors.criticalColor] - A RGB Hex coded color in the form 
+   *    of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 
+   *    Extended)
+   * @param {string} [colors.errorColor] - A RGB Hex coded color in the form 
+   *    of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 
+   *    Extended)
+   * @param {string} [colors.warningColor] - A RGB Hex coded color in the form 
+   *    of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 
+   *    Extended)
+   * @param {string} [colors.noticeColor] - A RGB Hex coded color in the form 
+   *    of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 
+   *    Extended)
+   * @param {string} [colors.informationalColor] - A RGB Hex coded color in the form 
+   *    of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 
+   *    Extended)
+   * @param {string} [colors.debugColor] - A RGB Hex coded color in the form 
+   *    of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 
+   *    Extended)
+   * @throws {Error} A standard error object
+   */
+  setColor (colors, extendedColor) {
+    return new Promise((resolve, reject) => {
+      let colorPromises = [];
+      if (colors.emergencyColor) {
+        colorPromises.push(
+            new Promise((resolve,reject) => {
+              rgbToAnsi(colors.emergencyColor, this.extendedColor)
+                  .then((result) => {
+                    this.emergencyColor = result;
+                    resolve(true);
+                  })
+                  .catch((reson) => {
+                    reson.message = 'TYPE ERROR: '; 
+                    reson.message += 'emergencyColor';
+                    reson.message += ' Not in RGB color hex or color code';
+                    reject(reson);
+                  });
+        }));
+      }
+      if (colors.alertColor) {
+        colorPromises.push(
+            new Promise((resolve,reject) => {
+              rgbToAnsi(colors.alertColor, this.extendedColor)
+                  .then((result) => {
+                    this.alertColor = result;
+                    resolve(true);
+                  })
+                  .catch((reson) => {
+                    reson.message = 'TYPE ERROR: '; 
+                    reson.message += 'alertColor';
+                    reson.message += ' Not in RGB color hex or color code';
+                    reject(reson);
+                  });
+        }));
+      }
+      if (colors.criticalColor) {
+        colorPromises.push(
+            new Promise((resolve,reject) => {
+              rgbToAnsi(colors.criticalColor, this.extendedColor)
+                  .then((result) => {
+                    this.criticalColor = result;
+                    resolve(true);
+                  })
+                  .catch((reson) => {
+                    reson.message = 'TYPE ERROR: '; 
+                    reson.message += 'criticalColor';
+                    reson.message += ' Not in RGB color hex or color code';
+                    reject(reson);
+                  });
+        }));
+      }
+      if (colors.errorColor) {
+        colorPromises.push(
+            new Promise((resolve,reject) => {
+              rgbToAnsi(colors.errorColor, this.extendedColor)
+                  .then((result) => {
+                    this.errorColor = result;
+                    resolve(true);
+                  })
+                  .catch((reson) => {
+                    reson.message = 'TYPE ERROR: '; 
+                    reson.message += 'errorColor';
+                    reson.message += ' Not in RGB color hex or color code';
+                    reject(reson);
+                  });
+        }));
+      }
+      if (colors.warningColor) {
+        colorPromises.push(
+            new Promise((resolve,reject) => {
+              rgbToAnsi(colors.warningColor, this.extendedColor)
+                  .then((result) => {
+                    this.warningColor = result;
+                    resolve(true);
+                  })
+                  .catch((reson) => {
+                    reson.message = 'TYPE ERROR: '; 
+                    reson.message += 'warningColor';
+                    reson.message += ' Not in RGB color hex or color code';
+                    reject(reson);
+                  });
+        }));
+      }
+      if (colors.noticeColor) {
+        colorPromises.push(
+            new Promise((resolve,reject) => {
+              rgbToAnsi(colors.noticeColor, this.extendedColor)
+                  .then((result) => {
+                    this.noticeColor = result;
+                    resolve(true);
+                  })
+                  .catch((reson) => {
+                    reson.message = 'TYPE ERROR: '; 
+                    reson.message += 'noticeColor';
+                    reson.message += ' Not in RGB color hex or color code';
+                    reject(reson);
+                  });
+        }));
+      }
+      if (colors.informationalColor) {
+        colorPromises.push(
+            new Promise((resolve,reject) => {
+              rgbToAnsi(colors.informationalColor, this.extendedColor)
+                  .then((result) => {
+                    this.informationalColor = result;
+                    resolve(true);
+                  })
+                  .catch((reson) => {
+                    reson.message = 'TYPE ERROR: '; 
+                    reson.message += 'informationalColor';
+                    reson.message += ' Not in RGB color hex or color code';
+                    reject(reson);
+                  });
+        }));
+      }
+      if (colors.debugColor) {
+        colorPromises.push(
+            new Promise((resolve,reject) => {
+              rgbToAnsi(colors.debugColor, this.extendedColor)
+                  .then((result) => {
+                    this.debugColor = result;
+                    resolve(true);
+                  })
+                  .catch((reson) => {
+                    reson.message = 'TYPE ERROR: '; 
+                    reson.message += 'debugColor';
+                    reson.message += ' Not in RGB color hex or color code';
+                    reject(reson);
+                  });
+        }));
+      }
+      Promise.all(colorPromises)
+          .then((results) => {
+            resolve(true);
+          })
+          .catch((reson) => {
+            reject(reson);
+          });
+    });
+  }
+  /**
+   * Building a formated message.  Returns a promise with a formated message 
+   * @public
+   * @param {string} msg - The Syslog Message
+   * @param {object} [options] - Options object
+   * @param {number} [options.severity=7] - An array of structure 
+   * @param {number} [options.facility=23] - Facility code to use sending this 
+   *    message 
+   * @param {string} [options.pid='-'] - The process id of the service sending 
+   *    this message 
+   * @param {string[]} [options.structuredData] - An array of structure 
+   *    data strings conforming to the IETF/IANA defined SD-IDs or IANA 
+   *    registred SMI Network Management Private Enterprise Code SD-ID 
+   *    conforming to the format 
+   *    [name@<private enterprise number> parameter=value] 
+   * @param {number} [options.colorCode=36] - The ANSI color code to use if 
+   *    message coloration is selected
+   * @returns {Promise} A Syslog formated string acording to the selected RFC
+   * @throws {Error} A standard error object
+   */
+  buildMessage (msg, options) {
+    return new Promise((resolve, reject) => {
+      options = options || {};
+      let severity = typeof options.severity === 'number' ? 
+          options.severity : 6;
+      if (typeof msg !== 'string' || options.severity > 7) {
+        let errMsg = 'FORMAT ERROR: Syslog message must be a string';
+        errMsg += ' msgSeverity must be a number between 0 and 7';
+        reject(new Error(errMsg));
+        return;
+      }
+      let facility = options.facility || 23;
+      let pid = options.pid || '-';
+      let id = options.id || '-';
+      let msgStructuredData = options.msgStructuredData || [];
+      let fmtMsg = ''; // Formated Syslog message string var
+      const newLine = '\n';
+      const newLineRegEx = /(\r|\n|(\r\n))/;
+      const escapeCode = '\u001B';
+      const resetColor = '\u001B[0m';
    + +
    • + + +
  • +
    + +
    + +
    +

    The PRI is common to both RFC formats

    + +
    + + 
          const pri = (facility * 8) + severity;
    + +
    • + + +
  • +
    + +
    + +
    +

    Remove any newline character

    + +
    + + 
          msg = msg.replace(newLineRegEx, '');
    + +
    • + + +
  • +
    + +
    + +
    +

    Add requested color

    + +
    + + 
          if (this.color) {
+        options.msgColor = options.msgColor || 36;
+        let colorCode = '[';
+        if (this.extendedColor) {
+          colorCode += '38;5;'; // Extended 256 Colors ANSI Code
+        }
+        if (typeof options.msgColor === 'number') {
+          colorCode += options.msgColor;
+          colorCode += 'm'; // ANSI Color Closer
+        } else {
+          colorCode = '[39m';  // Use terminal's defualt color
+        }
+        msg = escapeCode + colorCode + msg + resetColor;
+      }
    + +
    • + + +
  • +
    + +
    + +
    +

    RFC5424 timestamp formating

    + +
    + + 
          let timestamp = '-';
+      if (this.timestamp) {
+        let timeQuality = '[timeQuality';
+        if (this.timestampUTC) {
+          timeQuality += ' tzKnown=1';
+          if (this.timestampMS) {
+            if (this.timestampTZ) {
+              timestamp = moment().utc().format('YYYY-MM-DDThh:mm:ss.SSSSSSZ');
+            } else {
+              timestamp = moment().utc().format('YYYY-MM-DDThh:mm:ss.SSSSSS');
+            }
+          } else {
+            if (this.timestampTZ) {
+              timestamp = moment().utc().format('YYYY-MM-DDThh:mm:ssZ');
+            } else {
+              timestamp = moment().utc().format('YYYY-MM-DDThh:mm:ss');
+            }
+          }
+        } else {
+          if (this.timestampTZ) {
+            timeQuality += ' tzKnown=1';
+            if (this.timestampMS) {
+              timeQuality += ' isSynced=1';
+              timeQuality += ' syncAccuracy=0';
+              timestamp = moment().format('YYYY-MM-DDThh:mm:ss.SSSSSSZ');
+            } else {
+              timestamp = moment().format('YYYY-MM-DDThh:mm:ssZ');
+            }
+          } else {
+            timeQuality += ' tzKnown=0';
+            if (this.timestampMS) {
+              timeQuality += ' isSynced=1';
+              timeQuality += ' syncAccuracy=0';
+              timestamp = moment().format('YYYY-MM-DDThh:mm:ss.SSSSSS');
+            } else {
+              timestamp = moment().format('YYYY-MM-DDThh:mm:ss');
+            }
+          }
+        }
+        timeQuality += ']';
+        msgStructuredData.push(timeQuality);
+      }
    + +
    • + + +
  • +
    + +
    + +
    +

    Build Structured Data string

    + +
    + + 
          let structuredData = '-';
+      const sdElementCount = msgStructuredData.length;
+      if (this.encludeStructuredData && sdElementCount > 0) {
+        let sdElementNames = [];
+        let sdElements = [];
+        const sdElementNameRegEx = /(\[)(\S*)(\s|\])/;
    + +
    • + + +
  • +
    + +
    + +
    +

    Loop to drop duplicates of the same SD Element name

    + +
    + + 
            for (let elementIndex=0; 
+            elementIndex<sdElementCount; 
+            elementIndex++) {
+          let elementName = 
+            msgStructuredData[elementIndex]
+            .match(sdElementNameRegEx)[2];
+          if (!sdElementNames.includes(elementName)) {
+            sdElementNames.push(elementName);
+            sdElements.push(msgStructuredData[elementIndex]);
+          }
+        }
+        structuredData = sdElements.join('');
+      }
    + +
    • + + +
  • +
    + +
    + +
    +

    Build the message

    + +
    + + 
          fmtMsg = '<' + pri + '>';
+      fmtMsg += '1'; // Version number
+      fmtMsg += ' ' + timestamp;
+      fmtMsg += ' ' + this.hostname;
+      fmtMsg += ' ' + this.applacationName;
+      fmtMsg += ' ' + pid;
+      fmtMsg += ' ' + id;
+      fmtMsg += ' ' + structuredData;
+      if (this.utf8BOM) {
+        fmtMsg += ' BOM' + msg;
+      } else {
+        fmtMsg += ' ' + msg;
+      }
+      fmtMsg += newLine;
+      resolve(fmtMsg);
+    });
+  }
+  /**
+   * send a RFC5424 formated message.  Returns a promise with the formated 
+   *    message that was sent.  If no server connection was defined when the 
+   *    class was created a defualt Syslog connector will be used.  
+   *    @see SyslogPro~Syslog
+   * @public
+   * @param {string} msg - The unformated Syslog message to send
+   * @returns {Promise} A Syslog formated string acording to the selected RFC
+   * @throws {Error} A standard error object
+   */
+  send (msg, options) {
+    return new Promise((resolve, reject) => {
+      if (!this.server) {
+        this.server = new Syslog();
+      }
+      this.buildMessage(msg, options)
+        .then((result) => {
+          this.server.send(result)
+            .then((sendResult) => {
+              resolve(sendResult);
+            })
+            .catch((error) => {
+              reject(error);
+            });
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  }
+  /**
+   * Send a syslog message with a secerity level of 0 (Emergency)
+   * @public
+   * @param {string} msg - The emergancy message to send to the Syslog server
+   * @returns {Promise} - The formated syslog message sent to the Syslog server
+   * @throws {Error} - Any bubbled up error
+   */
+  emergency (msg) {
+    return this.send(msg, {
+      severity: 0, 
+      colorCode: this.emergencyColor
+    });
+  }
+  /**
+   * Send a syslog message with a secerity level of 0 (Emergency)
+   * @public
+   * @param {string} msg - The emergancy message to send to the Syslog server
+   * @returns {Promise} - The formated syslog message sent to the Syslog server
+   * @throws {Error} - Any bubbled up error
+   */
+  emer (msg) {
+    return this.emergency(msg);
+  }
+  /**
+   * Send a syslog message with a secerity level of 1 (Alert)
+   * @public
+   * @param {string} msg - The alert message to send to the Syslog server
+   * @returns {Promise} - The formated syslog message sent to the Syslog server
+   * @throws {Error} - Any bubbled up error
+   */
+  alert (msg) {
+    return this.send(msg, {
+      severity: 1, 
+      colorCode: this.alertColor
+    });
+  }
+  /**
+   * Send a syslog message with a secerity level of 2 (Critical)
+   * @public
+   * @param {string} msg - The critical message to send to the Syslog server
+   * @returns {Promise} - The formated syslog message sent to the Syslog server
+   * @throws {Error} - Any bubbled up error
+   */
+  critical (msg) {
+    return this.send(msg, {
+      severity: 2, 
+      colorCode: this.criticalColor
+    });
+  }
+  /**
+   * Send a syslog message with a secerity level of 2 (Critical)
+   * @public
+   * @param {string} msg - The critical message to send to the Syslog server
+   * @returns {Promise} - The formated syslog message sent to the Syslog server
+   * @throws {Error} - Any bubbled up error
+   */
+  crit (msg) {
+    return this.critical(msg);
+  }
+  /**
+   * Send a syslog message with a secerity level of 3 (Error)
+   * @public
+   * @param {string} msg - The error message to send to the Syslog server
+   * @returns {Promise} - The formated syslog message sent to the Syslog server
+   * @throws {Error} - Any bubbled up error
+   */
+  error (msg) {
+    return this.send(msg, {
+      severity: 3, 
+      colorCode: this.errorColor
+    });
+  }
+  /**
+   * Send a syslog message with a secerity level of 3 (Error)
+   * @public
+   * @param {string} msg - The error message to send to the Syslog server
+   * @returns {Promise} - The formated syslog message sent to the Syslog server
+   * @throws {Error} - Any bubbled up error
+   */
+  err (msg) {
+    return this.error(msg);
+  }
+  /**
+   * Send a syslog message with a secerity level of 4 (Warning)
+   * @public
+   * @param {string} msg - The warning message to send to the Syslog server
+   * @returns {Promise} - The formated syslog message sent to the Syslog server
+   * @throws {Error} - Any bubbled up error
+   */
+  warning (msg) {
+    return this.send(msg, {
+      severity: 4, 
+      colorCode: this.warningColor
+    });
+  }
+  /**
+   * Send a syslog message with a secerity level of 4 (Warning)
+   * @public
+   * @param {string} msg - The warning message to send to the Syslog server
+   * @returns {Promise} - The formated syslog message sent to the Syslog server
+   * @throws {Error} - Any bubbled up error
+   */
+  warn (msg) {
+    return this.warning(msg);
+  }
+  /**
+   * Send a syslog message with a secerity level of 5 (Notice)
+   * @public
+   * @param {string} msg - The notice message to send to the Syslog server
+   * @returns {Promise} - The formated syslog message sent to the Syslog server
+   * @throws {Error} - Any bubbled up error
+   */
+  notice (msg) {
+    return this.send(msg, {
+      severity: 5, 
+      colorCode: this.noticeColor
+    });
+  }
+  /**
+   * Send a syslog message with a secerity level of 5 (Notice)
+   * @public
+   * @param {string} msg - The notice message to send to the Syslog server
+   * @returns {Promise} - The formated syslog message sent to the Syslog server
+   * @throws {Error} - Any bubbled up error
+   */
+  note (msg) {
+    return this.notice(msg);
+  }
+  /**
+   * Send a syslog message with a secerity level of 6 (Informational)
+   * @public
+   * @param {string} msg - The informational message to send to the Syslog server
+   * @returns {Promise} - The formated syslog message sent to the Syslog server
+   * @throws {Error} - Any bubbled up error
+   */
+  informational (msg) {
+    return this.send(msg, {
+      severity: 6, 
+      colorCode: this.informationalColor
+    });
+  }
+  /**
+   * Send a syslog message with a secerity level of 6 (Informational)
+   * @public
+   * @param {string} msg - The informational message to send to the Syslog server
+   * @returns {Promise} - The formated syslog message sent to the Syslog server
+   * @throws {Error} - Any bubbled up error
+   */
+  info (msg) {
+    return this.informational(msg);
+  }
+  /**
+   * Send a syslog message with a secerity level of 6 (Informational)
+   * @public
+   * @param {string} msg - The informational message to send to the Syslog server
+   * @returns {Promise} - The formated syslog message sent to the Syslog server
+   * @throws {Error} - Any bubbled up error
+   */
+  log (msg) {
+    return this.informational(msg);
+  }
+  /**
+   * Send a syslog message with a secerity level of 7 (Debug)
+   * @public
+   * @param {string} msg - The debug message to send to the Syslog server
+   * @returns {Promise} - The formated syslog message sent to the Syslog server
+   * @throws {Error} - Any bubbled up error
+   */
+  debug (msg) {
+    return this.send(msg, {
+      severity: 7, 
+      colorCode: this.debugColor
+    });
+  }
+}
+ 
+/**
+ * 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. 
+ * Most APIs will return a promise. These APIs can be used using 
+ * `then(...)/catch(...)`
+ * 
+ * A Syslog class with a configured Syslog server target can also be used as 
+ * the input into the formating classes so that it may run independtly. The 
+ * LEEF format is designed to send event data to a SIEM system and should not 
+ * be as a logging stream. This class is ment to be used once per message.
+ * @requires moment
+ * @version 0.0.0
+ * @since 0.0.0
+ */
+class LEEF {
+  /**
+   * Construct a new LEEF formating object with user options
+   * @public
+   * @param {object} [options] - Options object
+   * @param {string} [options.vendor='unknown'] - The vendor of the system that
+   *    genrated the event being reported
+   * @param {string} [options.product='unknown'] - The product name of the 
+   *    system that genrated the event being reported
+   * @param {string} [options.version='unknown'] - The version name of the 
+   *    system that genrated the event being reported
+   * @param {string} [options.eventId='unknown'] - The eventId of the 
+   *    system that genrated the event being reported
+   * @param {object} [options.attrabute] - LEEF message attrabutes which 
+   *    defualts to all base attrabutes with null values, new attrabutes should
+   *    be added as new elements to this object
+   * @param {boolean} [options.syslogHeader='true'] - Should the LEEF message 
+   *    include a Syslog header with Timestamp and source
+   * @param {Syslog} [options.server=false] - A {@link module:SyslogPro~Syslog|
+   *    Syslog server connection} that should be used to send messages directly 
+   *    from this class. @see SyslogPro~Syslog
+   */
+  constructor (options) {
+    /** @private @type {boolean} */
+    this.constructor__ = true;
+    options = options || {};
+    /** @type {string} */
+    this.vendor = options.vendor || 'unknown';
+    /** @type {string} */
+    this.product = options.product || 'unknown';
+    /** @type {string} */
+    this.version = options.version || 'unknown';
+    /** @type {string} */
+    this.eventId = options.eventId || 'unknown';
+    /** @type {boolean} */
+    this.syslogHeader = typeof options.syslogHeader === 'boolean' 
+        ? options.syslogHeader : true;
+    /** @type {object} */
+    this.attrabutes = options.attrabutes || {
+      cat: null,
+      devTime: null,
+      devTimeFormat: null,
+      proto: null,
+      sev: null,
+      src: null,
+      dst: null,
+      srcPort: null,
+      dstPort: null,
+      srcPreNAT: null,
+      dstPreNAT: null,
+      srcPostNAT: null,
+      dstPostNAT: null,
+      usrName: null,
+      srcMAC: null,
+      dstMAC: null,
+      srcPreNATPort: null,
+      dstPreNATPort: null,
+      srcPostNATPort: null,
+      dstPostNATPort: null,
+      identSrc: null,
+      identHostName: null,
+      identNetBios: null,
+      identGrpName: null,
+      identMAC: null,
+      vSrc: null,
+      vSrcName: null,
+      accountName: null,
+      srcBytes: null,
+      dstBytes: null,
+      srcPackets: null,
+      dstPackets: null,
+      totalPackets: null,
+      role: null,
+      realm: null,
+      policy: null,
+      resource: null,
+      url: null,
+      groupID: null,
+      domain: null,
+      isLoginEvent: null,
+      isLogoutEvent: null,
+      identSecondlp: null,
+      calLanguage: null,
+      AttributeLimits: null,
+      calCountryOrRegion: null,
+    };
+    if (options.server) {
+      if (options.server.constructor__) {
+        /** @private @type {Syslog} */
+        this.server = options.server;
+      } else {
+        this.server = new Syslog(options.server);
+      }
+    }
+  }
+  /**
+   *Build a formated message
+   * @public
+   * @return {Promise} - string with formated message
+   */
+  buildMessage () {
+    return new Promise((resolve, reject) => {
+      let fmtMsg = 'LEEF:2.0';
+      fmtMsg += '|' + this.vendor;
+      fmtMsg += '|' + this.product;
+      fmtMsg += '|' + this.version;
+      fmtMsg += '|' + this.eventId;
+      fmtMsg += '|';
    + +
    • + + +
  • +
    + +
    + +
    +

    Build LEEF Attrabuites

    + +
    + + 
          const Tab = '\x09';
+      const leefAttribs = Object.entries(this.attrabutes);
+      const leefAttribsLen = leefAttribs.length;
+      for (let attrib = 0; attrib < leefAttribsLen; attrib++) {
+        if (leefAttribs[attrib][1] !== null) {
+          fmtMsg += leefAttribs[attrib][0] + '=' + leefAttribs[attrib][1] + Tab;
+        }
+      }
+      resolve(fmtMsg);
+    });
+  }
+  
+  /**
+   * @public
+   * @param {Syslog} [options=false] - A {@link module:SyslogPro~Syslog|
+   *    Syslog server connection} that should be used to send messages directly 
+   *    from this class. @see SyslogPro~Syslog
+   */
+  send (options) {
+    return new Promise((resolve, reject) => {
+      this.buildMessage()
+        .then((result) => {
+          if (!this.server) {
+            this.server = new Syslog(options);
+          }
+          this.server.send(result)
+            .then((sendResult) => {
+              resolve(sendResult);
+            })
+            .catch((reson) => {
+              reject(reson);
+            });
+        });
+    });
+  }
+}
+
+/**
+ * A class to work with HP CEF (Common Event 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 CEF 
+ * formated mesage produced by this module can be saved externaly to it) or 
+ * sent via Syslog.
+ * Most APIs will return a promise. These APIs can be used using 
+ * `then(...)/catch(...)`
+ * 
+ * A Syslog class with a configured Syslog server target can also be used as 
+ * the input into the formating classes so that it may run independtly. The CEF 
+ * format is designed to send event data to a SIEM system and should not be as 
+ * a logging stream. This class is ment to be used once per message.
+ * @requires moment
+ * @version 0.0.0
+ * @since 0.0.0
+ */
+class CEF {
+  /**
+   * Construct a new CEF formating object with user options 
+   * @public
+   * @param {object} [options] - Options object
+   * @param {string} [options.deviceVendor='unknown'] - The vendor of the system 
+   *    that genrated the event being reported
+   * @param {string} [options.deviceProduct='unknown'] - The product name of the 
+   *    system that genrated the event being reported
+   * @param {string} [options.deviceVersion='unknown'] - The version name of the 
+   *    system that genrated the event being reported
+   * @param {string} [options.deviceEventClassId='unknown'] - The eventId of the 
+   *    system that genrated the event being reported
+   * @param {string} [options.name='unknown'] - Name of the service genrating 
+   *    the notice
+   * @param {string} [options.severity='unknown'] - Severity of the notification
+   * @param {string} [options.extensions={}] - Any CEF Key=Value extentions
+   * @param {Syslog} [options.server=false] - A {@link module:SyslogPro~Syslog|
+   *    Syslog server connection} that should be used to send messages directly 
+   *    from this class. @see SyslogPro~Syslog
+   */
+  constructor (options) {
+    /** @private @type {boolean} */
+    this.constructor__ = true;
+    options = options || {};
+    /** @type {string} */
+    this.deviceVendor = options.deviceVendor || 'Unknown';
+    /** @type {string} */
+    this.deviceProduct = options.deviceProduct || 'Unknown';
+    /** @type {string} */
+    this.deviceVersion = options.deviceVersion || 'Unknown';
+    /** @type {string} */
+    this.deviceEventClassId = options.deviceEventClassId || 'Unknown';
+    /** @type {string} */
+    this.name = options.name || 'Unknown';
+    /** @type {string} */
+    this.severity = options.severity || 'Unknown';
+    /** @type {object} */
+    this.extensions = options.extensions || {
+      'deviceAction': null,
+      'applicationProtocol': null,
+      'deviceCustomIPv6Address1': null,
+      'deviceCustomIPv6 Address1Label': null,
+      'deviceCustomIPv6Address3': null,
+      'deviceCustomIPv6Address3 Label': null,
+      'deviceCustomIPv6 Address4': null,
+      'deviceCustomIPv6 Address4Label': null,
+      'deviceEventCategory': null,
+      'deviceCustomFloatingPoint1': null,
+      'deviceCustom FloatingPoint1Label': null,
+      'deviceCustomFloatingPoint2': null,
+      'deviceCustomFloatingPoint2 Label': null,
+      'deviceCustomFloatingPoint3': null,
+      'deviceCustom FloatingPoint3Label': null,
+      'deviceCustomFloatingPoint4': null,
+      'deviceCustom FloatingPoint4Label': null,
+      'deviceCustomNumber1': null,
+      'deviceCustomNumber1Label': null,
+      'DeviceCustomNumber2': null,
+      'deviceCustomNumber2Label': null,
+      'deviceCustomNumber3': null,
+      'deviceCustomNumber3Label': null,
+      'baseEventCount': null,
+      'deviceCustomString1': null,
+      'deviceCustomString1Label': null,
+      'deviceCustomString2': null,
+      'deviceCustomString2Label': null,
+      'deviceCustomString3': null,
+      'deviceCustomString3Label': null,
+      'deviceCustomString4': null,
+      'deviceCustomString4Label': null,
+      'deviceCustomString5': null,
+      'deviceCustomString5Label': null,
+      'deviceCustomString6': null,
+      'deviceCustomString6Label': null,
+      'destinationDnsDomain': null,
+      'destinationServiceName': null,
+      'destinationTranslated Address': null,
+      'destinationTranslatedPort': null,
+      'deviceCustomDate1': null,
+      'deviceCustomDate1Label': null,
+      'deviceCustomDate2': null,
+      'deviceCustomDate2Label': null,
+      'deviceDirection': null,
+      'deviceDnsDomain': null,
+      'deviceExternalId': null,
+      'deviceFacility': null,
+      'deviceInboundInterface': null,
+      'deviceNtDomain': null,
+      'deviceOutboundInterface': null,
+      'devicePayloadId': null,
+      'deviceProcessName': null,
+      'deviceTranslatedAddress': null,
+      'destinationHostName': null,
+      'destinationMacAddress': null,
+      'destinationNtDomain': null,
+      'destinationProcessId': null,
+      'destinationUserPrivileges': null,
+      'destinationProcessName': null,
+      'destinationPort': null,
+      'destinationAddress': null,
+      'deviceTimeZone': null,
+      'destinationUserId': null,
+      'destinationUserName': null,
+      'deviceAddress': null,
+      'deviceHostName': null,
+      'deviceMacAddress': null,
+      'deviceProcessId': null,
+      'endTime': null,
+      'externalId': null,
+      'fileCreateTime': null,
+      'fileHash': null,
+      'fileId': null,
+      'fileModificationTime': null,
+      'filePath': null,
+      'filePermission': null,
+      'fileType': null,
+      'flexDate1': null,
+      'flexDate1Label': null,
+      'flexString1': null,
+      'flexString1Label': null,
+      'flexString2': null,
+      'flexString2Label': null,
+      'filename': null,
+      'fileSize': null,
+      'bytesIn': null,
+      'message': null,
+      'oldFileCreateTime': null,
+      'oldFileHash': null,
+      'oldFileId': null,
+      'oldFileModificationTime': null,
+      'oldFileName': null,
+      'oldFilePath': null,
+      'oldFileSize': null,
+      'oldFileType': null,
+      'bytesOut': null,
+      'eventOutcome': null,
+      'transportProtocol': null,
+      'Reason': null,
+      'requestUrl': null,
+      'requestClientApplication': null,
+      'requestContext': null,
+      'requestCookies': null,
+      'requestMethod': null,
+      'deviceReceiptTime': null,
+      'sourceHostName': null,
+      'sourceMacAddress': null,
+      'sourceNtDomain': null,
+      'sourceDnsDomain': null,
+      'sourceServiceName': null,
+      'sourceTranslatedAddress': null,
+      'sourceTranslatedPort': null,
+      'sourceProcessId': null,
+      'sourceUserPrivileges': null,
+      'sourceProcessName': null,
+      'sourcePort': null,
+      'sourceAddress': null,
+      'startTime': null,
+      'sourceUserId': null,
+      'sourceUserName': null,
+      'type': null,
+      'agentDnsDomain': null,
+      'agentNtDomain': null,
+      'agentTranslatedAddress': null,
+      'agentTranslatedZone ExternalID': null,
+      'agentTranslatedZoneURI': null,
+      'agentZoneExternalID': null,
+      'agentZoneURI': null,
+      'agentAddress': null,
+      'agentHostName': null,
+      'agentId': null,
+      'agentMacAddress': null,
+      'agentReceiptTime': null,
+      'agentType': null,
+      'agentTimeZone': null,
+      'agentVersion': null,
+      'customerExternalID': null,
+      'customerURI': null,
+      'destinationTranslated ZoneExternalID': null,
+      'destinationTranslated ZoneURI': null,
+      'destinationZoneExternalID': null,
+      'destinationZoneURI': null,
+      'deviceTranslatedZone ExternalID': null,
+      'deviceTranslatedZoneURI': null,
+      'deviceZoneExternalID': null,
+      'deviceZoneURI': null,
+      'destinationGeoLatitude': null,
+      'destinationGeoLongitude': null,
+      'eventId': null,
+      'rawEvent': null,
+      'sourceGeoLatitude': null,
+      'sourceGeoLongitude': null,
+      'sourceTranslatedZone ExternalID': null,
+      'sourceTranslatedZoneURI': null,
+      'sourceZoneExternalID': null,
+      'sourceZoneURI': null,
+    };
+    if (options.server) {
+      if (options.server.constructor__) {
+        /** @private @type {Syslog} */
+        this.server = options.server;
+      } else {
+        this.server = new Syslog(options.server);
+      }
+    }
+  }
+  /**
+   * Validate this CEF object
+   * @public
+   * @return {Promise} - True if valadated
+   * @throws {Error} - First element to fail valadation
+   */  
+  validate () {
+    return new Promise ((resolve, reject) => {
+      const Extensions = {
+        'deviceAction': {key: 'act', type:'String', len:63,  discription: 'Action taken by the device.'},
+        'applicationProtocol': {key: 'app', type:'String', len:31,  discription: 'Application level protocol, example values are HTTP, HTTPS, SSHv2, Telnet, POP, IMPA, IMAPS, and so on.'},
+        'deviceCustomIPv6Address1': {key: 'c6a1', type:'String', len:null,  discription: 'One of four IPv6 address fields available to map fields that do not apply to any other in this dictionary. TIP: See the guidelines under “User-Defined Extensions” for tips on using these fields.'},
+        'deviceCustomIPv6 Address1Label': {key: 'c6a1Label', type:'String', len:1023,  discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'},
+        'deviceCustomIPv6Address3': {key: 'c6a3', type:'String', len:null,  discription: 'One of four IPv6 address fields available to map fields that do not apply to any other in this dictionary. TIP: See the guidelines under “User-Defined Extensions” for tips on using these fields.'},
+        'deviceCustomIPv6Address3 Label': {key: 'c6a3Label', type:'String', len:1023,  discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'},
+        'deviceCustomIPv6 Address4': {key: 'c6a4', type:'String', len:null,  discription: 'One of four IPv6 address fields available to map fields that do not apply to any other in this dictionary. TIP: See the guidelines under “User-Defined Extensions” for tips on using these fields.'},
+        'deviceCustomIPv6 Address4Label': {key: 'C6a4Label', type:'String', len:1023,  discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'},
+        'deviceEventCategory': {key: 'cat', type:'String', len:1023,  discription: 'Represents the category assigned by the originating device. Devices often use their own categorization schema to classify event. Example: “/Monitor/Disk/Read”'},
+        'deviceCustomFloatingPoint1': {key: 'cfp1', type:'Number', len:null,  discription: 'One of four floating point fields available to map fields that do not apply to any other in this dictionary.'},
+        'deviceCustom FloatingPoint1Label': {key: 'cfp1Label', type:'String', len:1023,  discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'},
+        'deviceCustomFloatingPoint2': {key: 'cfp2', type:'Number', len:null,  discription: 'One of four floating point fields available to map fields that do not apply to any other in this dictionary.'},
+        'deviceCustomFloatingPoint2 Label': {key: 'cfp2Label', type:'String', len:1023,  discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'},
+        'deviceCustomFloatingPoint3': {key: 'cfp3', type:'Number', len:null,  discription: 'One of four floating point fields available to map fields that do not apply to any other in this dictionary.'},
+        'deviceCustom FloatingPoint3Label': {key: 'cfp3Label', type:'String', len:1023,  discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'},
+        'deviceCustomFloatingPoint4': {key: 'cfp4', type:'Number', len:null,  discription: 'One of four floating point fields available to map fields that do not apply to any other in this dictionary.'},
+        'deviceCustom FloatingPoint4Label': {key: 'cfp4Label', type:'String', len:1023,  discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'},
+        'deviceCustomNumber1': {key: 'cn1', type:'Number', len:null,  discription: 'One of three number fields available to map fields that do not apply to any other in this dictionary. Use sparingly and seek a more specific, dictionary supplied field when possible.'},
+        'deviceCustomNumber1Label': {key: 'cn1Label', type:'String', len:1023,  discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'},
+        'DeviceCustomNumber2': {key: 'cn2', type:'Number', len:null,  discription: 'One of three number fields available to map fields that do not apply to any other in this dictionary. Use sparingly and seek a more specific, dictionary supplied field when possible.'},
+        'deviceCustomNumber2Label': {key: 'cn2Label', type:'String', len:1023,  discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'},
+        'deviceCustomNumber3': {key: 'cn3', type:'Number', len:null,  discription: 'One of three number fields available to map fields that do not apply to any other in this dictionary. Use sparingly and seek a more specific, dictionary supplied field when possible.'},
+        'deviceCustomNumber3Label': {key: 'cn3Label', type:'String', len:1023,  discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'},
+        'baseEventCount': {key: 'cnt', type:'Number', len:null,  discription: 'A count associated with this event. How many times was this same event observed? Count can be omitted if it is 1.'},
+        'deviceCustomString1': {key: 'cs1', type:'String', len:4000,  discription: 'One of six strings available to map fields that do not apply to any other in this dictionary. Use sparingly and seek a more specific, dictionary supplied field when possible. TIP: See the guidelines under “User-Defined Extensions” for tips on using these fields.'},
+        'deviceCustomString1Label': {key: 'cs1Label', type:'String', len:1023,  discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'},
+        'deviceCustomString2': {key: 'cs2', type:'String', len:4000,  discription: 'One of six strings available to map fields that do not apply to any other in this dictionary. Use sparingly and seek a more specific, dictionary supplied field when possible. TIP: See the guidelines under “User-Defined Extensions” for tips on using these fields.'},
+        'deviceCustomString2Label': {key: 'cs2Label', type:'String', len:1023,  discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'},
+        'deviceCustomString3': {key: 'cs3', type:'String', len:4000,  discription: 'One of six strings available to map fields that do not apply to any other in this dictionary. Use sparingly and seek a more specific, dictionary supplied field when possible. TIP: See the guidelines under “User-Defined Extensions” for tips on using these fields.'},
+        'deviceCustomString3Label': {key: 'cs3Label', type:'String', len:1023,  discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'},
+        'deviceCustomString4': {key: 'cs4', type:'String', len:4000,  discription: 'One of six strings available to map fields that do not apply to any other in this dictionary. Use sparingly and seek a more specific, dictionary supplied field when possible. TIP: See the guidelines under “User-Defined Extensions” for tips on using these fields.'},
+        'deviceCustomString4Label': {key: 'cs4Label', type:'String', len:1023,  discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'},
+        'deviceCustomString5': {key: 'cs5', type:'String', len:4000,  discription: 'One of six strings available to map fields that do not apply to any other in this dictionary. Use sparingly and seek a more specific, dictionary supplied field when possible. TIP: See the guidelines under “User-Defined Extensions” for tips on using these fields.'},
+        'deviceCustomString5Label': {key: 'cs5Label', type:'String', len:1023,  discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'},
+        'deviceCustomString6': {key: 'cs6', type:'String', len:4000,  discription: 'One of six strings available to map fields that do not apply to any other in this dictionary. Use sparingly and seek a more specific, dictionary supplied field when possible. TIP: See the guidelines under “User-Defined Extensions” for tips on using these fields.'},
+        'deviceCustomString6Label': {key: 'cs6Label', type:'String', len:1023,  discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'},
+        'destinationDnsDomain': {key: 'destination DnsDomain', type:'String', len:255,  discription: 'The DNS domain part of the complete fully qualified domain name (FQDN).'},
+        'destinationServiceName': {key: 'destination ServiceName', type:'String', len:1023,  discription: 'The service targeted by this event. Example: “sshd”'},
+        'destinationTranslated Address': {key: 'Destination Translated Address', type:'String', len:null,  discription: 'Identifies the translated destination that the event refers to in an IP network. The format is an IPv4 address. Example: “192.168.10.1”'},
+        'destinationTranslatedPort': {key: 'Destination TranslatedPort', type:'Number', len:null,  discription: 'Port after it was translated; for example, a firewall. Valid port numbers are 0 to 65535.'},
+        'deviceCustomDate1': {key: 'deviceCustom Date1', type:'String', len:null,  discription: 'One of two timestamp fields available to map fields that do not apply to any other in this dictionary. Use sparingly and seek a more specific, dictionary supplied field when possible. TIP: See the guidelines under “User-Defined Extensions” for tips on using these fields.'},
+        'deviceCustomDate1Label': {key: 'deviceCustom Date1Label', type:'String', len:1023,  discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'},
+        'deviceCustomDate2': {key: 'deviceCustom Date2', type:'String', len:null,  discription: 'One of two timestamp fields available to map fields that do not apply to any other in this dictionary. Use sparingly and seek a more specific, dictionary supplied field when possible. TIP: See the guidelines under “User-Defined Extensions” for tips on using these fields.'},
+        'deviceCustomDate2Label': {key: 'deviceCustom Date2Label', type:'String', len:1023,  discription: 'All custom fields have a corresponding label field. Each of these fields is a string and describes the purpose of the custom field.'},
+        'deviceDirection': {key: 'deviceDirection', type:'Number', len:null,  discription: 'Any information about what direction the observed communication has taken. The following values are supported: “0” for inbound or “1” for outbound'},
+        'deviceDnsDomain': {key: 'deviceDns Domain', type:'String', len:255,  discription: 'The DNS domain part of the complete fully qualified domain name (FQDN).'},
+        'deviceExternalId': {key: 'device ExternalId', type:'String', len:255,  discription: 'A name that uniquely identifies the device generating this event.'},
+        'deviceFacility': {key: 'deviceFacility', type:'String', len:1023,  discription: 'The facility generating this event. For example, Syslog has an explicit facility associated with every event.'},
+        'deviceInboundInterface': {key: 'deviceInbound Interface', type:'String', len:128,  discription: 'Interface on which the packet or data entered the device.'},
+        'deviceNtDomain': {key: 'deviceNt Domain', type:'String', len:255,  discription: 'The Windows domain name of the device address.'},
+        'deviceOutboundInterface': {key: 'Device Outbound Interface', type:'String', len:128,  discription: 'Interface on which the packet or data left the device.'},
+        'devicePayloadId': {key: 'Device PayloadId', type:'String', len:128,  discription: 'Unique identifier for the payload associated with the event.'},
+        'deviceProcessName': {key: 'deviceProcess Name', type:'String', len:1023,  discription: 'Process name associated with the event. An example might be the process generating the syslog entry in UNIX.'},
+        'deviceTranslatedAddress': {key: 'device Translated Address', type:'String', len:null,  discription: 'Identifies the translated device address that the event refers to in an IP network. The format is an IPv4 address. Example: “192.168.10.1”'},
+        'destinationHostName': {key: 'dhost', type:'String', len:1023,  discription: 'Identifies the destination that an event refers to in an IP network. The format should be a fully qualified domain name (FQDN) associated with the destination node, when a node is available. Examples: “host.domain.com” or “host”.'},
+        'destinationMacAddress': {key: 'dmac', type:'String', len:null,  discription: 'Six colon-seperated hexadecimal numbers. Example: “00:0D:60:AF:1B:61”'},
+        'destinationNtDomain': {key: 'dntdom', type:'String', len:255,  discription: 'The Windows domain name of the destination address.'},
+        'destinationProcessId': {key: 'dpid', type:'Number', len:null,  discription: 'Provides the ID of the destination process associated with the event. For example, if an event contains process ID 105, “105” is the process ID.'},
+        'destinationUserPrivileges': {key: 'dpriv', type:'String', len:1023,  discription: 'The typical values are “Administrator”, “User”, and “Guest”. This identifies the destination user’s privileges. In UNIX, for example, activity executed on the root user would be identified with destinationUser Privileges of “Administrator”.'},
+        'destinationProcessName': {key: 'dproc', type:'String', len:1023,  discription: 'The name of the event’s destination process. Example: “telnetd” or “sshd”.'},
+        'destinationPort': {key: 'dpt', type:'Number', len:null,  discription: 'The valid port numbers are between 0 and 65535.'},
+        'destinationAddress': {key: 'dst', type:'String', len:null,  discription: 'Identifies the destination address that the event refers to in an IP network. The format is an IPv4 address. Example: “192.168.10.1”'},
+        'deviceTimeZone': {key: 'dtz', type:'String', len:255,  discription: 'The timezone for the device generating the event.'},
+        'destinationUserId': {key: 'duid', type:'String', len:1023,  discription: 'Identifies the destination user by ID. For example, in UNIX, the root user is generally associated with user ID 0.'},
+        'destinationUserName': {key: 'duser', type:'String', len:1023,  discription: 'Identifies the destination user by name. This is the user associated with the event’s destination. Email addresses are often mapped into the UserName fields. The recipient is a candidate to put into this field.'},
+        'deviceAddress': {key: 'dvc', type:'String', len:null,  discription: 'Identifies the device address that an event refers to in an IP network. The format is an IPv4 address. Example: “192.168.10.1”.'},
+        'deviceHostName': {key: 'dvchost', type:'String', len:100,  discription: 'The format should be a fully qualified domain name (FQDN) associated with the device node, when a node is available. Example: “host.domain.com” or “host”.'},
+        'deviceMacAddress': {key: 'dvcmac', type:'String', len:null,  discription: 'Six colon-separated hexadecimal numbers. Example: “00:0D:60:AF:1B:61”'},
+        'deviceProcessId': {key: 'dvcpid', type:'Number', len:null,  discription: 'Provides the ID of the process on the device generating the event.'},
+        'endTime': {key: 'end', type:'String', len:null,  discription: 'The time at which the activity related to the event ended. The format is MMM dd yyyy HH:mm:ss or milliseconds since epoch (Jan 1st1970). An example would be reporting the end of a session.'},
+        'externalId': {key: 'externalId', type:'String', len:40,  discription: 'The ID used by an originating device. They are usually increasing numbers, associated with events.'},
+        'fileCreateTime': {key: 'fileCreateTime', type:'String', len:null,  discription: 'Time when the file was created.'},
+        'fileHash': {key: 'fileHash', type:'String', len:255,  discription: 'Hash of a file.'},
+        'fileId': {key: 'fileId', type:'String', len:1023,  discription: 'An ID associated with a file could be the inode.'},
+        'fileModificationTime': {key: 'fileModification Time', type:'String', len:null,  discription: 'Time when the file was last modified.'},
+        'filePath': {key: 'filePath', type:'String', len:1023,  discription: 'Full path to the file, including file name itself. Example: C:\Program Files \WindowsNT\Accessories\ wordpad.exe or /usr/bin/zip'},
+        'filePermission': {key: 'filePermission', type:'String', len:1023,  discription: 'Permissions of the file.'},
+        'fileType': {key: 'fileType', type:'String', len:1023,  discription: 'Type of file (pipe, socket, etc.)'},
+        'flexDate1': {key: 'flexDate1', type:'String', len:null,  discription: 'A timestamp field available to map a timestamp that does not apply to any other defined timestamp field in this dictionary. Use all flex fields sparingly and seek a more specific, dictionary supplied field when possible. These fields are typically reserved for customer use and should not be set by vendors unless necessary.'},
+        'flexDate1Label': {key: 'flexDate1Label', type:'String', len:128,  discription: 'The label field is a string and describes the purpose of the flex field.'},
+        'flexString1': {key: 'flexString1', type:'String', len:1023,  discription: 'One of four floating point fields available to map fields that do not apply to any other in this dictionary. Use sparingly and seek a more specific, dictionary supplied field when possible. These fields are typically reserved for customer use and should not be set by vendors unless necessary.'},
+        'flexString1Label': {key: 'flexString1 Label', type:'String', len:128,  discription: 'The label field is a string and describes the purpose of the flex field.'},
+        'flexString2': {key: 'flexString2', type:'String', len:1023,  discription: 'One of four floating point fields available to map fields that do not apply to any other in this dictionary. Use sparingly and seek a more specific, dictionary supplied field when possible. These fields are typically reserved for customer use and should not be set by vendors unless necessary.'},
+        'flexString2Label': {key: 'flex String2Label', type:'String', len:128,  discription: 'The label field is a string and describes the purpose of the flex field.'},
+        'filename': {key: 'fname', type:'String', len:1023,  discription: 'Name of the file only (without its path).'},
+        'fileSize': {key: 'fsize', type:'Number', len:null,  discription: 'Size of the file.'},
+        'bytesIn': {key: 'in', type:'Number', len:null,  discription: 'Number of bytes transferred inbound, relative to the source to destination relationship, meaning that data was flowing from source to destination.'},
+        'message': {key: 'msg', type:'String', len:1023,  discription: 'An arbitrary message giving more details about the event. Multi-line entries can be produced by using \n as the new line separator.'},
+        'oldFileCreateTime': {key: 'oldFileCreate Time', type:'String', len:null,  discription: 'Time when old file was created.'},
+        'oldFileHash': {key: 'oldFileHash', type:'String', len:255,  discription: 'Hash of the old file.'},
+        'oldFileId': {key: 'oldFileId', type:'String', len:1023,  discription: 'An ID associated with the old file could be the inode.'},
+        'oldFileModificationTime': {key: 'oldFile Modification Time', type:'String', len:null,  discription: 'Time when old file was last modified.'},
+        'oldFileName': {key: 'oldFileName', type:'String', len:1023,  discription: 'Name of the old file.'},
+        'oldFilePath': {key: 'oldFilePath', type:'String', len:1023,  discription: 'Full path to the old fiWindowsNT\Accessories le, including the file name itself. Examples: c:\Program Files\wordpad.exe or /usr/bin/zip'},
+        'oldFileSize': {key: 'oldFileSize', type:'Number', len:null,  discription: 'Size of the old file.'},
+        'oldFileType': {key: 'oldFileType', type:'String', len:1023,  discription: 'Type of the old file (pipe, socket, etc.)'},
+        'bytesOut': {key: 'out', type:'Number', len:null,  discription: 'Number of bytes transferred outbound relative to the source to destination relationship. For example, the byte number of data flowing from the destination to the source.'},
+        'eventOutcome': {key: 'outcome', type:'String', len:63,  discription: 'Displays the outcome, usually as ‘success’ or ‘failure’.'},
+        'transportProtocol': {key: 'proto', type:'String', len:31,  discription: 'Identifies the Layer-4 protocol used. The possible values are protocols such as TCP or UDP.'},
+        'Reason': {key: 'reason', type:'String', len:1023,  discription: 'The reason an audit event was generated. For example “badd password” or “unknown user”. This could also be an error or return code. Example: “0x1234”'},
+        'requestUrl': {key: 'request', type:'String', len:1023,  discription: 'In the case of an HTTP request, this field contains the URL accessed. The URL should contain the protocol as well. Example: “http://www/secure.com”'},
+        'requestClientApplication': {key: 'requestClient Application', type:'String', len:1023,  discription: 'The User-Agent associated with the request.'},
+        'requestContext': {key: 'requestContext', type:'String', len:2048,  discription: 'Description of the content from which the request originated (for example, HTTP Referrer)'},
+        'requestCookies': {key: 'requestCookies', type:'String', len:1023,  discription: 'Cookies associated with the request.'},
+        'requestMethod': {key: 'requestMethod', type:'String', len:1023,  discription: 'The method used to access a URL. Possible values: “POST”, “GET”, etc.'},
+        'deviceReceiptTime': {key: 'rt', type:'String', len:null,  discription: 'The time at which the event related to the activity was received. The format is MMM dd yyyy HH:mm:ss or milliseconds since epoch (Jan 1st 1970)'},
+        'sourceHostName': {key: 'shost', type:'String', len:1023,  discription: 'Identifies the source that an event refers to in an IP network. The format should be a fully qualified domain name (DQDN) associated with the source node, when a mode is available. Examples: “host” or “host.domain.com”.'},
+        'sourceMacAddress': {key: 'smac', type:'String', len:null,  discription: 'Six colon-separated hexadecimal numbers. Example: “00:0D:60:AF:1B:61”'},
+        'sourceNtDomain': {key: 'sntdom', type:'String', len:255,  discription: 'The Windows domain name for the source address.'},
+        'sourceDnsDomain': {key: 'sourceDns Domain', type:'String', len:255,  discription: 'The DNS domain part of the complete fully qualified domain name (FQDN).'},
+        'sourceServiceName': {key: 'source ServiceName', type:'String', len:1023,  discription: 'The service that is responsible for generating this event.'},
+        'sourceTranslatedAddress': {key: 'source Translated Address', type:'String', len:null,  discription: 'Identifies the translated source that the event refers to in an IP network. The format is an IPv4 address. Example: “192.168.10.1”.'},
+        'sourceTranslatedPort': {key: 'source TranslatedPort', type:'Number', len:null,  discription: 'A port number after being translated by, for example, a firewall. Valid port numbers are 0 to 65535.'},
+        'sourceProcessId': {key: 'spid', type:'Number', len:null,  discription: 'The ID of the source process associated with the event.'},
+        'sourceUserPrivileges': {key: 'spriv', type:'String', len:1023,  discription: 'The typical values are “Administrator”, “User”, and “Guest”. It identifies the source user’s privileges. In UNIX, for example, activity executed by the root user would be identified with “Administrator”.'},
+        'sourceProcessName': {key: 'sproc', type:'String', len:1023,  discription: 'The name of the event’s source process.'},
+        'sourcePort': {key: 'spt', type:'Number', len:null,  discription: 'The valid port numbers are 0 to 65535.'},
+        'sourceAddress': {key: 'src', type:'String', len:null,  discription: 'Identifies the source that an event refers to in an IP network. The format is an IPv4 address. Example: “192.168.10.1”.'},
+        'startTime': {key: 'start', type:'String', len:null,  discription: 'The time when the activity the event referred to started. The format is MMM dd yyyy HH:mm:ss or milliseconds since epoch (Jan 1st 1970)'},
+        'sourceUserId': {key: 'suid', type:'String', len:1023,  discription: 'Identifies the source user by ID. This is the user associated with the source of the event. For example, in UNIX, the root user is generally associated with user ID 0.'},
+        'sourceUserName': {key: 'suser', type:'String', len:1023,  discription: 'Identifies the source user by name. Email addresses are also mapped into the UserName fields. The sender is a candidate to put into this field.'},
+        'type': {key: 'type', type:'Number', len:null,  discription: '0 means base event, 1 means aggregated, 2 means correlation, and 3 means action. This field can be omitted for base events (type 0).'},
+        'agentDnsDomain': {key: 'agentDns Domain', type:'String', len:255,  discription: 'The DNS domain name of the ArcSight connector that processed the event.'},
+        'agentNtDomain': {key: 'agentNtDomain', type:'String', len:255,  discription: ''},
+        'agentTranslatedAddress': {key: 'agentTranslated Address', type:'String', len:null,  discription: ''},
+        'agentTranslatedZone ExternalID': {key: 'agentTranslated ZoneExternalID', type:'String', len:200,  discription: ''},
+        'agentTranslatedZoneURI': {key: 'agentTranslated Zone URI', type:'String', len:2048,  discription: ''},
+        'agentZoneExternalID': {key: 'agentZone ExternalID', type:'String', len:200,  discription: ''},
+        'agentZoneURI': {key: 'agentZoneURI', type:'String', len:2048,  discription: ''},
+        'agentAddress': {key: 'agt', type:'String', len:null,  discription: 'The IP address of the ArcSight connector that processed the event.'},
+        'agentHostName': {key: 'ahost', type:'String', len:1023,  discription: 'The hostname of the ArcSight connector that processed the event.'},
+        'agentId': {key: 'aid', type:'String', len:40,  discription: 'The agent ID of the ArcSight connector that processed the event.'},
+        'agentMacAddress': {key: 'amac', type:'String', len:null,  discription: 'The MAC address of the ArcSight connector that processed the event.'},
+        'agentReceiptTime': {key: 'art', type:'String', len:null,  discription: 'The time at which information about the event was received by the ArcSight connector.'},
+        'agentType': {key: 'at', type:'String', len:63,  discription: 'The agent type of the ArcSight connector that processed the event'},
+        'agentTimeZone': {key: 'atz', type:'String', len:255,  discription: 'The agent time zone of the ArcSight connector that processed the event.'},
+        'agentVersion': {key: 'av', type:'String', len:31,  discription: 'The version of the ArcSight connector that processed the event.'},
+        'customerExternalID': {key: 'customer ExternalID', type:'String', len:200,  discription: ''},
+        'customerURI': {key: 'customerURI', type:'String', len:2048,  discription: ''},
+        'destinationTranslated ZoneExternalID': {key: 'destination TranslatedZone ExternalID', type:'String', len:200,  discription: ''},
+        'destinationTranslated ZoneURI': {key: 'destination Translated ZoneURI', type:'String', len:2048,  discription: 'The URI for the Translated Zone that the destination asset has been assigned to in ArcSight.'},
+        'destinationZoneExternalID': {key: 'destinationZone ExternalID', type:'String', len:200,  discription: ''},
+        'destinationZoneURI': {key: 'destinationZone URI', type:'String', len:2048,  discription: 'The URI for the Zone that the destination asset has been assigned to in ArcSight.'},
+        'deviceTranslatedZone ExternalID': {key: 'device TranslatedZone ExternalID', type:'String', len:200,  discription: ''},
+        'deviceTranslatedZoneURI': {key: 'device TranslatedZone URI', type:'String', len:2048,  discription: 'The URI for the Translated Zone that the device asset has been assigned to in ArcSight.'},
+        'deviceZoneExternalID': {key: 'deviceZone ExternalID', type:'String', len:200,  discription: ''},
+        'deviceZoneURI': {key: 'deviceZoneURI', type:'String', len:2048,  discription: 'Thee URI for the Zone that the device asset has been assigned to in ArcSight.'},
+        'destinationGeoLatitude': {key: 'dlat', type:'Number', len:null,  discription: 'The latitudinal value from which the destination’s IP address belongs.'},
+        'destinationGeoLongitude': {key: 'dlong', type:'Number', len:null,  discription: 'The longitudinal value from which the destination’s IP address belongs.'},
+        'eventId': {key: 'eventId', type:'Number', len:null,  discription: 'This is a unique ID that ArcSight assigns to each event.'},
+        'rawEvent': {key: 'rawEvent', type:'String', len:4000,  discription: ''},
+        'sourceGeoLatitude': {key: 'slat', type:'Number', len:null,  discription: ''},
+        'sourceGeoLongitude': {key: 'slong', type:'Number', len:null,  discription: ''},
+        'sourceTranslatedZone ExternalID': {key: 'source TranslatedZone ExternalID', type:'String', len:200,  discription: ''},
+        'sourceTranslatedZoneURI': {key: 'source TranslatedZone URI', type:'String', len:2048,  discription: 'The URI for the Translated Zone that the destination asset has been assigned to in ArcSight.'},
+        'sourceZoneExternalID': {key: 'sourceZone ExternalID', type:'String', len:200,  discription: ''},
+        'sourceZoneURI': {key: 'sourceZoneURI', type:'String', len:2048,  discription: 'The URI for the Zone that the source asset has been assigned to in ArcSight.'},
+      };
+      if (typeof this.deviceVendor !== 'string'
+          || typeof this.deviceProduct !== 'string'
+          || typeof this.deviceVersion !== 'string'
+      ) {
+        reject(new Error('TYPE ERROR: CEF Device Info must be a string'));
+      }
+      if (this.severity
+          && (
+            (
+              typeof this.severity === 'string'
+              && (
+                this.severity !== 'Unknown'
+                && this.severity !== 'Low'
+                && this.severity !== 'Medium'
+                && this.severity !== 'High'
+                && this.severity !== 'Very-High'
+              )
+            )
+            || (
+              typeof this.severity === 'number'
+              && (
+                this.severity < 0
+                || this.severity > 10
+              )
+            )
+          )
+      ) {
+        reject(new Error('TYPE ERROR: CEF Severity not set correctly'));
+      }
+      const cefExts = Object.entries(this.extensions);
+      const cefExtsLen = cefExts.length;
+      for (let ext = 0; ext < cefExtsLen; ext++) {
+        if (cefExts[ext][1] !== null) {
+          if(Extensions[cefExts[ext][0]]) {
+            if (typeof cefExts[ext][1] === Extensions[cefExts[ext][0]]
+                .type
+                .toLowerCase()) {
+              if (Extensions[cefExts[ext][0]].len > 0
+                  && typeof cefExts[ext][1] === 'string'
+                  && cefExts[ext][1].length > Extensions[cefExts[ext][0]].len){
+                let errMsg = 'FORMAT ERROR:';
+                errMsg += ' CEF Extention Key';
+                errMsg += ' ' + cefExts[ext][0];
+                errMsg += ' value length is to long;';
+                errMsg += ' max length is';
+                errMsg += ' ' + Extensions[cefExts[ext][0]].len;
+                reject(new Error(errMsg));
+              }
+            } else {
+              let errMsg = 'TYPE ERROR:';
+              errMsg += ' CEF Key';
+              errMsg += ' ' + cefExts[ext][0];
+              errMsg += ' value type was expected to be';
+              errMsg += ' ' + Extensions[cefExts[ext][0]].type.toLowerCase();
+              reject(new Error(errMsg));
+            }
+          }
+        }
+      }
+      resolve(true);
+    });
+  }
+  /**
+   * Build a CEF formated string
+   * @public
+   * @return {Promise} - String with formated message
+   */    
+  buildMessage () {
+    return new Promise((resolve, reject) => {
+      let fmtMsg = 'CEF:0';
+      fmtMsg += '|' + this.deviceVendor;
+      fmtMsg += '|' + this.deviceProduct;
+      fmtMsg += '|' + this.deviceVersion;
+      fmtMsg += '|' + this.deviceEventClassId;
+      fmtMsg += '|' + this.name;
+      fmtMsg += '|' + this.severity;
+      fmtMsg += '|';
+      
+      const cefExts = Object.entries(this.extensions);
+      const cefExtsLen = cefExts.length;
+      for (let ext = 0; ext < cefExtsLen; ext++) {
+        if (cefExts[ext][1] !== null) {
+          fmtMsg += cefExts[ext][0] + '=' + cefExts[ext][1] + ' ';
+        }
+      }
+      resolve(fmtMsg);
+    });
+  }
+  /**
+   * @public
+   * @param {Syslog} [options=false] - A {@link module:SyslogPro~Syslog|
+   *    Syslog server connection} that should be used to send messages directly 
+   *    from this class. @see SyslogPro~Syslog
+   */
+  send (options) {
+    return new Promise((resolve, reject) => {
+      this.buildMessage()
+        .then((result) => {
+          if (!this.server) {
+            this.server = new Syslog(options);
+          }
+          this.server.send(result)
+            .then((sendResult) => {
+              resolve(sendResult);
+            })
+            .catch((reson) => {
+              reject(reson);
+            });
+        });
+    });
+  }
+}
+
+module.exports = {
+  RgbToAnsi: rgbToAnsi,
+  RFC3164: RFC3164,
+  RFC5424:RFC5424,
+  LEEF: LEEF,
+  CEF: CEF,
+  Syslog: Syslog
+};
    + +
    • + +
+
+ + diff --git a/docs/docco/public/fonts/aller-bold.eot b/docs/docco/public/fonts/aller-bold.eot new file mode 100644 index 0000000..1b32532 Binary files /dev/null and b/docs/docco/public/fonts/aller-bold.eot differ diff --git a/docs/docco/public/fonts/aller-bold.ttf b/docs/docco/public/fonts/aller-bold.ttf new file mode 100644 index 0000000..dc4cc9c Binary files /dev/null and b/docs/docco/public/fonts/aller-bold.ttf differ diff --git a/docs/docco/public/fonts/aller-bold.woff b/docs/docco/public/fonts/aller-bold.woff new file mode 100644 index 0000000..fa16fd0 Binary files /dev/null and b/docs/docco/public/fonts/aller-bold.woff differ diff --git a/docs/docco/public/fonts/aller-light.eot b/docs/docco/public/fonts/aller-light.eot new file mode 100644 index 0000000..40bd654 Binary files /dev/null and b/docs/docco/public/fonts/aller-light.eot differ diff --git a/docs/docco/public/fonts/aller-light.ttf b/docs/docco/public/fonts/aller-light.ttf new file mode 100644 index 0000000..c2c7290 Binary files /dev/null and b/docs/docco/public/fonts/aller-light.ttf differ diff --git a/docs/docco/public/fonts/aller-light.woff b/docs/docco/public/fonts/aller-light.woff new file mode 100644 index 0000000..81a09d1 Binary files /dev/null and b/docs/docco/public/fonts/aller-light.woff differ diff --git a/docs/docco/public/fonts/roboto-black.eot b/docs/docco/public/fonts/roboto-black.eot new file mode 100755 index 0000000..571ed49 Binary files /dev/null and b/docs/docco/public/fonts/roboto-black.eot differ diff --git a/docs/docco/public/fonts/roboto-black.ttf b/docs/docco/public/fonts/roboto-black.ttf new file mode 100755 index 0000000..e0300b3 Binary files /dev/null and b/docs/docco/public/fonts/roboto-black.ttf differ diff --git a/docs/docco/public/fonts/roboto-black.woff b/docs/docco/public/fonts/roboto-black.woff new file mode 100755 index 0000000..642e5b6 Binary files /dev/null and b/docs/docco/public/fonts/roboto-black.woff differ diff --git a/docs/docco/public/stylesheets/normalize.css b/docs/docco/public/stylesheets/normalize.css new file mode 100644 index 0000000..73abb76 --- /dev/null +++ b/docs/docco/public/stylesheets/normalize.css @@ -0,0 +1,375 @@ +/*! normalize.css v2.0.1 | MIT License | git.io/normalize */ + +/* ========================================================================== + HTML5 display definitions + ========================================================================== */ + +/* + * Corrects `block` display not defined in IE 8/9. + */ + +article, +aside, +details, +figcaption, +figure, +footer, +header, +hgroup, +nav, +section, +summary { + display: block; +} + +/* + * Corrects `inline-block` display not defined in IE 8/9. + */ + +audio, +canvas, +video { + display: inline-block; +} + +/* + * Prevents modern browsers from displaying `audio` without controls. + * Remove excess height in iOS 5 devices. + */ + +audio:not([controls]) { + display: none; + height: 0; +} + +/* + * Addresses styling for `hidden` attribute not present in IE 8/9. + */ + +[hidden] { + display: none; +} + +/* ========================================================================== + Base + ========================================================================== */ + +/* + * 1. Sets default font family to sans-serif. + * 2. Prevents iOS text size adjust after orientation change, without disabling + * user zoom. + */ + +html { + font-family: sans-serif; /* 1 */ + -webkit-text-size-adjust: 100%; /* 2 */ + -ms-text-size-adjust: 100%; /* 2 */ +} + +/* + * Removes default margin. + */ + +body { + margin: 0; +} + +/* ========================================================================== + Links + ========================================================================== */ + +/* + * Addresses `outline` inconsistency between Chrome and other browsers. + */ + +a:focus { + outline: thin dotted; +} + +/* + * Improves readability when focused and also mouse hovered in all browsers. + */ + +a:active, +a:hover { + outline: 0; +} + +/* ========================================================================== + Typography + ========================================================================== */ + +/* + * Addresses `h1` font sizes within `section` and `article` in Firefox 4+, + * Safari 5, and Chrome. + */ + +h1 { + font-size: 2em; +} + +/* + * Addresses styling not present in IE 8/9, Safari 5, and Chrome. + */ + +abbr[title] { + border-bottom: 1px dotted; +} + +/* + * Addresses style set to `bolder` in Firefox 4+, Safari 5, and Chrome. + */ + +b, +strong { + font-weight: bold; +} + +/* + * Addresses styling not present in Safari 5 and Chrome. + */ + +dfn { + font-style: italic; +} + +/* + * Addresses styling not present in IE 8/9. + */ + +mark { + background: #ff0; + color: #000; +} + + +/* + * Corrects font family set oddly in Safari 5 and Chrome. + */ + +code, +kbd, +pre, +samp { + font-family: monospace, serif; + font-size: 1em; +} + +/* + * Improves readability of pre-formatted text in all browsers. + */ + +pre { + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; +} + +/* + * Sets consistent quote types. + */ + +q { + quotes: "\201C" "\201D" "\2018" "\2019"; +} + +/* + * Addresses inconsistent and variable font size in all browsers. + */ + +small { + font-size: 80%; +} + +/* + * Prevents `sub` and `sup` affecting `line-height` in all browsers. + */ + +sub, +sup { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline; +} + +sup { + top: -0.5em; +} + +sub { + bottom: -0.25em; +} + +/* ========================================================================== + Embedded content + ========================================================================== */ + +/* + * Removes border when inside `a` element in IE 8/9. + */ + +img { + border: 0; +} + +/* + * Corrects overflow displayed oddly in IE 9. + */ + +svg:not(:root) { + overflow: hidden; +} + +/* ========================================================================== + Figures + ========================================================================== */ + +/* + * Addresses margin not present in IE 8/9 and Safari 5. + */ + +figure { + margin: 0; +} + +/* ========================================================================== + Forms + ========================================================================== */ + +/* + * Define consistent border, margin, and padding. + */ + +fieldset { + border: 1px solid #c0c0c0; + margin: 0 2px; + padding: 0.35em 0.625em 0.75em; +} + +/* + * 1. Corrects color not being inherited in IE 8/9. + * 2. Remove padding so people aren't caught out if they zero out fieldsets. + */ + +legend { + border: 0; /* 1 */ + padding: 0; /* 2 */ +} + +/* + * 1. Corrects font family not being inherited in all browsers. + * 2. Corrects font size not being inherited in all browsers. + * 3. Addresses margins set differently in Firefox 4+, Safari 5, and Chrome + */ + +button, +input, +select, +textarea { + font-family: inherit; /* 1 */ + font-size: 100%; /* 2 */ + margin: 0; /* 3 */ +} + +/* + * Addresses Firefox 4+ setting `line-height` on `input` using `!important` in + * the UA stylesheet. + */ + +button, +input { + line-height: normal; +} + +/* + * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` + * and `video` controls. + * 2. Corrects inability to style clickable `input` types in iOS. + * 3. Improves usability and consistency of cursor style between image-type + * `input` and others. + */ + +button, +html input[type="button"], /* 1 */ +input[type="reset"], +input[type="submit"] { + -webkit-appearance: button; /* 2 */ + cursor: pointer; /* 3 */ +} + +/* + * Re-set default cursor for disabled elements. + */ + +button[disabled], +input[disabled] { + cursor: default; +} + +/* + * 1. Addresses box sizing set to `content-box` in IE 8/9. + * 2. Removes excess padding in IE 8/9. + */ + +input[type="checkbox"], +input[type="radio"] { + box-sizing: border-box; /* 1 */ + padding: 0; /* 2 */ +} + +/* + * 1. Addresses `appearance` set to `searchfield` in Safari 5 and Chrome. + * 2. Addresses `box-sizing` set to `border-box` in Safari 5 and Chrome + * (include `-moz` to future-proof). + */ + +input[type="search"] { + -webkit-appearance: textfield; /* 1 */ + -moz-box-sizing: content-box; + -webkit-box-sizing: content-box; /* 2 */ + box-sizing: content-box; +} + +/* + * Removes inner padding and search cancel button in Safari 5 and Chrome + * on OS X. + */ + +input[type="search"]::-webkit-search-cancel-button, +input[type="search"]::-webkit-search-decoration { + -webkit-appearance: none; +} + +/* + * Removes inner padding and border in Firefox 4+. + */ + +button::-moz-focus-inner, +input::-moz-focus-inner { + border: 0; + padding: 0; +} + +/* + * 1. Removes default vertical scrollbar in IE 8/9. + * 2. Improves readability and alignment in all browsers. + */ + +textarea { + overflow: auto; /* 1 */ + vertical-align: top; /* 2 */ +} + +/* ========================================================================== + Tables + ========================================================================== */ + +/* + * Remove most spacing between table cells. + */ + +table { + border-collapse: collapse; + border-spacing: 0; +} \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 9520683..8183c56 100644 --- a/docs/index.html +++ b/docs/index.html @@ -50,92 +50,107 @@
-

SyslogPro

A pure Javascript Syslog module with support for RFC3164, RFC5424, IBM LEEF +

SyslogPro

Build Status +Coverage Status +

+

Site | +Docs | +Wiki | +Code of Conduct

+

A pure Javascript Syslog module with support for RFC3164, RFC5424, IBM LEEF (Log Event Extended Format), and HP CEF (Common Event Format) formatted -messages. SyslogPro has transport options of UDP, TCP, and TLS. TLS includes -support for Server and Client certificate authrization. For unformatedm and +messages. SyslogPro has transport options for UDP, TCP, and TLS. TLS includes +support for Server and Client certificate authorization. For unformatted and RFC messages there is support for Basic and Extended ANSI coloring. RFC5424 -Strucutred Data is also encluded in the module. All 28 standard CEF Extentions -are included in the defualt CEF class. All 45 standard LEEF Atrabutes are -included in the defualt LEEF class. It is the goal of this project is for every -relase to offer full code covrage unit testing and documentation. Please see -the full documation for usage and options.

-

Installation

npm install SyslogPro

-

Usage

const SyslogPro = require('syslogpro');
-
-let syslog = new SyslogPro.Syslog({
-  target: 'localhost',
-  protocol: 'udp',
-  format: 'rfc5424'
-});
-
-syslog.rfc5424.info('My Message');
-
-// Optionaly you can create each class or class options to pass to SyslogPro
-// to create formated messages or use directly
-
-let rfc3164 = new SyslogPro.RFC3164({
-  applacationName: 'MyApp',
-  color: true,
-  extendedColor: true,
-  server: {
-    target: 'myServer.fqdn'
-  }
-});
-
-rfc3164.info('My Message');
-
-let rfc5424 = new SyslogPro.RFC5424({
-  applacationName: 'MyApp',
-  timestamp: true,
-  encludeStructuredData: true
-  color: true,
-  extendedColor: true,
-  server: {
-    target: 'myServer.fqdn'
-  }
-});
-
-rfc5424.info('My Message');
-
-let leef = new SyslogPro.LEEF({
-  vendor: 'acme',
-  product: 'doohickey1000',
-  version: 'alpha',
-  eventId: 'hack',
-  attrabutes: {
-    cat: 'CC Databreach'
-  },
-  server: {
-    target: 'myServer.fqdn'
-  }
-})
-    .send()
-        .then((result) => {})
-        .catch((error) => {
-          console.log(error);
-        });
-
-let cef = new SyslogPro.CEF({
-  deviceVendor: 'acme',
-  deviceProduct: 'doohickey1000',
-  deviceVersion: 'alpha',
-  deviceEventClassId: 'hack',
-  name: 'My Reporting Service',
-  severity: 'High',
-  extensions: {
-    rawEvent: 'CC Databreach'
-  },
-  server: {
-    target: 'myServer.fqdn'
-  }
-})
-    .send()
-        .then((result) => {})
-        .catch((error) => {
-          console.log(error);
-        });

Tests

npm test

-

Contributing

Please try to stay close to the Google JS Style Guid, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.

+Structured Data is also included in the module. All 28 standard CEF Extensions +are included in the default CEF class. All 45 standard LEEF Attributes are +included in the default LEEF class. It is the goal of this project is for +every release to offer full code coverage unit testing and documentation.

+

Please see the full JSDoc for usage and options: +https://cyamato.github.io/SyslogPro/.

+

News

+

Installation

  npm install --save SyslogPro

Usage

  const SyslogPro = require('syslogpro');
+  let syslog = new SyslogPro.Syslog({
+    target: 'localhost',
+    protocol: 'udp',
+    format: 'rfc5424'
+  });
+  syslog.rfc5424.info('My Message');

Optionaly you can create each class or class options to pass to SyslogPro + to create formated messages or use directly

+

RFC3164

+
  let rfc3164 = new SyslogPro.RFC3164({
+    applacationName: 'MyApp',
+    color: true,
+    extendedColor: true,
+    server: {
+      target: 'myServer.fqdn'
+    }
+  });
+  rfc3164.info('My Message');

RFC5424

+
  let rfc5424 = new SyslogPro.RFC5424({
+    applacationName: 'MyApp',
+    timestamp: true,
+    encludeStructuredData: true
+    color: true,
+    extendedColor: true,
+    server: {
+      target: 'myServer.fqdn'
+    }
+  });
+  rfc5424.info('My Message');

LEEF (Log Event Extended Format)

+
  let leef = new SyslogPro.LEEF({
+    vendor: 'acme',
+    product: 'doohickey1000',
+    version: 'alpha',
+    eventId: 'hack',
+    attrabutes: {
+      cat: 'CC Databreach'
+    },
+    server: {
+      target: 'myServer.fqdn'
+    }
+  })
+      .send()
+          .then((result) => {})
+          .catch((error) => {
+            console.log(error);
+          });

CEF (Common Event Format)

+
  let cef = new SyslogPro.CEF({
+    deviceVendor: 'acme',
+    deviceProduct: 'doohickey1000',
+    deviceVersion: 'alpha',
+    deviceEventClassId: 'hack',
+    name: 'My Reporting Service',
+    severity: 'High',
+    extensions: {
+      rawEvent: 'CC Databreach'
+    },
+    server: {
+      target: 'myServer.fqdn'
+    }
+  })
+      .send()
+          .then((result) => {})
+          .catch((error) => {
+            console.log(error);
+          });

API

For more details see:

+ +

Test

  npm test

Contributing

Please try to maintain the existing coding style. Add unit tests for any new or +changed functionality. Lint and test your code.

+
@@ -150,7 +165,7 @@ let cef = new SyslogPro.CEF({
- Documentation generated by JSDoc 3.5.5 on Mon Sep 24 2018 06:41:35 GMT+0000 (Coordinated Universal Time) using the docdash theme. + Documentation generated by JSDoc 3.5.5 on Tue Sep 25 2018 18:22:00 GMT+0000 (Coordinated Universal Time) using the docdash theme.
diff --git a/docs/index.js.html b/docs/index.js.html index 629bd2d..a363064 100644 --- a/docs/index.js.html +++ b/docs/index.js.html @@ -44,11 +44,17 @@ 
/** Copyright (c) 2018 Craig Yamato */
 
 /**
- * @fileoverview The SyslogPro class for sending syslog messages
+ * @fileoverview The SyslogPro module for sending syslog messages
+ * Most APIs will return a promise. These APIs can be used using 
+ * `then(...)/catch(...)`
+ *
+ * Syslog formating classes can be used as input into a Syslog class to be used 
+ * simultatniusly to the same Syslog server.  The Syslog Class with a configured
+ * Syslog server target can also be used as the input into each of the formating 
+ * classes so that they may run independtly.
  * @author Craig Yamato <craig@kentik.com>
  * @copyright (c) 2018 - Craig Yamato
- * @version 0.0.0
- * @since 0.0.0
+ * @version 0.1.0
  * @exports Syslog
  * @exports LEEF
  * @exports CEF
@@ -133,15 +139,16 @@ function rgbToAnsi (hex, extendedColor) {
  * A class to work with syslog messages using UDP, TCP, or TLS transport.  
  * There is suport for Syslog message formating RFC-3164, RFC-5424 including 
  * Structured Data, IBM LEEF (Log Event Extended Format), and HP CEF (Common
- * Event Format). The meesaging is fully configurabule and Ansi foreground 
- * colors can be added.  Both ANSI 8 and ANSI 256 color are fully suported.
+ * Event Format).
+ * Syslog formating classes can be used as input into a Syslog class to be used 
+ * simultatniusly to the same Syslog server. * 
  * @requires moment
  * @version 0.0.0
  * @since 0.0.0
  */
 class Syslog {
   /**
-   * Construct a new Syslog object with user options 
+   * Construct a new Syslog transport object with user options 
    * @public
    * @version 0.0.0
    * @since 0.0.0
@@ -486,7 +493,18 @@ class Syslog {
 }
  
 /**
- * A class to work with RFC3164 formated syslog messages.
+ * A class to work with RFC3164 formated syslog messages. The meesaging is fully configurabule and Ansi foreground 
+ * colors can be added.  Both ANSI 8 and ANSI 256 color are fully suported.
+ * Most APIs will return a promise. These APIs can be used using 
+ * `then(...)/catch(...)`
+ * 
+ * A Syslog class with a configured
+ * Syslog server target can also be used as the input into the formating 
+ * classes so that it may run independtly.
+ * 
+ * The RFC3164 Syslog logging format is ment to be used as a stream of log data 
+ * from a service or applacation. This class is designed to be used in this
+ * fashion where new messages are writen to the class as needed.
  * @requires moment
  * @version 0.0.0
  * @since 0.0.0
@@ -1034,7 +1052,18 @@ class RFC3164 {
 }
 
 /**
- * A class to work with RFC5424 formated syslog messages.
+ * A class to work with RFC5424 formated syslog messages. The meesaging is fully configurabule and Ansi foreground 
+ * colors can be added.  Both ANSI 8 and ANSI 256 color are fully suported.
+ * Most APIs will return a promise. These APIs can be used using 
+ * `then(...)/catch(...)`
+ * 
+ * A Syslog class with a configured
+ * Syslog server target can also be used as the input into the formating 
+ * classes so that it may run independtly.
+ * 
+ * The RFC5424 Syslog logging format is ment to be used as a stream of log data 
+ * from a service or applacation. This class is designed to be used in this
+ * fashion where new messages are writen to the class as needed.
  * @requires moment
  * @version 0.0.0
  * @since 0.0.0
@@ -1704,14 +1733,21 @@ class RFC5424 {
  * 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.
+ * sent via Syslog. 
+ * Most APIs will return a promise. These APIs can be used using 
+ * `then(...)/catch(...)`
+ * 
+ * A Syslog class with a configured Syslog server target can also be used as 
+ * the input into the formating classes so that it may run independtly. The 
+ * LEEF format is designed to send event data to a SIEM system and should not 
+ * be as a logging stream. This class is ment to be used once per message.
  * @requires moment
  * @version 0.0.0
  * @since 0.0.0
  */
 class LEEF {
   /**
-   * Construct a new LEEF object with user options 
+   * Construct a new LEEF formating object with user options
    * @public
    * @param {object} [options] - Options object
    * @param {string} [options.vendor='unknown'] - The vendor of the system that
@@ -1862,13 +1898,20 @@ class LEEF {
  * be saved to file (Saving to file if not part of this module but a CEF 
  * formated mesage produced by this module can be saved externaly to it) or 
  * sent via Syslog.
+ * Most APIs will return a promise. These APIs can be used using 
+ * `then(...)/catch(...)`
+ * 
+ * A Syslog class with a configured Syslog server target can also be used as 
+ * the input into the formating classes so that it may run independtly. The CEF 
+ * format is designed to send event data to a SIEM system and should not be as 
+ * a logging stream. This class is ment to be used once per message.
  * @requires moment
  * @version 0.0.0
  * @since 0.0.0
  */
 class CEF {
   /**
-   * Construct a new CEF object with user options 
+   * Construct a new CEF formating object with user options 
    * @public
    * @param {object} [options] - Options object
    * @param {string} [options.deviceVendor='unknown'] - The vendor of the system 
@@ -2373,7 +2416,7 @@ module.exports = {
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Mon Sep 24 2018 06:41:35 GMT+0000 (Coordinated Universal Time) using the docdash theme.
+    Documentation generated by JSDoc 3.5.5 on Tue Sep 25 2018 18:22:00 GMT+0000 (Coordinated Universal Time) using the docdash theme.
 

 
 
diff --git a/docs/module-SyslogPro-CEF.html b/docs/module-SyslogPro-CEF.html
index 2ed9944..b0465d5 100644
--- a/docs/module-SyslogPro-CEF.html
+++ b/docs/module-SyslogPro-CEF.html
@@ -53,7 +53,14 @@
 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 CEF 
 formated mesage produced by this module can be saved externaly to it) or 
-sent via Syslog.
+sent via Syslog.
+Most APIs will return a promise. These APIs can be used using 
+`then(...)/catch(...)`
+
+A Syslog class with a configured Syslog server target can also be used as 
+the input into the formating classes so that it may run independtly. The CEF 
+format is designed to send event data to a SIEM system and should not be as 
+a logging stream. This class is ment to be used once per message.
         
     
 
@@ -80,7 +87,7 @@ sent via Syslog.
     
     
Source:

     

     
 
@@ -126,7 +133,7 @@ sent via Syslog.
 
 
 

-    Construct a new CEF object with user options
+    Construct a new CEF formating object with user options
 

 
 
@@ -603,7 +610,7 @@ sent via Syslog.
     
     
Source:

     

     
 
@@ -662,7 +669,7 @@ sent via Syslog.
     
     
Source:

     

     
 
@@ -731,7 +738,7 @@ sent via Syslog.
     
     
Source:

     

     
 
@@ -800,7 +807,7 @@ sent via Syslog.
     
     
Source:

     

     
 
@@ -869,7 +876,7 @@ sent via Syslog.
     
     
Source:

     

     
 
@@ -938,7 +945,7 @@ sent via Syslog.
     
     
Source:

     

     
 
@@ -1007,7 +1014,7 @@ sent via Syslog.
     
     
Source:

     

     
 
@@ -1076,7 +1083,7 @@ sent via Syslog.
     
     
Source:

     

     
 
@@ -1135,7 +1142,7 @@ sent via Syslog.
     
     
Source:

     

     
 
@@ -1214,7 +1221,7 @@ sent via Syslog.
     
     
Source:

     

     
 
@@ -1320,7 +1327,7 @@ sent via Syslog.
     
     
Source:

     

     
 
@@ -1470,7 +1477,7 @@ sent via Syslog.
     
     
Source:

     

     
 
@@ -1608,7 +1615,7 @@ sent via Syslog.
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Mon Sep 24 2018 06:41:35 GMT+0000 (Coordinated Universal Time) using the docdash theme.
+    Documentation generated by JSDoc 3.5.5 on Tue Sep 25 2018 18:22:00 GMT+0000 (Coordinated Universal Time) using the docdash theme.
 

 
 
diff --git a/docs/module-SyslogPro-LEEF.html b/docs/module-SyslogPro-LEEF.html
index de36096..6fae4e5 100644
--- a/docs/module-SyslogPro-LEEF.html
+++ b/docs/module-SyslogPro-LEEF.html
@@ -53,7 +53,14 @@
 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.
+sent via Syslog. 
+Most APIs will return a promise. These APIs can be used using 
+`then(...)/catch(...)`
+
+A Syslog class with a configured Syslog server target can also be used as 
+the input into the formating classes so that it may run independtly. The 
+LEEF format is designed to send event data to a SIEM system and should not 
+be as a logging stream. This class is ment to be used once per message.
         
     
 
@@ -80,7 +87,7 @@ sent via Syslog.
     
     
Source:

     

     
 
@@ -126,7 +133,7 @@ sent via Syslog.
 
 
 

-    Construct a new LEEF object with user options
+    Construct a new LEEF formating object with user options
 

 
 
@@ -564,7 +571,7 @@ sent via Syslog.
     
     
Source:

     

     
 
@@ -633,7 +640,7 @@ sent via Syslog.
     
     
Source:

     

     
 
@@ -692,7 +699,7 @@ sent via Syslog.
     
     
Source:

     

     
 
@@ -761,7 +768,7 @@ sent via Syslog.
     
     
Source:

     

     
 
@@ -830,7 +837,7 @@ sent via Syslog.
     
     
Source:

     

     
 
@@ -889,7 +896,7 @@ sent via Syslog.
     
     
Source:

     

     
 
@@ -958,7 +965,7 @@ sent via Syslog.
     
     
Source:

     

     
 
@@ -1027,7 +1034,7 @@ sent via Syslog.
     
     
Source:

     

     
 
@@ -1106,7 +1113,7 @@ sent via Syslog.
     
     
Source:

     

     
 
@@ -1212,7 +1219,7 @@ sent via Syslog.
     
     
Source:

     

     
 
@@ -1365,7 +1372,7 @@ sent via Syslog.
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Mon Sep 24 2018 06:41:35 GMT+0000 (Coordinated Universal Time) using the docdash theme.
+    Documentation generated by JSDoc 3.5.5 on Tue Sep 25 2018 18:22:00 GMT+0000 (Coordinated Universal Time) using the docdash theme.
 

 
 
diff --git a/docs/module-SyslogPro-RFC3164.html b/docs/module-SyslogPro-RFC3164.html
index dda9c08..2c7a9d0 100644
--- a/docs/module-SyslogPro-RFC3164.html
+++ b/docs/module-SyslogPro-RFC3164.html
@@ -49,7 +49,18 @@
         RFC3164
         
         
-            
A class to work with RFC3164 formated syslog messages.

+            
A class to work with RFC3164 formated syslog messages. The meesaging is fully configurabule and Ansi foreground 
+colors can be added.  Both ANSI 8 and ANSI 256 color are fully suported.
+Most APIs will return a promise. These APIs can be used using 
+`then(...)/catch(...)`
+
+A Syslog class with a configured
+Syslog server target can also be used as the input into the formating 
+classes so that it may run independtly.
+
+The RFC3164 Syslog logging format is ment to be used as a stream of log data 
+from a service or applacation. This class is designed to be used in this
+fashion where new messages are writen to the class as needed.

         
     
 
@@ -76,7 +87,7 @@
     
     
Source:

     

     
 
@@ -865,7 +876,7 @@
     
     
Source:

     

     
 
@@ -924,7 +935,7 @@
     
     
Source:

     

     
 
@@ -993,7 +1004,7 @@
     
     
Source:

     

     
 
@@ -1052,7 +1063,7 @@
     
     
Source:

     

     
 
@@ -1111,7 +1122,7 @@
     
     
Source:

     

     
 
@@ -1170,7 +1181,7 @@
     
     
Source:

     

     
 
@@ -1229,7 +1240,7 @@
     
     
Source:

     

     
 
@@ -1288,7 +1299,7 @@
     
     
Source:

     

     
 
@@ -1357,7 +1368,7 @@
     
     
Source:

     

     
 
@@ -1416,7 +1427,7 @@
     
     
Source:

     

     
 
@@ -1475,7 +1486,7 @@
     
     
Source:

     

     
 
@@ -1534,7 +1545,7 @@
     
     
Source:

     

     
 
@@ -1603,7 +1614,7 @@
     
     
Source:

     

     
 
@@ -1787,7 +1798,7 @@
     
     
Source:

     

     
 
@@ -2123,7 +2134,7 @@
     
     
Source:

     

     
 
@@ -2307,7 +2318,7 @@
     
     
Source:

     

     
 
@@ -2491,7 +2502,7 @@
     
     
Source:

     

     
 
@@ -2675,7 +2686,7 @@
     
     
Source:

     

     
 
@@ -2859,7 +2870,7 @@
     
     
Source:

     

     
 
@@ -3043,7 +3054,7 @@
     
     
Source:

     

     
 
@@ -3227,7 +3238,7 @@
     
     
Source:

     

     
 
@@ -3411,7 +3422,7 @@
     
     
Source:

     

     
 
@@ -3595,7 +3606,7 @@
     
     
Source:

     

     
 
@@ -3779,7 +3790,7 @@
     
     
Source:

     

     
 
@@ -3963,7 +3974,7 @@
     
     
Source:

     

     
 
@@ -4147,7 +4158,7 @@
     
     
Source:

     

     
 
@@ -4331,7 +4342,7 @@
     
     
Source:

     

     
 
@@ -4675,7 +4686,7 @@
     
     
Source:

     

     
 
@@ -5096,7 +5107,7 @@
     
     
Source:

     

     
 
@@ -5280,7 +5291,7 @@
     
     
Source:

     

     
 
@@ -5467,7 +5478,7 @@
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Mon Sep 24 2018 06:41:35 GMT+0000 (Coordinated Universal Time) using the docdash theme.
+    Documentation generated by JSDoc 3.5.5 on Tue Sep 25 2018 18:22:00 GMT+0000 (Coordinated Universal Time) using the docdash theme.
 

 
 
diff --git a/docs/module-SyslogPro-RFC5424.html b/docs/module-SyslogPro-RFC5424.html
index f4a7017..d348606 100644
--- a/docs/module-SyslogPro-RFC5424.html
+++ b/docs/module-SyslogPro-RFC5424.html
@@ -49,7 +49,18 @@
         RFC5424
         
         
-            
A class to work with RFC5424 formated syslog messages.

+            
A class to work with RFC5424 formated syslog messages. The meesaging is fully configurabule and Ansi foreground 
+colors can be added.  Both ANSI 8 and ANSI 256 color are fully suported.
+Most APIs will return a promise. These APIs can be used using 
+`then(...)/catch(...)`
+
+A Syslog class with a configured
+Syslog server target can also be used as the input into the formating 
+classes so that it may run independtly.
+
+The RFC5424 Syslog logging format is ment to be used as a stream of log data 
+from a service or applacation. This class is designed to be used in this
+fashion where new messages are writen to the class as needed.

         
     
 
@@ -76,7 +87,7 @@
     
     
Source:

     

     
 
@@ -1062,7 +1073,7 @@
     
     
Source:

     

     
 
@@ -1121,7 +1132,7 @@
     
     
Source:

     

     
 
@@ -1190,7 +1201,7 @@
     
     
Source:

     

     
 
@@ -1249,7 +1260,7 @@
     
     
Source:

     

     
 
@@ -1308,7 +1319,7 @@
     
     
Source:

     

     
 
@@ -1367,7 +1378,7 @@
     
     
Source:

     

     
 
@@ -1426,7 +1437,7 @@
     
     
Source:

     

     
 
@@ -1495,7 +1506,7 @@
     
     
Source:

     

     
 
@@ -1554,7 +1565,7 @@
     
     
Source:

     

     
 
@@ -1623,7 +1634,7 @@
     
     
Source:

     

     
 
@@ -1682,7 +1693,7 @@
     
     
Source:

     

     
 
@@ -1741,7 +1752,7 @@
     
     
Source:

     

     
 
@@ -1800,7 +1811,7 @@
     
     
Source:

     

     
 
@@ -1869,7 +1880,7 @@
     
     
Source:

     

     
 
@@ -1938,7 +1949,7 @@
     
     
Source:

     

     
 
@@ -2007,7 +2018,7 @@
     
     
Source:

     

     
 
@@ -2076,7 +2087,7 @@
     
     
Source:

     

     
 
@@ -2145,7 +2156,7 @@
     
     
Source:

     

     
 
@@ -2214,7 +2225,7 @@
     
     
Source:

     

     
 
@@ -2398,7 +2409,7 @@
     
     
Source:

     

     
 
@@ -2855,7 +2866,7 @@
     
     
Source:

     

     
 
@@ -3039,7 +3050,7 @@
     
     
Source:

     

     
 
@@ -3223,7 +3234,7 @@
     
     
Source:

     

     
 
@@ -3407,7 +3418,7 @@
     
     
Source:

     

     
 
@@ -3591,7 +3602,7 @@
     
     
Source:

     

     
 
@@ -3775,7 +3786,7 @@
     
     
Source:

     

     
 
@@ -3959,7 +3970,7 @@
     
     
Source:

     

     
 
@@ -4143,7 +4154,7 @@
     
     
Source:

     

     
 
@@ -4327,7 +4338,7 @@
     
     
Source:

     

     
 
@@ -4511,7 +4522,7 @@
     
     
Source:

     

     
 
@@ -4695,7 +4706,7 @@
     
     
Source:

     

     
 
@@ -4879,7 +4890,7 @@
     
     
Source:

     

     
 
@@ -5063,7 +5074,7 @@
     
     
Source:

     

     
 
@@ -5256,7 +5267,7 @@
     
     
Source:

     

     
 
@@ -5677,7 +5688,7 @@
     
     
Source:

     

     
 
@@ -5861,7 +5872,7 @@
     
     
Source:

     

     
 
@@ -6048,7 +6059,7 @@
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Mon Sep 24 2018 06:41:35 GMT+0000 (Coordinated Universal Time) using the docdash theme.
+    Documentation generated by JSDoc 3.5.5 on Tue Sep 25 2018 18:22:00 GMT+0000 (Coordinated Universal Time) using the docdash theme.
 

 
 
diff --git a/docs/module-SyslogPro-Syslog.html b/docs/module-SyslogPro-Syslog.html
index 39932e5..612b5d6 100644
--- a/docs/module-SyslogPro-Syslog.html
+++ b/docs/module-SyslogPro-Syslog.html
@@ -52,8 +52,9 @@
             
A class to work with syslog messages using UDP, TCP, or TLS transport.  
 There is suport for Syslog message formating RFC-3164, RFC-5424 including 
 Structured Data, IBM LEEF (Log Event Extended Format), and HP CEF (Common
-Event Format). The meesaging is fully configurabule and Ansi foreground 
-colors can be added.  Both ANSI 8 and ANSI 256 color are fully suported.

+Event Format).
+Syslog formating classes can be used as input into a Syslog class to be used 
+simultatniusly to the same Syslog server. *
         
     
 
@@ -80,7 +81,7 @@ colors can be added.  Both ANSI 8 and ANSI 256 color are fully suported.
     
     
Source:

     

     
 
@@ -126,7 +127,7 @@ colors can be added.  Both ANSI 8 and ANSI 256 color are fully suported.
 
 
 

-    Construct a new Syslog object with user options
+    Construct a new Syslog transport object with user options
 

 
 
@@ -755,7 +756,7 @@ colors can be added.  Both ANSI 8 and ANSI 256 color are fully suported.
     
     
Source:

     

     
 
@@ -824,7 +825,7 @@ colors can be added.  Both ANSI 8 and ANSI 256 color are fully suported.
     
     
Source:

     

     
 
@@ -893,7 +894,7 @@ colors can be added.  Both ANSI 8 and ANSI 256 color are fully suported.
     
     
Source:

     

     
 
@@ -962,7 +963,7 @@ colors can be added.  Both ANSI 8 and ANSI 256 color are fully suported.
     
     
Source:

     

     
 
@@ -1031,7 +1032,7 @@ colors can be added.  Both ANSI 8 and ANSI 256 color are fully suported.
     
     
Source:

     

     
 
@@ -1100,7 +1101,7 @@ colors can be added.  Both ANSI 8 and ANSI 256 color are fully suported.
     
     
Source:

     

     
 
@@ -1169,7 +1170,7 @@ colors can be added.  Both ANSI 8 and ANSI 256 color are fully suported.
     
     
Source:

     

     
 
@@ -1238,7 +1239,7 @@ colors can be added.  Both ANSI 8 and ANSI 256 color are fully suported.
     
     
Source:

     

     
 
@@ -1307,7 +1308,7 @@ colors can be added.  Both ANSI 8 and ANSI 256 color are fully suported.
     
     
Source:

     

     
 
@@ -1376,7 +1377,7 @@ colors can be added.  Both ANSI 8 and ANSI 256 color are fully suported.
     
     
Source:

     

     
 
@@ -1445,7 +1446,7 @@ colors can be added.  Both ANSI 8 and ANSI 256 color are fully suported.
     
     
Source:

     

     
 
@@ -1514,7 +1515,7 @@ colors can be added.  Both ANSI 8 and ANSI 256 color are fully suported.
     
     
Source:

     

     
 
@@ -1583,7 +1584,7 @@ colors can be added.  Both ANSI 8 and ANSI 256 color are fully suported.
     
     
Source:

     

     
 
@@ -1652,7 +1653,7 @@ colors can be added.  Both ANSI 8 and ANSI 256 color are fully suported.
     
     
Source:

     

     
 
@@ -1847,7 +1848,7 @@ input as a file location straing and add it to an array of certificates
     
     
Source:

     

     
 
@@ -2059,7 +2060,7 @@ selected transport.
     
     
Source:

     

     
 
@@ -2270,7 +2271,7 @@ selected transport.
     
     
Source:

     

     
 
@@ -2481,7 +2482,7 @@ selected transport.
     
     
Source:

     

     
 
@@ -2668,7 +2669,7 @@ selected transport.
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Mon Sep 24 2018 06:41:36 GMT+0000 (Coordinated Universal Time) using the docdash theme.
+    Documentation generated by JSDoc 3.5.5 on Tue Sep 25 2018 18:22:00 GMT+0000 (Coordinated Universal Time) using the docdash theme.
 

 
 
diff --git a/docs/module-SyslogPro.html b/docs/module-SyslogPro.html
index ba55b56..64004a3 100644
--- a/docs/module-SyslogPro.html
+++ b/docs/module-SyslogPro.html
@@ -54,7 +54,14 @@
         

         
             
-                
The SyslogPro class for sending syslog messages

+                
The SyslogPro module for sending syslog messages
+Most APIs will return a promise. These APIs can be used using 
+`then(...)/catch(...)`
+
+Syslog formating classes can be used as input into a Syslog class to be used 
+simultatniusly to the same Syslog server.  The Syslog Class with a configured
+Syslog server target can also be used as the input into each of the formating 
+classes so that they may run independtly.

             
 
             
@@ -74,13 +81,10 @@
 
     
     
Version:

-    
  • 0.0.0

+    
  • 0.1.0

     
 
     
-    
Since:

-    
  • 0.0.0

-    
 
     
 
@@ -203,7 +207,7 @@
     
     
Source:

     

     
 
@@ -391,7 +395,7 @@
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Mon Sep 24 2018 06:41:35 GMT+0000 (Coordinated Universal Time) using the docdash theme.
+    Documentation generated by JSDoc 3.5.5 on Tue Sep 25 2018 18:22:00 GMT+0000 (Coordinated Universal Time) using the docdash theme.
 

 
 
diff --git a/index.js b/index.js
index 786914a..874be00 100644
--- a/index.js
+++ b/index.js
@@ -1,11 +1,17 @@
 /** Copyright (c) 2018 Craig Yamato */
 
 /**
- * @fileoverview The SyslogPro class for sending syslog messages
+ * @fileoverview The SyslogPro module for sending syslog messages
+ * Most APIs will return a promise. These APIs can be used using 
+ * `then(...)/catch(...)`
+ *
+ * Syslog formating classes can be used as input into a Syslog class to be used 
+ * simultatniusly to the same Syslog server.  The Syslog Class with a configured
+ * Syslog server target can also be used as the input into each of the formating 
+ * classes so that they may run independtly.
  * @author Craig Yamato 
  * @copyright (c) 2018 - Craig Yamato
- * @version 0.0.0
- * @since 0.0.0
+ * @version 0.1.0
  * @exports Syslog
  * @exports LEEF
  * @exports CEF
@@ -90,15 +96,16 @@ function rgbToAnsi (hex, extendedColor) {
  * A class to work with syslog messages using UDP, TCP, or TLS transport.  
  * There is suport for Syslog message formating RFC-3164, RFC-5424 including 
  * Structured Data, IBM LEEF (Log Event Extended Format), and HP CEF (Common
- * Event Format). The meesaging is fully configurabule and Ansi foreground 
- * colors can be added.  Both ANSI 8 and ANSI 256 color are fully suported.
+ * Event Format).
+ * Syslog formating classes can be used as input into a Syslog class to be used 
+ * simultatniusly to the same Syslog server. * 
  * @requires moment
  * @version 0.0.0
  * @since 0.0.0
  */
 class Syslog {
   /**
-   * Construct a new Syslog object with user options 
+   * Construct a new Syslog transport object with user options 
    * @public
    * @version 0.0.0
    * @since 0.0.0
@@ -443,7 +450,18 @@ class Syslog {
 }
  
 /**
- * A class to work with RFC3164 formated syslog messages.
+ * A class to work with RFC3164 formated syslog messages. The meesaging is fully configurabule and Ansi foreground 
+ * colors can be added.  Both ANSI 8 and ANSI 256 color are fully suported.
+ * Most APIs will return a promise. These APIs can be used using 
+ * `then(...)/catch(...)`
+ * 
+ * A Syslog class with a configured
+ * Syslog server target can also be used as the input into the formating 
+ * classes so that it may run independtly.
+ * 
+ * The RFC3164 Syslog logging format is ment to be used as a stream of log data 
+ * from a service or applacation. This class is designed to be used in this
+ * fashion where new messages are writen to the class as needed.
  * @requires moment
  * @version 0.0.0
  * @since 0.0.0
@@ -991,7 +1009,18 @@ class RFC3164 {
 }
 
 /**
- * A class to work with RFC5424 formated syslog messages.
+ * A class to work with RFC5424 formated syslog messages. The meesaging is fully configurabule and Ansi foreground 
+ * colors can be added.  Both ANSI 8 and ANSI 256 color are fully suported.
+ * Most APIs will return a promise. These APIs can be used using 
+ * `then(...)/catch(...)`
+ * 
+ * A Syslog class with a configured
+ * Syslog server target can also be used as the input into the formating 
+ * classes so that it may run independtly.
+ * 
+ * The RFC5424 Syslog logging format is ment to be used as a stream of log data 
+ * from a service or applacation. This class is designed to be used in this
+ * fashion where new messages are writen to the class as needed.
  * @requires moment
  * @version 0.0.0
  * @since 0.0.0
@@ -1661,14 +1690,21 @@ class RFC5424 {
  * 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.
+ * sent via Syslog. 
+ * Most APIs will return a promise. These APIs can be used using 
+ * `then(...)/catch(...)`
+ * 
+ * A Syslog class with a configured Syslog server target can also be used as 
+ * the input into the formating classes so that it may run independtly. The 
+ * LEEF format is designed to send event data to a SIEM system and should not 
+ * be as a logging stream. This class is ment to be used once per message.
  * @requires moment
  * @version 0.0.0
  * @since 0.0.0
  */
 class LEEF {
   /**
-   * Construct a new LEEF object with user options 
+   * Construct a new LEEF formating object with user options
    * @public
    * @param {object} [options] - Options object
    * @param {string} [options.vendor='unknown'] - The vendor of the system that
@@ -1819,13 +1855,20 @@ class LEEF {
  * be saved to file (Saving to file if not part of this module but a CEF 
  * formated mesage produced by this module can be saved externaly to it) or 
  * sent via Syslog.
+ * Most APIs will return a promise. These APIs can be used using 
+ * `then(...)/catch(...)`
+ * 
+ * A Syslog class with a configured Syslog server target can also be used as 
+ * the input into the formating classes so that it may run independtly. The CEF 
+ * format is designed to send event data to a SIEM system and should not be as 
+ * a logging stream. This class is ment to be used once per message.
  * @requires moment
  * @version 0.0.0
  * @since 0.0.0
  */
 class CEF {
   /**
-   * Construct a new CEF object with user options 
+   * Construct a new CEF formating object with user options 
    * @public
    * @param {object} [options] - Options object
    * @param {string} [options.deviceVendor='unknown'] - The vendor of the system 
diff --git a/jsdoc.json b/jsdoc.json
new file mode 100644
index 0000000..833c458
--- /dev/null
+++ b/jsdoc.json
@@ -0,0 +1,25 @@
+{
+  "sourceType": "module",
+  "tags": {
+    "allowUnknownTags": true,
+    "dictionaries": ["jsdoc","closure"]
+  },
+  "source": {
+    "includePattern": ".+\\.js(doc|x)?$",
+    "excludePattern": "(^|\\/|\\\\)_"
+  },
+  "plugins": [],
+  "templates": {
+    "cleverLinks": false,
+    "monospaceLinks": false,
+    "default": {
+      "outputSourceFiles": true
+    }
+  },
+  "opts": {
+    "destination": "./docs",
+    "private": true,
+    "readme": "./README.md",
+    "template": "./node_modules/docdash"
+  }
+}
\ No newline at end of file
diff --git a/jsdoc2md/api.hbs b/jsdoc2md/api.hbs
new file mode 100644
index 0000000..12ab71d
--- /dev/null
+++ b/jsdoc2md/api.hbs
@@ -0,0 +1,22 @@
+API
+==========================
+
+- back to [README.md](../README.md)
+
+API convention
+==
+
+{{>main}}
+
+*docs autogenerated via [jsdoc2md]
+(https://github.com/jsdoc2md/jsdoc-to-markdown)*
+
+## Test
+```shell
+  npm test
+```
+
+## Contributing
+
+Please try to maintain the existing coding style. Add unit tests for any new or 
+changed functionality. Lint and test your code.
diff --git a/package-lock.json b/package-lock.json
index 8feaad4..11dde16 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -80,6 +80,15 @@
         "json-schema-traverse": "^0.3.0"
       }
     },
+    "ansi-escape-sequences": {
+      "version": "4.0.0",
+      "resolved": "https://registry.npmjs.org/ansi-escape-sequences/-/ansi-escape-sequences-4.0.0.tgz",
+      "integrity": "sha512-v+0wW9Wezwsyb0uF4aBVCjmSqit3Ru7PZFziGF0o2KwTvN2zWfTi3BRLq9EkJFdg3eBbyERXGTntVpBxH1J68Q==",
+      "dev": true,
+      "requires": {
+        "array-back": "^2.0.0"
+      }
+    },
     "ansi-escapes": {
       "version": "3.1.0",
       "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-3.1.0.tgz",
@@ -405,6 +414,16 @@
         "sprintf-js": "~1.0.2"
       }
     },
+    "argv-tools": {
+      "version": "0.1.1",
+      "resolved": "https://registry.npmjs.org/argv-tools/-/argv-tools-0.1.1.tgz",
+      "integrity": "sha512-Cc0dBvx4dvrjjKpyDA6w8RlNAw8Su30NvZbWl/Tv9ZALEVlLVkWQiHMi84Q0xNfpVuSaiQbYkdmWK8g1PLGhKw==",
+      "dev": true,
+      "requires": {
+        "array-back": "^2.0.0",
+        "find-replace": "^2.0.1"
+      }
+    },
     "arr-diff": {
       "version": "2.0.0",
       "resolved": "https://registry.npmjs.org/arr-diff/-/arr-diff-2.0.0.tgz",
@@ -426,6 +445,15 @@
       "integrity": "sha1-45sJrqne+Gao8gbiiK9jkZuuOcQ=",
       "dev": true
     },
+    "array-back": {
+      "version": "2.0.0",
+      "resolved": "https://registry.npmjs.org/array-back/-/array-back-2.0.0.tgz",
+      "integrity": "sha512-eJv4pLLufP3g5kcZry0j6WXpIbzYw9GUB4mVJZno9wfwiBxbizTnHCw3VJb07cBihbFX48Y7oSrW9y+gt4glyw==",
+      "dev": true,
+      "requires": {
+        "typical": "^2.6.1"
+      }
+    },
     "array-equal": {
       "version": "1.0.0",
       "resolved": "https://registry.npmjs.org/array-equal/-/array-equal-1.0.0.tgz",
@@ -907,6 +935,17 @@
         }
       }
     },
+    "cache-point": {
+      "version": "0.4.1",
+      "resolved": "https://registry.npmjs.org/cache-point/-/cache-point-0.4.1.tgz",
+      "integrity": "sha512-4TgWfe9SF+bUy5cCql8gWHqKNrviufNwSYxLjf2utB0pY4+bdcuFwMmY1hDB+67Gz/L1vmhFNhePAjJTFBtV+Q==",
+      "dev": true,
+      "requires": {
+        "array-back": "^2.0.0",
+        "fs-then-native": "^2.0.0",
+        "mkdirp2": "^1.0.3"
+      }
+    },
     "callsites": {
       "version": "2.0.0",
       "resolved": "https://registry.npmjs.org/callsites/-/callsites-2.0.0.tgz",
@@ -1012,6 +1051,16 @@
       "integrity": "sha1-DQcLTQQ6W+ozovGkDi7bPZpMz3c=",
       "dev": true
     },
+    "collect-all": {
+      "version": "1.0.3",
+      "resolved": "https://registry.npmjs.org/collect-all/-/collect-all-1.0.3.tgz",
+      "integrity": "sha512-0y0rBgoX8IzIjBAUnO73SEtSb4Mhk3IoceWJq5zZSxb9mWORhWH8xLYo4EDSOE1jRBk1LhmfjqWFFt10h/+MEA==",
+      "dev": true,
+      "requires": {
+        "stream-connect": "^1.0.2",
+        "stream-via": "^1.0.4"
+      }
+    },
     "collection-visit": {
       "version": "1.0.0",
       "resolved": "https://registry.npmjs.org/collection-visit/-/collection-visit-1.0.0.tgz",
@@ -1046,12 +1095,56 @@
         "delayed-stream": "~1.0.0"
       }
     },
+    "command-line-args": {
+      "version": "5.0.2",
+      "resolved": "https://registry.npmjs.org/command-line-args/-/command-line-args-5.0.2.tgz",
+      "integrity": "sha512-/qPcbL8zpqg53x4rAaqMFlRV4opN3pbla7I7k9x8kyOBMQoGT6WltjN6sXZuxOXw6DgdK7Ad+ijYS5gjcr7vlA==",
+      "dev": true,
+      "requires": {
+        "argv-tools": "^0.1.1",
+        "array-back": "^2.0.0",
+        "find-replace": "^2.0.1",
+        "lodash.camelcase": "^4.3.0",
+        "typical": "^2.6.1"
+      }
+    },
+    "command-line-tool": {
+      "version": "0.8.0",
+      "resolved": "https://registry.npmjs.org/command-line-tool/-/command-line-tool-0.8.0.tgz",
+      "integrity": "sha512-Xw18HVx/QzQV3Sc5k1vy3kgtOeGmsKIqwtFFoyjI4bbcpSgnw2CWVULvtakyw4s6fhyAdI6soQQhXc2OzJy62g==",
+      "dev": true,
+      "requires": {
+        "ansi-escape-sequences": "^4.0.0",
+        "array-back": "^2.0.0",
+        "command-line-args": "^5.0.0",
+        "command-line-usage": "^4.1.0",
+        "typical": "^2.6.1"
+      }
+    },
+    "command-line-usage": {
+      "version": "4.1.0",
+      "resolved": "https://registry.npmjs.org/command-line-usage/-/command-line-usage-4.1.0.tgz",
+      "integrity": "sha512-MxS8Ad995KpdAC0Jopo/ovGIroV/m0KHwzKfXxKag6FHOkGsH8/lv5yjgablcRxCJJC0oJeUMuO/gmaq+Wq46g==",
+      "dev": true,
+      "requires": {
+        "ansi-escape-sequences": "^4.0.0",
+        "array-back": "^2.0.0",
+        "table-layout": "^0.4.2",
+        "typical": "^2.6.1"
+      }
+    },
     "commander": {
       "version": "2.18.0",
       "resolved": "https://registry.npmjs.org/commander/-/commander-2.18.0.tgz",
       "integrity": "sha512-6CYPa+JP2ftfRU2qkDK+UTVeQYosOg/2GbcjIcKPHfinyOLPVGXu/ovN86RP49Re5ndJK1N0kuiidFFuepc4ZQ==",
       "dev": true
     },
+    "common-sequence": {
+      "version": "1.0.2",
+      "resolved": "https://registry.npmjs.org/common-sequence/-/common-sequence-1.0.2.tgz",
+      "integrity": "sha1-MOB/P49vf5s97oVPILLTnu4Ibeg=",
+      "dev": true
+    },
     "component-emitter": {
       "version": "1.2.1",
       "resolved": "https://registry.npmjs.org/component-emitter/-/component-emitter-1.2.1.tgz",
@@ -1064,6 +1157,23 @@
       "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=",
       "dev": true
     },
+    "config-master": {
+      "version": "3.1.0",
+      "resolved": "https://registry.npmjs.org/config-master/-/config-master-3.1.0.tgz",
+      "integrity": "sha1-ZnZjWQUFooO/JqSE1oSJ10xUhdo=",
+      "dev": true,
+      "requires": {
+        "walk-back": "^2.0.1"
+      },
+      "dependencies": {
+        "walk-back": {
+          "version": "2.0.1",
+          "resolved": "https://registry.npmjs.org/walk-back/-/walk-back-2.0.1.tgz",
+          "integrity": "sha1-VU4qnYdPrEeoywBr9EwvDEmYoKQ=",
+          "dev": true
+        }
+      }
+    },
     "convert-source-map": {
       "version": "1.6.0",
       "resolved": "https://registry.npmjs.org/convert-source-map/-/convert-source-map-1.6.0.tgz",
@@ -1193,6 +1303,12 @@
       "integrity": "sha1-6zkTMzRYd1y4TNGh+uBiEGu4dUU=",
       "dev": true
     },
+    "deep-extend": {
+      "version": "0.6.0",
+      "resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.6.0.tgz",
+      "integrity": "sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==",
+      "dev": true
+    },
     "deep-is": {
       "version": "0.1.3",
       "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.3.tgz",
@@ -1297,6 +1413,34 @@
       "integrity": "sha512-A46qtFgd+g7pDZinpnwiRJtxbC1hpgf0uzP3iG89scHk0AUC7A1TGxf5OiiOUv/JMZR8GOt8hL900hV0bOy5xA==",
       "dev": true
     },
+    "dmd": {
+      "version": "3.0.12",
+      "resolved": "https://registry.npmjs.org/dmd/-/dmd-3.0.12.tgz",
+      "integrity": "sha512-79w644JdsB2TthYpVl2bDurX7i9Abaegg2E7X46Ajc135aASTMXxrHzJ9mOa5X5nbmnXwlBYiF68K+1baX+BzQ==",
+      "dev": true,
+      "requires": {
+        "array-back": "^2.0.0",
+        "cache-point": "^0.4.1",
+        "common-sequence": "^1.0.2",
+        "file-set": "^2.0.0",
+        "handlebars": "^4.0.11",
+        "marked": "^0.3.16",
+        "object-get": "^2.1.0",
+        "reduce-flatten": "^1.0.1",
+        "reduce-unique": "^1.0.0",
+        "reduce-without": "^1.0.1",
+        "test-value": "^3.0.0",
+        "walk-back": "^3.0.0"
+      },
+      "dependencies": {
+        "marked": {
+          "version": "0.3.19",
+          "resolved": "https://registry.npmjs.org/marked/-/marked-0.3.19.tgz",
+          "integrity": "sha512-ea2eGWOqNxPcXv8dyERdSr/6FmzvWwzjMxpfGB/sbMccXoct+xY+YukPD+QTUZwyvK7BZwcr4m21WBOW41pAkg==",
+          "dev": true
+        }
+      }
+    },
     "docco": {
       "version": "0.8.0",
       "resolved": "https://registry.npmjs.org/docco/-/docco-0.8.0.tgz",
@@ -1552,6 +1696,16 @@
         "bser": "^2.0.0"
       }
     },
+    "file-set": {
+      "version": "2.0.1",
+      "resolved": "https://registry.npmjs.org/file-set/-/file-set-2.0.1.tgz",
+      "integrity": "sha512-XgOUUpgR6FbbfYcniLw0qm1Am7PnNYIAkd+eXxRt42LiYhjaso0WiuQ+VmrNdtwotyM+cLCfZ56AZrySP3QnKA==",
+      "dev": true,
+      "requires": {
+        "array-back": "^2.0.0",
+        "glob": "^7.1.3"
+      }
+    },
     "filename-regex": {
       "version": "2.0.1",
       "resolved": "https://registry.npmjs.org/filename-regex/-/filename-regex-2.0.1.tgz",
@@ -1581,6 +1735,16 @@
         "repeat-string": "^1.5.2"
       }
     },
+    "find-replace": {
+      "version": "2.0.1",
+      "resolved": "https://registry.npmjs.org/find-replace/-/find-replace-2.0.1.tgz",
+      "integrity": "sha512-LzDo3Fpa30FLIBsh6DCDnMN1KW2g4QKkqKmejlImgWY67dDFPX/x9Kh/op/GK522DchQXEvDi/wD48HKW49XOQ==",
+      "dev": true,
+      "requires": {
+        "array-back": "^2.0.0",
+        "test-value": "^3.0.0"
+      }
+    },
     "find-up": {
       "version": "2.1.0",
       "resolved": "https://registry.npmjs.org/find-up/-/find-up-2.1.0.tgz",
@@ -1653,6 +1817,12 @@
         "universalify": "^0.1.0"
       }
     },
+    "fs-then-native": {
+      "version": "2.0.0",
+      "resolved": "https://registry.npmjs.org/fs-then-native/-/fs-then-native-2.0.0.tgz",
+      "integrity": "sha1-GaEk2U2QwiyOBF8ujdbr6jbUjGc=",
+      "dev": true
+    },
     "fs.realpath": {
       "version": "1.0.0",
       "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz",
@@ -1720,7 +1890,8 @@
         "code-point-at": {
           "version": "1.1.0",
           "bundled": true,
-          "dev": true
+          "dev": true,
+          "optional": true
         },
         "concat-map": {
           "version": "0.0.1",
@@ -1730,7 +1901,8 @@
         "console-control-strings": {
           "version": "1.1.0",
           "bundled": true,
-          "dev": true
+          "dev": true,
+          "optional": true
         },
         "core-util-is": {
           "version": "1.0.2",
@@ -1847,7 +2019,8 @@
         "inherits": {
           "version": "2.0.3",
           "bundled": true,
-          "dev": true
+          "dev": true,
+          "optional": true
         },
         "ini": {
           "version": "1.3.5",
@@ -1859,6 +2032,7 @@
           "version": "1.0.0",
           "bundled": true,
           "dev": true,
+          "optional": true,
           "requires": {
             "number-is-nan": "^1.0.0"
           }
@@ -1984,7 +2158,8 @@
         "number-is-nan": {
           "version": "1.0.1",
           "bundled": true,
-          "dev": true
+          "dev": true,
+          "optional": true
         },
         "object-assign": {
           "version": "4.1.1",
@@ -1996,6 +2171,7 @@
           "version": "1.4.0",
           "bundled": true,
           "dev": true,
+          "optional": true,
           "requires": {
             "wrappy": "1"
           }
@@ -2117,6 +2293,7 @@
           "version": "1.0.2",
           "bundled": true,
           "dev": true,
+          "optional": true,
           "requires": {
             "code-point-at": "^1.0.0",
             "is-fullwidth-code-point": "^1.0.0",
@@ -3337,6 +3514,52 @@
         }
       }
     },
+    "jsdoc-api": {
+      "version": "4.0.3",
+      "resolved": "https://registry.npmjs.org/jsdoc-api/-/jsdoc-api-4.0.3.tgz",
+      "integrity": "sha512-dfYq9JgB+XahY0XfSEw93PmXmocjwYcvJ5aMuQUJ/OdDRGWamf2SSOk3W06Bsj8qdjp/UdefzqpP/mpwsvHuvA==",
+      "dev": true,
+      "requires": {
+        "array-back": "^2.0.0",
+        "cache-point": "^0.4.1",
+        "collect-all": "^1.0.3",
+        "file-set": "^2.0.0",
+        "fs-then-native": "^2.0.0",
+        "jsdoc": "~3.5.5",
+        "object-to-spawn-args": "^1.1.1",
+        "temp-path": "^1.0.0",
+        "walk-back": "^3.0.0"
+      }
+    },
+    "jsdoc-parse": {
+      "version": "3.0.1",
+      "resolved": "https://registry.npmjs.org/jsdoc-parse/-/jsdoc-parse-3.0.1.tgz",
+      "integrity": "sha512-btZLp4wYl90vcAfgk4hoGQbO17iBVrhh3LJRMKZNtZgniO3F8H2CjxXld0owBIB1XxN+j3bAcWZnZKMnSj3iMA==",
+      "dev": true,
+      "requires": {
+        "array-back": "^2.0.0",
+        "lodash.omit": "^4.5.0",
+        "lodash.pick": "^4.4.0",
+        "reduce-extract": "^1.0.0",
+        "sort-array": "^2.0.0",
+        "test-value": "^3.0.0"
+      }
+    },
+    "jsdoc-to-markdown": {
+      "version": "4.0.1",
+      "resolved": "https://registry.npmjs.org/jsdoc-to-markdown/-/jsdoc-to-markdown-4.0.1.tgz",
+      "integrity": "sha512-LHJRoLoLyDdxNcColgkLoB/rFG5iRP+PNJjMILI0x+95IdEAtyjSt0wJ6ZlKxRpkhBYtQXTQQ119hMqPIUZzTQ==",
+      "dev": true,
+      "requires": {
+        "array-back": "^2.0.0",
+        "command-line-tool": "^0.8.0",
+        "config-master": "^3.1.0",
+        "dmd": "^3.0.10",
+        "jsdoc-api": "^4.0.1",
+        "jsdoc-parse": "^3.0.1",
+        "walk-back": "^3.0.0"
+      }
+    },
     "jsdom": {
       "version": "11.12.0",
       "resolved": "https://registry.npmjs.org/jsdom/-/jsdom-11.12.0.tgz",
@@ -3512,6 +3735,30 @@
       "integrity": "sha512-cQKh8igo5QUhZ7lg38DYWAxMvjSAKG0A8wGSVimP07SIUEK2UO+arSRKbRZWtelMtN5V0Hkwh5ryOto/SshYIg==",
       "dev": true
     },
+    "lodash.camelcase": {
+      "version": "4.3.0",
+      "resolved": "https://registry.npmjs.org/lodash.camelcase/-/lodash.camelcase-4.3.0.tgz",
+      "integrity": "sha1-soqmKIorn8ZRA1x3EfZathkDMaY=",
+      "dev": true
+    },
+    "lodash.omit": {
+      "version": "4.5.0",
+      "resolved": "https://registry.npmjs.org/lodash.omit/-/lodash.omit-4.5.0.tgz",
+      "integrity": "sha1-brGa5aHuHdnfC5aeZs4Lf6MLXmA=",
+      "dev": true
+    },
+    "lodash.padend": {
+      "version": "4.6.1",
+      "resolved": "https://registry.npmjs.org/lodash.padend/-/lodash.padend-4.6.1.tgz",
+      "integrity": "sha1-U8y6BH0G4VjTEfRdpiX05J5vFm4=",
+      "dev": true
+    },
+    "lodash.pick": {
+      "version": "4.4.0",
+      "resolved": "https://registry.npmjs.org/lodash.pick/-/lodash.pick-4.4.0.tgz",
+      "integrity": "sha1-UvBWEP/53tQiYRRB7R/BI6AwAbM=",
+      "dev": true
+    },
     "lodash.sortby": {
       "version": "4.7.0",
       "resolved": "https://registry.npmjs.org/lodash.sortby/-/lodash.sortby-4.7.0.tgz",
@@ -3690,6 +3937,12 @@
         "minimist": "0.0.8"
       }
     },
+    "mkdirp2": {
+      "version": "1.0.4",
+      "resolved": "https://registry.npmjs.org/mkdirp2/-/mkdirp2-1.0.4.tgz",
+      "integrity": "sha512-Q2PKB4ZR4UPtjLl76JfzlgSCUZhSV1AXQgAZa1qt5RiaALFjP/CDrGvFBrOz7Ck6McPcwMAxTsJvWOUjOU8XMw==",
+      "dev": true
+    },
     "moment": {
       "version": "2.22.2",
       "resolved": "https://registry.npmjs.org/moment/-/moment-2.22.2.tgz",
@@ -3847,12 +4100,24 @@
         }
       }
     },
+    "object-get": {
+      "version": "2.1.0",
+      "resolved": "https://registry.npmjs.org/object-get/-/object-get-2.1.0.tgz",
+      "integrity": "sha1-ciu9tgA576R8rTxtws5RqFwCxa4=",
+      "dev": true
+    },
     "object-keys": {
       "version": "1.0.12",
       "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.0.12.tgz",
       "integrity": "sha512-FTMyFUm2wBcGHnH2eXmz7tC6IwlqQZ6mVZ+6dm6vZ4IQIHjs6FdNsQBuKGPuUUUY6NfJw2PshC08Tn6LzLDOag==",
       "dev": true
     },
+    "object-to-spawn-args": {
+      "version": "1.1.1",
+      "resolved": "https://registry.npmjs.org/object-to-spawn-args/-/object-to-spawn-args-1.1.1.tgz",
+      "integrity": "sha1-d9qIJ/Bz0BHJ4bFz+JV4FHAkZ4U=",
+      "dev": true
+    },
     "object-visit": {
       "version": "1.0.1",
       "resolved": "https://registry.npmjs.org/object-visit/-/object-visit-1.0.1.tgz",
@@ -4284,6 +4549,78 @@
         "util.promisify": "^1.0.0"
       }
     },
+    "reduce-extract": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/reduce-extract/-/reduce-extract-1.0.0.tgz",
+      "integrity": "sha1-Z/I4W+2mUGG19fQxJmLosIDKFSU=",
+      "dev": true,
+      "requires": {
+        "test-value": "^1.0.1"
+      },
+      "dependencies": {
+        "array-back": {
+          "version": "1.0.4",
+          "resolved": "https://registry.npmjs.org/array-back/-/array-back-1.0.4.tgz",
+          "integrity": "sha1-ZEun8JX3/898Q7Xw3DnTwfA8Bjs=",
+          "dev": true,
+          "requires": {
+            "typical": "^2.6.0"
+          }
+        },
+        "test-value": {
+          "version": "1.1.0",
+          "resolved": "https://registry.npmjs.org/test-value/-/test-value-1.1.0.tgz",
+          "integrity": "sha1-oJE29y7AQ9J8iTcHwrFZv6196T8=",
+          "dev": true,
+          "requires": {
+            "array-back": "^1.0.2",
+            "typical": "^2.4.2"
+          }
+        }
+      }
+    },
+    "reduce-flatten": {
+      "version": "1.0.1",
+      "resolved": "https://registry.npmjs.org/reduce-flatten/-/reduce-flatten-1.0.1.tgz",
+      "integrity": "sha1-JYx479FT3fk8tWEjf2EYTzaW4yc=",
+      "dev": true
+    },
+    "reduce-unique": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/reduce-unique/-/reduce-unique-1.0.0.tgz",
+      "integrity": "sha1-flhrz4ek4ytter2Cd/rWzeyfSAM=",
+      "dev": true
+    },
+    "reduce-without": {
+      "version": "1.0.1",
+      "resolved": "https://registry.npmjs.org/reduce-without/-/reduce-without-1.0.1.tgz",
+      "integrity": "sha1-aK0OrRGFXJo31OglbBW7+Hly/Iw=",
+      "dev": true,
+      "requires": {
+        "test-value": "^2.0.0"
+      },
+      "dependencies": {
+        "array-back": {
+          "version": "1.0.4",
+          "resolved": "https://registry.npmjs.org/array-back/-/array-back-1.0.4.tgz",
+          "integrity": "sha1-ZEun8JX3/898Q7Xw3DnTwfA8Bjs=",
+          "dev": true,
+          "requires": {
+            "typical": "^2.6.0"
+          }
+        },
+        "test-value": {
+          "version": "2.1.0",
+          "resolved": "https://registry.npmjs.org/test-value/-/test-value-2.1.0.tgz",
+          "integrity": "sha1-Edpv9nDzRxpztiXKTz/c97t0gpE=",
+          "dev": true,
+          "requires": {
+            "array-back": "^1.0.3",
+            "typical": "^2.6.0"
+          }
+        }
+      }
+    },
     "regenerator-runtime": {
       "version": "0.11.1",
       "resolved": "https://registry.npmjs.org/regenerator-runtime/-/regenerator-runtime-0.11.1.tgz",
@@ -4969,6 +5306,28 @@
         "kind-of": "^3.2.0"
       }
     },
+    "sort-array": {
+      "version": "2.0.0",
+      "resolved": "https://registry.npmjs.org/sort-array/-/sort-array-2.0.0.tgz",
+      "integrity": "sha1-OKnG2if9fRR7QuYFVPKBGHtN9HI=",
+      "dev": true,
+      "requires": {
+        "array-back": "^1.0.4",
+        "object-get": "^2.1.0",
+        "typical": "^2.6.0"
+      },
+      "dependencies": {
+        "array-back": {
+          "version": "1.0.4",
+          "resolved": "https://registry.npmjs.org/array-back/-/array-back-1.0.4.tgz",
+          "integrity": "sha1-ZEun8JX3/898Q7Xw3DnTwfA8Bjs=",
+          "dev": true,
+          "requires": {
+            "typical": "^2.6.0"
+          }
+        }
+      }
+    },
     "source-map": {
       "version": "0.5.7",
       "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.5.7.tgz",
@@ -5100,6 +5459,32 @@
       "integrity": "sha1-NbCYdbT/SfJqd35QmzCQoyJr8ks=",
       "dev": true
     },
+    "stream-connect": {
+      "version": "1.0.2",
+      "resolved": "https://registry.npmjs.org/stream-connect/-/stream-connect-1.0.2.tgz",
+      "integrity": "sha1-GLyB8u2zW4tdmoAJIAqYUxRCipc=",
+      "dev": true,
+      "requires": {
+        "array-back": "^1.0.2"
+      },
+      "dependencies": {
+        "array-back": {
+          "version": "1.0.4",
+          "resolved": "https://registry.npmjs.org/array-back/-/array-back-1.0.4.tgz",
+          "integrity": "sha1-ZEun8JX3/898Q7Xw3DnTwfA8Bjs=",
+          "dev": true,
+          "requires": {
+            "typical": "^2.6.0"
+          }
+        }
+      }
+    },
+    "stream-via": {
+      "version": "1.0.4",
+      "resolved": "https://registry.npmjs.org/stream-via/-/stream-via-1.0.4.tgz",
+      "integrity": "sha512-DBp0lSvX5G9KGRDTkR/R+a29H+Wk2xItOF+MpZLLNDWbEV9tGPnqLPxHEYjmiz8xGtJHRIqmI+hCjmNzqoA4nQ==",
+      "dev": true
+    },
     "string-length": {
       "version": "2.0.0",
       "resolved": "https://registry.npmjs.org/string-length/-/string-length-2.0.0.tgz",
@@ -5182,12 +5567,31 @@
       "integrity": "sha1-rifbOPZgp64uHDt9G8KQgZuFGeY=",
       "dev": true
     },
+    "table-layout": {
+      "version": "0.4.4",
+      "resolved": "https://registry.npmjs.org/table-layout/-/table-layout-0.4.4.tgz",
+      "integrity": "sha512-uNaR3SRMJwfdp9OUr36eyEi6LLsbcTqTO/hfTsNviKsNeyMBPICJCC7QXRF3+07bAP6FRwA8rczJPBqXDc0CkQ==",
+      "dev": true,
+      "requires": {
+        "array-back": "^2.0.0",
+        "deep-extend": "~0.6.0",
+        "lodash.padend": "^4.6.1",
+        "typical": "^2.6.1",
+        "wordwrapjs": "^3.0.0"
+      }
+    },
     "taffydb": {
       "version": "2.6.2",
       "resolved": "https://registry.npmjs.org/taffydb/-/taffydb-2.6.2.tgz",
       "integrity": "sha1-fLy2S1oUG2ou/CxdLGe04VCyomg=",
       "dev": true
     },
+    "temp-path": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/temp-path/-/temp-path-1.0.0.tgz",
+      "integrity": "sha1-JLFUOXOrRCiW2a02fdnL2/r+kYs=",
+      "dev": true
+    },
     "test-exclude": {
       "version": "4.2.3",
       "resolved": "https://registry.npmjs.org/test-exclude/-/test-exclude-4.2.3.tgz",
@@ -5201,6 +5605,16 @@
         "require-main-filename": "^1.0.1"
       }
     },
+    "test-value": {
+      "version": "3.0.0",
+      "resolved": "https://registry.npmjs.org/test-value/-/test-value-3.0.0.tgz",
+      "integrity": "sha512-sVACdAWcZkSU9x7AOmJo5TqE+GyNJknHaHsMrR6ZnhjVlVN9Yx6FjHrsKZ3BjIpPCT68zYesPWkakrNupwfOTQ==",
+      "dev": true,
+      "requires": {
+        "array-back": "^2.0.0",
+        "typical": "^2.6.1"
+      }
+    },
     "throat": {
       "version": "4.1.0",
       "resolved": "https://registry.npmjs.org/throat/-/throat-4.1.0.tgz",
@@ -5319,6 +5733,12 @@
         "prelude-ls": "~1.1.2"
       }
     },
+    "typical": {
+      "version": "2.6.1",
+      "resolved": "https://registry.npmjs.org/typical/-/typical-2.6.1.tgz",
+      "integrity": "sha1-XAgOXWYcu+OCWdLnCjxyU+hziB0=",
+      "dev": true
+    },
     "uglify-js": {
       "version": "3.4.9",
       "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.4.9.tgz",
@@ -5520,6 +5940,12 @@
         "browser-process-hrtime": "^0.1.2"
       }
     },
+    "walk-back": {
+      "version": "3.0.0",
+      "resolved": "https://registry.npmjs.org/walk-back/-/walk-back-3.0.0.tgz",
+      "integrity": "sha1-I1h4ejXakQMtrV6S+AsSNw2HlcU=",
+      "dev": true
+    },
     "walker": {
       "version": "1.0.7",
       "resolved": "https://registry.npmjs.org/walker/-/walker-1.0.7.tgz",
@@ -5600,6 +6026,16 @@
       "integrity": "sha1-o9XabNXAvAAI03I0u68b7WMFkQc=",
       "dev": true
     },
+    "wordwrapjs": {
+      "version": "3.0.0",
+      "resolved": "https://registry.npmjs.org/wordwrapjs/-/wordwrapjs-3.0.0.tgz",
+      "integrity": "sha512-mO8XtqyPvykVCsrwj5MlOVWvSnCdT+C+QVbm6blradR7JExAhbkZ7hZ9A+9NUtwzSqrlUo9a67ws0EiILrvRpw==",
+      "dev": true,
+      "requires": {
+        "reduce-flatten": "^1.0.1",
+        "typical": "^2.6.1"
+      }
+    },
     "wrap-ansi": {
       "version": "2.1.0",
       "resolved": "http://registry.npmjs.org/wrap-ansi/-/wrap-ansi-2.1.0.tgz",
diff --git a/package.json b/package.json
index f3a7184..ca3f4cb 100644
--- a/package.json
+++ b/package.json
@@ -36,8 +36,8 @@
     }
   ],
   "homepage": "https://cyamato.github.io/SyslogPro/",
-  "bugs": { 
-    "url" : "https://github.com/cyamato/SyslogPro/issues"
+  "bugs": {
+    "url": "https://github.com/cyamato/SyslogPro/issues"
   },
   "license": "MIT",
   "repository": {
@@ -48,7 +48,7 @@
     "doc": "./docs",
     "example": "./example",
     "test": "./test"
-  }
+  },
   "main": "index.js",
   "engines": {
     "node": ">=10.0.0"
@@ -61,11 +61,15 @@
     "docco": "^0.8.0",
     "docdash": "^1.0.0",
     "jest": "^23.5.0",
-    "jsdoc": "^3.5.5"
+    "jsdoc": "^3.5.5",
+    "jsdoc-to-markdown": "^4.0.1"
   },
   "scripts": {
     "test": "jest --colors --expand --logHeapUsage --runInBand && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js",
-    "doc": "jsdoc *.js --destination ./docs --private --readme ./readme.md --template ./node_modules/docdash"
+    "docs": "jsdoc *.js -c ./jsdoc.json; jsdoc2md --template ./jsdoc2md/api.hbs --files *.js > ./docs/api.md; docco --output ./docs/docco --layout plain-markdown *.js && mv ./docs/docco/index.html ./docs/docco/README.md; docco --output ./docs/docco *.js",
+    "jsdoc": "jsdoc *.js -c ./jsdoc.json",
+    "readme": "jsdoc2md --template ./jsdoc2md/api.hbs --files *.js > ./docs/api.md",
+    "docco": "docco --output ./docs/docco --layout plain-markdown *.js && mv ./docs/docco/index.html ./docs/docco/README.md; docco --output ./docs/docco *.js"
   },
   "jest": {
     "collectCoverage": true,