Skip to main content
Module

x/jose/index.ts>FlattenedEncrypt

JWA, JWS, JWE, JWT, JWK, JWKS for Node.js, Browser, Cloudflare Workers, Deno, Bun, and other Web-interoperable runtimes.
panva/jose
Extremely Popular
Latest
class FlattenedEncrypt
import { FlattenedEncrypt } from "https://deno.land/x/jose@v5.3.0/index.ts";

The FlattenedEncrypt class is used to build and encrypt Flattened JWE objects.

Constructors

new
FlattenedEncrypt(plaintext: Uint8Array)

Properties

private
_aad: Uint8Array | undefined
private
_cek: Uint8Array | undefined
private
_iv: Uint8Array | undefined
private
_keyManagementParameters: JWEKeyManagementHeaderParameters
private
_plaintext: Uint8Array
private
_protectedHeader: JWEHeaderParameters | undefined
private
_sharedUnprotectedHeader: JWEHeaderParameters | undefined
private
_unprotectedHeader: JWEHeaderParameters | undefined

Methods

encrypt(key: KeyLike | Uint8Array, options?: EncryptOptions): Promise<FlattenedJWE>

Encrypts and resolves the value of the Flattened JWE object.

setAdditionalAuthenticatedData(aad: Uint8Array)

Sets the Additional Authenticated Data on the FlattenedEncrypt object.

deprecated
setContentEncryptionKey(cek: Uint8Array)

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

deprecated
setInitializationVector(iv: Uint8Array)

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.

setKeyManagementParameters(parameters: JWEKeyManagementHeaderParameters)

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.

setProtectedHeader(protectedHeader: JWEHeaderParameters)

Sets the JWE Protected Header on the FlattenedEncrypt object.

setSharedUnprotectedHeader(sharedUnprotectedHeader: JWEHeaderParameters)

Sets the JWE Shared Unprotected Header on the FlattenedEncrypt object.

setUnprotectedHeader(unprotectedHeader: JWEHeaderParameters)

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