Class ECDSAKeyIdentity

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

Hierarchy

SignIdentity
- ECDSAKeyIdentity

Index

Constructors

constructor

Properties

Methods

Constructors

Protected constructor

new ECDSAKeyIdentity(keyPair: CryptoKeyPair, derKey: DerEncodedPublicKey, subtleCrypto: SubtleCrypto): ECDSAKeyIdentity

Overrides SignIdentity.constructor
- Defined in packages/identity/src/identity/ecdsa.ts:98
Parameters
- keyPair: CryptoKeyPair
- derKey: DerEncodedPublicKey
- subtleCrypto: SubtleCrypto
Returns ECDSAKeyIdentity

Properties

Protected _derKey

_derKey: DerEncodedPublicKey

Protected _keyPair

_keyPair: CryptoKeyPair

Protected _principal

_principal: undefined | Principal

Protected _subtleCrypto

_subtleCrypto: SubtleCrypto

Methods

getKeyPair

getKeyPair(): CryptoKeyPair

- Defined in packages/identity/src/identity/ecdsa.ts:113
Return the internally-used key pair.

Returns CryptoKeyPair
a {@link CryptoKeyPair}

getPrincipal

getPrincipal(): Principal

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

Returns Principal

getPublicKey

getPublicKey(): DerCryptoKey

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

Returns DerCryptoKey
an DerCryptoKey

sign

sign(challenge: ArrayBuffer): Promise<Signature>

Overrides SignIdentity.sign
- Defined in packages/identity/src/identity/ecdsa.ts:136
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>
signature

transformRequest

transformRequest(request: HttpAgentRequest): Promise<unknown>

Inherited from SignIdentity.transformRequest
- Defined in packages/agent/lib/cjs/auth.d.ts:71
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 fromKeyPair

fromKeyPair(keyPair: CryptoKeyPair | { privateKey: CryptoKey; publicKey: CryptoKey }, subtleCrypto?: SubtleCrypto): Promise<ECDSAKeyIdentity>

- Defined in packages/identity/src/identity/ecdsa.ts:81
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 {@link CryptoKeyPair}
- Optional subtleCrypto: SubtleCrypto
  
  a {@link SubtleCrypto} interface in case one is not available globally
Returns Promise<ECDSAKeyIdentity>
an ECDSAKeyIdentity

Static generate

generate(options?: CryptoKeyOptions): Promise<ECDSAKeyIdentity>

- Defined in packages/identity/src/identity/ecdsa.ts:56
Generates a randomly generated identity for use in calls to the Internet Computer.

constructs
ECDSAKeyIdentity

Parameters
- Optional options: CryptoKeyOptions
  
  optional settings
Returns Promise<ECDSAKeyIdentity>
a ECDSAKeyIdentity

Generated using TypeDoc