mirror of
https://github.com/fluencelabs/js-peer-id
synced 2025-07-04 03:01:54 +00:00
Compare commits
100 Commits
Author | SHA1 | Date | |
---|---|---|---|
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 | |||
1cdbf19857 | |||
845bd088fe | |||
1f72aaf7b7 | |||
effa21b892 | |||
91bc56eb05 | |||
3cc3cb31f0 | |||
de572bd15f | |||
1a336f9289 | |||
77790571aa | |||
d9b9ca8812 | |||
67c26ec546 | |||
58fe038e07 | |||
61c0c663d6 | |||
8adbdd0d6e | |||
7ae9be8f71 | |||
16c77433f9 | |||
6ce01ab434 | |||
5cb511c646 | |||
370e5c55b1 | |||
e3cc273a14 | |||
2c1874a689 | |||
3c0c9a3b19 | |||
d7ab4bd8fb | |||
9aee5bf670 | |||
5e9bf9837d | |||
f82d0d6ac5 | |||
0b30a0964c | |||
9b2cb012e9 | |||
35102b4ad5 | |||
192c65f09a | |||
dda0204ec0 | |||
1096d15a16 | |||
615a966d6a | |||
171a561537 | |||
fa62838777 | |||
bb2f23633d | |||
d472664924 | |||
2cc1a8ac59 |
16
.aegir.js
Normal file
16
.aegir.js
Normal file
@ -0,0 +1,16 @@
|
||||
'use strict'
|
||||
|
||||
const path = require('path')
|
||||
|
||||
module.exports = {
|
||||
webpack: {
|
||||
resolve: {
|
||||
alias: {
|
||||
'node-forge': path.resolve(
|
||||
path.dirname(require.resolve('libp2p-crypto')),
|
||||
'../vendor/forge.bundle.js'
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
3
.gitignore
vendored
3
.gitignore
vendored
@ -25,3 +25,6 @@ build/Release
|
||||
# Dependency directory
|
||||
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
|
||||
node_modules
|
||||
|
||||
lib
|
||||
dist
|
@ -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
|
25
.travis.yml
Normal file
25
.travis.yml
Normal file
@ -0,0 +1,25 @@
|
||||
sudo: false
|
||||
language: node_js
|
||||
node_js:
|
||||
- 4
|
||||
- 5
|
||||
- stable
|
||||
|
||||
# Make sure we have new NPM.
|
||||
before_install:
|
||||
- npm install -g npm
|
||||
|
||||
script:
|
||||
- npm run lint
|
||||
- npm 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
|
196
README.md
196
README.md
@ -1,66 +1,172 @@
|
||||
ipfs-peer-id Node.js implementation
|
||||
===================================
|
||||
# peer-id
|
||||
|
||||
[](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://github.com/feross/standard)
|
||||
|
||||
> IPFS Peer Id implementation in Node.js
|
||||
> [IPFS](https://github.com/ipfs/ipfs) Peer ID implementation in JavaScript.
|
||||
|
||||
# Description
|
||||
|
||||
A IPFS Peer Id is based on a sha256 has 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).
|
||||
|
||||
# Usage
|
||||
*A Peer ID is the SHA-256 [multihash](https://github.com/jbenet/multihash) of a
|
||||
public key.*
|
||||
|
||||
### Installing
|
||||
*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.*
|
||||
|
||||
```
|
||||
$ npm install ipfs-peer-id
|
||||
# Example
|
||||
|
||||
```js
|
||||
var PeerId = require('peer-id')
|
||||
var bs58 = require('bs58')
|
||||
|
||||
var id = PeerId.create({ bits: 32 })
|
||||
|
||||
console.log('id ', id.toB58String())
|
||||
console.log('priv key ', bs58.encode(id.privKey.bytes))
|
||||
console.log('pub key ', bs58.encode(id.pubKey.bytes))
|
||||
```
|
||||
|
||||
### Creating a new Id
|
||||
|
||||
```
|
||||
var PeerId = require('ipfs-peer')
|
||||
|
||||
// Create a new Id
|
||||
var id = new Id.create()
|
||||
|
||||
// Recreate an Id from Hex string
|
||||
var id = new Id.createFromHexString(str)
|
||||
|
||||
// Recreate an Id from a Buffer
|
||||
var id = new Id.createFromBytes(buf)
|
||||
|
||||
// Recreate an B58 String
|
||||
var id = new Id.createFromB58String(str)
|
||||
|
||||
// Recreate from a Public Key
|
||||
var id = new Id.createFromPubKey(pubKey)
|
||||
|
||||
// Recreate from a Private Key
|
||||
var id = new Id.createFromPrivKey(privKey)
|
||||
id QmeeLFb92nkZJGj3gXLqXrEMzCMYs6uBgQLVNbrcXEvYXk
|
||||
priv key 6ibrcPAbevzvPpkq6EA6XmLyuhmUrJrEvUfgQDtEiSEPzGnGU8Ejwf6b11DVm6opnFGo
|
||||
pub key 2BeBZVKJ9RQs4i4LbGv4ReEeuBA5dck2Gje3wt67e44XuyyPq5jE
|
||||
```
|
||||
|
||||
### Exporting an Id
|
||||
# Installation
|
||||
|
||||
```
|
||||
// Print friendly format
|
||||
id.toPrint() // returns an object with id, privKey and pubKey in hex format
|
||||
## npm
|
||||
|
||||
// Export to an hex string
|
||||
id.toHexString()
|
||||
|
||||
// Export to Buffer
|
||||
id.toBytes() (same as id.id)
|
||||
|
||||
// Export to a B58 string
|
||||
id.toB58String()
|
||||
```sh
|
||||
> npm i peer-id
|
||||
```
|
||||
|
||||
### Id format
|
||||
# Setup
|
||||
|
||||
## Node.js
|
||||
|
||||
```js
|
||||
var PeerId = require('peer-id')
|
||||
```
|
||||
|
||||
## 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
|
||||
var 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://npmcdn.com/peer-id/dist/index.min.js"></script>
|
||||
<!-- OR -->
|
||||
<script src="https://npmcdn.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/ipfs/js-libp2p-crypto).
|
||||
|
||||
### `create([opts])`
|
||||
|
||||
Generates a new Peer ID, complete with public/private keypair.
|
||||
|
||||
- `opts: Object`: Default: `{bits: 2048}`
|
||||
|
||||
## 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)`
|
||||
|
||||
Creates a Peer ID from a buffer containing a public key.
|
||||
|
||||
### `createFromPrivKey(privKey)`
|
||||
|
||||
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()`.
|
||||
|
||||
|
||||
# License
|
||||
|
||||
MIT
|
||||
|
12
circle.yml
Normal file
12
circle.yml
Normal file
@ -0,0 +1,12 @@
|
||||
machine:
|
||||
node:
|
||||
version: stable
|
||||
|
||||
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'
|
||||
- sudo apt-get update
|
||||
- sudo apt-get --only-upgrade install google-chrome-stable
|
||||
- google-chrome --version
|
58
package.json
58
package.json
@ -1,12 +1,21 @@
|
||||
{
|
||||
"name": "ipfs-peer-id",
|
||||
"version": "0.2.0",
|
||||
"name": "peer-id",
|
||||
"version": "0.7.0",
|
||||
"description": "IPFS Peer Id implementation in Node.js",
|
||||
"main": "src/index.js",
|
||||
"main": "lib/index.js",
|
||||
"bin": "src/bin.js",
|
||||
"jsnext:main": "src/index.js",
|
||||
"scripts": {
|
||||
"test": "./node_modules/.bin/lab tests/*-test.js",
|
||||
"coverage": "./node_modules/.bin/lab -t 100 tests/*-test.js",
|
||||
"codestyle": "./node_modules/.bin/standard --format"
|
||||
"lint": "aegir-lint",
|
||||
"build": "aegir-build",
|
||||
"test": "aegir-test",
|
||||
"test:node": "aegir-test node",
|
||||
"test:browser": "aegir-test browser",
|
||||
"release": "aegir-release",
|
||||
"release-minor": "aegir-release --type minor",
|
||||
"release-major": "aegir-release --type major",
|
||||
"coverage": "aegir-coverage",
|
||||
"coverage-publish": "aegir-coverage publish"
|
||||
},
|
||||
"keywords": [
|
||||
"IPFS"
|
||||
@ -14,21 +23,34 @@
|
||||
"author": "David Dias <daviddias@ipfs.io>",
|
||||
"license": "MIT",
|
||||
"pre-commit": [
|
||||
"codestyle",
|
||||
"lint",
|
||||
"test"
|
||||
],
|
||||
"bugs": {
|
||||
"url": "https://github.com/diasdavid/node-ipfs-peer-id/issues"
|
||||
"engines": {
|
||||
"node": "^4.3.0"
|
||||
},
|
||||
"homepage": "https://github.com/diasdavid/node-ipfs-peer-id",
|
||||
"bugs": {
|
||||
"url": "https://github.com/diasdavid/js-peer-id/issues"
|
||||
},
|
||||
"homepage": "https://github.com/diasdavid/js-peer-id",
|
||||
"devDependencies": {
|
||||
"code": "^1.4.1",
|
||||
"lab": "^5.13.0",
|
||||
"precommit-hook": "^3.0.0",
|
||||
"standard": "^4.5.2"
|
||||
"aegir": "^3.1.1",
|
||||
"chai": "^3.5.0",
|
||||
"pre-commit": "^1.1.3"
|
||||
},
|
||||
"dependencies": {
|
||||
"bs58": "^2.0.1",
|
||||
"multihashing": "^0.1.3"
|
||||
}
|
||||
}
|
||||
"libp2p-crypto": "^0.5.0",
|
||||
"multihashes": "^0.2.2"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/diasdavid/js-peer-id.git"
|
||||
},
|
||||
"contributors": [
|
||||
"David Dias <daviddias.p@gmail.com>",
|
||||
"David Dias <mail@daviddias.me>",
|
||||
"Stephen Whitmore <stephen.whitmore@gmail.com>",
|
||||
"dignifiedquire <dignifiedquire@gmail.com>",
|
||||
"nginnever <ginneversource@gmail.com>"
|
||||
]
|
||||
}
|
7
src/bin.js
Executable file
7
src/bin.js
Executable file
@ -0,0 +1,7 @@
|
||||
#!/usr/local/bin/node
|
||||
|
||||
'use strict'
|
||||
|
||||
const PeerId = require('./index.js')
|
||||
|
||||
console.log(JSON.stringify(PeerId.create().toJSON(), null, ' '))
|
148
src/index.js
148
src/index.js
@ -2,77 +2,151 @@
|
||||
* Id is an object representation of a peer Id. a peer Id is a multihash
|
||||
*/
|
||||
|
||||
var multihashing = require('multihashing')
|
||||
var base58 = require('bs58')
|
||||
var crypto = require('crypto')
|
||||
'use strict'
|
||||
|
||||
exports = module.exports = Id
|
||||
const mh = require('multihashes')
|
||||
const crypto = require('libp2p-crypto')
|
||||
const assert = require('assert')
|
||||
|
||||
function Id (id, privKey, pubKey) {
|
||||
var self = this
|
||||
class PeerId {
|
||||
constructor (id, privKey, pubKey) {
|
||||
assert(Buffer.isBuffer(id), 'invalid id provided')
|
||||
|
||||
if (!(self instanceof Id)) {
|
||||
throw new Error('Id must be called with new')
|
||||
if (pubKey) {
|
||||
assert(id.equals(pubKey.hash()), 'inconsistent arguments')
|
||||
}
|
||||
|
||||
if (privKey) {
|
||||
assert(id.equals(privKey.public.hash()), 'inconsistent arguments')
|
||||
}
|
||||
|
||||
if (privKey && pubKey) {
|
||||
assert(privKey.public.bytes.equals(pubKey.bytes), 'inconsistent arguments')
|
||||
}
|
||||
|
||||
this.id = id
|
||||
this.privKey = privKey
|
||||
this._pubKey = pubKey
|
||||
}
|
||||
|
||||
self.privKey = privKey
|
||||
self.pubKey = pubKey
|
||||
self.id = id // multihash - sha256 - buffer
|
||||
get pubKey () {
|
||||
if (this._pubKey) {
|
||||
return this._pubKey
|
||||
}
|
||||
|
||||
if (this.privKey) {
|
||||
return this.privKey.public
|
||||
}
|
||||
}
|
||||
|
||||
// Return the protobuf version of the public key,
|
||||
// matching go ipfs formatting
|
||||
marshalPubKey () {
|
||||
if (this.pubKey) {
|
||||
return crypto.marshalPublicKey(this.pubKey)
|
||||
}
|
||||
}
|
||||
|
||||
// Return the protobuf version of the private key,
|
||||
// matching go ipfs formatting
|
||||
marshalPrivKey () {
|
||||
if (this.privKey) {
|
||||
return crypto.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: id.toHexString(),
|
||||
privKey: privKey.toString('hex'),
|
||||
pubKey: pubKey.toString('hex')
|
||||
id: mh.toB58String(this.id),
|
||||
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 mh.toB58String(this.id)
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
exports = module.exports = PeerId
|
||||
exports.Buffer = Buffer
|
||||
|
||||
// generation
|
||||
exports.create = function (opts) {
|
||||
opts = opts || {}
|
||||
opts.bits = opts.bits || 2048
|
||||
|
||||
exports.create = function () {
|
||||
var ecdh = crypto.createECDH('secp256k1')
|
||||
ecdh.generateKeys()
|
||||
const privKey = crypto.generateKeyPair('RSA', opts.bits)
|
||||
|
||||
var mhId = multihashing(ecdh.getPublicKey(), 'sha2-256')
|
||||
|
||||
return new Id(mhId, ecdh.getPrivateKey(), ecdh.getPublicKey())
|
||||
return new PeerId(privKey.public.hash(), 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 mhId = multihashing(pubKey, 'sha2-256')
|
||||
return new Id(mhId, null, pubKey)
|
||||
// Public Key input will be a buffer
|
||||
exports.createFromPubKey = function (key) {
|
||||
let buf = key
|
||||
if (typeof buf === 'string') {
|
||||
buf = new Buffer(key, 'base64')
|
||||
}
|
||||
const pubKey = crypto.unmarshalPublicKey(buf)
|
||||
return new PeerId(pubKey.hash(), null, pubKey)
|
||||
}
|
||||
|
||||
exports.createFromPrivKey = function () {
|
||||
// TODO(daviddias) derive PubKey from priv
|
||||
// Private key input will be a string
|
||||
exports.createFromPrivKey = function (key) {
|
||||
let buf = key
|
||||
if (typeof buf === 'string') {
|
||||
buf = new Buffer(key, 'base64')
|
||||
}
|
||||
|
||||
const privKey = crypto.unmarshalPrivateKey(buf)
|
||||
return new PeerId(privKey.public.hash(), privKey)
|
||||
}
|
||||
|
||||
exports.createFromJSON = function (obj) {
|
||||
let priv
|
||||
let pub
|
||||
|
||||
if (obj.privKey) {
|
||||
priv = crypto.unmarshalPrivateKey(new Buffer(obj.privKey, 'base64'))
|
||||
}
|
||||
|
||||
if (obj.pubKey) {
|
||||
pub = crypto.unmarshalPublicKey(new Buffer(obj.pubKey, 'base64'))
|
||||
}
|
||||
|
||||
return new PeerId(mh.fromB58String(obj.id), priv, pub)
|
||||
}
|
||||
|
||||
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='
|
||||
}
|
170
test/index.spec.js
Normal file
170
test/index.spec.js
Normal file
@ -0,0 +1,170 @@
|
||||
/* eslint-env mocha */
|
||||
'use strict'
|
||||
|
||||
const expect = require('chai').expect
|
||||
const crypto = require('libp2p-crypto')
|
||||
const mh = require('multihashes')
|
||||
|
||||
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', () => {
|
||||
const id = PeerId.create()
|
||||
expect(id.toB58String().length).to.equal(46)
|
||||
})
|
||||
|
||||
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', () => {
|
||||
const id = PeerId.createFromPubKey(testId.pubKey)
|
||||
expect(testIdB58String).to.equal(id.toB58String())
|
||||
})
|
||||
|
||||
it('Recreate from a Private Key', () => {
|
||||
const id = PeerId.createFromPrivKey(testId.privKey)
|
||||
expect(testIdB58String).to.equal(id.toB58String())
|
||||
|
||||
const id2 = PeerId.createFromPrivKey(new Buffer(testId.privKey, 'base64'))
|
||||
expect(testIdB58String).to.equal(id2.toB58String())
|
||||
})
|
||||
|
||||
it('Compare generated ID with one created from PubKey', () => {
|
||||
const id1 = PeerId.create()
|
||||
const id2 = PeerId.createFromPubKey(id1.marshalPubKey())
|
||||
expect(id1.id).to.be.eql(id2.id)
|
||||
})
|
||||
|
||||
it('Non-default # of bits', () => {
|
||||
const shortId = PeerId.create({ bits: 128 })
|
||||
const longId = PeerId.create({ bits: 256 })
|
||||
expect(shortId.privKey.bytes.length).is.below(longId.privKey.bytes.length)
|
||||
})
|
||||
|
||||
it('Pretty printing', () => {
|
||||
const id = PeerId.createFromPrivKey(testId.privKey)
|
||||
const out = id.toPrint()
|
||||
|
||||
expect(out.id).to.equal(testIdB58String)
|
||||
expect(out.privKey).to.equal(testId.privKey)
|
||||
expect(out.pubKey).to.equal(testId.pubKey)
|
||||
})
|
||||
|
||||
it('toBytes', () => {
|
||||
const id = PeerId.createFromHexString(testIdHex)
|
||||
expect(id.toBytes().toString('hex')).to.equal(testIdBytes.toString('hex'))
|
||||
})
|
||||
|
||||
describe('toJSON', () => {
|
||||
it('full node', () => {
|
||||
const id = PeerId.create({bits: 64})
|
||||
expect(
|
||||
id.toB58String()
|
||||
).to.equal(
|
||||
PeerId.createFromJSON(id.toJSON()).toB58String()
|
||||
)
|
||||
expect(
|
||||
id.privKey.bytes
|
||||
).to.deep.equal(
|
||||
PeerId.createFromJSON(id.toJSON()).privKey.bytes
|
||||
)
|
||||
expect(
|
||||
id.pubKey.bytes
|
||||
).to.deep.equal(
|
||||
PeerId.createFromJSON(id.toJSON()).pubKey.bytes
|
||||
)
|
||||
})
|
||||
|
||||
it('only id', () => {
|
||||
const key = crypto.generateKeyPair('RSA', 64)
|
||||
const id = PeerId.createFromBytes(key.public.hash())
|
||||
expect(
|
||||
id.toB58String()
|
||||
).to.equal(
|
||||
PeerId.createFromJSON(id.toJSON()).toB58String()
|
||||
)
|
||||
|
||||
expect(id.privKey).to.not.exist
|
||||
expect(id.pubKey).to.not.exist
|
||||
})
|
||||
|
||||
it('go interop', () => {
|
||||
const id = PeerId.createFromJSON(goId)
|
||||
|
||||
expect(
|
||||
mh.toB58String(id.privKey.public.hash())
|
||||
).to.be.eql(
|
||||
goId.id
|
||||
)
|
||||
})
|
||||
})
|
||||
|
||||
describe('throws on inconsistent data', () => {
|
||||
const k1 = crypto.generateKeyPair('RSA', 64)
|
||||
const k2 = crypto.generateKeyPair('RSA', 64)
|
||||
const k3 = crypto.generateKeyPair('RSA', 64)
|
||||
|
||||
it('missmatch id - private key', () => {
|
||||
expect(
|
||||
() => new PeerId(k1.public.hash(), k2)
|
||||
).to.throw(
|
||||
/inconsistent arguments/
|
||||
)
|
||||
})
|
||||
|
||||
it('missmatch id - public key', () => {
|
||||
expect(
|
||||
() => new PeerId(k1.public.hash(), null, k2.public)
|
||||
).to.throw(
|
||||
/inconsistent arguments/
|
||||
)
|
||||
})
|
||||
|
||||
it('missmatch private - public key', () => {
|
||||
expect(
|
||||
() => new PeerId(k1.public.hash(), k1, k2.public)
|
||||
).to.throw(
|
||||
/inconsistent arguments/
|
||||
)
|
||||
})
|
||||
|
||||
it('missmatch id - private - public key', () => {
|
||||
expect(
|
||||
() => new PeerId(k1.public.hash(), k1, k3.public)
|
||||
).to.throw(
|
||||
/inconsistent arguments/
|
||||
)
|
||||
})
|
||||
|
||||
it('invalid id', () => {
|
||||
expect(
|
||||
() => new PeerId(k1.public.hash().toString())
|
||||
).to.throw(
|
||||
/invalid id/
|
||||
)
|
||||
})
|
||||
})
|
||||
})
|
Reference in New Issue
Block a user