-
Notifications
You must be signed in to change notification settings - Fork 90
Update SECURITY.md #5231
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Update SECURITY.md #5231
Conversation
The Security Council has approved a new SECURITY.md aligned with the bug-bounty process. Please update your project’s SECURITY.md with the correct links for your project and confirm that private vulnerability reporting is enabled for your repository. All bug bounty details found here: https://opensourcecommittee.docs.intersectmbo.org/about/paid-open-source-model-posm/bug-bounty-program' opensourcecommittee.docs.intersectmbo.org
| Please report (suspected) security vulnerabilities to [email protected]. You will receive a | ||
| response from us within 48 hours. If the issue is confirmed, we will release a patch as soon | ||
| as possible. | ||
| The Cardano open source project (xxx) is committed to ensuring the security of |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you mean:
| The Cardano open source project (xxx) is committed to ensuring the security of | |
| The Cardano open source project `ouroboros-network` is committed to ensuring the security of |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes
| * any workarounds or mitigations | ||
| ### Reporting a Vulnerability | ||
|
|
||
| If you discover a security vulnerability in xxxx, we encourage you to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| If you discover a security vulnerability in xxxx, we encourage you to | |
| If you discover a security vulnerability in `ouroboros-network`, we encourage you to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes
| If you discover a security vulnerability in xxxx, we encourage you to | ||
| responsibly disclose it to us. To report a vulnerability, please use | ||
| the [private reporting form on | ||
| GitHub](https://github.com/input-output-hk/mithril/security/advisories/new) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We certainly shouldn't use input-output-hk/mithril. What I suggest below is also wrong since it's 404:
| GitHub](https://github.com/input-output-hk/mithril/security/advisories/new) | |
| GitHub](https://github.com/IntersectMBO/ouroboros-network/security/advisories/new) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes its for use to something applicable to yall's project left mithril there as reference
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The link I posted is 404, and there's no way to create a new advisory in the ouroboros-network repo. You'll need to configure it correctly.
|
|
||
| - A description of the vulnerability and its potential impact. | ||
| - Steps to reproduce the vulnerability. | ||
| - The version of `xxxx` package where the vulnerability exists. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| - The version of `xxxx` package where the vulnerability exists. | |
| - The name and version of one of the packages in `ouroboros-network` repository where the vulnerability exists. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes
| To report a security vulnerability, please use [GitHub | ||
| form]((add project github form for your project)). Should you experience any issues reporting via GitHub or have other questions, Please contact [Security]([email protected]). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The link is invalid. What should it be? Should it link to ouroboros-network advisory, cardano-node advisory?
It should be done consistently across all cardano-node repos.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
does it serve best as project specific or meta project specific
|
|
||
| This Security Vulnerability Disclosure Policy may be updated or | ||
| revised as necessary. Please check the latest version of this policy | ||
| on the [xxxx repository]((add link for your project)). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please fix the link.
|
|
||
| ## Conclusion | ||
|
|
||
| The xxxx project greatly appreciates the assistance of the security |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| The xxxx project greatly appreciates the assistance of the security | |
| The `ouroboros-network` project greatly appreciates the assistance of the security |
The Security Council has approved a new SECURITY.md aligned with the bug-bounty process. Please update your project’s SECURITY.md with the correct links for your project and confirm that private vulnerability reporting is enabled for your repository. All bug bounty details found here:
https://opensourcecommittee.docs.intersectmbo.org/about/paid-open-source-model-posm/bug-bounty-program'
opensourcecommittee.docs.intersectmbo.org
Description
reasonably detailed description of the pull request
Checklist
Quality
Maintenance
ouroboros-networkproject.