Struct paho_mqtt::ssl_options::SslOptionsBuilder

pub struct SslOptionsBuilder { /* private fields */ }

Builder to create SSL Options.

Implementations

impl SslOptionsBuilder

pub fn new() -> Self

Creates a new builder with default options.

pub fn trust_store<P>(&mut self, trust_store: P) -> Result<&mut Self> where
    P: AsRef<Path>, 

Set the name of the file in PEM format containing the public digital certificates trusted by the client.

pub fn key_store<P>(&mut self, key_store: P) -> Result<&mut Self> where
    P: AsRef<Path>, 

Set the name of the file in PEM format containing the public certificate chain of the client.

It may also include the client’s private key.

pub fn private_key<P>(&mut self, private_key: P) -> Result<&mut Self> where
    P: AsRef<Path>, 

If not included in the Key Store, this setting points to the file in PEM format containing the client’s private key.

pub fn private_key_password<S>(&mut self, private_key_password: S) -> &mut Self where
    S: Into<String>, 

The password to load the client’s privateKey if it’s encrypted.

pub fn enabled_cipher_suites<S>(
    &mut self,
    enabled_cipher_suites: S
) -> &mut Self where
    S: Into<String>, 

The list of cipher suites that the client will present to the server during the SSL handshake.

For a full explanation of the cipher list format, please see the OpenSSL on-line documentation: http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT

If this setting is ommitted, its default value will be “ALL”, that is, all the cipher suites -excluding those offering no encryption- will be considered.

pub fn enable_server_cert_auth(&mut self, on: bool) -> &mut Self

Enable or disable verification of the server certificate

pub fn ssl_version(&mut self, ver: SslVersion) -> &mut Self

The SSL/TLS version to use.

pub fn verify(&mut self, on: bool) -> &mut Self

Whether to carry out post-connect checks, including that a certificate matches the given host name.

pub fn ca_path<P>(&mut self, ca_path: P) -> Result<&mut Self> where
    P: AsRef<Path>, 

If set, this points to a directory containing CA certificates in PEM format.

pub fn disable_default_trust_store(&mut self, disable: bool) -> &mut Self

Don’t load the default SSL CA.

This should be used together with PSK to make sure regular servers with certificate in place is not accepted.

pub fn alpn_protos(&mut self, protos: &[&str]) -> &mut Self

If set, only these protocols are used during negotiation.

pub fn finalize(&self) -> SslOptions

Create the SSL options from the builder.

Trait Implementations

impl Default for SslOptionsBuilder

fn default() -> SslOptionsBuilder

Returns the “default value” for a type.