We actively support and provide security updates for the following versions:
| Version | Supported | Status |
|---|---|---|
| 2.0.x | β Yes | Current |
| 1.x | β No | End of Life |
Please do not report security vulnerabilities through public GitHub issues.
- Email: Send details to
security@example.com(replace with actual email) - Subject: Include "WireGuard Monitor Security Issue" in the subject line
- Details: Include as much information as possible (see template below)
- Response: We will respond within 48 hours
Subject: WireGuard Monitor Security Issue - [Brief Description]
**Summary**:
Brief description of the vulnerability
**Impact**:
What could an attacker accomplish?
**Reproduction Steps**:
1. Step one
2. Step two
3. Step three
**Environment**:
- OS and version
- WireGuard Monitor version
- Docker version
- Any relevant configuration
**Proof of Concept**:
(If applicable, include PoC code or screenshots)
**Suggested Fix**:
(If you have ideas for fixing the issue)
- Initial Response: Within 48 hours
- Investigation: 1-7 days depending on complexity
- Fix Development: 7-30 days
- Coordinated Disclosure: After fix is available
- β Secure file permissions (600) for config files
- β Root-only access to sensitive files
- β Input validation for all configuration parameters
- β No hardcoded secrets in code
- β Process isolation with systemd security features
- β Minimal privileges (NoNewPrivileges=true)
- β Protected system directories
- β Secure temporary file handling
- β HTTPS-only communication with Telegram API
- β TLS certificate validation
- β No sensitive data in logs
- β Secure error message handling
- β Read-only Docker socket access where possible
- β Container isolation respect
- β No privileged container operations
- β Secure command execution
- Risk: Telegram bot tokens provide full access to your bot
- Mitigation: Store tokens securely with 600 permissions, rotate regularly
- Best Practice: Use dedicated monitoring-only bot, not personal bot
- Risk: Script requires Docker socket access to monitor containers
- Mitigation: Run with minimal necessary privileges
- Best Practice: Consider read-only Docker access where possible
- Risk: Logs may contain sensitive information
- Mitigation: Logs are protected with proper file permissions
- Best Practice: Regular log rotation and secure log storage
# Secure installation permissions
sudo chmod 600 /etc/telemon.env
sudo chown root:root /etc/telemon.env
sudo chmod 644 /var/log/wg-monitor.log
sudo chown root:adm /var/log/wg-monitor.log- Create dedicated bot for monitoring only
- Limit bot permissions to send messages only
- Regularly rotate bot tokens
- Monitor bot usage in @BotFather
- Ensure firewall allows HTTPS (443) for Telegram API
- Monitor network traffic to api.telegram.org
- Consider using Telegram Bot API on local server
# Check file permissions
ls -la /etc/telemon.env
ls -la /usr/local/bin/wg_telemon.sh
ls -la /var/log/wg-monitor.log
# Audit configuration
sudo /usr/local/bin/wg_telemon.sh --test- Always validate input parameters
- Use parameterized commands, avoid shell injection
- Implement proper error handling
- Never log sensitive information
- Follow principle of least privilege
# β
Good - Secure variable handling
if [[ -n "${BOT_TOKEN:-}" ]]; then
# Use token securely
fi
# β Bad - Insecure variable usage
echo "Token: $BOT_TOKEN"- Configuration files have proper permissions (600)
- No hardcoded secrets in scripts or configs
- Input validation for all user-provided data
- Error messages don't reveal sensitive information
- Log files are properly secured and rotated
- Network communication uses encryption (HTTPS)
- File operations use secure temporary files
- Process execution follows least privilege principle
- File permission changes monitored
- Unusual network activity logged
- Failed authentication attempts tracked
- Configuration changes audited
- Docker socket access monitored
- Telegram API errors investigated
- β Added comprehensive input validation
- β Implemented secure configuration file handling
- β Enhanced systemd security features
- β Improved error message security
- β Added process isolation features
- π Configuration encryption at rest
- π Enhanced audit logging
- π Rate limiting for API calls
- π Additional input validation
We recognize security researchers who responsibly disclose vulnerabilities:
No vulnerabilities reported yet - be the first to help improve security!
Currently no formal bounty program, but we recognize contributions:
- Public acknowledgment in security advisories
- GitHub contributor badge for security improvements
- Priority support for security-focused contributors
- ShellCheck - Static analysis for shell scripts
- Docker Bench - Docker security benchmark
- Lynis - Linux security auditing
- CIS Benchmarks - Security configuration guides
- Security Email: [Create a security@yourdomain email]
- GPG Key: [Consider adding a GPG key for encrypted reports]
- Response Team: Project maintainers
- Escalation: For critical issues requiring immediate attention
Last Updated: August 2024
Next Review: November 2024
This security policy will be updated as the project evolves and new security features are implemented.