Skip to main content

Tls

Struct Tls 

Source
pub struct Tls { /* private fields */ }
Expand description

How a connection to the broker is secured.

Start from Tls::system_roots for a broker whose certificate a public authority issued, or Tls::with_ca_pem for one whose certificate comes from an authority of its own, and add client_certificate when the broker asks each client to prove who it is.

§Examples

use pamoja_mqtt::{MqttConfig, Tls};

// A hosted broker with a publicly issued certificate, on the MQTT over TLS port.
let config = MqttConfig::new("sensor-1", "broker.example.com", 8883).tls(Tls::system_roots());
assert!(config.uses_tls());

Implementations§

Source§

impl Tls

Source

pub fn system_roots() -> Tls

Trusts the certificate authorities the operating system trusts.

§Returns

The TLS settings, presenting no client certificate.

Source

pub fn with_ca_pem(pem: impl Into<Vec<u8>>) -> Tls

Trusts only the certificate authorities in a PEM file.

A broker on a private network usually holds a certificate its operator issued, so the client trusts that operator’s authority and nothing else.

§Arguments
  • pem - one or more CERTIFICATE blocks.
§Returns

The TLS settings, presenting no client certificate.

Source

pub fn client_certificate( self, certificate_pem: impl Into<Vec<u8>>, key_pem: impl Into<Vec<u8>>, ) -> Tls

Presents a client certificate, for a broker that authenticates each client by one.

§Arguments
  • certificate_pem - the client’s certificate, followed by any intermediates.
  • key_pem - the certificate’s private key, in PKCS #8, PKCS #1, or SEC1 form.
§Returns

The updated settings, for chaining.

Trait Implementations§

Source§

impl Clone for Tls

Source§

fn clone(&self) -> Tls

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Tls

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Tls

§

impl RefUnwindSafe for Tls

§

impl Send for Tls

§

impl Sync for Tls

§

impl Unpin for Tls

§

impl UnsafeUnpin for Tls

§

impl UnwindSafe for Tls

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.