import Router from "@koa/router" const compress = require("koa-compress") const zlib = require("zlib") import { routes } from "./routes" import { middleware as pro } from "@budibase/pro" import { errors, auth, middleware } from "@budibase/backend-core" import { APIError } from "@budibase/types" const PUBLIC_ENDPOINTS = [ // old deprecated endpoints kept for backwards compat { route: "/api/admin/auth/google/callback", method: "GET", }, { route: "/api/admin/auth/oidc/callback", method: "GET", }, { // this covers all of the POST auth routes route: "/api/global/auth/:tenantId", method: "POST", }, { // this covers all of the GET auth routes route: "/api/global/auth/:tenantId", method: "GET", }, { // this covers all of the public config routes route: "/api/global/configs/public", method: "GET", }, { route: "/api/global/configs/checklist", method: "GET", }, { route: "/api/global/users/init", method: "POST", }, { route: "/api/global/users/invite/accept", method: "POST", }, { route: "api/system/environment", method: "GET", }, { route: "api/system/status", method: "GET", }, { route: "/api/global/users/tenant/:id", method: "GET", }, ] const NO_TENANCY_ENDPOINTS = [ ...PUBLIC_ENDPOINTS, { route: "/api/system", method: "ALL", }, { route: "/api/global/users/self", method: "GET", }, { route: "/api/global/self", method: "GET", }, ] // most public endpoints are gets, but some are posts // add them all to be safe const NO_CSRF_ENDPOINTS = [...PUBLIC_ENDPOINTS] const router = new Router() router .use( compress({ threshold: 2048, gzip: { flush: zlib.constants.Z_SYNC_FLUSH, }, deflate: { flush: zlib.constants.Z_SYNC_FLUSH, }, br: false, }) ) .use("/health", ctx => (ctx.status = 200)) .use(auth.buildAuthMiddleware(PUBLIC_ENDPOINTS)) .use(auth.buildTenancyMiddleware(PUBLIC_ENDPOINTS, NO_TENANCY_ENDPOINTS)) .use(auth.buildCsrfMiddleware({ noCsrfPatterns: NO_CSRF_ENDPOINTS })) .use(pro.licensing()) // for now no public access is allowed to worker (bar health check) .use((ctx, next) => { if (ctx.publicEndpoint) { return next() } if ( (!ctx.isAuthenticated || (ctx.user && !ctx.user.budibaseAccess)) && !ctx.internal ) { ctx.throw(403, "Unauthorized - no public worker access") } return next() }) .use(middleware.auditLog) // error handling middleware - TODO: This could be moved to backend-core router.use(async (ctx, next) => { try { await next() } catch (err: any) { ctx.log.error(err) ctx.status = err.status || err.statusCode || 500 const error = errors.getPublicError(err) const body: APIError = { message: err.message, status: ctx.status, error, } ctx.body = body } }) router.get("/health", ctx => (ctx.status = 200)) // authenticated routes for (let route of routes) { router.use(route.routes()) router.use(route.allowedMethods()) } module.exports = router