Commit 850bd96
Add SECURITY.md and notes on PVR (#372)
## Summary
Adds a `SECURITY.md` file to the repository and documents best practices
for allowing others to report security problems.
## Changes
### Added `SECURITY.md`
- Provides guidance on how to report security vulnerabilities
- Uses GitHub's Private Vulnerability Reporting (PVR) as the primary
reporting method
- Includes a direct link to the vulnerability reporting form for ease of
use
- Retains contact details for general security enquiries
### Updated `practices/securing-repositories.md`
Added a new section "Allowing others to report security problems"
covering:
- Adding a `SECURITY.md` file to repositories
- Enabling Security advisories
- Enabling Private vulnerability reporting for public repositories
- Monitoring and acting on security advisories
Also links to this repository's `SECURITY.md` as a working example.
## Why
Public repositories should make it easy for security researchers and
users to report vulnerabilities privately. GitHub's Private
Vulnerability Reporting provides a low-friction, secure channel that
doesn't require external reporters to manage email or tokens — they just
need a GitHub account.
## Checklist
- [x] `SECURITY.md` added to repository root
- [x] Private vulnerability reporting enabled in repository settings
- [x] Documentation updated with guidance for other teams
---------
Co-authored-by: Alex Young <alex.young12@nhs.net>1 parent 0916f36 commit 850bd96
2 files changed
Lines changed: 34 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
| 12 | + | |
12 | 13 | | |
13 | 14 | | |
14 | 15 | | |
| |||
64 | 65 | | |
65 | 66 | | |
66 | 67 | | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
0 commit comments