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.

Class Name

IPWorksDTLS_DTLSServer

Procedural Interface

 ipworksdtls_dtlsserver_open();
 ipworksdtls_dtlsserver_close($res);
 ipworksdtls_dtlsserver_register_callback($res, $id, $function);
 ipworksdtls_dtlsserver_get_last_error($res);
 ipworksdtls_dtlsserver_get_last_error_code($res);
 ipworksdtls_dtlsserver_set($res, $id, $index, $value);
 ipworksdtls_dtlsserver_get($res, $id, $index);
 ipworksdtls_dtlsserver_do_config($res, $configurationstring);
 ipworksdtls_dtlsserver_do_disconnect($res, $connectionid);
 ipworksdtls_dtlsserver_do_doevents($res);
 ipworksdtls_dtlsserver_do_pausedata($res, $connectionid);
 ipworksdtls_dtlsserver_do_processdata($res, $connectionid);
 ipworksdtls_dtlsserver_do_reset($res);
 ipworksdtls_dtlsserver_do_sendbytes($res, $connectionid, $data);
 ipworksdtls_dtlsserver_do_sendtext($res, $connectionid, $text);
 ipworksdtls_dtlsserver_do_shutdown($res);
 ipworksdtls_dtlsserver_do_startlistening($res);
 ipworksdtls_dtlsserver_do_stoplistening($res);

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 SSLCert* properties. Note the certificate must contain a private key.

After doing so, calling StartListening will cause the class to start listening for incoming connections. The class will listen on the interface defined by LocalHost and LocalPort, if specified. Otherwise, these values will be set by the class. If applicable, these values must be set before calling StartListening. 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 ConnectionRequest 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 SSLStatus event. By default, the client is not required to present a certificate to the server. To force this, the SSLAuthenticateClients property can be enabled. When enabled, the client's presented certificate will be available within the SSLClientAuthentication event, where the server can again choose to accept (or reject) incoming connections.

Once the connection is complete (or fails), the 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 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 SendBytes and SendText methods.

While a connection is active, incoming data from a connection will be available within the DataIn 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 method can be called, disabling the reception of incoming data from a particular connection. Data reception can later be enabled via the ProcessData 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 DefaultIdleTimeout 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 DefaultIdleTimeout to work as intended, DoEvents must be called frequently in both console and form-based applications (e.g., using a loop or timer).

Finally, once a connection ends, 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 DefaultIdleTimeout and KeepAlive functionality, it is important to note that DoEvents must be called regularly in both console and form-based applications.

For DefaultIdleTimeout, DoEvents must be called frequently to ensure that idle connections are handled and removed in a timely manner. For KeepAlive, DoEvents 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 DefaultIdleTimeout is set to 0 and KeepAlive 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.

Method List

---

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

Event List

---

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

Config Settings

---

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

ConnectionCount Property (IPWorksDTLS_DTLSServer Class)

The number of records in the Connection arrays.

Object Oriented Interface

public function getConnectionCount();


public function setConnectionCount($value);

Procedural Interface

ipworksdtls_dtlsserver_get($res, 1 );


ipworksdtls_dtlsserver_set($res, 1, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ConnectionConnectionId
• ConnectionLocalHost
• ConnectionLocalPort
• ConnectionRemoteHost
• ConnectionRemotePort

The array indices start at 0 and end at ConnectionCount - 1.

This property is not available at design time.

Data Type

Integer

ConnectionConnectionId Property (IPWorksDTLS_DTLSServer Class)

This property contains an identifier generated by the class to identify each connection.

Object Oriented Interface

public function getConnectionConnectionId($connectionid);

Procedural Interface

ipworksdtls_dtlsserver_get($res, 2 , $connectionid);

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 $connectionid parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

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

Data Type

Integer

ConnectionLocalHost Property (IPWorksDTLS_DTLSServer Class)

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

Object Oriented Interface

public function getConnectionLocalHost($connectionid);

Procedural Interface

ipworksdtls_dtlsserver_get($res, 3 , $connectionid);

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 $connectionid parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

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

Data Type

String

ConnectionLocalPort Property (IPWorksDTLS_DTLSServer Class)

This property indicates the UDP port on the local host or user-assigned IP interface through which connections are initiated or accepted.

Object Oriented Interface

public function getConnectionLocalPort($connectionid);

Procedural Interface

ipworksdtls_dtlsserver_get($res, 4 , $connectionid);

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 $connectionid parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

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

Data Type

Integer

ConnectionRemoteHost Property (IPWorksDTLS_DTLSServer Class)

This property indicates the IP address of the remote host through which the connection is coming.

Object Oriented Interface

public function getConnectionRemoteHost($connectionid);

Procedural Interface

ipworksdtls_dtlsserver_get($res, 5 , $connectionid);

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 $connectionid parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

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

Data Type

String

ConnectionRemotePort Property (IPWorksDTLS_DTLSServer Class)

This property indicates the UDP port on the remote host through which the connection is coming.

Object Oriented Interface

public function getConnectionRemotePort($connectionid);

Procedural Interface

ipworksdtls_dtlsserver_get($res, 6 , $connectionid);

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 $connectionid parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

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

Data Type

Integer

DefaultIdleTimeout Property (IPWorksDTLS_DTLSServer Class)

This property includes the default idle timeout for inactive clients.

Object Oriented Interface

public function getDefaultIdleTimeout();


public function setDefaultIdleTimeout($value);

Procedural Interface

ipworksdtls_dtlsserver_get($res, 7 );


ipworksdtls_dtlsserver_set($res, 7, $value );

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

If set to 0 (default), no idle timeout is applied.

Note: DoEvents must be called for the class to check existing connections.

Data Type

Integer

KeepAlive Property (IPWorksDTLS_DTLSServer Class)

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

Object Oriented Interface

public function getKeepAlive();


public function setKeepAlive($value);

Procedural Interface

ipworksdtls_dtlsserver_get($res, 8 );


ipworksdtls_dtlsserver_set($res, 8, $value );

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, DoEvents 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

Listening Property (IPWorksDTLS_DTLSServer Class)

This property indicates whether the class is listening for incoming connections on LocalPort.

Object Oriented Interface

public function getListening();

Procedural Interface

ipworksdtls_dtlsserver_get($res, 9 );

Default Value

false

Remarks

This property indicates whether the class is listening for connections on the port specified by the LocalPort property. Use the StartListening and StopListening methods to control whether the class is listening.

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

Data Type

Boolean

LocalHost Property (IPWorksDTLS_DTLSServer Class)

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

Object Oriented Interface

public function getLocalHost();


public function setLocalHost($value);

Procedural Interface

ipworksdtls_dtlsserver_get($res, 10 );


ipworksdtls_dtlsserver_set($res, 10, $value );

Default Value

''

Remarks

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

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

If the class is connected, the LocalHost 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 (IPWorksDTLS_DTLSServer Class)

This property includes the Transmission Control Protocol (TCP) port in the local host where the class listens.

Object Oriented Interface

public function getLocalPort();


public function setLocalPort($value);

Procedural Interface

ipworksdtls_dtlsserver_get($res, 11 );


ipworksdtls_dtlsserver_set($res, 11, $value );

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.

Data Type

Integer

SSLAuthenticateClients Property (IPWorksDTLS_DTLSServer Class)

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

Object Oriented Interface

public function getSSLAuthenticateClients();


public function setSSLAuthenticateClients($value);

Procedural Interface

ipworksdtls_dtlsserver_get($res, 12 );


ipworksdtls_dtlsserver_set($res, 12, $value );

Default Value

false

Remarks

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

Data Type

Boolean

SSLCertEffectiveDate Property (IPWorksDTLS_DTLSServer Class)

This is the date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

ipworksdtls_dtlsserver_get($res, 13 );

Default Value

''

Remarks

This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertEncoded Property (IPWorksDTLS_DTLSServer Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

ipworksdtls_dtlsserver_get($res, 14 );


ipworksdtls_dtlsserver_set($res, 14, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertExpirationDate Property (IPWorksDTLS_DTLSServer Class)

This is the date the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

ipworksdtls_dtlsserver_get($res, 15 );

Default Value

''

Remarks

This is the date the certificate expires. After this date, the certificate will no longer be valid. 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 (IPWorksDTLS_DTLSServer Class)

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

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

ipworksdtls_dtlsserver_get($res, 16 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertFingerprint Property (IPWorksDTLS_DTLSServer Class)

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

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

ipworksdtls_dtlsserver_get($res, 17 );

Default Value

''

Remarks

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (IPWorksDTLS_DTLSServer Class)

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

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

ipworksdtls_dtlsserver_get($res, 18 );

Default Value

''

Remarks

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (IPWorksDTLS_DTLSServer Class)

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

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

ipworksdtls_dtlsserver_get($res, 19 );

Default Value

''

Remarks

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (IPWorksDTLS_DTLSServer Class)

This is the issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

ipworksdtls_dtlsserver_get($res, 20 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (IPWorksDTLS_DTLSServer Class)

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

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

ipworksdtls_dtlsserver_get($res, 21 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (IPWorksDTLS_DTLSServer Class)

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

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

ipworksdtls_dtlsserver_get($res, 22 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (IPWorksDTLS_DTLSServer Class)

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

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

ipworksdtls_dtlsserver_get($res, 23 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKey Property (IPWorksDTLS_DTLSServer Class)

This is the public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

ipworksdtls_dtlsserver_get($res, 24 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (IPWorksDTLS_DTLSServer Class)

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

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

ipworksdtls_dtlsserver_get($res, 25 );

Default Value

''

Remarks

This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (IPWorksDTLS_DTLSServer Class)

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

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

ipworksdtls_dtlsserver_get($res, 26 );

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (IPWorksDTLS_DTLSServer Class)

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

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

ipworksdtls_dtlsserver_get($res, 27 );

Default Value

''

Remarks

This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (IPWorksDTLS_DTLSServer Class)

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

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

ipworksdtls_dtlsserver_get($res, 28 );

Default Value

''

Remarks

The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (IPWorksDTLS_DTLSServer Class)

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

Object Oriented Interface

public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface

ipworksdtls_dtlsserver_get($res, 29 );


ipworksdtls_dtlsserver_set($res, 29, $value );

Default Value

'MY'

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (IPWorksDTLS_DTLSServer Class)

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

Object Oriented Interface

public function getSSLCertStorePassword();


public function setSSLCertStorePassword($value);

Procedural Interface

ipworksdtls_dtlsserver_get($res, 30 );


ipworksdtls_dtlsserver_set($res, 30, $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 (IPWorksDTLS_DTLSServer Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

ipworksdtls_dtlsserver_get($res, 31 );


ipworksdtls_dtlsserver_set($res, 31, $value );

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (IPWorksDTLS_DTLSServer Class)

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

Object Oriented Interface

public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface

ipworksdtls_dtlsserver_get($res, 32 );


ipworksdtls_dtlsserver_set($res, 32, $value );

Default Value

''

Remarks

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

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

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

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

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

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

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

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

Data Type

String

SSLCertSubjectAltNames Property (IPWorksDTLS_DTLSServer Class)

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

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

ipworksdtls_dtlsserver_get($res, 33 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (IPWorksDTLS_DTLSServer Class)

This property contains the MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

ipworksdtls_dtlsserver_get($res, 34 );

Default Value

''

Remarks

This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (IPWorksDTLS_DTLSServer Class)

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

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

ipworksdtls_dtlsserver_get($res, 35 );

Default Value

''

Remarks

This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (IPWorksDTLS_DTLSServer Class)

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

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

ipworksdtls_dtlsserver_get($res, 36 );

Default Value

''

Remarks

This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (IPWorksDTLS_DTLSServer Class)

This property contains the text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

ipworksdtls_dtlsserver_get($res, 37 );

Default Value

''

Remarks

This property contains the text description of SSLCertUsageFlags.

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

• Digital Signatures
• Key Authentication
• Key Encryption
• Data Encryption
• Key Agreement
• Certificate Signing
• Key Signing

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

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

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

ipworksdtls_dtlsserver_get($res, 38 );

Default Value

0

Remarks

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

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

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

This property is read-only.

Data Type

Integer

SSLCertVersion Property (IPWorksDTLS_DTLSServer Class)

This property contains the certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

ipworksdtls_dtlsserver_get($res, 39 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

Config Method (IPWorksDTLS_DTLSServer Class)

This method sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksdtls_dtlsserver_do_config($res, $configurationstring);

Remarks

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

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

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

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Disconnect Method (IPWorksDTLS_DTLSServer Class)

This method disconnects the specified client.

Object Oriented Interface

public function doDisconnect($connectionid);

Procedural Interface

ipworksdtls_dtlsserver_do_disconnect($res, $connectionid);

Remarks

Calling this method will disconnect the client specified by the ConnectionId parameter.

DoEvents Method (IPWorksDTLS_DTLSServer Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworksdtls_dtlsserver_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 (IPWorksDTLS_DTLSServer Class)

This method pauses data reception.

Object Oriented Interface

public function doPauseData($connectionid);

Procedural Interface

ipworksdtls_dtlsserver_do_pausedata($res, $connectionid);

Remarks

This method pauses data reception for the connection identified by ConnectionId when called. While data reception is paused, the DataIn event will not fire for the specified connection. Call ProcessData to reenable data reception.

ProcessData Method (IPWorksDTLS_DTLSServer Class)

This method reenables data reception after a call to PauseData .

Object Oriented Interface

public function doProcessData($connectionid);

Procedural Interface

ipworksdtls_dtlsserver_do_processdata($res, $connectionid);

Remarks

This method reenables data reception for the connection identified by ConnectionId after a previous call to PauseData. When PauseData is called, the DataIn event will not fire for the specified connection. To reenable data reception and allow DataIn to fire, call this method.

Note: This method is used only after previously calling PauseData. It does not need to be called to process incoming data by default.

Reset Method (IPWorksDTLS_DTLSServer Class)

This method will reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksdtls_dtlsserver_do_reset($res);

Remarks

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

SendBytes Method (IPWorksDTLS_DTLSServer Class)

This method sends binary data to the specified client.

Object Oriented Interface

public function doSendBytes($connectionid, $data);

Procedural Interface

ipworksdtls_dtlsserver_do_sendbytes($res, $connectionid, $data);

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 SendText method instead.

SendText Method (IPWorksDTLS_DTLSServer Class)

This method sends text to the specified client.

Object Oriented Interface

public function doSendText($connectionid, $text);

Procedural Interface

ipworksdtls_dtlsserver_do_sendtext($res, $connectionid, $text);

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 SendBytes method instead.

Shutdown Method (IPWorksDTLS_DTLSServer Class)

This method shuts down the server.

Object Oriented Interface

public function doShutdown();

Procedural Interface

ipworksdtls_dtlsserver_do_shutdown($res);

Remarks

This method shuts down the server. Calling this method is equivalent to calling StopListening and then breaking every client connection by calling Disconnect.

StartListening Method (IPWorksDTLS_DTLSServer Class)

This method starts listening for incoming connections.

Object Oriented Interface

public function doStartListening();

Procedural Interface

ipworksdtls_dtlsserver_do_startlistening($res);

Remarks

This method begins listening for incoming connections on the port specified by LocalPort. Once listening, events will fire as new clients connect and data are transferred.

To stop listening for new connections, call StopListening. To stop listening for new connections and to disconnect all existing clients, call Shutdown.

StopListening Method (IPWorksDTLS_DTLSServer Class)

This method stops listening for new connections.

Object Oriented Interface

public function doStopListening();

Procedural Interface

ipworksdtls_dtlsserver_do_stoplistening($res);

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.

Connected Event (IPWorksDTLS_DTLSServer Class)

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

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

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

Parameter List

 'connectionid'
 'sourceaddr'
 'sourceport'
 'statuscode'
 'description'

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.

ConnectionRequest Event (IPWorksDTLS_DTLSServer Class)

This event is fired when a request for connection comes from a remote host.

Object Oriented Interface

public function fireConnectionRequest($param);

Procedural Interface

ipworksdtls_dtlsserver_register_callback($res, 2, array($this, 'fireConnectionRequest'));

Parameter List

 'address'
 'port'
 'accept'

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.

DataIn Event (IPWorksDTLS_DTLSServer Class)

This event is fired when data is received.

Object Oriented Interface

public function fireDataIn($param);

Procedural Interface

ipworksdtls_dtlsserver_register_callback($res, 3, array($this, 'fireDataIn'));

Parameter List

 'connectionid'
 'datagram'

Remarks

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

Disconnected Event (IPWorksDTLS_DTLSServer Class)

This event is fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

ipworksdtls_dtlsserver_register_callback($res, 4, array($this, 'fireDisconnected'));

Parameter List

 'connectionid'
 'statuscode'
 'description'

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.

Error Event (IPWorksDTLS_DTLSServer Class)

This event fires information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksdtls_dtlsserver_register_callback($res, 5, array($this, 'fireError'));

Parameter List

 'connectionid'
 'errorcode'
 'description'

Remarks

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

Log Event (IPWorksDTLS_DTLSServer Class)

This event fires once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworksdtls_dtlsserver_register_callback($res, 6, array($this, 'fireLog'));

Parameter List

 'connectionid'
 'loglevel'
 'message'
 'logtype'

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:

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 PITrail 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"

SSLClientAuthentication Event (IPWorksDTLS_DTLSServer Class)

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

Object Oriented Interface

public function fireSSLClientAuthentication($param);

Procedural Interface

ipworksdtls_dtlsserver_register_callback($res, 7, array($this, 'fireSSLClientAuthentication'));

Parameter List

 'connectionid'
 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

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

SSLStatus Event (IPWorksDTLS_DTLSServer Class)

This event is fired to show the progress of the secure connection.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

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

Parameter List

 'connectionid'
 'message'

Remarks

The event is fired for informational and logging purposes only. It is used to track the progress of the connection.

Config Settings (DTLSServer Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

DTLSServer Config Settings

UDP Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (DTLSServer Class)

DTLSServer Errors