[2022-03-03] Secret scanning: public repo scans for GHAS (#25667)
|
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 99 KiB |
|
Before Width: | Height: | Size: 143 KiB After Width: | Height: | Size: 164 KiB |
|
Before Width: | Height: | Size: 76 KiB |
|
Before Width: | Height: | Size: 124 KiB |
|
After Width: | Height: | Size: 78 KiB |
|
Before Width: | Height: | Size: 81 KiB After Width: | Height: | Size: 105 KiB |
|
Before Width: | Height: | Size: 89 KiB After Width: | Height: | Size: 122 KiB |
|
Before Width: | Height: | Size: 98 KiB After Width: | Height: | Size: 114 KiB |
@@ -30,7 +30,7 @@ For an overview of repository-level security, see "[Securing your repository](/c
|
|||||||
|
|
||||||
{% data reusables.user-settings.access_settings %}
|
{% data reusables.user-settings.access_settings %}
|
||||||
{% data reusables.user-settings.security-analysis %}
|
{% data reusables.user-settings.security-analysis %}
|
||||||
3. Under "Configure security and analysis features", to the right of the feature, click **Disable all** or **Enable all**.
|
3. Under "Code security and analysis", to the right of the feature, click **Disable all** or **Enable all**.
|
||||||
{% ifversion ghes > 3.2 %}{% else %}{% endif %}
|
{% ifversion ghes > 3.2 %}{% else %}{% endif %}
|
||||||
6. Optionally, enable the feature by default for new repositories that you own.
|
6. Optionally, enable the feature by default for new repositories that you own.
|
||||||
{% ifversion ghes > 3.2 %}{% else %}{% endif %}
|
{% ifversion ghes > 3.2 %}{% else %}{% endif %}
|
||||||
@@ -43,7 +43,7 @@ For an overview of repository-level security, see "[Securing your repository](/c
|
|||||||
|
|
||||||
{% data reusables.user-settings.access_settings %}
|
{% data reusables.user-settings.access_settings %}
|
||||||
{% data reusables.user-settings.security-analysis %}
|
{% data reusables.user-settings.security-analysis %}
|
||||||
3. Under "Configure security and analysis features", to the right of the feature, enable or disable the feature by default for new repositories that you own.
|
3. Under "Code security and analysis", to the right of the feature, enable or disable the feature by default for new repositories that you own.
|
||||||
{% ifversion ghes > 3.2 %}{% else %}{% endif %}
|
{% ifversion ghes > 3.2 %}{% else %}{% endif %}
|
||||||
|
|
||||||
## Further reading
|
## Further reading
|
||||||
|
|||||||
@@ -69,17 +69,38 @@ For all public repositories, the security overview shows which security features
|
|||||||
|
|
||||||
## Available with {% data variables.product.prodname_GH_advanced_security %}
|
## Available with {% data variables.product.prodname_GH_advanced_security %}
|
||||||
|
|
||||||
{% data reusables.advanced-security.ghas-availability %}
|
{% ifversion fpt %}
|
||||||
|
The following {% data variables.product.prodname_GH_advanced_security %} features are available and free of charge for public repositories on {% data variables.product.prodname_dotcom_the_website %}. Organizations that use {% data variables.product.prodname_ghe_cloud %} with a license for {% data variables.product.prodname_GH_advanced_security %} can use the full set of features in any of their repositories. For a list of the features available with {% data variables.product.prodname_ghe_cloud %}, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/code-security/getting-started/github-security-features#available-with-github-advanced-security).
|
||||||
|
|
||||||
|
{% elsif ghec %}
|
||||||
|
Many {% data variables.product.prodname_GH_advanced_security %} features are available and free of charge for public repositories on {% data variables.product.prodname_dotcom_the_website %}. Organizations within an enterprise that has a {% data variables.product.prodname_GH_advanced_security %} license can use all the following features on their repositories. {% data reusables.advanced-security.more-info-ghas %}
|
||||||
|
|
||||||
|
{% elsif ghes %}
|
||||||
|
{% data variables.product.prodname_GH_advanced_security %} features are available for enterprises with a license for {% data variables.product.prodname_GH_advanced_security %}. The features are restricted to repositories owned by an organization. {% data reusables.advanced-security.more-info-ghas %}
|
||||||
|
|
||||||
|
{% elsif ghae %}
|
||||||
|
{% data variables.product.prodname_GH_advanced_security %} features are available for repositories owned by an organization. {% data reusables.advanced-security.more-info-ghas %}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
### {% data variables.product.prodname_code_scanning_capc %}
|
### {% data variables.product.prodname_code_scanning_capc %}
|
||||||
|
|
||||||
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)."
|
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)."
|
||||||
|
|
||||||
### {% data variables.product.prodname_secret_scanning_caps %}
|
{% ifversion fpt or ghec %}
|
||||||
|
### {% data variables.product.prodname_secret_scanning_partner_caps %}
|
||||||
|
|
||||||
Automatically detect tokens or credentials that have been checked into a repository. {% ifversion fpt or ghec %}{% data variables.product.prodname_secret_scanning_caps %} finds leaked secrets across all public repositories and 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 %} partners](/code-security/secret-scanning/secret-scanning-partners)."{% endif %}
|
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)."
|
||||||
{%- ifversion ghec or ghes or ghae %}
|
{% endif %}
|
||||||
{% ifversion ghec %}In private repositories, you can view {% elsif ghes or ghae %}You can view {% endif %}any secrets that {% data variables.product.company_short %} has found in your code. You should treat tokens or credentials that have been checked into the repository as compromised.{% endif %} For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)."
|
|
||||||
|
{% ifversion not fpt %}
|
||||||
|
### {% data variables.product.prodname_secret_scanning_GHAS_caps %}
|
||||||
|
|
||||||
|
{% ifversion ghec %}
|
||||||
|
Available only with a license for {% data variables.product.prodname_GH_advanced_security %}.
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
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)."
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
{% ifversion fpt or ghes > 3.1 or ghae-issue-4864 or ghec %}
|
{% ifversion fpt or ghes > 3.1 or ghae-issue-4864 or ghec %}
|
||||||
### Dependency review
|
### Dependency review
|
||||||
@@ -90,6 +111,10 @@ Show the full impact of changes to dependencies and see details of any vulnerabl
|
|||||||
{% ifversion ghec or ghes > 3.1 or ghae-issue-4554 %}
|
{% ifversion ghec or ghes > 3.1 or ghae-issue-4554 %}
|
||||||
### Security overview for organizations{% ifversion ghec or ghes > 3.4 or ghae-issue-6199 %}, enterprises,{% endif %} and teams
|
### Security overview for organizations{% ifversion ghec or ghes > 3.4 or ghae-issue-6199 %}, enterprises,{% endif %} and teams
|
||||||
|
|
||||||
|
{% ifversion ghec %}
|
||||||
|
Available only with a license for {% data variables.product.prodname_GH_advanced_security %}.
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
Review the security configuration and alerts for your organization and identify the repositories at greatest risk. For more information, see "[About the security overview](/code-security/security-overview/about-the-security-overview)."
|
Review the security configuration and alerts for your organization and identify the repositories at greatest risk. For more information, see "[About the security overview](/code-security/security-overview/about-the-security-overview)."
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
|
|||||||
@@ -27,7 +27,7 @@ includeGuides:
|
|||||||
- /code-security/secret-scanning/configuring-secret-scanning-for-your-repositories
|
- /code-security/secret-scanning/configuring-secret-scanning-for-your-repositories
|
||||||
- /code-security/secret-scanning/defining-custom-patterns-for-secret-scanning
|
- /code-security/secret-scanning/defining-custom-patterns-for-secret-scanning
|
||||||
- /code-security/secret-scanning/managing-alerts-from-secret-scanning
|
- /code-security/secret-scanning/managing-alerts-from-secret-scanning
|
||||||
- /code-security/secret-scanning/secret-scanning-partners
|
- /code-security/secret-scanning/secret-scanning-patterns
|
||||||
- /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/tracking-code-scanning-alerts-in-issues-using-task-lists
|
- /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/tracking-code-scanning-alerts-in-issues-using-task-lists
|
||||||
- /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning
|
- /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning
|
||||||
- /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts
|
- /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
title: About secret scanning
|
title: About secret scanning
|
||||||
intro: '{% data variables.product.product_name %} scans repositories for known types of secrets, to prevent fraudulent use of secrets that were committed accidentally.'
|
intro: '{% data variables.product.product_name %} scans repositories for known types of secrets, to prevent fraudulent use of secrets that were committed accidentally.'
|
||||||
product: '{% data reusables.gated-features.secret-scanning %}'
|
product: '{% data reusables.gated-features.secret-scanning-partner %}'
|
||||||
redirect_from:
|
redirect_from:
|
||||||
- /github/administering-a-repository/about-token-scanning
|
- /github/administering-a-repository/about-token-scanning
|
||||||
- /articles/about-token-scanning
|
- /articles/about-token-scanning
|
||||||
@@ -26,21 +26,31 @@ topics:
|
|||||||
|
|
||||||
If your project communicates with an external service, you might use a token or private key for authentication. Tokens and private keys are examples of secrets that a service provider can issue. 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. We recommend that you store secrets in a dedicated, secure location outside of the repository for your project.
|
If your project communicates with an external service, you might use a token or private key for authentication. Tokens and private keys are examples of secrets that a service provider can issue. 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. We recommend that you store secrets in a dedicated, secure location outside of the repository for your project.
|
||||||
|
|
||||||
{% data variables.product.prodname_secret_scanning_caps %} will scan your entire Git history on all branches present in your {% data variables.product.prodname_dotcom %} repository for any secrets. Service providers can partner with {% data variables.product.company_short %} to provide their secret formats for scanning. For details of the supported secrets and service providers, see "[{% data variables.product.prodname_secret_scanning_caps %} partners](/code-security/secret-scanning/secret-scanning-partners)."
|
{% data variables.product.prodname_secret_scanning_caps %} will scan your entire Git history on all branches present in your {% data variables.product.prodname_dotcom %} repository for secrets{% ifversion ghec or ghes > 3.4 or ghae-issue-6329 %}, even if the repository is archived{% endif %}.
|
||||||
|
|
||||||
{% data reusables.secret-scanning.partner-program-link %}
|
|
||||||
|
|
||||||
{% ifversion fpt or ghec %}
|
{% ifversion fpt or ghec %}
|
||||||
## About {% data variables.product.prodname_secret_scanning %} for public repositories
|
{% data variables.product.prodname_secret_scanning_caps %} is available on {% data variables.product.prodname_dotcom_the_website %} in two forms:
|
||||||
|
|
||||||
{% data variables.product.prodname_secret_scanning_caps %} is automatically enabled on public repositories. When you push to a public repository, {% data variables.product.product_name %} scans the content of the commits for secrets.
|
1. **{% data variables.product.prodname_secret_scanning_partner_caps %}.** Runs automatically on all public repositories. Any strings that match patterns that were provided by secret scanning partners are reported directly to the relvant partner.
|
||||||
|
|
||||||
When {% data variables.product.prodname_secret_scanning %} detects a potential secret, we notify the service provider who issued the secret. The service provider validates the string and then decides whether they should revoke the secret, issue a new secret, or contact you directly. Their action will depend on the associated risks to you or them.
|
2. **{% data variables.product.prodname_secret_scanning_GHAS_caps %}.** You can enable and configure additional scanning for repositories owned by organizations that use {% data variables.product.prodname_ghe_cloud %} and have a license for {% data variables.product.prodname_GH_advanced_security %}. Any strings that match patterns provided by secret scannng partners, by other service providers, or defined by your organization are reported as alerts in the "Security" tab of repositories. If a string in a public repository matches a partner pattern, it is also reported to the partner.
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
Service providers can partner with {% data variables.product.company_short %} to provide their secret formats for scanning. {% data reusables.secret-scanning.partner-program-link %}
|
||||||
|
|
||||||
|
{% ifversion fpt or ghec %}
|
||||||
|
## About {% data variables.product.prodname_secret_scanning_partner %}
|
||||||
|
|
||||||
|
When you make a repository public, or push changes to a public repository, {% data variables.product.product_name %} always scans the code for secrets that match partner patterns. If {% data variables.product.prodname_secret_scanning %} detects a potential secret, we notify the service provider who issued the secret. The service provider validates the string and then decides whether they should revoke the secret, issue a new secret, or contact you directly. Their action will depend on the associated risks to you or them. For more information, see "[Supported secrets for partner patterns](/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-partner-patterns)."
|
||||||
|
|
||||||
You cannot change the configuration of {% data variables.product.prodname_secret_scanning %} on public repositories.
|
You cannot change the configuration of {% data variables.product.prodname_secret_scanning %} on public repositories.
|
||||||
|
|
||||||
{% ifversion fpt %}
|
{% ifversion fpt %}
|
||||||
Organizations using {% data variables.product.prodname_ghe_cloud %} with {% data variables.product.prodname_GH_advanced_security %} can configure {% data variables.product.prodname_secret_scanning %} to run on private repositories. For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/code-security/secret-security/about-secret-scanning).
|
{% note %}
|
||||||
|
|
||||||
|
**Note:** Organizations using {% data variables.product.prodname_ghe_cloud %} with {% data variables.product.prodname_GH_advanced_security %} can also enable {% data variables.product.prodname_secret_scanning_GHAS %} on any repository they own, including private repositories. For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-advanced-security).
|
||||||
|
|
||||||
|
{% endnote %}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
@@ -48,14 +58,14 @@ Organizations using {% data variables.product.prodname_ghe_cloud %} with {% data
|
|||||||
{% ifversion not fpt %}
|
{% ifversion not fpt %}
|
||||||
|
|
||||||
{% ifversion ghec %}
|
{% ifversion ghec %}
|
||||||
## About {% data variables.product.prodname_secret_scanning %} for private repositories
|
## About {% data variables.product.prodname_secret_scanning_GHAS %}
|
||||||
{% elsif ghes or ghae %}
|
{% elsif ghes or ghae %}
|
||||||
## About {% data variables.product.prodname_secret_scanning %} on {% data variables.product.product_name %}
|
## About {% data variables.product.prodname_secret_scanning %} on {% data variables.product.product_name %}
|
||||||
|
|
||||||
{% data variables.product.prodname_secret_scanning_caps %} is available on all organization-owned repositories as part of {% data variables.product.prodname_GH_advanced_security %}. It is not available on user-owned repositories.
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
If you're a repository administrator or an organization owner, you can enable {% data variables.product.prodname_secret_scanning %} for {% ifversion ghec %} private{% endif %} repositories{% ifversion ghec or ghes > 3.4 or ghae-issue-6329 %}, including archived repositories,{% endif %} that are owned by organizations. You can enable {% data variables.product.prodname_secret_scanning %} for all your organization's repositories, or for all new repositories within your organization.{% ifversion ghec %} {% data variables.product.prodname_secret_scanning_caps %} is not available for private repositories owned by user accounts.{% endif %} For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)."
|
{% data variables.product.prodname_secret_scanning_GHAS_caps %} is available on all organization-owned repositories as part of {% data variables.product.prodname_GH_advanced_security %}. It is not available on user-owned repositories. When you enable {% data variables.product.prodname_secret_scanning %} for a repository, {% data variables.product.prodname_dotcom %} scans the code for patterns that match secrets used by many service providers. For more information, see "{% ifversion ghec %}[Supported secrets for advanced security](/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security){% else %}[{% data variables.product.prodname_secret_scanning_caps %} patterns](/code-security/secret-scanning/secret-scanning-patterns){% endif %}."
|
||||||
|
|
||||||
|
If you're a repository administrator you can enable {% data variables.product.prodname_secret_scanning_GHAS %} for any repository{% ifversion ghec or ghes > 3.4 or ghae-issue-6329 %}, including archived repositories{% endif %}. Organization owners can also enable {% data variables.product.prodname_secret_scanning_GHAS %} for all repositories or for all new repositories within an organization. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)."
|
||||||
|
|
||||||
{% ifversion ghes > 3.1 or ghae or ghec %}You can also define custom {% data variables.product.prodname_secret_scanning %} patterns for a repository, organization, or enterprise. For more information, see "[Defining custom patterns for {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/defining-custom-patterns-for-secret-scanning)."
|
{% ifversion ghes > 3.1 or ghae or ghec %}You can also define custom {% data variables.product.prodname_secret_scanning %} patterns for a repository, organization, or enterprise. For more information, see "[Defining custom patterns for {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/defining-custom-patterns-for-secret-scanning)."
|
||||||
{% elsif ghes < 3.2 %}
|
{% elsif ghes < 3.2 %}
|
||||||
@@ -64,15 +74,15 @@ Versions 3.1 and lower of {% data variables.product.product_name %} do not allow
|
|||||||
|
|
||||||
### About {% data variables.product.prodname_secret_scanning %} alerts
|
### About {% data variables.product.prodname_secret_scanning %} alerts
|
||||||
|
|
||||||
When you push commits to a{% ifversion ghec %} private{% endif %} repository with {% data variables.product.prodname_secret_scanning %} enabled, {% data variables.product.prodname_dotcom %} scans the contents of the commits for secrets.
|
When you push commits to a repository with {% data variables.product.prodname_secret_scanning %} enabled, {% data variables.product.prodname_dotcom %} scans the contents of those commits for secrets that match patterns defined by service providers{% ifversion ghes > 3.1 or ghae or ghec %} and any custom patterns defined in your enterprise, organization, or repository{% endif %}.
|
||||||
|
|
||||||
When {% data variables.product.prodname_secret_scanning %} detects a secret in a{% ifversion ghec %} private{% endif %} repository, {% data variables.product.prodname_dotcom %} generates an alert.
|
If {% data variables.product.prodname_secret_scanning %} detects a secret, {% data variables.product.prodname_dotcom %} generates an alert.
|
||||||
|
|
||||||
- {% data variables.product.prodname_dotcom %} sends an email alert to the repository administrators and organization owners.
|
- {% data variables.product.prodname_dotcom %} sends an email alert to the repository administrators and organization owners.
|
||||||
{% ifversion ghes > 3.0 or ghae or ghec %}
|
{% ifversion ghes > 3.0 or ghae or ghec %}
|
||||||
- {% data variables.product.prodname_dotcom %} sends an email alert to the contributor who committed the secret to the repository, with a link to the related {% data variables.product.prodname_secret_scanning %} alert. The commit author can then view the alert in the repository, and resolve the alert.
|
- {% data variables.product.prodname_dotcom %} sends an email alert to the contributor who committed the secret to the repository, with a link to the related {% data variables.product.prodname_secret_scanning %} alert. The commit author can then view the alert in the repository, and resolve the alert.
|
||||||
{% endif %}
|
{% endif %}
|
||||||
- {% data variables.product.prodname_dotcom %} displays an alert in the repository.{% ifversion ghes = 3.0 %} For more information, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/managing-alerts-from-secret-scanning)."{% endif %}
|
- {% data variables.product.prodname_dotcom %} displays an alert in the "Security" tab of the repository.{% ifversion ghes = 3.0 %} For more information, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/managing-alerts-from-secret-scanning)."{% endif %}
|
||||||
|
|
||||||
{% ifversion ghes > 3.0 or ghae or ghec %}
|
{% ifversion ghes > 3.0 or ghae or ghec %}
|
||||||
For more information about viewing and resolving {% data variables.product.prodname_secret_scanning %} alerts, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/managing-alerts-from-secret-scanning)."{% endif %}
|
For more information about viewing and resolving {% data variables.product.prodname_secret_scanning %} alerts, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/managing-alerts-from-secret-scanning)."{% endif %}
|
||||||
|
|||||||
@@ -1,12 +1,12 @@
|
|||||||
---
|
---
|
||||||
title: Configuring secret scanning for your repositories
|
title: Configuring secret scanning for your repositories
|
||||||
intro: 'You can configure how {% data variables.product.prodname_dotcom %} scans your repositories for secrets.'
|
intro: 'You can configure how {% data variables.product.prodname_dotcom %} scans your repositories for secrets that match advanced security patterns.'
|
||||||
permissions: 'People with admin permissions to a repository can enable {% data variables.product.prodname_secret_scanning %} for the repository.'
|
product: '{% data reusables.gated-features.secret-scanning %}'
|
||||||
|
permissions: 'People with admin permissions to a repository can enable {% data variables.product.prodname_secret_scanning_GHAS %} for the repository.'
|
||||||
redirect_from:
|
redirect_from:
|
||||||
- /github/administering-a-repository/configuring-secret-scanning-for-private-repositories
|
- /github/administering-a-repository/configuring-secret-scanning-for-private-repositories
|
||||||
- /github/administering-a-repository/configuring-secret-scanning-for-your-repositories
|
- /github/administering-a-repository/configuring-secret-scanning-for-your-repositories
|
||||||
- /code-security/secret-security/configuring-secret-scanning-for-your-repositories
|
- /code-security/secret-security/configuring-secret-scanning-for-your-repositories
|
||||||
product: '{% data reusables.gated-features.secret-scanning %}'
|
|
||||||
versions:
|
versions:
|
||||||
ghes: '*'
|
ghes: '*'
|
||||||
ghae: '*'
|
ghae: '*'
|
||||||
@@ -22,19 +22,9 @@ shortTitle: Configure secret scans
|
|||||||
{% data reusables.secret-scanning.beta %}
|
{% data reusables.secret-scanning.beta %}
|
||||||
{% data reusables.secret-scanning.enterprise-enable-secret-scanning %}
|
{% data reusables.secret-scanning.enterprise-enable-secret-scanning %}
|
||||||
|
|
||||||
{% ifversion fpt or ghec %}
|
## Enabling {% data variables.product.prodname_secret_scanning_GHAS %}
|
||||||
{% note %}
|
|
||||||
|
|
||||||
**Note:** {% data variables.product.prodname_secret_scanning_caps %} is enabled by default on public repositories and cannot be turned off. You can configure {% data variables.product.prodname_secret_scanning %} for your private repositories only.
|
You can enable {% data variables.product.prodname_secret_scanning_GHAS %} for any repository that is owned by an organization. Once enabled, {% data reusables.secret-scanning.secret-scanning-process %}
|
||||||
|
|
||||||
{% endnote %}
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
## Enabling {% data variables.product.prodname_secret_scanning %} for {% ifversion fpt or ghec %}private {% endif %}repositories
|
|
||||||
|
|
||||||
{% ifversion ghes or ghae %}
|
|
||||||
You can enable {% data variables.product.prodname_secret_scanning %} for any repository that is owned by an organization.
|
|
||||||
{% endif %} Once enabled, {% data reusables.secret-scanning.secret-scanning-process %}
|
|
||||||
|
|
||||||
{% data reusables.repositories.navigate-to-repo %}
|
{% data reusables.repositories.navigate-to-repo %}
|
||||||
{% data reusables.repositories.sidebar-settings %}
|
{% data reusables.repositories.sidebar-settings %}
|
||||||
@@ -59,7 +49,7 @@ You can enable {% data variables.product.prodname_secret_scanning %} for any rep
|
|||||||

|

|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
## Excluding alerts from {% data variables.product.prodname_secret_scanning %} in {% ifversion fpt or ghec %}private {% endif %}repositories
|
## Excluding directories from {% data variables.product.prodname_secret_scanning_GHAS %}
|
||||||
|
|
||||||
You can use a *secret_scanning.yml* file to exclude directories from {% data variables.product.prodname_secret_scanning %}. For example, you can exclude directories that contain tests or randomly generated content.
|
You can use a *secret_scanning.yml* file to exclude directories from {% data variables.product.prodname_secret_scanning %}. For example, you can exclude directories that contain tests or randomly generated content.
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
title: Defining custom patterns for secret scanning
|
title: Defining custom patterns for secret scanning
|
||||||
shortTitle: Define custom patterns
|
shortTitle: Define custom patterns
|
||||||
intro: 'You can define custom patterns for {% data variables.product.prodname_secret_scanning %} in organizations and private repositories.'
|
intro: 'You can extend {% data variables.product.prodname_secret_scanning_GHAS %} to detect secrets beyond the default patterns.'
|
||||||
product: '{% data reusables.gated-features.secret-scanning %}'
|
product: '{% data reusables.gated-features.secret-scanning %}'
|
||||||
redirect_from:
|
redirect_from:
|
||||||
- /code-security/secret-security/defining-custom-patterns-for-secret-scanning
|
- /code-security/secret-security/defining-custom-patterns-for-secret-scanning
|
||||||
@@ -25,10 +25,10 @@ topics:
|
|||||||
|
|
||||||
## About custom patterns for {% data variables.product.prodname_secret_scanning %}
|
## About custom patterns for {% data variables.product.prodname_secret_scanning %}
|
||||||
|
|
||||||
{% data variables.product.company_short %} performs {% data variables.product.prodname_secret_scanning %} on {% ifversion fpt or ghec %}public and private{% endif %} repositories for secret patterns provided by {% data variables.product.company_short %} and {% data variables.product.company_short %} partners. {% data reusables.secret-scanning.partner-program-link %} For details of the supported secrets and service providers, see "[{% data variables.product.prodname_secret_scanning_caps %} partners](/code-security/secret-scanning/secret-scanning-partners)."
|
You can define custom patterns to identify secrets that are not detected by the default patterns supported by {% data variables.product.prodname_secret_scanning %}. For example, you might have a secret pattern that is internal to your organization. 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)."
|
||||||
|
|
||||||
However, there can be situations where you want to scan for other secret patterns in your {% ifversion fpt or ghec %}private{% endif %} repositories. For example, you might have a secret pattern that is internal to your organization. For these situations, you can define custom {% data variables.product.prodname_secret_scanning %} patterns in your enterprise, organization, or {% ifversion fpt or ghec %}private{% endif %} repository on {% data variables.product.product_name %}. You can define up to
|
You can define custom patterns for your enterprise, organization, or repository. {% data variables.product.prodname_secret_scanning_caps %} supports up to
|
||||||
{%- ifversion fpt or ghec or ghes > 3.3 %} 500 custom patterns for each organization or enterprise account, and up to 100 custom patterns per {% ifversion fpt or ghec %}private{% endif %} repository.
|
{%- ifversion fpt or ghec or ghes > 3.3 %} 500 custom patterns for each organization or enterprise account, and up to 100 custom patterns per repository.
|
||||||
{%- elsif ghes = 3.3 %} 100 custom patterns for each organization or enterprise account, and 20 per repository.
|
{%- elsif ghes = 3.3 %} 100 custom patterns for each organization or enterprise account, and 20 per repository.
|
||||||
{%- else %} 20 custom patterns for each organization or enterprise account, and per repository.
|
{%- else %} 20 custom patterns for each organization or enterprise account, and per repository.
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
@@ -47,7 +47,7 @@ However, there can be situations where you want to scan for other secret pattern
|
|||||||
|
|
||||||
## Regular expression syntax for custom patterns
|
## Regular expression syntax for custom patterns
|
||||||
|
|
||||||
Custom patterns for {% data variables.product.prodname_secret_scanning %} are specified as one or more regular expressions.
|
You can specify custom patterns for {% data variables.product.prodname_secret_scanning_GHAS %} as one or more regular expressions.
|
||||||
|
|
||||||
- **Secret format:** an expression that describes the format of the secret itself.
|
- **Secret format:** an expression that describes the format of the secret itself.
|
||||||
- **Before secret:** an expression that describes the characters that come before the secret. By default, this is set to `\A|[^0-9A-Za-z]` which means that the secret must be at the start of a line or be preceded by a non-alphanumeric character.
|
- **Before secret:** an expression that describes the characters that come before the secret. By default, this is set to `\A|[^0-9A-Za-z]` which means that the secret must be at the start of a line or be preceded by a non-alphanumeric character.
|
||||||
@@ -109,7 +109,7 @@ aAAAe9
|
|||||||
|
|
||||||
## Defining a custom pattern for an organization
|
## Defining a custom pattern for an organization
|
||||||
|
|
||||||
Before defining a custom pattern, you must ensure that you enable {% data variables.product.prodname_secret_scanning %} for the {% ifversion fpt or ghec %}private{% endif %} repositories that you want to scan in your organization. To enable {% data variables.product.prodname_secret_scanning %} on all {% ifversion fpt or ghec %}private{% endif %} repositories in your organization, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)."
|
Before defining a custom pattern, you must ensure that you enable {% data variables.product.prodname_secret_scanning %} for the repositories that you want to scan in your organization. To enable {% data variables.product.prodname_secret_scanning %} on all repositories in your organization, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)."
|
||||||
|
|
||||||
{% note %}
|
{% note %}
|
||||||
|
|
||||||
@@ -125,7 +125,7 @@ Before defining a custom pattern, you must ensure that you enable {% data variab
|
|||||||
{% data reusables.advanced-security.secret-scanning-add-custom-pattern-details %}
|
{% data reusables.advanced-security.secret-scanning-add-custom-pattern-details %}
|
||||||
{% data reusables.advanced-security.secret-scanning-create-custom-pattern %}
|
{% data reusables.advanced-security.secret-scanning-create-custom-pattern %}
|
||||||
|
|
||||||
After your pattern is created, {% data variables.product.prodname_secret_scanning %} scans for any secrets in {% ifversion fpt or ghec %}private{% endif %} repositories in your organization, including their entire Git history on all branches. Organization owners and repository administrators will be alerted to any secrets found, and can review the alert in the repository where the secret is found. For more information on viewing {% data variables.product.prodname_secret_scanning %} alerts, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/managing-alerts-from-secret-scanning)."
|
After your pattern is created, {% data variables.product.prodname_secret_scanning %} scans for any secrets in repositories in your organization, including their entire Git history on all branches. Organization owners and repository administrators will be alerted to any secrets found and can review the alert in the repository where the secret is found. For more information on viewing {% data variables.product.prodname_secret_scanning %} alerts, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/managing-alerts-from-secret-scanning)."
|
||||||
|
|
||||||
## Defining a custom pattern for an enterprise account
|
## Defining a custom pattern for an enterprise account
|
||||||
|
|
||||||
@@ -149,7 +149,7 @@ Before defining a custom pattern, you must ensure that you enable secret scannin
|
|||||||
{% data reusables.advanced-security.secret-scanning-add-custom-pattern-details %}
|
{% data reusables.advanced-security.secret-scanning-add-custom-pattern-details %}
|
||||||
{% data reusables.advanced-security.secret-scanning-create-custom-pattern %}
|
{% data reusables.advanced-security.secret-scanning-create-custom-pattern %}
|
||||||
|
|
||||||
After your pattern is created, {% data variables.product.prodname_secret_scanning %} scans for any secrets in {% ifversion fpt or ghec %}private{% endif %} repositories within your enterprise's organizations with {% data variables.product.prodname_GH_advanced_security %} enabled, including their entire Git history on all branches. Organization owners and repository administrators will be alerted to any secrets found, and can review the alert in the repository where the secret is found. For more information on viewing {% data variables.product.prodname_secret_scanning %} alerts, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/managing-alerts-from-secret-scanning)."
|
After your pattern is created, {% data variables.product.prodname_secret_scanning %} scans for any secrets in repositories within your enterprise's organizations with {% data variables.product.prodname_GH_advanced_security %} enabled, including their entire Git history on all branches. Organization owners and repository administrators will be alerted to any secrets found, and can review the alert in the repository where the secret is found. For more information on viewing {% data variables.product.prodname_secret_scanning %} alerts, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/managing-alerts-from-secret-scanning)."
|
||||||
|
|
||||||
{% ifversion fpt or ghes > 3.2 or ghec or ghae %}
|
{% ifversion fpt or ghes > 3.2 or ghec or ghae %}
|
||||||
## Editing a custom pattern
|
## Editing a custom pattern
|
||||||
|
|||||||
@@ -19,6 +19,6 @@ children:
|
|||||||
- /configuring-secret-scanning-for-your-repositories
|
- /configuring-secret-scanning-for-your-repositories
|
||||||
- /defining-custom-patterns-for-secret-scanning
|
- /defining-custom-patterns-for-secret-scanning
|
||||||
- /managing-alerts-from-secret-scanning
|
- /managing-alerts-from-secret-scanning
|
||||||
- /secret-scanning-partners
|
- /secret-scanning-patterns
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@@ -22,6 +22,14 @@ shortTitle: Manage secret alerts
|
|||||||
|
|
||||||
## Managing {% data variables.product.prodname_secret_scanning %} alerts
|
## Managing {% data variables.product.prodname_secret_scanning %} alerts
|
||||||
|
|
||||||
|
{% ifversion ghec %}
|
||||||
|
{% note %}
|
||||||
|
|
||||||
|
**Note:** Alerts are created only for repositories with {% data variables.product.prodname_secret_scanning_GHAS %} enabled. Secrets found in public repositories using the free {% data variables.product.prodname_secret_scanning_partner%} service are reported directly to the partner, without creating an alert.
|
||||||
|
|
||||||
|
{% endnote %}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
{% data reusables.repositories.navigate-to-repo %}
|
{% data reusables.repositories.navigate-to-repo %}
|
||||||
{% data reusables.repositories.sidebar-security %}
|
{% data reusables.repositories.sidebar-security %}
|
||||||
1. In the left sidebar, click **Secret scanning alerts**.
|
1. In the left sidebar, click **Secret scanning alerts**.
|
||||||
@@ -56,6 +64,14 @@ Once a secret has been committed to a repository, you should consider the secret
|
|||||||
- For a compromised {% data variables.product.prodname_dotcom %} personal access token, delete the compromised token, create a new token, and update any services that use the old token. For more information, see "[Creating a personal access token for the command line](/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line)."
|
- For a compromised {% data variables.product.prodname_dotcom %} personal access token, delete the compromised token, create a new token, and update any services that use the old token. For more information, see "[Creating a personal access token for the command line](/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line)."
|
||||||
- For all other secrets, first verify that the secret committed to {% data variables.product.product_name %} is valid. If so, create a new secret, update any services that use the old secret, and then delete the old secret.
|
- For all other secrets, first verify that the secret committed to {% data variables.product.product_name %} is valid. If so, create a new secret, update any services that use the old secret, and then delete the old secret.
|
||||||
|
|
||||||
|
{% ifversion ghec %}
|
||||||
|
{% note %}
|
||||||
|
|
||||||
|
**Note:** If a secret is detected in a public repository on {% data variables.product.prodname_dotcom_the_website %} and the secret also matches a partner pattern, an alert is generated and the potential secret is reported to the service provider. For details of partner patterns, see "[Supported secrets for partner patterns](/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-partner-patterns)."
|
||||||
|
|
||||||
|
{% endnote %}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
{% ifversion fpt or ghes > 3.1 or ghae-issue-4910 or ghec %}
|
{% ifversion fpt or ghes > 3.1 or ghae-issue-4910 or ghec %}
|
||||||
## Configuring notifications for {% data variables.product.prodname_secret_scanning %} alerts
|
## Configuring notifications for {% data variables.product.prodname_secret_scanning %} alerts
|
||||||
|
|
||||||
|
|||||||
@@ -1,55 +0,0 @@
|
|||||||
---
|
|
||||||
title: Secret scanning partners
|
|
||||||
intro: 'Lists of supported secrets and the partners that {% data variables.product.company_short %} works with to prevent fraudulent use of secrets that were committed accidentally.'
|
|
||||||
product: '{% data reusables.gated-features.secret-scanning %}'
|
|
||||||
versions:
|
|
||||||
fpt: '*'
|
|
||||||
ghes: '*'
|
|
||||||
ghae: '*'
|
|
||||||
ghec: '*'
|
|
||||||
type: reference
|
|
||||||
topics:
|
|
||||||
- Secret scanning
|
|
||||||
- Advanced Security
|
|
||||||
---
|
|
||||||
|
|
||||||
{% data reusables.secret-scanning.beta %}
|
|
||||||
{% data reusables.secret-scanning.enterprise-enable-secret-scanning %}
|
|
||||||
|
|
||||||
{% ifversion fpt or ghec %}
|
|
||||||
## List of supported secrets for public repositories
|
|
||||||
|
|
||||||
{% data variables.product.product_name %} currently scans public repositories for secrets issued by the following service providers.
|
|
||||||
|
|
||||||
{% data reusables.secret-scanning.partner-secret-list-public-repo %}
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
{% ifversion fpt %}
|
|
||||||
Organizations using {% data variables.product.prodname_ghe_cloud %} with {% data variables.product.prodname_GH_advanced_security %} can run {% data variables.product.prodname_secret_scanning %} on private repositories. For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/code-security/secret-scanning/secret-scanning-partners).
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
{% ifversion ghec or ghae or ghes %}
|
|
||||||
## List of supported secrets {% ifversion ghec %}for private repositories{% endif %}
|
|
||||||
|
|
||||||
{% ifversion ghes > 3.1 or ghae or ghec %}
|
|
||||||
{% note %}
|
|
||||||
|
|
||||||
**Note:** You can also define custom {% data variables.product.prodname_secret_scanning %} patterns that only apply to your repository or organization. For more information, see "[Defining custom patterns for {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/defining-custom-patterns-for-secret-scanning)."
|
|
||||||
|
|
||||||
{% endnote %}
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
{% data variables.product.prodname_dotcom %} currently scans{% ifversion ghec %} private{% endif %} repositories for secrets issued by the following service providers.
|
|
||||||
|
|
||||||
{% data reusables.secret-scanning.partner-secret-list-private-repo %}
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
## Further reading
|
|
||||||
|
|
||||||
- "[Securing your repository](/code-security/getting-started/securing-your-repository)"
|
|
||||||
- "[Keeping your account and data secure](/github/authenticating-to-github/keeping-your-account-and-data-secure)"
|
|
||||||
{%- ifversion fpt or ghec %}
|
|
||||||
- "[{% data variables.product.prodname_secret_scanning_caps %} partner program](/developers/overview/secret-scanning-partner-program)"
|
|
||||||
{%- else %}
|
|
||||||
- "[{% data variables.product.prodname_secret_scanning_caps %} partner program](/free-pro-team@latest/developers/overview/secret-scanning-partner-program)" in the {% data variables.product.prodname_ghe_cloud %} documentation
|
|
||||||
{% endif %}
|
|
||||||
@@ -0,0 +1,64 @@
|
|||||||
|
---
|
||||||
|
title: Secret scanning patterns
|
||||||
|
intro: 'Lists of supported secrets and the partners that {% data variables.product.company_short %} works with to prevent fraudulent use of secrets that were committed accidentally.'
|
||||||
|
product: '{% data reusables.gated-features.secret-scanning-partner %}'
|
||||||
|
versions:
|
||||||
|
fpt: '*'
|
||||||
|
ghes: '*'
|
||||||
|
ghae: '*'
|
||||||
|
ghec: '*'
|
||||||
|
type: reference
|
||||||
|
topics:
|
||||||
|
- Secret scanning
|
||||||
|
- Advanced Security
|
||||||
|
redirect_from:
|
||||||
|
- /code-security/secret-security/secret-scanning-partners
|
||||||
|
---
|
||||||
|
|
||||||
|
{% data reusables.secret-scanning.beta %}
|
||||||
|
{% data reusables.secret-scanning.enterprise-enable-secret-scanning %}
|
||||||
|
|
||||||
|
{% ifversion fpt or ghec %}
|
||||||
|
## About {% data variables.product.prodname_secret_scanning %} patterns
|
||||||
|
|
||||||
|
{% data variables.product.product_name %} maintains two different sets of {% data variables.product.prodname_secret_scanning %} patterns:
|
||||||
|
|
||||||
|
1. **Partner patterns.** Used to detect potential secrets in all public repositories. For details, see "[Supported secrets for partner patterns](#supported-secrets-for-partner-patterns)."
|
||||||
|
2. **Advanced security patterns.** Used to detect potential secrets in repositories with {% data variables.product.prodname_secret_scanning %} enabled. {% ifversion ghec %} For details, see "[Supported secrets for advanced security](#supported-secrets-for-advanced-security)."{% endif %}
|
||||||
|
|
||||||
|
{% ifversion fpt %}
|
||||||
|
Organizations using {% data variables.product.prodname_ghe_cloud %} with {% data variables.product.prodname_GH_advanced_security %} can enable {% data variables.product.prodname_secret_scanning_GHAS %} on their repositories. For details of these patterns, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
## Supported secrets for partner patterns
|
||||||
|
|
||||||
|
{% data variables.product.product_name %} currently scans public repositories for secrets issued by the following service providers. For more information about {% data variables.product.prodname_secret_scanning_partner %}, see "[About {% data variables.product.prodname_secret_scanning_partner %}](/code-security/secret-scanning/about-secret-scanning#about-secret-scanning-for-partner-patterns)."
|
||||||
|
|
||||||
|
{% data reusables.secret-scanning.partner-secret-list-public-repo %}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% ifversion ghec or ghae or ghes %}
|
||||||
|
## Supported secrets{% ifversion ghec %} for advanced security{% endif %}
|
||||||
|
|
||||||
|
When {% data variables.product.prodname_secret_scanning_GHAS %} is enabled, {% data variables.product.prodname_dotcom %} scans for secrets issued by the following service providers. {% ifversion ghec %}For more information about {% data variables.product.prodname_secret_scanning_GHAS %}, see "[About {% data variables.product.prodname_secret_scanning_GHAS %}](/code-security/secret-scanning/about-secret-scanning#about-secret-scanning-for-advanced-security)."{% endif %}
|
||||||
|
|
||||||
|
{% ifversion ghes > 3.1 or ghae or ghec %}
|
||||||
|
{% note %}
|
||||||
|
|
||||||
|
**Note:** You can also define custom {% data variables.product.prodname_secret_scanning %} patterns for your repository, organization, or enterprise. For more information, see "[Defining custom patterns for {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/defining-custom-patterns-for-secret-scanning)."
|
||||||
|
|
||||||
|
{% endnote %}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% data reusables.secret-scanning.partner-secret-list-private-repo %}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
## Further reading
|
||||||
|
|
||||||
|
- "[Securing your repository](/code-security/getting-started/securing-your-repository)"
|
||||||
|
- "[Keeping your account and data secure](/github/authenticating-to-github/keeping-your-account-and-data-secure)"
|
||||||
|
{%- ifversion fpt or ghec %}
|
||||||
|
- "[{% data variables.product.prodname_secret_scanning_caps %} partner program](/developers/overview/secret-scanning-partner-program)"
|
||||||
|
{%- else %}
|
||||||
|
- "[{% data variables.product.prodname_secret_scanning_caps %} partner program](/free-pro-team@latest/developers/overview/secret-scanning-partner-program)" in the {% data variables.product.prodname_ghe_cloud %} documentation
|
||||||
|
{% endif %}
|
||||||
@@ -125,7 +125,7 @@ Available in the secret scanning alert views.
|
|||||||
|
|
||||||
| Qualifier | Description |
|
| Qualifier | Description |
|
||||||
| -------- | -------- |
|
| -------- | -------- |
|
||||||
| `secret-type:SERVICE_PROVIDER` | Displays alerts for the specified secret and provider. For more information, see "[{% data variables.product.prodname_secret_scanning_caps %} partners](/code-security/secret-scanning/secret-scanning-partners)." |
|
| `secret-type:SERVICE_PROVIDER` | Displays alerts for the specified secret and provider. For more information, see "[{% data variables.product.prodname_secret_scanning_caps %} patterns](/code-security/secret-scanning/secret-scanning-patterns)." |
|
||||||
| `secret-type:CUSTOM-PATTERN` | Displays alerts for secrets matching the specified custom pattern. {% ifversion not fpt %}For more information, see "[Defining custom patterns for secret scanning](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning)."{% endif %} |
|
| `secret-type:CUSTOM-PATTERN` | Displays alerts for secrets matching the specified custom pattern. {% ifversion not fpt %}For more information, see "[Defining custom patterns for secret scanning](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning)."{% endif %} |
|
||||||
|
|
||||||
## Filter by provider
|
## Filter by provider
|
||||||
@@ -134,4 +134,4 @@ Available in the secret scanning alert views.
|
|||||||
|
|
||||||
| Qualifier | Description |
|
| Qualifier | Description |
|
||||||
| -------- | -------- |
|
| -------- | -------- |
|
||||||
|`provider:PROVIDER_NAME` | Displays alerts for all secrets issues by the specified provider. For more information, see "[{% data variables.product.prodname_secret_scanning_caps %} partners](/code-security/secret-scanning/secret-scanning-partners)." |
|
|`provider:PROVIDER_NAME` | Displays alerts for all secrets issues by the specified provider. For more information, see "[{% data variables.product.prodname_secret_scanning_caps %} patterns](/code-security/secret-scanning/secret-scanning-patterns)." |
|
||||||
|
|||||||
@@ -68,8 +68,8 @@ You can also enable or disable {% data variables.product.prodname_dependabot_sec
|
|||||||
{% data reusables.repositories.navigate-to-repo %}
|
{% data reusables.repositories.navigate-to-repo %}
|
||||||
{% data reusables.repositories.sidebar-settings %}
|
{% data reusables.repositories.sidebar-settings %}
|
||||||
{% data reusables.repositories.navigate-to-security-and-analysis %}
|
{% data reusables.repositories.navigate-to-security-and-analysis %}
|
||||||
1. Under "Configure security and analysis features", to the right of "{% data variables.product.prodname_dependabot %} security updates", click **Enable** or **Disable**.
|
1. Under "Code security and analysis", to the right of "{% data variables.product.prodname_dependabot %} security updates", click **Enable** or **Disable**.
|
||||||
{% ifversion fpt or ghec %}{% else %}{% endif %}
|
{% ifversion fpt or ghec %}{% else %}{% endif %}
|
||||||
|
|
||||||
|
|
||||||
## Further reading
|
## Further reading
|
||||||
|
|||||||
@@ -97,7 +97,7 @@ The "Used by" section represents a single package from the repository. If you ha
|
|||||||
{% data reusables.repositories.navigate-to-repo %}
|
{% data reusables.repositories.navigate-to-repo %}
|
||||||
{% data reusables.repositories.sidebar-settings %}
|
{% data reusables.repositories.sidebar-settings %}
|
||||||
{% data reusables.repositories.navigate-to-security-and-analysis %}
|
{% data reusables.repositories.navigate-to-security-and-analysis %}
|
||||||
4. Under "Configure security and analysis features", click the drop-down menu in the "Used by counter" section and choose a package.
|
4. Under "Code security and analysis", click the drop-down menu in the "Used by counter" section and choose a package.
|
||||||

|

|
||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ When you enable data use for your private repository, you'll be able to access t
|
|||||||
{% data reusables.repositories.navigate-to-repo %}
|
{% data reusables.repositories.navigate-to-repo %}
|
||||||
{% data reusables.repositories.sidebar-settings %}
|
{% data reusables.repositories.sidebar-settings %}
|
||||||
{% data reusables.repositories.navigate-to-security-and-analysis %}
|
{% data reusables.repositories.navigate-to-security-and-analysis %}
|
||||||
4. Under "Configure security and analysis features", to the right of the feature, click **Disable** or **Enable**.{% ifversion fpt %}
|
4. Under "Code security and analysis", to the right of the feature, click **Disable** or **Enable**.{% ifversion fpt %}
|
||||||
{% elsif ghec %}
|
{% elsif ghec %}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
|
|||||||
@@ -48,7 +48,7 @@ You can enable or disable features for all repositories.
|
|||||||
- **{% data variables.product.prodname_dependabot_security_updates %}** - Your changes affect all repositories.
|
- **{% data variables.product.prodname_dependabot_security_updates %}** - Your changes affect all repositories.
|
||||||
{%- ifversion ghec %}
|
{%- ifversion ghec %}
|
||||||
- **{% data variables.product.prodname_GH_advanced_security %}** - Your changes affect only private repositories because {% data variables.product.prodname_GH_advanced_security %} and the related features are always enabled for public repositories.
|
- **{% data variables.product.prodname_GH_advanced_security %}** - Your changes affect only private repositories because {% data variables.product.prodname_GH_advanced_security %} and the related features are always enabled for public repositories.
|
||||||
- **{% data variables.product.prodname_secret_scanning_caps %}** - Your changes affect only private repositories where {% data variables.product.prodname_GH_advanced_security %} is also enabled. {% data variables.product.prodname_secret_scanning_caps %} is always enabled for public repositories.
|
- **{% data variables.product.prodname_secret_scanning_caps %}** - Your changes affect repositories where {% data variables.product.prodname_GH_advanced_security %} is also enabled. This option controls whether or not {% data variables.product.prodname_secret_scanning_GHAS %} is enabled. {% data variables.product.prodname_secret_scanning_partner_caps %} always runs on all public repositories.
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
@@ -56,7 +56,7 @@ You can enable or disable features for all repositories.
|
|||||||
{% data reusables.advanced-security.note-org-enable-uses-seats %}
|
{% data reusables.advanced-security.note-org-enable-uses-seats %}
|
||||||
|
|
||||||
1. Go to the security and analysis settings for your organization. For more information, see "[Displaying the security and analysis settings](#displaying-the-security-and-analysis-settings)."
|
1. Go to the security and analysis settings for your organization. For more information, see "[Displaying the security and analysis settings](#displaying-the-security-and-analysis-settings)."
|
||||||
2. Under "Configure security and analysis features", to the right of the feature, click **Disable all** or **Enable all**. {% ifversion ghes > 3.0 or ghec %}The control for "{% data variables.product.prodname_GH_advanced_security %}" is disabled if you have no available seats in your {% data variables.product.prodname_GH_advanced_security %} license.{% endif %}
|
2. Under "Code security and analysis", to the right of the feature, click **Disable all** or **Enable all**. {% ifversion ghes > 3.0 or ghec %}The control for "{% data variables.product.prodname_GH_advanced_security %}" is disabled if you have no available seats in your {% data variables.product.prodname_GH_advanced_security %} license.{% endif %}
|
||||||
{% ifversion fpt %}
|
{% ifversion fpt %}
|
||||||

|

|
||||||
{% endif %}
|
{% endif %}
|
||||||
@@ -103,24 +103,21 @@ You can enable or disable features for all repositories.
|
|||||||
## Enabling or disabling a feature automatically when new repositories are added
|
## Enabling or disabling a feature automatically when new repositories are added
|
||||||
|
|
||||||
1. Go to the security and analysis settings for your organization. For more information, see "[Displaying the security and analysis settings](#displaying-the-security-and-analysis-settings)."
|
1. Go to the security and analysis settings for your organization. For more information, see "[Displaying the security and analysis settings](#displaying-the-security-and-analysis-settings)."
|
||||||
2. Under "Configure security and analysis features", to the right of the feature, enable or disable the feature by default for new repositories{% ifversion fpt or ghec %}, or all new private repositories,{% endif %} in your organization.
|
2. Under "Code security and analysis", to the right of the feature, enable or disable the feature by default for new repositories{% ifversion fpt or ghec %}, or all new private repositories,{% endif %} in your organization.
|
||||||
{% ifversion fpt %}
|
{% ifversion fpt or ghec %}
|
||||||

|

|
||||||
{% endif %}
|
|
||||||
{% ifversion ghec %}
|
|
||||||

|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
{% ifversion ghes > 3.2 %}
|
{% ifversion ghes > 3.2 %}
|
||||||

|

|
||||||
{% endif %}
|
{% endif %}
|
||||||
{% ifversion ghes = 3.1 or ghes = 3.2 %}
|
{% ifversion ghes = 3.1 or ghes = 3.2 %}
|
||||||

|

|
||||||
{% endif %}
|
{% endif %}
|
||||||
{% ifversion ghes = 3.0 %}
|
{% ifversion ghes = 3.0 %}
|
||||||

|

|
||||||
{% endif %}
|
{% endif %}
|
||||||
{% ifversion ghae %}
|
{% ifversion ghae %}
|
||||||

|

|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% ifversion ghec or ghes > 3.2 %}
|
{% ifversion ghec or ghes > 3.2 %}
|
||||||
|
|||||||
@@ -32,7 +32,7 @@ You can manage a subset of security and analysis features for public repositorie
|
|||||||
{% data reusables.repositories.navigate-to-repo %}
|
{% data reusables.repositories.navigate-to-repo %}
|
||||||
{% data reusables.repositories.sidebar-settings %}
|
{% data reusables.repositories.sidebar-settings %}
|
||||||
{% data reusables.repositories.navigate-to-security-and-analysis %}
|
{% data reusables.repositories.navigate-to-security-and-analysis %}
|
||||||
4. Under "Configure security and analysis features", to the right of the feature, click **Disable** or **Enable**.{% ifversion fpt %}
|
4. Under "Code security and analysis", to the right of the feature, click **Disable** or **Enable**.{% ifversion fpt %}
|
||||||
{% elsif ghec %}
|
{% elsif ghec %}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
@@ -49,7 +49,7 @@ You can manage the security and analysis features for your {% ifversion fpt or g
|
|||||||
{% data reusables.repositories.sidebar-settings %}
|
{% data reusables.repositories.sidebar-settings %}
|
||||||
{% data reusables.repositories.navigate-to-security-and-analysis %}
|
{% data reusables.repositories.navigate-to-security-and-analysis %}
|
||||||
{% ifversion fpt or ghes > 3.0 or ghec %}
|
{% ifversion fpt or ghes > 3.0 or ghec %}
|
||||||
4. Under "Configure security and analysis features", to the right of the feature, click **Disable** or **Enable**. {% ifversion not fpt %}The control for "{% data variables.product.prodname_GH_advanced_security %}" is disabled if your enterprise has no available licenses for {% data variables.product.prodname_advanced_security %}.{% endif %}{% ifversion fpt %}
|
4. Under "Code security and analysis", to the right of the feature, click **Disable** or **Enable**. {% ifversion not fpt %}The control for "{% data variables.product.prodname_GH_advanced_security %}" is disabled if your enterprise has no available licenses for {% data variables.product.prodname_advanced_security %}.{% endif %}{% ifversion fpt %}
|
||||||
{% elsif ghec %}
|
{% elsif ghec %}
|
||||||
{% elsif ghes > 3.2 %}
|
{% elsif ghes > 3.2 %}
|
||||||
{% else %}
|
{% else %}
|
||||||
@@ -64,11 +64,11 @@ You can manage the security and analysis features for your {% ifversion fpt or g
|
|||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% ifversion ghes = 3.0 %}
|
{% ifversion ghes = 3.0 %}
|
||||||
4. Under "Configure security and analysis features", to the right of the feature, click **Disable** or **Enable**.
|
4. Under "Code security and analysis", to the right of the feature, click **Disable** or **Enable**.
|
||||||

|

|
||||||
{% endif %}
|
{% endif %}
|
||||||
{% ifversion ghae %}
|
{% ifversion ghae %}
|
||||||
4. Under "Configure security and analysis features", to the right of the feature, click **Disable** or **Enable**. Before you can enable "{% data variables.product.prodname_secret_scanning %}" for your repository, you may need to enable {% data variables.product.prodname_GH_advanced_security %}.
|
4. Under "Code security and analysis", to the right of the feature, click **Disable** or **Enable**. Before you can enable "{% data variables.product.prodname_secret_scanning %}" for your repository, you may need to enable {% data variables.product.prodname_GH_advanced_security %}.
|
||||||

|

|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Secret scanning
|
title: Secret scanning
|
||||||
intro: 'To retrieve and update the secret alerts from a private repository, you can use Secret Scanning API.'
|
intro: 'Use the secret scanning API to retrieve and update secret alerts from a repository.'
|
||||||
versions:
|
versions:
|
||||||
fpt: '*'
|
fpt: '*'
|
||||||
ghes: '>=3.1'
|
ghes: '>=3.1'
|
||||||
|
|||||||
@@ -1,10 +0,0 @@
|
|||||||
{% data variables.product.prodname_GH_advanced_security %} features are available
|
|
||||||
|
|
||||||
{%- ifversion fpt %} for public repositories on {% data variables.product.prodname_dotcom_the_website %}. Organizations that use {% data variables.product.prodname_ghe_cloud %} can also access these features in private repositories with a license for {% data variables.product.prodname_GH_advanced_security %}. {% data reusables.advanced-security.more-info-ghas %}
|
|
||||||
|
|
||||||
{%- elsif ghec %} and free of charge for public repositories on {% data variables.product.prodname_dotcom_the_website %}. Organizations within an enterprise that has a {% data variables.product.prodname_GH_advanced_security %} license can also access these features on private or internal repositories. {% data reusables.advanced-security.more-info-ghas %}
|
|
||||||
|
|
||||||
{%- elsif ghes %} for enterprises with a license for {% data variables.product.prodname_GH_advanced_security %}. The features are restricted to repositories owned by an organization. {% data reusables.advanced-security.more-info-ghas %}
|
|
||||||
|
|
||||||
{%- elsif ghae %} for repositories owned by an organization. {% data reusables.advanced-security.more-info-ghas %}
|
|
||||||
{% endif %}
|
|
||||||
13
data/reusables/gated-features/secret-scanning-partner.md
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
{%- ifversion fpt %}
|
||||||
|
{% data variables.product.prodname_secret_scanning_partner_caps %} is automatically run on public repositories in all products on {% data variables.product.prodname_dotcom_the_website %}. {% data variables.product.prodname_secret_scanning_GHAS_caps %} is available for repositories owned by organizations that use {% data variables.product.prodname_ghe_cloud %} and have a license for {% data variables.product.prodname_GH_advanced_security %}.
|
||||||
|
|
||||||
|
{%- elsif ghec %}
|
||||||
|
{% data variables.product.prodname_secret_scanning_partner_caps %} is automatically run on all public repositories. If you have a license for {% data variables.product.prodname_GH_advanced_security %}, you can enable and configure {% data variables.product.prodname_secret_scanning_GHAS %} for any repository owned by an organization.
|
||||||
|
|
||||||
|
{%- elsif ghes %}
|
||||||
|
{% data variables.product.prodname_secret_scanning_caps %} is available for organization-owned repositories in {% data variables.product.product_name %} if your enterprise has a license for {% data variables.product.prodname_GH_advanced_security %}.
|
||||||
|
|
||||||
|
{%- elsif ghae %}
|
||||||
|
{% data variables.product.prodname_secret_scanning_caps %} is available for organization-owned repositories in {% data variables.product.product_name %}. This is a {% data variables.product.prodname_GH_advanced_security %} feature (free during the beta release).
|
||||||
|
|
||||||
|
{%- endif %} {% ifversion not ghae %}For more information, see "[GitHub's products](/articles/githubs-products)."{% endif %}
|
||||||
@@ -1,11 +1,7 @@
|
|||||||
{%- ifversion fpt %}
|
<!--This reusable describes the GHAS secret scanning feature. For a reusable that also covers the free secret scanning for public repositories on GitHub.com, use `secret-scanning-parter.md` -->
|
||||||
{% data variables.product.prodname_secret_scanning_caps %} is enabled on public repositories in all products. {% data variables.product.prodname_secret_scanning_caps %} is also available in private repositories owned by organizations that use {% data variables.product.prodname_ghe_cloud %} and have a license for {% data variables.product.prodname_GH_advanced_security %}.
|
|
||||||
|
|
||||||
{%- elsif ghec %}
|
{%- ifversion ghec or ghes %}
|
||||||
{% data variables.product.prodname_secret_scanning_caps %} is included in {% data variables.product.product_name %} for public repositories. To use {% data variables.product.prodname_secret_scanning %} in private repositories owned by organizations, you must have a license for {% data variables.product.prodname_GH_advanced_security %}.
|
{% data variables.product.prodname_secret_scanning_GHAS_caps %} is available for organization-owned repositories in {% data variables.product.product_name %} if your enterprise has a license for {% data variables.product.prodname_GH_advanced_security %}.
|
||||||
|
|
||||||
{%- elsif ghes %}
|
|
||||||
{% data variables.product.prodname_secret_scanning_caps %} is available for organization-owned repositories in {% data variables.product.product_name %} if your enterprise has a license for {% data variables.product.prodname_GH_advanced_security %}.
|
|
||||||
|
|
||||||
{%- elsif ghae %}
|
{%- elsif ghae %}
|
||||||
{% data variables.product.prodname_secret_scanning_caps %} is available for organization-owned repositories in {% data variables.product.product_name %}. This is a {% data variables.product.prodname_GH_advanced_security %} feature (free during the beta release).
|
{% data variables.product.prodname_secret_scanning_caps %} is available for organization-owned repositories in {% data variables.product.product_name %}. This is a {% data variables.product.prodname_GH_advanced_security %} feature (free during the beta release).
|
||||||
|
|||||||
@@ -1 +1 @@
|
|||||||
1. Under "Configure security and analysis features", find "{% data variables.product.prodname_GH_advanced_security %}."
|
1. Under "Code security and analysis", find "{% data variables.product.prodname_GH_advanced_security %}."
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
The {% data variables.product.prodname_secret_scanning %} API lets you{% ifversion fpt or ghec or ghes > 3.1 or ghae %}:
|
The {% data variables.product.prodname_secret_scanning %} API lets you{% ifversion fpt or ghec or ghes > 3.1 or ghae %}:
|
||||||
|
|
||||||
- Enable or disable {% data variables.product.prodname_secret_scanning %} for a repository. For more information, see "[Repositories](/rest/reference/repos#update-a-repository)" in the REST API documentation.
|
- Enable or disable {% data variables.product.prodname_secret_scanning %} for a repository. For more information, see "[Repositories](/rest/reference/repos#update-a-repository)" in the REST API documentation.
|
||||||
- Retrieve and update {% data variables.product.prodname_secret_scanning %} alerts from a {% ifversion fpt or ghec %}private {% endif %}repository. For futher details, see the sections below.
|
- Retrieve and update {% data variables.product.prodname_secret_scanning_GHAS %} alerts from a repository. For further details, see the sections below.
|
||||||
{%- else %} retrieve and update {% data variables.product.prodname_secret_scanning %} alerts from a {% ifversion fpt or ghec %}private {% endif %}repository.{% endif %}
|
{%- else %} retrieve and update {% data variables.product.prodname_secret_scanning %} alerts from a repository.{% endif %}
|
||||||
|
|
||||||
For more information about {% data variables.product.prodname_secret_scanning %}, see "[About {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/about-secret-scanning)."
|
For more information about {% data variables.product.prodname_secret_scanning %}, see "[About {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/about-secret-scanning)."
|
||||||
@@ -159,8 +159,16 @@ prodname_security_link: 'https://securitylab.github.com/'
|
|||||||
prodname_security_advisories: 'GitHub Security Advisories'
|
prodname_security_advisories: 'GitHub Security Advisories'
|
||||||
|
|
||||||
# Security features and code scanning platform
|
# Security features and code scanning platform
|
||||||
prodname_secret_scanning: 'secret scanning'
|
prodname_secret_scanning: 'secret scanning' # Overall feature name and name for GHES and GHAE
|
||||||
prodname_secret_scanning_caps: 'Secret scanning'
|
prodname_secret_scanning_caps: 'Secret scanning'
|
||||||
|
prodname_secret_scanning_partner: 'secret scanning for partner patterns' # GitHub.com feature for public repos only
|
||||||
|
prodname_secret_scanning_partner_caps: 'Secret scanning for partner patterns'
|
||||||
|
prodname_secret_scanning_GHAS:
|
||||||
|
>- # Includes GitHub.com name for GHAS licenced feature
|
||||||
|
{% ifversion fpt or ghec %}secret scanning for advanced security{% else %}secret scanning{% endif %}
|
||||||
|
prodname_secret_scanning_GHAS_caps: >-
|
||||||
|
{% ifversion fpt or ghec %}Secret scanning for advanced security{% else %}Secret scanning{% endif %}
|
||||||
|
|
||||||
prodname_code_scanning: 'code scanning'
|
prodname_code_scanning: 'code scanning'
|
||||||
prodname_code_scanning_capc: 'Code scanning'
|
prodname_code_scanning_capc: 'Code scanning'
|
||||||
prodname_codeql_runner: 'CodeQL runner'
|
prodname_codeql_runner: 'CodeQL runner'
|
||||||
|
|||||||