Class: SymEncryptedAEADProtected

packet.SymEncryptedAEADProtected()

new SymEncryptedAEADProtected()

Implementation of the Symmetrically Encrypted Authenticated Encryption with Additional Data (AEAD) Protected Data Packet

https://tools.ietf.org/html/draft-ford-openpgp-format-00#section-2.1: AEAD Protected Data Packet

Source:

Methods

(async) crypt(fn, key, data, streaming) → {Uint8Array|ReadableStream.<Uint8Array>}

En/decrypt the payload.

Parameters:
Name Type Description
fn encrypt | decrypt

Whether to encrypt or decrypt

key Uint8Array

The session key used to en/decrypt the payload

data Uint8Array | ReadableStream.<Uint8Array>

The data to en/decrypt

streaming Boolean

Whether the top-level function will return a stream

Source:
Returns:
Type
Uint8Array | ReadableStream.<Uint8Array>

(async) decrypt(sessionKeyAlgorithm, key, streaming) → {Boolean}

Decrypt the encrypted payload.

Parameters:
Name Type Description
sessionKeyAlgorithm String

The session key's cipher algorithm e.g. 'aes128'

key Uint8Array

The session key used to encrypt the payload

streaming Boolean

Whether the top-level function will return a stream

Source:
Returns:
Type
Boolean

(async) encrypt(sessionKeyAlgorithm, key, streaming)

Encrypt the packet list payload.

Parameters:
Name Type Description
sessionKeyAlgorithm String

The session key's cipher algorithm e.g. 'aes128'

key Uint8Array

The session key used to encrypt the payload

streaming Boolean

Whether the top-level function will return a stream

Source:

read(bytes)

Parse an encrypted payload of bytes in the order: version, IV, ciphertext (see specification)

Parameters:
Name Type Description
bytes Uint8Array | ReadableStream.<Uint8Array>
Source:

write() → {Uint8Array|ReadableStream.<Uint8Array>}

Write the encrypted payload of bytes in the order: version, IV, ciphertext (see specification)

Source:
Returns:

The encrypted payload

Type
Uint8Array | ReadableStream.<Uint8Array>