X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fmiddlewares%2Fvalidators%2Fusers.ts;h=bc6007c6d45b6b4233489989398d877ecca7a364;hb=3318147300b4f998adf728eb0a5a14a4c1829c51;hp=26f43cec71a56bb87769ef6fbb06fa31bda490a0;hpb=d11c28a36b1382ea0a5d5e8d19a67e99b6b24de0;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/middlewares/validators/users.ts b/server/middlewares/validators/users.ts index 26f43cec7..bc6007c6d 100644 --- a/server/middlewares/validators/users.ts +++ b/server/middlewares/validators/users.ts @@ -1,16 +1,23 @@ -import * as Bluebird from 'bluebird' -import * as express from 'express' -import { body, param } from 'express-validator' +import express from 'express' +import { body, param, query } from 'express-validator' import { omit } from 'lodash' -import { isIdOrUUIDValid, toBooleanOrNull, toIntOrNull } from '../../helpers/custom-validators/misc' +import { Hooks } from '@server/lib/plugins/hooks' +import { MUserDefault } from '@server/types/models' +import { HttpStatusCode, UserRegister, UserRight, UserRole } from '@shared/models' +import { isBooleanValid, isIdValid, toBooleanOrNull, toIntOrNull } from '../../helpers/custom-validators/misc' +import { isThemeNameValid } from '../../helpers/custom-validators/plugins' import { isUserAdminFlagsValid, + isUserAutoPlayNextVideoValid, isUserAutoPlayVideoValid, isUserBlockedReasonValid, isUserDescriptionValid, isUserDisplayNameValid, + isUserNoModal, isUserNSFWPolicyValid, + isUserP2PEnabledValid, isUserPasswordValid, + isUserPasswordValidOrEmpty, isUserRoleValid, isUserUsernameValid, isUserVideoLanguages, @@ -18,27 +25,40 @@ import { isUserVideoQuotaValid, isUserVideosHistoryEnabledValid } from '../../helpers/custom-validators/users' +import { isVideoChannelDisplayNameValid, isVideoChannelUsernameValid } from '../../helpers/custom-validators/video-channels' import { logger } from '../../helpers/logger' -import { isSignupAllowed, isSignupAllowedForCurrentIP } from '../../helpers/signup' -import { Redis } from '../../lib/redis' -import { UserModel } from '../../models/account/user' -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' -import { isThemeNameValid } from '../../helpers/custom-validators/plugins' import { isThemeRegistered } from '../../lib/plugins/theme-utils' -import { doesVideoExist } from '../../helpers/middlewares' -import { UserRole } from '../../../shared/models/users' -import { MUserDefault } from '@server/typings/models' +import { Redis } from '../../lib/redis' +import { isSignupAllowed, isSignupAllowedForCurrentIP } from '../../lib/signup' +import { ActorModel } from '../../models/actor/actor' +import { UserModel } from '../../models/user/user' +import { areValidationErrors, doesVideoChannelIdExist, doesVideoExist, isValidVideoIdParam } from './shared' + +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(isVideoChannelUsernameValid).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') .customSanitizer(toIntOrNull) .custom(isUserRoleValid).withMessage('Should have a valid role'), @@ -52,8 +72,24 @@ const usersAddValidator = [ const authUser = res.locals.oauth.token.User if (authUser.role !== UserRole.ADMINISTRATOR && req.body.role !== UserRole.USER) { - return res.status(403) - .json({ error: 'You can only create users (and not administrators or moderators)' }) + return res.fail({ + status: HttpStatusCode.FORBIDDEN_403, + message: 'You can only create users (and not administrators or moderators)' + }) + } + + if (req.body.channelName) { + if (req.body.channelName === req.body.username) { + return res.fail({ message: 'Channel name cannot be the same as user username.' }) + } + + const existing = await ActorModel.loadLocalByName(req.body.channelName) + if (existing) { + return res.fail({ + status: HttpStatusCode.CONFLICT_409, + message: `Channel with name ${req.body.channelName} already exists.` + }) + } } return next() @@ -70,10 +106,10 @@ const usersRegisterValidator = [ body('channel.name') .optional() - .custom(isActorPreferredUsernameValid).withMessage('Should have a valid channel name'), + .custom(isVideoChannelUsernameValid).withMessage('Should have a valid channel name'), body('channel.displayName') .optional() - .custom(isVideoChannelNameValid).withMessage('Should have a valid display name'), + .custom(isVideoChannelDisplayNameValid).withMessage('Should have a valid display name'), async (req: express.Request, res: express.Response, next: express.NextFunction) => { logger.debug('Checking usersRegister parameters', { parameters: omit(req.body, 'password') }) @@ -84,19 +120,19 @@ const usersRegisterValidator = [ const body: UserRegister = req.body if (body.channel) { if (!body.channel.name || !body.channel.displayName) { - return res.status(400) - .json({ error: 'Channel is optional but if you specify it, channel.name and channel.displayName are required.' }) + return res.fail({ message: '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) - .json({ error: 'Channel name cannot be the same than user username.' }) + return res.fail({ message: 'Channel name cannot be the same as user username.' }) } const existing = await ActorModel.loadLocalByName(body.channel.name) if (existing) { - return res.status(409) - .json({ error: `Channel with name ${body.channel.name} already exists.` }) + return res.fail({ + status: HttpStatusCode.CONFLICT_409, + message: `Channel with name ${body.channel.name} already exists.` + }) } } @@ -115,8 +151,7 @@ const usersRemoveValidator = [ const user = res.locals.user if (user.username === 'root') { - return res.status(400) - .json({ error: 'Cannot remove the root user' }) + return res.fail({ message: 'Cannot remove the root user' }) } return next() @@ -135,8 +170,7 @@ const usersBlockingValidator = [ const user = res.locals.user if (user.username === 'root') { - return res.status(400) - .json({ error: 'Cannot block the root user' }) + return res.fail({ message: 'Cannot block the root user' }) } return next() @@ -144,12 +178,10 @@ 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) - .json({ error: 'You cannot delete your root account.' }) - .end() + return res.fail({ message: 'You cannot delete your root account.' }) } return next() @@ -158,11 +190,13 @@ 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('pluginAuth').optional(), body('role') .optional() .customSanitizer(toIntOrNull) @@ -177,8 +211,7 @@ const usersUpdateValidator = [ const user = res.locals.user if (user.username === 'root' && req.body.role !== undefined && user.role !== req.body.role) { - return res.status(400) - .json({ error: 'Cannot change root role.' }) + return res.fail({ message: 'Cannot change root role.' }) } return next() @@ -207,6 +240,9 @@ const usersUpdateMeValidator = [ body('autoPlayVideo') .optional() .custom(isUserAutoPlayVideoValid).withMessage('Should have a valid automatically plays video attribute'), + body('p2pEnabled') + .optional() + .custom(isUserP2PEnabledValid).withMessage('Should have a valid p2p enabled boolean'), body('videoLanguages') .optional() .custom(isUserVideoLanguages).withMessage('Should have a valid video languages attribute'), @@ -217,20 +253,39 @@ const usersUpdateMeValidator = [ .optional() .custom(v => isThemeNameValid(v) && isThemeRegistered(v)).withMessage('Should have a valid theme'), + body('noInstanceConfigWarningModal') + .optional() + .custom(v => isUserNoModal(v)).withMessage('Should have a valid noInstanceConfigWarningModal boolean'), + body('noWelcomeModal') + .optional() + .custom(v => isUserNoModal(v)).withMessage('Should have a valid noWelcomeModal boolean'), + body('noAccountSetupWarningModal') + .optional() + .custom(v => isUserNoModal(v)).withMessage('Should have a valid noAccountSetupWarningModal 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') }) + const user = res.locals.oauth.token.User + if (req.body.password || req.body.email) { + if (user.pluginAuth !== null) { + return res.fail({ message: 'You cannot update your email or password that is associated with an external auth system.' }) + } + if (!req.body.currentPassword) { - return res.status(400) - .json({ error: 'currentPassword parameter is missing.' }) - .end() + return res.fail({ message: 'currentPassword parameter is missing.' }) } - const user = res.locals.oauth.token.User if (await user.isPasswordMatch(req.body.currentPassword) !== true) { - return res.status(401) - .json({ error: 'currentPassword is invalid.' }) + return res.fail({ + status: HttpStatusCode.UNAUTHORIZED_401, + message: 'currentPassword is invalid.' + }) } } @@ -242,19 +297,20 @@ 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() } ] const usersVideoRatingValidator = [ - param('videoId').custom(isIdOrUUIDValid).not().isEmpty().withMessage('Should have a valid video id'), + isValidVideoIdParam('videoId'), async (req: express.Request, res: express.Response, next: express.NextFunction) => { logger.debug('Checking usersVideoRating parameters', { parameters: req.params }) @@ -266,12 +322,46 @@ const usersVideoRatingValidator = [ } ] +const usersVideosValidator = [ + query('isLive') + .optional() + .customSanitizer(toBooleanOrNull) + .custom(isBooleanValid).withMessage('Should have a valid live boolean'), + + query('channelId') + .optional() + .customSanitizer(toIntOrNull) + .custom(isIdValid).withMessage('Should have a valid channel id'), + + async (req: express.Request, res: express.Response, next: express.NextFunction) => { + logger.debug('Checking usersVideosValidator parameters', { parameters: req.query }) + + if (areValidationErrors(req, res)) return + + if (req.query.channelId && !await doesVideoChannelIdExist(req.query.channelId, res)) return + + return next() + } +] + const ensureUserRegistrationAllowed = [ async (req: express.Request, res: express.Response, next: express.NextFunction) => { - const allowed = await isSignupAllowed() - if (allowed === false) { - return res.status(403) - .json({ error: 'User registration is not enabled or user limit is reached.' }) + 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.fail({ + status: HttpStatusCode.FORBIDDEN_403, + message: allowedResult.errorMessage || 'User registration is not enabled or user limit is reached.' + }) } return next() @@ -279,12 +369,14 @@ 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) - .json({ error: 'You are not on a network authorized for registration.' }) + return res.fail({ + status: HttpStatusCode.FORBIDDEN_403, + message: 'You are not on a network authorized for registration.' + }) } return next() @@ -303,7 +395,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() @@ -325,9 +417,10 @@ const usersResetPasswordValidator = [ const redisVerificationString = await Redis.Instance.getResetPasswordLink(user.id) if (redisVerificationString !== req.body.verificationString) { - return res - .status(403) - .json({ error: 'Invalid verification string.' }) + return res.fail({ + status: HttpStatusCode.FORBIDDEN_403, + message: 'Invalid verification string.' + }) } return next() @@ -345,7 +438,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() @@ -372,9 +465,10 @@ const usersVerifyEmailValidator = [ const redisVerificationString = await Redis.Instance.getVerifyEmailLink(user.id) if (redisVerificationString !== req.body.verificationString) { - return res - .status(403) - .json({ error: 'Invalid verification string.' }) + return res.fail({ + status: HttpStatusCode.FORBIDDEN_403, + message: 'Invalid verification string.' + }) } return next() @@ -386,12 +480,32 @@ 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) - .json({ error: 'Only owner can access ratings list.' }) + return res.fail({ + status: HttpStatusCode.FORBIDDEN_403, + message: 'Only owner of this account can access this ressource.' + }) + } + + return next() + } +] + +const ensureCanManageChannel = [ + (req: express.Request, res: express.Response, next: express.NextFunction) => { + const user = res.locals.oauth.token.user + const isUserOwner = res.locals.videoChannel.Account.userId === user.id + + if (!isUserOwner && user.hasRight(UserRight.MANAGE_ANY_VIDEO_CHANNEL) === false) { + const message = `User ${user.username} does not have right to manage channel ${req.params.nameWithHost}.` + + return res.fail({ + status: HttpStatusCode.FORBIDDEN_403, + message + }) } return next() @@ -406,14 +520,17 @@ const ensureCanManageUser = [ if (authUser.role === UserRole.ADMINISTRATOR) return next() if (authUser.role === UserRole.MODERATOR && onUser.role === UserRole.USER) return next() - return res.status(403) - .json({ error: 'A moderator can only manager users.' }) + return res.fail({ + status: HttpStatusCode.FORBIDDEN_403, + message: 'A moderator can only manager users.' + }) } ] // --------------------------------------------------------------------------- export { + usersListValidator, usersAddValidator, deleteMeValidator, usersRegisterValidator, @@ -425,19 +542,22 @@ export { ensureUserRegistrationAllowed, ensureUserRegistrationAllowedForIP, usersGetValidator, + usersVideosValidator, usersAskResetPasswordValidator, usersResetPasswordValidator, usersAskSendVerifyEmailValidator, usersVerifyEmailValidator, userAutocompleteValidator, ensureAuthUserOwnsAccountValidator, - ensureCanManageUser + ensureCanManageUser, + ensureCanManageChannel } // --------------------------------------------------------------------------- -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) { @@ -448,34 +568,39 @@ async function checkUserNameOrEmailDoesNotAlreadyExist (username: string, email: const user = await UserModel.loadByUsernameOrEmail(username, email) if (user) { - res.status(409) - .json({ error: 'User with this username or email already exists.' }) + res.fail({ + status: HttpStatusCode.CONFLICT_409, + message: 'User with this username or email already exists.' + }) return false } const actor = await ActorModel.loadLocalByName(username) if (actor) { - res.status(409) - .json({ error: 'Another actor (account/channel) with this name on this instance already exists or has already existed.' }) + res.fail({ + status: HttpStatusCode.CONFLICT_409, + message: '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) - .json({ error: 'User not found' }) + res.fail({ + status: HttpStatusCode.NOT_FOUND_404, + message: 'User not found' + }) } return false } res.locals.user = user - return true }