Update

Updated to use ArduinoJson 6
Fixed bug where having debug mode without Serial configured would cause crash (to be tested more)
Settings now load properly (?)

Author: marecl

README.md

@@ -30,10 +30,6 @@ It's meant to be an universal, secure toolbox.
 * Cookie auth works best with Firefox
 * encryptKey takes values >=1 because of how key verification works
 * Using a function without configuring it (or loading settings) may cause crash
-* Requires ArduinoJson v5
 
 ### ToDo list
-1. Update to ArduinoJson v6
-2. Encrypt config file
-3. Change key structure to [id]=(...) to make cookie auth working on all browsers
-4. Rewrite token verification function to consume less memory
+For ToDo list check issues.

library.properties

@@ -1,5 +1,5 @@
 name=settingsManager
-version=1.0.1
+version=1.0.2
 author=Marek Ledworowski (marecl)
 maintainer=Marek Ledworowski (marecl)
 sentence=Simple settings management for ESP8266

src/settingsManager.cpp

@@ -10,6 +10,9 @@ settingsManager::settingsManager(const char* _f) {
   this->_pwd = new char[16];
   this->_ntp = new char[32];
   this->_file = new char[32];
+#ifdef DEBUG_INSECURE
+  this->_debug = NULL;
+#endif
   if (_f == NULL) memset(this->_file, 0, 32);
   else this->setField(this->_file, _f, 32);
   this->_dhcp = true;
@@ -18,12 +21,8 @@ settingsManager::settingsManager(const char* _f) {
   this->timezone = 0;
   this->readInterval = 5;
   this->tokenLifespan = 600;
-#ifdef DEBUG_INSECURE
-  this->_debug = NULL;
-#endif
 }
 
-
 settingsManager::~settingsManager() {
   delete[] _name;
   delete[] _ssid;
@@ -48,8 +47,7 @@ void settingsManager::ntpServer(const char* _ntp) {
 }
 
 void settingsManager::save() {
-  if (this->_file[0] == 0) return;
-  SPIFFS.remove(this->_file);
+  if (this->_file == NULL) return;
   fs::File _toSave = SPIFFS.open(this->_file, "w");
   _toSave.print(F("{\"SN\":\""));
   _toSave.print(this->_name);
@@ -140,37 +138,40 @@ bool settingsManager::load() {
   this->_print(F("Found file"));
 #endif
   fs::File _toSave = SPIFFS.open(this->_file, "r");
-  //Longest config i could create
-  StaticJsonBuffer<800> _ld;
-  JsonObject& _data = _ld.parseObject(_toSave);
-  _toSave.close();
-  if (!_data.success()) {
+  //(about the) Longest config i could create
+  StaticJsonDocument<800> _ld;
+
+  DeserializationError err = deserializeJson(_ld, _toSave);
+
+  if (err || !_toSave) {
 #ifdef DEBUG_INSECURE
     this->_print(F("Load error"));
 #endif
+    _toSave.close();
     return false;
   }
 
-  this->setField(this->_name, _data["SN"], 32);
-  this->setField(this->_user, _data["SL"], 16);
-  this->setField(this->_pwd, _data["SPL"], 16);
-  this->setField(this->_ssid, _data["OS"], 32);
-  this->setField(this->_pass, _data["OP"], 32);
-  this->setField(this->_ssidap, _data["SS"], 32);
-  this->setField(this->_passap, _data["SPA"], 32);
-  this->_ip = stringToIP(_data["OI"]);
-  this->_gw = stringToIP(_data["OG"]);
-  this->_mask = stringToIP(_data["OM"]);
-  this->_dhcp = _data["OD"].as<bool>();
-  this->useNTP = _data["UN"].as<bool>();
-  this->setField(this->_ntp, _data["NS"], 32);
-  this->lastUpdate = _data["LU"].as<uint32_t>();
-  this->timezone = _data["TZ"].as<int8_t>();
-  this->readInterval = _data["RI"].as<uint16_t>();
-  this->tokenLifespan = _data["TL"].as<uint16_t>();
+  this->setField(this->_name, _ld["SN"], 32);
+  this->setField(this->_user, _ld["SL"], 16);
+  this->setField(this->_pwd, _ld["SPL"], 16);
+  this->setField(this->_ssid, _ld["OS"], 32);
+  this->setField(this->_pass, _ld["OP"], 32);
+  this->setField(this->_ssidap, _ld["SS"], 32);
+  this->setField(this->_passap, _ld["SPA"], 32);
+  this->_ip = stringToIP(_ld["OI"]);
+  this->_gw = stringToIP(_ld["OG"]);
+  this->_mask = stringToIP(_ld["OM"]);
+  this->_dhcp = _ld["OD"];
+  this->useNTP = _ld["UN"];
+  this->setField(this->_ntp, _ld["NS"], 32);
+  this->lastUpdate = _ld["LU"];
+  this->timezone = _ld["TZ"];
+  this->readInterval = _ld["RI"];
+  this->tokenLifespan = _ld["TL"];
 #ifdef DEBUG_INSECURE
   this->_print(F("Loaded successfully"));
 #endif
+  _toSave.close();
   return true;
 }
 
@@ -224,9 +225,9 @@ void settingsManager::printConfig() {
   this->_debug->print(this->lastUpdate);
   this->_debug->print(F(",\"TZ\":"));
   this->_debug->print(this->timezone);
-  this->_debug->print(F("\",\"RI\":"));
+  this->_debug->print(F(",\"RI\":"));
   this->_debug->print(this->readInterval);
-  this->_debug->print(F("\",\"TL\":"));
+  this->_debug->print(F(",\"TL\":"));
   this->_debug->print(this->tokenLifespan);
   this->_debug->print(F("}\r\n"));
   return void();

src/settingsManager.h

@@ -23,28 +23,45 @@
 
 class settingsManager {
   public:
+    /* File name to store settings */
     settingsManager(const char* = NULL);
     ~settingsManager();
     void save();
     bool load();
+
+    /* SSID, password */
     void configSTA(const char*, const char* = NULL);
     void configAP(const char*, const char* = NULL);
+
+    /* SSID */
     void ssid(const char*);
     void ssidAP(const char*);
+
+    /* IP addresses */
     void configIP(IPAddress, IPAddress, IPAddress);
     void configIP(const char*, const char*, const char*);
     void useDHCP(bool);
     bool useDHCP();
     void name(const char*);
+    /* Username, password */
     void configUser(const char*, const char*);
     bool authenticate(const char*, const char*);
+
     bool beginSTA();
     bool beginAP();
+
+    /* Direct NTP address. Pools are not tested */
     void ntpServer(const char*);
+
+    /* Server, update service, path */
     void configUpdateServer(ESP8266WebServer*, ESP8266HTTPUpdateServer*, const char*);
+
     void beginOTA(uint16_t = 8266);
     bool webAuthenticate(ESP8266WebServer*);
+
+    /* Username, password, file to remove from SPIFFS */
     bool remove(const char*, const char*, const char*);
+
     IPAddress localIP();
     IPAddress gatewayIP();
     IPAddress subnetMask();
@@ -57,9 +74,17 @@ class settingsManager {
     uint32_t lastUpdate;
     int8_t timezone;
     uint16_t readInterval;
+
+    /* Decrypted key, canary */
     uint8_t verifyKey(String, uint32_t);
+
+    /* Encrypted key, canary */
     uint8_t verifyEncryptedKey(String, uint32_t);
+
+    /* Canary */
     String encryptKey(uint32_t);
+
+    /* Encrypted key */
     String decryptKey(String);
     uint32_t tokenLifespan;
 
@@ -88,6 +113,7 @@ class settingsManager {
     }
 
 #ifdef DEBUG_INSECURE
+    /* Pointer to Serial */
     void serialDebug(HardwareSerial*);
     void printConfigFile();
     void printConfig();