Type Alias CreateZTDFOptions

CreateZTDFOptions: CreateOptions & {
    assertionConfigs?: AssertionConfig[];
    metadata?: Metadata;
    mimeType?: MimeType;
    rootIntegrityAlgorithm?: RootIntegrityAlgorithm;
    segmentIntegrityAlgorithm?: SegmentIntegrityAlgorithm;
    splitPlan?: SplitStep[];
    tdfSpecVersion?: "4.2.2" | "4.3.0";
    windowSize?: number;
    wrappingKeyAlgorithm?: KasPublicKeyAlgorithm;
}

Options specific to the ZTDF container format.

OptionalassertionConfigs?: AssertionConfig[]

Configuration for bound metadata.
Optionalmetadata?: Metadata

Unbound metadata (deprecated).
OptionalmimeType?: MimeType

MIME type of the decrypted content. Used for display.
OptionalrootIntegrityAlgorithm?: RootIntegrityAlgorithm

Algorithm used for the root signature over the aggregate of segment hashes. HS256 only. Defaults to HS256.
OptionalsegmentIntegrityAlgorithm?: SegmentIntegrityAlgorithm

Algorithm used for each segment's integrity value. GMAC reads out the AES-GCM tag the cipher already produced for that segment; HS256 computes an HMAC over the segment ciphertext. Defaults to GMAC.
OptionalsplitPlan?: SplitStep[]

How to split or share the data encryption key across multiple KASes.
OptionaltdfSpecVersion?: "4.2.2" | "4.3.0"

TDF spec version to target.
OptionalwindowSize?: number

The segment size for the content; smaller is slower, but allows faster random access. The current default is 1 MiB (2^20 bytes).
OptionalwrappingKeyAlgorithm?: KasPublicKeyAlgorithm

Preferred algorithm to use for Key Access Objects.