1 import * as express from 'express'
2 import * as RateLimit from 'express-rate-limit'
3 import { v4 as uuidv4 } from 'uuid'
4 import { logger } from '@server/helpers/logger'
5 import { CONFIG } from '@server/initializers/config'
6 import { getAuthNameFromRefreshGrant, getBypassFromExternalAuth, getBypassFromPasswordGrant } from '@server/lib/auth/external-auth'
7 import { handleOAuthToken } from '@server/lib/auth/oauth'
8 import { BypassLogin, revokeToken } from '@server/lib/auth/oauth-model'
9 import { Hooks } from '@server/lib/plugins/hooks'
10 import { asyncMiddleware, authenticate } from '@server/middlewares'
11 import { ScopedToken } from '@shared/models/users/user-scoped-token'
13 const tokensRouter = express.Router()
15 const loginRateLimiter = RateLimit({
16 windowMs: CONFIG.RATES_LIMIT.LOGIN.WINDOW_MS,
17 max: CONFIG.RATES_LIMIT.LOGIN.MAX
20 tokensRouter.post('/token',
22 asyncMiddleware(handleToken)
25 tokensRouter.post('/revoke-token',
27 asyncMiddleware(handleTokenRevocation)
30 tokensRouter.get('/scoped-tokens',
35 tokensRouter.post('/scoped-tokens',
37 asyncMiddleware(renewScopedTokens)
40 // ---------------------------------------------------------------------------
45 // ---------------------------------------------------------------------------
47 async function handleToken (req: express.Request, res: express.Response, next: express.NextFunction) {
48 const grantType = req.body.grant_type
51 const bypassLogin = await buildByPassLogin(req, grantType)
53 const refreshTokenAuthName = grantType === 'refresh_token'
54 ? await getAuthNameFromRefreshGrant(req.body.refresh_token)
62 const token = await handleOAuthToken(req, options)
64 res.set('Cache-Control', 'no-store')
65 res.set('Pragma', 'no-cache')
67 Hooks.runAction('action:api.user.oauth2-got-token', { username: token.user.username, ip: req.ip })
72 access_token: token.accessToken,
73 refresh_token: token.refreshToken,
75 expires_in: token.accessTokenExpiresIn,
76 refresh_token_expires_in: token.refreshTokenExpiresIn
79 logger.warn('Login error', { err })
81 return res.status(err.code || 400).json({
88 async function handleTokenRevocation (req: express.Request, res: express.Response) {
89 const token = res.locals.oauth.token
91 const result = await revokeToken(token, { req, explicitLogout: true })
93 return res.json(result)
96 function getScopedTokens (req: express.Request, res: express.Response) {
97 const user = res.locals.oauth.token.user
100 feedToken: user.feedToken
104 async function renewScopedTokens (req: express.Request, res: express.Response) {
105 const user = res.locals.oauth.token.user
107 user.feedToken = uuidv4()
111 feedToken: user.feedToken
115 async function buildByPassLogin (req: express.Request, grantType: string): Promise<BypassLogin> {
116 if (grantType !== 'password') return undefined
118 if (req.body.externalAuthToken) {
119 // Consistency with the getBypassFromPasswordGrant promise
120 return getBypassFromExternalAuth(req.body.username, req.body.externalAuthToken)
123 return getBypassFromPasswordGrant(req.body.username, req.body.password)