Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add SECURITY.md to outline the security policy and reporting guidelines. #2

Merged
merged 1 commit into from
Sep 1, 2024
Merged

Add SECURITY.md to outline the security policy and reporting guidelines. #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions SECURITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Security Policy

## Supported Versions

We release patches for security vulnerabilities affecting supported versions of the project. Our current policy is:

| Version | Supported |
| ------- | ------------------ |
| 1.0.x | :white_check_mark: |
| < 1.0 | :x: |

## Reporting a Vulnerability

We take all security vulnerabilities seriously. If you discover a security issue, please report it to us privately. Do not create a public issue. Here’s how you can report a security vulnerability:

1. **Email us directly at**: [[email protected]](mailto:[email protected])
2. Provide a detailed description of the vulnerability, including steps to reproduce it.
3. Include any relevant logs or screenshots that can help in identifying and solving the issue.

## Handling Security Issues

1. **Acknowledgment**: We will acknowledge the receipt of your report within 48 hours and communicate with you to understand and validate the issue.
2. **Assessment**: We will conduct a thorough assessment of the vulnerability to determine its impact and the urgency of the fix.
3. **Resolution**: We aim to resolve critical security issues within 7 days. After the resolution, we will issue a patch and update the affected parties.
4. **Disclosure**: Once a fix is implemented, we will publicly disclose the nature of the vulnerability and encourage users to update to the patched version.

## Best Practices for Users

1. **Keep your software updated**: Always use the latest version of `gin-host-route` to ensure you have the latest security patches and improvements.
2. **Review and Audit**: Regularly review and audit the dependencies of your project for potential vulnerabilities.
3. **Limit Scope**: Follow the principle of least privilege by limiting the scope of access and permissions of applications using this library.

## Public Disclosure

We believe in responsible disclosure and will work with researchers and users to ensure vulnerabilities are patched before any details are released. We appreciate your cooperation in keeping our library secure.

## Contact

If you have any questions or need further information regarding our security policy, do not hesitate to contact us at [[email protected]](mailto:[email protected]).

Thank you for helping us keep `gin-host-route` secure.
Loading