Skip to content

sdk 0.3.0-beta.1975

Install from the command line:
Learn more about npm packages
$ npm install @opentdf/sdk@0.3.0-beta.1975
Install via package.json:
"@opentdf/sdk": "0.3.0-beta.1975"

About this version

An OpenTDF Library for Browser Applications

This project presents client code to write and read a OpenTDF data formats. This included NanoTDF and collections and Base TDF3.

Usage

NanoTDF

import { type Chunker, OpenTDF } from '@opentdf/sdk';

const oidcCredentials: RefreshTokenCredentials = {
  clientId: keycloakClientId,
  exchange: 'refresh',
  refreshToken: refreshToken,
  oidcOrigin: keycloakUrl,
};
const authProvider = await AuthProviders.refreshAuthProvider(oidcCredentials);
const client = new OpenTDF({
  authProvider,
  defaultCreateOptions: {
    defaultKASEndpoint: kasEndpoint, // Server used for Key Access Control
  },
  dpopKeys: authProvider.getSigningKey(),
});
const cipherText = await client.createNanoTDF({
  source: { type: 'stream', location: source },
});

const clearText = await client.read({ type: 'stream', location: cipherText });

ZTDF

import { type Chunker, OpenTDF } from '@opentdf/sdk';

const oidcCredentials: RefreshTokenCredentials = {
  clientId: keycloakClientId,
  exchange: 'refresh',
  refreshToken: refreshToken,
  oidcOrigin: keycloakUrl,
};
const authProvider = await AuthProviders.refreshAuthProvider(oidcCredentials);
const client = new OpenTDF({
  authProvider,
  defaultCreateOptions: {
    defaultKASEndpoint: kasEndpoint, // Server used for Key Access Control
  },
  dpopKeys: authProvider.getSigningKey(),
});
const cipherText = await client.createZTDF({
  source: { type: 'stream', location: source },
  autoconfigure: false,
});

const clearText = await client.read({ type: 'stream', location: cipherText });

Details

  • sdk
  • @opentdf opentdf
  • 1 day ago
  • BSD-3-Clause-Clear
  • 48 dependencies

Assets

  • sdk-0.3.0-beta.1975.tgz

Download activity

  • Total downloads 0
  • Last 30 days 0
  • Last week 0
  • Today 0