GitHub.Data.Webhooks.Secure

See https://developer.github.com/webhooks/securing/.

Documentation

data PayloadNotSecure

An exception indicating that the given payload is not secure.

Constructors

PayloadNotSecure

Instances

Show PayloadNotSecure

Defined in GitHub.Data.Webhooks.Secure

Methods

showsPrec :: Int -> PayloadNotSecure -> ShowS

show :: PayloadNotSecure -> String

showList :: [PayloadNotSecure] -> ShowS

Exception PayloadNotSecure

Defined in GitHub.Data.Webhooks.Secure

Methods

toException :: PayloadNotSecure -> SomeException

fromException :: SomeException -> Maybe PayloadNotSecure

displayException :: PayloadNotSecure -> String

isSecurePayload :: Text -> Maybe Text -> ByteString -> Bool

Returns True if the given HMAC digest (passed in the X-Hub-Signature header) agrees with the provided secret and request body. If not, this request may be forged.

assertSecurePayload :: Text -> Maybe Text -> ByteString -> IO ()

Like isSecurePayload, but throws PayloadNotSecure if the payload is not secure.