hsoz-0.0.0.2: Iron, Hawk, Oz: Web auth protocols

Safe HaskellNone
LanguageHaskell2010

Network.Hawk.Server.Types

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.

data AuthSuccess t Source #

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

Instances

data Credentials Source #

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

Constructors

Credentials 

Fields

Instances

Show Credentials Source # 
Generic Credentials Source # 

Associated Types

type Rep Credentials :: * -> * #

type Rep Credentials Source # 
type Rep Credentials = D1 (MetaData "Credentials" "Network.Hawk.Server.Types" "hsoz-0.0.0.2-3Cllcgcqvn288lQBqaARRr" 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))))

data HeaderArtifacts Source #

HeaderArtifacts are the attributes which are included in the verification. The terminology (and spelling) come from the original Javascript implementation of Hawk.

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

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

data HawkReq Source #

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