fido2_client library

Public API for the FIDO2 client (CTAP).

Classes

AuthenticatorInfo
CTAP2 authenticatorGetInfo response structure (spec §6.4).
ClientPin
ClientPinRequest
CTAP2 authenticatorClientPIN (0x06) request (spec §6.5.5).
ClientPinResponse
CTAP2 authenticatorClientPIN (0x06) response (spec §6.5.5).
CmCredential
CmMetadata
CmRp
CoseKey
Represents a key as specified by RFC8152: CBOR Object Signing and Encryption (COSE)
CredentialManagement
CredentialManagementRequest
CTAP2 authenticatorCredentialManagement (0x0A) request (spec §6.8).
CredentialManagementResponse
CTAP2 authenticatorCredentialManagement (0x0A) response (spec §6.8).
Ctap2
CtapDevice
CtapResponse<T>
EcdhEsHkdf256
Represents a COSE key of type ECDH-ES+HKDF-256 (see RFC8152 11.1)
EdDSA
Represents a COSE key of type EdDSA (Ed25519, see RFC8152 8.2)
EncapsulateResult
ES256
Represents a COSE key of type ES256 (ECDSA w/ SHA-256, see RFC8152 8.1)
GetAssertionRequest
CTAP2 authenticatorGetAssertion (0x02) request (spec §6.2).
GetAssertionResponse
CTAP2 authenticatorGetAssertion (0x02) response (spec §6.2).
GetInfoRequest
CTAP2 authenticatorGetInfo (0x04) request.
MakeCredentialRequest
CTAP2 authenticatorMakeCredential (0x01) request (spec §6.1).
MakeCredentialResponse
CTAP2 authenticatorMakeCredential (0x01) response (spec §6.1).
PinProtocol
PinProtocolV1
PinProtocolV2
PublicKeyCredentialDescriptor
Identifies a specific credential (spec §5.8.3). Used to hint which credentials to create or allow during operations.
PublicKeyCredentialRpEntity
WebAuthn Relying Party (RP) parameters used during credential creation (see spec §5.4.2). Contains the RP identifier.
PublicKeyCredentialUserEntity
WebAuthn user account parameters for credential creation (spec §5.4.3). Includes an opaque user handle and human-readable names.
UnsupportedKey
Represents a currently unsupported COSE key type

Exceptions / Errors

CtapError
Represents an error retuned by CTAP device