OpenTDF Web Browser Client opentdf

This project is focused on providing web client support for OpenTDF.

Usage

// currently we support only ESM importimport{AuthProviders,NanoTDFClient}from'@opentdf/client';constoidcCredentials: RefreshTokenCredentials={clientId: keycloakClientId,exchange: 'refresh',refreshToken: refreshToken,oidcOrigin: keycloakUrlWithRealm,}constauthProvider=awaitAuthProviders.refreshAuthProvider(oidcCredentials);constclient=newNanoTDFClient(authProvider,access);constcipherText=awaitclient.encrypt(plainText);constclearText=awaitclient.decrypt(cipherText);

Distribute

make dist

Contribute

Prerequisites

Developing with this code requires a recent version of npm and node.

• Install nvm
  • see https://github.com/nvm-sh/nvm#installing-and-updating
  • nvm use will install npm and node

To check out, build, and validate your installation, and test the sample web application, you may:

nvm use
make test
make start

Use the platform

Generate Typescript code from platform protobufs

scripts/platform.sh

This will clone the platform repo and generate Typescript code in lib/src/platform.

Import Typescript code

import { GetAttributeRequest } from './lib/src/platform/policy/attributes/attributes_pb';
import { Attribute, AttributeRuleTypeEnum } from './lib/src/platform/policy/objects_pb';
import {
createConnectTransport,
} from '@connectrpc/connect-web'
import {
createPromiseClient,
} from '@connectrpc/connect'
const attrData = {
name: "my-attr",
rule: AttributeRuleTypeEnum.ALL_OF,
namespace: {name: 'my-namespace'},
values: [{value: 'my-value'}],
active: true,
extraField: 'this will be ignored' // only proto defined fields and value types are respected
}
const attr = new Attribute(attrData);
console.log(attr.toJson());
// {
// namespace: { name: 'my-namespace' },
// name: 'my-attr',
// rule: 'ATTRIBUTE_RULE_TYPE_ENUM_ALL_OF',
// values: [ { value: 'my-value' } ],
// active: true
// }
const req = new GetAttributeRequest({id: 'uuid-here'});
const client = createPromiseClient(
AttributesService,
createConnectTransport({
baseUrl: 'localhost:8080',
})
)

This is an example to instantiate an Attribute and create a GetAttributeRequest.