]>
Commit | Line | Data |
---|---|---|
4a8d113b | 1 | import { isUserDisplayNameValid, isUserRoleValid, isUserUsernameValid } from '@server/helpers/custom-validators/users' |
7fed6375 | 2 | import { logger } from '@server/helpers/logger' |
4a8d113b | 3 | import { generateRandomString } from '@server/helpers/utils' |
9107d791 | 4 | import { OAUTH_LIFETIME, PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME } from '@server/initializers/constants' |
e1c55031 | 5 | import { revokeToken } from '@server/lib/oauth-model' |
4a8d113b | 6 | import { PluginManager } from '@server/lib/plugins/plugin-manager' |
e307e4fc | 7 | import { OAuthTokenModel } from '@server/models/oauth/oauth-token' |
4a8d113b C |
8 | import { UserRole } from '@shared/models' |
9 | import { | |
10 | RegisterServerAuthenticatedResult, | |
11 | RegisterServerAuthPassOptions, | |
12 | RegisterServerExternalAuthenticatedResult | |
13 | } from '@shared/models/plugins/register-server-auth.model' | |
14 | import * as express from 'express' | |
15 | import * as OAuthServer from 'express-oauth-server' | |
7fed6375 C |
16 | |
17 | const oAuthServer = new OAuthServer({ | |
18 | useErrorHandler: true, | |
19 | accessTokenLifetime: OAUTH_LIFETIME.ACCESS_TOKEN, | |
20 | refreshTokenLifetime: OAUTH_LIFETIME.REFRESH_TOKEN, | |
21 | continueMiddleware: true, | |
22 | model: require('./oauth-model') | |
23 | }) | |
24 | ||
4a8d113b C |
25 | // Token is the key, expiration date is the value |
26 | const authBypassTokens = new Map<string, { | |
27 | expires: Date | |
28 | user: { | |
29 | username: string | |
30 | email: string | |
31 | displayName: string | |
32 | role: UserRole | |
33 | } | |
34 | authName: string | |
35 | npmName: string | |
36 | }>() | |
7fed6375 | 37 | |
9107d791 | 38 | async function handleLogin (req: express.Request, res: express.Response, next: express.NextFunction) { |
e307e4fc C |
39 | const grantType = req.body.grant_type |
40 | ||
4a8d113b C |
41 | if (grantType === 'password') { |
42 | if (req.body.externalAuthToken) proxifyExternalAuthBypass(req, res) | |
43 | else await proxifyPasswordGrant(req, res) | |
44 | } else if (grantType === 'refresh_token') { | |
45 | await proxifyRefreshGrant(req, res) | |
46 | } | |
e307e4fc C |
47 | |
48 | return forwardTokenReq(req, res, next) | |
49 | } | |
50 | ||
51 | async function handleTokenRevocation (req: express.Request, res: express.Response) { | |
52 | const token = res.locals.oauth.token | |
53 | ||
54 | res.locals.explicitLogout = true | |
55 | await revokeToken(token) | |
56 | ||
57 | // FIXME: uncomment when https://github.com/oauthjs/node-oauth2-server/pull/289 is released | |
58 | // oAuthServer.revoke(req, res, err => { | |
59 | // if (err) { | |
60 | // logger.warn('Error in revoke token handler.', { err }) | |
61 | // | |
62 | // return res.status(err.status) | |
63 | // .json({ | |
64 | // error: err.message, | |
65 | // code: err.name | |
66 | // }) | |
67 | // .end() | |
68 | // } | |
69 | // }) | |
70 | ||
71 | return res.sendStatus(200) | |
72 | } | |
73 | ||
4a8d113b C |
74 | async function onExternalUserAuthenticated (options: { |
75 | npmName: string | |
76 | authName: string | |
77 | authResult: RegisterServerExternalAuthenticatedResult | |
78 | }) { | |
79 | const { npmName, authName, authResult } = options | |
e307e4fc | 80 | |
4a8d113b C |
81 | if (!authResult.req || !authResult.res) { |
82 | logger.error('Cannot authenticate external user for auth %s of plugin %s: no req or res are provided.', authName, npmName) | |
83 | return | |
84 | } | |
85 | ||
86 | if (!isAuthResultValid(npmName, authName, authResult)) return | |
87 | ||
88 | const { res } = authResult | |
89 | ||
90 | logger.info('Generating auth bypass token for %s in auth %s of plugin %s.', authResult.username, authName, npmName) | |
91 | ||
92 | const bypassToken = await generateRandomString(32) | |
4a8d113b C |
93 | |
94 | const expires = new Date() | |
9107d791 | 95 | expires.setTime(expires.getTime() + PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME) |
4a8d113b C |
96 | |
97 | const user = buildUserResult(authResult) | |
98 | authBypassTokens.set(bypassToken, { | |
99 | expires, | |
100 | user, | |
101 | npmName, | |
102 | authName | |
103 | }) | |
104 | ||
105 | res.redirect(`/login?externalAuthToken=${bypassToken}&username=${user.username}`) | |
e307e4fc C |
106 | } |
107 | ||
108 | // --------------------------------------------------------------------------- | |
109 | ||
9107d791 | 110 | export { oAuthServer, handleLogin, onExternalUserAuthenticated, handleTokenRevocation } |
4a8d113b C |
111 | |
112 | // --------------------------------------------------------------------------- | |
113 | ||
114 | function forwardTokenReq (req: express.Request, res: express.Response, next?: express.NextFunction) { | |
e307e4fc C |
115 | return oAuthServer.token()(req, res, err => { |
116 | if (err) { | |
117 | logger.warn('Login error.', { err }) | |
118 | ||
119 | return res.status(err.status) | |
4a8d113b C |
120 | .json({ |
121 | error: err.message, | |
122 | code: err.name | |
123 | }) | |
e307e4fc C |
124 | } |
125 | ||
4a8d113b | 126 | if (next) return next() |
e307e4fc C |
127 | }) |
128 | } | |
129 | ||
130 | async function proxifyRefreshGrant (req: express.Request, res: express.Response) { | |
131 | const refreshToken = req.body.refresh_token | |
132 | if (!refreshToken) return | |
133 | ||
134 | const tokenModel = await OAuthTokenModel.loadByRefreshToken(refreshToken) | |
135 | if (tokenModel?.authName) res.locals.refreshTokenAuthName = tokenModel.authName | |
136 | } | |
137 | ||
138 | async function proxifyPasswordGrant (req: express.Request, res: express.Response) { | |
7fed6375 C |
139 | const plugins = PluginManager.Instance.getIdAndPassAuths() |
140 | const pluginAuths: { npmName?: string, registerAuthOptions: RegisterServerAuthPassOptions }[] = [] | |
141 | ||
142 | for (const plugin of plugins) { | |
143 | const auths = plugin.idAndPassAuths | |
144 | ||
145 | for (const auth of auths) { | |
146 | pluginAuths.push({ | |
147 | npmName: plugin.npmName, | |
148 | registerAuthOptions: auth | |
149 | }) | |
150 | } | |
151 | } | |
152 | ||
153 | pluginAuths.sort((a, b) => { | |
154 | const aWeight = a.registerAuthOptions.getWeight() | |
155 | const bWeight = b.registerAuthOptions.getWeight() | |
156 | ||
e1c55031 | 157 | // DESC weight order |
7fed6375 | 158 | if (aWeight === bWeight) return 0 |
e1c55031 | 159 | if (aWeight < bWeight) return 1 |
7fed6375 C |
160 | return -1 |
161 | }) | |
162 | ||
163 | const loginOptions = { | |
164 | id: req.body.username, | |
165 | password: req.body.password | |
166 | } | |
167 | ||
168 | for (const pluginAuth of pluginAuths) { | |
e1c55031 | 169 | const authOptions = pluginAuth.registerAuthOptions |
98813e69 C |
170 | const authName = authOptions.authName |
171 | const npmName = pluginAuth.npmName | |
e1c55031 | 172 | |
7fed6375 | 173 | logger.debug( |
e1c55031 | 174 | 'Using auth method %s of plugin %s to login %s with weight %d.', |
98813e69 | 175 | authName, npmName, loginOptions.id, authOptions.getWeight() |
7fed6375 C |
176 | ) |
177 | ||
055cfb11 C |
178 | try { |
179 | const loginResult = await authOptions.login(loginOptions) | |
4a8d113b C |
180 | |
181 | if (!loginResult) continue | |
182 | if (!isAuthResultValid(pluginAuth.npmName, authOptions.authName, loginResult)) continue | |
183 | ||
184 | logger.info( | |
185 | 'Login success with auth method %s of plugin %s for %s.', | |
186 | authName, npmName, loginOptions.id | |
187 | ) | |
188 | ||
189 | res.locals.bypassLogin = { | |
190 | bypass: true, | |
191 | pluginName: pluginAuth.npmName, | |
192 | authName: authOptions.authName, | |
193 | user: buildUserResult(loginResult) | |
055cfb11 | 194 | } |
4a8d113b C |
195 | |
196 | return | |
055cfb11 C |
197 | } catch (err) { |
198 | logger.error('Error in auth method %s of plugin %s', authOptions.authName, pluginAuth.npmName, { err }) | |
7fed6375 C |
199 | } |
200 | } | |
7fed6375 | 201 | } |
4a8d113b C |
202 | |
203 | function proxifyExternalAuthBypass (req: express.Request, res: express.Response) { | |
204 | const obj = authBypassTokens.get(req.body.externalAuthToken) | |
205 | if (!obj) { | |
206 | logger.error('Cannot authenticate user with unknown bypass token') | |
207 | return res.sendStatus(400) | |
208 | } | |
209 | ||
210 | const { expires, user, authName, npmName } = obj | |
211 | ||
212 | const now = new Date() | |
213 | if (now.getTime() > expires.getTime()) { | |
9107d791 | 214 | logger.error('Cannot authenticate user with an expired external auth token') |
4a8d113b C |
215 | return res.sendStatus(400) |
216 | } | |
217 | ||
218 | if (user.username !== req.body.username) { | |
219 | logger.error('Cannot authenticate user %s with invalid username %s.', req.body.username) | |
220 | return res.sendStatus(400) | |
221 | } | |
222 | ||
223 | // Bypass oauth library validation | |
224 | req.body.password = 'fake' | |
225 | ||
226 | logger.info( | |
227 | 'Auth success with external auth method %s of plugin %s for %s.', | |
228 | authName, npmName, user.email | |
229 | ) | |
230 | ||
231 | res.locals.bypassLogin = { | |
232 | bypass: true, | |
233 | pluginName: npmName, | |
234 | authName: authName, | |
235 | user | |
236 | } | |
237 | } | |
238 | ||
239 | function isAuthResultValid (npmName: string, authName: string, result: RegisterServerAuthenticatedResult) { | |
240 | if (!isUserUsernameValid(result.username)) { | |
241 | logger.error('Auth method %s of plugin %s did not provide a valid username.', authName, npmName, { result }) | |
242 | return false | |
243 | } | |
244 | ||
245 | if (!result.email) { | |
246 | logger.error('Auth method %s of plugin %s did not provide a valid email.', authName, npmName, { result }) | |
247 | return false | |
248 | } | |
249 | ||
250 | // role is optional | |
251 | if (result.role && !isUserRoleValid(result.role)) { | |
252 | logger.error('Auth method %s of plugin %s did not provide a valid role.', authName, npmName, { result }) | |
253 | return false | |
254 | } | |
255 | ||
256 | // display name is optional | |
257 | if (result.displayName && !isUserDisplayNameValid(result.displayName)) { | |
258 | logger.error('Auth method %s of plugin %s did not provide a valid display name.', authName, npmName, { result }) | |
259 | return false | |
260 | } | |
261 | ||
262 | return true | |
263 | } | |
264 | ||
265 | function buildUserResult (pluginResult: RegisterServerAuthenticatedResult) { | |
266 | return { | |
267 | username: pluginResult.username, | |
268 | email: pluginResult.email, | |
9107d791 | 269 | role: pluginResult.role ?? UserRole.USER, |
4a8d113b C |
270 | displayName: pluginResult.displayName || pluginResult.username |
271 | } | |
272 | } |