server/middlewares/oauth.ts

   1 import * as express from 'express'
   2 import { Socket } from 'socket.io'
   3 import { oAuthServer } from '@server/lib/auth'
   4 import { logger } from '../helpers/logger'
   5 import { getAccessToken } from '../lib/oauth-model'
   6 import { HttpStatusCode } from '../../shared/core-utils/miscs/http-error-codes'
   7
   8 function authenticate (req: express.Request, res: express.Response, next: express.NextFunction, authenticateInQuery = false) {
   9   const options = authenticateInQuery ? { allowBearerTokensInQueryString: true } : {}
  10
  11   oAuthServer.authenticate(options)(req, res, err => {
  12     if (err) {
  13       logger.warn('Cannot authenticate.', { err })
  14
  15       return res.status(err.status)
  16         .json({
  17           error: 'Token is invalid.',
  18           code: err.name
  19         })
  20         .end()
  21     }
  22
  23     return next()
  24   })
  25 }
  26
  27 function authenticateSocket (socket: Socket, next: (err?: any) => void) {
  28   const accessToken = socket.handshake.query['accessToken']
  29
  30   logger.debug('Checking socket access token %s.', accessToken)
  31
  32   if (!accessToken) return next(new Error('No access token provided'))
  33
  34   getAccessToken(accessToken)
  35     .then(tokenDB => {
  36       const now = new Date()
  37
  38       if (!tokenDB || tokenDB.accessTokenExpiresAt < now || tokenDB.refreshTokenExpiresAt < now) {
  39         return next(new Error('Invalid access token.'))
  40       }
  41
  42       socket.handshake.query['user'] = tokenDB.User
  43
  44       return next()
  45     })
  46     .catch(err => logger.error('Cannot get access token.', { err }))
  47 }
  48
  49 function authenticatePromiseIfNeeded (req: express.Request, res: express.Response, authenticateInQuery = false) {
  50   return new Promise(resolve => {
  51     // Already authenticated? (or tried to)
  52     if (res.locals.oauth?.token.User) return resolve()
  53
  54     if (res.locals.authenticated === false) return res.sendStatus(HttpStatusCode.UNAUTHORIZED_401)
  55
  56     authenticate(req, res, () => resolve(), authenticateInQuery)
  57   })
  58 }
  59
  60 function optionalAuthenticate (req: express.Request, res: express.Response, next: express.NextFunction) {
  61   if (req.header('authorization')) return authenticate(req, res, next)
  62
  63   res.locals.authenticated = false
  64
  65   return next()
  66 }
  67
  68 // ---------------------------------------------------------------------------
  69
  70 export {
  71   authenticate,
  72   authenticateSocket,
  73   authenticatePromiseIfNeeded,
  74   optionalAuthenticate
  75 }