SubtleCrypto.decrypt

The SubtleCrypto.decrypt() method returns a Promise of the cleartext corresponding to the ciphertext, algorithm and key given as parameters.

Syntax

var result = crypto.decrypt(algo, key, ciphertext);

Parameters

• algo is a DOMString defining the decryption function to use. Supported values are: AES-CBC, AES-CTR, AES-GCM, and RSA-OAEP.
• key is a CryptoKey containing the key to be used for decryption.
• ciphertext is a ArrayBuffer or an ArrayBufferView containing the data to be decrypted, the ciphertext.

Return value

• result is a Promise that returns the cleartext generated by the decryption of the ciphertext.

Exceptions

The promise is rejected when the following exception is encountered:

• InvalidAccessError when the encryption key is not a key for the requested decryption algorithm or when trying to use an algorithm that is either unknown or isn't suitable for decryption.

Specifications

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

Browser compatibility

See also

• Crypto and Crypto.subtle.
• SubtleCrypto, the interface it belongs to.