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

Inherits:
Object
  • 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 Method Summary collapse

Constructor Details

#initialize(client_cert: nil, client_private_key: nil, server_root_ca_cert: nil, domain: nil) ⇒ TLSOptions

Returns a new instance of TLSOptions.



53
54
55
56
57
58
59
60
 
# File 'lib/temporalio/client/connection.rb', line 53

def initialize(
  client_cert: nil,
  client_private_key: nil,
  server_root_ca_cert: nil,
  domain: nil
)
  super
end

Instance Attribute Details

#client_cert ⇒ String?

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

Returns:



52
53
54
55
56
57
58
59
60
61
 
# File 'lib/temporalio/client/connection.rb', line 52

class TLSOptions
  def initialize(
    client_cert: nil,
    client_private_key: nil,
    server_root_ca_cert: nil,
    domain: nil
  )
    super
  end
end

#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.



52
53
54
55
56
57
58
59
60
61
 
# File 'lib/temporalio/client/connection.rb', line 52

class TLSOptions
  def initialize(
    client_cert: nil,
    client_private_key: nil,
    server_root_ca_cert: nil,
    domain: nil
  )
    super
  end
end

#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.



52
53
54
55
56
57
58
59
60
61
 
# File 'lib/temporalio/client/connection.rb', line 52

class TLSOptions
  def initialize(
    client_cert: nil,
    client_private_key: nil,
    server_root_ca_cert: nil,
    domain: nil
  )
    super
  end
end

#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.



52
53
54
55
56
57
58
59
60
61
 
# File 'lib/temporalio/client/connection.rb', line 52

class TLSOptions
  def initialize(
    client_cert: nil,
    client_private_key: nil,
    server_root_ca_cert: nil,
    domain: nil
  )
    super
  end
end