1 import * as express from 'express'
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 { LRU_CACHE } from '../initializers/constants'
8 import { Transaction } from 'sequelize'
9 import { CONFIG } from '../initializers/config'
10 import * as LRUCache from 'lru-cache'
11 import { MOAuthTokenUser } from '@server/typings/models/oauth/oauth-token'
12 import { MUser } from '@server/typings/models/user/user'
13 import { UserAdminFlag } from '@shared/models/users/user-flag.model'
14 import { createUserAccountAndChannelAndPlaylist } from './user'
15 import { UserRole } from '@shared/models/users/user-role'
16 import { PluginManager } from '@server/lib/plugins/plugin-manager'
18 type TokenInfo = { accessToken: string, refreshToken: string, accessTokenExpiresAt: Date, refreshTokenExpiresAt: Date }
20 const accessTokenCache = new LRUCache<string, MOAuthTokenUser>({ max: LRU_CACHE.USER_TOKENS.MAX_SIZE })
21 const userHavingToken = new LRUCache<number, string>({ max: LRU_CACHE.USER_TOKENS.MAX_SIZE })
23 // ---------------------------------------------------------------------------
25 function deleteUserToken (userId: number, t?: Transaction) {
26 clearCacheByUserId(userId)
28 return OAuthTokenModel.deleteUserToken(userId, t)
31 function clearCacheByUserId (userId: number) {
32 const token = userHavingToken.get(userId)
34 if (token !== undefined) {
35 accessTokenCache.del(token)
36 userHavingToken.del(userId)
40 function clearCacheByToken (token: string) {
41 const tokenModel = accessTokenCache.get(token)
43 if (tokenModel !== undefined) {
44 userHavingToken.del(tokenModel.userId)
45 accessTokenCache.del(token)
49 async function getAccessToken (bearerToken: string) {
50 logger.debug('Getting access token (bearerToken: ' + bearerToken + ').')
52 if (!bearerToken) return undefined
54 let tokenModel: MOAuthTokenUser
56 if (accessTokenCache.has(bearerToken)) {
57 tokenModel = accessTokenCache.get(bearerToken)
59 tokenModel = await OAuthTokenModel.getByTokenAndPopulateUser(bearerToken)
62 accessTokenCache.set(bearerToken, tokenModel)
63 userHavingToken.set(tokenModel.userId, tokenModel.accessToken)
67 if (!tokenModel) return undefined
69 if (tokenModel.User.pluginAuth) {
70 const valid = await PluginManager.Instance.isTokenValid(tokenModel, 'access')
72 if (valid !== true) return undefined
78 function getClient (clientId: string, clientSecret: string) {
79 logger.debug('Getting Client (clientId: ' + clientId + ', clientSecret: ' + clientSecret + ').')
81 return OAuthClientModel.getByIdAndSecret(clientId, clientSecret)
84 async function getRefreshToken (refreshToken: string) {
85 logger.debug('Getting RefreshToken (refreshToken: ' + refreshToken + ').')
87 const tokenInfo = await OAuthTokenModel.getByRefreshTokenAndPopulateClient(refreshToken)
88 if (!tokenInfo) return undefined
90 const tokenModel = tokenInfo.token
92 if (tokenModel.User.pluginAuth) {
93 const valid = await PluginManager.Instance.isTokenValid(tokenModel, 'refresh')
95 if (valid !== true) return undefined
101 async function getUser (usernameOrEmail?: string, password?: string) {
102 const res: express.Response = this.request.res
104 // Special treatment coming from a plugin
105 if (res.locals.bypassLogin && res.locals.bypassLogin.bypass === true) {
106 const obj = res.locals.bypassLogin
107 logger.info('Bypassing oauth login by plugin %s.', obj.pluginName)
109 let user = await UserModel.loadByEmail(obj.user.email)
110 if (!user) user = await createUserFromExternal(obj.pluginName, obj.user)
112 // If the user does not belongs to a plugin, it was created before its installation
113 // Then we just go through a regular login process
114 if (user.pluginAuth !== null) {
115 // This user does not belong to this plugin, skip it
116 if (user.pluginAuth !== obj.pluginName) return null
122 logger.debug('Getting User (username/email: ' + usernameOrEmail + ', password: ******).')
124 const user = await UserModel.loadByUsernameOrEmail(usernameOrEmail)
125 // If we don't find the user, or if the user belongs to a plugin
126 if (!user || user.pluginAuth !== null) return null
128 const passwordMatch = await user.isPasswordMatch(password)
129 if (passwordMatch !== true) return null
131 if (user.blocked) throw new AccessDeniedError('User is blocked.')
133 if (CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION && user.emailVerified === false) {
134 throw new AccessDeniedError('User email is not verified.')
140 async function revokeToken (tokenInfo: { refreshToken: string }) {
141 const res: express.Response = this.request.res
142 const token = await OAuthTokenModel.getByRefreshTokenAndPopulateUser(tokenInfo.refreshToken)
145 if (res.locals.explicitLogout === true && token.User.pluginAuth && token.authName) {
146 PluginManager.Instance.onLogout(token.User.pluginAuth, token.authName, token.User)
149 clearCacheByToken(token.accessToken)
152 .catch(err => logger.error('Cannot destroy token when revoking token.', { err }))
160 async function saveToken (token: TokenInfo, client: OAuthClientModel, user: UserModel) {
161 const res: express.Response = this.request.res
163 let authName: string = null
164 if (res.locals.bypassLogin?.bypass === true) {
165 authName = res.locals.bypassLogin.authName
166 } else if (res.locals.refreshTokenAuthName) {
167 authName = res.locals.refreshTokenAuthName
170 logger.debug('Saving token ' + token.accessToken + ' for client ' + client.id + ' and user ' + user.id + '.')
172 const tokenToCreate = {
173 accessToken: token.accessToken,
174 accessTokenExpiresAt: token.accessTokenExpiresAt,
175 refreshToken: token.refreshToken,
176 refreshTokenExpiresAt: token.refreshTokenExpiresAt,
178 oAuthClientId: client.id,
182 const tokenCreated = await OAuthTokenModel.create(tokenToCreate)
184 user.lastLoginDate = new Date()
187 return Object.assign(tokenCreated, { client, user })
190 // ---------------------------------------------------------------------------
192 // See https://github.com/oauthjs/node-oauth2-server/wiki/Model-specification for the model specifications
205 async function createUserFromExternal (pluginAuth: string, options: {
211 const userToCreate = new UserModel({
212 username: options.username,
214 email: options.email,
215 nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
218 videoQuota: CONFIG.USER.VIDEO_QUOTA,
219 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY,
220 adminFlags: UserAdminFlag.NONE,
224 const { user } = await createUserAccountAndChannelAndPlaylist({
226 userDisplayName: options.displayName