Skip to content

docs: add security policy - #7011

Open
snehasaisneha wants to merge 2 commits into
mainfrom
sneha/security-md
Open

docs: add security policy#7011
snehasaisneha wants to merge 2 commits into
mainfrom
sneha/security-md

Conversation

@snehasaisneha

@snehasaisneha snehasaisneha commented Jul 30, 2026

Copy link
Copy Markdown
Member

Summary

Adds a SECURITY.md covering private vulnerability reporting, scope, research guidelines, and Loculus's current unversioned support model. GitHub private vulnerability reporting is the primary channel, with contacting a team member as fallback.

Documentation-only; no runtime behavior changes.

Resolves #6997

🚀 Preview: Add preview label to enable

@snehasaisneha snehasaisneha self-assigned this Jul 30, 2026
@snehasaisneha
snehasaisneha marked this pull request as ready for review July 30, 2026 10:58
@claude

claude Bot commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

Claude finished @snehasaisneha's task in 44s —— View job


Review complete

  • Read SECURITY.md
  • Checked for cross-references (README, CONTRIBUTING) — none exist and none are needed; GitHub surfaces SECURITY.md automatically in the repo's Security tab
  • Posted inline feedback

Summary

This is a clear, well-structured SECURITY.md. It covers reporting channel, expected report contents, disclosure expectations, the unversioned support model, scope, out-of-scope items, and research guidelines — good coverage for a project at this stage. No runtime code is touched, so there's no functional risk.

Two non-blocking items left as inline comments, both about content accuracy rather than the doc's writing:

  1. Line 9 — the private vulnerability reporting link only works if that GitHub feature is actually enabled for this repo; worth confirming in repo settings.
  2. Line 11 — worth double-checking the loculus.org/#team anchor still resolves, since it's the fallback contact path if the form is unavailable.

Nothing else stood out — the out-of-scope and research-guidelines sections are sensible and match common industry practice (e.g. GitHub's own bug bounty scope language).

Comment thread SECURITY.md
Comment thread SECURITY.md
Comment thread SECURITY.md
- Issues in software, services, infrastructure, or protocols that are not under
the Loculus project's control
- Attacks that require physical access to a user's device
- Self-XSS

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

maybe lets add social engineering attacks

Comment thread SECURITY.md
maintained version
- Vulnerabilities in an upstream dependency that have already been reported to the
upstream maintainer and do not introduce a Loculus-specific vulnerability
- Issues in software, services, infrastructure, or protocols that are not under

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Im not sure about this - potentially we would still like to know if we are using a tool (software, services, infrastructure, ...) with a known vulnerability - like I would hope github would figure it out and let us know but maybe there could be an edge case here

@snehasaisneha snehasaisneha Jul 30, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Hmm but would that be a security vulnerability or a regular GH Issue?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Yeah maybe I would for jow remove the out of scope part as this is only useful if we get overwhelmed with useless reports. We can do that once that happens

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yes, I think for now, I'd also tend to leaving out the out of scope section and add it only if we get too many reports.

@anna-parker anna-parker left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good to me - but maybe others would also like to take a closer look before merging!

@corneliusroemer corneliusroemer left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Good stuff, thank! I might cut the "out of scope part" for now and add an email address like our security channel slack email address so people don't have to hunt for one.

Comment thread SECURITY.md

Please report suspected vulnerabilities through
[GitHub's private vulnerability reporting form](https://github.com/loculus-project/loculus/security/advisories/new).
If the form is unavailable to you, contact a

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I would give an email address here - maybe the slack security channel email address 😀

Comment thread SECURITY.md
maintained version
- Vulnerabilities in an upstream dependency that have already been reported to the
upstream maintainer and do not introduce a Loculus-specific vulnerability
- Issues in software, services, infrastructure, or protocols that are not under

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Yeah maybe I would for jow remove the out of scope part as this is only useful if we get overwhelmed with useless reports. We can do that once that happens

@corneliusroemer

corneliusroemer commented Jul 30, 2026 via email

Copy link
Copy Markdown
Contributor

Comment thread SECURITY.md
Loculus is currently unversioned and under active development while we work
towards a versioning system. Security fixes are applied to the `main` branch;
older revisions are not separately maintained. Operators should deploy a recent
revision and update promptly when a security fix is published.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Do we have any mechanism for an operator to subscribe to security updates? If not, should we add a sentence about us welcoming Loculus admins to reach out to us if they are maintaining a Loculus instance? This way and for now, we can ensure that operators are informed about any issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add SECURITY.md on how to disclose vulnerabilities

4 participants