Merge pull request 'Add multiline-hidden-prompt' (#3632) from multiline-hidden-prompt into main

Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/3632
Reviewed-by: hsjobeki <hsjobeki@gmail.com>
Reviewed-by: lopter <louis@opter.org>

nixosModules/clanCore/vars/interface.nix

@@ -364,11 +364,13 @@ in
                           - hidden: A hidden text (e.g. password)
                           - line: A single line of text
                           - multiline: A multiline text
+                          - multiline-hidden: A multiline text
                       '';
                       type = enum [
                         "hidden"
                         "line"
                         "multiline"
+                        "multiline-hidden"
                       ];
                       default = "line";
                     };

pkgs/clan-cli/clan_cli/flash/flash.py

@@ -91,7 +91,7 @@ def flash_machine(
                 "users": {"root": {"openssh": {"authorizedKeys": {"keys": root_keys}}}}
             }
 
-        for generator in machine.vars_generators:
+        for generator in machine.vars_generators():
             for file in generator.files:
                 if file.needed_for == "partitioning":
                     msg = f"Partitioning time secrets are not supported with `clan flash write`: clan.core.vars.generators.{generator.name}.files.{file.name}"

pkgs/clan-cli/clan_cli/machines/machines.py

@@ -123,7 +123,6 @@ class Machine:
             return self.deployment["facts"]["services"]
         return {}
 
-    @property
     def vars_generators(self) -> list["Generator"]:
         from clan_cli.vars.generate import Generator
 

pkgs/clan-cli/clan_cli/tests/test_modules.py

@@ -107,7 +107,7 @@ def test_add_module_to_inventory(
 
         generator = None
 
-        for gen in machine.vars_generators:
+        for gen in machine.vars_generators():
             if gen.name == "borgbackup":
                 generator = gen
                 break

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

@@ -33,7 +33,7 @@ def vars_status(machine: Machine, generator_name: None | str = None) -> VarStatu
     # signals if a var needs to be updated (eg. needs re-encryption due to new users added)
     unfixed_secret_vars = []
     invalid_generators = []
-    generators = machine.vars_generators
+    generators = machine.vars_generators()
     if generator_name:
         for generator in generators:
             if generator_name == generator.name:

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

@@ -9,7 +9,7 @@ log = logging.getLogger(__name__)
 
 
 def fix_vars(machine: Machine, generator_name: None | str = None) -> None:
-    generators = machine.vars_generators
+    generators = machine.vars_generators()
     if generator_name:
         for generator in generators:
             if generator_name == generator.name:

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

@@ -132,7 +132,7 @@ def decrypt_dependencies(
     decrypted_dependencies: dict[str, Any] = {}
     for generator_name in set(generator.dependencies):
         decrypted_dependencies[generator_name] = {}
-        for dep_generator in machine.vars_generators:
+        for dep_generator in machine.vars_generators():
             if generator_name == dep_generator.name:
                 break
         else:
@@ -320,7 +320,7 @@ def get_closure(
 ) -> list[Generator]:
     from .graph import all_missing_closure, full_closure
 
-    vars_generators = machine.vars_generators
+    vars_generators = machine.vars_generators()
     generators: dict[str, Generator] = {
         generator.name: generator for generator in vars_generators
     }
@@ -399,7 +399,7 @@ def generate_vars_for_machine(
 
     machine = Machine(name=machine_name, flake=Flake(str(base_dir)))
     generators_set = set(generators)
-    generators_ = [g for g in machine.vars_generators if g.name in generators_set]
+    generators_ = [g for g in machine.vars_generators() if g.name in generators_set]
 
     return _generate_vars_for_machine(
         machine=machine,
@@ -417,7 +417,7 @@ def generate_vars_for_machine_interactive(
 ) -> bool:
     _generator = None
     if generator_name:
-        for generator in machine.vars_generators:
+        for generator in machine.vars_generators():
             if generator.name == generator_name:
                 _generator = generator
                 break

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

@@ -19,7 +19,7 @@ def get_vars(base_dir: str, machine_name: str) -> list[Var]:
     pub_store = machine.public_vars_store
     sec_store = machine.secret_vars_store
     all_vars = []
-    for generator in machine.vars_generators:
+    for generator in machine.vars_generators():
         for var in generator.files:
             if var.secret:
                 var.store(sec_store)
@@ -50,7 +50,7 @@ def _get_previous_value(
 @API.register
 def get_generators(base_dir: str, machine_name: str) -> list[Generator]:
     machine = Machine(name=machine_name, flake=Flake(base_dir))
-    generators: list[Generator] = machine.vars_generators
+    generators: list[Generator] = machine.vars_generators()
     for generator in generators:
         for prompt in generator.prompts:
             prompt.previous_value = _get_previous_value(machine, generator, prompt)
@@ -66,7 +66,7 @@ def set_prompts(
 ) -> None:
     machine = Machine(name=machine_name, flake=Flake(base_dir))
     for update in updates:
-        for generator in machine.vars_generators:
+        for generator in machine.vars_generators():
             if generator.name == update.generator:
                 break
         else:

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

@@ -1,10 +1,14 @@
 import enum
 import logging
 import sys
+import termios
+import tty
 from dataclasses import dataclass
 from getpass import getpass
 from typing import Any
 
+from clan_cli.errors import ClanError
+
 log = logging.getLogger(__name__)
 
 # This is for simulating user input in tests.
@@ -15,6 +19,7 @@ class PromptType(enum.Enum):
     LINE = "line"
     HIDDEN = "hidden"
     MULTILINE = "multiline"
+    MULTILINE_HIDDEN = "multiline-hidden"
 
 
 @dataclass
@@ -36,6 +41,63 @@ class Prompt:
         )
 
 
+def get_multiline_hidden_input() -> str:
+    """
+    Get multiline input from the user without echoing the input.
+    This function allows the user to enter multiple lines of text,
+    and it will return the concatenated string of all lines entered.
+    The user can finish the input by pressing Ctrl-D (EOF).
+    """
+
+    # Save terminal settings
+    fd = sys.stdin.fileno()
+    old_settings = termios.tcgetattr(fd)
+
+    lines = []
+    current_line: list[str] = []
+
+    try:
+        # Change terminal settings - disable echo
+        tty.setraw(fd)
+
+        while True:
+            char = sys.stdin.read(1)
+
+            # Check for Ctrl-D (ASCII value 4 or EOF)
+            if not char or ord(char) == 4:
+                # Add last line if not empty
+                if current_line:
+                    lines.append("".join(current_line))
+                break
+
+            # Check for Ctrl-C (KeyboardInterrupt)
+            if ord(char) == 3:
+                raise KeyboardInterrupt
+
+            # Handle Enter key
+            if char == "\r" or char == "\n":
+                lines.append("".join(current_line))
+                current_line = []
+                # Print newline for visual feedback
+                sys.stdout.write("\r\n")
+                sys.stdout.flush()
+            # Handle backspace
+            elif ord(char) == 127 or ord(char) == 8:
+                if current_line:
+                    current_line.pop()
+            # Regular character
+            else:
+                current_line.append(char)
+
+    finally:
+        # Restore terminal settings
+        termios.tcsetattr(fd, termios.TCSADRAIN, old_settings)
+        # Print a final newline for clean display
+        print()
+
+    return "\n".join(lines)
+
+
 def ask(
     ident: str,
     input_type: PromptType,
@@ -47,14 +109,23 @@ def ask(
     log.info(f"Prompting value for {ident}")
     if MOCK_PROMPT_RESPONSE:
         return next(MOCK_PROMPT_RESPONSE)
-    match input_type:
+    try:
-        case PromptType.LINE:
+        match input_type:
-            result = input(f"{text}: ")
+            case PromptType.LINE:
-        case PromptType.MULTILINE:
+                result = input(f"{text}: ")
-            print(f"{text} (Finish with Ctrl-D): ")
+            case PromptType.MULTILINE:
-            result = sys.stdin.read()
+                print(f"{text} (Finish with Ctrl-D): ")
-        case PromptType.HIDDEN:
+                result = sys.stdin.read()
-            result = getpass(f"{text} (hidden): ")
+            case PromptType.MULTILINE_HIDDEN:
+                print(
+                    "Enter multiple lines (press Ctrl-D to finish or Ctrl-C to cancel):"
+                )
+                result = get_multiline_hidden_input()
+            case PromptType.HIDDEN:
+                result = getpass(f"{text} (hidden): ")
+    except KeyboardInterrupt as e:
+        msg = "User cancelled the input."
+        raise ClanError(msg) from e
 
     log.info("Input received. Processing...")
     return result

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

@@ -141,7 +141,7 @@ class SecretStore(StoreBase):
         hashes.sort()
 
         manifest = []
-        for generator in self.machine.vars_generators:
+        for generator in self.machine.vars_generators():
             for file in generator.files:
                 manifest.append(f"{generator.name}/{file.name}".encode())
         manifest += hashes
@@ -165,11 +165,12 @@ class SecretStore(StoreBase):
         return local_hash.decode() != remote_hash
 
     def populate_dir(self, output_dir: Path, phases: list[str]) -> None:
+        vars_generators = self.machine.vars_generators()
         if "users" in phases:
             with tarfile.open(
                 output_dir / "secrets_for_users.tar.gz", "w:gz"
             ) as user_tar:
-                for generator in self.machine.vars_generators:
+                for generator in vars_generators:
                     dir_exists = False
                     for file in generator.files:
                         if not file.deploy:
@@ -184,7 +185,7 @@ class SecretStore(StoreBase):
 
         if "services" in phases:
             with tarfile.open(output_dir / "secrets.tar.gz", "w:gz") as tar:
-                for generator in self.machine.vars_generators:
+                for generator in vars_generators:
                     dir_exists = False
                     for file in generator.files:
                         if not file.deploy:
@@ -205,7 +206,7 @@ class SecretStore(StoreBase):
                         tar_file.gname = file.group
                         tar.addfile(tarinfo=tar_file, fileobj=io.BytesIO(content))
         if "activation" in phases:
-            for generator in self.machine.vars_generators:
+            for generator in vars_generators:
                 for file in generator.files:
                     if file.needed_for == "activation":
                         out_file = (
@@ -214,7 +215,7 @@ class SecretStore(StoreBase):
                         out_file.parent.mkdir(parents=True, exist_ok=True)
                         out_file.write_bytes(self.get(generator, file.name))
         if "partitioning" in phases:
-            for generator in self.machine.vars_generators:
+            for generator in vars_generators:
                 for file in generator.files:
                     if file.needed_for == "partitioning":
                         out_file = (

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

@@ -51,10 +51,11 @@ class SecretStore(StoreBase):
         self.machine = machine
 
         # no need to generate keys if we don't manage secrets
-        if not self.machine.vars_generators:
+        vars_generators = self.machine.vars_generators()
+        if not vars_generators:
             return
         has_secrets = False
-        for generator in self.machine.vars_generators:
+        for generator in vars_generators:
             for file in generator.files:
                 if file.secret:
                     has_secrets = True
@@ -108,7 +109,7 @@ class SecretStore(StoreBase):
         """
 
         if generator is None:
-            generators = self.machine.vars_generators
+            generators = self.machine.vars_generators()
         else:
             generators = [generator]
         file_found = False
@@ -179,6 +180,7 @@ class SecretStore(StoreBase):
         return [store_folder]
 
     def populate_dir(self, output_dir: Path, phases: list[str]) -> None:
+        vars_generators = self.machine.vars_generators()
         if "users" in phases or "services" in phases:
             key_name = f"{self.machine.name}-age.key"
             if not has_secret(sops_secrets_folder(self.machine.flake_dir) / key_name):
@@ -192,7 +194,7 @@ class SecretStore(StoreBase):
             (output_dir / "key.txt").write_text(key)
 
         if "activation" in phases:
-            for generator in self.machine.vars_generators:
+            for generator in vars_generators:
                 for file in generator.files:
                     if file.needed_for == "activation":
                         target_path = (
@@ -208,7 +210,7 @@ class SecretStore(StoreBase):
                         target_path.chmod(file.mode)
 
         if "partitioning" in phases:
-            for generator in self.machine.vars_generators:
+            for generator in vars_generators:
                 for file in generator.files:
                     if file.needed_for == "partitioning":
                         target_path = output_dir / generator.name / file.name
@@ -284,7 +286,7 @@ class SecretStore(StoreBase):
         from clan_cli.secrets.secrets import update_keys
 
         if generator is None:
-            generators = self.machine.vars_generators
+            generators = self.machine.vars_generators()
         else:
             generators = [generator]
         file_found = False

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

@@ -33,19 +33,19 @@ def set_var(machine: str | Machine, var: str | Var, value: bytes, flake: Flake)
         )
 
 
-def set_via_stdin(machine: str, var_id: str, flake: Flake) -> None:
+def set_via_stdin(machine_name: str, var_id: str, flake: Flake) -> None:
-    var = get_var(str(flake.path), machine, var_id)
+    machine = Machine(name=machine_name, flake=flake)
+    var = get_var(str(flake.path), machine_name, var_id)
     if sys.stdin.isatty():
         new_value = ask(
             var.id,
-            PromptType.HIDDEN,
+            PromptType.MULTILINE_HIDDEN,
             None,
         ).encode("utf-8")
     else:
         new_value = sys.stdin.buffer.read()
 
-    _machine = Machine(name=machine, flake=flake)
+    set_var(machine, var, new_value, flake)
-    set_var(_machine, var, new_value, flake)
 
 
 def _set_command(args: argparse.Namespace) -> None:

pkgs/webview-ui/app/src/routes/machines/install/vars-step.tsx

@@ -1,9 +1,9 @@
 import { callApi } from "@/src/api";
 import {
   createForm,
+  FieldValues,
   SubmitHandler,
   validate,
-  FieldValues,
 } from "@modular-forms/solid";
 import { createQuery, useQueryClient } from "@tanstack/solid-query";
 import { Typography } from "@/src/components/Typography";
@@ -113,21 +113,43 @@ export const VarsStep = (props: VarsStepProps) => {
                             </Typography>
                             {/* Avoid nesting issue in case of a "." */}
                             <Field
-                              name={`${generator.name.replaceAll(".", "__dot__")}.${prompt.name.replaceAll(".", "__dot__")}`}
+                              name={`${generator.name.replaceAll(
+                                ".",
+                                "__dot__",
+                              )}.${prompt.name.replaceAll(".", "__dot__")}`}
                             >
                               {(field, props) => (
-                                <TextInput
+                                <Switch
-                                  inputProps={{
+                                  fallback={
-                                    ...props,
+                                    <TextInput
-                                    type:
+                                      inputProps={{
-                                      prompt.prompt_type === "hidden"
+                                        ...props,
-                                        ? "password"
+                                        type:
-                                        : "text",
+                                          prompt.prompt_type === "hidden"
-                                  }}
+                                            ? "password"
-                                  label={prompt.description}
+                                            : "text",
-                                  value={prompt.previous_value ?? ""}
+                                      }}
-                                  error={field.error}
+                                      label={prompt.description}
-                                />
+                                      value={prompt.previous_value ?? ""}
+                                      error={field.error}
+                                    />
+                                  }
+                                >
+                                  <Match
+                                    when={
+                                      prompt.prompt_type === "multiline" ||
+                                      prompt.prompt_type === "multiline-hidden"
+                                    }
+                                  >
+                                    <textarea
+                                      {...props}
+                                      class="w-full h-32 border border-gray-300 rounded-md p-2"
+                                      placeholder={prompt.description}
+                                      value={prompt.previous_value ?? ""}
+                                      name={prompt.description}
+                                    />
+                                  </Match>
+                                </Switch>
                               )}
                             </Field>
                           </Group>