added copies function, improved docs

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

Author: desultory

readme.md

@@ -59,6 +59,29 @@ 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 `/`.
 
+##### symlink creation
+
+Symlinks are defined in the `symlinks` dict. Each entry must have a name, `source` and `target`:
+
+```
+[symlinks.pinentry]
+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.
+
+To copy files to a different path:
+
+```
+[copies.my_key]
+source = "/home/larry/.gnupg/pubkey.gpg"
+destination = "/etc/ugrd/pub.gpg"
+```
+
 ##### Device node creation
 
 Device nodes can be created by defining them in the `nodes` dict using the following keys:

ugrd/base/core.py

@@ -1,5 +1,5 @@
 __author__ = 'desultory'
-__version__ = '1.0.0'
+__version__ = '1.0.1'
 
 from pathlib import Path
 
@@ -38,6 +38,15 @@ def deploy_dependencies(self):
         self._copy(dependency)
 
 
+def deploy_copies(self):
+    """
+    Copiues everything from self.config_dict['copies'] into the build directory
+    """
+    for copy_name, copy_parameters in self.config_dict['copies'].items():
+        self.logger.debug("[%s] Copying: %s" % (copy_name, copy_parameters))
+        self._copy(copy_parameters['source'], copy_parameters['destination'])
+
+
 def deploy_symlinks(self):
     """
     Creates symlinks for all symlinks in self.config_dict['symlinks']
@@ -98,10 +107,24 @@ def _process_dependencies_multi(self, dependency):
     self['dependencies'].append(dependency)
 
 
+def _process_copies_multi(self, copy_name, copy_parameters):
+    """
+    Processes a copy from the copies parameter
+    Ensures the source and target are defined in the parameters.
+    """
+    self.logger.debug("[%s] Processing copy: %s" % (copy_name, copy_parameters))
+    if 'source' not in copy_parameters:
+        raise ValueError("[%s] No source specified" % copy_name)
+    if 'destination' not in copy_parameters:
+        raise ValueError("[%s] No target specified" % copy_name)
+
+    self['copies'][copy_name] = copy_parameters
+
+
 def _process_symlinks_multi(self, symlink_name, symlink_parameters):
     """
     Processes a symlink,
-    Ensuures the source and target are defined in the parameters.
+    Ensures the source and target are defined in the parameters.
     """
     self.logger.debug("[%s] Processing symlink: %s" % (symlink_name, symlink_parameters))
     if 'source' not in symlink_parameters:

ugrd/base/core.toml

@@ -10,19 +10,21 @@ minor = 1
 
 [imports.config_processing]
 "ugrd.base.core" = [ "_process_binaries_multi",
-		     "_process_dependencies_multi", 
+		     "_process_dependencies_multi",
+		     "_process_copies_multi",
 		     "_process_symlinks_multi",
 		     "_process_file_owner",
 		     "_process_nodes_multi"
 		   ]
 
 [imports.build_tasks]
-"ugrd.base.core" = [ "deploy_dependencies", "deploy_symlinks", "deploy_nodes" ]
+"ugrd.base.core" = [ "deploy_dependencies", "deploy_copies", "deploy_nodes", "deploy_symlinks" ]
 
 [custom_parameters]
 binaries = "NoDupFlatList"  # Binaries which should be included in the intiramfs, dependencies resolved with lddtree
 dependencies = "NoDupFlatList"  # Add the dependencies property, used to define the dependencies of the initramfs
 symlinks = "dict"  # Add the symlinks property, used to define the symlinks to be made in the initramfs
+copies = "dict"  # Add the copies property, used to define the files to be copied to the initramfs
 nodes = "dict"  # Add the nodes property, used to define the device nodes to be created
 paths = "NoDupFlatList"  # Paths to be copied to the initramfs
 build_dir = "Path"  # The directory where the initramfs is built

ugrd/crypto/cryptsetup.py

@@ -1,6 +1,6 @@
 __author__ = 'desultory'
 
-__version__ = '0.5.0'
+__version__ = '0.5.2'
 
 
 CRYPTSETUP_PARAMETERS = ['key_type', 'partuuid', 'uuid', 'key_file', 'header_file']
@@ -83,9 +83,9 @@ def crypt_init(self):
     return out
 
 
-def copy_libgcc(self):
+def find_libgcc(self):
     """
-    Copies libgcc_s.so
+    Finds libgcc.so, adds a copies item for it.
     """
     from subprocess import run
     from pathlib import Path
@@ -95,5 +95,4 @@ def copy_libgcc(self):
     source_path = Path(libgcc.partition('=> ')[-1])
     self.logger.debug("Source path for libgcc_s: %s" % source_path)
 
-    self._copy(source_path, f"/lib64/{source_path.name}")
-
+    self.config_dict['copies']['libgcc_s'] = {'source': source_path, 'destination': Path('/lib64/')}

ugrd/crypto/cryptsetup.toml

@@ -15,8 +15,8 @@ _kmod_depend = [ "dm_crypt", "crc32c" ]
 [imports.init_late]
 "ugrd.crypto.cryptsetup" = [ "crypt_init" ]
 
-[imports.build_tasks]
-"ugrd.crypto.cryptsetup" = [ "copy_libgcc" ]
+[imports.build_pre]
+"ugrd.crypto.cryptsetup" = [ "find_libgcc" ]
 
 [custom_parameters]
 cryptsetup = "dict"  # Dict of cryptsetup volume to be unlocked, keyed by mapped device name

ugrd/crypto/gpg.py

@@ -1,6 +1,6 @@
 __author__ = 'desultory'
 
-__version__ = '0.3.0'
+__version__ = '0.3.1'
 
 
 def fetch_keys(self):
@@ -23,14 +23,6 @@ def import_keys(self):
         return f"gpg --import {self.config_dict['gpg_public_key']}"
 
 
-def symlink_pinentry(self):
-    """
-    Symlink pinentry
-    """
-    pinentry = self.config_dict.get('pinentry', 'pinentry-tty')
-    return f"ln -s /usr/bin/{pinentry} /usr/bin/pinentry"
-
-
 def start_agent(self):
     """
     Start the GPG agent

ugrd/initramfs_generator.py

@@ -1,6 +1,6 @@
 
 __author__ = "desultory"
-__version__ = "0.7.3"
+__version__ = "0.7.4"
 
 from tomllib import load
 from pathlib import Path
@@ -291,6 +291,10 @@ def _copy(self, source, dest=None, in_build_dir=True):
 
         if dest_path.is_file():
             self.logger.warning("File already exists: %s" % dest_path)
+        elif dest_path.is_dir():
+            self.logger.debug("Destination is a directory, adding source filename: %s" % source.name)
+            dest_path = dest_path / source.name
+
         self.logger.info("Copying '%s' to '%s'" % (source, dest_path))
         copy2(source, dest_path)