Crypto.WebAuthn.Model.WebIDL

This module contains functions and types for encoding CredentialOptions and decoding Credentials, based on intermediate types that implement the ToJSON and FromJSON types respectively, matching the serialization used by webauthn-json.

Registration

encodeCredentialOptionsRegistration :: CredentialOptions 'Registration -> IDLCredentialOptionsRegistration

Encodes a CredentialOptions Registration, which is needed for the registration ceremony. The resulting type from this function can be encoded using toJSON, sent as a response, received by the Relying Party script, passed directly as the publicKey field in the argument to webauthn-json's create() (or equivalent) function. The result of that function can then be decoded using decodeCredentialRegistration.

data IDLCredentialOptionsRegistration

The intermediate type returned by encodeCredentialOptionsRegistration, equivalent to the PublicKeyCredentialCreationOptions dictionary

Instances

Eq IDLCredentialOptionsRegistration

Defined in Crypto.WebAuthn.Model.WebIDL

Methods

(==) :: IDLCredentialOptionsRegistration -> IDLCredentialOptionsRegistration -> Bool

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

Show IDLCredentialOptionsRegistration

Defined in Crypto.WebAuthn.Model.WebIDL

Methods

showsPrec :: Int -> IDLCredentialOptionsRegistration -> ShowS

show :: IDLCredentialOptionsRegistration -> String

showList :: [IDLCredentialOptionsRegistration] -> ShowS

ToJSON IDLCredentialOptionsRegistration

Defined in Crypto.WebAuthn.Model.WebIDL

Methods

toJSON :: IDLCredentialOptionsRegistration -> Value

toEncoding :: IDLCredentialOptionsRegistration -> Encoding

toJSONList :: [IDLCredentialOptionsRegistration] -> Value

toEncodingList :: [IDLCredentialOptionsRegistration] -> Encoding

data IDLCredentialRegistration

The intermediate type as an input to decodeCredentialRegistration, equivalent to the PublicKeyCredential interface with the response being an AuthenticatorAttestationResponse.

Instances

Eq IDLCredentialRegistration

Defined in Crypto.WebAuthn.Model.WebIDL

Methods

(==) :: IDLCredentialRegistration -> IDLCredentialRegistration -> Bool

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

Show IDLCredentialRegistration

Defined in Crypto.WebAuthn.Model.WebIDL

Methods

showsPrec :: Int -> IDLCredentialRegistration -> ShowS

show :: IDLCredentialRegistration -> String

showList :: [IDLCredentialRegistration] -> ShowS

ToJSON IDLCredentialRegistration

Defined in Crypto.WebAuthn.Model.WebIDL

Methods

toJSON :: IDLCredentialRegistration -> Value

toEncoding :: IDLCredentialRegistration -> Encoding

toJSONList :: [IDLCredentialRegistration] -> Value

toEncodingList :: [IDLCredentialRegistration] -> Encoding

FromJSON IDLCredentialRegistration

Defined in Crypto.WebAuthn.Model.WebIDL

Methods

parseJSON :: Value -> Parser IDLCredentialRegistration

parseJSONList :: Value -> Parser [IDLCredentialRegistration]

decodeCredentialRegistration

Arguments

:: SupportedAttestationStatementFormats

The attestation statement formats that should be supported. The value of allSupportedFormats can be passed here, but additional or custom formats may also be used if needed

-> IDLCredentialRegistration

-> Either Text (Credential 'Registration 'True)

Decodes the intermediate IDLCredentialRegistration type which can be parsed with fromJSON from the result of webauthn-json's create() (or equivalent) function, to a Credential Registration. This is the continuation of encodeCredentialOptionsRegistration.

Authentication

encodeCredentialOptionsAuthentication :: CredentialOptions 'Authentication -> IDLCredentialOptionsAuthentication

Encodes a CredentialOptions Authentication, which is needed for the authentication ceremony. The resulting type from this function can be encoded using toJSON, sent as a response, received by the Relying Party script, parsed as JSON, and passed directly as the publicKey field in the argument to the navigator.credentials.get() function.

data IDLCredentialOptionsAuthentication

The intermediate type returned by encodeCredentialOptionsAuthentication, equivalent to the PublicKeyCredentialRequestOptions dictionary

Instances

Eq IDLCredentialOptionsAuthentication

Defined in Crypto.WebAuthn.Model.WebIDL

Methods

(==) :: IDLCredentialOptionsAuthentication -> IDLCredentialOptionsAuthentication -> Bool

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

Show IDLCredentialOptionsAuthentication

Defined in Crypto.WebAuthn.Model.WebIDL

Methods

showsPrec :: Int -> IDLCredentialOptionsAuthentication -> ShowS

show :: IDLCredentialOptionsAuthentication -> String

showList :: [IDLCredentialOptionsAuthentication] -> ShowS

ToJSON IDLCredentialOptionsAuthentication

Defined in Crypto.WebAuthn.Model.WebIDL

Methods

toJSON :: IDLCredentialOptionsAuthentication -> Value

toEncoding :: IDLCredentialOptionsAuthentication -> Encoding

toJSONList :: [IDLCredentialOptionsAuthentication] -> Value

toEncodingList :: [IDLCredentialOptionsAuthentication] -> Encoding

data IDLCredentialAuthentication

The intermediate type as an input to decodeCredentialAuthentication, equivalent to the PublicKeyCredential interface with the response being an AuthenticatorAssertionResponse.

Instances

Eq IDLCredentialAuthentication

Defined in Crypto.WebAuthn.Model.WebIDL

Methods

(==) :: IDLCredentialAuthentication -> IDLCredentialAuthentication -> Bool

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

Show IDLCredentialAuthentication

Defined in Crypto.WebAuthn.Model.WebIDL

Methods

showsPrec :: Int -> IDLCredentialAuthentication -> ShowS

show :: IDLCredentialAuthentication -> String

showList :: [IDLCredentialAuthentication] -> ShowS

ToJSON IDLCredentialAuthentication

Defined in Crypto.WebAuthn.Model.WebIDL

Methods

toJSON :: IDLCredentialAuthentication -> Value

toEncoding :: IDLCredentialAuthentication -> Encoding

toJSONList :: [IDLCredentialAuthentication] -> Value

toEncodingList :: [IDLCredentialAuthentication] -> Encoding

FromJSON IDLCredentialAuthentication

Defined in Crypto.WebAuthn.Model.WebIDL

Methods

parseJSON :: Value -> Parser IDLCredentialAuthentication

parseJSONList :: Value -> Parser [IDLCredentialAuthentication]

decodeCredentialAuthentication :: IDLCredentialAuthentication -> Either Text (Credential 'Authentication 'True)

Decodes a RequestedPublicKeyCredential result, corresponding to the PublicKeyCredential interface as returned by the get() method while Verifying an Authentication Assertion

| Decodes the intermediate IDLCredentialAuthentication type which can be parsed with fromJSON from the result of webauthn-json's get() (or equivalent) function, to a Credential Authentication True. This is the continuation of encodeCredentialOptionsAuthentication