chore: backport libp2p noise as fallback for secio (#3074) (#3211)

jacobheun · vasco-santos · achingbrain · achingbrain · commit fad81d6244f9 · 2020-08-12T10:42:54.000+01:00
Adds `libp2p-noise` encryption protocol as a fallback for `libp2p-secio`. This replicates what happened in [ipfs/go-ipfs/releases/v0.5.0](https://github.com/ipfs/go-ipfs/releases/tag/v0.5.0). >SECIO Deprecation Notice >SECIO should be considered to be well on the way to deprecation and will be >completely disabled in either the next release (0.6.0, ~mid May) or the one >following that (0.7.0, ~end of June). Before SECIO is disabled, support will be >added for the NOISE transport for compatibility with other IPFS implementations. From what I know, this is likely to happen for `0.7.0`. We currently have interop tests for using noise in [libp2p/interop/test/connect](https://github.com/libp2p/interop/tree/master/test/connect). I think there are enough for now, but when we use noise as default in JS and GO, we will definitely want to make sure we have more verbose interop before we switch to default. AFAIK, with the current setup of `ipfsd-ctl` we cannot specify what libp2p modules to use. Co-authored-by: Vasco Santos <vasco.santos@moxy.studio> Co-authored-by: Alex Potsides <alex@achingbrain.net>
diff --git a/examples/browser-add-readable-stream/package.json b/examples/browser-add-readable-stream/package.json
@@ -12,7 +12,7 @@
   "keywords": [],
   "license": "MIT",
   "devDependencies": {
-    "ipfs": "^0.45.0",
+    "ipfs": "^0.46.0",
     "test-ipfs-example": "^2.0.3"
   }
 }
diff --git a/examples/browser-browserify/package.json b/examples/browser-browserify/package.json
@@ -18,7 +18,7 @@
     "concat-stream": "^2.0.0",
     "execa": "^4.0.0",
     "http-server": "^0.11.1",
-    "ipfs": "^0.45.0",
+    "ipfs": "^0.46.0",
     "test-ipfs-example": "^2.0.3"
   },
   "browser": {
diff --git a/examples/browser-create-react-app/package.json b/examples/browser-create-react-app/package.json
@@ -4,7 +4,7 @@
   "private": true,
   "dependencies": {
     "dot-prop": "^5.0.0",
-    "ipfs": "^0.45.0",
+    "ipfs": "^0.46.0",
     "ipfs-css": "^0.13.1",
     "react": "^16.8.6",
     "react-dom": "^16.8.6",
diff --git a/examples/browser-mfs/package.json b/examples/browser-mfs/package.json
@@ -21,7 +21,7 @@
     "webpack-cli": "^3.3.11"
   },
   "dependencies": {
-    "ipfs": "^0.45.0",
+    "ipfs": "^0.46.0",
     "mime-sniffer": "~0.0.3"
   }
 }
diff --git a/examples/browser-parceljs/package.json b/examples/browser-parceljs/package.json
@@ -18,7 +18,7 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "ipfs": "^0.45.0"
+    "ipfs": "^0.46.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.1.5",
diff --git a/examples/browser-readablestream/package.json b/examples/browser-readablestream/package.json
@@ -20,7 +20,7 @@
     "webpack": "^4.28.4"
   },
   "dependencies": {
-    "ipfs": "^0.45.0",
+    "ipfs": "^0.46.0",
     "it-to-stream": "^0.1.1",
     "videostream": "^3.2.0"
   }
diff --git a/examples/browser-script-tag/package.json b/examples/browser-script-tag/package.json
@@ -16,6 +16,6 @@
     "test-ipfs-example": "^2.0.3"
   },
   "dependencies": {
-    "ipfs": "^0.45.0"
+    "ipfs": "^0.46.0"
   }
 }
diff --git a/examples/browser-video-streaming/package.json b/examples/browser-video-streaming/package.json
@@ -16,6 +16,6 @@
     "test-ipfs-example": "^2.0.3"
   },
   "dependencies": {
-    "ipfs": "^0.45.0"
+    "ipfs": "^0.46.0"
   }
 }
diff --git a/examples/browser-vue/package.json b/examples/browser-vue/package.json
@@ -11,7 +11,7 @@
   },
   "dependencies": {
     "core-js": "^3.6.4",
-    "ipfs": "^0.45.0",
+    "ipfs": "^0.46.0",
     "vue": "^2.6.11"
   },
   "devDependencies": {
diff --git a/examples/browser-webpack/package.json b/examples/browser-webpack/package.json
@@ -26,7 +26,7 @@
     "webpack-dev-server": "^3.1.14"
   },
   "dependencies": {
-    "ipfs": "^0.45.0"
+    "ipfs": "^0.46.0"
   },
   "browserslist": [
     ">1%",
diff --git a/examples/circuit-relaying/package.json b/examples/circuit-relaying/package.json
@@ -14,13 +14,13 @@
   "author": "Dmitriy Ryajov <dryajov@gmail.com>",
   "license": "MIT",
   "dependencies": {
-    "ipfs": "^0.45.0",
+    "ipfs": "^0.46.0",
     "ipfs-pubsub-room": "^2.0.1"
   },
   "devDependencies": {
     "execa": "^4.0.0",
     "ipfs-css": "^0.13.1",
-    "ipfs-http-client": "^44.1.1",
+    "ipfs-http-client": "^44.2.0",
     "parcel-bundler": "^1.12.4",
     "tachyons": "^4.9.1",
     "test-ipfs-example": "^2.0.3"
diff --git a/examples/custom-ipfs-repo/package.json b/examples/custom-ipfs-repo/package.json
@@ -11,7 +11,7 @@
   "license": "MIT",
   "dependencies": {
     "datastore-fs": "^1.1.0",
-    "ipfs": "^0.45.0",
+    "ipfs": "^0.46.0",
     "ipfs-repo": "^3.0.0",
     "it-all": "^1.0.1"
   },
diff --git a/examples/custom-libp2p/package.json b/examples/custom-libp2p/package.json
@@ -10,7 +10,7 @@
   },
   "license": "MIT",
   "dependencies": {
-    "ipfs": "^0.45.0",
+    "ipfs": "^0.46.0",
     "libp2p": "^0.27.7",
     "libp2p-bootstrap": "^0.10.3",
     "libp2p-kad-dht": "^0.18.7",
diff --git a/examples/exchange-files-in-browser/package.json b/examples/exchange-files-in-browser/package.json
@@ -14,10 +14,10 @@
     "browserify": "^16.2.3",
     "execa": "^4.0.0",
     "http-server": "^0.11.1",
-    "ipfs-http-client": "^44.1.1"
+    "ipfs-http-client": "^44.2.0"
   },
   "dependencies": {
-    "ipfs": "^0.45.0",
+    "ipfs": "^0.46.0",
     "it-all": "^1.0.1",
     "it-last": "^1.0.1",
     "test-ipfs-example": "^2.0.3"
diff --git a/examples/explore-ethereum-blockchain/package.json b/examples/explore-ethereum-blockchain/package.json
@@ -10,8 +10,8 @@
   "keywords": [],
   "license": "MIT",
   "devDependencies": {
-    "ipfs": "^0.45.0",
-    "ipfs-http-client": "^44.1.1",
+    "ipfs": "^0.46.0",
+    "ipfs-http-client": "^44.2.0",
     "test-ipfs-example": "^2.0.3"
   }
 }
diff --git a/examples/ipfs-101/package.json b/examples/ipfs-101/package.json
@@ -10,7 +10,7 @@
   "author": "David Dias <daviddias@ipfs.io>",
   "license": "MIT",
   "dependencies": {
-    "ipfs": "^0.45.0",
+    "ipfs": "^0.46.0",
     "it-all": "^1.0.1"
   },
   "devDependencies": {
diff --git a/examples/run-in-electron/package.json b/examples/run-in-electron/package.json
@@ -18,7 +18,7 @@
   "devDependencies": {
     "electron": "^6.0.0",
     "electron-rebuild": "^1.8.4",
-    "ipfs": "^0.45.0",
+    "ipfs": "^0.46.0",
     "test-ipfs-example": "^2.0.3"
   },
   "greenkeeper": {
diff --git a/examples/running-multiple-nodes/package.json b/examples/running-multiple-nodes/package.json
@@ -13,6 +13,6 @@
     "test-ipfs-example": "^2.0.3"
   },
   "dependencies": {
-    "ipfs": "^0.45.0"
+    "ipfs": "^0.46.0"
   }
 }
diff --git a/examples/traverse-ipld-graphs/package.json b/examples/traverse-ipld-graphs/package.json
@@ -13,7 +13,7 @@
     "test-ipfs-example": "^2.0.3"
   },
   "dependencies": {
-    "ipfs": "^0.45.0",
+    "ipfs": "^0.46.0",
     "ipld-block": "^0.9.1"
   }
 }
diff --git a/packages/interface-ipfs-core/src/block/get.js b/packages/interface-ipfs-core/src/block/get.js
@@ -89,10 +89,7 @@ module.exports = (common, options) => {
     })
 
     it('should return an error for an invalid CID', () => {
-      return expect(ipfs.block.get('invalid')).to.eventually.be.rejected
-        .and.be.an.instanceOf(Error)
-        .and.have.property('message')
-        .that.include('Non-base58 character')
+      return expect(ipfs.block.get('invalid')).to.eventually.be.rejected()
     })
   })
 }
diff --git a/packages/interface-ipfs-core/src/object/put.js b/packages/interface-ipfs-core/src/object/put.js
@@ -113,7 +113,11 @@ module.exports = (common, options) => {
       const cid = await ipfs.object.put(node1b)
       const node = await ipfs.object.get(cid)
       expect(node1b.Data).to.deep.equal(node.Data)
-      expect(node1b.Links).to.deep.equal(node.Links)
+      expect(node1b.Links).to.deep.equal(node.Links.map(l => ({
+        Name: l.Name,
+        Tsize: l.Tsize,
+        Hash: l.Hash
+      })))
     })
   })
 }
diff --git a/packages/ipfs/.aegir.js b/packages/ipfs/.aegir.js
@@ -15,7 +15,7 @@ let sigServerB
 let ipfsdServer
 
 module.exports = {
-  bundlesize: { maxSize: '446kB' },
+  bundlesize: { maxSize: '545kB' },
   karma: {
     files: [{
       pattern: 'node_modules/interface-ipfs-core/test/fixtures/**/*',
diff --git a/packages/ipfs/README.md b/packages/ipfs/README.md
@@ -188,6 +188,7 @@ List of the main packages that make up the IPFS ecosystem.
 | [`libp2p-mdns`](//github.com/libp2p/js-libp2p-mdns) | [![npm](https://img.shields.io/npm/v/libp2p-mdns.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-mdns/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-mdns.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-mdns) | [![Travis CI](https://flat.badgen.net/travis/libp2p/js-libp2p-mdns/master)](https://travis-ci.com/libp2p/js-libp2p-mdns) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-mdns/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-mdns) | [Jacob Heun](mailto:jacobheun@gmail.com) |
 | [`libp2p-bootstrap`](//github.com/libp2p/js-libp2p-bootstrap) | [![npm](https://img.shields.io/npm/v/libp2p-bootstrap.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-bootstrap/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-bootstrap.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-bootstrap) | [![Travis CI](https://flat.badgen.net/travis/libp2p/js-libp2p-bootstrap/master)](https://travis-ci.com/libp2p/js-libp2p-bootstrap) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-bootstrap/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-bootstrap) | [Vasco Santos](mailto:vasco.santos@moxy.studio) |
 | [`libp2p-secio`](//github.com/libp2p/js-libp2p-secio) | [![npm](https://img.shields.io/npm/v/libp2p-secio.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-secio/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-secio.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-secio) | [![Travis CI](https://flat.badgen.net/travis/libp2p/js-libp2p-secio/master)](https://travis-ci.com/libp2p/js-libp2p-secio) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-secio/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-secio) | [Friedel Ziegelmayer](mailto:dignifiedquire@gmail.com) |
+| [`libp2p-noise`](//github.com/NodeFactoryIo/js-libp2p-noise) | [![npm](https://img.shields.io/npm/v/libp2p-noise.svg?maxAge=86400&style=flat-square)](//github.com/NodeFactoryIo/js-libp2p-noise/releases) | [![Deps](https://david-dm.org/NodeFactoryIo/js-libp2p-noise.svg?style=flat-square)](https://david-dm.org/NodeFactoryIo/js-libp2p-noise) | [![Travis CI](https://flat.badgen.net/travis/NodeFactoryIo/js-libp2p-noise/master)](https://travis-ci.com/NodeFactoryIo/js-libp2p-noise) | [![codecov](https://codecov.io/gh/NodeFactoryIo/js-libp2p-noise/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/NodeFactoryIo/js-libp2p-noise) | N/A |
 | [`libp2p-tcp`](//github.com/libp2p/js-libp2p-tcp) | [![npm](https://img.shields.io/npm/v/libp2p-tcp.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-tcp/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-tcp.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-tcp) | [![Travis CI](https://flat.badgen.net/travis/libp2p/js-libp2p-tcp/master)](https://travis-ci.com/libp2p/js-libp2p-tcp) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-tcp/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-tcp) | [Jacob Heun](mailto:jacobheun@gmail.com) |
 | [`libp2p-webrtc-star`](//github.com/libp2p/js-libp2p-webrtc-star) | [![npm](https://img.shields.io/npm/v/libp2p-webrtc-star.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-webrtc-star/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-webrtc-star.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-webrtc-star) | [![Travis CI](https://flat.badgen.net/travis/libp2p/js-libp2p-webrtc-star/master)](https://travis-ci.com/libp2p/js-libp2p-webrtc-star) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-webrtc-star/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-webrtc-star) | [Vasco Santos](mailto:vasco.santos@moxy.studio) |
 | [`libp2p-websocket-star`](//github.com/libp2p/js-libp2p-websocket-star) | [![npm](https://img.shields.io/npm/v/libp2p-websocket-star.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-websocket-star/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-websocket-star.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-websocket-star) | [![Travis CI](https://flat.badgen.net/travis/libp2p/js-libp2p-websocket-star/master)](https://travis-ci.com/libp2p/js-libp2p-websocket-star) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-websocket-star/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-websocket-star) | [Jacob Heun](mailto:jacobheun@gmail.com) |
diff --git a/packages/ipfs/package-list.json b/packages/ipfs/package-list.json
@@ -46,6 +46,7 @@
     ["libp2p/js-libp2p-mdns", "libp2p-mdns"],
     ["libp2p/js-libp2p-bootstrap", "libp2p-bootstrap"],
     ["libp2p/js-libp2p-secio", "libp2p-secio"],
+    ["NodeFactoryIo/js-libp2p-noise", "libp2p-noise"],
     ["libp2p/js-libp2p-tcp", "libp2p-tcp"],
     ["libp2p/js-libp2p-webrtc-star", "libp2p-webrtc-star"],
     ["libp2p/js-libp2p-websocket-star", "libp2p-websocket-star"],
diff --git a/packages/ipfs/package.json b/packages/ipfs/package.json
@@ -139,6 +139,7 @@
     "libp2p-keychain": "^0.6.0",
     "libp2p-mdns": "^0.13.1",
     "libp2p-mplex": "^0.9.3",
+    "libp2p-noise": "^1.1.1",
     "libp2p-record": "^0.7.3",
     "libp2p-secio": "^0.12.2",
     "libp2p-tcp": "^0.14.5",
diff --git a/packages/ipfs/src/core/runtime/libp2p-browser.js b/packages/ipfs/src/core/runtime/libp2p-browser.js
@@ -3,6 +3,7 @@
 const WS = require('libp2p-websockets')
 const WebRTCStar = require('libp2p-webrtc-star')
 const Multiplex = require('libp2p-mplex')
+const { NOISE } = require('libp2p-noise')
 const SECIO = require('libp2p-secio')
 const KadDHT = require('libp2p-kad-dht')
 const GossipSub = require('libp2p-gossipsub')
@@ -24,7 +25,8 @@ module.exports = () => {
         Multiplex
       ],
       connEncryption: [
-        SECIO
+        SECIO,
+        NOISE
       ],
       peerDiscovery: [],
       dht: KadDHT,
diff --git a/packages/ipfs/src/core/runtime/libp2p-nodejs.js b/packages/ipfs/src/core/runtime/libp2p-nodejs.js
@@ -7,6 +7,7 @@ const KadDHT = require('libp2p-kad-dht')
 const GossipSub = require('libp2p-gossipsub')
 const Multiplex = require('libp2p-mplex')
 const SECIO = require('libp2p-secio')
+const { NOISE } = require('libp2p-noise')
 const ipnsUtils = require('../ipns/routing/utils')
 
 module.exports = () => {
@@ -25,7 +26,8 @@ module.exports = () => {
         Multiplex
       ],
       connEncryption: [
-        SECIO
+        SECIO,
+        NOISE
       ],
       peerDiscovery: [
         MulticastDNS
diff --git a/packages/ipfs/src/http/gateway/resources/gateway.js b/packages/ipfs/src/http/gateway/resources/gateway.js
@@ -62,6 +62,7 @@ module.exports = {
           throw Boom.boomify(err, { statusCode: 404 })
         case (errorToString.startsWith('Error: multihash length inconsistent')):
         case (errorToString.startsWith('Error: Non-base58 character')):
+        case (errorToString.startsWith('Error: invalid character')):
           throw Boom.boomify(err, { statusCode: 400 })
         default:
           log.error(err)

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`"keywords": [],`
`13`	`13`	`"license": "MIT",`
`14`	`14`	`"devDependencies": {`
`15`		`- "ipfs": "^0.45.0",`
	`15`	`+ "ipfs": "^0.46.0",`
`16`	`16`	`"test-ipfs-example": "^2.0.3"`
`17`	`17`	`}`
`18`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@`
`21`	`21`	`"webpack-cli": "^3.3.11"`
`22`	`22`	`},`
`23`	`23`	`"dependencies": {`
`24`		`- "ipfs": "^0.45.0",`
	`24`	`+ "ipfs": "^0.46.0",`
`25`	`25`	`"mime-sniffer": "~0.0.3"`
`26`	`26`	`}`
`27`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`	`"webpack": "^4.28.4"`
`21`	`21`	`},`
`22`	`22`	`"dependencies": {`
`23`		`- "ipfs": "^0.45.0",`
	`23`	`+ "ipfs": "^0.46.0",`
`24`	`24`	`"it-to-stream": "^0.1.1",`
`25`	`25`	`"videostream": "^3.2.0"`
`26`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,6 @@`
`16`	`16`	`"test-ipfs-example": "^2.0.3"`
`17`	`17`	`},`
`18`	`18`	`"dependencies": {`
`19`		`- "ipfs": "^0.45.0"`
	`19`	`+ "ipfs": "^0.46.0"`
`20`	`20`	`}`
`21`	`21`	`}`