4.2 KiB
title, intro, product, versions, type, topics, redirect_from
| title | intro | product | versions | type | topics | redirect_from | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Secret scanning patterns | 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. | {% data reusables.gated-features.secret-scanning-partner %} |
|
reference |
|
|
{% 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:
- Partner patterns. Used to detect potential secrets in all public repositories. For details, see "Supported secrets for partner patterns."
- 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."{% 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. {% 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 %}."
{% 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 %}."{% endif %}
If you use the REST API for secret scanning, you can use the Secret type to report on secrets from specific issuers. For more information, see "Secret scanning."
{% 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 %}."
{% endnote %} {% endif %}
{% data reusables.secret-scanning.partner-secret-list-private-repo %} {% endif %}
Further reading
- "Securing your repository"
- "Keeping your account and data secure" {%- ifversion fpt or ghec %}
- "{% data variables.product.prodname_secret_scanning_caps %} partner program" {%- else %}
- "{% data variables.product.prodname_secret_scanning_caps %} partner program" in the {% data variables.product.prodname_ghe_cloud %} documentation {% endif %}