| Version | Supported |
|---|---|
| 2.x.x | Yes |
| 1.x.x | No |
We take security seriously. If you discover a security vulnerability in LyreBirdAudio, please report it responsibly.
- Do NOT open a public GitHub issue for security vulnerabilities
- Email security concerns to the maintainer (see GitHub profile)
- Include as much detail as possible:
- Description of the vulnerability
- Steps to reproduce
- Potential impact
- Suggested fix (if any)
- Acknowledgment: Within 48 hours of your report
- Initial Assessment: Within 7 days
- Resolution Timeline: Depends on severity
- Critical: 24-48 hours
- High: 7 days
- Medium: 30 days
- Low: Next release
When deploying LyreBirdAudio, follow these security recommendations:
- Run MediaMTX behind a reverse proxy with TLS termination
- Restrict API access to localhost or trusted networks
- Use firewall rules to limit RTSP port exposure
- Consider VPN for remote stream access
- Run scripts with minimal required privileges
- Avoid running as root when possible
- Use appropriate file permissions (640 for configs, 750 for scripts)
- Store recordings in a dedicated partition
- Never commit webhook URLs or API keys to version control
- Use environment variables for sensitive configuration
- Rotate credentials regularly
- Monitor logs for unauthorized access attempts
- Use HTTPS endpoints for webhook delivery
- Verify webhook signatures when possible
- Implement rate limiting
- Monitor for failed delivery attempts
LyreBirdAudio includes several security-conscious features:
- SHA256 Verification: All MediaMTX downloads are verified against checksums
- Secure Temp Files: Uses
mktempfor temporary file creation - Input Sanitization: RTSP paths and user inputs are validated
- No Hardcoded Credentials: Configuration is environment-driven
- Atomic Operations: File operations use atomic patterns where possible
- Signal Handling: Graceful shutdown and cleanup on termination
- Path Validation: Dangerous operations validate path safety
We follow a coordinated disclosure process:
- Reporter contacts maintainers privately
- Issue is confirmed and assessed
- Fix is developed and tested
- Security advisory is prepared
- Patch is released
- Advisory is published after users have time to update
We appreciate security researchers who help keep LyreBirdAudio secure. Responsible disclosures will be acknowledged in release notes (with permission).