SubtleCrypto.sign()

The SubtleCrypto.sign() method returns a Promise containing the signature corresponding to the text, algorithm and key given as parameters.

Syntax

var signature = crypto.sign(algo, key, text2sign);

Parameters

• algo is a DOMString defining the signature function to use. Supported values are: HMAC, RSASSA-PKCS1-v1_5, and ECDSA.
• key is a CryptoKey containing the private key to be used for signing.
• text2sign is a ArrayBuffer or an ArrayBufferView containing the data to be signed.

Return value

• signature is a Promise that returns the signature on success.

Exceptions

The promise is rejected when the following exception is encountered:

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

Specifications

Browser compatibility

See also

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