SubtleCrypto.encrypt()

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

Syntax

var result = crypto<code>.encrypt(algo, key, cleartext)</code>;

Parameters

• algo is an object defining the encryption function to use or a DOMString, the latter being a shorthand for {"name": algo}. Supported values are:
  • {"name": "AES-CBC", iv} where iv is an ArrayBuffer or an ArrayBufferView with 16 random bytes (these should be generated by RandomSource.getRandomValues()).
  • {"name": "AES-CTR", counter, length}
  • {"name": "AES-GCM", iv, additionalData, tagLength} (additionalData and tagLength are optional)
  • {"name": "RSA-OAEP", label} (label is optional)
• key is a CryptoKey containing the key to be used for signing.
• cleartext is a ArrayBuffer or an ArrayBufferView containing the data to be encrypted, the cleartext.

Return value

• result is a Promise that returns the ciphertext generated by the encryption of the cleartext as an ArrayBuffer.

Exceptions

The promise is rejected when the following exception is encountered:

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

Specifications

Browser compatibility

See also

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