Struct esp_idf_svc::sys::esp_mqtt_client_config_t_credentials_t_authentication_t

#[repr(C)]
pub struct esp_mqtt_client_config_t_credentials_t_authentication_t {
    pub password: *const i8,
    pub certificate: *const i8,
    pub certificate_len: usize,
    pub key: *const i8,
    pub key_len: usize,
    pub key_password: *const i8,
    pub key_password_len: i32,
    pub use_secure_element: bool,
    pub ds_data: *mut c_void,
}

Client authentication

Fields related to client authentication by broker

For mutual authentication using TLS, user could select certificate and key, secure element or digital signature peripheral if available.

Fields

password: *const i8

< MQTT password

certificate: *const i8

< Certificate for ssl mutual authentication, not required if mutual authentication is not needed. Must be provided with key. It’s not copied nor freed by the client, user needs to clean up.

certificate_len: usize

< Length of the buffer pointed to by certificate.

key: *const i8

< Private key for SSL mutual authentication, not required if mutual authentication is not needed. If it is not NULL, also certificate has to be provided. It’s not copied nor freed by the client, user needs to clean up.

key_len: usize

< Length of the buffer pointed to by key.

key_password: *const i8

< Client key decryption password, not PEM nor DER, if provided key_password_len must be correctly set.

key_password_len: i32

< Length of the password pointed to by key_password

use_secure_element: bool

< Enable secure element, available in ESP32-ROOM-32SE, for SSL connection

ds_data: *mut c_void

< Carrier of handle for digital signature parameters, digital signature peripheral is available in some Espressif devices. It’s not copied nor freed by the client, user needs to clean up.

Trait Implementations

impl Clone for esp_mqtt_client_config_t_credentials_t_authentication_t

fn clone(&self) -> esp_mqtt_client_config_t_credentials_t_authentication_t

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for esp_mqtt_client_config_t_credentials_t_authentication_t

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

Formats the value using the given formatter.

impl Default for esp_mqtt_client_config_t_credentials_t_authentication_t

fn default() -> esp_mqtt_client_config_t_credentials_t_authentication_t

Returns the “default value” for a type.

impl Copy for esp_mqtt_client_config_t_credentials_t_authentication_t