We provide security updates for the following versions:
| Version | Supported |
|---|---|
| main | ✅ |
| other branches | ❌ |
We take security seriously. If you discover a security vulnerability in this project, please help us by reporting it responsibly.
Please do NOT report security vulnerabilities through public GitHub issues.
Instead, please report security vulnerabilities by:
-
Opening a GitHub Security Advisory (recommended)
- Go to the Security tab
- Click "Report a vulnerability"
- Provide detailed information about the vulnerability
-
Creating a private issue
- If Security Advisories are not available, create a standard issue
- Mark it with the
securitylabel - Avoid including sensitive details in the public description
Please include as much of the following information as possible:
- Type of vulnerability (e.g., code injection, privilege escalation, insecure defaults)
- Affected component(s) (e.g., specific script, image configuration, workflow)
- Steps to reproduce the vulnerability
- Potential impact of the vulnerability
- Suggested fix (if you have one)
- Your environment (OS, versions, etc.)
- Initial response: Within 48 hours
- Assessment: Within 1 week
- Fix timeline: Depends on severity
- Critical: Immediate fix and release
- High: Fix within 1-2 weeks
- Medium/Low: Fix in next release cycle
This project builds custom Raspberry Pi images. Please consider:
- Default credentials: Always change default passwords after first boot
- SSH access: Images may have SSH enabled by default - secure it immediately
- Network exposure: Review firewall rules and exposed services
- Package updates: Run
apt update && apt upgradeafter first boot
- Downloaded images: We download base images from official sources (Raspberry Pi OS, Debian)
- Image verification: Consider verifying checksums of downloaded base images
- Build environment: Use trusted build environments (avoid compromised systems)
- Custom configurations: Review
setup.shscripts before building images
- Base images: Downloaded from official Raspberry Pi and Debian repositories
- Packages: Installed via official APT repositories (archive.raspberrypi.org, deb.debian.org)
- Dependencies: Minimal external dependencies, all from official distro repos
- GitHub Actions: Workflows run in GitHub-hosted runners with restricted permissions
- Cloud-init passwords: Cloud-init configurations may contain plain text passwords
- Store
user-datafiles securely - Change passwords after first boot
- Consider using SSH keys instead
- Store
- QEMU execution: Setup scripts run in QEMU during build
- Review
setup.shscripts for malicious commands - Avoid running untrusted image configurations
- Review
- Root access: Build process requires root/sudo access
- Review scripts before running with elevated privileges
- Use dedicated build systems if possible
When using images built by this project:
- Change default credentials immediately after first boot
- Update system packages:
sudo apt update && sudo apt upgrade - Configure firewall: Set up
ufworiptables - Disable unnecessary services
- Enable automatic security updates: Install
unattended-upgrades - Use SSH keys instead of password authentication
- Review running services:
systemctl list-units --type=service
Security fixes will be:
- Released as soon as possible after confirmation
- Documented in release notes
- Announced via GitHub releases
- Tagged with
securitylabel in issues/PRs
- We follow coordinated disclosure principles
- Security vulnerabilities will be publicly disclosed after a fix is available
- We will credit security researchers (unless they prefer to remain anonymous)
Thank you for helping keep this project and its users safe!