Class: GeneralEncrypt

💗 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.

Builds and encrypts 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

Creates a General JWE encryptor.

Parameters

Returns

GeneralEncrypt

Methods

addRecipient()

▸ addRecipient(key, options?): Recipient

Adds a recipient and returns its configuration.

Parameters

Returns

Recipient

encrypt()

▸ encrypt(): Promise<GeneralJWE>

Encrypts the plaintext as a General JWE.

Returns

Promise<GeneralJWE>

setAdditionalAuthenticatedData()

▸ setAdditionalAuthenticatedData(aad): this

Sets additional data to authenticate without encrypting it.

Parameters

Returns

this

setProtectedHeader()

▸ setProtectedHeader(protectedHeader): this

Sets the JWE Protected Header. May only be called once.

Parameters

Returns

this

setSharedUnprotectedHeader()

▸ setSharedUnprotectedHeader(sharedUnprotectedHeader): this

Sets the JWE Shared Unprotected Header. May only be called once.

Parameters

Returns

this