https://github.com/virgilsecurity/virgil-e3kit-js
E3Kit is a security framework that simplifies work with Virgil services and presents the easiest way to add full end-to-end security to your chat application to become HIPAA and GDPR compliant and more.
https://github.com/virgilsecurity/virgil-e3kit-js
e3kit encryption end-to-end-encryption gdpr group-encryption hipaa multi-device pki sdk secure-the-future securethefuture security-sdk stream-encryption
Last synced: about 1 year ago
JSON representation
E3Kit is a security framework that simplifies work with Virgil services and presents the easiest way to add full end-to-end security to your chat application to become HIPAA and GDPR compliant and more.
- Host: GitHub
- URL: https://github.com/virgilsecurity/virgil-e3kit-js
- Owner: VirgilSecurity
- License: bsd-3-clause
- Created: 2018-10-17T15:15:59.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-05-28T16:40:28.000Z (about 2 years ago)
- Last Synced: 2025-04-07T12:51:03.461Z (about 1 year ago)
- Topics: e3kit, encryption, end-to-end-encryption, gdpr, group-encryption, hipaa, multi-device, pki, sdk, secure-the-future, securethefuture, security-sdk, stream-encryption
- Language: TypeScript
- Homepage: https://virgilsecurity.com/e3kit/
- Size: 5.34 MB
- Stars: 60
- Watchers: 11
- Forks: 19
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Virgil E3Kit TypeScript/JavaScript
[](https://travis-ci.com/VirgilSecurity/virgil-e3kit-js)
[](https://www.npmjs.com/package/@virgilsecurity/e3kit-browser)
[](https://github.com/VirgilSecurity/virgil-e3kit-js/blob/master/LICENSE)
[](https://virgilsecurity.github.io/virgil-e3kit-js/)
[Introduction](#introduction) | [Benefits](#benefits) | [Features](#features) | [Installation](#installation) | [Resources](#resources) | [Samples](#samples) | [License](#license) | [Support](#support)
## Introduction
[Virgil Security](https://virgilsecurity.com) provides [Virgil E3Kit](https://virgilsecurity.com/e3kit/) - an open-source client-side framework that allows developers to add end-to-end encryption to their messaging applications, file sharing programs, and other digital communication products in just a few simple steps to become HIPAA and GDPR compliant and more.
## Benefits
- Easy to setup and integrate into new or existing projects
- Compatible with any CPaaS provider, including Nexmo, Firebase, Twilio, PubNub and etc.
- Strong secret keys storage, integration with all platform-specific storages
- Provides GDPR and HIPAA compliance
- Immune to quantum computers attacks
## Features
- Strong one-to-one and group encryption
- Files end-to-end encryption (for browser and React Native)
- Data signature and verification as part of the encrypt and decrypt functions
- Recoverable private encryption keys
- Access to encrypted data from multiple user devices
## Installation
Navigate to our [Developer Documentation](https://developer.virgilsecurity.com/docs/e3kit/get-started/setup-client/) to install and initialize Virgil E3Kit.
Virgil E3Kit JS is provided in separate packages for different platforms:
| Name | Description |
| :--- | :---------- |
| [e3kit-browser](/packages/e3kit-browser) | For use in web browsers. |
| [e3kit-native](/packages/e3kit-native) | For use in React Native. |
| [e3kit-node](/packages/e3kit-node) | For use in Node.js and Electron. |
## Resources
- [E3Kit Product Page](https://virgilsecurity.com/e3kit/)
- [E3Kit Documentation](https://developer.virgilsecurity.com/docs/e3kit/) - start integrating E3Kit into your project with our detailed guides.
- [E3Kit TypeScript/JavaScript API Reference](https://virgilsecurity.github.io/virgil-e3kit-js/) - E3Kit API reference for the language of your choice.
- [Quickstart Demo](https://developer.virgilsecurity.com/docs/e3kit/get-started/quickstart/) - will help you to get started with the Virgil E3Kit quickly, and to learn some common ways to build end-to-end encryption between two fictional characters Alice and Bob.
## Samples
You can find examples for React Native, Webpack, Ionic, Node and UMD in the [examples folder](/examples), at our [Developer Documentation](https://developer.virgilsecurity.com/docs/e3kit/) and in the [E3kit Web Demo](https://github.com/VirgilSecurity/demo-e3kit-web).
## License
This library is released under the [3-clause BSD License](LICENSE).
## Support
Our developer support team is here to help you. Find out more information on our [Help Center](https://help.virgilsecurity.com/).
You can find us on [Twitter](https://twitter.com/VirgilSecurity) or send us email support@VirgilSecurity.com.
Also, get extra help from our support team on [Slack](https://virgilsecurity.com/join-community).
## Troubleshooting
### Webpack
Make sure you're following a similar approach to the [webpack example](/examples/webpack) and pay special attention to the webpack.config.js file.