Merge pull request 'vars: allow setting files as needed for activation' (#2633) from vars-needed_activation into main

docs/site/manual/secrets.md

@@ -28,7 +28,7 @@ In your nixos configuration you can get a path to secrets like this `config.sops
 
 ```nix
 { config, ...}: {
-  sops.secrets.my-password.neededForUsers = true;
+  sops.secrets.my-password.neededFor = "users";
 
   users.users.mic92 = {
     isNormalUser = true;

nixosModules/clanCore/vars/default.nix

@@ -55,7 +55,7 @@ in
                 mode
                 deploy
                 secret
-                neededForUsers
+                neededFor
                 ;
             }
           );

nixosModules/clanCore/vars/interface.nix

@@ -196,14 +196,18 @@ in
                       '';
                       type = str;
                     };
-                    neededForUsers = lib.mkOption {
+                    neededFor = lib.mkOption {
                       description = ''
                         Enabling this option causes the secret to be decrypted/installed before users and groups are created.
                         This can be used to retrieve user's passwords.
                         Setting this option moves the secret to /run/secrets-for-users and disallows setting owner and group to anything else than root.
                       '';
-                      type = bool;
-                      default = false;
+                      type = lib.types.enum [
+                        "activation"
+                        "users"
+                        "services"
+                      ];
+                      default = "services";
                     };
                     owner = lib.mkOption {
                       description = "The user name or id that will own the file.";

nixosModules/clanCore/vars/secret/password-store.nix

@@ -69,10 +69,15 @@ in
             file:
             lib.mkIf file.config.secret {
               path =
-                if file.config.neededForUsers then
+                if file.config.neededFor == "users" then
                   "/run/user-secrets/${file.config.generatorName}/${file.config.name}"
+                else if file.config.neededFor == "services" then
+                  "/run/secrets/${file.config.generatorName}/${file.config.name}"
+                else if file.config.neededFor == "activation" then
+                  "${config.clan.password-store.secretLocation}/${file.config.generatorName}/${file.config.name}"
                 else
-                  "/run/secrets/${file.config.generatorName}/${file.config.name}";
+                  throw "unknown neededFor ${file.config.neededFor}";
+
             };
           secretModule = "clan_cli.vars.secret_modules.password_store";
         };

nixosModules/clanCore/vars/secret/sops/default.nix

@@ -27,6 +27,9 @@ in
     # Before we generate a secret we cannot know the path yet, so we need to set it to an empty string
     fileModule = file: {
       path = lib.mkIf file.config.secret (
+        if file.config.neededFor == "activation" then
+          "/var/lib/sops-nix/${file.config.generatorName}/${file.config.name}"
+        else
           config.sops.secrets.${"vars/${file.config.generatorName}/${file.config.name}"}.path
             or "/no-such-path"
       );

nixosModules/clanCore/vars/secret/sops/funcs.nix

@@ -16,7 +16,9 @@ in
   collectFiles =
     vars:
     let
-      relevantFiles = generator: flip filterAttrs generator.files (_name: f: f.secret && f.deploy);
+      relevantFiles =
+        generator:
+        flip filterAttrs generator.files (_name: f: f.secret && f.deploy && (f.neededFor != "activation"));
       allFiles = flatten (
         flip mapAttrsToList vars.generators (
           gen_name: generator:
@@ -24,8 +26,9 @@ in
             fname: file: {
               name = fname;
               generator = gen_name;
+              neededForUsers = file.neededFor == "users";
               inherit (generator) share;
-              inherit (file) owner group neededForUsers;
+              inherit (file) owner group;
             }
           )
         )

pkgs/clan-cli/clan_cli/vars/secret_modules/password_store.py

@@ -160,11 +160,20 @@ class SecretStore(StoreBase):
             for generator in self.machine.vars_generators:
                 dir_exists = False
                 for file in generator.files:
+                    if file.needed_for == "activation":
+                        (output_dir / generator.name / file.name).parent.mkdir(
+                            parents=True,
+                            exist_ok=True,
+                        )
+                        (output_dir / generator.name / file.name).write_bytes(
+                            self.get(generator, file.name)
+                        )
+                        continue
                     if not file.deploy:
                         continue
                     if not file.secret:
                         continue
-                    if not dir_exists and not file.needed_for_users:
+                    if not dir_exists and file.needed_for == "services":
                         tar_dir = tarfile.TarInfo(name=generator.name)
                         tar_dir.type = tarfile.DIRTYPE
                         tar_dir.mode = 0o511
@@ -176,7 +185,7 @@ class SecretStore(StoreBase):
                     tar_file.mode = file.mode
                     tar_file.uname = file.owner
                     tar_file.gname = file.group
-                    if file.needed_for_users:
+                    if file.needed_for == "users":
                         user_tar.addfile(tarinfo=tar_file, fileobj=io.BytesIO(content))
                     else:
                         tar.addfile(tarinfo=tar_file, fileobj=io.BytesIO(content))

pkgs/clan-cli/clan_cli/vars/secret_modules/sops.py

@@ -173,6 +173,16 @@ class SecretStore(StoreBase):
             sops_secrets_folder(self.machine.flake_dir) / key_name,
         )
         (output_dir / "key.txt").write_text(key)
+        for generator in self.machine.vars_generators:
+            for file in generator.files:
+                if file.needed_for == "activation":
+                    (output_dir / generator.name / file.name).parent.mkdir(
+                        parents=True,
+                        exist_ok=True,
+                    )
+                    (output_dir / generator.name / file.name).write_bytes(
+                        self.get(generator, file.name)
+                    )
 
     def upload(self) -> None:
         with TemporaryDirectory(prefix="sops-upload-") as tempdir:

pkgs/clan-cli/clan_cli/vars/var.py

@@ -17,7 +17,7 @@ class Var:
     owner: str = "root"
     group: str = "root"
     mode: int = 0o400
-    needed_for_users: bool = False
+    needed_for: str = "services"
 
     # TODO: those shouldn't be set here
     _store: "StoreBase | None" = None
@@ -78,5 +78,5 @@ class Var:
             owner=data.get("owner", "root"),
             group=data.get("group", "root"),
             mode=int(data.get("mode", "400"), 8),
-            needed_for_users=data.get("neededForUsers", False),
+            needed_for=data.get("neededFor", "services"),
         )