Network.Hawk.Client

Functions for making Hawk-authenticated request headers and verifying responses from the server.

Documentation

header

Arguments

:: Text

The request URL

-> Method

The request method

-> Credentials

Credentials used to generate the header

-> Maybe PayloadInfo

Optional request payload

-> Maybe Text

ext data

-> IO Header

Generates the Hawk authentication header for a request.

headerOz :: Text -> Method -> Credentials -> Maybe PayloadInfo -> Maybe Text -> Text -> Maybe Text -> IO Header

Generates the Hawk authentication header for an Oz request. Oz requires another attribute -- the application id. It also has an optional delegated-by attribute, which is the application id of the application the credentials were directly issued to.

getBewit :: Credentials -> NominalDiffTime -> Maybe ByteString -> NominalDiffTime -> ByteString -> IO (Maybe ByteString)

Generate a bewit value for a given URI.

authenticate :: Response body -> Credentials -> HeaderArtifacts -> Maybe ByteString -> ServerAuthorizationCheck -> IO (Either String ())

Validates the server response.

data ServerAuthorizationCheck

Whether the client wants to check the received Server-Authorization header depends on the application.

Constructors

ServerAuthorizationNotRequired

ServerAuthorizationRequired

Instances

Show ServerAuthorizationCheck

Methods

showsPrec :: Int -> ServerAuthorizationCheck -> ShowS

show :: ServerAuthorizationCheck -> String

showList :: [ServerAuthorizationCheck] -> ShowS

data Credentials

ID and key used for encrypting Hawk Authorization header.

Constructors

Credentials

Fields

• ccId :: ClientId
• ccKey :: Key
• ccAlgorithm :: HawkAlgo

Instances

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.Client.Types" "hsoz-0.0.0.3-Ie80R7owbceLSvk8BcdUmT" False) (C1 (MetaCons "Credentials" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "ccId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ClientId)) ((:*:) (S1 (MetaSel (Just Symbol "ccKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Key)) (S1 (MetaSel (Just Symbol "ccAlgorithm") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 HawkAlgo)))))

data Header

The result of Hawk header generation.

Constructors

Header

Fields

• hdrField :: Authorization

  Value of Authorization header.

• hdrArtifacts :: HeaderArtifacts

  Not sure if this is needed by users.

Instances

Show Header

Methods

showsPrec :: Int -> Header -> ShowS

show :: Header -> String

showList :: [Header] -> ShowS

Generic Header

Associated Types

type Rep Header :: * -> *

Methods

from :: Header -> Rep Header x

to :: Rep Header x -> Header

type Rep Header

type Rep Header = D1 (MetaData "Header" "Network.Hawk.Client.Types" "hsoz-0.0.0.3-Ie80R7owbceLSvk8BcdUmT" False) (C1 (MetaCons "Header" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "hdrField") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Authorization)) (S1 (MetaSel (Just Symbol "hdrArtifacts") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 HeaderArtifacts))))

type Authorization = ByteString

The value of an Authorization header.

data HeaderArtifacts

Struct for attributes which will be encoded in the Hawk Authorization header. The term "artifacts" comes from the original Javascript implementation of Hawk.

Instances

Show HeaderArtifacts

Methods

showsPrec :: Int -> HeaderArtifacts -> ShowS

show :: HeaderArtifacts -> String

showList :: [HeaderArtifacts] -> ShowS

module Network.Hawk.Types