]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/controllers/plugins.ts
Refactor auth flow
[github/Chocobozzz/PeerTube.git] / server / controllers / plugins.ts
index 1fc49b646fb2f2ea16e71d567a75259e2a651530..105f515184130196a093d5f2d842448e5e7542ca 100644 (file)
@@ -1,12 +1,15 @@
 import * as express from 'express'
-import { PLUGIN_GLOBAL_CSS_PATH } from '../initializers/constants'
 import { join } from 'path'
-import { PluginManager, RegisteredPlugin } from '../lib/plugins/plugin-manager'
-import { getPluginValidator, pluginStaticDirectoryValidator } from '../middlewares/validators/plugins'
-import { serveThemeCSSValidator } from '../middlewares/validators/themes'
+import { logger } from '@server/helpers/logger'
+import { optionalAuthenticate } from '@server/middlewares/auth'
+import { getCompleteLocale, is18nLocale } from '../../shared/core-utils/i18n'
+import { HttpStatusCode } from '../../shared/core-utils/miscs/http-error-codes'
 import { PluginType } from '../../shared/models/plugins/plugin.type'
 import { isTestInstance } from '../helpers/core-utils'
-import { getCompleteLocale, is18nLocale } from '../../shared/models/i18n'
+import { PLUGIN_GLOBAL_CSS_PATH } from '../initializers/constants'
+import { PluginManager, RegisteredPlugin } from '../lib/plugins/plugin-manager'
+import { getExternalAuthValidator, getPluginValidator, pluginStaticDirectoryValidator } from '../middlewares/validators/plugins'
+import { serveThemeCSSValidator } from '../middlewares/validators/themes'
 
 const sendFileOptions = {
   maxAge: '30 days',
@@ -23,6 +26,12 @@ pluginsRouter.get('/plugins/translations/:locale.json',
   getPluginTranslations
 )
 
+pluginsRouter.get('/plugins/:pluginName/:pluginVersion/auth/:authName',
+  getPluginValidator(PluginType.PLUGIN),
+  getExternalAuthValidator,
+  handleAuthInPlugin
+)
+
 pluginsRouter.get('/plugins/:pluginName/:pluginVersion/static/:staticEndpoint(*)',
   getPluginValidator(PluginType.PLUGIN),
   pluginStaticDirectoryValidator,
@@ -37,11 +46,13 @@ pluginsRouter.get('/plugins/:pluginName/:pluginVersion/client-scripts/:staticEnd
 
 pluginsRouter.use('/plugins/:pluginName/router',
   getPluginValidator(PluginType.PLUGIN, false),
+  optionalAuthenticate,
   servePluginCustomRoutes
 )
 
 pluginsRouter.use('/plugins/:pluginName/:pluginVersion/router',
   getPluginValidator(PluginType.PLUGIN),
+  optionalAuthenticate,
   servePluginCustomRoutes
 )
 
@@ -89,7 +100,7 @@ function getPluginTranslations (req: express.Request, res: express.Response) {
     return res.json(json)
   }
 
-  return res.sendStatus(404)
+  return res.sendStatus(HttpStatusCode.NOT_FOUND_404)
 }
 
 function servePluginStaticDirectory (req: express.Request, res: express.Response) {
@@ -99,7 +110,7 @@ function servePluginStaticDirectory (req: express.Request, res: express.Response
   const [ directory, ...file ] = staticEndpoint.split('/')
 
   const staticPath = plugin.staticDirs[directory]
-  if (!staticPath) return res.sendStatus(404)
+  if (!staticPath) return res.sendStatus(HttpStatusCode.NOT_FOUND_404)
 
   const filepath = file.join('/')
   return res.sendFile(join(plugin.path, staticPath, filepath), sendFileOptions)
@@ -109,7 +120,7 @@ function servePluginCustomRoutes (req: express.Request, res: express.Response, n
   const plugin: RegisteredPlugin = res.locals.registeredPlugin
   const router = PluginManager.Instance.getRouter(plugin.npmName)
 
-  if (!router) return res.sendStatus(404)
+  if (!router) return res.sendStatus(HttpStatusCode.NOT_FOUND_404)
 
   return router(req, res, next)
 }
@@ -119,7 +130,7 @@ function servePluginClientScripts (req: express.Request, res: express.Response)
   const staticEndpoint = req.params.staticEndpoint
 
   const file = plugin.clientScripts[staticEndpoint]
-  if (!file) return res.sendStatus(404)
+  if (!file) return res.sendStatus(HttpStatusCode.NOT_FOUND_404)
 
   return res.sendFile(join(plugin.path, staticEndpoint), sendFileOptions)
 }
@@ -129,8 +140,19 @@ function serveThemeCSSDirectory (req: express.Request, res: express.Response) {
   const staticEndpoint = req.params.staticEndpoint
 
   if (plugin.css.includes(staticEndpoint) === false) {
-    return res.sendStatus(404)
+    return res.sendStatus(HttpStatusCode.NOT_FOUND_404)
   }
 
   return res.sendFile(join(plugin.path, staticEndpoint), sendFileOptions)
 }
+
+function handleAuthInPlugin (req: express.Request, res: express.Response) {
+  const authOptions = res.locals.externalAuth
+
+  try {
+    logger.debug('Forwarding auth plugin request in %s of plugin %s.', authOptions.authName, res.locals.registeredPlugin.npmName)
+    authOptions.onAuthRequest(req, res)
+  } catch (err) {
+    logger.error('Forward request error in auth %s of plugin %s.', authOptions.authName, res.locals.registeredPlugin.npmName, { err })
+  }
+}