The TLSClient component provides client-side functionality of the TLS protocol.
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.
The following is the full list of the properties of the module with short descriptions. Click on the links for further details.
|BlockedCertificates||The certificates that must be rejected as trust anchors.|
|ClientChain||The TLS client certificate chain.|
|Connected||Indicates whether the connection is active.|
|ConnectionInfo||Returns the details of the underlying network connection.|
|ErrorOrigin||Indicates the endpoint where the error originates from.|
|ErrorSeverity||The severity of the error that happened.|
|ExternalCrypto||Provides access to external signing and DC parameters.|
|KnownCertificates||Additional certificates for chain validation.|
|KnownCRLs||Additional CRLs for chain validation.|
|KnownOCSPs||Additional OCSP responses for chain validation.|
|OutputBytes||A memory buffer where the incoming data is collected.|
|OutputString||A string where the incoming data is collected.|
|Proxy||The proxy server settings.|
|ServerChain||The TLS server's certificate chain.|
|SocketSettings||Manages network connection settings.|
|TLSSettings||Manages TLS layer settings.|
|TrustedCertificates||A list of trusted certificates for chain validation.|
The following is the full list of the methods of the module with short descriptions. Click on the links for further details.
|Config||Sets or retrieves a configuration setting.|
|Connect||Establishes connection to a remote server.|
|Disconnect||Disconnects from the server.|
|ReceiveAllData||Reads data from the connection.|
|ReceiveData||Reads data from the connection.|
|SendData||Sends a buffer to the server.|
|SendKeepAlive||Sends a keep-alive packet.|
|SendText||Sends a text string to the server.|
The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.
|CertificateValidate||Fires when the server's TLS certificate has to be validated.|
|Error||Information about errors during data delivery.|
|ExternalSign||Handles remote or external signing initiated by the SignExternal method or other source.|
|Notification||This event notifies the application about an underlying control flow event.|
The following is a list of configuration settings for the module with short descriptions. Click on the links for further details.
|IgnoreSystemTrust||Whether trusted Windows Certificate Stores should be treated as trusted.|
|TolerateMinorChainIssues||Whether to tolerate minor chain issues.|
|UseMicrosoftCTL||Enables or disables automatic use of Microsoft online certificate trust list.|
|UseSystemCertificates||Enables or disables the use of the system certificates.|
|CheckKeyIntegrityBeforeUse||Enables or disable private key integrity check before use.|
|CookieCaching||Specifies whether a cookie cache should be used for HTTP(S) transports.|
|Cookies||Gets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only).|
|DefDeriveKeyIterations||Specifies the default key derivation algorithm iteration count.|
|EnableClientSideSSLFFDHE||Enables or disables finite field DHE key exchange support in TLS clients.|
|GlobalCookies||Gets or sets global cookies for all the HTTP transports.|
|HttpUserAgent||Specifies the user agent name to be used by all HTTP clients.|
|LogDestination||Specifies the debug log destination.|
|LogDetails||Specifies the debug log details to dump.|
|LogFile||Specifies the debug log filename.|
|LogFilters||Specifies the debug log filters.|
|LogFlushMode||Specifies the log flush mode.|
|LogLevel||Specifies the debug log level.|
|LogMaxEventCount||Specifies the maximum number of events to cache before further action is taken.|
|LogRotationMode||Specifies the log rotation mode.|
|MaxASN1BufferLength||Specifies the maximal allowed length for ASN.1 primitive tag data.|
|MaxASN1TreeDepth||Specifies the maximal depth for processed ASN.1 trees.|
|OCSPHashAlgorithm||Specifies the hash algorithm to be used to identify certificates in OCSP requests.|
|UseOwnDNSResolver||Specifies whether the client components should use own DNS resolver.|
|UseSharedSystemStorages||Specifies whether the validation engine should use a global per-process copy of the system certificate stores.|
|UseSystemOAEPAndPSS||Enforces or disables the use of system-driven RSA OAEP and PSS computations.|
|UseSystemRandom||Enables or disables the use of the OS PRNG.|