Class: Temporalio::Client::Connection::TLSOptions

Inherits:
Struct
  • Object
show all
Defined in:
lib/temporalio/client/connection.rb

Overview

TLS options. All attributes are optional, and an empty options set just enables default TLS.

Instance Attribute Summary collapse

Instance Attribute Details

#client_cert ⇒ String?

Returns Client certificate for mTLS. Must be combined with #client_private_key.

Returns:



44
45
46
47
48
49
50
 
# File 'lib/temporalio/client/connection.rb', line 44

TLSOptions = Struct.new(
  :client_cert,
  :client_private_key,
  :server_root_ca_cert,
  :domain,
  keyword_init: true
)

#client_private_key ⇒ String?

Returns Client private key for mTLS. Must be combined with #client_cert.

Returns:

  • (String, nil) —

    Client private key for mTLS. Must be combined with #client_cert.



44
45
46
47
48
49
50
 
# File 'lib/temporalio/client/connection.rb', line 44

TLSOptions = Struct.new(
  :client_cert,
  :client_private_key,
  :server_root_ca_cert,
  :domain,
  keyword_init: true
)

#domain ⇒ String?

Returns SNI override. This is only needed for self-hosted servers with certificates that do not match the hostname being connected to.

Returns:

  • (String, nil) —

    SNI override. This is only needed for self-hosted servers with certificates that do not match the hostname being connected to.



44
45
46
47
48
49
50
 
# File 'lib/temporalio/client/connection.rb', line 44

TLSOptions = Struct.new(
  :client_cert,
  :client_private_key,
  :server_root_ca_cert,
  :domain,
  keyword_init: true
)

#server_root_ca_cert ⇒ String?

Returns Root CA certificate to validate the server certificate against. This is only needed for self-hosted servers with self-signed server certificates.

Returns:

  • (String, nil) —

    Root CA certificate to validate the server certificate against. This is only needed for self-hosted servers with self-signed server certificates.



44
45
46
47
48
49
50
 
# File 'lib/temporalio/client/connection.rb', line 44

TLSOptions = Struct.new(
  :client_cert,
  :client_private_key,
  :server_root_ca_cert,
  :domain,
  keyword_init: true
)