IPFS Integration

.gitignore

@@ -1,3 +1,6 @@
+package-lock.json
+yarn.lock
+
 # Logs
 logs
 *.log
@@ -54,6 +57,8 @@ Brave.tar.bz2
 app/extensions/gen
 app/extensions/brave/gen
 app/extensions/torrent/gen
+app/extensions/ipfs/gen
+
 *.pfx
 buildConfig.js
 

app/extensions.js

@@ -415,13 +415,17 @@ module.exports.init = () => {
     return object
   }
 
-  let loadExtension = (extensionId, extensionPath, manifest = {}, manifestLocation = 'unpacked') => {
-    if (extensionId === config.PDFJSExtensionId) {
+  const loadExtension = (extensionId, extensionPath, manifest = {}, manifestLocation = 'unpacked') => {
+    if (extensionId === config.PDFJSExtensionId ||
+        extensionId === config.ipfsExtensionId) {
       manifestLocation = 'component'
     }
-    if (!extensionInfo.isLoaded(extensionId) && !extensionInfo.isLoading(extensionId)) {
+    if (!extensionInfo.isLoaded(extensionId) &&
+        !extensionInfo.isLoading(extensionId)) {
       extensionInfo.setState(extensionId, extensionStates.LOADING)
-      if (extensionId === config.braveExtensionId || extensionId === config.torrentExtensionId || extensionId === config.syncExtensionId) {
+      if (extensionId === config.braveExtensionId ||
+          extensionId === config.torrentExtensionId ||
+          extensionId === config.syncExtensionId) {
         session.defaultSession.extensions.load(extensionPath, manifest, manifestLocation)
         return
       }
@@ -430,6 +434,7 @@ module.exports.init = () => {
       // just a safety net.
       fs.exists(path.join(extensionPath, 'manifest.json'), (exists) => {
         if (exists) {
+          console.log('Loading:', extensionId, manifestLocation)
           session.defaultSession.extensions.load(extensionPath, manifest, manifestLocation)
         } else {
           // This is an error condition, but we can recover.
@@ -454,18 +459,21 @@ module.exports.init = () => {
       const extensions = extensionState.getExtensions(appStore.getState())
       const extensionPath = extensions.getIn([extensionId, 'filePath'])
       if (extensionPath) {
-        // Otheriwse just install it
+        // Otherwise just install it
         loadExtension(extensionId, extensionPath)
       }
     }
   }
 
-  // Manually install the braveExtension and torrentExtension
+  // Manually install the braveExtension, torrentExtension and ipfsExtension
+
+  // braveExtension
   extensionInfo.setState(config.braveExtensionId, extensionStates.REGISTERED)
   loadExtension(config.braveExtensionId, getExtensionsPath('brave'), generateBraveManifest(), 'component')
   extensionInfo.setState(config.syncExtensionId, extensionStates.REGISTERED)
   loadExtension(config.syncExtensionId, getExtensionsPath('brave'), generateSyncManifest(), 'unpacked')
 
+  // torrentExtension
   if (getSetting(settings.TORRENT_VIEWER_ENABLED)) {
     extensionInfo.setState(config.torrentExtensionId, extensionStates.REGISTERED)
     loadExtension(config.torrentExtensionId, getExtensionsPath('torrent'), generateTorrentManifest(), 'component')
@@ -474,6 +482,10 @@ module.exports.init = () => {
     extensionActions.extensionDisabled(config.torrentExtensionId)
   }
 
+  // ipfsExtension
+  extensionInfo.setState(config.ipfsExtensionId, extensionStates.REGISTERED)
+  loadExtension(config.ipfsExtensionId, getExtensionsPath('ipfs'))
+
   let registerComponents = (diff) => {
     if (getSetting(settings.PDFJS_ENABLED)) {
       registerComponent(config.PDFJSExtensionId, config.PDFJSExtensionPublicKey)

app/extensions/brave/index-dev.html

@@ -7,7 +7,40 @@
     <!-- TODO: Don't allow img-src *, needed for favicons -->
     <!-- TODO: Refactor away all unsafe-inline content -->
     <!-- TODO: Replace suggestqueries.google.com and ac.duckduckgo.com and other search engines with a single config search engine -->
-    <meta http-equiv="Content-Security-Policy" content="default-src 'none'; form-action http://localhost:*; script-src 'self' http://localhost:*; connect-src 'self' https://s3.amazonaws.com/adblock-data/ https://s3.amazonaws.com/safe-browsing-data/ https://s3.amazonaws.com/tracking-protection-data/ https://s3.amazonaws.com/https-everywhere-data/ http://localhost:* ws://localhost:* https://suggestqueries.google.com https://ac.duckduckgo.com https://completion.amazon.com https://search.yahoo.com https://api.bing.com https://www.startpage.com https://infogalactic.com https://api.qwant.com https://ac.ecosia.org https://searx.me https://www.findx.com https://brave-download.global.ssl.fastly.net https://brave-laptop-updates.global.ssl.fastly.net https://brave-download.global.ssl.fastly.net https://laptop-updates-pre.brave.com https://brave-laptop-updates-pre.brave.com; style-src 'unsafe-inline'; font-src 'self' http://localhost:*; img-src 'self' * data: file: chrome-extension:; object-src 'self'; plugin-types application/browser-plugin">
+    <meta http-equiv="Content-Security-Policy" content="
+      default-src 'none';
+      form-action http://localhost:*;
+      script-src 
+        'self'
+         http://localhost:*;
+      connect-src
+        'self'
+        https://s3.amazonaws.com/adblock-data/
+        https://s3.amazonaws.com/safe-browsing-data/
+        https://s3.amazonaws.com/tracking-protection-data/
+        https://s3.amazonaws.com/https-everywhere-data/
+        http://localhost:* ws://localhost:*
+        https://suggestqueries.google.com
+        https://ac.duckduckgo.com
+        https://completion.amazon.com
+        https://search.yahoo.com
+        https://api.bing.com
+        https://www.startpage.com
+        https://infogalactic.com
+        https://api.qwant.com
+        https://ac.ecosia.org
+        https://searx.me
+        https://www.findx.com
+        https://brave-download.global.ssl.fastly.net
+        https://brave-laptop-updates.global.ssl.fastly.net
+        https://brave-download.global.ssl.fastly.net
+        https://laptop-updates-pre.brave.com
+        https://brave-laptop-updates-pre.brave.com;
+      style-src 'unsafe-inline';
+      font-src 'self' http://localhost:*;
+      img-src 'self' * data: file: chrome-extension:;
+      object-src 'self';
+      plugin-types application/browser-plugin">
     <meta name="referrer" content="no-referrer">
     <title>Brave</title>
     <script src="ext/l20n.min.js"></script>

app/extensions/ipfs/_locales/en/app.properties

@@ -0,0 +1 @@
+ipfs=Distributed Web

app/extensions/ipfs/_locales/en/messages.json

@@ -0,0 +1 @@
+{}

app/extensions/ipfs/ipfs.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta name="availableLanguages" content="">
+    <meta name="defaultLanguage" content="en-US">
+    <meta http-equiv="Content-Security-Policy" content="
+      default-src 'none';
+      form-action http://localhost:*;
+      script-src 'self' 'unsafe-eval';
+      img-src * data: file: chrome-extension:;
+      style-src 'self' 'unsafe-inline'; font-src 'self'; 
+      connect-src 'self' wss://* ;
+      object-src 'self';
+      plugin-types application/browser-plugin"
+    />
+    <meta name="referrer" content="no-referrer">
+    <title>IPFS</title>
+    <script src="js/ipfs.min.js"></script>
+    <script src="js/main.js"></script>
+    <script src="js/some-other.js"></script>
+  </head>
+  <body>
+    <h1>IPFS</h1>
+  </body>
+</html>

app/extensions/ipfs/js/main.js

@@ -0,0 +1,54 @@
+/* global Ipfs */
+
+chrome.protocol.registerStringProtocol('ipfs', handler)
+
+const node = new Ipfs({
+  config: {
+    Addresses: {
+      Swarm: []
+    }
+  }
+})
+
+// TODO: bring back once brave supports registerURIHandlers
+// chrome.protocol.registerStringProtocol('dweb', handler)
+
+/*
+ * request is an object with:
+ *   - method (e.g GET)
+ *   - referrer (always empty for now)
+ *   - url (full ipfs://<path>)
+ * reply is a functin that takes one argument which is the response to the request
+ */
+function handler (request, reply) {
+  if (!node.isOnline()) {
+    node.once('ready', () => handler(request, reply))
+  }
+
+  const path = request.url.split('ipfs://')[1]
+
+  // TODO check if it is valid IPFS Path
+  // callback('hi there!' + test()) // eslint-disable-line
+
+  // TODO here I need to check if it is a directory or a file:
+  // if file load it
+  // if directory fetch it and look for an index.html
+  //   if index.html load that
+  //   if no index.html, load the directory listing just like the gateway
+
+  node.files.cat(path, (err, stream) => {
+    if (err) {
+      // TODO create a nice error page
+      return reply('err: ' + err.message)
+    }
+
+    // TODO replace this by something like BL
+    let buf = ''
+
+    stream.on('data', (data) => {
+      buf += data.toString()
+    })
+
+    stream.on('end', () => reply(buf))
+  })
+}

app/extensions/ipfs/js/some-other.js

@@ -0,0 +1,3 @@
+function test () {
+  return 'yeeah'
+}

app/extensions/ipfs/manifest.json

@@ -0,0 +1,18 @@
+{
+  "manifest_version": 2,
+  "name": "IPFS",
+  "version": "0.1.0",
+  "default_locale": "en",
+  "description": "InterPlanetary FileSystem",
+  "icons": {
+    "128": "img/ipfs-128.png",
+    "48": "img/ipfs-48.png",
+    "16": "img/ipfs-16.png"
+  },
+  "offline_enabled": true,
+  "background": {
+    "page": "ipfs.html",
+    "persistent": true
+  },
+  "content_security_policy": "script-src 'self' 'unsafe-eval'"
+}

docs/state.md

@@ -209,6 +209,7 @@ AppStore
     'advanced.send-usage-statistics': boolean, // true or undefined if usage reports should be sent
     'advanced.smooth-scroll-enabled': boolean, // false if smooth scrolling should be explicitly disabled
     'advanced.torrent-viewer-enabled': boolean, // whether to render magnet links in the browser
+    'advanced.ipfs-enabled': boolean, // whether to use IPFS to render ipfs:// or dweb: links in the browser
     'bookmarks.toolbar.show': boolean, // true if the bookmakrs toolbar should be shown
     'bookmarks.toolbar.showFavicon': boolean, // true if bookmark favicons should be shown on the bookmarks toolbar
     'bookmarks.toolbar.showOnlyFavicon': boolean, // true if only favicons should be shown on the bookmarks toolbar

js/about/preferences.js

@@ -819,6 +819,7 @@ class AboutPreferences extends React.Component {
       settings.LANGUAGE,
       settings.PDFJS_ENABLED,
       settings.TORRENT_VIEWER_ENABLED,
+      settings.IPFS_ENABLED,
       settings.SMOOTH_SCROLL_ENABLED,
       settings.SEND_CRASH_REPORTS,
       settings.UPDATE_TO_PREVIEW_RELEASES

js/constants/appConfig.js

@@ -33,7 +33,8 @@ module.exports = {
     COOKIEBLOCK: 'cookieblock', // block 3p cookies and referer
     COOKIEBLOCK_ALL: 'cookieblockAll', // block all cookies and referer
     SITEHACK: 'siteHacks',
-    WEBTORRENT: 'webtorrent'
+    WEBTORRENT: 'webtorrent',
+    IPFS: 'ipfs'
     // ... other optional resource files are identified by uuid such as for regional adblock
   },
   cookieblock: {
@@ -95,6 +96,9 @@ module.exports = {
   webtorrent: {
     enabled: true
   },
+  ipfs: {
+    enabled: true
+  },
   adInsertion: {
     enabled: false,
     url: adHost
@@ -207,6 +211,7 @@ module.exports = {
     'advanced.default-zoom-level': null,
     'advanced.pdfjs-enabled': true,
     'advanced.torrent-viewer-enabled': true,
+    'advanced.ipfs-enabled': true,
     'advanced.smooth-scroll-enabled': false,
     'advanced.send-crash-reports': true,
     'advanced.send-usage-statistics': false,

js/constants/config.js

@@ -62,6 +62,7 @@ module.exports = {
   widevineComponentPublicKey: 'MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCmhe+02cLPPAViaevk/fzODKUnb/ysaAeD8lpE9pwirV6GYOm+naTo7xPOCh8ujcR6Ryi1nPTq2GTG0CyqdDyOsZ1aRLuMZ5QqX3dJ9jXklS0LqGfosoIpGexfwggbiLvQOo9Q+IWTrAO620KAzYU0U6MV272TJLSmZPUEFY6IGQIDAQAB',
   braveExtensionId: 'mnojpmjdmbbfmejpflffifhffcmidifd',
   torrentExtensionId: 'fmdpfempfmekjkcfdehndghogpnpjeno',
+  ipfsExtensionId: 'interplanetaryfilesystemuniverse',
   syncExtensionId: 'cjnmeadmgmiihncdidmfiabhenbggfjm',
   // PDFJS
   // Parent repo: https://github.com/diracdeltas/pdf.js

js/constants/settings.js

@@ -71,6 +71,7 @@ const settings = {
   HARDWARE_ACCELERATION_ENABLED: 'advanced.hardware-acceleration-enabled',
   PDFJS_ENABLED: 'advanced.pdfjs-enabled',
   TORRENT_VIEWER_ENABLED: 'advanced.torrent-viewer-enabled',
+  IPFS_ENABLED: 'advanced.ipfs-enabled',
   DEFAULT_ZOOM_LEVEL: 'advanced.default-zoom-level',
   SMOOTH_SCROLL_ENABLED: 'advanced.smooth-scroll-enabled',
   SEND_CRASH_REPORTS: 'advanced.send-crash-reports',

js/lib/appUrlUtil.js

@@ -48,6 +48,18 @@ module.exports.getTorrentExtUrl = function (relativeUrl) {
   return 'chrome-extension://' + config.torrentExtensionId + '/' + relativeUrl
 }
 
+/**
+ * Gets the URL of a page hosted by the ipfsExtension
+ * Returns 'chrome-extension://<...>'
+ */
+module.exports.getIpfsExtUrl = function (relativeUrl) {
+  if (relativeUrl === undefined) {
+    relativeUrl = ''
+  }
+
+  return 'chrome-extension://' + config.ipfsExtensionId + '/' + relativeUrl
+}
+
 module.exports.getExtensionsPath = function (extensionDir) {
   return (process.env.NODE_ENV !== 'development' && process.env.NODE_ENV !== 'test')
     // the path is different for release builds because extensions are not in the asar file
@@ -210,6 +222,47 @@ module.exports.isTargetMagnetUrl = function (input) {
   return !!module.exports.getSourceMagnetUrl(input)
 }
 
+/**
+ * Obtains the target URL associated with a IPFS path
+ * Returns null if the input is not a IPFS path
+ * Example: getTargetIpfsPath('ipfs:/...') -> 'chrome-extension://<...>.html#/ipfs/...'
+ */
+module.exports.getTargetIpfsPath = function (input) {
+  if (!input.startsWith('ipfs://') &&
+     !input.startsWith('dweb:')) {
+    return null
+  }
+  const url = module.exports.getIpfsExtUrl('ipfs.html')
+  return [url, input].join('#')
+}
+
+/**
+ * Obtains the source IPFS Path associated with a target URL
+ * Returns null if the input is not the local URL for a IPFS Path
+ * Example: getSourceIPFSPath('chrome-extension://<...>.html#/ipfs/...') -> 'ipfs:/:...'
+ */
+module.exports.getSourceIPFSPath = function (input) {
+  if (getBaseUrl(input) !== module.exports.getIpfsExtUrl('ipfs.html')) return null
+  const url = decodeURIComponent(getHash(input))
+  return url
+}
+
+/**
+ * Checks if the input looks like a magnet: URL
+ * Example: isSourceIpfsPath('ipfs:/..') -> true
+ */
+module.exports.isSourceIpfsPath = function (input) {
+  return !!module.exports.getTargetIpfsPath(input)
+}
+
+/*
+ * Checks if the input looks like the local URL for a IPFS Path
+ * Example: isSourceIpfsPath('chrome-extension://<...>.html#/ipfs/') -> true
+ */
+module.exports.isTargetIPFSPath = function (input) {
+  return !!module.exports.getSourceIPFSPath(input)
+}
+
 /**
  * Determines whether a string is a valid URL. Based on node-urlutil.js.
  * @param {string} input

package.json

@@ -45,7 +45,8 @@
     "watch-all": "npm run watch & npm run watch-test",
     "watch-test": "cross-env NODE_ENV=test webpack --watch",
     "webpack": "webpack",
-    "win-renpm": "powershell ./tools/windows/re-npm.ps1"
+    "win-renpm": "powershell ./tools/windows/re-npm.ps1",
+    "ipfs": "wget https://unpkg.com/ipfs/dist/index.min.js -O app/extensions/ipfs/js/ipfs.min.js"
   },
   "repository": "brave/browser-laptop",
   "author": {
@@ -148,6 +149,7 @@
     "electron-chromedriver": "^1.7.1",
     "electron-packager": "brave/electron-packager",
     "electron-prebuilt": "brave/electron-prebuilt",
+    "electron-rebuild": "^1.5.11",
     "empty-port": "0.0.2",
     "enzyme": "^2.9.1",
     "flow-bin": "^0.22.1",