mirror of
https://github.com/fluencelabs/js-peer-id
synced 2025-04-28 20:02:23 +00:00
Compare commits
76 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
85dac48621 | ||
|
f3fc3449c1 | ||
|
|
927a6cf078 | ||
|
|
73fe2c553f | ||
|
719ddfe8e2 | ||
|
|
037ed87dac | ||
|
|
af47794289 | ||
|
|
eeb53305c8 | ||
|
|
5468ee0877 | ||
|
|
f895151451 | ||
|
|
e7d0eaa796 | ||
|
41ab96c47d | ||
|
4178e53db8 | ||
|
|
10ead07dd9 | ||
|
|
d940099131 | ||
|
|
b2ee34295b | ||
|
|
ecc1e5be6d | ||
|
|
153bc8ea38 | ||
|
|
d40d588776 | ||
|
224b30cb65 | ||
|
6d571ae196 | ||
|
ff4bd96467 | ||
|
|
427b46c86e | ||
|
|
d16ce9c2ac | ||
|
|
cd99cb2c7d | ||
|
|
c295329300 | ||
|
|
bb32b12395 | ||
|
6fd5ca2a12 | ||
|
|
020b963711 | ||
|
|
e3da29a440 | ||
|
|
8cd9dfb137 | ||
|
|
3598a433dc | ||
|
|
5ec88281e2 | ||
|
|
a80c481146 | ||
|
|
efc96106a4 | ||
|
|
16e1c74e9a | ||
|
c305c36b26 | ||
|
|
7e985b127f | ||
|
|
40d68cb512 | ||
|
|
1d86506c64 | ||
|
|
9dc7ce5f5e | ||
|
f775e3509b | ||
|
|
00819ba4eb | ||
|
|
6870c8c4d7 | ||
|
|
71d3a100c9 | ||
|
|
f44645ef7e | ||
|
|
a68855a5d2 | ||
|
|
d8c307a44f | ||
|
a5070aea6e | ||
|
|
fc9698476f | ||
|
|
ffe04c12a0 | ||
|
|
65e0b746a5 | ||
|
74cdb24544 | ||
|
|
b5335cd4ee | ||
|
|
519052693d | ||
|
|
bbf0416f08 | ||
|
|
4fbf859efc | ||
|
|
52bd949b43 | ||
|
544ca7d74b | ||
|
11d4ec10bd | ||
|
4d5bb2cfff | ||
|
|
a2ac32ac0f | ||
|
|
ed211a943b | ||
|
|
8ea480a3b0 | ||
|
f39fb24321 | ||
|
|
911aa634d3 | ||
|
|
94aa3483b3 | ||
|
|
1f1f86f576 | ||
|
|
76864184da | ||
|
|
f50b2ac016 | ||
|
|
6754752b05 | ||
|
17440a3f9a | ||
|
|
989b413a96 | ||
|
|
52ed9c58a5 | ||
|
c3463c7421 | ||
|
bbabd7451e |
7
.aegir.js
Normal file
7
.aegir.js
Normal file
@ -0,0 +1,7 @@
|
||||
'use strict'
|
||||
|
||||
module.exports = {
|
||||
bundlesize: {
|
||||
maxSize: '140kB'
|
||||
}
|
||||
}
|
||||
45
.travis.yml
Normal file
45
.travis.yml
Normal file
@ -0,0 +1,45 @@
|
||||
language: node_js
|
||||
cache: npm
|
||||
stages:
|
||||
- check
|
||||
- test
|
||||
- cov
|
||||
|
||||
node_js:
|
||||
- '10'
|
||||
|
||||
os:
|
||||
- linux
|
||||
- osx
|
||||
|
||||
script: npx nyc -s npm run test:node -- --bail
|
||||
after_success: npx nyc report --reporter=text-lcov > coverage.lcov && npx codecov
|
||||
|
||||
jobs:
|
||||
include:
|
||||
- os: windows
|
||||
cache: false
|
||||
|
||||
- stage: check
|
||||
script:
|
||||
- npx aegir dep-check
|
||||
- npm run lint
|
||||
|
||||
- stage: test
|
||||
name: chrome
|
||||
addons:
|
||||
chrome: stable
|
||||
script:
|
||||
- npx aegir test -t browser
|
||||
- npx aegir test -t webworker
|
||||
|
||||
- stage: test
|
||||
name: firefox
|
||||
addons:
|
||||
firefox: latest
|
||||
script:
|
||||
- npx aegir test -t browser -- --browsers FirefoxHeadless
|
||||
- npx aegir test -t webworker -- --browsers FirefoxHeadless
|
||||
|
||||
notifications:
|
||||
email: false
|
||||
204
CHANGELOG.md
204
CHANGELOG.md
@ -1,3 +1,207 @@
|
||||
## [0.14.6](https://github.com/libp2p/js-peer-id/compare/v0.14.4...v0.14.6) (2021-04-06)
|
||||
|
||||
|
||||
|
||||
## [0.14.4](https://github.com/libp2p/js-peer-id/compare/v0.14.3...v0.14.4) (2021-03-29)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* remove toString side effect that breaks deep equals ([#142](https://github.com/libp2p/js-peer-id/issues/142)) ([eeb5330](https://github.com/libp2p/js-peer-id/commit/eeb53305c8767a6a2b3f610fe9e45a589b4fa972)), closes [#141](https://github.com/libp2p/js-peer-id/issues/141)
|
||||
|
||||
|
||||
|
||||
## [0.14.3](https://github.com/libp2p/js-peer-id/compare/v0.14.2...v0.14.3) (2021-01-26)
|
||||
|
||||
|
||||
|
||||
<a name="0.14.2"></a>
|
||||
## [0.14.2](https://github.com/libp2p/js-peer-id/compare/v0.14.1...v0.14.2) (2020-09-23)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* has inline public key method ([#132](https://github.com/libp2p/js-peer-id/issues/132)) ([b2ee342](https://github.com/libp2p/js-peer-id/commit/b2ee342))
|
||||
|
||||
|
||||
|
||||
<a name="0.14.1"></a>
|
||||
## [0.14.1](https://github.com/libp2p/js-peer-id/compare/v0.13.13...v0.14.1) (2020-09-03)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* privKey possible undefined ([#129](https://github.com/libp2p/js-peer-id/issues/129)) ([224b30c](https://github.com/libp2p/js-peer-id/commit/224b30c))
|
||||
* replace node buffers with uint8arrays ([#127](https://github.com/libp2p/js-peer-id/issues/127)) ([d16ce9c](https://github.com/libp2p/js-peer-id/commit/d16ce9c))
|
||||
* ts constructor types ([#130](https://github.com/libp2p/js-peer-id/issues/130)) ([d40d588](https://github.com/libp2p/js-peer-id/commit/d40d588))
|
||||
* typo in readme ([#128](https://github.com/libp2p/js-peer-id/issues/128)) ([6d571ae](https://github.com/libp2p/js-peer-id/commit/6d571ae))
|
||||
|
||||
|
||||
### BREAKING CHANGES
|
||||
|
||||
* - Where node Buffers were returned, now Uint8Arrays are
|
||||
|
||||
* chore: remove gh dep
|
||||
|
||||
|
||||
|
||||
<a name="0.14.0"></a>
|
||||
# [0.14.0](https://github.com/libp2p/js-peer-id/compare/v0.13.13...v0.14.0) (2020-08-07)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* replace node buffers with uint8arrays ([#127](https://github.com/libp2p/js-peer-id/issues/127)) ([d16ce9c](https://github.com/libp2p/js-peer-id/commit/d16ce9c))
|
||||
|
||||
|
||||
### BREAKING CHANGES
|
||||
|
||||
* - Where node Buffers were returned, now Uint8Arrays are
|
||||
|
||||
* chore: remove gh dep
|
||||
|
||||
|
||||
|
||||
<a name="0.13.13"></a>
|
||||
## [0.13.13](https://github.com/libp2p/js-peer-id/compare/v0.13.12...v0.13.13) (2020-06-23)
|
||||
|
||||
|
||||
|
||||
<a name="0.13.12"></a>
|
||||
## [0.13.12](https://github.com/libp2p/js-peer-id/compare/v0.13.11...v0.13.12) (2020-04-22)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **cli:** add support for specifying type and size ([#122](https://github.com/libp2p/js-peer-id/issues/122)) ([8cd9dfb](https://github.com/libp2p/js-peer-id/commit/8cd9dfb))
|
||||
|
||||
|
||||
|
||||
<a name="0.13.11"></a>
|
||||
## [0.13.11](https://github.com/libp2p/js-peer-id/compare/v0.13.10...v0.13.11) (2020-03-26)
|
||||
|
||||
|
||||
|
||||
<a name="0.13.10"></a>
|
||||
## [0.13.10](https://github.com/libp2p/js-peer-id/compare/v0.13.9...v0.13.10) (2020-03-18)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* add buffer ([#120](https://github.com/libp2p/js-peer-id/issues/120)) ([c305c36](https://github.com/libp2p/js-peer-id/commit/c305c36))
|
||||
|
||||
|
||||
|
||||
<a name="0.13.9"></a>
|
||||
## [0.13.9](https://github.com/libp2p/js-peer-id/compare/v0.13.8...v0.13.9) (2020-02-19)
|
||||
|
||||
|
||||
|
||||
<a name="0.13.8"></a>
|
||||
## [0.13.8](https://github.com/libp2p/js-peer-id/compare/v0.13.6...v0.13.8) (2020-02-18)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* remove use of assert module ([#117](https://github.com/libp2p/js-peer-id/issues/117)) ([f44645e](https://github.com/libp2p/js-peer-id/commit/f44645e))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* adds typescript types + type tests ([#110](https://github.com/libp2p/js-peer-id/issues/110)) ([a5070ae](https://github.com/libp2p/js-peer-id/commit/a5070ae))
|
||||
|
||||
|
||||
|
||||
<a name="0.13.7"></a>
|
||||
## [0.13.7](https://github.com/libp2p/js-peer-id/compare/v0.13.6...v0.13.7) (2020-01-27)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* adds typescript types + type tests ([#110](https://github.com/libp2p/js-peer-id/issues/110)) ([a5070ae](https://github.com/libp2p/js-peer-id/commit/a5070ae))
|
||||
|
||||
|
||||
|
||||
<a name="0.13.6"></a>
|
||||
## [0.13.6](https://github.com/libp2p/js-peer-id/compare/v0.13.5...v0.13.6) (2019-12-18)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* catch errors thrown by multihash decode ([#109](https://github.com/libp2p/js-peer-id/issues/109)) ([65e0b74](https://github.com/libp2p/js-peer-id/commit/65e0b74))
|
||||
|
||||
|
||||
|
||||
<a name="0.13.5"></a>
|
||||
## [0.13.5](https://github.com/libp2p/js-peer-id/compare/v0.13.4...v0.13.5) (2019-11-12)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* deprecate isEqual in favor of equals ([#107](https://github.com/libp2p/js-peer-id/issues/107)) ([bbf0416](https://github.com/libp2p/js-peer-id/commit/bbf0416))
|
||||
|
||||
|
||||
|
||||
<a name="0.13.4"></a>
|
||||
## [0.13.4](https://github.com/libp2p/js-peer-id/compare/v0.13.3...v0.13.4) (2019-11-04)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* bang in bin.js ([#106](https://github.com/libp2p/js-peer-id/issues/106)) ([11d4ec1](https://github.com/libp2p/js-peer-id/commit/11d4ec1))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* support Peer ID represented as CID ([#105](https://github.com/libp2p/js-peer-id/issues/105)) ([544ca7d](https://github.com/libp2p/js-peer-id/commit/544ca7d))
|
||||
|
||||
|
||||
|
||||
<a name="0.13.3"></a>
|
||||
## [0.13.3](https://github.com/libp2p/js-peer-id/compare/v0.13.2...v0.13.3) (2019-09-25)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* allow nested PeerIds to support pubKey function when using identity encoding ([#101](https://github.com/libp2p/js-peer-id/issues/101)) ([f39fb24](https://github.com/libp2p/js-peer-id/commit/f39fb24))
|
||||
|
||||
|
||||
|
||||
<a name="0.13.2"></a>
|
||||
## [0.13.2](https://github.com/libp2p/js-peer-id/compare/v0.13.1...v0.13.2) (2019-07-12)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add compact protobuf format ([#76](https://github.com/libp2p/js-peer-id/issues/76)) ([7686418](https://github.com/libp2p/js-peer-id/commit/7686418))
|
||||
|
||||
|
||||
|
||||
<a name="0.13.1"></a>
|
||||
## [0.13.1](https://github.com/libp2p/js-peer-id/compare/v0.13.0...v0.13.1) (2019-07-11)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **peerid:** support creating from secp256k1; harmonize algo with Go ([#95](https://github.com/libp2p/js-peer-id/issues/95)) ([17440a3](https://github.com/libp2p/js-peer-id/commit/17440a3))
|
||||
|
||||
|
||||
|
||||
<a name="0.13.0"></a>
|
||||
# [0.13.0](https://github.com/libp2p/js-peer-id/compare/v0.12.2...v0.13.0) (2019-07-11)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* async await ([#87](https://github.com/libp2p/js-peer-id/issues/87)) ([c3463c7](https://github.com/libp2p/js-peer-id/commit/c3463c7))
|
||||
|
||||
|
||||
### BREAKING CHANGES
|
||||
|
||||
* API refactored to use async/await
|
||||
|
||||
|
||||
|
||||
<a name="0.12.2"></a>
|
||||
## [0.12.2](https://github.com/libp2p/js-peer-id/compare/v0.12.1...v0.12.2) (2019-01-09)
|
||||
|
||||
|
||||
122
README.md
122
README.md
@ -1,22 +1,25 @@
|
||||
# peer-id
|
||||
|
||||
[](http://ipn.io)
|
||||
[](http://webchat.freenode.net/?channels=%23ipfs)
|
||||
[](https://travis-ci.org/libp2p/js-peer-id)
|
||||
[](https://coveralls.io/github/libp2p/js-peer-id?branch=master)
|
||||
[](http://protocol.ai)
|
||||
[](http://libp2p.io/)
|
||||
[](http://webchat.freenode.net/?channels=%23libp2p)
|
||||
[](https://discuss.libp2p.io)
|
||||
[](https://codecov.io/gh/libp2p/js-peer-id)
|
||||
[](https://travis-ci.com/libp2p/js-peer-id)
|
||||
[](https://david-dm.org/libp2p/js-peer-id)
|
||||
[](https://github.com/feross/standard)
|
||||
|
||||
|
||||
|
||||
> [IPFS](https://github.com/ipfs/ipfs) Peer ID implementation in JavaScript.
|
||||
|
||||
## Lead Maintainer
|
||||
|
||||
[Pedro Teixeira](https://github.com/pgte)
|
||||
[Vasco Santos](https://github.com/vasco-santos)
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [peer-id](#peer-id)
|
||||
- [Lead Maintainer](#lead-maintainer)
|
||||
- [Table of Contents](#table-of-contents)
|
||||
- [Description](#description)
|
||||
- [Example](#example)
|
||||
- [Installation](#installation)
|
||||
@ -25,23 +28,33 @@
|
||||
- [Node.js](#nodejs)
|
||||
- [Browser: Browserify, Webpack, other bundlers](#browser-browserify-webpack-other-bundlers)
|
||||
- [Browser: `<script>` Tag](#browser-script-tag)
|
||||
- [CLI](#cli)
|
||||
- [API](#api)
|
||||
- [Create](#create)
|
||||
- [`new PeerId(id[, privKey, pubKey])`](#new-peeridid-privkey-pubkey)
|
||||
- [`create([opts], callback)`](#createopts-callback)
|
||||
- [`create([opts])`](#createopts)
|
||||
- [Import](#import)
|
||||
- [`createFromHexString(str)`](#createfromhexstringstr)
|
||||
- [`createFromBytes(buf)`](#createfrombytesbuf)
|
||||
- [`createFromCID(cid)`](#createfromcidcid)
|
||||
- [`createFromB58String(str)`](#createfromb58stringstr)
|
||||
- [`createFromPubKey(pubKey)`](#createfrompubkeypubkey)
|
||||
- [`createFromPrivKey(privKey)`](#createfromprivkeyprivkey)
|
||||
- [`createFromJSON(obj)`](#createfromjsonobj)
|
||||
- [`createFromProtobuf(buf)`](#createfromprotobufbuf)
|
||||
- [Export](#export)
|
||||
- [`toHexString()`](#tohexstring)
|
||||
- [`toBytes()`](#tobytes)
|
||||
- [`toString()`](#tostring)
|
||||
- [`toB58String()`](#tob58string)
|
||||
- [`toJSON()`](#tojson)
|
||||
- [`marshal(excludePrivateKey)`](#marshalexcludeprivatekey)
|
||||
- [`marshalPubKey()`](#marshalpubkey)
|
||||
- [`toPrint()`](#toprint)
|
||||
- [`equals(id)`](#equalsid)
|
||||
- [`isEqual(id)`](#isequalid)
|
||||
- [Others](#others)
|
||||
- [`isPeerId(id)`](#ispeeridid)
|
||||
- [License](#license)
|
||||
|
||||
# Description
|
||||
@ -57,11 +70,10 @@ The public key is a base64 encoded string of a protobuf containing an RSA DER bu
|
||||
```JavaScript
|
||||
const PeerId = require('peer-id')
|
||||
|
||||
PeerId.create({ bits: 1024 }, (err, id) => {
|
||||
if (err) { throw err }
|
||||
const id = await PeerId.create({ bits: 1024, keyType: 'RSA' })
|
||||
console.log(JSON.stringify(id.toJSON(), null, 2))
|
||||
})
|
||||
```
|
||||
|
||||
```bash
|
||||
{
|
||||
"id": "Qma9T5YraSnpRDZqRR4krcSJabThc8nwZuJV3LercPHufi",
|
||||
@ -108,6 +120,14 @@ the global namespace.
|
||||
<script src="https://unpkg.com/peer-id/dist/index.js"></script>
|
||||
```
|
||||
|
||||
# CLI
|
||||
|
||||
After installing `peer-id`, `npm install peer-id`, you can leverage the cli to generate keys exported as JSON. You can specify the type for the key and size, as detailed in [`create([opts])`](#createopts). The defaults are shown here.
|
||||
|
||||
```sh
|
||||
> peer-id --type rsa --bits 2048
|
||||
```
|
||||
|
||||
# API
|
||||
|
||||
```js
|
||||
@ -118,20 +138,20 @@ const PeerId = require('peer-id')
|
||||
|
||||
### `new PeerId(id[, privKey, pubKey])`
|
||||
|
||||
- `id: Buffer` - The multihash of the publick key as `Buffer`
|
||||
- `id: Buffer` - The multihash of the public key as `Buffer`
|
||||
- `privKey: RsaPrivateKey` - The private key
|
||||
- `pubKey: RsaPublicKey` - The public key
|
||||
|
||||
The key format is detailed in [libp2p-crypto](https://github.com/libp2p/js-libp2p-crypto).
|
||||
|
||||
### `create([opts], callback)`
|
||||
### `create([opts])`
|
||||
|
||||
Generates a new Peer ID, complete with public/private keypair.
|
||||
|
||||
- `opts: Object`: Default: `{bits: 2048}`
|
||||
- `callback: Function`
|
||||
- `opts.bits: number` - The size of the key. Default: `2048`
|
||||
- `opts.keyType: string` - The key type, one of: `['RSA', 'Ed25519', 'secp256k1']`. Default: `RSA`
|
||||
|
||||
Calls back `callback` with `err, id`.
|
||||
Returns `Promise<PeerId>`.
|
||||
|
||||
## Import
|
||||
|
||||
@ -139,32 +159,56 @@ Calls back `callback` with `err, id`.
|
||||
|
||||
Creates a Peer ID from hex string representing the key's multihash.
|
||||
|
||||
Returns `PeerId`.
|
||||
|
||||
### `createFromBytes(buf)`
|
||||
|
||||
Creates a Peer ID from a buffer representing the key's multihash.
|
||||
|
||||
Returns `PeerId`.
|
||||
|
||||
### `createFromCID(cid)`
|
||||
|
||||
- `cid: CID|String|Buffer` - The multihash encoded as [CID](https://github.com/ipld/js-cid) (object, `String` or `Buffer`)
|
||||
|
||||
Creates a Peer ID from a CID representation of the key's multihash ([RFC 0001](https://github.com/libp2p/specs/blob/master/RFC/0001-text-peerid-cid.md)).
|
||||
|
||||
Returns `PeerId`.
|
||||
|
||||
### `createFromB58String(str)`
|
||||
|
||||
Creates a Peer ID from a Base58 string representing the key's multihash.
|
||||
|
||||
Returns `PeerId`.
|
||||
|
||||
### `createFromPubKey(pubKey)`
|
||||
|
||||
- `publicKey: Buffer`
|
||||
|
||||
Creates a Peer ID from a buffer containing a public key.
|
||||
|
||||
Returns `Promise<PeerId>`.
|
||||
|
||||
### `createFromPrivKey(privKey)`
|
||||
|
||||
- `privKey: Buffer`
|
||||
|
||||
Creates a Peer ID from a buffer containing a private key.
|
||||
|
||||
Returns `Promise<PeerId>`.
|
||||
|
||||
### `createFromJSON(obj)`
|
||||
|
||||
- `obj.id: String` - The multihash encoded in `base58`
|
||||
- `obj.pubKey: String` - The public key in protobuf format, encoded in `base64`
|
||||
- `obj.privKey: String` - The private key in protobuf format, encoded in `base64`
|
||||
|
||||
Returns `Promise<PeerId>`.
|
||||
|
||||
### `createFromProtobuf(buf)`
|
||||
|
||||
`buf` is a protocol-buffers encoded PeerId (see `marshal()`)
|
||||
|
||||
## Export
|
||||
|
||||
### `toHexString()`
|
||||
@ -183,9 +227,18 @@ Returns the Peer ID's `id` as a buffer.
|
||||
<Buffer 12 20 d6 24 39 98 f2 fc 56 34 3a d7 ed 03 42 ab 78 86 a4 eb 18 d7 36 f1 b6 7d 44 b3 7f cc 81 e0 f3 9f>
|
||||
```
|
||||
|
||||
|
||||
### `toString()`
|
||||
|
||||
Returns the Peer ID's `id` as a self-describing CIDv1 in Base32 ([RFC 0001](https://github.com/libp2p/specs/blob/master/RFC/0001-text-peerid-cid.md))
|
||||
|
||||
```
|
||||
bafzbeigweq4zr4x4ky2dvv7nanbkw6egutvrrvzw6g3h2rftp7gidyhtt4
|
||||
```
|
||||
|
||||
### `toB58String()`
|
||||
|
||||
Returns the Peer ID's `id` as a base58 string.
|
||||
Returns the Peer ID's `id` as a base58 string (multihash/CIDv0).
|
||||
|
||||
```
|
||||
QmckZzdVd72h9QUFuJJpQqhsZqGLwjhh81qSvZ9BhB2FQi
|
||||
@ -199,16 +252,49 @@ Returns an `obj` of the form
|
||||
- `obj.pubKey: String` - The public key in protobuf format, encoded in 'base64'
|
||||
- `obj.privKey: String` - The private key in protobuf format, encoded in 'base 64'
|
||||
|
||||
### `marshal(excludePrivateKey)`
|
||||
|
||||
Returns a protocol-buffers encoded version of the id, public key and, if `excludePrivateKey` is not set, the private key.
|
||||
|
||||
### `marshalPubKey()`
|
||||
|
||||
Returns a protobuf of just the public key, compatible with `libp2p-crypto` (unlike `marshal` above).
|
||||
|
||||
For example:
|
||||
```js
|
||||
const crypto = require('libp2p-crypto')
|
||||
|
||||
PeerId.create({ bits: 256, keyType: 'ed25519' }).then( pid => {
|
||||
let pk = crypto.keys.unmarshalPublicKey(pid.marshalPubKey())
|
||||
// your code here
|
||||
}
|
||||
```
|
||||
|
||||
### `toPrint()`
|
||||
|
||||
Returns the Peer ID as a printable string without the `Qm` prefix.
|
||||
|
||||
Example: `<peer.ID xxxxxx>`
|
||||
|
||||
### `isEqual(id)`
|
||||
### `equals(id)`
|
||||
|
||||
Returns `true` if the given PeerId is equal to the current instance.
|
||||
|
||||
- `id` can be a PeerId or a Buffer containing the id
|
||||
|
||||
### `isEqual(id)`
|
||||
**Deprecation Notice**: Use [`equals`](#equalsid), `isEqual` will be removed in 0.14.0.
|
||||
|
||||
- `id` can be a PeerId or a Buffer containing the id
|
||||
|
||||
## Others
|
||||
|
||||
### `isPeerId(id)`
|
||||
|
||||
Returns `true` if the given id is an instance of PeerId
|
||||
|
||||
- `id` should be an instance of PeerId
|
||||
|
||||
# License
|
||||
|
||||
MIT
|
||||
|
||||
2
ci/Jenkinsfile
vendored
2
ci/Jenkinsfile
vendored
@ -1,2 +0,0 @@
|
||||
// Warning: This file is automatically synced from https://github.com/ipfs/ci-sync so if you want to change it, please change it there and ask someone to sync all repositories.
|
||||
javascript()
|
||||
57
package.json
57
package.json
@ -1,21 +1,23 @@
|
||||
{
|
||||
"name": "peer-id",
|
||||
"version": "0.12.2",
|
||||
"version": "0.14.6",
|
||||
"description": "IPFS Peer Id implementation in Node.js",
|
||||
"leadMaintainer": "Pedro Teixeira <i@pgte.me>",
|
||||
"leadMaintainer": "Vasco Santos <santos.vasco10@gmail.com>",
|
||||
"main": "src/index.js",
|
||||
"types": "src/index.d.ts",
|
||||
"bin": "src/bin.js",
|
||||
"scripts": {
|
||||
"lint": "aegir lint",
|
||||
"build": "aegir build",
|
||||
"build": "aegir build --no-types",
|
||||
"test": "aegir test",
|
||||
"test:node": "aegir test -t node",
|
||||
"test:browser": "aegir test -t browser -t webworker",
|
||||
"release": "aegir release",
|
||||
"test:types": "npx tsc",
|
||||
"release": "aegir release --no-types",
|
||||
"release-minor": "aegir release --type minor",
|
||||
"release-major": "aegir release --type major",
|
||||
"coverage": "aegir coverage",
|
||||
"size": "bundlesize -f dist/index.min.js -s 140kB"
|
||||
"size": "aegir build -b"
|
||||
},
|
||||
"files": [
|
||||
"src",
|
||||
@ -34,16 +36,19 @@
|
||||
},
|
||||
"homepage": "https://github.com/libp2p/js-peer-id",
|
||||
"devDependencies": {
|
||||
"aegir": "^18.0.2",
|
||||
"bundlesize": "~0.17.0",
|
||||
"chai": "^4.2.0",
|
||||
"dirty-chai": "^2.0.1"
|
||||
"@types/chai": "^4.2.14",
|
||||
"@types/dirty-chai": "^2.0.2",
|
||||
"@types/mocha": "^8.2.0",
|
||||
"aegir": "^32.2.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"async": "^2.6.1",
|
||||
"cids": "^1.1.6",
|
||||
"class-is": "^1.1.0",
|
||||
"libp2p-crypto": "~0.16.0",
|
||||
"multihashes": "~0.4.13"
|
||||
"libp2p-crypto": "fluencelabs/js-libp2p-crypto",
|
||||
"minimist": "^1.2.5",
|
||||
"multihashes": "^4.0.2",
|
||||
"protons": "^2.0.0",
|
||||
"uint8arrays": "^2.1.4"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
@ -51,21 +56,31 @@
|
||||
},
|
||||
"contributors": [
|
||||
"David Dias <daviddias.p@gmail.com>",
|
||||
"David Dias <mail@daviddias.me>",
|
||||
"Friedel Ziegelmayer <dignifiedquire@gmail.com>",
|
||||
"Vasco Santos <vasco.santos@moxy.studio>",
|
||||
"nginnever <ginneversource@gmail.com>",
|
||||
"dignifiedquire <dignifiedquire@gmail.com>",
|
||||
"Jacob Heun <jacobheun@gmail.com>",
|
||||
"Pedro Teixeira <i@pgte.me>",
|
||||
"Stephen Whitmore <stephen.whitmore@gmail.com>",
|
||||
"Alex Potsides <alex@achingbrain.net>",
|
||||
"Hugo Dias <hugomrdias@gmail.com>",
|
||||
"Maciej Krüger <mkg20001@gmail.com>",
|
||||
"Nate Foss <npfoss@gmail.com>",
|
||||
"Robert Kiel <robert.kiel@validitylabs.org>",
|
||||
"Adam Uhlíř <adam@uhlir.dev>",
|
||||
"ᴠɪᴄᴛᴏʀ ʙᴊᴇʟᴋʜᴏʟᴍ <victorbjelkholm@gmail.com>",
|
||||
"Arve Knudsen <arve.knudsen@gmail.com>",
|
||||
"Carson Farmer <carson.farmer@gmail.com>",
|
||||
"Christian Paul <info@jaller.de>",
|
||||
"Henrique Dias <hacdias@gmail.com>",
|
||||
"Marcin Rataj <lidel@lidel.org>",
|
||||
"Michael Garvin <gar+gh@danger.computer>",
|
||||
"Pedro Teixeira <i@pgte.me>",
|
||||
"Prashanth Chandra <coolshanth94@gmail.com>",
|
||||
"Richard Littauer <richard.littauer@gmail.com>",
|
||||
"Richard Schneider <makaretu@gmail.com>",
|
||||
"Stephen Whitmore <stephen.whitmore@gmail.com>",
|
||||
"Vasco Santos <vasco.santos@moxy.studio>",
|
||||
"Topper Bowers <topper@quorumcontrol.com>",
|
||||
"Vojtech Simetka <vojtech@simetka.cz>",
|
||||
"Yahya <ya7yaz@gmail.com>",
|
||||
"greenkeeperio-bot <support@greenkeeper.io>",
|
||||
"nginnever <ginneversource@gmail.com>",
|
||||
"npmcdn-to-unpkg-bot <npmcdn-to-unpkg-bot@users.noreply.github.com>",
|
||||
"ᴠɪᴄᴛᴏʀ ʙᴊᴇʟᴋʜᴏʟᴍ <victorbjelkholm@gmail.com>"
|
||||
"a1300 <matthias-knopp@gmx.net>"
|
||||
]
|
||||
}
|
||||
|
||||
15
src/bin.js
15
src/bin.js
@ -1,13 +1,16 @@
|
||||
#!/usr/local/bin/node
|
||||
#!/usr/bin/env node
|
||||
|
||||
'use strict'
|
||||
|
||||
const PeerId = require('./index.js')
|
||||
const argv = require('minimist')(process.argv.slice(2))
|
||||
|
||||
PeerId.create((err, id) => {
|
||||
if (err) {
|
||||
throw err
|
||||
async function main () {
|
||||
const id = await PeerId.create({
|
||||
keyType: argv.type,
|
||||
bits: argv.bits
|
||||
})
|
||||
console.log(JSON.stringify(id.toJSON(), null, 2)) // eslint-disable-line no-console
|
||||
}
|
||||
|
||||
console.log(JSON.stringify(id.toJSON(), null, 2))
|
||||
})
|
||||
main()
|
||||
|
||||
193
src/index.d.ts
vendored
Normal file
193
src/index.d.ts
vendored
Normal file
@ -0,0 +1,193 @@
|
||||
import { PrivateKey, PublicKey, KeyType } from "libp2p-crypto";
|
||||
import CID from 'cids'
|
||||
|
||||
declare namespace PeerId {
|
||||
/**
|
||||
* Options for PeerId creation.
|
||||
*/
|
||||
type CreateOptions = {
|
||||
/**
|
||||
* The number of bits to use.
|
||||
*/
|
||||
bits?: number;
|
||||
/**
|
||||
* The type of key to use.
|
||||
*/
|
||||
keyType?: KeyType;
|
||||
};
|
||||
|
||||
/**
|
||||
* PeerId JSON format.
|
||||
*/
|
||||
type JSONPeerId = {
|
||||
/**
|
||||
* String representation of PeerId.
|
||||
*/
|
||||
id: string;
|
||||
/**
|
||||
* Public key.
|
||||
*/
|
||||
pubKey?: string;
|
||||
/**
|
||||
* Private key.
|
||||
*/
|
||||
privKey?: string;
|
||||
};
|
||||
|
||||
/**
|
||||
* Checks if a value is an instance of PeerId.
|
||||
* @param id The value to check.
|
||||
*/
|
||||
function isPeerId(id: any): id is PeerId
|
||||
|
||||
/**
|
||||
* Create a new PeerId.
|
||||
* @param opts Options.
|
||||
*/
|
||||
function create(opts?: PeerId.CreateOptions): Promise<PeerId>;
|
||||
|
||||
/**
|
||||
* Create PeerId from hex string.
|
||||
* @param str The input hex string.
|
||||
*/
|
||||
function createFromHexString(str: string): PeerId;
|
||||
|
||||
/**
|
||||
* Create PeerId from raw bytes.
|
||||
* @param buf The raw bytes.
|
||||
*/
|
||||
function createFromBytes(buf: Uint8Array): PeerId;
|
||||
|
||||
/**
|
||||
* Create PeerId from base58-encoded string.
|
||||
* @param str The base58-encoded string.
|
||||
*/
|
||||
function createFromB58String(str: string): PeerId;
|
||||
|
||||
/**
|
||||
* Create PeerId from CID.
|
||||
* @param cid The CID.
|
||||
*/
|
||||
function createFromCID(cid: CID | Uint8Array | string | object): PeerId;
|
||||
|
||||
/**
|
||||
* Create PeerId from public key.
|
||||
* @param key Public key, as Uint8Array or base64-encoded string.
|
||||
*/
|
||||
function createFromPubKey(key: Uint8Array | string): Promise<PeerId>;
|
||||
|
||||
/**
|
||||
* Create PeerId from private key.
|
||||
* @param key Private key, as Uint8Array or base64-encoded string.
|
||||
*/
|
||||
function createFromPrivKey(key: Uint8Array | string): Promise<PeerId>;
|
||||
|
||||
/**
|
||||
* Create PeerId from PeerId JSON formatted object.
|
||||
* @see {@link PeerId#toJSON}
|
||||
* @param json PeerId in JSON format.
|
||||
*/
|
||||
function createFromJSON(json: JSONPeerId): Promise<PeerId>;
|
||||
|
||||
/**
|
||||
* Create PeerId from Protobuf bytes.
|
||||
* @param buf Protobuf bytes, as Uint8Array or hex-encoded string.
|
||||
*/
|
||||
function createFromProtobuf(buf: Uint8Array | string): Promise<PeerId>;
|
||||
}
|
||||
|
||||
/**
|
||||
* PeerId is an object representation of a peer identifier.
|
||||
*/
|
||||
declare class PeerId {
|
||||
constructor(id: Uint8Array, privKey?: PrivateKey, pubKey?: PublicKey);
|
||||
|
||||
/**
|
||||
* Raw id.
|
||||
*/
|
||||
readonly id: Uint8Array;
|
||||
|
||||
/**
|
||||
* Private key.
|
||||
*/
|
||||
privKey: PrivateKey;
|
||||
|
||||
/**
|
||||
* Public key.
|
||||
*/
|
||||
pubKey: PublicKey;
|
||||
|
||||
/**
|
||||
* Return the protobuf version of the public key, matching go ipfs formatting.
|
||||
*/
|
||||
marshalPubKey(): Uint8Array;
|
||||
|
||||
/**
|
||||
* Return the protobuf version of the private key, matching go ipfs formatting.
|
||||
*/
|
||||
marshalPrivKey(): Uint8Array;
|
||||
|
||||
/**
|
||||
* Return the protobuf version of the peer-id.
|
||||
* @param excludePriv Whether to exclude the private key information from the output.
|
||||
*/
|
||||
marshal(excludePriv?: boolean): Uint8Array;
|
||||
|
||||
/**
|
||||
* String representation.
|
||||
*/
|
||||
toPrint(): string;
|
||||
|
||||
/**
|
||||
* Return the jsonified version of the key.
|
||||
* Matches the formatting of go-ipfs for its config file.
|
||||
* @see {@link PeerId.createFromJSON}
|
||||
*/
|
||||
toJSON(): PeerId.JSONPeerId;
|
||||
|
||||
/**
|
||||
* Encode to hex.
|
||||
*/
|
||||
toHexString(): string;
|
||||
|
||||
/**
|
||||
* Return raw id bytes.
|
||||
*/
|
||||
toBytes(): Uint8Array;
|
||||
|
||||
/**
|
||||
* Encode to base58 string.
|
||||
*/
|
||||
toB58String(): string;
|
||||
|
||||
/**
|
||||
* Return self-describing string representation.
|
||||
* Uses default format from RFC 0001: https://github.com/libp2p/specs/pull/209
|
||||
*/
|
||||
toString(): string;
|
||||
|
||||
/**
|
||||
* Checks the equality of `this` peer against a given PeerId.
|
||||
* @param id The other PeerId.
|
||||
*/
|
||||
equals(id: PeerId | Uint8Array): boolean;
|
||||
|
||||
/**
|
||||
* Checks the equality of `this` peer against a given PeerId.
|
||||
* @deprecated Use {.equals}
|
||||
* @param id The other PeerId.
|
||||
*/
|
||||
isEqual(id: PeerId | Uint8Array): boolean;
|
||||
|
||||
/**
|
||||
* Check if this PeerId instance is valid (privKey -> pubKey -> Id)
|
||||
*/
|
||||
isValid(): boolean;
|
||||
|
||||
/**
|
||||
* Check if the PeerId has an inline public key.
|
||||
*/
|
||||
hasInlinePublicKey(): boolean;
|
||||
}
|
||||
|
||||
export = PeerId;
|
||||
324
src/index.js
324
src/index.js
@ -5,17 +5,22 @@
|
||||
'use strict'
|
||||
|
||||
const mh = require('multihashes')
|
||||
const CID = require('cids')
|
||||
const cryptoKeys = require('libp2p-crypto/src/keys')
|
||||
const assert = require('assert')
|
||||
const waterfall = require('async/waterfall')
|
||||
const withIs = require('class-is')
|
||||
const { PeerIdProto } = require('./proto')
|
||||
const uint8ArrayEquals = require('uint8arrays/equals')
|
||||
const uint8ArrayFromString = require('uint8arrays/from-string')
|
||||
const uint8ArrayToString = require('uint8arrays/to-string')
|
||||
|
||||
class PeerId {
|
||||
constructor (id, privKey, pubKey) {
|
||||
assert(Buffer.isBuffer(id), 'invalid id provided')
|
||||
if (!(id instanceof Uint8Array)) {
|
||||
throw new Error('invalid id provided')
|
||||
}
|
||||
|
||||
if (privKey && pubKey) {
|
||||
assert(privKey.public.bytes.equals(pubKey.bytes), 'inconsistent arguments')
|
||||
if (privKey && pubKey && !uint8ArrayEquals(privKey.public.bytes, pubKey.bytes)) {
|
||||
throw new Error('inconsistent arguments')
|
||||
}
|
||||
|
||||
this._id = id
|
||||
@ -48,6 +53,18 @@ class PeerId {
|
||||
if (this._privKey) {
|
||||
return this._privKey.public
|
||||
}
|
||||
|
||||
try {
|
||||
const decoded = mh.decode(this.id)
|
||||
|
||||
if (decoded.name === 'identity') {
|
||||
this._pubKey = cryptoKeys.unmarshalPublicKey(decoded.digest)
|
||||
}
|
||||
} catch (_) {
|
||||
// Ignore, there is no valid public key
|
||||
}
|
||||
|
||||
return this._pubKey
|
||||
}
|
||||
|
||||
set pubKey (pubKey) {
|
||||
@ -68,6 +85,15 @@ class PeerId {
|
||||
}
|
||||
}
|
||||
|
||||
// Return the protobuf version of the peer-id
|
||||
marshal (excludePriv) {
|
||||
return PeerIdProto.encode({
|
||||
id: this.toBytes(),
|
||||
pubKey: this.marshalPubKey(),
|
||||
privKey: excludePriv ? null : this.marshalPrivKey()
|
||||
})
|
||||
}
|
||||
|
||||
toPrint () {
|
||||
let pid = this.toB58String()
|
||||
// All sha256 nodes start with Qm
|
||||
@ -106,189 +132,235 @@ class PeerId {
|
||||
return this._idB58String
|
||||
}
|
||||
|
||||
isEqual (id) {
|
||||
if (Buffer.isBuffer(id)) {
|
||||
return this.id.equals(id)
|
||||
// return self-describing String representation
|
||||
// in default format from RFC 0001: https://github.com/libp2p/specs/pull/209
|
||||
toString () {
|
||||
if (!this._idCIDString) {
|
||||
const cid = new CID(1, 'libp2p-key', this.id, 'base32')
|
||||
|
||||
Object.defineProperty(this, '_idCIDString', {
|
||||
value: cid.toBaseEncodedString('base32'),
|
||||
enumerable: false
|
||||
})
|
||||
}
|
||||
return this._idCIDString
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks the equality of `this` peer against a given PeerId.
|
||||
*
|
||||
* @param {Uint8Array|PeerId} id
|
||||
* @returns {boolean}
|
||||
*/
|
||||
equals (id) {
|
||||
if (id instanceof Uint8Array) {
|
||||
return uint8ArrayEquals(this.id, id)
|
||||
} else if (id.id) {
|
||||
return this.id.equals(id.id)
|
||||
return uint8ArrayEquals(this.id, id.id)
|
||||
} else {
|
||||
throw new Error('not valid Id')
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks the equality of `this` peer against a given PeerId.
|
||||
*
|
||||
* @deprecated Use `.equals`
|
||||
* @param {Uint8Array|PeerId} id
|
||||
* @returns {boolean}
|
||||
*/
|
||||
isEqual (id) {
|
||||
return this.equals(id)
|
||||
}
|
||||
|
||||
/*
|
||||
* Check if this PeerId instance is valid (privKey -> pubKey -> Id)
|
||||
*/
|
||||
isValid (callback) {
|
||||
// TODO Needs better checking
|
||||
if (this.privKey &&
|
||||
isValid () {
|
||||
// TODO: needs better checking
|
||||
return Boolean(this.privKey &&
|
||||
this.privKey.public &&
|
||||
this.privKey.public.bytes &&
|
||||
Buffer.isBuffer(this.pubKey.bytes) &&
|
||||
this.privKey.public.bytes.equals(this.pubKey.bytes)) {
|
||||
callback()
|
||||
} else {
|
||||
callback(new Error('Keys not match'))
|
||||
this.pubKey.bytes instanceof Uint8Array &&
|
||||
uint8ArrayEquals(this.privKey.public.bytes, this.pubKey.bytes))
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if the PeerId has an inline public key.
|
||||
*
|
||||
* @returns {boolean}
|
||||
*/
|
||||
hasInlinePublicKey () {
|
||||
try {
|
||||
const decoded = mh.decode(this.id)
|
||||
if (decoded.name === 'identity') {
|
||||
return true
|
||||
}
|
||||
} catch (_) {
|
||||
// Ignore, there is no valid public key
|
||||
}
|
||||
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
const PeerIdWithIs = withIs(PeerId, { className: 'PeerId', symbolName: '@libp2p/js-peer-id/PeerId' })
|
||||
const PeerIdWithIs = withIs(PeerId, {
|
||||
className: 'PeerId',
|
||||
symbolName: '@libp2p/js-peer-id/PeerId'
|
||||
})
|
||||
|
||||
exports = module.exports = PeerIdWithIs
|
||||
|
||||
// generation
|
||||
exports.create = function (opts, callback) {
|
||||
if (typeof opts === 'function') {
|
||||
callback = opts
|
||||
opts = {}
|
||||
const computeDigest = (pubKey) => {
|
||||
if (pubKey.bytes.length <= 42) {
|
||||
return mh.encode(pubKey.bytes, 'identity')
|
||||
} else {
|
||||
return pubKey.hash()
|
||||
}
|
||||
}
|
||||
|
||||
const computePeerId = async (privKey, pubKey) => {
|
||||
const digest = await computeDigest(pubKey)
|
||||
return new PeerIdWithIs(digest, privKey, pubKey)
|
||||
}
|
||||
|
||||
// generation
|
||||
exports.create = async (opts) => {
|
||||
opts = opts || {}
|
||||
opts.bits = opts.bits || 2048
|
||||
opts.keyType = opts.keyType || 'RSA'
|
||||
|
||||
waterfall([
|
||||
(cb) => cryptoKeys.generateKeyPair('RSA', opts.bits, cb),
|
||||
(privKey, cb) => privKey.public.hash((err, digest) => {
|
||||
cb(err, digest, privKey)
|
||||
})
|
||||
], (err, digest, privKey) => {
|
||||
if (err) {
|
||||
return callback(err)
|
||||
const key = await cryptoKeys.generateKeyPair(opts.keyType, opts.bits)
|
||||
return computePeerId(key, key.public)
|
||||
}
|
||||
|
||||
callback(null, new PeerIdWithIs(digest, privKey))
|
||||
})
|
||||
}
|
||||
|
||||
exports.createFromHexString = function (str) {
|
||||
exports.createFromHexString = (str) => {
|
||||
return new PeerIdWithIs(mh.fromHexString(str))
|
||||
}
|
||||
|
||||
exports.createFromBytes = function (buf) {
|
||||
exports.createFromBytes = (buf) => {
|
||||
return new PeerIdWithIs(buf)
|
||||
}
|
||||
|
||||
exports.createFromB58String = function (str) {
|
||||
return new PeerIdWithIs(mh.fromB58String(str))
|
||||
exports.createFromB58String = (str) => {
|
||||
return exports.createFromCID(str) // B58String is CIDv0
|
||||
}
|
||||
|
||||
// Public Key input will be a buffer
|
||||
exports.createFromPubKey = function (key, callback) {
|
||||
if (typeof callback !== 'function') {
|
||||
throw new Error('callback is required')
|
||||
const validMulticodec = (cid) => {
|
||||
// supported: 'libp2p-key' (CIDv1) and 'dag-pb' (CIDv0 converted to CIDv1)
|
||||
return cid.codec === 'libp2p-key' || cid.codec === 'dag-pb'
|
||||
}
|
||||
|
||||
let pubKey
|
||||
exports.createFromCID = (cid) => {
|
||||
cid = CID.isCID(cid) ? cid : new CID(cid)
|
||||
if (!validMulticodec(cid)) throw new Error('Supplied PeerID CID has invalid multicodec: ' + cid.codec)
|
||||
return new PeerIdWithIs(cid.multihash)
|
||||
}
|
||||
|
||||
try {
|
||||
// Public Key input will be a Uint8Array
|
||||
exports.createFromPubKey = async (key) => {
|
||||
let buf = key
|
||||
|
||||
if (typeof buf === 'string') {
|
||||
buf = Buffer.from(key, 'base64')
|
||||
buf = uint8ArrayFromString(key, 'base64pad')
|
||||
}
|
||||
|
||||
if (!Buffer.isBuffer(buf)) throw new Error('Supplied key is neither a base64 string nor a buffer')
|
||||
|
||||
pubKey = cryptoKeys.unmarshalPublicKey(buf)
|
||||
} catch (err) {
|
||||
return callback(err)
|
||||
if (!(buf instanceof Uint8Array)) {
|
||||
throw new Error('Supplied key is neither a base64 string nor a Uint8Array')
|
||||
}
|
||||
|
||||
pubKey.hash((err, digest) => {
|
||||
if (err) {
|
||||
return callback(err)
|
||||
}
|
||||
|
||||
callback(null, new PeerIdWithIs(digest, null, pubKey))
|
||||
})
|
||||
const pubKey = await cryptoKeys.unmarshalPublicKey(buf)
|
||||
return computePeerId(null, pubKey)
|
||||
}
|
||||
|
||||
// Private key input will be a string
|
||||
exports.createFromPrivKey = function (key, callback) {
|
||||
if (typeof callback !== 'function') {
|
||||
throw new Error('callback is required')
|
||||
exports.createFromPrivKey = async (key) => {
|
||||
if (typeof key === 'string') {
|
||||
key = uint8ArrayFromString(key, 'base64pad')
|
||||
}
|
||||
|
||||
let buf = key
|
||||
|
||||
try {
|
||||
if (typeof buf === 'string') {
|
||||
buf = Buffer.from(key, 'base64')
|
||||
if (!(key instanceof Uint8Array)) {
|
||||
throw new Error('Supplied key is neither a base64 string nor a Uint8Array')
|
||||
}
|
||||
|
||||
if (!Buffer.isBuffer(buf)) throw new Error('Supplied key is neither a base64 string nor a buffer')
|
||||
} catch (err) {
|
||||
return callback(err)
|
||||
const privKey = await cryptoKeys.unmarshalPrivateKey(key)
|
||||
return computePeerId(privKey, privKey.public)
|
||||
}
|
||||
|
||||
waterfall([
|
||||
(cb) => cryptoKeys.unmarshalPrivateKey(buf, cb),
|
||||
(privKey, cb) => privKey.public.hash((err, digest) => {
|
||||
cb(err, digest, privKey)
|
||||
})
|
||||
], (err, digest, privKey) => {
|
||||
if (err) {
|
||||
return callback(err)
|
||||
exports.createFromJSON = async (obj) => {
|
||||
const id = mh.fromB58String(obj.id)
|
||||
const rawPrivKey = obj.privKey && uint8ArrayFromString(obj.privKey, 'base64pad')
|
||||
const rawPubKey = obj.pubKey && uint8ArrayFromString(obj.pubKey, 'base64pad')
|
||||
const pub = rawPubKey && await cryptoKeys.unmarshalPublicKey(rawPubKey)
|
||||
|
||||
if (!rawPrivKey) {
|
||||
return new PeerIdWithIs(id, null, pub)
|
||||
}
|
||||
|
||||
callback(null, new PeerIdWithIs(digest, privKey, privKey.public))
|
||||
})
|
||||
}
|
||||
const privKey = await cryptoKeys.unmarshalPrivateKey(rawPrivKey)
|
||||
const privDigest = await computeDigest(privKey.public)
|
||||
|
||||
exports.createFromJSON = function (obj, callback) {
|
||||
if (typeof callback !== 'function') {
|
||||
throw new Error('callback is required')
|
||||
}
|
||||
let pubDigest
|
||||
|
||||
let id
|
||||
let rawPrivKey
|
||||
let rawPubKey
|
||||
let pub
|
||||
|
||||
try {
|
||||
id = mh.fromB58String(obj.id)
|
||||
rawPrivKey = obj.privKey && Buffer.from(obj.privKey, 'base64')
|
||||
rawPubKey = obj.pubKey && Buffer.from(obj.pubKey, 'base64')
|
||||
pub = rawPubKey && cryptoKeys.unmarshalPublicKey(rawPubKey)
|
||||
} catch (err) {
|
||||
return callback(err)
|
||||
}
|
||||
|
||||
if (rawPrivKey) {
|
||||
waterfall([
|
||||
(cb) => cryptoKeys.unmarshalPrivateKey(rawPrivKey, cb),
|
||||
(priv, cb) => priv.public.hash((err, digest) => {
|
||||
cb(err, digest, priv)
|
||||
}),
|
||||
(privDigest, priv, cb) => {
|
||||
if (pub) {
|
||||
pub.hash((err, pubDigest) => {
|
||||
cb(err, privDigest, priv, pubDigest)
|
||||
})
|
||||
} else {
|
||||
cb(null, privDigest, priv)
|
||||
}
|
||||
}
|
||||
], (err, privDigest, priv, pubDigest) => {
|
||||
if (err) {
|
||||
return callback(err)
|
||||
pubDigest = await computeDigest(pub)
|
||||
}
|
||||
|
||||
if (pub && !privDigest.equals(pubDigest)) {
|
||||
return callback(new Error('Public and private key do not match'))
|
||||
if (pub && !uint8ArrayEquals(privDigest, pubDigest)) {
|
||||
throw new Error('Public and private key do not match')
|
||||
}
|
||||
|
||||
if (id && !privDigest.equals(id)) {
|
||||
return callback(new Error('Id and private key do not match'))
|
||||
if (id && !uint8ArrayEquals(privDigest, id)) {
|
||||
throw new Error('Id and private key do not match')
|
||||
}
|
||||
|
||||
callback(null, new PeerIdWithIs(id, priv, pub))
|
||||
})
|
||||
} else {
|
||||
callback(null, new PeerIdWithIs(id, null, pub))
|
||||
}
|
||||
return new PeerIdWithIs(id, privKey, pub)
|
||||
}
|
||||
|
||||
exports.isPeerId = function (peerId) {
|
||||
exports.createFromProtobuf = async (buf) => {
|
||||
if (typeof buf === 'string') {
|
||||
buf = uint8ArrayFromString(buf, 'base16')
|
||||
}
|
||||
|
||||
let { id, privKey, pubKey } = PeerIdProto.decode(buf)
|
||||
|
||||
privKey = privKey ? await cryptoKeys.unmarshalPrivateKey(privKey) : false
|
||||
pubKey = pubKey ? await cryptoKeys.unmarshalPublicKey(pubKey) : false
|
||||
|
||||
let pubDigest
|
||||
let privDigest
|
||||
|
||||
if (privKey) {
|
||||
privDigest = await computeDigest(privKey.public)
|
||||
}
|
||||
|
||||
if (pubKey) {
|
||||
pubDigest = await computeDigest(pubKey)
|
||||
}
|
||||
|
||||
if (privKey) {
|
||||
if (pubKey) {
|
||||
if (!uint8ArrayEquals(privDigest, pubDigest)) {
|
||||
throw new Error('Public and private key do not match')
|
||||
}
|
||||
}
|
||||
return new PeerIdWithIs(privDigest, privKey, privKey.public)
|
||||
}
|
||||
|
||||
// TODO: val id and pubDigest
|
||||
|
||||
if (pubKey) {
|
||||
return new PeerIdWithIs(pubDigest, null, pubKey)
|
||||
}
|
||||
|
||||
if (id) {
|
||||
return new PeerIdWithIs(id)
|
||||
}
|
||||
|
||||
throw new Error('Protobuf did not contain any usable key material')
|
||||
}
|
||||
|
||||
exports.isPeerId = (peerId) => {
|
||||
return Boolean(typeof peerId === 'object' &&
|
||||
peerId._id &&
|
||||
peerId._idB58String)
|
||||
@ -296,6 +368,6 @@ exports.isPeerId = function (peerId) {
|
||||
|
||||
function toB64Opt (val) {
|
||||
if (val) {
|
||||
return val.toString('base64')
|
||||
return uint8ArrayToString(val, 'base64pad')
|
||||
}
|
||||
}
|
||||
|
||||
12
src/proto.js
Normal file
12
src/proto.js
Normal file
@ -0,0 +1,12 @@
|
||||
'use strict'
|
||||
|
||||
const protons = require('protons')
|
||||
module.exports = protons(`
|
||||
|
||||
message PeerIdProto {
|
||||
required bytes id = 1;
|
||||
bytes pubKey = 2;
|
||||
bytes privKey = 3;
|
||||
}
|
||||
|
||||
`)
|
||||
3
test/fixtures/sample-id.js
vendored
3
test/fixtures/sample-id.js
vendored
@ -3,5 +3,6 @@
|
||||
module.exports = {
|
||||
id: '122019318b6e5e0cf93a2314bf01269a2cc23cd3dcd452d742cdb9379d8646f6e4a9',
|
||||
privKey: 'CAASpgkwggSiAgEAAoIBAQC2SKo/HMFZeBml1AF3XijzrxrfQXdJzjePBZAbdxqKR1Mc6juRHXij6HXYPjlAk01BhF1S3Ll4Lwi0cAHhggf457sMg55UWyeGKeUv0ucgvCpBwlR5cQ020i0MgzjPWOLWq1rtvSbNcAi2ZEVn6+Q2EcHo3wUvWRtLeKz+DZSZfw2PEDC+DGPJPl7f8g7zl56YymmmzH9liZLNrzg/qidokUv5u1pdGrcpLuPNeTODk0cqKB+OUbuKj9GShYECCEjaybJDl9276oalL9ghBtSeEv20kugatTvYy590wFlJkkvyl+nPxIH0EEYMKK9XRWlu9XYnoSfboiwcv8M3SlsjAgMBAAECggEAZtju/bcKvKFPz0mkHiaJcpycy9STKphorpCT83srBVQi59CdFU6Mj+aL/xt0kCPMVigJw8P3/YCEJ9J+rS8BsoWE+xWUEsJvtXoT7vzPHaAtM3ci1HZd302Mz1+GgS8Epdx+7F5p80XAFLDUnELzOzKftvWGZmWfSeDnslwVONkL/1VAzwKy7Ce6hk4SxRE7l2NE2OklSHOzCGU1f78ZzVYKSnS5Ag9YrGjOAmTOXDbKNKN/qIorAQ1bovzGoCwx3iGIatQKFOxyVCyO1PsJYT7JO+kZbhBWRRE+L7l+ppPER9bdLFxs1t5CrKc078h+wuUr05S1P1JjXk68pk3+kQKBgQDeK8AR11373Mzib6uzpjGzgNRMzdYNuExWjxyxAzz53NAR7zrPHvXvfIqjDScLJ4NcRO2TddhXAfZoOPVH5k4PJHKLBPKuXZpWlookCAyENY7+Pd55S8r+a+MusrMagYNljb5WbVTgN8cgdpim9lbbIFlpN6SZaVjLQL3J8TWH6wKBgQDSChzItkqWX11CNstJ9zJyUE20I7LrpyBJNgG1gtvz3ZMUQCn3PxxHtQzN9n1P0mSSYs+jBKPuoSyYLt1wwe10/lpgL4rkKWU3/m1Myt0tveJ9WcqHh6tzcAbb/fXpUFT/o4SWDimWkPkuCb+8j//2yiXk0a/T2f36zKMuZvujqQKBgC6B7BAQDG2H2B/ijofp12ejJU36nL98gAZyqOfpLJ+FeMz4TlBDQ+phIMhnHXA5UkdDapQ+zA3SrFk+6yGk9Vw4Hf46B+82SvOrSbmnMa+PYqKYIvUzR4gg34rL/7AhwnbEyD5hXq4dHwMNsIDq+l2elPjwm/U9V0gdAl2+r50HAoGALtsKqMvhv8HucAMBPrLikhXP/8um8mMKFMrzfqZ+otxfHzlhI0L08Bo3jQrb0Z7ByNY6M8epOmbCKADsbWcVre/AAY0ZkuSZK/CaOXNX/AhMKmKJh8qAOPRY02LIJRBCpfS4czEdnfUhYV/TYiFNnKRj57PPYZdTzUsxa/yVTmECgYBr7slQEjb5Onn5mZnGDh+72BxLNdgwBkhO0OCdpdISqk0F0Pxby22DFOKXZEpiyI9XYP1C8wPiJsShGm2yEwBPWXnrrZNWczaVuCbXHrZkWQogBDG3HGXNdU4MAWCyiYlyinIBpPpoAJZSzpGLmWbMWh28+RJS6AQX6KHrK1o2uw==',
|
||||
pubKey: 'CAASpgIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC2SKo/HMFZeBml1AF3XijzrxrfQXdJzjePBZAbdxqKR1Mc6juRHXij6HXYPjlAk01BhF1S3Ll4Lwi0cAHhggf457sMg55UWyeGKeUv0ucgvCpBwlR5cQ020i0MgzjPWOLWq1rtvSbNcAi2ZEVn6+Q2EcHo3wUvWRtLeKz+DZSZfw2PEDC+DGPJPl7f8g7zl56YymmmzH9liZLNrzg/qidokUv5u1pdGrcpLuPNeTODk0cqKB+OUbuKj9GShYECCEjaybJDl9276oalL9ghBtSeEv20kugatTvYy590wFlJkkvyl+nPxIH0EEYMKK9XRWlu9XYnoSfboiwcv8M3SlsjAgMBAAE='
|
||||
pubKey: 'CAASpgIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC2SKo/HMFZeBml1AF3XijzrxrfQXdJzjePBZAbdxqKR1Mc6juRHXij6HXYPjlAk01BhF1S3Ll4Lwi0cAHhggf457sMg55UWyeGKeUv0ucgvCpBwlR5cQ020i0MgzjPWOLWq1rtvSbNcAi2ZEVn6+Q2EcHo3wUvWRtLeKz+DZSZfw2PEDC+DGPJPl7f8g7zl56YymmmzH9liZLNrzg/qidokUv5u1pdGrcpLuPNeTODk0cqKB+OUbuKj9GShYECCEjaybJDl9276oalL9ghBtSeEv20kugatTvYy590wFlJkkvyl+nPxIH0EEYMKK9XRWlu9XYnoSfboiwcv8M3SlsjAgMBAAE=',
|
||||
marshaled: '0a22122019318b6e5e0cf93a2314bf01269a2cc23cd3dcd452d742cdb9379d8646f6e4a912ab02080012a60230820122300d06092a864886f70d01010105000382010f003082010a0282010100b648aa3f1cc1597819a5d401775e28f3af1adf417749ce378f05901b771a8a47531cea3b911d78a3e875d83e3940934d41845d52dcb9782f08b47001e18207f8e7bb0c839e545b278629e52fd2e720bc2a41c25479710d36d22d0c8338cf58e2d6ab5aedbd26cd7008b6644567ebe43611c1e8df052f591b4b78acfe0d94997f0d8f1030be0c63c93e5edff20ef3979e98ca69a6cc7f658992cdaf383faa2768914bf9bb5a5d1ab7292ee3cd79338393472a281f8e51bb8a8fd1928581020848dac9b24397ddbbea86a52fd82106d49e12fdb492e81ab53bd8cb9f74c05949924bf297e9cfc481f410460c28af5745696ef57627a127dba22c1cbfc3374a5b2302030100011aab09080012a609308204a20201000282010100b648aa3f1cc1597819a5d401775e28f3af1adf417749ce378f05901b771a8a47531cea3b911d78a3e875d83e3940934d41845d52dcb9782f08b47001e18207f8e7bb0c839e545b278629e52fd2e720bc2a41c25479710d36d22d0c8338cf58e2d6ab5aedbd26cd7008b6644567ebe43611c1e8df052f591b4b78acfe0d94997f0d8f1030be0c63c93e5edff20ef3979e98ca69a6cc7f658992cdaf383faa2768914bf9bb5a5d1ab7292ee3cd79338393472a281f8e51bb8a8fd1928581020848dac9b24397ddbbea86a52fd82106d49e12fdb492e81ab53bd8cb9f74c05949924bf297e9cfc481f410460c28af5745696ef57627a127dba22c1cbfc3374a5b2302030100010282010066d8eefdb70abca14fcf49a41e2689729c9ccbd4932a9868ae9093f37b2b055422e7d09d154e8c8fe68bff1b749023cc562809c3c3f7fd808427d27ead2f01b28584fb159412c26fb57a13eefccf1da02d337722d4765ddf4d8ccf5f86812f04a5dc7eec5e69f345c014b0d49c42f33b329fb6f58666659f49e0e7b25c1538d90bff5540cf02b2ec27ba864e12c5113b976344d8e9254873b30865357fbf19cd560a4a74b9020f58ac68ce0264ce5c36ca34a37fa88a2b010d5ba2fcc6a02c31de21886ad40a14ec72542c8ed4fb09613ec93be9196e105645113e2fb97ea693c447d6dd2c5c6cd6de42aca734efc87ec2e52bd394b53f52635e4ebca64dfe9102818100de2bc011d75dfbdccce26fabb3a631b380d44ccdd60db84c568f1cb1033cf9dcd011ef3acf1ef5ef7c8aa30d270b27835c44ed9375d85701f66838f547e64e0f24728b04f2ae5d9a56968a24080c84358efe3dde794bcafe6be32eb2b31a8183658dbe566d54e037c7207698a6f656db20596937a4996958cb40bdc9f13587eb02818100d20a1cc8b64a965f5d4236cb49f73272504db423b2eba720493601b582dbf3dd93144029f73f1c47b50ccdf67d4fd2649262cfa304a3eea12c982edd70c1ed74fe5a602f8ae4296537fe6d4ccadd2dbde27d59ca8787ab737006dbfdf5e95054ffa384960e299690f92e09bfbc8ffff6ca25e4d1afd3d9fdfacca32e66fba3a90281802e81ec10100c6d87d81fe28e87e9d767a3254dfa9cbf7c800672a8e7e92c9f8578ccf84e504343ea6120c8671d70395247436a943ecc0dd2ac593eeb21a4f55c381dfe3a07ef364af3ab49b9a731af8f62a29822f533478820df8acbffb021c276c4c83e615eae1d1f030db080eafa5d9e94f8f09bf53d57481d025dbeaf9d070281802edb0aa8cbe1bfc1ee7003013eb2e29215cfffcba6f2630a14caf37ea67ea2dc5f1f39612342f4f01a378d0adbd19ec1c8d63a33c7a93a66c22800ec6d6715adefc0018d1992e4992bf09a397357fc084c2a628987ca8038f458d362c8251042a5f4b873311d9df521615fd362214d9ca463e7b3cf619753cd4b316bfc954e610281806beec9501236f93a79f99999c60e1fbbd81c4b35d83006484ed0e09da5d212aa4d05d0fc5bcb6d8314e297644a62c88f5760fd42f303e226c4a11a6db213004f5979ebad9356733695b826d71eb664590a200431b71c65cd754e0c0160b28989728a7201a4fa68009652ce918b9966cc5a1dbcf91252e80417e8a1eb2b5a36bb'
|
||||
}
|
||||
|
||||
@ -2,13 +2,12 @@
|
||||
/* eslint-env mocha */
|
||||
'use strict'
|
||||
|
||||
const chai = require('chai')
|
||||
const dirtyChai = require('dirty-chai')
|
||||
chai.use(dirtyChai)
|
||||
const expect = chai.expect
|
||||
const { expect } = require('aegir/utils/chai')
|
||||
const crypto = require('libp2p-crypto')
|
||||
const mh = require('multihashes')
|
||||
const parallel = require('async/parallel')
|
||||
const CID = require('cids')
|
||||
const uint8ArrayFromString = require('uint8arrays/from-string')
|
||||
const uint8ArrayToString = require('uint8arrays/to-string')
|
||||
|
||||
const PeerId = require('../src')
|
||||
|
||||
@ -18,6 +17,8 @@ const testId = require('./fixtures/sample-id')
|
||||
const testIdHex = testId.id
|
||||
const testIdBytes = mh.fromHexString(testId.id)
|
||||
const testIdB58String = mh.toB58String(testIdBytes)
|
||||
const testIdCID = new CID(1, 'libp2p-key', testIdBytes)
|
||||
const testIdCIDString = testIdCID.toBaseEncodedString('base32')
|
||||
|
||||
const goId = require('./fixtures/go-private-key')
|
||||
|
||||
@ -32,238 +33,314 @@ describe('PeerId', () => {
|
||||
expect(PeerId).to.throw(Error)
|
||||
})
|
||||
|
||||
it('create a new id', (done) => {
|
||||
PeerId.create(testOpts, (err, id) => {
|
||||
expect(err).to.not.exist()
|
||||
it('create a new id', async () => {
|
||||
const id = await PeerId.create(testOpts)
|
||||
expect(id.toB58String().length).to.equal(46)
|
||||
done()
|
||||
})
|
||||
})
|
||||
|
||||
it('isPeerId', (done) => {
|
||||
PeerId.create(testOpts, (err, id) => {
|
||||
expect(err).to.not.exist()
|
||||
it('can be created for a Secp256k1 key', async () => {
|
||||
const id = await PeerId.create({ keyType: 'secp256k1', bits: 256 })
|
||||
const expB58 = mh.toB58String(mh.encode(id.pubKey.bytes, 'identity'))
|
||||
expect(id.toB58String()).to.equal(expB58)
|
||||
})
|
||||
|
||||
it('can get the public key from a Secp256k1 key', async () => {
|
||||
const original = await PeerId.create({ keyType: 'secp256k1', bits: 256 })
|
||||
const newId = PeerId.createFromB58String(original.toB58String())
|
||||
expect(original.pubKey.bytes).to.eql(newId.pubKey.bytes)
|
||||
})
|
||||
|
||||
it('isPeerId', async () => {
|
||||
const id = await PeerId.create(testOpts)
|
||||
expect(PeerId.isPeerId(id)).to.equal(true)
|
||||
expect(PeerId.isPeerId('aaa')).to.equal(false)
|
||||
expect(PeerId.isPeerId(Buffer.from('batatas'))).to.equal(false)
|
||||
done()
|
||||
})
|
||||
expect(PeerId.isPeerId(uint8ArrayFromString('batatas'))).to.equal(false)
|
||||
})
|
||||
|
||||
it('throws on changing the id', function (done) {
|
||||
this.timeout(10000)
|
||||
PeerId.create(testOpts, (err, id) => {
|
||||
expect(err).to.not.exist()
|
||||
it('throws on changing the id', async () => {
|
||||
const id = await PeerId.create(testOpts)
|
||||
expect(id.toB58String().length).to.equal(46)
|
||||
expect(() => {
|
||||
id.id = Buffer.from('hello')
|
||||
// @ts-ignore
|
||||
id.id = uint8ArrayFromString('hello')
|
||||
}).to.throw(/immutable/)
|
||||
done()
|
||||
})
|
||||
})
|
||||
|
||||
it('recreate an Id from Hex string', () => {
|
||||
it('recreate from Hex string', () => {
|
||||
const id = PeerId.createFromHexString(testIdHex)
|
||||
expect(testIdBytes).to.deep.equal(id.id)
|
||||
expect(testIdBytes).to.deep.equal(id.toBytes())
|
||||
})
|
||||
|
||||
it('Recreate an Id from a Buffer', () => {
|
||||
it('recreate from a Uint8Array', () => {
|
||||
const id = PeerId.createFromBytes(testIdBytes)
|
||||
expect(testId.id).to.equal(id.toHexString())
|
||||
expect(testIdBytes).to.deep.equal(id.toBytes())
|
||||
})
|
||||
|
||||
it('Recreate a B58 String', () => {
|
||||
it('recreate from a B58 String', () => {
|
||||
const id = PeerId.createFromB58String(testIdB58String)
|
||||
expect(testIdB58String).to.equal(id.toB58String())
|
||||
expect(testIdBytes).to.deep.equal(id.toBytes())
|
||||
})
|
||||
|
||||
it('Recreate from a Public Key', (done) => {
|
||||
PeerId.createFromPubKey(testId.pubKey, (err, id) => {
|
||||
expect(err).to.not.exist()
|
||||
it('recreate from CID object', () => {
|
||||
const id = PeerId.createFromCID(testIdCID)
|
||||
expect(testIdCIDString).to.equal(id.toString())
|
||||
expect(testIdBytes).to.deep.equal(id.toBytes())
|
||||
})
|
||||
|
||||
it('recreate from Base58 String (CIDv0))', () => {
|
||||
const id = PeerId.createFromCID(testIdB58String)
|
||||
expect(testIdCIDString).to.equal(id.toString())
|
||||
expect(testIdBytes).to.deep.equal(id.toBytes())
|
||||
})
|
||||
|
||||
it('recreate from CIDv1 Base32 (libp2p-key multicodec)', () => {
|
||||
const cid = new CID(1, 'libp2p-key', testIdBytes)
|
||||
const cidString = cid.toBaseEncodedString('base32')
|
||||
const id = PeerId.createFromCID(cidString)
|
||||
expect(cidString).to.equal(id.toString())
|
||||
expect(testIdBytes).to.deep.equal(id.toBytes())
|
||||
})
|
||||
|
||||
it('recreate from CIDv1 Base32 (dag-pb multicodec)', () => {
|
||||
const cid = new CID(1, 'dag-pb', testIdBytes)
|
||||
const cidString = cid.toBaseEncodedString('base32')
|
||||
const id = PeerId.createFromCID(cidString)
|
||||
// toString should return CID with multicodec set to libp2p-key
|
||||
expect(new CID(id.toString()).codec).to.equal('libp2p-key')
|
||||
expect(testIdBytes).to.deep.equal(id.toBytes())
|
||||
})
|
||||
|
||||
it('recreate from CID Uint8Array', () => {
|
||||
const id = PeerId.createFromCID(testIdCID.bytes)
|
||||
expect(testIdCIDString).to.equal(id.toString())
|
||||
expect(testIdBytes).to.deep.equal(id.toBytes())
|
||||
})
|
||||
|
||||
it('throws on invalid CID multicodec', () => {
|
||||
// only libp2p and dag-pb are supported
|
||||
const invalidCID = new CID(1, 'raw', testIdBytes).toBaseEncodedString('base32')
|
||||
expect(() => {
|
||||
PeerId.createFromCID(invalidCID)
|
||||
}).to.throw(/Supplied PeerID CID has invalid multicodec: raw/)
|
||||
})
|
||||
|
||||
it('throws on invalid CID value', () => {
|
||||
// using function code that does not represent valid hash function
|
||||
// https://github.com/multiformats/js-multihash/blob/b85999d5768bf06f1b0f16b926ef2cb6d9c14265/src/constants.js#L345
|
||||
const invalidCID = 'QmaozNR7DZHQK1ZcU9p7QdrshMvXqWK6gpu5rmrkPdT3L'
|
||||
expect(() => {
|
||||
PeerId.createFromCID(invalidCID)
|
||||
}).to.throw(/multihash unknown function code: 0x50/)
|
||||
})
|
||||
|
||||
it('throws on invalid CID object', () => {
|
||||
const invalidCID = {}
|
||||
expect(() => {
|
||||
PeerId.createFromCID(invalidCID)
|
||||
}).to.throw(/Invalid version, must be a number equal to 1 or 0/)
|
||||
})
|
||||
|
||||
it('throws on invalid CID object', () => {
|
||||
const invalidCID = {}
|
||||
expect(() => {
|
||||
PeerId.createFromCID(invalidCID)
|
||||
}).to.throw(/Invalid version, must be a number equal to 1 or 0/)
|
||||
})
|
||||
|
||||
it('recreate from a Public Key', async () => {
|
||||
const id = await PeerId.createFromPubKey(testId.pubKey)
|
||||
expect(testIdB58String).to.equal(id.toB58String())
|
||||
done()
|
||||
})
|
||||
expect(testIdBytes).to.deep.equal(id.toBytes())
|
||||
})
|
||||
|
||||
it('Recreate from a Private Key', (done) => {
|
||||
PeerId.createFromPrivKey(testId.privKey, (err, id) => {
|
||||
expect(err).to.not.exist()
|
||||
it('recreate from a Private Key', async () => {
|
||||
const id = await PeerId.createFromPrivKey(testId.privKey)
|
||||
expect(testIdB58String).to.equal(id.toB58String())
|
||||
|
||||
const encoded = Buffer.from(testId.privKey, 'base64')
|
||||
PeerId.createFromPrivKey(encoded, (err, id2) => {
|
||||
expect(err).to.not.exist()
|
||||
const encoded = uint8ArrayFromString(testId.privKey, 'base64pad')
|
||||
const id2 = await PeerId.createFromPrivKey(encoded)
|
||||
expect(testIdB58String).to.equal(id2.toB58String())
|
||||
expect(id.marshalPubKey()).to.deep.equal(id2.marshalPubKey())
|
||||
done()
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
it('Compare generated ID with one created from PubKey', (done) => {
|
||||
PeerId.create(testOpts, (err, id1) => {
|
||||
expect(err).to.not.exist()
|
||||
it('recreate from Protobuf', async () => {
|
||||
const id = await PeerId.createFromProtobuf(testId.marshaled)
|
||||
expect(testIdB58String).to.equal(id.toB58String())
|
||||
const encoded = uint8ArrayFromString(testId.privKey, 'base64pad')
|
||||
const id2 = await PeerId.createFromPrivKey(encoded)
|
||||
expect(testIdB58String).to.equal(id2.toB58String())
|
||||
expect(id.marshalPubKey()).to.deep.equal(id2.marshalPubKey())
|
||||
expect(uint8ArrayToString(id.marshal(), 'base16')).to.deep.equal(testId.marshaled)
|
||||
})
|
||||
|
||||
PeerId.createFromPubKey(id1.marshalPubKey(), (err, id2) => {
|
||||
expect(err).to.not.exist()
|
||||
it('can be created from a Secp256k1 public key', async () => {
|
||||
const privKey = await crypto.keys.generateKeyPair('secp256k1', 256)
|
||||
const id = await PeerId.createFromPubKey(privKey.public.bytes)
|
||||
const expB58 = mh.toB58String(mh.encode(id.pubKey.bytes, 'identity'))
|
||||
expect(id.toB58String()).to.equal(expB58)
|
||||
})
|
||||
|
||||
it('can be created from a Secp256k1 private key', async () => {
|
||||
const privKey = await crypto.keys.generateKeyPair('secp256k1', 256)
|
||||
const id = await PeerId.createFromPrivKey(privKey.bytes)
|
||||
const expB58 = mh.toB58String(mh.encode(id.pubKey.bytes, 'identity'))
|
||||
expect(id.toB58String()).to.equal(expB58)
|
||||
})
|
||||
|
||||
it('Compare generated ID with one created from PubKey', async () => {
|
||||
const id1 = await PeerId.create(testOpts)
|
||||
const id2 = await PeerId.createFromPubKey(id1.marshalPubKey())
|
||||
expect(id1.id).to.be.eql(id2.id)
|
||||
done()
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
it('Works with default options', function (done) {
|
||||
it('Works with default options', async function () {
|
||||
this.timeout(10000)
|
||||
PeerId.create((err, id) => {
|
||||
expect(err).to.not.exist()
|
||||
const id = await PeerId.create()
|
||||
expect(id.toB58String().length).to.equal(46)
|
||||
done()
|
||||
})
|
||||
})
|
||||
|
||||
it('Non-default # of bits', function (done) {
|
||||
it('Non-default # of bits', async function () {
|
||||
this.timeout(1000 * 60)
|
||||
PeerId.create(testOpts, (err, shortId) => {
|
||||
expect(err).to.not.exist()
|
||||
PeerId.create({ bits: 1024 }, (err, longId) => {
|
||||
expect(err).to.not.exist()
|
||||
const shortId = await PeerId.create(testOpts)
|
||||
const longId = await PeerId.create({ bits: 1024 })
|
||||
expect(shortId.privKey.bytes.length).is.below(longId.privKey.bytes.length)
|
||||
done()
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
it('Pretty printing', (done) => {
|
||||
PeerId.create(testOpts, (err, id1) => {
|
||||
expect(err).to.not.exist()
|
||||
PeerId.createFromPrivKey(id1.toJSON().privKey, (err, id2) => {
|
||||
expect(err).to.not.exist()
|
||||
it('Pretty printing', async () => {
|
||||
const id1 = await PeerId.create(testOpts)
|
||||
const id2 = await PeerId.createFromPrivKey((id1.toJSON()).privKey)
|
||||
expect(id1.toPrint()).to.be.eql(id2.toPrint())
|
||||
expect(id1.toPrint()).to.equal('<peer.ID ' + id1.toB58String().substr(2, 6) + '>')
|
||||
done()
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
it('toBytes', () => {
|
||||
const id = PeerId.createFromHexString(testIdHex)
|
||||
expect(id.toBytes().toString('hex')).to.equal(testIdBytes.toString('hex'))
|
||||
expect(uint8ArrayToString(id.toBytes(), 'base16')).to.equal(uint8ArrayToString(testIdBytes, 'base16'))
|
||||
})
|
||||
|
||||
it('isEqual', (done) => {
|
||||
parallel([
|
||||
(cb) => PeerId.create(testOpts, cb),
|
||||
(cb) => PeerId.create(testOpts, cb)
|
||||
], (err, ids) => {
|
||||
expect(err).to.not.exist()
|
||||
it('isEqual', async () => {
|
||||
const ids = await Promise.all([
|
||||
PeerId.create(testOpts),
|
||||
PeerId.create(testOpts)
|
||||
])
|
||||
|
||||
expect(ids[0].isEqual(ids[0])).to.equal(true)
|
||||
expect(ids[0].isEqual(ids[1])).to.equal(false)
|
||||
expect(ids[0].isEqual(ids[0].id)).to.equal(true)
|
||||
expect(ids[0].isEqual(ids[1].id)).to.equal(false)
|
||||
done()
|
||||
})
|
||||
|
||||
it('equals', async () => {
|
||||
const ids = await Promise.all([
|
||||
PeerId.create(testOpts),
|
||||
PeerId.create(testOpts)
|
||||
])
|
||||
|
||||
expect(ids[0].equals(ids[0])).to.equal(true)
|
||||
expect(ids[0].equals(ids[1])).to.equal(false)
|
||||
expect(ids[0].equals(ids[0].id)).to.equal(true)
|
||||
expect(ids[0].equals(ids[1].id)).to.equal(false)
|
||||
})
|
||||
|
||||
describe('hasInlinePublicKey', () => {
|
||||
it('returns true if uses a key type with inline public key', async () => {
|
||||
const peerId = await PeerId.create({ keyType: 'secp256k1' })
|
||||
expect(peerId.hasInlinePublicKey()).to.equal(true)
|
||||
})
|
||||
|
||||
it('returns false if uses a key type with no inline public key', async () => {
|
||||
const peerId = await PeerId.create({ keyType: 'RSA' })
|
||||
expect(peerId.hasInlinePublicKey()).to.equal(false)
|
||||
})
|
||||
})
|
||||
|
||||
describe('fromJSON', () => {
|
||||
it('full node', (done) => {
|
||||
PeerId.create(testOpts, (err, id) => {
|
||||
expect(err).to.not.exist()
|
||||
|
||||
PeerId.createFromJSON(id.toJSON(), (err, other) => {
|
||||
expect(err).to.not.exist()
|
||||
it('full node', async () => {
|
||||
const id = await PeerId.create(testOpts)
|
||||
const other = await PeerId.createFromJSON(id.toJSON())
|
||||
expect(id.toB58String()).to.equal(other.toB58String())
|
||||
expect(id.privKey.bytes).to.eql(other.privKey.bytes)
|
||||
expect(id.pubKey.bytes).to.eql(other.pubKey.bytes)
|
||||
done()
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
it('only id', (done) => {
|
||||
crypto.keys.generateKeyPair('RSA', 1024, (err, key) => {
|
||||
expect(err).to.not.exist()
|
||||
key.public.hash((err, digest) => {
|
||||
expect(err).to.not.exist()
|
||||
|
||||
it('only id', async () => {
|
||||
const key = await crypto.keys.generateKeyPair('RSA', 1024)
|
||||
const digest = await key.public.hash()
|
||||
const id = PeerId.createFromBytes(digest)
|
||||
expect(id.privKey).to.not.exist()
|
||||
expect(id.pubKey).to.not.exist()
|
||||
|
||||
PeerId.createFromJSON(id.toJSON(), (err, other) => {
|
||||
expect(err).to.not.exist()
|
||||
const other = await PeerId.createFromJSON(id.toJSON())
|
||||
expect(id.toB58String()).to.equal(other.toB58String())
|
||||
done()
|
||||
})
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
it('go interop', (done) => {
|
||||
PeerId.createFromJSON(goId, (err, id) => {
|
||||
expect(err).to.not.exist()
|
||||
id.privKey.public.hash((err, digest) => {
|
||||
expect(err).to.not.exist()
|
||||
it('go interop', async () => {
|
||||
const id = await PeerId.createFromJSON(goId)
|
||||
const digest = await id.privKey.public.hash()
|
||||
expect(mh.toB58String(digest)).to.eql(goId.id)
|
||||
done()
|
||||
})
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
it('set privKey (valid)', (done) => {
|
||||
PeerId.create(testOpts, (err, peerId) => {
|
||||
expect(err).to.not.exist()
|
||||
it('set privKey (valid)', async () => {
|
||||
const peerId = await PeerId.create(testOpts)
|
||||
// @ts-ignore
|
||||
peerId.privKey = peerId._privKey
|
||||
peerId.isValid(done)
|
||||
})
|
||||
expect(peerId.isValid()).to.equal(true)
|
||||
})
|
||||
|
||||
it('set pubKey (valid)', (done) => {
|
||||
PeerId.create(testOpts, (err, peerId) => {
|
||||
expect(err).to.not.exist()
|
||||
it('set pubKey (valid)', async () => {
|
||||
const peerId = await PeerId.create(testOpts)
|
||||
// @ts-ignore
|
||||
peerId.pubKey = peerId._pubKey
|
||||
peerId.isValid(done)
|
||||
})
|
||||
expect(peerId.isValid()).to.equal(true)
|
||||
})
|
||||
|
||||
it('set privKey (invalid)', (done) => {
|
||||
PeerId.create(testOpts, (err, peerId) => {
|
||||
expect(err).to.not.exist()
|
||||
peerId.privKey = Buffer.from('bufff')
|
||||
peerId.isValid((err) => {
|
||||
expect(err).to.exist()
|
||||
done()
|
||||
})
|
||||
})
|
||||
it('set privKey (invalid)', async () => {
|
||||
const peerId = await PeerId.create(testOpts)
|
||||
// @ts-ignore
|
||||
peerId.privKey = uint8ArrayFromString('bufff')
|
||||
expect(peerId.isValid()).to.equal(false)
|
||||
})
|
||||
|
||||
it('set pubKey (invalid)', (done) => {
|
||||
PeerId.create(testOpts, (err, peerId) => {
|
||||
expect(err).to.not.exist()
|
||||
peerId.pubKey = Buffer.from('buffff')
|
||||
peerId.isValid((err) => {
|
||||
expect(err).to.exist()
|
||||
done()
|
||||
})
|
||||
it('set pubKey (invalid)', async () => {
|
||||
const peerId = await PeerId.create(testOpts)
|
||||
// @ts-ignore
|
||||
peerId.pubKey = uint8ArrayFromString('bufff')
|
||||
expect(peerId.isValid()).to.equal(false)
|
||||
})
|
||||
|
||||
it('keys are equal after one is stringified', async () => {
|
||||
const peerId = await PeerId.create(testOpts)
|
||||
const peerId1 = PeerId.createFromB58String(peerId.toB58String())
|
||||
const peerId2 = PeerId.createFromB58String(peerId.toB58String())
|
||||
|
||||
expect(peerId1).to.deep.equal(peerId2)
|
||||
|
||||
peerId1.toString()
|
||||
|
||||
expect(peerId1).to.deep.equal(peerId2)
|
||||
})
|
||||
|
||||
describe('returns error via cb instead of crashing', () => {
|
||||
const garbage = [Buffer.from('00010203040506070809', 'hex'), {}, null, false, undefined, true, 1, 0, Buffer.from(''), 'aGVsbG93b3JsZA==', 'helloworld', '']
|
||||
const garbage = [
|
||||
uint8ArrayFromString('00010203040506070809', 'base16'),
|
||||
{}, null, false, undefined, true, 1, 0,
|
||||
uint8ArrayFromString(''), 'aGVsbG93b3JsZA==', 'helloworld', ''
|
||||
]
|
||||
|
||||
const fncs = ['createFromPubKey', 'createFromPrivKey', 'createFromJSON']
|
||||
const fncs = ['createFromPubKey', 'createFromPrivKey', 'createFromJSON', 'createFromProtobuf']
|
||||
|
||||
garbage.forEach(garbage => {
|
||||
fncs.forEach(fnc => {
|
||||
it(fnc + '(' + util.inspect(garbage) + ')', cb => {
|
||||
PeerId[fnc](garbage, (err, res) => {
|
||||
for (const gb of garbage) {
|
||||
for (const fn of fncs) {
|
||||
it(`${fn} (${util.inspect(gb)})`, async () => {
|
||||
try {
|
||||
await PeerId[fn](gb)
|
||||
} catch (err) {
|
||||
expect(err).to.exist()
|
||||
expect(res).to.not.exist()
|
||||
cb()
|
||||
})
|
||||
})
|
||||
})
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
})
|
||||
|
||||
describe('throws on inconsistent data', () => {
|
||||
@ -271,37 +348,30 @@ describe('PeerId', () => {
|
||||
let k2
|
||||
let k3
|
||||
|
||||
before((done) => {
|
||||
parallel([
|
||||
(cb) => crypto.keys.generateKeyPair('RSA', 512, cb),
|
||||
(cb) => crypto.keys.generateKeyPair('RSA', 512, cb),
|
||||
(cb) => crypto.keys.generateKeyPair('RSA', 512, cb)
|
||||
], (err, keys) => {
|
||||
expect(err).to.not.exist()
|
||||
before(async () => {
|
||||
const keys = await Promise.all([
|
||||
crypto.keys.generateKeyPair('RSA', 512),
|
||||
crypto.keys.generateKeyPair('RSA', 512),
|
||||
crypto.keys.generateKeyPair('RSA', 512)
|
||||
])
|
||||
|
||||
k1 = keys[0]
|
||||
k2 = keys[1]
|
||||
k3 = keys[2]
|
||||
done()
|
||||
})
|
||||
})
|
||||
|
||||
it('missmatch private - public key', (done) => {
|
||||
k1.public.hash((err, digest) => {
|
||||
expect(err).to.not.exist()
|
||||
expect(() => new PeerId(digest, k1, k2.public))
|
||||
.to.throw(/inconsistent arguments/)
|
||||
done()
|
||||
})
|
||||
it('missmatch private - public key', async () => {
|
||||
const digest = await k1.public.hash()
|
||||
expect(() => {
|
||||
new PeerId(digest, k1, k2.public) // eslint-disable-line no-new
|
||||
}).to.throw(/inconsistent arguments/)
|
||||
})
|
||||
|
||||
it('missmatch id - private - public key', (done) => {
|
||||
k1.public.hash((err, digest) => {
|
||||
expect(err).to.not.exist()
|
||||
expect(() => new PeerId(digest, k1, k3.public))
|
||||
.to.throw(/inconsistent arguments/)
|
||||
done()
|
||||
})
|
||||
it('missmatch id - private - public key', async () => {
|
||||
const digest = await k1.public.hash()
|
||||
expect(() => {
|
||||
new PeerId(digest, k1, k3.public) // eslint-disable-line no-new
|
||||
}).to.throw(/inconsistent arguments/)
|
||||
})
|
||||
|
||||
it('invalid id', () => {
|
||||
|
||||
37
tsconfig.json
Normal file
37
tsconfig.json
Normal file
@ -0,0 +1,37 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"module": "commonjs",
|
||||
"lib": [
|
||||
"es6"
|
||||
],
|
||||
"target": "ES5",
|
||||
"noImplicitAny": false,
|
||||
"noImplicitThis": true,
|
||||
"strictFunctionTypes": true,
|
||||
"strictNullChecks": true,
|
||||
"esModuleInterop": true,
|
||||
"resolveJsonModule": true,
|
||||
"allowJs": true,
|
||||
"checkJs": true,
|
||||
"baseUrl": ".",
|
||||
"paths": {
|
||||
"peer-id": [
|
||||
"./src",
|
||||
"../src",
|
||||
]
|
||||
},
|
||||
"types": [
|
||||
"node",
|
||||
"mocha",
|
||||
"chai"
|
||||
],
|
||||
"noEmit": true,
|
||||
"forceConsistentCasingInFileNames": true
|
||||
},
|
||||
"files": [
|
||||
"./src/index.d.ts",
|
||||
],
|
||||
"include": [
|
||||
"./test/**/*.spec.js"
|
||||
]
|
||||
}
|
||||
Loading…
x
Reference in New Issue
Block a user