SysLog Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

class ipworks.SysLog

Remarks

The Syslog class implements a lightweight BSD syslog client as specified in RFC 3164 (UDP), RFC 5425 (SSL/TLS), and RFC 6587 (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 local_host and local_port to the interface and port on which the host will be receiving syslog packets, then set active to True. For each packet, the class will parse the headers and message and fire a on_packet_in event.

Property List

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

Method List

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

Event List

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

Config Settings

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

active Property

Indicates whether the class is active.

Syntax

def get_active() -> bool: ...
def set_active(value: bool) -> None: ...

active = property(get_active, set_active)

Default Value

FALSE

Remarks

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

Note: Use the activate or deactivate method to control whether the class is active.

local_host Property

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

Syntax

def get_local_host() -> str: ...
def set_local_host(value: str) -> None: ...

local_host = property(get_local_host, set_local_host)

Default Value

""

Remarks

The local_host 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 class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the local_host 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: local_host is not persistent. You must always set it in code, and never in the property window.

local_port Property

The port in the local host where Syslog binds.

Syntax

def get_local_port() -> int: ...
def set_local_port(value: int) -> None: ...

local_port = property(get_local_port, set_local_port)

Default Value

514

Remarks

The local_port property must be set before Syslog is activated (active is set to True). It instructs the class 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 local_port property after the connection is established.

local_port cannot be changed once the class is active. Any attempt to set the local_port property when the class is active will generate an error.

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

remote_host Property

Sets a specific host for outgoing log packets.

Syntax

def get_remote_host() -> str: ...
def set_remote_host(value: str) -> None: ...

remote_host = property(get_remote_host, set_remote_host)

Default Value

"255.255.255.255"

Remarks

When a call is made to the send_packet method, the class will send it to whatever value is in remote_host. The default value is the broadcast address, "255.255.255.255".

remote_port Property

Sets a specific port for outgoing log packets.

Syntax

def get_remote_port() -> int: ...
def set_remote_port(value: int) -> None: ...

remote_port = property(get_remote_port, set_remote_port)

Default Value

514

Remarks

When a call is made to the send_packet method, the class will send to remote_host on remote_port. The default value is 514, the standard port as defined in the BSD syslog RFC 3164.

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

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

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

ssl_authenticate_clients Property

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

Syntax

def get_ssl_authenticate_clients() -> bool: ...
def set_ssl_authenticate_clients(value: bool) -> None: ...

ssl_authenticate_clients = property(get_ssl_authenticate_clients, set_ssl_authenticate_clients)

Default Value

FALSE

Remarks

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

ssl_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_store Property

This is the name of the certificate store for the client certificate.

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

ssl_cert_store_password Property

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

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

Default Value

""

Remarks

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

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

This is 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:

 
 Copy
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);

ssl_cert_subject Property

This is the subject of the certificate used for client authentication.

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

This is 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=support@nsoftware.com". Common fields and their meanings are as follows:

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

ssl_enabled Property

Whether TLS/SSL is enabled.

Syntax

def get_ssl_enabled() -> bool: ...
def set_ssl_enabled(value: bool) -> None: ...

ssl_enabled = property(get_ssl_enabled, set_ssl_enabled)

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 only be used when use_tcp is True.

ssl_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

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

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

This property is read-only.

use_tcp Property

Whether to use TCP.

Syntax

def get_use_tcp() -> bool: ...
def set_use_tcp(value: bool) -> None: ...

use_tcp = property(get_use_tcp, set_use_tcp)

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:

• ssl_authenticate_clients
• ssl_enabled
• SSLAcceptServerCert*
• SSLCert*
• SSLServerCert*
• TCPMessageDelimiter

activate Method

Enables sending and receiving of data.

Syntax

def activate() -> None: ...

Remarks

This method enables sending and receiving of data. When called the class will create a communication endpoint (socket) which can be used for sending and receiving UDP messages. This method must be called before using the class 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

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings 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, you must call Config("PROPERTY"). The value will be returned as a string.

deactivate Method

Disables sending and receive of data.

Syntax

def deactivate() -> None: ...

Remarks

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

do_events Method

Processes events from the internal message queue.

Syntax

def do_events() -> None: ...

Remarks

When do_events 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

Reset the class.

Syntax

def reset() -> None: ...

Remarks

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

resolve_remote_host Method

Resolves the hostname in RemoteHost to an IP address.

Syntax

def resolve_remote_host() -> None: ...

Remarks

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

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

send_packet Method

Send a log packet to RemoteHost .

Syntax

def send_packet(facility: int, severity: int, message: str) -> None: ...

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 class. The third section is the Message itself.

on_connected Event

Fired immediately after a connection completes (or fails).

Syntax

class SysLogConnectedEventParams(object):
  @property
  def remote_address() -> str: ...

  @property
  def remote_port() -> int: ...

  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class SysLog:
@property
def on_connected() -> Callable[[SysLogConnectedEventParams], None]: ...
@on_connected.setter
def on_connected(event_hook: Callable[[SysLogConnectedEventParams], None]) -> None: ...

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.

on_connection_status Event

Fired to indicate changes in a connection state.

Syntax

class SysLogConnectionStatusEventParams(object):
  @property
  def connection_event() -> str: ...

  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class SysLog:
@property
def on_connection_status() -> Callable[[SysLogConnectionStatusEventParams], None]: ...
@on_connection_status.setter
def on_connection_status(event_hook: Callable[[SysLogConnectionStatusEventParams], None]) -> None: ...

Remarks

The on_connection_status 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:

on_disconnected Event

Fired when a connection is closed.

Syntax

class SysLogDisconnectedEventParams(object):
  @property
  def remote_address() -> str: ...

  @property
  def remote_port() -> int: ...

  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class SysLog:
@property
def on_disconnected() -> Callable[[SysLogDisconnectedEventParams], None]: ...
@on_disconnected.setter
def on_disconnected(event_hook: Callable[[SysLogDisconnectedEventParams], None]) -> None: ...

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.

on_error Event

Fired when information is available about errors during data delivery.

Syntax

class SysLogErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class SysLog:
@property
def on_error() -> Callable[[SysLogErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[SysLogErrorEventParams], None]) -> None: ...

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

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 section.

on_packet_in Event

Fires whenever a system log packet is received.

Syntax

class SysLogPacketInEventParams(object):
  @property
  def facility_code() -> int: ...

  @property
  def facility() -> str: ...

  @property
  def severity_code() -> int: ...

  @property
  def severity() -> str: ...

  @property
  def timestamp() -> str: ...

  @property
  def hostname() -> str: ...

  @property
  def message() -> str: ...

  @property
  def conforms() -> bool: ...

  @property
  def packet() -> bytes: ...

  @property
  def source_address() -> str: ...

  @property
  def source_port() -> int: ...

# In class SysLog:
@property
def on_packet_in() -> Callable[[SysLogPacketInEventParams], None]: ...
@on_packet_in.setter
def on_packet_in(event_hook: Callable[[SysLogPacketInEventParams], None]) -> None: ...

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 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.

on_ssl_client_authentication Event

Fired when the client presents its credentials to the server.

Syntax

class SysLogSSLClientAuthenticationEventParams(object):
  @property
  def remote_address() -> str: ...

  @property
  def remote_port() -> int: ...

  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class SysLog:
@property
def on_ssl_client_authentication() -> Callable[[SysLogSSLClientAuthenticationEventParams], None]: ...
@on_ssl_client_authentication.setter
def on_ssl_client_authentication(event_hook: Callable[[SysLogSSLClientAuthenticationEventParams], None]) -> None: ...

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 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.

on_ssl_server_authentication Event

Fires when connecting to the server.

Syntax

class SysLogSSLServerAuthenticationEventParams(object):
  @property
  def remote_address() -> str: ...

  @property
  def remote_port() -> int: ...

  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class SysLog:
@property
def on_ssl_server_authentication() -> Callable[[SysLogSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[SysLogSSLServerAuthenticationEventParams], None]) -> None: ...

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.

on_ssl_status Event

Shows the progress of the secure connection.

Syntax

class SysLogSSLStatusEventParams(object):
  @property
  def remote_address() -> str: ...

  @property
  def remote_port() -> int: ...

  @property
  def message() -> str: ...

# In class SysLog:
@property
def on_ssl_status() -> Callable[[SysLogSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[SysLogSSLStatusEventParams], None]) -> None: ...

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.

SysLog Config Settings

Syslog Config Settings

 
 Copy
  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() + "]"));
    }
  }

 
 Copy
  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");

UDP Config Settings

Socket Config Settings

Base Config Settings

SysLog Errors

SysLog Errors

UDP Errors

SSL Errors

TCP/IP Errors