Servant.Auth.Server

Documentation

This package provides implementations for some common authentication methods. Authentication yields a trustworthy (because generated by the server) value of an some arbitrary type:

type MyApi = Protected

type Protected = Auth '[JWT, Cookie] User :> Get '[JSON] UserAccountDetails

server :: Server Protected
server (Authenticated usr) = ... -- here we know the client really is
                                 -- who she claims to be
server _ = throwAll err401

Additional configuration happens via Context.

Example for Custom Handler

To use a custom Handler it is necessary to use hoistServerWithContext instead of hoistServer and specify the Context.

Below is an example of passing CookieSettings and JWTSettings in the Context to create a specialized function equivalent to hoistServer for an API that includes cookie authentication.

hoistServerWithAuth
  :: HasServer api '[CookieSettings, JWTSettings]
  => Proxy api
  -> (forall x. m x -> n x)
  -> ServerT api m
  -> ServerT api n
hoistServerWithAuth api =
  hoistServerWithContext api (Proxy :: Proxy '[CookieSettings, JWTSettings])

Auth

Basic types

data Auth (auths :: [Type]) val

Auth [auth1, auth2] val :> api represents an API protected *either* by auth1 or auth2

Instances

HasLink sub => HasLink (Auth tag value :> sub :: Type)

A HasLink instance for Auth

Defined in Servant.Auth

Associated Types

type MkLink (Auth tag value :> sub) a :: Type

Methods

toLink :: (Link -> a) -> Proxy (Auth tag value :> sub) -> Link -> MkLink (Auth tag value :> sub) a

(n ~ S (S Z), HasServer (AddSetCookiesApi n api) ctxs, AreAuths auths ctxs v, HasServer api ctxs, AddSetCookies n (ServerT api Handler) (ServerT (AddSetCookiesApi n api) Handler), ToJWT v, HasContextEntry ctxs CookieSettings, HasContextEntry ctxs JWTSettings) => HasServer (Auth auths v :> api :: Type) ctxs

Defined in Servant.Auth.Server.Internal

Associated Types

type ServerT (Auth auths v :> api) m :: Type

Methods

route :: Proxy (Auth auths v :> api) -> Context ctxs -> Delayed env (Server (Auth auths v :> api)) -> Router env

hoistServerWithContext :: Proxy (Auth auths v :> api) -> Proxy ctxs -> (forall x. m x -> n x) -> ServerT (Auth auths v :> api) m -> ServerT (Auth auths v :> api) n

type MkLink (Auth tag value :> sub :: Type) a

Defined in Servant.Auth

type MkLink (Auth tag value :> sub :: Type) a = MkLink sub a

type ServerT (Auth auths v :> api :: Type) m

Defined in Servant.Auth.Server.Internal

type ServerT (Auth auths v :> api :: Type) m = AuthResult v -> ServerT api m

data AuthResult val

The result of an authentication attempt.

Constructors

BadPassword

NoSuchUser

Authenticated val

Authentication succeeded.

Indefinite

If an authentication procedure cannot be carried out - if for example it expects a password and username in a header that is not present - Indefinite is returned. This indicates that other authentication methods should be tried.

Instances

Monad AuthResult

Defined in Servant.Auth.Server.Internal.Types

Methods

(>>=) :: AuthResult a -> (a -> AuthResult b) -> AuthResult b

(>>) :: AuthResult a -> AuthResult b -> AuthResult b

return :: a -> AuthResult a

fail :: String -> AuthResult a

Functor AuthResult

Defined in Servant.Auth.Server.Internal.Types

Methods

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

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

Applicative AuthResult

Defined in Servant.Auth.Server.Internal.Types

Methods

pure :: a -> AuthResult a

(<*>) :: AuthResult (a -> b) -> AuthResult a -> AuthResult b

liftA2 :: (a -> b -> c) -> AuthResult a -> AuthResult b -> AuthResult c

(*>) :: AuthResult a -> AuthResult b -> AuthResult b

(<*) :: AuthResult a -> AuthResult b -> AuthResult a

Foldable AuthResult

Defined in Servant.Auth.Server.Internal.Types

Methods

fold :: Monoid m => AuthResult m -> m

foldMap :: Monoid m => (a -> m) -> AuthResult a -> m

foldr :: (a -> b -> b) -> b -> AuthResult a -> b

foldr' :: (a -> b -> b) -> b -> AuthResult a -> b

foldl :: (b -> a -> b) -> b -> AuthResult a -> b

foldl' :: (b -> a -> b) -> b -> AuthResult a -> b

foldr1 :: (a -> a -> a) -> AuthResult a -> a

foldl1 :: (a -> a -> a) -> AuthResult a -> a

toList :: AuthResult a -> [a]

null :: AuthResult a -> Bool

length :: AuthResult a -> Int

elem :: Eq a => a -> AuthResult a -> Bool

maximum :: Ord a => AuthResult a -> a

minimum :: Ord a => AuthResult a -> a

sum :: Num a => AuthResult a -> a

product :: Num a => AuthResult a -> a

Traversable AuthResult

Defined in Servant.Auth.Server.Internal.Types

Methods

traverse :: Applicative f => (a -> f b) -> AuthResult a -> f (AuthResult b)

sequenceA :: Applicative f => AuthResult (f a) -> f (AuthResult a)

mapM :: Monad m => (a -> m b) -> AuthResult a -> m (AuthResult b)

sequence :: Monad m => AuthResult (m a) -> m (AuthResult a)

Alternative AuthResult

Defined in Servant.Auth.Server.Internal.Types

Methods

empty :: AuthResult a

(<|>) :: AuthResult a -> AuthResult a -> AuthResult a

some :: AuthResult a -> AuthResult [a]

many :: AuthResult a -> AuthResult [a]

MonadPlus AuthResult

Defined in Servant.Auth.Server.Internal.Types

Methods

mzero :: AuthResult a

mplus :: AuthResult a -> AuthResult a -> AuthResult a

Eq val => Eq (AuthResult val)

Defined in Servant.Auth.Server.Internal.Types

Methods

(==) :: AuthResult val -> AuthResult val -> Bool

(/=) :: AuthResult val -> AuthResult val -> Bool

Ord val => Ord (AuthResult val)

Defined in Servant.Auth.Server.Internal.Types

Methods

compare :: AuthResult val -> AuthResult val -> Ordering

(<) :: AuthResult val -> AuthResult val -> Bool

(<=) :: AuthResult val -> AuthResult val -> Bool

(>) :: AuthResult val -> AuthResult val -> Bool

(>=) :: AuthResult val -> AuthResult val -> Bool

max :: AuthResult val -> AuthResult val -> AuthResult val

min :: AuthResult val -> AuthResult val -> AuthResult val

Read val => Read (AuthResult val)

Defined in Servant.Auth.Server.Internal.Types

Methods

readsPrec :: Int -> ReadS (AuthResult val)

readList :: ReadS [AuthResult val]

readPrec :: ReadPrec (AuthResult val)

readListPrec :: ReadPrec [AuthResult val]

Show val => Show (AuthResult val)

Defined in Servant.Auth.Server.Internal.Types

Methods

showsPrec :: Int -> AuthResult val -> ShowS

show :: AuthResult val -> String

showList :: [AuthResult val] -> ShowS

Generic (AuthResult val)

Defined in Servant.Auth.Server.Internal.Types

Associated Types

type Rep (AuthResult val) :: Type -> Type

Methods

from :: AuthResult val -> Rep (AuthResult val) x

to :: Rep (AuthResult val) x -> AuthResult val

Semigroup (AuthResult val)

Defined in Servant.Auth.Server.Internal.Types

Methods

(<>) :: AuthResult val -> AuthResult val -> AuthResult val

sconcat :: NonEmpty (AuthResult val) -> AuthResult val

stimes :: Integral b => b -> AuthResult val -> AuthResult val

Monoid (AuthResult val)

Defined in Servant.Auth.Server.Internal.Types

Methods

mempty :: AuthResult val

mappend :: AuthResult val -> AuthResult val -> AuthResult val

mconcat :: [AuthResult val] -> AuthResult val

type Rep (AuthResult val)

Defined in Servant.Auth.Server.Internal.Types

type Rep (AuthResult val) = D1 (MetaData "AuthResult" "Servant.Auth.Server.Internal.Types" "servant-auth-server-0.4.6.0-8RJj0uWcvJV2ZGFUGTeUUQ" False) ((C1 (MetaCons "BadPassword" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "NoSuchUser" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "Authenticated" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 val)) :+: C1 (MetaCons "Indefinite" PrefixI False) (U1 :: Type -> Type)))

newtype AuthCheck val

An AuthCheck is the function used to decide the authentication status (the AuthResult) of a request. Different AuthChecks may be combined as a Monoid or Alternative; the semantics of this is that the *first* non-Indefinite result from left to right is used and the rest are ignored.

Constructors

AuthCheck

Fields

• runAuthCheck :: Request -> IO (AuthResult val)

Instances

Monad AuthCheck

Defined in Servant.Auth.Server.Internal.Types

Methods

(>>=) :: AuthCheck a -> (a -> AuthCheck b) -> AuthCheck b

(>>) :: AuthCheck a -> AuthCheck b -> AuthCheck b

return :: a -> AuthCheck a

fail :: String -> AuthCheck a

Functor AuthCheck

Defined in Servant.Auth.Server.Internal.Types

Methods

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

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

MonadFail AuthCheck

Defined in Servant.Auth.Server.Internal.Types

Methods

fail :: String -> AuthCheck a

Applicative AuthCheck

Defined in Servant.Auth.Server.Internal.Types

Methods

pure :: a -> AuthCheck a

(<*>) :: AuthCheck (a -> b) -> AuthCheck a -> AuthCheck b

liftA2 :: (a -> b -> c) -> AuthCheck a -> AuthCheck b -> AuthCheck c

(*>) :: AuthCheck a -> AuthCheck b -> AuthCheck b

(<*) :: AuthCheck a -> AuthCheck b -> AuthCheck a

Alternative AuthCheck

Defined in Servant.Auth.Server.Internal.Types

Methods

empty :: AuthCheck a

(<|>) :: AuthCheck a -> AuthCheck a -> AuthCheck a

some :: AuthCheck a -> AuthCheck [a]

many :: AuthCheck a -> AuthCheck [a]

MonadPlus AuthCheck

Defined in Servant.Auth.Server.Internal.Types

Methods

mzero :: AuthCheck a

mplus :: AuthCheck a -> AuthCheck a -> AuthCheck a

MonadIO AuthCheck

Defined in Servant.Auth.Server.Internal.Types

Methods

liftIO :: IO a -> AuthCheck a

MonadTime AuthCheck

Defined in Servant.Auth.Server.Internal.Types

Methods

currentTime :: AuthCheck UTCTime

MonadReader Request AuthCheck

Defined in Servant.Auth.Server.Internal.Types

Methods

ask :: AuthCheck Request

local :: (Request -> Request) -> AuthCheck a -> AuthCheck a

reader :: (Request -> a) -> AuthCheck a

Generic (AuthCheck val)

Defined in Servant.Auth.Server.Internal.Types

Associated Types

type Rep (AuthCheck val) :: Type -> Type

Methods

from :: AuthCheck val -> Rep (AuthCheck val) x

to :: Rep (AuthCheck val) x -> AuthCheck val

Semigroup (AuthCheck val)

Defined in Servant.Auth.Server.Internal.Types

Methods

(<>) :: AuthCheck val -> AuthCheck val -> AuthCheck val

sconcat :: NonEmpty (AuthCheck val) -> AuthCheck val

stimes :: Integral b => b -> AuthCheck val -> AuthCheck val

Monoid (AuthCheck val)

Defined in Servant.Auth.Server.Internal.Types

Methods

mempty :: AuthCheck val

mappend :: AuthCheck val -> AuthCheck val -> AuthCheck val

mconcat :: [AuthCheck val] -> AuthCheck val

type Rep (AuthCheck val)

Defined in Servant.Auth.Server.Internal.Types

type Rep (AuthCheck val) = D1 (MetaData "AuthCheck" "Servant.Auth.Server.Internal.Types" "servant-auth-server-0.4.6.0-8RJj0uWcvJV2ZGFUGTeUUQ" True) (C1 (MetaCons "AuthCheck" PrefixI True) (S1 (MetaSel (Just "runAuthCheck") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Request -> IO (AuthResult val)))))

JWT

JSON Web Tokens (JWT) are a compact and secure way of transferring information between parties. In this library, they are signed by the server (or by some other party posessing the relevant key), and used to indicate the bearer's identity or authorization.

Arbitrary information can be encoded - just declare instances for the FromJWT and ToJWT classes. Don't go overboard though - be aware that usually you'll be trasmitting this information on each request (and response!).

Note that, while the tokens are signed, they are not encrypted. Do not put any information you do not wish the client to know in them!

Combinator

Re-exported from 'servant-auth'

data JWT

A JSON Web Token (JWT) in the the Authorization header:

Authorization: Bearer token

Note that while the token is signed, it is not encrypted. Therefore do not keep in it any information you would not like the client to know.

JWTs are described in IETF's RFC 7519

Instances

FromJWT usr => IsAuth JWT usr

Defined in Servant.Auth.Server.Internal.Class

Associated Types

type AuthArgs JWT :: [Type]

Methods

runAuth :: proxy JWT -> proxy usr -> Unapp (AuthArgs JWT) (AuthCheck usr)

type AuthArgs JWT

Defined in Servant.Auth.Server.Internal.Class

type AuthArgs JWT = JWTSettings ': ([] :: [Type])

Classes

class FromJWT a where

How to decode data from a JWT.

The default implementation assumes the data is stored in the unregistered dat claim, and uses the FromJSON instance to decode value from there.

Minimal complete definition

Nothing

Methods

decodeJWT :: ClaimsSet -> Either Text a

class ToJWT a where

How to encode data from a JWT.

The default implementation stores data in the unregistered dat claim, and uses the type's ToJSON instance to encode the data.

Minimal complete definition

Nothing

Methods

encodeJWT :: a -> ClaimsSet

Related types

data IsMatch

Constructors

Matches

DoesNotMatch

Instances

Eq IsMatch

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

(==) :: IsMatch -> IsMatch -> Bool

(/=) :: IsMatch -> IsMatch -> Bool

Ord IsMatch

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

compare :: IsMatch -> IsMatch -> Ordering

(<) :: IsMatch -> IsMatch -> Bool

(<=) :: IsMatch -> IsMatch -> Bool

(>) :: IsMatch -> IsMatch -> Bool

(>=) :: IsMatch -> IsMatch -> Bool

max :: IsMatch -> IsMatch -> IsMatch

min :: IsMatch -> IsMatch -> IsMatch

Read IsMatch

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

readsPrec :: Int -> ReadS IsMatch

readList :: ReadS [IsMatch]

readPrec :: ReadPrec IsMatch

readListPrec :: ReadPrec [IsMatch]

Show IsMatch

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

showsPrec :: Int -> IsMatch -> ShowS

show :: IsMatch -> String

showList :: [IsMatch] -> ShowS

Generic IsMatch

Defined in Servant.Auth.Server.Internal.ConfigTypes

Associated Types

type Rep IsMatch :: Type -> Type

Methods

from :: IsMatch -> Rep IsMatch x

to :: Rep IsMatch x -> IsMatch

type Rep IsMatch

Defined in Servant.Auth.Server.Internal.ConfigTypes

type Rep IsMatch = D1 (MetaData "IsMatch" "Servant.Auth.Server.Internal.ConfigTypes" "servant-auth-server-0.4.6.0-8RJj0uWcvJV2ZGFUGTeUUQ" False) (C1 (MetaCons "Matches" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "DoesNotMatch" PrefixI False) (U1 :: Type -> Type))

Settings

data JWTSettings

JWTSettings are used to generate cookies, and to verify JWTs.

Constructors

JWTSettings

Fields

• signingKey :: JWK

  Key used to sign JWT.

• jwtAlg :: Maybe Alg

  Algorithm used to sign JWT.

• validationKeys :: JWKSet

  Keys used to validate JWT.

• audienceMatches :: StringOrURI -> IsMatch

  An aud predicate. The aud is a string or URI that identifies the intended recipient of the JWT.

Instances

Generic JWTSettings

Defined in Servant.Auth.Server.Internal.ConfigTypes

Associated Types

type Rep JWTSettings :: Type -> Type

Methods

from :: JWTSettings -> Rep JWTSettings x

to :: Rep JWTSettings x -> JWTSettings

type Rep JWTSettings

Defined in Servant.Auth.Server.Internal.ConfigTypes

type Rep JWTSettings = D1 (MetaData "JWTSettings" "Servant.Auth.Server.Internal.ConfigTypes" "servant-auth-server-0.4.6.0-8RJj0uWcvJV2ZGFUGTeUUQ" False) (C1 (MetaCons "JWTSettings" PrefixI True) ((S1 (MetaSel (Just "signingKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JWK) :*: S1 (MetaSel (Just "jwtAlg") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Alg))) :*: (S1 (MetaSel (Just "validationKeys") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JWKSet) :*: S1 (MetaSel (Just "audienceMatches") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (StringOrURI -> IsMatch)))))

defaultJWTSettings :: JWK -> JWTSettings

A JWTSettings where the audience always matches.

Create check

jwtAuthCheck :: FromJWT usr => JWTSettings -> AuthCheck usr

A JWT AuthCheck. You likely won't need to use this directly unless you are protecting a Raw endpoint.

Cookie

Cookies are also a method of identifying and authenticating a user. They are particular common when the client is a browser

Combinator

Re-exported from 'servant-auth'

data Cookie

A cookie. The content cookie itself is a JWT. Another cookie is also used, the contents of which are expected to be send back to the server in a header, for XSRF protection.

Instances

FromJWT usr => IsAuth Cookie usr

Defined in Servant.Auth.Server.Internal.Class

Associated Types

type AuthArgs Cookie :: [Type]

Methods

runAuth :: proxy Cookie -> proxy usr -> Unapp (AuthArgs Cookie) (AuthCheck usr)

type AuthArgs Cookie

Defined in Servant.Auth.Server.Internal.Class

type AuthArgs Cookie = CookieSettings ': (JWTSettings ': ([] :: [Type]))

Settings

data CookieSettings

The policies to use when generating cookies.

If *both* cookieMaxAge and cookieExpires are Nothing, browsers will treat the cookie as a *session cookie*. These will be deleted when the browser is closed.

Note that having the setting Secure may cause testing failures if you are not testing over HTTPS.

Constructors

CookieSettings

Fields

• cookieIsSecure :: !IsSecure

  Secure means browsers will only send cookies over HTTPS. Default: Secure.

• cookieMaxAge :: !(Maybe DiffTime)

  How long from now until the cookie expires. Default: Nothing.

• cookieExpires :: !(Maybe UTCTime)

  At what time the cookie expires. Default: Nothing.

• cookiePath :: !(Maybe ByteString)

  The URL path and sub-paths for which this cookie is used. Default: Just "/".

• cookieDomain :: !(Maybe ByteString)

  Domain name, if set cookie also allows subdomains. Default: Nothing.

• cookieSameSite :: !SameSite

  SameSite settings. Default: SameSiteLax.

• sessionCookieName :: !ByteString

  What name to use for the cookie used for the session.

• cookieXsrfSetting :: !(Maybe XsrfCookieSettings)

  The optional settings to use for XSRF protection. Default: Just def.

Instances

Eq CookieSettings

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

(==) :: CookieSettings -> CookieSettings -> Bool

(/=) :: CookieSettings -> CookieSettings -> Bool

Show CookieSettings

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

showsPrec :: Int -> CookieSettings -> ShowS

show :: CookieSettings -> String

showList :: [CookieSettings] -> ShowS

Generic CookieSettings

Defined in Servant.Auth.Server.Internal.ConfigTypes

Associated Types

type Rep CookieSettings :: Type -> Type

Methods

from :: CookieSettings -> Rep CookieSettings x

to :: Rep CookieSettings x -> CookieSettings

Default CookieSettings

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

def :: CookieSettings

type Rep CookieSettings

Defined in Servant.Auth.Server.Internal.ConfigTypes

type Rep CookieSettings = D1 (MetaData "CookieSettings" "Servant.Auth.Server.Internal.ConfigTypes" "servant-auth-server-0.4.6.0-8RJj0uWcvJV2ZGFUGTeUUQ" False) (C1 (MetaCons "CookieSettings" PrefixI True) (((S1 (MetaSel (Just "cookieIsSecure") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 IsSecure) :*: S1 (MetaSel (Just "cookieMaxAge") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DiffTime))) :*: (S1 (MetaSel (Just "cookieExpires") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe UTCTime)) :*: S1 (MetaSel (Just "cookiePath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ByteString)))) :*: ((S1 (MetaSel (Just "cookieDomain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ByteString)) :*: S1 (MetaSel (Just "cookieSameSite") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SameSite)) :*: (S1 (MetaSel (Just "sessionCookieName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ByteString) :*: S1 (MetaSel (Just "cookieXsrfSetting") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe XsrfCookieSettings))))))

data XsrfCookieSettings

The policies to use when generating and verifying XSRF cookies

Constructors

XsrfCookieSettings

Fields

• xsrfCookieName :: !ByteString

  What name to use for the cookie used for XSRF protection.

• xsrfCookiePath :: !(Maybe ByteString)

  What path to use for the cookie used for XSRF protection. Default Just "/".

• xsrfHeaderName :: !ByteString

  What name to use for the header used for XSRF protection.

• xsrfExcludeGet :: !Bool

  Exclude GET request method from XSRF protection.

Instances

Eq XsrfCookieSettings

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

(==) :: XsrfCookieSettings -> XsrfCookieSettings -> Bool

(/=) :: XsrfCookieSettings -> XsrfCookieSettings -> Bool

Show XsrfCookieSettings

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

showsPrec :: Int -> XsrfCookieSettings -> ShowS

show :: XsrfCookieSettings -> String

showList :: [XsrfCookieSettings] -> ShowS

Generic XsrfCookieSettings

Defined in Servant.Auth.Server.Internal.ConfigTypes

Associated Types

type Rep XsrfCookieSettings :: Type -> Type

Methods

from :: XsrfCookieSettings -> Rep XsrfCookieSettings x

to :: Rep XsrfCookieSettings x -> XsrfCookieSettings

Default XsrfCookieSettings

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

def :: XsrfCookieSettings

type Rep XsrfCookieSettings

Defined in Servant.Auth.Server.Internal.ConfigTypes

type Rep XsrfCookieSettings = D1 (MetaData "XsrfCookieSettings" "Servant.Auth.Server.Internal.ConfigTypes" "servant-auth-server-0.4.6.0-8RJj0uWcvJV2ZGFUGTeUUQ" False) (C1 (MetaCons "XsrfCookieSettings" PrefixI True) ((S1 (MetaSel (Just "xsrfCookieName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ByteString) :*: S1 (MetaSel (Just "xsrfCookiePath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ByteString))) :*: (S1 (MetaSel (Just "xsrfHeaderName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ByteString) :*: S1 (MetaSel (Just "xsrfExcludeGet") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool))))

defaultCookieSettings :: CookieSettings

defaultXsrfCookieSettings :: XsrfCookieSettings

makeSessionCookie :: ToJWT v => CookieSettings -> JWTSettings -> v -> IO (Maybe SetCookie)

Makes a cookie with session information.

makeSessionCookieBS :: ToJWT v => CookieSettings -> JWTSettings -> v -> IO (Maybe ByteString)

makeXsrfCookie :: CookieSettings -> IO SetCookie

Makes a cookie to be used for XSRF.

makeCsrfCookie :: CookieSettings -> IO SetCookie

Deprecated: Use makeXsrfCookie instead

Alias for makeXsrfCookie.

makeCookie :: ToJWT v => CookieSettings -> JWTSettings -> v -> IO (Maybe SetCookie)

Deprecated: Use makeSessionCookie instead

Alias for makeSessionCookie.

makeCookieBS :: ToJWT v => CookieSettings -> JWTSettings -> v -> IO (Maybe ByteString)

Deprecated: Use makeSessionCookieBS instead

Alias for makeSessionCookieBS.

acceptLogin :: (ToJWT session, AddHeader "Set-Cookie" SetCookie response withOneCookie, AddHeader "Set-Cookie" SetCookie withOneCookie withTwoCookies) => CookieSettings -> JWTSettings -> session -> IO (Maybe (response -> withTwoCookies))

For a JWT-serializable session, returns a function that decorates a provided response object with XSRF and session cookies. This should be used when a user successfully authenticates with credentials.

clearSession :: (AddHeader "Set-Cookie" SetCookie response withOneCookie, AddHeader "Set-Cookie" SetCookie withOneCookie withTwoCookies) => CookieSettings -> response -> withTwoCookies

Adds headers to a response that clears all session cookies | using max-age and expires cookie attributes.

Related types

data IsSecure

Was this request made over an SSL connection?

Note that this value will not tell you if the client originally made this request over SSL, but rather whether the current connection is SSL. The distinction lies with reverse proxies. In many cases, the client will connect to a load balancer over SSL, but connect to the WAI handler without SSL. In such a case, the handlers would get NotSecure, but from a user perspective, there is a secure connection.

Constructors

Secure

the connection to the server is secure (HTTPS)

NotSecure

the connection to the server is not secure (HTTP)

Instances

Eq IsSecure

Defined in Servant.API.IsSecure

Methods

(==) :: IsSecure -> IsSecure -> Bool

(/=) :: IsSecure -> IsSecure -> Bool

Ord IsSecure

Defined in Servant.API.IsSecure

Methods

compare :: IsSecure -> IsSecure -> Ordering

(<) :: IsSecure -> IsSecure -> Bool

(<=) :: IsSecure -> IsSecure -> Bool

(>) :: IsSecure -> IsSecure -> Bool

(>=) :: IsSecure -> IsSecure -> Bool

max :: IsSecure -> IsSecure -> IsSecure

min :: IsSecure -> IsSecure -> IsSecure

Read IsSecure

Defined in Servant.API.IsSecure

Methods

readsPrec :: Int -> ReadS IsSecure

readList :: ReadS [IsSecure]

readPrec :: ReadPrec IsSecure

readListPrec :: ReadPrec [IsSecure]

Show IsSecure

Defined in Servant.API.IsSecure

Methods

showsPrec :: Int -> IsSecure -> ShowS

show :: IsSecure -> String

showList :: [IsSecure] -> ShowS

Generic IsSecure

Defined in Servant.API.IsSecure

Associated Types

type Rep IsSecure :: Type -> Type

Methods

from :: IsSecure -> Rep IsSecure x

to :: Rep IsSecure x -> IsSecure

HasLink sub => HasLink (IsSecure :> sub :: Type)

Defined in Servant.Links

Associated Types

type MkLink (IsSecure :> sub) a :: Type

Methods

toLink :: (Link -> a) -> Proxy (IsSecure :> sub) -> Link -> MkLink (IsSecure :> sub) a

HasServer api context => HasServer (IsSecure :> api :: Type) context

Defined in Servant.Server.Internal

Associated Types

type ServerT (IsSecure :> api) m :: Type

Methods

route :: Proxy (IsSecure :> api) -> Context context -> Delayed env (Server (IsSecure :> api)) -> Router env

hoistServerWithContext :: Proxy (IsSecure :> api) -> Proxy context -> (forall x. m x -> n x) -> ServerT (IsSecure :> api) m -> ServerT (IsSecure :> api) n

type Rep IsSecure

Defined in Servant.API.IsSecure

type Rep IsSecure = D1 (MetaData "IsSecure" "Servant.API.IsSecure" "servant-0.18-32RIkw5w1diK18VC7zPjEU" False) (C1 (MetaCons "Secure" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "NotSecure" PrefixI False) (U1 :: Type -> Type))

type MkLink (IsSecure :> sub :: Type) a

Defined in Servant.Links

type MkLink (IsSecure :> sub :: Type) a = MkLink sub a

type ServerT (IsSecure :> api :: Type) m

Defined in Servant.Server.Internal

type ServerT (IsSecure :> api :: Type) m = IsSecure -> ServerT api m

data SameSite

Constructors

AnySite

SameSiteStrict

SameSiteLax

Instances

Eq SameSite

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

(==) :: SameSite -> SameSite -> Bool

(/=) :: SameSite -> SameSite -> Bool

Ord SameSite

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

compare :: SameSite -> SameSite -> Ordering

(<) :: SameSite -> SameSite -> Bool

(<=) :: SameSite -> SameSite -> Bool

(>) :: SameSite -> SameSite -> Bool

(>=) :: SameSite -> SameSite -> Bool

max :: SameSite -> SameSite -> SameSite

min :: SameSite -> SameSite -> SameSite

Read SameSite

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

readsPrec :: Int -> ReadS SameSite

readList :: ReadS [SameSite]

readPrec :: ReadPrec SameSite

readListPrec :: ReadPrec [SameSite]

Show SameSite

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

showsPrec :: Int -> SameSite -> ShowS

show :: SameSite -> String

showList :: [SameSite] -> ShowS

Generic SameSite

Defined in Servant.Auth.Server.Internal.ConfigTypes

Associated Types

type Rep SameSite :: Type -> Type

Methods

from :: SameSite -> Rep SameSite x

to :: Rep SameSite x -> SameSite

type Rep SameSite

Defined in Servant.Auth.Server.Internal.ConfigTypes

type Rep SameSite = D1 (MetaData "SameSite" "Servant.Auth.Server.Internal.ConfigTypes" "servant-auth-server-0.4.6.0-8RJj0uWcvJV2ZGFUGTeUUQ" False) (C1 (MetaCons "AnySite" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "SameSiteStrict" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "SameSiteLax" PrefixI False) (U1 :: Type -> Type)))

class AreAuths (as :: [*]) (ctxs :: [*]) v

Minimal complete definition

runAuths

Instances

AreAuths ([] :: [Type]) ctxs v

Defined in Servant.Auth.Server.Internal.Class

Methods

runAuths :: proxy [] -> Context ctxs -> AuthCheck v

(AuthCheck v ~ App (AuthArgs a) (Unapp (AuthArgs a) (AuthCheck v)), IsAuth a v, AreAuths as ctxs v, AppCtx ctxs (AuthArgs a) (Unapp (AuthArgs a) (AuthCheck v))) => AreAuths (a ': as) ctxs v

Defined in Servant.Auth.Server.Internal.Class

Methods

runAuths :: proxy (a ': as) -> Context ctxs -> AuthCheck v

BasicAuth

Combinator

Re-exported from 'servant-auth'

data BasicAuth

Basic Auth.

Instances

FromBasicAuthData usr => IsAuth BasicAuth usr

Defined in Servant.Auth.Server.Internal.Class

Associated Types

type AuthArgs BasicAuth :: [Type]

Methods

runAuth :: proxy BasicAuth -> proxy usr -> Unapp (AuthArgs BasicAuth) (AuthCheck usr)

type AuthArgs BasicAuth

Defined in Servant.Auth.Server.Internal.Class

type AuthArgs BasicAuth = BasicAuthCfg ': ([] :: [Type])

Classes

class FromBasicAuthData a where

Methods

fromBasicAuthData :: BasicAuthData -> BasicAuthCfg -> IO (AuthResult a)

Whether the username exists and the password is correct. Note that, rather than passing a Pass to the function, we pass a function that checks an EncryptedPass. This is to make sure you don't accidentally do something untoward with the password, like store it.

Settings

type family BasicAuthCfg

A type holding the configuration for Basic Authentication. It is defined as a type family with no arguments, so that it can be instantiated to whatever type you need to authenticate your users (use type instance BasicAuthCfg = ...).

Note that the instantiation is application-wide, i.e. there can be only one instance. As a consequence, it should not be instantiated in a library.

Basic Authentication expects an element of type BasicAuthCfg to be in the Context; that element is then passed automatically to the instance of FromBasicAuthData together with the authentication data obtained from the client.

If you do not need a configuration for Basic Authentication, you can use just BasicAuthCfg = (), and recall to also add () to the Context. A basic but more interesting example is to take as BasicAuthCfg a list of authorised username/password pairs:

deriving instance Eq BasicAuthData
type instance BasicAuthCfg = [BasicAuthData]
instance FromBasicAuthData User where
  fromBasicAuthData authData authCfg =
    if elem authData authCfg then ...

Related types

data BasicAuthData

A simple datatype to hold data required to decorate a request

Constructors

BasicAuthData

Fields

• basicAuthUsername :: !ByteString
• basicAuthPassword :: !ByteString

data IsPasswordCorrect

Constructors

PasswordCorrect

PasswordIncorrect

Instances

Eq IsPasswordCorrect

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

(==) :: IsPasswordCorrect -> IsPasswordCorrect -> Bool

(/=) :: IsPasswordCorrect -> IsPasswordCorrect -> Bool

Ord IsPasswordCorrect

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

compare :: IsPasswordCorrect -> IsPasswordCorrect -> Ordering

(<) :: IsPasswordCorrect -> IsPasswordCorrect -> Bool

(<=) :: IsPasswordCorrect -> IsPasswordCorrect -> Bool

(>) :: IsPasswordCorrect -> IsPasswordCorrect -> Bool

(>=) :: IsPasswordCorrect -> IsPasswordCorrect -> Bool

max :: IsPasswordCorrect -> IsPasswordCorrect -> IsPasswordCorrect

min :: IsPasswordCorrect -> IsPasswordCorrect -> IsPasswordCorrect

Read IsPasswordCorrect

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

readsPrec :: Int -> ReadS IsPasswordCorrect

readList :: ReadS [IsPasswordCorrect]

readPrec :: ReadPrec IsPasswordCorrect

readListPrec :: ReadPrec [IsPasswordCorrect]

Show IsPasswordCorrect

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

showsPrec :: Int -> IsPasswordCorrect -> ShowS

show :: IsPasswordCorrect -> String

showList :: [IsPasswordCorrect] -> ShowS

Generic IsPasswordCorrect

Defined in Servant.Auth.Server.Internal.ConfigTypes

Associated Types

type Rep IsPasswordCorrect :: Type -> Type

Methods

from :: IsPasswordCorrect -> Rep IsPasswordCorrect x

to :: Rep IsPasswordCorrect x -> IsPasswordCorrect

type Rep IsPasswordCorrect

Defined in Servant.Auth.Server.Internal.ConfigTypes

type Rep IsPasswordCorrect = D1 (MetaData "IsPasswordCorrect" "Servant.Auth.Server.Internal.ConfigTypes" "servant-auth-server-0.4.6.0-8RJj0uWcvJV2ZGFUGTeUUQ" False) (C1 (MetaCons "PasswordCorrect" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "PasswordIncorrect" PrefixI False) (U1 :: Type -> Type))

Authentication request

wwwAuthenticatedErr :: ByteString -> ServerError

A ServerError that asks the client to authenticate via Basic Authentication, should be invoked by an application whenever appropriate. The argument is the realm.

Utilies

class ThrowAll a where

Methods

throwAll :: ServerError -> a

throwAll is a convenience function to throw errors across an entire sub-API

throwAll err400 :: Handler a :<|> Handler b :<|> Handler c
   == throwError err400 :<|> throwError err400 :<|> err400

Instances

ThrowAll Application

for servant <0.11

Defined in Servant.Auth.Server.Internal.ThrowAll

Methods

throwAll :: ServerError -> Application

MonadError ServerError m => ThrowAll (m a)

Defined in Servant.Auth.Server.Internal.ThrowAll

Methods

throwAll :: ServerError -> m a

ThrowAll b => ThrowAll (a -> b)

Defined in Servant.Auth.Server.Internal.ThrowAll

Methods

throwAll :: ServerError -> a -> b

(ThrowAll a, ThrowAll b) => ThrowAll (a :<|> b)

Defined in Servant.Auth.Server.Internal.ThrowAll

Methods

throwAll :: ServerError -> a :<|> b

MonadError ServerError m => ThrowAll (Tagged m Application)

for servant >=0.11

Defined in Servant.Auth.Server.Internal.ThrowAll

Methods

throwAll :: ServerError -> Tagged m Application

generateKey :: IO JWK

Generate a key suitable for use with defaultConfig.

generateSecret :: MonadRandom m => m ByteString

Generate a bytestring suitable for use with fromSecret.

fromSecret :: ByteString -> JWK

Restores a key from a bytestring.

writeKey :: FilePath -> IO ()

Writes a secret to a file. Can for instance be used from the REPL to persist a key to a file, which can then be included with the application. Restore the key using readKey.

readKey :: FilePath -> IO JWK

Reads a key from a file.

makeJWT :: ToJWT a => a -> JWTSettings -> Maybe UTCTime -> IO (Either Error ByteString)

Creates a JWT containing the specified data. The data is stored in the dat claim. The 'Maybe UTCTime' argument indicates the time at which the token expires.

verifyJWT :: FromJWT a => JWTSettings -> ByteString -> IO (Maybe a)

Re-exports

class Default a where

A class for types with a default value.

Minimal complete definition

Nothing

Methods

def :: a

The default value for this type.

Instances

Default Double

Defined in Data.Default.Class

Methods

def :: Double

Default Float

Defined in Data.Default.Class

Methods

def :: Float

Default Int

Defined in Data.Default.Class

Methods

def :: Int

Default Int8

Defined in Data.Default.Class

Methods

def :: Int8

Default Int16

Defined in Data.Default.Class

Methods

def :: Int16

Default Int32

Defined in Data.Default.Class

Methods

def :: Int32

Default Int64

Defined in Data.Default.Class

Methods

def :: Int64

Default Integer

Defined in Data.Default.Class

Methods

def :: Integer

Default Ordering

Defined in Data.Default.Class

Methods

def :: Ordering

Default Word

Defined in Data.Default.Class

Methods

def :: Word

Default Word8

Defined in Data.Default.Class

Methods

def :: Word8

Default Word16

Defined in Data.Default.Class

Methods

def :: Word16

Default Word32

Defined in Data.Default.Class

Methods

def :: Word32

Default Word64

Defined in Data.Default.Class

Methods

def :: Word64

Default ()

Defined in Data.Default.Class

Methods

def :: ()

Default All

Defined in Data.Default.Class

Methods

def :: All

Default Any

Defined in Data.Default.Class

Methods

def :: Any

Default CShort

Defined in Data.Default.Class

Methods

def :: CShort

Default CUShort

Defined in Data.Default.Class

Methods

def :: CUShort

Default CInt

Defined in Data.Default.Class

Methods

def :: CInt

Default CUInt

Defined in Data.Default.Class

Methods

def :: CUInt

Default CLong

Defined in Data.Default.Class

Methods

def :: CLong

Default CULong

Defined in Data.Default.Class

Methods

def :: CULong

Default CLLong

Defined in Data.Default.Class

Methods

def :: CLLong

Default CULLong

Defined in Data.Default.Class

Methods

def :: CULLong

Default CFloat

Defined in Data.Default.Class

Methods

def :: CFloat

Default CDouble

Defined in Data.Default.Class

Methods

def :: CDouble

Default CPtrdiff

Defined in Data.Default.Class

Methods

def :: CPtrdiff

Default CSize

Defined in Data.Default.Class

Methods

def :: CSize

Default CSigAtomic

Defined in Data.Default.Class

Methods

def :: CSigAtomic

Default CClock

Defined in Data.Default.Class

Methods

def :: CClock

Default CTime

Defined in Data.Default.Class

Methods

def :: CTime

Default CUSeconds

Defined in Data.Default.Class

Methods

def :: CUSeconds

Default CSUSeconds

Defined in Data.Default.Class

Methods

def :: CSUSeconds

Default CIntPtr

Defined in Data.Default.Class

Methods

def :: CIntPtr

Default CUIntPtr

Defined in Data.Default.Class

Methods

def :: CUIntPtr

Default CIntMax

Defined in Data.Default.Class

Methods

def :: CIntMax

Default CUIntMax

Defined in Data.Default.Class

Methods

def :: CUIntMax

Default SetCookie

def = defaultSetCookie

Defined in Web.Cookie

Methods

def :: SetCookie

Default XsrfCookieSettings

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

def :: XsrfCookieSettings

Default CookieSettings

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

def :: CookieSettings

Default [a]

Defined in Data.Default.Class

Methods

def :: [a]

Default (Maybe a)

Defined in Data.Default.Class

Methods

def :: Maybe a

Integral a => Default (Ratio a)

Defined in Data.Default.Class

Methods

def :: Ratio a

Default a => Default (IO a)

Defined in Data.Default.Class

Methods

def :: IO a

(Default a, RealFloat a) => Default (Complex a)

Defined in Data.Default.Class

Methods

def :: Complex a

Default (First a)

Defined in Data.Default.Class

Methods

def :: First a

Default (Last a)

Defined in Data.Default.Class

Methods

def :: Last a

Default a => Default (Dual a)

Defined in Data.Default.Class

Methods

def :: Dual a

Default (Endo a)

Defined in Data.Default.Class

Methods

def :: Endo a

Num a => Default (Sum a)

Defined in Data.Default.Class

Methods

def :: Sum a

Num a => Default (Product a)

Defined in Data.Default.Class

Methods

def :: Product a

Default r => Default (e -> r)

Defined in Data.Default.Class

Methods

def :: e -> r

(Default a, Default b) => Default (a, b)

Defined in Data.Default.Class

Methods

def :: (a, b)

(Default a, Default b, Default c) => Default (a, b, c)

Defined in Data.Default.Class

Methods

def :: (a, b, c)

(Default a, Default b, Default c, Default d) => Default (a, b, c, d)

Defined in Data.Default.Class

Methods

def :: (a, b, c, d)

(Default a, Default b, Default c, Default d, Default e) => Default (a, b, c, d, e)

Defined in Data.Default.Class

Methods

def :: (a, b, c, d, e)

(Default a, Default b, Default c, Default d, Default e, Default f) => Default (a, b, c, d, e, f)

Defined in Data.Default.Class

Methods

def :: (a, b, c, d, e, f)

(Default a, Default b, Default c, Default d, Default e, Default f, Default g) => Default (a, b, c, d, e, f, g)

Defined in Data.Default.Class

Methods

def :: (a, b, c, d, e, f, g)

data SetCookie

Data type representing the key-value pair to use for a cookie, as well as configuration options for it.

Creating a SetCookie

SetCookie does not export a constructor; instead, use defaultSetCookie and override values (see http://www.yesodweb.com/book/settings-types for details):

import Web.Cookie
:set -XOverloadedStrings
let cookie = defaultSetCookie { setCookieName = "cookieName", setCookieValue = "cookieValue" }

Cookie Configuration

Cookies have several configuration options; a brief summary of each option is given below. For more information, see RFC 6265 or Wikipedia.

Instances

Eq SetCookie

Defined in Web.Cookie

Methods

(==) :: SetCookie -> SetCookie -> Bool

(/=) :: SetCookie -> SetCookie -> Bool

Show SetCookie

Defined in Web.Cookie

Methods

showsPrec :: Int -> SetCookie -> ShowS

show :: SetCookie -> String

showList :: [SetCookie] -> ShowS

NFData SetCookie

Defined in Web.Cookie

Methods

rnf :: SetCookie -> ()

Default SetCookie

def = defaultSetCookie

Defined in Web.Cookie

Methods

def :: SetCookie

ToHttpApiData SetCookie

Note: this instance works correctly for alphanumeric name and value

>>> let Right c = parseUrlPiece "SESSID=r2t5uvjq435r4q7ib3vtdjq120" :: Either Text SetCookie
>>> toUrlPiece c
"SESSID=r2t5uvjq435r4q7ib3vtdjq120"

>>> toHeader c
"SESSID=r2t5uvjq435r4q7ib3vtdjq120"

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: SetCookie -> Text

toEncodedUrlPiece :: SetCookie -> Builder

toHeader :: SetCookie -> ByteString

toQueryParam :: SetCookie -> Text

FromHttpApiData SetCookie

Note: this instance works correctly for alphanumeric name and value

>>> parseUrlPiece "SESSID=r2t5uvjq435r4q7ib3vtdjq120" :: Either Text SetCookie
Right (SetCookie {setCookieName = "SESSID", setCookieValue = "r2t5uvjq435r4q7ib3vtdjq120", setCookiePath = Nothing, setCookieExpires = Nothing, setCookieMaxAge = Nothing, setCookieDomain = Nothing, setCookieHttpOnly = False, setCookieSecure = False, setCookieSameSite = Nothing})

Defined in Web.Internal.HttpApiData

Methods

parseUrlPiece :: Text -> Either Text SetCookie

parseHeader :: ByteString -> Either Text SetCookie

parseQueryParam :: Text -> Either Text SetCookie