SysLog Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

IPWorks_SysLog

Procedural Interface

 ipworks_syslog_open();
 ipworks_syslog_close($res);
 ipworks_syslog_register_callback($res, $id, $function);
 ipworks_syslog_get_last_error($res);
 ipworks_syslog_get_last_error_code($res);
 ipworks_syslog_set($res, $id, $index, $value);
 ipworks_syslog_get($res, $id, $index);
 ipworks_syslog_do_activate($res);
 ipworks_syslog_do_config($res, $configurationstring);
 ipworks_syslog_do_deactivate($res);
 ipworks_syslog_do_doevents($res);
 ipworks_syslog_do_reset($res);
 ipworks_syslog_do_resolveremotehost($res);
 ipworks_syslog_do_sendpacket($res, $facility, $severity, $message);

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 and LocalPort to the interface and port on which the host will be receiving syslog packets, and then set Active to True. For each packet, the class will parse the headers and message and fire a PacketIn 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.

ActiveThis property indicates whether the class is active.
LocalHostThis property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPortThis property indicates the port in the local host where Syslog binds.
RemoteHostThis property sets a specific host for outgoing log packets.
RemotePortThis property sets a specific port for outgoing log packets.
SSLAcceptServerCertEffectiveDateThis is the date on which this certificate becomes valid.
SSLAcceptServerCertExpirationDateThis is the date the certificate expires.
SSLAcceptServerCertExtendedKeyUsageThis is a comma-delimited list of extended key usage identifiers.
SSLAcceptServerCertFingerprintThis is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
SSLAcceptServerCertFingerprintSHA1This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
SSLAcceptServerCertFingerprintSHA256This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
SSLAcceptServerCertIssuerThis is the issuer of the certificate.
SSLAcceptServerCertPrivateKeyThis is the private key of the certificate (if available).
SSLAcceptServerCertPrivateKeyAvailableThis property shows whether a PrivateKey is available for the selected certificate.
SSLAcceptServerCertPrivateKeyContainerThis is the name of the PrivateKey container for the certificate (if available).
SSLAcceptServerCertPublicKeyThis is the public key of the certificate.
SSLAcceptServerCertPublicKeyAlgorithmThis property contains the textual description of the certificate's public key algorithm.
SSLAcceptServerCertPublicKeyLengthThis is the length of the certificate's public key (in bits).
SSLAcceptServerCertSerialNumberThis is the serial number of the certificate encoded as a string.
SSLAcceptServerCertSignatureAlgorithmThe property contains the text description of the certificate's signature algorithm.
SSLAcceptServerCertStoreThis is the name of the certificate store for the client certificate.
SSLAcceptServerCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLAcceptServerCertStoreTypeThis is the type of certificate store for this certificate.
SSLAcceptServerCertSubjectAltNamesThis property contains comma-separated lists of alternative subject names for the certificate.
SSLAcceptServerCertThumbprintMD5This property contains the MD5 hash of the certificate.
SSLAcceptServerCertThumbprintSHA1This property contains the SHA-1 hash of the certificate.
SSLAcceptServerCertThumbprintSHA256This property contains the SHA-256 hash of the certificate.
SSLAcceptServerCertUsageThis property contains the text description of UsageFlags .
SSLAcceptServerCertUsageFlagsThis property contains the flags that show intended use for the certificate.
SSLAcceptServerCertVersionThis property contains the certificate's version number.
SSLAcceptServerCertSubjectThis is the subject of the certificate used for client authentication.
SSLAcceptServerCertEncodedThis is the certificate (PEM/Base64 encoded).
SSLAuthenticateClientsIf set to True, the server asks the client(s) for a certificate.
SSLCertEffectiveDateThis is the date on which this certificate becomes valid.
SSLCertExpirationDateThis is the date the certificate expires.
SSLCertExtendedKeyUsageThis is a comma-delimited list of extended key usage identifiers.
SSLCertFingerprintThis is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
SSLCertFingerprintSHA1This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
SSLCertFingerprintSHA256This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
SSLCertIssuerThis is the issuer of the certificate.
SSLCertPrivateKeyThis is the private key of the certificate (if available).
SSLCertPrivateKeyAvailableThis property shows whether a PrivateKey is available for the selected certificate.
SSLCertPrivateKeyContainerThis is the name of the PrivateKey container for the certificate (if available).
SSLCertPublicKeyThis is the public key of the certificate.
SSLCertPublicKeyAlgorithmThis property contains the textual description of the certificate's public key algorithm.
SSLCertPublicKeyLengthThis is the length of the certificate's public key (in bits).
SSLCertSerialNumberThis is the serial number of the certificate encoded as a string.
SSLCertSignatureAlgorithmThe property contains the text description of the certificate's signature algorithm.
SSLCertStoreThis is the name of the certificate store for the client certificate.
SSLCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreTypeThis is the type of certificate store for this certificate.
SSLCertSubjectAltNamesThis property contains comma-separated lists of alternative subject names for the certificate.
SSLCertThumbprintMD5This property contains the MD5 hash of the certificate.
SSLCertThumbprintSHA1This property contains the SHA-1 hash of the certificate.
SSLCertThumbprintSHA256This property contains the SHA-256 hash of the certificate.
SSLCertUsageThis property contains the text description of UsageFlags .
SSLCertUsageFlagsThis property contains the flags that show intended use for the certificate.
SSLCertVersionThis property contains the certificate's version number.
SSLCertSubjectThis is the subject of the certificate used for client authentication.
SSLCertEncodedThis is the certificate (PEM/Base64 encoded).
SSLEnabledThis property indicates whether Secure Sockets Layer/Transport Layer Security (TLS/SSL) is enabled.
SSLServerCertEffectiveDateThis is the date on which this certificate becomes valid.
SSLServerCertExpirationDateThis is the date the certificate expires.
SSLServerCertExtendedKeyUsageThis is a comma-delimited list of extended key usage identifiers.
SSLServerCertFingerprintThis is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
SSLServerCertFingerprintSHA1This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
SSLServerCertFingerprintSHA256This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
SSLServerCertIssuerThis is the issuer of the certificate.
SSLServerCertPrivateKeyThis is the private key of the certificate (if available).
SSLServerCertPrivateKeyAvailableThis property shows whether a PrivateKey is available for the selected certificate.
SSLServerCertPrivateKeyContainerThis is the name of the PrivateKey container for the certificate (if available).
SSLServerCertPublicKeyThis is the public key of the certificate.
SSLServerCertPublicKeyAlgorithmThis property contains the textual description of the certificate's public key algorithm.
SSLServerCertPublicKeyLengthThis is the length of the certificate's public key (in bits).
SSLServerCertSerialNumberThis is the serial number of the certificate encoded as a string.
SSLServerCertSignatureAlgorithmThe property contains the text description of the certificate's signature algorithm.
SSLServerCertStoreThis is the name of the certificate store for the client certificate.
SSLServerCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLServerCertStoreTypeThis is the type of certificate store for this certificate.
SSLServerCertSubjectAltNamesThis property contains comma-separated lists of alternative subject names for the certificate.
SSLServerCertThumbprintMD5This property contains the MD5 hash of the certificate.
SSLServerCertThumbprintSHA1This property contains the SHA-1 hash of the certificate.
SSLServerCertThumbprintSHA256This property contains the SHA-256 hash of the certificate.
SSLServerCertUsageThis property contains the text description of UsageFlags .
SSLServerCertUsageFlagsThis property contains the flags that show intended use for the certificate.
SSLServerCertVersionThis property contains the certificate's version number.
SSLServerCertSubjectThis is the subject of the certificate used for client authentication.
SSLServerCertEncodedThis is the certificate (PEM/Base64 encoded).
UseTCPThis property specifies whether Transmission Control Protocol (TCP) is used.

Method List


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

ActivateThis method enables sending and receiving of data.
ConfigSets or retrieves a configuration setting.
DeactivateThis method disables sending and receive of data.
DoEventsThis method processes events from the internal message queue.
ResetThis method will reset the class.
ResolveRemoteHostThis method resolves the hostname in RemoteHost to an IP address.
SendPacketThis method sends a log packet to RemoteHost .

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.

ConnectedThis event is fired immediately after a connection completes (or fails).
ConnectionStatusThis event is fired to indicate changes in a connection state.
DisconnectedThis event is fired when a connection is closed.
ErrorFired when information is available about errors during data delivery.
PacketInThis event fires whenever a system log packet is received.
SSLClientAuthenticationThis is event fired when the client presents its credentials to the server.
SSLServerAuthenticationThis event fires when connecting to the server.
SSLStatusThis event shows the progress of the secure connection.

Config Settings


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

AcceptDataWhether the class can accept/receive data.
AppNameSets the App-Name field in RFC 5424.
DelayHostResolutionWhether the hostname is resolved when RemoteHost is set.
MsgIdSets the MsgId field in RFC 5424.
ProcIdSets the ProcId field in RFC 5424.
ReceivedAppNameReturns the value of the App-Name field in RFC 5424.
ReceivedMsgIdReturns the value of the MsgId field in RFC 5424.
ReceivedProcIdReturns the value of the ProcId field in RFC 5424.
ReceivedSDElementCountReturns the number of Structured-data elements in RFC 5424.
ReceivedSDElementIdReturns the Sd-Id value of the Sd-element with the specified SDElementIndex in RFC 5424.
ReceivedSDElementIndexReturns the index of the Structured-Data element in RFC 5424.
ReceivedSDParamCountReturns the number of the Sd-param values for the specified SDElementIndex in RFC 5424.
ReceivedSDParamNameReturns the name of the SD-Param field in RFC 5424.
ReceivedSDParamValueReturns the value of the SD-Param field in RFC 5424.
SDElementCountSets the number of Structured-data elements in RFC 5424.
SDElementIdSets the Sd-Id value of the Sd-element with the specified SDElementIndex in RFC 5424.
SDElementIndexSets the index of the Structured-Data element in RFC 5424.
SDParamCountSets the number of the Sd-param values for the specified SDElementIndex in RFC 5424.
SDParamNameSets the name of the SD-Param field in RFC 5424.
SDParamValueSets the value of the SD-Param field in RFC 5424.
TCPMessageDelimiterThe message delimiter to use (if any) when sending and receiving over TCP.
UseHostnameDetermines if the local host name or IP address is used in the Syslog header.
UseLocalTimeIndicates whether to use local time or GMT time for packet timestamps.
VersionDetermines which Syslog version to use.
CaptureIPPacketInfoUsed to capture the packet information.
DelayHostResolutionWhether the hostname is resolved when RemoteHost is set.
DestinationAddressUsed to get the destination address from the packet information.
DontFragmentUsed to set the Don't Fragment flag of outgoing packets.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxPacketSizeThe maximum length of the packets that can be received.
QOSDSCPValueUsed to specify an arbitrary QOS/DSCP setting (optional).
QOSTrafficTypeUsed to specify QOS/DSCP settings (optional).
ShareLocalPortIf set to True, allows more than one instance of the class to be active on the same local port.
SourceIPAddressUsed to set the source IP address used when sending a packet.
SourceMacAddressUsed to set the source MAC address used when sending a packet.
UseConnectionDetermines whether to use a connected socket.
UseIPv6Whether or not to use IPv6.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveDataWhether sensitive data is masked in log messages.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

Active Property (IPWorks_SysLog Class)

This property indicates whether the class is active.

Object Oriented Interface


public function getActive();


Procedural Interface


ipworks_syslog_get($res, 1 );


Default Value

false

Remarks

This property indicates whether the class is currently active and can send or receive data. Use the Activate and Deactivate methods to control whether the class is active.

This property is read-only and not available at design time.

Data Type

Boolean

LocalHost Property (IPWorks_SysLog Class)

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

Object Oriented Interface


public function getLocalHost();


public function setLocalHost($value);

Procedural Interface


ipworks_syslog_get($res, 2 );


ipworks_syslog_set($res, 2, $value );

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

Data Type

String

LocalPort Property (IPWorks_SysLog Class)

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

Object Oriented Interface


public function getLocalPort();


public function setLocalPort($value);

Procedural Interface


ipworks_syslog_get($res, 3 );


ipworks_syslog_set($res, 3, $value );

Default Value

514

Remarks

The LocalPort 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 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. Any attempt to set the LocalPort property when the class 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.

Data Type

Integer

RemoteHost Property (IPWorks_SysLog Class)

This property sets a specific host for outgoing log packets.

Object Oriented Interface


public function getRemoteHost();


public function setRemoteHost($value);

Procedural Interface


ipworks_syslog_get($res, 4 );


ipworks_syslog_set($res, 4, $value );

Default Value

'255.255.255.255'

Remarks

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

Data Type

String

RemotePort Property (IPWorks_SysLog Class)

This property sets a specific port for outgoing log packets.

Object Oriented Interface


public function getRemotePort();


public function setRemotePort($value);

Procedural Interface


ipworks_syslog_get($res, 5 );


ipworks_syslog_set($res, 5, $value );

Default Value

514

Remarks

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

Data Type

Integer

SSLAcceptServerCertEffectiveDate Property (IPWorks_SysLog Class)

This is the date on which this certificate becomes valid.

Object Oriented Interface


public function getSSLAcceptServerCertEffectiveDate();


Procedural Interface


ipworks_syslog_get($res, 6 );


Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (IPWorks_SysLog Class)

This is the date the certificate expires.

Object Oriented Interface


public function getSSLAcceptServerCertExpirationDate();


Procedural Interface


ipworks_syslog_get($res, 7 );


Default Value

''

Remarks

This is the date 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.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (IPWorks_SysLog Class)

This is a comma-delimited list of extended key usage identifiers.

Object Oriented Interface


public function getSSLAcceptServerCertExtendedKeyUsage();


Procedural Interface


ipworks_syslog_get($res, 8 );


Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (IPWorks_SysLog Class)

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface


public function getSSLAcceptServerCertFingerprint();


Procedural Interface


ipworks_syslog_get($res, 9 );


Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (IPWorks_SysLog Class)

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface


public function getSSLAcceptServerCertFingerprintSHA1();


Procedural Interface


ipworks_syslog_get($res, 10 );


Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (IPWorks_SysLog Class)

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface


public function getSSLAcceptServerCertFingerprintSHA256();


Procedural Interface


ipworks_syslog_get($res, 11 );


Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (IPWorks_SysLog Class)

This is the issuer of the certificate.

Object Oriented Interface


public function getSSLAcceptServerCertIssuer();


Procedural Interface


ipworks_syslog_get($res, 12 );


Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (IPWorks_SysLog Class)

This is the private key of the certificate (if available).

Object Oriented Interface


public function getSSLAcceptServerCertPrivateKey();


Procedural Interface


ipworks_syslog_get($res, 13 );


Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (IPWorks_SysLog Class)

This property shows whether a PrivateKey is available for the selected certificate.

Object Oriented Interface


public function getSSLAcceptServerCertPrivateKeyAvailable();


Procedural Interface


ipworks_syslog_get($res, 14 );


Default Value

false

Remarks

This property shows whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (IPWorks_SysLog Class)

This is the name of the PrivateKey container for the certificate (if available).

Object Oriented Interface


public function getSSLAcceptServerCertPrivateKeyContainer();


Procedural Interface


ipworks_syslog_get($res, 15 );


Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (IPWorks_SysLog Class)

This is the public key of the certificate.

Object Oriented Interface


public function getSSLAcceptServerCertPublicKey();


Procedural Interface


ipworks_syslog_get($res, 16 );


Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (IPWorks_SysLog Class)

This property contains the textual description of the certificate's public key algorithm.

Object Oriented Interface


public function getSSLAcceptServerCertPublicKeyAlgorithm();


Procedural Interface


ipworks_syslog_get($res, 17 );


Default Value

''

Remarks

This property contains 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.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (IPWorks_SysLog Class)

This is the length of the certificate's public key (in bits).

Object Oriented Interface


public function getSSLAcceptServerCertPublicKeyLength();


Procedural Interface


ipworks_syslog_get($res, 18 );


Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (IPWorks_SysLog Class)

This is the serial number of the certificate encoded as a string.

Object Oriented Interface


public function getSSLAcceptServerCertSerialNumber();


Procedural Interface


ipworks_syslog_get($res, 19 );


Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (IPWorks_SysLog Class)

The property contains the text description of the certificate's signature algorithm.

Object Oriented Interface


public function getSSLAcceptServerCertSignatureAlgorithm();


Procedural Interface


ipworks_syslog_get($res, 20 );


Default Value

''

Remarks

The property contains 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.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (IPWorks_SysLog Class)

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

Object Oriented Interface


public function getSSLAcceptServerCertStore();


public function setSSLAcceptServerCertStore($value);

Procedural Interface


ipworks_syslog_get($res, 21 );


ipworks_syslog_set($res, 21, $value );

Default Value

'MY'

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

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

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (IPWorks_SysLog Class)

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

Object Oriented Interface


public function getSSLAcceptServerCertStorePassword();


public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface


ipworks_syslog_get($res, 22 );


ipworks_syslog_set($res, 22, $value );

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.

Data Type

String

SSLAcceptServerCertStoreType Property (IPWorks_SysLog Class)

This is the type of certificate store for this certificate.

Object Oriented Interface


public function getSSLAcceptServerCertStoreType();


public function setSSLAcceptServerCertStoreType($value);

Procedural Interface


ipworks_syslog_get($res, 23 );


ipworks_syslog_set($res, 23, $value );

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:

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, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the SSLAcceptServerCertStore and set SSLAcceptServerCertStorePassword to the PIN.

Code Example. SSH Authentication with Security Key: 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);

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.

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (IPWorks_SysLog Class)

This property contains comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface


public function getSSLAcceptServerCertSubjectAltNames();


Procedural Interface


ipworks_syslog_get($res, 24 );


Default Value

''

Remarks

This property contains comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (IPWorks_SysLog Class)

This property contains the MD5 hash of the certificate.

Object Oriented Interface


public function getSSLAcceptServerCertThumbprintMD5();


Procedural Interface


ipworks_syslog_get($res, 25 );


Default Value

''

Remarks

This property contains 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.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (IPWorks_SysLog Class)

This property contains the SHA-1 hash of the certificate.

Object Oriented Interface


public function getSSLAcceptServerCertThumbprintSHA1();


Procedural Interface


ipworks_syslog_get($res, 26 );


Default Value

''

Remarks

This property contains 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.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (IPWorks_SysLog Class)

This property contains the SHA-256 hash of the certificate.

Object Oriented Interface


public function getSSLAcceptServerCertThumbprintSHA256();


Procedural Interface


ipworks_syslog_get($res, 27 );


Default Value

''

Remarks

This property contains 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.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (IPWorks_SysLog Class)

This property contains the text description of UsageFlags .

Object Oriented Interface


public function getSSLAcceptServerCertUsage();


Procedural Interface


ipworks_syslog_get($res, 28 );


Default Value

''

Remarks

This property contains the text description of SSLAcceptServerCertUsageFlags.

This value will be of 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.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (IPWorks_SysLog Class)

This property contains the flags that show intended use for the certificate.

Object Oriented Interface


public function getSSLAcceptServerCertUsageFlags();


Procedural Interface


ipworks_syslog_get($res, 29 );


Default Value

0

Remarks

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

0x80Digital Signature
0x40Non-Repudiation
0x20Key Encipherment
0x10Data Encipherment
0x08Key Agreement
0x04Certificate Signing
0x02CRL Signing
0x01Encipher Only

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (IPWorks_SysLog Class)

This property contains the certificate's version number.

Object Oriented Interface


public function getSSLAcceptServerCertVersion();


Procedural Interface


ipworks_syslog_get($res, 30 );


Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (IPWorks_SysLog Class)

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

Object Oriented Interface


public function getSSLAcceptServerCertSubject();


public function setSSLAcceptServerCertSubject($value);

Procedural Interface


ipworks_syslog_get($res, 31 );


ipworks_syslog_set($res, 31, $value );

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:

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

Data Type

String

SSLAcceptServerCertEncoded Property (IPWorks_SysLog Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface


public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface


ipworks_syslog_get($res, 32 );


ipworks_syslog_set($res, 32, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLAuthenticateClients Property (IPWorks_SysLog Class)

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

Object Oriented Interface


public function getSSLAuthenticateClients();


public function setSSLAuthenticateClients($value);

Procedural Interface


ipworks_syslog_get($res, 33 );


ipworks_syslog_set($res, 33, $value );

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.

Data Type

Boolean

SSLCertEffectiveDate Property (IPWorks_SysLog Class)

This is the date on which this certificate becomes valid.

Object Oriented Interface


public function getSSLCertEffectiveDate();


Procedural Interface


ipworks_syslog_get($res, 34 );


Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (IPWorks_SysLog Class)

This is the date the certificate expires.

Object Oriented Interface


public function getSSLCertExpirationDate();


Procedural Interface


ipworks_syslog_get($res, 35 );


Default Value

''

Remarks

This is the date 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.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (IPWorks_SysLog Class)

This is a comma-delimited list of extended key usage identifiers.

Object Oriented Interface


public function getSSLCertExtendedKeyUsage();


Procedural Interface


ipworks_syslog_get($res, 36 );


Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertFingerprint Property (IPWorks_SysLog Class)

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface


public function getSSLCertFingerprint();


Procedural Interface


ipworks_syslog_get($res, 37 );


Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (IPWorks_SysLog Class)

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface


public function getSSLCertFingerprintSHA1();


Procedural Interface


ipworks_syslog_get($res, 38 );


Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (IPWorks_SysLog Class)

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface


public function getSSLCertFingerprintSHA256();


Procedural Interface


ipworks_syslog_get($res, 39 );


Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertIssuer Property (IPWorks_SysLog Class)

This is the issuer of the certificate.

Object Oriented Interface


public function getSSLCertIssuer();


Procedural Interface


ipworks_syslog_get($res, 40 );


Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (IPWorks_SysLog Class)

This is the private key of the certificate (if available).

Object Oriented Interface


public function getSSLCertPrivateKey();


Procedural Interface


ipworks_syslog_get($res, 41 );


Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (IPWorks_SysLog Class)

This property shows whether a PrivateKey is available for the selected certificate.

Object Oriented Interface


public function getSSLCertPrivateKeyAvailable();


Procedural Interface


ipworks_syslog_get($res, 42 );


Default Value

false

Remarks

This property shows whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (IPWorks_SysLog Class)

This is the name of the PrivateKey container for the certificate (if available).

Object Oriented Interface


public function getSSLCertPrivateKeyContainer();


Procedural Interface


ipworks_syslog_get($res, 43 );


Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKey Property (IPWorks_SysLog Class)

This is the public key of the certificate.

Object Oriented Interface


public function getSSLCertPublicKey();


Procedural Interface


ipworks_syslog_get($res, 44 );


Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (IPWorks_SysLog Class)

This property contains the textual description of the certificate's public key algorithm.

Object Oriented Interface


public function getSSLCertPublicKeyAlgorithm();


Procedural Interface


ipworks_syslog_get($res, 45 );


Default Value

''

Remarks

This property contains 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.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (IPWorks_SysLog Class)

This is the length of the certificate's public key (in bits).

Object Oriented Interface


public function getSSLCertPublicKeyLength();


Procedural Interface


ipworks_syslog_get($res, 46 );


Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (IPWorks_SysLog Class)

This is the serial number of the certificate encoded as a string.

Object Oriented Interface


public function getSSLCertSerialNumber();


Procedural Interface


ipworks_syslog_get($res, 47 );


Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (IPWorks_SysLog Class)

The property contains the text description of the certificate's signature algorithm.

Object Oriented Interface


public function getSSLCertSignatureAlgorithm();


Procedural Interface


ipworks_syslog_get($res, 48 );


Default Value

''

Remarks

The property contains 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.

This property is read-only.

Data Type

String

SSLCertStore Property (IPWorks_SysLog Class)

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

Object Oriented Interface


public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface


ipworks_syslog_get($res, 49 );


ipworks_syslog_set($res, 49, $value );

Default Value

'MY'

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

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

Data Type

Binary String

SSLCertStorePassword Property (IPWorks_SysLog Class)

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

Object Oriented Interface


public function getSSLCertStorePassword();


public function setSSLCertStorePassword($value);

Procedural Interface


ipworks_syslog_get($res, 50 );


ipworks_syslog_set($res, 50, $value );

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.

Data Type

String

SSLCertStoreType Property (IPWorks_SysLog Class)

This is the type of certificate store for this certificate.

Object Oriented Interface


public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface


ipworks_syslog_get($res, 51 );


ipworks_syslog_set($res, 51, $value );

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:

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, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN.

Code Example. SSH Authentication with Security Key: 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);

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.

Data Type

Integer

SSLCertSubjectAltNames Property (IPWorks_SysLog Class)

This property contains comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface


public function getSSLCertSubjectAltNames();


Procedural Interface


ipworks_syslog_get($res, 52 );


Default Value

''

Remarks

This property contains comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (IPWorks_SysLog Class)

This property contains the MD5 hash of the certificate.

Object Oriented Interface


public function getSSLCertThumbprintMD5();


Procedural Interface


ipworks_syslog_get($res, 53 );


Default Value

''

Remarks

This property contains 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.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (IPWorks_SysLog Class)

This property contains the SHA-1 hash of the certificate.

Object Oriented Interface


public function getSSLCertThumbprintSHA1();


Procedural Interface


ipworks_syslog_get($res, 54 );


Default Value

''

Remarks

This property contains 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.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (IPWorks_SysLog Class)

This property contains the SHA-256 hash of the certificate.

Object Oriented Interface


public function getSSLCertThumbprintSHA256();


Procedural Interface


ipworks_syslog_get($res, 55 );


Default Value

''

Remarks

This property contains 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.

This property is read-only.

Data Type

String

SSLCertUsage Property (IPWorks_SysLog Class)

This property contains the text description of UsageFlags .

Object Oriented Interface


public function getSSLCertUsage();


Procedural Interface


ipworks_syslog_get($res, 56 );


Default Value

''

Remarks

This property contains the text description of SSLCertUsageFlags.

This value will be of 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.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (IPWorks_SysLog Class)

This property contains the flags that show intended use for the certificate.

Object Oriented Interface


public function getSSLCertUsageFlags();


Procedural Interface


ipworks_syslog_get($res, 57 );


Default Value

0

Remarks

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

0x80Digital Signature
0x40Non-Repudiation
0x20Key Encipherment
0x10Data Encipherment
0x08Key Agreement
0x04Certificate Signing
0x02CRL Signing
0x01Encipher Only

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLCertVersion Property (IPWorks_SysLog Class)

This property contains the certificate's version number.

Object Oriented Interface


public function getSSLCertVersion();


Procedural Interface


ipworks_syslog_get($res, 58 );


Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertSubject Property (IPWorks_SysLog Class)

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

Object Oriented Interface


public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface


ipworks_syslog_get($res, 59 );


ipworks_syslog_set($res, 59, $value );

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:

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

Data Type

String

SSLCertEncoded Property (IPWorks_SysLog Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface


public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface


ipworks_syslog_get($res, 60 );


ipworks_syslog_set($res, 60, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLEnabled Property (IPWorks_SysLog Class)

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

Object Oriented Interface


public function getSSLEnabled();


public function setSSLEnabled($value);

Procedural Interface


ipworks_syslog_get($res, 61 );


ipworks_syslog_set($res, 61, $value );

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

This property is not available at design time.

Data Type

Boolean

SSLServerCertEffectiveDate Property (IPWorks_SysLog Class)

This is the date on which this certificate becomes valid.

Object Oriented Interface


public function getSSLServerCertEffectiveDate();


Procedural Interface


ipworks_syslog_get($res, 62 );


Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (IPWorks_SysLog Class)

This is the date the certificate expires.

Object Oriented Interface


public function getSSLServerCertExpirationDate();


Procedural Interface


ipworks_syslog_get($res, 63 );


Default Value

''

Remarks

This is the date 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.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (IPWorks_SysLog Class)

This is a comma-delimited list of extended key usage identifiers.

Object Oriented Interface


public function getSSLServerCertExtendedKeyUsage();


Procedural Interface


ipworks_syslog_get($res, 64 );


Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (IPWorks_SysLog Class)

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface


public function getSSLServerCertFingerprint();


Procedural Interface


ipworks_syslog_get($res, 65 );


Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (IPWorks_SysLog Class)

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface


public function getSSLServerCertFingerprintSHA1();


Procedural Interface


ipworks_syslog_get($res, 66 );


Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (IPWorks_SysLog Class)

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface


public function getSSLServerCertFingerprintSHA256();


Procedural Interface


ipworks_syslog_get($res, 67 );


Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (IPWorks_SysLog Class)

This is the issuer of the certificate.

Object Oriented Interface


public function getSSLServerCertIssuer();


Procedural Interface


ipworks_syslog_get($res, 68 );


Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (IPWorks_SysLog Class)

This is the private key of the certificate (if available).

Object Oriented Interface


public function getSSLServerCertPrivateKey();


Procedural Interface


ipworks_syslog_get($res, 69 );


Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (IPWorks_SysLog Class)

This property shows whether a PrivateKey is available for the selected certificate.

Object Oriented Interface


public function getSSLServerCertPrivateKeyAvailable();


Procedural Interface


ipworks_syslog_get($res, 70 );


Default Value

false

Remarks

This property shows whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (IPWorks_SysLog Class)

This is the name of the PrivateKey container for the certificate (if available).

Object Oriented Interface


public function getSSLServerCertPrivateKeyContainer();


Procedural Interface


ipworks_syslog_get($res, 71 );


Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (IPWorks_SysLog Class)

This is the public key of the certificate.

Object Oriented Interface


public function getSSLServerCertPublicKey();


Procedural Interface


ipworks_syslog_get($res, 72 );


Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (IPWorks_SysLog Class)

This property contains the textual description of the certificate's public key algorithm.

Object Oriented Interface


public function getSSLServerCertPublicKeyAlgorithm();


Procedural Interface


ipworks_syslog_get($res, 73 );


Default Value

''

Remarks

This property contains 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.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (IPWorks_SysLog Class)

This is the length of the certificate's public key (in bits).

Object Oriented Interface


public function getSSLServerCertPublicKeyLength();


Procedural Interface


ipworks_syslog_get($res, 74 );


Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (IPWorks_SysLog Class)

This is the serial number of the certificate encoded as a string.

Object Oriented Interface


public function getSSLServerCertSerialNumber();


Procedural Interface


ipworks_syslog_get($res, 75 );


Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (IPWorks_SysLog Class)

The property contains the text description of the certificate's signature algorithm.

Object Oriented Interface


public function getSSLServerCertSignatureAlgorithm();


Procedural Interface


ipworks_syslog_get($res, 76 );


Default Value

''

Remarks

The property contains 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.

This property is read-only.

Data Type

String

SSLServerCertStore Property (IPWorks_SysLog Class)

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

Object Oriented Interface


public function getSSLServerCertStore();


Procedural Interface


ipworks_syslog_get($res, 77 );


Default Value

'MY'

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

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

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (IPWorks_SysLog Class)

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

Object Oriented Interface


public function getSSLServerCertStorePassword();


Procedural Interface


ipworks_syslog_get($res, 78 );


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.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (IPWorks_SysLog Class)

This is the type of certificate store for this certificate.

Object Oriented Interface


public function getSSLServerCertStoreType();


Procedural Interface


ipworks_syslog_get($res, 79 );


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:

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, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the SSLServerCertStore and set SSLServerCertStorePassword to the PIN.

Code Example. SSH Authentication with Security Key: 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);

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.

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (IPWorks_SysLog Class)

This property contains comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface


public function getSSLServerCertSubjectAltNames();


Procedural Interface


ipworks_syslog_get($res, 80 );


Default Value

''

Remarks

This property contains comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (IPWorks_SysLog Class)

This property contains the MD5 hash of the certificate.

Object Oriented Interface


public function getSSLServerCertThumbprintMD5();


Procedural Interface


ipworks_syslog_get($res, 81 );


Default Value

''

Remarks

This property contains 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.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (IPWorks_SysLog Class)

This property contains the SHA-1 hash of the certificate.

Object Oriented Interface


public function getSSLServerCertThumbprintSHA1();


Procedural Interface


ipworks_syslog_get($res, 82 );


Default Value

''

Remarks

This property contains 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.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (IPWorks_SysLog Class)

This property contains the SHA-256 hash of the certificate.

Object Oriented Interface


public function getSSLServerCertThumbprintSHA256();


Procedural Interface


ipworks_syslog_get($res, 83 );


Default Value

''

Remarks

This property contains 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.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (IPWorks_SysLog Class)

This property contains the text description of UsageFlags .

Object Oriented Interface


public function getSSLServerCertUsage();


Procedural Interface


ipworks_syslog_get($res, 84 );


Default Value

''

Remarks

This property contains the text description of SSLServerCertUsageFlags.

This value will be of 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.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (IPWorks_SysLog Class)

This property contains the flags that show intended use for the certificate.

Object Oriented Interface


public function getSSLServerCertUsageFlags();


Procedural Interface


ipworks_syslog_get($res, 85 );


Default Value

0

Remarks

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

0x80Digital Signature
0x40Non-Repudiation
0x20Key Encipherment
0x10Data Encipherment
0x08Key Agreement
0x04Certificate Signing
0x02CRL Signing
0x01Encipher Only

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (IPWorks_SysLog Class)

This property contains the certificate's version number.

Object Oriented Interface


public function getSSLServerCertVersion();


Procedural Interface


ipworks_syslog_get($res, 86 );


Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertSubject Property (IPWorks_SysLog Class)

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

Object Oriented Interface


public function getSSLServerCertSubject();


Procedural Interface


ipworks_syslog_get($res, 87 );


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:

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (IPWorks_SysLog Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface


public function getSSLServerCertEncoded();


Procedural Interface


ipworks_syslog_get($res, 88 );


Default Value

''

Remarks

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

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

This property is read-only and not available at design time.

Data Type

Binary String

UseTCP Property (IPWorks_SysLog Class)

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

Object Oriented Interface


public function getUseTCP();


public function setUseTCP($value);

Procedural Interface


ipworks_syslog_get($res, 89 );


ipworks_syslog_set($res, 89, $value );

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:

Data Type

Boolean

Activate Method (IPWorks_SysLog Class)

This method enables sending and receiving of data.

Object Oriented Interface

public function doActivate();

Procedural Interface

ipworks_syslog_do_activate($res);

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 configuration setting is set to true, then a local association (connection) to the remote host is also created.

Config Method (IPWorks_SysLog Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworks_syslog_do_config($res, $configurationstring);

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 (IPWorks_SysLog Class)

This method disables sending and receive of data.

Object Oriented Interface

public function doDeactivate();

Procedural Interface

ipworks_syslog_do_deactivate($res);

Remarks

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

DoEvents Method (IPWorks_SysLog Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworks_syslog_do_doevents($res);

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 (IPWorks_SysLog Class)

This method will reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworks_syslog_do_reset($res);

Remarks

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

ResolveRemoteHost Method (IPWorks_SysLog Class)

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

Object Oriented Interface

public function doResolveRemoteHost();

Procedural Interface

ipworks_syslog_do_resolveremotehost($res);

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 class will resolve the hostname automatically when needed. If DelayHostResolution is true, this method may be called to manually resolve RemoteHost, if desired.

SendPacket Method (IPWorks_SysLog Class)

This method sends a log packet to RemoteHost .

Object Oriented Interface

public function doSendPacket($facility, $severity, $message);

Procedural Interface

ipworks_syslog_do_sendpacket($res, $facility, $severity, $message);

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:

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

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

0Emergency - the system is unusable
1Alert - action must be taken immediately
2Critical - critical conditions exist
3Error - error conditions exist
4Warning - warning conditions exist
5Notice - normal but significant condition
6Informational - informative message
7Debug - 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 (IPWorks_SysLog Class)

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

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

ipworks_syslog_register_callback($res, 1, array($this, 'fireConnected'));

Parameter List

 'remoteaddress'
'remoteport'
'statuscode'
'description'

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 (IPWorks_SysLog Class)

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

Object Oriented Interface

public function fireConnectionStatus($param);

Procedural Interface

ipworks_syslog_register_callback($res, 2, array($this, 'fireConnectionStatus'));

Parameter List

 'connectionevent'
'statuscode'
'description'

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 (IPWorks_SysLog Class)

This event is fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

ipworks_syslog_register_callback($res, 3, array($this, 'fireDisconnected'));

Parameter List

 'remoteaddress'
'remoteport'
'statuscode'
'description'

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 (IPWorks_SysLog Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworks_syslog_register_callback($res, 4, array($this, 'fireError'));

Parameter List

 'errorcode'
'description'

Remarks

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

PacketIn Event (IPWorks_SysLog Class)

This event fires whenever a system log packet is received.

Object Oriented Interface

public function firePacketIn($param);

Procedural Interface

ipworks_syslog_register_callback($res, 5, array($this, 'firePacketIn'));

Parameter List

 'facilitycode'
'facility'
'severitycode'
'severity'
'timestamp'
'hostname'
'message'
'conforms'
'packet'
'sourceaddress'
'sourceport'

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:

0Kernel messages
1User-level messages
2Mail system
3System daemons
4Security/authorization messages
5Messages generated internally by syslogd
6Line printer subsystem
7Network news subsystem
8UUCP subsystem
9Clock daemon
10Security/authorization messages
11FTP daemon
12NTP subsystem
13Log audit
14Log alert
15Clock daemon
16Local use
17Local use
18Local use
19Local use
20Local use
21Local use
22Local use
23Local use
SeverityCode is a value from 0 to 7. Severity is a string representation of SeverityCode using the following convention:
0Emergency - the system is unusable.
1Alert - action must be taken immediately.
2Critical - critical conditions exist.
3Error - error conditions exist.
4Warning - warning conditions exist.
5Notice - normal but significant condition.
6Informational - informative message.
7Debug - 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 (IPWorks_SysLog Class)

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

Object Oriented Interface

public function fireSSLClientAuthentication($param);

Procedural Interface

ipworks_syslog_register_callback($res, 6, array($this, 'fireSSLClientAuthentication'));

Parameter List

 'remoteaddress'
'remoteport'
'certencoded'
'certsubject'
'certissuer'
'status'
'accept'

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 (IPWorks_SysLog Class)

This event fires when connecting to the server.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

ipworks_syslog_register_callback($res, 7, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'remoteaddress'
'remoteport'
'certencoded'
'certsubject'
'certissuer'
'status'
'accept'

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 (IPWorks_SysLog Class)

This event shows the progress of the secure connection.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworks_syslog_register_callback($res, 8, array($this, 'fireSSLStatus'));

Parameter List

 'remoteaddress'
'remoteport'
'message'

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.

Config Settings (SysLog Class)

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 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 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 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 is set. If true the class will resolve the hostname and the IP address will be present in the RemoteHost 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 may be called to manually resolve the value in RemoteHost 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 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 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 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 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 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 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 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 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 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 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 is set to 1 (RFC 5424)

The following example demonstrates how to obtain the structured data information from a received message: 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 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 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 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 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 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 is set to 1 (RFC 5424)

The following example demonstrates how to set the Struct-Data configs: 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 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 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, MsgId, 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 is set. If true the class will resolve the hostname and the IP address will be present in the RemoteHost 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 may be called to manually resolve the value in RemoteHost at any time.

The default value is false.

DestinationAddress:   Used to get the destination address from the packet information.

If 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 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 classs) only through that interface.

If the class is connected, the LocalHost 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 after the connection is established.

LocalPort 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 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 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 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 property or it will have no effect.

The default value for this setting is False.

SourceIPAddress:   Used to set the source IP address used when sending a packet.

This configuration setting can be used to override the source IP address when sending a packet.

Note: This configuration setting is available only in Windows and requires that the winpcap library be installed (or npcap with winpcap compatibility).

SourceMacAddress:   Used to set the source MAC address used when sending a packet.

This configuration setting can be used to override the source MAC address when sending a packet.

Note: This configuration setting is available only in Windows and requires that the winpcap library be installed (or npcap with winpcap compatibility).

UseConnection:   Determines whether to use a connected socket.

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

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

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.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

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.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

Trappable Errors (SysLog Class)

SysLog Errors

451   Unable to acquire valid system time.

UDP Errors

104   UDP is already Active.
106   You cannot change the LocalPort while the class is Active.
107   You cannot change the LocalHost at this time. A connection is in progress.
109   The class must be Active for this operation.
112   You cannot change MaxPacketSize while the class is Active.
113   You cannot change ShareLocalPort option while the class is Active.
114   You cannot change RemoteHost when UseConnection is set and the class Active.
115   You cannot change RemotePort when UseConnection is set and the class is Active.
116   RemotePort cannot be zero when UseConnection is set. Please specify a valid service port number.
117   You cannot change UseConnection while the class is Active.
118   Message cannot be longer than 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).