Skip to content

DecodedProtectedHeader

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

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

  • ProtectedHeaderFields

alg: Alg

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

ProtectedHeaderFields.alg


optional appMetadata?: AppMetadata

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

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:113


optional chunkSize?: number

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

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:99

ProtectedHeaderFields.contentType


iv: Uint8Array

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

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:103

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

ProtectedHeaderFields.plaintextLength