Servant.Auth.Hmac.Client

Servant client authentication.

HMAC client settings

data HmacSettings

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

MonadReader HmacSettings HmacClientM

Defined in Servant.Auth.Hmac.Client

Methods

ask :: HmacClientM HmacSettings

local :: (HmacSettings -> HmacSettings) -> HmacClientM a -> HmacClientM a

reader :: (HmacSettings -> a) -> HmacClientM a

defaultHmacSettings :: SecretKey -> HmacSettings

Default HmacSettings with the following configuration:

1. Signing function is signSHA256.
2. Secret key is provided.
3. hmacRequestHook is Nothing.

HMAC servant client

newtype HmacClientM a

newtype wrapper over ClientM that signs all outgoing requests automatically.

Constructors

HmacClientM

Fields

• runHmacClientM :: ReaderT HmacSettings ClientM a

Instances

MonadIO HmacClientM

Defined in Servant.Auth.Hmac.Client

Methods

liftIO :: IO a -> HmacClientM a

Applicative HmacClientM

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

Defined in Servant.Auth.Hmac.Client

Methods

fmap :: (a -> b) -> HmacClientM a -> HmacClientM b

(<$) :: a -> HmacClientM b -> HmacClientM a

Monad HmacClientM

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

Defined in Servant.Auth.Hmac.Client

Methods

runRequestAcceptStatus :: Maybe [Status] -> Request -> HmacClientM Response

throwClientError :: ClientError -> HmacClientM a

MonadReader HmacSettings HmacClientM

Defined in Servant.Auth.Hmac.Client

Methods

ask :: HmacClientM HmacSettings

local :: (HmacSettings -> HmacSettings) -> HmacClientM a -> HmacClientM a

reader :: (HmacSettings -> a) -> HmacClientM a

runHmacClient :: HmacSettings -> ClientEnv -> HmacClientM a -> IO (Either ClientError a)

hmacClient :: forall api. HasClient HmacClientM api => Client HmacClientM api

Generates a set of client functions for an API.