Skip to content

Commit 821ff2e

Browse files
[EDI] Publishing a repository security advisory (#59594)
Co-authored-by: Sophie <29382425+sophietheking@users.noreply.github.com>
1 parent fd82df7 commit 821ff2e

3 files changed

Lines changed: 33 additions & 47 deletions

File tree

content/code-security/concepts/vulnerability-reporting-and-management/about-repository-security-advisories.md

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ topics:
2929

3030
With repository security advisories, you can:
3131

32-
1. Create a draft security advisory, and use the draft to privately discuss the impact of the vulnerability on your project. For more information, see [AUTOTITLE](/code-security/security-advisories/working-with-repository-security-advisories/creating-a-repository-security-advisory).
32+
1. Create a draft security advisory, and use the draft to privately discuss the impact of the vulnerability on your project.
3333
1. Privately collaborate to fix the vulnerability in a temporary private fork.
34-
1. Publish the security advisory to alert your community of the vulnerability once a patch is released. For more information, see [AUTOTITLE](/code-security/security-advisories/working-with-repository-security-advisories/publishing-a-repository-security-advisory).
34+
1. Publish the security advisory to alert your community of the vulnerability once a patch is released.
3535

3636
{% data reusables.repositories.security-advisories-republishing %}
3737

@@ -58,8 +58,30 @@ If a security advisory is specifically for npm, we also publish the advisory to
5858
When you create a security advisory for a public repository on {% data variables.product.prodname_dotcom %}, you have the option of providing an existing CVE identification number for the security vulnerability. {% data reusables.repositories.request-security-advisory-cve-id %}
5959

6060
Once you've published the security advisory and {% data variables.product.prodname_dotcom %} has assigned a CVE identification number to the vulnerability, {% data variables.product.prodname_dotcom %} publishes the CVE to the MITRE database.
61-
For more information, see [AUTOTITLE](/code-security/security-advisories/working-with-repository-security-advisories/publishing-a-repository-security-advisory).
6261

63-
## {% data variables.product.prodname_dependabot_alerts %} for published security advisories
62+
## Publication of security advisories
6463

65-
{% data reusables.repositories.github-reviews-security-advisories %}
64+
Publishing a security advisory notifies your community about the vulnerability it addresses, making it easier for them to update package dependencies and research the impact of the vulnerability.
65+
66+
When you publish a draft advisory from a public repository, visibility levels vary as follows:
67+
68+
* **Anyone** can see the current version of the advisory data, as well as any advisory credits that the credited users have accepted.
69+
* **Collaborators** can view the conversation history of the advisory.
70+
71+
The URL of a security advisory does not change after publication.
72+
73+
If you need to update or correct information in a security advisory that you've published, you can edit the security advisory. See [AUTOTITLE](/code-security/security-advisories/working-with-repository-security-advisories/editing-a-repository-security-advisory).
74+
75+
### {% data variables.product.prodname_dependabot_alerts %} for published security advisories
76+
77+
{% data variables.product.prodname_dotcom %} will review each published security advisory, add it to the {% data variables.product.prodname_advisory_database %}, and may use the security advisory to send {% data variables.product.prodname_dependabot_alerts %} to affected repositories. If the security advisory comes from a fork, we'll only send an alert if the fork owns a package, published under a unique name, on a public package registry. This process can take up to 72 hours and {% data variables.product.prodname_dotcom %} may contact you for more information.
78+
79+
### Importance of fix versions
80+
81+
Whenever possible, you should **add a fix version to a security advisory prior to publishing the advisory**. If you don't, the advisory will be published without a fixed version, and {% data variables.product.prodname_dependabot %} will alert your users about the issue, without offering any safe version to update to.
82+
83+
Depending on the vulnerability, you may need to adjust your approach. If a fix version is:
84+
85+
* **Imminently available**, and you are able to, wait to disclose the issue when the fix is ready.
86+
* **In development but not yet available**, mention this in the advisory, and edit the advisory later, after publication.
87+
* **Not planned**, be clear about it in the advisory so that your users don't contact you to ask when a fix will be made. In this case, it is helpful to include steps users can take to mitigate the issue.

content/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/publishing-a-repository-security-advisory.md

Lines changed: 6 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -27,61 +27,28 @@ shortTitle: Publish repository advisory
2727

2828
## Prerequisites
2929

30-
Before you can publish a security advisory or request a CVE identification number, you must create a draft security advisory and provide information about the versions of your project affected by the security vulnerability. For more information, see [AUTOTITLE](/code-security/security-advisories/working-with-repository-security-advisories/creating-a-repository-security-advisory).
31-
32-
If you've created a security advisory but haven't yet provided details about the versions of your project that the security vulnerability affects, you can edit the security advisory. For more information, see [AUTOTITLE](/code-security/security-advisories/working-with-repository-security-advisories/editing-a-repository-security-advisory).
33-
34-
## About publishing a security advisory
35-
36-
When you publish a security advisory, you notify your community about the security vulnerability that the security advisory addresses. Publishing a security advisory makes it easier for your community to update package dependencies and research the impact of the security vulnerability.
37-
38-
{% data reusables.repositories.security-advisories-republishing %}
39-
40-
Before you publish a security advisory, you can privately collaborate to fix the vulnerability in a temporary private fork. For more information, see [AUTOTITLE](/code-security/security-advisories/working-with-repository-security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-repository-security-vulnerability).
41-
42-
> [!WARNING]
43-
> Whenever possible, you should always add a fix version to a security advisory prior to publishing the advisory. If you don't, the advisory will be published without a fixed version, and {% data variables.product.prodname_dependabot %} will alert your users about the issue, without offering any safe version to update to.
44-
>
45-
> We recommend you take the following steps in these different situations:
46-
>
47-
> * If a fix version is imminently available, and you are able to, wait to disclose the issue when the fix is ready.
48-
> * If a fix version is in development but not yet available, mention this in the advisory, and edit the advisory later, after publication.
49-
> * If you are not planning to fix the issue, be clear about it in the advisory so that your users don't contact you to ask when a fix will be made. In this case, it is helpful to include steps users can take to mitigate the issue.
50-
51-
When you publish a draft advisory from a public repository, everyone is able to see:
52-
53-
* The current version of the advisory data.
54-
* Any advisory credits that the credited users have accepted.
55-
56-
> [!NOTE]
57-
> The general public will never have access to the edit history of the advisory, and will only see the published version.
58-
59-
After you publish a security advisory, the URL for the security advisory will remain the same as before you published the security advisory. Anyone with read access to the repository can see the security advisory. Collaborators on the security advisory can continue to view past conversations, including the full comment stream, in the security advisory unless someone with admin permissions removes the collaborator from the security advisory.
60-
61-
If you need to update or correct information in a security advisory that you've published, you can edit the security advisory. For more information, see [AUTOTITLE](/code-security/security-advisories/working-with-repository-security-advisories/editing-a-repository-security-advisory).
30+
Before you can publish a security advisory or request a CVE identification number, you must create a draft security advisory and provide information about the versions of your project affected by the security vulnerability. See [AUTOTITLE](/code-security/security-advisories/working-with-repository-security-advisories/creating-a-repository-security-advisory) and [AUTOTITLE](/code-security/security-advisories/working-with-repository-security-advisories/editing-a-repository-security-advisory).
6231

6332
## Publishing a security advisory
6433

65-
Publishing a security advisory deletes the temporary private fork for the security advisory.
34+
> [!WARNING]
35+
> Whenever possible, you should add a fix version to a security advisory prior to publishing the advisory. If you don't, the advisory will be published without a fixed version, and {% data variables.product.prodname_dependabot %} will alert your users about the issue without offering any safe version to update to.
6636
6737
{% data reusables.repositories.navigate-to-repo %}
6838
{% data reusables.repositories.sidebar-security %}
6939
{% data reusables.repositories.sidebar-advisories %}
7040
1. In the "Security Advisories" list, click the name of the security advisory you'd like to publish.
7141
1. Scroll to the bottom of the advisory form and click **Publish advisory**.
42+
* If you selected "Request CVE ID later", you will see a **Request CVE** button in place of the **Publish advisory** button.
7243

7344
![Screenshot of the "Required advisory information has been provided" area of the page. The "Publish advisory" button is outlined in orange.](/assets/images/help/security/publish-advisory-button.png)
7445

7546
> [!NOTE]
76-
> If you selected "Request CVE ID later", you will see a **Request CVE** button in place of the **Publish advisory** button. For more information, see [Requesting a CVE identification number (Optional)](#requesting-a-cve-identification-number-optional) below.
77-
78-
## {% data variables.product.prodname_dependabot_alerts %} for published security advisories
79-
80-
{% data reusables.repositories.github-reviews-security-advisories %}
47+
> Publishing a security advisory deletes the temporary private fork for the security advisory.
8148
8249
## Requesting a CVE identification number (Optional)
8350

84-
{% data reusables.repositories.request-security-advisory-cve-id %} For more information, see [AUTOTITLE](/code-security/security-advisories/working-with-repository-security-advisories/about-repository-security-advisories#cve-identification-numbers).
51+
If you don't already have a CVE identification number for a security vulnerability in your project, you can request one from {% data variables.product.github %}.
8552

8653
{% data reusables.repositories.navigate-to-repo %}
8754
{% data reusables.repositories.sidebar-security %}

data/reusables/repositories/github-reviews-security-advisories.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)