PeerTube/server/lib/oauth-model.ts

255 lines
8.1 KiB
TypeScript
Raw Normal View History

2020-04-22 16:07:04 +02:00
import * as express from 'express'
2021-02-25 15:55:31 +01:00
import * as LRUCache from 'lru-cache'
2018-08-09 17:51:25 +02:00
import { AccessDeniedError } from 'oauth2-server'
2018-09-20 11:31:48 +02:00
import { Transaction } from 'sequelize'
2021-02-25 15:55:31 +01:00
import { PluginManager } from '@server/lib/plugins/plugin-manager'
import { ActorModel } from '@server/models/activitypub/actor'
2020-06-18 10:45:25 +02:00
import { MOAuthTokenUser } from '@server/types/models/oauth/oauth-token'
import { MUser } from '@server/types/models/user/user'
2020-04-22 16:07:04 +02:00
import { UserAdminFlag } from '@shared/models/users/user-flag.model'
import { UserRole } from '@shared/models/users/user-role'
2021-02-25 15:55:31 +01:00
import { logger } from '../helpers/logger'
import { CONFIG } from '../initializers/config'
import { LRU_CACHE } from '../initializers/constants'
import { UserModel } from '../models/account/user'
import { OAuthClientModel } from '../models/oauth/oauth-client'
import { OAuthTokenModel } from '../models/oauth/oauth-token'
import { createUserAccountAndChannelAndPlaylist } from './user'
2017-06-10 22:15:25 +02:00
type TokenInfo = { accessToken: string, refreshToken: string, accessTokenExpiresAt: Date, refreshTokenExpiresAt: Date }
2019-08-09 11:32:40 +02:00
2019-08-15 11:53:26 +02:00
const accessTokenCache = new LRUCache<string, MOAuthTokenUser>({ max: LRU_CACHE.USER_TOKENS.MAX_SIZE })
2019-08-09 11:32:40 +02:00
const userHavingToken = new LRUCache<number, string>({ max: LRU_CACHE.USER_TOKENS.MAX_SIZE })
2017-06-10 22:15:25 +02:00
// ---------------------------------------------------------------------------
2018-09-20 11:31:48 +02:00
function deleteUserToken (userId: number, t?: Transaction) {
clearCacheByUserId(userId)
return OAuthTokenModel.deleteUserToken(userId, t)
}
function clearCacheByUserId (userId: number) {
2019-08-09 11:32:40 +02:00
const token = userHavingToken.get(userId)
2018-09-20 11:31:48 +02:00
if (token !== undefined) {
2019-08-09 11:32:40 +02:00
accessTokenCache.del(token)
userHavingToken.del(userId)
2018-09-20 11:31:48 +02:00
}
}
function clearCacheByToken (token: string) {
2019-08-09 11:32:40 +02:00
const tokenModel = accessTokenCache.get(token)
2018-09-20 11:31:48 +02:00
if (tokenModel !== undefined) {
2019-08-09 11:32:40 +02:00
userHavingToken.del(tokenModel.userId)
accessTokenCache.del(token)
2018-09-20 11:31:48 +02:00
}
}
async function getAccessToken (bearerToken: string) {
logger.debug('Getting access token (bearerToken: ' + bearerToken + ').')
if (!bearerToken) return undefined
2019-04-23 09:50:57 +02:00
let tokenModel: MOAuthTokenUser
2018-09-20 11:31:48 +02:00
if (accessTokenCache.has(bearerToken)) {
tokenModel = accessTokenCache.get(bearerToken)
} else {
tokenModel = await OAuthTokenModel.getByTokenAndPopulateUser(bearerToken)
2020-04-22 16:07:04 +02:00
if (tokenModel) {
accessTokenCache.set(bearerToken, tokenModel)
userHavingToken.set(tokenModel.userId, tokenModel.accessToken)
}
}
if (!tokenModel) return undefined
if (tokenModel.User.pluginAuth) {
const valid = await PluginManager.Instance.isTokenValid(tokenModel, 'access')
if (valid !== true) return undefined
}
return tokenModel
}
2017-06-10 22:15:25 +02:00
function getClient (clientId: string, clientSecret: string) {
logger.debug('Getting Client (clientId: ' + clientId + ', clientSecret: ' + clientSecret + ').')
2017-12-12 17:53:50 +01:00
return OAuthClientModel.getByIdAndSecret(clientId, clientSecret)
}
async function getRefreshToken (refreshToken: string) {
logger.debug('Getting RefreshToken (refreshToken: ' + refreshToken + ').')
const tokenInfo = await OAuthTokenModel.getByRefreshTokenAndPopulateClient(refreshToken)
if (!tokenInfo) return undefined
const tokenModel = tokenInfo.token
if (tokenModel.User.pluginAuth) {
const valid = await PluginManager.Instance.isTokenValid(tokenModel, 'refresh')
if (valid !== true) return undefined
}
return tokenInfo
}
2020-04-28 14:49:03 +02:00
async function getUser (usernameOrEmail?: string, password?: string) {
2020-04-22 16:07:04 +02:00
const res: express.Response = this.request.res
// Special treatment coming from a plugin
2020-04-22 16:07:04 +02:00
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)
2020-04-22 16:07:04 +02:00
if (!user) user = await createUserFromExternal(obj.pluginName, obj.user)
// Cannot create a user
if (!user) throw new AccessDeniedError('Cannot create such user: an actor with that name already exists.')
// If the user does not belongs to a plugin, it was created before its installation
// Then we just go through a regular login process
if (user.pluginAuth !== null) {
// This user does not belong to this plugin, skip it
if (user.pluginAuth !== obj.pluginName) return null
2020-04-22 16:07:04 +02:00
2021-02-01 09:24:14 +01:00
checkUserValidityOrThrow(user)
return user
}
2020-04-22 16:07:04 +02:00
}
2018-01-29 16:09:50 +01:00
logger.debug('Getting User (username/email: ' + usernameOrEmail + ', password: ******).')
2018-01-29 16:09:50 +01:00
const user = await UserModel.loadByUsernameOrEmail(usernameOrEmail)
// If we don't find the user, or if the user belongs to a plugin
2020-05-11 18:29:06 +02:00
if (!user || user.pluginAuth !== null || !password) return null
2016-08-25 17:57:37 +02:00
const passwordMatch = await user.isPasswordMatch(password)
if (passwordMatch !== true) return null
2016-08-25 17:57:37 +02:00
2021-02-01 09:24:14 +01:00
checkUserValidityOrThrow(user)
2018-08-08 14:58:21 +02:00
if (CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION && user.emailVerified === false) {
throw new AccessDeniedError('User email is not verified.')
}
return user
2016-07-20 16:23:58 +02:00
}
async function revokeToken (tokenInfo: { refreshToken: string }): Promise<{ success: boolean, redirectUrl?: string }> {
const res: express.Response = this.request.res
2017-12-12 17:53:50 +01:00
const token = await OAuthTokenModel.getByRefreshTokenAndPopulateUser(tokenInfo.refreshToken)
2018-08-28 10:56:09 +02:00
if (token) {
let redirectUrl: string
if (res.locals.explicitLogout === true && token.User.pluginAuth && token.authName) {
redirectUrl = await PluginManager.Instance.onLogout(token.User.pluginAuth, token.authName, token.User, this.request)
}
2018-09-20 11:31:48 +02:00
clearCacheByToken(token.accessToken)
2018-08-28 10:56:09 +02:00
token.destroy()
.catch(err => logger.error('Cannot destroy token when revoking token.', { err }))
2020-04-22 16:07:04 +02:00
return { success: true, redirectUrl }
2018-08-28 10:56:09 +02:00
}
return { success: false }
}
2017-12-12 17:53:50 +01:00
async function saveToken (token: TokenInfo, client: OAuthClientModel, user: UserModel) {
const res: express.Response = this.request.res
let authName: string = null
if (res.locals.bypassLogin?.bypass === true) {
authName = res.locals.bypassLogin.authName
} else if (res.locals.refreshTokenAuthName) {
authName = res.locals.refreshTokenAuthName
}
logger.debug('Saving token ' + token.accessToken + ' for client ' + client.id + ' and user ' + user.id + '.')
2016-12-11 21:50:51 +01:00
const tokenToCreate = {
accessToken: token.accessToken,
2016-07-20 16:23:58 +02:00
accessTokenExpiresAt: token.accessTokenExpiresAt,
refreshToken: token.refreshToken,
2016-07-20 16:23:58 +02:00
refreshTokenExpiresAt: token.refreshTokenExpiresAt,
authName,
2016-12-11 21:50:51 +01:00
oAuthClientId: client.id,
userId: user.id
}
2017-12-12 17:53:50 +01:00
const tokenCreated = await OAuthTokenModel.create(tokenToCreate)
2020-05-07 10:39:09 +02:00
user.lastLoginDate = new Date()
await user.save()
return {
accessToken: tokenCreated.accessToken,
accessTokenExpiresAt: tokenCreated.accessTokenExpiresAt,
refreshToken: tokenCreated.refreshToken,
refreshTokenExpiresAt: tokenCreated.refreshTokenExpiresAt,
client,
user,
refresh_token_expires_in: Math.floor((tokenCreated.refreshTokenExpiresAt.getTime() - new Date().getTime()) / 1000)
}
}
// ---------------------------------------------------------------------------
2017-05-15 22:22:03 +02:00
// See https://github.com/oauthjs/node-oauth2-server/wiki/Model-specification for the model specifications
export {
2018-09-20 11:31:48 +02:00
deleteUserToken,
clearCacheByUserId,
clearCacheByToken,
2017-05-15 22:22:03 +02:00
getAccessToken,
getClient,
getRefreshToken,
getUser,
revokeToken,
saveToken
}
2020-04-22 16:07:04 +02:00
async function createUserFromExternal (pluginAuth: string, options: {
username: string
email: string
role: UserRole
displayName: string
}) {
// Check an actor does not already exists with that name (removed user)
const actor = await ActorModel.loadLocalByName(options.username)
if (actor) return null
2020-04-22 16:07:04 +02:00
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
}
2021-02-01 09:24:14 +01:00
function checkUserValidityOrThrow (user: MUser) {
if (user.blocked) throw new AccessDeniedError('User is blocked.')
}