Currently supported versions for security updates:
| Version | Supported |
|---|---|
| main | ✅ |
We take security seriously. If you discover a security vulnerability, please follow these steps:
DO NOT create a public GitHub issue for security vulnerabilities.
Instead, please:
- Email: Send details to [security contact] (replace with actual email)
- Include:
- Description of the vulnerability
- Steps to reproduce
- Potential impact
- Suggested fix (if any)
For non-security issues, please use the GitHub issue tracker.
This transparent proxy operates with these security principles:
- No TLS MITM: HTTPS traffic is tunneled, not decrypted
- SNI-only extraction: Only hostname extraction from TLS handshakes
- Userspace operation: No kernel-level privileges required
- Local-only: Designed for localhost/LAN operation
- Plaintext HTTP: HTTP content is visible to the proxy
- SNI logging: Destination hostnames are logged
- pfctl rules: Require admin privileges to configure
- DoS potential: No built-in rate limiting
- Run proxy with minimal privileges
- Monitor logs for suspicious activity
- Use HTTPS whenever possible
- Regularly update dependencies
- Validate all input data
- Sanitize log output
- Handle errors gracefully
- Follow secure coding practices
- Risk: SNI hostnames visible in logs
- Mitigation: Configure log rotation and access controls
- Risk: Memory exhaustion from large requests
- Mitigation: Implement connection limits and timeouts
- Risk: pfctl rules require admin access
- Mitigation: Use principle of least privilege
- Risk: HTTP traffic interception
- Mitigation: This is intentional for filtering; use HTTPS for sensitive data
We aim to:
- Acknowledge reports within 48 hours
- Provide initial assessment within 1 week
- Release fixes for critical issues within 2 weeks
- Coordinate disclosure responsibly
We follow responsible disclosure principles:
- Work with researchers to understand issues
- Provide credit for valid reports
- Coordinate public disclosure timing
- Focus on user safety first
Thank you for helping keep this project secure! 🔐