Skip to content

Create SECURITY.md for vulnerability reporting #725

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

Closed
acornall wants to merge 1 commit into from
Closed

Create SECURITY.md for vulnerability reporting #725

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

If you have discovered a security vulnerability in this project, please report it
privately. **Do not disclose it as a public issue.** This gives us time to work with you
to fix the issue before public exposure, reducing the chance that the exploit will be
used before a patch is released.

Please submit reports via the [Report a vulnerability](https://github.com/veraPDF/veraPDF-validation/security/advisories/new) button.
Comment on lines +3 to +8
Copy link
Copy Markdown

@coderabbitai coderabbitai bot Mar 12, 2026

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion | 🟠 Major

Add a fallback private reporting channel.

Right now the policy only offers GitHub's advisory workflow. If a reporter cannot use GitHub or that flow is unavailable, there is no private path left for disclosure.

Proposed wording 
 If you have discovered a security vulnerability in this project, please report it
 privately. **Do not disclose it as a public issue.** This gives us time to work with you
 to fix the issue before public exposure, reducing the chance that the exploit will be
 used before a patch is released.
 
 Please submit reports via the [Report a vulnerability](https://github.com/veraPDF/veraPDF-validation/security/advisories/new) button.
+If you cannot use that workflow, please contact the maintainers through an alternate
+private channel (for example, a dedicated security email address).
📝 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
If you have discovered a security vulnerability in this project, please report it
privately. **Do not disclose it as a public issue.** This gives us time to work with you
to fix the issue before public exposure, reducing the chance that the exploit will be
used before a patch is released.
Please submit reports via the [Report a vulnerability](https://github.com/veraPDF/veraPDF-validation/security/advisories/new) button.
If you have discovered a security vulnerability in this project, please report it
privately. **Do not disclose it as a public issue.** This gives us time to work with you
to fix the issue before public exposure, reducing the chance that the exploit will be
used before a patch is released.
Please submit reports via the [Report a vulnerability](https://github.com/veraPDF/veraPDF-validation/security/advisories/new) button.
If you cannot use that workflow, please contact the maintainers through an alternate
private channel (for example, a dedicated security email address).
🧰 Tools
🪛 LanguageTool

[style] ~5-~5: Consider using a different verb for a more formal wording.
Context: ... This gives us time to work with you to fix the issue before public exposure, reduc...

(FIX_RESOLVE)

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@SECURITY.md` around lines 3 - 8, Update SECURITY.md to add a fallback private
reporting channel alongside the existing GitHub advisory link: keep the existing
paragraph and link text but append a sentence offering an alternative contact
method (e.g., a dedicated security@ or PGP-encrypted email address and
instructions for encryption) for reporters who cannot use GitHub; ensure the new
sentence references the current “Report a vulnerability” flow and provides
clear, brief instructions for using the fallback channel and any required
metadata (vulnerability summary, reproduction steps, contact preference).



Please provide the following information in your report:

- A description of the vulnerability and its impact
- How to reproduce the issue

Please allow us 90 days to work on a fix before public disclosure.