SecureBlackbox 2020 macOS Edition

Questions / Feedback?

TLSClient Module

Properties   Methods   Events   Configuration Settings   Errors  

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.

Property List

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

BlockedCertificatesThe certificates that must be rejected as trust anchors.
ClientChainThe TLS client certificate chain.
ConnectedIndicates whether the connection is active.
ConnectionInfoReturns the details of the underlying network connection.
ErrorOriginIndicates the endpoint where the error originates from.
ErrorSeverityThe severity of the error that happened.
ExternalCryptoProvides access to external signing and DC parameters.
KnownCertificatesAdditional certificates for chain validation.
KnownCRLsAdditional CRLs for chain validation.
KnownOCSPsAdditional OCSP responses for chain validation.
OutputBytesA memory buffer where the incoming data is collected.
OutputStringA string where the incoming data is collected.
ProxyThe proxy server settings.
ServerChainThe TLS server's certificate chain.
SocketSettingsManages network connection settings.
TLSSettingsManages TLS layer settings.
TrustedCertificatesA list of trusted certificates for chain validation.

Method List

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

ConfigSets or retrieves a configuration setting.
ConnectEstablishes connection to a remote server.
DisconnectDisconnects from the server.
ReceiveAllDataReads data from the connection.
ReceiveDataReads data from the connection.
SendDataSends a buffer to the server.
SendKeepAliveSends a keep-alive packet.
SendTextSends a text string to the server.

Event List

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

CertificateValidateFires when the server's TLS certificate has to be validated.
ErrorInformation about errors during data delivery.
ExternalSignHandles remote or external signing initiated by the SignExternal method or other source.
NotificationThis event notifies the application about an underlying control flow event.

Configuration Settings

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

IgnoreSystemTrustWhether trusted Windows Certificate Stores should be treated as trusted.
TolerateMinorChainIssuesWhether to tolerate minor chain issues.
UseMicrosoftCTLEnables or disables automatic use of Microsoft online certificate trust list.
UseSystemCertificatesEnables or disables the use of the system certificates.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
UseOwnDNSResolverSpecifies whether the client components should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2020 macOS Edition - Version 20.0 [Build 8165]