Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Add rate limit note; suggest caching/etags
  • Loading branch information
jamisonhyatt authored Apr 21, 2021
commit 51dfc667e80c90b6098414821835c8f52a543723
2 changes: 2 additions & 0 deletions content/developers/overview/secret-scanning.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,8 @@ We strongly recommend you implement signature validation in your secret alert se

You can retrieve the {% data variables.product.prodname_dotcom %} secret scanning public key from https://api.github.com/meta/public_keys/secret_scanning and validate the message using the `ECDSA-NIST-P256V1-SHA256` algorithm.

> Important: While the public key endpoint above does not require authentication, if no authentication is present, requests may be heavily rate limited. Please use a PAT as suggested below, or implement caching or [conditional requests](/rest/guides/getting-started-with-the-rest-api#conditional-requests) using ETags.

Assuming you receive the following message, the code snippets below demonstrate how you could perform signature validation.
The code also assumes you've set an environment variable called `GITHUB_PRODUCTION_TOKEN` with a generated PAT (https://github.com/settings/tokens). The token does not need any permissions set.

Expand Down