Network.Hawk.Internal.Types

Documentation

type ClientId = Text

Identifies a particular client so that their credentials can be looked up.

type ExtData = ByteString

Extension data included in verification hash. This can be anything or nothing, depending on what the application needs.

data HeaderArtifacts

Struct for attributes which will be encoded in the Hawk Authorization header and included in the verification. The terminology (and spelling) come from the original Javascript implementation of Hawk.

Constructors

HeaderArtifacts

Fields

• haMethod :: Method

  Signed request method. fixme: replace hostportresource with SplitURL

• haHost :: ByteString

  Request host.

• haPort :: Maybe Int

  Request port.

• haResource :: ByteString

  Request path and query params.

• haId :: ClientId

  Client identifier.

• haTimestamp :: POSIXTime

  Time of request.

• haNonce :: ByteString

  Nonce value.

• haMac :: ByteString

  Entire header hash.

• haHash :: Maybe ByteString

  Payload hash.

• haExt :: Maybe ExtData

  Optional application-specific data.

• haApp :: Maybe Text

  Oz application, Iron-encoded.

• haDlg :: Maybe Text

  Oz delegated-by application.

Instances

Eq HeaderArtifacts

Methods

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

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

Show HeaderArtifacts

Methods

showsPrec :: Int -> HeaderArtifacts -> ShowS

show :: HeaderArtifacts -> String

showList :: [HeaderArtifacts] -> ShowS

type ContentType = ByteString

Value of Content-Type HTTP headers.

data PayloadInfo

Payload data and content type bundled up for convenience.

Constructors

PayloadInfo

Fields

• payloadContentType :: ContentType
• payloadData :: ByteString

Instances

Show PayloadInfo

Methods

showsPrec :: Int -> PayloadInfo -> ShowS

show :: PayloadInfo -> String

showList :: [PayloadInfo] -> ShowS

data MessageAuth

Authorization attributes for a Hawk message. This is generated by message and verified by authenticateMessage.

Constructors

MessageAuth

Fields

• msgId :: ClientId

  User identifier.

• msgTimestamp :: POSIXTime

  Message time.

• msgNonce :: ByteString

  Nonce string.

• msgHash :: ByteString

  Message hash.

• msgMac :: ByteString

  Hash of all message parameters.

Instances

Eq MessageAuth

Methods

(==) :: MessageAuth -> MessageAuth -> Bool

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

Show MessageAuth

Methods

showsPrec :: Int -> MessageAuth -> ShowS

show :: MessageAuth -> String

showList :: [MessageAuth] -> ShowS

data WwwAuthenticateHeader

Represents the WWW-Authenticate header which the server uses to respond when the client isn't authenticated.

Constructors

WwwAuthenticateHeader

Fields

• wahError :: ByteString

  Error message

• wahTs :: Maybe POSIXTime

  Server's timestamp

• wahTsm :: Maybe ByteString

  Timestamp mac

Instances

Eq WwwAuthenticateHeader

Methods

(==) :: WwwAuthenticateHeader -> WwwAuthenticateHeader -> Bool

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

Show WwwAuthenticateHeader

Methods

showsPrec :: Int -> WwwAuthenticateHeader -> ShowS

show :: WwwAuthenticateHeader -> String

showList :: [WwwAuthenticateHeader] -> ShowS

data ServerAuthorizationHeader

Represents the Server-Authorization header which the server sends back to the client.

Constructors

ServerAuthorizationHeader

Fields

• sahMac :: ByteString

  Hash of all response parameters.

• sahHash :: Maybe ByteString

  Optional payload hash.

• sahExt :: Maybe ExtData

  Optional application-specific data.

Instances

Eq ServerAuthorizationHeader

Methods

(==) :: ServerAuthorizationHeader -> ServerAuthorizationHeader -> Bool

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

Show ServerAuthorizationHeader

Methods

showsPrec :: Int -> ServerAuthorizationHeader -> ShowS

show :: ServerAuthorizationHeader -> String

showList :: [ServerAuthorizationHeader] -> ShowS