webauthn

Development These docs follow the development version and change with every merge.

Last updated View as Markdown

Interfaces

PasskeyCeremonyOptions

Daemon registration challenge (CreationChallengeResponse + challenge_id).

Properties

challenge_id
challenge_id: string;
publicKey
publicKey: Record<string, unknown>;

Variables

PASSKEY_PROMPT_TIMEOUT_MS

const PASSKEY_PROMPT_TIMEOUT_MS: 45000 = 45_000;

How long to wait for a WebAuthn prompt. Browsers without passkey support (or in-app WebViews that stub the API) can hang forever on navigator.credentials.get / .create.

Functions

assertPasskey()

function assertPasskey(options): Promise<{
  challenge_id: string;
  credential: Record<string, unknown>;
}>;

Run an assertion ceremony and return JSON for login/elevate finish.

Parameters

Parameter Type Description
options PasskeyCeremonyOptions -

Returns

Promise<{ challenge_id: string; credential: Record<string, unknown>; }>


createPasskey()

function createPasskey(options): Promise<{
  challenge_id: string;
  credential: Record<string, unknown>;
}>;

Run a registration ceremony and return JSON for /register/finish.

Parameters

Parameter Type Description
options PasskeyCeremonyOptions -

Returns

Promise<{ challenge_id: string; credential: Record<string, unknown>; }>


creationOptionsFromJson()

function creationOptionsFromJson(publicKey): PublicKeyCredentialCreationOptions;

Decode a registration publicKey for navigator.credentials.create.

Parameters

Parameter Type Description
publicKey Record<string, unknown> -

Returns

PublicKeyCredentialCreationOptions


credentialToJson()

function credentialToJson(cred): Record<string, unknown>;

Serialize a WebAuthn credential for the daemon finish endpoints.

Parameters

Parameter Type Description
cred PublicKeyCredential -

Returns

Record<string, unknown>


passkeysSupported()

function passkeysSupported(): boolean;

True when the WebAuthn credential API is present.

Returns

boolean

Whether PublicKeyCredential and credential create/get are available.


requestOptionsFromJson()

function requestOptionsFromJson(publicKey): PublicKeyCredentialRequestOptions;

Decode an assertion publicKey for navigator.credentials.get.

Parameters

Parameter Type Description
publicKey Record<string, unknown> -

Returns

PublicKeyCredentialRequestOptions

Generated from ui/src/lib at main · View as Markdown