HmacKeyGenParams

You’re reading the English version of this content since no translation exists yet for this locale. Help us translate this article!

The HmacKeyGenParams dictionary of the Web Crypto API represents the object that should be passed as the algorithm parameter into SubtleCrypto.generateKey(), when generating a key for the HMAC algorithm.

Properties

name
A DOMString. This should be set to HMAC.
hash

A DOMString representing the name of the digest function to use. You can pass any of SHA-1, SHA-256, SHA-384, or SHA-512 here.

length Optional

A Number — the length in bits of the key. If this is omitted the length of the key is equal to the length of the digest generated by the digest function you have chosen. Unless you have a good reason to use a different length, omit this property and use the default.

Examples

See the examples for SubtleCrypto.generateKey().

Specifications

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

Browser compatibility

Browsers that support the "HMAC" algorithm for the SubtleCrypto.generateKey() method will support this type.

See Also