# TLSClient Component The TLSClient component provides client-side functionality of the TLS protocol. ## Syntax ```text TsbxTLSClient ``` ## Remarks Use this component to set up secure connections from your application. TLSClient offers comprehensive support for all versions of the TLS protocol, including the most popular TLS 1.2 and the newest TLS 1.3. Among other features this component can offer are: - Certificate-based and PSK authentication types are supported, making this component the ideal fit for all sorts of Internet environments. - Support for efficient reconnections using TLS session resume approach. - Comprehensive support for all existing cipher suites. - DH and Elliptic Curve key exchange algorithms. - Support for SNI, Extended Master Secret, Cookie, and other protocol extensions included as standard. - Support for secure renegotiation. - Resistant to all known TLS attacks (heartbleed, POODLE, BEAST, and others). With TLS mode switched off, this component turns to an efficient TCP socket client. ## Property List *The following is the full list of the properties of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [BlockedCertCount](#blockedcertcount-property-tlsclient-component) | The number of records in the BlockedCert arrays. | | [BlockedCertBytes](#blockedcertbytes-property-tlsclient-component) | Returns the raw certificate data in DER format. | | [BlockedCertHandle](#blockedcerthandle-property-tlsclient-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [Connected](#connected-property-tlsclient-component) | Indicates whether the connection is active. | | [ConnInfoAEADCipher](#conninfoaeadcipher-property-tlsclient-component) | Indicates whether the encryption algorithm used is an AEAD cipher. | | [ConnInfoChainValidationDetails](#conninfochainvalidationdetails-property-tlsclient-component) | The details of a certificate chain validation outcome. | | [ConnInfoChainValidationResult](#conninfochainvalidationresult-property-tlsclient-component) | The outcome of a certificate chain validation routine. | | [ConnInfoCiphersuite](#conninfociphersuite-property-tlsclient-component) | The cipher suite employed by this connection. | | [ConnInfoClientAuthenticated](#conninfoclientauthenticated-property-tlsclient-component) | Specifies whether client authentication was performed during this connection. | | [ConnInfoClientAuthRequested](#conninfoclientauthrequested-property-tlsclient-component) | Specifies whether client authentication was requested during this connection. | | [ConnInfoConnectionEstablished](#conninfoconnectionestablished-property-tlsclient-component) | Indicates whether the connection has been established fully. | | [ConnInfoConnectionID](#conninfoconnectionid-property-tlsclient-component) | The unique identifier assigned to this connection. | | [ConnInfoDigestAlgorithm](#conninfodigestalgorithm-property-tlsclient-component) | The digest algorithm used in a TLS-enabled connection. | | [ConnInfoEncryptionAlgorithm](#conninfoencryptionalgorithm-property-tlsclient-component) | The symmetric encryption algorithm used in a TLS-enabled connection. | | [ConnInfoExportable](#conninfoexportable-property-tlsclient-component) | Indicates whether a TLS connection uses a reduced-strength exportable cipher. | | [ConnInfoGroup](#conninfogroup-property-tlsclient-component) | The elliptic curve used in this connection. | | [ConnInfoID](#conninfoid-property-tlsclient-component) | The client connection's unique identifier. | | [ConnInfoKeyExchangeAlgorithm](#conninfokeyexchangealgorithm-property-tlsclient-component) | The key exchange algorithm used in a TLS-enabled connection. | | [ConnInfoKeyExchangeKeyBits](#conninfokeyexchangekeybits-property-tlsclient-component) | The length of the key exchange key of a TLS-enabled connection. | | [ConnInfoPFSCipher](#conninfopfscipher-property-tlsclient-component) | Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). | | [ConnInfoPreSharedIdentity](#conninfopresharedidentity-property-tlsclient-component) | Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. | | [ConnInfoPreSharedIdentityHint](#conninfopresharedidentityhint-property-tlsclient-component) | A hint professed by the server to help the client select the PSK identity to use. | | [ConnInfoPublicKeyBits](#conninfopublickeybits-property-tlsclient-component) | The length of the public key. | | [ConnInfoRemoteAddress](#conninforemoteaddress-property-tlsclient-component) | The client's IP address. | | [ConnInfoRemotePort](#conninforemoteport-property-tlsclient-component) | The remote port of the client connection. | | [ConnInfoResumedSession](#conninforesumedsession-property-tlsclient-component) | Indicates whether a TLS-enabled connection was spawned from another TLS connection. | | [ConnInfoSecureConnection](#conninfosecureconnection-property-tlsclient-component) | Indicates whether TLS or SSL is enabled for this connection. | | [ConnInfoServerAuthenticated](#conninfoserverauthenticated-property-tlsclient-component) | Indicates whether server authentication was performed during a TLS-enabled connection. | | [ConnInfoSignatureAlgorithm](#conninfosignaturealgorithm-property-tlsclient-component) | The signature algorithm used in a TLS handshake. | | [ConnInfoSymmetricBlockSize](#conninfosymmetricblocksize-property-tlsclient-component) | The block size of the symmetric algorithm used. | | [ConnInfoSymmetricKeyBits](#conninfosymmetrickeybits-property-tlsclient-component) | The key length of the symmetric algorithm used. | | [ConnInfoTotalBytesReceived](#conninfototalbytesreceived-property-tlsclient-component) | The total number of bytes received over this connection. | | [ConnInfoTotalBytesSent](#conninfototalbytessent-property-tlsclient-component) | The total number of bytes sent over this connection. | | [ConnInfoValidationLog](#conninfovalidationlog-property-tlsclient-component) | Contains the server certificate's chain validation log. | | [ConnInfoVersion](#conninfoversion-property-tlsclient-component) | Indicates the version of SSL/TLS protocol negotiated during this connection. | | [ExternalCryptoAsyncDocumentID](#externalcryptoasyncdocumentid-property-tlsclient-component) | Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. | | [ExternalCryptoCustomParams](#externalcryptocustomparams-property-tlsclient-component) | Custom parameters to be passed to the signing service (uninterpreted). | | [ExternalCryptoData](#externalcryptodata-property-tlsclient-component) | Additional data to be included in the async state and mirrored back by the requestor. | | [ExternalCryptoExternalHashCalculation](#externalcryptoexternalhashcalculation-property-tlsclient-component) | Specifies whether the message hash is to be calculated at the external endpoint. | | [ExternalCryptoHashAlgorithm](#externalcryptohashalgorithm-property-tlsclient-component) | Specifies the request's signature hash algorithm. | | [ExternalCryptoKeyID](#externalcryptokeyid-property-tlsclient-component) | The ID of the pre-shared key used for DC request authentication. | | [ExternalCryptoKeySecret](#externalcryptokeysecret-property-tlsclient-component) | The pre-shared key used for DC request authentication. | | [ExternalCryptoMethod](#externalcryptomethod-property-tlsclient-component) | Specifies the asynchronous signing method. | | [ExternalCryptoMode](#externalcryptomode-property-tlsclient-component) | Specifies the external cryptography mode. | | [ExternalCryptoPublicKeyAlgorithm](#externalcryptopublickeyalgorithm-property-tlsclient-component) | Provide the public key algorithm here if the certificate is not available on the pre-signing stage. | | [FIPSMode](#fipsmode-property-tlsclient-component) | Reserved. | | [KnownCertCount](#knowncertcount-property-tlsclient-component) | The number of records in the KnownCert arrays. | | [KnownCertBytes](#knowncertbytes-property-tlsclient-component) | Returns the raw certificate data in DER format. | | [KnownCertHandle](#knowncerthandle-property-tlsclient-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [KnownCRLCount](#knowncrlcount-property-tlsclient-component) | The number of records in the KnownCRL arrays. | | [KnownCRLBytes](#knowncrlbytes-property-tlsclient-component) | Returns the raw CRL data in DER format. | | [KnownCRLHandle](#knowncrlhandle-property-tlsclient-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [KnownOCSPCount](#knownocspcount-property-tlsclient-component) | The number of records in the KnownOCSP arrays. | | [KnownOCSPBytes](#knownocspbytes-property-tlsclient-component) | A buffer containing the raw OCSP response data. | | [KnownOCSPHandle](#knownocsphandle-property-tlsclient-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [OutputBytes](#outputbytes-property-tlsclient-component) | A memory buffer where the incoming data is collected. | | [OutputString](#outputstring-property-tlsclient-component) | A string where the incoming data is collected. | | [ProxyAddress](#proxyaddress-property-tlsclient-component) | The IP address of the proxy server. | | [ProxyAuthentication](#proxyauthentication-property-tlsclient-component) | The authentication type used by the proxy server. | | [ProxyPassword](#proxypassword-property-tlsclient-component) | The password to authenticate to the proxy server. | | [ProxyPort](#proxyport-property-tlsclient-component) | The port on the proxy server to connect to. | | [ProxyType](#proxytype-property-tlsclient-component) | The type of the proxy server. | | [ProxyRequestHeaders](#proxyrequestheaders-property-tlsclient-component) | Contains HTTP request headers for WebTunnel and HTTP proxy. | | [ProxyResponseBody](#proxyresponsebody-property-tlsclient-component) | Contains the HTTP or HTTPS (WebTunnel) proxy response body. | | [ProxyResponseHeaders](#proxyresponseheaders-property-tlsclient-component) | Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. | | [ProxyUseIPv6](#proxyuseipv6-property-tlsclient-component) | Specifies whether IPv6 should be used when connecting through the proxy. | | [ProxyUsername](#proxyusername-property-tlsclient-component) | Specifies the username credential for proxy authentication. | | [SocketDNSMode](#socketdnsmode-property-tlsclient-component) | Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system. | | [SocketDNSPort](#socketdnsport-property-tlsclient-component) | Specifies the port number to be used for sending queries to the DNS server. | | [SocketDNSQueryTimeout](#socketdnsquerytimeout-property-tlsclient-component) | The timeout (in milliseconds) for each DNS query. | | [SocketDNSServers](#socketdnsservers-property-tlsclient-component) | The addresses of DNS servers to use for address resolution, separated by commas or semicolons. | | [SocketDNSTotalTimeout](#socketdnstotaltimeout-property-tlsclient-component) | The timeout (in milliseconds) for the whole resolution process. | | [SocketIncomingSpeedLimit](#socketincomingspeedlimit-property-tlsclient-component) | The maximum number of bytes to read from the socket, per second. | | [SocketLocalAddress](#socketlocaladdress-property-tlsclient-component) | The local network interface to bind the socket to. | | [SocketLocalPort](#socketlocalport-property-tlsclient-component) | The local port number to bind the socket to. | | [SocketOutgoingSpeedLimit](#socketoutgoingspeedlimit-property-tlsclient-component) | The maximum number of bytes to write to the socket, per second. | | [SocketTimeout](#sockettimeout-property-tlsclient-component) | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. | | [SocketUseIPv6](#socketuseipv6-property-tlsclient-component) | Enables or disables IP protocol version 6. | | [TLSClientCertCount](#tlsclientcertcount-property-tlsclient-component) | The number of records in the TLSClientCert arrays. | | [TLSClientCertBytes](#tlsclientcertbytes-property-tlsclient-component) | Returns the raw certificate data in DER format. | | [TLSClientCertHandle](#tlsclientcerthandle-property-tlsclient-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [TLSServerCertCount](#tlsservercertcount-property-tlsclient-component) | The number of records in the TLSServerCert arrays. | | [TLSServerCertBytes](#tlsservercertbytes-property-tlsclient-component) | Returns the raw certificate data in DER format. | | [TLSServerCertFingerprint](#tlsservercertfingerprint-property-tlsclient-component) | Contains the fingerprint (a hash imprint) of this certificate. | | [TLSServerCertHandle](#tlsservercerthandle-property-tlsclient-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [TLSServerCertIssuer](#tlsservercertissuer-property-tlsclient-component) | The common name of the certificate issuer (CA), typically a company name. | | [TLSServerCertIssuerRDN](#tlsservercertissuerrdn-property-tlsclient-component) | A list of Property=Value pairs that uniquely identify the certificate issuer. | | [TLSServerCertKeyAlgorithm](#tlsservercertkeyalgorithm-property-tlsclient-component) | Specifies the public key algorithm of this certificate. | | [TLSServerCertKeyBits](#tlsservercertkeybits-property-tlsclient-component) | Returns the length of the public key in bits. | | [TLSServerCertKeyUsage](#tlsservercertkeyusage-property-tlsclient-component) | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. | | [TLSServerCertSelfSigned](#tlsservercertselfsigned-property-tlsclient-component) | Indicates whether the certificate is self-signed (root) or signed by an external CA. | | [TLSServerCertSerialNumber](#tlsservercertserialnumber-property-tlsclient-component) | Returns the certificate's serial number. | | [TLSServerCertSigAlgorithm](#tlsservercertsigalgorithm-property-tlsclient-component) | Indicates the algorithm that was used by the CA to sign this certificate. | | [TLSServerCertSubject](#tlsservercertsubject-property-tlsclient-component) | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. | | [TLSServerCertSubjectRDN](#tlsservercertsubjectrdn-property-tlsclient-component) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). | | [TLSServerCertValidFrom](#tlsservercertvalidfrom-property-tlsclient-component) | The time point at which the certificate becomes valid, in UTC. | | [TLSServerCertValidTo](#tlsservercertvalidto-property-tlsclient-component) | The time point at which the certificate expires, in UTC. | | [TLSAutoValidateCertificates](#tlsautovalidatecertificates-property-tlsclient-component) | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. | | [TLSBaseConfiguration](#tlsbaseconfiguration-property-tlsclient-component) | Selects the base configuration for the TLS settings. | | [TLSCiphersuites](#tlsciphersuites-property-tlsclient-component) | A list of ciphersuites separated with commas or semicolons. | | [TLSClientAuth](#tlsclientauth-property-tlsclient-component) | Enables or disables certificate-based client authentication. | | [TLSExtensions](#tlsextensions-property-tlsclient-component) | Provides access to TLS extensions. | | [TLSForceResumeIfDestinationChanges](#tlsforceresumeifdestinationchanges-property-tlsclient-component) | Whether to force TLS session resumption when the destination address changes. | | [TLSGroups](#tlsgroups-property-tlsclient-component) | Specifies a list of key exchange groups to attempt during the TLS key exchange. | | [TLSPreSharedIdentity](#tlspresharedidentity-property-tlsclient-component) | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. | | [TLSPreSharedKey](#tlspresharedkey-property-tlsclient-component) | Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. | | [TLSPreSharedKeyCiphersuite](#tlspresharedkeyciphersuite-property-tlsclient-component) | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. | | [TLSRenegotiationAttackPreventionMode](#tlsrenegotiationattackpreventionmode-property-tlsclient-component) | Selects the renegotiation attack prevention mechanism. | | [TLSRevocationCheck](#tlsrevocationcheck-property-tlsclient-component) | Specifies the kind(s) of revocation check to perform. | | [TLSSSLOptions](#tlsssloptions-property-tlsclient-component) | 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-tlsclient-component) | Specifies the TLS mode to use. | | [TLSUseExtendedMasterSecret](#tlsuseextendedmastersecret-property-tlsclient-component) | Enables the Extended Master Secret Extension, as defined in RFC 7627. | | [TLSUseSessionResumption](#tlsusesessionresumption-property-tlsclient-component) | Enables or disables the TLS session resumption capability. | | [TLSVersions](#tlsversions-property-tlsclient-component) | The SSL/TLS versions to enable by default. | | [TrustedCertCount](#trustedcertcount-property-tlsclient-component) | The number of records in the TrustedCert arrays. | | [TrustedCertBytes](#trustedcertbytes-property-tlsclient-component) | Returns the raw certificate data in DER format. | | [TrustedCertHandle](#trustedcerthandle-property-tlsclient-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | ## Method List *The following is the full list of the methods of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Config](#config-method-tlsclient-component) | Sets or retrieves a configuration setting. | | [Connect](#connect-method-tlsclient-component) | Establishes connection to a remote server. | | [Disconnect](#disconnect-method-tlsclient-component) | Disconnects from the server. | | [DoAction](#doaction-method-tlsclient-component) | Performs an additional action. | | [ExportKeyMaterial](#exportkeymaterial-method-tlsclient-component) | Derives key material from the session's master key using the TLS exporters scheme. | | [ReceiveAllData](#receivealldata-method-tlsclient-component) | Reads data from the connection. | | [ReceiveData](#receivedata-method-tlsclient-component) | Reads data from the connection. | | [Reset](#reset-method-tlsclient-component) | Resets the component settings. | | [SendData](#senddata-method-tlsclient-component) | Sends a buffer to the server. | | [SendKeepAlive](#sendkeepalive-method-tlsclient-component) | Sends a keep-alive packet. | | [SendText](#sendtext-method-tlsclient-component) | Sends a text string to the server. | | [StartTLS](#starttls-method-tlsclient-component) | Starts TLS negotiation on an established TCP connection. | | [StopTLS](#stoptls-method-tlsclient-component) | Downgrades the protected connection to plain TCP. | ## Event List *The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Error](#error-event-tlsclient-component) | Information about errors during data delivery. | | [ExternalSign](#externalsign-event-tlsclient-component) | Handles remote or external signing initiated by the SignExternal method or other source. | | [Notification](#notification-event-tlsclient-component) | This event notifies the application about an underlying control flow event. | | [TLSCertNeeded](#tlscertneeded-event-tlsclient-component) | Fires when a remote TLS party requests a client certificate. | | [TLSCertValidate](#tlscertvalidate-event-tlsclient-component) | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. | | [TLSEstablished](#tlsestablished-event-tlsclient-component) | Fires when a TLS handshake with Host successfully completes. | | [TLSHandshake](#tlshandshake-event-tlsclient-component) | Fires when a new TLS handshake is initiated, before the handshake commences. | | [TLSPSK](#tlspsk-event-tlsclient-component) | Notifies the application about the PSK key exchange. | | [TLSShutdown](#tlsshutdown-event-tlsclient-component) | Reports the graceful closure of a TLS connection. | ## Config Settings *The following is a list of config settings for the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [CachedCRLMaxAge](#CachedCRLMaxAge) | Specifies the maximum age of a cached CRL. | | [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio) | Specifies the maximum age of a cached CRL as a percentage of its remaining lifetime. | | [CachedCRLOverlapTime](#CachedCRLOverlapTime) | Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed. | | [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) | Specifies the maximum age of a cached OCSP response. | | [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio) | Specifies the maximum age of a cached OCSP response as a percentage of its remaining lifetime. | | [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime) | Specifies the time period before a cached OCSP response's NextUpdate when it is considered stale and must be refreshed. | | [DeltaCRLPreference](#DeltaCRLPreference) | Specifies whether complete or delta CRLs are preferred. | | [EvaluateSystemTrust](#EvaluateSystemTrust) | Enables or disables usage of the platform's built-in trust validation facilities. | | [IgnoreSystemTrust](#IgnoreSystemTrust) | Whether trusted Windows Certificate Stores should be treated as trusted. | | [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) | Specifies a preset policy for cached CRL and OCSP response freshness settings. | | [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. | | [TLSCiphersuites](#TLSCiphersuites) | Returns the list of ciphersuites activated in the component for the current session. | | [TLSExtensions](#TLSExtensions) | TBD. | | [TLSGroups](#TLSGroups) | Returns the list of TLS key exchange groups enabled in the component. | | [TLSPeerExtensions](#TLSPeerExtensions) | TBD. | | [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. | | [TLSVersions](#TLSVersions) | Returns the list of TLS versions enabled in the component. | | [TolerateMinorChainIssues](#TolerateMinorChainIssues) | Whether to tolerate minor chain issues. | | [UseEnvStorages](#UseEnvStorages) | Enables or disables use of the environment storages. | | [UseMicrosoftCTL](#UseMicrosoftCTL) | Enables or disables the automatic use of the Microsoft online certificate trust list. | | [UseSystemCertificates](#UseSystemCertificates) | Enables or disables the use of the system certificates. | | [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 component. | | [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 components. | | [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server components. | | [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 components 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 components 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. | # BlockedCertCount Property ([TLSClient](#tlsclient-component) Component) The number of records in the BlockedCert arrays. ## Syntax *C++ Builder Syntax* ```text __property int BlockedCertCount = { read=FBlockedCertCount, write=FSetBlockedCertCount }; ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [BlockedCertBytes](#blockedcertbytes-property-tlsclient-component) - [BlockedCertHandle](#blockedcerthandle-property-tlsclient-component) The array indices start at *0* and end at *BlockedCertCount - 1*. This property is not available at design time. ## Data Type Integer # BlockedCertBytes Property ([TLSClient](#tlsclient-component) Component) Returns the raw certificate data in DER format. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray BlockedCertBytes[int BlockedCertIndex] = { read=FBlockedCertBytes }; ``` ## Remarks Returns the raw certificate data in DER format. The *BlockedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blockedcertcount-property-tlsclient-component) property. This property is read-only and not available at design time. ## Data Type Byte Array # BlockedCertHandle Property ([TLSClient](#tlsclient-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *C++ Builder Syntax* ```text __property __int64 BlockedCertHandle[int BlockedCertIndex] = { read=FBlockedCertHandle, write=FSetBlockedCertHandle }; ``` ## 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 *BlockedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [BlockedCertCount](#blockedcertcount-property-tlsclient-component) property. This property is not available at design time. ## Data Type Long64 # Connected Property ([TLSClient](#tlsclient-component) Component) Indicates whether the connection is active. ## Syntax *C++ Builder Syntax* ```text __property bool Connected = { read=FConnected }; ``` ## Default Value false ## Remarks Use this property to check if the connection is alive. This property is read-only and not available at design time. ## Data Type Boolean # ConnInfoAEADCipher Property ([TLSClient](#tlsclient-component) Component) Indicates whether the encryption algorithm used is an AEAD cipher. ## Syntax *C++ Builder Syntax* ```text __property bool ConnInfoAEADCipher = { read=FConnInfoAEADCipher }; ``` ## 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 # ConnInfoChainValidationDetails Property ([TLSClient](#tlsclient-component) Component) The details of a certificate chain validation outcome. ## Syntax *C++ Builder Syntax* ```text __property int ConnInfoChainValidationDetails = { read=FConnInfoChainValidationDetails }; ``` ## 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 # ConnInfoChainValidationResult Property ([TLSClient](#tlsclient-component) Component) The outcome of a certificate chain validation routine. ## Syntax *C++ Builder Syntax* ```text __property TsbxTLSClientConnInfoChainValidationResults ConnInfoChainValidationResult = { read=FConnInfoChainValidationResult }; enum TsbxTLSClientConnInfoChainValidationResults { cvtValid=0, cvtValidButUntrusted=1, cvtInvalid=2, cvtCantBeEstablished=3 }; ``` ## Default Value cvtValid ## 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 # ConnInfoCiphersuite Property ([TLSClient](#tlsclient-component) Component) The cipher suite employed by this connection. ## Syntax *C++ Builder Syntax* ```text __property String ConnInfoCiphersuite = { read=FConnInfoCiphersuite }; ``` ## 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 # ConnInfoClientAuthenticated Property ([TLSClient](#tlsclient-component) Component) Specifies whether client authentication was performed during this connection. ## Syntax *C++ Builder Syntax* ```text __property bool ConnInfoClientAuthenticated = { read=FConnInfoClientAuthenticated }; ``` ## 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 # ConnInfoClientAuthRequested Property ([TLSClient](#tlsclient-component) Component) Specifies whether client authentication was requested during this connection. ## Syntax *C++ Builder Syntax* ```text __property bool ConnInfoClientAuthRequested = { read=FConnInfoClientAuthRequested }; ``` ## 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 # ConnInfoConnectionEstablished Property ([TLSClient](#tlsclient-component) Component) Indicates whether the connection has been established fully. ## Syntax *C++ Builder Syntax* ```text __property bool ConnInfoConnectionEstablished = { read=FConnInfoConnectionEstablished }; ``` ## 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 # ConnInfoConnectionID Property ([TLSClient](#tlsclient-component) Component) The unique identifier assigned to this connection. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray ConnInfoConnectionID = { read=FConnInfoConnectionID }; ``` ## Remarks The unique identifier assigned to this connection. This property is read-only and not available at design time. ## Data Type Byte Array # ConnInfoDigestAlgorithm Property ([TLSClient](#tlsclient-component) Component) The digest algorithm used in a TLS-enabled connection. ## Syntax *C++ Builder Syntax* ```text __property String ConnInfoDigestAlgorithm = { read=FConnInfoDigestAlgorithm }; ``` ## 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 # ConnInfoEncryptionAlgorithm Property ([TLSClient](#tlsclient-component) Component) The symmetric encryption algorithm used in a TLS-enabled connection. ## Syntax *C++ Builder Syntax* ```text __property String ConnInfoEncryptionAlgorithm = { read=FConnInfoEncryptionAlgorithm }; ``` ## 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 # ConnInfoExportable Property ([TLSClient](#tlsclient-component) Component) Indicates whether a TLS connection uses a reduced-strength exportable cipher. ## Syntax *C++ Builder Syntax* ```text __property bool ConnInfoExportable = { read=FConnInfoExportable }; ``` ## 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 # ConnInfoGroup Property ([TLSClient](#tlsclient-component) Component) The elliptic curve used in this connection. ## Syntax *C++ Builder Syntax* ```text __property String ConnInfoGroup = { read=FConnInfoGroup }; ``` ## 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 # ConnInfoID Property ([TLSClient](#tlsclient-component) Component) The client connection's unique identifier. ## Syntax *C++ Builder Syntax* ```text __property __int64 ConnInfoID = { read=FConnInfoID }; ``` ## 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 # ConnInfoKeyExchangeAlgorithm Property ([TLSClient](#tlsclient-component) Component) The key exchange algorithm used in a TLS-enabled connection. ## Syntax *C++ Builder Syntax* ```text __property String ConnInfoKeyExchangeAlgorithm = { read=FConnInfoKeyExchangeAlgorithm }; ``` ## 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 # ConnInfoKeyExchangeKeyBits Property ([TLSClient](#tlsclient-component) Component) The length of the key exchange key of a TLS-enabled connection. ## Syntax *C++ Builder Syntax* ```text __property int ConnInfoKeyExchangeKeyBits = { read=FConnInfoKeyExchangeKeyBits }; ``` ## 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 # ConnInfoPFSCipher Property ([TLSClient](#tlsclient-component) Component) Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). ## Syntax *C++ Builder Syntax* ```text __property bool ConnInfoPFSCipher = { read=FConnInfoPFSCipher }; ``` ## 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 # ConnInfoPreSharedIdentity Property ([TLSClient](#tlsclient-component) Component) Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. ## Syntax *C++ Builder Syntax* ```text __property String ConnInfoPreSharedIdentity = { read=FConnInfoPreSharedIdentity }; ``` ## 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 # ConnInfoPreSharedIdentityHint Property ([TLSClient](#tlsclient-component) Component) A hint professed by the server to help the client select the PSK identity to use. ## Syntax *C++ Builder Syntax* ```text __property String ConnInfoPreSharedIdentityHint = { read=FConnInfoPreSharedIdentityHint }; ``` ## 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 # ConnInfoPublicKeyBits Property ([TLSClient](#tlsclient-component) Component) The length of the public key. ## Syntax *C++ Builder Syntax* ```text __property int ConnInfoPublicKeyBits = { read=FConnInfoPublicKeyBits }; ``` ## Default Value 0 ## Remarks The length of the public key. This property is read-only and not available at design time. ## Data Type Integer # ConnInfoRemoteAddress Property ([TLSClient](#tlsclient-component) Component) The client's IP address. ## Syntax *C++ Builder Syntax* ```text __property String ConnInfoRemoteAddress = { read=FConnInfoRemoteAddress }; ``` ## Default Value "" ## Remarks The client's IP address. This property is read-only and not available at design time. ## Data Type String # ConnInfoRemotePort Property ([TLSClient](#tlsclient-component) Component) The remote port of the client connection. ## Syntax *C++ Builder Syntax* ```text __property int ConnInfoRemotePort = { read=FConnInfoRemotePort }; ``` ## 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 # ConnInfoResumedSession Property ([TLSClient](#tlsclient-component) Component) Indicates whether a TLS-enabled connection was spawned from another TLS connection. ## Syntax *C++ Builder Syntax* ```text __property bool ConnInfoResumedSession = { read=FConnInfoResumedSession }; ``` ## 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 # ConnInfoSecureConnection Property ([TLSClient](#tlsclient-component) Component) Indicates whether TLS or SSL is enabled for this connection. ## Syntax *C++ Builder Syntax* ```text __property bool ConnInfoSecureConnection = { read=FConnInfoSecureConnection }; ``` ## 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 # ConnInfoServerAuthenticated Property ([TLSClient](#tlsclient-component) Component) Indicates whether server authentication was performed during a TLS-enabled connection. ## Syntax *C++ Builder Syntax* ```text __property bool ConnInfoServerAuthenticated = { read=FConnInfoServerAuthenticated }; ``` ## 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 # ConnInfoSignatureAlgorithm Property ([TLSClient](#tlsclient-component) Component) The signature algorithm used in a TLS handshake. ## Syntax *C++ Builder Syntax* ```text __property String ConnInfoSignatureAlgorithm = { read=FConnInfoSignatureAlgorithm }; ``` ## 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 # ConnInfoSymmetricBlockSize Property ([TLSClient](#tlsclient-component) Component) The block size of the symmetric algorithm used. ## Syntax *C++ Builder Syntax* ```text __property int ConnInfoSymmetricBlockSize = { read=FConnInfoSymmetricBlockSize }; ``` ## 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 # ConnInfoSymmetricKeyBits Property ([TLSClient](#tlsclient-component) Component) The key length of the symmetric algorithm used. ## Syntax *C++ Builder Syntax* ```text __property int ConnInfoSymmetricKeyBits = { read=FConnInfoSymmetricKeyBits }; ``` ## 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 # ConnInfoTotalBytesReceived Property ([TLSClient](#tlsclient-component) Component) The total number of bytes received over this connection. ## Syntax *C++ Builder Syntax* ```text __property __int64 ConnInfoTotalBytesReceived = { read=FConnInfoTotalBytesReceived }; ``` ## 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 # ConnInfoTotalBytesSent Property ([TLSClient](#tlsclient-component) Component) The total number of bytes sent over this connection. ## Syntax *C++ Builder Syntax* ```text __property __int64 ConnInfoTotalBytesSent = { read=FConnInfoTotalBytesSent }; ``` ## 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 # ConnInfoValidationLog Property ([TLSClient](#tlsclient-component) Component) Contains the server certificate's chain validation log. ## Syntax *C++ Builder Syntax* ```text __property String ConnInfoValidationLog = { read=FConnInfoValidationLog }; ``` ## 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 # ConnInfoVersion Property ([TLSClient](#tlsclient-component) Component) Indicates the version of SSL/TLS protocol negotiated during this connection. ## Syntax *C++ Builder Syntax* ```text __property String ConnInfoVersion = { read=FConnInfoVersion }; ``` ## 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 # ExternalCryptoAsyncDocumentID Property ([TLSClient](#tlsclient-component) Component) Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. ## Syntax *C++ Builder Syntax* ```text __property String ExternalCryptoAsyncDocumentID = { read=FExternalCryptoAsyncDocumentID, write=FSetExternalCryptoAsyncDocumentID }; ``` ## 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 ([TLSClient](#tlsclient-component) Component) Custom parameters to be passed to the signing service (uninterpreted). ## Syntax *C++ Builder Syntax* ```text __property String ExternalCryptoCustomParams = { read=FExternalCryptoCustomParams, write=FSetExternalCryptoCustomParams }; ``` ## 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 ([TLSClient](#tlsclient-component) Component) Additional data to be included in the async state and mirrored back by the requestor. ## Syntax *C++ Builder Syntax* ```text __property String ExternalCryptoData = { read=FExternalCryptoData, write=FSetExternalCryptoData }; ``` ## 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 ([TLSClient](#tlsclient-component) Component) Specifies whether the message hash is to be calculated at the external endpoint. ## Syntax *C++ Builder Syntax* ```text __property bool ExternalCryptoExternalHashCalculation = { read=FExternalCryptoExternalHashCalculation, write=FSetExternalCryptoExternalHashCalculation }; ``` ## 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 component. If set to true, the component 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 ([TLSClient](#tlsclient-component) Component) Specifies the request's signature hash algorithm. ## Syntax *C++ Builder Syntax* ```text __property String ExternalCryptoHashAlgorithm = { read=FExternalCryptoHashAlgorithm, write=FSetExternalCryptoHashAlgorithm }; ``` ## 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 ([TLSClient](#tlsclient-component) Component) The ID of the pre-shared key used for DC request authentication. ## Syntax *C++ Builder Syntax* ```text __property String ExternalCryptoKeyID = { read=FExternalCryptoKeyID, write=FSetExternalCryptoKeyID }; ``` ## 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-tlsclient-component) 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 ([TLSClient](#tlsclient-component) Component) The pre-shared key used for DC request authentication. ## Syntax *C++ Builder Syntax* ```text __property String ExternalCryptoKeySecret = { read=FExternalCryptoKeySecret, write=FSetExternalCryptoKeySecret }; ``` ## 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-tlsclient-component) topic. ## Data Type String # ExternalCryptoMethod Property ([TLSClient](#tlsclient-component) Component) Specifies the asynchronous signing method. ## Syntax *C++ Builder Syntax* ```text __property TsbxTLSClientExternalCryptoMethods ExternalCryptoMethod = { read=FExternalCryptoMethod, write=FSetExternalCryptoMethod }; enum TsbxTLSClientExternalCryptoMethods { asmdPKCS1=0, asmdPKCS7=1 }; ``` ## Default Value asmdPKCS1 ## 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 ([TLSClient](#tlsclient-component) Component) Specifies the external cryptography mode. ## Syntax *C++ Builder Syntax* ```text __property TsbxTLSClientExternalCryptoModes ExternalCryptoMode = { read=FExternalCryptoMode, write=FSetExternalCryptoMode }; enum TsbxTLSClientExternalCryptoModes { ecmDefault=0, ecmDisabled=1, ecmGeneric=2, ecmDCAuth=3, ecmDCAuthJSON=4 }; ``` ## Default Value ecmDefault ## 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 ([TLSClient](#tlsclient-component) Component) Provide the public key algorithm here if the certificate is not available on the pre-signing stage. ## Syntax *C++ Builder Syntax* ```text __property String ExternalCryptoPublicKeyAlgorithm = { read=FExternalCryptoPublicKeyAlgorithm, write=FSetExternalCryptoPublicKeyAlgorithm }; ``` ## 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 ([TLSClient](#tlsclient-component) Component) Reserved. ## Syntax *C++ Builder Syntax* ```text __property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode }; ``` ## Default Value false ## Remarks This property is reserved for future use. ## Data Type Boolean # KnownCertCount Property ([TLSClient](#tlsclient-component) Component) The number of records in the KnownCert arrays. ## Syntax *C++ Builder Syntax* ```text __property int KnownCertCount = { read=FKnownCertCount, write=FSetKnownCertCount }; ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [KnownCertBytes](#knowncertbytes-property-tlsclient-component) - [KnownCertHandle](#knowncerthandle-property-tlsclient-component) The array indices start at *0* and end at *KnownCertCount - 1*. This property is not available at design time. ## Data Type Integer # KnownCertBytes Property ([TLSClient](#tlsclient-component) Component) Returns the raw certificate data in DER format. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray KnownCertBytes[int KnownCertIndex] = { read=FKnownCertBytes }; ``` ## Remarks Returns the raw certificate data in DER format. The *KnownCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#knowncertcount-property-tlsclient-component) property. This property is read-only and not available at design time. ## Data Type Byte Array # KnownCertHandle Property ([TLSClient](#tlsclient-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *C++ Builder Syntax* ```text __property __int64 KnownCertHandle[int KnownCertIndex] = { read=FKnownCertHandle, write=FSetKnownCertHandle }; ``` ## 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 *KnownCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#knowncertcount-property-tlsclient-component) property. This property is not available at design time. ## Data Type Long64 # KnownCRLCount Property ([TLSClient](#tlsclient-component) Component) The number of records in the KnownCRL arrays. ## Syntax *C++ Builder Syntax* ```text __property int KnownCRLCount = { read=FKnownCRLCount, write=FSetKnownCRLCount }; ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [KnownCRLBytes](#knowncrlbytes-property-tlsclient-component) - [KnownCRLHandle](#knowncrlhandle-property-tlsclient-component) The array indices start at *0* and end at *KnownCRLCount - 1*. This property is not available at design time. ## Data Type Integer # KnownCRLBytes Property ([TLSClient](#tlsclient-component) Component) Returns the raw CRL data in DER format. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray KnownCRLBytes[int KnownCRLIndex] = { read=FKnownCRLBytes }; ``` ## Remarks Returns the raw CRL data in DER format. The *KnownCRLIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCRLCount](#knowncrlcount-property-tlsclient-component) property. This property is read-only and not available at design time. ## Data Type Byte Array # KnownCRLHandle Property ([TLSClient](#tlsclient-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *C++ Builder Syntax* ```text __property __int64 KnownCRLHandle[int KnownCRLIndex] = { read=FKnownCRLHandle, write=FSetKnownCRLHandle }; ``` ## 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 *KnownCRLIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCRLCount](#knowncrlcount-property-tlsclient-component) property. This property is not available at design time. ## Data Type Long64 # KnownOCSPCount Property ([TLSClient](#tlsclient-component) Component) The number of records in the KnownOCSP arrays. ## Syntax *C++ Builder Syntax* ```text __property int KnownOCSPCount = { read=FKnownOCSPCount, write=FSetKnownOCSPCount }; ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [KnownOCSPBytes](#knownocspbytes-property-tlsclient-component) - [KnownOCSPHandle](#knownocsphandle-property-tlsclient-component) The array indices start at *0* and end at *KnownOCSPCount - 1*. This property is not available at design time. ## Data Type Integer # KnownOCSPBytes Property ([TLSClient](#tlsclient-component) Component) A buffer containing the raw OCSP response data. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray KnownOCSPBytes[int KnownOCSPIndex] = { read=FKnownOCSPBytes }; ``` ## Remarks A buffer containing the raw OCSP response data. The *KnownOCSPIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownOCSPCount](#knownocspcount-property-tlsclient-component) property. This property is read-only and not available at design time. ## Data Type Byte Array # KnownOCSPHandle Property ([TLSClient](#tlsclient-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *C++ Builder Syntax* ```text __property __int64 KnownOCSPHandle[int KnownOCSPIndex] = { read=FKnownOCSPHandle, write=FSetKnownOCSPHandle }; ``` ## 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 *KnownOCSPIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownOCSPCount](#knownocspcount-property-tlsclient-component) property. This property is not available at design time. ## Data Type Long64 # OutputBytes Property ([TLSClient](#tlsclient-component) Component) A memory buffer where the incoming data is collected. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray OutputBytes = { read=FOutputBytes }; ``` ## Remarks Use this property to access the cached incoming data after a [ReceiveData](#receivedata-method-tlsclient-component) or [ReceiveAllData](#receivealldata-method-tlsclient-component) call. This property is read-only and not available at design time. ## Data Type Byte Array # OutputString Property ([TLSClient](#tlsclient-component) Component) A string where the incoming data is collected. ## Syntax *C++ Builder Syntax* ```text __property String OutputString = { read=FOutputString }; ``` ## Default Value "" ## Remarks Use this property to access the stored incoming data in the string interpretation. This property is read-only and not available at design time. ## Data Type String # ProxyAddress Property ([TLSClient](#tlsclient-component) Component) The IP address of the proxy server. ## Syntax *C++ Builder Syntax* ```text __property String ProxyAddress = { read=FProxyAddress, write=FSetProxyAddress }; ``` ## Default Value "" ## Remarks The IP address of the proxy server. ## Data Type String # ProxyAuthentication Property ([TLSClient](#tlsclient-component) Component) The authentication type used by the proxy server. ## Syntax *C++ Builder Syntax* ```text __property TsbxTLSClientProxyAuthentications ProxyAuthentication = { read=FProxyAuthentication, write=FSetProxyAuthentication }; enum TsbxTLSClientProxyAuthentications { patNoAuthentication=0, patBasic=1, patDigest=2, patNTLM=3 }; ``` ## Default Value patNoAuthentication ## Remarks The authentication type used by the proxy server. | | | | --- | --- | | patNoAuthentication | 0 | | patBasic | 1 | | patDigest | 2 | | patNTLM | 3 | ## Data Type Integer # ProxyPassword Property ([TLSClient](#tlsclient-component) Component) The password to authenticate to the proxy server. ## Syntax *C++ Builder Syntax* ```text __property String ProxyPassword = { read=FProxyPassword, write=FSetProxyPassword }; ``` ## Default Value "" ## Remarks The password to authenticate to the proxy server. ## Data Type String # ProxyPort Property ([TLSClient](#tlsclient-component) Component) The port on the proxy server to connect to. ## Syntax *C++ Builder Syntax* ```text __property int ProxyPort = { read=FProxyPort, write=FSetProxyPort }; ``` ## Default Value 0 ## Remarks The port on the proxy server to connect to. ## Data Type Integer # ProxyType Property ([TLSClient](#tlsclient-component) Component) The type of the proxy server. ## Syntax *C++ Builder Syntax* ```text __property TsbxTLSClientProxyTypes ProxyType = { read=FProxyType, write=FSetProxyType }; enum TsbxTLSClientProxyTypes { cptNone=0, cptSocks4=1, cptSocks5=2, cptWebTunnel=3, cptHTTP=4 }; ``` ## Default Value cptNone ## Remarks The type of the proxy server. | | | | --- | --- | | cptNone | 0 | | cptSocks4 | 1 | | cptSocks5 | 2 | | cptWebTunnel | 3 | | cptHTTP | 4 | ## Data Type Integer # ProxyRequestHeaders Property ([TLSClient](#tlsclient-component) Component) Contains HTTP request headers for WebTunnel and HTTP proxy. ## Syntax *C++ Builder Syntax* ```text __property String ProxyRequestHeaders = { read=FProxyRequestHeaders, write=FSetProxyRequestHeaders }; ``` ## Default Value "" ## Remarks Contains HTTP request headers for WebTunnel and HTTP proxy. ## Data Type String # ProxyResponseBody Property ([TLSClient](#tlsclient-component) Component) Contains the HTTP or HTTPS (WebTunnel) proxy response body. ## Syntax *C++ Builder Syntax* ```text __property String ProxyResponseBody = { read=FProxyResponseBody, write=FSetProxyResponseBody }; ``` ## Default Value "" ## Remarks Contains the HTTP or HTTPS (WebTunnel) proxy response body. ## Data Type String # ProxyResponseHeaders Property ([TLSClient](#tlsclient-component) Component) Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. ## Syntax *C++ Builder Syntax* ```text __property String ProxyResponseHeaders = { read=FProxyResponseHeaders, write=FSetProxyResponseHeaders }; ``` ## Default Value "" ## Remarks Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. ## Data Type String # ProxyUseIPv6 Property ([TLSClient](#tlsclient-component) Component) Specifies whether IPv6 should be used when connecting through the proxy. ## Syntax *C++ Builder Syntax* ```text __property bool ProxyUseIPv6 = { read=FProxyUseIPv6, write=FSetProxyUseIPv6 }; ``` ## Default Value false ## Remarks Specifies whether IPv6 should be used when connecting through the proxy. ## Data Type Boolean # ProxyUsername Property ([TLSClient](#tlsclient-component) Component) Specifies the username credential for proxy authentication. ## Syntax *C++ Builder Syntax* ```text __property String ProxyUsername = { read=FProxyUsername, write=FSetProxyUsername }; ``` ## Default Value "" ## Remarks Specifies the username credential for proxy authentication. ## Data Type String # SocketDNSMode Property ([TLSClient](#tlsclient-component) Component) Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system. ## Syntax *C++ Builder Syntax* ```text __property TsbxTLSClientSocketDNSModes SocketDNSMode = { read=FSocketDNSMode, write=FSetSocketDNSMode }; enum TsbxTLSClientSocketDNSModes { dmAuto=0, dmPlatform=1, dmOwn=2, dmOwnSecure=3 }; ``` ## Default Value dmAuto ## Remarks Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system. | | | | --- | --- | | dmAuto | 0 | | dmPlatform | 1 | | dmOwn | 2 | | dmOwnSecure | 3 | ## Data Type Integer # SocketDNSPort Property ([TLSClient](#tlsclient-component) Component) Specifies the port number to be used for sending queries to the DNS server. ## Syntax *C++ Builder Syntax* ```text __property int SocketDNSPort = { read=FSocketDNSPort, write=FSetSocketDNSPort }; ``` ## Default Value 0 ## Remarks Specifies the port number to be used for sending queries to the DNS server. ## Data Type Integer # SocketDNSQueryTimeout Property ([TLSClient](#tlsclient-component) Component) The timeout (in milliseconds) for each DNS query. ## Syntax *C++ Builder Syntax* ```text __property int SocketDNSQueryTimeout = { read=FSocketDNSQueryTimeout, write=FSetSocketDNSQueryTimeout }; ``` ## Default Value 0 ## Remarks The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout. ## Data Type Integer # SocketDNSServers Property ([TLSClient](#tlsclient-component) Component) The addresses of DNS servers to use for address resolution, separated by commas or semicolons. ## Syntax *C++ Builder Syntax* ```text __property String SocketDNSServers = { read=FSocketDNSServers, write=FSetSocketDNSServers }; ``` ## Default Value "" ## Remarks The addresses of DNS servers to use for address resolution, separated by commas or semicolons. ## Data Type String # SocketDNSTotalTimeout Property ([TLSClient](#tlsclient-component) Component) The timeout (in milliseconds) for the whole resolution process. ## Syntax *C++ Builder Syntax* ```text __property int SocketDNSTotalTimeout = { read=FSocketDNSTotalTimeout, write=FSetSocketDNSTotalTimeout }; ``` ## Default Value 0 ## Remarks The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout. ## Data Type Integer # SocketIncomingSpeedLimit Property ([TLSClient](#tlsclient-component) Component) The maximum number of bytes to read from the socket, per second. ## Syntax *C++ Builder Syntax* ```text __property int SocketIncomingSpeedLimit = { read=FSocketIncomingSpeedLimit, write=FSetSocketIncomingSpeedLimit }; ``` ## Default Value 0 ## Remarks The maximum number of bytes to read from the socket, per second. ## Data Type Integer # SocketLocalAddress Property ([TLSClient](#tlsclient-component) Component) The local network interface to bind the socket to. ## Syntax *C++ Builder Syntax* ```text __property String SocketLocalAddress = { read=FSocketLocalAddress, write=FSetSocketLocalAddress }; ``` ## Default Value "" ## Remarks The local network interface to bind the socket to. ## Data Type String # SocketLocalPort Property ([TLSClient](#tlsclient-component) Component) The local port number to bind the socket to. ## Syntax *C++ Builder Syntax* ```text __property int SocketLocalPort = { read=FSocketLocalPort, write=FSetSocketLocalPort }; ``` ## Default Value 0 ## Remarks The local port number to bind the socket to. ## Data Type Integer # SocketOutgoingSpeedLimit Property ([TLSClient](#tlsclient-component) Component) The maximum number of bytes to write to the socket, per second. ## Syntax *C++ Builder Syntax* ```text __property int SocketOutgoingSpeedLimit = { read=FSocketOutgoingSpeedLimit, write=FSetSocketOutgoingSpeedLimit }; ``` ## Default Value 0 ## Remarks The maximum number of bytes to write to the socket, per second. ## Data Type Integer # SocketTimeout Property ([TLSClient](#tlsclient-component) Component) The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. ## Syntax *C++ Builder Syntax* ```text __property int SocketTimeout = { read=FSocketTimeout, write=FSetSocketTimeout }; ``` ## 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 ([TLSClient](#tlsclient-component) Component) Enables or disables IP protocol version 6. ## Syntax *C++ Builder Syntax* ```text __property bool SocketUseIPv6 = { read=FSocketUseIPv6, write=FSetSocketUseIPv6 }; ``` ## Default Value false ## Remarks Enables or disables IP protocol version 6. ## Data Type Boolean # TLSClientCertCount Property ([TLSClient](#tlsclient-component) Component) The number of records in the TLSClientCert arrays. ## Syntax *C++ Builder Syntax* ```text __property int TLSClientCertCount = { read=FTLSClientCertCount, write=FSetTLSClientCertCount }; ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [TLSClientCertBytes](#tlsclientcertbytes-property-tlsclient-component) - [TLSClientCertHandle](#tlsclientcerthandle-property-tlsclient-component) The array indices start at *0* and end at *TLSClientCertCount - 1*. This property is not available at design time. ## Data Type Integer # TLSClientCertBytes Property ([TLSClient](#tlsclient-component) Component) Returns the raw certificate data in DER format. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray TLSClientCertBytes[int TLSClientCertIndex] = { read=FTLSClientCertBytes }; ``` ## Remarks Returns the raw certificate data in DER format. The *TLSClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSClientCertCount](#tlsclientcertcount-property-tlsclient-component) property. This property is read-only and not available at design time. ## Data Type Byte Array # TLSClientCertHandle Property ([TLSClient](#tlsclient-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *C++ Builder Syntax* ```text __property __int64 TLSClientCertHandle[int TLSClientCertIndex] = { read=FTLSClientCertHandle, write=FSetTLSClientCertHandle }; ``` ## 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 *TLSClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSClientCertCount](#tlsclientcertcount-property-tlsclient-component) property. This property is not available at design time. ## Data Type Long64 # TLSServerCertCount Property ([TLSClient](#tlsclient-component) Component) The number of records in the TLSServerCert arrays. ## Syntax *C++ Builder Syntax* ```text __property int TLSServerCertCount = { read=FTLSServerCertCount }; ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [TLSServerCertBytes](#tlsservercertbytes-property-tlsclient-component) - [TLSServerCertFingerprint](#tlsservercertfingerprint-property-tlsclient-component) - [TLSServerCertHandle](#tlsservercerthandle-property-tlsclient-component) - [TLSServerCertIssuer](#tlsservercertissuer-property-tlsclient-component) - [TLSServerCertIssuerRDN](#tlsservercertissuerrdn-property-tlsclient-component) - [TLSServerCertKeyAlgorithm](#tlsservercertkeyalgorithm-property-tlsclient-component) - [TLSServerCertKeyBits](#tlsservercertkeybits-property-tlsclient-component) - [TLSServerCertKeyUsage](#tlsservercertkeyusage-property-tlsclient-component) - [TLSServerCertSelfSigned](#tlsservercertselfsigned-property-tlsclient-component) - [TLSServerCertSerialNumber](#tlsservercertserialnumber-property-tlsclient-component) - [TLSServerCertSigAlgorithm](#tlsservercertsigalgorithm-property-tlsclient-component) - [TLSServerCertSubject](#tlsservercertsubject-property-tlsclient-component) - [TLSServerCertSubjectRDN](#tlsservercertsubjectrdn-property-tlsclient-component) - [TLSServerCertValidFrom](#tlsservercertvalidfrom-property-tlsclient-component) - [TLSServerCertValidTo](#tlsservercertvalidto-property-tlsclient-component) The array indices start at *0* and end at *TLSServerCertCount - 1*. This property is read-only and not available at design time. ## Data Type Integer # TLSServerCertBytes Property ([TLSClient](#tlsclient-component) Component) Returns the raw certificate data in DER format. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray TLSServerCertBytes[int TLSServerCertIndex] = { read=FTLSServerCertBytes }; ``` ## 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-tlsclient-component) property. This property is read-only and not available at design time. ## Data Type Byte Array # TLSServerCertFingerprint Property ([TLSClient](#tlsclient-component) Component) Contains the fingerprint (a hash imprint) of this certificate. ## Syntax *C++ Builder Syntax* ```text __property String TLSServerCertFingerprint[int TLSServerCertIndex] = { read=FTLSServerCertFingerprint }; ``` ## 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 *TLSServerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-tlsclient-component) property. This property is read-only and not available at design time. ## Data Type String # TLSServerCertHandle Property ([TLSClient](#tlsclient-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *C++ Builder Syntax* ```text __property __int64 TLSServerCertHandle[int TLSServerCertIndex] = { read=FTLSServerCertHandle }; ``` ## 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-tlsclient-component) property. This property is read-only and not available at design time. ## Data Type Long64 # TLSServerCertIssuer Property ([TLSClient](#tlsclient-component) Component) The common name of the certificate issuer (CA), typically a company name. ## Syntax *C++ Builder Syntax* ```text __property String TLSServerCertIssuer[int TLSServerCertIndex] = { read=FTLSServerCertIssuer }; ``` ## 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 [TLSIssuerRDN](#TLSClient_p_TLSIssuerRDN). The *TLSServerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-tlsclient-component) property. This property is read-only and not available at design time. ## Data Type String # TLSServerCertIssuerRDN Property ([TLSClient](#tlsclient-component) Component) A list of Property=Value pairs that uniquely identify the certificate issuer. ## Syntax *C++ Builder Syntax* ```text __property String TLSServerCertIssuerRDN[int TLSServerCertIndex] = { read=FTLSServerCertIssuerRDN }; ``` ## 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 *TLSServerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-tlsclient-component) property. This property is read-only and not available at design time. ## Data Type String # TLSServerCertKeyAlgorithm Property ([TLSClient](#tlsclient-component) Component) Specifies the public key algorithm of this certificate. ## Syntax *C++ Builder Syntax* ```text __property String TLSServerCertKeyAlgorithm[int TLSServerCertIndex] = { read=FTLSServerCertKeyAlgorithm }; ``` ## 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 [TLSKeyBits](#TLSClient_p_TLSKeyBits), [TLSCurve](#TLSClient_p_TLSCurve), and [TLSPublicKeyBytes](#TLSClient_p_TLSPublicKeyBytes) properties to get more details about the key the certificate contains. The *TLSServerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-tlsclient-component) property. This property is read-only and not available at design time. ## Data Type String # TLSServerCertKeyBits Property ([TLSClient](#tlsclient-component) Component) Returns the length of the public key in bits. ## Syntax *C++ Builder Syntax* ```text __property int TLSServerCertKeyBits[int TLSServerCertIndex] = { read=FTLSServerCertKeyBits }; ``` ## 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 [TLSPublicKeyBytes](#TLSClient_p_TLSPublicKeyBytes) or [TLSPrivateKeyBytes](#TLSClient_p_TLSPrivateKeyBytes) property would typically contain auxiliary values, and therefore be longer. The *TLSServerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-tlsclient-component) property. This property is read-only and not available at design time. ## Data Type Integer # TLSServerCertKeyUsage Property ([TLSClient](#tlsclient-component) Component) Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. ## Syntax *C++ Builder Syntax* ```text __property int TLSServerCertKeyUsage[int TLSServerCertIndex] = { read=FTLSServerCertKeyUsage }; ``` ## 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 *TLSServerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-tlsclient-component) property. This property is read-only and not available at design time. ## Data Type Integer # TLSServerCertSelfSigned Property ([TLSClient](#tlsclient-component) Component) Indicates whether the certificate is self-signed (root) or signed by an external CA. ## Syntax *C++ Builder Syntax* ```text __property bool TLSServerCertSelfSigned[int TLSServerCertIndex] = { read=FTLSServerCertSelfSigned }; ``` ## Default Value false ## Remarks Indicates whether the certificate is self-signed (root) or signed by an external CA. The *TLSServerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-tlsclient-component) property. This property is read-only and not available at design time. ## Data Type Boolean # TLSServerCertSerialNumber Property ([TLSClient](#tlsclient-component) Component) Returns the certificate's serial number. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray TLSServerCertSerialNumber[int TLSServerCertIndex] = { read=FTLSServerCertSerialNumber }; ``` ## 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 *TLSServerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-tlsclient-component) property. This property is read-only and not available at design time. ## Data Type Byte Array # TLSServerCertSigAlgorithm Property ([TLSClient](#tlsclient-component) Component) Indicates the algorithm that was used by the CA to sign this certificate. ## Syntax *C++ Builder Syntax* ```text __property String TLSServerCertSigAlgorithm[int TLSServerCertIndex] = { read=FTLSServerCertSigAlgorithm }; ``` ## 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 *TLSServerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-tlsclient-component) property. This property is read-only and not available at design time. ## Data Type String # TLSServerCertSubject Property ([TLSClient](#tlsclient-component) Component) The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. ## Syntax *C++ Builder Syntax* ```text __property String TLSServerCertSubject[int TLSServerCertIndex] = { read=FTLSServerCertSubject }; ``` ## 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 [TLSSubjectRDN](#TLSClient_p_TLSSubjectRDN). The *TLSServerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-tlsclient-component) property. This property is read-only and not available at design time. ## Data Type String # TLSServerCertSubjectRDN Property ([TLSClient](#tlsclient-component) Component) A list of Property=Value pairs that uniquely identify the certificate holder (subject). ## Syntax *C++ Builder Syntax* ```text __property String TLSServerCertSubjectRDN[int TLSServerCertIndex] = { read=FTLSServerCertSubjectRDN }; ``` ## 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 *TLSServerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-tlsclient-component) property. This property is read-only and not available at design time. ## Data Type String # TLSServerCertValidFrom Property ([TLSClient](#tlsclient-component) Component) The time point at which the certificate becomes valid, in UTC. ## Syntax *C++ Builder Syntax* ```text __property String TLSServerCertValidFrom[int TLSServerCertIndex] = { read=FTLSServerCertValidFrom }; ``` ## Default Value "" ## Remarks The time point at which the certificate becomes valid, in UTC. The *TLSServerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-tlsclient-component) property. This property is read-only and not available at design time. ## Data Type String # TLSServerCertValidTo Property ([TLSClient](#tlsclient-component) Component) The time point at which the certificate expires, in UTC. ## Syntax *C++ Builder Syntax* ```text __property String TLSServerCertValidTo[int TLSServerCertIndex] = { read=FTLSServerCertValidTo }; ``` ## Default Value "" ## Remarks The time point at which the certificate expires, in UTC. The *TLSServerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-tlsclient-component) property. This property is read-only and not available at design time. ## Data Type String # TLSAutoValidateCertificates Property ([TLSClient](#tlsclient-component) Component) Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. ## Syntax *C++ Builder Syntax* ```text __property bool TLSAutoValidateCertificates = { read=FTLSAutoValidateCertificates, write=FSetTLSAutoValidateCertificates }; ``` ## Default Value true ## Remarks Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. ## Data Type Boolean # TLSBaseConfiguration Property ([TLSClient](#tlsclient-component) Component) Selects the base configuration for the TLS settings. ## Syntax *C++ Builder Syntax* ```text __property TsbxTLSClientTLSBaseConfigurations TLSBaseConfiguration = { read=FTLSBaseConfiguration, write=FSetTLSBaseConfiguration }; enum TsbxTLSClientTLSBaseConfigurations { stpcDefault=0, stpcCompatible=1, stpcComprehensiveInsecure=2, stpcHighlySecure=3 }; ``` ## Default Value stpcDefault ## 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 ([TLSClient](#tlsclient-component) Component) A list of ciphersuites separated with commas or semicolons. ## Syntax *C++ Builder Syntax* ```text __property String TLSCiphersuites = { read=FTLSCiphersuites, write=FSetTLSCiphersuites }; ``` ## 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-tlsclient-component). 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 ([TLSClient](#tlsclient-component) Component) Enables or disables certificate-based client authentication. ## Syntax *C++ Builder Syntax* ```text __property TsbxTLSClientTLSClientAuths TLSClientAuth = { read=FTLSClientAuth, write=FSetTLSClientAuth }; enum TsbxTLSClientTLSClientAuths { ccatNoAuth=0, ccatRequestCert=1, ccatRequireCert=2 }; ``` ## Default Value ccatNoAuth ## 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 ([TLSClient](#tlsclient-component) Component) Provides access to TLS extensions. ## Syntax *C++ Builder Syntax* ```text __property String TLSExtensions = { read=FTLSExtensions, write=FSetTLSExtensions }; ``` ## Default Value "" ## Remarks Provides access to TLS extensions. ## Data Type String # TLSForceResumeIfDestinationChanges Property ([TLSClient](#tlsclient-component) Component) Whether to force TLS session resumption when the destination address changes. ## Syntax *C++ Builder Syntax* ```text __property bool TLSForceResumeIfDestinationChanges = { read=FTLSForceResumeIfDestinationChanges, write=FSetTLSForceResumeIfDestinationChanges }; ``` ## Default Value false ## Remarks Whether to force TLS session resumption when the destination address changes. ## Data Type Boolean # TLSGroups Property ([TLSClient](#tlsclient-component) Component) Specifies a list of key exchange groups to attempt during the TLS key exchange. ## Syntax *C++ Builder Syntax* ```text __property String TLSGroups = { read=FTLSGroups, write=FSetTLSGroups }; ``` ## 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 ([TLSClient](#tlsclient-component) Component) Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. ## Syntax *C++ Builder Syntax* ```text __property String TLSPreSharedIdentity = { read=FTLSPreSharedIdentity, write=FSetTLSPreSharedIdentity }; ``` ## 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 ([TLSClient](#tlsclient-component) Component) Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. ## Syntax *C++ Builder Syntax* ```text __property String TLSPreSharedKey = { read=FTLSPreSharedKey, write=FSetTLSPreSharedKey }; ``` ## 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 ([TLSClient](#tlsclient-component) Component) Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. ## Syntax *C++ Builder Syntax* ```text __property String TLSPreSharedKeyCiphersuite = { read=FTLSPreSharedKeyCiphersuite, write=FSetTLSPreSharedKeyCiphersuite }; ``` ## Default Value "" ## Remarks Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. ## Data Type String # TLSRenegotiationAttackPreventionMode Property ([TLSClient](#tlsclient-component) Component) Selects the renegotiation attack prevention mechanism. ## Syntax *C++ Builder Syntax* ```text __property TsbxTLSClientTLSRenegotiationAttackPreventionModes TLSRenegotiationAttackPreventionMode = { read=FTLSRenegotiationAttackPreventionMode, write=FSetTLSRenegotiationAttackPreventionMode }; enum TsbxTLSClientTLSRenegotiationAttackPreventionModes { crapmCompatible=0, crapmStrict=1, crapmAuto=2 }; ``` ## Default Value crapmAuto ## 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 ([TLSClient](#tlsclient-component) Component) Specifies the kind(s) of revocation check to perform. ## Syntax *C++ Builder Syntax* ```text __property TsbxTLSClientTLSRevocationChecks TLSRevocationCheck = { read=FTLSRevocationCheck, write=FSetTLSRevocationCheck }; enum TsbxTLSClientTLSRevocationChecks { crcNone=0, crcAuto=1, crcAllCRL=2, crcAllOCSP=3, crcAllCRLAndOCSP=4, crcAnyCRL=5, crcAnyOCSP=6, crcAnyCRLOrOCSP=7, crcAnyOCSPOrCRL=8 }; ``` ## Default Value crcAuto ## 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 ([TLSClient](#tlsclient-component) Component) 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. ## Syntax *C++ Builder Syntax* ```text __property int TLSSSLOptions = { read=FTLSSSLOptions, write=FSetTLSSSLOptions }; ``` ## 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 ([TLSClient](#tlsclient-component) Component) Specifies the TLS mode to use. ## Syntax *C++ Builder Syntax* ```text __property TsbxTLSClientTLSModes TLSMode = { read=FTLSMode, write=FSetTLSMode }; enum TsbxTLSClientTLSModes { smDefault=0, smNoTLS=1, smExplicitTLS=2, smImplicitTLS=3, smMixedTLS=4 }; ``` ## Default Value smDefault ## 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 ([TLSClient](#tlsclient-component) Component) Enables the Extended Master Secret Extension, as defined in RFC 7627. ## Syntax *C++ Builder Syntax* ```text __property bool TLSUseExtendedMasterSecret = { read=FTLSUseExtendedMasterSecret, write=FSetTLSUseExtendedMasterSecret }; ``` ## Default Value true ## Remarks Enables the Extended Master Secret Extension, as defined in RFC 7627. ## Data Type Boolean # TLSUseSessionResumption Property ([TLSClient](#tlsclient-component) Component) Enables or disables the TLS session resumption capability. ## Syntax *C++ Builder Syntax* ```text __property bool TLSUseSessionResumption = { read=FTLSUseSessionResumption, write=FSetTLSUseSessionResumption }; ``` ## Default Value false ## Remarks Enables or disables the TLS session resumption capability. ## Data Type Boolean # TLSVersions Property ([TLSClient](#tlsclient-component) Component) The SSL/TLS versions to enable by default. ## Syntax *C++ Builder Syntax* ```text __property int TLSVersions = { read=FTLSVersions, write=FSetTLSVersions }; ``` ## 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 # TrustedCertCount Property ([TLSClient](#tlsclient-component) Component) The number of records in the TrustedCert arrays. ## Syntax *C++ Builder Syntax* ```text __property int TrustedCertCount = { read=FTrustedCertCount, write=FSetTrustedCertCount }; ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [TrustedCertBytes](#trustedcertbytes-property-tlsclient-component) - [TrustedCertHandle](#trustedcerthandle-property-tlsclient-component) The array indices start at *0* and end at *TrustedCertCount - 1*. This property is not available at design time. ## Data Type Integer # TrustedCertBytes Property ([TLSClient](#tlsclient-component) Component) Returns the raw certificate data in DER format. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray TrustedCertBytes[int TrustedCertIndex] = { read=FTrustedCertBytes }; ``` ## Remarks Returns the raw certificate data in DER format. The *TrustedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trustedcertcount-property-tlsclient-component) property. This property is read-only and not available at design time. ## Data Type Byte Array # TrustedCertHandle Property ([TLSClient](#tlsclient-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *C++ Builder Syntax* ```text __property __int64 TrustedCertHandle[int TrustedCertIndex] = { read=FTrustedCertHandle, write=FSetTrustedCertHandle }; ``` ## 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 *TrustedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trustedcertcount-property-tlsclient-component) property. This property is not available at design time. ## Data Type Long64 # Config Method ([TLSClient](#tlsclient-component) Component) Sets or retrieves a configuration setting. ## Syntax *C++ Builder Syntax* ```text String __fastcall Config(String ConfigurationString); ``` ## Remarks Config is a generic method available in every component. It is used to set and retrieve [configuration settings](#config-settings-tlsclient-component) for the component. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these *internal properties* is provided through the Config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#config-settings-tlsclient-component), you must call *Config("PROPERTY")*. The value will be returned as a string. # Connect Method ([TLSClient](#tlsclient-component) Component) Establishes connection to a remote server. ## Syntax *C++ Builder Syntax* ```text void __fastcall Connect(String Address, int Port); ``` ## Remarks Call this method to establish connection to a TLS server at *Address*:*Port*. # Disconnect Method ([TLSClient](#tlsclient-component) Component) Disconnects from the server. ## Syntax *C++ Builder Syntax* ```text void __fastcall Disconnect(); ``` ## Remarks Call this method to close an active connection to the server. # DoAction Method ([TLSClient](#tlsclient-component) Component) Performs an additional action. ## Syntax *C++ Builder Syntax* ```text String __fastcall DoAction(String ActionID, String ActionParams); ``` ## Remarks DoAction is a generic method available in every component. 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. | # ExportKeyMaterial Method ([TLSClient](#tlsclient-component) Component) Derives key material from the session's master key using the TLS exporters scheme. ## Syntax *C++ Builder Syntax* ```text void __fastcall ExportKeyMaterial(String Lbl, DynamicArray Context, int Len); ``` ## Remarks Some protocols - for example, SRTP - use TLS exporters to derive their own session keys from the TLS master key. This method lets you employ the exporters scheme to obtain such keys, or to generate secure keys for your own needs from the current 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*. # ReceiveAllData Method ([TLSClient](#tlsclient-component) Component) Reads data from the connection. ## Syntax *C++ Builder Syntax* ```text void __fastcall ReceiveAllData(int Size); ``` ## Remarks Use this method to read *Size* bytes from the connection. The method will block until the requested number of bytes is received. Use [OutputBytes](#outputbytes-property-tlsclient-component) (or [OutputString](#outputstring-property-tlsclient-component)) to access the received data. Use [ReceiveData](#receivedata-method-tlsclient-component) method to read all the data there is and return without waiting for the whole piece. # ReceiveData Method ([TLSClient](#tlsclient-component) Component) Reads data from the connection. ## Syntax *C++ Builder Syntax* ```text void __fastcall ReceiveData(int Size); ``` ## Remarks Use this method to read *Size* or less bytes from the connection. The method will read as much data is possible (but no more than *Size*) and return without blocking. Use [OutputBytes](#outputbytes-property-tlsclient-component) (or [OutputString](#outputstring-property-tlsclient-component)) to access the received data. # Reset Method ([TLSClient](#tlsclient-component) Component) Resets the component settings. ## Syntax *C++ Builder Syntax* ```text void __fastcall Reset(); ``` ## Remarks Reset is a generic method available in every component. # SendData Method ([TLSClient](#tlsclient-component) Component) Sends a buffer to the server. ## Syntax *C++ Builder Syntax* ```text void __fastcall SendData(DynamicArray Buffer); ``` ## Remarks Use this method to send a byte array to the server. # SendKeepAlive Method ([TLSClient](#tlsclient-component) Component) Sends a keep-alive packet. ## Syntax *C++ Builder Syntax* ```text void __fastcall SendKeepAlive(); ``` ## Remarks Use this method to send a keep-alive packet to the server. Keep alive is an empty packet; keep-alive signals sent occasionally can be used to keep connection up. # SendText Method ([TLSClient](#tlsclient-component) Component) Sends a text string to the server. ## Syntax *C++ Builder Syntax* ```text void __fastcall SendText(String Text); ``` ## Remarks Use this method to send a text string to the server. # StartTLS Method ([TLSClient](#tlsclient-component) Component) Starts TLS negotiation on an established TCP connection. ## Syntax *C++ Builder Syntax* ```text void __fastcall StartTLS(); ``` ## Remarks Use this method to initiate a TLS handshake on a plain TCP connection. This method is handy for establishing explicit TLS connections manually. # StopTLS Method ([TLSClient](#tlsclient-component) Component) Downgrades the protected connection to plain TCP. ## Syntax *C++ Builder Syntax* ```text void __fastcall StopTLS(bool Quiet); ``` ## Remarks Use this method to make the component stop encrypting session data with TLS and downgrade the connection to plain unencrypted TCP. Use the *Quiet* parameter to suppress sending of the close_notify alert upon closing the TLS session. # Error Event ([TLSClient](#tlsclient-component) Component) Information about errors during data delivery. ## Syntax *C++ Builder Syntax* ```text typedef struct { int ErrorCode; bool Fatal; bool Remote; String Description; } TsbxTLSClientErrorEventParams; typedef void __fastcall (__closure *TsbxTLSClientErrorEvent)(System::TObject* Sender, TsbxTLSClientErrorEventParams *e); __property TsbxTLSClientErrorEvent OnError = { read=FOnError, write=FOnError }; ``` ## 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-tlsclient-component) section. # ExternalSign Event ([TLSClient](#tlsclient-component) Component) Handles remote or external signing initiated by the SignExternal method or other source. ## Syntax *C++ Builder Syntax* ```text typedef struct { String OperationId; String HashAlgorithm; String Pars; String Data; String SignedData; } TsbxTLSClientExternalSignEventParams; typedef void __fastcall (__closure *TsbxTLSClientExternalSignEvent)(System::TObject* Sender, TsbxTLSClientExternalSignEventParams *e); __property TsbxTLSClientExternalSignEvent OnExternalSign = { read=FOnExternalSign, write=FOnExternalSign }; ``` ## 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 component via the *SignedData* parameter. *OperationId* provides a comment about the operation and its origin. It depends on the exact component being used, and may be empty. *HashAlgorithm* specifies the hash algorithm being used for the operation, and *Pars* contains algorithm-dependent parameters. The component 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 ([TLSClient](#tlsclient-component) Component) This event notifies the application about an underlying control flow event. ## Syntax *C++ Builder Syntax* ```text typedef struct { String EventID; String EventParam; } TsbxTLSClientNotificationEventParams; typedef void __fastcall (__closure *TsbxTLSClientNotificationEvent)(System::TObject* Sender, TsbxTLSClientNotificationEventParams *e); __property TsbxTLSClientNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification }; ``` ## Remarks The component fires this event to let the application know about some event, occurrence, or milestone in the component. 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 component, the exact action it is performing, or the document being processed, one or both may be omitted. This component can fire this event with the following *EventID* values: | | | | --- | --- | | TLSExtensions.CertificateStatus | TBD | | TLSExtensions.PreSharedIdentityHint | TBD | # TLSCertNeeded Event ([TLSClient](#tlsclient-component) Component) Fires when a remote TLS party requests a client certificate. ## Syntax *C++ Builder Syntax* ```text typedef struct { String Host; String CANames; } TsbxTLSClientTLSCertNeededEventParams; typedef void __fastcall (__closure *TsbxTLSClientTLSCertNeededEvent)(System::TObject* Sender, TsbxTLSClientTLSCertNeededEventParams *e); __property TsbxTLSClientTLSCertNeededEvent OnTLSCertNeeded = { read=FOnTLSCertNeeded, write=FOnTLSCertNeeded }; ``` ## Remarks This event fires to notify the implementation that a remote TLS server has requested a client certificate. The *Host* parameter identifies the host that makes a request, and the *CANames* parameter (optional, according to the TLS spec) advises on the accepted issuing CAs. Use the TLSClientChain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire. This event is preceded by the [TLSHandshake](#tlshandshake-event-tlsclient-component) event for the given host and, if the certificate was accepted, succeeded by the [TLSEstablished](#tlsestablished-event-tlsclient-component) event. # TLSCertValidate Event ([TLSClient](#tlsclient-component) Component) This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. ## Syntax *C++ Builder Syntax* ```text typedef struct { String ServerHost; String ServerIP; bool Accept; } TsbxTLSClientTLSCertValidateEventParams; typedef void __fastcall (__closure *TsbxTLSClientTLSCertValidateEvent)(System::TObject* Sender, TsbxTLSClientTLSCertValidateEventParams *e); __property TsbxTLSClientTLSCertValidateEvent OnTLSCertValidate = { read=FOnTLSCertValidate, write=FOnTLSCertValidate }; ``` ## Remarks This event is fired during a TLS handshake. Use the TLSServerChain property to access the certificate chain. In general, components may contact a number of TLS endpoints during their work, depending on their configuration. *Accept* is assigned in accordance with the outcome of the internal validation check performed by the component, and can be adjusted if needed. # TLSEstablished Event ([TLSClient](#tlsclient-component) Component) Fires when a TLS handshake with Host successfully completes. ## Syntax *C++ Builder Syntax* ```text typedef struct { String Host; String Version; String Ciphersuite; DynamicArray ConnectionId; bool Abort; } TsbxTLSClientTLSEstablishedEventParams; typedef void __fastcall (__closure *TsbxTLSClientTLSEstablishedEvent)(System::TObject* Sender, TsbxTLSClientTLSEstablishedEventParams *e); __property TsbxTLSClientTLSEstablishedEvent OnTLSEstablished = { read=FOnTLSEstablished, write=FOnTLSEstablished }; ``` ## Remarks The component uses this event to notify the application about a successful completion of a TLS handshake. The *Version*, *Ciphersuite*, and *ConnectionId* parameters indicate the security parameters of the new connection. Use the *Abort* parameter if you need to terminate the connection at this stage. # TLSHandshake Event ([TLSClient](#tlsclient-component) Component) Fires when a new TLS handshake is initiated, before the handshake commences. ## Syntax *C++ Builder Syntax* ```text typedef struct { String Host; bool Abort; } TsbxTLSClientTLSHandshakeEventParams; typedef void __fastcall (__closure *TsbxTLSClientTLSHandshakeEvent)(System::TObject* Sender, TsbxTLSClientTLSHandshakeEventParams *e); __property TsbxTLSClientTLSHandshakeEvent OnTLSHandshake = { read=FOnTLSHandshake, write=FOnTLSHandshake }; ``` ## Remarks The component uses this event to notify the application about the start of a new TLS handshake to *Host*. If the handshake is successful, this event will be followed by the [TLSEstablished](#tlsestablished-event-tlsclient-component) event. If the server chooses to request a client certificate, the [TLSCertNeeded](#tlscertneeded-event-tlsclient-component) event will also be fired. # TLSPSK Event ([TLSClient](#tlsclient-component) Component) Notifies the application about the PSK key exchange. ## Syntax *C++ Builder Syntax* ```text typedef struct { String Host; String Hint; } TsbxTLSClientTLSPSKEventParams; typedef void __fastcall (__closure *TsbxTLSClientTLSPSKEvent)(System::TObject* Sender, TsbxTLSClientTLSPSKEventParams *e); __property TsbxTLSClientTLSPSKEvent OnTLSPSK = { read=FOnTLSPSK, write=FOnTLSPSK }; ``` ## Remarks The component fires this event to notify the application about the beginning of TLS-PSK key exchange with *Host*. The *Hint* parameter may be used by the server to identify the key or service to use. Use the PreSharedKey field of TLSSettings to provide the pre-shared key to the component. # TLSShutdown Event ([TLSClient](#tlsclient-component) Component) Reports the graceful closure of a TLS connection. ## Syntax *C++ Builder Syntax* ```text typedef struct { String Host; } TsbxTLSClientTLSShutdownEventParams; typedef void __fastcall (__closure *TsbxTLSClientTLSShutdownEvent)(System::TObject* Sender, TsbxTLSClientTLSShutdownEventParams *e); __property TsbxTLSClientTLSShutdownEvent OnTLSShutdown = { read=FOnTLSShutdown, write=FOnTLSShutdown }; ``` ## Remarks This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported. # Config Settings ([TLSClient](#tlsclient-component) Component) The component accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these *internal properties* is provided through the [Config](#config-method-tlsclient-component) method. ### TLSClient Config Settings **CachedCRLMaxAge**: Specifies the maximum age of a cached CRL.Use this setting to specify the maximum number of seconds that may pass since a CRL was added to the global cache. When the cached CRL is older than this value, it is disregarded and a new CRL should be fetched. The default value is 0, which disables the absolute CRL age check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings. **CachedCRLMaxAgeRatio**: Specifies the maximum age of a cached CRL as a percentage of its remaining lifetime.Use this setting to specify the percentage of the CRL's remaining lifetime, measured from the time the CRL was added to the global cache to the CRL's NextUpdate. When this portion of the remaining lifetime has passed, the cached CRL is disregarded and a new CRL should be fetched. The default value is 0, which disables the CRL ratio check. Values are interpreted in the 0..100 range. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings. **CachedCRLOverlapTime**: Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed.Use this setting to specify the number of seconds before the NextUpdate time at which the cached CRL should be disregarded, and a new CRL should be fetched. The default value is 0, which disables the CRL overlap check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings. This setting is evaluated independently from [CachedCRLMaxAge](#CachedCRLMaxAge) and [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio). If several cached CRL freshness settings are enabled, the cached CRL is used only if it satisfies all of them. **CachedOCSPResponseMaxAge**: Specifies the maximum age of a cached OCSP response.Use this setting to specify the maximum number of seconds that may pass since an OCSP response was added to the global cache. When the cached OCSP response is older than this value, it is disregarded and a new OCSP response should be fetched. The default value is 0, which disables the absolute OCSP response age check. This setting is also used to limit open-ended OCSP responses that do not have NextUpdate. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings. **CachedOCSPResponseMaxAgeRatio**: Specifies the maximum age of a cached OCSP response as a percentage of its remaining lifetime.Use this setting to specify the percentage of the OCSP response's remaining lifetime, measured from the time the OCSP response was added to the global cache to the response's NextUpdate. When this portion of the remaining lifetime has passed, the cached OCSP response is disregarded and a new OCSP response should be fetched. The default value is 0, which disables the OCSP response ratio check. Values are interpreted in the 0..100 range. Open-ended OCSP responses without NextUpdate ignore this setting; use [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) to limit their age. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings. **CachedOCSPResponseOverlapTime**: Specifies the time period before a cached OCSP response's NextUpdate when it is considered stale and must be refreshed.Use this setting to specify the number of seconds before the NextUpdate time at which the cached OCSP response should be disregarded, and a new OCSP response should be fetched. The default value is 0, which disables the OCSP response overlap check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings. This setting is evaluated independently from [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) and [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio). If several cached OCSP response freshness settings are enabled, the cached OCSP response is used only if it satisfies all of them. **DeltaCRLPreference**: Specifies whether complete or delta CRLs are preferred.Use this setting to specify which CRL type should be preferred during TLS certificate revocation checks. The default value is **dcrlpPreferDelta** (0). Supported values: - **dcrlpPreferDelta** (0): retrieve and use delta CRLs when available, falling back to complete CRLs when needed. - **dcrlpPreferComplete** (1): try complete CRLs first, and use delta CRLs only if complete CRLs cannot be retrieved. **EvaluateSystemTrust**: Enables or disables usage of the platform's built-in trust validation facilities.Enable this property to delegate the chain validation to the operating system's native trust evaluation mechanism (e.g. SecTrustEvaluate on Apple platforms). This functionality is currently available on macOS and iOS systems only. This property is enabled by default. **IgnoreSystemTrust**: Whether trusted Windows Certificate Stores should be treated as trusted.Specifies whether, during chain validation, the component should respect the trust to CA certificates as configured in the operating system. In Windows this effectively defines whether the component should trust the certificates residing in the Trusted Root Certification Authorities store. If [IgnoreSystemTrust](#IgnoreSystemTrust) is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as the TrustedCertificates property) are considered trusted. **RevocationCacheAgePolicy**: Specifies a preset policy for cached CRL and OCSP response freshness settings.Use this setting to configure all cached revocation freshness settings at once. The default value is Disabled. Supported values are case-insensitive: | | | | --- | --- | | Disabled | Sets [CachedCRLOverlapTime](#CachedCRLOverlapTime), [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime), [CachedCRLMaxAge](#CachedCRLMaxAge), [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge), [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio), and [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio) to 0. This value is the default. It only disables the cache-age freshness policy; it does not disable revocation checking or use of the revocation cache. | | Default | Applies the component default freshness settings. For this component, Default is equivalent to Disabled. | | Short | Uses crl:43200;50;300,ocsp:1800;50;300. This means: CRL maximum age 12 hours, CRL age ratio 50%, CRL overlap 5 minutes; OCSP response maximum age 30 minutes, OCSP response age ratio 50%, OCSP response overlap 5 minutes. | | Long | Uses crl:518400;50;3600,ocsp:21600;50;3600. This means: CRL maximum age 6 days, CRL age ratio 50%, CRL overlap 1 hour; OCSP response maximum age 6 hours, OCSP response age ratio 50%, OCSP response overlap 1 hour. | | N | Interprets N as an integer number of seconds. The overlap settings are set to N seconds, CRL maximum age is set to N * 144, OCSP response maximum age is set to N * 6, and both ratio settings are set to 50. | | crl:;;,ocsp:;; | Sets the CRL and OCSP response freshness values explicitly. | Ratios must be in the 0..100 range. Maximum age and overlap values must be non-negative. Short and Long are time-scale profiles: Long allows older cached revocation information by increasing maximum ages, but also uses a larger pre-expiry safety margin by increasing overlap times. For individual [CachedCRLOverlapTime](#CachedCRLOverlapTime), [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime), [CachedCRLMaxAge](#CachedCRLMaxAge), [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge), [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio), and [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio) settings, a value of 0 disables the corresponding freshness check. The individual settings remain available for advanced configuration and can be used after this setting to override specific values. **StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the component. 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 component) 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 component is set to "*local*", the property returns/restores the rules from/to the internal storage of the component. If *StaticDNS* of the component 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. **TLSCiphersuites**: Returns the list of ciphersuites activated in the component for the current session.Check this property to enumerate the list of TLS ciphersuites enabled in the component. A good place to do that is OnTLSHandshake event handler. **TLSExtensions**: TBD.TBD **TLSGroups**: Returns the list of TLS key exchange groups enabled in the component.Check this property to enumerate the list of TLS key exchange groups enabled in the component. **TLSPeerExtensions**: TBD.TBD **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 components. **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). **TLSVersions**: Returns the list of TLS versions enabled in the component.Check this property to obtain the list of TLS versions enabled in the component, as an integer bitmask. **TolerateMinorChainIssues**: Whether to tolerate minor chain issues.This parameter controls whether the chain validator should tolerate minor technical issues when validating the chain. Those are: - CA, revocation source, TLS key usage requirements are not mandated - Violation of OCSP issuer requirements are ignored - The AuthorityKeyID extension in CRL- and certificate-issuing CAs are ignored (helps with incorrectly renewed certificates) - Basic constraints and name constraints of CA certificates are ignored - Some weaker algorithms are tolerated **UseEnvStorages**: Enables or disables use of the environment storages.Enable this property to make the chain validation module automatically look up missing CA and intermediate certificates in the environment storages. **UseMicrosoftCTL**: Enables or disables the automatic use of the Microsoft online certificate trust list.Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository. **UseSystemCertificates**: Enables or disables the use of the system certificates.Use this property to tell the chain validation module to automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework. ### 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 component. Supported values are: | | | | | --- | --- | --- | | off | | No caching (default) | | local | | Local caching | | global | | Global caching | **Cookies**: Gets or sets local cookies for the component.Use this property to get cookies from the internal cookie storage of the component 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 components 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 components. **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 component. 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 component) 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 component is set to "*local*", the property returns/restores the rules from/to the internal storage of the component. If *StaticDNS* of the component 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 components. **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 ([TLSClient](#tlsclient-component) Component) ### TLSClient 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)) |