Class: Temporalio::EnvConfig::ClientConfigTLS

Inherits:
Data
  • Object
show all
Defined in:
lib/temporalio/env_config.rb,
lib/temporalio/env_config.rb

Overview

TLS configuration for Temporal client connections.

This class provides methods for creating, serializing, and converting TLS configuration objects used by Temporal clients.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(disabled: nil, server_name: nil, server_root_ca_cert: nil, client_cert: nil, client_private_key: nil) ⇒ ClientConfigTLS

Set default values



47
48
49
50
 
# File 'lib/temporalio/env_config.rb', line 47

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

Instance Attribute Details

#client_cert ⇒ Pathname, ... (readonly)

Returns Client certificate source.

Returns:

  • (Pathname, String, nil) —

    Client certificate source



24
 
# File 'lib/temporalio/env_config.rb', line 24

ClientConfigTLS = Data.define(:disabled, :server_name, :server_root_ca_cert, :client_cert, :client_private_key)

#client_private_key ⇒ Pathname, ... (readonly)

Returns Client key source.

Returns:

  • (Pathname, String, nil) —

    Client key source



24
 
# File 'lib/temporalio/env_config.rb', line 24

ClientConfigTLS = Data.define(:disabled, :server_name, :server_root_ca_cert, :client_cert, :client_private_key)

#disabled ⇒ Boolean? (readonly)

Returns If true, TLS is explicitly disabled; if nil, not specified.

Returns:

  • (Boolean, nil) —

    If true, TLS is explicitly disabled; if nil, not specified



24
 
# File 'lib/temporalio/env_config.rb', line 24

ClientConfigTLS = Data.define(:disabled, :server_name, :server_root_ca_cert, :client_cert, :client_private_key)

#server_name ⇒ String? (readonly)

Returns SNI override.

Returns:

  • (String, nil) —

    SNI override



24
 
# File 'lib/temporalio/env_config.rb', line 24

ClientConfigTLS = Data.define(:disabled, :server_name, :server_root_ca_cert, :client_cert, :client_private_key)

#server_root_ca_cert ⇒ Pathname, ... (readonly)

Returns Server CA certificate source.

Returns:

  • (Pathname, String, nil) —

    Server CA certificate source



24
 
# File 'lib/temporalio/env_config.rb', line 24

ClientConfigTLS = Data.define(:disabled, :server_name, :server_root_ca_cert, :client_cert, :client_private_key)

Class Method Details

.from_h(hash) ⇒ ClientConfigTLS?

Create a ClientConfigTLS from a hash

Parameters:

  • hash (Hash, nil) —

    Hash representation

Returns:

  • (ClientConfigTLS, nil) —

    The TLS configuration or nil if hash is nil/empty



34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/temporalio/env_config.rb', line 34

def self.from_h(hash)
  return nil if hash.nil? || hash.empty?

  new(
    disabled: hash[:disabled],
    server_name: hash[:server_name],
    server_root_ca_cert: hash_to_source(hash[:server_ca_cert]),
    client_cert: hash_to_source(hash[:client_cert]),
    client_private_key: hash_to_source(hash[:client_key])
  )
end

Instance Method Details

#to_client_tls_options ⇒ Connection::TLSOptions, false

Create a TLS configuration for use with connections

Returns:

  • (Connection::TLSOptions, false) —

    TLS options or false if disabled



66
67
68
69
70
71
72
73
74
75
 
# File 'lib/temporalio/env_config.rb', line 66

def to_client_tls_options
  return false if disabled

  Client::Connection::TLSOptions.new(
    domain: server_name,
    server_root_ca_cert: read_source(server_root_ca_cert),
    client_cert: read_source(client_cert),
    client_private_key: read_source(client_private_key)
  )
end

#to_h ⇒ Hash

Convert to a hash that can be used for TOML serialization

Returns:

  • (Hash) —

    Dictionary representation



54
55
56
57
58
59
60
61
62
 
# File 'lib/temporalio/env_config.rb', line 54

def to_h
  {
    disabled:,
    server_name:,
    server_ca_cert: server_root_ca_cert ? source_to_hash(server_root_ca_cert) : nil,
    client_cert: client_cert ? source_to_hash(client_cert) : nil,
    client_key: client_private_key ? source_to_hash(client_private_key) : nil
  }.compact
end