PeerTube/server/lib/auth/oauth-model.ts

253 lines
7.5 KiB
TypeScript
Raw Normal View History

2021-08-27 14:32:44 +02:00
import express from 'express'
2018-08-09 17:51:25 +02:00
import { AccessDeniedError } from 'oauth2-server'
2021-02-25 15:55:31 +01:00
import { PluginManager } from '@server/lib/plugins/plugin-manager'
2021-05-11 11:15:29 +02:00
import { ActorModel } from '@server/models/actor/actor'
import { MOAuthClient } from '@server/types/models'
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'
import { logger } from '../../helpers/logger'
import { CONFIG } from '../../initializers/config'
2021-05-11 11:15:29 +02:00
import { UserModel } from '../../models/user/user'
import { OAuthClientModel } from '../../models/oauth/oauth-client'
import { OAuthTokenModel } from '../../models/oauth/oauth-token'
import { createUserAccountAndChannelAndPlaylist } from '../user'
import { TokensCache } from './tokens-cache'
type TokenInfo = {
accessToken: string
refreshToken: string
accessTokenExpiresAt: Date
refreshTokenExpiresAt: Date
2018-09-20 11:31:48 +02:00
}
export type BypassLogin = {
bypass: boolean
pluginName: string
authName?: string
user: {
username: string
email: string
displayName: string
role: UserRole
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 (TokensCache.Instance.hasToken(bearerToken)) {
tokenModel = TokensCache.Instance.getByToken(bearerToken)
} else {
tokenModel = await OAuthTokenModel.getByTokenAndPopulateUser(bearerToken)
2020-04-22 16:07:04 +02:00
if (tokenModel) TokensCache.Instance.setToken(tokenModel)
}
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
}
async function getUser (usernameOrEmail?: string, password?: string, bypassLogin?: BypassLogin) {
// Special treatment coming from a plugin
if (bypassLogin && bypassLogin.bypass === true) {
logger.info('Bypassing oauth login by plugin %s.', bypassLogin.pluginName)
2020-04-22 16:07:04 +02:00
let user = await UserModel.loadByEmail(bypassLogin.user.email)
if (!user) user = await createUserFromExternal(bypassLogin.pluginName, bypassLogin.user)
2020-04-22 16:07:04 +02:00
// 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 !== bypassLogin.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 },
2021-03-12 17:19:02 +01:00
options: {
req?: express.Request
explicitLogout?: boolean
} = {}
): Promise<{ success: boolean, redirectUrl?: string }> {
2021-03-12 17:19:02 +01:00
const { req, explicitLogout } = options
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 (explicitLogout === true && token.User.pluginAuth && token.authName) {
2021-03-12 17:19:02 +01:00
redirectUrl = await PluginManager.Instance.onLogout(token.User.pluginAuth, token.authName, token.User, req)
}
TokensCache.Instance.clearCacheByToken(token.accessToken)
2018-09-20 11:31:48 +02:00
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 }
}
async function saveToken (
token: TokenInfo,
client: MOAuthClient,
user: MUser,
options: {
refreshTokenAuthName?: string
bypassLogin?: BypassLogin
} = {}
) {
const { refreshTokenAuthName, bypassLogin } = options
let authName: string = null
if (bypassLogin?.bypass === true) {
authName = bypassLogin.authName
} else if (refreshTokenAuthName) {
authName = 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,
accessTokenExpiresIn: buildExpiresIn(tokenCreated.accessTokenExpiresAt),
refreshTokenExpiresIn: buildExpiresIn(tokenCreated.refreshTokenExpiresAt)
}
}
2017-05-15 22:22:03 +02:00
export {
getAccessToken,
getClient,
getRefreshToken,
getUser,
revokeToken,
saveToken
}
2020-04-22 16:07:04 +02:00
// ---------------------------------------------------------------------------
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,
p2pEnabled: CONFIG.DEFAULTS.P2P.WEBAPP.ENABLED,
2020-04-22 16:07:04 +02:00
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.')
}
function buildExpiresIn (expiresAt: Date) {
return Math.floor((expiresAt.getTime() - new Date().getTime()) / 1000)
}