# DTLSClient Class

The DTLSClient class provides client-side functionality for secure UDP communication utilizing the Datagram Transport Layer Security (DTLS) protocol.

## Class Name

**IPWorks_DTLSClient**

## Procedural Interface

```text
 ipworks_dtlsclient_open();
 ipworks_dtlsclient_close($res);
 ipworks_dtlsclient_register_callback($res, $id, $function);
 ipworks_dtlsclient_get_last_error($res);
 ipworks_dtlsclient_get_last_error_code($res);
 ipworks_dtlsclient_set($res, $id, $index, $value);
 ipworks_dtlsclient_get($res, $id, $index);
 ipworks_dtlsclient_do_config($res, $configurationstring);
 ipworks_dtlsclient_do_connect($res);
 ipworks_dtlsclient_do_disconnect($res);
 ipworks_dtlsclient_do_doevents($res);
 ipworks_dtlsclient_do_pausedata($res);
 ipworks_dtlsclient_do_processdata($res);
 ipworks_dtlsclient_do_reset($res);
 ipworks_dtlsclient_do_sendbytes($res, $data);
 ipworks_dtlsclient_do_sendtext($res, $text);
```

## Remarks

The DTLSClient class functions as a client that facilitates in connecting to DTLS servers and offers a convenient means of transmitting and receiving datagrams over the established, secure connection.

### Connecting to a Server

First, the [RemoteHost](#remotehost-property-ipworks_dtlsclient-class) and [RemotePort](#remoteport-property-ipworks_dtlsclient-class) must be set to the address and port of the target DTLS server. The [Timeout](#timeout-property-ipworks_dtlsclient-class) property can be used to specify a timeout when connecting to the server. To initiate the connection, call [Connect](#connect-method-ipworks_dtlsclient-class).

After doing so, the handshake process will begin. Relevant handshake details will be reported by the [SSLStatus](#sslstatus-event-ipworks_dtlsclient-class) event. Initially, the server will present its certificate to the client. The certificate can be evaluated within the [SSLServerAuthentication](#sslserverauthentication-event-ipworks_dtlsclient-class) event. By default, the class will provide a recommendation of whether to accept or reject the certificate, and reasoning behind the recommendation. Regardless, the certificate can be manually accepted (or rejected) within this event.

In some cases, the server requires the client to present a certificate as well. In this case, a valid certificate will need to be specified via the SSLCert property.

Once the connection is complete (or fails), the [Connected](#connected-event-ipworks_dtlsclient-class) event will fire. Note that this event will fire if a connection succeeds or fails. If successful, the event will fire with a *StatusCode* of 0. If this value is non-zero, it indicates the connection was unsuccessful. The *Description* parameter will contain relevant details. Upon successful connection, the [Connected](#connected-property-ipworks_dtlsclient-class) property will be set to *True*. This process may look like the following:

```csharp
dtlsclient.OnConnected += (o, e) => {
  if (e.StatusCode == 0) {
    Console.WriteLine("Connection successful!");
  } else {
    Console.WriteLine("Connection failed.");
    Console.WriteLine("Error code: " + e.StatusCode);
    Console.WriteLine("Error description: " + e.Description);
  }
};

dtlsclient.OnSSLServerAuthentication += (o, e) => {
  if (e.Accept) return;
  Console.Write("Server provided the following certificate:\nIssuer: " + e.CertIssuer + "\nSubject: " + e.CertSubject + "\n");
  Console.Write("The following problems have been determined for this certificate: " + e.Status + "\n");
  Console.Write("Would you like to accept anyways? [y/n] ");
  if (Console.Read() == 'y') e.Accept = true;
};

dtlsclient.RemoteHost = "remote_ip";
dtlsclient.RemotePort = 1234;
dtlsclient.Timeout = 30;

// if client authentication is applicable
dtlsclient.SSLCert = new Certificate("/path/to/cert.pfx", CertStoreTypes.cstPFXFile, "cert_password", "cert_subject");

dtlsclient.Connect();
```

### Sending and Receiving Data

Once a successful connection is established, the class can send data to the server via [SendText](#sendtext-method-ipworks_dtlsclient-class) or [SendBytes](#sendbytes-method-ipworks_dtlsclient-class).

The class will also be able to receive data from the server via the [DataIn](#datain-event-ipworks_dtlsclient-class) event. Note that this event is non-reentrant, and it is recommended to offload time-consuming operations to ensure the best performance.

If required, the [PauseData](#pausedata-method-ipworks_dtlsclient-class) method can be called, disabling the reception of incoming data from the server. Data reception can later be enabled via the [ProcessData](#processdata-method-ipworks_dtlsclient-class) method. Note that if this reception is disabled, the server may continue sending data, which will remain unprocessed by the class. In this case, the underlying socket buffer may be filled. This can result in possible data loss originating from the server. Please use these methods with caution.

The complete process may look like the following:

```csharp
dtlsclient.OnSSLServerAuthentication += (o, e) => {
  e.Accept = true;
};

dtlsclient.OnDataIn += (o, e) => {
  Console.WriteLine("Packet received from server.");
  Console.WriteLine("Datagram: " + e.Datagram);
}

dtlsclient.RemoteHost = "remote_ip";
dtlsclient.RemotePort = 1234;

dtlsclient.Connect();

dtlsclient.SendText("Hello World!");

while (true) {
  dtlsclient.DoEvents();
}
```

### Disconnecting from a Server

Once the connection to the server is broken, the [Disconnected](#disconnected-event-ipworks_dtlsclient-class) event will fire. The disconnection can be performed by calling [Disconnect](#disconnect-method-ipworks_dtlsclient-class), or performed by the server.

In the case a connection ends and an error is encountered, the *StatusCode* and *Description* parameters will contain relevant details regarding the error. For example:

```csharp
dtlsclient.OnDisconnected += (o, e) => {
  if (e.StatusCode == 0) {
    Console.WriteLine("Connection ended.");
  } else {
    Console.WriteLine("Connection ended.");
    Console.WriteLine("Error code: " + e.StatusCode);
    Console.WriteLine("Error description: " + e.Description);
  }
};

dtlsclient.RemoteHost = "remote_ip";
dtlsclient.RemotePort = 1234;

dtlsclient.Connect();
...
...
...
dtlsclient.Disconnect();
```

### Additional Information

To support [KeepAlive](#keepalive-property-ipworks_dtlsclient-class) functionality, it is important to note that [DoEvents](#doevents-method-ipworks_dtlsclient-class) **must** be called regularly in both console and form-based applications. This is to ensure the class sends keep-alive (or Heartbeat) packets to the server in a timely manner.

In form-based applications, this does not apply if [KeepAlive](#keepalive-property-ipworks_dtlsclient-class) is *False*.

## Property List

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

|  |  |
| --- | --- |
| [AcceptData](#acceptdata-property-ipworks_dtlsclient-class) | This property indicates whether data reception is currently enabled. |
| [Connected](#connected-property-ipworks_dtlsclient-class) | This property indicates whether the class is connected. |
| [KeepAlive](#keepalive-property-ipworks_dtlsclient-class) | When True, keep-alive functionality is enabled via the DTLS Heartbeat Extension. |
| [LocalHost](#localhost-property-ipworks_dtlsclient-class) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| [LocalPort](#localport-property-ipworks_dtlsclient-class) | This property includes the User Datagram Protocol (UDP) port in the local host where the class binds. |
| [RemoteHost](#remotehost-property-ipworks_dtlsclient-class) | This property includes the address of the remote host. Domain names are resolved to IP addresses. |
| [RemotePort](#remoteport-property-ipworks_dtlsclient-class) | This property specifies the User Datagram Protocol (UDP) port in the remote host. |
| [SSLAcceptServerCertEffectiveDate](#sslacceptservercerteffectivedate-property-ipworks_dtlsclient-class) | The date on which this certificate becomes valid. |
| [SSLAcceptServerCertExpirationDate](#sslacceptservercertexpirationdate-property-ipworks_dtlsclient-class) | The date on which the certificate expires. |
| [SSLAcceptServerCertExtendedKeyUsage](#sslacceptservercertextendedkeyusage-property-ipworks_dtlsclient-class) | A comma-delimited list of extended key usage identifiers. |
| [SSLAcceptServerCertFingerprint](#sslacceptservercertfingerprint-property-ipworks_dtlsclient-class) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [SSLAcceptServerCertFingerprintSHA1](#sslacceptservercertfingerprintsha1-property-ipworks_dtlsclient-class) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [SSLAcceptServerCertFingerprintSHA256](#sslacceptservercertfingerprintsha256-property-ipworks_dtlsclient-class) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [SSLAcceptServerCertIssuer](#sslacceptservercertissuer-property-ipworks_dtlsclient-class) | The issuer of the certificate. |
| [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-ipworks_dtlsclient-class) | The private key of the certificate (if available). |
| [SSLAcceptServerCertPrivateKeyAvailable](#sslacceptservercertprivatekeyavailable-property-ipworks_dtlsclient-class) | Whether a PrivateKey is available for the selected certificate. |
| [SSLAcceptServerCertPrivateKeyContainer](#sslacceptservercertprivatekeycontainer-property-ipworks_dtlsclient-class) | The name of the PrivateKey container for the certificate (if available). |
| [SSLAcceptServerCertPublicKey](#sslacceptservercertpublickey-property-ipworks_dtlsclient-class) | The public key of the certificate. |
| [SSLAcceptServerCertPublicKeyAlgorithm](#sslacceptservercertpublickeyalgorithm-property-ipworks_dtlsclient-class) | The textual description of the certificate's public key algorithm. |
| [SSLAcceptServerCertPublicKeyLength](#sslacceptservercertpublickeylength-property-ipworks_dtlsclient-class) | The length of the certificate's public key (in bits). |
| [SSLAcceptServerCertSerialNumber](#sslacceptservercertserialnumber-property-ipworks_dtlsclient-class) | The serial number of the certificate encoded as a string. |
| [SSLAcceptServerCertSignatureAlgorithm](#sslacceptservercertsignaturealgorithm-property-ipworks_dtlsclient-class) | The text description of the certificate's signature algorithm. |
| [SSLAcceptServerCertStore](#sslacceptservercertstore-property-ipworks_dtlsclient-class) | The name of the certificate store for the client certificate. |
| [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-ipworks_dtlsclient-class) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [SSLAcceptServerCertStoreType](#sslacceptservercertstoretype-property-ipworks_dtlsclient-class) | The type of certificate store for this certificate. |
| [SSLAcceptServerCertSubjectAltNames](#sslacceptservercertsubjectaltnames-property-ipworks_dtlsclient-class) | Comma-separated lists of alternative subject names for the certificate. |
| [SSLAcceptServerCertThumbprintMD5](#sslacceptservercertthumbprintmd5-property-ipworks_dtlsclient-class) | The MD5 hash of the certificate. |
| [SSLAcceptServerCertThumbprintSHA1](#sslacceptservercertthumbprintsha1-property-ipworks_dtlsclient-class) | The SHA-1 hash of the certificate. |
| [SSLAcceptServerCertThumbprintSHA256](#sslacceptservercertthumbprintsha256-property-ipworks_dtlsclient-class) | The SHA-256 hash of the certificate. |
| [SSLAcceptServerCertUsage](#sslacceptservercertusage-property-ipworks_dtlsclient-class) | The text description of UsageFlags . |
| [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-ipworks_dtlsclient-class) | The flags that show intended use for the certificate. |
| [SSLAcceptServerCertVersion](#sslacceptservercertversion-property-ipworks_dtlsclient-class) | The certificate's version number. |
| [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-ipworks_dtlsclient-class) | The subject of the certificate used for client authentication. |
| [SSLAcceptServerCertEncoded](#sslacceptservercertencoded-property-ipworks_dtlsclient-class) | The certificate (PEM/Base64 encoded). |
| [SSLCertEffectiveDate](#sslcerteffectivedate-property-ipworks_dtlsclient-class) | The date on which this certificate becomes valid. |
| [SSLCertExpirationDate](#sslcertexpirationdate-property-ipworks_dtlsclient-class) | The date on which the certificate expires. |
| [SSLCertExtendedKeyUsage](#sslcertextendedkeyusage-property-ipworks_dtlsclient-class) | A comma-delimited list of extended key usage identifiers. |
| [SSLCertFingerprint](#sslcertfingerprint-property-ipworks_dtlsclient-class) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [SSLCertFingerprintSHA1](#sslcertfingerprintsha1-property-ipworks_dtlsclient-class) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [SSLCertFingerprintSHA256](#sslcertfingerprintsha256-property-ipworks_dtlsclient-class) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [SSLCertIssuer](#sslcertissuer-property-ipworks_dtlsclient-class) | The issuer of the certificate. |
| [SSLCertPrivateKey](#sslcertprivatekey-property-ipworks_dtlsclient-class) | The private key of the certificate (if available). |
| [SSLCertPrivateKeyAvailable](#sslcertprivatekeyavailable-property-ipworks_dtlsclient-class) | Whether a PrivateKey is available for the selected certificate. |
| [SSLCertPrivateKeyContainer](#sslcertprivatekeycontainer-property-ipworks_dtlsclient-class) | The name of the PrivateKey container for the certificate (if available). |
| [SSLCertPublicKey](#sslcertpublickey-property-ipworks_dtlsclient-class) | The public key of the certificate. |
| [SSLCertPublicKeyAlgorithm](#sslcertpublickeyalgorithm-property-ipworks_dtlsclient-class) | The textual description of the certificate's public key algorithm. |
| [SSLCertPublicKeyLength](#sslcertpublickeylength-property-ipworks_dtlsclient-class) | The length of the certificate's public key (in bits). |
| [SSLCertSerialNumber](#sslcertserialnumber-property-ipworks_dtlsclient-class) | The serial number of the certificate encoded as a string. |
| [SSLCertSignatureAlgorithm](#sslcertsignaturealgorithm-property-ipworks_dtlsclient-class) | The text description of the certificate's signature algorithm. |
| [SSLCertStore](#sslcertstore-property-ipworks_dtlsclient-class) | The name of the certificate store for the client certificate. |
| [SSLCertStorePassword](#sslcertstorepassword-property-ipworks_dtlsclient-class) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [SSLCertStoreType](#sslcertstoretype-property-ipworks_dtlsclient-class) | The type of certificate store for this certificate. |
| [SSLCertSubjectAltNames](#sslcertsubjectaltnames-property-ipworks_dtlsclient-class) | Comma-separated lists of alternative subject names for the certificate. |
| [SSLCertThumbprintMD5](#sslcertthumbprintmd5-property-ipworks_dtlsclient-class) | The MD5 hash of the certificate. |
| [SSLCertThumbprintSHA1](#sslcertthumbprintsha1-property-ipworks_dtlsclient-class) | The SHA-1 hash of the certificate. |
| [SSLCertThumbprintSHA256](#sslcertthumbprintsha256-property-ipworks_dtlsclient-class) | The SHA-256 hash of the certificate. |
| [SSLCertUsage](#sslcertusage-property-ipworks_dtlsclient-class) | The text description of UsageFlags . |
| [SSLCertUsageFlags](#sslcertusageflags-property-ipworks_dtlsclient-class) | The flags that show intended use for the certificate. |
| [SSLCertVersion](#sslcertversion-property-ipworks_dtlsclient-class) | The certificate's version number. |
| [SSLCertSubject](#sslcertsubject-property-ipworks_dtlsclient-class) | The subject of the certificate used for client authentication. |
| [SSLCertEncoded](#sslcertencoded-property-ipworks_dtlsclient-class) | The certificate (PEM/Base64 encoded). |
| [SSLServerCertEffectiveDate](#sslservercerteffectivedate-property-ipworks_dtlsclient-class) | The date on which this certificate becomes valid. |
| [SSLServerCertExpirationDate](#sslservercertexpirationdate-property-ipworks_dtlsclient-class) | The date on which the certificate expires. |
| [SSLServerCertExtendedKeyUsage](#sslservercertextendedkeyusage-property-ipworks_dtlsclient-class) | A comma-delimited list of extended key usage identifiers. |
| [SSLServerCertFingerprint](#sslservercertfingerprint-property-ipworks_dtlsclient-class) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [SSLServerCertFingerprintSHA1](#sslservercertfingerprintsha1-property-ipworks_dtlsclient-class) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [SSLServerCertFingerprintSHA256](#sslservercertfingerprintsha256-property-ipworks_dtlsclient-class) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [SSLServerCertIssuer](#sslservercertissuer-property-ipworks_dtlsclient-class) | The issuer of the certificate. |
| [SSLServerCertPrivateKey](#sslservercertprivatekey-property-ipworks_dtlsclient-class) | The private key of the certificate (if available). |
| [SSLServerCertPrivateKeyAvailable](#sslservercertprivatekeyavailable-property-ipworks_dtlsclient-class) | Whether a PrivateKey is available for the selected certificate. |
| [SSLServerCertPrivateKeyContainer](#sslservercertprivatekeycontainer-property-ipworks_dtlsclient-class) | The name of the PrivateKey container for the certificate (if available). |
| [SSLServerCertPublicKey](#sslservercertpublickey-property-ipworks_dtlsclient-class) | The public key of the certificate. |
| [SSLServerCertPublicKeyAlgorithm](#sslservercertpublickeyalgorithm-property-ipworks_dtlsclient-class) | The textual description of the certificate's public key algorithm. |
| [SSLServerCertPublicKeyLength](#sslservercertpublickeylength-property-ipworks_dtlsclient-class) | The length of the certificate's public key (in bits). |
| [SSLServerCertSerialNumber](#sslservercertserialnumber-property-ipworks_dtlsclient-class) | The serial number of the certificate encoded as a string. |
| [SSLServerCertSignatureAlgorithm](#sslservercertsignaturealgorithm-property-ipworks_dtlsclient-class) | The text description of the certificate's signature algorithm. |
| [SSLServerCertStore](#sslservercertstore-property-ipworks_dtlsclient-class) | The name of the certificate store for the client certificate. |
| [SSLServerCertStorePassword](#sslservercertstorepassword-property-ipworks_dtlsclient-class) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [SSLServerCertStoreType](#sslservercertstoretype-property-ipworks_dtlsclient-class) | The type of certificate store for this certificate. |
| [SSLServerCertSubjectAltNames](#sslservercertsubjectaltnames-property-ipworks_dtlsclient-class) | Comma-separated lists of alternative subject names for the certificate. |
| [SSLServerCertThumbprintMD5](#sslservercertthumbprintmd5-property-ipworks_dtlsclient-class) | The MD5 hash of the certificate. |
| [SSLServerCertThumbprintSHA1](#sslservercertthumbprintsha1-property-ipworks_dtlsclient-class) | The SHA-1 hash of the certificate. |
| [SSLServerCertThumbprintSHA256](#sslservercertthumbprintsha256-property-ipworks_dtlsclient-class) | The SHA-256 hash of the certificate. |
| [SSLServerCertUsage](#sslservercertusage-property-ipworks_dtlsclient-class) | The text description of UsageFlags . |
| [SSLServerCertUsageFlags](#sslservercertusageflags-property-ipworks_dtlsclient-class) | The flags that show intended use for the certificate. |
| [SSLServerCertVersion](#sslservercertversion-property-ipworks_dtlsclient-class) | The certificate's version number. |
| [SSLServerCertSubject](#sslservercertsubject-property-ipworks_dtlsclient-class) | The subject of the certificate used for client authentication. |
| [SSLServerCertEncoded](#sslservercertencoded-property-ipworks_dtlsclient-class) | The certificate (PEM/Base64 encoded). |
| [Timeout](#timeout-property-ipworks_dtlsclient-class) | This property specifies a timeout when connecting to a server. |

## Method List

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

|  |  |
| --- | --- |
| [Config](#config-method-ipworks_dtlsclient-class) | Sets or retrieves a configuration setting. |
| [Connect](#connect-method-ipworks_dtlsclient-class) | This method connects to a remote host. |
| [Disconnect](#disconnect-method-ipworks_dtlsclient-class) | This method disconnects from the remote host. |
| [DoEvents](#doevents-method-ipworks_dtlsclient-class) | This method processes events from the internal message queue. |
| [PauseData](#pausedata-method-ipworks_dtlsclient-class) | This method pauses data reception. |
| [ProcessData](#processdata-method-ipworks_dtlsclient-class) | This method reenables data reception after a call to PauseData . |
| [Reset](#reset-method-ipworks_dtlsclient-class) | This method will reset the class. |
| [SendBytes](#sendbytes-method-ipworks_dtlsclient-class) | This method sends binary data to the remote host. |
| [SendText](#sendtext-method-ipworks_dtlsclient-class) | This method sends text to the remote host. |

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

|  |  |
| --- | --- |
| [Connected](#connected-event-ipworks_dtlsclient-class) | This event is fired immediately after a connection completes (or fails). |
| [DataIn](#datain-event-ipworks_dtlsclient-class) | This event is fired when data are received. |
| [Disconnected](#disconnected-event-ipworks_dtlsclient-class) | This event is fired when a connection is closed. |
| [Error](#error-event-ipworks_dtlsclient-class) | Fired when information is available about errors during data delivery. |
| [Log](#log-event-ipworks_dtlsclient-class) | This event fires once for each log message. |
| [SSLServerAuthentication](#sslserverauthentication-event-ipworks_dtlsclient-class) | This event is fired after the server presents its certificate to the client. |
| [SSLStatus](#sslstatus-event-ipworks_dtlsclient-class) | Fired when secure connection progress messages are available. |

## Config Settings

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

|  |  |
| --- | --- |
| [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in seconds, to be used when a HeartbeatRequest is sent and no response is received. |
| [KeepAliveMode](#KeepAliveMode) | Specifies the Heartbeat (or keep-alive) mode to be used by the class. |
| [KeepAliveTime](#KeepAliveTime) | The inactivity time, in seconds, before a HeartbeatRequest is sent. |
| [LogLevel](#LogLevel) | This configuration controls the level of detail that is logged through the Log event. |
| [CaptureIPPacketInfo](#CaptureIPPacketInfo) | Used to capture the packet information. |
| [DelayHostResolution](#DelayHostResolution) | Whether the hostname is resolved when RemoteHost is set. |
| [DestinationAddress](#DestinationAddress) | Used to get the destination address from the packet information. |
| [DontFragment](#DontFragment) | Used to set the Don't Fragment flag of outgoing packets. |
| [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. |
| [LocalPort](#LocalPort) | The port in the local host where the class binds. |
| [MaxPacketSize](#MaxPacketSize) | The maximum length of the packets that can be received. |
| [QOSDSCPValue](#QOSDSCPValue) | Used to specify an arbitrary QOS/DSCP setting (optional). |
| [QOSTrafficType](#QOSTrafficType) | Used to specify QOS/DSCP settings (optional). |
| [ShareLocalPort](#ShareLocalPort) | If set to True, allows more than one instance of the class to be active on the same local port. |
| [SourceIPAddress](#SourceIPAddress) | Used to set the source IP address used when sending a packet. |
| [SourceMacAddress](#SourceMacAddress) | Used to set the source MAC address used when sending a packet. |
| [UseConnection](#UseConnection) | Determines whether to use a connected socket. |
| [UseIPv6](#UseIPv6) | Whether or not to use IPv6. |
| [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| [FirewallData](#FirewallData) | Used to send extra data to the firewall. |
| [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. |
| [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. |
| [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged. |
| [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. |
| [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. |
| [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. |
| [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. |
| [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. |
| [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. |
| [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | Specifies the cipher suites to be used during TLS negotiation. |
| [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. |
| [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. |
| [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. |
| [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. |
| [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. |
| [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. |
| [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. |
| [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. |
| [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. |
| [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. |
| [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. |
| [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
| [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [ProcessIdleEvents](#ProcessIdleEvents) | Whether the class uses its internal event loop to process events when the main thread is idle. |
| [SelectWaitMillis](#SelectWaitMillis) | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# AcceptData Property ([IPWorks_DTLSClient](#dtlsclient-class) Class)

This property indicates whether data reception is currently enabled.

## Object Oriented Interface

```text
public function getAcceptData();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 1 );
```

## Default Value

true

## Remarks

This property indicates whether data reception is currently enabled. When *false*, data reception is disabled and the [DataIn](#datain-event-ipworks_dtlsclient-class) event will not fire. Use the [PauseData](#pausedata-method-ipworks_dtlsclient-class) and [ProcessData](#processdata-method-ipworks_dtlsclient-class) methods to pause and resume data reception.

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

## Data Type

Boolean

# Connected Property ([IPWorks_DTLSClient](#dtlsclient-class) Class)

This property indicates whether the class is connected.

## Object Oriented Interface

```text
public function getConnected();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 2 );
```

## Default Value

false

## Remarks

This property indicates whether the class is connected to the remote host. Use the [Connect](#connect-method-ipworks_dtlsclient-class) and [Disconnect](#disconnect-method-ipworks_dtlsclient-class) methods to manage the connection.

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

## Data Type

Boolean

# KeepAlive Property ([IPWorks_DTLSClient](#dtlsclient-class) Class)

When True, keep-alive functionality is enabled via the DTLS Heartbeat Extension.

## Object Oriented Interface

```text
public function getKeepAlive();
public function setKeepAlive($value);
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 3 );
ipworks_dtlsclient_set($res, 3, $value );
```

## Default Value

false

## Remarks

This property enables keep-alive functionality for the established connection via the DTLS Heartbeat Extension (RFC 6520). Enabling this option can prevent a long connection from timing out in case of inactivity.

NOTE: For this functionality to work as intended, [DoEvents](#doevents-method-ipworks_dtlsclient-class) must be called frequently in **both** console and form-based applications (e.g., using a loop or timer).

Additionally, DTLS server implementations are not required to support Heartbeats.

## Data Type

Boolean

# LocalHost Property ([IPWorks_DTLSClient](#dtlsclient-class) Class)

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

## Object Oriented Interface

```text
public function getLocalHost();
public function setLocalHost($value);
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 4 );
ipworks_dtlsclient_set($res, 4, $value );
```

## Default Value

''

## Remarks

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

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

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

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

## Data Type

String

# LocalPort Property ([IPWorks_DTLSClient](#dtlsclient-class) Class)

This property includes the User Datagram Protocol (UDP) port in the local host where the class binds.

## Object Oriented Interface

```text
public function getLocalPort();
public function setLocalPort($value);
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 5 );
ipworks_dtlsclient_set($res, 5, $value );
```

## Default Value

0

## Remarks

The LocalPort property must be set before the class is activated ([Connect](#connect-method-ipworks_dtlsclient-class) is called). This 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 [Connected](#connected-property-ipworks_dtlsclient-class). Any attempt to set the LocalPort property when the class is [Connected](#connected-property-ipworks_dtlsclient-class) will generate an error.

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

## Data Type

Integer

# RemoteHost Property ([IPWorks_DTLSClient](#dtlsclient-class) Class)

This property includes the address of the remote host. Domain names are resolved to IP addresses.

## Object Oriented Interface

```text
public function getRemoteHost();
public function setRemoteHost($value);
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 6 );
ipworks_dtlsclient_set($res, 6, $value );
```

## Default Value

''

## Remarks

The RemoteHost property specifies the IP address (IP number in dotted internet format) or domain name of the remote host.

If RemoteHost is set to 255.255.255.255, the class broadcasts data on the local subnet.

If the RemoteHost property is set to a domain name, a DNS request is initiated, and upon successful termination of the request, the RemoteHost property is set to the corresponding address. If the search is not successful, an error is returned.

If [UseConnection](#UseConnection) is set to True, the RemoteHost must be set before the class is activated ([Connect](#connect-method-ipworks_dtlsclient-class) is called).

## Data Type

String

# RemotePort Property ([IPWorks_DTLSClient](#dtlsclient-class) Class)

This property specifies the User Datagram Protocol (UDP) port in the remote host.

## Object Oriented Interface

```text
public function getRemotePort();
public function setRemotePort($value);
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 7 );
ipworks_dtlsclient_set($res, 7, $value );
```

## Default Value

0

## Remarks

The RemotePort is the UDP port on the [RemoteHost](#remotehost-property-ipworks_dtlsclient-class) to send UDP datagrams to.

A valid port number (a value between 1 and 65535) is required.

If [UseConnection](#UseConnection) is set to True, the RemotePort must be set before the class is activated ([Connect](#connect-method-ipworks_dtlsclient-class) is called).

## Data Type

Integer

# SSLAcceptServerCertEffectiveDate Property ([IPWorks_DTLSClient](#dtlsclient-class) Class)

The date on which this certificate becomes valid.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertEffectiveDate();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 8 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The date on which the certificate expires.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertExpirationDate();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 9 );
```

## Default Value

''

## Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

## Data Type

String

# SSLAcceptServerCertExtendedKeyUsage Property ([IPWorks_DTLSClient](#dtlsclient-class) Class)

A comma-delimited list of extended key usage identifiers.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertExtendedKeyUsage();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 10 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

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

## Object Oriented Interface

```text
public function getSSLAcceptServerCertFingerprint();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 11 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

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

## Object Oriented Interface

```text
public function getSSLAcceptServerCertFingerprintSHA1();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 12 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

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

## Object Oriented Interface

```text
public function getSSLAcceptServerCertFingerprintSHA256();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 13 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The issuer of the certificate.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertIssuer();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 14 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The private key of the certificate (if available).

## Object Oriented Interface

```text
public function getSSLAcceptServerCertPrivateKey();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 15 );
```

## Default Value

''

## Remarks

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

NOTE: The [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-ipworks_dtlsclient-class) may be available but not exportable. In this case, [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-ipworks_dtlsclient-class) returns an empty string.

This property is read-only.

## Data Type

String

# SSLAcceptServerCertPrivateKeyAvailable Property ([IPWorks_DTLSClient](#dtlsclient-class) Class)

Whether a PrivateKey is available for the selected certificate.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertPrivateKeyAvailable();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 16 );
```

## Default Value

false

## Remarks

Whether a [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-ipworks_dtlsclient-class) is available for the selected certificate. If [SSLAcceptServerCertPrivateKeyAvailable](#sslacceptservercertprivatekeyavailable-property-ipworks_dtlsclient-class) 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_DTLSClient](#dtlsclient-class) Class)

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

## Object Oriented Interface

```text
public function getSSLAcceptServerCertPrivateKeyContainer();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 17 );
```

## Default Value

''

## Remarks

The name of the [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-ipworks_dtlsclient-class) 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_DTLSClient](#dtlsclient-class) Class)

The public key of the certificate.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertPublicKey();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 18 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The textual description of the certificate's public key algorithm.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertPublicKeyAlgorithm();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 19 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

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

## Object Oriented Interface

```text
public function getSSLAcceptServerCertPublicKeyLength();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 20 );
```

## Default Value

0

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The serial number of the certificate encoded as a string.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertSerialNumber();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 21 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The text description of the certificate's signature algorithm.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertSignatureAlgorithm();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 22 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The name of the certificate store for the client certificate.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 23 );
ipworks_dtlsclient_set($res, 23, $value );
```

## Default Value

'MY'

## Remarks

The name of the certificate store for the client certificate.

The [SSLAcceptServerCertStoreType](#sslacceptservercertstoretype-property-ipworks_dtlsclient-class) property denotes the type of the certificate store specified by [SSLAcceptServerCertStore](#sslacceptservercertstore-property-ipworks_dtlsclient-class). If the store is password-protected, specify the password in [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-ipworks_dtlsclient-class).

[SSLAcceptServerCertStore](#sslacceptservercertstore-property-ipworks_dtlsclient-class) is used in conjunction with the [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-ipworks_dtlsclient-class) property to specify client certificates. If [SSLAcceptServerCertStore](#sslacceptservercertstore-property-ipworks_dtlsclient-class) has a value, and [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-ipworks_dtlsclient-class) or [SSLAcceptServerCertEncoded](#sslacceptservercertencoded-property-ipworks_dtlsclient-class) is set, a search for a certificate is initiated. Please see the [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-ipworks_dtlsclient-class) property for details.

 Designations of certificate stores are platform dependent.

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

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

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

## Data Type

Binary String

# SSLAcceptServerCertStorePassword Property ([IPWorks_DTLSClient](#dtlsclient-class) 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

```text
public function getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 24 );
ipworks_dtlsclient_set($res, 24, $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_DTLSClient](#dtlsclient-class) Class)

The type of certificate store for this certificate.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 25 );
ipworks_dtlsclient_set($res, 25, $value );
```

## Possible Values

```text
DTLSCLIENT_SSLACCEPTSERVERCERTSTORETYPE_USER(0), DTLSCLIENT_SSLACCEPTSERVERCERTSTORETYPE_MACHINE(1), DTLSCLIENT_SSLACCEPTSERVERCERTSTORETYPE_PFXFILE(2), DTLSCLIENT_SSLACCEPTSERVERCERTSTORETYPE_PFXBLOB(3), DTLSCLIENT_SSLACCEPTSERVERCERTSTORETYPE_JKSFILE(4), DTLSCLIENT_SSLACCEPTSERVERCERTSTORETYPE_JKSBLOB(5), DTLSCLIENT_SSLACCEPTSERVERCERTSTORETYPE_PEMKEY_FILE(6), DTLSCLIENT_SSLACCEPTSERVERCERTSTORETYPE_PEMKEY_BLOB(7), DTLSCLIENT_SSLACCEPTSERVERCERTSTORETYPE_PUBLIC_KEY_FILE(8), DTLSCLIENT_SSLACCEPTSERVERCERTSTORETYPE_PUBLIC_KEY_BLOB(9), DTLSCLIENT_SSLACCEPTSERVERCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), DTLSCLIENT_SSLACCEPTSERVERCERTSTORETYPE_P7BFILE(11), DTLSCLIENT_SSLACCEPTSERVERCERTSTORETYPE_P7BBLOB(12), DTLSCLIENT_SSLACCEPTSERVERCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), DTLSCLIENT_SSLACCEPTSERVERCERTSTORETYPE_PPKFILE(14), DTLSCLIENT_SSLACCEPTSERVERCERTSTORETYPE_PPKBLOB(15), DTLSCLIENT_SSLACCEPTSERVERCERTSTORETYPE_XMLFILE(16), DTLSCLIENT_SSLACCEPTSERVERCERTSTORETYPE_XMLBLOB(17), DTLSCLIENT_SSLACCEPTSERVERCERTSTORETYPE_JWKFILE(18), DTLSCLIENT_SSLACCEPTSERVERCERTSTORETYPE_JWKBLOB(19), DTLSCLIENT_SSLACCEPTSERVERCERTSTORETYPE_SECURITY_KEY(20), DTLSCLIENT_SSLACCEPTSERVERCERTSTORETYPE_BCFKSFILE(21), DTLSCLIENT_SSLACCEPTSERVERCERTSTORETYPE_BCFKSBLOB(22), DTLSCLIENT_SSLACCEPTSERVERCERTSTORETYPE_PKCS11(23), DTLSCLIENT_SSLACCEPTSERVERCERTSTORETYPE_AUTO(99)
```

## Default Value

0

## Remarks

The type of certificate store for this certificate.

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

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

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

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

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

## Data Type

Integer

# SSLAcceptServerCertSubjectAltNames Property ([IPWorks_DTLSClient](#dtlsclient-class) Class)

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

## Object Oriented Interface

```text
public function getSSLAcceptServerCertSubjectAltNames();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 26 );
```

## Default Value

''

## Remarks

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

This property is read-only.

## Data Type

String

# SSLAcceptServerCertThumbprintMD5 Property ([IPWorks_DTLSClient](#dtlsclient-class) Class)

The MD5 hash of the certificate.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertThumbprintMD5();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 27 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The SHA-1 hash of the certificate.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertThumbprintSHA1();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 28 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The SHA-256 hash of the certificate.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertThumbprintSHA256();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 29 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The text description of UsageFlags .

## Object Oriented Interface

```text
public function getSSLAcceptServerCertUsage();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 30 );
```

## Default Value

''

## Remarks

The text description of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-ipworks_dtlsclient-class).

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

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

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

This property is read-only.

## Data Type

String

# SSLAcceptServerCertUsageFlags Property ([IPWorks_DTLSClient](#dtlsclient-class) Class)

The flags that show intended use for the certificate.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertUsageFlags();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 31 );
```

## Default Value

0

## Remarks

The flags that show intended use for the certificate. The value of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-ipworks_dtlsclient-class) is a combination of the following flags:

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

Please see the [SSLAcceptServerCertUsage](#sslacceptservercertusage-property-ipworks_dtlsclient-class) property for a text representation of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-ipworks_dtlsclient-class).

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

This property is read-only.

## Data Type

Integer

# SSLAcceptServerCertVersion Property ([IPWorks_DTLSClient](#dtlsclient-class) Class)

The certificate's version number.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertVersion();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 32 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The subject of the certificate used for client authentication.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 33 );
ipworks_dtlsclient_set($res, 33, $value );
```

## Default Value

''

## Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

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

## Data Type

String

# SSLAcceptServerCertEncoded Property ([IPWorks_DTLSClient](#dtlsclient-class) Class)

The certificate (PEM/Base64 encoded).

## Object Oriented Interface

```text
public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 34 );
ipworks_dtlsclient_set($res, 34, $value );
```

## Default Value

''

## Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLAcceptServerCertStore](#sslacceptservercertstore-property-ipworks_dtlsclient-class) and [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-ipworks_dtlsclient-class) properties also may be used to specify a certificate.

When [SSLAcceptServerCertEncoded](#sslacceptservercertencoded-property-ipworks_dtlsclient-class) is set, a search is initiated in the current [SSLAcceptServerCertStore](#sslacceptservercertstore-property-ipworks_dtlsclient-class) for the private key of the certificate. If the key is found, [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-ipworks_dtlsclient-class) is updated to reflect the full subject of the selected certificate; otherwise, [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-ipworks_dtlsclient-class) is set to an empty string.

This property is not available at design time.

## Data Type

Binary String

# SSLCertEffectiveDate Property ([IPWorks_DTLSClient](#dtlsclient-class) Class)

The date on which this certificate becomes valid.

## Object Oriented Interface

```text
public function getSSLCertEffectiveDate();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 35 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The date on which the certificate expires.

## Object Oriented Interface

```text
public function getSSLCertExpirationDate();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 36 );
```

## Default Value

''

## Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

## Data Type

String

# SSLCertExtendedKeyUsage Property ([IPWorks_DTLSClient](#dtlsclient-class) Class)

A comma-delimited list of extended key usage identifiers.

## Object Oriented Interface

```text
public function getSSLCertExtendedKeyUsage();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 37 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

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

## Object Oriented Interface

```text
public function getSSLCertFingerprint();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 38 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

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

## Object Oriented Interface

```text
public function getSSLCertFingerprintSHA1();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 39 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

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

## Object Oriented Interface

```text
public function getSSLCertFingerprintSHA256();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 40 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The issuer of the certificate.

## Object Oriented Interface

```text
public function getSSLCertIssuer();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 41 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The private key of the certificate (if available).

## Object Oriented Interface

```text
public function getSSLCertPrivateKey();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 42 );
```

## Default Value

''

## Remarks

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

NOTE: The [SSLCertPrivateKey](#sslcertprivatekey-property-ipworks_dtlsclient-class) may be available but not exportable. In this case, [SSLCertPrivateKey](#sslcertprivatekey-property-ipworks_dtlsclient-class) returns an empty string.

This property is read-only.

## Data Type

String

# SSLCertPrivateKeyAvailable Property ([IPWorks_DTLSClient](#dtlsclient-class) Class)

Whether a PrivateKey is available for the selected certificate.

## Object Oriented Interface

```text
public function getSSLCertPrivateKeyAvailable();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 43 );
```

## Default Value

false

## Remarks

Whether a [SSLCertPrivateKey](#sslcertprivatekey-property-ipworks_dtlsclient-class) is available for the selected certificate. If [SSLCertPrivateKeyAvailable](#sslcertprivatekeyavailable-property-ipworks_dtlsclient-class) 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_DTLSClient](#dtlsclient-class) Class)

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

## Object Oriented Interface

```text
public function getSSLCertPrivateKeyContainer();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 44 );
```

## Default Value

''

## Remarks

The name of the [SSLCertPrivateKey](#sslcertprivatekey-property-ipworks_dtlsclient-class) 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_DTLSClient](#dtlsclient-class) Class)

The public key of the certificate.

## Object Oriented Interface

```text
public function getSSLCertPublicKey();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 45 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The textual description of the certificate's public key algorithm.

## Object Oriented Interface

```text
public function getSSLCertPublicKeyAlgorithm();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 46 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

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

## Object Oriented Interface

```text
public function getSSLCertPublicKeyLength();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 47 );
```

## Default Value

0

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The serial number of the certificate encoded as a string.

## Object Oriented Interface

```text
public function getSSLCertSerialNumber();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 48 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The text description of the certificate's signature algorithm.

## Object Oriented Interface

```text
public function getSSLCertSignatureAlgorithm();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 49 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The name of the certificate store for the client certificate.

## Object Oriented Interface

```text
public function getSSLCertStore();
public function setSSLCertStore($value);
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 50 );
ipworks_dtlsclient_set($res, 50, $value );
```

## Default Value

'MY'

## Remarks

The name of the certificate store for the client certificate.

The [SSLCertStoreType](#sslcertstoretype-property-ipworks_dtlsclient-class) property denotes the type of the certificate store specified by [SSLCertStore](#sslcertstore-property-ipworks_dtlsclient-class). If the store is password-protected, specify the password in [SSLCertStorePassword](#sslcertstorepassword-property-ipworks_dtlsclient-class).

[SSLCertStore](#sslcertstore-property-ipworks_dtlsclient-class) is used in conjunction with the [SSLCertSubject](#sslcertsubject-property-ipworks_dtlsclient-class) property to specify client certificates. If [SSLCertStore](#sslcertstore-property-ipworks_dtlsclient-class) has a value, and [SSLCertSubject](#sslcertsubject-property-ipworks_dtlsclient-class) or [SSLCertEncoded](#sslcertencoded-property-ipworks_dtlsclient-class) is set, a search for a certificate is initiated. Please see the [SSLCertSubject](#sslcertsubject-property-ipworks_dtlsclient-class) property for details.

 Designations of certificate stores are platform dependent.

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

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

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

## Data Type

Binary String

# SSLCertStorePassword Property ([IPWorks_DTLSClient](#dtlsclient-class) 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

```text
public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 51 );
ipworks_dtlsclient_set($res, 51, $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_DTLSClient](#dtlsclient-class) Class)

The type of certificate store for this certificate.

## Object Oriented Interface

```text
public function getSSLCertStoreType();
public function setSSLCertStoreType($value);
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 52 );
ipworks_dtlsclient_set($res, 52, $value );
```

## Possible Values

```text
DTLSCLIENT_SSLCERTSTORETYPE_USER(0), DTLSCLIENT_SSLCERTSTORETYPE_MACHINE(1), DTLSCLIENT_SSLCERTSTORETYPE_PFXFILE(2), DTLSCLIENT_SSLCERTSTORETYPE_PFXBLOB(3), DTLSCLIENT_SSLCERTSTORETYPE_JKSFILE(4), DTLSCLIENT_SSLCERTSTORETYPE_JKSBLOB(5), DTLSCLIENT_SSLCERTSTORETYPE_PEMKEY_FILE(6), DTLSCLIENT_SSLCERTSTORETYPE_PEMKEY_BLOB(7), DTLSCLIENT_SSLCERTSTORETYPE_PUBLIC_KEY_FILE(8), DTLSCLIENT_SSLCERTSTORETYPE_PUBLIC_KEY_BLOB(9), DTLSCLIENT_SSLCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), DTLSCLIENT_SSLCERTSTORETYPE_P7BFILE(11), DTLSCLIENT_SSLCERTSTORETYPE_P7BBLOB(12), DTLSCLIENT_SSLCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), DTLSCLIENT_SSLCERTSTORETYPE_PPKFILE(14), DTLSCLIENT_SSLCERTSTORETYPE_PPKBLOB(15), DTLSCLIENT_SSLCERTSTORETYPE_XMLFILE(16), DTLSCLIENT_SSLCERTSTORETYPE_XMLBLOB(17), DTLSCLIENT_SSLCERTSTORETYPE_JWKFILE(18), DTLSCLIENT_SSLCERTSTORETYPE_JWKBLOB(19), DTLSCLIENT_SSLCERTSTORETYPE_SECURITY_KEY(20), DTLSCLIENT_SSLCERTSTORETYPE_BCFKSFILE(21), DTLSCLIENT_SSLCERTSTORETYPE_BCFKSBLOB(22), DTLSCLIENT_SSLCERTSTORETYPE_PKCS11(23), DTLSCLIENT_SSLCERTSTORETYPE_AUTO(99)
```

## Default Value

0

## Remarks

The type of certificate store for this certificate.

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

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

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

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

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

## Data Type

Integer

# SSLCertSubjectAltNames Property ([IPWorks_DTLSClient](#dtlsclient-class) Class)

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

## Object Oriented Interface

```text
public function getSSLCertSubjectAltNames();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 53 );
```

## Default Value

''

## Remarks

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

This property is read-only.

## Data Type

String

# SSLCertThumbprintMD5 Property ([IPWorks_DTLSClient](#dtlsclient-class) Class)

The MD5 hash of the certificate.

## Object Oriented Interface

```text
public function getSSLCertThumbprintMD5();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 54 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The SHA-1 hash of the certificate.

## Object Oriented Interface

```text
public function getSSLCertThumbprintSHA1();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 55 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The SHA-256 hash of the certificate.

## Object Oriented Interface

```text
public function getSSLCertThumbprintSHA256();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 56 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The text description of UsageFlags .

## Object Oriented Interface

```text
public function getSSLCertUsage();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 57 );
```

## Default Value

''

## Remarks

The text description of [SSLCertUsageFlags](#sslcertusageflags-property-ipworks_dtlsclient-class).

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

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

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

This property is read-only.

## Data Type

String

# SSLCertUsageFlags Property ([IPWorks_DTLSClient](#dtlsclient-class) Class)

The flags that show intended use for the certificate.

## Object Oriented Interface

```text
public function getSSLCertUsageFlags();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 58 );
```

## Default Value

0

## Remarks

The flags that show intended use for the certificate. The value of [SSLCertUsageFlags](#sslcertusageflags-property-ipworks_dtlsclient-class) is a combination of the following flags:

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

Please see the [SSLCertUsage](#sslcertusage-property-ipworks_dtlsclient-class) property for a text representation of [SSLCertUsageFlags](#sslcertusageflags-property-ipworks_dtlsclient-class).

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

This property is read-only.

## Data Type

Integer

# SSLCertVersion Property ([IPWorks_DTLSClient](#dtlsclient-class) Class)

The certificate's version number.

## Object Oriented Interface

```text
public function getSSLCertVersion();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 59 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The subject of the certificate used for client authentication.

## Object Oriented Interface

```text
public function getSSLCertSubject();
public function setSSLCertSubject($value);
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 60 );
ipworks_dtlsclient_set($res, 60, $value );
```

## Default Value

''

## Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

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

## Data Type

String

# SSLCertEncoded Property ([IPWorks_DTLSClient](#dtlsclient-class) Class)

The certificate (PEM/Base64 encoded).

## Object Oriented Interface

```text
public function getSSLCertEncoded();
public function setSSLCertEncoded($value);
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 61 );
ipworks_dtlsclient_set($res, 61, $value );
```

## Default Value

''

## Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLCertStore](#sslcertstore-property-ipworks_dtlsclient-class) and [SSLCertSubject](#sslcertsubject-property-ipworks_dtlsclient-class) properties also may be used to specify a certificate.

When [SSLCertEncoded](#sslcertencoded-property-ipworks_dtlsclient-class) is set, a search is initiated in the current [SSLCertStore](#sslcertstore-property-ipworks_dtlsclient-class) for the private key of the certificate. If the key is found, [SSLCertSubject](#sslcertsubject-property-ipworks_dtlsclient-class) is updated to reflect the full subject of the selected certificate; otherwise, [SSLCertSubject](#sslcertsubject-property-ipworks_dtlsclient-class) is set to an empty string.

This property is not available at design time.

## Data Type

Binary String

# SSLServerCertEffectiveDate Property ([IPWorks_DTLSClient](#dtlsclient-class) Class)

The date on which this certificate becomes valid.

## Object Oriented Interface

```text
public function getSSLServerCertEffectiveDate();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 62 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The date on which the certificate expires.

## Object Oriented Interface

```text
public function getSSLServerCertExpirationDate();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 63 );
```

## Default Value

''

## Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

## Data Type

String

# SSLServerCertExtendedKeyUsage Property ([IPWorks_DTLSClient](#dtlsclient-class) Class)

A comma-delimited list of extended key usage identifiers.

## Object Oriented Interface

```text
public function getSSLServerCertExtendedKeyUsage();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 64 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

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

## Object Oriented Interface

```text
public function getSSLServerCertFingerprint();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 65 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

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

## Object Oriented Interface

```text
public function getSSLServerCertFingerprintSHA1();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 66 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

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

## Object Oriented Interface

```text
public function getSSLServerCertFingerprintSHA256();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 67 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The issuer of the certificate.

## Object Oriented Interface

```text
public function getSSLServerCertIssuer();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 68 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The private key of the certificate (if available).

## Object Oriented Interface

```text
public function getSSLServerCertPrivateKey();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 69 );
```

## Default Value

''

## Remarks

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

NOTE: The [SSLServerCertPrivateKey](#sslservercertprivatekey-property-ipworks_dtlsclient-class) may be available but not exportable. In this case, [SSLServerCertPrivateKey](#sslservercertprivatekey-property-ipworks_dtlsclient-class) returns an empty string.

This property is read-only.

## Data Type

String

# SSLServerCertPrivateKeyAvailable Property ([IPWorks_DTLSClient](#dtlsclient-class) Class)

Whether a PrivateKey is available for the selected certificate.

## Object Oriented Interface

```text
public function getSSLServerCertPrivateKeyAvailable();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 70 );
```

## Default Value

false

## Remarks

Whether a [SSLServerCertPrivateKey](#sslservercertprivatekey-property-ipworks_dtlsclient-class) is available for the selected certificate. If [SSLServerCertPrivateKeyAvailable](#sslservercertprivatekeyavailable-property-ipworks_dtlsclient-class) 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_DTLSClient](#dtlsclient-class) Class)

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

## Object Oriented Interface

```text
public function getSSLServerCertPrivateKeyContainer();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 71 );
```

## Default Value

''

## Remarks

The name of the [SSLServerCertPrivateKey](#sslservercertprivatekey-property-ipworks_dtlsclient-class) 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_DTLSClient](#dtlsclient-class) Class)

The public key of the certificate.

## Object Oriented Interface

```text
public function getSSLServerCertPublicKey();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 72 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The textual description of the certificate's public key algorithm.

## Object Oriented Interface

```text
public function getSSLServerCertPublicKeyAlgorithm();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 73 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

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

## Object Oriented Interface

```text
public function getSSLServerCertPublicKeyLength();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 74 );
```

## Default Value

0

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The serial number of the certificate encoded as a string.

## Object Oriented Interface

```text
public function getSSLServerCertSerialNumber();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 75 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The text description of the certificate's signature algorithm.

## Object Oriented Interface

```text
public function getSSLServerCertSignatureAlgorithm();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 76 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The name of the certificate store for the client certificate.

## Object Oriented Interface

```text
public function getSSLServerCertStore();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 77 );
```

## Default Value

'MY'

## Remarks

The name of the certificate store for the client certificate.

The [SSLServerCertStoreType](#sslservercertstoretype-property-ipworks_dtlsclient-class) property denotes the type of the certificate store specified by [SSLServerCertStore](#sslservercertstore-property-ipworks_dtlsclient-class). If the store is password-protected, specify the password in [SSLServerCertStorePassword](#sslservercertstorepassword-property-ipworks_dtlsclient-class).

[SSLServerCertStore](#sslservercertstore-property-ipworks_dtlsclient-class) is used in conjunction with the [SSLServerCertSubject](#sslservercertsubject-property-ipworks_dtlsclient-class) property to specify client certificates. If [SSLServerCertStore](#sslservercertstore-property-ipworks_dtlsclient-class) has a value, and [SSLServerCertSubject](#sslservercertsubject-property-ipworks_dtlsclient-class) or [SSLServerCertEncoded](#sslservercertencoded-property-ipworks_dtlsclient-class) is set, a search for a certificate is initiated. Please see the [SSLServerCertSubject](#sslservercertsubject-property-ipworks_dtlsclient-class) property for details.

 Designations of certificate stores are platform dependent.

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

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

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

This property is read-only.

## Data Type

Binary String

# SSLServerCertStorePassword Property ([IPWorks_DTLSClient](#dtlsclient-class) 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

```text
public function getSSLServerCertStorePassword();
```

## Procedural Interface

```text
ipworks_dtlsclient_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_DTLSClient](#dtlsclient-class) Class)

The type of certificate store for this certificate.

## Object Oriented Interface

```text
public function getSSLServerCertStoreType();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 79 );
```

## Possible Values

```text
DTLSCLIENT_SSLSERVERCERTSTORETYPE_USER(0), DTLSCLIENT_SSLSERVERCERTSTORETYPE_MACHINE(1), DTLSCLIENT_SSLSERVERCERTSTORETYPE_PFXFILE(2), DTLSCLIENT_SSLSERVERCERTSTORETYPE_PFXBLOB(3), DTLSCLIENT_SSLSERVERCERTSTORETYPE_JKSFILE(4), DTLSCLIENT_SSLSERVERCERTSTORETYPE_JKSBLOB(5), DTLSCLIENT_SSLSERVERCERTSTORETYPE_PEMKEY_FILE(6), DTLSCLIENT_SSLSERVERCERTSTORETYPE_PEMKEY_BLOB(7), DTLSCLIENT_SSLSERVERCERTSTORETYPE_PUBLIC_KEY_FILE(8), DTLSCLIENT_SSLSERVERCERTSTORETYPE_PUBLIC_KEY_BLOB(9), DTLSCLIENT_SSLSERVERCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), DTLSCLIENT_SSLSERVERCERTSTORETYPE_P7BFILE(11), DTLSCLIENT_SSLSERVERCERTSTORETYPE_P7BBLOB(12), DTLSCLIENT_SSLSERVERCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), DTLSCLIENT_SSLSERVERCERTSTORETYPE_PPKFILE(14), DTLSCLIENT_SSLSERVERCERTSTORETYPE_PPKBLOB(15), DTLSCLIENT_SSLSERVERCERTSTORETYPE_XMLFILE(16), DTLSCLIENT_SSLSERVERCERTSTORETYPE_XMLBLOB(17), DTLSCLIENT_SSLSERVERCERTSTORETYPE_JWKFILE(18), DTLSCLIENT_SSLSERVERCERTSTORETYPE_JWKBLOB(19), DTLSCLIENT_SSLSERVERCERTSTORETYPE_SECURITY_KEY(20), DTLSCLIENT_SSLSERVERCERTSTORETYPE_BCFKSFILE(21), DTLSCLIENT_SSLSERVERCERTSTORETYPE_BCFKSBLOB(22), DTLSCLIENT_SSLSERVERCERTSTORETYPE_PKCS11(23), DTLSCLIENT_SSLSERVERCERTSTORETYPE_AUTO(99)
```

## Default Value

0

## Remarks

The type of certificate store for this certificate.

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

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

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

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

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

This property is read-only.

## Data Type

Integer

# SSLServerCertSubjectAltNames Property ([IPWorks_DTLSClient](#dtlsclient-class) Class)

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

## Object Oriented Interface

```text
public function getSSLServerCertSubjectAltNames();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 80 );
```

## Default Value

''

## Remarks

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

This property is read-only.

## Data Type

String

# SSLServerCertThumbprintMD5 Property ([IPWorks_DTLSClient](#dtlsclient-class) Class)

The MD5 hash of the certificate.

## Object Oriented Interface

```text
public function getSSLServerCertThumbprintMD5();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 81 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The SHA-1 hash of the certificate.

## Object Oriented Interface

```text
public function getSSLServerCertThumbprintSHA1();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 82 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The SHA-256 hash of the certificate.

## Object Oriented Interface

```text
public function getSSLServerCertThumbprintSHA256();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 83 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The text description of UsageFlags .

## Object Oriented Interface

```text
public function getSSLServerCertUsage();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 84 );
```

## Default Value

''

## Remarks

The text description of [SSLServerCertUsageFlags](#sslservercertusageflags-property-ipworks_dtlsclient-class).

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

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

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

This property is read-only.

## Data Type

String

# SSLServerCertUsageFlags Property ([IPWorks_DTLSClient](#dtlsclient-class) Class)

The flags that show intended use for the certificate.

## Object Oriented Interface

```text
public function getSSLServerCertUsageFlags();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 85 );
```

## Default Value

0

## Remarks

The flags that show intended use for the certificate. The value of [SSLServerCertUsageFlags](#sslservercertusageflags-property-ipworks_dtlsclient-class) is a combination of the following flags:

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

Please see the [SSLServerCertUsage](#sslservercertusage-property-ipworks_dtlsclient-class) property for a text representation of [SSLServerCertUsageFlags](#sslservercertusageflags-property-ipworks_dtlsclient-class).

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

This property is read-only.

## Data Type

Integer

# SSLServerCertVersion Property ([IPWorks_DTLSClient](#dtlsclient-class) Class)

The certificate's version number.

## Object Oriented Interface

```text
public function getSSLServerCertVersion();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 86 );
```

## Default Value

''

## Remarks

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_DTLSClient](#dtlsclient-class) Class)

The subject of the certificate used for client authentication.

## Object Oriented Interface

```text
public function getSSLServerCertSubject();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 87 );
```

## Default Value

''

## Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

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

This property is read-only.

## Data Type

String

# SSLServerCertEncoded Property ([IPWorks_DTLSClient](#dtlsclient-class) Class)

The certificate (PEM/Base64 encoded).

## Object Oriented Interface

```text
public function getSSLServerCertEncoded();
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 88 );
```

## Default Value

''

## Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLServerCertStore](#sslservercertstore-property-ipworks_dtlsclient-class) and [SSLServerCertSubject](#sslservercertsubject-property-ipworks_dtlsclient-class) properties also may be used to specify a certificate.

When [SSLServerCertEncoded](#sslservercertencoded-property-ipworks_dtlsclient-class) is set, a search is initiated in the current [SSLServerCertStore](#sslservercertstore-property-ipworks_dtlsclient-class) for the private key of the certificate. If the key is found, [SSLServerCertSubject](#sslservercertsubject-property-ipworks_dtlsclient-class) is updated to reflect the full subject of the selected certificate; otherwise, [SSLServerCertSubject](#sslservercertsubject-property-ipworks_dtlsclient-class) is set to an empty string.

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

## Data Type

Binary String

# Timeout Property ([IPWorks_DTLSClient](#dtlsclient-class) Class)

This property specifies a timeout when connecting to a server.

## Object Oriented Interface

```text
public function getTimeout();
public function setTimeout($value);
```

## Procedural Interface

```text
ipworks_dtlsclient_get($res, 89 );
ipworks_dtlsclient_set($res, 89, $value );
```

## Default Value

60

## Remarks

This property specifies a timeout when connecting to a server. When calling [Connect](#connect-method-ipworks_dtlsclient-class), if the connection is not established within Timeout seconds, an error is thrown.

## Data Type

Integer

# Config Method ([IPWorks_DTLSClient](#dtlsclient-class) Class)

Sets or retrieves a configuration setting.

## Object Oriented Interface

```text
public function doConfig($configurationstring);
```

## Procedural Interface

```text
ipworks_dtlsclient_do_config($res, $configurationstring);
```

## Remarks

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

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

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

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

# Connect Method ([IPWorks_DTLSClient](#dtlsclient-class) Class)

This method connects to a remote host.

## Object Oriented Interface

```text
public function doConnect();
```

## Procedural Interface

```text
ipworks_dtlsclient_do_connect($res);
```

## Remarks

This method connects to the remote host specified by [RemoteHost](#remotehost-property-ipworks_dtlsclient-class) and [RemotePort](#remoteport-property-ipworks_dtlsclient-class). For instance:

```text
component.RemoteHost = "MyHostNameOrIP";
component.RemotePort = 7777;
component.Connect();
```

# Disconnect Method ([IPWorks_DTLSClient](#dtlsclient-class) Class)

This method disconnects from the remote host.

## Object Oriented Interface

```text
public function doDisconnect();
```

## Procedural Interface

```text
ipworks_dtlsclient_do_disconnect($res);
```

## Remarks

This method disconnects from the remote host.

# DoEvents Method ([IPWorks_DTLSClient](#dtlsclient-class) Class)

This method processes events from the internal message queue.

## Object Oriented Interface

```text
public function doEvents();
```

## Procedural Interface

```text
ipworks_dtlsclient_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.

# PauseData Method ([IPWorks_DTLSClient](#dtlsclient-class) Class)

This method pauses data reception.

## Object Oriented Interface

```text
public function doPauseData();
```

## Procedural Interface

```text
ipworks_dtlsclient_do_pausedata($res);
```

## Remarks

This method pauses data reception when called. While data reception is paused, the [DataIn](#datain-event-ipworks_dtlsclient-class) event will not fire. Call [ProcessData](#processdata-method-ipworks_dtlsclient-class) to reenable data reception.

# ProcessData Method ([IPWorks_DTLSClient](#dtlsclient-class) Class)

This method reenables data reception after a call to PauseData .

## Object Oriented Interface

```text
public function doProcessData();
```

## Procedural Interface

```text
ipworks_dtlsclient_do_processdata($res);
```

## Remarks

This method reenables data reception after a previous call to [PauseData](#pausedata-method-ipworks_dtlsclient-class). When [PauseData](#pausedata-method-ipworks_dtlsclient-class) is called, the [DataIn](#datain-event-ipworks_dtlsclient-class) event will not fire. To reenable data reception and allow [DataIn](#datain-event-ipworks_dtlsclient-class) to fire, call this method.

NOTE: This method is used only after previously calling [PauseData](#pausedata-method-ipworks_dtlsclient-class). It does not need to be called to process incoming data by default.

# Reset Method ([IPWorks_DTLSClient](#dtlsclient-class) Class)

This method will reset the class.

## Object Oriented Interface

```text
public function doReset();
```

## Procedural Interface

```text
ipworks_dtlsclient_do_reset($res);
```

## Remarks

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

# SendBytes Method ([IPWorks_DTLSClient](#dtlsclient-class) Class)

This method sends binary data to the remote host.

## Object Oriented Interface

```text
public function doSendBytes($data);
```

## Procedural Interface

```text
ipworks_dtlsclient_do_sendbytes($res, $data);
```

## Remarks

This method sends the specified binary data to the remote host. For example:

```text
byte[] dataToSend = new byte[] { 72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100, 33 };
dtlsclient.SendBytes(dataToSend);
```

To send text, use the [SendText](#sendtext-method-ipworks_dtlsclient-class) method instead.

# SendText Method ([IPWorks_DTLSClient](#dtlsclient-class) Class)

This method sends text to the remote host.

## Object Oriented Interface

```text
public function doSendText($text);
```

## Procedural Interface

```text
ipworks_dtlsclient_do_sendtext($res, $text);
```

## Remarks

This method sends the specified text to the remote host. For example:

```text
dtlsclient.OnSSLServerAuthentication += (o, e) => {
  e.Accept = true;
};

dtlsclient.RemotePort = 8765;
dtlsclient.RemoteHost = "HostNameOrIPAddress";
dtlsclient.Connect();
dtlsclient.SendText("Hello!");
```

To send binary data, use the [SendBytes](#sendbytes-method-ipworks_dtlsclient-class) method instead.

# Connected Event ([IPWorks_DTLSClient](#dtlsclient-class) Class)

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

## Object Oriented Interface

```text
public function fireConnected($param);
```

## Procedural Interface

```text
ipworks_dtlsclient_register_callback($res, 1, array($this, 'fireConnected'));
```

## Parameter List

```text
 'address' 'port' 'statuscode' 'description'
```

## Remarks

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

If the connection is made normally, *StatusCode* is 0 and *Description* is "OK".

If the connection is broken for any other reason, *StatusCode* will be non-zero, and the *Description* parameter will contain a description of this code.

# DataIn Event ([IPWorks_DTLSClient](#dtlsclient-class) Class)

This event is fired when data are received.

## Object Oriented Interface

```text
public function fireDataIn($param);
```

## Procedural Interface

```text
ipworks_dtlsclient_register_callback($res, 2, array($this, 'fireDataIn'));
```

## Parameter List

```text
 'datagram' 'sourceaddress' 'sourceport'
```

## Remarks

The DataIn event is fired every time a new datagram is received.

*Datagram* contains the packet as sent by the remote host.

*SourceAddress* contains the IP number (Internet address) of the remote host, and *SourcePort* contains the port from which the packet originated.

NOTE: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

# Disconnected Event ([IPWorks_DTLSClient](#dtlsclient-class) Class)

This event is fired when a connection is closed.

## Object Oriented Interface

```text
public function fireDisconnected($param);
```

## Procedural Interface

```text
ipworks_dtlsclient_register_callback($res, 3, array($this, 'fireDisconnected'));
```

## Parameter List

```text
 'address' 'port' 'statuscode' 'description'
```

## Remarks

This event is fired when a connection is closed.

If the connection is broken normally, *StatusCode* is 0 and *Description* is "OK".

If the connection is broken for any other reason, *StatusCode* will be non-zero, and the *Description* parameter will contain a description of this code.

# Error Event ([IPWorks_DTLSClient](#dtlsclient-class) Class)

Fired when information is available about errors during data delivery.

## Object Oriented Interface

```text
public function fireError($param);
```

## Procedural Interface

```text
ipworks_dtlsclient_register_callback($res, 4, array($this, 'fireError'));
```

## Parameter List

```text
 '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](#trappable-errors-dtlsclient-class) section.

# Log Event ([IPWorks_DTLSClient](#dtlsclient-class) Class)

This event fires once for each log message.

## Object Oriented Interface

```text
public function fireLog($param);
```

## Procedural Interface

```text
ipworks_dtlsclient_register_callback($res, 5, array($this, 'fireLog'));
```

## Parameter List

```text
 'loglevel' 'message' 'logtype'
```

## Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the [LogLevel](#LogLevel) setting.

*LogLevel* indicates the detail level of the message. Possible values are as follows:

|  |  |
| --- | --- |
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data are logged. |
| 3 (Debug) | Debug data are logged. |

*Message* is the log entry.

*LogType* identifies the type of log entry. Possible values are as follows:

- "Info"
- "Error"
- "Verbose"
- "Debug"

# SSLServerAuthentication Event ([IPWorks_DTLSClient](#dtlsclient-class) Class)

This event is fired after the server presents its certificate to the client.

## Object Oriented Interface

```text
public function fireSSLServerAuthentication($param);
```

## Procedural Interface

```text
ipworks_dtlsclient_register_callback($res, 6, array($this, 'fireSSLServerAuthentication'));
```

## Parameter List

```text
 'sourceaddress' 'sourceport' 'certencoded' 'certsubject' 'certissuer' 'status' 'accept'
```

## Remarks

This event is fired after the server presents its certificate to the client.

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.

# SSLStatus Event ([IPWorks_DTLSClient](#dtlsclient-class) Class)

Fired when secure connection progress messages are available.

## Object Oriented Interface

```text
public function fireSSLStatus($param);
```

## Procedural Interface

```text
ipworks_dtlsclient_register_callback($res, 7, array($this, 'fireSSLStatus'));
```

## Parameter List

```text
 'message'
```

## Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

# Config Settings ([DTLSClient](#dtlsclient-class) 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](#config-method-ipworks_dtlsclient-class) method.

### DTLSClient Config Settings

**KeepAliveInterval**: The retry interval, in seconds, to be used when a HeartbeatRequest is sent and no response is received.This configuration specifies the retry interval, in seconds, to be used when a HeartbeatRequest message is sent and no response is received. HeartbeatRequest messages are only sent if the Heartbeat Extension is supported by the remote host.

The class will send a HeartbeatRequest message after a specified period of inactivity, defined by [KeepAliveTime](#KeepAliveTime). This value specifies the interval at which the class sends successive HeartbeatRequest messages, assuming no response is received from the remote host (HeartbeatResponse). By default, this value is 2 seconds and will only apply if [KeepAlive](#keepalive-property-ipworks_dtlsclient-class) is true.

**KeepAliveMode**: Specifies the Heartbeat (or keep-alive) mode to be used by the class.This configuration specifies the Heartbeat (or keep-alive) mode to be used by the class, as defined in RFC 6520. When [KeepAlive](#keepalive-property-ipworks_dtlsclient-class) is true, the following values are applicable:

|  |  |
| --- | --- |
| 1 | peer_allowed_to_send (default) |
| 2 | peer_not_allowed_to_send |

 When set to 1 (peer_allowed_to_send), the class can both a) send HeartbeatRequest messages and b) receive and respond to HeartbeatRequest messages.

When set to 2 (peer_not_allowed_to_send), the class will only be capable of sending HeartbeatRequests.

Note, if [KeepAlive](#keepalive-property-ipworks_dtlsclient-class) is false, Heartbeat functionality will be disabled. The class will not be capable of sending or handling HeartbeatRequest messages.

**KeepAliveTime**: The inactivity time, in seconds, before a HeartbeatRequest is sent.This configuration specifies the inactivity time, in seconds, before sending a HeartbeatRequest message. HeartbeatRequest messages are only sent if the Heartbeat Extension is supported by the remote host.

If the connection is inactive for the specified time, the class will send a HeartbeatRequest message to the remote host. If no response is received, the class will continue sending Heartbeats every [KeepAliveInterval](#KeepAliveInterval) seconds. By default, this value is 60 seconds and will only apply if [KeepAlive](#keepalive-property-ipworks_dtlsclient-class) is true.

**LogLevel**: This configuration controls the level of detail that is logged through the Log event.This configuration controls the level of detail that is logged through the [Log](#log-event-ipworks_dtlsclient-class) event. Possible values are as follows:

|  |  |
| --- | --- |
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data are logged. |
| 3 (Debug) | Debug data are logged. |

### UDP Config Settings

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

The default value for this setting is False.

NOTE: This setting is available only in Windows.

**DelayHostResolution**: Whether the hostname is resolved when RemoteHost is set.This configuration setting specifies whether a hostname is resolved immediately when [RemoteHost](#remotehost-property-ipworks_dtlsclient-class) is set. If *true* the class will resolve the hostname and the IP address will be present in the [RemoteHost](#remotehost-property-ipworks_dtlsclient-class) 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](#remotehost-property-ipworks_dtlsclient-class) at any time.

The default value is *false*.

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

NOTE: This setting is available only in Windows.

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

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

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

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

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

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

[LocalPort](#localport-property-ipworks_dtlsclient-class) 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).To use this configuration setting, [UseConnection](#UseConnection) must be True. This option allows you to specify an arbitrary DiffServ Code Point (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 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).To use this configuration setting, [UseConnection](#UseConnection) must be True. You may specify either the text or integer values: BestEffort (0), Background (1), ExcellentEffort (2), AudioVideo (3), Voice (4), and Control (5).

NOTE: This 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 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 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](#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 will create an IPv4 socket. To use IPv6 instead, set this to True.

### Socket Config Settings

**AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [Timeout](#timeout-property-ipworks_dtlsclient-class) 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.

### SSL Config Settings

**LogSSLPackets**: Controls whether SSL packets are logged.This configuration setting controls whether SSL packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes.

When enabled, SSL packet logs are output using the [SSLStatus](#sslstatus-event-ipworks_dtlsclient-class) event, which will fire each time a SSL packet is sent or received.

**ReuseSSLSession**: Determines if the SSL session is reused.

If set to True, the class will reuse the context if and only if the following criteria are met:

- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the class is the same.

**SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When SSLProvider is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the SSLCert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

```text
-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----
```

**SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the class will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class fails with an error.

When set to 0 (default), the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

**SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the class fails with an error.

When set to 0 (default), the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

**SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [SSLStatus](#sslstatus-event-ipworks_dtlsclient-class) event.

Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting.

**SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

```text
-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----
```

**SSLEnabledCipherSuites**: Specifies the cipher suites to be used during TLS negotiation.This configuration is used to specify the cipher suites to be used during TLS negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons. For example:

```text
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");
```

Possible cipher suites include the following:

- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA

**SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols.

The default value is *3072*. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values:

|  |  |
| --- | --- |
| TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |

**SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *false* by default, but it can be set to *true* to enable the extension.

This configuration setting is applicable only when SSLProvider is set to *Internal*.

**SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.

NOTE: This configuration setting is applicable only when SSLProvider is set to *Internal*.

**SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipher[connId]");
```

**SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipherStrength[connId]");
```

**SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipherSuite[connId]");
```

**SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedKeyExchange[connId]");
```

**SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
```

**SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedVersion[connId]");
```

**SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions:

|  |  |
| --- | --- |
| 0x00000001 | Ignore time validity status of certificate. |
| 0x00000002 | Ignore time validity status of CTL. |
| 0x00000004 | Ignore non-nested certificate times. |
| 0x00000010 | Allow unknown certificate authority. |
| 0x00000020 | Ignore wrong certificate usage. |
| 0x00000100 | Ignore unknown certificate revocation status. |
| 0x00000200 | Ignore unknown CTL signer revocation status. |
| 0x00000400 | Ignore unknown certificate authority revocation status. |
| 0x00000800 | Ignore unknown root revocation status. |
| 0x00008000 | Allow test root certificate. |
| 0x00004000 | Trust test root certificate. |
| 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |

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

**SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

```text
-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----
```

**TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when SSLProvider is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2.

When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class fails with an error.

The format of this value is a comma-separated list of hash-signature combinations. For instance:

```csharp
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
```

 The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*.

To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

**TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC.

The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*.

When using TLS 1.2 and SSLProvider is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported:

- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)

### Base Config Settings

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

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

The following is a list of valid code page identifiers:

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

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

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

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

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

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

**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](#doevents-method-ipworks_dtlsclient-class) 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](platforms.md) section.

# Trappable Errors ([DTLSClient](#dtlsclient-class) Class)

### DTLSClient Errors

|  |  |
| --- | --- |
| 400 | Invalid datagram received. See the error description for further details. |
| 401 | Invalid DTLS flow. See the error description for further details. |
| 402 | Not supported. See the error description for further details. |
| 403 | DTLS handshake error. See the error description for further details. |
| 404 | Invalid certificate provided. See the error description for further details. |
| 405 | Fatal alert. See the error description for further details. |