| Version | Supported |
|---|---|
| 2.x | β Active |
| 1.x | β EOL |
This project processes live webcam video on-device. Please understand:
| Data | Where it goes | Persisted? |
|---|---|---|
| Webcam frames | Processed in RAM only | β No |
| Face / eye regions | Processed in RAM only | β No |
| Sleep-event snapshots | snapshots/ folder on your machine |
β Yes (local) |
| Session logs | logs/ folder on your machine (JSON Lines) |
β Yes (local) |
No data is ever transmitted to any server, cloud service, or third party. The project is entirely offline.
The snapshots/ directory is listed in .gitignore. Do not commit it.
If you fork or share the repository, verify that no snapshots/ images are
accidentally staged.
- β Does not record or store continuous video
- β Does not send any data over the network
- β Does not require API keys or cloud credentials
- β Does not access microphone, GPS, or any other sensor
- β Does not read environment variables or system information
If you discover a security issue (e.g., a dependency with a known CVE, an unintended data-leak path, or an injection vector), please report it privately before opening a public issue:
- Email:
your-email@example.com(replace with your real address) - Subject:
[SECURITY] Sleeping Alarm System β <brief description> - Include steps to reproduce and the potential impact.
We aim to respond within 5 business days and release a patch within 14 days of confirmation.
Please do not open a public GitHub issue for security vulnerabilities β use private disclosure instead.
Dependencies are pinned in requirements.txt. To audit them:
pip install pip-audit
pip-audit -r requirements.txtTo check for known CVEs in OpenCV or NumPy:
pip install safety
safety check -r requirements.txt| Recommendation | Reason |
|---|---|
Run in a virtual environment (venv) |
Isolates dependencies |
| Do not run as root/admin | Limits blast radius |
Keep snapshots/ out of version control |
Contains face images |
| Rotate logs periodically | Avoids unbounded disk growth |
| Pin dependencies in CI | Prevents supply-chain surprises |
Last updated: 2025