mirror of
https://github.com/MarekZegare4/MeshCore-Solo.git
synced 2026-07-26 14:58:12 +00:00
fix: smaller audit items — strnlen, narrow-display guard, SNR precision
M2: CMD_SET_DEFAULT_FLOOD_SCOPE used strlen() on the frame's 31-byte name slot, which is not required to be NUL-terminated. Switched to strnlen() so the search can't run past the field into the 16-byte key. M4: NearbyScreen::renderDiscoverDetail computed strncpy(b64, ..., max_chars - 3) where max_chars came from display width. On very narrow displays (width < ~28 at 6 px font) this became negative. Skip the pub-key line entirely when max_chars < 4 so we don't risk a negative count and a bogus terminator. L1: SNR was shown as truncated integer dB. Switched the detail view and the 2-line discover cards to %.1f so they keep the 0.25 dB resolution (consistent with the ping popup, which already used %.1f). L4: Two fallback "?" sender placeholders used strncpy(buf, "?", sizeof(buf)) — functional but it memsets 21 unused bytes for a one-character string. Replaced with strcpy. M1 marked as not-a-bug after re-check: default_scope_name is char[31], so the n < 31 guard correctly admits the max 30-char string + NUL. FEATURES.md audit section updated with current status. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
48
FEATURES.md
48
FEATURES.md
@@ -337,37 +337,29 @@ The reset is now gated on `sentinel == 0xC0DE0003` so newer mismatches (e.g. 0xC
|
||||
|
||||
## Medium
|
||||
|
||||
### 📋 `CMD_SET_DEFAULT_FLOOD_SCOPE` off-by-one
|
||||
### ❌ `CMD_SET_DEFAULT_FLOOD_SCOPE` off-by-one — not a bug
|
||||
|
||||
[`MyMesh.cpp:2127-2128`](examples/companion_radio/MyMesh.cpp#L2127-L2128)
|
||||
[`MyMesh.cpp:2143`](examples/companion_radio/MyMesh.cpp#L2143)
|
||||
|
||||
```cpp
|
||||
if (n > 0 && n < 31) { // default_scope_name is 32 B → should allow n <= 31
|
||||
```
|
||||
Re-checked: `default_scope_name` is declared `char[31]` (not 32), so `n < 31` correctly admits the maximum 30-character string + NUL. The audit entry was a misread.
|
||||
|
||||
Rejects a valid 31-character scope name.
|
||||
### ✅ `strlen` on `cmd_frame` without null-termination — replaced with `strnlen`
|
||||
|
||||
### 📋 `strlen` on `cmd_frame` without null-termination guarantee
|
||||
[`MyMesh.cpp:2140-2147`](examples/companion_radio/MyMesh.cpp#L2140-L2147)
|
||||
|
||||
[`MyMesh.cpp:2127`](examples/companion_radio/MyMesh.cpp#L2127)
|
||||
|
||||
`strlen((char *) &cmd_frame[1])` will read past frame end if the app sends no `\0` in the first 31 bytes. Bounded by frame buffer size (172+) so practically safe but fragile.
|
||||
The 31-byte name slot in `CMD_SET_DEFAULT_FLOOD_SCOPE` doesn't have to be NUL-terminated by the sender. Switched to `strnlen(…, 31)` so the search can't run past the field into the 16-byte key (or beyond the frame).
|
||||
|
||||
### 📋 `PopupMenu._cap` updated only in `render()`
|
||||
|
||||
[`PopupMenu.h:37-44, 77-90`](examples/companion_radio/ui-new/PopupMenu.h#L37-L90)
|
||||
|
||||
The first `handleInput()` after `begin()` uses `_cap = _visible` (caller hint), not the real screen capacity. Render always precedes input in practice, but the invariant is fragile.
|
||||
Left as-is: the framework always renders before forwarding input, so the fragile invariant doesn't fire in practice. Worth a refactor only if the call order ever changes.
|
||||
|
||||
### 📋 `renderDiscoverDetail` potential negative length in `strncpy`
|
||||
### ✅ `renderDiscoverDetail` guarded against narrow displays
|
||||
|
||||
[`NearbyScreen.h:331-334`](examples/companion_radio/ui-new/NearbyScreen.h#L331-L334)
|
||||
[`NearbyScreen.h:325-348`](examples/companion_radio/ui-new/NearbyScreen.h#L325-L348)
|
||||
|
||||
```cpp
|
||||
strncpy(b64_line, b64, max_chars - 3); // UB if max_chars < 3
|
||||
```
|
||||
|
||||
Requires `display.width() < ~28` (very narrow), but no guard.
|
||||
Pub-key line is now skipped entirely when `max_chars < 4` instead of feeding a negative length to `strncpy`.
|
||||
|
||||
### 📋 `expandMsg` GPS validity test treats (0, 0) as invalid
|
||||
|
||||
@@ -377,15 +369,15 @@ Requires `display.width() < ~28` (very narrow), but no guard.
|
||||
sensors.node_lat != 0.0 || sensors.node_lon != 0.0 // proxy for "valid GPS"
|
||||
```
|
||||
|
||||
Point (0, 0) is a legitimate location (Gulf of Guinea). Corner case but a logic error.
|
||||
Point (0, 0) is a legitimate location (Gulf of Guinea). Corner case but a logic error. Left for a future pass with a proper GPS-validity bool.
|
||||
|
||||
## Low
|
||||
|
||||
### 📋 SNR division by 4 loses precision
|
||||
### ✅ SNR division by 4 — now uses `%.1f`
|
||||
|
||||
[`NearbyScreen.h:348, 350`](examples/companion_radio/ui-new/NearbyScreen.h#L348-L350)
|
||||
[`NearbyScreen.h:355-357, 487`](examples/companion_radio/ui-new/NearbyScreen.h#L355-L487)
|
||||
|
||||
`(int)(r.snr_x4 / 4)` truncates the 0.25 dB component. Should be `r.snr_x4 / 4.0f` with `%.1f`.
|
||||
Detail view (`SNR: %.1f dB`, `Rem: %.1f dB`) and discover list cards (`SNR:%.1f`) both keep the 0.25 dB resolution. Stays consistent with the ping popup, which already used `%.1f`.
|
||||
|
||||
### 📋 Trail `_count` cast to `uint16_t`
|
||||
|
||||
@@ -399,11 +391,11 @@ Safe today (CAPACITY=512 fits), fragile if CAPACITY grows past 65535.
|
||||
|
||||
Trigger word near the end of a >199-character message will not match.
|
||||
|
||||
### 📋 `strncpy("?", buf, sizeof(buf))` — 1 B source into 22 B dest
|
||||
### ✅ `strncpy("?", buf, sizeof(buf))` replaced with `strcpy`
|
||||
|
||||
[`QuickMsgScreen.h:785, 858`](examples/companion_radio/ui-new/QuickMsgScreen.h#L785)
|
||||
|
||||
Functional but copies 22 bytes for a 1-character string. Should be `strcpy(buf, "?")`.
|
||||
Two fallback "?" sender names now use a plain `strcpy` so we don't memset 21 unused bytes for a one-character string.
|
||||
|
||||
### 📋 Title truncation in MSG_PICK reply mode
|
||||
|
||||
@@ -417,7 +409,11 @@ Fix status after this pass:
|
||||
|
||||
- ✅ C1 + C2 — `findChannelIdx == -1` guarded at both channel-recv paths; `addChannelMsg` defends against bogus index
|
||||
- ✅ H4 — `trail_units_idx` reset scoped to the 0xC0DE0003 jump
|
||||
- ✅ M2 — `strnlen` instead of `strlen` on default scope name
|
||||
- ✅ M4 — `renderDiscoverDetail` skips pub-key line on very narrow displays
|
||||
- ✅ L1 — SNR shown with 0.25 dB precision everywhere
|
||||
- ✅ L4 — fallback `"?"` sender no longer memsets through `strncpy`
|
||||
- ❌ M1 — re-checked, not a bug (`default_scope_name[31]`)
|
||||
- 📋 H1 + H2 — still open; need coordinated fix in upstream `BaseChatMesh` (`findChannelIdx` should iterate `num_channels`, not `MAX_GROUP_CHANNELS`; `saveChannels` should stop at the first uninitialised slot) or a local override
|
||||
- 📋 H3 — left as known limitation pending UX call
|
||||
|
||||
Medium/Low items can ride along with other refactors in the affected files.
|
||||
- 📋 M3, M5, L2, L3, L6 — minor or stylistic; left in backlog
|
||||
|
||||
@@ -2139,7 +2139,10 @@ void MyMesh::handleCmdFrame(size_t len) {
|
||||
writeOKFrame();
|
||||
} else if (cmd_frame[0] == CMD_SET_DEFAULT_FLOOD_SCOPE && len >= 1) {
|
||||
if (len >= 1+31+16) {
|
||||
int n = strlen((char *) &cmd_frame[1]);
|
||||
// strnlen, not strlen: the name field is always 31 bytes in the frame
|
||||
// even if the actual name is shorter, so we must bound the search to
|
||||
// avoid reading into the key (or past the frame) when no NUL is present.
|
||||
int n = (int)strnlen((char *) &cmd_frame[1], 31);
|
||||
if (n > 0 && n < 31) {
|
||||
strcpy(_prefs.default_scope_name, (char *) &cmd_frame[1]);
|
||||
memcpy(_prefs.default_scope_key, &cmd_frame[1+31], 16);
|
||||
|
||||
@@ -328,7 +328,12 @@ class NearbyScreen : public UIScreen {
|
||||
int max_chars = (display.width() - 4) / display.getCharWidth();
|
||||
int b64_len = strlen(b64);
|
||||
char b64_line[48];
|
||||
if (b64_len > max_chars) {
|
||||
// Need at least 4 chars (one char + "..." ellipsis) to display anything
|
||||
// meaningful; on a very narrow display skip the pubkey line entirely
|
||||
// rather than risk a negative strncpy length.
|
||||
if (max_chars < 4) {
|
||||
b64_line[0] = '\0';
|
||||
} else if (b64_len > max_chars) {
|
||||
strncpy(b64_line, b64, max_chars - 3);
|
||||
b64_line[max_chars - 3] = '\0';
|
||||
strcat(b64_line, "...");
|
||||
@@ -336,8 +341,10 @@ class NearbyScreen : public UIScreen {
|
||||
strncpy(b64_line, b64, sizeof(b64_line) - 1);
|
||||
b64_line[sizeof(b64_line) - 1] = '\0';
|
||||
}
|
||||
display.setCursor(2, hdr);
|
||||
display.print(b64_line);
|
||||
if (b64_line[0]) {
|
||||
display.setCursor(2, hdr);
|
||||
display.print(b64_line);
|
||||
}
|
||||
}
|
||||
|
||||
int step = display.lineStep();
|
||||
@@ -345,9 +352,9 @@ class NearbyScreen : public UIScreen {
|
||||
char buf[32];
|
||||
snprintf(buf, sizeof(buf), "RSSI: %d dBm", (int)r.rssi);
|
||||
display.setCursor(2, hdr + step); display.print(buf);
|
||||
snprintf(buf, sizeof(buf), "SNR: %d dB", (int)(r.snr_x4 / 4));
|
||||
snprintf(buf, sizeof(buf), "SNR: %.1f dB", r.snr_x4 / 4.0f);
|
||||
display.setCursor(2, hdr + step * 2); display.print(buf);
|
||||
snprintf(buf, sizeof(buf), "Rem: %d dB", (int)(r.remote_snr_x4 / 4));
|
||||
snprintf(buf, sizeof(buf), "Rem: %.1f dB", r.remote_snr_x4 / 4.0f);
|
||||
display.setCursor(2, hdr + step * 3); display.print(buf);
|
||||
display.setCursor(2, hdr + step * 4);
|
||||
display.print(r.is_known ? "Status: known" : "Status: new");
|
||||
@@ -477,7 +484,7 @@ class NearbyScreen : public UIScreen {
|
||||
// body: RSSI + SNR
|
||||
display.setColor(sel ? DisplayDriver::DARK : DisplayDriver::LIGHT);
|
||||
char sig[24];
|
||||
snprintf(sig, sizeof(sig), "RSSI:%d SNR:%d", (int)r.rssi, (int)(r.snr_x4 / 4));
|
||||
snprintf(sig, sizeof(sig), "RSSI:%d SNR:%.1f", (int)r.rssi, r.snr_x4 / 4.0f);
|
||||
display.drawTextEllipsized(3, y + lh + 2, display.width() - 6, sig);
|
||||
}
|
||||
|
||||
|
||||
@@ -784,7 +784,7 @@ public:
|
||||
strncpy(fsender, ftext, nl); fsender[nl] = '\0';
|
||||
strncpy(fmsg, fsep + 2, sizeof(fmsg) - 1); fmsg[sizeof(fmsg)-1] = '\0';
|
||||
} else {
|
||||
strncpy(fsender, "?", sizeof(fsender));
|
||||
strcpy(fsender, "?");
|
||||
strncpy(fmsg, ftext, sizeof(fmsg) - 1); fmsg[sizeof(fmsg)-1] = '\0';
|
||||
}
|
||||
int ret = _fs.render(display, fsender, fmsg,
|
||||
@@ -857,7 +857,7 @@ public:
|
||||
strncpy(msg_part, sep + 2, sizeof(msg_part) - 1);
|
||||
msg_part[sizeof(msg_part) - 1] = '\0';
|
||||
} else {
|
||||
strncpy(sender, "?", sizeof(sender));
|
||||
strcpy(sender, "?");
|
||||
strncpy(msg_part, text, sizeof(msg_part) - 1);
|
||||
msg_part[sizeof(msg_part) - 1] = '\0';
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user