ECDSAKeyIdentity
Defined in: packages/identity/src/identity/ecdsa.ts:52
An identity interface that wraps an ECDSA keypair using the P-256 named curve. Supports DER-encoding and decoding for agent calls
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”
protectednew ECDSAKeyIdentity(keyPair,derKey,subtleCrypto):ECDSAKeyIdentity
Defined in: packages/identity/src/identity/ecdsa.ts:108
Parameters
Section titled “Parameters”keyPair
Section titled “keyPair”CryptoKeyPair
derKey
Section titled “derKey”subtleCrypto
Section titled “subtleCrypto”SubtleCrypto
Returns
Section titled “Returns”ECDSAKeyIdentity
Overrides
Section titled “Overrides”Properties
Section titled “Properties”_derKey
Section titled “_derKey”
protected_derKey:DerEncodedPublicKey
Defined in: packages/identity/src/identity/ecdsa.ts:103
_keyPair
Section titled “_keyPair”
protected_keyPair:CryptoKeyPair
Defined in: packages/identity/src/identity/ecdsa.ts:104
_principal
Section titled “_principal”
protected_principal:undefined|Principal
Defined in: packages/agent/lib/esm/auth.d.ts:52
Inherited from
Section titled “Inherited from”_subtleCrypto
Section titled “_subtleCrypto”
protected_subtleCrypto:SubtleCrypto
Defined in: packages/identity/src/identity/ecdsa.ts:105
Methods
Section titled “Methods”getKeyPair()
Section titled “getKeyPair()”getKeyPair():
CryptoKeyPair
Defined in: packages/identity/src/identity/ecdsa.ts:123
Return the internally-used key pair.
Returns
Section titled “Returns”CryptoKeyPair
a CryptoKeyPair
getPrincipal()
Section titled “getPrincipal()”getPrincipal():
Principal
Defined in: packages/agent/lib/esm/auth.d.ts:65
Get the principal represented by this identity. Normally should be a
Principal.selfAuthenticating().
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”getPublicKey()
Section titled “getPublicKey()”getPublicKey():
PublicKey&DerCryptoKey
Defined in: packages/identity/src/identity/ecdsa.ts:131
Return the public key.
Returns
Section titled “Returns”Overrides
Section titled “Overrides”sign()
Section titled “sign()”sign(
challenge):Promise<Signature>
Defined in: packages/identity/src/identity/ecdsa.ts:146
Signs a blob of data, with this identity’s private key.
Parameters
Section titled “Parameters”challenge
Section titled “challenge”Uint8Array
challenge to sign with this identity’s secretKey, producing a signature
Returns
Section titled “Returns”Promise<Signature>
signature
Overrides
Section titled “Overrides”transformRequest()
Section titled “transformRequest()”transformRequest(
request):Promise<unknown>
Defined in: packages/agent/lib/esm/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
Section titled “Parameters”request
Section titled “request”internet computer request to transform
Returns
Section titled “Returns”Promise<unknown>
Inherited from
Section titled “Inherited from”fromKeyPair()
Section titled “fromKeyPair()”
staticfromKeyPair(keyPair,subtleCrypto?):Promise<ECDSAKeyIdentity>
Defined in: packages/identity/src/identity/ecdsa.ts:89
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
Section titled “Parameters”keyPair
Section titled “keyPair”a CryptoKeyPair
CryptoKeyPair | { privateKey: CryptoKey; publicKey: CryptoKey; }
subtleCrypto?
Section titled “subtleCrypto?”SubtleCrypto
a SubtleCrypto interface in case one is not available globally
Returns
Section titled “Returns”Promise<ECDSAKeyIdentity>
an ECDSAKeyIdentity
generate()
Section titled “generate()”
staticgenerate(options?):Promise<ECDSAKeyIdentity>
Defined in: packages/identity/src/identity/ecdsa.ts:61
Generates a randomly generated identity for use in calls to the Internet Computer.
Parameters
Section titled “Parameters”options?
Section titled “options?”optional settings
Returns
Section titled “Returns”Promise<ECDSAKeyIdentity>
a ECDSAKeyIdentity