Skip to content

Security: tatanus/pentest_setup

Security

.github/SECURITY.md

Security Policy

Supported Versions

The following versions of the project are actively supported for security updates:

Version Supported
v1.x ✅ Fully supported
<v1.0 ❌ No longer supported

Please ensure you're using the latest version of the project to receive the most up-to-date security fixes.


Reporting a Vulnerability

If you discover a security vulnerability in the project, please follow these steps:

  1. Do not disclose the vulnerability publicly.
    • Report it directly to the maintainers so a fix can be developed before disclosure.
  2. Submit a private report:
  3. Wait for acknowledgment:
    • You should receive confirmation within 3 business days. If you don’t, please follow up.

Vulnerability Disclosure Process

  1. Upon receiving a report, the maintainers will:

    • Confirm the vulnerability.
    • Investigate and develop a fix or mitigation.
  2. Once a fix is ready:

    • The reporter will be notified.
    • A patch or release will be prepared.
    • Security advisories will be drafted.
  3. Public disclosure:

    • The vulnerability will be disclosed publicly alongside the fix, after a reasonable grace period to allow users to update.

Security Best Practices for Contributors

To help keep the project secure, contributors should follow these practices:

  1. Validate Inputs:

    • Always sanitize and validate user inputs to prevent injection vulnerabilities.
  2. Principle of Least Privilege:

    • Avoid running scripts or code with unnecessary privileges.
  3. Protect Secrets:

    • Never hardcode sensitive information (e.g., credentials, tokens, API keys).
    • Use environment variables or secret managers.
  4. Static Analysis / Linters:

    • Run project-specific security tools before submitting contributions.
    • For Bash projects, this includes:
      shellcheck --shell=bash --external-sources -x -S style -f gcc <script.sh>
      shfmt -i 4 -ci -bn -kp -sr -ln bash -d .
  5. Secure Storage:

    • Encrypt sensitive files and data at rest, or store them in secure locations only.

Contact

For additional security concerns or questions, please contact:

  • Email: <security@project.org>
  • GitHub Issues: Use the Issues tab for non-sensitive reports only.

There aren’t any published security advisories