X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fmiddlewares%2Fvalidators%2Fplugins.ts;h=2c47ec5bbd03aef78f0a852c98cae228d2f7357a;hb=4d7ce9218a3f695bf3d013cbdce1c5c6a5221927;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..2c47ec5bb 100644 --- a/server/middlewares/validators/plugins.ts +++ b/server/middlewares/validators/plugins.ts @@ -1,33 +1,73 @@ import * as express from 'express' -import { body, param, query } from 'express-validator' -import { logger } from '../../helpers/logger' -import { areValidationErrors } from './utils' +import { body, param, query, ValidationChain } from 'express-validator' +import { HttpStatusCode } from '../../../shared/core-utils/miscs/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, isPluginTypeValid, isPluginVersionValid } from '../../helpers/custom-validators/plugins' +import { logger } from '../../helpers/logger' +import { CONFIG } from '../../initializers/config' 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 { PluginType } from '../../../shared/models/plugins/plugin.type' -import { CONFIG } from '../../initializers/config' +import { areValidationErrors } from './utils' -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 getPluginValidator = (pluginType: PluginType, withVersion = true) => { + const validators: (ValidationChain | express.Handler)[] = [ + param('pluginName').custom(isPluginNameValid).withMessage('Should have a valid plugin name') + ] + + if (withVersion) { + validators.push( + param('pluginVersion').custom(isPluginVersionValid).withMessage('Should have a valid plugin version') + ) + } + + return validators.concat([ + (req: express.Request, res: express.Response, next: express.NextFunction) => { + logger.debug('Checking getPluginValidator parameters', { parameters: req.params }) + + if (areValidationErrors(req, res)) return + + const npmName = PluginModel.buildNpmName(req.params.pluginName, pluginType) + const plugin = PluginManager.Instance.getRegisteredPluginOrTheme(npmName) + + if (!plugin) return res.sendStatus(HttpStatusCode.NOT_FOUND_404) + if (withVersion && plugin.version !== req.params.pluginVersion) return res.sendStatus(HttpStatusCode.NOT_FOUND_404) + + res.locals.registeredPlugin = plugin + + return next() + } + ]) +} + +const getExternalAuthValidator = [ + param('authName').custom(exists).withMessage('Should have a valid auth name'), (req: express.Request, res: express.Response, next: express.NextFunction) => { - logger.debug('Checking servePluginStaticDirectory parameters', { parameters: req.params }) + logger.debug('Checking getExternalAuthValidator 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.sendStatus(HttpStatusCode.NOT_FOUND_404) - 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.sendStatus(HttpStatusCode.NOT_FOUND_404) + + res.locals.externalAuth = externalAuth + + return next() + } +] + +const pluginStaticDirectoryValidator = [ + param('staticEndpoint').custom(isSafePath).withMessage('Should have a valid static endpoint'), + + (req: express.Request, res: express.Response, next: express.NextFunction) => { + logger.debug('Checking pluginStaticDirectoryValidator parameters', { parameters: req.params }) - res.locals.registeredPlugin = plugin + if (areValidationErrors(req, res)) return return next() } @@ -36,6 +76,7 @@ const servePluginStaticDirectoryValidator = (pluginType: PluginType) => [ const listPluginsValidator = [ query('pluginType') .optional() + .customSanitizer(toIntOrNull) .custom(isPluginTypeValid).withMessage('Should have a valid plugin type'), query('uninstalled') .optional() @@ -66,9 +107,8 @@ const installOrUpdatePluginValidator = [ const body: InstallOrUpdatePlugin = req.body if (!body.path && !body.npmName) { - return res.status(400) + return res.status(HttpStatusCode.BAD_REQUEST_400) .json({ error: 'Should have either a npmName or a path' }) - .end() } return next() @@ -97,9 +137,8 @@ const existingPluginValidator = [ const plugin = await PluginModel.loadByNpmName(req.params.npmName) if (!plugin) { - return res.status(404) - .json({ error: 'Plugin not found' }) - .end() + return res.status(HttpStatusCode.NOT_FOUND_404) + .json({ error: 'Plugin not found' }) } res.locals.plugin = plugin @@ -126,6 +165,7 @@ const listAvailablePluginsValidator = [ .exists().withMessage('Should have a valid search'), query('pluginType') .optional() + .customSanitizer(toIntOrNull) .custom(isPluginTypeValid).withMessage('Should have a valid plugin type'), query('currentPeerTubeEngine') .optional() @@ -137,9 +177,9 @@ const listAvailablePluginsValidator = [ 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.status(HttpStatusCode.BAD_REQUEST_400) + .json({ error: 'Plugin index is not enabled' }) + .end() } return next() @@ -149,11 +189,13 @@ const listAvailablePluginsValidator = [ // --------------------------------------------------------------------------- export { - servePluginStaticDirectoryValidator, + pluginStaticDirectoryValidator, + getPluginValidator, updatePluginSettingsValidator, uninstallPluginValidator, listAvailablePluginsValidator, existingPluginValidator, installOrUpdatePluginValidator, - listPluginsValidator + listPluginsValidator, + getExternalAuthValidator }