@axium/sysadmin 0.0.1

package/LICENSE.md

@@ -0,0 +1,157 @@
+# GNU LESSER GENERAL PUBLIC LICENSE
+
+Version 3, 29 June 2007
+
+Copyright (C) 2007 Free Software Foundation, Inc.
+<https://fsf.org/>
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+This version of the GNU Lesser General Public License incorporates the
+terms and conditions of version 3 of the GNU General Public License,
+supplemented by the additional permissions listed below.
+
+## 0. Additional Definitions.
+
+As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the
+GNU General Public License.
+
+"The Library" refers to a covered work governed by this License, other
+than an Application or a Combined Work as defined below.
+
+An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+A "Combined Work" is a work produced by combining or linking an
+Application with the Library. The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+## 1. Exception to Section 3 of the GNU GPL.
+
+You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+## 2. Conveying Modified Versions.
+
+If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+-   a) under this License, provided that you make a good faith effort
+    to ensure that, in the event an Application does not supply the
+    function or data, the facility still operates, and performs
+    whatever part of its purpose remains meaningful, or
+-   b) under the GNU GPL, with none of the additional permissions of
+    this License applicable to that copy.
+
+## 3. Object Code Incorporating Material from Library Header Files.
+
+The object code form of an Application may incorporate material from a
+header file that is part of the Library. You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+-   a) Give prominent notice with each copy of the object code that
+    the Library is used in it and that the Library and its use are
+    covered by this License.
+-   b) Accompany the object code with a copy of the GNU GPL and this
+    license document.
+
+## 4. Combined Works.
+
+You may convey a Combined Work under terms of your choice that, taken
+together, effectively do not restrict modification of the portions of
+the Library contained in the Combined Work and reverse engineering for
+debugging such modifications, if you also do each of the following:
+
+-   a) Give prominent notice with each copy of the Combined Work that
+    the Library is used in it and that the Library and its use are
+    covered by this License.
+-   b) Accompany the Combined Work with a copy of the GNU GPL and this
+    license document.
+-   c) For a Combined Work that displays copyright notices during
+    execution, include the copyright notice for the Library among
+    these notices, as well as a reference directing the user to the
+    copies of the GNU GPL and this license document.
+-   d) Do one of the following:
+    -   0) Convey the Minimal Corresponding Source under the terms of
+        this License, and the Corresponding Application Code in a form
+        suitable for, and under terms that permit, the user to
+        recombine or relink the Application with a modified version of
+        the Linked Version to produce a modified Combined Work, in the
+        manner specified by section 6 of the GNU GPL for conveying
+        Corresponding Source.
+    -   1) Use a suitable shared library mechanism for linking with
+        the Library. A suitable mechanism is one that (a) uses at run
+        time a copy of the Library already present on the user's
+        computer system, and (b) will operate properly with a modified
+        version of the Library that is interface-compatible with the
+        Linked Version.
+-   e) Provide Installation Information, but only if you would
+    otherwise be required to provide such information under section 6
+    of the GNU GPL, and only to the extent that such information is
+    necessary to install and execute a modified version of the
+    Combined Work produced by recombining or relinking the Application
+    with a modified version of the Linked Version. (If you use option
+    4d0, the Installation Information must accompany the Minimal
+    Corresponding Source and Corresponding Application Code. If you
+    use option 4d1, you must provide the Installation Information in
+    the manner specified by section 6 of the GNU GPL for conveying
+    Corresponding Source.)
+
+## 5. Combined Libraries.
+
+You may place library facilities that are a work based on the Library
+side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+-   a) Accompany the combined library with a copy of the same work
+    based on the Library, uncombined with any other library
+    facilities, conveyed under the terms of this License.
+-   b) Give prominent notice with the combined library that part of it
+    is a work based on the Library, and explaining where to find the
+    accompanying uncombined form of the same work.
+
+## 6. Revised Versions of the GNU Lesser General Public License.
+
+The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Library
+as you received it specifies that a certain numbered version of the
+GNU Lesser General Public License "or any later version" applies to
+it, you have the option of following the terms and conditions either
+of that published version or of any later version published by the
+Free Software Foundation. If the Library as you received it does not
+specify a version number of the GNU Lesser General Public License, you
+may choose any version of the GNU Lesser General Public License ever
+published by the Free Software Foundation.
+
+If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/README.md

@@ -0,0 +1,3 @@
+# Axium Sysadmin
+
+This is a plugin for administrating your computers using Axium.

package/db.json

@@ -0,0 +1,77 @@
+{
+	"$schema": "../server/schemas/db.json",
+	"format": 1,
+	"versions": [
+		{
+			"delta": false,
+			"tables": {
+				"systems": {
+					"columns": {
+						"id": { "type": "uuid", "required": true, "primary": true, "default": "gen_random_uuid()" },
+						"userId": { "type": "uuid", "required": true, "references": "users.id", "onDelete": "cascade" },
+						"name": { "type": "text", "required": true },
+						"hostname": { "type": "text", "required": true }
+					}
+				},
+				"system_users": {
+					"columns": {
+						"id": { "type": "uuid", "required": true, "primary": true, "default": "gen_random_uuid()" },
+						"userId": { "type": "uuid", "required": true, "references": "users.id", "onDelete": "cascade" },
+						"name": { "type": "text", "required": true },
+						"username": { "type": "text", "required": true }
+					}
+				},
+				"acl.systems": {
+					"columns": {
+						"userId": { "type": "uuid", "references": "users.id", "onDelete": "cascade" },
+						"itemId": { "type": "uuid", "required": true, "references": "systems.id", "onDelete": "cascade" },
+						"createdAt": { "type": "timestamptz", "required": true, "default": "now()" },
+						"role": { "type": "text" },
+						"tag": { "type": "text" },
+						"read": { "type": "boolean", "required": true, "default": false },
+						"edit": { "type": "boolean", "required": true, "default": false },
+						"manage": { "type": "boolean", "required": true, "default": false }
+					},
+					"constraints": {
+						"unique_systems": { "type": "unique", "on": ["itemId", "userId", "role", "tag"], "nulls_not_distinct": true }
+					}
+				}
+			},
+			"indexes": {
+				"systems_userId": { "on": "systems", "columns": ["userId"] },
+				"system_users_userId": { "on": "system_users", "columns": ["userId"] },
+				"acl_systems_userId": { "on": "acl.systems", "columns": ["userId"] },
+				"acl_systems_itemId": { "on": "acl.systems", "columns": ["itemId"] }
+			}
+		},
+		{
+			"delta": true,
+			"alter_tables": {
+				"systems": {
+					"add_columns": {
+						"type": { "type": "text", "required": true, "default": "'server'" }
+					}
+				}
+			}
+		},
+		{
+			"delta": true,
+			"alter_tables": {
+				"systems": {
+					"add_constraints": {
+						"unique_systems_hostname": { "type": "unique", "on": ["userId", "hostname"] }
+					}
+				},
+				"system_users": {
+					"add_constraints": {
+						"unique_system_users_username": { "type": "unique", "on": ["userId", "username"] }
+					}
+				}
+			}
+		}
+	],
+	"wipe": ["systems", "system_users", "acl.systems"],
+	"acl_tables": {
+		"systems": "acl.systems"
+	}
+}

package/dist/_probe.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/_probe.js

@@ -0,0 +1,4 @@
+import { SystemType } from './common.js';
+const v = SystemType.def.values;
+const _check = v;
+console.log(v);

package/dist/client/.info.js

@@ -0,0 +1,38 @@
+import { systemInfo } from './info.js';
+import { formatBytes } from '@axium/core';
+import { styleText } from 'node:util';
+
+const t = '   ',
+	t2 = '       ';
+
+const { cpus, gpus, memory, storage, networkInterfaces, uptime, ...rest } = systemInfo();
+
+function usage(info) {
+	return styleText('blueBright', formatBytes(info.used)) + '/' + styleText('blueBright', formatBytes(info.total));
+}
+
+const num = value => styleText('blueBright', value.toString());
+
+console.log('CPUs:');
+for (const cpu of cpus) console.log(t, num(cpu.cores) + 'x', styleText('yellow', cpu.model));
+
+console.log('GPUs:');
+for (const gpu of gpus) {
+	console.log(t, styleText('yellow', gpu.model));
+	if (gpu.vram) console.log(t2, 'VRAM:', usage(gpu.vram));
+}
+
+console.log('Memory:', usage(memory));
+if (memory.swap) console.log(t, 'Swap:', usage(memory.swap));
+
+console.log('Storage:');
+for (const drive of storage) console.log(t, styleText('yellow', drive.model), usage(drive));
+
+console.log('Network:');
+for (const iface of networkInterfaces) {
+	console.log(t, styleText('cyanBright', iface.name), styleText('yellow', iface.model), iface.wireless ? '(wireless)' : '(wired)');
+	if (iface.connected)
+		console.log(t2, iface.connection ? 'Connected to ' + iface.connection : 'Connected', 'at', num(iface.speed), 'MBit/s');
+}
+
+console.log(rest);

package/dist/client/cli.d.ts

@@ -0,0 +1 @@
+import './socket.js';

package/dist/client/cli.js

@@ -0,0 +1,109 @@
+import { session } from '@axium/client/cli/config';
+import { fetchAPI } from '@axium/client/requests';
+import { connect } from '@axium/client/socket';
+import { formatBytes, formatDuration } from '@axium/core';
+import { program } from 'commander';
+import * as io from 'ioium/node';
+import { styleText } from 'node:util';
+import './socket.js';
+function usage(info) {
+    return styleText('blueBright', formatBytes(info.used)) + '/' + styleText('blueBright', formatBytes(info.total));
+}
+const num = (value) => value === undefined ? styleText('red', '<unknown>') : styleText('blueBright', value.toString());
+const tab = '   ', tab2 = '       ';
+function dumpInfo(system, info) {
+    console.log(styleText('bold', `${system.hostname} "${system.name}"`), styleText('dim', `(${system.id})`));
+    const { cpus, gpus, memory, storage, networkInterfaces, uptime, ...rest } = info;
+    console.log('CPUs:');
+    for (const cpu of cpus)
+        console.log(tab, num(cpu.cores) + 'x', styleText('yellow', cpu.model));
+    console.log('GPUs:');
+    for (const gpu of gpus) {
+        console.log(tab, styleText('yellow', gpu.model));
+        if (gpu.vram)
+            console.log(tab2, 'VRAM:', usage(gpu.vram));
+    }
+    console.log('Memory:', usage(memory));
+    if (memory.swap)
+        console.log(tab, 'Swap:', usage(memory.swap));
+    console.log('Storage:');
+    for (const drive of storage)
+        console.log(tab, styleText('yellow', drive.model), usage(drive));
+    console.log('Network:');
+    for (const iface of networkInterfaces) {
+        console.log(tab, styleText('cyanBright', iface.name), styleText('yellow', iface.model), iface.wireless ? '(wireless)' : '(wired)');
+        if (iface.connected)
+            console.log(tab2, iface.connection ? 'Connected to ' + iface.connection : 'Connected', 'at', num(iface.speed), 'MBit/s');
+    }
+    console.log('Uptime:', formatDuration(uptime));
+    for (const [key, value] of Object.entries(rest)) {
+        console.log(key + ':', value);
+    }
+}
+async function getSystems() {
+    return await fetchAPI('GET', 'users/:id/sysadmin/systems', {}, session().userId);
+}
+async function getUsers() {
+    return await fetchAPI('GET', 'users/:id/sysadmin/users', {}, session().userId);
+}
+/** Resolve a system by its ID or hostname. */
+function resolveSystem(systems, search) {
+    const system = systems.find(s => s.id === search || s.hostname === search);
+    if (!system)
+        io.exit(`No system matching "${search}".`);
+    return system;
+}
+/** Resolve a system user by its ID or username. */
+function resolveUser(users, search) {
+    const user = users.find(u => u.id === search || u.username === search);
+    if (!user)
+        io.exit(`No system user matching "${search}".`);
+    return user;
+}
+function listSystems(systems) {
+    for (const system of systems) {
+        console.log(styleText('bold', system.hostname), styleText('yellow', system.type), `"${system.name}"`, styleText('dim', `(${system.id})`));
+    }
+}
+function listUsers(users) {
+    for (const user of users) {
+        console.log(styleText('bold', user.username), `"${user.name}"`, styleText('dim', `(${user.id})`));
+    }
+}
+const cli = program.command('sysadmin').helpGroup('Plugins:').description('CLI integration for @axium/sysadmin');
+cli.action(async () => {
+    const [systems, users] = await Promise.all([getSystems(), getUsers()]);
+    console.log(styleText('whiteBright', `${systems.length} system(s):`));
+    listSystems(systems);
+    console.log(styleText('whiteBright', `\n${users.length} user(s):`));
+    listUsers(users);
+});
+cli.command('systems')
+    .description('List systems')
+    .action(async () => listSystems(await getSystems()));
+cli.command('users')
+    .description('List system users')
+    .action(async () => listUsers(await getUsers()));
+cli.command('system')
+    .description('Show information about a system')
+    .argument('<system>', 'the hostname or ID of the system')
+    .option('--insecure', 'allow connecting to a server with an untrusted (e.g. self-signed) TLS certificate', false)
+    .action(async (search, opt) => {
+    const system = resolveSystem(await getSystems(), search);
+    const socket = await connect({ rejectUnauthorized: !opt.insecure });
+    const all = await socket.emitWithAck('sysadmin:getSystemInfo').catch(() => undefined);
+    const info = all?.find(i => i.hostname === system.hostname);
+    if (!info) {
+        console.log(styleText('bold', `${system.hostname} "${system.name}"`), styleText('dim', `(${system.id})`));
+        io.exit('System is offline; live information is unavailable.', 1);
+    }
+    dumpInfo(system, info);
+    process.exit();
+});
+cli.command('user')
+    .description('Show information about a system user')
+    .argument('<user>', 'the username or ID of the system user')
+    .action(async (search) => {
+    const user = resolveUser(await getUsers(), search);
+    console.log(styleText('bold', `${user.username} "${user.name}"`), styleText('dim', `(${user.id})`));
+});

package/dist/client/hooks.d.ts

@@ -0,0 +1 @@
+import './socket.js';

package/dist/client/hooks.js

@@ -0,0 +1 @@
+import './socket.js'; // Registers socket listeners

package/dist/client/info.d.ts

@@ -0,0 +1,2 @@
+import type { SystemInfo } from '../info.js';
+export declare function systemInfo(): SystemInfo;

package/dist/client/info.js

@@ -0,0 +1,171 @@
+import * as fs from 'node:fs';
+import * as os from 'node:os';
+/** Read a sysfs/procfs file, returning the trimmed contents or undefined if unreadable. */
+function read(path) {
+    try {
+        return fs.readFileSync(path, 'utf8').trim();
+    }
+    catch {
+        return undefined;
+    }
+}
+function list(path) {
+    try {
+        return fs.readdirSync(path);
+    }
+    catch {
+        return [];
+    }
+}
+let pciDb;
+/** Map `vendor:device` PCI IDs (lowercase hex) to a human-readable name using the system pci.ids database. */
+function pciName(id) {
+    const [vendor, device] = id.toLowerCase().split(':');
+    if (!pciDb)
+        pciDb = read('/usr/share/hwdata/pci.ids') ?? read('/usr/share/misc/pci.ids');
+    if (!pciDb || !vendor || !device)
+        return id;
+    let inVendor = false;
+    for (const line of pciDb.split('\n')) {
+        if (line.startsWith('#') || !line.trim())
+            continue;
+        if (!line.startsWith('\t')) {
+            // Vendor line: `1002  Advanced Micro Devices, Inc. [AMD/ATI]`
+            inVendor = line.slice(0, 4).toLowerCase() === vendor;
+            continue;
+        }
+        if (!inVendor || line.startsWith('\t\t'))
+            continue;
+        // Device line: `\t7550  Device name`
+        const entry = line.slice(1);
+        if (entry.slice(0, 4).toLowerCase() === device)
+            return entry.slice(4).trim();
+    }
+    return id;
+}
+function gpus() {
+    const seen = new Set();
+    const result = [];
+    for (const card of list('/sys/class/drm')) {
+        // Only whole cards (`card0`), not connectors (`card0-DP-1`) or render nodes.
+        if (!/^card\d+$/.test(card))
+            continue;
+        const uevent = read(`/sys/class/drm/${card}/device/uevent`);
+        const id = uevent && /^PCI_ID=(.+)$/m.exec(uevent)?.[1];
+        if (!id || seen.has(id))
+            continue;
+        seen.add(id);
+        // VRAM totals are exposed by some drivers (e.g. amdgpu) in bytes.
+        const vramTotal = read(`/sys/class/drm/${card}/device/mem_info_vram_total`);
+        const vramUsed = read(`/sys/class/drm/${card}/device/mem_info_vram_used`);
+        const vram = vramTotal && vramUsed ? { total: BigInt(vramTotal), used: BigInt(vramUsed) } : undefined;
+        result.push({ model: pciName(id), vram });
+    }
+    return result;
+}
+/** Map mounted block devices to the filesystem usage (bytes) of their mount point. */
+function mountUsage() {
+    const usage = new Map();
+    const mounts = read('/proc/mounts');
+    if (!mounts)
+        return usage;
+    for (const line of mounts.split('\n')) {
+        const [source, mountPoint] = line.split(' ');
+        if (!source?.startsWith('/dev/'))
+            continue;
+        let stat;
+        try {
+            stat = fs.statfsSync(mountPoint, { bigint: true });
+        }
+        catch {
+            continue;
+        }
+        const total = stat.blocks * stat.bsize;
+        const used = (stat.blocks - stat.bfree) * stat.bsize;
+        usage.set(source.slice('/dev/'.length), { total, used });
+    }
+    return usage;
+}
+function storage() {
+    const usage = mountUsage();
+    const result = [];
+    for (const dev of list('/sys/block')) {
+        // Skip virtual devices (zram, loop, device-mapper) which have no backing `device`.
+        if (!fs.existsSync(`/sys/block/${dev}/device`))
+            continue;
+        const sectors = read(`/sys/block/${dev}/size`);
+        if (!sectors)
+            continue;
+        // `size` is always in 512-byte sectors regardless of logical block size.
+        const total = BigInt(sectors) * 512n;
+        // Sum filesystem usage across mounted partitions of this disk.
+        let used = 0n;
+        for (const [mounted, info] of usage) {
+            if (mounted === dev || mounted.startsWith(dev + 'p') || (mounted.startsWith(dev) && /\d$/.test(mounted))) {
+                used += info.used;
+            }
+        }
+        const model = read(`/sys/block/${dev}/device/model`)?.trim() || dev;
+        result.push({ model, total, used });
+    }
+    return result;
+}
+function memory() {
+    const info = {};
+    const content = read('/proc/meminfo');
+    if (content)
+        for (const line of content.split('\n')) {
+            const match = /^(\w+):\s+(\d+)(?:\s+kB)?$/.exec(line.trim());
+            if (!match)
+                continue;
+            const [, key, value] = match;
+            info[key] = BigInt(value) * (line.endsWith('kB') ? 1024n : 1n);
+        }
+    const total = info.MemTotal ?? BigInt(os.totalmem());
+    const available = info.MemAvailable ?? BigInt(os.freemem());
+    const memory = {
+        speed: 0,
+        total,
+        used: total - available,
+    };
+    const swapTotal = info.SwapTotal ?? 0n;
+    if (swapTotal > 0n)
+        memory.swap = { total: swapTotal, used: swapTotal - (info.SwapFree ?? 0n) };
+    return memory;
+}
+function networkInterfaces() {
+    const result = [];
+    for (const name of list('/sys/class/net')) {
+        if (name === 'lo')
+            continue;
+        const operstate = read(`/sys/class/net/${name}/operstate`);
+        const connected = operstate === 'up' || read(`/sys/class/net/${name}/carrier`) === '1';
+        // `speed` is in Mbit/s; only valid for connected links and may be -1/unreadable.
+        const raw = read(`/sys/class/net/${name}/speed`);
+        const speed = connected && raw && Number(raw) > 0 ? BigInt(raw) : undefined;
+        // Wi-Fi devices expose a `wireless`/`phy80211` subdirectory.
+        const wireless = fs.existsSync(`/sys/class/net/${name}/wireless`) || fs.existsSync(`/sys/class/net/${name}/phy80211`);
+        const uevent = read(`/sys/class/net/${name}/device/uevent`);
+        const id = uevent && /^PCI_ID=(.+)$/m.exec(uevent)?.[1];
+        const model = id ? pciName(id) : name;
+        result.push({ name, model, connected, wireless, speed });
+    }
+    return result;
+}
+export function systemInfo() {
+    return {
+        cpus: Object.entries(Object.groupBy(os.cpus(), cpu => cpu.model)).map(([model, info]) => ({ model, cores: info?.length || 1 })),
+        gpus: gpus(),
+        memory: memory(),
+        storage: storage(),
+        networkInterfaces: networkInterfaces(),
+        arch: os.arch(),
+        machine: os.machine(),
+        platform: os.platform(),
+        release: os.release(),
+        type: os.type(),
+        uptime: os.uptime(),
+        version: os.version(),
+        hostname: os.hostname(),
+    };
+}

package/dist/client/socket.d.ts

@@ -0,0 +1 @@
+import '../common.js';

package/dist/client/socket.js

@@ -0,0 +1,9 @@
+import { addListener } from '@axium/client/socket';
+import '../common.js';
+import { systemInfo } from './info.js';
+import * as os from 'node:os';
+addListener('sysadmin:ping', cb => cb({
+    hostname: os.hostname(),
+    username: os.userInfo().username,
+}));
+addListener('sysadmin:getSystemInfo', cb => cb(systemInfo()));