Add RFC 9116 security.txt to static/.well-known/#599
Conversation
Adds a machine-discoverable security contact at /.well-known/security.txt, served by Hugo from static/. Points to the existing security mailbox (security@lists.valkey.io) and the project's security policy. Includes the RFC 9116-mandatory Expires field. Assisted by an AI tool; every line verified by me against the live site and SECURITY.md. Signed-off-by: Kobi Hikri <kobi.hikri@gmail.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughChangesSecurity Metadata
Suggested reviewers: Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
| Filename | Overview |
|---|---|
| static/.well-known/security.txt | Adds the RFC 9116 security contact file; the policy URL may need to match the site's existing direct policy link. |
Reviews (1): Last reviewed commit: "Add RFC 9116 security.txt to static/.wel..." | Re-trigger Greptile
| Expires: 2027-07-14T00:00:00.000Z | ||
| Preferred-Languages: en | ||
| Canonical: https://valkey.io/.well-known/security.txt | ||
| Policy: https://github.com/valkey-io/valkey/security/policy |
There was a problem hiding this comment.
If GitHub does not expose this repository's security policy through the /security/policy UI route, researchers following the published Policy field can land on a missing or generic page instead of the actual disclosure policy. The site already links its security policy directly to the repository SECURITY.md, so using that same target avoids a broken policy reference in security.txt.
|
What this does
Adds
/.well-known/security.txtto the site by placing it instatic/.well-known/security.txt, which Hugo copies verbatim to the published site root.Why
RFC 9116 defines a small, standard file at
/.well-known/security.txtso a security researcher can find where to report a vulnerability without guessing. Right now the live file is missing:The project already has a security contact — I just pointed the file at the existing mailbox and policy rather than inventing anything:
Contact: mailto:security@lists.valkey.io(fromSECURITY.mdin this repo)Policy: https://github.com/valkey-io/valkey/security/policyExpires:— RFC 9116 requires this field; I set it ~1 year out.Verifying it will serve
static/is already served verbatim — for examplestatic/img/IconGithub.svgis live athttps://valkey.io/img/IconGithub.svg(200). Hugo copies dot-directories understatic/too, sostatic/.well-known/security.txtwill publish athttps://valkey.io/.well-known/security.txt. Please double-check on a preview build.Single file, no other changes. Commit is DCO signed-off.
Disclosure: I used an AI tool to help spot this and draft the file. I verified every line myself against the live site and this repo's
SECURITY.md, and I take responsibility for the change. Happy to adjust theExpiresdate, contact, or policy link to whatever the maintainers prefer.