Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/opentdf/web-sdk
OpenTDF JavaScript SDK
https://github.com/opentdf/web-sdk
data-encryption data-tagging drm end-to-end-encryption file-encryption open-source opensource opentdf tdf webclient zero-trust zero-trust-security
Last synced: 2 months ago
JSON representation
OpenTDF JavaScript SDK
- Host: GitHub
- URL: https://github.com/opentdf/web-sdk
- Owner: opentdf
- License: bsd-3-clause-clear
- Created: 2021-10-26T19:53:47.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-01T20:22:47.000Z (3 months ago)
- Last Synced: 2024-11-01T21:22:53.189Z (3 months ago)
- Topics: data-encryption, data-tagging, drm, end-to-end-encryption, file-encryption, open-source, opensource, opentdf, tdf, webclient, zero-trust, zero-trust-security
- Language: TypeScript
- Homepage:
- Size: 12.6 MB
- Stars: 0
- Watchers: 15
- Forks: 1
- Open Issues: 49
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# OpenTDF Web Browser Client opentdf
This project is focused on providing web client support for the OpenTDF platform.
This includes encrypting and decrypting TDF content,
and some management tasks for ABAC.
## Usage (NanoTDF)
```typescript
import { AuthProviders, NanoTDFClient } from '@opentdf/sdk';
// Configuration Options
const kasEndpoint = "http://localhost:65432/kas";
// Authentication options (vary by middleware)
const oidcOrigin = "http://localhost:65432/auth/realms/tdf";
const clientId = "applicationNameFromIdP";
const refreshToken = "refreshTokenValueFromIdP";
// AuthProviders are middlewares that add `Authorization` or other bearer tokens to requests.
// These include The `refresh` provider can be handed a refresh and optional access token.
const authProvider = await AuthProviders.refreshAuthProvider({
clientId,
exchange: 'refresh',
refreshToken,
oidcOrigin,
});
const client = new NanoTDFClient({
authProvider,
kasEndpoint,
});
client.dataAttributes = ["http://opentdf.io/attr/class/value/secret"]
const cipherText = await client.encrypt(plainText);
const clearText = await client.decrypt(cipherText);
```
### Authorization Middleware Options
#### Client Credentials
For long running server-side apps, a client id + secret is allowed with OAuth2.
This should not be used in a browser, but within a Deno or Node process.
```typescript
import { AuthProviders } from '@opentdf/sdk';
// Authentication options (vary by middleware)
const oidcOrigin = "http://localhost:65432/auth/realms/tdf";
const clientId = "username";
const clientSecret = "IdP_GENERATED_SECRET";
const authProvider = await AuthProviders.clientSecretAuthProvider({
clientId,
clientSecret,
oidcOrigin,
exchange: 'client',
});
```
#### Given Credentials
The `refreshAuthProvider` and `externalAuthProvder` allow the application developer to use existing tokens.
```typescript
import { AuthProviders, NanoTDFClient } from '@opentdf/sdk';
const oidcCredentials: RefreshTokenCredentials = {
clientId: keycloakClientId,
exchange: 'refresh',
refreshToken: refreshToken,
oidcOrigin: keycloakUrlWithRealm,
}
```
#### Building your own provider
A more complete example of using an OIDC compatible provider
with support for authorization code flow with PKCE and DPoP
is available in the [sample `web-app` folder](./web-app/src/session.ts)
## Build and Test
```shell
make
```
## Contribute
### Prerequisites
Developing with this code requires a recent version of `npm` and `node`.
We develop using [nvm](https://github.com/nvm-sh/nvm#readme),
which allows us to pin to the same version of `npm` easily.
- Install [nvm](https://github.com/nvm-sh/nvm#readme)
- see
- `nvm use` will install `npm` and `node`
[](https://github.com/opentdf/web-sdk/actions/workflows/build.yaml)
To check out, build, and validate your installation, and test the sample web application, you may:
```sh
nvm use
make test
make start
```
## Use the platform
Version 2 of this library adds support for ABAC management tasks.
This is provided with the [opentdf Platform](https://github.com/opentdf/platform).
### Generate Typescript code from platform protobufs
```sh
scripts/platform.sh
```
This will clone the platform repo and generate Typescript code in `lib/src/platform`.
### Import Typescript code
```ts
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`.