Project All pages

Security

How to report a vulnerability, and what is in scope.

What this means for you

  • fauxcloud's pages are plain HTTP, without encryption. Use them on your home network only, and keep fauxcloud off the internet.
  • Every device on your home network can open the dashboard and read its data. Settings needs your admin password.
  • Setup mode opens a Wi-Fi with the shared password fauxcloud, for at most 30 minutes without activity.

Reporting a vulnerability

Please report a vulnerability privately, never in a public issue, a pull request or a discussion.

Use GitHub's private reporting: the repository's Security tab → Report a vulnerability (https://github.com/fauxcloud/fauxcloud/security/advisories/new). Only the maintainer sees the report. You can also e-mail security@fauxcloud.org. Write in English or Polish.

Please include:

  • the fauxcloud version (Settings → Maintenance shows it) and the board;
  • what an attacker needs (on fauxcloud's own Wi-Fi, on your home network, signed in or not, physical access);
  • the steps to reproduce it on a real board, and what happens;
  • whether you want to be credited, and under which name.

Never send passwords, keys, the crash file (it contains your passwords) or the exact location of your station.

The maintainer reads reports in batches, roughly once a week; no response time is promised. A confirmed problem is fixed in a release and published as a GitHub security advisory, with credit if you want it. Reports generated by AI tools without a reproduction on a real board are closed without discussion.

Supported versions

Only the latest release gets security fixes. Update through Settings → Maintenance → Firmware update.

Scope

In scope: the fauxcloud firmware and its web pages:

  • the HTTP server on your home network: the dashboard, Settings and their API;
  • the HTTP server on fauxcloud's own Wi-Fi, the console side: its DNS and time answers, and the upload;
  • the admin sign-in, sessions and the lock after wrong passwords;
  • setup mode and the BOOT-button flows;
  • the firmware update upload and its rollback;
  • the MQTT client, the online-services sending (including the HTTPS certificate checks) and the airport-weather and forecast fetches;
  • the tools in this repository that build and check a release.

Out of scope:

  • the weather console's own firmware and its setup page, and the online services fauxcloud can send to;
  • the limits fauxcloud documents by design:
    • the pages are plain HTTP on your home network, and the dashboard and its read API are open to every device there;
    • setup mode opens a Wi-Fi with the shared password fauxcloud, for at most 30 minutes without activity;
    • there is no secure boot and no image signing: a signed-in admin can install any image that carries the fauxcloud marker;
    • MQTT to your broker is plain TCP;
    • anyone with physical access to the board can reinstall the firmware or reset it.
Tip

If you are not sure whether something is in scope, report it privately anyway.