import express from 'express'
import { body, param, query } from 'express-validator'
-import { omit } from 'lodash'
-import { Hooks } from '@server/lib/plugins/hooks'
-import { MUserDefault } from '@server/types/models'
-import { HttpStatusCode } from '../../../shared/models/http/http-error-codes'
-import { UserRole } from '../../../shared/models/users'
-import { UserRegister } from '../../../shared/models/users/user-register.model'
-import { toBooleanOrNull, toIntOrNull } from '../../helpers/custom-validators/misc'
+import { forceNumber } from '@shared/core-utils'
+import { HttpStatusCode, UserRight, UserRole } from '@shared/models'
+import { exists, isBooleanValid, isIdValid, toBooleanOrNull, toIntOrNull } from '../../helpers/custom-validators/misc'
import { isThemeNameValid } from '../../helpers/custom-validators/plugins'
import {
isUserAdminFlagsValid,
isUserBlockedReasonValid,
isUserDescriptionValid,
isUserDisplayNameValid,
+ isUserEmailPublicValid,
isUserNoModal,
isUserNSFWPolicyValid,
+ isUserP2PEnabledValid,
isUserPasswordValid,
isUserPasswordValidOrEmpty,
isUserRoleValid,
isUserVideoQuotaValid,
isUserVideosHistoryEnabledValid
} from '../../helpers/custom-validators/users'
-import { isVideoChannelDisplayNameValid, isVideoChannelUsernameValid } from '../../helpers/custom-validators/video-channels'
+import { isVideoChannelUsernameValid } from '../../helpers/custom-validators/video-channels'
import { logger } from '../../helpers/logger'
import { isThemeRegistered } from '../../lib/plugins/theme-utils'
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, doesVideoExist, isValidVideoIdParam } from './shared'
+import {
+ areValidationErrors,
+ checkUserEmailExist,
+ checkUserIdExist,
+ checkUserNameOrEmailDoNotAlreadyExist,
+ doesVideoChannelIdExist,
+ doesVideoExist,
+ isValidVideoIdParam
+} from './shared'
const usersListValidator = [
query('blocked')
.optional()
.customSanitizer(toBooleanOrNull)
- .isBoolean().withMessage('Should be a valid boolean banned state'),
+ .isBoolean().withMessage('Should be a valid blocked boolean'),
(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(isUserPasswordValidOrEmpty).withMessage('Should have a valid password'),
- body('email').isEmail().withMessage('Should have a valid email'),
+ body('username')
+ .custom(isUserUsernameValid)
+ .withMessage('Should have a valid username (lowercase alphanumeric characters)'),
+ body('password')
+ .custom(isUserPasswordValidOrEmpty),
+ body('email')
+ .isEmail(),
- body('channelName').optional().custom(isVideoChannelUsernameValid).withMessage('Should have a valid channel name'),
+ body('channelName')
+ .optional()
+ .custom(isVideoChannelUsernameValid),
- body('videoQuota').custom(isUserVideoQuotaValid).withMessage('Should have a valid user quota'),
- body('videoQuotaDaily').custom(isUserVideoQuotaDailyValid).withMessage('Should have a valid daily user quota'),
+ body('videoQuota')
+ .optional()
+ .custom(isUserVideoQuotaValid),
+
+ body('videoQuotaDaily')
+ .optional()
+ .custom(isUserVideoQuotaDailyValid),
body('role')
.customSanitizer(toIntOrNull)
- .custom(isUserRoleValid).withMessage('Should have a valid role'),
- body('adminFlags').optional().custom(isUserAdminFlagsValid).withMessage('Should have a valid admin flags'),
+ .custom(isUserRoleValid),
- async (req: express.Request, res: express.Response, next: express.NextFunction) => {
- logger.debug('Checking usersAdd parameters', { parameters: omit(req.body, 'password') })
+ body('adminFlags')
+ .optional()
+ .custom(isUserAdminFlagsValid),
- if (areValidationErrors(req, res)) return
- if (!await checkUserNameOrEmailDoesNotAlreadyExist(req.body.username, req.body.email, res)) return
+ async (req: express.Request, res: express.Response, next: express.NextFunction) => {
+ if (areValidationErrors(req, res, { omitBodyLog: true })) return
+ if (!await checkUserNameOrEmailDoNotAlreadyExist(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) {
}
]
-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'),
-
- body('channel.name')
- .optional()
- .custom(isVideoChannelUsernameValid).withMessage('Should have a valid channel name'),
- body('channel.displayName')
- .optional()
- .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') })
-
- 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.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.fail({ message: 'Channel name cannot be the same as user username.' })
- }
-
- const existing = await ActorModel.loadLocalByName(body.channel.name)
- if (existing) {
- return res.fail({
- status: HttpStatusCode.CONFLICT_409,
- message: `Channel with name ${body.channel.name} already exists.`
- })
- }
- }
-
- return next()
- }
-]
-
const usersRemoveValidator = [
- param('id').isInt().not().isEmpty().withMessage('Should have a valid id'),
+ param('id')
+ .custom(isIdValid),
async (req: express.Request, res: express.Response, next: express.NextFunction) => {
- logger.debug('Checking usersRemove parameters', { parameters: req.params })
-
if (areValidationErrors(req, res)) return
if (!await checkUserIdExist(req.params.id, res)) return
]
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'),
+ param('id')
+ .custom(isIdValid),
+ body('reason')
+ .optional()
+ .custom(isUserBlockedReasonValid),
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 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(),
+ param('id').custom(isIdValid),
+
+ body('password')
+ .optional()
+ .custom(isUserPasswordValid),
+ body('email')
+ .optional()
+ .isEmail(),
+ body('emailVerified')
+ .optional()
+ .isBoolean(),
+ body('videoQuota')
+ .optional()
+ .custom(isUserVideoQuotaValid),
+ body('videoQuotaDaily')
+ .optional()
+ .custom(isUserVideoQuotaDailyValid),
+ body('pluginAuth')
+ .optional()
+ .exists(),
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'),
+ .custom(isUserRoleValid),
+ body('adminFlags')
+ .optional()
+ .custom(isUserAdminFlagsValid),
async (req: express.Request, res: express.Response, next: express.NextFunction) => {
- logger.debug('Checking usersUpdate parameters', { parameters: req.body })
-
- if (areValidationErrors(req, res)) return
+ if (areValidationErrors(req, res, { omitBodyLog: true })) return
if (!await checkUserIdExist(req.params.id, res)) return
const user = res.locals.user
const usersUpdateMeValidator = [
body('displayName')
.optional()
- .custom(isUserDisplayNameValid).withMessage('Should have a valid display name'),
+ .custom(isUserDisplayNameValid),
body('description')
.optional()
- .custom(isUserDescriptionValid).withMessage('Should have a valid description'),
+ .custom(isUserDescriptionValid),
body('currentPassword')
.optional()
- .custom(isUserPasswordValid).withMessage('Should have a valid current password'),
+ .custom(isUserPasswordValid),
body('password')
.optional()
- .custom(isUserPasswordValid).withMessage('Should have a valid password'),
+ .custom(isUserPasswordValid),
+ body('emailPublic')
+ .optional()
+ .custom(isUserEmailPublicValid),
body('email')
.optional()
- .isEmail().withMessage('Should have a valid email attribute'),
+ .isEmail(),
body('nsfwPolicy')
.optional()
- .custom(isUserNSFWPolicyValid).withMessage('Should have a valid display Not Safe For Work policy'),
+ .custom(isUserNSFWPolicyValid),
body('autoPlayVideo')
.optional()
- .custom(isUserAutoPlayVideoValid).withMessage('Should have a valid automatically plays video attribute'),
+ .custom(isUserAutoPlayVideoValid),
+ 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'),
+ .custom(isUserVideoLanguages),
body('videosHistoryEnabled')
.optional()
- .custom(isUserVideosHistoryEnabledValid).withMessage('Should have a valid videos history enabled attribute'),
+ .custom(isUserVideosHistoryEnabledValid).withMessage('Should have a valid videos history enabled boolean'),
body('theme')
.optional()
- .custom(v => isThemeNameValid(v) && isThemeRegistered(v)).withMessage('Should have a valid theme'),
+ .custom(v => isThemeNameValid(v) && isThemeRegistered(v)),
body('noInstanceConfigWarningModal')
.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 (areValidationErrors(req, res)) return
+ if (areValidationErrors(req, res, { omitBodyLog: true })) return
return next()
}
]
const usersGetValidator = [
- param('id').isInt().not().isEmpty().withMessage('Should have a valid id'),
- query('withStats').optional().isBoolean().withMessage('Should have a valid stats flag'),
+ param('id')
+ .custom(isIdValid),
+ query('withStats')
+ .optional()
+ .isBoolean().withMessage('Should have a valid withStats boolean'),
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, req.query.withStats)) return
isValidVideoIdParam('videoId'),
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
}
]
-const ensureUserRegistrationAllowed = [
- async (req: express.Request, res: express.Response, next: express.NextFunction) => {
- 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.'
- })
- }
+const usersVideosValidator = [
+ query('isLive')
+ .optional()
+ .customSanitizer(toBooleanOrNull)
+ .custom(isBooleanValid).withMessage('Should have a valid isLive boolean'),
- return next()
- }
-]
+ query('channelId')
+ .optional()
+ .customSanitizer(toIntOrNull)
+ .custom(isIdValid),
-const ensureUserRegistrationAllowedForIP = [
- (req: express.Request, res: express.Response, next: express.NextFunction) => {
- const allowed = isSignupAllowedForCurrentIP(req.ip)
+ async (req: express.Request, res: express.Response, next: express.NextFunction) => {
+ if (areValidationErrors(req, res)) return
- if (allowed === false) {
- return res.fail({
- status: HttpStatusCode.FORBIDDEN_403,
- message: 'You are not on a network authorized for registration.'
- })
- }
+ if (req.query.channelId && !await doesVideoChannelIdExist(req.query.channelId, res)) return
return next()
}
]
const usersAskResetPasswordValidator = [
- body('email').isEmail().not().isEmpty().withMessage('Should have a valid email'),
+ body('email')
+ .isEmail(),
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)
return res.status(HttpStatusCode.NO_CONTENT_204).end()
}
+ if (res.locals.user.pluginAuth) {
+ return res.fail({
+ status: HttpStatusCode.CONFLICT_409,
+ message: 'Cannot recover password of a user that uses a plugin authentication.'
+ })
+ }
+
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'),
+ param('id')
+ .custom(isIdValid),
+ body('verificationString')
+ .not().isEmpty(),
+ body('password')
+ .custom(isUserPasswordValid),
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)
+ const redisVerificationString = await Redis.Instance.getResetPasswordVerificationString(user.id)
if (redisVerificationString !== req.body.verificationString) {
return res.fail({
}
]
-const usersAskSendVerifyEmailValidator = [
- body('email').isEmail().not().isEmpty().withMessage('Should have a valid email'),
+const usersCheckCurrentPasswordFactory = (targetUserIdGetter: (req: express.Request) => number | string) => {
+ return [
+ body('currentPassword').optional().custom(exists),
- async (req: express.Request, res: express.Response, next: express.NextFunction) => {
- logger.debug('Checking askUsersSendVerifyEmail parameters', { parameters: req.body })
+ async (req: express.Request, res: express.Response, next: express.NextFunction) => {
+ if (areValidationErrors(req, res)) return
- 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(HttpStatusCode.NO_CONTENT_204).end()
- }
+ const user = res.locals.oauth.token.User
+ const isAdminOrModerator = user.role === UserRole.ADMINISTRATOR || user.role === UserRole.MODERATOR
+ const targetUserId = forceNumber(targetUserIdGetter(req))
- return next()
- }
-]
+ // Admin/moderator action on another user, skip the password check
+ if (isAdminOrModerator && targetUserId !== user.id) {
+ return next()
+ }
-const usersVerifyEmailValidator = [
- param('id')
- .isInt().not().isEmpty().withMessage('Should have a valid id'),
+ if (!req.body.currentPassword) {
+ return res.fail({
+ status: HttpStatusCode.BAD_REQUEST_400,
+ message: 'currentPassword is missing'
+ })
+ }
- body('verificationString')
- .not().isEmpty().withMessage('Should have a valid verification string'),
- body('isPendingEmail')
- .optional()
- .customSanitizer(toBooleanOrNull),
+ if (await user.isPasswordMatch(req.body.currentPassword) !== true) {
+ return res.fail({
+ status: HttpStatusCode.FORBIDDEN_403,
+ message: 'currentPassword is invalid.'
+ })
+ }
- async (req: express.Request, res: express.Response, next: express.NextFunction) => {
- logger.debug('Checking usersVerifyEmail parameters', { parameters: req.params })
+ return next()
+ }
+ ]
+}
- if (areValidationErrors(req, res)) return
- if (!await checkUserIdExist(req.params.id, res)) return
+const userAutocompleteValidator = [
+ param('search')
+ .isString()
+ .not().isEmpty()
+]
- const user = res.locals.user
- const redisVerificationString = await Redis.Instance.getVerifyEmailLink(user.id)
+const ensureAuthUserOwnsAccountValidator = [
+ (req: express.Request, res: express.Response, next: express.NextFunction) => {
+ const user = res.locals.oauth.token.User
- if (redisVerificationString !== req.body.verificationString) {
+ if (res.locals.account.id !== user.Account.id) {
return res.fail({
status: HttpStatusCode.FORBIDDEN_403,
- message: 'Invalid verification string.'
+ message: 'Only owner of this account can access this resource.'
})
}
}
]
-const userAutocompleteValidator = [
- param('search').isString().not().isEmpty().withMessage('Should have a search parameter')
-]
-
-const ensureAuthUserOwnsAccountValidator = [
+const ensureCanManageChannelOrAccount = [
(req: express.Request, res: express.Response, next: express.NextFunction) => {
- const user = res.locals.oauth.token.User
+ const user = res.locals.oauth.token.user
+ const account = res.locals.videoChannel?.Account ?? res.locals.account
+ const isUserOwner = account.userId === user.id
+
+ if (!isUserOwner && user.hasRight(UserRight.MANAGE_ANY_VIDEO_CHANNEL) === false) {
+ const message = `User ${user.username} does not have right this channel or account.`
- if (res.locals.account.id !== user.Account.id) {
return res.fail({
status: HttpStatusCode.FORBIDDEN_403,
- message: 'Only owner can access ratings list.'
+ message
})
}
}
]
-const ensureCanManageUser = [
+const ensureCanModerateUser = [
(req: express.Request, res: express.Response, next: express.NextFunction) => {
const authUser = res.locals.oauth.token.User
const onUser = res.locals.user
return res.fail({
status: HttpStatusCode.FORBIDDEN_403,
- message: 'A moderator can only manager users.'
+ message: 'A moderator can only manage users.'
})
}
]
usersListValidator,
usersAddValidator,
deleteMeValidator,
- usersRegisterValidator,
usersBlockingValidator,
usersRemoveValidator,
usersUpdateValidator,
usersUpdateMeValidator,
usersVideoRatingValidator,
- ensureUserRegistrationAllowed,
- ensureUserRegistrationAllowedForIP,
+ usersCheckCurrentPasswordFactory,
usersGetValidator,
+ usersVideosValidator,
usersAskResetPasswordValidator,
usersResetPasswordValidator,
- usersAskSendVerifyEmailValidator,
- usersVerifyEmailValidator,
userAutocompleteValidator,
ensureAuthUserOwnsAccountValidator,
- ensureCanManageUser
-}
-
-// ---------------------------------------------------------------------------
-
-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) {
- 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.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.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: () => Promise<MUserDefault>, res: express.Response, abortResponse = true) {
- const user = await finder()
-
- if (!user) {
- if (abortResponse === true) {
- res.fail({
- status: HttpStatusCode.NOT_FOUND_404,
- message: 'User not found'
- })
- }
-
- return false
- }
-
- res.locals.user = user
- return true
+ ensureCanModerateUser,
+ ensureCanManageChannelOrAccount
}
projects / github / Chocobozzz / PeerTube.git / blobdiff