@notabene/crypto
v1.1.0
Published
Encryption Library for Notabene Services
Downloads
5
Readme
notabene-crypto
Documentation: https://notabene-id.github.io/notabene-crypto/
Description
Encryption Library for Notabene Services
Installation
yarn
yarn add @notabene/crypto
npm
npm install @notabene/crypto
Usage
const {
createEncriptionKeyPair,
serializeKey,
deserializeKey,
encrypt,
decrypt,
} = require("@notabene/crypto");
//Create pair of keys
const alice = createEncriptionKeyPair();
console.log(serializeKey(alice));
/*
{
publicKeyB64: '...',
secretKeyB64: '...'
}
*/
//Get bob key
const bobSerializedKeys = {
publicKeyB64: "vBTvb1MGLOahUPgzAJJB/fPqi6GOG4kcaaNAqD3SDzU=",
secretKeyB64: "iKVZwIFyONUNga0dKlZqD1mlVRBVUmVnsiFICkTY9Vk=",
};
console.log(bobSerializedKeys);
const bob = deserializeKey(bobSerializedKeys);
//Encrypt a message from alice to bob
encrypt(alice, bob.publicKey, "sensitive data").then(enc => {
console.log(enc);
/*
{
ciphertext: '...',
nonce: '...',
fromPublicKey: '...',
toPublicKey: 'vBTvb1MGLOahUPgzAJJB/fPqi6GOG4kcaaNAqD3SDzU=',
version: 'x25519-xsalsa20-poly1305'
}
*/
//Decrypt message with bob secretKey
const message = decrypt(bob.secretKey, enc);
console.log(message);
/*
"sensitive data"
*/
});
Development
Instal dependencies
$ npm install
Build
$ npm run build
Test
$ npm test
To publish to NPM:
$ pika publish
To publish dosc:
$ npm run docs
Contributing
Contributions are welcome!
Want to file a bug, request a feature or contribute some code?
- Check out the Code of Conduct
- Check that there is no existing issue corresponding to your bug or feature
- Before implementing a new feature, discuss your changes in an issue first!
License
MIT © Notabene