From 56f47830758ff8e92abcfcc5f35d474ab12fe215 Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Wed, 5 Oct 2022 15:37:15 +0200 Subject: Support two factor authentication in backend --- server/controllers/api/users/index.ts | 2 + server/controllers/api/users/token.ts | 7 ++- server/controllers/api/users/two-factor.ts | 91 ++++++++++++++++++++++++++++++ 3 files changed, 99 insertions(+), 1 deletion(-) create mode 100644 server/controllers/api/users/two-factor.ts (limited to 'server/controllers') diff --git a/server/controllers/api/users/index.ts b/server/controllers/api/users/index.ts index 07b9ae395..a8677a1d3 100644 --- a/server/controllers/api/users/index.ts +++ b/server/controllers/api/users/index.ts @@ -51,6 +51,7 @@ import { myVideosHistoryRouter } from './my-history' import { myNotificationsRouter } from './my-notifications' import { mySubscriptionsRouter } from './my-subscriptions' import { myVideoPlaylistsRouter } from './my-video-playlists' +import { twoFactorRouter } from './two-factor' const auditLogger = auditLoggerFactory('users') @@ -66,6 +67,7 @@ const askSendEmailLimiter = buildRateLimiter({ }) const usersRouter = express.Router() +usersRouter.use('/', twoFactorRouter) usersRouter.use('/', tokensRouter) usersRouter.use('/', myNotificationsRouter) usersRouter.use('/', mySubscriptionsRouter) diff --git a/server/controllers/api/users/token.ts b/server/controllers/api/users/token.ts index 012a49791..c6afea67c 100644 --- a/server/controllers/api/users/token.ts +++ b/server/controllers/api/users/token.ts @@ -1,8 +1,9 @@ import express from 'express' import { logger } from '@server/helpers/logger' import { CONFIG } from '@server/initializers/config' +import { OTP } from '@server/initializers/constants' import { getAuthNameFromRefreshGrant, getBypassFromExternalAuth, getBypassFromPasswordGrant } from '@server/lib/auth/external-auth' -import { handleOAuthToken } from '@server/lib/auth/oauth' +import { handleOAuthToken, MissingTwoFactorError } from '@server/lib/auth/oauth' import { BypassLogin, revokeToken } from '@server/lib/auth/oauth-model' import { Hooks } from '@server/lib/plugins/hooks' import { asyncMiddleware, authenticate, buildRateLimiter, openapiOperationDoc } from '@server/middlewares' @@ -79,6 +80,10 @@ async function handleToken (req: express.Request, res: express.Response, next: e } catch (err) { logger.warn('Login error', { err }) + if (err instanceof MissingTwoFactorError) { + res.set(OTP.HEADER_NAME, OTP.HEADER_REQUIRED_VALUE) + } + return res.fail({ status: err.code, message: err.message, diff --git a/server/controllers/api/users/two-factor.ts b/server/controllers/api/users/two-factor.ts new file mode 100644 index 000000000..1725294e7 --- /dev/null +++ b/server/controllers/api/users/two-factor.ts @@ -0,0 +1,91 @@ +import express from 'express' +import { generateOTPSecret, isOTPValid } from '@server/helpers/otp' +import { Redis } from '@server/lib/redis' +import { asyncMiddleware, authenticate, usersCheckCurrentPassword } from '@server/middlewares' +import { + confirmTwoFactorValidator, + disableTwoFactorValidator, + requestOrConfirmTwoFactorValidator +} from '@server/middlewares/validators/two-factor' +import { HttpStatusCode, TwoFactorEnableResult } from '@shared/models' + +const twoFactorRouter = express.Router() + +twoFactorRouter.post('/:id/two-factor/request', + authenticate, + asyncMiddleware(usersCheckCurrentPassword), + asyncMiddleware(requestOrConfirmTwoFactorValidator), + asyncMiddleware(requestTwoFactor) +) + +twoFactorRouter.post('/:id/two-factor/confirm-request', + authenticate, + asyncMiddleware(requestOrConfirmTwoFactorValidator), + confirmTwoFactorValidator, + asyncMiddleware(confirmRequestTwoFactor) +) + +twoFactorRouter.post('/:id/two-factor/disable', + authenticate, + asyncMiddleware(usersCheckCurrentPassword), + asyncMiddleware(disableTwoFactorValidator), + asyncMiddleware(disableTwoFactor) +) + +// --------------------------------------------------------------------------- + +export { + twoFactorRouter +} + +// --------------------------------------------------------------------------- + +async function requestTwoFactor (req: express.Request, res: express.Response) { + const user = res.locals.user + + const { secret, uri } = generateOTPSecret(user.email) + const requestToken = await Redis.Instance.setTwoFactorRequest(user.id, secret) + + return res.json({ + otpRequest: { + requestToken, + secret, + uri + } + } as TwoFactorEnableResult) +} + +async function confirmRequestTwoFactor (req: express.Request, res: express.Response) { + const requestToken = req.body.requestToken + const otpToken = req.body.otpToken + const user = res.locals.user + + const secret = await Redis.Instance.getTwoFactorRequestToken(user.id, requestToken) + if (!secret) { + return res.fail({ + message: 'Invalid request token', + status: HttpStatusCode.FORBIDDEN_403 + }) + } + + if (isOTPValid({ secret, token: otpToken }) !== true) { + return res.fail({ + message: 'Invalid OTP token', + status: HttpStatusCode.FORBIDDEN_403 + }) + } + + user.otpSecret = secret + await user.save() + + return res.sendStatus(HttpStatusCode.NO_CONTENT_204) +} + +async function disableTwoFactor (req: express.Request, res: express.Response) { + const user = res.locals.user + + user.otpSecret = null + await user.save() + + return res.sendStatus(HttpStatusCode.NO_CONTENT_204) +} -- cgit v1.2.3