Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bitpay/bitcore-ecies

A module for bitcore that implements the Elliptic Curve Integrated Encryption Scheme (ECIES).
https://github.com/bitpay/bitcore-ecies

Last synced: 3 months ago
JSON representation

A module for bitcore that implements the Elliptic Curve Integrated Encryption Scheme (ECIES).

Host: GitHub
URL: https://github.com/bitpay/bitcore-ecies
Owner: bitpay
License: mit
Created: 2014-12-16T15:24:52.000Z (almost 10 years ago)
Default Branch: master
Last Pushed: 2023-03-08T08:31:37.000Z (over 1 year ago)
Last Synced: 2024-07-16T12:20:48.170Z (4 months ago)
Language: JavaScript
Homepage:
Size: 960 KB
Stars: 57
Watchers: 20
Forks: 71
Open Issues: 7
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

awesome-cryptocoinjs - *

README

        

# ECIES for bitcore

[![NPM Package](https://img.shields.io/npm/v/bitcore-ecies.svg?style=flat-square)](https://www.npmjs.org/package/bitcore-ecies)

[![Build Status](https://img.shields.io/travis/bitpay/bitcore-ecies.svg?branch=master&style=flat-square)](https://travis-ci.org/bitpay/bitcore-ecies)

[![Coverage Status](https://img.shields.io/coveralls/bitpay/bitcore-ecies.svg?style=flat-square)](https://coveralls.io/r/bitpay/bitcore-ecies)

A module for [bitcore][bitcore] that implements the [Elliptic Curve Integrated Encryption Scheme (ECIES)][ECIES]. Uses ECIES symmetric key negotiation from public keys to encrypt arbitrarily long data streams.

See [the main bitcore repo](https://github.com/bitpay/bitcore) or the [bitcore guide on ECIES](http://bitcore.io/guide/module/ecies/index.html) for more information.

Credit to [@ryanxcharles][ryan] for the original implementation.

## Getting started

ECIES will allow to securely encrypt and decrypt messages using ECDSA key pairs (bitcoin cryptography).

```javascript

var alice = ECIES()

  .privateKey(aliceKey)

  .publicKey(bobKey.publicKey);

var message = 'some secret message';

var encrypted = alice.encrypt(message);

// encrypted will contain an encrypted buffer only Bob can decrypt

var bob = ECIES()

  .privateKey(bobKey)

  .publicKey(aliceKey.publicKey);

var decrypted = bob

  .decrypt(encrypted)

  .toString();

// decrypted will be 'some secret message'

```

## Contributing

See [CONTRIBUTING.md](https://github.com/bitpay/bitcore/blob/master/CONTRIBUTING.md) on the main bitcore repo for information about how to contribute.

## License

Code released under [the MIT license](https://github.com/bitpay/bitcore/blob/master/LICENSE).

Copyright 2013-2015 BitPay, Inc. Bitcore is a trademark maintained by BitPay, Inc.

[bitcore]: http://github.com/bitpay/bitcore

[ECIES]: http://en.wikipedia.org/wiki/Integrated_Encryption_Scheme

[ryan]: http://github.com/ryanxcharles