jose/docs/jwe/flattened/encrypt/classes/FlattenedEncrypt.md

Class: FlattenedEncrypt

💗 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 FlattenedEncrypt class is used to build and encrypt Flattened 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/flattened/encrypt'.

Example

const jwe = await new jose.FlattenedEncrypt(
  new TextEncoder().encode('It’s a dangerous business, Frodo, going out your door.'),
)
  .setProtectedHeader({ alg: 'RSA-OAEP-256', enc: 'A256GCM' })
  .setAdditionalAuthenticatedData(new TextEncoder().encode('The Fellowship of the Ring'))
  .encrypt(publicKey)

console.log(jwe)

Constructors

Constructor

▸ new FlattenedEncrypt(plaintext): FlattenedEncrypt

FlattenedEncrypt constructor

Parameters

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

Returns

FlattenedEncrypt

Methods

encrypt()

▸ encrypt(key, options?): Promise<FlattenedJWE>

Encrypts and resolves the value of the Flattened JWE object.

Parameters

Parameter	Type	Description
key	KeyInput	Public Key or Secret to encrypt the JWE with. See Algorithm Key Requirements.
options?	EncryptOptions	JWE Encryption options.

Returns

Promise<FlattenedJWE>

---

setAdditionalAuthenticatedData()

▸ setAdditionalAuthenticatedData(aad): this

Sets the Additional Authenticated Data on the FlattenedEncrypt object.

Parameters

Parameter	Type	Description
aad	Uint8Array	Additional Authenticated Data.

Returns

this

---

setContentEncryptionKey()

▸ setContentEncryptionKey(cek): this

Sets a content encryption key to use, by default a random suitable one is generated for the JWE "enc" (Encryption Algorithm) Header Parameter.

Parameters

Parameter	Type	Description
cek	Uint8Array	JWE Content Encryption Key.

Returns

this

Deprecated

You should not use this method. It is only really intended for test and vector validation purposes.

---

setInitializationVector()

▸ setInitializationVector(iv): this

Sets the JWE Initialization Vector to use for content encryption, by default a random suitable one is generated for the JWE "enc" (Encryption Algorithm) Header Parameter.

Parameters

Parameter	Type	Description
iv	Uint8Array	JWE Initialization Vector.

Returns

this

Deprecated

You should not use this method. It is only really intended for test and vector validation purposes.

---

setKeyManagementParameters()

▸ setKeyManagementParameters(parameters): this

Sets the JWE Key Management parameters to be used when encrypting. For ECDH based algorithms, use this method to set the "apu" (Agreement PartyUInfo) or "apv" (Agreement PartyVInfo) parameters.

Parameters

Parameter	Type	Description
parameters	JWEKeyManagementHeaderParameters	JWE Key Management parameters.

Returns

this

---

setProtectedHeader()

▸ setProtectedHeader(protectedHeader): this

Sets the JWE Protected Header on the FlattenedEncrypt object.

Parameters

Parameter	Type	Description
protectedHeader	JWEHeaderParameters	JWE Protected Header.

Returns

this

---

setSharedUnprotectedHeader()

▸ setSharedUnprotectedHeader(sharedUnprotectedHeader): this

Sets the JWE Shared Unprotected Header on the FlattenedEncrypt object.

Parameters

Parameter	Type	Description
sharedUnprotectedHeader	JWEHeaderParameters	JWE Shared Unprotected Header.

Returns

this

---

setUnprotectedHeader()

▸ setUnprotectedHeader(unprotectedHeader): this

Sets the JWE Per-Recipient Unprotected Header on the FlattenedEncrypt object.

Parameters

Parameter	Type	Description
unprotectedHeader	JWEHeaderParameters	JWE Per-Recipient Unprotected Header.

Returns

this