MQTTAsync_SSLOptions Struct Reference

MQTTAsync_sslProperties defines the settings to establish an SSL/TLS connection using the OpenSSL library. More...

#include <MQTTAsync.h>

Data Fields

char struct_id [4]
 The eyecatcher for this structure.
int struct_version
 The version number of this structure.
const char * trustStore
 The file in PEM format containing the public digital certificates trusted by the client.
const char * keyStore
 The file in PEM format containing the public certificate chain of the client.
const char * privateKey
 If not included in the sslKeyStore, this setting points to the file in PEM format containing the client's private key.
const char * privateKeyPassword
 The password to load the client's privateKey if encrypted.
const char * enabledCipherSuites
 The list of cipher suites that the client will present to the server during the SSL handshake.
int enableServerCertAuth
 True/False option to enable verification of the server certificate.
int sslVersion
 The SSL/TLS version to use.
int verify
 Whether to carry out post-connect checks, including that a certificate matches the given host name.
const char * CApath
 From the OpenSSL documentation: If CApath is not NULL, it points to a directory containing CA certificates in PEM format.

Detailed Description

MQTTAsync_sslProperties defines the settings to establish an SSL/TLS connection using the OpenSSL library.

It covers the following scenarios:


Field Documentation

From the OpenSSL documentation: If CApath is not NULL, it points to a directory containing CA certificates in PEM format.

Exists only if struct_version >= 2

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).

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

It may also include the client's private key.

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

The SSL/TLS version to use.

Specify one of MQTT_SSL_VERSION_DEFAULT (0), MQTT_SSL_VERSION_TLS_1_0 (1), MQTT_SSL_VERSION_TLS_1_1 (2) or MQTT_SSL_VERSION_TLS_1_2 (3). Only used if struct_version is >= 1.

The eyecatcher for this structure.

Must be MQTS

The version number of this structure.

Must be 0, or 1 to enable TLS version selection.

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

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

Exists only if struct_version >= 2


The documentation for this struct was generated from the following file:
 All Data Structures Files Functions Variables Typedefs Defines

Generated on 2 Jun 2018 for MQTT C Client Libraries Internals by  doxygen 1.6.1