You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
virt/engine/tests/test_cloud_init.py

257 lines
9.5 KiB
Python

"""Cloud-init public networking and NoCloud seed behavior."""
from __future__ import annotations
import importlib.util
import json
import uuid
import pytest
from virsh_panel.cloud_init import (
ROOT_PASSWORD_ALPHABET, ROOT_PASSWORD_DIGITS, ROOT_PASSWORD_LENGTH,
ROOT_PASSWORD_LOWERCASE, ROOT_PASSWORD_SYMBOLS, ROOT_PASSWORD_UPPERCASE,
build_seed_iso, generate_root_password, hash_root_password,
read_seed_network, validate_cloud_network,
)
PUBLIC_KEY = (
"ssh-ed25519 "
"AAAAC3NzaC1lZDI1NTE5AAAAIF7mFh4aYz3lRzNqjoFQasAQLpm7BdSULhe1iWuvj3y5 "
"panel-test"
)
GUEST_PASSWORD = "A-strong-guest-password-2026"
def _user_data(seed: bytes) -> dict:
"""Read the single-line JSON cloud-config embedded in the generated ISO."""
prefix = b"#cloud-config\n"
start = seed.index(prefix) + len(prefix)
return json.loads(seed[start:seed.index(b"\n", start)])
@pytest.mark.parametrize(
("address", "gateway"),
[
("8.8.8.18/24", "8.8.8.1"),
("8.8.8.18/28", "8.8.8.17"),
("123.123.123.114/24", "123.123.123.113"),
],
)
def test_public_network_accepts_24_and_28(address, gateway):
validated = validate_cloud_network(
address, gateway, ["1.1.1.1", "8.8.8.8"], PUBLIC_KEY,
)
assert validated == {
"public_ip_cidr": address,
"gateway": gateway,
"dns_servers": ["1.1.1.1", "8.8.8.8"],
"guest_ssh_public_key": PUBLIC_KEY,
}
def test_cloud_login_accepts_key_and_root_password_together():
network = ("8.8.8.18/24", "8.8.8.1", ["1.1.1.1"])
password_hash = hash_root_password(GUEST_PASSWORD)
assert password_hash.startswith("$6$")
assert GUEST_PASSWORD not in password_hash
assert hash_root_password(GUEST_PASSWORD) != password_hash
validated = validate_cloud_network(
*network, "", root_password_hash=password_hash,
)
assert validated["root_password_hash"] == password_hash
assert not validated["guest_ssh_public_key"]
together = validate_cloud_network(
*network, PUBLIC_KEY, root_password_hash=password_hash,
)
assert together["guest_ssh_public_key"] == PUBLIC_KEY
assert together["root_password_hash"] == password_hash
with pytest.raises(ValueError):
validate_cloud_network(*network, "", root_password_hash=None)
with pytest.raises(ValueError):
validate_cloud_network(*network, "", root_password_hash=GUEST_PASSWORD)
@pytest.mark.parametrize("invalid", [
"Short1!", "alllowercase12!", "ALLUPPERCASE12!", "NoSymbolPassword12",
"NoDigitsLong!Aa", "A-lowercase password12!", "A-lowercase\npassword12!",
"A-lowercase-password-1" + "x" * 110, "ValidAscii1!含中文",
])
def test_manual_root_password_requires_ascii_and_all_character_classes(invalid):
with pytest.raises(ValueError, match="初始 root 密码"):
hash_root_password(invalid)
def test_generated_root_password_always_meets_policy():
assert ROOT_PASSWORD_ALPHABET == (
"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
"0123456789!@#$%*-_=+?"
)
samples = set()
for _ in range(50):
password = generate_root_password()
samples.add(password)
assert len(password) == ROOT_PASSWORD_LENGTH
assert set(password) <= set(ROOT_PASSWORD_ALPHABET)
assert any(char in ROOT_PASSWORD_UPPERCASE for char in password)
assert any(char in ROOT_PASSWORD_LOWERCASE for char in password)
assert any(char in ROOT_PASSWORD_DIGITS for char in password)
assert any(char in ROOT_PASSWORD_SYMBOLS for char in password)
assert len(samples) == 50
assert len({password[:4] for password in samples}) > 1
assert hash_root_password(password).startswith("$6$")
def test_generated_root_password_rejects_whole_noncompliant_candidate(monkeypatch):
# First candidate is 32 uppercase A characters and must be discarded.
# The second one is a known compliant candidate with no post-processing.
indexes = iter([0] * 32 + [0, 26, 52, 62] * 8)
bounds = []
def deterministic_randbelow(bound):
bounds.append(bound)
return next(indexes)
monkeypatch.setattr("virsh_panel.cloud_init.secrets.randbelow",
deterministic_randbelow)
assert generate_root_password() == "Aa0!" * 8
assert bounds == [len(ROOT_PASSWORD_ALPHABET)] * 64
@pytest.mark.parametrize(
("address", "gateway"),
[
("192.168.1.18/24", "192.168.1.1"),
("10.0.0.18/24", "10.0.0.1"),
("172.16.0.18/24", "172.16.0.1"),
("127.0.0.18/24", "127.0.0.1"),
("169.254.0.18/24", "169.254.0.1"),
("224.0.0.18/24", "224.0.0.1"),
("2001:4860:4860::8888/64", "2001:4860:4860::1"),
("8.8.8.0/24", "8.8.8.1"),
("8.8.8.255/24", "8.8.8.1"),
("8.8.8.18/28", "8.8.8.1"),
("8.8.8.18", "8.8.8.1"),
],
)
def test_public_network_rejects_nonpublic_or_unroutable_pairs(address, gateway):
with pytest.raises(ValueError):
validate_cloud_network(address, gateway, ["1.1.1.1"], PUBLIC_KEY)
@pytest.mark.parametrize(
("dns", "key"),
[
(["not-an-ip"], PUBLIC_KEY),
(["192.168.1.1"], PUBLIC_KEY),
([], PUBLIC_KEY),
(["1.1.1.1"], "not-an-ssh-key"),
(["1.1.1.1"], PUBLIC_KEY + "\nruncmd: [evil]"),
],
)
def test_public_network_rejects_bad_dns_and_ssh_key(dns, key):
with pytest.raises(ValueError):
validate_cloud_network("8.8.8.18/24", "8.8.8.1", dns, key)
@pytest.mark.skipif(importlib.util.find_spec("pycdlib") is None,
reason="pycdlib is not installed")
def test_seed_iso_has_nocloud_files_and_mac_specific_static_network():
vm_uuid = str(uuid.uuid4())
mac = "52:54:00:12:34:56"
validated = validate_cloud_network(
"8.8.8.18/28", "8.8.8.17", ["1.1.1.1"], PUBLIC_KEY,
)
seed = build_seed_iso(vm_uuid, "cloud-vm", mac, validated)
assert isinstance(seed, bytes)
assert seed[32769:32774] == b"CD001" # ISO-9660 primary volume descriptor
assert b"CIDATA" in seed
for marker in (
b"user-data", b"meta-data", b"network-config", b"8.8.8.18/28",
b"8.8.8.17", b"1.1.1.1", mac.encode(), PUBLIC_KEY.encode(),
):
assert marker in seed
assert b'"routes": [{"to": "0.0.0.0/0", "via": "8.8.8.17"}]' in seed
assert b'"to": "default"' not in seed
user_data = _user_data(seed)
assert user_data["disable_root"] is False
assert user_data["ssh_pwauth"] is False
assert user_data["users"][0]["name"] == "root"
assert user_data["users"][0]["ssh_authorized_keys"] == [PUBLIC_KEY]
assert "hashed_passwd" not in user_data["users"][0]
assert "passwd" not in user_data["users"][0]
sshd_dropin = user_data["write_files"][0]
assert sshd_dropin["path"] == "/etc/ssh/sshd_config.d/00-virsh-panel-root.conf"
assert "PermitRootLogin prohibit-password" in sshd_dropin["content"]
assert "PasswordAuthentication no" in sshd_dropin["content"]
assert b"almalinux" not in seed
assert read_seed_network(seed) == {
"public_ip_cidr": "8.8.8.18/28",
"gateway": "8.8.8.17",
"dns_servers": ["1.1.1.1"],
"mac": mac,
}
@pytest.mark.skipif(importlib.util.find_spec("pycdlib") is None,
reason="pycdlib is not installed")
def test_read_seed_network_rejects_invalid_iso_without_exposing_credentials():
with pytest.raises(ValueError):
read_seed_network(b"not an ISO")
with pytest.raises(ValueError):
read_seed_network(b"x" * (1024 * 1024 + 1))
@pytest.mark.skipif(importlib.util.find_spec("pycdlib") is None,
reason="pycdlib is not installed")
def test_password_seed_sets_root_hash_and_enables_ssh_password_login():
password_hash = hash_root_password(GUEST_PASSWORD)
validated = validate_cloud_network(
"8.8.8.18/28", "8.8.8.17", ["1.1.1.1"], "",
root_password_hash=password_hash,
)
seed = build_seed_iso(
str(uuid.uuid4()), "password-vm", "52:54:00:12:34:56", validated,
)
user_data = _user_data(seed)
assert user_data["disable_root"] is False
assert user_data["ssh_pwauth"] is True
assert user_data["users"][0]["name"] == "root"
assert user_data["users"][0]["lock_passwd"] is False
assert user_data["users"][0]["hashed_passwd"] == password_hash
assert "ssh_authorized_keys" not in user_data["users"][0]
sshd_dropin = user_data["write_files"][0]
assert sshd_dropin["path"] == "/etc/ssh/sshd_config.d/00-virsh-panel-root.conf"
assert "PermitRootLogin yes" in sshd_dropin["content"]
assert "PasswordAuthentication yes" in sshd_dropin["content"]
assert GUEST_PASSWORD.encode() not in seed
@pytest.mark.skipif(importlib.util.find_spec("pycdlib") is None,
reason="pycdlib is not installed")
def test_seed_allows_root_password_and_ssh_key_together():
password_hash = hash_root_password(GUEST_PASSWORD)
validated = validate_cloud_network(
"8.8.8.18/28", "8.8.8.17", ["1.1.1.1"], PUBLIC_KEY,
root_password_hash=password_hash,
)
seed = build_seed_iso(
str(uuid.uuid4()), "both-vm", "52:54:00:12:34:56", validated,
)
user_data = _user_data(seed)
root = user_data["users"][0]
assert root["name"] == "root"
assert root["lock_passwd"] is False
assert root["ssh_authorized_keys"] == [PUBLIC_KEY]
assert root["hashed_passwd"] == password_hash
assert user_data["ssh_pwauth"] is True
assert "PermitRootLogin yes" in user_data["write_files"][0]["content"]
assert "PasswordAuthentication yes" in user_data["write_files"][0]["content"]
assert GUEST_PASSWORD.encode() not in seed