Safe Haskell	Safe-Inferred
Language	Haskell2010

Servant.Auth.Hmac.Client

Contents

Description

Servant client authentication.

Synopsis

HMAC client settings

Environment for HmacClientM. Contains all required settings for hmac client.

Constructors

HmacSettings
Fields hmacSigner :: SecretKey -> ByteString -> Signature Singing function that will sign all outgoing requests. hmacSecretKey :: SecretKey Secret key for signing function. hmacRequestHook :: Maybe (Request -> ClientM ()) Function to call for every request after this request is signed. Useful for debugging.

Instances details

MonadReader HmacSettings HmacClientM Source #
Instance details Defined in Servant.Auth.Hmac.Client Methods ask :: HmacClientM HmacSettings # local :: (HmacSettings -> HmacSettings) -> HmacClientM a -> HmacClientM a # reader :: (HmacSettings -> a) -> HmacClientM a #

Default HmacSettings with the following configuration:

HMAC servant client

newtype wrapper over ClientM that signs all outgoing requests automatically.

Constructors

HmacClientM
Fields runHmacClientM :: ReaderT HmacSettings ClientM a

Instances details

MonadIO HmacClientM Source #
Instance details Defined in Servant.Auth.Hmac.Client Methods liftIO :: IO a -> HmacClientM a #
Applicative HmacClientM Source #
Instance details Defined in Servant.Auth.Hmac.Client Methods pure :: a -> HmacClientM a # (<>) :: HmacClientM (a -> b) -> HmacClientM a -> HmacClientM b # liftA2 :: (a -> b -> c) -> HmacClientM a -> HmacClientM b -> HmacClientM c # (>) :: HmacClientM a -> HmacClientM b -> HmacClientM b # (<*) :: HmacClientM a -> HmacClientM b -> HmacClientM a #
Functor HmacClientM Source #
Instance details Defined in Servant.Auth.Hmac.Client Methods fmap :: (a -> b) -> HmacClientM a -> HmacClientM b # (<$) :: a -> HmacClientM b -> HmacClientM a #
Monad HmacClientM Source #
Instance details Defined in Servant.Auth.Hmac.Client Methods (>>=) :: HmacClientM a -> (a -> HmacClientM b) -> HmacClientM b # (>>) :: HmacClientM a -> HmacClientM b -> HmacClientM b # return :: a -> HmacClientM a #
RunClient HmacClientM Source #
Instance details Defined in Servant.Auth.Hmac.Client Methods runRequestAcceptStatus :: Maybe [Status] -> Request -> HmacClientM Response # throwClientError :: ClientError -> HmacClientM a #
MonadReader HmacSettings HmacClientM Source #
Instance details Defined in Servant.Auth.Hmac.Client Methods ask :: HmacClientM HmacSettings # local :: (HmacSettings -> HmacSettings) -> HmacClientM a -> HmacClientM a # reader :: (HmacSettings -> a) -> HmacClientM a #

Generates a set of client functions for an API.