X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fmodels%2Foauth%2Foauth-token.ts;h=af4b0ec421daf6cacdca629207996e7479f1ca4d;hb=20213fbd2a366dffc35aa7dddad71323893f8d62;hp=dc8bcd872aa15b416cfd26c875d086acb93eb884;hpb=72c7248b6fdcdb2175e726ff51b42e7555f2bd84;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/models/oauth/oauth-token.ts b/server/models/oauth/oauth-token.ts index dc8bcd872..af4b0ec42 100644 --- a/server/models/oauth/oauth-token.ts +++ b/server/models/oauth/oauth-token.ts @@ -1,182 +1,220 @@ -import * as Sequelize from 'sequelize' - -import { logger } from '../../helpers' - -import { addMethodsToModel } from '../utils' +import { Transaction } from 'sequelize' import { - OAuthTokenInstance, - OAuthTokenAttributes, - - OAuthTokenMethods, - OAuthTokenInfo -} from './oauth-token-interface' + AfterDestroy, + AfterUpdate, + AllowNull, + BelongsTo, + Column, + CreatedAt, + ForeignKey, + Model, + Scopes, + Table, + UpdatedAt +} from 'sequelize-typescript' +import { TokensCache } from '@server/lib/auth/tokens-cache' +import { MUserAccountId } from '@server/types/models' +import { MOAuthTokenUser } from '@server/types/models/oauth/oauth-token' +import { AttributesOnly } from '@shared/core-utils' +import { logger } from '../../helpers/logger' +import { AccountModel } from '../account/account' +import { ActorModel } from '../actor/actor' +import { UserModel } from '../user/user' +import { OAuthClientModel } from './oauth-client' + +export type OAuthTokenInfo = { + refreshToken: string + refreshTokenExpiresAt: Date + client: { + id: number + } + user: MUserAccountId + token: MOAuthTokenUser +} -let OAuthToken: Sequelize.Model -let getByRefreshTokenAndPopulateClient: OAuthTokenMethods.GetByRefreshTokenAndPopulateClient -let getByTokenAndPopulateUser: OAuthTokenMethods.GetByTokenAndPopulateUser -let getByRefreshTokenAndPopulateUser: OAuthTokenMethods.GetByRefreshTokenAndPopulateUser -let removeByUserId: OAuthTokenMethods.RemoveByUserId +enum ScopeNames { + WITH_USER = 'WITH_USER' +} -export default function (sequelize: Sequelize.Sequelize, DataTypes: Sequelize.DataTypes) { - OAuthToken = sequelize.define('OAuthToken', - { - accessToken: { - type: DataTypes.STRING, - allowNull: false - }, - accessTokenExpiresAt: { - type: DataTypes.DATE, - allowNull: false - }, - refreshToken: { - type: DataTypes.STRING, - allowNull: false - }, - refreshTokenExpiresAt: { - type: DataTypes.DATE, - allowNull: false +@Scopes(() => ({ + [ScopeNames.WITH_USER]: { + include: [ + { + model: UserModel.unscoped(), + required: true, + include: [ + { + attributes: [ 'id' ], + model: AccountModel.unscoped(), + required: true, + include: [ + { + attributes: [ 'id', 'url' ], + model: ActorModel.unscoped(), + required: true + } + ] + } + ] } + ] + } +})) +@Table({ + tableName: 'oAuthToken', + indexes: [ + { + fields: [ 'refreshToken' ], + unique: true + }, + { + fields: [ 'accessToken' ], + unique: true + }, + { + fields: [ 'userId' ] }, { - indexes: [ - { - fields: [ 'refreshToken' ], - unique: true - }, - { - fields: [ 'accessToken' ], - unique: true - }, - { - fields: [ 'userId' ] - }, - { - fields: [ 'oAuthClientId' ] - } - ] + fields: [ 'oAuthClientId' ] } - ) + ] +}) +export class OAuthTokenModel extends Model>> { - const classMethods = [ - associate, + @AllowNull(false) + @Column + accessToken: string - getByRefreshTokenAndPopulateClient, - getByTokenAndPopulateUser, - getByRefreshTokenAndPopulateUser, - removeByUserId - ] - addMethodsToModel(OAuthToken, classMethods) + @AllowNull(false) + @Column + accessTokenExpiresAt: Date - return OAuthToken -} + @AllowNull(false) + @Column + refreshToken: string + + @AllowNull(false) + @Column + refreshTokenExpiresAt: Date -// --------------------------------------------------------------------------- + @Column + authName: string -function associate (models) { - OAuthToken.belongsTo(models.User, { + @CreatedAt + createdAt: Date + + @UpdatedAt + updatedAt: Date + + @ForeignKey(() => UserModel) + @Column + userId: number + + @BelongsTo(() => UserModel, { foreignKey: { - name: 'userId', allowNull: false }, onDelete: 'cascade' }) + User: UserModel - OAuthToken.belongsTo(models.OAuthClient, { + @ForeignKey(() => OAuthClientModel) + @Column + oAuthClientId: number + + @BelongsTo(() => OAuthClientModel, { foreignKey: { - name: 'oAuthClientId', allowNull: false }, onDelete: 'cascade' }) -} + OAuthClients: OAuthClientModel[] -getByRefreshTokenAndPopulateClient = function (refreshToken: string) { - const query = { - where: { - refreshToken: refreshToken - }, - include: [ OAuthToken['sequelize'].models.OAuthClient ] + @AfterUpdate + @AfterDestroy + static removeTokenCache (token: OAuthTokenModel) { + return TokensCache.Instance.clearCacheByToken(token.accessToken) } - return OAuthToken.findOne(query) - .then(token => { - if (!token) return null - - const tokenInfos: OAuthTokenInfo = { - refreshToken: token.refreshToken, - refreshTokenExpiresAt: token.refreshTokenExpiresAt, - client: { - id: token.oAuthClientId - }, - user: { - id: token.userId - } - } - - return tokenInfos - }) - .catch(err => { - logger.info('getRefreshToken error.', err) - throw err - }) -} + static loadByRefreshToken (refreshToken: string) { + const query = { + where: { refreshToken } + } -getByTokenAndPopulateUser = function (bearerToken: string) { - const query = { - where: { - accessToken: bearerToken - }, - include: [ - { - model: OAuthToken['sequelize'].models.User, - include: [ - { - model: OAuthToken['sequelize'].models.Author, - required: true - } - ] - } - ] + return OAuthTokenModel.findOne(query) } - return OAuthToken.findOne(query).then(token => { - if (token) token['user'] = token.User + static getByRefreshTokenAndPopulateClient (refreshToken: string) { + const query = { + where: { + refreshToken + }, + include: [ OAuthClientModel ] + } - return token - }) -} + return OAuthTokenModel.scope(ScopeNames.WITH_USER) + .findOne(query) + .then(token => { + if (!token) return null + + return { + refreshToken: token.refreshToken, + refreshTokenExpiresAt: token.refreshTokenExpiresAt, + client: { + id: token.oAuthClientId + }, + user: token.User, + token + } as OAuthTokenInfo + }) + .catch(err => { + logger.error('getRefreshToken error.', { err }) + throw err + }) + } -getByRefreshTokenAndPopulateUser = function (refreshToken: string) { - const query = { - where: { - refreshToken: refreshToken - }, - include: [ - { - model: OAuthToken['sequelize'].models.User, - include: [ - { - model: OAuthToken['sequelize'].models.Author, - required: true - } - ] + static getByTokenAndPopulateUser (bearerToken: string): Promise { + const query = { + where: { + accessToken: bearerToken } - ] - } + } - return OAuthToken.findOne(query).then(token => { - token['user'] = token.User + return OAuthTokenModel.scope(ScopeNames.WITH_USER) + .findOne(query) + .then(token => { + if (!token) return null - return token - }) -} + return Object.assign(token, { user: token.User }) + }) + } -removeByUserId = function (userId: number) { - const query = { - where: { - userId: userId + static getByRefreshTokenAndPopulateUser (refreshToken: string): Promise { + const query = { + where: { + refreshToken + } } + + return OAuthTokenModel.scope(ScopeNames.WITH_USER) + .findOne(query) + .then(token => { + if (!token) return undefined + + return Object.assign(token, { user: token.User }) + }) } - return OAuthToken.destroy(query) + static deleteUserToken (userId: number, t?: Transaction) { + TokensCache.Instance.deleteUserToken(userId) + + const query = { + where: { + userId + }, + transaction: t + } + + return OAuthTokenModel.destroy(query) + } }