Refresh

.aegir.js

@@ -0,0 +1,40 @@
+'use strict'
+
+const multiaddr = require('multiaddr')
+const pull = require('pull-stream')
+const WS = require('libp2p-websockets')
+const PeerId = require('peer-id')
+
+const secio = require('./src')
+
+const peerNodeJSON = require('./test/fixtures/peer-node.json')
+const ma = multiaddr('/ip4/127.0.0.1/tcp/9090/ws')
+let listener
+
+module.exports = {
+  hooks: {
+    browser: {
+      pre: (done) => {
+        PeerId.createFromJSON(peerNodeJSON, (err, peerId) => {
+          if (err) { throw err }
+
+          const ws = new WS()
+
+          listener = ws.createListener((conn) => {
+            const encryptedConn = secio.encrypt(peerId, conn, undefined, (err) => {
+              if (err) { throw err }
+            })
+
+            // echo
+            pull(encryptedConn, encryptedConn)
+          })
+
+          listener.listen(ma, done)
+        })
+      },
+      post: (done) => {
+        listener.close(done)
+      }
+    }
+  }
+}

.gitignore

@@ -1,43 +1,13 @@
-**/node_modules/
-**/*.log
-test/repo-tests*
-**/bundle.js
-
-# Logs
-logs
-*.log
-
-coverage
-
-# 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
-
-# node-waf configuration
-.lock-wscript
-
-build
-
-# Dependency directory
-# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
-node_modules
+package-lock.json
+yarn.lock
+docs
 
-lib
+**/node_modules
+**/*.log
+test/setup/tmp-disposable-nodes-addrs.json
 dist
-test/test-data/go-ipfs-repo/LOCK
-test/test-data/go-ipfs-repo/LOG
-test/test-data/go-ipfs-repo/LOG.old
-
-# while testing npm5
-package-lock.json
-yarn.lock
+coverage
+**/*.swp
+examples/sub-module/**/bundle.js
+examples/sub-module/**/*-minified.js
+examples/sub-module/*-bundle.js

.npmignore

@@ -1,34 +1,5 @@
-**/node_modules/
-**/*.log
-test/repo-tests*
-
-# Logs
-logs
+node_modules
 *.log
-
-coverage
-
-# 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
-
-# node-waf configuration
-.lock-wscript
-
-build
-
-# Dependency directory
-# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
-node_modules
-
 test

.travis.yml

@@ -8,13 +8,10 @@ matrix:
     env: CXX=g++-4.8
   - node_js: 8
     env: CXX=g++-4.8
-    #  - node_js: stable
-    #    env: CXX=g++-4.8
 
 script:
   - npm run lint
   - npm run test
-  - npm run coverage
 
 before_script:
   - export DISPLAY=:99.0

README.md

@@ -13,7 +13,7 @@
 ![](https://img.shields.io/badge/Node.js-%3E%3D6.0.0-orange.svg?style=flat-square)
 
 
-> Secio implementation in JavaScript
+> SECIO implementation in JavaScript
 
 This repo contains the JavaScript implementation of secio, an encryption protocol used in libp2p. This is based on this [go implementation](https://github.com/libp2p/go-libp2p-secio).
 
@@ -39,18 +39,20 @@ const secio = require('libp2p-secio')
 
 ## API
 
-### `tag`
+### `.tag`
 
 The current `secio` tag, usable in `multistream`.
 
-### `encrypt(id, key, insecure[, callback])`
+### `const encryptedConnection = secio.encrypt(localPeerId, plainTextConnection [, remotePeerId] [, callback])`
 
-- `id: PeerId` - The id of the node.
-- `key: RSAPrivateKey` - The private key of the node.
-- `insecure: PullStream` - The insecure connection.
-- `callback: Function` - Called if an error happens during the initialization.
+- `localPeerId: PeerId` - A PeerId object containing the Private, Public and Id of our node.
+- `plainTextConnection: Connection` - The insecure connection to be secured.
+- `remotePeerId: PeerId` - A PeerId object containing the Public and/or Id of the node we are doing the SECIO handshake with.
+- `callback: Function` - Optional, Called if an error happens during the initialization.
 
-Returns the `insecure` connection provided, wrapped with secio. This is a pull-stream.
+Returns an encrypted [Connection object](https://github.com/libp2p/interface-connection) that is the upgraded `plainTextConnection` with now having every byte encripted.
+
+Both plainTextConnection and encryptedConnection are at their base, PullStreams.
 
 ### This module uses `pull-streams`
 
@@ -76,8 +78,6 @@ const nodeStreamInstance = pullToStream(pullStreamInstance)
 
 To learn more about this utility, visit https://pull-stream.github.io/#pull-stream-to-stream.
 
-
-
 ## Contribute
 
 Feel free to join in. All welcome. Open an [issue](https://github.com/libp2p/js-libp2p-secio/issues)!

benchmarks/peer-a.json

@@ -0,0 +1,5 @@
+{
+  "id": "QmVbkvMswbUZbmRHbmBicg5sdzDYBnvGPC5PhZFnkozdoP",
+  "privKey": "CAASpgkwggSiAgEAAoIBAQCX1xFsZIszqLYXaJ7QZUbotUcWC6SB0CZGUamCPWD5Idfa+LiMByQKLxJrttNkcx+85NRIYPzlV6ToHz6OH/WzUCXEOFy0iKmq/Jz15KKuzzDuyzToqPI0EPRTKWoxI4rj7Ppx6wFQvancgLvxxmPslaqxST+9tsdDw5W2cQnRAIBPoJZtrS9AL9dya6bt6GiLQKKHox4jxVE0P/QYj6/LX7e5wjZMfeS6y4yIdfSiu9UueLI78pixRn5qXcn0zL0L/+xWNsZG2tSVG7BbHFGm4PjF/WdELSOHj9R2YWH+snzdkxPcX3zwle+JKJW/AJGjJGMIoNkIuDg/1uizSRzhAgMBAAECggEAa90gR3v1VzFWibKMf0Yy5UVBxmtm5cDUL8f7PsYTiWd9S9S8ZNz9wS5HS7WI3ibaOPnlw7UCcnmccDkh2xzhEgyxh37yfF1JCmqBpjxRRRVykXBRmaXKySnyJtGY2meBVwEVuK9VM+JINJhO6yYf/gUkSOTcHw0k6QKb7ArJCmrMVH/b/mjqbzQpUM74M6f/5DDU2IYCAaGu5QB7VZsAFSocb5aVvbW3uEAwJ9AmoqYOte6Jlsv07Rb+bENj6E7CeGsh4UPIqLv5ALaLF41U+JDSj/H9fegoxY4lUEEz0cGbgZLOcWUgYCQ3R+E2aBF+EpZ7ySuZjtfwWiXTUVqrQQKBgQD7TNc/kY3IRiMSGy7WJ60wqPc7+f2WnoJFMNPC0G9m0mWvB3jFwmM0lmx6LJ7zw6Xvxxt/LiFFA2dPzvXtxrj2yrKhIhB6fmVNj8VZibxTDGfONXEfc5IvqNQpv0ysCCmt9xlb2GzbJat7jasU8nzcOZED0FjbW8AXVTetXXwozQKBgQCargnkV2CzaKYHfxdJViplBEPaJtOBzcf7XtC62V5NPRruAdOEWvjO0HX9AGemss5F2hruWzAJ99drpbYeDoWPtkM6ui2WeatiOCuU9tom6OtvZ6JbCgDRnUgnvl6R1LhgYT0qm7zdz2CoTtlA9ll9CeqRs0fdrnTpJcxyCpEUZQKBgArh2vhfvzoK/33LO43+jdtrlbk9LCQXnSCN6r2m9QwI1Gpt8mbt8gnW8b+gqwl3UXo+rwwk3T/108V6+t9fGadmQ7ICnaAQVSa0sSEde9BE20HswodQI+Z4cyeTpyhT+ioUZz648o3S5cgl7GCt14ZZ39PAc/ib0oewIwcY40WJAoGAF7mCAuf0CRCQBq5ToAf7UKsqzRcPceViOwf78+zLLgWlT8Qv8SkS6IXI0xlwzHy4brZZUx3hbGX7QKOWH14S1kwaW7Oasm3O/62l4Z9LLpSjJ985Y8VRAtWg75efYbbC4OWJQDPK8CqSpL4TTId8ilUvCVH6P+I2RFxr00ITppECgYA8P3AOAxS/PhNoH02rLi6DHnfcotWGM9m5QkImyH7OL2Im1sKekVuF18iNamxk8HVTo0BMwda86Gdwhr7M0eh7cAuj9kHgYqPsgWKiHEHu2wq7jz85O4EKT96JI8QEphHEWDaBS1toSFnCxFYBsPtCoJO5KMAOLpda70VcRhY+/Q==",
+  "pubKey": "CAASpgIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCX1xFsZIszqLYXaJ7QZUbotUcWC6SB0CZGUamCPWD5Idfa+LiMByQKLxJrttNkcx+85NRIYPzlV6ToHz6OH/WzUCXEOFy0iKmq/Jz15KKuzzDuyzToqPI0EPRTKWoxI4rj7Ppx6wFQvancgLvxxmPslaqxST+9tsdDw5W2cQnRAIBPoJZtrS9AL9dya6bt6GiLQKKHox4jxVE0P/QYj6/LX7e5wjZMfeS6y4yIdfSiu9UueLI78pixRn5qXcn0zL0L/+xWNsZG2tSVG7BbHFGm4PjF/WdELSOHj9R2YWH+snzdkxPcX3zwle+JKJW/AJGjJGMIoNkIuDg/1uizSRzhAgMBAAE="
+}

benchmarks/peer-b.json

@@ -0,0 +1,5 @@
+{
+  "id": "QmTY6txxqgf7E3ChpYEXqz6QSVa32qjDbyeKuiaPYT1vx9",
+  "privKey": "CAASqQkwggSlAgEAAoIBAQDLAL7+npPinALH9GE0SSSgi89fIWnbZXO1e94cdpJsR6WoZgGeHNZMTUew3x7TeJV1PoX7DFyM2ZxnclJx/C2DLQzQbRnmbMNqfq+3WfvRBk/e2D0UtwALSCPvM5qKBj7JWCAleAw7ypfJYXL1rSa5tYtLprQd6mt9IZsBCHLnfPibMM8X+8QOkw0Y40NONFaTRPN3PXznAmMekFkAMpSf1QyhNlS2WCX5+aARz8uEZYVdycjcA/ISq/WYxEeFCoyRVdEvjeq+NS5b6pFV5nZ4PnOJzFmvEyGBqndpNHEMgCWsvlspXN/jFMY1pTBds/35b4Vqd6ui7lZTiIEr/3nZAgMBAAECggEBALaLMTRc/Lale4q6oj4WF62Wix8MONhk3iuv+wa1SO29b6WCNKotXDa4t2LBAENBB4SqeGhLsV2mwRH0p1aAYZy3gfJaaRPfccntqazCacKIXoIRCLv74zpB4K5URP8gpoz/hcirrrSFdQBNdMaesVgFfADHIuhTx9x5v5yqMEkfaOe5SDxGLhYGEfBGm/+a3zJK9BXUkQ8gCiqRXlCYM2x9emzBBOKDRBUYTJeSStggHKMJwrCm+XYyAMeYf9CLGXa0ziG4QU7F/4QdqPGL6b4aUaT/hLW+SpQUFGsMsioO6k+HGqVEfSemBNteqohxK8ibcgeoZgpUCMXYgd+0DJECgYEA8e6Egshr7kx+O7Jy0C/tRx4+B8H0m9ZyWdKn1rVH9M41JmswDQlh3qY6q2pma35g0J0zqvIn4usGlFfanG3BpD/yiBDAd/75OxD25Jxk6wDXgOnoxFCDwBfi8IlYy8fGxSEizNZHS3oungyr402aMu9k+aTXtGJytp7RHQGCw98CgYEA1s64bTtBmSHtKovHHqlXn/fKBmldxRc68M1uP3TIGSKBeoo2pcS7T4tdXW55tyLVDtDJqe+WIRB8dsaCziI8gnypV4OXENIA09DUGRWlo0NBsd4JqgYe7ALMRLF1l1+DXvz/O33ikh2T7oAmrcOUDKSjcWYvgFGooalHBayxuUcCgYEAxuoRUWZwN1H1SCgEdl+xe5PF9KLn92luQ6QME2ChdQpGcPwYWd+o9GNAQcgNxbv25g8aeCb53HzYwAcr2wny+JULWAxN81tUl9fu5zAfWYkrpvarRx3b9YiuMo76zzHGoDYKYtibbddblN9eRFl9uvtRzmBWah23q6cQ0AR5+4kCgYBHHX8/YovQJ8Q9/rK4evXwlveCceXCd3Ni/5ANYBtS/vKA4DtBXEVrC0eoxAd10wlYc1UgdppsbenW5NevaPRBewYRXBZqUixF8/AUMe95gq3ANjNa39Xi6vY3k8zLhaqXiwjw6DdXioVMQ48KniJooSUfSOZXBDHg+4rw3QClxwKBgQCtlFXk2J0H4YoNrHxTupSui0xntwStQJEWd5Ze4uAK0Z82iJsahdqk6Wk3aqXZqYoXak5E88yzdGLjmqIb+qgzJVjtlHMRv6ETD+kY4ec8/IlTP7Lyxcx5odqi0ooTgUq4sRPWdiTjj4bZWdZS4gkwo12ZXqcyZe2qbuT+gYqrYQ==",
+  "pubKey": "CAASpgIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDLAL7+npPinALH9GE0SSSgi89fIWnbZXO1e94cdpJsR6WoZgGeHNZMTUew3x7TeJV1PoX7DFyM2ZxnclJx/C2DLQzQbRnmbMNqfq+3WfvRBk/e2D0UtwALSCPvM5qKBj7JWCAleAw7ypfJYXL1rSa5tYtLprQd6mt9IZsBCHLnfPibMM8X+8QOkw0Y40NONFaTRPN3PXznAmMekFkAMpSf1QyhNlS2WCX5+aARz8uEZYVdycjcA/ISq/WYxEeFCoyRVdEvjeq+NS5b6pFV5nZ4PnOJzFmvEyGBqndpNHEMgCWsvlspXN/jFMY1pTBds/35b4Vqd6ui7lZTiIEr/3nZAgMBAAE="
+}

benchmarks/send.js

@@ -2,77 +2,97 @@
 
 const Benchmark = require('benchmark')
 const pull = require('pull-stream')
+const parallel = require('async/parallel')
 const pair = require('pull-pair/duplex')
 const PeerId = require('peer-id')
-const crypto = require('libp2p-crypto')
 
 const secio = require('../src')
 
 const suite = new Benchmark.Suite('secio')
-const ids = []
+let peers
 
-suite.add('createKey', function (d) {
-  crypto.keys.generateKeyPair('RSA', 2048, (err, key) => {
-    if (err) { throw err }
-    PeerId.createFromPrivKey(key.bytes, (err, id) => {
-      if (err) { throw err }
+function sendData (a, b, opts, finish) {
+  opts = Object.assign({ times: 1, size: 100 }, opts)
+
+  pull(
+    pull.infinite(() => Buffer.allocUnsafe(opts.size)),
+    pull.take(opts.times),
+    a
+  )
 
-      ids.push(id)
-      d.resolve()
+  let length = 0
+
+  pull(
+    b,
+    pull.drain((data) => {
+      length += data.length
+    }, () => {
+      if (length !== opts.times * opts.size) {
+        throw new Error('Did not receive enough chunks')
+      }
+      finish.resolve()
     })
-  })
-}, {
-  defer: true
-})
-.add('send', function (deferred) {
-  const p = pair()
+  )
+}
 
-  createSession(p[0], (err, local) => {
+suite.add('create peers for test', (deferred) => {
+  parallel([
+    (cb) => PeerId.createFromJSON(require('./peer-a'), cb),
+    (cb) => PeerId.createFromJSON(require('./peer-b'), cb)
+  ], (err, _peers) => {
     if (err) { throw err }
-    createSession(p[1], (err, remote) => {
-      if (err) { throw err }
+    peers = _peers
 
-      sendMessages(local, remote)
-    })
+    deferred.resolve()
   })
+}, { defer: true })
+
+suite.add('establish an encrypted channel', (deferred) => {
+  const p = pair()
+
+  const peerA = peers[0]
+  const peerB = peers[1]
+
+  const aToB = secio.encrypt(peerA, p[0], peerB, (err) => { throw err })
+  const bToA = secio.encrypt(peerB, p[1], peerA, (err) => { throw err })
+
+  sendData(aToB, bToA, {}, deferred)
+}, { defer: true })
+
+const cases = [
+  [10, 262144],
+  [100, 262144],
+  [1000, 262144]
+  // [10000, 262144],
+  // [100000, 262144],
+  // [1000000, 262144]
+]
+cases.forEach((el) => {
+  const times = el[0]
+  const size = el[1]
 
-  function sendMessages (local, remote) {
-    pull(
-      pull.infinite(),
-      pull.take(100),
-      pull.map((val) => Buffer.from(val.toString())),
-      local
-    )
-
-    pull(
-      remote,
-      pull.take(100),
-      pull.collect((err, chunks) => {
-        if (err) throw err
-        if (chunks.length !== 100) throw new Error('Did not receive enough chunks')
-        deferred.resolve()
-      })
-    )
-  }
-}, {
-  defer: true
+  suite.add(`send plaintext ${times} x ${size} bytes`, (deferred) => {
+    const p = pair()
+
+    sendData(p[0], p[1], { times: times, size: size }, deferred)
+  }, { defer: true })
+
+  suite.add(`send encrypted ${times} x ${size} bytes`, (deferred) => {
+    const p = pair()
+
+    const peerA = peers[0]
+    const peerB = peers[1]
+
+    const aToB = secio.encrypt(peerA, p[0], peerB, (err) => { throw err })
+    const bToA = secio.encrypt(peerB, p[1], peerA, (err) => { throw err })
+
+    sendData(aToB, bToA, { times: times, size: size }, deferred)
+  }, { defer: true })
 })
-.on('cycle', (event) => {
+
+suite.on('cycle', (event) => {
   console.log(String(event.target))
 })
-// run async
-.run({
-  async: true
-})
-
-function createSession (insecure, cb) {
-  crypto.keys.generateKeyPair('RSA', 2048, (err, key) => {
-    if (err) { return cb(err) }
 
-    PeerId.createFromPrivKey(key.bytes, (err, id) => {
-      if (err) { return cb(err) }
-
-      cb(null, secio.encrypt(id, key, insecure))
-    })
-  })
-}
+// run async
+suite.run({ async: true })

circle.yml

@@ -3,6 +3,10 @@ machine:
   node:
     version: stable
 
+test:
+  post:
+    - npm run coverage -- --upload --providers coveralls
+
 dependencies:
   pre:
     - google-chrome --version