Skip to content

Commit adf0e94

Browse files
Create a conceptual article broadly covering GitHub's secret security tooling (#58600)
Co-authored-by: Sam Browning <106113886+sabrowning1@users.noreply.github.com>
1 parent 34349d7 commit adf0e94

File tree

6 files changed

+73
-65
lines changed

6 files changed

+73
-65
lines changed

content/code-security/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ redirect_from:
66
- /code-security/guides
77
introLinks:
88
overview: '{% ifversion ghes %}/code-security/getting-started/github-security-features{% endif %}'
9-
generate_secret_risk_assessment_report_for_free: '{% ifversion secret-risk-assessment %}/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/viewing-the-secret-risk-assessment-report-for-your-organization#generating-an-initial-secret-risk-assessment{% endif %}'
9+
generate_secret_risk_assessment_report_for_free: '{% ifversion secret-risk-assessment %}/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/assess-your-secret-risk{% endif %}'
1010
featuredLinks:
1111
startHere: # Links aimed at the builder audience
1212
- '{% ifversion fpt or ghec %}/code-security/getting-started/github-security-features{% endif %}'

content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/about-secret-risk-assessment.md

Lines changed: 0 additions & 59 deletions
This file was deleted.
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: 'About secret security with GitHub'
3+
shortTitle: 'Secret protection tools'
4+
intro: 'Learn how {% data variables.product.github %}''s security tools can help you identify, remediate, and prevent secret leaks.'
5+
product: '{% data reusables.gated-features.secret-protection %}'
6+
permissions: 'Organizations on {% data variables.product.prodname_team %} or {% data variables.product.prodname_enterprise %}'
7+
contentType: concepts
8+
versions:
9+
feature: secret-risk-assessment
10+
topics:
11+
- Code Security
12+
- Secret scanning
13+
- Secret Protection
14+
- Organizations
15+
- Security
16+
redirect_from:
17+
- /code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/about-secret-risk-assessment
18+
---
19+
20+
{% data variables.product.github %} provides tools to help you understand and address your organization's exposure to leaked secrets:
21+
22+
- **Secret risk assessment**: A free, on-demand scan that reveals your organization's current exposure to leaked secrets.
23+
- **{% data variables.product.prodname_GH_secret_protection %}**: A comprehensive suite of features that detects existing secrets and prevents new leaks across your repositories.
24+
25+
## Secret risk assessment
26+
27+
The secret risk assessment provides organization owners and security managers with a free point-in-time scan of their organization's repositories to identify leaked secrets like API keys, tokens, and passwords.
28+
29+
{% data variables.secret-scanning.secret-risk-assessment-cta-product %}
30+
31+
### What the assessment shows
32+
33+
The assessment report includes:
34+
35+
- **Total secrets detected**: The aggregate count of exposed secrets in your organization.
36+
- **Public leaks**: Secrets found in public repositories that are accessible to anyone.
37+
- **Preventable leaks**: Secrets that could have been blocked with push protection enabled.
38+
- **Secret categories**: The distribution of secret types (such as AWS keys, {% data variables.product.github %} tokens, or generic passwords).
39+
40+
### Why assess your risk
41+
42+
Regular assessment helps prevent:
43+
* Unauthorized access to your systems and data
44+
* Service disruptions from compromised credentials
45+
* Regulatory compliance issues
46+
* Financial loss from resource misuse
47+
* Reputational damage from security incidents
48+
49+
## {% data variables.product.prodname_GH_secret_protection %}
50+
51+
{% data variables.product.prodname_GH_secret_protection %} is a {% data variables.product.prodname_GH_advanced_security %} product containing a suite of features designed to prevent, detect, and assist in remediating secret leaks in your organization.
52+
53+
While the {% data variables.product.prodname_secret_risk_assessment %} provides a point-in-time view of your organization's current secret exposure, {% data variables.product.prodname_GH_secret_protection %}:
54+
55+
* **Implements continuous monitoring** and expands scanned surfaces beyond code to include pull requests, issues, wikis, and discussions
56+
* **Prevents secret leaks** by blocking commits containing secrets before they are saved to {% data variables.product.github %}
57+
* **Creates actionable alerts** that can be grouped into campaigns and assigned to team members for remediation
58+
* **Meets your specific needs** by scanning for patterns unique to your organization and unstructured secrets like passwords
59+
* **Supports governance at scale** with settings dictating who can bypass protections and dismiss alerts
60+
* **Surfaces key analytics** through a view dedicated to your organization's secret security
61+
62+
Through these features, {% data variables.product.prodname_GH_secret_protection %} provides complete coverage for your organization, reducing the risk of costly secret leaks and high-effort remediation processes.
63+
64+
For more information about the specific features of {% data variables.product.prodname_GH_secret_protection %}, see [AUTOTITLE](/code-security/getting-started/github-security-features#available-with-github-secret-protection).
65+
66+
## Next steps
67+
68+
Now that you know how {% data variables.product.github %} can help keep your secrets safe, you should assess your organization's current exposure to leaked secrets. See [AUTOTITLE](/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/assess-your-secret-risk).

content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/assess-your-secret-risk.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@ topics:
2828

2929
> [!NOTE]
3030
> You can only generate a secret risk assessment report once every 90 days.
31-
3231
{% data reusables.organizations.navigate-to-org %}
3332
{% data reusables.organizations.security-overview %}
3433
{% data reusables.security-overview.open-assessments-view %}

content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: 'Understanding your organization''s exposure to leaked secrets'
2+
title: Understanding your organization's exposure to leaked secrets
33
shortTitle: Exposure to leaked secrets
4-
intro: 'You can generate a secret risk assessment report to evaluate the extent of your organization''s vulnerability to leaked secrets. Decide whether to enable {% data variables.product.prodname_secret_protection %} to protect your organization from further leaks.<br>{% data variables.secret-scanning.secret-risk-assessment-cta-product %}'
4+
intro: You can generate a secret risk assessment report to evaluate the extent of your organization's vulnerability to leaked secrets. Decide whether to enable {% data variables.product.prodname_secret_protection %} to protect your organization from further leaks.<br>{% data variables.secret-scanning.secret-risk-assessment-cta-product %}
55
versions:
66
feature: secret-risk-assessment
77
topics:
@@ -11,7 +11,7 @@ topics:
1111
- Code Security
1212
- Security
1313
children:
14-
- /about-secret-risk-assessment
14+
- /about-secret-security-with-github
1515
- /assess-your-secret-risk
1616
- /viewing-the-secret-risk-assessment-report-for-your-organization
1717
- /export-risk-report-csv

data/variables/secret-scanning.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ roi-calculator: 'ROI calculator'
1717
pricing-calculator: 'pricing calculator'
1818

1919
# Secret risk assessment call to action links. If changing the links below, also update the hard-coded link in /code-security/index.md
20-
secret-risk-assessment-cta-link: '/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/viewing-the-secret-risk-assessment-report-for-your-organization#generating-an-initial-secret-risk-assessment'
20+
secret-risk-assessment-cta-link: '/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/assess-your-secret-risk'
2121
secret-risk-assessment-cta-text: 'Find out how to run a free secret risk assessment'
2222
secret-risk-assessment-cta-product: '[<span class="btn btn-primary mt-3 mr-3 no-underline">{% data variables.secret-scanning.secret-risk-assessment-cta-text %}</span>](/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/viewing-the-secret-risk-assessment-report-for-your-organization#generating-an-initial-secret-risk-assessment)'
2323

0 commit comments

Comments
 (0)