Skip to content

Commit 9cc5c51

Browse files
authored
docs: add SECURITY.md with vulnerability disclosure policy (#651)
* docs: add SECURITY.md with vulnerability disclosure policy * docs: revert table formatting as per review * docs: revert supported versions table to original format
1 parent 4a8b9a4 commit 9cc5c51

1 file changed

Lines changed: 26 additions & 16 deletions

File tree

SECURITY.md

Lines changed: 26 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,18 @@
22

33
## Supported Versions
44

5-
The following versions of **DevCard** are currently supported with security updates:
5+
## Supported Versions
66

77
| Version | Supported |
88
| ------- | ------------------ |
99
| main | ✅ Yes |
1010

1111
## Reporting a Vulnerability
1212

13-
If you discover a security vulnerability in **DevCard**, please **do not open a public issue**.
14-
15-
Instead, report it responsibly by:
13+
Please report via **GitHub Private Security Advisory**:
14+
[Report here](https://github.com/Dev-Card/DevCard/security/advisories/new)
1615

17-
- 📧 Reaching out to the maintainer directly via their [GitHub profile](https://github.com/Dev-Card)
18-
- 💬 Sending a private message through GitHub's messaging or social links listed in the profile
16+
**Do NOT open a public issue for security vulnerabilities.**
1917

2018
### What to include in your report:
2119
- A clear description of the vulnerability
@@ -25,18 +23,30 @@ Instead, report it responsibly by:
2523

2624
## Response Timeline
2725

28-
| Action | Timeframe |
29-
| ----------------------------- | ----------------- |
30-
| Acknowledgement of report | Within 48 hours |
31-
| Status update | Within 7 days |
32-
| Patch / fix release | Within 30 days |
26+
- Acknowledgement: within 48–72 hours
27+
- Status update: within 7 days
28+
- Patch / fix release: within 30 days
29+
30+
## In Scope
31+
- Authentication bypass
32+
- Sensitive data exposure via API endpoints
33+
- XSS in profile/card rendering
34+
- Unauthorized access to user contact data
35+
36+
## Out of Scope
37+
- Rate limiting / brute force without impact
38+
- Spam or social engineering
39+
- Issues in third-party dependencies (report upstream)
3340

3441
## Responsible Disclosure
3542

36-
We follow a **responsible disclosure** policy. Please give us adequate time to patch the issue before any public disclosure. We deeply appreciate security researchers who help keep **DevCard** safe. 🙏
43+
Please give us adequate time to patch the issue before any public disclosure.
44+
We deeply appreciate security researchers who help keep **DevCard** safe. 🙏
3745

38-
## References
46+
## Acknowledgements
47+
48+
Responsible reporters will be credited in release notes (with permission).
3949

40-
- [DevCard Repository](https://github.com/Dev-Card/DevCard)
41-
- [GitHub Security Advisories](https://docs.github.com/en/code-security/security-advisories)
42-
- [Adding a Security Policy to your repo](https://docs.github.com/en/code-security/getting-started/adding-a-security-policy-to-your-repository)
50+
## References
51+
- [GitHub Security Advisories Docs](https://docs.github.com/en/code-security/security-advisories)
52+
- [Adding a Security Policy](https://docs.github.com/en/code-security/getting-started/adding-a-security-policy-to-your-repository)

0 commit comments

Comments
 (0)