Overleaf/services/web/app/src/Features/Authorization/PermissionsController.mjs

// @ts-check
import { ForbiddenError, UserNotFoundError } from '../Errors/Errors.js'
import PermissionsManager from './PermissionsManager.mjs'
import Modules from '../../infrastructure/Modules.mjs'
import { expressify } from '@overleaf/promise-utils'
import Features from '../../infrastructure/Features.mjs'

/**
 * @typedef {(import('express').Request)} Request
 * @typedef {(import('express').Response)} Response
 * @typedef {(import('express').NextFunction)} NextFunction
 * @typedef {import('./PermissionsManager.mjs').Capability} Capability
 */

const {
  getUserCapabilities,
  getUserRestrictions,
  combineGroupPolicies,
  combineAllowedProperties,
  promises: { assertUserPermissions },
} = PermissionsManager

/**
 * Function that returns middleware to add an `assertPermission` function to the request object to check if the user has a specific capability.
 * @returns {() => (req: Request, res: Response, next: NextFunction) => void} The middleware function that adds the `assertPermission` function to the request object.
 */
function useCapabilities() {
  /**
   * @param {any} req
   * @param {any} res
   * @param {any} next
   */
  const middleware = async function (req, res, next) {
    // attach the user's capabilities to the request object
    req.capabilitySet = new Set()
    // provide a function to assert that a capability is present
    /** @param {any} capability */
    req.assertPermission = capability => {
      if (!req.capabilitySet.has(capability)) {
        throw new ForbiddenError(
          `user does not have permission for ${capability}`
        )
      }
    }
    if (!req.user) {
      return next()
    }
    try {
      /**
       * @type {{groupPolicy: Record<string, boolean>}[][]}
       */
      const hookResponses = await Modules.promises.hooks.fire(
        'getGroupPolicyForUser',
        req.user
      )
      // merge array of all results from all modules
      const results = hookResponses.flat()

      if (results.length > 0) {
        // get the combined group policy applying to the user
        const groupPolicies = results.map(
          /** @param {any} result */ result => result.groupPolicy
        )
        const combinedGroupPolicy = combineGroupPolicies(groupPolicies)
        // attach the new capabilities to the request object
        for (const cap of getUserCapabilities(combinedGroupPolicy)) {
          req.capabilitySet.add(cap)
        }
        // also attach the user's restrictions (the capabilities they don't have)
        req.userRestrictions = getUserRestrictions(combinedGroupPolicy)

        // attach allowed properties to the request object
        const allowedProperties = combineAllowedProperties(results)
        for (const [prop, value] of Object.entries(allowedProperties)) {
          req[prop] = value
        }
      }
      next()
    } catch (/** @type {any} */ error) {
      if (error instanceof UserNotFoundError) {
        // the user is logged in but doesn't exist in the database
        // this can happen if the user has just deleted their account
        return next()
      } else {
        next(error)
      }
    }
  }
  return expressify(middleware)
}

/**
 * Function that returns middleware to check if the user has permission to access a resource.
 * @param {...Capability} requiredCapabilities - the capabilities required to access the resource.
 * @returns {(req: Request, res: Response, next: NextFunction) => void} The middleware function that checks if the user has the required capabilities.
 */
function requirePermission(...requiredCapabilities) {
  if (
    requiredCapabilities.length === 0 ||
    requiredCapabilities.some(
      /** @param {any} capability */ capability =>
        typeof capability !== 'string'
    )
  ) {
    throw new Error('invalid required capabilities')
  }
  /**
   * @param {Request} req
   * @param {Response} res
   * @param {NextFunction} next
   */
  const doRequest = async function (req, res, next) {
    if (!Features.hasFeature('saas')) {
      return next()
    }
    const user = req.user || req.oauth_user
    if (!user) {
      return next(new Error('no user'))
    }
    try {
      await assertUserPermissions(user, requiredCapabilities)
      next()
    } catch (/** @type {any} */ error) {
      next(error)
    }
  }
  return doRequest
}

export default {
  requirePermission,
  useCapabilities,
}