FlattenedEncrypt | /jwe/flattened/encrypt.ts | jose@v4.13.0

class FlattenedEncrypt

import { FlattenedEncrypt } from "https://deno.land/x/jose@v4.13.0/jwe/flattened/encrypt.ts";

The FlattenedEncrypt class is a utility for creating Flattened JWE objects.

Examples

Usage

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)

Constructors

new

FlattenedEncrypt(plaintext: Uint8Array)

Properties

private

_aad: Uint8Array

private

_cek: Uint8Array

private

_iv: Uint8Array

private

_keyManagementParameters: JWEKeyManagementHeaderParameters

private

_plaintext: Uint8Array

private

_protectedHeader: JWEHeaderParameters

private

_sharedUnprotectedHeader: JWEHeaderParameters

private

_unprotectedHeader: JWEHeaderParameters

Methods

encrypt(key: KeyLike | Uint8Array, options?: EncryptOptions)

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.