PeerTube/server/middlewares/validators/users.ts

278 lines
9.6 KiB
TypeScript
Raw Normal View History

2018-01-30 13:27:07 +01:00
import * as Bluebird from 'bluebird'
2017-06-10 22:15:25 +02:00
import * as express from 'express'
2017-11-27 17:30:46 +01:00
import 'express-validator'
import { body, param } from 'express-validator/check'
2018-01-30 13:27:07 +01:00
import { omit } from 'lodash'
2017-12-12 17:53:50 +01:00
import { isIdOrUUIDValid } from '../../helpers/custom-validators/misc'
2017-09-15 12:17:08 +02:00
import {
2018-01-30 13:27:07 +01:00
isUserAutoPlayVideoValid,
isUserDescriptionValid,
isUserDisplayNameValid,
isUserNSFWPolicyValid,
2018-01-30 13:27:07 +01:00
isUserPasswordValid,
isUserRoleValid,
isUserUsernameValid,
2017-12-12 17:53:50 +01:00
isUserVideoQuotaValid
} from '../../helpers/custom-validators/users'
2018-01-03 10:12:36 +01:00
import { isVideoExist } from '../../helpers/custom-validators/videos'
2017-12-28 11:16:08 +01:00
import { logger } from '../../helpers/logger'
import { isSignupAllowed, isSignupAllowedForCurrentIP } from '../../helpers/utils'
2018-01-30 13:27:07 +01:00
import { Redis } from '../../lib/redis'
2017-12-12 17:53:50 +01:00
import { UserModel } from '../../models/account/user'
2017-11-27 17:30:46 +01:00
import { areValidationErrors } from './utils'
import { ActorModel } from '../../models/activitypub/actor'
2017-09-15 12:17:08 +02:00
const usersAddValidator = [
2017-11-04 18:32:38 +01:00
body('username').custom(isUserUsernameValid).withMessage('Should have a valid username (lowercase alphanumeric characters)'),
2017-09-15 12:17:08 +02:00
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'),
2017-11-27 17:30:46 +01:00
async (req: express.Request, res: express.Response, next: express.NextFunction) => {
2018-01-26 13:55:27 +01:00
logger.debug('Checking usersAdd parameters', { parameters: omit(req.body, 'password') })
2017-11-27 17:30:46 +01:00
if (areValidationErrors(req, res)) return
if (!await checkUserNameOrEmailDoesNotAlreadyExist(req.body.username, req.body.email, res)) return
return next()
2017-09-15 12:17:08 +02:00
}
]
2017-09-15 12:17:08 +02:00
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'),
2017-09-06 16:35:40 +02:00
2017-11-27 17:30:46 +01:00
async (req: express.Request, res: express.Response, next: express.NextFunction) => {
2018-01-26 13:55:27 +01:00
logger.debug('Checking usersRegister parameters', { parameters: omit(req.body, 'password') })
2017-09-06 16:35:40 +02:00
2017-11-27 17:30:46 +01:00
if (areValidationErrors(req, res)) return
if (!await checkUserNameOrEmailDoesNotAlreadyExist(req.body.username, req.body.email, res)) return
return next()
2017-09-15 12:17:08 +02:00
}
]
2017-09-15 12:17:08 +02:00
const usersRemoveValidator = [
param('id').isInt().not().isEmpty().withMessage('Should have a valid id'),
2017-11-27 17:30:46 +01:00
async (req: express.Request, res: express.Response, next: express.NextFunction) => {
2017-09-15 12:17:08 +02:00
logger.debug('Checking usersRemove parameters', { parameters: req.params })
2017-11-27 17:30:46 +01:00
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()
}
return next()
2017-09-15 12:17:08 +02:00
}
]
2017-09-05 21:29:39 +02:00
2017-09-15 12:17:08 +02:00
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'),
2017-09-05 21:29:39 +02:00
2017-11-27 17:30:46 +01:00
async (req: express.Request, res: express.Response, next: express.NextFunction) => {
2017-09-15 12:17:08 +02:00
logger.debug('Checking usersUpdate parameters', { parameters: req.body })
2017-11-27 17:30:46 +01:00
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()
}
2017-11-27 17:30:46 +01:00
return next()
2017-09-15 12:17:08 +02:00
}
]
2017-09-15 12:17:08 +02:00
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'),
2017-09-15 12:17:08 +02:00
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'),
2017-09-15 12:17:08 +02:00
(req: express.Request, res: express.Response, next: express.NextFunction) => {
// TODO: Add old password verification
2018-01-26 13:55:27 +01:00
logger.debug('Checking usersUpdateMe parameters', { parameters: omit(req.body, 'password') })
2017-09-05 21:29:39 +02:00
2017-11-27 17:30:46 +01:00
if (areValidationErrors(req, res)) return
return next()
2017-09-15 12:17:08 +02:00
}
]
2017-09-05 21:29:39 +02:00
2017-09-15 12:17:08 +02:00
const usersGetValidator = [
param('id').isInt().not().isEmpty().withMessage('Should have a valid id'),
2017-03-08 21:35:43 +01:00
2017-11-27 17:30:46 +01:00
async (req: express.Request, res: express.Response, next: express.NextFunction) => {
2018-01-26 13:55:27 +01:00
logger.debug('Checking usersGet parameters', { parameters: req.params })
2017-11-27 17:30:46 +01:00
if (areValidationErrors(req, res)) return
if (!await checkUserIdExist(req.params.id, res)) return
return next()
2017-09-15 12:17:08 +02:00
}
]
2017-03-08 21:35:43 +01:00
2017-09-15 12:17:08 +02:00
const usersVideoRatingValidator = [
2017-10-24 19:41:09 +02:00
param('videoId').custom(isIdOrUUIDValid).not().isEmpty().withMessage('Should have a valid video id'),
2017-11-27 17:30:46 +01:00
async (req: express.Request, res: express.Response, next: express.NextFunction) => {
2017-09-15 12:17:08 +02:00
logger.debug('Checking usersVideoRating parameters', { parameters: req.params })
2017-11-27 17:30:46 +01:00
if (areValidationErrors(req, res)) return
if (!await isVideoExist(req.params.videoId, res)) return
return next()
2017-09-15 12:17:08 +02:00
}
]
const ensureUserRegistrationAllowed = [
2017-11-27 17:30:46 +01:00
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()
}
return next()
2017-09-15 12:17:08 +02:00
}
]
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()
}
]
2018-01-30 13:27:07 +01:00
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.' })
2018-01-30 15:16:24 +01:00
.end()
2018-01-30 13:27:07 +01:00
}
return next()
}
]
// ---------------------------------------------------------------------------
2017-05-15 22:22:03 +02:00
export {
usersAddValidator,
2017-09-06 16:35:40 +02:00
usersRegisterValidator,
2017-05-15 22:22:03 +02:00
usersRemoveValidator,
usersUpdateValidator,
2017-09-05 21:29:39 +02:00
usersUpdateMeValidator,
usersVideoRatingValidator,
2017-09-05 21:29:39 +02:00
ensureUserRegistrationAllowed,
ensureUserRegistrationAllowedForIP,
2017-12-29 19:10:13 +01:00
usersGetValidator,
2018-01-30 13:27:07 +01:00
usersAskResetPasswordValidator,
usersResetPasswordValidator
2017-09-05 21:29:39 +02:00
}
// ---------------------------------------------------------------------------
2018-01-30 13:27:07 +01:00
function checkUserIdExist (id: number, res: express.Response) {
return checkUserExist(() => UserModel.loadById(id), res)
}
2017-11-27 17:30:46 +01:00
2018-01-30 13:27:07 +01:00
function checkUserEmailExist (email: string, res: express.Response, abortResponse = true) {
return checkUserExist(() => UserModel.loadByEmail(email), res, abortResponse)
2017-05-15 22:22:03 +02:00
}
2017-09-06 16:35:40 +02:00
2017-11-27 17:30:46 +01:00
async function checkUserNameOrEmailDoesNotAlreadyExist (username: string, email: string, res: express.Response) {
2017-12-12 17:53:50 +01:00
const user = await UserModel.loadByUsernameOrEmail(username, email)
2017-11-27 17:30:46 +01:00
if (user) {
res.status(409)
.send({ error: 'User with this username or email already exists.' })
2017-11-27 17:30:46 +01:00
.end()
return false
}
const actor = await ActorModel.loadLocalByName(username)
if (actor) {
res.status(409)
.send({ error: 'Another actor (account/channel) with this name already exists.' })
.end()
return false
}
2017-11-27 17:30:46 +01:00
return true
2017-09-06 16:35:40 +02:00
}
2018-01-30 13:27:07 +01:00
async function checkUserExist (finder: () => Bluebird<UserModel>, 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
}