jose/docs/functions/util_generate_secret.generateSecret.md

Function: generateSecret

util/generate_secret.generateSecret

▸ generateSecret(alg, options?): Promise<KeyLike | Uint8Array>

Generates a symmetric secret key for a given JWA algorithm identifier.

Note: Under Web Cryptography API runtime the secret key is generated with extractable set to false by default.

example ESM import

import { generateSecret } from 'jose/util/generate_secret'

example CJS import

const { generateSecret } = require('jose/util/generate_secret')

example Deno import

import { generateSecret } from 'https://deno.land/x/jose@v3.20.1/util/generate_secret.ts'

example Usage

const secret = await generateSecret('HS256')
console.log(secret)

Parameters

Name	Type	Description
alg	string	JWA Algorithm Identifier to be used with the generated secret.
options?	GenerateSecretOptions	Additional options passed down to the secret generation.

Returns

Promise<KeyLike | Uint8Array>