Have ideas to improve npm?Join in the discussion! »

lcrypto

1.1.6 • Public • Published

lcrypto Build Status

NPM

An even better JavaScript Elliptic curve cryptography library for both browserify and node (my updates are only for the browser, sorry). This is a fork from Bitchan's eccrypto as it didn't have some things I wanted (Create a private key from a passphrase, sign messages longer than 32 characters and encryption was broken for anything over 15 characters which I had to change for a project I'm working on).

Motivation

There is currently no any isomorphic ECC library which provides ECDSA, ECDH and ECIES for both Node.js and Browser and uses the fastest implementation available (e.g. secp256k1-node is much faster than other libraries but can be used only on Node.js). So lcrypto is an attempt to create one.

Implementation details

With the help of browserify lcrypto provides different implementations for Browser and Node.js with the same API. Because WebCryptoAPI defines asynchronous promise-driven API, implementation for Node needs to use promises too.

  • Use Node.js crypto module/library bindings where possible
  • Use WebCryptoAPI where possible
  • Promise-driven API
  • Only secp256k1 curve, only SHA-512 (KDF), HMAC-SHA-256 (HMAC) and AES-256-CBC for ECIES
  • Compressed key support

Native crypto API limitations

crypto

ECDH only works in Node 0.11+ (see https://github.com/joyent/node/pull/5854), ECDSA only supports keys in PEM format (see https://github.com/joyent/node/issues/6904) and ECIES is not supported at all.

WebCryptoAPI

ECDSA and ECDH are supported in Chrome only on Windows (see also bug 338883), aren't supported by Firefox (fixed only in 36.0+, see bug 1034854; see also feature matrix) and ECIES is not defined at all in WebCryptoAPI draft. Also WebCryptoAPI currently defines only curves recommended by NIST meaning that secp256k1 (K-256) curve is not supported (see also: [1], [2]).

So we use seck256k1 library in Node for ECDSA, elliptic in Browser for ECDSA and ECDH and implement ECIES manually with the help of native crypto API.

Possible future goals

  • Support other curves/KDF/MAC/symmetric encryption schemes

Usage

ECDSA

var crypto = require("crypto");
var eccrypto = require("eccrypto");
 
// A new random 32-byte private key.
//The optional first param here is the passphrase.
//It must be 32 characters long, I suggest using scrypt or bcrypt for hashing any password to this length
var privateKey = eccrypto.generatePrivate(
  "fdgfdsfdgufdugsbifdgsbuubsdfgubffdgfdsfdgufdugsbifdgsbuubsdfgubf"
);
// Corresponding uncompressed (65-byte) public key.
var publicKey = eccrypto.getPublic(privateKey);
 
var str = "message to sign";
// Always hash you message to sign!
var msg = crypto
  .createHash("sha256")
  .update(str)
  .digest();
 
eccrypto.sign(privateKey, msg).then(function(sig) {
  console.log("Signature in DER format:", sig);
  eccrypto
    .verify(publicKey, msg, sig)
    .then(function() {
      console.log("Signature is OK");
    })
    .catch(function() {
      console.log("Signature is BAD");
    });
});

ECDH

var eccrypto = require("eccrypto");
 
var privateKeyA = eccrypto.generatePrivate();
var publicKeyA = eccrypto.getPublic(privateKeyA);
var privateKeyB = eccrypto.generatePrivate();
var publicKeyB = eccrypto.getPublic(privateKeyB);
 
eccrypto.derive(privateKeyA, publicKeyB).then(function(sharedKey1) {
  eccrypto.derive(privateKeyB, publicKeyA).then(function(sharedKey2) {
    console.log("Both shared keys are equal:", sharedKey1, sharedKey2);
  });
});

ECIES

var eccrypto = require("eccrypto");
 
var privateKeyA = eccrypto.generatePrivate();
var publicKeyA = eccrypto.getPublic(privateKeyA);
var privateKeyB = eccrypto.generatePrivate();
var publicKeyB = eccrypto.getPublic(privateKeyB);
 
// Encrypting the message for B.
eccrypto.encrypt(publicKeyB, Buffer.from("msg to b")).then(function(encrypted) {
  // B decrypting the message.
  eccrypto.decrypt(privateKeyB, encrypted).then(function(plaintext) {
    console.log("Message to part B:", plaintext.toString());
  });
});
 
// Encrypting the message for A.
eccrypto.encrypt(publicKeyA, Buffer.from("msg to a")).then(function(encrypted) {
  // A decrypting the message.
  eccrypto.decrypt(privateKeyA, encrypted).then(function(plaintext) {
    console.log("Message to part A:", plaintext.toString());
  });
});

License

eccrypto - JavaScript Elliptic curve cryptography library

Written in 2014-2015 by Kagami Hiiragi kagami@genshiken.org

To the extent possible under law, the author(s) have dedicated all copyright and related and neighboring rights to this software to the public domain worldwide. This software is distributed without any warranty.

You should have received a copy of the CC0 Public Domain Dedication along with this software. If not, see http://creativecommons.org/publicdomain/zero/1.0/.

Install

npm i lcrypto

DownloadsWeekly Downloads

5

Version

1.1.6

License

CC0-1.0

Unpacked Size

48.8 kB

Total Files

8

Last publish

Collaborators

  • avatar