PeerTube/server/lib/oauth-model.ts

144 lines
4.8 KiB
TypeScript
Raw Normal View History

2018-12-26 10:36:24 +01:00
import * as Bluebird from 'bluebird'
2018-08-09 17:51:25 +02:00
import { AccessDeniedError } from 'oauth2-server'
2017-12-28 11:16:08 +01:00
import { logger } from '../helpers/logger'
2017-12-12 17:53:50 +01:00
import { UserModel } from '../models/account/user'
import { OAuthClientModel } from '../models/oauth/oauth-client'
import { OAuthTokenModel } from '../models/oauth/oauth-token'
2019-08-09 11:32:40 +02:00
import { LRU_CACHE } from '../initializers/constants'
2018-09-20 11:31:48 +02:00
import { Transaction } from 'sequelize'
2019-04-11 11:33:44 +02:00
import { CONFIG } from '../initializers/config'
2019-08-09 11:32:40 +02:00
import * as LRUCache from 'lru-cache'
2019-08-15 11:53:26 +02:00
import { MOAuthTokenUser } from '@server/typings/models/oauth/oauth-token'
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
}
}
2017-06-10 22:15:25 +02:00
function getAccessToken (bearerToken: string) {
logger.debug('Getting access token (bearerToken: ' + bearerToken + ').')
2019-04-23 09:50:57 +02:00
if (!bearerToken) return Bluebird.resolve(undefined)
2019-08-09 11:32:40 +02:00
if (accessTokenCache.has(bearerToken)) return Bluebird.resolve(accessTokenCache.get(bearerToken))
2018-09-20 11:31:48 +02:00
2017-12-12 17:53:50 +01:00
return OAuthTokenModel.getByTokenAndPopulateUser(bearerToken)
2018-09-20 11:31:48 +02:00
.then(tokenModel => {
if (tokenModel) {
2019-08-09 11:32:40 +02:00
accessTokenCache.set(bearerToken, tokenModel)
userHavingToken.set(tokenModel.userId, tokenModel.accessToken)
2018-09-20 11:31:48 +02:00
}
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)
}
2017-06-10 22:15:25 +02:00
function getRefreshToken (refreshToken: string) {
logger.debug('Getting RefreshToken (refreshToken: ' + refreshToken + ').')
2017-12-12 17:53:50 +01:00
return OAuthTokenModel.getByRefreshTokenAndPopulateClient(refreshToken)
}
2018-01-29 16:09:50 +01:00
async function getUser (usernameOrEmail: string, password: string) {
logger.debug('Getting User (username/email: ' + usernameOrEmail + ', password: ******).')
2018-01-29 16:09:50 +01:00
const user = await UserModel.loadByUsernameOrEmail(usernameOrEmail)
if (!user) return null
2016-08-25 17:57:37 +02:00
const passwordMatch = await user.isPasswordMatch(password)
if (passwordMatch === false) return null
2016-08-25 17:57:37 +02:00
2018-08-08 14:58:21 +02:00
if (user.blocked) throw new AccessDeniedError('User is blocked.')
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: TokenInfo) {
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) {
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 }))
}
/*
* Thanks to https://github.com/manjeshpv/node-oauth2-server-implementation/blob/master/components/oauth/mongo-models.js
* "As per the discussion we need set older date
* revokeToken will expected return a boolean in future version
* https://github.com/oauthjs/node-oauth2-server/pull/274
* https://github.com/oauthjs/node-oauth2-server/issues/290"
*/
const expiredToken = token
expiredToken.refreshTokenExpiresAt = new Date('2015-05-28T06:59:53.000Z')
return expiredToken
}
2017-12-12 17:53:50 +01:00
async function saveToken (token: TokenInfo, client: OAuthClientModel, user: UserModel) {
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,
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)
2018-08-08 14:58:21 +02:00
return Object.assign(tokenCreated, { client, user })
}
// ---------------------------------------------------------------------------
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
}