server/lib/oauth-model.ts

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