mirror of
https://github.com/fluencelabs/js-libp2p-crypto
synced 2025-03-15 21:50:54 +00:00
1974eb92be
BREAKING CHANGE: Callback support has been dropped in favor of async/await. * feat: use async/await This PR changes this module to remove callbacks and use async/await. The API is unchanged aside from the obvious removal of the `callback` parameter. refs https://github.com/ipfs/js-ipfs/issues/1670 * fix: use latest multihashing-async as it is all promises now
127 lines
4.8 KiB
Markdown
127 lines
4.8 KiB
Markdown
# js-libp2p-crypto-secp256k1
|
|
|
|
[](http://protocol.ai)
|
|
[](http://libp2p.io/)
|
|
[](http://webchat.freenode.net/?channels=%23libp2p)
|
|
[](https://discuss.libp2p.io)
|
|
[](https://codecov.io/gh/libp2p/js-libp2p-crypto-secp256k1)
|
|
[](https://travis-ci.com/libp2p/js-libp2p-crypto-secp256k1)
|
|
[](https://david-dm.org/libp2p/js-libp2p-crypto-secp256k1)
|
|
[](https://github.com/feross/standard)
|
|
|
|
|
|
|
|
> Support for secp256k1 keys in js-libp2p-crypto
|
|
|
|
This repo contains a [js-libp2p-crypto](https://github.com/libp2p/js-libp2p-crypto)-compatible
|
|
implementation of cryptographic signature generation and verification using the
|
|
[secp256k1 elliptic curve](https://en.bitcoin.it/wiki/Secp256k1) popularized by Bitcoin and other
|
|
crypto currencies.
|
|
|
|
## Lead Captain
|
|
|
|
[Friedel Ziegelmayer](https://github.com/dignifiedquire/)
|
|
|
|
## Table of Contents
|
|
|
|
- [Install](#install)
|
|
- [Usage](#usage)
|
|
- [Example](#example)
|
|
- [API](#api)
|
|
- [`generateKeyPair([bits])`](#generatekeypairbits)
|
|
- [`unmarshalSecp256k1PublicKey(bytes)`](#unmarshalsecp256k1publickeybytes)
|
|
- [`unmarshalSecp256k1PrivateKey(bytes)`](#unmarshalsecp256k1privatekeybytes)
|
|
- [`Secp256k1PublicKey`](#secp256k1publickey)
|
|
- [`.verify(data, sig)`](#verifydata-sig)
|
|
- [`Secp256k1PrivateKey`](#secp256k1privatekey)
|
|
- [`.public`](#public)
|
|
- [`.sign(data)`](#signdata)
|
|
- [Contribute](#contribute)
|
|
- [License](#license)
|
|
|
|
## Install
|
|
|
|
```sh
|
|
npm install --save libp2p-crypto-secp256k1
|
|
```
|
|
|
|
## Usage
|
|
|
|
This module is designed to work with [js-libp2p-crypto](https://github.com/libp2p/js-libp2p-crypto).
|
|
Installing `libp2p-crypto-secp256k1` will automatically add support for the `'secp256k1'` key type, which
|
|
can be used as an argument to the [libp2p-crypto API functions](https://github.com/libp2p/js-libp2p-crypto#api)
|
|
`generateKeyPair`, `unmarshalPublicKey`, and `marshalPrivateKey`. The keys returned from those functions will be
|
|
instances of the `Secp256k1PublicKey` or `Secp256k1PrivateKey` classes provided by this module.
|
|
|
|
### Example
|
|
|
|
```js
|
|
const crypto = require('libp2p-crypto')
|
|
const msg = Buffer.from('Hello World')
|
|
|
|
const key = await crypto.generateKeyPair('secp256k1', 256)
|
|
// assuming no error, key will be an instance of Secp256k1PrivateKey
|
|
// the public key is available as key.public
|
|
const sig = await key.sign(msg)
|
|
|
|
const valid = await key.public.verify(msg, sig)
|
|
assert(valid, 'Something went horribly wrong')
|
|
```
|
|
|
|
## API
|
|
|
|
The functions below are the public API of this module.
|
|
For usage within `libp2p-crypto`, see the [`libp2p-crypto` API documentation](https://github.com/libp2p/js-libp2p-crypto#api).
|
|
|
|
### `generateKeyPair([bits])`
|
|
- `bits: Number` - Optional, included for compatibility with js-libp2p-crypto. Ignored if present; private keys will always be 256 bits.
|
|
|
|
Returns `Promise<Secp256k1PrivateKey>`
|
|
|
|
### `unmarshalSecp256k1PublicKey(bytes)`
|
|
- `bytes: Buffer`
|
|
|
|
Converts a serialized secp256k1 public key into an instance of `Secp256k1PublicKey` and returns it
|
|
|
|
### `unmarshalSecp256k1PrivateKey(bytes)`
|
|
- `bytes: Buffer`
|
|
|
|
Returns `Promise<Secp256k1PrivateKey>`
|
|
|
|
Converts a serialized secp256k1 private key into an instance of `Secp256k1PrivateKey`.
|
|
|
|
### `Secp256k1PublicKey`
|
|
|
|
#### `.verify(data, sig)`
|
|
- `data: Buffer`
|
|
- `sig: Buffer`
|
|
|
|
Returns `Promise<Boolean>`
|
|
|
|
Calculates the SHA-256 hash of `data`, and verifies the DER-encoded signature in `sig`.
|
|
|
|
### `Secp256k1PrivateKey`
|
|
|
|
#### `.public`
|
|
|
|
Accessor for the `Secp256k1PublicKey` associated with this private key.
|
|
|
|
#### `.sign(data)`
|
|
- `data: Buffer`
|
|
|
|
Returns `Promise<Buffer>`
|
|
|
|
Calculates the SHA-256 hash of `data` and signs it, resolves with the DER-encoded signature.
|
|
|
|
## Contribute
|
|
|
|
Feel free to join in. All welcome. Open an [issue](https://github.com/libp2p/js-libp2p-crypto-secp256k1/issues)!
|
|
|
|
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
|
|
|
|
[](https://github.com/ipfs/community/blob/master/contributing.md)
|
|
|
|
## License
|
|
|
|
[MIT](LICENSE)
|