|
1 | | -# Hyperledger Security Policy |
| 1 | +# Security Policy |
2 | 2 |
|
3 | | -## Reporting a Security Bug |
| 3 | +This document defines how security vulnerability reporting is handled for Hyperledger Fabric. The |
| 4 | +approach aligns with the |
| 5 | +[LF Decentralized Trust security policy](https://lf-decentralized-trust.github.io/governance/governing-documents/security). |
| 6 | +Please review that document to understand the basis of security reporting for this project. Details |
| 7 | +specific to this repository are documented below. |
4 | 8 |
|
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. |
| 9 | +## Reporting a vulnerability |
6 | 10 |
|
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:security@hyperledger.org). |
| 11 | +**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull |
| 12 | +requests.** |
8 | 13 |
|
9 | | -The other way is to file a confidential security bug in the repository's [security advisories page](https://github.com/hyperledger/fabric/security/advisories). Guidance can be found in the GitHub documentation on [privately reporting a security vulnerability](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability). |
| 14 | +Suspected security vulnerabilities in this project can be reported privately using the repository's |
| 15 | +[security advisories page](https://github.com/hyperledger/fabric/security/advisories/new). Guidance |
| 16 | +can be found in the GitHub documentation on |
| 17 | +[privately reporting a security vulnerability](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability). |
10 | 18 |
|
11 | | -The process by which the Hyperledger Security Team handles security bugs is documented further in our [Defect Response page](https://lf-hyperledger.atlassian.net/wiki/spaces/SEC/pages/20283618/Defect+Response) on our [wiki](https://lf-hyperledger.atlassian.net/wiki). |
| 19 | +Reports are also always accepted by email to the LF Decentralized Trust security list, |
| 20 | +[security@lists.lfdecentralizedtrust.org](mailto:security@lists.lfdecentralizedtrust.org). Include |
| 21 | +the name of the project or repository along with the details listed below. If triage determines the |
| 22 | +issue is a security vulnerability, the security team will open a GitHub security advisory for it. |
12 | 23 |
|
| 24 | +### What to include |
| 25 | + |
| 26 | +The more detail you can give us, the faster we can confirm and fix the issue. Where possible, |
| 27 | +please include: |
| 28 | + |
| 29 | +- The affected version, commit, or release. |
| 30 | +- A description of the vulnerability and its potential impact. |
| 31 | +- Step-by-step instructions to reproduce it, including any proof-of-concept code. |
| 32 | +- Your assessment of the severity, and any suggested mitigation or fix. |
| 33 | +- How you would like to be credited in the advisory, if the issue is confirmed. |
| 34 | + |
| 35 | +## What to expect |
| 36 | + |
| 37 | +- We will acknowledge receipt of your report within 2 business days. |
| 38 | +- The maintainers will work with you to confirm the vulnerability and keep you updated on progress. |
| 39 | +- We will coordinate a fix and a public security bulletin with you, and credit you as the |
| 40 | + discoverer unless you ask us not to. |
| 41 | + |
| 42 | +Please keep the details of the issue confidential until an advisory has been published, so that |
| 43 | +users have a chance to update. |
| 44 | + |
| 45 | +## Vulnerabilities in dependencies |
| 46 | + |
| 47 | +Dependencies are regularly scanned for published security vulnerabilities, and these are addressed |
| 48 | +as soon as practical. In general it should not be necessary to report vulnerabilities in project |
| 49 | +dependencies. |
0 commit comments