Skip to content

Latest commit

 

History

History
141 lines (88 loc) · 3.87 KB

jwe_compact_encrypt.CompactEncrypt.md

File metadata and controls

141 lines (88 loc) · 3.87 KB

Class: CompactEncrypt

The CompactEncrypt class is a utility for creating Compact JWE strings.

example Usage

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

console.log(jwe)

Table of contents

Constructors

Methods

Constructors

constructor

new CompactEncrypt(plaintext)

Parameters

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

Methods

encrypt

encrypt(key, options?): Promise<string>

Encrypts and resolves the value of the Compact JWE string.

Parameters

Name Type Description
key KeyLike | Uint8Array Public Key or Secret to encrypt the JWE with.
options? EncryptOptions JWE Encryption options.

Returns

Promise<string>


setContentEncryptionKey

setContentEncryptionKey(cek): CompactEncrypt

Sets a content encryption key to use, by default a random suitable one is generated for the JWE enc" (Encryption Algorithm) Header Parameter. You do not need to invoke this method, it is only really intended for test and vector validation purposes.

Parameters

Name Type Description
cek Uint8Array JWE Content Encryption Key.

Returns

CompactEncrypt


setInitializationVector

setInitializationVector(iv): CompactEncrypt

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. You do not need to invoke this method, it is only really intended for test and vector validation purposes.

Parameters

Name Type Description
iv Uint8Array JWE Initialization Vector.

Returns

CompactEncrypt


setKeyManagementParameters

setKeyManagementParameters(parameters): CompactEncrypt

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.

Parameters

Name Type Description
parameters JWEKeyManagementHeaderParameters JWE Key Management parameters.

Returns

CompactEncrypt


setProtectedHeader

setProtectedHeader(protectedHeader): CompactEncrypt

Sets the JWE Protected Header on the CompactEncrypt object.

Parameters

Name Type Description
protectedHeader CompactJWEHeaderParameters JWE Protected Header object.

Returns

CompactEncrypt