|
1 | | -# Hyperledger Security Policy |
| 1 | +# Hyperledger Indy Security Policy |
2 | 2 |
|
3 | | -## Reporting a Security Bug |
| 3 | +[Hyperledger security vulnerability disclosure policy]: /governing-documents/security.md |
4 | 4 |
|
5 | | -If you think you have discovered a security issue in any of the Hyperledger projects, we'd love to hear from you. We will take all security bugs seriously and if confirmed upon investigation we will patch it within a reasonable amount of time and release a public security bulletin discussing the impact and credit the discoverer. |
| 5 | +## About this document |
6 | 6 |
|
7 | | -There are two ways to report a security bug. The easiest is to email a description of the flaw and any related information (e.g. reproduction steps, version) to [security at hyperledger dot org ](mailto:[email protected]). |
| 7 | +This document defines how security vulnerability reporting is handled in the |
| 8 | +Hyperledger Indy project. The approach aligns with the [Hyperledger |
| 9 | +Foundation's Security Vulnerability Reporting |
| 10 | +policy](https://toc.hyperledger.org/governing-documents/security.html). Please |
| 11 | +review that document to understand the basis of the security reporting for |
| 12 | +Hyperledger Indy. |
8 | 13 |
|
9 | | -The other way is to file a confidential security bug in our [JIRA bug tracking system](https://jira.hyperledger.org). Be sure to set the “Security Level” to “Security issue”. |
| 14 | +The Hyperledger Security Vulnerability policy borrows heavily from the |
| 15 | +recommendations of the OpenSSF Vulnerability Disclosure working group. For |
| 16 | +up-to-date information on the latest recommendations related to vulnerability |
| 17 | +disclosures, please visit the [GitHub of that working |
| 18 | +group](https://github.com/ossf/wg-vulnerability-disclosures). |
10 | 19 |
|
11 | | -The process by which the Hyperledger Security Team handles security bugs is documented further in our [Defect Response page](https://wiki.hyperledger.org/display/HYP/Defect+Response) on our [wiki](https://wiki.hyperledger.org). |
| 20 | +If you are already familiar with the security policies of Hyperledger Indy, and |
| 21 | +ready to report a vulnerability, please jump to [Report |
| 22 | +Intakes](#report-intakes). |
| 23 | + |
| 24 | +## Outline |
| 25 | + |
| 26 | +This document has the following sections: |
| 27 | + |
| 28 | +- [Hyperledger Indy Security Policy](#hyperledger-indy-security-policy) |
| 29 | + - [About this document](#about-this-document) |
| 30 | + - [Outline](#outline) |
| 31 | + - [What Is a Vulnerability Disclosure Policy?](#what-is-a-vulnerability-disclosure-policy) |
| 32 | + - [Security Team](#security-team) |
| 33 | + - [Discussion Forums](#discussion-forums) |
| 34 | + - [Report Intakes](#report-intakes) |
| 35 | + - [CNA/CVE Reporting](#cnacve-reporting) |
| 36 | + - [Embargo List](#embargo-list) |
| 37 | + - [(GitHub) Security Advisories](#github-security-advisories) |
| 38 | + - [Private Patch Deployment Infrastructure](#private-patch-deployment-infrastructure) |
| 39 | + |
| 40 | +## What Is a Vulnerability Disclosure Policy? |
| 41 | + |
| 42 | +No piece of software is perfect. All software (at least, all software of a |
| 43 | +certain size and complexity) has bugs. In open source development, members of |
| 44 | +the community or the public find bugs and report them to the project. A |
| 45 | +vulnerability disclosure policy explains how this process functions from the |
| 46 | +perspective of the project. |
| 47 | + |
| 48 | +This vulnerability disclosure policy explains the rules and guidelines for |
| 49 | +Hyperledger Indy. It is intended to act as both a reference for |
| 50 | +outsiders–including both bug reporters and those looking for information on the |
| 51 | +project's security practices–as well as a set of rules that maintainers and |
| 52 | +contributors have agreed to follow. |
| 53 | + |
| 54 | +## Security Team |
| 55 | + |
| 56 | +The current Hyperledger Indy security team is: |
| 57 | + |
| 58 | +| Name | Email ID | Discord ID | Area/Specialty | |
| 59 | +| -------------- | --------------------------------- | ------------- | -------------------- | |
| 60 | +| Stephen Curran | [email protected] | swcurran | | |
| 61 | +| Wade Barnes | [email protected] | WadeBarnes | Security, Operations | |
| 62 | +| Sam Curren | [email protected] | TelegramSam | Security | |
| 63 | +| Renata Toktar | [email protected] | Renata.toktar | Security | |
| 64 | + |
| 65 | +The security team for Hyperledger Indy must include at least three Indy |
| 66 | +Maintainers that agree to carry out the following duties and responsibilities. |
| 67 | +Members are added and removed from the team via approved Pull Requests to this |
| 68 | +repository. For additional background into the role of the security team, see |
| 69 | +the [People Infrastructure] section of the Hyperledger Security Policy. |
| 70 | + |
| 71 | +[People Infrastructure]: https://toc.hyperledger.org/governing-documents/security.html#people-infrastructure |
| 72 | + |
| 73 | +**Responsibilities:** |
| 74 | + |
| 75 | +1. Acknowledge the receipt of vulnerability reports to the reporter within 2 |
| 76 | + business days. |
| 77 | + |
| 78 | +2. Assess the issue. Engage with the reporter to ask any outstanding questions |
| 79 | +about the report and how to reproduce it. If the report was received by email |
| 80 | +and may be a security vulnerability, open a GitHub Security Advisory on the |
| 81 | +repository to manage the report. If the report is not considered a |
| 82 | +vulnerability, then the reporter should be informed and this process can be |
| 83 | +halted. If the report is a regular bug (but not a security vulnerability), the |
| 84 | +reporter should be informed (if necessary) of the regular process for reporting |
| 85 | +issues. |
| 86 | + |
| 87 | +1. Some issues may require more time and resources to correct. If a particular |
| 88 | +report is complex, discuss an embargo period with the reporter during which |
| 89 | +time the report will not be publicly disclosed. The embargo period should be |
| 90 | +negotiated with the reporter and must not be longer than 90 days. |
| 91 | + |
| 92 | +1. If necessary, create a private patch development infrastructure for the issue |
| 93 | + by emailing the [Hyperledger Community Architects]. |
| 94 | + |
| 95 | +[Hyperledger Community Architects]: mailto:[email protected] |
| 96 | + |
| 97 | +5. Request a CVE for the issue (see the [CNA/CVE Reporting](#cnacve-reporting) |
| 98 | + section). |
| 99 | + |
| 100 | +6. Decide a date for the public release of the vulnerability report, the date |
| 101 | + the embargo period ends. |
| 102 | + |
| 103 | +7. If applicable, notify members of the embargo list of the vulnerability, |
| 104 | +upcoming patch and release, as described above. |
| 105 | + |
| 106 | +8. Publish a new (software) release in which the vulnerability is addressed. |
| 107 | + |
| 108 | +9. Publicly disclose the issue within 48 hours after the release via a |
| 109 | +GitHub security advisory (see the [(GitHub) Security |
| 110 | +Advisories](#github-security-advisories) section for details). |
| 111 | + |
| 112 | +## Discussion Forums |
| 113 | + |
| 114 | +Discussions about each reported vulnerability should be carried out in the |
| 115 | +private GitHub security advisory about the vulnerability. If necessary, a private |
| 116 | +channel specific to the issue may be created on the Hyperledger Discord server |
| 117 | +with invited participants added to the discussion. |
| 118 | + |
| 119 | +## Report Intakes |
| 120 | + |
| 121 | +Hyperledger Indy has the following ways to submit security |
| 122 | +vulnerabilities. While the security team members will do their best to |
| 123 | +respond to bugs disclosed in all possible ways, it is encouraged for bug |
| 124 | +finders to report through the following approved channels: |
| 125 | + |
| 126 | +- Email the [Hyperledger Foundation security |
| 127 | +list ](mailto:[email protected]): To report a security issue, please |
| 128 | +send an email with the name of the project/repository, a description of the issue, the |
| 129 | +steps you took to create the issue, affected versions, and if known, |
| 130 | +mitigations. If in triaging the email, the security team determines the issue may be |
| 131 | +a security vulnerability, a [GitHub security vulnerability report] will be |
| 132 | +opened. |
| 133 | +- Open a [GitHub security vulnerability report]: Open a draft security advisory |
| 134 | +on the "Security" tab of this GitHub repository. See [GitHub Security |
| 135 | +Advisories](#github-security-advisories) to learn more about the security |
| 136 | +infrastructure in GitHub. |
| 137 | + |
| 138 | +[GitHub security vulnerability report]: https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability |
| 139 | + |
| 140 | +## CNA/CVE Reporting |
| 141 | + |
| 142 | +Hyperledger Indy maintains a list of **Common Vulnerabilities and Exposures |
| 143 | +(CVE)** and uses GitHub as its **CVE numbering authority (CNA)** for issuing |
| 144 | +CVEs. |
| 145 | + |
| 146 | +## Embargo List |
| 147 | + |
| 148 | +Hyperledger Indy does **NOT** currently maintain a private embargo list. |
| 149 | + |
| 150 | +If you wish to be added to the embargo list, please email the [Hyperledger |
| 151 | +Foundation security mailing list ](mailto:[email protected]), |
| 152 | +including the project name (Hyperledger Indy) and reason for being added |
| 153 | +to the embargo list. Requests will be assessed by the Hyperledger Indy |
| 154 | +security team in conjunction with the appropriate Hyperledger Staff, and a |
| 155 | +decision will be made to accommodate or not the request. |
| 156 | + |
| 157 | +For more information about embargo lists, please see the [Embargo List section |
| 158 | +of the Hyperledger Security |
| 159 | +Policy](https://toc.hyperledger.org/governing-documents/security.html#embargo-list). |
| 160 | + |
| 161 | +## (GitHub) Security Advisories |
| 162 | + |
| 163 | +Hyperledger Indy uses GitHub Security Advisories to manage the public |
| 164 | +disclosure of security vulnerabilities. |
| 165 | + |
| 166 | +## Private Patch Deployment Infrastructure |
| 167 | + |
| 168 | +In creating patches and new releases that address security vulnerabilities, |
| 169 | +Hyperledger Indy **MAY** use the private development features of GitHub for |
| 170 | +security vulnerabilities. GitHub has [extensive |
| 171 | +documentation](https://docs.github.com/en/code-security/security-advisories/repository-security-advisories) |
| 172 | +about these features. |
0 commit comments