yadunut/clan-core
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request 'clan-cli: Expose private_key to Machine class, in the future we should merge Machine and Host class' (#3407) from Qubasa/clan-core:vpb-patches2 into main

Browse Source 
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/3407
This commit is contained in:
Luis Hebendanz
2025-04-25 12:26:00 +00:00
parent e78bd89426 130a5bc593
commit 7b6483bfad
6 changed files with 46 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
pkgs/clan-cli/clan_cli/machines/machines.py
View File

@@ -32,6 +32,7 @@ class Machine:
cached_deployment: None | dict[str, Any] = None
override_target_host: None | str = None
override_build_host: None | str = None
private_key: Path | None = None
host_key_check: HostKeyCheck = HostKeyCheck.STRICT
def get_id(self) -> str:
@@ -150,6 +151,7 @@ class Machine:
self.name,
self.target_host_address,
self.host_key_check,
private_key=self.private_key,
meta={"machine": self},
)
@@ -168,6 +170,7 @@ class Machine:
build_host,
self.host_key_check,
forward_agent=True,
private_key=self.private_key,
meta={"machine": self, "target_host": self.target_host},
)

13
pkgs/clan-cli/clan_cli/ssh/host.py
View File

@@ -6,6 +6,7 @@ import shlex
import socket
import subprocess
from dataclasses import dataclass, field
from pathlib import Path
from shlex import quote
from typing import Any
@@ -27,7 +28,7 @@ class Host:
host: str
user: str | None = None
port: int | None = None
key: str | None = None
private_key: Path | None = None
forward_agent: bool = False
command_prefix: str | None = None
host_key_check: HostKeyCheck = HostKeyCheck.ASK
@@ -54,7 +55,7 @@ class Host:
host=host.host,
user=host.user,
port=host.port,
key=host.key,
private_key=host.private_key,
forward_agent=host.forward_agent,
command_prefix=host.command_prefix,
host_key_check=host.host_key_check,
@@ -176,6 +177,9 @@ class Host:
ssh_opts.extend(self.host_key_check.to_ssh_opt())
if self.private_key:
ssh_opts.extend(["-i", str(self.private_key)])
return ssh_opts
def ssh_cmd(
@@ -201,11 +205,6 @@ class Host:
if tty:
ssh_opts.extend(["-t"])
if self.port:
ssh_opts.extend(["-p", str(self.port)])
if self.key:
ssh_opts.extend(["-i", self.key])
if tor_socks:
packages.append("netcat")
ssh_opts.append("-o")

3
pkgs/clan-cli/clan_cli/ssh/parse.py
View File

@@ -1,5 +1,6 @@
import re
import urllib.parse
from pathlib import Path
from typing import Any
from clan_cli.errors import ClanError
@@ -13,6 +14,7 @@ def parse_deployment_address(
host_key_check: HostKeyCheck,
forward_agent: bool = True,
meta: dict[str, Any] | None = None,
private_key: Path | None = None,
) -> Host:
parts = host.split("?", maxsplit=1)
endpoint, maybe_options = parts if len(parts) == 2 else (parts[0], "")
@@ -58,6 +60,7 @@ def parse_deployment_address(
hostname,
user=user,
port=port,
private_key=private_key,
host_key_check=host_key_check,
command_prefix=machine_name,
forward_agent=forward_agent,

35
pkgs/clan-cli/clan_cli/ssh/upload.py
View File

@@ -18,10 +18,37 @@ def upload(
dir_mode: int = 0o700,
file_mode: int = 0o400,
) -> None:
# Check if the remote destination is at least 3 directories deep
if len(remote_dest.parts) < 3:
msg = f"The remote destination must be at least 3 directories deep. Got: {remote_dest}. Reason: The directory will be deleted with 'rm -rf'."
raise ClanError(msg)
# Check the depth of the remote destination path to prevent accidental deletion
# of important directories like /home/user when uploading a directory,
# as the process involves `rm -rf` on the destination.
if local_src.is_dir():
# Calculate the depth (number of components after the root '/')
# / -> depth 0
# /a -> depth 1
# /a/b -> depth 2
# /a/b/c -> depth 3
depth = len(remote_dest.parts) - 1
# General rule: destination must be at least 3 levels deep for safety.
is_too_shallow = depth < 3
# Exceptions: Allow depth 2 if the path starts with /tmp/, /root/, or /etc/.
# This allows destinations like /tmp/mydir or /etc/conf.d, but not /tmp or /etc directly.
is_allowed_exception = depth >= 2 and (
str(remote_dest).startswith("/tmp/")
or str(remote_dest).startswith("/root/")
or str(remote_dest).startswith("/etc/")
)
# Raise error if the path is too shallow and not an allowed exception.
if is_too_shallow and not is_allowed_exception:
msg = (
f"When uploading a directory, the remote destination '{remote_dest}' is considered unsafe "
f"(depth {depth}). It must be at least 3 levels deep (e.g., /path/to/dir), "
f"or at least 2 levels deep starting with /tmp/, /root/, or /etc/ (e.g., /tmp/mydir). "
f"Reason: The existing destination '{remote_dest}' will be recursively deleted ('rm -rf') before upload."
)
raise ClanError(msg)
# Create the tarball from the temporary directory
with TemporaryDirectory(prefix="facts-upload-") as tardir:

3
pkgs/clan-cli/clan_cli/tests/hosts.py
View File

@@ -1,5 +1,6 @@
import os
import pwd
from pathlib import Path
import pytest
from clan_cli.ssh.host import Host
@@ -15,7 +16,7 @@ def hosts(sshd: Sshd) -> list[Host]:
"127.0.0.1",
port=sshd.port,
user=login,
key=sshd.key,
private_key=Path(sshd.key),
host_key_check=HostKeyCheck.NONE,
)
]

2
pkgs/clan-cli/clan_cli/tests/test_secrets_upload.py
View File

@@ -40,7 +40,7 @@ def test_secrets_upload(
config = flake.machines["vm1"]
config["nixpkgs"]["hostPlatform"] = "x86_64-linux"
host = hosts[0]
addr = f"{host.user}@{host.host}:{host.port}?StrictHostKeyChecking=no&UserKnownHostsFile=/dev/null&IdentityFile={host.key}"
addr = f"{host.user}@{host.host}:{host.port}?StrictHostKeyChecking=no&UserKnownHostsFile=/dev/null&IdentityFile={host.private_key}"
config["clan"]["networking"]["targetHost"] = addr
config["clan"]["core"]["facts"]["secretUploadDirectory"] = str(flake.path / "facts")
flake.refresh()