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)- encrypt
- setContentEncryptionKey
- setInitializationVector
- setKeyManagementParameters
- setProtectedHeader
• new CompactEncrypt(plaintext)
| Name | Type | Description |
|---|---|---|
plaintext |
Uint8Array |
Binary representation of the plaintext to encrypt. |
▸ encrypt(key, options?): Promise<string>
Encrypts and resolves the value of the Compact JWE string.
| Name | Type | Description |
|---|---|---|
key |
Uint8Array | KeyLike |
Public Key or Secret to encrypt the JWE with. |
options? |
EncryptOptions |
JWE Encryption options. |
Promise<string>
▸ 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.
deprecated You should not use this method. It is only really intended for test and vector
validation purposes.
| Name | Type | Description |
|---|---|---|
cek |
Uint8Array |
JWE Content Encryption Key. |
▸ 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.
deprecated You should not use this method. It is only really intended for test and vector
validation purposes.
| Name | Type | Description |
|---|---|---|
iv |
Uint8Array |
JWE Initialization Vector. |
▸ 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.
| Name | Type | Description |
|---|---|---|
parameters |
JWEKeyManagementHeaderParameters |
JWE Key Management parameters. |
▸ setProtectedHeader(protectedHeader): CompactEncrypt
Sets the JWE Protected Header on the CompactEncrypt object.
| Name | Type | Description |
|---|---|---|
protectedHeader |
CompactJWEHeaderParameters |
JWE Protected Header object. |