@opentdf/sdk
    Preparing search index...

    Type Alias ReadOptions

    Settings for decrypting any variety of TDF file.

    type ReadOptions = {
        allowedKASEndpoints?: string[];
        assertionVerificationKeys?: AssertionVerificationKeys;
        concurrencyLimit?: number;
        fulfillableObligationFQNs?: string[];
        ignoreAllowlist?: boolean;
        maxConcurrentSegmentBatches?: number;
        noVerify?: boolean;
        platformUrl?: string;
        segmentBatchSize?: number;
        source: Source;
        wrappingKeyAlgorithm?: KasPublicKeyAlgorithm;
    }
    Index
    allowedKASEndpoints? assertionVerificationKeys? concurrencyLimit? fulfillableObligationFQNs? ignoreAllowlist? maxConcurrentSegmentBatches? noVerify? platformUrl? segmentBatchSize? source wrappingKeyAlgorithm?
    allowedKASEndpoints?: string[]

    List of KASes that may be contacted for a rewrap.

    assertionVerificationKeys?: AssertionVerificationKeys

    Public (or shared) keys for verifying assertions.

    concurrencyLimit?: number

    If set, prevents more than this number of concurrent requests to the KAS.

    fulfillableObligationFQNs?: string[]

    Optionally override client fulfillableObligationFQNs.

    ignoreAllowlist?: boolean

    Optionally disable checking the allowlist.

    maxConcurrentSegmentBatches?: number

    Maximum number of segment batches that may be fetched concurrently. Adjust together with segmentBatchSize for expected throughput.

    Also derived from the TDF's segment size by default. Setting one of these two does not rescale the other -- the unset one keeps its derived value.

    noVerify?: boolean

    Optionally disable assertion verification.

    platformUrl?: string

    The platform URL.

    segmentBatchSize?: number

    Maximum number of payload segments to fetch and decrypt per batch. Adjust together with maxConcurrentSegmentBatches for expected throughput.

    Defaults to a value derived from the TDF's own segment size, so that segmentBatchSize * maxConcurrentSegmentBatches segments stay inside a fixed byte budget (see derivePrefetchWindow). Raising this raises peak memory in proportion.

    source: Source

    The ciphertext source.

    wrappingKeyAlgorithm?: KasPublicKeyAlgorithm

    Type of key to use for wrapping responses.

    Settings
    Member Visibility

    On This Page
    Properties