servant-0.14.1: A family of combinators for defining webservices APIs

Safe HaskellSafe




data BasicAuth (realm :: Symbol) (userData :: *) Source #

Combinator for Basic Access Authentication.

  • IMPORTANT*: Only use Basic Auth over HTTPS! Credentials are not hashed or encrypted. Note also that because the same credentials are sent on every request, Basic Auth is not as secure as some alternatives. Further, the implementation in servant-server does not protect against some types of timing attacks.

In Basic Auth, username and password are base64-encoded and transmitted via the Authorization header. Handshakes are not required, making it relatively efficient.

HasLink sub => HasLink (BasicAuth realm a :> sub :: *) Source # 
Instance details

Defined in Servant.Links

Associated Types

type MkLink (BasicAuth realm a :> sub) a :: * Source #


toLink :: (Link -> a0) -> Proxy (BasicAuth realm a :> sub) -> Link -> MkLink (BasicAuth realm a :> sub) a0 Source #

type MkLink (BasicAuth realm a :> sub :: *) r Source # 
Instance details

Defined in Servant.Links

type MkLink (BasicAuth realm a :> sub :: *) r = MkLink sub r

data BasicAuthData Source #

A simple datatype to hold data required to decorate a request