@iobroker/js-controller-cli 7.2.3 → 8.0.0-alpha.2-20260923-99da17fcc

package/build/cjs/lib/setup/setupUsers.d.ts

@@ -1,19 +1,29 @@
 import type { ProcessExitCallback } from '../_Types.js';
 import type { Client as ObjectsRedisClient } from '@iobroker/db-objects-redis';
+import type { ProcessCommandOptions } from '../../lib/cli/cliCommand.js';
+/** Options for the users command */
 export interface CLIUsersOptions {
+    /** Callback to exit the process with an exit code */
     processExit: ProcessExitCallback;
+    /** The objects database client */
     objects: ObjectsRedisClient;
 }
+/**
+ * CLI command to manage ioBroker users and groups
+ */
 export declare class Users {
     private readonly objects;
     private readonly processExit;
+    /**
+     * @param options The objects database client and the process-exit callback
+     */
     constructor(options: CLIUsersOptions);
     /**
      * Adds new user to system
      *
      * @param username name of the user which will be added
      * @param pw password
-     * @param callback
+     * @param callback Called once the user has been added
      */
     addUser(username: string, pw: string, callback: ioBroker.ErrorCallback): void;
     /**
@@ -27,7 +37,7 @@ export declare class Users {
      *
      * @param username name of the user to set password for
      * @param pw password
-     * @param callback
+     * @param callback Called once the password has been set
      */
     setPassword(username: string, pw: string, callback: ioBroker.ErrorCallback): void;
     /**
@@ -35,14 +45,14 @@ export declare class Users {
      *
      * @param username name of the user to check password
      * @param pw password
-     * @param callback
+     * @param callback Called with whether the password is correct
      */
     checkPassword(username: string, pw: string, callback: (err?: Error | null, isOk?: boolean) => void): void;
     /**
      * Deletes user from system
      *
      * @param username name of the user to delete
-     * @param callback
+     * @param callback Called once the user has been deleted
      */
     delUser(username: string, callback: ioBroker.ErrorCallback): void;
     /**
@@ -50,7 +60,7 @@ export declare class Users {
      *
      * @param username user which will be added to the group
      * @param groupName name of the group where the user will be added to
-     * @param callback
+     * @param callback Called once the user has been added to the group
      */
     addUserToGroup(username: string, groupName: string, callback: ioBroker.ErrorCallback): void;
     /**
@@ -59,7 +69,7 @@ export declare class Users {
      * @param username user which sohuld be created
      * @param groupName default group for the new user
      * @param password user password
-     * @param callback
+     * @param callback Called once the user has been created
      */
     addUserPrompt(username: string, groupName: string, password: string, callback: ioBroker.ErrorCallback): void;
     /**
@@ -67,7 +77,7 @@ export declare class Users {
      *
      * @param username name of the user to set password for
      * @param password password of user
-     * @param callback
+     * @param callback Called once the password has been set
      */
     setUserPassword(username: string, password: string, callback: ioBroker.ErrorCallback): Promise<void>;
     /**
@@ -75,7 +85,7 @@ export declare class Users {
      *
      * @param username name of the user which will be activated
      * @param enable true if it should be enabled else false
-     * @param callback
+     * @param callback Called once the user has been enabled or disabled
      */
     enableUser(username: string, enable: boolean, callback: ioBroker.ErrorCallback): void;
     /**
@@ -83,21 +93,21 @@ export declare class Users {
      *
      * @param username name of the user to check password for
      * @param password password to check
-     * @param callback
+     * @param callback Called with whether the password is valid
      */
     checkUserPassword(username: string, password: string, callback: ioBroker.ErrorCallback): void;
     /**
      * Get user object
      *
      * @param username name of the user to get object of
-     * @param callback
+     * @param callback Called with the user object
      */
     getUser(username: string, callback: (err?: Error | null, enabled?: boolean) => void): void;
     /**
      * Get group object
      *
      * @param group groupname
-     * @param callback
+     * @param callback Called with the group object
      */
     getGroup(group: string, callback: (err?: Error | null, enabled?: boolean, members?: string[]) => void): void;
     /**
@@ -105,7 +115,7 @@ export declare class Users {
      *
      * @param group groupname
      * @param enable if enable or disable
-     * @param callback
+     * @param callback Called once the group has been enabled or disabled
      */
     enableGroup(group: string, enable: boolean, callback: ioBroker.ErrorCallback): void;
     /**
@@ -118,7 +128,7 @@ export declare class Users {
      * Remove group
      *
      * @param group groupname
-     * @param callback
+     * @param callback Called once the group has been removed
      */
     delGroup(group: string, callback: ioBroker.ErrorCallback): void;
     /**
@@ -126,8 +136,28 @@ export declare class Users {
      *
      * @param username name of the user which will be removed from group
      * @param groupName name of the group user will be removed from
-     * @param callback
+     * @param callback Called once the user has been removed from the group
      */
     removeUserFromGroup(username: string, groupName: string, callback: ioBroker.ErrorCallback): void;
 }
+/**
+ * @param options Command execution options
+ */
+export declare function processCommandUser(options: ProcessCommandOptions): void;
+/**
+ * @param options Command execution options
+ */
+export declare function processCommandGroup(options: ProcessCommandOptions): void;
+/**
+ * @param options Command execution options
+ */
+export declare function processCommandAddUser(options: ProcessCommandOptions): void;
+/**
+ * @param options Command execution options
+ */
+export declare function processCommandPassword(options: ProcessCommandOptions): void;
+/**
+ * @param options Command execution options
+ */
+export declare function processCommandUserDel(options: ProcessCommandOptions): void;
 //# sourceMappingURL=setupUsers.d.ts.map

package/build/cjs/lib/setup/setupUsers.js

@@ -5,6 +5,7 @@ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 var __export = (target, all) => {
   for (var name in all)
     __defProp(target, name, { get: all[name], enumerable: true });
@@ -28,14 +29,26 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var setupUsers_exports = {};
 __export(setupUsers_exports, {
-  Users: () => Users
+  Users: () => Users,
+  processCommandAddUser: () => processCommandAddUser,
+  processCommandGroup: () => processCommandGroup,
+  processCommandPassword: () => processCommandPassword,
+  processCommandUser: () => processCommandUser,
+  processCommandUserDel: () => processCommandUserDel
 });
 module.exports = __toCommonJS(setupUsers_exports);
 var import_js_controller_common = require("@iobroker/js-controller-common");
 var import_prompt = __toESM(require("prompt"), 1);
+var import_dbConnection = require("../../lib/setup/dbConnection.js");
 class Users {
+  static {
+    __name(this, "Users");
+  }
   objects;
   processExit;
+  /**
+   * @param options The objects database client and the process-exit callback
+   */
   constructor(options) {
     if (!options.objects) {
       throw new Error("Invalid arguments: objects is missing");
@@ -51,7 +64,7 @@ class Users {
    *
    * @param username name of the user which will be added
    * @param pw password
-   * @param callback
+   * @param callback Called once the user has been added
    */
   addUser(username, pw, callback) {
     const _user = username.replace(/\s/g, "_").toLowerCase();
@@ -97,7 +110,7 @@ class Users {
    *
    * @param username name of the user to set password for
    * @param pw password
-   * @param callback
+   * @param callback Called once the password has been set
    */
   setPassword(username, pw, callback) {
     const _user = username.replace(/\s/g, "_").toLowerCase();
@@ -123,7 +136,7 @@ class Users {
    *
    * @param username name of the user to check password
    * @param pw password
-   * @param callback
+   * @param callback Called with whether the password is correct
    */
   checkPassword(username, pw, callback) {
     const _user = username.replace(/\s/g, "_").toLowerCase();
@@ -140,7 +153,7 @@ class Users {
    * Deletes user from system
    *
    * @param username name of the user to delete
-   * @param callback
+   * @param callback Called once the user has been deleted
    */
   delUser(username, callback) {
     if (!username) {
@@ -193,7 +206,7 @@ class Users {
    *
    * @param username user which will be added to the group
    * @param groupName name of the group where the user will be added to
-   * @param callback
+   * @param callback Called once the user has been added to the group
    */
   addUserToGroup(username, groupName, callback) {
     let _user = username.replace(/\s/g, "_").toLowerCase();
@@ -232,7 +245,7 @@ class Users {
    * @param username user which sohuld be created
    * @param groupName default group for the new user
    * @param password user password
-   * @param callback
+   * @param callback Called once the user has been created
    */
   addUserPrompt(username, groupName, password2, callback) {
     if (!username) {
@@ -306,7 +319,7 @@ class Users {
    *
    * @param username name of the user to set password for
    * @param password password of user
-   * @param callback
+   * @param callback Called once the password has been set
    */
   async setUserPassword(username, password2, callback) {
     if (!username) {
@@ -365,7 +378,7 @@ class Users {
    *
    * @param username name of the user which will be activated
    * @param enable true if it should be enabled else false
-   * @param callback
+   * @param callback Called once the user has been enabled or disabled
    */
   enableUser(username, enable, callback) {
     if (!username) {
@@ -397,7 +410,7 @@ class Users {
    *
    * @param username name of the user to check password for
    * @param password password to check
-   * @param callback
+   * @param callback Called with whether the password is valid
    */
   checkUserPassword(username, password2, callback) {
     if (!username && !password2) {
@@ -463,7 +476,7 @@ class Users {
    * Get user object
    *
    * @param username name of the user to get object of
-   * @param callback
+   * @param callback Called with the user object
    */
   getUser(username, callback) {
     this.objects.getObject(`system.user.${username}`, (err, obj) => {
@@ -480,7 +493,7 @@ class Users {
    * Get group object
    *
    * @param group groupname
-   * @param callback
+   * @param callback Called with the group object
    */
   getGroup(group, callback) {
     this.objects.getObject(`system.group.${group}`, (err, obj) => {
@@ -498,7 +511,7 @@ class Users {
    *
    * @param group groupname
    * @param enable if enable or disable
-   * @param callback
+   * @param callback Called once the group has been enabled or disabled
    */
   enableGroup(group, enable, callback) {
     if (!group) {
@@ -537,11 +550,47 @@ class Users {
       throw new Error("Group yet exists");
     } else {
       await this.objects.setObject(`system.group.${_group}`, {
+        _id: `system.group.${_group}`,
         type: "group",
         common: {
           name: group,
           enabled: true,
-          members: []
+          members: [],
+          acl: {
+            file: {
+              read: false,
+              list: false,
+              write: false,
+              create: false,
+              delete: false
+            },
+            object: {
+              read: false,
+              list: false,
+              write: false,
+              create: false,
+              delete: false
+            },
+            users: {
+              read: false,
+              list: false,
+              write: false,
+              create: false,
+              delete: false
+            },
+            state: {
+              read: false,
+              list: false,
+              write: false,
+              create: false,
+              delete: false
+            },
+            other: {
+              execute: false,
+              sendto: false,
+              http: false
+            }
+          }
         },
         from: `system.host.${import_js_controller_common.tools.getHostName()}.cli`,
         ts: Date.now(),
@@ -553,7 +602,7 @@ class Users {
    * Remove group
    *
    * @param group groupname
-   * @param callback
+   * @param callback Called once the group has been removed
    */
   delGroup(group, callback) {
     const _group = group.replace(/\s/g, "_");
@@ -574,7 +623,7 @@ class Users {
    *
    * @param username name of the user which will be removed from group
    * @param groupName name of the group user will be removed from
-   * @param callback
+   * @param callback Called once the user has been removed from the group
    */
   removeUserFromGroup(username, groupName, callback) {
     const _group = groupName.replace(/\s/g, "_");
@@ -595,8 +644,272 @@ class Users {
     });
   }
 }
+function processCommandUser(options) {
+  const { args, params, callback } = options;
+  const command = args[0] || "";
+  let user = args[1] || "";
+  if (user?.startsWith("system.user.")) {
+    user = user.substring("system.user.".length);
+  }
+  (0, import_dbConnection.dbConnect)(params, ({ objects }) => {
+    const users = new Users({
+      objects,
+      processExit: callback
+    });
+    const password2 = params.password;
+    const group = params.ingroup || "system.group.administrator";
+    if (command === "add") {
+      users.addUserPrompt(user, group, password2, (err) => {
+        if (err) {
+          console.error(err);
+          return void callback(import_js_controller_common.EXIT_CODES.CANNOT_CREATE_USER_OR_GROUP);
+        }
+        console.log(`User "${user}" created (Group: ${group.replace("system.group.", "")})`);
+        return void callback();
+      });
+    } else if (command === "del" || command === "delete") {
+      users.delUser(user, (err) => {
+        if (err) {
+          console.error(err);
+          return void callback(import_js_controller_common.EXIT_CODES.CANNOT_CREATE_USER_OR_GROUP);
+        }
+        console.log(`User "${user}" deleted`);
+        return void callback();
+      });
+    } else if (command === "check") {
+      users.checkUserPassword(user, password2, (err) => {
+        if (err) {
+          console.error(err.message);
+          return void callback(import_js_controller_common.EXIT_CODES.CANNOT_CREATE_USER_OR_GROUP);
+        }
+        console.log(`Password for user "${user}" matches.`);
+        return void callback();
+      });
+    } else if (command === "set" || command === "passwd") {
+      users.setUserPassword(user, password2, (err) => {
+        if (err) {
+          console.error(err.message);
+          return void callback(import_js_controller_common.EXIT_CODES.CANNOT_CREATE_USER_OR_GROUP);
+        }
+        console.log(`Password for "${user}" was successfully set.`);
+        return void callback();
+      }).catch((e) => console.error(`Cannot set password: ${e.message}`));
+    } else if (command === "enable" || command === "e") {
+      users.enableUser(user, true, (err) => {
+        if (err) {
+          console.error(err.message);
+          return void callback(import_js_controller_common.EXIT_CODES.CANNOT_CREATE_USER_OR_GROUP);
+        }
+        console.log(`User "${user}" was successfully enabled.`);
+        return void callback();
+      });
+    } else if (command === "disable" || command === "d") {
+      users.enableUser(user, false, (err) => {
+        if (err) {
+          console.error(err.message);
+          return void callback(import_js_controller_common.EXIT_CODES.CANNOT_CREATE_USER_OR_GROUP);
+        }
+        console.log(`User "${user}" was successfully disabled.`);
+        return void callback();
+      });
+    } else if (command === "get") {
+      users.getUser(user, (err, isEnabled) => {
+        if (err) {
+          console.error(err.message);
+          return void callback(import_js_controller_common.EXIT_CODES.CANNOT_CREATE_USER_OR_GROUP);
+        }
+        console.log(`User "${user}" is ${isEnabled ? "enabled" : "disabled"}`);
+        return void callback();
+      });
+    } else {
+      console.warn(`Unknown command "${command}". Available commands are: add, del, passwd, enable, disable, check, get`);
+      return void callback(import_js_controller_common.EXIT_CODES.INVALID_ARGUMENTS);
+    }
+  });
+}
+__name(processCommandUser, "processCommandUser");
+function processCommandGroup(options) {
+  const { args, params, callback } = options;
+  const command = args[0] || "";
+  let group = args[1] || "";
+  let user = args[2] || "";
+  if (group?.startsWith("system.group.")) {
+    group = group.substring("system.group.".length);
+  }
+  if (user?.startsWith("system.user.")) {
+    user = user.substring("system.user.".length);
+  }
+  if (!command) {
+    console.warn(`Unknown command "${command}". Available commands are: add, del, passwd, enable, disable, list, get`);
+    return void callback(import_js_controller_common.EXIT_CODES.INVALID_ARGUMENTS);
+  }
+  if (!group) {
+    console.warn(`Please define group name: group ${command} groupName`);
+    return callback(import_js_controller_common.EXIT_CODES.CANNOT_CREATE_USER_OR_GROUP);
+  }
+  (0, import_dbConnection.dbConnect)(params, async ({ objects }) => {
+    const users = new Users({
+      objects,
+      processExit: callback
+    });
+    if (command === "useradd" || command === "adduser") {
+      if (!user) {
+        console.warn('Please define user name: "group useradd groupName userName"');
+        return void callback(import_js_controller_common.EXIT_CODES.CANNOT_CREATE_USER_OR_GROUP);
+      }
+      users.addUserToGroup(user, group, (err) => {
+        if (err) {
+          console.error(err);
+          return void callback(import_js_controller_common.EXIT_CODES.CANNOT_CREATE_USER_OR_GROUP);
+        }
+        console.log(`User "${user}" was added to group "${group}"`);
+        return void callback();
+      });
+    } else if (command === "userdel" || command === "deluser") {
+      if (!user) {
+        console.warn('Please define user name: "group userdel groupName userName"');
+        return void callback(import_js_controller_common.EXIT_CODES.CANNOT_CREATE_USER_OR_GROUP);
+      }
+      users.removeUserFromGroup(user, group, (err) => {
+        if (err) {
+          console.error(err);
+          return void callback(import_js_controller_common.EXIT_CODES.CANNOT_CREATE_USER_OR_GROUP);
+        }
+        console.log(`User "${user}" was deleted from group "${group}"`);
+        return void callback();
+      });
+    } else if (command === "add") {
+      try {
+        await users.addGroup(group);
+        console.log(`Group "${group}" was created`);
+        return void callback();
+      } catch {
+        return void callback(import_js_controller_common.EXIT_CODES.CANNOT_CREATE_USER_OR_GROUP);
+      }
+    } else if (command === "del" || command === "delete") {
+      users.delGroup(group, (err) => {
+        if (err) {
+          console.error(err);
+          return void callback(import_js_controller_common.EXIT_CODES.CANNOT_CREATE_USER_OR_GROUP);
+        }
+        console.log(`Group "${group}" was deleted`);
+        return void callback();
+      });
+    } else if (command === "list" || command === "l") {
+      users.getGroup(group, (err, isEnabled, members) => {
+        if (err) {
+          console.error(err);
+          return void callback(import_js_controller_common.EXIT_CODES.CANNOT_CREATE_USER_OR_GROUP);
+        }
+        console.log(`Group "${group}" is ${isEnabled ? "enabled" : "disabled"} and has following members:`);
+        if (members) {
+          for (const member of members) {
+            console.log(member.substring("system.user.".length));
+          }
+        }
+        return void callback();
+      });
+    } else if (command === "enable" || command === "e") {
+      users.enableGroup(group, true, (err) => {
+        if (err) {
+          console.error(err);
+          return void callback(import_js_controller_common.EXIT_CODES.CANNOT_CREATE_USER_OR_GROUP);
+        }
+        console.log(`Group "${group}" was successfully enabled.`);
+        return void callback();
+      });
+    } else if (command === "disable" || command === "d") {
+      users.enableGroup(group, false, (err) => {
+        if (err) {
+          console.error(err);
+          return void callback(import_js_controller_common.EXIT_CODES.CANNOT_CREATE_USER_OR_GROUP);
+        }
+        console.log(`Group "${group}" was successfully disabled.`);
+        return void callback();
+      });
+    } else if (command === "get") {
+      users.getGroup(group, (err, isEnabled) => {
+        if (err) {
+          console.error(err);
+          return void callback(import_js_controller_common.EXIT_CODES.CANNOT_CREATE_USER_OR_GROUP);
+        }
+        console.log(`Group "${group}" is ${isEnabled ? "enabled" : "disabled"}`);
+        return void callback();
+      });
+    } else {
+      console.warn(`Unknown command "${command}". Available commands are: add, del, passwd, enable, disable, list, get`);
+      return void callback(import_js_controller_common.EXIT_CODES.INVALID_ARGUMENTS);
+    }
+  });
+}
+__name(processCommandGroup, "processCommandGroup");
+function processCommandAddUser(options) {
+  const { args, params, callback } = options;
+  const user = args[0];
+  const group = params.ingroup || "system.group.administrator";
+  const password2 = params.password;
+  (0, import_dbConnection.dbConnect)(params, ({ objects }) => {
+    const users = new Users({
+      objects,
+      processExit: callback
+    });
+    users.addUserPrompt(user, group, password2, (err) => {
+      if (err) {
+        console.error(err);
+        return void callback(import_js_controller_common.EXIT_CODES.CANNOT_CREATE_USER_OR_GROUP);
+      }
+      console.log(`User "${user}" created (Group: ${group.replace("system.group.", "")})`);
+      return void callback();
+    });
+  });
+}
+__name(processCommandAddUser, "processCommandAddUser");
+function processCommandPassword(options) {
+  const { args, params, callback } = options;
+  const user = args[0];
+  const password2 = params.password;
+  (0, import_dbConnection.dbConnect)(params, ({ objects }) => {
+    const users = new Users({
+      objects,
+      processExit: callback
+    });
+    users.setUserPassword(user, password2, (err) => {
+      if (err) {
+        console.error(err);
+        return void callback(import_js_controller_common.EXIT_CODES.CANNOT_CREATE_USER_OR_GROUP);
+      }
+      console.log(`Password for "${user}" was successfully set.`);
+      return void callback();
+    }).catch((e) => console.error(`Cannot set password: ${e.message}`));
+  });
+}
+__name(processCommandPassword, "processCommandPassword");
+function processCommandUserDel(options) {
+  const { args, params, callback } = options;
+  const user = args[0];
+  (0, import_dbConnection.dbConnect)(params, ({ objects }) => {
+    const users = new Users({
+      objects,
+      processExit: callback
+    });
+    users.delUser(user, (err) => {
+      if (err) {
+        console.error(err);
+        return void callback(import_js_controller_common.EXIT_CODES.CANNOT_CREATE_USER_OR_GROUP);
+      }
+      console.log(`User "${user}" deleted`);
+      return void callback();
+    });
+  });
+}
+__name(processCommandUserDel, "processCommandUserDel");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  Users
+  Users,
+  processCommandAddUser,
+  processCommandGroup,
+  processCommandPassword,
+  processCommandUser,
+  processCommandUserDel
 });
 //# sourceMappingURL=setupUsers.js.map