From 2aa569b1e018bfd3178a4d8ce3069ce8a485bb99 Mon Sep 17 00:00:00 2001 From: Lucas Costi Date: Tue, 8 Jun 2021 11:59:55 +1000 Subject: [PATCH] Rename dev secret scanning article (#19736) --- .../code-security/secret-security/about-secret-scanning.md | 4 ++-- .../defining-custom-patterns-for-secret-scanning.md | 2 +- content/developers/overview/index.md | 2 +- ...{secret-scanning.md => secret-scanning-partner-program.md} | 3 ++- 4 files changed, 6 insertions(+), 5 deletions(-) rename content/developers/overview/{secret-scanning.md => secret-scanning-partner-program.md} (99%) diff --git a/content/code-security/secret-security/about-secret-scanning.md b/content/code-security/secret-security/about-secret-scanning.md index 27ba53cfb3..e796d74293 100644 --- a/content/code-security/secret-security/about-secret-scanning.md +++ b/content/code-security/secret-security/about-secret-scanning.md @@ -22,7 +22,7 @@ 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. -{% 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.{% if currentVersion == "free-pro-team@latest" %} For more information, see "[Secret scanning](/developers/overview/secret-scanning)." +{% 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.{% if currentVersion == "free-pro-team@latest" %} For more information, see "[Secret scanning partner program](/developers/overview/secret-scanning-partner-program)." {% endif %} {% data reusables.secret-scanning.about-secret-scanning %} @@ -32,7 +32,7 @@ If your project communicates with an external service, you might use a token or {% 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. If you switch a private repository to public, {% data variables.product.product_name %} scans the entire repository for secrets. -When {% data variables.product.prodname_secret_scanning %} detects a set of credentials, we notify the service provider who issued the secret. The service provider validates the credential and then decides whether they should revoke the secret, issue a new secret, or reach out to you directly, which will depend on the associated risks to you or the service provider. For an overview of how we work with token-issuing partners, see "[Secret scanning](/developers/overview/secret-scanning)." +When {% data variables.product.prodname_secret_scanning %} detects a set of credentials, we notify the service provider who issued the secret. The service provider validates the credential and then decides whether they should revoke the secret, issue a new secret, or reach out to you directly, which will depend on the associated risks to you or the service provider. For an overview of how we work with token-issuing partners, see "[Secret scanning partner program](/developers/overview/secret-scanning-partner-program)." {% data variables.product.product_name %} currently scans public repositories for secrets issued by the following service providers. diff --git a/content/code-security/secret-security/defining-custom-patterns-for-secret-scanning.md b/content/code-security/secret-security/defining-custom-patterns-for-secret-scanning.md index aa3f4793c4..894ffcd48b 100644 --- a/content/code-security/secret-security/defining-custom-patterns-for-secret-scanning.md +++ b/content/code-security/secret-security/defining-custom-patterns-for-secret-scanning.md @@ -19,7 +19,7 @@ topics: ### About custom patterns for {% data variables.product.prodname_secret_scanning %} -{% 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 "Secret scanning." +{% 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 "Secret scanning partner program." 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. diff --git a/content/developers/overview/index.md b/content/developers/overview/index.md index 378383ca60..c2d5a94b12 100644 --- a/content/developers/overview/index.md +++ b/content/developers/overview/index.md @@ -10,7 +10,7 @@ children: - /managing-deploy-keys - /viewing-deployment-history - /using-ssh-agent-forwarding - - /secret-scanning + - /secret-scanning-partner-program - /replacing-github-services - /github-developer-program --- diff --git a/content/developers/overview/secret-scanning.md b/content/developers/overview/secret-scanning-partner-program.md similarity index 99% rename from content/developers/overview/secret-scanning.md rename to content/developers/overview/secret-scanning-partner-program.md index 4d37da16de..95cc2d803f 100644 --- a/content/developers/overview/secret-scanning.md +++ b/content/developers/overview/secret-scanning-partner-program.md @@ -1,10 +1,11 @@ --- -title: Secret scanning +title: Secret scanning partner program intro: 'As a service provider, you can partner with {% data variables.product.prodname_dotcom %} to have your secret token formats secured through secret scanning, which searches for accidental commits of your secret format and can be sent to a service provider''s verify endpoint.' miniTocMaxHeadingLevel: 4 redirect_from: - /partnerships/token-scanning/ - /partnerships/secret-scanning + - /developers/overview/secret-scanning versions: free-pro-team: '*' topics: