Class OpenTDF

constructor

• new OpenTDF(__namedParameters): OpenTDF

• Parameters

  • __namedParameters: OpenTDFOptions

  Returns OpenTDF

Readonly authProvider

defaultCreateOptions

defaultReadOptions

Readonly dpopEnabled

Readonly dpopKeys

Readonly policyEndpoint

close

• close(): void

• Returns void

createNanoTDF

• createNanoTDF(opts): Promise<DecoratedStream>

• Parameters

  • opts: CreateNanoTDFOptions

  Returns Promise<DecoratedStream>

createNanoTDFCollection

• createNanoTDFCollection(opts): Promise<NanoTDFCollection>

• Creates a new collection object, which can be used to encrypt a series of data with the same policy.

  Parameters

  • opts: CreateNanoTDFCollectionOptions

  Returns Promise<NanoTDFCollection>

createZTDF

• createZTDF(opts): Promise<DecoratedStream>

• Parameters

  • opts: CreateZTDFOptions

  Returns Promise<DecoratedStream>

read

• read(opts): Promise<DecoratedStream>

• Decrypts a nanotdf object. Optionally, stores the collection header and its DEK.

  Parameters

  • opts: ReadOptions

  Returns Promise<DecoratedStream>