1 import { AccessDeniedError } from 'oauth2-server'
2 import { PluginManager } from '@server/lib/plugins/plugin-manager'
3 import { ActorModel } from '@server/models/activitypub/actor'
4 import { MOAuthClient } from '@server/types/models'
5 import { MOAuthTokenUser } from '@server/types/models/oauth/oauth-token'
6 import { MUser } from '@server/types/models/user/user'
7 import { UserAdminFlag } from '@shared/models/users/user-flag.model'
8 import { UserRole } from '@shared/models/users/user-role'
9 import { logger } from '../../helpers/logger'
10 import { CONFIG } from '../../initializers/config'
11 import { UserModel } from '../../models/account/user'
12 import { OAuthClientModel } from '../../models/oauth/oauth-client'
13 import { OAuthTokenModel } from '../../models/oauth/oauth-token'
14 import { createUserAccountAndChannelAndPlaylist } from '../user'
15 import { TokensCache } from './tokens-cache'
20 accessTokenExpiresAt: Date
21 refreshTokenExpiresAt: Date
24 export type BypassLogin = {
36 async function getAccessToken (bearerToken: string) {
37 logger.debug('Getting access token (bearerToken: ' + bearerToken + ').')
39 if (!bearerToken) return undefined
41 let tokenModel: MOAuthTokenUser
43 if (TokensCache.Instance.hasToken(bearerToken)) {
44 tokenModel = TokensCache.Instance.getByToken(bearerToken)
46 tokenModel = await OAuthTokenModel.getByTokenAndPopulateUser(bearerToken)
48 if (tokenModel) TokensCache.Instance.setToken(tokenModel)
51 if (!tokenModel) return undefined
53 if (tokenModel.User.pluginAuth) {
54 const valid = await PluginManager.Instance.isTokenValid(tokenModel, 'access')
56 if (valid !== true) return undefined
62 function getClient (clientId: string, clientSecret: string) {
63 logger.debug('Getting Client (clientId: ' + clientId + ', clientSecret: ' + clientSecret + ').')
65 return OAuthClientModel.getByIdAndSecret(clientId, clientSecret)
68 async function getRefreshToken (refreshToken: string) {
69 logger.debug('Getting RefreshToken (refreshToken: ' + refreshToken + ').')
71 const tokenInfo = await OAuthTokenModel.getByRefreshTokenAndPopulateClient(refreshToken)
72 if (!tokenInfo) return undefined
74 const tokenModel = tokenInfo.token
76 if (tokenModel.User.pluginAuth) {
77 const valid = await PluginManager.Instance.isTokenValid(tokenModel, 'refresh')
79 if (valid !== true) return undefined
85 async function getUser (usernameOrEmail?: string, password?: string, bypassLogin?: BypassLogin) {
86 // Special treatment coming from a plugin
87 if (bypassLogin && bypassLogin.bypass === true) {
88 logger.info('Bypassing oauth login by plugin %s.', bypassLogin.pluginName)
90 let user = await UserModel.loadByEmail(bypassLogin.user.email)
91 if (!user) user = await createUserFromExternal(bypassLogin.pluginName, bypassLogin.user)
93 // Cannot create a user
94 if (!user) throw new AccessDeniedError('Cannot create such user: an actor with that name already exists.')
96 // If the user does not belongs to a plugin, it was created before its installation
97 // Then we just go through a regular login process
98 if (user.pluginAuth !== null) {
99 // This user does not belong to this plugin, skip it
100 if (user.pluginAuth !== bypassLogin.pluginName) return null
102 checkUserValidityOrThrow(user)
108 logger.debug('Getting User (username/email: ' + usernameOrEmail + ', password: ******).')
110 const user = await UserModel.loadByUsernameOrEmail(usernameOrEmail)
111 // If we don't find the user, or if the user belongs to a plugin
112 if (!user || user.pluginAuth !== null || !password) return null
114 const passwordMatch = await user.isPasswordMatch(password)
115 if (passwordMatch !== true) return null
117 checkUserValidityOrThrow(user)
119 if (CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION && user.emailVerified === false) {
120 throw new AccessDeniedError('User email is not verified.')
126 async function revokeToken (
127 tokenInfo: { refreshToken: string },
128 explicitLogout?: boolean
129 ): Promise<{ success: boolean, redirectUrl?: string }> {
130 const token = await OAuthTokenModel.getByRefreshTokenAndPopulateUser(tokenInfo.refreshToken)
133 let redirectUrl: string
135 if (explicitLogout === true && token.User.pluginAuth && token.authName) {
136 redirectUrl = await PluginManager.Instance.onLogout(token.User.pluginAuth, token.authName, token.User, this.request)
139 TokensCache.Instance.clearCacheByToken(token.accessToken)
142 .catch(err => logger.error('Cannot destroy token when revoking token.', { err }))
144 return { success: true, redirectUrl }
147 return { success: false }
150 async function saveToken (
152 client: MOAuthClient,
155 refreshTokenAuthName?: string
156 bypassLogin?: BypassLogin
159 const { refreshTokenAuthName, bypassLogin } = options
160 let authName: string = null
162 if (bypassLogin?.bypass === true) {
163 authName = bypassLogin.authName
164 } else if (refreshTokenAuthName) {
165 authName = refreshTokenAuthName
168 logger.debug('Saving token ' + token.accessToken + ' for client ' + client.id + ' and user ' + user.id + '.')
170 const tokenToCreate = {
171 accessToken: token.accessToken,
172 accessTokenExpiresAt: token.accessTokenExpiresAt,
173 refreshToken: token.refreshToken,
174 refreshTokenExpiresAt: token.refreshTokenExpiresAt,
176 oAuthClientId: client.id,
180 const tokenCreated = await OAuthTokenModel.create(tokenToCreate)
182 user.lastLoginDate = new Date()
186 accessToken: tokenCreated.accessToken,
187 accessTokenExpiresAt: tokenCreated.accessTokenExpiresAt,
188 refreshToken: tokenCreated.refreshToken,
189 refreshTokenExpiresAt: tokenCreated.refreshTokenExpiresAt,
192 accessTokenExpiresIn: buildExpiresIn(tokenCreated.accessTokenExpiresAt),
193 refreshTokenExpiresIn: buildExpiresIn(tokenCreated.refreshTokenExpiresAt)
206 // ---------------------------------------------------------------------------
208 async function createUserFromExternal (pluginAuth: string, options: {
214 // Check an actor does not already exists with that name (removed user)
215 const actor = await ActorModel.loadLocalByName(options.username)
216 if (actor) return null
218 const userToCreate = new UserModel({
219 username: options.username,
221 email: options.email,
222 nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
225 videoQuota: CONFIG.USER.VIDEO_QUOTA,
226 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY,
227 adminFlags: UserAdminFlag.NONE,
231 const { user } = await createUserAccountAndChannelAndPlaylist({
233 userDisplayName: options.displayName
239 function checkUserValidityOrThrow (user: MUser) {
240 if (user.blocked) throw new AccessDeniedError('User is blocked.')
243 function buildExpiresIn (expiresAt: Date) {
244 return Math.floor((expiresAt.getTime() - new Date().getTime()) / 1000)