Git Product home page Git Product logo

zymkey's Introduction

Zymkey NodeJS Library

A NodeJS wrapper for zymkey crypto library.

Caution: This repo is deprecated and not catching up with the hardware development of zymkey.

Installation

npm install zymkey --save

Usage

var client = require('zymkey');
var ret = client.ledOff();
console.log('Zymkey ledOff returned ' + ret);

var srcBuf = new Buffer('hello, world');
lockedBuf =  client.lock(srcBuf);
console.log('Locked data: \n\t' + lockedBuf.toString());

unlockedBuf = client.unlock(lockedBuf);
console.log('Unlocked data: ');
console.log('\t' + unlockedBuf.toString('utf-8'));

console.log('Buffer equals ' + srcBuf.equals(unlockedBuf));

Examples

Take a look at the examples under examples/ folder.

Tests

All the test are under test/. And run test script by

npm test

Supported Zymkey Features

  • Manipulation (on/off/flash) of onboard LED.
  • ECDSA (P256 curve only) operations (getECDSAPubKey/sign/verify)
  • Data encrypt/decrypt using Zymkey private key.
  • Generate random bytes using Zymkey's True Random Number Generator (TRNG).
  • Access to Zymkey's Real Time Clock (RTC).
  • Access to Zymkey's Tap Detection Sensor.
  • Set Zymkey's I2C address.

Release History

  • 0.1.0 Inital Release (01/04/2017)

Acknowledgement

This project is based on Zymbit's trusted hardware modules. Thanks to Zymbit's amazing technical supports and great product!
And credits are given to the node-ffi and ref that enable calling Zymkey's C library in nodejs.

License

GPL-3.0

Copyright

Lex && Oaken Team

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.