You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/developers/overview/secret-scanning.md
+7-8Lines changed: 7 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ versions:
13
13
14
14
When a match of your secret format is found in a public repository, a payload is sent to an HTTP endpoint of your choice.
15
15
16
-
When a match of your secret format is found in a private repository configured for {% data variables.product.prodname_secret_scanning %}, then repository admins are alerted and can view and manage the {% data variables.product.prodname_secret_scanning %} results on {% data variables.product.prodname_dotcom %}. For more information, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/managing-alerts-from-secret-scanning)".
16
+
When a match of your secret format is found in a private repository configured for {% data variables.product.prodname_secret_scanning %}, then repository admins are alerted and can view and manage the {% data variables.product.prodname_secret_scanning %} results on {% data variables.product.prodname_dotcom %}. For more information, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/managing-alerts-from-secret-scanning)."
17
17
18
18
{% note %}
19
19
@@ -42,7 +42,7 @@ The following diagram summarizes the {% data variables.product.prodname_secret_s
42
42
43
43
#### Contact {% data variables.product.prodname_dotcom %} to get the process started
44
44
45
-
To get the enrollment process started, email secret-scanning@github.com.
45
+
To get the enrollment process started, email <ahref="mailto:secret-scanning@github.com">secret-scanning@github.com</a>.
46
46
47
47
You will receive details on the {% data variables.product.prodname_secret_scanning %} program, and you will need to agree to {% data variables.product.prodname_dotcom %}'s terms of participation before proceeding.
48
48
@@ -284,11 +284,11 @@ For {% data variables.product.prodname_secret_scanning %} in public repositories
284
284
285
285
#### Provide feedback for false positives
286
286
287
-
We collect feedback on the validity of the detected individual secrets in partner responses. Email us at secret-scanning@github.com if you wish to to take part, and get feedback collection enabled.
287
+
We collect feedback on the validity of the detected individual secrets in partner responses. If you wish to take part, email us at <ahref="mailto:secret-scanning@github.com">secret-scanning@github.com</a>.
288
288
289
-
When we report secrets to you, we send a JSON array with each element containing the token, type identifier, and commit URL. When you send us feedback, you send us information about whether the detected token was a real or false credential.
289
+
When we report secrets to you, we send a JSON array with each element containing the token, type identifier, and commit URL. When you send us feedback, you send us information about whether the detected token was a real or false credential. We accept feedback in the following formats.
290
290
291
-
You can find below the two response formats that we support in terms of feedback:
291
+
You can send us the raw token:
292
292
293
293
```
294
294
[
@@ -304,7 +304,7 @@ You may also provide the token in hashed form after performing a one way cryptog
304
304
```
305
305
[
306
306
{
307
-
"token_hash": "The SHA256 hashed form of the raw token",
307
+
"token_hash": "The SHA-256 hashed form of the raw token",
308
308
"token_type": "ACompany_API_token",
309
309
"label": "false_positive"
310
310
}
@@ -317,8 +317,7 @@ A few important points:
317
317
318
318
{% note %}
319
319
320
-
**Note:** Our request timeout is set to be higher (that is, 30 seconds) for responding partners with false positives data. If you require a timeout larger than 30 seconds, email us at secret-scanning@github.com.
320
+
**Note:** Our request timeout is set to be higher (that is, 30 seconds) for partners who provide data about false positives. If you require a timeout higher than 30 seconds, email us at <ahref="mailto:secret-scanning@github.com">secret-scanning@github.com</a>.
0 commit comments