--- /srv/reproducible-results/rbuild-debian/r-b-build.x9GZr1hx/b1/cockpit_317-5_i386.changes +++ /srv/reproducible-results/rbuild-debian/r-b-build.x9GZr1hx/b2/cockpit_317-5_i386.changes ├── Files │ @@ -1,10 +1,10 @@ │ │ 352b6c2bf1ab8bc205bbbfdaa55492c5 123108 debug optional cockpit-bridge-dbgsym_317-5_i386.deb │ - 87e95b4ecc1d947d4698231d6d2c1888 364900 admin optional cockpit-bridge_317-5_i386.deb │ + 075ba1340c280f6d5d7cc1bb13efe9f0 365312 admin optional cockpit-bridge_317-5_i386.deb │ 097ce2e1e6651b3f08664f587bcde805 132180 doc optional cockpit-doc_317-5_all.deb │ ff791dc6c8e35ddc5a35f713f218c3ac 831552 admin optional cockpit-networkmanager_317-5_all.deb │ e8b11b470e82c2e8cf7e80ccdc3b3717 944828 admin optional cockpit-packagekit_317-5_all.deb │ b46703922196dc34f9ce96ee02109c1b 560524 admin optional cockpit-sosreport_317-5_all.deb │ de8cd1c072255b3f5dc542a12907d143 886272 admin optional cockpit-storaged_317-5_all.deb │ fb7ce4b12f0352249b3660ea2ad3b016 3316080 admin optional cockpit-system_317-5_all.deb │ 6498af41f44439eab2d14a34728e74a0 4340 debug optional cockpit-tests-dbgsym_317-5_i386.deb ├── cockpit-bridge_317-5_i386.deb │ ├── file list │ │ @@ -1,3 +1,3 @@ │ │ -rw-r--r-- 0 0 0 4 2024-06-06 12:41:23.000000 debian-binary │ │ -rw-r--r-- 0 0 0 3880 2024-06-06 12:41:23.000000 control.tar.xz │ │ --rw-r--r-- 0 0 0 360828 2024-06-06 12:41:23.000000 data.tar.xz │ │ +-rw-r--r-- 0 0 0 361240 2024-06-06 12:41:23.000000 data.tar.xz │ ├── control.tar.xz │ │ ├── control.tar │ │ │ ├── ./control │ │ │ │ @@ -1,13 +1,13 @@ │ │ │ │ Package: cockpit-bridge │ │ │ │ Source: cockpit │ │ │ │ Version: 317-5 │ │ │ │ Architecture: i386 │ │ │ │ Maintainer: Utopia Maintenance Team │ │ │ │ -Installed-Size: 870 │ │ │ │ +Installed-Size: 871 │ │ │ │ Depends: libc6 (>= 2.38), libglib2.0-0t64 (>= 2.68.0), libjson-glib-1.0-0 (>= 1.5.2), libssh-4 (>= 0.10.4), libsystemd0 (>= 235), python3:any, glib-networking │ │ │ │ Recommends: openssh-client │ │ │ │ Breaks: cockpit-ws (<< 181.x) │ │ │ │ Replaces: cockpit-dashboard (<< 170.x), cockpit-ws (<< 181.x) │ │ │ │ Provides: cockpit-ssh │ │ │ │ Section: admin │ │ │ │ Priority: optional │ │ │ ├── ./md5sums │ │ │ │ ├── ./md5sums │ │ │ │ │┄ Files differ │ ├── data.tar.xz │ │ ├── data.tar │ │ │ ├── file list │ │ │ │ @@ -60,15 +60,15 @@ │ │ │ │ -rw-r--r-- 0 root (0) root (0) 6653 2024-06-06 12:41:23.000000 ./usr/lib/python3/dist-packages/cockpit/channels/metrics.py │ │ │ │ -rw-r--r-- 0 root (0) root (0) 4058 2024-06-06 12:41:23.000000 ./usr/lib/python3/dist-packages/cockpit/channels/packages.py │ │ │ │ -rw-r--r-- 0 root (0) root (0) 4872 2024-06-06 12:41:23.000000 ./usr/lib/python3/dist-packages/cockpit/channels/stream.py │ │ │ │ -rw-r--r-- 0 root (0) root (0) 1171 2024-06-06 12:41:23.000000 ./usr/lib/python3/dist-packages/cockpit/channels/trivial.py │ │ │ │ -rw-r--r-- 0 root (0) root (0) 3188 2024-06-06 12:41:23.000000 ./usr/lib/python3/dist-packages/cockpit/config.py │ │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2024-06-06 12:41:23.000000 ./usr/lib/python3/dist-packages/cockpit/data/ │ │ │ │ -rw-r--r-- 0 root (0) root (0) 574 2024-06-06 12:41:23.000000 ./usr/lib/python3/dist-packages/cockpit/data/__init__.py │ │ │ │ --rw-r--r-- 0 root (0) root (0) 86688 2024-06-06 12:41:23.000000 ./usr/lib/python3/dist-packages/cockpit/data/cockpit-bridge.beipack.xz │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 87104 2024-06-06 12:41:23.000000 ./usr/lib/python3/dist-packages/cockpit/data/cockpit-bridge.beipack.xz │ │ │ │ -rw-r--r-- 0 root (0) root (0) 3212 2024-06-06 12:41:23.000000 ./usr/lib/python3/dist-packages/cockpit/data/fail.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 5517 2024-06-06 12:41:23.000000 ./usr/lib/python3/dist-packages/cockpit/internal_endpoints.py │ │ │ │ -rw-r--r-- 0 root (0) root (0) 7242 2024-06-06 12:41:23.000000 ./usr/lib/python3/dist-packages/cockpit/jsonutil.py │ │ │ │ -rw-r--r-- 0 root (0) root (0) 21539 2024-06-06 12:41:23.000000 ./usr/lib/python3/dist-packages/cockpit/packages.py │ │ │ │ -rw-r--r-- 0 root (0) root (0) 12729 2024-06-06 12:41:23.000000 ./usr/lib/python3/dist-packages/cockpit/peer.py │ │ │ │ -rw-r--r-- 0 root (0) root (0) 7580 2024-06-06 12:41:23.000000 ./usr/lib/python3/dist-packages/cockpit/polkit.py │ │ │ │ -rw-r--r-- 0 root (0) root (0) 2031 2024-06-06 12:41:23.000000 ./usr/lib/python3/dist-packages/cockpit/polyfills.py │ │ │ ├── ./usr/lib/python3/dist-packages/cockpit/data/cockpit-bridge.beipack.xz │ │ │ │ ├── cockpit-bridge.beipack │ │ │ │ │┄ Ordering differences only │ │ │ │ │ @@ -64,105 +64,512 @@ │ │ │ │ │ ) -> Optional[importlib.machinery.ModuleSpec]: │ │ │ │ │ if fullname not in self.modules: │ │ │ │ │ return None │ │ │ │ │ return importlib.util.spec_from_loader(fullname, self) │ │ │ │ │ │ │ │ │ │ import sys │ │ │ │ │ sys.meta_path.insert(0, BeipackLoader({ │ │ │ │ │ - 'cockpit/config.py': br'''# This file is part of Cockpit. │ │ │ │ │ + 'cockpit/samples.py': br'''# This file is part of Cockpit. │ │ │ │ │ # │ │ │ │ │ -# Copyright (C) 2023 Red Hat, Inc. │ │ │ │ │ +# Copyright (C) 2022 Red Hat, Inc. │ │ │ │ │ # │ │ │ │ │ # This program is free software: you can redistribute it and/or modify │ │ │ │ │ # it under the terms of the GNU General Public License as published by │ │ │ │ │ # the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ # (at your option) any later version. │ │ │ │ │ # │ │ │ │ │ # This program is distributed in the hope that it will be useful, │ │ │ │ │ # but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ # GNU General Public License for more details. │ │ │ │ │ # │ │ │ │ │ # You should have received a copy of the GNU General Public License │ │ │ │ │ # along with this program. If not, see . │ │ │ │ │ │ │ │ │ │ -import configparser │ │ │ │ │ +import errno │ │ │ │ │ import logging │ │ │ │ │ import os │ │ │ │ │ -from pathlib import Path │ │ │ │ │ +import re │ │ │ │ │ +from typing import Any, DefaultDict, Iterable, List, NamedTuple, Optional, Tuple │ │ │ │ │ │ │ │ │ │ -from cockpit._vendor.systemd_ctypes import bus │ │ │ │ │ +from cockpit._vendor.systemd_ctypes import Handle │ │ │ │ │ + │ │ │ │ │ +USER_HZ = os.sysconf(os.sysconf_names['SC_CLK_TCK']) │ │ │ │ │ +MS_PER_JIFFY = 1000 / (USER_HZ if (USER_HZ > 0) else 100) │ │ │ │ │ +HWMON_PATH = '/sys/class/hwmon' │ │ │ │ │ + │ │ │ │ │ +# we would like to do this, but mypy complains; https://github.com/python/mypy/issues/2900 │ │ │ │ │ +# Samples = collections.defaultdict[str, Union[float, Dict[str, Union[float, None]]]] │ │ │ │ │ +Samples = DefaultDict[str, Any] │ │ │ │ │ │ │ │ │ │ logger = logging.getLogger(__name__) │ │ │ │ │ │ │ │ │ │ -XDG_CONFIG_HOME = Path(os.getenv('XDG_CONFIG_HOME') or os.path.expanduser('~/.config')) │ │ │ │ │ -DOT_CONFIG_COCKPIT = XDG_CONFIG_HOME / 'cockpit' │ │ │ │ │ │ │ │ │ │ +def read_int_file(rootfd: int, statfile: str, default: Optional[int] = None, key: bytes = b'') -> Optional[int]: │ │ │ │ │ + # Not every stat is available, such as cpu.weight │ │ │ │ │ + try: │ │ │ │ │ + fd = os.open(statfile, os.O_RDONLY, dir_fd=rootfd) │ │ │ │ │ + except FileNotFoundError: │ │ │ │ │ + return None │ │ │ │ │ │ │ │ │ │ -def lookup_config(filename: str) -> Path: │ │ │ │ │ - config_dirs = os.environ.get('XDG_CONFIG_DIRS', '/etc').split(':') │ │ │ │ │ - fallback = None │ │ │ │ │ - for config_dir in config_dirs: │ │ │ │ │ - config_path = Path(config_dir, 'cockpit', filename) │ │ │ │ │ - if not fallback: │ │ │ │ │ - fallback = config_path │ │ │ │ │ - if config_path.exists(): │ │ │ │ │ - logger.debug('lookup_config(%s): found %s', filename, config_path) │ │ │ │ │ - return config_path │ │ │ │ │ + try: │ │ │ │ │ + data = os.read(fd, 1024) │ │ │ │ │ + except OSError as e: │ │ │ │ │ + # cgroups can disappear between the open and read │ │ │ │ │ + if e.errno != errno.ENODEV: │ │ │ │ │ + logger.warning('Failed to read %s: %s', statfile, e) │ │ │ │ │ + return None │ │ │ │ │ + finally: │ │ │ │ │ + os.close(fd) │ │ │ │ │ │ │ │ │ │ - # default to the first entry in XDG_CONFIG_DIRS; that's not according to the spec, │ │ │ │ │ - # but what Cockpit has done for years │ │ │ │ │ - logger.debug('lookup_config(%s): defaulting to %s', filename, fallback) │ │ │ │ │ - assert fallback # mypy; config_dirs always has at least one string │ │ │ │ │ - return fallback │ │ │ │ │ + if key: │ │ │ │ │ + start = data.index(key) + len(key) │ │ │ │ │ + end = data.index(b'\n', start) │ │ │ │ │ + data = data[start:end] │ │ │ │ │ │ │ │ │ │ + try: │ │ │ │ │ + # 0 often means "none", so replace it with default value │ │ │ │ │ + return int(data) or default │ │ │ │ │ + except ValueError: │ │ │ │ │ + # Some samples such as "memory.max" contains "max" when there is a no limit │ │ │ │ │ + return None │ │ │ │ │ │ │ │ │ │ -class Config(bus.Object, interface='cockpit.Config'): │ │ │ │ │ - def __init__(self): │ │ │ │ │ - self.reload() │ │ │ │ │ │ │ │ │ │ - @bus.Interface.Method(out_types='s', in_types='ss') │ │ │ │ │ - def get_string(self, section, key): │ │ │ │ │ - try: │ │ │ │ │ - return self.config[section][key] │ │ │ │ │ - except KeyError as exc: │ │ │ │ │ - raise bus.BusError('cockpit.Config.KeyError', f'key {key} in section {section} does not exist') from exc │ │ │ │ │ +class SampleDescription(NamedTuple): │ │ │ │ │ + name: str │ │ │ │ │ + units: str │ │ │ │ │ + semantics: str │ │ │ │ │ + instanced: bool │ │ │ │ │ │ │ │ │ │ - @bus.Interface.Method(out_types='u', in_types='ssuuu') │ │ │ │ │ - def get_u_int(self, section, key, default, maximum, minimum): │ │ │ │ │ + │ │ │ │ │ +class Sampler: │ │ │ │ │ + descriptions: List[SampleDescription] │ │ │ │ │ + │ │ │ │ │ + def sample(self, samples: Samples) -> None: │ │ │ │ │ + raise NotImplementedError │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class CPUSampler(Sampler): │ │ │ │ │ + descriptions = [ │ │ │ │ │ + SampleDescription('cpu.basic.nice', 'millisec', 'counter', instanced=False), │ │ │ │ │ + SampleDescription('cpu.basic.user', 'millisec', 'counter', instanced=False), │ │ │ │ │ + SampleDescription('cpu.basic.system', 'millisec', 'counter', instanced=False), │ │ │ │ │ + SampleDescription('cpu.basic.iowait', 'millisec', 'counter', instanced=False), │ │ │ │ │ + │ │ │ │ │ + SampleDescription('cpu.core.nice', 'millisec', 'counter', instanced=True), │ │ │ │ │ + SampleDescription('cpu.core.user', 'millisec', 'counter', instanced=True), │ │ │ │ │ + SampleDescription('cpu.core.system', 'millisec', 'counter', instanced=True), │ │ │ │ │ + SampleDescription('cpu.core.iowait', 'millisec', 'counter', instanced=True), │ │ │ │ │ + ] │ │ │ │ │ + │ │ │ │ │ + def sample(self, samples: Samples) -> None: │ │ │ │ │ + with open('/proc/stat') as stat: │ │ │ │ │ + for line in stat: │ │ │ │ │ + if not line.startswith('cpu'): │ │ │ │ │ + continue │ │ │ │ │ + cpu, user, nice, system, _idle, iowait = line.split()[:6] │ │ │ │ │ + core = cpu[3:] or None │ │ │ │ │ + if core: │ │ │ │ │ + prefix = 'cpu.core' │ │ │ │ │ + samples[f'{prefix}.nice'][core] = int(nice) * MS_PER_JIFFY │ │ │ │ │ + samples[f'{prefix}.user'][core] = int(user) * MS_PER_JIFFY │ │ │ │ │ + samples[f'{prefix}.system'][core] = int(system) * MS_PER_JIFFY │ │ │ │ │ + samples[f'{prefix}.iowait'][core] = int(iowait) * MS_PER_JIFFY │ │ │ │ │ + else: │ │ │ │ │ + prefix = 'cpu.basic' │ │ │ │ │ + samples[f'{prefix}.nice'] = int(nice) * MS_PER_JIFFY │ │ │ │ │ + samples[f'{prefix}.user'] = int(user) * MS_PER_JIFFY │ │ │ │ │ + samples[f'{prefix}.system'] = int(system) * MS_PER_JIFFY │ │ │ │ │ + samples[f'{prefix}.iowait'] = int(iowait) * MS_PER_JIFFY │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class MemorySampler(Sampler): │ │ │ │ │ + descriptions = [ │ │ │ │ │ + SampleDescription('memory.free', 'bytes', 'instant', instanced=False), │ │ │ │ │ + SampleDescription('memory.used', 'bytes', 'instant', instanced=False), │ │ │ │ │ + SampleDescription('memory.cached', 'bytes', 'instant', instanced=False), │ │ │ │ │ + SampleDescription('memory.swap-used', 'bytes', 'instant', instanced=False), │ │ │ │ │ + ] │ │ │ │ │ + │ │ │ │ │ + def sample(self, samples: Samples) -> None: │ │ │ │ │ + with open('/proc/meminfo') as meminfo: │ │ │ │ │ + items = {k: int(v.strip(' kB\n')) for line in meminfo for k, v in [line.split(':', 1)]} │ │ │ │ │ + │ │ │ │ │ + samples['memory.free'] = 1024 * items['MemFree'] │ │ │ │ │ + samples['memory.used'] = 1024 * (items['MemTotal'] - items['MemAvailable']) │ │ │ │ │ + samples['memory.cached'] = 1024 * (items['Buffers'] + items['Cached']) │ │ │ │ │ + samples['memory.swap-used'] = 1024 * (items['SwapTotal'] - items['SwapFree']) │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class CPUTemperatureSampler(Sampler): │ │ │ │ │ + # Cache found sensors, as they can't be hotplugged. │ │ │ │ │ + sensors: Optional[List[str]] = None │ │ │ │ │ + │ │ │ │ │ + descriptions = [ │ │ │ │ │ + SampleDescription('cpu.temperature', 'celsius', 'instant', instanced=True), │ │ │ │ │ + ] │ │ │ │ │ + │ │ │ │ │ + @staticmethod │ │ │ │ │ + def detect_cpu_sensors(dir_fd: int) -> Iterable[str]: │ │ │ │ │ + # Read the name file to decide what to do with this directory │ │ │ │ │ try: │ │ │ │ │ - value = self.config[section][key] │ │ │ │ │ - except KeyError: │ │ │ │ │ - return default │ │ │ │ │ + with Handle.open('name', os.O_RDONLY, dir_fd=dir_fd) as fd: │ │ │ │ │ + name = os.read(fd, 1024).decode().strip() │ │ │ │ │ + except FileNotFoundError: │ │ │ │ │ + return │ │ │ │ │ + │ │ │ │ │ + if name == 'atk0110': │ │ │ │ │ + # only sample 'CPU Temperature' in atk0110 │ │ │ │ │ + predicate = (lambda label: label == 'CPU Temperature') │ │ │ │ │ + elif name == 'cpu_thermal': │ │ │ │ │ + # labels are not used on ARM │ │ │ │ │ + predicate = None │ │ │ │ │ + elif name == 'coretemp': │ │ │ │ │ + # accept all labels on Intel │ │ │ │ │ + predicate = None │ │ │ │ │ + elif name in ['k8temp', 'k10temp']: │ │ │ │ │ + predicate = None │ │ │ │ │ + else: │ │ │ │ │ + # Not a CPU sensor │ │ │ │ │ + return │ │ │ │ │ + │ │ │ │ │ + # Now scan the directory for inputs │ │ │ │ │ + for input_filename in os.listdir(dir_fd): │ │ │ │ │ + if not input_filename.endswith('_input'): │ │ │ │ │ + continue │ │ │ │ │ + │ │ │ │ │ + if predicate: │ │ │ │ │ + # We need to check the label │ │ │ │ │ + try: │ │ │ │ │ + label_filename = input_filename.replace('_input', '_label') │ │ │ │ │ + with Handle.open(label_filename, os.O_RDONLY, dir_fd=dir_fd) as fd: │ │ │ │ │ + label = os.read(fd, 1024).decode().strip() │ │ │ │ │ + except FileNotFoundError: │ │ │ │ │ + continue │ │ │ │ │ │ │ │ │ │ + if not predicate(label): │ │ │ │ │ + continue │ │ │ │ │ + │ │ │ │ │ + yield input_filename │ │ │ │ │ + │ │ │ │ │ + @staticmethod │ │ │ │ │ + def scan_sensors() -> Iterable[str]: │ │ │ │ │ try: │ │ │ │ │ - int_val = int(value) │ │ │ │ │ - except ValueError: │ │ │ │ │ - logger.warning('cockpit.conf: [%s] %s is not an integer', section, key) │ │ │ │ │ - return default │ │ │ │ │ + top_fd = Handle.open(HWMON_PATH, os.O_RDONLY | os.O_DIRECTORY) │ │ │ │ │ + except FileNotFoundError: │ │ │ │ │ + return │ │ │ │ │ │ │ │ │ │ - return min(max(int_val, minimum), maximum) │ │ │ │ │ + with top_fd: │ │ │ │ │ + for hwmon_name in os.listdir(top_fd): │ │ │ │ │ + with Handle.open(hwmon_name, os.O_RDONLY | os.O_DIRECTORY, dir_fd=top_fd) as subdir_fd: │ │ │ │ │ + for sensor in CPUTemperatureSampler.detect_cpu_sensors(subdir_fd): │ │ │ │ │ + yield f'{HWMON_PATH}/{hwmon_name}/{sensor}' │ │ │ │ │ │ │ │ │ │ - @bus.Interface.Method() │ │ │ │ │ - def reload(self): │ │ │ │ │ - self.config = configparser.ConfigParser(interpolation=None) │ │ │ │ │ - cockpit_conf = lookup_config('cockpit.conf') │ │ │ │ │ - logger.debug("cockpit.Config: loading %s", cockpit_conf) │ │ │ │ │ - # this may not exist, but it's ok to not have a config file and thus leave self.config empty │ │ │ │ │ - self.config.read(cockpit_conf) │ │ │ │ │ + def sample(self, samples: Samples) -> None: │ │ │ │ │ + if self.sensors is None: │ │ │ │ │ + self.sensors = list(CPUTemperatureSampler.scan_sensors()) │ │ │ │ │ │ │ │ │ │ + for sensor_path in self.sensors: │ │ │ │ │ + with open(sensor_path) as sensor: │ │ │ │ │ + temperature = int(sensor.read().strip()) │ │ │ │ │ + if temperature == 0: │ │ │ │ │ + return │ │ │ │ │ │ │ │ │ │ -class Environment(bus.Object, interface='cockpit.Environment'): │ │ │ │ │ - variables = bus.Interface.Property('a{ss}') │ │ │ │ │ + samples['cpu.temperature'][sensor_path] = temperature / 1000 │ │ │ │ │ │ │ │ │ │ - @variables.getter │ │ │ │ │ - def get_variables(self): │ │ │ │ │ - return os.environ.copy() │ │ │ │ │ + │ │ │ │ │ +class DiskSampler(Sampler): │ │ │ │ │ + descriptions = [ │ │ │ │ │ + SampleDescription('disk.all.read', 'bytes', 'counter', instanced=False), │ │ │ │ │ + SampleDescription('disk.all.written', 'bytes', 'counter', instanced=False), │ │ │ │ │ + SampleDescription('disk.dev.read', 'bytes', 'counter', instanced=True), │ │ │ │ │ + SampleDescription('disk.dev.written', 'bytes', 'counter', instanced=True), │ │ │ │ │ + ] │ │ │ │ │ + │ │ │ │ │ + def sample(self, samples: Samples) -> None: │ │ │ │ │ + with open('/proc/diskstats') as diskstats: │ │ │ │ │ + all_read_bytes = 0 │ │ │ │ │ + all_written_bytes = 0 │ │ │ │ │ + │ │ │ │ │ + for line in diskstats: │ │ │ │ │ + # https://www.kernel.org/doc/Documentation/ABI/testing/procfs-diskstats │ │ │ │ │ + fields = line.strip().split() │ │ │ │ │ + dev_major = fields[0] │ │ │ │ │ + dev_name = fields[2] │ │ │ │ │ + num_sectors_read = fields[5] │ │ │ │ │ + num_sectors_written = fields[9] │ │ │ │ │ + │ │ │ │ │ + # ignore mdraid │ │ │ │ │ + if dev_major == '9': │ │ │ │ │ + continue │ │ │ │ │ + │ │ │ │ │ + # ignore device-mapper │ │ │ │ │ + if dev_name.startswith('dm-'): │ │ │ │ │ + continue │ │ │ │ │ + │ │ │ │ │ + # Skip partitions │ │ │ │ │ + if dev_name[:2] in ['sd', 'hd', 'vd'] and dev_name[-1].isdigit(): │ │ │ │ │ + continue │ │ │ │ │ + │ │ │ │ │ + # Ignore nvme partitions │ │ │ │ │ + if dev_name.startswith('nvme') and 'p' in dev_name: │ │ │ │ │ + continue │ │ │ │ │ + │ │ │ │ │ + read_bytes = int(num_sectors_read) * 512 │ │ │ │ │ + written_bytes = int(num_sectors_written) * 512 │ │ │ │ │ + │ │ │ │ │ + all_read_bytes += read_bytes │ │ │ │ │ + all_written_bytes += written_bytes │ │ │ │ │ + │ │ │ │ │ + samples['disk.dev.read'][dev_name] = read_bytes │ │ │ │ │ + samples['disk.dev.written'][dev_name] = written_bytes │ │ │ │ │ + │ │ │ │ │ + samples['disk.all.read'] = all_read_bytes │ │ │ │ │ + samples['disk.all.written'] = all_written_bytes │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class CGroupSampler(Sampler): │ │ │ │ │ + descriptions = [ │ │ │ │ │ + SampleDescription('cgroup.memory.usage', 'bytes', 'instant', instanced=True), │ │ │ │ │ + SampleDescription('cgroup.memory.limit', 'bytes', 'instant', instanced=True), │ │ │ │ │ + SampleDescription('cgroup.memory.sw-usage', 'bytes', 'instant', instanced=True), │ │ │ │ │ + SampleDescription('cgroup.memory.sw-limit', 'bytes', 'instant', instanced=True), │ │ │ │ │ + SampleDescription('cgroup.cpu.usage', 'millisec', 'counter', instanced=True), │ │ │ │ │ + SampleDescription('cgroup.cpu.shares', 'count', 'instant', instanced=True), │ │ │ │ │ + ] │ │ │ │ │ + │ │ │ │ │ + cgroups_v2: Optional[bool] = None │ │ │ │ │ + │ │ │ │ │ + def sample(self, samples: Samples) -> None: │ │ │ │ │ + if self.cgroups_v2 is None: │ │ │ │ │ + self.cgroups_v2 = os.path.exists('/sys/fs/cgroup/cgroup.controllers') │ │ │ │ │ + │ │ │ │ │ + if self.cgroups_v2: │ │ │ │ │ + cgroups_v2_path = '/sys/fs/cgroup/' │ │ │ │ │ + for path, _, _, rootfd in os.fwalk(cgroups_v2_path): │ │ │ │ │ + cgroup = path.replace(cgroups_v2_path, '') │ │ │ │ │ + │ │ │ │ │ + if not cgroup: │ │ │ │ │ + continue │ │ │ │ │ + │ │ │ │ │ + samples['cgroup.memory.usage'][cgroup] = read_int_file(rootfd, 'memory.current', 0) │ │ │ │ │ + samples['cgroup.memory.limit'][cgroup] = read_int_file(rootfd, 'memory.max') │ │ │ │ │ + samples['cgroup.memory.sw-usage'][cgroup] = read_int_file(rootfd, 'memory.swap.current', 0) │ │ │ │ │ + samples['cgroup.memory.sw-limit'][cgroup] = read_int_file(rootfd, 'memory.swap.max') │ │ │ │ │ + samples['cgroup.cpu.shares'][cgroup] = read_int_file(rootfd, 'cpu.weight') │ │ │ │ │ + usage_usec = read_int_file(rootfd, 'cpu.stat', 0, key=b'usage_usec') │ │ │ │ │ + if usage_usec: │ │ │ │ │ + samples['cgroup.cpu.usage'][cgroup] = usage_usec / 1000 │ │ │ │ │ + else: │ │ │ │ │ + memory_path = '/sys/fs/cgroup/memory/' │ │ │ │ │ + for path, _, _, rootfd in os.fwalk(memory_path): │ │ │ │ │ + cgroup = path.replace(memory_path, '') │ │ │ │ │ + │ │ │ │ │ + if not cgroup: │ │ │ │ │ + continue │ │ │ │ │ + │ │ │ │ │ + samples['cgroup.memory.usage'][cgroup] = read_int_file(rootfd, 'memory.usage_in_bytes', 0) │ │ │ │ │ + samples['cgroup.memory.limit'][cgroup] = read_int_file(rootfd, 'memory.limit_in_bytes') │ │ │ │ │ + samples['cgroup.memory.sw-usage'][cgroup] = read_int_file(rootfd, 'memory.memsw.usage_in_bytes', 0) │ │ │ │ │ + samples['cgroup.memory.sw-limit'][cgroup] = read_int_file(rootfd, 'memory.memsw.limit_in_bytes') │ │ │ │ │ + │ │ │ │ │ + cpu_path = '/sys/fs/cgroup/cpu/' │ │ │ │ │ + for path, _, _, rootfd in os.fwalk(cpu_path): │ │ │ │ │ + cgroup = path.replace(cpu_path, '') │ │ │ │ │ + │ │ │ │ │ + if not cgroup: │ │ │ │ │ + continue │ │ │ │ │ + │ │ │ │ │ + samples['cgroup.cpu.shares'][cgroup] = read_int_file(rootfd, 'cpu.shares') │ │ │ │ │ + usage_nsec = read_int_file(rootfd, 'cpuacct.usage') │ │ │ │ │ + if usage_nsec: │ │ │ │ │ + samples['cgroup.cpu.usage'][cgroup] = usage_nsec / 1000000 │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class CGroupDiskIO(Sampler): │ │ │ │ │ + IO_RE = re.compile(rb'\bread_bytes: (?P\d+).*\nwrite_bytes: (?P\d+)', flags=re.S) │ │ │ │ │ + descriptions = [ │ │ │ │ │ + SampleDescription('disk.cgroup.read', 'bytes', 'counter', instanced=True), │ │ │ │ │ + SampleDescription('disk.cgroup.written', 'bytes', 'counter', instanced=True), │ │ │ │ │ + ] │ │ │ │ │ + │ │ │ │ │ + @staticmethod │ │ │ │ │ + def get_cgroup_name(fd: int) -> str: │ │ │ │ │ + with Handle.open('cgroup', os.O_RDONLY, dir_fd=fd) as cgroup_fd: │ │ │ │ │ + cgroup_name = os.read(cgroup_fd, 2048).decode().strip() │ │ │ │ │ + │ │ │ │ │ + # Skip leading ::0/ │ │ │ │ │ + return cgroup_name[4:] │ │ │ │ │ + │ │ │ │ │ + @staticmethod │ │ │ │ │ + def get_proc_io(fd: int) -> Tuple[int, int]: │ │ │ │ │ + with Handle.open('io', os.O_RDONLY, dir_fd=fd) as io_fd: │ │ │ │ │ + data = os.read(io_fd, 4096) │ │ │ │ │ + │ │ │ │ │ + match = re.search(CGroupDiskIO.IO_RE, data) │ │ │ │ │ + if match: │ │ │ │ │ + proc_read = int(match.group('read')) │ │ │ │ │ + proc_write = int(match.group('write')) │ │ │ │ │ + │ │ │ │ │ + return proc_read, proc_write │ │ │ │ │ + │ │ │ │ │ + return 0, 0 │ │ │ │ │ + │ │ │ │ │ + def sample(self, samples: Samples): │ │ │ │ │ + with Handle.open('/proc', os.O_RDONLY | os.O_DIRECTORY) as proc_fd: │ │ │ │ │ + reads = samples['disk.cgroup.read'] │ │ │ │ │ + writes = samples['disk.cgroup.written'] │ │ │ │ │ + │ │ │ │ │ + for path in os.listdir(proc_fd): │ │ │ │ │ + # non-pid entries in proc are guaranteed to start with a character a-z │ │ │ │ │ + if path[0] < '0' or path[0] > '9': │ │ │ │ │ + continue │ │ │ │ │ + │ │ │ │ │ + try: │ │ │ │ │ + with Handle.open(path, os.O_PATH, dir_fd=proc_fd) as pid_fd: │ │ │ │ │ + cgroup_name = self.get_cgroup_name(pid_fd) │ │ │ │ │ + proc_read, proc_write = self.get_proc_io(pid_fd) │ │ │ │ │ + except (FileNotFoundError, PermissionError, ProcessLookupError): │ │ │ │ │ + continue │ │ │ │ │ + │ │ │ │ │ + reads[cgroup_name] = reads.get(cgroup_name, 0) + proc_read │ │ │ │ │ + writes[cgroup_name] = writes.get(cgroup_name, 0) + proc_write │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class NetworkSampler(Sampler): │ │ │ │ │ + descriptions = [ │ │ │ │ │ + SampleDescription('network.interface.tx', 'bytes', 'counter', instanced=True), │ │ │ │ │ + SampleDescription('network.interface.rx', 'bytes', 'counter', instanced=True), │ │ │ │ │ + ] │ │ │ │ │ + │ │ │ │ │ + def sample(self, samples: Samples) -> None: │ │ │ │ │ + with open("/proc/net/dev") as network_samples: │ │ │ │ │ + for line in network_samples: │ │ │ │ │ + fields = line.split() │ │ │ │ │ + │ │ │ │ │ + # Skip header line │ │ │ │ │ + if fields[0][-1] != ':': │ │ │ │ │ + continue │ │ │ │ │ + │ │ │ │ │ + iface = fields[0][:-1] │ │ │ │ │ + samples['network.interface.rx'][iface] = int(fields[1]) │ │ │ │ │ + samples['network.interface.tx'][iface] = int(fields[9]) │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class MountSampler(Sampler): │ │ │ │ │ + descriptions = [ │ │ │ │ │ + SampleDescription('mount.total', 'bytes', 'instant', instanced=True), │ │ │ │ │ + SampleDescription('mount.used', 'bytes', 'instant', instanced=True), │ │ │ │ │ + ] │ │ │ │ │ + │ │ │ │ │ + def sample(self, samples: Samples) -> None: │ │ │ │ │ + with open('/proc/mounts') as mounts: │ │ │ │ │ + for line in mounts: │ │ │ │ │ + # Only look at real devices │ │ │ │ │ + if line[0] != '/': │ │ │ │ │ + continue │ │ │ │ │ + │ │ │ │ │ + path = line.split()[1] │ │ │ │ │ + try: │ │ │ │ │ + res = os.statvfs(path) │ │ │ │ │ + except OSError: │ │ │ │ │ + continue │ │ │ │ │ + frsize = res.f_frsize │ │ │ │ │ + total = frsize * res.f_blocks │ │ │ │ │ + samples['mount.total'][path] = total │ │ │ │ │ + samples['mount.used'][path] = total - frsize * res.f_bfree │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class BlockSampler(Sampler): │ │ │ │ │ + descriptions = [ │ │ │ │ │ + SampleDescription('block.device.read', 'bytes', 'counter', instanced=True), │ │ │ │ │ + SampleDescription('block.device.written', 'bytes', 'counter', instanced=True), │ │ │ │ │ + ] │ │ │ │ │ + │ │ │ │ │ + def sample(self, samples: Samples) -> None: │ │ │ │ │ + with open('/proc/diskstats') as diskstats: │ │ │ │ │ + for line in diskstats: │ │ │ │ │ + # https://www.kernel.org/doc/Documentation/ABI/testing/procfs-diskstats │ │ │ │ │ + [_, _, dev_name, _, _, sectors_read, _, _, _, sectors_written, *_] = line.strip().split() │ │ │ │ │ + │ │ │ │ │ + samples['block.device.read'][dev_name] = int(sectors_read) * 512 │ │ │ │ │ + samples['block.device.written'][dev_name] = int(sectors_written) * 512 │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +SAMPLERS = [ │ │ │ │ │ + BlockSampler, │ │ │ │ │ + CGroupSampler, │ │ │ │ │ + CGroupDiskIO, │ │ │ │ │ + CPUSampler, │ │ │ │ │ + CPUTemperatureSampler, │ │ │ │ │ + DiskSampler, │ │ │ │ │ + MemorySampler, │ │ │ │ │ + MountSampler, │ │ │ │ │ + NetworkSampler, │ │ │ │ │ +] │ │ │ │ │ ''', │ │ │ │ │ - 'cockpit/packages.py': br'''# This file is part of Cockpit. │ │ │ │ │ + 'cockpit/polyfills.py': br'''# This file is part of Cockpit. │ │ │ │ │ +# │ │ │ │ │ +# Copyright (C) 2023 Red Hat, Inc. │ │ │ │ │ +# │ │ │ │ │ +# This program is free software: you can redistribute it and/or modify │ │ │ │ │ +# it under the terms of the GNU General Public License as published by │ │ │ │ │ +# the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ +# (at your option) any later version. │ │ │ │ │ +# │ │ │ │ │ +# This program is distributed in the hope that it will be useful, │ │ │ │ │ +# but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ +# GNU General Public License for more details. │ │ │ │ │ +# │ │ │ │ │ +# You should have received a copy of the GNU General Public License │ │ │ │ │ +# along with this program. If not, see . │ │ │ │ │ + │ │ │ │ │ +import contextlib │ │ │ │ │ +import socket │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +def install(): │ │ │ │ │ + """Add shims for older Python versions""" │ │ │ │ │ + │ │ │ │ │ + # introduced in 3.9 │ │ │ │ │ + if not hasattr(socket, 'recv_fds'): │ │ │ │ │ + import array │ │ │ │ │ + │ │ │ │ │ + import _socket │ │ │ │ │ + │ │ │ │ │ + def recv_fds(sock, bufsize, maxfds, flags=0): │ │ │ │ │ + fds = array.array("i") │ │ │ │ │ + msg, ancdata, flags, addr = sock.recvmsg(bufsize, _socket.CMSG_LEN(maxfds * fds.itemsize)) │ │ │ │ │ + for cmsg_level, cmsg_type, cmsg_data in ancdata: │ │ │ │ │ + if (cmsg_level == _socket.SOL_SOCKET and cmsg_type == _socket.SCM_RIGHTS): │ │ │ │ │ + fds.frombytes(cmsg_data[:len(cmsg_data) - (len(cmsg_data) % fds.itemsize)]) │ │ │ │ │ + return msg, list(fds), flags, addr │ │ │ │ │ + │ │ │ │ │ + socket.recv_fds = recv_fds │ │ │ │ │ + │ │ │ │ │ + # introduced in 3.7 │ │ │ │ │ + if not hasattr(contextlib, 'AsyncExitStack'): │ │ │ │ │ + class AsyncExitStack: │ │ │ │ │ + async def __aenter__(self): │ │ │ │ │ + self.cms = [] │ │ │ │ │ + return self │ │ │ │ │ + │ │ │ │ │ + async def enter_async_context(self, cm): │ │ │ │ │ + result = await cm.__aenter__() │ │ │ │ │ + self.cms.append(cm) │ │ │ │ │ + return result │ │ │ │ │ + │ │ │ │ │ + async def __aexit__(self, exc_type, exc_value, traceback): │ │ │ │ │ + for cm in self.cms: │ │ │ │ │ + cm.__aexit__(exc_type, exc_value, traceback) │ │ │ │ │ + │ │ │ │ │ + contextlib.AsyncExitStack = AsyncExitStack │ │ │ │ │ +''', │ │ │ │ │ + 'cockpit/bridge.py': r'''# This file is part of Cockpit. │ │ │ │ │ # │ │ │ │ │ # Copyright (C) 2022 Red Hat, Inc. │ │ │ │ │ # │ │ │ │ │ # This program is free software: you can redistribute it and/or modify │ │ │ │ │ # it under the terms of the GNU General Public License as published by │ │ │ │ │ # the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ # (at your option) any later version. │ │ │ │ │ @@ -171,578 +578,583 @@ │ │ │ │ │ # but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ # GNU General Public License for more details. │ │ │ │ │ # │ │ │ │ │ # You should have received a copy of the GNU General Public License │ │ │ │ │ # along with this program. If not, see . │ │ │ │ │ │ │ │ │ │ -import collections │ │ │ │ │ +import argparse │ │ │ │ │ +import asyncio │ │ │ │ │ import contextlib │ │ │ │ │ -import functools │ │ │ │ │ -import gzip │ │ │ │ │ -import io │ │ │ │ │ -import itertools │ │ │ │ │ import json │ │ │ │ │ import logging │ │ │ │ │ -import mimetypes │ │ │ │ │ import os │ │ │ │ │ -import re │ │ │ │ │ -import shutil │ │ │ │ │ -from pathlib import Path │ │ │ │ │ -from typing import ( │ │ │ │ │ - BinaryIO, │ │ │ │ │ - Callable, │ │ │ │ │ - ClassVar, │ │ │ │ │ - Dict, │ │ │ │ │ - Iterable, │ │ │ │ │ - List, │ │ │ │ │ - NamedTuple, │ │ │ │ │ - Optional, │ │ │ │ │ - Pattern, │ │ │ │ │ - Sequence, │ │ │ │ │ - Tuple, │ │ │ │ │ - TypeVar, │ │ │ │ │ -) │ │ │ │ │ +import pwd │ │ │ │ │ +import shlex │ │ │ │ │ +import socket │ │ │ │ │ +import stat │ │ │ │ │ +import subprocess │ │ │ │ │ +from typing import Iterable, List, Optional, Sequence, Tuple, Type │ │ │ │ │ │ │ │ │ │ -from cockpit._vendor.systemd_ctypes import bus │ │ │ │ │ +from cockpit._vendor.ferny import interaction_client │ │ │ │ │ +from cockpit._vendor.systemd_ctypes import bus, run_async │ │ │ │ │ │ │ │ │ │ -from . import config │ │ │ │ │ +from . import polyfills │ │ │ │ │ from ._version import __version__ │ │ │ │ │ -from .jsonutil import ( │ │ │ │ │ - JsonError, │ │ │ │ │ - JsonObject, │ │ │ │ │ - JsonValue, │ │ │ │ │ - get_bool, │ │ │ │ │ - get_dict, │ │ │ │ │ - get_int, │ │ │ │ │ - get_objv, │ │ │ │ │ - get_str, │ │ │ │ │ - get_strv, │ │ │ │ │ - json_merge_patch, │ │ │ │ │ - typechecked, │ │ │ │ │ -) │ │ │ │ │ +from .channel import ChannelRoutingRule │ │ │ │ │ +from .channels import CHANNEL_TYPES │ │ │ │ │ +from .config import Config, Environment │ │ │ │ │ +from .internal_endpoints import EXPORTS │ │ │ │ │ +from .jsonutil import JsonError, JsonObject, get_dict │ │ │ │ │ +from .packages import BridgeConfig, Packages, PackagesListener │ │ │ │ │ +from .peer import PeersRoutingRule │ │ │ │ │ +from .remote import HostRoutingRule │ │ │ │ │ +from .router import Router │ │ │ │ │ +from .superuser import SuperuserRoutingRule │ │ │ │ │ +from .transports import StdioTransport │ │ │ │ │ │ │ │ │ │ logger = logging.getLogger(__name__) │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ -# In practice, this is going to get called over and over again with exactly the │ │ │ │ │ -# same list. Let's try to cache the result. │ │ │ │ │ -@functools.lru_cache() │ │ │ │ │ -def parse_accept_language(accept_language: str) -> Sequence[str]: │ │ │ │ │ - """Parse the Accept-Language header, if it exists. │ │ │ │ │ +class InternalBus: │ │ │ │ │ + exportees: List[bus.Slot] │ │ │ │ │ │ │ │ │ │ - Returns an ordered list of languages, with fallbacks inserted, and │ │ │ │ │ - truncated to the position where 'en' would have otherwise appeared, if │ │ │ │ │ - applicable. │ │ │ │ │ + def __init__(self, exports: Iterable[Tuple[str, Type[bus.BaseObject]]]): │ │ │ │ │ + client_socket, server_socket = socket.socketpair() │ │ │ │ │ + self.client = bus.Bus.new(fd=client_socket.detach()) │ │ │ │ │ + self.server = bus.Bus.new(fd=server_socket.detach(), server=True) │ │ │ │ │ + self.exportees = [self.server.add_object(path, cls()) for path, cls in exports] │ │ │ │ │ │ │ │ │ │ - https://tools.ietf.org/html/rfc7231#section-5.3.5 │ │ │ │ │ - https://datatracker.ietf.org/doc/html/rfc4647#section-3.4 │ │ │ │ │ - """ │ │ │ │ │ + def export(self, path: str, obj: bus.BaseObject) -> None: │ │ │ │ │ + self.exportees.append(self.server.add_object(path, obj)) │ │ │ │ │ │ │ │ │ │ - logger.debug('parse_accept_language(%r)', accept_language) │ │ │ │ │ - locales_with_q = [] │ │ │ │ │ - for entry in accept_language.split(','): │ │ │ │ │ - entry = entry.strip().lower() │ │ │ │ │ - logger.debug(' entry %r', entry) │ │ │ │ │ - locale, _, qstr = entry.partition(';q=') │ │ │ │ │ + │ │ │ │ │ +class Bridge(Router, PackagesListener): │ │ │ │ │ + internal_bus: InternalBus │ │ │ │ │ + packages: Optional[Packages] │ │ │ │ │ + bridge_configs: Sequence[BridgeConfig] │ │ │ │ │ + args: argparse.Namespace │ │ │ │ │ + │ │ │ │ │ + def __init__(self, args: argparse.Namespace): │ │ │ │ │ + self.internal_bus = InternalBus(EXPORTS) │ │ │ │ │ + self.bridge_configs = [] │ │ │ │ │ + self.args = args │ │ │ │ │ + │ │ │ │ │ + self.superuser_rule = SuperuserRoutingRule(self, privileged=args.privileged) │ │ │ │ │ + self.internal_bus.export('/superuser', self.superuser_rule) │ │ │ │ │ + │ │ │ │ │ + self.internal_bus.export('/config', Config()) │ │ │ │ │ + self.internal_bus.export('/environment', Environment()) │ │ │ │ │ + │ │ │ │ │ + self.peers_rule = PeersRoutingRule(self) │ │ │ │ │ + │ │ │ │ │ + if args.beipack: │ │ │ │ │ + # Some special stuff for beipack │ │ │ │ │ + self.superuser_rule.set_configs(( │ │ │ │ │ + BridgeConfig({ │ │ │ │ │ + "privileged": True, │ │ │ │ │ + "spawn": ["sudo", "-k", "-A", "python3", "-ic", "# cockpit-bridge", "--privileged"], │ │ │ │ │ + "environ": ["SUDO_ASKPASS=ferny-askpass"], │ │ │ │ │ + }), │ │ │ │ │ + )) │ │ │ │ │ + self.packages = None │ │ │ │ │ + elif args.privileged: │ │ │ │ │ + self.packages = None │ │ │ │ │ + else: │ │ │ │ │ + self.packages = Packages(self) │ │ │ │ │ + self.internal_bus.export('/packages', self.packages) │ │ │ │ │ + self.packages_loaded() │ │ │ │ │ + │ │ │ │ │ + super().__init__([ │ │ │ │ │ + HostRoutingRule(self), │ │ │ │ │ + self.superuser_rule, │ │ │ │ │ + ChannelRoutingRule(self, CHANNEL_TYPES), │ │ │ │ │ + self.peers_rule, │ │ │ │ │ + ]) │ │ │ │ │ + │ │ │ │ │ + @staticmethod │ │ │ │ │ + def get_os_release(): │ │ │ │ │ try: │ │ │ │ │ - q = float(qstr or 1.0) │ │ │ │ │ - except ValueError: │ │ │ │ │ - continue # ignore malformed entry │ │ │ │ │ + file = open('/etc/os-release', encoding='utf-8') │ │ │ │ │ + except FileNotFoundError: │ │ │ │ │ + try: │ │ │ │ │ + file = open('/usr/lib/os-release', encoding='utf-8') │ │ │ │ │ + except FileNotFoundError: │ │ │ │ │ + logger.warning("Neither /etc/os-release nor /usr/lib/os-release exists") │ │ │ │ │ + return {} │ │ │ │ │ │ │ │ │ │ - while locale: │ │ │ │ │ - logger.debug(' adding %r q=%r', locale, q) │ │ │ │ │ - locales_with_q.append((locale, q)) │ │ │ │ │ - # strip off '-detail' suffixes until there's nothing left │ │ │ │ │ - locale, _, _region = locale.rpartition('-') │ │ │ │ │ + os_release = {} │ │ │ │ │ + for line in file.readlines(): │ │ │ │ │ + line = line.strip() │ │ │ │ │ + if not line or line.startswith('#'): │ │ │ │ │ + continue │ │ │ │ │ + try: │ │ │ │ │ + k, v = line.split('=') │ │ │ │ │ + (v_parsed, ) = shlex.split(v) # expect exactly one token │ │ │ │ │ + except ValueError: │ │ │ │ │ + logger.warning('Ignoring invalid line in os-release: %r', line) │ │ │ │ │ + continue │ │ │ │ │ + os_release[k] = v_parsed │ │ │ │ │ + return os_release │ │ │ │ │ │ │ │ │ │ - # Sort the list by highest q value. Otherwise, this is a stable sort. │ │ │ │ │ - locales_with_q.sort(key=lambda pair: pair[1], reverse=True) │ │ │ │ │ - logger.debug(' sorted list is %r', locales_with_q) │ │ │ │ │ + def do_init(self, message: JsonObject) -> None: │ │ │ │ │ + # we're only interested in the case where this is a dict, but │ │ │ │ │ + # 'superuser' may well be `False` and that's not an error │ │ │ │ │ + with contextlib.suppress(JsonError): │ │ │ │ │ + superuser = get_dict(message, 'superuser') │ │ │ │ │ + self.superuser_rule.init(superuser) │ │ │ │ │ │ │ │ │ │ - # If we have 'en' anywhere in our list, ignore it and all items after it. │ │ │ │ │ - # This will result in us getting an untranslated (ie: English) version if │ │ │ │ │ - # none of the more-preferred languages are found, which is what we want. │ │ │ │ │ - # We also take the chance to drop duplicate items. Note: both of these │ │ │ │ │ - # things need to happen after sorting. │ │ │ │ │ - results = [] │ │ │ │ │ - for locale, _q in locales_with_q: │ │ │ │ │ - if locale == 'en': │ │ │ │ │ - break │ │ │ │ │ - if locale not in results: │ │ │ │ │ - results.append(locale) │ │ │ │ │ + def do_send_init(self) -> None: │ │ │ │ │ + init_args = { │ │ │ │ │ + 'capabilities': {'explicit-superuser': True}, │ │ │ │ │ + 'command': 'init', │ │ │ │ │ + 'os-release': self.get_os_release(), │ │ │ │ │ + 'version': 1, │ │ │ │ │ + } │ │ │ │ │ │ │ │ │ │ - logger.debug(' results list is %r', results) │ │ │ │ │ - return tuple(results) │ │ │ │ │ + if self.packages is not None: │ │ │ │ │ + init_args['packages'] = dict.fromkeys(self.packages.packages) │ │ │ │ │ │ │ │ │ │ + self.write_control(init_args) │ │ │ │ │ │ │ │ │ │ -def sortify_version(version: str) -> str: │ │ │ │ │ - """Convert a version string to a form that can be compared""" │ │ │ │ │ - # 0-pad each numeric component. Only supports numeric versions like 1.2.3. │ │ │ │ │ - return '.'.join(part.zfill(8) for part in version.split('.')) │ │ │ │ │ + # PackagesListener interface │ │ │ │ │ + def packages_loaded(self) -> None: │ │ │ │ │ + assert self.packages │ │ │ │ │ + bridge_configs = self.packages.get_bridge_configs() │ │ │ │ │ + if self.bridge_configs != bridge_configs: │ │ │ │ │ + self.superuser_rule.set_configs(bridge_configs) │ │ │ │ │ + self.peers_rule.set_configs(bridge_configs) │ │ │ │ │ + self.bridge_configs = bridge_configs │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ -@functools.lru_cache() │ │ │ │ │ -def get_libexecdir() -> str: │ │ │ │ │ - """Detect libexecdir on current machine │ │ │ │ │ +async def run(args) -> None: │ │ │ │ │ + logger.debug("Hi. How are you today?") │ │ │ │ │ │ │ │ │ │ - This only works for systems which have cockpit-ws installed. │ │ │ │ │ - """ │ │ │ │ │ - for candidate in ['/usr/local/libexec', '/usr/libexec', '/usr/local/lib/cockpit', '/usr/lib/cockpit']: │ │ │ │ │ - if os.path.exists(os.path.join(candidate, 'cockpit-askpass')): │ │ │ │ │ - return candidate │ │ │ │ │ - else: │ │ │ │ │ - logger.warning('Could not detect libexecdir') │ │ │ │ │ - # give readable error messages │ │ │ │ │ - return '/nonexistent/libexec' │ │ │ │ │ + # Unit tests require this │ │ │ │ │ + me = pwd.getpwuid(os.getuid()) │ │ │ │ │ + os.environ['HOME'] = me.pw_dir │ │ │ │ │ + os.environ['SHELL'] = me.pw_shell │ │ │ │ │ + os.environ['USER'] = me.pw_name │ │ │ │ │ │ │ │ │ │ + logger.debug('Starting the router.') │ │ │ │ │ + router = Bridge(args) │ │ │ │ │ + StdioTransport(asyncio.get_running_loop(), router) │ │ │ │ │ │ │ │ │ │ -# HACK: Type narrowing over Union types is not supported in the general case, │ │ │ │ │ -# but this works for the case we care about: knowing that when we pass in an │ │ │ │ │ -# JsonObject, we'll get an JsonObject back. │ │ │ │ │ -J = TypeVar('J', JsonObject, JsonValue) │ │ │ │ │ + logger.debug('Startup done. Looping until connection closes.') │ │ │ │ │ │ │ │ │ │ + try: │ │ │ │ │ + await router.communicate() │ │ │ │ │ + except (BrokenPipeError, ConnectionResetError): │ │ │ │ │ + # not unexpected if the peer doesn't hang up cleanly │ │ │ │ │ + pass │ │ │ │ │ │ │ │ │ │ -def patch_libexecdir(obj: J) -> J: │ │ │ │ │ - if isinstance(obj, str): │ │ │ │ │ - if '${libexecdir}/cockpit-askpass' in obj: │ │ │ │ │ - # extra-special case: we handle this internally │ │ │ │ │ - abs_askpass = shutil.which('cockpit-askpass') │ │ │ │ │ - if abs_askpass is not None: │ │ │ │ │ - return obj.replace('${libexecdir}/cockpit-askpass', abs_askpass) │ │ │ │ │ - return obj.replace('${libexecdir}', get_libexecdir()) │ │ │ │ │ - elif isinstance(obj, dict): │ │ │ │ │ - return {key: patch_libexecdir(value) for key, value in obj.items()} │ │ │ │ │ - elif isinstance(obj, list): │ │ │ │ │ - return [patch_libexecdir(item) for item in obj] │ │ │ │ │ - else: │ │ │ │ │ - return obj │ │ │ │ │ │ │ │ │ │ +def try_to_receive_stderr(): │ │ │ │ │ + try: │ │ │ │ │ + ours, theirs = socket.socketpair() │ │ │ │ │ + with ours: │ │ │ │ │ + with theirs: │ │ │ │ │ + interaction_client.command(2, 'cockpit.send-stderr', fds=[theirs.fileno()]) │ │ │ │ │ + _msg, fds, _flags, _addr = socket.recv_fds(ours, 1, 1) │ │ │ │ │ + except OSError: │ │ │ │ │ + return │ │ │ │ │ │ │ │ │ │ -# A document is a binary stream with a Content-Type, optional Content-Encoding, │ │ │ │ │ -# and optional Content-Security-Policy │ │ │ │ │ -class Document(NamedTuple): │ │ │ │ │ - data: BinaryIO │ │ │ │ │ - content_type: str │ │ │ │ │ - content_encoding: Optional[str] = None │ │ │ │ │ - content_security_policy: Optional[str] = None │ │ │ │ │ + try: │ │ │ │ │ + stderr_fd, = fds │ │ │ │ │ + # We're about to abruptly drop our end of the stderr socketpair that we │ │ │ │ │ + # share with the ferny agent. ferny would normally treat that as an │ │ │ │ │ + # unexpected error. Instruct it to do a clean exit, instead. │ │ │ │ │ + interaction_client.command(2, 'ferny.end') │ │ │ │ │ + os.dup2(stderr_fd, 2) │ │ │ │ │ + finally: │ │ │ │ │ + for fd in fds: │ │ │ │ │ + os.close(fd) │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ -class PackagesListener: │ │ │ │ │ - def packages_loaded(self) -> None: │ │ │ │ │ - """Called when the packages have been reloaded""" │ │ │ │ │ +def setup_journald() -> bool: │ │ │ │ │ + # If stderr is a socket, prefer systemd-journal logging. This covers the │ │ │ │ │ + # case we're already connected to the journal but also the case where we're │ │ │ │ │ + # talking to the ferny agent, while leaving logging to file or terminal │ │ │ │ │ + # unaffected. │ │ │ │ │ + if not stat.S_ISSOCK(os.fstat(2).st_mode): │ │ │ │ │ + # not a socket? Don't redirect. │ │ │ │ │ + return False │ │ │ │ │ │ │ │ │ │ + try: │ │ │ │ │ + import systemd.journal # type: ignore[import] │ │ │ │ │ + except ImportError: │ │ │ │ │ + # No python3-systemd? Don't redirect. │ │ │ │ │ + return False │ │ │ │ │ │ │ │ │ │ -class BridgeConfig(dict, JsonObject): │ │ │ │ │ - def __init__(self, value: JsonObject): │ │ │ │ │ - super().__init__(value) │ │ │ │ │ + logging.root.addHandler(systemd.journal.JournalHandler()) │ │ │ │ │ + return True │ │ │ │ │ │ │ │ │ │ - self.label = get_str(self, 'label', None) │ │ │ │ │ │ │ │ │ │ - self.privileged = get_bool(self, 'privileged', default=False) │ │ │ │ │ - self.match = get_dict(self, 'match', {}) │ │ │ │ │ - if not self.privileged and not self.match: │ │ │ │ │ - raise JsonError(value, 'must have match rules or be privileged') │ │ │ │ │ +def setup_logging(*, debug: bool) -> None: │ │ │ │ │ + """Setup our logger with optional filtering of modules if COCKPIT_DEBUG env is set""" │ │ │ │ │ │ │ │ │ │ - self.environ = get_strv(self, 'environ', ()) │ │ │ │ │ - self.spawn = get_strv(self, 'spawn') │ │ │ │ │ - if not self.spawn: │ │ │ │ │ - raise JsonError(value, 'spawn vector must be non-empty') │ │ │ │ │ + modules = os.getenv('COCKPIT_DEBUG', '') │ │ │ │ │ │ │ │ │ │ - self.name = self.label or self.spawn[0] │ │ │ │ │ + # Either setup logging via journal or via formatted messages to stderr │ │ │ │ │ + if not setup_journald(): │ │ │ │ │ + logging.basicConfig(format='%(name)s-%(levelname)s: %(message)s') │ │ │ │ │ │ │ │ │ │ + if debug or modules == 'all': │ │ │ │ │ + logging.getLogger().setLevel(level=logging.DEBUG) │ │ │ │ │ + elif modules: │ │ │ │ │ + for module in modules.split(','): │ │ │ │ │ + module = module.strip() │ │ │ │ │ + if not module: │ │ │ │ │ + continue │ │ │ │ │ │ │ │ │ │ -class Condition: │ │ │ │ │ - def __init__(self, value: JsonObject): │ │ │ │ │ - try: │ │ │ │ │ - (self.name, self.value), = value.items() │ │ │ │ │ - except ValueError as exc: │ │ │ │ │ - raise JsonError(value, 'must contain exactly one key/value pair') from exc │ │ │ │ │ + logging.getLogger(module).setLevel(logging.DEBUG) │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ -class Manifest(dict, JsonObject): │ │ │ │ │ - # Skip version check when running out of the git checkout (__version__ is None) │ │ │ │ │ - COCKPIT_VERSION = __version__ and sortify_version(__version__) │ │ │ │ │ +def start_ssh_agent() -> None: │ │ │ │ │ + # Launch the agent so that it goes down with us on EOF; PDEATHSIG would be more robust, │ │ │ │ │ + # but it gets cleared on setgid ssh-agent, which some distros still do │ │ │ │ │ + try: │ │ │ │ │ + proc = subprocess.Popen(['ssh-agent', 'sh', '-ec', 'echo SSH_AUTH_SOCK=$SSH_AUTH_SOCK; read a'], │ │ │ │ │ + stdin=subprocess.PIPE, stdout=subprocess.PIPE, universal_newlines=True) │ │ │ │ │ + assert proc.stdout is not None │ │ │ │ │ │ │ │ │ │ - def __init__(self, path: Path, value: JsonObject): │ │ │ │ │ - super().__init__(value) │ │ │ │ │ - self.path = path │ │ │ │ │ - self.name = get_str(self, 'name', self.path.name) │ │ │ │ │ - self.bridges = get_objv(self, 'bridges', BridgeConfig) │ │ │ │ │ - self.priority = get_int(self, 'priority', 1) │ │ │ │ │ - self.csp = get_str(self, 'content-security-policy', '') │ │ │ │ │ - self.conditions = get_objv(self, 'conditions', Condition) │ │ │ │ │ + # Wait for the agent to write at least one line and look for the │ │ │ │ │ + # listener socket. If we fail to find it, kill the agent — something │ │ │ │ │ + # went wrong. │ │ │ │ │ + for token in shlex.shlex(proc.stdout.readline(), punctuation_chars=True): │ │ │ │ │ + if token.startswith('SSH_AUTH_SOCK='): │ │ │ │ │ + os.environ['SSH_AUTH_SOCK'] = token.replace('SSH_AUTH_SOCK=', '', 1) │ │ │ │ │ + break │ │ │ │ │ + else: │ │ │ │ │ + proc.terminate() │ │ │ │ │ + proc.wait() │ │ │ │ │ │ │ │ │ │ - # Skip version check when running out of the git checkout (COCKPIT_VERSION is None) │ │ │ │ │ - if self.COCKPIT_VERSION is not None: │ │ │ │ │ - requires = get_dict(self, 'requires', {}) │ │ │ │ │ - for name, version in requires.items(): │ │ │ │ │ - if name != 'cockpit': │ │ │ │ │ - raise JsonError(name, 'non-cockpit requirement listed') │ │ │ │ │ - if sortify_version(typechecked(version, str)) > self.COCKPIT_VERSION: │ │ │ │ │ - raise JsonError(version, f'required cockpit version ({version}) not met') │ │ │ │ │ + except FileNotFoundError: │ │ │ │ │ + logger.debug("Couldn't start ssh-agent (FileNotFoundError)") │ │ │ │ │ │ │ │ │ │ + except OSError as exc: │ │ │ │ │ + logger.warning("Could not start ssh-agent: %s", exc) │ │ │ │ │ │ │ │ │ │ -class Package: │ │ │ │ │ - # For po{,.manifest}.js files, the interesting part is the locale name │ │ │ │ │ - PO_JS_RE: ClassVar[Pattern] = re.compile(r'(po|po\.manifest)\.([^.]+)\.js(\.gz)?') │ │ │ │ │ │ │ │ │ │ - # immutable after __init__ │ │ │ │ │ - manifest: Manifest │ │ │ │ │ - name: str │ │ │ │ │ - path: Path │ │ │ │ │ - priority: int │ │ │ │ │ +def main(*, beipack: bool = False) -> None: │ │ │ │ │ + polyfills.install() │ │ │ │ │ │ │ │ │ │ - # computed later │ │ │ │ │ - translations: Optional[Dict[str, Dict[str, str]]] = None │ │ │ │ │ - files: Optional[Dict[str, str]] = None │ │ │ │ │ + parser = argparse.ArgumentParser(description='cockpit-bridge is run automatically inside of a Cockpit session.') │ │ │ │ │ + parser.add_argument('--privileged', action='store_true', help='Privileged copy of the bridge') │ │ │ │ │ + parser.add_argument('--packages', action='store_true', help='Show Cockpit package information') │ │ │ │ │ + parser.add_argument('--bridges', action='store_true', help='Show Cockpit bridges information') │ │ │ │ │ + parser.add_argument('--debug', action='store_true', help='Enable debug output (very verbose)') │ │ │ │ │ + parser.add_argument('--version', action='store_true', help='Show Cockpit version information') │ │ │ │ │ + args = parser.parse_args() │ │ │ │ │ │ │ │ │ │ - def __init__(self, manifest: Manifest): │ │ │ │ │ - self.manifest = manifest │ │ │ │ │ - self.name = manifest.name │ │ │ │ │ - self.path = manifest.path │ │ │ │ │ - self.priority = manifest.priority │ │ │ │ │ + # This is determined by who calls us │ │ │ │ │ + args.beipack = beipack │ │ │ │ │ │ │ │ │ │ - def ensure_scanned(self) -> None: │ │ │ │ │ - """Ensure that the package has been scanned. │ │ │ │ │ + # If we were run with --privileged then our stderr is currently being │ │ │ │ │ + # consumed by the main bridge looking for startup-related error messages. │ │ │ │ │ + # Let's switch back to the original stderr stream, which has a side-effect │ │ │ │ │ + # of indicating that our startup is more or less complete. Any errors │ │ │ │ │ + # after this point will land in the journal. │ │ │ │ │ + if args.privileged: │ │ │ │ │ + try_to_receive_stderr() │ │ │ │ │ │ │ │ │ │ - This allows us to defer scanning the files of the package until we know │ │ │ │ │ - that we'll actually use it. │ │ │ │ │ - """ │ │ │ │ │ + setup_logging(debug=args.debug) │ │ │ │ │ │ │ │ │ │ - if self.files is not None: │ │ │ │ │ - return │ │ │ │ │ + # Special modes │ │ │ │ │ + if args.packages: │ │ │ │ │ + Packages().show() │ │ │ │ │ + return │ │ │ │ │ + elif args.version: │ │ │ │ │ + print(f'Version: {__version__}\nProtocol: 1') │ │ │ │ │ + return │ │ │ │ │ + elif args.bridges: │ │ │ │ │ + print(json.dumps([config.__dict__ for config in Packages().get_bridge_configs()], indent=2)) │ │ │ │ │ + return │ │ │ │ │ │ │ │ │ │ - self.files = {} │ │ │ │ │ - self.translations = {'po.js': {}, 'po.manifest.js': {}} │ │ │ │ │ + # The privileged bridge doesn't need ssh-agent, but the main one does │ │ │ │ │ + if 'SSH_AUTH_SOCK' not in os.environ and not args.privileged: │ │ │ │ │ + start_ssh_agent() │ │ │ │ │ │ │ │ │ │ - for file in self.path.rglob('*'): │ │ │ │ │ - name = str(file.relative_to(self.path)) │ │ │ │ │ - if name in ['.', '..', 'manifest.json']: │ │ │ │ │ - continue │ │ │ │ │ + # asyncio.run() shim for Python 3.6 support │ │ │ │ │ + run_async(run(args), debug=args.debug) │ │ │ │ │ │ │ │ │ │ - po_match = Package.PO_JS_RE.fullmatch(name) │ │ │ │ │ - if po_match: │ │ │ │ │ - basename = po_match.group(1) │ │ │ │ │ - locale = po_match.group(2) │ │ │ │ │ - # Accept-Language is case-insensitive and uses '-' to separate variants │ │ │ │ │ - lower_locale = locale.lower().replace('_', '-') │ │ │ │ │ │ │ │ │ │ - logger.debug('Adding translation %r %r -> %r', basename, lower_locale, name) │ │ │ │ │ - self.translations[f'{basename}.js'][lower_locale] = name │ │ │ │ │ - else: │ │ │ │ │ - # strip out trailing '.gz' components │ │ │ │ │ - basename = re.sub('.gz$', '', name) │ │ │ │ │ - logger.debug('Adding content %r -> %r', basename, name) │ │ │ │ │ - self.files[basename] = name │ │ │ │ │ +if __name__ == '__main__': │ │ │ │ │ + main() │ │ │ │ │ +'''.encode('utf-8'), │ │ │ │ │ + 'cockpit/beipack.py': br'''# This file is part of Cockpit. │ │ │ │ │ +# │ │ │ │ │ +# Copyright (C) 2023 Red Hat, Inc. │ │ │ │ │ +# │ │ │ │ │ +# This program is free software: you can redistribute it and/or modify │ │ │ │ │ +# it under the terms of the GNU General Public License as published by │ │ │ │ │ +# the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ +# (at your option) any later version. │ │ │ │ │ +# │ │ │ │ │ +# This program is distributed in the hope that it will be useful, │ │ │ │ │ +# but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ +# GNU General Public License for more details. │ │ │ │ │ +# │ │ │ │ │ +# You should have received a copy of the GNU General Public License │ │ │ │ │ +# along with this program. If not, see . │ │ │ │ │ │ │ │ │ │ - # If we see a filename like `x.min.js` we want to also offer it │ │ │ │ │ - # at `x.js`, but only if `x.js(.gz)` itself is not present. │ │ │ │ │ - # Note: this works for both the case where we found the `x.js` │ │ │ │ │ - # first (it's already in the map) and also if we find it second │ │ │ │ │ - # (it will be replaced in the map by the line just above). │ │ │ │ │ - # See https://github.com/cockpit-project/cockpit/pull/19716 │ │ │ │ │ - self.files.setdefault(basename.replace('.min.', '.'), name) │ │ │ │ │ +import logging │ │ │ │ │ +import lzma │ │ │ │ │ +from typing import List, Sequence, Tuple │ │ │ │ │ │ │ │ │ │ - # support old cockpit-po-plugin which didn't write po.manifest.??.js │ │ │ │ │ - if not self.translations['po.manifest.js']: │ │ │ │ │ - self.translations['po.manifest.js'] = self.translations['po.js'] │ │ │ │ │ +from cockpit._vendor import ferny │ │ │ │ │ +from cockpit._vendor.bei import beipack │ │ │ │ │ │ │ │ │ │ - def get_content_security_policy(self) -> str: │ │ │ │ │ - policy = { │ │ │ │ │ - "default-src": "'self'", │ │ │ │ │ - "connect-src": "'self'", │ │ │ │ │ - "form-action": "'self'", │ │ │ │ │ - "base-uri": "'self'", │ │ │ │ │ - "object-src": "'none'", │ │ │ │ │ - "font-src": "'self' data:", │ │ │ │ │ - "img-src": "'self' data:", │ │ │ │ │ - } │ │ │ │ │ +from .data import read_cockpit_data_file │ │ │ │ │ +from .peer import Peer, PeerError │ │ │ │ │ │ │ │ │ │ - for item in self.manifest.csp.split(';'): │ │ │ │ │ - item = item.strip() │ │ │ │ │ - if item: │ │ │ │ │ - key, _, value = item.strip().partition(' ') │ │ │ │ │ - policy[key] = value │ │ │ │ │ +logger = logging.getLogger(__name__) │ │ │ │ │ │ │ │ │ │ - return ' '.join(f'{k} {v};' for k, v in policy.items()) + ' block-all-mixed-content' │ │ │ │ │ │ │ │ │ │ - def load_file(self, filename: str) -> Document: │ │ │ │ │ - content_type, content_encoding = mimetypes.guess_type(filename) │ │ │ │ │ - content_security_policy = None │ │ │ │ │ +def get_bridge_beipack_xz() -> Tuple[str, bytes]: │ │ │ │ │ + try: │ │ │ │ │ + bridge_beipack_xz = read_cockpit_data_file('cockpit-bridge.beipack.xz') │ │ │ │ │ + logger.debug('Got pre-built cockpit-bridge.beipack.xz') │ │ │ │ │ + except FileNotFoundError: │ │ │ │ │ + logger.debug('Pre-built cockpit-bridge.beipack.xz; building our own.') │ │ │ │ │ + # beipack ourselves │ │ │ │ │ + cockpit_contents = beipack.collect_module('cockpit', recursive=True) │ │ │ │ │ + bridge_beipack = beipack.pack(cockpit_contents, entrypoint='cockpit.bridge:main', args='beipack=True') │ │ │ │ │ + bridge_beipack_xz = lzma.compress(bridge_beipack.encode()) │ │ │ │ │ + logger.debug(' ... done!') │ │ │ │ │ │ │ │ │ │ - if content_type is None: │ │ │ │ │ - content_type = 'text/plain' │ │ │ │ │ - elif content_type.startswith('text/html'): │ │ │ │ │ - content_security_policy = self.get_content_security_policy() │ │ │ │ │ + return 'cockpit/data/cockpit-bridge.beipack.xz', bridge_beipack_xz │ │ │ │ │ │ │ │ │ │ - path = self.path / filename │ │ │ │ │ - logger.debug(' loading data from %s', path) │ │ │ │ │ │ │ │ │ │ - return Document(path.open('rb'), content_type, content_encoding, content_security_policy) │ │ │ │ │ +class BridgeBeibootHelper(ferny.InteractionHandler): │ │ │ │ │ + # ferny.InteractionHandler ClassVar │ │ │ │ │ + commands = ['beiboot.provide', 'beiboot.exc'] │ │ │ │ │ │ │ │ │ │ - def load_translation(self, path: str, locales: Sequence[str]) -> Document: │ │ │ │ │ - self.ensure_scanned() │ │ │ │ │ - assert self.translations is not None │ │ │ │ │ + peer: Peer │ │ │ │ │ + payload: bytes │ │ │ │ │ + steps: Sequence[Tuple[str, Sequence[object]]] │ │ │ │ │ │ │ │ │ │ - # First match wins │ │ │ │ │ - for locale in locales: │ │ │ │ │ - with contextlib.suppress(KeyError): │ │ │ │ │ - return self.load_file(self.translations[path][locale]) │ │ │ │ │ + def __init__(self, peer: Peer, args: Sequence[str] = ()) -> None: │ │ │ │ │ + filename, payload = get_bridge_beipack_xz() │ │ │ │ │ │ │ │ │ │ - # We prefer to return an empty document than 404 in order to avoid │ │ │ │ │ - # errors in the console when a translation can't be found │ │ │ │ │ - return Document(io.BytesIO(), 'text/javascript') │ │ │ │ │ + self.peer = peer │ │ │ │ │ + self.payload = payload │ │ │ │ │ + self.steps = (('boot_xz', (filename, len(payload), tuple(args))),) │ │ │ │ │ │ │ │ │ │ - def load_path(self, path: str, headers: JsonObject) -> Document: │ │ │ │ │ - self.ensure_scanned() │ │ │ │ │ - assert self.files is not None │ │ │ │ │ - assert self.translations is not None │ │ │ │ │ + async def run_command(self, command: str, args: Tuple, fds: List[int], stderr: str) -> None: │ │ │ │ │ + logger.debug('Got ferny request %s %s %s %s', command, args, fds, stderr) │ │ │ │ │ + if command == 'beiboot.provide': │ │ │ │ │ + try: │ │ │ │ │ + size, = args │ │ │ │ │ + assert size == len(self.payload) │ │ │ │ │ + except (AssertionError, ValueError) as exc: │ │ │ │ │ + raise PeerError('internal-error', message=f'ferny interaction error {exc!s}') from exc │ │ │ │ │ │ │ │ │ │ - if path in self.translations: │ │ │ │ │ - locales = parse_accept_language(get_str(headers, 'Accept-Language', '')) │ │ │ │ │ - return self.load_translation(path, locales) │ │ │ │ │ + assert self.peer.transport is not None │ │ │ │ │ + logger.debug('Writing %d bytes of payload', len(self.payload)) │ │ │ │ │ + self.peer.transport.write(self.payload) │ │ │ │ │ + elif command == 'beiboot.exc': │ │ │ │ │ + raise PeerError('internal-error', message=f'Remote exception: {args[0]}') │ │ │ │ │ else: │ │ │ │ │ - return self.load_file(self.files[path]) │ │ │ │ │ + raise PeerError('internal-error', message=f'Unexpected ferny interaction command {command}') │ │ │ │ │ +''', │ │ │ │ │ + 'cockpit/jsonutil.py': r'''# This file is part of Cockpit. │ │ │ │ │ +# │ │ │ │ │ +# Copyright (C) 2023 Red Hat, Inc. │ │ │ │ │ +# │ │ │ │ │ +# This program is free software: you can redistribute it and/or modify │ │ │ │ │ +# it under the terms of the GNU General Public License as published by │ │ │ │ │ +# the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ +# (at your option) any later version. │ │ │ │ │ +# │ │ │ │ │ +# This program is distributed in the hope that it will be useful, │ │ │ │ │ +# but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ +# GNU General Public License for more details. │ │ │ │ │ +# │ │ │ │ │ +# You should have received a copy of the GNU General Public License │ │ │ │ │ +# along with this program. If not, see . │ │ │ │ │ │ │ │ │ │ +from enum import Enum │ │ │ │ │ +from typing import Callable, Container, Dict, List, Mapping, Optional, Sequence, Type, TypeVar, Union │ │ │ │ │ │ │ │ │ │ -class PackagesLoader: │ │ │ │ │ - CONDITIONS: ClassVar[Dict[str, Callable[[str], bool]]] = { │ │ │ │ │ - 'path-exists': os.path.exists, │ │ │ │ │ - 'path-not-exists': lambda p: not os.path.exists(p), │ │ │ │ │ - } │ │ │ │ │ +JsonLiteral = Union[str, float, bool, None] │ │ │ │ │ │ │ │ │ │ - @classmethod │ │ │ │ │ - def get_xdg_data_dirs(cls) -> Iterable[str]: │ │ │ │ │ - try: │ │ │ │ │ - yield os.environ['XDG_DATA_HOME'] │ │ │ │ │ - except KeyError: │ │ │ │ │ - yield os.path.expanduser('~/.local/share') │ │ │ │ │ +# immutable │ │ │ │ │ +JsonValue = Union['JsonObject', Sequence['JsonValue'], JsonLiteral] │ │ │ │ │ +JsonObject = Mapping[str, JsonValue] │ │ │ │ │ │ │ │ │ │ - try: │ │ │ │ │ - yield from os.environ['XDG_DATA_DIRS'].split(':') │ │ │ │ │ - except KeyError: │ │ │ │ │ - yield from ('/usr/local/share', '/usr/share') │ │ │ │ │ +# mutable │ │ │ │ │ +JsonDocument = Union['JsonDict', 'JsonList', JsonLiteral] │ │ │ │ │ +JsonDict = Dict[str, JsonDocument] │ │ │ │ │ +JsonList = List[JsonDocument] │ │ │ │ │ │ │ │ │ │ - @classmethod │ │ │ │ │ - def patch_manifest(cls, manifest: JsonObject, parent: Path) -> JsonObject: │ │ │ │ │ - override_files = [ │ │ │ │ │ - parent / 'override.json', │ │ │ │ │ - config.lookup_config(f'{parent.name}.override.json'), │ │ │ │ │ - config.DOT_CONFIG_COCKPIT / f'{parent.name}.override.json', │ │ │ │ │ - ] │ │ │ │ │ │ │ │ │ │ - for override_file in override_files: │ │ │ │ │ - try: │ │ │ │ │ - override: JsonValue = json.loads(override_file.read_bytes()) │ │ │ │ │ - except FileNotFoundError: │ │ │ │ │ - continue │ │ │ │ │ - except json.JSONDecodeError as exc: │ │ │ │ │ - # User input error: report a warning │ │ │ │ │ - logger.warning('%s: %s', override_file, exc) │ │ │ │ │ +DT = TypeVar('DT') │ │ │ │ │ +T = TypeVar('T') │ │ │ │ │ │ │ │ │ │ - if not isinstance(override, dict): │ │ │ │ │ - logger.warning('%s: override file is not a dictionary', override_file) │ │ │ │ │ - continue │ │ │ │ │ │ │ │ │ │ - manifest = json_merge_patch(manifest, override) │ │ │ │ │ +class JsonError(Exception): │ │ │ │ │ + value: object │ │ │ │ │ │ │ │ │ │ - return patch_libexecdir(manifest) │ │ │ │ │ + def __init__(self, value: object, msg: str): │ │ │ │ │ + super().__init__(msg) │ │ │ │ │ + self.value = value │ │ │ │ │ │ │ │ │ │ - @classmethod │ │ │ │ │ - def load_manifests(cls) -> Iterable[Manifest]: │ │ │ │ │ - for datadir in cls.get_xdg_data_dirs(): │ │ │ │ │ - logger.debug("Scanning for manifest files under %s", datadir) │ │ │ │ │ - for file in Path(datadir).glob('cockpit/*/manifest.json'): │ │ │ │ │ - logger.debug("Considering file %s", file) │ │ │ │ │ - try: │ │ │ │ │ - manifest = json.loads(file.read_text()) │ │ │ │ │ - except json.JSONDecodeError as exc: │ │ │ │ │ - logger.error("%s: %s", file, exc) │ │ │ │ │ - continue │ │ │ │ │ - if not isinstance(manifest, dict): │ │ │ │ │ - logger.error("%s: json document isn't an object", file) │ │ │ │ │ - continue │ │ │ │ │ │ │ │ │ │ - parent = file.parent │ │ │ │ │ - manifest = cls.patch_manifest(manifest, parent) │ │ │ │ │ - try: │ │ │ │ │ - yield Manifest(parent, manifest) │ │ │ │ │ - except JsonError as exc: │ │ │ │ │ - logger.warning('%s %s', file, exc) │ │ │ │ │ +def typechecked(value: JsonValue, expected_type: Type[T]) -> T: │ │ │ │ │ + """Ensure a JSON value has the expected type, returning it if so.""" │ │ │ │ │ + if not isinstance(value, expected_type): │ │ │ │ │ + raise JsonError(value, f'must have type {expected_type.__name__}') │ │ │ │ │ + return value │ │ │ │ │ │ │ │ │ │ - def check_condition(self, condition: str, value: object) -> bool: │ │ │ │ │ - check_fn = self.CONDITIONS[condition] │ │ │ │ │ │ │ │ │ │ - # All known predicates currently only work on strings │ │ │ │ │ - if not isinstance(value, str): │ │ │ │ │ - return False │ │ │ │ │ +# We can't use None as a sentinel because it's often the actual default value │ │ │ │ │ +# EllipsisType is difficult because it's not available before 3.10. │ │ │ │ │ +# See https://peps.python.org/pep-0484/#support-for-singleton-types-in-unions │ │ │ │ │ +class _Empty(Enum): │ │ │ │ │ + TOKEN = 0 │ │ │ │ │ │ │ │ │ │ - return check_fn(value) │ │ │ │ │ │ │ │ │ │ - def check_conditions(self, manifest: Manifest) -> bool: │ │ │ │ │ - for condition in manifest.conditions: │ │ │ │ │ - try: │ │ │ │ │ - okay = self.check_condition(condition.name, condition.value) │ │ │ │ │ - except KeyError: │ │ │ │ │ - # do *not* ignore manifests with unknown predicates, for forward compatibility │ │ │ │ │ - logger.warning(' %s: ignoring unknown predicate in manifest: %s', manifest.path, condition.name) │ │ │ │ │ - continue │ │ │ │ │ +_empty = _Empty.TOKEN │ │ │ │ │ │ │ │ │ │ - if not okay: │ │ │ │ │ - logger.debug(' hiding package %s as its %s condition is not met', manifest.path, condition) │ │ │ │ │ - return False │ │ │ │ │ │ │ │ │ │ - return True │ │ │ │ │ +def _get(obj: JsonObject, cast: Callable[[JsonValue], T], key: str, default: Union[DT, _Empty]) -> Union[T, DT]: │ │ │ │ │ + try: │ │ │ │ │ + return cast(obj[key]) │ │ │ │ │ + except KeyError: │ │ │ │ │ + if default is not _empty: │ │ │ │ │ + return default │ │ │ │ │ + raise JsonError(obj, f"attribute '{key}' required") from None │ │ │ │ │ + except JsonError as exc: │ │ │ │ │ + target = f"attribute '{key}'" + (' elements:' if exc.value is not obj[key] else ':') │ │ │ │ │ + raise JsonError(obj, f"{target} {exc!s}") from exc │ │ │ │ │ │ │ │ │ │ - def load_packages(self) -> Iterable[Tuple[str, Package]]: │ │ │ │ │ - logger.debug('Scanning for available package manifests:') │ │ │ │ │ - # Sort all available packages into buckets by to their claimed name │ │ │ │ │ - names: Dict[str, List[Manifest]] = collections.defaultdict(list) │ │ │ │ │ - for manifest in self.load_manifests(): │ │ │ │ │ - logger.debug(' %s/manifest.json', manifest.path) │ │ │ │ │ - names[manifest.name].append(manifest) │ │ │ │ │ - logger.debug('done.') │ │ │ │ │ │ │ │ │ │ - logger.debug('Selecting packages to serve:') │ │ │ │ │ - for name, candidates in names.items(): │ │ │ │ │ - # For each package name, iterate the candidates in descending │ │ │ │ │ - # priority order and select the first one which passes all checks │ │ │ │ │ - for candidate in sorted(candidates, key=lambda manifest: manifest.priority, reverse=True): │ │ │ │ │ - try: │ │ │ │ │ - if self.check_conditions(candidate): │ │ │ │ │ - logger.debug(' creating package %s -> %s', name, candidate.path) │ │ │ │ │ - yield name, Package(candidate) │ │ │ │ │ - break │ │ │ │ │ - except JsonError: │ │ │ │ │ - logger.warning(' %s: ignoring package with invalid manifest file', candidate.path) │ │ │ │ │ +def get_bool(obj: JsonObject, key: str, default: Union[DT, _Empty] = _empty) -> Union[DT, bool]: │ │ │ │ │ + return _get(obj, lambda v: typechecked(v, bool), key, default) │ │ │ │ │ │ │ │ │ │ - logger.debug(' ignoring %s: unmet conditions', candidate.path) │ │ │ │ │ - logger.debug('done.') │ │ │ │ │ │ │ │ │ │ +def get_int(obj: JsonObject, key: str, default: Union[DT, _Empty] = _empty) -> Union[DT, int]: │ │ │ │ │ + return _get(obj, lambda v: typechecked(v, int), key, default) │ │ │ │ │ │ │ │ │ │ -class Packages(bus.Object, interface='cockpit.Packages'): │ │ │ │ │ - loader: PackagesLoader │ │ │ │ │ - listener: Optional[PackagesListener] │ │ │ │ │ - packages: Dict[str, Package] │ │ │ │ │ - saw_first_reload_hint: bool │ │ │ │ │ │ │ │ │ │ - def __init__(self, listener: Optional[PackagesListener] = None, loader: Optional[PackagesLoader] = None): │ │ │ │ │ - self.listener = listener │ │ │ │ │ - self.loader = loader or PackagesLoader() │ │ │ │ │ - self.load() │ │ │ │ │ +def get_str(obj: JsonObject, key: str, default: Union[DT, _Empty] = _empty) -> Union[DT, str]: │ │ │ │ │ + return _get(obj, lambda v: typechecked(v, str), key, default) │ │ │ │ │ │ │ │ │ │ - # Reloading the Shell in the browser should reload the │ │ │ │ │ - # packages. This is implemented by having the Shell call │ │ │ │ │ - # reload_hint whenever it starts. The first call of this │ │ │ │ │ - # method in each session is ignored so that packages are not │ │ │ │ │ - # loaded twice right after logging in. │ │ │ │ │ - # │ │ │ │ │ - self.saw_first_reload_hint = False │ │ │ │ │ │ │ │ │ │ - def load(self) -> None: │ │ │ │ │ - self.packages = dict(self.loader.load_packages()) │ │ │ │ │ - self.manifests = json.dumps({name: dict(package.manifest) for name, package in self.packages.items()}) │ │ │ │ │ - logger.debug('Packages loaded: %s', list(self.packages)) │ │ │ │ │ +def get_str_or_none(obj: JsonObject, key: str, default: Optional[str]) -> Optional[str]: │ │ │ │ │ + return _get(obj, lambda v: None if v is None else typechecked(v, str), key, default) │ │ │ │ │ │ │ │ │ │ - def show(self): │ │ │ │ │ - for name in sorted(self.packages): │ │ │ │ │ - package = self.packages[name] │ │ │ │ │ - menuitems = [] │ │ │ │ │ - for entry in itertools.chain( │ │ │ │ │ - package.manifest.get('menu', {}).values(), │ │ │ │ │ - package.manifest.get('tools', {}).values()): │ │ │ │ │ - with contextlib.suppress(KeyError): │ │ │ │ │ - menuitems.append(entry['label']) │ │ │ │ │ - print(f'{name:20} {", ".join(menuitems):40} {package.path}') │ │ │ │ │ │ │ │ │ │ - def get_bridge_configs(self) -> Sequence[BridgeConfig]: │ │ │ │ │ - def yield_configs(): │ │ │ │ │ - for package in sorted(self.packages.values(), key=lambda package: -package.priority): │ │ │ │ │ - yield from package.manifest.bridges │ │ │ │ │ - return tuple(yield_configs()) │ │ │ │ │ +def get_dict(obj: JsonObject, key: str, default: Union[DT, _Empty] = _empty) -> Union[DT, JsonObject]: │ │ │ │ │ + return _get(obj, lambda v: typechecked(v, dict), key, default) │ │ │ │ │ │ │ │ │ │ - # D-Bus Interface │ │ │ │ │ - manifests = bus.Interface.Property('s', value="{}") │ │ │ │ │ │ │ │ │ │ - @bus.Interface.Method() │ │ │ │ │ - def reload(self): │ │ │ │ │ - self.load() │ │ │ │ │ - if self.listener is not None: │ │ │ │ │ - self.listener.packages_loaded() │ │ │ │ │ +def get_object( │ │ │ │ │ + obj: JsonObject, │ │ │ │ │ + key: str, │ │ │ │ │ + constructor: Callable[[JsonObject], T], │ │ │ │ │ + default: Union[DT, _Empty] = _empty │ │ │ │ │ +) -> Union[DT, T]: │ │ │ │ │ + return _get(obj, lambda v: constructor(typechecked(v, dict)), key, default) │ │ │ │ │ │ │ │ │ │ - @bus.Interface.Method() │ │ │ │ │ - def reload_hint(self): │ │ │ │ │ - if self.saw_first_reload_hint: │ │ │ │ │ - self.reload() │ │ │ │ │ - self.saw_first_reload_hint = True │ │ │ │ │ │ │ │ │ │ - def load_manifests_js(self, headers: JsonObject) -> Document: │ │ │ │ │ - logger.debug('Serving /manifests.js') │ │ │ │ │ +def get_strv(obj: JsonObject, key: str, default: Union[DT, _Empty] = _empty) -> Union[DT, Sequence[str]]: │ │ │ │ │ + def as_strv(value: JsonValue) -> Sequence[str]: │ │ │ │ │ + return tuple(typechecked(item, str) for item in typechecked(value, list)) │ │ │ │ │ + return _get(obj, as_strv, key, default) │ │ │ │ │ │ │ │ │ │ - chunks: List[bytes] = [] │ │ │ │ │ │ │ │ │ │ - # Send the translations required for the manifest files, from each package │ │ │ │ │ - locales = parse_accept_language(get_str(headers, 'Accept-Language', '')) │ │ │ │ │ - for name, package in self.packages.items(): │ │ │ │ │ - if name in ['static', 'base1']: │ │ │ │ │ - continue │ │ │ │ │ +def get_enum( │ │ │ │ │ + obj: JsonObject, key: str, choices: Container[str], default: Union[DT, _Empty] = _empty │ │ │ │ │ +) -> Union[DT, str]: │ │ │ │ │ + def as_choice(value: JsonValue) -> str: │ │ │ │ │ + # mypy can't do `__eq__()`-based type narrowing... │ │ │ │ │ + # https://github.com/python/mypy/issues/17101 │ │ │ │ │ + if isinstance(value, str) and value in choices: │ │ │ │ │ + return value │ │ │ │ │ + raise JsonError(value, f'invalid value "{value}" not in {choices}') │ │ │ │ │ + return _get(obj, as_choice, key, default) │ │ │ │ │ │ │ │ │ │ - # find_translation will always find at least 'en' │ │ │ │ │ - translation = package.load_translation('po.manifest.js', locales) │ │ │ │ │ - with translation.data: │ │ │ │ │ - if translation.content_encoding == 'gzip': │ │ │ │ │ - data = gzip.decompress(translation.data.read()) │ │ │ │ │ - else: │ │ │ │ │ - data = translation.data.read() │ │ │ │ │ │ │ │ │ │ - chunks.append(data) │ │ │ │ │ +def get_objv(obj: JsonObject, key: str, constructor: Callable[[JsonObject], T]) -> Union[DT, Sequence[T]]: │ │ │ │ │ + def as_objv(value: JsonValue) -> Sequence[T]: │ │ │ │ │ + return tuple(constructor(typechecked(item, dict)) for item in typechecked(value, list)) │ │ │ │ │ + return _get(obj, as_objv, key, ()) │ │ │ │ │ │ │ │ │ │ - chunks.append(b""" │ │ │ │ │ - (function (root, data) { │ │ │ │ │ - if (typeof define === 'function' && define.amd) { │ │ │ │ │ - define(data); │ │ │ │ │ - } │ │ │ │ │ │ │ │ │ │ - if (typeof cockpit === 'object') { │ │ │ │ │ - cockpit.manifests = data; │ │ │ │ │ - } else { │ │ │ │ │ - root.manifests = data; │ │ │ │ │ - } │ │ │ │ │ - }(this, """ + self.manifests.encode() + b"""))""") │ │ │ │ │ +def create_object(message: 'JsonObject | None', kwargs: JsonObject) -> JsonObject: │ │ │ │ │ + """Constructs a JSON object based on message and kwargs. │ │ │ │ │ │ │ │ │ │ - return Document(io.BytesIO(b'\n'.join(chunks)), 'text/javascript') │ │ │ │ │ + If only message is given, it is returned, unmodified. If message is None, │ │ │ │ │ + it is equivalent to an empty dictionary. A copy is always made. │ │ │ │ │ │ │ │ │ │ - def load_manifests_json(self) -> Document: │ │ │ │ │ - logger.debug('Serving /manifests.json') │ │ │ │ │ - return Document(io.BytesIO(self.manifests.encode()), 'application/json') │ │ │ │ │ + If kwargs are present, then any underscore ('_') present in a key name is │ │ │ │ │ + rewritten to a dash ('-'). This is intended to bridge between the required │ │ │ │ │ + Python syntax when providing kwargs and idiomatic JSON (which uses '-' for │ │ │ │ │ + attributes). These values override values in message. │ │ │ │ │ │ │ │ │ │ - PATH_RE = re.compile( │ │ │ │ │ - r'/' # leading '/' │ │ │ │ │ - r'(?:([^/]+)/)?' # optional leading path component │ │ │ │ │ - r'((?:[^/]+/)*[^/]+)' # remaining path components │ │ │ │ │ - ) │ │ │ │ │ + The idea is that `message` should be used for passing data along, and │ │ │ │ │ + kwargs used for data originating at a given call site, possibly including │ │ │ │ │ + modifications to an original message. │ │ │ │ │ + """ │ │ │ │ │ + result = dict(message or {}) │ │ │ │ │ │ │ │ │ │ - def load_path(self, path: str, headers: JsonObject) -> Document: │ │ │ │ │ - logger.debug('packages: serving %s', path) │ │ │ │ │ + for key, value in kwargs.items(): │ │ │ │ │ + # rewrite '_' (necessary in Python syntax kwargs list) to '-' (idiomatic JSON) │ │ │ │ │ + json_key = key.replace('_', '-') │ │ │ │ │ + result[json_key] = value │ │ │ │ │ │ │ │ │ │ - match = self.PATH_RE.fullmatch(path) │ │ │ │ │ - if match is None: │ │ │ │ │ - raise ValueError(f'Invalid HTTP path {path}') │ │ │ │ │ - packagename, filename = match.groups() │ │ │ │ │ + return result │ │ │ │ │ │ │ │ │ │ - if packagename is not None: │ │ │ │ │ - return self.packages[packagename].load_path(filename, headers) │ │ │ │ │ - elif filename == 'manifests.js': │ │ │ │ │ - return self.load_manifests_js(headers) │ │ │ │ │ - elif filename == 'manifests.json': │ │ │ │ │ - return self.load_manifests_json() │ │ │ │ │ + │ │ │ │ │ +def json_merge_patch(current: JsonObject, patch: JsonObject) -> JsonObject: │ │ │ │ │ + """Perform a JSON merge patch (RFC 7396) using 'current' and 'patch'. │ │ │ │ │ + Neither of the original dictionaries is modified — the result is returned. │ │ │ │ │ + """ │ │ │ │ │ + # Always take a copy ('result') — we never modify the input ('current') │ │ │ │ │ + result = dict(current) │ │ │ │ │ + for key, patch_value in patch.items(): │ │ │ │ │ + if isinstance(patch_value, Mapping): │ │ │ │ │ + current_value = current.get(key, None) │ │ │ │ │ + if not isinstance(current_value, Mapping): │ │ │ │ │ + current_value = {} │ │ │ │ │ + result[key] = json_merge_patch(current_value, patch_value) │ │ │ │ │ + elif patch_value is not None: │ │ │ │ │ + result[key] = patch_value │ │ │ │ │ else: │ │ │ │ │ - raise KeyError │ │ │ │ │ -''', │ │ │ │ │ + result.pop(key, None) │ │ │ │ │ + │ │ │ │ │ + return result │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +def json_merge_and_filter_patch(current: JsonDict, patch: JsonDict) -> None: │ │ │ │ │ + """Perform a JSON merge patch (RFC 7396) modifying 'current' with 'patch'. │ │ │ │ │ + Also modifies 'patch' to remove redundant operations. │ │ │ │ │ + """ │ │ │ │ │ + for key, patch_value in tuple(patch.items()): │ │ │ │ │ + current_value = current.get(key, None) │ │ │ │ │ + │ │ │ │ │ + if isinstance(patch_value, dict): │ │ │ │ │ + if not isinstance(current_value, dict): │ │ │ │ │ + current[key] = current_value = {} │ │ │ │ │ + json_merge_and_filter_patch(current_value, patch_value) │ │ │ │ │ + else: │ │ │ │ │ + json_merge_and_filter_patch(current_value, patch_value) │ │ │ │ │ + if not patch_value: │ │ │ │ │ + del patch[key] │ │ │ │ │ + elif current_value == patch_value: │ │ │ │ │ + del patch[key] │ │ │ │ │ + elif patch_value is not None: │ │ │ │ │ + current[key] = patch_value │ │ │ │ │ + else: │ │ │ │ │ + del current[key] │ │ │ │ │ +'''.encode('utf-8'), │ │ │ │ │ 'cockpit/superuser.py': br'''# This file is part of Cockpit. │ │ │ │ │ # │ │ │ │ │ # Copyright (C) 2022 Red Hat, Inc. │ │ │ │ │ # │ │ │ │ │ # This program is free software: you can redistribute it and/or modify │ │ │ │ │ # it under the terms of the GNU General Public License as published by │ │ │ │ │ # the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ @@ -981,15 +1393,15 @@ │ │ │ │ │ def answer(self, reply: str) -> None: │ │ │ │ │ if self.pending_prompt is not None: │ │ │ │ │ logger.debug('responding to pending prompt') │ │ │ │ │ self.pending_prompt.set_result(reply) │ │ │ │ │ else: │ │ │ │ │ logger.debug('got Answer, but no prompt pending') │ │ │ │ │ ''', │ │ │ │ │ - 'cockpit/bridge.py': r'''# This file is part of Cockpit. │ │ │ │ │ + 'cockpit/beiboot.py': br'''# This file is part of Cockpit. │ │ │ │ │ # │ │ │ │ │ # Copyright (C) 2022 Red Hat, Inc. │ │ │ │ │ # │ │ │ │ │ # This program is free software: you can redistribute it and/or modify │ │ │ │ │ # it under the terms of the GNU General Public License as published by │ │ │ │ │ # the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ # (at your option) any later version. │ │ │ │ │ @@ -1000,311 +1412,612 @@ │ │ │ │ │ # GNU General Public License for more details. │ │ │ │ │ # │ │ │ │ │ # You should have received a copy of the GNU General Public License │ │ │ │ │ # along with this program. If not, see . │ │ │ │ │ │ │ │ │ │ import argparse │ │ │ │ │ import asyncio │ │ │ │ │ -import contextlib │ │ │ │ │ -import json │ │ │ │ │ +import base64 │ │ │ │ │ +import importlib.resources │ │ │ │ │ import logging │ │ │ │ │ import os │ │ │ │ │ -import pwd │ │ │ │ │ import shlex │ │ │ │ │ -import socket │ │ │ │ │ -import stat │ │ │ │ │ -import subprocess │ │ │ │ │ -from typing import Iterable, List, Optional, Sequence, Tuple, Type │ │ │ │ │ +from pathlib import Path │ │ │ │ │ +from typing import Dict, Iterable, Optional, Sequence │ │ │ │ │ │ │ │ │ │ -from cockpit._vendor.ferny import interaction_client │ │ │ │ │ -from cockpit._vendor.systemd_ctypes import bus, run_async │ │ │ │ │ +from cockpit import polyfills │ │ │ │ │ +from cockpit._vendor import ferny │ │ │ │ │ +from cockpit._vendor.bei import bootloader │ │ │ │ │ +from cockpit.beipack import BridgeBeibootHelper │ │ │ │ │ +from cockpit.bridge import setup_logging │ │ │ │ │ +from cockpit.channel import ChannelRoutingRule │ │ │ │ │ +from cockpit.channels import PackagesChannel │ │ │ │ │ +from cockpit.jsonutil import JsonObject │ │ │ │ │ +from cockpit.packages import Packages, PackagesLoader, patch_libexecdir │ │ │ │ │ +from cockpit.peer import Peer │ │ │ │ │ +from cockpit.protocol import CockpitProblem │ │ │ │ │ +from cockpit.router import Router, RoutingRule │ │ │ │ │ +from cockpit.transports import StdioTransport │ │ │ │ │ │ │ │ │ │ -from . import polyfills │ │ │ │ │ -from ._version import __version__ │ │ │ │ │ -from .channel import ChannelRoutingRule │ │ │ │ │ -from .channels import CHANNEL_TYPES │ │ │ │ │ -from .config import Config, Environment │ │ │ │ │ -from .internal_endpoints import EXPORTS │ │ │ │ │ -from .jsonutil import JsonError, JsonObject, get_dict │ │ │ │ │ -from .packages import BridgeConfig, Packages, PackagesListener │ │ │ │ │ -from .peer import PeersRoutingRule │ │ │ │ │ -from .remote import HostRoutingRule │ │ │ │ │ -from .router import Router │ │ │ │ │ -from .superuser import SuperuserRoutingRule │ │ │ │ │ -from .transports import StdioTransport │ │ │ │ │ +logger = logging.getLogger('cockpit.beiboot') │ │ │ │ │ │ │ │ │ │ -logger = logging.getLogger(__name__) │ │ │ │ │ │ │ │ │ │ +def ensure_ferny_askpass() -> Path: │ │ │ │ │ + """Create askpass executable │ │ │ │ │ │ │ │ │ │ -class InternalBus: │ │ │ │ │ - exportees: List[bus.Slot] │ │ │ │ │ + We need this for the flatpak: ssh and thus the askpass program run on the host (via flatpak-spawn), │ │ │ │ │ + not the flatpak. Thus we cannot use the shipped cockpit-askpass program. │ │ │ │ │ + """ │ │ │ │ │ + src_path = importlib.resources.files(ferny.__name__) / 'interaction_client.py' │ │ │ │ │ + src_data = src_path.read_bytes() │ │ │ │ │ │ │ │ │ │ - def __init__(self, exports: Iterable[Tuple[str, Type[bus.BaseObject]]]): │ │ │ │ │ - client_socket, server_socket = socket.socketpair() │ │ │ │ │ - self.client = bus.Bus.new(fd=client_socket.detach()) │ │ │ │ │ - self.server = bus.Bus.new(fd=server_socket.detach(), server=True) │ │ │ │ │ - self.exportees = [self.server.add_object(path, cls()) for path, cls in exports] │ │ │ │ │ + # Create the file in $XDG_CACHE_HOME, one of the few locations that a flatpak can write to │ │ │ │ │ + xdg_cache_home = os.environ.get('XDG_CACHE_HOME') │ │ │ │ │ + if xdg_cache_home is None: │ │ │ │ │ + xdg_cache_home = os.path.expanduser('~/.cache') │ │ │ │ │ + os.makedirs(xdg_cache_home, exist_ok=True) │ │ │ │ │ + dest_path = Path(xdg_cache_home, 'cockpit-client-askpass') │ │ │ │ │ │ │ │ │ │ - def export(self, path: str, obj: bus.BaseObject) -> None: │ │ │ │ │ - self.exportees.append(self.server.add_object(path, obj)) │ │ │ │ │ + logger.debug("Checking if %s exists...", dest_path) │ │ │ │ │ │ │ │ │ │ + # Check first to see if we already wrote the current version │ │ │ │ │ + try: │ │ │ │ │ + if dest_path.read_bytes() != src_data: │ │ │ │ │ + logger.debug(" ... it exists but is not the same version...") │ │ │ │ │ + raise ValueError │ │ │ │ │ + if not dest_path.stat().st_mode & 0o100: │ │ │ │ │ + logger.debug(" ... it has the correct contents, but is not executable...") │ │ │ │ │ + raise ValueError │ │ │ │ │ + except (FileNotFoundError, ValueError): │ │ │ │ │ + logger.debug(" ... writing contents.") │ │ │ │ │ + dest_path.write_bytes(src_data) │ │ │ │ │ + dest_path.chmod(0o700) │ │ │ │ │ │ │ │ │ │ -class Bridge(Router, PackagesListener): │ │ │ │ │ - internal_bus: InternalBus │ │ │ │ │ - packages: Optional[Packages] │ │ │ │ │ - bridge_configs: Sequence[BridgeConfig] │ │ │ │ │ - args: argparse.Namespace │ │ │ │ │ + return dest_path │ │ │ │ │ │ │ │ │ │ - def __init__(self, args: argparse.Namespace): │ │ │ │ │ - self.internal_bus = InternalBus(EXPORTS) │ │ │ │ │ - self.bridge_configs = [] │ │ │ │ │ - self.args = args │ │ │ │ │ │ │ │ │ │ - self.superuser_rule = SuperuserRoutingRule(self, privileged=args.privileged) │ │ │ │ │ - self.internal_bus.export('/superuser', self.superuser_rule) │ │ │ │ │ +def get_interesting_files() -> Iterable[str]: │ │ │ │ │ + for manifest in PackagesLoader.load_manifests(): │ │ │ │ │ + for condition in manifest.conditions: │ │ │ │ │ + if condition.name in ('path-exists', 'path-not-exists') and isinstance(condition.value, str): │ │ │ │ │ + yield condition.value │ │ │ │ │ │ │ │ │ │ - self.internal_bus.export('/config', Config()) │ │ │ │ │ - self.internal_bus.export('/environment', Environment()) │ │ │ │ │ │ │ │ │ │ - self.peers_rule = PeersRoutingRule(self) │ │ │ │ │ +class ProxyPackagesLoader(PackagesLoader): │ │ │ │ │ + file_status: Dict[str, bool] │ │ │ │ │ │ │ │ │ │ - if args.beipack: │ │ │ │ │ - # Some special stuff for beipack │ │ │ │ │ - self.superuser_rule.set_configs(( │ │ │ │ │ - BridgeConfig({ │ │ │ │ │ - "privileged": True, │ │ │ │ │ - "spawn": ["sudo", "-k", "-A", "python3", "-ic", "# cockpit-bridge", "--privileged"], │ │ │ │ │ - "environ": ["SUDO_ASKPASS=ferny-askpass"], │ │ │ │ │ - }), │ │ │ │ │ - )) │ │ │ │ │ - self.packages = None │ │ │ │ │ - elif args.privileged: │ │ │ │ │ - self.packages = None │ │ │ │ │ + def check_condition(self, condition: str, value: object) -> bool: │ │ │ │ │ + assert isinstance(value, str) │ │ │ │ │ + assert value in self.file_status │ │ │ │ │ + │ │ │ │ │ + if condition == 'path-exists': │ │ │ │ │ + return self.file_status[value] │ │ │ │ │ + elif condition == 'path-not-exists': │ │ │ │ │ + return not self.file_status[value] │ │ │ │ │ else: │ │ │ │ │ - self.packages = Packages(self) │ │ │ │ │ - self.internal_bus.export('/packages', self.packages) │ │ │ │ │ - self.packages_loaded() │ │ │ │ │ + raise KeyError │ │ │ │ │ │ │ │ │ │ - super().__init__([ │ │ │ │ │ - HostRoutingRule(self), │ │ │ │ │ - self.superuser_rule, │ │ │ │ │ - ChannelRoutingRule(self, CHANNEL_TYPES), │ │ │ │ │ - self.peers_rule, │ │ │ │ │ - ]) │ │ │ │ │ + def __init__(self, file_status: Dict[str, bool]): │ │ │ │ │ + self.file_status = file_status │ │ │ │ │ │ │ │ │ │ - @staticmethod │ │ │ │ │ - def get_os_release(): │ │ │ │ │ - try: │ │ │ │ │ - file = open('/etc/os-release', encoding='utf-8') │ │ │ │ │ - except FileNotFoundError: │ │ │ │ │ - try: │ │ │ │ │ - file = open('/usr/lib/os-release', encoding='utf-8') │ │ │ │ │ - except FileNotFoundError: │ │ │ │ │ - logger.warning("Neither /etc/os-release nor /usr/lib/os-release exists") │ │ │ │ │ - return {} │ │ │ │ │ │ │ │ │ │ - os_release = {} │ │ │ │ │ - for line in file.readlines(): │ │ │ │ │ - line = line.strip() │ │ │ │ │ - if not line or line.startswith('#'): │ │ │ │ │ - continue │ │ │ │ │ - try: │ │ │ │ │ - k, v = line.split('=') │ │ │ │ │ - (v_parsed, ) = shlex.split(v) # expect exactly one token │ │ │ │ │ - except ValueError: │ │ │ │ │ - logger.warning('Ignoring invalid line in os-release: %r', line) │ │ │ │ │ - continue │ │ │ │ │ - os_release[k] = v_parsed │ │ │ │ │ - return os_release │ │ │ │ │ +BEIBOOT_GADGETS = { │ │ │ │ │ + "report_exists": r""" │ │ │ │ │ + import os │ │ │ │ │ + def report_exists(files): │ │ │ │ │ + command('cockpit.report-exists', {name: os.path.exists(name) for name in files}) │ │ │ │ │ + """, │ │ │ │ │ + **ferny.BEIBOOT_GADGETS │ │ │ │ │ +} │ │ │ │ │ │ │ │ │ │ - def do_init(self, message: JsonObject) -> None: │ │ │ │ │ - # we're only interested in the case where this is a dict, but │ │ │ │ │ - # 'superuser' may well be `False` and that's not an error │ │ │ │ │ - with contextlib.suppress(JsonError): │ │ │ │ │ - superuser = get_dict(message, 'superuser') │ │ │ │ │ - self.superuser_rule.init(superuser) │ │ │ │ │ │ │ │ │ │ - def do_send_init(self) -> None: │ │ │ │ │ - init_args = { │ │ │ │ │ - 'capabilities': {'explicit-superuser': True}, │ │ │ │ │ - 'command': 'init', │ │ │ │ │ - 'os-release': self.get_os_release(), │ │ │ │ │ - 'version': 1, │ │ │ │ │ - } │ │ │ │ │ +class DefaultRoutingRule(RoutingRule): │ │ │ │ │ + peer: 'Peer | None' │ │ │ │ │ │ │ │ │ │ - if self.packages is not None: │ │ │ │ │ - init_args['packages'] = dict.fromkeys(self.packages.packages) │ │ │ │ │ + def __init__(self, router: Router): │ │ │ │ │ + super().__init__(router) │ │ │ │ │ │ │ │ │ │ - self.write_control(init_args) │ │ │ │ │ + def apply_rule(self, options: JsonObject) -> 'Peer | None': │ │ │ │ │ + return self.peer │ │ │ │ │ │ │ │ │ │ - # PackagesListener interface │ │ │ │ │ - def packages_loaded(self) -> None: │ │ │ │ │ - assert self.packages │ │ │ │ │ - bridge_configs = self.packages.get_bridge_configs() │ │ │ │ │ - if self.bridge_configs != bridge_configs: │ │ │ │ │ - self.superuser_rule.set_configs(bridge_configs) │ │ │ │ │ - self.peers_rule.set_configs(bridge_configs) │ │ │ │ │ - self.bridge_configs = bridge_configs │ │ │ │ │ + def shutdown(self) -> None: │ │ │ │ │ + if self.peer is not None: │ │ │ │ │ + self.peer.close() │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class AuthorizeResponder(ferny.AskpassHandler): │ │ │ │ │ + commands = ('ferny.askpass', 'cockpit.report-exists') │ │ │ │ │ + router: Router │ │ │ │ │ + │ │ │ │ │ + def __init__(self, router: Router): │ │ │ │ │ + self.router = router │ │ │ │ │ + │ │ │ │ │ + async def do_askpass(self, messages: str, prompt: str, hint: str) -> Optional[str]: │ │ │ │ │ + if hint == 'none': │ │ │ │ │ + # We have three problems here: │ │ │ │ │ + # │ │ │ │ │ + # - we have no way to present a message on the login │ │ │ │ │ + # screen without presenting a prompt and a button │ │ │ │ │ + # - the login screen will not try to repost the login │ │ │ │ │ + # request because it doesn't understand that we are not │ │ │ │ │ + # waiting on input, which means that it won't notice │ │ │ │ │ + # that we've logged in successfully │ │ │ │ │ + # - cockpit-ws has an issue where if we retry the request │ │ │ │ │ + # again after login succeeded then it won't forward the │ │ │ │ │ + # init message to the client, stalling the login. This │ │ │ │ │ + # is a race and can't be fixed without -ws changes. │ │ │ │ │ + # │ │ │ │ │ + # Let's avoid all of that by just showing nothing. │ │ │ │ │ + return None │ │ │ │ │ + │ │ │ │ │ + challenge = 'X-Conversation - ' + base64.b64encode(prompt.encode()).decode() │ │ │ │ │ + response = await self.router.request_authorization(challenge, │ │ │ │ │ + messages=messages, │ │ │ │ │ + prompt=prompt, │ │ │ │ │ + hint=hint, │ │ │ │ │ + echo=False) │ │ │ │ │ + │ │ │ │ │ + b64 = response.removeprefix('X-Conversation -').strip() │ │ │ │ │ + response = base64.b64decode(b64.encode()).decode() │ │ │ │ │ + logger.debug('Returning a %d chars response', len(response)) │ │ │ │ │ + return response │ │ │ │ │ + │ │ │ │ │ + async def do_custom_command(self, command: str, args: tuple, fds: list[int], stderr: str) -> None: │ │ │ │ │ + logger.debug('Got ferny command %s %s %s', command, args, stderr) │ │ │ │ │ + │ │ │ │ │ + if command == 'cockpit.report-exists': │ │ │ │ │ + file_status, = args │ │ │ │ │ + # FIXME: evil duck typing here -- this is a half-way Bridge │ │ │ │ │ + self.router.packages = Packages(loader=ProxyPackagesLoader(file_status)) # type: ignore[attr-defined] │ │ │ │ │ + self.router.routing_rules.insert(0, ChannelRoutingRule(self.router, [PackagesChannel])) │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class SshPeer(Peer): │ │ │ │ │ + always: bool │ │ │ │ │ + │ │ │ │ │ + def __init__(self, router: Router, destination: str, args: argparse.Namespace): │ │ │ │ │ + self.destination = destination │ │ │ │ │ + self.always = args.always │ │ │ │ │ + super().__init__(router) │ │ │ │ │ + │ │ │ │ │ + async def do_connect_transport(self) -> None: │ │ │ │ │ + beiboot_helper = BridgeBeibootHelper(self) │ │ │ │ │ + │ │ │ │ │ + agent = ferny.InteractionAgent([AuthorizeResponder(self.router), beiboot_helper]) │ │ │ │ │ + │ │ │ │ │ + # We want to run a python interpreter somewhere... │ │ │ │ │ + cmd: Sequence[str] = ('python3', '-ic', '# cockpit-bridge') │ │ │ │ │ + env: Sequence[str] = () │ │ │ │ │ + │ │ │ │ │ + in_flatpak = os.path.exists('/.flatpak-info') │ │ │ │ │ + │ │ │ │ │ + # Remote host? Wrap command with SSH │ │ │ │ │ + if self.destination != 'localhost': │ │ │ │ │ + if in_flatpak: │ │ │ │ │ + # we run ssh and thus the helper on the host, always use the xdg-cache helper │ │ │ │ │ + ssh_askpass = ensure_ferny_askpass() │ │ │ │ │ + else: │ │ │ │ │ + # outside of the flatpak we expect cockpit-ws and thus an installed helper │ │ │ │ │ + askpass = patch_libexecdir('${libexecdir}/cockpit-askpass') │ │ │ │ │ + assert isinstance(askpass, str) │ │ │ │ │ + ssh_askpass = Path(askpass) │ │ │ │ │ + if not ssh_askpass.exists(): │ │ │ │ │ + logger.error("Could not find cockpit-askpass helper at %r", askpass) │ │ │ │ │ + │ │ │ │ │ + env = ( │ │ │ │ │ + f'SSH_ASKPASS={ssh_askpass!s}', │ │ │ │ │ + 'DISPLAY=x', │ │ │ │ │ + 'SSH_ASKPASS_REQUIRE=force', │ │ │ │ │ + ) │ │ │ │ │ + host, _, port = self.destination.rpartition(':') │ │ │ │ │ + # catch cases like `host:123` but not cases like `[2001:abcd::1] │ │ │ │ │ + if port.isdigit(): │ │ │ │ │ + host_args = ['-p', port, host] │ │ │ │ │ + else: │ │ │ │ │ + host_args = [self.destination] │ │ │ │ │ + │ │ │ │ │ + cmd = ('ssh', *host_args, shlex.join(cmd)) │ │ │ │ │ + │ │ │ │ │ + # Running in flatpak? Wrap command with flatpak-spawn --host │ │ │ │ │ + if in_flatpak: │ │ │ │ │ + cmd = ('flatpak-spawn', '--host', │ │ │ │ │ + *(f'--env={kv}' for kv in env), │ │ │ │ │ + *cmd) │ │ │ │ │ + env = () │ │ │ │ │ + │ │ │ │ │ + logger.debug("Launching command: cmd=%s env=%s", cmd, env) │ │ │ │ │ + transport = await self.spawn(cmd, env, stderr=agent, start_new_session=True) │ │ │ │ │ + │ │ │ │ │ + if not self.always: │ │ │ │ │ + exec_cockpit_bridge_steps = [('try_exec', (['cockpit-bridge'],))] │ │ │ │ │ + else: │ │ │ │ │ + exec_cockpit_bridge_steps = [] │ │ │ │ │ + │ │ │ │ │ + # Send the first-stage bootloader │ │ │ │ │ + stage1 = bootloader.make_bootloader([ │ │ │ │ │ + *exec_cockpit_bridge_steps, │ │ │ │ │ + ('report_exists', [list(get_interesting_files())]), │ │ │ │ │ + *beiboot_helper.steps, │ │ │ │ │ + ], gadgets=BEIBOOT_GADGETS) │ │ │ │ │ + transport.write(stage1.encode()) │ │ │ │ │ + │ │ │ │ │ + # Wait for "init" or error, handling auth and beiboot requests │ │ │ │ │ + await agent.communicate() │ │ │ │ │ + │ │ │ │ │ + def transport_control_received(self, command: str, message: JsonObject) -> None: │ │ │ │ │ + if command == 'authorize': │ │ │ │ │ + # We've disabled this for explicit-superuser bridges, but older │ │ │ │ │ + # bridges don't support that and will ask us anyway. │ │ │ │ │ + return │ │ │ │ │ + │ │ │ │ │ + super().transport_control_received(command, message) │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class SshBridge(Router): │ │ │ │ │ + packages: Optional[Packages] = None │ │ │ │ │ + ssh_peer: SshPeer │ │ │ │ │ + │ │ │ │ │ + def __init__(self, args: argparse.Namespace): │ │ │ │ │ + # By default, we route everything to the other host. We add an extra │ │ │ │ │ + # routing rule for the packages webserver only if we're running the │ │ │ │ │ + # beipack. │ │ │ │ │ + rule = DefaultRoutingRule(self) │ │ │ │ │ + super().__init__([rule]) │ │ │ │ │ + │ │ │ │ │ + # This needs to be created after Router.__init__ is called. │ │ │ │ │ + self.ssh_peer = SshPeer(self, args.destination, args) │ │ │ │ │ + rule.peer = self.ssh_peer │ │ │ │ │ + │ │ │ │ │ + def do_send_init(self): │ │ │ │ │ + pass # wait for the peer to do it first │ │ │ │ │ + │ │ │ │ │ + def do_init(self, message): │ │ │ │ │ + # https://github.com/cockpit-project/cockpit/issues/18927 │ │ │ │ │ + # │ │ │ │ │ + # We tell cockpit-ws that we have the explicit-superuser capability and │ │ │ │ │ + # handle it ourselves (just below) by sending `superuser-init-done` and │ │ │ │ │ + # passing {'superuser': False} on to the actual bridge (Python or C). │ │ │ │ │ + if isinstance(message.get('superuser'), dict): │ │ │ │ │ + self.write_control(command='superuser-init-done') │ │ │ │ │ + message['superuser'] = False │ │ │ │ │ + self.ssh_peer.write_control(message) │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ async def run(args) -> None: │ │ │ │ │ logger.debug("Hi. How are you today?") │ │ │ │ │ │ │ │ │ │ - # Unit tests require this │ │ │ │ │ - me = pwd.getpwuid(os.getuid()) │ │ │ │ │ - os.environ['HOME'] = me.pw_dir │ │ │ │ │ - os.environ['SHELL'] = me.pw_shell │ │ │ │ │ - os.environ['USER'] = me.pw_name │ │ │ │ │ + bridge = SshBridge(args) │ │ │ │ │ + StdioTransport(asyncio.get_running_loop(), bridge) │ │ │ │ │ │ │ │ │ │ - logger.debug('Starting the router.') │ │ │ │ │ - router = Bridge(args) │ │ │ │ │ - StdioTransport(asyncio.get_running_loop(), router) │ │ │ │ │ + try: │ │ │ │ │ + message = dict(await bridge.ssh_peer.start()) │ │ │ │ │ │ │ │ │ │ - logger.debug('Startup done. Looping until connection closes.') │ │ │ │ │ + # See comment in do_init() above: we tell cockpit-ws that we support │ │ │ │ │ + # this and then handle it ourselves when we get the init message. │ │ │ │ │ + capabilities = message.setdefault('capabilities', {}) │ │ │ │ │ + if not isinstance(capabilities, dict): │ │ │ │ │ + bridge.write_control(command='init', problem='protocol-error', message='capabilities must be a dict') │ │ │ │ │ + return │ │ │ │ │ + assert isinstance(capabilities, dict) # convince mypy │ │ │ │ │ + capabilities['explicit-superuser'] = True │ │ │ │ │ + │ │ │ │ │ + # only patch the packages line if we are in beiboot mode │ │ │ │ │ + if bridge.packages: │ │ │ │ │ + message['packages'] = dict.fromkeys(bridge.packages.packages) │ │ │ │ │ + │ │ │ │ │ + bridge.write_control(message) │ │ │ │ │ + bridge.ssh_peer.thaw_endpoint() │ │ │ │ │ + except ferny.InteractionError as exc: │ │ │ │ │ + error = ferny.ssh_errors.get_exception_for_ssh_stderr(str(exc)) │ │ │ │ │ + logger.debug("ferny.InteractionError: %s, interpreted as: %r", exc, error) │ │ │ │ │ + if isinstance(error, ferny.SshAuthenticationError): │ │ │ │ │ + problem = 'authentication-failed' │ │ │ │ │ + elif isinstance(error, ferny.SshHostKeyError): │ │ │ │ │ + problem = 'unknown-hostkey' │ │ │ │ │ + elif isinstance(error, OSError): │ │ │ │ │ + # usually DNS/socket errors │ │ │ │ │ + problem = 'unknown-host' │ │ │ │ │ + else: │ │ │ │ │ + problem = 'internal-error' │ │ │ │ │ + bridge.write_control(command='init', problem=problem, message=str(error)) │ │ │ │ │ + return │ │ │ │ │ + except CockpitProblem as exc: │ │ │ │ │ + logger.debug("CockpitProblem: %s", exc) │ │ │ │ │ + bridge.write_control(exc.attrs, command='init') │ │ │ │ │ + return │ │ │ │ │ │ │ │ │ │ + logger.debug('Startup done. Looping until connection closes.') │ │ │ │ │ try: │ │ │ │ │ - await router.communicate() │ │ │ │ │ - except (BrokenPipeError, ConnectionResetError): │ │ │ │ │ - # not unexpected if the peer doesn't hang up cleanly │ │ │ │ │ + await bridge.communicate() │ │ │ │ │ + except BrokenPipeError: │ │ │ │ │ + # expected if the peer doesn't hang up cleanly │ │ │ │ │ pass │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ -def try_to_receive_stderr(): │ │ │ │ │ - try: │ │ │ │ │ - ours, theirs = socket.socketpair() │ │ │ │ │ - with ours: │ │ │ │ │ - with theirs: │ │ │ │ │ - interaction_client.command(2, 'cockpit.send-stderr', fds=[theirs.fileno()]) │ │ │ │ │ - _msg, fds, _flags, _addr = socket.recv_fds(ours, 1, 1) │ │ │ │ │ - except OSError: │ │ │ │ │ - return │ │ │ │ │ +def main() -> None: │ │ │ │ │ + polyfills.install() │ │ │ │ │ │ │ │ │ │ - try: │ │ │ │ │ - stderr_fd, = fds │ │ │ │ │ - # We're about to abruptly drop our end of the stderr socketpair that we │ │ │ │ │ - # share with the ferny agent. ferny would normally treat that as an │ │ │ │ │ - # unexpected error. Instruct it to do a clean exit, instead. │ │ │ │ │ - interaction_client.command(2, 'ferny.end') │ │ │ │ │ - os.dup2(stderr_fd, 2) │ │ │ │ │ - finally: │ │ │ │ │ - for fd in fds: │ │ │ │ │ - os.close(fd) │ │ │ │ │ + parser = argparse.ArgumentParser(description='cockpit-bridge is run automatically inside of a Cockpit session.') │ │ │ │ │ + parser.add_argument('--always', action='store_true', help="Never try to run cockpit-bridge from the system") │ │ │ │ │ + parser.add_argument('--debug', action='store_true') │ │ │ │ │ + parser.add_argument('destination', help="Name of the remote host to connect to, or 'localhost'") │ │ │ │ │ + args = parser.parse_args() │ │ │ │ │ │ │ │ │ │ + setup_logging(debug=args.debug) │ │ │ │ │ │ │ │ │ │ -def setup_journald() -> bool: │ │ │ │ │ - # If stderr is a socket, prefer systemd-journal logging. This covers the │ │ │ │ │ - # case we're already connected to the journal but also the case where we're │ │ │ │ │ - # talking to the ferny agent, while leaving logging to file or terminal │ │ │ │ │ - # unaffected. │ │ │ │ │ - if not stat.S_ISSOCK(os.fstat(2).st_mode): │ │ │ │ │ - # not a socket? Don't redirect. │ │ │ │ │ - return False │ │ │ │ │ + asyncio.run(run(args), debug=args.debug) │ │ │ │ │ │ │ │ │ │ - try: │ │ │ │ │ - import systemd.journal # type: ignore[import] │ │ │ │ │ - except ImportError: │ │ │ │ │ - # No python3-systemd? Don't redirect. │ │ │ │ │ - return False │ │ │ │ │ │ │ │ │ │ - logging.root.addHandler(systemd.journal.JournalHandler()) │ │ │ │ │ - return True │ │ │ │ │ +if __name__ == '__main__': │ │ │ │ │ + main() │ │ │ │ │ +''', │ │ │ │ │ + 'cockpit/__init__.py': br'''from ._version import __version__ │ │ │ │ │ │ │ │ │ │ +__all__ = ( │ │ │ │ │ + '__version__', │ │ │ │ │ +) │ │ │ │ │ +''', │ │ │ │ │ + 'cockpit/protocol.py': br'''# This file is part of Cockpit. │ │ │ │ │ +# │ │ │ │ │ +# Copyright (C) 2022 Red Hat, Inc. │ │ │ │ │ +# │ │ │ │ │ +# This program is free software: you can redistribute it and/or modify │ │ │ │ │ +# it under the terms of the GNU General Public License as published by │ │ │ │ │ +# the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ +# (at your option) any later version. │ │ │ │ │ +# │ │ │ │ │ +# This program is distributed in the hope that it will be useful, │ │ │ │ │ +# but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ +# GNU General Public License for more details. │ │ │ │ │ +# │ │ │ │ │ +# You should have received a copy of the GNU General Public License │ │ │ │ │ +# along with this program. If not, see . │ │ │ │ │ │ │ │ │ │ -def setup_logging(*, debug: bool) -> None: │ │ │ │ │ - """Setup our logger with optional filtering of modules if COCKPIT_DEBUG env is set""" │ │ │ │ │ +import asyncio │ │ │ │ │ +import json │ │ │ │ │ +import logging │ │ │ │ │ +import traceback │ │ │ │ │ +import uuid │ │ │ │ │ │ │ │ │ │ - modules = os.getenv('COCKPIT_DEBUG', '') │ │ │ │ │ +from .jsonutil import JsonError, JsonObject, JsonValue, create_object, get_int, get_str, get_str_or_none, typechecked │ │ │ │ │ │ │ │ │ │ - # Either setup logging via journal or via formatted messages to stderr │ │ │ │ │ - if not setup_journald(): │ │ │ │ │ - logging.basicConfig(format='%(name)s-%(levelname)s: %(message)s') │ │ │ │ │ +logger = logging.getLogger(__name__) │ │ │ │ │ │ │ │ │ │ - if debug or modules == 'all': │ │ │ │ │ - logging.getLogger().setLevel(level=logging.DEBUG) │ │ │ │ │ - elif modules: │ │ │ │ │ - for module in modules.split(','): │ │ │ │ │ - module = module.strip() │ │ │ │ │ - if not module: │ │ │ │ │ - continue │ │ │ │ │ │ │ │ │ │ - logging.getLogger(module).setLevel(logging.DEBUG) │ │ │ │ │ +class CockpitProblem(Exception): │ │ │ │ │ + """A type of exception that carries a problem code and a message. │ │ │ │ │ │ │ │ │ │ + Depending on the scope, this is used to handle shutting down: │ │ │ │ │ │ │ │ │ │ -def start_ssh_agent() -> None: │ │ │ │ │ - # Launch the agent so that it goes down with us on EOF; PDEATHSIG would be more robust, │ │ │ │ │ - # but it gets cleared on setgid ssh-agent, which some distros still do │ │ │ │ │ - try: │ │ │ │ │ - proc = subprocess.Popen(['ssh-agent', 'sh', '-ec', 'echo SSH_AUTH_SOCK=$SSH_AUTH_SOCK; read a'], │ │ │ │ │ - stdin=subprocess.PIPE, stdout=subprocess.PIPE, universal_newlines=True) │ │ │ │ │ - assert proc.stdout is not None │ │ │ │ │ + - an individual channel (sends problem code in the close message) │ │ │ │ │ + - peer connections (sends problem code in close message for each open channel) │ │ │ │ │ + - the main stdio interaction with the bridge │ │ │ │ │ │ │ │ │ │ - # Wait for the agent to write at least one line and look for the │ │ │ │ │ - # listener socket. If we fail to find it, kill the agent — something │ │ │ │ │ - # went wrong. │ │ │ │ │ - for token in shlex.shlex(proc.stdout.readline(), punctuation_chars=True): │ │ │ │ │ - if token.startswith('SSH_AUTH_SOCK='): │ │ │ │ │ - os.environ['SSH_AUTH_SOCK'] = token.replace('SSH_AUTH_SOCK=', '', 1) │ │ │ │ │ - break │ │ │ │ │ + It is usually thrown in response to some violation of expected protocol │ │ │ │ │ + when parsing messages, connecting to a peer, or opening a channel. │ │ │ │ │ + """ │ │ │ │ │ + attrs: JsonObject │ │ │ │ │ + │ │ │ │ │ + def __init__(self, problem: str, _msg: 'JsonObject | None' = None, **kwargs: JsonValue) -> None: │ │ │ │ │ + kwargs['problem'] = problem │ │ │ │ │ + self.attrs = create_object(_msg, kwargs) │ │ │ │ │ + super().__init__(get_str(self.attrs, 'message', problem)) │ │ │ │ │ + │ │ │ │ │ + def get_attrs(self) -> JsonObject: │ │ │ │ │ + if self.attrs['problem'] == 'internal-error' and self.__cause__ is not None: │ │ │ │ │ + return dict(self.attrs, cause=traceback.format_exception( │ │ │ │ │ + self.__cause__.__class__, self.__cause__, self.__cause__.__traceback__ │ │ │ │ │ + )) │ │ │ │ │ else: │ │ │ │ │ - proc.terminate() │ │ │ │ │ - proc.wait() │ │ │ │ │ + return self.attrs │ │ │ │ │ │ │ │ │ │ - except FileNotFoundError: │ │ │ │ │ - logger.debug("Couldn't start ssh-agent (FileNotFoundError)") │ │ │ │ │ │ │ │ │ │ - except OSError as exc: │ │ │ │ │ - logger.warning("Could not start ssh-agent: %s", exc) │ │ │ │ │ +class CockpitProtocolError(CockpitProblem): │ │ │ │ │ + def __init__(self, message: str, problem: str = 'protocol-error'): │ │ │ │ │ + super().__init__(problem, message=message) │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ -def main(*, beipack: bool = False) -> None: │ │ │ │ │ - polyfills.install() │ │ │ │ │ +class CockpitProtocol(asyncio.Protocol): │ │ │ │ │ + """A naive implementation of the Cockpit frame protocol │ │ │ │ │ │ │ │ │ │ - parser = argparse.ArgumentParser(description='cockpit-bridge is run automatically inside of a Cockpit session.') │ │ │ │ │ - parser.add_argument('--privileged', action='store_true', help='Privileged copy of the bridge') │ │ │ │ │ - parser.add_argument('--packages', action='store_true', help='Show Cockpit package information') │ │ │ │ │ - parser.add_argument('--bridges', action='store_true', help='Show Cockpit bridges information') │ │ │ │ │ - parser.add_argument('--debug', action='store_true', help='Enable debug output (very verbose)') │ │ │ │ │ - parser.add_argument('--version', action='store_true', help='Show Cockpit version information') │ │ │ │ │ - args = parser.parse_args() │ │ │ │ │ + We need to use this because Python's SelectorEventLoop doesn't supported │ │ │ │ │ + buffered protocols. │ │ │ │ │ + """ │ │ │ │ │ + transport: 'asyncio.Transport | None' = None │ │ │ │ │ + buffer = b'' │ │ │ │ │ + _closed: bool = False │ │ │ │ │ + _communication_done: 'asyncio.Future[None] | None' = None │ │ │ │ │ │ │ │ │ │ - # This is determined by who calls us │ │ │ │ │ - args.beipack = beipack │ │ │ │ │ + def do_ready(self) -> None: │ │ │ │ │ + pass │ │ │ │ │ │ │ │ │ │ - # If we were run with --privileged then our stderr is currently being │ │ │ │ │ - # consumed by the main bridge looking for startup-related error messages. │ │ │ │ │ - # Let's switch back to the original stderr stream, which has a side-effect │ │ │ │ │ - # of indicating that our startup is more or less complete. Any errors │ │ │ │ │ - # after this point will land in the journal. │ │ │ │ │ - if args.privileged: │ │ │ │ │ - try_to_receive_stderr() │ │ │ │ │ + def do_closed(self, exc: 'Exception | None') -> None: │ │ │ │ │ + pass │ │ │ │ │ │ │ │ │ │ - setup_logging(debug=args.debug) │ │ │ │ │ + def transport_control_received(self, command: str, message: JsonObject) -> None: │ │ │ │ │ + raise NotImplementedError │ │ │ │ │ │ │ │ │ │ - # Special modes │ │ │ │ │ - if args.packages: │ │ │ │ │ - Packages().show() │ │ │ │ │ - return │ │ │ │ │ - elif args.version: │ │ │ │ │ - print(f'Version: {__version__}\nProtocol: 1') │ │ │ │ │ - return │ │ │ │ │ - elif args.bridges: │ │ │ │ │ - print(json.dumps([config.__dict__ for config in Packages().get_bridge_configs()], indent=2)) │ │ │ │ │ - return │ │ │ │ │ + def channel_control_received(self, channel: str, command: str, message: JsonObject) -> None: │ │ │ │ │ + raise NotImplementedError │ │ │ │ │ │ │ │ │ │ - # The privileged bridge doesn't need ssh-agent, but the main one does │ │ │ │ │ - if 'SSH_AUTH_SOCK' not in os.environ and not args.privileged: │ │ │ │ │ - start_ssh_agent() │ │ │ │ │ + def channel_data_received(self, channel: str, data: bytes) -> None: │ │ │ │ │ + raise NotImplementedError │ │ │ │ │ │ │ │ │ │ - # asyncio.run() shim for Python 3.6 support │ │ │ │ │ - run_async(run(args), debug=args.debug) │ │ │ │ │ + def frame_received(self, frame: bytes) -> None: │ │ │ │ │ + header, _, data = frame.partition(b'\n') │ │ │ │ │ + │ │ │ │ │ + if header != b'': │ │ │ │ │ + channel = header.decode('ascii') │ │ │ │ │ + logger.debug('data received: %d bytes of data for channel %s', len(data), channel) │ │ │ │ │ + self.channel_data_received(channel, data) │ │ │ │ │ │ │ │ │ │ + else: │ │ │ │ │ + self.control_received(data) │ │ │ │ │ │ │ │ │ │ -if __name__ == '__main__': │ │ │ │ │ - main() │ │ │ │ │ -'''.encode('utf-8'), │ │ │ │ │ + def control_received(self, data: bytes) -> None: │ │ │ │ │ + try: │ │ │ │ │ + message = typechecked(json.loads(data), dict) │ │ │ │ │ + command = get_str(message, 'command') │ │ │ │ │ + channel = get_str(message, 'channel', None) │ │ │ │ │ + │ │ │ │ │ + if channel is not None: │ │ │ │ │ + logger.debug('channel control received %s', message) │ │ │ │ │ + self.channel_control_received(channel, command, message) │ │ │ │ │ + else: │ │ │ │ │ + logger.debug('transport control received %s', message) │ │ │ │ │ + self.transport_control_received(command, message) │ │ │ │ │ + │ │ │ │ │ + except (json.JSONDecodeError, JsonError) as exc: │ │ │ │ │ + raise CockpitProtocolError(f'control message: {exc!s}') from exc │ │ │ │ │ + │ │ │ │ │ + def consume_one_frame(self, data: bytes) -> int: │ │ │ │ │ + """Consumes a single frame from view. │ │ │ │ │ + │ │ │ │ │ + Returns positive if a number of bytes were consumed, or negative if no │ │ │ │ │ + work can be done because of a given number of bytes missing. │ │ │ │ │ + """ │ │ │ │ │ + │ │ │ │ │ + try: │ │ │ │ │ + newline = data.index(b'\n') │ │ │ │ │ + except ValueError as exc: │ │ │ │ │ + if len(data) < 10: │ │ │ │ │ + # Let's try reading more │ │ │ │ │ + return len(data) - 10 │ │ │ │ │ + raise CockpitProtocolError("size line is too long") from exc │ │ │ │ │ + │ │ │ │ │ + try: │ │ │ │ │ + length = int(data[:newline]) │ │ │ │ │ + except ValueError as exc: │ │ │ │ │ + raise CockpitProtocolError("frame size is not an integer") from exc │ │ │ │ │ + │ │ │ │ │ + start = newline + 1 │ │ │ │ │ + end = start + length │ │ │ │ │ + │ │ │ │ │ + if end > len(data): │ │ │ │ │ + # We need to read more │ │ │ │ │ + return len(data) - end │ │ │ │ │ + │ │ │ │ │ + # We can consume a full frame │ │ │ │ │ + self.frame_received(data[start:end]) │ │ │ │ │ + return end │ │ │ │ │ + │ │ │ │ │ + def connection_made(self, transport: asyncio.BaseTransport) -> None: │ │ │ │ │ + logger.debug('connection_made(%s)', transport) │ │ │ │ │ + assert isinstance(transport, asyncio.Transport) │ │ │ │ │ + self.transport = transport │ │ │ │ │ + self.do_ready() │ │ │ │ │ + │ │ │ │ │ + if self._closed: │ │ │ │ │ + logger.debug(' but the protocol already was closed, so closing transport') │ │ │ │ │ + transport.close() │ │ │ │ │ + │ │ │ │ │ + def connection_lost(self, exc: 'Exception | None') -> None: │ │ │ │ │ + logger.debug('connection_lost') │ │ │ │ │ + assert self.transport is not None │ │ │ │ │ + self.transport = None │ │ │ │ │ + self.close(exc) │ │ │ │ │ + │ │ │ │ │ + def close(self, exc: 'Exception | None' = None) -> None: │ │ │ │ │ + if self._closed: │ │ │ │ │ + return │ │ │ │ │ + self._closed = True │ │ │ │ │ + │ │ │ │ │ + if self.transport: │ │ │ │ │ + self.transport.close() │ │ │ │ │ + │ │ │ │ │ + self.do_closed(exc) │ │ │ │ │ + │ │ │ │ │ + def write_channel_data(self, channel: str, payload: bytes) -> None: │ │ │ │ │ + """Send a given payload (bytes) on channel (string)""" │ │ │ │ │ + # Channel is certainly ascii (as enforced by .encode() below) │ │ │ │ │ + frame_length = len(channel + '\n') + len(payload) │ │ │ │ │ + header = f'{frame_length}\n{channel}\n'.encode('ascii') │ │ │ │ │ + if self.transport is not None: │ │ │ │ │ + logger.debug('writing to transport %s', self.transport) │ │ │ │ │ + self.transport.write(header + payload) │ │ │ │ │ + else: │ │ │ │ │ + logger.debug('cannot write to closed transport') │ │ │ │ │ + │ │ │ │ │ + def write_control(self, _msg: 'JsonObject | None' = None, **kwargs: JsonValue) -> None: │ │ │ │ │ + """Write a control message. See jsonutil.create_object() for details.""" │ │ │ │ │ + logger.debug('sending control message %r %r', _msg, kwargs) │ │ │ │ │ + pretty = json.dumps(create_object(_msg, kwargs), indent=2) + '\n' │ │ │ │ │ + self.write_channel_data('', pretty.encode()) │ │ │ │ │ + │ │ │ │ │ + def data_received(self, data: bytes) -> None: │ │ │ │ │ + try: │ │ │ │ │ + self.buffer += data │ │ │ │ │ + while self.buffer: │ │ │ │ │ + result = self.consume_one_frame(self.buffer) │ │ │ │ │ + if result <= 0: │ │ │ │ │ + return │ │ │ │ │ + self.buffer = self.buffer[result:] │ │ │ │ │ + except CockpitProtocolError as exc: │ │ │ │ │ + self.close(exc) │ │ │ │ │ + │ │ │ │ │ + def eof_received(self) -> bool: │ │ │ │ │ + return False │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +# Helpful functionality for "server"-side protocol implementations │ │ │ │ │ +class CockpitProtocolServer(CockpitProtocol): │ │ │ │ │ + init_host: 'str | None' = None │ │ │ │ │ + authorizations: 'dict[str, asyncio.Future[str]] | None' = None │ │ │ │ │ + │ │ │ │ │ + def do_send_init(self) -> None: │ │ │ │ │ + raise NotImplementedError │ │ │ │ │ + │ │ │ │ │ + def do_init(self, message: JsonObject) -> None: │ │ │ │ │ + pass │ │ │ │ │ + │ │ │ │ │ + def do_kill(self, host: 'str | None', group: 'str | None', message: JsonObject) -> None: │ │ │ │ │ + raise NotImplementedError │ │ │ │ │ + │ │ │ │ │ + def transport_control_received(self, command: str, message: JsonObject) -> None: │ │ │ │ │ + if command == 'init': │ │ │ │ │ + if get_int(message, 'version') != 1: │ │ │ │ │ + raise CockpitProtocolError('incorrect version number') │ │ │ │ │ + self.init_host = get_str(message, 'host') │ │ │ │ │ + self.do_init(message) │ │ │ │ │ + elif command == 'kill': │ │ │ │ │ + self.do_kill(get_str_or_none(message, 'host', None), get_str_or_none(message, 'group', None), message) │ │ │ │ │ + elif command == 'authorize': │ │ │ │ │ + self.do_authorize(message) │ │ │ │ │ + else: │ │ │ │ │ + raise CockpitProtocolError(f'unexpected control message {command} received') │ │ │ │ │ + │ │ │ │ │ + def do_ready(self) -> None: │ │ │ │ │ + self.do_send_init() │ │ │ │ │ + │ │ │ │ │ + # authorize request/response API │ │ │ │ │ + async def request_authorization( │ │ │ │ │ + self, challenge: str, timeout: 'int | None' = None, **kwargs: JsonValue │ │ │ │ │ + ) -> str: │ │ │ │ │ + if self.authorizations is None: │ │ │ │ │ + self.authorizations = {} │ │ │ │ │ + cookie = str(uuid.uuid4()) │ │ │ │ │ + future = asyncio.get_running_loop().create_future() │ │ │ │ │ + try: │ │ │ │ │ + self.authorizations[cookie] = future │ │ │ │ │ + self.write_control(None, command='authorize', challenge=challenge, cookie=cookie, **kwargs) │ │ │ │ │ + return await asyncio.wait_for(future, timeout) │ │ │ │ │ + finally: │ │ │ │ │ + self.authorizations.pop(cookie) │ │ │ │ │ + │ │ │ │ │ + def do_authorize(self, message: JsonObject) -> None: │ │ │ │ │ + cookie = get_str(message, 'cookie') │ │ │ │ │ + response = get_str(message, 'response') │ │ │ │ │ + │ │ │ │ │ + if self.authorizations is None or cookie not in self.authorizations: │ │ │ │ │ + logger.warning('no matching authorize request') │ │ │ │ │ + return │ │ │ │ │ + │ │ │ │ │ + self.authorizations[cookie].set_result(response) │ │ │ │ │ +''', │ │ │ │ │ 'cockpit/transports.py': br'''# This file is part of Cockpit. │ │ │ │ │ # │ │ │ │ │ # Copyright (C) 2022 Red Hat, Inc. │ │ │ │ │ # │ │ │ │ │ # This program is free software: you can redistribute it and/or modify │ │ │ │ │ # it under the terms of the GNU General Public License as published by │ │ │ │ │ # the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ @@ -1851,837 +2564,14 @@ │ │ │ │ │ self._loop.remove_reader(self._fd) │ │ │ │ │ os.close(self._fd) │ │ │ │ │ self._fd = -1 │ │ │ │ │ │ │ │ │ │ def __del__(self) -> None: │ │ │ │ │ self.close() │ │ │ │ │ ''', │ │ │ │ │ - 'cockpit/beipack.py': br'''# This file is part of Cockpit. │ │ │ │ │ -# │ │ │ │ │ -# Copyright (C) 2023 Red Hat, Inc. │ │ │ │ │ -# │ │ │ │ │ -# This program is free software: you can redistribute it and/or modify │ │ │ │ │ -# it under the terms of the GNU General Public License as published by │ │ │ │ │ -# the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ -# (at your option) any later version. │ │ │ │ │ -# │ │ │ │ │ -# This program is distributed in the hope that it will be useful, │ │ │ │ │ -# but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ -# GNU General Public License for more details. │ │ │ │ │ -# │ │ │ │ │ -# You should have received a copy of the GNU General Public License │ │ │ │ │ -# along with this program. If not, see . │ │ │ │ │ - │ │ │ │ │ -import logging │ │ │ │ │ -import lzma │ │ │ │ │ -from typing import List, Sequence, Tuple │ │ │ │ │ - │ │ │ │ │ -from cockpit._vendor import ferny │ │ │ │ │ -from cockpit._vendor.bei import beipack │ │ │ │ │ - │ │ │ │ │ -from .data import read_cockpit_data_file │ │ │ │ │ -from .peer import Peer, PeerError │ │ │ │ │ - │ │ │ │ │ -logger = logging.getLogger(__name__) │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -def get_bridge_beipack_xz() -> Tuple[str, bytes]: │ │ │ │ │ - try: │ │ │ │ │ - bridge_beipack_xz = read_cockpit_data_file('cockpit-bridge.beipack.xz') │ │ │ │ │ - logger.debug('Got pre-built cockpit-bridge.beipack.xz') │ │ │ │ │ - except FileNotFoundError: │ │ │ │ │ - logger.debug('Pre-built cockpit-bridge.beipack.xz; building our own.') │ │ │ │ │ - # beipack ourselves │ │ │ │ │ - cockpit_contents = beipack.collect_module('cockpit', recursive=True) │ │ │ │ │ - bridge_beipack = beipack.pack(cockpit_contents, entrypoint='cockpit.bridge:main', args='beipack=True') │ │ │ │ │ - bridge_beipack_xz = lzma.compress(bridge_beipack.encode()) │ │ │ │ │ - logger.debug(' ... done!') │ │ │ │ │ - │ │ │ │ │ - return 'cockpit/data/cockpit-bridge.beipack.xz', bridge_beipack_xz │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -class BridgeBeibootHelper(ferny.InteractionHandler): │ │ │ │ │ - # ferny.InteractionHandler ClassVar │ │ │ │ │ - commands = ['beiboot.provide', 'beiboot.exc'] │ │ │ │ │ - │ │ │ │ │ - peer: Peer │ │ │ │ │ - payload: bytes │ │ │ │ │ - steps: Sequence[Tuple[str, Sequence[object]]] │ │ │ │ │ - │ │ │ │ │ - def __init__(self, peer: Peer, args: Sequence[str] = ()) -> None: │ │ │ │ │ - filename, payload = get_bridge_beipack_xz() │ │ │ │ │ - │ │ │ │ │ - self.peer = peer │ │ │ │ │ - self.payload = payload │ │ │ │ │ - self.steps = (('boot_xz', (filename, len(payload), tuple(args))),) │ │ │ │ │ - │ │ │ │ │ - async def run_command(self, command: str, args: Tuple, fds: List[int], stderr: str) -> None: │ │ │ │ │ - logger.debug('Got ferny request %s %s %s %s', command, args, fds, stderr) │ │ │ │ │ - if command == 'beiboot.provide': │ │ │ │ │ - try: │ │ │ │ │ - size, = args │ │ │ │ │ - assert size == len(self.payload) │ │ │ │ │ - except (AssertionError, ValueError) as exc: │ │ │ │ │ - raise PeerError('internal-error', message=f'ferny interaction error {exc!s}') from exc │ │ │ │ │ - │ │ │ │ │ - assert self.peer.transport is not None │ │ │ │ │ - logger.debug('Writing %d bytes of payload', len(self.payload)) │ │ │ │ │ - self.peer.transport.write(self.payload) │ │ │ │ │ - elif command == 'beiboot.exc': │ │ │ │ │ - raise PeerError('internal-error', message=f'Remote exception: {args[0]}') │ │ │ │ │ - else: │ │ │ │ │ - raise PeerError('internal-error', message=f'Unexpected ferny interaction command {command}') │ │ │ │ │ -''', │ │ │ │ │ - 'cockpit/peer.py': r'''# This file is part of Cockpit. │ │ │ │ │ -# │ │ │ │ │ -# Copyright (C) 2022 Red Hat, Inc. │ │ │ │ │ -# │ │ │ │ │ -# This program is free software: you can redistribute it and/or modify │ │ │ │ │ -# it under the terms of the GNU General Public License as published by │ │ │ │ │ -# the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ -# (at your option) any later version. │ │ │ │ │ -# │ │ │ │ │ -# This program is distributed in the hope that it will be useful, │ │ │ │ │ -# but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ -# GNU General Public License for more details. │ │ │ │ │ -# │ │ │ │ │ -# You should have received a copy of the GNU General Public License │ │ │ │ │ -# along with this program. If not, see . │ │ │ │ │ - │ │ │ │ │ -import asyncio │ │ │ │ │ -import logging │ │ │ │ │ -import os │ │ │ │ │ -from typing import Callable, List, Optional, Sequence │ │ │ │ │ - │ │ │ │ │ -from .jsonutil import JsonObject, JsonValue │ │ │ │ │ -from .packages import BridgeConfig │ │ │ │ │ -from .protocol import CockpitProblem, CockpitProtocol, CockpitProtocolError │ │ │ │ │ -from .router import Endpoint, Router, RoutingRule │ │ │ │ │ -from .transports import SubprocessProtocol, SubprocessTransport │ │ │ │ │ - │ │ │ │ │ -logger = logging.getLogger(__name__) │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -class PeerError(CockpitProblem): │ │ │ │ │ - pass │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -class PeerExited(Exception): │ │ │ │ │ - def __init__(self, exit_code: int): │ │ │ │ │ - self.exit_code = exit_code │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -class Peer(CockpitProtocol, SubprocessProtocol, Endpoint): │ │ │ │ │ - done_callbacks: List[Callable[[], None]] │ │ │ │ │ - init_future: Optional[asyncio.Future] │ │ │ │ │ - │ │ │ │ │ - def __init__(self, router: Router): │ │ │ │ │ - super().__init__(router) │ │ │ │ │ - │ │ │ │ │ - # All Peers start out frozen — we only unfreeze after we see the first 'init' message │ │ │ │ │ - self.freeze_endpoint() │ │ │ │ │ - │ │ │ │ │ - self.init_future = asyncio.get_running_loop().create_future() │ │ │ │ │ - self.done_callbacks = [] │ │ │ │ │ - │ │ │ │ │ - # Initialization │ │ │ │ │ - async def do_connect_transport(self) -> None: │ │ │ │ │ - raise NotImplementedError │ │ │ │ │ - │ │ │ │ │ - async def spawn(self, argv: Sequence[str], env: Sequence[str], **kwargs) -> asyncio.Transport: │ │ │ │ │ - # Not actually async... │ │ │ │ │ - loop = asyncio.get_running_loop() │ │ │ │ │ - user_env = dict(e.split('=', 1) for e in env) │ │ │ │ │ - return SubprocessTransport(loop, self, argv, env=dict(os.environ, **user_env), **kwargs) │ │ │ │ │ - │ │ │ │ │ - async def start(self, init_host: Optional[str] = None, **kwargs: JsonValue) -> JsonObject: │ │ │ │ │ - """Request that the Peer is started and connected to the router. │ │ │ │ │ - │ │ │ │ │ - Creates the transport, connects it to the protocol, and participates in │ │ │ │ │ - exchanging of init messages. If anything goes wrong, the connection │ │ │ │ │ - will be closed and an exception will be raised. │ │ │ │ │ - │ │ │ │ │ - The Peer starts out in a frozen state (ie: attempts to send messages to │ │ │ │ │ - it will initially be queued). If init_host is not None then an init │ │ │ │ │ - message is sent with the given 'host' field, plus any extra kwargs, and │ │ │ │ │ - the queue is thawed. Otherwise, the caller is responsible for sending │ │ │ │ │ - the init message and thawing the peer. │ │ │ │ │ - │ │ │ │ │ - In any case, the return value is the init message from the peer. │ │ │ │ │ - """ │ │ │ │ │ - assert self.init_future is not None │ │ │ │ │ - │ │ │ │ │ - def _connect_task_done(task: asyncio.Task) -> None: │ │ │ │ │ - assert task is connect_task │ │ │ │ │ - try: │ │ │ │ │ - task.result() │ │ │ │ │ - except asyncio.CancelledError: # we did that (below) │ │ │ │ │ - pass # we want to ignore it │ │ │ │ │ - except Exception as exc: │ │ │ │ │ - self.close(exc) │ │ │ │ │ - │ │ │ │ │ - connect_task = asyncio.create_task(self.do_connect_transport()) │ │ │ │ │ - connect_task.add_done_callback(_connect_task_done) │ │ │ │ │ - │ │ │ │ │ - try: │ │ │ │ │ - # Wait for something to happen: │ │ │ │ │ - # - exception from our connection function │ │ │ │ │ - # - receiving "init" from the other side │ │ │ │ │ - # - receiving EOF from the other side │ │ │ │ │ - # - .close() was called │ │ │ │ │ - # - other transport exception │ │ │ │ │ - init_message = await self.init_future │ │ │ │ │ - │ │ │ │ │ - except (PeerExited, BrokenPipeError): │ │ │ │ │ - # These are fairly generic errors. PeerExited means that we observed the process exiting. │ │ │ │ │ - # BrokenPipeError means that we got EPIPE when attempting to write() to it. In both cases, │ │ │ │ │ - # the process is gone, but it's not clear why. If the connection process is still running, │ │ │ │ │ - # perhaps we'd get a better error message from it. │ │ │ │ │ - await connect_task │ │ │ │ │ - # Otherwise, re-raise │ │ │ │ │ - raise │ │ │ │ │ - │ │ │ │ │ - finally: │ │ │ │ │ - self.init_future = None │ │ │ │ │ - │ │ │ │ │ - # In any case (failure or success) make sure this is done. │ │ │ │ │ - if not connect_task.done(): │ │ │ │ │ - connect_task.cancel() │ │ │ │ │ - │ │ │ │ │ - if init_host is not None: │ │ │ │ │ - logger.debug(' sending init message back, host %s', init_host) │ │ │ │ │ - # Send "init" back │ │ │ │ │ - self.write_control(None, command='init', version=1, host=init_host, **kwargs) │ │ │ │ │ - │ │ │ │ │ - # Thaw the queued messages │ │ │ │ │ - self.thaw_endpoint() │ │ │ │ │ - │ │ │ │ │ - return init_message │ │ │ │ │ - │ │ │ │ │ - # Background initialization │ │ │ │ │ - def start_in_background(self, init_host: Optional[str] = None, **kwargs: JsonValue) -> None: │ │ │ │ │ - def _start_task_done(task: asyncio.Task) -> None: │ │ │ │ │ - assert task is start_task │ │ │ │ │ - │ │ │ │ │ - try: │ │ │ │ │ - task.result() │ │ │ │ │ - except (OSError, PeerExited, CockpitProblem, asyncio.CancelledError): │ │ │ │ │ - pass # Those are expected. Others will throw. │ │ │ │ │ - │ │ │ │ │ - start_task = asyncio.create_task(self.start(init_host, **kwargs)) │ │ │ │ │ - start_task.add_done_callback(_start_task_done) │ │ │ │ │ - │ │ │ │ │ - # Shutdown │ │ │ │ │ - def add_done_callback(self, callback: Callable[[], None]) -> None: │ │ │ │ │ - self.done_callbacks.append(callback) │ │ │ │ │ - │ │ │ │ │ - # Handling of interesting events │ │ │ │ │ - def do_superuser_init_done(self) -> None: │ │ │ │ │ - pass │ │ │ │ │ - │ │ │ │ │ - def do_authorize(self, message: JsonObject) -> None: │ │ │ │ │ - pass │ │ │ │ │ - │ │ │ │ │ - def transport_control_received(self, command: str, message: JsonObject) -> None: │ │ │ │ │ - if command == 'init' and self.init_future is not None: │ │ │ │ │ - logger.debug('Got init message with active init_future. Setting result.') │ │ │ │ │ - self.init_future.set_result(message) │ │ │ │ │ - elif command == 'authorize': │ │ │ │ │ - self.do_authorize(message) │ │ │ │ │ - elif command == 'superuser-init-done': │ │ │ │ │ - self.do_superuser_init_done() │ │ │ │ │ - else: │ │ │ │ │ - raise CockpitProtocolError(f'Received unexpected control message {command}') │ │ │ │ │ - │ │ │ │ │ - def eof_received(self) -> bool: │ │ │ │ │ - # We always expect to be the ones to close the connection, so if we get │ │ │ │ │ - # an EOF, then we consider it to be an error. This allows us to │ │ │ │ │ - # distinguish close caused by unexpected EOF (but no errno from a │ │ │ │ │ - # syscall failure) vs. close caused by calling .close() on our side. │ │ │ │ │ - # The process is still running at this point, so keep it and handle │ │ │ │ │ - # the error in process_exited(). │ │ │ │ │ - logger.debug('Peer %s received unexpected EOF', self.__class__.__name__) │ │ │ │ │ - return True │ │ │ │ │ - │ │ │ │ │ - def do_closed(self, exc: Optional[Exception]) -> None: │ │ │ │ │ - logger.debug('Peer %s connection lost %s %s', self.__class__.__name__, type(exc), exc) │ │ │ │ │ - │ │ │ │ │ - if exc is None: │ │ │ │ │ - self.shutdown_endpoint(problem='terminated') │ │ │ │ │ - elif isinstance(exc, PeerExited): │ │ │ │ │ - # a common case is that the called peer does not exist │ │ │ │ │ - if exc.exit_code == 127: │ │ │ │ │ - self.shutdown_endpoint(problem='no-cockpit') │ │ │ │ │ - else: │ │ │ │ │ - self.shutdown_endpoint(problem='terminated', message=f'Peer exited with status {exc.exit_code}') │ │ │ │ │ - elif isinstance(exc, CockpitProblem): │ │ │ │ │ - self.shutdown_endpoint(exc.attrs) │ │ │ │ │ - else: │ │ │ │ │ - self.shutdown_endpoint(problem='internal-error', │ │ │ │ │ - message=f"[{exc.__class__.__name__}] {exc!s}") │ │ │ │ │ - │ │ │ │ │ - # If .start() is running, we need to make sure it stops running, │ │ │ │ │ - # raising the correct exception. │ │ │ │ │ - if self.init_future is not None and not self.init_future.done(): │ │ │ │ │ - if exc is not None: │ │ │ │ │ - self.init_future.set_exception(exc) │ │ │ │ │ - else: │ │ │ │ │ - self.init_future.cancel() │ │ │ │ │ - │ │ │ │ │ - for callback in self.done_callbacks: │ │ │ │ │ - callback() │ │ │ │ │ - │ │ │ │ │ - def process_exited(self) -> None: │ │ │ │ │ - assert isinstance(self.transport, SubprocessTransport) │ │ │ │ │ - logger.debug('Peer %s exited, status %d', self.__class__.__name__, self.transport.get_returncode()) │ │ │ │ │ - returncode = self.transport.get_returncode() │ │ │ │ │ - assert isinstance(returncode, int) │ │ │ │ │ - self.close(PeerExited(returncode)) │ │ │ │ │ - │ │ │ │ │ - # Forwarding data: from the peer to the router │ │ │ │ │ - def channel_control_received(self, channel: str, command: str, message: JsonObject) -> None: │ │ │ │ │ - if self.init_future is not None: │ │ │ │ │ - raise CockpitProtocolError('Received unexpected channel control message before init') │ │ │ │ │ - self.send_channel_control(channel, command, message) │ │ │ │ │ - │ │ │ │ │ - def channel_data_received(self, channel: str, data: bytes) -> None: │ │ │ │ │ - if self.init_future is not None: │ │ │ │ │ - raise CockpitProtocolError('Received unexpected channel data before init') │ │ │ │ │ - self.send_channel_data(channel, data) │ │ │ │ │ - │ │ │ │ │ - # Forwarding data: from the router to the peer │ │ │ │ │ - def do_channel_control(self, channel: str, command: str, message: JsonObject) -> None: │ │ │ │ │ - assert self.init_future is None │ │ │ │ │ - self.write_control(message) │ │ │ │ │ - │ │ │ │ │ - def do_channel_data(self, channel: str, data: bytes) -> None: │ │ │ │ │ - assert self.init_future is None │ │ │ │ │ - self.write_channel_data(channel, data) │ │ │ │ │ - │ │ │ │ │ - def do_kill(self, host: 'str | None', group: 'str | None', message: JsonObject) -> None: │ │ │ │ │ - assert self.init_future is None │ │ │ │ │ - self.write_control(message) │ │ │ │ │ - │ │ │ │ │ - def do_close(self) -> None: │ │ │ │ │ - self.close() │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -class ConfiguredPeer(Peer): │ │ │ │ │ - config: BridgeConfig │ │ │ │ │ - args: Sequence[str] │ │ │ │ │ - env: Sequence[str] │ │ │ │ │ - │ │ │ │ │ - def __init__(self, router: Router, config: BridgeConfig): │ │ │ │ │ - self.config = config │ │ │ │ │ - self.args = config.spawn │ │ │ │ │ - self.env = config.environ │ │ │ │ │ - super().__init__(router) │ │ │ │ │ - │ │ │ │ │ - async def do_connect_transport(self) -> None: │ │ │ │ │ - await self.spawn(self.args, self.env) │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -class PeerRoutingRule(RoutingRule): │ │ │ │ │ - config: BridgeConfig │ │ │ │ │ - match: JsonObject │ │ │ │ │ - peer: Optional[Peer] │ │ │ │ │ - │ │ │ │ │ - def __init__(self, router: Router, config: BridgeConfig): │ │ │ │ │ - super().__init__(router) │ │ │ │ │ - self.config = config │ │ │ │ │ - self.match = config.match │ │ │ │ │ - self.peer = None │ │ │ │ │ - │ │ │ │ │ - def apply_rule(self, options: JsonObject) -> Optional[Peer]: │ │ │ │ │ - # Check that we match │ │ │ │ │ - │ │ │ │ │ - for key, value in self.match.items(): │ │ │ │ │ - if key not in options: │ │ │ │ │ - logger.debug(' rejecting because key %s is missing', key) │ │ │ │ │ - return None │ │ │ │ │ - if value is not None and options[key] != value: │ │ │ │ │ - logger.debug(' rejecting because key %s has wrong value %s (vs %s)', key, options[key], value) │ │ │ │ │ - return None │ │ │ │ │ - │ │ │ │ │ - # Start the peer if it's not running already │ │ │ │ │ - if self.peer is None: │ │ │ │ │ - self.peer = ConfiguredPeer(self.router, self.config) │ │ │ │ │ - self.peer.add_done_callback(self.peer_closed) │ │ │ │ │ - assert self.router.init_host │ │ │ │ │ - self.peer.start_in_background(init_host=self.router.init_host) │ │ │ │ │ - │ │ │ │ │ - return self.peer │ │ │ │ │ - │ │ │ │ │ - def peer_closed(self): │ │ │ │ │ - self.peer = None │ │ │ │ │ - │ │ │ │ │ - def shutdown(self): │ │ │ │ │ - if self.peer is not None: │ │ │ │ │ - self.peer.close() │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -class PeersRoutingRule(RoutingRule): │ │ │ │ │ - rules: List[PeerRoutingRule] = [] │ │ │ │ │ - │ │ │ │ │ - def apply_rule(self, options: JsonObject) -> Optional[Endpoint]: │ │ │ │ │ - logger.debug(' considering %d rules', len(self.rules)) │ │ │ │ │ - for rule in self.rules: │ │ │ │ │ - logger.debug(' considering %s', rule.config.name) │ │ │ │ │ - endpoint = rule.apply_rule(options) │ │ │ │ │ - if endpoint is not None: │ │ │ │ │ - logger.debug(' selected') │ │ │ │ │ - return endpoint │ │ │ │ │ - logger.debug(' no peer rules matched') │ │ │ │ │ - return None │ │ │ │ │ - │ │ │ │ │ - def set_configs(self, bridge_configs: Sequence[BridgeConfig]) -> None: │ │ │ │ │ - old_rules = self.rules │ │ │ │ │ - self.rules = [] │ │ │ │ │ - │ │ │ │ │ - for config in bridge_configs: │ │ │ │ │ - # Those are handled elsewhere... │ │ │ │ │ - if config.privileged or 'host' in config.match: │ │ │ │ │ - continue │ │ │ │ │ - │ │ │ │ │ - # Try to reuse an existing rule, if one exists... │ │ │ │ │ - for rule in list(old_rules): │ │ │ │ │ - if rule.config == config: │ │ │ │ │ - old_rules.remove(rule) │ │ │ │ │ - break │ │ │ │ │ - else: │ │ │ │ │ - # ... otherwise, create a new one. │ │ │ │ │ - rule = PeerRoutingRule(self.router, config) │ │ │ │ │ - │ │ │ │ │ - self.rules.append(rule) │ │ │ │ │ - │ │ │ │ │ - # close down the old rules that didn't get reclaimed │ │ │ │ │ - for rule in old_rules: │ │ │ │ │ - rule.shutdown() │ │ │ │ │ - │ │ │ │ │ - def shutdown(self): │ │ │ │ │ - for rule in self.rules: │ │ │ │ │ - rule.shutdown() │ │ │ │ │ -'''.encode('utf-8'), │ │ │ │ │ - 'cockpit/internal_endpoints.py': br'''# This file is part of Cockpit. │ │ │ │ │ -# │ │ │ │ │ -# Copyright (C) 2022 Red Hat, Inc. │ │ │ │ │ -# │ │ │ │ │ -# This program is free software: you can redistribute it and/or modify │ │ │ │ │ -# it under the terms of the GNU General Public License as published by │ │ │ │ │ -# the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ -# (at your option) any later version. │ │ │ │ │ -# │ │ │ │ │ -# This program is distributed in the hope that it will be useful, │ │ │ │ │ -# but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ -# GNU General Public License for more details. │ │ │ │ │ -# │ │ │ │ │ -# You should have received a copy of the GNU General Public License │ │ │ │ │ -# along with this program. If not, see . │ │ │ │ │ - │ │ │ │ │ -import asyncio │ │ │ │ │ -import glob │ │ │ │ │ -import grp │ │ │ │ │ -import json │ │ │ │ │ -import logging │ │ │ │ │ -import os │ │ │ │ │ -import pwd │ │ │ │ │ -from pathlib import Path │ │ │ │ │ -from typing import Dict, Optional │ │ │ │ │ - │ │ │ │ │ -from cockpit._vendor.systemd_ctypes import Variant, bus, inotify, pathwatch │ │ │ │ │ - │ │ │ │ │ -from . import config │ │ │ │ │ - │ │ │ │ │ -logger = logging.getLogger(__name__) │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -class cockpit_LoginMessages(bus.Object): │ │ │ │ │ - messages: Optional[str] = None │ │ │ │ │ - │ │ │ │ │ - def __init__(self): │ │ │ │ │ - fdstr = os.environ.pop('COCKPIT_LOGIN_MESSAGES_MEMFD', None) │ │ │ │ │ - if fdstr is None: │ │ │ │ │ - logger.debug("COCKPIT_LOGIN_MESSAGES_MEMFD wasn't set. No login messages today.") │ │ │ │ │ - return │ │ │ │ │ - │ │ │ │ │ - logger.debug("Trying to read login messages from fd %s", fdstr) │ │ │ │ │ - try: │ │ │ │ │ - with open(int(fdstr), 'r') as login_messages: │ │ │ │ │ - login_messages.seek(0) │ │ │ │ │ - self.messages = login_messages.read() │ │ │ │ │ - except (ValueError, OSError, UnicodeDecodeError) as exc: │ │ │ │ │ - # ValueError - the envvar wasn't an int │ │ │ │ │ - # OSError - the fd wasn't open, or other read failure │ │ │ │ │ - # UnicodeDecodeError - didn't contain utf-8 │ │ │ │ │ - # For all of these, we simply failed to get the message. │ │ │ │ │ - logger.debug("Reading login messages failed: %s", exc) │ │ │ │ │ - else: │ │ │ │ │ - logger.debug("Successfully read login messages: %s", self.messages) │ │ │ │ │ - │ │ │ │ │ - @bus.Interface.Method(out_types=['s']) │ │ │ │ │ - def get(self): │ │ │ │ │ - return self.messages or '{}' │ │ │ │ │ - │ │ │ │ │ - @bus.Interface.Method(out_types=[]) │ │ │ │ │ - def dismiss(self): │ │ │ │ │ - self.messages = None │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -class cockpit_Machines(bus.Object): │ │ │ │ │ - path: Path │ │ │ │ │ - watch: pathwatch.PathWatch │ │ │ │ │ - pending_notify: Optional[asyncio.Handle] │ │ │ │ │ - │ │ │ │ │ - # D-Bus implementation │ │ │ │ │ - machines = bus.Interface.Property('a{sa{sv}}') │ │ │ │ │ - │ │ │ │ │ - @machines.getter │ │ │ │ │ - def get_machines(self) -> Dict[str, Dict[str, Variant]]: │ │ │ │ │ - results: Dict[str, Dict[str, Variant]] = {} │ │ │ │ │ - │ │ │ │ │ - for filename in glob.glob(f'{self.path}/*.json'): │ │ │ │ │ - with open(filename) as fp: │ │ │ │ │ - try: │ │ │ │ │ - contents = json.load(fp) │ │ │ │ │ - except json.JSONDecodeError: │ │ │ │ │ - logger.warning('Invalid JSON in file %s. Ignoring.', filename) │ │ │ │ │ - continue │ │ │ │ │ - # merge │ │ │ │ │ - for hostname, attrs in contents.items(): │ │ │ │ │ - results[hostname] = {key: Variant(value) for key, value in attrs.items()} │ │ │ │ │ - │ │ │ │ │ - return results │ │ │ │ │ - │ │ │ │ │ - @bus.Interface.Method(in_types=['s', 's', 'a{sv}']) │ │ │ │ │ - def update(self, filename: str, hostname: str, attrs: Dict[str, Variant]) -> None: │ │ │ │ │ - try: │ │ │ │ │ - with self.path.joinpath(filename).open() as fp: │ │ │ │ │ - contents = json.load(fp) │ │ │ │ │ - except json.JSONDecodeError as exc: │ │ │ │ │ - # Refuse to replace corrupted file │ │ │ │ │ - raise bus.BusError('cockpit.Machines.Error', f'File {filename} is in invalid format: {exc}.') from exc │ │ │ │ │ - except FileNotFoundError: │ │ │ │ │ - # But an empty file is an expected case │ │ │ │ │ - contents = {} │ │ │ │ │ - │ │ │ │ │ - contents.setdefault(hostname, {}).update({key: value.value for key, value in attrs.items()}) │ │ │ │ │ - │ │ │ │ │ - self.path.mkdir(parents=True, exist_ok=True) │ │ │ │ │ - with open(self.path.joinpath(filename), 'w') as fp: │ │ │ │ │ - json.dump(contents, fp, indent=2) │ │ │ │ │ - │ │ │ │ │ - def notify(self): │ │ │ │ │ - def _notify_now(): │ │ │ │ │ - self.properties_changed('cockpit.Machines', {}, ['Machines']) │ │ │ │ │ - self.pending_notify = None │ │ │ │ │ - │ │ │ │ │ - # avoid a flurry of update notifications │ │ │ │ │ - if self.pending_notify is None: │ │ │ │ │ - self.pending_notify = asyncio.get_running_loop().call_later(1.0, _notify_now) │ │ │ │ │ - │ │ │ │ │ - # inotify events │ │ │ │ │ - def do_inotify_event(self, mask: inotify.Event, cookie: int, name: Optional[str]) -> None: │ │ │ │ │ - self.notify() │ │ │ │ │ - │ │ │ │ │ - def do_identity_changed(self, fd: Optional[int], errno: Optional[int]) -> None: │ │ │ │ │ - self.notify() │ │ │ │ │ - │ │ │ │ │ - def __init__(self): │ │ │ │ │ - self.path = config.lookup_config('machines.d') │ │ │ │ │ - │ │ │ │ │ - # ignore the first callback │ │ │ │ │ - self.pending_notify = ... │ │ │ │ │ - self.watch = pathwatch.PathWatch(str(self.path), self) │ │ │ │ │ - self.pending_notify = None │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -class cockpit_User(bus.Object): │ │ │ │ │ - name = bus.Interface.Property('s', value='') │ │ │ │ │ - full = bus.Interface.Property('s', value='') │ │ │ │ │ - id = bus.Interface.Property('i', value=0) │ │ │ │ │ - home = bus.Interface.Property('s', value='') │ │ │ │ │ - shell = bus.Interface.Property('s', value='') │ │ │ │ │ - groups = bus.Interface.Property('as', value=[]) │ │ │ │ │ - │ │ │ │ │ - def __init__(self): │ │ │ │ │ - user = pwd.getpwuid(os.getuid()) │ │ │ │ │ - self.name = user.pw_name │ │ │ │ │ - self.full = user.pw_gecos │ │ │ │ │ - self.id = user.pw_uid │ │ │ │ │ - self.home = user.pw_dir │ │ │ │ │ - self.shell = user.pw_shell │ │ │ │ │ - self.groups = [gr.gr_name for gr in grp.getgrall() if user.pw_name in gr.gr_mem] │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -EXPORTS = [ │ │ │ │ │ - ('/LoginMessages', cockpit_LoginMessages), │ │ │ │ │ - ('/machines', cockpit_Machines), │ │ │ │ │ - ('/user', cockpit_User), │ │ │ │ │ -] │ │ │ │ │ -''', │ │ │ │ │ - 'cockpit/polyfills.py': br'''# This file is part of Cockpit. │ │ │ │ │ -# │ │ │ │ │ -# Copyright (C) 2023 Red Hat, Inc. │ │ │ │ │ -# │ │ │ │ │ -# This program is free software: you can redistribute it and/or modify │ │ │ │ │ -# it under the terms of the GNU General Public License as published by │ │ │ │ │ -# the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ -# (at your option) any later version. │ │ │ │ │ -# │ │ │ │ │ -# This program is distributed in the hope that it will be useful, │ │ │ │ │ -# but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ -# GNU General Public License for more details. │ │ │ │ │ -# │ │ │ │ │ -# You should have received a copy of the GNU General Public License │ │ │ │ │ -# along with this program. If not, see . │ │ │ │ │ - │ │ │ │ │ -import contextlib │ │ │ │ │ -import socket │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -def install(): │ │ │ │ │ - """Add shims for older Python versions""" │ │ │ │ │ - │ │ │ │ │ - # introduced in 3.9 │ │ │ │ │ - if not hasattr(socket, 'recv_fds'): │ │ │ │ │ - import array │ │ │ │ │ - │ │ │ │ │ - import _socket │ │ │ │ │ - │ │ │ │ │ - def recv_fds(sock, bufsize, maxfds, flags=0): │ │ │ │ │ - fds = array.array("i") │ │ │ │ │ - msg, ancdata, flags, addr = sock.recvmsg(bufsize, _socket.CMSG_LEN(maxfds * fds.itemsize)) │ │ │ │ │ - for cmsg_level, cmsg_type, cmsg_data in ancdata: │ │ │ │ │ - if (cmsg_level == _socket.SOL_SOCKET and cmsg_type == _socket.SCM_RIGHTS): │ │ │ │ │ - fds.frombytes(cmsg_data[:len(cmsg_data) - (len(cmsg_data) % fds.itemsize)]) │ │ │ │ │ - return msg, list(fds), flags, addr │ │ │ │ │ - │ │ │ │ │ - socket.recv_fds = recv_fds │ │ │ │ │ - │ │ │ │ │ - # introduced in 3.7 │ │ │ │ │ - if not hasattr(contextlib, 'AsyncExitStack'): │ │ │ │ │ - class AsyncExitStack: │ │ │ │ │ - async def __aenter__(self): │ │ │ │ │ - self.cms = [] │ │ │ │ │ - return self │ │ │ │ │ - │ │ │ │ │ - async def enter_async_context(self, cm): │ │ │ │ │ - result = await cm.__aenter__() │ │ │ │ │ - self.cms.append(cm) │ │ │ │ │ - return result │ │ │ │ │ - │ │ │ │ │ - async def __aexit__(self, exc_type, exc_value, traceback): │ │ │ │ │ - for cm in self.cms: │ │ │ │ │ - cm.__aexit__(exc_type, exc_value, traceback) │ │ │ │ │ - │ │ │ │ │ - contextlib.AsyncExitStack = AsyncExitStack │ │ │ │ │ -''', │ │ │ │ │ - 'cockpit/jsonutil.py': r'''# This file is part of Cockpit. │ │ │ │ │ -# │ │ │ │ │ -# Copyright (C) 2023 Red Hat, Inc. │ │ │ │ │ -# │ │ │ │ │ -# This program is free software: you can redistribute it and/or modify │ │ │ │ │ -# it under the terms of the GNU General Public License as published by │ │ │ │ │ -# the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ -# (at your option) any later version. │ │ │ │ │ -# │ │ │ │ │ -# This program is distributed in the hope that it will be useful, │ │ │ │ │ -# but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ -# GNU General Public License for more details. │ │ │ │ │ -# │ │ │ │ │ -# You should have received a copy of the GNU General Public License │ │ │ │ │ -# along with this program. If not, see . │ │ │ │ │ - │ │ │ │ │ -from enum import Enum │ │ │ │ │ -from typing import Callable, Container, Dict, List, Mapping, Optional, Sequence, Type, TypeVar, Union │ │ │ │ │ - │ │ │ │ │ -JsonLiteral = Union[str, float, bool, None] │ │ │ │ │ - │ │ │ │ │ -# immutable │ │ │ │ │ -JsonValue = Union['JsonObject', Sequence['JsonValue'], JsonLiteral] │ │ │ │ │ -JsonObject = Mapping[str, JsonValue] │ │ │ │ │ - │ │ │ │ │ -# mutable │ │ │ │ │ -JsonDocument = Union['JsonDict', 'JsonList', JsonLiteral] │ │ │ │ │ -JsonDict = Dict[str, JsonDocument] │ │ │ │ │ -JsonList = List[JsonDocument] │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -DT = TypeVar('DT') │ │ │ │ │ -T = TypeVar('T') │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -class JsonError(Exception): │ │ │ │ │ - value: object │ │ │ │ │ - │ │ │ │ │ - def __init__(self, value: object, msg: str): │ │ │ │ │ - super().__init__(msg) │ │ │ │ │ - self.value = value │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -def typechecked(value: JsonValue, expected_type: Type[T]) -> T: │ │ │ │ │ - """Ensure a JSON value has the expected type, returning it if so.""" │ │ │ │ │ - if not isinstance(value, expected_type): │ │ │ │ │ - raise JsonError(value, f'must have type {expected_type.__name__}') │ │ │ │ │ - return value │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -# We can't use None as a sentinel because it's often the actual default value │ │ │ │ │ -# EllipsisType is difficult because it's not available before 3.10. │ │ │ │ │ -# See https://peps.python.org/pep-0484/#support-for-singleton-types-in-unions │ │ │ │ │ -class _Empty(Enum): │ │ │ │ │ - TOKEN = 0 │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -_empty = _Empty.TOKEN │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -def _get(obj: JsonObject, cast: Callable[[JsonValue], T], key: str, default: Union[DT, _Empty]) -> Union[T, DT]: │ │ │ │ │ - try: │ │ │ │ │ - return cast(obj[key]) │ │ │ │ │ - except KeyError: │ │ │ │ │ - if default is not _empty: │ │ │ │ │ - return default │ │ │ │ │ - raise JsonError(obj, f"attribute '{key}' required") from None │ │ │ │ │ - except JsonError as exc: │ │ │ │ │ - target = f"attribute '{key}'" + (' elements:' if exc.value is not obj[key] else ':') │ │ │ │ │ - raise JsonError(obj, f"{target} {exc!s}") from exc │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -def get_bool(obj: JsonObject, key: str, default: Union[DT, _Empty] = _empty) -> Union[DT, bool]: │ │ │ │ │ - return _get(obj, lambda v: typechecked(v, bool), key, default) │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -def get_int(obj: JsonObject, key: str, default: Union[DT, _Empty] = _empty) -> Union[DT, int]: │ │ │ │ │ - return _get(obj, lambda v: typechecked(v, int), key, default) │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -def get_str(obj: JsonObject, key: str, default: Union[DT, _Empty] = _empty) -> Union[DT, str]: │ │ │ │ │ - return _get(obj, lambda v: typechecked(v, str), key, default) │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -def get_str_or_none(obj: JsonObject, key: str, default: Optional[str]) -> Optional[str]: │ │ │ │ │ - return _get(obj, lambda v: None if v is None else typechecked(v, str), key, default) │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -def get_dict(obj: JsonObject, key: str, default: Union[DT, _Empty] = _empty) -> Union[DT, JsonObject]: │ │ │ │ │ - return _get(obj, lambda v: typechecked(v, dict), key, default) │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -def get_object( │ │ │ │ │ - obj: JsonObject, │ │ │ │ │ - key: str, │ │ │ │ │ - constructor: Callable[[JsonObject], T], │ │ │ │ │ - default: Union[DT, _Empty] = _empty │ │ │ │ │ -) -> Union[DT, T]: │ │ │ │ │ - return _get(obj, lambda v: constructor(typechecked(v, dict)), key, default) │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -def get_strv(obj: JsonObject, key: str, default: Union[DT, _Empty] = _empty) -> Union[DT, Sequence[str]]: │ │ │ │ │ - def as_strv(value: JsonValue) -> Sequence[str]: │ │ │ │ │ - return tuple(typechecked(item, str) for item in typechecked(value, list)) │ │ │ │ │ - return _get(obj, as_strv, key, default) │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -def get_enum( │ │ │ │ │ - obj: JsonObject, key: str, choices: Container[str], default: Union[DT, _Empty] = _empty │ │ │ │ │ -) -> Union[DT, str]: │ │ │ │ │ - def as_choice(value: JsonValue) -> str: │ │ │ │ │ - # mypy can't do `__eq__()`-based type narrowing... │ │ │ │ │ - # https://github.com/python/mypy/issues/17101 │ │ │ │ │ - if isinstance(value, str) and value in choices: │ │ │ │ │ - return value │ │ │ │ │ - raise JsonError(value, f'invalid value "{value}" not in {choices}') │ │ │ │ │ - return _get(obj, as_choice, key, default) │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -def get_objv(obj: JsonObject, key: str, constructor: Callable[[JsonObject], T]) -> Union[DT, Sequence[T]]: │ │ │ │ │ - def as_objv(value: JsonValue) -> Sequence[T]: │ │ │ │ │ - return tuple(constructor(typechecked(item, dict)) for item in typechecked(value, list)) │ │ │ │ │ - return _get(obj, as_objv, key, ()) │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -def create_object(message: 'JsonObject | None', kwargs: JsonObject) -> JsonObject: │ │ │ │ │ - """Constructs a JSON object based on message and kwargs. │ │ │ │ │ - │ │ │ │ │ - If only message is given, it is returned, unmodified. If message is None, │ │ │ │ │ - it is equivalent to an empty dictionary. A copy is always made. │ │ │ │ │ - │ │ │ │ │ - If kwargs are present, then any underscore ('_') present in a key name is │ │ │ │ │ - rewritten to a dash ('-'). This is intended to bridge between the required │ │ │ │ │ - Python syntax when providing kwargs and idiomatic JSON (which uses '-' for │ │ │ │ │ - attributes). These values override values in message. │ │ │ │ │ - │ │ │ │ │ - The idea is that `message` should be used for passing data along, and │ │ │ │ │ - kwargs used for data originating at a given call site, possibly including │ │ │ │ │ - modifications to an original message. │ │ │ │ │ - """ │ │ │ │ │ - result = dict(message or {}) │ │ │ │ │ - │ │ │ │ │ - for key, value in kwargs.items(): │ │ │ │ │ - # rewrite '_' (necessary in Python syntax kwargs list) to '-' (idiomatic JSON) │ │ │ │ │ - json_key = key.replace('_', '-') │ │ │ │ │ - result[json_key] = value │ │ │ │ │ - │ │ │ │ │ - return result │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -def json_merge_patch(current: JsonObject, patch: JsonObject) -> JsonObject: │ │ │ │ │ - """Perform a JSON merge patch (RFC 7396) using 'current' and 'patch'. │ │ │ │ │ - Neither of the original dictionaries is modified — the result is returned. │ │ │ │ │ - """ │ │ │ │ │ - # Always take a copy ('result') — we never modify the input ('current') │ │ │ │ │ - result = dict(current) │ │ │ │ │ - for key, patch_value in patch.items(): │ │ │ │ │ - if isinstance(patch_value, Mapping): │ │ │ │ │ - current_value = current.get(key, None) │ │ │ │ │ - if not isinstance(current_value, Mapping): │ │ │ │ │ - current_value = {} │ │ │ │ │ - result[key] = json_merge_patch(current_value, patch_value) │ │ │ │ │ - elif patch_value is not None: │ │ │ │ │ - result[key] = patch_value │ │ │ │ │ - else: │ │ │ │ │ - result.pop(key, None) │ │ │ │ │ - │ │ │ │ │ - return result │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -def json_merge_and_filter_patch(current: JsonDict, patch: JsonDict) -> None: │ │ │ │ │ - """Perform a JSON merge patch (RFC 7396) modifying 'current' with 'patch'. │ │ │ │ │ - Also modifies 'patch' to remove redundant operations. │ │ │ │ │ - """ │ │ │ │ │ - for key, patch_value in tuple(patch.items()): │ │ │ │ │ - current_value = current.get(key, None) │ │ │ │ │ - │ │ │ │ │ - if isinstance(patch_value, dict): │ │ │ │ │ - if not isinstance(current_value, dict): │ │ │ │ │ - current[key] = current_value = {} │ │ │ │ │ - json_merge_and_filter_patch(current_value, patch_value) │ │ │ │ │ - else: │ │ │ │ │ - json_merge_and_filter_patch(current_value, patch_value) │ │ │ │ │ - if not patch_value: │ │ │ │ │ - del patch[key] │ │ │ │ │ - elif current_value == patch_value: │ │ │ │ │ - del patch[key] │ │ │ │ │ - elif patch_value is not None: │ │ │ │ │ - current[key] = patch_value │ │ │ │ │ - else: │ │ │ │ │ - del current[key] │ │ │ │ │ -'''.encode('utf-8'), │ │ │ │ │ - 'cockpit/__init__.py': br'''from ._version import __version__ │ │ │ │ │ - │ │ │ │ │ -__all__ = ( │ │ │ │ │ - '__version__', │ │ │ │ │ -) │ │ │ │ │ -''', │ │ │ │ │ 'cockpit/polkit.py': r'''# This file is part of Cockpit. │ │ │ │ │ # │ │ │ │ │ # Copyright (C) 2023 Red Hat, Inc. │ │ │ │ │ # │ │ │ │ │ # This program is free software: you can redistribute it and/or modify │ │ │ │ │ # it under the terms of the GNU General Public License as published by │ │ │ │ │ # the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ @@ -2846,15 +2736,15 @@ │ │ │ │ │ 'org.freedesktop.PolicyKit1.Authority', │ │ │ │ │ 'UnregisterAuthenticationAgent', │ │ │ │ │ '(sa{sv})s', │ │ │ │ │ self.subject, AGENT_DBUS_PATH) │ │ │ │ │ self.agent_slot.cancel() │ │ │ │ │ logger.debug('Unregistered agent for %r', self.subject) │ │ │ │ │ '''.encode('utf-8'), │ │ │ │ │ - 'cockpit/beiboot.py': br'''# This file is part of Cockpit. │ │ │ │ │ + 'cockpit/remote.py': r'''# This file is part of Cockpit. │ │ │ │ │ # │ │ │ │ │ # Copyright (C) 2022 Red Hat, Inc. │ │ │ │ │ # │ │ │ │ │ # This program is free software: you can redistribute it and/or modify │ │ │ │ │ # it under the terms of the GNU General Public License as published by │ │ │ │ │ # the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ # (at your option) any later version. │ │ │ │ │ @@ -2863,350 +2753,231 @@ │ │ │ │ │ # but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ # GNU General Public License for more details. │ │ │ │ │ # │ │ │ │ │ # You should have received a copy of the GNU General Public License │ │ │ │ │ # along with this program. If not, see . │ │ │ │ │ │ │ │ │ │ -import argparse │ │ │ │ │ -import asyncio │ │ │ │ │ -import base64 │ │ │ │ │ -import importlib.resources │ │ │ │ │ +import getpass │ │ │ │ │ import logging │ │ │ │ │ -import os │ │ │ │ │ -import shlex │ │ │ │ │ -from pathlib import Path │ │ │ │ │ -from typing import Dict, Iterable, Optional, Sequence │ │ │ │ │ +import re │ │ │ │ │ +import socket │ │ │ │ │ +from typing import Dict, List, Optional, Tuple │ │ │ │ │ │ │ │ │ │ -from cockpit import polyfills │ │ │ │ │ from cockpit._vendor import ferny │ │ │ │ │ -from cockpit._vendor.bei import bootloader │ │ │ │ │ -from cockpit.beipack import BridgeBeibootHelper │ │ │ │ │ -from cockpit.bridge import setup_logging │ │ │ │ │ -from cockpit.channel import ChannelRoutingRule │ │ │ │ │ -from cockpit.channels import PackagesChannel │ │ │ │ │ -from cockpit.jsonutil import JsonObject │ │ │ │ │ -from cockpit.packages import Packages, PackagesLoader, patch_libexecdir │ │ │ │ │ -from cockpit.peer import Peer │ │ │ │ │ -from cockpit.protocol import CockpitProblem │ │ │ │ │ -from cockpit.router import Router, RoutingRule │ │ │ │ │ -from cockpit.transports import StdioTransport │ │ │ │ │ - │ │ │ │ │ -logger = logging.getLogger('cockpit.beiboot') │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -def ensure_ferny_askpass() -> Path: │ │ │ │ │ - """Create askpass executable │ │ │ │ │ - │ │ │ │ │ - We need this for the flatpak: ssh and thus the askpass program run on the host (via flatpak-spawn), │ │ │ │ │ - not the flatpak. Thus we cannot use the shipped cockpit-askpass program. │ │ │ │ │ - """ │ │ │ │ │ - src_path = importlib.resources.files(ferny.__name__) / 'interaction_client.py' │ │ │ │ │ - src_data = src_path.read_bytes() │ │ │ │ │ - │ │ │ │ │ - # Create the file in $XDG_CACHE_HOME, one of the few locations that a flatpak can write to │ │ │ │ │ - xdg_cache_home = os.environ.get('XDG_CACHE_HOME') │ │ │ │ │ - if xdg_cache_home is None: │ │ │ │ │ - xdg_cache_home = os.path.expanduser('~/.cache') │ │ │ │ │ - os.makedirs(xdg_cache_home, exist_ok=True) │ │ │ │ │ - dest_path = Path(xdg_cache_home, 'cockpit-client-askpass') │ │ │ │ │ - │ │ │ │ │ - logger.debug("Checking if %s exists...", dest_path) │ │ │ │ │ - │ │ │ │ │ - # Check first to see if we already wrote the current version │ │ │ │ │ - try: │ │ │ │ │ - if dest_path.read_bytes() != src_data: │ │ │ │ │ - logger.debug(" ... it exists but is not the same version...") │ │ │ │ │ - raise ValueError │ │ │ │ │ - if not dest_path.stat().st_mode & 0o100: │ │ │ │ │ - logger.debug(" ... it has the correct contents, but is not executable...") │ │ │ │ │ - raise ValueError │ │ │ │ │ - except (FileNotFoundError, ValueError): │ │ │ │ │ - logger.debug(" ... writing contents.") │ │ │ │ │ - dest_path.write_bytes(src_data) │ │ │ │ │ - dest_path.chmod(0o700) │ │ │ │ │ - │ │ │ │ │ - return dest_path │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -def get_interesting_files() -> Iterable[str]: │ │ │ │ │ - for manifest in PackagesLoader.load_manifests(): │ │ │ │ │ - for condition in manifest.conditions: │ │ │ │ │ - if condition.name in ('path-exists', 'path-not-exists') and isinstance(condition.value, str): │ │ │ │ │ - yield condition.value │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -class ProxyPackagesLoader(PackagesLoader): │ │ │ │ │ - file_status: Dict[str, bool] │ │ │ │ │ - │ │ │ │ │ - def check_condition(self, condition: str, value: object) -> bool: │ │ │ │ │ - assert isinstance(value, str) │ │ │ │ │ - assert value in self.file_status │ │ │ │ │ - │ │ │ │ │ - if condition == 'path-exists': │ │ │ │ │ - return self.file_status[value] │ │ │ │ │ - elif condition == 'path-not-exists': │ │ │ │ │ - return not self.file_status[value] │ │ │ │ │ - else: │ │ │ │ │ - raise KeyError │ │ │ │ │ - │ │ │ │ │ - def __init__(self, file_status: Dict[str, bool]): │ │ │ │ │ - self.file_status = file_status │ │ │ │ │ - │ │ │ │ │ │ │ │ │ │ -BEIBOOT_GADGETS = { │ │ │ │ │ - "report_exists": r""" │ │ │ │ │ - import os │ │ │ │ │ - def report_exists(files): │ │ │ │ │ - command('cockpit.report-exists', {name: os.path.exists(name) for name in files}) │ │ │ │ │ - """, │ │ │ │ │ - **ferny.BEIBOOT_GADGETS │ │ │ │ │ -} │ │ │ │ │ +from .jsonutil import JsonObject, JsonValue, get_str, get_str_or_none │ │ │ │ │ +from .peer import Peer, PeerError │ │ │ │ │ +from .router import Router, RoutingRule │ │ │ │ │ │ │ │ │ │ +logger = logging.getLogger(__name__) │ │ │ │ │ │ │ │ │ │ -class DefaultRoutingRule(RoutingRule): │ │ │ │ │ - peer: 'Peer | None' │ │ │ │ │ │ │ │ │ │ - def __init__(self, router: Router): │ │ │ │ │ - super().__init__(router) │ │ │ │ │ +class PasswordResponder(ferny.AskpassHandler): │ │ │ │ │ + PASSPHRASE_RE = re.compile(r"Enter passphrase for key '(.*)': ") │ │ │ │ │ │ │ │ │ │ - def apply_rule(self, options: JsonObject) -> 'Peer | None': │ │ │ │ │ - return self.peer │ │ │ │ │ + password: Optional[str] │ │ │ │ │ │ │ │ │ │ - def shutdown(self) -> None: │ │ │ │ │ - if self.peer is not None: │ │ │ │ │ - self.peer.close() │ │ │ │ │ + hostkeys_seen: List[Tuple[str, str, str, str, str]] │ │ │ │ │ + error_message: Optional[str] │ │ │ │ │ + password_attempts: int │ │ │ │ │ │ │ │ │ │ + def __init__(self, password: Optional[str]): │ │ │ │ │ + self.password = password │ │ │ │ │ │ │ │ │ │ -class AuthorizeResponder(ferny.AskpassHandler): │ │ │ │ │ - commands = ('ferny.askpass', 'cockpit.report-exists') │ │ │ │ │ - router: Router │ │ │ │ │ + self.hostkeys_seen = [] │ │ │ │ │ + self.error_message = None │ │ │ │ │ + self.password_attempts = 0 │ │ │ │ │ │ │ │ │ │ - def __init__(self, router: Router): │ │ │ │ │ - self.router = router │ │ │ │ │ + async def do_hostkey(self, reason: str, host: str, algorithm: str, key: str, fingerprint: str) -> bool: │ │ │ │ │ + self.hostkeys_seen.append((reason, host, algorithm, key, fingerprint)) │ │ │ │ │ + return False │ │ │ │ │ │ │ │ │ │ async def do_askpass(self, messages: str, prompt: str, hint: str) -> Optional[str]: │ │ │ │ │ - if hint == 'none': │ │ │ │ │ - # We have three problems here: │ │ │ │ │ - # │ │ │ │ │ - # - we have no way to present a message on the login │ │ │ │ │ - # screen without presenting a prompt and a button │ │ │ │ │ - # - the login screen will not try to repost the login │ │ │ │ │ - # request because it doesn't understand that we are not │ │ │ │ │ - # waiting on input, which means that it won't notice │ │ │ │ │ - # that we've logged in successfully │ │ │ │ │ - # - cockpit-ws has an issue where if we retry the request │ │ │ │ │ - # again after login succeeded then it won't forward the │ │ │ │ │ - # init message to the client, stalling the login. This │ │ │ │ │ - # is a race and can't be fixed without -ws changes. │ │ │ │ │ - # │ │ │ │ │ - # Let's avoid all of that by just showing nothing. │ │ │ │ │ - return None │ │ │ │ │ - │ │ │ │ │ - challenge = 'X-Conversation - ' + base64.b64encode(prompt.encode()).decode() │ │ │ │ │ - response = await self.router.request_authorization(challenge, │ │ │ │ │ - messages=messages, │ │ │ │ │ - prompt=prompt, │ │ │ │ │ - hint=hint, │ │ │ │ │ - echo=False) │ │ │ │ │ - │ │ │ │ │ - b64 = response.removeprefix('X-Conversation -').strip() │ │ │ │ │ - response = base64.b64decode(b64.encode()).decode() │ │ │ │ │ - logger.debug('Returning a %d chars response', len(response)) │ │ │ │ │ - return response │ │ │ │ │ + logger.debug('Got askpass(%s): %s', hint, prompt) │ │ │ │ │ │ │ │ │ │ - async def do_custom_command(self, command: str, args: tuple, fds: list[int], stderr: str) -> None: │ │ │ │ │ - logger.debug('Got ferny command %s %s %s', command, args, stderr) │ │ │ │ │ + match = PasswordResponder.PASSPHRASE_RE.fullmatch(prompt) │ │ │ │ │ + if match is not None: │ │ │ │ │ + # We never unlock private keys — we rather need to throw a │ │ │ │ │ + # specially-formatted error message which will cause the frontend │ │ │ │ │ + # to load the named key into the agent for us and try again. │ │ │ │ │ + path = match.group(1) │ │ │ │ │ + logger.debug("This is a passphrase request for %s, but we don't do those. Abort.", path) │ │ │ │ │ + self.error_message = f'locked identity: {path}' │ │ │ │ │ + return None │ │ │ │ │ │ │ │ │ │ - if command == 'cockpit.report-exists': │ │ │ │ │ - file_status, = args │ │ │ │ │ - # FIXME: evil duck typing here -- this is a half-way Bridge │ │ │ │ │ - self.router.packages = Packages(loader=ProxyPackagesLoader(file_status)) # type: ignore[attr-defined] │ │ │ │ │ - self.router.routing_rules.insert(0, ChannelRoutingRule(self.router, [PackagesChannel])) │ │ │ │ │ + assert self.password is not None │ │ │ │ │ + assert self.password_attempts == 0 │ │ │ │ │ + self.password_attempts += 1 │ │ │ │ │ + return self.password │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ class SshPeer(Peer): │ │ │ │ │ - always: bool │ │ │ │ │ - │ │ │ │ │ - def __init__(self, router: Router, destination: str, args: argparse.Namespace): │ │ │ │ │ - self.destination = destination │ │ │ │ │ - self.always = args.always │ │ │ │ │ - super().__init__(router) │ │ │ │ │ + session: Optional[ferny.Session] = None │ │ │ │ │ + host: str │ │ │ │ │ + user: Optional[str] │ │ │ │ │ + password: Optional[str] │ │ │ │ │ + private: bool │ │ │ │ │ │ │ │ │ │ async def do_connect_transport(self) -> None: │ │ │ │ │ - beiboot_helper = BridgeBeibootHelper(self) │ │ │ │ │ + assert self.session is not None │ │ │ │ │ + logger.debug('Starting ssh session user=%s, host=%s, private=%s', self.user, self.host, self.private) │ │ │ │ │ │ │ │ │ │ - agent = ferny.InteractionAgent([AuthorizeResponder(self.router), beiboot_helper]) │ │ │ │ │ + basename, colon, portstr = self.host.rpartition(':') │ │ │ │ │ + if colon and portstr.isdigit(): │ │ │ │ │ + host = basename │ │ │ │ │ + port = int(portstr) │ │ │ │ │ + else: │ │ │ │ │ + host = self.host │ │ │ │ │ + port = None │ │ │ │ │ │ │ │ │ │ - # We want to run a python interpreter somewhere... │ │ │ │ │ - cmd: Sequence[str] = ('python3', '-ic', '# cockpit-bridge') │ │ │ │ │ - env: Sequence[str] = () │ │ │ │ │ + responder = PasswordResponder(self.password) │ │ │ │ │ + options = {"StrictHostKeyChecking": 'yes'} │ │ │ │ │ │ │ │ │ │ - in_flatpak = os.path.exists('/.flatpak-info') │ │ │ │ │ + if self.password is not None: │ │ │ │ │ + options.update(NumberOfPasswordPrompts='1') │ │ │ │ │ + else: │ │ │ │ │ + options.update(PasswordAuthentication="no", KbdInteractiveAuthentication="no") │ │ │ │ │ │ │ │ │ │ - # Remote host? Wrap command with SSH │ │ │ │ │ - if self.destination != 'localhost': │ │ │ │ │ - if in_flatpak: │ │ │ │ │ - # we run ssh and thus the helper on the host, always use the xdg-cache helper │ │ │ │ │ - ssh_askpass = ensure_ferny_askpass() │ │ │ │ │ - else: │ │ │ │ │ - # outside of the flatpak we expect cockpit-ws and thus an installed helper │ │ │ │ │ - askpass = patch_libexecdir('${libexecdir}/cockpit-askpass') │ │ │ │ │ - assert isinstance(askpass, str) │ │ │ │ │ - ssh_askpass = Path(askpass) │ │ │ │ │ - if not ssh_askpass.exists(): │ │ │ │ │ - logger.error("Could not find cockpit-askpass helper at %r", askpass) │ │ │ │ │ + try: │ │ │ │ │ + await self.session.connect(host, login_name=self.user, port=port, │ │ │ │ │ + handle_host_key=self.private, options=options, │ │ │ │ │ + interaction_responder=responder) │ │ │ │ │ + except (OSError, socket.gaierror) as exc: │ │ │ │ │ + logger.debug('connecting to host %s failed: %s', host, exc) │ │ │ │ │ + raise PeerError('no-host', error='no-host', message=str(exc)) from exc │ │ │ │ │ │ │ │ │ │ - env = ( │ │ │ │ │ - f'SSH_ASKPASS={ssh_askpass!s}', │ │ │ │ │ - 'DISPLAY=x', │ │ │ │ │ - 'SSH_ASKPASS_REQUIRE=force', │ │ │ │ │ - ) │ │ │ │ │ - host, _, port = self.destination.rpartition(':') │ │ │ │ │ - # catch cases like `host:123` but not cases like `[2001:abcd::1] │ │ │ │ │ - if port.isdigit(): │ │ │ │ │ - host_args = ['-p', port, host] │ │ │ │ │ + except ferny.SshHostKeyError as exc: │ │ │ │ │ + if responder.hostkeys_seen: │ │ │ │ │ + # If we saw a hostkey then we can issue a detailed error message │ │ │ │ │ + # containing the key that would need to be accepted. That will │ │ │ │ │ + # cause the front-end to present a dialog. │ │ │ │ │ + _reason, host, algorithm, key, fingerprint = responder.hostkeys_seen[0] │ │ │ │ │ + error_args = {'host-key': f'{host} {algorithm} {key}', 'host-fingerprint': fingerprint} │ │ │ │ │ else: │ │ │ │ │ - host_args = [self.destination] │ │ │ │ │ + error_args = {} │ │ │ │ │ │ │ │ │ │ - cmd = ('ssh', *host_args, shlex.join(cmd)) │ │ │ │ │ + if isinstance(exc, ferny.SshChangedHostKeyError): │ │ │ │ │ + error = 'invalid-hostkey' │ │ │ │ │ + elif self.private: │ │ │ │ │ + error = 'unknown-hostkey' │ │ │ │ │ + else: │ │ │ │ │ + # non-private session case. throw a generic error. │ │ │ │ │ + error = 'unknown-host' │ │ │ │ │ │ │ │ │ │ - # Running in flatpak? Wrap command with flatpak-spawn --host │ │ │ │ │ - if in_flatpak: │ │ │ │ │ - cmd = ('flatpak-spawn', '--host', │ │ │ │ │ - *(f'--env={kv}' for kv in env), │ │ │ │ │ - *cmd) │ │ │ │ │ - env = () │ │ │ │ │ + logger.debug('SshPeer got a %s %s; private %s, seen hostkeys %r; raising %s with extra args %r', │ │ │ │ │ + type(exc), exc, self.private, responder.hostkeys_seen, error, error_args) │ │ │ │ │ + raise PeerError(error, error_args, error=error, auth_method_results={}) from exc │ │ │ │ │ │ │ │ │ │ - logger.debug("Launching command: cmd=%s env=%s", cmd, env) │ │ │ │ │ - transport = await self.spawn(cmd, env, stderr=agent, start_new_session=True) │ │ │ │ │ + except ferny.SshAuthenticationError as exc: │ │ │ │ │ + logger.debug('authentication to host %s failed: %s', host, exc) │ │ │ │ │ │ │ │ │ │ - if not self.always: │ │ │ │ │ - exec_cockpit_bridge_steps = [('try_exec', (['cockpit-bridge'],))] │ │ │ │ │ - else: │ │ │ │ │ - exec_cockpit_bridge_steps = [] │ │ │ │ │ + results = dict.fromkeys(exc.methods, "not-provided") │ │ │ │ │ + if 'password' in results and self.password is not None: │ │ │ │ │ + if responder.password_attempts == 0: │ │ │ │ │ + results['password'] = 'not-tried' │ │ │ │ │ + else: │ │ │ │ │ + results['password'] = 'denied' │ │ │ │ │ │ │ │ │ │ - # Send the first-stage bootloader │ │ │ │ │ - stage1 = bootloader.make_bootloader([ │ │ │ │ │ - *exec_cockpit_bridge_steps, │ │ │ │ │ - ('report_exists', [list(get_interesting_files())]), │ │ │ │ │ - *beiboot_helper.steps, │ │ │ │ │ - ], gadgets=BEIBOOT_GADGETS) │ │ │ │ │ - transport.write(stage1.encode()) │ │ │ │ │ + raise PeerError('authentication-failed', │ │ │ │ │ + error=responder.error_message or 'authentication-failed', │ │ │ │ │ + auth_method_results=results) from exc │ │ │ │ │ │ │ │ │ │ - # Wait for "init" or error, handling auth and beiboot requests │ │ │ │ │ - await agent.communicate() │ │ │ │ │ + except ferny.SshError as exc: │ │ │ │ │ + logger.debug('unknown failure connecting to host %s: %s', host, exc) │ │ │ │ │ + raise PeerError('internal-error', message=str(exc)) from exc │ │ │ │ │ │ │ │ │ │ - def transport_control_received(self, command: str, message: JsonObject) -> None: │ │ │ │ │ - if command == 'authorize': │ │ │ │ │ - # We've disabled this for explicit-superuser bridges, but older │ │ │ │ │ - # bridges don't support that and will ask us anyway. │ │ │ │ │ - return │ │ │ │ │ + args = self.session.wrap_subprocess_args(['cockpit-bridge']) │ │ │ │ │ + await self.spawn(args, []) │ │ │ │ │ │ │ │ │ │ - super().transport_control_received(command, message) │ │ │ │ │ + def do_kill(self, host: 'str | None', group: 'str | None', message: JsonObject) -> None: │ │ │ │ │ + if host == self.host: │ │ │ │ │ + self.close() │ │ │ │ │ + elif host is None: │ │ │ │ │ + super().do_kill(host, group, message) │ │ │ │ │ │ │ │ │ │ + def do_authorize(self, message: JsonObject) -> None: │ │ │ │ │ + if get_str(message, 'challenge').startswith('plain1:'): │ │ │ │ │ + cookie = get_str(message, 'cookie') │ │ │ │ │ + self.write_control(command='authorize', cookie=cookie, response=self.password or '') │ │ │ │ │ + self.password = None # once is enough... │ │ │ │ │ │ │ │ │ │ -class SshBridge(Router): │ │ │ │ │ - packages: Optional[Packages] = None │ │ │ │ │ - ssh_peer: SshPeer │ │ │ │ │ + def do_superuser_init_done(self) -> None: │ │ │ │ │ + self.password = None │ │ │ │ │ │ │ │ │ │ - def __init__(self, args: argparse.Namespace): │ │ │ │ │ - # By default, we route everything to the other host. We add an extra │ │ │ │ │ - # routing rule for the packages webserver only if we're running the │ │ │ │ │ - # beipack. │ │ │ │ │ - rule = DefaultRoutingRule(self) │ │ │ │ │ - super().__init__([rule]) │ │ │ │ │ + def __init__(self, router: Router, host: str, user: Optional[str], options: JsonObject, *, private: bool) -> None: │ │ │ │ │ + super().__init__(router) │ │ │ │ │ + self.host = host │ │ │ │ │ + self.user = user │ │ │ │ │ + self.password = get_str(options, 'password', None) │ │ │ │ │ + self.private = private │ │ │ │ │ │ │ │ │ │ - # This needs to be created after Router.__init__ is called. │ │ │ │ │ - self.ssh_peer = SshPeer(self, args.destination, args) │ │ │ │ │ - rule.peer = self.ssh_peer │ │ │ │ │ + self.session = ferny.Session() │ │ │ │ │ │ │ │ │ │ - def do_send_init(self): │ │ │ │ │ - pass # wait for the peer to do it first │ │ │ │ │ + superuser: JsonValue │ │ │ │ │ + init_superuser = get_str_or_none(options, 'init-superuser', None) │ │ │ │ │ + if init_superuser in (None, 'none'): │ │ │ │ │ + superuser = False │ │ │ │ │ + else: │ │ │ │ │ + superuser = {'id': init_superuser} │ │ │ │ │ │ │ │ │ │ - def do_init(self, message): │ │ │ │ │ - # https://github.com/cockpit-project/cockpit/issues/18927 │ │ │ │ │ - # │ │ │ │ │ - # We tell cockpit-ws that we have the explicit-superuser capability and │ │ │ │ │ - # handle it ourselves (just below) by sending `superuser-init-done` and │ │ │ │ │ - # passing {'superuser': False} on to the actual bridge (Python or C). │ │ │ │ │ - if isinstance(message.get('superuser'), dict): │ │ │ │ │ - self.write_control(command='superuser-init-done') │ │ │ │ │ - message['superuser'] = False │ │ │ │ │ - self.ssh_peer.write_control(message) │ │ │ │ │ + self.start_in_background(init_host=host, superuser=superuser) │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ -async def run(args) -> None: │ │ │ │ │ - logger.debug("Hi. How are you today?") │ │ │ │ │ +class HostRoutingRule(RoutingRule): │ │ │ │ │ + remotes: Dict[Tuple[str, Optional[str], Optional[str]], Peer] │ │ │ │ │ │ │ │ │ │ - bridge = SshBridge(args) │ │ │ │ │ - StdioTransport(asyncio.get_running_loop(), bridge) │ │ │ │ │ + def __init__(self, router): │ │ │ │ │ + super().__init__(router) │ │ │ │ │ + self.remotes = {} │ │ │ │ │ │ │ │ │ │ - try: │ │ │ │ │ - message = dict(await bridge.ssh_peer.start()) │ │ │ │ │ + def apply_rule(self, options: JsonObject) -> Optional[Peer]: │ │ │ │ │ + assert self.router is not None │ │ │ │ │ + assert self.router.init_host is not None │ │ │ │ │ │ │ │ │ │ - # See comment in do_init() above: we tell cockpit-ws that we support │ │ │ │ │ - # this and then handle it ourselves when we get the init message. │ │ │ │ │ - capabilities = message.setdefault('capabilities', {}) │ │ │ │ │ - if not isinstance(capabilities, dict): │ │ │ │ │ - bridge.write_control(command='init', problem='protocol-error', message='capabilities must be a dict') │ │ │ │ │ - return │ │ │ │ │ - assert isinstance(capabilities, dict) # convince mypy │ │ │ │ │ - capabilities['explicit-superuser'] = True │ │ │ │ │ + host = get_str(options, 'host', self.router.init_host) │ │ │ │ │ + if host == self.router.init_host: │ │ │ │ │ + return None │ │ │ │ │ │ │ │ │ │ - # only patch the packages line if we are in beiboot mode │ │ │ │ │ - if bridge.packages: │ │ │ │ │ - message['packages'] = dict.fromkeys(bridge.packages.packages) │ │ │ │ │ + user = get_str(options, 'user', None) │ │ │ │ │ + # HACK: the front-end relies on this for tracking connections without an explicit user name; │ │ │ │ │ + # the user will then be determined by SSH (`User` in the config or the current user) │ │ │ │ │ + # See cockpit_router_normalize_host_params() in src/bridge/cockpitrouter.c │ │ │ │ │ + if user == getpass.getuser(): │ │ │ │ │ + user = None │ │ │ │ │ + if not user: │ │ │ │ │ + user_from_host, _, _ = host.rpartition('@') │ │ │ │ │ + user = user_from_host or None # avoid '' │ │ │ │ │ │ │ │ │ │ - bridge.write_control(message) │ │ │ │ │ - bridge.ssh_peer.thaw_endpoint() │ │ │ │ │ - except ferny.InteractionError as exc: │ │ │ │ │ - error = ferny.ssh_errors.get_exception_for_ssh_stderr(str(exc)) │ │ │ │ │ - logger.debug("ferny.InteractionError: %s, interpreted as: %r", exc, error) │ │ │ │ │ - if isinstance(error, ferny.SshAuthenticationError): │ │ │ │ │ - problem = 'authentication-failed' │ │ │ │ │ - elif isinstance(error, ferny.SshHostKeyError): │ │ │ │ │ - problem = 'unknown-hostkey' │ │ │ │ │ - elif isinstance(error, OSError): │ │ │ │ │ - # usually DNS/socket errors │ │ │ │ │ - problem = 'unknown-host' │ │ │ │ │ + if get_str(options, 'session', None) == 'private': │ │ │ │ │ + nonce = get_str(options, 'channel') │ │ │ │ │ else: │ │ │ │ │ - problem = 'internal-error' │ │ │ │ │ - bridge.write_control(command='init', problem=problem, message=str(error)) │ │ │ │ │ - return │ │ │ │ │ - except CockpitProblem as exc: │ │ │ │ │ - logger.debug("CockpitProblem: %s", exc) │ │ │ │ │ - bridge.write_control(exc.attrs, command='init') │ │ │ │ │ - return │ │ │ │ │ - │ │ │ │ │ - logger.debug('Startup done. Looping until connection closes.') │ │ │ │ │ - try: │ │ │ │ │ - await bridge.communicate() │ │ │ │ │ - except BrokenPipeError: │ │ │ │ │ - # expected if the peer doesn't hang up cleanly │ │ │ │ │ - pass │ │ │ │ │ - │ │ │ │ │ + nonce = None │ │ │ │ │ │ │ │ │ │ -def main() -> None: │ │ │ │ │ - polyfills.install() │ │ │ │ │ + assert isinstance(host, str) │ │ │ │ │ + assert user is None or isinstance(user, str) │ │ │ │ │ + assert nonce is None or isinstance(nonce, str) │ │ │ │ │ │ │ │ │ │ - parser = argparse.ArgumentParser(description='cockpit-bridge is run automatically inside of a Cockpit session.') │ │ │ │ │ - parser.add_argument('--always', action='store_true', help="Never try to run cockpit-bridge from the system") │ │ │ │ │ - parser.add_argument('--debug', action='store_true') │ │ │ │ │ - parser.add_argument('destination', help="Name of the remote host to connect to, or 'localhost'") │ │ │ │ │ - args = parser.parse_args() │ │ │ │ │ + key = host, user, nonce │ │ │ │ │ │ │ │ │ │ - setup_logging(debug=args.debug) │ │ │ │ │ + logger.debug('Request for channel %s is remote.', options) │ │ │ │ │ + logger.debug('key=%s', key) │ │ │ │ │ │ │ │ │ │ - asyncio.run(run(args), debug=args.debug) │ │ │ │ │ + if key not in self.remotes: │ │ │ │ │ + logger.debug('%s is not among the existing remotes %s. Opening a new connection.', key, self.remotes) │ │ │ │ │ + peer = SshPeer(self.router, host, user, options, private=nonce is not None) │ │ │ │ │ + peer.add_done_callback(lambda: self.remotes.__delitem__(key)) │ │ │ │ │ + self.remotes[key] = peer │ │ │ │ │ │ │ │ │ │ + return self.remotes[key] │ │ │ │ │ │ │ │ │ │ -if __name__ == '__main__': │ │ │ │ │ - main() │ │ │ │ │ -''', │ │ │ │ │ + def shutdown(self): │ │ │ │ │ + for peer in set(self.remotes.values()): │ │ │ │ │ + peer.close() │ │ │ │ │ +'''.encode('utf-8'), │ │ │ │ │ 'cockpit/channel.py': r'''# This file is part of Cockpit. │ │ │ │ │ # │ │ │ │ │ # Copyright (C) 2022 Red Hat, Inc. │ │ │ │ │ # │ │ │ │ │ # This program is free software: you can redistribute it and/or modify │ │ │ │ │ # it under the terms of the GNU General Public License as published by │ │ │ │ │ # the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ @@ -3758,15 +3529,15 @@ │ │ │ │ │ try: │ │ │ │ │ while self.send_data(next(self.__generator)): │ │ │ │ │ pass │ │ │ │ │ except StopIteration as stop: │ │ │ │ │ self.done() │ │ │ │ │ self.close(stop.value) │ │ │ │ │ '''.encode('utf-8'), │ │ │ │ │ - 'cockpit/remote.py': r'''# This file is part of Cockpit. │ │ │ │ │ + 'cockpit/internal_endpoints.py': br'''# This file is part of Cockpit. │ │ │ │ │ # │ │ │ │ │ # Copyright (C) 2022 Red Hat, Inc. │ │ │ │ │ # │ │ │ │ │ # This program is free software: you can redistribute it and/or modify │ │ │ │ │ # it under the terms of the GNU General Public License as published by │ │ │ │ │ # the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ # (at your option) any later version. │ │ │ │ │ @@ -3775,234 +3546,246 @@ │ │ │ │ │ # but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ # GNU General Public License for more details. │ │ │ │ │ # │ │ │ │ │ # You should have received a copy of the GNU General Public License │ │ │ │ │ # along with this program. If not, see . │ │ │ │ │ │ │ │ │ │ -import getpass │ │ │ │ │ +import asyncio │ │ │ │ │ +import glob │ │ │ │ │ +import grp │ │ │ │ │ +import json │ │ │ │ │ import logging │ │ │ │ │ -import re │ │ │ │ │ -import socket │ │ │ │ │ -from typing import Dict, List, Optional, Tuple │ │ │ │ │ +import os │ │ │ │ │ +import pwd │ │ │ │ │ +from pathlib import Path │ │ │ │ │ +from typing import Dict, Optional │ │ │ │ │ │ │ │ │ │ -from cockpit._vendor import ferny │ │ │ │ │ +from cockpit._vendor.systemd_ctypes import Variant, bus, inotify, pathwatch │ │ │ │ │ │ │ │ │ │ -from .jsonutil import JsonObject, JsonValue, get_str, get_str_or_none │ │ │ │ │ -from .peer import Peer, PeerError │ │ │ │ │ -from .router import Router, RoutingRule │ │ │ │ │ +from . import config │ │ │ │ │ │ │ │ │ │ logger = logging.getLogger(__name__) │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ -class PasswordResponder(ferny.AskpassHandler): │ │ │ │ │ - PASSPHRASE_RE = re.compile(r"Enter passphrase for key '(.*)': ") │ │ │ │ │ - │ │ │ │ │ - password: Optional[str] │ │ │ │ │ - │ │ │ │ │ - hostkeys_seen: List[Tuple[str, str, str, str, str]] │ │ │ │ │ - error_message: Optional[str] │ │ │ │ │ - password_attempts: int │ │ │ │ │ +class cockpit_LoginMessages(bus.Object): │ │ │ │ │ + messages: Optional[str] = None │ │ │ │ │ │ │ │ │ │ - def __init__(self, password: Optional[str]): │ │ │ │ │ - self.password = password │ │ │ │ │ + def __init__(self): │ │ │ │ │ + fdstr = os.environ.pop('COCKPIT_LOGIN_MESSAGES_MEMFD', None) │ │ │ │ │ + if fdstr is None: │ │ │ │ │ + logger.debug("COCKPIT_LOGIN_MESSAGES_MEMFD wasn't set. No login messages today.") │ │ │ │ │ + return │ │ │ │ │ │ │ │ │ │ - self.hostkeys_seen = [] │ │ │ │ │ - self.error_message = None │ │ │ │ │ - self.password_attempts = 0 │ │ │ │ │ + logger.debug("Trying to read login messages from fd %s", fdstr) │ │ │ │ │ + try: │ │ │ │ │ + with open(int(fdstr), 'r') as login_messages: │ │ │ │ │ + login_messages.seek(0) │ │ │ │ │ + self.messages = login_messages.read() │ │ │ │ │ + except (ValueError, OSError, UnicodeDecodeError) as exc: │ │ │ │ │ + # ValueError - the envvar wasn't an int │ │ │ │ │ + # OSError - the fd wasn't open, or other read failure │ │ │ │ │ + # UnicodeDecodeError - didn't contain utf-8 │ │ │ │ │ + # For all of these, we simply failed to get the message. │ │ │ │ │ + logger.debug("Reading login messages failed: %s", exc) │ │ │ │ │ + else: │ │ │ │ │ + logger.debug("Successfully read login messages: %s", self.messages) │ │ │ │ │ │ │ │ │ │ - async def do_hostkey(self, reason: str, host: str, algorithm: str, key: str, fingerprint: str) -> bool: │ │ │ │ │ - self.hostkeys_seen.append((reason, host, algorithm, key, fingerprint)) │ │ │ │ │ - return False │ │ │ │ │ + @bus.Interface.Method(out_types=['s']) │ │ │ │ │ + def get(self): │ │ │ │ │ + return self.messages or '{}' │ │ │ │ │ │ │ │ │ │ - async def do_askpass(self, messages: str, prompt: str, hint: str) -> Optional[str]: │ │ │ │ │ - logger.debug('Got askpass(%s): %s', hint, prompt) │ │ │ │ │ + @bus.Interface.Method(out_types=[]) │ │ │ │ │ + def dismiss(self): │ │ │ │ │ + self.messages = None │ │ │ │ │ │ │ │ │ │ - match = PasswordResponder.PASSPHRASE_RE.fullmatch(prompt) │ │ │ │ │ - if match is not None: │ │ │ │ │ - # We never unlock private keys — we rather need to throw a │ │ │ │ │ - # specially-formatted error message which will cause the frontend │ │ │ │ │ - # to load the named key into the agent for us and try again. │ │ │ │ │ - path = match.group(1) │ │ │ │ │ - logger.debug("This is a passphrase request for %s, but we don't do those. Abort.", path) │ │ │ │ │ - self.error_message = f'locked identity: {path}' │ │ │ │ │ - return None │ │ │ │ │ │ │ │ │ │ - assert self.password is not None │ │ │ │ │ - assert self.password_attempts == 0 │ │ │ │ │ - self.password_attempts += 1 │ │ │ │ │ - return self.password │ │ │ │ │ +class cockpit_Machines(bus.Object): │ │ │ │ │ + path: Path │ │ │ │ │ + watch: pathwatch.PathWatch │ │ │ │ │ + pending_notify: Optional[asyncio.Handle] │ │ │ │ │ │ │ │ │ │ + # D-Bus implementation │ │ │ │ │ + machines = bus.Interface.Property('a{sa{sv}}') │ │ │ │ │ │ │ │ │ │ -class SshPeer(Peer): │ │ │ │ │ - session: Optional[ferny.Session] = None │ │ │ │ │ - host: str │ │ │ │ │ - user: Optional[str] │ │ │ │ │ - password: Optional[str] │ │ │ │ │ - private: bool │ │ │ │ │ + @machines.getter │ │ │ │ │ + def get_machines(self) -> Dict[str, Dict[str, Variant]]: │ │ │ │ │ + results: Dict[str, Dict[str, Variant]] = {} │ │ │ │ │ │ │ │ │ │ - async def do_connect_transport(self) -> None: │ │ │ │ │ - assert self.session is not None │ │ │ │ │ - logger.debug('Starting ssh session user=%s, host=%s, private=%s', self.user, self.host, self.private) │ │ │ │ │ + for filename in glob.glob(f'{self.path}/*.json'): │ │ │ │ │ + with open(filename) as fp: │ │ │ │ │ + try: │ │ │ │ │ + contents = json.load(fp) │ │ │ │ │ + except json.JSONDecodeError: │ │ │ │ │ + logger.warning('Invalid JSON in file %s. Ignoring.', filename) │ │ │ │ │ + continue │ │ │ │ │ + # merge │ │ │ │ │ + for hostname, attrs in contents.items(): │ │ │ │ │ + results[hostname] = {key: Variant(value) for key, value in attrs.items()} │ │ │ │ │ │ │ │ │ │ - basename, colon, portstr = self.host.rpartition(':') │ │ │ │ │ - if colon and portstr.isdigit(): │ │ │ │ │ - host = basename │ │ │ │ │ - port = int(portstr) │ │ │ │ │ - else: │ │ │ │ │ - host = self.host │ │ │ │ │ - port = None │ │ │ │ │ + return results │ │ │ │ │ │ │ │ │ │ - responder = PasswordResponder(self.password) │ │ │ │ │ - options = {"StrictHostKeyChecking": 'yes'} │ │ │ │ │ + @bus.Interface.Method(in_types=['s', 's', 'a{sv}']) │ │ │ │ │ + def update(self, filename: str, hostname: str, attrs: Dict[str, Variant]) -> None: │ │ │ │ │ + try: │ │ │ │ │ + with self.path.joinpath(filename).open() as fp: │ │ │ │ │ + contents = json.load(fp) │ │ │ │ │ + except json.JSONDecodeError as exc: │ │ │ │ │ + # Refuse to replace corrupted file │ │ │ │ │ + raise bus.BusError('cockpit.Machines.Error', f'File {filename} is in invalid format: {exc}.') from exc │ │ │ │ │ + except FileNotFoundError: │ │ │ │ │ + # But an empty file is an expected case │ │ │ │ │ + contents = {} │ │ │ │ │ │ │ │ │ │ - if self.password is not None: │ │ │ │ │ - options.update(NumberOfPasswordPrompts='1') │ │ │ │ │ - else: │ │ │ │ │ - options.update(PasswordAuthentication="no", KbdInteractiveAuthentication="no") │ │ │ │ │ + contents.setdefault(hostname, {}).update({key: value.value for key, value in attrs.items()}) │ │ │ │ │ │ │ │ │ │ - try: │ │ │ │ │ - await self.session.connect(host, login_name=self.user, port=port, │ │ │ │ │ - handle_host_key=self.private, options=options, │ │ │ │ │ - interaction_responder=responder) │ │ │ │ │ - except (OSError, socket.gaierror) as exc: │ │ │ │ │ - logger.debug('connecting to host %s failed: %s', host, exc) │ │ │ │ │ - raise PeerError('no-host', error='no-host', message=str(exc)) from exc │ │ │ │ │ + self.path.mkdir(parents=True, exist_ok=True) │ │ │ │ │ + with open(self.path.joinpath(filename), 'w') as fp: │ │ │ │ │ + json.dump(contents, fp, indent=2) │ │ │ │ │ │ │ │ │ │ - except ferny.SshHostKeyError as exc: │ │ │ │ │ - if responder.hostkeys_seen: │ │ │ │ │ - # If we saw a hostkey then we can issue a detailed error message │ │ │ │ │ - # containing the key that would need to be accepted. That will │ │ │ │ │ - # cause the front-end to present a dialog. │ │ │ │ │ - _reason, host, algorithm, key, fingerprint = responder.hostkeys_seen[0] │ │ │ │ │ - error_args = {'host-key': f'{host} {algorithm} {key}', 'host-fingerprint': fingerprint} │ │ │ │ │ - else: │ │ │ │ │ - error_args = {} │ │ │ │ │ + def notify(self): │ │ │ │ │ + def _notify_now(): │ │ │ │ │ + self.properties_changed('cockpit.Machines', {}, ['Machines']) │ │ │ │ │ + self.pending_notify = None │ │ │ │ │ │ │ │ │ │ - if isinstance(exc, ferny.SshChangedHostKeyError): │ │ │ │ │ - error = 'invalid-hostkey' │ │ │ │ │ - elif self.private: │ │ │ │ │ - error = 'unknown-hostkey' │ │ │ │ │ - else: │ │ │ │ │ - # non-private session case. throw a generic error. │ │ │ │ │ - error = 'unknown-host' │ │ │ │ │ + # avoid a flurry of update notifications │ │ │ │ │ + if self.pending_notify is None: │ │ │ │ │ + self.pending_notify = asyncio.get_running_loop().call_later(1.0, _notify_now) │ │ │ │ │ │ │ │ │ │ - logger.debug('SshPeer got a %s %s; private %s, seen hostkeys %r; raising %s with extra args %r', │ │ │ │ │ - type(exc), exc, self.private, responder.hostkeys_seen, error, error_args) │ │ │ │ │ - raise PeerError(error, error_args, error=error, auth_method_results={}) from exc │ │ │ │ │ + # inotify events │ │ │ │ │ + def do_inotify_event(self, mask: inotify.Event, cookie: int, name: Optional[str]) -> None: │ │ │ │ │ + self.notify() │ │ │ │ │ │ │ │ │ │ - except ferny.SshAuthenticationError as exc: │ │ │ │ │ - logger.debug('authentication to host %s failed: %s', host, exc) │ │ │ │ │ + def do_identity_changed(self, fd: Optional[int], errno: Optional[int]) -> None: │ │ │ │ │ + self.notify() │ │ │ │ │ │ │ │ │ │ - results = dict.fromkeys(exc.methods, "not-provided") │ │ │ │ │ - if 'password' in results and self.password is not None: │ │ │ │ │ - if responder.password_attempts == 0: │ │ │ │ │ - results['password'] = 'not-tried' │ │ │ │ │ - else: │ │ │ │ │ - results['password'] = 'denied' │ │ │ │ │ + def __init__(self): │ │ │ │ │ + self.path = config.lookup_config('machines.d') │ │ │ │ │ │ │ │ │ │ - raise PeerError('authentication-failed', │ │ │ │ │ - error=responder.error_message or 'authentication-failed', │ │ │ │ │ - auth_method_results=results) from exc │ │ │ │ │ + # ignore the first callback │ │ │ │ │ + self.pending_notify = ... │ │ │ │ │ + self.watch = pathwatch.PathWatch(str(self.path), self) │ │ │ │ │ + self.pending_notify = None │ │ │ │ │ │ │ │ │ │ - except ferny.SshError as exc: │ │ │ │ │ - logger.debug('unknown failure connecting to host %s: %s', host, exc) │ │ │ │ │ - raise PeerError('internal-error', message=str(exc)) from exc │ │ │ │ │ │ │ │ │ │ - args = self.session.wrap_subprocess_args(['cockpit-bridge']) │ │ │ │ │ - await self.spawn(args, []) │ │ │ │ │ +class cockpit_User(bus.Object): │ │ │ │ │ + name = bus.Interface.Property('s', value='') │ │ │ │ │ + full = bus.Interface.Property('s', value='') │ │ │ │ │ + id = bus.Interface.Property('i', value=0) │ │ │ │ │ + home = bus.Interface.Property('s', value='') │ │ │ │ │ + shell = bus.Interface.Property('s', value='') │ │ │ │ │ + groups = bus.Interface.Property('as', value=[]) │ │ │ │ │ │ │ │ │ │ - def do_kill(self, host: 'str | None', group: 'str | None', message: JsonObject) -> None: │ │ │ │ │ - if host == self.host: │ │ │ │ │ - self.close() │ │ │ │ │ - elif host is None: │ │ │ │ │ - super().do_kill(host, group, message) │ │ │ │ │ + def __init__(self): │ │ │ │ │ + user = pwd.getpwuid(os.getuid()) │ │ │ │ │ + self.name = user.pw_name │ │ │ │ │ + self.full = user.pw_gecos │ │ │ │ │ + self.id = user.pw_uid │ │ │ │ │ + self.home = user.pw_dir │ │ │ │ │ + self.shell = user.pw_shell │ │ │ │ │ + self.groups = [gr.gr_name for gr in grp.getgrall() if user.pw_name in gr.gr_mem] │ │ │ │ │ │ │ │ │ │ - def do_authorize(self, message: JsonObject) -> None: │ │ │ │ │ - if get_str(message, 'challenge').startswith('plain1:'): │ │ │ │ │ - cookie = get_str(message, 'cookie') │ │ │ │ │ - self.write_control(command='authorize', cookie=cookie, response=self.password or '') │ │ │ │ │ - self.password = None # once is enough... │ │ │ │ │ │ │ │ │ │ - def do_superuser_init_done(self) -> None: │ │ │ │ │ - self.password = None │ │ │ │ │ +EXPORTS = [ │ │ │ │ │ + ('/LoginMessages', cockpit_LoginMessages), │ │ │ │ │ + ('/machines', cockpit_Machines), │ │ │ │ │ + ('/user', cockpit_User), │ │ │ │ │ +] │ │ │ │ │ +''', │ │ │ │ │ + 'cockpit/config.py': br'''# This file is part of Cockpit. │ │ │ │ │ +# │ │ │ │ │ +# Copyright (C) 2023 Red Hat, Inc. │ │ │ │ │ +# │ │ │ │ │ +# This program is free software: you can redistribute it and/or modify │ │ │ │ │ +# it under the terms of the GNU General Public License as published by │ │ │ │ │ +# the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ +# (at your option) any later version. │ │ │ │ │ +# │ │ │ │ │ +# This program is distributed in the hope that it will be useful, │ │ │ │ │ +# but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ +# GNU General Public License for more details. │ │ │ │ │ +# │ │ │ │ │ +# You should have received a copy of the GNU General Public License │ │ │ │ │ +# along with this program. If not, see . │ │ │ │ │ │ │ │ │ │ - def __init__(self, router: Router, host: str, user: Optional[str], options: JsonObject, *, private: bool) -> None: │ │ │ │ │ - super().__init__(router) │ │ │ │ │ - self.host = host │ │ │ │ │ - self.user = user │ │ │ │ │ - self.password = get_str(options, 'password', None) │ │ │ │ │ - self.private = private │ │ │ │ │ +import configparser │ │ │ │ │ +import logging │ │ │ │ │ +import os │ │ │ │ │ +from pathlib import Path │ │ │ │ │ │ │ │ │ │ - self.session = ferny.Session() │ │ │ │ │ +from cockpit._vendor.systemd_ctypes import bus │ │ │ │ │ │ │ │ │ │ - superuser: JsonValue │ │ │ │ │ - init_superuser = get_str_or_none(options, 'init-superuser', None) │ │ │ │ │ - if init_superuser in (None, 'none'): │ │ │ │ │ - superuser = False │ │ │ │ │ - else: │ │ │ │ │ - superuser = {'id': init_superuser} │ │ │ │ │ +logger = logging.getLogger(__name__) │ │ │ │ │ │ │ │ │ │ - self.start_in_background(init_host=host, superuser=superuser) │ │ │ │ │ +XDG_CONFIG_HOME = Path(os.getenv('XDG_CONFIG_HOME') or os.path.expanduser('~/.config')) │ │ │ │ │ +DOT_CONFIG_COCKPIT = XDG_CONFIG_HOME / 'cockpit' │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ -class HostRoutingRule(RoutingRule): │ │ │ │ │ - remotes: Dict[Tuple[str, Optional[str], Optional[str]], Peer] │ │ │ │ │ +def lookup_config(filename: str) -> Path: │ │ │ │ │ + config_dirs = os.environ.get('XDG_CONFIG_DIRS', '/etc').split(':') │ │ │ │ │ + fallback = None │ │ │ │ │ + for config_dir in config_dirs: │ │ │ │ │ + config_path = Path(config_dir, 'cockpit', filename) │ │ │ │ │ + if not fallback: │ │ │ │ │ + fallback = config_path │ │ │ │ │ + if config_path.exists(): │ │ │ │ │ + logger.debug('lookup_config(%s): found %s', filename, config_path) │ │ │ │ │ + return config_path │ │ │ │ │ │ │ │ │ │ - def __init__(self, router): │ │ │ │ │ - super().__init__(router) │ │ │ │ │ - self.remotes = {} │ │ │ │ │ + # default to the first entry in XDG_CONFIG_DIRS; that's not according to the spec, │ │ │ │ │ + # but what Cockpit has done for years │ │ │ │ │ + logger.debug('lookup_config(%s): defaulting to %s', filename, fallback) │ │ │ │ │ + assert fallback # mypy; config_dirs always has at least one string │ │ │ │ │ + return fallback │ │ │ │ │ │ │ │ │ │ - def apply_rule(self, options: JsonObject) -> Optional[Peer]: │ │ │ │ │ - assert self.router is not None │ │ │ │ │ - assert self.router.init_host is not None │ │ │ │ │ │ │ │ │ │ - host = get_str(options, 'host', self.router.init_host) │ │ │ │ │ - if host == self.router.init_host: │ │ │ │ │ - return None │ │ │ │ │ +class Config(bus.Object, interface='cockpit.Config'): │ │ │ │ │ + def __init__(self): │ │ │ │ │ + self.reload() │ │ │ │ │ │ │ │ │ │ - user = get_str(options, 'user', None) │ │ │ │ │ - # HACK: the front-end relies on this for tracking connections without an explicit user name; │ │ │ │ │ - # the user will then be determined by SSH (`User` in the config or the current user) │ │ │ │ │ - # See cockpit_router_normalize_host_params() in src/bridge/cockpitrouter.c │ │ │ │ │ - if user == getpass.getuser(): │ │ │ │ │ - user = None │ │ │ │ │ - if not user: │ │ │ │ │ - user_from_host, _, _ = host.rpartition('@') │ │ │ │ │ - user = user_from_host or None # avoid '' │ │ │ │ │ + @bus.Interface.Method(out_types='s', in_types='ss') │ │ │ │ │ + def get_string(self, section, key): │ │ │ │ │ + try: │ │ │ │ │ + return self.config[section][key] │ │ │ │ │ + except KeyError as exc: │ │ │ │ │ + raise bus.BusError('cockpit.Config.KeyError', f'key {key} in section {section} does not exist') from exc │ │ │ │ │ │ │ │ │ │ - if get_str(options, 'session', None) == 'private': │ │ │ │ │ - nonce = get_str(options, 'channel') │ │ │ │ │ - else: │ │ │ │ │ - nonce = None │ │ │ │ │ + @bus.Interface.Method(out_types='u', in_types='ssuuu') │ │ │ │ │ + def get_u_int(self, section, key, default, maximum, minimum): │ │ │ │ │ + try: │ │ │ │ │ + value = self.config[section][key] │ │ │ │ │ + except KeyError: │ │ │ │ │ + return default │ │ │ │ │ │ │ │ │ │ - assert isinstance(host, str) │ │ │ │ │ - assert user is None or isinstance(user, str) │ │ │ │ │ - assert nonce is None or isinstance(nonce, str) │ │ │ │ │ + try: │ │ │ │ │ + int_val = int(value) │ │ │ │ │ + except ValueError: │ │ │ │ │ + logger.warning('cockpit.conf: [%s] %s is not an integer', section, key) │ │ │ │ │ + return default │ │ │ │ │ │ │ │ │ │ - key = host, user, nonce │ │ │ │ │ + return min(max(int_val, minimum), maximum) │ │ │ │ │ │ │ │ │ │ - logger.debug('Request for channel %s is remote.', options) │ │ │ │ │ - logger.debug('key=%s', key) │ │ │ │ │ + @bus.Interface.Method() │ │ │ │ │ + def reload(self): │ │ │ │ │ + self.config = configparser.ConfigParser(interpolation=None) │ │ │ │ │ + cockpit_conf = lookup_config('cockpit.conf') │ │ │ │ │ + logger.debug("cockpit.Config: loading %s", cockpit_conf) │ │ │ │ │ + # this may not exist, but it's ok to not have a config file and thus leave self.config empty │ │ │ │ │ + self.config.read(cockpit_conf) │ │ │ │ │ │ │ │ │ │ - if key not in self.remotes: │ │ │ │ │ - logger.debug('%s is not among the existing remotes %s. Opening a new connection.', key, self.remotes) │ │ │ │ │ - peer = SshPeer(self.router, host, user, options, private=nonce is not None) │ │ │ │ │ - peer.add_done_callback(lambda: self.remotes.__delitem__(key)) │ │ │ │ │ - self.remotes[key] = peer │ │ │ │ │ │ │ │ │ │ - return self.remotes[key] │ │ │ │ │ +class Environment(bus.Object, interface='cockpit.Environment'): │ │ │ │ │ + variables = bus.Interface.Property('a{ss}') │ │ │ │ │ │ │ │ │ │ - def shutdown(self): │ │ │ │ │ - for peer in set(self.remotes.values()): │ │ │ │ │ - peer.close() │ │ │ │ │ -'''.encode('utf-8'), │ │ │ │ │ - 'cockpit/_version.py': br'''__version__ = '317' │ │ │ │ │ + @variables.getter │ │ │ │ │ + def get_variables(self): │ │ │ │ │ + return os.environ.copy() │ │ │ │ │ ''', │ │ │ │ │ - 'cockpit/router.py': br'''# This file is part of Cockpit. │ │ │ │ │ + 'cockpit/peer.py': r'''# This file is part of Cockpit. │ │ │ │ │ # │ │ │ │ │ # Copyright (C) 2022 Red Hat, Inc. │ │ │ │ │ # │ │ │ │ │ # This program is free software: you can redistribute it and/or modify │ │ │ │ │ # it under the terms of the GNU General Public License as published by │ │ │ │ │ # the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ # (at your option) any later version. │ │ │ │ │ @@ -4012,200 +3795,533 @@ │ │ │ │ │ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ # GNU General Public License for more details. │ │ │ │ │ # │ │ │ │ │ # You should have received a copy of the GNU General Public License │ │ │ │ │ # along with this program. If not, see . │ │ │ │ │ │ │ │ │ │ import asyncio │ │ │ │ │ -import collections │ │ │ │ │ import logging │ │ │ │ │ -from typing import Dict, List, Optional │ │ │ │ │ +import os │ │ │ │ │ +from typing import Callable, List, Optional, Sequence │ │ │ │ │ │ │ │ │ │ from .jsonutil import JsonObject, JsonValue │ │ │ │ │ -from .protocol import CockpitProblem, CockpitProtocolError, CockpitProtocolServer │ │ │ │ │ +from .packages import BridgeConfig │ │ │ │ │ +from .protocol import CockpitProblem, CockpitProtocol, CockpitProtocolError │ │ │ │ │ +from .router import Endpoint, Router, RoutingRule │ │ │ │ │ +from .transports import SubprocessProtocol, SubprocessTransport │ │ │ │ │ │ │ │ │ │ logger = logging.getLogger(__name__) │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ -class ExecutionQueue: │ │ │ │ │ - """Temporarily delay calls to a given set of class methods. │ │ │ │ │ - │ │ │ │ │ - Functions by replacing the named function at the instance __dict__ │ │ │ │ │ - level, effectively providing an override for exactly one instance │ │ │ │ │ - of `method`'s object. │ │ │ │ │ - Queues the invocations. Run them later with .run(), which also reverses │ │ │ │ │ - the redirection by deleting the named methods from the instance. │ │ │ │ │ - """ │ │ │ │ │ - def __init__(self, methods): │ │ │ │ │ - self.queue = collections.deque() │ │ │ │ │ - self.methods = methods │ │ │ │ │ +class PeerError(CockpitProblem): │ │ │ │ │ + pass │ │ │ │ │ │ │ │ │ │ - for method in self.methods: │ │ │ │ │ - self._wrap(method) │ │ │ │ │ │ │ │ │ │ - def _wrap(self, method): │ │ │ │ │ - # NB: this function is stored in the instance dict and therefore │ │ │ │ │ - # doesn't function as a descriptor, isn't a method, doesn't get bound, │ │ │ │ │ - # and therefore doesn't receive a self parameter │ │ │ │ │ - setattr(method.__self__, method.__func__.__name__, lambda *args: self.queue.append((method, args))) │ │ │ │ │ +class PeerExited(Exception): │ │ │ │ │ + def __init__(self, exit_code: int): │ │ │ │ │ + self.exit_code = exit_code │ │ │ │ │ │ │ │ │ │ - def run(self): │ │ │ │ │ - logger.debug('ExecutionQueue: Running %d queued method calls', len(self.queue)) │ │ │ │ │ - for method, args in self.queue: │ │ │ │ │ - method(*args) │ │ │ │ │ │ │ │ │ │ - for method in self.methods: │ │ │ │ │ - delattr(method.__self__, method.__func__.__name__) │ │ │ │ │ +class Peer(CockpitProtocol, SubprocessProtocol, Endpoint): │ │ │ │ │ + done_callbacks: List[Callable[[], None]] │ │ │ │ │ + init_future: Optional[asyncio.Future] │ │ │ │ │ │ │ │ │ │ + def __init__(self, router: Router): │ │ │ │ │ + super().__init__(router) │ │ │ │ │ │ │ │ │ │ -class Endpoint: │ │ │ │ │ - router: 'Router' │ │ │ │ │ - __endpoint_frozen_queue: Optional[ExecutionQueue] = None │ │ │ │ │ + # All Peers start out frozen — we only unfreeze after we see the first 'init' message │ │ │ │ │ + self.freeze_endpoint() │ │ │ │ │ │ │ │ │ │ - def __init__(self, router: 'Router'): │ │ │ │ │ - router.add_endpoint(self) │ │ │ │ │ - self.router = router │ │ │ │ │ + self.init_future = asyncio.get_running_loop().create_future() │ │ │ │ │ + self.done_callbacks = [] │ │ │ │ │ │ │ │ │ │ - def freeze_endpoint(self): │ │ │ │ │ - assert self.__endpoint_frozen_queue is None │ │ │ │ │ - logger.debug('Freezing endpoint %s', self) │ │ │ │ │ - self.__endpoint_frozen_queue = ExecutionQueue({self.do_channel_control, self.do_channel_data, self.do_kill}) │ │ │ │ │ + # Initialization │ │ │ │ │ + async def do_connect_transport(self) -> None: │ │ │ │ │ + raise NotImplementedError │ │ │ │ │ │ │ │ │ │ - def thaw_endpoint(self): │ │ │ │ │ - assert self.__endpoint_frozen_queue is not None │ │ │ │ │ - logger.debug('Thawing endpoint %s', self) │ │ │ │ │ - self.__endpoint_frozen_queue.run() │ │ │ │ │ - self.__endpoint_frozen_queue = None │ │ │ │ │ + async def spawn(self, argv: Sequence[str], env: Sequence[str], **kwargs) -> asyncio.Transport: │ │ │ │ │ + # Not actually async... │ │ │ │ │ + loop = asyncio.get_running_loop() │ │ │ │ │ + user_env = dict(e.split('=', 1) for e in env) │ │ │ │ │ + return SubprocessTransport(loop, self, argv, env=dict(os.environ, **user_env), **kwargs) │ │ │ │ │ │ │ │ │ │ - # interface for receiving messages │ │ │ │ │ - def do_close(self): │ │ │ │ │ - raise NotImplementedError │ │ │ │ │ + async def start(self, init_host: Optional[str] = None, **kwargs: JsonValue) -> JsonObject: │ │ │ │ │ + """Request that the Peer is started and connected to the router. │ │ │ │ │ │ │ │ │ │ - def do_channel_control(self, channel: str, command: str, message: JsonObject) -> None: │ │ │ │ │ - raise NotImplementedError │ │ │ │ │ + Creates the transport, connects it to the protocol, and participates in │ │ │ │ │ + exchanging of init messages. If anything goes wrong, the connection │ │ │ │ │ + will be closed and an exception will be raised. │ │ │ │ │ │ │ │ │ │ - def do_channel_data(self, channel: str, data: bytes) -> None: │ │ │ │ │ - raise NotImplementedError │ │ │ │ │ + The Peer starts out in a frozen state (ie: attempts to send messages to │ │ │ │ │ + it will initially be queued). If init_host is not None then an init │ │ │ │ │ + message is sent with the given 'host' field, plus any extra kwargs, and │ │ │ │ │ + the queue is thawed. Otherwise, the caller is responsible for sending │ │ │ │ │ + the init message and thawing the peer. │ │ │ │ │ │ │ │ │ │ - def do_kill(self, host: 'str | None', group: 'str | None', message: JsonObject) -> None: │ │ │ │ │ - raise NotImplementedError │ │ │ │ │ + In any case, the return value is the init message from the peer. │ │ │ │ │ + """ │ │ │ │ │ + assert self.init_future is not None │ │ │ │ │ │ │ │ │ │ - # interface for sending messages │ │ │ │ │ - def send_channel_data(self, channel: str, data: bytes) -> None: │ │ │ │ │ - self.router.write_channel_data(channel, data) │ │ │ │ │ + def _connect_task_done(task: asyncio.Task) -> None: │ │ │ │ │ + assert task is connect_task │ │ │ │ │ + try: │ │ │ │ │ + task.result() │ │ │ │ │ + except asyncio.CancelledError: # we did that (below) │ │ │ │ │ + pass # we want to ignore it │ │ │ │ │ + except Exception as exc: │ │ │ │ │ + self.close(exc) │ │ │ │ │ │ │ │ │ │ - def send_channel_control( │ │ │ │ │ - self, channel: str, command: str, _msg: 'JsonObject | None', **kwargs: JsonValue │ │ │ │ │ - ) -> None: │ │ │ │ │ - self.router.write_control(_msg, channel=channel, command=command, **kwargs) │ │ │ │ │ - if command == 'close': │ │ │ │ │ - self.router.endpoints[self].remove(channel) │ │ │ │ │ - self.router.drop_channel(channel) │ │ │ │ │ + connect_task = asyncio.create_task(self.do_connect_transport()) │ │ │ │ │ + connect_task.add_done_callback(_connect_task_done) │ │ │ │ │ │ │ │ │ │ - def shutdown_endpoint(self, _msg: 'JsonObject | None' = None, **kwargs: JsonValue) -> None: │ │ │ │ │ - self.router.shutdown_endpoint(self, _msg, **kwargs) │ │ │ │ │ + try: │ │ │ │ │ + # Wait for something to happen: │ │ │ │ │ + # - exception from our connection function │ │ │ │ │ + # - receiving "init" from the other side │ │ │ │ │ + # - receiving EOF from the other side │ │ │ │ │ + # - .close() was called │ │ │ │ │ + # - other transport exception │ │ │ │ │ + init_message = await self.init_future │ │ │ │ │ │ │ │ │ │ + except (PeerExited, BrokenPipeError): │ │ │ │ │ + # These are fairly generic errors. PeerExited means that we observed the process exiting. │ │ │ │ │ + # BrokenPipeError means that we got EPIPE when attempting to write() to it. In both cases, │ │ │ │ │ + # the process is gone, but it's not clear why. If the connection process is still running, │ │ │ │ │ + # perhaps we'd get a better error message from it. │ │ │ │ │ + await connect_task │ │ │ │ │ + # Otherwise, re-raise │ │ │ │ │ + raise │ │ │ │ │ │ │ │ │ │ -class RoutingError(CockpitProblem): │ │ │ │ │ - pass │ │ │ │ │ + finally: │ │ │ │ │ + self.init_future = None │ │ │ │ │ │ │ │ │ │ + # In any case (failure or success) make sure this is done. │ │ │ │ │ + if not connect_task.done(): │ │ │ │ │ + connect_task.cancel() │ │ │ │ │ │ │ │ │ │ -class RoutingRule: │ │ │ │ │ - router: 'Router' │ │ │ │ │ + if init_host is not None: │ │ │ │ │ + logger.debug(' sending init message back, host %s', init_host) │ │ │ │ │ + # Send "init" back │ │ │ │ │ + self.write_control(None, command='init', version=1, host=init_host, **kwargs) │ │ │ │ │ │ │ │ │ │ - def __init__(self, router: 'Router'): │ │ │ │ │ - self.router = router │ │ │ │ │ + # Thaw the queued messages │ │ │ │ │ + self.thaw_endpoint() │ │ │ │ │ │ │ │ │ │ - def apply_rule(self, options: JsonObject) -> Optional[Endpoint]: │ │ │ │ │ - """Check if a routing rule applies to a given 'open' message. │ │ │ │ │ + return init_message │ │ │ │ │ │ │ │ │ │ - This should inspect the options dictionary and do one of the following three things: │ │ │ │ │ + # Background initialization │ │ │ │ │ + def start_in_background(self, init_host: Optional[str] = None, **kwargs: JsonValue) -> None: │ │ │ │ │ + def _start_task_done(task: asyncio.Task) -> None: │ │ │ │ │ + assert task is start_task │ │ │ │ │ │ │ │ │ │ - - return an Endpoint to handle this channel │ │ │ │ │ - - raise a RoutingError to indicate that the open should be rejected │ │ │ │ │ - - return None to let the next rule run │ │ │ │ │ - """ │ │ │ │ │ - raise NotImplementedError │ │ │ │ │ + try: │ │ │ │ │ + task.result() │ │ │ │ │ + except (OSError, PeerExited, CockpitProblem, asyncio.CancelledError): │ │ │ │ │ + pass # Those are expected. Others will throw. │ │ │ │ │ │ │ │ │ │ - def shutdown(self): │ │ │ │ │ - raise NotImplementedError │ │ │ │ │ + start_task = asyncio.create_task(self.start(init_host, **kwargs)) │ │ │ │ │ + start_task.add_done_callback(_start_task_done) │ │ │ │ │ │ │ │ │ │ + # Shutdown │ │ │ │ │ + def add_done_callback(self, callback: Callable[[], None]) -> None: │ │ │ │ │ + self.done_callbacks.append(callback) │ │ │ │ │ │ │ │ │ │ -class Router(CockpitProtocolServer): │ │ │ │ │ - routing_rules: List[RoutingRule] │ │ │ │ │ - open_channels: Dict[str, Endpoint] │ │ │ │ │ - endpoints: 'dict[Endpoint, set[str]]' │ │ │ │ │ - no_endpoints: asyncio.Event # set if endpoints dict is empty │ │ │ │ │ - _eof: bool = False │ │ │ │ │ + # Handling of interesting events │ │ │ │ │ + def do_superuser_init_done(self) -> None: │ │ │ │ │ + pass │ │ │ │ │ │ │ │ │ │ - def __init__(self, routing_rules: List[RoutingRule]): │ │ │ │ │ - for rule in routing_rules: │ │ │ │ │ - rule.router = self │ │ │ │ │ - self.routing_rules = routing_rules │ │ │ │ │ - self.open_channels = {} │ │ │ │ │ - self.endpoints = {} │ │ │ │ │ - self.no_endpoints = asyncio.Event() │ │ │ │ │ - self.no_endpoints.set() # at first there are no endpoints │ │ │ │ │ + def do_authorize(self, message: JsonObject) -> None: │ │ │ │ │ + pass │ │ │ │ │ │ │ │ │ │ - def check_rules(self, options: JsonObject) -> Endpoint: │ │ │ │ │ - for rule in self.routing_rules: │ │ │ │ │ - logger.debug(' applying rule %s', rule) │ │ │ │ │ - endpoint = rule.apply_rule(options) │ │ │ │ │ - if endpoint is not None: │ │ │ │ │ - logger.debug(' resulting endpoint is %s', endpoint) │ │ │ │ │ - return endpoint │ │ │ │ │ + def transport_control_received(self, command: str, message: JsonObject) -> None: │ │ │ │ │ + if command == 'init' and self.init_future is not None: │ │ │ │ │ + logger.debug('Got init message with active init_future. Setting result.') │ │ │ │ │ + self.init_future.set_result(message) │ │ │ │ │ + elif command == 'authorize': │ │ │ │ │ + self.do_authorize(message) │ │ │ │ │ + elif command == 'superuser-init-done': │ │ │ │ │ + self.do_superuser_init_done() │ │ │ │ │ else: │ │ │ │ │ - logger.debug(' No rules matched') │ │ │ │ │ - raise RoutingError('not-supported') │ │ │ │ │ + raise CockpitProtocolError(f'Received unexpected control message {command}') │ │ │ │ │ │ │ │ │ │ - def drop_channel(self, channel: str) -> None: │ │ │ │ │ - try: │ │ │ │ │ - self.open_channels.pop(channel) │ │ │ │ │ - logger.debug('router dropped channel %s', channel) │ │ │ │ │ - except KeyError: │ │ │ │ │ - logger.error('trying to drop non-existent channel %s from %s', channel, self.open_channels) │ │ │ │ │ + def eof_received(self) -> bool: │ │ │ │ │ + # We always expect to be the ones to close the connection, so if we get │ │ │ │ │ + # an EOF, then we consider it to be an error. This allows us to │ │ │ │ │ + # distinguish close caused by unexpected EOF (but no errno from a │ │ │ │ │ + # syscall failure) vs. close caused by calling .close() on our side. │ │ │ │ │ + # The process is still running at this point, so keep it and handle │ │ │ │ │ + # the error in process_exited(). │ │ │ │ │ + logger.debug('Peer %s received unexpected EOF', self.__class__.__name__) │ │ │ │ │ + return True │ │ │ │ │ │ │ │ │ │ - def add_endpoint(self, endpoint: Endpoint) -> None: │ │ │ │ │ - self.endpoints[endpoint] = set() │ │ │ │ │ - self.no_endpoints.clear() │ │ │ │ │ + def do_closed(self, exc: Optional[Exception]) -> None: │ │ │ │ │ + logger.debug('Peer %s connection lost %s %s', self.__class__.__name__, type(exc), exc) │ │ │ │ │ │ │ │ │ │ - def shutdown_endpoint(self, endpoint: Endpoint, _msg: 'JsonObject | None' = None, **kwargs: JsonValue) -> None: │ │ │ │ │ - channels = self.endpoints.pop(endpoint) │ │ │ │ │ - logger.debug('shutdown_endpoint(%s, %s) will close %s', endpoint, kwargs, channels) │ │ │ │ │ - for channel in channels: │ │ │ │ │ - self.write_control(_msg, command='close', channel=channel, **kwargs) │ │ │ │ │ - self.drop_channel(channel) │ │ │ │ │ + if exc is None: │ │ │ │ │ + self.shutdown_endpoint(problem='terminated') │ │ │ │ │ + elif isinstance(exc, PeerExited): │ │ │ │ │ + # a common case is that the called peer does not exist │ │ │ │ │ + if exc.exit_code == 127: │ │ │ │ │ + self.shutdown_endpoint(problem='no-cockpit') │ │ │ │ │ + else: │ │ │ │ │ + self.shutdown_endpoint(problem='terminated', message=f'Peer exited with status {exc.exit_code}') │ │ │ │ │ + elif isinstance(exc, CockpitProblem): │ │ │ │ │ + self.shutdown_endpoint(exc.attrs) │ │ │ │ │ + else: │ │ │ │ │ + self.shutdown_endpoint(problem='internal-error', │ │ │ │ │ + message=f"[{exc.__class__.__name__}] {exc!s}") │ │ │ │ │ │ │ │ │ │ - if not self.endpoints: │ │ │ │ │ - self.no_endpoints.set() │ │ │ │ │ + # If .start() is running, we need to make sure it stops running, │ │ │ │ │ + # raising the correct exception. │ │ │ │ │ + if self.init_future is not None and not self.init_future.done(): │ │ │ │ │ + if exc is not None: │ │ │ │ │ + self.init_future.set_exception(exc) │ │ │ │ │ + else: │ │ │ │ │ + self.init_future.cancel() │ │ │ │ │ │ │ │ │ │ - # were we waiting to exit? │ │ │ │ │ - if self._eof: │ │ │ │ │ - logger.debug(' endpoints remaining: %r', self.endpoints) │ │ │ │ │ - if not self.endpoints and self.transport: │ │ │ │ │ - logger.debug(' close transport') │ │ │ │ │ - self.transport.close() │ │ │ │ │ + for callback in self.done_callbacks: │ │ │ │ │ + callback() │ │ │ │ │ │ │ │ │ │ - def do_kill(self, host: 'str | None', group: 'str | None', message: JsonObject) -> None: │ │ │ │ │ - endpoints = set(self.endpoints) │ │ │ │ │ - logger.debug('do_kill(%s, %s). Considering %d endpoints.', host, group, len(endpoints)) │ │ │ │ │ - for endpoint in endpoints: │ │ │ │ │ - endpoint.do_kill(host, group, message) │ │ │ │ │ + def process_exited(self) -> None: │ │ │ │ │ + assert isinstance(self.transport, SubprocessTransport) │ │ │ │ │ + logger.debug('Peer %s exited, status %d', self.__class__.__name__, self.transport.get_returncode()) │ │ │ │ │ + returncode = self.transport.get_returncode() │ │ │ │ │ + assert isinstance(returncode, int) │ │ │ │ │ + self.close(PeerExited(returncode)) │ │ │ │ │ │ │ │ │ │ + # Forwarding data: from the peer to the router │ │ │ │ │ def channel_control_received(self, channel: str, command: str, message: JsonObject) -> None: │ │ │ │ │ - # If this is an open message then we need to apply the routing rules to │ │ │ │ │ - # figure out the correct endpoint to connect. If it's not an open │ │ │ │ │ - # message, then we expect the endpoint to already exist. │ │ │ │ │ - if command == 'open': │ │ │ │ │ - if channel in self.open_channels: │ │ │ │ │ - raise CockpitProtocolError('channel is already open') │ │ │ │ │ + if self.init_future is not None: │ │ │ │ │ + raise CockpitProtocolError('Received unexpected channel control message before init') │ │ │ │ │ + self.send_channel_control(channel, command, message) │ │ │ │ │ │ │ │ │ │ - try: │ │ │ │ │ - logger.debug('Trying to find endpoint for new channel %s payload=%s', channel, message.get('payload')) │ │ │ │ │ - endpoint = self.check_rules(message) │ │ │ │ │ + def channel_data_received(self, channel: str, data: bytes) -> None: │ │ │ │ │ + if self.init_future is not None: │ │ │ │ │ + raise CockpitProtocolError('Received unexpected channel data before init') │ │ │ │ │ + self.send_channel_data(channel, data) │ │ │ │ │ + │ │ │ │ │ + # Forwarding data: from the router to the peer │ │ │ │ │ + def do_channel_control(self, channel: str, command: str, message: JsonObject) -> None: │ │ │ │ │ + assert self.init_future is None │ │ │ │ │ + self.write_control(message) │ │ │ │ │ + │ │ │ │ │ + def do_channel_data(self, channel: str, data: bytes) -> None: │ │ │ │ │ + assert self.init_future is None │ │ │ │ │ + self.write_channel_data(channel, data) │ │ │ │ │ + │ │ │ │ │ + def do_kill(self, host: 'str | None', group: 'str | None', message: JsonObject) -> None: │ │ │ │ │ + assert self.init_future is None │ │ │ │ │ + self.write_control(message) │ │ │ │ │ + │ │ │ │ │ + def do_close(self) -> None: │ │ │ │ │ + self.close() │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class ConfiguredPeer(Peer): │ │ │ │ │ + config: BridgeConfig │ │ │ │ │ + args: Sequence[str] │ │ │ │ │ + env: Sequence[str] │ │ │ │ │ + │ │ │ │ │ + def __init__(self, router: Router, config: BridgeConfig): │ │ │ │ │ + self.config = config │ │ │ │ │ + self.args = config.spawn │ │ │ │ │ + self.env = config.environ │ │ │ │ │ + super().__init__(router) │ │ │ │ │ + │ │ │ │ │ + async def do_connect_transport(self) -> None: │ │ │ │ │ + await self.spawn(self.args, self.env) │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class PeerRoutingRule(RoutingRule): │ │ │ │ │ + config: BridgeConfig │ │ │ │ │ + match: JsonObject │ │ │ │ │ + peer: Optional[Peer] │ │ │ │ │ + │ │ │ │ │ + def __init__(self, router: Router, config: BridgeConfig): │ │ │ │ │ + super().__init__(router) │ │ │ │ │ + self.config = config │ │ │ │ │ + self.match = config.match │ │ │ │ │ + self.peer = None │ │ │ │ │ + │ │ │ │ │ + def apply_rule(self, options: JsonObject) -> Optional[Peer]: │ │ │ │ │ + # Check that we match │ │ │ │ │ + │ │ │ │ │ + for key, value in self.match.items(): │ │ │ │ │ + if key not in options: │ │ │ │ │ + logger.debug(' rejecting because key %s is missing', key) │ │ │ │ │ + return None │ │ │ │ │ + if value is not None and options[key] != value: │ │ │ │ │ + logger.debug(' rejecting because key %s has wrong value %s (vs %s)', key, options[key], value) │ │ │ │ │ + return None │ │ │ │ │ + │ │ │ │ │ + # Start the peer if it's not running already │ │ │ │ │ + if self.peer is None: │ │ │ │ │ + self.peer = ConfiguredPeer(self.router, self.config) │ │ │ │ │ + self.peer.add_done_callback(self.peer_closed) │ │ │ │ │ + assert self.router.init_host │ │ │ │ │ + self.peer.start_in_background(init_host=self.router.init_host) │ │ │ │ │ + │ │ │ │ │ + return self.peer │ │ │ │ │ + │ │ │ │ │ + def peer_closed(self): │ │ │ │ │ + self.peer = None │ │ │ │ │ + │ │ │ │ │ + def shutdown(self): │ │ │ │ │ + if self.peer is not None: │ │ │ │ │ + self.peer.close() │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class PeersRoutingRule(RoutingRule): │ │ │ │ │ + rules: List[PeerRoutingRule] = [] │ │ │ │ │ + │ │ │ │ │ + def apply_rule(self, options: JsonObject) -> Optional[Endpoint]: │ │ │ │ │ + logger.debug(' considering %d rules', len(self.rules)) │ │ │ │ │ + for rule in self.rules: │ │ │ │ │ + logger.debug(' considering %s', rule.config.name) │ │ │ │ │ + endpoint = rule.apply_rule(options) │ │ │ │ │ + if endpoint is not None: │ │ │ │ │ + logger.debug(' selected') │ │ │ │ │ + return endpoint │ │ │ │ │ + logger.debug(' no peer rules matched') │ │ │ │ │ + return None │ │ │ │ │ + │ │ │ │ │ + def set_configs(self, bridge_configs: Sequence[BridgeConfig]) -> None: │ │ │ │ │ + old_rules = self.rules │ │ │ │ │ + self.rules = [] │ │ │ │ │ + │ │ │ │ │ + for config in bridge_configs: │ │ │ │ │ + # Those are handled elsewhere... │ │ │ │ │ + if config.privileged or 'host' in config.match: │ │ │ │ │ + continue │ │ │ │ │ + │ │ │ │ │ + # Try to reuse an existing rule, if one exists... │ │ │ │ │ + for rule in list(old_rules): │ │ │ │ │ + if rule.config == config: │ │ │ │ │ + old_rules.remove(rule) │ │ │ │ │ + break │ │ │ │ │ + else: │ │ │ │ │ + # ... otherwise, create a new one. │ │ │ │ │ + rule = PeerRoutingRule(self.router, config) │ │ │ │ │ + │ │ │ │ │ + self.rules.append(rule) │ │ │ │ │ + │ │ │ │ │ + # close down the old rules that didn't get reclaimed │ │ │ │ │ + for rule in old_rules: │ │ │ │ │ + rule.shutdown() │ │ │ │ │ + │ │ │ │ │ + def shutdown(self): │ │ │ │ │ + for rule in self.rules: │ │ │ │ │ + rule.shutdown() │ │ │ │ │ +'''.encode('utf-8'), │ │ │ │ │ + 'cockpit/_version.py': br'''__version__ = '317' │ │ │ │ │ +''', │ │ │ │ │ + 'cockpit/router.py': br'''# This file is part of Cockpit. │ │ │ │ │ +# │ │ │ │ │ +# Copyright (C) 2022 Red Hat, Inc. │ │ │ │ │ +# │ │ │ │ │ +# This program is free software: you can redistribute it and/or modify │ │ │ │ │ +# it under the terms of the GNU General Public License as published by │ │ │ │ │ +# the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ +# (at your option) any later version. │ │ │ │ │ +# │ │ │ │ │ +# This program is distributed in the hope that it will be useful, │ │ │ │ │ +# but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ +# GNU General Public License for more details. │ │ │ │ │ +# │ │ │ │ │ +# You should have received a copy of the GNU General Public License │ │ │ │ │ +# along with this program. If not, see . │ │ │ │ │ + │ │ │ │ │ +import asyncio │ │ │ │ │ +import collections │ │ │ │ │ +import logging │ │ │ │ │ +from typing import Dict, List, Optional │ │ │ │ │ + │ │ │ │ │ +from .jsonutil import JsonObject, JsonValue │ │ │ │ │ +from .protocol import CockpitProblem, CockpitProtocolError, CockpitProtocolServer │ │ │ │ │ + │ │ │ │ │ +logger = logging.getLogger(__name__) │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class ExecutionQueue: │ │ │ │ │ + """Temporarily delay calls to a given set of class methods. │ │ │ │ │ + │ │ │ │ │ + Functions by replacing the named function at the instance __dict__ │ │ │ │ │ + level, effectively providing an override for exactly one instance │ │ │ │ │ + of `method`'s object. │ │ │ │ │ + Queues the invocations. Run them later with .run(), which also reverses │ │ │ │ │ + the redirection by deleting the named methods from the instance. │ │ │ │ │ + """ │ │ │ │ │ + def __init__(self, methods): │ │ │ │ │ + self.queue = collections.deque() │ │ │ │ │ + self.methods = methods │ │ │ │ │ + │ │ │ │ │ + for method in self.methods: │ │ │ │ │ + self._wrap(method) │ │ │ │ │ + │ │ │ │ │ + def _wrap(self, method): │ │ │ │ │ + # NB: this function is stored in the instance dict and therefore │ │ │ │ │ + # doesn't function as a descriptor, isn't a method, doesn't get bound, │ │ │ │ │ + # and therefore doesn't receive a self parameter │ │ │ │ │ + setattr(method.__self__, method.__func__.__name__, lambda *args: self.queue.append((method, args))) │ │ │ │ │ + │ │ │ │ │ + def run(self): │ │ │ │ │ + logger.debug('ExecutionQueue: Running %d queued method calls', len(self.queue)) │ │ │ │ │ + for method, args in self.queue: │ │ │ │ │ + method(*args) │ │ │ │ │ + │ │ │ │ │ + for method in self.methods: │ │ │ │ │ + delattr(method.__self__, method.__func__.__name__) │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class Endpoint: │ │ │ │ │ + router: 'Router' │ │ │ │ │ + __endpoint_frozen_queue: Optional[ExecutionQueue] = None │ │ │ │ │ + │ │ │ │ │ + def __init__(self, router: 'Router'): │ │ │ │ │ + router.add_endpoint(self) │ │ │ │ │ + self.router = router │ │ │ │ │ + │ │ │ │ │ + def freeze_endpoint(self): │ │ │ │ │ + assert self.__endpoint_frozen_queue is None │ │ │ │ │ + logger.debug('Freezing endpoint %s', self) │ │ │ │ │ + self.__endpoint_frozen_queue = ExecutionQueue({self.do_channel_control, self.do_channel_data, self.do_kill}) │ │ │ │ │ + │ │ │ │ │ + def thaw_endpoint(self): │ │ │ │ │ + assert self.__endpoint_frozen_queue is not None │ │ │ │ │ + logger.debug('Thawing endpoint %s', self) │ │ │ │ │ + self.__endpoint_frozen_queue.run() │ │ │ │ │ + self.__endpoint_frozen_queue = None │ │ │ │ │ + │ │ │ │ │ + # interface for receiving messages │ │ │ │ │ + def do_close(self): │ │ │ │ │ + raise NotImplementedError │ │ │ │ │ + │ │ │ │ │ + def do_channel_control(self, channel: str, command: str, message: JsonObject) -> None: │ │ │ │ │ + raise NotImplementedError │ │ │ │ │ + │ │ │ │ │ + def do_channel_data(self, channel: str, data: bytes) -> None: │ │ │ │ │ + raise NotImplementedError │ │ │ │ │ + │ │ │ │ │ + def do_kill(self, host: 'str | None', group: 'str | None', message: JsonObject) -> None: │ │ │ │ │ + raise NotImplementedError │ │ │ │ │ + │ │ │ │ │ + # interface for sending messages │ │ │ │ │ + def send_channel_data(self, channel: str, data: bytes) -> None: │ │ │ │ │ + self.router.write_channel_data(channel, data) │ │ │ │ │ + │ │ │ │ │ + def send_channel_control( │ │ │ │ │ + self, channel: str, command: str, _msg: 'JsonObject | None', **kwargs: JsonValue │ │ │ │ │ + ) -> None: │ │ │ │ │ + self.router.write_control(_msg, channel=channel, command=command, **kwargs) │ │ │ │ │ + if command == 'close': │ │ │ │ │ + self.router.endpoints[self].remove(channel) │ │ │ │ │ + self.router.drop_channel(channel) │ │ │ │ │ + │ │ │ │ │ + def shutdown_endpoint(self, _msg: 'JsonObject | None' = None, **kwargs: JsonValue) -> None: │ │ │ │ │ + self.router.shutdown_endpoint(self, _msg, **kwargs) │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class RoutingError(CockpitProblem): │ │ │ │ │ + pass │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class RoutingRule: │ │ │ │ │ + router: 'Router' │ │ │ │ │ + │ │ │ │ │ + def __init__(self, router: 'Router'): │ │ │ │ │ + self.router = router │ │ │ │ │ + │ │ │ │ │ + def apply_rule(self, options: JsonObject) -> Optional[Endpoint]: │ │ │ │ │ + """Check if a routing rule applies to a given 'open' message. │ │ │ │ │ + │ │ │ │ │ + This should inspect the options dictionary and do one of the following three things: │ │ │ │ │ + │ │ │ │ │ + - return an Endpoint to handle this channel │ │ │ │ │ + - raise a RoutingError to indicate that the open should be rejected │ │ │ │ │ + - return None to let the next rule run │ │ │ │ │ + """ │ │ │ │ │ + raise NotImplementedError │ │ │ │ │ + │ │ │ │ │ + def shutdown(self): │ │ │ │ │ + raise NotImplementedError │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class Router(CockpitProtocolServer): │ │ │ │ │ + routing_rules: List[RoutingRule] │ │ │ │ │ + open_channels: Dict[str, Endpoint] │ │ │ │ │ + endpoints: 'dict[Endpoint, set[str]]' │ │ │ │ │ + no_endpoints: asyncio.Event # set if endpoints dict is empty │ │ │ │ │ + _eof: bool = False │ │ │ │ │ + │ │ │ │ │ + def __init__(self, routing_rules: List[RoutingRule]): │ │ │ │ │ + for rule in routing_rules: │ │ │ │ │ + rule.router = self │ │ │ │ │ + self.routing_rules = routing_rules │ │ │ │ │ + self.open_channels = {} │ │ │ │ │ + self.endpoints = {} │ │ │ │ │ + self.no_endpoints = asyncio.Event() │ │ │ │ │ + self.no_endpoints.set() # at first there are no endpoints │ │ │ │ │ + │ │ │ │ │ + def check_rules(self, options: JsonObject) -> Endpoint: │ │ │ │ │ + for rule in self.routing_rules: │ │ │ │ │ + logger.debug(' applying rule %s', rule) │ │ │ │ │ + endpoint = rule.apply_rule(options) │ │ │ │ │ + if endpoint is not None: │ │ │ │ │ + logger.debug(' resulting endpoint is %s', endpoint) │ │ │ │ │ + return endpoint │ │ │ │ │ + else: │ │ │ │ │ + logger.debug(' No rules matched') │ │ │ │ │ + raise RoutingError('not-supported') │ │ │ │ │ + │ │ │ │ │ + def drop_channel(self, channel: str) -> None: │ │ │ │ │ + try: │ │ │ │ │ + self.open_channels.pop(channel) │ │ │ │ │ + logger.debug('router dropped channel %s', channel) │ │ │ │ │ + except KeyError: │ │ │ │ │ + logger.error('trying to drop non-existent channel %s from %s', channel, self.open_channels) │ │ │ │ │ + │ │ │ │ │ + def add_endpoint(self, endpoint: Endpoint) -> None: │ │ │ │ │ + self.endpoints[endpoint] = set() │ │ │ │ │ + self.no_endpoints.clear() │ │ │ │ │ + │ │ │ │ │ + def shutdown_endpoint(self, endpoint: Endpoint, _msg: 'JsonObject | None' = None, **kwargs: JsonValue) -> None: │ │ │ │ │ + channels = self.endpoints.pop(endpoint) │ │ │ │ │ + logger.debug('shutdown_endpoint(%s, %s) will close %s', endpoint, kwargs, channels) │ │ │ │ │ + for channel in channels: │ │ │ │ │ + self.write_control(_msg, command='close', channel=channel, **kwargs) │ │ │ │ │ + self.drop_channel(channel) │ │ │ │ │ + │ │ │ │ │ + if not self.endpoints: │ │ │ │ │ + self.no_endpoints.set() │ │ │ │ │ + │ │ │ │ │ + # were we waiting to exit? │ │ │ │ │ + if self._eof: │ │ │ │ │ + logger.debug(' endpoints remaining: %r', self.endpoints) │ │ │ │ │ + if not self.endpoints and self.transport: │ │ │ │ │ + logger.debug(' close transport') │ │ │ │ │ + self.transport.close() │ │ │ │ │ + │ │ │ │ │ + def do_kill(self, host: 'str | None', group: 'str | None', message: JsonObject) -> None: │ │ │ │ │ + endpoints = set(self.endpoints) │ │ │ │ │ + logger.debug('do_kill(%s, %s). Considering %d endpoints.', host, group, len(endpoints)) │ │ │ │ │ + for endpoint in endpoints: │ │ │ │ │ + endpoint.do_kill(host, group, message) │ │ │ │ │ + │ │ │ │ │ + def channel_control_received(self, channel: str, command: str, message: JsonObject) -> None: │ │ │ │ │ + # If this is an open message then we need to apply the routing rules to │ │ │ │ │ + # figure out the correct endpoint to connect. If it's not an open │ │ │ │ │ + # message, then we expect the endpoint to already exist. │ │ │ │ │ + if command == 'open': │ │ │ │ │ + if channel in self.open_channels: │ │ │ │ │ + raise CockpitProtocolError('channel is already open') │ │ │ │ │ + │ │ │ │ │ + try: │ │ │ │ │ + logger.debug('Trying to find endpoint for new channel %s payload=%s', channel, message.get('payload')) │ │ │ │ │ + endpoint = self.check_rules(message) │ │ │ │ │ except RoutingError as exc: │ │ │ │ │ self.write_control(exc.get_attrs(), command='close', channel=channel) │ │ │ │ │ return │ │ │ │ │ │ │ │ │ │ self.open_channels[channel] = endpoint │ │ │ │ │ self.endpoints[endpoint].add(channel) │ │ │ │ │ else: │ │ │ │ │ @@ -4261,15 +4377,15 @@ │ │ │ │ │ finally: │ │ │ │ │ self._communication_done = None │ │ │ │ │ │ │ │ │ │ # In an orderly exit, this is already done, but in case it wasn't │ │ │ │ │ # orderly, we need to make sure the endpoints shut down anyway... │ │ │ │ │ await self.no_endpoints.wait() │ │ │ │ │ ''', │ │ │ │ │ - 'cockpit/samples.py': br'''# This file is part of Cockpit. │ │ │ │ │ + 'cockpit/packages.py': br'''# This file is part of Cockpit. │ │ │ │ │ # │ │ │ │ │ # Copyright (C) 2022 Red Hat, Inc. │ │ │ │ │ # │ │ │ │ │ # This program is free software: you can redistribute it and/or modify │ │ │ │ │ # it under the terms of the GNU General Public License as published by │ │ │ │ │ # the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ # (at your option) any later version. │ │ │ │ │ @@ -4278,437 +4394,579 @@ │ │ │ │ │ # but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ # GNU General Public License for more details. │ │ │ │ │ # │ │ │ │ │ # You should have received a copy of the GNU General Public License │ │ │ │ │ # along with this program. If not, see . │ │ │ │ │ │ │ │ │ │ -import errno │ │ │ │ │ +import collections │ │ │ │ │ +import contextlib │ │ │ │ │ +import functools │ │ │ │ │ +import gzip │ │ │ │ │ +import io │ │ │ │ │ +import itertools │ │ │ │ │ +import json │ │ │ │ │ import logging │ │ │ │ │ +import mimetypes │ │ │ │ │ import os │ │ │ │ │ import re │ │ │ │ │ -from typing import Any, DefaultDict, Iterable, List, NamedTuple, Optional, Tuple │ │ │ │ │ - │ │ │ │ │ -from cockpit._vendor.systemd_ctypes import Handle │ │ │ │ │ +import shutil │ │ │ │ │ +from pathlib import Path │ │ │ │ │ +from typing import ( │ │ │ │ │ + BinaryIO, │ │ │ │ │ + Callable, │ │ │ │ │ + ClassVar, │ │ │ │ │ + Dict, │ │ │ │ │ + Iterable, │ │ │ │ │ + List, │ │ │ │ │ + NamedTuple, │ │ │ │ │ + Optional, │ │ │ │ │ + Pattern, │ │ │ │ │ + Sequence, │ │ │ │ │ + Tuple, │ │ │ │ │ + TypeVar, │ │ │ │ │ +) │ │ │ │ │ │ │ │ │ │ -USER_HZ = os.sysconf(os.sysconf_names['SC_CLK_TCK']) │ │ │ │ │ -MS_PER_JIFFY = 1000 / (USER_HZ if (USER_HZ > 0) else 100) │ │ │ │ │ -HWMON_PATH = '/sys/class/hwmon' │ │ │ │ │ +from cockpit._vendor.systemd_ctypes import bus │ │ │ │ │ │ │ │ │ │ -# we would like to do this, but mypy complains; https://github.com/python/mypy/issues/2900 │ │ │ │ │ -# Samples = collections.defaultdict[str, Union[float, Dict[str, Union[float, None]]]] │ │ │ │ │ -Samples = DefaultDict[str, Any] │ │ │ │ │ +from . import config │ │ │ │ │ +from ._version import __version__ │ │ │ │ │ +from .jsonutil import ( │ │ │ │ │ + JsonError, │ │ │ │ │ + JsonObject, │ │ │ │ │ + JsonValue, │ │ │ │ │ + get_bool, │ │ │ │ │ + get_dict, │ │ │ │ │ + get_int, │ │ │ │ │ + get_objv, │ │ │ │ │ + get_str, │ │ │ │ │ + get_strv, │ │ │ │ │ + json_merge_patch, │ │ │ │ │ + typechecked, │ │ │ │ │ +) │ │ │ │ │ │ │ │ │ │ logger = logging.getLogger(__name__) │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ -def read_int_file(rootfd: int, statfile: str, default: Optional[int] = None, key: bytes = b'') -> Optional[int]: │ │ │ │ │ - # Not every stat is available, such as cpu.weight │ │ │ │ │ - try: │ │ │ │ │ - fd = os.open(statfile, os.O_RDONLY, dir_fd=rootfd) │ │ │ │ │ - except FileNotFoundError: │ │ │ │ │ - return None │ │ │ │ │ +# In practice, this is going to get called over and over again with exactly the │ │ │ │ │ +# same list. Let's try to cache the result. │ │ │ │ │ +@functools.lru_cache() │ │ │ │ │ +def parse_accept_language(accept_language: str) -> Sequence[str]: │ │ │ │ │ + """Parse the Accept-Language header, if it exists. │ │ │ │ │ │ │ │ │ │ - try: │ │ │ │ │ - data = os.read(fd, 1024) │ │ │ │ │ - except OSError as e: │ │ │ │ │ - # cgroups can disappear between the open and read │ │ │ │ │ - if e.errno != errno.ENODEV: │ │ │ │ │ - logger.warning('Failed to read %s: %s', statfile, e) │ │ │ │ │ - return None │ │ │ │ │ - finally: │ │ │ │ │ - os.close(fd) │ │ │ │ │ + Returns an ordered list of languages, with fallbacks inserted, and │ │ │ │ │ + truncated to the position where 'en' would have otherwise appeared, if │ │ │ │ │ + applicable. │ │ │ │ │ │ │ │ │ │ - if key: │ │ │ │ │ - start = data.index(key) + len(key) │ │ │ │ │ - end = data.index(b'\n', start) │ │ │ │ │ - data = data[start:end] │ │ │ │ │ + https://tools.ietf.org/html/rfc7231#section-5.3.5 │ │ │ │ │ + https://datatracker.ietf.org/doc/html/rfc4647#section-3.4 │ │ │ │ │ + """ │ │ │ │ │ │ │ │ │ │ - try: │ │ │ │ │ - # 0 often means "none", so replace it with default value │ │ │ │ │ - return int(data) or default │ │ │ │ │ - except ValueError: │ │ │ │ │ - # Some samples such as "memory.max" contains "max" when there is a no limit │ │ │ │ │ - return None │ │ │ │ │ + logger.debug('parse_accept_language(%r)', accept_language) │ │ │ │ │ + locales_with_q = [] │ │ │ │ │ + for entry in accept_language.split(','): │ │ │ │ │ + entry = entry.strip().lower() │ │ │ │ │ + logger.debug(' entry %r', entry) │ │ │ │ │ + locale, _, qstr = entry.partition(';q=') │ │ │ │ │ + try: │ │ │ │ │ + q = float(qstr or 1.0) │ │ │ │ │ + except ValueError: │ │ │ │ │ + continue # ignore malformed entry │ │ │ │ │ │ │ │ │ │ + while locale: │ │ │ │ │ + logger.debug(' adding %r q=%r', locale, q) │ │ │ │ │ + locales_with_q.append((locale, q)) │ │ │ │ │ + # strip off '-detail' suffixes until there's nothing left │ │ │ │ │ + locale, _, _region = locale.rpartition('-') │ │ │ │ │ │ │ │ │ │ -class SampleDescription(NamedTuple): │ │ │ │ │ - name: str │ │ │ │ │ - units: str │ │ │ │ │ - semantics: str │ │ │ │ │ - instanced: bool │ │ │ │ │ + # Sort the list by highest q value. Otherwise, this is a stable sort. │ │ │ │ │ + locales_with_q.sort(key=lambda pair: pair[1], reverse=True) │ │ │ │ │ + logger.debug(' sorted list is %r', locales_with_q) │ │ │ │ │ │ │ │ │ │ + # If we have 'en' anywhere in our list, ignore it and all items after it. │ │ │ │ │ + # This will result in us getting an untranslated (ie: English) version if │ │ │ │ │ + # none of the more-preferred languages are found, which is what we want. │ │ │ │ │ + # We also take the chance to drop duplicate items. Note: both of these │ │ │ │ │ + # things need to happen after sorting. │ │ │ │ │ + results = [] │ │ │ │ │ + for locale, _q in locales_with_q: │ │ │ │ │ + if locale == 'en': │ │ │ │ │ + break │ │ │ │ │ + if locale not in results: │ │ │ │ │ + results.append(locale) │ │ │ │ │ │ │ │ │ │ -class Sampler: │ │ │ │ │ - descriptions: List[SampleDescription] │ │ │ │ │ + logger.debug(' results list is %r', results) │ │ │ │ │ + return tuple(results) │ │ │ │ │ │ │ │ │ │ - def sample(self, samples: Samples) -> None: │ │ │ │ │ - raise NotImplementedError │ │ │ │ │ │ │ │ │ │ +def sortify_version(version: str) -> str: │ │ │ │ │ + """Convert a version string to a form that can be compared""" │ │ │ │ │ + # 0-pad each numeric component. Only supports numeric versions like 1.2.3. │ │ │ │ │ + return '.'.join(part.zfill(8) for part in version.split('.')) │ │ │ │ │ │ │ │ │ │ -class CPUSampler(Sampler): │ │ │ │ │ - descriptions = [ │ │ │ │ │ - SampleDescription('cpu.basic.nice', 'millisec', 'counter', instanced=False), │ │ │ │ │ - SampleDescription('cpu.basic.user', 'millisec', 'counter', instanced=False), │ │ │ │ │ - SampleDescription('cpu.basic.system', 'millisec', 'counter', instanced=False), │ │ │ │ │ - SampleDescription('cpu.basic.iowait', 'millisec', 'counter', instanced=False), │ │ │ │ │ │ │ │ │ │ - SampleDescription('cpu.core.nice', 'millisec', 'counter', instanced=True), │ │ │ │ │ - SampleDescription('cpu.core.user', 'millisec', 'counter', instanced=True), │ │ │ │ │ - SampleDescription('cpu.core.system', 'millisec', 'counter', instanced=True), │ │ │ │ │ - SampleDescription('cpu.core.iowait', 'millisec', 'counter', instanced=True), │ │ │ │ │ - ] │ │ │ │ │ +@functools.lru_cache() │ │ │ │ │ +def get_libexecdir() -> str: │ │ │ │ │ + """Detect libexecdir on current machine │ │ │ │ │ │ │ │ │ │ - def sample(self, samples: Samples) -> None: │ │ │ │ │ - with open('/proc/stat') as stat: │ │ │ │ │ - for line in stat: │ │ │ │ │ - if not line.startswith('cpu'): │ │ │ │ │ - continue │ │ │ │ │ - cpu, user, nice, system, _idle, iowait = line.split()[:6] │ │ │ │ │ - core = cpu[3:] or None │ │ │ │ │ - if core: │ │ │ │ │ - prefix = 'cpu.core' │ │ │ │ │ - samples[f'{prefix}.nice'][core] = int(nice) * MS_PER_JIFFY │ │ │ │ │ - samples[f'{prefix}.user'][core] = int(user) * MS_PER_JIFFY │ │ │ │ │ - samples[f'{prefix}.system'][core] = int(system) * MS_PER_JIFFY │ │ │ │ │ - samples[f'{prefix}.iowait'][core] = int(iowait) * MS_PER_JIFFY │ │ │ │ │ - else: │ │ │ │ │ - prefix = 'cpu.basic' │ │ │ │ │ - samples[f'{prefix}.nice'] = int(nice) * MS_PER_JIFFY │ │ │ │ │ - samples[f'{prefix}.user'] = int(user) * MS_PER_JIFFY │ │ │ │ │ - samples[f'{prefix}.system'] = int(system) * MS_PER_JIFFY │ │ │ │ │ - samples[f'{prefix}.iowait'] = int(iowait) * MS_PER_JIFFY │ │ │ │ │ + This only works for systems which have cockpit-ws installed. │ │ │ │ │ + """ │ │ │ │ │ + for candidate in ['/usr/local/libexec', '/usr/libexec', '/usr/local/lib/cockpit', '/usr/lib/cockpit']: │ │ │ │ │ + if os.path.exists(os.path.join(candidate, 'cockpit-askpass')): │ │ │ │ │ + return candidate │ │ │ │ │ + else: │ │ │ │ │ + logger.warning('Could not detect libexecdir') │ │ │ │ │ + # give readable error messages │ │ │ │ │ + return '/nonexistent/libexec' │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ -class MemorySampler(Sampler): │ │ │ │ │ - descriptions = [ │ │ │ │ │ - SampleDescription('memory.free', 'bytes', 'instant', instanced=False), │ │ │ │ │ - SampleDescription('memory.used', 'bytes', 'instant', instanced=False), │ │ │ │ │ - SampleDescription('memory.cached', 'bytes', 'instant', instanced=False), │ │ │ │ │ - SampleDescription('memory.swap-used', 'bytes', 'instant', instanced=False), │ │ │ │ │ - ] │ │ │ │ │ +# HACK: Type narrowing over Union types is not supported in the general case, │ │ │ │ │ +# but this works for the case we care about: knowing that when we pass in an │ │ │ │ │ +# JsonObject, we'll get an JsonObject back. │ │ │ │ │ +J = TypeVar('J', JsonObject, JsonValue) │ │ │ │ │ │ │ │ │ │ - def sample(self, samples: Samples) -> None: │ │ │ │ │ - with open('/proc/meminfo') as meminfo: │ │ │ │ │ - items = {k: int(v.strip(' kB\n')) for line in meminfo for k, v in [line.split(':', 1)]} │ │ │ │ │ │ │ │ │ │ - samples['memory.free'] = 1024 * items['MemFree'] │ │ │ │ │ - samples['memory.used'] = 1024 * (items['MemTotal'] - items['MemAvailable']) │ │ │ │ │ - samples['memory.cached'] = 1024 * (items['Buffers'] + items['Cached']) │ │ │ │ │ - samples['memory.swap-used'] = 1024 * (items['SwapTotal'] - items['SwapFree']) │ │ │ │ │ +def patch_libexecdir(obj: J) -> J: │ │ │ │ │ + if isinstance(obj, str): │ │ │ │ │ + if '${libexecdir}/cockpit-askpass' in obj: │ │ │ │ │ + # extra-special case: we handle this internally │ │ │ │ │ + abs_askpass = shutil.which('cockpit-askpass') │ │ │ │ │ + if abs_askpass is not None: │ │ │ │ │ + return obj.replace('${libexecdir}/cockpit-askpass', abs_askpass) │ │ │ │ │ + return obj.replace('${libexecdir}', get_libexecdir()) │ │ │ │ │ + elif isinstance(obj, dict): │ │ │ │ │ + return {key: patch_libexecdir(value) for key, value in obj.items()} │ │ │ │ │ + elif isinstance(obj, list): │ │ │ │ │ + return [patch_libexecdir(item) for item in obj] │ │ │ │ │ + else: │ │ │ │ │ + return obj │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ -class CPUTemperatureSampler(Sampler): │ │ │ │ │ - # Cache found sensors, as they can't be hotplugged. │ │ │ │ │ - sensors: Optional[List[str]] = None │ │ │ │ │ +# A document is a binary stream with a Content-Type, optional Content-Encoding, │ │ │ │ │ +# and optional Content-Security-Policy │ │ │ │ │ +class Document(NamedTuple): │ │ │ │ │ + data: BinaryIO │ │ │ │ │ + content_type: str │ │ │ │ │ + content_encoding: Optional[str] = None │ │ │ │ │ + content_security_policy: Optional[str] = None │ │ │ │ │ │ │ │ │ │ - descriptions = [ │ │ │ │ │ - SampleDescription('cpu.temperature', 'celsius', 'instant', instanced=True), │ │ │ │ │ - ] │ │ │ │ │ │ │ │ │ │ - @staticmethod │ │ │ │ │ - def detect_cpu_sensors(dir_fd: int) -> Iterable[str]: │ │ │ │ │ - # Read the name file to decide what to do with this directory │ │ │ │ │ +class PackagesListener: │ │ │ │ │ + def packages_loaded(self) -> None: │ │ │ │ │ + """Called when the packages have been reloaded""" │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class BridgeConfig(dict, JsonObject): │ │ │ │ │ + def __init__(self, value: JsonObject): │ │ │ │ │ + super().__init__(value) │ │ │ │ │ + │ │ │ │ │ + self.label = get_str(self, 'label', None) │ │ │ │ │ + │ │ │ │ │ + self.privileged = get_bool(self, 'privileged', default=False) │ │ │ │ │ + self.match = get_dict(self, 'match', {}) │ │ │ │ │ + if not self.privileged and not self.match: │ │ │ │ │ + raise JsonError(value, 'must have match rules or be privileged') │ │ │ │ │ + │ │ │ │ │ + self.environ = get_strv(self, 'environ', ()) │ │ │ │ │ + self.spawn = get_strv(self, 'spawn') │ │ │ │ │ + if not self.spawn: │ │ │ │ │ + raise JsonError(value, 'spawn vector must be non-empty') │ │ │ │ │ + │ │ │ │ │ + self.name = self.label or self.spawn[0] │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class Condition: │ │ │ │ │ + def __init__(self, value: JsonObject): │ │ │ │ │ try: │ │ │ │ │ - with Handle.open('name', os.O_RDONLY, dir_fd=dir_fd) as fd: │ │ │ │ │ - name = os.read(fd, 1024).decode().strip() │ │ │ │ │ - except FileNotFoundError: │ │ │ │ │ - return │ │ │ │ │ + (self.name, self.value), = value.items() │ │ │ │ │ + except ValueError as exc: │ │ │ │ │ + raise JsonError(value, 'must contain exactly one key/value pair') from exc │ │ │ │ │ │ │ │ │ │ - if name == 'atk0110': │ │ │ │ │ - # only sample 'CPU Temperature' in atk0110 │ │ │ │ │ - predicate = (lambda label: label == 'CPU Temperature') │ │ │ │ │ - elif name == 'cpu_thermal': │ │ │ │ │ - # labels are not used on ARM │ │ │ │ │ - predicate = None │ │ │ │ │ - elif name == 'coretemp': │ │ │ │ │ - # accept all labels on Intel │ │ │ │ │ - predicate = None │ │ │ │ │ - elif name in ['k8temp', 'k10temp']: │ │ │ │ │ - predicate = None │ │ │ │ │ - else: │ │ │ │ │ - # Not a CPU sensor │ │ │ │ │ + │ │ │ │ │ +class Manifest(dict, JsonObject): │ │ │ │ │ + # Skip version check when running out of the git checkout (__version__ is None) │ │ │ │ │ + COCKPIT_VERSION = __version__ and sortify_version(__version__) │ │ │ │ │ + │ │ │ │ │ + def __init__(self, path: Path, value: JsonObject): │ │ │ │ │ + super().__init__(value) │ │ │ │ │ + self.path = path │ │ │ │ │ + self.name = get_str(self, 'name', self.path.name) │ │ │ │ │ + self.bridges = get_objv(self, 'bridges', BridgeConfig) │ │ │ │ │ + self.priority = get_int(self, 'priority', 1) │ │ │ │ │ + self.csp = get_str(self, 'content-security-policy', '') │ │ │ │ │ + self.conditions = get_objv(self, 'conditions', Condition) │ │ │ │ │ + │ │ │ │ │ + # Skip version check when running out of the git checkout (COCKPIT_VERSION is None) │ │ │ │ │ + if self.COCKPIT_VERSION is not None: │ │ │ │ │ + requires = get_dict(self, 'requires', {}) │ │ │ │ │ + for name, version in requires.items(): │ │ │ │ │ + if name != 'cockpit': │ │ │ │ │ + raise JsonError(name, 'non-cockpit requirement listed') │ │ │ │ │ + if sortify_version(typechecked(version, str)) > self.COCKPIT_VERSION: │ │ │ │ │ + raise JsonError(version, f'required cockpit version ({version}) not met') │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class Package: │ │ │ │ │ + # For po{,.manifest}.js files, the interesting part is the locale name │ │ │ │ │ + PO_JS_RE: ClassVar[Pattern] = re.compile(r'(po|po\.manifest)\.([^.]+)\.js(\.gz)?') │ │ │ │ │ + │ │ │ │ │ + # immutable after __init__ │ │ │ │ │ + manifest: Manifest │ │ │ │ │ + name: str │ │ │ │ │ + path: Path │ │ │ │ │ + priority: int │ │ │ │ │ + │ │ │ │ │ + # computed later │ │ │ │ │ + translations: Optional[Dict[str, Dict[str, str]]] = None │ │ │ │ │ + files: Optional[Dict[str, str]] = None │ │ │ │ │ + │ │ │ │ │ + def __init__(self, manifest: Manifest): │ │ │ │ │ + self.manifest = manifest │ │ │ │ │ + self.name = manifest.name │ │ │ │ │ + self.path = manifest.path │ │ │ │ │ + self.priority = manifest.priority │ │ │ │ │ + │ │ │ │ │ + def ensure_scanned(self) -> None: │ │ │ │ │ + """Ensure that the package has been scanned. │ │ │ │ │ + │ │ │ │ │ + This allows us to defer scanning the files of the package until we know │ │ │ │ │ + that we'll actually use it. │ │ │ │ │ + """ │ │ │ │ │ + │ │ │ │ │ + if self.files is not None: │ │ │ │ │ return │ │ │ │ │ │ │ │ │ │ - # Now scan the directory for inputs │ │ │ │ │ - for input_filename in os.listdir(dir_fd): │ │ │ │ │ - if not input_filename.endswith('_input'): │ │ │ │ │ + self.files = {} │ │ │ │ │ + self.translations = {'po.js': {}, 'po.manifest.js': {}} │ │ │ │ │ + │ │ │ │ │ + for file in self.path.rglob('*'): │ │ │ │ │ + name = str(file.relative_to(self.path)) │ │ │ │ │ + if name in ['.', '..', 'manifest.json']: │ │ │ │ │ continue │ │ │ │ │ │ │ │ │ │ - if predicate: │ │ │ │ │ - # We need to check the label │ │ │ │ │ - try: │ │ │ │ │ - label_filename = input_filename.replace('_input', '_label') │ │ │ │ │ - with Handle.open(label_filename, os.O_RDONLY, dir_fd=dir_fd) as fd: │ │ │ │ │ - label = os.read(fd, 1024).decode().strip() │ │ │ │ │ - except FileNotFoundError: │ │ │ │ │ - continue │ │ │ │ │ + po_match = Package.PO_JS_RE.fullmatch(name) │ │ │ │ │ + if po_match: │ │ │ │ │ + basename = po_match.group(1) │ │ │ │ │ + locale = po_match.group(2) │ │ │ │ │ + # Accept-Language is case-insensitive and uses '-' to separate variants │ │ │ │ │ + lower_locale = locale.lower().replace('_', '-') │ │ │ │ │ │ │ │ │ │ - if not predicate(label): │ │ │ │ │ - continue │ │ │ │ │ + logger.debug('Adding translation %r %r -> %r', basename, lower_locale, name) │ │ │ │ │ + self.translations[f'{basename}.js'][lower_locale] = name │ │ │ │ │ + else: │ │ │ │ │ + # strip out trailing '.gz' components │ │ │ │ │ + basename = re.sub('.gz$', '', name) │ │ │ │ │ + logger.debug('Adding content %r -> %r', basename, name) │ │ │ │ │ + self.files[basename] = name │ │ │ │ │ │ │ │ │ │ - yield input_filename │ │ │ │ │ + # If we see a filename like `x.min.js` we want to also offer it │ │ │ │ │ + # at `x.js`, but only if `x.js(.gz)` itself is not present. │ │ │ │ │ + # Note: this works for both the case where we found the `x.js` │ │ │ │ │ + # first (it's already in the map) and also if we find it second │ │ │ │ │ + # (it will be replaced in the map by the line just above). │ │ │ │ │ + # See https://github.com/cockpit-project/cockpit/pull/19716 │ │ │ │ │ + self.files.setdefault(basename.replace('.min.', '.'), name) │ │ │ │ │ │ │ │ │ │ - @staticmethod │ │ │ │ │ - def scan_sensors() -> Iterable[str]: │ │ │ │ │ - try: │ │ │ │ │ - top_fd = Handle.open(HWMON_PATH, os.O_RDONLY | os.O_DIRECTORY) │ │ │ │ │ - except FileNotFoundError: │ │ │ │ │ - return │ │ │ │ │ + # support old cockpit-po-plugin which didn't write po.manifest.??.js │ │ │ │ │ + if not self.translations['po.manifest.js']: │ │ │ │ │ + self.translations['po.manifest.js'] = self.translations['po.js'] │ │ │ │ │ │ │ │ │ │ - with top_fd: │ │ │ │ │ - for hwmon_name in os.listdir(top_fd): │ │ │ │ │ - with Handle.open(hwmon_name, os.O_RDONLY | os.O_DIRECTORY, dir_fd=top_fd) as subdir_fd: │ │ │ │ │ - for sensor in CPUTemperatureSampler.detect_cpu_sensors(subdir_fd): │ │ │ │ │ - yield f'{HWMON_PATH}/{hwmon_name}/{sensor}' │ │ │ │ │ + def get_content_security_policy(self) -> str: │ │ │ │ │ + policy = { │ │ │ │ │ + "default-src": "'self'", │ │ │ │ │ + "connect-src": "'self'", │ │ │ │ │ + "form-action": "'self'", │ │ │ │ │ + "base-uri": "'self'", │ │ │ │ │ + "object-src": "'none'", │ │ │ │ │ + "font-src": "'self' data:", │ │ │ │ │ + "img-src": "'self' data:", │ │ │ │ │ + } │ │ │ │ │ │ │ │ │ │ - def sample(self, samples: Samples) -> None: │ │ │ │ │ - if self.sensors is None: │ │ │ │ │ - self.sensors = list(CPUTemperatureSampler.scan_sensors()) │ │ │ │ │ + for item in self.manifest.csp.split(';'): │ │ │ │ │ + item = item.strip() │ │ │ │ │ + if item: │ │ │ │ │ + key, _, value = item.strip().partition(' ') │ │ │ │ │ + policy[key] = value │ │ │ │ │ │ │ │ │ │ - for sensor_path in self.sensors: │ │ │ │ │ - with open(sensor_path) as sensor: │ │ │ │ │ - temperature = int(sensor.read().strip()) │ │ │ │ │ - if temperature == 0: │ │ │ │ │ - return │ │ │ │ │ + return ' '.join(f'{k} {v};' for k, v in policy.items()) + ' block-all-mixed-content' │ │ │ │ │ │ │ │ │ │ - samples['cpu.temperature'][sensor_path] = temperature / 1000 │ │ │ │ │ + def load_file(self, filename: str) -> Document: │ │ │ │ │ + content_type, content_encoding = mimetypes.guess_type(filename) │ │ │ │ │ + content_security_policy = None │ │ │ │ │ │ │ │ │ │ + if content_type is None: │ │ │ │ │ + content_type = 'text/plain' │ │ │ │ │ + elif content_type.startswith('text/html'): │ │ │ │ │ + content_security_policy = self.get_content_security_policy() │ │ │ │ │ │ │ │ │ │ -class DiskSampler(Sampler): │ │ │ │ │ - descriptions = [ │ │ │ │ │ - SampleDescription('disk.all.read', 'bytes', 'counter', instanced=False), │ │ │ │ │ - SampleDescription('disk.all.written', 'bytes', 'counter', instanced=False), │ │ │ │ │ - SampleDescription('disk.dev.read', 'bytes', 'counter', instanced=True), │ │ │ │ │ - SampleDescription('disk.dev.written', 'bytes', 'counter', instanced=True), │ │ │ │ │ - ] │ │ │ │ │ + path = self.path / filename │ │ │ │ │ + logger.debug(' loading data from %s', path) │ │ │ │ │ │ │ │ │ │ - def sample(self, samples: Samples) -> None: │ │ │ │ │ - with open('/proc/diskstats') as diskstats: │ │ │ │ │ - all_read_bytes = 0 │ │ │ │ │ - all_written_bytes = 0 │ │ │ │ │ + return Document(path.open('rb'), content_type, content_encoding, content_security_policy) │ │ │ │ │ │ │ │ │ │ - for line in diskstats: │ │ │ │ │ - # https://www.kernel.org/doc/Documentation/ABI/testing/procfs-diskstats │ │ │ │ │ - fields = line.strip().split() │ │ │ │ │ - dev_major = fields[0] │ │ │ │ │ - dev_name = fields[2] │ │ │ │ │ - num_sectors_read = fields[5] │ │ │ │ │ - num_sectors_written = fields[9] │ │ │ │ │ + def load_translation(self, path: str, locales: Sequence[str]) -> Document: │ │ │ │ │ + self.ensure_scanned() │ │ │ │ │ + assert self.translations is not None │ │ │ │ │ │ │ │ │ │ - # ignore mdraid │ │ │ │ │ - if dev_major == '9': │ │ │ │ │ - continue │ │ │ │ │ + # First match wins │ │ │ │ │ + for locale in locales: │ │ │ │ │ + with contextlib.suppress(KeyError): │ │ │ │ │ + return self.load_file(self.translations[path][locale]) │ │ │ │ │ │ │ │ │ │ - # ignore device-mapper │ │ │ │ │ - if dev_name.startswith('dm-'): │ │ │ │ │ - continue │ │ │ │ │ + # We prefer to return an empty document than 404 in order to avoid │ │ │ │ │ + # errors in the console when a translation can't be found │ │ │ │ │ + return Document(io.BytesIO(), 'text/javascript') │ │ │ │ │ │ │ │ │ │ - # Skip partitions │ │ │ │ │ - if dev_name[:2] in ['sd', 'hd', 'vd'] and dev_name[-1].isdigit(): │ │ │ │ │ - continue │ │ │ │ │ + def load_path(self, path: str, headers: JsonObject) -> Document: │ │ │ │ │ + self.ensure_scanned() │ │ │ │ │ + assert self.files is not None │ │ │ │ │ + assert self.translations is not None │ │ │ │ │ │ │ │ │ │ - # Ignore nvme partitions │ │ │ │ │ - if dev_name.startswith('nvme') and 'p' in dev_name: │ │ │ │ │ - continue │ │ │ │ │ + if path in self.translations: │ │ │ │ │ + locales = parse_accept_language(get_str(headers, 'Accept-Language', '')) │ │ │ │ │ + return self.load_translation(path, locales) │ │ │ │ │ + else: │ │ │ │ │ + return self.load_file(self.files[path]) │ │ │ │ │ │ │ │ │ │ - read_bytes = int(num_sectors_read) * 512 │ │ │ │ │ - written_bytes = int(num_sectors_written) * 512 │ │ │ │ │ │ │ │ │ │ - all_read_bytes += read_bytes │ │ │ │ │ - all_written_bytes += written_bytes │ │ │ │ │ +class PackagesLoader: │ │ │ │ │ + CONDITIONS: ClassVar[Dict[str, Callable[[str], bool]]] = { │ │ │ │ │ + 'path-exists': os.path.exists, │ │ │ │ │ + 'path-not-exists': lambda p: not os.path.exists(p), │ │ │ │ │ + } │ │ │ │ │ │ │ │ │ │ - samples['disk.dev.read'][dev_name] = read_bytes │ │ │ │ │ - samples['disk.dev.written'][dev_name] = written_bytes │ │ │ │ │ + @classmethod │ │ │ │ │ + def get_xdg_data_dirs(cls) -> Iterable[str]: │ │ │ │ │ + try: │ │ │ │ │ + yield os.environ['XDG_DATA_HOME'] │ │ │ │ │ + except KeyError: │ │ │ │ │ + yield os.path.expanduser('~/.local/share') │ │ │ │ │ │ │ │ │ │ - samples['disk.all.read'] = all_read_bytes │ │ │ │ │ - samples['disk.all.written'] = all_written_bytes │ │ │ │ │ + try: │ │ │ │ │ + yield from os.environ['XDG_DATA_DIRS'].split(':') │ │ │ │ │ + except KeyError: │ │ │ │ │ + yield from ('/usr/local/share', '/usr/share') │ │ │ │ │ │ │ │ │ │ + @classmethod │ │ │ │ │ + def patch_manifest(cls, manifest: JsonObject, parent: Path) -> JsonObject: │ │ │ │ │ + override_files = [ │ │ │ │ │ + parent / 'override.json', │ │ │ │ │ + config.lookup_config(f'{parent.name}.override.json'), │ │ │ │ │ + config.DOT_CONFIG_COCKPIT / f'{parent.name}.override.json', │ │ │ │ │ + ] │ │ │ │ │ │ │ │ │ │ -class CGroupSampler(Sampler): │ │ │ │ │ - descriptions = [ │ │ │ │ │ - SampleDescription('cgroup.memory.usage', 'bytes', 'instant', instanced=True), │ │ │ │ │ - SampleDescription('cgroup.memory.limit', 'bytes', 'instant', instanced=True), │ │ │ │ │ - SampleDescription('cgroup.memory.sw-usage', 'bytes', 'instant', instanced=True), │ │ │ │ │ - SampleDescription('cgroup.memory.sw-limit', 'bytes', 'instant', instanced=True), │ │ │ │ │ - SampleDescription('cgroup.cpu.usage', 'millisec', 'counter', instanced=True), │ │ │ │ │ - SampleDescription('cgroup.cpu.shares', 'count', 'instant', instanced=True), │ │ │ │ │ - ] │ │ │ │ │ + for override_file in override_files: │ │ │ │ │ + try: │ │ │ │ │ + override: JsonValue = json.loads(override_file.read_bytes()) │ │ │ │ │ + except FileNotFoundError: │ │ │ │ │ + continue │ │ │ │ │ + except json.JSONDecodeError as exc: │ │ │ │ │ + # User input error: report a warning │ │ │ │ │ + logger.warning('%s: %s', override_file, exc) │ │ │ │ │ │ │ │ │ │ - cgroups_v2: Optional[bool] = None │ │ │ │ │ + if not isinstance(override, dict): │ │ │ │ │ + logger.warning('%s: override file is not a dictionary', override_file) │ │ │ │ │ + continue │ │ │ │ │ │ │ │ │ │ - def sample(self, samples: Samples) -> None: │ │ │ │ │ - if self.cgroups_v2 is None: │ │ │ │ │ - self.cgroups_v2 = os.path.exists('/sys/fs/cgroup/cgroup.controllers') │ │ │ │ │ + manifest = json_merge_patch(manifest, override) │ │ │ │ │ │ │ │ │ │ - if self.cgroups_v2: │ │ │ │ │ - cgroups_v2_path = '/sys/fs/cgroup/' │ │ │ │ │ - for path, _, _, rootfd in os.fwalk(cgroups_v2_path): │ │ │ │ │ - cgroup = path.replace(cgroups_v2_path, '') │ │ │ │ │ + return patch_libexecdir(manifest) │ │ │ │ │ │ │ │ │ │ - if not cgroup: │ │ │ │ │ + @classmethod │ │ │ │ │ + def load_manifests(cls) -> Iterable[Manifest]: │ │ │ │ │ + for datadir in cls.get_xdg_data_dirs(): │ │ │ │ │ + logger.debug("Scanning for manifest files under %s", datadir) │ │ │ │ │ + for file in Path(datadir).glob('cockpit/*/manifest.json'): │ │ │ │ │ + logger.debug("Considering file %s", file) │ │ │ │ │ + try: │ │ │ │ │ + manifest = json.loads(file.read_text()) │ │ │ │ │ + except json.JSONDecodeError as exc: │ │ │ │ │ + logger.error("%s: %s", file, exc) │ │ │ │ │ + continue │ │ │ │ │ + if not isinstance(manifest, dict): │ │ │ │ │ + logger.error("%s: json document isn't an object", file) │ │ │ │ │ continue │ │ │ │ │ │ │ │ │ │ - samples['cgroup.memory.usage'][cgroup] = read_int_file(rootfd, 'memory.current', 0) │ │ │ │ │ - samples['cgroup.memory.limit'][cgroup] = read_int_file(rootfd, 'memory.max') │ │ │ │ │ - samples['cgroup.memory.sw-usage'][cgroup] = read_int_file(rootfd, 'memory.swap.current', 0) │ │ │ │ │ - samples['cgroup.memory.sw-limit'][cgroup] = read_int_file(rootfd, 'memory.swap.max') │ │ │ │ │ - samples['cgroup.cpu.shares'][cgroup] = read_int_file(rootfd, 'cpu.weight') │ │ │ │ │ - usage_usec = read_int_file(rootfd, 'cpu.stat', 0, key=b'usage_usec') │ │ │ │ │ - if usage_usec: │ │ │ │ │ - samples['cgroup.cpu.usage'][cgroup] = usage_usec / 1000 │ │ │ │ │ - else: │ │ │ │ │ - memory_path = '/sys/fs/cgroup/memory/' │ │ │ │ │ - for path, _, _, rootfd in os.fwalk(memory_path): │ │ │ │ │ - cgroup = path.replace(memory_path, '') │ │ │ │ │ + parent = file.parent │ │ │ │ │ + manifest = cls.patch_manifest(manifest, parent) │ │ │ │ │ + try: │ │ │ │ │ + yield Manifest(parent, manifest) │ │ │ │ │ + except JsonError as exc: │ │ │ │ │ + logger.warning('%s %s', file, exc) │ │ │ │ │ │ │ │ │ │ - if not cgroup: │ │ │ │ │ - continue │ │ │ │ │ + def check_condition(self, condition: str, value: object) -> bool: │ │ │ │ │ + check_fn = self.CONDITIONS[condition] │ │ │ │ │ │ │ │ │ │ - samples['cgroup.memory.usage'][cgroup] = read_int_file(rootfd, 'memory.usage_in_bytes', 0) │ │ │ │ │ - samples['cgroup.memory.limit'][cgroup] = read_int_file(rootfd, 'memory.limit_in_bytes') │ │ │ │ │ - samples['cgroup.memory.sw-usage'][cgroup] = read_int_file(rootfd, 'memory.memsw.usage_in_bytes', 0) │ │ │ │ │ - samples['cgroup.memory.sw-limit'][cgroup] = read_int_file(rootfd, 'memory.memsw.limit_in_bytes') │ │ │ │ │ + # All known predicates currently only work on strings │ │ │ │ │ + if not isinstance(value, str): │ │ │ │ │ + return False │ │ │ │ │ │ │ │ │ │ - cpu_path = '/sys/fs/cgroup/cpu/' │ │ │ │ │ - for path, _, _, rootfd in os.fwalk(cpu_path): │ │ │ │ │ - cgroup = path.replace(cpu_path, '') │ │ │ │ │ + return check_fn(value) │ │ │ │ │ │ │ │ │ │ - if not cgroup: │ │ │ │ │ - continue │ │ │ │ │ + def check_conditions(self, manifest: Manifest) -> bool: │ │ │ │ │ + for condition in manifest.conditions: │ │ │ │ │ + try: │ │ │ │ │ + okay = self.check_condition(condition.name, condition.value) │ │ │ │ │ + except KeyError: │ │ │ │ │ + # do *not* ignore manifests with unknown predicates, for forward compatibility │ │ │ │ │ + logger.warning(' %s: ignoring unknown predicate in manifest: %s', manifest.path, condition.name) │ │ │ │ │ + continue │ │ │ │ │ │ │ │ │ │ - samples['cgroup.cpu.shares'][cgroup] = read_int_file(rootfd, 'cpu.shares') │ │ │ │ │ - usage_nsec = read_int_file(rootfd, 'cpuacct.usage') │ │ │ │ │ - if usage_nsec: │ │ │ │ │ - samples['cgroup.cpu.usage'][cgroup] = usage_nsec / 1000000 │ │ │ │ │ + if not okay: │ │ │ │ │ + logger.debug(' hiding package %s as its %s condition is not met', manifest.path, condition) │ │ │ │ │ + return False │ │ │ │ │ │ │ │ │ │ + return True │ │ │ │ │ │ │ │ │ │ -class CGroupDiskIO(Sampler): │ │ │ │ │ - IO_RE = re.compile(rb'\bread_bytes: (?P\d+).*\nwrite_bytes: (?P\d+)', flags=re.S) │ │ │ │ │ - descriptions = [ │ │ │ │ │ - SampleDescription('disk.cgroup.read', 'bytes', 'counter', instanced=True), │ │ │ │ │ - SampleDescription('disk.cgroup.written', 'bytes', 'counter', instanced=True), │ │ │ │ │ - ] │ │ │ │ │ + def load_packages(self) -> Iterable[Tuple[str, Package]]: │ │ │ │ │ + logger.debug('Scanning for available package manifests:') │ │ │ │ │ + # Sort all available packages into buckets by to their claimed name │ │ │ │ │ + names: Dict[str, List[Manifest]] = collections.defaultdict(list) │ │ │ │ │ + for manifest in self.load_manifests(): │ │ │ │ │ + logger.debug(' %s/manifest.json', manifest.path) │ │ │ │ │ + names[manifest.name].append(manifest) │ │ │ │ │ + logger.debug('done.') │ │ │ │ │ │ │ │ │ │ - @staticmethod │ │ │ │ │ - def get_cgroup_name(fd: int) -> str: │ │ │ │ │ - with Handle.open('cgroup', os.O_RDONLY, dir_fd=fd) as cgroup_fd: │ │ │ │ │ - cgroup_name = os.read(cgroup_fd, 2048).decode().strip() │ │ │ │ │ + logger.debug('Selecting packages to serve:') │ │ │ │ │ + for name, candidates in names.items(): │ │ │ │ │ + # For each package name, iterate the candidates in descending │ │ │ │ │ + # priority order and select the first one which passes all checks │ │ │ │ │ + for candidate in sorted(candidates, key=lambda manifest: manifest.priority, reverse=True): │ │ │ │ │ + try: │ │ │ │ │ + if self.check_conditions(candidate): │ │ │ │ │ + logger.debug(' creating package %s -> %s', name, candidate.path) │ │ │ │ │ + yield name, Package(candidate) │ │ │ │ │ + break │ │ │ │ │ + except JsonError: │ │ │ │ │ + logger.warning(' %s: ignoring package with invalid manifest file', candidate.path) │ │ │ │ │ │ │ │ │ │ - # Skip leading ::0/ │ │ │ │ │ - return cgroup_name[4:] │ │ │ │ │ + logger.debug(' ignoring %s: unmet conditions', candidate.path) │ │ │ │ │ + logger.debug('done.') │ │ │ │ │ │ │ │ │ │ - @staticmethod │ │ │ │ │ - def get_proc_io(fd: int) -> Tuple[int, int]: │ │ │ │ │ - with Handle.open('io', os.O_RDONLY, dir_fd=fd) as io_fd: │ │ │ │ │ - data = os.read(io_fd, 4096) │ │ │ │ │ │ │ │ │ │ - match = re.search(CGroupDiskIO.IO_RE, data) │ │ │ │ │ - if match: │ │ │ │ │ - proc_read = int(match.group('read')) │ │ │ │ │ - proc_write = int(match.group('write')) │ │ │ │ │ +class Packages(bus.Object, interface='cockpit.Packages'): │ │ │ │ │ + loader: PackagesLoader │ │ │ │ │ + listener: Optional[PackagesListener] │ │ │ │ │ + packages: Dict[str, Package] │ │ │ │ │ + saw_first_reload_hint: bool │ │ │ │ │ │ │ │ │ │ - return proc_read, proc_write │ │ │ │ │ + def __init__(self, listener: Optional[PackagesListener] = None, loader: Optional[PackagesLoader] = None): │ │ │ │ │ + self.listener = listener │ │ │ │ │ + self.loader = loader or PackagesLoader() │ │ │ │ │ + self.load() │ │ │ │ │ │ │ │ │ │ - return 0, 0 │ │ │ │ │ + # Reloading the Shell in the browser should reload the │ │ │ │ │ + # packages. This is implemented by having the Shell call │ │ │ │ │ + # reload_hint whenever it starts. The first call of this │ │ │ │ │ + # method in each session is ignored so that packages are not │ │ │ │ │ + # loaded twice right after logging in. │ │ │ │ │ + # │ │ │ │ │ + self.saw_first_reload_hint = False │ │ │ │ │ │ │ │ │ │ - def sample(self, samples: Samples): │ │ │ │ │ - with Handle.open('/proc', os.O_RDONLY | os.O_DIRECTORY) as proc_fd: │ │ │ │ │ - reads = samples['disk.cgroup.read'] │ │ │ │ │ - writes = samples['disk.cgroup.written'] │ │ │ │ │ + def load(self) -> None: │ │ │ │ │ + self.packages = dict(self.loader.load_packages()) │ │ │ │ │ + self.manifests = json.dumps({name: dict(package.manifest) for name, package in self.packages.items()}) │ │ │ │ │ + logger.debug('Packages loaded: %s', list(self.packages)) │ │ │ │ │ │ │ │ │ │ - for path in os.listdir(proc_fd): │ │ │ │ │ - # non-pid entries in proc are guaranteed to start with a character a-z │ │ │ │ │ - if path[0] < '0' or path[0] > '9': │ │ │ │ │ - continue │ │ │ │ │ + def show(self): │ │ │ │ │ + for name in sorted(self.packages): │ │ │ │ │ + package = self.packages[name] │ │ │ │ │ + menuitems = [] │ │ │ │ │ + for entry in itertools.chain( │ │ │ │ │ + package.manifest.get('menu', {}).values(), │ │ │ │ │ + package.manifest.get('tools', {}).values()): │ │ │ │ │ + with contextlib.suppress(KeyError): │ │ │ │ │ + menuitems.append(entry['label']) │ │ │ │ │ + print(f'{name:20} {", ".join(menuitems):40} {package.path}') │ │ │ │ │ │ │ │ │ │ - try: │ │ │ │ │ - with Handle.open(path, os.O_PATH, dir_fd=proc_fd) as pid_fd: │ │ │ │ │ - cgroup_name = self.get_cgroup_name(pid_fd) │ │ │ │ │ - proc_read, proc_write = self.get_proc_io(pid_fd) │ │ │ │ │ - except (FileNotFoundError, PermissionError, ProcessLookupError): │ │ │ │ │ - continue │ │ │ │ │ + def get_bridge_configs(self) -> Sequence[BridgeConfig]: │ │ │ │ │ + def yield_configs(): │ │ │ │ │ + for package in sorted(self.packages.values(), key=lambda package: -package.priority): │ │ │ │ │ + yield from package.manifest.bridges │ │ │ │ │ + return tuple(yield_configs()) │ │ │ │ │ │ │ │ │ │ - reads[cgroup_name] = reads.get(cgroup_name, 0) + proc_read │ │ │ │ │ - writes[cgroup_name] = writes.get(cgroup_name, 0) + proc_write │ │ │ │ │ + # D-Bus Interface │ │ │ │ │ + manifests = bus.Interface.Property('s', value="{}") │ │ │ │ │ │ │ │ │ │ + @bus.Interface.Method() │ │ │ │ │ + def reload(self): │ │ │ │ │ + self.load() │ │ │ │ │ + if self.listener is not None: │ │ │ │ │ + self.listener.packages_loaded() │ │ │ │ │ │ │ │ │ │ -class NetworkSampler(Sampler): │ │ │ │ │ - descriptions = [ │ │ │ │ │ - SampleDescription('network.interface.tx', 'bytes', 'counter', instanced=True), │ │ │ │ │ - SampleDescription('network.interface.rx', 'bytes', 'counter', instanced=True), │ │ │ │ │ - ] │ │ │ │ │ + @bus.Interface.Method() │ │ │ │ │ + def reload_hint(self): │ │ │ │ │ + if self.saw_first_reload_hint: │ │ │ │ │ + self.reload() │ │ │ │ │ + self.saw_first_reload_hint = True │ │ │ │ │ │ │ │ │ │ - def sample(self, samples: Samples) -> None: │ │ │ │ │ - with open("/proc/net/dev") as network_samples: │ │ │ │ │ - for line in network_samples: │ │ │ │ │ - fields = line.split() │ │ │ │ │ + def load_manifests_js(self, headers: JsonObject) -> Document: │ │ │ │ │ + logger.debug('Serving /manifests.js') │ │ │ │ │ │ │ │ │ │ - # Skip header line │ │ │ │ │ - if fields[0][-1] != ':': │ │ │ │ │ - continue │ │ │ │ │ + chunks: List[bytes] = [] │ │ │ │ │ │ │ │ │ │ - iface = fields[0][:-1] │ │ │ │ │ - samples['network.interface.rx'][iface] = int(fields[1]) │ │ │ │ │ - samples['network.interface.tx'][iface] = int(fields[9]) │ │ │ │ │ + # Send the translations required for the manifest files, from each package │ │ │ │ │ + locales = parse_accept_language(get_str(headers, 'Accept-Language', '')) │ │ │ │ │ + for name, package in self.packages.items(): │ │ │ │ │ + if name in ['static', 'base1']: │ │ │ │ │ + continue │ │ │ │ │ │ │ │ │ │ + # find_translation will always find at least 'en' │ │ │ │ │ + translation = package.load_translation('po.manifest.js', locales) │ │ │ │ │ + with translation.data: │ │ │ │ │ + if translation.content_encoding == 'gzip': │ │ │ │ │ + data = gzip.decompress(translation.data.read()) │ │ │ │ │ + else: │ │ │ │ │ + data = translation.data.read() │ │ │ │ │ │ │ │ │ │ -class MountSampler(Sampler): │ │ │ │ │ - descriptions = [ │ │ │ │ │ - SampleDescription('mount.total', 'bytes', 'instant', instanced=True), │ │ │ │ │ - SampleDescription('mount.used', 'bytes', 'instant', instanced=True), │ │ │ │ │ - ] │ │ │ │ │ + chunks.append(data) │ │ │ │ │ │ │ │ │ │ - def sample(self, samples: Samples) -> None: │ │ │ │ │ - with open('/proc/mounts') as mounts: │ │ │ │ │ - for line in mounts: │ │ │ │ │ - # Only look at real devices │ │ │ │ │ - if line[0] != '/': │ │ │ │ │ - continue │ │ │ │ │ + chunks.append(b""" │ │ │ │ │ + (function (root, data) { │ │ │ │ │ + if (typeof define === 'function' && define.amd) { │ │ │ │ │ + define(data); │ │ │ │ │ + } │ │ │ │ │ │ │ │ │ │ - path = line.split()[1] │ │ │ │ │ - try: │ │ │ │ │ - res = os.statvfs(path) │ │ │ │ │ - except OSError: │ │ │ │ │ - continue │ │ │ │ │ - frsize = res.f_frsize │ │ │ │ │ - total = frsize * res.f_blocks │ │ │ │ │ - samples['mount.total'][path] = total │ │ │ │ │ - samples['mount.used'][path] = total - frsize * res.f_bfree │ │ │ │ │ + if (typeof cockpit === 'object') { │ │ │ │ │ + cockpit.manifests = data; │ │ │ │ │ + } else { │ │ │ │ │ + root.manifests = data; │ │ │ │ │ + } │ │ │ │ │ + }(this, """ + self.manifests.encode() + b"""))""") │ │ │ │ │ │ │ │ │ │ + return Document(io.BytesIO(b'\n'.join(chunks)), 'text/javascript') │ │ │ │ │ │ │ │ │ │ -class BlockSampler(Sampler): │ │ │ │ │ - descriptions = [ │ │ │ │ │ - SampleDescription('block.device.read', 'bytes', 'counter', instanced=True), │ │ │ │ │ - SampleDescription('block.device.written', 'bytes', 'counter', instanced=True), │ │ │ │ │ - ] │ │ │ │ │ + def load_manifests_json(self) -> Document: │ │ │ │ │ + logger.debug('Serving /manifests.json') │ │ │ │ │ + return Document(io.BytesIO(self.manifests.encode()), 'application/json') │ │ │ │ │ │ │ │ │ │ - def sample(self, samples: Samples) -> None: │ │ │ │ │ - with open('/proc/diskstats') as diskstats: │ │ │ │ │ - for line in diskstats: │ │ │ │ │ - # https://www.kernel.org/doc/Documentation/ABI/testing/procfs-diskstats │ │ │ │ │ - [_, _, dev_name, _, _, sectors_read, _, _, _, sectors_written, *_] = line.strip().split() │ │ │ │ │ + PATH_RE = re.compile( │ │ │ │ │ + r'/' # leading '/' │ │ │ │ │ + r'(?:([^/]+)/)?' # optional leading path component │ │ │ │ │ + r'((?:[^/]+/)*[^/]+)' # remaining path components │ │ │ │ │ + ) │ │ │ │ │ │ │ │ │ │ - samples['block.device.read'][dev_name] = int(sectors_read) * 512 │ │ │ │ │ - samples['block.device.written'][dev_name] = int(sectors_written) * 512 │ │ │ │ │ + def load_path(self, path: str, headers: JsonObject) -> Document: │ │ │ │ │ + logger.debug('packages: serving %s', path) │ │ │ │ │ │ │ │ │ │ + match = self.PATH_RE.fullmatch(path) │ │ │ │ │ + if match is None: │ │ │ │ │ + raise ValueError(f'Invalid HTTP path {path}') │ │ │ │ │ + packagename, filename = match.groups() │ │ │ │ │ │ │ │ │ │ -SAMPLERS = [ │ │ │ │ │ - BlockSampler, │ │ │ │ │ - CGroupSampler, │ │ │ │ │ - CGroupDiskIO, │ │ │ │ │ - CPUSampler, │ │ │ │ │ - CPUTemperatureSampler, │ │ │ │ │ - DiskSampler, │ │ │ │ │ - MemorySampler, │ │ │ │ │ - MountSampler, │ │ │ │ │ - NetworkSampler, │ │ │ │ │ -] │ │ │ │ │ + if packagename is not None: │ │ │ │ │ + return self.packages[packagename].load_path(filename, headers) │ │ │ │ │ + elif filename == 'manifests.js': │ │ │ │ │ + return self.load_manifests_js(headers) │ │ │ │ │ + elif filename == 'manifests.json': │ │ │ │ │ + return self.load_manifests_json() │ │ │ │ │ + else: │ │ │ │ │ + raise KeyError │ │ │ │ │ ''', │ │ │ │ │ - 'cockpit/protocol.py': br'''# This file is part of Cockpit. │ │ │ │ │ + 'cockpit/channels/http.py': br'''# This file is part of Cockpit. │ │ │ │ │ # │ │ │ │ │ # Copyright (C) 2022 Red Hat, Inc. │ │ │ │ │ # │ │ │ │ │ # This program is free software: you can redistribute it and/or modify │ │ │ │ │ # it under the terms of the GNU General Public License as published by │ │ │ │ │ # the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ # (at your option) any later version. │ │ │ │ │ @@ -4717,1838 +4975,1843 @@ │ │ │ │ │ # but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ # GNU General Public License for more details. │ │ │ │ │ # │ │ │ │ │ # You should have received a copy of the GNU General Public License │ │ │ │ │ # along with this program. If not, see . │ │ │ │ │ │ │ │ │ │ -import asyncio │ │ │ │ │ -import json │ │ │ │ │ +import http.client │ │ │ │ │ import logging │ │ │ │ │ -import traceback │ │ │ │ │ -import uuid │ │ │ │ │ +import socket │ │ │ │ │ +import ssl │ │ │ │ │ │ │ │ │ │ -from .jsonutil import JsonError, JsonObject, JsonValue, create_object, get_int, get_str, get_str_or_none, typechecked │ │ │ │ │ +from ..channel import AsyncChannel, ChannelError │ │ │ │ │ +from ..jsonutil import JsonObject, get_dict, get_enum, get_int, get_object, get_str, typechecked │ │ │ │ │ │ │ │ │ │ logger = logging.getLogger(__name__) │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ -class CockpitProblem(Exception): │ │ │ │ │ - """A type of exception that carries a problem code and a message. │ │ │ │ │ - │ │ │ │ │ - Depending on the scope, this is used to handle shutting down: │ │ │ │ │ - │ │ │ │ │ - - an individual channel (sends problem code in the close message) │ │ │ │ │ - - peer connections (sends problem code in close message for each open channel) │ │ │ │ │ - - the main stdio interaction with the bridge │ │ │ │ │ - │ │ │ │ │ - It is usually thrown in response to some violation of expected protocol │ │ │ │ │ - when parsing messages, connecting to a peer, or opening a channel. │ │ │ │ │ - """ │ │ │ │ │ - attrs: JsonObject │ │ │ │ │ - │ │ │ │ │ - def __init__(self, problem: str, _msg: 'JsonObject | None' = None, **kwargs: JsonValue) -> None: │ │ │ │ │ - kwargs['problem'] = problem │ │ │ │ │ - self.attrs = create_object(_msg, kwargs) │ │ │ │ │ - super().__init__(get_str(self.attrs, 'message', problem)) │ │ │ │ │ - │ │ │ │ │ - def get_attrs(self) -> JsonObject: │ │ │ │ │ - if self.attrs['problem'] == 'internal-error' and self.__cause__ is not None: │ │ │ │ │ - return dict(self.attrs, cause=traceback.format_exception( │ │ │ │ │ - self.__cause__.__class__, self.__cause__, self.__cause__.__traceback__ │ │ │ │ │ - )) │ │ │ │ │ - else: │ │ │ │ │ - return self.attrs │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -class CockpitProtocolError(CockpitProblem): │ │ │ │ │ - def __init__(self, message: str, problem: str = 'protocol-error'): │ │ │ │ │ - super().__init__(problem, message=message) │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -class CockpitProtocol(asyncio.Protocol): │ │ │ │ │ - """A naive implementation of the Cockpit frame protocol │ │ │ │ │ - │ │ │ │ │ - We need to use this because Python's SelectorEventLoop doesn't supported │ │ │ │ │ - buffered protocols. │ │ │ │ │ - """ │ │ │ │ │ - transport: 'asyncio.Transport | None' = None │ │ │ │ │ - buffer = b'' │ │ │ │ │ - _closed: bool = False │ │ │ │ │ - _communication_done: 'asyncio.Future[None] | None' = None │ │ │ │ │ - │ │ │ │ │ - def do_ready(self) -> None: │ │ │ │ │ - pass │ │ │ │ │ - │ │ │ │ │ - def do_closed(self, exc: 'Exception | None') -> None: │ │ │ │ │ - pass │ │ │ │ │ - │ │ │ │ │ - def transport_control_received(self, command: str, message: JsonObject) -> None: │ │ │ │ │ - raise NotImplementedError │ │ │ │ │ - │ │ │ │ │ - def channel_control_received(self, channel: str, command: str, message: JsonObject) -> None: │ │ │ │ │ - raise NotImplementedError │ │ │ │ │ +class HttpChannel(AsyncChannel): │ │ │ │ │ + payload = 'http-stream2' │ │ │ │ │ │ │ │ │ │ - def channel_data_received(self, channel: str, data: bytes) -> None: │ │ │ │ │ - raise NotImplementedError │ │ │ │ │ + @staticmethod │ │ │ │ │ + def get_headers(response: http.client.HTTPResponse, *, binary: bool) -> JsonObject: │ │ │ │ │ + # Never send these headers │ │ │ │ │ + remove = {'Connection', 'Transfer-Encoding'} │ │ │ │ │ │ │ │ │ │ - def frame_received(self, frame: bytes) -> None: │ │ │ │ │ - header, _, data = frame.partition(b'\n') │ │ │ │ │ + if not binary: │ │ │ │ │ + # Only send these headers for raw binary streams │ │ │ │ │ + remove.update({'Content-Length', 'Range'}) │ │ │ │ │ │ │ │ │ │ - if header != b'': │ │ │ │ │ - channel = header.decode('ascii') │ │ │ │ │ - logger.debug('data received: %d bytes of data for channel %s', len(data), channel) │ │ │ │ │ - self.channel_data_received(channel, data) │ │ │ │ │ + return {key: value for key, value in response.getheaders() if key not in remove} │ │ │ │ │ │ │ │ │ │ - else: │ │ │ │ │ - self.control_received(data) │ │ │ │ │ + @staticmethod │ │ │ │ │ + def create_client(options: JsonObject) -> http.client.HTTPConnection: │ │ │ │ │ + opt_address = get_str(options, 'address', 'localhost') │ │ │ │ │ + opt_tls = get_dict(options, 'tls', None) │ │ │ │ │ + opt_unix = get_str(options, 'unix', None) │ │ │ │ │ + opt_port = get_int(options, 'port', None) │ │ │ │ │ │ │ │ │ │ - def control_received(self, data: bytes) -> None: │ │ │ │ │ - try: │ │ │ │ │ - message = typechecked(json.loads(data), dict) │ │ │ │ │ - command = get_str(message, 'command') │ │ │ │ │ - channel = get_str(message, 'channel', None) │ │ │ │ │ + if opt_tls is not None and opt_unix is not None: │ │ │ │ │ + raise ChannelError('protocol-error', message='TLS on Unix socket is not supported') │ │ │ │ │ + if opt_port is None and opt_unix is None: │ │ │ │ │ + raise ChannelError('protocol-error', message='no "port" or "unix" option for channel') │ │ │ │ │ + if opt_port is not None and opt_unix is not None: │ │ │ │ │ + raise ChannelError('protocol-error', message='cannot specify both "port" and "unix" options') │ │ │ │ │ │ │ │ │ │ - if channel is not None: │ │ │ │ │ - logger.debug('channel control received %s', message) │ │ │ │ │ - self.channel_control_received(channel, command, message) │ │ │ │ │ + if opt_tls is not None: │ │ │ │ │ + authority = get_dict(opt_tls, 'authority', None) │ │ │ │ │ + if authority is not None: │ │ │ │ │ + data = get_str(authority, 'data', None) │ │ │ │ │ + if data is not None: │ │ │ │ │ + context = ssl.create_default_context(cadata=data) │ │ │ │ │ + else: │ │ │ │ │ + context = ssl.create_default_context(cafile=get_str(authority, 'file')) │ │ │ │ │ else: │ │ │ │ │ - logger.debug('transport control received %s', message) │ │ │ │ │ - self.transport_control_received(command, message) │ │ │ │ │ - │ │ │ │ │ - except (json.JSONDecodeError, JsonError) as exc: │ │ │ │ │ - raise CockpitProtocolError(f'control message: {exc!s}') from exc │ │ │ │ │ - │ │ │ │ │ - def consume_one_frame(self, data: bytes) -> int: │ │ │ │ │ - """Consumes a single frame from view. │ │ │ │ │ - │ │ │ │ │ - Returns positive if a number of bytes were consumed, or negative if no │ │ │ │ │ - work can be done because of a given number of bytes missing. │ │ │ │ │ - """ │ │ │ │ │ - │ │ │ │ │ - try: │ │ │ │ │ - newline = data.index(b'\n') │ │ │ │ │ - except ValueError as exc: │ │ │ │ │ - if len(data) < 10: │ │ │ │ │ - # Let's try reading more │ │ │ │ │ - return len(data) - 10 │ │ │ │ │ - raise CockpitProtocolError("size line is too long") from exc │ │ │ │ │ - │ │ │ │ │ - try: │ │ │ │ │ - length = int(data[:newline]) │ │ │ │ │ - except ValueError as exc: │ │ │ │ │ - raise CockpitProtocolError("frame size is not an integer") from exc │ │ │ │ │ - │ │ │ │ │ - start = newline + 1 │ │ │ │ │ - end = start + length │ │ │ │ │ - │ │ │ │ │ - if end > len(data): │ │ │ │ │ - # We need to read more │ │ │ │ │ - return len(data) - end │ │ │ │ │ - │ │ │ │ │ - # We can consume a full frame │ │ │ │ │ - self.frame_received(data[start:end]) │ │ │ │ │ - return end │ │ │ │ │ - │ │ │ │ │ - def connection_made(self, transport: asyncio.BaseTransport) -> None: │ │ │ │ │ - logger.debug('connection_made(%s)', transport) │ │ │ │ │ - assert isinstance(transport, asyncio.Transport) │ │ │ │ │ - self.transport = transport │ │ │ │ │ - self.do_ready() │ │ │ │ │ - │ │ │ │ │ - if self._closed: │ │ │ │ │ - logger.debug(' but the protocol already was closed, so closing transport') │ │ │ │ │ - transport.close() │ │ │ │ │ - │ │ │ │ │ - def connection_lost(self, exc: 'Exception | None') -> None: │ │ │ │ │ - logger.debug('connection_lost') │ │ │ │ │ - assert self.transport is not None │ │ │ │ │ - self.transport = None │ │ │ │ │ - self.close(exc) │ │ │ │ │ + context = ssl.create_default_context() │ │ │ │ │ │ │ │ │ │ - def close(self, exc: 'Exception | None' = None) -> None: │ │ │ │ │ - if self._closed: │ │ │ │ │ - return │ │ │ │ │ - self._closed = True │ │ │ │ │ + if 'validate' in opt_tls and not opt_tls['validate']: │ │ │ │ │ + context.check_hostname = False │ │ │ │ │ + context.verify_mode = ssl.VerifyMode.CERT_NONE │ │ │ │ │ │ │ │ │ │ - if self.transport: │ │ │ │ │ - self.transport.close() │ │ │ │ │ + # See https://github.com/python/typeshed/issues/11057 │ │ │ │ │ + return http.client.HTTPSConnection(opt_address, port=opt_port, context=context) # type: ignore[arg-type] │ │ │ │ │ │ │ │ │ │ - self.do_closed(exc) │ │ │ │ │ + else: │ │ │ │ │ + return http.client.HTTPConnection(opt_address, port=opt_port) │ │ │ │ │ │ │ │ │ │ - def write_channel_data(self, channel: str, payload: bytes) -> None: │ │ │ │ │ - """Send a given payload (bytes) on channel (string)""" │ │ │ │ │ - # Channel is certainly ascii (as enforced by .encode() below) │ │ │ │ │ - frame_length = len(channel + '\n') + len(payload) │ │ │ │ │ - header = f'{frame_length}\n{channel}\n'.encode('ascii') │ │ │ │ │ - if self.transport is not None: │ │ │ │ │ - logger.debug('writing to transport %s', self.transport) │ │ │ │ │ - self.transport.write(header + payload) │ │ │ │ │ + @staticmethod │ │ │ │ │ + def connect(connection: http.client.HTTPConnection, opt_unix: 'str | None') -> None: │ │ │ │ │ + # Blocks. Runs in a thread. │ │ │ │ │ + if opt_unix: │ │ │ │ │ + # create the connection's socket so that it won't call .connect() internally (which only supports TCP) │ │ │ │ │ + connection.sock = socket.socket(socket.AF_UNIX) │ │ │ │ │ + connection.sock.connect(opt_unix) │ │ │ │ │ else: │ │ │ │ │ - logger.debug('cannot write to closed transport') │ │ │ │ │ + # explicitly call connect(), so that we can do proper error handling │ │ │ │ │ + connection.connect() │ │ │ │ │ │ │ │ │ │ - def write_control(self, _msg: 'JsonObject | None' = None, **kwargs: JsonValue) -> None: │ │ │ │ │ - """Write a control message. See jsonutil.create_object() for details.""" │ │ │ │ │ - logger.debug('sending control message %r %r', _msg, kwargs) │ │ │ │ │ - pretty = json.dumps(create_object(_msg, kwargs), indent=2) + '\n' │ │ │ │ │ - self.write_channel_data('', pretty.encode()) │ │ │ │ │ + @staticmethod │ │ │ │ │ + def request( │ │ │ │ │ + connection: http.client.HTTPConnection, method: str, path: str, headers: 'dict[str, str]', body: bytes │ │ │ │ │ + ) -> http.client.HTTPResponse: │ │ │ │ │ + # Blocks. Runs in a thread. │ │ │ │ │ + connection.request(method, path, headers=headers or {}, body=body) │ │ │ │ │ + return connection.getresponse() │ │ │ │ │ │ │ │ │ │ - def data_received(self, data: bytes) -> None: │ │ │ │ │ - try: │ │ │ │ │ - self.buffer += data │ │ │ │ │ - while self.buffer: │ │ │ │ │ - result = self.consume_one_frame(self.buffer) │ │ │ │ │ - if result <= 0: │ │ │ │ │ - return │ │ │ │ │ - self.buffer = self.buffer[result:] │ │ │ │ │ - except CockpitProtocolError as exc: │ │ │ │ │ - self.close(exc) │ │ │ │ │ + async def run(self, options: JsonObject) -> None: │ │ │ │ │ + logger.debug('open %s', options) │ │ │ │ │ │ │ │ │ │ - def eof_received(self) -> bool: │ │ │ │ │ - return False │ │ │ │ │ + binary = get_enum(options, 'binary', ['raw'], None) is not None │ │ │ │ │ + method = get_str(options, 'method') │ │ │ │ │ + path = get_str(options, 'path') │ │ │ │ │ + headers = get_object(options, 'headers', lambda d: {k: typechecked(v, str) for k, v in d.items()}, None) │ │ │ │ │ │ │ │ │ │ + if 'connection' in options: │ │ │ │ │ + raise ChannelError('protocol-error', message='connection sharing is not implemented on this bridge') │ │ │ │ │ │ │ │ │ │ -# Helpful functionality for "server"-side protocol implementations │ │ │ │ │ -class CockpitProtocolServer(CockpitProtocol): │ │ │ │ │ - init_host: 'str | None' = None │ │ │ │ │ - authorizations: 'dict[str, asyncio.Future[str]] | None' = None │ │ │ │ │ + connection = self.create_client(options) │ │ │ │ │ │ │ │ │ │ - def do_send_init(self) -> None: │ │ │ │ │ - raise NotImplementedError │ │ │ │ │ + self.ready() │ │ │ │ │ │ │ │ │ │ - def do_init(self, message: JsonObject) -> None: │ │ │ │ │ - pass │ │ │ │ │ + body = b'' │ │ │ │ │ + while True: │ │ │ │ │ + data = await self.read() │ │ │ │ │ + if data is None: │ │ │ │ │ + break │ │ │ │ │ + body += data │ │ │ │ │ │ │ │ │ │ - def do_kill(self, host: 'str | None', group: 'str | None', message: JsonObject) -> None: │ │ │ │ │ - raise NotImplementedError │ │ │ │ │ + # Connect in a thread and handle errors │ │ │ │ │ + try: │ │ │ │ │ + await self.in_thread(self.connect, connection, get_str(options, 'unix', None)) │ │ │ │ │ + except ssl.SSLCertVerificationError as exc: │ │ │ │ │ + raise ChannelError('unknown-hostkey', message=str(exc)) from exc │ │ │ │ │ + except (OSError, IOError) as exc: │ │ │ │ │ + raise ChannelError('not-found', message=str(exc)) from exc │ │ │ │ │ │ │ │ │ │ - def transport_control_received(self, command: str, message: JsonObject) -> None: │ │ │ │ │ - if command == 'init': │ │ │ │ │ - if get_int(message, 'version') != 1: │ │ │ │ │ - raise CockpitProtocolError('incorrect version number') │ │ │ │ │ - self.init_host = get_str(message, 'host') │ │ │ │ │ - self.do_init(message) │ │ │ │ │ - elif command == 'kill': │ │ │ │ │ - self.do_kill(get_str_or_none(message, 'host', None), get_str_or_none(message, 'group', None), message) │ │ │ │ │ - elif command == 'authorize': │ │ │ │ │ - self.do_authorize(message) │ │ │ │ │ - else: │ │ │ │ │ - raise CockpitProtocolError(f'unexpected control message {command} received') │ │ │ │ │ + # Submit request in a thread and handle errors │ │ │ │ │ + try: │ │ │ │ │ + response = await self.in_thread(self.request, connection, method, path, headers or {}, body) │ │ │ │ │ + except (http.client.HTTPException, OSError) as exc: │ │ │ │ │ + raise ChannelError('terminated', message=str(exc)) from exc │ │ │ │ │ │ │ │ │ │ - def do_ready(self) -> None: │ │ │ │ │ - self.do_send_init() │ │ │ │ │ + self.send_control(command='response', │ │ │ │ │ + status=response.status, │ │ │ │ │ + reason=response.reason, │ │ │ │ │ + headers=self.get_headers(response, binary=binary)) │ │ │ │ │ │ │ │ │ │ - # authorize request/response API │ │ │ │ │ - async def request_authorization( │ │ │ │ │ - self, challenge: str, timeout: 'int | None' = None, **kwargs: JsonValue │ │ │ │ │ - ) -> str: │ │ │ │ │ - if self.authorizations is None: │ │ │ │ │ - self.authorizations = {} │ │ │ │ │ - cookie = str(uuid.uuid4()) │ │ │ │ │ - future = asyncio.get_running_loop().create_future() │ │ │ │ │ + # Receive the body and finish up │ │ │ │ │ try: │ │ │ │ │ - self.authorizations[cookie] = future │ │ │ │ │ - self.write_control(None, command='authorize', challenge=challenge, cookie=cookie, **kwargs) │ │ │ │ │ - return await asyncio.wait_for(future, timeout) │ │ │ │ │ - finally: │ │ │ │ │ - self.authorizations.pop(cookie) │ │ │ │ │ + while True: │ │ │ │ │ + block = await self.in_thread(response.read1, self.BLOCK_SIZE) │ │ │ │ │ + if not block: │ │ │ │ │ + break │ │ │ │ │ + await self.write(block) │ │ │ │ │ │ │ │ │ │ - def do_authorize(self, message: JsonObject) -> None: │ │ │ │ │ - cookie = get_str(message, 'cookie') │ │ │ │ │ - response = get_str(message, 'response') │ │ │ │ │ + logger.debug('reading response done') │ │ │ │ │ + # this returns immediately and does not read anything more, but updates the http.client's │ │ │ │ │ + # internal state machine to "response done" │ │ │ │ │ + block = response.read() │ │ │ │ │ + assert block == b'' │ │ │ │ │ │ │ │ │ │ - if self.authorizations is None or cookie not in self.authorizations: │ │ │ │ │ - logger.warning('no matching authorize request') │ │ │ │ │ - return │ │ │ │ │ + await self.in_thread(connection.close) │ │ │ │ │ + except (http.client.HTTPException, OSError) as exc: │ │ │ │ │ + raise ChannelError('terminated', message=str(exc)) from exc │ │ │ │ │ │ │ │ │ │ - self.authorizations[cookie].set_result(response) │ │ │ │ │ + self.done() │ │ │ │ │ ''', │ │ │ │ │ - 'cockpit/_vendor/__init__.py': br'''''', │ │ │ │ │ - 'cockpit/_vendor/bei/tmpfs.py': br'''import os │ │ │ │ │ -import subprocess │ │ │ │ │ -import sys │ │ │ │ │ -import tempfile │ │ │ │ │ - │ │ │ │ │ + 'cockpit/channels/__init__.py': br'''# This file is part of Cockpit. │ │ │ │ │ +# │ │ │ │ │ +# Copyright (C) 2022 Red Hat, Inc. │ │ │ │ │ +# │ │ │ │ │ +# This program is free software: you can redistribute it and/or modify │ │ │ │ │ +# it under the terms of the GNU General Public License as published by │ │ │ │ │ +# the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ +# (at your option) any later version. │ │ │ │ │ +# │ │ │ │ │ +# This program is distributed in the hope that it will be useful, │ │ │ │ │ +# but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ +# GNU General Public License for more details. │ │ │ │ │ +# │ │ │ │ │ +# You should have received a copy of the GNU General Public License │ │ │ │ │ +# along with this program. If not, see . │ │ │ │ │ │ │ │ │ │ -def main(*command: str) -> None: │ │ │ │ │ - with tempfile.TemporaryDirectory() as tmpdir: │ │ │ │ │ - os.chdir(tmpdir) │ │ │ │ │ +from .dbus import DBusChannel │ │ │ │ │ +from .filesystem import FsInfoChannel, FsListChannel, FsReadChannel, FsReplaceChannel, FsWatchChannel │ │ │ │ │ +from .http import HttpChannel │ │ │ │ │ +from .metrics import InternalMetricsChannel │ │ │ │ │ +from .packages import PackagesChannel │ │ │ │ │ +from .stream import SocketStreamChannel, SubprocessStreamChannel │ │ │ │ │ +from .trivial import EchoChannel, NullChannel │ │ │ │ │ │ │ │ │ │ - for key, value in __loader__.get_contents().items(): │ │ │ │ │ - if key.startswith('tmpfs/'): │ │ │ │ │ - subdir = os.path.dirname(key) │ │ │ │ │ - os.makedirs(subdir, exist_ok=True) │ │ │ │ │ - with open(key, 'wb') as fp: │ │ │ │ │ - fp.write(value) │ │ │ │ │ +CHANNEL_TYPES = [ │ │ │ │ │ + DBusChannel, │ │ │ │ │ + EchoChannel, │ │ │ │ │ + FsInfoChannel, │ │ │ │ │ + FsListChannel, │ │ │ │ │ + FsReadChannel, │ │ │ │ │ + FsReplaceChannel, │ │ │ │ │ + FsWatchChannel, │ │ │ │ │ + HttpChannel, │ │ │ │ │ + InternalMetricsChannel, │ │ │ │ │ + NullChannel, │ │ │ │ │ + PackagesChannel, │ │ │ │ │ + SubprocessStreamChannel, │ │ │ │ │ + SocketStreamChannel, │ │ │ │ │ +] │ │ │ │ │ +''', │ │ │ │ │ + 'cockpit/channels/trivial.py': br'''# This file is part of Cockpit. │ │ │ │ │ +# │ │ │ │ │ +# Copyright (C) 2022 Red Hat, Inc. │ │ │ │ │ +# │ │ │ │ │ +# This program is free software: you can redistribute it and/or modify │ │ │ │ │ +# it under the terms of the GNU General Public License as published by │ │ │ │ │ +# the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ +# (at your option) any later version. │ │ │ │ │ +# │ │ │ │ │ +# This program is distributed in the hope that it will be useful, │ │ │ │ │ +# but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ +# GNU General Public License for more details. │ │ │ │ │ +# │ │ │ │ │ +# You should have received a copy of the GNU General Public License │ │ │ │ │ +# along with this program. If not, see . │ │ │ │ │ │ │ │ │ │ - os.chdir('tmpfs') │ │ │ │ │ +import logging │ │ │ │ │ │ │ │ │ │ - result = subprocess.run(command, check=False) │ │ │ │ │ - sys.exit(result.returncode) │ │ │ │ │ -''', │ │ │ │ │ - 'cockpit/_vendor/bei/spawn.py': br'''"""Helper to create a beipack to spawn a command with files in a tmpdir""" │ │ │ │ │ +from ..channel import Channel │ │ │ │ │ │ │ │ │ │ -import argparse │ │ │ │ │ -import os │ │ │ │ │ -import sys │ │ │ │ │ +logger = logging.getLogger(__name__) │ │ │ │ │ │ │ │ │ │ -from . import pack, tmpfs │ │ │ │ │ │ │ │ │ │ +class EchoChannel(Channel): │ │ │ │ │ + payload = 'echo' │ │ │ │ │ │ │ │ │ │ -def main() -> None: │ │ │ │ │ - parser = argparse.ArgumentParser() │ │ │ │ │ - parser.add_argument('--file', '-f', action='append') │ │ │ │ │ - parser.add_argument('command', nargs='+', help='The command to execute') │ │ │ │ │ - args = parser.parse_args() │ │ │ │ │ + def do_open(self, options): │ │ │ │ │ + self.ready() │ │ │ │ │ │ │ │ │ │ - contents = { │ │ │ │ │ - '_beitmpfs.py': tmpfs.__spec__.loader.get_data(tmpfs.__spec__.origin) │ │ │ │ │ - } │ │ │ │ │ + def do_data(self, data): │ │ │ │ │ + self.send_data(data) │ │ │ │ │ │ │ │ │ │ - if args.file is not None: │ │ │ │ │ - files = args.file │ │ │ │ │ - else: │ │ │ │ │ - file = args.command[-1] │ │ │ │ │ - files = [file] │ │ │ │ │ - args.command[-1] = './' + os.path.basename(file) │ │ │ │ │ + def do_done(self): │ │ │ │ │ + self.done() │ │ │ │ │ + self.close() │ │ │ │ │ │ │ │ │ │ - for filename in files: │ │ │ │ │ - with open(filename, 'rb') as file: │ │ │ │ │ - basename = os.path.basename(filename) │ │ │ │ │ - contents[f'tmpfs/{basename}'] = file.read() │ │ │ │ │ │ │ │ │ │ - script = pack.pack(contents, '_beitmpfs:main', '*' + repr(args.command)) │ │ │ │ │ - sys.stdout.write(script) │ │ │ │ │ +class NullChannel(Channel): │ │ │ │ │ + payload = 'null' │ │ │ │ │ │ │ │ │ │ + def do_open(self, options): │ │ │ │ │ + self.ready() │ │ │ │ │ │ │ │ │ │ -if __name__ == '__main__': │ │ │ │ │ - main() │ │ │ │ │ + def do_close(self): │ │ │ │ │ + self.close() │ │ │ │ │ ''', │ │ │ │ │ - 'cockpit/_vendor/bei/beipack.py': br'''# beipack - Remote bootloader for Python │ │ │ │ │ + 'cockpit/channels/metrics.py': br'''# This file is part of Cockpit. │ │ │ │ │ # │ │ │ │ │ -# Copyright (C) 2022 Allison Karlitskaya │ │ │ │ │ +# Copyright (C) 2022 Red Hat, Inc. │ │ │ │ │ # │ │ │ │ │ # This program is free software: you can redistribute it and/or modify │ │ │ │ │ # it under the terms of the GNU General Public License as published by │ │ │ │ │ # the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ # (at your option) any later version. │ │ │ │ │ # │ │ │ │ │ # This program is distributed in the hope that it will be useful, │ │ │ │ │ # but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ # GNU General Public License for more details. │ │ │ │ │ # │ │ │ │ │ # You should have received a copy of the GNU General Public License │ │ │ │ │ -# along with this program. If not, see . │ │ │ │ │ +# along with this program. If not, see . │ │ │ │ │ │ │ │ │ │ -import argparse │ │ │ │ │ -import binascii │ │ │ │ │ -import lzma │ │ │ │ │ -import os │ │ │ │ │ +import asyncio │ │ │ │ │ +import json │ │ │ │ │ +import logging │ │ │ │ │ import sys │ │ │ │ │ -import tempfile │ │ │ │ │ -import zipfile │ │ │ │ │ -from typing import Dict, Iterable, List, Optional, Set, Tuple │ │ │ │ │ - │ │ │ │ │ -from .data import read_data_file │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -def escape_string(data: str) -> str: │ │ │ │ │ - # Avoid mentioning ' ' ' literally, to make our own packing a bit prettier │ │ │ │ │ - triplequote = "'" * 3 │ │ │ │ │ - if triplequote not in data: │ │ │ │ │ - return "r" + triplequote + data + triplequote │ │ │ │ │ - if '"""' not in data: │ │ │ │ │ - return 'r"""' + data + '"""' │ │ │ │ │ - return repr(data) │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -def ascii_bytes_repr(data: bytes) -> str: │ │ │ │ │ - return 'b' + escape_string(data.decode('ascii')) │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -def utf8_bytes_repr(data: bytes) -> str: │ │ │ │ │ - return escape_string(data.decode('utf-8')) + ".encode('utf-8')" │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -def base64_bytes_repr(data: bytes, imports: Set[str]) -> str: │ │ │ │ │ - # base85 is smaller, but base64 is in C, and ~20x faster. │ │ │ │ │ - # when compressing with `xz -e` the size difference is marginal. │ │ │ │ │ - imports.add('from binascii import a2b_base64') │ │ │ │ │ - encoded = binascii.b2a_base64(data).decode('ascii').strip() │ │ │ │ │ - return f'a2b_base64("{encoded}")' │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -def bytes_repr(data: bytes, imports: Set[str]) -> str: │ │ │ │ │ - # Strategy: │ │ │ │ │ - # if the file is ascii, encode it directly as bytes │ │ │ │ │ - # otherwise, if it's UTF-8, use a unicode string and encode │ │ │ │ │ - # otherwise, base64 │ │ │ │ │ - │ │ │ │ │ - try: │ │ │ │ │ - return ascii_bytes_repr(data) │ │ │ │ │ - except UnicodeDecodeError: │ │ │ │ │ - # it's not ascii │ │ │ │ │ - pass │ │ │ │ │ - │ │ │ │ │ - # utf-8 │ │ │ │ │ - try: │ │ │ │ │ - return utf8_bytes_repr(data) │ │ │ │ │ - except UnicodeDecodeError: │ │ │ │ │ - # it's not utf-8 │ │ │ │ │ - pass │ │ │ │ │ - │ │ │ │ │ - return base64_bytes_repr(data, imports) │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -def dict_repr(contents: Dict[str, bytes], imports: Set[str]) -> str: │ │ │ │ │ - return ('{\n' + │ │ │ │ │ - ''.join(f' {repr(k)}: {bytes_repr(v, imports)},\n' │ │ │ │ │ - for k, v in contents.items()) + │ │ │ │ │ - '}') │ │ │ │ │ +import time │ │ │ │ │ +from collections import defaultdict │ │ │ │ │ +from typing import Dict, List, NamedTuple, Optional, Set, Tuple, Union │ │ │ │ │ │ │ │ │ │ +from ..channel import AsyncChannel, ChannelError │ │ │ │ │ +from ..jsonutil import JsonList │ │ │ │ │ +from ..samples import SAMPLERS, SampleDescription, Sampler, Samples │ │ │ │ │ │ │ │ │ │ -def pack(contents: Dict[str, bytes], │ │ │ │ │ - entrypoint: Optional[str] = None, │ │ │ │ │ - args: str = '') -> str: │ │ │ │ │ - """Creates a beipack with the given `contents`. │ │ │ │ │ +logger = logging.getLogger(__name__) │ │ │ │ │ │ │ │ │ │ - If `entrypoint` is given, it should be an entry point which is run as the │ │ │ │ │ - "main" function. It is given in the `package.module:func format` such that │ │ │ │ │ - the following code is emitted: │ │ │ │ │ │ │ │ │ │ - from package.module import func as main │ │ │ │ │ - main() │ │ │ │ │ +class MetricInfo(NamedTuple): │ │ │ │ │ + derive: Optional[str] │ │ │ │ │ + desc: SampleDescription │ │ │ │ │ │ │ │ │ │ - Additionally, if `args` is given, it is written verbatim between the parens │ │ │ │ │ - of the call to main (ie: it should already be in Python syntax). │ │ │ │ │ - """ │ │ │ │ │ │ │ │ │ │ - loader = read_data_file('beipack_loader.py') │ │ │ │ │ - lines = [line for line in loader.splitlines() if line] │ │ │ │ │ - lines.append('') │ │ │ │ │ +class InternalMetricsChannel(AsyncChannel): │ │ │ │ │ + payload = 'metrics1' │ │ │ │ │ + restrictions = [('source', 'internal')] │ │ │ │ │ │ │ │ │ │ - imports = {'import sys'} │ │ │ │ │ - contents_txt = dict_repr(contents, imports) │ │ │ │ │ - lines.extend(imports) │ │ │ │ │ - lines.append(f'sys.meta_path.insert(0, BeipackLoader({contents_txt}))') │ │ │ │ │ + metrics: List[MetricInfo] │ │ │ │ │ + samplers: Set │ │ │ │ │ + samplers_cache: Optional[Dict[str, Tuple[Sampler, SampleDescription]]] = None │ │ │ │ │ │ │ │ │ │ - if entrypoint: │ │ │ │ │ - package, main = entrypoint.split(':') │ │ │ │ │ - lines.append(f'from {package} import {main} as main') │ │ │ │ │ - lines.append(f'main({args})') │ │ │ │ │ + interval: int = 1000 │ │ │ │ │ + need_meta: bool = True │ │ │ │ │ + last_timestamp: float = 0 │ │ │ │ │ + next_timestamp: float = 0 │ │ │ │ │ │ │ │ │ │ - return ''.join(f'{line}\n' for line in lines) │ │ │ │ │ + @classmethod │ │ │ │ │ + def ensure_samplers(cls): │ │ │ │ │ + if cls.samplers_cache is None: │ │ │ │ │ + cls.samplers_cache = {desc.name: (sampler, desc) for sampler in SAMPLERS for desc in sampler.descriptions} │ │ │ │ │ │ │ │ │ │ + def parse_options(self, options): │ │ │ │ │ + logger.debug('metrics internal open: %s, channel: %s', options, self.channel) │ │ │ │ │ │ │ │ │ │ -def collect_contents(filenames: List[str], │ │ │ │ │ - relative_to: Optional[str] = None) -> Dict[str, bytes]: │ │ │ │ │ - contents: Dict[str, bytes] = {} │ │ │ │ │ + interval = options.get('interval', self.interval) │ │ │ │ │ + if not isinstance(interval, int) or interval <= 0 or interval > sys.maxsize: │ │ │ │ │ + raise ChannelError('protocol-error', message=f'invalid "interval" value: {interval}') │ │ │ │ │ │ │ │ │ │ - for filename in filenames: │ │ │ │ │ - with open(filename, 'rb') as file: │ │ │ │ │ - contents[os.path.relpath(filename, start=relative_to)] = file.read() │ │ │ │ │ + self.interval = interval │ │ │ │ │ │ │ │ │ │ - return contents │ │ │ │ │ + metrics = options.get('metrics') │ │ │ │ │ + if not isinstance(metrics, list) or len(metrics) == 0: │ │ │ │ │ + logger.error('invalid "metrics" value: %s', metrics) │ │ │ │ │ + raise ChannelError('protocol-error', message='invalid "metrics" option was specified (not an array)') │ │ │ │ │ │ │ │ │ │ + sampler_classes = set() │ │ │ │ │ + for metric in metrics: │ │ │ │ │ + # validate it's an object │ │ │ │ │ + name = metric.get('name') │ │ │ │ │ + units = metric.get('units') │ │ │ │ │ + derive = metric.get('derive') │ │ │ │ │ │ │ │ │ │ -def collect_module(name: str, *, recursive: bool) -> Dict[str, bytes]: │ │ │ │ │ - import importlib.resources │ │ │ │ │ - from importlib.resources.abc import Traversable │ │ │ │ │ + try: │ │ │ │ │ + sampler, desc = self.samplers_cache[name] │ │ │ │ │ + except KeyError as exc: │ │ │ │ │ + logger.error('unsupported metric: %s', name) │ │ │ │ │ + raise ChannelError('not-supported', message=f'unsupported metric: {name}') from exc │ │ │ │ │ │ │ │ │ │ - def walk(path: str, entry: Traversable) -> Iterable[Tuple[str, bytes]]: │ │ │ │ │ - for item in entry.iterdir(): │ │ │ │ │ - itemname = f'{path}/{item.name}' │ │ │ │ │ - if item.is_file(): │ │ │ │ │ - yield itemname, item.read_bytes() │ │ │ │ │ - elif recursive and item.name != '__pycache__': │ │ │ │ │ - yield from walk(itemname, item) │ │ │ │ │ + if units and units != desc.units: │ │ │ │ │ + raise ChannelError('not-supported', message=f'{name} has units {desc.units}, not {units}') │ │ │ │ │ │ │ │ │ │ - return dict(walk(name.replace('.', '/'), importlib.resources.files(name))) │ │ │ │ │ + sampler_classes.add(sampler) │ │ │ │ │ + self.metrics.append(MetricInfo(derive=derive, desc=desc)) │ │ │ │ │ │ │ │ │ │ + self.samplers = {cls() for cls in sampler_classes} │ │ │ │ │ │ │ │ │ │ -def collect_zip(filename: str) -> Dict[str, bytes]: │ │ │ │ │ - contents = {} │ │ │ │ │ + def send_meta(self, samples: Samples, timestamp: float): │ │ │ │ │ + metrics: JsonList = [] │ │ │ │ │ + for metricinfo in self.metrics: │ │ │ │ │ + if metricinfo.desc.instanced: │ │ │ │ │ + metrics.append({ │ │ │ │ │ + 'name': metricinfo.desc.name, │ │ │ │ │ + 'units': metricinfo.desc.units, │ │ │ │ │ + 'instances': list(samples[metricinfo.desc.name].keys()), │ │ │ │ │ + 'semantics': metricinfo.desc.semantics │ │ │ │ │ + }) │ │ │ │ │ + else: │ │ │ │ │ + metrics.append({ │ │ │ │ │ + 'name': metricinfo.desc.name, │ │ │ │ │ + 'derive': metricinfo.derive, # type: ignore[dict-item] │ │ │ │ │ + 'units': metricinfo.desc.units, │ │ │ │ │ + 'semantics': metricinfo.desc.semantics │ │ │ │ │ + }) │ │ │ │ │ │ │ │ │ │ - with zipfile.ZipFile(filename) as file: │ │ │ │ │ - for entry in file.filelist: │ │ │ │ │ - if '.dist-info/' in entry.filename: │ │ │ │ │ - continue │ │ │ │ │ - contents[entry.filename] = file.read(entry) │ │ │ │ │ + self.send_json(source='internal', interval=self.interval, timestamp=timestamp * 1000, metrics=metrics) │ │ │ │ │ + self.need_meta = False │ │ │ │ │ │ │ │ │ │ - return contents │ │ │ │ │ + def sample(self): │ │ │ │ │ + samples = defaultdict(dict) │ │ │ │ │ + for sampler in self.samplers: │ │ │ │ │ + sampler.sample(samples) │ │ │ │ │ + return samples │ │ │ │ │ │ │ │ │ │ + def calculate_sample_rate(self, value: float, old_value: Optional[float]) -> Union[float, bool]: │ │ │ │ │ + if old_value is not None and self.last_timestamp: │ │ │ │ │ + return (value - old_value) / (self.next_timestamp - self.last_timestamp) │ │ │ │ │ + else: │ │ │ │ │ + return False │ │ │ │ │ │ │ │ │ │ -def collect_pep517(path: str) -> Dict[str, bytes]: │ │ │ │ │ - with tempfile.TemporaryDirectory() as tmpdir: │ │ │ │ │ - import build │ │ │ │ │ - builder = build.ProjectBuilder(path) │ │ │ │ │ - wheel = builder.build('wheel', tmpdir) │ │ │ │ │ - return collect_zip(wheel) │ │ │ │ │ + def send_updates(self, samples: Samples, last_samples: Samples): │ │ │ │ │ + data: List[Union[float, List[Optional[Union[float, bool]]]]] = [] │ │ │ │ │ + timestamp = time.time() │ │ │ │ │ + self.next_timestamp = timestamp │ │ │ │ │ │ │ │ │ │ + for metricinfo in self.metrics: │ │ │ │ │ + value = samples[metricinfo.desc.name] │ │ │ │ │ │ │ │ │ │ -def main() -> None: │ │ │ │ │ - parser = argparse.ArgumentParser() │ │ │ │ │ - parser.add_argument('--python', '-p', │ │ │ │ │ - help="add a #!python3 interpreter line using the given path") │ │ │ │ │ - parser.add_argument('--xz', '-J', action='store_true', │ │ │ │ │ - help="compress the output with `xz`") │ │ │ │ │ - parser.add_argument('--topdir', │ │ │ │ │ - help="toplevel directory (paths are stored relative to this)") │ │ │ │ │ - parser.add_argument('--output', '-o', │ │ │ │ │ - help="write output to a file (default: stdout)") │ │ │ │ │ - parser.add_argument('--main', '-m', metavar='MODULE:FUNC', │ │ │ │ │ - help="use FUNC from MODULE as the main function") │ │ │ │ │ - parser.add_argument('--main-args', metavar='ARGS', │ │ │ │ │ - help="arguments to main() in Python syntax", default='') │ │ │ │ │ - parser.add_argument('--module', action='append', default=[], │ │ │ │ │ - help="collect installed modules (recursively)") │ │ │ │ │ - parser.add_argument('--zip', '-z', action='append', default=[], │ │ │ │ │ - help="include files from a zipfile (or wheel)") │ │ │ │ │ - parser.add_argument('--build', metavar='DIR', action='append', default=[], │ │ │ │ │ - help="PEP-517 from a given source directory") │ │ │ │ │ - parser.add_argument('files', nargs='*', │ │ │ │ │ - help="files to include in the beipack") │ │ │ │ │ - args = parser.parse_args() │ │ │ │ │ + if metricinfo.desc.instanced: │ │ │ │ │ + old_value = last_samples[metricinfo.desc.name] │ │ │ │ │ + assert isinstance(value, dict) │ │ │ │ │ + assert isinstance(old_value, dict) │ │ │ │ │ │ │ │ │ │ - contents = collect_contents(args.files, relative_to=args.topdir) │ │ │ │ │ + # If we have less or more keys the data changed, send a meta message. │ │ │ │ │ + if value.keys() != old_value.keys(): │ │ │ │ │ + self.need_meta = True │ │ │ │ │ │ │ │ │ │ - for file in args.zip: │ │ │ │ │ - contents.update(collect_zip(file)) │ │ │ │ │ + if metricinfo.derive == 'rate': │ │ │ │ │ + instances: List[Optional[Union[float, bool]]] = [] │ │ │ │ │ + for key, val in value.items(): │ │ │ │ │ + instances.append(self.calculate_sample_rate(val, old_value.get(key))) │ │ │ │ │ │ │ │ │ │ - for name in args.module: │ │ │ │ │ - contents.update(collect_module(name, recursive=True)) │ │ │ │ │ + data.append(instances) │ │ │ │ │ + else: │ │ │ │ │ + data.append(list(value.values())) │ │ │ │ │ + else: │ │ │ │ │ + old_value = last_samples.get(metricinfo.desc.name) │ │ │ │ │ + assert not isinstance(value, dict) │ │ │ │ │ + assert not isinstance(old_value, dict) │ │ │ │ │ │ │ │ │ │ - for path in args.build: │ │ │ │ │ - contents.update(collect_pep517(path)) │ │ │ │ │ + if metricinfo.derive == 'rate': │ │ │ │ │ + data.append(self.calculate_sample_rate(value, old_value)) │ │ │ │ │ + else: │ │ │ │ │ + data.append(value) │ │ │ │ │ │ │ │ │ │ - result = pack(contents, args.main, args.main_args).encode('utf-8') │ │ │ │ │ + if self.need_meta: │ │ │ │ │ + self.send_meta(samples, timestamp) │ │ │ │ │ │ │ │ │ │ - if args.python: │ │ │ │ │ - result = b'#!' + args.python.encode('ascii') + b'\n' + result │ │ │ │ │ + self.last_timestamp = self.next_timestamp │ │ │ │ │ + self.send_data(json.dumps([data]).encode()) │ │ │ │ │ │ │ │ │ │ - if args.xz: │ │ │ │ │ - result = lzma.compress(result, preset=lzma.PRESET_EXTREME) │ │ │ │ │ + async def run(self, options): │ │ │ │ │ + self.metrics = [] │ │ │ │ │ + self.samplers = set() │ │ │ │ │ │ │ │ │ │ - if args.output: │ │ │ │ │ - with open(args.output, 'wb') as file: │ │ │ │ │ - file.write(result) │ │ │ │ │ - else: │ │ │ │ │ - if args.xz and os.isatty(1): │ │ │ │ │ - sys.exit('refusing to write compressed output to a terminal') │ │ │ │ │ - sys.stdout.buffer.write(result) │ │ │ │ │ + InternalMetricsChannel.ensure_samplers() │ │ │ │ │ │ │ │ │ │ + self.parse_options(options) │ │ │ │ │ + self.ready() │ │ │ │ │ │ │ │ │ │ -if __name__ == '__main__': │ │ │ │ │ - main() │ │ │ │ │ + last_samples = defaultdict(dict) │ │ │ │ │ + while True: │ │ │ │ │ + samples = self.sample() │ │ │ │ │ + self.send_updates(samples, last_samples) │ │ │ │ │ + last_samples = samples │ │ │ │ │ + await asyncio.sleep(self.interval / 1000) │ │ │ │ │ ''', │ │ │ │ │ - 'cockpit/_vendor/bei/bootloader.py': br'''# beiboot - Remote bootloader for Python │ │ │ │ │ + 'cockpit/channels/dbus.py': r'''# This file is part of Cockpit. │ │ │ │ │ # │ │ │ │ │ -# Copyright (C) 2023 Allison Karlitskaya │ │ │ │ │ +# Copyright (C) 2022 Red Hat, Inc. │ │ │ │ │ # │ │ │ │ │ # This program is free software: you can redistribute it and/or modify │ │ │ │ │ # it under the terms of the GNU General Public License as published by │ │ │ │ │ # the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ # (at your option) any later version. │ │ │ │ │ # │ │ │ │ │ # This program is distributed in the hope that it will be useful, │ │ │ │ │ # but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ # GNU General Public License for more details. │ │ │ │ │ # │ │ │ │ │ # You should have received a copy of the GNU General Public License │ │ │ │ │ -# along with this program. If not, see . │ │ │ │ │ - │ │ │ │ │ -import textwrap │ │ │ │ │ -from typing import Dict, Iterable, List, Optional, Sequence, Set, Tuple │ │ │ │ │ - │ │ │ │ │ -GADGETS = { │ │ │ │ │ - "_frame": r""" │ │ │ │ │ - import sys │ │ │ │ │ - import traceback │ │ │ │ │ - try: │ │ │ │ │ - ... │ │ │ │ │ - except SystemExit: │ │ │ │ │ - raise │ │ │ │ │ - except BaseException: │ │ │ │ │ - command('beiboot.exc', traceback.format_exc()) │ │ │ │ │ - sys.exit(37) │ │ │ │ │ - """, │ │ │ │ │ - "try_exec": r""" │ │ │ │ │ - import contextlib │ │ │ │ │ - import os │ │ │ │ │ - def try_exec(argv): │ │ │ │ │ - with contextlib.suppress(OSError): │ │ │ │ │ - os.execvp(argv[0], argv) │ │ │ │ │ - """, │ │ │ │ │ - "boot_xz": r""" │ │ │ │ │ - import lzma │ │ │ │ │ - import sys │ │ │ │ │ - def boot_xz(filename, size, args=[], send_end=False): │ │ │ │ │ - command('beiboot.provide', size) │ │ │ │ │ - src_xz = sys.stdin.buffer.read(size) │ │ │ │ │ - src = lzma.decompress(src_xz) │ │ │ │ │ - sys.argv = [filename, *args] │ │ │ │ │ - if send_end: │ │ │ │ │ - end() │ │ │ │ │ - exec(src, { │ │ │ │ │ - '__name__': '__main__', │ │ │ │ │ - '__self_source__': src_xz, │ │ │ │ │ - '__file__': filename}) │ │ │ │ │ - sys.exit() │ │ │ │ │ - """, │ │ │ │ │ -} │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -def split_code(code: str, imports: Set[str]) -> Iterable[Tuple[str, str]]: │ │ │ │ │ - for line in textwrap.dedent(code).splitlines(): │ │ │ │ │ - text = line.lstrip(" ") │ │ │ │ │ - if text.startswith("import "): │ │ │ │ │ - imports.add(text) │ │ │ │ │ - elif text: │ │ │ │ │ - spaces = len(line) - len(text) │ │ │ │ │ - assert (spaces % 4) == 0 │ │ │ │ │ - yield "\t" * (spaces // 4), text │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -def yield_body(user_gadgets: Dict[str, str], │ │ │ │ │ - steps: Sequence[Tuple[str, Sequence[object]]], │ │ │ │ │ - imports: Set[str]) -> Iterable[Tuple[str, str]]: │ │ │ │ │ - # Allow the caller to override our gadgets, but keep the original │ │ │ │ │ - # variable for use in the next step. │ │ │ │ │ - gadgets = dict(GADGETS, **user_gadgets) │ │ │ │ │ - │ │ │ │ │ - # First emit the gadgets. Emit all gadgets provided by the caller, │ │ │ │ │ - # plus any referred to by the caller's list of steps. │ │ │ │ │ - provided_gadgets = set(user_gadgets) │ │ │ │ │ - step_gadgets = {name for name, _args in steps} │ │ │ │ │ - for name in provided_gadgets | step_gadgets: │ │ │ │ │ - yield from split_code(gadgets[name], imports) │ │ │ │ │ - │ │ │ │ │ - # Yield functions mentioned in steps from the caller │ │ │ │ │ - for name, args in steps: │ │ │ │ │ - yield '', name + repr(tuple(args)) │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -def make_bootloader(steps: Sequence[Tuple[str, Sequence[object]]], │ │ │ │ │ - gadgets: Optional[Dict[str, str]] = None) -> str: │ │ │ │ │ - imports: Set[str] = set() │ │ │ │ │ - lines: List[str] = [] │ │ │ │ │ - │ │ │ │ │ - for frame_spaces, frame_text in split_code(GADGETS["_frame"], imports): │ │ │ │ │ - if frame_text == "...": │ │ │ │ │ - for spaces, text in yield_body(gadgets or {}, steps, imports): │ │ │ │ │ - lines.append(frame_spaces + spaces + text) │ │ │ │ │ - else: │ │ │ │ │ - lines.append(frame_spaces + frame_text) │ │ │ │ │ +# along with this program. If not, see . │ │ │ │ │ │ │ │ │ │ - return "".join(f"{line}\n" for line in [*imports, *lines]) + "\n" │ │ │ │ │ -''', │ │ │ │ │ - 'cockpit/_vendor/bei/__init__.py': br'''''', │ │ │ │ │ - 'cockpit/_vendor/bei/beiboot.py': br"""# beiboot - Remote bootloader for Python │ │ │ │ │ +# Missing stuff compared to the C bridge that we should probably add: │ │ │ │ │ # │ │ │ │ │ -# Copyright (C) 2022 Allison Karlitskaya │ │ │ │ │ +# - removing matches │ │ │ │ │ +# - removing watches │ │ │ │ │ +# - emitting of signals │ │ │ │ │ +# - publishing of objects │ │ │ │ │ +# - failing more gracefully in some cases (during open, etc) │ │ │ │ │ # │ │ │ │ │ -# This program is free software: you can redistribute it and/or modify │ │ │ │ │ -# it under the terms of the GNU General Public License as published by │ │ │ │ │ -# the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ -# (at your option) any later version. │ │ │ │ │ +# Stuff we might or might not do: │ │ │ │ │ # │ │ │ │ │ -# This program is distributed in the hope that it will be useful, │ │ │ │ │ -# but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ -# GNU General Public License for more details. │ │ │ │ │ +# - using non-default service names │ │ │ │ │ # │ │ │ │ │ -# You should have received a copy of the GNU General Public License │ │ │ │ │ -# along with this program. If not, see . │ │ │ │ │ +# Stuff we should probably not do: │ │ │ │ │ +# │ │ │ │ │ +# - emulation of ObjectManager via recursive introspection │ │ │ │ │ +# - automatic detection of ObjectManager below the given path_namespace │ │ │ │ │ +# - recursive scraping of properties for new object paths │ │ │ │ │ +# (for path_namespace watches that don't hit an ObjectManager) │ │ │ │ │ │ │ │ │ │ -import argparse │ │ │ │ │ import asyncio │ │ │ │ │ -import os │ │ │ │ │ -import shlex │ │ │ │ │ -import subprocess │ │ │ │ │ -import sys │ │ │ │ │ -import threading │ │ │ │ │ -from typing import IO, List, Sequence, Tuple │ │ │ │ │ - │ │ │ │ │ -from .bootloader import make_bootloader │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -def get_python_command(local: bool = False, │ │ │ │ │ - tty: bool = False, │ │ │ │ │ - sh: bool = False) -> Sequence[str]: │ │ │ │ │ - interpreter = sys.executable if local else 'python3' │ │ │ │ │ - command: Sequence[str] │ │ │ │ │ - │ │ │ │ │ - if tty: │ │ │ │ │ - command = (interpreter, '-iq') │ │ │ │ │ - else: │ │ │ │ │ - command = ( │ │ │ │ │ - interpreter, '-ic', │ │ │ │ │ - # https://github.com/python/cpython/issues/93139 │ │ │ │ │ - '''" - beiboot - "; import sys; sys.ps1 = ''; sys.ps2 = '';''' │ │ │ │ │ - ) │ │ │ │ │ +import errno │ │ │ │ │ +import json │ │ │ │ │ +import logging │ │ │ │ │ +import traceback │ │ │ │ │ +import xml.etree.ElementTree as ET │ │ │ │ │ │ │ │ │ │ - if sh: │ │ │ │ │ - command = (' '.join(shlex.quote(arg) for arg in command),) │ │ │ │ │ +from cockpit._vendor import systemd_ctypes │ │ │ │ │ +from cockpit._vendor.systemd_ctypes import Bus, BusError, introspection │ │ │ │ │ │ │ │ │ │ - return command │ │ │ │ │ +from ..channel import Channel, ChannelError │ │ │ │ │ │ │ │ │ │ +logger = logging.getLogger(__name__) │ │ │ │ │ │ │ │ │ │ -def get_ssh_command(*args: str, tty: bool = False) -> Sequence[str]: │ │ │ │ │ - return ('ssh', │ │ │ │ │ - *(['-t'] if tty else ()), │ │ │ │ │ - *args, │ │ │ │ │ - *get_python_command(tty=tty, sh=True)) │ │ │ │ │ +# The dbusjson3 payload │ │ │ │ │ +# │ │ │ │ │ +# This channel payload type translates JSON encoded messages on a │ │ │ │ │ +# Cockpit channel to D-Bus messages, in a mostly straightforward way. │ │ │ │ │ +# See doc/protocol.md for a description of the basics. │ │ │ │ │ +# │ │ │ │ │ +# However, dbusjson3 offers some advanced features as well that are │ │ │ │ │ +# meant to support the "magic" DBusProxy objects implemented by │ │ │ │ │ +# cockpit.js. Those proxy objects "magically" expose all the methods │ │ │ │ │ +# and properties of a D-Bus interface without requiring any explicit │ │ │ │ │ +# binding code to be generated for a JavaScript client. A dbusjson3 │ │ │ │ │ +# channel does this by doing automatic introspection and property │ │ │ │ │ +# retrieval without much direction from the JavaScript client. │ │ │ │ │ +# │ │ │ │ │ +# The details of what exactly is done is not specified very strictly, │ │ │ │ │ +# and the Python bridge will likely differ from the C bridge │ │ │ │ │ +# significantly. This will be informed by what existing code actually │ │ │ │ │ +# needs, and we might end up with a more concrete description of what │ │ │ │ │ +# a client can actually expect. │ │ │ │ │ +# │ │ │ │ │ +# Here is an example of a more complex scenario: │ │ │ │ │ +# │ │ │ │ │ +# - The client adds a "watch" for a path namespace. There is a │ │ │ │ │ +# ObjectManager at the given path and the bridge emits "meta" and │ │ │ │ │ +# "notify" messages to describe all interfaces and objects reported │ │ │ │ │ +# by that ObjectManager. │ │ │ │ │ +# │ │ │ │ │ +# - The client makes a method call that causes a new object with a new │ │ │ │ │ +# interface to appear at the ObjectManager. The bridge will send a │ │ │ │ │ +# "meta" and "notify" message to describe this new object. │ │ │ │ │ +# │ │ │ │ │ +# - Since the InterfacesAdded signal was emitted before the method │ │ │ │ │ +# reply, the bridge must send the "meta" and "notify" messages │ │ │ │ │ +# before the method reply message. │ │ │ │ │ +# │ │ │ │ │ +# - However, in order to construct the "meta" message, the bridge must │ │ │ │ │ +# perform a Introspect call, and consequently must delay sending the │ │ │ │ │ +# method reply until that call has finished. │ │ │ │ │ +# │ │ │ │ │ +# The Python bridge implements this delaying of messages with │ │ │ │ │ +# coroutines and a fair mutex. Every message coming from D-Bus will │ │ │ │ │ +# wait on the mutex for its turn to send its message on the Cockpit │ │ │ │ │ +# channel, and will keep that mutex locked until it is done with │ │ │ │ │ +# sending. Since the mutex is fair, everyone will nicely wait in line │ │ │ │ │ +# without messages getting re-ordered. │ │ │ │ │ +# │ │ │ │ │ +# The scenario above will play out like this: │ │ │ │ │ +# │ │ │ │ │ +# - While adding the initial "watch", the lock is held until the │ │ │ │ │ +# "meta" and "notify" messages have been sent. │ │ │ │ │ +# │ │ │ │ │ +# - Later, when the InterfacesAdded signal comes in that has been │ │ │ │ │ +# triggered by the method call, the mutex will be locked while the │ │ │ │ │ +# necessary introspection is going on. │ │ │ │ │ +# │ │ │ │ │ +# - The method reply will likely come while the mutex is locked, and │ │ │ │ │ +# the task for sending that reply on the Cockpit channel will enter │ │ │ │ │ +# the wait queue of the mutex. │ │ │ │ │ +# │ │ │ │ │ +# - Once the introspection is done and the new "meta" and "notify" │ │ │ │ │ +# messages have been sent, the mutex is unlocked, the method reply │ │ │ │ │ +# task acquires it, and sends its message. │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ -def get_container_command(*args: str, tty: bool = False) -> Sequence[str]: │ │ │ │ │ - return ('podman', 'exec', '--interactive', │ │ │ │ │ - *(['--tty'] if tty else ()), │ │ │ │ │ - *args, │ │ │ │ │ - *get_python_command(tty=tty)) │ │ │ │ │ +class InterfaceCache: │ │ │ │ │ + def __init__(self): │ │ │ │ │ + self.cache = {} │ │ │ │ │ + self.old = set() # Interfaces already returned by get_interface_if_new │ │ │ │ │ │ │ │ │ │ + def inject(self, interfaces): │ │ │ │ │ + self.cache.update(interfaces) │ │ │ │ │ │ │ │ │ │ -def get_command(*args: str, tty: bool = False, sh: bool = False) -> Sequence[str]: │ │ │ │ │ - return (*args, *get_python_command(local=True, tty=tty, sh=sh)) │ │ │ │ │ + async def introspect_path(self, bus, destination, object_path): │ │ │ │ │ + xml, = await bus.call_method_async(destination, object_path, │ │ │ │ │ + 'org.freedesktop.DBus.Introspectable', │ │ │ │ │ + 'Introspect') │ │ │ │ │ │ │ │ │ │ + et = ET.fromstring(xml) │ │ │ │ │ │ │ │ │ │ -def splice_in_thread(src: int, dst: IO[bytes]) -> None: │ │ │ │ │ - def _thread() -> None: │ │ │ │ │ - # os.splice() only in Python 3.10 │ │ │ │ │ - with dst: │ │ │ │ │ - block_size = 1 << 20 │ │ │ │ │ - while True: │ │ │ │ │ - data = os.read(src, block_size) │ │ │ │ │ - if not data: │ │ │ │ │ - break │ │ │ │ │ - dst.write(data) │ │ │ │ │ - dst.flush() │ │ │ │ │ + interfaces = {tag.attrib['name']: introspection.parse_interface(tag) for tag in et.findall('interface')} │ │ │ │ │ │ │ │ │ │ - threading.Thread(target=_thread, daemon=True).start() │ │ │ │ │ + # Add all interfaces we found: we might use them later │ │ │ │ │ + self.inject(interfaces) │ │ │ │ │ │ │ │ │ │ + return interfaces │ │ │ │ │ │ │ │ │ │ -def send_and_splice(command: Sequence[str], script: bytes) -> None: │ │ │ │ │ - with subprocess.Popen(command, stdin=subprocess.PIPE) as proc: │ │ │ │ │ - assert proc.stdin is not None │ │ │ │ │ - proc.stdin.write(script) │ │ │ │ │ + async def get_interface(self, interface_name, bus=None, destination=None, object_path=None): │ │ │ │ │ + try: │ │ │ │ │ + return self.cache[interface_name] │ │ │ │ │ + except KeyError: │ │ │ │ │ + pass │ │ │ │ │ │ │ │ │ │ - splice_in_thread(0, proc.stdin) │ │ │ │ │ - sys.exit(proc.wait()) │ │ │ │ │ + if bus and object_path: │ │ │ │ │ + try: │ │ │ │ │ + await self.introspect_path(bus, destination, object_path) │ │ │ │ │ + except BusError: │ │ │ │ │ + pass │ │ │ │ │ │ │ │ │ │ + return self.cache.get(interface_name) │ │ │ │ │ │ │ │ │ │ -def send_xz_and_splice(command: Sequence[str], script: bytes) -> None: │ │ │ │ │ - import ferny │ │ │ │ │ + async def get_interface_if_new(self, interface_name, bus, destination, object_path): │ │ │ │ │ + if interface_name in self.old: │ │ │ │ │ + return None │ │ │ │ │ + self.old.add(interface_name) │ │ │ │ │ + return await self.get_interface(interface_name, bus, destination, object_path) │ │ │ │ │ │ │ │ │ │ - class Responder(ferny.InteractionResponder): │ │ │ │ │ - async def do_custom_command(self, │ │ │ │ │ - command: str, │ │ │ │ │ - args: Tuple, │ │ │ │ │ - fds: List[int], │ │ │ │ │ - stderr: str) -> None: │ │ │ │ │ - assert proc.stdin is not None │ │ │ │ │ - if command == 'beiboot.provide': │ │ │ │ │ - proc.stdin.write(script) │ │ │ │ │ - proc.stdin.flush() │ │ │ │ │ + async def get_signature(self, interface_name, method, bus=None, destination=None, object_path=None): │ │ │ │ │ + interface = await self.get_interface(interface_name, bus, destination, object_path) │ │ │ │ │ + if interface is None: │ │ │ │ │ + raise KeyError(f'Interface {interface_name} is not found') │ │ │ │ │ │ │ │ │ │ - agent = ferny.InteractionAgent(Responder()) │ │ │ │ │ - with subprocess.Popen(command, stdin=subprocess.PIPE, stderr=agent) as proc: │ │ │ │ │ - assert proc.stdin is not None │ │ │ │ │ - proc.stdin.write(make_bootloader([ │ │ │ │ │ - ('boot_xz', ('script.py.xz', len(script), [], True)), │ │ │ │ │ - ], gadgets=ferny.BEIBOOT_GADGETS).encode()) │ │ │ │ │ - proc.stdin.flush() │ │ │ │ │ + return ''.join(interface['methods'][method]['in']) │ │ │ │ │ │ │ │ │ │ - asyncio.run(agent.communicate()) │ │ │ │ │ - splice_in_thread(0, proc.stdin) │ │ │ │ │ - sys.exit(proc.wait()) │ │ │ │ │ │ │ │ │ │ +def notify_update(notify, path, interface_name, props): │ │ │ │ │ + notify.setdefault(path, {})[interface_name] = {k: v.value for k, v in props.items()} │ │ │ │ │ │ │ │ │ │ -def main() -> None: │ │ │ │ │ - parser = argparse.ArgumentParser() │ │ │ │ │ - parser.add_argument('--sh', action='store_true', │ │ │ │ │ - help='Pass Python interpreter command as shell-script') │ │ │ │ │ - parser.add_argument('--xz', help="the xz to run remotely") │ │ │ │ │ - parser.add_argument('--script', │ │ │ │ │ - help="the script to run remotely (must be repl-friendly)") │ │ │ │ │ - parser.add_argument('command', nargs='*') │ │ │ │ │ │ │ │ │ │ - args = parser.parse_args() │ │ │ │ │ - tty = not args.script and os.isatty(0) │ │ │ │ │ +class DBusChannel(Channel): │ │ │ │ │ + json_encoder = systemd_ctypes.JSONEncoder(indent=2) │ │ │ │ │ + payload = 'dbus-json3' │ │ │ │ │ │ │ │ │ │ - if args.command == []: │ │ │ │ │ - command = get_python_command(tty=tty) │ │ │ │ │ - elif args.command[0] == 'ssh': │ │ │ │ │ - command = get_ssh_command(*args.command[1:], tty=tty) │ │ │ │ │ - elif args.command[0] == 'container': │ │ │ │ │ - command = get_container_command(*args.command[1:], tty=tty) │ │ │ │ │ - else: │ │ │ │ │ - command = get_command(*args.command, tty=tty, sh=args.sh) │ │ │ │ │ + matches = None │ │ │ │ │ + name = None │ │ │ │ │ + bus = None │ │ │ │ │ + owner = None │ │ │ │ │ │ │ │ │ │ - if args.script: │ │ │ │ │ - with open(args.script, 'rb') as file: │ │ │ │ │ - script = file.read() │ │ │ │ │ + async def setup_name_owner_tracking(self): │ │ │ │ │ + def send_owner(owner): │ │ │ │ │ + # We must be careful not to send duplicate owner │ │ │ │ │ + # notifications. cockpit.js relies on that. │ │ │ │ │ + if self.owner != owner: │ │ │ │ │ + self.owner = owner │ │ │ │ │ + self.send_json(owner=owner) │ │ │ │ │ │ │ │ │ │ - send_and_splice(command, script) │ │ │ │ │ + def handler(message): │ │ │ │ │ + _name, _old, new = message.get_body() │ │ │ │ │ + send_owner(owner=new if new != "" else None) │ │ │ │ │ + self.add_signal_handler(handler, │ │ │ │ │ + sender='org.freedesktop.DBus', │ │ │ │ │ + path='/org/freedesktop/DBus', │ │ │ │ │ + interface='org.freedesktop.DBus', │ │ │ │ │ + member='NameOwnerChanged', │ │ │ │ │ + arg0=self.name) │ │ │ │ │ + try: │ │ │ │ │ + unique_name, = await self.bus.call_method_async("org.freedesktop.DBus", │ │ │ │ │ + "/org/freedesktop/DBus", │ │ │ │ │ + "org.freedesktop.DBus", │ │ │ │ │ + "GetNameOwner", "s", self.name) │ │ │ │ │ + except BusError as error: │ │ │ │ │ + if error.name == "org.freedesktop.DBus.Error.NameHasNoOwner": │ │ │ │ │ + # Try to start it. If it starts successfully, we will │ │ │ │ │ + # get a NameOwnerChanged signal (which will set │ │ │ │ │ + # self.owner) before StartServiceByName returns. │ │ │ │ │ + try: │ │ │ │ │ + await self.bus.call_method_async("org.freedesktop.DBus", │ │ │ │ │ + "/org/freedesktop/DBus", │ │ │ │ │ + "org.freedesktop.DBus", │ │ │ │ │ + "StartServiceByName", "su", self.name, 0) │ │ │ │ │ + except BusError as start_error: │ │ │ │ │ + logger.debug("Failed to start service '%s': %s", self.name, start_error.message) │ │ │ │ │ + self.send_json(owner=None) │ │ │ │ │ + else: │ │ │ │ │ + logger.debug("Failed to get owner of service '%s': %s", self.name, error.message) │ │ │ │ │ + else: │ │ │ │ │ + send_owner(unique_name) │ │ │ │ │ │ │ │ │ │ - elif args.xz: │ │ │ │ │ - with open(args.xz, 'rb') as file: │ │ │ │ │ - script = file.read() │ │ │ │ │ + def do_open(self, options): │ │ │ │ │ + self.cache = InterfaceCache() │ │ │ │ │ + self.name = options.get('name') │ │ │ │ │ + self.matches = [] │ │ │ │ │ │ │ │ │ │ - send_xz_and_splice(command, script) │ │ │ │ │ + bus = options.get('bus') │ │ │ │ │ + address = options.get('address') │ │ │ │ │ │ │ │ │ │ - else: │ │ │ │ │ - # If we're streaming from stdin then this is a lot easier... │ │ │ │ │ - os.execlp(command[0], *command) │ │ │ │ │ + try: │ │ │ │ │ + if address is not None: │ │ │ │ │ + if bus is not None and bus != 'none': │ │ │ │ │ + raise ChannelError('protocol-error', message='only one of "bus" and "address" can be specified') │ │ │ │ │ + logger.debug('get bus with address %s for %s', address, self.name) │ │ │ │ │ + self.bus = Bus.new(address=address, bus_client=self.name is not None) │ │ │ │ │ + elif bus == 'internal': │ │ │ │ │ + logger.debug('get internal bus for %s', self.name) │ │ │ │ │ + self.bus = self.router.internal_bus.client │ │ │ │ │ + else: │ │ │ │ │ + if bus == 'session': │ │ │ │ │ + logger.debug('get session bus for %s', self.name) │ │ │ │ │ + self.bus = Bus.default_user() │ │ │ │ │ + elif bus == 'system' or bus is None: │ │ │ │ │ + logger.debug('get system bus for %s', self.name) │ │ │ │ │ + self.bus = Bus.default_system() │ │ │ │ │ + else: │ │ │ │ │ + raise ChannelError('protocol-error', message=f'invalid bus "{bus}"') │ │ │ │ │ + except OSError as exc: │ │ │ │ │ + raise ChannelError('protocol-error', message=f'failed to connect to {bus} bus: {exc}') from exc │ │ │ │ │ │ │ │ │ │ - # Otherwise, "full strength" │ │ │ │ │ + try: │ │ │ │ │ + self.bus.attach_event(None, 0) │ │ │ │ │ + except OSError as err: │ │ │ │ │ + if err.errno != errno.EBUSY: │ │ │ │ │ + raise │ │ │ │ │ │ │ │ │ │ -if __name__ == '__main__': │ │ │ │ │ - main() │ │ │ │ │ -""", │ │ │ │ │ - 'cockpit/_vendor/bei/data/beipack_loader.py': br'''# beipack https://github.com/allisonkarlitskaya/beipack │ │ │ │ │ + # This needs to be a fair mutex so that outgoing messages don't │ │ │ │ │ + # get re-ordered. asyncio.Lock is fair. │ │ │ │ │ + self.watch_processing_lock = asyncio.Lock() │ │ │ │ │ │ │ │ │ │ -import importlib.abc │ │ │ │ │ -import importlib.util │ │ │ │ │ -import io │ │ │ │ │ -import sys │ │ │ │ │ -from types import ModuleType │ │ │ │ │ -from typing import BinaryIO, Dict, Iterator, Optional, Sequence │ │ │ │ │ + if self.name is not None: │ │ │ │ │ + async def get_ready(): │ │ │ │ │ + async with self.watch_processing_lock: │ │ │ │ │ + await self.setup_name_owner_tracking() │ │ │ │ │ + if self.owner: │ │ │ │ │ + self.ready(unique_name=self.owner) │ │ │ │ │ + else: │ │ │ │ │ + self.close({'problem': 'not-found'}) │ │ │ │ │ + self.create_task(get_ready()) │ │ │ │ │ + else: │ │ │ │ │ + self.ready() │ │ │ │ │ │ │ │ │ │ + def add_signal_handler(self, handler, **kwargs): │ │ │ │ │ + r = dict(**kwargs) │ │ │ │ │ + r['type'] = 'signal' │ │ │ │ │ + if 'sender' not in r and self.name is not None: │ │ │ │ │ + r['sender'] = self.name │ │ │ │ │ + # HACK - https://github.com/bus1/dbus-broker/issues/309 │ │ │ │ │ + # path_namespace='/' in a rule does not work. │ │ │ │ │ + if r.get('path_namespace') == "/": │ │ │ │ │ + del r['path_namespace'] │ │ │ │ │ │ │ │ │ │ -class BeipackLoader(importlib.abc.SourceLoader, importlib.abc.MetaPathFinder): │ │ │ │ │ - if sys.version_info >= (3, 11): │ │ │ │ │ - from importlib.resources.abc import ResourceReader as AbstractResourceReader │ │ │ │ │ - else: │ │ │ │ │ - AbstractResourceReader = object │ │ │ │ │ + def filter_owner(message): │ │ │ │ │ + if self.owner is not None and self.owner == message.get_sender(): │ │ │ │ │ + handler(message) │ │ │ │ │ │ │ │ │ │ - class ResourceReader(AbstractResourceReader): │ │ │ │ │ - def __init__(self, contents: Dict[str, bytes], filename: str) -> None: │ │ │ │ │ - self._contents = contents │ │ │ │ │ - self._dir = f'{filename}/' │ │ │ │ │ + if self.name is not None and 'sender' in r and r['sender'] == self.name: │ │ │ │ │ + func = filter_owner │ │ │ │ │ + else: │ │ │ │ │ + func = handler │ │ │ │ │ + r_string = ','.join(f"{key}='{value}'" for key, value in r.items()) │ │ │ │ │ + if not self.is_closing(): │ │ │ │ │ + # this gets an EINTR very often especially on RHEL 8 │ │ │ │ │ + while True: │ │ │ │ │ + try: │ │ │ │ │ + match = self.bus.add_match(r_string, func) │ │ │ │ │ + break │ │ │ │ │ + except InterruptedError: │ │ │ │ │ + pass │ │ │ │ │ │ │ │ │ │ - def is_resource(self, resource: str) -> bool: │ │ │ │ │ - return f'{self._dir}{resource}' in self._contents │ │ │ │ │ + self.matches.append(match) │ │ │ │ │ │ │ │ │ │ - def open_resource(self, resource: str) -> BinaryIO: │ │ │ │ │ - return io.BytesIO(self._contents[f'{self._dir}{resource}']) │ │ │ │ │ + def add_async_signal_handler(self, handler, **kwargs): │ │ │ │ │ + def sync_handler(message): │ │ │ │ │ + self.create_task(handler(message)) │ │ │ │ │ + self.add_signal_handler(sync_handler, **kwargs) │ │ │ │ │ │ │ │ │ │ - def resource_path(self, resource: str) -> str: │ │ │ │ │ - raise FileNotFoundError │ │ │ │ │ + async def do_call(self, message): │ │ │ │ │ + path, iface, method, args = message['call'] │ │ │ │ │ + cookie = message.get('id') │ │ │ │ │ + flags = message.get('flags') │ │ │ │ │ │ │ │ │ │ - def contents(self) -> Iterator[str]: │ │ │ │ │ - dir_length = len(self._dir) │ │ │ │ │ - result = set() │ │ │ │ │ + timeout = message.get('timeout') │ │ │ │ │ + if timeout is not None: │ │ │ │ │ + # sd_bus timeout is μs, cockpit API timeout is ms │ │ │ │ │ + timeout *= 1000 │ │ │ │ │ + else: │ │ │ │ │ + # sd_bus has no "indefinite" timeout, so use MAX_UINT64 │ │ │ │ │ + timeout = 2 ** 64 - 1 │ │ │ │ │ │ │ │ │ │ - for filename in self._contents: │ │ │ │ │ - if filename.startswith(self._dir): │ │ │ │ │ - try: │ │ │ │ │ - next_slash = filename.index('/', dir_length) │ │ │ │ │ - except ValueError: │ │ │ │ │ - next_slash = None │ │ │ │ │ - result.add(filename[dir_length:next_slash]) │ │ │ │ │ + # We have to figure out the signature of the call. Either we got told it: │ │ │ │ │ + signature = message.get('type') │ │ │ │ │ │ │ │ │ │ - return iter(result) │ │ │ │ │ + # ... or there aren't any arguments │ │ │ │ │ + if signature is None and len(args) == 0: │ │ │ │ │ + signature = '' │ │ │ │ │ │ │ │ │ │ - contents: Dict[str, bytes] │ │ │ │ │ - modules: Dict[str, str] │ │ │ │ │ + # ... or we need to introspect │ │ │ │ │ + if signature is None: │ │ │ │ │ + try: │ │ │ │ │ + logger.debug('Doing introspection request for %s %s', iface, method) │ │ │ │ │ + signature = await self.cache.get_signature(iface, method, self.bus, self.name, path) │ │ │ │ │ + except BusError as error: │ │ │ │ │ + self.send_json(error=[error.name, [f'Introspection: {error.message}']], id=cookie) │ │ │ │ │ + return │ │ │ │ │ + except KeyError: │ │ │ │ │ + self.send_json( │ │ │ │ │ + error=[ │ │ │ │ │ + "org.freedesktop.DBus.Error.UnknownMethod", │ │ │ │ │ + [f"Introspection data for method {iface} {method} not available"]], │ │ │ │ │ + id=cookie) │ │ │ │ │ + return │ │ │ │ │ + except Exception as exc: │ │ │ │ │ + self.send_json(error=['python.error', [f'Introspection: {exc!s}']], id=cookie) │ │ │ │ │ + return │ │ │ │ │ │ │ │ │ │ - def __init__(self, contents: Dict[str, bytes]) -> None: │ │ │ │ │ try: │ │ │ │ │ - contents[__file__] = __self_source__ # type: ignore[name-defined] │ │ │ │ │ - except NameError: │ │ │ │ │ - pass │ │ │ │ │ - │ │ │ │ │ - self.contents = contents │ │ │ │ │ - self.modules = { │ │ │ │ │ - self.get_fullname(filename): filename │ │ │ │ │ - for filename in contents │ │ │ │ │ - if filename.endswith(".py") │ │ │ │ │ - } │ │ │ │ │ - │ │ │ │ │ - def get_fullname(self, filename: str) -> str: │ │ │ │ │ - assert filename.endswith(".py") │ │ │ │ │ - filename = filename[:-3] │ │ │ │ │ - if filename.endswith("/__init__"): │ │ │ │ │ - filename = filename[:-9] │ │ │ │ │ - return filename.replace("/", ".") │ │ │ │ │ + method_call = self.bus.message_new_method_call(self.name, path, iface, method, signature, *args) │ │ │ │ │ + reply = await self.bus.call_async(method_call, timeout=timeout) │ │ │ │ │ + # If the method call has kicked off any signals related to │ │ │ │ │ + # watch processing, wait for that to be done. │ │ │ │ │ + async with self.watch_processing_lock: │ │ │ │ │ + # TODO: stop hard-coding the endian flag here. │ │ │ │ │ + self.send_json( │ │ │ │ │ + reply=[reply.get_body()], id=cookie, │ │ │ │ │ + flags="<" if flags is not None else None, │ │ │ │ │ + type=reply.get_signature(True)) # noqa: FBT003 │ │ │ │ │ + except BusError as error: │ │ │ │ │ + # actually, should send the fields from the message body │ │ │ │ │ + self.send_json(error=[error.name, [error.message]], id=cookie) │ │ │ │ │ + except Exception: │ │ │ │ │ + logger.exception("do_call(%s): generic exception", message) │ │ │ │ │ + self.send_json(error=['python.error', [traceback.format_exc()]], id=cookie) │ │ │ │ │ │ │ │ │ │ - def get_resource_reader(self, fullname: str) -> ResourceReader: │ │ │ │ │ - return BeipackLoader.ResourceReader(self.contents, fullname.replace('.', '/')) │ │ │ │ │ + async def do_add_match(self, message): │ │ │ │ │ + add_match = message['add-match'] │ │ │ │ │ + logger.debug('adding match %s', add_match) │ │ │ │ │ │ │ │ │ │ - def get_data(self, path: str) -> bytes: │ │ │ │ │ - return self.contents[path] │ │ │ │ │ + async def match_hit(message): │ │ │ │ │ + logger.debug('got match') │ │ │ │ │ + async with self.watch_processing_lock: │ │ │ │ │ + self.send_json(signal=[ │ │ │ │ │ + message.get_path(), │ │ │ │ │ + message.get_interface(), │ │ │ │ │ + message.get_member(), │ │ │ │ │ + list(message.get_body()) │ │ │ │ │ + ]) │ │ │ │ │ │ │ │ │ │ - def get_filename(self, fullname: str) -> str: │ │ │ │ │ - return self.modules[fullname] │ │ │ │ │ + self.add_async_signal_handler(match_hit, **add_match) │ │ │ │ │ │ │ │ │ │ - def find_spec( │ │ │ │ │ - self, │ │ │ │ │ - fullname: str, │ │ │ │ │ - path: Optional[Sequence[str]], │ │ │ │ │ - target: Optional[ModuleType] = None │ │ │ │ │ - ) -> Optional[importlib.machinery.ModuleSpec]: │ │ │ │ │ - if fullname not in self.modules: │ │ │ │ │ - return None │ │ │ │ │ - return importlib.util.spec_from_loader(fullname, self) │ │ │ │ │ -''', │ │ │ │ │ - 'cockpit/_vendor/bei/data/__init__.py': br'''import sys │ │ │ │ │ + async def setup_objectmanager_watch(self, path, interface_name, meta, notify): │ │ │ │ │ + # Watch the objects managed by the ObjectManager at "path". │ │ │ │ │ + # Properties are not watched, that is done by setup_path_watch │ │ │ │ │ + # below via recursive_props == True. │ │ │ │ │ │ │ │ │ │ -if sys.version_info >= (3, 9): │ │ │ │ │ - import importlib.abc │ │ │ │ │ - import importlib.resources │ │ │ │ │ + async def handler(message): │ │ │ │ │ + member = message.get_member() │ │ │ │ │ + if member == "InterfacesAdded": │ │ │ │ │ + (path, interface_props) = message.get_body() │ │ │ │ │ + logger.debug('interfaces added %s %s', path, interface_props) │ │ │ │ │ + meta = {} │ │ │ │ │ + notify = {} │ │ │ │ │ + async with self.watch_processing_lock: │ │ │ │ │ + for name, props in interface_props.items(): │ │ │ │ │ + if interface_name is None or name == interface_name: │ │ │ │ │ + mm = await self.cache.get_interface_if_new(name, self.bus, self.name, path) │ │ │ │ │ + if mm: │ │ │ │ │ + meta.update({name: mm}) │ │ │ │ │ + notify_update(notify, path, name, props) │ │ │ │ │ + self.send_json(meta=meta) │ │ │ │ │ + self.send_json(notify=notify) │ │ │ │ │ + elif member == "InterfacesRemoved": │ │ │ │ │ + (path, interfaces) = message.get_body() │ │ │ │ │ + logger.debug('interfaces removed %s %s', path, interfaces) │ │ │ │ │ + async with self.watch_processing_lock: │ │ │ │ │ + notify = {path: dict.fromkeys(interfaces)} │ │ │ │ │ + self.send_json(notify=notify) │ │ │ │ │ │ │ │ │ │ - def read_data_file(filename: str) -> str: │ │ │ │ │ - return (importlib.resources.files(__name__) / filename).read_text() │ │ │ │ │ -else: │ │ │ │ │ - def read_data_file(filename: str) -> str: │ │ │ │ │ - loader = __loader__ # type: ignore[name-defined] │ │ │ │ │ - data = loader.get_data(__file__.replace('__init__.py', filename)) │ │ │ │ │ - return data.decode('utf-8') │ │ │ │ │ -''', │ │ │ │ │ - 'cockpit/_vendor/systemd_ctypes/inotify.py': br'''# systemd_ctypes │ │ │ │ │ -# │ │ │ │ │ -# Copyright (C) 2022 Allison Karlitskaya │ │ │ │ │ -# │ │ │ │ │ -# This program is free software: you can redistribute it and/or modify │ │ │ │ │ -# it under the terms of the GNU General Public License as published by │ │ │ │ │ -# the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ -# (at your option) any later version. │ │ │ │ │ -# │ │ │ │ │ -# This program is distributed in the hope that it will be useful, │ │ │ │ │ -# but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ -# GNU General Public License for more details. │ │ │ │ │ -# │ │ │ │ │ -# You should have received a copy of the GNU General Public License │ │ │ │ │ -# along with this program. If not, see . │ │ │ │ │ + self.add_async_signal_handler(handler, │ │ │ │ │ + path=path, │ │ │ │ │ + interface="org.freedesktop.DBus.ObjectManager") │ │ │ │ │ + objects, = await self.bus.call_method_async(self.name, path, │ │ │ │ │ + 'org.freedesktop.DBus.ObjectManager', │ │ │ │ │ + 'GetManagedObjects') │ │ │ │ │ + for p, ifaces in objects.items(): │ │ │ │ │ + for iface, props in ifaces.items(): │ │ │ │ │ + if interface_name is None or iface == interface_name: │ │ │ │ │ + mm = await self.cache.get_interface_if_new(iface, self.bus, self.name, p) │ │ │ │ │ + if mm: │ │ │ │ │ + meta.update({iface: mm}) │ │ │ │ │ + notify_update(notify, p, iface, props) │ │ │ │ │ │ │ │ │ │ -import ctypes │ │ │ │ │ -from enum import IntFlag, auto │ │ │ │ │ -from typing import Optional │ │ │ │ │ + async def setup_path_watch(self, path, interface_name, recursive_props, meta, notify): │ │ │ │ │ + # Watch a single object at "path", but maybe also watch for │ │ │ │ │ + # property changes for all objects below "path". │ │ │ │ │ │ │ │ │ │ + async def handler(message): │ │ │ │ │ + async with self.watch_processing_lock: │ │ │ │ │ + path = message.get_path() │ │ │ │ │ + name, props, invalids = message.get_body() │ │ │ │ │ + logger.debug('NOTIFY: %s %s %s %s', path, name, props, invalids) │ │ │ │ │ + for inv in invalids: │ │ │ │ │ + try: │ │ │ │ │ + reply, = await self.bus.call_method_async(self.name, path, │ │ │ │ │ + 'org.freedesktop.DBus.Properties', 'Get', │ │ │ │ │ + 'ss', name, inv) │ │ │ │ │ + except BusError as exc: │ │ │ │ │ + logger.debug('failed to fetch property %s.%s on %s %s: %s', │ │ │ │ │ + name, inv, self.name, path, str(exc)) │ │ │ │ │ + continue │ │ │ │ │ + props[inv] = reply │ │ │ │ │ + notify = {} │ │ │ │ │ + notify_update(notify, path, name, props) │ │ │ │ │ + self.send_json(notify=notify) │ │ │ │ │ │ │ │ │ │ -class inotify_event(ctypes.Structure): │ │ │ │ │ - _fields_ = ( │ │ │ │ │ - ('wd', ctypes.c_int32), │ │ │ │ │ - ('mask', ctypes.c_uint32), │ │ │ │ │ - ('cookie', ctypes.c_uint32), │ │ │ │ │ - ('len', ctypes.c_uint32), │ │ │ │ │ - ) │ │ │ │ │ + this_meta = await self.cache.introspect_path(self.bus, self.name, path) │ │ │ │ │ + if interface_name is not None: │ │ │ │ │ + interface = this_meta.get(interface_name) │ │ │ │ │ + this_meta = {interface_name: interface} │ │ │ │ │ + meta.update(this_meta) │ │ │ │ │ + if recursive_props: │ │ │ │ │ + self.add_async_signal_handler(handler, │ │ │ │ │ + interface="org.freedesktop.DBus.Properties", │ │ │ │ │ + path_namespace=path) │ │ │ │ │ + else: │ │ │ │ │ + self.add_async_signal_handler(handler, │ │ │ │ │ + interface="org.freedesktop.DBus.Properties", │ │ │ │ │ + path=path) │ │ │ │ │ │ │ │ │ │ - @property │ │ │ │ │ - def name(self) -> Optional[bytes]: │ │ │ │ │ - if self.len == 0: │ │ │ │ │ - return None │ │ │ │ │ + for name in meta: │ │ │ │ │ + if name.startswith("org.freedesktop.DBus."): │ │ │ │ │ + continue │ │ │ │ │ + try: │ │ │ │ │ + props, = await self.bus.call_method_async(self.name, path, │ │ │ │ │ + 'org.freedesktop.DBus.Properties', │ │ │ │ │ + 'GetAll', 's', name) │ │ │ │ │ + notify_update(notify, path, name, props) │ │ │ │ │ + except BusError: │ │ │ │ │ + pass │ │ │ │ │ │ │ │ │ │ - class event_with_name(ctypes.Structure): │ │ │ │ │ - _fields_ = (*inotify_event._fields_, ('name', ctypes.c_char * self.len)) │ │ │ │ │ + async def do_watch(self, message): │ │ │ │ │ + watch = message['watch'] │ │ │ │ │ + path = watch.get('path') │ │ │ │ │ + path_namespace = watch.get('path_namespace') │ │ │ │ │ + interface_name = watch.get('interface') │ │ │ │ │ + cookie = message.get('id') │ │ │ │ │ │ │ │ │ │ - name = ctypes.cast(ctypes.addressof(self), ctypes.POINTER(event_with_name)).contents.name │ │ │ │ │ - assert isinstance(name, bytes) │ │ │ │ │ - return name │ │ │ │ │ + path = path or path_namespace │ │ │ │ │ + recursive = path == path_namespace │ │ │ │ │ │ │ │ │ │ + if path is None or cookie is None: │ │ │ │ │ + logger.debug('ignored incomplete watch request %s', message) │ │ │ │ │ + self.send_json(error=['x.y.z', ['Not Implemented']], id=cookie) │ │ │ │ │ + self.send_json(reply=[], id=cookie) │ │ │ │ │ + return │ │ │ │ │ │ │ │ │ │ -class Event(IntFlag): │ │ │ │ │ - ACCESS = auto() │ │ │ │ │ - MODIFY = auto() │ │ │ │ │ - ATTRIB = auto() │ │ │ │ │ - CLOSE_WRITE = auto() │ │ │ │ │ - CLOSE_NOWRITE = auto() │ │ │ │ │ - OPEN = auto() │ │ │ │ │ - MOVED_FROM = auto() │ │ │ │ │ - MOVED_TO = auto() │ │ │ │ │ - CREATE = auto() │ │ │ │ │ - DELETE = auto() │ │ │ │ │ - DELETE_SELF = auto() │ │ │ │ │ - MOVE_SELF = auto() │ │ │ │ │ + try: │ │ │ │ │ + async with self.watch_processing_lock: │ │ │ │ │ + meta = {} │ │ │ │ │ + notify = {} │ │ │ │ │ + await self.setup_path_watch(path, interface_name, recursive, meta, notify) │ │ │ │ │ + if recursive: │ │ │ │ │ + await self.setup_objectmanager_watch(path, interface_name, meta, notify) │ │ │ │ │ + self.send_json(meta=meta) │ │ │ │ │ + self.send_json(notify=notify) │ │ │ │ │ + self.send_json(reply=[], id=message['id']) │ │ │ │ │ + except BusError as error: │ │ │ │ │ + logger.debug("do_watch(%s) caught D-Bus error: %s", message, error.message) │ │ │ │ │ + self.send_json(error=[error.name, [error.message]], id=cookie) │ │ │ │ │ │ │ │ │ │ - UNMOUNT = 1 << 13 │ │ │ │ │ - Q_OVERFLOW = auto() │ │ │ │ │ - IGNORED = auto() │ │ │ │ │ + async def do_meta(self, message): │ │ │ │ │ + self.cache.inject(message['meta']) │ │ │ │ │ │ │ │ │ │ - ONLYDIR = 1 << 24 │ │ │ │ │ - DONT_FOLLOW = auto() │ │ │ │ │ - EXCL_UNLINK = auto() │ │ │ │ │ + def do_data(self, data): │ │ │ │ │ + message = json.loads(data) │ │ │ │ │ + logger.debug('receive dbus request %s %s', self.name, message) │ │ │ │ │ │ │ │ │ │ - MASK_CREATE = 1 << 28 │ │ │ │ │ - MASK_ADD = auto() │ │ │ │ │ - ISDIR = auto() │ │ │ │ │ - ONESHOT = auto() │ │ │ │ │ + if 'call' in message: │ │ │ │ │ + self.create_task(self.do_call(message)) │ │ │ │ │ + elif 'add-match' in message: │ │ │ │ │ + self.create_task(self.do_add_match(message)) │ │ │ │ │ + elif 'watch' in message: │ │ │ │ │ + self.create_task(self.do_watch(message)) │ │ │ │ │ + elif 'meta' in message: │ │ │ │ │ + self.create_task(self.do_meta(message)) │ │ │ │ │ + else: │ │ │ │ │ + logger.debug('ignored dbus request %s', message) │ │ │ │ │ + return │ │ │ │ │ │ │ │ │ │ - CLOSE = CLOSE_WRITE | CLOSE_NOWRITE │ │ │ │ │ - MOVE = MOVED_FROM | MOVED_TO │ │ │ │ │ - CHANGED = (MODIFY | ATTRIB | CLOSE_WRITE | MOVE | │ │ │ │ │ - CREATE | DELETE | DELETE_SELF | MOVE_SELF) │ │ │ │ │ -''', │ │ │ │ │ - 'cockpit/_vendor/systemd_ctypes/bus.py': br'''# systemd_ctypes │ │ │ │ │ + def do_close(self): │ │ │ │ │ + for slot in self.matches: │ │ │ │ │ + slot.cancel() │ │ │ │ │ + self.matches = [] │ │ │ │ │ + self.close() │ │ │ │ │ +'''.encode('utf-8'), │ │ │ │ │ + 'cockpit/channels/filesystem.py': r'''# This file is part of Cockpit. │ │ │ │ │ # │ │ │ │ │ -# Copyright (C) 2022 Allison Karlitskaya │ │ │ │ │ +# Copyright (C) 2022 Red Hat, Inc. │ │ │ │ │ # │ │ │ │ │ # This program is free software: you can redistribute it and/or modify │ │ │ │ │ # it under the terms of the GNU General Public License as published by │ │ │ │ │ # the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ # (at your option) any later version. │ │ │ │ │ # │ │ │ │ │ # This program is distributed in the hope that it will be useful, │ │ │ │ │ # but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ # GNU General Public License for more details. │ │ │ │ │ # │ │ │ │ │ # You should have received a copy of the GNU General Public License │ │ │ │ │ -# along with this program. If not, see . │ │ │ │ │ +# along with this program. If not, see . │ │ │ │ │ │ │ │ │ │ import asyncio │ │ │ │ │ +import contextlib │ │ │ │ │ import enum │ │ │ │ │ +import errno │ │ │ │ │ +import fnmatch │ │ │ │ │ +import functools │ │ │ │ │ +import grp │ │ │ │ │ import logging │ │ │ │ │ -import typing │ │ │ │ │ -from typing import Any, Callable, Dict, Optional, Sequence, Tuple, Union │ │ │ │ │ +import os │ │ │ │ │ +import pwd │ │ │ │ │ +import re │ │ │ │ │ +import stat │ │ │ │ │ +import tempfile │ │ │ │ │ +from pathlib import Path │ │ │ │ │ +from typing import Callable, Iterable, Iterator │ │ │ │ │ │ │ │ │ │ -from . import bustypes, introspection, libsystemd │ │ │ │ │ -from .librarywrapper import WeakReference, byref │ │ │ │ │ +from cockpit._vendor.systemd_ctypes import Handle, PathWatch │ │ │ │ │ +from cockpit._vendor.systemd_ctypes.inotify import Event as InotifyEvent │ │ │ │ │ +from cockpit._vendor.systemd_ctypes.pathwatch import Listener as PathWatchListener │ │ │ │ │ │ │ │ │ │ -logger = logging.getLogger(__name__) │ │ │ │ │ +from ..channel import AsyncChannel, Channel, ChannelError, GeneratorChannel │ │ │ │ │ +from ..jsonutil import ( │ │ │ │ │ + JsonDict, │ │ │ │ │ + JsonDocument, │ │ │ │ │ + JsonError, │ │ │ │ │ + JsonObject, │ │ │ │ │ + get_bool, │ │ │ │ │ + get_enum, │ │ │ │ │ + get_int, │ │ │ │ │ + get_str, │ │ │ │ │ + get_strv, │ │ │ │ │ + json_merge_and_filter_patch, │ │ │ │ │ +) │ │ │ │ │ │ │ │ │ │ +logger = logging.getLogger(__name__) │ │ │ │ │ │ │ │ │ │ -class BusError(Exception): │ │ │ │ │ - """An exception corresponding to a D-Bus error message │ │ │ │ │ │ │ │ │ │ - This exception is raised by the method call methods. You can also raise it │ │ │ │ │ - from your own method handlers. It can also be passed directly to functions │ │ │ │ │ - such as Message.reply_method_error(). │ │ │ │ │ +@functools.lru_cache() │ │ │ │ │ +def my_umask() -> int: │ │ │ │ │ + match = re.search(r'^Umask:\s*0([0-7]*)$', Path('/proc/self/status').read_text(), re.M) │ │ │ │ │ + return (match and int(match.group(1), 8)) or 0o077 │ │ │ │ │ │ │ │ │ │ - :name: the 'code' of the error, like org.freedesktop.DBus.Error.UnknownMethod │ │ │ │ │ - :message: a human-readable description of the error │ │ │ │ │ - """ │ │ │ │ │ - def __init__(self, name: str, message: str): │ │ │ │ │ - super().__init__(f'{name}: {message}') │ │ │ │ │ - self.name = name │ │ │ │ │ - self.message = message │ │ │ │ │ │ │ │ │ │ +def tag_from_stat(buf): │ │ │ │ │ + return f'1:{buf.st_ino}-{buf.st_mtime}-{buf.st_mode:o}-{buf.st_uid}-{buf.st_gid}' │ │ │ │ │ │ │ │ │ │ -class BusMessage(libsystemd.sd_bus_message): │ │ │ │ │ - """A message, received from or to be sent over D-Bus │ │ │ │ │ │ │ │ │ │ - This is the low-level interface to receiving and sending individual │ │ │ │ │ - messages over D-Bus. You won't normally need to use it. │ │ │ │ │ +def tag_from_path(path): │ │ │ │ │ + try: │ │ │ │ │ + return tag_from_stat(os.stat(path)) │ │ │ │ │ + except FileNotFoundError: │ │ │ │ │ + return '-' │ │ │ │ │ + except OSError: │ │ │ │ │ + return None │ │ │ │ │ │ │ │ │ │ - A message is associated with a particular bus. You can create messages for │ │ │ │ │ - a bus with Bus.message_new_method_call() or Bus.message_new_signal(). You │ │ │ │ │ - can create replies to method calls with Message.new_method_return() or │ │ │ │ │ - Message.new_method_error(). You can append arguments with Message.append() │ │ │ │ │ - and send the message with Message.send(). │ │ │ │ │ - """ │ │ │ │ │ - def get_bus(self) -> 'Bus': │ │ │ │ │ - """Get the bus that a message is associated with. │ │ │ │ │ │ │ │ │ │ - This is the bus that a message came from or will be sent on. Every │ │ │ │ │ - message has an associated bus, and it cannot be changed. │ │ │ │ │ +def tag_from_fd(fd): │ │ │ │ │ + try: │ │ │ │ │ + return tag_from_stat(os.fstat(fd)) │ │ │ │ │ + except OSError: │ │ │ │ │ + return None │ │ │ │ │ │ │ │ │ │ - :returns: the Bus │ │ │ │ │ - """ │ │ │ │ │ - return Bus.ref(self._get_bus()) │ │ │ │ │ │ │ │ │ │ - def get_error(self) -> Optional[BusError]: │ │ │ │ │ - """Get the BusError from a message. │ │ │ │ │ +class FsListChannel(Channel): │ │ │ │ │ + payload = 'fslist1' │ │ │ │ │ │ │ │ │ │ - :returns: a BusError for an error message, or None for a non-error message │ │ │ │ │ - """ │ │ │ │ │ - error = self._get_error() │ │ │ │ │ - if error: │ │ │ │ │ - return BusError(*error.contents.get()) │ │ │ │ │ + def send_entry(self, event, entry): │ │ │ │ │ + if entry.is_symlink(): │ │ │ │ │ + mode = 'link' │ │ │ │ │ + elif entry.is_file(): │ │ │ │ │ + mode = 'file' │ │ │ │ │ + elif entry.is_dir(): │ │ │ │ │ + mode = 'directory' │ │ │ │ │ else: │ │ │ │ │ - return None │ │ │ │ │ - │ │ │ │ │ - def new_method_return(self, signature: str = '', *args: Any) -> 'BusMessage': │ │ │ │ │ - """Create a new (successful) return message as a reply to this message. │ │ │ │ │ - │ │ │ │ │ - This only makes sense when performed on a method call message. │ │ │ │ │ - │ │ │ │ │ - :signature: The signature of the result, as a string. │ │ │ │ │ - :args: The values to send, conforming to the signature string. │ │ │ │ │ - │ │ │ │ │ - :returns: the reply message │ │ │ │ │ - """ │ │ │ │ │ - reply = BusMessage() │ │ │ │ │ - self._new_method_return(byref(reply)) │ │ │ │ │ - reply.append(signature, *args) │ │ │ │ │ - return reply │ │ │ │ │ - │ │ │ │ │ - def new_method_error(self, error: Union[BusError, OSError]) -> 'BusMessage': │ │ │ │ │ - """Create a new error message as a reply to this message. │ │ │ │ │ - │ │ │ │ │ - This only makes sense when performed on a method call message. │ │ │ │ │ - │ │ │ │ │ - :error: BusError or OSError of the error to send │ │ │ │ │ + mode = 'special' │ │ │ │ │ │ │ │ │ │ - :returns: the reply message │ │ │ │ │ - """ │ │ │ │ │ - reply = BusMessage() │ │ │ │ │ - if isinstance(error, BusError): │ │ │ │ │ - self._new_method_errorf(byref(reply), error.name, "%s", error.message) │ │ │ │ │ - else: │ │ │ │ │ - assert isinstance(error, OSError) │ │ │ │ │ - self._new_method_errnof(byref(reply), error.errno, "%s", str(error)) │ │ │ │ │ - return reply │ │ │ │ │ + self.send_json(event=event, path=entry.name, type=mode) │ │ │ │ │ │ │ │ │ │ - def append_arg(self, typestring: str, arg: Any) -> None: │ │ │ │ │ - """Append a single argument to the message. │ │ │ │ │ + def do_open(self, options): │ │ │ │ │ + path = options.get('path') │ │ │ │ │ + watch = options.get('watch', True) │ │ │ │ │ │ │ │ │ │ - :typestring: a single typestring, such as 's', or 'a{sv}' │ │ │ │ │ - :arg: the argument to append, matching the typestring │ │ │ │ │ - """ │ │ │ │ │ - type_, = bustypes.from_signature(typestring) │ │ │ │ │ - type_.writer(self, arg) │ │ │ │ │ + if watch: │ │ │ │ │ + raise ChannelError('not-supported', message='watching is not implemented, use fswatch1') │ │ │ │ │ │ │ │ │ │ - def append(self, signature: str, *args: Any) -> None: │ │ │ │ │ - """Append zero or more arguments to the message. │ │ │ │ │ + try: │ │ │ │ │ + scan_dir = os.scandir(path) │ │ │ │ │ + except FileNotFoundError as error: │ │ │ │ │ + raise ChannelError('not-found', message=str(error)) from error │ │ │ │ │ + except PermissionError as error: │ │ │ │ │ + raise ChannelError('access-denied', message=str(error)) from error │ │ │ │ │ + except OSError as error: │ │ │ │ │ + raise ChannelError('internal-error', message=str(error)) from error │ │ │ │ │ │ │ │ │ │ - :signature: concatenated typestrings, such 'a{sv}' (one arg), or 'ss' (two args) │ │ │ │ │ - :args: one argument for each type string in the signature │ │ │ │ │ - """ │ │ │ │ │ - types = bustypes.from_signature(signature) │ │ │ │ │ - assert len(types) == len(args), f'call args {args} have different length than signature {signature}' │ │ │ │ │ - for type_, arg in zip(types, args): │ │ │ │ │ - type_.writer(self, arg) │ │ │ │ │ + self.ready() │ │ │ │ │ + for entry in scan_dir: │ │ │ │ │ + self.send_entry("present", entry) │ │ │ │ │ │ │ │ │ │ - def get_body(self) -> Tuple[object, ...]: │ │ │ │ │ - """Gets the body of a message. │ │ │ │ │ + if not watch: │ │ │ │ │ + self.done() │ │ │ │ │ + self.close() │ │ │ │ │ │ │ │ │ │ - Possible return values are (), ('single',), or ('x', 'y'). If you │ │ │ │ │ - check the signature of the message using Message.has_signature() then │ │ │ │ │ - you can use tuple unpacking. │ │ │ │ │ │ │ │ │ │ - single, = message.get_body() │ │ │ │ │ +class FsReadChannel(GeneratorChannel): │ │ │ │ │ + payload = 'fsread1' │ │ │ │ │ │ │ │ │ │ - x, y = other_message.get_body() │ │ │ │ │ + def do_yield_data(self, options: JsonObject) -> Iterator[bytes]: │ │ │ │ │ + path = get_str(options, 'path') │ │ │ │ │ + binary = get_enum(options, 'binary', ['raw'], None) is not None │ │ │ │ │ + max_read_size = get_int(options, 'max_read_size', None) │ │ │ │ │ │ │ │ │ │ - :returns: an n-tuple containing one value per argument in the message │ │ │ │ │ - """ │ │ │ │ │ - self.rewind(True) │ │ │ │ │ - types = bustypes.from_signature(self.get_signature(True)) │ │ │ │ │ - return tuple(type_.reader(self) for type_ in types) │ │ │ │ │ + logger.debug('Opening file "%s" for reading', path) │ │ │ │ │ │ │ │ │ │ - def send(self) -> bool: # Literal[True] │ │ │ │ │ - """Sends a message on the bus that it was created for. │ │ │ │ │ + try: │ │ │ │ │ + with open(path, 'rb') as filep: │ │ │ │ │ + buf = os.stat(filep.fileno()) │ │ │ │ │ + if max_read_size is not None and buf.st_size > max_read_size: │ │ │ │ │ + raise ChannelError('too-large') │ │ │ │ │ │ │ │ │ │ - :returns: True │ │ │ │ │ - """ │ │ │ │ │ - self.get_bus().send(self, None) │ │ │ │ │ - return True │ │ │ │ │ + if binary and stat.S_ISREG(buf.st_mode): │ │ │ │ │ + self.ready(size_hint=buf.st_size) │ │ │ │ │ + else: │ │ │ │ │ + self.ready() │ │ │ │ │ │ │ │ │ │ - def reply_method_error(self, error: Union[BusError, OSError]) -> bool: # Literal[True] │ │ │ │ │ - """Sends an error as a reply to a method call message. │ │ │ │ │ + while True: │ │ │ │ │ + data = filep.read1(Channel.BLOCK_SIZE) │ │ │ │ │ + if data == b'': │ │ │ │ │ + break │ │ │ │ │ + logger.debug(' ...sending %d bytes', len(data)) │ │ │ │ │ + if not binary: │ │ │ │ │ + data = data.replace(b'\0', b'').decode('utf-8', errors='ignore').encode('utf-8') │ │ │ │ │ + yield data │ │ │ │ │ │ │ │ │ │ - :error: A BusError or OSError │ │ │ │ │ + return {'tag': tag_from_stat(buf)} │ │ │ │ │ │ │ │ │ │ - :returns: True │ │ │ │ │ - """ │ │ │ │ │ - return self.new_method_error(error).send() │ │ │ │ │ + except FileNotFoundError: │ │ │ │ │ + return {'tag': '-'} │ │ │ │ │ + except PermissionError as exc: │ │ │ │ │ + raise ChannelError('access-denied') from exc │ │ │ │ │ + except OSError as exc: │ │ │ │ │ + raise ChannelError('internal-error', message=str(exc)) from exc │ │ │ │ │ │ │ │ │ │ - def reply_method_return(self, signature: str = '', *args: Any) -> bool: # Literal[True] │ │ │ │ │ - """Sends a return value as a reply to a method call message. │ │ │ │ │ │ │ │ │ │ - :signature: The signature of the result, as a string. │ │ │ │ │ - :args: The values to send, conforming to the signature string. │ │ │ │ │ +class FsReplaceChannel(AsyncChannel): │ │ │ │ │ + payload = 'fsreplace1' │ │ │ │ │ │ │ │ │ │ - :returns: True │ │ │ │ │ - """ │ │ │ │ │ - return self.new_method_return(signature, *args).send() │ │ │ │ │ + def delete(self, path: str, tag: 'str | None') -> str: │ │ │ │ │ + if tag is not None and tag != tag_from_path(path): │ │ │ │ │ + raise ChannelError('change-conflict') │ │ │ │ │ + with contextlib.suppress(FileNotFoundError): # delete is idempotent │ │ │ │ │ + os.unlink(path) │ │ │ │ │ + return '-' │ │ │ │ │ │ │ │ │ │ - def _coroutine_task_complete(self, out_type: bustypes.MessageType, task: asyncio.Task) -> None: │ │ │ │ │ + async def set_contents(self, path: str, tag: 'str | None', data: 'bytes | None', size: 'int | None') -> str: │ │ │ │ │ + dirname, basename = os.path.split(path) │ │ │ │ │ + tmpname: str | None │ │ │ │ │ + fd, tmpname = tempfile.mkstemp(dir=dirname, prefix=f'.{basename}-') │ │ │ │ │ try: │ │ │ │ │ - self.reply_method_function_return_value(out_type, task.result()) │ │ │ │ │ - except (BusError, OSError) as exc: │ │ │ │ │ - self.reply_method_error(exc) │ │ │ │ │ - │ │ │ │ │ - def reply_method_function_return_value(self, │ │ │ │ │ - out_type: bustypes.MessageType, │ │ │ │ │ - return_value: Any) -> bool: # Literal[True]: │ │ │ │ │ - """Sends the result of a function call as a reply to a method call message. │ │ │ │ │ - │ │ │ │ │ - This call does a bit of magic: it adapts from the usual Python return │ │ │ │ │ - value conventions (where the return value is ``None``, a single value, │ │ │ │ │ - or a tuple) to the normal D-Bus return value conventions (where the │ │ │ │ │ - result is always a tuple). │ │ │ │ │ - │ │ │ │ │ - Additionally, if the value is found to be a coroutine, a task is │ │ │ │ │ - created to run the coroutine to completion and return the result │ │ │ │ │ - (including exception handling). │ │ │ │ │ - │ │ │ │ │ - :out_types: The types of the return values, as an iterable. │ │ │ │ │ - :return_value: The return value of a Python function call. │ │ │ │ │ + if size is not None: │ │ │ │ │ + logger.debug('fallocate(%s.tmp, %d)', path, size) │ │ │ │ │ + if size: # posix_fallocate() of 0 bytes is EINVAL │ │ │ │ │ + await self.in_thread(os.posix_fallocate, fd, 0, size) │ │ │ │ │ + self.ready() # ...only after that worked │ │ │ │ │ │ │ │ │ │ - :returns: True │ │ │ │ │ - """ │ │ │ │ │ - if asyncio.coroutines.iscoroutine(return_value): │ │ │ │ │ - task = asyncio.create_task(return_value) │ │ │ │ │ - task.add_done_callback(lambda task: self._coroutine_task_complete(out_type, task)) │ │ │ │ │ - return True │ │ │ │ │ + written = 0 │ │ │ │ │ + while data is not None: │ │ │ │ │ + await self.in_thread(os.write, fd, data) │ │ │ │ │ + written += len(data) │ │ │ │ │ + data = await self.read() │ │ │ │ │ │ │ │ │ │ - reply = self.new_method_return() │ │ │ │ │ - # In the general case, a function returns an n-tuple, but... │ │ │ │ │ - if len(out_type) == 0: │ │ │ │ │ - # Functions with no return value return None. │ │ │ │ │ - assert return_value is None │ │ │ │ │ - elif len(out_type) == 1: │ │ │ │ │ - # Functions with a single return value return that value. │ │ │ │ │ - out_type.write(reply, return_value) │ │ │ │ │ - else: │ │ │ │ │ - # (general case) n return values are handled as an n-tuple. │ │ │ │ │ - assert len(out_type) == len(return_value) │ │ │ │ │ - out_type.write(reply, *return_value) │ │ │ │ │ - return reply.send() │ │ │ │ │ + if size is not None and written < size: │ │ │ │ │ + logger.debug('ftruncate(%s.tmp, %d)', path, written) │ │ │ │ │ + await self.in_thread(os.ftruncate, fd, written) │ │ │ │ │ │ │ │ │ │ + await self.in_thread(os.fdatasync, fd) │ │ │ │ │ │ │ │ │ │ -class Slot(libsystemd.sd_bus_slot): │ │ │ │ │ - def __init__(self, callback: Callable[[BusMessage], bool]): │ │ │ │ │ - def handler(message: WeakReference, _data: object, _err: object) -> int: │ │ │ │ │ - return 1 if callback(BusMessage.ref(message)) else 0 │ │ │ │ │ - self.trampoline = libsystemd.sd_bus_message_handler_t(handler) │ │ │ │ │ + if tag is None: │ │ │ │ │ + # no preconditions about what currently exists or not │ │ │ │ │ + # calculate the file mode from the umask │ │ │ │ │ + os.fchmod(fd, 0o666 & ~my_umask()) │ │ │ │ │ + os.rename(tmpname, path) │ │ │ │ │ + tmpname = None │ │ │ │ │ │ │ │ │ │ + elif tag == '-': │ │ │ │ │ + # the file must not exist. file mode from umask. │ │ │ │ │ + os.fchmod(fd, 0o666 & ~my_umask()) │ │ │ │ │ + os.link(tmpname, path) # will fail if file exists │ │ │ │ │ │ │ │ │ │ -if typing.TYPE_CHECKING: │ │ │ │ │ - FutureMessage = asyncio.Future[BusMessage] │ │ │ │ │ -else: │ │ │ │ │ - # Python 3.6 can't subscript asyncio.Future │ │ │ │ │ - FutureMessage = asyncio.Future │ │ │ │ │ + else: │ │ │ │ │ + # the file must exist with the given tag │ │ │ │ │ + buf = os.stat(path) │ │ │ │ │ + if tag != tag_from_stat(buf): │ │ │ │ │ + raise ChannelError('change-conflict') │ │ │ │ │ + # chown/chmod from the existing file permissions │ │ │ │ │ + os.fchmod(fd, stat.S_IMODE(buf.st_mode)) │ │ │ │ │ + os.fchown(fd, buf.st_uid, buf.st_gid) │ │ │ │ │ + os.rename(tmpname, path) │ │ │ │ │ + tmpname = None │ │ │ │ │ │ │ │ │ │ + finally: │ │ │ │ │ + os.close(fd) │ │ │ │ │ + if tmpname is not None: │ │ │ │ │ + os.unlink(tmpname) │ │ │ │ │ │ │ │ │ │ -class PendingCall(Slot): │ │ │ │ │ - future: FutureMessage │ │ │ │ │ + return tag_from_path(path) │ │ │ │ │ │ │ │ │ │ - def __init__(self) -> None: │ │ │ │ │ - future = asyncio.get_running_loop().create_future() │ │ │ │ │ + async def run(self, options: JsonObject) -> JsonObject: │ │ │ │ │ + path = get_str(options, 'path') │ │ │ │ │ + size = get_int(options, 'size', None) │ │ │ │ │ + tag = get_str(options, 'tag', None) │ │ │ │ │ │ │ │ │ │ - def done(message: BusMessage) -> bool: │ │ │ │ │ - error = message.get_error() │ │ │ │ │ - if future.cancelled(): │ │ │ │ │ - return True │ │ │ │ │ - if error is not None: │ │ │ │ │ - future.set_exception(error) │ │ │ │ │ + try: │ │ │ │ │ + # In the `size` case, .set_contents() sends the ready only after │ │ │ │ │ + # it knows that the allocate was successful. In the case without │ │ │ │ │ + # `size`, we need to send the ready() up front in order to │ │ │ │ │ + # receive the first frame and decide if we're creating or deleting. │ │ │ │ │ + if size is not None: │ │ │ │ │ + tag = await self.set_contents(path, tag, b'', size) │ │ │ │ │ else: │ │ │ │ │ - future.set_result(message) │ │ │ │ │ - return True │ │ │ │ │ - │ │ │ │ │ - super().__init__(done) │ │ │ │ │ - self.future = future │ │ │ │ │ + self.ready() │ │ │ │ │ + data = await self.read() │ │ │ │ │ + # if we get EOF right away, that's a request to delete │ │ │ │ │ + if data is None: │ │ │ │ │ + tag = self.delete(path, tag) │ │ │ │ │ + else: │ │ │ │ │ + tag = await self.set_contents(path, tag, data, None) │ │ │ │ │ │ │ │ │ │ + self.done() │ │ │ │ │ + return {'tag': tag} │ │ │ │ │ │ │ │ │ │ -class Bus(libsystemd.sd_bus): │ │ │ │ │ - _default_system_instance = None │ │ │ │ │ - _default_user_instance = None │ │ │ │ │ + except FileNotFoundError as exc: │ │ │ │ │ + raise ChannelError('not-found') from exc │ │ │ │ │ + except FileExistsError as exc: │ │ │ │ │ + # that's from link() noticing that the target file already exists │ │ │ │ │ + raise ChannelError('change-conflict') from exc │ │ │ │ │ + except PermissionError as exc: │ │ │ │ │ + raise ChannelError('access-denied') from exc │ │ │ │ │ + except IsADirectoryError as exc: │ │ │ │ │ + # not ideal, but the closest code we have │ │ │ │ │ + raise ChannelError('access-denied', message=str(exc)) from exc │ │ │ │ │ + except OSError as exc: │ │ │ │ │ + raise ChannelError('internal-error', message=str(exc)) from exc │ │ │ │ │ │ │ │ │ │ - class NameFlags(enum.IntFlag): │ │ │ │ │ - DEFAULT = 0 │ │ │ │ │ - REPLACE_EXISTING = 1 << 0 │ │ │ │ │ - ALLOW_REPLACEMENT = 1 << 1 │ │ │ │ │ - QUEUE = 1 << 2 │ │ │ │ │ │ │ │ │ │ - @staticmethod │ │ │ │ │ - def new( │ │ │ │ │ - fd: Optional[int] = None, │ │ │ │ │ - address: Optional[str] = None, │ │ │ │ │ - bus_client: bool = False, │ │ │ │ │ - server: bool = False, │ │ │ │ │ - start: bool = True, │ │ │ │ │ - attach_event: bool = True │ │ │ │ │ - ) -> 'Bus': │ │ │ │ │ - bus = Bus() │ │ │ │ │ - Bus._new(byref(bus)) │ │ │ │ │ - if address is not None: │ │ │ │ │ - bus.set_address(address) │ │ │ │ │ - if fd is not None: │ │ │ │ │ - bus.set_fd(fd, fd) │ │ │ │ │ - if bus_client: │ │ │ │ │ - bus.set_bus_client(True) │ │ │ │ │ - if server: │ │ │ │ │ - bus.set_server(True, libsystemd.sd_id128()) │ │ │ │ │ - if address is not None or fd is not None: │ │ │ │ │ - if start: │ │ │ │ │ - bus.start() │ │ │ │ │ - if attach_event: │ │ │ │ │ - bus.attach_event(None, 0) │ │ │ │ │ - return bus │ │ │ │ │ +class FsWatchChannel(Channel): │ │ │ │ │ + payload = 'fswatch1' │ │ │ │ │ + _tag = None │ │ │ │ │ + _path = None │ │ │ │ │ + _watch = None │ │ │ │ │ │ │ │ │ │ - @staticmethod │ │ │ │ │ - def default_system(attach_event: bool = True) -> 'Bus': │ │ │ │ │ - if Bus._default_system_instance is None: │ │ │ │ │ - Bus._default_system_instance = Bus() │ │ │ │ │ - Bus._default_system(byref(Bus._default_system_instance)) │ │ │ │ │ - if attach_event: │ │ │ │ │ - Bus._default_system_instance.attach_event(None, 0) │ │ │ │ │ - return Bus._default_system_instance │ │ │ │ │ + # The C bridge doesn't send the initial event, and the JS calls read() │ │ │ │ │ + # instead to figure out the initial state of the file. If we send the │ │ │ │ │ + # initial state then we cause the event to get delivered twice. │ │ │ │ │ + # Ideally we'll sort that out at some point, but for now, suppress it. │ │ │ │ │ + _active = False │ │ │ │ │ │ │ │ │ │ @staticmethod │ │ │ │ │ - def default_user(attach_event: bool = True) -> 'Bus': │ │ │ │ │ - if Bus._default_user_instance is None: │ │ │ │ │ - Bus._default_user_instance = Bus() │ │ │ │ │ - Bus._default_user(byref(Bus._default_user_instance)) │ │ │ │ │ - if attach_event: │ │ │ │ │ - Bus._default_user_instance.attach_event(None, 0) │ │ │ │ │ - return Bus._default_user_instance │ │ │ │ │ - │ │ │ │ │ - def message_new_method_call( │ │ │ │ │ - self, │ │ │ │ │ - destination: Optional[str], │ │ │ │ │ - path: str, │ │ │ │ │ - interface: str, │ │ │ │ │ - member: str, │ │ │ │ │ - types: str = '', │ │ │ │ │ - *args: object │ │ │ │ │ - ) -> BusMessage: │ │ │ │ │ - message = BusMessage() │ │ │ │ │ - self._message_new_method_call(byref(message), destination, path, interface, member) │ │ │ │ │ - message.append(types, *args) │ │ │ │ │ - return message │ │ │ │ │ - │ │ │ │ │ - def message_new_signal( │ │ │ │ │ - self, path: str, interface: str, member: str, types: str = '', *args: object │ │ │ │ │ - ) -> BusMessage: │ │ │ │ │ - message = BusMessage() │ │ │ │ │ - self._message_new_signal(byref(message), path, interface, member) │ │ │ │ │ - message.append(types, *args) │ │ │ │ │ - return message │ │ │ │ │ + def mask_to_event_and_type(mask): │ │ │ │ │ + if (InotifyEvent.CREATE or InotifyEvent.MOVED_TO) in mask: │ │ │ │ │ + return 'created', 'directory' if InotifyEvent.ISDIR in mask else 'file' │ │ │ │ │ + elif InotifyEvent.MOVED_FROM in mask or InotifyEvent.DELETE in mask or InotifyEvent.DELETE_SELF in mask: │ │ │ │ │ + return 'deleted', None │ │ │ │ │ + elif InotifyEvent.ATTRIB in mask: │ │ │ │ │ + return 'attribute-changed', None │ │ │ │ │ + elif InotifyEvent.CLOSE_WRITE in mask: │ │ │ │ │ + return 'done-hint', None │ │ │ │ │ + else: │ │ │ │ │ + return 'changed', None │ │ │ │ │ │ │ │ │ │ - def call(self, message: BusMessage, timeout: Optional[int] = None) -> BusMessage: │ │ │ │ │ - reply = BusMessage() │ │ │ │ │ - error = libsystemd.sd_bus_error() │ │ │ │ │ - try: │ │ │ │ │ - self._call(message, timeout or 0, byref(error), byref(reply)) │ │ │ │ │ - return reply │ │ │ │ │ - except OSError as exc: │ │ │ │ │ - raise BusError(*error.get()) from exc │ │ │ │ │ + def do_inotify_event(self, mask, _cookie, name): │ │ │ │ │ + logger.debug("do_inotify_event(%s): mask %X name %s", self._path, mask, name) │ │ │ │ │ + event, type_ = self.mask_to_event_and_type(mask) │ │ │ │ │ + if name: │ │ │ │ │ + # file inside watched directory changed │ │ │ │ │ + path = os.path.join(self._path, name.decode()) │ │ │ │ │ + tag = tag_from_path(path) │ │ │ │ │ + self.send_json(event=event, path=path, tag=tag, type=type_) │ │ │ │ │ + else: │ │ │ │ │ + # the watched path itself changed; filter out duplicate events │ │ │ │ │ + tag = tag_from_path(self._path) │ │ │ │ │ + if tag == self._tag: │ │ │ │ │ + return │ │ │ │ │ + self._tag = tag │ │ │ │ │ + self.send_json(event=event, path=self._path, tag=self._tag, type=type_) │ │ │ │ │ │ │ │ │ │ - def call_method( │ │ │ │ │ - self, │ │ │ │ │ - destination: str, │ │ │ │ │ - path: str, │ │ │ │ │ - interface: str, │ │ │ │ │ - member: str, │ │ │ │ │ - types: str = '', │ │ │ │ │ - *args: object, │ │ │ │ │ - timeout: Optional[int] = None │ │ │ │ │ - ) -> Tuple[object, ...]: │ │ │ │ │ - logger.debug('Doing sync method call %s %s %s %s %s %s', │ │ │ │ │ - destination, path, interface, member, types, args) │ │ │ │ │ - message = self.message_new_method_call(destination, path, interface, member, types, *args) │ │ │ │ │ - message = self.call(message, timeout) │ │ │ │ │ - return message.get_body() │ │ │ │ │ + def do_identity_changed(self, fd, err): │ │ │ │ │ + logger.debug("do_identity_changed(%s): fd %s, err %s", self._path, str(fd), err) │ │ │ │ │ + self._tag = tag_from_fd(fd) if fd else '-' │ │ │ │ │ + if self._active: │ │ │ │ │ + self.send_json(event='created' if fd else 'deleted', path=self._path, tag=self._tag) │ │ │ │ │ │ │ │ │ │ - async def call_async( │ │ │ │ │ - self, │ │ │ │ │ - message: BusMessage, │ │ │ │ │ - timeout: Optional[int] = None │ │ │ │ │ - ) -> BusMessage: │ │ │ │ │ - pending = PendingCall() │ │ │ │ │ - self._call_async(byref(pending), message, pending.trampoline, pending.userdata, timeout or 0) │ │ │ │ │ - return await pending.future │ │ │ │ │ + def do_open(self, options): │ │ │ │ │ + self._path = options['path'] │ │ │ │ │ + self._tag = None │ │ │ │ │ │ │ │ │ │ - async def call_method_async( │ │ │ │ │ - self, │ │ │ │ │ - destination: Optional[str], │ │ │ │ │ - path: str, │ │ │ │ │ - interface: str, │ │ │ │ │ - member: str, │ │ │ │ │ - types: str = '', │ │ │ │ │ - *args: object, │ │ │ │ │ - timeout: Optional[int] = None │ │ │ │ │ - ) -> Tuple[object, ...]: │ │ │ │ │ - logger.debug('Doing async method call %s %s %s %s %s %s', │ │ │ │ │ - destination, path, interface, member, types, args) │ │ │ │ │ - message = self.message_new_method_call(destination, path, interface, member, types, *args) │ │ │ │ │ - message = await self.call_async(message, timeout) │ │ │ │ │ - return message.get_body() │ │ │ │ │ + self._active = False │ │ │ │ │ + self._watch = PathWatch(self._path, self) │ │ │ │ │ + self._active = True │ │ │ │ │ │ │ │ │ │ - def add_match(self, rule: str, handler: Callable[[BusMessage], bool]) -> Slot: │ │ │ │ │ - slot = Slot(handler) │ │ │ │ │ - self._add_match(byref(slot), rule, slot.trampoline, slot.userdata) │ │ │ │ │ - return slot │ │ │ │ │ + self.ready() │ │ │ │ │ │ │ │ │ │ - def add_object(self, path: str, obj: 'BaseObject') -> Slot: │ │ │ │ │ - slot = Slot(obj.message_received) │ │ │ │ │ - self._add_object(byref(slot), path, slot.trampoline, slot.userdata) │ │ │ │ │ - obj.registered_on_bus(self, path) │ │ │ │ │ - return slot │ │ │ │ │ + def do_close(self): │ │ │ │ │ + self._watch.close() │ │ │ │ │ + self._watch = None │ │ │ │ │ + self.close() │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ -class BaseObject: │ │ │ │ │ - """Base object type for exporting objects on the bus │ │ │ │ │ +class Follow(enum.Enum): │ │ │ │ │ + NO = False │ │ │ │ │ + YES = True │ │ │ │ │ │ │ │ │ │ - This is the lowest-level class that can be passed to Bus.add_object(). │ │ │ │ │ │ │ │ │ │ - If you want to directly subclass this, you'll need to implement │ │ │ │ │ - `message_received()`. │ │ │ │ │ +class FsInfoChannel(Channel, PathWatchListener): │ │ │ │ │ + payload = 'fsinfo' │ │ │ │ │ │ │ │ │ │ - Subclassing from `bus.Object` is probably a better choice. │ │ │ │ │ - """ │ │ │ │ │ - _dbus_bus: Optional[Bus] = None │ │ │ │ │ - _dbus_path: Optional[str] = None │ │ │ │ │ + # Options (all get set in `do_open()`) │ │ │ │ │ + path: str │ │ │ │ │ + attrs: 'set[str]' │ │ │ │ │ + fnmatch: str │ │ │ │ │ + targets: bool │ │ │ │ │ + follow: bool │ │ │ │ │ + watch: bool │ │ │ │ │ │ │ │ │ │ - def registered_on_bus(self, bus: Bus, path: str) -> None: │ │ │ │ │ - """Report that an instance was exported on a given bus and path. │ │ │ │ │ + # State │ │ │ │ │ + current_value: JsonDict │ │ │ │ │ + effective_fnmatch: str = '' │ │ │ │ │ + fd: 'Handle | None' = None │ │ │ │ │ + pending: 'set[str] | None' = None │ │ │ │ │ + path_watch: 'PathWatch | None' = None │ │ │ │ │ + getattrs: 'Callable[[int, str, Follow], JsonDocument]' │ │ │ │ │ │ │ │ │ │ - This is used so that the instance knows where to send signals. │ │ │ │ │ - Bus.add_object() calls this: you probably shouldn't call this on your │ │ │ │ │ - own. │ │ │ │ │ - """ │ │ │ │ │ - self._dbus_bus = bus │ │ │ │ │ - self._dbus_path = path │ │ │ │ │ + @staticmethod │ │ │ │ │ + def make_getattrs(attrs: Iterable[str]) -> 'Callable[[int, str, Follow], JsonDocument | None]': │ │ │ │ │ + # Cached for the duration of the closure we're creating │ │ │ │ │ + @functools.lru_cache() │ │ │ │ │ + def get_user(uid: int) -> 'str | int': │ │ │ │ │ + try: │ │ │ │ │ + return pwd.getpwuid(uid).pw_name │ │ │ │ │ + except KeyError: │ │ │ │ │ + return uid │ │ │ │ │ │ │ │ │ │ - self.registered() │ │ │ │ │ + @functools.lru_cache() │ │ │ │ │ + def get_group(gid: int) -> 'str | int': │ │ │ │ │ + try: │ │ │ │ │ + return grp.getgrgid(gid).gr_name │ │ │ │ │ + except KeyError: │ │ │ │ │ + return gid │ │ │ │ │ │ │ │ │ │ - def registered(self) -> None: │ │ │ │ │ - """Called after an object has been registered on the bus │ │ │ │ │ + stat_types = {stat.S_IFREG: 'reg', stat.S_IFDIR: 'dir', stat.S_IFLNK: 'lnk', stat.S_IFCHR: 'chr', │ │ │ │ │ + stat.S_IFBLK: 'blk', stat.S_IFIFO: 'fifo', stat.S_IFSOCK: 'sock'} │ │ │ │ │ + available_stat_getters = { │ │ │ │ │ + 'type': lambda buf: stat_types.get(stat.S_IFMT(buf.st_mode)), │ │ │ │ │ + 'tag': tag_from_stat, │ │ │ │ │ + 'mode': lambda buf: stat.S_IMODE(buf.st_mode), │ │ │ │ │ + 'size': lambda buf: buf.st_size, │ │ │ │ │ + 'uid': lambda buf: buf.st_uid, │ │ │ │ │ + 'gid': lambda buf: buf.st_gid, │ │ │ │ │ + 'mtime': lambda buf: buf.st_mtime, │ │ │ │ │ + 'user': lambda buf: get_user(buf.st_uid), │ │ │ │ │ + 'group': lambda buf: get_group(buf.st_gid), │ │ │ │ │ + } │ │ │ │ │ + stat_getters = tuple((key, available_stat_getters.get(key, lambda _: None)) for key in attrs) │ │ │ │ │ │ │ │ │ │ - This is the correct method to implement to do some initial work that │ │ │ │ │ - needs to be done after registration. The default implementation does │ │ │ │ │ - nothing. │ │ │ │ │ - """ │ │ │ │ │ - pass │ │ │ │ │ + def get_attrs(fd: int, name: str, follow: Follow) -> 'JsonDict | None': │ │ │ │ │ + try: │ │ │ │ │ + buf = os.stat(name, follow_symlinks=follow.value, dir_fd=fd) if name else os.fstat(fd) │ │ │ │ │ + except FileNotFoundError: │ │ │ │ │ + return None │ │ │ │ │ + except OSError: │ │ │ │ │ + return {name: None for name, func in stat_getters} │ │ │ │ │ │ │ │ │ │ - def emit_signal( │ │ │ │ │ - self, interface: str, name: str, signature: str, *args: Any │ │ │ │ │ - ) -> bool: │ │ │ │ │ - """Emit a D-Bus signal on this object │ │ │ │ │ + result = {key: func(buf) for key, func in stat_getters} │ │ │ │ │ │ │ │ │ │ - The object must have been exported on the bus with Bus.add_object(). │ │ │ │ │ + if 'target' in result and stat.S_IFMT(buf.st_mode) == stat.S_IFLNK: │ │ │ │ │ + with contextlib.suppress(OSError): │ │ │ │ │ + result['target'] = os.readlink(name, dir_fd=fd) │ │ │ │ │ │ │ │ │ │ - :interface: the interface of the signal │ │ │ │ │ - :name: the 'member' name of the signal to emit │ │ │ │ │ - :signature: the type signature, as a string │ │ │ │ │ - :args: the arguments, according to the signature │ │ │ │ │ - :returns: True │ │ │ │ │ - """ │ │ │ │ │ - assert self._dbus_bus is not None │ │ │ │ │ - assert self._dbus_path is not None │ │ │ │ │ - return self._dbus_bus.message_new_signal(self._dbus_path, interface, name, signature, *args).send() │ │ │ │ │ + return result │ │ │ │ │ │ │ │ │ │ - def message_received(self, message: BusMessage) -> bool: │ │ │ │ │ - """Called when a message is received for this object │ │ │ │ │ + return get_attrs │ │ │ │ │ │ │ │ │ │ - This is the lowest level interface to the BaseObject. You need to │ │ │ │ │ - handle method calls, properties, and introspection. │ │ │ │ │ + def send_update(self, updates: JsonDict, *, reset: bool = False) -> None: │ │ │ │ │ + if reset: │ │ │ │ │ + if set(self.current_value) & set(updates): │ │ │ │ │ + # if we have an overlap, we need to do a proper reset │ │ │ │ │ + self.send_json(dict.fromkeys(self.current_value), partial=True) │ │ │ │ │ + self.current_value = {'partial': True} │ │ │ │ │ + updates.update(partial=None) │ │ │ │ │ + else: │ │ │ │ │ + # otherwise there's no overlap: we can just remove the old keys │ │ │ │ │ + updates.update(dict.fromkeys(self.current_value)) │ │ │ │ │ │ │ │ │ │ - You are expected to handle the message and return True. Normally this │ │ │ │ │ - means that you send a reply. If you don't want to handle the message, │ │ │ │ │ - return False and other handlers will have a chance to run. If no │ │ │ │ │ - handler handles the message, systemd will generate a suitable error │ │ │ │ │ - message and send that, instead. │ │ │ │ │ + json_merge_and_filter_patch(self.current_value, updates) │ │ │ │ │ + if updates: │ │ │ │ │ + self.send_json(updates) │ │ │ │ │ │ │ │ │ │ - :message: the message that was received │ │ │ │ │ - :returns: True if the message was handled │ │ │ │ │ - """ │ │ │ │ │ - raise NotImplementedError │ │ │ │ │ + def process_update(self, updates: 'set[str]', *, reset: bool = False) -> None: │ │ │ │ │ + assert self.fd is not None │ │ │ │ │ │ │ │ │ │ + entries: JsonDict = {name: self.getattrs(self.fd, name, Follow.NO) for name in updates} │ │ │ │ │ │ │ │ │ │ -class Interface: │ │ │ │ │ - """The high-level base class for defining D-Bus interfaces │ │ │ │ │ + info = entries.pop('', {}) │ │ │ │ │ + assert isinstance(info, dict) # fstat() will never fail with FileNotFoundError │ │ │ │ │ │ │ │ │ │ - This class provides high-level APIs for defining methods, properties, and │ │ │ │ │ - signals, as well as implementing introspection. │ │ │ │ │ + if self.effective_fnmatch: │ │ │ │ │ + info['entries'] = entries │ │ │ │ │ │ │ │ │ │ - On its own, this class doesn't provide a mechanism for exporting anything │ │ │ │ │ - on the bus. The Object class does that, and you'll generally want to │ │ │ │ │ - subclass from it, as it contains several built-in standard interfaces │ │ │ │ │ - (introspection, properties, etc.). │ │ │ │ │ + if self.targets: │ │ │ │ │ + info['targets'] = targets = {} │ │ │ │ │ + for name in {e.get('target') for e in entries.values() if isinstance(e, dict)}: │ │ │ │ │ + if isinstance(name, str) and ('/' in name or not self.interesting(name)): │ │ │ │ │ + # if this target is a string that we wouldn't otherwise │ │ │ │ │ + # report, then report it via our "targets" attribute. │ │ │ │ │ + targets[name] = self.getattrs(self.fd, name, Follow.YES) │ │ │ │ │ │ │ │ │ │ - The name of your class will be interpreted as a D-Bus interface name. │ │ │ │ │ - Underscores are converted to dots. No case conversion is performed. If │ │ │ │ │ - the interface name can't be represented using this scheme, or if you'd like │ │ │ │ │ - to name your class differently, you can provide an interface= kwarg to the │ │ │ │ │ - class definition. │ │ │ │ │ + self.send_update({'info': info}, reset=reset) │ │ │ │ │ │ │ │ │ │ - class com_example_Interface(bus.Object): │ │ │ │ │ - pass │ │ │ │ │ + def process_pending_updates(self) -> None: │ │ │ │ │ + assert self.pending is not None │ │ │ │ │ + if self.pending: │ │ │ │ │ + self.process_update(self.pending) │ │ │ │ │ + self.pending = None │ │ │ │ │ │ │ │ │ │ - class MyInterface(bus.Object, interface='org.cockpit_project.Interface'): │ │ │ │ │ - pass │ │ │ │ │ + def interesting(self, name: str) -> bool: │ │ │ │ │ + if name == '': │ │ │ │ │ + return True │ │ │ │ │ + else: │ │ │ │ │ + # only report updates on entry filenames if we match them │ │ │ │ │ + return fnmatch.fnmatch(name, self.effective_fnmatch) │ │ │ │ │ │ │ │ │ │ - The methods, properties, and signals which are visible from D-Bus are │ │ │ │ │ - defined using helper classes with the corresponding names (Method, │ │ │ │ │ - Property, Signal). You should use normal Python snake_case conventions for │ │ │ │ │ - the member names: they will automatically be converted to CamelCase by │ │ │ │ │ - splitting on underscore and converting the first letter of each resulting │ │ │ │ │ - word to uppercase. For example, `method_name` becomes `MethodName`. │ │ │ │ │ + def schedule_update(self, name: str) -> None: │ │ │ │ │ + if not self.interesting(name): │ │ │ │ │ + return │ │ │ │ │ │ │ │ │ │ - Each Method, Property, or Signal constructor takes an optional name= kwargs │ │ │ │ │ - to override the automatic name conversion convention above. │ │ │ │ │ + if self.pending is None: │ │ │ │ │ + asyncio.get_running_loop().call_later(0.1, self.process_pending_updates) │ │ │ │ │ + self.pending = set() │ │ │ │ │ │ │ │ │ │ - An example class might look like: │ │ │ │ │ + self.pending.add(name) │ │ │ │ │ │ │ │ │ │ - class com_example_MyObject(bus.Object): │ │ │ │ │ - created = bus.Interface.Signal('s', 'i') │ │ │ │ │ - renames = bus.Interface.Property('u', value=0) │ │ │ │ │ - name = bus.Interface.Property('s', 'undefined') │ │ │ │ │ + def report_error(self, err: int) -> None: │ │ │ │ │ + if err == errno.ENOENT: │ │ │ │ │ + problem = 'not-found' │ │ │ │ │ + elif err in (errno.EPERM, errno.EACCES): │ │ │ │ │ + problem = 'access-denied' │ │ │ │ │ + elif err == errno.ENOTDIR: │ │ │ │ │ + problem = 'not-directory' │ │ │ │ │ + else: │ │ │ │ │ + problem = 'internal-error' │ │ │ │ │ │ │ │ │ │ - @bus.Interface.Method(out_types=(), in_types='s') │ │ │ │ │ - def rename(self, name): │ │ │ │ │ - self.renames += 1 │ │ │ │ │ - self.name = name │ │ │ │ │ + self.send_update({'error': { │ │ │ │ │ + 'problem': problem, 'message': os.strerror(err), 'errno': errno.errorcode[err] │ │ │ │ │ + }}, reset=True) │ │ │ │ │ │ │ │ │ │ - def registered(self): │ │ │ │ │ - self.created('Hello', 42) │ │ │ │ │ + def flag_onlydir_error(self, fd: Handle) -> bool: │ │ │ │ │ + # If our requested path ended with '/' then make sure we got a │ │ │ │ │ + # directory, or else it's an error. open() will have already flagged │ │ │ │ │ + # that for us, but systemd_ctypes doesn't do that (yet). │ │ │ │ │ + if not self.watch or not self.path.endswith('/'): │ │ │ │ │ + return False │ │ │ │ │ │ │ │ │ │ - See the documentation for the Method, Property, and Signal classes for │ │ │ │ │ - more information and examples. │ │ │ │ │ - """ │ │ │ │ │ + buf = os.fstat(fd) # this should never fail │ │ │ │ │ + if stat.S_IFMT(buf.st_mode) != stat.S_IFDIR: │ │ │ │ │ + self.report_error(errno.ENOTDIR) │ │ │ │ │ + return True │ │ │ │ │ │ │ │ │ │ - # Class variables │ │ │ │ │ - _dbus_interfaces: Dict[str, Dict[str, Dict[str, Any]]] │ │ │ │ │ - _dbus_members: Optional[Tuple[str, Dict[str, Dict[str, Any]]]] │ │ │ │ │ + return False │ │ │ │ │ │ │ │ │ │ - # Instance variables: stored in Python form │ │ │ │ │ - _dbus_property_values: Optional[Dict[str, Any]] = None │ │ │ │ │ + def report_initial_state(self, fd: Handle) -> None: │ │ │ │ │ + if self.flag_onlydir_error(fd): │ │ │ │ │ + return │ │ │ │ │ │ │ │ │ │ - @classmethod │ │ │ │ │ - def __init_subclass__(cls, interface: Optional[str] = None) -> None: │ │ │ │ │ - if interface is None: │ │ │ │ │ - assert '__' not in cls.__name__, 'Class name cannot contain sequential underscores' │ │ │ │ │ - interface = cls.__name__.replace('_', '.') │ │ │ │ │ + self.fd = fd │ │ │ │ │ │ │ │ │ │ - # This is the information for this subclass directly │ │ │ │ │ - members: Dict[str, Dict[str, Interface._Member]] = {'methods': {}, 'properties': {}, 'signals': {}} │ │ │ │ │ - for name, member in cls.__dict__.items(): │ │ │ │ │ - if isinstance(member, Interface._Member): │ │ │ │ │ - member.setup(interface, name, members) │ │ │ │ │ + entries = {''} │ │ │ │ │ + if self.fnmatch: │ │ │ │ │ + try: │ │ │ │ │ + entries.update(os.listdir(f'/proc/self/fd/{self.fd}')) │ │ │ │ │ + self.effective_fnmatch = self.fnmatch │ │ │ │ │ + except OSError: │ │ │ │ │ + # If we failed to get an initial list, then report nothing from now on │ │ │ │ │ + self.effective_fnmatch = '' │ │ │ │ │ │ │ │ │ │ - # We only store the information if something was actually defined │ │ │ │ │ - if sum(len(category) for category in members.values()) > 0: │ │ │ │ │ - cls._dbus_members = (interface, members) │ │ │ │ │ + self.process_update({e for e in entries if self.interesting(e)}, reset=True) │ │ │ │ │ │ │ │ │ │ - # This is the information for this subclass, with all its ancestors │ │ │ │ │ - cls._dbus_interfaces = dict(ancestor.__dict__['_dbus_members'] │ │ │ │ │ - for ancestor in cls.mro() │ │ │ │ │ - if '_dbus_members' in ancestor.__dict__) │ │ │ │ │ + def do_inotify_event(self, mask: InotifyEvent, cookie: int, rawname: 'bytes | None') -> None: │ │ │ │ │ + logger.debug('do_inotify_event(%r, %r, %r)', mask, cookie, rawname) │ │ │ │ │ + name = (rawname or b'').decode(errors='surrogateescape') │ │ │ │ │ │ │ │ │ │ - @classmethod │ │ │ │ │ - def _find_interface(cls, interface: str) -> Dict[str, Dict[str, '_Member']]: │ │ │ │ │ - try: │ │ │ │ │ - return cls._dbus_interfaces[interface] │ │ │ │ │ - except KeyError as exc: │ │ │ │ │ - raise Object.Method.Unhandled from exc │ │ │ │ │ + self.schedule_update(name) │ │ │ │ │ │ │ │ │ │ - @classmethod │ │ │ │ │ - def _find_category(cls, interface: str, category: str) -> Dict[str, '_Member']: │ │ │ │ │ - return cls._find_interface(interface)[category] │ │ │ │ │ + if name and mask | (InotifyEvent.CREATE | InotifyEvent.DELETE | │ │ │ │ │ + InotifyEvent.MOVED_TO | InotifyEvent.MOVED_FROM): │ │ │ │ │ + # These events change the mtime of the directory │ │ │ │ │ + self.schedule_update('') │ │ │ │ │ │ │ │ │ │ - @classmethod │ │ │ │ │ - def _find_member(cls, interface: str, category: str, member: str) -> '_Member': │ │ │ │ │ - members = cls._find_category(interface, category) │ │ │ │ │ - try: │ │ │ │ │ - return members[member] │ │ │ │ │ - except KeyError as exc: │ │ │ │ │ - raise Object.Method.Unhandled from exc │ │ │ │ │ + def do_identity_changed(self, fd: 'Handle | None', err: 'int | None') -> None: │ │ │ │ │ + logger.debug('do_identity_changed(%r, %r)', fd, err) │ │ │ │ │ + # If there were previously pending changes, they are now irrelevant. │ │ │ │ │ + if self.pending is not None: │ │ │ │ │ + # Note: don't set to None, since the handler is still pending │ │ │ │ │ + self.pending.clear() │ │ │ │ │ │ │ │ │ │ - class _Member: │ │ │ │ │ - _category: str # filled in from subclasses │ │ │ │ │ + if err is None: │ │ │ │ │ + assert fd is not None │ │ │ │ │ + self.report_initial_state(fd) │ │ │ │ │ + else: │ │ │ │ │ + self.report_error(err) │ │ │ │ │ │ │ │ │ │ - _python_name: Optional[str] = None │ │ │ │ │ - _name: Optional[str] = None │ │ │ │ │ - _interface: Optional[str] = None │ │ │ │ │ - _description: Optional[Dict[str, Any]] │ │ │ │ │ + def do_close(self) -> None: │ │ │ │ │ + # non-watch channels close immediately — if we get this, we're watching │ │ │ │ │ + assert self.path_watch is not None │ │ │ │ │ + self.path_watch.close() │ │ │ │ │ + self.close() │ │ │ │ │ │ │ │ │ │ - def __init__(self, name: Optional[str] = None) -> None: │ │ │ │ │ - self._python_name = None │ │ │ │ │ - self._interface = None │ │ │ │ │ - self._name = name │ │ │ │ │ + def do_open(self, options: JsonObject) -> None: │ │ │ │ │ + self.path = get_str(options, 'path') │ │ │ │ │ + if not os.path.isabs(self.path): │ │ │ │ │ + raise JsonError(options, '"path" must be an absolute path') │ │ │ │ │ │ │ │ │ │ - def setup(self, interface: str, name: str, members: Dict[str, Dict[str, 'Interface._Member']]) -> None: │ │ │ │ │ - self._python_name = name # for error messages │ │ │ │ │ - if self._name is None: │ │ │ │ │ - self._name = ''.join(word.title() for word in name.split('_')) │ │ │ │ │ - self._interface = interface │ │ │ │ │ - self._description = self._describe() │ │ │ │ │ - members[self._category][self._name] = self │ │ │ │ │ + attrs = set(get_strv(options, 'attrs')) │ │ │ │ │ + self.getattrs = self.make_getattrs(attrs - {'targets', 'entries'}) │ │ │ │ │ + self.fnmatch = get_str(options, 'fnmatch', '*' if 'entries' in attrs else '') │ │ │ │ │ + self.targets = 'targets' in attrs │ │ │ │ │ + self.follow = get_bool(options, 'follow', default=True) │ │ │ │ │ + self.watch = get_bool(options, 'watch', default=False) │ │ │ │ │ + if self.watch and not self.follow: │ │ │ │ │ + raise JsonError(options, '"watch: true" and "follow: false" are (currently) incompatible') │ │ │ │ │ + if self.targets and not self.follow: │ │ │ │ │ + raise JsonError(options, '`targets: "stat"` and `follow: false` are (currently) incompatible') │ │ │ │ │ │ │ │ │ │ - def _describe(self) -> Dict[str, Any]: │ │ │ │ │ - raise NotImplementedError │ │ │ │ │ + self.current_value = {} │ │ │ │ │ + self.ready() │ │ │ │ │ │ │ │ │ │ - def __getitem__(self, key: str) -> Any: │ │ │ │ │ - # Acts as an adaptor for dict accesses from introspection.to_xml() │ │ │ │ │ - assert self._description is not None │ │ │ │ │ - return self._description[key] │ │ │ │ │ + if not self.watch: │ │ │ │ │ + try: │ │ │ │ │ + fd = Handle.open(self.path, os.O_PATH if self.follow else os.O_PATH | os.O_NOFOLLOW) │ │ │ │ │ + except OSError as exc: │ │ │ │ │ + self.report_error(exc.errno) │ │ │ │ │ + else: │ │ │ │ │ + self.report_initial_state(fd) │ │ │ │ │ + fd.close() │ │ │ │ │ │ │ │ │ │ - class Property(_Member): │ │ │ │ │ - """Defines a D-Bus property on an interface │ │ │ │ │ + self.done() │ │ │ │ │ + self.close() │ │ │ │ │ │ │ │ │ │ - There are two main ways to define properties: with and without getters. │ │ │ │ │ - If you define a property without a getter, then you must provide a │ │ │ │ │ - value (via the value= kwarg). In this case, the property value is │ │ │ │ │ - maintained internally and can be accessed from Python in the usual way. │ │ │ │ │ - Change signals are sent automatically. │ │ │ │ │ + else: │ │ │ │ │ + # PathWatch will call do_identity_changed(), which does the same as │ │ │ │ │ + # above: calls either report_initial_state() or report_error(), │ │ │ │ │ + # depending on if it was provided with an fd or an error code. │ │ │ │ │ + self.path_watch = PathWatch(self.path, self) │ │ │ │ │ +'''.encode('utf-8'), │ │ │ │ │ + 'cockpit/channels/stream.py': br'''# This file is part of Cockpit. │ │ │ │ │ +# │ │ │ │ │ +# Copyright (C) 2022 Red Hat, Inc. │ │ │ │ │ +# │ │ │ │ │ +# This program is free software: you can redistribute it and/or modify │ │ │ │ │ +# it under the terms of the GNU General Public License as published by │ │ │ │ │ +# the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ +# (at your option) any later version. │ │ │ │ │ +# │ │ │ │ │ +# This program is distributed in the hope that it will be useful, │ │ │ │ │ +# but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ +# GNU General Public License for more details. │ │ │ │ │ +# │ │ │ │ │ +# You should have received a copy of the GNU General Public License │ │ │ │ │ +# along with this program. If not, see . │ │ │ │ │ │ │ │ │ │ - class MyObject(bus.Object): │ │ │ │ │ - counter = bus.Interface.Property('i', value=0) │ │ │ │ │ +import asyncio │ │ │ │ │ +import logging │ │ │ │ │ +import os │ │ │ │ │ +import subprocess │ │ │ │ │ +from typing import Dict │ │ │ │ │ │ │ │ │ │ - a = MyObject() │ │ │ │ │ - a.counter = 5 │ │ │ │ │ - a.counter += 1 │ │ │ │ │ - print(a.counter) │ │ │ │ │ +from ..channel import ChannelError, ProtocolChannel │ │ │ │ │ +from ..jsonutil import JsonDict, JsonObject, get_bool, get_enum, get_int, get_object, get_str, get_strv │ │ │ │ │ +from ..transports import SubprocessProtocol, SubprocessTransport, WindowSize │ │ │ │ │ │ │ │ │ │ - The other way to define properties is with a getter function. In this │ │ │ │ │ - case, you can read from the property in the normal way, but not write │ │ │ │ │ - to it. You are responsible for emitting change signals for yourself. │ │ │ │ │ - You must not provide the value= kwarg. │ │ │ │ │ +logger = logging.getLogger(__name__) │ │ │ │ │ │ │ │ │ │ - class MyObject(bus.Object): │ │ │ │ │ - _counter = 0 │ │ │ │ │ │ │ │ │ │ - counter = bus.Interface.Property('i') │ │ │ │ │ - @counter.getter │ │ │ │ │ - def get_counter(self): │ │ │ │ │ - return self._counter │ │ │ │ │ +class SocketStreamChannel(ProtocolChannel): │ │ │ │ │ + payload = 'stream' │ │ │ │ │ │ │ │ │ │ - @counter.setter │ │ │ │ │ - def set_counter(self, value): │ │ │ │ │ - self._counter = value │ │ │ │ │ - self.property_changed('Counter') │ │ │ │ │ + async def create_transport(self, loop: asyncio.AbstractEventLoop, options: JsonObject) -> asyncio.Transport: │ │ │ │ │ + if 'unix' in options and 'port' in options: │ │ │ │ │ + raise ChannelError('protocol-error', message='cannot specify both "port" and "unix" options') │ │ │ │ │ │ │ │ │ │ - In either case, you can provide a setter function. This function has │ │ │ │ │ - no impact on Python code, but makes the property writable from the view │ │ │ │ │ - of D-Bus. Your setter will be called when a Properties.Set() call is │ │ │ │ │ - made, and no other action will be performed. A trivial implementation │ │ │ │ │ - might look like: │ │ │ │ │ + try: │ │ │ │ │ + # Unix │ │ │ │ │ + if 'unix' in options: │ │ │ │ │ + path = get_str(options, 'unix') │ │ │ │ │ + label = f'Unix socket {path}' │ │ │ │ │ + transport, _ = await loop.create_unix_connection(lambda: self, path) │ │ │ │ │ │ │ │ │ │ - class MyObject(bus.Object): │ │ │ │ │ - counter = bus.Interface.Property('i', value=0) │ │ │ │ │ - @counter.setter │ │ │ │ │ - def set_counter(self, value): │ │ │ │ │ - # we got a request to set the counter from D-Bus │ │ │ │ │ - self.counter = value │ │ │ │ │ + # TCP │ │ │ │ │ + elif 'port' in options: │ │ │ │ │ + port = get_int(options, 'port') │ │ │ │ │ + host = get_str(options, 'address', 'localhost') │ │ │ │ │ + label = f'TCP socket {host}:{port}' │ │ │ │ │ │ │ │ │ │ - In all cases, the first (and only mandatory) argument to the │ │ │ │ │ - constructor is the D-Bus type of the property. │ │ │ │ │ + transport, _ = await loop.create_connection(lambda: self, host, port) │ │ │ │ │ + else: │ │ │ │ │ + raise ChannelError('protocol-error', │ │ │ │ │ + message='no "port" or "unix" or other address option for channel') │ │ │ │ │ │ │ │ │ │ - Your getter and setter functions can be provided by kwarg to the │ │ │ │ │ - constructor. You can also give a name= kwarg to override the default │ │ │ │ │ - name conversion scheme. │ │ │ │ │ - """ │ │ │ │ │ - _category = 'properties' │ │ │ │ │ + logger.debug('SocketStreamChannel: connected to %s', label) │ │ │ │ │ + except OSError as error: │ │ │ │ │ + logger.info('SocketStreamChannel: connecting to %s failed: %s', label, error) │ │ │ │ │ + if isinstance(error, ConnectionRefusedError): │ │ │ │ │ + problem = 'not-found' │ │ │ │ │ + else: │ │ │ │ │ + problem = 'terminated' │ │ │ │ │ + raise ChannelError(problem, message=str(error)) from error │ │ │ │ │ + self.close_on_eof() │ │ │ │ │ + assert isinstance(transport, asyncio.Transport) │ │ │ │ │ + return transport │ │ │ │ │ │ │ │ │ │ - _getter: Optional[Callable[[Any], Any]] │ │ │ │ │ - _setter: Optional[Callable[[Any, Any], None]] │ │ │ │ │ - _type: bustypes.Type │ │ │ │ │ - _value: Any │ │ │ │ │ │ │ │ │ │ - def __init__(self, type_string: str, │ │ │ │ │ - value: Any = None, │ │ │ │ │ - name: Optional[str] = None, │ │ │ │ │ - getter: Optional[Callable[[Any], Any]] = None, │ │ │ │ │ - setter: Optional[Callable[[Any, Any], None]] = None): │ │ │ │ │ - assert value is None or getter is None, 'A property cannot have both a value and a getter' │ │ │ │ │ +class SubprocessStreamChannel(ProtocolChannel, SubprocessProtocol): │ │ │ │ │ + payload = 'stream' │ │ │ │ │ + restrictions = (('spawn', None),) │ │ │ │ │ │ │ │ │ │ - super().__init__(name=name) │ │ │ │ │ - self._getter = getter │ │ │ │ │ - self._setter = setter │ │ │ │ │ - self._type, = bustypes.from_signature(type_string) │ │ │ │ │ - self._value = value │ │ │ │ │ + def process_exited(self) -> None: │ │ │ │ │ + self.close_on_eof() │ │ │ │ │ │ │ │ │ │ - def _describe(self) -> Dict[str, Any]: │ │ │ │ │ - return {'type': self._type.typestring, 'flags': 'r' if self._setter is None else 'w'} │ │ │ │ │ + def _get_close_args(self) -> JsonObject: │ │ │ │ │ + assert isinstance(self._transport, SubprocessTransport) │ │ │ │ │ + args: JsonDict = {'exit-status': self._transport.get_returncode()} │ │ │ │ │ + stderr = self._transport.get_stderr() │ │ │ │ │ + if stderr is not None: │ │ │ │ │ + args['message'] = stderr │ │ │ │ │ + return args │ │ │ │ │ │ │ │ │ │ - def __get__(self, obj: 'Object', cls: Optional[type] = None) -> Any: │ │ │ │ │ - assert self._name is not None │ │ │ │ │ - if obj is None: │ │ │ │ │ - return self │ │ │ │ │ - if self._getter is not None: │ │ │ │ │ - return self._getter.__get__(obj, cls)() │ │ │ │ │ - elif self._value is not None: │ │ │ │ │ - if obj._dbus_property_values is not None: │ │ │ │ │ - return obj._dbus_property_values.get(self._name, self._value) │ │ │ │ │ - else: │ │ │ │ │ - return self._value │ │ │ │ │ - else: │ │ │ │ │ - raise AttributeError(f"'{obj.__class__.__name__}' property '{self._python_name}' " │ │ │ │ │ - f"was not properly initialised: use either the 'value=' kwarg or " │ │ │ │ │ - f"the @'{self._python_name}.getter' decorator") │ │ │ │ │ + def do_options(self, options): │ │ │ │ │ + window = get_object(options, 'window', WindowSize, None) │ │ │ │ │ + if window is not None: │ │ │ │ │ + self._transport.set_window_size(window) │ │ │ │ │ │ │ │ │ │ - def __set__(self, obj: 'Object', value: Any) -> None: │ │ │ │ │ - assert self._name is not None │ │ │ │ │ - if self._getter is not None: │ │ │ │ │ - raise AttributeError(f"Cannot directly assign '{obj.__class__.__name__}' " │ │ │ │ │ - "property '{self._python_name}' because it has a getter") │ │ │ │ │ - if obj._dbus_property_values is None: │ │ │ │ │ - obj._dbus_property_values = {} │ │ │ │ │ - obj._dbus_property_values[self._name] = value │ │ │ │ │ - if obj._dbus_bus is not None: │ │ │ │ │ - obj.properties_changed(self._interface, {self._name: bustypes.Variant(value, self._type)}, []) │ │ │ │ │ + async def create_transport(self, loop: asyncio.AbstractEventLoop, options: JsonObject) -> SubprocessTransport: │ │ │ │ │ + args = get_strv(options, 'spawn') │ │ │ │ │ + err = get_enum(options, 'err', ['out', 'ignore', 'message'], 'message') │ │ │ │ │ + cwd = get_str(options, 'directory', '.') │ │ │ │ │ + pty = get_bool(options, 'pty', default=False) │ │ │ │ │ + window = get_object(options, 'window', WindowSize, None) │ │ │ │ │ + environ = get_strv(options, 'environ', []) │ │ │ │ │ │ │ │ │ │ - def to_dbus(self, obj: 'Object') -> bustypes.Variant: │ │ │ │ │ - return bustypes.Variant(self.__get__(obj), self._type) │ │ │ │ │ + if err == 'out': │ │ │ │ │ + stderr = subprocess.STDOUT │ │ │ │ │ + elif err == 'ignore': │ │ │ │ │ + stderr = subprocess.DEVNULL │ │ │ │ │ + else: │ │ │ │ │ + stderr = subprocess.PIPE │ │ │ │ │ │ │ │ │ │ - def from_dbus(self, obj: 'Object', value: bustypes.Variant) -> None: │ │ │ │ │ - if self._setter is None or self._type != value.type: │ │ │ │ │ - raise Object.Method.Unhandled │ │ │ │ │ - self._setter.__get__(obj)(value.value) │ │ │ │ │ + env: Dict[str, str] = dict(os.environ) │ │ │ │ │ + try: │ │ │ │ │ + env.update(dict(e.split('=', 1) for e in environ)) │ │ │ │ │ + except ValueError: │ │ │ │ │ + raise ChannelError('protocol-error', message='invalid "environ" option for stream channel') from None │ │ │ │ │ │ │ │ │ │ - def getter(self, getter: Callable[[Any], Any]) -> Callable[[Any], Any]: │ │ │ │ │ - if self._value is not None: │ │ │ │ │ - raise ValueError('A property cannot have both a value and a getter') │ │ │ │ │ - if self._getter is not None: │ │ │ │ │ - raise ValueError('This property already has a getter') │ │ │ │ │ - self._getter = getter │ │ │ │ │ - return getter │ │ │ │ │ + try: │ │ │ │ │ + transport = SubprocessTransport(loop, self, args, pty=pty, window=window, env=env, cwd=cwd, stderr=stderr) │ │ │ │ │ + logger.debug('Spawned process args=%s pid=%i', args, transport.get_pid()) │ │ │ │ │ + return transport │ │ │ │ │ + except FileNotFoundError as error: │ │ │ │ │ + raise ChannelError('not-found') from error │ │ │ │ │ + except PermissionError as error: │ │ │ │ │ + raise ChannelError('access-denied') from error │ │ │ │ │ + except OSError as error: │ │ │ │ │ + logger.info("Failed to spawn %s: %s", args, str(error)) │ │ │ │ │ + raise ChannelError('internal-error') from error │ │ │ │ │ +''', │ │ │ │ │ + 'cockpit/channels/packages.py': br'''# This file is part of Cockpit. │ │ │ │ │ +# │ │ │ │ │ +# Copyright (C) 2022 Red Hat, Inc. │ │ │ │ │ +# │ │ │ │ │ +# This program is free software: you can redistribute it and/or modify │ │ │ │ │ +# it under the terms of the GNU General Public License as published by │ │ │ │ │ +# the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ +# (at your option) any later version. │ │ │ │ │ +# │ │ │ │ │ +# This program is distributed in the hope that it will be useful, │ │ │ │ │ +# but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ +# GNU General Public License for more details. │ │ │ │ │ +# │ │ │ │ │ +# You should have received a copy of the GNU General Public License │ │ │ │ │ +# along with this program. If not, see . │ │ │ │ │ │ │ │ │ │ - def setter(self, setter: Callable[[Any, Any], None]) -> Callable[[Any, Any], None]: │ │ │ │ │ - self._setter = setter │ │ │ │ │ - return setter │ │ │ │ │ +import logging │ │ │ │ │ +from typing import Optional │ │ │ │ │ │ │ │ │ │ - class Signal(_Member): │ │ │ │ │ - """Defines a D-Bus signal on an interface │ │ │ │ │ +from ..channel import AsyncChannel │ │ │ │ │ +from ..data import read_cockpit_data_file │ │ │ │ │ +from ..jsonutil import JsonObject, get_dict, get_str │ │ │ │ │ +from ..packages import Packages │ │ │ │ │ │ │ │ │ │ - This is a callable which will result in the signal being emitted. │ │ │ │ │ +logger = logging.getLogger(__name__) │ │ │ │ │ │ │ │ │ │ - The constructor takes the types of the arguments, each one as a │ │ │ │ │ - separate parameter. For example: │ │ │ │ │ │ │ │ │ │ - properties_changed = Interface.Signal('s', 'a{sv}', 'as') │ │ │ │ │ +class PackagesChannel(AsyncChannel): │ │ │ │ │ + payload = 'http-stream1' │ │ │ │ │ + restrictions = [("internal", "packages")] │ │ │ │ │ │ │ │ │ │ - You can give a name= kwarg to override the default name conversion │ │ │ │ │ - scheme. │ │ │ │ │ - """ │ │ │ │ │ - _category = 'signals' │ │ │ │ │ - _type: bustypes.MessageType │ │ │ │ │ + # used to carry data forward from open to done │ │ │ │ │ + options: Optional[JsonObject] = None │ │ │ │ │ │ │ │ │ │ - def __init__(self, *out_types: str, name: Optional[str] = None) -> None: │ │ │ │ │ - super().__init__(name=name) │ │ │ │ │ - self._type = bustypes.MessageType(out_types) │ │ │ │ │ + def http_error(self, status: int, message: str) -> None: │ │ │ │ │ + template = read_cockpit_data_file('fail.html') │ │ │ │ │ + self.send_json(status=status, reason='ERROR', headers={'Content-Type': 'text/html; charset=utf-8'}) │ │ │ │ │ + self.send_data(template.replace(b'@@message@@', message.encode('utf-8'))) │ │ │ │ │ + self.done() │ │ │ │ │ + self.close() │ │ │ │ │ │ │ │ │ │ - def _describe(self) -> Dict[str, Any]: │ │ │ │ │ - return {'in': self._type.typestrings} │ │ │ │ │ + async def run(self, options: JsonObject) -> None: │ │ │ │ │ + packages: Packages = self.router.packages # type: ignore[attr-defined] # yes, this is evil │ │ │ │ │ │ │ │ │ │ - def __get__(self, obj: 'Object', cls: Optional[type] = None) -> Callable[..., None]: │ │ │ │ │ - def emitter(obj: Object, *args: Any) -> None: │ │ │ │ │ - assert self._interface is not None │ │ │ │ │ - assert self._name is not None │ │ │ │ │ - assert obj._dbus_bus is not None │ │ │ │ │ - assert obj._dbus_path is not None │ │ │ │ │ - message = obj._dbus_bus.message_new_signal(obj._dbus_path, self._interface, self._name) │ │ │ │ │ - self._type.write(message, *args) │ │ │ │ │ - message.send() │ │ │ │ │ - return emitter.__get__(obj, cls) │ │ │ │ │ + try: │ │ │ │ │ + if get_str(options, 'method') != 'GET': │ │ │ │ │ + raise ValueError(f'Unsupported HTTP method {options["method"]}') │ │ │ │ │ │ │ │ │ │ - class Method(_Member): │ │ │ │ │ - """Defines a D-Bus method on an interface │ │ │ │ │ + self.ready() │ │ │ │ │ + if await self.read() is not None: │ │ │ │ │ + raise ValueError('Received unexpected data') │ │ │ │ │ │ │ │ │ │ - This is a function decorator which marks a given method for export. │ │ │ │ │ + path = get_str(options, 'path') │ │ │ │ │ + headers = get_dict(options, 'headers') │ │ │ │ │ + document = packages.load_path(path, headers) │ │ │ │ │ │ │ │ │ │ - The constructor takes two arguments: the type of the output arguments, │ │ │ │ │ - and the type of the input arguments. Both should be given as a │ │ │ │ │ - sequence. │ │ │ │ │ + # Note: we can't cache documents right now. See │ │ │ │ │ + # https://github.com/cockpit-project/cockpit/issues/19071 │ │ │ │ │ + # for future plans. │ │ │ │ │ + out_headers = { │ │ │ │ │ + 'Cache-Control': 'no-cache, no-store', │ │ │ │ │ + 'Content-Type': document.content_type, │ │ │ │ │ + } │ │ │ │ │ │ │ │ │ │ - @Interface.Method(['a{sv}'], ['s']) │ │ │ │ │ - def get_all(self, interface): │ │ │ │ │ - ... │ │ │ │ │ + if document.content_encoding is not None: │ │ │ │ │ + out_headers['Content-Encoding'] = document.content_encoding │ │ │ │ │ │ │ │ │ │ - You can give a name= kwarg to override the default name conversion │ │ │ │ │ - scheme. │ │ │ │ │ - """ │ │ │ │ │ - _category = 'methods' │ │ │ │ │ + if document.content_security_policy is not None: │ │ │ │ │ + policy = document.content_security_policy │ │ │ │ │ │ │ │ │ │ - class Unhandled(Exception): │ │ │ │ │ - """Raised by a method to indicate that the message triggering that │ │ │ │ │ - method call remains unhandled.""" │ │ │ │ │ - pass │ │ │ │ │ + # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/connect-src │ │ │ │ │ + # │ │ │ │ │ + # Note: connect-src 'self' does not resolve to websocket │ │ │ │ │ + # schemes in all browsers, more info in this issue. │ │ │ │ │ + # │ │ │ │ │ + # https://github.com/w3c/webappsec-csp/issues/7 │ │ │ │ │ + if "connect-src 'self';" in policy: │ │ │ │ │ + protocol = headers.get('X-Forwarded-Proto') │ │ │ │ │ + host = headers.get('X-Forwarded-Host') │ │ │ │ │ + if not isinstance(protocol, str) or not isinstance(host, str): │ │ │ │ │ + raise ValueError('Invalid host or protocol header') │ │ │ │ │ │ │ │ │ │ - def __init__(self, out_types: Sequence[str] = (), in_types: Sequence[str] = (), name: Optional[str] = None): │ │ │ │ │ - super().__init__(name=name) │ │ │ │ │ - self._out_type = bustypes.MessageType(out_types) │ │ │ │ │ - self._in_type = bustypes.MessageType(in_types) │ │ │ │ │ - self._func = None │ │ │ │ │ + websocket_scheme = "wss" if protocol == "https" else "ws" │ │ │ │ │ + websocket_origin = f"{websocket_scheme}://{host}" │ │ │ │ │ + policy = policy.replace("connect-src 'self';", f"connect-src {websocket_origin} 'self';") │ │ │ │ │ │ │ │ │ │ - def __get__(self, obj, cls=None): │ │ │ │ │ - return self._func.__get__(obj, cls) │ │ │ │ │ + out_headers['Content-Security-Policy'] = policy │ │ │ │ │ │ │ │ │ │ - def __call__(self, *args, **kwargs): │ │ │ │ │ - # decorator │ │ │ │ │ - self._func, = args │ │ │ │ │ - return self │ │ │ │ │ + except ValueError as exc: │ │ │ │ │ + self.http_error(400, str(exc)) │ │ │ │ │ │ │ │ │ │ - def _describe(self) -> Dict[str, Any]: │ │ │ │ │ - return {'in': [item.typestring for item in self._in_type.item_types], │ │ │ │ │ - 'out': [item.typestring for item in self._out_type.item_types]} │ │ │ │ │ + except KeyError: │ │ │ │ │ + self.http_error(404, 'Not found') │ │ │ │ │ │ │ │ │ │ - def _invoke(self, obj, message): │ │ │ │ │ - args = self._in_type.read(message) │ │ │ │ │ - if args is None: │ │ │ │ │ - return False │ │ │ │ │ - try: │ │ │ │ │ - result = self._func.__get__(obj)(*args) │ │ │ │ │ - except (BusError, OSError) as error: │ │ │ │ │ - return message.reply_method_error(error) │ │ │ │ │ + except OSError as exc: │ │ │ │ │ + self.http_error(500, f'Internal error: {exc!s}') │ │ │ │ │ │ │ │ │ │ - return message.reply_method_function_return_value(self._out_type, result) │ │ │ │ │ + else: │ │ │ │ │ + self.send_json(status=200, reason='OK', headers=out_headers) │ │ │ │ │ + await self.sendfile(document.data) │ │ │ │ │ +''', │ │ │ │ │ + 'cockpit/_vendor/__init__.py': br'''''', │ │ │ │ │ + 'cockpit/_vendor/ferny/interaction_client.py': br'''#!/usr/bin/python3 │ │ │ │ │ │ │ │ │ │ +import array │ │ │ │ │ +import io │ │ │ │ │ +import os │ │ │ │ │ +import socket │ │ │ │ │ +import sys │ │ │ │ │ +from typing import Sequence │ │ │ │ │ │ │ │ │ │ -class org_freedesktop_DBus_Peer(Interface): │ │ │ │ │ - @Interface.Method() │ │ │ │ │ - @staticmethod │ │ │ │ │ - def ping() -> None: │ │ │ │ │ - pass │ │ │ │ │ │ │ │ │ │ - @Interface.Method('s') │ │ │ │ │ - @staticmethod │ │ │ │ │ - def get_machine_id() -> str: │ │ │ │ │ - with open('/etc/machine-id', encoding='ascii') as file: │ │ │ │ │ - return file.read().strip() │ │ │ │ │ +def command(stderr_fd: int, command: str, *args: object, fds: Sequence[int] = ()) -> None: │ │ │ │ │ + cmd_read, cmd_write = [io.open(*end) for end in zip(os.pipe(), 'rw')] │ │ │ │ │ │ │ │ │ │ + with cmd_write: │ │ │ │ │ + with cmd_read: │ │ │ │ │ + with socket.fromfd(stderr_fd, socket.AF_UNIX, socket.SOCK_STREAM) as sock: │ │ │ │ │ + fd_array = array.array('i', (cmd_read.fileno(), *fds)) │ │ │ │ │ + sock.sendmsg([b'\0'], [(socket.SOL_SOCKET, socket.SCM_RIGHTS, fd_array)]) │ │ │ │ │ │ │ │ │ │ -class org_freedesktop_DBus_Introspectable(Interface): │ │ │ │ │ - @Interface.Method('s') │ │ │ │ │ - @classmethod │ │ │ │ │ - def introspect(cls) -> str: │ │ │ │ │ - return introspection.to_xml(cls._dbus_interfaces) │ │ │ │ │ + cmd_write.write(repr((command, args))) │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ -class org_freedesktop_DBus_Properties(Interface): │ │ │ │ │ - properties_changed = Interface.Signal('s', 'a{sv}', 'as') │ │ │ │ │ +def askpass(stderr_fd: int, stdout_fd: int, args: 'list[str]', env: 'dict[str, str]') -> int: │ │ │ │ │ + ours, theirs = socket.socketpair() │ │ │ │ │ │ │ │ │ │ - @Interface.Method('v', 'ss') │ │ │ │ │ - def get(self, interface, name): │ │ │ │ │ - return self._find_member(interface, 'properties', name).to_dbus(self) │ │ │ │ │ + with theirs: │ │ │ │ │ + command(stderr_fd, 'ferny.askpass', args, env, fds=(theirs.fileno(), stdout_fd)) │ │ │ │ │ │ │ │ │ │ - @Interface.Method(['a{sv}'], 's') │ │ │ │ │ - def get_all(self, interface): │ │ │ │ │ - properties = self._find_category(interface, 'properties') │ │ │ │ │ - return {name: prop.to_dbus(self) for name, prop in properties.items()} │ │ │ │ │ + with ours: │ │ │ │ │ + return int(ours.recv(16) or b'1') │ │ │ │ │ │ │ │ │ │ - @Interface.Method('', 'ssv') │ │ │ │ │ - def set(self, interface, name, value): │ │ │ │ │ - self._find_member(interface, 'properties', name).from_dbus(self, value) │ │ │ │ │ │ │ │ │ │ +def main() -> None: │ │ │ │ │ + if len(sys.argv) == 1: │ │ │ │ │ + command(2, 'ferny.end', []) │ │ │ │ │ + else: │ │ │ │ │ + sys.exit(askpass(2, 1, sys.argv, dict(os.environ))) │ │ │ │ │ │ │ │ │ │ -class Object(org_freedesktop_DBus_Introspectable, │ │ │ │ │ - org_freedesktop_DBus_Peer, │ │ │ │ │ - org_freedesktop_DBus_Properties, │ │ │ │ │ - BaseObject, │ │ │ │ │ - Interface): │ │ │ │ │ - """High-level base class for exporting objects on D-Bus │ │ │ │ │ │ │ │ │ │ - This is usually where you should start. │ │ │ │ │ +if __name__ == '__main__': │ │ │ │ │ + main() │ │ │ │ │ +''', │ │ │ │ │ + 'cockpit/_vendor/ferny/__init__.py': br'''from .interaction_agent import ( │ │ │ │ │ + BEIBOOT_GADGETS, │ │ │ │ │ + COMMAND_TEMPLATE, │ │ │ │ │ + AskpassHandler, │ │ │ │ │ + InteractionAgent, │ │ │ │ │ + InteractionError, │ │ │ │ │ + InteractionHandler, │ │ │ │ │ + temporary_askpass, │ │ │ │ │ + write_askpass_to_tmpdir, │ │ │ │ │ +) │ │ │ │ │ +from .session import Session │ │ │ │ │ +from .ssh_askpass import ( │ │ │ │ │ + AskpassPrompt, │ │ │ │ │ + SshAskpassResponder, │ │ │ │ │ + SshFIDOPINPrompt, │ │ │ │ │ + SshFIDOUserPresencePrompt, │ │ │ │ │ + SshHostKeyPrompt, │ │ │ │ │ + SshPassphrasePrompt, │ │ │ │ │ + SshPasswordPrompt, │ │ │ │ │ + SshPKCS11PINPrompt, │ │ │ │ │ +) │ │ │ │ │ +from .ssh_errors import ( │ │ │ │ │ + SshAuthenticationError, │ │ │ │ │ + SshChangedHostKeyError, │ │ │ │ │ + SshError, │ │ │ │ │ + SshHostKeyError, │ │ │ │ │ + SshUnknownHostKeyError, │ │ │ │ │ +) │ │ │ │ │ +from .transport import FernyTransport, SubprocessError │ │ │ │ │ │ │ │ │ │ - This provides a base for exporting objects on the bus, implements the │ │ │ │ │ - standard D-Bus interfaces, and allows you to add your own interfaces to the │ │ │ │ │ - mix. See the documentation for Interface to find out how to define and │ │ │ │ │ - implement your D-Bus interface. │ │ │ │ │ - """ │ │ │ │ │ - def message_received(self, message: BusMessage) -> bool: │ │ │ │ │ - interface = message.get_interface() │ │ │ │ │ - name = message.get_member() │ │ │ │ │ +__all__ = [ │ │ │ │ │ + 'AskpassHandler', │ │ │ │ │ + 'AskpassPrompt', │ │ │ │ │ + 'AuthenticationError', │ │ │ │ │ + 'BEIBOOT_GADGETS', │ │ │ │ │ + 'COMMAND_TEMPLATE', │ │ │ │ │ + 'ChangedHostKeyError', │ │ │ │ │ + 'FernyTransport', │ │ │ │ │ + 'HostKeyError', │ │ │ │ │ + 'InteractionAgent', │ │ │ │ │ + 'InteractionError', │ │ │ │ │ + 'InteractionHandler', │ │ │ │ │ + 'Session', │ │ │ │ │ + 'SshAskpassResponder', │ │ │ │ │ + 'SshAuthenticationError', │ │ │ │ │ + 'SshChangedHostKeyError', │ │ │ │ │ + 'SshError', │ │ │ │ │ + 'SshFIDOPINPrompt', │ │ │ │ │ + 'SshFIDOUserPresencePrompt', │ │ │ │ │ + 'SshHostKeyError', │ │ │ │ │ + 'SshHostKeyPrompt', │ │ │ │ │ + 'SshPKCS11PINPrompt', │ │ │ │ │ + 'SshPassphrasePrompt', │ │ │ │ │ + 'SshPasswordPrompt', │ │ │ │ │ + 'SshUnknownHostKeyError', │ │ │ │ │ + 'SubprocessError', │ │ │ │ │ + 'temporary_askpass', │ │ │ │ │ + 'write_askpass_to_tmpdir', │ │ │ │ │ +] │ │ │ │ │ │ │ │ │ │ - try: │ │ │ │ │ - method = self._find_member(interface, 'methods', name) │ │ │ │ │ - assert isinstance(method, Interface.Method) │ │ │ │ │ - return method._invoke(self, message) │ │ │ │ │ - except Object.Method.Unhandled: │ │ │ │ │ - return False │ │ │ │ │ +__version__ = '0' │ │ │ │ │ ''', │ │ │ │ │ - 'cockpit/_vendor/systemd_ctypes/event.py': br'''# systemd_ctypes │ │ │ │ │ + 'cockpit/_vendor/ferny/transport.py': br'''# ferny - asyncio SSH client library, using ssh(1) │ │ │ │ │ # │ │ │ │ │ -# Copyright (C) 2022 Allison Karlitskaya │ │ │ │ │ +# Copyright (C) 2023 Allison Karlitskaya │ │ │ │ │ # │ │ │ │ │ # This program is free software: you can redistribute it and/or modify │ │ │ │ │ # it under the terms of the GNU General Public License as published by │ │ │ │ │ # the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ # (at your option) any later version. │ │ │ │ │ # │ │ │ │ │ # This program is distributed in the hope that it will be useful, │ │ │ │ │ @@ -6556,136 +6819,399 @@ │ │ │ │ │ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ # GNU General Public License for more details. │ │ │ │ │ # │ │ │ │ │ # You should have received a copy of the GNU General Public License │ │ │ │ │ # along with this program. If not, see . │ │ │ │ │ │ │ │ │ │ import asyncio │ │ │ │ │ -import selectors │ │ │ │ │ -import sys │ │ │ │ │ -from typing import Callable, ClassVar, Coroutine, List, Optional, Tuple │ │ │ │ │ +import contextlib │ │ │ │ │ +import logging │ │ │ │ │ +import typing │ │ │ │ │ +from typing import Any, Callable, Iterable, Sequence, TypeVar │ │ │ │ │ │ │ │ │ │ -from . import inotify, libsystemd │ │ │ │ │ -from .librarywrapper import Reference, UserData, byref │ │ │ │ │ +from .interaction_agent import InteractionAgent, InteractionHandler, get_running_loop │ │ │ │ │ +from .ssh_errors import get_exception_for_ssh_stderr │ │ │ │ │ │ │ │ │ │ +logger = logging.getLogger(__name__) │ │ │ │ │ │ │ │ │ │ -class Event(libsystemd.sd_event): │ │ │ │ │ - class Source(libsystemd.sd_event_source): │ │ │ │ │ - def cancel(self) -> None: │ │ │ │ │ - self._unref() │ │ │ │ │ - self.value = None │ │ │ │ │ +P = TypeVar('P', bound=asyncio.Protocol) │ │ │ │ │ │ │ │ │ │ - _default_instance: ClassVar[Optional['Event']] = None │ │ │ │ │ │ │ │ │ │ - @staticmethod │ │ │ │ │ - def default() -> 'Event': │ │ │ │ │ - if Event._default_instance is None: │ │ │ │ │ - Event._default_instance = Event() │ │ │ │ │ - Event._default(byref(Event._default_instance)) │ │ │ │ │ - return Event._default_instance │ │ │ │ │ +class SubprocessError(Exception): │ │ │ │ │ + returncode: int │ │ │ │ │ + stderr: str │ │ │ │ │ │ │ │ │ │ - InotifyHandler = Callable[[inotify.Event, int, Optional[bytes]], None] │ │ │ │ │ + def __init__(self, returncode: int, stderr: str) -> None: │ │ │ │ │ + super().__init__(returncode, stderr) │ │ │ │ │ + self.returncode = returncode │ │ │ │ │ + self.stderr = stderr │ │ │ │ │ │ │ │ │ │ - class InotifySource(Source): │ │ │ │ │ - def __init__(self, handler: 'Event.InotifyHandler') -> None: │ │ │ │ │ - def callback(source: libsystemd.sd_event_source, │ │ │ │ │ - _event: Reference[inotify.inotify_event], │ │ │ │ │ - userdata: UserData) -> int: │ │ │ │ │ - event = _event.contents │ │ │ │ │ - handler(inotify.Event(event.mask), event.cookie, event.name) │ │ │ │ │ - return 0 │ │ │ │ │ - self.trampoline = libsystemd.sd_event_inotify_handler_t(callback) │ │ │ │ │ │ │ │ │ │ - def add_inotify(self, path: str, mask: inotify.Event, handler: InotifyHandler) -> InotifySource: │ │ │ │ │ - source = Event.InotifySource(handler) │ │ │ │ │ - self._add_inotify(byref(source), path, mask, source.trampoline, source.userdata) │ │ │ │ │ - return source │ │ │ │ │ +class FernyTransport(asyncio.Transport, asyncio.SubprocessProtocol): │ │ │ │ │ + _agent: InteractionAgent │ │ │ │ │ + _exec_task: 'asyncio.Task[tuple[asyncio.SubprocessTransport, FernyTransport]]' │ │ │ │ │ + _is_ssh: bool │ │ │ │ │ + _protocol: asyncio.Protocol │ │ │ │ │ + _protocol_disconnected: bool = False │ │ │ │ │ │ │ │ │ │ - def add_inotify_fd(self, fd: int, mask: inotify.Event, handler: InotifyHandler) -> InotifySource: │ │ │ │ │ - # HACK: sd_event_add_inotify_fd() got added in 250, which is too new. Fake it. │ │ │ │ │ - return self.add_inotify(f'/proc/self/fd/{fd}', mask, handler) │ │ │ │ │ + # These get initialized in connection_made() and once set, never get unset. │ │ │ │ │ + _subprocess_transport: 'asyncio.SubprocessTransport | None' = None │ │ │ │ │ + _stdin_transport: 'asyncio.WriteTransport | None' = None │ │ │ │ │ + _stdout_transport: 'asyncio.ReadTransport | None' = None │ │ │ │ │ │ │ │ │ │ + # We record events that might build towards a connection termination here │ │ │ │ │ + # and consider them from _consider_disconnect() in order to try to get the │ │ │ │ │ + # best possible Exception for the protocol, rather than just taking the │ │ │ │ │ + # first one (which is likely to be somewhat random). │ │ │ │ │ + _exception: 'Exception | None' = None │ │ │ │ │ + _stderr_output: 'str | None' = None │ │ │ │ │ + _returncode: 'int | None' = None │ │ │ │ │ + _transport_disconnected: bool = False │ │ │ │ │ + _closed: bool = False │ │ │ │ │ │ │ │ │ │ -# This is all a bit more awkward than it should have to be: systemd's event │ │ │ │ │ -# loop chaining model is designed for glib's prepare/check/dispatch paradigm; │ │ │ │ │ -# failing to call prepare() can lead to deadlocks, for example. │ │ │ │ │ -# │ │ │ │ │ -# Hack a selector subclass which calls prepare() before sleeping and this for us. │ │ │ │ │ -class Selector(selectors.DefaultSelector): │ │ │ │ │ - def __init__(self, event: Optional[Event] = None) -> None: │ │ │ │ │ - super().__init__() │ │ │ │ │ - self.sd_event = event or Event.default() │ │ │ │ │ - self.key = self.register(self.sd_event.get_fd(), selectors.EVENT_READ) │ │ │ │ │ + @classmethod │ │ │ │ │ + def spawn( │ │ │ │ │ + cls: 'type[typing.Self]', │ │ │ │ │ + protocol_factory: Callable[[], P], │ │ │ │ │ + args: Sequence[str], │ │ │ │ │ + loop: 'asyncio.AbstractEventLoop | None' = None, │ │ │ │ │ + interaction_handlers: Sequence[InteractionHandler] = (), │ │ │ │ │ + is_ssh: bool = True, │ │ │ │ │ + **kwargs: Any │ │ │ │ │ + ) -> 'tuple[typing.Self, P]': │ │ │ │ │ + """Connects a FernyTransport to a protocol, using the given command. │ │ │ │ │ │ │ │ │ │ - def select( │ │ │ │ │ - self, timeout: Optional[float] = None │ │ │ │ │ - ) -> List[Tuple[selectors.SelectorKey, int]]: │ │ │ │ │ - # It's common to drop the last reference to a Source or Slot object on │ │ │ │ │ - # a dispatch of that same source/slot from the main loop. If we happen │ │ │ │ │ - # to garbage collect before returning, the trampoline could be │ │ │ │ │ - # destroyed before we're done using it. Provide a mechanism to defer │ │ │ │ │ - # the destruction of trampolines for as long as we might be │ │ │ │ │ - # dispatching. This gets cleared again at the bottom, before return. │ │ │ │ │ - libsystemd.Trampoline.deferred = [] │ │ │ │ │ + This spawns an external command and connects the stdin and stdout of │ │ │ │ │ + the command to the protocol returned by the factory. │ │ │ │ │ │ │ │ │ │ - while self.sd_event.prepare(): │ │ │ │ │ - self.sd_event.dispatch() │ │ │ │ │ - ready = super().select(timeout) │ │ │ │ │ - # workaround https://github.com/systemd/systemd/issues/23826 │ │ │ │ │ - # keep calling wait() until there's nothing left │ │ │ │ │ - while self.sd_event.wait(0): │ │ │ │ │ - self.sd_event.dispatch() │ │ │ │ │ - while self.sd_event.prepare(): │ │ │ │ │ - self.sd_event.dispatch() │ │ │ │ │ + An instance of ferny.InteractionAgent is created and attached to the │ │ │ │ │ + stderr of the spawned process, using the provided handlers. It is the │ │ │ │ │ + responsibility of the caller to ensure that: │ │ │ │ │ + - a `ferny-askpass` client program is installed somewhere; and │ │ │ │ │ + - any relevant command-line arguments or environment variables are │ │ │ │ │ + passed correctly to the program to be spawned │ │ │ │ │ │ │ │ │ │ - # We can be sure we're not dispatching callbacks anymore │ │ │ │ │ - libsystemd.Trampoline.deferred = None │ │ │ │ │ + This function returns immediately and never raises exceptions, assuming │ │ │ │ │ + all preconditions are met. │ │ │ │ │ │ │ │ │ │ - # This could return zero events with infinite timeout, but nobody seems to mind. │ │ │ │ │ - return [(key, events) for (key, events) in ready if key != self.key] │ │ │ │ │ + If spawning the process fails then connection_lost() will be │ │ │ │ │ + called with the relevant OSError, even before connection_made() is │ │ │ │ │ + called. This is somewhat non-standard behaviour, but is the easiest │ │ │ │ │ + way to report these errors without making this function async. │ │ │ │ │ │ │ │ │ │ + Once the process is successfully executed, connection_made() will be │ │ │ │ │ + called and the transport can be used as normal. connection_lost() will │ │ │ │ │ + be called if the process exits or another error occurs. │ │ │ │ │ │ │ │ │ │ -class EventLoopPolicy(asyncio.DefaultEventLoopPolicy): │ │ │ │ │ - def new_event_loop(self) -> asyncio.AbstractEventLoop: │ │ │ │ │ - return asyncio.SelectorEventLoop(Selector()) │ │ │ │ │ + The return value of this function is the transport, but it exists in a │ │ │ │ │ + semi-initialized state. You can call .close() on it, but nothing else. │ │ │ │ │ + Once .connection_made() is called, you can call all the other │ │ │ │ │ + functions. │ │ │ │ │ │ │ │ │ │ + After you call this function, `.connection_lost()` will be called on │ │ │ │ │ + your Protocol, exactly once, no matter what. Until that happens, you │ │ │ │ │ + are responsible for holding a reference to the returned transport. │ │ │ │ │ │ │ │ │ │ -def run_async(main: Coroutine[None, None, None], debug: Optional[bool] = None) -> None: │ │ │ │ │ - asyncio.set_event_loop_policy(EventLoopPolicy()) │ │ │ │ │ + :param args: the full argv of the command to spawn │ │ │ │ │ + :param loop: the event loop to use. If none is provided, we use the │ │ │ │ │ + one which is (read: must be) currently running. │ │ │ │ │ + :param interaction_handlers: the handlers passed to the │ │ │ │ │ + InteractionAgent │ │ │ │ │ + :param is_ssh: whether we should attempt to interpret stderr as ssh │ │ │ │ │ + error messages │ │ │ │ │ + :param kwargs: anything else is passed through to `subprocess_exec()` │ │ │ │ │ + :returns: the usual `(Transport, Protocol)` pair │ │ │ │ │ + """ │ │ │ │ │ + logger.debug('spawn(%r, %r, %r)', cls, protocol_factory, args) │ │ │ │ │ │ │ │ │ │ - polyfill = sys.version_info < (3, 7, 0) and not hasattr(asyncio, 'run') │ │ │ │ │ - if polyfill: │ │ │ │ │ - # Polyfills for Python 3.6: │ │ │ │ │ - loop = asyncio.get_event_loop() │ │ │ │ │ + protocol = protocol_factory() │ │ │ │ │ + self = cls(protocol) │ │ │ │ │ + self._is_ssh = is_ssh │ │ │ │ │ │ │ │ │ │ - assert not hasattr(asyncio, 'get_running_loop') │ │ │ │ │ - asyncio.get_running_loop = lambda: loop │ │ │ │ │ + if loop is None: │ │ │ │ │ + loop = get_running_loop() │ │ │ │ │ │ │ │ │ │ - assert not hasattr(asyncio, 'create_task') │ │ │ │ │ - asyncio.create_task = loop.create_task │ │ │ │ │ + self._agent = InteractionAgent(interaction_handlers, loop, self._interaction_completed) │ │ │ │ │ + kwargs.setdefault('stderr', self._agent.fileno()) │ │ │ │ │ │ │ │ │ │ - assert not hasattr(asyncio, 'run') │ │ │ │ │ + # As of Python 3.12 this isn't really asynchronous (since it uses the │ │ │ │ │ + # subprocess module, which blocks while waiting for the exec() to │ │ │ │ │ + # complete in the child), but we have to deal with the complication of │ │ │ │ │ + # the async interface anyway. Since we, ourselves, want to export a │ │ │ │ │ + # non-async interface, that means that we need a task here and a │ │ │ │ │ + # bottom-half handler below. │ │ │ │ │ + self._exec_task = loop.create_task(loop.subprocess_exec(lambda: self, *args, **kwargs)) │ │ │ │ │ │ │ │ │ │ - def run( │ │ │ │ │ - main: Coroutine[None, None, None], debug: Optional[bool] = None │ │ │ │ │ - ) -> None: │ │ │ │ │ - if debug is not None: │ │ │ │ │ - loop.set_debug(debug) │ │ │ │ │ - loop.run_until_complete(main) │ │ │ │ │ + def exec_completed(task: asyncio.Task) -> None: │ │ │ │ │ + logger.debug('exec_completed(%r, %r)', self, task) │ │ │ │ │ + assert task is self._exec_task │ │ │ │ │ + try: │ │ │ │ │ + transport, me = task.result() │ │ │ │ │ + assert me is self │ │ │ │ │ + logger.debug(' success.') │ │ │ │ │ + except asyncio.CancelledError: │ │ │ │ │ + return # in that case, do nothing │ │ │ │ │ + except OSError as exc: │ │ │ │ │ + logger.debug(' OSError %r', exc) │ │ │ │ │ + self.close(exc) │ │ │ │ │ + return │ │ │ │ │ │ │ │ │ │ - asyncio.run = run # type: ignore[assignment] │ │ │ │ │ + # Our own .connection_made() handler should have gotten called by │ │ │ │ │ + # now. Make sure everything got filled in properly. │ │ │ │ │ + assert self._subprocess_transport is transport │ │ │ │ │ + assert self._stdin_transport is not None │ │ │ │ │ + assert self._stdout_transport is not None │ │ │ │ │ │ │ │ │ │ - asyncio._systemd_ctypes_polyfills = True # type: ignore[attr-defined] │ │ │ │ │ + # Ask the InteractionAgent to start processing stderr. │ │ │ │ │ + self._agent.start() │ │ │ │ │ │ │ │ │ │ - asyncio.run(main, debug=debug) │ │ │ │ │ + self._exec_task.add_done_callback(exec_completed) │ │ │ │ │ │ │ │ │ │ - if polyfill: │ │ │ │ │ - del asyncio.create_task, asyncio.get_running_loop, asyncio.run │ │ │ │ │ + return self, protocol │ │ │ │ │ + │ │ │ │ │ + def __init__(self, protocol: asyncio.Protocol) -> None: │ │ │ │ │ + self._protocol = protocol │ │ │ │ │ + │ │ │ │ │ + def _consider_disconnect(self) -> None: │ │ │ │ │ + logger.debug('_consider_disconnect(%r)', self) │ │ │ │ │ + # We cannot disconnect as long as any of these three things are happening │ │ │ │ │ + if not self._exec_task.done(): │ │ │ │ │ + logger.debug(' exec_task still running %r', self._exec_task) │ │ │ │ │ + return │ │ │ │ │ + │ │ │ │ │ + if self._subprocess_transport is not None and not self._transport_disconnected: │ │ │ │ │ + logger.debug(' transport still connected %r', self._subprocess_transport) │ │ │ │ │ + return │ │ │ │ │ + │ │ │ │ │ + if self._stderr_output is None: │ │ │ │ │ + logger.debug(' agent still running') │ │ │ │ │ + return │ │ │ │ │ + │ │ │ │ │ + # All conditions for disconnection are satisfied. │ │ │ │ │ + if self._protocol_disconnected: │ │ │ │ │ + logger.debug(' already disconnected') │ │ │ │ │ + return │ │ │ │ │ + self._protocol_disconnected = True │ │ │ │ │ + │ │ │ │ │ + # Now we just need to determine what we report to the protocol... │ │ │ │ │ + if self._exception is not None: │ │ │ │ │ + # If we got an exception reported, that's our reason for closing. │ │ │ │ │ + logger.debug(' disconnect with exception %r', self._exception) │ │ │ │ │ + self._protocol.connection_lost(self._exception) │ │ │ │ │ + elif self._returncode == 0 or self._closed: │ │ │ │ │ + # If we called close() or have a zero return status, that's a clean │ │ │ │ │ + # exit, regardless of noise that might have landed in stderr. │ │ │ │ │ + logger.debug(' clean disconnect') │ │ │ │ │ + self._protocol.connection_lost(None) │ │ │ │ │ + elif self._is_ssh and self._returncode == 255: │ │ │ │ │ + # This is an error code due to an SSH failure. Try to interpret it. │ │ │ │ │ + logger.debug(' disconnect with ssh error %r', self._stderr_output) │ │ │ │ │ + self._protocol.connection_lost(get_exception_for_ssh_stderr(self._stderr_output)) │ │ │ │ │ + else: │ │ │ │ │ + # Otherwise, report the stderr text and return code. │ │ │ │ │ + logger.debug(' disconnect with exit code %r, stderr %r', self._returncode, self._stderr_output) │ │ │ │ │ + # We surely have _returncode set here, since otherwise: │ │ │ │ │ + # - exec_task failed with an exception (which we handle above); or │ │ │ │ │ + # - we're still connected... │ │ │ │ │ + assert self._returncode is not None │ │ │ │ │ + self._protocol.connection_lost(SubprocessError(self._returncode, self._stderr_output)) │ │ │ │ │ + │ │ │ │ │ + def _interaction_completed(self, future: 'asyncio.Future[str]') -> None: │ │ │ │ │ + logger.debug('_interaction_completed(%r, %r)', self, future) │ │ │ │ │ + try: │ │ │ │ │ + self._stderr_output = future.result() │ │ │ │ │ + logger.debug(' stderr: %r', self._stderr_output) │ │ │ │ │ + except Exception as exc: │ │ │ │ │ + logger.debug(' exception: %r', exc) │ │ │ │ │ + self._stderr_output = '' # we need to set this in order to complete │ │ │ │ │ + self.close(exc) │ │ │ │ │ + │ │ │ │ │ + self._consider_disconnect() │ │ │ │ │ + │ │ │ │ │ + # BaseProtocol implementation │ │ │ │ │ + def connection_made(self, transport: asyncio.BaseTransport) -> None: │ │ │ │ │ + logger.debug('connection_made(%r, %r)', self, transport) │ │ │ │ │ + assert isinstance(transport, asyncio.SubprocessTransport) │ │ │ │ │ + self._subprocess_transport = transport │ │ │ │ │ + │ │ │ │ │ + stdin_transport = transport.get_pipe_transport(0) │ │ │ │ │ + assert isinstance(stdin_transport, asyncio.WriteTransport) │ │ │ │ │ + self._stdin_transport = stdin_transport │ │ │ │ │ + │ │ │ │ │ + stdout_transport = transport.get_pipe_transport(1) │ │ │ │ │ + assert isinstance(stdout_transport, asyncio.ReadTransport) │ │ │ │ │ + self._stdout_transport = stdout_transport │ │ │ │ │ + │ │ │ │ │ + stderr_transport = transport.get_pipe_transport(2) │ │ │ │ │ + assert stderr_transport is None │ │ │ │ │ + │ │ │ │ │ + logger.debug('calling connection_made(%r, %r)', self, self._protocol) │ │ │ │ │ + self._protocol.connection_made(self) │ │ │ │ │ + │ │ │ │ │ + def connection_lost(self, exc: 'Exception | None') -> None: │ │ │ │ │ + logger.debug('connection_lost(%r, %r)', self, exc) │ │ │ │ │ + if self._exception is None: │ │ │ │ │ + self._exception = exc │ │ │ │ │ + self._transport_disconnected = True │ │ │ │ │ + self._consider_disconnect() │ │ │ │ │ + │ │ │ │ │ + # SubprocessProtocol implementation │ │ │ │ │ + def pipe_data_received(self, fd: int, data: bytes) -> None: │ │ │ │ │ + logger.debug('pipe_data_received(%r, %r, %r)', self, fd, len(data)) │ │ │ │ │ + assert fd == 1 # stderr is handled separately │ │ │ │ │ + self._protocol.data_received(data) │ │ │ │ │ + │ │ │ │ │ + def pipe_connection_lost(self, fd: int, exc: 'Exception | None') -> None: │ │ │ │ │ + logger.debug('pipe_connection_lost(%r, %r, %r)', self, fd, exc) │ │ │ │ │ + assert fd in (0, 1) # stderr is handled separately │ │ │ │ │ + │ │ │ │ │ + # We treat this as a clean close │ │ │ │ │ + if isinstance(exc, BrokenPipeError): │ │ │ │ │ + exc = None │ │ │ │ │ + │ │ │ │ │ + # Record serious errors to propagate them to the protocol │ │ │ │ │ + # If this is a clean exit on stdout, report an EOF │ │ │ │ │ + if exc is not None: │ │ │ │ │ + self.close(exc) │ │ │ │ │ + elif fd == 1 and not self._closed: │ │ │ │ │ + if not self._protocol.eof_received(): │ │ │ │ │ + self.close() │ │ │ │ │ + │ │ │ │ │ + def process_exited(self) -> None: │ │ │ │ │ + logger.debug('process_exited(%r)', self) │ │ │ │ │ + assert self._subprocess_transport is not None │ │ │ │ │ + self._returncode = self._subprocess_transport.get_returncode() │ │ │ │ │ + logger.debug(' ._returncode = %r', self._returncode) │ │ │ │ │ + self._agent.force_completion() │ │ │ │ │ + │ │ │ │ │ + def pause_writing(self) -> None: │ │ │ │ │ + logger.debug('pause_writing(%r)', self) │ │ │ │ │ + self._protocol.pause_writing() │ │ │ │ │ + │ │ │ │ │ + def resume_writing(self) -> None: │ │ │ │ │ + logger.debug('resume_writing(%r)', self) │ │ │ │ │ + self._protocol.resume_writing() │ │ │ │ │ + │ │ │ │ │ + # Transport implementation. Most of this is straight delegation. │ │ │ │ │ + def close(self, exc: 'Exception | None' = None) -> None: │ │ │ │ │ + logger.debug('close(%r, %r)', self, exc) │ │ │ │ │ + self._closed = True │ │ │ │ │ + if self._exception is None: │ │ │ │ │ + logger.debug(' setting exception %r', exc) │ │ │ │ │ + self._exception = exc │ │ │ │ │ + if not self._exec_task.done(): │ │ │ │ │ + logger.debug(' cancelling _exec_task') │ │ │ │ │ + self._exec_task.cancel() │ │ │ │ │ + if self._subprocess_transport is not None: │ │ │ │ │ + logger.debug(' closing _subprocess_transport') │ │ │ │ │ + # https://github.com/python/cpython/issues/112800 │ │ │ │ │ + with contextlib.suppress(PermissionError): │ │ │ │ │ + self._subprocess_transport.close() │ │ │ │ │ + self._agent.force_completion() │ │ │ │ │ + │ │ │ │ │ + def is_closing(self) -> bool: │ │ │ │ │ + assert self._subprocess_transport is not None │ │ │ │ │ + return self._subprocess_transport.is_closing() │ │ │ │ │ + │ │ │ │ │ + def get_extra_info(self, name: str, default: object = None) -> object: │ │ │ │ │ + assert self._subprocess_transport is not None │ │ │ │ │ + return self._subprocess_transport.get_extra_info(name, default) │ │ │ │ │ + │ │ │ │ │ + def set_protocol(self, protocol: asyncio.BaseProtocol) -> None: │ │ │ │ │ + assert isinstance(protocol, asyncio.Protocol) │ │ │ │ │ + self._protocol = protocol │ │ │ │ │ + │ │ │ │ │ + def get_protocol(self) -> asyncio.Protocol: │ │ │ │ │ + return self._protocol │ │ │ │ │ + │ │ │ │ │ + def is_reading(self) -> bool: │ │ │ │ │ + assert self._stdout_transport is not None │ │ │ │ │ + try: │ │ │ │ │ + return self._stdout_transport.is_reading() │ │ │ │ │ + except NotImplementedError: │ │ │ │ │ + # This is (incorrectly) unimplemented before Python 3.11 │ │ │ │ │ + return not self._stdout_transport._paused # type:ignore[attr-defined] │ │ │ │ │ + except AttributeError: │ │ │ │ │ + # ...and in Python 3.6 it's even worse │ │ │ │ │ + try: │ │ │ │ │ + selector = self._stdout_transport._loop._selector # type:ignore[attr-defined] │ │ │ │ │ + selector.get_key(self._stdout_transport._fileno) # type:ignore[attr-defined] │ │ │ │ │ + return True │ │ │ │ │ + except KeyError: │ │ │ │ │ + return False │ │ │ │ │ + │ │ │ │ │ + def pause_reading(self) -> None: │ │ │ │ │ + assert self._stdout_transport is not None │ │ │ │ │ + self._stdout_transport.pause_reading() │ │ │ │ │ + │ │ │ │ │ + def resume_reading(self) -> None: │ │ │ │ │ + assert self._stdout_transport is not None │ │ │ │ │ + self._stdout_transport.resume_reading() │ │ │ │ │ + │ │ │ │ │ + def abort(self) -> None: │ │ │ │ │ + assert self._stdin_transport is not None │ │ │ │ │ + assert self._subprocess_transport is not None │ │ │ │ │ + self._stdin_transport.abort() │ │ │ │ │ + self._subprocess_transport.kill() │ │ │ │ │ + │ │ │ │ │ + def can_write_eof(self) -> bool: │ │ │ │ │ + assert self._stdin_transport is not None │ │ │ │ │ + return self._stdin_transport.can_write_eof() # will always be True │ │ │ │ │ + │ │ │ │ │ + def get_write_buffer_size(self) -> int: │ │ │ │ │ + assert self._stdin_transport is not None │ │ │ │ │ + return self._stdin_transport.get_write_buffer_size() │ │ │ │ │ + │ │ │ │ │ + def get_write_buffer_limits(self) -> 'tuple[int, int]': │ │ │ │ │ + assert self._stdin_transport is not None │ │ │ │ │ + return self._stdin_transport.get_write_buffer_limits() │ │ │ │ │ + │ │ │ │ │ + def set_write_buffer_limits(self, high: 'int | None' = None, low: 'int | None' = None) -> None: │ │ │ │ │ + assert self._stdin_transport is not None │ │ │ │ │ + return self._stdin_transport.set_write_buffer_limits(high, low) │ │ │ │ │ + │ │ │ │ │ + def write(self, data: bytes) -> None: │ │ │ │ │ + assert self._stdin_transport is not None │ │ │ │ │ + return self._stdin_transport.write(data) │ │ │ │ │ + │ │ │ │ │ + def writelines(self, list_of_data: Iterable[bytes]) -> None: │ │ │ │ │ + assert self._stdin_transport is not None │ │ │ │ │ + return self._stdin_transport.writelines(list_of_data) │ │ │ │ │ + │ │ │ │ │ + def write_eof(self) -> None: │ │ │ │ │ + assert self._stdin_transport is not None │ │ │ │ │ + return self._stdin_transport.write_eof() │ │ │ │ │ + │ │ │ │ │ + # We don't really implement SubprocessTransport, but provide these as │ │ │ │ │ + # "extras" to our user. │ │ │ │ │ + def get_pid(self) -> int: │ │ │ │ │ + assert self._subprocess_transport is not None │ │ │ │ │ + return self._subprocess_transport.get_pid() │ │ │ │ │ + │ │ │ │ │ + def get_returncode(self) -> 'int | None': │ │ │ │ │ + return self._returncode │ │ │ │ │ + │ │ │ │ │ + def kill(self) -> None: │ │ │ │ │ + assert self._subprocess_transport is not None │ │ │ │ │ + self._subprocess_transport.kill() │ │ │ │ │ + │ │ │ │ │ + def send_signal(self, number: int) -> None: │ │ │ │ │ + assert self._subprocess_transport is not None │ │ │ │ │ + self._subprocess_transport.send_signal(number) │ │ │ │ │ + │ │ │ │ │ + def terminate(self) -> None: │ │ │ │ │ + assert self._subprocess_transport is not None │ │ │ │ │ + self._subprocess_transport.terminate() │ │ │ │ │ ''', │ │ │ │ │ - 'cockpit/_vendor/systemd_ctypes/pathwatch.py': br'''# systemd_ctypes │ │ │ │ │ + 'cockpit/_vendor/ferny/askpass.py': br'''from .interaction_client import main │ │ │ │ │ + │ │ │ │ │ +if __name__ == '__main__': │ │ │ │ │ + main() │ │ │ │ │ +''', │ │ │ │ │ + 'cockpit/_vendor/ferny/session.py': r'''# ferny - asyncio SSH client library, using ssh(1) │ │ │ │ │ # │ │ │ │ │ # Copyright (C) 2022 Allison Karlitskaya │ │ │ │ │ # │ │ │ │ │ # This program is free software: you can redistribute it and/or modify │ │ │ │ │ # it under the terms of the GNU General Public License as published by │ │ │ │ │ # the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ # (at your option) any later version. │ │ │ │ │ @@ -6694,280 +7220,947 @@ │ │ │ │ │ # but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ # GNU General Public License for more details. │ │ │ │ │ # │ │ │ │ │ # You should have received a copy of the GNU General Public License │ │ │ │ │ # along with this program. If not, see . │ │ │ │ │ │ │ │ │ │ -import errno │ │ │ │ │ +import asyncio │ │ │ │ │ +import ctypes │ │ │ │ │ +import functools │ │ │ │ │ import logging │ │ │ │ │ import os │ │ │ │ │ -import stat │ │ │ │ │ -from typing import Any, List, Optional │ │ │ │ │ +import shlex │ │ │ │ │ +import signal │ │ │ │ │ +import subprocess │ │ │ │ │ +import tempfile │ │ │ │ │ +from typing import Mapping, Sequence │ │ │ │ │ │ │ │ │ │ -from .event import Event │ │ │ │ │ -from .inotify import Event as IN │ │ │ │ │ +from . import ssh_errors │ │ │ │ │ +from .interaction_agent import InteractionAgent, InteractionError, InteractionHandler, write_askpass_to_tmpdir │ │ │ │ │ │ │ │ │ │ +prctl = ctypes.cdll.LoadLibrary('libc.so.6').prctl │ │ │ │ │ logger = logging.getLogger(__name__) │ │ │ │ │ +PR_SET_PDEATHSIG = 1 │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ -# inotify hard facts: │ │ │ │ │ -# │ │ │ │ │ -# DELETE_SELF doesn't get called until all references to an inode are gone │ │ │ │ │ -# - including open fds │ │ │ │ │ -# - including on directories │ │ │ │ │ +@functools.lru_cache() │ │ │ │ │ +def has_feature(feature: str, teststr: str = 'x') -> bool: │ │ │ │ │ + try: │ │ │ │ │ + subprocess.check_output(['ssh', f'-o{feature} {teststr}', '-G', 'nonexisting'], stderr=subprocess.DEVNULL) │ │ │ │ │ + return True │ │ │ │ │ + except subprocess.CalledProcessError: │ │ │ │ │ + return False │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class SubprocessContext: │ │ │ │ │ + def wrap_subprocess_args(self, args: Sequence[str]) -> Sequence[str]: │ │ │ │ │ + """Return the args required to launch a process in the given context. │ │ │ │ │ + │ │ │ │ │ + For example, this might return a vector with │ │ │ │ │ + ["sudo"] │ │ │ │ │ + or │ │ │ │ │ + ["flatpak-spawn", "--host"] │ │ │ │ │ + prepended. │ │ │ │ │ + │ │ │ │ │ + It is also possible that more substantial changes may be performed. │ │ │ │ │ + │ │ │ │ │ + This function is not permitted to modify its argument, although it may │ │ │ │ │ + (optionally) return it unmodified, if no changes are required. │ │ │ │ │ + """ │ │ │ │ │ + return args │ │ │ │ │ + │ │ │ │ │ + def wrap_subprocess_env(self, env: Mapping[str, str]) -> Mapping[str, str]: │ │ │ │ │ + """Return the envp required to launch a process in the given context. │ │ │ │ │ + │ │ │ │ │ + For example, this might set the "SUDO_ASKPASS" environment variable, if │ │ │ │ │ + needed. │ │ │ │ │ + │ │ │ │ │ + As with wrap_subprocess_args(), this function is not permitted to │ │ │ │ │ + modify its argument, although it may (optionally) return it unmodified │ │ │ │ │ + if no changes are required. │ │ │ │ │ + """ │ │ │ │ │ + return env │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class Session(SubprocessContext, InteractionHandler): │ │ │ │ │ + # Set after .connect() called, even if failed │ │ │ │ │ + _controldir: 'tempfile.TemporaryDirectory | None' = None │ │ │ │ │ + _controlsock: 'str | None' = None │ │ │ │ │ + │ │ │ │ │ + # Set if connected, else None │ │ │ │ │ + _process: 'asyncio.subprocess.Process | None' = None │ │ │ │ │ + │ │ │ │ │ + async def connect(self, │ │ │ │ │ + destination: str, │ │ │ │ │ + handle_host_key: bool = False, │ │ │ │ │ + configfile: 'str | None' = None, │ │ │ │ │ + identity_file: 'str | None' = None, │ │ │ │ │ + login_name: 'str | None' = None, │ │ │ │ │ + options: 'Mapping[str, str] | None' = None, │ │ │ │ │ + pkcs11: 'str | None' = None, │ │ │ │ │ + port: 'int | None' = None, │ │ │ │ │ + interaction_responder: 'InteractionHandler | None' = None) -> None: │ │ │ │ │ + rundir = os.path.join(os.environ.get('XDG_RUNTIME_DIR', '/run'), 'ferny') │ │ │ │ │ + os.makedirs(rundir, exist_ok=True) │ │ │ │ │ + self._controldir = tempfile.TemporaryDirectory(dir=rundir) │ │ │ │ │ + self._controlsock = f'{self._controldir.name}/socket' │ │ │ │ │ + │ │ │ │ │ + # In general, we can't guarantee an accessible and executable version │ │ │ │ │ + # of this file, but since it's small and we're making a temporary │ │ │ │ │ + # directory anyway, let's just copy it into place and use it from │ │ │ │ │ + # there. │ │ │ │ │ + askpass_path = write_askpass_to_tmpdir(self._controldir.name) │ │ │ │ │ + │ │ │ │ │ + env = dict(os.environ) │ │ │ │ │ + env['SSH_ASKPASS'] = askpass_path │ │ │ │ │ + env['SSH_ASKPASS_REQUIRE'] = 'force' │ │ │ │ │ + # old SSH doesn't understand SSH_ASKPASS_REQUIRE and guesses based on DISPLAY instead │ │ │ │ │ + env['DISPLAY'] = '-' │ │ │ │ │ + │ │ │ │ │ + args = [ │ │ │ │ │ + '-M', │ │ │ │ │ + '-N', │ │ │ │ │ + '-S', self._controlsock, │ │ │ │ │ + '-o', 'PermitLocalCommand=yes', │ │ │ │ │ + '-o', f'LocalCommand={askpass_path}', │ │ │ │ │ + ] │ │ │ │ │ + │ │ │ │ │ + if configfile is not None: │ │ │ │ │ + args.append(f'-F{configfile}') │ │ │ │ │ + │ │ │ │ │ + if identity_file is not None: │ │ │ │ │ + args.append(f'-i{identity_file}') │ │ │ │ │ + │ │ │ │ │ + if options is not None: │ │ │ │ │ + for key in options: # Note: Mapping may not have .items() │ │ │ │ │ + args.append(f'-o{key} {options[key]}') │ │ │ │ │ + │ │ │ │ │ + if pkcs11 is not None: │ │ │ │ │ + args.append(f'-I{pkcs11}') │ │ │ │ │ + │ │ │ │ │ + if port is not None: │ │ │ │ │ + args.append(f'-p{port}') │ │ │ │ │ + │ │ │ │ │ + if login_name is not None: │ │ │ │ │ + args.append(f'-l{login_name}') │ │ │ │ │ + │ │ │ │ │ + if handle_host_key and has_feature('KnownHostsCommand'): │ │ │ │ │ + args.extend([ │ │ │ │ │ + '-o', f'KnownHostsCommand={askpass_path} %I %H %t %K %f', │ │ │ │ │ + '-o', 'StrictHostKeyChecking=yes', │ │ │ │ │ + ]) │ │ │ │ │ + │ │ │ │ │ + agent = InteractionAgent([interaction_responder] if interaction_responder is not None else []) │ │ │ │ │ + │ │ │ │ │ + # SSH_ASKPASS_REQUIRE is not generally available, so use setsid │ │ │ │ │ + process = await asyncio.create_subprocess_exec( │ │ │ │ │ + *('/usr/bin/ssh', *args, destination), env=env, │ │ │ │ │ + start_new_session=True, stdin=asyncio.subprocess.DEVNULL, │ │ │ │ │ + stdout=asyncio.subprocess.DEVNULL, stderr=agent, # type: ignore │ │ │ │ │ + preexec_fn=lambda: prctl(PR_SET_PDEATHSIG, signal.SIGKILL)) │ │ │ │ │ + │ │ │ │ │ + # This is tricky: we need to clean up the subprocess, but only in case │ │ │ │ │ + # if failure. Otherwise, we keep it around. │ │ │ │ │ + try: │ │ │ │ │ + await agent.communicate() │ │ │ │ │ + assert os.path.exists(self._controlsock) │ │ │ │ │ + self._process = process │ │ │ │ │ + except InteractionError as exc: │ │ │ │ │ + await process.wait() │ │ │ │ │ + raise ssh_errors.get_exception_for_ssh_stderr(str(exc)) from None │ │ │ │ │ + except BaseException: │ │ │ │ │ + # If we get here because the InteractionHandler raised an │ │ │ │ │ + # exception then SSH might still be running, and may even attempt │ │ │ │ │ + # further interactions (ie: 2nd attempt for password). We already │ │ │ │ │ + # have our exception and don't need any more info. Kill it. │ │ │ │ │ + try: │ │ │ │ │ + process.kill() │ │ │ │ │ + except ProcessLookupError: │ │ │ │ │ + pass # already exited? good. │ │ │ │ │ + await process.wait() │ │ │ │ │ + raise │ │ │ │ │ + │ │ │ │ │ + def is_connected(self) -> bool: │ │ │ │ │ + return self._process is not None │ │ │ │ │ + │ │ │ │ │ + async def wait(self) -> None: │ │ │ │ │ + assert self._process is not None │ │ │ │ │ + await self._process.wait() │ │ │ │ │ + │ │ │ │ │ + def exit(self) -> None: │ │ │ │ │ + assert self._process is not None │ │ │ │ │ + self._process.terminate() │ │ │ │ │ + │ │ │ │ │ + async def disconnect(self) -> None: │ │ │ │ │ + self.exit() │ │ │ │ │ + await self.wait() │ │ │ │ │ + │ │ │ │ │ + # Launching of processes │ │ │ │ │ + def wrap_subprocess_args(self, args: Sequence[str]) -> Sequence[str]: │ │ │ │ │ + assert self._controlsock is not None │ │ │ │ │ + # 1. We specify the hostname as the empty string: it will be ignored │ │ │ │ │ + # when ssh is trying to use the control socket, but in case the │ │ │ │ │ + # socket has stopped working, ssh will try to fall back to directly │ │ │ │ │ + # connecting, in which case an empty hostname will prevent that. │ │ │ │ │ + # 2. We need to quote the arguments — ssh will paste them together │ │ │ │ │ + # using only spaces, executing the result using the user's shell. │ │ │ │ │ + return ('ssh', '-S', self._controlsock, '', *map(shlex.quote, args)) │ │ │ │ │ +'''.encode('utf-8'), │ │ │ │ │ + 'cockpit/_vendor/ferny/ssh_errors.py': br'''# ferny - asyncio SSH client library, using ssh(1) │ │ │ │ │ # │ │ │ │ │ -# ATTRIB gets called when unlinking files (because the link count changes) but │ │ │ │ │ -# not on directories. When unlinking an open directory, no events at all │ │ │ │ │ -# happen on the directory. ATTRIB also collects child events, which means we │ │ │ │ │ -# get a lot of unwanted noise. │ │ │ │ │ +# Copyright (C) 2023 Allison Karlitskaya │ │ │ │ │ # │ │ │ │ │ -# There's nothing like UNLINK_SELF, unfortunately. │ │ │ │ │ +# This program is free software: you can redistribute it and/or modify │ │ │ │ │ +# it under the terms of the GNU General Public License as published by │ │ │ │ │ +# the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ +# (at your option) any later version. │ │ │ │ │ # │ │ │ │ │ -# Even if it was possible to take this approach, it might not work: after │ │ │ │ │ -# you've opened the fd, it might get deleted before you can establish the watch │ │ │ │ │ -# on it. │ │ │ │ │ +# This program is distributed in the hope that it will be useful, │ │ │ │ │ +# but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ +# GNU General Public License for more details. │ │ │ │ │ # │ │ │ │ │ -# Additionally, systemd makes it impossible to register those events on │ │ │ │ │ -# symlinks (because it removes IN_DONT_FOLLOW in order to watch via │ │ │ │ │ -# /proc/self/fd). │ │ │ │ │ +# You should have received a copy of the GNU General Public License │ │ │ │ │ +# along with this program. If not, see . │ │ │ │ │ + │ │ │ │ │ +import ctypes │ │ │ │ │ +import errno │ │ │ │ │ +import os │ │ │ │ │ +import re │ │ │ │ │ +import socket │ │ │ │ │ +from typing import ClassVar, Iterable, Match, Pattern │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class SshError(Exception): │ │ │ │ │ + PATTERN: ClassVar[Pattern] │ │ │ │ │ + │ │ │ │ │ + def __init__(self, match: 'Match | None', stderr: str) -> None: │ │ │ │ │ + super().__init__(match.group(0) if match is not None else stderr) │ │ │ │ │ + self.stderr = stderr │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class SshAuthenticationError(SshError): │ │ │ │ │ + PATTERN = re.compile(r'^([^:]+): Permission denied \(([^()]+)\)\.$', re.M) │ │ │ │ │ + │ │ │ │ │ + def __init__(self, match: Match, stderr: str) -> None: │ │ │ │ │ + super().__init__(match, stderr) │ │ │ │ │ + self.destination = match.group(1) │ │ │ │ │ + self.methods = match.group(2).split(',') │ │ │ │ │ + self.message = match.group(0) │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +# generic host key error for OSes without KnownHostsCommand support │ │ │ │ │ +class SshHostKeyError(SshError): │ │ │ │ │ + PATTERN = re.compile(r'^Host key verification failed.$', re.M) │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +# specific errors for OSes with KnownHostsCommand │ │ │ │ │ +class SshUnknownHostKeyError(SshHostKeyError): │ │ │ │ │ + PATTERN = re.compile(r'^No .* host key is known.*Host key verification failed.$', re.S | re.M) │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class SshChangedHostKeyError(SshHostKeyError): │ │ │ │ │ + PATTERN = re.compile(r'warning.*remote host identification has changed', re.I) │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +# Functionality for mapping getaddrinfo()-family error messages to their │ │ │ │ │ +# equivalent Python exceptions. │ │ │ │ │ +def make_gaierror_map() -> 'Iterable[tuple[str, int]]': │ │ │ │ │ + libc = ctypes.CDLL(None) │ │ │ │ │ + libc.gai_strerror.restype = ctypes.c_char_p │ │ │ │ │ + │ │ │ │ │ + for key in dir(socket): │ │ │ │ │ + if key.startswith('EAI_'): │ │ │ │ │ + errnum = getattr(socket, key) │ │ │ │ │ + yield libc.gai_strerror(errnum).decode('utf-8'), errnum │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +gaierror_map = dict(make_gaierror_map()) │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +# Functionality for passing strerror() error messages to their equivalent │ │ │ │ │ +# Python exceptions. │ │ │ │ │ +# There doesn't seem to be an official API for turning an errno into the │ │ │ │ │ +# correct subtype of OSError, and the list that cpython uses is hidden fairly │ │ │ │ │ +# deeply inside of the implementation. This is basically copied from the │ │ │ │ │ +# ADD_ERRNO() lines in _PyExc_InitState in cpython/Objects/exceptions.c │ │ │ │ │ +oserror_subclass_map = dict((errnum, cls) for cls, errnum in [ │ │ │ │ │ + (BlockingIOError, errno.EAGAIN), │ │ │ │ │ + (BlockingIOError, errno.EALREADY), │ │ │ │ │ + (BlockingIOError, errno.EINPROGRESS), │ │ │ │ │ + (BlockingIOError, errno.EWOULDBLOCK), │ │ │ │ │ + (BrokenPipeError, errno.EPIPE), │ │ │ │ │ + (BrokenPipeError, errno.ESHUTDOWN), │ │ │ │ │ + (ChildProcessError, errno.ECHILD), │ │ │ │ │ + (ConnectionAbortedError, errno.ECONNABORTED), │ │ │ │ │ + (ConnectionRefusedError, errno.ECONNREFUSED), │ │ │ │ │ + (ConnectionResetError, errno.ECONNRESET), │ │ │ │ │ + (FileExistsError, errno.EEXIST), │ │ │ │ │ + (FileNotFoundError, errno.ENOENT), │ │ │ │ │ + (IsADirectoryError, errno.EISDIR), │ │ │ │ │ + (NotADirectoryError, errno.ENOTDIR), │ │ │ │ │ + (InterruptedError, errno.EINTR), │ │ │ │ │ + (PermissionError, errno.EACCES), │ │ │ │ │ + (PermissionError, errno.EPERM), │ │ │ │ │ + (ProcessLookupError, errno.ESRCH), │ │ │ │ │ + (TimeoutError, errno.ETIMEDOUT), │ │ │ │ │ +]) │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +def get_exception_for_ssh_stderr(stderr: str) -> Exception: │ │ │ │ │ + stderr = stderr.replace('\r\n', '\n') # fix line separators │ │ │ │ │ + │ │ │ │ │ + # check for the specific error messages first, then for generic SshHostKeyError │ │ │ │ │ + for ssh_cls in [SshAuthenticationError, SshChangedHostKeyError, SshUnknownHostKeyError, SshHostKeyError]: │ │ │ │ │ + match = ssh_cls.PATTERN.search(stderr) │ │ │ │ │ + if match is not None: │ │ │ │ │ + return ssh_cls(match, stderr) │ │ │ │ │ + │ │ │ │ │ + before, colon, after = stderr.rpartition(':') │ │ │ │ │ + if colon and after: │ │ │ │ │ + potential_strerror = after.strip() │ │ │ │ │ + │ │ │ │ │ + # DNS lookup errors │ │ │ │ │ + if potential_strerror in gaierror_map: │ │ │ │ │ + errnum = gaierror_map[potential_strerror] │ │ │ │ │ + return socket.gaierror(errnum, stderr) │ │ │ │ │ + │ │ │ │ │ + # Network connect errors │ │ │ │ │ + for errnum in errno.errorcode: │ │ │ │ │ + if os.strerror(errnum) == potential_strerror: │ │ │ │ │ + os_cls = oserror_subclass_map.get(errnum, OSError) │ │ │ │ │ + return os_cls(errnum, stderr) │ │ │ │ │ + │ │ │ │ │ + # No match? Generic. │ │ │ │ │ + return SshError(None, stderr) │ │ │ │ │ +''', │ │ │ │ │ + 'cockpit/_vendor/ferny/interaction_agent.py': r'''# ferny - asyncio SSH client library, using ssh(1) │ │ │ │ │ # │ │ │ │ │ -# For all of these reasons, unfortunately, the best way seems to be to watch │ │ │ │ │ -# for CREATE|DELETE|MOVE events on each intermediate directory. │ │ │ │ │ +# Copyright (C) 2023 Allison Karlitskaya │ │ │ │ │ # │ │ │ │ │ -# Unfortunately there is no way to filter to only the name we're interested in, │ │ │ │ │ -# so we're gonna get a lot of unnecessary wakeups. │ │ │ │ │ +# This program is free software: you can redistribute it and/or modify │ │ │ │ │ +# it under the terms of the GNU General Public License as published by │ │ │ │ │ +# the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ +# (at your option) any later version. │ │ │ │ │ # │ │ │ │ │ -# Also: due to the above-mentioned race about watching after opening the fd, │ │ │ │ │ -# let's just always watch for both create and delete events *before* trying to │ │ │ │ │ -# open the fd. We could try to reduce the mask after the fact, but meh... │ │ │ │ │ +# This program is distributed in the hope that it will be useful, │ │ │ │ │ +# but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ +# GNU General Public License for more details. │ │ │ │ │ # │ │ │ │ │ -# We use a WatchInvalidator utility class to fill the role of "Tell me when an │ │ │ │ │ -# event happened on this (directory) fd which impacted the name file". We │ │ │ │ │ -# build a series of these when setting up a watch in order to find out if any │ │ │ │ │ -# part of the path leading to the monitored file changed. │ │ │ │ │ +# You should have received a copy of the GNU General Public License │ │ │ │ │ +# along with this program. If not, see . │ │ │ │ │ │ │ │ │ │ +import array │ │ │ │ │ +import ast │ │ │ │ │ +import asyncio │ │ │ │ │ +import contextlib │ │ │ │ │ +import logging │ │ │ │ │ +import os │ │ │ │ │ +import re │ │ │ │ │ +import socket │ │ │ │ │ +import tempfile │ │ │ │ │ +from typing import Any, Callable, ClassVar, Generator, Sequence │ │ │ │ │ │ │ │ │ │ -class Handle(int): │ │ │ │ │ - """An integer subclass that makes it easier to work with file descriptors""" │ │ │ │ │ +from . import interaction_client │ │ │ │ │ │ │ │ │ │ - def __new__(cls, fd: int = -1) -> 'Handle': │ │ │ │ │ - return super(Handle, cls).__new__(cls, fd) │ │ │ │ │ +logger = logging.getLogger(__name__) │ │ │ │ │ │ │ │ │ │ - # separate __init__() to set _needs_close mostly to keep pylint quiet │ │ │ │ │ - def __init__(self, fd: int = -1): │ │ │ │ │ - super().__init__() │ │ │ │ │ - self._needs_close = fd != -1 │ │ │ │ │ │ │ │ │ │ - def __bool__(self) -> bool: │ │ │ │ │ - return self != -1 │ │ │ │ │ +COMMAND_RE = re.compile(b'\0ferny\0([^\n]*)\0\0\n') │ │ │ │ │ +COMMAND_TEMPLATE = '\0ferny\0{(command, args)!r}\0\0\n' │ │ │ │ │ │ │ │ │ │ - def close(self) -> None: │ │ │ │ │ - if self._needs_close: │ │ │ │ │ - self._needs_close = False │ │ │ │ │ - os.close(self) │ │ │ │ │ +BEIBOOT_GADGETS = { │ │ │ │ │ + "command": fr""" │ │ │ │ │ + import sys │ │ │ │ │ + def command(command, *args): │ │ │ │ │ + sys.stderr.write(f{COMMAND_TEMPLATE!r}) │ │ │ │ │ + sys.stderr.flush() │ │ │ │ │ + """, │ │ │ │ │ + "end": r""" │ │ │ │ │ + def end(): │ │ │ │ │ + command('ferny.end') │ │ │ │ │ + """, │ │ │ │ │ +} │ │ │ │ │ │ │ │ │ │ - def __eq__(self, value: object) -> bool: │ │ │ │ │ - if int.__eq__(self, value): # also handles both == -1 │ │ │ │ │ - return True │ │ │ │ │ │ │ │ │ │ - if not isinstance(value, int): # other object is not an int │ │ │ │ │ - return False │ │ │ │ │ +class InteractionError(Exception): │ │ │ │ │ + pass │ │ │ │ │ │ │ │ │ │ - if not self or not value: # when only one == -1 │ │ │ │ │ - return False │ │ │ │ │ │ │ │ │ │ - return os.path.sameopenfile(self, value) │ │ │ │ │ +try: │ │ │ │ │ + recv_fds = socket.recv_fds │ │ │ │ │ +except AttributeError: │ │ │ │ │ + # Python < 3.9 │ │ │ │ │ │ │ │ │ │ - def __del__(self) -> None: │ │ │ │ │ - if self._needs_close: │ │ │ │ │ - self.close() │ │ │ │ │ + def recv_fds( │ │ │ │ │ + sock: socket.socket, bufsize: int, maxfds: int, flags: int = 0 │ │ │ │ │ + ) -> 'tuple[bytes, list[int], int, None]': │ │ │ │ │ + fds = array.array("i") │ │ │ │ │ + msg, ancdata, flags, addr = sock.recvmsg(bufsize, socket.CMSG_LEN(maxfds * fds.itemsize)) │ │ │ │ │ + for cmsg_level, cmsg_type, cmsg_data in ancdata: │ │ │ │ │ + if (cmsg_level == socket.SOL_SOCKET and cmsg_type == socket.SCM_RIGHTS): │ │ │ │ │ + fds.frombytes(cmsg_data[:len(cmsg_data) - (len(cmsg_data) % fds.itemsize)]) │ │ │ │ │ + return msg, list(fds), flags, addr │ │ │ │ │ │ │ │ │ │ - def __enter__(self) -> 'Handle': │ │ │ │ │ - return self │ │ │ │ │ │ │ │ │ │ - def __exit__(self, _type: type, _value: object, _traceback: object) -> None: │ │ │ │ │ - self.close() │ │ │ │ │ +def get_running_loop() -> asyncio.AbstractEventLoop: │ │ │ │ │ + try: │ │ │ │ │ + return asyncio.get_running_loop() │ │ │ │ │ + except AttributeError: │ │ │ │ │ + # Python 3.6 │ │ │ │ │ + return asyncio.get_event_loop() │ │ │ │ │ │ │ │ │ │ - @classmethod │ │ │ │ │ - def open(cls, *args: Any, **kwargs: Any) -> 'Handle': │ │ │ │ │ - return cls(os.open(*args, **kwargs)) │ │ │ │ │ │ │ │ │ │ - def steal(self) -> 'Handle': │ │ │ │ │ - self._needs_close = False │ │ │ │ │ - return self.__class__(int(self)) │ │ │ │ │ +class InteractionHandler: │ │ │ │ │ + commands: ClassVar[Sequence[str]] │ │ │ │ │ │ │ │ │ │ + async def run_command(self, command: str, args: 'tuple[object, ...]', fds: 'list[int]', stderr: str) -> None: │ │ │ │ │ + raise NotImplementedError │ │ │ │ │ │ │ │ │ │ -class WatchInvalidator: │ │ │ │ │ - _name: bytes │ │ │ │ │ - _source: Optional[Event.Source] │ │ │ │ │ - _watch: Optional['PathWatch'] │ │ │ │ │ │ │ │ │ │ - def event(self, mask: IN, _cookie: int, name: Optional[bytes]) -> None: │ │ │ │ │ - logger.debug('invalidator event %s %s', mask, name) │ │ │ │ │ - if self._watch is not None: │ │ │ │ │ - # If this node itself disappeared, that's definitely an │ │ │ │ │ - # invalidation. Otherwise, the name needs to match. │ │ │ │ │ - if IN.IGNORED in mask or self._name == name: │ │ │ │ │ - logger.debug('Invalidating!') │ │ │ │ │ - self._watch.invalidate() │ │ │ │ │ +class AskpassHandler(InteractionHandler): │ │ │ │ │ + commands: ClassVar[Sequence[str]] = ('ferny.askpass',) │ │ │ │ │ │ │ │ │ │ - def __init__(self, watch: 'PathWatch', event: Event, dirfd: int, name: str): │ │ │ │ │ - self._watch = watch │ │ │ │ │ - self._name = name.encode('utf-8') │ │ │ │ │ + async def do_askpass(self, messages: str, prompt: str, hint: str) -> 'str | None': │ │ │ │ │ + """Prompt the user for an authentication or confirmation interaction. │ │ │ │ │ │ │ │ │ │ - # establishing invalidation watches is best-effort and can fail for a │ │ │ │ │ - # number of reasons, including search (+x) but not read (+r) permission │ │ │ │ │ - # on a particular path component, or exceeding limits on watches │ │ │ │ │ + 'messages' is data that was sent to stderr before the interaction was requested. │ │ │ │ │ + 'prompt' is the interaction prompt. │ │ │ │ │ + │ │ │ │ │ + The expected response type depends on hint: │ │ │ │ │ + │ │ │ │ │ + - "confirm": ask for permission, returning "yes" if accepted │ │ │ │ │ + - example: authorizing agent operation │ │ │ │ │ + │ │ │ │ │ + - "none": show a request without need for a response │ │ │ │ │ + - example: please touch your authentication token │ │ │ │ │ + │ │ │ │ │ + - otherwise: return a password or other form of text token │ │ │ │ │ + - examples: enter password, unlock private key │ │ │ │ │ + │ │ │ │ │ + In any case, the function should properly handle cancellation. For the │ │ │ │ │ + "none" case, this will be the normal way to dismiss the dialog. │ │ │ │ │ + """ │ │ │ │ │ + return None │ │ │ │ │ + │ │ │ │ │ + async def do_hostkey(self, reason: str, host: str, algorithm: str, key: str, fingerprint: str) -> bool: │ │ │ │ │ + """Prompt the user for a decision regarding acceptance of a host key. │ │ │ │ │ + │ │ │ │ │ + The "reason" will be either "HOSTNAME" or "ADDRESS" (if `CheckHostIP` is enabled). │ │ │ │ │ + │ │ │ │ │ + The host, algorithm, and key parameters are the values in the form that │ │ │ │ │ + they would appear one a single line in the known hosts file. The │ │ │ │ │ + fingerprint is the key fingerprint in the format that ssh would │ │ │ │ │ + normally present it to the user. │ │ │ │ │ + │ │ │ │ │ + In case the host key should be accepted, this function needs to return │ │ │ │ │ + True. Returning False means that ssh implements its default logic. To │ │ │ │ │ + interrupt the connection, raise an exception. │ │ │ │ │ + """ │ │ │ │ │ + return False │ │ │ │ │ + │ │ │ │ │ + async def do_custom_command( │ │ │ │ │ + self, command: str, args: 'tuple[object, ...]', fds: 'list[int]', stderr: str │ │ │ │ │ + ) -> None: │ │ │ │ │ + """Handle a custom command. │ │ │ │ │ + │ │ │ │ │ + The command name, its arguments, the passed fds, and the stderr leading │ │ │ │ │ + up to the command invocation are all provided. │ │ │ │ │ + │ │ │ │ │ + See doc/interaction-protocol.md │ │ │ │ │ + """ │ │ │ │ │ + │ │ │ │ │ + async def _askpass_command(self, args: 'tuple[object, ...]', fds: 'list[int]', stderr: str) -> None: │ │ │ │ │ + logger.debug('_askpass_command(%s, %s, %s)', args, fds, stderr) │ │ │ │ │ try: │ │ │ │ │ - mask = IN.CREATE | IN.DELETE | IN.MOVE | IN.DELETE_SELF | IN.IGNORED │ │ │ │ │ - self._source = event.add_inotify_fd(dirfd, mask, self.event) │ │ │ │ │ - except OSError: │ │ │ │ │ - self._source = None │ │ │ │ │ + argv, env = args │ │ │ │ │ + assert isinstance(argv, list) │ │ │ │ │ + assert all(isinstance(arg, str) for arg in argv) │ │ │ │ │ + assert isinstance(env, dict) │ │ │ │ │ + assert all(isinstance(key, str) and isinstance(val, str) for key, val in env.items()) │ │ │ │ │ + assert len(fds) == 2 │ │ │ │ │ + except (ValueError, TypeError, AssertionError) as exc: │ │ │ │ │ + logger.error('Invalid arguments to askpass interaction: %s, %s: %s', args, fds, exc) │ │ │ │ │ + return │ │ │ │ │ │ │ │ │ │ - def close(self) -> None: │ │ │ │ │ - # This is a little bit tricky: systemd doesn't have a specific close │ │ │ │ │ - # API outside of unref, so let's make it as explicit as possible. │ │ │ │ │ - self._watch = None │ │ │ │ │ - self._source = None │ │ │ │ │ + with open(fds.pop(0), 'w') as status, open(fds.pop(0), 'w') as stdout: │ │ │ │ │ + try: │ │ │ │ │ + loop = get_running_loop() │ │ │ │ │ + try: │ │ │ │ │ + task = asyncio.current_task() │ │ │ │ │ + except AttributeError: │ │ │ │ │ + task = asyncio.Task.current_task() # type:ignore[attr-defined] # (Python 3.6) │ │ │ │ │ + assert task is not None │ │ │ │ │ + loop.add_reader(status, task.cancel) │ │ │ │ │ │ │ │ │ │ + if len(argv) == 2: │ │ │ │ │ + # normal askpass │ │ │ │ │ + prompt = argv[1] │ │ │ │ │ + hint = env.get('SSH_ASKPASS_PROMPT', '') │ │ │ │ │ + logger.debug('do_askpass(%r, %r, %r)', stderr, prompt, hint) │ │ │ │ │ + answer = await self.do_askpass(stderr, prompt, hint) │ │ │ │ │ + logger.debug('do_askpass answer %r', answer) │ │ │ │ │ + if answer is not None: │ │ │ │ │ + print(answer, file=stdout) │ │ │ │ │ + print(0, file=status) │ │ │ │ │ │ │ │ │ │ -class PathStack(List[str]): │ │ │ │ │ - def add_path(self, pathname: str) -> None: │ │ │ │ │ - # TO DO: consider doing something reasonable with trailing slashes │ │ │ │ │ - # this is a stack, popped from the end: push components in reverse │ │ │ │ │ - self.extend(item for item in reversed(pathname.split('/')) if item) │ │ │ │ │ - if pathname.startswith('/'): │ │ │ │ │ - self.append('/') │ │ │ │ │ + elif len(argv) == 6: │ │ │ │ │ + # KnownHostsCommand │ │ │ │ │ + argv0, reason, host, algorithm, key, fingerprint = argv │ │ │ │ │ + if reason in ['ADDRESS', 'HOSTNAME']: │ │ │ │ │ + logger.debug('do_hostkey(%r, %r, %r, %r, %r)', reason, host, algorithm, key, fingerprint) │ │ │ │ │ + if await self.do_hostkey(reason, host, algorithm, key, fingerprint): │ │ │ │ │ + print(host, algorithm, key, file=stdout) │ │ │ │ │ + else: │ │ │ │ │ + logger.debug('ignoring KnownHostsCommand reason %r', reason) │ │ │ │ │ │ │ │ │ │ - def __init__(self, path: str): │ │ │ │ │ - super().__init__() │ │ │ │ │ - self.add_path(path) │ │ │ │ │ + print(0, file=status) │ │ │ │ │ │ │ │ │ │ + else: │ │ │ │ │ + logger.error('Incorrect number of command-line arguments to ferny-askpass: %s', argv) │ │ │ │ │ + finally: │ │ │ │ │ + loop.remove_reader(status) │ │ │ │ │ │ │ │ │ │ -class Listener: │ │ │ │ │ - def do_inotify_event(self, mask: IN, cookie: int, name: Optional[bytes]) -> None: │ │ │ │ │ - raise NotImplementedError │ │ │ │ │ + async def run_command(self, command: str, args: 'tuple[object, ...]', fds: 'list[int]', stderr: str) -> None: │ │ │ │ │ + logger.debug('run_command(%s, %s, %s, %s)', command, args, fds, stderr) │ │ │ │ │ + if command == 'ferny.askpass': │ │ │ │ │ + await self._askpass_command(args, fds, stderr) │ │ │ │ │ + else: │ │ │ │ │ + await self.do_custom_command(command, args, fds, stderr) │ │ │ │ │ │ │ │ │ │ - def do_identity_changed(self, fd: Optional[Handle], errno: Optional[int]) -> None: │ │ │ │ │ - raise NotImplementedError │ │ │ │ │ │ │ │ │ │ +class InteractionAgent: │ │ │ │ │ + _handlers: 'dict[str, InteractionHandler]' │ │ │ │ │ │ │ │ │ │ -class PathWatch: │ │ │ │ │ - _event: Event │ │ │ │ │ - _listener: Listener │ │ │ │ │ - _path: str │ │ │ │ │ - _invalidators: List[WatchInvalidator] │ │ │ │ │ - _errno: Optional[int] │ │ │ │ │ - _source: Optional[Event.Source] │ │ │ │ │ - _tag: Optional[None] │ │ │ │ │ - _fd: Handle │ │ │ │ │ + _loop: asyncio.AbstractEventLoop │ │ │ │ │ │ │ │ │ │ - def __init__(self, path: str, listener: Listener, event: Optional[Event] = None): │ │ │ │ │ - self._event = event or Event.default() │ │ │ │ │ - self._path = path │ │ │ │ │ - self._listener = listener │ │ │ │ │ + _tasks: 'set[asyncio.Task]' │ │ │ │ │ │ │ │ │ │ - self._invalidators = [] │ │ │ │ │ - self._errno = None │ │ │ │ │ - self._source = None │ │ │ │ │ - self._tag = None │ │ │ │ │ - self._fd = Handle() │ │ │ │ │ + _buffer: bytearray │ │ │ │ │ + _ours: socket.socket │ │ │ │ │ + _theirs: socket.socket │ │ │ │ │ │ │ │ │ │ - self.invalidate() │ │ │ │ │ + _completion_future: 'asyncio.Future[str]' │ │ │ │ │ + _pending_result: 'None | str | Exception' = None │ │ │ │ │ + _end: bool = False │ │ │ │ │ │ │ │ │ │ - def got_event(self, mask: IN, cookie: int, name: Optional[bytes]) -> None: │ │ │ │ │ - logger.debug('target event %s: %s %s %s', self._path, mask, cookie, name) │ │ │ │ │ - self._listener.do_inotify_event(mask, cookie, name) │ │ │ │ │ + def _consider_completion(self) -> None: │ │ │ │ │ + logger.debug('_consider_completion(%r)', self) │ │ │ │ │ │ │ │ │ │ - def invalidate(self) -> None: │ │ │ │ │ - for invalidator in self._invalidators: │ │ │ │ │ - invalidator.close() │ │ │ │ │ - self._invalidators = [] │ │ │ │ │ + if self._pending_result is None or self._tasks: │ │ │ │ │ + logger.debug(' but not ready yet') │ │ │ │ │ │ │ │ │ │ - try: │ │ │ │ │ - fd = self.walk() │ │ │ │ │ - except OSError as error: │ │ │ │ │ - logger.debug('walk ended in error %d', error.errno) │ │ │ │ │ + elif self._completion_future.done(): │ │ │ │ │ + logger.debug(' but already complete') │ │ │ │ │ │ │ │ │ │ - if self._source or self._fd or self._errno != error.errno: │ │ │ │ │ - logger.debug('Ending existing watches.') │ │ │ │ │ - self._source = None │ │ │ │ │ - self._fd.close() │ │ │ │ │ - self._fd = Handle() │ │ │ │ │ - self._errno = error.errno │ │ │ │ │ + elif isinstance(self._pending_result, str): │ │ │ │ │ + logger.debug(' submitting stderr (%r) to completion_future', self._pending_result) │ │ │ │ │ + self._completion_future.set_result(self._pending_result) │ │ │ │ │ │ │ │ │ │ - logger.debug('Notifying of new error state %d', self._errno) │ │ │ │ │ - self._listener.do_identity_changed(None, self._errno) │ │ │ │ │ + else: │ │ │ │ │ + logger.debug(' submitting exception (%r) to completion_future') │ │ │ │ │ + self._completion_future.set_exception(self._pending_result) │ │ │ │ │ + │ │ │ │ │ + def _result(self, result: 'str | Exception') -> None: │ │ │ │ │ + logger.debug('_result(%r, %r)', self, result) │ │ │ │ │ + │ │ │ │ │ + if self._pending_result is None: │ │ │ │ │ + self._pending_result = result │ │ │ │ │ + │ │ │ │ │ + if self._ours.fileno() != -1: │ │ │ │ │ + logger.debug(' remove_reader(%r)', self._ours) │ │ │ │ │ + self._loop.remove_reader(self._ours.fileno()) │ │ │ │ │ + │ │ │ │ │ + for task in self._tasks: │ │ │ │ │ + logger.debug(' cancel(%r)', task) │ │ │ │ │ + task.cancel() │ │ │ │ │ + │ │ │ │ │ + logger.debug(' closing sockets') │ │ │ │ │ + self._theirs.close() # idempotent │ │ │ │ │ + self._ours.close() │ │ │ │ │ + │ │ │ │ │ + self._consider_completion() │ │ │ │ │ + │ │ │ │ │ + def _invoke_command(self, stderr: bytes, command_blob: bytes, fds: 'list[int]') -> None: │ │ │ │ │ + logger.debug('_invoke_command(%r, %r, %r)', stderr, command_blob, fds) │ │ │ │ │ + try: │ │ │ │ │ + command, args = ast.literal_eval(command_blob.decode()) │ │ │ │ │ + if not isinstance(command, str) or not isinstance(args, tuple): │ │ │ │ │ + raise TypeError('Invalid argument types') │ │ │ │ │ + except (UnicodeDecodeError, SyntaxError, ValueError, TypeError) as exc: │ │ │ │ │ + logger.error('Received invalid ferny command: %s: %s', command_blob, exc) │ │ │ │ │ + return │ │ │ │ │ │ │ │ │ │ + if command == 'ferny.end': │ │ │ │ │ + self._end = True │ │ │ │ │ + self._result(self._buffer.decode(errors='replace')) │ │ │ │ │ return │ │ │ │ │ │ │ │ │ │ - with fd: │ │ │ │ │ - logger.debug('walk successful. Got fd %d', fd) │ │ │ │ │ - if fd == self._fd: │ │ │ │ │ - logger.debug('fd seems to refer to same file. Doing nothing.') │ │ │ │ │ - return │ │ │ │ │ + try: │ │ │ │ │ + handler = self._handlers[command] │ │ │ │ │ + except KeyError: │ │ │ │ │ + logger.error('Received unhandled ferny command: %s', command) │ │ │ │ │ + return │ │ │ │ │ │ │ │ │ │ - logger.debug('This file is new for us. Removing old watch.') │ │ │ │ │ - self._source = None │ │ │ │ │ - self._fd.close() │ │ │ │ │ - self._fd = fd.steal() │ │ │ │ │ + # The task is responsible for the list of fds and removing itself │ │ │ │ │ + # from the set. │ │ │ │ │ + task_fds = list(fds) │ │ │ │ │ + task = self._loop.create_task(handler.run_command(command, args, task_fds, stderr.decode())) │ │ │ │ │ + │ │ │ │ │ + def bottom_half(completed_task: asyncio.Task) -> None: │ │ │ │ │ + assert completed_task is task │ │ │ │ │ + while task_fds: │ │ │ │ │ + os.close(task_fds.pop()) │ │ │ │ │ + self._tasks.remove(task) │ │ │ │ │ │ │ │ │ │ try: │ │ │ │ │ - logger.debug('Establishing a new watch.') │ │ │ │ │ - self._source = self._event.add_inotify_fd(self._fd, IN.CHANGED, self.got_event) │ │ │ │ │ - logger.debug('Watching successfully. Notifying of new identity.') │ │ │ │ │ - self._listener.do_identity_changed(self._fd, None) │ │ │ │ │ - except OSError as error: │ │ │ │ │ - logger.debug('Watching failed (%d). Notifying of new identity.', error.errno) │ │ │ │ │ - self._listener.do_identity_changed(self._fd, error.errno) │ │ │ │ │ + task.result() │ │ │ │ │ + logger.debug('%r completed cleanly', handler) │ │ │ │ │ + except asyncio.CancelledError: │ │ │ │ │ + # this is not an error — it just means ferny-askpass exited via signal │ │ │ │ │ + logger.debug('%r was cancelled', handler) │ │ │ │ │ + except Exception as exc: │ │ │ │ │ + logger.debug('%r raised %r', handler, exc) │ │ │ │ │ + self._result(exc) │ │ │ │ │ │ │ │ │ │ - def walk(self) -> Handle: │ │ │ │ │ - remaining_symlink_lookups = 40 │ │ │ │ │ - remaining_components = PathStack(self._path) │ │ │ │ │ - dirfd = Handle() │ │ │ │ │ + self._consider_completion() │ │ │ │ │ + │ │ │ │ │ + task.add_done_callback(bottom_half) │ │ │ │ │ + self._tasks.add(task) │ │ │ │ │ + fds[:] = [] │ │ │ │ │ + │ │ │ │ │ + def _got_data(self, data: bytes, fds: 'list[int]') -> None: │ │ │ │ │ + logger.debug('_got_data(%r, %r)', data, fds) │ │ │ │ │ + │ │ │ │ │ + if data == b'': │ │ │ │ │ + self._result(self._buffer.decode(errors='replace')) │ │ │ │ │ + return │ │ │ │ │ + │ │ │ │ │ + self._buffer.extend(data) │ │ │ │ │ + │ │ │ │ │ + # Read zero or more "remote" messages │ │ │ │ │ + chunks = COMMAND_RE.split(self._buffer) │ │ │ │ │ + self._buffer = bytearray(chunks.pop()) │ │ │ │ │ + while len(chunks) > 1: │ │ │ │ │ + self._invoke_command(chunks[0], chunks[1], []) │ │ │ │ │ + chunks = chunks[2:] │ │ │ │ │ + │ │ │ │ │ + # Maybe read one "local" message │ │ │ │ │ + if fds: │ │ │ │ │ + assert self._buffer.endswith(b'\0'), self._buffer │ │ │ │ │ + stderr = self._buffer[:-1] │ │ │ │ │ + self._buffer = bytearray(b'') │ │ │ │ │ + with open(fds.pop(0), 'rb') as command_channel: │ │ │ │ │ + command = command_channel.read() │ │ │ │ │ + self._invoke_command(stderr, command, fds) │ │ │ │ │ │ │ │ │ │ + def _read_ready(self) -> None: │ │ │ │ │ try: │ │ │ │ │ - logger.debug('Starting path walk') │ │ │ │ │ + data, fds, _flags, _addr = recv_fds(self._ours, 4096, 10, flags=socket.MSG_DONTWAIT) │ │ │ │ │ + except BlockingIOError: │ │ │ │ │ + return │ │ │ │ │ + except OSError as exc: │ │ │ │ │ + self._result(exc) │ │ │ │ │ + else: │ │ │ │ │ + self._got_data(data, fds) │ │ │ │ │ + finally: │ │ │ │ │ + while fds: │ │ │ │ │ + os.close(fds.pop()) │ │ │ │ │ │ │ │ │ │ - while remaining_components: │ │ │ │ │ - logger.debug('r=%s dfd=%s', remaining_components, dirfd) │ │ │ │ │ + def __init__( │ │ │ │ │ + self, │ │ │ │ │ + handlers: Sequence[InteractionHandler], │ │ │ │ │ + loop: 'asyncio.AbstractEventLoop | None' = None, │ │ │ │ │ + done_callback: 'Callable[[asyncio.Future[str]], None] | None' = None, │ │ │ │ │ + ) -> None: │ │ │ │ │ + self._loop = loop or get_running_loop() │ │ │ │ │ + self._completion_future = self._loop.create_future() │ │ │ │ │ + self._tasks = set() │ │ │ │ │ + self._handlers = {} │ │ │ │ │ │ │ │ │ │ - name = remaining_components.pop() │ │ │ │ │ + for handler in handlers: │ │ │ │ │ + for command in handler.commands: │ │ │ │ │ + self._handlers[command] = handler │ │ │ │ │ │ │ │ │ │ - if dirfd and name != '/': │ │ │ │ │ - self._invalidators.append(WatchInvalidator(self, self._event, dirfd, name)) │ │ │ │ │ + if done_callback is not None: │ │ │ │ │ + self._completion_future.add_done_callback(done_callback) │ │ │ │ │ │ │ │ │ │ - with Handle.open(name, os.O_PATH | os.O_NOFOLLOW | os.O_CLOEXEC, dir_fd=dirfd) as fd: │ │ │ │ │ - mode = os.fstat(fd).st_mode │ │ │ │ │ + self._theirs, self._ours = socket.socketpair(socket.AF_UNIX, socket.SOCK_STREAM) │ │ │ │ │ + self._buffer = bytearray() │ │ │ │ │ │ │ │ │ │ - if stat.S_ISLNK(mode): │ │ │ │ │ - if remaining_symlink_lookups == 0: │ │ │ │ │ - raise OSError(errno.ELOOP, os.strerror(errno.ELOOP)) │ │ │ │ │ - remaining_symlink_lookups -= 1 │ │ │ │ │ - linkpath = os.readlink('', dir_fd=fd) │ │ │ │ │ - logger.debug('%s is a symlink. adding %s to components', name, linkpath) │ │ │ │ │ - remaining_components.add_path(linkpath) │ │ │ │ │ + def fileno(self) -> int: │ │ │ │ │ + return self._theirs.fileno() │ │ │ │ │ │ │ │ │ │ - else: │ │ │ │ │ - dirfd.close() │ │ │ │ │ - dirfd = fd.steal() │ │ │ │ │ + def start(self) -> None: │ │ │ │ │ + logger.debug('start(%r)', self) │ │ │ │ │ + if self._ours.fileno() != -1: │ │ │ │ │ + logger.debug(' add_reader(%r)', self._ours) │ │ │ │ │ + self._loop.add_reader(self._ours.fileno(), self._read_ready) │ │ │ │ │ + else: │ │ │ │ │ + logger.debug(' ...but agent is already finished.') │ │ │ │ │ │ │ │ │ │ - return dirfd.steal() │ │ │ │ │ + logger.debug(' close(%r)', self._theirs) │ │ │ │ │ + self._theirs.close() │ │ │ │ │ + │ │ │ │ │ + def force_completion(self) -> None: │ │ │ │ │ + logger.debug('force_completion(%r)', self) │ │ │ │ │ + │ │ │ │ │ + # read any residual data on stderr, but don't process commands, and │ │ │ │ │ + # don't block │ │ │ │ │ + try: │ │ │ │ │ + if self._ours.fileno() != -1: │ │ │ │ │ + logger.debug(' draining pending stderr data (non-blocking)') │ │ │ │ │ + with contextlib.suppress(BlockingIOError): │ │ │ │ │ + while True: │ │ │ │ │ + data = self._ours.recv(4096, socket.MSG_DONTWAIT) │ │ │ │ │ + logger.debug(' got %d bytes', len(data)) │ │ │ │ │ + if not data: │ │ │ │ │ + break │ │ │ │ │ + self._buffer.extend(data) │ │ │ │ │ + except OSError as exc: │ │ │ │ │ + self._result(exc) │ │ │ │ │ + else: │ │ │ │ │ + self._result(self._buffer.decode(errors='replace')) │ │ │ │ │ │ │ │ │ │ + async def communicate(self) -> None: │ │ │ │ │ + logger.debug('_communicate(%r)', self) │ │ │ │ │ + try: │ │ │ │ │ + self.start() │ │ │ │ │ + # We assume that we are the only ones to write to │ │ │ │ │ + # self._completion_future. If we directly await it, though, it can │ │ │ │ │ + # also have a asyncio.CancelledError posted to it from outside. │ │ │ │ │ + # Shield it to prevent that from happening. │ │ │ │ │ + stderr = await asyncio.shield(self._completion_future) │ │ │ │ │ + logger.debug('_communicate(%r) stderr result is %r', self, stderr) │ │ │ │ │ finally: │ │ │ │ │ - dirfd.close() │ │ │ │ │ + logger.debug('_communicate finished. Ensuring completion.') │ │ │ │ │ + self.force_completion() │ │ │ │ │ + if not self._end: │ │ │ │ │ + logger.debug('_communicate never saw ferny.end. raising InteractionError.') │ │ │ │ │ + raise InteractionError(stderr.strip()) │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +def write_askpass_to_tmpdir(tmpdir: str) -> str: │ │ │ │ │ + askpass_path = os.path.join(tmpdir, 'ferny-askpass') │ │ │ │ │ + fd = os.open(askpass_path, os.O_CREAT | os.O_WRONLY | os.O_CLOEXEC | os.O_EXCL | os.O_NOFOLLOW, 0o777) │ │ │ │ │ + try: │ │ │ │ │ + os.write(fd, __loader__.get_data(interaction_client.__file__)) # type: ignore │ │ │ │ │ + finally: │ │ │ │ │ + os.close(fd) │ │ │ │ │ + return askpass_path │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +@contextlib.contextmanager │ │ │ │ │ +def temporary_askpass(**kwargs: Any) -> Generator[str, None, None]: │ │ │ │ │ + with tempfile.TemporaryDirectory(**kwargs) as directory: │ │ │ │ │ + yield write_askpass_to_tmpdir(directory) │ │ │ │ │ +'''.encode('utf-8'), │ │ │ │ │ + 'cockpit/_vendor/ferny/ssh_askpass.py': br'''import logging │ │ │ │ │ +import re │ │ │ │ │ +from typing import ClassVar, Match, Sequence │ │ │ │ │ + │ │ │ │ │ +from .interaction_agent import AskpassHandler │ │ │ │ │ + │ │ │ │ │ +logger = logging.getLogger(__name__) │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class AskpassPrompt: │ │ │ │ │ + """An askpass prompt resulting from a call to ferny-askpass. │ │ │ │ │ + │ │ │ │ │ + stderr: the contents of stderr from before ferny-askpass was called. │ │ │ │ │ + Likely related to previous failed operations. │ │ │ │ │ + messages: all but the last line of the prompt as handed to ferny-askpass. │ │ │ │ │ + Usually contains context about the question. │ │ │ │ │ + prompt: the last line handed to ferny-askpass. The prompt itself. │ │ │ │ │ + """ │ │ │ │ │ + stderr: str │ │ │ │ │ + messages: str │ │ │ │ │ + prompt: str │ │ │ │ │ + │ │ │ │ │ + def __init__(self, prompt: str, messages: str, stderr: str) -> None: │ │ │ │ │ + self.stderr = stderr │ │ │ │ │ + self.messages = messages │ │ │ │ │ + self.prompt = prompt │ │ │ │ │ + │ │ │ │ │ + def reply(self, response: str) -> None: │ │ │ │ │ + pass │ │ │ │ │ │ │ │ │ │ def close(self) -> None: │ │ │ │ │ - for invalidator in self._invalidators: │ │ │ │ │ - invalidator.close() │ │ │ │ │ - self._invalidators = [] │ │ │ │ │ - self._source = None │ │ │ │ │ - self._fd.close() │ │ │ │ │ + pass │ │ │ │ │ + │ │ │ │ │ + async def handle_via(self, responder: 'SshAskpassResponder') -> None: │ │ │ │ │ + try: │ │ │ │ │ + response = await self.dispatch(responder) │ │ │ │ │ + if response is not None: │ │ │ │ │ + self.reply(response) │ │ │ │ │ + finally: │ │ │ │ │ + self.close() │ │ │ │ │ + │ │ │ │ │ + async def dispatch(self, responder: 'SshAskpassResponder') -> 'str | None': │ │ │ │ │ + return await responder.do_prompt(self) │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class SSHAskpassPrompt(AskpassPrompt): │ │ │ │ │ + # The valid answers to prompts of this type. If this is None then any │ │ │ │ │ + # answer is permitted. If it's a sequence then only answers from the │ │ │ │ │ + # sequence are permitted. If it's an empty sequence, then no answer is │ │ │ │ │ + # permitted (ie: the askpass callback should never return). │ │ │ │ │ + answers: 'ClassVar[Sequence[str] | None]' = None │ │ │ │ │ + │ │ │ │ │ + # Patterns to capture. `_pattern` *must* match. │ │ │ │ │ + _pattern: ClassVar[str] │ │ │ │ │ + # `_extra_patterns` can fill in extra class attributes if they match. │ │ │ │ │ + _extra_patterns: ClassVar[Sequence[str]] = () │ │ │ │ │ + │ │ │ │ │ + def __init__(self, prompt: str, messages: str, stderr: str, match: Match) -> None: │ │ │ │ │ + super().__init__(prompt, messages, stderr) │ │ │ │ │ + self.__dict__.update(match.groupdict()) │ │ │ │ │ + │ │ │ │ │ + for pattern in self._extra_patterns: │ │ │ │ │ + extra_match = re.search(with_helpers(pattern), messages, re.M) │ │ │ │ │ + if extra_match is not None: │ │ │ │ │ + self.__dict__.update(extra_match.groupdict()) │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +# Specific prompts │ │ │ │ │ +HELPERS = { │ │ │ │ │ + "%{algorithm}": r"(?P\b[-\w]+\b)", │ │ │ │ │ + "%{filename}": r"(?P.+)", │ │ │ │ │ + "%{fingerprint}": r"(?PSHA256:[0-9A-Za-z+/]{43})", │ │ │ │ │ + "%{hostname}": r"(?P[^ @']+)", │ │ │ │ │ + "%{pkcs11_id}": r"(?P.+)", │ │ │ │ │ + "%{username}": r"(?P[^ @']+)", │ │ │ │ │ +} │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class SshPasswordPrompt(SSHAskpassPrompt): │ │ │ │ │ + _pattern = r"%{username}@%{hostname}'s password: " │ │ │ │ │ + username: 'str | None' = None │ │ │ │ │ + hostname: 'str | None' = None │ │ │ │ │ + │ │ │ │ │ + async def dispatch(self, responder: 'SshAskpassResponder') -> 'str | None': │ │ │ │ │ + return await responder.do_password_prompt(self) │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class SshPassphrasePrompt(SSHAskpassPrompt): │ │ │ │ │ + _pattern = r"Enter passphrase for key '%{filename}': " │ │ │ │ │ + filename: str │ │ │ │ │ + │ │ │ │ │ + async def dispatch(self, responder: 'SshAskpassResponder') -> 'str | None': │ │ │ │ │ + return await responder.do_passphrase_prompt(self) │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class SshFIDOPINPrompt(SSHAskpassPrompt): │ │ │ │ │ + _pattern = r"Enter PIN for %{algorithm} key %{filename}: " │ │ │ │ │ + algorithm: str │ │ │ │ │ + filename: str │ │ │ │ │ + │ │ │ │ │ + async def dispatch(self, responder: 'SshAskpassResponder') -> 'str | None': │ │ │ │ │ + return await responder.do_fido_pin_prompt(self) │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class SshFIDOUserPresencePrompt(SSHAskpassPrompt): │ │ │ │ │ + _pattern = r"Confirm user presence for key %{algorithm} %{fingerprint}" │ │ │ │ │ + answers = () │ │ │ │ │ + algorithm: str │ │ │ │ │ + fingerprint: str │ │ │ │ │ + │ │ │ │ │ + async def dispatch(self, responder: 'SshAskpassResponder') -> 'str | None': │ │ │ │ │ + return await responder.do_fido_user_presence_prompt(self) │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class SshPKCS11PINPrompt(SSHAskpassPrompt): │ │ │ │ │ + _pattern = r"Enter PIN for '%{pkcs11_id}': " │ │ │ │ │ + pkcs11_id: str │ │ │ │ │ + │ │ │ │ │ + async def dispatch(self, responder: 'SshAskpassResponder') -> 'str | None': │ │ │ │ │ + return await responder.do_pkcs11_pin_prompt(self) │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class SshHostKeyPrompt(SSHAskpassPrompt): │ │ │ │ │ + _pattern = r"Are you sure you want to continue connecting \(yes/no(/\[fingerprint\])?\)\? " │ │ │ │ │ + _extra_patterns = [ │ │ │ │ │ + r"%{fingerprint}[.]$", │ │ │ │ │ + r"^%{algorithm} key fingerprint is", │ │ │ │ │ + r"^The fingerprint for the %{algorithm} key sent by the remote host is$" │ │ │ │ │ + ] │ │ │ │ │ + answers = ('yes', 'no') │ │ │ │ │ + algorithm: str │ │ │ │ │ + fingerprint: str │ │ │ │ │ + │ │ │ │ │ + async def dispatch(self, responder: 'SshAskpassResponder') -> 'str | None': │ │ │ │ │ + return await responder.do_host_key_prompt(self) │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +def with_helpers(pattern: str) -> str: │ │ │ │ │ + for name, helper in HELPERS.items(): │ │ │ │ │ + pattern = pattern.replace(name, helper) │ │ │ │ │ + │ │ │ │ │ + assert '%{' not in pattern │ │ │ │ │ + return pattern │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +def categorize_ssh_prompt(string: str, stderr: str) -> AskpassPrompt: │ │ │ │ │ + classes = [ │ │ │ │ │ + SshFIDOPINPrompt, │ │ │ │ │ + SshFIDOUserPresencePrompt, │ │ │ │ │ + SshHostKeyPrompt, │ │ │ │ │ + SshPKCS11PINPrompt, │ │ │ │ │ + SshPassphrasePrompt, │ │ │ │ │ + SshPasswordPrompt, │ │ │ │ │ + ] │ │ │ │ │ + │ │ │ │ │ + # The last line is the line after the last newline character, excluding the │ │ │ │ │ + # optional final newline character. eg: "x\ny\nLAST\n" or "x\ny\nLAST" │ │ │ │ │ + second_last_newline = string.rfind('\n', 0, -1) │ │ │ │ │ + if second_last_newline >= 0: │ │ │ │ │ + last_line = string[second_last_newline + 1:] │ │ │ │ │ + extras = string[:second_last_newline + 1] │ │ │ │ │ + else: │ │ │ │ │ + last_line = string │ │ │ │ │ + extras = '' │ │ │ │ │ + │ │ │ │ │ + for cls in classes: │ │ │ │ │ + pattern = with_helpers(cls._pattern) │ │ │ │ │ + match = re.fullmatch(pattern, last_line) │ │ │ │ │ + if match is not None: │ │ │ │ │ + return cls(last_line, extras, stderr, match) │ │ │ │ │ + │ │ │ │ │ + return AskpassPrompt(last_line, extras, stderr) │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class SshAskpassResponder(AskpassHandler): │ │ │ │ │ + async def do_askpass(self, stderr: str, prompt: str, hint: str) -> 'str | None': │ │ │ │ │ + return await categorize_ssh_prompt(prompt, stderr).dispatch(self) │ │ │ │ │ + │ │ │ │ │ + async def do_prompt(self, prompt: AskpassPrompt) -> 'str | None': │ │ │ │ │ + # Default fallback for unrecognised message types: unimplemented │ │ │ │ │ + return None │ │ │ │ │ + │ │ │ │ │ + async def do_fido_pin_prompt(self, prompt: SshFIDOPINPrompt) -> 'str | None': │ │ │ │ │ + return await self.do_prompt(prompt) │ │ │ │ │ + │ │ │ │ │ + async def do_fido_user_presence_prompt(self, prompt: SshFIDOUserPresencePrompt) -> 'str | None': │ │ │ │ │ + return await self.do_prompt(prompt) │ │ │ │ │ + │ │ │ │ │ + async def do_host_key_prompt(self, prompt: SshHostKeyPrompt) -> 'str | None': │ │ │ │ │ + return await self.do_prompt(prompt) │ │ │ │ │ + │ │ │ │ │ + async def do_pkcs11_pin_prompt(self, prompt: SshPKCS11PINPrompt) -> 'str | None': │ │ │ │ │ + return await self.do_prompt(prompt) │ │ │ │ │ + │ │ │ │ │ + async def do_passphrase_prompt(self, prompt: SshPassphrasePrompt) -> 'str | None': │ │ │ │ │ + return await self.do_prompt(prompt) │ │ │ │ │ + │ │ │ │ │ + async def do_password_prompt(self, prompt: SshPasswordPrompt) -> 'str | None': │ │ │ │ │ + return await self.do_prompt(prompt) │ │ │ │ │ ''', │ │ │ │ │ + 'cockpit/_vendor/ferny/py.typed': br'''''', │ │ │ │ │ 'cockpit/_vendor/systemd_ctypes/introspection.py': br'''# systemd_ctypes │ │ │ │ │ # │ │ │ │ │ # Copyright (C) 2022 Allison Karlitskaya │ │ │ │ │ # │ │ │ │ │ # This program is free software: you can redistribute it and/or modify │ │ │ │ │ # it under the terms of the GNU General Public License as published by │ │ │ │ │ # the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ @@ -7268,15 +8461,193 @@ │ │ │ │ │ self._ref() │ │ │ │ │ return self │ │ │ │ │ │ │ │ │ │ def __del__(self) -> None: │ │ │ │ │ if self.value is not None: │ │ │ │ │ self._unref() │ │ │ │ │ ''', │ │ │ │ │ - 'cockpit/_vendor/systemd_ctypes/py.typed': br'''''', │ │ │ │ │ + 'cockpit/_vendor/systemd_ctypes/__init__.py': br'''# systemd_ctypes │ │ │ │ │ +# │ │ │ │ │ +# Copyright (C) 2022 Allison Karlitskaya │ │ │ │ │ +# │ │ │ │ │ +# This program is free software: you can redistribute it and/or modify │ │ │ │ │ +# it under the terms of the GNU General Public License as published by │ │ │ │ │ +# the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ +# (at your option) any later version. │ │ │ │ │ +# │ │ │ │ │ +# This program is distributed in the hope that it will be useful, │ │ │ │ │ +# but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ +# GNU General Public License for more details. │ │ │ │ │ +# │ │ │ │ │ +# You should have received a copy of the GNU General Public License │ │ │ │ │ +# along with this program. If not, see . │ │ │ │ │ + │ │ │ │ │ +"""systemd_ctypes""" │ │ │ │ │ + │ │ │ │ │ +__version__ = "0" │ │ │ │ │ + │ │ │ │ │ +from .bus import Bus, BusError, BusMessage │ │ │ │ │ +from .bustypes import BusType, JSONEncoder, Variant │ │ │ │ │ +from .event import Event, EventLoopPolicy, run_async │ │ │ │ │ +from .pathwatch import Handle, PathWatch │ │ │ │ │ + │ │ │ │ │ +__all__ = [ │ │ │ │ │ + "Bus", │ │ │ │ │ + "BusError", │ │ │ │ │ + "BusMessage", │ │ │ │ │ + "BusType", │ │ │ │ │ + "Event", │ │ │ │ │ + "EventLoopPolicy", │ │ │ │ │ + "Handle", │ │ │ │ │ + "JSONEncoder", │ │ │ │ │ + "PathWatch", │ │ │ │ │ + "Variant", │ │ │ │ │ + "run_async", │ │ │ │ │ +] │ │ │ │ │ +''', │ │ │ │ │ + 'cockpit/_vendor/systemd_ctypes/event.py': br'''# systemd_ctypes │ │ │ │ │ +# │ │ │ │ │ +# Copyright (C) 2022 Allison Karlitskaya │ │ │ │ │ +# │ │ │ │ │ +# This program is free software: you can redistribute it and/or modify │ │ │ │ │ +# it under the terms of the GNU General Public License as published by │ │ │ │ │ +# the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ +# (at your option) any later version. │ │ │ │ │ +# │ │ │ │ │ +# This program is distributed in the hope that it will be useful, │ │ │ │ │ +# but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ +# GNU General Public License for more details. │ │ │ │ │ +# │ │ │ │ │ +# You should have received a copy of the GNU General Public License │ │ │ │ │ +# along with this program. If not, see . │ │ │ │ │ + │ │ │ │ │ +import asyncio │ │ │ │ │ +import selectors │ │ │ │ │ +import sys │ │ │ │ │ +from typing import Callable, ClassVar, Coroutine, List, Optional, Tuple │ │ │ │ │ + │ │ │ │ │ +from . import inotify, libsystemd │ │ │ │ │ +from .librarywrapper import Reference, UserData, byref │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class Event(libsystemd.sd_event): │ │ │ │ │ + class Source(libsystemd.sd_event_source): │ │ │ │ │ + def cancel(self) -> None: │ │ │ │ │ + self._unref() │ │ │ │ │ + self.value = None │ │ │ │ │ + │ │ │ │ │ + _default_instance: ClassVar[Optional['Event']] = None │ │ │ │ │ + │ │ │ │ │ + @staticmethod │ │ │ │ │ + def default() -> 'Event': │ │ │ │ │ + if Event._default_instance is None: │ │ │ │ │ + Event._default_instance = Event() │ │ │ │ │ + Event._default(byref(Event._default_instance)) │ │ │ │ │ + return Event._default_instance │ │ │ │ │ + │ │ │ │ │ + InotifyHandler = Callable[[inotify.Event, int, Optional[bytes]], None] │ │ │ │ │ + │ │ │ │ │ + class InotifySource(Source): │ │ │ │ │ + def __init__(self, handler: 'Event.InotifyHandler') -> None: │ │ │ │ │ + def callback(source: libsystemd.sd_event_source, │ │ │ │ │ + _event: Reference[inotify.inotify_event], │ │ │ │ │ + userdata: UserData) -> int: │ │ │ │ │ + event = _event.contents │ │ │ │ │ + handler(inotify.Event(event.mask), event.cookie, event.name) │ │ │ │ │ + return 0 │ │ │ │ │ + self.trampoline = libsystemd.sd_event_inotify_handler_t(callback) │ │ │ │ │ + │ │ │ │ │ + def add_inotify(self, path: str, mask: inotify.Event, handler: InotifyHandler) -> InotifySource: │ │ │ │ │ + source = Event.InotifySource(handler) │ │ │ │ │ + self._add_inotify(byref(source), path, mask, source.trampoline, source.userdata) │ │ │ │ │ + return source │ │ │ │ │ + │ │ │ │ │ + def add_inotify_fd(self, fd: int, mask: inotify.Event, handler: InotifyHandler) -> InotifySource: │ │ │ │ │ + # HACK: sd_event_add_inotify_fd() got added in 250, which is too new. Fake it. │ │ │ │ │ + return self.add_inotify(f'/proc/self/fd/{fd}', mask, handler) │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +# This is all a bit more awkward than it should have to be: systemd's event │ │ │ │ │ +# loop chaining model is designed for glib's prepare/check/dispatch paradigm; │ │ │ │ │ +# failing to call prepare() can lead to deadlocks, for example. │ │ │ │ │ +# │ │ │ │ │ +# Hack a selector subclass which calls prepare() before sleeping and this for us. │ │ │ │ │ +class Selector(selectors.DefaultSelector): │ │ │ │ │ + def __init__(self, event: Optional[Event] = None) -> None: │ │ │ │ │ + super().__init__() │ │ │ │ │ + self.sd_event = event or Event.default() │ │ │ │ │ + self.key = self.register(self.sd_event.get_fd(), selectors.EVENT_READ) │ │ │ │ │ + │ │ │ │ │ + def select( │ │ │ │ │ + self, timeout: Optional[float] = None │ │ │ │ │ + ) -> List[Tuple[selectors.SelectorKey, int]]: │ │ │ │ │ + # It's common to drop the last reference to a Source or Slot object on │ │ │ │ │ + # a dispatch of that same source/slot from the main loop. If we happen │ │ │ │ │ + # to garbage collect before returning, the trampoline could be │ │ │ │ │ + # destroyed before we're done using it. Provide a mechanism to defer │ │ │ │ │ + # the destruction of trampolines for as long as we might be │ │ │ │ │ + # dispatching. This gets cleared again at the bottom, before return. │ │ │ │ │ + libsystemd.Trampoline.deferred = [] │ │ │ │ │ + │ │ │ │ │ + while self.sd_event.prepare(): │ │ │ │ │ + self.sd_event.dispatch() │ │ │ │ │ + ready = super().select(timeout) │ │ │ │ │ + # workaround https://github.com/systemd/systemd/issues/23826 │ │ │ │ │ + # keep calling wait() until there's nothing left │ │ │ │ │ + while self.sd_event.wait(0): │ │ │ │ │ + self.sd_event.dispatch() │ │ │ │ │ + while self.sd_event.prepare(): │ │ │ │ │ + self.sd_event.dispatch() │ │ │ │ │ + │ │ │ │ │ + # We can be sure we're not dispatching callbacks anymore │ │ │ │ │ + libsystemd.Trampoline.deferred = None │ │ │ │ │ + │ │ │ │ │ + # This could return zero events with infinite timeout, but nobody seems to mind. │ │ │ │ │ + return [(key, events) for (key, events) in ready if key != self.key] │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class EventLoopPolicy(asyncio.DefaultEventLoopPolicy): │ │ │ │ │ + def new_event_loop(self) -> asyncio.AbstractEventLoop: │ │ │ │ │ + return asyncio.SelectorEventLoop(Selector()) │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +def run_async(main: Coroutine[None, None, None], debug: Optional[bool] = None) -> None: │ │ │ │ │ + asyncio.set_event_loop_policy(EventLoopPolicy()) │ │ │ │ │ + │ │ │ │ │ + polyfill = sys.version_info < (3, 7, 0) and not hasattr(asyncio, 'run') │ │ │ │ │ + if polyfill: │ │ │ │ │ + # Polyfills for Python 3.6: │ │ │ │ │ + loop = asyncio.get_event_loop() │ │ │ │ │ + │ │ │ │ │ + assert not hasattr(asyncio, 'get_running_loop') │ │ │ │ │ + asyncio.get_running_loop = lambda: loop │ │ │ │ │ + │ │ │ │ │ + assert not hasattr(asyncio, 'create_task') │ │ │ │ │ + asyncio.create_task = loop.create_task │ │ │ │ │ + │ │ │ │ │ + assert not hasattr(asyncio, 'run') │ │ │ │ │ + │ │ │ │ │ + def run( │ │ │ │ │ + main: Coroutine[None, None, None], debug: Optional[bool] = None │ │ │ │ │ + ) -> None: │ │ │ │ │ + if debug is not None: │ │ │ │ │ + loop.set_debug(debug) │ │ │ │ │ + loop.run_until_complete(main) │ │ │ │ │ + │ │ │ │ │ + asyncio.run = run # type: ignore[assignment] │ │ │ │ │ + │ │ │ │ │ + asyncio._systemd_ctypes_polyfills = True # type: ignore[attr-defined] │ │ │ │ │ + │ │ │ │ │ + asyncio.run(main, debug=debug) │ │ │ │ │ + │ │ │ │ │ + if polyfill: │ │ │ │ │ + del asyncio.create_task, asyncio.get_running_loop, asyncio.run │ │ │ │ │ +''', │ │ │ │ │ 'cockpit/_vendor/systemd_ctypes/bustypes.py': br'''# systemd_ctypes │ │ │ │ │ # │ │ │ │ │ # Copyright (C) 2023 Allison Karlitskaya │ │ │ │ │ # │ │ │ │ │ # This program is free software: you can redistribute it and/or modify │ │ │ │ │ # it under the terms of the GNU General Public License as published by │ │ │ │ │ # the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ @@ -7821,15 +9192,15 @@ │ │ │ │ │ def default(self, obj: object) -> object: │ │ │ │ │ if isinstance(obj, Variant): │ │ │ │ │ return {"t": obj.type.typestring, "v": obj.value} │ │ │ │ │ elif isinstance(obj, bytes): │ │ │ │ │ return binascii.b2a_base64(obj, newline=False).decode('ascii') │ │ │ │ │ return super().default(obj) │ │ │ │ │ ''', │ │ │ │ │ - 'cockpit/_vendor/systemd_ctypes/__init__.py': br'''# systemd_ctypes │ │ │ │ │ + 'cockpit/_vendor/systemd_ctypes/pathwatch.py': br'''# systemd_ctypes │ │ │ │ │ # │ │ │ │ │ # Copyright (C) 2022 Allison Karlitskaya │ │ │ │ │ # │ │ │ │ │ # This program is free software: you can redistribute it and/or modify │ │ │ │ │ # it under the terms of the GNU General Public License as published by │ │ │ │ │ # the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ # (at your option) any later version. │ │ │ │ │ @@ -7838,36 +9209,413 @@ │ │ │ │ │ # but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ # GNU General Public License for more details. │ │ │ │ │ # │ │ │ │ │ # You should have received a copy of the GNU General Public License │ │ │ │ │ # along with this program. If not, see . │ │ │ │ │ │ │ │ │ │ -"""systemd_ctypes""" │ │ │ │ │ +import errno │ │ │ │ │ +import logging │ │ │ │ │ +import os │ │ │ │ │ +import stat │ │ │ │ │ +from typing import Any, List, Optional │ │ │ │ │ │ │ │ │ │ -__version__ = "0" │ │ │ │ │ +from .event import Event │ │ │ │ │ +from .inotify import Event as IN │ │ │ │ │ │ │ │ │ │ -from .bus import Bus, BusError, BusMessage │ │ │ │ │ -from .bustypes import BusType, JSONEncoder, Variant │ │ │ │ │ -from .event import Event, EventLoopPolicy, run_async │ │ │ │ │ -from .pathwatch import Handle, PathWatch │ │ │ │ │ +logger = logging.getLogger(__name__) │ │ │ │ │ │ │ │ │ │ -__all__ = [ │ │ │ │ │ - "Bus", │ │ │ │ │ - "BusError", │ │ │ │ │ - "BusMessage", │ │ │ │ │ - "BusType", │ │ │ │ │ - "Event", │ │ │ │ │ - "EventLoopPolicy", │ │ │ │ │ - "Handle", │ │ │ │ │ - "JSONEncoder", │ │ │ │ │ - "PathWatch", │ │ │ │ │ - "Variant", │ │ │ │ │ - "run_async", │ │ │ │ │ -] │ │ │ │ │ + │ │ │ │ │ +# inotify hard facts: │ │ │ │ │ +# │ │ │ │ │ +# DELETE_SELF doesn't get called until all references to an inode are gone │ │ │ │ │ +# - including open fds │ │ │ │ │ +# - including on directories │ │ │ │ │ +# │ │ │ │ │ +# ATTRIB gets called when unlinking files (because the link count changes) but │ │ │ │ │ +# not on directories. When unlinking an open directory, no events at all │ │ │ │ │ +# happen on the directory. ATTRIB also collects child events, which means we │ │ │ │ │ +# get a lot of unwanted noise. │ │ │ │ │ +# │ │ │ │ │ +# There's nothing like UNLINK_SELF, unfortunately. │ │ │ │ │ +# │ │ │ │ │ +# Even if it was possible to take this approach, it might not work: after │ │ │ │ │ +# you've opened the fd, it might get deleted before you can establish the watch │ │ │ │ │ +# on it. │ │ │ │ │ +# │ │ │ │ │ +# Additionally, systemd makes it impossible to register those events on │ │ │ │ │ +# symlinks (because it removes IN_DONT_FOLLOW in order to watch via │ │ │ │ │ +# /proc/self/fd). │ │ │ │ │ +# │ │ │ │ │ +# For all of these reasons, unfortunately, the best way seems to be to watch │ │ │ │ │ +# for CREATE|DELETE|MOVE events on each intermediate directory. │ │ │ │ │ +# │ │ │ │ │ +# Unfortunately there is no way to filter to only the name we're interested in, │ │ │ │ │ +# so we're gonna get a lot of unnecessary wakeups. │ │ │ │ │ +# │ │ │ │ │ +# Also: due to the above-mentioned race about watching after opening the fd, │ │ │ │ │ +# let's just always watch for both create and delete events *before* trying to │ │ │ │ │ +# open the fd. We could try to reduce the mask after the fact, but meh... │ │ │ │ │ +# │ │ │ │ │ +# We use a WatchInvalidator utility class to fill the role of "Tell me when an │ │ │ │ │ +# event happened on this (directory) fd which impacted the name file". We │ │ │ │ │ +# build a series of these when setting up a watch in order to find out if any │ │ │ │ │ +# part of the path leading to the monitored file changed. │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class Handle(int): │ │ │ │ │ + """An integer subclass that makes it easier to work with file descriptors""" │ │ │ │ │ + │ │ │ │ │ + def __new__(cls, fd: int = -1) -> 'Handle': │ │ │ │ │ + return super(Handle, cls).__new__(cls, fd) │ │ │ │ │ + │ │ │ │ │ + # separate __init__() to set _needs_close mostly to keep pylint quiet │ │ │ │ │ + def __init__(self, fd: int = -1): │ │ │ │ │ + super().__init__() │ │ │ │ │ + self._needs_close = fd != -1 │ │ │ │ │ + │ │ │ │ │ + def __bool__(self) -> bool: │ │ │ │ │ + return self != -1 │ │ │ │ │ + │ │ │ │ │ + def close(self) -> None: │ │ │ │ │ + if self._needs_close: │ │ │ │ │ + self._needs_close = False │ │ │ │ │ + os.close(self) │ │ │ │ │ + │ │ │ │ │ + def __eq__(self, value: object) -> bool: │ │ │ │ │ + if int.__eq__(self, value): # also handles both == -1 │ │ │ │ │ + return True │ │ │ │ │ + │ │ │ │ │ + if not isinstance(value, int): # other object is not an int │ │ │ │ │ + return False │ │ │ │ │ + │ │ │ │ │ + if not self or not value: # when only one == -1 │ │ │ │ │ + return False │ │ │ │ │ + │ │ │ │ │ + return os.path.sameopenfile(self, value) │ │ │ │ │ + │ │ │ │ │ + def __del__(self) -> None: │ │ │ │ │ + if self._needs_close: │ │ │ │ │ + self.close() │ │ │ │ │ + │ │ │ │ │ + def __enter__(self) -> 'Handle': │ │ │ │ │ + return self │ │ │ │ │ + │ │ │ │ │ + def __exit__(self, _type: type, _value: object, _traceback: object) -> None: │ │ │ │ │ + self.close() │ │ │ │ │ + │ │ │ │ │ + @classmethod │ │ │ │ │ + def open(cls, *args: Any, **kwargs: Any) -> 'Handle': │ │ │ │ │ + return cls(os.open(*args, **kwargs)) │ │ │ │ │ + │ │ │ │ │ + def steal(self) -> 'Handle': │ │ │ │ │ + self._needs_close = False │ │ │ │ │ + return self.__class__(int(self)) │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class WatchInvalidator: │ │ │ │ │ + _name: bytes │ │ │ │ │ + _source: Optional[Event.Source] │ │ │ │ │ + _watch: Optional['PathWatch'] │ │ │ │ │ + │ │ │ │ │ + def event(self, mask: IN, _cookie: int, name: Optional[bytes]) -> None: │ │ │ │ │ + logger.debug('invalidator event %s %s', mask, name) │ │ │ │ │ + if self._watch is not None: │ │ │ │ │ + # If this node itself disappeared, that's definitely an │ │ │ │ │ + # invalidation. Otherwise, the name needs to match. │ │ │ │ │ + if IN.IGNORED in mask or self._name == name: │ │ │ │ │ + logger.debug('Invalidating!') │ │ │ │ │ + self._watch.invalidate() │ │ │ │ │ + │ │ │ │ │ + def __init__(self, watch: 'PathWatch', event: Event, dirfd: int, name: str): │ │ │ │ │ + self._watch = watch │ │ │ │ │ + self._name = name.encode('utf-8') │ │ │ │ │ + │ │ │ │ │ + # establishing invalidation watches is best-effort and can fail for a │ │ │ │ │ + # number of reasons, including search (+x) but not read (+r) permission │ │ │ │ │ + # on a particular path component, or exceeding limits on watches │ │ │ │ │ + try: │ │ │ │ │ + mask = IN.CREATE | IN.DELETE | IN.MOVE | IN.DELETE_SELF | IN.IGNORED │ │ │ │ │ + self._source = event.add_inotify_fd(dirfd, mask, self.event) │ │ │ │ │ + except OSError: │ │ │ │ │ + self._source = None │ │ │ │ │ + │ │ │ │ │ + def close(self) -> None: │ │ │ │ │ + # This is a little bit tricky: systemd doesn't have a specific close │ │ │ │ │ + # API outside of unref, so let's make it as explicit as possible. │ │ │ │ │ + self._watch = None │ │ │ │ │ + self._source = None │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class PathStack(List[str]): │ │ │ │ │ + def add_path(self, pathname: str) -> None: │ │ │ │ │ + # TO DO: consider doing something reasonable with trailing slashes │ │ │ │ │ + # this is a stack, popped from the end: push components in reverse │ │ │ │ │ + self.extend(item for item in reversed(pathname.split('/')) if item) │ │ │ │ │ + if pathname.startswith('/'): │ │ │ │ │ + self.append('/') │ │ │ │ │ + │ │ │ │ │ + def __init__(self, path: str): │ │ │ │ │ + super().__init__() │ │ │ │ │ + self.add_path(path) │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class Listener: │ │ │ │ │ + def do_inotify_event(self, mask: IN, cookie: int, name: Optional[bytes]) -> None: │ │ │ │ │ + raise NotImplementedError │ │ │ │ │ + │ │ │ │ │ + def do_identity_changed(self, fd: Optional[Handle], errno: Optional[int]) -> None: │ │ │ │ │ + raise NotImplementedError │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class PathWatch: │ │ │ │ │ + _event: Event │ │ │ │ │ + _listener: Listener │ │ │ │ │ + _path: str │ │ │ │ │ + _invalidators: List[WatchInvalidator] │ │ │ │ │ + _errno: Optional[int] │ │ │ │ │ + _source: Optional[Event.Source] │ │ │ │ │ + _tag: Optional[None] │ │ │ │ │ + _fd: Handle │ │ │ │ │ + │ │ │ │ │ + def __init__(self, path: str, listener: Listener, event: Optional[Event] = None): │ │ │ │ │ + self._event = event or Event.default() │ │ │ │ │ + self._path = path │ │ │ │ │ + self._listener = listener │ │ │ │ │ + │ │ │ │ │ + self._invalidators = [] │ │ │ │ │ + self._errno = None │ │ │ │ │ + self._source = None │ │ │ │ │ + self._tag = None │ │ │ │ │ + self._fd = Handle() │ │ │ │ │ + │ │ │ │ │ + self.invalidate() │ │ │ │ │ + │ │ │ │ │ + def got_event(self, mask: IN, cookie: int, name: Optional[bytes]) -> None: │ │ │ │ │ + logger.debug('target event %s: %s %s %s', self._path, mask, cookie, name) │ │ │ │ │ + self._listener.do_inotify_event(mask, cookie, name) │ │ │ │ │ + │ │ │ │ │ + def invalidate(self) -> None: │ │ │ │ │ + for invalidator in self._invalidators: │ │ │ │ │ + invalidator.close() │ │ │ │ │ + self._invalidators = [] │ │ │ │ │ + │ │ │ │ │ + try: │ │ │ │ │ + fd = self.walk() │ │ │ │ │ + except OSError as error: │ │ │ │ │ + logger.debug('walk ended in error %d', error.errno) │ │ │ │ │ + │ │ │ │ │ + if self._source or self._fd or self._errno != error.errno: │ │ │ │ │ + logger.debug('Ending existing watches.') │ │ │ │ │ + self._source = None │ │ │ │ │ + self._fd.close() │ │ │ │ │ + self._fd = Handle() │ │ │ │ │ + self._errno = error.errno │ │ │ │ │ + │ │ │ │ │ + logger.debug('Notifying of new error state %d', self._errno) │ │ │ │ │ + self._listener.do_identity_changed(None, self._errno) │ │ │ │ │ + │ │ │ │ │ + return │ │ │ │ │ + │ │ │ │ │ + with fd: │ │ │ │ │ + logger.debug('walk successful. Got fd %d', fd) │ │ │ │ │ + if fd == self._fd: │ │ │ │ │ + logger.debug('fd seems to refer to same file. Doing nothing.') │ │ │ │ │ + return │ │ │ │ │ + │ │ │ │ │ + logger.debug('This file is new for us. Removing old watch.') │ │ │ │ │ + self._source = None │ │ │ │ │ + self._fd.close() │ │ │ │ │ + self._fd = fd.steal() │ │ │ │ │ + │ │ │ │ │ + try: │ │ │ │ │ + logger.debug('Establishing a new watch.') │ │ │ │ │ + self._source = self._event.add_inotify_fd(self._fd, IN.CHANGED, self.got_event) │ │ │ │ │ + logger.debug('Watching successfully. Notifying of new identity.') │ │ │ │ │ + self._listener.do_identity_changed(self._fd, None) │ │ │ │ │ + except OSError as error: │ │ │ │ │ + logger.debug('Watching failed (%d). Notifying of new identity.', error.errno) │ │ │ │ │ + self._listener.do_identity_changed(self._fd, error.errno) │ │ │ │ │ + │ │ │ │ │ + def walk(self) -> Handle: │ │ │ │ │ + remaining_symlink_lookups = 40 │ │ │ │ │ + remaining_components = PathStack(self._path) │ │ │ │ │ + dirfd = Handle() │ │ │ │ │ + │ │ │ │ │ + try: │ │ │ │ │ + logger.debug('Starting path walk') │ │ │ │ │ + │ │ │ │ │ + while remaining_components: │ │ │ │ │ + logger.debug('r=%s dfd=%s', remaining_components, dirfd) │ │ │ │ │ + │ │ │ │ │ + name = remaining_components.pop() │ │ │ │ │ + │ │ │ │ │ + if dirfd and name != '/': │ │ │ │ │ + self._invalidators.append(WatchInvalidator(self, self._event, dirfd, name)) │ │ │ │ │ + │ │ │ │ │ + with Handle.open(name, os.O_PATH | os.O_NOFOLLOW | os.O_CLOEXEC, dir_fd=dirfd) as fd: │ │ │ │ │ + mode = os.fstat(fd).st_mode │ │ │ │ │ + │ │ │ │ │ + if stat.S_ISLNK(mode): │ │ │ │ │ + if remaining_symlink_lookups == 0: │ │ │ │ │ + raise OSError(errno.ELOOP, os.strerror(errno.ELOOP)) │ │ │ │ │ + remaining_symlink_lookups -= 1 │ │ │ │ │ + linkpath = os.readlink('', dir_fd=fd) │ │ │ │ │ + logger.debug('%s is a symlink. adding %s to components', name, linkpath) │ │ │ │ │ + remaining_components.add_path(linkpath) │ │ │ │ │ + │ │ │ │ │ + else: │ │ │ │ │ + dirfd.close() │ │ │ │ │ + dirfd = fd.steal() │ │ │ │ │ + │ │ │ │ │ + return dirfd.steal() │ │ │ │ │ + │ │ │ │ │ + finally: │ │ │ │ │ + dirfd.close() │ │ │ │ │ + │ │ │ │ │ + def close(self) -> None: │ │ │ │ │ + for invalidator in self._invalidators: │ │ │ │ │ + invalidator.close() │ │ │ │ │ + self._invalidators = [] │ │ │ │ │ + self._source = None │ │ │ │ │ + self._fd.close() │ │ │ │ │ +''', │ │ │ │ │ + 'cockpit/_vendor/systemd_ctypes/typing.py': br'''import typing │ │ │ │ │ +from typing import TYPE_CHECKING │ │ │ │ │ + │ │ │ │ │ +# The goal here is to continue to work on Python 3.6 while pretending to have │ │ │ │ │ +# access to some modern typing features. The shims provided here are only │ │ │ │ │ +# enough for what we need for systemd_ctypes to work at runtime. │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +if TYPE_CHECKING: │ │ │ │ │ + # See https://github.com/python/mypy/issues/1153 for why we do this separately │ │ │ │ │ + from typing import Annotated, ForwardRef, TypeGuard, get_args, get_origin │ │ │ │ │ + │ │ │ │ │ +else: │ │ │ │ │ + # typing.get_args() and .get_origin() appeared in Python 3.8 but Annotated │ │ │ │ │ + # arrived in 3.9. Unfortunately, it's difficult to implement a mocked up │ │ │ │ │ + # version of Annotated which works with the real typing.get_args() and │ │ │ │ │ + # .get_origin() in Python 3.8, so we use our own versions there as well. │ │ │ │ │ + try: │ │ │ │ │ + from typing import Annotated, get_args, get_origin │ │ │ │ │ + except ImportError: │ │ │ │ │ + class AnnotatedMeta(type): │ │ │ │ │ + def __getitem__(cls, params): │ │ │ │ │ + class AnnotatedType: │ │ │ │ │ + __origin__ = Annotated │ │ │ │ │ + __args__ = params │ │ │ │ │ + return AnnotatedType │ │ │ │ │ + │ │ │ │ │ + class Annotated(metaclass=AnnotatedMeta): │ │ │ │ │ + pass │ │ │ │ │ + │ │ │ │ │ + def get_args(annotation: typing.Any) -> typing.Tuple[typing.Any]: │ │ │ │ │ + return getattr(annotation, '__args__', ()) │ │ │ │ │ + │ │ │ │ │ + def get_origin(annotation: typing.Any) -> typing.Any: │ │ │ │ │ + return getattr(annotation, '__origin__', None) │ │ │ │ │ + │ │ │ │ │ + try: │ │ │ │ │ + from typing import ForwardRef │ │ │ │ │ + except ImportError: │ │ │ │ │ + from typing import _ForwardRef as ForwardRef │ │ │ │ │ + │ │ │ │ │ + try: │ │ │ │ │ + from typing import TypeGuard │ │ │ │ │ + except ImportError: │ │ │ │ │ + T = typing.TypeVar('T') │ │ │ │ │ + │ │ │ │ │ + class TypeGuard(typing.Generic[T]): │ │ │ │ │ + pass │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +__all__ = ( │ │ │ │ │ + 'Annotated', │ │ │ │ │ + 'ForwardRef', │ │ │ │ │ + 'TypeGuard', │ │ │ │ │ + 'get_args', │ │ │ │ │ + 'get_origin', │ │ │ │ │ + 'TYPE_CHECKING', │ │ │ │ │ +) │ │ │ │ │ +''', │ │ │ │ │ + 'cockpit/_vendor/systemd_ctypes/inotify.py': br'''# systemd_ctypes │ │ │ │ │ +# │ │ │ │ │ +# Copyright (C) 2022 Allison Karlitskaya │ │ │ │ │ +# │ │ │ │ │ +# This program is free software: you can redistribute it and/or modify │ │ │ │ │ +# it under the terms of the GNU General Public License as published by │ │ │ │ │ +# the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ +# (at your option) any later version. │ │ │ │ │ +# │ │ │ │ │ +# This program is distributed in the hope that it will be useful, │ │ │ │ │ +# but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ +# GNU General Public License for more details. │ │ │ │ │ +# │ │ │ │ │ +# You should have received a copy of the GNU General Public License │ │ │ │ │ +# along with this program. If not, see . │ │ │ │ │ + │ │ │ │ │ +import ctypes │ │ │ │ │ +from enum import IntFlag, auto │ │ │ │ │ +from typing import Optional │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class inotify_event(ctypes.Structure): │ │ │ │ │ + _fields_ = ( │ │ │ │ │ + ('wd', ctypes.c_int32), │ │ │ │ │ + ('mask', ctypes.c_uint32), │ │ │ │ │ + ('cookie', ctypes.c_uint32), │ │ │ │ │ + ('len', ctypes.c_uint32), │ │ │ │ │ + ) │ │ │ │ │ + │ │ │ │ │ + @property │ │ │ │ │ + def name(self) -> Optional[bytes]: │ │ │ │ │ + if self.len == 0: │ │ │ │ │ + return None │ │ │ │ │ + │ │ │ │ │ + class event_with_name(ctypes.Structure): │ │ │ │ │ + _fields_ = (*inotify_event._fields_, ('name', ctypes.c_char * self.len)) │ │ │ │ │ + │ │ │ │ │ + name = ctypes.cast(ctypes.addressof(self), ctypes.POINTER(event_with_name)).contents.name │ │ │ │ │ + assert isinstance(name, bytes) │ │ │ │ │ + return name │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +class Event(IntFlag): │ │ │ │ │ + ACCESS = auto() │ │ │ │ │ + MODIFY = auto() │ │ │ │ │ + ATTRIB = auto() │ │ │ │ │ + CLOSE_WRITE = auto() │ │ │ │ │ + CLOSE_NOWRITE = auto() │ │ │ │ │ + OPEN = auto() │ │ │ │ │ + MOVED_FROM = auto() │ │ │ │ │ + MOVED_TO = auto() │ │ │ │ │ + CREATE = auto() │ │ │ │ │ + DELETE = auto() │ │ │ │ │ + DELETE_SELF = auto() │ │ │ │ │ + MOVE_SELF = auto() │ │ │ │ │ + │ │ │ │ │ + UNMOUNT = 1 << 13 │ │ │ │ │ + Q_OVERFLOW = auto() │ │ │ │ │ + IGNORED = auto() │ │ │ │ │ + │ │ │ │ │ + ONLYDIR = 1 << 24 │ │ │ │ │ + DONT_FOLLOW = auto() │ │ │ │ │ + EXCL_UNLINK = auto() │ │ │ │ │ + │ │ │ │ │ + MASK_CREATE = 1 << 28 │ │ │ │ │ + MASK_ADD = auto() │ │ │ │ │ + ISDIR = auto() │ │ │ │ │ + ONESHOT = auto() │ │ │ │ │ + │ │ │ │ │ + CLOSE = CLOSE_WRITE | CLOSE_NOWRITE │ │ │ │ │ + MOVE = MOVED_FROM | MOVED_TO │ │ │ │ │ + CHANGED = (MODIFY | ATTRIB | CLOSE_WRITE | MOVE | │ │ │ │ │ + CREATE | DELETE | DELETE_SELF | MOVE_SELF) │ │ │ │ │ ''', │ │ │ │ │ 'cockpit/_vendor/systemd_ctypes/libsystemd.py': r'''# systemd_ctypes │ │ │ │ │ # │ │ │ │ │ # Copyright (C) 2022 Allison Karlitskaya │ │ │ │ │ # │ │ │ │ │ # This program is free software: you can redistribute it and/or modify │ │ │ │ │ # it under the terms of the GNU General Public License as published by │ │ │ │ │ @@ -8196,3327 +9944,1579 @@ │ │ │ │ │ sd_bus_message, │ │ │ │ │ sd_bus_slot, │ │ │ │ │ sd_event, │ │ │ │ │ sd_event_source, │ │ │ │ │ }: │ │ │ │ │ cls._install_cfuncs(libsystemd) │ │ │ │ │ '''.encode('utf-8'), │ │ │ │ │ - 'cockpit/_vendor/systemd_ctypes/typing.py': br'''import typing │ │ │ │ │ -from typing import TYPE_CHECKING │ │ │ │ │ - │ │ │ │ │ -# The goal here is to continue to work on Python 3.6 while pretending to have │ │ │ │ │ -# access to some modern typing features. The shims provided here are only │ │ │ │ │ -# enough for what we need for systemd_ctypes to work at runtime. │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -if TYPE_CHECKING: │ │ │ │ │ - # See https://github.com/python/mypy/issues/1153 for why we do this separately │ │ │ │ │ - from typing import Annotated, ForwardRef, TypeGuard, get_args, get_origin │ │ │ │ │ - │ │ │ │ │ -else: │ │ │ │ │ - # typing.get_args() and .get_origin() appeared in Python 3.8 but Annotated │ │ │ │ │ - # arrived in 3.9. Unfortunately, it's difficult to implement a mocked up │ │ │ │ │ - # version of Annotated which works with the real typing.get_args() and │ │ │ │ │ - # .get_origin() in Python 3.8, so we use our own versions there as well. │ │ │ │ │ - try: │ │ │ │ │ - from typing import Annotated, get_args, get_origin │ │ │ │ │ - except ImportError: │ │ │ │ │ - class AnnotatedMeta(type): │ │ │ │ │ - def __getitem__(cls, params): │ │ │ │ │ - class AnnotatedType: │ │ │ │ │ - __origin__ = Annotated │ │ │ │ │ - __args__ = params │ │ │ │ │ - return AnnotatedType │ │ │ │ │ - │ │ │ │ │ - class Annotated(metaclass=AnnotatedMeta): │ │ │ │ │ - pass │ │ │ │ │ - │ │ │ │ │ - def get_args(annotation: typing.Any) -> typing.Tuple[typing.Any]: │ │ │ │ │ - return getattr(annotation, '__args__', ()) │ │ │ │ │ - │ │ │ │ │ - def get_origin(annotation: typing.Any) -> typing.Any: │ │ │ │ │ - return getattr(annotation, '__origin__', None) │ │ │ │ │ - │ │ │ │ │ - try: │ │ │ │ │ - from typing import ForwardRef │ │ │ │ │ - except ImportError: │ │ │ │ │ - from typing import _ForwardRef as ForwardRef │ │ │ │ │ - │ │ │ │ │ - try: │ │ │ │ │ - from typing import TypeGuard │ │ │ │ │ - except ImportError: │ │ │ │ │ - T = typing.TypeVar('T') │ │ │ │ │ - │ │ │ │ │ - class TypeGuard(typing.Generic[T]): │ │ │ │ │ - pass │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -__all__ = ( │ │ │ │ │ - 'Annotated', │ │ │ │ │ - 'ForwardRef', │ │ │ │ │ - 'TypeGuard', │ │ │ │ │ - 'get_args', │ │ │ │ │ - 'get_origin', │ │ │ │ │ - 'TYPE_CHECKING', │ │ │ │ │ -) │ │ │ │ │ -''', │ │ │ │ │ - 'cockpit/_vendor/ferny/interaction_client.py': br'''#!/usr/bin/python3 │ │ │ │ │ - │ │ │ │ │ -import array │ │ │ │ │ -import io │ │ │ │ │ -import os │ │ │ │ │ -import socket │ │ │ │ │ -import sys │ │ │ │ │ -from typing import Sequence │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -def command(stderr_fd: int, command: str, *args: object, fds: Sequence[int] = ()) -> None: │ │ │ │ │ - cmd_read, cmd_write = [io.open(*end) for end in zip(os.pipe(), 'rw')] │ │ │ │ │ - │ │ │ │ │ - with cmd_write: │ │ │ │ │ - with cmd_read: │ │ │ │ │ - with socket.fromfd(stderr_fd, socket.AF_UNIX, socket.SOCK_STREAM) as sock: │ │ │ │ │ - fd_array = array.array('i', (cmd_read.fileno(), *fds)) │ │ │ │ │ - sock.sendmsg([b'\0'], [(socket.SOL_SOCKET, socket.SCM_RIGHTS, fd_array)]) │ │ │ │ │ - │ │ │ │ │ - cmd_write.write(repr((command, args))) │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -def askpass(stderr_fd: int, stdout_fd: int, args: 'list[str]', env: 'dict[str, str]') -> int: │ │ │ │ │ - ours, theirs = socket.socketpair() │ │ │ │ │ - │ │ │ │ │ - with theirs: │ │ │ │ │ - command(stderr_fd, 'ferny.askpass', args, env, fds=(theirs.fileno(), stdout_fd)) │ │ │ │ │ - │ │ │ │ │ - with ours: │ │ │ │ │ - return int(ours.recv(16) or b'1') │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -def main() -> None: │ │ │ │ │ - if len(sys.argv) == 1: │ │ │ │ │ - command(2, 'ferny.end', []) │ │ │ │ │ - else: │ │ │ │ │ - sys.exit(askpass(2, 1, sys.argv, dict(os.environ))) │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -if __name__ == '__main__': │ │ │ │ │ - main() │ │ │ │ │ -''', │ │ │ │ │ - 'cockpit/_vendor/ferny/interaction_agent.py': r'''# ferny - asyncio SSH client library, using ssh(1) │ │ │ │ │ + 'cockpit/_vendor/systemd_ctypes/bus.py': br'''# systemd_ctypes │ │ │ │ │ # │ │ │ │ │ -# Copyright (C) 2023 Allison Karlitskaya │ │ │ │ │ +# Copyright (C) 2022 Allison Karlitskaya │ │ │ │ │ # │ │ │ │ │ # This program is free software: you can redistribute it and/or modify │ │ │ │ │ # it under the terms of the GNU General Public License as published by │ │ │ │ │ # the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ # (at your option) any later version. │ │ │ │ │ # │ │ │ │ │ # This program is distributed in the hope that it will be useful, │ │ │ │ │ # but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ # GNU General Public License for more details. │ │ │ │ │ # │ │ │ │ │ # You should have received a copy of the GNU General Public License │ │ │ │ │ # along with this program. If not, see . │ │ │ │ │ │ │ │ │ │ -import array │ │ │ │ │ -import ast │ │ │ │ │ import asyncio │ │ │ │ │ -import contextlib │ │ │ │ │ +import enum │ │ │ │ │ import logging │ │ │ │ │ -import os │ │ │ │ │ -import re │ │ │ │ │ -import socket │ │ │ │ │ -import tempfile │ │ │ │ │ -from typing import Any, Callable, ClassVar, Generator, Sequence │ │ │ │ │ +import typing │ │ │ │ │ +from typing import Any, Callable, Dict, Optional, Sequence, Tuple, Union │ │ │ │ │ │ │ │ │ │ -from . import interaction_client │ │ │ │ │ +from . import bustypes, introspection, libsystemd │ │ │ │ │ +from .librarywrapper import WeakReference, byref │ │ │ │ │ │ │ │ │ │ logger = logging.getLogger(__name__) │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ -COMMAND_RE = re.compile(b'\0ferny\0([^\n]*)\0\0\n') │ │ │ │ │ -COMMAND_TEMPLATE = '\0ferny\0{(command, args)!r}\0\0\n' │ │ │ │ │ - │ │ │ │ │ -BEIBOOT_GADGETS = { │ │ │ │ │ - "command": fr""" │ │ │ │ │ - import sys │ │ │ │ │ - def command(command, *args): │ │ │ │ │ - sys.stderr.write(f{COMMAND_TEMPLATE!r}) │ │ │ │ │ - sys.stderr.flush() │ │ │ │ │ - """, │ │ │ │ │ - "end": r""" │ │ │ │ │ - def end(): │ │ │ │ │ - command('ferny.end') │ │ │ │ │ - """, │ │ │ │ │ -} │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -class InteractionError(Exception): │ │ │ │ │ - pass │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -try: │ │ │ │ │ - recv_fds = socket.recv_fds │ │ │ │ │ -except AttributeError: │ │ │ │ │ - # Python < 3.9 │ │ │ │ │ - │ │ │ │ │ - def recv_fds( │ │ │ │ │ - sock: socket.socket, bufsize: int, maxfds: int, flags: int = 0 │ │ │ │ │ - ) -> 'tuple[bytes, list[int], int, None]': │ │ │ │ │ - fds = array.array("i") │ │ │ │ │ - msg, ancdata, flags, addr = sock.recvmsg(bufsize, socket.CMSG_LEN(maxfds * fds.itemsize)) │ │ │ │ │ - for cmsg_level, cmsg_type, cmsg_data in ancdata: │ │ │ │ │ - if (cmsg_level == socket.SOL_SOCKET and cmsg_type == socket.SCM_RIGHTS): │ │ │ │ │ - fds.frombytes(cmsg_data[:len(cmsg_data) - (len(cmsg_data) % fds.itemsize)]) │ │ │ │ │ - return msg, list(fds), flags, addr │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -def get_running_loop() -> asyncio.AbstractEventLoop: │ │ │ │ │ - try: │ │ │ │ │ - return asyncio.get_running_loop() │ │ │ │ │ - except AttributeError: │ │ │ │ │ - # Python 3.6 │ │ │ │ │ - return asyncio.get_event_loop() │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -class InteractionHandler: │ │ │ │ │ - commands: ClassVar[Sequence[str]] │ │ │ │ │ - │ │ │ │ │ - async def run_command(self, command: str, args: 'tuple[object, ...]', fds: 'list[int]', stderr: str) -> None: │ │ │ │ │ - raise NotImplementedError │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -class AskpassHandler(InteractionHandler): │ │ │ │ │ - commands: ClassVar[Sequence[str]] = ('ferny.askpass',) │ │ │ │ │ - │ │ │ │ │ - async def do_askpass(self, messages: str, prompt: str, hint: str) -> 'str | None': │ │ │ │ │ - """Prompt the user for an authentication or confirmation interaction. │ │ │ │ │ - │ │ │ │ │ - 'messages' is data that was sent to stderr before the interaction was requested. │ │ │ │ │ - 'prompt' is the interaction prompt. │ │ │ │ │ - │ │ │ │ │ - The expected response type depends on hint: │ │ │ │ │ +class BusError(Exception): │ │ │ │ │ + """An exception corresponding to a D-Bus error message │ │ │ │ │ │ │ │ │ │ - - "confirm": ask for permission, returning "yes" if accepted │ │ │ │ │ - - example: authorizing agent operation │ │ │ │ │ + This exception is raised by the method call methods. You can also raise it │ │ │ │ │ + from your own method handlers. It can also be passed directly to functions │ │ │ │ │ + such as Message.reply_method_error(). │ │ │ │ │ │ │ │ │ │ - - "none": show a request without need for a response │ │ │ │ │ - - example: please touch your authentication token │ │ │ │ │ + :name: the 'code' of the error, like org.freedesktop.DBus.Error.UnknownMethod │ │ │ │ │ + :message: a human-readable description of the error │ │ │ │ │ + """ │ │ │ │ │ + def __init__(self, name: str, message: str): │ │ │ │ │ + super().__init__(f'{name}: {message}') │ │ │ │ │ + self.name = name │ │ │ │ │ + self.message = message │ │ │ │ │ │ │ │ │ │ - - otherwise: return a password or other form of text token │ │ │ │ │ - - examples: enter password, unlock private key │ │ │ │ │ │ │ │ │ │ - In any case, the function should properly handle cancellation. For the │ │ │ │ │ - "none" case, this will be the normal way to dismiss the dialog. │ │ │ │ │ - """ │ │ │ │ │ - return None │ │ │ │ │ +class BusMessage(libsystemd.sd_bus_message): │ │ │ │ │ + """A message, received from or to be sent over D-Bus │ │ │ │ │ │ │ │ │ │ - async def do_hostkey(self, reason: str, host: str, algorithm: str, key: str, fingerprint: str) -> bool: │ │ │ │ │ - """Prompt the user for a decision regarding acceptance of a host key. │ │ │ │ │ + This is the low-level interface to receiving and sending individual │ │ │ │ │ + messages over D-Bus. You won't normally need to use it. │ │ │ │ │ │ │ │ │ │ - The "reason" will be either "HOSTNAME" or "ADDRESS" (if `CheckHostIP` is enabled). │ │ │ │ │ + A message is associated with a particular bus. You can create messages for │ │ │ │ │ + a bus with Bus.message_new_method_call() or Bus.message_new_signal(). You │ │ │ │ │ + can create replies to method calls with Message.new_method_return() or │ │ │ │ │ + Message.new_method_error(). You can append arguments with Message.append() │ │ │ │ │ + and send the message with Message.send(). │ │ │ │ │ + """ │ │ │ │ │ + def get_bus(self) -> 'Bus': │ │ │ │ │ + """Get the bus that a message is associated with. │ │ │ │ │ │ │ │ │ │ - The host, algorithm, and key parameters are the values in the form that │ │ │ │ │ - they would appear one a single line in the known hosts file. The │ │ │ │ │ - fingerprint is the key fingerprint in the format that ssh would │ │ │ │ │ - normally present it to the user. │ │ │ │ │ + This is the bus that a message came from or will be sent on. Every │ │ │ │ │ + message has an associated bus, and it cannot be changed. │ │ │ │ │ │ │ │ │ │ - In case the host key should be accepted, this function needs to return │ │ │ │ │ - True. Returning False means that ssh implements its default logic. To │ │ │ │ │ - interrupt the connection, raise an exception. │ │ │ │ │ + :returns: the Bus │ │ │ │ │ """ │ │ │ │ │ - return False │ │ │ │ │ - │ │ │ │ │ - async def do_custom_command( │ │ │ │ │ - self, command: str, args: 'tuple[object, ...]', fds: 'list[int]', stderr: str │ │ │ │ │ - ) -> None: │ │ │ │ │ - """Handle a custom command. │ │ │ │ │ + return Bus.ref(self._get_bus()) │ │ │ │ │ │ │ │ │ │ - The command name, its arguments, the passed fds, and the stderr leading │ │ │ │ │ - up to the command invocation are all provided. │ │ │ │ │ + def get_error(self) -> Optional[BusError]: │ │ │ │ │ + """Get the BusError from a message. │ │ │ │ │ │ │ │ │ │ - See doc/interaction-protocol.md │ │ │ │ │ + :returns: a BusError for an error message, or None for a non-error message │ │ │ │ │ """ │ │ │ │ │ - │ │ │ │ │ - async def _askpass_command(self, args: 'tuple[object, ...]', fds: 'list[int]', stderr: str) -> None: │ │ │ │ │ - logger.debug('_askpass_command(%s, %s, %s)', args, fds, stderr) │ │ │ │ │ - try: │ │ │ │ │ - argv, env = args │ │ │ │ │ - assert isinstance(argv, list) │ │ │ │ │ - assert all(isinstance(arg, str) for arg in argv) │ │ │ │ │ - assert isinstance(env, dict) │ │ │ │ │ - assert all(isinstance(key, str) and isinstance(val, str) for key, val in env.items()) │ │ │ │ │ - assert len(fds) == 2 │ │ │ │ │ - except (ValueError, TypeError, AssertionError) as exc: │ │ │ │ │ - logger.error('Invalid arguments to askpass interaction: %s, %s: %s', args, fds, exc) │ │ │ │ │ - return │ │ │ │ │ - │ │ │ │ │ - with open(fds.pop(0), 'w') as status, open(fds.pop(0), 'w') as stdout: │ │ │ │ │ - try: │ │ │ │ │ - loop = get_running_loop() │ │ │ │ │ - try: │ │ │ │ │ - task = asyncio.current_task() │ │ │ │ │ - except AttributeError: │ │ │ │ │ - task = asyncio.Task.current_task() # type:ignore[attr-defined] # (Python 3.6) │ │ │ │ │ - assert task is not None │ │ │ │ │ - loop.add_reader(status, task.cancel) │ │ │ │ │ - │ │ │ │ │ - if len(argv) == 2: │ │ │ │ │ - # normal askpass │ │ │ │ │ - prompt = argv[1] │ │ │ │ │ - hint = env.get('SSH_ASKPASS_PROMPT', '') │ │ │ │ │ - logger.debug('do_askpass(%r, %r, %r)', stderr, prompt, hint) │ │ │ │ │ - answer = await self.do_askpass(stderr, prompt, hint) │ │ │ │ │ - logger.debug('do_askpass answer %r', answer) │ │ │ │ │ - if answer is not None: │ │ │ │ │ - print(answer, file=stdout) │ │ │ │ │ - print(0, file=status) │ │ │ │ │ - │ │ │ │ │ - elif len(argv) == 6: │ │ │ │ │ - # KnownHostsCommand │ │ │ │ │ - argv0, reason, host, algorithm, key, fingerprint = argv │ │ │ │ │ - if reason in ['ADDRESS', 'HOSTNAME']: │ │ │ │ │ - logger.debug('do_hostkey(%r, %r, %r, %r, %r)', reason, host, algorithm, key, fingerprint) │ │ │ │ │ - if await self.do_hostkey(reason, host, algorithm, key, fingerprint): │ │ │ │ │ - print(host, algorithm, key, file=stdout) │ │ │ │ │ - else: │ │ │ │ │ - logger.debug('ignoring KnownHostsCommand reason %r', reason) │ │ │ │ │ - │ │ │ │ │ - print(0, file=status) │ │ │ │ │ - │ │ │ │ │ - else: │ │ │ │ │ - logger.error('Incorrect number of command-line arguments to ferny-askpass: %s', argv) │ │ │ │ │ - finally: │ │ │ │ │ - loop.remove_reader(status) │ │ │ │ │ - │ │ │ │ │ - async def run_command(self, command: str, args: 'tuple[object, ...]', fds: 'list[int]', stderr: str) -> None: │ │ │ │ │ - logger.debug('run_command(%s, %s, %s, %s)', command, args, fds, stderr) │ │ │ │ │ - if command == 'ferny.askpass': │ │ │ │ │ - await self._askpass_command(args, fds, stderr) │ │ │ │ │ - else: │ │ │ │ │ - await self.do_custom_command(command, args, fds, stderr) │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -class InteractionAgent: │ │ │ │ │ - _handlers: 'dict[str, InteractionHandler]' │ │ │ │ │ - │ │ │ │ │ - _loop: asyncio.AbstractEventLoop │ │ │ │ │ - │ │ │ │ │ - _tasks: 'set[asyncio.Task]' │ │ │ │ │ - │ │ │ │ │ - _buffer: bytearray │ │ │ │ │ - _ours: socket.socket │ │ │ │ │ - _theirs: socket.socket │ │ │ │ │ - │ │ │ │ │ - _completion_future: 'asyncio.Future[str]' │ │ │ │ │ - _pending_result: 'None | str | Exception' = None │ │ │ │ │ - _end: bool = False │ │ │ │ │ - │ │ │ │ │ - def _consider_completion(self) -> None: │ │ │ │ │ - logger.debug('_consider_completion(%r)', self) │ │ │ │ │ - │ │ │ │ │ - if self._pending_result is None or self._tasks: │ │ │ │ │ - logger.debug(' but not ready yet') │ │ │ │ │ - │ │ │ │ │ - elif self._completion_future.done(): │ │ │ │ │ - logger.debug(' but already complete') │ │ │ │ │ - │ │ │ │ │ - elif isinstance(self._pending_result, str): │ │ │ │ │ - logger.debug(' submitting stderr (%r) to completion_future', self._pending_result) │ │ │ │ │ - self._completion_future.set_result(self._pending_result) │ │ │ │ │ - │ │ │ │ │ + error = self._get_error() │ │ │ │ │ + if error: │ │ │ │ │ + return BusError(*error.contents.get()) │ │ │ │ │ else: │ │ │ │ │ - logger.debug(' submitting exception (%r) to completion_future') │ │ │ │ │ - self._completion_future.set_exception(self._pending_result) │ │ │ │ │ - │ │ │ │ │ - def _result(self, result: 'str | Exception') -> None: │ │ │ │ │ - logger.debug('_result(%r, %r)', self, result) │ │ │ │ │ - │ │ │ │ │ - if self._pending_result is None: │ │ │ │ │ - self._pending_result = result │ │ │ │ │ - │ │ │ │ │ - if self._ours.fileno() != -1: │ │ │ │ │ - logger.debug(' remove_reader(%r)', self._ours) │ │ │ │ │ - self._loop.remove_reader(self._ours.fileno()) │ │ │ │ │ - │ │ │ │ │ - for task in self._tasks: │ │ │ │ │ - logger.debug(' cancel(%r)', task) │ │ │ │ │ - task.cancel() │ │ │ │ │ - │ │ │ │ │ - logger.debug(' closing sockets') │ │ │ │ │ - self._theirs.close() # idempotent │ │ │ │ │ - self._ours.close() │ │ │ │ │ - │ │ │ │ │ - self._consider_completion() │ │ │ │ │ - │ │ │ │ │ - def _invoke_command(self, stderr: bytes, command_blob: bytes, fds: 'list[int]') -> None: │ │ │ │ │ - logger.debug('_invoke_command(%r, %r, %r)', stderr, command_blob, fds) │ │ │ │ │ - try: │ │ │ │ │ - command, args = ast.literal_eval(command_blob.decode()) │ │ │ │ │ - if not isinstance(command, str) or not isinstance(args, tuple): │ │ │ │ │ - raise TypeError('Invalid argument types') │ │ │ │ │ - except (UnicodeDecodeError, SyntaxError, ValueError, TypeError) as exc: │ │ │ │ │ - logger.error('Received invalid ferny command: %s: %s', command_blob, exc) │ │ │ │ │ - return │ │ │ │ │ - │ │ │ │ │ - if command == 'ferny.end': │ │ │ │ │ - self._end = True │ │ │ │ │ - self._result(self._buffer.decode(errors='replace')) │ │ │ │ │ - return │ │ │ │ │ - │ │ │ │ │ - try: │ │ │ │ │ - handler = self._handlers[command] │ │ │ │ │ - except KeyError: │ │ │ │ │ - logger.error('Received unhandled ferny command: %s', command) │ │ │ │ │ - return │ │ │ │ │ - │ │ │ │ │ - # The task is responsible for the list of fds and removing itself │ │ │ │ │ - # from the set. │ │ │ │ │ - task_fds = list(fds) │ │ │ │ │ - task = self._loop.create_task(handler.run_command(command, args, task_fds, stderr.decode())) │ │ │ │ │ - │ │ │ │ │ - def bottom_half(completed_task: asyncio.Task) -> None: │ │ │ │ │ - assert completed_task is task │ │ │ │ │ - while task_fds: │ │ │ │ │ - os.close(task_fds.pop()) │ │ │ │ │ - self._tasks.remove(task) │ │ │ │ │ - │ │ │ │ │ - try: │ │ │ │ │ - task.result() │ │ │ │ │ - logger.debug('%r completed cleanly', handler) │ │ │ │ │ - except asyncio.CancelledError: │ │ │ │ │ - # this is not an error — it just means ferny-askpass exited via signal │ │ │ │ │ - logger.debug('%r was cancelled', handler) │ │ │ │ │ - except Exception as exc: │ │ │ │ │ - logger.debug('%r raised %r', handler, exc) │ │ │ │ │ - self._result(exc) │ │ │ │ │ - │ │ │ │ │ - self._consider_completion() │ │ │ │ │ - │ │ │ │ │ - task.add_done_callback(bottom_half) │ │ │ │ │ - self._tasks.add(task) │ │ │ │ │ - fds[:] = [] │ │ │ │ │ - │ │ │ │ │ - def _got_data(self, data: bytes, fds: 'list[int]') -> None: │ │ │ │ │ - logger.debug('_got_data(%r, %r)', data, fds) │ │ │ │ │ - │ │ │ │ │ - if data == b'': │ │ │ │ │ - self._result(self._buffer.decode(errors='replace')) │ │ │ │ │ - return │ │ │ │ │ - │ │ │ │ │ - self._buffer.extend(data) │ │ │ │ │ - │ │ │ │ │ - # Read zero or more "remote" messages │ │ │ │ │ - chunks = COMMAND_RE.split(self._buffer) │ │ │ │ │ - self._buffer = bytearray(chunks.pop()) │ │ │ │ │ - while len(chunks) > 1: │ │ │ │ │ - self._invoke_command(chunks[0], chunks[1], []) │ │ │ │ │ - chunks = chunks[2:] │ │ │ │ │ + return None │ │ │ │ │ │ │ │ │ │ - # Maybe read one "local" message │ │ │ │ │ - if fds: │ │ │ │ │ - assert self._buffer.endswith(b'\0'), self._buffer │ │ │ │ │ - stderr = self._buffer[:-1] │ │ │ │ │ - self._buffer = bytearray(b'') │ │ │ │ │ - with open(fds.pop(0), 'rb') as command_channel: │ │ │ │ │ - command = command_channel.read() │ │ │ │ │ - self._invoke_command(stderr, command, fds) │ │ │ │ │ + def new_method_return(self, signature: str = '', *args: Any) -> 'BusMessage': │ │ │ │ │ + """Create a new (successful) return message as a reply to this message. │ │ │ │ │ │ │ │ │ │ - def _read_ready(self) -> None: │ │ │ │ │ - try: │ │ │ │ │ - data, fds, _flags, _addr = recv_fds(self._ours, 4096, 10, flags=socket.MSG_DONTWAIT) │ │ │ │ │ - except BlockingIOError: │ │ │ │ │ - return │ │ │ │ │ - except OSError as exc: │ │ │ │ │ - self._result(exc) │ │ │ │ │ - else: │ │ │ │ │ - self._got_data(data, fds) │ │ │ │ │ - finally: │ │ │ │ │ - while fds: │ │ │ │ │ - os.close(fds.pop()) │ │ │ │ │ + This only makes sense when performed on a method call message. │ │ │ │ │ │ │ │ │ │ - def __init__( │ │ │ │ │ - self, │ │ │ │ │ - handlers: Sequence[InteractionHandler], │ │ │ │ │ - loop: 'asyncio.AbstractEventLoop | None' = None, │ │ │ │ │ - done_callback: 'Callable[[asyncio.Future[str]], None] | None' = None, │ │ │ │ │ - ) -> None: │ │ │ │ │ - self._loop = loop or get_running_loop() │ │ │ │ │ - self._completion_future = self._loop.create_future() │ │ │ │ │ - self._tasks = set() │ │ │ │ │ - self._handlers = {} │ │ │ │ │ + :signature: The signature of the result, as a string. │ │ │ │ │ + :args: The values to send, conforming to the signature string. │ │ │ │ │ │ │ │ │ │ - for handler in handlers: │ │ │ │ │ - for command in handler.commands: │ │ │ │ │ - self._handlers[command] = handler │ │ │ │ │ + :returns: the reply message │ │ │ │ │ + """ │ │ │ │ │ + reply = BusMessage() │ │ │ │ │ + self._new_method_return(byref(reply)) │ │ │ │ │ + reply.append(signature, *args) │ │ │ │ │ + return reply │ │ │ │ │ │ │ │ │ │ - if done_callback is not None: │ │ │ │ │ - self._completion_future.add_done_callback(done_callback) │ │ │ │ │ + def new_method_error(self, error: Union[BusError, OSError]) -> 'BusMessage': │ │ │ │ │ + """Create a new error message as a reply to this message. │ │ │ │ │ │ │ │ │ │ - self._theirs, self._ours = socket.socketpair(socket.AF_UNIX, socket.SOCK_STREAM) │ │ │ │ │ - self._buffer = bytearray() │ │ │ │ │ + This only makes sense when performed on a method call message. │ │ │ │ │ │ │ │ │ │ - def fileno(self) -> int: │ │ │ │ │ - return self._theirs.fileno() │ │ │ │ │ + :error: BusError or OSError of the error to send │ │ │ │ │ │ │ │ │ │ - def start(self) -> None: │ │ │ │ │ - logger.debug('start(%r)', self) │ │ │ │ │ - if self._ours.fileno() != -1: │ │ │ │ │ - logger.debug(' add_reader(%r)', self._ours) │ │ │ │ │ - self._loop.add_reader(self._ours.fileno(), self._read_ready) │ │ │ │ │ + :returns: the reply message │ │ │ │ │ + """ │ │ │ │ │ + reply = BusMessage() │ │ │ │ │ + if isinstance(error, BusError): │ │ │ │ │ + self._new_method_errorf(byref(reply), error.name, "%s", error.message) │ │ │ │ │ else: │ │ │ │ │ - logger.debug(' ...but agent is already finished.') │ │ │ │ │ - │ │ │ │ │ - logger.debug(' close(%r)', self._theirs) │ │ │ │ │ - self._theirs.close() │ │ │ │ │ - │ │ │ │ │ - def force_completion(self) -> None: │ │ │ │ │ - logger.debug('force_completion(%r)', self) │ │ │ │ │ + assert isinstance(error, OSError) │ │ │ │ │ + self._new_method_errnof(byref(reply), error.errno, "%s", str(error)) │ │ │ │ │ + return reply │ │ │ │ │ │ │ │ │ │ - # read any residual data on stderr, but don't process commands, and │ │ │ │ │ - # don't block │ │ │ │ │ - try: │ │ │ │ │ - if self._ours.fileno() != -1: │ │ │ │ │ - logger.debug(' draining pending stderr data (non-blocking)') │ │ │ │ │ - with contextlib.suppress(BlockingIOError): │ │ │ │ │ - while True: │ │ │ │ │ - data = self._ours.recv(4096, socket.MSG_DONTWAIT) │ │ │ │ │ - logger.debug(' got %d bytes', len(data)) │ │ │ │ │ - if not data: │ │ │ │ │ - break │ │ │ │ │ - self._buffer.extend(data) │ │ │ │ │ - except OSError as exc: │ │ │ │ │ - self._result(exc) │ │ │ │ │ - else: │ │ │ │ │ - self._result(self._buffer.decode(errors='replace')) │ │ │ │ │ + def append_arg(self, typestring: str, arg: Any) -> None: │ │ │ │ │ + """Append a single argument to the message. │ │ │ │ │ │ │ │ │ │ - async def communicate(self) -> None: │ │ │ │ │ - logger.debug('_communicate(%r)', self) │ │ │ │ │ - try: │ │ │ │ │ - self.start() │ │ │ │ │ - # We assume that we are the only ones to write to │ │ │ │ │ - # self._completion_future. If we directly await it, though, it can │ │ │ │ │ - # also have a asyncio.CancelledError posted to it from outside. │ │ │ │ │ - # Shield it to prevent that from happening. │ │ │ │ │ - stderr = await asyncio.shield(self._completion_future) │ │ │ │ │ - logger.debug('_communicate(%r) stderr result is %r', self, stderr) │ │ │ │ │ - finally: │ │ │ │ │ - logger.debug('_communicate finished. Ensuring completion.') │ │ │ │ │ - self.force_completion() │ │ │ │ │ - if not self._end: │ │ │ │ │ - logger.debug('_communicate never saw ferny.end. raising InteractionError.') │ │ │ │ │ - raise InteractionError(stderr.strip()) │ │ │ │ │ + :typestring: a single typestring, such as 's', or 'a{sv}' │ │ │ │ │ + :arg: the argument to append, matching the typestring │ │ │ │ │ + """ │ │ │ │ │ + type_, = bustypes.from_signature(typestring) │ │ │ │ │ + type_.writer(self, arg) │ │ │ │ │ │ │ │ │ │ + def append(self, signature: str, *args: Any) -> None: │ │ │ │ │ + """Append zero or more arguments to the message. │ │ │ │ │ │ │ │ │ │ -def write_askpass_to_tmpdir(tmpdir: str) -> str: │ │ │ │ │ - askpass_path = os.path.join(tmpdir, 'ferny-askpass') │ │ │ │ │ - fd = os.open(askpass_path, os.O_CREAT | os.O_WRONLY | os.O_CLOEXEC | os.O_EXCL | os.O_NOFOLLOW, 0o777) │ │ │ │ │ - try: │ │ │ │ │ - os.write(fd, __loader__.get_data(interaction_client.__file__)) # type: ignore │ │ │ │ │ - finally: │ │ │ │ │ - os.close(fd) │ │ │ │ │ - return askpass_path │ │ │ │ │ + :signature: concatenated typestrings, such 'a{sv}' (one arg), or 'ss' (two args) │ │ │ │ │ + :args: one argument for each type string in the signature │ │ │ │ │ + """ │ │ │ │ │ + types = bustypes.from_signature(signature) │ │ │ │ │ + assert len(types) == len(args), f'call args {args} have different length than signature {signature}' │ │ │ │ │ + for type_, arg in zip(types, args): │ │ │ │ │ + type_.writer(self, arg) │ │ │ │ │ │ │ │ │ │ + def get_body(self) -> Tuple[object, ...]: │ │ │ │ │ + """Gets the body of a message. │ │ │ │ │ │ │ │ │ │ -@contextlib.contextmanager │ │ │ │ │ -def temporary_askpass(**kwargs: Any) -> Generator[str, None, None]: │ │ │ │ │ - with tempfile.TemporaryDirectory(**kwargs) as directory: │ │ │ │ │ - yield write_askpass_to_tmpdir(directory) │ │ │ │ │ -'''.encode('utf-8'), │ │ │ │ │ - 'cockpit/_vendor/ferny/session.py': r'''# ferny - asyncio SSH client library, using ssh(1) │ │ │ │ │ -# │ │ │ │ │ -# Copyright (C) 2022 Allison Karlitskaya │ │ │ │ │ -# │ │ │ │ │ -# This program is free software: you can redistribute it and/or modify │ │ │ │ │ -# it under the terms of the GNU General Public License as published by │ │ │ │ │ -# the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ -# (at your option) any later version. │ │ │ │ │ -# │ │ │ │ │ -# This program is distributed in the hope that it will be useful, │ │ │ │ │ -# but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ -# GNU General Public License for more details. │ │ │ │ │ -# │ │ │ │ │ -# You should have received a copy of the GNU General Public License │ │ │ │ │ -# along with this program. If not, see . │ │ │ │ │ + Possible return values are (), ('single',), or ('x', 'y'). If you │ │ │ │ │ + check the signature of the message using Message.has_signature() then │ │ │ │ │ + you can use tuple unpacking. │ │ │ │ │ │ │ │ │ │ -import asyncio │ │ │ │ │ -import ctypes │ │ │ │ │ -import functools │ │ │ │ │ -import logging │ │ │ │ │ -import os │ │ │ │ │ -import shlex │ │ │ │ │ -import signal │ │ │ │ │ -import subprocess │ │ │ │ │ -import tempfile │ │ │ │ │ -from typing import Mapping, Sequence │ │ │ │ │ + single, = message.get_body() │ │ │ │ │ │ │ │ │ │ -from . import ssh_errors │ │ │ │ │ -from .interaction_agent import InteractionAgent, InteractionError, InteractionHandler, write_askpass_to_tmpdir │ │ │ │ │ + x, y = other_message.get_body() │ │ │ │ │ │ │ │ │ │ -prctl = ctypes.cdll.LoadLibrary('libc.so.6').prctl │ │ │ │ │ -logger = logging.getLogger(__name__) │ │ │ │ │ -PR_SET_PDEATHSIG = 1 │ │ │ │ │ + :returns: an n-tuple containing one value per argument in the message │ │ │ │ │ + """ │ │ │ │ │ + self.rewind(True) │ │ │ │ │ + types = bustypes.from_signature(self.get_signature(True)) │ │ │ │ │ + return tuple(type_.reader(self) for type_ in types) │ │ │ │ │ │ │ │ │ │ + def send(self) -> bool: # Literal[True] │ │ │ │ │ + """Sends a message on the bus that it was created for. │ │ │ │ │ │ │ │ │ │ -@functools.lru_cache() │ │ │ │ │ -def has_feature(feature: str, teststr: str = 'x') -> bool: │ │ │ │ │ - try: │ │ │ │ │ - subprocess.check_output(['ssh', f'-o{feature} {teststr}', '-G', 'nonexisting'], stderr=subprocess.DEVNULL) │ │ │ │ │ + :returns: True │ │ │ │ │ + """ │ │ │ │ │ + self.get_bus().send(self, None) │ │ │ │ │ return True │ │ │ │ │ - except subprocess.CalledProcessError: │ │ │ │ │ - return False │ │ │ │ │ │ │ │ │ │ + def reply_method_error(self, error: Union[BusError, OSError]) -> bool: # Literal[True] │ │ │ │ │ + """Sends an error as a reply to a method call message. │ │ │ │ │ │ │ │ │ │ -class SubprocessContext: │ │ │ │ │ - def wrap_subprocess_args(self, args: Sequence[str]) -> Sequence[str]: │ │ │ │ │ - """Return the args required to launch a process in the given context. │ │ │ │ │ - │ │ │ │ │ - For example, this might return a vector with │ │ │ │ │ - ["sudo"] │ │ │ │ │ - or │ │ │ │ │ - ["flatpak-spawn", "--host"] │ │ │ │ │ - prepended. │ │ │ │ │ - │ │ │ │ │ - It is also possible that more substantial changes may be performed. │ │ │ │ │ + :error: A BusError or OSError │ │ │ │ │ │ │ │ │ │ - This function is not permitted to modify its argument, although it may │ │ │ │ │ - (optionally) return it unmodified, if no changes are required. │ │ │ │ │ + :returns: True │ │ │ │ │ """ │ │ │ │ │ - return args │ │ │ │ │ + return self.new_method_error(error).send() │ │ │ │ │ │ │ │ │ │ - def wrap_subprocess_env(self, env: Mapping[str, str]) -> Mapping[str, str]: │ │ │ │ │ - """Return the envp required to launch a process in the given context. │ │ │ │ │ + def reply_method_return(self, signature: str = '', *args: Any) -> bool: # Literal[True] │ │ │ │ │ + """Sends a return value as a reply to a method call message. │ │ │ │ │ │ │ │ │ │ - For example, this might set the "SUDO_ASKPASS" environment variable, if │ │ │ │ │ - needed. │ │ │ │ │ + :signature: The signature of the result, as a string. │ │ │ │ │ + :args: The values to send, conforming to the signature string. │ │ │ │ │ │ │ │ │ │ - As with wrap_subprocess_args(), this function is not permitted to │ │ │ │ │ - modify its argument, although it may (optionally) return it unmodified │ │ │ │ │ - if no changes are required. │ │ │ │ │ + :returns: True │ │ │ │ │ """ │ │ │ │ │ - return env │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -class Session(SubprocessContext, InteractionHandler): │ │ │ │ │ - # Set after .connect() called, even if failed │ │ │ │ │ - _controldir: 'tempfile.TemporaryDirectory | None' = None │ │ │ │ │ - _controlsock: 'str | None' = None │ │ │ │ │ - │ │ │ │ │ - # Set if connected, else None │ │ │ │ │ - _process: 'asyncio.subprocess.Process | None' = None │ │ │ │ │ - │ │ │ │ │ - async def connect(self, │ │ │ │ │ - destination: str, │ │ │ │ │ - handle_host_key: bool = False, │ │ │ │ │ - configfile: 'str | None' = None, │ │ │ │ │ - identity_file: 'str | None' = None, │ │ │ │ │ - login_name: 'str | None' = None, │ │ │ │ │ - options: 'Mapping[str, str] | None' = None, │ │ │ │ │ - pkcs11: 'str | None' = None, │ │ │ │ │ - port: 'int | None' = None, │ │ │ │ │ - interaction_responder: 'InteractionHandler | None' = None) -> None: │ │ │ │ │ - rundir = os.path.join(os.environ.get('XDG_RUNTIME_DIR', '/run'), 'ferny') │ │ │ │ │ - os.makedirs(rundir, exist_ok=True) │ │ │ │ │ - self._controldir = tempfile.TemporaryDirectory(dir=rundir) │ │ │ │ │ - self._controlsock = f'{self._controldir.name}/socket' │ │ │ │ │ - │ │ │ │ │ - # In general, we can't guarantee an accessible and executable version │ │ │ │ │ - # of this file, but since it's small and we're making a temporary │ │ │ │ │ - # directory anyway, let's just copy it into place and use it from │ │ │ │ │ - # there. │ │ │ │ │ - askpass_path = write_askpass_to_tmpdir(self._controldir.name) │ │ │ │ │ - │ │ │ │ │ - env = dict(os.environ) │ │ │ │ │ - env['SSH_ASKPASS'] = askpass_path │ │ │ │ │ - env['SSH_ASKPASS_REQUIRE'] = 'force' │ │ │ │ │ - # old SSH doesn't understand SSH_ASKPASS_REQUIRE and guesses based on DISPLAY instead │ │ │ │ │ - env['DISPLAY'] = '-' │ │ │ │ │ - │ │ │ │ │ - args = [ │ │ │ │ │ - '-M', │ │ │ │ │ - '-N', │ │ │ │ │ - '-S', self._controlsock, │ │ │ │ │ - '-o', 'PermitLocalCommand=yes', │ │ │ │ │ - '-o', f'LocalCommand={askpass_path}', │ │ │ │ │ - ] │ │ │ │ │ - │ │ │ │ │ - if configfile is not None: │ │ │ │ │ - args.append(f'-F{configfile}') │ │ │ │ │ - │ │ │ │ │ - if identity_file is not None: │ │ │ │ │ - args.append(f'-i{identity_file}') │ │ │ │ │ - │ │ │ │ │ - if options is not None: │ │ │ │ │ - for key in options: # Note: Mapping may not have .items() │ │ │ │ │ - args.append(f'-o{key} {options[key]}') │ │ │ │ │ - │ │ │ │ │ - if pkcs11 is not None: │ │ │ │ │ - args.append(f'-I{pkcs11}') │ │ │ │ │ - │ │ │ │ │ - if port is not None: │ │ │ │ │ - args.append(f'-p{port}') │ │ │ │ │ - │ │ │ │ │ - if login_name is not None: │ │ │ │ │ - args.append(f'-l{login_name}') │ │ │ │ │ - │ │ │ │ │ - if handle_host_key and has_feature('KnownHostsCommand'): │ │ │ │ │ - args.extend([ │ │ │ │ │ - '-o', f'KnownHostsCommand={askpass_path} %I %H %t %K %f', │ │ │ │ │ - '-o', 'StrictHostKeyChecking=yes', │ │ │ │ │ - ]) │ │ │ │ │ - │ │ │ │ │ - agent = InteractionAgent([interaction_responder] if interaction_responder is not None else []) │ │ │ │ │ - │ │ │ │ │ - # SSH_ASKPASS_REQUIRE is not generally available, so use setsid │ │ │ │ │ - process = await asyncio.create_subprocess_exec( │ │ │ │ │ - *('/usr/bin/ssh', *args, destination), env=env, │ │ │ │ │ - start_new_session=True, stdin=asyncio.subprocess.DEVNULL, │ │ │ │ │ - stdout=asyncio.subprocess.DEVNULL, stderr=agent, # type: ignore │ │ │ │ │ - preexec_fn=lambda: prctl(PR_SET_PDEATHSIG, signal.SIGKILL)) │ │ │ │ │ + return self.new_method_return(signature, *args).send() │ │ │ │ │ │ │ │ │ │ - # This is tricky: we need to clean up the subprocess, but only in case │ │ │ │ │ - # if failure. Otherwise, we keep it around. │ │ │ │ │ + def _coroutine_task_complete(self, out_type: bustypes.MessageType, task: asyncio.Task) -> None: │ │ │ │ │ try: │ │ │ │ │ - await agent.communicate() │ │ │ │ │ - assert os.path.exists(self._controlsock) │ │ │ │ │ - self._process = process │ │ │ │ │ - except InteractionError as exc: │ │ │ │ │ - await process.wait() │ │ │ │ │ - raise ssh_errors.get_exception_for_ssh_stderr(str(exc)) from None │ │ │ │ │ - except BaseException: │ │ │ │ │ - # If we get here because the InteractionHandler raised an │ │ │ │ │ - # exception then SSH might still be running, and may even attempt │ │ │ │ │ - # further interactions (ie: 2nd attempt for password). We already │ │ │ │ │ - # have our exception and don't need any more info. Kill it. │ │ │ │ │ - try: │ │ │ │ │ - process.kill() │ │ │ │ │ - except ProcessLookupError: │ │ │ │ │ - pass # already exited? good. │ │ │ │ │ - await process.wait() │ │ │ │ │ - raise │ │ │ │ │ - │ │ │ │ │ - def is_connected(self) -> bool: │ │ │ │ │ - return self._process is not None │ │ │ │ │ - │ │ │ │ │ - async def wait(self) -> None: │ │ │ │ │ - assert self._process is not None │ │ │ │ │ - await self._process.wait() │ │ │ │ │ - │ │ │ │ │ - def exit(self) -> None: │ │ │ │ │ - assert self._process is not None │ │ │ │ │ - self._process.terminate() │ │ │ │ │ - │ │ │ │ │ - async def disconnect(self) -> None: │ │ │ │ │ - self.exit() │ │ │ │ │ - await self.wait() │ │ │ │ │ - │ │ │ │ │ - # Launching of processes │ │ │ │ │ - def wrap_subprocess_args(self, args: Sequence[str]) -> Sequence[str]: │ │ │ │ │ - assert self._controlsock is not None │ │ │ │ │ - # 1. We specify the hostname as the empty string: it will be ignored │ │ │ │ │ - # when ssh is trying to use the control socket, but in case the │ │ │ │ │ - # socket has stopped working, ssh will try to fall back to directly │ │ │ │ │ - # connecting, in which case an empty hostname will prevent that. │ │ │ │ │ - # 2. We need to quote the arguments — ssh will paste them together │ │ │ │ │ - # using only spaces, executing the result using the user's shell. │ │ │ │ │ - return ('ssh', '-S', self._controlsock, '', *map(shlex.quote, args)) │ │ │ │ │ -'''.encode('utf-8'), │ │ │ │ │ - 'cockpit/_vendor/ferny/transport.py': br'''# ferny - asyncio SSH client library, using ssh(1) │ │ │ │ │ -# │ │ │ │ │ -# Copyright (C) 2023 Allison Karlitskaya │ │ │ │ │ -# │ │ │ │ │ -# This program is free software: you can redistribute it and/or modify │ │ │ │ │ -# it under the terms of the GNU General Public License as published by │ │ │ │ │ -# the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ -# (at your option) any later version. │ │ │ │ │ -# │ │ │ │ │ -# This program is distributed in the hope that it will be useful, │ │ │ │ │ -# but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ -# GNU General Public License for more details. │ │ │ │ │ -# │ │ │ │ │ -# You should have received a copy of the GNU General Public License │ │ │ │ │ -# along with this program. If not, see . │ │ │ │ │ - │ │ │ │ │ -import asyncio │ │ │ │ │ -import contextlib │ │ │ │ │ -import logging │ │ │ │ │ -import typing │ │ │ │ │ -from typing import Any, Callable, Iterable, Sequence, TypeVar │ │ │ │ │ - │ │ │ │ │ -from .interaction_agent import InteractionAgent, InteractionHandler, get_running_loop │ │ │ │ │ -from .ssh_errors import get_exception_for_ssh_stderr │ │ │ │ │ - │ │ │ │ │ -logger = logging.getLogger(__name__) │ │ │ │ │ - │ │ │ │ │ -P = TypeVar('P', bound=asyncio.Protocol) │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -class SubprocessError(Exception): │ │ │ │ │ - returncode: int │ │ │ │ │ - stderr: str │ │ │ │ │ - │ │ │ │ │ - def __init__(self, returncode: int, stderr: str) -> None: │ │ │ │ │ - super().__init__(returncode, stderr) │ │ │ │ │ - self.returncode = returncode │ │ │ │ │ - self.stderr = stderr │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -class FernyTransport(asyncio.Transport, asyncio.SubprocessProtocol): │ │ │ │ │ - _agent: InteractionAgent │ │ │ │ │ - _exec_task: 'asyncio.Task[tuple[asyncio.SubprocessTransport, FernyTransport]]' │ │ │ │ │ - _is_ssh: bool │ │ │ │ │ - _protocol: asyncio.Protocol │ │ │ │ │ - _protocol_disconnected: bool = False │ │ │ │ │ - │ │ │ │ │ - # These get initialized in connection_made() and once set, never get unset. │ │ │ │ │ - _subprocess_transport: 'asyncio.SubprocessTransport | None' = None │ │ │ │ │ - _stdin_transport: 'asyncio.WriteTransport | None' = None │ │ │ │ │ - _stdout_transport: 'asyncio.ReadTransport | None' = None │ │ │ │ │ - │ │ │ │ │ - # We record events that might build towards a connection termination here │ │ │ │ │ - # and consider them from _consider_disconnect() in order to try to get the │ │ │ │ │ - # best possible Exception for the protocol, rather than just taking the │ │ │ │ │ - # first one (which is likely to be somewhat random). │ │ │ │ │ - _exception: 'Exception | None' = None │ │ │ │ │ - _stderr_output: 'str | None' = None │ │ │ │ │ - _returncode: 'int | None' = None │ │ │ │ │ - _transport_disconnected: bool = False │ │ │ │ │ - _closed: bool = False │ │ │ │ │ - │ │ │ │ │ - @classmethod │ │ │ │ │ - def spawn( │ │ │ │ │ - cls: 'type[typing.Self]', │ │ │ │ │ - protocol_factory: Callable[[], P], │ │ │ │ │ - args: Sequence[str], │ │ │ │ │ - loop: 'asyncio.AbstractEventLoop | None' = None, │ │ │ │ │ - interaction_handlers: Sequence[InteractionHandler] = (), │ │ │ │ │ - is_ssh: bool = True, │ │ │ │ │ - **kwargs: Any │ │ │ │ │ - ) -> 'tuple[typing.Self, P]': │ │ │ │ │ - """Connects a FernyTransport to a protocol, using the given command. │ │ │ │ │ - │ │ │ │ │ - This spawns an external command and connects the stdin and stdout of │ │ │ │ │ - the command to the protocol returned by the factory. │ │ │ │ │ - │ │ │ │ │ - An instance of ferny.InteractionAgent is created and attached to the │ │ │ │ │ - stderr of the spawned process, using the provided handlers. It is the │ │ │ │ │ - responsibility of the caller to ensure that: │ │ │ │ │ - - a `ferny-askpass` client program is installed somewhere; and │ │ │ │ │ - - any relevant command-line arguments or environment variables are │ │ │ │ │ - passed correctly to the program to be spawned │ │ │ │ │ - │ │ │ │ │ - This function returns immediately and never raises exceptions, assuming │ │ │ │ │ - all preconditions are met. │ │ │ │ │ + self.reply_method_function_return_value(out_type, task.result()) │ │ │ │ │ + except (BusError, OSError) as exc: │ │ │ │ │ + self.reply_method_error(exc) │ │ │ │ │ │ │ │ │ │ - If spawning the process fails then connection_lost() will be │ │ │ │ │ - called with the relevant OSError, even before connection_made() is │ │ │ │ │ - called. This is somewhat non-standard behaviour, but is the easiest │ │ │ │ │ - way to report these errors without making this function async. │ │ │ │ │ + def reply_method_function_return_value(self, │ │ │ │ │ + out_type: bustypes.MessageType, │ │ │ │ │ + return_value: Any) -> bool: # Literal[True]: │ │ │ │ │ + """Sends the result of a function call as a reply to a method call message. │ │ │ │ │ │ │ │ │ │ - Once the process is successfully executed, connection_made() will be │ │ │ │ │ - called and the transport can be used as normal. connection_lost() will │ │ │ │ │ - be called if the process exits or another error occurs. │ │ │ │ │ + This call does a bit of magic: it adapts from the usual Python return │ │ │ │ │ + value conventions (where the return value is ``None``, a single value, │ │ │ │ │ + or a tuple) to the normal D-Bus return value conventions (where the │ │ │ │ │ + result is always a tuple). │ │ │ │ │ │ │ │ │ │ - The return value of this function is the transport, but it exists in a │ │ │ │ │ - semi-initialized state. You can call .close() on it, but nothing else. │ │ │ │ │ - Once .connection_made() is called, you can call all the other │ │ │ │ │ - functions. │ │ │ │ │ + Additionally, if the value is found to be a coroutine, a task is │ │ │ │ │ + created to run the coroutine to completion and return the result │ │ │ │ │ + (including exception handling). │ │ │ │ │ │ │ │ │ │ - After you call this function, `.connection_lost()` will be called on │ │ │ │ │ - your Protocol, exactly once, no matter what. Until that happens, you │ │ │ │ │ - are responsible for holding a reference to the returned transport. │ │ │ │ │ + :out_types: The types of the return values, as an iterable. │ │ │ │ │ + :return_value: The return value of a Python function call. │ │ │ │ │ │ │ │ │ │ - :param args: the full argv of the command to spawn │ │ │ │ │ - :param loop: the event loop to use. If none is provided, we use the │ │ │ │ │ - one which is (read: must be) currently running. │ │ │ │ │ - :param interaction_handlers: the handlers passed to the │ │ │ │ │ - InteractionAgent │ │ │ │ │ - :param is_ssh: whether we should attempt to interpret stderr as ssh │ │ │ │ │ - error messages │ │ │ │ │ - :param kwargs: anything else is passed through to `subprocess_exec()` │ │ │ │ │ - :returns: the usual `(Transport, Protocol)` pair │ │ │ │ │ + :returns: True │ │ │ │ │ """ │ │ │ │ │ - logger.debug('spawn(%r, %r, %r)', cls, protocol_factory, args) │ │ │ │ │ - │ │ │ │ │ - protocol = protocol_factory() │ │ │ │ │ - self = cls(protocol) │ │ │ │ │ - self._is_ssh = is_ssh │ │ │ │ │ - │ │ │ │ │ - if loop is None: │ │ │ │ │ - loop = get_running_loop() │ │ │ │ │ - │ │ │ │ │ - self._agent = InteractionAgent(interaction_handlers, loop, self._interaction_completed) │ │ │ │ │ - kwargs.setdefault('stderr', self._agent.fileno()) │ │ │ │ │ - │ │ │ │ │ - # As of Python 3.12 this isn't really asynchronous (since it uses the │ │ │ │ │ - # subprocess module, which blocks while waiting for the exec() to │ │ │ │ │ - # complete in the child), but we have to deal with the complication of │ │ │ │ │ - # the async interface anyway. Since we, ourselves, want to export a │ │ │ │ │ - # non-async interface, that means that we need a task here and a │ │ │ │ │ - # bottom-half handler below. │ │ │ │ │ - self._exec_task = loop.create_task(loop.subprocess_exec(lambda: self, *args, **kwargs)) │ │ │ │ │ - │ │ │ │ │ - def exec_completed(task: asyncio.Task) -> None: │ │ │ │ │ - logger.debug('exec_completed(%r, %r)', self, task) │ │ │ │ │ - assert task is self._exec_task │ │ │ │ │ - try: │ │ │ │ │ - transport, me = task.result() │ │ │ │ │ - assert me is self │ │ │ │ │ - logger.debug(' success.') │ │ │ │ │ - except asyncio.CancelledError: │ │ │ │ │ - return # in that case, do nothing │ │ │ │ │ - except OSError as exc: │ │ │ │ │ - logger.debug(' OSError %r', exc) │ │ │ │ │ - self.close(exc) │ │ │ │ │ - return │ │ │ │ │ - │ │ │ │ │ - # Our own .connection_made() handler should have gotten called by │ │ │ │ │ - # now. Make sure everything got filled in properly. │ │ │ │ │ - assert self._subprocess_transport is transport │ │ │ │ │ - assert self._stdin_transport is not None │ │ │ │ │ - assert self._stdout_transport is not None │ │ │ │ │ - │ │ │ │ │ - # Ask the InteractionAgent to start processing stderr. │ │ │ │ │ - self._agent.start() │ │ │ │ │ - │ │ │ │ │ - self._exec_task.add_done_callback(exec_completed) │ │ │ │ │ - │ │ │ │ │ - return self, protocol │ │ │ │ │ - │ │ │ │ │ - def __init__(self, protocol: asyncio.Protocol) -> None: │ │ │ │ │ - self._protocol = protocol │ │ │ │ │ - │ │ │ │ │ - def _consider_disconnect(self) -> None: │ │ │ │ │ - logger.debug('_consider_disconnect(%r)', self) │ │ │ │ │ - # We cannot disconnect as long as any of these three things are happening │ │ │ │ │ - if not self._exec_task.done(): │ │ │ │ │ - logger.debug(' exec_task still running %r', self._exec_task) │ │ │ │ │ - return │ │ │ │ │ - │ │ │ │ │ - if self._subprocess_transport is not None and not self._transport_disconnected: │ │ │ │ │ - logger.debug(' transport still connected %r', self._subprocess_transport) │ │ │ │ │ - return │ │ │ │ │ - │ │ │ │ │ - if self._stderr_output is None: │ │ │ │ │ - logger.debug(' agent still running') │ │ │ │ │ - return │ │ │ │ │ - │ │ │ │ │ - # All conditions for disconnection are satisfied. │ │ │ │ │ - if self._protocol_disconnected: │ │ │ │ │ - logger.debug(' already disconnected') │ │ │ │ │ - return │ │ │ │ │ - self._protocol_disconnected = True │ │ │ │ │ + if asyncio.coroutines.iscoroutine(return_value): │ │ │ │ │ + task = asyncio.create_task(return_value) │ │ │ │ │ + task.add_done_callback(lambda task: self._coroutine_task_complete(out_type, task)) │ │ │ │ │ + return True │ │ │ │ │ │ │ │ │ │ - # Now we just need to determine what we report to the protocol... │ │ │ │ │ - if self._exception is not None: │ │ │ │ │ - # If we got an exception reported, that's our reason for closing. │ │ │ │ │ - logger.debug(' disconnect with exception %r', self._exception) │ │ │ │ │ - self._protocol.connection_lost(self._exception) │ │ │ │ │ - elif self._returncode == 0 or self._closed: │ │ │ │ │ - # If we called close() or have a zero return status, that's a clean │ │ │ │ │ - # exit, regardless of noise that might have landed in stderr. │ │ │ │ │ - logger.debug(' clean disconnect') │ │ │ │ │ - self._protocol.connection_lost(None) │ │ │ │ │ - elif self._is_ssh and self._returncode == 255: │ │ │ │ │ - # This is an error code due to an SSH failure. Try to interpret it. │ │ │ │ │ - logger.debug(' disconnect with ssh error %r', self._stderr_output) │ │ │ │ │ - self._protocol.connection_lost(get_exception_for_ssh_stderr(self._stderr_output)) │ │ │ │ │ + reply = self.new_method_return() │ │ │ │ │ + # In the general case, a function returns an n-tuple, but... │ │ │ │ │ + if len(out_type) == 0: │ │ │ │ │ + # Functions with no return value return None. │ │ │ │ │ + assert return_value is None │ │ │ │ │ + elif len(out_type) == 1: │ │ │ │ │ + # Functions with a single return value return that value. │ │ │ │ │ + out_type.write(reply, return_value) │ │ │ │ │ else: │ │ │ │ │ - # Otherwise, report the stderr text and return code. │ │ │ │ │ - logger.debug(' disconnect with exit code %r, stderr %r', self._returncode, self._stderr_output) │ │ │ │ │ - # We surely have _returncode set here, since otherwise: │ │ │ │ │ - # - exec_task failed with an exception (which we handle above); or │ │ │ │ │ - # - we're still connected... │ │ │ │ │ - assert self._returncode is not None │ │ │ │ │ - self._protocol.connection_lost(SubprocessError(self._returncode, self._stderr_output)) │ │ │ │ │ - │ │ │ │ │ - def _interaction_completed(self, future: 'asyncio.Future[str]') -> None: │ │ │ │ │ - logger.debug('_interaction_completed(%r, %r)', self, future) │ │ │ │ │ - try: │ │ │ │ │ - self._stderr_output = future.result() │ │ │ │ │ - logger.debug(' stderr: %r', self._stderr_output) │ │ │ │ │ - except Exception as exc: │ │ │ │ │ - logger.debug(' exception: %r', exc) │ │ │ │ │ - self._stderr_output = '' # we need to set this in order to complete │ │ │ │ │ - self.close(exc) │ │ │ │ │ - │ │ │ │ │ - self._consider_disconnect() │ │ │ │ │ - │ │ │ │ │ - # BaseProtocol implementation │ │ │ │ │ - def connection_made(self, transport: asyncio.BaseTransport) -> None: │ │ │ │ │ - logger.debug('connection_made(%r, %r)', self, transport) │ │ │ │ │ - assert isinstance(transport, asyncio.SubprocessTransport) │ │ │ │ │ - self._subprocess_transport = transport │ │ │ │ │ - │ │ │ │ │ - stdin_transport = transport.get_pipe_transport(0) │ │ │ │ │ - assert isinstance(stdin_transport, asyncio.WriteTransport) │ │ │ │ │ - self._stdin_transport = stdin_transport │ │ │ │ │ - │ │ │ │ │ - stdout_transport = transport.get_pipe_transport(1) │ │ │ │ │ - assert isinstance(stdout_transport, asyncio.ReadTransport) │ │ │ │ │ - self._stdout_transport = stdout_transport │ │ │ │ │ - │ │ │ │ │ - stderr_transport = transport.get_pipe_transport(2) │ │ │ │ │ - assert stderr_transport is None │ │ │ │ │ - │ │ │ │ │ - logger.debug('calling connection_made(%r, %r)', self, self._protocol) │ │ │ │ │ - self._protocol.connection_made(self) │ │ │ │ │ - │ │ │ │ │ - def connection_lost(self, exc: 'Exception | None') -> None: │ │ │ │ │ - logger.debug('connection_lost(%r, %r)', self, exc) │ │ │ │ │ - if self._exception is None: │ │ │ │ │ - self._exception = exc │ │ │ │ │ - self._transport_disconnected = True │ │ │ │ │ - self._consider_disconnect() │ │ │ │ │ - │ │ │ │ │ - # SubprocessProtocol implementation │ │ │ │ │ - def pipe_data_received(self, fd: int, data: bytes) -> None: │ │ │ │ │ - logger.debug('pipe_data_received(%r, %r, %r)', self, fd, len(data)) │ │ │ │ │ - assert fd == 1 # stderr is handled separately │ │ │ │ │ - self._protocol.data_received(data) │ │ │ │ │ - │ │ │ │ │ - def pipe_connection_lost(self, fd: int, exc: 'Exception | None') -> None: │ │ │ │ │ - logger.debug('pipe_connection_lost(%r, %r, %r)', self, fd, exc) │ │ │ │ │ - assert fd in (0, 1) # stderr is handled separately │ │ │ │ │ - │ │ │ │ │ - # We treat this as a clean close │ │ │ │ │ - if isinstance(exc, BrokenPipeError): │ │ │ │ │ - exc = None │ │ │ │ │ - │ │ │ │ │ - # Record serious errors to propagate them to the protocol │ │ │ │ │ - # If this is a clean exit on stdout, report an EOF │ │ │ │ │ - if exc is not None: │ │ │ │ │ - self.close(exc) │ │ │ │ │ - elif fd == 1 and not self._closed: │ │ │ │ │ - if not self._protocol.eof_received(): │ │ │ │ │ - self.close() │ │ │ │ │ - │ │ │ │ │ - def process_exited(self) -> None: │ │ │ │ │ - logger.debug('process_exited(%r)', self) │ │ │ │ │ - assert self._subprocess_transport is not None │ │ │ │ │ - self._returncode = self._subprocess_transport.get_returncode() │ │ │ │ │ - logger.debug(' ._returncode = %r', self._returncode) │ │ │ │ │ - self._agent.force_completion() │ │ │ │ │ + # (general case) n return values are handled as an n-tuple. │ │ │ │ │ + assert len(out_type) == len(return_value) │ │ │ │ │ + out_type.write(reply, *return_value) │ │ │ │ │ + return reply.send() │ │ │ │ │ │ │ │ │ │ - def pause_writing(self) -> None: │ │ │ │ │ - logger.debug('pause_writing(%r)', self) │ │ │ │ │ - self._protocol.pause_writing() │ │ │ │ │ │ │ │ │ │ - def resume_writing(self) -> None: │ │ │ │ │ - logger.debug('resume_writing(%r)', self) │ │ │ │ │ - self._protocol.resume_writing() │ │ │ │ │ +class Slot(libsystemd.sd_bus_slot): │ │ │ │ │ + def __init__(self, callback: Callable[[BusMessage], bool]): │ │ │ │ │ + def handler(message: WeakReference, _data: object, _err: object) -> int: │ │ │ │ │ + return 1 if callback(BusMessage.ref(message)) else 0 │ │ │ │ │ + self.trampoline = libsystemd.sd_bus_message_handler_t(handler) │ │ │ │ │ │ │ │ │ │ - # Transport implementation. Most of this is straight delegation. │ │ │ │ │ - def close(self, exc: 'Exception | None' = None) -> None: │ │ │ │ │ - logger.debug('close(%r, %r)', self, exc) │ │ │ │ │ - self._closed = True │ │ │ │ │ - if self._exception is None: │ │ │ │ │ - logger.debug(' setting exception %r', exc) │ │ │ │ │ - self._exception = exc │ │ │ │ │ - if not self._exec_task.done(): │ │ │ │ │ - logger.debug(' cancelling _exec_task') │ │ │ │ │ - self._exec_task.cancel() │ │ │ │ │ - if self._subprocess_transport is not None: │ │ │ │ │ - logger.debug(' closing _subprocess_transport') │ │ │ │ │ - # https://github.com/python/cpython/issues/112800 │ │ │ │ │ - with contextlib.suppress(PermissionError): │ │ │ │ │ - self._subprocess_transport.close() │ │ │ │ │ - self._agent.force_completion() │ │ │ │ │ │ │ │ │ │ - def is_closing(self) -> bool: │ │ │ │ │ - assert self._subprocess_transport is not None │ │ │ │ │ - return self._subprocess_transport.is_closing() │ │ │ │ │ +if typing.TYPE_CHECKING: │ │ │ │ │ + FutureMessage = asyncio.Future[BusMessage] │ │ │ │ │ +else: │ │ │ │ │ + # Python 3.6 can't subscript asyncio.Future │ │ │ │ │ + FutureMessage = asyncio.Future │ │ │ │ │ │ │ │ │ │ - def get_extra_info(self, name: str, default: object = None) -> object: │ │ │ │ │ - assert self._subprocess_transport is not None │ │ │ │ │ - return self._subprocess_transport.get_extra_info(name, default) │ │ │ │ │ │ │ │ │ │ - def set_protocol(self, protocol: asyncio.BaseProtocol) -> None: │ │ │ │ │ - assert isinstance(protocol, asyncio.Protocol) │ │ │ │ │ - self._protocol = protocol │ │ │ │ │ +class PendingCall(Slot): │ │ │ │ │ + future: FutureMessage │ │ │ │ │ │ │ │ │ │ - def get_protocol(self) -> asyncio.Protocol: │ │ │ │ │ - return self._protocol │ │ │ │ │ + def __init__(self) -> None: │ │ │ │ │ + future = asyncio.get_running_loop().create_future() │ │ │ │ │ │ │ │ │ │ - def is_reading(self) -> bool: │ │ │ │ │ - assert self._stdout_transport is not None │ │ │ │ │ - try: │ │ │ │ │ - return self._stdout_transport.is_reading() │ │ │ │ │ - except NotImplementedError: │ │ │ │ │ - # This is (incorrectly) unimplemented before Python 3.11 │ │ │ │ │ - return not self._stdout_transport._paused # type:ignore[attr-defined] │ │ │ │ │ - except AttributeError: │ │ │ │ │ - # ...and in Python 3.6 it's even worse │ │ │ │ │ - try: │ │ │ │ │ - selector = self._stdout_transport._loop._selector # type:ignore[attr-defined] │ │ │ │ │ - selector.get_key(self._stdout_transport._fileno) # type:ignore[attr-defined] │ │ │ │ │ + def done(message: BusMessage) -> bool: │ │ │ │ │ + error = message.get_error() │ │ │ │ │ + if future.cancelled(): │ │ │ │ │ return True │ │ │ │ │ - except KeyError: │ │ │ │ │ - return False │ │ │ │ │ - │ │ │ │ │ - def pause_reading(self) -> None: │ │ │ │ │ - assert self._stdout_transport is not None │ │ │ │ │ - self._stdout_transport.pause_reading() │ │ │ │ │ + if error is not None: │ │ │ │ │ + future.set_exception(error) │ │ │ │ │ + else: │ │ │ │ │ + future.set_result(message) │ │ │ │ │ + return True │ │ │ │ │ │ │ │ │ │ - def resume_reading(self) -> None: │ │ │ │ │ - assert self._stdout_transport is not None │ │ │ │ │ - self._stdout_transport.resume_reading() │ │ │ │ │ + super().__init__(done) │ │ │ │ │ + self.future = future │ │ │ │ │ │ │ │ │ │ - def abort(self) -> None: │ │ │ │ │ - assert self._stdin_transport is not None │ │ │ │ │ - assert self._subprocess_transport is not None │ │ │ │ │ - self._stdin_transport.abort() │ │ │ │ │ - self._subprocess_transport.kill() │ │ │ │ │ │ │ │ │ │ - def can_write_eof(self) -> bool: │ │ │ │ │ - assert self._stdin_transport is not None │ │ │ │ │ - return self._stdin_transport.can_write_eof() # will always be True │ │ │ │ │ +class Bus(libsystemd.sd_bus): │ │ │ │ │ + _default_system_instance = None │ │ │ │ │ + _default_user_instance = None │ │ │ │ │ │ │ │ │ │ - def get_write_buffer_size(self) -> int: │ │ │ │ │ - assert self._stdin_transport is not None │ │ │ │ │ - return self._stdin_transport.get_write_buffer_size() │ │ │ │ │ + class NameFlags(enum.IntFlag): │ │ │ │ │ + DEFAULT = 0 │ │ │ │ │ + REPLACE_EXISTING = 1 << 0 │ │ │ │ │ + ALLOW_REPLACEMENT = 1 << 1 │ │ │ │ │ + QUEUE = 1 << 2 │ │ │ │ │ │ │ │ │ │ - def get_write_buffer_limits(self) -> 'tuple[int, int]': │ │ │ │ │ - assert self._stdin_transport is not None │ │ │ │ │ - return self._stdin_transport.get_write_buffer_limits() │ │ │ │ │ + @staticmethod │ │ │ │ │ + def new( │ │ │ │ │ + fd: Optional[int] = None, │ │ │ │ │ + address: Optional[str] = None, │ │ │ │ │ + bus_client: bool = False, │ │ │ │ │ + server: bool = False, │ │ │ │ │ + start: bool = True, │ │ │ │ │ + attach_event: bool = True │ │ │ │ │ + ) -> 'Bus': │ │ │ │ │ + bus = Bus() │ │ │ │ │ + Bus._new(byref(bus)) │ │ │ │ │ + if address is not None: │ │ │ │ │ + bus.set_address(address) │ │ │ │ │ + if fd is not None: │ │ │ │ │ + bus.set_fd(fd, fd) │ │ │ │ │ + if bus_client: │ │ │ │ │ + bus.set_bus_client(True) │ │ │ │ │ + if server: │ │ │ │ │ + bus.set_server(True, libsystemd.sd_id128()) │ │ │ │ │ + if address is not None or fd is not None: │ │ │ │ │ + if start: │ │ │ │ │ + bus.start() │ │ │ │ │ + if attach_event: │ │ │ │ │ + bus.attach_event(None, 0) │ │ │ │ │ + return bus │ │ │ │ │ │ │ │ │ │ - def set_write_buffer_limits(self, high: 'int | None' = None, low: 'int | None' = None) -> None: │ │ │ │ │ - assert self._stdin_transport is not None │ │ │ │ │ - return self._stdin_transport.set_write_buffer_limits(high, low) │ │ │ │ │ + @staticmethod │ │ │ │ │ + def default_system(attach_event: bool = True) -> 'Bus': │ │ │ │ │ + if Bus._default_system_instance is None: │ │ │ │ │ + Bus._default_system_instance = Bus() │ │ │ │ │ + Bus._default_system(byref(Bus._default_system_instance)) │ │ │ │ │ + if attach_event: │ │ │ │ │ + Bus._default_system_instance.attach_event(None, 0) │ │ │ │ │ + return Bus._default_system_instance │ │ │ │ │ │ │ │ │ │ - def write(self, data: bytes) -> None: │ │ │ │ │ - assert self._stdin_transport is not None │ │ │ │ │ - return self._stdin_transport.write(data) │ │ │ │ │ + @staticmethod │ │ │ │ │ + def default_user(attach_event: bool = True) -> 'Bus': │ │ │ │ │ + if Bus._default_user_instance is None: │ │ │ │ │ + Bus._default_user_instance = Bus() │ │ │ │ │ + Bus._default_user(byref(Bus._default_user_instance)) │ │ │ │ │ + if attach_event: │ │ │ │ │ + Bus._default_user_instance.attach_event(None, 0) │ │ │ │ │ + return Bus._default_user_instance │ │ │ │ │ │ │ │ │ │ - def writelines(self, list_of_data: Iterable[bytes]) -> None: │ │ │ │ │ - assert self._stdin_transport is not None │ │ │ │ │ - return self._stdin_transport.writelines(list_of_data) │ │ │ │ │ + def message_new_method_call( │ │ │ │ │ + self, │ │ │ │ │ + destination: Optional[str], │ │ │ │ │ + path: str, │ │ │ │ │ + interface: str, │ │ │ │ │ + member: str, │ │ │ │ │ + types: str = '', │ │ │ │ │ + *args: object │ │ │ │ │ + ) -> BusMessage: │ │ │ │ │ + message = BusMessage() │ │ │ │ │ + self._message_new_method_call(byref(message), destination, path, interface, member) │ │ │ │ │ + message.append(types, *args) │ │ │ │ │ + return message │ │ │ │ │ │ │ │ │ │ - def write_eof(self) -> None: │ │ │ │ │ - assert self._stdin_transport is not None │ │ │ │ │ - return self._stdin_transport.write_eof() │ │ │ │ │ + def message_new_signal( │ │ │ │ │ + self, path: str, interface: str, member: str, types: str = '', *args: object │ │ │ │ │ + ) -> BusMessage: │ │ │ │ │ + message = BusMessage() │ │ │ │ │ + self._message_new_signal(byref(message), path, interface, member) │ │ │ │ │ + message.append(types, *args) │ │ │ │ │ + return message │ │ │ │ │ │ │ │ │ │ - # We don't really implement SubprocessTransport, but provide these as │ │ │ │ │ - # "extras" to our user. │ │ │ │ │ - def get_pid(self) -> int: │ │ │ │ │ - assert self._subprocess_transport is not None │ │ │ │ │ - return self._subprocess_transport.get_pid() │ │ │ │ │ + def call(self, message: BusMessage, timeout: Optional[int] = None) -> BusMessage: │ │ │ │ │ + reply = BusMessage() │ │ │ │ │ + error = libsystemd.sd_bus_error() │ │ │ │ │ + try: │ │ │ │ │ + self._call(message, timeout or 0, byref(error), byref(reply)) │ │ │ │ │ + return reply │ │ │ │ │ + except OSError as exc: │ │ │ │ │ + raise BusError(*error.get()) from exc │ │ │ │ │ │ │ │ │ │ - def get_returncode(self) -> 'int | None': │ │ │ │ │ - return self._returncode │ │ │ │ │ + def call_method( │ │ │ │ │ + self, │ │ │ │ │ + destination: str, │ │ │ │ │ + path: str, │ │ │ │ │ + interface: str, │ │ │ │ │ + member: str, │ │ │ │ │ + types: str = '', │ │ │ │ │ + *args: object, │ │ │ │ │ + timeout: Optional[int] = None │ │ │ │ │ + ) -> Tuple[object, ...]: │ │ │ │ │ + logger.debug('Doing sync method call %s %s %s %s %s %s', │ │ │ │ │ + destination, path, interface, member, types, args) │ │ │ │ │ + message = self.message_new_method_call(destination, path, interface, member, types, *args) │ │ │ │ │ + message = self.call(message, timeout) │ │ │ │ │ + return message.get_body() │ │ │ │ │ │ │ │ │ │ - def kill(self) -> None: │ │ │ │ │ - assert self._subprocess_transport is not None │ │ │ │ │ - self._subprocess_transport.kill() │ │ │ │ │ + async def call_async( │ │ │ │ │ + self, │ │ │ │ │ + message: BusMessage, │ │ │ │ │ + timeout: Optional[int] = None │ │ │ │ │ + ) -> BusMessage: │ │ │ │ │ + pending = PendingCall() │ │ │ │ │ + self._call_async(byref(pending), message, pending.trampoline, pending.userdata, timeout or 0) │ │ │ │ │ + return await pending.future │ │ │ │ │ │ │ │ │ │ - def send_signal(self, number: int) -> None: │ │ │ │ │ - assert self._subprocess_transport is not None │ │ │ │ │ - self._subprocess_transport.send_signal(number) │ │ │ │ │ + async def call_method_async( │ │ │ │ │ + self, │ │ │ │ │ + destination: Optional[str], │ │ │ │ │ + path: str, │ │ │ │ │ + interface: str, │ │ │ │ │ + member: str, │ │ │ │ │ + types: str = '', │ │ │ │ │ + *args: object, │ │ │ │ │ + timeout: Optional[int] = None │ │ │ │ │ + ) -> Tuple[object, ...]: │ │ │ │ │ + logger.debug('Doing async method call %s %s %s %s %s %s', │ │ │ │ │ + destination, path, interface, member, types, args) │ │ │ │ │ + message = self.message_new_method_call(destination, path, interface, member, types, *args) │ │ │ │ │ + message = await self.call_async(message, timeout) │ │ │ │ │ + return message.get_body() │ │ │ │ │ │ │ │ │ │ - def terminate(self) -> None: │ │ │ │ │ - assert self._subprocess_transport is not None │ │ │ │ │ - self._subprocess_transport.terminate() │ │ │ │ │ -''', │ │ │ │ │ - 'cockpit/_vendor/ferny/py.typed': br'''''', │ │ │ │ │ - 'cockpit/_vendor/ferny/__init__.py': br'''from .interaction_agent import ( │ │ │ │ │ - BEIBOOT_GADGETS, │ │ │ │ │ - COMMAND_TEMPLATE, │ │ │ │ │ - AskpassHandler, │ │ │ │ │ - InteractionAgent, │ │ │ │ │ - InteractionError, │ │ │ │ │ - InteractionHandler, │ │ │ │ │ - temporary_askpass, │ │ │ │ │ - write_askpass_to_tmpdir, │ │ │ │ │ -) │ │ │ │ │ -from .session import Session │ │ │ │ │ -from .ssh_askpass import ( │ │ │ │ │ - AskpassPrompt, │ │ │ │ │ - SshAskpassResponder, │ │ │ │ │ - SshFIDOPINPrompt, │ │ │ │ │ - SshFIDOUserPresencePrompt, │ │ │ │ │ - SshHostKeyPrompt, │ │ │ │ │ - SshPassphrasePrompt, │ │ │ │ │ - SshPasswordPrompt, │ │ │ │ │ - SshPKCS11PINPrompt, │ │ │ │ │ -) │ │ │ │ │ -from .ssh_errors import ( │ │ │ │ │ - SshAuthenticationError, │ │ │ │ │ - SshChangedHostKeyError, │ │ │ │ │ - SshError, │ │ │ │ │ - SshHostKeyError, │ │ │ │ │ - SshUnknownHostKeyError, │ │ │ │ │ -) │ │ │ │ │ -from .transport import FernyTransport, SubprocessError │ │ │ │ │ + def add_match(self, rule: str, handler: Callable[[BusMessage], bool]) -> Slot: │ │ │ │ │ + slot = Slot(handler) │ │ │ │ │ + self._add_match(byref(slot), rule, slot.trampoline, slot.userdata) │ │ │ │ │ + return slot │ │ │ │ │ │ │ │ │ │ -__all__ = [ │ │ │ │ │ - 'AskpassHandler', │ │ │ │ │ - 'AskpassPrompt', │ │ │ │ │ - 'AuthenticationError', │ │ │ │ │ - 'BEIBOOT_GADGETS', │ │ │ │ │ - 'COMMAND_TEMPLATE', │ │ │ │ │ - 'ChangedHostKeyError', │ │ │ │ │ - 'FernyTransport', │ │ │ │ │ - 'HostKeyError', │ │ │ │ │ - 'InteractionAgent', │ │ │ │ │ - 'InteractionError', │ │ │ │ │ - 'InteractionHandler', │ │ │ │ │ - 'Session', │ │ │ │ │ - 'SshAskpassResponder', │ │ │ │ │ - 'SshAuthenticationError', │ │ │ │ │ - 'SshChangedHostKeyError', │ │ │ │ │ - 'SshError', │ │ │ │ │ - 'SshFIDOPINPrompt', │ │ │ │ │ - 'SshFIDOUserPresencePrompt', │ │ │ │ │ - 'SshHostKeyError', │ │ │ │ │ - 'SshHostKeyPrompt', │ │ │ │ │ - 'SshPKCS11PINPrompt', │ │ │ │ │ - 'SshPassphrasePrompt', │ │ │ │ │ - 'SshPasswordPrompt', │ │ │ │ │ - 'SshUnknownHostKeyError', │ │ │ │ │ - 'SubprocessError', │ │ │ │ │ - 'temporary_askpass', │ │ │ │ │ - 'write_askpass_to_tmpdir', │ │ │ │ │ -] │ │ │ │ │ + def add_object(self, path: str, obj: 'BaseObject') -> Slot: │ │ │ │ │ + slot = Slot(obj.message_received) │ │ │ │ │ + self._add_object(byref(slot), path, slot.trampoline, slot.userdata) │ │ │ │ │ + obj.registered_on_bus(self, path) │ │ │ │ │ + return slot │ │ │ │ │ │ │ │ │ │ -__version__ = '0' │ │ │ │ │ -''', │ │ │ │ │ - 'cockpit/_vendor/ferny/ssh_errors.py': br'''# ferny - asyncio SSH client library, using ssh(1) │ │ │ │ │ -# │ │ │ │ │ -# Copyright (C) 2023 Allison Karlitskaya │ │ │ │ │ -# │ │ │ │ │ -# This program is free software: you can redistribute it and/or modify │ │ │ │ │ -# it under the terms of the GNU General Public License as published by │ │ │ │ │ -# the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ -# (at your option) any later version. │ │ │ │ │ -# │ │ │ │ │ -# This program is distributed in the hope that it will be useful, │ │ │ │ │ -# but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ -# GNU General Public License for more details. │ │ │ │ │ -# │ │ │ │ │ -# You should have received a copy of the GNU General Public License │ │ │ │ │ -# along with this program. If not, see . │ │ │ │ │ │ │ │ │ │ -import ctypes │ │ │ │ │ -import errno │ │ │ │ │ -import os │ │ │ │ │ -import re │ │ │ │ │ -import socket │ │ │ │ │ -from typing import ClassVar, Iterable, Match, Pattern │ │ │ │ │ +class BaseObject: │ │ │ │ │ + """Base object type for exporting objects on the bus │ │ │ │ │ │ │ │ │ │ + This is the lowest-level class that can be passed to Bus.add_object(). │ │ │ │ │ │ │ │ │ │ -class SshError(Exception): │ │ │ │ │ - PATTERN: ClassVar[Pattern] │ │ │ │ │ + If you want to directly subclass this, you'll need to implement │ │ │ │ │ + `message_received()`. │ │ │ │ │ │ │ │ │ │ - def __init__(self, match: 'Match | None', stderr: str) -> None: │ │ │ │ │ - super().__init__(match.group(0) if match is not None else stderr) │ │ │ │ │ - self.stderr = stderr │ │ │ │ │ + Subclassing from `bus.Object` is probably a better choice. │ │ │ │ │ + """ │ │ │ │ │ + _dbus_bus: Optional[Bus] = None │ │ │ │ │ + _dbus_path: Optional[str] = None │ │ │ │ │ │ │ │ │ │ + def registered_on_bus(self, bus: Bus, path: str) -> None: │ │ │ │ │ + """Report that an instance was exported on a given bus and path. │ │ │ │ │ │ │ │ │ │ -class SshAuthenticationError(SshError): │ │ │ │ │ - PATTERN = re.compile(r'^([^:]+): Permission denied \(([^()]+)\)\.$', re.M) │ │ │ │ │ + This is used so that the instance knows where to send signals. │ │ │ │ │ + Bus.add_object() calls this: you probably shouldn't call this on your │ │ │ │ │ + own. │ │ │ │ │ + """ │ │ │ │ │ + self._dbus_bus = bus │ │ │ │ │ + self._dbus_path = path │ │ │ │ │ │ │ │ │ │ - def __init__(self, match: Match, stderr: str) -> None: │ │ │ │ │ - super().__init__(match, stderr) │ │ │ │ │ - self.destination = match.group(1) │ │ │ │ │ - self.methods = match.group(2).split(',') │ │ │ │ │ - self.message = match.group(0) │ │ │ │ │ + self.registered() │ │ │ │ │ │ │ │ │ │ + def registered(self) -> None: │ │ │ │ │ + """Called after an object has been registered on the bus │ │ │ │ │ │ │ │ │ │ -# generic host key error for OSes without KnownHostsCommand support │ │ │ │ │ -class SshHostKeyError(SshError): │ │ │ │ │ - PATTERN = re.compile(r'^Host key verification failed.$', re.M) │ │ │ │ │ + This is the correct method to implement to do some initial work that │ │ │ │ │ + needs to be done after registration. The default implementation does │ │ │ │ │ + nothing. │ │ │ │ │ + """ │ │ │ │ │ + pass │ │ │ │ │ │ │ │ │ │ + def emit_signal( │ │ │ │ │ + self, interface: str, name: str, signature: str, *args: Any │ │ │ │ │ + ) -> bool: │ │ │ │ │ + """Emit a D-Bus signal on this object │ │ │ │ │ │ │ │ │ │ -# specific errors for OSes with KnownHostsCommand │ │ │ │ │ -class SshUnknownHostKeyError(SshHostKeyError): │ │ │ │ │ - PATTERN = re.compile(r'^No .* host key is known.*Host key verification failed.$', re.S | re.M) │ │ │ │ │ + The object must have been exported on the bus with Bus.add_object(). │ │ │ │ │ │ │ │ │ │ + :interface: the interface of the signal │ │ │ │ │ + :name: the 'member' name of the signal to emit │ │ │ │ │ + :signature: the type signature, as a string │ │ │ │ │ + :args: the arguments, according to the signature │ │ │ │ │ + :returns: True │ │ │ │ │ + """ │ │ │ │ │ + assert self._dbus_bus is not None │ │ │ │ │ + assert self._dbus_path is not None │ │ │ │ │ + return self._dbus_bus.message_new_signal(self._dbus_path, interface, name, signature, *args).send() │ │ │ │ │ │ │ │ │ │ -class SshChangedHostKeyError(SshHostKeyError): │ │ │ │ │ - PATTERN = re.compile(r'warning.*remote host identification has changed', re.I) │ │ │ │ │ + def message_received(self, message: BusMessage) -> bool: │ │ │ │ │ + """Called when a message is received for this object │ │ │ │ │ │ │ │ │ │ + This is the lowest level interface to the BaseObject. You need to │ │ │ │ │ + handle method calls, properties, and introspection. │ │ │ │ │ │ │ │ │ │ -# Functionality for mapping getaddrinfo()-family error messages to their │ │ │ │ │ -# equivalent Python exceptions. │ │ │ │ │ -def make_gaierror_map() -> 'Iterable[tuple[str, int]]': │ │ │ │ │ - libc = ctypes.CDLL(None) │ │ │ │ │ - libc.gai_strerror.restype = ctypes.c_char_p │ │ │ │ │ + You are expected to handle the message and return True. Normally this │ │ │ │ │ + means that you send a reply. If you don't want to handle the message, │ │ │ │ │ + return False and other handlers will have a chance to run. If no │ │ │ │ │ + handler handles the message, systemd will generate a suitable error │ │ │ │ │ + message and send that, instead. │ │ │ │ │ │ │ │ │ │ - for key in dir(socket): │ │ │ │ │ - if key.startswith('EAI_'): │ │ │ │ │ - errnum = getattr(socket, key) │ │ │ │ │ - yield libc.gai_strerror(errnum).decode('utf-8'), errnum │ │ │ │ │ + :message: the message that was received │ │ │ │ │ + :returns: True if the message was handled │ │ │ │ │ + """ │ │ │ │ │ + raise NotImplementedError │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ -gaierror_map = dict(make_gaierror_map()) │ │ │ │ │ +class Interface: │ │ │ │ │ + """The high-level base class for defining D-Bus interfaces │ │ │ │ │ │ │ │ │ │ + This class provides high-level APIs for defining methods, properties, and │ │ │ │ │ + signals, as well as implementing introspection. │ │ │ │ │ │ │ │ │ │ -# Functionality for passing strerror() error messages to their equivalent │ │ │ │ │ -# Python exceptions. │ │ │ │ │ -# There doesn't seem to be an official API for turning an errno into the │ │ │ │ │ -# correct subtype of OSError, and the list that cpython uses is hidden fairly │ │ │ │ │ -# deeply inside of the implementation. This is basically copied from the │ │ │ │ │ -# ADD_ERRNO() lines in _PyExc_InitState in cpython/Objects/exceptions.c │ │ │ │ │ -oserror_subclass_map = dict((errnum, cls) for cls, errnum in [ │ │ │ │ │ - (BlockingIOError, errno.EAGAIN), │ │ │ │ │ - (BlockingIOError, errno.EALREADY), │ │ │ │ │ - (BlockingIOError, errno.EINPROGRESS), │ │ │ │ │ - (BlockingIOError, errno.EWOULDBLOCK), │ │ │ │ │ - (BrokenPipeError, errno.EPIPE), │ │ │ │ │ - (BrokenPipeError, errno.ESHUTDOWN), │ │ │ │ │ - (ChildProcessError, errno.ECHILD), │ │ │ │ │ - (ConnectionAbortedError, errno.ECONNABORTED), │ │ │ │ │ - (ConnectionRefusedError, errno.ECONNREFUSED), │ │ │ │ │ - (ConnectionResetError, errno.ECONNRESET), │ │ │ │ │ - (FileExistsError, errno.EEXIST), │ │ │ │ │ - (FileNotFoundError, errno.ENOENT), │ │ │ │ │ - (IsADirectoryError, errno.EISDIR), │ │ │ │ │ - (NotADirectoryError, errno.ENOTDIR), │ │ │ │ │ - (InterruptedError, errno.EINTR), │ │ │ │ │ - (PermissionError, errno.EACCES), │ │ │ │ │ - (PermissionError, errno.EPERM), │ │ │ │ │ - (ProcessLookupError, errno.ESRCH), │ │ │ │ │ - (TimeoutError, errno.ETIMEDOUT), │ │ │ │ │ -]) │ │ │ │ │ + On its own, this class doesn't provide a mechanism for exporting anything │ │ │ │ │ + on the bus. The Object class does that, and you'll generally want to │ │ │ │ │ + subclass from it, as it contains several built-in standard interfaces │ │ │ │ │ + (introspection, properties, etc.). │ │ │ │ │ │ │ │ │ │ + The name of your class will be interpreted as a D-Bus interface name. │ │ │ │ │ + Underscores are converted to dots. No case conversion is performed. If │ │ │ │ │ + the interface name can't be represented using this scheme, or if you'd like │ │ │ │ │ + to name your class differently, you can provide an interface= kwarg to the │ │ │ │ │ + class definition. │ │ │ │ │ │ │ │ │ │ -def get_exception_for_ssh_stderr(stderr: str) -> Exception: │ │ │ │ │ - stderr = stderr.replace('\r\n', '\n') # fix line separators │ │ │ │ │ + class com_example_Interface(bus.Object): │ │ │ │ │ + pass │ │ │ │ │ │ │ │ │ │ - # check for the specific error messages first, then for generic SshHostKeyError │ │ │ │ │ - for ssh_cls in [SshAuthenticationError, SshChangedHostKeyError, SshUnknownHostKeyError, SshHostKeyError]: │ │ │ │ │ - match = ssh_cls.PATTERN.search(stderr) │ │ │ │ │ - if match is not None: │ │ │ │ │ - return ssh_cls(match, stderr) │ │ │ │ │ + class MyInterface(bus.Object, interface='org.cockpit_project.Interface'): │ │ │ │ │ + pass │ │ │ │ │ │ │ │ │ │ - before, colon, after = stderr.rpartition(':') │ │ │ │ │ - if colon and after: │ │ │ │ │ - potential_strerror = after.strip() │ │ │ │ │ + The methods, properties, and signals which are visible from D-Bus are │ │ │ │ │ + defined using helper classes with the corresponding names (Method, │ │ │ │ │ + Property, Signal). You should use normal Python snake_case conventions for │ │ │ │ │ + the member names: they will automatically be converted to CamelCase by │ │ │ │ │ + splitting on underscore and converting the first letter of each resulting │ │ │ │ │ + word to uppercase. For example, `method_name` becomes `MethodName`. │ │ │ │ │ │ │ │ │ │ - # DNS lookup errors │ │ │ │ │ - if potential_strerror in gaierror_map: │ │ │ │ │ - errnum = gaierror_map[potential_strerror] │ │ │ │ │ - return socket.gaierror(errnum, stderr) │ │ │ │ │ + Each Method, Property, or Signal constructor takes an optional name= kwargs │ │ │ │ │ + to override the automatic name conversion convention above. │ │ │ │ │ │ │ │ │ │ - # Network connect errors │ │ │ │ │ - for errnum in errno.errorcode: │ │ │ │ │ - if os.strerror(errnum) == potential_strerror: │ │ │ │ │ - os_cls = oserror_subclass_map.get(errnum, OSError) │ │ │ │ │ - return os_cls(errnum, stderr) │ │ │ │ │ + An example class might look like: │ │ │ │ │ │ │ │ │ │ - # No match? Generic. │ │ │ │ │ - return SshError(None, stderr) │ │ │ │ │ -''', │ │ │ │ │ - 'cockpit/_vendor/ferny/askpass.py': br'''from .interaction_client import main │ │ │ │ │ + class com_example_MyObject(bus.Object): │ │ │ │ │ + created = bus.Interface.Signal('s', 'i') │ │ │ │ │ + renames = bus.Interface.Property('u', value=0) │ │ │ │ │ + name = bus.Interface.Property('s', 'undefined') │ │ │ │ │ │ │ │ │ │ -if __name__ == '__main__': │ │ │ │ │ - main() │ │ │ │ │ -''', │ │ │ │ │ - 'cockpit/_vendor/ferny/ssh_askpass.py': br'''import logging │ │ │ │ │ -import re │ │ │ │ │ -from typing import ClassVar, Match, Sequence │ │ │ │ │ + @bus.Interface.Method(out_types=(), in_types='s') │ │ │ │ │ + def rename(self, name): │ │ │ │ │ + self.renames += 1 │ │ │ │ │ + self.name = name │ │ │ │ │ │ │ │ │ │ -from .interaction_agent import AskpassHandler │ │ │ │ │ + def registered(self): │ │ │ │ │ + self.created('Hello', 42) │ │ │ │ │ │ │ │ │ │ -logger = logging.getLogger(__name__) │ │ │ │ │ + See the documentation for the Method, Property, and Signal classes for │ │ │ │ │ + more information and examples. │ │ │ │ │ + """ │ │ │ │ │ │ │ │ │ │ + # Class variables │ │ │ │ │ + _dbus_interfaces: Dict[str, Dict[str, Dict[str, Any]]] │ │ │ │ │ + _dbus_members: Optional[Tuple[str, Dict[str, Dict[str, Any]]]] │ │ │ │ │ │ │ │ │ │ -class AskpassPrompt: │ │ │ │ │ - """An askpass prompt resulting from a call to ferny-askpass. │ │ │ │ │ + # Instance variables: stored in Python form │ │ │ │ │ + _dbus_property_values: Optional[Dict[str, Any]] = None │ │ │ │ │ │ │ │ │ │ - stderr: the contents of stderr from before ferny-askpass was called. │ │ │ │ │ - Likely related to previous failed operations. │ │ │ │ │ - messages: all but the last line of the prompt as handed to ferny-askpass. │ │ │ │ │ - Usually contains context about the question. │ │ │ │ │ - prompt: the last line handed to ferny-askpass. The prompt itself. │ │ │ │ │ - """ │ │ │ │ │ - stderr: str │ │ │ │ │ - messages: str │ │ │ │ │ - prompt: str │ │ │ │ │ + @classmethod │ │ │ │ │ + def __init_subclass__(cls, interface: Optional[str] = None) -> None: │ │ │ │ │ + if interface is None: │ │ │ │ │ + assert '__' not in cls.__name__, 'Class name cannot contain sequential underscores' │ │ │ │ │ + interface = cls.__name__.replace('_', '.') │ │ │ │ │ │ │ │ │ │ - def __init__(self, prompt: str, messages: str, stderr: str) -> None: │ │ │ │ │ - self.stderr = stderr │ │ │ │ │ - self.messages = messages │ │ │ │ │ - self.prompt = prompt │ │ │ │ │ + # This is the information for this subclass directly │ │ │ │ │ + members: Dict[str, Dict[str, Interface._Member]] = {'methods': {}, 'properties': {}, 'signals': {}} │ │ │ │ │ + for name, member in cls.__dict__.items(): │ │ │ │ │ + if isinstance(member, Interface._Member): │ │ │ │ │ + member.setup(interface, name, members) │ │ │ │ │ │ │ │ │ │ - def reply(self, response: str) -> None: │ │ │ │ │ - pass │ │ │ │ │ + # We only store the information if something was actually defined │ │ │ │ │ + if sum(len(category) for category in members.values()) > 0: │ │ │ │ │ + cls._dbus_members = (interface, members) │ │ │ │ │ │ │ │ │ │ - def close(self) -> None: │ │ │ │ │ - pass │ │ │ │ │ + # This is the information for this subclass, with all its ancestors │ │ │ │ │ + cls._dbus_interfaces = dict(ancestor.__dict__['_dbus_members'] │ │ │ │ │ + for ancestor in cls.mro() │ │ │ │ │ + if '_dbus_members' in ancestor.__dict__) │ │ │ │ │ │ │ │ │ │ - async def handle_via(self, responder: 'SshAskpassResponder') -> None: │ │ │ │ │ + @classmethod │ │ │ │ │ + def _find_interface(cls, interface: str) -> Dict[str, Dict[str, '_Member']]: │ │ │ │ │ try: │ │ │ │ │ - response = await self.dispatch(responder) │ │ │ │ │ - if response is not None: │ │ │ │ │ - self.reply(response) │ │ │ │ │ - finally: │ │ │ │ │ - self.close() │ │ │ │ │ - │ │ │ │ │ - async def dispatch(self, responder: 'SshAskpassResponder') -> 'str | None': │ │ │ │ │ - return await responder.do_prompt(self) │ │ │ │ │ - │ │ │ │ │ + return cls._dbus_interfaces[interface] │ │ │ │ │ + except KeyError as exc: │ │ │ │ │ + raise Object.Method.Unhandled from exc │ │ │ │ │ │ │ │ │ │ -class SSHAskpassPrompt(AskpassPrompt): │ │ │ │ │ - # The valid answers to prompts of this type. If this is None then any │ │ │ │ │ - # answer is permitted. If it's a sequence then only answers from the │ │ │ │ │ - # sequence are permitted. If it's an empty sequence, then no answer is │ │ │ │ │ - # permitted (ie: the askpass callback should never return). │ │ │ │ │ - answers: 'ClassVar[Sequence[str] | None]' = None │ │ │ │ │ + @classmethod │ │ │ │ │ + def _find_category(cls, interface: str, category: str) -> Dict[str, '_Member']: │ │ │ │ │ + return cls._find_interface(interface)[category] │ │ │ │ │ │ │ │ │ │ - # Patterns to capture. `_pattern` *must* match. │ │ │ │ │ - _pattern: ClassVar[str] │ │ │ │ │ - # `_extra_patterns` can fill in extra class attributes if they match. │ │ │ │ │ - _extra_patterns: ClassVar[Sequence[str]] = () │ │ │ │ │ + @classmethod │ │ │ │ │ + def _find_member(cls, interface: str, category: str, member: str) -> '_Member': │ │ │ │ │ + members = cls._find_category(interface, category) │ │ │ │ │ + try: │ │ │ │ │ + return members[member] │ │ │ │ │ + except KeyError as exc: │ │ │ │ │ + raise Object.Method.Unhandled from exc │ │ │ │ │ │ │ │ │ │ - def __init__(self, prompt: str, messages: str, stderr: str, match: Match) -> None: │ │ │ │ │ - super().__init__(prompt, messages, stderr) │ │ │ │ │ - self.__dict__.update(match.groupdict()) │ │ │ │ │ + class _Member: │ │ │ │ │ + _category: str # filled in from subclasses │ │ │ │ │ │ │ │ │ │ - for pattern in self._extra_patterns: │ │ │ │ │ - extra_match = re.search(with_helpers(pattern), messages, re.M) │ │ │ │ │ - if extra_match is not None: │ │ │ │ │ - self.__dict__.update(extra_match.groupdict()) │ │ │ │ │ + _python_name: Optional[str] = None │ │ │ │ │ + _name: Optional[str] = None │ │ │ │ │ + _interface: Optional[str] = None │ │ │ │ │ + _description: Optional[Dict[str, Any]] │ │ │ │ │ │ │ │ │ │ + def __init__(self, name: Optional[str] = None) -> None: │ │ │ │ │ + self._python_name = None │ │ │ │ │ + self._interface = None │ │ │ │ │ + self._name = name │ │ │ │ │ │ │ │ │ │ -# Specific prompts │ │ │ │ │ -HELPERS = { │ │ │ │ │ - "%{algorithm}": r"(?P\b[-\w]+\b)", │ │ │ │ │ - "%{filename}": r"(?P.+)", │ │ │ │ │ - "%{fingerprint}": r"(?PSHA256:[0-9A-Za-z+/]{43})", │ │ │ │ │ - "%{hostname}": r"(?P[^ @']+)", │ │ │ │ │ - "%{pkcs11_id}": r"(?P.+)", │ │ │ │ │ - "%{username}": r"(?P[^ @']+)", │ │ │ │ │ -} │ │ │ │ │ + def setup(self, interface: str, name: str, members: Dict[str, Dict[str, 'Interface._Member']]) -> None: │ │ │ │ │ + self._python_name = name # for error messages │ │ │ │ │ + if self._name is None: │ │ │ │ │ + self._name = ''.join(word.title() for word in name.split('_')) │ │ │ │ │ + self._interface = interface │ │ │ │ │ + self._description = self._describe() │ │ │ │ │ + members[self._category][self._name] = self │ │ │ │ │ │ │ │ │ │ + def _describe(self) -> Dict[str, Any]: │ │ │ │ │ + raise NotImplementedError │ │ │ │ │ │ │ │ │ │ -class SshPasswordPrompt(SSHAskpassPrompt): │ │ │ │ │ - _pattern = r"%{username}@%{hostname}'s password: " │ │ │ │ │ - username: 'str | None' = None │ │ │ │ │ - hostname: 'str | None' = None │ │ │ │ │ + def __getitem__(self, key: str) -> Any: │ │ │ │ │ + # Acts as an adaptor for dict accesses from introspection.to_xml() │ │ │ │ │ + assert self._description is not None │ │ │ │ │ + return self._description[key] │ │ │ │ │ │ │ │ │ │ - async def dispatch(self, responder: 'SshAskpassResponder') -> 'str | None': │ │ │ │ │ - return await responder.do_password_prompt(self) │ │ │ │ │ + class Property(_Member): │ │ │ │ │ + """Defines a D-Bus property on an interface │ │ │ │ │ │ │ │ │ │ + There are two main ways to define properties: with and without getters. │ │ │ │ │ + If you define a property without a getter, then you must provide a │ │ │ │ │ + value (via the value= kwarg). In this case, the property value is │ │ │ │ │ + maintained internally and can be accessed from Python in the usual way. │ │ │ │ │ + Change signals are sent automatically. │ │ │ │ │ │ │ │ │ │ -class SshPassphrasePrompt(SSHAskpassPrompt): │ │ │ │ │ - _pattern = r"Enter passphrase for key '%{filename}': " │ │ │ │ │ - filename: str │ │ │ │ │ + class MyObject(bus.Object): │ │ │ │ │ + counter = bus.Interface.Property('i', value=0) │ │ │ │ │ │ │ │ │ │ - async def dispatch(self, responder: 'SshAskpassResponder') -> 'str | None': │ │ │ │ │ - return await responder.do_passphrase_prompt(self) │ │ │ │ │ + a = MyObject() │ │ │ │ │ + a.counter = 5 │ │ │ │ │ + a.counter += 1 │ │ │ │ │ + print(a.counter) │ │ │ │ │ │ │ │ │ │ + The other way to define properties is with a getter function. In this │ │ │ │ │ + case, you can read from the property in the normal way, but not write │ │ │ │ │ + to it. You are responsible for emitting change signals for yourself. │ │ │ │ │ + You must not provide the value= kwarg. │ │ │ │ │ │ │ │ │ │ -class SshFIDOPINPrompt(SSHAskpassPrompt): │ │ │ │ │ - _pattern = r"Enter PIN for %{algorithm} key %{filename}: " │ │ │ │ │ - algorithm: str │ │ │ │ │ - filename: str │ │ │ │ │ + class MyObject(bus.Object): │ │ │ │ │ + _counter = 0 │ │ │ │ │ │ │ │ │ │ - async def dispatch(self, responder: 'SshAskpassResponder') -> 'str | None': │ │ │ │ │ - return await responder.do_fido_pin_prompt(self) │ │ │ │ │ + counter = bus.Interface.Property('i') │ │ │ │ │ + @counter.getter │ │ │ │ │ + def get_counter(self): │ │ │ │ │ + return self._counter │ │ │ │ │ │ │ │ │ │ + @counter.setter │ │ │ │ │ + def set_counter(self, value): │ │ │ │ │ + self._counter = value │ │ │ │ │ + self.property_changed('Counter') │ │ │ │ │ │ │ │ │ │ -class SshFIDOUserPresencePrompt(SSHAskpassPrompt): │ │ │ │ │ - _pattern = r"Confirm user presence for key %{algorithm} %{fingerprint}" │ │ │ │ │ - answers = () │ │ │ │ │ - algorithm: str │ │ │ │ │ - fingerprint: str │ │ │ │ │ + In either case, you can provide a setter function. This function has │ │ │ │ │ + no impact on Python code, but makes the property writable from the view │ │ │ │ │ + of D-Bus. Your setter will be called when a Properties.Set() call is │ │ │ │ │ + made, and no other action will be performed. A trivial implementation │ │ │ │ │ + might look like: │ │ │ │ │ │ │ │ │ │ - async def dispatch(self, responder: 'SshAskpassResponder') -> 'str | None': │ │ │ │ │ - return await responder.do_fido_user_presence_prompt(self) │ │ │ │ │ + class MyObject(bus.Object): │ │ │ │ │ + counter = bus.Interface.Property('i', value=0) │ │ │ │ │ + @counter.setter │ │ │ │ │ + def set_counter(self, value): │ │ │ │ │ + # we got a request to set the counter from D-Bus │ │ │ │ │ + self.counter = value │ │ │ │ │ │ │ │ │ │ + In all cases, the first (and only mandatory) argument to the │ │ │ │ │ + constructor is the D-Bus type of the property. │ │ │ │ │ │ │ │ │ │ -class SshPKCS11PINPrompt(SSHAskpassPrompt): │ │ │ │ │ - _pattern = r"Enter PIN for '%{pkcs11_id}': " │ │ │ │ │ - pkcs11_id: str │ │ │ │ │ + Your getter and setter functions can be provided by kwarg to the │ │ │ │ │ + constructor. You can also give a name= kwarg to override the default │ │ │ │ │ + name conversion scheme. │ │ │ │ │ + """ │ │ │ │ │ + _category = 'properties' │ │ │ │ │ │ │ │ │ │ - async def dispatch(self, responder: 'SshAskpassResponder') -> 'str | None': │ │ │ │ │ - return await responder.do_pkcs11_pin_prompt(self) │ │ │ │ │ + _getter: Optional[Callable[[Any], Any]] │ │ │ │ │ + _setter: Optional[Callable[[Any, Any], None]] │ │ │ │ │ + _type: bustypes.Type │ │ │ │ │ + _value: Any │ │ │ │ │ │ │ │ │ │ + def __init__(self, type_string: str, │ │ │ │ │ + value: Any = None, │ │ │ │ │ + name: Optional[str] = None, │ │ │ │ │ + getter: Optional[Callable[[Any], Any]] = None, │ │ │ │ │ + setter: Optional[Callable[[Any, Any], None]] = None): │ │ │ │ │ + assert value is None or getter is None, 'A property cannot have both a value and a getter' │ │ │ │ │ │ │ │ │ │ -class SshHostKeyPrompt(SSHAskpassPrompt): │ │ │ │ │ - _pattern = r"Are you sure you want to continue connecting \(yes/no(/\[fingerprint\])?\)\? " │ │ │ │ │ - _extra_patterns = [ │ │ │ │ │ - r"%{fingerprint}[.]$", │ │ │ │ │ - r"^%{algorithm} key fingerprint is", │ │ │ │ │ - r"^The fingerprint for the %{algorithm} key sent by the remote host is$" │ │ │ │ │ - ] │ │ │ │ │ - answers = ('yes', 'no') │ │ │ │ │ - algorithm: str │ │ │ │ │ - fingerprint: str │ │ │ │ │ + super().__init__(name=name) │ │ │ │ │ + self._getter = getter │ │ │ │ │ + self._setter = setter │ │ │ │ │ + self._type, = bustypes.from_signature(type_string) │ │ │ │ │ + self._value = value │ │ │ │ │ │ │ │ │ │ - async def dispatch(self, responder: 'SshAskpassResponder') -> 'str | None': │ │ │ │ │ - return await responder.do_host_key_prompt(self) │ │ │ │ │ + def _describe(self) -> Dict[str, Any]: │ │ │ │ │ + return {'type': self._type.typestring, 'flags': 'r' if self._setter is None else 'w'} │ │ │ │ │ │ │ │ │ │ + def __get__(self, obj: 'Object', cls: Optional[type] = None) -> Any: │ │ │ │ │ + assert self._name is not None │ │ │ │ │ + if obj is None: │ │ │ │ │ + return self │ │ │ │ │ + if self._getter is not None: │ │ │ │ │ + return self._getter.__get__(obj, cls)() │ │ │ │ │ + elif self._value is not None: │ │ │ │ │ + if obj._dbus_property_values is not None: │ │ │ │ │ + return obj._dbus_property_values.get(self._name, self._value) │ │ │ │ │ + else: │ │ │ │ │ + return self._value │ │ │ │ │ + else: │ │ │ │ │ + raise AttributeError(f"'{obj.__class__.__name__}' property '{self._python_name}' " │ │ │ │ │ + f"was not properly initialised: use either the 'value=' kwarg or " │ │ │ │ │ + f"the @'{self._python_name}.getter' decorator") │ │ │ │ │ │ │ │ │ │ -def with_helpers(pattern: str) -> str: │ │ │ │ │ - for name, helper in HELPERS.items(): │ │ │ │ │ - pattern = pattern.replace(name, helper) │ │ │ │ │ + def __set__(self, obj: 'Object', value: Any) -> None: │ │ │ │ │ + assert self._name is not None │ │ │ │ │ + if self._getter is not None: │ │ │ │ │ + raise AttributeError(f"Cannot directly assign '{obj.__class__.__name__}' " │ │ │ │ │ + "property '{self._python_name}' because it has a getter") │ │ │ │ │ + if obj._dbus_property_values is None: │ │ │ │ │ + obj._dbus_property_values = {} │ │ │ │ │ + obj._dbus_property_values[self._name] = value │ │ │ │ │ + if obj._dbus_bus is not None: │ │ │ │ │ + obj.properties_changed(self._interface, {self._name: bustypes.Variant(value, self._type)}, []) │ │ │ │ │ │ │ │ │ │ - assert '%{' not in pattern │ │ │ │ │ - return pattern │ │ │ │ │ + def to_dbus(self, obj: 'Object') -> bustypes.Variant: │ │ │ │ │ + return bustypes.Variant(self.__get__(obj), self._type) │ │ │ │ │ │ │ │ │ │ + def from_dbus(self, obj: 'Object', value: bustypes.Variant) -> None: │ │ │ │ │ + if self._setter is None or self._type != value.type: │ │ │ │ │ + raise Object.Method.Unhandled │ │ │ │ │ + self._setter.__get__(obj)(value.value) │ │ │ │ │ │ │ │ │ │ -def categorize_ssh_prompt(string: str, stderr: str) -> AskpassPrompt: │ │ │ │ │ - classes = [ │ │ │ │ │ - SshFIDOPINPrompt, │ │ │ │ │ - SshFIDOUserPresencePrompt, │ │ │ │ │ - SshHostKeyPrompt, │ │ │ │ │ - SshPKCS11PINPrompt, │ │ │ │ │ - SshPassphrasePrompt, │ │ │ │ │ - SshPasswordPrompt, │ │ │ │ │ - ] │ │ │ │ │ + def getter(self, getter: Callable[[Any], Any]) -> Callable[[Any], Any]: │ │ │ │ │ + if self._value is not None: │ │ │ │ │ + raise ValueError('A property cannot have both a value and a getter') │ │ │ │ │ + if self._getter is not None: │ │ │ │ │ + raise ValueError('This property already has a getter') │ │ │ │ │ + self._getter = getter │ │ │ │ │ + return getter │ │ │ │ │ │ │ │ │ │ - # The last line is the line after the last newline character, excluding the │ │ │ │ │ - # optional final newline character. eg: "x\ny\nLAST\n" or "x\ny\nLAST" │ │ │ │ │ - second_last_newline = string.rfind('\n', 0, -1) │ │ │ │ │ - if second_last_newline >= 0: │ │ │ │ │ - last_line = string[second_last_newline + 1:] │ │ │ │ │ - extras = string[:second_last_newline + 1] │ │ │ │ │ - else: │ │ │ │ │ - last_line = string │ │ │ │ │ - extras = '' │ │ │ │ │ + def setter(self, setter: Callable[[Any, Any], None]) -> Callable[[Any, Any], None]: │ │ │ │ │ + self._setter = setter │ │ │ │ │ + return setter │ │ │ │ │ │ │ │ │ │ - for cls in classes: │ │ │ │ │ - pattern = with_helpers(cls._pattern) │ │ │ │ │ - match = re.fullmatch(pattern, last_line) │ │ │ │ │ - if match is not None: │ │ │ │ │ - return cls(last_line, extras, stderr, match) │ │ │ │ │ + class Signal(_Member): │ │ │ │ │ + """Defines a D-Bus signal on an interface │ │ │ │ │ │ │ │ │ │ - return AskpassPrompt(last_line, extras, stderr) │ │ │ │ │ + This is a callable which will result in the signal being emitted. │ │ │ │ │ │ │ │ │ │ + The constructor takes the types of the arguments, each one as a │ │ │ │ │ + separate parameter. For example: │ │ │ │ │ │ │ │ │ │ -class SshAskpassResponder(AskpassHandler): │ │ │ │ │ - async def do_askpass(self, stderr: str, prompt: str, hint: str) -> 'str | None': │ │ │ │ │ - return await categorize_ssh_prompt(prompt, stderr).dispatch(self) │ │ │ │ │ + properties_changed = Interface.Signal('s', 'a{sv}', 'as') │ │ │ │ │ │ │ │ │ │ - async def do_prompt(self, prompt: AskpassPrompt) -> 'str | None': │ │ │ │ │ - # Default fallback for unrecognised message types: unimplemented │ │ │ │ │ - return None │ │ │ │ │ + You can give a name= kwarg to override the default name conversion │ │ │ │ │ + scheme. │ │ │ │ │ + """ │ │ │ │ │ + _category = 'signals' │ │ │ │ │ + _type: bustypes.MessageType │ │ │ │ │ │ │ │ │ │ - async def do_fido_pin_prompt(self, prompt: SshFIDOPINPrompt) -> 'str | None': │ │ │ │ │ - return await self.do_prompt(prompt) │ │ │ │ │ + def __init__(self, *out_types: str, name: Optional[str] = None) -> None: │ │ │ │ │ + super().__init__(name=name) │ │ │ │ │ + self._type = bustypes.MessageType(out_types) │ │ │ │ │ │ │ │ │ │ - async def do_fido_user_presence_prompt(self, prompt: SshFIDOUserPresencePrompt) -> 'str | None': │ │ │ │ │ - return await self.do_prompt(prompt) │ │ │ │ │ + def _describe(self) -> Dict[str, Any]: │ │ │ │ │ + return {'in': self._type.typestrings} │ │ │ │ │ │ │ │ │ │ - async def do_host_key_prompt(self, prompt: SshHostKeyPrompt) -> 'str | None': │ │ │ │ │ - return await self.do_prompt(prompt) │ │ │ │ │ + def __get__(self, obj: 'Object', cls: Optional[type] = None) -> Callable[..., None]: │ │ │ │ │ + def emitter(obj: Object, *args: Any) -> None: │ │ │ │ │ + assert self._interface is not None │ │ │ │ │ + assert self._name is not None │ │ │ │ │ + assert obj._dbus_bus is not None │ │ │ │ │ + assert obj._dbus_path is not None │ │ │ │ │ + message = obj._dbus_bus.message_new_signal(obj._dbus_path, self._interface, self._name) │ │ │ │ │ + self._type.write(message, *args) │ │ │ │ │ + message.send() │ │ │ │ │ + return emitter.__get__(obj, cls) │ │ │ │ │ │ │ │ │ │ - async def do_pkcs11_pin_prompt(self, prompt: SshPKCS11PINPrompt) -> 'str | None': │ │ │ │ │ - return await self.do_prompt(prompt) │ │ │ │ │ + class Method(_Member): │ │ │ │ │ + """Defines a D-Bus method on an interface │ │ │ │ │ │ │ │ │ │ - async def do_passphrase_prompt(self, prompt: SshPassphrasePrompt) -> 'str | None': │ │ │ │ │ - return await self.do_prompt(prompt) │ │ │ │ │ + This is a function decorator which marks a given method for export. │ │ │ │ │ │ │ │ │ │ - async def do_password_prompt(self, prompt: SshPasswordPrompt) -> 'str | None': │ │ │ │ │ - return await self.do_prompt(prompt) │ │ │ │ │ -''', │ │ │ │ │ - 'cockpit/data/fail.html': br''' │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ - @@message@@ │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -
│ │ │ │ │ - │ │ │ │ │ -

@@message@@

│ │ │ │ │ -
│ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -''', │ │ │ │ │ - 'cockpit/data/__init__.py': br'''import sys │ │ │ │ │ + The constructor takes two arguments: the type of the output arguments, │ │ │ │ │ + and the type of the input arguments. Both should be given as a │ │ │ │ │ + sequence. │ │ │ │ │ │ │ │ │ │ -if sys.version_info >= (3, 11): │ │ │ │ │ - import importlib.resources │ │ │ │ │ + @Interface.Method(['a{sv}'], ['s']) │ │ │ │ │ + def get_all(self, interface): │ │ │ │ │ + ... │ │ │ │ │ │ │ │ │ │ - def read_cockpit_data_file(filename: str) -> bytes: │ │ │ │ │ - return (importlib.resources.files('cockpit.data') / filename).read_bytes() │ │ │ │ │ + You can give a name= kwarg to override the default name conversion │ │ │ │ │ + scheme. │ │ │ │ │ + """ │ │ │ │ │ + _category = 'methods' │ │ │ │ │ │ │ │ │ │ -else: │ │ │ │ │ - import importlib.abc │ │ │ │ │ + class Unhandled(Exception): │ │ │ │ │ + """Raised by a method to indicate that the message triggering that │ │ │ │ │ + method call remains unhandled.""" │ │ │ │ │ + pass │ │ │ │ │ │ │ │ │ │ - def read_cockpit_data_file(filename: str) -> bytes: │ │ │ │ │ - # https://github.com/python/mypy/issues/4182 │ │ │ │ │ - loader = __loader__ # type: ignore[name-defined] │ │ │ │ │ - assert isinstance(loader, importlib.abc.ResourceLoader) │ │ │ │ │ + def __init__(self, out_types: Sequence[str] = (), in_types: Sequence[str] = (), name: Optional[str] = None): │ │ │ │ │ + super().__init__(name=name) │ │ │ │ │ + self._out_type = bustypes.MessageType(out_types) │ │ │ │ │ + self._in_type = bustypes.MessageType(in_types) │ │ │ │ │ + self._func = None │ │ │ │ │ │ │ │ │ │ - path = __file__.replace('__init__.py', filename) │ │ │ │ │ - return loader.get_data(path) │ │ │ │ │ -''', │ │ │ │ │ - 'cockpit/channels/http.py': br'''# This file is part of Cockpit. │ │ │ │ │ -# │ │ │ │ │ -# Copyright (C) 2022 Red Hat, Inc. │ │ │ │ │ -# │ │ │ │ │ -# This program is free software: you can redistribute it and/or modify │ │ │ │ │ -# it under the terms of the GNU General Public License as published by │ │ │ │ │ -# the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ -# (at your option) any later version. │ │ │ │ │ -# │ │ │ │ │ -# This program is distributed in the hope that it will be useful, │ │ │ │ │ -# but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ -# GNU General Public License for more details. │ │ │ │ │ -# │ │ │ │ │ -# You should have received a copy of the GNU General Public License │ │ │ │ │ -# along with this program. If not, see . │ │ │ │ │ + def __get__(self, obj, cls=None): │ │ │ │ │ + return self._func.__get__(obj, cls) │ │ │ │ │ │ │ │ │ │ -import http.client │ │ │ │ │ -import logging │ │ │ │ │ -import socket │ │ │ │ │ -import ssl │ │ │ │ │ + def __call__(self, *args, **kwargs): │ │ │ │ │ + # decorator │ │ │ │ │ + self._func, = args │ │ │ │ │ + return self │ │ │ │ │ │ │ │ │ │ -from ..channel import AsyncChannel, ChannelError │ │ │ │ │ -from ..jsonutil import JsonObject, get_dict, get_enum, get_int, get_object, get_str, typechecked │ │ │ │ │ + def _describe(self) -> Dict[str, Any]: │ │ │ │ │ + return {'in': [item.typestring for item in self._in_type.item_types], │ │ │ │ │ + 'out': [item.typestring for item in self._out_type.item_types]} │ │ │ │ │ │ │ │ │ │ -logger = logging.getLogger(__name__) │ │ │ │ │ + def _invoke(self, obj, message): │ │ │ │ │ + args = self._in_type.read(message) │ │ │ │ │ + if args is None: │ │ │ │ │ + return False │ │ │ │ │ + try: │ │ │ │ │ + result = self._func.__get__(obj)(*args) │ │ │ │ │ + except (BusError, OSError) as error: │ │ │ │ │ + return message.reply_method_error(error) │ │ │ │ │ │ │ │ │ │ + return message.reply_method_function_return_value(self._out_type, result) │ │ │ │ │ │ │ │ │ │ -class HttpChannel(AsyncChannel): │ │ │ │ │ - payload = 'http-stream2' │ │ │ │ │ │ │ │ │ │ +class org_freedesktop_DBus_Peer(Interface): │ │ │ │ │ + @Interface.Method() │ │ │ │ │ @staticmethod │ │ │ │ │ - def get_headers(response: http.client.HTTPResponse, *, binary: bool) -> JsonObject: │ │ │ │ │ - # Never send these headers │ │ │ │ │ - remove = {'Connection', 'Transfer-Encoding'} │ │ │ │ │ - │ │ │ │ │ - if not binary: │ │ │ │ │ - # Only send these headers for raw binary streams │ │ │ │ │ - remove.update({'Content-Length', 'Range'}) │ │ │ │ │ - │ │ │ │ │ - return {key: value for key, value in response.getheaders() if key not in remove} │ │ │ │ │ + def ping() -> None: │ │ │ │ │ + pass │ │ │ │ │ │ │ │ │ │ + @Interface.Method('s') │ │ │ │ │ @staticmethod │ │ │ │ │ - def create_client(options: JsonObject) -> http.client.HTTPConnection: │ │ │ │ │ - opt_address = get_str(options, 'address', 'localhost') │ │ │ │ │ - opt_tls = get_dict(options, 'tls', None) │ │ │ │ │ - opt_unix = get_str(options, 'unix', None) │ │ │ │ │ - opt_port = get_int(options, 'port', None) │ │ │ │ │ - │ │ │ │ │ - if opt_tls is not None and opt_unix is not None: │ │ │ │ │ - raise ChannelError('protocol-error', message='TLS on Unix socket is not supported') │ │ │ │ │ - if opt_port is None and opt_unix is None: │ │ │ │ │ - raise ChannelError('protocol-error', message='no "port" or "unix" option for channel') │ │ │ │ │ - if opt_port is not None and opt_unix is not None: │ │ │ │ │ - raise ChannelError('protocol-error', message='cannot specify both "port" and "unix" options') │ │ │ │ │ - │ │ │ │ │ - if opt_tls is not None: │ │ │ │ │ - authority = get_dict(opt_tls, 'authority', None) │ │ │ │ │ - if authority is not None: │ │ │ │ │ - data = get_str(authority, 'data', None) │ │ │ │ │ - if data is not None: │ │ │ │ │ - context = ssl.create_default_context(cadata=data) │ │ │ │ │ - else: │ │ │ │ │ - context = ssl.create_default_context(cafile=get_str(authority, 'file')) │ │ │ │ │ - else: │ │ │ │ │ - context = ssl.create_default_context() │ │ │ │ │ - │ │ │ │ │ - if 'validate' in opt_tls and not opt_tls['validate']: │ │ │ │ │ - context.check_hostname = False │ │ │ │ │ - context.verify_mode = ssl.VerifyMode.CERT_NONE │ │ │ │ │ - │ │ │ │ │ - # See https://github.com/python/typeshed/issues/11057 │ │ │ │ │ - return http.client.HTTPSConnection(opt_address, port=opt_port, context=context) # type: ignore[arg-type] │ │ │ │ │ - │ │ │ │ │ - else: │ │ │ │ │ - return http.client.HTTPConnection(opt_address, port=opt_port) │ │ │ │ │ + def get_machine_id() -> str: │ │ │ │ │ + with open('/etc/machine-id', encoding='ascii') as file: │ │ │ │ │ + return file.read().strip() │ │ │ │ │ │ │ │ │ │ - @staticmethod │ │ │ │ │ - def connect(connection: http.client.HTTPConnection, opt_unix: 'str | None') -> None: │ │ │ │ │ - # Blocks. Runs in a thread. │ │ │ │ │ - if opt_unix: │ │ │ │ │ - # create the connection's socket so that it won't call .connect() internally (which only supports TCP) │ │ │ │ │ - connection.sock = socket.socket(socket.AF_UNIX) │ │ │ │ │ - connection.sock.connect(opt_unix) │ │ │ │ │ - else: │ │ │ │ │ - # explicitly call connect(), so that we can do proper error handling │ │ │ │ │ - connection.connect() │ │ │ │ │ │ │ │ │ │ - @staticmethod │ │ │ │ │ - def request( │ │ │ │ │ - connection: http.client.HTTPConnection, method: str, path: str, headers: 'dict[str, str]', body: bytes │ │ │ │ │ - ) -> http.client.HTTPResponse: │ │ │ │ │ - # Blocks. Runs in a thread. │ │ │ │ │ - connection.request(method, path, headers=headers or {}, body=body) │ │ │ │ │ - return connection.getresponse() │ │ │ │ │ +class org_freedesktop_DBus_Introspectable(Interface): │ │ │ │ │ + @Interface.Method('s') │ │ │ │ │ + @classmethod │ │ │ │ │ + def introspect(cls) -> str: │ │ │ │ │ + return introspection.to_xml(cls._dbus_interfaces) │ │ │ │ │ │ │ │ │ │ - async def run(self, options: JsonObject) -> None: │ │ │ │ │ - logger.debug('open %s', options) │ │ │ │ │ │ │ │ │ │ - binary = get_enum(options, 'binary', ['raw'], None) is not None │ │ │ │ │ - method = get_str(options, 'method') │ │ │ │ │ - path = get_str(options, 'path') │ │ │ │ │ - headers = get_object(options, 'headers', lambda d: {k: typechecked(v, str) for k, v in d.items()}, None) │ │ │ │ │ +class org_freedesktop_DBus_Properties(Interface): │ │ │ │ │ + properties_changed = Interface.Signal('s', 'a{sv}', 'as') │ │ │ │ │ │ │ │ │ │ - if 'connection' in options: │ │ │ │ │ - raise ChannelError('protocol-error', message='connection sharing is not implemented on this bridge') │ │ │ │ │ + @Interface.Method('v', 'ss') │ │ │ │ │ + def get(self, interface, name): │ │ │ │ │ + return self._find_member(interface, 'properties', name).to_dbus(self) │ │ │ │ │ │ │ │ │ │ - connection = self.create_client(options) │ │ │ │ │ + @Interface.Method(['a{sv}'], 's') │ │ │ │ │ + def get_all(self, interface): │ │ │ │ │ + properties = self._find_category(interface, 'properties') │ │ │ │ │ + return {name: prop.to_dbus(self) for name, prop in properties.items()} │ │ │ │ │ │ │ │ │ │ - self.ready() │ │ │ │ │ + @Interface.Method('', 'ssv') │ │ │ │ │ + def set(self, interface, name, value): │ │ │ │ │ + self._find_member(interface, 'properties', name).from_dbus(self, value) │ │ │ │ │ │ │ │ │ │ - body = b'' │ │ │ │ │ - while True: │ │ │ │ │ - data = await self.read() │ │ │ │ │ - if data is None: │ │ │ │ │ - break │ │ │ │ │ - body += data │ │ │ │ │ │ │ │ │ │ - # Connect in a thread and handle errors │ │ │ │ │ - try: │ │ │ │ │ - await self.in_thread(self.connect, connection, get_str(options, 'unix', None)) │ │ │ │ │ - except ssl.SSLCertVerificationError as exc: │ │ │ │ │ - raise ChannelError('unknown-hostkey', message=str(exc)) from exc │ │ │ │ │ - except (OSError, IOError) as exc: │ │ │ │ │ - raise ChannelError('not-found', message=str(exc)) from exc │ │ │ │ │ +class Object(org_freedesktop_DBus_Introspectable, │ │ │ │ │ + org_freedesktop_DBus_Peer, │ │ │ │ │ + org_freedesktop_DBus_Properties, │ │ │ │ │ + BaseObject, │ │ │ │ │ + Interface): │ │ │ │ │ + """High-level base class for exporting objects on D-Bus │ │ │ │ │ │ │ │ │ │ - # Submit request in a thread and handle errors │ │ │ │ │ - try: │ │ │ │ │ - response = await self.in_thread(self.request, connection, method, path, headers or {}, body) │ │ │ │ │ - except (http.client.HTTPException, OSError) as exc: │ │ │ │ │ - raise ChannelError('terminated', message=str(exc)) from exc │ │ │ │ │ + This is usually where you should start. │ │ │ │ │ │ │ │ │ │ - self.send_control(command='response', │ │ │ │ │ - status=response.status, │ │ │ │ │ - reason=response.reason, │ │ │ │ │ - headers=self.get_headers(response, binary=binary)) │ │ │ │ │ + This provides a base for exporting objects on the bus, implements the │ │ │ │ │ + standard D-Bus interfaces, and allows you to add your own interfaces to the │ │ │ │ │ + mix. See the documentation for Interface to find out how to define and │ │ │ │ │ + implement your D-Bus interface. │ │ │ │ │ + """ │ │ │ │ │ + def message_received(self, message: BusMessage) -> bool: │ │ │ │ │ + interface = message.get_interface() │ │ │ │ │ + name = message.get_member() │ │ │ │ │ │ │ │ │ │ - # Receive the body and finish up │ │ │ │ │ try: │ │ │ │ │ - while True: │ │ │ │ │ - block = await self.in_thread(response.read1, self.BLOCK_SIZE) │ │ │ │ │ - if not block: │ │ │ │ │ - break │ │ │ │ │ - await self.write(block) │ │ │ │ │ - │ │ │ │ │ - logger.debug('reading response done') │ │ │ │ │ - # this returns immediately and does not read anything more, but updates the http.client's │ │ │ │ │ - # internal state machine to "response done" │ │ │ │ │ - block = response.read() │ │ │ │ │ - assert block == b'' │ │ │ │ │ - │ │ │ │ │ - await self.in_thread(connection.close) │ │ │ │ │ - except (http.client.HTTPException, OSError) as exc: │ │ │ │ │ - raise ChannelError('terminated', message=str(exc)) from exc │ │ │ │ │ - │ │ │ │ │ - self.done() │ │ │ │ │ + method = self._find_member(interface, 'methods', name) │ │ │ │ │ + assert isinstance(method, Interface.Method) │ │ │ │ │ + return method._invoke(self, message) │ │ │ │ │ + except Object.Method.Unhandled: │ │ │ │ │ + return False │ │ │ │ │ ''', │ │ │ │ │ - 'cockpit/channels/packages.py': br'''# This file is part of Cockpit. │ │ │ │ │ -# │ │ │ │ │ -# Copyright (C) 2022 Red Hat, Inc. │ │ │ │ │ -# │ │ │ │ │ -# This program is free software: you can redistribute it and/or modify │ │ │ │ │ -# it under the terms of the GNU General Public License as published by │ │ │ │ │ -# the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ -# (at your option) any later version. │ │ │ │ │ -# │ │ │ │ │ -# This program is distributed in the hope that it will be useful, │ │ │ │ │ -# but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ -# GNU General Public License for more details. │ │ │ │ │ -# │ │ │ │ │ -# You should have received a copy of the GNU General Public License │ │ │ │ │ -# along with this program. If not, see . │ │ │ │ │ - │ │ │ │ │ -import logging │ │ │ │ │ -from typing import Optional │ │ │ │ │ - │ │ │ │ │ -from ..channel import AsyncChannel │ │ │ │ │ -from ..data import read_cockpit_data_file │ │ │ │ │ -from ..jsonutil import JsonObject, get_dict, get_str │ │ │ │ │ -from ..packages import Packages │ │ │ │ │ - │ │ │ │ │ -logger = logging.getLogger(__name__) │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -class PackagesChannel(AsyncChannel): │ │ │ │ │ - payload = 'http-stream1' │ │ │ │ │ - restrictions = [("internal", "packages")] │ │ │ │ │ - │ │ │ │ │ - # used to carry data forward from open to done │ │ │ │ │ - options: Optional[JsonObject] = None │ │ │ │ │ - │ │ │ │ │ - def http_error(self, status: int, message: str) -> None: │ │ │ │ │ - template = read_cockpit_data_file('fail.html') │ │ │ │ │ - self.send_json(status=status, reason='ERROR', headers={'Content-Type': 'text/html; charset=utf-8'}) │ │ │ │ │ - self.send_data(template.replace(b'@@message@@', message.encode('utf-8'))) │ │ │ │ │ - self.done() │ │ │ │ │ - self.close() │ │ │ │ │ - │ │ │ │ │ - async def run(self, options: JsonObject) -> None: │ │ │ │ │ - packages: Packages = self.router.packages # type: ignore[attr-defined] # yes, this is evil │ │ │ │ │ - │ │ │ │ │ - try: │ │ │ │ │ - if get_str(options, 'method') != 'GET': │ │ │ │ │ - raise ValueError(f'Unsupported HTTP method {options["method"]}') │ │ │ │ │ - │ │ │ │ │ - self.ready() │ │ │ │ │ - if await self.read() is not None: │ │ │ │ │ - raise ValueError('Received unexpected data') │ │ │ │ │ - │ │ │ │ │ - path = get_str(options, 'path') │ │ │ │ │ - headers = get_dict(options, 'headers') │ │ │ │ │ - document = packages.load_path(path, headers) │ │ │ │ │ - │ │ │ │ │ - # Note: we can't cache documents right now. See │ │ │ │ │ - # https://github.com/cockpit-project/cockpit/issues/19071 │ │ │ │ │ - # for future plans. │ │ │ │ │ - out_headers = { │ │ │ │ │ - 'Cache-Control': 'no-cache, no-store', │ │ │ │ │ - 'Content-Type': document.content_type, │ │ │ │ │ - } │ │ │ │ │ - │ │ │ │ │ - if document.content_encoding is not None: │ │ │ │ │ - out_headers['Content-Encoding'] = document.content_encoding │ │ │ │ │ - │ │ │ │ │ - if document.content_security_policy is not None: │ │ │ │ │ - policy = document.content_security_policy │ │ │ │ │ - │ │ │ │ │ - # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/connect-src │ │ │ │ │ - # │ │ │ │ │ - # Note: connect-src 'self' does not resolve to websocket │ │ │ │ │ - # schemes in all browsers, more info in this issue. │ │ │ │ │ - # │ │ │ │ │ - # https://github.com/w3c/webappsec-csp/issues/7 │ │ │ │ │ - if "connect-src 'self';" in policy: │ │ │ │ │ - protocol = headers.get('X-Forwarded-Proto') │ │ │ │ │ - host = headers.get('X-Forwarded-Host') │ │ │ │ │ - if not isinstance(protocol, str) or not isinstance(host, str): │ │ │ │ │ - raise ValueError('Invalid host or protocol header') │ │ │ │ │ - │ │ │ │ │ - websocket_scheme = "wss" if protocol == "https" else "ws" │ │ │ │ │ - websocket_origin = f"{websocket_scheme}://{host}" │ │ │ │ │ - policy = policy.replace("connect-src 'self';", f"connect-src {websocket_origin} 'self';") │ │ │ │ │ + 'cockpit/_vendor/systemd_ctypes/py.typed': br'''''', │ │ │ │ │ + 'cockpit/_vendor/bei/tmpfs.py': br'''import os │ │ │ │ │ +import subprocess │ │ │ │ │ +import sys │ │ │ │ │ +import tempfile │ │ │ │ │ │ │ │ │ │ - out_headers['Content-Security-Policy'] = policy │ │ │ │ │ │ │ │ │ │ - except ValueError as exc: │ │ │ │ │ - self.http_error(400, str(exc)) │ │ │ │ │ +def main(*command: str) -> None: │ │ │ │ │ + with tempfile.TemporaryDirectory() as tmpdir: │ │ │ │ │ + os.chdir(tmpdir) │ │ │ │ │ │ │ │ │ │ - except KeyError: │ │ │ │ │ - self.http_error(404, 'Not found') │ │ │ │ │ + for key, value in __loader__.get_contents().items(): │ │ │ │ │ + if key.startswith('tmpfs/'): │ │ │ │ │ + subdir = os.path.dirname(key) │ │ │ │ │ + os.makedirs(subdir, exist_ok=True) │ │ │ │ │ + with open(key, 'wb') as fp: │ │ │ │ │ + fp.write(value) │ │ │ │ │ │ │ │ │ │ - except OSError as exc: │ │ │ │ │ - self.http_error(500, f'Internal error: {exc!s}') │ │ │ │ │ + os.chdir('tmpfs') │ │ │ │ │ │ │ │ │ │ - else: │ │ │ │ │ - self.send_json(status=200, reason='OK', headers=out_headers) │ │ │ │ │ - await self.sendfile(document.data) │ │ │ │ │ + result = subprocess.run(command, check=False) │ │ │ │ │ + sys.exit(result.returncode) │ │ │ │ │ ''', │ │ │ │ │ - 'cockpit/channels/dbus.py': r'''# This file is part of Cockpit. │ │ │ │ │ + 'cockpit/_vendor/bei/beipack.py': br'''# beipack - Remote bootloader for Python │ │ │ │ │ # │ │ │ │ │ -# Copyright (C) 2022 Red Hat, Inc. │ │ │ │ │ +# Copyright (C) 2022 Allison Karlitskaya │ │ │ │ │ # │ │ │ │ │ # This program is free software: you can redistribute it and/or modify │ │ │ │ │ # it under the terms of the GNU General Public License as published by │ │ │ │ │ # the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ # (at your option) any later version. │ │ │ │ │ # │ │ │ │ │ # This program is distributed in the hope that it will be useful, │ │ │ │ │ # but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ # GNU General Public License for more details. │ │ │ │ │ # │ │ │ │ │ # You should have received a copy of the GNU General Public License │ │ │ │ │ -# along with this program. If not, see . │ │ │ │ │ - │ │ │ │ │ -# Missing stuff compared to the C bridge that we should probably add: │ │ │ │ │ -# │ │ │ │ │ -# - removing matches │ │ │ │ │ -# - removing watches │ │ │ │ │ -# - emitting of signals │ │ │ │ │ -# - publishing of objects │ │ │ │ │ -# - failing more gracefully in some cases (during open, etc) │ │ │ │ │ -# │ │ │ │ │ -# Stuff we might or might not do: │ │ │ │ │ -# │ │ │ │ │ -# - using non-default service names │ │ │ │ │ -# │ │ │ │ │ -# Stuff we should probably not do: │ │ │ │ │ -# │ │ │ │ │ -# - emulation of ObjectManager via recursive introspection │ │ │ │ │ -# - automatic detection of ObjectManager below the given path_namespace │ │ │ │ │ -# - recursive scraping of properties for new object paths │ │ │ │ │ -# (for path_namespace watches that don't hit an ObjectManager) │ │ │ │ │ - │ │ │ │ │ -import asyncio │ │ │ │ │ -import errno │ │ │ │ │ -import json │ │ │ │ │ -import logging │ │ │ │ │ -import traceback │ │ │ │ │ -import xml.etree.ElementTree as ET │ │ │ │ │ - │ │ │ │ │ -from cockpit._vendor import systemd_ctypes │ │ │ │ │ -from cockpit._vendor.systemd_ctypes import Bus, BusError, introspection │ │ │ │ │ - │ │ │ │ │ -from ..channel import Channel, ChannelError │ │ │ │ │ - │ │ │ │ │ -logger = logging.getLogger(__name__) │ │ │ │ │ - │ │ │ │ │ -# The dbusjson3 payload │ │ │ │ │ -# │ │ │ │ │ -# This channel payload type translates JSON encoded messages on a │ │ │ │ │ -# Cockpit channel to D-Bus messages, in a mostly straightforward way. │ │ │ │ │ -# See doc/protocol.md for a description of the basics. │ │ │ │ │ -# │ │ │ │ │ -# However, dbusjson3 offers some advanced features as well that are │ │ │ │ │ -# meant to support the "magic" DBusProxy objects implemented by │ │ │ │ │ -# cockpit.js. Those proxy objects "magically" expose all the methods │ │ │ │ │ -# and properties of a D-Bus interface without requiring any explicit │ │ │ │ │ -# binding code to be generated for a JavaScript client. A dbusjson3 │ │ │ │ │ -# channel does this by doing automatic introspection and property │ │ │ │ │ -# retrieval without much direction from the JavaScript client. │ │ │ │ │ -# │ │ │ │ │ -# The details of what exactly is done is not specified very strictly, │ │ │ │ │ -# and the Python bridge will likely differ from the C bridge │ │ │ │ │ -# significantly. This will be informed by what existing code actually │ │ │ │ │ -# needs, and we might end up with a more concrete description of what │ │ │ │ │ -# a client can actually expect. │ │ │ │ │ -# │ │ │ │ │ -# Here is an example of a more complex scenario: │ │ │ │ │ -# │ │ │ │ │ -# - The client adds a "watch" for a path namespace. There is a │ │ │ │ │ -# ObjectManager at the given path and the bridge emits "meta" and │ │ │ │ │ -# "notify" messages to describe all interfaces and objects reported │ │ │ │ │ -# by that ObjectManager. │ │ │ │ │ -# │ │ │ │ │ -# - The client makes a method call that causes a new object with a new │ │ │ │ │ -# interface to appear at the ObjectManager. The bridge will send a │ │ │ │ │ -# "meta" and "notify" message to describe this new object. │ │ │ │ │ -# │ │ │ │ │ -# - Since the InterfacesAdded signal was emitted before the method │ │ │ │ │ -# reply, the bridge must send the "meta" and "notify" messages │ │ │ │ │ -# before the method reply message. │ │ │ │ │ -# │ │ │ │ │ -# - However, in order to construct the "meta" message, the bridge must │ │ │ │ │ -# perform a Introspect call, and consequently must delay sending the │ │ │ │ │ -# method reply until that call has finished. │ │ │ │ │ -# │ │ │ │ │ -# The Python bridge implements this delaying of messages with │ │ │ │ │ -# coroutines and a fair mutex. Every message coming from D-Bus will │ │ │ │ │ -# wait on the mutex for its turn to send its message on the Cockpit │ │ │ │ │ -# channel, and will keep that mutex locked until it is done with │ │ │ │ │ -# sending. Since the mutex is fair, everyone will nicely wait in line │ │ │ │ │ -# without messages getting re-ordered. │ │ │ │ │ -# │ │ │ │ │ -# The scenario above will play out like this: │ │ │ │ │ -# │ │ │ │ │ -# - While adding the initial "watch", the lock is held until the │ │ │ │ │ -# "meta" and "notify" messages have been sent. │ │ │ │ │ -# │ │ │ │ │ -# - Later, when the InterfacesAdded signal comes in that has been │ │ │ │ │ -# triggered by the method call, the mutex will be locked while the │ │ │ │ │ -# necessary introspection is going on. │ │ │ │ │ -# │ │ │ │ │ -# - The method reply will likely come while the mutex is locked, and │ │ │ │ │ -# the task for sending that reply on the Cockpit channel will enter │ │ │ │ │ -# the wait queue of the mutex. │ │ │ │ │ -# │ │ │ │ │ -# - Once the introspection is done and the new "meta" and "notify" │ │ │ │ │ -# messages have been sent, the mutex is unlocked, the method reply │ │ │ │ │ -# task acquires it, and sends its message. │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -class InterfaceCache: │ │ │ │ │ - def __init__(self): │ │ │ │ │ - self.cache = {} │ │ │ │ │ - self.old = set() # Interfaces already returned by get_interface_if_new │ │ │ │ │ - │ │ │ │ │ - def inject(self, interfaces): │ │ │ │ │ - self.cache.update(interfaces) │ │ │ │ │ - │ │ │ │ │ - async def introspect_path(self, bus, destination, object_path): │ │ │ │ │ - xml, = await bus.call_method_async(destination, object_path, │ │ │ │ │ - 'org.freedesktop.DBus.Introspectable', │ │ │ │ │ - 'Introspect') │ │ │ │ │ - │ │ │ │ │ - et = ET.fromstring(xml) │ │ │ │ │ - │ │ │ │ │ - interfaces = {tag.attrib['name']: introspection.parse_interface(tag) for tag in et.findall('interface')} │ │ │ │ │ - │ │ │ │ │ - # Add all interfaces we found: we might use them later │ │ │ │ │ - self.inject(interfaces) │ │ │ │ │ - │ │ │ │ │ - return interfaces │ │ │ │ │ - │ │ │ │ │ - async def get_interface(self, interface_name, bus=None, destination=None, object_path=None): │ │ │ │ │ - try: │ │ │ │ │ - return self.cache[interface_name] │ │ │ │ │ - except KeyError: │ │ │ │ │ - pass │ │ │ │ │ - │ │ │ │ │ - if bus and object_path: │ │ │ │ │ - try: │ │ │ │ │ - await self.introspect_path(bus, destination, object_path) │ │ │ │ │ - except BusError: │ │ │ │ │ - pass │ │ │ │ │ - │ │ │ │ │ - return self.cache.get(interface_name) │ │ │ │ │ +# along with this program. If not, see . │ │ │ │ │ │ │ │ │ │ - async def get_interface_if_new(self, interface_name, bus, destination, object_path): │ │ │ │ │ - if interface_name in self.old: │ │ │ │ │ - return None │ │ │ │ │ - self.old.add(interface_name) │ │ │ │ │ - return await self.get_interface(interface_name, bus, destination, object_path) │ │ │ │ │ +import argparse │ │ │ │ │ +import binascii │ │ │ │ │ +import lzma │ │ │ │ │ +import os │ │ │ │ │ +import sys │ │ │ │ │ +import tempfile │ │ │ │ │ +import zipfile │ │ │ │ │ +from typing import Dict, Iterable, List, Optional, Set, Tuple │ │ │ │ │ │ │ │ │ │ - async def get_signature(self, interface_name, method, bus=None, destination=None, object_path=None): │ │ │ │ │ - interface = await self.get_interface(interface_name, bus, destination, object_path) │ │ │ │ │ - if interface is None: │ │ │ │ │ - raise KeyError(f'Interface {interface_name} is not found') │ │ │ │ │ +from .data import read_data_file │ │ │ │ │ │ │ │ │ │ - return ''.join(interface['methods'][method]['in']) │ │ │ │ │ │ │ │ │ │ +def escape_string(data: str) -> str: │ │ │ │ │ + # Avoid mentioning ' ' ' literally, to make our own packing a bit prettier │ │ │ │ │ + triplequote = "'" * 3 │ │ │ │ │ + if triplequote not in data: │ │ │ │ │ + return "r" + triplequote + data + triplequote │ │ │ │ │ + if '"""' not in data: │ │ │ │ │ + return 'r"""' + data + '"""' │ │ │ │ │ + return repr(data) │ │ │ │ │ │ │ │ │ │ -def notify_update(notify, path, interface_name, props): │ │ │ │ │ - notify.setdefault(path, {})[interface_name] = {k: v.value for k, v in props.items()} │ │ │ │ │ │ │ │ │ │ +def ascii_bytes_repr(data: bytes) -> str: │ │ │ │ │ + return 'b' + escape_string(data.decode('ascii')) │ │ │ │ │ │ │ │ │ │ -class DBusChannel(Channel): │ │ │ │ │ - json_encoder = systemd_ctypes.JSONEncoder(indent=2) │ │ │ │ │ - payload = 'dbus-json3' │ │ │ │ │ │ │ │ │ │ - matches = None │ │ │ │ │ - name = None │ │ │ │ │ - bus = None │ │ │ │ │ - owner = None │ │ │ │ │ +def utf8_bytes_repr(data: bytes) -> str: │ │ │ │ │ + return escape_string(data.decode('utf-8')) + ".encode('utf-8')" │ │ │ │ │ │ │ │ │ │ - async def setup_name_owner_tracking(self): │ │ │ │ │ - def send_owner(owner): │ │ │ │ │ - # We must be careful not to send duplicate owner │ │ │ │ │ - # notifications. cockpit.js relies on that. │ │ │ │ │ - if self.owner != owner: │ │ │ │ │ - self.owner = owner │ │ │ │ │ - self.send_json(owner=owner) │ │ │ │ │ │ │ │ │ │ - def handler(message): │ │ │ │ │ - _name, _old, new = message.get_body() │ │ │ │ │ - send_owner(owner=new if new != "" else None) │ │ │ │ │ - self.add_signal_handler(handler, │ │ │ │ │ - sender='org.freedesktop.DBus', │ │ │ │ │ - path='/org/freedesktop/DBus', │ │ │ │ │ - interface='org.freedesktop.DBus', │ │ │ │ │ - member='NameOwnerChanged', │ │ │ │ │ - arg0=self.name) │ │ │ │ │ - try: │ │ │ │ │ - unique_name, = await self.bus.call_method_async("org.freedesktop.DBus", │ │ │ │ │ - "/org/freedesktop/DBus", │ │ │ │ │ - "org.freedesktop.DBus", │ │ │ │ │ - "GetNameOwner", "s", self.name) │ │ │ │ │ - except BusError as error: │ │ │ │ │ - if error.name == "org.freedesktop.DBus.Error.NameHasNoOwner": │ │ │ │ │ - # Try to start it. If it starts successfully, we will │ │ │ │ │ - # get a NameOwnerChanged signal (which will set │ │ │ │ │ - # self.owner) before StartServiceByName returns. │ │ │ │ │ - try: │ │ │ │ │ - await self.bus.call_method_async("org.freedesktop.DBus", │ │ │ │ │ - "/org/freedesktop/DBus", │ │ │ │ │ - "org.freedesktop.DBus", │ │ │ │ │ - "StartServiceByName", "su", self.name, 0) │ │ │ │ │ - except BusError as start_error: │ │ │ │ │ - logger.debug("Failed to start service '%s': %s", self.name, start_error.message) │ │ │ │ │ - self.send_json(owner=None) │ │ │ │ │ - else: │ │ │ │ │ - logger.debug("Failed to get owner of service '%s': %s", self.name, error.message) │ │ │ │ │ - else: │ │ │ │ │ - send_owner(unique_name) │ │ │ │ │ +def base64_bytes_repr(data: bytes, imports: Set[str]) -> str: │ │ │ │ │ + # base85 is smaller, but base64 is in C, and ~20x faster. │ │ │ │ │ + # when compressing with `xz -e` the size difference is marginal. │ │ │ │ │ + imports.add('from binascii import a2b_base64') │ │ │ │ │ + encoded = binascii.b2a_base64(data).decode('ascii').strip() │ │ │ │ │ + return f'a2b_base64("{encoded}")' │ │ │ │ │ │ │ │ │ │ - def do_open(self, options): │ │ │ │ │ - self.cache = InterfaceCache() │ │ │ │ │ - self.name = options.get('name') │ │ │ │ │ - self.matches = [] │ │ │ │ │ │ │ │ │ │ - bus = options.get('bus') │ │ │ │ │ - address = options.get('address') │ │ │ │ │ +def bytes_repr(data: bytes, imports: Set[str]) -> str: │ │ │ │ │ + # Strategy: │ │ │ │ │ + # if the file is ascii, encode it directly as bytes │ │ │ │ │ + # otherwise, if it's UTF-8, use a unicode string and encode │ │ │ │ │ + # otherwise, base64 │ │ │ │ │ │ │ │ │ │ - try: │ │ │ │ │ - if address is not None: │ │ │ │ │ - if bus is not None and bus != 'none': │ │ │ │ │ - raise ChannelError('protocol-error', message='only one of "bus" and "address" can be specified') │ │ │ │ │ - logger.debug('get bus with address %s for %s', address, self.name) │ │ │ │ │ - self.bus = Bus.new(address=address, bus_client=self.name is not None) │ │ │ │ │ - elif bus == 'internal': │ │ │ │ │ - logger.debug('get internal bus for %s', self.name) │ │ │ │ │ - self.bus = self.router.internal_bus.client │ │ │ │ │ - else: │ │ │ │ │ - if bus == 'session': │ │ │ │ │ - logger.debug('get session bus for %s', self.name) │ │ │ │ │ - self.bus = Bus.default_user() │ │ │ │ │ - elif bus == 'system' or bus is None: │ │ │ │ │ - logger.debug('get system bus for %s', self.name) │ │ │ │ │ - self.bus = Bus.default_system() │ │ │ │ │ - else: │ │ │ │ │ - raise ChannelError('protocol-error', message=f'invalid bus "{bus}"') │ │ │ │ │ - except OSError as exc: │ │ │ │ │ - raise ChannelError('protocol-error', message=f'failed to connect to {bus} bus: {exc}') from exc │ │ │ │ │ + try: │ │ │ │ │ + return ascii_bytes_repr(data) │ │ │ │ │ + except UnicodeDecodeError: │ │ │ │ │ + # it's not ascii │ │ │ │ │ + pass │ │ │ │ │ │ │ │ │ │ - try: │ │ │ │ │ - self.bus.attach_event(None, 0) │ │ │ │ │ - except OSError as err: │ │ │ │ │ - if err.errno != errno.EBUSY: │ │ │ │ │ - raise │ │ │ │ │ + # utf-8 │ │ │ │ │ + try: │ │ │ │ │ + return utf8_bytes_repr(data) │ │ │ │ │ + except UnicodeDecodeError: │ │ │ │ │ + # it's not utf-8 │ │ │ │ │ + pass │ │ │ │ │ │ │ │ │ │ - # This needs to be a fair mutex so that outgoing messages don't │ │ │ │ │ - # get re-ordered. asyncio.Lock is fair. │ │ │ │ │ - self.watch_processing_lock = asyncio.Lock() │ │ │ │ │ + return base64_bytes_repr(data, imports) │ │ │ │ │ │ │ │ │ │ - if self.name is not None: │ │ │ │ │ - async def get_ready(): │ │ │ │ │ - async with self.watch_processing_lock: │ │ │ │ │ - await self.setup_name_owner_tracking() │ │ │ │ │ - if self.owner: │ │ │ │ │ - self.ready(unique_name=self.owner) │ │ │ │ │ - else: │ │ │ │ │ - self.close({'problem': 'not-found'}) │ │ │ │ │ - self.create_task(get_ready()) │ │ │ │ │ - else: │ │ │ │ │ - self.ready() │ │ │ │ │ │ │ │ │ │ - def add_signal_handler(self, handler, **kwargs): │ │ │ │ │ - r = dict(**kwargs) │ │ │ │ │ - r['type'] = 'signal' │ │ │ │ │ - if 'sender' not in r and self.name is not None: │ │ │ │ │ - r['sender'] = self.name │ │ │ │ │ - # HACK - https://github.com/bus1/dbus-broker/issues/309 │ │ │ │ │ - # path_namespace='/' in a rule does not work. │ │ │ │ │ - if r.get('path_namespace') == "/": │ │ │ │ │ - del r['path_namespace'] │ │ │ │ │ +def dict_repr(contents: Dict[str, bytes], imports: Set[str]) -> str: │ │ │ │ │ + return ('{\n' + │ │ │ │ │ + ''.join(f' {repr(k)}: {bytes_repr(v, imports)},\n' │ │ │ │ │ + for k, v in contents.items()) + │ │ │ │ │ + '}') │ │ │ │ │ │ │ │ │ │ - def filter_owner(message): │ │ │ │ │ - if self.owner is not None and self.owner == message.get_sender(): │ │ │ │ │ - handler(message) │ │ │ │ │ │ │ │ │ │ - if self.name is not None and 'sender' in r and r['sender'] == self.name: │ │ │ │ │ - func = filter_owner │ │ │ │ │ - else: │ │ │ │ │ - func = handler │ │ │ │ │ - r_string = ','.join(f"{key}='{value}'" for key, value in r.items()) │ │ │ │ │ - if not self.is_closing(): │ │ │ │ │ - # this gets an EINTR very often especially on RHEL 8 │ │ │ │ │ - while True: │ │ │ │ │ - try: │ │ │ │ │ - match = self.bus.add_match(r_string, func) │ │ │ │ │ - break │ │ │ │ │ - except InterruptedError: │ │ │ │ │ - pass │ │ │ │ │ +def pack(contents: Dict[str, bytes], │ │ │ │ │ + entrypoint: Optional[str] = None, │ │ │ │ │ + args: str = '') -> str: │ │ │ │ │ + """Creates a beipack with the given `contents`. │ │ │ │ │ │ │ │ │ │ - self.matches.append(match) │ │ │ │ │ + If `entrypoint` is given, it should be an entry point which is run as the │ │ │ │ │ + "main" function. It is given in the `package.module:func format` such that │ │ │ │ │ + the following code is emitted: │ │ │ │ │ │ │ │ │ │ - def add_async_signal_handler(self, handler, **kwargs): │ │ │ │ │ - def sync_handler(message): │ │ │ │ │ - self.create_task(handler(message)) │ │ │ │ │ - self.add_signal_handler(sync_handler, **kwargs) │ │ │ │ │ + from package.module import func as main │ │ │ │ │ + main() │ │ │ │ │ │ │ │ │ │ - async def do_call(self, message): │ │ │ │ │ - path, iface, method, args = message['call'] │ │ │ │ │ - cookie = message.get('id') │ │ │ │ │ - flags = message.get('flags') │ │ │ │ │ + Additionally, if `args` is given, it is written verbatim between the parens │ │ │ │ │ + of the call to main (ie: it should already be in Python syntax). │ │ │ │ │ + """ │ │ │ │ │ │ │ │ │ │ - timeout = message.get('timeout') │ │ │ │ │ - if timeout is not None: │ │ │ │ │ - # sd_bus timeout is μs, cockpit API timeout is ms │ │ │ │ │ - timeout *= 1000 │ │ │ │ │ - else: │ │ │ │ │ - # sd_bus has no "indefinite" timeout, so use MAX_UINT64 │ │ │ │ │ - timeout = 2 ** 64 - 1 │ │ │ │ │ + loader = read_data_file('beipack_loader.py') │ │ │ │ │ + lines = [line for line in loader.splitlines() if line] │ │ │ │ │ + lines.append('') │ │ │ │ │ │ │ │ │ │ - # We have to figure out the signature of the call. Either we got told it: │ │ │ │ │ - signature = message.get('type') │ │ │ │ │ + imports = {'import sys'} │ │ │ │ │ + contents_txt = dict_repr(contents, imports) │ │ │ │ │ + lines.extend(imports) │ │ │ │ │ + lines.append(f'sys.meta_path.insert(0, BeipackLoader({contents_txt}))') │ │ │ │ │ │ │ │ │ │ - # ... or there aren't any arguments │ │ │ │ │ - if signature is None and len(args) == 0: │ │ │ │ │ - signature = '' │ │ │ │ │ + if entrypoint: │ │ │ │ │ + package, main = entrypoint.split(':') │ │ │ │ │ + lines.append(f'from {package} import {main} as main') │ │ │ │ │ + lines.append(f'main({args})') │ │ │ │ │ │ │ │ │ │ - # ... or we need to introspect │ │ │ │ │ - if signature is None: │ │ │ │ │ - try: │ │ │ │ │ - logger.debug('Doing introspection request for %s %s', iface, method) │ │ │ │ │ - signature = await self.cache.get_signature(iface, method, self.bus, self.name, path) │ │ │ │ │ - except BusError as error: │ │ │ │ │ - self.send_json(error=[error.name, [f'Introspection: {error.message}']], id=cookie) │ │ │ │ │ - return │ │ │ │ │ - except KeyError: │ │ │ │ │ - self.send_json( │ │ │ │ │ - error=[ │ │ │ │ │ - "org.freedesktop.DBus.Error.UnknownMethod", │ │ │ │ │ - [f"Introspection data for method {iface} {method} not available"]], │ │ │ │ │ - id=cookie) │ │ │ │ │ - return │ │ │ │ │ - except Exception as exc: │ │ │ │ │ - self.send_json(error=['python.error', [f'Introspection: {exc!s}']], id=cookie) │ │ │ │ │ - return │ │ │ │ │ + return ''.join(f'{line}\n' for line in lines) │ │ │ │ │ │ │ │ │ │ - try: │ │ │ │ │ - method_call = self.bus.message_new_method_call(self.name, path, iface, method, signature, *args) │ │ │ │ │ - reply = await self.bus.call_async(method_call, timeout=timeout) │ │ │ │ │ - # If the method call has kicked off any signals related to │ │ │ │ │ - # watch processing, wait for that to be done. │ │ │ │ │ - async with self.watch_processing_lock: │ │ │ │ │ - # TODO: stop hard-coding the endian flag here. │ │ │ │ │ - self.send_json( │ │ │ │ │ - reply=[reply.get_body()], id=cookie, │ │ │ │ │ - flags="<" if flags is not None else None, │ │ │ │ │ - type=reply.get_signature(True)) # noqa: FBT003 │ │ │ │ │ - except BusError as error: │ │ │ │ │ - # actually, should send the fields from the message body │ │ │ │ │ - self.send_json(error=[error.name, [error.message]], id=cookie) │ │ │ │ │ - except Exception: │ │ │ │ │ - logger.exception("do_call(%s): generic exception", message) │ │ │ │ │ - self.send_json(error=['python.error', [traceback.format_exc()]], id=cookie) │ │ │ │ │ │ │ │ │ │ - async def do_add_match(self, message): │ │ │ │ │ - add_match = message['add-match'] │ │ │ │ │ - logger.debug('adding match %s', add_match) │ │ │ │ │ +def collect_contents(filenames: List[str], │ │ │ │ │ + relative_to: Optional[str] = None) -> Dict[str, bytes]: │ │ │ │ │ + contents: Dict[str, bytes] = {} │ │ │ │ │ │ │ │ │ │ - async def match_hit(message): │ │ │ │ │ - logger.debug('got match') │ │ │ │ │ - async with self.watch_processing_lock: │ │ │ │ │ - self.send_json(signal=[ │ │ │ │ │ - message.get_path(), │ │ │ │ │ - message.get_interface(), │ │ │ │ │ - message.get_member(), │ │ │ │ │ - list(message.get_body()) │ │ │ │ │ - ]) │ │ │ │ │ + for filename in filenames: │ │ │ │ │ + with open(filename, 'rb') as file: │ │ │ │ │ + contents[os.path.relpath(filename, start=relative_to)] = file.read() │ │ │ │ │ │ │ │ │ │ - self.add_async_signal_handler(match_hit, **add_match) │ │ │ │ │ + return contents │ │ │ │ │ │ │ │ │ │ - async def setup_objectmanager_watch(self, path, interface_name, meta, notify): │ │ │ │ │ - # Watch the objects managed by the ObjectManager at "path". │ │ │ │ │ - # Properties are not watched, that is done by setup_path_watch │ │ │ │ │ - # below via recursive_props == True. │ │ │ │ │ │ │ │ │ │ - async def handler(message): │ │ │ │ │ - member = message.get_member() │ │ │ │ │ - if member == "InterfacesAdded": │ │ │ │ │ - (path, interface_props) = message.get_body() │ │ │ │ │ - logger.debug('interfaces added %s %s', path, interface_props) │ │ │ │ │ - meta = {} │ │ │ │ │ - notify = {} │ │ │ │ │ - async with self.watch_processing_lock: │ │ │ │ │ - for name, props in interface_props.items(): │ │ │ │ │ - if interface_name is None or name == interface_name: │ │ │ │ │ - mm = await self.cache.get_interface_if_new(name, self.bus, self.name, path) │ │ │ │ │ - if mm: │ │ │ │ │ - meta.update({name: mm}) │ │ │ │ │ - notify_update(notify, path, name, props) │ │ │ │ │ - self.send_json(meta=meta) │ │ │ │ │ - self.send_json(notify=notify) │ │ │ │ │ - elif member == "InterfacesRemoved": │ │ │ │ │ - (path, interfaces) = message.get_body() │ │ │ │ │ - logger.debug('interfaces removed %s %s', path, interfaces) │ │ │ │ │ - async with self.watch_processing_lock: │ │ │ │ │ - notify = {path: dict.fromkeys(interfaces)} │ │ │ │ │ - self.send_json(notify=notify) │ │ │ │ │ +def collect_module(name: str, *, recursive: bool) -> Dict[str, bytes]: │ │ │ │ │ + import importlib.resources │ │ │ │ │ + from importlib.resources.abc import Traversable │ │ │ │ │ │ │ │ │ │ - self.add_async_signal_handler(handler, │ │ │ │ │ - path=path, │ │ │ │ │ - interface="org.freedesktop.DBus.ObjectManager") │ │ │ │ │ - objects, = await self.bus.call_method_async(self.name, path, │ │ │ │ │ - 'org.freedesktop.DBus.ObjectManager', │ │ │ │ │ - 'GetManagedObjects') │ │ │ │ │ - for p, ifaces in objects.items(): │ │ │ │ │ - for iface, props in ifaces.items(): │ │ │ │ │ - if interface_name is None or iface == interface_name: │ │ │ │ │ - mm = await self.cache.get_interface_if_new(iface, self.bus, self.name, p) │ │ │ │ │ - if mm: │ │ │ │ │ - meta.update({iface: mm}) │ │ │ │ │ - notify_update(notify, p, iface, props) │ │ │ │ │ + def walk(path: str, entry: Traversable) -> Iterable[Tuple[str, bytes]]: │ │ │ │ │ + for item in entry.iterdir(): │ │ │ │ │ + itemname = f'{path}/{item.name}' │ │ │ │ │ + if item.is_file(): │ │ │ │ │ + yield itemname, item.read_bytes() │ │ │ │ │ + elif recursive and item.name != '__pycache__': │ │ │ │ │ + yield from walk(itemname, item) │ │ │ │ │ │ │ │ │ │ - async def setup_path_watch(self, path, interface_name, recursive_props, meta, notify): │ │ │ │ │ - # Watch a single object at "path", but maybe also watch for │ │ │ │ │ - # property changes for all objects below "path". │ │ │ │ │ + return dict(walk(name.replace('.', '/'), importlib.resources.files(name))) │ │ │ │ │ │ │ │ │ │ - async def handler(message): │ │ │ │ │ - async with self.watch_processing_lock: │ │ │ │ │ - path = message.get_path() │ │ │ │ │ - name, props, invalids = message.get_body() │ │ │ │ │ - logger.debug('NOTIFY: %s %s %s %s', path, name, props, invalids) │ │ │ │ │ - for inv in invalids: │ │ │ │ │ - try: │ │ │ │ │ - reply, = await self.bus.call_method_async(self.name, path, │ │ │ │ │ - 'org.freedesktop.DBus.Properties', 'Get', │ │ │ │ │ - 'ss', name, inv) │ │ │ │ │ - except BusError as exc: │ │ │ │ │ - logger.debug('failed to fetch property %s.%s on %s %s: %s', │ │ │ │ │ - name, inv, self.name, path, str(exc)) │ │ │ │ │ - continue │ │ │ │ │ - props[inv] = reply │ │ │ │ │ - notify = {} │ │ │ │ │ - notify_update(notify, path, name, props) │ │ │ │ │ - self.send_json(notify=notify) │ │ │ │ │ │ │ │ │ │ - this_meta = await self.cache.introspect_path(self.bus, self.name, path) │ │ │ │ │ - if interface_name is not None: │ │ │ │ │ - interface = this_meta.get(interface_name) │ │ │ │ │ - this_meta = {interface_name: interface} │ │ │ │ │ - meta.update(this_meta) │ │ │ │ │ - if recursive_props: │ │ │ │ │ - self.add_async_signal_handler(handler, │ │ │ │ │ - interface="org.freedesktop.DBus.Properties", │ │ │ │ │ - path_namespace=path) │ │ │ │ │ - else: │ │ │ │ │ - self.add_async_signal_handler(handler, │ │ │ │ │ - interface="org.freedesktop.DBus.Properties", │ │ │ │ │ - path=path) │ │ │ │ │ +def collect_zip(filename: str) -> Dict[str, bytes]: │ │ │ │ │ + contents = {} │ │ │ │ │ │ │ │ │ │ - for name in meta: │ │ │ │ │ - if name.startswith("org.freedesktop.DBus."): │ │ │ │ │ + with zipfile.ZipFile(filename) as file: │ │ │ │ │ + for entry in file.filelist: │ │ │ │ │ + if '.dist-info/' in entry.filename: │ │ │ │ │ continue │ │ │ │ │ - try: │ │ │ │ │ - props, = await self.bus.call_method_async(self.name, path, │ │ │ │ │ - 'org.freedesktop.DBus.Properties', │ │ │ │ │ - 'GetAll', 's', name) │ │ │ │ │ - notify_update(notify, path, name, props) │ │ │ │ │ - except BusError: │ │ │ │ │ - pass │ │ │ │ │ - │ │ │ │ │ - async def do_watch(self, message): │ │ │ │ │ - watch = message['watch'] │ │ │ │ │ - path = watch.get('path') │ │ │ │ │ - path_namespace = watch.get('path_namespace') │ │ │ │ │ - interface_name = watch.get('interface') │ │ │ │ │ - cookie = message.get('id') │ │ │ │ │ - │ │ │ │ │ - path = path or path_namespace │ │ │ │ │ - recursive = path == path_namespace │ │ │ │ │ - │ │ │ │ │ - if path is None or cookie is None: │ │ │ │ │ - logger.debug('ignored incomplete watch request %s', message) │ │ │ │ │ - self.send_json(error=['x.y.z', ['Not Implemented']], id=cookie) │ │ │ │ │ - self.send_json(reply=[], id=cookie) │ │ │ │ │ - return │ │ │ │ │ - │ │ │ │ │ - try: │ │ │ │ │ - async with self.watch_processing_lock: │ │ │ │ │ - meta = {} │ │ │ │ │ - notify = {} │ │ │ │ │ - await self.setup_path_watch(path, interface_name, recursive, meta, notify) │ │ │ │ │ - if recursive: │ │ │ │ │ - await self.setup_objectmanager_watch(path, interface_name, meta, notify) │ │ │ │ │ - self.send_json(meta=meta) │ │ │ │ │ - self.send_json(notify=notify) │ │ │ │ │ - self.send_json(reply=[], id=message['id']) │ │ │ │ │ - except BusError as error: │ │ │ │ │ - logger.debug("do_watch(%s) caught D-Bus error: %s", message, error.message) │ │ │ │ │ - self.send_json(error=[error.name, [error.message]], id=cookie) │ │ │ │ │ + contents[entry.filename] = file.read(entry) │ │ │ │ │ │ │ │ │ │ - async def do_meta(self, message): │ │ │ │ │ - self.cache.inject(message['meta']) │ │ │ │ │ + return contents │ │ │ │ │ │ │ │ │ │ - def do_data(self, data): │ │ │ │ │ - message = json.loads(data) │ │ │ │ │ - logger.debug('receive dbus request %s %s', self.name, message) │ │ │ │ │ │ │ │ │ │ - if 'call' in message: │ │ │ │ │ - self.create_task(self.do_call(message)) │ │ │ │ │ - elif 'add-match' in message: │ │ │ │ │ - self.create_task(self.do_add_match(message)) │ │ │ │ │ - elif 'watch' in message: │ │ │ │ │ - self.create_task(self.do_watch(message)) │ │ │ │ │ - elif 'meta' in message: │ │ │ │ │ - self.create_task(self.do_meta(message)) │ │ │ │ │ - else: │ │ │ │ │ - logger.debug('ignored dbus request %s', message) │ │ │ │ │ - return │ │ │ │ │ +def collect_pep517(path: str) -> Dict[str, bytes]: │ │ │ │ │ + with tempfile.TemporaryDirectory() as tmpdir: │ │ │ │ │ + import build │ │ │ │ │ + builder = build.ProjectBuilder(path) │ │ │ │ │ + wheel = builder.build('wheel', tmpdir) │ │ │ │ │ + return collect_zip(wheel) │ │ │ │ │ │ │ │ │ │ - def do_close(self): │ │ │ │ │ - for slot in self.matches: │ │ │ │ │ - slot.cancel() │ │ │ │ │ - self.matches = [] │ │ │ │ │ - self.close() │ │ │ │ │ -'''.encode('utf-8'), │ │ │ │ │ - 'cockpit/channels/trivial.py': br'''# This file is part of Cockpit. │ │ │ │ │ -# │ │ │ │ │ -# Copyright (C) 2022 Red Hat, Inc. │ │ │ │ │ -# │ │ │ │ │ -# This program is free software: you can redistribute it and/or modify │ │ │ │ │ -# it under the terms of the GNU General Public License as published by │ │ │ │ │ -# the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ -# (at your option) any later version. │ │ │ │ │ -# │ │ │ │ │ -# This program is distributed in the hope that it will be useful, │ │ │ │ │ -# but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ -# GNU General Public License for more details. │ │ │ │ │ -# │ │ │ │ │ -# You should have received a copy of the GNU General Public License │ │ │ │ │ -# along with this program. If not, see . │ │ │ │ │ │ │ │ │ │ -import logging │ │ │ │ │ +def main() -> None: │ │ │ │ │ + parser = argparse.ArgumentParser() │ │ │ │ │ + parser.add_argument('--python', '-p', │ │ │ │ │ + help="add a #!python3 interpreter line using the given path") │ │ │ │ │ + parser.add_argument('--xz', '-J', action='store_true', │ │ │ │ │ + help="compress the output with `xz`") │ │ │ │ │ + parser.add_argument('--topdir', │ │ │ │ │ + help="toplevel directory (paths are stored relative to this)") │ │ │ │ │ + parser.add_argument('--output', '-o', │ │ │ │ │ + help="write output to a file (default: stdout)") │ │ │ │ │ + parser.add_argument('--main', '-m', metavar='MODULE:FUNC', │ │ │ │ │ + help="use FUNC from MODULE as the main function") │ │ │ │ │ + parser.add_argument('--main-args', metavar='ARGS', │ │ │ │ │ + help="arguments to main() in Python syntax", default='') │ │ │ │ │ + parser.add_argument('--module', action='append', default=[], │ │ │ │ │ + help="collect installed modules (recursively)") │ │ │ │ │ + parser.add_argument('--zip', '-z', action='append', default=[], │ │ │ │ │ + help="include files from a zipfile (or wheel)") │ │ │ │ │ + parser.add_argument('--build', metavar='DIR', action='append', default=[], │ │ │ │ │ + help="PEP-517 from a given source directory") │ │ │ │ │ + parser.add_argument('files', nargs='*', │ │ │ │ │ + help="files to include in the beipack") │ │ │ │ │ + args = parser.parse_args() │ │ │ │ │ │ │ │ │ │ -from ..channel import Channel │ │ │ │ │ + contents = collect_contents(args.files, relative_to=args.topdir) │ │ │ │ │ │ │ │ │ │ -logger = logging.getLogger(__name__) │ │ │ │ │ + for file in args.zip: │ │ │ │ │ + contents.update(collect_zip(file)) │ │ │ │ │ │ │ │ │ │ + for name in args.module: │ │ │ │ │ + contents.update(collect_module(name, recursive=True)) │ │ │ │ │ │ │ │ │ │ -class EchoChannel(Channel): │ │ │ │ │ - payload = 'echo' │ │ │ │ │ + for path in args.build: │ │ │ │ │ + contents.update(collect_pep517(path)) │ │ │ │ │ │ │ │ │ │ - def do_open(self, options): │ │ │ │ │ - self.ready() │ │ │ │ │ + result = pack(contents, args.main, args.main_args).encode('utf-8') │ │ │ │ │ │ │ │ │ │ - def do_data(self, data): │ │ │ │ │ - self.send_data(data) │ │ │ │ │ + if args.python: │ │ │ │ │ + result = b'#!' + args.python.encode('ascii') + b'\n' + result │ │ │ │ │ │ │ │ │ │ - def do_done(self): │ │ │ │ │ - self.done() │ │ │ │ │ - self.close() │ │ │ │ │ + if args.xz: │ │ │ │ │ + result = lzma.compress(result, preset=lzma.PRESET_EXTREME) │ │ │ │ │ │ │ │ │ │ + if args.output: │ │ │ │ │ + with open(args.output, 'wb') as file: │ │ │ │ │ + file.write(result) │ │ │ │ │ + else: │ │ │ │ │ + if args.xz and os.isatty(1): │ │ │ │ │ + sys.exit('refusing to write compressed output to a terminal') │ │ │ │ │ + sys.stdout.buffer.write(result) │ │ │ │ │ │ │ │ │ │ -class NullChannel(Channel): │ │ │ │ │ - payload = 'null' │ │ │ │ │ │ │ │ │ │ - def do_open(self, options): │ │ │ │ │ - self.ready() │ │ │ │ │ - │ │ │ │ │ - def do_close(self): │ │ │ │ │ - self.close() │ │ │ │ │ +if __name__ == '__main__': │ │ │ │ │ + main() │ │ │ │ │ ''', │ │ │ │ │ - 'cockpit/channels/stream.py': br'''# This file is part of Cockpit. │ │ │ │ │ + 'cockpit/_vendor/bei/beiboot.py': br"""# beiboot - Remote bootloader for Python │ │ │ │ │ # │ │ │ │ │ -# Copyright (C) 2022 Red Hat, Inc. │ │ │ │ │ +# Copyright (C) 2022 Allison Karlitskaya │ │ │ │ │ # │ │ │ │ │ # This program is free software: you can redistribute it and/or modify │ │ │ │ │ # it under the terms of the GNU General Public License as published by │ │ │ │ │ # the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ # (at your option) any later version. │ │ │ │ │ # │ │ │ │ │ # This program is distributed in the hope that it will be useful, │ │ │ │ │ # but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ # GNU General Public License for more details. │ │ │ │ │ # │ │ │ │ │ # You should have received a copy of the GNU General Public License │ │ │ │ │ -# along with this program. If not, see . │ │ │ │ │ +# along with this program. If not, see . │ │ │ │ │ │ │ │ │ │ +import argparse │ │ │ │ │ import asyncio │ │ │ │ │ -import logging │ │ │ │ │ import os │ │ │ │ │ +import shlex │ │ │ │ │ import subprocess │ │ │ │ │ -from typing import Dict │ │ │ │ │ - │ │ │ │ │ -from ..channel import ChannelError, ProtocolChannel │ │ │ │ │ -from ..jsonutil import JsonDict, JsonObject, get_bool, get_enum, get_int, get_object, get_str, get_strv │ │ │ │ │ -from ..transports import SubprocessProtocol, SubprocessTransport, WindowSize │ │ │ │ │ - │ │ │ │ │ -logger = logging.getLogger(__name__) │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -class SocketStreamChannel(ProtocolChannel): │ │ │ │ │ - payload = 'stream' │ │ │ │ │ - │ │ │ │ │ - async def create_transport(self, loop: asyncio.AbstractEventLoop, options: JsonObject) -> asyncio.Transport: │ │ │ │ │ - if 'unix' in options and 'port' in options: │ │ │ │ │ - raise ChannelError('protocol-error', message='cannot specify both "port" and "unix" options') │ │ │ │ │ - │ │ │ │ │ - try: │ │ │ │ │ - # Unix │ │ │ │ │ - if 'unix' in options: │ │ │ │ │ - path = get_str(options, 'unix') │ │ │ │ │ - label = f'Unix socket {path}' │ │ │ │ │ - transport, _ = await loop.create_unix_connection(lambda: self, path) │ │ │ │ │ - │ │ │ │ │ - # TCP │ │ │ │ │ - elif 'port' in options: │ │ │ │ │ - port = get_int(options, 'port') │ │ │ │ │ - host = get_str(options, 'address', 'localhost') │ │ │ │ │ - label = f'TCP socket {host}:{port}' │ │ │ │ │ - │ │ │ │ │ - transport, _ = await loop.create_connection(lambda: self, host, port) │ │ │ │ │ - else: │ │ │ │ │ - raise ChannelError('protocol-error', │ │ │ │ │ - message='no "port" or "unix" or other address option for channel') │ │ │ │ │ - │ │ │ │ │ - logger.debug('SocketStreamChannel: connected to %s', label) │ │ │ │ │ - except OSError as error: │ │ │ │ │ - logger.info('SocketStreamChannel: connecting to %s failed: %s', label, error) │ │ │ │ │ - if isinstance(error, ConnectionRefusedError): │ │ │ │ │ - problem = 'not-found' │ │ │ │ │ - else: │ │ │ │ │ - problem = 'terminated' │ │ │ │ │ - raise ChannelError(problem, message=str(error)) from error │ │ │ │ │ - self.close_on_eof() │ │ │ │ │ - assert isinstance(transport, asyncio.Transport) │ │ │ │ │ - return transport │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -class SubprocessStreamChannel(ProtocolChannel, SubprocessProtocol): │ │ │ │ │ - payload = 'stream' │ │ │ │ │ - restrictions = (('spawn', None),) │ │ │ │ │ - │ │ │ │ │ - def process_exited(self) -> None: │ │ │ │ │ - self.close_on_eof() │ │ │ │ │ - │ │ │ │ │ - def _get_close_args(self) -> JsonObject: │ │ │ │ │ - assert isinstance(self._transport, SubprocessTransport) │ │ │ │ │ - args: JsonDict = {'exit-status': self._transport.get_returncode()} │ │ │ │ │ - stderr = self._transport.get_stderr() │ │ │ │ │ - if stderr is not None: │ │ │ │ │ - args['message'] = stderr │ │ │ │ │ - return args │ │ │ │ │ - │ │ │ │ │ - def do_options(self, options): │ │ │ │ │ - window = get_object(options, 'window', WindowSize, None) │ │ │ │ │ - if window is not None: │ │ │ │ │ - self._transport.set_window_size(window) │ │ │ │ │ - │ │ │ │ │ - async def create_transport(self, loop: asyncio.AbstractEventLoop, options: JsonObject) -> SubprocessTransport: │ │ │ │ │ - args = get_strv(options, 'spawn') │ │ │ │ │ - err = get_enum(options, 'err', ['out', 'ignore', 'message'], 'message') │ │ │ │ │ - cwd = get_str(options, 'directory', '.') │ │ │ │ │ - pty = get_bool(options, 'pty', default=False) │ │ │ │ │ - window = get_object(options, 'window', WindowSize, None) │ │ │ │ │ - environ = get_strv(options, 'environ', []) │ │ │ │ │ - │ │ │ │ │ - if err == 'out': │ │ │ │ │ - stderr = subprocess.STDOUT │ │ │ │ │ - elif err == 'ignore': │ │ │ │ │ - stderr = subprocess.DEVNULL │ │ │ │ │ - else: │ │ │ │ │ - stderr = subprocess.PIPE │ │ │ │ │ - │ │ │ │ │ - env: Dict[str, str] = dict(os.environ) │ │ │ │ │ - try: │ │ │ │ │ - env.update(dict(e.split('=', 1) for e in environ)) │ │ │ │ │ - except ValueError: │ │ │ │ │ - raise ChannelError('protocol-error', message='invalid "environ" option for stream channel') from None │ │ │ │ │ - │ │ │ │ │ - try: │ │ │ │ │ - transport = SubprocessTransport(loop, self, args, pty=pty, window=window, env=env, cwd=cwd, stderr=stderr) │ │ │ │ │ - logger.debug('Spawned process args=%s pid=%i', args, transport.get_pid()) │ │ │ │ │ - return transport │ │ │ │ │ - except FileNotFoundError as error: │ │ │ │ │ - raise ChannelError('not-found') from error │ │ │ │ │ - except PermissionError as error: │ │ │ │ │ - raise ChannelError('access-denied') from error │ │ │ │ │ - except OSError as error: │ │ │ │ │ - logger.info("Failed to spawn %s: %s", args, str(error)) │ │ │ │ │ - raise ChannelError('internal-error') from error │ │ │ │ │ -''', │ │ │ │ │ - 'cockpit/channels/__init__.py': br'''# This file is part of Cockpit. │ │ │ │ │ -# │ │ │ │ │ -# Copyright (C) 2022 Red Hat, Inc. │ │ │ │ │ -# │ │ │ │ │ -# This program is free software: you can redistribute it and/or modify │ │ │ │ │ -# it under the terms of the GNU General Public License as published by │ │ │ │ │ -# the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ -# (at your option) any later version. │ │ │ │ │ -# │ │ │ │ │ -# This program is distributed in the hope that it will be useful, │ │ │ │ │ -# but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ -# GNU General Public License for more details. │ │ │ │ │ -# │ │ │ │ │ -# You should have received a copy of the GNU General Public License │ │ │ │ │ -# along with this program. If not, see . │ │ │ │ │ - │ │ │ │ │ -from .dbus import DBusChannel │ │ │ │ │ -from .filesystem import FsInfoChannel, FsListChannel, FsReadChannel, FsReplaceChannel, FsWatchChannel │ │ │ │ │ -from .http import HttpChannel │ │ │ │ │ -from .metrics import InternalMetricsChannel │ │ │ │ │ -from .packages import PackagesChannel │ │ │ │ │ -from .stream import SocketStreamChannel, SubprocessStreamChannel │ │ │ │ │ -from .trivial import EchoChannel, NullChannel │ │ │ │ │ - │ │ │ │ │ -CHANNEL_TYPES = [ │ │ │ │ │ - DBusChannel, │ │ │ │ │ - EchoChannel, │ │ │ │ │ - FsInfoChannel, │ │ │ │ │ - FsListChannel, │ │ │ │ │ - FsReadChannel, │ │ │ │ │ - FsReplaceChannel, │ │ │ │ │ - FsWatchChannel, │ │ │ │ │ - HttpChannel, │ │ │ │ │ - InternalMetricsChannel, │ │ │ │ │ - NullChannel, │ │ │ │ │ - PackagesChannel, │ │ │ │ │ - SubprocessStreamChannel, │ │ │ │ │ - SocketStreamChannel, │ │ │ │ │ -] │ │ │ │ │ -''', │ │ │ │ │ - 'cockpit/channels/metrics.py': br'''# This file is part of Cockpit. │ │ │ │ │ -# │ │ │ │ │ -# Copyright (C) 2022 Red Hat, Inc. │ │ │ │ │ -# │ │ │ │ │ -# This program is free software: you can redistribute it and/or modify │ │ │ │ │ -# it under the terms of the GNU General Public License as published by │ │ │ │ │ -# the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ -# (at your option) any later version. │ │ │ │ │ -# │ │ │ │ │ -# This program is distributed in the hope that it will be useful, │ │ │ │ │ -# but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ -# GNU General Public License for more details. │ │ │ │ │ -# │ │ │ │ │ -# You should have received a copy of the GNU General Public License │ │ │ │ │ -# along with this program. If not, see . │ │ │ │ │ - │ │ │ │ │ -import asyncio │ │ │ │ │ -import json │ │ │ │ │ -import logging │ │ │ │ │ import sys │ │ │ │ │ -import time │ │ │ │ │ -from collections import defaultdict │ │ │ │ │ -from typing import Dict, List, NamedTuple, Optional, Set, Tuple, Union │ │ │ │ │ - │ │ │ │ │ -from ..channel import AsyncChannel, ChannelError │ │ │ │ │ -from ..jsonutil import JsonList │ │ │ │ │ -from ..samples import SAMPLERS, SampleDescription, Sampler, Samples │ │ │ │ │ +import threading │ │ │ │ │ +from typing import IO, List, Sequence, Tuple │ │ │ │ │ │ │ │ │ │ -logger = logging.getLogger(__name__) │ │ │ │ │ +from .bootloader import make_bootloader │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ -class MetricInfo(NamedTuple): │ │ │ │ │ - derive: Optional[str] │ │ │ │ │ - desc: SampleDescription │ │ │ │ │ +def get_python_command(local: bool = False, │ │ │ │ │ + tty: bool = False, │ │ │ │ │ + sh: bool = False) -> Sequence[str]: │ │ │ │ │ + interpreter = sys.executable if local else 'python3' │ │ │ │ │ + command: Sequence[str] │ │ │ │ │ │ │ │ │ │ + if tty: │ │ │ │ │ + command = (interpreter, '-iq') │ │ │ │ │ + else: │ │ │ │ │ + command = ( │ │ │ │ │ + interpreter, '-ic', │ │ │ │ │ + # https://github.com/python/cpython/issues/93139 │ │ │ │ │ + '''" - beiboot - "; import sys; sys.ps1 = ''; sys.ps2 = '';''' │ │ │ │ │ + ) │ │ │ │ │ │ │ │ │ │ -class InternalMetricsChannel(AsyncChannel): │ │ │ │ │ - payload = 'metrics1' │ │ │ │ │ - restrictions = [('source', 'internal')] │ │ │ │ │ + if sh: │ │ │ │ │ + command = (' '.join(shlex.quote(arg) for arg in command),) │ │ │ │ │ │ │ │ │ │ - metrics: List[MetricInfo] │ │ │ │ │ - samplers: Set │ │ │ │ │ - samplers_cache: Optional[Dict[str, Tuple[Sampler, SampleDescription]]] = None │ │ │ │ │ + return command │ │ │ │ │ │ │ │ │ │ - interval: int = 1000 │ │ │ │ │ - need_meta: bool = True │ │ │ │ │ - last_timestamp: float = 0 │ │ │ │ │ - next_timestamp: float = 0 │ │ │ │ │ │ │ │ │ │ - @classmethod │ │ │ │ │ - def ensure_samplers(cls): │ │ │ │ │ - if cls.samplers_cache is None: │ │ │ │ │ - cls.samplers_cache = {desc.name: (sampler, desc) for sampler in SAMPLERS for desc in sampler.descriptions} │ │ │ │ │ +def get_ssh_command(*args: str, tty: bool = False) -> Sequence[str]: │ │ │ │ │ + return ('ssh', │ │ │ │ │ + *(['-t'] if tty else ()), │ │ │ │ │ + *args, │ │ │ │ │ + *get_python_command(tty=tty, sh=True)) │ │ │ │ │ │ │ │ │ │ - def parse_options(self, options): │ │ │ │ │ - logger.debug('metrics internal open: %s, channel: %s', options, self.channel) │ │ │ │ │ │ │ │ │ │ - interval = options.get('interval', self.interval) │ │ │ │ │ - if not isinstance(interval, int) or interval <= 0 or interval > sys.maxsize: │ │ │ │ │ - raise ChannelError('protocol-error', message=f'invalid "interval" value: {interval}') │ │ │ │ │ +def get_container_command(*args: str, tty: bool = False) -> Sequence[str]: │ │ │ │ │ + return ('podman', 'exec', '--interactive', │ │ │ │ │ + *(['--tty'] if tty else ()), │ │ │ │ │ + *args, │ │ │ │ │ + *get_python_command(tty=tty)) │ │ │ │ │ │ │ │ │ │ - self.interval = interval │ │ │ │ │ │ │ │ │ │ - metrics = options.get('metrics') │ │ │ │ │ - if not isinstance(metrics, list) or len(metrics) == 0: │ │ │ │ │ - logger.error('invalid "metrics" value: %s', metrics) │ │ │ │ │ - raise ChannelError('protocol-error', message='invalid "metrics" option was specified (not an array)') │ │ │ │ │ +def get_command(*args: str, tty: bool = False, sh: bool = False) -> Sequence[str]: │ │ │ │ │ + return (*args, *get_python_command(local=True, tty=tty, sh=sh)) │ │ │ │ │ │ │ │ │ │ - sampler_classes = set() │ │ │ │ │ - for metric in metrics: │ │ │ │ │ - # validate it's an object │ │ │ │ │ - name = metric.get('name') │ │ │ │ │ - units = metric.get('units') │ │ │ │ │ - derive = metric.get('derive') │ │ │ │ │ │ │ │ │ │ - try: │ │ │ │ │ - sampler, desc = self.samplers_cache[name] │ │ │ │ │ - except KeyError as exc: │ │ │ │ │ - logger.error('unsupported metric: %s', name) │ │ │ │ │ - raise ChannelError('not-supported', message=f'unsupported metric: {name}') from exc │ │ │ │ │ +def splice_in_thread(src: int, dst: IO[bytes]) -> None: │ │ │ │ │ + def _thread() -> None: │ │ │ │ │ + # os.splice() only in Python 3.10 │ │ │ │ │ + with dst: │ │ │ │ │ + block_size = 1 << 20 │ │ │ │ │ + while True: │ │ │ │ │ + data = os.read(src, block_size) │ │ │ │ │ + if not data: │ │ │ │ │ + break │ │ │ │ │ + dst.write(data) │ │ │ │ │ + dst.flush() │ │ │ │ │ │ │ │ │ │ - if units and units != desc.units: │ │ │ │ │ - raise ChannelError('not-supported', message=f'{name} has units {desc.units}, not {units}') │ │ │ │ │ + threading.Thread(target=_thread, daemon=True).start() │ │ │ │ │ │ │ │ │ │ - sampler_classes.add(sampler) │ │ │ │ │ - self.metrics.append(MetricInfo(derive=derive, desc=desc)) │ │ │ │ │ │ │ │ │ │ - self.samplers = {cls() for cls in sampler_classes} │ │ │ │ │ +def send_and_splice(command: Sequence[str], script: bytes) -> None: │ │ │ │ │ + with subprocess.Popen(command, stdin=subprocess.PIPE) as proc: │ │ │ │ │ + assert proc.stdin is not None │ │ │ │ │ + proc.stdin.write(script) │ │ │ │ │ │ │ │ │ │ - def send_meta(self, samples: Samples, timestamp: float): │ │ │ │ │ - metrics: JsonList = [] │ │ │ │ │ - for metricinfo in self.metrics: │ │ │ │ │ - if metricinfo.desc.instanced: │ │ │ │ │ - metrics.append({ │ │ │ │ │ - 'name': metricinfo.desc.name, │ │ │ │ │ - 'units': metricinfo.desc.units, │ │ │ │ │ - 'instances': list(samples[metricinfo.desc.name].keys()), │ │ │ │ │ - 'semantics': metricinfo.desc.semantics │ │ │ │ │ - }) │ │ │ │ │ - else: │ │ │ │ │ - metrics.append({ │ │ │ │ │ - 'name': metricinfo.desc.name, │ │ │ │ │ - 'derive': metricinfo.derive, # type: ignore[dict-item] │ │ │ │ │ - 'units': metricinfo.desc.units, │ │ │ │ │ - 'semantics': metricinfo.desc.semantics │ │ │ │ │ - }) │ │ │ │ │ + splice_in_thread(0, proc.stdin) │ │ │ │ │ + sys.exit(proc.wait()) │ │ │ │ │ │ │ │ │ │ - self.send_json(source='internal', interval=self.interval, timestamp=timestamp * 1000, metrics=metrics) │ │ │ │ │ - self.need_meta = False │ │ │ │ │ │ │ │ │ │ - def sample(self): │ │ │ │ │ - samples = defaultdict(dict) │ │ │ │ │ - for sampler in self.samplers: │ │ │ │ │ - sampler.sample(samples) │ │ │ │ │ - return samples │ │ │ │ │ +def send_xz_and_splice(command: Sequence[str], script: bytes) -> None: │ │ │ │ │ + import ferny │ │ │ │ │ │ │ │ │ │ - def calculate_sample_rate(self, value: float, old_value: Optional[float]) -> Union[float, bool]: │ │ │ │ │ - if old_value is not None and self.last_timestamp: │ │ │ │ │ - return (value - old_value) / (self.next_timestamp - self.last_timestamp) │ │ │ │ │ - else: │ │ │ │ │ - return False │ │ │ │ │ + class Responder(ferny.InteractionResponder): │ │ │ │ │ + async def do_custom_command(self, │ │ │ │ │ + command: str, │ │ │ │ │ + args: Tuple, │ │ │ │ │ + fds: List[int], │ │ │ │ │ + stderr: str) -> None: │ │ │ │ │ + assert proc.stdin is not None │ │ │ │ │ + if command == 'beiboot.provide': │ │ │ │ │ + proc.stdin.write(script) │ │ │ │ │ + proc.stdin.flush() │ │ │ │ │ │ │ │ │ │ - def send_updates(self, samples: Samples, last_samples: Samples): │ │ │ │ │ - data: List[Union[float, List[Optional[Union[float, bool]]]]] = [] │ │ │ │ │ - timestamp = time.time() │ │ │ │ │ - self.next_timestamp = timestamp │ │ │ │ │ + agent = ferny.InteractionAgent(Responder()) │ │ │ │ │ + with subprocess.Popen(command, stdin=subprocess.PIPE, stderr=agent) as proc: │ │ │ │ │ + assert proc.stdin is not None │ │ │ │ │ + proc.stdin.write(make_bootloader([ │ │ │ │ │ + ('boot_xz', ('script.py.xz', len(script), [], True)), │ │ │ │ │ + ], gadgets=ferny.BEIBOOT_GADGETS).encode()) │ │ │ │ │ + proc.stdin.flush() │ │ │ │ │ │ │ │ │ │ - for metricinfo in self.metrics: │ │ │ │ │ - value = samples[metricinfo.desc.name] │ │ │ │ │ + asyncio.run(agent.communicate()) │ │ │ │ │ + splice_in_thread(0, proc.stdin) │ │ │ │ │ + sys.exit(proc.wait()) │ │ │ │ │ │ │ │ │ │ - if metricinfo.desc.instanced: │ │ │ │ │ - old_value = last_samples[metricinfo.desc.name] │ │ │ │ │ - assert isinstance(value, dict) │ │ │ │ │ - assert isinstance(old_value, dict) │ │ │ │ │ │ │ │ │ │ - # If we have less or more keys the data changed, send a meta message. │ │ │ │ │ - if value.keys() != old_value.keys(): │ │ │ │ │ - self.need_meta = True │ │ │ │ │ +def main() -> None: │ │ │ │ │ + parser = argparse.ArgumentParser() │ │ │ │ │ + parser.add_argument('--sh', action='store_true', │ │ │ │ │ + help='Pass Python interpreter command as shell-script') │ │ │ │ │ + parser.add_argument('--xz', help="the xz to run remotely") │ │ │ │ │ + parser.add_argument('--script', │ │ │ │ │ + help="the script to run remotely (must be repl-friendly)") │ │ │ │ │ + parser.add_argument('command', nargs='*') │ │ │ │ │ │ │ │ │ │ - if metricinfo.derive == 'rate': │ │ │ │ │ - instances: List[Optional[Union[float, bool]]] = [] │ │ │ │ │ - for key, val in value.items(): │ │ │ │ │ - instances.append(self.calculate_sample_rate(val, old_value.get(key))) │ │ │ │ │ + args = parser.parse_args() │ │ │ │ │ + tty = not args.script and os.isatty(0) │ │ │ │ │ │ │ │ │ │ - data.append(instances) │ │ │ │ │ - else: │ │ │ │ │ - data.append(list(value.values())) │ │ │ │ │ - else: │ │ │ │ │ - old_value = last_samples.get(metricinfo.desc.name) │ │ │ │ │ - assert not isinstance(value, dict) │ │ │ │ │ - assert not isinstance(old_value, dict) │ │ │ │ │ + if args.command == []: │ │ │ │ │ + command = get_python_command(tty=tty) │ │ │ │ │ + elif args.command[0] == 'ssh': │ │ │ │ │ + command = get_ssh_command(*args.command[1:], tty=tty) │ │ │ │ │ + elif args.command[0] == 'container': │ │ │ │ │ + command = get_container_command(*args.command[1:], tty=tty) │ │ │ │ │ + else: │ │ │ │ │ + command = get_command(*args.command, tty=tty, sh=args.sh) │ │ │ │ │ │ │ │ │ │ - if metricinfo.derive == 'rate': │ │ │ │ │ - data.append(self.calculate_sample_rate(value, old_value)) │ │ │ │ │ - else: │ │ │ │ │ - data.append(value) │ │ │ │ │ + if args.script: │ │ │ │ │ + with open(args.script, 'rb') as file: │ │ │ │ │ + script = file.read() │ │ │ │ │ │ │ │ │ │ - if self.need_meta: │ │ │ │ │ - self.send_meta(samples, timestamp) │ │ │ │ │ + send_and_splice(command, script) │ │ │ │ │ │ │ │ │ │ - self.last_timestamp = self.next_timestamp │ │ │ │ │ - self.send_data(json.dumps([data]).encode()) │ │ │ │ │ + elif args.xz: │ │ │ │ │ + with open(args.xz, 'rb') as file: │ │ │ │ │ + script = file.read() │ │ │ │ │ │ │ │ │ │ - async def run(self, options): │ │ │ │ │ - self.metrics = [] │ │ │ │ │ - self.samplers = set() │ │ │ │ │ + send_xz_and_splice(command, script) │ │ │ │ │ │ │ │ │ │ - InternalMetricsChannel.ensure_samplers() │ │ │ │ │ + else: │ │ │ │ │ + # If we're streaming from stdin then this is a lot easier... │ │ │ │ │ + os.execlp(command[0], *command) │ │ │ │ │ │ │ │ │ │ - self.parse_options(options) │ │ │ │ │ - self.ready() │ │ │ │ │ + # Otherwise, "full strength" │ │ │ │ │ │ │ │ │ │ - last_samples = defaultdict(dict) │ │ │ │ │ - while True: │ │ │ │ │ - samples = self.sample() │ │ │ │ │ - self.send_updates(samples, last_samples) │ │ │ │ │ - last_samples = samples │ │ │ │ │ - await asyncio.sleep(self.interval / 1000) │ │ │ │ │ -''', │ │ │ │ │ - 'cockpit/channels/filesystem.py': r'''# This file is part of Cockpit. │ │ │ │ │ +if __name__ == '__main__': │ │ │ │ │ + main() │ │ │ │ │ +""", │ │ │ │ │ + 'cockpit/_vendor/bei/__init__.py': br'''''', │ │ │ │ │ + 'cockpit/_vendor/bei/bootloader.py': br'''# beiboot - Remote bootloader for Python │ │ │ │ │ # │ │ │ │ │ -# Copyright (C) 2022 Red Hat, Inc. │ │ │ │ │ +# Copyright (C) 2023 Allison Karlitskaya │ │ │ │ │ # │ │ │ │ │ # This program is free software: you can redistribute it and/or modify │ │ │ │ │ # it under the terms of the GNU General Public License as published by │ │ │ │ │ # the Free Software Foundation, either version 3 of the License, or │ │ │ │ │ # (at your option) any later version. │ │ │ │ │ # │ │ │ │ │ # This program is distributed in the hope that it will be useful, │ │ │ │ │ # but WITHOUT ANY WARRANTY; without even the implied warranty of │ │ │ │ │ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the │ │ │ │ │ # GNU General Public License for more details. │ │ │ │ │ # │ │ │ │ │ # You should have received a copy of the GNU General Public License │ │ │ │ │ -# along with this program. If not, see . │ │ │ │ │ - │ │ │ │ │ -import asyncio │ │ │ │ │ -import contextlib │ │ │ │ │ -import enum │ │ │ │ │ -import errno │ │ │ │ │ -import fnmatch │ │ │ │ │ -import functools │ │ │ │ │ -import grp │ │ │ │ │ -import logging │ │ │ │ │ -import os │ │ │ │ │ -import pwd │ │ │ │ │ -import re │ │ │ │ │ -import stat │ │ │ │ │ -import tempfile │ │ │ │ │ -from pathlib import Path │ │ │ │ │ -from typing import Callable, Iterable, Iterator │ │ │ │ │ - │ │ │ │ │ -from cockpit._vendor.systemd_ctypes import Handle, PathWatch │ │ │ │ │ -from cockpit._vendor.systemd_ctypes.inotify import Event as InotifyEvent │ │ │ │ │ -from cockpit._vendor.systemd_ctypes.pathwatch import Listener as PathWatchListener │ │ │ │ │ - │ │ │ │ │ -from ..channel import AsyncChannel, Channel, ChannelError, GeneratorChannel │ │ │ │ │ -from ..jsonutil import ( │ │ │ │ │ - JsonDict, │ │ │ │ │ - JsonDocument, │ │ │ │ │ - JsonError, │ │ │ │ │ - JsonObject, │ │ │ │ │ - get_bool, │ │ │ │ │ - get_enum, │ │ │ │ │ - get_int, │ │ │ │ │ - get_str, │ │ │ │ │ - get_strv, │ │ │ │ │ - json_merge_and_filter_patch, │ │ │ │ │ -) │ │ │ │ │ - │ │ │ │ │ -logger = logging.getLogger(__name__) │ │ │ │ │ +# along with this program. If not, see . │ │ │ │ │ │ │ │ │ │ +import textwrap │ │ │ │ │ +from typing import Dict, Iterable, List, Optional, Sequence, Set, Tuple │ │ │ │ │ │ │ │ │ │ -@functools.lru_cache() │ │ │ │ │ -def my_umask() -> int: │ │ │ │ │ - match = re.search(r'^Umask:\s*0([0-7]*)$', Path('/proc/self/status').read_text(), re.M) │ │ │ │ │ - return (match and int(match.group(1), 8)) or 0o077 │ │ │ │ │ +GADGETS = { │ │ │ │ │ + "_frame": r""" │ │ │ │ │ + import sys │ │ │ │ │ + import traceback │ │ │ │ │ + try: │ │ │ │ │ + ... │ │ │ │ │ + except SystemExit: │ │ │ │ │ + raise │ │ │ │ │ + except BaseException: │ │ │ │ │ + command('beiboot.exc', traceback.format_exc()) │ │ │ │ │ + sys.exit(37) │ │ │ │ │ + """, │ │ │ │ │ + "try_exec": r""" │ │ │ │ │ + import contextlib │ │ │ │ │ + import os │ │ │ │ │ + def try_exec(argv): │ │ │ │ │ + with contextlib.suppress(OSError): │ │ │ │ │ + os.execvp(argv[0], argv) │ │ │ │ │ + """, │ │ │ │ │ + "boot_xz": r""" │ │ │ │ │ + import lzma │ │ │ │ │ + import sys │ │ │ │ │ + def boot_xz(filename, size, args=[], send_end=False): │ │ │ │ │ + command('beiboot.provide', size) │ │ │ │ │ + src_xz = sys.stdin.buffer.read(size) │ │ │ │ │ + src = lzma.decompress(src_xz) │ │ │ │ │ + sys.argv = [filename, *args] │ │ │ │ │ + if send_end: │ │ │ │ │ + end() │ │ │ │ │ + exec(src, { │ │ │ │ │ + '__name__': '__main__', │ │ │ │ │ + '__self_source__': src_xz, │ │ │ │ │ + '__file__': filename}) │ │ │ │ │ + sys.exit() │ │ │ │ │ + """, │ │ │ │ │ +} │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ -def tag_from_stat(buf): │ │ │ │ │ - return f'1:{buf.st_ino}-{buf.st_mtime}-{buf.st_mode:o}-{buf.st_uid}-{buf.st_gid}' │ │ │ │ │ +def split_code(code: str, imports: Set[str]) -> Iterable[Tuple[str, str]]: │ │ │ │ │ + for line in textwrap.dedent(code).splitlines(): │ │ │ │ │ + text = line.lstrip(" ") │ │ │ │ │ + if text.startswith("import "): │ │ │ │ │ + imports.add(text) │ │ │ │ │ + elif text: │ │ │ │ │ + spaces = len(line) - len(text) │ │ │ │ │ + assert (spaces % 4) == 0 │ │ │ │ │ + yield "\t" * (spaces // 4), text │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ -def tag_from_path(path): │ │ │ │ │ - try: │ │ │ │ │ - return tag_from_stat(os.stat(path)) │ │ │ │ │ - except FileNotFoundError: │ │ │ │ │ - return '-' │ │ │ │ │ - except OSError: │ │ │ │ │ - return None │ │ │ │ │ +def yield_body(user_gadgets: Dict[str, str], │ │ │ │ │ + steps: Sequence[Tuple[str, Sequence[object]]], │ │ │ │ │ + imports: Set[str]) -> Iterable[Tuple[str, str]]: │ │ │ │ │ + # Allow the caller to override our gadgets, but keep the original │ │ │ │ │ + # variable for use in the next step. │ │ │ │ │ + gadgets = dict(GADGETS, **user_gadgets) │ │ │ │ │ │ │ │ │ │ + # First emit the gadgets. Emit all gadgets provided by the caller, │ │ │ │ │ + # plus any referred to by the caller's list of steps. │ │ │ │ │ + provided_gadgets = set(user_gadgets) │ │ │ │ │ + step_gadgets = {name for name, _args in steps} │ │ │ │ │ + for name in provided_gadgets | step_gadgets: │ │ │ │ │ + yield from split_code(gadgets[name], imports) │ │ │ │ │ │ │ │ │ │ -def tag_from_fd(fd): │ │ │ │ │ - try: │ │ │ │ │ - return tag_from_stat(os.fstat(fd)) │ │ │ │ │ - except OSError: │ │ │ │ │ - return None │ │ │ │ │ + # Yield functions mentioned in steps from the caller │ │ │ │ │ + for name, args in steps: │ │ │ │ │ + yield '', name + repr(tuple(args)) │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ -class FsListChannel(Channel): │ │ │ │ │ - payload = 'fslist1' │ │ │ │ │ +def make_bootloader(steps: Sequence[Tuple[str, Sequence[object]]], │ │ │ │ │ + gadgets: Optional[Dict[str, str]] = None) -> str: │ │ │ │ │ + imports: Set[str] = set() │ │ │ │ │ + lines: List[str] = [] │ │ │ │ │ │ │ │ │ │ - def send_entry(self, event, entry): │ │ │ │ │ - if entry.is_symlink(): │ │ │ │ │ - mode = 'link' │ │ │ │ │ - elif entry.is_file(): │ │ │ │ │ - mode = 'file' │ │ │ │ │ - elif entry.is_dir(): │ │ │ │ │ - mode = 'directory' │ │ │ │ │ + for frame_spaces, frame_text in split_code(GADGETS["_frame"], imports): │ │ │ │ │ + if frame_text == "...": │ │ │ │ │ + for spaces, text in yield_body(gadgets or {}, steps, imports): │ │ │ │ │ + lines.append(frame_spaces + spaces + text) │ │ │ │ │ else: │ │ │ │ │ - mode = 'special' │ │ │ │ │ - │ │ │ │ │ - self.send_json(event=event, path=entry.name, type=mode) │ │ │ │ │ - │ │ │ │ │ - def do_open(self, options): │ │ │ │ │ - path = options.get('path') │ │ │ │ │ - watch = options.get('watch', True) │ │ │ │ │ - │ │ │ │ │ - if watch: │ │ │ │ │ - raise ChannelError('not-supported', message='watching is not implemented, use fswatch1') │ │ │ │ │ - │ │ │ │ │ - try: │ │ │ │ │ - scan_dir = os.scandir(path) │ │ │ │ │ - except FileNotFoundError as error: │ │ │ │ │ - raise ChannelError('not-found', message=str(error)) from error │ │ │ │ │ - except PermissionError as error: │ │ │ │ │ - raise ChannelError('access-denied', message=str(error)) from error │ │ │ │ │ - except OSError as error: │ │ │ │ │ - raise ChannelError('internal-error', message=str(error)) from error │ │ │ │ │ + lines.append(frame_spaces + frame_text) │ │ │ │ │ │ │ │ │ │ - self.ready() │ │ │ │ │ - for entry in scan_dir: │ │ │ │ │ - self.send_entry("present", entry) │ │ │ │ │ + return "".join(f"{line}\n" for line in [*imports, *lines]) + "\n" │ │ │ │ │ +''', │ │ │ │ │ + 'cockpit/_vendor/bei/spawn.py': br'''"""Helper to create a beipack to spawn a command with files in a tmpdir""" │ │ │ │ │ │ │ │ │ │ - if not watch: │ │ │ │ │ - self.done() │ │ │ │ │ - self.close() │ │ │ │ │ +import argparse │ │ │ │ │ +import os │ │ │ │ │ +import sys │ │ │ │ │ │ │ │ │ │ +from . import pack, tmpfs │ │ │ │ │ │ │ │ │ │ -class FsReadChannel(GeneratorChannel): │ │ │ │ │ - payload = 'fsread1' │ │ │ │ │ │ │ │ │ │ - def do_yield_data(self, options: JsonObject) -> Iterator[bytes]: │ │ │ │ │ - path = get_str(options, 'path') │ │ │ │ │ - binary = get_enum(options, 'binary', ['raw'], None) is not None │ │ │ │ │ - max_read_size = get_int(options, 'max_read_size', None) │ │ │ │ │ +def main() -> None: │ │ │ │ │ + parser = argparse.ArgumentParser() │ │ │ │ │ + parser.add_argument('--file', '-f', action='append') │ │ │ │ │ + parser.add_argument('command', nargs='+', help='The command to execute') │ │ │ │ │ + args = parser.parse_args() │ │ │ │ │ │ │ │ │ │ - logger.debug('Opening file "%s" for reading', path) │ │ │ │ │ + contents = { │ │ │ │ │ + '_beitmpfs.py': tmpfs.__spec__.loader.get_data(tmpfs.__spec__.origin) │ │ │ │ │ + } │ │ │ │ │ │ │ │ │ │ - try: │ │ │ │ │ - with open(path, 'rb') as filep: │ │ │ │ │ - buf = os.stat(filep.fileno()) │ │ │ │ │ - if max_read_size is not None and buf.st_size > max_read_size: │ │ │ │ │ - raise ChannelError('too-large') │ │ │ │ │ + if args.file is not None: │ │ │ │ │ + files = args.file │ │ │ │ │ + else: │ │ │ │ │ + file = args.command[-1] │ │ │ │ │ + files = [file] │ │ │ │ │ + args.command[-1] = './' + os.path.basename(file) │ │ │ │ │ │ │ │ │ │ - if binary and stat.S_ISREG(buf.st_mode): │ │ │ │ │ - self.ready(size_hint=buf.st_size) │ │ │ │ │ - else: │ │ │ │ │ - self.ready() │ │ │ │ │ + for filename in files: │ │ │ │ │ + with open(filename, 'rb') as file: │ │ │ │ │ + basename = os.path.basename(filename) │ │ │ │ │ + contents[f'tmpfs/{basename}'] = file.read() │ │ │ │ │ │ │ │ │ │ - while True: │ │ │ │ │ - data = filep.read1(Channel.BLOCK_SIZE) │ │ │ │ │ - if data == b'': │ │ │ │ │ - break │ │ │ │ │ - logger.debug(' ...sending %d bytes', len(data)) │ │ │ │ │ - if not binary: │ │ │ │ │ - data = data.replace(b'\0', b'').decode('utf-8', errors='ignore').encode('utf-8') │ │ │ │ │ - yield data │ │ │ │ │ + script = pack.pack(contents, '_beitmpfs:main', '*' + repr(args.command)) │ │ │ │ │ + sys.stdout.write(script) │ │ │ │ │ │ │ │ │ │ - return {'tag': tag_from_stat(buf)} │ │ │ │ │ │ │ │ │ │ - except FileNotFoundError: │ │ │ │ │ - return {'tag': '-'} │ │ │ │ │ - except PermissionError as exc: │ │ │ │ │ - raise ChannelError('access-denied') from exc │ │ │ │ │ - except OSError as exc: │ │ │ │ │ - raise ChannelError('internal-error', message=str(exc)) from exc │ │ │ │ │ +if __name__ == '__main__': │ │ │ │ │ + main() │ │ │ │ │ +''', │ │ │ │ │ + 'cockpit/_vendor/bei/data/__init__.py': br'''import sys │ │ │ │ │ │ │ │ │ │ +if sys.version_info >= (3, 9): │ │ │ │ │ + import importlib.abc │ │ │ │ │ + import importlib.resources │ │ │ │ │ │ │ │ │ │ -class FsReplaceChannel(AsyncChannel): │ │ │ │ │ - payload = 'fsreplace1' │ │ │ │ │ + def read_data_file(filename: str) -> str: │ │ │ │ │ + return (importlib.resources.files(__name__) / filename).read_text() │ │ │ │ │ +else: │ │ │ │ │ + def read_data_file(filename: str) -> str: │ │ │ │ │ + loader = __loader__ # type: ignore[name-defined] │ │ │ │ │ + data = loader.get_data(__file__.replace('__init__.py', filename)) │ │ │ │ │ + return data.decode('utf-8') │ │ │ │ │ +''', │ │ │ │ │ + 'cockpit/_vendor/bei/data/beipack_loader.py': br'''# beipack https://github.com/allisonkarlitskaya/beipack │ │ │ │ │ │ │ │ │ │ - def delete(self, path: str, tag: 'str | None') -> str: │ │ │ │ │ - if tag is not None and tag != tag_from_path(path): │ │ │ │ │ - raise ChannelError('change-conflict') │ │ │ │ │ - with contextlib.suppress(FileNotFoundError): # delete is idempotent │ │ │ │ │ - os.unlink(path) │ │ │ │ │ - return '-' │ │ │ │ │ +import importlib.abc │ │ │ │ │ +import importlib.util │ │ │ │ │ +import io │ │ │ │ │ +import sys │ │ │ │ │ +from types import ModuleType │ │ │ │ │ +from typing import BinaryIO, Dict, Iterator, Optional, Sequence │ │ │ │ │ │ │ │ │ │ - async def set_contents(self, path: str, tag: 'str | None', data: 'bytes | None', size: 'int | None') -> str: │ │ │ │ │ - dirname, basename = os.path.split(path) │ │ │ │ │ - tmpname: str | None │ │ │ │ │ - fd, tmpname = tempfile.mkstemp(dir=dirname, prefix=f'.{basename}-') │ │ │ │ │ - try: │ │ │ │ │ - if size is not None: │ │ │ │ │ - logger.debug('fallocate(%s.tmp, %d)', path, size) │ │ │ │ │ - if size: # posix_fallocate() of 0 bytes is EINVAL │ │ │ │ │ - await self.in_thread(os.posix_fallocate, fd, 0, size) │ │ │ │ │ - self.ready() # ...only after that worked │ │ │ │ │ │ │ │ │ │ - written = 0 │ │ │ │ │ - while data is not None: │ │ │ │ │ - await self.in_thread(os.write, fd, data) │ │ │ │ │ - written += len(data) │ │ │ │ │ - data = await self.read() │ │ │ │ │ +class BeipackLoader(importlib.abc.SourceLoader, importlib.abc.MetaPathFinder): │ │ │ │ │ + if sys.version_info >= (3, 11): │ │ │ │ │ + from importlib.resources.abc import ResourceReader as AbstractResourceReader │ │ │ │ │ + else: │ │ │ │ │ + AbstractResourceReader = object │ │ │ │ │ │ │ │ │ │ - if size is not None and written < size: │ │ │ │ │ - logger.debug('ftruncate(%s.tmp, %d)', path, written) │ │ │ │ │ - await self.in_thread(os.ftruncate, fd, written) │ │ │ │ │ + class ResourceReader(AbstractResourceReader): │ │ │ │ │ + def __init__(self, contents: Dict[str, bytes], filename: str) -> None: │ │ │ │ │ + self._contents = contents │ │ │ │ │ + self._dir = f'{filename}/' │ │ │ │ │ │ │ │ │ │ - await self.in_thread(os.fdatasync, fd) │ │ │ │ │ + def is_resource(self, resource: str) -> bool: │ │ │ │ │ + return f'{self._dir}{resource}' in self._contents │ │ │ │ │ │ │ │ │ │ - if tag is None: │ │ │ │ │ - # no preconditions about what currently exists or not │ │ │ │ │ - # calculate the file mode from the umask │ │ │ │ │ - os.fchmod(fd, 0o666 & ~my_umask()) │ │ │ │ │ - os.rename(tmpname, path) │ │ │ │ │ - tmpname = None │ │ │ │ │ + def open_resource(self, resource: str) -> BinaryIO: │ │ │ │ │ + return io.BytesIO(self._contents[f'{self._dir}{resource}']) │ │ │ │ │ │ │ │ │ │ - elif tag == '-': │ │ │ │ │ - # the file must not exist. file mode from umask. │ │ │ │ │ - os.fchmod(fd, 0o666 & ~my_umask()) │ │ │ │ │ - os.link(tmpname, path) # will fail if file exists │ │ │ │ │ + def resource_path(self, resource: str) -> str: │ │ │ │ │ + raise FileNotFoundError │ │ │ │ │ │ │ │ │ │ - else: │ │ │ │ │ - # the file must exist with the given tag │ │ │ │ │ - buf = os.stat(path) │ │ │ │ │ - if tag != tag_from_stat(buf): │ │ │ │ │ - raise ChannelError('change-conflict') │ │ │ │ │ - # chown/chmod from the existing file permissions │ │ │ │ │ - os.fchmod(fd, stat.S_IMODE(buf.st_mode)) │ │ │ │ │ - os.fchown(fd, buf.st_uid, buf.st_gid) │ │ │ │ │ - os.rename(tmpname, path) │ │ │ │ │ - tmpname = None │ │ │ │ │ + def contents(self) -> Iterator[str]: │ │ │ │ │ + dir_length = len(self._dir) │ │ │ │ │ + result = set() │ │ │ │ │ │ │ │ │ │ - finally: │ │ │ │ │ - os.close(fd) │ │ │ │ │ - if tmpname is not None: │ │ │ │ │ - os.unlink(tmpname) │ │ │ │ │ + for filename in self._contents: │ │ │ │ │ + if filename.startswith(self._dir): │ │ │ │ │ + try: │ │ │ │ │ + next_slash = filename.index('/', dir_length) │ │ │ │ │ + except ValueError: │ │ │ │ │ + next_slash = None │ │ │ │ │ + result.add(filename[dir_length:next_slash]) │ │ │ │ │ │ │ │ │ │ - return tag_from_path(path) │ │ │ │ │ + return iter(result) │ │ │ │ │ │ │ │ │ │ - async def run(self, options: JsonObject) -> JsonObject: │ │ │ │ │ - path = get_str(options, 'path') │ │ │ │ │ - size = get_int(options, 'size', None) │ │ │ │ │ - tag = get_str(options, 'tag', None) │ │ │ │ │ + contents: Dict[str, bytes] │ │ │ │ │ + modules: Dict[str, str] │ │ │ │ │ │ │ │ │ │ + def __init__(self, contents: Dict[str, bytes]) -> None: │ │ │ │ │ try: │ │ │ │ │ - # In the `size` case, .set_contents() sends the ready only after │ │ │ │ │ - # it knows that the allocate was successful. In the case without │ │ │ │ │ - # `size`, we need to send the ready() up front in order to │ │ │ │ │ - # receive the first frame and decide if we're creating or deleting. │ │ │ │ │ - if size is not None: │ │ │ │ │ - tag = await self.set_contents(path, tag, b'', size) │ │ │ │ │ - else: │ │ │ │ │ - self.ready() │ │ │ │ │ - data = await self.read() │ │ │ │ │ - # if we get EOF right away, that's a request to delete │ │ │ │ │ - if data is None: │ │ │ │ │ - tag = self.delete(path, tag) │ │ │ │ │ - else: │ │ │ │ │ - tag = await self.set_contents(path, tag, data, None) │ │ │ │ │ - │ │ │ │ │ - self.done() │ │ │ │ │ - return {'tag': tag} │ │ │ │ │ - │ │ │ │ │ - except FileNotFoundError as exc: │ │ │ │ │ - raise ChannelError('not-found') from exc │ │ │ │ │ - except FileExistsError as exc: │ │ │ │ │ - # that's from link() noticing that the target file already exists │ │ │ │ │ - raise ChannelError('change-conflict') from exc │ │ │ │ │ - except PermissionError as exc: │ │ │ │ │ - raise ChannelError('access-denied') from exc │ │ │ │ │ - except IsADirectoryError as exc: │ │ │ │ │ - # not ideal, but the closest code we have │ │ │ │ │ - raise ChannelError('access-denied', message=str(exc)) from exc │ │ │ │ │ - except OSError as exc: │ │ │ │ │ - raise ChannelError('internal-error', message=str(exc)) from exc │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -class FsWatchChannel(Channel): │ │ │ │ │ - payload = 'fswatch1' │ │ │ │ │ - _tag = None │ │ │ │ │ - _path = None │ │ │ │ │ - _watch = None │ │ │ │ │ - │ │ │ │ │ - # The C bridge doesn't send the initial event, and the JS calls read() │ │ │ │ │ - # instead to figure out the initial state of the file. If we send the │ │ │ │ │ - # initial state then we cause the event to get delivered twice. │ │ │ │ │ - # Ideally we'll sort that out at some point, but for now, suppress it. │ │ │ │ │ - _active = False │ │ │ │ │ - │ │ │ │ │ - @staticmethod │ │ │ │ │ - def mask_to_event_and_type(mask): │ │ │ │ │ - if (InotifyEvent.CREATE or InotifyEvent.MOVED_TO) in mask: │ │ │ │ │ - return 'created', 'directory' if InotifyEvent.ISDIR in mask else 'file' │ │ │ │ │ - elif InotifyEvent.MOVED_FROM in mask or InotifyEvent.DELETE in mask or InotifyEvent.DELETE_SELF in mask: │ │ │ │ │ - return 'deleted', None │ │ │ │ │ - elif InotifyEvent.ATTRIB in mask: │ │ │ │ │ - return 'attribute-changed', None │ │ │ │ │ - elif InotifyEvent.CLOSE_WRITE in mask: │ │ │ │ │ - return 'done-hint', None │ │ │ │ │ - else: │ │ │ │ │ - return 'changed', None │ │ │ │ │ - │ │ │ │ │ - def do_inotify_event(self, mask, _cookie, name): │ │ │ │ │ - logger.debug("do_inotify_event(%s): mask %X name %s", self._path, mask, name) │ │ │ │ │ - event, type_ = self.mask_to_event_and_type(mask) │ │ │ │ │ - if name: │ │ │ │ │ - # file inside watched directory changed │ │ │ │ │ - path = os.path.join(self._path, name.decode()) │ │ │ │ │ - tag = tag_from_path(path) │ │ │ │ │ - self.send_json(event=event, path=path, tag=tag, type=type_) │ │ │ │ │ - else: │ │ │ │ │ - # the watched path itself changed; filter out duplicate events │ │ │ │ │ - tag = tag_from_path(self._path) │ │ │ │ │ - if tag == self._tag: │ │ │ │ │ - return │ │ │ │ │ - self._tag = tag │ │ │ │ │ - self.send_json(event=event, path=self._path, tag=self._tag, type=type_) │ │ │ │ │ - │ │ │ │ │ - def do_identity_changed(self, fd, err): │ │ │ │ │ - logger.debug("do_identity_changed(%s): fd %s, err %s", self._path, str(fd), err) │ │ │ │ │ - self._tag = tag_from_fd(fd) if fd else '-' │ │ │ │ │ - if self._active: │ │ │ │ │ - self.send_json(event='created' if fd else 'deleted', path=self._path, tag=self._tag) │ │ │ │ │ - │ │ │ │ │ - def do_open(self, options): │ │ │ │ │ - self._path = options['path'] │ │ │ │ │ - self._tag = None │ │ │ │ │ - │ │ │ │ │ - self._active = False │ │ │ │ │ - self._watch = PathWatch(self._path, self) │ │ │ │ │ - self._active = True │ │ │ │ │ - │ │ │ │ │ - self.ready() │ │ │ │ │ - │ │ │ │ │ - def do_close(self): │ │ │ │ │ - self._watch.close() │ │ │ │ │ - self._watch = None │ │ │ │ │ - self.close() │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -class Follow(enum.Enum): │ │ │ │ │ - NO = False │ │ │ │ │ - YES = True │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ -class FsInfoChannel(Channel, PathWatchListener): │ │ │ │ │ - payload = 'fsinfo' │ │ │ │ │ - │ │ │ │ │ - # Options (all get set in `do_open()`) │ │ │ │ │ - path: str │ │ │ │ │ - attrs: 'set[str]' │ │ │ │ │ - fnmatch: str │ │ │ │ │ - targets: bool │ │ │ │ │ - follow: bool │ │ │ │ │ - watch: bool │ │ │ │ │ - │ │ │ │ │ - # State │ │ │ │ │ - current_value: JsonDict │ │ │ │ │ - effective_fnmatch: str = '' │ │ │ │ │ - fd: 'Handle | None' = None │ │ │ │ │ - pending: 'set[str] | None' = None │ │ │ │ │ - path_watch: 'PathWatch | None' = None │ │ │ │ │ - getattrs: 'Callable[[int, str, Follow], JsonDocument]' │ │ │ │ │ - │ │ │ │ │ - @staticmethod │ │ │ │ │ - def make_getattrs(attrs: Iterable[str]) -> 'Callable[[int, str, Follow], JsonDocument | None]': │ │ │ │ │ - # Cached for the duration of the closure we're creating │ │ │ │ │ - @functools.lru_cache() │ │ │ │ │ - def get_user(uid: int) -> 'str | int': │ │ │ │ │ - try: │ │ │ │ │ - return pwd.getpwuid(uid).pw_name │ │ │ │ │ - except KeyError: │ │ │ │ │ - return uid │ │ │ │ │ - │ │ │ │ │ - @functools.lru_cache() │ │ │ │ │ - def get_group(gid: int) -> 'str | int': │ │ │ │ │ - try: │ │ │ │ │ - return grp.getgrgid(gid).gr_name │ │ │ │ │ - except KeyError: │ │ │ │ │ - return gid │ │ │ │ │ + contents[__file__] = __self_source__ # type: ignore[name-defined] │ │ │ │ │ + except NameError: │ │ │ │ │ + pass │ │ │ │ │ │ │ │ │ │ - stat_types = {stat.S_IFREG: 'reg', stat.S_IFDIR: 'dir', stat.S_IFLNK: 'lnk', stat.S_IFCHR: 'chr', │ │ │ │ │ - stat.S_IFBLK: 'blk', stat.S_IFIFO: 'fifo', stat.S_IFSOCK: 'sock'} │ │ │ │ │ - available_stat_getters = { │ │ │ │ │ - 'type': lambda buf: stat_types.get(stat.S_IFMT(buf.st_mode)), │ │ │ │ │ - 'tag': tag_from_stat, │ │ │ │ │ - 'mode': lambda buf: stat.S_IMODE(buf.st_mode), │ │ │ │ │ - 'size': lambda buf: buf.st_size, │ │ │ │ │ - 'uid': lambda buf: buf.st_uid, │ │ │ │ │ - 'gid': lambda buf: buf.st_gid, │ │ │ │ │ - 'mtime': lambda buf: buf.st_mtime, │ │ │ │ │ - 'user': lambda buf: get_user(buf.st_uid), │ │ │ │ │ - 'group': lambda buf: get_group(buf.st_gid), │ │ │ │ │ + self.contents = contents │ │ │ │ │ + self.modules = { │ │ │ │ │ + self.get_fullname(filename): filename │ │ │ │ │ + for filename in contents │ │ │ │ │ + if filename.endswith(".py") │ │ │ │ │ } │ │ │ │ │ - stat_getters = tuple((key, available_stat_getters.get(key, lambda _: None)) for key in attrs) │ │ │ │ │ - │ │ │ │ │ - def get_attrs(fd: int, name: str, follow: Follow) -> 'JsonDict | None': │ │ │ │ │ - try: │ │ │ │ │ - buf = os.stat(name, follow_symlinks=follow.value, dir_fd=fd) if name else os.fstat(fd) │ │ │ │ │ - except FileNotFoundError: │ │ │ │ │ - return None │ │ │ │ │ - except OSError: │ │ │ │ │ - return {name: None for name, func in stat_getters} │ │ │ │ │ - │ │ │ │ │ - result = {key: func(buf) for key, func in stat_getters} │ │ │ │ │ - │ │ │ │ │ - if 'target' in result and stat.S_IFMT(buf.st_mode) == stat.S_IFLNK: │ │ │ │ │ - with contextlib.suppress(OSError): │ │ │ │ │ - result['target'] = os.readlink(name, dir_fd=fd) │ │ │ │ │ - │ │ │ │ │ - return result │ │ │ │ │ - │ │ │ │ │ - return get_attrs │ │ │ │ │ - │ │ │ │ │ - def send_update(self, updates: JsonDict, *, reset: bool = False) -> None: │ │ │ │ │ - if reset: │ │ │ │ │ - if set(self.current_value) & set(updates): │ │ │ │ │ - # if we have an overlap, we need to do a proper reset │ │ │ │ │ - self.send_json(dict.fromkeys(self.current_value), partial=True) │ │ │ │ │ - self.current_value = {'partial': True} │ │ │ │ │ - updates.update(partial=None) │ │ │ │ │ - else: │ │ │ │ │ - # otherwise there's no overlap: we can just remove the old keys │ │ │ │ │ - updates.update(dict.fromkeys(self.current_value)) │ │ │ │ │ - │ │ │ │ │ - json_merge_and_filter_patch(self.current_value, updates) │ │ │ │ │ - if updates: │ │ │ │ │ - self.send_json(updates) │ │ │ │ │ - │ │ │ │ │ - def process_update(self, updates: 'set[str]', *, reset: bool = False) -> None: │ │ │ │ │ - assert self.fd is not None │ │ │ │ │ - │ │ │ │ │ - entries: JsonDict = {name: self.getattrs(self.fd, name, Follow.NO) for name in updates} │ │ │ │ │ - │ │ │ │ │ - info = entries.pop('', {}) │ │ │ │ │ - assert isinstance(info, dict) # fstat() will never fail with FileNotFoundError │ │ │ │ │ - │ │ │ │ │ - if self.effective_fnmatch: │ │ │ │ │ - info['entries'] = entries │ │ │ │ │ - │ │ │ │ │ - if self.targets: │ │ │ │ │ - info['targets'] = targets = {} │ │ │ │ │ - for name in {e.get('target') for e in entries.values() if isinstance(e, dict)}: │ │ │ │ │ - if isinstance(name, str) and ('/' in name or not self.interesting(name)): │ │ │ │ │ - # if this target is a string that we wouldn't otherwise │ │ │ │ │ - # report, then report it via our "targets" attribute. │ │ │ │ │ - targets[name] = self.getattrs(self.fd, name, Follow.YES) │ │ │ │ │ - │ │ │ │ │ - self.send_update({'info': info}, reset=reset) │ │ │ │ │ - │ │ │ │ │ - def process_pending_updates(self) -> None: │ │ │ │ │ - assert self.pending is not None │ │ │ │ │ - if self.pending: │ │ │ │ │ - self.process_update(self.pending) │ │ │ │ │ - self.pending = None │ │ │ │ │ - │ │ │ │ │ - def interesting(self, name: str) -> bool: │ │ │ │ │ - if name == '': │ │ │ │ │ - return True │ │ │ │ │ - else: │ │ │ │ │ - # only report updates on entry filenames if we match them │ │ │ │ │ - return fnmatch.fnmatch(name, self.effective_fnmatch) │ │ │ │ │ - │ │ │ │ │ - def schedule_update(self, name: str) -> None: │ │ │ │ │ - if not self.interesting(name): │ │ │ │ │ - return │ │ │ │ │ - │ │ │ │ │ - if self.pending is None: │ │ │ │ │ - asyncio.get_running_loop().call_later(0.1, self.process_pending_updates) │ │ │ │ │ - self.pending = set() │ │ │ │ │ - │ │ │ │ │ - self.pending.add(name) │ │ │ │ │ - │ │ │ │ │ - def report_error(self, err: int) -> None: │ │ │ │ │ - if err == errno.ENOENT: │ │ │ │ │ - problem = 'not-found' │ │ │ │ │ - elif err in (errno.EPERM, errno.EACCES): │ │ │ │ │ - problem = 'access-denied' │ │ │ │ │ - elif err == errno.ENOTDIR: │ │ │ │ │ - problem = 'not-directory' │ │ │ │ │ - else: │ │ │ │ │ - problem = 'internal-error' │ │ │ │ │ - │ │ │ │ │ - self.send_update({'error': { │ │ │ │ │ - 'problem': problem, 'message': os.strerror(err), 'errno': errno.errorcode[err] │ │ │ │ │ - }}, reset=True) │ │ │ │ │ - │ │ │ │ │ - def flag_onlydir_error(self, fd: Handle) -> bool: │ │ │ │ │ - # If our requested path ended with '/' then make sure we got a │ │ │ │ │ - # directory, or else it's an error. open() will have already flagged │ │ │ │ │ - # that for us, but systemd_ctypes doesn't do that (yet). │ │ │ │ │ - if not self.watch or not self.path.endswith('/'): │ │ │ │ │ - return False │ │ │ │ │ - │ │ │ │ │ - buf = os.fstat(fd) # this should never fail │ │ │ │ │ - if stat.S_IFMT(buf.st_mode) != stat.S_IFDIR: │ │ │ │ │ - self.report_error(errno.ENOTDIR) │ │ │ │ │ - return True │ │ │ │ │ - │ │ │ │ │ - return False │ │ │ │ │ - │ │ │ │ │ - def report_initial_state(self, fd: Handle) -> None: │ │ │ │ │ - if self.flag_onlydir_error(fd): │ │ │ │ │ - return │ │ │ │ │ - │ │ │ │ │ - self.fd = fd │ │ │ │ │ - │ │ │ │ │ - entries = {''} │ │ │ │ │ - if self.fnmatch: │ │ │ │ │ - try: │ │ │ │ │ - entries.update(os.listdir(f'/proc/self/fd/{self.fd}')) │ │ │ │ │ - self.effective_fnmatch = self.fnmatch │ │ │ │ │ - except OSError: │ │ │ │ │ - # If we failed to get an initial list, then report nothing from now on │ │ │ │ │ - self.effective_fnmatch = '' │ │ │ │ │ - │ │ │ │ │ - self.process_update({e for e in entries if self.interesting(e)}, reset=True) │ │ │ │ │ - │ │ │ │ │ - def do_inotify_event(self, mask: InotifyEvent, cookie: int, rawname: 'bytes | None') -> None: │ │ │ │ │ - logger.debug('do_inotify_event(%r, %r, %r)', mask, cookie, rawname) │ │ │ │ │ - name = (rawname or b'').decode(errors='surrogateescape') │ │ │ │ │ │ │ │ │ │ - self.schedule_update(name) │ │ │ │ │ - │ │ │ │ │ - if name and mask | (InotifyEvent.CREATE | InotifyEvent.DELETE | │ │ │ │ │ - InotifyEvent.MOVED_TO | InotifyEvent.MOVED_FROM): │ │ │ │ │ - # These events change the mtime of the directory │ │ │ │ │ - self.schedule_update('') │ │ │ │ │ + def get_fullname(self, filename: str) -> str: │ │ │ │ │ + assert filename.endswith(".py") │ │ │ │ │ + filename = filename[:-3] │ │ │ │ │ + if filename.endswith("/__init__"): │ │ │ │ │ + filename = filename[:-9] │ │ │ │ │ + return filename.replace("/", ".") │ │ │ │ │ │ │ │ │ │ - def do_identity_changed(self, fd: 'Handle | None', err: 'int | None') -> None: │ │ │ │ │ - logger.debug('do_identity_changed(%r, %r)', fd, err) │ │ │ │ │ - # If there were previously pending changes, they are now irrelevant. │ │ │ │ │ - if self.pending is not None: │ │ │ │ │ - # Note: don't set to None, since the handler is still pending │ │ │ │ │ - self.pending.clear() │ │ │ │ │ + def get_resource_reader(self, fullname: str) -> ResourceReader: │ │ │ │ │ + return BeipackLoader.ResourceReader(self.contents, fullname.replace('.', '/')) │ │ │ │ │ │ │ │ │ │ - if err is None: │ │ │ │ │ - assert fd is not None │ │ │ │ │ - self.report_initial_state(fd) │ │ │ │ │ - else: │ │ │ │ │ - self.report_error(err) │ │ │ │ │ + def get_data(self, path: str) -> bytes: │ │ │ │ │ + return self.contents[path] │ │ │ │ │ │ │ │ │ │ - def do_close(self) -> None: │ │ │ │ │ - # non-watch channels close immediately — if we get this, we're watching │ │ │ │ │ - assert self.path_watch is not None │ │ │ │ │ - self.path_watch.close() │ │ │ │ │ - self.close() │ │ │ │ │ + def get_filename(self, fullname: str) -> str: │ │ │ │ │ + return self.modules[fullname] │ │ │ │ │ │ │ │ │ │ - def do_open(self, options: JsonObject) -> None: │ │ │ │ │ - self.path = get_str(options, 'path') │ │ │ │ │ - if not os.path.isabs(self.path): │ │ │ │ │ - raise JsonError(options, '"path" must be an absolute path') │ │ │ │ │ + def find_spec( │ │ │ │ │ + self, │ │ │ │ │ + fullname: str, │ │ │ │ │ + path: Optional[Sequence[str]], │ │ │ │ │ + target: Optional[ModuleType] = None │ │ │ │ │ + ) -> Optional[importlib.machinery.ModuleSpec]: │ │ │ │ │ + if fullname not in self.modules: │ │ │ │ │ + return None │ │ │ │ │ + return importlib.util.spec_from_loader(fullname, self) │ │ │ │ │ +''', │ │ │ │ │ + 'cockpit/data/fail.html': br''' │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ + @@message@@ │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +
│ │ │ │ │ + │ │ │ │ │ +

@@message@@

│ │ │ │ │ +
│ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ +''', │ │ │ │ │ + 'cockpit/data/__init__.py': br'''import sys │ │ │ │ │ │ │ │ │ │ - attrs = set(get_strv(options, 'attrs')) │ │ │ │ │ - self.getattrs = self.make_getattrs(attrs - {'targets', 'entries'}) │ │ │ │ │ - self.fnmatch = get_str(options, 'fnmatch', '*' if 'entries' in attrs else '') │ │ │ │ │ - self.targets = 'targets' in attrs │ │ │ │ │ - self.follow = get_bool(options, 'follow', default=True) │ │ │ │ │ - self.watch = get_bool(options, 'watch', default=False) │ │ │ │ │ - if self.watch and not self.follow: │ │ │ │ │ - raise JsonError(options, '"watch: true" and "follow: false" are (currently) incompatible') │ │ │ │ │ - if self.targets and not self.follow: │ │ │ │ │ - raise JsonError(options, '`targets: "stat"` and `follow: false` are (currently) incompatible') │ │ │ │ │ +if sys.version_info >= (3, 11): │ │ │ │ │ + import importlib.resources │ │ │ │ │ │ │ │ │ │ - self.current_value = {} │ │ │ │ │ - self.ready() │ │ │ │ │ + def read_cockpit_data_file(filename: str) -> bytes: │ │ │ │ │ + return (importlib.resources.files('cockpit.data') / filename).read_bytes() │ │ │ │ │ │ │ │ │ │ - if not self.watch: │ │ │ │ │ - try: │ │ │ │ │ - fd = Handle.open(self.path, os.O_PATH if self.follow else os.O_PATH | os.O_NOFOLLOW) │ │ │ │ │ - except OSError as exc: │ │ │ │ │ - self.report_error(exc.errno) │ │ │ │ │ - else: │ │ │ │ │ - self.report_initial_state(fd) │ │ │ │ │ - fd.close() │ │ │ │ │ +else: │ │ │ │ │ + import importlib.abc │ │ │ │ │ │ │ │ │ │ - self.done() │ │ │ │ │ - self.close() │ │ │ │ │ + def read_cockpit_data_file(filename: str) -> bytes: │ │ │ │ │ + # https://github.com/python/mypy/issues/4182 │ │ │ │ │ + loader = __loader__ # type: ignore[name-defined] │ │ │ │ │ + assert isinstance(loader, importlib.abc.ResourceLoader) │ │ │ │ │ │ │ │ │ │ - else: │ │ │ │ │ - # PathWatch will call do_identity_changed(), which does the same as │ │ │ │ │ - # above: calls either report_initial_state() or report_error(), │ │ │ │ │ - # depending on if it was provided with an fd or an error code. │ │ │ │ │ - self.path_watch = PathWatch(self.path, self) │ │ │ │ │ -'''.encode('utf-8'), │ │ │ │ │ + path = __file__.replace('__init__.py', filename) │ │ │ │ │ + return loader.get_data(path) │ │ │ │ │ +''', │ │ │ │ │ })) │ │ │ │ │ from cockpit.bridge import main as main │ │ │ │ │ main(beipack=True) │ │ │ ├── ./usr/lib/python3/dist-packages/cockpit-317.dist-info/direct_url.json │ │ │ │ ├── Pretty-printed │ │ │ │ │┄ Similarity: 0.90625% │ │ │ │ │┄ Differences: {"'archive_info'": "{'hash': " │ │ │ │ │┄ "'sha256=dec088452ec6f25fcf224728543a98272d3d6296c11d172cddcbef693df5d1a8', " │ │ │ │ │┄ "'hashes': {'sha256': " │ │ │ │ │┄ "'dec088452ec6f25fcf224728543a98272d3d6296c11d172cddcbef693df5d1a8'}}"} │ │ │ │ │ @@ -1,9 +1,9 @@ │ │ │ │ │ { │ │ │ │ │ "archive_info": { │ │ │ │ │ - "hash": "sha256=706224e4acf3739a18e599033e60b05e24f2267635349e04d8cf7144c0a58444", │ │ │ │ │ + "hash": "sha256=dec088452ec6f25fcf224728543a98272d3d6296c11d172cddcbef693df5d1a8", │ │ │ │ │ "hashes": { │ │ │ │ │ - "sha256": "706224e4acf3739a18e599033e60b05e24f2267635349e04d8cf7144c0a58444" │ │ │ │ │ + "sha256": "dec088452ec6f25fcf224728543a98272d3d6296c11d172cddcbef693df5d1a8" │ │ │ │ │ } │ │ │ │ │ }, │ │ │ │ │ "url": "file:///build/reproducible-path/cockpit-317/tmp/wheel/cockpit-317-py3-none-any.whl" │ │ │ │ │ }