Crypto.WebAuthn.Encoding.Strings

This module provides functions for encoding and decoding WebAuthn enum types between their Haskell types defined in Crypto.WebAuthn.Model.Types and their string forms.

Documentation

encodeCredentialType :: CredentialType -> Text

(spec) Encodes a CredentialType to a string.

decodeCredentialType :: Text -> Either Text CredentialType

(spec) Decodes a string into a CredentialType, returning Left when the string isn't known to be an enum value.

encodeUserVerificationRequirement :: UserVerificationRequirement -> Text

(spec) Encodes a UserVerificationRequirement to a string.

decodeUserVerificationRequirement :: Text -> Either Text UserVerificationRequirement

(spec) Decodes a string into a UserVerificationRequirement, returning Left when the string isn't known to be an enum value.

encodeAuthenticatorAttachment :: AuthenticatorAttachment -> Text

(spec) Encodes a AuthenticatorAttachment to a string.

decodeAuthenticatorAttachment :: Text -> Either Text AuthenticatorAttachment

(spec) Decodes a string into a AuthenticatorAttachment, returning Left when the string isn't known to be an enum value.

encodeResidentKeyRequirement :: ResidentKeyRequirement -> Text

(spec) Encodes a ResidentKeyRequirement to a string.

decodeResidentKeyRequirement :: Text -> Either Text ResidentKeyRequirement

(spec) Decodes a string into a ResidentKeyRequirement, returning Left when the string isn't known to be an enum value.

encodeAttestationConveyancePreference :: AttestationConveyancePreference -> Text

(spec) Encodes a AttestationConveyancePreference to a string.

decodeAttestationConveyancePreference :: Text -> Either Text AttestationConveyancePreference

(spec) Decodes a string into a AttestationConveyancePreference, returning Left when the string isn't known to be an enum value.

encodeAuthenticatorTransport :: AuthenticatorTransport -> Text

(spec) Encodes a AuthenticatorTransport to a string.

decodeAuthenticatorTransport :: Text -> AuthenticatorTransport

(spec) Decodes a string into a AuthenticatorTransport, returning AuthenticatorTransportUnknown when the string isn't known to be an enum value. This is required so that relying parties can still store unknown values, see transports and the clarification to that section here