-
Notifications
You must be signed in to change notification settings - Fork 2
Create SECURITY.md Template #78
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.
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
Merged
reactive-firewall
merged 1 commit into
master
from
feature-add-a-template-security-policy
Nov 2, 2024
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # Security Policy (Template) | ||
|
|
||
| ## Supported Versions | ||
|
|
||
| We actively support the following versions of the project: | ||
|
|
||
| | Version | Supported | | ||
| | ------- | ------------------ | | ||
| | 1.x | :white_check_mark: | | ||
|
|
||
| ## Reporting a Vulnerability | ||
|
|
||
| If you discover a security vulnerability, we encourage you to report it as soon as possible. Please email us at [[email protected]](mailto:[email protected]) with a detailed description of the issue and any relevant proof of concept. We are committed to addressing all security concerns promptly. | ||
|
|
||
| ## Security Measures | ||
|
|
||
| - **Dependency Management**: Our project uses `requirements.txt` and `setup.py` for dependency management. We regularly review and update dependencies to patch known vulnerabilities, adhering to best practices in dependency hygiene. | ||
|
|
||
| - **Handling of Secrets**: The codebase does not contain hardcoded secrets such as passwords, API keys, or tokens. We recommend that all contributors use environment variables or secure configuration management tools to handle sensitive information. | ||
|
|
||
| - **Secure Coding Practices**: We follow custom coding standards, including **CEP-8** for Python and **CEP-5** for Bash scripts, to ensure code quality and security. These standards emphasize input validation, error handling, and adherence to the principle of least privilege. | ||
|
|
||
| - **Encryption and Cryptography**: While the current codebase does not implement encryption or decryption functionalities, any future cryptographic implementations will utilize well-vetted libraries and follow industry-standard algorithms to ensure data integrity and confidentiality. | ||
|
|
||
| - **Authentication and Authorization**: References to authentication mechanisms are minimal. Any future integration of authentication features will be designed with robust security protocols and regular audits. | ||
|
|
||
| ## Code Scanning and Continuous Integration | ||
|
|
||
| We employ tools such as `flake8`, `pytest`, and `tox` for continuous integration and static code analysis. These tools help us identify potential security issues early in the development process. | ||
|
|
||
| ## Security Updates | ||
|
|
||
| We are committed to promptly updating the project to address any security vulnerabilities. Users are encouraged to keep their versions up to date to benefit from the latest security enhancements. | ||
|
|
||
| ## Third-Party Dependencies | ||
|
|
||
| All third-party libraries and dependencies are sourced from trusted repositories. We closely monitor these dependencies for any reported vulnerabilities and apply patches as necessary. | ||
|
|
||
| ## Contact Information | ||
|
|
||
| For any security-related inquiries or to report a vulnerability, please contact us at [[email protected]](mailto:[email protected]). | ||
reactive-firewall marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.