# DTLSServer Class The DTLSServer class provides server-side functionality of the DTLS protocol. ## Class Name **SecureBlackbox_DTLSServer** ## Procedural Interface ```text secureblackbox_dtlsserver_open(); secureblackbox_dtlsserver_close($res); secureblackbox_dtlsserver_register_callback($res, $id, $function); secureblackbox_dtlsserver_get_last_error($res); secureblackbox_dtlsserver_get_last_error_code($res); secureblackbox_dtlsserver_set($res, $id, $index, $value); secureblackbox_dtlsserver_get($res, $id, $index); secureblackbox_dtlsserver_do_broadcastdata($res, $connectionid, $data); secureblackbox_dtlsserver_do_broadcasttext($res, $connectionid, $text); secureblackbox_dtlsserver_do_cleanup($res); secureblackbox_dtlsserver_do_config($res, $configurationstring); secureblackbox_dtlsserver_do_doaction($res, $actionid, $actionparams); secureblackbox_dtlsserver_do_dropclient($res, $connectionid, $forced); secureblackbox_dtlsserver_do_exportkeymaterial($res, $connectionid, $lbl, $context, $len); secureblackbox_dtlsserver_do_listclients($res); secureblackbox_dtlsserver_do_pinclient($res, $connectionid); secureblackbox_dtlsserver_do_processplaindata($res, $connectionid, $buffer); secureblackbox_dtlsserver_do_reset($res); secureblackbox_dtlsserver_do_senddata($res, $connectionid, $buffer); secureblackbox_dtlsserver_do_sendkeepalive($res, $connectionid); secureblackbox_dtlsserver_do_sendplaindata($res, $connectionid, $buffer); secureblackbox_dtlsserver_do_sendtext($res, $connectionid, $text); secureblackbox_dtlsserver_do_start($res); secureblackbox_dtlsserver_do_stop($res); ``` ## Remarks Use this component to receive data over a protected DTLS channel in your application. ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Active](#active-property-secureblackbox_dtlsserver-class) | Indicates whether the server is active and is listening to new connections. | | [BoundPort](#boundport-property-secureblackbox_dtlsserver-class) | Indicates the bound listening port. | | [ExternalCryptoAsyncDocumentID](#externalcryptoasyncdocumentid-property-secureblackbox_dtlsserver-class) | Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. | | [ExternalCryptoCustomParams](#externalcryptocustomparams-property-secureblackbox_dtlsserver-class) | Custom parameters to be passed to the signing service (uninterpreted). | | [ExternalCryptoData](#externalcryptodata-property-secureblackbox_dtlsserver-class) | Additional data to be included in the async state and mirrored back by the requestor. | | [ExternalCryptoExternalHashCalculation](#externalcryptoexternalhashcalculation-property-secureblackbox_dtlsserver-class) | Specifies whether the message hash is to be calculated at the external endpoint. | | [ExternalCryptoHashAlgorithm](#externalcryptohashalgorithm-property-secureblackbox_dtlsserver-class) | Specifies the request's signature hash algorithm. | | [ExternalCryptoKeyID](#externalcryptokeyid-property-secureblackbox_dtlsserver-class) | The ID of the pre-shared key used for DC request authentication. | | [ExternalCryptoKeySecret](#externalcryptokeysecret-property-secureblackbox_dtlsserver-class) | The pre-shared key used for DC request authentication. | | [ExternalCryptoMethod](#externalcryptomethod-property-secureblackbox_dtlsserver-class) | Specifies the asynchronous signing method. | | [ExternalCryptoMode](#externalcryptomode-property-secureblackbox_dtlsserver-class) | Specifies the external cryptography mode. | | [ExternalCryptoPublicKeyAlgorithm](#externalcryptopublickeyalgorithm-property-secureblackbox_dtlsserver-class) | Provide the public key algorithm here if the certificate is not available on the pre-signing stage. | | [FIPSMode](#fipsmode-property-secureblackbox_dtlsserver-class) | Reserved. | | [Host](#host-property-secureblackbox_dtlsserver-class) | The host to bind the listening port to. | | [PinnedClientAEADCipher](#pinnedclientaeadcipher-property-secureblackbox_dtlsserver-class) | Indicates whether the encryption algorithm used is an AEAD cipher. | | [PinnedClientChainValidationDetails](#pinnedclientchainvalidationdetails-property-secureblackbox_dtlsserver-class) | The details of a certificate chain validation outcome. | | [PinnedClientChainValidationResult](#pinnedclientchainvalidationresult-property-secureblackbox_dtlsserver-class) | The outcome of a certificate chain validation routine. | | [PinnedClientCiphersuite](#pinnedclientciphersuite-property-secureblackbox_dtlsserver-class) | The cipher suite employed by this connection. | | [PinnedClientClientAuthenticated](#pinnedclientclientauthenticated-property-secureblackbox_dtlsserver-class) | Specifies whether client authentication was performed during this connection. | | [PinnedClientClientAuthRequested](#pinnedclientclientauthrequested-property-secureblackbox_dtlsserver-class) | Specifies whether client authentication was requested during this connection. | | [PinnedClientConnectionEstablished](#pinnedclientconnectionestablished-property-secureblackbox_dtlsserver-class) | Indicates whether the connection has been established fully. | | [PinnedClientConnectionID](#pinnedclientconnectionid-property-secureblackbox_dtlsserver-class) | The unique identifier assigned to this connection. | | [PinnedClientDigestAlgorithm](#pinnedclientdigestalgorithm-property-secureblackbox_dtlsserver-class) | The digest algorithm used in a TLS-enabled connection. | | [PinnedClientEncryptionAlgorithm](#pinnedclientencryptionalgorithm-property-secureblackbox_dtlsserver-class) | The symmetric encryption algorithm used in a TLS-enabled connection. | | [PinnedClientExportable](#pinnedclientexportable-property-secureblackbox_dtlsserver-class) | Indicates whether a TLS connection uses a reduced-strength exportable cipher. | | [PinnedClientGroup](#pinnedclientgroup-property-secureblackbox_dtlsserver-class) | The elliptic curve used in this connection. | | [PinnedClientID](#pinnedclientid-property-secureblackbox_dtlsserver-class) | The client connection's unique identifier. | | [PinnedClientKeyExchangeAlgorithm](#pinnedclientkeyexchangealgorithm-property-secureblackbox_dtlsserver-class) | The key exchange algorithm used in a TLS-enabled connection. | | [PinnedClientKeyExchangeKeyBits](#pinnedclientkeyexchangekeybits-property-secureblackbox_dtlsserver-class) | The length of the key exchange key of a TLS-enabled connection. | | [PinnedClientPFSCipher](#pinnedclientpfscipher-property-secureblackbox_dtlsserver-class) | Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). | | [PinnedClientPreSharedIdentity](#pinnedclientpresharedidentity-property-secureblackbox_dtlsserver-class) | Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. | | [PinnedClientPreSharedIdentityHint](#pinnedclientpresharedidentityhint-property-secureblackbox_dtlsserver-class) | A hint professed by the server to help the client select the PSK identity to use. | | [PinnedClientPublicKeyBits](#pinnedclientpublickeybits-property-secureblackbox_dtlsserver-class) | The length of the public key. | | [PinnedClientRemoteAddress](#pinnedclientremoteaddress-property-secureblackbox_dtlsserver-class) | The client's IP address. | | [PinnedClientRemotePort](#pinnedclientremoteport-property-secureblackbox_dtlsserver-class) | The remote port of the client connection. | | [PinnedClientResumedSession](#pinnedclientresumedsession-property-secureblackbox_dtlsserver-class) | Indicates whether a TLS-enabled connection was spawned from another TLS connection. | | [PinnedClientSecureConnection](#pinnedclientsecureconnection-property-secureblackbox_dtlsserver-class) | Indicates whether TLS or SSL is enabled for this connection. | | [PinnedClientServerAuthenticated](#pinnedclientserverauthenticated-property-secureblackbox_dtlsserver-class) | Indicates whether server authentication was performed during a TLS-enabled connection. | | [PinnedClientSignatureAlgorithm](#pinnedclientsignaturealgorithm-property-secureblackbox_dtlsserver-class) | The signature algorithm used in a TLS handshake. | | [PinnedClientSymmetricBlockSize](#pinnedclientsymmetricblocksize-property-secureblackbox_dtlsserver-class) | The block size of the symmetric algorithm used. | | [PinnedClientSymmetricKeyBits](#pinnedclientsymmetrickeybits-property-secureblackbox_dtlsserver-class) | The key length of the symmetric algorithm used. | | [PinnedClientTotalBytesReceived](#pinnedclienttotalbytesreceived-property-secureblackbox_dtlsserver-class) | The total number of bytes received over this connection. | | [PinnedClientTotalBytesSent](#pinnedclienttotalbytessent-property-secureblackbox_dtlsserver-class) | The total number of bytes sent over this connection. | | [PinnedClientValidationLog](#pinnedclientvalidationlog-property-secureblackbox_dtlsserver-class) | Contains the server certificate's chain validation log. | | [PinnedClientVersion](#pinnedclientversion-property-secureblackbox_dtlsserver-class) | Indicates the version of SSL/TLS protocol negotiated during this connection. | | [PinnedClientCertCount](#pinnedclientcertcount-property-secureblackbox_dtlsserver-class) | The number of records in the PinnedClientCert arrays. | | [PinnedClientCertBytes](#pinnedclientcertbytes-property-secureblackbox_dtlsserver-class) | Returns the raw certificate data in DER format. | | [PinnedClientCertCAKeyID](#pinnedclientcertcakeyid-property-secureblackbox_dtlsserver-class) | A unique identifier (fingerprint) of the CA certificate's cryptographic key. | | [PinnedClientCertFingerprint](#pinnedclientcertfingerprint-property-secureblackbox_dtlsserver-class) | Contains the fingerprint (a hash imprint) of this certificate. | | [PinnedClientCertHandle](#pinnedclientcerthandle-property-secureblackbox_dtlsserver-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [PinnedClientCertIssuer](#pinnedclientcertissuer-property-secureblackbox_dtlsserver-class) | The common name of the certificate issuer (CA), typically a company name. | | [PinnedClientCertIssuerRDN](#pinnedclientcertissuerrdn-property-secureblackbox_dtlsserver-class) | A list of Property=Value pairs that uniquely identify the certificate issuer. | | [PinnedClientCertKeyAlgorithm](#pinnedclientcertkeyalgorithm-property-secureblackbox_dtlsserver-class) | Specifies the public key algorithm of this certificate. | | [PinnedClientCertKeyBits](#pinnedclientcertkeybits-property-secureblackbox_dtlsserver-class) | Returns the length of the public key in bits. | | [PinnedClientCertKeyFingerprint](#pinnedclientcertkeyfingerprint-property-secureblackbox_dtlsserver-class) | Returns a SHA1 fingerprint of the public key contained in the certificate. | | [PinnedClientCertKeyUsage](#pinnedclientcertkeyusage-property-secureblackbox_dtlsserver-class) | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. | | [PinnedClientCertPublicKeyBytes](#pinnedclientcertpublickeybytes-property-secureblackbox_dtlsserver-class) | Contains the certificate's public key in DER format. | | [PinnedClientCertSelfSigned](#pinnedclientcertselfsigned-property-secureblackbox_dtlsserver-class) | Indicates whether the certificate is self-signed (root) or signed by an external CA. | | [PinnedClientCertSerialNumber](#pinnedclientcertserialnumber-property-secureblackbox_dtlsserver-class) | Returns the certificate's serial number. | | [PinnedClientCertSigAlgorithm](#pinnedclientcertsigalgorithm-property-secureblackbox_dtlsserver-class) | Indicates the algorithm that was used by the CA to sign this certificate. | | [PinnedClientCertSubject](#pinnedclientcertsubject-property-secureblackbox_dtlsserver-class) | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. | | [PinnedClientCertSubjectKeyID](#pinnedclientcertsubjectkeyid-property-secureblackbox_dtlsserver-class) | Contains a unique identifier of the certificate's cryptographic key. | | [PinnedClientCertSubjectRDN](#pinnedclientcertsubjectrdn-property-secureblackbox_dtlsserver-class) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). | | [PinnedClientCertValidFrom](#pinnedclientcertvalidfrom-property-secureblackbox_dtlsserver-class) | The time point at which the certificate becomes valid, in UTC. | | [PinnedClientCertValidTo](#pinnedclientcertvalidto-property-secureblackbox_dtlsserver-class) | The time point at which the certificate expires, in UTC. | | [Port](#port-property-secureblackbox_dtlsserver-class) | Specifies the port number to listen for connections on. | | [PortRangeFrom](#portrangefrom-property-secureblackbox_dtlsserver-class) | Specifies the lower limit of the listening port range for incoming connections. | | [PortRangeTo](#portrangeto-property-secureblackbox_dtlsserver-class) | Specifies the upper limit of the listening port range for incoming connections. | | [SocketIncomingSpeedLimit](#socketincomingspeedlimit-property-secureblackbox_dtlsserver-class) | The maximum number of bytes to read from the socket, per second. | | [SocketLocalAddress](#socketlocaladdress-property-secureblackbox_dtlsserver-class) | The local network interface to bind the socket to. | | [SocketLocalPort](#socketlocalport-property-secureblackbox_dtlsserver-class) | The local port number to bind the socket to. | | [SocketOutgoingSpeedLimit](#socketoutgoingspeedlimit-property-secureblackbox_dtlsserver-class) | The maximum number of bytes to write to the socket, per second. | | [SocketTimeout](#sockettimeout-property-secureblackbox_dtlsserver-class) | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. | | [SocketUseIPv6](#socketuseipv6-property-secureblackbox_dtlsserver-class) | Enables or disables IP protocol version 6. | | [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_dtlsserver-class) | The number of records in the TLSServerCert arrays. | | [TLSServerCertBytes](#tlsservercertbytes-property-secureblackbox_dtlsserver-class) | Returns the raw certificate data in DER format. | | [TLSServerCertHandle](#tlsservercerthandle-property-secureblackbox_dtlsserver-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [TLSAutoValidateCertificates](#tlsautovalidatecertificates-property-secureblackbox_dtlsserver-class) | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. | | [TLSBaseConfiguration](#tlsbaseconfiguration-property-secureblackbox_dtlsserver-class) | Selects the base configuration for the TLS settings. | | [TLSCiphersuites](#tlsciphersuites-property-secureblackbox_dtlsserver-class) | A list of ciphersuites separated with commas or semicolons. | | [TLSClientAuth](#tlsclientauth-property-secureblackbox_dtlsserver-class) | Enables or disables certificate-based client authentication. | | [TLSExtensions](#tlsextensions-property-secureblackbox_dtlsserver-class) | Provides access to TLS extensions. | | [TLSForceResumeIfDestinationChanges](#tlsforceresumeifdestinationchanges-property-secureblackbox_dtlsserver-class) | Whether to force TLS session resumption when the destination address changes. | | [TLSGroups](#tlsgroups-property-secureblackbox_dtlsserver-class) | Specifies a list of key exchange groups to attempt during the TLS key exchange. | | [TLSPreSharedIdentity](#tlspresharedidentity-property-secureblackbox_dtlsserver-class) | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. | | [TLSPreSharedKey](#tlspresharedkey-property-secureblackbox_dtlsserver-class) | Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. | | [TLSPreSharedKeyCiphersuite](#tlspresharedkeyciphersuite-property-secureblackbox_dtlsserver-class) | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. | | [TLSRenegotiationAttackPreventionMode](#tlsrenegotiationattackpreventionmode-property-secureblackbox_dtlsserver-class) | Selects the renegotiation attack prevention mechanism. | | [TLSRevocationCheck](#tlsrevocationcheck-property-secureblackbox_dtlsserver-class) | Specifies the kind(s) of revocation check to perform. | | [TLSSSLOptions](#tlsssloptions-property-secureblackbox_dtlsserver-class) | Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size. | | [TLSMode](#tlsmode-property-secureblackbox_dtlsserver-class) | Specifies the TLS mode to use. | | [TLSUseExtendedMasterSecret](#tlsuseextendedmastersecret-property-secureblackbox_dtlsserver-class) | Enables the Extended Master Secret Extension, as defined in RFC 7627. | | [TLSUseSessionResumption](#tlsusesessionresumption-property-secureblackbox_dtlsserver-class) | Enables or disables the TLS session resumption capability. | | [TLSVersions](#tlsversions-property-secureblackbox_dtlsserver-class) | The SSL/TLS versions to enable by default. | | [WebsiteName](#websitename-property-secureblackbox_dtlsserver-class) | Specifies the web site name to use in the certificate. | ## Method List *The following is the full list of the methods of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [BroadcastData](#broadcastdata-method-secureblackbox_dtlsserver-class) | Broadcasts data to all connections. | | [BroadcastText](#broadcasttext-method-secureblackbox_dtlsserver-class) | Broadcasts a text string to all connections. | | [Cleanup](#cleanup-method-secureblackbox_dtlsserver-class) | Cleans up the server environment by purging expired sessions and cleaning caches. | | [Config](#config-method-secureblackbox_dtlsserver-class) | Sets or retrieves a configuration setting. | | [DoAction](#doaction-method-secureblackbox_dtlsserver-class) | Performs an additional action. | | [DropClient](#dropclient-method-secureblackbox_dtlsserver-class) | Terminates a client connection. | | [ExportKeyMaterial](#exportkeymaterial-method-secureblackbox_dtlsserver-class) | Derives key material from the session's master key using the TLS exporters scheme. | | [ListClients](#listclients-method-secureblackbox_dtlsserver-class) | Enumerates the connected clients. | | [PinClient](#pinclient-method-secureblackbox_dtlsserver-class) | Takes a snapshot of the connection's properties. | | [ProcessPlainData](#processplaindata-method-secureblackbox_dtlsserver-class) | Process a plain data buffer to a connection client. | | [Reset](#reset-method-secureblackbox_dtlsserver-class) | Resets the class settings. | | [SendData](#senddata-method-secureblackbox_dtlsserver-class) | Sends a data buffer to a connection client. | | [SendKeepAlive](#sendkeepalive-method-secureblackbox_dtlsserver-class) | Sends a keep-alive packet. | | [SendPlainData](#sendplaindata-method-secureblackbox_dtlsserver-class) | Sends a data buffer to a connection client. | | [SendText](#sendtext-method-secureblackbox_dtlsserver-class) | Sends a text string to a client. | | [Start](#start-method-secureblackbox_dtlsserver-class) | Starts the DTLS server. | | [Stop](#stop-method-secureblackbox_dtlsserver-class) | Stops the DTLS server. | ## Event List *The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Accept](#accept-event-secureblackbox_dtlsserver-class) | Reports an incoming connection. | | [Connect](#connect-event-secureblackbox_dtlsserver-class) | Reports a new 'connection'. | | [Data](#data-event-secureblackbox_dtlsserver-class) | Supplies a data chunk received from a client. | | [Disconnect](#disconnect-event-secureblackbox_dtlsserver-class) | Fires to report a disconnected client. | | [Error](#error-event-secureblackbox_dtlsserver-class) | Information about errors during data delivery. | | [ExternalSign](#externalsign-event-secureblackbox_dtlsserver-class) | Handles remote or external signing initiated by the server protocol. | | [Notification](#notification-event-secureblackbox_dtlsserver-class) | This event notifies the application about an underlying control flow event. | | [PlainData](#plaindata-event-secureblackbox_dtlsserver-class) | Supplies a plain data chunk received from a client. | | [TLSCertValidate](#tlscertvalidate-event-secureblackbox_dtlsserver-class) | Fires when a client certificate needs to be validated. | | [TLSEstablished](#tlsestablished-event-secureblackbox_dtlsserver-class) | Reports the setup of a TLS session. | | [TLSHandshake](#tlshandshake-event-secureblackbox_dtlsserver-class) | Fires when a newly established client connection initiates a TLS handshake. | | [TLSPSK](#tlspsk-event-secureblackbox_dtlsserver-class) | Requests a pre-shared key for TLS-PSK. | | [TLSShutdown](#tlsshutdown-event-secureblackbox_dtlsserver-class) | Reports closure of a TLS session. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [BoundAddress](#BoundAddress) | Returns the bound address of the listening socket. | | [BoundPort](#BoundPort) | The port that was bound by the server. | | [ClientAuth](#ClientAuth) | Enables or disables certificate-based client authentication. | | [DatagramSize](#DatagramSize) | Specifies maximum size of the datagram. | | [DualStack](#DualStack) | Allows the use of ip4 and ip6 simultaneously. | | [MaxDataSize](#MaxDataSize) | Specifies maximum size of the packet which will not be divided into smaller ones. | | [PreSharedIdentityHint](#PreSharedIdentityHint) | Gets or sets the PSK identity hint. | | [RetransmissionInterval](#RetransmissionInterval) | Specifies value of the retransmission interval. | | [SocketHandle](#SocketHandle) | Returns the socket handle of the connected class. | | [SocketHandle\[i\]](#SocketHandle[i]) | Returns the internal socket handle. | | [SplitLongData](#SplitLongData) | Specifies whether to split long datagrams into smaller ones. | | [SrtpMasterKeyLen](#SrtpMasterKeyLen) | The SRTP master key length. | | [SrtpMasterSaltLen](#SrtpMasterSaltLen) | The SRTP master salt length. | | [TLSExtensions](#TLSExtensions) | TBD. | | [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. | | [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. | | [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. | | [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. | | [Cookies](#Cookies) | Gets or sets local cookies for the class. | | [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. | | [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. | | [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. | | [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. | | [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server classes. | | [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. | | [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. | | [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. | | [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client classes created. | | [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. | | [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. | | [LogDestination](#LogDestination) | Specifies the debug log destination. | | [LogDetails](#LogDetails) | Specifies the debug log details to dump. | | [LogFile](#LogFile) | Specifies the debug log filename. | | [LogFilters](#LogFilters) | Specifies the debug log filters. | | [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. | | [LogLevel](#LogLevel) | Specifies the debug log level. | | [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. | | [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. | | [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. | | [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. | | [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. | | [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. | | [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. | | [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. | | [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. | | [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. | | [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. | | [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. | | [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. | | [Tag](#Tag) | Allows to store any custom data. | | [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. | | [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. | | [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. | | [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. | | [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. | | [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. | | [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. | | [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client classes should use own DNS resolver. | | [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. | | [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. | | [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. | | [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. | | [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. | | [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. | | [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. | | [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. | # Active Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Indicates whether the server is active and is listening to new connections. ## Object Oriented Interface ```text public function getActive(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 1 ); ``` ## Default Value false ## Remarks This read-only property returns True if the server is listening to incoming connections. This property is read-only and not available at design time. ## Data Type Boolean # BoundPort Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Indicates the bound listening port. ## Object Oriented Interface ```text public function getBoundPort(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 2 ); ``` ## Default Value 0 ## Remarks Check this property to find out the port that has been allocated to the server by the system. The bound port always equals [Port](#port-property-secureblackbox_dtlsserver-class) if it is provided, or is allocated dynamically if configured to fall in the range between [PortRangeFrom](#portrangefrom-property-secureblackbox_dtlsserver-class) and [PortRangeTo](#portrangeto-property-secureblackbox_dtlsserver-class) constraints. This property is read-only and not available at design time. ## Data Type Integer # ExternalCryptoAsyncDocumentID Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. ## Object Oriented Interface ```text public function getExternalCryptoAsyncDocumentID(); public function setExternalCryptoAsyncDocumentID($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 3 ); secureblackbox_dtlsserver_set($res, 3, $value ); ``` ## Default Value '' ## Remarks Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses. If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages. ## Data Type String # ExternalCryptoCustomParams Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Custom parameters to be passed to the signing service (uninterpreted). ## Object Oriented Interface ```text public function getExternalCryptoCustomParams(); public function setExternalCryptoCustomParams($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 4 ); secureblackbox_dtlsserver_set($res, 4, $value ); ``` ## Default Value '' ## Remarks Custom parameters to be passed to the signing service (uninterpreted). This property is not available at design time. ## Data Type String # ExternalCryptoData Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Additional data to be included in the async state and mirrored back by the requestor. ## Object Oriented Interface ```text public function getExternalCryptoData(); public function setExternalCryptoData($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 5 ); secureblackbox_dtlsserver_set($res, 5, $value ); ``` ## Default Value '' ## Remarks Additional data to be included in the async state and mirrored back by the requestor. This property is not available at design time. ## Data Type String # ExternalCryptoExternalHashCalculation Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Specifies whether the message hash is to be calculated at the external endpoint. ## Object Oriented Interface ```text public function getExternalCryptoExternalHashCalculation(); public function setExternalCryptoExternalHashCalculation($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 6 ); secureblackbox_dtlsserver_set($res, 6, $value ); ``` ## Default Value false ## Remarks Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class. If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called. ## Data Type Boolean # ExternalCryptoHashAlgorithm Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Specifies the request's signature hash algorithm. ## Object Oriented Interface ```text public function getExternalCryptoHashAlgorithm(); public function setExternalCryptoHashAlgorithm($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 7 ); secureblackbox_dtlsserver_set($res, 7, $value ); ``` ## Default Value 'SHA256' ## Remarks Specifies the request's signature hash algorithm. | | | | | --- | --- | --- | | SB_HASH_ALGORITHM_SHA1 | SHA1 | | | SB_HASH_ALGORITHM_SHA224 | SHA224 | | | SB_HASH_ALGORITHM_SHA256 | SHA256 | | | SB_HASH_ALGORITHM_SHA384 | SHA384 | | | SB_HASH_ALGORITHM_SHA512 | SHA512 | | | SB_HASH_ALGORITHM_MD2 | MD2 | | | SB_HASH_ALGORITHM_MD4 | MD4 | | | SB_HASH_ALGORITHM_MD5 | MD5 | | | SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | | | SB_HASH_ALGORITHM_CRC32 | CRC32 | | | SB_HASH_ALGORITHM_SSL3 | SSL3 | | | SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | | | SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | | | SB_HASH_ALGORITHM_POLY1305 | POLY1305 | | | SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | | | SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | | | SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | | | SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | | | SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | | | SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | | | SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | | | SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | | | SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | | | SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | | | SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | | | SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | | | SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | | | SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | | | SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | | | SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN | | ## Data Type String # ExternalCryptoKeyID Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The ID of the pre-shared key used for DC request authentication. ## Object Oriented Interface ```text public function getExternalCryptoKeyID(); public function setExternalCryptoKeyID($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 8 ); secureblackbox_dtlsserver_set($res, 8, $value ); ``` ## Default Value '' ## Remarks The ID of the pre-shared key used for DC request authentication. Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use [ExternalCryptoKeySecret](#externalcryptokeysecret-property-secureblackbox_dtlsserver-class) to pass the key itself. The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted. Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users. Example: ```text signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789"; ``` ## Data Type String # ExternalCryptoKeySecret Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The pre-shared key used for DC request authentication. ## Object Oriented Interface ```text public function getExternalCryptoKeySecret(); public function setExternalCryptoKeySecret($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 9 ); secureblackbox_dtlsserver_set($res, 9, $value ); ``` ## Default Value '' ## Remarks The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work. Read more about configuring authentication in the [ExternalCryptoKeyID](#externalcryptokeyid-property-secureblackbox_dtlsserver-class) topic. ## Data Type String # ExternalCryptoMethod Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Specifies the asynchronous signing method. ## Object Oriented Interface ```text public function getExternalCryptoMethod(); public function setExternalCryptoMethod($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 10 ); secureblackbox_dtlsserver_set($res, 10, $value ); ``` ## Possible Values ```text DTLSSERVER_EXTERNALCRYPTOMETHOD_PKCS1(0), DTLSSERVER_EXTERNALCRYPTOMETHOD_PKCS7(1) ``` ## Default Value 0 ## Remarks Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup. Available options: | | | | --- | --- | | asmdPKCS1 | 0 | | asmdPKCS7 | 1 | ## Data Type Integer # ExternalCryptoMode Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Specifies the external cryptography mode. ## Object Oriented Interface ```text public function getExternalCryptoMode(); public function setExternalCryptoMode($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 11 ); secureblackbox_dtlsserver_set($res, 11, $value ); ``` ## Possible Values ```text DTLSSERVER_EXTERNALCRYPTOMODE_DEFAULT(0), DTLSSERVER_EXTERNALCRYPTOMODE_DISABLED(1), DTLSSERVER_EXTERNALCRYPTOMODE_GENERIC(2), DTLSSERVER_EXTERNALCRYPTOMODE_DCAUTH(3), DTLSSERVER_EXTERNALCRYPTOMODE_DCAUTH_JSON(4) ``` ## Default Value 0 ## Remarks Specifies the external cryptography mode. Available options: | | | | --- | --- | | ecmDefault | The default value (0) | | ecmDisabled | Do not use DC or external signing (1) | | ecmGeneric | Generic external signing with the OnExternalSign event (2) | | ecmDCAuth | DCAuth signing (3) | | ecmDCAuthJSON | DCAuth signing in JSON format (4) | This property is not available at design time. ## Data Type Integer # ExternalCryptoPublicKeyAlgorithm Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Provide the public key algorithm here if the certificate is not available on the pre-signing stage. ## Object Oriented Interface ```text public function getExternalCryptoPublicKeyAlgorithm(); public function setExternalCryptoPublicKeyAlgorithm($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 12 ); secureblackbox_dtlsserver_set($res, 12, $value ); ``` ## Default Value '' ## Remarks Provide the public key algorithm here if the certificate is not available on the pre-signing stage. | | | | | --- | --- | --- | | SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | | | SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | | | SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | | | SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA | id-dsa | | | SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | | | SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | | | SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | | | SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | | | SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | | | SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | | | SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | | | SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | | | SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | | | SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | | | SB_CERT_ALGORITHM_EC | id-ecPublicKey | | | SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | | | SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | | | SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | | | SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | | | SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | | | SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | | | SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | | | SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | | | SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | | | SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | | | SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | | | SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | | | SB_CERT_ALGORITHM_EDDSA | id-EdDSA | | | SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | ## Data Type String # FIPSMode Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Reserved. ## Object Oriented Interface ```text public function getFIPSMode(); public function setFIPSMode($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 13 ); secureblackbox_dtlsserver_set($res, 13, $value ); ``` ## Default Value false ## Remarks This property is reserved for future use. ## Data Type Boolean # Host Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The host to bind the listening port to. ## Object Oriented Interface ```text public function getHost(); public function setHost($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 14 ); secureblackbox_dtlsserver_set($res, 14, $value ); ``` ## Default Value '' ## Remarks Use this property to specify the IP address on which to listen to incoming connections. ## Data Type String # PinnedClientAEADCipher Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Indicates whether the encryption algorithm used is an AEAD cipher. ## Object Oriented Interface ```text public function getPinnedClientAEADCipher(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 15 ); ``` ## Default Value false ## Remarks Indicates whether the encryption algorithm used is an AEAD cipher. This property is read-only and not available at design time. ## Data Type Boolean # PinnedClientChainValidationDetails Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The details of a certificate chain validation outcome. ## Object Oriented Interface ```text public function getPinnedClientChainValidationDetails(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 16 ); ``` ## Default Value 0 ## Remarks The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result. Returns a bit mask of the following options: | | | | | --- | --- | --- | | cvrBadData | 0x0001 | One or more certificates in the validation path are malformed | | cvrRevoked | 0x0002 | One or more certificates are revoked | | cvrNotYetValid | 0x0004 | One or more certificates are not yet valid | | cvrExpired | 0x0008 | One or more certificates are expired | | cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature | | cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) | | cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA | | cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified | | cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified | | cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate | | cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates | | cvrBlocked | 0x0800 | One or more certificates are blocked | | cvrFailure | 0x1000 | General validation failure | | cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself | | cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements | | cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code | This property is read-only and not available at design time. ## Data Type Integer # PinnedClientChainValidationResult Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The outcome of a certificate chain validation routine. ## Object Oriented Interface ```text public function getPinnedClientChainValidationResult(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 17 ); ``` ## Possible Values ```text DTLSSERVER_PINNEDCLIENTCHAINVALIDATIONRESULT_VALID(0), DTLSSERVER_PINNEDCLIENTCHAINVALIDATIONRESULT_VALID_BUT_UNTRUSTED(1), DTLSSERVER_PINNEDCLIENTCHAINVALIDATIONRESULT_INVALID(2), DTLSSERVER_PINNEDCLIENTCHAINVALIDATIONRESULT_CANT_BE_ESTABLISHED(3) ``` ## Default Value 0 ## Remarks The outcome of a certificate chain validation routine. Available options: | | | | | --- | --- | --- | | cvtValid | 0 | The chain is valid | | cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted | | cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) | | cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) | Use the ValidationLog property to access the detailed validation log. This property is read-only and not available at design time. ## Data Type Integer # PinnedClientCiphersuite Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The cipher suite employed by this connection. ## Object Oriented Interface ```text public function getPinnedClientCiphersuite(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 18 ); ``` ## Default Value '' ## Remarks The cipher suite employed by this connection. For TLS connections, this property returns the ciphersuite that was/is employed by the connection. This property is read-only and not available at design time. ## Data Type String # PinnedClientClientAuthenticated Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Specifies whether client authentication was performed during this connection. ## Object Oriented Interface ```text public function getPinnedClientClientAuthenticated(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 19 ); ``` ## Default Value false ## Remarks Specifies whether client authentication was performed during this connection. This property is read-only and not available at design time. ## Data Type Boolean # PinnedClientClientAuthRequested Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Specifies whether client authentication was requested during this connection. ## Object Oriented Interface ```text public function getPinnedClientClientAuthRequested(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 20 ); ``` ## Default Value false ## Remarks Specifies whether client authentication was requested during this connection. This property is read-only and not available at design time. ## Data Type Boolean # PinnedClientConnectionEstablished Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Indicates whether the connection has been established fully. ## Object Oriented Interface ```text public function getPinnedClientConnectionEstablished(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 21 ); ``` ## Default Value false ## Remarks Indicates whether the connection has been established fully. This property is read-only and not available at design time. ## Data Type Boolean # PinnedClientConnectionID Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The unique identifier assigned to this connection. ## Object Oriented Interface ```text public function getPinnedClientConnectionID(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 22 ); ``` ## Remarks The unique identifier assigned to this connection. This property is read-only and not available at design time. ## Data Type Byte Array # PinnedClientDigestAlgorithm Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The digest algorithm used in a TLS-enabled connection. ## Object Oriented Interface ```text public function getPinnedClientDigestAlgorithm(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 23 ); ``` ## Default Value '' ## Remarks The digest algorithm used in a TLS-enabled connection. This property is read-only and not available at design time. ## Data Type String # PinnedClientEncryptionAlgorithm Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The symmetric encryption algorithm used in a TLS-enabled connection. ## Object Oriented Interface ```text public function getPinnedClientEncryptionAlgorithm(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 24 ); ``` ## Default Value '' ## Remarks The symmetric encryption algorithm used in a TLS-enabled connection. This property is read-only and not available at design time. ## Data Type String # PinnedClientExportable Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Indicates whether a TLS connection uses a reduced-strength exportable cipher. ## Object Oriented Interface ```text public function getPinnedClientExportable(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 25 ); ``` ## Default Value false ## Remarks Indicates whether a TLS connection uses a reduced-strength exportable cipher. This property is read-only and not available at design time. ## Data Type Boolean # PinnedClientGroup Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The elliptic curve used in this connection. ## Object Oriented Interface ```text public function getPinnedClientGroup(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 26 ); ``` ## Default Value '' ## Remarks The elliptic curve used in this connection. This property was named *NamedECCurve* in SecureBlackbox 2024 and earlier versions. This property is read-only and not available at design time. ## Data Type String # PinnedClientID Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The client connection's unique identifier. ## Object Oriented Interface ```text public function getPinnedClientID(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 27 ); ``` ## Default Value -1 ## Remarks The client connection's unique identifier. This value is used throughout to refer to a particular client connection. This property is read-only and not available at design time. ## Data Type Long64 # PinnedClientKeyExchangeAlgorithm Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The key exchange algorithm used in a TLS-enabled connection. ## Object Oriented Interface ```text public function getPinnedClientKeyExchangeAlgorithm(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 28 ); ``` ## Default Value '' ## Remarks The key exchange algorithm used in a TLS-enabled connection. This property is read-only and not available at design time. ## Data Type String # PinnedClientKeyExchangeKeyBits Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The length of the key exchange key of a TLS-enabled connection. ## Object Oriented Interface ```text public function getPinnedClientKeyExchangeKeyBits(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 29 ); ``` ## Default Value 0 ## Remarks The length of the key exchange key of a TLS-enabled connection. This property is read-only and not available at design time. ## Data Type Integer # PinnedClientPFSCipher Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). ## Object Oriented Interface ```text public function getPinnedClientPFSCipher(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 30 ); ``` ## Default Value false ## Remarks Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). This property is read-only and not available at design time. ## Data Type Boolean # PinnedClientPreSharedIdentity Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. ## Object Oriented Interface ```text public function getPinnedClientPreSharedIdentity(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 31 ); ``` ## Default Value '' ## Remarks Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. This property is read-only and not available at design time. ## Data Type String # PinnedClientPreSharedIdentityHint Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) A hint professed by the server to help the client select the PSK identity to use. ## Object Oriented Interface ```text public function getPinnedClientPreSharedIdentityHint(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 32 ); ``` ## Default Value '' ## Remarks A hint professed by the server to help the client select the PSK identity to use. This property is read-only and not available at design time. ## Data Type String # PinnedClientPublicKeyBits Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The length of the public key. ## Object Oriented Interface ```text public function getPinnedClientPublicKeyBits(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 33 ); ``` ## Default Value 0 ## Remarks The length of the public key. This property is read-only and not available at design time. ## Data Type Integer # PinnedClientRemoteAddress Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The client's IP address. ## Object Oriented Interface ```text public function getPinnedClientRemoteAddress(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 34 ); ``` ## Default Value '' ## Remarks The client's IP address. This property is read-only and not available at design time. ## Data Type String # PinnedClientRemotePort Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The remote port of the client connection. ## Object Oriented Interface ```text public function getPinnedClientRemotePort(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 35 ); ``` ## Default Value 0 ## Remarks The remote port of the client connection. This property is read-only and not available at design time. ## Data Type Integer # PinnedClientResumedSession Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Indicates whether a TLS-enabled connection was spawned from another TLS connection. ## Object Oriented Interface ```text public function getPinnedClientResumedSession(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 36 ); ``` ## Default Value false ## Remarks Indicates whether a TLS-enabled connection was spawned from another TLS connection This property is read-only and not available at design time. ## Data Type Boolean # PinnedClientSecureConnection Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Indicates whether TLS or SSL is enabled for this connection. ## Object Oriented Interface ```text public function getPinnedClientSecureConnection(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 37 ); ``` ## Default Value false ## Remarks Indicates whether TLS or SSL is enabled for this connection. This property is read-only and not available at design time. ## Data Type Boolean # PinnedClientServerAuthenticated Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Indicates whether server authentication was performed during a TLS-enabled connection. ## Object Oriented Interface ```text public function getPinnedClientServerAuthenticated(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 38 ); ``` ## Default Value false ## Remarks Indicates whether server authentication was performed during a TLS-enabled connection. This property is read-only and not available at design time. ## Data Type Boolean # PinnedClientSignatureAlgorithm Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The signature algorithm used in a TLS handshake. ## Object Oriented Interface ```text public function getPinnedClientSignatureAlgorithm(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 39 ); ``` ## Default Value '' ## Remarks The signature algorithm used in a TLS handshake. This property is read-only and not available at design time. ## Data Type String # PinnedClientSymmetricBlockSize Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The block size of the symmetric algorithm used. ## Object Oriented Interface ```text public function getPinnedClientSymmetricBlockSize(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 40 ); ``` ## Default Value 0 ## Remarks The block size of the symmetric algorithm used. This property is read-only and not available at design time. ## Data Type Integer # PinnedClientSymmetricKeyBits Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The key length of the symmetric algorithm used. ## Object Oriented Interface ```text public function getPinnedClientSymmetricKeyBits(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 41 ); ``` ## Default Value 0 ## Remarks The key length of the symmetric algorithm used. This property is read-only and not available at design time. ## Data Type Integer # PinnedClientTotalBytesReceived Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The total number of bytes received over this connection. ## Object Oriented Interface ```text public function getPinnedClientTotalBytesReceived(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 42 ); ``` ## Default Value 0 ## Remarks The total number of bytes received over this connection. This property is read-only and not available at design time. ## Data Type Long64 # PinnedClientTotalBytesSent Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The total number of bytes sent over this connection. ## Object Oriented Interface ```text public function getPinnedClientTotalBytesSent(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 43 ); ``` ## Default Value 0 ## Remarks The total number of bytes sent over this connection. This property is read-only and not available at design time. ## Data Type Long64 # PinnedClientValidationLog Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Contains the server certificate's chain validation log. ## Object Oriented Interface ```text public function getPinnedClientValidationLog(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 44 ); ``` ## Default Value '' ## Remarks Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures. This property is read-only and not available at design time. ## Data Type String # PinnedClientVersion Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Indicates the version of SSL/TLS protocol negotiated during this connection. ## Object Oriented Interface ```text public function getPinnedClientVersion(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 45 ); ``` ## Default Value '' ## Remarks Indicates the version of SSL/TLS protocol negotiated during this connection. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertCount Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The number of records in the PinnedClientCert arrays. ## Object Oriented Interface ```text public function getPinnedClientCertCount(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 46 ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [PinnedClientCertBytes](#pinnedclientcertbytes-property-secureblackbox_dtlsserver-class) - [PinnedClientCertCAKeyID](#pinnedclientcertcakeyid-property-secureblackbox_dtlsserver-class) - [PinnedClientCertFingerprint](#pinnedclientcertfingerprint-property-secureblackbox_dtlsserver-class) - [PinnedClientCertHandle](#pinnedclientcerthandle-property-secureblackbox_dtlsserver-class) - [PinnedClientCertIssuer](#pinnedclientcertissuer-property-secureblackbox_dtlsserver-class) - [PinnedClientCertIssuerRDN](#pinnedclientcertissuerrdn-property-secureblackbox_dtlsserver-class) - [PinnedClientCertKeyAlgorithm](#pinnedclientcertkeyalgorithm-property-secureblackbox_dtlsserver-class) - [PinnedClientCertKeyBits](#pinnedclientcertkeybits-property-secureblackbox_dtlsserver-class) - [PinnedClientCertKeyFingerprint](#pinnedclientcertkeyfingerprint-property-secureblackbox_dtlsserver-class) - [PinnedClientCertKeyUsage](#pinnedclientcertkeyusage-property-secureblackbox_dtlsserver-class) - [PinnedClientCertPublicKeyBytes](#pinnedclientcertpublickeybytes-property-secureblackbox_dtlsserver-class) - [PinnedClientCertSelfSigned](#pinnedclientcertselfsigned-property-secureblackbox_dtlsserver-class) - [PinnedClientCertSerialNumber](#pinnedclientcertserialnumber-property-secureblackbox_dtlsserver-class) - [PinnedClientCertSigAlgorithm](#pinnedclientcertsigalgorithm-property-secureblackbox_dtlsserver-class) - [PinnedClientCertSubject](#pinnedclientcertsubject-property-secureblackbox_dtlsserver-class) - [PinnedClientCertSubjectKeyID](#pinnedclientcertsubjectkeyid-property-secureblackbox_dtlsserver-class) - [PinnedClientCertSubjectRDN](#pinnedclientcertsubjectrdn-property-secureblackbox_dtlsserver-class) - [PinnedClientCertValidFrom](#pinnedclientcertvalidfrom-property-secureblackbox_dtlsserver-class) - [PinnedClientCertValidTo](#pinnedclientcertvalidto-property-secureblackbox_dtlsserver-class) The array indices start at *0* and end at *PinnedClientCertCount - 1*. This property is read-only and not available at design time. ## Data Type Integer # PinnedClientCertBytes Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Returns the raw certificate data in DER format. ## Object Oriented Interface ```text public function getPinnedClientCertBytes($pinnedclientcertindex); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 47 , $pinnedclientcertindex); ``` ## Remarks Returns the raw certificate data in DER format. The *$pinnedclientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-secureblackbox_dtlsserver-class) property. This property is read-only and not available at design time. ## Data Type Byte Array # PinnedClientCertCAKeyID Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) A unique identifier (fingerprint) of the CA certificate's cryptographic key. ## Object Oriented Interface ```text public function getPinnedClientCertCAKeyID($pinnedclientcertindex); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 49 , $pinnedclientcertindex); ``` ## Remarks A unique identifier (fingerprint) of the CA certificate's cryptographic key. Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building. This setting cannot be set when generating a certificate as it always derives from another certificate property. [CertificateManager](#CertificateManager) generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the [PinnedClientCertSubjectKeyID](#pinnedclientcertsubjectkeyid-property-secureblackbox_dtlsserver-class) setting, and for lower-level certificates, from the parent certificate's subject key ID extension. The *$pinnedclientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-secureblackbox_dtlsserver-class) property. This property is read-only and not available at design time. ## Data Type Byte Array # PinnedClientCertFingerprint Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Contains the fingerprint (a hash imprint) of this certificate. ## Object Oriented Interface ```text public function getPinnedClientCertFingerprint($pinnedclientcertindex); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 53 , $pinnedclientcertindex); ``` ## Default Value '' ## Remarks Contains the fingerprint (a hash imprint) of this certificate. While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used. The *$pinnedclientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-secureblackbox_dtlsserver-class) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertHandle Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Object Oriented Interface ```text public function getPinnedClientCertHandle($pinnedclientcertindex); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 55 , $pinnedclientcertindex); ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *$pinnedclientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-secureblackbox_dtlsserver-class) property. This property is read-only and not available at design time. ## Data Type Long64 # PinnedClientCertIssuer Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The common name of the certificate issuer (CA), typically a company name. ## Object Oriented Interface ```text public function getPinnedClientCertIssuer($pinnedclientcertindex); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 57 , $pinnedclientcertindex); ``` ## Default Value '' ## Remarks The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via [PinnedClientCertIssuerRDN](#pinnedclientcertissuerrdn-property-secureblackbox_dtlsserver-class). The *$pinnedclientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-secureblackbox_dtlsserver-class) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertIssuerRDN Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) A list of Property=Value pairs that uniquely identify the certificate issuer. ## Object Oriented Interface ```text public function getPinnedClientCertIssuerRDN($pinnedclientcertindex); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 58 , $pinnedclientcertindex); ``` ## Default Value '' ## Remarks A list of *Property=Value* pairs that uniquely identify the certificate issuer. Example: */C=US/O=Nationwide CA/CN=Web Certification Authority* The *$pinnedclientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-secureblackbox_dtlsserver-class) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertKeyAlgorithm Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Specifies the public key algorithm of this certificate. ## Object Oriented Interface ```text public function getPinnedClientCertKeyAlgorithm($pinnedclientcertindex); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 59 , $pinnedclientcertindex); ``` ## Default Value '0' ## Remarks Specifies the public key algorithm of this certificate. | | | | | --- | --- | --- | | SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | | | SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | | | SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | | | SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA | id-dsa | | | SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | | | SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | | | SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | | | SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | | | SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | | | SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | | | SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | | | SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | | | SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | | | SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | | | SB_CERT_ALGORITHM_EC | id-ecPublicKey | | | SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | | | SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | | | SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | | | SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | | | SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | | | SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | | | SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | | | SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | | | SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | | | SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | | | SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | | | SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | | | SB_CERT_ALGORITHM_EDDSA | id-EdDSA | | | SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | Use the [PinnedClientCertKeyBits](#pinnedclientcertkeybits-property-secureblackbox_dtlsserver-class), [PinnedClientCertCurve](#DTLSServer_p_PinnedClientCertCurve), and [PinnedClientCertPublicKeyBytes](#pinnedclientcertpublickeybytes-property-secureblackbox_dtlsserver-class) properties to get more details about the key the certificate contains. The *$pinnedclientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-secureblackbox_dtlsserver-class) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertKeyBits Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Returns the length of the public key in bits. ## Object Oriented Interface ```text public function getPinnedClientCertKeyBits($pinnedclientcertindex); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 60 , $pinnedclientcertindex); ``` ## Default Value 0 ## Remarks Returns the length of the public key in bits. This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the [PinnedClientCertPublicKeyBytes](#pinnedclientcertpublickeybytes-property-secureblackbox_dtlsserver-class) or [PinnedClientCertPrivateKeyBytes](#DTLSServer_p_PinnedClientCertPrivateKeyBytes) property would typically contain auxiliary values, and therefore be longer. The *$pinnedclientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-secureblackbox_dtlsserver-class) property. This property is read-only and not available at design time. ## Data Type Integer # PinnedClientCertKeyFingerprint Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Returns a SHA1 fingerprint of the public key contained in the certificate. ## Object Oriented Interface ```text public function getPinnedClientCertKeyFingerprint($pinnedclientcertindex); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 61 , $pinnedclientcertindex); ``` ## Default Value '' ## Remarks Returns a SHA1 fingerprint of the public key contained in the certificate. Note that the key fingerprint is different from the certificate fingerprint accessible via the [PinnedClientCertFingerprint](#pinnedclientcertfingerprint-property-secureblackbox_dtlsserver-class) property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key. The *$pinnedclientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-secureblackbox_dtlsserver-class) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertKeyUsage Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. ## Object Oriented Interface ```text public function getPinnedClientCertKeyUsage($pinnedclientcertindex); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 62 , $pinnedclientcertindex); ``` ## Default Value 0 ## Remarks Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. This value is a bit mask of the following values: | | | | | --- | --- | --- | | ckuUnknown | 0x00000 | Unknown key usage | | ckuDigitalSignature | 0x00001 | Digital signature | | ckuNonRepudiation | 0x00002 | Non-repudiation | | ckuKeyEncipherment | 0x00004 | Key encipherment | | ckuDataEncipherment | 0x00008 | Data encipherment | | ckuKeyAgreement | 0x00010 | Key agreement | | ckuKeyCertSign | 0x00020 | Certificate signing | | ckuCRLSign | 0x00040 | Revocation signing | | ckuEncipherOnly | 0x00080 | Encipher only | | ckuDecipherOnly | 0x00100 | Decipher only | | ckuServerAuthentication | 0x00200 | Server authentication | | ckuClientAuthentication | 0x00400 | Client authentication | | ckuCodeSigning | 0x00800 | Code signing | | ckuEmailProtection | 0x01000 | Email protection | | ckuTimeStamping | 0x02000 | Timestamping | | ckuOCSPSigning | 0x04000 | OCSP signing | | ckuSmartCardLogon | 0x08000 | Smartcard logon | | ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication | | ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC | Set this property before generating the certificate to propagate the key usage flags to the new certificate. The *$pinnedclientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-secureblackbox_dtlsserver-class) property. This property is read-only and not available at design time. ## Data Type Integer # PinnedClientCertPublicKeyBytes Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Contains the certificate's public key in DER format. ## Object Oriented Interface ```text public function getPinnedClientCertPublicKeyBytes($pinnedclientcertindex); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 71 , $pinnedclientcertindex); ``` ## Remarks Contains the certificate's public key in DER format. This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate. The *$pinnedclientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-secureblackbox_dtlsserver-class) property. This property is read-only and not available at design time. ## Data Type Byte Array # PinnedClientCertSelfSigned Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Indicates whether the certificate is self-signed (root) or signed by an external CA. ## Object Oriented Interface ```text public function getPinnedClientCertSelfSigned($pinnedclientcertindex); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 75 , $pinnedclientcertindex); ``` ## Default Value false ## Remarks Indicates whether the certificate is self-signed (root) or signed by an external CA. The *$pinnedclientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-secureblackbox_dtlsserver-class) property. This property is read-only and not available at design time. ## Data Type Boolean # PinnedClientCertSerialNumber Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Returns the certificate's serial number. ## Object Oriented Interface ```text public function getPinnedClientCertSerialNumber($pinnedclientcertindex); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 76 , $pinnedclientcertindex); ``` ## Remarks Returns the certificate's serial number. The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building. The *$pinnedclientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-secureblackbox_dtlsserver-class) property. This property is read-only and not available at design time. ## Data Type Byte Array # PinnedClientCertSigAlgorithm Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Indicates the algorithm that was used by the CA to sign this certificate. ## Object Oriented Interface ```text public function getPinnedClientCertSigAlgorithm($pinnedclientcertindex); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 77 , $pinnedclientcertindex); ``` ## Default Value '' ## Remarks Indicates the algorithm that was used by the CA to sign this certificate. A signature algorithm typically combines hash and public key algorithms together, such as *sha256WithRSAEncryption* or *ecdsa-with-SHA256*. The *$pinnedclientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-secureblackbox_dtlsserver-class) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertSubject Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. ## Object Oriented Interface ```text public function getPinnedClientCertSubject($pinnedclientcertindex); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 79 , $pinnedclientcertindex); ``` ## Default Value '' ## Remarks The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via [PinnedClientCertSubjectRDN](#pinnedclientcertsubjectrdn-property-secureblackbox_dtlsserver-class). The *$pinnedclientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-secureblackbox_dtlsserver-class) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertSubjectKeyID Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Contains a unique identifier of the certificate's cryptographic key. ## Object Oriented Interface ```text public function getPinnedClientCertSubjectKeyID($pinnedclientcertindex); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 81 , $pinnedclientcertindex); ``` ## Remarks Contains a unique identifier of the certificate's cryptographic key. Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building. The [PinnedClientCertSubjectKeyID](#pinnedclientcertsubjectkeyid-property-secureblackbox_dtlsserver-class) and [PinnedClientCertCAKeyID](#pinnedclientcertcakeyid-property-secureblackbox_dtlsserver-class) properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity. The *$pinnedclientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-secureblackbox_dtlsserver-class) property. This property is read-only and not available at design time. ## Data Type Byte Array # PinnedClientCertSubjectRDN Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) A list of Property=Value pairs that uniquely identify the certificate holder (subject). ## Object Oriented Interface ```text public function getPinnedClientCertSubjectRDN($pinnedclientcertindex); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 82 , $pinnedclientcertindex); ``` ## Default Value '' ## Remarks A list of *Property=Value* pairs that uniquely identify the certificate holder (subject). Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data. Example: */C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins*. The *$pinnedclientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-secureblackbox_dtlsserver-class) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertValidFrom Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The time point at which the certificate becomes valid, in UTC. ## Object Oriented Interface ```text public function getPinnedClientCertValidFrom($pinnedclientcertindex); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 84 , $pinnedclientcertindex); ``` ## Default Value '' ## Remarks The time point at which the certificate becomes valid, in UTC. The *$pinnedclientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-secureblackbox_dtlsserver-class) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertValidTo Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The time point at which the certificate expires, in UTC. ## Object Oriented Interface ```text public function getPinnedClientCertValidTo($pinnedclientcertindex); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 85 , $pinnedclientcertindex); ``` ## Default Value '' ## Remarks The time point at which the certificate expires, in UTC. The *$pinnedclientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-secureblackbox_dtlsserver-class) property. This property is read-only and not available at design time. ## Data Type String # Port Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Specifies the port number to listen for connections on. ## Object Oriented Interface ```text public function getPort(); public function setPort($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 86 ); secureblackbox_dtlsserver_set($res, 86, $value ); ``` ## Default Value 80 ## Remarks Use this property to specify the port number to listen to connections on. Standard port numbers are 80 for an HTTP server, and 443 for an HTTPS server. Alternatively, you may specify the acceptable range of listening ports via [PortRangeFrom](#portrangefrom-property-secureblackbox_dtlsserver-class) and [PortRangeTo](#portrangeto-property-secureblackbox_dtlsserver-class) properties. In this case the port will be allocated within the requested range by the operating system, and reported in [BoundPort](#boundport-property-secureblackbox_dtlsserver-class). ## Data Type Integer # PortRangeFrom Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Specifies the lower limit of the listening port range for incoming connections. ## Object Oriented Interface ```text public function getPortRangeFrom(); public function setPortRangeFrom($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 87 ); secureblackbox_dtlsserver_set($res, 87, $value ); ``` ## Default Value 0 ## Remarks Use this property to specify the lower limit of the port range to listen to connections on. When a port range is used to specify the listening port (as opposed to a fixed value provided via [Port](#port-property-secureblackbox_dtlsserver-class)), the port will be allocated within the requested range by the operating system, and reported in [BoundPort](#boundport-property-secureblackbox_dtlsserver-class). Note that this property is ignored if the [Port](#port-property-secureblackbox_dtlsserver-class) property is set to a non-zero value, in which case the server always aims to listen on that fixed port. ## Data Type Integer # PortRangeTo Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Specifies the upper limit of the listening port range for incoming connections. ## Object Oriented Interface ```text public function getPortRangeTo(); public function setPortRangeTo($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 88 ); secureblackbox_dtlsserver_set($res, 88, $value ); ``` ## Default Value 0 ## Remarks Use this property to specify the upper limit of the port range to listen to connections on. When a port range is used to specify the listening port (as opposed to a fixed value provided via [Port](#port-property-secureblackbox_dtlsserver-class)), the port will be allocated within the requested range by the operating system, and reported in [BoundPort](#boundport-property-secureblackbox_dtlsserver-class). Note that this property is ignored if the [Port](#port-property-secureblackbox_dtlsserver-class) property is set to a non-zero value, in which case the server always aims to listen on that fixed port. ## Data Type Integer # SocketIncomingSpeedLimit Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The maximum number of bytes to read from the socket, per second. ## Object Oriented Interface ```text public function getSocketIncomingSpeedLimit(); public function setSocketIncomingSpeedLimit($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 94 ); secureblackbox_dtlsserver_set($res, 94, $value ); ``` ## Default Value 0 ## Remarks The maximum number of bytes to read from the socket, per second. ## Data Type Integer # SocketLocalAddress Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The local network interface to bind the socket to. ## Object Oriented Interface ```text public function getSocketLocalAddress(); public function setSocketLocalAddress($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 95 ); secureblackbox_dtlsserver_set($res, 95, $value ); ``` ## Default Value '' ## Remarks The local network interface to bind the socket to. ## Data Type String # SocketLocalPort Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The local port number to bind the socket to. ## Object Oriented Interface ```text public function getSocketLocalPort(); public function setSocketLocalPort($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 96 ); secureblackbox_dtlsserver_set($res, 96, $value ); ``` ## Default Value 0 ## Remarks The local port number to bind the socket to. ## Data Type Integer # SocketOutgoingSpeedLimit Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The maximum number of bytes to write to the socket, per second. ## Object Oriented Interface ```text public function getSocketOutgoingSpeedLimit(); public function setSocketOutgoingSpeedLimit($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 97 ); secureblackbox_dtlsserver_set($res, 97, $value ); ``` ## Default Value 0 ## Remarks The maximum number of bytes to write to the socket, per second. ## Data Type Integer # SocketTimeout Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. ## Object Oriented Interface ```text public function getSocketTimeout(); public function setSocketTimeout($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 98 ); secureblackbox_dtlsserver_set($res, 98, $value ); ``` ## Default Value 60000 ## Remarks The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. If *Timeout* is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack). ## Data Type Integer # SocketUseIPv6 Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Enables or disables IP protocol version 6. ## Object Oriented Interface ```text public function getSocketUseIPv6(); public function setSocketUseIPv6($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 99 ); secureblackbox_dtlsserver_set($res, 99, $value ); ``` ## Default Value false ## Remarks Enables or disables IP protocol version 6. ## Data Type Boolean # TLSServerCertCount Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The number of records in the TLSServerCert arrays. ## Object Oriented Interface ```text public function getTLSServerCertCount(); public function setTLSServerCertCount($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 100 ); secureblackbox_dtlsserver_set($res, 100, $value ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [TLSServerCertBytes](#tlsservercertbytes-property-secureblackbox_dtlsserver-class) - [TLSServerCertHandle](#tlsservercerthandle-property-secureblackbox_dtlsserver-class) The array indices start at *0* and end at *TLSServerCertCount - 1*. This property is not available at design time. ## Data Type Integer # TLSServerCertBytes Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Returns the raw certificate data in DER format. ## Object Oriented Interface ```text public function getTLSServerCertBytes($tlsservercertindex); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 101 , $tlsservercertindex); ``` ## Remarks Returns the raw certificate data in DER format. The *$tlsservercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_dtlsserver-class) property. This property is read-only and not available at design time. ## Data Type Byte Array # TLSServerCertHandle Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Object Oriented Interface ```text public function getTLSServerCertHandle($tlsservercertindex); public function setTLSServerCertHandle($tlsservercertindex, $value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 109 , $tlsservercertindex); secureblackbox_dtlsserver_set($res, 109, $value , $tlsservercertindex); ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *$tlsservercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_dtlsserver-class) property. This property is not available at design time. ## Data Type Long64 # TLSAutoValidateCertificates Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. ## Object Oriented Interface ```text public function getTLSAutoValidateCertificates(); public function setTLSAutoValidateCertificates($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 140 ); secureblackbox_dtlsserver_set($res, 140, $value ); ``` ## Default Value true ## Remarks Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. ## Data Type Boolean # TLSBaseConfiguration Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Selects the base configuration for the TLS settings. ## Object Oriented Interface ```text public function getTLSBaseConfiguration(); public function setTLSBaseConfiguration($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 141 ); secureblackbox_dtlsserver_set($res, 141, $value ); ``` ## Possible Values ```text DTLSSERVER_TLSBASECONFIGURATION_DEFAULT(0), DTLSSERVER_TLSBASECONFIGURATION_COMPATIBLE(1), DTLSSERVER_TLSBASECONFIGURATION_COMPREHENSIVE_INSECURE(2), DTLSSERVER_TLSBASECONFIGURATION_HIGHLY_SECURE(3) ``` ## Default Value 0 ## Remarks Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility. | | | | | --- | --- | --- | | stpcDefault | 0 | | | stpcCompatible | 1 | | | stpcComprehensiveInsecure | 2 | | | stpcHighlySecure | 3 | | ## Data Type Integer # TLSCiphersuites Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) A list of ciphersuites separated with commas or semicolons. ## Object Oriented Interface ```text public function getTLSCiphersuites(); public function setTLSCiphersuites($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 142 ); secureblackbox_dtlsserver_set($res, 142, $value ); ``` ## Default Value '' ## Remarks A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the *all* (and *-all*) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once. Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by [TLSBaseConfiguration](#tlsbaseconfiguration-property-secureblackbox_dtlsserver-class). Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below: - NULL_NULL_NULL - RSA_NULL_MD5 - RSA_NULL_SHA - RSA_RC4_MD5 - RSA_RC4_SHA - RSA_RC2_MD5 - RSA_IDEA_MD5 - RSA_IDEA_SHA - RSA_DES_MD5 - RSA_DES_SHA - RSA_3DES_MD5 - RSA_3DES_SHA - RSA_AES128_SHA - RSA_AES256_SHA - DH_DSS_DES_SHA - DH_DSS_3DES_SHA - DH_DSS_AES128_SHA - DH_DSS_AES256_SHA - DH_RSA_DES_SHA - DH_RSA_3DES_SHA - DH_RSA_AES128_SHA - DH_RSA_AES256_SHA - DHE_DSS_DES_SHA - DHE_DSS_3DES_SHA - DHE_DSS_AES128_SHA - DHE_DSS_AES256_SHA - DHE_RSA_DES_SHA - DHE_RSA_3DES_SHA - DHE_RSA_AES128_SHA - DHE_RSA_AES256_SHA - DH_ANON_RC4_MD5 - DH_ANON_DES_SHA - DH_ANON_3DES_SHA - DH_ANON_AES128_SHA - DH_ANON_AES256_SHA - RSA_RC2_MD5_EXPORT - RSA_RC4_MD5_EXPORT - RSA_DES_SHA_EXPORT - DH_DSS_DES_SHA_EXPORT - DH_RSA_DES_SHA_EXPORT - DHE_DSS_DES_SHA_EXPORT - DHE_RSA_DES_SHA_EXPORT - DH_ANON_RC4_MD5_EXPORT - DH_ANON_DES_SHA_EXPORT - RSA_CAMELLIA128_SHA - DH_DSS_CAMELLIA128_SHA - DH_RSA_CAMELLIA128_SHA - DHE_DSS_CAMELLIA128_SHA - DHE_RSA_CAMELLIA128_SHA - DH_ANON_CAMELLIA128_SHA - RSA_CAMELLIA256_SHA - DH_DSS_CAMELLIA256_SHA - DH_RSA_CAMELLIA256_SHA - DHE_DSS_CAMELLIA256_SHA - DHE_RSA_CAMELLIA256_SHA - DH_ANON_CAMELLIA256_SHA - PSK_RC4_SHA - PSK_3DES_SHA - PSK_AES128_SHA - PSK_AES256_SHA - DHE_PSK_RC4_SHA - DHE_PSK_3DES_SHA - DHE_PSK_AES128_SHA - DHE_PSK_AES256_SHA - RSA_PSK_RC4_SHA - RSA_PSK_3DES_SHA - RSA_PSK_AES128_SHA - RSA_PSK_AES256_SHA - RSA_SEED_SHA - DH_DSS_SEED_SHA - DH_RSA_SEED_SHA - DHE_DSS_SEED_SHA - DHE_RSA_SEED_SHA - DH_ANON_SEED_SHA - SRP_SHA_3DES_SHA - SRP_SHA_RSA_3DES_SHA - SRP_SHA_DSS_3DES_SHA - SRP_SHA_AES128_SHA - SRP_SHA_RSA_AES128_SHA - SRP_SHA_DSS_AES128_SHA - SRP_SHA_AES256_SHA - SRP_SHA_RSA_AES256_SHA - SRP_SHA_DSS_AES256_SHA - ECDH_ECDSA_NULL_SHA - ECDH_ECDSA_RC4_SHA - ECDH_ECDSA_3DES_SHA - ECDH_ECDSA_AES128_SHA - ECDH_ECDSA_AES256_SHA - ECDHE_ECDSA_NULL_SHA - ECDHE_ECDSA_RC4_SHA - ECDHE_ECDSA_3DES_SHA - ECDHE_ECDSA_AES128_SHA - ECDHE_ECDSA_AES256_SHA - ECDH_RSA_NULL_SHA - ECDH_RSA_RC4_SHA - ECDH_RSA_3DES_SHA - ECDH_RSA_AES128_SHA - ECDH_RSA_AES256_SHA - ECDHE_RSA_NULL_SHA - ECDHE_RSA_RC4_SHA - ECDHE_RSA_3DES_SHA - ECDHE_RSA_AES128_SHA - ECDHE_RSA_AES256_SHA - ECDH_ANON_NULL_SHA - ECDH_ANON_RC4_SHA - ECDH_ANON_3DES_SHA - ECDH_ANON_AES128_SHA - ECDH_ANON_AES256_SHA - RSA_NULL_SHA256 - RSA_AES128_SHA256 - RSA_AES256_SHA256 - DH_DSS_AES128_SHA256 - DH_RSA_AES128_SHA256 - DHE_DSS_AES128_SHA256 - DHE_RSA_AES128_SHA256 - DH_DSS_AES256_SHA256 - DH_RSA_AES256_SHA256 - DHE_DSS_AES256_SHA256 - DHE_RSA_AES256_SHA256 - DH_ANON_AES128_SHA256 - DH_ANON_AES256_SHA256 - RSA_AES128_GCM_SHA256 - RSA_AES256_GCM_SHA384 - DHE_RSA_AES128_GCM_SHA256 - DHE_RSA_AES256_GCM_SHA384 - DH_RSA_AES128_GCM_SHA256 - DH_RSA_AES256_GCM_SHA384 - DHE_DSS_AES128_GCM_SHA256 - DHE_DSS_AES256_GCM_SHA384 - DH_DSS_AES128_GCM_SHA256 - DH_DSS_AES256_GCM_SHA384 - DH_ANON_AES128_GCM_SHA256 - DH_ANON_AES256_GCM_SHA384 - ECDHE_ECDSA_AES128_SHA256 - ECDHE_ECDSA_AES256_SHA384 - ECDH_ECDSA_AES128_SHA256 - ECDH_ECDSA_AES256_SHA384 - ECDHE_RSA_AES128_SHA256 - ECDHE_RSA_AES256_SHA384 - ECDH_RSA_AES128_SHA256 - ECDH_RSA_AES256_SHA384 - ECDHE_ECDSA_AES128_GCM_SHA256 - ECDHE_ECDSA_AES256_GCM_SHA384 - ECDH_ECDSA_AES128_GCM_SHA256 - ECDH_ECDSA_AES256_GCM_SHA384 - ECDHE_RSA_AES128_GCM_SHA256 - ECDHE_RSA_AES256_GCM_SHA384 - ECDH_RSA_AES128_GCM_SHA256 - ECDH_RSA_AES256_GCM_SHA384 - PSK_AES128_GCM_SHA256 - PSK_AES256_GCM_SHA384 - DHE_PSK_AES128_GCM_SHA256 - DHE_PSK_AES256_GCM_SHA384 - RSA_PSK_AES128_GCM_SHA256 - RSA_PSK_AES256_GCM_SHA384 - PSK_AES128_SHA256 - PSK_AES256_SHA384 - PSK_NULL_SHA256 - PSK_NULL_SHA384 - DHE_PSK_AES128_SHA256 - DHE_PSK_AES256_SHA384 - DHE_PSK_NULL_SHA256 - DHE_PSK_NULL_SHA384 - RSA_PSK_AES128_SHA256 - RSA_PSK_AES256_SHA384 - RSA_PSK_NULL_SHA256 - RSA_PSK_NULL_SHA384 - RSA_CAMELLIA128_SHA256 - DH_DSS_CAMELLIA128_SHA256 - DH_RSA_CAMELLIA128_SHA256 - DHE_DSS_CAMELLIA128_SHA256 - DHE_RSA_CAMELLIA128_SHA256 - DH_ANON_CAMELLIA128_SHA256 - RSA_CAMELLIA256_SHA256 - DH_DSS_CAMELLIA256_SHA256 - DH_RSA_CAMELLIA256_SHA256 - DHE_DSS_CAMELLIA256_SHA256 - DHE_RSA_CAMELLIA256_SHA256 - DH_ANON_CAMELLIA256_SHA256 - ECDHE_ECDSA_CAMELLIA128_SHA256 - ECDHE_ECDSA_CAMELLIA256_SHA384 - ECDH_ECDSA_CAMELLIA128_SHA256 - ECDH_ECDSA_CAMELLIA256_SHA384 - ECDHE_RSA_CAMELLIA128_SHA256 - ECDHE_RSA_CAMELLIA256_SHA384 - ECDH_RSA_CAMELLIA128_SHA256 - ECDH_RSA_CAMELLIA256_SHA384 - RSA_CAMELLIA128_GCM_SHA256 - RSA_CAMELLIA256_GCM_SHA384 - DHE_RSA_CAMELLIA128_GCM_SHA256 - DHE_RSA_CAMELLIA256_GCM_SHA384 - DH_RSA_CAMELLIA128_GCM_SHA256 - DH_RSA_CAMELLIA256_GCM_SHA384 - DHE_DSS_CAMELLIA128_GCM_SHA256 - DHE_DSS_CAMELLIA256_GCM_SHA384 - DH_DSS_CAMELLIA128_GCM_SHA256 - DH_DSS_CAMELLIA256_GCM_SHA384 - DH_anon_CAMELLIA128_GCM_SHA256 - DH_anon_CAMELLIA256_GCM_SHA384 - ECDHE_ECDSA_CAMELLIA128_GCM_SHA256 - ECDHE_ECDSA_CAMELLIA256_GCM_SHA384 - ECDH_ECDSA_CAMELLIA128_GCM_SHA256 - ECDH_ECDSA_CAMELLIA256_GCM_SHA384 - ECDHE_RSA_CAMELLIA128_GCM_SHA256 - ECDHE_RSA_CAMELLIA256_GCM_SHA384 - ECDH_RSA_CAMELLIA128_GCM_SHA256 - ECDH_RSA_CAMELLIA256_GCM_SHA384 - PSK_CAMELLIA128_GCM_SHA256 - PSK_CAMELLIA256_GCM_SHA384 - DHE_PSK_CAMELLIA128_GCM_SHA256 - DHE_PSK_CAMELLIA256_GCM_SHA384 - RSA_PSK_CAMELLIA128_GCM_SHA256 - RSA_PSK_CAMELLIA256_GCM_SHA384 - PSK_CAMELLIA128_SHA256 - PSK_CAMELLIA256_SHA384 - DHE_PSK_CAMELLIA128_SHA256 - DHE_PSK_CAMELLIA256_SHA384 - RSA_PSK_CAMELLIA128_SHA256 - RSA_PSK_CAMELLIA256_SHA384 - ECDHE_PSK_CAMELLIA128_SHA256 - ECDHE_PSK_CAMELLIA256_SHA384 - ECDHE_PSK_RC4_SHA - ECDHE_PSK_3DES_SHA - ECDHE_PSK_AES128_SHA - ECDHE_PSK_AES256_SHA - ECDHE_PSK_AES128_SHA256 - ECDHE_PSK_AES256_SHA384 - ECDHE_PSK_NULL_SHA - ECDHE_PSK_NULL_SHA256 - ECDHE_PSK_NULL_SHA384 - ECDHE_RSA_CHACHA20_POLY1305_SHA256 - ECDHE_ECDSA_CHACHA20_POLY1305_SHA256 - DHE_RSA_CHACHA20_POLY1305_SHA256 - PSK_CHACHA20_POLY1305_SHA256 - ECDHE_PSK_CHACHA20_POLY1305_SHA256 - DHE_PSK_CHACHA20_POLY1305_SHA256 - RSA_PSK_CHACHA20_POLY1305_SHA256 - AES128_GCM_SHA256 - AES256_GCM_SHA384 - CHACHA20_POLY1305_SHA256 - AES128_CCM_SHA256 - AES128_CCM8_SHA256 ## Data Type String # TLSClientAuth Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Enables or disables certificate-based client authentication. ## Object Oriented Interface ```text public function getTLSClientAuth(); public function setTLSClientAuth($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 143 ); secureblackbox_dtlsserver_set($res, 143, $value ); ``` ## Possible Values ```text DTLSSERVER_TLSCLIENTAUTH_NO_AUTH(0), DTLSSERVER_TLSCLIENTAUTH_REQUEST_CERT(1), DTLSSERVER_TLSCLIENTAUTH_REQUIRE_CERT(2) ``` ## Default Value 0 ## Remarks Enables or disables certificate-based client authentication. Set this property to true to tune up the client authentication type: | | | | | --- | --- | --- | | ccatNoAuth | 0 | | | ccatRequestCert | 1 | | | ccatRequireCert | 2 | | ## Data Type Integer # TLSExtensions Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Provides access to TLS extensions. ## Object Oriented Interface ```text public function getTLSExtensions(); public function setTLSExtensions($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 144 ); secureblackbox_dtlsserver_set($res, 144, $value ); ``` ## Default Value '' ## Remarks Provides access to TLS extensions. ## Data Type String # TLSForceResumeIfDestinationChanges Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Whether to force TLS session resumption when the destination address changes. ## Object Oriented Interface ```text public function getTLSForceResumeIfDestinationChanges(); public function setTLSForceResumeIfDestinationChanges($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 145 ); secureblackbox_dtlsserver_set($res, 145, $value ); ``` ## Default Value false ## Remarks Whether to force TLS session resumption when the destination address changes. ## Data Type Boolean # TLSGroups Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Specifies a list of key exchange groups to attempt during the TLS key exchange. ## Object Oriented Interface ```text public function getTLSGroups(); public function setTLSGroups($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 146 ); secureblackbox_dtlsserver_set($res, 146, $value ); ``` ## Default Value '' ## Remarks Specifies a list of key exchange groups to attempt during the TLS key exchange. Keep this setting at its default value (empty string) to stick with the default list of key exchange groups. You can tweak the list by using '+' and '-' modifiers that are immediately followed by a group name or the *all* placeholder: ```text // Ensure the two x25519-based groups are enabled and the finite field DHE2048 is disabled client.TLSSettings.Groups = "+x25519mlkem768;+x25519;-ffdhe2048"; // Only enable the hybrid X25519/ML-KEM768 group client.TLSSettings.Groups = "-all;+x25519mlkem768"; ``` The list of groups supported by the component is provided below. All the names are case-insensitive: **Elliptic curve-based groups:** - SECT163K1 - SECT163R1 - SECT163R2 - SECT193R1 - SECT193R2 - SECT233K1 - SECT233R1 - SECT239K1 - SECT283K1 - SECT283R1 - SECT409K1 - SECT409R1 - SECT571K1 - SECT571R1 - SECP160K1 - SECP160R1 - SECP160R2 - SECP192K1 - SECP192R1 - SECP224K1 - SECP224R1 - SECP256K1 - SECP256R1 - SECP384R1 - SECP521R1 - BRAINPOOLP256R1 - BRAINPOOLP384R1 - BRAINPOOLP512R1 - X25519 - X448 **Finite field-based groups:** - FFDHE2048 - FFDHE3072 - FFDHE4096 - FFDHE6144 - FFDHE8192 **Post-Quantum and Hybrid groups:** - MLKEM512 - MLKEM768 - MLKEM1024 - SECP256R1MLKEM768 - X25519MLKEM768 - SECP384R1MLKEM1024 Note: this property was called *ECCurves* in SecureBlackbox 2024 and older. ## Data Type String # TLSPreSharedIdentity Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. ## Object Oriented Interface ```text public function getTLSPreSharedIdentity(); public function setTLSPreSharedIdentity($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 147 ); secureblackbox_dtlsserver_set($res, 147, $value ); ``` ## Default Value '' ## Remarks Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. This property is not available at design time. ## Data Type String # TLSPreSharedKey Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. ## Object Oriented Interface ```text public function getTLSPreSharedKey(); public function setTLSPreSharedKey($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 148 ); secureblackbox_dtlsserver_set($res, 148, $value ); ``` ## Default Value '' ## Remarks Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. This property is not available at design time. ## Data Type String # TLSPreSharedKeyCiphersuite Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. ## Object Oriented Interface ```text public function getTLSPreSharedKeyCiphersuite(); public function setTLSPreSharedKeyCiphersuite($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 149 ); secureblackbox_dtlsserver_set($res, 149, $value ); ``` ## Default Value '' ## Remarks Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. ## Data Type String # TLSRenegotiationAttackPreventionMode Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Selects the renegotiation attack prevention mechanism. ## Object Oriented Interface ```text public function getTLSRenegotiationAttackPreventionMode(); public function setTLSRenegotiationAttackPreventionMode($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 150 ); secureblackbox_dtlsserver_set($res, 150, $value ); ``` ## Possible Values ```text DTLSSERVER_TLSRENEGOTIATIONATTACKPREVENTIONMODE_COMPATIBLE(0), DTLSSERVER_TLSRENEGOTIATIONATTACKPREVENTIONMODE_STRICT(1), DTLSSERVER_TLSRENEGOTIATIONATTACKPREVENTIONMODE_AUTO(2) ``` ## Default Value 2 ## Remarks Selects the renegotiation attack prevention mechanism. The following options are available: | | | | | --- | --- | --- | | crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). | | crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. | | crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. | ## Data Type Integer # TLSRevocationCheck Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Specifies the kind(s) of revocation check to perform. ## Object Oriented Interface ```text public function getTLSRevocationCheck(); public function setTLSRevocationCheck($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 151 ); secureblackbox_dtlsserver_set($res, 151, $value ); ``` ## Possible Values ```text DTLSSERVER_TLSREVOCATIONCHECK_NONE(0), DTLSSERVER_TLSREVOCATIONCHECK_AUTO(1), DTLSSERVER_TLSREVOCATIONCHECK_ALL_CRL(2), DTLSSERVER_TLSREVOCATIONCHECK_ALL_OCSP(3), DTLSSERVER_TLSREVOCATIONCHECK_ALL_CRLAND_OCSP(4), DTLSSERVER_TLSREVOCATIONCHECK_ANY_CRL(5), DTLSSERVER_TLSREVOCATIONCHECK_ANY_OCSP(6), DTLSSERVER_TLSREVOCATIONCHECK_ANY_CRLOR_OCSP(7), DTLSSERVER_TLSREVOCATIONCHECK_ANY_OCSPOR_CRL(8) ``` ## Default Value 1 ## Remarks Specifies the kind(s) of revocation check to perform. Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information. | | | | | --- | --- | --- | | crcNone | 0 | No revocation checking. | | crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. | | crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. | | crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. | | crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. | | crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. | | crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. | | crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. | | crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. | This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time. There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs). This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential. NOTE: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable. NOTE: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails. This property is not available at design time. ## Data Type Integer # TLSSSLOptions Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size. ## Object Oriented Interface ```text public function getTLSSSLOptions(); public function setTLSSSLOptions($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 152 ); secureblackbox_dtlsserver_set($res, 152, $value ); ``` ## Default Value 16 ## Remarks Various SSL (TLS) protocol options, set of | | | | | --- | --- | --- | | cssloExpectShutdownMessage | 0x001 | Wait for the close-notify message when shutting down the connection | | cssloOpenSSLDTLSWorkaround | 0x002 | (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions | | cssloDisableKexLengthAlignment | 0x004 | Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it. | | cssloForceUseOfClientCertHashAlg | 0x008 | Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it. | | cssloAutoAddServerNameExtension | 0x010 | Automatically add the server name extension when known | | cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only | | cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it. | | cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled | | cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms | | cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks | | cssloUseHandshakeBatches | 0x400 | Send the handshake message as large batches rather than individually | ## Data Type Integer # TLSMode Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Specifies the TLS mode to use. ## Object Oriented Interface ```text public function getTLSMode(); public function setTLSMode($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 153 ); secureblackbox_dtlsserver_set($res, 153, $value ); ``` ## Possible Values ```text DTLSSERVER_TLSMODE_DEFAULT(0), DTLSSERVER_TLSMODE_NO_TLS(1), DTLSSERVER_TLSMODE_EXPLICIT_TLS(2), DTLSSERVER_TLSMODE_IMPLICIT_TLS(3), DTLSSERVER_TLSMODE_MIXED_TLS(4) ``` ## Default Value 0 ## Remarks Specifies the TLS mode to use. | | | | | --- | --- | --- | | smDefault | 0 | | | smNoTLS | 1 | Do not use TLS | | smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. | | smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. | | smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, but allow plain data. | ## Data Type Integer # TLSUseExtendedMasterSecret Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Enables the Extended Master Secret Extension, as defined in RFC 7627. ## Object Oriented Interface ```text public function getTLSUseExtendedMasterSecret(); public function setTLSUseExtendedMasterSecret($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 154 ); secureblackbox_dtlsserver_set($res, 154, $value ); ``` ## Default Value true ## Remarks Enables the Extended Master Secret Extension, as defined in RFC 7627. ## Data Type Boolean # TLSUseSessionResumption Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Enables or disables the TLS session resumption capability. ## Object Oriented Interface ```text public function getTLSUseSessionResumption(); public function setTLSUseSessionResumption($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 155 ); secureblackbox_dtlsserver_set($res, 155, $value ); ``` ## Default Value false ## Remarks Enables or disables the TLS session resumption capability. ## Data Type Boolean # TLSVersions Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) The SSL/TLS versions to enable by default. ## Object Oriented Interface ```text public function getTLSVersions(); public function setTLSVersions($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 156 ); secureblackbox_dtlsserver_set($res, 156, $value ); ``` ## Default Value 48 ## Remarks The SSL/TLS versions to enable by default. | | | | | --- | --- | --- | | csbSSL2 | 0x01 | SSL 2 | | csbSSL3 | 0x02 | SSL 3 | | csbTLS1 | 0x04 | TLS 1.0 | | csbTLS11 | 0x08 | TLS 1.1 | | csbTLS12 | 0x10 | TLS 1.2 | | csbTLS13 | 0x20 | TLS 1.3 | ## Data Type Integer # WebsiteName Property ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Specifies the web site name to use in the certificate. ## Object Oriented Interface ```text public function getWebsiteName(); public function setWebsiteName($value); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_get($res, 157 ); secureblackbox_dtlsserver_set($res, 157, $value ); ``` ## Default Value 'secureblackbox' ## Remarks If using an internally-generated certificate, use this property to specify the web site name to be included as a common name. A typical common name consists of the host name, such as '192.168.10.10' or 'domain.com'. ## Data Type String # BroadcastData Method ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Broadcasts data to all connections. ## Object Oriented Interface ```text public function doBroadcastData($connectionid, $data); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_do_broadcastdata($res, $connectionid, $data); ``` ## Remarks Call this method to send *Data* to all active client connections except for *ConnectionID*. Set *ConnectionID* to -1 to broadcast to all connections. # BroadcastText Method ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Broadcasts a text string to all connections. ## Object Oriented Interface ```text public function doBroadcastText($connectionid, $text); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_do_broadcasttext($res, $connectionid, $text); ``` ## Remarks Call this method to send *Text* to all active client connections except for *ConnectionID*. Set *ConnectionID* to -1 to broadcast to all connections without exceptions. # Cleanup Method ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Cleans up the server environment by purging expired sessions and cleaning caches. ## Object Oriented Interface ```text public function doCleanup(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_do_cleanup($res); ``` ## Remarks Call this method while the server is active to clean up the environment allocated for the server by releasing unused resources and cleaning caches. # Config Method ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Sets or retrieves a configuration setting. ## Object Oriented Interface ```text public function doConfig($configurationstring); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_do_config($res, $configurationstring); ``` ## Remarks Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-dtlsserver-class) for the class. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the Config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#config-settings-dtlsserver-class), you must call *Config("PROPERTY")*. The value will be returned as a string. # DoAction Method ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Performs an additional action. ## Object Oriented Interface ```text public function doDoAction($actionid, $actionparams); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_do_doaction($res, $actionid, $actionparams); ``` ## Remarks DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time. The unique identifier (case insensitive) of the action is provided in the *ActionID* parameter. *ActionParams* contains the value of a single parameter, or a list of multiple parameters for the action in the form of *PARAM1=VALUE1;PARAM2=VALUE2;...*. Common ActionIDs: | | | | | | --- | --- | --- | --- | | Action | Parameters | Returned value | Description | | ResetTrustedListCache | none | none | Clears the cached list of trusted lists. | | ResetCertificateCache | none | none | Clears the cached certificates. | | ResetCRLCache | none | none | Clears the cached CRLs. | | ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. | # DropClient Method ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Terminates a client connection. ## Object Oriented Interface ```text public function doDropClient($connectionid, $forced); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_do_dropclient($res, $connectionid, $forced); ``` ## Remarks Call this method to shut down a connected client. *Forced* indicates whether the connection should be closed in a graceful manner. # ExportKeyMaterial Method ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Derives key material from the session's master key using the TLS exporters scheme. ## Object Oriented Interface ```text public function doExportKeyMaterial($connectionid, $lbl, $context, $len); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_do_exportkeymaterial($res, $connectionid, $lbl, $context, $len); ``` ## Remarks Some protocols - for example, SRTP - use the TLS exporters scheme to derive their own session keys from the TLS master key. This method lets you employ exporters to obtain such keys, or to generate secure keys for your own needs from an active TLS session. The exported keys depend on the master key, and are different for every TLS session. However, a client and server sharing a session will always end up with the same key material, as long as they use the same values of *Lbl*, *Context*, and *Len*. Use the *ConnectionID* parameter to specify the session that you would like to derive key material from. # ListClients Method ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Enumerates the connected clients. ## Object Oriented Interface ```text public function doListClients(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_do_listclients($res); ``` ## Remarks This method enumerates the connected clients. It returns a list of strings, with each string being of 'ConnectionID|Address|Port' format, and representing a single connection. # PinClient Method ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Takes a snapshot of the connection's properties. ## Object Oriented Interface ```text public function doPinClient($connectionid); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_do_pinclient($res, $connectionid); ``` ## Remarks Use this method to take a snapshot of a connected client. The captured properties are populated in PinnedClient and PinnedClientChain properties. # ProcessPlainData Method ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Process a plain data buffer to a connection client. ## Object Oriented Interface ```text public function doProcessPlainData($connectionid, $buffer); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_do_processplaindata($res, $connectionid, $buffer); ``` ## Remarks Use this method to process a plain data buffer to a connected client. Use *ConnectionID* to specify the client. # Reset Method ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Resets the class settings. ## Object Oriented Interface ```text public function doReset(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_do_reset($res); ``` ## Remarks Reset is a generic method available in every class. # SendData Method ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Sends a data buffer to a connection client. ## Object Oriented Interface ```text public function doSendData($connectionid, $buffer); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_do_senddata($res, $connectionid, $buffer); ``` ## Remarks Use this method to send a data buffer to a connected client. Use *ConnectionID* to specify the client. # SendKeepAlive Method ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Sends a keep-alive packet. ## Object Oriented Interface ```text public function doSendKeepAlive($connectionid); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_do_sendkeepalive($res, $connectionid); ``` ## Remarks Use this method to send a keep-alive packet to a client. Keep alive is an empty packet; keep-alive signals sent occasionally can be used to keep connection up. # SendPlainData Method ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Sends a data buffer to a connection client. ## Object Oriented Interface ```text public function doSendPlainData($connectionid, $buffer); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_do_sendplaindata($res, $connectionid, $buffer); ``` ## Remarks Use this method to send a data buffer to a connected client. Use *ConnectionID* to specify the client. # SendText Method ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Sends a text string to a client. ## Object Oriented Interface ```text public function doSendText($connectionid, $text); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_do_sendtext($res, $connectionid, $text); ``` ## Remarks Use this method to send a text string to a connected client. # Start Method ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Starts the DTLS server. ## Object Oriented Interface ```text public function doStart(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_do_start($res); ``` ## Remarks Use this method to start listening for incoming data. # Stop Method ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Stops the DTLS server. ## Object Oriented Interface ```text public function doStop(); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_do_stop($res); ``` ## Remarks Call this method to stop listening for incoming data. # Accept Event ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Reports an incoming connection. ## Object Oriented Interface ```text public function fireAccept($param); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_register_callback($res, 1, array($this, 'fireAccept')); ``` ## Parameter List ```text 'remoteaddress' 'remoteport' 'accept' ``` ## Remarks This event is fired when a new connection from *RemoteAddress*:*RemotePort* is ready to be accepted. Use the *Accept* parameter to accept or decline it. Subscribe to [Connect](#connect-event-secureblackbox_dtlsserver-class) event to be notified of every connection that has been set up. # Connect Event ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Reports a new 'connection'. ## Object Oriented Interface ```text public function fireConnect($param); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_register_callback($res, 2, array($this, 'fireConnect')); ``` ## Parameter List ```text 'connectionid' 'remoteaddress' 'remoteport' ``` ## Remarks The class fires this event to report that a datagram from a new source has been received. When using DTLS, this may typically be thought of as a request for a new datagram-driven secure channel. *ConnectionId* indicates the unique ID assigned to this connection. The same ID will be supplied to any other events related to this connection, such as [TLSHandshake](#tlshandshake-event-secureblackbox_dtlsserver-class) or [Data](#data-event-secureblackbox_dtlsserver-class). # Data Event ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Supplies a data chunk received from a client. ## Object Oriented Interface ```text public function fireData($param); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_register_callback($res, 3, array($this, 'fireData')); ``` ## Parameter List ```text 'connectionid' 'buffer' ``` ## Remarks This event is fired to supply another piece of data received from a client. This event may fire multiple times. # Disconnect Event ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Fires to report a disconnected client. ## Object Oriented Interface ```text public function fireDisconnect($param); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_register_callback($res, 4, array($this, 'fireDisconnect')); ``` ## Parameter List ```text 'connectionid' ``` ## Remarks The class fires this event when a virtual secure channel is closed. # Error Event ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Information about errors during data delivery. ## Object Oriented Interface ```text public function fireError($param); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_register_callback($res, 5, array($this, 'fireError')); ``` ## Parameter List ```text 'connectionid' 'errorcode' 'fatal' 'remote' 'description' ``` ## Remarks The event is fired in case of exceptional conditions during message processing. *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 [HTTPS](#trappable-errors-dtlsserver-class) section. # ExternalSign Event ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Handles remote or external signing initiated by the server protocol. ## Object Oriented Interface ```text public function fireExternalSign($param); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_register_callback($res, 6, array($this, 'fireExternalSign')); ``` ## Parameter List ```text 'connectionid' 'operationid' 'hashalgorithm' 'pars' 'data' 'signeddata' ``` ## Remarks Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed. The event handler must pass the value of *Data* to the signer, obtain the signature, and pass it back to the class via the *SignedData* parameter. *OperationId* provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. *HashAlgorithm* specifies the hash algorithm being used for the operation, and *Pars* contains algorithm-dependent parameters. The class uses base16 (hex) encoding for the *Data*, *SignedData*, and *Pars* parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing. A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16 A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: ```text signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); }; ``` # Notification Event ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) This event notifies the application about an underlying control flow event. ## Object Oriented Interface ```text public function fireNotification($param); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_register_callback($res, 7, array($this, 'fireNotification')); ``` ## Parameter List ```text 'eventid' 'eventparam' ``` ## Remarks The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time. The unique identifier of the event is provided in the *EventID* parameter. *EventParam* contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted. This class can fire this event with the following *EventID* values: | | | | --- | --- | | ListeningStarted | Notifies the application that the server has started listening for incoming connections. | | ListeningStopped | Notifies the application that the server has stopped listening to incoming connections. | # PlainData Event ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Supplies a plain data chunk received from a client. ## Object Oriented Interface ```text public function firePlainData($param); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_register_callback($res, 8, array($this, 'firePlainData')); ``` ## Parameter List ```text 'connectionid' 'buffer' ``` ## Remarks This event is fired to supply another piece of plain data received from a client. This event may fire multiple times. # TLSCertValidate Event ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Fires when a client certificate needs to be validated. ## Object Oriented Interface ```text public function fireTLSCertValidate($param); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_register_callback($res, 9, array($this, 'fireTLSCertValidate')); ``` ## Parameter List ```text 'connectionid' 'accept' ``` ## Remarks The class fires this event to notify the application of an authenticating client. Use the event handler to validate the certificate and pass your decision back to the server component via the *Accept* parameter. # TLSEstablished Event ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Reports the setup of a TLS session. ## Object Oriented Interface ```text public function fireTLSEstablished($param); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_register_callback($res, 10, array($this, 'fireTLSEstablished')); ``` ## Parameter List ```text 'connectionid' ``` ## Remarks Subscribe to this event to be notified about the setup of a TLS connection by a connected client. # TLSHandshake Event ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Fires when a newly established client connection initiates a TLS handshake. ## Object Oriented Interface ```text public function fireTLSHandshake($param); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_register_callback($res, 11, array($this, 'fireTLSHandshake')); ``` ## Parameter List ```text 'connectionid' 'servername' 'abort' ``` ## Remarks Use this event to get notified about the initiation of the TLS handshake by the remote client. The *ServerName* parameter specifies the requested host from the client hello message. # TLSPSK Event ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Requests a pre-shared key for TLS-PSK. ## Object Oriented Interface ```text public function fireTLSPSK($param); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_register_callback($res, 12, array($this, 'fireTLSPSK')); ``` ## Parameter List ```text 'connectionid' 'identity' 'psk' 'ciphersuite' ``` ## Remarks The class fires this event to report that a client has requested a TLS-PSK negotiation. *ConnectionId* indicates the unique connection ID that requested the PSK handshake. Use *Identity* to look up for the corresponding pre-shared key in the server's database, then assign the key to the *PSK* parameter. If TLS 1.3 PSK is used, you will also need to assign the *Ciphersuite* parameter with the cipher suite associated with that identity and their key. # TLSShutdown Event ([SecureBlackbox_DTLSServer](#dtlsserver-class) Class) Reports closure of a TLS session. ## Object Oriented Interface ```text public function fireTLSShutdown($param); ``` ## Procedural Interface ```text secureblackbox_dtlsserver_register_callback($res, 13, array($this, 'fireTLSShutdown')); ``` ## Parameter List ```text 'connectionid' ``` ## Remarks The class fires this event when a connected client closes their TLS session gracefully. This event is typically followed by a [Disconnect](#disconnect-event-secureblackbox_dtlsserver-class), which marks the closure of the underlying TCP session. # Config Settings ([DTLSServer](#dtlsserver-class) Class) The class accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the [Config](#config-method-secureblackbox_dtlsserver-class) method. ### DTLSServer Config Settings **BoundAddress**: Returns the bound address of the listening socket.Use this property to obtain the bound address of the listening socket. **BoundPort**: The port that was bound by the server.Returns the port number that was bound by the server. **ClientAuth**: Enables or disables certificate-based client authentication.Set this property to one of the below values to tune up the client authentication logic: | | | | | --- | --- | --- | | 0 | | No client authentication (the default setting) | | 1 | | Request certificates. The server will ask connecting clients for their certificates. Non-authenticated client connections will be accepted anyway. | | 2 | | Require certificates. The server will ask connecting clients for their certificates. If a client fails to provide a certificate, the server will terminate the connection. | If this property is set to 1 or 2, the component will request certificates from the connecting clients. Depending on the setting, the clients that fail to provide their certificate in response will be allowed or disallowed to proceed with the connection. The server signals about a received certificate by firing its CertificateValidate event. Use [PinClient](#pinclient-method-secureblackbox_dtlsserver-class) method in the event handler to pin the client details, and access the provided certificate chain via the PinnedClientChain property. Note that this event is fired from the connecting clients threads, so please make sure you avoid bottlenecks in the event handler and put appropriate thread safety measures in place. Unlike the client-side components, the server component does not perform automated certificate validation against the local security policy. You must perform appropriate certificate validation steps in your CertificateValidate event handler. **DatagramSize**: Specifies maximum size of the datagram.Use this property to get or set maximum size of the datagram. Data pieces larger than DatagramSize will be split into several smaller datagrams with lengths smaller (or equal) to the DatagramSize. **DualStack**: Allows the use of ip4 and ip6 simultaneously.This setting specifies a socket can use ip4 and ip6 simultaneously. **MaxDataSize**: Specifies maximum size of the packet which will not be divided into smaller ones.Use this read-only property to get the maximum size of the data piece which will not be divided into smaller ones. The value of this property is smaller or equal to the DatagramSize. **PreSharedIdentityHint**: Gets or sets the PSK identity hint.Use this property to get or set the PSK identity hint to be used during PSK-based TLS handshake. **RetransmissionInterval**: Specifies value of the retransmission interval.Use this property to specify the period of time in milliseconds, after which the client will repeat sending. Set this property to 0 to disable the retransmission timer. Default value is 1000 (i.e. 1 second). **SocketHandle**: Returns the socket handle of the connected component.Read this config property to get the socket handle of the active socket. In servers, either pin the specific client connection before checking this property, or pass the connection ID as an index (SocketHandle[connId]). **SocketHandle[i]**: Returns the internal socket handle.Use this property to read the socket handle of the connection number i. **SplitLongData**: Specifies whether to split long datagrams into smaller ones.If this property is set to True, datagrams larger than MaxDataSize will be split into smaller ones. Default value is True. **SrtpMasterKeyLen**: The SRTP master key length.Gets or sets the length, in bytes, of the SRTP master key. The default value is 16. **SrtpMasterSaltLen**: The SRTP master salt length.Gets or sets the length of the SRTP master salt, in bytes. The default setting is 14. **TLSExtensions**: TBD.TBD ### Base Config Settings **ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it. **AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it. **CheckKeyIntegrityBeforeUse**: Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used. You can switch this property off to improve performance if your project only uses known, good private keys. **CookieCaching**: Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class. Supported values are: | | | | | --- | --- | --- | | off | | No caching (default) | | local | | Local caching | | global | | Global caching | **Cookies**: Gets or sets local cookies for the class.Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions. **DefDeriveKeyIterations**: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. **DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*. **EnableClientSideSSLFFDHE**: Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections. This setting only applies to sessions negotiated with TLS version 1.3. **EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components. **EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components. **GlobalCookies**: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its *CookieCaching* property set to "global". **HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy. Supported Values: | | | | --- | --- | | auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). | | enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. | | disable | Do not use hardware cryptography. | **HttpUserAgent**: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes. **HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use. **IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account. **ListDelimiter**: The delimiter character for multi-element lists.Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence. **LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped. Supported values are: | | | | | --- | --- | --- | | file | | File | | console | | Console | | systemlog | | System Log (supported for Android only) | | debugger | | Debugger (supported for VCL for Windows and .Net) | **LogDetails**: Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump. Supported values are: | | | | | --- | --- | --- | | time | | Current time | | level | | Level | | package | | Package name | | module | | Module name | | class | | Class name | | method | | Method name | | threadid | | Thread Id | | contenttype | | Content type | | content | | Content | | all | | All details | **LogFile**: Specifies the debug log filename.Use this property to provide a path to the log file. **LogFilters**: Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters. Supported filter names are: | | | | | --- | --- | --- | | exclude-package | | Exclude a package specified in the value | | exclude-module | | Exclude a module specified in the value | | exclude-class | | Exclude a class specified in the value | | exclude-method | | Exclude a method specified in the value | | include-package | | Include a package specified in the value | | include-module | | Include a module specified in the value | | include-class | | Include a class specified in the value | | include-method | | Include a method specified in the value | **LogFlushMode**: Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined: | | | | | --- | --- | --- | | none | | No flush (caching only) | | immediate | | Immediate flush (real-time logging) | | maxcount | | Flush cached entries upon reaching LogMaxEventCount entries in the cache. | **LogLevel**: Specifies the debug log level.Use this property to provide the desired debug log level. Supported values are: | | | | | --- | --- | --- | | none | | None (by default) | | fatal | | Severe errors that cause premature termination. | | error | | Other runtime errors or unexpected conditions. | | warning | | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | | info | | Interesting runtime events (startup/shutdown). | | debug | | Detailed information on flow of through the system. | | trace | | More detailed information. | **LogMaxEventCount**: Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode. The default value of this setting is 100. **LogRotationMode**: Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined: | | | | | --- | --- | --- | | none | | No rotation | | deleteolder | | Delete older entries from the cache upon reaching LogMaxEventCount | | keepolder | | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) | **MaxASN1BufferLength**: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. **MaxASN1TreeDepth**: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. **OCSPHashAlgorithm**: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. **OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak. **PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached. Supported Values: | | | | --- | --- | | certificate | Enables caching of certificates. | | crl | Enables caching of Certificate Revocation Lists (CRLs). | | ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. | Example (default value): ```text PKICache=certificate,crl,ocsp ``` In this example, the component caches certificates, CRLs, and OCSP responses. **PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts. The default value is an empty string - no cached PKI data is stored on disk. Example: ```text PKICachePath=C:\Temp\cache ``` In this example, the cached PKI data is stored in the C:\Temp\cache directory. **ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision). **ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server. **StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if *UseOwnDNSResolver* is set to *true*. Supported values are: | | | | | --- | --- | --- | | none | | No static DNS rules (default) | | local | | Local static DNS rules | | global | | Global static DNS rules | **StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the *StaticDNS* value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are divided by the | (pipe) character. **StaticIPAddresses**: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If *StaticDNS* of the class is set to "*local*", the property returns/restores the rules from/to the internal storage of the class. If *StaticDNS* of the class is set to "*global*", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format. **Tag**: Allows to store any custom data.Use this config property to store any custom data. **TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes. **TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes). **TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute). **UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used. **UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform. **UseLegacyAdESValidation**: Enables legacy AdES validation mode.Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details). **UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used. **UseOwnDNSResolver**: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one. **UseSharedSystemStorages**: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. **UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team. **UseSystemOAEPAndPSS**: Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation. This setting only applies to certificates originating from a Windows system store. **UseSystemRandom**: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. **XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures. The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing. Syntax: ```text Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2"); ``` Where: OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map. PrimaryName: The main descriptor name used in the XML signature when the OID is encountered. Alias1, Alias2, ...: Optional alternative names recognized during parsing. Usage Examples: Map OID 2.5.4.5 to SERIALNUMBER: ```text Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER"); ``` Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: ```text Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS"); ``` **XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing. **XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1). **XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value. # Trappable Errors ([DTLSServer](#dtlsserver-class) Class) ### DTLSServer Errors | | | | --- | --- | | 1048577 | Invalid parameter ([SB_ERROR_INVALID_PARAMETER](constants.md#const_SBERRORINVALIDPARAMETER)) | | 1048578 | Invalid configuration ([SB_ERROR_INVALID_SETUP](constants.md#const_SBERRORINVALIDSETUP)) | | 1048579 | Invalid state ([SB_ERROR_INVALID_STATE](constants.md#const_SBERRORINVALIDSTATE)) | | 1048580 | Invalid value ([SB_ERROR_INVALID_VALUE](constants.md#const_SBERRORINVALIDVALUE)) | | 1048581 | Private key not found ([SB_ERROR_NO_PRIVATE_KEY](constants.md#const_SBERRORNOPRIVATEKEY)) | | 1048582 | Cancelled by the user ([SB_ERROR_CANCELLED_BY_USER](constants.md#const_SBERRORCANCELLEDBYUSER)) | | 1048583 | The file was not found ([SB_ERROR_NO_SUCH_FILE](constants.md#const_SBERRORNOSUCHFILE)) | | 1048584 | Unsupported feature or operation ([SB_ERROR_UNSUPPORTED_FEATURE](constants.md#const_SBERRORUNSUPPORTEDFEATURE)) | | 1048585 | General error ([SB_ERROR_GENERAL_ERROR](constants.md#const_SBERRORGENERALERROR)) |