mirror of
https://github.com/Chocobozzz/PeerTube.git
synced 2025-10-05 02:39:33 +02:00
Refactor auth flow
Reimplement some node-oauth2-server methods to remove hacky code needed by our external login workflow
This commit is contained in:
Chocobozzz
parent
cae2df6bdc
commit
f43db2f46e
24 changed files with 487 additions and 255 deletions
|
|
@ -1,28 +1,16 @@
|
|||
|
||||
import { isUserDisplayNameValid, isUserRoleValid, isUserUsernameValid } from '@server/helpers/custom-validators/users'
|
||||
import { logger } from '@server/helpers/logger'
|
||||
import { generateRandomString } from '@server/helpers/utils'
|
||||
import { OAUTH_LIFETIME, PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME } from '@server/initializers/constants'
|
||||
import { revokeToken } from '@server/lib/oauth-model'
|
||||
import { PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME } from '@server/initializers/constants'
|
||||
import { PluginManager } from '@server/lib/plugins/plugin-manager'
|
||||
import { OAuthTokenModel } from '@server/models/oauth/oauth-token'
|
||||
import { UserRole } from '@shared/models'
|
||||
import {
|
||||
RegisterServerAuthenticatedResult,
|
||||
RegisterServerAuthPassOptions,
|
||||
RegisterServerExternalAuthenticatedResult
|
||||
} from '@server/types/plugins/register-server-auth.model'
|
||||
import * as express from 'express'
|
||||
import * as OAuthServer from 'express-oauth-server'
|
||||
import { HttpStatusCode } from '@shared/core-utils/miscs/http-error-codes'
|
||||
|
||||
const oAuthServer = new OAuthServer({
|
||||
useErrorHandler: true,
|
||||
accessTokenLifetime: OAUTH_LIFETIME.ACCESS_TOKEN,
|
||||
refreshTokenLifetime: OAUTH_LIFETIME.REFRESH_TOKEN,
|
||||
allowExtendedTokenAttributes: true,
|
||||
continueMiddleware: true,
|
||||
model: require('./oauth-model')
|
||||
})
|
||||
import { UserRole } from '@shared/models'
|
||||
|
||||
// Token is the key, expiration date is the value
|
||||
const authBypassTokens = new Map<string, {
|
||||
|
|
@ -37,42 +25,6 @@ const authBypassTokens = new Map<string, {
|
|||
npmName: string
|
||||
}>()
|
||||
|
||||
async function handleLogin (req: express.Request, res: express.Response, next: express.NextFunction) {
|
||||
const grantType = req.body.grant_type
|
||||
|
||||
if (grantType === 'password') {
|
||||
if (req.body.externalAuthToken) proxifyExternalAuthBypass(req, res)
|
||||
else await proxifyPasswordGrant(req, res)
|
||||
} else if (grantType === 'refresh_token') {
|
||||
await proxifyRefreshGrant(req, res)
|
||||
}
|
||||
|
||||
return forwardTokenReq(req, res, next)
|
||||
}
|
||||
|
||||
async function handleTokenRevocation (req: express.Request, res: express.Response) {
|
||||
const token = res.locals.oauth.token
|
||||
|
||||
res.locals.explicitLogout = true
|
||||
const result = await revokeToken(token)
|
||||
|
||||
// FIXME: uncomment when https://github.com/oauthjs/node-oauth2-server/pull/289 is released
|
||||
// oAuthServer.revoke(req, res, err => {
|
||||
// if (err) {
|
||||
// logger.warn('Error in revoke token handler.', { err })
|
||||
//
|
||||
// return res.status(err.status)
|
||||
// .json({
|
||||
// error: err.message,
|
||||
// code: err.name
|
||||
// })
|
||||
// .end()
|
||||
// }
|
||||
// })
|
||||
|
||||
return res.json(result)
|
||||
}
|
||||
|
||||
async function onExternalUserAuthenticated (options: {
|
||||
npmName: string
|
||||
authName: string
|
||||
|
|
@ -107,7 +59,7 @@ async function onExternalUserAuthenticated (options: {
|
|||
authName
|
||||
})
|
||||
|
||||
// Cleanup
|
||||
// Cleanup expired tokens
|
||||
const now = new Date()
|
||||
for (const [ key, value ] of authBypassTokens) {
|
||||
if (value.expires.getTime() < now.getTime()) {
|
||||
|
|
@ -118,37 +70,15 @@ async function onExternalUserAuthenticated (options: {
|
|||
res.redirect(`/login?externalAuthToken=${bypassToken}&username=${user.username}`)
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
export { oAuthServer, handleLogin, onExternalUserAuthenticated, handleTokenRevocation }
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
function forwardTokenReq (req: express.Request, res: express.Response, next?: express.NextFunction) {
|
||||
return oAuthServer.token()(req, res, err => {
|
||||
if (err) {
|
||||
logger.warn('Login error.', { err })
|
||||
|
||||
return res.status(err.status)
|
||||
.json({
|
||||
error: err.message,
|
||||
code: err.name
|
||||
})
|
||||
}
|
||||
|
||||
if (next) return next()
|
||||
})
|
||||
}
|
||||
|
||||
async function proxifyRefreshGrant (req: express.Request, res: express.Response) {
|
||||
const refreshToken = req.body.refresh_token
|
||||
if (!refreshToken) return
|
||||
async function getAuthNameFromRefreshGrant (refreshToken?: string) {
|
||||
if (!refreshToken) return undefined
|
||||
|
||||
const tokenModel = await OAuthTokenModel.loadByRefreshToken(refreshToken)
|
||||
if (tokenModel?.authName) res.locals.refreshTokenAuthName = tokenModel.authName
|
||||
|
||||
return tokenModel?.authName
|
||||
}
|
||||
|
||||
async function proxifyPasswordGrant (req: express.Request, res: express.Response) {
|
||||
async function getBypassFromPasswordGrant (username: string, password: string) {
|
||||
const plugins = PluginManager.Instance.getIdAndPassAuths()
|
||||
const pluginAuths: { npmName?: string, registerAuthOptions: RegisterServerAuthPassOptions }[] = []
|
||||
|
||||
|
|
@ -174,8 +104,8 @@ async function proxifyPasswordGrant (req: express.Request, res: express.Response
|
|||
})
|
||||
|
||||
const loginOptions = {
|
||||
id: req.body.username,
|
||||
password: req.body.password
|
||||
id: username,
|
||||
password
|
||||
}
|
||||
|
||||
for (const pluginAuth of pluginAuths) {
|
||||
|
|
@ -199,49 +129,41 @@ async function proxifyPasswordGrant (req: express.Request, res: express.Response
|
|||
authName, npmName, loginOptions.id
|
||||
)
|
||||
|
||||
res.locals.bypassLogin = {
|
||||
return {
|
||||
bypass: true,
|
||||
pluginName: pluginAuth.npmName,
|
||||
authName: authOptions.authName,
|
||||
user: buildUserResult(loginResult)
|
||||
}
|
||||
|
||||
return
|
||||
} catch (err) {
|
||||
logger.error('Error in auth method %s of plugin %s', authOptions.authName, pluginAuth.npmName, { err })
|
||||
}
|
||||
}
|
||||
|
||||
return undefined
|
||||
}
|
||||
|
||||
function proxifyExternalAuthBypass (req: express.Request, res: express.Response) {
|
||||
const obj = authBypassTokens.get(req.body.externalAuthToken)
|
||||
if (!obj) {
|
||||
logger.error('Cannot authenticate user with unknown bypass token')
|
||||
return res.sendStatus(HttpStatusCode.BAD_REQUEST_400)
|
||||
}
|
||||
function getBypassFromExternalAuth (username: string, externalAuthToken: string) {
|
||||
const obj = authBypassTokens.get(externalAuthToken)
|
||||
if (!obj) throw new Error('Cannot authenticate user with unknown bypass token')
|
||||
|
||||
const { expires, user, authName, npmName } = obj
|
||||
|
||||
const now = new Date()
|
||||
if (now.getTime() > expires.getTime()) {
|
||||
logger.error('Cannot authenticate user with an expired external auth token')
|
||||
return res.sendStatus(HttpStatusCode.BAD_REQUEST_400)
|
||||
throw new Error('Cannot authenticate user with an expired external auth token')
|
||||
}
|
||||
|
||||
if (user.username !== req.body.username) {
|
||||
logger.error('Cannot authenticate user %s with invalid username %s.', req.body.username)
|
||||
return res.sendStatus(HttpStatusCode.BAD_REQUEST_400)
|
||||
if (user.username !== username) {
|
||||
throw new Error(`Cannot authenticate user ${user.username} with invalid username ${username}`)
|
||||
}
|
||||
|
||||
// Bypass oauth library validation
|
||||
req.body.password = 'fake'
|
||||
|
||||
logger.info(
|
||||
'Auth success with external auth method %s of plugin %s for %s.',
|
||||
authName, npmName, user.email
|
||||
)
|
||||
|
||||
res.locals.bypassLogin = {
|
||||
return {
|
||||
bypass: true,
|
||||
pluginName: npmName,
|
||||
authName: authName,
|
||||
|
|
@ -286,3 +208,12 @@ function buildUserResult (pluginResult: RegisterServerAuthenticatedResult) {
|
|||
displayName: pluginResult.displayName || pluginResult.username
|
||||
}
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
export {
|
||||
onExternalUserAuthenticated,
|
||||
getBypassFromExternalAuth,
|
||||
getAuthNameFromRefreshGrant,
|
||||
getBypassFromPasswordGrant
|
||||
}
|
||||
|
|
@ -1,49 +1,35 @@
|
|||
import * as express from 'express'
|
||||
import * as LRUCache from 'lru-cache'
|
||||
import { AccessDeniedError } from 'oauth2-server'
|
||||
import { Transaction } from 'sequelize'
|
||||
import { PluginManager } from '@server/lib/plugins/plugin-manager'
|
||||
import { ActorModel } from '@server/models/activitypub/actor'
|
||||
import { MOAuthClient } from '@server/types/models'
|
||||
import { MOAuthTokenUser } from '@server/types/models/oauth/oauth-token'
|
||||
import { MUser } from '@server/types/models/user/user'
|
||||
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'
|
||||
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'
|
||||
import { logger } from '../../helpers/logger'
|
||||
import { CONFIG } from '../../initializers/config'
|
||||
import { UserModel } from '../../models/account/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 }
|
||||
|
||||
const accessTokenCache = new LRUCache<string, MOAuthTokenUser>({ max: LRU_CACHE.USER_TOKENS.MAX_SIZE })
|
||||
const userHavingToken = new LRUCache<number, string>({ max: LRU_CACHE.USER_TOKENS.MAX_SIZE })
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
function deleteUserToken (userId: number, t?: Transaction) {
|
||||
clearCacheByUserId(userId)
|
||||
|
||||
return OAuthTokenModel.deleteUserToken(userId, t)
|
||||
type TokenInfo = {
|
||||
accessToken: string
|
||||
refreshToken: string
|
||||
accessTokenExpiresAt: Date
|
||||
refreshTokenExpiresAt: Date
|
||||
}
|
||||
|
||||
function clearCacheByUserId (userId: number) {
|
||||
const token = userHavingToken.get(userId)
|
||||
|
||||
if (token !== undefined) {
|
||||
accessTokenCache.del(token)
|
||||
userHavingToken.del(userId)
|
||||
}
|
||||
}
|
||||
|
||||
function clearCacheByToken (token: string) {
|
||||
const tokenModel = accessTokenCache.get(token)
|
||||
|
||||
if (tokenModel !== undefined) {
|
||||
userHavingToken.del(tokenModel.userId)
|
||||
accessTokenCache.del(token)
|
||||
export type BypassLogin = {
|
||||
bypass: boolean
|
||||
pluginName: string
|
||||
authName?: string
|
||||
user: {
|
||||
username: string
|
||||
email: string
|
||||
displayName: string
|
||||
role: UserRole
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -54,15 +40,12 @@ async function getAccessToken (bearerToken: string) {
|
|||
|
||||
let tokenModel: MOAuthTokenUser
|
||||
|
||||
if (accessTokenCache.has(bearerToken)) {
|
||||
tokenModel = accessTokenCache.get(bearerToken)
|
||||
if (TokensCache.Instance.hasToken(bearerToken)) {
|
||||
tokenModel = TokensCache.Instance.getByToken(bearerToken)
|
||||
} else {
|
||||
tokenModel = await OAuthTokenModel.getByTokenAndPopulateUser(bearerToken)
|
||||
|
||||
if (tokenModel) {
|
||||
accessTokenCache.set(bearerToken, tokenModel)
|
||||
userHavingToken.set(tokenModel.userId, tokenModel.accessToken)
|
||||
}
|
||||
if (tokenModel) TokensCache.Instance.setToken(tokenModel)
|
||||
}
|
||||
|
||||
if (!tokenModel) return undefined
|
||||
|
|
@ -99,16 +82,13 @@ async function getRefreshToken (refreshToken: string) {
|
|||
return tokenInfo
|
||||
}
|
||||
|
||||
async function getUser (usernameOrEmail?: string, password?: string) {
|
||||
const res: express.Response = this.request.res
|
||||
|
||||
async function getUser (usernameOrEmail?: string, password?: string, bypassLogin?: BypassLogin) {
|
||||
// Special treatment coming from a plugin
|
||||
if (res.locals.bypassLogin && res.locals.bypassLogin.bypass === true) {
|
||||
const obj = res.locals.bypassLogin
|
||||
logger.info('Bypassing oauth login by plugin %s.', obj.pluginName)
|
||||
if (bypassLogin && bypassLogin.bypass === true) {
|
||||
logger.info('Bypassing oauth login by plugin %s.', bypassLogin.pluginName)
|
||||
|
||||
let user = await UserModel.loadByEmail(obj.user.email)
|
||||
if (!user) user = await createUserFromExternal(obj.pluginName, obj.user)
|
||||
let user = await UserModel.loadByEmail(bypassLogin.user.email)
|
||||
if (!user) user = await createUserFromExternal(bypassLogin.pluginName, bypassLogin.user)
|
||||
|
||||
// Cannot create a user
|
||||
if (!user) throw new AccessDeniedError('Cannot create such user: an actor with that name already exists.')
|
||||
|
|
@ -117,7 +97,7 @@ async function getUser (usernameOrEmail?: string, password?: string) {
|
|||
// 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
|
||||
if (user.pluginAuth !== bypassLogin.pluginName) return null
|
||||
|
||||
checkUserValidityOrThrow(user)
|
||||
|
||||
|
|
@ -143,18 +123,20 @@ async function getUser (usernameOrEmail?: string, password?: string) {
|
|||
return user
|
||||
}
|
||||
|
||||
async function revokeToken (tokenInfo: { refreshToken: string }): Promise<{ success: boolean, redirectUrl?: string }> {
|
||||
const res: express.Response = this.request.res
|
||||
async function revokeToken (
|
||||
tokenInfo: { refreshToken: string },
|
||||
explicitLogout?: boolean
|
||||
): Promise<{ success: boolean, redirectUrl?: string }> {
|
||||
const token = await OAuthTokenModel.getByRefreshTokenAndPopulateUser(tokenInfo.refreshToken)
|
||||
|
||||
if (token) {
|
||||
let redirectUrl: string
|
||||
|
||||
if (res.locals.explicitLogout === true && token.User.pluginAuth && token.authName) {
|
||||
if (explicitLogout === true && token.User.pluginAuth && token.authName) {
|
||||
redirectUrl = await PluginManager.Instance.onLogout(token.User.pluginAuth, token.authName, token.User, this.request)
|
||||
}
|
||||
|
||||
clearCacheByToken(token.accessToken)
|
||||
TokensCache.Instance.clearCacheByToken(token.accessToken)
|
||||
|
||||
token.destroy()
|
||||
.catch(err => logger.error('Cannot destroy token when revoking token.', { err }))
|
||||
|
|
@ -165,14 +147,22 @@ async function revokeToken (tokenInfo: { refreshToken: string }): Promise<{ succ
|
|||
return { success: false }
|
||||
}
|
||||
|
||||
async function saveToken (token: TokenInfo, client: OAuthClientModel, user: UserModel) {
|
||||
const res: express.Response = this.request.res
|
||||
|
||||
async function saveToken (
|
||||
token: TokenInfo,
|
||||
client: MOAuthClient,
|
||||
user: MUser,
|
||||
options: {
|
||||
refreshTokenAuthName?: string
|
||||
bypassLogin?: BypassLogin
|
||||
} = {}
|
||||
) {
|
||||
const { refreshTokenAuthName, bypassLogin } = options
|
||||
let authName: string = null
|
||||
if (res.locals.bypassLogin?.bypass === true) {
|
||||
authName = res.locals.bypassLogin.authName
|
||||
} else if (res.locals.refreshTokenAuthName) {
|
||||
authName = res.locals.refreshTokenAuthName
|
||||
|
||||
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 + '.')
|
||||
|
|
@ -199,17 +189,12 @@ async function saveToken (token: TokenInfo, client: OAuthClientModel, user: User
|
|||
refreshTokenExpiresAt: tokenCreated.refreshTokenExpiresAt,
|
||||
client,
|
||||
user,
|
||||
refresh_token_expires_in: Math.floor((tokenCreated.refreshTokenExpiresAt.getTime() - new Date().getTime()) / 1000)
|
||||
accessTokenExpiresIn: buildExpiresIn(tokenCreated.accessTokenExpiresAt),
|
||||
refreshTokenExpiresIn: buildExpiresIn(tokenCreated.refreshTokenExpiresAt)
|
||||
}
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
// See https://github.com/oauthjs/node-oauth2-server/wiki/Model-specification for the model specifications
|
||||
export {
|
||||
deleteUserToken,
|
||||
clearCacheByUserId,
|
||||
clearCacheByToken,
|
||||
getAccessToken,
|
||||
getClient,
|
||||
getRefreshToken,
|
||||
|
|
@ -218,6 +203,8 @@ export {
|
|||
saveToken
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
async function createUserFromExternal (pluginAuth: string, options: {
|
||||
username: string
|
||||
email: string
|
||||
|
|
@ -252,3 +239,7 @@ async function createUserFromExternal (pluginAuth: string, options: {
|
|||
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)
|
||||
}
|
||||
180
server/lib/auth/oauth.ts
Normal file
180
server/lib/auth/oauth.ts
Normal file
|
|
@ -0,0 +1,180 @@
|
|||
import * as express from 'express'
|
||||
import {
|
||||
InvalidClientError,
|
||||
InvalidGrantError,
|
||||
InvalidRequestError,
|
||||
Request,
|
||||
Response,
|
||||
UnauthorizedClientError,
|
||||
UnsupportedGrantTypeError
|
||||
} from 'oauth2-server'
|
||||
import { randomBytesPromise, sha1 } from '@server/helpers/core-utils'
|
||||
import { MOAuthClient } from '@server/types/models'
|
||||
import { OAUTH_LIFETIME } from '../../initializers/constants'
|
||||
import { BypassLogin, getClient, getRefreshToken, getUser, revokeToken, saveToken } from './oauth-model'
|
||||
|
||||
/**
|
||||
*
|
||||
* Reimplement some functions of OAuth2Server to inject external auth methods
|
||||
*
|
||||
*/
|
||||
|
||||
const oAuthServer = new (require('oauth2-server'))({
|
||||
accessTokenLifetime: OAUTH_LIFETIME.ACCESS_TOKEN,
|
||||
refreshTokenLifetime: OAUTH_LIFETIME.REFRESH_TOKEN,
|
||||
|
||||
// See https://github.com/oauthjs/node-oauth2-server/wiki/Model-specification for the model specifications
|
||||
model: require('./oauth-model')
|
||||
})
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
async function handleOAuthToken (req: express.Request, options: { refreshTokenAuthName?: string, bypassLogin?: BypassLogin }) {
|
||||
const request = new Request(req)
|
||||
const { refreshTokenAuthName, bypassLogin } = options
|
||||
|
||||
if (request.method !== 'POST') {
|
||||
throw new InvalidRequestError('Invalid request: method must be POST')
|
||||
}
|
||||
|
||||
if (!request.is([ 'application/x-www-form-urlencoded' ])) {
|
||||
throw new InvalidRequestError('Invalid request: content must be application/x-www-form-urlencoded')
|
||||
}
|
||||
|
||||
const clientId = request.body.client_id
|
||||
const clientSecret = request.body.client_secret
|
||||
|
||||
if (!clientId || !clientSecret) {
|
||||
throw new InvalidClientError('Invalid client: cannot retrieve client credentials')
|
||||
}
|
||||
|
||||
const client = await getClient(clientId, clientSecret)
|
||||
if (!client) {
|
||||
throw new InvalidClientError('Invalid client: client is invalid')
|
||||
}
|
||||
|
||||
const grantType = request.body.grant_type
|
||||
if (!grantType) {
|
||||
throw new InvalidRequestError('Missing parameter: `grant_type`')
|
||||
}
|
||||
|
||||
if (![ 'password', 'refresh_token' ].includes(grantType)) {
|
||||
throw new UnsupportedGrantTypeError('Unsupported grant type: `grant_type` is invalid')
|
||||
}
|
||||
|
||||
if (!client.grants.includes(grantType)) {
|
||||
throw new UnauthorizedClientError('Unauthorized client: `grant_type` is invalid')
|
||||
}
|
||||
|
||||
if (grantType === 'password') {
|
||||
return handlePasswordGrant({
|
||||
request,
|
||||
client,
|
||||
bypassLogin
|
||||
})
|
||||
}
|
||||
|
||||
return handleRefreshGrant({
|
||||
request,
|
||||
client,
|
||||
refreshTokenAuthName
|
||||
})
|
||||
}
|
||||
|
||||
async function handleOAuthAuthenticate (
|
||||
req: express.Request,
|
||||
res: express.Response,
|
||||
authenticateInQuery = false
|
||||
) {
|
||||
const options = authenticateInQuery
|
||||
? { allowBearerTokensInQueryString: true }
|
||||
: {}
|
||||
|
||||
return oAuthServer.authenticate(new Request(req), new Response(res), options)
|
||||
}
|
||||
|
||||
export {
|
||||
handleOAuthToken,
|
||||
handleOAuthAuthenticate
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
async function handlePasswordGrant (options: {
|
||||
request: Request
|
||||
client: MOAuthClient
|
||||
bypassLogin?: BypassLogin
|
||||
}) {
|
||||
const { request, client, bypassLogin } = options
|
||||
|
||||
if (!request.body.username) {
|
||||
throw new InvalidRequestError('Missing parameter: `username`')
|
||||
}
|
||||
|
||||
if (!bypassLogin && !request.body.password) {
|
||||
throw new InvalidRequestError('Missing parameter: `password`')
|
||||
}
|
||||
|
||||
const user = await getUser(request.body.username, request.body.password, bypassLogin)
|
||||
if (!user) throw new InvalidGrantError('Invalid grant: user credentials are invalid')
|
||||
|
||||
const token = await buildToken()
|
||||
|
||||
return saveToken(token, client, user, { bypassLogin })
|
||||
}
|
||||
|
||||
async function handleRefreshGrant (options: {
|
||||
request: Request
|
||||
client: MOAuthClient
|
||||
refreshTokenAuthName: string
|
||||
}) {
|
||||
const { request, client, refreshTokenAuthName } = options
|
||||
|
||||
if (!request.body.refresh_token) {
|
||||
throw new InvalidRequestError('Missing parameter: `refresh_token`')
|
||||
}
|
||||
|
||||
const refreshToken = await getRefreshToken(request.body.refresh_token)
|
||||
|
||||
if (!refreshToken) {
|
||||
throw new InvalidGrantError('Invalid grant: refresh token is invalid')
|
||||
}
|
||||
|
||||
if (refreshToken.client.id !== client.id) {
|
||||
throw new InvalidGrantError('Invalid grant: refresh token is invalid')
|
||||
}
|
||||
|
||||
if (refreshToken.refreshTokenExpiresAt && refreshToken.refreshTokenExpiresAt < new Date()) {
|
||||
throw new InvalidGrantError('Invalid grant: refresh token has expired')
|
||||
}
|
||||
|
||||
await revokeToken({ refreshToken: refreshToken.refreshToken })
|
||||
|
||||
const token = await buildToken()
|
||||
|
||||
return saveToken(token, client, refreshToken.user, { refreshTokenAuthName })
|
||||
}
|
||||
|
||||
function generateRandomToken () {
|
||||
return randomBytesPromise(256)
|
||||
.then(buffer => sha1(buffer))
|
||||
}
|
||||
|
||||
function getTokenExpiresAt (type: 'access' | 'refresh') {
|
||||
const lifetime = type === 'access'
|
||||
? OAUTH_LIFETIME.ACCESS_TOKEN
|
||||
: OAUTH_LIFETIME.REFRESH_TOKEN
|
||||
|
||||
return new Date(Date.now() + lifetime * 1000)
|
||||
}
|
||||
|
||||
async function buildToken () {
|
||||
const [ accessToken, refreshToken ] = await Promise.all([ generateRandomToken(), generateRandomToken() ])
|
||||
|
||||
return {
|
||||
accessToken,
|
||||
refreshToken,
|
||||
accessTokenExpiresAt: getTokenExpiresAt('access'),
|
||||
refreshTokenExpiresAt: getTokenExpiresAt('refresh')
|
||||
}
|
||||
}
|
||||
52
server/lib/auth/tokens-cache.ts
Normal file
52
server/lib/auth/tokens-cache.ts
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
import * as LRUCache from 'lru-cache'
|
||||
import { MOAuthTokenUser } from '@server/types/models'
|
||||
import { LRU_CACHE } from '../../initializers/constants'
|
||||
|
||||
export class TokensCache {
|
||||
|
||||
private static instance: TokensCache
|
||||
|
||||
private readonly accessTokenCache = new LRUCache<string, MOAuthTokenUser>({ max: LRU_CACHE.USER_TOKENS.MAX_SIZE })
|
||||
private readonly userHavingToken = new LRUCache<number, string>({ max: LRU_CACHE.USER_TOKENS.MAX_SIZE })
|
||||
|
||||
private constructor () { }
|
||||
|
||||
static get Instance () {
|
||||
return this.instance || (this.instance = new this())
|
||||
}
|
||||
|
||||
hasToken (token: string) {
|
||||
return this.accessTokenCache.has(token)
|
||||
}
|
||||
|
||||
getByToken (token: string) {
|
||||
return this.accessTokenCache.get(token)
|
||||
}
|
||||
|
||||
setToken (token: MOAuthTokenUser) {
|
||||
this.accessTokenCache.set(token.accessToken, token)
|
||||
this.userHavingToken.set(token.userId, token.accessToken)
|
||||
}
|
||||
|
||||
deleteUserToken (userId: number) {
|
||||
this.clearCacheByUserId(userId)
|
||||
}
|
||||
|
||||
clearCacheByUserId (userId: number) {
|
||||
const token = this.userHavingToken.get(userId)
|
||||
|
||||
if (token !== undefined) {
|
||||
this.accessTokenCache.del(token)
|
||||
this.userHavingToken.del(userId)
|
||||
}
|
||||
}
|
||||
|
||||
clearCacheByToken (token: string) {
|
||||
const tokenModel = this.accessTokenCache.get(token)
|
||||
|
||||
if (tokenModel !== undefined) {
|
||||
this.userHavingToken.del(tokenModel.userId)
|
||||
this.accessTokenCache.del(token)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -7,7 +7,7 @@ import {
|
|||
VIDEO_PLAYLIST_PRIVACIES,
|
||||
VIDEO_PRIVACIES
|
||||
} from '@server/initializers/constants'
|
||||
import { onExternalUserAuthenticated } from '@server/lib/auth'
|
||||
import { onExternalUserAuthenticated } from '@server/lib/auth/external-auth'
|
||||
import { PluginModel } from '@server/models/server/plugin'
|
||||
import {
|
||||
RegisterServerAuthExternalOptions,
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue