Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for SSL/TLS #122

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add support for SSL/TLS #122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 74 additions & 7 deletions src/EspMQTTClient.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,47 +16,86 @@ EspMQTTClient::EspMQTTClient(
const char* mqttServerIp,
const uint16_t mqttServerPort,
const char* mqttClientName) :
EspMQTTClient(NULL, NULL, mqttServerIp, NULL, NULL, mqttClientName, mqttServerPort)
EspMQTTClient(NULL, NULL, mqttServerIp, NULL, NULL, NULL, NULL, NULL, mqttClientName, mqttServerPort, false)
{
}

/// Wifi + MQTT with no MQTT authentification
EspMQTTClient::EspMQTTClient(
const char* wifiSsid,
const char* wifiPassword,
const char* mqttServerIp,
const char* mqttClientName,
const uint16_t mqttServerPort) :
EspMQTTClient(wifiSsid, wifiPassword, mqttServerIp, NULL, NULL, NULL, NULL, NULL, mqttClientName, mqttServerPort, false)

{
}

/// Only MQTT handling (no wifi), with MQTT authentification
EspMQTTClient::EspMQTTClient(
const char* mqttServerIp,
const uint16_t mqttServerPort,
const char* mqttUsername,
const char* mqttPassword,
const char* mqttClientName) :
EspMQTTClient(NULL, NULL, mqttServerIp, mqttUsername, mqttPassword, mqttClientName, mqttServerPort)
EspMQTTClient(NULL, NULL, mqttServerIp, mqttUsername, mqttPassword, NULL, NULL, NULL, mqttClientName, mqttServerPort, false)
{
}

// Wifi and MQTT handling
/// Wifi + MQTT(S) (SSL unsecure) with MQTT authentification
EspMQTTClient::EspMQTTClient(
const char* wifiSsid,
const char* wifiPassword,
const char* mqttServerIp,
const char* mqttUsername,
const char* mqttPassword,
const char* mqttClientName,
const uint16_t mqttServerPort) :
EspMQTTClient(wifiSsid, wifiPassword, mqttServerIp, NULL, NULL, mqttClientName, mqttServerPort)
const uint16_t mqttServerPort,
bool mqttSecure) :
EspMQTTClient(NULL, NULL, mqttServerIp, mqttUsername, mqttPassword, NULL, NULL, NULL, mqttClientName, mqttServerPort, mqttSecure)
{
}

/// Wifi + MQTT(S) (SSL with CA certificate) with MQTT authentification
EspMQTTClient::EspMQTTClient(
const char* wifiSsid,
const char* wifiPassword,
const char* mqttServerIp,
const char* mqttUsername,
const char* mqttPassword,
const char* mqttRootCA,
const char* mqttClientName,
const uint16_t mqttServerPort) :
const uint16_t mqttServerPort,
bool mqttSecure) :
EspMQTTClient(NULL, NULL, mqttServerIp, mqttUsername, mqttPassword, mqttRootCA, NULL, NULL, mqttClientName, mqttServerPort, mqttSecure)
{
}

/// Wifi + MQTT(S) (with client certificate) with MQTT authentification
EspMQTTClient::EspMQTTClient(
const char* wifiSsid,
const char* wifiPassword,
const char* mqttServerIp,
const char* mqttUsername,
const char* mqttPassword,
const char* mqttRootCA,
const char* mqttClientCertificate,
const char* mqttClientKey,
const char* mqttClientName,
const uint16_t mqttServerPort,
bool mqttSecure) :
_wifiSsid(wifiSsid),
_wifiPassword(wifiPassword),
_mqttServerIp(mqttServerIp),
_mqttUsername(mqttUsername),
_mqttPassword(mqttPassword),
_mqttRootCA(mqttRootCA),
_mqttClientCertificate(mqttClientCertificate),
_mqttClientKey(mqttClientKey),
_mqttClientName(mqttClientName),
_mqttServerPort(mqttServerPort),
_mqttClient(mqttServerIp, mqttServerPort, _wifiClient)
_mqttSecure(mqttSecure)
{
// WiFi connection
_handleWiFi = (wifiSsid != NULL);
Expand All @@ -67,6 +106,34 @@ EspMQTTClient::EspMQTTClient(
_wifiReconnectionAttemptDelay = 60 * 1000;

// MQTT client
if(!_mqttSecure)
// MQTT unsecure
{
_mqttClient.setServer(_mqttServerIp, _mqttServerPort);
_mqttClient.setClient(_wifiClient);
}
else
// MQTT with SSL
{
if(_mqttRootCA != NULL)
{
_wifiClientSecure.setCACert(_mqttRootCA); // Set CA certificate to validate MQTT server

if(_mqttClientCertificate != NULL && _mqttClientKey != NULL)
{
_wifiClientSecure.setCertificate(_mqttClientCertificate); // Set MQTT client SSL certificate
_wifiClientSecure.setPrivateKey(_mqttClientKey); // Set MQTT client SSL key
}
}
else
{
_wifiClientSecure.setInsecure(); // Don't check CA certificate just use the SSL channel
}
_mqttClient.setServer(_mqttServerIp, _mqttServerPort);
_mqttClient.setClient(_wifiClientSecure);
}


_mqttConnected = false;
_nextMqttConnectionAttemptMillis = 0;
_mqttReconnectionAttemptDelay = 15 * 1000; // 15 seconds of waiting between each mqtt reconnection attempts by default
Expand Down
56 changes: 46 additions & 10 deletions src/EspMQTTClient.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
#ifdef ESP8266

#include <ESP8266WiFi.h>
#include <WiFiClientSecure.h>
#include <ESP8266WebServer.h>
#include <ESP8266mDNS.h>
#include <ESP8266HTTPUpdateServer.h>
Expand All @@ -19,7 +20,9 @@

#else // for ESP32


#include <WiFiClient.h>
#include <WiFiClientSecure.h>
#include <WebServer.h>
#include <ESPmDNS.h>
#include "ESP32HTTPUpdateServer.h"
Expand Down Expand Up @@ -48,7 +51,9 @@ class EspMQTTClient
unsigned int _wifiReconnectionAttemptDelay;
const char* _wifiSsid;
const char* _wifiPassword;

WiFiClient _wifiClient;
WiFiClientSecure _wifiClientSecure;

// MQTT related
bool _mqttConnected;
Expand All @@ -57,8 +62,12 @@ class EspMQTTClient
const char* _mqttServerIp;
const char* _mqttUsername;
const char* _mqttPassword;
const char* _mqttRootCA;
const char* _mqttClientCertificate;
const char *_mqttClientKey;
const char* _mqttClientName;
uint16_t _mqttServerPort;
bool _mqttSecure;
bool _mqttCleanSession;
char* _mqttLastWillTopic;
char* _mqttLastWillMessage;
Expand Down Expand Up @@ -109,16 +118,6 @@ class EspMQTTClient
const char* mqttClientName = DEFAULT_MQTT_CLIENT_NAME,
const uint16_t mqttServerPort = 1883);

/// Wifi + MQTT with MQTT authentification
EspMQTTClient(
const char* wifiSsid,
const char* wifiPassword,
const char* mqttServerIp,
const char* mqttUsername,
const char* mqttPassword,
const char* mqttClientName = DEFAULT_MQTT_CLIENT_NAME,
const uint16_t mqttServerPort = 1883);

/// Only MQTT handling (no wifi), with MQTT authentification
EspMQTTClient(
const char* mqttServerIp,
Expand All @@ -133,6 +132,43 @@ class EspMQTTClient
const uint16_t mqttServerPort,
const char* mqttClientName = DEFAULT_MQTT_CLIENT_NAME);

/// Wifi + MQTT(S) (SSL unsecure) with MQTT authentification
EspMQTTClient(
const char *wifiSsid,
const char *wifiPassword,
const char *mqttServerIp,
const char *mqttUsername,
const char *mqttPassword,
const char *mqttClientName,
const uint16_t mqttServerPort,
bool mqttSecure = false);

/// Wifi + MQTT(S) (SSL with CA certificate) with MQTT authentification
EspMQTTClient(
const char* wifiSsid,
const char* wifiPassword,
const char* mqttServerIp,
const char* mqttUsername,
const char* mqttPassword,
const char* mqttRootCA,
const char* mqttClientName = DEFAULT_MQTT_CLIENT_NAME,
const uint16_t mqttServerPort = 1883,
bool mqttSecure = false);

/// Wifi + MQTT(S) (with client certificate) with MQTT authentification
EspMQTTClient(
const char* wifiSsid,
const char* wifiPassword,
const char* mqttServerIp,
const char* mqttUsername,
const char* mqttPassword,
const char* mqttRootCA,
const char* mqttClientCertificate,
const char* mqttClientKey,
const char* mqttClientName = DEFAULT_MQTT_CLIENT_NAME,
const uint16_t mqttServerPort = 1883,
bool mqttSecure = false);

~EspMQTTClient();

// Optional functionality
Expand Down