WebAuthn

Web Authentication API Verification library

Basic

data TokenBinding

state of the Token Binding protocol (unsupported)

Constructors

TokenBindingUnsupported

TokenBindingSupported

TokenBindingPresent !Text

Instances

FromJSON TokenBinding

Defined in WebAuthn.Types

Methods

parseJSON :: Value -> Parser TokenBinding

parseJSONList :: Value -> Parser [TokenBinding]

data Origin

Constructors

Origin

Fields

• originScheme :: Text
• originHost :: Text
• originPort :: Maybe Int

Instances

Eq Origin

Defined in WebAuthn.Types

Methods

(==) :: Origin -> Origin -> Bool

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

Ord Origin

Defined in WebAuthn.Types

Methods

compare :: Origin -> Origin -> Ordering

(<) :: Origin -> Origin -> Bool

(<=) :: Origin -> Origin -> Bool

(>) :: Origin -> Origin -> Bool

(>=) :: Origin -> Origin -> Bool

max :: Origin -> Origin -> Origin

min :: Origin -> Origin -> Origin

Show Origin

Defined in WebAuthn.Types

Methods

showsPrec :: Int -> Origin -> ShowS

show :: Origin -> String

showList :: [Origin] -> ShowS

FromJSON Origin

Defined in WebAuthn.Types

Methods

parseJSON :: Value -> Parser Origin

parseJSONList :: Value -> Parser [Origin]

data RelyingParty

WebAuthn Relying Party

Constructors

RelyingParty

Fields

• rpOrigin :: Origin
• rpId :: ByteString
• rpAllowSelfAttestation :: Bool
• rpAllowNoAttestation :: Bool

Instances

Eq RelyingParty

Defined in WebAuthn.Types

Methods

(==) :: RelyingParty -> RelyingParty -> Bool

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

Ord RelyingParty

Defined in WebAuthn.Types

Methods

compare :: RelyingParty -> RelyingParty -> Ordering

(<) :: RelyingParty -> RelyingParty -> Bool

(<=) :: RelyingParty -> RelyingParty -> Bool

(>) :: RelyingParty -> RelyingParty -> Bool

(>=) :: RelyingParty -> RelyingParty -> Bool

max :: RelyingParty -> RelyingParty -> RelyingParty

min :: RelyingParty -> RelyingParty -> RelyingParty

Show RelyingParty

Defined in WebAuthn.Types

Methods

showsPrec :: Int -> RelyingParty -> ShowS

show :: RelyingParty -> String

showList :: [RelyingParty] -> ShowS

defaultRelyingParty :: Origin -> RelyingParty

data User

1. 4.3. User Account Parameters for Credential Generation

Constructors

User

Fields

• userId :: ByteString
• userDisplayName :: Text

Instances

Eq User

Defined in WebAuthn.Types

Methods

(==) :: User -> User -> Bool

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

Show User

Defined in WebAuthn.Types

Methods

showsPrec :: Int -> User -> ShowS

show :: User -> String

showList :: [User] -> ShowS

Generic User

Defined in WebAuthn.Types

Associated Types

type Rep User :: Type -> Type

Methods

from :: User -> Rep User x

to :: Rep User x -> User

Serialise User

Defined in WebAuthn.Types

Methods

encode :: User -> Encoding

decode :: Decoder s User

encodeList :: [User] -> Encoding

decodeList :: Decoder s [User]

type Rep User

Defined in WebAuthn.Types

type Rep User = D1 (MetaData "User" "WebAuthn.Types" "webauthn-0-D7kkv1m3eu7AMrO2q5jdsU" False) (C1 (MetaCons "User" PrefixI True) (S1 (MetaSel (Just "userId") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 ByteString) :*: S1 (MetaSel (Just "userDisplayName") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 Text)))

newtype Challenge

1. 1. Cryptographic Challenges

Constructors

Challenge

Fields

• rawChallenge :: ByteString

Instances

Eq Challenge

Defined in WebAuthn.Types

Methods

(==) :: Challenge -> Challenge -> Bool

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

Ord Challenge

Defined in WebAuthn.Types

Methods

compare :: Challenge -> Challenge -> Ordering

(<) :: Challenge -> Challenge -> Bool

(<=) :: Challenge -> Challenge -> Bool

(>) :: Challenge -> Challenge -> Bool

(>=) :: Challenge -> Challenge -> Bool

max :: Challenge -> Challenge -> Challenge

min :: Challenge -> Challenge -> Challenge

Show Challenge

Defined in WebAuthn.Types

Methods

showsPrec :: Int -> Challenge -> ShowS

show :: Challenge -> String

showList :: [Challenge] -> ShowS

Hashable Challenge

Defined in WebAuthn.Types

Methods

hashWithSalt :: Int -> Challenge -> Int

hash :: Challenge -> Int

ToJSON Challenge

Defined in WebAuthn.Types

Methods

toJSON :: Challenge -> Value

toEncoding :: Challenge -> Encoding

toJSONList :: [Challenge] -> Value

toEncodingList :: [Challenge] -> Encoding

FromJSON Challenge

Defined in WebAuthn.Types

Methods

parseJSON :: Value -> Parser Challenge

parseJSONList :: Value -> Parser [Challenge]

Serialise Challenge

Defined in WebAuthn.Types

Methods

encode :: Challenge -> Encoding

decode :: Decoder s Challenge

encodeList :: [Challenge] -> Encoding

decodeList :: Decoder s [Challenge]

generateChallenge :: Int -> IO Challenge

Generate a cryptographic challenge (13.1).

data WebAuthnType

Constructors

Create

Get

Instances

Eq WebAuthnType

Defined in WebAuthn.Types

Methods

(==) :: WebAuthnType -> WebAuthnType -> Bool

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

Ord WebAuthnType

Defined in WebAuthn.Types

Methods

compare :: WebAuthnType -> WebAuthnType -> Ordering

(<) :: WebAuthnType -> WebAuthnType -> Bool

(<=) :: WebAuthnType -> WebAuthnType -> Bool

(>) :: WebAuthnType -> WebAuthnType -> Bool

(>=) :: WebAuthnType -> WebAuthnType -> Bool

max :: WebAuthnType -> WebAuthnType -> WebAuthnType

min :: WebAuthnType -> WebAuthnType -> WebAuthnType

Show WebAuthnType

Defined in WebAuthn.Types

Methods

showsPrec :: Int -> WebAuthnType -> ShowS

show :: WebAuthnType -> String

showList :: [WebAuthnType] -> ShowS

FromJSON WebAuthnType

Defined in WebAuthn.Types

Methods

parseJSON :: Value -> Parser WebAuthnType

parseJSONList :: Value -> Parser [WebAuthnType]

data CollectedClientData

1. 10.1. Client Data Used in WebAuthn Signatures (dictionary CollectedClientData)

Constructors

CollectedClientData

Fields

• clientType :: WebAuthnType
• clientChallenge :: Challenge
• clientOrigin :: Origin
• clientTokenBinding :: TokenBinding

Instances

FromJSON CollectedClientData

Defined in WebAuthn.Types

Methods

parseJSON :: Value -> Parser CollectedClientData

parseJSONList :: Value -> Parser [CollectedClientData]

data AuthenticatorData

1. 1. Authenticator Data

Constructors

AuthenticatorData

Fields

• rpIdHash :: Digest SHA256
• userPresent :: Bool
• userVerified :: Bool
• attestedCredentialData :: Maybe AttestedCredentialData
• authenticatorDataExtension :: ByteString

data AttestedCredentialData

1. 4.1. Attested Credential Data

Constructors

AttestedCredentialData

Fields

• aaguid :: AAGUID
• credentialId :: CredentialId
• credentialPublicKey :: CredentialPublicKey

Instances

Eq AttestedCredentialData

Defined in WebAuthn.Types

Methods

(==) :: AttestedCredentialData -> AttestedCredentialData -> Bool

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

Show AttestedCredentialData

Defined in WebAuthn.Types

Methods

showsPrec :: Int -> AttestedCredentialData -> ShowS

show :: AttestedCredentialData -> String

showList :: [AttestedCredentialData] -> ShowS

Generic AttestedCredentialData

Defined in WebAuthn.Types

Associated Types

type Rep AttestedCredentialData :: Type -> Type

Methods

from :: AttestedCredentialData -> Rep AttestedCredentialData x

to :: Rep AttestedCredentialData x -> AttestedCredentialData

ToJSON AttestedCredentialData

Defined in WebAuthn.Types

Methods

toJSON :: AttestedCredentialData -> Value

toEncoding :: AttestedCredentialData -> Encoding

toJSONList :: [AttestedCredentialData] -> Value

toEncodingList :: [AttestedCredentialData] -> Encoding

FromJSON AttestedCredentialData

Defined in WebAuthn.Types

Methods

parseJSON :: Value -> Parser AttestedCredentialData

parseJSONList :: Value -> Parser [AttestedCredentialData]

type Rep AttestedCredentialData

Defined in WebAuthn.Types

type Rep AttestedCredentialData = D1 (MetaData "AttestedCredentialData" "WebAuthn.Types" "webauthn-0-D7kkv1m3eu7AMrO2q5jdsU" False) (C1 (MetaCons "AttestedCredentialData" PrefixI True) (S1 (MetaSel (Just "aaguid") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 AAGUID) :*: (S1 (MetaSel (Just "credentialId") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 CredentialId) :*: S1 (MetaSel (Just "credentialPublicKey") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 CredentialPublicKey))))

newtype AAGUID

AAGUID of the authenticator

Constructors

AAGUID

Fields

• unAAGUID :: ByteString

Instances

Eq AAGUID

Defined in WebAuthn.Types

Methods

(==) :: AAGUID -> AAGUID -> Bool

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

Show AAGUID

Defined in WebAuthn.Types

Methods

showsPrec :: Int -> AAGUID -> ShowS

show :: AAGUID -> String

showList :: [AAGUID] -> ShowS

ToJSON AAGUID

Defined in WebAuthn.Types

Methods

toJSON :: AAGUID -> Value

toEncoding :: AAGUID -> Encoding

toJSONList :: [AAGUID] -> Value

toEncodingList :: [AAGUID] -> Encoding

FromJSON AAGUID

Defined in WebAuthn.Types

Methods

parseJSON :: Value -> Parser AAGUID

parseJSONList :: Value -> Parser [AAGUID]

newtype CredentialPublicKey

credential public key encoded in COSE_Key format

Constructors

CredentialPublicKey

Fields

• unCredentialPublicKey :: ByteString

Instances

Eq CredentialPublicKey

Defined in WebAuthn.Types

Methods

(==) :: CredentialPublicKey -> CredentialPublicKey -> Bool

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

Show CredentialPublicKey

Defined in WebAuthn.Types

Methods

showsPrec :: Int -> CredentialPublicKey -> ShowS

show :: CredentialPublicKey -> String

showList :: [CredentialPublicKey] -> ShowS

Hashable CredentialPublicKey

Defined in WebAuthn.Types

Methods

hashWithSalt :: Int -> CredentialPublicKey -> Int

hash :: CredentialPublicKey -> Int

ToJSON CredentialPublicKey

Defined in WebAuthn.Types

Methods

toJSON :: CredentialPublicKey -> Value

toEncoding :: CredentialPublicKey -> Encoding

toJSONList :: [CredentialPublicKey] -> Value

toEncodingList :: [CredentialPublicKey] -> Encoding

FromJSON CredentialPublicKey

Defined in WebAuthn.Types

Methods

parseJSON :: Value -> Parser CredentialPublicKey

parseJSONList :: Value -> Parser [CredentialPublicKey]

Serialise CredentialPublicKey

Defined in WebAuthn.Types

Methods

encode :: CredentialPublicKey -> Encoding

decode :: Decoder s CredentialPublicKey

encodeList :: [CredentialPublicKey] -> Encoding

decodeList :: Decoder s [CredentialPublicKey]

newtype CredentialId

A probabilistically-unique byte sequence identifying a public key credential source and its authentication assertions.

Constructors

CredentialId

Fields

• unCredentialId :: ByteString

Instances

Eq CredentialId

Defined in WebAuthn.Types

Methods

(==) :: CredentialId -> CredentialId -> Bool

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

Show CredentialId

Defined in WebAuthn.Types

Methods

showsPrec :: Int -> CredentialId -> ShowS

show :: CredentialId -> String

showList :: [CredentialId] -> ShowS

Hashable CredentialId

Defined in WebAuthn.Types

Methods

hashWithSalt :: Int -> CredentialId -> Int

hash :: CredentialId -> Int

ToJSON CredentialId

Defined in WebAuthn.Types

Methods

toJSON :: CredentialId -> Value

toEncoding :: CredentialId -> Encoding

toJSONList :: [CredentialId] -> Value

toEncodingList :: [CredentialId] -> Encoding

FromJSON CredentialId

Defined in WebAuthn.Types

Methods

parseJSON :: Value -> Parser CredentialId

parseJSONList :: Value -> Parser [CredentialId]

Serialise CredentialId

Defined in WebAuthn.Types

Methods

encode :: CredentialId -> Encoding

decode :: Decoder s CredentialId

encodeList :: [CredentialId] -> Encoding

decodeList :: Decoder s [CredentialId]

verfication

data VerificationFailure

Constructors

InvalidType

MismatchedChallenge

MismatchedOrigin

UnexpectedPresenceOfTokenBinding

MismatchedTokenBinding

JSONDecodeError String

CBORDecodeError String DeserialiseFailure

MismatchedRPID

UserNotPresent

UserUnverified

UnsupportedAttestationFormat

UnsupportedAlgorithm Int

MalformedPublicKey

MalformedAuthenticatorData

MalformedX509Certificate

MalformedSignature

SignatureFailure String

Instances

Show VerificationFailure

Defined in WebAuthn.Types

Methods

showsPrec :: Int -> VerificationFailure -> ShowS

show :: VerificationFailure -> String

showList :: [VerificationFailure] -> ShowS

registerCredential

Arguments

:: Challenge

-> RelyingParty

-> Maybe Text

Token Binding ID in base64

-> Bool

require user verification?

-> ByteString

clientDataJSON

-> ByteString

attestationObject

-> Either VerificationFailure AttestedCredentialData

1. 1. Registering a New Credential

verify

Arguments

:: Challenge

-> RelyingParty

-> Maybe Text

Token Binding ID in base64

-> Bool

require user verification?

-> ByteString

clientDataJSON

-> ByteString

authenticatorData

-> ByteString

signature

-> CredentialPublicKey

public key

-> Either VerificationFailure ()

1. 2. Verifying an Authentication Assertion