@filoz/filecoin-encryption-envelope

Filecoin Encryption Envelope (FIP-1253) - Main Entry Point

Example

import * as fee from '@filoz/filecoin-encryption-envelope'

source.pipeThrough(fee.encrypt({ cek }))  // chunked stream, the default
fee.aesGcm.encrypt(plaintext, { cek })     // whole-object, opt-in
fee.constants.ALG_A256KW

Namespaces

Namespace	Description
aesGcm	-
constants	-
cose	COSE decode-only inspection surface (FIP-1253): read an untrusted envelope into its typed protected header, unprotected header, and recipient list. See docs/tech-spec.md, “Wire profile” and “CDDL”.
errors	-
recipients	-

Interfaces

Interface	Description
ChunkedEncryptOptions	Options for one chunked AES-256-GCM STREAM encryption using a direct CEK.

Type Aliases

Type Alias	Description
AppMetadata	Opaque, string-keyed application metadata. Carried but never interpreted.
CborValue	CBOR values supported by this profile.

Functions

Function	Description
encrypt	Encrypt a plaintext stream using scheme 2 (chunked AES-256-GCM STREAM) and a direct CEK.