Struct TlsClientConfig 

pub struct TlsClientConfig(/* private fields */);

Available on crate feature boring only.

A backend agnostic builder for the common TLS configs.

It holds a set of fine grained config extensions (e.g. TlsAlpn, TlsServerVerify) and exposes typed setters for the settings both TLS backends support. Backend crates add setters for their backend-specific pieces via extension traits (RustlsClientConfigExt).

Implementations

impl TlsClientConfig

pub fn new() -> TlsClientConfig

Create an empty config.

pub fn default_http() -> TlsClientConfig

Create a default TlsClientConfig that enables:

• ALPN: H2, http1.1
• Keylogger: KeyLogIntent::Environment

pub fn write_to(&self, extensions: &Extensions)

Transfer this config’s pieces onto extensions (appending, so they override existing entries of the same type — newest-wins). Use this to transfer the tls config to e.g. request extensions

pub fn with_alpn(self, protocols: Vec<ApplicationProtocol>) -> TlsClientConfig

Set the ALPN protocols to offer.

pub fn set_alpn( &mut self, protocols: Vec<ApplicationProtocol>, ) -> &mut TlsClientConfig

Set the ALPN protocols to offer.

pub fn with_alpn_http_auto(self) -> TlsClientConfig

Offer HTTP/2 and HTTP/1.1 via ALPN.

pub fn set_alpn_http_auto(&mut self) -> &mut TlsClientConfig

Offer HTTP/2 and HTTP/1.1 via ALPN.

pub fn with_alpn_http_1(self) -> TlsClientConfig

Offer HTTP/1.1 only via ALPN.

pub fn set_alpn_http_1(&mut self) -> &mut TlsClientConfig

Offer HTTP/1.1 only via ALPN.

pub fn with_alpn_http_2(self) -> TlsClientConfig

Offer HTTP/2 only via ALPN.

pub fn set_alpn_http_2(&mut self) -> &mut TlsClientConfig

Offer HTTP/2 only via ALPN.

pub fn with_server_name(self, server_name: Host) -> TlsClientConfig

Set the client SNI (server name) to send.

Overrides the SNI the connector would otherwise derive: the transport authority host, or for a tunnel connector, the TlsTunnel sni

pub fn set_server_name(&mut self, server_name: Host) -> &mut TlsClientConfig

Set the client SNI (server name) to send.

Overrides the SNI the connector would otherwise derive: the transport authority host, or for a tunnel connector, the TlsTunnel sni

pub fn with_server_verify(self, mode: ServerVerifyMode) -> TlsClientConfig

Set how the server certificate is verified.

pub fn set_server_verify( &mut self, mode: ServerVerifyMode, ) -> &mut TlsClientConfig

Set how the server certificate is verified.

pub fn with_supported_versions( self, versions: Vec<ProtocolVersion>, ) -> TlsClientConfig

Set the supported protocol versions.

pub fn set_supported_versions( &mut self, versions: Vec<ProtocolVersion>, ) -> &mut TlsClientConfig

Set the supported protocol versions.

pub fn with_keylog(self, intent: KeyLogIntent) -> TlsClientConfig

Set the keylog intent.

pub fn set_keylog(&mut self, intent: KeyLogIntent) -> &mut TlsClientConfig

Set the keylog intent.

pub fn with_client_auth(self, client_auth: ClientAuth) -> TlsClientConfig

Set the client certificate authentication material (mTLS).

pub fn set_client_auth( &mut self, client_auth: ClientAuth, ) -> &mut TlsClientConfig

Set the client certificate authentication material (mTLS).

pub fn with_store_server_cert_chain(self, store: bool) -> TlsClientConfig

Set whether the peer certificate chain is captured.

pub fn set_store_server_cert_chain( &mut self, store: bool, ) -> &mut TlsClientConfig

Set whether the peer certificate chain is captured.

pub fn as_extensions(&self) -> &Extensions

Trait Implementations

impl Clone for TlsClientConfig

fn clone(&self) -> TlsClientConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TlsClientConfig

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

Formats the value using the given formatter.

impl Default for TlsClientConfig

fn default() -> TlsClientConfig

Returns the “default value” for a type.

impl RustlsClientConfigExt for TlsClientConfig

fn with_cert_verifier( self, verifier: Arc<dyn ServerCertVerifier>, ) -> TlsClientConfig

Set a custom server certificate verifier

fn set_cert_verifier( &mut self, verifier: Arc<dyn ServerCertVerifier>, ) -> &mut TlsClientConfig

Set a custom server certificate verifier

fn with_modify_rustls_config( self, modify: impl Fn(ClientConfig) -> Result<ClientConfig, Box<dyn Error + Sync + Send>> + Send + Sync + 'static, ) -> TlsClientConfig

Take over the final rustls ClientConfig build: see ModifyRustlsClientConfig.

fn set_modify_rustls_config( &mut self, modify: impl Fn(ClientConfig) -> Result<ClientConfig, Box<dyn Error + Sync + Send>> + Send + Sync + 'static, ) -> &mut TlsClientConfig

Take over the final rustls ClientConfig build: see ModifyRustlsClientConfig.