The importKey() imports a key from an external, portable format, and gives you a CryptoKey object that can be used with the Web Crypto API.
Usage
Parameters
Name | Type | Description |
---|---|---|
format | string | Defines the data format of the key to import. Currently supported formats: raw. |
keyData | ArrayBuffer, TypedArray or DataView | the data to import the key from. |
algorithm | a string or object with a single name string property | The algorithm to use to import the key. Currently supported algorithms: AES-CBC, AES-GCM, AES-CTR, and HMAC. |
extractable | boolean | Indicates whether it will be possible to export the key using exportKey. |
keyUsages | Array<string> | An array of strings describing what operations can be performed with the key. Currently supported usages include encrypt, decrypt, sign, and verify. |
Return Value
A Promise that resolves with the imported key as a CryptoKey object.
Throws
Type | Description |
---|---|
SyntaxError | Raised when the keyUsages parameter is empty but the key is of type secret or private. |
TypeError | Raised when trying to use an invalid format, or if the keyData is not suited for that format. |
Example
example-webcrypto-importKey.js