1 import express from 'express'
2 import { AccessDeniedError } from 'oauth2-server'
3 import { PluginManager } from '@server/lib/plugins/plugin-manager'
4 import { ActorModel } from '@server/models/actor/actor'
5 import { MOAuthClient } from '@server/types/models'
6 import { MOAuthTokenUser } from '@server/types/models/oauth/oauth-token'
7 import { MUser } from '@server/types/models/user/user'
8 import { UserAdminFlag } from '@shared/models/users/user-flag.model'
9 import { UserRole } from '@shared/models/users/user-role'
10 import { logger } from '../../helpers/logger'
11 import { CONFIG } from '../../initializers/config'
12 import { UserModel } from '../../models/user/user'
13 import { OAuthClientModel } from '../../models/oauth/oauth-client'
14 import { OAuthTokenModel } from '../../models/oauth/oauth-token'
15 import { createUserAccountAndChannelAndPlaylist } from '../user'
16 import { TokensCache } from './tokens-cache'
21 accessTokenExpiresAt: Date
22 refreshTokenExpiresAt: Date
25 export type BypassLogin = {
37 async function getAccessToken (bearerToken: string) {
38 logger.debug('Getting access token (bearerToken: ' + bearerToken + ').')
40 if (!bearerToken) return undefined
42 let tokenModel: MOAuthTokenUser
44 if (TokensCache.Instance.hasToken(bearerToken)) {
45 tokenModel = TokensCache.Instance.getByToken(bearerToken)
47 tokenModel = await OAuthTokenModel.getByTokenAndPopulateUser(bearerToken)
49 if (tokenModel) TokensCache.Instance.setToken(tokenModel)
52 if (!tokenModel) return undefined
54 if (tokenModel.User.pluginAuth) {
55 const valid = await PluginManager.Instance.isTokenValid(tokenModel, 'access')
57 if (valid !== true) return undefined
63 function getClient (clientId: string, clientSecret: string) {
64 logger.debug('Getting Client (clientId: ' + clientId + ', clientSecret: ' + clientSecret + ').')
66 return OAuthClientModel.getByIdAndSecret(clientId, clientSecret)
69 async function getRefreshToken (refreshToken: string) {
70 logger.debug('Getting RefreshToken (refreshToken: ' + refreshToken + ').')
72 const tokenInfo = await OAuthTokenModel.getByRefreshTokenAndPopulateClient(refreshToken)
73 if (!tokenInfo) return undefined
75 const tokenModel = tokenInfo.token
77 if (tokenModel.User.pluginAuth) {
78 const valid = await PluginManager.Instance.isTokenValid(tokenModel, 'refresh')
80 if (valid !== true) return undefined
86 async function getUser (usernameOrEmail?: string, password?: string, bypassLogin?: BypassLogin) {
87 // Special treatment coming from a plugin
88 if (bypassLogin && bypassLogin.bypass === true) {
89 logger.info('Bypassing oauth login by plugin %s.', bypassLogin.pluginName)
91 let user = await UserModel.loadByEmail(bypassLogin.user.email)
92 if (!user) user = await createUserFromExternal(bypassLogin.pluginName, bypassLogin.user)
94 // Cannot create a user
95 if (!user) throw new AccessDeniedError('Cannot create such user: an actor with that name already exists.')
97 // If the user does not belongs to a plugin, it was created before its installation
98 // Then we just go through a regular login process
99 if (user.pluginAuth !== null) {
100 // This user does not belong to this plugin, skip it
101 if (user.pluginAuth !== bypassLogin.pluginName) return null
103 checkUserValidityOrThrow(user)
109 logger.debug('Getting User (username/email: ' + usernameOrEmail + ', password: ******).')
111 const user = await UserModel.loadByUsernameOrEmail(usernameOrEmail)
112 // If we don't find the user, or if the user belongs to a plugin
113 if (!user || user.pluginAuth !== null || !password) return null
115 const passwordMatch = await user.isPasswordMatch(password)
116 if (passwordMatch !== true) return null
118 checkUserValidityOrThrow(user)
120 if (CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION && user.emailVerified === false) {
121 throw new AccessDeniedError('User email is not verified.')
127 async function revokeToken (
128 tokenInfo: { refreshToken: string },
130 req?: express.Request
131 explicitLogout?: boolean
133 ): Promise<{ success: boolean, redirectUrl?: string }> {
134 const { req, explicitLogout } = options
136 const token = await OAuthTokenModel.getByRefreshTokenAndPopulateUser(tokenInfo.refreshToken)
139 let redirectUrl: string
141 if (explicitLogout === true && token.User.pluginAuth && token.authName) {
142 redirectUrl = await PluginManager.Instance.onLogout(token.User.pluginAuth, token.authName, token.User, req)
145 TokensCache.Instance.clearCacheByToken(token.accessToken)
148 .catch(err => logger.error('Cannot destroy token when revoking token.', { err }))
150 return { success: true, redirectUrl }
153 return { success: false }
156 async function saveToken (
158 client: MOAuthClient,
161 refreshTokenAuthName?: string
162 bypassLogin?: BypassLogin
165 const { refreshTokenAuthName, bypassLogin } = options
166 let authName: string = null
168 if (bypassLogin?.bypass === true) {
169 authName = bypassLogin.authName
170 } else if (refreshTokenAuthName) {
171 authName = refreshTokenAuthName
174 logger.debug('Saving token ' + token.accessToken + ' for client ' + client.id + ' and user ' + user.id + '.')
176 const tokenToCreate = {
177 accessToken: token.accessToken,
178 accessTokenExpiresAt: token.accessTokenExpiresAt,
179 refreshToken: token.refreshToken,
180 refreshTokenExpiresAt: token.refreshTokenExpiresAt,
182 oAuthClientId: client.id,
186 const tokenCreated = await OAuthTokenModel.create(tokenToCreate)
188 user.lastLoginDate = new Date()
192 accessToken: tokenCreated.accessToken,
193 accessTokenExpiresAt: tokenCreated.accessTokenExpiresAt,
194 refreshToken: tokenCreated.refreshToken,
195 refreshTokenExpiresAt: tokenCreated.refreshTokenExpiresAt,
198 accessTokenExpiresIn: buildExpiresIn(tokenCreated.accessTokenExpiresAt),
199 refreshTokenExpiresIn: buildExpiresIn(tokenCreated.refreshTokenExpiresAt)
212 // ---------------------------------------------------------------------------
214 async function createUserFromExternal (pluginAuth: string, options: {
220 // Check an actor does not already exists with that name (removed user)
221 const actor = await ActorModel.loadLocalByName(options.username)
222 if (actor) return null
224 const userToCreate = new UserModel({
225 username: options.username,
227 email: options.email,
228 nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
229 p2pEnabled: CONFIG.DEFAULTS.P2P.WEBAPP.ENABLED,
232 videoQuota: CONFIG.USER.VIDEO_QUOTA,
233 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY,
234 adminFlags: UserAdminFlag.NONE,
238 const { user } = await createUserAccountAndChannelAndPlaylist({
240 userDisplayName: options.displayName
246 function checkUserValidityOrThrow (user: MUser) {
247 if (user.blocked) throw new AccessDeniedError('User is blocked.')
250 function buildExpiresIn (expiresAt: Date) {
251 return Math.floor((expiresAt.getTime() - new Date().getTime()) / 1000)