X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fmiddlewares%2Fvalidators%2Fplugins.ts;h=64bef26480f57f243ffd6daffaea28ed90569713;hb=05a60d85997c108d39bcfb14f1ffd4c74f8b1e93;hp=910d03c2938e313c65e532875aba3984bb13f290;hpb=c8861d5dc0436ef4342ce517241e3591fa256a13;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/middlewares/validators/plugins.ts b/server/middlewares/validators/plugins.ts index 910d03c29..64bef2648 100644 --- a/server/middlewares/validators/plugins.ts +++ b/server/middlewares/validators/plugins.ts @@ -1,33 +1,95 @@ -import * as express from 'express' -import { body, param, query } from 'express-validator' -import { logger } from '../../helpers/logger' -import { areValidationErrors } from './utils' -import { isNpmPluginNameValid, isPluginNameValid, isPluginTypeValid, isPluginVersionValid } from '../../helpers/custom-validators/plugins' -import { PluginManager } from '../../lib/plugins/plugin-manager' -import { isBooleanValid, isSafePath, toBooleanOrNull } from '../../helpers/custom-validators/misc' -import { PluginModel } from '../../models/server/plugin' -import { InstallOrUpdatePlugin } from '../../../shared/models/plugins/install-plugin.model' +import express from 'express' +import { body, param, query, ValidationChain } from 'express-validator' +import { HttpStatusCode } from '../../../shared/models/http/http-error-codes' import { PluginType } from '../../../shared/models/plugins/plugin.type' +import { InstallOrUpdatePlugin } from '../../../shared/models/plugins/server/api/install-plugin.model' +import { exists, isBooleanValid, isSafePath, toBooleanOrNull, toIntOrNull } from '../../helpers/custom-validators/misc' +import { + isNpmPluginNameValid, + isPluginNameValid, + isPluginStableOrUnstableVersionValid, + isPluginTypeValid +} from '../../helpers/custom-validators/plugins' import { CONFIG } from '../../initializers/config' +import { PluginManager } from '../../lib/plugins/plugin-manager' +import { PluginModel } from '../../models/server/plugin' +import { areValidationErrors } from './shared' + +const getPluginValidator = (pluginType: PluginType, withVersion = true) => { + const validators: (ValidationChain | express.Handler)[] = [ + param('pluginName') + .custom(isPluginNameValid) + ] + + if (withVersion) { + validators.push( + param('pluginVersion') + .custom(isPluginStableOrUnstableVersionValid) + ) + } + + return validators.concat([ + (req: express.Request, res: express.Response, next: express.NextFunction) => { + if (areValidationErrors(req, res)) return + + const npmName = PluginModel.buildNpmName(req.params.pluginName, pluginType) + const plugin = PluginManager.Instance.getRegisteredPluginOrTheme(npmName) + + if (!plugin) { + return res.fail({ + status: HttpStatusCode.NOT_FOUND_404, + message: 'No plugin found named ' + npmName + }) + } + if (withVersion && plugin.version !== req.params.pluginVersion) { + return res.fail({ + status: HttpStatusCode.NOT_FOUND_404, + message: 'No plugin found named ' + npmName + ' with version ' + req.params.pluginVersion + }) + } + + res.locals.registeredPlugin = plugin + + return next() + } + ]) +} -const servePluginStaticDirectoryValidator = (pluginType: PluginType) => [ - param('pluginName').custom(isPluginNameValid).withMessage('Should have a valid plugin name'), - param('pluginVersion').custom(isPluginVersionValid).withMessage('Should have a valid plugin version'), - param('staticEndpoint').custom(isSafePath).withMessage('Should have a valid static endpoint'), +const getExternalAuthValidator = [ + param('authName') + .custom(exists), (req: express.Request, res: express.Response, next: express.NextFunction) => { - logger.debug('Checking servePluginStaticDirectory parameters', { parameters: req.params }) - if (areValidationErrors(req, res)) return - const npmName = PluginModel.buildNpmName(req.params.pluginName, pluginType) - const plugin = PluginManager.Instance.getRegisteredPluginOrTheme(npmName) + const plugin = res.locals.registeredPlugin + if (!plugin.registerHelpers) { + return res.fail({ + status: HttpStatusCode.NOT_FOUND_404, + message: 'No registered helpers were found for this plugin' + }) + } - if (!plugin || plugin.version !== req.params.pluginVersion) { - return res.sendStatus(404) + const externalAuth = plugin.registerHelpers.getExternalAuths().find(a => a.authName === req.params.authName) + if (!externalAuth) { + return res.fail({ + status: HttpStatusCode.NOT_FOUND_404, + message: 'No external auths were found for this plugin' + }) } - res.locals.registeredPlugin = plugin + res.locals.externalAuth = externalAuth + + return next() + } +] + +const pluginStaticDirectoryValidator = [ + param('staticEndpoint') + .custom(isSafePath), + + (req: express.Request, res: express.Response, next: express.NextFunction) => { + if (areValidationErrors(req, res)) return return next() } @@ -36,15 +98,14 @@ const servePluginStaticDirectoryValidator = (pluginType: PluginType) => [ const listPluginsValidator = [ query('pluginType') .optional() - .custom(isPluginTypeValid).withMessage('Should have a valid plugin type'), + .customSanitizer(toIntOrNull) + .custom(isPluginTypeValid), query('uninstalled') .optional() .customSanitizer(toBooleanOrNull) - .custom(isBooleanValid).withMessage('Should have a valid uninstalled attribute'), + .custom(isBooleanValid), (req: express.Request, res: express.Response, next: express.NextFunction) => { - logger.debug('Checking listPluginsValidator parameters', { parameters: req.query }) - if (areValidationErrors(req, res)) return return next() @@ -54,21 +115,23 @@ const listPluginsValidator = [ const installOrUpdatePluginValidator = [ body('npmName') .optional() - .custom(isNpmPluginNameValid).withMessage('Should have a valid npm name'), + .custom(isNpmPluginNameValid), + body('pluginVersion') + .optional() + .custom(isPluginStableOrUnstableVersionValid), body('path') .optional() - .custom(isSafePath).withMessage('Should have a valid safe path'), + .custom(isSafePath), (req: express.Request, res: express.Response, next: express.NextFunction) => { - logger.debug('Checking installOrUpdatePluginValidator parameters', { parameters: req.body }) - if (areValidationErrors(req, res)) return const body: InstallOrUpdatePlugin = req.body if (!body.path && !body.npmName) { - return res.status(400) - .json({ error: 'Should have either a npmName or a path' }) - .end() + return res.fail({ message: 'Should have either a npmName or a path' }) + } + if (body.pluginVersion && !body.npmName) { + return res.fail({ message: 'Should have a npmName when specifying a pluginVersion' }) } return next() @@ -76,11 +139,10 @@ const installOrUpdatePluginValidator = [ ] const uninstallPluginValidator = [ - body('npmName').custom(isNpmPluginNameValid).withMessage('Should have a valid npm name'), + body('npmName') + .custom(isNpmPluginNameValid), (req: express.Request, res: express.Response, next: express.NextFunction) => { - logger.debug('Checking uninstallPluginValidator parameters', { parameters: req.body }) - if (areValidationErrors(req, res)) return return next() @@ -88,32 +150,30 @@ const uninstallPluginValidator = [ ] const existingPluginValidator = [ - param('npmName').custom(isNpmPluginNameValid).withMessage('Should have a valid plugin name'), + param('npmName') + .custom(isNpmPluginNameValid), async (req: express.Request, res: express.Response, next: express.NextFunction) => { - logger.debug('Checking enabledPluginValidator parameters', { parameters: req.params }) - if (areValidationErrors(req, res)) return const plugin = await PluginModel.loadByNpmName(req.params.npmName) if (!plugin) { - return res.status(404) - .json({ error: 'Plugin not found' }) - .end() + return res.fail({ + status: HttpStatusCode.NOT_FOUND_404, + message: 'Plugin not found' + }) } res.locals.plugin = plugin - return next() } ] const updatePluginSettingsValidator = [ - body('settings').exists().withMessage('Should have settings'), + body('settings') + .exists(), (req: express.Request, res: express.Response, next: express.NextFunction) => { - logger.debug('Checking enabledPluginValidator parameters', { parameters: req.body }) - if (areValidationErrors(req, res)) return return next() @@ -123,23 +183,20 @@ const updatePluginSettingsValidator = [ const listAvailablePluginsValidator = [ query('search') .optional() - .exists().withMessage('Should have a valid search'), + .exists(), query('pluginType') .optional() - .custom(isPluginTypeValid).withMessage('Should have a valid plugin type'), + .customSanitizer(toIntOrNull) + .custom(isPluginTypeValid), query('currentPeerTubeEngine') .optional() - .custom(isPluginVersionValid).withMessage('Should have a valid current peertube engine'), + .custom(isPluginStableOrUnstableVersionValid), (req: express.Request, res: express.Response, next: express.NextFunction) => { - logger.debug('Checking enabledPluginValidator parameters', { parameters: req.query }) - if (areValidationErrors(req, res)) return if (CONFIG.PLUGINS.INDEX.ENABLED === false) { - return res.status(400) - .json({ error: 'Plugin index is not enabled' }) - .end() + return res.fail({ message: 'Plugin index is not enabled' }) } return next() @@ -149,11 +206,13 @@ const listAvailablePluginsValidator = [ // --------------------------------------------------------------------------- export { - servePluginStaticDirectoryValidator, + pluginStaticDirectoryValidator, + getPluginValidator, updatePluginSettingsValidator, uninstallPluginValidator, listAvailablePluginsValidator, existingPluginValidator, installOrUpdatePluginValidator, - listPluginsValidator + listPluginsValidator, + getExternalAuthValidator }