Menu
Documentationbreadcrumb arrow Grafana k6breadcrumb arrow JavaScript APIbreadcrumb arrow k6/experimentalbreadcrumb arrow webcryptobreadcrumb arrow HmacKeyGenParams
Open source

HmacKeyGenParams

Caution

The experimental module k6/experimental/webcrypto has graduated, and its functionality is now available globally through the crypto object. The k6/experimental/webcrypto is deprecated and will be removed in the near future.

To migrate your scripts, remove the k6/experimental/webcrypto imports and use the crypto object instead.

The HmacKeyGenParams object represents the object that should be passed as the algorithm parameter into the generateKey operation when generating an HMAC key.

Properties

PropertyTypeDescription
namestringThis should be set to HMAC.
hashstringThe name of the digest function to use. Possible values are SHA-1, SHA-256, SHA-384 and SHA-512.
length (optional)numberThe length of the key in bits. If this is omitted, the length of the key is equal to the block size of the hash function you have chosen. We recommend to leave this parameter empty, unless you have a good reason to use something different.

Example

JavaScript 
import { crypto } from 'k6/experimental/webcrypto';

export default async function () {
  const key = await crypto.subtle.generateKey(
    {
      name: 'HMAC',
      hash: { name: 'SHA-512' },
      length: 256,
    },
    true,
    ['sign', 'verify']
  );
}