@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

    Properties

    allowedKASEndpoints? assertionVerificationKeys? concurrencyLimit? fulfillableObligationFQNs? ignoreAllowlist? maxConcurrentSegmentBatches? noVerify? platformUrl? segmentBatchSize? source wrappingKeyAlgorithm?

    Properties

    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.

    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.

    source: Source

    The ciphertext source.

    wrappingKeyAlgorithm?: KasPublicKeyAlgorithm

    Type of key to use for wrapping responses.

    Settings

    Member Visibility

    On This Page

    Properties