v1.9

Author: s60sc

appGlobals.h

@@ -22,12 +22,13 @@
 #define DEBUG_MEM false // leave as false
 #define FLUSH_DELAY 0 // for debugging crashes
 #define DBG_ON false // esp debug output
+#define DBG_LVL ESP_LOG_ERROR // level if DBG_ON true: ESP_LOG_ERROR, ESP_LOG_WARN, ESP_LOG_INFO, ESP_LOG_DEBUG, ESP_LOG_VERBOSE
 #define DOT_MAX 50
 #define HOSTNAME_GRP 0
 #define USE_IP6 false
 
 #define APP_NAME "VoiceChanger" // max 15 chars
-#define APP_VER "1.8"
+#define APP_VER "1.9"
 
 #define HTTP_CLIENTS 2 // http, ws
 #define MAX_STREAMS 0
@@ -55,7 +56,7 @@
 #define ISVC // VC specific code in generics
 
 // to determine if newer data files need to be loaded
-#define CFG_VER 5
+#define CFG_VER 6
 
 #ifdef CONFIG_IDF_TARGET_ESP32S3 
 #define SERVER_STACK_SIZE (1024 * 8)

globals.h

@@ -151,6 +151,7 @@ void initStatus(int cfgGroup, int delayVal);
 void killSocket(int skt = -99);
 void listBuff(const uint8_t* b, size_t len); 
 bool listDir(const char* fname, char* jsonBuff, size_t jsonBuffLen, const char* extension);
+void loadCerts();
 bool loadConfig();
 void logLine();
 void logPrint(const char *fmtStr, ...);
@@ -254,6 +255,7 @@ extern bool wsLog;
 extern uint16_t sustainId;
 extern bool heartBeatDone;
 extern TaskHandle_t heartBeatHandle;
+extern char portFwd[];
 
 // remote file server
 extern char fsServer[];
@@ -300,8 +302,7 @@ extern const char* smtp_rootCACertificate;
 extern const char* mqtt_rootCACertificate;
 extern const char* telegram_rootCACertificate;
 extern const char* hfs_rootCACertificate;
-extern const char* prvtkey_pem; // app https server private key
-extern const char* cacert_pem; // app https server public certificate
+extern char* serverCerts[];
 
 // app status
 extern char timezone[];

prefs.cpp

@@ -378,7 +378,10 @@ void updateStatus(const char* variable, const char* _value, bool fromUser) {
   } else {
     res = updateAppStatus(variable, value, fromUser);
     if (!res) {
-      if (fromUser) LOG_WRN("Unable to config %s as required cpp file not included", variable);
+      if (fromUser) {
+        updateConfigVect(variable, value); // in case value previously set in different compilation state
+        LOG_WRN("Unable to use %s as required cpp file not included", variable);
+      }
       else LOG_VRB("Unrecognised config: %s", variable);
     }
   }
@@ -536,6 +539,14 @@ bool loadConfig() {
     loadPrefs(); // overwrites any corresponding entries in config
     // load variables from stored config vector
     reloadConfigs();
+#if INCLUDE_CERTS
+    loadCerts();
+#else
+  if (useHttps) {
+    LOG_WRN("Need to compile with INCLUDE_CERTS true to use HTTPS");
+    useHttps = false;
+  }
+#endif
     debugMemory("loadConfig");
     return true;
   }

utils.cpp

@@ -26,6 +26,7 @@ static void initBrownout(void);
 int wakePin; // if wakeUse is true
 bool wakeUse = false; // true to allow app to sleep and wake
 char* jsonBuff = NULL;
+char portFwd[6] = "";
 
 /************************** Wifi **************************/
 
@@ -72,11 +73,10 @@ static void setupMdnsHost() {
   snprintf(mdnsName, MAX_IP_LEN, "%.*s", MAX_IP_LEN - 1, hostName);
   if (MDNS.begin(mdnsName)) {
     // Add service to MDNS
-    MDNS.addService("http", "tcp", HTTP_PORT);
-    MDNS.addService("https", "tcp", HTTPS_PORT);
-    //MDNS.addService("ws", "udp", 83);
-    //MDNS.addService("ftp", "tcp", 21);    
-    LOG_INF("mDNS service: http://%s.local", mdnsName);
+    useHttps ? MDNS.addService("https", "tcp", HTTPS_PORT) : MDNS.addService("http", "tcp", HTTP_PORT);
+    MDNS.addService("ws", "udp", 83);
+    MDNS.addService("ftp", "tcp", 21);    
+    LOG_INF("mDNS service: http%s://%s.local", useHttps ? "s" : "", mdnsName);
   } else LOG_WRN("mDNS host: %s Failed", mdnsName);
   debugMemory("setupMdnsHost");
 }
@@ -118,7 +118,7 @@ static void onWiFiEvent(WiFiEvent_t event) {
     case ARDUINO_EVENT_WIFI_STA_STOP: LOG_INF("Wifi Station stopped %s", ST_SSID); break;
     case ARDUINO_EVENT_WIFI_AP_START: {
       if (strlen(AP_SSID) && !strcmp(WiFi.softAPSSID().c_str(), AP_SSID)) {
-        LOG_INF("Wifi AP SSID: %s started, use '%s://%s' to connect", WiFi.softAPSSID().c_str(), useHttps ? "https" : "http", WiFi.softAPIP().toString().c_str());
+        LOG_INF("Wifi AP SSID: %s started, use 'http%s://%s' to connect", WiFi.softAPSSID().c_str(), useHttps ? "s" : "", WiFi.softAPIP().toString().c_str());
         APstarted = true;
       }
       break;
@@ -866,13 +866,23 @@ void logLine() {
   logPrint(" \n");
 }
 
+int vprintfRedirect(const char* format, va_list args) {
+  // format esp_log() output for logPrint()
+  char buffer[256];
+  int len = vsnprintf(buffer, sizeof(buffer), format, args);
+  logPrint("%s", buffer);
+  return len;
+}
+
 void logSetup() {
   // prep logging environment
   Serial.begin(115200);
   Serial.setDebugOutput(DBG_ON);
   printf("\n\n");
   if (DEBUG_MEM) printf("init > Free: heap %lu\n", ESP.getFreeHeap()); 
-  if (!DBG_ON) esp_log_level_set("*", ESP_LOG_NONE); // suppress ESP_LOG_ERROR messages
+  if (DBG_ON) esp_log_level_set("*", DBG_LVL);
+  else esp_log_level_set("*", ESP_LOG_NONE); // suppress esp log messages
+  esp_log_set_vprintf(vprintfRedirect); // redirect esp_log output to app log
   if (crashLoop == MAGIC_NUM) snprintf(startupFailure, SF_LEN, STARTUP_FAIL "Crash loop detected, check log %s", (brownoutStatus == 'B' || brownoutStatus == 'R') ? "(brownout)" : " ");
   crashLoop = MAGIC_NUM;
   logSemaphore = xSemaphoreCreateBinary(); // flag that log message formatted
@@ -903,6 +913,7 @@ void formatHex(const char* inData, size_t inLen) {
 
 const char* espErrMsg(esp_err_t errCode) {
   // convert esp error code to text
+  // https://github.com/espressif/esp-idf/blob/master/components/esp_common/include/esp_err.h
   static char errText[100];
   esp_err_to_name_r(errCode, errText, 100);
   return errText;

utilsFS.cpp

@@ -78,11 +78,7 @@ static bool prepSD_MMC() {
   if (res) {
     fp.mkdir(DATA_DIR);
     infoSD();
-    res = true;
-  } else {
-    LOG_WRN("SD card mount failed");
-    res = false;
-  }
+  } else LOG_WRN("SD card mount failed");
 #endif
   return res;
 }

webServer.cpp

@@ -12,7 +12,7 @@ static char value[FILE_NAME_LEN];
 static char retainAction[2];
 int refreshVal = 5000; // msecs
 
-static httpd_handle_t httpServer = NULL; // web server port 
+static httpd_handle_t httpServer = NULL; // web server port
 static int fdWs = -1; // websocket sockfd
 bool useHttps = false;
 bool useSecure = false;
@@ -501,74 +501,66 @@ static esp_err_t customOrNotFoundHandler(httpd_req_t *req, httpd_err_code_t err)
 
 void startWebServer() {
   esp_err_t res = ESP_FAIL;
-  chunk = psramFound() ? (byte*)ps_malloc(CHUNKSIZE) : (byte*)malloc(CHUNKSIZE); 
+  chunk = psramFound() ? (byte*)ps_malloc(CHUNKSIZE) : (byte*)malloc(CHUNKSIZE);
 #if INCLUDE_CERTS
-  size_t prvtkey_len = strlen(prvtkey_pem);
-  size_t cacert_len = strlen(cacert_pem);
-  if (useHttps && (!cacert_len || !prvtkey_len)) {
-    useHttps = false;
-    LOG_ALT("HTTPS not available as server keys not defined, using HTTP");
-  }
   if (useHttps) {
     // HTTPS server
     httpd_ssl_config_t config = HTTPD_SSL_CONFIG_DEFAULT();
 #if CONFIG_IDF_TARGET_ESP32S3
     config.httpd.stack_size = SERVER_STACK_SIZE;
 #endif  
-    config.cacert_pem = (const uint8_t*)cacert_pem;
-    config.cacert_len = cacert_len + 1;
-    config.prvtkey_pem = (const uint8_t*)prvtkey_pem;
-    config.prvtkey_len = prvtkey_len + 1;
+    config.prvtkey_pem = (const uint8_t*)serverCerts[0];
+    config.prvtkey_len = strlen(serverCerts[0]) + 1;
+    config.servercert = (const uint8_t*)serverCerts[1];
+    config.servercert_len = strlen(serverCerts[1]) + 1;
+  
     //config.user_cb = https_server_user_callback;
     config.httpd.server_port = HTTPS_PORT;
-    config.httpd.ctrl_port = HTTPS_PORT;
     config.httpd.lru_purge_enable = true; // close least used socket 
     config.httpd.max_uri_handlers = MAX_HANDLERS;
     config.httpd.max_open_sockets = HTTP_CLIENTS + MAX_STREAMS;
     config.httpd.task_priority = HTTP_PRI;
     //config.httpd.uri_match_fn = httpd_uri_match_wildcard;
     res = httpd_ssl_start(&httpServer, &config);
   } else {
+#else
+  if (!useHttps) {
 #endif
     // HTTP server
     httpd_config_t config = HTTPD_DEFAULT_CONFIG();
 #if CONFIG_IDF_TARGET_ESP32S3
     config.stack_size = SERVER_STACK_SIZE;
-#endif  
+#endif
     config.server_port = HTTP_PORT;
-    config.ctrl_port = HTTP_PORT;
-    config.lru_purge_enable = true;   
+    config.lru_purge_enable = true;
     config.max_uri_handlers = MAX_HANDLERS;
     config.max_open_sockets = HTTP_CLIENTS + MAX_STREAMS;
     config.task_priority = HTTP_PRI;
     //config.uri_match_fn = httpd_uri_match_wildcard;
     res = httpd_start(&httpServer, &config);
-#if INCLUDE_CERTS
   }
-#endif
-
   httpd_uri_t indexUri = {.uri = "/", .method = HTTP_GET, .handler = indexHandler, .user_ctx = NULL};
   httpd_uri_t webUri = {.uri = "/web", .method = HTTP_GET, .handler = webHandler, .user_ctx = NULL};
   httpd_uri_t controlUri = {.uri = "/control", .method = HTTP_GET, .handler = controlHandler, .user_ctx = NULL};
   httpd_uri_t updateUri = {.uri = "/update", .method = HTTP_POST, .handler = updateHandler, .user_ctx = NULL};
   httpd_uri_t statusUri = {.uri = "/status", .method = HTTP_GET, .handler = statusHandler, .user_ctx = NULL};
-  httpd_uri_t wsUri = {.uri = "/ws", .method = HTTP_GET, .handler = wsHandler, .user_ctx = NULL, .is_websocket = true};
   httpd_uri_t uploadUri = {.uri = "/upload", .method = HTTP_POST, .handler = uploadHandler, .user_ctx = NULL};
+  httpd_uri_t wifiUri = {.uri = "/wifi", .method = HTTP_GET, .handler = setupHandler, .user_ctx = NULL};
+  httpd_uri_t wsUri = {.uri = "/ws", .method = HTTP_GET, .handler = wsHandler, .user_ctx = NULL, .is_websocket = true};
   httpd_uri_t sustainUri = {.uri = "/sustain", .method = HTTP_GET, .handler = appSpecificSustainHandler, .user_ctx = NULL};
   httpd_uri_t checkUri = {.uri = "/sustain", .method = HTTP_HEAD, .handler = appSpecificSustainHandler, .user_ctx = NULL};
-  httpd_uri_t wifiUri = {.uri = "/wifi", .method = HTTP_GET, .handler = setupHandler, .user_ctx = NULL};
 
   if (res == ESP_OK) {
     httpd_register_uri_handler(httpServer, &indexUri);
     httpd_register_uri_handler(httpServer, &webUri);
     httpd_register_uri_handler(httpServer, &controlUri);
     httpd_register_uri_handler(httpServer, &updateUri);
     httpd_register_uri_handler(httpServer, &statusUri);
-    httpd_register_uri_handler(httpServer, &wsUri);
     httpd_register_uri_handler(httpServer, &uploadUri);
+    httpd_register_uri_handler(httpServer, &wifiUri);
+    httpd_register_uri_handler(httpServer, &wsUri);
     httpd_register_uri_handler(httpServer, &sustainUri);
     httpd_register_uri_handler(httpServer, &checkUri);
-    httpd_register_uri_handler(httpServer, &wifiUri);
     httpd_register_err_handler(httpServer, HTTPD_404_NOT_FOUND, customOrNotFoundHandler);
 
     LOG_INF("Starting web server on port: %u", useHttps ? HTTPS_PORT : HTTP_PORT);