SymmetricKey

Represents a symmetric key used for cryptographic operations. Symmetric keys are typically generated using a SymmetricKeyBuilder. This class also provides methods to export and check the properties of symmetric keys.

​

Extends

• BaseCryptoClass

​

Constructors

​

new SymmetricKey()

new SymmetricKey(): SymmetricKey

​

Returns

SymmetricKey

​

Methods

​

exportRaw()

exportRaw(): Promise<ArrayBuffer>

Export the symmetric key as raw bytes. This method should only be called on keys that are marked as exportable.

​

Throws

• AccessDeniedError If the key is not exportable.

​

Returns

Promise<ArrayBuffer> Promise<ArrayBuffer> A promise that resolves to the raw key bytes.

---

​

hasPurpose()

hasPurpose(purpose: KeyPurpose): boolean

Check if a particular purpose is enabled for this key.

​

Parameters

purpose

KeyPurpose A key purpose to check.

​

Throws

• InvalidArgumentError If the argument is not a valid purpose.

​

Returns

boolean boolean true if the purpose is enabled for this key, false otherwise.