]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/lib/oauth-model.ts
Support logout and add id and pass tests
[github/Chocobozzz/PeerTube.git] / server / lib / oauth-model.ts
index f13c25795b841200f67c5630a795be8f7f5cc5be..7a6ed63be3477d78aaefeef7b74995dc268f48a0 100644 (file)
@@ -1,17 +1,68 @@
-import { AccessDeniedError} from 'oauth2-server'
+import * as Bluebird from 'bluebird'
+import * as express from 'express'
+import { AccessDeniedError } from 'oauth2-server'
 import { logger } from '../helpers/logger'
 import { UserModel } from '../models/account/user'
 import { OAuthClientModel } from '../models/oauth/oauth-client'
 import { OAuthTokenModel } from '../models/oauth/oauth-token'
+import { LRU_CACHE } from '../initializers/constants'
+import { Transaction } from 'sequelize'
+import { CONFIG } from '../initializers/config'
+import * as LRUCache from 'lru-cache'
+import { MOAuthTokenUser } from '@server/typings/models/oauth/oauth-token'
+import { MUser } from '@server/typings/models/user/user'
+import { UserAdminFlag } from '@shared/models/users/user-flag.model'
+import { createUserAccountAndChannelAndPlaylist } from './user'
+import { UserRole } from '@shared/models/users/user-role'
+import { PluginManager } from '@server/lib/plugins/plugin-manager'
 
 type TokenInfo = { accessToken: string, refreshToken: string, accessTokenExpiresAt: Date, refreshTokenExpiresAt: Date }
 
+const accessTokenCache = new LRUCache<string, MOAuthTokenUser>({ max: LRU_CACHE.USER_TOKENS.MAX_SIZE })
+const userHavingToken = new LRUCache<number, string>({ max: LRU_CACHE.USER_TOKENS.MAX_SIZE })
+
 // ---------------------------------------------------------------------------
 
+function deleteUserToken (userId: number, t?: Transaction) {
+  clearCacheByUserId(userId)
+
+  return OAuthTokenModel.deleteUserToken(userId, t)
+}
+
+function clearCacheByUserId (userId: number) {
+  const token = userHavingToken.get(userId)
+
+  if (token !== undefined) {
+    accessTokenCache.del(token)
+    userHavingToken.del(userId)
+  }
+}
+
+function clearCacheByToken (token: string) {
+  const tokenModel = accessTokenCache.get(token)
+
+  if (tokenModel !== undefined) {
+    userHavingToken.del(tokenModel.userId)
+    accessTokenCache.del(token)
+  }
+}
+
 function getAccessToken (bearerToken: string) {
   logger.debug('Getting access token (bearerToken: ' + bearerToken + ').')
 
+  if (!bearerToken) return Bluebird.resolve(undefined)
+
+  if (accessTokenCache.has(bearerToken)) return Bluebird.resolve(accessTokenCache.get(bearerToken))
+
   return OAuthTokenModel.getByTokenAndPopulateUser(bearerToken)
+                        .then(tokenModel => {
+                          if (tokenModel) {
+                            accessTokenCache.set(bearerToken, tokenModel)
+                            userHavingToken.set(tokenModel.userId, tokenModel.accessToken)
+                          }
+
+                          return tokenModel
+                        })
 }
 
 function getClient (clientId: string, clientSecret: string) {
@@ -27,37 +78,65 @@ function getRefreshToken (refreshToken: string) {
 }
 
 async function getUser (usernameOrEmail: string, password: string) {
+  const res: express.Response = this.request.res
+  if (res.locals.bypassLogin && res.locals.bypassLogin.bypass === true) {
+    const obj = res.locals.bypassLogin
+    logger.info('Bypassing oauth login by plugin %s.', obj.pluginName)
+
+    let user = await UserModel.loadByEmail(obj.user.email)
+    if (!user) user = await createUserFromExternal(obj.pluginName, obj.user)
+
+    // This user does not belong to this plugin, skip it
+    if (user.pluginAuth !== obj.pluginName) return null
+
+    return user
+  }
+
   logger.debug('Getting User (username/email: ' + usernameOrEmail + ', password: ******).')
 
   const user = await UserModel.loadByUsernameOrEmail(usernameOrEmail)
-  if (!user) return null
+  // If we don't find the user, or if the user belongs to a plugin
+  if (!user || user.pluginAuth !== null) return null
 
   const passwordMatch = await user.isPasswordMatch(password)
   if (passwordMatch === false) return null
 
   if (user.blocked) throw new AccessDeniedError('User is blocked.')
 
+  if (CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION && user.emailVerified === false) {
+    throw new AccessDeniedError('User email is not verified.')
+  }
+
   return user
 }
 
 async function revokeToken (tokenInfo: TokenInfo) {
+  const res: express.Response = this.request.res
   const token = await OAuthTokenModel.getByRefreshTokenAndPopulateUser(tokenInfo.refreshToken)
-  if (token) token.destroy()
-
-  /*
-    * Thanks to https://github.com/manjeshpv/node-oauth2-server-implementation/blob/master/components/oauth/mongo-models.js
-    * "As per the discussion we need set older date
-    * revokeToken will expected return a boolean in future version
-    * https://github.com/oauthjs/node-oauth2-server/pull/274
-    * https://github.com/oauthjs/node-oauth2-server/issues/290"
-  */
-  const expiredToken = token
-  expiredToken.refreshTokenExpiresAt = new Date('2015-05-28T06:59:53.000Z')
-
-  return expiredToken
+
+  if (token) {
+    if (res.locals.explicitLogout === true && token.User.pluginAuth && token.authName) {
+      PluginManager.Instance.onLogout(token.User.pluginAuth, token.authName)
+    }
+
+    clearCacheByToken(token.accessToken)
+
+    token.destroy()
+         .catch(err => logger.error('Cannot destroy token when revoking token.', { err }))
+
+    return true
+  }
+
+  return false
 }
 
 async function saveToken (token: TokenInfo, client: OAuthClientModel, user: UserModel) {
+  const res: express.Response = this.request.res
+
+  const authName = res.locals.bypassLogin?.bypass === true
+    ? res.locals.bypassLogin.authName
+    : null
+
   logger.debug('Saving token ' + token.accessToken + ' for client ' + client.id + ' and user ' + user.id + '.')
 
   const tokenToCreate = {
@@ -65,6 +144,7 @@ async function saveToken (token: TokenInfo, client: OAuthClientModel, user: User
     accessTokenExpiresAt: token.accessTokenExpiresAt,
     refreshToken: token.refreshToken,
     refreshTokenExpiresAt: token.refreshTokenExpiresAt,
+    authName,
     oAuthClientId: client.id,
     userId: user.id
   }
@@ -77,6 +157,9 @@ async function saveToken (token: TokenInfo, client: OAuthClientModel, user: User
 
 // See https://github.com/oauthjs/node-oauth2-server/wiki/Model-specification for the model specifications
 export {
+  deleteUserToken,
+  clearCacheByUserId,
+  clearCacheByToken,
   getAccessToken,
   getClient,
   getRefreshToken,
@@ -84,3 +167,30 @@ export {
   revokeToken,
   saveToken
 }
+
+async function createUserFromExternal (pluginAuth: string, options: {
+  username: string
+  email: string
+  role: UserRole
+  displayName: string
+}) {
+  const userToCreate = new UserModel({
+    username: options.username,
+    password: null,
+    email: options.email,
+    nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
+    autoPlayVideo: true,
+    role: options.role,
+    videoQuota: CONFIG.USER.VIDEO_QUOTA,
+    videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY,
+    adminFlags: UserAdminFlag.NONE,
+    pluginAuth
+  }) as MUser
+
+  const { user } = await createUserAccountAndChannelAndPlaylist({
+    userToCreate,
+    userDisplayName: options.displayName
+  })
+
+  return user
+}