X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fmiddlewares%2Fvalidators%2Fusers.ts;h=548d5df4df334aa83825e3bd31cf8bab05f31ac7;hb=20213fbd2a366dffc35aa7dddad71323893f8d62;hp=a4d4ae46d0a1f5980ec3ab41e602e811f969976f;hpb=d1ab89deb79f70c439b58750d044d9cadf1194e5;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/middlewares/validators/users.ts b/server/middlewares/validators/users.ts index a4d4ae46d..548d5df4d 100644 --- a/server/middlewares/validators/users.ts +++ b/server/middlewares/validators/users.ts @@ -1,41 +1,68 @@ -import * as Bluebird from 'bluebird' import * as express from 'express' -import 'express-validator' -import { body, param } from 'express-validator/check' +import { body, param, query } from 'express-validator' import { omit } from 'lodash' -import { isIdOrUUIDValid } from '../../helpers/custom-validators/misc' +import { Hooks } from '@server/lib/plugins/hooks' +import { MUserDefault } from '@server/types/models' +import { HttpStatusCode } from '../../../shared/core-utils/miscs/http-error-codes' +import { UserRole } from '../../../shared/models/users' +import { UserRegister } from '../../../shared/models/users/user-register.model' +import { isActorPreferredUsernameValid } from '../../helpers/custom-validators/activitypub/actor' +import { isIdOrUUIDValid, toBooleanOrNull, toIntOrNull } from '../../helpers/custom-validators/misc' +import { isThemeNameValid } from '../../helpers/custom-validators/plugins' import { + isNoInstanceConfigWarningModal, + isNoWelcomeModal, isUserAdminFlagsValid, + isUserAutoPlayNextVideoValid, isUserAutoPlayVideoValid, isUserBlockedReasonValid, isUserDescriptionValid, isUserDisplayNameValid, isUserNSFWPolicyValid, isUserPasswordValid, + isUserPasswordValidOrEmpty, isUserRoleValid, isUserUsernameValid, + isUserVideoLanguages, isUserVideoQuotaDailyValid, isUserVideoQuotaValid, isUserVideosHistoryEnabledValid } from '../../helpers/custom-validators/users' -import { doesVideoExist } from '../../helpers/custom-validators/videos' +import { isVideoChannelNameValid } from '../../helpers/custom-validators/video-channels' import { logger } from '../../helpers/logger' +import { doesVideoExist } from '../../helpers/middlewares' import { isSignupAllowed, isSignupAllowedForCurrentIP } from '../../helpers/signup' +import { isThemeRegistered } from '../../lib/plugins/theme-utils' import { Redis } from '../../lib/redis' -import { UserModel } from '../../models/account/user' +import { UserModel } from '../../models/user/user' +import { ActorModel } from '../../models/actor/actor' import { areValidationErrors } from './utils' -import { ActorModel } from '../../models/activitypub/actor' -import { isActorPreferredUsernameValid } from '../../helpers/custom-validators/activitypub/actor' -import { isVideoChannelNameValid } from '../../helpers/custom-validators/video-channels' -import { UserRegister } from '../../../shared/models/users/user-register.model' + +const usersListValidator = [ + query('blocked') + .optional() + .customSanitizer(toBooleanOrNull) + .isBoolean().withMessage('Should be a valid boolean banned state'), + + (req: express.Request, res: express.Response, next: express.NextFunction) => { + logger.debug('Checking usersList parameters', { parameters: req.query }) + + if (areValidationErrors(req, res)) return + + return next() + } +] const usersAddValidator = [ body('username').custom(isUserUsernameValid).withMessage('Should have a valid username (lowercase alphanumeric characters)'), - body('password').custom(isUserPasswordValid).withMessage('Should have a valid password'), + body('password').custom(isUserPasswordValidOrEmpty).withMessage('Should have a valid password'), body('email').isEmail().withMessage('Should have a valid email'), + body('channelName').optional().custom(isActorPreferredUsernameValid).withMessage('Should have a valid channel name'), body('videoQuota').custom(isUserVideoQuotaValid).withMessage('Should have a valid user quota'), body('videoQuotaDaily').custom(isUserVideoQuotaDailyValid).withMessage('Should have a valid daily user quota'), - body('role').custom(isUserRoleValid).withMessage('Should have a valid role'), + body('role') + .customSanitizer(toIntOrNull) + .custom(isUserRoleValid).withMessage('Should have a valid role'), body('adminFlags').optional().custom(isUserAdminFlagsValid).withMessage('Should have a valid admin flags'), async (req: express.Request, res: express.Response, next: express.NextFunction) => { @@ -44,6 +71,28 @@ const usersAddValidator = [ if (areValidationErrors(req, res)) return if (!await checkUserNameOrEmailDoesNotAlreadyExist(req.body.username, req.body.email, res)) return + const authUser = res.locals.oauth.token.User + if (authUser.role !== UserRole.ADMINISTRATOR && req.body.role !== UserRole.USER) { + return res + .status(HttpStatusCode.FORBIDDEN_403) + .json({ error: 'You can only create users (and not administrators or moderators)' }) + } + + if (req.body.channelName) { + if (req.body.channelName === req.body.username) { + return res + .status(HttpStatusCode.BAD_REQUEST_400) + .json({ error: 'Channel name cannot be the same as user username.' }) + } + + const existing = await ActorModel.loadLocalByName(req.body.channelName) + if (existing) { + return res + .status(HttpStatusCode.CONFLICT_409) + .json({ error: `Channel with name ${req.body.channelName} already exists.` }) + } + } + return next() } ] @@ -72,22 +121,20 @@ const usersRegisterValidator = [ const body: UserRegister = req.body if (body.channel) { if (!body.channel.name || !body.channel.displayName) { - return res.status(400) - .send({ error: 'Channel is optional but if you specify it, channel.name and channel.displayName are required.' }) - .end() + return res + .status(HttpStatusCode.BAD_REQUEST_400) + .json({ error: 'Channel is optional but if you specify it, channel.name and channel.displayName are required.' }) } if (body.channel.name === body.username) { - return res.status(400) - .send({ error: 'Channel name cannot be the same than user username.' }) - .end() + return res.status(HttpStatusCode.BAD_REQUEST_400) + .json({ error: 'Channel name cannot be the same as user username.' }) } const existing = await ActorModel.loadLocalByName(body.channel.name) if (existing) { - return res.status(409) - .send({ error: `Channel with name ${body.channel.name} already exists.` }) - .end() + return res.status(HttpStatusCode.CONFLICT_409) + .json({ error: `Channel with name ${body.channel.name} already exists.` }) } } @@ -106,9 +153,8 @@ const usersRemoveValidator = [ const user = res.locals.user if (user.username === 'root') { - return res.status(400) - .send({ error: 'Cannot remove the root user' }) - .end() + return res.status(HttpStatusCode.BAD_REQUEST_400) + .json({ error: 'Cannot remove the root user' }) } return next() @@ -127,9 +173,8 @@ const usersBlockingValidator = [ const user = res.locals.user if (user.username === 'root') { - return res.status(400) - .send({ error: 'Cannot block the root user' }) - .end() + return res.status(HttpStatusCode.BAD_REQUEST_400) + .json({ error: 'Cannot block the root user' }) } return next() @@ -137,11 +182,11 @@ const usersBlockingValidator = [ ] const deleteMeValidator = [ - async (req: express.Request, res: express.Response, next: express.NextFunction) => { + (req: express.Request, res: express.Response, next: express.NextFunction) => { const user = res.locals.oauth.token.User if (user.username === 'root') { - return res.status(400) - .send({ error: 'You cannot delete your root account.' }) + return res.status(HttpStatusCode.BAD_REQUEST_400) + .json({ error: 'You cannot delete your root account.' }) .end() } @@ -151,12 +196,17 @@ const deleteMeValidator = [ const usersUpdateValidator = [ param('id').isInt().not().isEmpty().withMessage('Should have a valid id'), + body('password').optional().custom(isUserPasswordValid).withMessage('Should have a valid password'), body('email').optional().isEmail().withMessage('Should have a valid email attribute'), body('emailVerified').optional().isBoolean().withMessage('Should have a valid email verified attribute'), body('videoQuota').optional().custom(isUserVideoQuotaValid).withMessage('Should have a valid user quota'), body('videoQuotaDaily').optional().custom(isUserVideoQuotaDailyValid).withMessage('Should have a valid daily user quota'), - body('role').optional().custom(isUserRoleValid).withMessage('Should have a valid role'), + body('pluginAuth').optional(), + body('role') + .optional() + .customSanitizer(toIntOrNull) + .custom(isUserRoleValid).withMessage('Should have a valid role'), body('adminFlags').optional().custom(isUserAdminFlagsValid).withMessage('Should have a valid admin flags'), async (req: express.Request, res: express.Response, next: express.NextFunction) => { @@ -167,9 +217,8 @@ const usersUpdateValidator = [ const user = res.locals.user if (user.username === 'root' && req.body.role !== undefined && user.role !== req.body.role) { - return res.status(400) - .send({ error: 'Cannot change root role.' }) - .end() + return res.status(HttpStatusCode.BAD_REQUEST_400) + .json({ error: 'Cannot change root role.' }) } return next() @@ -198,25 +247,44 @@ const usersUpdateMeValidator = [ body('autoPlayVideo') .optional() .custom(isUserAutoPlayVideoValid).withMessage('Should have a valid automatically plays video attribute'), + body('videoLanguages') + .optional() + .custom(isUserVideoLanguages).withMessage('Should have a valid video languages attribute'), body('videosHistoryEnabled') .optional() .custom(isUserVideosHistoryEnabledValid).withMessage('Should have a valid videos history enabled attribute'), + body('theme') + .optional() + .custom(v => isThemeNameValid(v) && isThemeRegistered(v)).withMessage('Should have a valid theme'), + body('noInstanceConfigWarningModal') + .optional() + .custom(v => isNoInstanceConfigWarningModal(v)).withMessage('Should have a valid noInstanceConfigWarningModal boolean'), + body('noWelcomeModal') + .optional() + .custom(v => isNoWelcomeModal(v)).withMessage('Should have a valid noWelcomeModal boolean'), + body('autoPlayNextVideo') + .optional() + .custom(v => isUserAutoPlayNextVideoValid(v)).withMessage('Should have a valid autoPlayNextVideo boolean'), async (req: express.Request, res: express.Response, next: express.NextFunction) => { logger.debug('Checking usersUpdateMe parameters', { parameters: omit(req.body, 'password') }) - if (req.body.password) { + const user = res.locals.oauth.token.User + + if (req.body.password || req.body.email) { + if (user.pluginAuth !== null) { + return res.status(HttpStatusCode.BAD_REQUEST_400) + .json({ error: 'You cannot update your email or password that is associated with an external auth system.' }) + } + if (!req.body.currentPassword) { - return res.status(400) - .send({ error: 'currentPassword parameter is missing.' }) - .end() + return res.status(HttpStatusCode.BAD_REQUEST_400) + .json({ error: 'currentPassword parameter is missing.' }) } - const user = res.locals.oauth.token.User if (await user.isPasswordMatch(req.body.currentPassword) !== true) { - return res.status(401) - .send({ error: 'currentPassword is invalid.' }) - .end() + return res.status(HttpStatusCode.UNAUTHORIZED_401) + .json({ error: 'currentPassword is invalid.' }) } } @@ -228,12 +296,13 @@ const usersUpdateMeValidator = [ const usersGetValidator = [ param('id').isInt().not().isEmpty().withMessage('Should have a valid id'), + query('withStats').optional().isBoolean().withMessage('Should have a valid stats flag'), async (req: express.Request, res: express.Response, next: express.NextFunction) => { logger.debug('Checking usersGet parameters', { parameters: req.params }) if (areValidationErrors(req, res)) return - if (!await checkUserIdExist(req.params.id, res)) return + if (!await checkUserIdExist(req.params.id, res, req.query.withStats)) return return next() } @@ -254,11 +323,20 @@ const usersVideoRatingValidator = [ const ensureUserRegistrationAllowed = [ async (req: express.Request, res: express.Response, next: express.NextFunction) => { - const allowed = await isSignupAllowed() - if (allowed === false) { - return res.status(403) - .send({ error: 'User registration is not enabled or user limit is reached.' }) - .end() + const allowedParams = { + body: req.body, + ip: req.ip + } + + const allowedResult = await Hooks.wrapPromiseFun( + isSignupAllowed, + allowedParams, + 'filter:api.user.signup.allowed.result' + ) + + if (allowedResult.allowed === false) { + return res.status(HttpStatusCode.FORBIDDEN_403) + .json({ error: allowedResult.errorMessage || 'User registration is not enabled or user limit is reached.' }) } return next() @@ -266,13 +344,12 @@ const ensureUserRegistrationAllowed = [ ] const ensureUserRegistrationAllowedForIP = [ - async (req: express.Request, res: express.Response, next: express.NextFunction) => { + (req: express.Request, res: express.Response, next: express.NextFunction) => { const allowed = isSignupAllowedForCurrentIP(req.ip) if (allowed === false) { - return res.status(403) - .send({ error: 'You are not on a network authorized for registration.' }) - .end() + return res.status(HttpStatusCode.FORBIDDEN_403) + .json({ error: 'You are not on a network authorized for registration.' }) } return next() @@ -291,7 +368,7 @@ const usersAskResetPasswordValidator = [ if (!exists) { logger.debug('User with email %s does not exist (asking reset password).', req.body.email) // Do not leak our emails - return res.status(204).end() + return res.status(HttpStatusCode.NO_CONTENT_204).end() } return next() @@ -314,9 +391,8 @@ const usersResetPasswordValidator = [ if (redisVerificationString !== req.body.verificationString) { return res - .status(403) - .send({ error: 'Invalid verification string.' }) - .end() + .status(HttpStatusCode.FORBIDDEN_403) + .json({ error: 'Invalid verification string.' }) } return next() @@ -334,7 +410,7 @@ const usersAskSendVerifyEmailValidator = [ if (!exists) { logger.debug('User with email %s does not exist (asking verify email).', req.body.email) // Do not leak our emails - return res.status(204).end() + return res.status(HttpStatusCode.NO_CONTENT_204).end() } return next() @@ -349,7 +425,7 @@ const usersVerifyEmailValidator = [ .not().isEmpty().withMessage('Should have a valid verification string'), body('isPendingEmail') .optional() - .toBoolean(), + .customSanitizer(toBooleanOrNull), async (req: express.Request, res: express.Response, next: express.NextFunction) => { logger.debug('Checking usersVerifyEmail parameters', { parameters: req.params }) @@ -362,9 +438,8 @@ const usersVerifyEmailValidator = [ if (redisVerificationString !== req.body.verificationString) { return res - .status(403) - .send({ error: 'Invalid verification string.' }) - .end() + .status(HttpStatusCode.FORBIDDEN_403) + .json({ error: 'Invalid verification string.' }) } return next() @@ -376,22 +451,35 @@ const userAutocompleteValidator = [ ] const ensureAuthUserOwnsAccountValidator = [ - async (req: express.Request, res: express.Response, next: express.NextFunction) => { + (req: express.Request, res: express.Response, next: express.NextFunction) => { const user = res.locals.oauth.token.User if (res.locals.account.id !== user.Account.id) { - return res.status(403) - .send({ error: 'Only owner can access ratings list.' }) - .end() + return res.status(HttpStatusCode.FORBIDDEN_403) + .json({ error: 'Only owner can access ratings list.' }) } return next() } ] +const ensureCanManageUser = [ + (req: express.Request, res: express.Response, next: express.NextFunction) => { + const authUser = res.locals.oauth.token.User + const onUser = res.locals.user + + if (authUser.role === UserRole.ADMINISTRATOR) return next() + if (authUser.role === UserRole.MODERATOR && onUser.role === UserRole.USER) return next() + + return res.status(HttpStatusCode.FORBIDDEN_403) + .json({ error: 'A moderator can only manager users.' }) + } +] + // --------------------------------------------------------------------------- export { + usersListValidator, usersAddValidator, deleteMeValidator, usersRegisterValidator, @@ -408,13 +496,15 @@ export { usersAskSendVerifyEmailValidator, usersVerifyEmailValidator, userAutocompleteValidator, - ensureAuthUserOwnsAccountValidator + ensureAuthUserOwnsAccountValidator, + ensureCanManageUser } // --------------------------------------------------------------------------- -function checkUserIdExist (id: number, res: express.Response) { - return checkUserExist(() => UserModel.loadById(id), res) +function checkUserIdExist (idArg: number | string, res: express.Response, withStats = false) { + const id = parseInt(idArg + '', 10) + return checkUserExist(() => UserModel.loadByIdWithChannels(id, withStats), res) } function checkUserEmailExist (email: string, res: express.Response, abortResponse = true) { @@ -425,31 +515,28 @@ async function checkUserNameOrEmailDoesNotAlreadyExist (username: string, email: const user = await UserModel.loadByUsernameOrEmail(username, email) if (user) { - res.status(409) - .send({ error: 'User with this username or email already exists.' }) - .end() + res.status(HttpStatusCode.CONFLICT_409) + .json({ error: 'User with this username or email already exists.' }) return false } const actor = await ActorModel.loadLocalByName(username) if (actor) { - res.status(409) - .send({ error: 'Another actor (account/channel) with this name on this instance already exists or has already existed.' }) - .end() + res.status(HttpStatusCode.CONFLICT_409) + .json({ error: 'Another actor (account/channel) with this name on this instance already exists or has already existed.' }) return false } return true } -async function checkUserExist (finder: () => Bluebird, res: express.Response, abortResponse = true) { +async function checkUserExist (finder: () => Promise, res: express.Response, abortResponse = true) { const user = await finder() if (!user) { if (abortResponse === true) { - res.status(404) - .send({ error: 'User not found' }) - .end() + res.status(HttpStatusCode.NOT_FOUND_404) + .json({ error: 'User not found' }) } return false