Overview

Classes

AttributesIdentity

Defined in: packages/core/src/identity/identity/attributes.ts:54

An Identity decorator that injects sender_info into the request body before delegating to an inner identity for signing.

Because sender_info is part of the request content, it is included in the representation-independent hash (requestIdOf) and covered by the sender’s signature for call and query endpoints.

The IC does not hash sender_info for read_state requests, so the decorator skips injection for that endpoint to avoid signature verification failures on update-call polls.

Example

const inner = DelegationIdentity.fromDelegation(key, chain);
const identity = new AttributesIdentity({
  inner,
  attributes: { data: new Uint8Array([...]), signature: new Uint8Array([...]) },
  signer: { canisterId: Principal.fromText('aaaaa-aa') },
});
const agent = HttpAgent.create({ identity });

Implements

• Identity

Constructors

Constructor

new AttributesIdentity(options): AttributesIdentity

Defined in: packages/core/src/identity/identity/attributes.ts:65

Parameters

options

AttributesIdentityOptions

Configuration for the identity.

Returns

AttributesIdentity

Methods

getPrincipal()

getPrincipal(): Principal

Defined in: packages/core/src/identity/identity/attributes.ts:71

Get the principal represented by this identity. Normally should be a Principal.selfAuthenticating().

Returns

Principal

Implementation of

Identity.getPrincipal

transformRequest()

transformRequest(request): Promise<unknown>

Defined in: packages/core/src/identity/identity/attributes.ts:75

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

Returns

Promise<unknown>

Implementation of

Identity.transformRequest

---

CryptoError

Defined in: packages/core/src/identity/identity/ecdsa.ts:13

Extends

• Error

Constructors

Constructor

new CryptoError(message): CryptoError

Defined in: packages/core/src/identity/identity/ecdsa.ts:14

Parameters

message

string

Returns

CryptoError

Overrides

Error.constructor

Properties

cause?

optional cause?: unknown

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

Error.cause

message

readonly message: string

Defined in: packages/core/src/identity/identity/ecdsa.ts:14

Inherited from

Error.message

name

name: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.name

stack?

optional stack?: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@25.5.0/node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace

---

Delegation

Defined in: packages/core/src/identity/identity/delegation.ts:42

A single delegation object that is signed by a private key. This is constructed by DelegationChain.create().

DelegationChain

Implements

• ToCborValue

Constructors

Constructor

new Delegation(pubkey, expiration, targets?): Delegation

Defined in: packages/core/src/identity/identity/delegation.ts:43

Parameters

pubkey

Uint8Array

expiration

bigint

targets?

Principal[]

Returns

Delegation

Properties

expiration

readonly expiration: bigint

Defined in: packages/core/src/identity/identity/delegation.ts:45

pubkey

readonly pubkey: Uint8Array

Defined in: packages/core/src/identity/identity/delegation.ts:44

targets?

readonly optional targets?: Principal[]

Defined in: packages/core/src/identity/identity/delegation.ts:46

Methods

toCborValue()

toCborValue(): object

Defined in: packages/core/src/identity/identity/delegation.ts:49

Returns a value that can be encoded with CBOR. Typically called in the replacer function of the encode function.

Returns

object

expiration

expiration: bigint

pubkey

pubkey: Uint8Array<ArrayBufferLike>

targets?

optional targets?: Principal[]

Implementation of

ToCborValue.toCborValue

toJSON()

toJSON(): JsonnableDelegation

Defined in: packages/core/src/identity/identity/delegation.ts:59

Returns

JsonnableDelegation

---

DelegationChain

Defined in: packages/core/src/identity/identity/delegation.ts:149

A chain of delegations. This is JSON Serializable. This is the object to serialize and pass to a DelegationIdentity. It does not keep any private keys.

Constructors

Constructor

protected new DelegationChain(delegations, publicKey): DelegationChain

Defined in: packages/core/src/identity/identity/delegation.ts:243

Parameters

delegations

SignedDelegation[]

publicKey

DerEncodedPublicKey

Returns

DelegationChain

Properties

delegations

readonly delegations: SignedDelegation[]

Defined in: packages/core/src/identity/identity/delegation.ts:244

publicKey

readonly publicKey: DerEncodedPublicKey

Defined in: packages/core/src/identity/identity/delegation.ts:245

Methods

toJSON()

toJSON(): JsonnableDelegationChain

Defined in: packages/core/src/identity/identity/delegation.ts:248

Returns

JsonnableDelegationChain

create()

static create(from, to, expiration?, options?): Promise<DelegationChain>

Defined in: packages/core/src/identity/identity/delegation.ts:179

Create a delegation chain between two (or more) keys. By default, the expiration time will be very short (15 minutes).

To build a chain of more than 2 identities, this function needs to be called multiple times, passing the previous delegation chain into the options argument. For example:

Parameters

from

SignIdentity

The identity that will delegate.

to

PublicKey

The identity that gets delegated. It can now sign messages as if it was the identity above.

expiration?

Date = ...

The length the delegation is valid. By default, 15 minutes from calling this function.

options?

A set of options for this delegation. expiration and previous

previous?

DelegationChain

Another DelegationChain that this chain should start with.

targets?

Principal[]

targets that scope the delegation (e.g. Canister Principals)

Returns

Promise<DelegationChain>

Example

const rootKey = createKey();
const middleKey = createKey();
const bottomeKey = createKey();

const rootToMiddle = await DelegationChain.create(
  root, middle.getPublicKey(), Date.parse('2100-01-01'),
);
const middleToBottom = await DelegationChain.create(
  middle, bottom.getPublicKey(), Date.parse('2100-01-01'), { previous: rootToMiddle },
);

// We can now use a delegation identity that uses the delegation above:
const identity = DelegationIdentity.fromDelegation(bottomKey, middleToBottom);

fromDelegations()

static fromDelegations(delegations, publicKey): DelegationChain

Defined in: packages/core/src/identity/identity/delegation.ts:236

Creates a DelegationChain object from a list of delegations and a DER-encoded public key.

Parameters

delegations

SignedDelegation[]

The list of delegations.

publicKey

DerEncodedPublicKey

The DER-encoded public key of the key-pair signing the first delegation.

Returns

DelegationChain

fromJSON()

static fromJSON(json): DelegationChain

Defined in: packages/core/src/identity/identity/delegation.ts:199

Creates a DelegationChain object from a JSON string.

Parameters

json

string | JsonnableDelegationChain

The JSON string to parse.

Returns

DelegationChain

---

DelegationIdentity

Defined in: packages/core/src/identity/identity/delegation.ts:275

An Identity that adds delegation to a request. Everywhere in this class, the name innerKey refers to the SignIdentity that is being used to sign the requests, while originalKey is the identity that is being borrowed. More identities can be used in the middle to delegate.

Extends

• SignIdentity

Constructors

Constructor

protected new DelegationIdentity(_inner, _delegation): DelegationIdentity

Defined in: packages/core/src/identity/identity/delegation.ts:288

Parameters

_inner

Pick<SignIdentity, "sign">

_delegation

DelegationChain

Returns

DelegationIdentity

Overrides

SignIdentity.constructor

Properties

_principal

protected _principal: Principal | undefined

Defined in: packages/core/src/agent/auth.ts:58

Inherited from

SignIdentity._principal

Methods

getDelegation()

getDelegation(): DelegationChain

Defined in: packages/core/src/identity/identity/delegation.ts:295

Returns

DelegationChain

getPrincipal()

getPrincipal(): Principal

Defined in: packages/core/src/agent/auth.ts:74

Get the principal represented by this identity. Normally should be a Principal.selfAuthenticating().

Returns

Principal

Inherited from

SignIdentity.getPrincipal

getPublicKey()

getPublicKey(): PublicKey

Defined in: packages/core/src/identity/identity/delegation.ts:299

Returns the public key that would match this identity’s signature.

Returns

PublicKey

Overrides

SignIdentity.getPublicKey

sign()

sign(blob): Promise<Signature>

Defined in: packages/core/src/identity/identity/delegation.ts:305

Signs a blob of data, with this identity’s private key.

Parameters

blob

Uint8Array

Returns

Promise<Signature>

Overrides

SignIdentity.sign

transformRequest()

transformRequest(request): Promise<unknown>

Defined in: packages/core/src/identity/identity/delegation.ts:309

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>

Overrides

SignIdentity.transformRequest

fromDelegation()

static fromDelegation(key, delegation): DelegationIdentity

Defined in: packages/core/src/identity/identity/delegation.ts:281

Create a delegation without having access to delegateKey.

Parameters

key

Pick<SignIdentity, "sign">

The key used to sign the requests.

delegation

DelegationChain

A delegation object created using createDelegation.

Returns

DelegationIdentity

---

ECDSAKeyIdentity

Defined in: packages/core/src/identity/identity/ecdsa.ts:47

An identity interface that wraps an ECDSA keypair using the P-256 named curve. Supports DER-encoding and decoding for agent calls

Extends

• SignIdentity

Constructors

Constructor

protected new ECDSAKeyIdentity(keyPair, derKey, subtleCrypto): ECDSAKeyIdentity

Defined in: packages/core/src/identity/identity/ecdsa.ts:103

Parameters

keyPair

CryptoKeyPair

derKey

DerEncodedPublicKey

subtleCrypto

SubtleCrypto

Returns

ECDSAKeyIdentity

Overrides

SignIdentity.constructor

Properties

_derKey

protected _derKey: DerEncodedPublicKey

Defined in: packages/core/src/identity/identity/ecdsa.ts:98

_keyPair

protected _keyPair: CryptoKeyPair

Defined in: packages/core/src/identity/identity/ecdsa.ts:99

_principal

protected _principal: Principal | undefined

Defined in: packages/core/src/agent/auth.ts:58

Inherited from

SignIdentity._principal

_subtleCrypto

protected _subtleCrypto: SubtleCrypto

Defined in: packages/core/src/identity/identity/ecdsa.ts:100

Methods

getKeyPair()

getKeyPair(): CryptoKeyPair

Defined in: packages/core/src/identity/identity/ecdsa.ts:118

Return the internally-used key pair.

Returns

CryptoKeyPair

a CryptoKeyPair

getPrincipal()

getPrincipal(): Principal

Defined in: packages/core/src/agent/auth.ts:74

Get the principal represented by this identity. Normally should be a Principal.selfAuthenticating().

Returns

Principal

Inherited from

SignIdentity.getPrincipal

getPublicKey()

getPublicKey(): PublicKey & DerCryptoKey

Defined in: packages/core/src/identity/identity/ecdsa.ts:126

Return the public key.

Returns

PublicKey & DerCryptoKey

an & DerCryptoKey

Overrides

SignIdentity.getPublicKey

sign()

sign(challenge): Promise<Signature>

Defined in: packages/core/src/identity/identity/ecdsa.ts:141

Signs a blob of data, with this identity’s private key.

Parameters

challenge

Uint8Array

challenge to sign with this identity’s secretKey, producing a signature

Returns

Promise<Signature>

signature

Overrides

SignIdentity.sign

transformRequest()

transformRequest(request): Promise<unknown>

Defined in: packages/core/src/agent/auth.ts:87

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>

Inherited from

SignIdentity.transformRequest

fromKeyPair()

static fromKeyPair(keyPair, subtleCrypto?): Promise<ECDSAKeyIdentity>

Defined in: packages/core/src/identity/identity/ecdsa.ts:84

generates an identity from a public and private key. Please ensure that you are generating these keys securely and protect the user’s private key

Parameters

keyPair

CryptoKeyPair | { privateKey: CryptoKey; publicKey: CryptoKey; }

a CryptoKeyPair

subtleCrypto?

SubtleCrypto

a SubtleCrypto interface in case one is not available globally

Returns

Promise<ECDSAKeyIdentity>

an ECDSAKeyIdentity

generate()

static generate(options?): Promise<ECDSAKeyIdentity>

Defined in: packages/core/src/identity/identity/ecdsa.ts:56

Generates a randomly generated identity for use in calls to the Internet Computer.

Parameters

options?

CryptoKeyOptions

optional settings

Returns

Promise<ECDSAKeyIdentity>

a ECDSAKeyIdentity

---

Ed25519KeyIdentity

Defined in: packages/core/src/identity/identity/ed25519.ts:115

Ed25519KeyIdentity is an implementation of SignIdentity that uses Ed25519 keys. This class is used to sign and verify messages for an agent.

Extends

• SignIdentity

Constructors

Constructor

protected new Ed25519KeyIdentity(publicKey, privateKey): Ed25519KeyIdentity

Defined in: packages/core/src/identity/identity/ed25519.ts:175

Parameters

publicKey

PublicKey

privateKey

Uint8Array

Returns

Ed25519KeyIdentity

Overrides

SignIdentity.constructor

Properties

_principal

protected _principal: Principal | undefined

Defined in: packages/core/src/agent/auth.ts:58

Inherited from

SignIdentity._principal

Methods

getKeyPair()

getKeyPair(): KeyPair

Defined in: packages/core/src/identity/identity/ed25519.ts:191

Return a copy of the key pair.

Returns

KeyPair

getPrincipal()

getPrincipal(): Principal

Defined in: packages/core/src/agent/auth.ts:74

Get the principal represented by this identity. Normally should be a Principal.selfAuthenticating().

Returns

Principal

Inherited from

SignIdentity.getPrincipal

getPublicKey()

getPublicKey(): Required<PublicKey>

Defined in: packages/core/src/identity/identity/ed25519.ts:201

Return the public key.

Returns

Required<PublicKey>

Overrides

SignIdentity.getPublicKey

sign()

sign(challenge): Promise<Signature>

Defined in: packages/core/src/identity/identity/ed25519.ts:209

Signs a blob of data, with this identity’s private key.

Parameters

challenge

Uint8Array

challenge to sign with this identity’s secretKey, producing a signature

Returns

Promise<Signature>

Overrides

SignIdentity.sign

toJSON()

toJSON(): JsonnableEd25519KeyIdentity

Defined in: packages/core/src/identity/identity/ed25519.ts:184

Serialize this key to JSON.

Returns

JsonnableEd25519KeyIdentity

transformRequest()

transformRequest(request): Promise<unknown>

Defined in: packages/core/src/agent/auth.ts:87

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>

Inherited from

SignIdentity.transformRequest

fromJSON()

static fromJSON(json): Ed25519KeyIdentity

Defined in: packages/core/src/identity/identity/ed25519.ts:151

Parameters

json

string

Returns

Ed25519KeyIdentity

fromKeyPair()

static fromKeyPair(publicKey, privateKey): Ed25519KeyIdentity

Defined in: packages/core/src/identity/identity/ed25519.ts:162

Parameters

publicKey

Uint8Array

privateKey

Uint8Array

Returns

Ed25519KeyIdentity

fromParsedJson()

static fromParsedJson(obj): Ed25519KeyIdentity

Defined in: packages/core/src/identity/identity/ed25519.ts:143

Parameters

obj

JsonnableEd25519KeyIdentity

Returns

Ed25519KeyIdentity

fromSecretKey()

static fromSecretKey(secretKey): Ed25519KeyIdentity

Defined in: packages/core/src/identity/identity/ed25519.ts:166

Parameters

secretKey

Uint8Array

Returns

Ed25519KeyIdentity

generate()

static generate(seed?): Ed25519KeyIdentity

Defined in: packages/core/src/identity/identity/ed25519.ts:121

Generate a new Ed25519KeyIdentity.

Parameters

seed?

Uint8Array<ArrayBufferLike>

a 32-byte seed for the private key. If not provided, a random seed will be generated.

Returns

Ed25519KeyIdentity

Ed25519KeyIdentity

verify()

static verify(sig, msg, pk): boolean

Defined in: packages/core/src/identity/identity/ed25519.ts:229

Verify

Parameters

sig

string | ArrayBuffer | Uint8Array<ArrayBufferLike>

signature to verify

msg

string | ArrayBuffer | Uint8Array<ArrayBufferLike>

message to verify

pk

string | ArrayBuffer | Uint8Array<ArrayBufferLike>

public key

Returns

boolean

• true if the signature is valid, false otherwise

---

Ed25519PublicKey

Defined in: packages/core/src/identity/identity/ed25519.ts:21

A Public Key implementation.

Implements

• PublicKey

Accessors

derKey

Get Signature

get derKey(): DerEncodedPublicKey

Defined in: packages/core/src/identity/identity/ed25519.ts:90

Returns

DerEncodedPublicKey

Implementation of

PublicKey.derKey

rawKey

Get Signature

get rawKey(): Uint8Array

Defined in: packages/core/src/identity/identity/ed25519.ts:84

Returns

Uint8Array

Implementation of

PublicKey.rawKey

Methods

toDer()

toDer(): DerEncodedPublicKey

Defined in: packages/core/src/identity/identity/ed25519.ts:103

Returns

DerEncodedPublicKey

Implementation of

PublicKey.toDer

toRaw()

toRaw(): Uint8Array

Defined in: packages/core/src/identity/identity/ed25519.ts:107

Returns

Uint8Array

Implementation of

PublicKey.toRaw

from()

static from(maybeKey): Ed25519PublicKey

Defined in: packages/core/src/identity/identity/ed25519.ts:27

Construct Ed25519PublicKey from an existing PublicKey

Parameters

maybeKey

unknown

existing PublicKey, ArrayBuffer, DerEncodedPublicKey, or hex string

Returns

Ed25519PublicKey

Instance of Ed25519PublicKey

fromDer()

static fromDer(derKey): Ed25519PublicKey

Defined in: packages/core/src/identity/identity/ed25519.ts:61

Parameters

derKey

DerEncodedPublicKey

Returns

Ed25519PublicKey

fromRaw()

static fromRaw(rawKey): Ed25519PublicKey

Defined in: packages/core/src/identity/identity/ed25519.ts:57

Parameters

rawKey

Uint8Array

Returns

Ed25519PublicKey

---

PartialDelegationIdentity

Defined in: packages/core/src/identity/identity/delegation.ts:329

A partial delegated identity, representing a delegation chain and the public key that it targets

Extends

• PartialIdentity

Accessors

delegation

Get Signature

get delegation(): DelegationChain

Defined in: packages/core/src/identity/identity/delegation.ts:335

The Delegation Chain of this identity.

Returns

DelegationChain

derKey

Get Signature

get derKey(): Uint8Array<ArrayBufferLike> | undefined

Defined in: packages/core/src/identity/identity/partial.ts:20

The DER-encoded public key of this identity.

Returns

Uint8Array<ArrayBufferLike> | undefined

Inherited from

PartialIdentity.derKey

rawKey

Get Signature

get rawKey(): Uint8Array<ArrayBufferLike> | undefined

Defined in: packages/core/src/identity/identity/partial.ts:13

The raw public key of this identity.

Returns

Uint8Array<ArrayBufferLike> | undefined

Inherited from

PartialIdentity.rawKey

Methods

getPrincipal()

getPrincipal(): Principal

Defined in: packages/core/src/identity/identity/partial.ts:41

The Principal of this identity.

Returns

Principal

Inherited from

PartialIdentity.getPrincipal

getPublicKey()

getPublicKey(): PublicKey

Defined in: packages/core/src/identity/identity/partial.ts:34

The inner PublicKey used by this identity.

Returns

PublicKey

Inherited from

PartialIdentity.getPublicKey

toDer()

toDer(): Uint8Array

Defined in: packages/core/src/identity/identity/partial.ts:27

The DER-encoded public key of this identity.

Returns

Uint8Array

Inherited from

PartialIdentity.toDer

transformRequest()

transformRequest(): Promise<never>

Defined in: packages/core/src/identity/identity/partial.ts:51

Required for the Identity interface, but cannot implemented for just a public key.

Returns

Promise<never>

Inherited from

PartialIdentity.transformRequest

fromDelegation()

static fromDelegation(key, delegation): PartialDelegationIdentity

Defined in: packages/core/src/identity/identity/delegation.ts:349

Create a PartialDelegationIdentity from a PublicKey and a DelegationChain.

Parameters

key

PublicKey

The PublicKey to delegate to.

delegation

DelegationChain

a DelegationChain targeting the inner key.

Returns

PartialDelegationIdentity

---

PartialIdentity

Defined in: packages/core/src/identity/identity/partial.ts:7

A partial delegated identity, representing a delegation chain and the public key that it targets

Extended by

• PartialDelegationIdentity

Implements

• Identity

Constructors

Constructor

new PartialIdentity(inner): PartialIdentity

Defined in: packages/core/src/identity/identity/partial.ts:57

Parameters

inner

PublicKey

Returns

PartialIdentity

Accessors

derKey

Get Signature

get derKey(): Uint8Array<ArrayBufferLike> | undefined

Defined in: packages/core/src/identity/identity/partial.ts:20

The DER-encoded public key of this identity.

Returns

Uint8Array<ArrayBufferLike> | undefined

rawKey

Get Signature

get rawKey(): Uint8Array<ArrayBufferLike> | undefined

Defined in: packages/core/src/identity/identity/partial.ts:13

The raw public key of this identity.

Returns

Uint8Array<ArrayBufferLike> | undefined

Methods

getPrincipal()

getPrincipal(): Principal

Defined in: packages/core/src/identity/identity/partial.ts:41

The Principal of this identity.

Returns

Principal

Implementation of

Identity.getPrincipal

getPublicKey()

getPublicKey(): PublicKey

Defined in: packages/core/src/identity/identity/partial.ts:34

The inner PublicKey used by this identity.

Returns

PublicKey

toDer()

toDer(): Uint8Array

Defined in: packages/core/src/identity/identity/partial.ts:27

The DER-encoded public key of this identity.

Returns

Uint8Array

transformRequest()

transformRequest(): Promise<never>

Defined in: packages/core/src/identity/identity/partial.ts:51

Required for the Identity interface, but cannot implemented for just a public key.

Returns

Promise<never>

Implementation of

Identity.transformRequest

---

WebAuthnIdentity

Defined in: packages/core/src/identity/identity/webauthn.ts:137

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

Extends

• SignIdentity

Constructors

Constructor

new WebAuthnIdentity(rawId, cose, authenticatorAttachment): WebAuthnIdentity

Defined in: packages/core/src/identity/identity/webauthn.ts:184

Parameters

rawId

Uint8Array

cose

Uint8Array

authenticatorAttachment

AuthenticatorAttachment | undefined

Returns

WebAuthnIdentity

Overrides

SignIdentity.constructor

Properties

_principal

protected _principal: Principal | undefined

Defined in: packages/core/src/agent/auth.ts:58

Inherited from

SignIdentity._principal

_publicKey

protected _publicKey: CosePublicKey

Defined in: packages/core/src/identity/identity/webauthn.ts:182

authenticatorAttachment

protected authenticatorAttachment: AuthenticatorAttachment | undefined

Defined in: packages/core/src/identity/identity/webauthn.ts:187

rawId

readonly rawId: Uint8Array

Defined in: packages/core/src/identity/identity/webauthn.ts:185

Methods

getAuthenticatorAttachment()

getAuthenticatorAttachment(): AuthenticatorAttachment | undefined

Defined in: packages/core/src/identity/identity/webauthn.ts:205

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

AuthenticatorAttachment | undefined

getPrincipal()

getPrincipal(): Principal

Defined in: packages/core/src/agent/auth.ts:74

Get the principal represented by this identity. Normally should be a Principal.selfAuthenticating().

Returns

Principal

Inherited from

SignIdentity.getPrincipal

getPublicKey()

getPublicKey(): PublicKey

Defined in: packages/core/src/identity/identity/webauthn.ts:193

Returns the public key that would match this identity’s signature.

Returns

PublicKey

Overrides

SignIdentity.getPublicKey

sign()

sign(blob): Promise<Signature>

Defined in: packages/core/src/identity/identity/webauthn.ts:209

Signs a blob of data, with this identity’s private key.

Parameters

blob

Uint8Array

Returns

Promise<Signature>

Overrides

SignIdentity.sign

toJSON()

toJSON(): JsonnableWebAuthnIdentity

Defined in: packages/core/src/identity/identity/webauthn.ts:249

Allow for JSON serialization of all information needed to reuse this identity.

Returns

JsonnableWebAuthnIdentity

transformRequest()

transformRequest(request): Promise<unknown>

Defined in: packages/core/src/agent/auth.ts:87

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>

Inherited from

SignIdentity.transformRequest

create()

static create(credentialCreationOptions?): Promise<WebAuthnIdentity>

Defined in: packages/core/src/identity/identity/webauthn.ts:156

Create an identity.

Parameters

credentialCreationOptions?

CredentialCreationOptions

an optional CredentialCreationOptions Challenge

Returns

Promise<WebAuthnIdentity>

fromJSON()

static fromJSON(json): WebAuthnIdentity

Defined in: packages/core/src/identity/identity/webauthn.ts:142

Create an identity from a JSON serialization.

Parameters

json

string

json to parse

Returns

WebAuthnIdentity

Interfaces

AttributesIdentityOptions

Defined in: packages/core/src/identity/identity/attributes.ts:22

Options for creating an AttributesIdentity.

Properties

attributes

attributes: SignedAttributes

Defined in: packages/core/src/identity/identity/attributes.ts:26

The signed attributes to include in the request.

inner

inner: Identity

Defined in: packages/core/src/identity/identity/attributes.ts:24

The inner identity to delegate signing to.

signer

signer: Signer

Defined in: packages/core/src/identity/identity/attributes.ts:28

The canister that signed the attributes.

---

CryptoKeyOptions

Defined in: packages/core/src/identity/identity/ecdsa.ts:7

Options used in a ECDSAKeyIdentity

Properties

extractable?

optional extractable?: boolean

Defined in: packages/core/src/identity/identity/ecdsa.ts:8

keyUsages?

optional keyUsages?: KeyUsage[]

Defined in: packages/core/src/identity/identity/ecdsa.ts:9

subtleCrypto?

optional subtleCrypto?: SubtleCrypto

Defined in: packages/core/src/identity/identity/ecdsa.ts:10

---

DelegationValidChecks

Defined in: packages/core/src/identity/identity/delegation.ts:357

List of things to check for a delegation chain validity.

Properties

scope?

optional scope?: string | Principal | (string | Principal)[]

Defined in: packages/core/src/identity/identity/delegation.ts:361

Check that the scope is amongst the scopes that this delegation has access to.

---

DerCryptoKey

Defined in: packages/core/src/identity/identity/ecdsa.ts:20

Extends

• CryptoKey

Properties

algorithm

readonly algorithm: KeyAlgorithm

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:8469

The read-only algorithm property of the CryptoKey interface returns an object describing the algorithm for which this key can be used, and any associated extra parameters.

MDN Reference

Inherited from

CryptoKey.algorithm

extractable

readonly extractable: boolean

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:8475

The read-only extractable property of the CryptoKey interface indicates whether or not the key may be extracted using SubtleCrypto.exportKey() or SubtleCrypto.wrapKey().

MDN Reference

Inherited from

CryptoKey.extractable

toDer

toDer: () => DerEncodedPublicKey

Defined in: packages/core/src/identity/identity/ecdsa.ts:21

Returns

DerEncodedPublicKey

type

readonly type: KeyType

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:8481

The read-only type property of the CryptoKey interface indicates which kind of key is represented by the object.

MDN Reference

Inherited from

CryptoKey.type

usages

readonly usages: KeyUsage[]

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:8487

The read-only usages property of the CryptoKey interface indicates what can be done with the key.

MDN Reference

Inherited from

CryptoKey.usages

---

JsonnableDelegationChain

Defined in: packages/core/src/identity/identity/delegation.ts:132

Properties

delegations

delegations: object[]

Defined in: packages/core/src/identity/identity/delegation.ts:134

delegation

delegation: object

delegation.expiration

expiration: string

delegation.pubkey

pubkey: string

delegation.targets?

optional targets?: string[]

signature

signature: string

publicKey

publicKey: string

Defined in: packages/core/src/identity/identity/delegation.ts:133

---

SignedAttributes

Defined in: packages/core/src/identity/identity/attributes.ts:7

Signed attributes to be included as sender_info in the request content.

Properties

data

data: Uint8Array

Defined in: packages/core/src/identity/identity/attributes.ts:8

signature

signature: Uint8Array

Defined in: packages/core/src/identity/identity/attributes.ts:9

---

SignedDelegation

Defined in: packages/core/src/identity/identity/delegation.ts:92

A signed delegation, which lends its identity to the public key in the delegation object. This is constructed by DelegationChain.create().

DelegationChain

Properties

delegation

delegation: Delegation

Defined in: packages/core/src/identity/identity/delegation.ts:93

signature

signature: Signature

Defined in: packages/core/src/identity/identity/delegation.ts:94

---

Signer

Defined in: packages/core/src/identity/identity/attributes.ts:15

The canister that signed the attributes.

Properties

canisterId

canisterId: Principal

Defined in: packages/core/src/identity/identity/attributes.ts:16

Type Aliases

JsonnableEd25519KeyIdentity

JsonnableEd25519KeyIdentity = [PublicKeyHex, SecretKeyHex]

Defined in: packages/core/src/identity/identity/ed25519.ts:246

Functions

isDelegationValid()

isDelegationValid(chain, checks?): boolean

Defined in: packages/core/src/identity/identity/delegation.ts:370

Analyze a DelegationChain and validate that it’s valid, ie. not expired and apply to the scope.

Parameters

chain

DelegationChain

The chain to validate.

checks?

DelegationValidChecks

Various checks to validate on the chain.

Returns

boolean

References

DER_COSE_OID

Re-exports DER_COSE_OID

---

ED25519_OID

Re-exports ED25519_OID

---

unwrapDER

Re-exports unwrapDER

---

wrapDER

Re-exports wrapDER