Skip to main content

Class: PasskeyAuthenticator

A passkey authenticator.

BCS

The BCS serialized form for this type is defined by the following ABNF:

passkey-bcs = bytes               ; where the contents of the bytes are
; defined by <passkey>
passkey     = passkey-flag
bytes               ; passkey authenticator data
client-data-json    ; valid json
simple-signature    ; required to be a secp256r1 signature

client-data-json = string ; valid json

See https://www.w3.org/TR/webauthn-2/#dictdef-collectedclientdata for the required json-schema for the client-data-json rule. In addition, IOTA currently requires that the CollectedClientData.type field is required to be webauthn.get.

Note: Due to historical reasons, signatures are serialized slightly different from the majority of the types in IOTA. In particular if a signature is ever embedded in another structure it generally is serialized as bytes meaning it has a length prefix that defines the length of the completely serialized signature.

Extends​

  • UniffiAbstractObject

Implements​

Properties​

[destructorGuardSymbol]​

readonly [destructorGuardSymbol]: UniffiGcObject;

[pointerLiteralSymbol]​

readonly [pointerLiteralSymbol]: bigint;

[uniffiTypeNameSymbol]​

readonly [uniffiTypeNameSymbol]: "PasskeyAuthenticator" = "PasskeyAuthenticator";

Methods​

authenticatorData()​

authenticatorData(): ArrayBuffer;

Opaque authenticator data for this passkey signature.

See https://www.w3.org/TR/webauthn-2/#sctn-authenticator-data for more information on this field.

Returns​

ArrayBuffer

Implementation of​

PasskeyAuthenticatorLike.authenticatorData

challenge()​

challenge(): ArrayBuffer;

The parsed challenge message for this passkey signature.

This is parsed by decoding the base64url data from the client_data_json.challenge field.

Returns​

ArrayBuffer

Implementation of​

PasskeyAuthenticatorLike.challenge

clientDataJson()​

clientDataJson(): string;

Structured, unparsed, JSON for this passkey signature.

See https://www.w3.org/TR/webauthn-2/#dictdef-collectedclientdata for more information on this field.

Returns​

string

Implementation of​

PasskeyAuthenticatorLike.clientDataJson

equals()​

equals(other): boolean;

Parameters​

other​

PasskeyAuthenticator

Returns​

boolean

publicKey()​

publicKey(): PasskeyPublicKeyLike;

The passkey public key.

Returns​

PasskeyPublicKeyLike

Implementation of​

PasskeyAuthenticatorLike.publicKey

signature()​

signature(): SimpleSignatureLike;

The passkey signature.

Returns​

SimpleSignatureLike

Implementation of​

PasskeyAuthenticatorLike.signature

toDebugString()​

toDebugString(): string;

Returns​

string

toString()​

toString(): string;

Returns a string representation of an object.

Returns​

string

uniffiDestroy()​

uniffiDestroy(): void;

Explicitly tell Rust to destroy the native peer that backs this object.

Once this method has been called, any following method calls will throw an error.

Can be called more than once.

Returns​

void

Overrides​

UniffiAbstractObject.uniffiDestroy

uniffiUse()​

uniffiUse<T>(block): T;

A convenience method to use this object, then destroy it after its use.

Type Parameters​

T​

T

Parameters​

block​

(obj) => T

Returns​

T

Inherited from​

UniffiAbstractObject.uniffiUse

instanceOf()​

static instanceOf(obj_): obj_ is PasskeyAuthenticator;

Parameters​

obj_​

any

Returns​

obj_ is PasskeyAuthenticator