The SubtleCrypto interface represents a set of cryptographic primitives. It is available via the Crypto.subtle properties available in a window context (via Window.crypto).

Per the spec: "Developers making use of the SubtleCrypto interface are expected to be aware of the security concerns associated with both the design and implementation of the various algorithms provided. The raw algorithms are provided in order to allow developers maximum flexibility in implementing a variety of protocols and applications, each of which may represent the composition and security parameters in a unique manner that necessitate the use of the raw algorithms."

Properties

This interface neither inherits, nor implements, any property.

Methods

This interface doesn't inherit any method.

SubtleCrypto.encrypt()
Returns a Promise of the encrypted data corresponding to the clear text, algorithm and key given as parameters.
SubtleCrypto.decrypt()
Returns a Promise of the clear data corresponding to the encrypted text, algorithm and key given as parameters.
SubtleCrypto.sign()
Returns a Promise of the signature corresponding to the text, algorithm and key given as parameters.
SubtleCrypto.verify()
Returns a Promise of a Boolean value indicating if the signature given as parameter matches the text, algorithm and key also given as parameters.
SubtleCrypto.digest()
Returns a Promise of a digest generated from the algorithm and text given as parameters.
SubtleCrypto.generateKey()
Returns a Promise of a newly generated CryptoKey, for symmetrical algorithms, or a CryptoKeyPair, containing two newly generated keys, for asymmetrical algorithm, that matches the algorithm, the usages and the extractability given as parameters.
SubtleCrypto.deriveKey()
Returns a Promise of a newly generated CryptoKey derived from a master key and a specific algorithm given as parameters.
SubtleCrypto.deriveBits()
Returns a Promise of a newly generated buffer of pseudo-random bits derived from a master key and a specific algorithm given as parameters.
SubtleCrypto.importKey()
Returns a Promise of a CryptoKey corresponding to the format, the algorithm, the raw key data, the usages and the extractability given as parameters.
SubtleCrypto.exportKey()
Returns a Promise of a buffer containing the key in the format requested.
SubtleCrypto.wrapKey()
Returns a Promise of a wrapped symmetric key for usage (transfer, storage) in insecure environments. The wrapped buffer returned is in the format given in parameters, and contains the key wrapped by the given wrapping key with the given algorithm.
SubtleCrypto.unwrapKey()
Returns a Promise of a CryptoKey corresponding to the wrapped key given in parameter.

Specifications

Specification Status Comment
Web Cryptography API
The definition of 'SubtleCrypto' in that specification.
Recommendation Initial definition.

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support3712

34

32 — 341

1124

10.1

7 WebKit

encrypt3712

34

32 — 341

112247
decrypt3712

34

32 — 341

112247
sign3712

34

32 — 341

112247
verify3712

34

32 — 341

112247
digest3712

34

32 — 341

112247
generateKey3712

34

32 — 341

113247
deriveKey3712

34

32 — 341

No247
deriveBits3712

34

32 — 341

No247
importKey3712

34

32 — 341

113247
exportKey3712

34

32 — 341

113247
wrapKey3712

34

32 — 341

113247
unwrapKey3712

34

32 — 341

113247
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support373712

34

32 — 341

24

10.1

7 WebKit

6.0
encrypt373712

34

32 — 341

2476.0
decrypt373712

34

32 — 341

2476.0
sign373712

34

32 — 341

2476.0
verify373712

34

32 — 341

2476.0
digest373712

34

32 — 341

2476.0
generateKey373712

34

32 — 341

2476.0
deriveKey373712

34

32 — 341

2476.0
deriveBits373712

34

32 — 341

2476.0
importKey373712

34

32 — 341

2476.0
exportKey373712

34

32 — 341

2476.0
wrapKey373712

34

32 — 341

2476.0
unwrapKey ?3712

34

32 — 341

2476.0

1. From version 32 until version 34 (exclusive): this feature is behind the dom.webcrypto.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.

2. Returns CryptoOperation instead of Promise

3. Returns KeyOperation instead of Promise

See also

Document Tags and Contributors

Last updated by: ExE-Boss,