Skip to content

Commit 7a9debd

Browse files
mchammer01sophiethekinggithub-actionsaashaham-stead
authored
[December 15, 2022] - Secret Scanning Experience for Free Public Repos (Public Beta) (github#32702)
Co-authored-by: Sophie <[email protected]> Co-authored-by: github-actions <[email protected]> Co-authored-by: Aakash Shah <[email protected]> Co-authored-by: amstead <[email protected]> Co-authored-by: Mariam <[email protected]> Co-authored-by: Felicity Chapman <[email protected]> Co-authored-by: Anne-Marie <[email protected]>
1 parent 14bf19e commit 7a9debd

File tree

47 files changed

+238
-183
lines changed

Some content is hidden

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

47 files changed

+238
-183
lines changed
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading

Diff for: content/code-security/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale.md

+8
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,14 @@ Before you can proceed with pilot programs and rolling out {% data variables.pro
118118

119119
## Preparing to enable {% data variables.product.prodname_secret_scanning %}
120120

121+
{% note %}
122+
123+
**Note:** When {% data variables.product.prodname_secret_scanning %} detects a secret in repositories owned by organizations that use {% data variables.product.prodname_ghe_cloud %} and have a license for {% data variables.product.prodname_GH_advanced_security %}, {% data variables.product.prodname_dotcom %} alerts all users with access to security alerts for the repository. {% ifversion ghec %}
124+
125+
Secrets found in public repositories using {% data variables.product.prodname_secret_scanning_partner_alerts%} are reported directly to the partner, without creating an alert on {% data variables.product.product_name %}. For details about the supported partner patterns, see "[Supported secrets for partner alerts](/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-partner-alerts)."{% endif %}
126+
127+
{% endnote %}
128+
121129
If a project communicates with an external service, it might use a token or private key for authentication. If you check a secret into a repository, anyone who has read access to the repository can use the secret to access the external service with your privileges. {% data variables.product.prodname_secret_scanning_caps %} will scan your entire Git history on all branches present in your {% data variables.product.prodname_dotcom %} repositories for secrets and alert you{% ifversion secret-scanning-push-protection %} or block the push containing the secret{% endif %}. For more information, see "[About secret scanning](/code-security/secret-scanning/about-secret-scanning)."
122130

123131
### Considerations when enabling {% data variables.product.prodname_secret_scanning %}

Diff for: content/code-security/getting-started/github-security-features.md

+14-8
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,15 @@ The security overview allows you to review security configurations and alerts, m
6868
The security overview shows which security features are enabled for the repository, and offers you the option of configuring any available security features that are not already enabled.
6969
{% endif %}
7070

71+
72+
{% ifversion fpt or ghec %}
73+
## Available for free public repositories
74+
75+
### {% data variables.product.prodname_secret_scanning_partner_alerts_caps %}
76+
77+
Automatically detect leaked secrets across all public repositories. {% data variables.product.company_short %} informs the relevant service provider that the secret may be compromised. For details of the supported secrets and service providers, see "[Supported secrets for partner alerts](/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-partner-alerts)."
78+
79+
{% endif %}
7180
## Available with {% data variables.product.prodname_GH_advanced_security %}
7281

7382
{% ifversion fpt %}
@@ -87,21 +96,18 @@ Many {% data variables.product.prodname_GH_advanced_security %} features are ava
8796

8897
Automatically detect security vulnerabilities and coding errors in new or modified code. Potential problems are highlighted, with detailed information, allowing you to fix the code before it's merged into your default branch. For more information, see "[About code scanning](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning)."
8998

90-
{% ifversion fpt or ghec %}
91-
### {% data variables.product.prodname_secret_scanning_partner_caps %}
99+
### {% data variables.product.prodname_secret_scanning_user_alerts_caps %}
92100

93-
Automatically detect leaked secrets across all public repositories. {% data variables.product.company_short %} informs the relevant service provider that the secret may be compromised. For details of the supported secrets and service providers, see "[{% data variables.product.prodname_secret_scanning_caps %} patterns](/code-security/secret-scanning/secret-scanning-patterns)."
101+
{% ifversion fpt %}
102+
{% data reusables.secret-scanning.secret-scanning-alerts-beta %}
103+
Limited to free public repositories.
94104
{% endif %}
95105

96-
{% ifversion ghec or ghes or ghae %}
97-
### {% data variables.product.prodname_secret_scanning_GHAS_caps %}
98-
99106
{% ifversion ghec %}
100107
Available only with a license for {% data variables.product.prodname_GH_advanced_security %}.
101108
{% endif %}
102109

103-
Automatically detect tokens or credentials that have been checked into a repository. You can view alerts for any secrets that {% data variables.product.company_short %} finds in your code, so that you know which tokens or credentials to treat as compromised. For more information, see "[About secret scanning](/code-security/secret-scanning/about-secret-scanning#about-secret-scanning-for-advanced-security)."
104-
{% endif %}
110+
Automatically detect tokens or credentials that have been checked into a repository. You can view alerts for any secrets that {% data variables.product.company_short %} finds in your code, in the "Security" tab of the repository, so that you know which tokens or credentials to treat as compromised. For more information, see {% ifversion fpt or ghec %}"[About {% data variables.product.prodname_secret_scanning_user_alerts %}](/code-security/secret-scanning/about-secret-scanning#about-secret-scanning-alerts-for-users)"{% elsif ghes %}"[About {% data variables.product.prodname_secret_scanning_user_alerts %} on {% data variables.product.product_name %}](/code-security/secret-scanning/about-secret-scanning#about-secret-scanning-on-github-enterprise-server){% elsif ghae %}"[About {% data variables.product.prodname_secret_scanning_user_alerts %} on {% data variables.product.product_name %}](/code-security/secret-scanning/about-secret-scanning#about-secret-scanning-on-github-ae){% endif %}."
105111

106112
### Dependency review
107113

Diff for: content/code-security/getting-started/securing-your-repository.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -122,14 +122,21 @@ You can set up {% data variables.product.prodname_code_scanning %} to automatica
122122

123123
## Configuring {% data variables.product.prodname_secret_scanning %}
124124

125-
{% data variables.product.prodname_secret_scanning_caps %} is {% ifversion fpt or ghec %}enabled for all public repositories and is available for private repositories owned by organizations that are part of an enterprise with a license for {% else %}available for organization-owned repositories if your enterprise uses {% endif %}{% data variables.product.prodname_GH_advanced_security %}. {% ifversion fpt %}For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/code-security/getting-started/securing-your-repository#configuring-secret-scanning).{% else %}{% data variables.product.prodname_secret_scanning_caps %} may already be enabled for your repository, depending upon your organization's settings.
125+
{% ifversion fpt %}
126+
{% data variables.product.prodname_secret_scanning_partner_alerts_caps %} runs automatically on public repositories in all products on {% data variables.product.prodname_dotcom_the_website %}. {% data variables.product.prodname_secret_scanning_user_alerts_caps %} are available for public repositories, as well as repositories owned by organizations that use {% data variables.product.prodname_ghe_cloud %} and have a license for {% data variables.product.prodname_GH_advanced_security %}. {% data reusables.advanced-security.more-info-ghas %}{% endif %}
127+
128+
{% ifversion ghec or ghes or ghae %}
129+
130+
{% data variables.product.prodname_secret_scanning_caps %} is {% ifversion ghec %}enabled for all public repositories and is available for private repositories owned by organizations that are part of an enterprise with a license for {% else %}available for organization-owned repositories if your enterprise uses {% endif %}{% data variables.product.prodname_GH_advanced_security %}. {% ifversion fpt %}For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/code-security/getting-started/securing-your-repository#configuring-secret-scanning).{% else %}{% data variables.product.prodname_secret_scanning_caps %} may already be enabled for your repository, depending upon your organization's settings.
126131

127132
1. From the main page of your repository, click **{% octicon "gear" aria-label="The Settings gear" %}Settings**.
128133
2. Click **Security & analysis**.
129134
3. If {% data variables.product.prodname_GH_advanced_security %} is not already enabled, click **Enable**.
130135
4. Next to {% data variables.product.prodname_secret_scanning_caps %}, click **Enable**.
131136
{% endif %}
132137

138+
{% endif %}
139+
133140
## Next steps
134141
You can view and manage alerts from security features to address dependencies and vulnerabilities in your code. For more information, see {% ifversion fpt or ghes or ghec %} "[Viewing and updating {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts),"{% endif %} {% ifversion fpt or ghec or ghes %}"[Managing pull requests for dependency updates](/code-security/supply-chain-security/managing-pull-requests-for-dependency-updates)," {% endif %}"[Managing {% data variables.product.prodname_code_scanning %} for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)," and "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/managing-alerts-from-secret-scanning)."
135142

0 commit comments

Comments
 (0)