Skip to content

Commit 10de35a

Browse files
docs: security.md (#356)
Co-authored-by: Florence Njeri <40742916+Florence-Njeri@users.noreply.github.com> Co-authored-by: Chan <bot+chan@asyncapi.io> Co-authored-by: Ashish Padhy <ashishpadhy1729@gmail.com>
1 parent dc96d61 commit 10de35a

1 file changed

Lines changed: 79 additions & 1 deletion

File tree

SECURITY.md

Lines changed: 79 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,79 @@
1-
In case you do not want to publicly report a security issue for one of the libraries owned by the AsyncAPI community, write an email with a detailed description of the issue to info@asyncapi.io.
1+
# AsyncAPI Security Policy
2+
3+
The AsyncAPI Initiative is committed to maintaining the security of our open source projects. We appreciate your efforts to responsibly disclose your findings and will make every effort to acknowledge your contributions. If you discover a vulnerability, follow the steps below to report it responsibly.
4+
5+
---
6+
7+
## Coordinated Vulnerability Disclosure
8+
9+
At AsyncAPI, we follow [coordinated vulnerability disclosure](https://en.wikipedia.org/wiki/Coordinated_vulnerability_disclosure). Please do not open a GitHub issue, do not notify us through any public channels, and do not disclose this issue to third parties. We respond promptly to security reports and appreciate your discretion.
10+
11+
---
12+
13+
## How to Report a Vulnerability
14+
15+
Use one of the following methods to report a vulnerability:
16+
17+
### GitHub Security Form
18+
19+
Submit a private report using GitHub's security advisory form: [Report a vulnerability](https://github.com/asyncapi/asyncapi/security/advisories/new)
20+
21+
This form allows you to privately share details with the maintainers. We'll use [GitHub Security Advisories](https://docs.github.com/en/code-security/security-advisories) to fix and publish information about the vulnerability once it is resolved.
22+
23+
### Email
24+
25+
Alternatively, send an email to: **security@asyncapi.com**
26+
27+
**Include the following in your report:**
28+
- A description of the vulnerability and how to reproduce it
29+
- Affected project and version
30+
- Steps to reproduce the issue
31+
- Potential impact
32+
- Any suggested fixes or mitigation
33+
34+
## Response Timeline
35+
36+
We aim to acknowledge all reports within 72 hours and provide an initial assessment within 5 business days.
37+
38+
## Resolution Timeline
39+
40+
The resolution time will depend on the severity and complexity of the vulnerability, and we will provide updates throughout the process.
41+
42+
## Incident Response Plan
43+
44+
Here's how we handle reported vulnerabilities:
45+
46+
1. **Acknowledge & Validation of the Issue**
47+
Each security report is acknowledged and reproduced by the security and project maintainers within 5 working days.
48+
49+
2. **Triage**
50+
Maintainers will assess the severity and impact the vulnerability has on AsyncAPI users and assign a rating to the issue, ranking from critical, high, medium, to low.
51+
52+
3. **Coordinate a Fix**
53+
We will assign the security issue to one of the security maintainers who will be in charge of coordinating the fix with the maintainers. We will also audit our codebases to find similar vulnerabilities elsewhere. The fix will also undergo thorough testing and code review to ensure the security vulnerability is fully resolved.
54+
55+
4. **Vulnerability Disclosure**
56+
Once the fix is ready and tested, we will create a **GitHub Security Advisory** (GHSA) in the affected repository. This advisory will include:
57+
58+
- **Vulnerability Description**: A clear explanation of the security issue, including how it could be exploited
59+
- **Affected Versions**: Specific versions of AsyncAPI components impacted by the vulnerability
60+
- **Severity Rating**: CVSS score and our internal severity classification (Critical/High/Medium/Low)
61+
- **CVE Assignment**: Request a Common Vulnerabilities and Exposures (CVE) identifier through GitHub's integration with MITRE
62+
- **Patched Versions**: The versions that contain the security fix
63+
- **Credit**: Acknowledgment of the security researcher who reported the issue with their consent
64+
65+
5. **Publish postmoterm doc**
66+
After the GitHub Security Advisory goes live, we will ensure all AsyncAPI users are informed by including the security patch details in the changelog of the affected project, publishing a security article explaining the vulnerability, impact, and required actions to mitigate this for all our users. Finally, we will make a post in the Slack announcements channel. Each notification will include a summary of the vulnerability, clear upgrade instructions, and links to patched versions.
67+
68+
6. **Learnings**
69+
We will document what went well and what we can do better in future incidents.
70+
71+
## Security Bug Bounty Program
72+
73+
AsyncAPI is an open source initiative maintained by the community. We currently **do not offer monetary bounties** for vulnerability disclosures. However, we deeply appreciate your contribution and may acknowledge your efforts publicly if you wish.
74+
75+
---
76+
77+
📝 **Note:** If you're contributing to AsyncAPI projects, follow secure coding practices and keep dependencies up to date. We regularly audit our codebase and generate SBOMs to ensure compliance and transparency.
78+
79+
---

0 commit comments

Comments
 (0)