Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/jose/index.ts>CompactEncrypt

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 CompactEncrypt
import { CompactEncrypt } from "https://deno.land/x/jose@v5.9.6/index.ts";

The CompactEncrypt class is used to build and encrypt Compact JWE strings.

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

Constructors

new
CompactEncrypt(plaintext: Uint8Array)

Properties

private
_flattened: FlattenedEncrypt

Methods

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

Encrypts and resolves the value of the Compact JWE string.

deprecated
setContentEncryptionKey(cek: Uint8Array): this

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): 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.

setKeyManagementParameters(parameters: JWEKeyManagementHeaderParameters): this

Sets the JWE Key Management parameters to be used when encrypting the Content Encryption Key. You do not need to invoke this method, it is only really intended for test and vector validation purposes.

setProtectedHeader(protectedHeader: CompactJWEHeaderParameters): this

Sets the JWE Protected Header on the CompactEncrypt object.