Skip to content

Add RFC 9116 security.txt to docs.defectdojo.com - #15737

Merged
Maffooch merged 1 commit into
DefectDojo:bugfixfrom
devGregA:devgrega/security-txt
Aug 20, 2026
Merged

Add RFC 9116 security.txt to docs.defectdojo.com#15737
Maffooch merged 1 commit into
DefectDojo:bugfixfrom
devGregA:devgrega/security-txt

Conversation

@devGregA

@devGregA devGregA commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

Description

Adds /.well-known/security.txt (RFC 9116) to docs.defectdojo.com so security researchers can discover our disclosure channel mechanically. The file points at the HackerOne disclosure program and the SECURITY.md policy, matching the documented process.

The file lives in docs/static/.well-known/, so Hugo copies it to the site root and GitHub Pages serves it at https://docs.defectdojo.com/.well-known/security.txt as text/plain. Note the docs deploy workflow (gh-pages.yml) triggers on pushes to bugfix/master that touch docs/**, so this goes live when the PR merges; no manual publish step.

Notes for review:

  • Expires is mandatory per RFC 9116 and is set to 2027-08-01T00:00:00Z (the RFC recommends keeping it under a year out). It needs an annual bump; a reminder comment is baked into the file itself.
  • Canonical lists defectdojo.com first: the live marketing site 302s www to the apex, so the apex is the primary host. The www and docs URIs are also listed so retrieval from any of the three validates.
  • Contact is HackerOne only. GitHub private vulnerability reporting is disabled on this repo (the security/advisories/new URL would dead-end researchers), and SECURITY.md documents advisories as something maintainers create after HackerOne triage.
  • A byte-identical copy will be served on defectdojo.com (HubSpot File Manager upload plus a URL redirect, tracked in the marketing theme repo).

Test results

  • Built the docs site locally with Hugo and confirmed public/.well-known/security.txt is emitted with the exact file content, i.e. the doks module mounts do copy the dot-directory from static/.
  • The "Docs: Dry Run Production Deployment" check on this PR runs the exact production build (Hugo 0.153.4).
  • The gh-pages branch already carries .nojekyll (added by peaceiris/actions-gh-pages), so GitHub Pages serves dot-directories as-is; fonts/ and svgs/ from the same docs/static/ mount are already live on the deployed branch.

Documentation

The added file is the deliverable; no docs content pages changed.

🤖 Generated with Claude Code

Serve /.well-known/security.txt from the docs site via Hugo's static dir.
Points researchers at the HackerOne disclosure program and the published
security policy. The Expires field is mandatory per RFC 9116 and needs an
annual refresh; a reminder comment is baked into the file.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@github-actions github-actions Bot added the docs label Aug 19, 2026
@Maffooch Maffooch added this to the 3.3.200 milestone Aug 19, 2026
@Maffooch
Maffooch added this pull request to the merge queue Aug 19, 2026
Merged via the queue into DefectDojo:bugfix with commit 946cbba Aug 20, 2026
30 checks passed
@Maffooch
Maffooch deleted the devgrega/security-txt branch August 20, 2026 00:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants