Skip to content

Commit 9aaffc2

Browse files
committed
Add security policy
Signed-off-by: Dan Barr <[email protected]>
1 parent d272833 commit 9aaffc2

File tree

2 files changed

+83
-1
lines changed

2 files changed

+83
-1
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ unacceptable behavior to
2828
If you think you have found a security vulnerability in the Stacklok Docs
2929
website, please DO NOT disclose it publicly until we've had a chance to fix it.
3030
Please don't report security vulnerabilities using GitHub issues; instead,
31-
please follow this [process](SECURITY.MD).
31+
please follow this [process](SECURITY.md).
3232

3333
## How to contribute
3434

SECURITY.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# Security Policy
2+
3+
Stacklok takes security seriously! We appreciate your efforts to disclose your
4+
findings responsibly and will make every effort to acknowledge your
5+
contributions.
6+
7+
## Reporting a vulnerability
8+
9+
To report a security issue, please use the GitHub Security Advisory
10+
["Report a Vulnerability"](https://github.com/stacklok/docs-website/security/advisories/new)
11+
tab.
12+
13+
If you are unable to access GitHub you can also email us at
14+
15+
16+
When reporting a vulnerability, please include:
17+
18+
- Steps to reproduce the issue
19+
- Description of the potential impact
20+
- Any additional context that would help us understand the issue
21+
22+
If you are only comfortable sharing under GPG, please start by sending an email
23+
requesting a public PGP key to use for encryption.
24+
25+
### Contacting the Stacklok security team
26+
27+
Contact the team by sending email to
28+
29+
30+
## About this project
31+
32+
This repository contains a documentation website built with Docusaurus. Security
33+
vulnerabilities in this context are most likely to come from:
34+
35+
- Upstream dependencies (Node.js packages, Docusaurus framework)
36+
- Build and deployment pipeline issues
37+
- Content injection or cross-site scripting vulnerabilities
38+
- Infrastructure or hosting configuration issues
39+
40+
## Disclosure process
41+
42+
Stacklok follows a responsible disclosure model for handling security
43+
vulnerabilities.
44+
45+
### Private disclosure
46+
47+
We prefer that suspected vulnerabilities be reported privately to allow us time
48+
to investigate and address the issue before public disclosure.
49+
50+
### Public disclosure
51+
52+
If you become aware of a publicly disclosed security vulnerability that affects
53+
this documentation website, please email
54+
[[email protected]](mailto:[email protected]) immediately so we can
55+
assess the impact and take appropriate action.
56+
57+
## Response process
58+
59+
When a vulnerability is reported:
60+
61+
1. **Acknowledgment**: We will acknowledge receipt of your report within 2
62+
business days
63+
2. **Assessment**: Our security team will assess the vulnerability and determine
64+
its impact
65+
3. **Resolution**: We will work to address the issue, which may involve:
66+
- Updating dependencies
67+
- Modifying configuration
68+
- Coordinating with upstream projects
69+
- Implementing workarounds or mitigations
70+
4. **Communication**: We will keep you informed of our progress and notify the
71+
community as appropriate
72+
73+
For vulnerabilities in upstream dependencies, our response timeline may depend
74+
on fixes being available from the upstream maintainers.
75+
76+
## Community notification
77+
78+
Significant security updates will be communicated through:
79+
80+
- GitHub Security Advisories
81+
- Updates to this documentation
82+
- The [Stacklok Discord Server](https://discord.gg/stacklok)

0 commit comments

Comments
 (0)