NostrGator takes security seriously. We are committed to providing a secure, reliable, and trustworthy Nostr infrastructure solution. This document outlines our security practices, vulnerability reporting process, and supported versions.
We provide security updates for the following versions:
| Version | Supported |
|---|---|
| 1.0.x | β Yes |
| < 1.0 | β No |
- GitHub Security Scanning: Automated CodeQL analysis for code vulnerabilities
- Dependabot Alerts: Automatic dependency vulnerability detection
- Regular Updates: Prompt security patches and dependency updates
- Security Audits: Regular review of code and configurations
- Localhost-Only Binding: All services bound to localhost by default
- Rate Limiting: API endpoints protected against abuse and DoS attacks
- Input Validation: Proper validation and sanitization of all inputs
- Error Handling: Secure error handling that doesn't expose sensitive information
- Container Security: Docker containers run with minimal privileges
- TLS/SSL Ready: HTTPS support for production deployments
- Tor Integration: Anonymous federation capabilities
- Firewall Friendly: Configurable port bindings for network security
- No External Dependencies: Core functionality works without internet access
- Local Storage: All data stored locally under user control
- Encryption Support: NIP-04 encrypted direct messages
- Backup Security: Secure backup and restore procedures
- Privacy by Design: Minimal data collection and retention
If you discover a security vulnerability in NostrGator, please report it responsibly:
For Critical/High Severity Issues:
- Email: [security@nostrgator.example.com] (to be configured)
- Subject: "SECURITY: [Brief Description]"
- Encryption: Use our PGP key if available
For Medium/Low Severity Issues:
- GitHub Security Advisories: Use GitHub's private vulnerability reporting
- GitHub Issues: Create an issue with the "security" label
Please include the following information in your report:
- Vulnerability Description: Clear description of the issue
- Impact Assessment: Potential impact and severity
- Reproduction Steps: Detailed steps to reproduce the vulnerability
- Affected Components: Which services or files are affected
- Suggested Fix: If you have ideas for remediation
- Disclosure Timeline: Your preferred disclosure timeline
- Acknowledgment: We'll acknowledge receipt within 24 hours
- Initial Assessment: We'll provide an initial assessment within 72 hours
- Investigation: We'll investigate and develop a fix
- Coordination: We'll coordinate disclosure timing with you
- Release: We'll release a security update and advisory
- Recognition: We'll credit you in our security acknowledgments (if desired)
- Keep Updated: Always use the latest version of NostrGator
- Secure Environment: Run on a secure, updated operating system
- Network Security: Use firewalls and secure network configurations
- Backup Security: Encrypt backups and store them securely
- Key Management: Protect your Nostr private keys
- Monitor Logs: Regularly check logs for suspicious activity
- Code Review: All code changes require security review
- Dependency Management: Keep dependencies updated and secure
- Input Validation: Validate and sanitize all inputs
- Error Handling: Don't expose sensitive information in errors
- Logging: Log security events without exposing sensitive data
- Testing: Include security testing in development process
- Principle of Least Privilege: Run services with minimal required permissions
- Network Isolation: Isolate NostrGator from other services when possible
- Monitoring: Implement security monitoring and alerting
- Backup Strategy: Regular, secure backups with tested restore procedures
- Incident Response: Have a plan for security incidents
NostrGator includes built-in rate limiting:
- API Endpoints: 100 requests per 15 minutes per IP
- Verification Requests: 20 requests per 5 minutes per IP
- Customizable: Adjust limits in configuration files
- Pubkey Whitelisting: Control who can publish to your relays
- Admin Authentication: Secure admin interfaces
- CORS Configuration: Proper cross-origin request handling
- Prometheus Metrics: Security-related metrics and alerts
- Health Checks: Automated health monitoring
- Log Analysis: Structured logging for security analysis
We thank the following security researchers and contributors:
- GitHub Security Team: For providing excellent security scanning tools
- Dependabot: For automated dependency vulnerability detection
- Open Source Community: For responsible disclosure and security contributions
[This section will be updated as we receive security reports and contributions]
For security-related questions or concerns:
- General Security Questions: Create a GitHub Discussion
- Vulnerability Reports: Follow the reporting process above
- Security Documentation: Contribute via pull requests
- Vulnerability Identified: Through scanning or reports
- Assessment: Evaluate severity and impact
- Fix Development: Develop and test security fix
- Release: Create security release with advisory
- Communication: Notify users through multiple channels
- GitHub Releases: Security advisories and release notes
- GitHub Security Advisories: Detailed vulnerability information
- Documentation: Updated security documentation
- Community: Announcements in Nostr community channels
We are committed to:
- Transparency: Open communication about security issues
- Responsiveness: Quick response to security reports
- Continuous Improvement: Regular security enhancements
- Community Safety: Protecting our users and the broader Nostr ecosystem
Thank you for helping keep NostrGator secure! π
Last updated: September 2025