|
| 1 | +--- |
| 2 | +title: Defining custom patterns for secret scanning |
| 3 | +shortTitle: 'Defining custom patterns' |
| 4 | +intro: 'You can define custom patterns for {% data variables.product.prodname_secret_scanning %} in organizations and private repositories.' |
| 5 | +product: '{% data reusables.gated-features.secret-scanning %}' |
| 6 | +versions: |
| 7 | + free-pro-team: '*' |
| 8 | + enterprise-server: '>=3.2' |
| 9 | + github-ae: 'next' |
| 10 | +topics: |
| 11 | + - Repositories |
| 12 | +--- |
| 13 | + |
| 14 | +{% note %} |
| 15 | + |
| 16 | +**Note:** Custom patterns for {% data variables.product.prodname_secret_scanning %} is currently in beta and is subject to change. |
| 17 | + |
| 18 | +{% endnote %} |
| 19 | + |
| 20 | +### About custom patterns for {% data variables.product.prodname_secret_scanning %} |
| 21 | + |
| 22 | +{% data variables.product.company_short %} performs {% data variables.product.prodname_secret_scanning %} on {% if currentVersion == "free-pro-team@latest" %}public and private{% endif %} repositories for secret patterns provided by {% data variables.product.company_short %} and {% data variables.product.company_short %} partners. For more information on the {% data variables.product.prodname_secret_scanning %} partner program, see "<a href="/developers/overview/secret-scanning" class="dotcom-only">Secret scanning</a>." |
| 23 | + |
| 24 | +However, there can be situations where you want to scan for other secret patterns in your {% if currentVersion == "free-pro-team@latest" %}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 organizations and {% if currentVersion == "free-pro-team@latest" %}private{% endif %} repositories on {% data variables.product.product_name %}. You can define up to 20 custom patterns for each {% if currentVersion == "free-pro-team@latest" %}private{% endif %} repository or organization. |
| 25 | + |
| 26 | +{% note %} |
| 27 | + |
| 28 | +**Note:** During the beta, there are some limitations when using custom patterns for {% data variables.product.prodname_secret_scanning %}: |
| 29 | + |
| 30 | +* There is no dry-run functionality. |
| 31 | +* You cannot edit custom patterns after they're created. To change a pattern, you must delete it and recreate it. |
| 32 | +* There is no API for creating, editing, or deleting custom patterns. However, results for custom patterns are returned in the [secret scanning alerts API](/rest/reference/secret-scanning). |
| 33 | + |
| 34 | +{% endnote %} |
| 35 | + |
| 36 | +### Regular expression syntax for custom patterns |
| 37 | + |
| 38 | +Custom patterns for {% data variables.product.prodname_secret_scanning %} are specified as regular expressions. {% data variables.product.prodname_secret_scanning_caps %} uses the [Hyperscan library](https://github.com/intel/hyperscan) and only supports Hyperscan regex constructs, which are a subset of PCRE syntax. Hyperscan option modifiers are not supported. For more information on Hyperscan pattern constructs, see "[Pattern support](http://intel.github.io/hyperscan/dev-reference/compilation.html#pattern-support)" in the Hyperscan documentation. |
| 39 | + |
| 40 | +### Defining a custom pattern for a repository |
| 41 | + |
| 42 | +Before defining a custom pattern, you must ensure that {% data variables.product.prodname_secret_scanning %} is enabled on your repository. For more information, see "[Configuring {% data variables.product.prodname_secret_scanning %} for your repositories](/code-security/secret-security/configuring-secret-scanning-for-your-repositories)." |
| 43 | + |
| 44 | +{% data reusables.repositories.navigate-to-repo %} |
| 45 | +{% data reusables.repositories.sidebar-settings %} |
| 46 | +{% data reusables.repositories.navigate-to-security-and-analysis %} |
| 47 | +{% data reusables.repositories.navigate-to-ghas-settings %} |
| 48 | +{% data reusables.repositories.secret-scanning-add-custom-pattern %} |
| 49 | + |
| 50 | +After your pattern is created, {% data reusables.secret-scanning.secret-scanning-process %} 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)." |
| 51 | + |
| 52 | +### Defining a custom pattern for an organization |
| 53 | + |
| 54 | +Before defining a custom pattern, you must ensure that you enable {% data variables.product.prodname_secret_scanning %} for the {% if currentVersion == "free-pro-team@latest" %}private{% endif %} repositories that you want to scan in your organization. To enable {% data variables.product.prodname_secret_scanning %} on all {% if currentVersion == "free-pro-team@latest" %}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)." |
| 55 | + |
| 56 | +{% note %} |
| 57 | + |
| 58 | +**Note:** There is no dry-run functionality during the custom patterns beta. To avoid excess false-positive {% data variables.product.prodname_secret_scanning %} alerts, we recommend that you test your custom patterns in a repository before defining them for your entire organization. |
| 59 | + |
| 60 | +{% endnote %} |
| 61 | + |
| 62 | +{% data reusables.profile.access_org %} |
| 63 | +{% data reusables.profile.org_settings %} |
| 64 | +{% data reusables.organizations.security-and-analysis %} |
| 65 | +{% data reusables.repositories.navigate-to-ghas-settings %} |
| 66 | +{% data reusables.repositories.secret-scanning-add-custom-pattern %} |
| 67 | + |
| 68 | +After your pattern is created, {% data variables.product.prodname_secret_scanning %} scans for any secrets in {% if currentVersion == "free-pro-team@latest" %}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)." |
| 69 | + |
| 70 | +### Removing a custom pattern |
| 71 | + |
| 72 | +Removing a custom pattern also closes all the {% data variables.product.prodname_secret_scanning %} alerts that the pattern created. |
| 73 | + |
| 74 | +1. Navigate to the **Security & analysis** settings for the repository or organization where the custom pattern was created. For more information, see "[Defining a custom pattern for a repository](#defining-a-custom-pattern-for-a-repository)" or "[Defining a custom pattern for an organization](#defining-a-custom-pattern-for-an-organization)" above. |
| 75 | +{% data reusables.repositories.navigate-to-ghas-settings %} |
| 76 | +1. Under "{% data variables.product.prodname_secret_scanning_caps %}", find the custom pattern you want to remove and click **Remove**. |
| 77 | + |
| 78 | +  |
| 79 | +1. Review the confirmation and click **Remove custom pattern**. |
0 commit comments