JavaScript Elliptic Curve Integrated Encryption Scheme (ECIES) Library - Based off Geth's implementation
npm install ecies-geth!GitHub tag (latest by date)
!npm
!GitHub last commit
!GitHub issues
!NPM
This is a JavaScript Elliptic Curve Integrated Encryption Scheme (ECIES) library for use in both Browser and NodeJS apps.
This module is a modified version of the eccrypto JavaScript library.
It's also based off Geth's implementation (Ethereum's ecies Go module).
We needed to have a JavaScript library fully compliant with the way the Go Ethereum ECIES module (ecies) was implemented. \
Parity has implemented ECIES encryption and decryption for arbitrary messages through its extended JSON RPC API and has started translating it into a JavaScript library (ecies-parity). But issues remain in the latter and needed a pass to correct them.
As with eccrypto, this library provides two implementations for Browser and NodeJS with the same API.
The ECIES implementation details mimic those introduced by both Geth and Parity, which are:
* Implements a __SHA-256__ Key Derivation Function (KDF);
* ECDH based only on the secp256k1 curve (to match common blockchain transaction signing);
* Uses __AES-128-CTR__ based symmetric encryption (with a 128-bit shared key derived from ECDH).
#### _Cryptography Warning_
The ECIES implementation given here is solely based off Geth's and Parity's implementations. This module offers no guarantee as to the security or validity of the implementation. Furthermore, this project is being actively developed and as such should not be used for highly sensitive informations without further investigation on its robustness. Any feedback or concerns regarding its security would be greatly appreciated.
``
npm i ecies-geth
Although this module was primarily developed for ECIES encryption/decryption, extra elliptic curve functionalities are provided.
#### ECIES Encryption / Decryption
`js
const crypto = require('crypto');
const ecies = require('ecies-geth');
const privateKeyA = crypto.randomBytes(32);
const publicKeyA = await ecies.getPublic(privateKeyA);
const privateKeyB = crypto.randomBytes(32);
const publicKeyB = await ecies.getPublic(privateKeyB);
// Encrypting the message for B.
ecies.encrypt(publicKeyB, Buffer.from('msg to b')).then(function(encrypted) {
// B decrypting the message.
ecies.decrypt(privateKeyB, encrypted).then(function(plaintext) {
console.log('Message to part B', plaintext.toString());
});
});
// Encrypting the message for A.
ecies.encrypt(publicKeyA, Buffer.from('msg to a')).then(function(encrypted) {
// A decrypting the message.
ecies.decrypt(privateKeyA, encrypted).then(function(plaintext) {
console.log('Message to part A', plaintext.toString());
});
});
`
#### ECDSA Signing
`js
const crypto = require('crypto');
const ecies = require('ecies-geth');
// A new random 32-byte private key.
const privateKey = crypto.randomBytes(32)
// Corresponding uncompressed (65-byte) public key.
const publicKey = await ecies.getPublic(privateKey);
const str = 'message to sign';
// Always hash your message to sign!
const msg = crypto.createHash('sha256').update(str).digest();
ecies.sign(privateKey, msg).then(function(sig) {
console.log('Signature in DER format:', sig);
ecies.verify(publicKey, msg, sig).then(function() {
console.log('Signature is OK');
}).catch(function() {
console.log('Signature is BAD');
});
})
`
#### ECDH Derivation
`js
const crypto = require('crypto');
const ecies = require('ecies-geth');
const privateKeyA = crypto.randomBytes(32);
const publicKeyA = await ecies.getPublic(privateKeyA);
const privateKeyB = crypto.randomBytes(32);
const publicKeyB = await ecies.getPublic(privateKeyB);
ecies.derive(privateKeyA, publicKeyB).then(function(sharedKey1) {
ecies.derive(privateKeyB, publicKeyA).then(function(sharedKey2) {
console.log('Both shared keys are equal', sharedKey1, sharedKey2);
})
})
`
This library relies on the following dependencies:
- elliptic;
- secp256k1.
To run the tests, you would need to install live-server:
`console``
npm i -g live-server
Thanks to @Methrat0n for the initial work on this adaptation.
This module is distributed under a MIT license. \
See the LICENSE file.