- ×Show All
Tanker is an open-source solution to protect sensitive data in any application, with a simple end-user experience and good performance. No cryptographic skills are required to implement it.
Tanker Core is the foundation, it provides powerful end-to-end encryption of any type of data, textual or binary. Tanker Core handles multi-device, identity verification, user groups and pre-registration sharing.
Package Version @tanker/client-browser @tanker/client-node
Detailed changes for each release are documented in the Release Notes.
Tanker Core usage exampleThe Core SDK takes care of all the difficult cryptography in the background, leaving you with simple high-level APIs:
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.
End-to-end encryption requires that all users have cryptographic identities. The following packages help to handle them:
Tanker Verification UI is a UI element that wraps a Tanker Core instance in order to handle the verification process automatically. It takes the form of a modal that will appear when needed, send the verification code by email to the user, and prompt them to verify their identity with the code.
Tanker Fake Authentication reduces the friction when starting new projects, by delaying the integration of Tanker Identity in your application server.
Package Version @tanker/identity @tanker/verification-ui @tanker/fake-authentication
Tanker FileKit is an end-to-end encrypted file storage service for apps.
Tanker FileKit transfers and stores files in the cloud. The files are encrypted in the browser before being uploaded, and can only be downloaded by the owner and recipients, completely transparently.
It wraps Tanker Core and Tanker VerificationUI in a single easy-to-use to use package.
Tanker FileKit usage exampleThis is a simple example using FileKit:
Package Version @tanker/filekit
- Chrome, Firefox, Safari, Microsoft Edge, and Internet Explorer 11
- Node.js 10+
We use BrowserStack to automate testing on many browser & OS combinations.
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
cd sdk-js && yarn
Test and lint
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:
Submit your pull request
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
masterbranch of this repository.