chore: release version v0.8.7

Implement generateKeyPairFromSeed for ed25519 - this will produce the same keypair for the same seed (or first 32 bytes of reader) as given to GenerateKeyPairWithReader in go-libp2p.

CHANGELOG.md

@@ -0,0 +1,20 @@
+<a name="0.8.7"></a>
+## [0.8.7](https://github.com/libp2p/js-libp2p-crypto/compare/v0.8.6...v0.8.7) (2017-03-21)
+
+
+
+<a name="0.8.6"></a>
+## [0.8.6](https://github.com/libp2p/js-libp2p-crypto/compare/v0.8.5...v0.8.6) (2017-03-03)
+
+
+### Bug Fixes
+
+* **package:** update tweetnacl to version 1.0.0-rc.1 ([4e56e17](https://github.com/libp2p/js-libp2p-crypto/commit/4e56e17))
+
+
+### Features
+
+* **keys:** implement generateKeyPairFromSeed for ed25519  ([e5b7c1f](https://github.com/libp2p/js-libp2p-crypto/commit/e5b7c1f))
+
+
+

package.json

@@ -1,6 +1,6 @@
 {
   "name": "libp2p-crypto",
-  "version": "0.8.3",
+  "version": "0.8.7",
   "description": "Crypto primitives for libp2p",
   "main": "src/index.js",
   "browser": {
@@ -33,28 +33,29 @@
   "author": "Friedel Ziegelmayer <dignifiedqurie@gmail.com>",
   "license": "MIT",
   "dependencies": {
-    "multihashing-async": "~0.4.2",
     "asn1.js": "^4.9.1",
-    "async": "^2.1.4",
+    "async": "^2.1.5",
     "browserify-aes": "^1.0.6",
     "keypair": "^1.0.1",
-    "nodeify": "^1.0.0",
+    "libp2p-crypto-secp256k1": "^0.1.4",
+    "multihashing-async": "~0.4.4",
+    "nodeify": "^1.0.1",
     "pem-jwk": "^1.5.1",
     "protocol-buffers": "^3.2.1",
     "rsa-pem-to-jwk": "^1.1.3",
     "safe-buffer": "^5.0.1",
-    "tweetnacl": "^0.14.5",
-    "browserify-optional": "^1.0.0",
+    "tweetnacl": "^1.0.0-rc.1",
     "webcrypto-shim": "github:dignifiedquire/webcrypto-shim#master"
   },
   "devDependencies": {
-    "aegir": "^10.0.0",
+    "aegir": "^11.0.0",
     "benchmark": "^2.1.3",
     "chai": "^3.5.0",
+    "dirty-chai": "^1.2.2",
     "pre-commit": "^1.2.2"
   },
   "optionalDependencies": {
-    "node-webcrypto-ossl": "^1.0.17"
+    "node-webcrypto-ossl": "^1.0.21"
   },
   "pre-commit": [
     "lint",
@@ -64,11 +65,6 @@
     "node": ">=4.0.0",
     "npm": ">=3.0.0"
   },
-  "browserify": {
-    "transform": [
-      "browserify-optional"
-    ]
-  },
   "repository": {
     "type": "git",
     "url": "https://github.com/libp2p/js-libp2p-crypto.git"
@@ -81,9 +77,11 @@
     "David Dias <daviddias.p@gmail.com>",
     "Dmitriy Ryajov <dryajov@gmail.com>",
     "Friedel Ziegelmayer <dignifiedquire@gmail.com>",
+    "Jack Kleeman <jackkleeman@gmail.com>",
     "Richard Littauer <richard.littauer@gmail.com>",
     "Tom Swindell <t.swindell@rubyx.co.uk>",
     "Yusef Napora <yusef@napora.org>",
+    "greenkeeper[bot] <greenkeeper[bot]@users.noreply.github.com>",
     "greenkeeperio-bot <support@greenkeeper.io>",
     "nikuda <nikuda@gmail.com>"
   ]

src/crypto/ed25519.js

@@ -22,6 +22,22 @@ exports.generateKey = function (callback) {
   done(null, keys)
 }
 
+// seed should be a 32 byte uint8array
+exports.generateKeyFromSeed = function (seed, callback) {
+  const done = (err, res) => setImmediate(() => {
+    callback(err, res)
+  })
+
+  let keys
+  try {
+    keys = nacl.sign.keyPair.fromSeed(seed)
+  } catch (err) {
+    done(err)
+    return
+  }
+  done(null, keys)
+}
+
 exports.hashAndSign = function (key, msg, callback) {
   setImmediate(() => {
     callback(null, Buffer.from(nacl.sign.detached(msg, key)))

src/index.js

@@ -30,6 +30,19 @@ exports.generateKeyPair = (type, bits, cb) => {
   key.generateKeyPair(bits, cb)
 }
 
+// Generates a keypair of the given type and bitsize
+// seed is a 32 byte uint8array
+exports.generateKeyPairFromSeed = (type, seed, bits, cb) => {
+  let key = keys[type.toLowerCase()]
+  if (!key) {
+    return cb(new Error('invalid or unsupported key type'))
+  }
+  if (type.toLowerCase() !== 'ed25519') {
+    return cb(new Error('Seed key derivation is unimplemented for RSA or secp256k1'))
+  }
+  key.generateKeyPairFromSeed(seed, bits, cb)
+}
+
 // Converts a protobuf serialized public key into its
 // representative object
 exports.unmarshalPublicKey = (buf) => {

src/keys/ed25519.js

@@ -117,6 +117,27 @@ function generateKeyPair (_bits, cb) {
   })
 }
 
+function generateKeyPairFromSeed (seed, _bits, cb) {
+  if (cb === undefined && typeof _bits === 'function') {
+    cb = _bits
+  }
+
+  crypto.generateKeyFromSeed(seed, (err, keys) => {
+    if (err) {
+      return cb(err)
+    }
+    let privkey
+    try {
+      privkey = new Ed25519PrivateKey(keys.secretKey, keys.publicKey)
+    } catch (err) {
+      cb(err)
+      return
+    }
+
+    cb(null, privkey)
+  })
+}
+
 function ensure (cb) {
   if (typeof cb !== 'function') {
     throw new Error('callback is required')
@@ -138,5 +159,6 @@ module.exports = {
   Ed25519PrivateKey,
   unmarshalEd25519PrivateKey,
   unmarshalEd25519PublicKey,
-  generateKeyPair
+  generateKeyPair,
+  generateKeyPairFromSeed
 }

src/keys/index.js

@@ -2,10 +2,6 @@
 
 module.exports = {
   rsa: require('./rsa'),
-  ed25519: require('./ed25519')
-}
-
-try {
-  module.exports.secp256k1 = require('libp2p-crypto-secp256k1')
-} catch (err) {
+  ed25519: require('./ed25519'),
+  secp256k1: require('libp2p-crypto-secp256k1')
 }

test/aes.spec.js

@@ -2,7 +2,10 @@
 /* eslint-env mocha */
 'use strict'
 
-const expect = require('chai').expect
+const chai = require('chai')
+const dirtyChai = require('dirty-chai')
+const expect = chai.expect
+chai.use(dirtyChai)
 const series = require('async/series')
 const Buffer = require('safe-buffer').Buffer
 
@@ -25,7 +28,7 @@ describe('AES-CTR', () => {
       iv.fill(1)
 
       crypto.aes.create(key, iv, (err, cipher) => {
-        expect(err).to.not.exist
+        expect(err).to.not.exist()
 
         series([
           encryptAndDecrypt(cipher),
@@ -46,17 +49,17 @@ describe('AES-CTR', () => {
       iv.fill(1)
 
       crypto.aes.create(key, iv, (err, cipher) => {
-        expect(err).to.not.exist
+        expect(err).to.not.exist()
 
         series(fixtures[byte].inputs.map((rawIn, i) => (cb) => {
           const input = Buffer.from(rawIn)
           const output = Buffer.from(fixtures[byte].outputs[i])
           cipher.encrypt(input, (err, res) => {
-            expect(err).to.not.exist
+            expect(err).to.not.exist()
             expect(res).to.have.length(output.length)
             expect(res).to.be.eql(output)
             cipher.decrypt(res, (err, res) => {
-              expect(err).to.not.exist
+              expect(err).to.not.exist()
               expect(res).to.be.eql(input)
               cb()
             })
@@ -79,17 +82,17 @@ describe('AES-CTR', () => {
       iv.fill(1)
 
       crypto.aes.create(key, iv, (err, cipher) => {
-        expect(err).to.not.exist
+        expect(err).to.not.exist()
 
         series(goFixtures[byte].inputs.map((rawIn, i) => (cb) => {
           const input = Buffer.from(rawIn)
           const output = Buffer.from(goFixtures[byte].outputs[i])
           cipher.encrypt(input, (err, res) => {
-            expect(err).to.not.exist
+            expect(err).to.not.exist()
             expect(res).to.have.length(output.length)
             expect(res).to.be.eql(output)
             cipher.decrypt(res, (err, res) => {
-              expect(err).to.not.exist
+              expect(err).to.not.exist()
               expect(res).to.be.eql(input)
               cb()
             })
@@ -105,9 +108,9 @@ function encryptAndDecrypt (cipher) {
   data.fill(Math.ceil(Math.random() * 100))
   return (cb) => {
     cipher.encrypt(data, (err, res) => {
-      expect(err).to.not.exist
+      expect(err).to.not.exist()
       cipher.decrypt(res, (err, res) => {
-        expect(err).to.not.exist
+        expect(err).to.not.exist()
         expect(res).to.be.eql(data)
         cb()
       })

test/ed25519.spec.js

@@ -1,7 +1,10 @@
 /* eslint-env mocha */
 'use strict'
 
-const expect = require('chai').expect
+const chai = require('chai')
+const dirtyChai = require('dirty-chai')
+const expect = chai.expect
+chai.use(dirtyChai)
 const Buffer = require('safe-buffer').Buffer
 
 const crypto = require('../src')
@@ -35,6 +38,70 @@ describe('ed25519', () => {
     })
   })
 
+  it('generates a valid key from seed', (done) => {
+    var seed = crypto.randomBytes(32)
+    crypto.generateKeyPairFromSeed('Ed25519', seed, 512, (err, seededkey) => {
+      if (err) return done(err)
+      expect(
+        seededkey
+      ).to.be.an.instanceof(
+        ed25519.Ed25519PrivateKey
+      )
+
+      seededkey.hash((err, digest) => {
+        if (err) {
+          return done(err)
+        }
+
+        expect(digest).to.have.length(34)
+        done()
+      })
+    })
+  })
+
+  it('generates the same key from the same seed', (done) => {
+    var seed = crypto.randomBytes(32)
+    crypto.generateKeyPairFromSeed('Ed25519', seed, 512, (err, seededkey1) => {
+      if (err) return done(err)
+      crypto.generateKeyPairFromSeed('Ed25519', seed, 512, (err, seededkey2) => {
+        if (err) return done(err)
+        expect(
+          seededkey1.equals(seededkey2)
+        ).to.be.eql(
+          true
+        )
+        expect(
+          seededkey1.public.equals(seededkey2.public)
+        ).to.be.eql(
+          true
+        )
+        done()
+      })
+    })
+  })
+
+  it('generates different keys for different seeds', (done) => {
+    var seed1 = crypto.randomBytes(32)
+    crypto.generateKeyPairFromSeed('Ed25519', seed1, 512, (err, seededkey1) => {
+      if (err) return done(err)
+      var seed2 = crypto.randomBytes(32)
+      crypto.generateKeyPairFromSeed('Ed25519', seed2, 512, (err, seededkey2) => {
+        if (err) return done(err)
+        expect(
+          seededkey1.equals(seededkey2)
+        ).to.be.eql(
+          false
+        )
+        expect(
+          seededkey1.public.equals(seededkey2.public)
+        ).to.be.eql(
+          false
+        )
+        done()
+      })
+    })
+  })
+
   it('signs', (done) => {
     const text = crypto.randomBytes(512)
 
@@ -167,7 +234,7 @@ describe('ed25519', () => {
     let privateKey
     before((done) => {
       crypto.unmarshalPrivateKey(fixtures.verify.privateKey, (err, key) => {
-        expect(err).to.not.exist
+        expect(err).to.not.exist()
         privateKey = key
         done()
       })
@@ -178,7 +245,7 @@ describe('ed25519', () => {
 
       key.verify(fixtures.verify.data, fixtures.verify.signature, (err, ok) => {
         if (err) throw err
-        expect(err).to.not.exist
+        expect(err).to.not.exist()
         expect(ok).to.be.eql(true)
         done()
       })
@@ -186,7 +253,7 @@ describe('ed25519', () => {
 
     it('generates the same signature as go', (done) => {
       privateKey.sign(fixtures.verify.data, (err, sig) => {
-        expect(err).to.not.exist
+        expect(err).to.not.exist()
         expect(sig).to.deep.equal(fixtures.verify.signature)
         done()
       })

test/ephemeral-keys.spec.js

@@ -2,7 +2,10 @@
 /* eslint-env mocha */
 'use strict'
 
-const expect = require('chai').expect
+const chai = require('chai')
+const dirtyChai = require('dirty-chai')
+const expect = chai.expect
+chai.use(dirtyChai)
 const parallel = require('async/parallel')
 
 const fixtures = require('./fixtures/go-elliptic-key')
@@ -27,12 +30,12 @@ describe('generateEphemeralKeyPair', () => {
         (cb) => crypto.generateEphemeralKeyPair(curve, cb),
         (cb) => crypto.generateEphemeralKeyPair(curve, cb)
       ], (err, keys) => {
-        expect(err).to.not.exist
+        expect(err).to.not.exist()
         expect(keys[0].key).to.have.length(lengths[curve])
         expect(keys[1].key).to.have.length(lengths[curve])
 
         keys[0].genSharedKey(keys[1].key, (err, shared) => {
-          expect(err).to.not.exist
+          expect(err).to.not.exist()
           expect(shared).to.have.length(secretLengths[curve])
           done()
         })
@@ -48,7 +51,7 @@ describe('generateEphemeralKeyPair', () => {
         (cb) => crypto.generateEphemeralKeyPair(curve, cb),
         (cb) => crypto.generateEphemeralKeyPair(curve, cb)
       ], (err, res) => {
-        expect(err).to.not.exist
+        expect(err).to.not.exist()
         const alice = res[0]
         const bob = res[1]
         bob.key = fixtures.bob.public
@@ -57,7 +60,7 @@ describe('generateEphemeralKeyPair', () => {
           (cb) => alice.genSharedKey(bob.key, cb),
           (cb) => bob.genSharedKey(alice.key, fixtures.bob, cb)
         ], (err, secrets) => {
-          expect(err).to.not.exist
+          expect(err).to.not.exist()
 
           expect(
             secrets[0]

test/hmac.spec.js

@@ -3,7 +3,10 @@
 'use strict'
 
 const Buffer = require('safe-buffer').Buffer
-const expect = require('chai').expect
+const chai = require('chai')
+const dirtyChai = require('dirty-chai')
+const expect = chai.expect
+chai.use(dirtyChai)
 
 const crypto = require('../src')
 
@@ -13,10 +16,10 @@ describe('HMAC', () => {
   hashes.forEach((hash) => {
     it(`${hash} - sign and verify`, (done) => {
       crypto.hmac.create(hash, Buffer.from('secret'), (err, hmac) => {
-        expect(err).to.not.exist
+        expect(err).to.not.exist()
 
         hmac.digest(Buffer.from('hello world'), (err, sig) => {
-          expect(err).to.not.exist
+          expect(err).to.not.exist()
           expect(sig).to.have.length(hmac.length)
           done()
         })

test/index.spec.js

@@ -2,8 +2,10 @@
 /* eslint-env mocha */
 'use strict'
 
-const expect = require('chai').expect
-
+const chai = require('chai')
+const dirtyChai = require('dirty-chai')
+const expect = chai.expect
+chai.use(dirtyChai)
 const crypto = require('../src')
 const fixtures = require('./fixtures/go-key-rsa')
 

test/key-stretcher.spec.js

@@ -2,8 +2,10 @@
 /* eslint-env mocha */
 'use strict'
 
-const expect = require('chai').expect
-
+const chai = require('chai')
+const dirtyChai = require('dirty-chai')
+const expect = chai.expect
+chai.use(dirtyChai)
 const crypto = require('../src')
 const fixtures = require('./fixtures/go-stretch-key')
 
@@ -39,8 +41,8 @@ describe('keyStretcher', () => {
               return done(err)
             }
 
-            expect(keys.k1).to.exist
-            expect(keys.k2).to.exist
+            expect(keys.k1).to.exist()
+            expect(keys.k2).to.exist()
             done()
           })
         })

test/rsa.spec.js

@@ -1,7 +1,10 @@
 /* eslint-env mocha */
 'use strict'
 
-const expect = require('chai').expect
+const chai = require('chai')
+const dirtyChai = require('dirty-chai')
+const expect = chai.expect
+chai.use(dirtyChai)
 const Buffer = require('safe-buffer').Buffer
 
 const crypto = require('../src')
@@ -169,8 +172,8 @@ describe('RSA', () => {
 
       key.verify(fixtures.verify.data, fixtures.verify.signature, (err, ok) => {
         if (err) throw err
-        expect(err).to.not.exist
-        expect(ok).to.be.eql(true)
+        expect(err).to.not.exist()
+        expect(ok).to.equal(true)
         done()
       })
     })

test/secp256k1.spec.js

@@ -1,7 +1,10 @@
 /* eslint-env mocha */
 'use strict'
 
-const expect = require('chai').expect
+const chai = require('chai')
+const dirtyChai = require('dirty-chai')
+const expect = chai.expect
+chai.use(dirtyChai)
 const fixtures = require('./fixtures/secp256k1')
 const crypto = require('../src')
 
@@ -48,7 +51,7 @@ describe('with libp2p-crypto-secp256k1 module present', () => {
   it('generates a valid key', (done) => {
     expect(
       key
-    ).to.exist
+    ).to.exist()
     done()
   })
 
@@ -82,16 +85,16 @@ describe('with libp2p-crypto-secp256k1 module present', () => {
 describe('without libp2p-crypto-secp256k1 module present', () => {
   it('fails to generate a secp256k1 key', (done) => {
     crypto.generateKeyPair('secp256k1', 256, (err, key) => {
-      expect(err).to.exist
-      expect(key).to.not.exist
+      expect(err).to.exist()
+      expect(key).to.not.exist()
       done()
     })
   })
 
   it('fails to unmarshal a secp256k1 private key', (done) => {
     crypto.unmarshalPrivateKey(fixtures.pbmPrivateKey, (err, key) => {
-      expect(err).to.exist
-      expect(key).to.not.exist
+      expect(err).to.exist()
+      expect(key).to.not.exist()
       done()
     })
   })

test/util.spec.js

@@ -2,7 +2,11 @@
 /* eslint-env mocha */
 'use strict'
 
-const expect = require('chai').expect
+const chai = require('chai')
+const dirtyChai = require('dirty-chai')
+const expect = chai.expect
+chai.use(dirtyChai)
+
 const util = require('../src/crypto/util')
 const BN = require('bn.js')