DocsReferenceGuidesBlog
Discord logo
Discord
GitHub logo
MgenerateKey
Bun

method

crypto.webcrypto.SubtleCrypto.generateKey

algorithm: EcKeyGenParams | RsaHashedKeyGenParams,
extractable: boolean,
keyUsages: readonly KeyUsage[]
): Promise<CryptoKeyPair>;

Using the method and parameters provided in algorithm, subtle.generateKey() attempts to generate new keying material. Depending the method used, the method may generate either a single <CryptoKey> or a <CryptoKeyPair>.

The <CryptoKeyPair> (public and private key) generating algorithms supported include:

  • 'RSASSA-PKCS1-v1_5'

  • 'RSA-PSS'

  • 'RSA-OAEP'

  • 'ECDSA'

  • 'Ed25519'

  • 'Ed448'

  • 'ECDH'

  • 'X25519'

  • 'X448' The <CryptoKey> (secret key) generating algorithms supported include:

  • 'HMAC'

  • 'AES-CTR'

  • 'AES-CBC'

  • 'AES-GCM'

  • 'AES-KW'

@param keyUsages

See Key usages.

algorithm: AesKeyGenParams | HmacKeyGenParams | Pbkdf2Params,
extractable: boolean,
keyUsages: readonly KeyUsage[]
): Promise<CryptoKey>;
algorithm: AlgorithmIdentifier,
extractable: boolean,
keyUsages: KeyUsage[]
): Promise<CryptoKey | CryptoKeyPair>;