@xen-orchestra/rest-api 0.30.1 → 0.31.0

package/dist/helpers/stream.helper.mjs

@@ -1,5 +1,20 @@
-export function* makeNdJsonStream(array) {
-    for (const object of array) {
+export async function* makeNdJsonStream(iterable) {
+    for await (const object of iterable) {
         yield JSON.stringify(object) + '\n';
     }
 }
+export async function* makeJsonStream(iterable) {
+    yield '[';
+    let first = true;
+    for await (const object of iterable) {
+        if (first) {
+            first = false;
+            yield '\n';
+        }
+        else {
+            yield ',\n';
+        }
+        yield JSON.stringify(object, null, 2);
+    }
+    yield '\n]\n';
+}

package/dist/hosts/host.controller.mjs

@@ -211,6 +211,9 @@ let HostController = class HostController extends XapiXoController {
         await host.$call('remove_tags', tag);
     }
     /**
+     * Required privilege:
+     * - resource: pif, action: update:management
+     *
      * Reconfigure the management interface of the host to use the given PIF.
      *
      * The target PIF must already have an IP address configured.
@@ -240,6 +243,10 @@ let HostController = class HostController extends XapiXoController {
         });
     }
     /**
+     * Required privileges:
+     * - resource: host, action: disable
+     * - resource: host, action: evacuate (if `evacuate: true`)
+     *
      * Disable a host.
      *
      * Set `evacuate` to `true` to also evacuate all running VMs to other hosts in the pool.
@@ -285,6 +292,9 @@ let HostController = class HostController extends XapiXoController {
         });
     }
     /**
+     * Required privilege:
+     * - resource: host, action: enable
+     *
      * Enable a host, taking it out of disabled state.
      *
      * @example id "b61a5c92-700e-4966-a13b-00633f03eea8"
@@ -438,9 +448,10 @@ __decorate([
 __decorate([
     Example(taskLocation),
     Post('{id}/actions/management_reconfigure'),
-    Middlewares(json()),
+    Middlewares([json(), acl({ resource: 'pif', action: 'update:management', objectId: 'body.pif' })]),
     SuccessResponse(asynchronousActionResp.status, asynchronousActionResp.description),
     Response(noContentResp.status, noContentResp.description),
+    Response(forbiddenOperationResp.status, forbiddenOperationResp.description),
     Response(notFoundResp.status, notFoundResp.description),
     Response(badRequestResp.status, badRequestResp.description),
     Response(invalidParametersResp.status, invalidParametersResp.description),
@@ -452,9 +463,23 @@ __decorate([
 __decorate([
     Example(taskLocation),
     Post('{id}/actions/disable'),
-    Middlewares(json()),
+    Middlewares([
+        json(),
+        acl({
+            resource: 'host',
+            actions: ({ req }) => {
+                const actions = ['disable'];
+                if (req.body?.evacuate) {
+                    actions.push('evacuate');
+                }
+                return actions;
+            },
+            objectId: 'params.id',
+        }),
+    ]),
     SuccessResponse(asynchronousActionResp.status, asynchronousActionResp.description),
     Response(noContentResp.status, noContentResp.description),
+    Response(forbiddenOperationResp.status, forbiddenOperationResp.description),
     Response(notFoundResp.status, notFoundResp.description),
     Response(invalidParametersResp.status, invalidParametersResp.description),
     Response(internalServerErrorResp.status, internalServerErrorResp.description),
@@ -465,8 +490,10 @@ __decorate([
 __decorate([
     Example(taskLocation),
     Post('{id}/actions/enable'),
+    Middlewares(acl({ resource: 'host', action: 'enable', objectId: 'params.id' })),
     SuccessResponse(asynchronousActionResp.status, asynchronousActionResp.description),
     Response(noContentResp.status, noContentResp.description),
+    Response(forbiddenOperationResp.status, forbiddenOperationResp.description),
     Response(notFoundResp.status, notFoundResp.description),
     Response(internalServerErrorResp.status, internalServerErrorResp.description),
     __param(0, Path()),

package/dist/index.mjs

@@ -6,6 +6,8 @@ import { RegisterRoutes } from './open-api/routes/routes.js';
 import { setupContainer } from './ioc/ioc.mjs';
 import { setupApiContext } from './middlewares/authentication.middleware.mjs';
 import { logMiddleware } from './middlewares/log.middleware.mjs';
+import { createExternalRouter, sendObjects } from './router/external-router.mjs';
+export { sendObjects };
 // Avoid using "import from" to import a json file as this requires assert/with and will break compatibility with recent node versions
 // https://github.com/nodejs/node/issues/51622
 const require = createRequire(import.meta.url);
@@ -34,9 +36,12 @@ const SWAGGER_UI_OPTIONS = {
 };
 export default function setupRestApi(express, xoApp) {
     setupContainer(xoApp);
+    // Create dynamic router so it can be used by plugin to register rest routes
+    const { mountExternalRoute, externalRouter } = createExternalRouter(swaggerOpenApiSpec);
     express.use(BASE_URL, setupApiContext(xoApp));
     express.use(BASE_URL, logMiddleware);
     RegisterRoutes(express);
+    express.use(BASE_URL, externalRouter);
     express.get(`${BASE_URL}/docs/swagger.json`, (_req, res) => {
         res.setHeader('Content-Type', 'application/json');
         res.json(swaggerOpenApiSpec);
@@ -46,4 +51,5 @@ export default function setupRestApi(express, xoApp) {
     express.use(`${BASE_URL}/docs`, swaggerUi.serveFiles(undefined, SWAGGER_UI_OPTIONS), swaggerUi.setup(null, SWAGGER_UI_OPTIONS));
     express.use(BASE_URL, tsoaToXoErrorHandler);
     express.use(BASE_URL, genericErrorHandler);
+    return { mountExternalRoute };
 }

package/dist/ioc/ioc.mjs

@@ -14,6 +14,8 @@ import { BackupLogService } from '../backup-logs/backup-log.service.mjs';
 import { EventService } from '../events/event.service.mjs';
 import { NetworkService } from '../networks/network.service.mjs';
 import { BackupArchiveService } from '../backup-archives/backup-archive.service.mjs';
+import { SrService } from '../srs/sr.service.mjs';
+import { LicenseService } from '../licenses/license.service.mjs';
 const iocContainer = new Container();
 export function setupContainer(xoApp) {
     decorate(injectable(), Controller);
@@ -109,5 +111,19 @@ export function setupContainer(xoApp) {
         return new BackupArchiveService(restApi);
     })
         .inSingletonScope();
+    iocContainer
+        .bind(SrService)
+        .toDynamicValue(ctx => {
+        const restApi = ctx.container.get(RestApi);
+        return new SrService(restApi);
+    })
+        .inSingletonScope();
+    iocContainer
+        .bind(LicenseService)
+        .toDynamicValue(ctx => {
+        const restApi = ctx.container.get(RestApi);
+        return new LicenseService(restApi);
+    })
+        .inSingletonScope();
 }
 export { iocContainer };

package/dist/licenses/license.service.mjs

@@ -0,0 +1,23 @@
+import { createLogger } from '@xen-orchestra/log';
+const log = createLogger('xo:rest-api:license-service');
+export class LicenseService {
+    #restApi;
+    constructor(restApi) {
+        this.#restApi = restApi;
+    }
+    async getXostorLicenses(srId) {
+        const xapiSr = this.#restApi.getXapiObject(srId, 'SR');
+        const xapi = xapiSr.$xapi;
+        const licenses = await this.#restApi.xoApp.getLicenses({ productType: 'xostor' });
+        const result = [];
+        for (const host of Object.values(xapi.objects.indexes.type.host)) {
+            const license = licenses.find(l => l.boundObjectId === host.uuid);
+            if (license === undefined) {
+                log.warn('no xostor license found for host', { hostId: host.uuid });
+                continue;
+            }
+            result.push({ licenseId: license.id, boundObjectId: host.uuid });
+        }
+        return result;
+    }
+}