]>
Commit | Line | Data |
---|---|---|
7fed6375 | 1 | import * as express from 'express' |
141b177d | 2 | import { AccessDeniedError } from 'oauth2-server' |
da854ddd | 3 | import { logger } from '../helpers/logger' |
3fd3ab2d C |
4 | import { UserModel } from '../models/account/user' |
5 | import { OAuthClientModel } from '../models/oauth/oauth-client' | |
6 | import { OAuthTokenModel } from '../models/oauth/oauth-token' | |
557b13ae | 7 | import { LRU_CACHE } from '../initializers/constants' |
f201a749 | 8 | import { Transaction } from 'sequelize' |
6dd9de95 | 9 | import { CONFIG } from '../initializers/config' |
557b13ae | 10 | import * as LRUCache from 'lru-cache' |
26d6bf65 C |
11 | import { MOAuthTokenUser } from '@server/types/models/oauth/oauth-token' |
12 | import { MUser } from '@server/types/models/user/user' | |
7fed6375 C |
13 | import { UserAdminFlag } from '@shared/models/users/user-flag.model' |
14 | import { createUserAccountAndChannelAndPlaylist } from './user' | |
15 | import { UserRole } from '@shared/models/users/user-role' | |
e1c55031 | 16 | import { PluginManager } from '@server/lib/plugins/plugin-manager' |
9a7fd960 | 17 | import { ActorModel } from '@server/models/activitypub/actor' |
69b0a27c | 18 | |
69818c93 | 19 | type TokenInfo = { accessToken: string, refreshToken: string, accessTokenExpiresAt: Date, refreshTokenExpiresAt: Date } |
557b13ae | 20 | |
453e83ea | 21 | const accessTokenCache = new LRUCache<string, MOAuthTokenUser>({ max: LRU_CACHE.USER_TOKENS.MAX_SIZE }) |
557b13ae | 22 | const userHavingToken = new LRUCache<number, string>({ max: LRU_CACHE.USER_TOKENS.MAX_SIZE }) |
69818c93 | 23 | |
69b0a27c C |
24 | // --------------------------------------------------------------------------- |
25 | ||
f201a749 C |
26 | function deleteUserToken (userId: number, t?: Transaction) { |
27 | clearCacheByUserId(userId) | |
28 | ||
29 | return OAuthTokenModel.deleteUserToken(userId, t) | |
30 | } | |
31 | ||
32 | function clearCacheByUserId (userId: number) { | |
557b13ae C |
33 | const token = userHavingToken.get(userId) |
34 | ||
f201a749 | 35 | if (token !== undefined) { |
557b13ae C |
36 | accessTokenCache.del(token) |
37 | userHavingToken.del(userId) | |
f201a749 C |
38 | } |
39 | } | |
40 | ||
41 | function clearCacheByToken (token: string) { | |
557b13ae C |
42 | const tokenModel = accessTokenCache.get(token) |
43 | ||
f201a749 | 44 | if (tokenModel !== undefined) { |
557b13ae C |
45 | userHavingToken.del(tokenModel.userId) |
46 | accessTokenCache.del(token) | |
f201a749 C |
47 | } |
48 | } | |
49 | ||
e307e4fc | 50 | async function getAccessToken (bearerToken: string) { |
69b0a27c C |
51 | logger.debug('Getting access token (bearerToken: ' + bearerToken + ').') |
52 | ||
e307e4fc | 53 | if (!bearerToken) return undefined |
3acc5084 | 54 | |
e307e4fc | 55 | let tokenModel: MOAuthTokenUser |
f201a749 | 56 | |
e307e4fc C |
57 | if (accessTokenCache.has(bearerToken)) { |
58 | tokenModel = accessTokenCache.get(bearerToken) | |
59 | } else { | |
60 | tokenModel = await OAuthTokenModel.getByTokenAndPopulateUser(bearerToken) | |
7fed6375 | 61 | |
e307e4fc C |
62 | if (tokenModel) { |
63 | accessTokenCache.set(bearerToken, tokenModel) | |
64 | userHavingToken.set(tokenModel.userId, tokenModel.accessToken) | |
65 | } | |
66 | } | |
67 | ||
68 | if (!tokenModel) return undefined | |
69 | ||
70 | if (tokenModel.User.pluginAuth) { | |
71 | const valid = await PluginManager.Instance.isTokenValid(tokenModel, 'access') | |
72 | ||
73 | if (valid !== true) return undefined | |
74 | } | |
75 | ||
76 | return tokenModel | |
69b0a27c C |
77 | } |
78 | ||
69818c93 | 79 | function getClient (clientId: string, clientSecret: string) { |
69b0a27c C |
80 | logger.debug('Getting Client (clientId: ' + clientId + ', clientSecret: ' + clientSecret + ').') |
81 | ||
3fd3ab2d | 82 | return OAuthClientModel.getByIdAndSecret(clientId, clientSecret) |
69b0a27c C |
83 | } |
84 | ||
e307e4fc | 85 | async function getRefreshToken (refreshToken: string) { |
69b0a27c C |
86 | logger.debug('Getting RefreshToken (refreshToken: ' + refreshToken + ').') |
87 | ||
e307e4fc C |
88 | const tokenInfo = await OAuthTokenModel.getByRefreshTokenAndPopulateClient(refreshToken) |
89 | if (!tokenInfo) return undefined | |
90 | ||
91 | const tokenModel = tokenInfo.token | |
92 | ||
93 | if (tokenModel.User.pluginAuth) { | |
94 | const valid = await PluginManager.Instance.isTokenValid(tokenModel, 'refresh') | |
95 | ||
96 | if (valid !== true) return undefined | |
97 | } | |
98 | ||
99 | return tokenInfo | |
69b0a27c C |
100 | } |
101 | ||
4a8d113b | 102 | async function getUser (usernameOrEmail?: string, password?: string) { |
7fed6375 | 103 | const res: express.Response = this.request.res |
e307e4fc C |
104 | |
105 | // Special treatment coming from a plugin | |
7fed6375 C |
106 | if (res.locals.bypassLogin && res.locals.bypassLogin.bypass === true) { |
107 | const obj = res.locals.bypassLogin | |
108 | logger.info('Bypassing oauth login by plugin %s.', obj.pluginName) | |
109 | ||
e1c55031 | 110 | let user = await UserModel.loadByEmail(obj.user.email) |
7fed6375 C |
111 | if (!user) user = await createUserFromExternal(obj.pluginName, obj.user) |
112 | ||
9a7fd960 C |
113 | // Cannot create a user |
114 | if (!user) throw new AccessDeniedError('Cannot create such user: an actor with that name already exists.') | |
115 | ||
e9b0fa5c C |
116 | // If the user does not belongs to a plugin, it was created before its installation |
117 | // Then we just go through a regular login process | |
118 | if (user.pluginAuth !== null) { | |
119 | // This user does not belong to this plugin, skip it | |
120 | if (user.pluginAuth !== obj.pluginName) return null | |
7fed6375 | 121 | |
e9b0fa5c C |
122 | return user |
123 | } | |
7fed6375 C |
124 | } |
125 | ||
ba12e8b3 | 126 | logger.debug('Getting User (username/email: ' + usernameOrEmail + ', password: ******).') |
69b0a27c | 127 | |
ba12e8b3 | 128 | const user = await UserModel.loadByUsernameOrEmail(usernameOrEmail) |
e1c55031 | 129 | // If we don't find the user, or if the user belongs to a plugin |
d253bfaa | 130 | if (!user || user.pluginAuth !== null || !password) return null |
26d7d31b | 131 | |
f5028693 | 132 | const passwordMatch = await user.isPasswordMatch(password) |
e9b0fa5c | 133 | if (passwordMatch !== true) return null |
26d7d31b | 134 | |
e6921918 C |
135 | if (user.blocked) throw new AccessDeniedError('User is blocked.') |
136 | ||
d9eaee39 JM |
137 | if (CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION && user.emailVerified === false) { |
138 | throw new AccessDeniedError('User email is not verified.') | |
139 | } | |
140 | ||
f5028693 | 141 | return user |
2f372a86 C |
142 | } |
143 | ||
74fd2643 | 144 | async function revokeToken (tokenInfo: { refreshToken: string }): Promise<{ success: boolean, redirectUrl?: string }> { |
e1c55031 | 145 | const res: express.Response = this.request.res |
3fd3ab2d | 146 | const token = await OAuthTokenModel.getByRefreshTokenAndPopulateUser(tokenInfo.refreshToken) |
e1c55031 | 147 | |
bfcef50d | 148 | if (token) { |
74fd2643 C |
149 | let redirectUrl: string |
150 | ||
e1c55031 | 151 | if (res.locals.explicitLogout === true && token.User.pluginAuth && token.authName) { |
74fd2643 | 152 | redirectUrl = await PluginManager.Instance.onLogout(token.User.pluginAuth, token.authName, token.User, this.request) |
e1c55031 C |
153 | } |
154 | ||
f201a749 C |
155 | clearCacheByToken(token.accessToken) |
156 | ||
bfcef50d C |
157 | token.destroy() |
158 | .catch(err => logger.error('Cannot destroy token when revoking token.', { err })) | |
7fed6375 | 159 | |
74fd2643 | 160 | return { success: true, redirectUrl } |
bfcef50d | 161 | } |
f5028693 | 162 | |
74fd2643 | 163 | return { success: false } |
69b0a27c C |
164 | } |
165 | ||
3fd3ab2d | 166 | async function saveToken (token: TokenInfo, client: OAuthClientModel, user: UserModel) { |
e1c55031 C |
167 | const res: express.Response = this.request.res |
168 | ||
e307e4fc C |
169 | let authName: string = null |
170 | if (res.locals.bypassLogin?.bypass === true) { | |
171 | authName = res.locals.bypassLogin.authName | |
172 | } else if (res.locals.refreshTokenAuthName) { | |
173 | authName = res.locals.refreshTokenAuthName | |
174 | } | |
e1c55031 | 175 | |
32bb4156 | 176 | logger.debug('Saving token ' + token.accessToken + ' for client ' + client.id + ' and user ' + user.id + '.') |
69b0a27c | 177 | |
feb4bdfd | 178 | const tokenToCreate = { |
69b0a27c | 179 | accessToken: token.accessToken, |
2f372a86 | 180 | accessTokenExpiresAt: token.accessTokenExpiresAt, |
69b0a27c | 181 | refreshToken: token.refreshToken, |
2f372a86 | 182 | refreshTokenExpiresAt: token.refreshTokenExpiresAt, |
e1c55031 | 183 | authName, |
feb4bdfd C |
184 | oAuthClientId: client.id, |
185 | userId: user.id | |
186 | } | |
69b0a27c | 187 | |
3fd3ab2d | 188 | const tokenCreated = await OAuthTokenModel.create(tokenToCreate) |
3cc665f4 C |
189 | |
190 | user.lastLoginDate = new Date() | |
191 | await user.save() | |
192 | ||
e6921918 | 193 | return Object.assign(tokenCreated, { client, user }) |
69b0a27c C |
194 | } |
195 | ||
196 | // --------------------------------------------------------------------------- | |
197 | ||
65fcc311 C |
198 | // See https://github.com/oauthjs/node-oauth2-server/wiki/Model-specification for the model specifications |
199 | export { | |
f201a749 C |
200 | deleteUserToken, |
201 | clearCacheByUserId, | |
202 | clearCacheByToken, | |
65fcc311 C |
203 | getAccessToken, |
204 | getClient, | |
205 | getRefreshToken, | |
206 | getUser, | |
207 | revokeToken, | |
208 | saveToken | |
209 | } | |
7fed6375 C |
210 | |
211 | async function createUserFromExternal (pluginAuth: string, options: { | |
212 | username: string | |
213 | email: string | |
214 | role: UserRole | |
215 | displayName: string | |
216 | }) { | |
9a7fd960 C |
217 | // Check an actor does not already exists with that name (removed user) |
218 | const actor = await ActorModel.loadLocalByName(options.username) | |
219 | if (actor) return null | |
220 | ||
7fed6375 C |
221 | const userToCreate = new UserModel({ |
222 | username: options.username, | |
223 | password: null, | |
224 | email: options.email, | |
225 | nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY, | |
226 | autoPlayVideo: true, | |
227 | role: options.role, | |
228 | videoQuota: CONFIG.USER.VIDEO_QUOTA, | |
229 | videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY, | |
230 | adminFlags: UserAdminFlag.NONE, | |
231 | pluginAuth | |
232 | }) as MUser | |
233 | ||
234 | const { user } = await createUserAccountAndChannelAndPlaylist({ | |
235 | userToCreate, | |
236 | userDisplayName: options.displayName | |
237 | }) | |
238 | ||
239 | return user | |
240 | } |