aaribaud/ESPSomfy-RTS
0
0
Fork 0
mirror of https://github.com/rstrouse/ESPSomfy-RTS.git synced 2026-10-31 13:52:15 +01:00
Code Issues Projects Releases Packages Wiki Activity

fix: stop sending stored passwords and PIN back to clients

Browse source 
The settings routes returned the WiFi passphrase, MQTT password and the
login password and PIN in plain text, and the debug log printed them and
the API key. Responses now carry hasPassphrase/hasPassword/hasPin flags,
logs mask the values, and an omitted secret keeps the stored one.

The UI loads secret fields empty and treats a blank field as "keep" while
the SSID or username is unchanged. Clearing a secret without changing the
SSID or username is listed in docs/KNOWN_ISSUES.md.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
cjkas 2026-10-18 14:34:18 +02:00
parent e963a5adb3
commit 1fb4c4cfcd
8 changed files with 189 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

8
data-src/index.html
View file

@ -207,11 +207,11 @@
<label for="fldUsername">Username</label>
</div>
<div class="field-group">
<input id="fldPassword" name="password" type="password" data-bind="security.password" length=32 placeholder="Password">
<input id="fldPassword" name="password" type="password" autocomplete="new-password" data-bind="security.password" length=32 placeholder="Password">
<label for="fldPassword">Password</label>
</div>
<div class="field-group">
<input id="fldReenterPassword" name="password" type="password" data-bind="security.repeatpassword" length=32 placeholder="Re-enter Password">
<input id="fldReenterPassword" name="password" type="password" autocomplete="new-password" data-bind="security.repeatpassword" length=32 placeholder="Re-enter Password">
<label for="fldRenterPassword">Re-enter Password</label>
</div>
</div>
@ -305,7 +305,7 @@
<label for="fldSsid">Network SSID</label>
</div>
<div class="field-group">
<input id="fldPassphrase" name="passphrase" type="password" data-bind="wifi.passphrase" length=32 placeholder="Passphrase">
<input id="fldPassphrase" name="passphrase" type="password" autocomplete="new-password" data-bind="wifi.passphrase" length=32 placeholder="Passphrase">
<label for="fldPassphrase">Passphrase</label>
</div>
@ -412,7 +412,7 @@
<label for="fldMqttUsername">Username</label>
</div>
<div class="field-group">
<input id="fldMqttPassword" name="mqtt-password" type="text" length=64 data-bind="mqtt.password" placeholder="Password">
<input id="fldMqttPassword" name="mqtt-password" type="password" autocomplete="new-password" length=64 data-bind="mqtt.password" placeholder="Password">
<label for="fldMqttPassword">Password</label>
</div>
<div class="field-group">

51
data-src/index.js
View file

@ -1236,7 +1236,7 @@ class UIBinder {
divCfg.style.display = 'none';
document.getElementById('icoConfig').className = 'icss-gear';
if (sockIsOpen) socket.send('leave:0');
general.setSecurityConfig({ type: 0, username: '', password: '', pin: '', permissions: 0 });
general.setSecurityConfig({ type: 0, username: '', permissions: 0 });
}
toggleConfig() {
if (this.isConfigOpen())
@ -1617,20 +1617,22 @@ class General {
}
}
setSecurityConfig(security) {
// The device never returns the stored password or PIN, only whether one is set.
this.savedSecurity = { type: security.type, username: security.username, hasPassword: makeBool(security.hasPassword), hasPin: makeBool(security.hasPin) };
// We need to transform the security object so that it can be set to the configuration.
let obj = {
security: {
type: security.type, username: security.username, password: security.password,
type: security.type, username: security.username, password: '', repeatpassword: '',
permissions: { configOnly: makeBool(security.permissions & 0x01) },
pin: {
d0: security.pin[0],
d1: security.pin[1],
d2: security.pin[2],
d3: security.pin[3]
}
pin: { d0: '', d1: '', d2: '', d3: '' }
}
};
ui.toElement(document.getElementById('divSecurityOptions'), obj);
let pnl = document.getElementById('divSecurityOptions');
ui.toElement(pnl, obj);
let keepHint = 'Saved (leave blank to keep)';
pnl.querySelector('#fldPassword').placeholder = this.savedSecurity.hasPassword ? keepHint : 'Password';
pnl.querySelector('#fldReenterPassword').placeholder = this.savedSecurity.hasPassword ? keepHint : 'Re-enter Password';
pnl.querySelector('label[for="fldPinEntry"]').innerHTML = this.savedSecurity.hasPin ? 'Enter Pin (leave blank to keep)' : 'Enter Pin';
this.onSecurityTypeChanged();
}
rebootDevice() {
@ -1674,9 +1676,17 @@ class General {
sec.pin += security.pin[`d${i}`];
}
sec.permissions |= security.permissions.configOnly ? 0x01 : 0x00;
// Blank secret fields keep the stored value while the type (and username) stay the same.
let saved = this.savedSecurity || {};
let keepPin = security.type === 1 && sec.pin === '' && saved.hasPin && saved.type === 1;
let keepPassword = security.type === 2 && sec.password === '' && security.repeatpassword === '' &&
saved.hasPassword && saved.type === 2 && sec.username === saved.username;
// Only send the secret for the selected type so the other one stays stored.
if (security.type !== 1 || keepPin) delete sec.pin;
if (security.type !== 2 || keepPassword) delete sec.password;
let confirm = '';
console.log(sec);
if (security.type === 1) { // Pin Entry
if (security.type === 1 && !keepPin) { // Pin Entry
// Make sure our pin is 4 digits.
if (sec.pin.length !== 4) {
ui.errorMessage('Invalid Pin').querySelector('.sub-message').innerHTML = 'Pins must be exactly 4 alpha-numeric values in length. Please enter a complete pin.';
@ -1693,7 +1703,8 @@ class General {
ui.errorMessage('Invalid Username').querySelector('.sub-message').innerHTML = 'The maximum username length is 32 characters.';
return;
}
}
if (security.type === 2 && !keepPassword) { // Password
if (sec.password.length === 0) {
ui.errorMessage('No Password Provided').querySelector('.sub-message').innerHTML = 'You must provide a password for password security.';
return;
@ -1803,6 +1814,11 @@ class Wifi {
document.getElementById('cbHardwired').checked = settings.connType >= 2;
document.getElementById('cbFallbackWireless').checked = settings.connType === 3;
ui.toElement(pnl, settings);
// The device never returns the stored passphrase; leave the field blank to keep it.
this.savedSsid = settings.wifi.ssid;
let fldPassphrase = document.getElementById('fldPassphrase');
fldPassphrase.value = '';
fldPassphrase.placeholder = settings.wifi.hasPassphrase ? 'Saved (leave blank to keep)' : 'Passphrase';
/*
if (settings.connType >= 2) {
document.getElementById('divWiFiMode').style.display = 'none';
@ -1850,7 +1866,7 @@ class Wifi {
//document.getElementById('btnConnectWiFi').classList.remove('disabled');
console.log(aps);
if (err) {
this.displayAPs({ connected: { name: '', passphrase: '' }, accessPoints: [] });
this.displayAPs({ connected: { name: '' }, accessPoints: [] });
}
else {
this.displayAPs(aps);
@ -1955,6 +1971,7 @@ class Wifi {
saveNetwork() {
let pnl = document.getElementById('divNetAdapter');
let obj = ui.fromElement(pnl);
if (this.keepSavedPassphrase(obj.wifi.ssid, obj.wifi.passphrase)) delete obj.wifi.passphrase;
obj.connType = obj.ethernet.hardwired ? (obj.ethernet.wirelessFallback ? 3 : 2) : 1;
console.log(obj);
if (obj.connType >= 2) {
@ -1991,6 +2008,8 @@ class Wifi {
this.sendNetworkSettings(obj);
}
}
// A blank passphrase for the saved SSID keeps the stored one; for a new SSID it means an open network.
keepSavedPassphrase(ssid, passphrase) { return passphrase === '' && ssid === this.savedSsid; }
sendNetworkSettings(obj) {
putJSONSync('/setNetwork', obj, (err, response) => {
if (err) {
@ -2014,6 +2033,7 @@ class Wifi {
ui.errorMessage('Invalid Passphrase').querySelector('.sub-message').innerHTML = 'The maximum length of the passphrase is 64 characters.';
return;
}
if (this.keepSavedPassphrase(obj.ssid, obj.passphrase)) delete obj.passphrase;
let overlay = ui.waitMessage(document.getElementById('divNetAdapter'));
@ -4364,12 +4384,19 @@ class MQTT {
else {
console.log(settings);
ui.toElement(document.getElementById('divMQTT'), { mqtt: settings });
// The device never returns the stored password; leave the field blank to keep it.
this.savedUsername = settings.username;
let fldPassword = document.getElementById('fldMqttPassword');
fldPassword.value = '';
fldPassword.placeholder = settings.hasPassword ? 'Saved (leave blank to keep)' : 'Password';
document.getElementById('divDiscoveryTopic').style.display = settings.pubDisco ? '' : 'none';
}
});
}
connectMQTT() {
let obj = ui.fromElement(document.getElementById('divMQTT'));
// A blank password keeps the stored one unless the username changed.
if (obj.mqtt.password === '' && obj.mqtt.username === this.savedUsername) delete obj.mqtt.password;
console.log(obj);
if (obj.mqtt.enabled) {
if (typeof obj.mqtt.hostname !== 'string' || obj.mqtt.hostname.length === 0) {

27
docs/KNOWN_ISSUES.md
View file

@ -105,3 +105,30 @@ It needs a group whose flags are out of date at the moment a client reads it, fo
- [ADR-0002](adr/0002-loop-task-is-the-only-writer-of-the-shade-model.md): the loop task is the only writer of the shade model.
- [Large websocket events are dropped](#large-websocket-events-are-dropped): the same `g_response` buffer.
## A saved WiFi passphrase or MQTT password can't be cleared from the UI
**Status:** open. A workaround exists (below).
**Introduced:** 2026-10-18, when the device stopped sending stored secrets back to clients.
**Location:** `keepSavedPassphrase` in `Wifi` and `connectMQTT` in `MQTT`, both in [data-src/index.js](../data-src/index.js). The firmware side is `applySecret` in [src/Secrets.h](../src/Secrets.h).
### Summary
The settings routes report only whether a secret is stored (`hasPassphrase`, `hasPassword`), so the UI loads every secret field empty. When the field is still blank on save, the UI treats it as "keep the saved value" and leaves the key out of the request, and `applySecret` keeps a value whose key is absent. Without that rule, saving any other setting on the page would wipe the secret.
The cost: a blank field can't mean "no password" while the other half of the login stays the same. That is the SSID for WiFi and the username for MQTT. When it does change, a blank field is sent as an empty value and clears the secret, so switching to a different open network works.
The login password and PIN aren't affected. Neither can be empty, and security is turned off with the type selector.
### Concrete failure modes
1. The network the device is on is changed to open on the router, keeping its SSID. Saving the network page with a blank passphrase keeps the old one. When a passphrase is set, `WiFi.begin` won't accept anything weaker than WPA2-PSK, so the device can't join the now-open network.
2. The MQTT broker stops requiring a password but keeps the username. The device keeps sending the old password.
### Workaround
Save once with a different SSID or MQTT username, then change it back and save again with the secret field blank.
### Fix options
- **(a) "Clear saved password" checkbox** next to the WiFi passphrase and MQTT password fields, shown only when a value is stored. Ticking it sends an explicit empty value, which `applySecret` already treats as "clear" (covered by `test_applySecret_empty_value_clears_stored`). This is a UI-only change.

21
src/ConfigSettings.cpp
View file

@ -5,6 +5,7 @@
#include <Preferences.h>
#include "ConfigSettings.h"
#include "Utils.h"
#include "Secrets.h"
#include "esp_chip_info.h"
#include "esp_log.h"
@ -301,7 +302,7 @@ bool MQTTSettings::toJSON(JsonObject &obj) {
obj["hostname"] = this->hostname;
obj["port"] = this->port;
obj["username"] = this->username;
obj["password"] = this->password;
obj["hasPassword"] = hasSecret(this->password);
obj["rootTopic"] = this->rootTopic;
obj["discoTopic"] = this->discoTopic;
return true;
@ -312,7 +313,7 @@ bool MQTTSettings::fromJSON(JsonObject &obj) {
this->parseValueString(obj, "protocol", this->protocol, sizeof(this->protocol));
this->parseValueString(obj, "hostname", this->hostname, sizeof(this->hostname));
this->parseValueString(obj, "username", this->username, sizeof(this->username));
this->parseValueString(obj, "password", this->password, sizeof(this->password));
applySecret(obj["password"].as<const char *>(), this->password, sizeof(this->password));
this->parseValueString(obj, "rootTopic", this->rootTopic, sizeof(this->rootTopic));
this->parseValueString(obj, "discoTopic", this->discoTopic, sizeof(this->discoTopic));
if(!obj["port"].isNull()) this->port = obj["port"];
@ -478,16 +479,16 @@ bool SecuritySettings::begin() {
bool SecuritySettings::fromJSON(JsonObject &obj) {
if(!obj["type"].isNull()) this->type = static_cast<security_types>(obj["type"].as<uint8_t>());
this->parseValueString(obj, "username", this->username, sizeof(this->username));
this->parseValueString(obj, "password", this->password, sizeof(this->password));
this->parseValueString(obj, "pin", this->pin, sizeof(this->pin));
applySecret(obj["password"].as<const char *>(), this->password, sizeof(this->password));
applySecret(obj["pin"].as<const char *>(), this->pin, sizeof(this->pin));
if(!obj["permissions"].isNull()) this->permissions = obj["permissions"];
return true;
}
bool SecuritySettings::toJSON(JsonObject &obj) {
obj["type"] = static_cast<uint8_t>(this->type);
obj["username"] = this->username;
obj["password"] = this->password;
obj["pin"] = this->pin;
obj["hasPassword"] = hasSecret(this->password);
obj["hasPin"] = hasSecret(this->pin);
obj["permissions"] = this->permissions;
return true;
}
@ -516,7 +517,7 @@ bool SecuritySettings::load() {
}
void SecuritySettings::print() {
ESP_LOGD(TAG, "SECURITY Type:%u Username:[%s] Password:[%s] Pin:[%s] Permissions:%u",
static_cast<uint8_t>(this->type), this->username, this->password, this->pin, this->permissions);
static_cast<uint8_t>(this->type), this->username, maskSecret(this->password), maskSecret(this->pin), this->permissions);
}
WifiSettings::WifiSettings() {}
@ -526,14 +527,14 @@ bool WifiSettings::begin() {
}
bool WifiSettings::fromJSON(JsonObject &obj) {
this->parseValueString(obj, "ssid", this->ssid, sizeof(this->ssid));
this->parseValueString(obj, "passphrase", this->passphrase, sizeof(this->passphrase));
applySecret(obj["passphrase"].as<const char *>(), this->passphrase, sizeof(this->passphrase));
if(!obj["roaming"].isNull()) this->roaming = obj["roaming"];
if(!obj["hidden"].isNull()) this->hidden = obj["hidden"];
return true;
}
bool WifiSettings::toJSON(JsonObject &obj) {
obj["ssid"] = this->ssid;
obj["passphrase"] = this->passphrase;
obj["hasPassphrase"] = hasSecret(this->passphrase);
obj["roaming"] = this->roaming;
obj["hidden"] = this->hidden;
return true;
@ -579,7 +580,7 @@ String WifiSettings::mapEncryptionType(int type) {
return "Unknown";
}
void WifiSettings::print() {
ESP_LOGD(TAG, "WIFI Settings SSID: [%s] PassPhrase: [%s]", this->ssid, this->passphrase);
ESP_LOGD(TAG, "WIFI Settings SSID: [%s] PassPhrase: [%s]", this->ssid, maskSecret(this->passphrase));
}
void WifiSettings::printNetworks() {
int n = WiFi.scanNetworks(false, false);

25
src/Secrets.h Normal file
View file

@ -0,0 +1,25 @@
#ifndef secrets_h
#define secrets_h
#include <string.h>
// Stored secrets (WiFi passphrase, MQTT password, login password/PIN) are
// write-only: responses carry hasSecret() flags and logs carry maskSecret().
inline bool hasSecret(const char *s) { return s && s[0] != '\0'; }
inline const char *maskSecret(const char *s) { return hasSecret(s) ? "<set>" : "<empty>"; }
// Updates dest from an incoming value, truncating to size. A null incoming
// value means the client left the field out, so the stored secret is kept.
// Pass obj["key"].as<const char *>(), which is null when the key is absent.
// Returns true when dest changed.
inline bool applySecret(const char *incoming, char *dest, size_t size) {
if(!incoming || size == 0) return false;
size_t len = strlen(incoming);
if(len >= size) len = size - 1;
if(strncmp(dest, incoming, len) == 0 && dest[len] == '\0') return false;
memcpy(dest, incoming, len);
dest[len] = '\0';
return true;
}
#endif

1
src/entryPoints/Web.cpp
View file

@ -125,7 +125,6 @@ bool Web::createAPIToken(const char *payload, char *token) {
sprintf(str, "%02x", (int)hmacResult[i]);
strcat(token, str);
}
ESP_LOGD(TAG, "Hash: %s", token);
return true;
}
bool Web::createAPIToken(const IPAddress ipAddress, char *token) {

4
src/entryPoints/WebUiRoutes.cpp
View file

@ -621,7 +621,6 @@ void registerWebUiRoutes(AsyncWebServer &server) {
resp.beginObject();
resp.beginObject("connected");
resp.addElem("name", settings.WIFI.ssid);
resp.addElem("passphrase", settings.WIFI.passphrase);
resp.addElem("strength", (int32_t)WiFi.RSSI());
resp.addElem("channel", (int32_t)WiFi.channel());
resp.endObject();
@ -834,7 +833,8 @@ void registerWebUiRoutes(AsyncWebServer &server) {
JsonObject obj = json.as<JsonObject>();
ESP_LOGD(TAG, "Settings WIFI connection...");
String ssid = "";
String passphrase = "";
// Clients never receive the stored passphrase, so an omitted one keeps it.
String passphrase = settings.WIFI.passphrase;
if(!obj["ssid"].isNull()) ssid = obj["ssid"].as<String>();
if(!obj["passphrase"].isNull()) passphrase = obj["passphrase"].as<String>();
bool reboot = false;

81
test/test_secrets/test_secrets.cpp Normal file
View file

@ -0,0 +1,81 @@
#include <unity.h>
#include "Secrets.h"
void setUp() {}
void tearDown() {}
/*********************************************************************
* hasSecret / maskSecret
********************************************************************/
static void test_hasSecret_null_and_empty_are_unset() {
TEST_ASSERT_FALSE(hasSecret(nullptr));
TEST_ASSERT_FALSE(hasSecret(""));
}
static void test_hasSecret_any_value_is_set() {
TEST_ASSERT_TRUE(hasSecret("x"));
TEST_ASSERT_TRUE(hasSecret(" "));
}
static void test_maskSecret_never_returns_the_secret() {
TEST_ASSERT_EQUAL_STRING("<set>", maskSecret("hunter2"));
TEST_ASSERT_EQUAL_STRING("<empty>", maskSecret(""));
TEST_ASSERT_EQUAL_STRING("<empty>", maskSecret(nullptr));
}
/*********************************************************************
* applySecret
********************************************************************/
static void test_applySecret_absent_keeps_stored_value() {
char dest[16] = "stored";
TEST_ASSERT_FALSE(applySecret(nullptr, dest, sizeof(dest)));
TEST_ASSERT_EQUAL_STRING("stored", dest);
}
static void test_applySecret_new_value_replaces_stored() {
char dest[16] = "stored";
TEST_ASSERT_TRUE(applySecret("fresh", dest, sizeof(dest)));
TEST_ASSERT_EQUAL_STRING("fresh", dest);
}
static void test_applySecret_same_value_is_no_change() {
char dest[16] = "stored";
TEST_ASSERT_FALSE(applySecret("stored", dest, sizeof(dest)));
TEST_ASSERT_EQUAL_STRING("stored", dest);
}
static void test_applySecret_prefix_of_stored_is_a_change() {
char dest[16] = "stored";
TEST_ASSERT_TRUE(applySecret("sto", dest, sizeof(dest)));
TEST_ASSERT_EQUAL_STRING("sto", dest);
}
// Sending an empty value explicitly clears it, e.g. an open WiFi network.
static void test_applySecret_empty_value_clears_stored() {
char dest[16] = "stored";
TEST_ASSERT_TRUE(applySecret("", dest, sizeof(dest)));
TEST_ASSERT_EQUAL_STRING("", dest);
}
static void test_applySecret_truncates_and_terminates() {
char storage[8];
memset(storage, 'X', sizeof(storage));
storage[0] = '\0';
TEST_ASSERT_TRUE(applySecret("abcdefgh", storage, 5));
TEST_ASSERT_EQUAL_STRING("abcd", storage);
// Nothing past the buffer size is touched.
TEST_ASSERT_EQUAL_HEX8('X', storage[5]);
}
static void test_applySecret_truncated_same_value_is_no_change() {
char dest[5] = "abcd";
TEST_ASSERT_FALSE(applySecret("abcdefgh", dest, sizeof(dest)));
TEST_ASSERT_EQUAL_STRING("abcd", dest);
}
int main(int argc, char **argv) {
UNITY_BEGIN();
RUN_TEST(test_hasSecret_null_and_empty_are_unset);
RUN_TEST(test_hasSecret_any_value_is_set);
RUN_TEST(test_maskSecret_never_returns_the_secret);
RUN_TEST(test_applySecret_absent_keeps_stored_value);
RUN_TEST(test_applySecret_new_value_replaces_stored);
RUN_TEST(test_applySecret_same_value_is_no_change);
RUN_TEST(test_applySecret_prefix_of_stored_is_a_change);
RUN_TEST(test_applySecret_empty_value_clears_stored);
RUN_TEST(test_applySecret_truncates_and_terminates);
RUN_TEST(test_applySecret_truncated_same_value_is_no_change);
return UNITY_END();
}