DTLSServer Class
Properties Methods Events Config Settings Errors
The DTLSServer class provides server-side functionality for secure UDP communication utilizing the Datagram Transport Layer Security (DTLS) protocol.
Syntax
class ipworksdtls.DTLSServer
Remarks
The DTLSServer class functions as a server that facilitates incoming DTLS connections and offers a convenient means of transmitting and receiving datagrams over the established, secure connections.
Getting Started
First, a valid certificate must be selected before the server can start listening for incoming connections. The certificate can be specified via the ssl_cert. Note the certificate must contain a private key.
After doing so, calling start_listening will cause the class to start listening for incoming connections. The class will listen on the interface defined by local_host and local_port, if specified. Otherwise, these values will be set by the class. If applicable, these values must be set before calling start_listening. For example:
//dtlsserver.LocalHost = "some_ip_address";
//dtlsserver.LocalPort = 1234;
dtlsserver.SSLCert = new Certificate("/path/to/cert.pfx", CertStoreTypes.cstPFXFile, "cert_password", "cert_subject");
dtlsserver.StartListening();
Console.WriteLine("Listening on: " + dtlsserver.LocalHost + ":" + dtlsserver.LocalPort);
while (dtlsserver.Listening) {
dtlsserver.DoEvents();
}
Handling Incoming Connections
Once successfully listening, the class can now accept (or reject) incoming connections. The first indicator of an incoming connection will be through the on_connection_request event. Here, the connection's originating address and port can be queried. By default, the class will accept all incoming connections, but this behavior can be overridden within this event.
Assuming the connection is accepted, the DTLS handshake will proceed. Relevant handshake details will be reported by the on_ssl_status event. By default, the client is not required to present a certificate to the server. To force this, the ssl_authenticate_clients property can be enabled. When enabled, the client's presented certificate will be available within the on_ssl_client_authentication event, where the server can again choose to accept (or reject) incoming connections.
Once the connection is complete (or fails), the on_connected 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.
After a successful connection, relevant connection-specific details will be available within the Connection* properties. Each connection will be assigned a unique ConnectionId, which can be acquired for a given connection within the on_connected event. For example:
dtlsserver.OnConnected += (o, e) => {
if (e.StatusCode == 0) {
Console.WriteLine("Successful connection from " + e.SourceAddr + ":" + e.SourcePort);
Console.WriteLine("ConnectionId: " + e.ConnectionId);
} else {
Console.WriteLine("Connection failed from " + e.SourceAddr + ":" + e.SourcePort);
Console.WriteLine("Error code: " + e.StatusCode);
Console.WriteLine("Error description: " + e.Description);
}
};
dtlsserver.OnSSLClientAuthentication += (o, e) => {
if (e.Accept) return;
Console.Write("Client 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;
};
dtlsserver.SSLCert = new Certificate("/path/to/cert.pfx", CertStoreTypes.cstPFXFile, "cert_password", "cert_subject");
dtlsserver.AuthenticateClients = true;
dtlsserver.StartListening();
Console.WriteLine("Listening on: " + dtlsserver.LocalHost + ":" + dtlsserver.LocalPort);
while (dtlsserver.Listening) {
dtlsserver.DoEvents();
}
Sending and Receiving Data
The class can send data to individual connections, specified by the ConnectionId parameter, via the send_bytes and send_text methods.
While a connection is active, incoming data from a connection will be available within the on_data_in 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 pause_data method can be called, disabling the reception of incoming data from a particular connection. Data reception can later be enabled via the process_data method. Note that if this reception is disabled for a connection, the connection 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 this connection. Please use these methods with caution.
The complete process may look like the following:
dtlsserver.OnDataIn += (o, e) => {
Console.WriteLine("Packet received from: " + e.ConnectionId);
Console.WriteLine("Packet: " + e.Datagram);
};
dtlsserver.SSLCert = new Certificate("/path/to/cert.pfx", CertStoreTypes.cstPFXFile, "cert_password", "cert_subject");
dtlsserver.StartListening();
Console.WriteLine("Listening on: " + dtlsserver.LocalHost + ":" + dtlsserver.LocalPort);
...
...
...
// Broadcast data
foreach (DTLSConnection c in dtlsserver.Connections.Values) {
dtlsserver.SendText(c.ConnectionId, "Hello world!");
}
Removing Connections
To remove a connection, disconnect must be called with the corresponding ConnectionId. In order to remove inactive connections, the default_idle_timeout property can be set accordingly. By default, this property is set to 0, and idle connections are not removed automatically. When this property is set to a positive value, this will automatically remove connections that are idle for a specified amount of time.
Note: For default_idle_timeout to work as intended, do_events must be called frequently in both console and form-based applications (e.g., using a loop or timer).
Finally, once a connection ends, on_disconnected will fire. In the case a connection ends and an error is encountered, the StatusCode and Description parameters will contain relevant details regarding the error. The connection will be removed from the Connection* properties. For example:
dtlsserver.OnDisconnected += (o, e) => {
if (e.StatusCode == 0) {
Console.WriteLine("Connection removed: " + e.ConnectionId);
} else {
Console.WriteLine("Connection removed: " + e.ConnectionId);
Console.WriteLine("Error code: " + e.StatusCode);
Console.WriteLine("Error description: " + e.Description);
}
};
dtlsserver.DefaultIdleTimeout = 60; // Remove connections inactive for 60 seconds
dtlsserver.StartListening();
Console.WriteLine("Listening on: " + dtlsserver.LocalHost + ":" + dtlsserver.LocalPort);
while (dtlsserver.Listening) {
dtlsserver.DoEvents();
}
Additional Information
To support default_idle_timeout and keep_alive functionality, it is important to note that do_events must be called regularly in both console and form-based applications.
For default_idle_timeout, do_events must be called frequently to ensure that idle connections are handled and removed in a timely manner. For keep_alive, do_events must be called frequently to ensure the class sends keep-alive (or Heartbeat) packets to existing connections in a timely manner.
In form-based applications, this does not apply if default_idle_timeout is set to 0 and keep_alive 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.
| connection_count | The number of records in the Connection arrays. |
| connection_connection_id | This property contains an identifier generated by the class to identify each connection. |
| connection_local_host | This property indicates the name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| connection_local_port | This property indicates the UDP port on the local host or user-assigned IP interface through which connections are initiated or accepted. |
| connection_remote_host | This property indicates the IP address of the remote host through which the connection is coming. |
| connection_remote_port | This property indicates the UDP port on the remote host through which the connection is coming. |
| default_idle_timeout | This property includes the default idle timeout for inactive clients. |
| keep_alive | When True, keep-alive functionality is enabled via the DTLS Heartbeat Extension. |
| listening | This property indicates whether the class is listening for incoming connections on LocalPort. |
| local_host | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| local_port | This property includes the Transmission Control Protocol (TCP) port in the local host where the class listens. |
| ssl_authenticate_clients | If set to True, the server asks the client(s) for a certificate. |
| ssl_cert_effective_date | The date on which this certificate becomes valid. |
| ssl_cert_expiration_date | The date on which the certificate expires. |
| ssl_cert_extended_key_usage | A comma-delimited list of extended key usage identifiers. |
| ssl_cert_fingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| ssl_cert_fingerprint_sha1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| ssl_cert_fingerprint_sha256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| ssl_cert_issuer | The issuer of the certificate. |
| ssl_cert_private_key | The private key of the certificate (if available). |
| ssl_cert_private_key_available | Whether a PrivateKey is available for the selected certificate. |
| ssl_cert_private_key_container | The name of the PrivateKey container for the certificate (if available). |
| ssl_cert_public_key | The public key of the certificate. |
| ssl_cert_public_key_algorithm | The textual description of the certificate's public key algorithm. |
| ssl_cert_public_key_length | The length of the certificate's public key (in bits). |
| ssl_cert_serial_number | The serial number of the certificate encoded as a string. |
| ssl_cert_signature_algorithm | The text description of the certificate's signature algorithm. |
| ssl_cert_store | The name of the certificate store for the client certificate. |
| ssl_cert_store_password | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| ssl_cert_store_type | The type of certificate store for this certificate. |
| ssl_cert_subject_alt_names | Comma-separated lists of alternative subject names for the certificate. |
| ssl_cert_thumbprint_md5 | The MD5 hash of the certificate. |
| ssl_cert_thumbprint_sha1 | The SHA-1 hash of the certificate. |
| ssl_cert_thumbprint_sha256 | The SHA-256 hash of the certificate. |
| ssl_cert_usage | The text description of UsageFlags . |
| ssl_cert_usage_flags | The flags that show intended use for the certificate. |
| ssl_cert_version | The certificate's version number. |
| ssl_cert_subject | The subject of the certificate used for client authentication. |
| ssl_cert_encoded | The certificate (PEM/Base64 encoded). |
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 | Sets or retrieves a configuration setting. |
| disconnect | This method disconnects the specified client. |
| do_events | This method processes events from the internal message queue. |
| pause_data | This method pauses data reception. |
| process_data | This method reenables data reception after a call to PauseData . |
| reset | This method will reset the class. |
| send_bytes | This method sends binary data to the specified client. |
| send_text | This method sends text to the specified client. |
| shutdown | This method shuts down the server. |
| start_listening | This method starts listening for incoming connections. |
| stop_listening | This method stops listening for new connections. |
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.
| on_connected | This event is fired immediately after a connection completes (or fails). |
| on_connection_request | This event is fired when a request for connection comes from a remote host. |
| on_data_in | This event is fired when data is received. |
| on_disconnected | This event is fired when a connection is closed. |
| on_error | This event fires information about errors during data delivery. |
| on_log | This event fires once for each log message. |
| on_ssl_client_authentication | This event is fired when the client presents its credentials to the server. |
| on_ssl_status | This event is fired to show the progress of the secure connection. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
| KeepAliveInterval | The retry interval, in seconds, to be used when a HeartbeatRequest is sent and no response is received. |
| KeepAliveMode | Specifies the Heartbeat (or keep-alive) mode to be used by the class. |
| KeepAliveTime | The inactivity time, in seconds, before a HeartbeatRequest is sent. |
| LogLevel | This configuration controls the level of detail that is logged through the Log event. |
| MaxConnections | Specifies the maximum number of simultaneous connections the server can maintain. |
| CaptureIPPacketInfo | Used to capture the packet information. |
| DelayHostResolution | Whether the hostname is resolved when RemoteHost is set. |
| DestinationAddress | Used to get the destination address from the packet information. |
| DontFragment | Used to set the Don't Fragment flag of outgoing packets. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The port in the local host where the class binds. |
| MaxPacketSize | The maximum length of the packets that can be received. |
| QOSDSCPValue | Used to specify an arbitrary QOS/DSCP setting (optional). |
| QOSTrafficType | Used to specify QOS/DSCP settings (optional). |
| ShareLocalPort | If set to True, allows more than one instance of the class to be active on the same local port. |
| SourceIPAddress | Used to set the source IP address used when sending a packet. |
| SourceMacAddress | Used to set the source MAC address used when sending a packet. |
| UseConnection | Determines whether to use a connected socket. |
| UseIPv6 | Whether or not to use IPv6. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| LogSSLPackets | Controls whether SSL packets are logged. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCACerts | A newline separated list of CA certificates to be included when performing an SSL handshake. |
| SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
| SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
| SSLEnabledCipherSuites | Specifies the cipher suites to be used during TLS negotiation. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
| SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
| SSLNegotiatedCipher | Returns the negotiated cipher suite. |
| SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
| SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
| SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
| SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
| SSLNegotiatedVersion | Returns the negotiated protocol version. |
| SSLSecurityFlags | Flags that control certificate verification. |
| SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
| TLS12SupportedGroups | The supported groups for ECC. |
| BuildInfo | Information about the product's build. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| MaskSensitiveData | Whether sensitive data is masked in log messages. |
| ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
| SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
connection_count Property
The number of records in the Connection arrays.
Syntax
def get_connection_count() -> int: ... def set_connection_count(value: int) -> None: ...
connection_count = property(get_connection_count, set_connection_count)
Default Value
0
Remarks
This property controls the size of the following arrays:
- connection_connection_id
- connection_local_host
- connection_local_port
- connection_remote_host
- connection_remote_port
connection_connection_id Property
This property contains an identifier generated by the class to identify each connection.
Syntax
def get_connection_connection_id(connection_id: int) -> int: ...
Default Value
0
Remarks
This property contains an identifier generated by the class to identify each connection. This identifier is unique to this connection.
The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the connection_count property.
This property is read-only.
connection_local_host Property
This property indicates the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
def get_connection_local_host(connection_id: int) -> str: ...
Default Value
""
Remarks
This property indicates the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the connection_count property.
This property is read-only.
connection_local_port Property
This property indicates the UDP port on the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
def get_connection_local_port(connection_id: int) -> int: ...
Default Value
0
Remarks
This property indicates the UDP port on the local host or user-assigned IP interface through which connections are initiated or accepted.
The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the connection_count property.
This property is read-only.
connection_remote_host Property
This property indicates the IP address of the remote host through which the connection is coming.
Syntax
def get_connection_remote_host(connection_id: int) -> str: ...
Default Value
""
Remarks
This property indicates the IP address of the remote host through which the connection is coming.
The connection must be valid or an error will be fired.
If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.
The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the connection_count property.
This property is read-only.
connection_remote_port Property
This property indicates the UDP port on the remote host through which the connection is coming.
Syntax
def get_connection_remote_port(connection_id: int) -> int: ...
Default Value
0
Remarks
This property indicates the UDP port on the remote host through which the connection is coming.
The connection must be valid or an error will be fired.
The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the connection_count property.
This property is read-only.
default_idle_timeout Property
This property includes the default idle timeout for inactive clients.
Syntax
def get_default_idle_timeout() -> int: ... def set_default_idle_timeout(value: int) -> None: ...
default_idle_timeout = property(get_default_idle_timeout, set_default_idle_timeout)
Default Value
0
Remarks
This property specifies the idle timeout (in seconds) for clients. When set to a positive value, the class will disconnect idle clients after the specified timeout.
This applies only to clients that have not sent or received data within default_idle_timeout seconds.
If set to 0 (default), no idle timeout is applied.
Note: do_events must be called for the class to check existing connections.
keep_alive Property
When True, keep-alive functionality is enabled via the DTLS Heartbeat Extension.
Syntax
def get_keep_alive() -> bool: ... def set_keep_alive(value: bool) -> None: ...
keep_alive = property(get_keep_alive, set_keep_alive)
Default Value
FALSE
Remarks
This property enables keep-alive functionality for established connections via the DTLS Heartbeat Extension (RFC 6520). Enabling this option can prevent long connections from timing out in case of inactivity.
Note: For this functionality to work as intended, do_events 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.
listening Property
This property indicates whether the class is listening for incoming connections on LocalPort.
Syntax
def get_listening() -> bool: ...
listening = property(get_listening, None)
Default Value
FALSE
Remarks
This property indicates whether the class is listening for connections on the port specified by the local_port property. Use the start_listening and stop_listening methods to control whether the class is listening.
This property is read-only.
local_host Property
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
def get_local_host() -> str: ... def set_local_host(value: str) -> None: ...
local_host = property(get_local_host, set_local_host)
Default Value
""
Remarks
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 classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.
If the class is connected, the local_host property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
Note: local_host is not persistent. You must always set it in code, and never in the property window.
local_port Property
This property includes the Transmission Control Protocol (TCP) port in the local host where the class listens.
Syntax
def get_local_port() -> int: ... def set_local_port(value: int) -> None: ...
local_port = property(get_local_port, set_local_port)
Default Value
0
Remarks
This property must be set before the class can start listening. If its value is 0, then the TCP/IP subsystem picks a port number at random. The port number can be found by checking the value of this property after the class is listening (i.e., after successfully assigning True to the listening property).
The service port is not shared among servers so two classs cannot be listening on the same port at the same time.
ssl_authenticate_clients Property
If set to True, the server asks the client(s) for a certificate.
Syntax
def get_ssl_authenticate_clients() -> bool: ... def set_ssl_authenticate_clients(value: bool) -> None: ...
ssl_authenticate_clients = property(get_ssl_authenticate_clients, set_ssl_authenticate_clients)
Default Value
FALSE
Remarks
This property is used in conjunction with the on_ssl_client_authentication event. Please refer to the documentation of the on_ssl_client_authentication event for details.
ssl_cert_effective_date Property
The date on which this certificate becomes valid.
Syntax
def get_ssl_cert_effective_date() -> str: ...
ssl_cert_effective_date = property(get_ssl_cert_effective_date, None)
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.
ssl_cert_expiration_date Property
The date on which the certificate expires.
Syntax
def get_ssl_cert_expiration_date() -> str: ...
ssl_cert_expiration_date = property(get_ssl_cert_expiration_date, None)
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.
ssl_cert_extended_key_usage Property
A comma-delimited list of extended key usage identifiers.
Syntax
def get_ssl_cert_extended_key_usage() -> str: ...
ssl_cert_extended_key_usage = property(get_ssl_cert_extended_key_usage, None)
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.
ssl_cert_fingerprint Property
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
def get_ssl_cert_fingerprint() -> str: ...
ssl_cert_fingerprint = property(get_ssl_cert_fingerprint, None)
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.
ssl_cert_fingerprint_sha1 Property
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
def get_ssl_cert_fingerprint_sha1() -> str: ...
ssl_cert_fingerprint_sha1 = property(get_ssl_cert_fingerprint_sha1, None)
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.
ssl_cert_fingerprint_sha256 Property
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
def get_ssl_cert_fingerprint_sha256() -> str: ...
ssl_cert_fingerprint_sha256 = property(get_ssl_cert_fingerprint_sha256, None)
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.
ssl_cert_issuer Property
The issuer of the certificate.
Syntax
def get_ssl_cert_issuer() -> str: ...
ssl_cert_issuer = property(get_ssl_cert_issuer, None)
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.
ssl_cert_private_key Property
The private key of the certificate (if available).
Syntax
def get_ssl_cert_private_key() -> str: ...
ssl_cert_private_key = property(get_ssl_cert_private_key, None)
Default Value
""
Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The ssl_cert_private_key may be available but not exportable. In this case, ssl_cert_private_key returns an empty string.
This property is read-only.
ssl_cert_private_key_available Property
Whether a PrivateKey is available for the selected certificate.
Syntax
def get_ssl_cert_private_key_available() -> bool: ...
ssl_cert_private_key_available = property(get_ssl_cert_private_key_available, None)
Default Value
FALSE
Remarks
Whether a ssl_cert_private_key is available for the selected certificate. If ssl_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
ssl_cert_private_key_container Property
The name of the PrivateKey container for the certificate (if available).
Syntax
def get_ssl_cert_private_key_container() -> str: ...
ssl_cert_private_key_container = property(get_ssl_cert_private_key_container, None)
Default Value
""
Remarks
The name of the ssl_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
ssl_cert_public_key Property
The public key of the certificate.
Syntax
def get_ssl_cert_public_key() -> str: ...
ssl_cert_public_key = property(get_ssl_cert_public_key, None)
Default Value
""
Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
ssl_cert_public_key_algorithm Property
The textual description of the certificate's public key algorithm.
Syntax
def get_ssl_cert_public_key_algorithm() -> str: ...
ssl_cert_public_key_algorithm = property(get_ssl_cert_public_key_algorithm, None)
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.
ssl_cert_public_key_length Property
The length of the certificate's public key (in bits).
Syntax
def get_ssl_cert_public_key_length() -> int: ...
ssl_cert_public_key_length = property(get_ssl_cert_public_key_length, None)
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.
ssl_cert_serial_number Property
The serial number of the certificate encoded as a string.
Syntax
def get_ssl_cert_serial_number() -> str: ...
ssl_cert_serial_number = property(get_ssl_cert_serial_number, None)
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.
ssl_cert_signature_algorithm Property
The text description of the certificate's signature algorithm.
Syntax
def get_ssl_cert_signature_algorithm() -> str: ...
ssl_cert_signature_algorithm = property(get_ssl_cert_signature_algorithm, None)
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.
ssl_cert_store Property
The name of the certificate store for the client certificate.
Syntax
def get_ssl_cert_store() -> bytes: ... def set_ssl_cert_store(value: bytes) -> None: ...
ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)
Default Value
"MY"
Remarks
The name of the certificate store for the client certificate.
The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password-protected, specify the password in ssl_cert_store_password.
ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
| 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).
ssl_cert_store_password Property
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
def get_ssl_cert_store_password() -> str: ... def set_ssl_cert_store_password(value: str) -> None: ...
ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
ssl_cert_store_type Property
The type of certificate store for this certificate.
Syntax
def get_ssl_cert_store_type() -> int: ... def set_ssl_cert_store_type(value: int) -> None: ...
ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)
Default Value
0
Remarks
The type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS#11 DLL. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ssl_cert_store and set ssl_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key:
|
| 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. |
ssl_cert_subject_alt_names Property
Comma-separated lists of alternative subject names for the certificate.
Syntax
def get_ssl_cert_subject_alt_names() -> str: ...
ssl_cert_subject_alt_names = property(get_ssl_cert_subject_alt_names, None)
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
ssl_cert_thumbprint_md5 Property
The MD5 hash of the certificate.
Syntax
def get_ssl_cert_thumbprint_md5() -> str: ...
ssl_cert_thumbprint_md5 = property(get_ssl_cert_thumbprint_md5, None)
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.
ssl_cert_thumbprint_sha1 Property
The SHA-1 hash of the certificate.
Syntax
def get_ssl_cert_thumbprint_sha1() -> str: ...
ssl_cert_thumbprint_sha1 = property(get_ssl_cert_thumbprint_sha1, None)
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.
ssl_cert_thumbprint_sha256 Property
The SHA-256 hash of the certificate.
Syntax
def get_ssl_cert_thumbprint_sha256() -> str: ...
ssl_cert_thumbprint_sha256 = property(get_ssl_cert_thumbprint_sha256, None)
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.
ssl_cert_usage Property
The text description of UsageFlags .
Syntax
def get_ssl_cert_usage() -> str: ...
ssl_cert_usage = property(get_ssl_cert_usage, None)
Default Value
""
Remarks
The text description of ssl_cert_usage_flags.
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.
ssl_cert_usage_flags Property
The flags that show intended use for the certificate.
Syntax
def get_ssl_cert_usage_flags() -> int: ...
ssl_cert_usage_flags = property(get_ssl_cert_usage_flags, None)
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of ssl_cert_usage_flags 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 ssl_cert_usage property for a text representation of ssl_cert_usage_flags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
ssl_cert_version Property
The certificate's version number.
Syntax
def get_ssl_cert_version() -> str: ...
ssl_cert_version = property(get_ssl_cert_version, None)
Default Value
""
Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
ssl_cert_subject Property
The subject of the certificate used for client authentication.
Syntax
def get_ssl_cert_subject() -> str: ... def set_ssl_cert_subject(value: str) -> None: ...
ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)
Default Value
""
Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
| 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.
ssl_cert_encoded Property
The certificate (PEM/Base64 encoded).
Syntax
def get_ssl_cert_encoded() -> bytes: ... def set_ssl_cert_encoded(value: bytes) -> None: ...
ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)
Default Value
""
Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.
When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.
config Method
Sets or retrieves a configuration setting.
Syntax
def config(configuration_string: str) -> str: ...
Remarks
config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
disconnect Method
This method disconnects the specified client.
Syntax
def disconnect(connection_id: int) -> None: ...
Remarks
Calling this method will disconnect the client specified by the ConnectionId parameter.
do_events Method
This method processes events from the internal message queue.
Syntax
def do_events() -> None: ...
Remarks
When do_events is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
pause_data Method
This method pauses data reception.
Syntax
def pause_data(connection_id: int) -> None: ...
Remarks
This method pauses data reception for the connection identified by ConnectionId when called. While data reception is paused, the on_data_in event will not fire for the specified connection. Call process_data to reenable data reception.
process_data Method
This method reenables data reception after a call to PauseData .
Syntax
def process_data(connection_id: int) -> None: ...
Remarks
This method reenables data reception for the connection identified by ConnectionId after a previous call to pause_data. When pause_data is called, the on_data_in event will not fire for the specified connection. To reenable data reception and allow on_data_in to fire, call this method.
Note: This method is used only after previously calling pause_data. It does not need to be called to process incoming data by default.
reset Method
This method will reset the class.
Syntax
def reset() -> None: ...
Remarks
This method will reset the class's properties to their default values.
send_bytes Method
This method sends binary data to the specified client.
Syntax
def send_bytes(connection_id: int, data: bytes) -> None: ...
Remarks
This method sends binary data to the client identified by ConnectionId. For example:
byte[] dataToSend = new byte[] { 72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100, 33 };
foreach (DTLSConnection c in dtlsserver.Connections.Values) {
dtlsserver.SendBytes(c.ConnectionId, dataToSend);
}
To send text, use the send_text method instead.
send_text Method
This method sends text to the specified client.
Syntax
def send_text(connection_id: int, text: str) -> None: ...
Remarks
This method sends text to the client identified by ConnectionId. For example:
string dataToSend = "Hello world!";
foreach (DTLSConnection c in dtlsserver.Connections.Values) {
dtlsserver.SendText(c.ConnectionId, dataToSend);
}
To send binary data, use the send_bytes method instead.
shutdown Method
This method shuts down the server.
Syntax
def shutdown() -> None: ...
Remarks
This method shuts down the server. Calling this method is equivalent to calling stop_listening and then breaking every client connection by calling disconnect.
start_listening Method
This method starts listening for incoming connections.
Syntax
def start_listening() -> None: ...
Remarks
This method begins listening for incoming connections on the port specified by local_port. Once listening, events will fire as new clients connect and data are transferred.
To stop listening for new connections, call stop_listening. To stop listening for new connections and to disconnect all existing clients, call shutdown.
stop_listening Method
This method stops listening for new connections.
Syntax
def stop_listening() -> None: ...
Remarks
This method stops listening for new connections. After being called, any new connection attempts will be rejected. Calling this method does not disconnect existing connections.
To stop listening and to disconnect all existing clients, call shutdown instead.
on_connected Event
This event is fired immediately after a connection completes (or fails).
Syntax
class DTLSServerConnectedEventParams(object): @property def connection_id() -> int: ... @property def source_addr() -> str: ... @property def source_port() -> int: ... @property def status_code() -> int: ... @property def description() -> str: ... # In class DTLSServer: @property def on_connected() -> Callable[[DTLSServerConnectedEventParams], None]: ... @on_connected.setter def on_connected(event_hook: Callable[[DTLSServerConnectedEventParams], None]) -> None: ...
Remarks
This event is fired immediately after a connection completes (or fails). The ConnectionId parameter indicates the unique ID assigned to this connection.
SourceAddr contains the IP number (Internet address) of the remote party, and SourcePort contains the port from which the packet originated.
If the connection is made normally, StatusCode is 0 and Description is "OK".
If the connection fails, StatusCode has the error code returned by the system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.
Please refer to the Error Codes section for more information.
on_connection_request Event
This event is fired when a request for connection comes from a remote host.
Syntax
class DTLSServerConnectionRequestEventParams(object): @property def address() -> str: ... @property def port() -> int: ... @property def accept() -> bool: ... @accept.setter def accept(value) -> None: ... # In class DTLSServer: @property def on_connection_request() -> Callable[[DTLSServerConnectionRequestEventParams], None]: ... @on_connection_request.setter def on_connection_request(event_hook: Callable[[DTLSServerConnectionRequestEventParams], None]) -> None: ...
Remarks
This event indicates an incoming connection. The connection is accepted by default. Address and Port will contain information about the remote host requesting the inbound connection. If you want to refuse it, you can set the Accept parameter to False.
on_data_in Event
This event is fired when data is received.
Syntax
class DTLSServerDataInEventParams(object): @property def connection_id() -> int: ... @property def datagram() -> bytes: ... # In class DTLSServer: @property def on_data_in() -> Callable[[DTLSServerDataInEventParams], None]: ... @on_data_in.setter def on_data_in(event_hook: Callable[[DTLSServerDataInEventParams], None]) -> None: ...
Remarks
The on_data_in event is fired every time a new datagram is received.
ConnectionId indicates the unique Id of the DTLSConnection from which the packet originated.
Datagram contains the packet as sent by the remote host.
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.
on_disconnected Event
This event is fired when a connection is closed.
Syntax
class DTLSServerDisconnectedEventParams(object): @property def connection_id() -> int: ... @property def status_code() -> int: ... @property def description() -> str: ... # In class DTLSServer: @property def on_disconnected() -> Callable[[DTLSServerDisconnectedEventParams], None]: ... @on_disconnected.setter def on_disconnected(event_hook: Callable[[DTLSServerDisconnectedEventParams], None]) -> None: ...
Remarks
If the connection is broken normally, StatusCode is 0, and Description is "OK".
If the connection is broken for any other reason, StatusCode has the error code returned by the system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.
Please refer to the Error Codes section for more information.
on_error Event
This event fires information about errors during data delivery.
Syntax
class DTLSServerErrorEventParams(object): @property def connection_id() -> int: ... @property def error_code() -> int: ... @property def description() -> str: ... # In class DTLSServer: @property def on_error() -> Callable[[DTLSServerErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[DTLSServerErrorEventParams], None]) -> None: ...
Remarks
The on_error event is fired in case of exceptional conditions during message processing. Normally, the class fails with an error.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
ConnectionId indicates the connection for which the error is applicable.
on_log Event
This event fires once for each log message.
Syntax
class DTLSServerLogEventParams(object): @property def connection_id() -> int: ... @property def log_level() -> int: ... @property def message() -> str: ... @property def log_type() -> str: ... # In class DTLSServer: @property def on_log() -> Callable[[DTLSServerLogEventParams], None]: ... @on_log.setter def on_log(event_hook: Callable[[DTLSServerLogEventParams], None]) -> None: ...
Remarks
This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.
LogLevel indicates the level of 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. |
The value 1 (Info) logs basic information, including users logging in and out, files transferred, and directories listed.
The value 2 (Verbose) includes logs from the on_pi_trail event as well as basic information about data transfer channels.
The value 3 (Debug) logs additional debug information, such as extended socket connection and data transfer information.
Message is the log entry.
LogType identifies the type of log entry. Possible values are as follows:
- "Info"
- "Error"
- "Verbose"
- "Debug"
on_ssl_client_authentication Event
This event is fired when the client presents its credentials to the server.
Syntax
class DTLSServerSSLClientAuthenticationEventParams(object): @property def connection_id() -> int: ... @property def cert_encoded() -> bytes: ... @property def cert_subject() -> str: ... @property def cert_issuer() -> str: ... @property def status() -> str: ... @property def accept() -> bool: ... @accept.setter def accept(value) -> None: ... # In class DTLSServer: @property def on_ssl_client_authentication() -> Callable[[DTLSServerSSLClientAuthenticationEventParams], None]: ... @on_ssl_client_authentication.setter def on_ssl_client_authentication(event_hook: Callable[[DTLSServerSSLClientAuthenticationEventParams], None]) -> None: ...
Remarks
This event enables the server to decide whether or not to continue. The Accept parameter is a recommendation on whether to continue or to 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").
on_ssl_status Event
This event is fired to show the progress of the secure connection.
Syntax
class DTLSServerSSLStatusEventParams(object): @property def connection_id() -> int: ... @property def message() -> str: ... # In class DTLSServer: @property def on_ssl_status() -> Callable[[DTLSServerSSLStatusEventParams], None]: ... @on_ssl_status.setter def on_ssl_status(event_hook: Callable[[DTLSServerSSLStatusEventParams], None]) -> None: ...
Remarks
The event is fired for informational and logging purposes only. It is used to track the progress of the connection.
DTLSServer Config Settings
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.DTLSServer Config Settings
The class will send a HeartbeatRequest message after a specified period of inactivity, defined by 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 keep_alive is true.
| 1 | peer_allowed_to_send (default) |
| 2 | peer_not_allowed_to_send |
When set to 2 (peer_not_allowed_to_send), the class will only be capable of sending HeartbeatRequests.
Note, if keep_alive is false, Heartbeat functionality will be disabled. The class will not be capable of sending or handling HeartbeatRequest messages.
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 seconds. By default, this value is 60 seconds and will only apply if keep_alive is true.
| 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
The default value for this setting is False.
Note: This setting is available only in Windows.
The default value is False.
Note: This setting is available only in Windows.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the local_host 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).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by local_port after the connection is established.
local_port 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.
Note: This setting uses the qWAVE API and is available only on Windows 7, Windows Server 2008 R2, and later.
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.
The default value for this setting is False.
Note: This setting is available only in Windows and requires that the winpcap library be installed (or npcap with winpcap compatibility).
Note: This setting is available only in Windows and requires that the winpcap library be installed (or npcap with winpcap compatibility).
The default value for this setting is False.
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
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.
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
When enabled, SSL packet logs are output using the on_ssl_status event, which will fire each time a SSL packet is sent or received.
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.
-----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-----
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.
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.
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 on_ssl_status 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 is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----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-----
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 is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons. For example:
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
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) |
This configuration setting is applicable only when ssl_provider is set to Internal.
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 ssl_provider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
| 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.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----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-----
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:
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.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and ssl_provider 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
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 |
| 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 |
- 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.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to True tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to False by default. On Linux/macOS, this setting is set to True by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
DTLSServer Errors
DTLSServer 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. |