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 or BoringServerConfigExt).

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: SmallVec<[ApplicationProtocol; 2]>, ) -> TlsClientConfig

Set the ALPN protocols to offer.

pub fn set_alpn( &mut self, protocols: SmallVec<[ApplicationProtocol; 2]>, ) -> &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 BoringClientConfigExt for TlsClientConfig

fn new_from_client_hello(hello: &ClientHello) -> TlsClientConfig

Create a new config that mimics the provided ClientHello

fn with_mimic_client_hello(self, hello: &ClientHello) -> TlsClientConfig

Layer the fingerprint pieces captured in a ClientHello onto this config.

fn set_mimic_client_hello( &mut self, hello: &ClientHello, ) -> &mut TlsClientConfig

Layer the fingerprint pieces captured in a ClientHello onto this config.

fn with_cipher_suites(self, suites: Vec<CipherSuite>) -> TlsClientConfig

Set the cipher suites to offer, in order.

fn set_cipher_suites( &mut self, suites: Vec<CipherSuite>, ) -> &mut TlsClientConfig

Set the cipher suites to offer, in order.

fn with_supported_groups(self, groups: Vec<SupportedGroup>) -> TlsClientConfig

Set the supported groups (named curves), in order.

fn set_supported_groups( &mut self, groups: Vec<SupportedGroup>, ) -> &mut TlsClientConfig

Set the supported groups (named curves), in order.

fn with_signature_schemes( self, schemes: Vec<SignatureScheme>, ) -> TlsClientConfig

Set the signature schemes to advertise, in order.

fn set_signature_schemes( &mut self, schemes: Vec<SignatureScheme>, ) -> &mut TlsClientConfig

Set the signature schemes to advertise, in order.

fn with_grease(self, enabled: bool) -> TlsClientConfig

Enable/disable GREASE injection.

fn set_grease(&mut self, enabled: bool) -> &mut TlsClientConfig

Enable/disable GREASE injection.

fn with_alps( self, protocols: Vec<ApplicationProtocol>, new_codepoint: bool, ) -> TlsClientConfig

Set Application-Layer Protocol Settings (ALPS).

fn set_alps( &mut self, protocols: Vec<ApplicationProtocol>, new_codepoint: bool, ) -> &mut TlsClientConfig

Set Application-Layer Protocol Settings (ALPS).

fn with_extension_order(self, order: Vec<ExtensionId>) -> TlsClientConfig

Set the ClientHello extension ordering.

fn set_extension_order( &mut self, order: Vec<ExtensionId>, ) -> &mut TlsClientConfig

Set the ClientHello extension ordering.

fn with_cert_compression( self, algorithms: Vec<CertificateCompressionAlgorithm>, ) -> TlsClientConfig

Set certificate compression algorithms to advertise.

fn set_cert_compression( &mut self, algorithms: Vec<CertificateCompressionAlgorithm>, ) -> &mut TlsClientConfig

Set certificate compression algorithms to advertise.

fn with_delegated_credentials( self, schemes: Vec<SignatureScheme>, ) -> TlsClientConfig

Set delegated credential signature schemes.

fn set_delegated_credentials( &mut self, schemes: Vec<SignatureScheme>, ) -> &mut TlsClientConfig

Set delegated credential signature schemes.

fn with_record_size_limit(self, limit: u16) -> TlsClientConfig

Set the record_size_limit value.

fn set_record_size_limit(&mut self, limit: u16) -> &mut TlsClientConfig

Set the record_size_limit value.

fn with_encrypted_client_hello(self, enabled: bool) -> TlsClientConfig

Enable/disable Encrypted ClientHello (ECH) GREASE.

fn set_encrypted_client_hello(&mut self, enabled: bool) -> &mut TlsClientConfig

Enable/disable Encrypted ClientHello (ECH) GREASE.

fn with_ocsp_stapling(self, enabled: bool) -> TlsClientConfig

Enable/disable OCSP stapling request.

fn set_ocsp_stapling(&mut self, enabled: bool) -> &mut TlsClientConfig

Enable/disable OCSP stapling request.

fn with_signed_cert_timestamps(self, enabled: bool) -> TlsClientConfig

Enable/disable signed certificate timestamps request.

fn set_signed_cert_timestamps(&mut self, enabled: bool) -> &mut TlsClientConfig

Enable/disable signed certificate timestamps request.

fn with_server_verify_cert_store(self, store: Arc<X509Store>) -> TlsClientConfig

Set a custom server-certificate verification store (custom CA roots).

fn set_server_verify_cert_store( &mut self, store: Arc<X509Store>, ) -> &mut TlsClientConfig

Set a custom server-certificate verification store (custom CA roots).

fn with_min_version(self, version: ProtocolVersion) -> TlsClientConfig

Set the minimum TLS version boring will negotiate.

fn set_min_version(&mut self, version: ProtocolVersion) -> &mut TlsClientConfig

Set the minimum TLS version boring will negotiate.

fn with_max_version(self, version: ProtocolVersion) -> TlsClientConfig

Cap the maximum TLS version boring will negotiate.

fn set_max_version(&mut self, version: ProtocolVersion) -> &mut TlsClientConfig

Cap the maximum TLS version boring will negotiate.

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 RamaFrom<&ClientHello, RamaTlsBoringCrateMarker> for TlsClientConfig

fn rama_from(hello: &ClientHello) -> TlsClientConfig

impl RamaTryFrom<&TlsClientConfig, RamaTlsRustlsCrateMarker> for ClientConfig

type Error = Box<dyn Error + Send + Sync>

fn rama_try_from( value: &TlsClientConfig, ) -> Result<ClientConfig, <ClientConfig as RamaTryFrom<&TlsClientConfig, RamaTlsRustlsCrateMarker>>::Error>

impl RamaTryFrom<TlsClientConfig, RamaTlsRustlsCrateMarker> for ClientConfig

type Error = Box<dyn Error + Send + Sync>

fn rama_try_from( value: TlsClientConfig, ) -> Result<ClientConfig, <ClientConfig as RamaTryFrom<TlsClientConfig, RamaTlsRustlsCrateMarker>>::Error>

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 + Send + Sync>> + 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 + Send + Sync>> + Send + Sync + 'static, ) -> &mut TlsClientConfig

Take over the final rustls ClientConfig build: see ModifyRustlsClientConfig.

impl TryFrom<&TlsClientConfig> for TlsConnectorData

fn try_from( value: &TlsClientConfig, ) -> Result<TlsConnectorData, <TlsConnectorData as TryFrom<&TlsClientConfig>>::Error>

Build TlsConnectorData from a TlsClientConfig by gathering its pieces (the same path the connector uses internally).

type Error = Box<dyn Error + Send + Sync>

The type returned in the event of a conversion error.