mirrors/webhook
1
0
Fork 0
mirror of https://github.com/adnanh/webhook.git synced 2025-06-28 07:18:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Transition payload hash option names to hmac

Browse source 
The payload-hash-* options are imprecisely named. Clarify their function
as HMAC validations by renaming them. The existing options will continue
to work but are deprecated.  Log a warning if the old options are used.

All tests, examples, and documentation are updated.

Fixes #289
This commit is contained in:
Cameron Moore 2020-09-24 21:37:49 -05:00
parent 6797bf7cf7
commit 6bbf14f7d9
11 changed files with 47 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/Templates.md
View file

@ -6,7 +6,7 @@ In additional to the [built-in Go template functions and features][tt], `webhook
## Example Usage
In the example `hooks.json` file below, the `payload-hash-sha1` matching rule looks up the secret hash from the environment using the `getenv` template function.
In the example `hooks.json` file below, the `payload-hmac-sha1` matching rule looks up the HMAC secret from the environment using the `getenv` template function.
Additionally, the result is piped through the built-in Go template function `js` to ensure that the result is a well-formed Javascript/JSON string.
```
@ -44,7 +44,7 @@ Additionally, the result is piped through the built-in Go template function `js`
{
"match":
{
"type": "payload-hash-sha1",
"type": "payload-hmac-sha1",
"secret": "{{ getenv "XXXTEST_SECRET" | js }}",
"parameter":
{