Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cyrildever/ecies-geth
JavaScript Elliptic Curve Integrated Encryption Scheme (ECIES) Library - Based off Geth's implementation
https://github.com/cyrildever/ecies-geth
cryptography ecdh ecies-encryption ecies-geth javascript-library
Last synced: about 1 month ago
JSON representation
JavaScript Elliptic Curve Integrated Encryption Scheme (ECIES) Library - Based off Geth's implementation
- Host: GitHub
- URL: https://github.com/cyrildever/ecies-geth
- Owner: cyrildever
- License: mit
- Created: 2019-12-21T14:55:09.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-27T09:31:54.000Z (8 months ago)
- Last Synced: 2024-04-24T06:09:40.255Z (7 months ago)
- Topics: cryptography, ecdh, ecies-encryption, ecies-geth, javascript-library
- Language: TypeScript
- Size: 790 KB
- Stars: 8
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ecies-geth
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`](https://github.com/bitchan/eccrypto) JavaScript library.
It's also based off Geth's implementation (Ethereum's `ecies` Go module).
### Motivation
We needed to have a JavaScript library fully compliant with the way the Go Ethereum ECIES module ([`ecies`](https://godoc.org/github.com/ethereum/go-ethereum/crypto/ecies)) was implemented. \
[Parity](https://www.parity.io/) has implemented ECIES encryption and decryption for arbitrary messages through its extended [JSON RPC API](https://wiki.parity.io/JSONRPC-parity-module.html) and has started translating it into a JavaScript library ([`ecies-parity`](https://www.npmjs.com/package/ecies-parity)). But issues remain in the latter and needed a pass to correct them.
### Implementation details
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.
### Usage
```
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);
})
})
```
### Dependencies
This library relies on the following dependencies:
- [`elliptic`](https://www.npmjs.com/package/elliptic);
- [`secp256k1`](https://www.npmjs.com/package/secp256k1).
To run the tests, you would need to install [`live-server`](https://www.npmjs.com/package/live-server):
```console
npm i -g live-server
```
### Credits
Thanks to [@Methrat0n](https://github.com/Methrat0n/) for the initial work on this adaptation.
### License
This module is distributed under a MIT license. \
See the [LICENSE](LICENSE) file.
© 2019-2024 Cyril Dever. All rights reserved.