Safe Haskell	None
Language	Haskell2010

Network.Hawk.Internal.Server.Types

Description

Consider this module to be internal, and don't import directly.

Synopsis

Documentation

type AuthResult t = AuthResult' (AuthSuccess t) Source #

The end result of authentication.

type AuthResult' r = Either AuthFail r Source #

An intermediate result of authentication.

data AuthFail Source #

Authentication can fail in multiple ways. This type includes the information necessary to generate a suitable response for the client. In the case of a stale timestamp, the client may try another authenticated request.

Constructors

AuthFailBadRequest String (Maybe HeaderArtifacts)
AuthFailUnauthorized String (Maybe Credentials) (Maybe HeaderArtifacts)
AuthFailStaleTimeStamp String POSIXTime Credentials HeaderArtifacts

Instances

Eq AuthFail Source #
Methods (==) :: AuthFail -> AuthFail -> Bool # (/=) :: AuthFail -> AuthFail -> Bool #
Show AuthFail Source #
Methods showsPrec :: Int -> AuthFail -> ShowS # show :: AuthFail -> String # showList :: [AuthFail] -> ShowS #

data AuthSuccess t Source #

Successful authentication produces a set of credentials and "artifacts". Also included in the result is the result of CredentialsFunc.

Constructors

AuthSuccess Credentials HeaderArtifacts t

Instances

Eq t => Eq (AuthSuccess t) Source #
Methods (==) :: AuthSuccess t -> AuthSuccess t -> Bool # (/=) :: AuthSuccess t -> AuthSuccess t -> Bool #
Show t => Show (AuthSuccess t) Source #
Methods showsPrec :: Int -> AuthSuccess t -> ShowS # show :: AuthSuccess t -> String # showList :: [AuthSuccess t] -> ShowS #

authValue :: AuthSuccess t -> t Source #

The result of an AuthSuccess.

authFailMessage :: AuthFail -> String Source #

The error message from an AuthFail.

data HawkReq Source #

A package of values containing the attributes of a HTTP request which are relevant to Hawk authentication.

Constructors

HawkReq
Fields hrqMethod :: Method hrqUrl :: ByteString hrqHost :: ByteString hrqPort :: Maybe Int hrqAuthorization :: ByteString hrqPayload :: Maybe PayloadInfo hrqBewit :: Maybe ByteString hrqBewitlessUrl :: ByteString

Instances

Show HawkReq Source #
Methods showsPrec :: Int -> HawkReq -> ShowS # show :: HawkReq -> String # showList :: [HawkReq] -> ShowS #
Default HawkReq Source #
Methods def :: HawkReq #

data Credentials Source #

The set of data the server requires for key-based hash verification of artifacts.

Constructors

Credentials
Fields scKey :: Key Key scAlgorithm :: HawkAlgo HMAC

Instances

Eq Credentials Source #
Methods (==) :: Credentials -> Credentials -> Bool # (/=) :: Credentials -> Credentials -> Bool #
Show Credentials Source #
Methods showsPrec :: Int -> Credentials -> ShowS # show :: Credentials -> String # showList :: [Credentials] -> ShowS #
Generic Credentials Source #
Associated Types type Rep Credentials :: * -> * # Methods from :: Credentials -> Rep Credentials x # to :: Rep Credentials x -> Credentials #
type Rep Credentials Source #
type Rep Credentials = D1 (MetaData "Credentials" "Network.Hawk.Internal.Server.Types" "hsoz-0.0.1.0-5r17DkUA43zE9P6QhuhthQ" False) (C1 (MetaCons "Credentials" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "scKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Key)) (S1 (MetaSel (Just Symbol "scAlgorithm") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 HawkAlgo))))

type CredentialsFunc m t = ClientId -> m (Either String (Credentials, t)) Source #

A user-supplied callback to get credentials from a client identifier.

type NonceFunc = Key -> POSIXTime -> Nonce -> IO Bool Source #

User-supplied nonce validation function. It should return True if the nonce is valid.

Checking nonces can prevent request replay attacks. If the same key and nonce have already been seen, then the request can be denied.

type Nonce = ByteString Source #

The nonce should be a short sequence of random ASCII characters.