chore: release version v0.10.6

* Updating CI files

This commit updates all CI scripts to the latest version

* Faster tests

.gitignore

@@ -1,3 +1,4 @@
+docs
 **/node_modules/
 **/*.log
 test/repo-tests*
@@ -32,6 +33,7 @@ build
 # 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
@@ -40,3 +42,4 @@ test/test-data/go-ipfs-repo/LOG.old
 
 # while testing npm5
 package-lock.json
+yarn.lock

.travis.yml

@@ -1,3 +1,4 @@
+# Warning: This file is automatically synced from https://github.com/ipfs/ci-sync so if you want to change it, please change it there and ask someone to sync all repositories.
 sudo: false
 language: node_js
 
@@ -14,7 +15,6 @@ script:
   - npm run lint
   - npm run test
   - npm run coverage
-  - make test
 
 before_script:
   - export DISPLAY=:99.0

CHANGELOG.md

@@ -0,0 +1,236 @@
+<a name="0.10.6"></a>
+## [0.10.6](https://github.com/libp2p/js-peer-id/compare/v0.10.5...v0.10.6) (2018-02-12)
+
+
+
+<a name="0.10.5"></a>
+## [0.10.5](https://github.com/libp2p/js-peer-id/compare/v0.10.4...v0.10.5) (2018-01-28)
+
+
+
+<a name="0.10.4"></a>
+## [0.10.4](https://github.com/libp2p/js-peer-id/compare/v0.10.3...v0.10.4) (2017-12-20)
+
+
+### Bug Fixes
+
+* update dependencies ([#73](https://github.com/libp2p/js-peer-id/issues/73)) ([8b9a134](https://github.com/libp2p/js-peer-id/commit/8b9a134))
+
+
+
+<a name="0.10.3"></a>
+## [0.10.3](https://github.com/libp2p/js-peer-id/compare/v0.10.2...v0.10.3) (2017-12-01)
+
+
+### Bug Fixes
+
+* catch error when unmarshaling instead of crashing ([#72](https://github.com/libp2p/js-peer-id/issues/72)) ([156911e](https://github.com/libp2p/js-peer-id/commit/156911e))
+
+
+
+<a name="0.10.2"></a>
+## [0.10.2](https://github.com/libp2p/js-peer-id/compare/v0.10.1...v0.10.2) (2017-10-12)
+
+
+### Bug Fixes
+
+* Always add public key to constructor if possible, Fix for undefined pubKey in remote peers ([#68](https://github.com/libp2p/js-peer-id/issues/68)) ([3abdcda](https://github.com/libp2p/js-peer-id/commit/3abdcda))
+
+
+
+<a name="0.10.1"></a>
+## [0.10.1](https://github.com/libp2p/js-peer-id/compare/v0.10.0...v0.10.1) (2017-09-07)
+
+
+### Features
+
+* **deps:** update aegir and libp2p-crypto ([#67](https://github.com/libp2p/js-peer-id/issues/67)) ([d7088d6](https://github.com/libp2p/js-peer-id/commit/d7088d6))
+
+
+
+<a name="0.10.0"></a>
+# [0.10.0](https://github.com/libp2p/js-peer-id/compare/v0.9.0...v0.10.0) (2017-09-03)
+
+
+### Features
+
+* p2p addrs situation ([#66](https://github.com/libp2p/js-peer-id/issues/66)) ([63428fa](https://github.com/libp2p/js-peer-id/commit/63428fa))
+
+
+
+<a name="0.9.0"></a>
+# [0.9.0](https://github.com/libp2p/js-peer-id/compare/v0.8.8...v0.9.0) (2017-07-22)
+
+
+### Features
+
+* use next libp2p-crypto ([#64](https://github.com/libp2p/js-peer-id/issues/64)) ([442df13](https://github.com/libp2p/js-peer-id/commit/442df13))
+
+
+
+<a name="0.8.8"></a>
+## [0.8.8](https://github.com/libp2p/js-peer-id/compare/v0.8.7...v0.8.8) (2017-07-21)
+
+
+
+<a name="0.8.7"></a>
+## [0.8.7](https://github.com/libp2p/js-peer-id/compare/v0.8.6...v0.8.7) (2017-04-03)
+
+
+### Features
+
+* set privKey pubKey ([ac27907](https://github.com/libp2p/js-peer-id/commit/ac27907))
+
+
+
+<a name="0.8.6"></a>
+## [0.8.6](https://github.com/libp2p/js-peer-id/compare/v0.8.5...v0.8.6) (2017-03-30)
+
+
+### Features
+
+* isEqual ([3f4f670](https://github.com/libp2p/js-peer-id/commit/3f4f670))
+
+
+
+<a name="0.8.5"></a>
+## [0.8.5](https://github.com/libp2p/js-peer-id/compare/v0.8.4...v0.8.5) (2017-03-27)
+
+
+### Bug Fixes
+
+* avoid using constructor.name ([a3fe1a2](https://github.com/libp2p/js-peer-id/commit/a3fe1a2))
+
+
+### Features
+
+* isPeerId ([0acc572](https://github.com/libp2p/js-peer-id/commit/0acc572))
+
+
+
+<a name="0.8.4"></a>
+## [0.8.4](https://github.com/libp2p/js-peer-id/compare/v0.8.2...v0.8.4) (2017-03-16)
+
+
+
+<a name="0.8.2"></a>
+## [0.8.2](https://github.com/libp2p/js-peer-id/compare/v0.8.1...v0.8.2) (2017-02-09)
+
+
+
+<a name="0.8.1"></a>
+## [0.8.1](https://github.com/libp2p/js-peer-id/compare/v0.8.0...v0.8.1) (2016-12-18)
+
+
+### Features
+
+* cache b58 id ([bebb0a7](https://github.com/libp2p/js-peer-id/commit/bebb0a7))
+* create b58 string on creation and throw on id mutation ([78d96d0](https://github.com/libp2p/js-peer-id/commit/78d96d0))
+
+
+
+<a name="0.8.0"></a>
+# [0.8.0](https://github.com/libp2p/js-peer-id/compare/v0.7.0...v0.8.0) (2016-11-03)
+
+
+* Async Crypto Endeavour (#33) ([31701e2](https://github.com/libp2p/js-peer-id/commit/31701e2))
+
+
+### BREAKING CHANGES
+
+* This changes the interface of .create, .createFromPrivKey,
+.createFromPubKey, .createFromJSON
+
+
+
+<a name="0.7.0"></a>
+# [0.7.0](https://github.com/libp2p/js-peer-id/compare/v0.6.7...v0.7.0) (2016-05-26)
+
+
+### Bug Fixes
+
+* code review and docs and go interop ([58f1933](https://github.com/libp2p/js-peer-id/commit/58f1933))
+* use new version of libp2p-crypto ([ab55046](https://github.com/libp2p/js-peer-id/commit/ab55046))
+
+
+
+<a name="0.6.7"></a>
+## [0.6.7](https://github.com/libp2p/js-peer-id/compare/v0.6.6...v0.6.7) (2016-05-23)
+
+
+
+<a name="0.6.6"></a>
+## [0.6.6](https://github.com/libp2p/js-peer-id/compare/v0.6.5...v0.6.6) (2016-04-12)
+
+
+
+<a name="0.6.5"></a>
+## [0.6.5](https://github.com/libp2p/js-peer-id/compare/v0.6.1...v0.6.5) (2016-04-12)
+
+
+
+<a name="0.6.1"></a>
+## [0.6.1](https://github.com/libp2p/js-peer-id/compare/v0.6.0...v0.6.1) (2016-03-15)
+
+
+
+<a name="0.6.0"></a>
+# [0.6.0](https://github.com/libp2p/js-peer-id/compare/v0.5.3...v0.6.0) (2016-03-10)
+
+
+
+<a name="0.5.3"></a>
+## [0.5.3](https://github.com/libp2p/js-peer-id/compare/v0.5.1...v0.5.3) (2016-03-05)
+
+
+
+<a name="0.5.1"></a>
+## [0.5.1](https://github.com/libp2p/js-peer-id/compare/v0.5.0...v0.5.1) (2016-03-03)
+
+
+
+<a name="0.5.0"></a>
+# [0.5.0](https://github.com/libp2p/js-peer-id/compare/v0.4.0...v0.5.0) (2016-02-14)
+
+
+
+<a name="0.4.0"></a>
+# [0.4.0](https://github.com/libp2p/js-peer-id/compare/v0.3.4...v0.4.0) (2015-11-05)
+
+
+
+<a name="0.3.4"></a>
+## [0.3.4](https://github.com/libp2p/js-peer-id/compare/v0.3.3...v0.3.4) (2015-10-28)
+
+
+
+<a name="0.3.3"></a>
+## [0.3.3](https://github.com/libp2p/js-peer-id/compare/v0.3.2...v0.3.3) (2015-09-15)
+
+
+
+<a name="0.3.2"></a>
+## [0.3.2](https://github.com/libp2p/js-peer-id/compare/v0.3.1...v0.3.2) (2015-09-14)
+
+
+
+<a name="0.3.1"></a>
+## [0.3.1](https://github.com/libp2p/js-peer-id/compare/v0.3.0...v0.3.1) (2015-08-25)
+
+
+
+<a name="0.3.0"></a>
+# [0.3.0](https://github.com/libp2p/js-peer-id/compare/v0.2.0...v0.3.0) (2015-07-19)
+
+
+
+<a name="0.2.0"></a>
+# [0.2.0](https://github.com/libp2p/js-peer-id/compare/v0.1.0...v0.2.0) (2015-07-17)
+
+
+
+<a name="0.1.0"></a>
+# 0.1.0 (2015-07-08)
+
+
+

appveyor.yml

@@ -0,0 +1,29 @@
+# Warning: This file is automatically synced from https://github.com/ipfs/ci-sync so if you want to change it, please change it there and ask someone to sync all repositories.
+version: "{build}"
+
+environment:
+  matrix:
+    - nodejs_version: "6"
+    - nodejs_version: "8"
+
+matrix:
+  fast_finish: true
+
+install:
+  # Install Node.js
+  - ps: Install-Product node $env:nodejs_version
+
+  # Upgrade npm
+  - npm install -g npm
+
+  # Output our current versions for debugging
+  - node --version
+  - npm --version
+
+  # Install our package dependencies
+  - npm install
+
+test_script:
+  - npm run test:node
+
+build: off

ci/Jenkinsfile

@@ -0,0 +1,2 @@
+// Warning: This file is automatically synced from https://github.com/ipfs/ci-sync so if you want to change it, please change it there and ask someone to sync all repositories.
+javascript()

circle.yml

@@ -1,3 +1,4 @@
+# Warning: This file is automatically synced from https://github.com/ipfs/ci-sync so if you want to change it, please change it there and ask someone to sync all repositories.
 machine:
   node:
     version: stable

package.json

@@ -1,20 +1,19 @@
 {
   "name": "peer-id",
-  "version": "0.10.0",
+  "version": "0.10.6",
   "description": "IPFS Peer Id implementation in Node.js",
   "main": "src/index.js",
   "bin": "src/bin.js",
   "scripts": {
-    "lint": "aegir-lint",
+    "lint": "aegir lint",
-    "build": "aegir-build",
+    "build": "aegir build",
-    "test": "aegir-test",
+    "test": "aegir test",
-    "test:node": "aegir-test node",
+    "test:node": "aegir test -t node",
-    "test:browser": "aegir-test browser",
+    "test:browser": "aegir test -t browser -t webworker",
-    "release": "aegir-release",
+    "release": "aegir release",
-    "release-minor": "aegir-release --type minor",
+    "release-minor": "aegir release --type minor",
-    "release-major": "aegir-release --type major",
+    "release-major": "aegir release --type major",
-    "coverage": "aegir-coverage",
+    "coverage": "aegir coverage"
-    "coverage-publish": "aegir-coverage publish"
   },
   "keywords": [
     "IPFS"
@@ -34,16 +33,16 @@
   },
   "homepage": "https://github.com/libp2p/js-peer-id",
   "devDependencies": {
-    "aegir": "^11.0.2",
+    "aegir": "^12.4.0",
     "chai": "^4.1.2",
     "dirty-chai": "^2.0.1",
     "pre-commit": "^1.2.2"
   },
   "dependencies": {
-    "async": "^2.5.0",
+    "async": "^2.6.0",
-    "libp2p-crypto": "~0.9.4",
+    "libp2p-crypto": "~0.12.1",
-    "lodash": "^4.17.4",
+    "lodash": "^4.17.5",
-    "multihashes": "~0.4.9"
+    "multihashes": "~0.4.13"
   },
   "repository": {
     "type": "git",
@@ -53,11 +52,15 @@
     "David Dias <daviddias.p@gmail.com>",
     "David Dias <mail@daviddias.me>",
     "Friedel Ziegelmayer <dignifiedquire@gmail.com>",
+    "Maciej Krüger <mkg20001@gmail.com>",
     "Prashanth Chandra <coolshanth94@gmail.com>",
     "Richard Littauer <richard.littauer@gmail.com>",
+    "Richard Schneider <makaretu@gmail.com>",
     "Stephen Whitmore <stephen.whitmore@gmail.com>",
+    "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>"
+    "npmcdn-to-unpkg-bot <npmcdn-to-unpkg-bot@users.noreply.github.com>",
+    "ᴠɪᴄᴛᴏʀ ʙᴊᴇʟᴋʜᴏʟᴍ <victorbjelkholm@gmail.com>"
   ]
-}
+}

src/index.js

@@ -8,7 +8,6 @@ const mh = require('multihashes')
 const crypto = require('libp2p-crypto')
 const assert = require('assert')
 const waterfall = require('async/waterfall')
-const Buffer = require('safe-buffer').Buffer
 
 class PeerId {
   constructor (id, privKey, pubKey) {
@@ -166,12 +165,20 @@ exports.createFromPubKey = function (key, callback) {
     throw new Error('callback is required')
   }
 
-  let buf = key
+  let pubKey
-  if (typeof buf === 'string') {
-    buf = Buffer.from(key, 'base64')
-  }
 
-  const pubKey = crypto.keys.unmarshalPublicKey(buf)
+  try {
+    let buf = key
+    if (typeof buf === 'string') {
+      buf = Buffer.from(key, 'base64')
+    }
+
+    if (!Buffer.isBuffer(buf)) throw new Error('Supplied key is neither a base64 string nor a buffer')
+
+    pubKey = crypto.keys.unmarshalPublicKey(buf)
+  } catch (err) {
+    return callback(err)
+  }
 
   pubKey.hash((err, digest) => {
     if (err) {
@@ -184,15 +191,22 @@ exports.createFromPubKey = function (key, callback) {
 
 // Private key input will be a string
 exports.createFromPrivKey = function (key, callback) {
-  let buf = key
-  if (typeof buf === 'string') {
-    buf = Buffer.from(key, 'base64')
-  }
-
   if (typeof callback !== 'function') {
     throw new Error('callback is required')
   }
 
+  let buf = key
+
+  try {
+    if (typeof buf === 'string') {
+      buf = Buffer.from(key, 'base64')
+    }
+
+    if (!Buffer.isBuffer(buf)) throw new Error('Supplied key is neither a base64 string nor a buffer')
+  } catch (err) {
+    return callback(err)
+  }
+
   waterfall([
     (cb) => crypto.keys.unmarshalPrivateKey(buf, cb),
     (privKey, cb) => privKey.public.hash((err, digest) => {
@@ -203,7 +217,7 @@ exports.createFromPrivKey = function (key, callback) {
       return callback(err)
     }
 
-    callback(null, new PeerId(digest, privKey))
+    callback(null, new PeerId(digest, privKey, privKey.public))
   })
 }
 
@@ -212,10 +226,19 @@ exports.createFromJSON = function (obj, callback) {
     throw new Error('callback is required')
   }
 
-  const id = mh.fromB58String(obj.id)
+  let id
-  const rawPrivKey = obj.privKey && Buffer.from(obj.privKey, 'base64')
+  let rawPrivKey
-  const rawPubKey = obj.pubKey && Buffer.from(obj.pubKey, 'base64')
+  let rawPubKey
-  const pub = rawPubKey && crypto.keys.unmarshalPublicKey(rawPubKey)
+  let pub
+
+  try {
+    id = mh.fromB58String(obj.id)
+    rawPrivKey = obj.privKey && Buffer.from(obj.privKey, 'base64')
+    rawPubKey = obj.pubKey && Buffer.from(obj.pubKey, 'base64')
+    pub = rawPubKey && crypto.keys.unmarshalPublicKey(rawPubKey)
+  } catch (err) {
+    return callback(err)
+  }
 
   if (rawPrivKey) {
     waterfall([

test/peer-id.spec.js

@@ -9,10 +9,11 @@ const expect = chai.expect
 const crypto = require('libp2p-crypto')
 const mh = require('multihashes')
 const parallel = require('async/parallel')
-const Buffer = require('safe-buffer').Buffer
 
 const PeerId = require('../src')
 
+const util = require('util')
+
 const testId = require('./fixtures/sample-id')
 const testIdHex = testId.id
 const testIdBytes = mh.fromHexString(testId.id)
@@ -20,13 +21,19 @@ const testIdB58String = mh.toB58String(testIdBytes)
 
 const goId = require('./fixtures/go-private-key')
 
+// Test options for making PeerId.create faster
+// INSECURE, only use when testing
+const testOpts = {
+  bits: 512
+}
+
 describe('PeerId', () => {
   it('create an id without \'new\'', () => {
     expect(PeerId).to.throw(Error)
   })
 
   it('create a new id', (done) => {
-    PeerId.create((err, id) => {
+    PeerId.create(testOpts, (err, id) => {
       expect(err).to.not.exist()
       expect(id.toB58String().length).to.equal(46)
       done()
@@ -34,7 +41,7 @@ describe('PeerId', () => {
   })
 
   it('isPeerId', (done) => {
-    PeerId.create((err, id) => {
+    PeerId.create(testOpts, (err, id) => {
       expect(err).to.not.exist()
       expect(PeerId.isPeerId(id)).to.equal(true)
       expect(PeerId.isPeerId('aaa')).to.equal(false)
@@ -43,8 +50,9 @@ describe('PeerId', () => {
     })
   })
 
-  it('throws on changing the id', (done) => {
+  it('throws on changing the id', function (done) {
-    PeerId.create((err, id) => {
+    this.timeout(10000)
+    PeerId.create(testOpts, (err, id) => {
       expect(err).to.not.exist()
       expect(id.toB58String().length).to.equal(46)
       expect(() => {
@@ -86,13 +94,14 @@ describe('PeerId', () => {
       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) => {
+    PeerId.create(testOpts, (err, id1) => {
       expect(err).to.not.exist()
 
       PeerId.createFromPubKey(id1.marshalPubKey(), (err, id2) => {
@@ -103,10 +112,20 @@ describe('PeerId', () => {
     })
   })
 
-  it('Non-default # of bits', (done) => {
+  it('Works with default options', function (done) {
-    PeerId.create({ bits: 1024 }, (err, shortId) => {
+    this.timeout(10000)
+    PeerId.create((err, id) => {
       expect(err).to.not.exist()
-      PeerId.create({ bits: 4096 }, (err, longId) => {
+      expect(id.toB58String().length).to.equal(46)
+      done()
+    })
+  })
+
+  it('Non-default # of bits', function (done) {
+    this.timeout(1000 * 60)
+    PeerId.create(testOpts, (err, shortId) => {
+      expect(err).to.not.exist()
+      PeerId.create({ bits: 1024 }, (err, longId) => {
         expect(err).to.not.exist()
         expect(shortId.privKey.bytes.length).is.below(longId.privKey.bytes.length)
         done()
@@ -115,7 +134,7 @@ describe('PeerId', () => {
   })
 
   it('Pretty printing', (done) => {
-    PeerId.create((err, id1) => {
+    PeerId.create(testOpts, (err, id1) => {
       expect(err).to.not.exist()
       PeerId.createFromPrivKey(id1.toPrint().privKey, (err, id2) => {
         expect(err).to.not.exist()
@@ -132,8 +151,8 @@ describe('PeerId', () => {
 
   it('isEqual', (done) => {
     parallel([
-      (cb) => PeerId.create(cb),
+      (cb) => PeerId.create(testOpts, cb),
-      (cb) => PeerId.create(cb)
+      (cb) => PeerId.create(testOpts, cb)
     ], (err, ids) => {
       expect(err).to.not.exist()
       expect(ids[0].isEqual(ids[0])).to.equal(true)
@@ -146,7 +165,7 @@ describe('PeerId', () => {
 
   describe('fromJSON', () => {
     it('full node', (done) => {
-      PeerId.create({ bits: 1024 }, (err, id) => {
+      PeerId.create(testOpts, (err, id) => {
         expect(err).to.not.exist()
 
         PeerId.createFromJSON(id.toJSON(), (err, other) => {
@@ -191,7 +210,7 @@ describe('PeerId', () => {
   })
 
   it('set privKey (valid)', (done) => {
-    PeerId.create((err, peerId) => {
+    PeerId.create(testOpts, (err, peerId) => {
       expect(err).to.not.exist()
       peerId.privKey = peerId._privKey
       peerId.isValid(done)
@@ -199,7 +218,7 @@ describe('PeerId', () => {
   })
 
   it('set pubKey (valid)', (done) => {
-    PeerId.create((err, peerId) => {
+    PeerId.create(testOpts, (err, peerId) => {
       expect(err).to.not.exist()
       peerId.pubKey = peerId._pubKey
       peerId.isValid(done)
@@ -207,7 +226,7 @@ describe('PeerId', () => {
   })
 
   it('set privKey (invalid)', (done) => {
-    PeerId.create((err, peerId) => {
+    PeerId.create(testOpts, (err, peerId) => {
       expect(err).to.not.exist()
       peerId.privKey = Buffer.from('bufff')
       peerId.isValid((err) => {
@@ -218,7 +237,7 @@ describe('PeerId', () => {
   })
 
   it('set pubKey (invalid)', (done) => {
-    PeerId.create((err, peerId) => {
+    PeerId.create(testOpts, (err, peerId) => {
       expect(err).to.not.exist()
       peerId.pubKey = Buffer.from('buffff')
       peerId.isValid((err) => {
@@ -228,6 +247,24 @@ describe('PeerId', () => {
     })
   })
 
+  describe('returns error via cb instead of crashing', () => {
+    const garbage = [Buffer.from('00010203040506070809', 'hex'), {}, null, false, undefined, true, 1, 0, Buffer.from(''), 'aGVsbG93b3JsZA==', 'helloworld', '']
+
+    const fncs = ['createFromPubKey', 'createFromPrivKey', 'createFromJSON']
+
+    garbage.forEach(garbage => {
+      fncs.forEach(fnc => {
+        it(fnc + '(' + util.inspect(garbage) + ')', cb => {
+          PeerId[fnc](garbage, (err, res) => {
+            expect(err).to.exist()
+            expect(res).to.not.exist()
+            cb()
+          })
+        })
+      })
+    })
+  })
+
   describe('throws on inconsistent data', () => {
     let k1
     let k2
@@ -235,9 +272,9 @@ describe('PeerId', () => {
 
     before((done) => {
       parallel([
-        (cb) => crypto.keys.generateKeyPair('RSA', 1024, cb),
+        (cb) => crypto.keys.generateKeyPair('RSA', 512, cb),
-        (cb) => crypto.keys.generateKeyPair('RSA', 1024, cb),
+        (cb) => crypto.keys.generateKeyPair('RSA', 512, cb),
-        (cb) => crypto.keys.generateKeyPair('RSA', 1024, cb)
+        (cb) => crypto.keys.generateKeyPair('RSA', 512, cb)
       ], (err, keys) => {
         expect(err).to.not.exist()