Menu

Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentationbreadcrumb arrow Grafana k6breadcrumb arrow JavaScript APIbreadcrumb arrow k6/cryptobreadcrumb arrow sha256( input, outputEncoding )
Open source

sha256( input, outputEncoding )

Note

A module with a better and standard API exists.

The new k6/experimental/webcrypto API partially implements the WebCryptoAPI, supporting more features than k6/crypto.

Use sha256 to hash input data.

ParameterTypeDescription
inputstring / ArrayBufferThe input string or ArrayBuffer object to hash.
outputEncodingstringDescribes the type of encoding to use for the hash value. Can be “base64”, “base64url”, “base64rawurl”, “hex” or “binary”.

Returns

TypeDescription
string / ArrayThe hash digest as string (for “base64”, “base64url”, “base64rawurl”, “hex” outputEncoding) or raw array of integers (for “binary” outputEncoding).

Example

JavaScript 
import crypto from 'k6/crypto';

export default function () {
  let hash = crypto.sha256('hello world!', 'hex');
  console.log(hash);
  const binArray = [104, 101, 108, 108, 111, 32, 119, 111, 114, 108, 100, 33];
  hash = crypto.sha256(new Uint8Array(binArray).buffer, 'hex');
  console.log(hash);
}

The above script should result in the following being printed during execution:

bash 
INFO[0000] 7509e5bda0c762d2bac7f90d758b5b2263fa01ccbc542ab5e3df163be08e6ca9
INFO[0000] 7509e5bda0c762d2bac7f90d758b5b2263fa01ccbc542ab5e3df163be08e6ca9