Class Ed25519KeyIdentity

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

Hierarchy

SignIdentity
- Ed25519KeyIdentity

Index

Constructors

constructor

Properties

Methods

Constructors

Protected constructor

new Ed25519KeyIdentity(publicKey: PublicKey, privateKey: ArrayBuffer): Ed25519KeyIdentity

Overrides SignIdentity.constructor
- Defined in packages/identity/src/identity/ed25519.ts:168
Parameters
- publicKey: PublicKey
- privateKey: ArrayBuffer
Returns Ed25519KeyIdentity

Properties

Private #privateKey

#privateKey: Uint8Array

Private #publicKey

#publicKey: Ed25519PublicKey

Protected _principal

_principal: undefined | Principal

Methods

getKeyPair

getKeyPair(): KeyPair

- Defined in packages/identity/src/identity/ed25519.ts:184
Return a copy of the key pair.

Returns KeyPair

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(): Required<PublicKey>

Overrides SignIdentity.getPublicKey
- Defined in packages/identity/src/identity/ed25519.ts:194
Return the public key.

Returns Required<PublicKey>

sign

sign(challenge: ArrayBuffer): Promise<Signature>

Overrides SignIdentity.sign
- Defined in packages/identity/src/identity/ed25519.ts:202
Signs a blob of data, with this identity's private key.

Parameters
- challenge: ArrayBuffer
  
  challenge to sign with this identity's secretKey, producing a signature
Returns Promise<Signature>

toJSON

toJSON(): JsonnableEd25519KeyIdentity

- Defined in packages/identity/src/identity/ed25519.ts:177
Serialize this key to JSON.

Returns JsonnableEd25519KeyIdentity

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 fromJSON

fromJSON(json: string): Ed25519KeyIdentity

- Defined in packages/identity/src/identity/ed25519.ts:143
Parameters
- json: string
Returns Ed25519KeyIdentity

Static fromKeyPair

fromKeyPair(publicKey: ArrayBuffer, privateKey: ArrayBuffer): Ed25519KeyIdentity

- Defined in packages/identity/src/identity/ed25519.ts:155
Parameters
- publicKey: ArrayBuffer
- privateKey: ArrayBuffer
Returns Ed25519KeyIdentity

Static fromParsedJson

fromParsedJson(obj: JsonnableEd25519KeyIdentity): Ed25519KeyIdentity

- Defined in packages/identity/src/identity/ed25519.ts:135
Parameters
- obj: JsonnableEd25519KeyIdentity
Returns Ed25519KeyIdentity

Static fromSecretKey

fromSecretKey(secretKey: ArrayBuffer): Ed25519KeyIdentity

- Defined in packages/identity/src/identity/ed25519.ts:159
Parameters
- secretKey: ArrayBuffer
Returns Ed25519KeyIdentity

Static generate

generate(seed?: Uint8Array): Ed25519KeyIdentity

- Defined in packages/identity/src/identity/ed25519.ts:118
Generate a new Ed25519KeyIdentity.

Parameters
- Optional seed: Uint8Array
  
  a 32-byte seed for the private key. If not provided, a random seed will be generated.
Returns Ed25519KeyIdentity
Ed25519KeyIdentity

Static verify

verify(sig: string | ArrayBuffer | Uint8Array, msg: string | ArrayBuffer | Uint8Array, pk: string | ArrayBuffer | Uint8Array): boolean

- Defined in packages/identity/src/identity/ed25519.ts:223
Verify

Parameters
- sig: string | ArrayBuffer | Uint8Array
  
  signature to verify
- msg: string | ArrayBuffer | Uint8Array
  
  message to verify
- pk: string | ArrayBuffer | Uint8Array
  
  public key
Returns boolean
- true if the signature is valid, false otherwise

Generated using TypeDoc