(homieiot#648) enable psk tls if ESP32

-> If using ESP32 and ssl is enabled then the json config parameters
   need to be setup :
     * mqtt.psk : the pre shared key, up to 32 chars
     * mqtt.psk_identity : the pre shared key  identity, up to 32 chars
-> Don't publish stats nor invoke the user defined loop function if OTA
   is ongoing. This helps aliviate the TCP window going out of space.
-> Send out 1 every 100 of the 206 messages while doing OTA updates

Author: Nicolas Emiliani

src/Homie/Boot/BootNormal.cpp

@@ -77,12 +77,18 @@ void BootNormal::setup() {
 #if ASYNC_TCP_SSL_ENABLED
   Interface::get().getLogger() << "SSL is: " << Interface::get().getConfig().get().mqtt.server.ssl.enabled << endl;
   Interface::get().getMqttClient().setSecure(Interface::get().getConfig().get().mqtt.server.ssl.enabled);
-  if (Interface::get().getConfig().get().mqtt.server.ssl.enabled && Interface::get().getConfig().get().mqtt.server.ssl.hasFingerprint) {
+  if (Interface::get().getConfig().get().mqtt.server.ssl.enabled){ // && Interface::get().getConfig().get().mqtt.server.ssl.hasFingerprint) {
+#if defined(ESP8266)
     char hexBuf[MAX_FINGERPRINT_STRING_LENGTH];
     Helpers::byteArrayToHexString(Interface::get().getConfig().get().mqtt.server.ssl.fingerprint, hexBuf, MAX_FINGERPRINT_SIZE);
     Interface::get().getLogger() << "Using fingerprint: " << hexBuf << endl;
     Interface::get().getMqttClient().addServerFingerprint((const uint8_t*)Interface::get().getConfig().get().mqtt.server.ssl.fingerprint);
+#elif defined(ESP32)
+    Interface::get().getMqttClient().setPsk(
+      Interface::get().getConfig().get().mqtt.server.ssl.psk_ident,
+      Interface::get().getConfig().get().mqtt.server.ssl.psk);
   }
+#endif
 #endif
 
   Interface::get().getMqttClient().setMaxTopicLength(MAX_MQTT_TOPIC_LENGTH);
@@ -164,6 +170,7 @@ void BootNormal::loop() {
     return;
   }
 
+  if(_otaOngoing) return;
   // here, we have notified the sketch we are ready
 
   if (_mqttOfflineMessageId == 0 && Interface::get().flaggedForSleep) {
@@ -211,13 +218,20 @@ char* BootNormal::_prefixMqttTopic(PGM_P topic) {
 }
 
 bool BootNormal::_publishOtaStatus(int status, const char* info) {
+  static uint8_t count = 0;
+  ++count;
+
   String payload(status);
   if (info) {
     payload.concat(F(" "));
     payload.concat(info);
   }
-
-  return Interface::get().getMqttClient().publish(_prefixMqttTopic(PSTR("/$implementation/ota/status")), 0, true, payload.c_str()) != 0;
+  if(count == 100){
+    count = 0;
+    return Interface::get().getMqttClient().publish(
+              _prefixMqttTopic(PSTR("/$implementation/ota/status")), 0, true, payload.c_str()) != 0;
+  }
+  return false;
 }
 
 void BootNormal::_endOtaUpdate(bool success, uint8_t update_error) {
@@ -779,6 +793,13 @@ void BootNormal::_onMqttDisconnected(AsyncMqttClientDisconnectReason reason) {
 }
 
 void BootNormal::_onMqttMessage(char* topic, char* payload, AsyncMqttClientMessageProperties properties, size_t len, size_t index, size_t total) {
+  /*
+  Interface::get().getLogger() << F("BootNormal::_onMqttMessage") << endl;
+  Interface::get().getLogger() << "topic > " << topic << endl;
+  Interface::get().getLogger() << "len > " << len << endl;
+  Interface::get().getLogger() << "index > " << index << endl;
+  Interface::get().getLogger() << "total > " << total << endl;
+  */
   if (total == 0) return;  // no empty message possible
 
   if (index == 0) {
@@ -875,6 +896,13 @@ bool HomieInternals::BootNormal::__fillPayloadBuffer(char * topic, char * payloa
 }
 
 bool HomieInternals::BootNormal::__handleOTAUpdates(char* topic, char* payload, const AsyncMqttClientMessageProperties& properties, size_t len, size_t index, size_t total) {
+  /*
+  Interface::get().getLogger() << F("HomieInternals::BootNormal::__handleOTAUpdates...") << endl;
+  Interface::get().getLogger() << "0 > " << _mqttTopicLevels.get()[0] << endl;
+  Interface::get().getLogger() << "1 > " << _mqttTopicLevels.get()[1] << endl;
+  Interface::get().getLogger() << "2 > " << _mqttTopicLevels.get()[2] << endl;
+  Interface::get().getLogger() << "3 > " << _mqttTopicLevels.get()[3] << endl;
+  */
   if (
     _mqttTopicLevelsCount == 5
     && strcmp(_mqttTopicLevels.get()[0], Interface::get().getConfig().get().deviceId) == 0
@@ -1047,6 +1075,7 @@ bool HomieInternals::BootNormal::__handleOTAUpdates(char* topic, char* payload,
     }
     return true;
   }
+  Interface::get().getLogger() << F("HomieInternals::BootNormal::__handleOTAUpdates FALSE") << endl;
   return false;
 }
 

src/Homie/Config.cpp

@@ -90,6 +90,8 @@ bool Config::load() {
   const char* reqMqttUsername = reqMqtt["username"] | "";
   const char* reqMqttPassword = reqMqtt["password"] | "";
   const char* reqMqttFingerprint = reqMqtt["ssl_fingerprint"] | "";
+  const char* reqMqttPsk = reqMqtt["psk"] | "";
+  const char* reqMqttPskIdent = reqMqtt["psk_identity"] | "";
   const char* reqMqttBaseTopic = reqMqtt["base_topic"] | DEFAULT_MQTT_BASE_TOPIC;
 
   strlcpy(_configStruct.name, reqName, MAX_FRIENDLY_NAME_LENGTH);
@@ -107,10 +109,15 @@ bool Config::load() {
   strlcpy(_configStruct.mqtt.server.host, reqMqttHost, MAX_HOSTNAME_LENGTH);
 #if ASYNC_TCP_SSL_ENABLED
   _configStruct.mqtt.server.ssl.enabled = reqMqttSsl;
+#if ESP8266
   if (strcmp_P(reqMqttFingerprint, PSTR("")) != 0) {
     _configStruct.mqtt.server.ssl.hasFingerprint = true;
     Helpers::hexStringToByteArray(reqMqttFingerprint, _configStruct.mqtt.server.ssl.fingerprint, MAX_FINGERPRINT_SIZE);
   }
+#elif defined(ESP32)
+  strlcpy(_configStruct.mqtt.server.ssl.psk, reqMqttPsk, MAX_PSK_STRING_LENGTH);
+  strlcpy(_configStruct.mqtt.server.ssl.psk_ident, reqMqttPskIdent, MAX_PSK_STRING_LENGTH);
+#endif
 #endif
   _configStruct.mqtt.server.port = reqMqttPort;
   strlcpy(_configStruct.mqtt.baseTopic, reqMqttBaseTopic, MAX_MQTT_BASE_TOPIC_LENGTH);
@@ -305,11 +312,18 @@ void Config::log() const {
   Interface::get().getLogger() << F("    ◦ Port: ") << _configStruct.mqtt.server.port << endl;
 #if ASYNC_TCP_SSL_ENABLED
   Interface::get().getLogger() << F("    ◦ SSL enabled: ") << (_configStruct.mqtt.server.ssl.enabled ? "true" : "false") << endl;
+#if ESP8266
   if (_configStruct.mqtt.server.ssl.enabled && _configStruct.mqtt.server.ssl.hasFingerprint) {
     char hexBuf[MAX_FINGERPRINT_STRING_LENGTH];
     Helpers::byteArrayToHexString(Interface::get().getConfig().get().mqtt.server.ssl.fingerprint, hexBuf, MAX_FINGERPRINT_SIZE);
     Interface::get().getLogger() << F("    ◦ Fingerprint: ") << hexBuf << endl;
   }
+#elif defined(ESP32)
+  if (_configStruct.mqtt.server.ssl.enabled) {
+    Interface::get().getLogger() << F("    ◦ PSK identity not shown") << endl;
+    Interface::get().getLogger() << F("    ◦ PSK not shown") << endl;
+  }
+#endif
 #endif
   Interface::get().getLogger() << F("    ◦ Base topic: ") << _configStruct.mqtt.baseTopic << endl;
   Interface::get().getLogger() << F("    ◦ Auth? ") << (_configStruct.mqtt.auth ? F("yes") : F("no")) << endl;

src/Homie/Datatypes/ConfigStruct.hpp

@@ -28,9 +28,14 @@ struct ConfigStruct {
 #if ASYNC_TCP_SSL_ENABLED
       struct {
         bool enabled;
+#if ESP8266
         bool hasFingerprint;
         uint8_t fingerprint[MAX_FINGERPRINT_SIZE];
+#elif ESP32
+        char psk_ident[MAX_PSK_STRING_LENGTH];
+        char psk[MAX_PSK_STRING_LENGTH];
       } ssl;
+#endif
 #endif
     } server;
     char baseTopic[MAX_MQTT_BASE_TOPIC_LENGTH];
@@ -44,3 +49,4 @@ struct ConfigStruct {
   } ota;
 };
 }  // namespace HomieInternals
+

src/Homie/Limits.hpp

@@ -36,4 +36,6 @@ namespace HomieInternals {
 
   const uint8_t MAX_IP_STRING_LENGTH = 16 + 1;
 
+  const uint8_t MAX_PSK_STRING_LENGTH = 64 + 1;
+
 }  // namespace HomieInternals