Class WebAuthnIdentity

A SignIdentity that uses navigator.credentials. See https://webauthn.guide/ for more information about WebAuthentication.

Hierarchy

SignIdentity
- WebAuthnIdentity

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new WebAuthnIdentity(rawId: ArrayBuffer, cose: ArrayBuffer, authenticatorAttachment: undefined | AuthenticatorAttachment): WebAuthnIdentity

Overrides SignIdentity.constructor
- Defined in packages/identity/src/identity/webauthn.ts:181
Parameters
- rawId: ArrayBuffer
- cose: ArrayBuffer
- authenticatorAttachment: undefined | AuthenticatorAttachment
Returns WebAuthnIdentity

Properties

Protected _principal

_principal: undefined | Principal

Protected _publicKey

_publicKey: CosePublicKey

Protected authenticatorAttachment

authenticatorAttachment: undefined | AuthenticatorAttachment

Readonly rawId

rawId: ArrayBuffer

Methods

getAuthenticatorAttachment

getAuthenticatorAttachment(): undefined | AuthenticatorAttachment

- Defined in packages/identity/src/identity/webauthn.ts:202
WebAuthn level 3 spec introduces a new attribute on successful WebAuthn interactions, see https://w3c.github.io/webauthn/#dom-publickeycredential-authenticatorattachment. This attribute is already implemented for Chrome, Safari and Edge.

Given the attribute is only available after a successful interaction, the information is provided opportunistically and might also be undefined.

Returns undefined | AuthenticatorAttachment

getPrincipal

getPrincipal(): Principal

Inherited from SignIdentity.getPrincipal
- Defined in packages/agent/lib/cjs/auth.d.ts:65
Get the principal represented by this identity. Normally should be a Principal.selfAuthenticating().

Returns Principal

getPublicKey

getPublicKey(): PublicKey

Overrides SignIdentity.getPublicKey
- Defined in packages/identity/src/identity/webauthn.ts:190
Returns PublicKey

sign

sign(blob: ArrayBuffer): Promise<Signature>

Overrides SignIdentity.sign
- Defined in packages/identity/src/identity/webauthn.ts:206
Parameters
- blob: ArrayBuffer
Returns Promise<Signature>

toJSON

toJSON(): JsonnableWebAuthnIdentity

- Defined in packages/identity/src/identity/webauthn.ts:242
Allow for JSON serialization of all information needed to reuse this identity.

Returns JsonnableWebAuthnIdentity

transformRequest

transformRequest(request: HttpAgentRequest): Promise<unknown>

Inherited from SignIdentity.transformRequest
- Defined in packages/agent/lib/cjs/auth.d.ts:72
Transform a request into a signed version of the request. This is done last after the transforms on the body of a request. The returned object can be anything, but must be serializable to CBOR.

Parameters
- request: HttpAgentRequest
  
  internet computer request to transform
Returns Promise<unknown>

Static create

create(credentialCreationOptions?: CredentialCreationOptions): Promise<WebAuthnIdentity>

- Defined in packages/identity/src/identity/webauthn.ts:155
Create an identity.

Parameters
- Optional credentialCreationOptions: CredentialCreationOptions
  
  an optional CredentialCreationOptions Challenge
Returns Promise<WebAuthnIdentity>

Static fromJSON

fromJSON(json: string): WebAuthnIdentity

- Defined in packages/identity/src/identity/webauthn.ts:141
Create an identity from a JSON serialization.

Parameters
- json: string
  
  json to parse
Returns WebAuthnIdentity

Generated using TypeDoc