# @virgilsecurity/e3kit-base

> End-to-end encryption with multiple device support powered by Virgil Security

Latest version **3.0.7** (published 2024-05-28) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install @virgilsecurity/e3kit-base
pnpm add @virgilsecurity/e3kit-base
yarn add @virgilsecurity/e3kit-base
bun add @virgilsecurity/e3kit-base
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.7 |
| Published | 2024-05-28 |
| First published | 2019-11-06 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 11 |
| Unpacked size | 156.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 61 |
| Author | Virgil Security Inc. |
| Maintainers | rstp, ddain, mbalyaba |

## Links

- npm: https://www.npmjs.com/package/@virgilsecurity/e3kit-base
- Repository: https://github.com/VirgilSecurity/virgil-e3kit-js/tree/master/packages/e3kit-base
- npm.io page: https://npm.io/package/@virgilsecurity/e3kit-base

## Dependencies (11)

- [levelup](https://npm.io/package/levelup.md) ^5.1.1
- [virgil-sdk](https://npm.io/package/virgil-sdk.md) ^6.1.2
- [subleveldown](https://npm.io/package/subleveldown.md) ^6.0.1
- [@types/expect](https://npm.io/package/@types/expect.md) ^24.3.0
- [virgil-pythia](https://npm.io/package/virgil-pythia.md) ^1.0.2
- [@types/levelup](https://npm.io/package/@types/levelup.md) ^5.1.2
- [abstract-leveldown](https://npm.io/package/abstract-leveldown.md) ^7.2.0
- [@virgilsecurity/keyknox](https://npm.io/package/@virgilsecurity/keyknox.md) ^1.0.3
- [@types/abstract-leveldown](https://npm.io/package/@types/abstract-leveldown.md) ^7.2.0
- [@virgilsecurity/sdk-crypto](https://npm.io/package/@virgilsecurity/sdk-crypto.md) ^2.0.0
- [@virgilsecurity/crypto-types](https://npm.io/package/@virgilsecurity/crypto-types.md) ^1.1.1

## Recent versions

- 3.0.7 (latest) — 2024-05-28
- 0.8.0-beta.0 (next) — 2020-01-29
- 3.0.6 — 2024-04-27
- 3.0.5 — 2024-01-25
- 3.0.4 — 2024-01-25
- 3.0.3 — 2024-01-25
- 3.0.2 — 2023-12-29
- 3.0.1 — 2023-12-28
- 3.0.0 — 2023-12-27
- 2.5.1 — 2022-11-11
- 2.5.0 — 2022-11-08
- 2.4.5 — 2021-08-14
- 2.4.4 — 2021-06-09
- 2.4.3 — 2021-04-16
- 2.4.2 — 2021-03-16
- … 15 more at https://npm.io/package/@virgilsecurity/e3kit-base/versions

## README

# Virgil E3Kit TypeScript/JavaScript

[![Build Status](https://travis-ci.com/VirgilSecurity/virgil-e3kit-js.svg?branch=master)](https://travis-ci.com/VirgilSecurity/virgil-e3kit-js)
[![npm](https://img.shields.io/npm/v/@virgilsecurity/e3kit-browser.svg)](https://www.npmjs.com/package/@virgilsecurity/e3kit-browser)
[![GitHub license](https://img.shields.io/github/license/VirgilSecurity/e3kit-js.svg)](https://github.com/VirgilSecurity/virgil-e3kit-js/blob/master/LICENSE)
[![API Reference](https://img.shields.io/badge/API%20reference-e3kit--js-green)](https://virgilsecurity.github.io/virgil-e3kit-js/)

[Introduction](#introduction) | [Benefits](#benefits) | [Features](#features) | [Installation](#installation) | [Resources](#resources) | [Samples](#samples) | [License](#license) | [Support](#support)

## Introduction

<a href="https://virgilsecurity.com/e3kit/"><img width="100px" src="https://cdn.virgilsecurity.com/assets/images/github/logos/e3kit/E3Kit.png" align="left" hspace="10" vspace="6"></a> [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.

---
_Source: https://npm.io/package/@virgilsecurity/e3kit-base · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
