Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/TankerHQ/sdk-js
Tanker client-side encryption SDK for JavaScript
https://github.com/TankerHQ/sdk-js
cryptography encryption end-to-end javascript privacy sdk security tanker
Last synced: 2 months ago
JSON representation
Tanker client-side encryption SDK for JavaScript
- Host: GitHub
- URL: https://github.com/TankerHQ/sdk-js
- Owner: TankerHQ
- License: other
- Created: 2018-10-10T14:36:43.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-12T13:03:52.000Z (about 1 year ago)
- Last Synced: 2023-12-12T14:28:05.812Z (about 1 year ago)
- Topics: cryptography, encryption, end-to-end, javascript, privacy, sdk, security, tanker
- Language: TypeScript
- Homepage:
- Size: 9.16 MB
- Stars: 795
- Watchers: 12
- Forks: 26
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - sdk-js - Tanker client-side encryption SDK for JavaScript (JavaScript)
README
[actions-badge]: https://github.com/TankerHQ/sdk-js/actions/workflows/tests.yml/badge.svg
[actions-link]: https://github.com/TankerHQ/sdk-js/actions/workflows/tests.yml
[browser_npm-badge]: https://img.shields.io/npm/v/@tanker/client-browser.svg
[browser_npm-link]: https://npmjs.com/package/@tanker/client-browser
[codecov-badge]: https://img.shields.io/codecov/c/github/TankerHQ/sdk-js.svg?label=Coverage
[codecov-link]: https://codecov.io/gh/TankerHQ/sdk-js
[identity_npm-badge]: https://img.shields.io/npm/v/@tanker/identity.svg
[identity_npm-link]: https://npmjs.com/package/@tanker/identity
[last-commit-badge]: https://img.shields.io/github/last-commit/TankerHQ/sdk-js.svg?label=Last%20commit&logo=github
[last-commit-link]: https://github.com/TankerHQ/sdk-js/commits/master
[license-badge]: https://img.shields.io/badge/License-Apache%202.0-blue.svg
[license-link]: https://opensource.org/licenses/Apache-2.0
[nodejs_npm-badge]: https://img.shields.io/npm/v/@tanker/client-node.svg
[nodejs_npm-link]: https://npmjs.com/package/@tanker/client-node
[![License][license-badge]][license-link]
[![Build][actions-badge]][actions-link]
[![Coverage][codecov-badge]][codecov-link]
[![Last commit][last-commit-badge]][last-commit-link]
# Encryption SDKs for JavaScript
[Overview](#overview) · [Core](#tanker-core) · [Identity](#identity-management) · [Browser support](#browser-support) · [Other platforms](#other-platforms) · [Contributing](#contributing)
## Overview
Tanker is an open-source solution to protect sensitive data in any application, with a simple end-user experience and good performance. No cryptographic expertise required.
## Tanker Core
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][browser_npm-link] | [![browser_npm-badge]][browser_npm-link] |
| [@tanker/client-node][nodejs_npm-link] | [![nodejs_npm-badge]][nodejs_npm-link] |
Detailed changes for each release are documented in the [Release Notes](https://github.com/TankerHQ/sdk-js/releases).
Tanker Core usage example
The Core SDK takes care of all the difficult cryptography in the background, leaving you with simple high-level APIs:
```javascript
import { Tanker } from '@tanker/client-browser';
// Initialize the isolated Tanker environment within your application
const tanker = new Tanker({ appId: '...' });
// Start a session with the user's cryptographic identity
await tanker.start(aliceIdentity);
// Encrypt data and share it with separate recipients or groups
const encryptedMessage = await tanker.encrypt(
"It's a secret to everybody",
{ shareWithUsers: [bobIdentity] }
);
// Decrypt data (or throw if not a legitimate recipient)
const message = await tanker.decrypt(encryptedMessage);
```
The Core SDK automatically handles complex key exchanges, cryptographic operations, and identity verification for you.
For more details and advanced examples, please refer to:
* [Core SDK implementation guide](https://docs.tanker.io/latest/guides/)
* [Core API reference](https://docs.tanker.io/latest/api/core/js/)
## Identity management
End-to-end encryption requires that all users have cryptographic identities. The following packages help to handle them:
Tanker **Identity** is a server side package to link Tanker identities with your users in your application backend.
It is available in multiple languages. This repository only contains the Javascript version.
| Package | Version |
|:--------------------------------------|:-------------------------------------------|
| [@tanker/identity][identity_npm-link] | [![identity_npm-badge]][identity_npm-link] |
## Browser support
The Tanker JavaScript SDKs support the following platforms:
* Chrome, Firefox, Safari, and Microsoft Edge
* Node.js 18+
The Tanker JavaScript SDKs are constantly tested with all of the supported browsers via unit and functional tests.
We use [BrowserStack](https://www.browserstack.com/) to automate testing on many browser & OS combinations.
## Other platforms
Tanker is also available for your **desktop and mobile applications**: use our open-source **[Python](https://github.com/TankerHQ/sdk-python)**, **[Ruby](https://github.com/TankerHQ/sdk-ruby)**, and **[Rust](https://github.com/TankerHQ/sdk-rust)** SDKs.
## Contributing
We welcome feedback, bug reports, and bug fixes in the form of [pull requests](https://github.com/TankerHQ/sdk-js/pulls).
To build the JavaScript SDKs yourself, please follow the steps below.
### Prerequisites
Install the lastest version of [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
Use this command to check the npm version installed on your system:
```bash
npm --version
```
### Install dependencies
Clone this repository:
```bash
git clone https://github.com/TankerHQ/sdk-js.git
```
Install dependencies:
```bash
cd sdk-js && npm install
```
### Test and lint
Our codebase uses the following ES6 features: `async` / `await`, `import` / `export`, and classes with typescript for type-checking and with eslint for linting.
To check that the code is correct and to launch the tests in Node.js, use:
```bash
npm run proof
```
### 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](https://github.com/TankerHQ/sdk-js/pulls), targeting the `master` branch of this repository.