Skip to content

SharedPreferences: don't log full prefs dict #123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ThomasFarstrike merged 1 commit into from
Apr 19, 2026
Merged

SharedPreferences: don't log full prefs dict #123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Frameworks:
- Add new LoRaManager framework
- Add mpos.ui.change_task_handler() for improving IR timing accuracy
- AppearanceManager: fix set_light_mode() and set_primary_color() — they called a non-existent `prefs.set_string()` and raised AttributeError for every third-party caller; writes now go through `edit().put_string().commit()` and the LVGL theme is reinitialised when the colour changes
- SharedPreferences: security fix — `load()` no longer prints the entire prefs dict to serial/REPL. Any pref holding a secret (WiFi password in `access_points`, Lightning wallet API keys, NWC secrets, xpubs, etc.) was being leaked to logs every time an app loaded its prefs. Now logs only the filepath and key count

OS:
- LilyGo T-Watch S3 Plus: add support for IR Remote app
Expand Down
9 changes: 8 additions & 1 deletion internal_filesystem/lib/mpos/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,14 @@ def load(self):
try:
with open(self.filepath, 'r') as f:
self.data = ujson.load(f)
print(f"load: Loaded preferences from {self.filepath}: {self.data}")
# Deliberately log only the filepath and key count, NOT the
# values. Prefs often hold secrets (WiFi passwords in
# access_points, wallet API keys / NWC secrets / xpubs in
# third-party apps, etc.) — printing self.data leaked those
# to serial/REPL every time any app loaded its prefs. An
# app that wants rich debug output can opt in by logging
# selected keys itself.
print(f"load: Loaded preferences from {self.filepath} ({len(self.data)} keys)")
except Exception as e:
print(f"SharedPreferences.load didn't find preferences: {e}")
self.data = {}
Expand Down
Loading