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

Methods

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

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

return :: a -> AuthResult a

fail :: String -> AuthResult a

Functor AuthResult

Methods

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

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

Applicative AuthResult

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

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

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

Methods

empty :: AuthResult a

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

some :: AuthResult a -> AuthResult [a]

many :: AuthResult a -> AuthResult [a]

MonadPlus AuthResult

Methods

mzero :: AuthResult a

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

Eq val => Eq (AuthResult val)

Methods

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

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

Ord val => Ord (AuthResult val)

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)

Methods

readsPrec :: Int -> ReadS (AuthResult val)

readList :: ReadS [AuthResult val]

readPrec :: ReadPrec (AuthResult val)

readListPrec :: ReadPrec [AuthResult val]

Show val => Show (AuthResult val)

Methods

showsPrec :: Int -> AuthResult val -> ShowS

show :: AuthResult val -> String

showList :: [AuthResult val] -> ShowS

Generic (AuthResult val)

Associated Types

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

Methods

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

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

Semigroup (AuthResult val)

Methods

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

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

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

Monoid (AuthResult val)

Methods

mempty :: AuthResult val

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

mconcat :: [AuthResult val] -> AuthResult val

type Rep (AuthResult val)

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

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

Methods

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

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

return :: a -> AuthCheck a

fail :: String -> AuthCheck a

Functor AuthCheck

Methods

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

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

Applicative AuthCheck

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

Methods

empty :: AuthCheck a

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

some :: AuthCheck a -> AuthCheck [a]

many :: AuthCheck a -> AuthCheck [a]

MonadPlus AuthCheck

Methods

mzero :: AuthCheck a

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

MonadIO AuthCheck

Methods

liftIO :: IO a -> AuthCheck a

MonadTime AuthCheck

Methods

currentTime :: AuthCheck UTCTime

MonadReader Request AuthCheck

Methods

ask :: AuthCheck Request

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

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

Generic (AuthCheck val)

Associated Types

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

Methods

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

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

Semigroup (AuthCheck val)

Methods

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

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

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

Monoid (AuthCheck val)

Methods

mempty :: AuthCheck val

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

mconcat :: [AuthCheck val] -> AuthCheck val

type Rep (AuthCheck val)

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