Safe Haskell | None |
---|---|
Language | Haskell2010 |
- type AuthResult t = AuthResult' (AuthSuccess t)
- type AuthResult' r = Either AuthFail r
- data AuthFail
- authFailMessage :: AuthFail -> String
- data AuthSuccess t = AuthSuccess Credentials HeaderArtifacts t
- data Credentials = Credentials {
- scKey :: Key
- scAlgorithm :: HawkAlgo
- data HeaderArtifacts = HeaderArtifacts {}
- type CredentialsFunc m t = ClientId -> m (Either String (Credentials, t))
- data HawkReq = HawkReq {}
- module Network.Hawk.Types
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.
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.
authFailMessage :: AuthFail -> String Source #
data AuthSuccess t Source #
Successful authentication produces a set of credentials and
"artifacts". Also included in the result is the result of
CredentialsFunc
.
Eq t => Eq (AuthSuccess t) Source # | |
Show t => Show (AuthSuccess t) Source # | |
data Credentials Source #
The set of data the server requires for key-based hash verification of artifacts.
Credentials | |
|
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.
HeaderArtifacts | |
|
type CredentialsFunc m t = ClientId -> m (Either String (Credentials, t)) Source #
A user-supplied callback to get credentials from a client identifier.
A package of values containing the attributes of a HTTP request which are relevant to Hawk authentication.
HawkReq | |
|
module Network.Hawk.Types