Skip to main content

Interface: TLSConfig

TLS configuration options.

Properties​

clientCertPair?​

optional clientCertPair?: object

Sets the client certificate and key for connecting with mTLS

crt​

crt: Uint8Array

The certificate for this client

key​

key: Uint8Array

The private key for this client


serverNameOverride?​

optional serverNameOverride?: string

Overrides the target name (SNI) used for TLS host name checking. If this attribute is not specified, the name used for TLS host name checking will be the host from ServerOptions.url. This can be useful when you have reverse proxy in front of temporal server, and you may want to override the SNI to direct traffic to the appropriate backend server based on custom routing rules. Oppositely, connections could be refused if the provided SNI does not match the expected host. Adding this override should be done with care.


serverRootCACertificate?​

optional serverRootCACertificate?: Uint8Array<ArrayBufferLike>

Root CA certificate used by the server. If not set, and the server's cert is issued by someone the operating system trusts, verification will still work (ex: Cloud offering).


verificationServerNames?​

optional verificationServerNames?: string[]

Names to verify the server certificate against, instead of serverNameOverride or the host from the connection address. The certificate is accepted if it is valid for any one of these names.

Use this when one address can route to servers that present different certificate names, for example regional servers behind a global address, where each server's certificate names only its own region. Unlike serverNameOverride, this does not change the SNI or HTTP/2 authority values.

Requires serverRootCACertificate; the system root store is not consulted when this is set. Must not be empty.