Class TDF3Client

constructor

• new TDF3Client(config: ClientConfig): TDF3Client

  An abstraction for protecting and accessing data using TDF3 services.

  Parameters

  • config: ClientConfig

    • keypair

      keypair generated for signing. Optional, will be generated by sdk if not passed

    • clientId

    • kasEndpoint

      Key Access Server url

    • refreshToken

      After logging in to browser OIDC interface user receives fresh token that needed by SDK for auth needs

    • externalJwt

      JWT from external authority (eg Google)

    • oidcOrigin

      Endpoint of authentication service

  Returns TDF3Client

Optional ReadonlyallowedKases

Optional ReadonlyauthProvider

ReadonlyclientConfig

Optional ReadonlyclientId

ReadonlycryptoService

ReadonlydpopEnabled

ReadonlydpopKeys

Optional ReadonlyeasEndpoint

Optional ReadonlyfileStreamServiceWorker

ReadonlyfulfillableObligationFQNs

ReadonlykasEndpoint

ReadonlykasKeyInfoCache

Optional ReadonlyplatformUrl

ReadonlypolicyEndpoint

Optional ReadonlyreaderUrl

_doFetchKasKeyWithCache

• _doFetchKasKeyWithCache(
      ...params: [
          cache: KasKeyInfoCache,
          kas: string,
          algorithm?: KasPublicKeyAlgorithm,
          kid?: string,
      ],
  ): Promise<KasPublicKeyInfo>

  Necessary only for testing. A dependency-injection approach should be preferred, but that is difficult currently

  Parameters

  • ...params: [
        cache: KasKeyInfoCache,
        kas: string,
        algorithm?: KasPublicKeyAlgorithm,
        kid?: string,
    ]

  Returns Promise<KasPublicKeyInfo>

decrypt

• decrypt(__namedParameters: DecryptParams): 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?: EncryptParams): Promise<DecoratedReadableStream>

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

  Parameters

  • Optionalopts: 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: { source: DecryptSource }): 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().

  Returns Promise<any>

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

  See

  DecryptParamsBuilder

loadTDFStream

• loadTDFStream(
      __namedParameters: { source: DecryptSource },
  ): Promise<InspectedTDFOverview>

  Parameters

  • __namedParameters: { source: DecryptSource }

  Returns Promise<InspectedTDFOverview>