X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fmiddlewares%2Fvalidators%2Fusers.ts;h=4ad0e33da7d203d2d9eedad64d512370b917e81c;hb=ff2c1fe8133f9556f6aaa52058cd8b83c40085e6;hp=15c07c6936f01903d5d6d8dfd2542b7a70c89fe2;hpb=bfb3a98fac582f104c6d9b8b7242ea2cbb650b91;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/middlewares/validators/users.ts b/server/middlewares/validators/users.ts index 15c07c693..4ad0e33da 100644 --- a/server/middlewares/validators/users.ts +++ b/server/middlewares/validators/users.ts @@ -1,134 +1,238 @@ -import 'express-validator' +import * as Bluebird from 'bluebird' import * as express from 'express' -import * as Promise from 'bluebird' -import * as validator from 'validator' +import 'express-validator' +import { body, param } from 'express-validator/check' +import { omit } from 'lodash' +import { isIdOrUUIDValid } from '../../helpers/custom-validators/misc' +import { + isAvatarFile, + isUserAutoPlayVideoValid, + isUserDescriptionValid, isUserDisplayNameValid, + isUserNSFWPolicyValid, + isUserPasswordValid, + isUserRoleValid, + isUserUsernameValid, + isUserVideoQuotaValid +} from '../../helpers/custom-validators/users' +import { isVideoExist } from '../../helpers/custom-validators/videos' +import { logger } from '../../helpers/logger' +import { isSignupAllowed, isSignupAllowedForCurrentIP } from '../../helpers/utils' +import { CONFIG, CONSTRAINTS_FIELDS } from '../../initializers' +import { Redis } from '../../lib/redis' +import { UserModel } from '../../models/account/user' +import { areValidationErrors } from './utils' + +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('email').isEmail().withMessage('Should have a valid email'), + body('videoQuota').custom(isUserVideoQuotaValid).withMessage('Should have a valid user quota'), + body('role').custom(isUserRoleValid).withMessage('Should have a valid role'), + + async (req: express.Request, res: express.Response, next: express.NextFunction) => { + logger.debug('Checking usersAdd parameters', { parameters: omit(req.body, 'password') }) + + if (areValidationErrors(req, res)) return + if (!await checkUserNameOrEmailDoesNotAlreadyExist(req.body.username, req.body.email, res)) return -import { database as db } from '../../initializers/database' -import { checkErrors } from './utils' -import { isSignupAllowed, logger } from '../../helpers' -import { UserInstance, VideoInstance } from '../../models' + return next() + } +] -function usersAddValidator (req: express.Request, res: express.Response, next: express.NextFunction) { - req.checkBody('username', 'Should have a valid username').isUserUsernameValid() - req.checkBody('password', 'Should have a valid password').isUserPasswordValid() - req.checkBody('email', 'Should have a valid email').isEmail() - req.checkBody('videoQuota', 'Should have a valid user quota').isUserVideoQuotaValid() +const usersRegisterValidator = [ + body('username').custom(isUserUsernameValid).withMessage('Should have a valid username'), + body('password').custom(isUserPasswordValid).withMessage('Should have a valid password'), + body('email').isEmail().withMessage('Should have a valid email'), - logger.debug('Checking usersAdd parameters', { parameters: req.body }) + async (req: express.Request, res: express.Response, next: express.NextFunction) => { + logger.debug('Checking usersRegister parameters', { parameters: omit(req.body, 'password') }) - checkErrors(req, res, () => { - checkUserDoesNotAlreadyExist(req.body.username, req.body.email, res, next) - }) -} + if (areValidationErrors(req, res)) return + if (!await checkUserNameOrEmailDoesNotAlreadyExist(req.body.username, req.body.email, res)) return -function usersRegisterValidator (req: express.Request, res: express.Response, next: express.NextFunction) { - req.checkBody('username', 'Should have a valid username').isUserUsernameValid() - req.checkBody('password', 'Should have a valid password').isUserPasswordValid() - req.checkBody('email', 'Should have a valid email').isEmail() + return next() + } +] - logger.debug('Checking usersRegister parameters', { parameters: req.body }) +const usersRemoveValidator = [ + param('id').isInt().not().isEmpty().withMessage('Should have a valid id'), - checkErrors(req, res, () => { - checkUserDoesNotAlreadyExist(req.body.username, req.body.email, res, next) - }) -} + async (req: express.Request, res: express.Response, next: express.NextFunction) => { + logger.debug('Checking usersRemove parameters', { parameters: req.params }) -function usersRemoveValidator (req: express.Request, res: express.Response, next: express.NextFunction) { - req.checkParams('id', 'Should have a valid id').notEmpty().isInt() + if (areValidationErrors(req, res)) return + if (!await checkUserIdExist(req.params.id, res)) return - logger.debug('Checking usersRemove parameters', { parameters: req.params }) + const user = res.locals.user + if (user.username === 'root') { + return res.status(400) + .send({ error: 'Cannot remove the root user' }) + .end() + } - checkErrors(req, res, () => { - checkUserExists(req.params.id, res, (err, user) => { - if (err) { - logger.error('Error in usersRemoveValidator.', err) - return res.sendStatus(500) - } + return next() + } +] + +const usersUpdateValidator = [ + param('id').isInt().not().isEmpty().withMessage('Should have a valid id'), + body('email').optional().isEmail().withMessage('Should have a valid email attribute'), + body('videoQuota').optional().custom(isUserVideoQuotaValid).withMessage('Should have a valid user quota'), + body('role').optional().custom(isUserRoleValid).withMessage('Should have a valid role'), + + async (req: express.Request, res: express.Response, next: express.NextFunction) => { + logger.debug('Checking usersUpdate parameters', { parameters: req.body }) + + if (areValidationErrors(req, res)) return + if (!await checkUserIdExist(req.params.id, res)) return + + 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() + } - if (user.username === 'root') { - return res.status(400) - .send({ error: 'Cannot remove the root user' }) - .end() - } + return next() + } +] - return next() - }) - }) -} +const usersUpdateMeValidator = [ + body('displayName').optional().custom(isUserDisplayNameValid).withMessage('Should have a valid display name'), + body('description').optional().custom(isUserDescriptionValid).withMessage('Should have a valid description'), + body('password').optional().custom(isUserPasswordValid).withMessage('Should have a valid password'), + body('email').optional().isEmail().withMessage('Should have a valid email attribute'), + body('nsfwPolicy').optional().custom(isUserNSFWPolicyValid).withMessage('Should have a valid display Not Safe For Work policy'), + body('autoPlayVideo').optional().custom(isUserAutoPlayVideoValid).withMessage('Should have a valid automatically plays video attribute'), -function usersUpdateValidator (req: express.Request, res: express.Response, next: express.NextFunction) { - req.checkParams('id', 'Should have a valid id').notEmpty().isInt() - req.checkBody('email', 'Should have a valid email attribute').optional().isEmail() - req.checkBody('videoQuota', 'Should have a valid user quota').optional().isUserVideoQuotaValid() + (req: express.Request, res: express.Response, next: express.NextFunction) => { + // TODO: Add old password verification + logger.debug('Checking usersUpdateMe parameters', { parameters: omit(req.body, 'password') }) - logger.debug('Checking usersUpdate parameters', { parameters: req.body }) + if (areValidationErrors(req, res)) return - checkErrors(req, res, () => { - checkUserExists(req.params.id, res, next) - }) -} + return next() + } +] + +const usersUpdateMyAvatarValidator = [ + body('avatarfile').custom((value, { req }) => isAvatarFile(req.files)).withMessage( + 'This file is not supported. Please, make sure it is of the following type : ' + + CONSTRAINTS_FIELDS.ACTORS.AVATAR.EXTNAME.join(', ') + ), + + (req: express.Request, res: express.Response, next: express.NextFunction) => { + logger.debug('Checking usersUpdateMyAvatarValidator parameters', { files: req.files }) + + if (areValidationErrors(req, res)) return + + const imageFile = req.files['avatarfile'][0] as Express.Multer.File + if (imageFile.size > CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max) { + res.status(400) + .send({ error: `The size of the avatar is too big (>${CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max}).` }) + .end() + return + } -function usersUpdateMeValidator (req: express.Request, res: express.Response, next: express.NextFunction) { - // Add old password verification - req.checkBody('password', 'Should have a valid password').optional().isUserPasswordValid() - req.checkBody('email', 'Should have a valid email attribute').optional().isEmail() - req.checkBody('displayNSFW', 'Should have a valid display Not Safe For Work attribute').optional().isUserDisplayNSFWValid() + return next() + } +] - logger.debug('Checking usersUpdateMe parameters', { parameters: req.body }) +const usersGetValidator = [ + param('id').isInt().not().isEmpty().withMessage('Should have a valid id'), - checkErrors(req, res, next) -} + async (req: express.Request, res: express.Response, next: express.NextFunction) => { + logger.debug('Checking usersGet parameters', { parameters: req.params }) -function usersGetValidator (req: express.Request, res: express.Response, next: express.NextFunction) { - req.checkParams('id', 'Should have a valid id').notEmpty().isInt() + if (areValidationErrors(req, res)) return + if (!await checkUserIdExist(req.params.id, res)) return - checkErrors(req, res, () => { - checkUserExists(req.params.id, res, next) - }) -} + return next() + } +] + +const usersVideoRatingValidator = [ + param('videoId').custom(isIdOrUUIDValid).not().isEmpty().withMessage('Should have a valid video id'), -function usersVideoRatingValidator (req: express.Request, res: express.Response, next: express.NextFunction) { - req.checkParams('videoId', 'Should have a valid video id').notEmpty().isVideoIdOrUUIDValid() + async (req: express.Request, res: express.Response, next: express.NextFunction) => { + logger.debug('Checking usersVideoRating parameters', { parameters: req.params }) - logger.debug('Checking usersVideoRating parameters', { parameters: req.params }) + if (areValidationErrors(req, res)) return + if (!await isVideoExist(req.params.videoId, res)) return - checkErrors(req, res, () => { - let videoPromise: Promise + return next() + } +] - if (validator.isUUID(req.params.videoId)) { - videoPromise = db.Video.loadByUUID(req.params.videoId) - } else { - videoPromise = db.Video.load(req.params.videoId) +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() } - videoPromise - .then(video => { - if (!video) { - return res.status(404) - .json({ error: 'Video not found' }) - .end() - } - - return next() - }) - .catch(err => { - logger.error('Error in user request validator.', err) - return res.sendStatus(500) - }) - }) -} + return next() + } +] + +const ensureUserRegistrationAllowedForIP = [ + async (req: express.Request, res: express.Response, next: express.NextFunction) => { + const allowed = isSignupAllowedForCurrentIP(req.ip) -function ensureUserRegistrationAllowed (req: express.Request, res: express.Response, next: express.NextFunction) { - isSignupAllowed().then(allowed => { if (allowed === false) { return res.status(403) - .send({ error: 'User registration is not enabled or user limit is reached.' }) + .send({ error: 'You are not on a network authorized for registration.' }) .end() } return next() - }) -} + } +] + +const usersAskResetPasswordValidator = [ + body('email').isEmail().not().isEmpty().withMessage('Should have a valid email'), + + async (req: express.Request, res: express.Response, next: express.NextFunction) => { + logger.debug('Checking usersAskResetPassword parameters', { parameters: req.body }) + + if (areValidationErrors(req, res)) return + const exists = await checkUserEmailExist(req.body.email, res, false) + 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 next() + } +] + +const usersResetPasswordValidator = [ + param('id').isInt().not().isEmpty().withMessage('Should have a valid id'), + body('verificationString').not().isEmpty().withMessage('Should have a valid verification string'), + body('password').custom(isUserPasswordValid).withMessage('Should have a valid password'), + + async (req: express.Request, res: express.Response, next: express.NextFunction) => { + logger.debug('Checking usersResetPassword parameters', { parameters: req.params }) + + if (areValidationErrors(req, res)) return + if (!await checkUserIdExist(req.params.id, res)) return + + const user = res.locals.user as UserModel + const redisVerificationString = await Redis.Instance.getResetPasswordLink(user.id) + + if (redisVerificationString !== req.body.verificationString) { + return res + .status(403) + .send({ error: 'Invalid verification string.' }) + .end() + } + + return next() + } +] // --------------------------------------------------------------------------- @@ -140,42 +244,50 @@ export { usersUpdateMeValidator, usersVideoRatingValidator, ensureUserRegistrationAllowed, - usersGetValidator + ensureUserRegistrationAllowedForIP, + usersGetValidator, + usersUpdateMyAvatarValidator, + usersAskResetPasswordValidator, + usersResetPasswordValidator } // --------------------------------------------------------------------------- -function checkUserExists (id: number, res: express.Response, callback: (err: Error, user: UserInstance) => void) { - db.User.loadById(id) - .then(user => { - if (!user) { - return res.status(404) - .send({ error: 'User not found' }) - .end() - } - - res.locals.user = user - return callback(null, user) - }) - .catch(err => { - logger.error('Error in user request validator.', err) - return res.sendStatus(500) - }) +function checkUserIdExist (id: number, res: express.Response) { + return checkUserExist(() => UserModel.loadById(id), res) +} + +function checkUserEmailExist (email: string, res: express.Response, abortResponse = true) { + return checkUserExist(() => UserModel.loadByEmail(email), res, abortResponse) } -function checkUserDoesNotAlreadyExist (username: string, email: string, res: express.Response, callback: () => void) { - db.User.loadByUsernameOrEmail(username, email) - .then(user => { - if (user) { - return res.status(409) - .send({ error: 'User already exists.' }) - .end() - } - - return callback() - }) - .catch(err => { - logger.error('Error in usersAdd request validator.', err) - return res.sendStatus(500) - }) +async function checkUserNameOrEmailDoesNotAlreadyExist (username: string, email: string, res: express.Response) { + const user = await UserModel.loadByUsernameOrEmail(username, email) + + if (user) { + res.status(409) + .send({ error: 'User with this username or email already exists.' }) + .end() + return false + } + + return true +} + +async function checkUserExist (finder: () => Bluebird, res: express.Response, abortResponse = true) { + const user = await finder() + + if (!user) { + if (abortResponse === true) { + res.status(404) + .send({ error: 'User not found' }) + .end() + } + + return false + } + + res.locals.user = user + + return true }