Crypto.WebAuthn.Encoding.Binary

Certain parts of the specification require that data is decoded/encoded from/to a binary form. This module holds such functions.

CollectedClientData

encodeRawCollectedClientData :: forall (c :: CeremonyKind) raw. SingI c => CollectedClientData c raw -> CollectedClientData c 'True

(spec) Encodes all raw fields of a CollectedClientData into ccdRawData using the JSON-compatible serialization of client data This function is useful for testing.

stripRawCollectedClientData :: CollectedClientData c raw -> CollectedClientData c 'False

Removes all raw fields of a CollectedClientData.

decodeCollectedClientData :: forall (c :: CeremonyKind). SingI c => ByteString -> Either Text (CollectedClientData c 'True)

(spec) Decodes a CollectedClientData from a ByteString. This is needed to parse the clientDataJSON field in the AuthenticatorResponse structure, which is used for both attestation and assertion.

AttestedCredentialData

encodeRawAttestedCredentialData :: AttestedCredentialData c raw -> AttestedCredentialData c 'True

Encodes all raw fields of a AttestedCredentialData, particularly encodes acdCredentialPublicKey using its Serialise instance into acdCredentialPublicKeyBytes, see credentialPublicKey.

stripRawAttestedCredentialData :: AttestedCredentialData c raw -> AttestedCredentialData c 'False

Removes all raw fields of a AttestedCredentialData.

AuthenticatorData

encodeRawAuthenticatorData :: forall (c :: CeremonyKind) raw. SingI c => AuthenticatorData c raw -> AuthenticatorData c 'True

(spec) Encodes all raw-containing fields of a AuthenticatorData, particularly adAttestedCredentialData, and the AuthenticatorData itself into adRawData. This function is needed for an authenticator implementation.

stripRawAuthenticatorData :: AuthenticatorData c raw -> AuthenticatorData c 'False

Removes all raw fields from a AuthenticatorData.

decodeAuthenticatorData :: forall (c :: CeremonyKind). SingI c => ByteString -> Either Text (AuthenticatorData c 'True)

(spec) Decodes a AuthenticatorData from a ByteString. This is needed to parse a webauthn clients authenticatorData field in the AuthenticatorAssertionResponse structure.

AttestationObject

encodeRawAttestationObject :: AttestationObject raw -> AttestationObject 'True

Encodes all raw fields of an AttestationObject.

stripRawAttestationObject :: AttestationObject raw -> AttestationObject 'False

Removes all raw fields of an AttestationObject.

encodeAttestationObject :: AttestationObject 'True -> ByteString

(spec) Encodes an AttestationObject as a ByteString. This is needed by the client side to generate a valid JSON response.

decodeAttestationObject :: SupportedAttestationStatementFormats -> ByteString -> Either Text (AttestationObject 'True)

(spec) Decodes a AttestationObject from a ByteString. This is needed to parse a webauthn clients attestationObject field in the AuthenticatorAttestationResponse structure This function takes a SupportedAttestationStatementFormats argument to indicate which attestation statement formats are supported. structure.

AuthenticatorResponse

encodeRawAuthenticatorResponse :: AuthenticatorResponse c raw -> AuthenticatorResponse c 'True

Encode all raw fields of an AuthenticatorResponse.

stripRawAuthenticatorResponse :: AuthenticatorResponse c raw -> AuthenticatorResponse c 'False

Removes all raw fields of an AuthenticatorResponse.

Credential

encodeRawCredential :: Credential c raw -> Credential c 'True

Encodes all raw fields of an Credential.

stripRawCredential :: Credential c raw -> Credential c 'False

Removes all raw fields of an Credential.