Safe Haskell	Trustworthy
Language	Haskell2010

GitHub.Data.Webhooks.Secure

Description

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

Synopsis

data PayloadNotSecure = PayloadNotSecure
isSecurePayload :: Text -> Maybe Text -> ByteString -> Bool
assertSecurePayload :: Text -> Maybe Text -> ByteString -> IO ()

Documentation

data PayloadNotSecure Source #

An exception indicating that the given payload is not secure.

Constructors

PayloadNotSecure

Instances

Show PayloadNotSecure Source #
Instance details Defined in GitHub.Data.Webhooks.Secure Methods showsPrec :: Int -> PayloadNotSecure -> ShowS # show :: PayloadNotSecure -> String # showList :: [PayloadNotSecure] -> ShowS #
Exception PayloadNotSecure Source #
Instance details Defined in GitHub.Data.Webhooks.Secure Methods toException :: PayloadNotSecure -> SomeException # fromException :: SomeException -> Maybe PayloadNotSecure # displayException :: PayloadNotSecure -> String #

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

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 () Source #

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