diff --git a/CHANGELOG.md b/CHANGELOG.md index fbbee11..327b741 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,9 @@ # Changelog +## 3.0.1 + +- Redact WiFi, AP, portal-form, and custom-parameter values from diagnostic logs. + ## 3.0.0 - Establish `device-framework` as the independently maintained canonical branch. diff --git a/lib/WiFiManager/src/WiFiManager.cpp b/lib/WiFiManager/src/WiFiManager.cpp index 294fe8a..8543930 100644 --- a/lib/WiFiManager/src/WiFiManager.cpp +++ b/lib/WiFiManager/src/WiFiManager.cpp @@ -986,7 +986,7 @@ bool WiFiManager::wifiConnectNew(String ssid, String pass,bool connect){ bool ret = false; #ifndef WM_NO_LOG log(WiFiManagerLogLevel::Info, kWiFiMgrLogSubsystem, F("Connecting to NEW AP:"),ssid); - log(WiFiManagerLogLevel::Trace, kWiFiMgrLogSubsystem,F("Using Password:"),pass); + log(WiFiManagerLogLevel::Trace, kWiFiMgrLogSubsystem, F("WiFi password supplied: [redacted]")); #endif WiFi_enableSTA(true,storeSTAmode); // storeSTAmode will also toggle STA on in default opmode (persistent) if true (default) WiFi.persistent(true); @@ -1007,7 +1007,7 @@ bool WiFiManager::wifiConnectDefault(){ #ifndef WM_NO_LOG log(WiFiManagerLogLevel::Info, kWiFiMgrLogSubsystem, F("Connecting to SAVED AP:"),WiFi_SSID(true)); - log(WiFiManagerLogLevel::Trace, kWiFiMgrLogSubsystem,F("Using Password:"),WiFi_psk(true)); + log(WiFiManagerLogLevel::Trace, kWiFiMgrLogSubsystem, F("Using saved WiFi credentials")); #endif ret = WiFi_enableSTA(true,storeSTAmode); @@ -2443,7 +2443,7 @@ void WiFiManager::debugSoftAPConfig(){ log(WiFiManagerLogLevel::Info, kWiFiMgrLogSubsystem, F("SoftAP Configuration")); log(WiFiManagerLogLevel::Info, kWiFiMgrLogSubsystem, F("--------------------")); log(WiFiManagerLogLevel::Info, kWiFiMgrLogSubsystem, F("ssid: "),(char *) config.ssid); - log(WiFiManagerLogLevel::Info, kWiFiMgrLogSubsystem, F("password: "),(char *) config.password); + log(WiFiManagerLogLevel::Info, kWiFiMgrLogSubsystem, F("password: [redacted]")); log(WiFiManagerLogLevel::Info, kWiFiMgrLogSubsystem, F("ssid_len: "),config.ssid_len); log(WiFiManagerLogLevel::Info, kWiFiMgrLogSubsystem, F("channel: "),config.channel); log(WiFiManagerLogLevel::Info, kWiFiMgrLogSubsystem, F("authmode: "),config.authmode); @@ -2518,7 +2518,7 @@ boolean WiFiManager::validApPassword(){ } #ifndef WM_NO_LOG log(WiFiManagerLogLevel::Debug, kWiFiMgrLogSubsystem,F("AccessPoint set password is VALID")); - log(WiFiManagerLogLevel::Trace, kWiFiMgrLogSubsystem,"ap pass",_apPassword); + log(WiFiManagerLogLevel::Trace, kWiFiMgrLogSubsystem, F("Access point password: [redacted]")); #endif } return true; diff --git a/lib/WiFiManager/src/WiFiManagerHandlers.cpp b/lib/WiFiManager/src/WiFiManagerHandlers.cpp index 8488ac4..0a483c3 100644 --- a/lib/WiFiManager/src/WiFiManagerHandlers.cpp +++ b/lib/WiFiManager/src/WiFiManagerHandlers.cpp @@ -739,7 +739,7 @@ void WiFiManagerHandlers::applyWifiAndParamsFromRequest(AsyncWebServerRequest *r requestinfo += "\n"; for (size_t i = 0; i < request->params(); i++) { const AsyncWebParameter* p = request->getParam(i); - requestinfo += " " + p->name() + ": " + p->value() + "\n"; + requestinfo += " " + p->name() + ": [redacted, " + String(p->value().length()) + " chars]\n"; } _wm->log(WiFiManagerLogLevel::Trace, kWiFiMgrLogSubsystem, requestinfo); @@ -823,7 +823,8 @@ void WiFiManagerHandlers::doParamSave(WiFiManager::WiFiManagerRequestArgs reques _wm->_params[i]->setValue(value.c_str(), value.length()); #ifndef WM_NO_LOG - _wm->log(WiFiManagerLogLevel::Debug, kWiFiMgrLogSubsystem,(String)_wm->_params[i]->getID() + ":",value); + _wm->log(WiFiManagerLogLevel::Debug, kWiFiMgrLogSubsystem, + (String)_wm->_params[i]->getID() + F(": [redacted, ") + String(value.length()) + F(" chars]")); #endif } #ifndef WM_NO_LOG diff --git a/library.json b/library.json index 561c943..894cc53 100644 --- a/library.json +++ b/library.json @@ -1,6 +1,6 @@ { "name": "WiFiManager", - "version": "3.0.0", + "version": "3.0.1", "keywords": [ "wifi", "wi-fi",