From 240494abdd6f7c7c7462512891f15f7c06173ef0 Mon Sep 17 00:00:00 2001 From: "David A. Wheeler" Date: Wed, 23 Aug 2023 14:01:08 -0400 Subject: [PATCH] Add SECURITY.md file This commit adds a SECURITY.md file, so panicked reporters will know how to report them. Since private reporting is enabled, I presume that's how this group wants the vulnerabilities reported. I also tweaked the README to point to it. Signed-off-by: David A. Wheeler --- README.md | 5 +++++ SECURITY.md | 8 ++++++++ 2 files changed, 13 insertions(+) create mode 100644 SECURITY.md diff --git a/README.md b/README.md index eedd12b8..f0874284 100644 --- a/README.md +++ b/README.md @@ -272,3 +272,8 @@ an external contributor could potentially exploit it to extract the PAT. The only benefit of a "classic" PAT is that it can be set to never expire. However, we believe this does not outweigh the significantly higher risk of "classic" PATs compared to fine-grained PATs. + +## Reporting vulnerabilities + +If you find a vulnerability, please report it to us! +See [SECURITY.md](./SECURITY.md) for more information. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 00000000..7792ddfa --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,8 @@ +# Security + +If you find a significant vulnerability, or evidence of one, +please report it privately. + +We prefer that you use the [GitHub mechanism for privately reporting a vulnerability](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability#privately-reporting-a-security-vulnerability). Under the +[main repository's security tab](https://github.com/coreinfrastructure/best-practices-badge/security), in the left sidebar, under "Reporting", click +Advisories, then click "Report a vulnerability" to open the advisory form.