docs(security): add initial security policy#3290
Conversation
|
It fails without a changelog entry, but I think this applies (I see this as docs). >[!NOTE]
|
| - Vulnerabilities will be handled on a best-effort basis. | ||
| - You may request an advance copy of the patched release, but we cannot guarantee early access before the public release. | ||
| - You will be notified via email simultaneously with the public announcement. | ||
| - We will respond within a few weeks to confirm whether your report has been accepted or rejected. |
There was a problem hiding this comment.
I'd like to point out that bat comes with no warranty, and I don't want to make any promises about timeliness
I don't really think there is a problem with our current place and instruction found at https://github.com/sharkdp/bat?tab=readme-ov-file#security-vulnerabilities
There was a problem hiding this comment.
@Enselic Then we should just remove the last note /respond paragraph/ maybe. I don't see there are any obligations in this, on purpose. Best-effort means that doing nothing is an option too (no warranty). There is nothing wrong the current instruction you link too, but this community file is an idiomatic way (like I show with examples in the PR-text - ie both acknowledged by platforms like GitHub, and an end user would expect to look for this information, in a file with this name. )(SECURITY.md).
There was a problem hiding this comment.
As a first step we could put our current instruction in the separate file and get that merged
There was a problem hiding this comment.
I can update this PR suggestion with a PR which is a mix of the both and be careful to remove anything which even remotely implies any promises. (The We will respond... paragraph, or soften it even more... In most cases, we will .. friendly, but no promises?). Sound good?
There was a problem hiding this comment.
Lets first do it minimally
and to be honest I don't see the point of adding more info
if someone does not know how to write a security bug report, they probably should not
(If it's too easy we end up in https://daniel.haxx.se/blog/2025/07/14/death-by-a-thousand-slops/)
There was a problem hiding this comment.
I simplified it and rebased, now it is almost like the original information from the README. Please have a look.
|
Closing for now to keep PR inbox clean but we can keep discussing here if needed. |
9eceb9d to
19cf695
Compare
19cf695 to
ef4940d
Compare
Please have a look again:) |
Signed-off-by: Josef Andersson <janderssonse@proton.me>
ef4940d to
67fc0d9
Compare
Removed the thank you note for reporting vulnerabilities.
Enselic
left a comment
There was a problem hiding this comment.
thanks for the update, let's merge
This PR adds a SECURITY.md file, battle tested in other projects and orgs, (the construct is CCO ie public domain, for example from here https://raw.githubusercontent.com/itiquette/git-provider-sync/refs/heads/main/SECURITY.md so just reuse)
A SECURITY.md would help anyone assessing the project for use, give a hint of how it handles critical no public security issues, and give anyone a clear instruction on how to report them non public.
IE, for someone thinking about using bat in an organisation or privately it would give an extra trust factor.
This policy basically says "send your findings, and we will see if we handle them, we will notify you".
Besides, being a good FOSS practice, makes the project look more professional and it is heavily supported by GitHub https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file etc as one of the community health files, so it will pop up automatically in the ui for the end user.
Examples:

Security Tab in project front will be added automatically
Security Policy in the top right corner of UI will be added automatically
Security Policy under Security Overview for the project will have the Security Policy green and enabled.

NOTE: there is a <...> in the text, where the preferred channel for reporting should be added I left that for you, (or tell me what to add there, and I'll rebase with that).
NOTE: I had this in multiple orgs and projects over the years. Only once I had a report, so I dont think one should be worry about getting to much reports from this, this is at least my experience.