Struct paho_mqtt3as_sys::MQTTAsync_SSLOptions

#[repr(C)]
pub struct MQTTAsync_SSLOptions {
    pub struct_id: [c_char; 4],
    pub struct_version: c_int,
    pub trustStore: *const c_char,
    pub keyStore: *const c_char,
    pub privateKey: *const c_char,
    pub privateKeyPassword: *const c_char,
    pub enabledCipherSuites: *const c_char,
    pub enableServerCertAuth: c_int,
}

MQTTAsync_sslProperties defines the settings to establish an SSL/TLS connection using the OpenSSL library. It covers the following scenarios: - Server authentication: The client needs the digital certificate of the server. It is included in a store containting trusted material (also known as "trust store"). - Mutual authentication: Both client and server are authenticated during the SSL handshake. In addition to the digital certificate of the server in a trust store, the client will need its own digital certificate and the private key used to sign its digital certificate stored in a "key store". - Anonymous connection: Both client and server do not get authenticated and no credentials are needed to establish an SSL connection. Note that this scenario is not fully secure since it is subject to man-in-the-middle attacks.

Fields

struct_id: [c_char; 4]

The eyecatcher for this structure. Must be MQTS

struct_version: c_int

The version number of this structure. Must be 0

trustStore: *const c_char

The file in PEM format containing the public digital certificates trusted by the client.

keyStore: *const c_char

The file in PEM format containing the public certificate chain of the client. It may also include the client's private key.

privateKey: *const c_char

If not included in the sslKeyStore, this setting points to the file in PEM format containing the client's private key.

privateKeyPassword: *const c_char

The password to load the client's privateKey if encrypted.

enabledCipherSuites: *const c_char

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. This setting can be used to set an SSL anonymous connection ("aNULL" string value, for instance).

enableServerCertAuth: c_int

True/False option to enable verification of the server certificate

Trait Implementations

impl Debug for MQTTAsync_SSLOptions

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Copy for MQTTAsync_SSLOptions

impl Clone for MQTTAsync_SSLOptions

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for MQTTAsync_SSLOptions

fn default() -> MQTTAsync_SSLOptions

Returns the "default value" for a type.