CryptoKey: algorithm property

Secure contextAvailable in workers

The read-only algorithm property of the CryptoKey interface returns an object describing the algorithm for which this key can be used, and any associated extra parameters.

The object returned depends of the algorithm used to generate the key.

Value

An object matching:

• AesKeyGenParams if the algorithm is any of the AES variants.
• RsaHashedKeyGenParams if the algorithm is any of the RSA variants.
• EcKeyGenParams if the algorithm is any of the EC variants.
• HmacKeyGenParams if the algorithm is HMAC.

For RsaHashedKeyGenParams and HmacKeyGenParams, the hash property is always in the object form (with a property called name), not the string form.

Examples

const rawKey = window.crypto.getRandomValues(new Uint8Array(16));

// Import an AES secret key from an ArrayBuffer containing the raw bytes.
// Takes an ArrayBuffer string containing the bytes, and returns a Promise
// that will resolve to a CryptoKey representing the secret key.
function importSecretKey(rawKey) {
  return window.crypto.subtle.importKey("raw", rawKey, "AES-GCM", true, [
    "encrypt",
    "decrypt",
  ]);
}

importSecretKey(rawKey).then((key) =>
  console.log(
    `This key is to be used with the ${key.algorithm.name} algorithm.`,
  ),
);

Specifications

Browser compatibility