Crypto.WebAuthn.Encoding.WebAuthnJson

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

wjEncodeCredentialOptionsRegistration :: CredentialOptions 'Registration -> WJCredentialOptionsRegistration

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 wjDecodeCredentialRegistration.

newtype WJCredentialOptionsRegistration

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

Constructors

WJCredentialOptionsRegistration

Fields

• _unWJCredentialOptionsRegistration :: PublicKeyCredentialCreationOptions

Instances

FromJSON WJCredentialOptionsRegistration

Defined in Crypto.WebAuthn.Encoding.WebAuthnJson

Methods

parseJSON :: Value -> Parser WJCredentialOptionsRegistration

parseJSONList :: Value -> Parser [WJCredentialOptionsRegistration]

ToJSON WJCredentialOptionsRegistration

Defined in Crypto.WebAuthn.Encoding.WebAuthnJson

Methods

toJSON :: WJCredentialOptionsRegistration -> Value

toEncoding :: WJCredentialOptionsRegistration -> Encoding

toJSONList :: [WJCredentialOptionsRegistration] -> Value

toEncodingList :: [WJCredentialOptionsRegistration] -> Encoding

Show WJCredentialOptionsRegistration

Defined in Crypto.WebAuthn.Encoding.WebAuthnJson

Methods

showsPrec :: Int -> WJCredentialOptionsRegistration -> ShowS

show :: WJCredentialOptionsRegistration -> String

showList :: [WJCredentialOptionsRegistration] -> ShowS

Eq WJCredentialOptionsRegistration

Defined in Crypto.WebAuthn.Encoding.WebAuthnJson

Methods

(==) :: WJCredentialOptionsRegistration -> WJCredentialOptionsRegistration -> Bool

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

newtype WJCredentialRegistration

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

Constructors

WJCredentialRegistration

Fields

• unWJCredentialRegistration :: PublicKeyCredential AuthenticatorAttestationResponse

Instances

FromJSON WJCredentialRegistration

Defined in Crypto.WebAuthn.Encoding.WebAuthnJson

Methods

parseJSON :: Value -> Parser WJCredentialRegistration

parseJSONList :: Value -> Parser [WJCredentialRegistration]

ToJSON WJCredentialRegistration

Defined in Crypto.WebAuthn.Encoding.WebAuthnJson

Methods

toJSON :: WJCredentialRegistration -> Value

toEncoding :: WJCredentialRegistration -> Encoding

toJSONList :: [WJCredentialRegistration] -> Value

toEncodingList :: [WJCredentialRegistration] -> Encoding

Show WJCredentialRegistration

Defined in Crypto.WebAuthn.Encoding.WebAuthnJson

Methods

showsPrec :: Int -> WJCredentialRegistration -> ShowS

show :: WJCredentialRegistration -> String

showList :: [WJCredentialRegistration] -> ShowS

Eq WJCredentialRegistration

Defined in Crypto.WebAuthn.Encoding.WebAuthnJson

Methods

(==) :: WJCredentialRegistration -> WJCredentialRegistration -> Bool

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

wjDecodeCredentialRegistration'

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

-> WJCredentialRegistration

-> Either Text (Credential 'Registration 'True)

Decodes the intermediate WJCredentialRegistration 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 wjEncodeCredentialOptionsRegistration.

wjDecodeCredentialRegistration :: WJCredentialRegistration -> Either Text (Credential 'Registration 'True)

A version of wjDecodeCredentialRegistration' with allSupportedFormats passed as the supported formats

Authentication

wjEncodeCredentialOptionsAuthentication :: CredentialOptions 'Authentication -> WJCredentialOptionsAuthentication

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.

newtype WJCredentialOptionsAuthentication

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

Constructors

WJCredentialOptionsAuthentication

Fields

• _unWJCredentialOptionsAuthentication :: PublicKeyCredentialRequestOptions

Instances

FromJSON WJCredentialOptionsAuthentication

Defined in Crypto.WebAuthn.Encoding.WebAuthnJson

Methods

parseJSON :: Value -> Parser WJCredentialOptionsAuthentication

parseJSONList :: Value -> Parser [WJCredentialOptionsAuthentication]

ToJSON WJCredentialOptionsAuthentication

Defined in Crypto.WebAuthn.Encoding.WebAuthnJson

Methods

toJSON :: WJCredentialOptionsAuthentication -> Value

toEncoding :: WJCredentialOptionsAuthentication -> Encoding

toJSONList :: [WJCredentialOptionsAuthentication] -> Value

toEncodingList :: [WJCredentialOptionsAuthentication] -> Encoding

Show WJCredentialOptionsAuthentication

Defined in Crypto.WebAuthn.Encoding.WebAuthnJson

Methods

showsPrec :: Int -> WJCredentialOptionsAuthentication -> ShowS

show :: WJCredentialOptionsAuthentication -> String

showList :: [WJCredentialOptionsAuthentication] -> ShowS

Eq WJCredentialOptionsAuthentication

Defined in Crypto.WebAuthn.Encoding.WebAuthnJson

Methods

(==) :: WJCredentialOptionsAuthentication -> WJCredentialOptionsAuthentication -> Bool

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

newtype WJCredentialAuthentication

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

Constructors

WJCredentialAuthentication

Fields

• unWJCredentialAuthentication :: PublicKeyCredential AuthenticatorAssertionResponse

Instances

FromJSON WJCredentialAuthentication

Defined in Crypto.WebAuthn.Encoding.WebAuthnJson

Methods

parseJSON :: Value -> Parser WJCredentialAuthentication

parseJSONList :: Value -> Parser [WJCredentialAuthentication]

ToJSON WJCredentialAuthentication

Defined in Crypto.WebAuthn.Encoding.WebAuthnJson

Methods

toJSON :: WJCredentialAuthentication -> Value

toEncoding :: WJCredentialAuthentication -> Encoding

toJSONList :: [WJCredentialAuthentication] -> Value

toEncodingList :: [WJCredentialAuthentication] -> Encoding

Show WJCredentialAuthentication

Defined in Crypto.WebAuthn.Encoding.WebAuthnJson

Methods

showsPrec :: Int -> WJCredentialAuthentication -> ShowS

show :: WJCredentialAuthentication -> String

showList :: [WJCredentialAuthentication] -> ShowS

Eq WJCredentialAuthentication

Defined in Crypto.WebAuthn.Encoding.WebAuthnJson

Methods

(==) :: WJCredentialAuthentication -> WJCredentialAuthentication -> Bool

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

wjDecodeCredentialAuthentication :: WJCredentialAuthentication -> 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 WJCredentialAuthentication 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 wjEncodeCredentialOptionsAuthentication