# SysLog Module

The Syslog module is used to send and receive network system log packets.

## Syntax

```text
IPWorks.SysLog
```

## Remarks

The Syslog class implements a lightweight BSD syslog client as specified in RFC 3164 (User Datagram Protocol [UDP]), RFC 5425 (Secure Sockets Layer/Transport Layer Security [SSL/TLS]), and RFC 6587 (Transmission Control Protocol [TCP]). The class is used to send and receive BSD system network logging packets.

The first step in using the Syslog class is to set [LocalHost](#localhost-property-syslog-module) and [LocalPort](#localport-property-syslog-module) to the interface and port on which the host will be receiving syslog packets, and then call the [Activate](#activate-method-syslog-module) method. For each packet, the class will parse the headers and message and fire a [PacketIn](#packetin-event-syslog-module) event.

## Property List

*The following is the full list of the properties of the module with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [Active](#active-property-syslog-module) | This property indicates whether the module is active. |
| [LocalHost](#localhost-property-syslog-module) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| [LocalPort](#localport-property-syslog-module) | This property indicates the port in the local host where Syslog binds. |
| [RemoteHost](#remotehost-property-syslog-module) | This property sets a specific host for outgoing log packets. |
| [RemotePort](#remoteport-property-syslog-module) | This property sets a specific port for outgoing log packets. |
| [SSLAcceptServerCert](#sslacceptservercert-property-syslog-module) | Instructs the module to unconditionally accept the server certificate that matches the supplied certificate. |
| [SSLAuthenticateClients](#sslauthenticateclients-property-syslog-module) | If set to True, the server asks the client(s) for a certificate. |
| [SSLCert](#sslcert-property-syslog-module) | The certificate to be used during Secure Sockets Layer (SSL) negotiation. |
| [SSLEnabled](#sslenabled-property-syslog-module) | This property indicates whether Secure Sockets Layer/Transport Layer Security (TLS/SSL) is enabled. |
| [SSLServerCert](#sslservercert-property-syslog-module) | The server certificate for the last established connection. |
| [UseTCP](#usetcp-property-syslog-module) | This property specifies whether Transmission Control Protocol (TCP) is used. |

## Method List

*The following is the full list of the methods of the module with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [Activate](#activate-method-syslog-module) | This method enables sending and receiving of data. |
| [Config](#config-method-syslog-module) | Sets or retrieves a configuration setting. |
| [Deactivate](#deactivate-method-syslog-module) | This method disables sending and receive of data. |
| [DoEvents](#doevents-method-syslog-module) | This method processes events from the internal message queue. |
| [Reset](#reset-method-syslog-module) | This method will reset the module. |
| [ResolveRemoteHost](#resolveremotehost-method-syslog-module) | This method resolves the hostname in RemoteHost to an IP address. |
| [SendPacket](#sendpacket-method-syslog-module) | This method sends a log packet to RemoteHost . |

## Event List

*The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [Connected](#connected-event-syslog-module) | This event is fired immediately after a connection completes (or fails). |
| [ConnectionStatus](#connectionstatus-event-syslog-module) | This event is fired to indicate changes in a connection state. |
| [Disconnected](#disconnected-event-syslog-module) | This event is fired when a connection is closed. |
| [Error](#error-event-syslog-module) | Fired when information is available about errors during data delivery. |
| [PacketIn](#packetin-event-syslog-module) | This event fires whenever a system log packet is received. |
| [SSLClientAuthentication](#sslclientauthentication-event-syslog-module) | This is event fired when the client presents its credentials to the server. |
| [SSLServerAuthentication](#sslserverauthentication-event-syslog-module) | This event fires when connecting to the server. |
| [SSLStatus](#sslstatus-event-syslog-module) | This event shows the progress of the secure connection. |

## Config Settings

*The following is a list of config settings for the module with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [AcceptData](#AcceptData) | Whether the module can accept/receive data. |
| [AppName](#AppName) | Sets the App-Name field in RFC 5424. |
| [DelayHostResolution](#DelayHostResolution) | Whether the hostname is resolved when RemoteHost is set. |
| [MsgId](#MsgId) | Sets the MsgId field in RFC 5424. |
| [ProcId](#ProcId) | Sets the ProcId field in RFC 5424. |
| [ReceivedAppName](#ReceivedAppName) | Returns the value of the App-Name field in RFC 5424. |
| [ReceivedMsgId](#ReceivedMsgId) | Returns the value of the MsgId field in RFC 5424. |
| [ReceivedProcId](#ReceivedProcId) | Returns the value of the ProcId field in RFC 5424. |
| [ReceivedSDElementCount](#ReceivedSDElementCount) | Returns the number of Structured-data elements in RFC 5424. |
| [ReceivedSDElementId](#ReceivedSDElementId) | Returns the Sd-Id value of the Sd-element with the specified SDElementIndex in RFC 5424. |
| [ReceivedSDElementIndex](#ReceivedSDElementIndex) | Returns the index of the Structured-Data element in RFC 5424. |
| [ReceivedSDParamCount](#ReceivedSDParamCount) | Returns the number of the Sd-param values for the specified SDElementIndex in RFC 5424. |
| [ReceivedSDParamName](#ReceivedSDParamName) | Returns the name of the SD-Param field in RFC 5424. |
| [ReceivedSDParamValue](#ReceivedSDParamValue) | Returns the value of the SD-Param field in RFC 5424. |
| [SDElementCount](#SDElementCount) | Sets the number of Structured-data elements in RFC 5424. |
| [SDElementId](#SDElementId) | Sets the Sd-Id value of the Sd-element with the specified SDElementIndex in RFC 5424. |
| [SDElementIndex](#SDElementIndex) | Sets the index of the Structured-Data element in RFC 5424. |
| [SDParamCount](#SDParamCount) | Sets the number of the Sd-param values for the specified SDElementIndex in RFC 5424. |
| [SDParamName](#SDParamName) | Sets the name of the SD-Param field in RFC 5424. |
| [SDParamValue](#SDParamValue) | Sets the value of the SD-Param field in RFC 5424. |
| [TCPMessageDelimiter](#TCPMessageDelimiter) | The message delimiter to use (if any) when sending and receiving over TCP. |
| [UseHostname](#UseHostname) | Determines if the local host name or IP address is used in the Syslog header. |
| [UseLocalTime](#UseLocalTime) | Indicates whether to use local time or GMT time for packet timestamps. |
| [Version](#Version) | Determines which Syslog version to use. |
| [CaptureIPPacketInfo](#CaptureIPPacketInfo) | Used to capture the packet information. |
| [DelayHostResolution](#DelayHostResolution) | Whether the hostname is resolved when RemoteHost is set. |
| [DestinationAddress](#DestinationAddress) | Used to get the destination address from the packet information. |
| [DontFragment](#DontFragment) | Used to set the Don't Fragment flag of outgoing packets. |
| [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. |
| [LocalPort](#LocalPort) | The port in the local host where the module binds. |
| [MaxPacketSize](#MaxPacketSize) | The maximum length of the packets that can be received. |
| [QOSDSCPValue](#QOSDSCPValue) | Used to specify an arbitrary QOS/DSCP setting (optional). |
| [QOSTrafficType](#QOSTrafficType) | Used to specify QOS/DSCP settings (optional). |
| [ShareLocalPort](#ShareLocalPort) | If set to True, allows more than one instance of the module to be active on the same local port. |
| [UseConnection](#UseConnection) | Determines whether to use a connected socket. |
| [UseIPv6](#UseIPv6) | Whether or not to use IPv6. |
| [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| [FirewallData](#FirewallData) | Used to send extra data to the firewall. |
| [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. |
| [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# Active Property ([SysLog](#syslog-module) Module)

This property indicates whether the module is active.

## Syntax

```text
public var active: Bool {
  get {...}
}
```

## Default Value

False

## Remarks

This property indicates whether the class is currently active and can send or receive data. Use the [Activate](#activate-method-syslog-module) and [Deactivate](#deactivate-method-syslog-module) methods to control whether the class is active.

This property is read-only.

# LocalHost Property ([SysLog](#syslog-module) Module)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

## Syntax

```text
public var localHost: String {
  get {...}
  set {...}
}
```

## Default Value

""

## Remarks

This property contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classes) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

# LocalPort Property ([SysLog](#syslog-module) Module)

This property indicates the port in the local host where Syslog binds.

## Syntax

```text
public var localPort: Int32 {
  get {...}
  set {...}
}
```

## Default Value

514

## Remarks

The LocalPort property must be set before Syslog is activated. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting it to *0* enables the Transmission Control Protocol (TCP)/IP stack to choose a port at random. The chosen port will be shown by the LocalPort property after the connection is established.

LocalPort cannot be changed once the class is [Active](#active-property-syslog-module). Any attempt to set the LocalPort property when the class is [Active](#active-property-syslog-module) will generate an error.

The LocalPort property is useful when trying to connect to services that require a trusted port in the client side.

# RemoteHost Property ([SysLog](#syslog-module) Module)

This property sets a specific host for outgoing log packets.

## Syntax

```text
public var remoteHost: String {
  get {...}
  set {...}
}
```

## Default Value

"255.255.255.255"

## Remarks

When a call is made to the [SendPacket](#sendpacket-method-syslog-module) method, the class will send it to whatever value is in RemoteHost. The default value is the broadcast address, "255.255.255.255".

# RemotePort Property ([SysLog](#syslog-module) Module)

This property sets a specific port for outgoing log packets.

## Syntax

```text
public var remotePort: Int32 {
  get {...}
  set {...}
}
```

## Default Value

514

## Remarks

When a call is made to the [SendPacket](#sendpacket-method-syslog-module) method, the class will send to [RemoteHost](#remotehost-property-syslog-module) on RemotePort. The default value is 514, the standard port as defined in the BSD syslog RFC 3164.

# SSLAcceptServerCert Property ([SysLog](#syslog-module) Module)

Instructs the module to unconditionally accept the server certificate that matches the supplied certificate.

## Syntax

```text
public var sslAcceptServerCert: Certificate {
  get {...}
  set {...}
}
```

## Default Value

False

## Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

NOTE: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

# SSLAuthenticateClients Property ([SysLog](#syslog-module) Module)

If set to True, the server asks the client(s) for a certificate.

## Syntax

```text
public var sslAuthenticateClients: Bool {
  get {...}
  set {...}
}
```

## Default Value

False

## Remarks

This property is used in conjunction with the [SSLClientAuthentication](#sslclientauthentication-event-syslog-module) event. Please refer to the documentation of the [SSLClientAuthentication](#sslclientauthentication-event-syslog-module) event for details.

# SSLCert Property ([SysLog](#syslog-module) Module)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

## Syntax

```text
public var sslCert: Certificate {
  get {...}
  set {...}
}
```

## Default Value

False

## Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the  field to the encoded certificate. To select a certificate, use the store and subject fields.

# SSLEnabled Property ([SysLog](#syslog-module) Module)

This property indicates whether Secure Sockets Layer/Transport Layer Security (TLS/SSL) is enabled.

## Syntax

```text
public var sslEnabled: Bool {
  get {...}
  set {...}
}
```

## Default Value

False

## Remarks

This setting specifies whether TLS/SSL is enabled in the class. When False (default), the class operates in plaintext mode. When True, TLS/SSL is enabled.

NOTE: TLS/SSL can be used only when [UseTCP](#usetcp-property-syslog-module) is *true*.

# SSLServerCert Property ([SysLog](#syslog-module) Module)

The server certificate for the last established connection.

## Syntax

```text
public var sslServerCert: Certificate {
  get {...}
}
```

## Default Value

False

## Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

# UseTCP Property ([SysLog](#syslog-module) Module)

This property specifies whether Transmission Control Protocol (TCP) is used.

## Syntax

```text
public var useTCP: Bool {
  get {...}
  set {...}
}
```

## Default Value

False

## Remarks

This property specifies whether TCP is used. By default, this property is False and UDP is used. When set to True, TCP will be used as the underlying protocol.

When set to True, the following additional settings are also applicable:

- [SSLAuthenticateClients](#sslauthenticateclients-property-syslog-module)
- [SSLEnabled](#sslenabled-property-syslog-module)
- [SSLAcceptServerCert](#sslacceptservercert-property-syslog-module)
- [SSLCert](#sslcert-property-syslog-module)
- [SSLServerCert](#sslservercert-property-syslog-module)
- [TCPMessageDelimiter](#TCPMessageDelimiter)

# Activate Method ([SysLog](#syslog-module) Module)

This method enables sending and receiving of data.

## Syntax

```text
public func activate() throws -> Void
```

## Remarks

This method enables sending and receiving of data. When called, the class will create a communication endpoint (socket) that can be used for sending and receiving User Datagram Protocol (UDP) messages. This method must be called before using the class to send and receive data.

If the [UseConnection](#UseConnection) configuration setting is set to *true*, then a local association (connection) to the remote host is also created.

# Config Method ([SysLog](#syslog-module) Module)

Sets or retrieves a configuration setting.

## Syntax

```text
public func config(configurationString: String) throws -> String
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-syslog-module) for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the Config method.

To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a [configuration setting](#config-settings-syslog-module), you must call *Config("PROPERTY")*. The value will be returned as a string.

# Deactivate Method ([SysLog](#syslog-module) Module)

This method disables sending and receive of data.

## Syntax

```text
public func deactivate() throws -> Void
```

## Remarks

This method disables sending and receiving of data. When called, the class will destroy the existing socket and disable data communications.

# DoEvents Method ([SysLog](#syslog-module) Module)

This method processes events from the internal message queue.

## Syntax

```text
public func doEvents() throws -> Void
```

## Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

# Reset Method ([SysLog](#syslog-module) Module)

This method will reset the component.

## Syntax

```text
public func reset() throws -> Void
```

## Remarks

This method will reset the class's properties to their default values.

# ResolveRemoteHost Method ([SysLog](#syslog-module) Module)

This method resolves the hostname in RemoteHost to an IP address.

## Syntax

```text
public func resolveRemoteHost() throws -> Void
```

## Remarks

This method resolves the hostname specified by [RemoteHost](#remotehost-property-syslog-module) to an IP address. The resolved value is available in the [RemoteHost](#remotehost-property-syslog-module) property after this method returns.

In most cases, calling this method is not necessary; the class will resolve the hostname automatically when needed. If [DelayHostResolution](#DelayHostResolution) is *true*, this method may be called to manually resolve [RemoteHost](#remotehost-property-syslog-module), if desired.

# SendPacket Method ([SysLog](#syslog-module) Module)

This method sends a log packet to RemoteHost .

## Syntax

```text
public func sendPacket(facility: Int32, severity: Int32, message: String) throws -> Void
```

## Remarks

System log packets are composed of three main sections, each of which can be broken down into two smaller pieces.

The first section is the PRI, which contains the originating *Facility* and *Severity* of the *Message*. *Facility* is a value from 0 to 23, with each value being a different part of the system:

|  |  |
| --- | --- |
| 0 | Kernel messages |
| 1 | User-level messages |
| 2 | Mail system |
| 3 | System daemons |
| 4 | Security/authorization messages |
| 5 | Messages generated internally by syslogd |
| 6 | Line printer subsystem |
| 7 | Network news subsystem |
| 8 | UUCP subsystem |
| 9 | Clock daemon |
| 10 | Security/authorization messages |
| 11 | FTP daemon |
| 12 | NTP subsystem |
| 13 | Log audit |
| 14 | Log alert |
| 15 | Clock daemon |
| 16 | Local use |
| 17 | Local use |
| 18 | Local use |
| 19 | Local use |
| 20 | Local use |
| 21 | Local use |
| 22 | Local use |
| 23 | Local use |

*Severity* is a value from 0 to 7 using the following convention:

|  |  |
| --- | --- |
| 0 | Emergency - the system is unusable |
| 1 | Alert - action must be taken immediately |
| 2 | Critical - critical conditions exist |
| 3 | Error - error conditions exist |
| 4 | Warning - warning conditions exist |
| 5 | Notice - normal but significant condition |
| 6 | Informational - informative message |
| 7 | Debug - debug-level messages |

The second section contains a timestamp and hostname, both of which are automatically generated by the class. The third section is the *Message*.

# Connected Event ([SysLog](#syslog-module) Module)

This event is fired immediately after a connection completes (or fails).

## Syntax

```text
func onConnected(remoteAddress: String, remotePort: Int32, statusCode: Int32, description: String)
```

## Remarks

This event fires after a connection completes or fails.

*StatusCode* is the value returned by the system Transmission Control Protocol (TCP)/IP stack. This will be *0* if the connection was successful.

*Description* contains a human readable description of the status. This will be *OK* if the connection was successful.

*RemoteAddress* is the IP address of the remote host.

*RemotePort* is the port on the remote host.

# ConnectionStatus Event ([SysLog](#syslog-module) Module)

This event is fired to indicate changes in a connection state.

## Syntax

```text
func onConnectionStatus(connectionEvent: String, statusCode: Int32, description: String)
```

## Remarks

The ConnectionStatus event is fired when the connection state changes: for example, upon completion of a firewall or proxy connection or completion of a security handshake.

The *ConnectionEvent* parameter indicates the type of connection event. Values may include the following:

|  |  |
| --- | --- |
|  | Firewall connection complete. |
|  | Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable). |
|  | Remote host connection complete. |
|  | Remote host disconnected. |
|  | SSL or S/Shell connection broken. |
|  | Firewall host disconnected. |

 *StatusCode* has the error code returned by the Transmission Control Protocol (TCP)/IP stack. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the error.

# Disconnected Event ([SysLog](#syslog-module) Module)

This event is fired when a connection is closed.

## Syntax

```text
func onDisconnected(remoteAddress: String, remotePort: Int32, statusCode: Int32, description: String)
```

## Remarks

This event fires when a connection is closed.

*StatusCode* is the value returned by the system Transmission Control Protocol (TCP)/IP stack. This will be *0* if the connection was successful.

*Description* contains a human readable description of the status. This will be *OK* if the connection was successful.

*RemoteAddress* is the IP address of the remote host.

*RemotePort* is the port on the remote host.

# Error Event ([SysLog](#syslog-module) Module)

Fired when information is available about errors during data delivery.

## Syntax

```text
func onError(errorCode: Int32, description: String)
```

## Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-syslog-module) section.

# PacketIn Event ([SysLog](#syslog-module) Module)

This event fires whenever a system log packet is received.

## Syntax

```text
func onPacketIn(facilityCode: Int32, facility: String, severityCode: Int32, severity: String, timestamp: String, hostname: String, message: String, conforms: Bool, packet: Data, sourceAddress: String, sourcePort: Int32)
```

## Remarks

System log packets are composed of three main sections, each of which can be broken down into two smaller pieces.

The first section is the PRI, which contains the originating *FacilityCode* and *SeverityCode* of the *Message*. *FacilityCode* is a value from 0 to 23, with each value being a different part of the system. *Facility* is a string representation of *FacilityCode* based on the following convention:

|  |  |
| --- | --- |
| 0 | Kernel messages |
| 1 | User-level messages |
| 2 | Mail system |
| 3 | System daemons |
| 4 | Security/authorization messages |
| 5 | Messages generated internally by syslogd |
| 6 | Line printer subsystem |
| 7 | Network news subsystem |
| 8 | UUCP subsystem |
| 9 | Clock daemon |
| 10 | Security/authorization messages |
| 11 | FTP daemon |
| 12 | NTP subsystem |
| 13 | Log audit |
| 14 | Log alert |
| 15 | Clock daemon |
| 16 | Local use |
| 17 | Local use |
| 18 | Local use |
| 19 | Local use |
| 20 | Local use |
| 21 | Local use |
| 22 | Local use |
| 23 | Local use |

 *SeverityCode* is a value from 0 to 7. *Severity* is a string representation of *SeverityCode* using the following convention:

|  |  |
| --- | --- |
| 0 | Emergency - the system is unusable. |
| 1 | Alert - action must be taken immediately. |
| 2 | Critical - critical conditions exist. |
| 3 | Error - error conditions exist. |
| 4 | Warning - warning conditions exist. |
| 5 | Notice - normal but significant condition. |
| 6 | Informational - informative message. |
| 7 | Debug - debug-level messages. |

The second section contains the *Timestamp* and *Hostname*. Timestamp is a string that should conform to the standard structure "MMM DD, HH:MM:SS". The class will search for the *Timestamp* and verify that it conforms. If it conforms, the class will set *Hostname*, otherwise, everything after the PRI will be placed in *Message*.

If *Conforms* is True, then the original syslog packet conforms to the syslog RFC and *Timestamp*, *Hostname*, and *Message* will all have valid values. Otherwise, you should parse the contents of *Packet* to verify the fields manually.

*SourceAddress* and *SourcePort* are the address and port from which *Packet* was sent. This can be an intermediate syslog server that is simply forwarding packets from the original host.

# SSLClientAuthentication Event ([SysLog](#syslog-module) Module)

This is event fired when the client presents its credentials to the server.

## Syntax

```text
func onSSLClientAuthentication(remoteAddress: String, remotePort: Int32, certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool)
```

## Remarks

This event fires when a client connects to the class and presents a certificate for authentication. The *Accept* parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When *Accept* is False, *Status* shows why the verification failed (otherwise, *Status* contains the string "OK").

*RemoteAddress* is the IP address of the connecting client.

*RemotePort* is the source port of the connecting client.

*CertEncoded* is the base64-encoded certificate presented by the client.

*CertSubject* is the subject of the certificate presented by the client.

*CertIssuer* is the subject of the issuer of the certificate presented by the client.

*Status* is the status of the certificate.

*Accept* defines whether the certificate is accepted.

# SSLServerAuthentication Event ([SysLog](#syslog-module) Module)

This event fires when connecting to the server.

## Syntax

```text
func onSSLServerAuthentication(remoteAddress: String, remotePort: Int32, certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool)
```

## Remarks

During this event, the client can decide whether or not to continue with the connection process. The *Accept* parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When *Accept* is False, *Status* shows why the verification failed (otherwise, *Status* contains the string *OK*). If it is decided to continue, you can override and accept the certificate by setting the *Accept* parameter to True.

*RemoteAddress* is the IP address of the server.

*RemotePort* is the source port of the server.

*CertEncoded* is the base64-encoded certificate presented by the server.

*CertSubject* is the subject of the certificate presented by the server.

*CertIssuer* is the subject of the issuer of the certificate presented by the server.

*Status* is the status of the certificate.

*Accept* defines whether the certificate is accepted.

# SSLStatus Event ([SysLog](#syslog-module) Module)

This event shows the progress of the secure connection.

## Syntax

```text
func onSSLStatus(remoteAddress: String, remotePort: Int32, message: String)
```

## Remarks

The event is fired for informational and logging purposes only. It is used to track the progress of the connection.

*RemoteAddress* is the IP address of the remote machine.

*RemotePort* is the port of the remote machine.

*Message* is the log message.

# Certificate Type

This is the digital certificate being used.

## Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

The following fields are available:

- [EffectiveDate](#Certificate_f_EffectiveDate)

- [ExpirationDate](#Certificate_f_ExpirationDate)

- [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage)

- [Fingerprint](#Certificate_f_Fingerprint)

- [FingerprintSHA1](#Certificate_f_FingerprintSHA1)

- [FingerprintSHA256](#Certificate_f_FingerprintSHA256)

- [Issuer](#Certificate_f_Issuer)

- [PrivateKey](#Certificate_f_PrivateKey)

- [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable)

- [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer)

- [PublicKey](#Certificate_f_PublicKey)

- [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm)

- [PublicKeyLength](#Certificate_f_PublicKeyLength)

- [SerialNumber](#Certificate_f_SerialNumber)

- [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm)

- [Store](#Certificate_f_Store)

- [StorePassword](#Certificate_f_StorePassword)

- [StoreType](#Certificate_f_StoreType)

- [SubjectAltNames](#Certificate_f_SubjectAltNames)

- [ThumbprintMD5](#Certificate_f_ThumbprintMD5)

- [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1)

- [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256)

- [Usage](#Certificate_f_Usage)

- [UsageFlags](#Certificate_f_UsageFlags)

- [Version](#Certificate_f_Version)

- [Subject](#Certificate_f_Subject)

- [Encoded](#Certificate_f_Encoded)

## Fields

 **effectiveDate** *String (read-only)*
*Default Value: ""*

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

 **expirationDate** *String (read-only)*
*Default Value: ""*

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

 **extendedKeyUsage** *String (read-only)*
*Default Value: ""*

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

 **fingerprint** *String (read-only)*
*Default Value: ""*

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02*

 **fingerprintSHA1** *String (read-only)*
*Default Value: ""*

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84*

 **fingerprintSHA256** *String (read-only)*
*Default Value: ""*

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53*

 **issuer** *String (read-only)*
*Default Value: ""*

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

 **privateKey** *String (read-only)*
*Default Value: ""*

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The  may be available but not exportable. In this case,  returns an empty string.

 **privateKeyAvailable** *Bool (read-only)*
*Default Value: False*

Whether a  is available for the selected certificate. If  is True, the certificate may be used for authentication purposes (e.g., server authentication).

 **privateKeyContainer** *String (read-only)*
*Default Value: ""*

The name of the  container for the certificate (if available). This functionality is available only on Windows platforms.

 **publicKey** *String (read-only)*
*Default Value: ""*

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

 **publicKeyAlgorithm** *String (read-only)*
*Default Value: ""*

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

 **publicKeyLength** *Int32 (read-only)*
*Default Value: 0*

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

 **serialNumber** *String (read-only)*
*Default Value: ""*

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

 **signatureAlgorithm** *String (read-only)*
*Default Value: ""*

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

 **storeB** *Data*
*Default Value: "MY"*

The name of the certificate store for the client certificate.

The  property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in .

 is used in conjunction with the  property to specify client certificates. If  has a value, and  or  is set, a search for a certificate is initiated. Please see the  property for details.

 Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

 **store** *String*
*Default Value: "MY"*

The name of the certificate store for the client certificate.

The  property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in .

 is used in conjunction with the  property to specify client certificates. If  has a value, and  or  is set, a search for a certificate is initiated. Please see the  property for details.

 Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

 **storePassword** *String*
*Default Value: ""*

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

 **storeType** *CertStoreTypes*
*Default Value: 0*

The type of certificate store for this certificate.

 The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This property can take one of the following values:

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [](#f_StoreType), the full path of the PKCS#11 DLL as the [](#f_Store), and the PIN as the [](#f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) class by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [](#f_Store) and set [](#f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |

 **subjectAltNames** *String (read-only)*
*Default Value: ""*

Comma-separated lists of alternative subject names for the certificate.

 **thumbprintMD5** *String (read-only)*
*Default Value: ""*

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

 **thumbprintSHA1** *String (read-only)*
*Default Value: ""*

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

 **thumbprintSHA256** *String (read-only)*
*Default Value: ""*

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

 **usage** *String (read-only)*
*Default Value: ""*

The text description of .

This value will be one or more of the following strings and will be separated by commas:

- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

 **usageFlags** *Int32 (read-only)*
*Default Value: 0*

The flags that show intended use for the certificate. The value of  is a combination of the following flags:

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the  property for a text representation of .

This functionality currently is not available when the provider is OpenSSL.

 **version** *String (read-only)*
*Default Value: ""*

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

 **subject** *String*
*Default Value: ""*

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

If a field value contains a comma, it must be quoted.

 **encodedB** *Data*
*Default Value: ""*

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The  and  properties also may be used to specify a certificate.

When  is set, a search is initiated in the current  for the private key of the certificate. If the key is found,  is updated to reflect the full subject of the selected certificate; otherwise,  is set to an empty string.

 **encoded** *String*
*Default Value: ""*

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The  and  properties also may be used to specify a certificate.

When  is set, a search is initiated in the current  for the private key of the certificate. If the key is found,  is updated to reflect the full subject of the selected certificate; otherwise,  is set to an empty string.

## Constructors

*Swift Syntax*

```text
public init()
```

 Creates a instance whose properties can be set.

*Swift Syntax*

```text
public init(encoded: )
```

 Parses * Encoded * as an X.509 public key.

*Swift Syntax*

```text
public init(storeType: , store: , storePassword: , subject: )
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

*Swift Syntax*

```text
public init(storeType: , store: , storePassword: , subject: )
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

# Config Settings ([SysLog](#syslog-module) Module)

 The class accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the [Config](#config-method-syslog-module) method.

### Syslog Config Settings

**AcceptData**: Whether the component can accept/receive data.When set to False, the class will no longer be able to accept any data. The [PacketIn](#packetin-event-syslog-module) event will not fire.

The default is True.

**AppName**: Sets the App-Name field in RFC 5424.This configuration setting specifies the App-Name field of the message as defined in RFC 5424

NOTE: This setting is applicable only when [Version](#Version) is set to *1* (RFC 5424)

**DelayHostResolution**: Whether the hostname is resolved when RemoteHost is set.This configuration setting specifies whether a hostname is resolved immediately when [RemoteHost](#remotehost-property-syslog-module) is set. If *true* the class will resolve the hostname and the IP address will be present in the [RemoteHost](#remotehost-property-syslog-module) property. If *false*, the hostname is not resolved until needed by the component when a method to connect or send data is called. If desired, [ResolveRemoteHost](#resolveremotehost-method-syslog-module) may be called to manually resolve the value in [RemoteHost](#remotehost-property-syslog-module) at any time.

The default value is *false*.

**MsgId**: Sets the MsgId field in RFC 5424.This configuration setting specifies the MsgId field as defined in RFC 5424.

NOTE: This configuration setting is applicable only when [Version](#Version) is set to *1* (RFC 5424)

**ProcId**: Sets the ProcId field in RFC 5424.This configuration setting specifies the ProcId field as defined in RFC 5424.

NOTE: This configuration setting is applicable only when [Version](#Version) is set to *1* (RFC 5424)

**ReceivedAppName**: Returns the value of the App-Name field in RFC 5424.This configuration setting returns the value of the App-Name field in RFC 5424.

This configuration setting is applicable when receiving messages.

NOTE: This configuration setting is applicable only when [Version](#Version) is set to *1* (RFC 5424)

**ReceivedMsgId**: Returns the value of the MsgId field in RFC 5424.This configuration setting returns the value of the MsgId field in RFC 5424.

This configuration setting is applicable when receiving messages.

NOTE: This configuration setting is applicable only when [Version](#Version) is set to *1* (RFC 5424)

**ReceivedProcId**: Returns the value of the ProcId field in RFC 5424.This configuration setting returns the value of the ProcId field in RFC 5424.

This configuration setting is applicable when receiving messages.

NOTE: This configuration setting is applicable when [Version](#Version) is set to *1* (RFC 5424)

**ReceivedSDElementCount**: Returns the number of Structured-data elements in RFC 5424.This configuration setting returns the number of Structured-data elements in RFC 5424.

This configuration setting is applicable when receiving messages.

NOTE: This configuration setting is applicable only when [Version](#Version) is set to *1* (RFC 5424)

**ReceivedSDElementId**: Returns the Sd-Id value of the Sd-element with the specified SDElementIndex in RFC 5424.This configuration setting returns the Sd-Id value of the SD-element with the specified SDElementIndex.

This configuration setting is applicable when receiving messages.

NOTE: This configuration setting is applicable only when [Version](#Version) is set to *1* (RFC 5424)

**ReceivedSDElementIndex**: Returns the index of the Structured-Data element in RFC 5424.This configuration setting returns the index of the Structured-Data element as defined in RFC 5424.

This configuration setting is applicable when receiving messages.

NOTE: This configuration setting is applicable only when [Version](#Version) is set to *1* (RFC 5424)

**ReceivedSDParamCount**: Returns the number of the Sd-param values for the specified SDElementIndex in RFC 5424.This configuration setting returns the number of the SD-param values for the specified SDElementIndex.

This configuration setting is applicable when receiving messages.

NOTE: This configuration setting is applicable only when [Version](#Version) is set to *1* (RFC 5424)

**ReceivedSDParamName**: Returns the name of the SD-Param field in RFC 5424.This configuration setting returns the name of the SD-Param field as defined in RFC 5424. Append the index in square brackets to refer to the SD-Param field in the specified index: *SDParamName[index]*

This configuration setting is applicable when receiving messages.

NOTE: This configuration setting is applicable only when [Version](#Version) is set to *1* (RFC 5424)

**ReceivedSDParamValue**: Returns the value of the SD-Param field in RFC 5424.This configuration setting returns the value of the SD-Param field as defined in RFC 5424. Append the index in square brackets to refer to the SD-Param field in the specified index: *SDParamValue[index]*

This configuration setting is applicable when receiving messages.

NOTE: This configuration setting is applicable when [Version](#Version) is set to *1* (RFC 5424)

The following example demonstrates how to obtain the structured data information from a received message:

```csharp
  int ReceivedSDElementCount = Int32.Parse(syslog.Config("ReceivedSDElementCount"));
  for(int i=0; i < ReceivedSDElementCount; i++)
  {
    syslog.Config("ReceivedSDElementIndex="+ i.ToString());
    int ReceivedSDParamCount = Int32.Parse(syslog.Config("ReceivedSDParamCount"));
    for(int j=0; j < ReceivedSDParamCount; j++)
    {
      Console.WriteLine("Param Name: " + syslog.Config("ReceivedSDParamName[" + j.ToString() + "]"));
      Console.WriteLine("Param Value: " + syslog.Config("ReceivedSDParamValue[" + j.ToString() + "]"));
    }
  }
```

**SDElementCount**: Sets the number of Structured-data elements in RFC 5424.This configuration setting specifies the number of Structured-data elements in RFC 5424.

NOTE: This configuration setting is applicable only when [Version](#Version) is set to *1* (RFC 5424)

**SDElementId**: Sets the Sd-Id value of the Sd-element with the specified SDElementIndex in RFC 5424.This configuration setting specifies the Sd-Id value of the SD-element with the specified SDElementIndex.

NOTE: This configuration setting is applicable only when [Version](#Version) is set to *1* (RFC 5424)

**SDElementIndex**: Sets the index of the Structured-Data element in RFC 5424.This configuration setting specifies the index of the Structured-Data element as defined in RFC 5424.

NOTE: This configuration setting is applicable only when [Version](#Version) is set to *1* (RFC 5424)

**SDParamCount**: Sets the number of the Sd-param values for the specified SDElementIndex in RFC 5424.This configuration setting specifies the number of the SD-param values for the specified SDElementIndex.

NOTE: This configuration setting is applicable only when [Version](#Version) is set to *1* (RFC 5424)

**SDParamName**: Sets the name of the SD-Param field in RFC 5424.This configuration setting specifies the name of the SD-Param field as defined in RFC 5424. Append the index in square brackets to refer to the SD-Param field in the specified index: *SDParamName[index]*

NOTE: This configuration setting is applicable only when [Version](#Version) is set to *1* (RFC 5424)

**SDParamValue**: Sets the value of the SD-Param field in RFC 5424.This configuration setting specifies the value of the SD-Param field as defined in RFC 5424. Append the index in square brackets to refer to the SD-Param field in the specified index: *SDParamValue[index]*

NOTE: This configuration setting is applicable only when [Version](#Version) is set to *1* (RFC 5424)

The following example demonstrates how to set the Struct-Data configs:

```csharp
  syslog.Config("SDElementCount=2");
  syslog.Config("SDElementIndex=0");
  syslog.Config("SDElementID=examplePriority@32473");
  syslog.Config("SDParamCount=1");
  syslog.Config("SDParamName[0]=class");
  syslog.Config("SDParamValue[0]=high");
  syslog.Config("SDElementIndex=1");
  syslog.Config("SDElementID=exampleSDID@32473");
  syslog.Config("SDParamCount=2");
  syslog.Config("SDParamName[0]=iut");
  syslog.Config("SDParamValue[0]=3");
  syslog.Config("SDParamName[1]=eventSource");
  syslog.Config("SDParamValue[1]=Application");
```

**TCPMessageDelimiter**: The message delimiter to use (if any) when sending and receiving over TCP.When [UseTCP](#usetcp-property-syslog-module) is set to True, messages may be sent and received using either Octet Counting or Non-Transparent-Framing schemes to separate messages sent over the wire. This setting defines the delimiter to use in the Non-Transparent-Framing scheme when sending messages. Possible values are as follows:

|  |  |
| --- | --- |
| 0 (None - Default) | Octet Counting is used, there is no delimiter character |
| 1 (Cr) | The carriage return character is used as a message delimiter |
| 2 (Lf) | The line feed character is used as a message delimiter |
| 3 (CrLf) | The two character carriage return line feed sequence is used as a message delimiter |
| 4 (Null) | A single null byte is used as a message delimiter |

This configuration setting is applicable only when sending a message and [UseTCP](#usetcp-property-syslog-module) is set to True.

**UseHostname**: Determines if the local host name or IP address is used in the Syslog header. If set to False, the class will use the IP address of the local host name in the header of the Syslog packet. The default value is True.

**UseLocalTime**: Indicates whether to use local time or GMT time for packet timestamps.Setting this to True will generate timestamps based on the time in your locality, taking into account your time zone. When this option is False (default), GMT timestamps are generated.

**Version**: Determines which Syslog version to use.

|  |  |
| --- | --- |
| 0 (RFC 3164 - Default) | Uses RFC 3164 |
| 1 (RFC 5424) | Uses RFC 5424 |

 This configuration setting specifies which version of Syslog will be used.

NOTE: This configuration setting should be set before setting any of the [AppName](#AppName), [MsgId](#MsgId), [ProcId](#ProcId)

### UDP Config Settings

**CaptureIPPacketInfo**: Used to capture the packet information.If this is set to True, the component will capture the IP packet information.

The default value for this setting is False.

NOTE: This configuration setting is available only in Windows.

**DelayHostResolution**: Whether the hostname is resolved when RemoteHost is set.This configuration setting specifies whether a hostname is resolved immediately when [RemoteHost](#remotehost-property-syslog-module) is set. If *true* the class will resolve the hostname and the IP address will be present in the [RemoteHost](#remotehost-property-syslog-module) property. If *false*, the hostname is not resolved until needed by the component when a method to connect or send data is called. If desired, [ResolveRemoteHost](#resolveremotehost-method-syslog-module) may be called to manually resolve the value in [RemoteHost](#remotehost-property-syslog-module) at any time.

The default value is *false*.

**DestinationAddress**: Used to get the destination address from the packet information.If [CaptureIPPacketInfo](#CaptureIPPacketInfo) is set to True, then this will be populated with the packet's destination address when a packet is received. This information will be accessible in the DataIn event.

NOTE: This configuration setting is available only in Windows.

**DontFragment**: Used to set the Don't Fragment flag of outgoing packets.When set to True, packets sent by the class will have the Don't Fragment flag set. The default value is False.

**LocalHost**: The name of the local host through which connections are initiated or accepted. The [LocalHost](#localhost-property-syslog-module) setting contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classes) only through that interface.

If the class is connected, the [LocalHost](#localhost-property-syslog-module) setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

**LocalPort**: The port in the local host where the class binds. This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by [LocalPort](#localport-property-syslog-module) after the connection is established.

[LocalPort](#localport-property-syslog-module) cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

**MaxPacketSize**: The maximum length of the packets that can be received.This configuration setting specifies the maximum size of the datagrams that the class will accept without truncation.

**QOSDSCPValue**: Used to specify an arbitrary QOS/DSCP setting (optional).[UseConnection](#UseConnection) must be True to use this configuration setting. This option allows you to specify an arbitrary DSCP value between 0 and 63. The default is 0. When set to the default value, the component will not set a DSCP value.

NOTE: This configuration setting uses the qWAVE API and is available only on Windows 7, Windows Server 2008 R2, and later.

**QOSTrafficType**: Used to specify QOS/DSCP settings (optional).[UseConnection](#UseConnection) must be True to use this setting. You may specify either the text or integer values: BestEffort (0), Background (1), ExcellentEffort (2), AudioVideo (3), Voice (4), and Control (5).

NOTE: This configuration setting uses the qWAVE API and is available only on Windows Vista and Windows Server 2008 or above.

NOTE: QOSTrafficType must be set before setting [Active](#active-property-syslog-module) to True.

**ShareLocalPort**: If set to True, allows more than one instance of the class to be active on the same local port.This option must be set before the class is activated through the [Active](#active-property-syslog-module) property or it will have no effect.

The default value for this setting is False.

**UseConnection**: Determines whether to use a connected socket.[UseConnection](#UseConnection) specifies whether or not the class should use a connected socket. The connection is defined as an association in between the local address/port and the remote address/port. As such, this is not a connection in the traditional Transmission Control Protocol (TCP) sense. It means only that the class will send and receive data to and from the specified destination.

The default value for this setting is False.

**UseIPv6**: Whether or not to use IPv6.By default, the component expects an IPv4 address for local and remote host properties, and it will create an IPv4 socket. To use IPv6 instead, set this to True.

### Socket Config Settings

**AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within Timeout seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout.

NOTE: This option is not valid for User Datagram Protocol (UDP) ports.

**FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).

**InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.

**OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.

### Base Config Settings

**BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build.

**CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

|  |  |
| --- | --- |
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |

 The following is a list of valid code page identifiers for Mac OS only:

|  |  |
| --- | --- |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries.

 This setting is set to *false* by default on all platforms.

# Trappable Errors ([SysLog](#syslog-module) Module)

### SysLog Errors

|  |  |
| --- | --- |
| 451 | Unable to acquire valid system time. |

### UDP Errors

|  |  |
| --- | --- |
| 104 | UDP is already [Active](#active-property-syslog-module). |
| 106 | You cannot change the [LocalPort](#localport-property-syslog-module) while the class is [Active](#active-property-syslog-module). |
| 107 | You cannot change the [LocalHost](#localhost-property-syslog-module) at this time. A connection is in progress. |
| 109 | The class must be [Active](#active-property-syslog-module) for this operation. |
| 112 | You cannot change [MaxPacketSize](#MaxPacketSize) while the class is [Active](#active-property-syslog-module). |
| 113 | You cannot change [ShareLocalPort](#ShareLocalPort) option while the class is [Active](#active-property-syslog-module). |
| 114 | You cannot change [RemoteHost](#remotehost-property-syslog-module) when [UseConnection](#UseConnection) is set and the class [Active](#active-property-syslog-module). |
| 115 | You cannot change [RemotePort](#remoteport-property-syslog-module) when [UseConnection](#UseConnection) is set and the class is [Active](#active-property-syslog-module). |
| 116 | [RemotePort](#remoteport-property-syslog-module) cannot be zero when [UseConnection](#UseConnection) is set. Please specify a valid service port number. |
| 117 | You cannot change [UseConnection](#UseConnection) while the class is [Active](#active-property-syslog-module). |
| 118 | Message cannot be longer than [MaxPacketSize](#MaxPacketSize). |
| 119 | Message too short. |
| 434 | Unable to convert string to selected CodePage. |

### SSL Errors

|  |  |
| --- | --- |
| 270 | Cannot load specified security library. |
| 271 | Cannot open certificate store. |
| 272 | Cannot find specified certificate. |
| 273 | Cannot acquire security credentials. |
| 274 | Cannot find certificate chain. |
| 275 | Cannot verify certificate chain. |
| 276 | Error during handshake. |
| 280 | Error verifying certificate. |
| 281 | Could not find client certificate. |
| 282 | Could not find server certificate. |
| 283 | Error encrypting data. |
| 284 | Error decrypting data. |

### TCP/IP Errors

|  |  |
| --- | --- |
| 10004 | [10004] Interrupted system call. |
| 10009 | [10009] Bad file number. |
| 10013 | [10013] Access denied. |
| 10014 | [10014] Bad address. |
| 10022 | [10022] Invalid argument. |
| 10024 | [10024] Too many open files. |
| 10035 | [10035] Operation would block. |
| 10036 | [10036] Operation now in progress. |
| 10037 | [10037] Operation already in progress. |
| 10038 | [10038] Socket operation on nonsocket. |
| 10039 | [10039] Destination address required. |
| 10040 | [10040] Message is too long. |
| 10041 | [10041] Protocol wrong type for socket. |
| 10042 | [10042] Bad protocol option. |
| 10043 | [10043] Protocol is not supported. |
| 10044 | [10044] Socket type is not supported. |
| 10045 | [10045] Operation is not supported on socket. |
| 10046 | [10046] Protocol family is not supported. |
| 10047 | [10047] Address family is not supported by protocol family. |
| 10048 | [10048] Address already in use. |
| 10049 | [10049] Cannot assign requested address. |
| 10050 | [10050] Network is down. |
| 10051 | [10051] Network is unreachable. |
| 10052 | [10052] Net dropped connection or reset. |
| 10053 | [10053] Software caused connection abort. |
| 10054 | [10054] Connection reset by peer. |
| 10055 | [10055] No buffer space available. |
| 10056 | [10056] Socket is already connected. |
| 10057 | [10057] Socket is not connected. |
| 10058 | [10058] Cannot send after socket shutdown. |
| 10059 | [10059] Too many references, cannot splice. |
| 10060 | [10060] Connection timed out. |
| 10061 | [10061] Connection refused. |
| 10062 | [10062] Too many levels of symbolic links. |
| 10063 | [10063] File name is too long. |
| 10064 | [10064] Host is down. |
| 10065 | [10065] No route to host. |
| 10066 | [10066] Directory is not empty |
| 10067 | [10067] Too many processes. |
| 10068 | [10068] Too many users. |
| 10069 | [10069] Disc Quota Exceeded. |
| 10070 | [10070] Stale NFS file handle. |
| 10071 | [10071] Too many levels of remote in path. |
| 10091 | [10091] Network subsystem is unavailable. |
| 10092 | [10092] WINSOCK DLL Version out of range. |
| 10093 | [10093] Winsock is not loaded yet. |
| 11001 | [11001] Host not found. |
| 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
| 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
| 11004 | [11004] Valid name, no data record (check DNS setup). |