chore: release version v0.7.0

refactor: use libp2p and standardized rsa keys

.aegir.js

@@ -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'
+        )
+      }
+    }
+  }
+}

.travis.yml

@@ -1,11 +1,18 @@
+sudo: false
 language: node_js
 node_js:
   - 4
   - 5
+  - stable
 
+# Make sure we have new NPM.
 before_install:
-  - npm i -g npm
+  - npm install -g npm
-  # Workaround for a permissions issue with Travis virtual machine images
+
+script:
+  - npm run lint
+  - npm test
+  - npm run coverage
 
 addons:
   firefox: 'latest'
@@ -14,6 +21,5 @@ before_script:
   - export DISPLAY=:99.0
   - sh -e /etc/init.d/xvfb start
 
-script:
+after_success:
-  - npm run lint
+  - npm run coverage-publish
-  - npm test

README.md

@@ -3,7 +3,7 @@
 [![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
 [![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
 [![Build Status](https://travis-ci.org/diasdavid/js-peer-id.svg?style=flat-square)](https://travis-ci.org/diasdavid/js-peer-id)
-![](https://img.shields.io/badge/coverage-100%25-brightgreen.svg?style=flat-square)
+[![Coverage Status](https://coveralls.io/repos/github/diasdavid/js-peer-id/badge.svg?branch=master)](https://coveralls.io/github/diasdavid/js-peer-id?branch=master)
 [![Dependency Status](https://david-dm.org/diasdavid/js-peer-id.svg?style=flat-square)](https://david-dm.org/diasdavid/js-peer-id)
 [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
 
@@ -29,8 +29,8 @@ var bs58 = require('bs58')
 var id = PeerId.create({ bits: 32 })
 
 console.log('id        ', id.toB58String())
-console.log('priv key  ', bs58.encode(id.privKey))
+console.log('priv key  ', bs58.encode(id.privKey.bytes))
-console.log('pub key   ', bs58.encode(id.pubKey))
+console.log('pub key   ', bs58.encode(id.pubKey.bytes))
 ```
 
 ```
@@ -51,7 +51,7 @@ pub key    2BeBZVKJ9RQs4i4LbGv4ReEeuBA5dck2Gje3wt67e44XuyyPq5jE
 
 ## Node.js
 
-```JavaScript
+```js
 var PeerId = require('peer-id')
 ```
 
@@ -62,7 +62,7 @@ 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
+```js
 var PeerId = require('peer-id')
 ```
 
@@ -85,73 +85,88 @@ 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
+- `id: Buffer` - The multihash of the publick key as `Buffer`
-following properties:
+- `privKey: RsaPrivateKey` - The private key
+- `pubKey: RsaPublicKey` - The public key
 
-- `pubKey` - Buffer containing the public key bytes
+The key format is detailed in [libp2p-crypto](https://github.com/ipfs/js-libp2p-crypto).
-- `privKey` - Buffer containing the private key bytes
+
-- `id` - Buffer containing the multihash bytes
+### `create([opts])`
+
+Generates a new Peer ID, complete with public/private keypair.
+
+- `opts: Object`: Default: `{bits: 2048}`
 
 ## 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)`
 
 Creates a Peer ID from a buffer containing a public key.
 
-### PeerId.createFromPrivKey(privKey)
+### `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
 
-### id.toPrint()
+### `toHexString()`
-
-Returns an object with the ID's properties in hex format:
-```js
-{
-  id: 'QmckZzdVd72h9QUFuJJpQqhsZqGLwjhh81qSvZ9BhB2FQi',
-  privKey: '080012a609308204a20201000282010100a608889914da08959d3a3db0734cee812c96...',
-  pubKey: '080012a60230820122300d06092a864886f70d01010105000382010f003082010a0282010...'
-}
-```
-
-### id.toHexString()
 
 Returns the Peer ID's `id` as a hex string.
 
-```js
+```
-1220d6243998f2fc56343ad7ed0342ab7886a4eb18d736f1b67d44b37fcc81e0f39f```
+1220d6243998f2fc56343ad7ed0342ab7886a4eb18d736f1b67d44b37fcc81e0f39f
+```
 
-### id.toBytes()
+### `toBytes()`
 
 Returns the Peer ID's `id` as a buffer.
 
-
+```
-```js
 <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.
 
-```js
+```
 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

circle.yml

@@ -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

package.json

@@ -1,17 +1,21 @@
 {
   "name": "peer-id",
-  "version": "0.6.6",
+  "version": "0.7.0",
   "description": "IPFS Peer Id implementation in Node.js",
   "main": "lib/index.js",
+  "bin": "src/bin.js",
   "jsnext:main": "src/index.js",
   "scripts": {
-    "lint": "dignified-lint",
+    "lint": "aegir-lint",
-    "build": "dignified-build",
+    "build": "aegir-build",
-    "test": "dignified-test",
+    "test": "aegir-test",
-    "test:node": "dignified-test node",
+    "test:node": "aegir-test node",
-    "test:browser": "dignified-test browser",
+    "test:browser": "aegir-test browser",
-    "release": "dignified-release",
+    "release": "aegir-release",
-    "coverage": "dignified-coverage"
+    "release-minor": "aegir-release --type minor",
+    "release-major": "aegir-release --type major",
+    "coverage": "aegir-coverage",
+    "coverage-publish": "aegir-coverage publish"
   },
   "keywords": [
     "IPFS"
@@ -30,29 +34,23 @@
   },
   "homepage": "https://github.com/diasdavid/js-peer-id",
   "devDependencies": {
-    "buffer-loader": "0.0.1",
+    "aegir": "^3.1.1",
     "chai": "^3.5.0",
-    "dignified.js": "^1.0.0",
+    "pre-commit": "^1.1.3"
-    "istanbul": "^0.4.2",
-    "pre-commit": "^1.1.1"
   },
   "dependencies": {
-    "bs58": "^3.0.0",
+    "libp2p-crypto": "^0.5.0",
-    "multihashing": "^0.2.0",
+    "multihashes": "^0.2.2"
-    "node-forge": "^0.6.38",
-    "protocol-buffers": "^3.1.4"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/diasdavid/js-peer-id.git"
   },
-  "dignified": {
+  "contributors": [
-    "webpack": {
+    "David Dias <daviddias.p@gmail.com>",
-      "resolve": {
+    "David Dias <mail@daviddias.me>",
-        "alias": {
+    "Stephen Whitmore <stephen.whitmore@gmail.com>",
-          "node-forge": "../vendor/forge.bundle.js"
+    "dignifiedquire <dignifiedquire@gmail.com>",
-        }
+    "nginnever <ginneversource@gmail.com>"
-      }
+  ]
-    }
+}
-  }
-}

protos/crypto.proto

@@ -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;
-}

src/bin.js

@@ -0,0 +1,7 @@
+#!/usr/local/bin/node
+
+'use strict'
+
+const PeerId = require('./index.js')
+
+console.log(JSON.stringify(PeerId.create().toJSON(), null, '  '))

src/index.js

@@ -1,175 +1,152 @@
 /*
  * Id is an object representation of a peer Id. a peer Id is a multihash
  */
+
 'use strict'
 
-const fs = require('fs')
+const mh = require('multihashes')
-const multihashing = require('multihashing')
+const crypto = require('libp2p-crypto')
-const base58 = require('bs58')
+const assert = require('assert')
-const forge = require('node-forge')
-const protobuf = require('protocol-buffers')
-const path = require('path')
 
-// protobuf read from file
+class PeerId {
-const messages = protobuf(fs.readFileSync(path.resolve(__dirname, '../protos/crypto.proto')))
+  constructor (id, privKey, pubKey) {
+    assert(Buffer.isBuffer(id), 'invalid id provided')
 
-exports = module.exports = Id
+    if (pubKey) {
+      assert(id.equals(pubKey.hash()), 'inconsistent arguments')
+    }
 
-exports.Buffer = Buffer
+    if (privKey) {
+      assert(id.equals(privKey.public.hash()), 'inconsistent arguments')
+    }
 
-function Id (id, privKey, pubKey) {
+    if (privKey && pubKey) {
-  const self = this
+      assert(privKey.public.bytes.equals(pubKey.bytes), 'inconsistent arguments')
+    }
 
-  if (!(self instanceof Id)) {
+    this.id = id
-    throw new Error('Id must be called with new')
+    this.privKey = privKey
+    this._pubKey = pubKey
   }
 
-  self.privKey = privKey
+  get pubKey () {
-  self.pubKey = pubKey
+    if (this._pubKey) {
-  self.id = id // multihash - sha256 - buffer
+      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
-  self.toPrint = function () {
+  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.toB58String(),
+      id: mh.toB58String(this.id),
-      privKey: privKey.toString('hex'),
+      privKey: toB64Opt(this.marshalPrivKey()),
-      pubKey: pubKey.toString('hex')
+      pubKey: toB64Opt(this.marshalPubKey())
     }
   }
 
   // encode/decode functions
-  self.toHexString = function () {
+  toHexString () {
-    return self.id.toString('hex')
+    return mh.toHexString(this.id)
   }
 
-  self.toBytes = function () {
+  toBytes () {
-    return self.id
+    return this.id
   }
 
-  self.toB58String = function () {
+  toB58String () {
-    return base58.encode(self.id)
+    return mh.toB58String(this.id)
   }
 }
 
-// unwrap the private key protobuf
+exports = module.exports = PeerId
-function unmarshal (key) {
+exports.Buffer = Buffer
-  return messages.PrivateKey.decode(key)
-}
-
-// 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
-  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 marshalKey = marshal(nDerBuf, type)
-
-  // encode the protobuf public key to base64 string
-  const b64 = marshalKey.toString('base64')
-  return b64
-}
 
 // generation
 exports.create = function (opts) {
   opts = opts || {}
   opts.bits = opts.bits || 2048
 
-  // generate keys
+  const privKey = crypto.generateKeyPair('RSA', opts.bits)
-  const pair = forge.rsa.generateKeyPair({
-    bits: opts.bits,
-    e: 0x10001
-  })
 
-  // return the RSA public/private key to asn1 object
+  return new PeerId(privKey.public.hash(), privKey)
-  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 Id(mhId, bufProtoPriv64, bufProtoPub64)
 }
 
 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))
 }
 
 // Public Key input will be a buffer
-exports.createFromPubKey = function (pubKey) {
+exports.createFromPubKey = function (key) {
-  const buf = new Buffer(pubKey, 'base64')
+  let buf = key
-  const mhId = multihashing(buf, 'sha2-256')
+  if (typeof buf === 'string') {
-  return new Id(mhId, null, pubKey)
+    buf = new Buffer(key, 'base64')
+  }
+  const pubKey = crypto.unmarshalPublicKey(buf)
+  return new PeerId(pubKey.hash(), null, pubKey)
 }
 
 // Private key input will be a string
-exports.createFromPrivKey = function (privKey) {
+exports.createFromPrivKey = function (key) {
-  // create a buffer from the base64 encoded string
+  let buf = key
-  const buf = new Buffer(privKey, 'base64')
+  if (typeof buf === 'string') {
+    buf = new Buffer(key, 'base64')
+  }
 
-  // get the private key data from the protobuf
+  const privKey = crypto.unmarshalPrivateKey(buf)
-  const mpk = unmarshal(buf)
+  return new PeerId(privKey.public.hash(), privKey)
-
+}
-  // create a forge buffer
+
-  const fbuf = forge.util.createBuffer(mpk.Data.toString('binary'))
+exports.createFromJSON = function (obj) {
-
+  let priv
-  // create an asn1 object from the private key bytes saved in the protobuf Data: field
+  let pub
-  const asnPriv = forge.asn1.fromDer(fbuf)
+
-
+  if (obj.privKey) {
-  // get the RSA privatekey data from the asn1 object
+    priv = crypto.unmarshalPrivateKey(new Buffer(obj.privKey, 'base64'))
-  const privateKey = forge.pki.privateKeyFromAsn1(asnPriv)
+  }
-
+
-  // set the RSA public key to the modulus and exponent of the private key
+  if (obj.pubKey) {
-  const publicKey = forge.pki.rsa.setPublicKey(privateKey.n, privateKey.e)
+    pub = crypto.unmarshalPublicKey(new Buffer(obj.pubKey, 'base64'))
-
+  }
-  // return the RSA public key to asn1 object
+
-  const asnPub = forge.pki.publicKeyToAsn1(publicKey)
+  return new PeerId(mh.fromB58String(obj.id), priv, pub)
-
+}
-  // format the public key
+
-  const protoPublic64 = formatKey(asnPub, 'Public')
+function toB64Opt (val) {
-
+  if (val) {
-  // buffer the public key for consistency before storing
+    return val.toString('base64')
-  const bufProtoPub64 = new Buffer(protoPublic64, 'base64')
+  }
-  const mhId = multihashing(new Buffer(protoPublic64, 'base64'), 'sha2-256')
-  return new Id(mhId, privKey, bufProtoPub64)
 }

test/fixtures/go-private-key.js

@@ -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='
+}

test/fixtures/sample-id.js

@@ -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='
+}

test/index.spec.js

@@ -2,95 +2,169 @@
 'use strict'
 
 const expect = require('chai').expect
+const crypto = require('libp2p-crypto')
+const mh = require('multihashes')
+
 const PeerId = require('../src')
 
-const testId = {
+const testId = require('./fixtures/sample-id')
-  id: '1220151ab1658d8294ab34b71d5582cfe20d06414212f440a69366f1bc31deb5c72d',
+const testIdHex = testId.id
-  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==',
+const testIdBytes = mh.fromHexString(testId.id)
-  pubKey: 'CAASpgIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC2SKo/HMFZeBml1AF3XijzrxrfQXdJzjePBZAbdxqKR1Mc6juRHXij6HXYPjlAk01BhF1S3Ll4Lwi0cAHhggf457sMg55UWyeGKeUv0ucgvCpBwlR5cQ020i0MgzjPWOLWq1rtvSbNcAi2ZEVn6+Q2EcHo3wUvWRtLeKz+DZSZfw2PEDC+DGPJPl7f8g7zl56YymmmzH9liZLNrzg/qidokUv5u1pdGrcpLuPNeTODk0cqKB+OUbuKj9GShYECCEjaybJDl9276oalL9ghBtSeEv20kugatTvYy590wFlJkkvyl+nPxIH0EEYMKK9XRWlu9XYnoSfboiwcv8M3SlsjAgMBAAE='
+const testIdB58String = mh.toB58String(testIdBytes)
-}
 
-const testIdHex = '1220151ab1658d8294ab34b71d5582cfe20d06414212f440a69366f1bc31deb5c72d'
+const goId = require('./fixtures/go-private-key')
 
-const testIdBytes = new Buffer('1220151ab1658d8294ab34b71d5582cfe20d06414212f440a69366f1bc31deb5c72d', 'hex')
+describe('PeerId', () => {
-
+  it('create an id without \'new\'', () => {
-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) => {
+  it('create a new id', () => {
     const id = PeerId.create()
     expect(id.toB58String().length).to.equal(46)
-    done()
   })
 
-  it('recreate an Id from Hex string', (done) => {
+  it('recreate an Id from Hex string', () => {
     const id = PeerId.createFromHexString(testIdHex)
     expect(testIdBytes).to.deep.equal(id.id)
-    done()
   })
 
-  it('Recreate an Id from a Buffer', (done) => {
+  it('Recreate an Id from a Buffer', () => {
     const id = PeerId.createFromBytes(testIdBytes)
     expect(testId.id).to.equal(id.toHexString())
-    done()
   })
 
-  it('Recreate a B58 String', (done) => {
+  it('Recreate a B58 String', () => {
     const id = PeerId.createFromB58String(testIdB58String)
     expect(testIdB58String).to.equal(id.toB58String())
-    done()
   })
 
-  it('Recreate from a Public Key', (done) => {
+  it('Recreate from a Public Key', () => {
     const id = PeerId.createFromPubKey(testId.pubKey)
     expect(testIdB58String).to.equal(id.toB58String())
-    done()
   })
 
-  it('Recreate from a Private Key', (done) => {
+  it('Recreate from a Private Key', () => {
     const id = PeerId.createFromPrivKey(testId.privKey)
     expect(testIdB58String).to.equal(id.toB58String())
-    done()
+
+    const id2 = PeerId.createFromPrivKey(new Buffer(testId.privKey, 'base64'))
+    expect(testIdB58String).to.equal(id2.toB58String())
   })
 
-  it('Compare generated ID with one created from PubKey', (done) => {
+  it('Compare generated ID with one created from PubKey', () => {
     const id1 = PeerId.create()
-    const id2 = PeerId.createFromPubKey(id1.pubKey)
+    const id2 = PeerId.createFromPubKey(id1.marshalPubKey())
-    expect(id2.id).to.deep.equal(id1.id)
+    expect(id1.id).to.be.eql(id2.id)
-    done()
   })
 
-  it('Non-default # of bits', (done) => {
+  it('Non-default # of bits', () => {
     const shortId = PeerId.create({ bits: 128 })
     const longId = PeerId.create({ bits: 256 })
-    expect(shortId.privKey.length).is.below(longId.privKey.length)
+    expect(shortId.privKey.bytes.length).is.below(longId.privKey.bytes.length)
-    done()
   })
 
-  it('Pretty printing', (done) => {
+  it('Pretty printing', () => {
     const id = PeerId.createFromPrivKey(testId.privKey)
-    var out = id.toPrint()
+    const out = id.toPrint()
-    var expected = {
+
-      id: 'QmQ2zigjQikYnyYUSXZydNXrDRhBut2mubwJBaLXobMt3A',
+    expect(out.id).to.equal(testIdB58String)
-      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==',
+    expect(out.privKey).to.equal(testId.privKey)
-      pubKey: '080012a60230820122300d06092a864886f70d01010105000382010f003082010a0282010100b648aa3f1cc1597819a5d401775e28f3af1adf417749ce378f05901b771a8a47531cea3b911d78a3e875d83e3940934d41845d52dcb9782f08b47001e18207f8e7bb0c839e545b278629e52fd2e720bc2a41c25479710d36d22d0c8338cf58e2d6ab5aedbd26cd7008b6644567ebe43611c1e8df052f591b4b78acfe0d94997f0d8f1030be0c63c93e5edff20ef3979e98ca69a6cc7f658992cdaf383faa2768914bf9bb5a5d1ab7292ee3cd79338393472a281f8e51bb8a8fd1928581020848dac9b24397ddbbea86a52fd82106d49e12fdb492e81ab53bd8cb9f74c05949924bf297e9cfc481f410460c28af5745696ef57627a127dba22c1cbfc3374a5b230203010001'
+    expect(out.pubKey).to.equal(testId.pubKey)
-    }
-    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) => {
+  it('toBytes', () => {
     const id = PeerId.createFromHexString(testIdHex)
     expect(id.toBytes().toString('hex')).to.equal(testIdBytes.toString('hex'))
-    done()
+  })
+
+  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/
+      )
+    })
   })
 })