Servant.Server.Internal.BasicAuth

Basic Auth

data BasicAuthResult usr

servant-server's current implementation of basic authentication is not immune to certian kinds of timing attacks. Decoding payloads does not take a fixed amount of time.

The result of authentication/authorization

Constructors

Unauthorized

BadPassword

NoSuchUser

Authorized usr

Instances

Functor BasicAuthResult

Defined in Servant.Server.Internal.BasicAuth

Methods

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

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

Eq usr => Eq (BasicAuthResult usr)

Defined in Servant.Server.Internal.BasicAuth

Methods

(==) :: BasicAuthResult usr -> BasicAuthResult usr -> Bool

(/=) :: BasicAuthResult usr -> BasicAuthResult usr -> Bool

Read usr => Read (BasicAuthResult usr)

Defined in Servant.Server.Internal.BasicAuth

Methods

readsPrec :: Int -> ReadS (BasicAuthResult usr)

readList :: ReadS [BasicAuthResult usr]

readPrec :: ReadPrec (BasicAuthResult usr)

readListPrec :: ReadPrec [BasicAuthResult usr]

Show usr => Show (BasicAuthResult usr)

Defined in Servant.Server.Internal.BasicAuth

Methods

showsPrec :: Int -> BasicAuthResult usr -> ShowS

show :: BasicAuthResult usr -> String

showList :: [BasicAuthResult usr] -> ShowS

Generic (BasicAuthResult usr)

Defined in Servant.Server.Internal.BasicAuth

Associated Types

type Rep (BasicAuthResult usr) :: Type -> Type

Methods

from :: BasicAuthResult usr -> Rep (BasicAuthResult usr) x

to :: Rep (BasicAuthResult usr) x -> BasicAuthResult usr

type Rep (BasicAuthResult usr)

Defined in Servant.Server.Internal.BasicAuth

type Rep (BasicAuthResult usr) = D1 (MetaData "BasicAuthResult" "Servant.Server.Internal.BasicAuth" "servant-snap-0.8.4.1-63elyMiCmB3FYfPoR19GKY" False) ((C1 (MetaCons "Unauthorized" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "BadPassword" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "NoSuchUser" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Authorized" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 usr))))

newtype BasicAuthCheck m usr

Datatype wrapping a function used to check authentication.

Constructors

BasicAuthCheck

Fields

• unBasicAuthCheck :: BasicAuthData -> m (BasicAuthResult usr)

Instances

Functor m => Functor (BasicAuthCheck m)

Defined in Servant.Server.Internal.BasicAuth

Methods

fmap :: (a -> b) -> BasicAuthCheck m a -> BasicAuthCheck m b

(<$) :: a -> BasicAuthCheck m b -> BasicAuthCheck m a

Generic (BasicAuthCheck m usr)

Defined in Servant.Server.Internal.BasicAuth

Associated Types

type Rep (BasicAuthCheck m usr) :: Type -> Type

Methods

from :: BasicAuthCheck m usr -> Rep (BasicAuthCheck m usr) x

to :: Rep (BasicAuthCheck m usr) x -> BasicAuthCheck m usr

type Rep (BasicAuthCheck m usr)

Defined in Servant.Server.Internal.BasicAuth

type Rep (BasicAuthCheck m usr) = D1 (MetaData "BasicAuthCheck" "Servant.Server.Internal.BasicAuth" "servant-snap-0.8.4.1-63elyMiCmB3FYfPoR19GKY" True) (C1 (MetaCons "BasicAuthCheck" PrefixI True) (S1 (MetaSel (Just "unBasicAuthCheck") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (BasicAuthData -> m (BasicAuthResult usr)))))

mkBAChallengerHdr :: ByteString -> (CI ByteString, ByteString)

Internal method to make a basic-auth challenge

decodeBAHdr :: Request -> Maybe BasicAuthData

Find and decode an Authorization header from the request as Basic Auth

runBasicAuth :: MonadSnap m => Request -> ByteString -> BasicAuthCheck m usr -> DelayedM m usr

Run and check basic authentication, returning the appropriate http error per the spec.