Network.Hawk.Server.Types

Documentation

type AuthResult t = AuthResult' (AuthSuccess t)

The end result of authentication.

type AuthResult' r = Either AuthFail r

An intermediate result of authentication.

data AuthFail

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

Methods

(==) :: AuthFail -> AuthFail -> Bool

(/=) :: AuthFail -> AuthFail -> Bool

Show AuthFail

Methods

showsPrec :: Int -> AuthFail -> ShowS

show :: AuthFail -> String

showList :: [AuthFail] -> ShowS

authFailMessage :: AuthFail -> String

data AuthSuccess t

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)

Methods

(==) :: AuthSuccess t -> AuthSuccess t -> Bool

(/=) :: AuthSuccess t -> AuthSuccess t -> Bool

Show t => Show (AuthSuccess t)

Methods

showsPrec :: Int -> AuthSuccess t -> ShowS

show :: AuthSuccess t -> String

showList :: [AuthSuccess t] -> ShowS

data Credentials

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

Methods

(==) :: Credentials -> Credentials -> Bool

(/=) :: Credentials -> Credentials -> Bool

Show Credentials

Methods

showsPrec :: Int -> Credentials -> ShowS

show :: Credentials -> String

showList :: [Credentials] -> ShowS

Generic Credentials

Associated Types

type Rep Credentials :: * -> *

Methods

from :: Credentials -> Rep Credentials x

to :: Rep Credentials x -> Credentials

type Rep Credentials

type Rep Credentials = D1 (MetaData "Credentials" "Network.Hawk.Server.Types" "hsoz-0.0.0.3-Ie80R7owbceLSvk8BcdUmT" 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

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

Constructors

HeaderArtifacts

Fields

• shaMethod :: Method
• shaHost :: ByteString
• shaPort :: Maybe Int
• shaResource :: ByteString
• shaId :: ClientId
• shaTimestamp :: POSIXTime
• shaNonce :: ByteString
• shaMac :: ByteString

  Entire header hash

• shaHash :: Maybe ByteString

  Payload hash

• shaExt :: Maybe ByteString
• shaApp :: Maybe Text
• shaDlg :: Maybe ByteString

Instances

Eq HeaderArtifacts

Methods

(==) :: HeaderArtifacts -> HeaderArtifacts -> Bool

(/=) :: HeaderArtifacts -> HeaderArtifacts -> Bool

Show HeaderArtifacts

Methods

showsPrec :: Int -> HeaderArtifacts -> ShowS

show :: HeaderArtifacts -> String

showList :: [HeaderArtifacts] -> ShowS

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

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

data HawkReq

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

Methods

showsPrec :: Int -> HawkReq -> ShowS

show :: HawkReq -> String

showList :: [HawkReq] -> ShowS

Default HawkReq

Methods

def :: HawkReq

module Network.Hawk.Types