Skip to content

Commit 2cb18fc

Browse files
authored
Merge pull request #45927 from github/repo-sync
Repo sync
2 parents d79d9d3 + 57fae3b commit 2cb18fc

112 files changed

Lines changed: 4981 additions & 1532 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎content/code-security/concepts/secret-security/secret-scanning.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,9 @@ Beyond the default detection of partner and provider secrets, you can expand and
5959

6060
* **Generic patterns.** Expand detection to secrets that aren't tied to a specific service provider, such as private keys, connection strings, and generic API keys.
6161
* **Custom patterns.** Define your own regular expressions to detect organization-specific secrets that aren't covered by default patterns.
62+
{% ifversion secret-scanning-validity-check-partner-patterns %}
6263
* **Validity checks.** Prioritize remediation by checking whether detected secrets are still active.
64+
{% endif %}
6365
{% ifversion secret-scanning-ai-generic-secret-detection %}
6466
* **{% data variables.secret-scanning.ai-detected-secrets-caps %}.** Use AI to detect unstructured secrets like passwords.
6567
{% endif %}

‎content/code-security/concepts/secret-security/validity-checks.md‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Validity checks
33
shortTitle: Validity checks
4-
intro: Validity checks and extended metadata checks help you prioritize remediation of exposed credentials that pose immediate security risks.
4+
intro: Validity checks{% ifversion secret-scanning-extended-metadata-checks %} and extended metadata checks{% endif %} help you prioritize remediation of exposed credentials that pose immediate security risks.
55
product: |
66
{% data reusables.gated-features.secret-scanning %}{% ifversion secret-risk-assessment %}
77
@@ -33,6 +33,8 @@ Some secrets require more than the token itself to confirm whether they are acti
3333

3434
{% data variables.product.github %} displays the validation status of the secret in the alert view, so you can see if the secret is `active`, `inactive`, or if the validation status is `unknown`. For most secrets, you can optionally perform an "on-demand" validity check for the secret in the alert view.
3535

36+
{% ifversion secret-scanning-extended-metadata-checks %}
37+
3638
## About extended metadata checks
3739

3840
{% data reusables.security-configurations.extended-metadata-checks %}
@@ -49,14 +51,16 @@ You can enable extended metadata checks if validity checks are enabled. Then, yo
4951

5052
The specific metadata available depends on what the service provider shares with {% data variables.product.github %}. Not all secret types support extended metadata checks. For more information, see [AUTOTITLE](/code-security/tutorials/remediate-leaked-secrets/evaluating-alerts).
5153

52-
## Getting started with validity and extended metadata checks
54+
{% endif %}
55+
56+
## Getting started with validity{% ifversion secret-scanning-extended-metadata-checks %} and extended metadata{% endif %} checks
5357

54-
You can enable validity and extended metadata checks at the repository, organization, or enterprise level to help prioritize which exposed credentials pose the most immediate security risks.
58+
You can enable validity{% ifversion secret-scanning-extended-metadata-checks %} and extended metadata{% endif %} checks at the repository, organization, or enterprise level to help prioritize which exposed credentials pose the most immediate security risks.
5559

5660
For large organizations, we recommend using **security configurations** to enable these features at the organization or enterprise level. Security configurations allow you to centrally manage {% data variables.product.prodname_secret_scanning %} settings and apply them consistently across many repositories.
5761

5862
To get started:
5963

60-
* For repositories, see [AUTOTITLE](/code-security/how-tos/secure-your-secrets/customize-leak-detection/enable-validity-checks)
64+
* For repositories, see [AUTOTITLE](/code-security/how-tos/secure-your-secrets/customize-leak-detection/enable-validity-checks){% ifversion secret-scanning-extended-metadata-checks %} and [AUTOTITLE](/code-security/how-tos/secure-your-secrets/customize-leak-detection/enable-metadata-checks){% endif %}
6165
* For an organization, see [AUTOTITLE](/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/create-custom-configuration)
6266
* For an enterprise, see [AUTOTITLE](/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/create-custom-configuration)

‎content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/create-custom-configuration.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ When creating a security configuration, keep in mind that:
4343
1. To help identify your {% data variables.product.prodname_custom_security_configuration %} and clarify its purpose on the "{% data variables.product.prodname_security_configurations_caps %}" page, name your configuration and create a description.
4444
1. Optionally, enable "{% data variables.product.prodname_secret_protection %}", a paid feature for private {% ifversion ghec %}and internal {% endif %} repositories. Enabling {% data variables.product.prodname_secret_protection %} enables alerts for {% data variables.product.prodname_secret_scanning %}. In addition, you can choose whether to enable, disable, or keep the existing settings for the following {% data variables.product.prodname_secret_scanning %} features:{% ifversion secret-scanning-validity-check-partner-patterns %}
4545
* **Validity checks**. To learn more about validity checks for partner patterns, see [AUTOTITLE](/code-security/tutorials/remediate-leaked-secrets/evaluating-alerts#checking-a-secrets-validity).{% ifversion ghes > 3.19 %}
46-
Your site administrator must enable validity checks before you can use this feature. See [AUTOTITLE](/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/configure-secret-scanning).{% endif %}{% endif %}{% ifversion fpt or ghec %}
46+
Your site administrator must enable validity checks before you can use this feature. See [AUTOTITLE](/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/configure-secret-scanning).{% endif %}{% endif %}{% ifversion secret-scanning-extended-metadata-checks %}
4747
* **Extended metadata**. To learn more about extended metadata checks, see [About extended metadata checks](/code-security/concepts/secret-security/validity-checks#about-extended-metadata-checks) and [AUTOTITLE](/code-security/tutorials/remediate-leaked-secrets/evaluating-alerts#reviewing-extended-metadata-for-a-token).
4848
> [!NOTE]
4949
> You can only enable extended metadata checks if validity checks are enabled.{% endif %}

‎content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/create-custom-configuration.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ When creating a security configuration, keep in mind that:
5151
1. To help identify your {% data variables.product.prodname_custom_security_configuration %} and clarify its purpose on the "{% data variables.product.prodname_security_configurations_caps %}" page, name your configuration and create a description.
5252
1. Optionally, enable "{% data variables.product.prodname_secret_protection %}", a paid feature for private {% ifversion ghec %}and internal {% endif %} repositories. Enabling {% data variables.product.prodname_secret_protection %} enables alerts for {% data variables.product.prodname_secret_scanning %}. In addition, you can choose whether to enable, disable, or keep the existing settings for the following {% data variables.product.prodname_secret_scanning %} features:{% ifversion secret-scanning-validity-check-partner-patterns %}
5353
* **Validity checks**. To learn more about validity checks for partner patterns, see [AUTOTITLE](/code-security/tutorials/remediate-leaked-secrets/evaluating-alerts#checking-a-secrets-validity).{% ifversion ghes > 3.19 %}
54-
Your site administrator must enable validity checks before you can use this feature. See [AUTOTITLE](/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/configure-secret-scanning).{% endif %}{% endif %}{% ifversion fpt or ghec %}
54+
Your site administrator must enable validity checks before you can use this feature. See [AUTOTITLE](/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/configure-secret-scanning).{% endif %}{% endif %}{% ifversion secret-scanning-extended-metadata-checks %}
5555
* **Extended metadata**. To learn more about extended metadata checks, see [About extended metadata checks](/code-security/concepts/secret-security/validity-checks#about-extended-metadata-checks) and [AUTOTITLE](/code-security/tutorials/remediate-leaked-secrets/evaluating-alerts#reviewing-extended-metadata-for-a-token).
5656
> [!NOTE]
5757
> You can only enable extended metadata checks if validity checks are enabled.{% endif %}

‎content/code-security/reference/secret-security/supported-secret-scanning-patterns.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,15 @@ If you use the REST API for {% data variables.product.prodname_secret_scanning %
4242
| Push protection (default) | {% octicon "x" aria-label="Not supported" %} | {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} (most) |
4343
| Push protection (configurable) | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | Some |
4444
| Validity checks | {% octicon "x" aria-label="Not supported" %} | {% octicon "x" aria-label="Not supported" %} | Some |
45-
| Extended metadata | {% octicon "x" aria-label="Not supported" %} | {% octicon "x" aria-label="Not supported" %} | Some |
45+
| Extended metadata | {% octicon "x" aria-label="Not supported" %} | {% octicon "x" aria-label="Not supported" %} | {% ifversion secret-scanning-extended-metadata-checks %}Some{% else %}{% data variables.product.company_short %} tokens only{% endif %} |
4646
| Base64 format support | {% octicon "x" aria-label="Not supported" %} | {% octicon "x" aria-label="Not supported" %} | Some |
4747

48+
{% ifversion secret-scanning-validity-check-partner-patterns %}
49+
4850
> [!NOTE]
49-
> Validity and extended metadata checks are only available to users with {% data variables.product.prodname_team %} or {% data variables.product.prodname_enterprise %} who enable the feature as part of {% data variables.product.prodname_GH_secret_protection %}.
51+
> Validity{% ifversion secret-scanning-extended-metadata-checks %} and extended metadata{% endif %} checks for partner patterns are only available to users with {% data variables.product.prodname_team %} or {% data variables.product.prodname_enterprise %} who enable the feature as part of {% data variables.product.prodname_GH_secret_protection %}.
52+
53+
{% endif %}
5054

5155
## Supported generic patterns
5256

‎content/code-security/tutorials/remediate-leaked-secrets/evaluating-alerts.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,12 +57,16 @@ With a {% data variables.copilot.copilot_enterprise %} license, you can ask {% d
5757

5858
You can use the REST API to retrieve a list of the most recent validation status for each of your tokens. For more information, see [AUTOTITLE](/rest/secret-scanning) in the REST API documentation. You can also use webhooks to be notified of activity relating to a {% data variables.product.prodname_secret_scanning %} alert. For more information, see the `secret_scanning_alert` event in [AUTOTITLE](/webhooks/webhook-events-and-payloads?actionType=created#secret_scanning_alert).
5959

60+
{% ifversion secret-scanning-validity-check-partner-patterns %}
61+
6062
## Performing an on-demand validity check
6163

6264
Once you have enabled validity checks for partner patterns for your repository, you can perform an "on-demand" validity check for any supported secret by clicking **{% octicon "sync" aria-hidden="true" aria-label="sync" %} Verify secret** in the alert view. {% data variables.product.company_short %} will send the pattern to the relevant partner and display the validation status of the secret in the alert view.
6365

6466
![Screenshot of the UI showing a {% data variables.product.prodname_secret_scanning %} alert. A button, labeled "Verify secret" is highlighted with an orange outline.](/assets/images/help/security/secret-scanning-verify-secret.png)
6567

68+
{% endif %}
69+
6670
## Reviewing {% data variables.product.company_short %} token metadata
6771

6872
> [!NOTE]

‎content/code-security/tutorials/secret-scanning-partner-program.md‎

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -90,25 +90,28 @@ The message body is a JSON array that contains one or more objects, with each ob
9090

9191
The list of valid values for `source` are:
9292

93-
* Content
94-
* Commit
95-
* Pull_request_title
96-
* Pull_request_description
97-
* Pull_request_comment
98-
* Issue_title
99-
* Issue_description
100-
* Issue_comment
101-
* Discussion_title
102-
* Discussion_body
103-
* Discussion_comment
104-
* Commit_comment
105-
* Gist_content
106-
* Gist_comment
107-
* Wiki_content
108-
* Wiki_commit
109-
* Npm
110-
* Manual_submission
111-
* Unknown
93+
* `content`
94+
* `commit`
95+
* `pull_request_title`
96+
* `pull_request_description`
97+
* `pull_request_comment`
98+
* `issue_title`
99+
* `issue_description`
100+
* `issue_comment`
101+
* `discussion_title`
102+
* `discussion_body`
103+
* `discussion_comment`
104+
* `commit_comment`
105+
* `gist_content`
106+
* `gist_comment`
107+
* `wiki_content`
108+
* `wiki_commit`
109+
* `npm`
110+
* `manual_submission`
111+
* `action_logs`
112+
* `unknown`
113+
114+
A `source` of `action_logs` means the match was found in the logs of a {% data variables.product.prodname_actions %} workflow run in a public repository.
112115

113116
### Implement signature verification in your secret alert service
114117

0 commit comments

Comments
 (0)