2021-08-27 08:32:44 -04:00
|
|
|
import express from 'express'
|
2022-06-28 09:32:57 -04:00
|
|
|
import { AccessDeniedError } from '@node-oauth/oauth2-server'
|
2021-02-25 09:55:31 -05:00
|
|
|
import { PluginManager } from '@server/lib/plugins/plugin-manager'
|
2021-03-12 09:20:46 -05:00
|
|
|
import { MOAuthClient } from '@server/types/models'
|
2020-06-18 04:45:25 -04:00
|
|
|
import { MOAuthTokenUser } from '@server/types/models/oauth/oauth-token'
|
|
|
|
import { MUser } from '@server/types/models/user/user'
|
2022-03-04 04:57:36 -05:00
|
|
|
import { pick } from '@shared/core-utils'
|
2020-04-22 10:07:04 -04:00
|
|
|
import { UserRole } from '@shared/models/users/user-role'
|
2021-03-12 09:20:46 -05:00
|
|
|
import { logger } from '../../helpers/logger'
|
|
|
|
import { CONFIG } from '../../initializers/config'
|
|
|
|
import { OAuthClientModel } from '../../models/oauth/oauth-client'
|
|
|
|
import { OAuthTokenModel } from '../../models/oauth/oauth-token'
|
2022-02-09 11:48:15 -05:00
|
|
|
import { UserModel } from '../../models/user/user'
|
2022-08-03 04:10:26 -04:00
|
|
|
import { findAvailableLocalActorName } from '../local-actor'
|
2022-03-04 04:57:36 -05:00
|
|
|
import { buildUser, createUserAccountAndChannelAndPlaylist } from '../user'
|
2021-03-12 09:20:46 -05:00
|
|
|
import { TokensCache } from './tokens-cache'
|
|
|
|
|
|
|
|
type TokenInfo = {
|
|
|
|
accessToken: string
|
|
|
|
refreshToken: string
|
|
|
|
accessTokenExpiresAt: Date
|
|
|
|
refreshTokenExpiresAt: Date
|
2018-09-20 05:31:48 -04:00
|
|
|
}
|
|
|
|
|
2021-03-12 09:20:46 -05:00
|
|
|
export type BypassLogin = {
|
|
|
|
bypass: boolean
|
|
|
|
pluginName: string
|
|
|
|
authName?: string
|
|
|
|
user: {
|
|
|
|
username: string
|
|
|
|
email: string
|
|
|
|
displayName: string
|
|
|
|
role: UserRole
|
2018-09-20 05:31:48 -04:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-04-24 05:33:01 -04:00
|
|
|
async function getAccessToken (bearerToken: string) {
|
2016-07-01 10:03:53 -04:00
|
|
|
logger.debug('Getting access token (bearerToken: ' + bearerToken + ').')
|
|
|
|
|
2020-04-24 05:33:01 -04:00
|
|
|
if (!bearerToken) return undefined
|
2019-04-23 03:50:57 -04:00
|
|
|
|
2020-04-24 05:33:01 -04:00
|
|
|
let tokenModel: MOAuthTokenUser
|
2018-09-20 05:31:48 -04:00
|
|
|
|
2021-03-12 09:20:46 -05:00
|
|
|
if (TokensCache.Instance.hasToken(bearerToken)) {
|
|
|
|
tokenModel = TokensCache.Instance.getByToken(bearerToken)
|
2020-04-24 05:33:01 -04:00
|
|
|
} else {
|
|
|
|
tokenModel = await OAuthTokenModel.getByTokenAndPopulateUser(bearerToken)
|
2020-04-22 10:07:04 -04:00
|
|
|
|
2021-03-12 09:20:46 -05:00
|
|
|
if (tokenModel) TokensCache.Instance.setToken(tokenModel)
|
2020-04-24 05:33:01 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
if (!tokenModel) return undefined
|
|
|
|
|
|
|
|
if (tokenModel.User.pluginAuth) {
|
|
|
|
const valid = await PluginManager.Instance.isTokenValid(tokenModel, 'access')
|
|
|
|
|
|
|
|
if (valid !== true) return undefined
|
|
|
|
}
|
|
|
|
|
|
|
|
return tokenModel
|
2016-07-01 10:03:53 -04:00
|
|
|
}
|
|
|
|
|
2017-06-10 16:15:25 -04:00
|
|
|
function getClient (clientId: string, clientSecret: string) {
|
2016-07-01 10:03:53 -04:00
|
|
|
logger.debug('Getting Client (clientId: ' + clientId + ', clientSecret: ' + clientSecret + ').')
|
|
|
|
|
2017-12-12 11:53:50 -05:00
|
|
|
return OAuthClientModel.getByIdAndSecret(clientId, clientSecret)
|
2016-07-01 10:03:53 -04:00
|
|
|
}
|
|
|
|
|
2020-04-24 05:33:01 -04:00
|
|
|
async function getRefreshToken (refreshToken: string) {
|
2016-07-01 10:03:53 -04:00
|
|
|
logger.debug('Getting RefreshToken (refreshToken: ' + refreshToken + ').')
|
|
|
|
|
2020-04-24 05:33:01 -04:00
|
|
|
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
|
2016-07-01 10:03:53 -04:00
|
|
|
}
|
|
|
|
|
2021-03-12 09:20:46 -05:00
|
|
|
async function getUser (usernameOrEmail?: string, password?: string, bypassLogin?: BypassLogin) {
|
2020-04-24 05:33:01 -04:00
|
|
|
// Special treatment coming from a plugin
|
2021-03-12 09:20:46 -05:00
|
|
|
if (bypassLogin && bypassLogin.bypass === true) {
|
|
|
|
logger.info('Bypassing oauth login by plugin %s.', bypassLogin.pluginName)
|
2020-04-22 10:07:04 -04:00
|
|
|
|
2021-03-12 09:20:46 -05:00
|
|
|
let user = await UserModel.loadByEmail(bypassLogin.user.email)
|
|
|
|
if (!user) user = await createUserFromExternal(bypassLogin.pluginName, bypassLogin.user)
|
2020-04-22 10:07:04 -04:00
|
|
|
|
2020-05-20 04:04:44 -04:00
|
|
|
// Cannot create a user
|
|
|
|
if (!user) throw new AccessDeniedError('Cannot create such user: an actor with that name already exists.')
|
|
|
|
|
2020-04-30 03:42:30 -04:00
|
|
|
// 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
|
2022-02-09 05:47:22 -05:00
|
|
|
if (user.pluginAuth !== bypassLogin.pluginName) {
|
|
|
|
logger.info(
|
|
|
|
'Cannot bypass oauth login by plugin %s because %s has another plugin auth method (%s).',
|
|
|
|
bypassLogin.pluginName, bypassLogin.user.email, user.pluginAuth
|
|
|
|
)
|
|
|
|
|
|
|
|
return null
|
|
|
|
}
|
2020-04-22 10:07:04 -04:00
|
|
|
|
2021-02-01 03:24:14 -05:00
|
|
|
checkUserValidityOrThrow(user)
|
|
|
|
|
2020-04-30 03:42:30 -04:00
|
|
|
return user
|
|
|
|
}
|
2020-04-22 10:07:04 -04:00
|
|
|
}
|
|
|
|
|
2018-01-29 10:09:50 -05:00
|
|
|
logger.debug('Getting User (username/email: ' + usernameOrEmail + ', password: ******).')
|
2016-07-01 10:03:53 -04:00
|
|
|
|
2018-01-29 10:09:50 -05:00
|
|
|
const user = await UserModel.loadByUsernameOrEmail(usernameOrEmail)
|
2022-02-09 11:48:15 -05:00
|
|
|
|
2020-04-23 05:36:50 -04:00
|
|
|
// If we don't find the user, or if the user belongs to a plugin
|
2020-05-11 12:29:06 -04:00
|
|
|
if (!user || user.pluginAuth !== null || !password) return null
|
2016-08-25 11:57:37 -04:00
|
|
|
|
2017-10-25 10:03:33 -04:00
|
|
|
const passwordMatch = await user.isPasswordMatch(password)
|
2020-04-30 03:42:30 -04:00
|
|
|
if (passwordMatch !== true) return null
|
2016-08-25 11:57:37 -04:00
|
|
|
|
2021-02-01 03:24:14 -05:00
|
|
|
checkUserValidityOrThrow(user)
|
2018-08-08 08:58:21 -04:00
|
|
|
|
2018-08-31 03:18:19 -04:00
|
|
|
if (CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION && user.emailVerified === false) {
|
|
|
|
throw new AccessDeniedError('User email is not verified.')
|
|
|
|
}
|
|
|
|
|
2017-10-25 10:03:33 -04:00
|
|
|
return user
|
2016-07-20 10:23:58 -04:00
|
|
|
}
|
|
|
|
|
2021-03-12 09:20:46 -05:00
|
|
|
async function revokeToken (
|
|
|
|
tokenInfo: { refreshToken: string },
|
2021-03-12 11:19:02 -05:00
|
|
|
options: {
|
|
|
|
req?: express.Request
|
|
|
|
explicitLogout?: boolean
|
|
|
|
} = {}
|
2021-03-12 09:20:46 -05:00
|
|
|
): Promise<{ success: boolean, redirectUrl?: string }> {
|
2021-03-12 11:19:02 -05:00
|
|
|
const { req, explicitLogout } = options
|
|
|
|
|
2017-12-12 11:53:50 -05:00
|
|
|
const token = await OAuthTokenModel.getByRefreshTokenAndPopulateUser(tokenInfo.refreshToken)
|
2020-04-23 05:36:50 -04:00
|
|
|
|
2018-08-28 04:56:09 -04:00
|
|
|
if (token) {
|
2020-11-20 09:36:43 -05:00
|
|
|
let redirectUrl: string
|
|
|
|
|
2021-03-12 09:20:46 -05:00
|
|
|
if (explicitLogout === true && token.User.pluginAuth && token.authName) {
|
2021-03-12 11:19:02 -05:00
|
|
|
redirectUrl = await PluginManager.Instance.onLogout(token.User.pluginAuth, token.authName, token.User, req)
|
2020-04-23 05:36:50 -04:00
|
|
|
}
|
|
|
|
|
2021-03-12 09:20:46 -05:00
|
|
|
TokensCache.Instance.clearCacheByToken(token.accessToken)
|
2018-09-20 05:31:48 -04:00
|
|
|
|
2018-08-28 04:56:09 -04:00
|
|
|
token.destroy()
|
|
|
|
.catch(err => logger.error('Cannot destroy token when revoking token.', { err }))
|
2020-04-22 10:07:04 -04:00
|
|
|
|
2020-11-20 09:36:43 -05:00
|
|
|
return { success: true, redirectUrl }
|
2018-08-28 04:56:09 -04:00
|
|
|
}
|
2017-10-25 10:03:33 -04:00
|
|
|
|
2020-11-20 09:36:43 -05:00
|
|
|
return { success: false }
|
2016-07-01 10:03:53 -04:00
|
|
|
}
|
|
|
|
|
2021-03-12 09:20:46 -05:00
|
|
|
async function saveToken (
|
|
|
|
token: TokenInfo,
|
|
|
|
client: MOAuthClient,
|
|
|
|
user: MUser,
|
|
|
|
options: {
|
|
|
|
refreshTokenAuthName?: string
|
|
|
|
bypassLogin?: BypassLogin
|
|
|
|
} = {}
|
|
|
|
) {
|
|
|
|
const { refreshTokenAuthName, bypassLogin } = options
|
2020-04-24 05:33:01 -04:00
|
|
|
let authName: string = null
|
2021-03-12 09:20:46 -05:00
|
|
|
|
|
|
|
if (bypassLogin?.bypass === true) {
|
|
|
|
authName = bypassLogin.authName
|
|
|
|
} else if (refreshTokenAuthName) {
|
|
|
|
authName = refreshTokenAuthName
|
2020-04-24 05:33:01 -04:00
|
|
|
}
|
2020-04-23 05:36:50 -04:00
|
|
|
|
2016-07-27 15:15:07 -04:00
|
|
|
logger.debug('Saving token ' + token.accessToken + ' for client ' + client.id + ' and user ' + user.id + '.')
|
2016-07-01 10:03:53 -04:00
|
|
|
|
2016-12-11 15:50:51 -05:00
|
|
|
const tokenToCreate = {
|
2016-07-01 10:03:53 -04:00
|
|
|
accessToken: token.accessToken,
|
2016-07-20 10:23:58 -04:00
|
|
|
accessTokenExpiresAt: token.accessTokenExpiresAt,
|
2016-07-01 10:03:53 -04:00
|
|
|
refreshToken: token.refreshToken,
|
2016-07-20 10:23:58 -04:00
|
|
|
refreshTokenExpiresAt: token.refreshTokenExpiresAt,
|
2020-04-23 05:36:50 -04:00
|
|
|
authName,
|
2016-12-11 15:50:51 -05:00
|
|
|
oAuthClientId: client.id,
|
|
|
|
userId: user.id
|
|
|
|
}
|
2016-07-01 10:03:53 -04:00
|
|
|
|
2017-12-12 11:53:50 -05:00
|
|
|
const tokenCreated = await OAuthTokenModel.create(tokenToCreate)
|
2020-05-07 04:39:09 -04:00
|
|
|
|
|
|
|
user.lastLoginDate = new Date()
|
|
|
|
await user.save()
|
|
|
|
|
2021-02-25 09:25:48 -05:00
|
|
|
return {
|
|
|
|
accessToken: tokenCreated.accessToken,
|
|
|
|
accessTokenExpiresAt: tokenCreated.accessTokenExpiresAt,
|
|
|
|
refreshToken: tokenCreated.refreshToken,
|
|
|
|
refreshTokenExpiresAt: tokenCreated.refreshTokenExpiresAt,
|
|
|
|
client,
|
|
|
|
user,
|
2021-03-12 09:20:46 -05:00
|
|
|
accessTokenExpiresIn: buildExpiresIn(tokenCreated.accessTokenExpiresAt),
|
|
|
|
refreshTokenExpiresIn: buildExpiresIn(tokenCreated.refreshTokenExpiresAt)
|
2021-02-25 09:25:48 -05:00
|
|
|
}
|
2016-07-01 10:03:53 -04:00
|
|
|
}
|
|
|
|
|
2017-05-15 16:22:03 -04:00
|
|
|
export {
|
|
|
|
getAccessToken,
|
|
|
|
getClient,
|
|
|
|
getRefreshToken,
|
|
|
|
getUser,
|
|
|
|
revokeToken,
|
|
|
|
saveToken
|
|
|
|
}
|
2020-04-22 10:07:04 -04:00
|
|
|
|
2021-03-12 09:20:46 -05:00
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
|
2020-04-22 10:07:04 -04:00
|
|
|
async function createUserFromExternal (pluginAuth: string, options: {
|
|
|
|
username: string
|
|
|
|
email: string
|
|
|
|
role: UserRole
|
|
|
|
displayName: string
|
|
|
|
}) {
|
2022-08-03 04:10:26 -04:00
|
|
|
const username = await findAvailableLocalActorName(options.username)
|
2020-05-20 04:04:44 -04:00
|
|
|
|
2022-03-04 04:57:36 -05:00
|
|
|
const userToCreate = buildUser({
|
2022-08-03 04:10:26 -04:00
|
|
|
...pick(options, [ 'email', 'role' ]),
|
2022-03-04 04:57:36 -05:00
|
|
|
|
2022-08-03 04:10:26 -04:00
|
|
|
username,
|
2022-03-04 04:57:36 -05:00
|
|
|
emailVerified: null,
|
2020-04-22 10:07:04 -04:00
|
|
|
password: null,
|
|
|
|
pluginAuth
|
2022-03-04 04:57:36 -05:00
|
|
|
})
|
2020-04-22 10:07:04 -04:00
|
|
|
|
|
|
|
const { user } = await createUserAccountAndChannelAndPlaylist({
|
|
|
|
userToCreate,
|
|
|
|
userDisplayName: options.displayName
|
|
|
|
})
|
|
|
|
|
|
|
|
return user
|
|
|
|
}
|
2021-02-01 03:24:14 -05:00
|
|
|
|
|
|
|
function checkUserValidityOrThrow (user: MUser) {
|
|
|
|
if (user.blocked) throw new AccessDeniedError('User is blocked.')
|
|
|
|
}
|
2021-03-12 09:20:46 -05:00
|
|
|
|
|
|
|
function buildExpiresIn (expiresAt: Date) {
|
|
|
|
return Math.floor((expiresAt.getTime() - new Date().getTime()) / 1000)
|
|
|
|
}
|