Merge pull request #1849 from MetaMask/blacklist-refactor

Blacklist refactor

app/manifest.json

@@ -52,15 +52,6 @@
       ],
       "run_at": "document_start",
       "all_frames": true
-    },
-    {
-      "run_at": "document_start",
-      "matches": [
-        "http://*/*",
-        "https://*/*"
-      ],
-      "js": ["scripts/blacklister.js"],
-      "all_frames": true
     }
   ],
   "permissions": [

app/scripts/background.js

@@ -11,7 +11,6 @@ const NotificationManager = require('./lib/notification-manager.js')
 const MetamaskController = require('./metamask-controller')
 const extension = require('extensionizer')
 const firstTimeState = require('./first-time-state')
-const isPhish = require('./lib/is-phish')
 
 const STORAGE_KEY = 'metamask-config'
 const METAMASK_DEBUG = 'GULP_METAMASK_DEBUG'
@@ -91,16 +90,12 @@ function setupController (initState) {
 
   extension.runtime.onConnect.addListener(connectRemote)
   function connectRemote (remotePort) {
-    if (remotePort.name === 'blacklister') {
+    const isMetaMaskInternalProcess = remotePort.name === 'popup' || remotePort.name === 'notification'
-      return checkBlacklist(remotePort)
+    const portStream = new PortStream(remotePort)
-    }
-
-    var isMetaMaskInternalProcess = remotePort.name === 'popup' || remotePort.name === 'notification'
-    var portStream = new PortStream(remotePort)
     if (isMetaMaskInternalProcess) {
       // communication with popup
       popupIsOpen = popupIsOpen || (remotePort.name === 'popup')
-      controller.setupTrustedCommunication(portStream, 'MetaMask', remotePort.name)
+      controller.setupTrustedCommunication(portStream, 'MetaMask')
       // record popup as closed
       if (remotePort.name === 'popup') {
         endOfStream(portStream, () => {
@@ -109,7 +104,7 @@ function setupController (initState) {
       }
     } else {
       // communication with page
-      var originDomain = urlUtil.parse(remotePort.sender.url).hostname
+      const originDomain = urlUtil.parse(remotePort.sender.url).hostname
       controller.setupUntrustedCommunication(portStream, originDomain)
     }
   }
@@ -140,27 +135,6 @@ function setupController (initState) {
   return Promise.resolve()
 }
 
-// Listen for new pages and return if blacklisted:
-function checkBlacklist (port) {
-  const handler = handleNewPageLoad.bind(null, port)
-  port.onMessage.addListener(handler)
-  setTimeout(() => {
-    port.onMessage.removeListener(handler)
-  }, 30000)
-}
-
-function handleNewPageLoad (port, message) {
-  const { pageLoaded } = message
-  if (!pageLoaded || !global.metamaskController) return
-
-  const state = global.metamaskController.getState()
-  const updatedBlacklist = state.blacklist
-
-  if (isPhish({ updatedBlacklist, hostname: pageLoaded })) {
-    port.postMessage({ 'blacklist': pageLoaded })
-  }
-}
-
 //
 // Etc...
 //

app/scripts/blacklister.js

@@ -1,14 +0,0 @@
-const extension = require('extensionizer')
-
-var port = extension.runtime.connect({name: 'blacklister'})
-port.postMessage({ 'pageLoaded': window.location.hostname })
-port.onMessage.addListener(redirectIfBlacklisted)
-
-function redirectIfBlacklisted (response) {
-  const { blacklist } = response
-  const host = window.location.hostname
-  if (blacklist && blacklist === host) {
-    window.location.href = 'https://metamask.io/phishing.html'
-  }
-}
-

app/scripts/contentscript.js

@@ -37,28 +37,33 @@ function setupInjection () {
 
 function setupStreams () {
   // setup communication to page and plugin
-  var pageStream = new LocalMessageDuplexStream({
+  const pageStream = new LocalMessageDuplexStream({
     name: 'contentscript',
     target: 'inpage',
   })
   pageStream.on('error', console.error)
-  var pluginPort = extension.runtime.connect({name: 'contentscript'})
+  const pluginPort = extension.runtime.connect({ name: 'contentscript' })
-  var pluginStream = new PortStream(pluginPort)
+  const pluginStream = new PortStream(pluginPort)
   pluginStream.on('error', console.error)
 
   // forward communication plugin->inpage
   pageStream.pipe(pluginStream).pipe(pageStream)
 
   // setup local multistream channels
-  var mx = ObjectMultiplex()
+  const mx = ObjectMultiplex()
   mx.on('error', console.error)
   mx.pipe(pageStream).pipe(mx)
+  mx.pipe(pluginStream).pipe(mx)
 
   // connect ping stream
-  var pongStream = new PongStream({ objectMode: true })
+  const pongStream = new PongStream({ objectMode: true })
   pongStream.pipe(mx.createStream('pingpong')).pipe(pongStream)
 
-  // ignore unused channels (handled by background)
+  // connect phishing warning stream
+  const phishingStream = mx.createStream('phishing')
+  phishingStream.once('data', redirectToPhishingWarning)
+
+  // ignore unused channels (handled by background, inpage)
   mx.ignoreStream('provider')
   mx.ignoreStream('publicConfig')
 }
@@ -88,3 +93,8 @@ function suffixCheck () {
   }
   return true
 }
+
+function redirectToPhishingWarning () {
+  console.log('MetaMask - redirecting to phishing warning')
+  window.location.href = 'https://metamask.io/phishing.html'
+}

app/scripts/controllers/blacklist.js

@@ -0,0 +1,50 @@
+const ObservableStore = require('obs-store')
+const extend = require('xtend')
+const communityBlacklistedDomains = require('etheraddresslookup/blacklists/domains.json')
+const communityWhitelistedDomains = require('etheraddresslookup/whitelists/domains.json')
+const checkForPhishing = require('../lib/is-phish')
+
+// compute phishing lists
+const PHISHING_BLACKLIST = communityBlacklistedDomains.concat(['metamask.com'])
+const PHISHING_WHITELIST = communityWhitelistedDomains.concat(['metamask.io', 'www.metamask.io'])
+const PHISHING_FUZZYLIST = ['myetherwallet', 'myetheroll', 'ledgerwallet', 'metamask']
+// every ten minutes
+const POLLING_INTERVAL = 10 * 60 * 1000
+
+class BlacklistController {
+
+  constructor (opts = {}) {
+    const initState = extend({
+      phishing: PHISHING_BLACKLIST,
+    }, opts.initState)
+    this.store = new ObservableStore(initState)
+    // polling references
+    this._phishingUpdateIntervalRef = null
+  }
+
+  //
+  // PUBLIC METHODS
+  //
+
+  checkForPhishing (hostname) {
+    if (!hostname) return false
+    const { blacklist } = this.store.getState()
+    return checkForPhishing({ hostname, blacklist, whitelist: PHISHING_WHITELIST, fuzzylist: PHISHING_FUZZYLIST })
+  }
+
+  async updatePhishingList () {
+    const response = await fetch('https://api.infura.io/v1/blacklist')
+    const phishing = await response.json()
+    this.store.updateState({ phishing })
+    return phishing
+  }
+
+  scheduleUpdates () {
+    if (this._phishingUpdateIntervalRef) return
+    this._phishingUpdateIntervalRef = setInterval(() => {
+      this.updatePhishingList()
+    }, POLLING_INTERVAL)
+  }
+}
+
+module.exports = BlacklistController

app/scripts/controllers/infura.js

@@ -1,16 +1,14 @@
 const ObservableStore = require('obs-store')
 const extend = require('xtend')
-const recentBlacklist = require('etheraddresslookup/blacklists/domains.json')
 
 // every ten minutes
-const POLLING_INTERVAL = 300000
+const POLLING_INTERVAL = 10 * 60 * 1000
 
 class InfuraController {
 
   constructor (opts = {}) {
     const initState = extend({
       infuraNetworkStatus: {},
-      blacklist: recentBlacklist,
     }, opts.initState)
     this.store = new ObservableStore(initState)
   }
@@ -32,24 +30,12 @@ class InfuraController {
       })
   }
 
-  updateLocalBlacklist () {
-    return fetch('https://api.infura.io/v1/blacklist')
-      .then(response => response.json())
-      .then((parsedResponse) => {
-        this.store.updateState({
-          blacklist: parsedResponse,
-        })
-        return parsedResponse
-      })
-  }
-
   scheduleInfuraNetworkCheck () {
     if (this.conversionInterval) {
       clearInterval(this.conversionInterval)
     }
     this.conversionInterval = setInterval(() => {
       this.checkInfuraNetworkStatus()
-      this.updateLocalBlacklist()
     }, POLLING_INTERVAL)
   }
 }

app/scripts/lib/inpage-provider.js

@@ -26,6 +26,9 @@ function MetamaskInpageProvider (connectionStream) {
     (err) => logStreamDisconnectWarning('MetaMask PublicConfigStore', err)
   )
 
+  // ignore phishing warning message (handled elsewhere)
+  multiStream.ignoreStream('phishing') 
+
   // connect to async provider
   const asyncProvider = self.asyncProvider = new StreamProvider()
   pipe(

app/scripts/lib/is-phish.js

@@ -1,38 +1,23 @@
 const levenshtein = require('fast-levenshtein')
-const blacklistedMetaMaskDomains = ['metamask.com']
-let blacklistedDomains = require('etheraddresslookup/blacklists/domains.json').concat(blacklistedMetaMaskDomains)
-const whitelistedMetaMaskDomains = ['metamask.io', 'www.metamask.io']
-const whitelistedDomains = require('etheraddresslookup/whitelists/domains.json').concat(whitelistedMetaMaskDomains)
 const LEVENSHTEIN_TOLERANCE = 4
-const LEVENSHTEIN_CHECKS = ['myetherwallet', 'myetheroll', 'ledgerwallet', 'metamask']
-
 
 // credit to @sogoiii and @409H for their help!
 // Return a boolean on whether or not a phish is detected.
-function isPhish({ hostname, updatedBlacklist = null }) {
+function isPhish({ hostname, blacklist, whitelist, fuzzylist }) {
-  var strCurrentTab = hostname
 
   // check if the domain is part of the whitelist.
-  if (whitelistedDomains && whitelistedDomains.includes(strCurrentTab)) { return false }
+  if (whitelist && whitelist.includes(hostname)) return false
-
-  // Allow updating of blacklist:
-  if (updatedBlacklist) {
-    blacklistedDomains = blacklistedDomains.concat(updatedBlacklist)
-  }
 
   // check if the domain is part of the blacklist.
-  const isBlacklisted = blacklistedDomains && blacklistedDomains.includes(strCurrentTab)
+  if (blacklist && blacklist.includes(hostname)) return true
 
   // check for similar values.
-  let levenshteinMatched = false
+  const levenshteinForm = hostname.replace(/\./g, '')
-  var levenshteinForm = strCurrentTab.replace(/\./g, '')
+  const levenshteinMatched = fuzzylist.some((element) => {
-  LEVENSHTEIN_CHECKS.forEach((element) => {
+    return levenshtein.get(element, levenshteinForm) <= LEVENSHTEIN_TOLERANCE
-    if (levenshtein.get(element, levenshteinForm) <= LEVENSHTEIN_TOLERANCE) {
-      levenshteinMatched = true
-    }
   })
 
-  return isBlacklisted || levenshteinMatched
+  return levenshteinMatched
 }
 
 module.exports = isPhish

app/scripts/lib/obj-multiplex.js

@@ -5,12 +5,16 @@ module.exports = ObjectMultiplex
 function ObjectMultiplex (opts) {
   opts = opts || {}
   // create multiplexer
-  var mx = through.obj(function (chunk, enc, cb) {
+  const mx = through.obj(function (chunk, enc, cb) {
-    var name = chunk.name
+    const name = chunk.name
-    var data = chunk.data
+    const data = chunk.data
-    var substream = mx.streams[name]
+    if (!name) {
+      console.warn(`ObjectMultiplex - Malformed chunk without name "${chunk}"`)
+      return cb()
+    }
+    const substream = mx.streams[name]
     if (!substream) {
-      console.warn(`orphaned data for stream "${name}"`)
+      console.warn(`ObjectMultiplex - orphaned data for stream "${name}"`)
     } else {
       if (substream.push) substream.push(data)
     }
@@ -19,7 +23,7 @@ function ObjectMultiplex (opts) {
   mx.streams = {}
   // create substreams
   mx.createStream = function (name) {
-    var substream = mx.streams[name] = through.obj(function (chunk, enc, cb) {
+    const substream = mx.streams[name] = through.obj(function (chunk, enc, cb) {
       mx.push({
         name: name,
         data: chunk,

app/scripts/metamask-controller.js

@@ -16,6 +16,7 @@ const NoticeController = require('./notice-controller')
 const ShapeShiftController = require('./controllers/shapeshift')
 const AddressBookController = require('./controllers/address-book')
 const InfuraController = require('./controllers/infura')
+const BlacklistController = require('./controllers/blacklist')
 const MessageManager = require('./lib/message-manager')
 const PersonalMessageManager = require('./lib/personal-message-manager')
 const TransactionController = require('./controllers/transactions')
@@ -69,6 +70,10 @@ module.exports = class MetamaskController extends EventEmitter {
     })
     this.infuraController.scheduleInfuraNetworkCheck()
 
+    this.blacklistController = new BlacklistController({
+      initState: initState.BlacklistController,
+    })
+    this.blacklistController.scheduleUpdates()
 
     // rpc provider
     this.provider = this.initializeProvider()
@@ -151,6 +156,9 @@ module.exports = class MetamaskController extends EventEmitter {
     this.networkController.store.subscribe((state) => {
       this.store.updateState({ NetworkController: state })
     })
+    this.blacklistController.store.subscribe((state) => {
+      this.store.updateState({ BlacklistController: state })
+    })
     this.infuraController.store.subscribe((state) => {
       this.store.updateState({ InfuraController: state })
     })
@@ -326,8 +334,15 @@ module.exports = class MetamaskController extends EventEmitter {
   }
 
   setupUntrustedCommunication (connectionStream, originDomain) {
+    // Check if new connection is blacklisted
+    if (this.blacklistController.checkForPhishing(originDomain)) {
+      console.log('MetaMask - sending phishing warning for', originDomain)
+      this.sendPhishingWarning(connectionStream, originDomain)
+      return
+    }
+
     // setup multiplexing
-    var mx = setupMultiplex(connectionStream)
+    const mx = setupMultiplex(connectionStream)
     // connect features
     this.setupProviderConnection(mx.createStream('provider'), originDomain)
     this.setupPublicConfig(mx.createStream('publicConfig'))
@@ -335,12 +350,18 @@ module.exports = class MetamaskController extends EventEmitter {
 
   setupTrustedCommunication (connectionStream, originDomain) {
     // setup multiplexing
-    var mx = setupMultiplex(connectionStream)
+    const mx = setupMultiplex(connectionStream)
     // connect features
     this.setupControllerConnection(mx.createStream('controller'))
     this.setupProviderConnection(mx.createStream('provider'), originDomain)
   }
 
+  sendPhishingWarning (connectionStream, hostname) {
+    const mx = setupMultiplex(connectionStream)
+    const phishingStream = mx.createStream('phishing')
+    phishingStream.write({ hostname })
+  }
+
   setupControllerConnection (outStream) {
     const api = this.getApi()
     const dnode = Dnode(api)

gulpfile.js

@@ -172,7 +172,6 @@ gulp.task('default', ['lint'], function () {
 const jsFiles = [
   'inpage',
   'contentscript',
-  'blacklister',
   'background',
   'popup',
 ]

package.json

@@ -126,7 +126,7 @@
     "sw-stream": "^2.0.0",
     "textarea-caret": "^3.0.1",
     "three.js": "^0.73.2",
-    "through2": "^2.0.1",
+    "through2": "^2.0.3",
     "valid-url": "^1.0.9",
     "vreme": "^3.0.2",
     "web3": "0.19.1",

test/unit/blacklist-controller-test.js

@@ -0,0 +1,41 @@
+const assert = require('assert')
+const BlacklistController = require('../../app/scripts/controllers/blacklist')
+
+describe('blacklist controller', function () {
+  let blacklistController
+
+  before(() => {
+    blacklistController = new BlacklistController()
+  })
+
+  describe('checkForPhishing', function () {
+    it('should not flag whitelisted values', function () {
+      const result = blacklistController.checkForPhishing('www.metamask.io')
+      assert.equal(result, false)
+    })
+    it('should flag explicit values', function () {
+      const result = blacklistController.checkForPhishing('metamask.com')
+      assert.equal(result, true)
+    })
+    it('should flag levenshtein values', function () {
+      const result = blacklistController.checkForPhishing('metmask.io')
+      assert.equal(result, true)
+    })
+    it('should not flag not-even-close values', function () {
+      const result = blacklistController.checkForPhishing('example.com')
+      assert.equal(result, false)
+    })
+    it('should not flag the ropsten faucet domains', function () {
+      const result = blacklistController.checkForPhishing('faucet.metamask.io')
+      assert.equal(result, false)
+    })
+    it('should not flag the mascara domain', function () {
+      const result = blacklistController.checkForPhishing('zero.metamask.io')
+      assert.equal(result, false)
+    })
+    it('should not flag the mascara-faucet domain', function () {
+      const result = blacklistController.checkForPhishing('zero-faucet.metamask.io')
+      assert.equal(result, false)
+    })
+  })
+})

test/unit/blacklister-test.js

@@ -1,24 +0,0 @@
-const assert = require('assert')
-const isPhish = require('../../app/scripts/lib/is-phish')
-
-describe('blacklister', function () {
-  describe('#isPhish', function () {
-    it('should not flag whitelisted values', function () {
-      var result = isPhish({ hostname: 'www.metamask.io' })
-      assert(!result)
-    })
-    it('should flag explicit values', function () {
-      var result = isPhish({ hostname: 'metamask.com' })
-      assert(result)
-    })
-    it('should flag levenshtein values', function () {
-      var result = isPhish({ hostname: 'metmask.com' })
-      assert(result)
-    })
-    it('should not flag not-even-close values', function () {
-      var result = isPhish({ hostname: 'example.com' })
-      assert(!result)
-    })
-  })
-})
-