Class TDF3Client

constructor

• new TDF3Client(config): TDF3Client

• An abstraction for protecting and accessing data using TDF3 services.

  Parameters

  • config: ClientConfig

  Returns TDF3Client

Readonly allowedKases

Optional Readonly authProvider

Readonly clientConfig

Optional Readonly clientId

Readonly cryptoService

Readonly dpopEnabled

Readonly dpopKeys

Optional Readonly easEndpoint

Optional Readonly fileStreamServiceWorker

Readonly kasEndpoint

Readonly kasKeys

Readonly policyEndpoint

Optional Readonly readerUrl

decrypt

• decrypt(__namedParameters): Promise<DecoratedReadableStream>

• Decrypt TDF ciphertext into plaintext. One of the core operations of the Virtru SDK.

  Parameters

  • __namedParameters: DecryptParams

  Returns Promise<DecoratedReadableStream>

  a https://nodejs.org/api/stream.html#stream_class_stream_readable|Readable stream containing the decrypted plaintext.

  See

  DecryptParamsBuilder

encrypt

• encrypt(opts?): Promise<DecoratedReadableStream>

• Encrypt plaintext into TDF ciphertext. One of the core operations of the Virtru SDK.

  Parameters

  • Optional opts: EncryptParams

    Test only

  Returns Promise<DecoratedReadableStream>

  a https://nodejs.org/api/stream.html#stream_class_stream_readable|Readable a new stream containing the TDF ciphertext

getPolicyId

• getPolicyId(source): Promise<any>

• Get the unique policyId associated with TDF ciphertext. Useful for managing authorization policies of encrypted data.
  
  The policyId is embedded in the ciphertext so this is a local operation.

  Parameters

  • source: {
        source: DecryptSource;
    }

    Required. TDF data stream, generated using DecryptParamsBuilder#build|DecryptParamsBuilder's build().

    • source: DecryptSource

  Returns Promise<any>

  • the unique policyId, which can be used for tracking purposes or policy management operations.

  See

  DecryptParamsBuilder

loadTDFStream

• loadTDFStream(__namedParameters): Promise<{
      centralDirectory: CentralDirectory[];
      manifest: Manifest;
      zipReader: ZipReader;
  }>

• Parameters

  • __namedParameters: {
        source: DecryptSource;
    }

    • source: DecryptSource

  Returns Promise<{
      centralDirectory: CentralDirectory[];
      manifest: Manifest;
      zipReader: ZipReader;
  }>