Tanker is an open-source client SDK that can be embedded in any application.
It leverages powerful client-side encryption of any type of data, textual or binary, but without performance loss and assuring a seamless end-user experience. No cryptographic skills are required.
The client SDK takes care of all the difficult cryptography in the background, leaving you with simple high-level APIs:
import Tanker from '@tanker/client-browser'; // Init the isolated Tanker environment within your application const tanker = new Tanker( trustchainId: '...' ); // Sign in with the user's cryptographic identity await tanker.open(aliceUserId, aliceUserToken); // Encrypt data and share it with separate recipients or groups const encryptedMessage = await tanker.encrypt( 'It is a secret to everybody', shareWithUsers: [bobUserId] ); // Decrypt data (or throw if not a legitimate recipient) const message = await tanker.decrypt(encryptedMessage);
The client SDK automatically handles complex key exchanges, cryptographic operations, and identity verification for you.
For more details and advanced examples, please refer to:
Or fiddle with the quickstart examples to see the Tanker SDKs integrated in a collection of demo apps.
Detailed changes for each release are documented in the release notes.
- Chrome, Firefox, Safari, Edge, and Internet Explorer 11
- Node.js 8+
Install Yarn version 1.0 or greater.
Use this command to check the Yarn version installed on your system:
Clone this repository:
git clone https://github.com/TankerHQ/sdk-js.git
Our codebase uses the following ES6 features:
export, and classes with flow for type-checking and with eslint for linting.
To check that the code is correct and to launch the tests in Node.js, use:
Before submitting your pull request, please make sure that your changes pass the linters and that all the tests pass on your local machine.
For non-trivial changes, we highly recommend including extra tests.
When you’re ready, submit your pull request, targeting the
master branch of this repository.
At Tanker, we happily use BrowserStack to automate testing on many browsers.