updated to be more like dracut in how it runs, made cpio required, warn about cpio chown errors and changed the cmdline args to allow specifying the output file

Signed-off-by: Zen <[email protected]>

Author: desultory

config_example.toml

@@ -1,15 +1,13 @@
 # This config will decrypt the LUKS volume with uuid "fdf442da-0574-4531-98c7-55227a041f1d", mapping it to "/dev/mapper/root"
 # It will attempt to mount the btrfs volume with label "rootfs" to /mnt/root
 # It will pull all current kernel modules from lspci -k results
-# The "ugrd.base.cpio" module will pack the initramfs into a cpio archive
 
 modules = [
   "ugrd.base.base",
   "ugrd.kmod.kmod",
   "ugrd.kmod.nosound",
   "ugrd.kmod.novideo",
   "ugrd.crypto.cryptsetup",
-  "ugrd.base.cpio"
 ]
 
 # The initramfs will be built in /tmp/initramfs if "build_dir" is not specified not specified

config_yubikey.toml

@@ -11,7 +11,6 @@ modules = [
   "ugrd.kmod.usb",
   "ugrd.kmod.nvme",
   "ugrd.crypto.smartcard",
-  "ugrd.base.cpio"
 ]
 
 sc_public_key = "/etc/ugrd/pubkey.gpg"

readme.md

@@ -24,10 +24,14 @@ To install `ugrd`, clone the repo and run `pip install .`, setting `--break-syst
 
 Once installed, either set the config file in `/etc/ugrd/config.toml`, or pass it to the script:
 
-`ugrd example_config.toml`
+`ugrd -c example_config.toml`
 
 > Debug mode can be enabled with `-d` or verbose debugging with `-dd`
 
+The last argument is the output file, which can be a path:
+
+`ugrd /boot/ugrd.cpio`
+
 ## Runtime usage
 
 `ugrd` runs the `init` script generated in the build dir. In cases where `agetty` is needed, most of the work is done in `init_main.sh`.
@@ -57,7 +61,7 @@ Modules write to a shared config dict that is accessible by other modules.
 
 #### base.base
 
-> The main module, mostly pulls basic binaries and pulls the `core` and `mounts` modules
+> The main module, mostly pulls basic binaries and pulls the `core`, `mounts`, and `cpio` module.
 
 * `shebang` (#!/bin/bash) sets the shebang on the init script.
 
@@ -70,6 +74,14 @@ Modules write to a shared config dict that is accessible by other modules.
 * `binaries` is a list used to define programs to be pulled into the initrams. `which` is used to find the path of added entries, and `lddtree` is used to resolve dependendies.
 * `paths` is a list of directores to create in the `build_dir`. They do not need a leading `/`.
 
+#### base.cpio
+
+This module handles CPIO creation.
+
+* `out_file` (ugrd.cpio) Sets the name of the output file, under `out_dir` unless a path is defined.
+* `cpio_list_name` (cpio.list) Sets the name of the cpio list file for `gen_init_cpio`
+* `mknod_cpio` (true) Only create devicne nodes within the CPIO.
+
 ##### symlink creation
 
 Symlinks are defined in the `symlinks` dict. Each entry must have a name, `source` and `target`:
@@ -80,7 +92,6 @@ source = "/usr/bin/pinentry-tty"
 target = "/usr/bin/pinentry"
 ```
 
-
 ##### Copying files to a different destination
 
 Using the `dependencies` list will pull files into the initramfs using the same path on the host system.
@@ -145,19 +156,6 @@ Defines /dev/ttyS1 as a `vt100` terminal with a `115200` baud rate.
 
 `primary_console` (tty0)  is used to set which console will be initialized with agetty on boot.
 
-#### base.cpio
-
-This module assists in creating a CPIO out of the initramfs `build_dir`.
-
-> This module is run during the `pack` phase.
-
-The following parameters can be set to alter CPIO functionality:
-
-* `mknod_cpio` (true) Only create the device nodes within the CPIO file.
-* `cpio_filename` (ugrd.cpio) can be set to change the final CPIO filename in the `out_dir`.
-* `cpio_list_name` (cpio.list) can be used to change the filename of the CPIO list for `gen_init_cpio`.
-* `_gen_init_cpio_path` The path to this tool can be specified. If not, it is included and will be built at runtime if needed.
-
 #### base.debug
 
 This module contains debug programs such as `cp`, `mv`, `rm`, `grep`, `dmesg`, `find`, and `nano`,
@@ -310,7 +308,7 @@ key_type = "gpg"
 
 Cryptsetup global config:
 
-* `cryptsetup_key_type` (keyfile) Used to determine how a key is unlocked, setting it globally changes the default for definitions
+* `cryptsetup_key_type` - Sets the default `key_type` for all cryptsetup entries. 
 * `cryptsetup_retries` (5) The default number of times to try to unlock a device.
 * `cryptsetup_autoretry` (false) Whether or not to automatically retry mount attempts.
 
@@ -448,7 +446,7 @@ The `cpio` module imports the `make_cpio_list` packing function with:
 
 ```
 [imports.pack]
-"ugrd.base.cpio" = [ "make_cpio_list" ]
+"ugrd.base.base" = [ "make_cpio_list" ]
 ```
 
 #### init hooks

ugrd/base/base.toml

@@ -1,14 +1,13 @@
-shebang = "#!/bin/bash"
-
-modules = ["ugrd.base.core", "ugrd.fs.mounts"]
+modules = ["ugrd.base.core", "ugrd.fs.mounts", "ugrd.base.cpio"]
 
 binaries = [ "bash", "ls", "cat", "switch_root" ]
 
 paths = [ "root" ]
 
+shebang = "#!/bin/bash"
+
 [imports.init_final]
 "ugrd.base.base" = [ "switch_root" ]
 
 [custom_parameters]
 shebang = "str"  # Add the shebang property, used because this is a bash script
-

ugrd/base/cpio.py

@@ -1,5 +1,6 @@
-__author__ = "desultory"
-__version__ = "0.1.1"
+__author__ = 'desultory'
+__version__ = '1.1.0'
+
 
 from subprocess import run
 from pathlib import Path
@@ -26,7 +27,7 @@ def pack_cpio(self):
     """
     Packs the CPIO file using gen_init_cpio
     """
-    cpio_path = self.config_dict.get('gen_init_cpio_path', Path(__file__).parent.parent / 'include' / 'gen_init_cpio')
+    cpio_path = Path(__file__).parent.parent / 'include' / 'gen_init_cpio'
 
     if not cpio_path.exists():
         build_gen_init_cpio(self, cpio_path)
@@ -36,15 +37,19 @@ def pack_cpio(self):
     packing_list = str(self.out_dir / self.config_dict['cpio_list_name'])
     self.logger.info("Creating CPIO file from packing list: %s" % packing_list)
 
-    out_cpio = self.out_dir / self.config_dict['cpio_filename']
+    out_cpio = self.out_dir / self.config_dict['out_file']
 
     with open(out_cpio, 'wb') as cpio_file:
         cmd = run([str(cpio_path), packing_list], stdout=cpio_file)
         if cmd.returncode != 0:
             raise RuntimeError("gen_init_cpio failed with error: %s" % cmd.stderr.decode())
 
     self.logger.info("CPIO file created at: %s" % out_cpio)
-    self._chown(out_cpio)
+
+    try:
+        self._chown(out_cpio)
+    except PermissionError:
+        self.logger.warning("Unable to change the owner of the CPIO file: %s" % out_cpio)
 
 
 def generate_cpio_mknods(self):
@@ -94,7 +99,7 @@ def make_cpio_list(self):
             file_dest = relative_dir / file
             file_source = current_dir / file
             if file_source.is_symlink():
-                symlink_list.append(f"slink /{file_dest} /{file_source.resolve().relative_to(self.build_dir)} 777 0 0")
+                symlink_list.append(f"slink /{file_dest} {file_source.resolve()} 777 0 0")
             elif file_source.is_char_device():
                 node_major = major(file_source.stat().st_rdev)
                 node_minor = minor(file_source.stat().st_rdev)
@@ -122,4 +127,3 @@ def make_cpio_list(self):
     packing_list = directory_list + file_list + symlink_list + node_list
 
     self._write(self.out_dir / self.config_dict['cpio_list_name'], packing_list, in_build_dir=False)
-

ugrd/base/cpio.toml

@@ -1,12 +1,11 @@
-cpio_filename = "ugrd.cpio"
+out_file = "ugrd.cpio"
 cpio_list_name = "cpio.list"
 mknod_cpio = true
 
 [imports.pack]
 "ugrd.base.cpio" = [ "make_cpio_list", "pack_cpio" ]
 
 [custom_parameters]
-mknod_cpio = "bool"  # When enabled, mknod is not used to create device nodes, they are just created in the cpio.
-cpio_filename = "str"  # The name of the cpio file to create.
+out_file =  "str"  # The name of the cpio file to create.
 cpio_list_name = "str"  # The name of the CPIO packing list to create
-_gen_init_cpio_path = "Path"  # The path of the gen_init_cpio binary
+mknod_cpio = "bool"  # When enabled, mknod is not used to create device nodes, they are just created in the cpio.

ugrd/crypto/cryptsetup.toml

@@ -6,7 +6,6 @@ _kmod_depend = [ "dm_crypt", "crc32c" ]
 
 cryptsetup_retries = 5
 cryptsetup_autoretry = true
-cryptsetup_key_type = "keyfile"
 
 [imports.config_processing]
 "ugrd.crypto.cryptsetup" = [ "_process_cryptsetup_multi", "_process_cryptsetup_key_types_multi" ]

ugrd/initramfs_dict.py

@@ -32,6 +32,14 @@ def __init__(self, *args, **kwargs):
             else:
                 super().__setitem__(parameter, default_type())
 
+    def import_args(self, args: dict):
+        """
+        Imports data from an argument dict
+        """
+        for arg, value in args.items():
+            self.logger.warning("Importing argument '%s' with value: %s" % (arg, value))
+            self[arg] = value
+
     def __setitem__(self, key, value):
         # If the type is registered, use the appropriate update function
         if expected_type := self.builtin_parameters.get(key, self['custom_parameters'].get(key)):

ugrd/initramfs_generator.py

@@ -1,6 +1,6 @@
 
 __author__ = "desultory"
-__version__ = "0.7.8"
+__version__ = "0.8.0"
 
 from tomllib import load
 from pathlib import Path
@@ -23,6 +23,7 @@ def __init__(self, config='/etc/ugrd/config.toml', *args, **kwargs):
         self.load_config()
         self.config_dict.verify_deps()
         self.config_dict.verify_mask()
+        self.config_dict.import_args(kwargs)
 
     def load_config(self):
         """

ugrd/main.py

@@ -11,14 +11,20 @@ def main():
     argparser = ArgumentParser(prog='ugrd',
                                description='MicrogRAM disk initramfs generator')
 
-    argparser.add_argument('config_file',
-                           action='store',
-                           nargs='?',
-                           help='Config file location')
-
     argparser.add_argument('-d', '--debug', action='store_true', help='Debug mode')
     argparser.add_argument('-dd', '--verbose-debug', action='store_true', help='Verbose debug mode')
 
+    # Add arguments for dracut compatibility
+    argparser.add_argument('-c', '--config', action='store', help='Config file location')
+    argparser.add_argument('--kver', action='store', help='Kernel version')
+
+    # Add and ignore arguments for dracut compatibility
+    argparser.add_argument('--force', action='store_true', help='Not used, for dracut compatibility')
+    argparser.add_argument('--kernel-image', action='store', help='Kernel image')
+
+    # Add the argument for the output file
+    argparser.add_argument('output_file', action='store', help='Output file location', nargs='?')
+
     args = argparser.parse_args()
 
     logger = logging.getLogger()
@@ -30,9 +36,15 @@ def main():
         logger.setLevel(20)
 
     kwargs = {'logger': logger}
-    if config := args.config_file:
+    if config := args.config:
         kwargs['config'] = config
 
+    if config := args.kver:
+        kwargs['kernel_version'] = config
+
+    if config := args.output_file:
+        kwargs['out_file'] = config
+
     generator = InitramfsGenerator(**kwargs)
     try:
         generator.build_structure()