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.
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(encoder.encode('The Fellowship of the Ring'))
.encrypt(publicKey)
console.log(jwe)- encrypt
- setAdditionalAuthenticatedData
- setContentEncryptionKey
- setInitializationVector
- setKeyManagementParameters
- setProtectedHeader
- setSharedUnprotectedHeader
- setUnprotectedHeader
• new FlattenedEncrypt(plaintext): FlattenedEncrypt
| Name | Type | Description |
|---|---|---|
plaintext |
Uint8Array |
Binary representation of the plaintext to encrypt. |
▸ encrypt(key, options?): Promise<FlattenedJWE>
Encrypts and resolves the value of the Flattened JWE object.
| Name | Type | Description |
|---|---|---|
key |
Uint8Array | KeyLike |
Public Key or Secret to encrypt the JWE with. See Algorithm Key Requirements. |
options? |
EncryptOptions |
JWE Encryption options. |
▸ setAdditionalAuthenticatedData(aad): FlattenedEncrypt
Sets the Additional Authenticated Data on the FlattenedEncrypt object.
| Name | Type | Description |
|---|---|---|
aad |
Uint8Array |
Additional Authenticated Data. |
▸ setContentEncryptionKey(cek): FlattenedEncrypt
Sets a content encryption key to use, by default a random suitable one is generated for the JWE enc" (Encryption Algorithm) Header Parameter.
| Name | Type | Description |
|---|---|---|
cek |
Uint8Array |
JWE Content Encryption Key. |
Deprecated
You should not use this method. It is only really intended for test and vector validation purposes.
▸ setInitializationVector(iv): FlattenedEncrypt
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.
| Name | Type | Description |
|---|---|---|
iv |
Uint8Array |
JWE Initialization Vector. |
Deprecated
You should not use this method. It is only really intended for test and vector validation purposes.
▸ setKeyManagementParameters(parameters): FlattenedEncrypt
Sets the JWE Key Management parameters to be used when encrypting. Use of this is method is really only needed for ECDH based algorithms when utilizing the Agreement PartyUInfo or Agreement PartyVInfo parameters. Other parameters will always be randomly generated when needed and missing.
| Name | Type | Description |
|---|---|---|
parameters |
JWEKeyManagementHeaderParameters |
JWE Key Management parameters. |
▸ setProtectedHeader(protectedHeader): FlattenedEncrypt
Sets the JWE Protected Header on the FlattenedEncrypt object.
| Name | Type | Description |
|---|---|---|
protectedHeader |
JWEHeaderParameters |
JWE Protected Header. |
▸ setSharedUnprotectedHeader(sharedUnprotectedHeader): FlattenedEncrypt
Sets the JWE Shared Unprotected Header on the FlattenedEncrypt object.
| Name | Type | Description |
|---|---|---|
sharedUnprotectedHeader |
JWEHeaderParameters |
JWE Shared Unprotected Header. |
▸ setUnprotectedHeader(unprotectedHeader): FlattenedEncrypt
Sets the JWE Per-Recipient Unprotected Header on the FlattenedEncrypt object.
| Name | Type | Description |
|---|---|---|
unprotectedHeader |
JWEHeaderParameters |
JWE Per-Recipient Unprotected Header. |