@xen-orchestra/rest-api 0.28.2 → 0.30.0

package/dist/tasks/task.controller.mjs

@@ -8,8 +8,9 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
     return function (target, key) { decorator(target, key, paramIndex); }
 };
 import { XoController } from '../abstract-classes/xo-controller.mjs';
-import { Get, Path, Query, Request, Route, Security, Tags, Response, Example, Delete, Post, SuccessResponse, } from 'tsoa';
-import { asynchronousActionResp, badRequestResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
+import { Get, Path, Query, Request, Route, Security, Tags, Response, Example, Delete, Post, SuccessResponse, Middlewares, } from 'tsoa';
+import { acl } from '../middlewares/acl.middleware.mjs';
+import { asynchronousActionResp, badRequestResp, forbiddenOperationResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
 import { inject } from 'inversify';
 import { provide } from 'inversify-binding-decorators';
 import { partialTasks, task, taskIds, taskLocation } from '../open-api/oa-examples/task.oa-example.mjs';
@@ -19,6 +20,7 @@ import { Transform } from 'node:stream';
 import { makeObjectMapper } from '../helpers/object-wrapper.helper.mjs';
 import { safeParseComplexMatcher } from '../helpers/utils.helper.mjs';
 import { RestApi } from '../rest-api/rest-api.mjs';
+import { hasPrivilegeOn } from '@xen-orchestra/acl';
 let TaskController = class TaskController extends XoController {
     constructor(restApi) {
         super('task', restApi);
@@ -34,6 +36,8 @@ let TaskController = class TaskController extends XoController {
         return this.restApi.tasks.get(id);
     }
     /**
+     * Returns all tasks that match the following privilege:
+     * - resource: task, action: read
      *
      * If watch is true, ndjson must also be true
      *
@@ -41,7 +45,7 @@ let TaskController = class TaskController extends XoController {
      * @example filter "status:failure"
      * @example limit 42
      */
-    async getTasks(req, fields, ndjson, watch, filter, limit) {
+    async getTasks(req, fields, ndjson, markdown, watch, filter, limit) {
         if (watch) {
             if (!ndjson) {
                 throw new ApiError('watch=true requires ndjson=true', 400);
@@ -63,21 +67,36 @@ let TaskController = class TaskController extends XoController {
             process.on('SIGTERM', () => {
                 req.destroy();
             });
-            function update(task) {
-                if (userFilter === undefined || userFilter(task)) {
+            const userId = this.restApi.getCurrentUser().id;
+            const update = async (task) => {
+                const user = await this.restApi.xoApp.getUser(userId);
+                const userPrivileges = (await this.restApi.xoApp.getAclV2UserPrivileges(user.id));
+                if (hasPrivilegeOn({ user, userPrivileges, action: 'read', resource: 'task', objects: task }) &&
+                    (userFilter === undefined || userFilter(task))) {
                     stream.write(['update', task]);
                 }
-            }
-            function remove(task) {
-                stream.write(['remove', { id: task.id }]);
-            }
+            };
+            const remove = async (task) => {
+                const user = await this.restApi.xoApp.getUser(userId);
+                const userPrivileges = (await this.restApi.xoApp.getAclV2UserPrivileges(user.id));
+                if (hasPrivilegeOn({ user, userPrivileges, action: 'read', resource: 'task', objects: task }) &&
+                    (userFilter === undefined || userFilter(task))) {
+                    stream.write(['remove', { id: task.id }]);
+                }
+            };
             this.restApi.tasks.on('update', update).on('remove', remove);
             return stream;
         }
-        const tasks = Object.values(await this.getObjects({ filter, limit }));
-        return this.sendObjects(tasks, req);
+        const tasks = Object.values(await this.getObjects({ filter }));
+        return this.sendObjects(tasks, req, {
+            limit,
+            privilege: { action: 'read', resource: 'task' },
+        });
     }
     /**
+     * Required privilege:
+     * - resource: task, action: read
+     *
      * @example id "0mdd1basu"
      */
     async getTask(req, id, wait) {
@@ -95,10 +114,25 @@ let TaskController = class TaskController extends XoController {
         }
         return this.getObject(taskId);
     }
+    /**
+     * Deletes all tasks the current user has the following privilege on:
+     * - resource: task, action: delete
+     */
     async deleteTasks() {
-        await this.restApi.tasks.clearLogs();
+        const user = this.restApi.getCurrentUser();
+        const userPrivileges = (await this.restApi.xoApp.getAclV2UserPrivileges(user.id));
+        const deletePromises = [];
+        for await (const task of this.restApi.tasks.list()) {
+            if (hasPrivilegeOn({ user, userPrivileges, resource: 'task', action: 'delete', objects: task })) {
+                deletePromises.push(this.restApi.tasks.deleteLog(task.id));
+            }
+        }
+        await Promise.all(deletePromises);
     }
     /**
+     * Required privilege:
+     * - resource: task, action: delete
+     *
      * @example id "0mdd1basu"
      */
     async deleteTask(id) {
@@ -106,6 +140,9 @@ let TaskController = class TaskController extends XoController {
         await this.restApi.tasks.deleteLog(task.id);
     }
     /**
+     * Required privilege:
+     * - resource: task, action: abort
+     *
      * @example id "0mdd1basu"
      */
     async abortTask(id, sync) {
@@ -127,17 +164,26 @@ __decorate([
     Example(taskIds),
     Example(partialTasks),
     Get(''),
+    Security('*', ['acl']),
     Response(badRequestResp.status, badRequestResp.description),
     __param(0, Request()),
     __param(1, Query()),
     __param(2, Query()),
     __param(3, Query()),
     __param(4, Query()),
-    __param(5, Query())
+    __param(5, Query()),
+    __param(6, Query())
 ], TaskController.prototype, "getTasks", null);
 __decorate([
     Example(task),
     Get('{id}'),
+    Middlewares(acl({
+        resource: 'task',
+        action: 'read',
+        objectId: 'params.id',
+        getObject: ({ restApi }) => restApi.xoApp.tasks.get.bind(restApi.xoApp.tasks),
+    })),
+    Response(forbiddenOperationResp.status, forbiddenOperationResp.description),
     Response(notFoundResp.status, notFoundResp.description),
     __param(0, Request()),
     __param(1, Path()),
@@ -145,19 +191,34 @@ __decorate([
 ], TaskController.prototype, "getTask", null);
 __decorate([
     Delete(''),
+    Security('*', ['acl']),
     SuccessResponse(noContentResp.status, noContentResp.description)
 ], TaskController.prototype, "deleteTasks", null);
 __decorate([
     Delete('{id}'),
+    Middlewares(acl({
+        resource: 'task',
+        action: 'delete',
+        objectId: 'params.id',
+        getObject: ({ restApi }) => restApi.xoApp.tasks.get.bind(restApi.xoApp.tasks),
+    })),
     SuccessResponse(noContentResp.status, noContentResp.description),
+    Response(forbiddenOperationResp.status, forbiddenOperationResp.description),
     Response(notFoundResp.status, notFoundResp.description),
     __param(0, Path())
 ], TaskController.prototype, "deleteTask", null);
 __decorate([
     Example(taskLocation),
     Post('{id}/actions/abort'),
+    Middlewares(acl({
+        resource: 'task',
+        action: 'abort',
+        objectId: 'params.id',
+        getObject: ({ restApi }) => restApi.xoApp.tasks.get.bind(restApi.xoApp.tasks),
+    })),
     SuccessResponse(asynchronousActionResp.status, asynchronousActionResp.description),
     Response(noContentResp.status, noContentResp.description),
+    Response(forbiddenOperationResp.status, forbiddenOperationResp.description),
     Response(notFoundResp.status, notFoundResp.description),
     __param(0, Path()),
     __param(1, Query())

package/dist/users/user.controller.mjs

@@ -9,11 +9,12 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
 };
 import { Body, Delete, Deprecated, Example, Get, Middlewares, Patch, Path, Post, Query, Request, Response, Route, Security, SuccessResponse, Tags, } from 'tsoa';
 import { createLogger } from '@xen-orchestra/log';
+import { forbiddenOperation } from 'xo-common/api-errors.js';
 import { inject } from 'inversify';
 import { json } from 'express';
 import { provide } from 'inversify-binding-decorators';
+import { acl, actionIfNotSelfUser, actionsFromBody } from '../middlewares/acl.middleware.mjs';
 import { badRequestResp, createdResp, forbiddenOperationResp, internalServerErrorResp, invalidParameters, noContentResp, notFoundResp, resourceAlreadyExists, unauthorizedResp, } from '../open-api/common/response.common.mjs';
-import { forbiddenOperation } from 'xo-common/api-errors.js';
 import { partialUsers, user, authenticationTokens, userId, userIds, authenticationToken, } from '../open-api/oa-examples/user.oa-example.mjs';
 import { RestApi } from '../rest-api/rest-api.mjs';
 import { limitAndFilterArray } from '../helpers/utils.helper.mjs';
@@ -22,6 +23,7 @@ import { XoController } from '../abstract-classes/xo-controller.mjs';
 import { groupIds, partialGroups } from '../open-api/oa-examples/group.oa-example.mjs';
 import { partialTasks, taskIds } from '../open-api/oa-examples/task.oa-example.mjs';
 import { redirectMeAlias } from './user.middleware.mjs';
+import { aclPrivilegeIds, partialAclPrivileges } from '../open-api/oa-examples/acl-privilege.oa-example.mjs';
 const log = createLogger('xo:rest-api:user-controller');
 let UserController = class UserController extends XoController {
     #userService;
@@ -37,21 +39,39 @@ let UserController = class UserController extends XoController {
         return this.#userService.getUser(id);
     }
     /**
+     * Returns all users that match the following privilege:
+     * - resource: user, action: read
+     *
      * @example fields "permission,name,id"
      * @example filter "permission:none"
      * @example limit 42
      */
-    async getUsers(req, fields, ndjson, filter, limit) {
-        const users = Object.values(await this.getObjects({ filter, limit }));
-        return this.sendObjects(users, req);
+    async getUsers(req, fields, ndjson, markdown, filter, limit) {
+        const users = Object.values(await this.getObjects({ filter }));
+        return this.sendObjects(users, req, {
+            limit,
+            privilege: { action: 'read', resource: 'user' },
+        });
     }
     /**
+     * Required privilege:
+     * - resource: user, action: read (if not self)
+     *
      * @example id "722d17b9-699b-49d2-8193-be1ac573d3de"
      */
     getUser(id) {
         return this.getObject(id);
     }
     /**
+     * You cannot change your own `permission` (even with the right privilege)
+     *
+     * Required privileges:
+     * - resource: user, action: update (grants all fields)
+     * - resource: user, action: update:name (if name is passed)
+     * - resource: user, action: update:password (if password is passed)
+     * - resource: user, action: update:permission (if permission is passed)
+     * - resource: user, action: update:preferences (if preferences is passed)
+     *
      * @example id "722d17b9-699b-49d2-8193-be1ac573d3de"
      * @example body {
      *   "name": "updated user name",
@@ -62,14 +82,8 @@ let UserController = class UserController extends XoController {
      */
     async updateUser(id, body) {
         const currentUser = this.restApi.getCurrentUser();
-        const isAdmin = currentUser.permission === 'admin';
-        if (isAdmin) {
-            if (body.permission !== undefined && currentUser.id === id) {
-                throw forbiddenOperation('update user', 'cannot change own permission');
-            }
-        }
-        else if (body.name !== undefined || body.password !== undefined || body.permission !== undefined) {
-            throw forbiddenOperation('update user', 'cannot change these fields without admin rights');
+        if (body.permission !== undefined && currentUser.id === id) {
+            throw forbiddenOperation('update user', 'cannot change own permission');
         }
         const user = await this.getObject(id);
         if (user.authProviders !== undefined &&
@@ -80,6 +94,9 @@ let UserController = class UserController extends XoController {
         await this.restApi.xoApp.updateUser(user.id, body);
     }
     /**
+     * Required privilege:
+     * - resource: user, action: create
+     *
      * @example body { "name": "new user", "password": "password", "permission": "none" }
      */
     async createUser(body) {
@@ -87,23 +104,35 @@ let UserController = class UserController extends XoController {
         return { id: user.id };
     }
     /**
+     * Required privilege:
+     * - resource: user, action: delete
+     *
      * @example id "722d17b9-699b-49d2-8193-be1ac573d3de"
      */
     async deleteUser(id) {
         await this.restApi.xoApp.deleteUser(id);
     }
     /**
+     * Returns all groups that match the following privilege:
+     * - resource: group, action: read
+     *
      * @example id "722d17b9-699b-49d2-8193-be1ac573d3de"
      * @example fields "name,id,users"
      * @example filter "users:length:>0"
      * @example limit 42
      */
-    async getUserGroups(req, id, fields, ndjson, filter, limit) {
+    async getUserGroups(req, id, fields, ndjson, markdown, filter, limit) {
         const user = await this.getObject(id);
         const groups = await Promise.all(user.groups.map(group => this.restApi.xoApp.getGroup(group)));
-        return this.sendObjects(limitAndFilterArray(groups, { filter, limit }), req, 'groups');
+        return this.sendObjects(limitAndFilterArray(groups, { filter }), req, {
+            path: 'groups',
+            limit,
+            privilege: { action: 'read', resource: 'group' },
+        });
     }
     /**
+     * You can only see your own authentication tokens
+     *
      * @example id "722d17b9-699b-49d2-8193-be1ac573d3de"
      * @example filter "expiration:>1757371582496"
      * @example limit 42
@@ -118,14 +147,21 @@ let UserController = class UserController extends XoController {
         return limitAndFilterArray(tokens, { filter, limit });
     }
     /**
+     * Returns all tasks that match the following privilege:
+     * - resource: task, action: read
+     *
      * @example id "722d17b9-699b-49d2-8193-be1ac573d3de"
      * @example fields "id,status,properties"
      * @example filter "status:failure"
      * @example limit 42
      */
-    async getUserTasks(req, id, fields, ndjson, filter, limit) {
-        const tasks = await this.getTasksForObject(id, { filter, limit });
-        return this.sendObjects(Object.values(tasks), req, 'tasks');
+    async getUserTasks(req, id, fields, ndjson, markdown, filter, limit) {
+        const tasks = await this.getTasksForObject(id, { filter });
+        return this.sendObjects(Object.values(tasks), req, {
+            path: 'tasks',
+            limit,
+            privilege: { action: 'read', resource: 'task' },
+        });
     }
     // ----------- DEPRECATED TO BE REMOVED IN ONE YEAR  (10-13-2026)--------------------
     /**
@@ -142,6 +178,8 @@ let UserController = class UserController extends XoController {
     }
     // ----------- DEPRECATED TO BE REMOVED IN ONE YEAR  (10-13-2026)--------------------
     /**
+     * You can only create authentication token for yourself
+     *
      * @example id "me"
      * @example body {"client": {"id": "my-fav-client"}, "description": "token for CLI usage", "expiresIn": "1 hour"}
      */
@@ -156,26 +194,62 @@ let UserController = class UserController extends XoController {
         });
         return { token };
     }
+    /**
+     * Returns all ACL privileges that match the following privilege:
+     * - resource: acl-privilege, action: read (if not self)
+     *
+     * @example id "me"
+     * @example fields "id,action,resource"
+     * @example filter "action:create"
+     * @example limit 42
+     */
+    async getUserPrivileges(req, id, fields, ndjson, filter, limit) {
+        const user = await this.getObject(id);
+        const currentUser = this.restApi.getCurrentUser();
+        const userPrivileges = (await this.restApi.xoApp.getAclV2UserPrivileges(user.id));
+        return this.sendObjects(limitAndFilterArray(userPrivileges, { filter }), req, {
+            path: 'acl-privileges',
+            limit,
+            privilege: currentUser.id === user.id ? undefined : { action: 'read', resource: 'acl-privilege' },
+        });
+    }
 };
 __decorate([
     Example(userIds),
     Example(partialUsers),
     Get(''),
+    Security('*', ['acl']),
     __param(0, Request()),
     __param(1, Query()),
     __param(2, Query()),
     __param(3, Query()),
-    __param(4, Query())
+    __param(4, Query()),
+    __param(5, Query())
 ], UserController.prototype, "getUsers", null);
 __decorate([
     Example(user),
     Get('{id}'),
+    Middlewares(acl({
+        resource: 'user',
+        action: actionIfNotSelfUser('read'),
+        objectId: 'params.id',
+        getObject: ({ restApi }) => restApi.xoApp.getUser,
+    })),
+    Response(forbiddenOperationResp.status, forbiddenOperationResp.description),
     Response(notFoundResp.status, notFoundResp.description),
     __param(0, Path())
 ], UserController.prototype, "getUser", null);
 __decorate([
     Patch('{id}'),
-    Middlewares(json()),
+    Middlewares([
+        json(),
+        acl({
+            resource: 'user',
+            actions: actionsFromBody(['update:name', 'update:password', 'update:permission', 'update:preferences']),
+            objectId: 'params.id',
+            getObject: ({ restApi }) => restApi.xoApp.getUser,
+        }),
+    ]),
     SuccessResponse(noContentResp.status, noContentResp.description),
     Response(notFoundResp.status, notFoundResp.description),
     Response(resourceAlreadyExists.status, resourceAlreadyExists.description),
@@ -186,15 +260,23 @@ __decorate([
 __decorate([
     Example(userId),
     Post(''),
-    Middlewares(json()),
+    Middlewares([json(), acl({ resource: 'user', action: 'create', object: ({ req }) => req.body })]),
     SuccessResponse(createdResp.status, createdResp.description),
     Response(unauthorizedResp.status, unauthorizedResp.description),
+    Response(forbiddenOperationResp.status, forbiddenOperationResp.description),
     Response(invalidParameters.status, invalidParameters.description),
     __param(0, Body())
 ], UserController.prototype, "createUser", null);
 __decorate([
     Delete('{id}'),
+    Middlewares(acl({
+        resource: 'user',
+        action: 'delete',
+        objectId: 'params.id',
+        getObject: ({ restApi }) => restApi.xoApp.getUser,
+    })),
     SuccessResponse(noContentResp.status, noContentResp.description),
+    Response(forbiddenOperationResp.status, forbiddenOperationResp.description),
     Response(notFoundResp.status, notFoundResp.description),
     __param(0, Path())
 ], UserController.prototype, "deleteUser", null);
@@ -202,6 +284,7 @@ __decorate([
     Example(groupIds),
     Example(partialGroups),
     Get('{id}/groups'),
+    Security('*', ['acl']),
     Tags('groups'),
     Response(notFoundResp.status, notFoundResp.description),
     __param(0, Request()),
@@ -209,11 +292,13 @@ __decorate([
     __param(2, Query()),
     __param(3, Query()),
     __param(4, Query()),
-    __param(5, Query())
+    __param(5, Query()),
+    __param(6, Query())
 ], UserController.prototype, "getUserGroups", null);
 __decorate([
     Example(authenticationTokens),
     Get('{id}/authentication_tokens'),
+    Security('*', ['acl']),
     Response(notFoundResp.status, notFoundResp.description),
     Response(forbiddenOperationResp.status, forbiddenOperationResp.description),
     __param(0, Request()),
@@ -225,6 +310,7 @@ __decorate([
     Example(taskIds),
     Example(partialTasks),
     Get('{id}/tasks'),
+    Security('*', ['acl']),
     Tags('tasks'),
     Response(notFoundResp.status, notFoundResp.description),
     __param(0, Request()),
@@ -232,7 +318,8 @@ __decorate([
     __param(2, Query()),
     __param(3, Query()),
     __param(4, Query()),
-    __param(5, Query())
+    __param(5, Query()),
+    __param(6, Query())
 ], UserController.prototype, "getUserTasks", null);
 __decorate([
     Example(authenticationToken),
@@ -247,12 +334,27 @@ __decorate([
     Example(authenticationToken),
     Post('{id}/authentication_tokens'),
     Middlewares(json()),
+    Security('*', ['acl']),
     SuccessResponse(createdResp.status, createdResp.description),
     Response(forbiddenOperationResp.status, forbiddenOperationResp.description),
     Response(internalServerErrorResp.status, internalServerErrorResp.description),
     __param(0, Body()),
     __param(1, Path())
 ], UserController.prototype, "postAuthenticationTokens", null);
+__decorate([
+    Example(aclPrivilegeIds),
+    Example(partialAclPrivileges),
+    Get('{id}/acl-privileges'),
+    Security('*', ['acl']),
+    Tags('acls'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Request()),
+    __param(1, Path()),
+    __param(2, Query()),
+    __param(3, Query()),
+    __param(4, Query()),
+    __param(5, Query())
+], UserController.prototype, "getUserPrivileges", null);
 UserController = __decorate([
     Route('users'),
     Security('*'),