refactor: introduce the SSH config converter

to docker-entrypoint.sh & README.md;

* properly parse the SSH configuration applies to multiple hosts
* cleanhouse
* more validation

Author: IceCodeNew

Dockerfile

@@ -9,6 +9,8 @@ FROM gcr.io/distroless/python3:latest
 COPY --link --chmod=0755 ./docker-entrypoint.sh /usr/local/bin/
 # toybox + bash(ash) + catatonit
 COPY --link --from=assets /usr/bin/             /usr/bin/
+
+COPY --link --chmod=0755 ./sshconfig_to_ananta/ /home/nonroot/sshconfig_to_ananta/
 COPY --link --from=build  /home/nonroot/.local/ /home/nonroot/.local/
 
 SHELL ["/usr/bin/bash", "-o", "pipefail", "-c"]

README.md

@@ -4,18 +4,32 @@
 docker pull icecodexi/ananta:latest
 mkdir -p "${HOME}/.ssh/"
 find "${HOME}/.ssh/" -type f -print0 | xargs -0 -r chmod 600
-touch "$(pwd)/hosts.csv"
 
+_extra_args=()
 if [[ "$UID" -eq '0' ]]; then
-    _run_as_root='--user root'
+    _extra_args+=('--user' 'root')
 fi
-docker run --rm --interactive --tty \
-    ${_run_as_root} \
-    --volume /etc/localtime:/etc/localtime:ro \
-    --volume "${HOME}/.ssh/:/home/nonroot/.ssh/:ro" \
-    --volume "$(pwd)/hosts.csv:/home/nonroot/hosts.csv:ro" \
-    --cpu-shares 512 --memory 512M --memory-swap 512M \
-    --security-opt no-new-privileges \
-    icecodexi/ananta:latest \
-        --help
+
+# Will automatic generate hosts.csv based on ~/.ssh/config if it does not exist
+_hosts_csv="$(pwd)/hosts.csv"
+if [[ -f "${_hosts_csv}" ]]; then
+    hosts_csv="${_hosts_csv}"
+    _extra_args+=('--volume' "${_hosts_csv}:/home/nonroot/hosts.csv:ro")
+fi
+
+export _extra_args hosts_csv
+# put this function definition in your ~/.bashrc
+ananta() {
+    docker run --rm --interactive --tty \
+        "${_extra_args[@]}" \
+        --volume /etc/localtime:/etc/localtime:ro \
+        --volume "${HOME}/.ssh/:/home/nonroot/.ssh/:ro" \
+        --cpu-shares 512 --memory 512M --memory-swap 512M \
+        --security-opt no-new-privileges \
+        icecodexi/ananta:latest "$hosts_csv" \
+            "$@"
+}
+
+## Example for issuing command `whoami` to multiple hosts
+ananta whoami
 ```

docker-entrypoint.sh

@@ -2,40 +2,48 @@
 set -e -o pipefail
 
 cd /home/nonroot/.ssh/ || exit 1
+ananta_args=()
+ssh_command=()
+hosts_file="/home/nonroot/_autogen_hosts.csv"
 
-args=()
 while [[ $# -gt 0 ]]; do
     case "$1" in
     -[kK]|--default-key)
         _DEFAULT_KEY="$2"
         # Modify the key path to be under /home/nonroot/.ssh/
         key_file=$(basename "$_DEFAULT_KEY")
         # Add the modified parameter
-        args+=("$1" "/home/nonroot/.ssh/$key_file")
+        ananta_args+=("$1" "/home/nonroot/.ssh/$key_file")
         shift 2
         ;;
     # Keep other parameters unchanged
     -[nNsSeEcCvV]|--no-color|--separate-output|--allow-empty-line|--allow-cursor-control|--version)
-        args+=("$1")
+        ananta_args+=("$1")
         shift
         ;;
     -[tTwW]|--host-tags|--terminal-width)
-        args+=("$1" "$2")
+        ananta_args+=("$1" "$2")
         shift 2
         ;;
-    [!-]*)
+    ''|[!-]*)
         _HOSTS_CSV="$1"
-        # Modify the hosts.csv path to be under /home/nonroot/
-        hosts_file=$(basename "$_HOSTS_CSV")
-        # Add the modified parameter
-        args+=("/home/nonroot/$hosts_file")
         shift
         # Stop processing remaining arguments
-        args+=("$@")
+        ssh_command=("$@")
         break
         ;;
     esac
 done
 
+if [[ -n "$_HOSTS_CSV" ]]; then
+    # Modify the hosts.csv path to be under /home/nonroot/
+    hosts_file="/home/nonroot/$(basename "$_HOSTS_CSV")"
+else
+    echo "INFO: Will try to generate one using the SSH config..."
+    python3 /home/nonroot/sshconfig_to_ananta/main.py \
+        --ssh /home/nonroot/.ssh/config \
+        "$hosts_file"
+fi
+
 # Run the ananta command with the modified arguments
-exec catatonit -- ananta "${args[@]}"
+exec catatonit -- ananta "${ananta_args[@]}" "$hosts_file" "${ssh_command[@]}"

sshconfig2ananta.py

@@ -0,0 +1,86 @@
+#!/usr/bin/env python3
+# pyright: strict
+
+from ipaddress import IPv4Address, IPv6Address, ip_address
+from pathlib import Path
+from typing import List
+
+
+class AnantaHost:
+    """Represents an Ananta host entry.
+
+    This class stores the configuration details for connecting to a host
+    via SSH, intended for use with the Ananta system.
+
+    The expected format for representing a host is a comma-separated string:
+    alias,ip,port,username,key_path[,tags]
+
+    Where:
+        - alias: A short name or identifier for the host.
+        - ip: The IP address or hostname of the host.
+        - port: The SSH port number (defaults to 22 if empty or omitted).
+        - username: The username for SSH login (defaults to 'root' if empty or omitted).
+        - key_path: The path to the SSH private key file. Use '#' if not applicable or managed elsewhere.
+        - tags (optional): Colon-separated tags for categorization (e.g., 'web', 'db', 'arch:web').
+
+    Examples:
+        - host-1,10.0.0.1,22,user,/home/user/.ssh/id_ed25519
+        - host-2,10.0.0.2,22,user,#,web
+        - host-3,10.0.0.3,22,user,#,arch:web
+        - host-4,10.0.0.4,22,user,#,ubuntu:db
+    """
+
+    alias: str
+    ip: IPv4Address | IPv6Address
+    port: int
+    username: str
+    key_path: str
+    tags: List[str]
+
+    def __init__(
+        self,
+        alias: str,
+        ip: str,
+        port: str,
+        username: str,
+        key_path: str,
+        tags: List[str],
+    ):
+        if not alias:
+            raise ValueError("ERROR: alias cannot be empty.")
+
+        try:
+            self.ip = ip_address(ip)
+        except ValueError as e:
+            raise ValueError(f"ERROR: Invalid IP address: {ip}") from e
+
+        try:
+            self.port = int(port) if str(port) else 22
+            if not (0 < self.port < 65536):
+                raise ValueError(f"ERROR: Port number {port} must be greater than 0 and less than 65536.")
+        except ValueError as e:
+            raise ValueError(f"ERROR: Invalid port number: {port}") from e
+
+        self.username = username if username else "root"
+
+        self.key_path = key_path if key_path else "#"
+        if not Path(key_path).is_file():
+            raise FileNotFoundError(f"ERROR: SSH Key {key_path} could not be found OR is not a regular file.")
+
+        self.tags = tags if tags else []
+
+    def to_string_with_feilds(self) -> str:
+        return (
+            f"  alias:    {self.alias}\n"
+            f"  ip:       {self.ip}\n"
+            f"  port:     {self.port}\n"
+            f"  username: {self.username}\n"
+            f"  key_path: {self.key_path}\n"
+            f"  tags:     {self.tags}\n"
+        )
+
+    def to_string(self) -> str:
+        parts = [self.alias, str(self.ip), str(self.port), self.username, self.key_path]
+        if self.tags:
+            parts.append(":".join(self.tags))
+        return ",".join(parts) + "\n"

sshconfig_to_ananta/ananta_host.py

@@ -0,0 +1,25 @@
+#!/usr/bin/env python3
+# pyright: strict
+
+import argparse
+from pathlib import Path
+from ssh_config_converter import convert_to_ananta_hosts
+
+def parse_arguments():
+    parser = argparse.ArgumentParser(description="Convert SSH config to Ananta hosts csv.")
+    parser.add_argument("--ssh", help="SSH config file.", default=Path.home() / ".ssh" / "config")
+    parser.add_argument("csvfile", help="Path the Ananta hosts file would be written to. (better set to a path that can safely overwrite)")
+    return parser.parse_args()
+
+
+if __name__ == "__main__":
+    args = parse_arguments()
+    ssh_path = Path(args.ssh)
+    csvfile = Path(args.csvfile)
+
+    if csvfile.is_dir() or csvfile.is_symlink():
+        raise IsADirectoryError(f"ERROR: {csvfile} is a directory OR a symlink. Script aborted to prevent data loss.")
+
+    ananta_hosts = convert_to_ananta_hosts(ssh_path)
+    with open(csvfile, "w", encoding="utf-8") as file:
+        file.writelines([host.to_string() for host in ananta_hosts])