SysLog Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

nsoftware.IPWorks.Syslog

Remarks

The Syslog component implements a lightweight BSD syslog client as specified in RFC 3164 (UDP), RFC 5425 (SSL/TLS), and RFC 6587 (TCP). The component is used to send and receive BSD system network logging packets.

The first step in using the Syslog component is to set LocalHost and LocalPort to the interface and port on which the host will be receiving syslog packets, then set Active to True. For each packet, the component will parse the headers and message and fire a PacketIn event.

Property List

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

Method List

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

Event List

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

Config Settings

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

Active Property (SysLog Component)

Indicates whether the component is active.

Syntax

• C#
• VB.NET

public bool Active { get; set; }

Public Property Active As Boolean

Default Value

False

Remarks

This property indicates whether the component is currently active and can send or receive data.

Note: Use the Activate or Deactivate method to control whether the component is active.

This property is not available at design time.

LocalHost Property (SysLog Component)

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

Syntax

• C#
• VB.NET

public string LocalHost { get; set; }

Public Property LocalHost As String

Default Value

""

Remarks

The LocalHost 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.

If the component 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 multi-homed 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 Component)

The port in the local host where Syslog binds.

Syntax

• C#
• VB.NET

public int LocalPort { get; set; }

Public Property LocalPort As Integer

Default Value

514

Remarks

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

Setting it to 0 (default) enables the 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 component is Active. Any attempt to set the LocalPort property when the component is Active 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 Component)

Sets a specific host for outgoing log packets.

Syntax

• C#
• VB.NET

public string RemoteHost { get; set; }

Public Property RemoteHost As String

Default Value

"255.255.255.255"

Remarks

When a call is made to the SendPacket method, the component will send it to whatever value is in RemoteHost. The default value is the broadcast address, "255.255.255.255".

RemotePort Property (SysLog Component)

Sets a specific port for outgoing log packets.

Syntax

• C#
• VB.NET

public int RemotePort { get; set; }

Public Property RemotePort As Integer

Default Value

514

Remarks

When a call is made to the SendPacket method, the component will send to RemoteHost on RemotePort. The default value is 514, the standard port as defined in the BSD syslog RFC 3164.

SSLAcceptServerCert Property (SysLog Component)

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

Syntax

• C#
• VB.NET

public Certificate SSLAcceptServerCert { get; set; }

Public Property SSLAcceptServerCert As Certificate

Remarks

If it finds any issues with the certificate presented by the server, the component 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.

Please note that this functionality is provided only for cases where 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 Component)

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

Syntax

• C#
• VB.NET

public bool SSLAuthenticateClients { get; set; }

Public Property SSLAuthenticateClients As Boolean

Default Value

False

Remarks

This property is used in conjunction with the SSLClientAuthentication event. Please refer to the documentation of the SSLClientAuthentication event for details.

SSLCert Property (SysLog Component)

The certificate to be used during SSL negotiation.

Syntax

• C#
• VB.NET

public Certificate SSLCert { get; set; }

Public Property SSLCert As Certificate

Remarks

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

SSLEnabled Property (SysLog Component)

Whether TLS/SSL is enabled.

Syntax

• C#
• VB.NET

public bool SSLEnabled { get; set; }

Public Property SSLEnabled As Boolean

Default Value

False

Remarks

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

Note: TLS/SSL can only be used when UseTCP is true.

This property is not available at design time.

SSLServerCert Property (SysLog Component)

The server certificate for the last established connection.

Syntax

• C#
• VB.NET

public Certificate SSLServerCert { get; }

Public ReadOnly Property SSLServerCert As Certificate

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

UseTCP Property (SysLog Component)

Whether to use TCP.

Syntax

• C#
• VB.NET

public bool UseTCP { get; set; }

Public Property UseTCP As Boolean

Default Value

False

Remarks

This property specifies whether TCP is used. By default this proprety 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
• SSLEnabled
• SSLAcceptServerCert
• SSLCert
• SSLServerCert
• TCPMessageDelimiter

Activate Method (SysLog Component)

Enables sending and receiving of data.

Syntax

• C#
• VB.NET

public void Activate();

Async Version
public async Task Activate();
public async Task Activate(CancellationToken cancellationToken);

Public Sub Activate()

Async Version
Public Sub Activate() As Task
Public Sub Activate(cancellationToken As CancellationToken) As Task

Remarks

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

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

Config Method (SysLog Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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, you must call Config("PROPERTY"). The value will be returned as a string.

Deactivate Method (SysLog Component)

Disables sending and receive of data.

Syntax

• C#
• VB.NET

public void Deactivate();

Async Version
public async Task Deactivate();
public async Task Deactivate(CancellationToken cancellationToken);

Public Sub Deactivate()

Async Version
Public Sub Deactivate() As Task
Public Sub Deactivate(cancellationToken As CancellationToken) As Task

Remarks

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

DoEvents Method (SysLog Component)

Processes events from the internal message queue.

Syntax

• C#
• VB.NET

public void DoEvents();

Async Version
public async Task DoEvents();
public async Task DoEvents(CancellationToken cancellationToken);

Public Sub DoEvents()

Async Version
Public Sub DoEvents() As Task
Public Sub DoEvents(cancellationToken As CancellationToken) As Task

Remarks

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

Reset Method (SysLog Component)

Reset the component.

Syntax

• C#
• VB.NET

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);

Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

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

ResolveRemoteHost Method (SysLog Component)

Resolves the hostname in RemoteHost to an IP address.

Syntax

• C#
• VB.NET

public void ResolveRemoteHost();

Async Version
public async Task ResolveRemoteHost();
public async Task ResolveRemoteHost(CancellationToken cancellationToken);

Public Sub ResolveRemoteHost()

Async Version
Public Sub ResolveRemoteHost() As Task
Public Sub ResolveRemoteHost(cancellationToken As CancellationToken) As Task

Remarks

This method resolves the hostname specified by RemoteHost to an IP address. The resolved value is available in the RemoteHost property after this method returns.

In most cases calling this method is not necessary, the component will resolve the hostname automatically when necessary. If DelayHostResolution is true this method may be called to manually resolve RemoteHost if desired.

SendPacket Method (SysLog Component)

Send a log packet to RemoteHost .

Syntax

• C#
• VB.NET

public void SendPacket(int facility, int severity, string message);

Async Version
public async Task SendPacket(int facility, int severity, string message);
public async Task SendPacket(int facility, int severity, string message, CancellationToken cancellationToken);

Public Sub SendPacket(ByVal Facility As Integer, ByVal Severity As Integer, ByVal Message As String)

Async Version
Public Sub SendPacket(ByVal Facility As Integer, ByVal Severity As Integer, ByVal Message As String) As Task
Public Sub SendPacket(ByVal Facility As Integer, ByVal Severity As Integer, ByVal Message As String, cancellationToken As CancellationToken) As Task

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:

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

The section sections contains a timestamp and hostname, both of which are automatically generated by the component. The third section is the Message itself.

Connected Event (SysLog Component)

Fired immediately after a connection completes (or fails).

Syntax

• C#
• VB.NET

public event OnConnectedHandler OnConnected;

public delegate void OnConnectedHandler(object sender, SyslogConnectedEventArgs e);

public class SyslogConnectedEventArgs : EventArgs {
  public string RemoteAddress { get; }
  public int RemotePort { get; }
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnConnected As OnConnectedHandler

Public Delegate Sub OnConnectedHandler(sender As Object, e As SyslogConnectedEventArgs)

Public Class SyslogConnectedEventArgs Inherits EventArgs
  Public ReadOnly Property RemoteAddress As String
  Public ReadOnly Property RemotePort As Integer
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

This event fires after a connection completes or fails.

StatusCode is the value returned by the system 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 Component)

Fired to indicate changes in a connection state.

Syntax

• C#
• VB.NET

public event OnConnectionStatusHandler OnConnectionStatus;

public delegate void OnConnectionStatusHandler(object sender, SyslogConnectionStatusEventArgs e);

public class SyslogConnectionStatusEventArgs : EventArgs {
  public string ConnectionEvent { get; }
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnConnectionStatus As OnConnectionStatusHandler

Public Delegate Sub OnConnectionStatusHandler(sender As Object, e As SyslogConnectionStatusEventArgs)

Public Class SyslogConnectionStatusEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionEvent As String
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The ConnectionStatus event is fired when the connection state changes: for example, 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:

Disconnected Event (SysLog Component)

Fired when a connection is closed.

Syntax

• C#
• VB.NET

public event OnDisconnectedHandler OnDisconnected;

public delegate void OnDisconnectedHandler(object sender, SyslogDisconnectedEventArgs e);

public class SyslogDisconnectedEventArgs : EventArgs {
  public string RemoteAddress { get; }
  public int RemotePort { get; }
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnDisconnected As OnDisconnectedHandler

Public Delegate Sub OnDisconnectedHandler(sender As Object, e As SyslogDisconnectedEventArgs)

Public Class SyslogDisconnectedEventArgs Inherits EventArgs
  Public ReadOnly Property RemoteAddress As String
  Public ReadOnly Property RemotePort As Integer
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

This event fires when a connection is closed.

StatusCode is the value returned by the system 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 Component)

Information about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, SyslogErrorEventArgs e);

public class SyslogErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As SyslogErrorEventArgs)

Public Class SyslogErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

PacketIn Event (SysLog Component)

Fires whenever a system log packet is received.

Syntax

• C#
• VB.NET

public event OnPacketInHandler OnPacketIn;

public delegate void OnPacketInHandler(object sender, SyslogPacketInEventArgs e);

public class SyslogPacketInEventArgs : EventArgs {
  public int FacilityCode { get; }
  public string Facility { get; }
  public int SeverityCode { get; }
  public string Severity { get; }
  public string Timestamp { get; }
  public string Hostname { get; }
  public string Message { get; }
  public bool Conforms { get; }
  public string Packet { get; }
  public byte[] PacketB { get; }
  public string SourceAddress { get; }
  public int SourcePort { get; }
}

Public Event OnPacketIn As OnPacketInHandler

Public Delegate Sub OnPacketInHandler(sender As Object, e As SyslogPacketInEventArgs)

Public Class SyslogPacketInEventArgs Inherits EventArgs
  Public ReadOnly Property FacilityCode As Integer
  Public ReadOnly Property Facility As String
  Public ReadOnly Property SeverityCode As Integer
  Public ReadOnly Property Severity As String
  Public ReadOnly Property Timestamp As String
  Public ReadOnly Property Hostname As String
  Public ReadOnly Property Message As String
  Public ReadOnly Property Conforms As Boolean
  Public ReadOnly Property Packet As String
  Public ReadOnly Property PacketB As Byte()
  Public ReadOnly Property SourceAddress As String
  Public ReadOnly Property SourcePort As Integer
End Class

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:

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 component will search for the Timestamp and verify that it conforms. If it conforms, the component 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 Component)

Fired when the client presents its credentials to the server.

Syntax

• C#
• VB.NET

public event OnSSLClientAuthenticationHandler OnSSLClientAuthentication;

public delegate void OnSSLClientAuthenticationHandler(object sender, SyslogSSLClientAuthenticationEventArgs e);

public class SyslogSSLClientAuthenticationEventArgs : EventArgs {
  public string RemoteAddress { get; }
  public int RemotePort { get; }
  public string CertEncoded { get; }
  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}

Public Event OnSSLClientAuthentication As OnSSLClientAuthenticationHandler

Public Delegate Sub OnSSLClientAuthenticationHandler(sender As Object, e As SyslogSSLClientAuthenticationEventArgs)

Public Class SyslogSSLClientAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property RemoteAddress As String
  Public ReadOnly Property RemotePort As Integer
  Public ReadOnly Property CertEncoded As String
  Public ReadOnly Property CertEncodedB As Byte()
  Public ReadOnly Property CertSubject As String
  Public ReadOnly Property CertIssuer As String
  Public ReadOnly Property Status As String
  Public Property Accept As Boolean
End Class

Remarks

This event fires when a client connects to the component 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 to continue or not.

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 stauts of the certificate.

Accept defines whether the certificate is accepted.

SSLServerAuthentication Event (SysLog Component)

Fires when connecting to the server.

Syntax

• C#
• VB.NET

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, SyslogSSLServerAuthenticationEventArgs e);

public class SyslogSSLServerAuthenticationEventArgs : EventArgs {
  public string RemoteAddress { get; }
  public int RemotePort { get; }
  public string CertEncoded { get; }
  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}

Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler

Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As SyslogSSLServerAuthenticationEventArgs)

Public Class SyslogSSLServerAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property RemoteAddress As String
  Public ReadOnly Property RemotePort As Integer
  Public ReadOnly Property CertEncoded As String
  Public ReadOnly Property CertEncodedB As Byte()
  Public ReadOnly Property CertSubject As String
  Public ReadOnly Property CertIssuer As String
  Public ReadOnly Property Status As String
  Public Property Accept As Boolean
End Class

Remarks

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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 stauts of the certificate.

Accept defines whether the certificate is accepted.

SSLStatus Event (SysLog Component)

Shows the progress of the secure connection.

Syntax

• C#
• VB.NET

public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, SyslogSSLStatusEventArgs e);

public class SyslogSSLStatusEventArgs : EventArgs {
  public string RemoteAddress { get; }
  public int RemotePort { get; }
  public string Message { get; }
}

Public Event OnSSLStatus As OnSSLStatusHandler

Public Delegate Sub OnSSLStatusHandler(sender As Object, e As SyslogSSLStatusEventArgs)

Public Class SyslogSSLStatusEventArgs Inherits EventArgs
  Public ReadOnly Property RemoteAddress As String
  Public ReadOnly Property RemotePort As Integer
  Public ReadOnly Property Message As String
End Class

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.

Fields

Constructors

• C#
• VB.NET

public Certificate();

Public Certificate()

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

• C#
• VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

Opens CertificateFile and reads out the contents as an X509 public key.

• C#
• VB.NET

public Certificate(byte[] certificateData);

Public Certificate(ByVal CertificateData As Byte())

Parses CertificateData as an X509 public key.

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType 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 X509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CyrptoAPI option. The default value is True (the key is persisted). "Thumbprint" - a MD5, SHA1, or SHA256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. 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 X509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, byte[] encoded);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType 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 load Encoded as an X509 certificate and search the opened store for a corresponding private key.

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) 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 X509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject, string configurationString);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) 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 X509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, byte[] encoded);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

Config Settings (SysLog Component)

Syslog Config Settings

UDP Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (SysLog Component)

SysLog Errors

UDP Errors

SSL Errors

TCP/IP Errors