docs(approvals): added HMAC signature verification example#26
Open
jeetsingh008 wants to merge 1 commit into
Open
docs(approvals): added HMAC signature verification example#26jeetsingh008 wants to merge 1 commit into
jeetsingh008 wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Closes #23
Adds a receiver-side HMAC signature verification recipe to the webhook
channel documentation in
docs/approvals.md.The signing implementation was already in place in
webhook.ts. This PRfulfills the documentation half of the issue — explaining how external
systems can verify the
x-helio-signatureheader sent by Helio usingtiming-safe comparison.
Type of Change
Packages Affected
packages/proxypackages/dashboardpackages/python-sdkdocs/examples/Checklist
anytypes or@ts-ignorewithout justificationHow to Test
helio.yamlwith asecretfieldx-helio-signatureheaderAdditional Context
The HMAC signing was already implemented end-to-end:
config/schema.ts—secretfield in webhook channel schemaapproval/channels.ts—ch.secretpassed intoWebhookChannelapproval/webhook.ts— signature computed and attached as headerThis PR only adds the missing receiver-side verification documentation.