Paho Asynchronous MQTT C Client Library
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Data Fields
MQTTAsync_SSLOptions Struct Reference

#include <MQTTAsync.h>

Data Fields

char struct_id [4]
 
int struct_version
 
const char * trustStore
 
const char * keyStore
 
const char * privateKey
 
const char * privateKeyPassword
 
const char * enabledCipherSuites
 
int enableServerCertAuth
 
int sslVersion
 
int verify
 
const char * CApath
 
int(* ssl_error_cb )(const char *str, size_t len, void *u)
 
void * ssl_error_context
 

Detailed Description

MQTTAsync_sslProperties defines the settings to establish an SSL/TLS connection using the OpenSSL library. It covers the following scenarios:

Field Documentation

char struct_id[4]

The eyecatcher for this structure. Must be MQTS

int struct_version

The version number of this structure. Must be 0, or 1 to enable TLS version selection.

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. It may also include the client's private key.

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

int enableServerCertAuth

True/False option to enable verification of the server certificate

int sslVersion

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.

int verify

Whether to carry out post-connect checks, including that a certificate matches the given host name. Exists only if struct_version >= 2

const char* CApath

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

int(* ssl_error_cb)(const char *str, size_t len, void *u)

Callback function for OpenSSL error handler ERR_print_errors_cb Exists only if struct_version >= 3

void* ssl_error_context

Application-specific contex for OpenSSL error handler ERR_print_errors_cb Exists only if struct_version >= 3


The documentation for this struct was generated from the following file: