Safe Haskell	None
Language	Haskell2010

Network.Hawk.Types

Contents

Artifacts
Credentials
Headers

Synopsis

Artifacts

data HeaderArtifacts Source #

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.

Instances

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

haHash :: HeaderArtifacts -> Maybe ByteString Source #

Payload hash.

haExt :: HeaderArtifacts -> Maybe ExtData Source #

Optional application-specific data.

haApp :: HeaderArtifacts -> Maybe Text Source #

Oz application, Iron-encoded.

haDlg :: HeaderArtifacts -> Maybe Text Source #

Oz delegated-by application.

type ExtData = ByteString Source #

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

data PayloadInfo Source #

Payload data and content type bundled up for convenience.

Constructors

PayloadInfo
Fields payloadContentType :: ContentType payloadData :: ByteString

Instances

Show PayloadInfo Source #
Methods showsPrec :: Int -> PayloadInfo -> ShowS # show :: PayloadInfo -> String # showList :: [PayloadInfo] -> ShowS #

type ContentType = ByteString Source #

Value of Content-Type HTTP headers.

Credentials

type ClientId = Text Source #

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

newtype Key Source #

A user-supplied password or generated key.

Constructors

Key ByteString

Instances

Eq Key Source #
Methods (==) :: Key -> Key -> Bool # (/=) :: Key -> Key -> Bool #
Show Key Source #
Methods showsPrec :: Int -> Key -> ShowS # show :: Key -> String # showList :: [Key] -> ShowS #
IsString Key Source #
Methods fromString :: String -> Key #
Generic Key Source #
Associated Types type Rep Key :: * -> * # Methods from :: Key -> Rep Key x # to :: Rep Key x -> Key #
ByteArrayAccess Key Source #
Methods length :: Key -> Int # withByteArray :: Key -> (Ptr p -> IO a) -> IO a #
type Rep Key Source #
type Rep Key = D1 (MetaData "Key" "Network.Hawk.Algo" "hsoz-0.0.1.0-5r17DkUA43zE9P6QhuhthQ" True) (C1 (MetaCons "Key" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ByteString)))

data HawkAlgo Source #

A wrapper data type representing one of the supported HMAC algorithms. Use HawkAlgo SHA1 or HawkAlgo SHA256.

Constructors

(HawkAlgoCls alg, Show alg) => HawkAlgo alg

Instances

Eq HawkAlgo Source #
Methods (==) :: HawkAlgo -> HawkAlgo -> Bool # (/=) :: HawkAlgo -> HawkAlgo -> Bool #
Show HawkAlgo Source #
Methods showsPrec :: Int -> HawkAlgo -> ShowS # show :: HawkAlgo -> String # showList :: [HawkAlgo] -> ShowS #
HawkAlgoCls HawkAlgo Source #
Methods hawkHash :: HawkAlgo -> ByteString -> ByteString Source # hawkMac :: HawkAlgo -> Key -> ByteString -> ByteString Source #

class HawkAlgoCls a where Source #

The class of HMAC algorithms supported by the Hawk protocol. Users of the Hawk module probably won't directly need this.

Minimal complete definition

hawkHash, hawkMac

Methods

hawkHash :: a -> ByteString -> ByteString Source #

Calculates the hash of a message. The result is encoded in Base64.

hawkMac :: a -> Key -> ByteString -> ByteString Source #

Calculates the hash-based MAC of a message. The result is encoded in Base64.

Instances

HawkAlgoCls SHA1 Source #
Methods hawkHash :: SHA1 -> ByteString -> ByteString Source # hawkMac :: SHA1 -> Key -> ByteString -> ByteString Source #
HawkAlgoCls SHA256 Source #
Methods hawkHash :: SHA256 -> ByteString -> ByteString Source # hawkMac :: SHA256 -> Key -> ByteString -> ByteString Source #
HawkAlgoCls HawkAlgo Source #
Methods hawkHash :: HawkAlgo -> ByteString -> ByteString Source # hawkMac :: HawkAlgo -> Key -> ByteString -> ByteString Source #

newtype Key Source #

A user-supplied password or generated key.

Constructors

Key ByteString

Instances

Eq Key Source #
Methods (==) :: Key -> Key -> Bool # (/=) :: Key -> Key -> Bool #
Show Key Source #
Methods showsPrec :: Int -> Key -> ShowS # show :: Key -> String # showList :: [Key] -> ShowS #
IsString Key Source #
Methods fromString :: String -> Key #
Generic Key Source #
Associated Types type Rep Key :: * -> * # Methods from :: Key -> Rep Key x # to :: Rep Key x -> Key #
ByteArrayAccess Key Source #
Methods length :: Key -> Int # withByteArray :: Key -> (Ptr p -> IO a) -> IO a #
type Rep Key Source #
type Rep Key = D1 (MetaData "Key" "Network.Hawk.Algo" "hsoz-0.0.1.0-5r17DkUA43zE9P6QhuhthQ" True) (C1 (MetaCons "Key" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ByteString)))

data SHA1 :: * #

SHA1 cryptographic hash algorithm

Constructors

SHA1

Instances

Show SHA1
Methods showsPrec :: Int -> SHA1 -> ShowS # show :: SHA1 -> String # showList :: [SHA1] -> ShowS #
HashAlgorithm SHA1
Methods hashBlockSize :: SHA1 -> Int # hashDigestSize :: SHA1 -> Int # hashInternalContextSize :: SHA1 -> Int # hashInternalInit :: Ptr (Context SHA1) -> IO () # hashInternalUpdate :: Ptr (Context SHA1) -> Ptr Word8 -> Word32 -> IO () # hashInternalFinalize :: Ptr (Context SHA1) -> Ptr (Digest SHA1) -> IO () #
HawkAlgoCls SHA1 Source #
Methods hawkHash :: SHA1 -> ByteString -> ByteString Source # hawkMac :: SHA1 -> Key -> ByteString -> ByteString Source #

data SHA256 :: * #

SHA256 cryptographic hash algorithm

Constructors

SHA256

Instances

Show SHA256
Methods showsPrec :: Int -> SHA256 -> ShowS # show :: SHA256 -> String # showList :: [SHA256] -> ShowS #
HashAlgorithm SHA256
Methods hashBlockSize :: SHA256 -> Int # hashDigestSize :: SHA256 -> Int # hashInternalContextSize :: SHA256 -> Int # hashInternalInit :: Ptr (Context SHA256) -> IO () # hashInternalUpdate :: Ptr (Context SHA256) -> Ptr Word8 -> Word32 -> IO () # hashInternalFinalize :: Ptr (Context SHA256) -> Ptr (Digest SHA256) -> IO () #
HawkAlgoCls SHA256 Source #
Methods hawkHash :: SHA256 -> ByteString -> ByteString Source # hawkMac :: SHA256 -> Key -> ByteString -> ByteString Source #

readHawkAlgo :: String -> Maybe HawkAlgo Source #

Inverse of show, for parsing "algorithm" fields in JSON structures.

Headers

data WwwAuthenticateHeader Source #

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 Source #
Methods (==) :: WwwAuthenticateHeader -> WwwAuthenticateHeader -> Bool # (/=) :: WwwAuthenticateHeader -> WwwAuthenticateHeader -> Bool #
Show WwwAuthenticateHeader Source #
Methods showsPrec :: Int -> WwwAuthenticateHeader -> ShowS # show :: WwwAuthenticateHeader -> String # showList :: [WwwAuthenticateHeader] -> ShowS #

data ServerAuthorizationHeader Source #

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 Source #
Methods (==) :: ServerAuthorizationHeader -> ServerAuthorizationHeader -> Bool # (/=) :: ServerAuthorizationHeader -> ServerAuthorizationHeader -> Bool #
Show ServerAuthorizationHeader Source #
Methods showsPrec :: Int -> ServerAuthorizationHeader -> ShowS # show :: ServerAuthorizationHeader -> String # showList :: [ServerAuthorizationHeader] -> ShowS #

data MessageAuth Source #

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 Source #
Methods (==) :: MessageAuth -> MessageAuth -> Bool # (/=) :: MessageAuth -> MessageAuth -> Bool #
Show MessageAuth Source #
Methods showsPrec :: Int -> MessageAuth -> ShowS # show :: MessageAuth -> String # showList :: [MessageAuth] -> ShowS #