mirror of
https://github.com/fluencelabs/js-peer-id
synced 2025-07-04 03:31:50 +00:00
Compare commits
129 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 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 | |||
| 7635cfcfda | |||
| afbd96edda | |||
| c1e18ee420 | |||
| b358530dfb | |||
| 4afbedb525 | |||
| e9b107fc55 | |||
| 855a97956d | |||
| dee54d3dcc | |||
| 167b726dad | |||
| 3b9f8af2e7 | |||
| 771b994d7e | |||
| 524fc37877 | |||
| 3c55473a45 | |||
| 8771627ce4 | |||
| bbf6bae073 | |||
| e45a9f4083 | |||
| 13f98c8913 | |||
| f374ab4411 | |||
| 2f4cdd3725 | |||
| d2f90ff447 | |||
| f2a75f1188 | |||
| dab90bd3b6 | |||
| e9fdc0a27e | |||
| f0a17a9bd9 | |||
| 57ab8406c0 | |||
| f16c08e7fd | |||
| be5d4f9b41 | |||
| 35a3ccca3d | |||
| 989c3fb7a5 | |||
| bbe67df1c8 | |||
| 8849d90d6a | |||
| 2552871bcc | |||
| ab76788771 | |||
| f62023f8a7 | |||
| 95367871ac | |||
| 352a6cfa17 | |||
| 727355c4f5 | |||
| bd185f8081 | |||
| d4c3de1ecb | |||
| b692394116 | |||
| a8e591525b | |||
| 6ad5d85f76 | |||
| ca9cef6de7 | |||
| f55eebcef7 | |||
| 6442bb4b59 | |||
| 33ff2aa608 | |||
| bbeb6fc0f6 | |||
| f518ced776 | |||
| 73b42ff2aa | |||
| b3e3dbe3c0 | |||
| b2b90bfbb5 | |||
| d9113d55e0 | |||
| 59b89039b6 |
21
.gitignore
vendored
21
.gitignore
vendored
@ -1,7 +1,14 @@
|
||||
**/node_modules/
|
||||
**/*.log
|
||||
test/repo-tests*
|
||||
**/bundle.js
|
||||
|
||||
# Logs
|
||||
logs
|
||||
*.log
|
||||
|
||||
coverage
|
||||
|
||||
# Runtime data
|
||||
pids
|
||||
*.pid
|
||||
@ -19,9 +26,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
|
||||
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
|
||||
@ -1 +0,0 @@
|
||||
node_modules
|
||||
10
.jshintrc
10
.jshintrc
@ -1,10 +0,0 @@
|
||||
{
|
||||
"node": true,
|
||||
|
||||
"curly": true,
|
||||
"latedef": true,
|
||||
"quotmark": true,
|
||||
"undef": true,
|
||||
"unused": true,
|
||||
"trailing": true
|
||||
}
|
||||
28
.npmignore
Normal file
28
.npmignore
Normal file
@ -0,0 +1,28 @@
|
||||
# Logs
|
||||
logs
|
||||
*.log
|
||||
|
||||
# Runtime data
|
||||
pids
|
||||
*.pid
|
||||
*.seed
|
||||
|
||||
# Directory for instrumented libs generated by jscoverage/JSCover
|
||||
lib-cov
|
||||
|
||||
# Coverage directory used by tools like istanbul
|
||||
coverage
|
||||
|
||||
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
|
||||
.grunt
|
||||
|
||||
# Compiled binary addons (http://nodejs.org/api/addons.html)
|
||||
build/Release
|
||||
|
||||
# Optional npm cache directory
|
||||
.npm
|
||||
|
||||
# Optional REPL history
|
||||
.node_repl_history
|
||||
|
||||
test
|
||||
36
.travis.yml
36
.travis.yml
@ -1,21 +1,31 @@
|
||||
sudo: false
|
||||
language: node_js
|
||||
node_js:
|
||||
- "4.0"
|
||||
|
||||
branches:
|
||||
only:
|
||||
- master
|
||||
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
|
||||
|
||||
before_install:
|
||||
- npm i -g npm
|
||||
# Workaround for a permissions issue with Travis virtual machine images
|
||||
|
||||
addons:
|
||||
firefox: 'latest'
|
||||
script:
|
||||
- npm run lint
|
||||
- npm run test
|
||||
- npm run coverage -- --upload
|
||||
|
||||
before_script:
|
||||
- export DISPLAY=:99.0
|
||||
- sh -e /etc/init.d/xvfb start
|
||||
|
||||
script:
|
||||
- npm test
|
||||
after_success:
|
||||
- npm run coverage-publish
|
||||
|
||||
addons:
|
||||
firefox: 'latest'
|
||||
apt:
|
||||
sources:
|
||||
- ubuntu-toolchain-r-test
|
||||
packages:
|
||||
- g++-4.8
|
||||
|
||||
206
CHANGELOG.md
Normal file
206
CHANGELOG.md
Normal file
@ -0,0 +1,206 @@
|
||||
<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)
|
||||
|
||||
|
||||
|
||||
250
README.md
250
README.md
@ -1,88 +1,206 @@
|
||||
peer-id JavaScript implementation
|
||||
==============================
|
||||
# peer-id
|
||||
|
||||
[](http://ipn.io) [[](http://webchat.freenode.net/?channels=%23ipfs) ](https://travis-ci.org/diasdavid/js-peer-id)  [](https://david-dm.org/diasdavid/js-peer-id) [](https://github.com/feross/standard)
|
||||
> IPFS Peer Id implementation in JavaScript
|
||||
[](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)
|
||||
[](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
|
||||
|
||||
An IPFS Peer Id is based on a sha256 hash of the peer public key, using [multihash](https://github.com/jbenet/multihash)
|
||||
Generate, import, and export PeerIDs, for use with [IPFS](https://github.com/ipfs/ipfs).
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
# Usage
|
||||
|
||||
### In Node.js through npm
|
||||
|
||||
```bash
|
||||
$ npm install --save peer-id
|
||||
```
|
||||
|
||||
```javascript
|
||||
var PeerId = require('peer-id')
|
||||
```
|
||||
|
||||
### In the Browser through browserify
|
||||
|
||||
Same as in Node.js, you just have to [browserify](https://github.com/substack/node-browserify) the code before serving it. See the browserify repo for how to do that.
|
||||
|
||||
### In the Browser through `<script>` tag
|
||||
|
||||
Make the [peer-id.min.js](/dist/peer-id.min.js) available through your server and load it using a normal `<script>` tag, this will export the `peerId` constructor on the `window` object, such that:
|
||||
# Example
|
||||
|
||||
```JavaScript
|
||||
var PeerId = window.PeerId
|
||||
const PeerId = require('peer-id')
|
||||
|
||||
PeerId.create({ bits: 1024 }, (err, id) => {
|
||||
if (err) { throw err }
|
||||
console.log(JSON.stringify(id.toJSON(), null, 2))
|
||||
})
|
||||
```
|
||||
```bash
|
||||
{
|
||||
"id": "Qma9T5YraSnpRDZqRR4krcSJabThc8nwZuJV3LercPHufi",
|
||||
"privKey": "CAAS4AQwggJcAgEAAoGBAMBgbIqyOL26oV3nGPBYrdpbv..",
|
||||
"pubKey": "CAASogEwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMBgbIqyOL26oV3nGPBYrdpbvzCY..."
|
||||
}
|
||||
```
|
||||
|
||||
#### Gotchas
|
||||
# Installation
|
||||
|
||||
You will need to use Node.js `Buffer` API compatible, if you are running inside the browser, you can access it by `PeerId.Buffer` or you can install Feross's [Buffer](https://github.com/feross/buffer).
|
||||
## npm
|
||||
|
||||
### Creating a new Id
|
||||
|
||||
```
|
||||
var PeerId = require('ipfs-peer')
|
||||
|
||||
// Create a new Id
|
||||
var id = PeerId.create()
|
||||
|
||||
// Recreate an Id from Hex string
|
||||
var id = PeerId.createFromHexString(str)
|
||||
|
||||
// Recreate an Id from a Buffer
|
||||
var id = PeerId.createFromBytes(buf)
|
||||
|
||||
// Recreate an B58 String
|
||||
var id = PeerId.createFromB58String(str)
|
||||
|
||||
// Recreate from a Public Key
|
||||
var id = PeerId.createFromPubKey(pubKey)
|
||||
|
||||
// Recreate from a Private Key
|
||||
var id = PeerId.createFromPrivKey(privKey)
|
||||
```sh
|
||||
> npm i peer-id
|
||||
```
|
||||
|
||||
### Exporting an Id
|
||||
# Setup
|
||||
|
||||
```
|
||||
// Print friendly format
|
||||
id.toPrint() // returns an object with id, privKey and pubKey in hex format
|
||||
## Node.js
|
||||
|
||||
// Export to an hex string
|
||||
id.toHexString()
|
||||
|
||||
// Export to Buffer
|
||||
id.toBytes() (same as id.id)
|
||||
|
||||
// Export to a B58 string
|
||||
id.toB58String()
|
||||
```js
|
||||
const PeerId = require('peer-id')
|
||||
```
|
||||
|
||||
### Id format
|
||||
## Browser: Browserify, Webpack, other bundlers
|
||||
|
||||
The code published to npm that gets loaded on require is in fact a ES5
|
||||
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.
|
||||
|
||||
```js
|
||||
const PeerId = require('peer-id')
|
||||
```
|
||||
|
||||
## Browser: `<script>` Tag
|
||||
|
||||
Loading this module through a script tag will make the `PeerId` obj available in
|
||||
the global namespace.
|
||||
|
||||
```html
|
||||
<script src="https://unpkg.com/peer-id/dist/index.min.js"></script>
|
||||
<!-- OR -->
|
||||
<script src="https://unpkg.com/peer-id/dist/index.js"></script>
|
||||
```
|
||||
|
||||
# API
|
||||
|
||||
```js
|
||||
const PeerId = require('peer-id')
|
||||
```
|
||||
|
||||
## Create
|
||||
|
||||
### `new PeerId(id[, privKey, pubKey])`
|
||||
|
||||
- `id: Buffer` - The multihash of the publick 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)`
|
||||
|
||||
Generates a new Peer ID, complete with public/private keypair.
|
||||
|
||||
- `opts: Object`: Default: `{bits: 2048}`
|
||||
- `callback: Function`
|
||||
|
||||
Calls back `callback` with `err, id`.
|
||||
|
||||
## Import
|
||||
|
||||
### `createFromHexString(str)`
|
||||
|
||||
Creates a Peer ID from hex string representing the key's multihash.
|
||||
|
||||
### `createFromBytes(buf)`
|
||||
|
||||
Creates a Peer ID from a buffer representing the key's multihash.
|
||||
|
||||
### `createFromB58String(str)`
|
||||
Creates a Peer ID from a Base58 string representing the key's multihash.
|
||||
|
||||
### `createFromPubKey(pubKey)`
|
||||
|
||||
- `publicKey: Buffer`
|
||||
|
||||
Creates a Peer ID from a buffer containing a public key.
|
||||
|
||||
### `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
|
||||
|
||||
### `toHexString()`
|
||||
|
||||
Returns the Peer ID's `id` as a hex string.
|
||||
|
||||
```
|
||||
id.pubKey // Buffer containing the Public Key
|
||||
id.privKey // Buffer containing the Private Key
|
||||
id.id // Buffer containing the multihash
|
||||
1220d6243998f2fc56343ad7ed0342ab7886a4eb18d736f1b67d44b37fcc81e0f39f
|
||||
```
|
||||
|
||||
### `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>
|
||||
```
|
||||
|
||||
### `toB58String()`
|
||||
|
||||
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
|
||||
|
||||
14
circle.yml
Normal file
14
circle.yml
Normal file
@ -0,0 +1,14 @@
|
||||
machine:
|
||||
node:
|
||||
version: stable
|
||||
|
||||
dependencies:
|
||||
pre:
|
||||
- google-chrome --version
|
||||
- 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 install -f
|
||||
- sudo apt-get install --only-upgrade lsb-base
|
||||
- sudo dpkg -i google-chrome.deb
|
||||
- google-chrome --version
|
||||
29552
deps/forge.bundle.js
vendored
29552
deps/forge.bundle.js
vendored
File diff suppressed because it is too large
Load Diff
24225
dist/peer-id.js
vendored
24225
dist/peer-id.js
vendored
File diff suppressed because it is too large
Load Diff
11
dist/peer-id.min.js
vendored
11
dist/peer-id.min.js
vendored
File diff suppressed because one or more lines are too long
@ -1,57 +0,0 @@
|
||||
module.exports = function (config) {
|
||||
var path = require('path')
|
||||
var node_modules_dir = path.join(__dirname, 'node_modules')
|
||||
var deps = [
|
||||
'deps/forge.bundle.js'
|
||||
]
|
||||
config.set({
|
||||
basePath: '',
|
||||
frameworks: ['mocha'],
|
||||
|
||||
files: [
|
||||
'tests/test.js'
|
||||
],
|
||||
|
||||
preprocessors: {
|
||||
'tests/*': ['webpack']
|
||||
},
|
||||
|
||||
webpack: {
|
||||
resolve: {
|
||||
extensions: ['', '.js', '.json'],
|
||||
alias: { 'node-forge': __dirname + '/deps/forge.bundle.js' }
|
||||
},
|
||||
externals: {
|
||||
fs: '{}'
|
||||
},
|
||||
node: {
|
||||
Buffer: true
|
||||
},
|
||||
module: {
|
||||
loaders: [
|
||||
{ test: /\.json$/, loader: 'json' }
|
||||
],
|
||||
noParse: []
|
||||
}
|
||||
},
|
||||
|
||||
webpackMiddleware: {
|
||||
noInfo: true,
|
||||
stats: {
|
||||
colors: true
|
||||
}
|
||||
},
|
||||
reporters: ['spec'],
|
||||
port: 9876,
|
||||
colors: true,
|
||||
logLevel: config.LOG_INFO,
|
||||
autoWatch: false,
|
||||
browsers: process.env.TRAVIS ? ['Firefox'] : ['Chrome'],
|
||||
singleRun: true
|
||||
})
|
||||
|
||||
deps.forEach(function (dep) {
|
||||
var depPath = path.resolve(node_modules_dir, dep)
|
||||
config.webpack.module.noParse.push(depPath)
|
||||
})
|
||||
}
|
||||
75
package.json
75
package.json
@ -1,14 +1,19 @@
|
||||
{
|
||||
"name": "peer-id",
|
||||
"version": "0.5.0",
|
||||
"version": "0.10.2",
|
||||
"description": "IPFS Peer Id implementation in Node.js",
|
||||
"main": "src/index.js",
|
||||
"bin": "src/bin.js",
|
||||
"scripts": {
|
||||
"lint": "standard",
|
||||
"test": "npm run test:node && npm run test:browser",
|
||||
"test:node": "mocha tests/test.js",
|
||||
"test:browser": "karma start karma.conf.js",
|
||||
"coverage": "istanbul cover --print both -- _mocha tests/test.js"
|
||||
"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"
|
||||
@ -19,40 +24,40 @@
|
||||
"lint",
|
||||
"test"
|
||||
],
|
||||
"standard": {
|
||||
"ignore": [
|
||||
"dist",
|
||||
"deps"
|
||||
]
|
||||
},
|
||||
"engines": {
|
||||
"node": "^4.2.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": {
|
||||
"buffer-loader": "0.0.1",
|
||||
"chai": "^3.5.0",
|
||||
"istanbul": "^0.4.2",
|
||||
"json-loader": "^0.5.4",
|
||||
"karma": "^0.13.19",
|
||||
"karma-chrome-launcher": "^0.2.2",
|
||||
"karma-cli": "^0.1.2",
|
||||
"karma-firefox-launcher": "^0.1.7",
|
||||
"karma-mocha": "^0.2.1",
|
||||
"karma-spec-reporter": "0.0.24",
|
||||
"karma-webpack": "^1.7.0",
|
||||
"mocha": "^2.4.5",
|
||||
"pre-commit": "^1.1.1",
|
||||
"standard": "^5.3.1",
|
||||
"webpack": "^1.12.13"
|
||||
"aegir": "^12.0.8",
|
||||
"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.5.0",
|
||||
"libp2p-crypto": "~0.10.3",
|
||||
"lodash": "^4.17.4",
|
||||
"multihashes": "~0.4.9"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"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>",
|
||||
"Prashanth Chandra <coolshanth94@gmail.com>",
|
||||
"Richard Littauer <richard.littauer@gmail.com>",
|
||||
"Stephen Whitmore <stephen.whitmore@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>"
|
||||
]
|
||||
}
|
||||
|
||||
@ -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;
|
||||
}
|
||||
13
src/bin.js
Executable file
13
src/bin.js
Executable file
@ -0,0 +1,13 @@
|
||||
#!/usr/local/bin/node
|
||||
|
||||
'use strict'
|
||||
|
||||
const PeerId = require('./index.js')
|
||||
|
||||
PeerId.create((err, id) => {
|
||||
if (err) {
|
||||
throw err
|
||||
}
|
||||
|
||||
console.log(JSON.stringify(id.toJSON(), null, 2))
|
||||
})
|
||||
336
src/index.js
336
src/index.js
@ -2,163 +2,263 @@
|
||||
* Id is an object representation of a peer Id. a peer Id is a multihash
|
||||
*/
|
||||
|
||||
var fs = require('fs')
|
||||
var multihashing = require('multihashing')
|
||||
var base58 = require('bs58')
|
||||
var forge = require('node-forge')
|
||||
var protobuf = require('protocol-buffers')
|
||||
'use strict'
|
||||
|
||||
var isNode = !global.window
|
||||
const mh = require('multihashes')
|
||||
const crypto = require('libp2p-crypto')
|
||||
const assert = require('assert')
|
||||
const waterfall = require('async/waterfall')
|
||||
|
||||
// protobuf read from file
|
||||
var messages = isNode ? protobuf(fs.readFileSync(__dirname + '/../pb/crypto.proto'))
|
||||
: protobuf(require('buffer!./../pb/crypto.proto'))
|
||||
class PeerId {
|
||||
constructor (id, privKey, pubKey) {
|
||||
assert(Buffer.isBuffer(id), 'invalid id provided')
|
||||
|
||||
exports = module.exports = Id
|
||||
if (privKey && pubKey) {
|
||||
assert(privKey.public.bytes.equals(pubKey.bytes), 'inconsistent arguments')
|
||||
}
|
||||
|
||||
exports.Buffer = Buffer
|
||||
|
||||
function Id (id, privKey, pubKey) {
|
||||
var self = this
|
||||
|
||||
if (!(self instanceof Id)) {
|
||||
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
|
||||
}
|
||||
|
||||
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
|
||||
}
|
||||
}
|
||||
|
||||
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()
|
||||
}
|
||||
|
||||
self.toPrint = function () {
|
||||
// return the jsonified version of the key, matching the formatting
|
||||
// of go-ipfs for its config file
|
||||
toJSON () {
|
||||
return {
|
||||
id: self.toB58String(),
|
||||
privKey: privKey.toString('hex'),
|
||||
pubKey: 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 unmarshal (key) {
|
||||
var dpb = messages.PrivateKey.decode(key)
|
||||
return dpb
|
||||
}
|
||||
|
||||
// create a public key protobuf to be base64 string stored in config
|
||||
function marshal (data, type) {
|
||||
var epb
|
||||
if (type === 'Public') {
|
||||
epb = messages.PublicKey.encode({
|
||||
Type: 0,
|
||||
Data: data
|
||||
})
|
||||
}
|
||||
|
||||
if (type === 'Private') {
|
||||
epb = messages.PrivateKey.encode({
|
||||
Type: 0,
|
||||
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
|
||||
var der = forge.asn1.toDer(key)
|
||||
|
||||
// create forge buffer of der public key buffer
|
||||
var fDerBuf = forge.util.createBuffer(der.data, 'binary')
|
||||
|
||||
// convert forge buffer to node buffer public key
|
||||
var nDerBuf = new Buffer(fDerBuf.getBytes(), 'binary')
|
||||
|
||||
// protobuf the new DER bytes to the PublicKey Data: field
|
||||
var marshalKey = marshal(nDerBuf, type)
|
||||
|
||||
// encode the protobuf public key to base64 string
|
||||
var b64 = marshalKey.toString('base64')
|
||||
return b64
|
||||
}
|
||||
exports = module.exports = PeerId
|
||||
|
||||
// generation
|
||||
exports.create = function () {
|
||||
// generate keys
|
||||
var pair = forge.rsa.generateKeyPair({ bits: 2048, e: 0x10001 })
|
||||
exports.create = function (opts, callback) {
|
||||
if (typeof opts === 'function') {
|
||||
callback = opts
|
||||
opts = {}
|
||||
}
|
||||
opts = opts || {}
|
||||
opts.bits = opts.bits || 2048
|
||||
|
||||
// return the RSA public/private key to asn1 object
|
||||
var asnPub = forge.pki.publicKeyToAsn1(pair.publicKey)
|
||||
var asnPriv = forge.pki.privateKeyToAsn1(pair.privateKey)
|
||||
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)
|
||||
}
|
||||
|
||||
// format the keys to protobuf base64 encoded string
|
||||
var protoPublic64 = formatKey(asnPub, 'Public')
|
||||
var protoPrivate64 = formatKey(asnPriv, 'Private')
|
||||
|
||||
var mhId = multihashing(new Buffer(protoPublic64, 'base64'), 'sha2-256')
|
||||
|
||||
return new Id(mhId, protoPrivate64, protoPublic64)
|
||||
callback(null, new PeerId(digest, privKey))
|
||||
})
|
||||
}
|
||||
|
||||
exports.createFromHexString = function (str) {
|
||||
return new Id(new Buffer(str, 'hex'))
|
||||
return new PeerId(mh.fromHexString(str))
|
||||
}
|
||||
|
||||
exports.createFromBytes = function (buf) {
|
||||
return new Id(buf)
|
||||
return new PeerId(buf)
|
||||
}
|
||||
|
||||
exports.createFromB58String = function (str) {
|
||||
return new Id(new Buffer(base58.decode(str)))
|
||||
return new PeerId(mh.fromB58String(str))
|
||||
}
|
||||
|
||||
exports.createFromPubKey = function (pubKey) {
|
||||
var buf = new Buffer(pubKey, 'base64')
|
||||
var mhId = multihashing(buf, 'sha2-256')
|
||||
return new Id(mhId, null, pubKey)
|
||||
// Public Key input will be a buffer
|
||||
exports.createFromPubKey = function (key, callback) {
|
||||
if (typeof callback !== 'function') {
|
||||
throw new Error('callback is required')
|
||||
}
|
||||
|
||||
let buf = key
|
||||
if (typeof buf === 'string') {
|
||||
buf = Buffer.from(key, 'base64')
|
||||
}
|
||||
|
||||
const pubKey = crypto.keys.unmarshalPublicKey(buf)
|
||||
|
||||
pubKey.hash((err, digest) => {
|
||||
if (err) {
|
||||
return callback(err)
|
||||
}
|
||||
|
||||
callback(null, new PeerId(digest, null, pubKey))
|
||||
})
|
||||
}
|
||||
|
||||
exports.createFromPrivKey = function (privKey) {
|
||||
// create a buffer from the base64 encoded string
|
||||
var buf = new Buffer(privKey, 'base64')
|
||||
// Private key input will be a string
|
||||
exports.createFromPrivKey = function (key, callback) {
|
||||
let buf = key
|
||||
if (typeof buf === 'string') {
|
||||
buf = Buffer.from(key, 'base64')
|
||||
}
|
||||
|
||||
// get the private key data from the protobuf
|
||||
var mpk = unmarshal(buf)
|
||||
if (typeof callback !== 'function') {
|
||||
throw new Error('callback is required')
|
||||
}
|
||||
|
||||
// create a forge buffer
|
||||
var fbuf = forge.util.createBuffer(mpk.Data.toString('binary'))
|
||||
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)
|
||||
}
|
||||
|
||||
// create an asn1 object from the private key bytes saved in the protobuf Data: field
|
||||
var asnPriv = forge.asn1.fromDer(fbuf)
|
||||
|
||||
// get the RSA privatekey data from the asn1 object
|
||||
var privateKey = forge.pki.privateKeyFromAsn1(asnPriv)
|
||||
|
||||
// set the RSA public key to the modulus and exponent of the private key
|
||||
var publicKey = forge.pki.rsa.setPublicKey(privateKey.n, privateKey.e)
|
||||
|
||||
// return the RSA public key to asn1 object
|
||||
var asnPub = forge.pki.publicKeyToAsn1(publicKey)
|
||||
|
||||
// format the public key
|
||||
var protoPublic64 = formatKey(asnPub, 'Public')
|
||||
var mhId = multihashing(new Buffer(protoPublic64, 'base64'), 'sha2-256')
|
||||
return new Id(mhId, privKey, protoPublic64)
|
||||
callback(null, new PeerId(digest, privKey, privKey.public))
|
||||
})
|
||||
}
|
||||
|
||||
exports.createFromJSON = function (obj, callback) {
|
||||
if (typeof callback !== 'function') {
|
||||
throw new Error('callback is required')
|
||||
}
|
||||
|
||||
const id = mh.fromB58String(obj.id)
|
||||
const rawPrivKey = obj.privKey && Buffer.from(obj.privKey, 'base64')
|
||||
const rawPubKey = obj.pubKey && Buffer.from(obj.pubKey, 'base64')
|
||||
const pub = rawPubKey && crypto.keys.unmarshalPublicKey(rawPubKey)
|
||||
|
||||
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='
|
||||
}
|
||||
56
tests/test.js → test/fixtures/sample-id.js
vendored
56
tests/test.js → test/fixtures/sample-id.js
vendored
@ -1,59 +1,7 @@
|
||||
/* globals describe, it */
|
||||
|
||||
'use strict'
|
||||
|
||||
const expect = require('chai').expect
|
||||
const PeerId = require('../src')
|
||||
|
||||
const testId = {
|
||||
id: '1220151ab1658d8294ab34b71d5582cfe20d06414212f440a69366f1bc31deb5c72d',
|
||||
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='
|
||||
}
|
||||
|
||||
const testIdHex = '1220151ab1658d8294ab34b71d5582cfe20d06414212f440a69366f1bc31deb5c72d'
|
||||
|
||||
const testIdBytes = new Buffer('1220151ab1658d8294ab34b71d5582cfe20d06414212f440a69366f1bc31deb5c72d', 'hex')
|
||||
|
||||
const testIdB58String = 'QmQ2zigjQikYnyYUSXZydNXrDRhBut2mubwJBaLXobMt3A'
|
||||
|
||||
describe('id', function (done) {
|
||||
this.timeout(30000)
|
||||
|
||||
it('create a new id', done => {
|
||||
var id = PeerId.create()
|
||||
expect(id.toB58String().length).to.equal(46)
|
||||
done()
|
||||
})
|
||||
|
||||
it('recreate an Id from Hex string', done => {
|
||||
var id = PeerId.createFromHexString(testIdHex)
|
||||
expect(testIdBytes).to.deep.equal(id.id)
|
||||
done()
|
||||
})
|
||||
|
||||
it('Recreate an Id from a Buffer', done => {
|
||||
var id = PeerId.createFromBytes(testIdBytes)
|
||||
expect(testId.id).to.equal(id.toHexString())
|
||||
done()
|
||||
})
|
||||
|
||||
it('Recreate a B58 String', done => {
|
||||
var id = PeerId.createFromB58String(testIdB58String)
|
||||
expect(testIdB58String).to.equal(id.toB58String())
|
||||
done()
|
||||
})
|
||||
|
||||
it('Recreate from a Public Key', done => {
|
||||
var id = PeerId.createFromPubKey(testId.pubKey)
|
||||
expect(testIdB58String).to.equal(id.toB58String())
|
||||
done()
|
||||
})
|
||||
|
||||
it('Recreate from a Private Key', done => {
|
||||
var id = PeerId.createFromPrivKey(testId.privKey)
|
||||
expect(testIdB58String).to.equal(id.toB58String())
|
||||
done()
|
||||
})
|
||||
})
|
||||
|
||||
275
test/peer-id.spec.js
Normal file
275
test/peer-id.spec.js
Normal file
@ -0,0 +1,275 @@
|
||||
/* 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 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')
|
||||
|
||||
describe('PeerId', () => {
|
||||
it('create an id without \'new\'', () => {
|
||||
expect(PeerId).to.throw(Error)
|
||||
})
|
||||
|
||||
it('create a new id', (done) => {
|
||||
PeerId.create((err, id) => {
|
||||
expect(err).to.not.exist()
|
||||
expect(id.toB58String().length).to.equal(46)
|
||||
done()
|
||||
})
|
||||
})
|
||||
|
||||
it('isPeerId', (done) => {
|
||||
PeerId.create((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', (done) => {
|
||||
PeerId.create((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((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('Non-default # of bits', function (done) {
|
||||
// rsa is slow atm
|
||||
this.timeout(100000)
|
||||
PeerId.create({ bits: 1024 }, (err, shortId) => {
|
||||
expect(err).to.not.exist()
|
||||
PeerId.create({ bits: 4096 }, (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((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(cb),
|
||||
(cb) => PeerId.create(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({ bits: 1024 }, (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((err, peerId) => {
|
||||
expect(err).to.not.exist()
|
||||
peerId.privKey = peerId._privKey
|
||||
peerId.isValid(done)
|
||||
})
|
||||
})
|
||||
|
||||
it('set pubKey (valid)', (done) => {
|
||||
PeerId.create((err, peerId) => {
|
||||
expect(err).to.not.exist()
|
||||
peerId.pubKey = peerId._pubKey
|
||||
peerId.isValid(done)
|
||||
})
|
||||
})
|
||||
|
||||
it('set privKey (invalid)', (done) => {
|
||||
PeerId.create((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((err, peerId) => {
|
||||
expect(err).to.not.exist()
|
||||
peerId.pubKey = Buffer.from('buffff')
|
||||
peerId.isValid((err) => {
|
||||
expect(err).to.exist()
|
||||
done()
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
describe('throws on inconsistent data', () => {
|
||||
let k1
|
||||
let k2
|
||||
let k3
|
||||
|
||||
before((done) => {
|
||||
parallel([
|
||||
(cb) => crypto.keys.generateKeyPair('RSA', 1024, cb),
|
||||
(cb) => crypto.keys.generateKeyPair('RSA', 1024, cb),
|
||||
(cb) => crypto.keys.generateKeyPair('RSA', 1024, 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/)
|
||||
})
|
||||
})
|
||||
})
|
||||
Reference in New Issue
Block a user