X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fmiddlewares%2Fvalidators%2Fusers.ts;h=b4e09c9b7a794b05e14bc9ddf45f206558faca30;hb=1f20622f2b087eaf8738d60fae00a44b9c558ca3;hp=71e529872087cb006c901b904975eafc955d5ab1;hpb=291e8d3eed88fe714fb74ad897ac2c67347a85ff;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/middlewares/validators/users.ts b/server/middlewares/validators/users.ts index 71e529872..b4e09c9b7 100644 --- a/server/middlewares/validators/users.ts +++ b/server/middlewares/validators/users.ts @@ -1,109 +1,442 @@ -import 'express-validator' +import * as Bluebird from 'bluebird' import * as express from 'express' -import * as Promise from 'bluebird' -import * as validator from 'validator' - -import { database as db } from '../../initializers/database' -import { checkErrors } from './utils' -import { isSignupAllowed, logger } from '../../helpers' -import { VideoInstance } from '../../models' - -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() - - logger.debug('Checking usersAdd parameters', { parameters: req.body }) - - checkErrors(req, res, () => { - db.User.loadByUsernameOrEmail(req.body.username, req.body.email) - .then(user => { - if (user) return res.status(409).send('User already exists.') - - next() - }) - .catch(err => { - logger.error('Error in usersAdd request validator.', err) - return res.sendStatus(500) - }) - }) -} +import 'express-validator' +import { body, param } from 'express-validator/check' +import { omit } from 'lodash' +import { isIdOrUUIDValid } from '../../helpers/custom-validators/misc' +import { + isUserAdminFlagsValid, + isUserAutoPlayVideoValid, + isUserBlockedReasonValid, + isUserDescriptionValid, + isUserDisplayNameValid, + isUserNSFWPolicyValid, + isUserPasswordValid, + isUserRoleValid, + isUserUsernameValid, + isUserVideoQuotaDailyValid, + isUserVideoQuotaValid, + isUserVideosHistoryEnabledValid +} from '../../helpers/custom-validators/users' +import { doesVideoExist } from '../../helpers/custom-validators/videos' +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 { UserCreate } from '../../../shared/models/users' +import { UserRegister } from '../../../shared/models/users/user-register.model' -function usersRemoveValidator (req: express.Request, res: express.Response, next: express.NextFunction) { - req.checkParams('id', 'Should have a valid id').notEmpty().isInt() +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('videoQuotaDaily').custom(isUserVideoQuotaDailyValid).withMessage('Should have a valid daily user quota'), + body('role').custom(isUserRoleValid).withMessage('Should have a valid role'), + body('adminFlags').optional().custom(isUserAdminFlagsValid).withMessage('Should have a valid admin flags'), - logger.debug('Checking usersRemove parameters', { parameters: req.params }) + async (req: express.Request, res: express.Response, next: express.NextFunction) => { + logger.debug('Checking usersAdd parameters', { parameters: omit(req.body, 'password') }) - checkErrors(req, res, () => { - db.User.loadById(req.params.id) - .then(user => { - if (!user) return res.status(404).send('User not found') + if (areValidationErrors(req, res)) return + if (!await checkUserNameOrEmailDoesNotAlreadyExist(req.body.username, req.body.email, res)) return - if (user.username === 'root') return res.status(400).send('Cannot remove the root user') + return next() + } +] - next() - }) - .catch(err => { - logger.error('Error in usersRemove request validator.', err) - return res.sendStatus(500) - }) - }) -} +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'), + body('displayName') + .optional() + .custom(isUserDisplayNameValid).withMessage('Should have a valid display name'), -function usersUpdateValidator (req: express.Request, res: express.Response, next: express.NextFunction) { - req.checkParams('id', 'Should have a valid id').notEmpty().isInt() - // Add old password verification - req.checkBody('password', 'Should have a valid password').optional().isUserPasswordValid() - req.checkBody('displayNSFW', 'Should have a valid display Not Safe For Work attribute').optional().isUserDisplayNSFWValid() + body('channel.name') + .optional() + .custom(isActorPreferredUsernameValid).withMessage('Should have a valid channel name'), + body('channel.displayName') + .optional() + .custom(isVideoChannelNameValid).withMessage('Should have a valid display name'), - logger.debug('Checking usersUpdate 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, next) -} + if (areValidationErrors(req, res)) return + if (!await checkUserNameOrEmailDoesNotAlreadyExist(req.body.username, req.body.email, res)) return + + 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() + } -function usersVideoRatingValidator (req: express.Request, res: express.Response, next: express.NextFunction) { - req.checkParams('videoId', 'Should have a valid video id').notEmpty().isVideoIdOrUUIDValid() + if (body.channel.name === body.username) { + return res.status(400) + .send({ error: 'Channel name cannot be the same than user username.' }) + .end() + } - logger.debug('Checking usersVideoRating parameters', { parameters: req.params }) + 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 next() + } +] + +const usersRemoveValidator = [ + param('id').isInt().not().isEmpty().withMessage('Should have a valid id'), - checkErrors(req, res, () => { - let videoPromise: Promise + async (req: express.Request, res: express.Response, next: express.NextFunction) => { + logger.debug('Checking usersRemove parameters', { parameters: req.params }) - if (validator.isUUID(req.params.videoId)) { - videoPromise = db.Video.loadByUUID(req.params.videoId) - } else { - videoPromise = db.Video.load(req.params.videoId) + if (areValidationErrors(req, res)) return + if (!await checkUserIdExist(req.params.id, res)) return + + const user = res.locals.user + if (user.username === 'root') { + return res.status(400) + .send({ error: 'Cannot remove the root user' }) + .end() } - videoPromise - .then(video => { - if (!video) return res.status(404).send('Video not found') - - next() - }) - .catch(err => { - logger.error('Error in user request validator.', err) - return res.sendStatus(500) - }) - }) -} + return next() + } +] + +const usersBlockingValidator = [ + param('id').isInt().not().isEmpty().withMessage('Should have a valid id'), + body('reason').optional().custom(isUserBlockedReasonValid).withMessage('Should have a valid blocking reason'), + + async (req: express.Request, res: express.Response, next: express.NextFunction) => { + logger.debug('Checking usersBlocking parameters', { parameters: req.params }) + + if (areValidationErrors(req, res)) return + if (!await checkUserIdExist(req.params.id, res)) return + + const user = res.locals.user + if (user.username === 'root') { + return res.status(400) + .send({ error: 'Cannot block the root user' }) + .end() + } + + return next() + } +] + +const deleteMeValidator = [ + async (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.' }) + .end() + } + + return next() + } +] + +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('adminFlags').optional().custom(isUserAdminFlagsValid).withMessage('Should have a valid admin flags'), + + 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 -function ensureUserRegistrationAllowed (req: express.Request, res: express.Response, next: express.NextFunction) { - isSignupAllowed().then(allowed => { + 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 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('currentPassword').optional().custom(isUserPasswordValid).withMessage('Should have a valid current password'), + 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'), + body('videosHistoryEnabled') + .optional() + .custom(isUserVideosHistoryEnabledValid).withMessage('Should have a valid videos history enabled attribute'), + + async (req: express.Request, res: express.Response, next: express.NextFunction) => { + logger.debug('Checking usersUpdateMe parameters', { parameters: omit(req.body, 'password') }) + + if (req.body.password) { + if (!req.body.currentPassword) { + return res.status(400) + .send({ error: 'currentPassword parameter is missing.' }) + .end() + } + + 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() + } + } + + if (areValidationErrors(req, res)) return + + return next() + } +] + +const usersGetValidator = [ + param('id').isInt().not().isEmpty().withMessage('Should have a valid id'), + + 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 + + return next() + } +] + +const usersVideoRatingValidator = [ + param('videoId').custom(isIdOrUUIDValid).not().isEmpty().withMessage('Should have a valid video id'), + + async (req: express.Request, res: express.Response, next: express.NextFunction) => { + logger.debug('Checking usersVideoRating parameters', { parameters: req.params }) + + if (areValidationErrors(req, res)) return + if (!await doesVideoExist(req.params.videoId, res, 'id')) 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).send('User registration is not enabled or user limit is reached.') + return res.status(403) + .send({ error: 'User registration is not enabled or user limit is reached.' }) + .end() } return next() - }) -} + } +] + +const ensureUserRegistrationAllowedForIP = [ + async (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 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 + 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() + } +] + +const usersAskSendVerifyEmailValidator = [ + body('email').isEmail().not().isEmpty().withMessage('Should have a valid email'), + + async (req: express.Request, res: express.Response, next: express.NextFunction) => { + logger.debug('Checking askUsersSendVerifyEmail 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 verify email).', req.body.email) + // Do not leak our emails + return res.status(204).end() + } + + return next() + } +] + +const usersVerifyEmailValidator = [ + param('id').isInt().not().isEmpty().withMessage('Should have a valid id'), + body('verificationString').not().isEmpty().withMessage('Should have a valid verification string'), + + async (req: express.Request, res: express.Response, next: express.NextFunction) => { + logger.debug('Checking usersVerifyEmail parameters', { parameters: req.params }) + + if (areValidationErrors(req, res)) return + if (!await checkUserIdExist(req.params.id, res)) return + + const user = res.locals.user + const redisVerificationString = await Redis.Instance.getVerifyEmailLink(user.id) + + if (redisVerificationString !== req.body.verificationString) { + return res + .status(403) + .send({ error: 'Invalid verification string.' }) + .end() + } + + return next() + } +] + +const userAutocompleteValidator = [ + param('search').isString().not().isEmpty().withMessage('Should have a search parameter') +] + +const ensureAuthUserOwnsAccountValidator = [ + async (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 next() + } +] // --------------------------------------------------------------------------- export { usersAddValidator, + deleteMeValidator, + usersRegisterValidator, + usersBlockingValidator, usersRemoveValidator, usersUpdateValidator, + usersUpdateMeValidator, usersVideoRatingValidator, - ensureUserRegistrationAllowed + ensureUserRegistrationAllowed, + ensureUserRegistrationAllowedForIP, + usersGetValidator, + usersAskResetPasswordValidator, + usersResetPasswordValidator, + usersAskSendVerifyEmailValidator, + usersVerifyEmailValidator, + userAutocompleteValidator, + ensureAuthUserOwnsAccountValidator +} + +// --------------------------------------------------------------------------- + +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) +} + +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 + } + + 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() + 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 }