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.
Note: This feature is available in Web Workers.
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.typeRead only-
The type of key the object represents. It may take one of the following values:
"secret","private"or"public". CryptoKey.extractableRead only-
A boolean value indicating whether or not the key may be extracted using
SubtleCrypto.exportKey()orSubtleCrypto.wrapKey(). CryptoKey.algorithmRead only-
An object describing the algorithm for which this key can be used and any associated extra parameters.
CryptoKey.usagesRead only-
An
Arrayof 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 Level 2 # cryptokey-interface |
Browser compatibility
| desktop | mobile | server | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
CryptoKey
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
algorithm
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
extractable
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
type
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
usages
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- Partial support
- Partial support
- Has more compatibility info.