Paho MQTT C Client Library
 All Data Structures Files Functions Variables Typedefs Macros Pages
Data Fields
MQTTClient_SSLOptions Struct Reference

#include <MQTTClient.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
 

Detailed Description

MQTTClient_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

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


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