Merge pull request #77 from thorrak/exp_multi_type_manifest

Allow multiple firmware types in a single JSON manifest

Author: chrisjoyce911

README.md

@@ -58,6 +58,24 @@ Version information can be either a single number or a semantic version string.
 }
 ```
 
+A single JSON file can provide information on multiple firmware types by combining them together into an array. When this is loaded, the firmware manifest with a type matching the one passed to the esp32FOTA constructor will be selected:
+
+```json
+[
+   {
+      "type":"esp32-fota-http",
+      "version":"0.0.2",
+      "url":"http://192.168.0.100/fota/esp32-fota-http-2.bin"
+   },
+   {
+      "type":"esp32-other-hardware",
+      "version":"0.0.3",
+      "url":"http://192.168.0.100/fota/esp32-other-hardware.bin"
+   }
+]
+```
+
+
 #### Firmware types
 
 Types are used to compare with the current loaded firmware, this is used to make sure that when loaded, the device will still do the intended job.

src/esp32fota.cpp

@@ -317,9 +317,63 @@ void esp32FOTA::execOTA()
     }
 }
 
+bool esp32FOTA::checkJSONManifest(JsonVariant JSONDocument) {
+
+    if(strcmp(JSONDocument["type"].as<const char *>(), _firmwareType.c_str()) != 0) {
+        log_i("Payload type in manifest %s doesn't match current firmware %s", JSONDocument["type"].as<const char *>(), _firmwareType.c_str() );
+        log_i("Doesn't match type: %s", _firmwareType.c_str() );
+        return false;  // Move to the next entry in the manifest
+    }
+    log_i("Payload type in manifest %s matches current firmware %s", JSONDocument["type"].as<const char *>(), _firmwareType.c_str() );
+
+    semver_free(&_payloadVersion);
+    if(JSONDocument["version"].is<uint16_t>()) {
+        log_i("JSON version: %d (int)", JSONDocument["version"].as<uint16_t>());
+        _payloadVersion = semver_t {JSONDocument["version"].as<uint16_t>()};
+    } else if (JSONDocument["version"].is<const char *>()) {
+        log_i("JSON version: %s (semver)", JSONDocument["version"].as<const char *>() );
+        if (semver_parse(JSONDocument["version"].as<const char *>(), &_payloadVersion)) {
+            log_e( "Invalid semver string received in manifest. Defaulting to 0" );
+            _payloadVersion = semver_t {0};
+        }
+    } else {
+        log_e( "Invalid semver format received in manifest. Defaulting to 0" );
+        _payloadVersion = semver_t {0};
+    }
+
+    char version_no[256] = {'\0'};
+    semver_render(&_payloadVersion, version_no);
+    log_i("Payload firmware version: %s", version_no );
+
+
+    if(JSONDocument["url"].is<String>()) {
+        // We were provided a complete URL in the JSON manifest - use it
+        _firmwareUrl = JSONDocument["url"].as<String>();
+        if(JSONDocument["host"].is<String>())  // If the manifest provides both, warn the user
+            log_w("Manifest provides both url and host - Using URL");
+    } else if (JSONDocument["host"].is<String>() && JSONDocument["port"].is<uint16_t>() && JSONDocument["bin"].is<String>()){
+        // We were provided host/port/bin format - Build the URL
+        if( JSONDocument["port"].as<uint16_t>() == 443 || JSONDocument["port"].as<uint16_t>() == 4433 )
+            _firmwareUrl = String( "https://");
+        else
+            _firmwareUrl = String( "http://" );
+
+        _firmwareUrl += JSONDocument["host"].as<String>() + ":" + String( JSONDocument["port"].as<uint16_t>() ) + JSONDocument["bin"].as<String>();
+
+    } else {
+        // JSON was malformed - no firmware target was provided
+        log_e("JSON manifest was missing both 'url' and 'host'/'port'/'bin' keys");
+        return false;
+    }
+
+    if (semver_compare(_payloadVersion, _firmwareVersion) == 1) {
+        return true;
+    }
+    return false;
+}
+
 bool esp32FOTA::execHTTPcheck()
 {
-
     String useURL;
 
     if (useDeviceID)
@@ -334,112 +388,78 @@ bool esp32FOTA::execHTTPcheck()
 
     log_i("Getting HTTP: %s",useURL.c_str());
     log_i("------");
-    if ((WiFi.status() == WL_CONNECTED)) {  //Check the current connection status
-
-        HTTPClient http;
-        WiFiClientSecure client;
-
-        if( useURL.substring( 0, 5 ) == "https" ) {
-            if (!_allow_insecure_https) {
-                // If the checkURL is https load the root-CA and connect with that
-                log_i( "Loading root_ca.pem" );
-                File root_ca_file = SPIFFS.open( "/root_ca.pem" );
-                if( !root_ca_file ) {
-                    log_e( "Could not open root_ca.pem" );
-                    return false;
-                }
-                {
-                    std::string root_ca = "";
-                    while( root_ca_file.available() ){
-                        root_ca.push_back( root_ca_file.read() );
-                    }
-                    root_ca_file.close();
-                    http.begin( useURL, root_ca.c_str() );
-                }
-            } else {
-                // We're downloading from a secure port, but we don't want to validate the root cert.
-                client.setInsecure();
-                http.begin(client, useURL);
-            }
-        } else {
-            http.begin(useURL);         //Specify the URL
-        }
-        int httpCode = http.GET();  //Make the request
-
-        if( httpCode == HTTP_CODE_OK || httpCode == HTTP_CODE_MOVED_PERMANENTLY ) {  //Check is a file was returned
-
-            String payload = http.getString();
-
-            int str_len = payload.length() + 1;
-            char JSONMessage[str_len];
-            payload.toCharArray(JSONMessage, str_len);
+    if ((WiFi.status() != WL_CONNECTED)) {  //Check the current connection status
+        log_w("WiFi not connected - skipping HTTP check");
+        return false;  // WiFi not connected
+    }
 
-            StaticJsonDocument<300> JSONDocument;  //Memory pool
-            DeserializationError err = deserializeJson(JSONDocument, JSONMessage);
+    HTTPClient http;
+    WiFiClientSecure client;
 
-            if (err) {  //Check for errors in parsing
-                log_e("Parsing failed");
-                http.end();
+    if( useURL.substring( 0, 5 ) == "https" ) {
+        if (!_allow_insecure_https) {
+            // If the checkURL is https load the root-CA and connect with that
+            log_i( "Loading root_ca.pem" );
+            File root_ca_file = SPIFFS.open( "/root_ca.pem" );
+            if( !root_ca_file ) {
+                log_e( "Could not open root_ca.pem" );
                 return false;
             }
-
-            const char *pltype = JSONDocument["type"];
-
-            semver_free(&_payloadVersion);
-            if(JSONDocument["version"].is<uint16_t>()) {
-                log_i("JSON version: %d (int)", JSONDocument["version"].as<uint16_t>());
-                _payloadVersion = semver_t {JSONDocument["version"].as<uint16_t>()};
-            } else if (JSONDocument["version"].is<const char *>()) {
-                log_i("JSON version: %s (semver)", JSONDocument["version"].as<const char *>() );
-                if (semver_parse(JSONDocument["version"].as<const char *>(), &_payloadVersion)) {
-                    log_e( "Invalid semver string received in manifest. Defaulting to 0" );
-                    _payloadVersion = semver_t {0};
+            {
+                std::string root_ca = "";
+                while( root_ca_file.available() ){
+                    root_ca.push_back( root_ca_file.read() );
                 }
-            } else {
-                log_e( "Invalid semver format received in manifest. Defaulting to 0" );
-                _payloadVersion = semver_t {0};
+                root_ca_file.close();
+                http.begin( useURL, root_ca.c_str() );
             }
+        } else {
+            // We're downloading from a secure port, but we don't want to validate the root cert.
+            client.setInsecure();
+            http.begin(client, useURL);
+        }
+    } else {
+        http.begin(useURL);         //Specify the URL
+    }
+    int httpCode = http.GET();  //Make the request
 
-            char version_no[256] = {'\0'};
-            semver_render(&_payloadVersion, version_no);
-            log_i("Payload firmware version: %s", version_no );
-
+    if( httpCode == HTTP_CODE_OK || httpCode == HTTP_CODE_MOVED_PERMANENTLY ) {  //Check is a file was returned
 
-            if(JSONDocument["url"].is<String>()) {
-                // We were provided a complete URL in the JSON manifest - use it
-                _firmwareUrl = JSONDocument["url"].as<String>();
-                if(JSONDocument["host"].is<String>())  // If the manifest provides both, warn the user
-                    log_w("Manifest provides both url and host - Using URL");
-            } else if (JSONDocument["host"].is<String>() && JSONDocument["port"].is<uint16_t>() && JSONDocument["bin"].is<String>()){
-                // We were provided host/port/bin format - Build the URL
-                if( JSONDocument["port"].as<uint16_t>() == 443 || JSONDocument["port"].as<uint16_t>() == 4433 )
-                    _firmwareUrl = String( "https://");
-                else
-                    _firmwareUrl = String( "http://" );
+        String payload = http.getString();
 
-                _firmwareUrl += JSONDocument["host"].as<String>() + ":" + String( JSONDocument["port"].as<uint16_t>() ) + JSONDocument["bin"].as<String>();
+        int str_len = payload.length() + 1;
+        char JSONMessage[str_len];
+        payload.toCharArray(JSONMessage, str_len);
 
-            } else {
-                // JSON was malformed - no firmware target was provided
-                log_e("JSON manifest was missing both 'url' and 'host'/'port'/'bin' keys");
-                http.end();
-                return false;
-            }
+        DynamicJsonDocument JSONResult(2048);
+        DeserializationError err = deserializeJson(JSONResult, JSONMessage);
 
+        http.end();  // We're done with HTTP - free the resources
 
-            String fwtype(pltype);
+        if (err) {  //Check for errors in parsing
+            log_e("Parsing failed");
+            return false;
+        }
 
-            if (semver_compare(_payloadVersion, _firmwareVersion) == 1 && fwtype == _firmwareType) {
-                http.end();
-                return true;
+        if (JSONResult.is<JsonArray>()) {
+            // We already received an array of multiple firmware types
+            JsonArray arr = JSONResult.as<JsonArray>();
+            for (JsonVariant JSONDocument : arr) {
+                if(checkJSONManifest(JSONDocument)) {
+                    return true;
+                }
             }
-        } else {
-            log_e("Error on HTTP request");
+        } else if (JSONResult.is<JsonObject>()) {
+            if(checkJSONManifest(JSONResult.as<JsonVariant>()))
+                return true;
         }
-        http.end();  //Free the resources
+
+        return false; // We didn't get a hit against the above, return false
+    } else {
+        log_e("Error on HTTP request");
+        http.end();
         return false;
     }
-    return false;
 }
 
 String esp32FOTA::getDeviceID()

src/esp32fota.h

@@ -19,6 +19,7 @@
 #define esp32fota_h
 
 #include <Arduino.h>
+#include <ArduinoJson.h>
 #include "semver/semver.h"
 
 class esp32FOTA
@@ -46,6 +47,7 @@ class esp32FOTA
   String _firmwareUrl;
   boolean _check_sig;
   boolean _allow_insecure_https;
+  bool checkJSONManifest(JsonVariant JSONDocument);
 
 };