Servant combinators to facilitate writing GitHub webhooks.
|Version on this page:||0.4.1.0|
|LTS Haskell 17.15:||0.4.2.0|
|Stackage Nightly 2022-02-07:||0.4.2.0|
|Latest on Hackage:||0.4.2.0|
Module documentation for 0.4.1.0
This library facilitates writing Servant routes that can safely act as GitHub webhooks.
- Dispatching to routes based on the type of repository event.
- Automatic verification of request signatures.
- Route protection expressed in the type system, so webhook routes and regular routes cannot be confused.
Why use servant-github-webhook?
A webhook server needs to be publicly hosted. How can legitimate requests sent by GitHub be distinguished from (malicious) requests sent by other clients?
When a webhook is configured on a repository, a secret key is added. This key is used by GitHub to compute a signature of the request body that it sends; this signature is included in the request headers. The routing combinators in servant-github-webhook compute the signature of the received request body using the same key, and check that the signature in the request headers matches. If it does, then the request is legitimate.
Revision history for servant-github-webhook
0.4.1.0 – 2018-04-07
- Include integration with github-webhooks package.
- Code is adjusted for backwards-compatibility with GHC 7.10.
HasServerinstances are updated for servant-0.13 or later, due to
0.4.0.0 – 2018-02-03
- Use constant-time equality to check signatures.
- Add dynamic key capabilities.
0.3.2.0 – 2017-12-25
- Support GHC 8.2 /
- Bump up version bound for
0.3.1.0 – 2017-08-06
- Drop support for GHC <8.
- Drop support for Servant <0.11.
- Switch from Crypto package to cryptonite package.
- Now servant-github-webhook builds with stack.
0.3.0.0 – 2016-09-22
- Pass reflected key index to the handler function for GitHubSignedReqBody. This allows for more generic handler functions, as they can determine programmatically which repository they are responding to.
0.2.0.1 – 2016-09-13
- Improve documentation (formatting and typos) and examples (remove unnecessary verbosity).
0.2.0.0 – 2016-09-11
GitHubSignedReqBody''to allow for configuring multiple signing keys, on a per-route basis.
GitHubKeytake a function instead of simply an
KProxy, to make writing
0.1.0.0 – 2016-09-10
GitHubSignedReqBodycombinator for automatic signature verification during routing.
GitHubEventcombinator for dispatching to routes based on the webhook type.
- Known issue: only one global
GitHubKeycan be used across all routes.