Struct TlsOptions 

#[non_exhaustive]
pub struct TlsOptions {
    pub server_root_ca_cert: Option<Vec<u8>>,
    pub domain: Option<String>,
    pub client_tls_options: Option<ClientTlsOptions>,
    pub server_cert_verifier: Option<Arc<dyn ServerCertVerifier>>,
}

Configuration options for TLS

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

server_root_ca_cert: Option<Vec<u8>>

Bytes representing the root CA certificate used by the server. If not set, and the server’s cert is issued by someone the operating system trusts, verification will still work (ex: Cloud offering).

domain: Option<String>

Sets the domain name against which to verify the server’s TLS certificate. If not provided, the domain name will be extracted from the URL used to connect.

client_tls_options: Option<ClientTlsOptions>

TLS info for the client. If specified, core will attempt to use mTLS.

Mutually exclusive with client_cert_resolver. Setting both is an error.

server_cert_verifier: Option<Arc<dyn ServerCertVerifier>>

Optional custom server certificate verifier. When set, this replaces the default certificate verification and server_root_ca_cert is ignored.

This is useful for:

• Certificate pinning
• Custom trust-domain validation (e.g., SAN-URI extraction)
• Federated root certificate stores

WARNING

Implementing a custom ServerCertVerifier can lead to severely insecure TLS connections (e.g., disabling all validation or allowing man-in-the-middle attacks) if not done carefully. Only use this if you know exactly what you are doing.

The verifier must implement ServerCertVerifier from the rustls crate. Note that domain is still respected for the :authority header / origin override even when a custom verifier is set.

Implementations

impl TlsOptions

pub fn builder() -> TlsOptionsBuilder

Create an instance of TlsOptions using the builder syntax

Trait Implementations

impl Clone for TlsOptions

fn clone(&self) -> TlsOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TlsOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TlsOptions

fn default() -> Self

Returns the “default value” for a type.