# DTLSServer Component The DTLSServer component provides server-side functionality for secure UDP communication utilizing the Datagram Transport Layer Security (DTLS) protocol. ## Syntax ```text TipwDTLSServer ``` ## Remarks The DTLSServer component 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](#sslcert-property-dtlsserver-component). Note the certificate must contain a private key. After doing so, calling [StartListening](#startlistening-method-dtlsserver-component) will cause the component to start listening for incoming connections. The component will listen on the interface defined by [LocalHost](#localhost-property-dtlsserver-component) and [LocalPort](#localport-property-dtlsserver-component), if specified. Otherwise, these values will be set by the component. If applicable, these values must be set before calling [StartListening](#startlistening-method-dtlsserver-component). For example: ```csharp //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 component can now accept (or reject) incoming connections. The first indicator of an incoming connection will be through the [ConnectionRequest](#connectionrequest-event-dtlsserver-component) event. Here, the connection's originating address and port can be queried. By default, the component 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](#sslstatus-event-dtlsserver-component) event. By default, the client is not required to present a certificate to the server. To force this, the [SSLAuthenticateClients](#sslauthenticateclients-property-dtlsserver-component) property can be enabled. When enabled, the client's presented certificate will be available within the [SSLClientAuthentication](#sslclientauthentication-event-dtlsserver-component) event, where the server can again choose to accept (or reject) incoming connections. Once the connection is complete (or fails), the [Connected](#connected-event-dtlsserver-component) 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 [Connections](#connections-property-dtlsserver-component) collection. Each connection will be assigned a unique *ConnectionId*, which can be acquired for a given connection within the [Connected](#connected-event-dtlsserver-component) event. For example: ```csharp 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.SSLAuthenticateClients = true; dtlsserver.StartListening(); Console.WriteLine("Listening on: " + dtlsserver.LocalHost + ":" + dtlsserver.LocalPort); while (dtlsserver.Listening) { dtlsserver.DoEvents(); } ``` ### Sending and Receiving Data The component can send data to individual connections, specified by the *ConnectionId* parameter, via the [SendBytes](#sendbytes-method-dtlsserver-component) and [SendText](#sendtext-method-dtlsserver-component) methods. While a connection is active, incoming data from a connection will be available within the [DataIn](#datain-event-dtlsserver-component) event. Note that this event is non-reentrant, and it is recommended to offload time-consuming operations to ensure the best performance. If required, the [PauseData](#pausedata-method-dtlsserver-component) method can be called, disabling the reception of incoming data from a particular connection. Data reception can later be enabled via the [ProcessData](#processdata-method-dtlsserver-component) method. Note that if this reception is disabled for a connection, the connection may continue sending data, which will remain unprocessed by the component. 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: ```csharp 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](#disconnect-method-dtlsserver-component) must be called with the corresponding *ConnectionId*. In order to remove inactive connections, the [DefaultIdleTimeout](#defaultidletimeout-property-dtlsserver-component) 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](#defaultidletimeout-property-dtlsserver-component) to work as intended, [DoEvents](#doevents-method-dtlsserver-component) must be called frequently in **both** console and form-based applications (e.g., using a loop or timer). Finally, once a connection ends, [Disconnected](#disconnected-event-dtlsserver-component) 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 [Connections](#connections-property-dtlsserver-component) collection. For example: ```csharp 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](#defaultidletimeout-property-dtlsserver-component) and [KeepAlive](#keepalive-property-dtlsserver-component) functionality, it is important to note that [DoEvents](#doevents-method-dtlsserver-component) **must** be called regularly in both console and form-based applications. For [DefaultIdleTimeout](#defaultidletimeout-property-dtlsserver-component), [DoEvents](#doevents-method-dtlsserver-component) must be called frequently to ensure that idle connections are handled and removed in a timely manner. For [KeepAlive](#keepalive-property-dtlsserver-component), [DoEvents](#doevents-method-dtlsserver-component) must be called frequently to ensure the component sends keep-alive (or Heartbeat) packets to existing connections in a timely manner. In form-based applications, this does not apply if [DefaultIdleTimeout](#defaultidletimeout-property-dtlsserver-component) is set to *0* and [KeepAlive](#keepalive-property-dtlsserver-component) is *False*. ## Property List *The following is the full list of the properties of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Connections](#connections-property-dtlsserver-component) | This property includes a collection of currently connected clients. | | [DefaultIdleTimeout](#defaultidletimeout-property-dtlsserver-component) | This property includes the default idle timeout for inactive clients. | | [KeepAlive](#keepalive-property-dtlsserver-component) | When True, keep-alive functionality is enabled via the DTLS Heartbeat Extension. | | [Listening](#listening-property-dtlsserver-component) | This property indicates whether the component is listening for incoming connections on LocalPort. | | [LocalHost](#localhost-property-dtlsserver-component) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [LocalPort](#localport-property-dtlsserver-component) | This property includes the User Datagram Protocol (UDP) port in the local host where the component listens. | | [SSLAuthenticateClients](#sslauthenticateclients-property-dtlsserver-component) | If set to True, the server asks the client(s) for a certificate. | | [SSLCert](#sslcert-property-dtlsserver-component) | The certificate to be used during Secure Sockets Layer (SSL) negotiation. | ## Method List *The following is the full list of the methods of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Config](#config-method-dtlsserver-component) | Sets or retrieves a configuration setting. | | [Disconnect](#disconnect-method-dtlsserver-component) | This method disconnects the specified client. | | [DoEvents](#doevents-method-dtlsserver-component) | This method processes events from the internal message queue. | | [PauseData](#pausedata-method-dtlsserver-component) | This method pauses data reception. | | [ProcessData](#processdata-method-dtlsserver-component) | This method reenables data reception after a call to PauseData . | | [Reset](#reset-method-dtlsserver-component) | This method will reset the component. | | [SendBytes](#sendbytes-method-dtlsserver-component) | This method sends binary data to the specified client. | | [SendText](#sendtext-method-dtlsserver-component) | This method sends text to the specified client. | | [Shutdown](#shutdown-method-dtlsserver-component) | This method shuts down the server. | | [StartListening](#startlistening-method-dtlsserver-component) | This method starts listening for incoming connections. | | [StopListening](#stoplistening-method-dtlsserver-component) | This method stops listening for new connections. | ## Event List *The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Connected](#connected-event-dtlsserver-component) | This event is fired immediately after a connection completes (or fails). | | [ConnectionRequest](#connectionrequest-event-dtlsserver-component) | This event is fired when a request for connection comes from a remote host. | | [DataIn](#datain-event-dtlsserver-component) | This event is fired when data is received. | | [Disconnected](#disconnected-event-dtlsserver-component) | This event is fired when a connection is closed. | | [Error](#error-event-dtlsserver-component) | This event fires information about errors during data delivery. | | [Log](#log-event-dtlsserver-component) | This event fires once for each log message. | | [SSLClientAuthentication](#sslclientauthentication-event-dtlsserver-component) | This event is fired when the client presents its credentials to the server. | | [SSLStatus](#sslstatus-event-dtlsserver-component) | This event is fired to show the progress of the secure connection. | ## Config Settings *The following is a list of config settings for the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in seconds, to be used when a HeartbeatRequest is sent and no response is received. | | [KeepAliveMode](#KeepAliveMode) | Specifies the Heartbeat (or keep-alive) mode to be used by the component. | | [KeepAliveTime](#KeepAliveTime) | The inactivity time, in seconds, before a HeartbeatRequest is sent. | | [LogLevel](#LogLevel) | This configuration controls the level of detail that is logged through the Log event. | | [MaxConnections](#MaxConnections) | Specifies the maximum number of simultaneous connections the server can maintain. | | [CaptureIPPacketInfo](#CaptureIPPacketInfo) | Used to capture the packet information. | | [DelayHostResolution](#DelayHostResolution) | Whether the hostname is resolved when RemoteHost is set. | | [DestinationAddress](#DestinationAddress) | Used to get the destination address from the packet information. | | [DontFragment](#DontFragment) | Used to set the Don't Fragment flag of outgoing packets. | | [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. | | [LocalPort](#LocalPort) | The port in the local host where the component binds. | | [MaxPacketSize](#MaxPacketSize) | The maximum length of the packets that can be received. | | [QOSDSCPValue](#QOSDSCPValue) | Used to specify an arbitrary QOS/DSCP setting (optional). | | [QOSTrafficType](#QOSTrafficType) | Used to specify QOS/DSCP settings (optional). | | [ShareLocalPort](#ShareLocalPort) | If set to True, allows more than one instance of the component to be active on the same local port. | | [UseConnection](#UseConnection) | Determines whether to use a connected socket. | | [UseIPv6](#UseIPv6) | Whether or not to use IPv6. | | [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. | | [FirewallData](#FirewallData) | Used to send extra data to the firewall. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | | [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged. | | [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. | | [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. | | [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. | | [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. | | [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. | | [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. | | [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | Specifies the cipher suites to be used during TLS negotiation. | | [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. | | [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. | | [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. | | [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. | | [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. | | [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. | | [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. | | [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. | | [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. | | [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. | | [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. | | [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. | | [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # Connections Property ([DTLSServer](#dtlsserver-component) Component) This property includes a collection of currently connected clients. ## Syntax *Delphi Syntax* ```text property Connections: TipwDTLSConnectionList read get_Connections write set_Connections; ``` ## Remarks This property includes a collection of currently connected clients. All of the connections may be managed using this property. Each connection is described by different fields of the [DTLSConnection](#dtlsconnection-type) type. The collection is a hash-table type of collection, in which the *ConnectionId* string is used as the key to the desired connection. You may acquire the key for a given connection through the [Connected](#connected-event-dtlsserver-component) event. **Example (Broadcasting Data)** ```text foreach (DTLSConnection c in dtlsserver.Connections.Values) { dtlsserver.SendText(c.ConnectionId, "Hello world!"); } ``` This property is not available at design time. Please refer to the [DTLSConnection](#dtlsconnection-type) type for a complete list of fields. # DefaultIdleTimeout Property ([DTLSServer](#dtlsserver-component) Component) This property includes the default idle timeout for inactive clients. ## Syntax *Delphi Syntax* ```text property DefaultIdleTimeout: Integer read get_DefaultIdleTimeout write set_DefaultIdleTimeout; ``` ## Default Value 0 ## Remarks This property specifies the idle timeout (in seconds) for clients. When set to a positive value, the component 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](#doevents-method-dtlsserver-component) must be called for the component to check existing connections. # KeepAlive Property ([DTLSServer](#dtlsserver-component) Component) When True, keep-alive functionality is enabled via the DTLS Heartbeat Extension. ## Syntax *Delphi Syntax* ```text property KeepAlive: Boolean read get_KeepAlive write set_KeepAlive; ``` ## 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](#doevents-method-dtlsserver-component) 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 ([DTLSServer](#dtlsserver-component) Component) This property indicates whether the component is listening for incoming connections on LocalPort. ## Syntax *Delphi Syntax* ```text property Listening: Boolean read get_Listening; ``` ## Default Value false ## Remarks This property indicates whether the component is listening for connections on the port specified by the [LocalPort](#localport-property-dtlsserver-component) property. Use the [StartListening](#startlistening-method-dtlsserver-component) and [StopListening](#stoplistening-method-dtlsserver-component) methods to control whether the component is listening. This property is read-only and not available at design time. # LocalHost Property ([DTLSServer](#dtlsserver-component) Component) The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax *Delphi Syntax* ```text property LocalHost: String read get_LocalHost write set_LocalHost; ``` ## 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 component initiate connections (or accept in the case of server components) 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 component 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. # LocalPort Property ([DTLSServer](#dtlsserver-component) Component) This property includes the User Datagram Protocol (UDP) port in the local host where the component listens. ## Syntax *Delphi Syntax* ```text property LocalPort: Integer read get_LocalPort write set_LocalPort; ``` ## Default Value 0 ## Remarks This property must be set before the component 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 component is listening (i.e., after successfully calling the [StartListening](#startlistening-method-dtlsserver-component) method). The service port is not shared among servers so two components cannot be listening on the same port at the same time. # SSLAuthenticateClients Property ([DTLSServer](#dtlsserver-component) Component) If set to True, the server asks the client(s) for a certificate. ## Syntax *Delphi Syntax* ```text property SSLAuthenticateClients: Boolean read get_SSLAuthenticateClients write set_SSLAuthenticateClients; ``` ## Default Value false ## Remarks This property is used in conjunction with the [SSLClientAuthentication](#sslclientauthentication-event-dtlsserver-component) event. Please refer to the documentation of the [SSLClientAuthentication](#sslclientauthentication-event-dtlsserver-component) event for details. # SSLCert Property ([DTLSServer](#dtlsserver-component) Component) The certificate to be used during Secure Sockets Layer (SSL) negotiation. ## Syntax *Delphi Syntax* ```text property SSLCert: TipwCertificate read get_SSLCert write set_SSLCert; ``` ## Remarks This property includes the digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the [Encoded](#Certificate_f_Encoded) field to the encoded certificate. To select a certificate, use the store and subject fields. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # Config Method ([DTLSServer](#dtlsserver-component) Component) Sets or retrieves a configuration setting. ## Syntax *Delphi Syntax* ```text function Config(ConfigurationString: String): String; ``` ## Remarks Config is a generic method available in every component. It is used to set and retrieve [configuration settings](#config-settings-dtlsserver-component) for the component. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these *internal properties* is provided through the Config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#config-settings-dtlsserver-component), you must call *Config("PROPERTY")*. The value will be returned as a string. # Disconnect Method ([DTLSServer](#dtlsserver-component) Component) This method disconnects the specified client. ## Syntax *Delphi Syntax* ```text procedure Disconnect(ConnectionId: Integer); ``` ## Remarks Calling this method will disconnect the client specified by the *ConnectionId* parameter. # DoEvents Method ([DTLSServer](#dtlsserver-component) Component) This method processes events from the internal message queue. ## Syntax *Delphi Syntax* ```text procedure DoEvents(); ``` ## Remarks When DoEvents is called, the component processes any available events. If no events are available, it waits for a preset period of time, and then returns. # PauseData Method ([DTLSServer](#dtlsserver-component) Component) This method pauses data reception. ## Syntax *Delphi Syntax* ```text procedure PauseData(ConnectionId: Integer); ``` ## Remarks This method pauses data reception for the connection identified by *ConnectionId* when called. While data reception is paused, the [DataIn](#datain-event-dtlsserver-component) event will not fire for the specified connection. Call [ProcessData](#processdata-method-dtlsserver-component) to reenable data reception. # ProcessData Method ([DTLSServer](#dtlsserver-component) Component) This method reenables data reception after a call to PauseData . ## Syntax *Delphi Syntax* ```text procedure ProcessData(ConnectionId: Integer); ``` ## Remarks This method reenables data reception for the connection identified by *ConnectionId* after a previous call to [PauseData](#pausedata-method-dtlsserver-component). When [PauseData](#pausedata-method-dtlsserver-component) is called, the [DataIn](#datain-event-dtlsserver-component) event will not fire for the specified connection. To reenable data reception and allow [DataIn](#datain-event-dtlsserver-component) to fire, call this method. NOTE: This method is used only after previously calling [PauseData](#pausedata-method-dtlsserver-component). It does not need to be called to process incoming data by default. # Reset Method ([DTLSServer](#dtlsserver-component) Component) This method will reset the component. ## Syntax *Delphi Syntax* ```text procedure Reset(); ``` ## Remarks This method will reset the component's properties to their default values. # SendBytes Method ([DTLSServer](#dtlsserver-component) Component) This method sends binary data to the specified client. ## Syntax *Delphi Syntax* ```text procedure SendBytes(ConnectionId: Integer; Data: TBytes); ``` ## Remarks This method sends binary data to the client identified by *ConnectionId*. For example: ```text 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](#sendtext-method-dtlsserver-component) method instead. # SendText Method ([DTLSServer](#dtlsserver-component) Component) This method sends text to the specified client. ## Syntax *Delphi Syntax* ```text procedure SendText(ConnectionId: Integer; Text: String); ``` ## Remarks This method sends text to the client identified by *ConnectionId*. For example: ```text string dataToSend = "Hello world!"; foreach (DTLSConnection c in dtlsserver.Connections.Values) { dtlsserver.SendText(c.ConnectionId, dataToSend); } ``` To send binary data, use the [SendBytes](#sendbytes-method-dtlsserver-component) method instead. # Shutdown Method ([DTLSServer](#dtlsserver-component) Component) This method shuts down the server. ## Syntax *Delphi Syntax* ```text procedure Shutdown(); ``` ## Remarks This method shuts down the server. Calling this method is equivalent to calling [StopListening](#stoplistening-method-dtlsserver-component) and then breaking every client connection by calling [Disconnect](#disconnect-method-dtlsserver-component). # StartListening Method ([DTLSServer](#dtlsserver-component) Component) This method starts listening for incoming connections. ## Syntax *Delphi Syntax* ```text procedure StartListening(); ``` ## Remarks This method begins listening for incoming connections on the port specified by [LocalPort](#localport-property-dtlsserver-component). Once listening, events will fire as new clients connect and data are transferred. To stop listening for new connections, call [StopListening](#stoplistening-method-dtlsserver-component). To stop listening for new connections and to disconnect all existing clients, call [Shutdown](#shutdown-method-dtlsserver-component). # StopListening Method ([DTLSServer](#dtlsserver-component) Component) This method stops listening for new connections. ## Syntax *Delphi Syntax* ```text procedure StopListening(); ``` ## 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](#shutdown-method-dtlsserver-component) instead. # Connected Event ([DTLSServer](#dtlsserver-component) Component) This event is fired immediately after a connection completes (or fails). ## Syntax *Delphi Syntax* ```text type TConnectedEvent = procedure ( Sender: TObject; ConnectionId: Integer; const SourceAddr: String; SourcePort: Integer; StatusCode: Integer; const Description: String ) of Object; property OnConnected: TConnectedEvent read FOnConnected write FOnConnected; ``` ## 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](#trappable-errors-dtlsserver-component) section for more information. # ConnectionRequest Event ([DTLSServer](#dtlsserver-component) Component) This event is fired when a request for connection comes from a remote host. ## Syntax *Delphi Syntax* ```text type TConnectionRequestEvent = procedure ( Sender: TObject; const Address: String; Port: Integer; var Accept: Boolean ) of Object; property OnConnectionRequest: TConnectionRequestEvent read FOnConnectionRequest write FOnConnectionRequest; ``` ## 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 ([DTLSServer](#dtlsserver-component) Component) This event is fired when data is received. ## Syntax *Delphi Syntax* ```text type TDataInEvent = procedure ( Sender: TObject; ConnectionId: Integer; const Datagram: String; const DatagramB: TBytes ) of Object; property OnDataIn: TDataInEvent read FOnDataIn write FOnDataIn; ``` ## Remarks The DataIn event is fired every time a new datagram is received. *ConnectionId* indicates the unique Id of the [DTLSConnection](#dtlsconnection-type) 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 ([DTLSServer](#dtlsserver-component) Component) This event is fired when a connection is closed. ## Syntax *Delphi Syntax* ```text type TDisconnectedEvent = procedure ( Sender: TObject; ConnectionId: Integer; StatusCode: Integer; const Description: String ) of Object; property OnDisconnected: TDisconnectedEvent read FOnDisconnected write FOnDisconnected; ``` ## 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](#trappable-errors-dtlsserver-component) section for more information. # Error Event ([DTLSServer](#dtlsserver-component) Component) This event fires information about errors during data delivery. ## Syntax *Delphi Syntax* ```text type TErrorEvent = procedure ( Sender: TObject; ConnectionId: Integer; ErrorCode: Integer; const Description: String ) of Object; property OnError: TErrorEvent read FOnError write FOnError; ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally, the component raises an exception. *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](#trappable-errors-dtlsserver-component) section. *ConnectionId* indicates the connection for which the error is applicable. # Log Event ([DTLSServer](#dtlsserver-component) Component) This event fires once for each log message. ## Syntax *Delphi Syntax* ```text type TLogEvent = procedure ( Sender: TObject; ConnectionId: Integer; LogLevel: Integer; const Message: String; const LogType: String ) of Object; property OnLog: TLogEvent read FOnLog write FOnLog; ``` ## Remarks This event fires once for each log message generated by the component. The verbosity is controlled by the [LogLevel](#LogLevel) setting. *ConnectionId* identifies the connection to which the log message applies. *LogLevel* indicates the detail level of the message. Possible values are as follows: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data are logged. | | 3 (Debug) | Debug data are logged. | *Message* is the log entry. *LogType* identifies the type of log entry. Possible values are as follows: - "Info" - "Error" - "Verbose" - "Debug" # SSLClientAuthentication Event ([DTLSServer](#dtlsserver-component) Component) This event is fired when the client presents its credentials to the server. ## Syntax *Delphi Syntax* ```text type TSSLClientAuthenticationEvent = procedure ( Sender: TObject; ConnectionId: Integer; const CertEncoded: String; const CertEncodedB: TBytes; const CertSubject: String; const CertIssuer: String; const Status: String; var Accept: Boolean ) of Object; property OnSSLClientAuthentication: TSSLClientAuthenticationEvent read FOnSSLClientAuthentication write FOnSSLClientAuthentication; ``` ## 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 ([DTLSServer](#dtlsserver-component) Component) This event is fired to show the progress of the secure connection. ## Syntax *Delphi Syntax* ```text type TSSLStatusEvent = procedure ( Sender: TObject; ConnectionId: Integer; const Message: String ) of Object; property OnSSLStatus: TSSLStatusEvent read FOnSSLStatus write FOnSSLStatus; ``` ## Remarks The event is fired for informational and logging purposes only. It is used to track the progress of the connection. # Certificate Type This is the digital certificate being used. ## Remarks This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates. The following fields are available: - [EffectiveDate](#Certificate_f_EffectiveDate) - [Encoded](#Certificate_f_Encoded) - [ExpirationDate](#Certificate_f_ExpirationDate) - [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage) - [Fingerprint](#Certificate_f_Fingerprint) - [FingerprintSHA1](#Certificate_f_FingerprintSHA1) - [FingerprintSHA256](#Certificate_f_FingerprintSHA256) - [Issuer](#Certificate_f_Issuer) - [PrivateKey](#Certificate_f_PrivateKey) - [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) - [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer) - [PublicKey](#Certificate_f_PublicKey) - [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm) - [PublicKeyLength](#Certificate_f_PublicKeyLength) - [SerialNumber](#Certificate_f_SerialNumber) - [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm) - [Store](#Certificate_f_Store) - [StorePassword](#Certificate_f_StorePassword) - [StoreType](#Certificate_f_StoreType) - [Subject](#Certificate_f_Subject) - [SubjectAltNames](#Certificate_f_SubjectAltNames) - [ThumbprintMD5](#Certificate_f_ThumbprintMD5) - [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1) - [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256) - [Usage](#Certificate_f_Usage) - [UsageFlags](#Certificate_f_UsageFlags) - [Version](#Certificate_f_Version) ## Fields **EffectiveDate** *String (read-only)* *Default Value: ""* 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. **Encoded** *String* *Default Value: ""* The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) properties also may be used to specify a certificate. When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string. **EncodedB** *TBytes* *Default Value: ""* The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) properties also may be used to specify a certificate. When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string. **ExpirationDate** *String (read-only)* *Default Value: ""* 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. **ExtendedKeyUsage** *String (read-only)* *Default Value: ""* A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). **Fingerprint** *String (read-only)* *Default Value: ""* 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* **FingerprintSHA1** *String (read-only)* *Default Value: ""* 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* **FingerprintSHA256** *String (read-only)* *Default Value: ""* 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* **Issuer** *String (read-only)* *Default Value: ""* The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. **PrivateKey** *String (read-only)* *Default Value: ""* The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [PrivateKey](#Certificate_f_PrivateKey) may be available but not exportable. In this case, [PrivateKey](#Certificate_f_PrivateKey) returns an empty string. **PrivateKeyAvailable** *Boolean (read-only)* *Default Value: False* Whether a [PrivateKey](#Certificate_f_PrivateKey) is available for the selected certificate. If [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) is True, the certificate may be used for authentication purposes (e.g., server authentication). **PrivateKeyContainer** *String (read-only)* *Default Value: ""* The name of the [PrivateKey](#Certificate_f_PrivateKey) container for the certificate (if available). This functionality is available only on Windows platforms. **PublicKey** *String (read-only)* *Default Value: ""* The public key of the certificate. The key is provided as PEM/Base64-encoded data. **PublicKeyAlgorithm** *String (read-only)* *Default Value: ""* 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. **PublicKeyLength** *Integer (read-only)* *Default Value: 0* The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. **SerialNumber** *String (read-only)* *Default Value: ""* 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. **SignatureAlgorithm** *String (read-only)* *Default Value: ""* 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. **Store** *String* *Default Value: "MY"* The name of the certificate store for the client certificate. The [StoreType](#Certificate_f_StoreType) property denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword). [Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) property to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_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). **StoreB** *TBytes* *Default Value: "MY"* The name of the certificate store for the client certificate. The [StoreType](#Certificate_f_StoreType) property denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword). [Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) property to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_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). **StorePassword** *String* *Default Value: ""* If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. **StoreType** *TipwCertStoreTypes* *Default Value: 0* The type of certificate store for this certificate. The component supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the component will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [StoreType](#Certificate_f_StoreType), the full path of the PKCS#11 DLL as the [Store](#Certificate_f_Store), and the PIN as the [StorePassword](#Certificate_f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) component by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [Store](#Certificate_f_Store) and set [StorePassword](#Certificate_f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | **Subject** *String* *Default Value: ""* The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. **SubjectAltNames** *String (read-only)* *Default Value: ""* Comma-separated lists of alternative subject names for the certificate. **ThumbprintMD5** *String (read-only)* *Default Value: ""* 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. **ThumbprintSHA1** *String (read-only)* *Default Value: ""* 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. **ThumbprintSHA256** *String (read-only)* *Default Value: ""* 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. **Usage** *String (read-only)* *Default Value: ""* The text description of [UsageFlags](#Certificate_f_UsageFlags). 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. **UsageFlags** *Integer (read-only)* *Default Value: 0* The flags that show intended use for the certificate. The value of [UsageFlags](#Certificate_f_UsageFlags) 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 [Usage](#Certificate_f_Usage) property for a text representation of [UsageFlags](#Certificate_f_UsageFlags). This functionality currently is not available when the provider is OpenSSL. **Version** *String (read-only)* *Default Value: ""* The certificate's version number. The possible values are the strings "V1", "V2", and "V3". ## Constructors > *Delphi Syntax* ```text constructor Create(); ``` Creates a instance whose properties can be set. > *Delphi Syntax* ```text constructor Create(valEncoded: TBytes); ``` Parses * Encoded * as an X.509 public key. > *Delphi Syntax* ```text constructor Create(valStoreType: TipwCertStoreTypes; valStore: String; valStorePassword: String; valSubject: String); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. > *Delphi Syntax* ```text constructor Create(valStoreType: TipwCertStoreTypes; valStore: TBytes; valStorePassword: String; valSubject: String); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. # DTLSConnection Type This is a currently connected client. ## Remarks This type describes the connection of a client that is currently connected to the component. You may use the different fields of this type to manage the connection. The following fields are available: - [ConnectionId](#DTLSConnection_f_ConnectionId) - [LocalHost](#DTLSConnection_f_LocalHost) - [LocalPort](#DTLSConnection_f_LocalPort) - [RemoteHost](#DTLSConnection_f_RemoteHost) - [RemotePort](#DTLSConnection_f_RemotePort) ## Fields **ConnectionId** *Integer (read-only)* *Default Value: 0* This property contains an identifier generated by the component to identify each connection. This identifier is unique to this connection. **LocalHost** *String (read-only)* *Default Value: ""* This property indicates the name of the local host or user-assigned IP interface through which connections are initiated or accepted. **LocalPort** *Integer (read-only)* *Default Value: 0* This property indicates the UDP port on the local host or user-assigned IP interface through which connections are initiated or accepted. **RemoteHost** *String (read-only)* *Default Value: ""* 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 component 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. **RemotePort** *Integer (read-only)* *Default Value: 0* 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. ## Constructors *Delphi Syntax* ```text constructor Create(); ``` # Config Settings ([DTLSServer](#dtlsserver-component) Component) The component 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 component, access to these *internal properties* is provided through the [Config](#config-method-dtlsserver-component) method. ### DTLSServer Config Settings **KeepAliveInterval**: The retry interval, in seconds, to be used when a HeartbeatRequest is sent and no response is received.This configuration specifies the retry interval, in seconds, to be used when a HeartbeatRequest message is sent and no response is received. HeartbeatRequest messages are only sent if the Heartbeat Extension is supported by the remote host. The component will send a HeartbeatRequest message after a specified period of inactivity, defined by [KeepAliveTime](#KeepAliveTime). This value specifies the interval at which the component sends successive HeartbeatRequest messages, assuming no response is received from the remote host (HeartbeatResponse). By default, this value is 2 seconds and will only apply if [KeepAlive](#keepalive-property-dtlsserver-component) is true. **KeepAliveMode**: Specifies the Heartbeat (or keep-alive) mode to be used by the component.This configuration specifies the Heartbeat (or keep-alive) mode to be used by the component, as defined in RFC 6520. When [KeepAlive](#keepalive-property-dtlsserver-component) is true, the following values are applicable: | | | | --- | --- | | 1 | peer_allowed_to_send (default) | | 2 | peer_not_allowed_to_send | When set to 1 (peer_allowed_to_send), the component can both a) send HeartbeatRequest messages and b) receive and respond to HeartbeatRequest messages. When set to 2 (peer_not_allowed_to_send), the component will only be capable of sending HeartbeatRequests. Note, if [KeepAlive](#keepalive-property-dtlsserver-component) is false, Heartbeat functionality will be disabled. The component will not be capable of sending or handling HeartbeatRequest messages. **KeepAliveTime**: The inactivity time, in seconds, before a HeartbeatRequest is sent.This configuration specifies the inactivity time, in seconds, before sending a HeartbeatRequest message. HeartbeatRequest messages are only sent if the Heartbeat Extension is supported by the remote host. If the connection is inactive for the specified time, the component will send a HeartbeatRequest message to the remote host. If no response is received, the component will continue sending Heartbeats every [KeepAliveInterval](#KeepAliveInterval) seconds. By default, this value is 60 seconds and will only apply if [KeepAlive](#keepalive-property-dtlsserver-component) is true. **LogLevel**: This configuration controls the level of detail that is logged through the Log event.This configuration controls the level of detail that is logged through the [Log](#log-event-dtlsserver-component) event. Possible values are as follows: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data are logged. | | 3 (Debug) | Debug data are logged. | **MaxConnections**: Specifies the maximum number of simultaneous connections the server can maintain.This configuration specifies the maximum number of simultaneous connections the server can maintain. While there is no predefined limit on the maximum number of simultaneous connections, please use caution when increasing the value of this configuration. ### UDP Config Settings **CaptureIPPacketInfo**: Used to capture the packet information.If this configuration setting is set to True, the component will capture the IP packet information. The default value for this setting is False. NOTE: This setting is available only in Windows. **DelayHostResolution**: Whether the hostname is resolved when RemoteHost is set.This configuration setting specifies whether a hostname is resolved immediately when RemoteHost is set. If *True* the component will resolve the hostname and the IP address will be present in the RemoteHost property. If *False*, the hostname is not resolved until needed by the component when a method to connect or send data is called. If desired, ResolveRemoteHost may be called to manually resolve the value in RemoteHost at any time. The default value is *False*. **DestinationAddress**: Used to get the destination address from the packet information.If [CaptureIPPacketInfo](#CaptureIPPacketInfo) is set to True, then this will be populated with the packet's destination address when a packet is received. This information will be accessible in the DataIn event. NOTE: This setting is available only in Windows. **DontFragment**: Used to set the Don't Fragment flag of outgoing packets.When this configuration setting is set to True, packets sent by the component will have the *Don't Fragment* flag set. The default value is False. **LocalHost**: The name of the local host through which connections are initiated or accepted. The [LocalHost](#localhost-property-dtlsserver-component) setting contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface. If the component is connected, the [LocalHost](#localhost-property-dtlsserver-component) setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). **LocalPort**: The port in the local host where the component binds. This configuration setting must be set before a connection is attempted. It instructs the component to bind to a specific port (or communication endpoint) in the local machine. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by [LocalPort](#localport-property-dtlsserver-component) after the connection is established. [LocalPort](#localport-property-dtlsserver-component) cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems. **MaxPacketSize**: The maximum length of the packets that can be received.This configuration setting specifies the maximum size of the datagrams that the component will accept without truncation. **QOSDSCPValue**: Used to specify an arbitrary QOS/DSCP setting (optional).To use this configuration setting, [UseConnection](#UseConnection) must be True. This option allows you to specify an arbitrary DiffServ Code Point (DSCP) value between 0 and 63. The default is 0. When set to the default value, the component will not set a DSCP value. NOTE: This setting uses the qWAVE API and is available only on Windows 7, Windows Server 2008 R2, and later. **QOSTrafficType**: Used to specify QOS/DSCP settings (optional).To use this configuration setting, [UseConnection](#UseConnection) must be True. You may specify either the text or integer values: BestEffort (0), Background (1), ExcellentEffort (2), AudioVideo (3), Voice (4), and Control (5). NOTE: This setting uses the qWAVE API and is available only on Windows Vista and Windows Server 2008 or above. NOTE: QOSTrafficType must be set before setting Active to True. **ShareLocalPort**: If set to True, allows more than one instance of the component to be active on the same local port.This option must be set before the component is activated through the Active property or it will have no effect. The default value for this setting is False. **UseConnection**: Determines whether to use a connected socket.[UseConnection](#UseConnection) specifies whether or not the component should use a connected socket. The connection is defined as an association in between the local address/port and the remote address/port. As such, this is not a connection in the traditional Transmission Control Protocol (TCP) sense. It means only that the component will send and receive data to and from the specified destination. The default value for this setting is False. **UseIPv6**: Whether or not to use IPv6.By default, the component expects an IPv4 address for local and remote host properties and will create an IPv4 socket. To use IPv6 instead, set this to True. ### Socket Config Settings **AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within Timeout seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout. NOTE: This option is not valid for User Datagram Protocol (UDP) ports. **FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes). **InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. **OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. ### SSL Config Settings **LogSSLPackets**: Controls whether SSL packets are logged.This configuration setting controls whether SSL packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes. When enabled, SSL packet logs are output using the [SSLStatus](#sslstatus-event-dtlsserver-component) event, which will fire each time a SSL packet is sent or received. **ReuseSSLSession**: Determines if the SSL session is reused. If set to True, the component 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 component is the same. **SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When SSLProvider is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the [SSLCert](#sslcert-property-dtlsserver-component) property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the component will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the component will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The component will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the component raises an exception. When set to 0 (default), the CRL check will not be performed by the component. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the component will use OCSP to check the validity of the server certificate. If set to 1 or 2, the component will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The component will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the component raises an exception. When set to 0 (default), the component will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated. NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [SSLStatus](#sslstatus-event-dtlsserver-component) event. Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting. **SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when [SSLAuthenticateClients](#sslauthenticateclients-property-dtlsserver-component) is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLEnabledCipherSuites**: Specifies the cipher suites to be used during TLS negotiation.This configuration is used to specify the cipher suites to be used during TLS negotiation. By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the component will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. For example: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA"); ``` Possible cipher suites include the following: - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_256_GCM_SHA384 - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_DSS_WITH_AES_256_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 - TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 - TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA - TLS_DHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA - TLS_DHE_DSS_WITH_AES_256_CBC_SHA - TLS_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_DSS_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_DES_CBC_SHA - TLS_DHE_RSA_WITH_DES_CBC_SHA - TLS_DHE_DSS_WITH_DES_CBC_SHA - TLS_RSA_WITH_RC4_128_MD5 - TLS_RSA_WITH_RC4_128_SHA **SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols. The default value is *3072*. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values: | | | | --- | --- | | TLS1.2 | 3072 (Hex C00) (Default - Client and Server) | **SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *False* by default, but it can be set to *True* to enable the extension. This configuration setting is applicable only when SSLProvider is set to *Internal*. **SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes. When set, the component 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 component will only append, it will not overwrite previous values. NOTE: This configuration setting is applicable only when SSLProvider is set to *Internal*. **SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipher[connId]"); ``` **SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherStrength[connId]"); ``` **SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherSuite[connId]"); ``` **SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchange[connId]"); ``` **SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchangeStrength[connId]"); ``` **SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedVersion[connId]"); ``` **SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions: | | | | --- | --- | | 0x00000001 | Ignore time validity status of certificate. | | 0x00000002 | Ignore time validity status of CTL. | | 0x00000004 | Ignore non-nested certificate times. | | 0x00000010 | Allow unknown certificate authority. | | 0x00000020 | Ignore wrong certificate usage. | | 0x00000100 | Ignore unknown certificate revocation status. | | 0x00000200 | Ignore unknown CTL signer revocation status. | | 0x00000400 | Ignore unknown certificate authority revocation status. | | 0x00000800 | Ignore unknown root revocation status. | | 0x00008000 | Allow test root certificate. | | 0x00004000 | Trust test root certificate. | | 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). | This functionality is currently not available when the provider is OpenSSL. **SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when SSLProvider is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2. When specified the component 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 component raises an exception. The format of this value is a comma-separated list of hash-signature combinations. For instance: ```csharp component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); ``` The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*. To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. **TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC. The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*. When using TLS 1.2 and SSLProvider is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported: - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: | | | | --- | --- | | Identifier | Name | | 037 | IBM EBCDIC - U.S./Canada | | 437 | OEM - United States | | 500 | IBM EBCDIC - International | | 708 | Arabic - ASMO 708 | | 709 | Arabic - ASMO 449+, BCON V4 | | 710 | Arabic - Transparent Arabic | | 720 | Arabic - Transparent ASMO | | 737 | OEM - Greek (formerly 437G) | | 775 | OEM - Baltic | | 850 | OEM - Multilingual Latin I | | 852 | OEM - Latin II | | 855 | OEM - Cyrillic (primarily Russian) | | 857 | OEM - Turkish | | 858 | OEM - Multilingual Latin I + Euro symbol | | 860 | OEM - Portuguese | | 861 | OEM - Icelandic | | 862 | OEM - Hebrew | | 863 | OEM - Canadian-French | | 864 | OEM - Arabic | | 865 | OEM - Nordic | | 866 | OEM - Russian | | 869 | OEM - Modern Greek | | 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) | | 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) | | 875 | IBM EBCDIC - Modern Greek | | 932 | ANSI/OEM - Japanese, Shift-JIS | | 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) | | 949 | ANSI/OEM - Korean (Unified Hangul Code) | | 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) | | 1026 | IBM EBCDIC - Turkish (Latin-5) | | 1047 | IBM EBCDIC - Latin 1/Open System | | 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) | | 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) | | 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) | | 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) | | 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) | | 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) | | 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) | | 1147 | IBM EBCDIC - France (20297 + Euro symbol) | | 1148 | IBM EBCDIC - International (500 + Euro symbol) | | 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) | | 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) | | 1201 | Unicode UCS-2 Big-Endian | | 1250 | ANSI - Central European | | 1251 | ANSI - Cyrillic | | 1252 | ANSI - Latin I | | 1253 | ANSI - Greek | | 1254 | ANSI - Turkish | | 1255 | ANSI - Hebrew | | 1256 | ANSI - Arabic | | 1257 | ANSI - Baltic | | 1258 | ANSI/OEM - Vietnamese | | 1361 | Korean (Johab) | | 10000 | MAC - Roman | | 10001 | MAC - Japanese | | 10002 | MAC - Traditional Chinese (Big5) | | 10003 | MAC - Korean | | 10004 | MAC - Arabic | | 10005 | MAC - Hebrew | | 10006 | MAC - Greek I | | 10007 | MAC - Cyrillic | | 10008 | MAC - Simplified Chinese (GB 2312) | | 10010 | MAC - Romania | | 10017 | MAC - Ukraine | | 10021 | MAC - Thai | | 10029 | MAC - Latin II | | 10079 | MAC - Icelandic | | 10081 | MAC - Turkish | | 10082 | MAC - Croatia | | 12000 | Unicode UCS-4 Little-Endian | | 12001 | Unicode UCS-4 Big-Endian | | 20000 | CNS - Taiwan | | 20001 | TCA - Taiwan | | 20002 | Eten - Taiwan | | 20003 | IBM5550 - Taiwan | | 20004 | TeleText - Taiwan | | 20005 | Wang - Taiwan | | 20105 | IA5 IRV International Alphabet No. 5 (7-bit) | | 20106 | IA5 German (7-bit) | | 20107 | IA5 Swedish (7-bit) | | 20108 | IA5 Norwegian (7-bit) | | 20127 | US-ASCII (7-bit) | | 20261 | T.61 | | 20269 | ISO 6937 Non-Spacing Accent | | 20273 | IBM EBCDIC - Germany | | 20277 | IBM EBCDIC - Denmark/Norway | | 20278 | IBM EBCDIC - Finland/Sweden | | 20280 | IBM EBCDIC - Italy | | 20284 | IBM EBCDIC - Latin America/Spain | | 20285 | IBM EBCDIC - United Kingdom | | 20290 | IBM EBCDIC - Japanese Katakana Extended | | 20297 | IBM EBCDIC - France | | 20420 | IBM EBCDIC - Arabic | | 20423 | IBM EBCDIC - Greek | | 20424 | IBM EBCDIC - Hebrew | | 20833 | IBM EBCDIC - Korean Extended | | 20838 | IBM EBCDIC - Thai | | 20866 | Russian - KOI8-R | | 20871 | IBM EBCDIC - Icelandic | | 20880 | IBM EBCDIC - Cyrillic (Russian) | | 20905 | IBM EBCDIC - Turkish | | 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) | | 20932 | JIS X 0208-1990 & 0121-1990 | | 20936 | Simplified Chinese (GB2312) | | 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) | | 21027 | Extended Alpha Lowercase | | 21866 | Ukrainian (KOI8-U) | | 28591 | ISO 8859-1 Latin I | | 28592 | ISO 8859-2 Central Europe | | 28593 | ISO 8859-3 Latin 3 | | 28594 | ISO 8859-4 Baltic | | 28595 | ISO 8859-5 Cyrillic | | 28596 | ISO 8859-6 Arabic | | 28597 | ISO 8859-7 Greek | | 28598 | ISO 8859-8 Hebrew | | 28599 | ISO 8859-9 Latin 5 | | 28605 | ISO 8859-15 Latin 9 | | 29001 | Europa 3 | | 38598 | ISO 8859-8 Hebrew | | 50220 | ISO 2022 Japanese with no halfwidth Katakana | | 50221 | ISO 2022 Japanese with halfwidth Katakana | | 50222 | ISO 2022 Japanese JIS X 0201-1989 | | 50225 | ISO 2022 Korean | | 50227 | ISO 2022 Simplified Chinese | | 50229 | ISO 2022 Traditional Chinese | | 50930 | Japanese (Katakana) Extended | | 50931 | US/Canada and Japanese | | 50933 | Korean Extended and Korean | | 50935 | Simplified Chinese Extended and Simplified Chinese | | 50936 | Simplified Chinese | | 50937 | US/Canada and Traditional Chinese | | 50939 | Japanese (Latin) Extended and Japanese | | 51932 | EUC - Japanese | | 51936 | EUC - Simplified Chinese | | 51949 | EUC - Korean | | 51950 | EUC - Traditional Chinese | | 52936 | HZ-GB2312 Simplified Chinese | | 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) | | 57002 | ISCII Devanagari | | 57003 | ISCII Bengali | | 57004 | ISCII Tamil | | 57005 | ISCII Telugu | | 57006 | ISCII Assamese | | 57007 | ISCII Oriya | | 57008 | ISCII Kannada | | 57009 | ISCII Malayalam | | 57010 | ISCII Gujarati | | 57011 | ISCII Punjabi | | 65000 | Unicode UTF-7 | | 65001 | Unicode UTF-8 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | Identifier | Name | | 1 | ASCII | | 2 | NEXTSTEP | | 3 | JapaneseEUC | | 4 | UTF8 | | 5 | ISOLatin1 | | 6 | Symbol | | 7 | NonLossyASCII | | 8 | ShiftJIS | | 9 | ISOLatin2 | | 10 | Unicode | | 11 | WindowsCP1251 | | 12 | WindowsCP1252 | | 13 | WindowsCP1253 | | 14 | WindowsCP1254 | | 15 | WindowsCP1250 | | 21 | ISO2022JP | | 30 | MacOSRoman | | 10 | UTF16String | | 0x90000100 | UTF16BigEndian | | 0x94000100 | UTF16LittleEndian | | 0x8c000100 | UTF32String | | 0x98000100 | UTF32BigEndian | | 0x9c000100 | UTF32LittleEndian | | 65536 | Proprietary | **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *True* to mask sensitive data. The default is *True*. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *False*, the component will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *True* tells the component to use the internal implementation instead of using the system security libraries. This setting is set to *False* by default on all platforms. # Trappable Errors ([DTLSServer](#dtlsserver-component) Component) ### 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. |