Skip to content

DecodedProtectedHeader

Defined in: packages/filecoin-encryption-envelope/src/cose/headers.ts:108

A decoded protected header with its original encoded bytes. Use bytes verbatim when building the Enc_structure.

alg: Alg

Defined in: packages/filecoin-encryption-envelope/src/cose/headers.ts:92

ProtectedHeaderFields.alg


optional appMetadata?: Record<string, CborValue>

Defined in: packages/filecoin-encryption-envelope/src/cose/headers.ts:101

Opaque authenticated metadata. This package carries but does not interpret it.

ProtectedHeaderFields.appMetadata


bytes: Uint8Array

Defined in: packages/filecoin-encryption-envelope/src/cose/headers.ts:109


optional chunkSize?: number

Defined in: packages/filecoin-encryption-envelope/src/cose/headers.ts:97

Plaintext bytes per chunk. Required only for the chunked scheme.

ProtectedHeaderFields.chunkSize


optional contentType?: string | number

Defined in: packages/filecoin-encryption-envelope/src/cose/headers.ts:95

ProtectedHeaderFields.contentType


iv: Uint8Array

Defined in: packages/filecoin-encryption-envelope/src/cose/headers.ts:94

12-byte IV for AES-256-GCM or 7-byte base nonce for the chunked scheme.

ProtectedHeaderFields.iv


optional plaintextLength?: number

Defined in: packages/filecoin-encryption-envelope/src/cose/headers.ts:99

Exact plaintext length, when known before encoding. Chunked scheme only.

ProtectedHeaderFields.plaintextLength