4.9 KiB
Class: CompactEncrypt
jwe/compact/encrypt.CompactEncrypt
The CompactEncrypt class is a utility for creating Compact JWE strings.
example ESM import
import { CompactEncrypt } from 'jose/jwe/compact/encrypt'
example CJS import
const { CompactEncrypt } = require('jose/jwe/compact/encrypt')
example Deno import
import { CompactEncrypt } from 'https://deno.land/x/jose@v3.15.5/jwe/compact/encrypt.ts'
example Usage
const encoder = new TextEncoder()
const jwe = await new CompactEncrypt(encoder.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
- encrypt
- setContentEncryptionKey
- setInitializationVector
- setKeyManagementParameters
- setProtectedHeader
Constructors
constructor
• new CompactEncrypt(plaintext)
Parameters
| Name | Type | Description |
|---|---|---|
plaintext |
Uint8Array |
Binary representation of the plaintext to encrypt. |
Defined in
Methods
encrypt
▸ encrypt(key, options?): Promise<string>
Encrypts and resolves the value of the Compact JWE string.
Parameters
| Name | Type | Description |
|---|---|---|
key |
KeyLike |
Public Key or Secret to encrypt the JWE with. |
options? |
EncryptOptions |
JWE Encryption options. |
Returns
Promise<string>
Defined in
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
Defined in
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
Defined in
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
Defined in
setProtectedHeader
▸ setProtectedHeader(protectedHeader): CompactEncrypt
Sets the JWE Protected Header on the CompactEncrypt object.
Parameters
| Name | Type | Description |
|---|---|---|
protectedHeader |
JWEHeaderParameters |
JWE Protected Header object. |