Class: GeneralEncrypt

July 29, 2026 · View on GitHub

💗 Help the project

Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by becoming a sponsor.

The GeneralEncrypt class is used to build and encrypt General JWE objects.

This class is exported (as a named export) from the main 'jose' module entry point as well as from its subpath export 'jose/jwe/general/encrypt'.

Example

const jwe = await new jose.GeneralEncrypt(
  new TextEncoder().encode('It’s a dangerous business, Frodo, going out your door.'),
)
  .setProtectedHeader({ enc: 'A256GCM' })
  .addRecipient(ecPublicKey)
  .setUnprotectedHeader({ alg: 'ECDH-ES+A256KW' })
  .addRecipient(rsaPublicKey)
  .setUnprotectedHeader({ alg: 'RSA-OAEP-384' })
  .encrypt()

console.log(jwe)

Constructors

Constructor

▸ new GeneralEncrypt(plaintext): GeneralEncrypt

GeneralEncrypt constructor

Parameters

Parameter	Type	Description
`plaintext`	`Uint8Array`	Binary representation of the plaintext to encrypt.

Returns

GeneralEncrypt

Methods

addRecipient()

▸ addRecipient(key, options?): Recipient

Adds an additional recipient for the General JWE object.

Parameters

Parameter	Type	Description
`key`	`KeyInput`	Public Key or Secret to encrypt the Content Encryption Key for the recipient with. See Algorithm Key Requirements.
`options?`	`CritOption`	JWE Encryption options.