Class: Zizq::TlsConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
lib/zizq/tls_configuration.rb,
sig/generated/zizq/tls_configuration.rbs

Overview

TLS settings for connecting to the Zizq server over HTTPS.

Set inside a Zizq.configure block via the c.tls accessors:

Zizq.configure do |c|
c.tls.ca          = "/path/to/ca-cert.pem"
c.tls.client_cert = "/path/to/client-cert.pem"
c.tls.client_key  = "/path/to/client-key.pem"
end

All values may be PEM-encoded strings or file paths.

Note: Mutual TLS support requires a Zizq Pro license on the server.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#ca ⇒ Object

Returns the value of attribute ca

Returns:

  • (Object) —

    the current value of ca



21
22
23
 
# File 'lib/zizq/tls_configuration.rb', line 21

def ca
  @ca
end

#client_cert ⇒ Object

Returns the value of attribute client_cert

Returns:

  • (Object) —

    the current value of client_cert



21
22
23
 
# File 'lib/zizq/tls_configuration.rb', line 21

def client_cert
  @client_cert
end

#client_key ⇒ Object

Returns the value of attribute client_key

Returns:

  • (Object) —

    the current value of client_key



21
22
23
 
# File 'lib/zizq/tls_configuration.rb', line 21

def client_key
  @client_key
end

Class Method Details

.new(ca:, client_cert:, client_key:) ⇒ instance .new(arg0) ⇒ instance

Overloads:

  • .new(ca:, client_cert:, client_key:) ⇒ instance

    Parameters:

    • ca: (String, nil)
    • client_cert: (String, nil)
    • client_key: (String, nil)

    Returns:

    • (instance)
  • .new(arg0) ⇒ instance

    Parameters:

    • arg0 ({ ?ca: String?, ?client_cert: String?, ?client_key: String? })

    Returns:

    • (instance) 


24
25
 
# File 'sig/generated/zizq/tls_configuration.rbs', line 24

def self.new: (?ca: String?, ?client_cert: String?, ?client_key: String?) -> instance
| ({ ?ca: String?, ?client_cert: String?, ?client_key: String? }) -> instance