@vivy/krypt-web

3.1.1 • Public • Published

krypt-web

A web crypto library used by Vivy GmbH for encryption/decryption in browser.

How to use

Installation

yarn add @vivy/krypt-web

Usage

EHREncryption example

import { ehrEncrypt, ehrDecrypt } from "@vivy/krypt-web";

async function myEncryptionModule(publicKey, bytesToEncrypt) {
  return await ehrEncrypt(publicKey, bytesToEncrypt);
}

// ....

async function myDecryptionModule(privateKey, data) {
  return await ehrDecrypt(privateKey, data);
}

MedStickerEncryption example

import { medicalId } from "@vivy/krypt-web";
const {
  deprecated: { deriveKey: medDeriveKey, decrypt: medDecrypt }
} = medicalId;

async function myEncryptionModule(code, pin, bytesToEncrypt) {
  const { key, iv } = medDeriveKey(code, pin);

  const { data } = await medEncrypt(code, pin, bytesToEncrypt);
  return { encryptedData: data };
}

// ....

async function myDecryptionModule(code, pin, data) {
  const { key, iv, version } = medDeriveKey(code, pin, "britney");

  return await medDecrypt({ key, iv, version }, data);
}

Development

Deployment process

krypt-web is deployed to npm, and new releases are deployed by CircleCI after creating a Github release.

To create a new release:

  1. Ensure your changes are merged to master
  2. Create a new Github release with the correct name (Release x.x.x) and tag (x.x.x). Your release must include a description of the changes included in the release
  3. CircleCI will then pick up the new tag and automatically build, test and publish the new version.

Running the tests

Single test tun

yarn test

Watch changes

yarn test:watch

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

  • Christos Paschalidis

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

  • Lanwen for his guidance and onto the point feeback.

  • Herman Rogers for his initial work on the project.

Readme

Keywords

none

Package Sidebar

Install

npm i @vivy/krypt-web

Weekly Downloads

2

Version

3.1.1

License

MIT

Unpacked Size

61.8 kB

Total Files

13

Last publish

Collaborators

  • sblaettgen
  • a7madgamal
  • vivy-npm
  • weetbix
  • kirill_at_vivy