Servant.Auth.Server.Internal.Types

Documentation

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

Functor AuthResult

Applicative AuthResult

Foldable AuthResult

Traversable AuthResult

Alternative AuthResult

MonadPlus AuthResult

Eq val => Eq (AuthResult val)

Ord val => Ord (AuthResult val)

Read val => Read (AuthResult val)

Show val => Show (AuthResult val)

Generic (AuthResult val)

Monoid (AuthResult val)

type Rep (AuthResult val)

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.

Constructors

AuthCheck

Fields

runAuthCheck :: Request -> IO (AuthResult val)

Instances

Monad AuthCheck

Functor AuthCheck

Applicative AuthCheck

Alternative AuthCheck

MonadPlus AuthCheck

MonadTime AuthCheck

MonadIO AuthCheck

MonadReader Request AuthCheck

Generic (AuthCheck val)

Monoid (AuthCheck val)

type Rep (AuthCheck val)