metamask-extension/app/scripts/controllers/provider-approval.js

const ObservableStore = require('obs-store')
const SafeEventEmitter = require('safe-event-emitter')
const createAsyncMiddleware = require('json-rpc-engine/src/createAsyncMiddleware')

/**
 * A controller that services user-approved requests for a full Ethereum provider API
 */
class ProviderApprovalController extends SafeEventEmitter {
  /**
   * Determines if caching is enabled
   */
  caching = true

  /**
   * Creates a ProviderApprovalController
   *
   * @param {Object} [config] - Options to configure controller
   */
  constructor ({ closePopup, keyringController, openPopup, preferencesController } = {}) {
    super()
    this.closePopup = closePopup
    this.keyringController = keyringController
    this.openPopup = openPopup
    this.preferencesController = preferencesController
    this.store = new ObservableStore({
      approvedOrigins: {},
      dismissedOrigins: {},
      providerRequests: [],
    })
  }

  /**
   * Called when a user approves access to a full Ethereum provider API
   *
   * @param {object} opts - opts for the middleware contains the origin for the middleware
   */
  createMiddleware ({ origin, getSiteMetadata }) {
    return createAsyncMiddleware(async (req, res, next) => {
      // only handle requestAccounts
      if (req.method !== 'eth_requestAccounts') return next()
      // if already approved or privacy mode disabled, return early
      const isUnlocked = this.keyringController.memStore.getState().isUnlocked
      if (this.shouldExposeAccounts(origin) && isUnlocked) {
        res.result = [this.preferencesController.getSelectedAddress()]
        return
      }
      // register the provider request
      const metadata = await getSiteMetadata(origin)
      this._handleProviderRequest(origin, metadata.name, metadata.icon)
      // wait for resolution of request
      const approved = await new Promise(resolve => this.once(`resolvedRequest:${origin}`, ({ approved }) => resolve(approved)))
      if (approved) {
        res.result = [this.preferencesController.getSelectedAddress()]
      } else {
        throw new Error('User denied account authorization')
      }
    })
  }

  /**
   * Called when a tab requests access to a full Ethereum provider API
   *
   * @param {string} origin - Origin of the window requesting full provider access
   * @param {string} siteTitle - The title of the document requesting full provider access
   * @param {string} siteImage - The icon of the window requesting full provider access
   */
  _handleProviderRequest (origin, siteTitle, siteImage) {
    this.store.updateState({ providerRequests: [{ origin, siteTitle, siteImage }] })
    const isUnlocked = this.keyringController.memStore.getState().isUnlocked
    const { approvedOrigins, dismissedOrigins } = this.store.getState()
    const originAlreadyHandled = approvedOrigins[origin] || dismissedOrigins[origin]
    if (originAlreadyHandled && this.caching && isUnlocked) {
      return
    }
    this.openPopup && this.openPopup()
  }

  /**
   * Called when a user approves access to a full Ethereum provider API
   *
   * @param {string} origin - origin of the domain that had provider access approved
   */
  approveProviderRequestByOrigin (origin) {
    if (this.closePopup) {
      this.closePopup()
    }

    const { approvedOrigins, dismissedOrigins, providerRequests } = this.store.getState()

    let _dismissedOrigins = dismissedOrigins
    if (dismissedOrigins[origin]) {
      _dismissedOrigins = Object.assign({}, dismissedOrigins)
      delete _dismissedOrigins[origin]
    }

    const remainingProviderRequests = providerRequests.filter(request => request.origin !== origin)
    this.store.updateState({
      approvedOrigins: {
        ...approvedOrigins,
        [origin]: true,
      },
      dismissedOrigins: _dismissedOrigins,
      providerRequests: remainingProviderRequests,
    })
    this.emit(`resolvedRequest:${origin}`, { approved: true })
  }

  /**
   * Called when a tab rejects access to a full Ethereum provider API
   *
   * @param {string} origin - origin of the domain that had provider access approved
   */
  rejectProviderRequestByOrigin (origin) {
    if (this.closePopup) {
      this.closePopup()
    }

    const { approvedOrigins, providerRequests, dismissedOrigins } = this.store.getState()
    const remainingProviderRequests = providerRequests.filter(request => request.origin !== origin)

    // We're cloning and deleting keys here because we don't want to keep unneeded keys
    const _approvedOrigins = Object.assign({}, approvedOrigins)
    delete _approvedOrigins[origin]

    this.store.putState({
      approvedOrigins: _approvedOrigins,
      providerRequests: remainingProviderRequests,
      dismissedOrigins: {
        ...dismissedOrigins,
        [origin]: true,
      },
    })
    this.emit(`resolvedRequest:${origin}`, { approved: false })
  }

  /**
   * Silently approves access to a full Ethereum provider API for the origin
   *
   * @param {string} origin - origin of the domain that had provider access approved
   */
  forceApproveProviderRequestByOrigin (origin) {
    const { approvedOrigins, dismissedOrigins, providerRequests } = this.store.getState()
    const remainingProviderRequests = providerRequests.filter(request => request.origin !== origin)

    let _dismissedOrigins = dismissedOrigins
    if (dismissedOrigins[origin]) {
      _dismissedOrigins = Object.assign({}, dismissedOrigins)
      delete _dismissedOrigins[origin]
    }

    this.store.updateState({
      approvedOrigins: {
        ...approvedOrigins,
        [origin]: true,
      },
      dismissedOrigins: _dismissedOrigins,
      providerRequests: remainingProviderRequests,
    })
  }

  /**
   * Clears any cached approvals for user-approved origins
   */
  clearApprovedOrigins () {
    this.store.updateState({
      approvedOrigins: {},
    })
  }

  /**
   * Determines if a given origin should have accounts exposed
   *
   * @param {string} origin - Domain origin to check for approval status
   * @returns {boolean} - True if the origin has been approved
   */
  shouldExposeAccounts (origin) {
    const privacyMode = this.preferencesController.getFeatureFlags().privacyMode
    return !privacyMode || Boolean(this.store.getState().approvedOrigins[origin])
  }

}

module.exports = ProviderApprovalController