Skip to content

Commit 5b2dfe2

Browse files
committed
Update vulnerability disclosure guide for EEF CNA
The EEF now operates a CVE Numbering Authority for the BEAM ecosystem. Updated all documentation to reference the EEF CNA as the primary authority for CVE requests on Hex.pm packages, with guidance to check the CNA scope and use the contact page for reporting.
1 parent 9deda30 commit 5b2dfe2

File tree

6 files changed

+40
-21
lines changed

6 files changed

+40
-21
lines changed

docs/security_vulnerability_disclosure/checklist.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,13 @@ checklist to ensure that you address vulnerabilities effectively:
2626
3. **Disclose & Request CVE**:
2727
- Document the vulnerability, including its impact, affected versions, and
2828
mitigations, in a security advisory on GitHub or your project's website.
29-
- Request a Common Vulnerabilities and Exposures (CVE) identifier for the
30-
vulnerability through GitHub's security advisory interface or other
31-
appropriate channels.
29+
- Request a Common Vulnerabilities and Exposures (CVE) identifier:
30+
- Check if your package is in the [EEF CNA scope](https://cna.erlef.org/scope).
31+
For the vast majority of Hex.pm packages, the EEF CNA is responsible.
32+
- **For packages in EEF CNA scope:** Request a CVE via the
33+
[EEF CNA](https://cna.erlef.org/contact).
34+
- **For packages outside EEF CNA scope:** Request a CVE through GitHub's
35+
security advisory interface or other appropriate channels.
3236
- Provide clear and comprehensive information to users and stakeholders to
3337
help them understand the nature and severity of the vulnerability.
3438
- Check that the disclosure is visible in the

docs/security_vulnerability_disclosure/github_disclosure.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,14 @@ vulnerabilities. Below are key features of GitHub's security disclosure process:
3333
take appropriate action to protect their systems.
3434

3535
3. **CVE Requests**:
36-
- GitHub supports the request and assignment of Common Vulnerabilities and
37-
Exposures (CVE) identifiers for reported vulnerabilities. Maintainers can
38-
request CVE identifiers directly through GitHub's security advisory
39-
interface.
36+
- For Hex.pm packages, the [EEF CNA](https://cna.erlef.org/) is the primary
37+
authority for assigning CVE identifiers. Before requesting a CVE, check the
38+
[CNA scope](https://cna.erlef.org/scope) to verify coverage. This applies to
39+
the vast majority of Hex packages. To request a CVE from the EEF CNA,
40+
contact the [EEF CNA](https://cna.erlef.org/contact).
41+
- For projects outside the EEF CNA scope, GitHub supports the request and
42+
assignment of CVE identifiers. Maintainers can request CVE identifiers
43+
directly through GitHub's security advisory interface.
4044
- GitHub streamlines the process of requesting CVE identifiers, reducing the
4145
administrative burden on maintainers and ensuring that vulnerabilities are
4246
properly cataloged and tracked in the CVE database.
@@ -51,4 +55,4 @@ GitHub provides a comprehensive toolkit for handling security incidents and
5155
safeguarding the integrity of open-source software projects.
5256

5357
You can see an example for this process in a disclosure for one of
54-
[ErlEFs libraries](https://github.com/erlef/oidcc/security/advisories/GHSA-mj35-2rgf-cv8p).
58+
[EEF libraries](https://github.com/erlef/oidcc/security/advisories/GHSA-mj35-2rgf-cv8p).

docs/security_vulnerability_disclosure/index.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,13 @@ systems and sensitive data against emerging threats.
5252
* [Process](process)
5353
* [GitHub Disclosure](github_disclosure)
5454

55-
The ErlEF Security Working Group ([security@erlef.org](mailto:security@erlef.org))
56-
offers to connect individuals with experts who can assist in coordinating and
57-
disclosing vulnerabilities within the BEAM ecosystem. While the WG does not
58-
handle direct disclosures, it helps to facilitate communication with experienced
59-
professionals in security vulnerability management.
55+
The Erlang Ecosystem Foundation operates a
56+
[CVE Numbering Authority (CNA)](https://cna.erlef.org/) for the BEAM ecosystem.
57+
The EEF CNA can assist in coordinating and disclosing vulnerabilities, including
58+
assigning CVE identifiers for most Hex.pm packages. Before requesting a CVE,
59+
check the [CNA scope](https://cna.erlef.org/scope) to verify coverage. For
60+
reporting channels and assistance, see the
61+
[CNA contact page](https://cna.erlef.org/contact).
6062

6163
To report mistakes or suggest additional content, please open an issue or create
6264
a pull request in the [GitHub repository]({{site.github.repository_url}}).

docs/security_vulnerability_disclosure/process.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,16 @@ Below are the most essential parts of a security disclosure process:
4747
4. **Disclosing the Vulnerability (CVE & Hex)**:
4848
- After the fix has been implemented and distributed to users, disclose the
4949
vulnerability publicly. Assign a Common Vulnerabilities and Exposures (CVE)
50-
identifier to the vulnerability, if applicable, to facilitate tracking and
51-
referencing. Additionally, update the retirement status (
50+
identifier to the vulnerability to facilitate tracking and referencing.
51+
- For Hex.pm packages, the [EEF CNA](https://cna.erlef.org/) is responsible
52+
for assigning CVE identifiers in most cases. Check the
53+
[CNA scope](https://cna.erlef.org/scope) to verify coverage (this applies
54+
to the vast majority of Hex packages). To request a CVE, contact
55+
the [EEF CNA](https://cna.erlef.org/contact).
56+
- For projects outside the EEF CNA scope, request a CVE through
57+
[GitHub's security advisory interface](https://docs.github.com/en/code-security/security-advisories/working-with-repository-security-advisories/publishing-a-repository-security-advisory)
58+
or other appropriate channels.
59+
- Additionally, update the retirement status (
5260
[Elixir](https://hexdocs.pm/hex/Mix.Tasks.Hex.Retire.html) /
5361
[Erlang](https://rebar3.org/docs/package_management/#retiring-packages))
5462
of the affected package on Hex, if necessary, to alert users to the presence

docs/security_vulnerability_disclosure/resources.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,11 @@ next:
1111

1212
## Guides
1313

14+
* [EEF CVE Numbering Authority](https://cna.erlef.org/) - Primary CVE authority for Hex.pm packages
1415
* [OpenSSF Guide to implementing a coordinated vulnerability disclosure process for open source projects](https://github.com/ossf/oss-vulnerability-guide/blob/main/maintainer-guide.md)
1516
* [GitHub Privately reporting a security vulnerability](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/privately-reporting-a-security-vulnerability)
1617
* [GitHub Managing privately reported security vulnerabilities](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/managing-privately-reported-security-vulnerabilities)
17-
* [Publishing a CVE](https://www.cve.org/ReportRequest/ReportRequestForNonCNAs)
18+
* [Publishing a CVE](https://www.cve.org/ReportRequest/ReportRequestForNonCNAs) - for projects outside EEF CNA scope
1819
* [Hex Package Retire](https://hexdocs.pm/hex/Mix.Tasks.Hex.Retire.html)
1920
* [Rebar Package Retire](https://rebar3.org/docs/package_management/#retiring-packages)
2021

docs/security_vulnerability_disclosure/vulnerability_definition.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,11 @@ Here's how a library maintainer can make this determination:
6060
insights. Security professionals can offer guidance on threat modeling, risk
6161
assessment, and appropriate mitigation strategies.
6262

63-
The ErlEF Security Working Group ([security@erlef.org](mailto:security@erlef.org))
64-
offers to connect individuals with experts who can assist in coordinating and
65-
disclosing vulnerabilities within the BEAM ecosystem. While the WG does not
66-
handle direct disclosures, it helps to facilitate communication with experienced
67-
professionals in security vulnerability management.
63+
The [EEF CVE Numbering Authority](https://cna.erlef.org/) can assist in
64+
coordinating and disclosing vulnerabilities within the BEAM ecosystem,
65+
including assigning CVE identifiers for Hex.pm packages. Check the
66+
[CNA scope](https://cna.erlef.org/scope) to verify coverage and the
67+
[contact page](https://cna.erlef.org/contact) for reporting channels.
6868

6969
By carefully considering these factors, a library maintainer can make informed
7070
decisions about whether a reported issue constitutes a security vulnerability

0 commit comments

Comments
 (0)