server/lib/oauth-model.ts

   1 import { AccessDeniedError } from 'oauth2-server'
   2 import { logger } from '../helpers/logger'
   3 import { UserModel } from '../models/account/user'
   4 import { OAuthClientModel } from '../models/oauth/oauth-client'
   5 import { OAuthTokenModel } from '../models/oauth/oauth-token'
   6 import { CONFIG } from '../initializers/constants'
   7 import { Transaction } from 'sequelize'
   8
   9 type TokenInfo = { accessToken: string, refreshToken: string, accessTokenExpiresAt: Date, refreshTokenExpiresAt: Date }
  10 const accessTokenCache: { [ accessToken: string ]: OAuthTokenModel } = {}
  11 const userHavingToken: { [ userId: number ]: string } = {}
  12
  13 // ---------------------------------------------------------------------------
  14
  15 function deleteUserToken (userId: number, t?: Transaction) {
  16   clearCacheByUserId(userId)
  17
  18   return OAuthTokenModel.deleteUserToken(userId, t)
  19 }
  20
  21 function clearCacheByUserId (userId: number) {
  22   const token = userHavingToken[userId]
  23   if (token !== undefined) {
  24     accessTokenCache[ token ] = undefined
  25     userHavingToken[ userId ] = undefined
  26   }
  27 }
  28
  29 function clearCacheByToken (token: string) {
  30   const tokenModel = accessTokenCache[ token ]
  31   if (tokenModel !== undefined) {
  32     userHavingToken[tokenModel.userId] = undefined
  33     accessTokenCache[ token ] = undefined
  34   }
  35 }
  36
  37 function getAccessToken (bearerToken: string) {
  38   logger.debug('Getting access token (bearerToken: ' + bearerToken + ').')
  39
  40   if (accessTokenCache[bearerToken] !== undefined) return accessTokenCache[bearerToken]
  41
  42   return OAuthTokenModel.getByTokenAndPopulateUser(bearerToken)
  43     .then(tokenModel => {
  44       if (tokenModel) {
  45         accessTokenCache[ bearerToken ] = tokenModel
  46         userHavingToken[ tokenModel.userId ] = tokenModel.accessToken
  47       }
  48
  49       return tokenModel
  50     })
  51 }
  52
  53 function getClient (clientId: string, clientSecret: string) {
  54   logger.debug('Getting Client (clientId: ' + clientId + ', clientSecret: ' + clientSecret + ').')
  55
  56   return OAuthClientModel.getByIdAndSecret(clientId, clientSecret)
  57 }
  58
  59 function getRefreshToken (refreshToken: string) {
  60   logger.debug('Getting RefreshToken (refreshToken: ' + refreshToken + ').')
  61
  62   return OAuthTokenModel.getByRefreshTokenAndPopulateClient(refreshToken)
  63 }
  64
  65 async function getUser (usernameOrEmail: string, password: string) {
  66   logger.debug('Getting User (username/email: ' + usernameOrEmail + ', password: ******).')
  67
  68   const user = await UserModel.loadByUsernameOrEmail(usernameOrEmail)
  69   if (!user) return null
  70
  71   const passwordMatch = await user.isPasswordMatch(password)
  72   if (passwordMatch === false) return null
  73
  74   if (user.blocked) throw new AccessDeniedError('User is blocked.')
  75
  76   if (CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION && user.emailVerified === false) {
  77     throw new AccessDeniedError('User email is not verified.')
  78   }
  79
  80   return user
  81 }
  82
  83 async function revokeToken (tokenInfo: TokenInfo) {
  84   const token = await OAuthTokenModel.getByRefreshTokenAndPopulateUser(tokenInfo.refreshToken)
  85   if (token) {
  86     clearCacheByToken(token.accessToken)
  87
  88     token.destroy()
  89          .catch(err => logger.error('Cannot destroy token when revoking token.', { err }))
  90   }
  91
  92   /*
  93     * Thanks to https://github.com/manjeshpv/node-oauth2-server-implementation/blob/master/components/oauth/mongo-models.js
  94     * "As per the discussion we need set older date
  95     * revokeToken will expected return a boolean in future version
  96     * https://github.com/oauthjs/node-oauth2-server/pull/274
  97     * https://github.com/oauthjs/node-oauth2-server/issues/290"
  98   */
  99   const expiredToken = token
 100   expiredToken.refreshTokenExpiresAt = new Date('2015-05-28T06:59:53.000Z')
 101
 102   return expiredToken
 103 }
 104
 105 async function saveToken (token: TokenInfo, client: OAuthClientModel, user: UserModel) {
 106   logger.debug('Saving token ' + token.accessToken + ' for client ' + client.id + ' and user ' + user.id + '.')
 107
 108   const tokenToCreate = {
 109     accessToken: token.accessToken,
 110     accessTokenExpiresAt: token.accessTokenExpiresAt,
 111     refreshToken: token.refreshToken,
 112     refreshTokenExpiresAt: token.refreshTokenExpiresAt,
 113     oAuthClientId: client.id,
 114     userId: user.id
 115   }
 116
 117   const tokenCreated = await OAuthTokenModel.create(tokenToCreate)
 118   return Object.assign(tokenCreated, { client, user })
 119 }
 120
 121 // ---------------------------------------------------------------------------
 122
 123 // See https://github.com/oauthjs/node-oauth2-server/wiki/Model-specification for the model specifications
 124 export {
 125   deleteUserToken,
 126   clearCacheByUserId,
 127   clearCacheByToken,
 128   getAccessToken,
 129   getClient,
 130   getRefreshToken,
 131   getUser,
 132   revokeToken,
 133   saveToken
 134 }