Skip to content

Create SECURITY.md #188

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Create SECURITY.md #188

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
21 changes: 21 additions & 0 deletions SECURITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Security Policy

## Supported Versions

Use this section to tell people about which versions of your project are
currently being supported with security updates.

Comment on lines +5 to +7
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Replace placeholder guidance with a clear policy statement.

Current wording reads like a template. Make it explicit which releases get fixes.

-Use this section to tell people about which versions of your project are
-currently being supported with security updates.
+We provide security fixes only for the release lines listed below. Versions not listed are end‑of‑life and do not receive security updates.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Use this section to tell people about which versions of your project are
currently being supported with security updates.
We provide security fixes only for the release lines listed below. Versions not listed are end-of-life and do not receive security updates.
🧰 Tools
🪛 LanguageTool

[grammar] ~5-~5: There might be a mistake here.
Context: ...about which versions of your project are currently being supported with security ...

(QB_NEW_EN)

🤖 Prompt for AI Agents 
In SECURITY.md around lines 5 to 7, the current text is a placeholder template;
replace it with a concrete security maintenance policy specifying which release
lines receive security fixes (e.g., "We provide security fixes for the current
major release and the previous minor release for 12 months after their initial
release; critical/severe issues may receive extended support"), include how long
fixes are provided, which versions are supported (exact semantic versions or
branches), and where to report vulnerabilities; update the wording to a
definitive, actionable statement rather than a template sentence.

| Version | Supported |
| ------- | ------------------ |
| 5.1.x | :white_check_mark: |
| 5.0.x | :x: |
| 4.0.x | :white_check_mark: |
| < 4.0 | :x: |

## Reporting a Vulnerability

Use this section to tell people how to report a vulnerability.

Tell them where to go, how often they can expect to get an update on a
reported vulnerability, what to expect if the vulnerability is accepted or
declined, etc.
Comment on lines +15 to +21
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Provide concrete, private reporting instructions, SLAs, and safe‑harbor.

Reporting guidance is still template text. Add a private channel (GitHub security advisory and/or email), acknowledgement/fix timelines, what info to include, disclosure policy, and legal safe‑harbor. This materially improves researcher experience.

-## Reporting a Vulnerability
-
-Use this section to tell people how to report a vulnerability.
-
-Tell them where to go, how often they can expect to get an update on a
-reported vulnerability, what to expect if the vulnerability is accepted or
-declined, etc.
+## Reporting a Vulnerability
+
+Please do not open public issues for security reports.
+
+- Preferred: Open a private GitHub Security Advisory for this repository (Security → Advisories → Report a vulnerability).
+- Alternative: Email security@<your-domain> (PGP optional; see key below).
+
+We will:
+- Acknowledge receipt within 3 business days.
+- Provide an initial assessment or remediation ETA within 7 business days.
+- Credit reporters upon request after a fix is released.
+
+Please include: affected versions/commit, impact, reproduction steps or PoC, environment, and proposed severity (CVSS if available).
+
+## Coordinated Disclosure
+We ask for coordinated disclosure. We will agree on a public disclosure date once a fix or mitigation is available. Please avoid testing that could disrupt production or access data you do not own.
+
+## Safe Harbor
+We will not pursue legal action for good‑faith research that follows this policy and avoids privacy violations, data exfiltration, or service degradation. If you are unsure, contact us first.
+
+## Optional: PGP Key
+Fingerprint: <fill‑in>  
+Key: <URL or block>

If you prefer lighter wording, I can trim this to a shorter policy.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
## Reporting a Vulnerability
Use this section to tell people how to report a vulnerability.
Tell them where to go, how often they can expect to get an update on a
reported vulnerability, what to expect if the vulnerability is accepted or
declined, etc.
## Reporting a Vulnerability
Please do not open public issues for security reports.
- Preferred: Open a private GitHub Security Advisory for this repository (Security → Advisories → Report a vulnerability).
- Alternative: Email security@<your-domain> (PGP optional; see key below).
We will:
- Acknowledge receipt within 3 business days.
- Provide an initial assessment or remediation ETA within 7 business days.
- Credit reporters upon request after a fix is released.
Please include: affected versions/commit, impact, reproduction steps or PoC, environment, and proposed severity (CVSS if available).
## Coordinated Disclosure
We ask for coordinated disclosure. We will agree on a public disclosure date once a fix or mitigation is available. Please avoid testing that could disrupt production or access data you do not own.
## Safe Harbor
We will not pursue legal action for good-faith research that follows this policy and avoids privacy violations, data exfiltration, or service degradation. If you are unsure, contact us first.
## Optional: PGP Key
Fingerprint: <fill-in>
Key: <URL or block>