Use this section to tell people about which versions of your project are currently being supported with security updates.
Version | Supported |
---|---|
1.0.x | ✅ |
We take the security of FreePenGateway seriously. If you believe you've found a security vulnerability, please follow these steps:
- Do not disclose the vulnerability publicly until it has been addressed by the maintainers.
- Email the details to [email protected] with the subject "FreePenGateway Security Vulnerability".
- Include the following information in your report:
- Description of the vulnerability
- Steps to reproduce the issue
- Potential impact
- Any suggestions for remediation if you have them
The maintainers will acknowledge your email within 48 hours and provide a detailed response about the next steps in handling your report. After the initial reply, the maintainers will keep you informed about the progress towards a fix and full announcement.
When deploying FreePenGateway, consider the following security best practices:
- Deploy behind a firewall: Restrict access to the application to only necessary IP addresses and ports.
- Use a reverse proxy: Consider placing the application behind a dedicated reverse proxy like Nginx or Apache for additional security layers.
- Network segmentation: Deploy in a segmented network environment to limit lateral movement in case of a breach.
- Keep the host system updated: Regularly apply security patches to the operating system and all installed software.
- Minimize installed packages: Only install necessary software on the host system.
- Use secure configurations: Follow security benchmarks like CIS (Center for Internet Security) for your operating system.
- Use HTTPS: Always use HTTPS in production with a valid SSL certificate.
- Implement authentication: Add authentication if the gateway is not intended for public use.
- Configure proper logging: Enable comprehensive logging and regularly review logs for suspicious activities.
- Set appropriate permissions: Ensure the application runs with the minimum necessary permissions.
- Implement monitoring: Set up monitoring for unusual traffic patterns or system behavior.
- Create an incident response plan: Have a plan in place for responding to security incidents.
- Regular security assessments: Conduct periodic security assessments of your deployment.
FreePenGateway includes several security features:
- HTTPS Redirection: All HTTP requests are automatically redirected to HTTPS.
- HTTP Strict Transport Security (HSTS): Ensures browsers always use HTTPS for future requests.
- Rate Limiting: Prevents abuse by limiting the number of requests from a single IP address.
- Security Headers: Implements various security headers to protect against common web vulnerabilities:
- Content-Security-Policy
- X-Content-Type-Options
- X-Frame-Options
- X-XSS-Protection
- Referrer-Policy
- Forwarded Headers Processing: Properly handles forwarded headers for accurate client IP detection.
- The application does not currently implement authentication or authorization.
- There is no built-in mechanism for IP allowlisting/blocklisting.
- The application does not perform content inspection of proxied traffic.
Security updates will be announced through:
- GitHub releases and release notes
- Updates to the SECURITY.md file
- Notifications to registered users (if applicable)
FreePenGateway relies on the following major dependencies:
- ASP.NET Core: Microsoft's web framework
- YARP: Microsoft's reverse proxy library
It's recommended to regularly check for updates to these dependencies and apply them promptly.