Skip to content

Initial attempt at restricting endpoints #2877

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Initial attempt at restricting endpoints #2877

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions backend/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions backend/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@
"nodemailer": "^7.0.7",
"outdent": "^0.8.0",
"p-queue": "^9.0.0",
"path-to-regexp": "^8.3.0",
"pretty-bytes": "^7.1.0",
"proxy-agent": "^6.5.0",
"qs": "^6.14.0",
Expand Down
211 changes: 5 additions & 206 deletions backend/src/routes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,227 +5,26 @@ import swaggerUi from 'swagger-ui-express'
import { fileURLToPath } from 'url'

import authentication from './connectors/authentication/index.js'
import { expressErrorHandler } from './routes/middleware/expressErrorHandler.js'
import { expressLogger } from './routes/middleware/expressLogger.js'
import { requestId } from './routes/middleware/requestId.js'
import { getDockerRegistryAuth } from './routes/v1/registryAuth.js'
import { getCurrentUser } from './routes/v2/entities/getCurrentUser.js'
import { getEntities } from './routes/v2/entities/getEntities.js'
import { getEntityLookup } from './routes/v2/entities/getEntityLookup.js'
import { getFilescanningInfo } from './routes/v2/filescanning/getFilescanningInfo.js'
import { putFileScan } from './routes/v2/filescanning/putFileScan.js'
import { deleteAccessRequest } from './routes/v2/model/accessRequest/deleteAccessRequest.js'
import { getAccessRequest } from './routes/v2/model/accessRequest/getAccessRequest.js'
import { getAccessRequestCurrentUserPermissions } from './routes/v2/model/accessRequest/getAccessRequestCurrentUserPermissions.js'
import { getModelAccessRequests } from './routes/v2/model/accessRequest/getModelAccessRequests.js'
import { patchAccessRequest } from './routes/v2/model/accessRequest/patchAccessRequest.js'
import { postAccessRequest } from './routes/v2/model/accessRequest/postAccessRequest.js'
import { postAccessRequestComment } from './routes/v2/model/accessRequest/postAccessRequestComment.js'
import { deleteFile } from './routes/v2/model/file/deleteFile.js'
import { getDownloadFile } from './routes/v2/model/file/getDownloadFile.js'
import { getFiles } from './routes/v2/model/file/getFiles.js'
import { patchFile } from './routes/v2/model/file/patchFile.js'
import { postFinishMultipartUpload } from './routes/v2/model/file/postFinishMultipartUpload.js'
import { postSimpleUpload } from './routes/v2/model/file/postSimpleUpload.js'
import { postStartMultipartUpload } from './routes/v2/model/file/postStartMultipartUpload.js'
import { getModel } from './routes/v2/model/getModel.js'
import { getModelCurrentUserPermissions } from './routes/v2/model/getModelCurrentUserPermissions.js'
import { getModelsSearch } from './routes/v2/model/getModelsSearch.js'
import { getImages } from './routes/v2/model/images/getImages.js'
import { deleteInference } from './routes/v2/model/inferencing/deleteInferenceService.js'
import { getInference } from './routes/v2/model/inferencing/getInferenceService.js'
import { getInferences } from './routes/v2/model/inferencing/getInferenceServices.js'
import { postInference } from './routes/v2/model/inferencing/postInferenceService.js'
import { putInference } from './routes/v2/model/inferencing/putInferenceService.js'
import { getModelCard } from './routes/v2/model/modelcard/getModelCard.js'
import { getModelCardHtml } from './routes/v2/model/modelcard/getModelCardHtml.js'
import { getModelCardRevisions } from './routes/v2/model/modelcard/getModelCardRevisions.js'
import { postFromSchema } from './routes/v2/model/modelcard/postFromSchema.js'
import { postFromTemplate } from './routes/v2/model/modelcard/postFromTemplate.js'
import { putModelCard } from './routes/v2/model/modelcard/putModelCard.js'
import { patchModel } from './routes/v2/model/patchModel.js'
import { postModel } from './routes/v2/model/postModel.js'
import { postRequestExportToS3 } from './routes/v2/model/postRequestExport.js'
import { postRequestImportFromS3 } from './routes/v2/model/postRequestImport.js'
import { getModelRoles } from './routes/v2/model/roles/getModelRoles.js'
import { deleteWebhook } from './routes/v2/model/webhook/deleteWebhook.js'
import { getWebhooks } from './routes/v2/model/webhook/getWebhooks.js'
import { postWebhook } from './routes/v2/model/webhook/postWebhook.js'
import { putWebhook } from './routes/v2/model/webhook/putWebhook.js'
import { deleteRelease } from './routes/v2/release/deleteRelease.js'
import { getRelease } from './routes/v2/release/getRelease.js'
import { getReleases } from './routes/v2/release/getReleases.js'
import { postRelease } from './routes/v2/release/postRelease.js'
import { postReleaseComment } from './routes/v2/release/postReleaseComment.js'
import { putRelease } from './routes/v2/release/putRelease.js'
import { getResponses } from './routes/v2/response/getResponses.js'
import { patchResponse } from './routes/v2/response/patchResponse.js'
import { patchResponseReaction } from './routes/v2/response/patchResponseReaction.js'
import { deleteReviewRole } from './routes/v2/review/deleteReviewRole.js'
import { getReviewRoles } from './routes/v2/review/getReviewRoles.js'
import { getReviews } from './routes/v2/review/getReviews.js'
import { postAccessRequestReviewResponse } from './routes/v2/review/postAccessRequestReviewResponse.js'
import { postReleaseReviewResponse } from './routes/v2/review/postReleaseReviewResponse.js'
import { postReviewRole } from './routes/v2/review/postReviewRole.js'
import { putReviewRole } from './routes/v2/review/putReviewRole.js'
import { deleteSchema } from './routes/v2/schema/deleteSchema.js'
import { getSchema } from './routes/v2/schema/getSchema.js'
import { getSchemaMigrations } from './routes/v2/schema/getSchemaMigrations.js'
import { getSchemas } from './routes/v2/schema/getSchemas.js'
import { patchSchema } from './routes/v2/schema/patchSchema.js'
import { postSchema } from './routes/v2/schema/postSchema.js'
import { postSchemaMigration } from './routes/v2/schema/postSchemaMigration.js'
import { getSpecification } from './routes/v2/specification.js'
import { getPeerStatus } from './routes/v2/system/peers.js'
import { getSystemStatus } from './routes/v2/system/status.js'
import { getUiConfig } from './routes/v2/uiConfig/getUiConfig.js'
import { deleteUserToken } from './routes/v2/user/deleteUserToken.js'
import { getUserTokenList } from './routes/v2/user/getUserTokenList.js'
import { getUserTokens } from './routes/v2/user/getUserTokens.js'
import { postUserToken } from './routes/v2/user/postUserToken.js'
import v1Router from './routes/v1/routes.js'
import v2Router from './routes/v2/routes.js'
import { generateSwaggerSpec } from './services/specification.js'
import config from './utils/config.js'

export const server = express()

server.use('/api/v2', requestId)
server.use('/api/v2', bodyParser.json())
server.use('/api/v2', expressLogger)
server.use(requestId, bodyParser.json(), expressLogger)
const middlewareConfigs = authentication.authenticationMiddleware()
for (const middlewareConf of middlewareConfigs) {
server.use(middlewareConf?.path || '/', middlewareConf.middleware)
}

server.use('/api/v2/docs', swaggerUi.serve, swaggerUi.setup(generateSwaggerSpec()))

server.get('/api/v1/registry_auth', ...getDockerRegistryAuth)

server.get('/api/v2/system/status', ...getSystemStatus)
server.get('/api/v2/system/peers', ...getPeerStatus)

server.post('/api/v2/models', ...postModel)
server.get('/api/v2/models/search', ...getModelsSearch)
// server.post('/api/v2/models/import', ...postModelImport)

server.get('/api/v2/model/:modelId', ...getModel)
server.patch('/api/v2/model/:modelId', ...patchModel)

server.post('/api/v2/model/:modelId/export/s3', ...postRequestExportToS3)
server.post('/api/v2/model/import/s3', ...postRequestImportFromS3)

server.get('/api/v2/model/:modelId/model-card/:version', ...getModelCard)
server.get('/api/v2/model/:modelId/model-card/:version/html', ...getModelCardHtml)
server.get('/api/v2/model/:modelId/model-card-revisions', ...getModelCardRevisions)
server.put('/api/v2/model/:modelId/model-cards', ...putModelCard) // *server.get('/api/v2/template/models', ...getModelTemplates)
// *server.post('/api/v2/model/:modelId/setup/from-existing', ...postFromExisting)
server.post(`/api/v2/model/:modelId/setup/from-template`, ...postFromTemplate)
server.post('/api/v2/model/:modelId/setup/from-schema', ...postFromSchema)

server.post('/api/v2/model/:modelId/releases', ...postRelease)
server.get('/api/v2/model/:modelId/releases', ...getReleases)
server.get('/api/v2/model/:modelId/release/:semver', ...getRelease)
server.get('/api/v2/model/:modelId/release/:semver/file/:fileName/download', ...getDownloadFile)
// This is a temporary workaround to split out the URL to disable authorisation.
server.get('/api/v2/token/model/:modelId/release/:semver/file/:fileName/download', ...getDownloadFile)
server.put('/api/v2/model/:modelId/release/:semver', ...putRelease)
server.post('/api/v2/model/:modelId/release/:semver/comment', ...postReleaseComment)
server.delete('/api/v2/model/:modelId/release/:semver', ...deleteRelease)
server.post('/api/v2/model/:modelId/release/:semver/review', ...postReleaseReviewResponse)

server.post('/api/v2/model/:modelId/access-requests', ...postAccessRequest)
server.get('/api/v2/model/:modelId/access-requests', getModelAccessRequests)
server.get('/api/v2/model/:modelId/access-request/:accessRequestId', ...getAccessRequest)
server.delete('/api/v2/model/:modelId/access-request/:accessRequestId', ...deleteAccessRequest)
server.patch('/api/v2/model/:modelId/access-request/:accessRequestId', ...patchAccessRequest)
server.post('/api/v2/model/:modelId/access-request/:accessRequestId/comment', ...postAccessRequestComment)
server.post('/api/v2/model/:modelId/access-request/:accessRequestId/review', ...postAccessRequestReviewResponse)
server.get(
'/api/v2/model/:modelId/access-request/:accessRequestId/permissions/mine',
...getAccessRequestCurrentUserPermissions,
)

server.get('/api/v2/model/:modelId/files', ...getFiles)
server.get('/api/v2/model/:modelId/file/:fileId/download', ...getDownloadFile)
// This is a temporary workaround to split out the URL to disable authorisation.
server.get('/api/v2/token/model/:modelId/file/:fileId/download', ...getDownloadFile)
server.post('/api/v2/model/:modelId/files/upload/simple', ...postSimpleUpload)
server.post('/api/v2/model/:modelId/files/upload/multipart/start', ...postStartMultipartUpload)
server.post('/api/v2/model/:modelId/files/upload/multipart/finish', ...postFinishMultipartUpload)
server.delete('/api/v2/model/:modelId/file/:fileId', ...deleteFile)
server.patch('/api/v2/model/:modelId/file/:fileId', ...patchFile)

server.post('/api/v2/model/:modelId/webhooks', ...postWebhook)
server.get('/api/v2/model/:modelId/webhooks', ...getWebhooks)
server.put('/api/v2/model/:modelId/webhook/:webhookId', ...putWebhook)
server.delete('/api/v2/model/:modelId/webhook/:webhookId', ...deleteWebhook)

server.get('/api/v2/model/:modelId/images', ...getImages)
// *server.delete('/api/v2/model/:modelId/images/:imageId', ...deleteImage)
server.get('/api/v2/model/:modelId/files', ...getFiles)
server.get('/api/v2/model/:modelId/file/:fileId/download', ...getDownloadFile)
// This is a temporary workaround to split out the URL to disable authorisation.
server.get('/api/v2/token/model/:modelId/file/:fileId/download', ...getDownloadFile)
server.post('/api/v2/model/:modelId/files/upload/simple', ...postSimpleUpload)
server.post('/api/v2/model/:modelId/files/upload/multipart/start', ...postStartMultipartUpload)
server.post('/api/v2/model/:modelId/files/upload/multipart/finish', ...postFinishMultipartUpload)
server.delete('/api/v2/model/:modelId/file/:fileId', ...deleteFile)

// Inferencing routes are conditional to Bailo specific configuration
// NOTE: Enabled if config not loaded for testing purposes
if (!config.ui?.inference || config.ui.inference?.enabled) {
server.get('/api/v2/model/:modelId/inferences', ...getInferences)
server.get('/api/v2/model/:modelId/inference/:image/:tag', ...getInference)
server.post('/api/v2/model/:modelId/inference', ...postInference)
server.put('/api/v2/model/:modelId/inference/:image/:tag', ...putInference)
server.delete('/api/v2/model/:modelId/inference/:image/:tag', ...deleteInference)
}

// *server.get('/api/v2/model/:modelId/release/:semver/file/:fileCode/list', ...getModelFileList)
// *server.get('/api/v2/model/:modelId/release/:semver/file/:fileCode/raw', ...getModelFileRaw)

server.get('/api/v2/schemas', ...getSchemas)
server.get('/api/v2/schema/:schemaId', ...getSchema)
server.post('/api/v2/schemas', ...postSchema)
server.patch('/api/v2/schema/:schemaId', ...patchSchema)
server.delete('/api/v2/schema/:schemaId', ...deleteSchema)

server.get('/api/v2/schema-migrations', ...getSchemaMigrations)
server.post('/api/v2/schema-migration', ...postSchemaMigration)

server.get('/api/v2/reviews', ...getReviews)
server.head('/api/v2/reviews', ...getReviews)
server.get('/api/v2/responses', ...getResponses)
server.patch('/api/v2/response/:responseId', ...patchResponse)
server.patch('/api/v2/response/:responseId/reaction/:kind', ...patchResponseReaction)

server.get('/api/v2/roles', ...getModelRoles)
server.get('/api/v2/model/:modelId/permissions/mine', ...getModelCurrentUserPermissions)

server.get('/api/v2/entities', ...getEntities)
server.get('/api/v2/entities/me', ...getCurrentUser)
server.get('/api/v2/entity/:dn/lookup', ...getEntityLookup)

server.get('/api/v2/config/ui', ...getUiConfig)

server.post('/api/v2/user/tokens', ...postUserToken)
server.get('/api/v2/user/tokens', ...getUserTokens)
server.get('/api/v2/user/tokens/list', ...getUserTokenList)
// server.get('/api/v2/user/:userId/token/:tokenId', ...getUserToken)
server.delete('/api/v2/user/token/:accessKey', ...deleteUserToken)

server.get('/api/v2/specification', ...getSpecification)

server.get('/api/v2/filescanning/info', ...getFilescanningInfo)
server.put('/api/v2/filescanning/model/:modelId/file/:fileId/scan', ...putFileScan)

server.get('/api/v2/review/roles', ...getReviewRoles)
server.delete('/api/v2/review/role/:reviewRoleShortName', ...deleteReviewRole)
server.post('/api/v2/review/role', ...postReviewRole)
server.put('/api/v2/review/role/:shortName', ...putReviewRole)
server.use('/api/v1', v1Router)
server.use('/api/v2', v2Router)

// Python docs
const __filename = fileURLToPath(import.meta.url)
const __dirname = path.dirname(__filename)
server.use('/docs/python', express.static(path.join(__dirname, '../python-docs/dirhtml')))

server.use('/api/v2', expressErrorHandler)
31 changes: 31 additions & 0 deletions backend/src/routes/middleware/entryType.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import { NextFunction, Request, Response } from 'express'
import { MatchFunction } from 'path-to-regexp'

import { getModelById } from '../../services/model.js'
import { BadReq } from '../../utils/error.js'

export type AllowList =
| {
allow: { url: MatchFunction<Partial<Record<string, string | string[]>>>; method: string[] }[]
allowAll?: never
}
| {
allow?: never
allowAll: true
}

export function entryKindCheck(allowList: { model: AllowList; 'data-card': AllowList; mirroredModel: AllowList }) {
return async function (req: Request, res: Response, next: NextFunction) {
const entry = await getModelById(req.user, req.params.modelId)
const entryAllowList = allowList[entry.kind]
if (entryAllowList.allowAll) {
return next()
} else if (
entryAllowList.allow &&
entryAllowList.allow.some((item) => item.method.includes(req.method) && item.url(req.path))
) {
return next()
}
throw BadReq('Deny')
Copy link
Member

@GB907762 GB907762 Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we give the user the EntryKind as context?

}
}
2 changes: 1 addition & 1 deletion backend/src/routes/middleware/requestId.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { NextFunction, Request, Response } from 'express'
import { v4 as uuidv4 } from 'uuid'

export async function requestId(req: Request, res: Response, next: NextFunction) {
export function requestId(req: Request, res: Response, next: NextFunction) {
req.reqId = (req.headers['x-request-id'] as string) || uuidv4()

next()
Expand Down
9 changes: 9 additions & 0 deletions backend/src/routes/v1/routes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { Router } from 'express'

import { getDockerRegistryAuth } from './registryAuth.js'

const router = Router()

router.get('/registry_auth', ...getDockerRegistryAuth)

export default router
Loading