Struct TlsParametersBuilder

pub struct TlsParametersBuilder { /* private fields */ }

Builder for TlsParameters

Implementations

impl TlsParametersBuilder

pub fn new(domain: String) -> Self

Creates a new builder for TlsParameters

pub fn certificate_store(self, cert_store: CertificateStore) -> Self

Set the source for the base set of root certificates to trust.

pub fn add_root_certificate(self, cert: Certificate) -> Self

Add a custom root certificate

Can be used to safely connect to a server using a self-signed certificate, for example.

pub fn identify_with(self, identity: Identity) -> Self

Add a client certificate

Can be used to configure a client certificate to present to the server.

pub fn dangerous_accept_invalid_hostnames( self, accept_invalid_hostnames: bool, ) -> Self

Controls whether certificates with an invalid hostname are accepted

This option is silently disabled when using rustls-platform-verifier.

Defaults to false.

Warning

You should think very carefully before using this method. If hostname verification is disabled any valid certificate, including those from other sites, are trusted.

This method introduces significant vulnerabilities to man-in-the-middle attacks.

pub fn set_min_tls_version(self, min_tls_version: TlsVersion) -> Self

Controls which minimum TLS version is allowed

Defaults to Tlsv12.

pub fn dangerous_accept_invalid_certs(self, accept_invalid_certs: bool) -> Self

Controls whether invalid certificates are accepted

Defaults to false.

Warning

You should think very carefully before using this method. If certificate verification is disabled, any certificate is trusted for use, including:

• Self signed certificates
• Certificates from different hostnames
• Expired certificates

This method should only be used as a last resort, as it introduces significant vulnerabilities to man-in-the-middle attacks.

pub fn build(self) -> Result<TlsParameters, Error>

Creates a new TlsParameters using native-tls, boring-tls or rustls depending on which one is available

pub fn build_native(self) -> Result<TlsParameters, Error>

Creates a new TlsParameters using native-tls with the provided configuration

Trait Implementations

impl Clone for TlsParametersBuilder

fn clone(&self) -> TlsParametersBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TlsParametersBuilder

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

Formats the value using the given formatter.