penguins-eggs 25.10.28 → 25.10.30

package/dist/classes/ovary.d/luks-root-initrd.js

@@ -0,0 +1,213 @@
+/**
+ * ./src/classes/ovary.d/luks-root-initrd.ts
+ * penguins-eggs v.25.10.x / ecmascript 2020
+ * author: Piero Proietti
+ * email: piero.proietti@gmail.com
+ * license: MIT
+ */
+// packages
+import fs from 'fs';
+import path from 'node:path';
+// classes
+import { exec } from '../../lib/utils.js';
+import Utils from '../utils.js';
+// _dirname
+const __dirname = path.dirname(new URL(import.meta.url).pathname);
+const noop = () => { };
+/**
+ * Creates a streamlined initrd image for Debian/Ubuntu with LUKS support using mkinitramfs within a temporary chroot.
+ * Copies the necessary unlock script, ensures losetup is included via a hook, and wraps /scripts/live for debugging.
+ * Assumes live-boot and cryptsetup packages are installed in the chroot.
+ * No cleanup of /etc modifications is performed as the chroot is temporary.
+ * @param this - Ovary instance context
+ * @param verbose - Whether to show verbose output
+ */
+export async function luksRootInitrd(verbose = false) {
+    const loggers = {
+        log: this.hidden ? noop : console.log,
+        warning: this.hidden ? noop : Utils.warning,
+        success: this.hidden ? noop : Utils.success,
+        info: this.hidden ? noop : Utils.info,
+    };
+    const { log, warning, success, info } = loggers;
+    if (this.hidden) {
+        Utils.warning("intentionally blank. System is working, please wait");
+    }
+    log();
+    log('===========================================================================');
+    log(`Creating ${this.initrd} for LUKS using mkinitramfs`);
+    log('===========================================================================');
+    // --- Core Paths & Config ---
+    const chrootPath = path.join(this.dotMnt, 'filesystem.squashfs');
+    const kernelVersion = this.kernel;
+    const initrdBaseName = path.basename(this.initrd);
+    const logBaseName = `${this.settings.config.snapshot_prefix}mkinitramfs.log.txt`;
+    const finalInitrdDestPath = path.join(this.settings.iso_work, 'live', initrdBaseName); // Define final destination early for logging
+    try {
+        // --- 2. Prepare Chroot Environment ---
+        warning("Preparing chroot environment...");
+        // --- 2.1 Copy boot-encrypted-root.sh
+        {
+            const bootEncryptedRootName = 'boot-encrypted-root.sh'; // Corrected to lowercase zz-
+            const srcbootEncryptedRootPath = path.join(__dirname, '../../../scripts', bootEncryptedRootName);
+            const chrootbootEncryptedRootDir = '/etc/initramfs-tools/scripts/live-premount';
+            const chrootbootEncryptedRootPath = path.join(chrootbootEncryptedRootDir, bootEncryptedRootName);
+            const hostDestbootEncryptedRootDir = path.join(chrootPath, chrootbootEncryptedRootDir);
+            const hostDestbootEncryptedRootPath = path.join(chrootPath, chrootbootEncryptedRootPath);
+            if (!fs.existsSync(srcbootEncryptedRootPath)) {
+                throw new Error(`Unlock script source not found: ${srcbootEncryptedRootPath}`);
+            }
+            await exec(`mkdir -p "${hostDestbootEncryptedRootDir}"`);
+            await exec(`cp "${srcbootEncryptedRootPath}" "${hostDestbootEncryptedRootPath}"`);
+            await exec(`chmod +x "${hostDestbootEncryptedRootPath}"`);
+            success(`Copied ${bootEncryptedRootName} script to ${hostDestbootEncryptedRootDir}`);
+        }
+        // --- 2.2 Create dummy /etc/crypttab if needed ---
+        {
+            const chrootCrypttabPath = '/etc/crypttab';
+            const hostCrypttabPath = path.join(chrootPath, chrootCrypttabPath);
+            if (!fs.existsSync(hostCrypttabPath)) {
+                const crypttabContent = "# Dummy entry to ensure cryptsetup is included\ncryptroot UUID=none none luks\n";
+                fs.writeFileSync(hostCrypttabPath, crypttabContent, 'utf-8');
+                success(`Created crypttab on ${path.dirname(hostCrypttabPath)}`);
+            }
+            else {
+                info(`${hostCrypttabPath} already exists.`);
+            }
+        }
+        // --- 2.3 Add hook ---
+        // Utils.warning(`Generating required hook scripts`)
+        await addHook('/usr/sbin/losetup', chrootPath, loggers);
+        await addHook('/usr/bin/rsync', chrootPath, loggers);
+        // --- 2.4 Add modules ---
+        // addModules('overlay', chrootPath)
+        // --- 3. Execute mkinitramfs INSIDE Chroot ---
+        {
+            warning(`Running mkinitramfs for kernel ${kernelVersion} inside chroot...`);
+            const chrootTmpInitrdPath = `/tmp/${initrdBaseName}`;
+            let logFilePath = path.join(this.settings.iso_work, logBaseName);
+            if (this.hidden) {
+                logFilePath = '/dev/null';
+            }
+            const mkinitramfsCmd = `mkinitramfs -v -o "${chrootTmpInitrdPath}" ${kernelVersion}`;
+            const chrootCmd = `chroot "${chrootPath}" /bin/bash -c "${mkinitramfsCmd}" > "${logFilePath}" 2>&1`;
+            await exec(chrootCmd, this.echo);
+            success(`mkinitramfs completed. Log: ${logFilePath}`);
+        }
+        // --- 4. Move Result ---
+        {
+            const chrootTmpInitrdPath = `/tmp/${initrdBaseName}`; // Re-declare for scope
+            const hostTmpInitrdPath = path.join(chrootPath, chrootTmpInitrdPath);
+            if (fs.existsSync(hostTmpInitrdPath)) {
+                info(`Moving generated initrd to ${finalInitrdDestPath}`);
+                await exec(`mv "${hostTmpInitrdPath}" "${finalInitrdDestPath}"`);
+                success(`Initrd moved successfully.`);
+            }
+            else {
+                Utils.error(`Generated initrd not found at ${hostTmpInitrdPath}. Build failed!`);
+                throw new Error("mkinitramfs did not produce the expected output file.");
+            }
+            // process.exit()
+        }
+    }
+    catch (error) {
+        Utils.error(`Error during LUKS initrd generation: ${error}`);
+        const logFilePath = path.join(this.settings.iso_work, logBaseName); // Re-declare for scope
+        if (error instanceof Error && error.message.includes('mkinitramfs inside chroot failed')) {
+            Utils.warning(`Check mkinitramfs log: ${logFilePath}`);
+        }
+        throw error; // Re-throw error
+    }
+    success(`Finished creating LUKS initrd: ${finalInitrdDestPath}`);
+}
+/**
+ * Genera e installa uno script hook di initramfs-tools nel chroot.
+ * Copia il comando specificato nella sua directory di destinazione
+ * standard (/bin o /sbin) all'interno dell'initramfs.
+ * @param cmdPath Path assoluto del comando da copiare *nel chroot* (es. '/usr/sbin/losetup')
+ * @param chrootPath Path assoluto alla radice del chroot
+ */
+async function addHook(cmdPath, chrootPath, loggers) {
+    const { log, warning, success, info } = loggers;
+    const chrootHooksDirPath = '/etc/initramfs-tools/hooks';
+    const hostHooksDirPath = path.join(chrootPath, chrootHooksDirPath);
+    const cmd = path.basename(cmdPath); // es. 'losetup'
+    const hookScriptName = `add-${cmd}-hook.sh`; // es. 'add-losetup-hook.sh'
+    const hostHookPath = path.join(hostHooksDirPath, hookScriptName);
+    if (!fs.existsSync(cmdPath)) {
+        Utils.error(`Dont' exists ${cmdPath}`);
+        process.exit();
+    }
+    let destDir = "/sbin"; // Default a /sbin per i comandi di amministrazione
+    // Determina la destinazione corretta
+    if (cmdPath.includes('/usr/bin') || cmdPath.includes('/bin')) {
+        destDir = "/bin"; // Comandi utente
+    }
+    else if (cmdPath.includes('/usr/sbin') || cmdPath.includes('/sbin')) {
+        destDir = "/sbin"; // Comandi amministrativi
+    }
+    // Crea la riga di comando per l'hook
+    const copyLine = `copy_exec ${cmdPath} ${destDir} || echo "WARNING: Failed to copy ${cmdPath} to ${destDir}" >&2`;
+    // Crea il contenuto boilerplate dello script hook
+    const hookContent = `#!/bin/sh
+# Hook: ${hookScriptName}
+# Generato automaticamente da penguins-eggs
+# Copia ${cmdPath} in ${destDir}
+
+PREREQ=""
+case $1 in prereqs) echo "\${PREREQ}"; exit 0;; esac
+
+. /usr/share/initramfs-tools/hook-functions
+
+echo "EGGS-HOOK: Esecuzione hook ${hookScriptName}..."
+${copyLine}
+
+exit 0
+`;
+    try {
+        await exec(`mkdir -p "${hostHooksDirPath}"`);
+        // Scrive il file e lo rende eseguibile (mode 0o755)
+        fs.writeFileSync(hostHookPath, hookContent, { mode: 0o755, encoding: 'utf-8' });
+        // console.log(hookContent)
+        success(`Generated and set executable hook: ${hookScriptName}`);
+    }
+    catch (err) {
+        Utils.error(`Failed to write hook script ${hostHookPath}: ${err.message}`);
+        process.exit(1);
+        throw err; // Lancia l'errore per fermare il processo
+    }
+}
+/**
+ *
+ * @param module
+ * @param chrootPath
+ */
+function addModules(module, chrootPath, loggers) {
+    const { log, warning, success, info } = loggers;
+    const chrootModulesFilePath = '/etc/initramfs-tools/modules'; // Relative inside chroot
+    const hostModulesFilePath = path.join(chrootPath, chrootModulesFilePath); // Absolute on host fs
+    let modulesContent = '';
+    let needsUpdate = false;
+    if (fs.existsSync(hostModulesFilePath)) {
+        modulesContent = fs.readFileSync(hostModulesFilePath, 'utf-8');
+    }
+    else {
+        // inizializzazione modules
+        modulesContent = '\n';
+    }
+    if (modulesContent.includes(`\n${module}\n`)) {
+        info(`'${module}' module already present.`);
+    }
+    else {
+        info(`Added '${module}' module on ${hostModulesFilePath}`);
+        if (!modulesContent.endsWith('\n')) {
+            modulesContent += '\n';
+        }
+        modulesContent += `${module}\n`;
+        needsUpdate = true;
+    }
+    if (needsUpdate) {
+        fs.writeFileSync(hostModulesFilePath, modulesContent, 'utf-8');
+        success(`Updated ${hostModulesFilePath} with 'overlay'.`);
+    }
+}

package/dist/classes/ovary.d/luks-root.d.ts

@@ -0,0 +1,15 @@
+/**
+ * ./src/classes/ovary.d/luks-root.ts
+ * penguins-eggs v.25.10.x / ecmascript 2020
+ * author: Piero Proietti
+ * email: piero.proietti@gmail.com
+ * license: MIT
+ */
+import Ovary from '../ovary.js';
+/**
+ * luksRoot()
+ *
+ * create a container LUKS with the entire
+ * filesystem.squashfs
+ */
+export declare function luksRoot(this: Ovary): Promise<void>;

package/dist/classes/ovary.d/luks-root.js

@@ -0,0 +1,123 @@
+/**
+ * ./src/classes/ovary.d/luks-root.ts
+ * penguins-eggs v.25.10.x / ecmascript 2020
+ * author: Piero Proietti
+ * email: piero.proietti@gmail.com
+ * license: MIT
+ */
+// packages
+import fs from 'fs';
+import Utils from '../utils.js';
+import { exec } from '../../lib/utils.js';
+const noop = () => { };
+/**
+ * luksRoot()
+ *
+ * create a container LUKS with the entire
+ * filesystem.squashfs
+ */
+export async function luksRoot() {
+    const loggers = {
+        log: this.hidden ? noop : console.log,
+        warning: this.hidden ? noop : Utils.warning,
+        success: this.hidden ? noop : Utils.success,
+        info: this.hidden ? noop : Utils.info,
+    };
+    const { log, warning, success, info } = loggers;
+    // filesystem.squashfs
+    const live_fs = `${this.settings.iso_work}live/filesystem.squashfs`;
+    try {
+        /**
+         * this.luksMappedName = 'root.img';
+         * this.luksFile = `/tmp/${luksMappedName}`
+         * this.luksDevice = `/dev/mapper/${luksMappedName}`
+         * this.luksMountpoint = `/tmp/mnt/${luksMappedName}`
+         * this.luksPassword = '0'
+         */
+        if (this.hidden) {
+            Utils.warning("intentionally blank. System is working, please wait");
+        }
+        log();
+        log('====================================');
+        log(` Creating ${this.luksMappedName}`);
+        log('====================================');
+        if (!fs.existsSync(live_fs)) {
+            throw new Error(`filesystem.squashfs not found at: ${live_fs}`);
+        }
+        const stats = fs.statSync(live_fs);
+        let size = stats.size; // Dimensione REALE del file in Byte
+        // Add overhead * 1.25 per più sicurezza con file grandi
+        const luksSize = Math.ceil(size * 1.25);
+        warning(`filesystem.squashfs size: ${bytesToGB(size)}`);
+        warning(`partition LUKS ${this.luksFile} size: ${bytesToGB(luksSize)}`);
+        warning(`creating partition LUKS: ${this.luksFile}`);
+        await this.luksExecuteCommand('truncate', ['--size', `${luksSize}`, this.luksFile]);
+        warning(`formatting ${this.luksFile} as a LUKS volume...`);
+        const luksFormatArgs = this.buildLuksFormatArgs(this.luksConfig, this.luksFile);
+        await this.luksExecuteCommand('cryptsetup', luksFormatArgs, `${this.luksPassword}\n`);
+        warning(`opening the LUKS volume. It will be mapped to ${this.luksDevice}`);
+        await this.luksExecuteCommand('cryptsetup', ['luksOpen', this.luksFile, this.luksMappedName], `${this.luksPassword}\n`);
+        warning(`formatting ext4 (without journal)...`);
+        await exec(`mkfs.ext4 -O ^has_journal -L live-root ${this.luksDevice}`, this.echo);
+        warning(`mounting ${this.luksDevice} on ${this.luksMountpoint}`);
+        if (fs.existsSync(this.luksMountpoint)) {
+            if (!Utils.isMountpoint(this.luksMountpoint)) {
+                await exec(`rm -rf ${this.luksMountpoint}`, this.echo);
+            }
+            else {
+                throw new Error(`${this.luksMountpoint} is already mounted, process will abort!`);
+            }
+        }
+        await exec(`mkdir -p ${this.luksMountpoint}`, this.echo);
+        await exec(`mount /dev/mapper/${this.luksMappedName} ${this.luksMountpoint}`, this.echo);
+        warning(`moving ${live_fs} ${this.luksMountpoint}/filesystem.squashfs`);
+        await exec(`mv ${live_fs} ${this.luksMountpoint}/filesystem.squashfs`, this.echo);
+        warning(`Syncing filesystem on ${this.luksMountpoint}...`);
+        await exec('sync', this.echo); // Forza scrittura dati su disco
+        warning(`Attempting unmount ${this.luksMountpoint}...`);
+        try {
+            await exec(`umount ${this.luksMountpoint}`, this.echo);
+            success(`Unmounted ${this.luksMountpoint} successfully.`);
+        }
+        catch (umountError) {
+            Utils.error(`Failed to unmount ${this.luksMountpoint}! Trying force unmount...`);
+            // Tenta un unmount forzato/lazy come ultima risorsa
+            await exec(`umount -lf ${this.luksMountpoint}`).catch((forceError) => {
+                Utils.error(`Force unmount also failed: ${forceError}`);
+                // Considera se lanciare un errore qui per fermare il processo
+            });
+            // Lancia comunque l'errore originale per segnalare il problema
+            throw umountError;
+        }
+        warning(`closing LUKS volume ${this.luksFile}.`);
+        await this.luksExecuteCommand('cryptsetup', ['close', this.luksMappedName]);
+        warning(`moving ${this.luksMappedName} on (ISO)/live.`);
+        await exec(`mv ${this.luksFile} ${this.settings.iso_work}/live`, this.echo);
+    }
+    catch (error) {
+        if (error instanceof Error) {
+            Utils.error(`ERROR: ${error.message}`);
+        }
+        else {
+            Utils.error(`An unknown error has occurred.`);
+        }
+        Utils.warning('Cleaning performed following the error...');
+        if (fs.existsSync(this.luksMountpoint)) {
+            await exec(`umount -lf ${this.luksMountpoint}`).catch(() => { });
+        }
+        if (fs.existsSync(this.luksDevice)) {
+            await this.luksExecuteCommand('cryptsetup', ['close', this.luksMappedName]).catch(() => { });
+        }
+        await Utils.pressKeyToExit();
+        process.exit(1);
+    }
+}
+/**
+ * Converte bytes in gigabytes per la visualizzazione.
+ */
+function bytesToGB(bytes) {
+    if (bytes === 0)
+        return '0.00 GB';
+    const gigabytes = bytes / (1024 * 1024 * 1024);
+    return gigabytes.toFixed(2) + ' GB';
+}

package/dist/classes/ovary.d/make-dot-disk.d.ts

@@ -0,0 +1,12 @@
+/**
+ * ./src/classes/ovary.d/produce.ts
+ * penguins-eggs v.25.7.x / ecmascript 2020
+ * author: Piero Proietti
+ * email: piero.proietti@gmail.com
+ * license: MIT
+ */
+import Ovary from './../ovary.js';
+/**
+   * makeDotDisk
+   */
+export declare function makeDotDisk(this: Ovary, info?: string, mksquashfs?: string, mkisofs?: string): void;

package/dist/classes/ovary.d/make-dot-disk.js

@@ -0,0 +1,71 @@
+/**
+ * ./src/classes/ovary.d/produce.ts
+ * penguins-eggs v.25.7.x / ecmascript 2020
+ * author: Piero Proietti
+ * email: piero.proietti@gmail.com
+ * license: MIT
+ */
+// packages
+import fs from 'node:fs';
+import shx from 'shelljs';
+import path from 'path';
+// interfaces
+// libraries
+// classes
+import Utils from './../utils.js';
+// _dirname
+const __dirname = path.dirname(new URL(import.meta.url).pathname);
+/**
+   * makeDotDisk
+   */
+export function makeDotDisk(info = '', mksquashfs = '', mkisofs = '') {
+    const dotDisk = this.settings.iso_work + '.disk';
+    if (fs.existsSync(dotDisk)) {
+        shx.rm('-rf', dotDisk);
+    }
+    shx.mkdir('-p', dotDisk);
+    /**
+     * write volid .disk/info
+     * Required
+     */
+    let volidContent = "Linux live";
+    if (this.hidden) {
+        fs.writeFileSync(path.join(dotDisk, 'info'), volidContent, 'utf-8');
+        return;
+    }
+    /**
+     * write volid .disk/info
+     * Complete
+     */
+    volidContent = this.settings.isoFilename;
+    fs.writeFileSync(path.join(dotDisk, 'info'), volidContent, 'utf-8');
+    /**
+     * A readme now replace the old .disk/info
+     */
+    let readme = ``;
+    readme += `# penguins_eggs\n`;
+    readme += `\n`;
+    readme += `Volinfo: ${this.volid}\n`;
+    readme += `Image created at: ${Utils.formatDate(new Date())} using penguins_eggs v. ${Utils.getPackageVersion()})\n`;
+    readme += `repo: [penguins-eggs](https://github.com/penguins-eggs)\n`;
+    readme += `blog: [penguins-eggs.net](https://penguins-eggs.net)\n`;
+    readme += `author: [Piero Proietti](mailto://piero.proietti@gmail.com)\n`;
+    fs.writeFileSync(path.join(dotDisk, 'README.md'), readme, 'utf-8');
+    /**
+     * write mksquashfs as .disk/mksquashfs
+     */
+    fs.writeFileSync(path.join(dotDisk, 'mksquashfs'), mksquashfs, 'utf-8');
+    /**
+     * write mkisofs as .disk/mkisofs
+     */
+    fs.writeFileSync(path.join(dotDisk, 'mkisofs'), mkisofs, 'utf-8');
+    /**
+     * touch uuid as file name on .disk/id
+     *
+     * This is a DEBIAN standard
+     */
+    if (this.uuid && this.uuid.trim() !== '') {
+        shx.mkdir(path.join(dotDisk, 'id'));
+        shx.touch(path.join(dotDisk, 'id', this.uuid));
+    }
+}

package/dist/classes/ovary.d/make-efi.d.ts

@@ -0,0 +1,14 @@
+/**
+ * ./src/classes/ovary.d/make-efi.ts
+ * penguins-eggs v.25.7.x / ecmascript 2020
+ * author: Piero Proietti
+ * email: piero.proietti@gmail.com
+ * license: MIT
+ */
+import Ovary from '../ovary.js';
+/**
+ *
+ * @param this
+ * @param theme
+ */
+export declare function makeEfi(this: Ovary, theme?: string): Promise<void>;