Introduction | SDK Features | Installation | Usage Example | Docs | Support
Don't use it in the production apps. Future API can be changed! More info in Slack
Virgil Security provides an SDK which simplifies work with Virgil services and presents easy to use API for adding security to any application. In a few simple steps you can setup user encryption with multidevice support.
- multidevice support
- manage users' Public Keys
You can install this module from npm. Another option is to add it via script tag in browser.
You will need to install @virgilsecurity/e3kit
.
npm install @virgilsecurity/e3kit
You will need to add @virgilsecurity/e3kit
script.
<script src="https://unpkg.com/@virgilsecurity/e3kit/dist/e3kit.browser.umd.js"></script>
import { EThree } from '@virgilsecurity/e3kit-js'
// get virgil token from you backend (better to protect it!)
const getToken = () => fetch('http://localhost:3000/get-virgil-jwt/')
.then(res => res.json())
.then(data => data.token);
// get your unique identity from backend
const sdk = await EThree.initialize(getToken);
// create private key and upload it to our protected cloud service
await sdk.register();
await sdk.backupPrivateKey('encryption_pwd');
const usersToEncryptTo = ["[email protected]", "[email protected]", '[email protected]'];
const userThatEncrypts = "[email protected]";
const [receiverPublicKeys, senderPublicKey] = await Promise.all([
eThree.lookupPublicKeys(usersToEncryptTo),
eThree.lookupPublicKeys(userThatEncrypts)
]);
const encryptedMsg = await eThree.encrypt('Send you my sensitive information!', receiversPublicKeys);
const decryptedMsg = await eThree.decrypt(encryptedMsg, senderPublicKey);
// we decrypt the message and check that it is sent by "[email protected]"
You can find more examples in examples folder and on https://e3kit.readme.io.
Virgil Security has a powerful set of APIs, and the documentation below can get you started today.
This library is released under the 3-clause BSD License.
Our developer support team is here to help you. Find out more information on our Help Center.
You can find us on Twitter or send us email [email protected].
Also, get extra help from our support team on Slack.