CryptoKey: algorithm property
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
Note: This feature is available in Web 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.
Examples
js
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",
]);
}
const key = importSecretKey(rawKey);
console.log(`This key is to be used with the ${key.algorithm} algorithm.`);
Specifications
Specification |
---|
Web Cryptography API # dom-cryptokey-algorithm |
Browser compatibility
BCD tables only load in the browser