mirror of
https://github.com/fluencelabs/js-peer-id
synced 2025-07-04 18:21:59 +00:00
Compare commits
89 Commits
Author | SHA1 | Date | |
---|---|---|---|
464c92a53b | |||
8a608def32 | |||
19deeff432 | |||
b18c0082ff | |||
2b050bcaa1 | |||
b19edf2ab2 | |||
35b384ed15 | |||
655ceec29b | |||
8b9a134276 | |||
a637297112 | |||
e666b7284f | |||
156911e162 | |||
f91f2b6506 | |||
8f6935499e | |||
80da1a54b2 | |||
300266ad51 | |||
3abdcdabbb | |||
7d3cb8e87c | |||
a57c0c6f14 | |||
d7088d6650 | |||
c945d6ad48 | |||
0eee1a2a69 | |||
63428faae9 | |||
a38e3859d2 | |||
551fd710be | |||
442df13a11 | |||
156088db99 | |||
9c0c648001 | |||
a2934aa371 | |||
ac98b7582a | |||
0dc3c14f2b | |||
af6575d06c | |||
ccf0b7875c | |||
733b40bb47 | |||
ac27907241 | |||
e206c46549 | |||
41d3e5be5b | |||
bc213dd818 | |||
3f4f670691 | |||
d2894bfa32 | |||
c3e3b70d09 | |||
f08866047d | |||
a3fe1a2f03 | |||
0acc572fd3 | |||
8c49610dff | |||
e1ffe9bba5 | |||
e59010b439 | |||
60b1c09665 | |||
b28b8ef693 | |||
961b218a53 | |||
0642070fdd | |||
3da91b92fa | |||
ad9a43b7c8 | |||
c67bf150f2 | |||
a2afb2aeea | |||
6624c27d8d | |||
26ac06d21c | |||
f0d72b7bfe | |||
78d96d0b14 | |||
bebb0a7eae | |||
5d6a962b6c | |||
531c9f1086 | |||
06f93cd961 | |||
1452f233c8 | |||
77900c7b45 | |||
564489b0ea | |||
65c2ac8dca | |||
31701e236d | |||
e08907ff94 | |||
f6a42fef76 | |||
ba8aa3ff34 | |||
ae81e95927 | |||
d24500a042 | |||
5fec44833e | |||
2432c56ad5 | |||
f0e380af58 | |||
24cd31b2d1 | |||
5f9136b3ca | |||
4fe3e12b3c | |||
49d454da7d | |||
7336b6ad80 | |||
461d2ea287 | |||
7c100f845a | |||
c3f50a2dfd | |||
907ed1571d | |||
2aad1dce7b | |||
58f1933980 | |||
ab5504686a | |||
4beb1f8888 |
21
.gitignore
vendored
21
.gitignore
vendored
@ -1,7 +1,15 @@
|
||||
docs
|
||||
**/node_modules/
|
||||
**/*.log
|
||||
test/repo-tests*
|
||||
**/bundle.js
|
||||
|
||||
# Logs
|
||||
logs
|
||||
*.log
|
||||
|
||||
coverage
|
||||
|
||||
# Runtime data
|
||||
pids
|
||||
*.pid
|
||||
@ -19,12 +27,19 @@ coverage
|
||||
# node-waf configuration
|
||||
.lock-wscript
|
||||
|
||||
# Compiled binary addons (http://nodejs.org/api/addons.html)
|
||||
build/Release
|
||||
build
|
||||
|
||||
# Dependency directory
|
||||
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
|
||||
node_modules
|
||||
|
||||
docs
|
||||
lib
|
||||
dist
|
||||
dist
|
||||
test/test-data/go-ipfs-repo/LOCK
|
||||
test/test-data/go-ipfs-repo/LOG
|
||||
test/test-data/go-ipfs-repo/LOG.old
|
||||
|
||||
# while testing npm5
|
||||
package-lock.json
|
||||
yarn.lock
|
||||
|
28
.travis.yml
28
.travis.yml
@ -1,24 +1,32 @@
|
||||
# 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.
|
||||
sudo: false
|
||||
language: node_js
|
||||
node_js:
|
||||
- 4
|
||||
- 5
|
||||
|
||||
# Make sure we have new NPM.
|
||||
before_install:
|
||||
- npm install -g npm
|
||||
matrix:
|
||||
include:
|
||||
- node_js: 6
|
||||
env: CXX=g++-4.8
|
||||
- node_js: 8
|
||||
env: CXX=g++-4.8
|
||||
# - node_js: stable
|
||||
# env: CXX=g++-4.8
|
||||
|
||||
script:
|
||||
- npm run lint
|
||||
- npm test
|
||||
- npm run test
|
||||
- npm run coverage
|
||||
|
||||
addons:
|
||||
firefox: 'latest'
|
||||
|
||||
before_script:
|
||||
- export DISPLAY=:99.0
|
||||
- sh -e /etc/init.d/xvfb start
|
||||
|
||||
after_success:
|
||||
- npm run coverage-publish
|
||||
|
||||
addons:
|
||||
firefox: 'latest'
|
||||
apt:
|
||||
sources:
|
||||
- ubuntu-toolchain-r-test
|
||||
packages:
|
||||
- g++-4.8
|
||||
|
236
CHANGELOG.md
Normal file
236
CHANGELOG.md
Normal file
@ -0,0 +1,236 @@
|
||||
<a name="0.10.6"></a>
|
||||
## [0.10.6](https://github.com/libp2p/js-peer-id/compare/v0.10.5...v0.10.6) (2018-02-12)
|
||||
|
||||
|
||||
|
||||
<a name="0.10.5"></a>
|
||||
## [0.10.5](https://github.com/libp2p/js-peer-id/compare/v0.10.4...v0.10.5) (2018-01-28)
|
||||
|
||||
|
||||
|
||||
<a name="0.10.4"></a>
|
||||
## [0.10.4](https://github.com/libp2p/js-peer-id/compare/v0.10.3...v0.10.4) (2017-12-20)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* update dependencies ([#73](https://github.com/libp2p/js-peer-id/issues/73)) ([8b9a134](https://github.com/libp2p/js-peer-id/commit/8b9a134))
|
||||
|
||||
|
||||
|
||||
<a name="0.10.3"></a>
|
||||
## [0.10.3](https://github.com/libp2p/js-peer-id/compare/v0.10.2...v0.10.3) (2017-12-01)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* catch error when unmarshaling instead of crashing ([#72](https://github.com/libp2p/js-peer-id/issues/72)) ([156911e](https://github.com/libp2p/js-peer-id/commit/156911e))
|
||||
|
||||
|
||||
|
||||
<a name="0.10.2"></a>
|
||||
## [0.10.2](https://github.com/libp2p/js-peer-id/compare/v0.10.1...v0.10.2) (2017-10-12)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Always add public key to constructor if possible, Fix for undefined pubKey in remote peers ([#68](https://github.com/libp2p/js-peer-id/issues/68)) ([3abdcda](https://github.com/libp2p/js-peer-id/commit/3abdcda))
|
||||
|
||||
|
||||
|
||||
<a name="0.10.1"></a>
|
||||
## [0.10.1](https://github.com/libp2p/js-peer-id/compare/v0.10.0...v0.10.1) (2017-09-07)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **deps:** update aegir and libp2p-crypto ([#67](https://github.com/libp2p/js-peer-id/issues/67)) ([d7088d6](https://github.com/libp2p/js-peer-id/commit/d7088d6))
|
||||
|
||||
|
||||
|
||||
<a name="0.10.0"></a>
|
||||
# [0.10.0](https://github.com/libp2p/js-peer-id/compare/v0.9.0...v0.10.0) (2017-09-03)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* p2p addrs situation ([#66](https://github.com/libp2p/js-peer-id/issues/66)) ([63428fa](https://github.com/libp2p/js-peer-id/commit/63428fa))
|
||||
|
||||
|
||||
|
||||
<a name="0.9.0"></a>
|
||||
# [0.9.0](https://github.com/libp2p/js-peer-id/compare/v0.8.8...v0.9.0) (2017-07-22)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* use next libp2p-crypto ([#64](https://github.com/libp2p/js-peer-id/issues/64)) ([442df13](https://github.com/libp2p/js-peer-id/commit/442df13))
|
||||
|
||||
|
||||
|
||||
<a name="0.8.8"></a>
|
||||
## [0.8.8](https://github.com/libp2p/js-peer-id/compare/v0.8.7...v0.8.8) (2017-07-21)
|
||||
|
||||
|
||||
|
||||
<a name="0.8.7"></a>
|
||||
## [0.8.7](https://github.com/libp2p/js-peer-id/compare/v0.8.6...v0.8.7) (2017-04-03)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* set privKey pubKey ([ac27907](https://github.com/libp2p/js-peer-id/commit/ac27907))
|
||||
|
||||
|
||||
|
||||
<a name="0.8.6"></a>
|
||||
## [0.8.6](https://github.com/libp2p/js-peer-id/compare/v0.8.5...v0.8.6) (2017-03-30)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* isEqual ([3f4f670](https://github.com/libp2p/js-peer-id/commit/3f4f670))
|
||||
|
||||
|
||||
|
||||
<a name="0.8.5"></a>
|
||||
## [0.8.5](https://github.com/libp2p/js-peer-id/compare/v0.8.4...v0.8.5) (2017-03-27)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* avoid using constructor.name ([a3fe1a2](https://github.com/libp2p/js-peer-id/commit/a3fe1a2))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* isPeerId ([0acc572](https://github.com/libp2p/js-peer-id/commit/0acc572))
|
||||
|
||||
|
||||
|
||||
<a name="0.8.4"></a>
|
||||
## [0.8.4](https://github.com/libp2p/js-peer-id/compare/v0.8.2...v0.8.4) (2017-03-16)
|
||||
|
||||
|
||||
|
||||
<a name="0.8.2"></a>
|
||||
## [0.8.2](https://github.com/libp2p/js-peer-id/compare/v0.8.1...v0.8.2) (2017-02-09)
|
||||
|
||||
|
||||
|
||||
<a name="0.8.1"></a>
|
||||
## [0.8.1](https://github.com/libp2p/js-peer-id/compare/v0.8.0...v0.8.1) (2016-12-18)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* cache b58 id ([bebb0a7](https://github.com/libp2p/js-peer-id/commit/bebb0a7))
|
||||
* create b58 string on creation and throw on id mutation ([78d96d0](https://github.com/libp2p/js-peer-id/commit/78d96d0))
|
||||
|
||||
|
||||
|
||||
<a name="0.8.0"></a>
|
||||
# [0.8.0](https://github.com/libp2p/js-peer-id/compare/v0.7.0...v0.8.0) (2016-11-03)
|
||||
|
||||
|
||||
* Async Crypto Endeavour (#33) ([31701e2](https://github.com/libp2p/js-peer-id/commit/31701e2))
|
||||
|
||||
|
||||
### BREAKING CHANGES
|
||||
|
||||
* This changes the interface of .create, .createFromPrivKey,
|
||||
.createFromPubKey, .createFromJSON
|
||||
|
||||
|
||||
|
||||
<a name="0.7.0"></a>
|
||||
# [0.7.0](https://github.com/libp2p/js-peer-id/compare/v0.6.7...v0.7.0) (2016-05-26)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* code review and docs and go interop ([58f1933](https://github.com/libp2p/js-peer-id/commit/58f1933))
|
||||
* use new version of libp2p-crypto ([ab55046](https://github.com/libp2p/js-peer-id/commit/ab55046))
|
||||
|
||||
|
||||
|
||||
<a name="0.6.7"></a>
|
||||
## [0.6.7](https://github.com/libp2p/js-peer-id/compare/v0.6.6...v0.6.7) (2016-05-23)
|
||||
|
||||
|
||||
|
||||
<a name="0.6.6"></a>
|
||||
## [0.6.6](https://github.com/libp2p/js-peer-id/compare/v0.6.5...v0.6.6) (2016-04-12)
|
||||
|
||||
|
||||
|
||||
<a name="0.6.5"></a>
|
||||
## [0.6.5](https://github.com/libp2p/js-peer-id/compare/v0.6.1...v0.6.5) (2016-04-12)
|
||||
|
||||
|
||||
|
||||
<a name="0.6.1"></a>
|
||||
## [0.6.1](https://github.com/libp2p/js-peer-id/compare/v0.6.0...v0.6.1) (2016-03-15)
|
||||
|
||||
|
||||
|
||||
<a name="0.6.0"></a>
|
||||
# [0.6.0](https://github.com/libp2p/js-peer-id/compare/v0.5.3...v0.6.0) (2016-03-10)
|
||||
|
||||
|
||||
|
||||
<a name="0.5.3"></a>
|
||||
## [0.5.3](https://github.com/libp2p/js-peer-id/compare/v0.5.1...v0.5.3) (2016-03-05)
|
||||
|
||||
|
||||
|
||||
<a name="0.5.1"></a>
|
||||
## [0.5.1](https://github.com/libp2p/js-peer-id/compare/v0.5.0...v0.5.1) (2016-03-03)
|
||||
|
||||
|
||||
|
||||
<a name="0.5.0"></a>
|
||||
# [0.5.0](https://github.com/libp2p/js-peer-id/compare/v0.4.0...v0.5.0) (2016-02-14)
|
||||
|
||||
|
||||
|
||||
<a name="0.4.0"></a>
|
||||
# [0.4.0](https://github.com/libp2p/js-peer-id/compare/v0.3.4...v0.4.0) (2015-11-05)
|
||||
|
||||
|
||||
|
||||
<a name="0.3.4"></a>
|
||||
## [0.3.4](https://github.com/libp2p/js-peer-id/compare/v0.3.3...v0.3.4) (2015-10-28)
|
||||
|
||||
|
||||
|
||||
<a name="0.3.3"></a>
|
||||
## [0.3.3](https://github.com/libp2p/js-peer-id/compare/v0.3.2...v0.3.3) (2015-09-15)
|
||||
|
||||
|
||||
|
||||
<a name="0.3.2"></a>
|
||||
## [0.3.2](https://github.com/libp2p/js-peer-id/compare/v0.3.1...v0.3.2) (2015-09-14)
|
||||
|
||||
|
||||
|
||||
<a name="0.3.1"></a>
|
||||
## [0.3.1](https://github.com/libp2p/js-peer-id/compare/v0.3.0...v0.3.1) (2015-08-25)
|
||||
|
||||
|
||||
|
||||
<a name="0.3.0"></a>
|
||||
# [0.3.0](https://github.com/libp2p/js-peer-id/compare/v0.2.0...v0.3.0) (2015-07-19)
|
||||
|
||||
|
||||
|
||||
<a name="0.2.0"></a>
|
||||
# [0.2.0](https://github.com/libp2p/js-peer-id/compare/v0.1.0...v0.2.0) (2015-07-17)
|
||||
|
||||
|
||||
|
||||
<a name="0.1.0"></a>
|
||||
# 0.1.0 (2015-07-08)
|
||||
|
||||
|
||||
|
154
README.md
154
README.md
@ -2,41 +2,66 @@
|
||||
|
||||
[](http://ipn.io)
|
||||
[](http://webchat.freenode.net/?channels=%23ipfs)
|
||||
[](https://travis-ci.org/diasdavid/js-peer-id)
|
||||
[](https://coveralls.io/github/diasdavid/js-peer-id?branch=master)
|
||||
[](https://david-dm.org/diasdavid/js-peer-id)
|
||||
[](https://travis-ci.org/libp2p/js-peer-id)
|
||||
[](https://coveralls.io/github/libp2p/js-peer-id?branch=master)
|
||||
[](https://david-dm.org/libp2p/js-peer-id)
|
||||
[](https://github.com/feross/standard)
|
||||

|
||||

|
||||
|
||||
> [IPFS](https://github.com/ipfs/ipfs) Peer ID implementation in JavaScript.
|
||||
|
||||
- [Description](#description)
|
||||
- [Example](#example)
|
||||
- [Installation](#installation)
|
||||
- [npm](#npm)
|
||||
- [Setup](#setup)
|
||||
- [Node.js](#nodejs)
|
||||
- [Browser: Browserify, Webpack, other bundlers](#browser-browserify-webpack-other-bundlers)
|
||||
- [Browser: `<script>` Tag](#browser-script-tag)
|
||||
- [API](#api)
|
||||
- [Create](#create)
|
||||
- [`new PeerId(id[, privKey, pubKey])`](#new-peeridid-privkey-pubkey)
|
||||
- [`create([opts], callback)`](#createopts-callback)
|
||||
- [Import](#import)
|
||||
- [`createFromHexString(str)`](#createfromhexstringstr)
|
||||
- [`createFromBytes(buf)`](#createfrombytesbuf)
|
||||
- [`createFromB58String(str)`](#createfromb58stringstr)
|
||||
- [`createFromPubKey(pubKey)`](#createfrompubkeypubkey)
|
||||
- [`createFromPrivKey(privKey)`](#createfromprivkeyprivkey)
|
||||
- [`createFromJSON(obj)`](#createfromjsonobj)
|
||||
- [Export](#export)
|
||||
- [`toHexString()`](#tohexstring)
|
||||
- [`toBytes()`](#tobytes)
|
||||
- [`toB58String()`](#tob58string)
|
||||
- [`toJSON()`](#tojson)
|
||||
- [`toPrint()`](#toprint)
|
||||
- [License](#license)
|
||||
|
||||
# Description
|
||||
|
||||
Generate, import, and export PeerIDs, for use with [IPFS](https://github.com/ipfs/ipfs).
|
||||
|
||||
*A Peer ID is the SHA-256 [multihash](https://github.com/jbenet/multihash) of a
|
||||
public key.*
|
||||
A Peer ID is the SHA-256 [multihash](https://github.com/multiformats/multihash) of a public key.
|
||||
|
||||
*The public key is a base64 encoded string of a protobuf containing an RSA DER
|
||||
buffer. This uses a node buffer to pass the base64 encoded public key protobuf
|
||||
to the multihash for ID generation.*
|
||||
The public key is a base64 encoded string of a protobuf containing an RSA DER buffer. This uses a node buffer to pass the base64 encoded public key protobuf to the multihash for ID generation.
|
||||
|
||||
# Example
|
||||
|
||||
```js
|
||||
var PeerId = require('peer-id')
|
||||
var bs58 = require('bs58')
|
||||
```JavaScript
|
||||
const PeerId = require('peer-id')
|
||||
|
||||
var id = PeerId.create({ bits: 32 })
|
||||
|
||||
console.log('id ', id.toB58String())
|
||||
console.log('priv key ', bs58.encode(id.privKey))
|
||||
console.log('pub key ', bs58.encode(id.pubKey))
|
||||
PeerId.create({ bits: 1024 }, (err, id) => {
|
||||
if (err) { throw err }
|
||||
console.log(JSON.stringify(id.toJSON(), null, 2))
|
||||
})
|
||||
```
|
||||
|
||||
```
|
||||
id QmeeLFb92nkZJGj3gXLqXrEMzCMYs6uBgQLVNbrcXEvYXk
|
||||
priv key 6ibrcPAbevzvPpkq6EA6XmLyuhmUrJrEvUfgQDtEiSEPzGnGU8Ejwf6b11DVm6opnFGo
|
||||
pub key 2BeBZVKJ9RQs4i4LbGv4ReEeuBA5dck2Gje3wt67e44XuyyPq5jE
|
||||
```bash
|
||||
{
|
||||
"id": "Qma9T5YraSnpRDZqRR4krcSJabThc8nwZuJV3LercPHufi",
|
||||
"privKey": "CAAS4AQwggJcAgEAAoGBAMBgbIqyOL26oV3nGPBYrdpbv..",
|
||||
"pubKey": "CAASogEwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMBgbIqyOL26oV3nGPBYrdpbvzCY..."
|
||||
}
|
||||
```
|
||||
|
||||
# Installation
|
||||
@ -51,8 +76,8 @@ pub key 2BeBZVKJ9RQs4i4LbGv4ReEeuBA5dck2Gje3wt67e44XuyyPq5jE
|
||||
|
||||
## Node.js
|
||||
|
||||
```JavaScript
|
||||
var PeerId = require('peer-id')
|
||||
```js
|
||||
const PeerId = require('peer-id')
|
||||
```
|
||||
|
||||
## Browser: Browserify, Webpack, other bundlers
|
||||
@ -62,8 +87,8 @@ transpiled version with the right shims added. This means that you can require
|
||||
it and use with your favourite bundler without having to adjust asset management
|
||||
process.
|
||||
|
||||
```JavaScript
|
||||
var PeerId = require('peer-id')
|
||||
```js
|
||||
const PeerId = require('peer-id')
|
||||
```
|
||||
|
||||
## Browser: `<script>` Tag
|
||||
@ -72,9 +97,9 @@ Loading this module through a script tag will make the `PeerId` obj available in
|
||||
the global namespace.
|
||||
|
||||
```html
|
||||
<script src="https://npmcdn.com/peer-id/dist/index.min.js"></script>
|
||||
<script src="https://unpkg.com/peer-id/dist/index.min.js"></script>
|
||||
<!-- OR -->
|
||||
<script src="https://npmcdn.com/peer-id/dist/index.js"></script>
|
||||
<script src="https://unpkg.com/peer-id/dist/index.js"></script>
|
||||
```
|
||||
|
||||
# API
|
||||
@ -85,50 +110,57 @@ const PeerId = require('peer-id')
|
||||
|
||||
## Create
|
||||
|
||||
### PeerId.create()
|
||||
### `new PeerId(id[, privKey, pubKey])`
|
||||
|
||||
Generates a new Peer ID, complete with public/private keypair. A Peer ID has the
|
||||
following properties:
|
||||
- `id: Buffer` - The multihash of the publick key as `Buffer`
|
||||
- `privKey: RsaPrivateKey` - The private key
|
||||
- `pubKey: RsaPublicKey` - The public key
|
||||
|
||||
- `pubKey` - Buffer containing the public key bytes
|
||||
- `privKey` - Buffer containing the private key bytes
|
||||
- `id` - Buffer containing the multihash bytes
|
||||
The key format is detailed in [libp2p-crypto](https://github.com/libp2p/js-libp2p-crypto).
|
||||
|
||||
### `create([opts], callback)`
|
||||
|
||||
Generates a new Peer ID, complete with public/private keypair.
|
||||
|
||||
- `opts: Object`: Default: `{bits: 2048}`
|
||||
- `callback: Function`
|
||||
|
||||
Calls back `callback` with `err, id`.
|
||||
|
||||
## Import
|
||||
|
||||
### PeerId.createFromHexString(str)
|
||||
### `createFromHexString(str)`
|
||||
|
||||
Creates a Peer ID from hex string representing the key's multihash.
|
||||
|
||||
### PeerId.createFromBytes(buf)
|
||||
### `createFromBytes(buf)`
|
||||
|
||||
Creates a Peer ID from a buffer representing the key's multihash.
|
||||
|
||||
### PeerId.createFromB58String(str)
|
||||
### `createFromB58String(str)`
|
||||
Creates a Peer ID from a Base58 string representing the key's multihash.
|
||||
|
||||
### PeerId.createFromPubKey(pubKey)
|
||||
### `createFromPubKey(pubKey)`
|
||||
|
||||
- `publicKey: Buffer`
|
||||
|
||||
Creates a Peer ID from a buffer containing a public key.
|
||||
|
||||
### PeerId.createFromPrivKey(privKey)
|
||||
### `createFromPrivKey(privKey)`
|
||||
|
||||
- `privKey: Buffer`
|
||||
|
||||
Creates a Peer ID from a buffer containing a private key.
|
||||
|
||||
### `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 'base 64'
|
||||
|
||||
## Export
|
||||
|
||||
### id.toPrint()
|
||||
|
||||
Returns an object with the ID's properties in hex format:
|
||||
```js
|
||||
{
|
||||
id: 'QmckZzdVd72h9QUFuJJpQqhsZqGLwjhh81qSvZ9BhB2FQi',
|
||||
privKey: '080012a609308204a20201000282010100a608889914da08959d3a3db0734cee812c96...',
|
||||
pubKey: '080012a60230820122300d06092a864886f70d01010105000382010f003082010a0282010...'
|
||||
}
|
||||
```
|
||||
|
||||
### id.toHexString()
|
||||
### `toHexString()`
|
||||
|
||||
Returns the Peer ID's `id` as a hex string.
|
||||
|
||||
@ -136,16 +168,15 @@ Returns the Peer ID's `id` as a hex string.
|
||||
1220d6243998f2fc56343ad7ed0342ab7886a4eb18d736f1b67d44b37fcc81e0f39f
|
||||
```
|
||||
|
||||
### id.toBytes()
|
||||
### `toBytes()`
|
||||
|
||||
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>
|
||||
```
|
||||
|
||||
### id.toB58String()
|
||||
### `toB58String()`
|
||||
|
||||
Returns the Peer ID's `id` as a base58 string.
|
||||
|
||||
@ -153,6 +184,23 @@ Returns the Peer ID's `id` as a base58 string.
|
||||
QmckZzdVd72h9QUFuJJpQqhsZqGLwjhh81qSvZ9BhB2FQi
|
||||
```
|
||||
|
||||
### `toJSON()`
|
||||
|
||||
Returns an `obj` of the form
|
||||
|
||||
- `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 'base 64'
|
||||
|
||||
|
||||
### `toPrint()`
|
||||
|
||||
Alias for `.toJSON()`.
|
||||
|
||||
### `isEqual(id)`
|
||||
|
||||
- `id` can be a PeerId or a Buffer containing the id
|
||||
|
||||
# License
|
||||
|
||||
MIT
|
||||
|
29
appveyor.yml
Normal file
29
appveyor.yml
Normal file
@ -0,0 +1,29 @@
|
||||
# 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.
|
||||
version: "{build}"
|
||||
|
||||
environment:
|
||||
matrix:
|
||||
- nodejs_version: "6"
|
||||
- nodejs_version: "8"
|
||||
|
||||
matrix:
|
||||
fast_finish: true
|
||||
|
||||
install:
|
||||
# Install Node.js
|
||||
- ps: Install-Product node $env:nodejs_version
|
||||
|
||||
# Upgrade npm
|
||||
- npm install -g npm
|
||||
|
||||
# Output our current versions for debugging
|
||||
- node --version
|
||||
- npm --version
|
||||
|
||||
# Install our package dependencies
|
||||
- npm install
|
||||
|
||||
test_script:
|
||||
- npm run test:node
|
||||
|
||||
build: off
|
2
ci/Jenkinsfile
vendored
Normal file
2
ci/Jenkinsfile
vendored
Normal file
@ -0,0 +1,2 @@
|
||||
// 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()
|
@ -1,3 +1,4 @@
|
||||
# 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.
|
||||
machine:
|
||||
node:
|
||||
version: stable
|
||||
@ -5,8 +6,10 @@ machine:
|
||||
dependencies:
|
||||
pre:
|
||||
- google-chrome --version
|
||||
- wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | sudo apt-key add -
|
||||
- sudo sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list'
|
||||
- curl -L -o google-chrome.deb https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
|
||||
- sudo dpkg -i google-chrome.deb || true
|
||||
- sudo apt-get update
|
||||
- sudo apt-get --only-upgrade install google-chrome-stable
|
||||
- sudo apt-get install -f
|
||||
- sudo apt-get install --only-upgrade lsb-base
|
||||
- sudo dpkg -i google-chrome.deb
|
||||
- google-chrome --version
|
||||
|
70
package.json
70
package.json
@ -1,19 +1,19 @@
|
||||
{
|
||||
"name": "peer-id",
|
||||
"version": "0.6.7",
|
||||
"version": "0.10.6",
|
||||
"description": "IPFS Peer Id implementation in Node.js",
|
||||
"main": "lib/index.js",
|
||||
"main": "src/index.js",
|
||||
"bin": "src/bin.js",
|
||||
"jsnext:main": "src/index.js",
|
||||
"scripts": {
|
||||
"lint": "aegir-lint",
|
||||
"build": "aegir-build",
|
||||
"test": "aegir-test",
|
||||
"test:node": "aegir-test node",
|
||||
"test:browser": "aegir-test browser",
|
||||
"release": "aegir-release",
|
||||
"coverage": "aegir-coverage",
|
||||
"coverage-publish": "aegir-coverage publish"
|
||||
"lint": "aegir lint",
|
||||
"build": "aegir build",
|
||||
"test": "aegir test",
|
||||
"test:node": "aegir test -t node",
|
||||
"test:browser": "aegir test -t browser -t webworker",
|
||||
"release": "aegir release",
|
||||
"release-minor": "aegir release --type minor",
|
||||
"release-major": "aegir release --type major",
|
||||
"coverage": "aegir coverage"
|
||||
},
|
||||
"keywords": [
|
||||
"IPFS"
|
||||
@ -25,42 +25,42 @@
|
||||
"test"
|
||||
],
|
||||
"engines": {
|
||||
"node": "^4.3.0"
|
||||
"node": ">=6.0.0",
|
||||
"npm": ">=3.0.0"
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://github.com/diasdavid/js-peer-id/issues"
|
||||
"url": "https://github.com/libp2p/js-peer-id/issues"
|
||||
},
|
||||
"homepage": "https://github.com/diasdavid/js-peer-id",
|
||||
"homepage": "https://github.com/libp2p/js-peer-id",
|
||||
"devDependencies": {
|
||||
"aegir": "^3.0.4",
|
||||
"buffer-loader": "0.0.1",
|
||||
"chai": "^3.5.0",
|
||||
"pre-commit": "^1.1.2"
|
||||
"aegir": "^12.4.0",
|
||||
"chai": "^4.1.2",
|
||||
"dirty-chai": "^2.0.1",
|
||||
"pre-commit": "^1.2.2"
|
||||
},
|
||||
"dependencies": {
|
||||
"bs58": "^3.0.0",
|
||||
"multihashing": "^0.2.0",
|
||||
"node-forge": "^0.6.38",
|
||||
"protocol-buffers": "^3.1.4"
|
||||
"async": "^2.6.0",
|
||||
"libp2p-crypto": "~0.12.1",
|
||||
"lodash": "^4.17.5",
|
||||
"multihashes": "~0.4.13"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/diasdavid/js-peer-id.git"
|
||||
},
|
||||
"aegir": {
|
||||
"webpack": {
|
||||
"resolve": {
|
||||
"alias": {
|
||||
"node-forge": "../vendor/forge.bundle.js"
|
||||
}
|
||||
}
|
||||
}
|
||||
"url": "https://github.com/libp2p/js-peer-id.git"
|
||||
},
|
||||
"contributors": [
|
||||
"David Dias <daviddias.p@gmail.com>",
|
||||
"David Dias <mail@daviddias.me>",
|
||||
"Friedel Ziegelmayer <dignifiedquire@gmail.com>",
|
||||
"Maciej Krüger <mkg20001@gmail.com>",
|
||||
"Prashanth Chandra <coolshanth94@gmail.com>",
|
||||
"Richard Littauer <richard.littauer@gmail.com>",
|
||||
"Richard Schneider <makaretu@gmail.com>",
|
||||
"Stephen Whitmore <stephen.whitmore@gmail.com>",
|
||||
"dignifiedquire <dignifiedquire@gmail.com>",
|
||||
"nginnever <ginneversource@gmail.com>"
|
||||
"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>"
|
||||
]
|
||||
}
|
||||
}
|
||||
|
@ -1,13 +0,0 @@
|
||||
enum KeyType {
|
||||
RSA = 0;
|
||||
}
|
||||
|
||||
message PublicKey {
|
||||
required KeyType Type = 1;
|
||||
required bytes Data = 2;
|
||||
}
|
||||
|
||||
message PrivateKey {
|
||||
required KeyType Type = 1;
|
||||
required bytes Data = 2;
|
||||
}
|
@ -4,4 +4,10 @@
|
||||
|
||||
const PeerId = require('./index.js')
|
||||
|
||||
console.log(JSON.stringify(PeerId.create().toJSON(), null, ' '))
|
||||
PeerId.create((err, id) => {
|
||||
if (err) {
|
||||
throw err
|
||||
}
|
||||
|
||||
console.log(JSON.stringify(id.toJSON(), null, 2))
|
||||
})
|
||||
|
366
src/index.js
366
src/index.js
@ -4,137 +4,151 @@
|
||||
|
||||
'use strict'
|
||||
|
||||
const fs = require('fs')
|
||||
const multihashing = require('multihashing')
|
||||
const base58 = require('bs58')
|
||||
const forge = require('node-forge')
|
||||
const protobuf = require('protocol-buffers')
|
||||
const path = require('path')
|
||||
const mh = require('multihashes')
|
||||
const crypto = require('libp2p-crypto')
|
||||
const assert = require('assert')
|
||||
const waterfall = require('async/waterfall')
|
||||
|
||||
const pbCrypto = protobuf(fs.readFileSync(path.resolve(__dirname, '../protos/crypto.proto')))
|
||||
class PeerId {
|
||||
constructor (id, privKey, pubKey) {
|
||||
assert(Buffer.isBuffer(id), 'invalid id provided')
|
||||
|
||||
exports = module.exports = PeerId
|
||||
if (privKey && pubKey) {
|
||||
assert(privKey.public.bytes.equals(pubKey.bytes), 'inconsistent arguments')
|
||||
}
|
||||
|
||||
exports.Buffer = Buffer
|
||||
|
||||
function PeerId (id, privKey, pubKey) {
|
||||
const self = this
|
||||
|
||||
if (!(self instanceof PeerId)) {
|
||||
throw new Error('Id must be called with new')
|
||||
this._id = id
|
||||
this._idB58String = mh.toB58String(this.id)
|
||||
this._privKey = privKey
|
||||
this._pubKey = pubKey
|
||||
}
|
||||
|
||||
self.privKey = privKey
|
||||
self.pubKey = pubKey
|
||||
self.id = id // multihash - sha256 - buffer
|
||||
get id () {
|
||||
return this._id
|
||||
}
|
||||
|
||||
// pretty print
|
||||
self.toPrint = function () {
|
||||
return {
|
||||
id: self.toB58String(),
|
||||
privKey: privKey.toString('hex'),
|
||||
pubKey: pubKey.toString('hex')
|
||||
set id (val) {
|
||||
throw new Error('Id is immutable')
|
||||
}
|
||||
|
||||
get privKey () {
|
||||
return this._privKey
|
||||
}
|
||||
|
||||
set privKey (privKey) {
|
||||
this._privKey = privKey
|
||||
}
|
||||
|
||||
get pubKey () {
|
||||
if (this._pubKey) {
|
||||
return this._pubKey
|
||||
}
|
||||
|
||||
if (this._privKey) {
|
||||
return this._privKey.public
|
||||
}
|
||||
}
|
||||
|
||||
self.toJSON = function () {
|
||||
set pubKey (pubKey) {
|
||||
this._pubKey = pubKey
|
||||
}
|
||||
|
||||
// Return the protobuf version of the public key, matching go ipfs formatting
|
||||
marshalPubKey () {
|
||||
if (this.pubKey) {
|
||||
return crypto.keys.marshalPublicKey(this.pubKey)
|
||||
}
|
||||
}
|
||||
|
||||
// Return the protobuf version of the private key, matching go ipfs formatting
|
||||
marshalPrivKey () {
|
||||
if (this.privKey) {
|
||||
return crypto.keys.marshalPrivateKey(this.privKey)
|
||||
}
|
||||
}
|
||||
|
||||
// pretty print
|
||||
toPrint () {
|
||||
return this.toJSON()
|
||||
}
|
||||
|
||||
// return the jsonified version of the key, matching the formatting
|
||||
// of go-ipfs for its config file
|
||||
toJSON () {
|
||||
return {
|
||||
id: self.id.toString('hex'),
|
||||
privKey: self.privKey.toString('hex'),
|
||||
pubKey: self.pubKey.toString('hex')
|
||||
id: this.toB58String(),
|
||||
privKey: toB64Opt(this.marshalPrivKey()),
|
||||
pubKey: toB64Opt(this.marshalPubKey())
|
||||
}
|
||||
}
|
||||
|
||||
// encode/decode functions
|
||||
self.toHexString = function () {
|
||||
return self.id.toString('hex')
|
||||
toHexString () {
|
||||
return mh.toHexString(this.id)
|
||||
}
|
||||
|
||||
self.toBytes = function () {
|
||||
return self.id
|
||||
toBytes () {
|
||||
return this.id
|
||||
}
|
||||
|
||||
self.toB58String = function () {
|
||||
return base58.encode(self.id)
|
||||
toB58String () {
|
||||
return this._idB58String
|
||||
}
|
||||
|
||||
isEqual (id) {
|
||||
if (Buffer.isBuffer(id)) {
|
||||
return this.id.equals(id)
|
||||
} else if (id.id) {
|
||||
return this.id.equals(id.id)
|
||||
} else {
|
||||
throw new Error('not valid Id')
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
* Check if this PeerId instance is valid (privKey -> pubKey -> Id)
|
||||
*/
|
||||
isValid (callback) {
|
||||
// TODO Needs better checking
|
||||
if (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'))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// unwrap the private key protobuf
|
||||
function keyUnmarshal (key) {
|
||||
return pbCrypto.PrivateKey.decode(key)
|
||||
}
|
||||
|
||||
// create a public key protobuf to be base64 string stored in config
|
||||
function keyMarshal (data, type) {
|
||||
const RSA = 0
|
||||
|
||||
let epb
|
||||
if (type === 'Public') {
|
||||
epb = pbCrypto.PublicKey.encode({
|
||||
Type: RSA,
|
||||
Data: data
|
||||
})
|
||||
}
|
||||
|
||||
if (type === 'Private') {
|
||||
epb = pbCrypto.PrivateKey.encode({
|
||||
Type: RSA,
|
||||
Data: data
|
||||
})
|
||||
}
|
||||
|
||||
return epb
|
||||
}
|
||||
|
||||
// this returns a base64 encoded protobuf of the public key
|
||||
function formatKey (key, type) {
|
||||
// create der buffer of public key asn.1 object
|
||||
const der = forge.asn1.toDer(key)
|
||||
|
||||
// create forge buffer of der public key buffer
|
||||
const fDerBuf = forge.util.createBuffer(der.data, 'binary')
|
||||
|
||||
// convert forge buffer to node buffer public key
|
||||
const nDerBuf = new Buffer(fDerBuf.getBytes(), 'binary')
|
||||
|
||||
// protobuf the new DER bytes to the PublicKey Data: field
|
||||
const marsheledKey = keyMarshal(nDerBuf, type)
|
||||
|
||||
// encode the protobuf public key to base64 string
|
||||
const b64 = marsheledKey.toString('base64')
|
||||
return b64
|
||||
}
|
||||
exports = module.exports = PeerId
|
||||
|
||||
// generation
|
||||
exports.create = function (opts) {
|
||||
exports.create = function (opts, callback) {
|
||||
if (typeof opts === 'function') {
|
||||
callback = opts
|
||||
opts = {}
|
||||
}
|
||||
opts = opts || {}
|
||||
opts.bits = opts.bits || 2048
|
||||
|
||||
// generate keys
|
||||
const pair = forge.rsa.generateKeyPair({
|
||||
bits: opts.bits,
|
||||
e: 0x10001
|
||||
waterfall([
|
||||
(cb) => crypto.keys.generateKeyPair('RSA', opts.bits, cb),
|
||||
(privKey, cb) => privKey.public.hash((err, digest) => {
|
||||
cb(err, digest, privKey)
|
||||
})
|
||||
], (err, digest, privKey) => {
|
||||
if (err) {
|
||||
return callback(err)
|
||||
}
|
||||
|
||||
callback(null, new PeerId(digest, privKey))
|
||||
})
|
||||
|
||||
// return the RSA public/private key to asn1 object
|
||||
const asnPub = forge.pki.publicKeyToAsn1(pair.publicKey)
|
||||
const asnPriv = forge.pki.privateKeyToAsn1(pair.privateKey)
|
||||
|
||||
// format the keys to protobuf base64 encoded string
|
||||
const protoPublic64 = formatKey(asnPub, 'Public')
|
||||
const protoPrivate64 = formatKey(asnPriv, 'Private')
|
||||
|
||||
// store the keys as a buffer
|
||||
const bufProtoPub64 = new Buffer(protoPublic64, 'base64')
|
||||
const bufProtoPriv64 = new Buffer(protoPrivate64, 'base64')
|
||||
|
||||
const mhId = multihashing(new Buffer(protoPublic64, 'base64'), 'sha2-256')
|
||||
|
||||
return new PeerId(mhId, bufProtoPriv64, bufProtoPub64)
|
||||
}
|
||||
|
||||
exports.createFromHexString = function (str) {
|
||||
return new PeerId(new Buffer(str, 'hex'))
|
||||
return new PeerId(mh.fromHexString(str))
|
||||
}
|
||||
|
||||
exports.createFromBytes = function (buf) {
|
||||
@ -142,51 +156,133 @@ exports.createFromBytes = function (buf) {
|
||||
}
|
||||
|
||||
exports.createFromB58String = function (str) {
|
||||
return new PeerId(new Buffer(base58.decode(str)))
|
||||
return new PeerId(mh.fromB58String(str))
|
||||
}
|
||||
|
||||
// Public Key input will be a buffer
|
||||
exports.createFromPubKey = function (pubKey) {
|
||||
const buf = new Buffer(pubKey, 'base64')
|
||||
const mhId = multihashing(buf, 'sha2-256')
|
||||
return new PeerId(mhId, null, pubKey)
|
||||
exports.createFromPubKey = function (key, callback) {
|
||||
if (typeof callback !== 'function') {
|
||||
throw new Error('callback is required')
|
||||
}
|
||||
|
||||
let pubKey
|
||||
|
||||
try {
|
||||
let buf = key
|
||||
if (typeof buf === 'string') {
|
||||
buf = Buffer.from(key, 'base64')
|
||||
}
|
||||
|
||||
if (!Buffer.isBuffer(buf)) throw new Error('Supplied key is neither a base64 string nor a buffer')
|
||||
|
||||
pubKey = crypto.keys.unmarshalPublicKey(buf)
|
||||
} catch (err) {
|
||||
return callback(err)
|
||||
}
|
||||
|
||||
pubKey.hash((err, digest) => {
|
||||
if (err) {
|
||||
return callback(err)
|
||||
}
|
||||
|
||||
callback(null, new PeerId(digest, null, pubKey))
|
||||
})
|
||||
}
|
||||
|
||||
// Private key input will be a string
|
||||
exports.createFromPrivKey = function (privKey) {
|
||||
// create a buffer from the base64 encoded string
|
||||
const buf = new Buffer(privKey, 'base64')
|
||||
exports.createFromPrivKey = function (key, callback) {
|
||||
if (typeof callback !== 'function') {
|
||||
throw new Error('callback is required')
|
||||
}
|
||||
|
||||
// get the private key data from the protobuf
|
||||
const mpk = keyUnmarshal(buf)
|
||||
let buf = key
|
||||
|
||||
// create a forge buffer
|
||||
const fbuf = forge.util.createBuffer(mpk.Data.toString('binary'))
|
||||
try {
|
||||
if (typeof buf === 'string') {
|
||||
buf = Buffer.from(key, 'base64')
|
||||
}
|
||||
|
||||
// create an asn1 object from the private key bytes saved in the protobuf Data: field
|
||||
const asnPriv = forge.asn1.fromDer(fbuf)
|
||||
if (!Buffer.isBuffer(buf)) throw new Error('Supplied key is neither a base64 string nor a buffer')
|
||||
} catch (err) {
|
||||
return callback(err)
|
||||
}
|
||||
|
||||
// get the RSA privatekey data from the asn1 object
|
||||
const privateKey = forge.pki.privateKeyFromAsn1(asnPriv)
|
||||
waterfall([
|
||||
(cb) => crypto.keys.unmarshalPrivateKey(buf, cb),
|
||||
(privKey, cb) => privKey.public.hash((err, digest) => {
|
||||
cb(err, digest, privKey)
|
||||
})
|
||||
], (err, digest, privKey) => {
|
||||
if (err) {
|
||||
return callback(err)
|
||||
}
|
||||
|
||||
// set the RSA public key to the modulus and exponent of the private key
|
||||
const publicKey = forge.pki.rsa.setPublicKey(privateKey.n, privateKey.e)
|
||||
|
||||
// return the RSA public key to asn1 object
|
||||
const asnPub = forge.pki.publicKeyToAsn1(publicKey)
|
||||
|
||||
// format the public key
|
||||
const protoPublic64 = formatKey(asnPub, 'Public')
|
||||
|
||||
// buffer the public key for consistency before storing
|
||||
const bufProtoPub64 = new Buffer(protoPublic64, 'base64')
|
||||
const mhId = multihashing(new Buffer(protoPublic64, 'base64'), 'sha2-256')
|
||||
return new PeerId(mhId, privKey, bufProtoPub64)
|
||||
callback(null, new PeerId(digest, privKey, privKey.public))
|
||||
})
|
||||
}
|
||||
|
||||
exports.createFromJSON = function (obj) {
|
||||
return new PeerId(
|
||||
new Buffer(obj.id, 'hex'),
|
||||
new Buffer(obj.privKey, 'hex'),
|
||||
new Buffer(obj.pubKey, 'hex'))
|
||||
exports.createFromJSON = function (obj, callback) {
|
||||
if (typeof callback !== 'function') {
|
||||
throw new Error('callback is required')
|
||||
}
|
||||
|
||||
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 && crypto.keys.unmarshalPublicKey(rawPubKey)
|
||||
} catch (err) {
|
||||
return callback(err)
|
||||
}
|
||||
|
||||
if (rawPrivKey) {
|
||||
waterfall([
|
||||
(cb) => crypto.keys.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)
|
||||
}
|
||||
|
||||
if (pub && !privDigest.equals(pubDigest)) {
|
||||
return callback(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'))
|
||||
}
|
||||
|
||||
callback(null, new PeerId(id, priv, pub))
|
||||
})
|
||||
} else {
|
||||
callback(null, new PeerId(id, null, pub))
|
||||
}
|
||||
}
|
||||
|
||||
exports.isPeerId = function (peerId) {
|
||||
return Boolean(typeof peerId === 'object' &&
|
||||
peerId._id &&
|
||||
peerId._idB58String)
|
||||
}
|
||||
|
||||
function toB64Opt (val) {
|
||||
if (val) {
|
||||
return val.toString('base64')
|
||||
}
|
||||
}
|
||||
|
6
test/fixtures/go-private-key.js
vendored
Normal file
6
test/fixtures/go-private-key.js
vendored
Normal file
@ -0,0 +1,6 @@
|
||||
'use strict'
|
||||
|
||||
module.exports = {
|
||||
id: 'QmRLoXS3E73psYaUsma1VSbboTa2J8Z9kso1tpiGLk9WQ4',
|
||||
privKey: 'CAASpwkwggSjAgEAAoIBAQDWBEbO8kc6a5kEks09CKPQargY3p0DCmCczoCT52/RYFqxvH9dI+s+u4ZAvF9aLWOBvFomL7jHZODPxKDrbiNCmyEbViNgZYK+PNbwh0V3ZGbB27X3q8yZtLvYA8dhcNkz/2SHBarSoC4QLA5MXUuSWtVaYMY3MzMnzBF57Jc9Ase7NvHOIUI90M7aN5izP7hxPXpZ+shiN+TyjM8mFxYONG7ZSsY3IxUhtrU5MRzFX+tp1o/gb/aa51mHf7AL3N02j5ABiYbCK97Rbwr03hsBcwgMxoDPJmP3WZ+D5yyPcOIIF1Vd7+4/f7FQJnIw3xr9/jvaFbPyDCVbBOhr9oyxAgMBAAECggEALlrgx2Q8v0+c5hux7p1XdgYXd/OHyKfPw0cLHH4NfylCm6q7X34vLvhJHO5wLMUV/3y/ffPqLu4Pr5DkVfoWExAsvJIMuY1jIzdkStbR2glaJHUlVc7VUxmNcj1nSxi5QwT3TjORC2v8bi5Mroeqnbmk6p15cW1akC0oP+NZ4rG48+WFHRqsBaBusdSOVfA+IiZUqSd1ILysJ1w7aVN3EC7jLjDG43i+P/2BcEHy8TVClGOknJL341bHe3UPdEpmeu6k6aHGlDI4blUMXahCIUh0IdZuj+Vi/TxQME9+3bKIOjQb8RCNm3U3j/uz5gs9SyTjBuYIib9Scj/jDbLh0QKBgQDfLr3go3Q/AR0jb12QjGALJz1lc9ZRX2RQJkqqmYkZwOlHHyl+YJgqOZiO80fUkN0sJ29CmKecXU4gXuHir913Fdceei1ScBSsvZpWtBLhEZXKrRJYq8U0atKUFQADDMGutyB/uGCNeNwR6VcJezHPICvHxQfmWlWHA5VIOEtRPQKBgQD1fID76SkIpF/EaJMnN2alXWWnzKhUBUPGpQtbpwgSfaCBiZ4vr3NQwKBntOOB5QwHmifNZMoqaFQLzC4B/uyTNUcQMQQ6arYav7WQXqXTmW6poTsjUSuSOPx1swsHlYX09SmUwWDfd94XF9UOU0KUfA2/c85ixzNlV5ejkFA4hQKBgEvP3uQN4hD82d8Nl2TgqkdfnvV1cdnWY4buWvK0kOPUqelk5n1tZoMBaZc1gLLuOpMjGiIvJNByyXUpheWxA7POEXLi4b5dIEjFZ0YIiVk21gEw5UiFoMl7d+ihcY2Xqbslrb507SdhZLAY6V3pITRQo06K2XIgQWlJiE4uATepAoGBALZ2vEiBnYZW5vfN4tKbUyhGq3B1pggNgbr8odyV4mIcDlk6OOGov0WeZ5ut0AyUesSLyFnaOIoc0ZuTP/8rxBwG1bMrO8FP39sx83pDX25P9PkQZixyALjGsp+pXOFeOhtAvo9azO5M4j638Bydtjc3neBX62dwOLtyx7tDYN0hAoGAVLmr3w7XMVHTfEuCSzKHyRrOaN2PAuSX31QAji1PwlwVKMylVrb8rRvBOpTicA/wXPX9Q5O/yjegqhqLT/LXAm9ziFzy5b9/9SzXPukKebXXbvc0FOmcsrcxtijlPyUzf9fKM1ShiwqqsgM9eNyZ9GWUJw2GFATCWW7pl7rtnWk='
|
||||
}
|
7
test/fixtures/sample-id.js
vendored
Normal file
7
test/fixtures/sample-id.js
vendored
Normal file
@ -0,0 +1,7 @@
|
||||
'use strict'
|
||||
|
||||
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='
|
||||
}
|
@ -1,104 +0,0 @@
|
||||
/* eslint-env mocha */
|
||||
'use strict'
|
||||
|
||||
const expect = require('chai').expect
|
||||
const PeerId = require('../src')
|
||||
|
||||
const testId = {
|
||||
id: '1220151ab1658d8294ab34b71d5582cfe20d06414212f440a69366f1bc31deb5c72d',
|
||||
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='
|
||||
}
|
||||
|
||||
const testIdHex = '1220151ab1658d8294ab34b71d5582cfe20d06414212f440a69366f1bc31deb5c72d'
|
||||
|
||||
const testIdBytes = new Buffer('1220151ab1658d8294ab34b71d5582cfe20d06414212f440a69366f1bc31deb5c72d', 'hex')
|
||||
|
||||
const testIdB58String = 'QmQ2zigjQikYnyYUSXZydNXrDRhBut2mubwJBaLXobMt3A'
|
||||
|
||||
describe('id', function (done) {
|
||||
this.timeout(30000)
|
||||
|
||||
it('create an id without \'new\'', (done) => {
|
||||
expect(PeerId).to.throw(Error)
|
||||
done()
|
||||
})
|
||||
|
||||
it('create a new id', (done) => {
|
||||
const id = PeerId.create()
|
||||
expect(id.toB58String().length).to.equal(46)
|
||||
done()
|
||||
})
|
||||
|
||||
it('recreate an Id from Hex string', (done) => {
|
||||
const id = PeerId.createFromHexString(testIdHex)
|
||||
expect(testIdBytes).to.deep.equal(id.id)
|
||||
done()
|
||||
})
|
||||
|
||||
it('Recreate an Id from a Buffer', (done) => {
|
||||
const id = PeerId.createFromBytes(testIdBytes)
|
||||
expect(testId.id).to.equal(id.toHexString())
|
||||
done()
|
||||
})
|
||||
|
||||
it('Recreate a B58 String', (done) => {
|
||||
const id = PeerId.createFromB58String(testIdB58String)
|
||||
expect(testIdB58String).to.equal(id.toB58String())
|
||||
done()
|
||||
})
|
||||
|
||||
it('Recreate from a Public Key', (done) => {
|
||||
const id = PeerId.createFromPubKey(testId.pubKey)
|
||||
expect(testIdB58String).to.equal(id.toB58String())
|
||||
done()
|
||||
})
|
||||
|
||||
it('Recreate from a Private Key', (done) => {
|
||||
const id = PeerId.createFromPrivKey(testId.privKey)
|
||||
expect(testIdB58String).to.equal(id.toB58String())
|
||||
done()
|
||||
})
|
||||
|
||||
it('Compare generated ID with one created from PubKey', (done) => {
|
||||
const id1 = PeerId.create()
|
||||
const id2 = PeerId.createFromPubKey(id1.pubKey)
|
||||
expect(id2.id).to.deep.equal(id1.id)
|
||||
done()
|
||||
})
|
||||
|
||||
it('Non-default # of bits', (done) => {
|
||||
const shortId = PeerId.create({ bits: 128 })
|
||||
const longId = PeerId.create({ bits: 256 })
|
||||
expect(shortId.privKey.length).is.below(longId.privKey.length)
|
||||
done()
|
||||
})
|
||||
|
||||
it('Pretty printing', (done) => {
|
||||
const id = PeerId.createFromPrivKey(testId.privKey)
|
||||
var out = id.toPrint()
|
||||
var expected = {
|
||||
id: 'QmQ2zigjQikYnyYUSXZydNXrDRhBut2mubwJBaLXobMt3A',
|
||||
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: '080012a60230820122300d06092a864886f70d01010105000382010f003082010a0282010100b648aa3f1cc1597819a5d401775e28f3af1adf417749ce378f05901b771a8a47531cea3b911d78a3e875d83e3940934d41845d52dcb9782f08b47001e18207f8e7bb0c839e545b278629e52fd2e720bc2a41c25479710d36d22d0c8338cf58e2d6ab5aedbd26cd7008b6644567ebe43611c1e8df052f591b4b78acfe0d94997f0d8f1030be0c63c93e5edff20ef3979e98ca69a6cc7f658992cdaf383faa2768914bf9bb5a5d1ab7292ee3cd79338393472a281f8e51bb8a8fd1928581020848dac9b24397ddbbea86a52fd82106d49e12fdb492e81ab53bd8cb9f74c05949924bf297e9cfc481f410460c28af5745696ef57627a127dba22c1cbfc3374a5b230203010001'
|
||||
}
|
||||
expect(out.id).to.equal(expected.id)
|
||||
expect(out.privKey).to.equal(expected.privKey)
|
||||
expect(out.pubKey).to.equal(expected.pubKey)
|
||||
done()
|
||||
})
|
||||
|
||||
it('toBytes', (done) => {
|
||||
const id = PeerId.createFromHexString(testIdHex)
|
||||
expect(id.toBytes().toString('hex')).to.equal(testIdBytes.toString('hex'))
|
||||
done()
|
||||
})
|
||||
|
||||
it('toJSON', (done) => {
|
||||
const id = PeerId.create()
|
||||
expect(id.toB58String()).to.equal(PeerId.createFromJSON(id.toJSON()).toB58String())
|
||||
expect(id.privKey).to.deep.equal(PeerId.createFromJSON(id.toJSON()).privKey)
|
||||
expect(id.pubKey).to.deep.equal(PeerId.createFromJSON(id.toJSON()).pubKey)
|
||||
done()
|
||||
})
|
||||
})
|
310
test/peer-id.spec.js
Normal file
310
test/peer-id.spec.js
Normal file
@ -0,0 +1,310 @@
|
||||
/* eslint max-nested-callbacks: ["error", 8] */
|
||||
/* eslint-env mocha */
|
||||
'use strict'
|
||||
|
||||
const chai = require('chai')
|
||||
const dirtyChai = require('dirty-chai')
|
||||
chai.use(dirtyChai)
|
||||
const expect = chai.expect
|
||||
const crypto = require('libp2p-crypto')
|
||||
const mh = require('multihashes')
|
||||
const parallel = require('async/parallel')
|
||||
|
||||
const PeerId = require('../src')
|
||||
|
||||
const util = require('util')
|
||||
|
||||
const testId = require('./fixtures/sample-id')
|
||||
const testIdHex = testId.id
|
||||
const testIdBytes = mh.fromHexString(testId.id)
|
||||
const testIdB58String = mh.toB58String(testIdBytes)
|
||||
|
||||
const goId = require('./fixtures/go-private-key')
|
||||
|
||||
// Test options for making PeerId.create faster
|
||||
// INSECURE, only use when testing
|
||||
const testOpts = {
|
||||
bits: 512
|
||||
}
|
||||
|
||||
describe('PeerId', () => {
|
||||
it('create an id without \'new\'', () => {
|
||||
expect(PeerId).to.throw(Error)
|
||||
})
|
||||
|
||||
it('create a new id', (done) => {
|
||||
PeerId.create(testOpts, (err, id) => {
|
||||
expect(err).to.not.exist()
|
||||
expect(id.toB58String().length).to.equal(46)
|
||||
done()
|
||||
})
|
||||
})
|
||||
|
||||
it('isPeerId', (done) => {
|
||||
PeerId.create(testOpts, (err, id) => {
|
||||
expect(err).to.not.exist()
|
||||
expect(PeerId.isPeerId(id)).to.equal(true)
|
||||
expect(PeerId.isPeerId('aaa')).to.equal(false)
|
||||
expect(PeerId.isPeerId(Buffer.from('batatas'))).to.equal(false)
|
||||
done()
|
||||
})
|
||||
})
|
||||
|
||||
it('throws on changing the id', function (done) {
|
||||
this.timeout(10000)
|
||||
PeerId.create(testOpts, (err, id) => {
|
||||
expect(err).to.not.exist()
|
||||
expect(id.toB58String().length).to.equal(46)
|
||||
expect(() => {
|
||||
id.id = Buffer.from('hello')
|
||||
}).to.throw(/immutable/)
|
||||
done()
|
||||
})
|
||||
})
|
||||
|
||||
it('recreate an Id from Hex string', () => {
|
||||
const id = PeerId.createFromHexString(testIdHex)
|
||||
expect(testIdBytes).to.deep.equal(id.id)
|
||||
})
|
||||
|
||||
it('Recreate an Id from a Buffer', () => {
|
||||
const id = PeerId.createFromBytes(testIdBytes)
|
||||
expect(testId.id).to.equal(id.toHexString())
|
||||
})
|
||||
|
||||
it('Recreate a B58 String', () => {
|
||||
const id = PeerId.createFromB58String(testIdB58String)
|
||||
expect(testIdB58String).to.equal(id.toB58String())
|
||||
})
|
||||
|
||||
it('Recreate from a Public Key', (done) => {
|
||||
PeerId.createFromPubKey(testId.pubKey, (err, id) => {
|
||||
expect(err).to.not.exist()
|
||||
expect(testIdB58String).to.equal(id.toB58String())
|
||||
done()
|
||||
})
|
||||
})
|
||||
|
||||
it('Recreate from a Private Key', (done) => {
|
||||
PeerId.createFromPrivKey(testId.privKey, (err, id) => {
|
||||
expect(err).to.not.exist()
|
||||
expect(testIdB58String).to.equal(id.toB58String())
|
||||
|
||||
const encoded = Buffer.from(testId.privKey, 'base64')
|
||||
PeerId.createFromPrivKey(encoded, (err, id2) => {
|
||||
expect(err).to.not.exist()
|
||||
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()
|
||||
|
||||
PeerId.createFromPubKey(id1.marshalPubKey(), (err, id2) => {
|
||||
expect(err).to.not.exist()
|
||||
expect(id1.id).to.be.eql(id2.id)
|
||||
done()
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
it('Works with default options', function (done) {
|
||||
this.timeout(10000)
|
||||
PeerId.create((err, id) => {
|
||||
expect(err).to.not.exist()
|
||||
expect(id.toB58String().length).to.equal(46)
|
||||
done()
|
||||
})
|
||||
})
|
||||
|
||||
it('Non-default # of bits', function (done) {
|
||||
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()
|
||||
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.toPrint().privKey, (err, id2) => {
|
||||
expect(err).to.not.exist()
|
||||
expect(id1.toPrint()).to.be.eql(id2.toPrint())
|
||||
done()
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
it('toBytes', () => {
|
||||
const id = PeerId.createFromHexString(testIdHex)
|
||||
expect(id.toBytes().toString('hex')).to.equal(testIdBytes.toString('hex'))
|
||||
})
|
||||
|
||||
it('isEqual', (done) => {
|
||||
parallel([
|
||||
(cb) => PeerId.create(testOpts, cb),
|
||||
(cb) => PeerId.create(testOpts, cb)
|
||||
], (err, ids) => {
|
||||
expect(err).to.not.exist()
|
||||
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()
|
||||
})
|
||||
})
|
||||
|
||||
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()
|
||||
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()
|
||||
|
||||
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()
|
||||
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()
|
||||
expect(mh.toB58String(digest)).to.eql(goId.id)
|
||||
done()
|
||||
})
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
it('set privKey (valid)', (done) => {
|
||||
PeerId.create(testOpts, (err, peerId) => {
|
||||
expect(err).to.not.exist()
|
||||
peerId.privKey = peerId._privKey
|
||||
peerId.isValid(done)
|
||||
})
|
||||
})
|
||||
|
||||
it('set pubKey (valid)', (done) => {
|
||||
PeerId.create(testOpts, (err, peerId) => {
|
||||
expect(err).to.not.exist()
|
||||
peerId.pubKey = peerId._pubKey
|
||||
peerId.isValid(done)
|
||||
})
|
||||
})
|
||||
|
||||
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 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()
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
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 fncs = ['createFromPubKey', 'createFromPrivKey', 'createFromJSON']
|
||||
|
||||
garbage.forEach(garbage => {
|
||||
fncs.forEach(fnc => {
|
||||
it(fnc + '(' + util.inspect(garbage) + ')', cb => {
|
||||
PeerId[fnc](garbage, (err, res) => {
|
||||
expect(err).to.exist()
|
||||
expect(res).to.not.exist()
|
||||
cb()
|
||||
})
|
||||
})
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
describe('throws on inconsistent data', () => {
|
||||
let k1
|
||||
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()
|
||||
|
||||
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 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('invalid id', () => {
|
||||
expect(() => new PeerId('hello world')).to.throw(/invalid id/)
|
||||
})
|
||||
})
|
||||
})
|
29552
vendor/forge.bundle.js
vendored
29552
vendor/forge.bundle.js
vendored
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user