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

Protected constructor

new WebAuthnIdentity(rawId: ArrayBuffer, cose: ArrayBuffer): WebAuthnIdentity

Overrides SignIdentity.constructor
- Defined in identity/src/identity/webauthn.ts:154
Parameters
- rawId: ArrayBuffer
- cose: ArrayBuffer
Returns WebAuthnIdentity

Properties

Protected _principal

_principal: undefined | Principal

Protected _publicKey

_publicKey: CosePublicKey

Readonly rawId

rawId: ArrayBuffer

Methods

getPrincipal

getPrincipal(): Principal

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

Returns Principal

getPublicKey

getPublicKey(): PublicKey

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

sign

sign(blob: ArrayBuffer): Promise<Signature>

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

toJSON

toJSON(): JsonnableWebAuthnIdentitiy

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

Returns JsonnableWebAuthnIdentitiy

transformRequest

transformRequest(request: HttpAgentRequest): Promise<unknown>

Inherited from SignIdentity.transformRequest
- Defined in agent/lib/cjs/auth.d.ts:69
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 identity/src/identity/webauthn.ts:132
Create an identity.

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

Static fromJSON

fromJSON(json: string): WebAuthnIdentity

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

Parameters
- json: string
  
  json to parse
Returns WebAuthnIdentity

Generated using TypeDoc