CryptoKey

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.

The CryptoKey interface of the Web Crypto API represents a cryptographic key obtained from one of the SubtleCrypto methods generateKey(), deriveKey(), importKey(), or unwrapKey().

For security reasons, the CryptoKey interface can only be used in a secure context.

Instance properties

CryptoKey.type Read only

The type of key the object represents. It may take one of the following values: "secret", "private" or "public".

CryptoKey.extractable Read only

A boolean value indicating whether or not the key may be extracted using SubtleCrypto.exportKey() or SubtleCrypto.wrapKey().

CryptoKey.algorithm Read only

An object describing the algorithm for which this key can be used and any associated extra parameters.

CryptoKey.usages Read only

An Array of strings, indicating what can be done with the key. Possible values for array elements are "encrypt", "decrypt", "sign", "verify", "deriveKey", "deriveBits", "wrapKey", and "unwrapKey".

Examples

The examples for SubtleCrypto methods often use CryptoKey objects. For example:

Specifications

Specification
Web Cryptography API
# cryptokey-interface

Browser compatibility

BCD tables only load in the browser

See also