class documentation

class TLSConfig: (source)

View In Hierarchy

TLS configuration for connecting to Temporal server.

Class Variable client_cert Client certificate for mTLS.
Class Variable client_private_key Client private key for mTLS.
Class Variable domain SNI host and HTTP/2 authority override, and the default name the server certificate is verified against (see verification_server_name).
Class Variable server_root_ca_cert Root CA to validate the server certificate against.
Class Variable verification_server_name Name to verify the server certificate against, instead of the domain / connected host.
Method _to_bridge_config Undocumented
client_cert: bytes | None = (source)

Client certificate for mTLS.

This must be combined with client_private_key.

client_private_key: bytes | None = (source)

Client private key for mTLS.

This must be combined with client_cert.

SNI host and HTTP/2 authority override, and the default name the server certificate is verified against (see verification_server_name).

server_root_ca_cert: bytes | None = (source)

Root CA to validate the server certificate against.

verification_server_name: str | None = (source)

Name to verify the server certificate against, instead of the domain / connected host.

Unlike domain, this does not change the TLS SNI or HTTP/2 authority values, which continue to follow the connected host (or domain if set). Use this when the server's certificate does not carry the name being dialed, e.g. when the connection traverses an SNI-inspecting proxy that must be able to resolve the SNI value.

Requires server_root_ca_cert; the system root store is not consulted when this is set.

Undocumented