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