{"diffoscope-json-version": 1, "source1": "/srv/reproducible-results/rbuild-debian/r-b-build.CgFvhNOk/b1/cockpit_316-1_armhf.changes", "source2": "/srv/reproducible-results/rbuild-debian/r-b-build.CgFvhNOk/b2/cockpit_316-1_armhf.changes", "unified_diff": null, "details": [{"source1": "Files", "source2": "Files", "unified_diff": "@@ -1,10 +1,10 @@\n \n 760242981c5b49ff96bf84495fa91aa1 138280 debug optional cockpit-bridge-dbgsym_316-1_armhf.deb\n- a12ed1b47518f1e6508d7cd49f40f947 354160 admin optional cockpit-bridge_316-1_armhf.deb\n+ 567d14ea09e664a5190dcb5693fd82e8 354536 admin optional cockpit-bridge_316-1_armhf.deb\n b244333d93e755b8795d5de9bfd74a75 131516 doc optional cockpit-doc_316-1_all.deb\n 5f5f51363cccd25ac69165e1bfe089be 829340 admin optional cockpit-networkmanager_316-1_all.deb\n b259a5a3925e9a8e04317b97aff99eea 941992 admin optional cockpit-packagekit_316-1_all.deb\n 4dbce21d388fa24e5bed69be2cddd7a5 231296 debug optional cockpit-pcp-dbgsym_316-1_armhf.deb\n a4aa6122dd089728e6df0468cf433908 71148 admin optional cockpit-pcp_316-1_armhf.deb\n ca337edae770f17961c72b2ed6a3a2e1 558888 admin optional cockpit-sosreport_316-1_all.deb\n 510e4876abdbe0222c7a9eaf8eed0969 879356 admin optional cockpit-storaged_316-1_all.deb\n"}, {"source1": "cockpit-bridge_316-1_armhf.deb", "source2": "cockpit-bridge_316-1_armhf.deb", "unified_diff": null, "details": [{"source1": "file list", "source2": "file list", "unified_diff": "@@ -1,3 +1,3 @@\n -rw-r--r-- 0 0 0 4 2024-04-26 05:46:21.000000 debian-binary\n--rw-r--r-- 0 0 0 3880 2024-04-26 05:46:21.000000 control.tar.xz\n--rw-r--r-- 0 0 0 350088 2024-04-26 05:46:21.000000 data.tar.xz\n+-rw-r--r-- 0 0 0 3884 2024-04-26 05:46:21.000000 control.tar.xz\n+-rw-r--r-- 0 0 0 350460 2024-04-26 05:46:21.000000 data.tar.xz\n"}, {"source1": "control.tar.xz", "source2": "control.tar.xz", "unified_diff": null, "details": [{"source1": "control.tar", "source2": "control.tar", "unified_diff": null, "details": [{"source1": "./md5sums", "source2": "./md5sums", "unified_diff": null, "details": [{"source1": "./md5sums", "source2": "./md5sums", "comments": ["Files differ"], "unified_diff": null}]}]}]}, {"source1": "data.tar.xz", "source2": "data.tar.xz", "unified_diff": null, "details": [{"source1": "data.tar", "source2": "data.tar", "unified_diff": null, "details": [{"source1": "file list", "source2": "file list", "unified_diff": "@@ -60,15 +60,15 @@\n -rw-r--r-- 0 root (0) root (0) 6653 2024-04-26 05:46:21.000000 ./usr/lib/python3/dist-packages/cockpit/channels/metrics.py\n -rw-r--r-- 0 root (0) root (0) 4058 2024-04-26 05:46:21.000000 ./usr/lib/python3/dist-packages/cockpit/channels/packages.py\n -rw-r--r-- 0 root (0) root (0) 4872 2024-04-26 05:46:21.000000 ./usr/lib/python3/dist-packages/cockpit/channels/stream.py\n -rw-r--r-- 0 root (0) root (0) 1171 2024-04-26 05:46:21.000000 ./usr/lib/python3/dist-packages/cockpit/channels/trivial.py\n -rw-r--r-- 0 root (0) root (0) 3188 2024-04-26 05:46:21.000000 ./usr/lib/python3/dist-packages/cockpit/config.py\n drwxr-xr-x 0 root (0) root (0) 0 2024-04-26 05:46:21.000000 ./usr/lib/python3/dist-packages/cockpit/data/\n -rw-r--r-- 0 root (0) root (0) 574 2024-04-26 05:46:21.000000 ./usr/lib/python3/dist-packages/cockpit/data/__init__.py\n--rw-r--r-- 0 root (0) root (0) 86616 2024-04-26 05:46:21.000000 ./usr/lib/python3/dist-packages/cockpit/data/cockpit-bridge.beipack.xz\n+-rw-r--r-- 0 root (0) root (0) 87016 2024-04-26 05:46:21.000000 ./usr/lib/python3/dist-packages/cockpit/data/cockpit-bridge.beipack.xz\n -rw-r--r-- 0 root (0) root (0) 3212 2024-04-26 05:46:21.000000 ./usr/lib/python3/dist-packages/cockpit/data/fail.html\n -rw-r--r-- 0 root (0) root (0) 5517 2024-04-26 05:46:21.000000 ./usr/lib/python3/dist-packages/cockpit/internal_endpoints.py\n -rw-r--r-- 0 root (0) root (0) 7242 2024-04-26 05:46:21.000000 ./usr/lib/python3/dist-packages/cockpit/jsonutil.py\n -rw-r--r-- 0 root (0) root (0) 21539 2024-04-26 05:46:21.000000 ./usr/lib/python3/dist-packages/cockpit/packages.py\n -rw-r--r-- 0 root (0) root (0) 12729 2024-04-26 05:46:21.000000 ./usr/lib/python3/dist-packages/cockpit/peer.py\n -rw-r--r-- 0 root (0) root (0) 7580 2024-04-26 05:46:21.000000 ./usr/lib/python3/dist-packages/cockpit/polkit.py\n -rw-r--r-- 0 root (0) root (0) 2031 2024-04-26 05:46:21.000000 ./usr/lib/python3/dist-packages/cockpit/polyfills.py\n"}, {"source1": "./usr/lib/python3/dist-packages/cockpit/data/cockpit-bridge.beipack.xz", "source2": "./usr/lib/python3/dist-packages/cockpit/data/cockpit-bridge.beipack.xz", "unified_diff": null, "details": [{"source1": "cockpit-bridge.beipack", "source2": "cockpit-bridge.beipack", "comments": ["Ordering differences only"], "unified_diff": "@@ -64,15 +64,15 @@\n ) -> Optional[importlib.machinery.ModuleSpec]:\n if fullname not in self.modules:\n return None\n return importlib.util.spec_from_loader(fullname, self)\n \n import sys\n sys.meta_path.insert(0, BeipackLoader({\n- 'cockpit/samples.py': br'''# This file is part of Cockpit.\n+ 'cockpit/remote.py': r'''# This file is part of Cockpit.\n #\n # Copyright (C) 2022 Red Hat, Inc.\n #\n # This program is free software: you can redistribute it and/or modify\n # it under the terms of the GNU General Public License as published by\n # the Free Software Foundation, either version 3 of the License, or\n # (at your option) any later version.\n@@ -81,436 +81,989 @@\n # but WITHOUT ANY WARRANTY; without even the implied warranty of\n # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n # GNU General Public License for more details.\n #\n # You should have received a copy of the GNU General Public License\n # along with this program. If not, see .\n \n-import errno\n+import getpass\n import logging\n-import os\n import re\n-from typing import Any, DefaultDict, Iterable, List, NamedTuple, Optional, Tuple\n-\n-from cockpit._vendor.systemd_ctypes import Handle\n+import socket\n+from typing import Dict, List, Optional, Tuple\n \n-USER_HZ = os.sysconf(os.sysconf_names['SC_CLK_TCK'])\n-MS_PER_JIFFY = 1000 / (USER_HZ if (USER_HZ > 0) else 100)\n-HWMON_PATH = '/sys/class/hwmon'\n+from cockpit._vendor import ferny\n \n-# we would like to do this, but mypy complains; https://github.com/python/mypy/issues/2900\n-# Samples = collections.defaultdict[str, Union[float, Dict[str, Union[float, None]]]]\n-Samples = DefaultDict[str, Any]\n+from .jsonutil import JsonObject, JsonValue, get_str, get_str_or_none\n+from .peer import Peer, PeerError\n+from .router import Router, RoutingRule\n \n logger = logging.getLogger(__name__)\n \n \n-def read_int_file(rootfd: int, statfile: str, default: Optional[int] = None, key: bytes = b'') -> Optional[int]:\n- # Not every stat is available, such as cpu.weight\n- try:\n- fd = os.open(statfile, os.O_RDONLY, dir_fd=rootfd)\n- except FileNotFoundError:\n- return None\n+class PasswordResponder(ferny.AskpassHandler):\n+ PASSPHRASE_RE = re.compile(r\"Enter passphrase for key '(.*)': \")\n \n- try:\n- data = os.read(fd, 1024)\n- except OSError as e:\n- # cgroups can disappear between the open and read\n- if e.errno != errno.ENODEV:\n- logger.warning('Failed to read %s: %s', statfile, e)\n- return None\n- finally:\n- os.close(fd)\n+ password: Optional[str]\n \n- if key:\n- start = data.index(key) + len(key)\n- end = data.index(b'\\n', start)\n- data = data[start:end]\n+ hostkeys_seen: List[Tuple[str, str, str, str, str]]\n+ error_message: Optional[str]\n+ password_attempts: int\n \n- try:\n- # 0 often means \"none\", so replace it with default value\n- return int(data) or default\n- except ValueError:\n- # Some samples such as \"memory.max\" contains \"max\" when there is a no limit\n- return None\n+ def __init__(self, password: Optional[str]):\n+ self.password = password\n \n+ self.hostkeys_seen = []\n+ self.error_message = None\n+ self.password_attempts = 0\n \n-class SampleDescription(NamedTuple):\n- name: str\n- units: str\n- semantics: str\n- instanced: bool\n+ async def do_hostkey(self, reason: str, host: str, algorithm: str, key: str, fingerprint: str) -> bool:\n+ self.hostkeys_seen.append((reason, host, algorithm, key, fingerprint))\n+ return False\n \n+ async def do_askpass(self, messages: str, prompt: str, hint: str) -> Optional[str]:\n+ logger.debug('Got askpass(%s): %s', hint, prompt)\n \n-class Sampler:\n- descriptions: List[SampleDescription]\n+ match = PasswordResponder.PASSPHRASE_RE.fullmatch(prompt)\n+ if match is not None:\n+ # We never unlock private keys \u2014 we rather need to throw a\n+ # specially-formatted error message which will cause the frontend\n+ # to load the named key into the agent for us and try again.\n+ path = match.group(1)\n+ logger.debug(\"This is a passphrase request for %s, but we don't do those. Abort.\", path)\n+ self.error_message = f'locked identity: {path}'\n+ return None\n \n- def sample(self, samples: Samples) -> None:\n- raise NotImplementedError\n+ assert self.password is not None\n+ assert self.password_attempts == 0\n+ self.password_attempts += 1\n+ return self.password\n \n \n-class CPUSampler(Sampler):\n- descriptions = [\n- SampleDescription('cpu.basic.nice', 'millisec', 'counter', instanced=False),\n- SampleDescription('cpu.basic.user', 'millisec', 'counter', instanced=False),\n- SampleDescription('cpu.basic.system', 'millisec', 'counter', instanced=False),\n- SampleDescription('cpu.basic.iowait', 'millisec', 'counter', instanced=False),\n+class SshPeer(Peer):\n+ session: Optional[ferny.Session] = None\n+ host: str\n+ user: Optional[str]\n+ password: Optional[str]\n+ private: bool\n \n- SampleDescription('cpu.core.nice', 'millisec', 'counter', instanced=True),\n- SampleDescription('cpu.core.user', 'millisec', 'counter', instanced=True),\n- SampleDescription('cpu.core.system', 'millisec', 'counter', instanced=True),\n- SampleDescription('cpu.core.iowait', 'millisec', 'counter', instanced=True),\n- ]\n+ async def do_connect_transport(self) -> None:\n+ assert self.session is not None\n+ logger.debug('Starting ssh session user=%s, host=%s, private=%s', self.user, self.host, self.private)\n \n- def sample(self, samples: Samples) -> None:\n- with open('/proc/stat') as stat:\n- for line in stat:\n- if not line.startswith('cpu'):\n- continue\n- cpu, user, nice, system, _idle, iowait = line.split()[:6]\n- core = cpu[3:] or None\n- if core:\n- prefix = 'cpu.core'\n- samples[f'{prefix}.nice'][core] = int(nice) * MS_PER_JIFFY\n- samples[f'{prefix}.user'][core] = int(user) * MS_PER_JIFFY\n- samples[f'{prefix}.system'][core] = int(system) * MS_PER_JIFFY\n- samples[f'{prefix}.iowait'][core] = int(iowait) * MS_PER_JIFFY\n+ basename, colon, portstr = self.host.rpartition(':')\n+ if colon and portstr.isdigit():\n+ host = basename\n+ port = int(portstr)\n+ else:\n+ host = self.host\n+ port = None\n+\n+ responder = PasswordResponder(self.password)\n+ options = {\"StrictHostKeyChecking\": 'yes'}\n+\n+ if self.password is not None:\n+ options.update(NumberOfPasswordPrompts='1')\n+ else:\n+ options.update(PasswordAuthentication=\"no\", KbdInteractiveAuthentication=\"no\")\n+\n+ try:\n+ await self.session.connect(host, login_name=self.user, port=port,\n+ handle_host_key=self.private, options=options,\n+ interaction_responder=responder)\n+ except (OSError, socket.gaierror) as exc:\n+ logger.debug('connecting to host %s failed: %s', host, exc)\n+ raise PeerError('no-host', error='no-host', message=str(exc)) from exc\n+\n+ except ferny.SshHostKeyError as exc:\n+ if responder.hostkeys_seen:\n+ # If we saw a hostkey then we can issue a detailed error message\n+ # containing the key that would need to be accepted. That will\n+ # cause the front-end to present a dialog.\n+ _reason, host, algorithm, key, fingerprint = responder.hostkeys_seen[0]\n+ error_args = {'host-key': f'{host} {algorithm} {key}', 'host-fingerprint': fingerprint}\n+ else:\n+ error_args = {}\n+\n+ if isinstance(exc, ferny.SshChangedHostKeyError):\n+ error = 'invalid-hostkey'\n+ elif self.private:\n+ error = 'unknown-hostkey'\n+ else:\n+ # non-private session case. throw a generic error.\n+ error = 'unknown-host'\n+\n+ logger.debug('SshPeer got a %s %s; private %s, seen hostkeys %r; raising %s with extra args %r',\n+ type(exc), exc, self.private, responder.hostkeys_seen, error, error_args)\n+ raise PeerError(error, error_args, error=error, auth_method_results={}) from exc\n+\n+ except ferny.SshAuthenticationError as exc:\n+ logger.debug('authentication to host %s failed: %s', host, exc)\n+\n+ results = dict.fromkeys(exc.methods, \"not-provided\")\n+ if 'password' in results and self.password is not None:\n+ if responder.password_attempts == 0:\n+ results['password'] = 'not-tried'\n else:\n- prefix = 'cpu.basic'\n- samples[f'{prefix}.nice'] = int(nice) * MS_PER_JIFFY\n- samples[f'{prefix}.user'] = int(user) * MS_PER_JIFFY\n- samples[f'{prefix}.system'] = int(system) * MS_PER_JIFFY\n- samples[f'{prefix}.iowait'] = int(iowait) * MS_PER_JIFFY\n+ results['password'] = 'denied'\n \n+ raise PeerError('authentication-failed',\n+ error=responder.error_message or 'authentication-failed',\n+ auth_method_results=results) from exc\n \n-class MemorySampler(Sampler):\n- descriptions = [\n- SampleDescription('memory.free', 'bytes', 'instant', instanced=False),\n- SampleDescription('memory.used', 'bytes', 'instant', instanced=False),\n- SampleDescription('memory.cached', 'bytes', 'instant', instanced=False),\n- SampleDescription('memory.swap-used', 'bytes', 'instant', instanced=False),\n- ]\n+ except ferny.SshError as exc:\n+ logger.debug('unknown failure connecting to host %s: %s', host, exc)\n+ raise PeerError('internal-error', message=str(exc)) from exc\n \n- def sample(self, samples: Samples) -> None:\n- with open('/proc/meminfo') as meminfo:\n- items = {k: int(v.strip(' kB\\n')) for line in meminfo for k, v in [line.split(':', 1)]}\n+ args = self.session.wrap_subprocess_args(['cockpit-bridge'])\n+ await self.spawn(args, [])\n \n- samples['memory.free'] = 1024 * items['MemFree']\n- samples['memory.used'] = 1024 * (items['MemTotal'] - items['MemAvailable'])\n- samples['memory.cached'] = 1024 * (items['Buffers'] + items['Cached'])\n- samples['memory.swap-used'] = 1024 * (items['SwapTotal'] - items['SwapFree'])\n+ def do_kill(self, host: 'str | None', group: 'str | None', message: JsonObject) -> None:\n+ if host == self.host:\n+ self.close()\n+ elif host is None:\n+ super().do_kill(host, group, message)\n \n+ def do_authorize(self, message: JsonObject) -> None:\n+ if get_str(message, 'challenge').startswith('plain1:'):\n+ cookie = get_str(message, 'cookie')\n+ self.write_control(command='authorize', cookie=cookie, response=self.password or '')\n+ self.password = None # once is enough...\n \n-class CPUTemperatureSampler(Sampler):\n- # Cache found sensors, as they can't be hotplugged.\n- sensors: Optional[List[str]] = None\n+ def do_superuser_init_done(self) -> None:\n+ self.password = None\n \n- descriptions = [\n- SampleDescription('cpu.temperature', 'celsius', 'instant', instanced=True),\n- ]\n+ def __init__(self, router: Router, host: str, user: Optional[str], options: JsonObject, *, private: bool) -> None:\n+ super().__init__(router)\n+ self.host = host\n+ self.user = user\n+ self.password = get_str(options, 'password', None)\n+ self.private = private\n \n- @staticmethod\n- def detect_cpu_sensors(dir_fd: int) -> Iterable[str]:\n- # Read the name file to decide what to do with this directory\n- try:\n- with Handle.open('name', os.O_RDONLY, dir_fd=dir_fd) as fd:\n- name = os.read(fd, 1024).decode().strip()\n- except FileNotFoundError:\n- return\n+ self.session = ferny.Session()\n \n- if name == 'atk0110':\n- # only sample 'CPU Temperature' in atk0110\n- predicate = (lambda label: label == 'CPU Temperature')\n- elif name == 'cpu_thermal':\n- # labels are not used on ARM\n- predicate = None\n- elif name == 'coretemp':\n- # accept all labels on Intel\n- predicate = None\n- elif name in ['k8temp', 'k10temp']:\n- predicate = None\n+ superuser: JsonValue\n+ init_superuser = get_str_or_none(options, 'init-superuser', None)\n+ if init_superuser in (None, 'none'):\n+ superuser = False\n else:\n- # Not a CPU sensor\n+ superuser = {'id': init_superuser}\n+\n+ self.start_in_background(init_host=host, superuser=superuser)\n+\n+\n+class HostRoutingRule(RoutingRule):\n+ remotes: Dict[Tuple[str, Optional[str], Optional[str]], Peer]\n+\n+ def __init__(self, router):\n+ super().__init__(router)\n+ self.remotes = {}\n+\n+ def apply_rule(self, options: JsonObject) -> Optional[Peer]:\n+ assert self.router is not None\n+ assert self.router.init_host is not None\n+\n+ host = get_str(options, 'host', self.router.init_host)\n+ if host == self.router.init_host:\n+ return None\n+\n+ user = get_str(options, 'user', None)\n+ # HACK: the front-end relies on this for tracking connections without an explicit user name;\n+ # the user will then be determined by SSH (`User` in the config or the current user)\n+ # See cockpit_router_normalize_host_params() in src/bridge/cockpitrouter.c\n+ if user == getpass.getuser():\n+ user = None\n+ if not user:\n+ user_from_host, _, _ = host.rpartition('@')\n+ user = user_from_host or None # avoid ''\n+\n+ if get_str(options, 'session', None) == 'private':\n+ nonce = get_str(options, 'channel')\n+ else:\n+ nonce = None\n+\n+ assert isinstance(host, str)\n+ assert user is None or isinstance(user, str)\n+ assert nonce is None or isinstance(nonce, str)\n+\n+ key = host, user, nonce\n+\n+ logger.debug('Request for channel %s is remote.', options)\n+ logger.debug('key=%s', key)\n+\n+ if key not in self.remotes:\n+ logger.debug('%s is not among the existing remotes %s. Opening a new connection.', key, self.remotes)\n+ peer = SshPeer(self.router, host, user, options, private=nonce is not None)\n+ peer.add_done_callback(lambda: self.remotes.__delitem__(key))\n+ self.remotes[key] = peer\n+\n+ return self.remotes[key]\n+\n+ def shutdown(self):\n+ for peer in set(self.remotes.values()):\n+ peer.close()\n+'''.encode('utf-8'),\n+ 'cockpit/internal_endpoints.py': br'''# This file is part of Cockpit.\n+#\n+# Copyright (C) 2022 Red Hat, Inc.\n+#\n+# This program is free software: you can redistribute it and/or modify\n+# it under the terms of the GNU General Public License as published by\n+# the Free Software Foundation, either version 3 of the License, or\n+# (at your option) any later version.\n+#\n+# This program is distributed in the hope that it will be useful,\n+# but WITHOUT ANY WARRANTY; without even the implied warranty of\n+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n+# GNU General Public License for more details.\n+#\n+# You should have received a copy of the GNU General Public License\n+# along with this program. If not, see .\n+\n+import asyncio\n+import glob\n+import grp\n+import json\n+import logging\n+import os\n+import pwd\n+from pathlib import Path\n+from typing import Dict, Optional\n+\n+from cockpit._vendor.systemd_ctypes import Variant, bus, inotify, pathwatch\n+\n+from . import config\n+\n+logger = logging.getLogger(__name__)\n+\n+\n+class cockpit_LoginMessages(bus.Object):\n+ messages: Optional[str] = None\n+\n+ def __init__(self):\n+ fdstr = os.environ.pop('COCKPIT_LOGIN_MESSAGES_MEMFD', None)\n+ if fdstr is None:\n+ logger.debug(\"COCKPIT_LOGIN_MESSAGES_MEMFD wasn't set. No login messages today.\")\n return\n \n- # Now scan the directory for inputs\n- for input_filename in os.listdir(dir_fd):\n- if not input_filename.endswith('_input'):\n- continue\n+ logger.debug(\"Trying to read login messages from fd %s\", fdstr)\n+ try:\n+ with open(int(fdstr), 'r') as login_messages:\n+ login_messages.seek(0)\n+ self.messages = login_messages.read()\n+ except (ValueError, OSError, UnicodeDecodeError) as exc:\n+ # ValueError - the envvar wasn't an int\n+ # OSError - the fd wasn't open, or other read failure\n+ # UnicodeDecodeError - didn't contain utf-8\n+ # For all of these, we simply failed to get the message.\n+ logger.debug(\"Reading login messages failed: %s\", exc)\n+ else:\n+ logger.debug(\"Successfully read login messages: %s\", self.messages)\n \n- if predicate:\n- # We need to check the label\n- try:\n- label_filename = input_filename.replace('_input', '_label')\n- with Handle.open(label_filename, os.O_RDONLY, dir_fd=dir_fd) as fd:\n- label = os.read(fd, 1024).decode().strip()\n- except FileNotFoundError:\n- continue\n+ @bus.Interface.Method(out_types=['s'])\n+ def get(self):\n+ return self.messages or '{}'\n \n- if not predicate(label):\n+ @bus.Interface.Method(out_types=[])\n+ def dismiss(self):\n+ self.messages = None\n+\n+\n+class cockpit_Machines(bus.Object):\n+ path: Path\n+ watch: pathwatch.PathWatch\n+ pending_notify: Optional[asyncio.Handle]\n+\n+ # D-Bus implementation\n+ machines = bus.Interface.Property('a{sa{sv}}')\n+\n+ @machines.getter\n+ def get_machines(self) -> Dict[str, Dict[str, Variant]]:\n+ results: Dict[str, Dict[str, Variant]] = {}\n+\n+ for filename in glob.glob(f'{self.path}/*.json'):\n+ with open(filename) as fp:\n+ try:\n+ contents = json.load(fp)\n+ except json.JSONDecodeError:\n+ logger.warning('Invalid JSON in file %s. Ignoring.', filename)\n continue\n+ # merge\n+ for hostname, attrs in contents.items():\n+ results[hostname] = {key: Variant(value) for key, value in attrs.items()}\n \n- yield input_filename\n+ return results\n \n- @staticmethod\n- def scan_sensors() -> Iterable[str]:\n+ @bus.Interface.Method(in_types=['s', 's', 'a{sv}'])\n+ def update(self, filename: str, hostname: str, attrs: Dict[str, Variant]) -> None:\n try:\n- top_fd = Handle.open(HWMON_PATH, os.O_RDONLY | os.O_DIRECTORY)\n+ with self.path.joinpath(filename).open() as fp:\n+ contents = json.load(fp)\n+ except json.JSONDecodeError as exc:\n+ # Refuse to replace corrupted file\n+ raise bus.BusError('cockpit.Machines.Error', f'File {filename} is in invalid format: {exc}.') from exc\n except FileNotFoundError:\n+ # But an empty file is an expected case\n+ contents = {}\n+\n+ contents.setdefault(hostname, {}).update({key: value.value for key, value in attrs.items()})\n+\n+ self.path.mkdir(parents=True, exist_ok=True)\n+ with open(self.path.joinpath(filename), 'w') as fp:\n+ json.dump(contents, fp, indent=2)\n+\n+ def notify(self):\n+ def _notify_now():\n+ self.properties_changed('cockpit.Machines', {}, ['Machines'])\n+ self.pending_notify = None\n+\n+ # avoid a flurry of update notifications\n+ if self.pending_notify is None:\n+ self.pending_notify = asyncio.get_running_loop().call_later(1.0, _notify_now)\n+\n+ # inotify events\n+ def do_inotify_event(self, mask: inotify.Event, cookie: int, name: Optional[str]) -> None:\n+ self.notify()\n+\n+ def do_identity_changed(self, fd: Optional[int], errno: Optional[int]) -> None:\n+ self.notify()\n+\n+ def __init__(self):\n+ self.path = config.lookup_config('machines.d')\n+\n+ # ignore the first callback\n+ self.pending_notify = ...\n+ self.watch = pathwatch.PathWatch(str(self.path), self)\n+ self.pending_notify = None\n+\n+\n+class cockpit_User(bus.Object):\n+ name = bus.Interface.Property('s', value='')\n+ full = bus.Interface.Property('s', value='')\n+ id = bus.Interface.Property('i', value=0)\n+ home = bus.Interface.Property('s', value='')\n+ shell = bus.Interface.Property('s', value='')\n+ groups = bus.Interface.Property('as', value=[])\n+\n+ def __init__(self):\n+ user = pwd.getpwuid(os.getuid())\n+ self.name = user.pw_name\n+ self.full = user.pw_gecos\n+ self.id = user.pw_uid\n+ self.home = user.pw_dir\n+ self.shell = user.pw_shell\n+ self.groups = [gr.gr_name for gr in grp.getgrall() if user.pw_name in gr.gr_mem]\n+\n+\n+EXPORTS = [\n+ ('/LoginMessages', cockpit_LoginMessages),\n+ ('/machines', cockpit_Machines),\n+ ('/user', cockpit_User),\n+]\n+''',\n+ 'cockpit/router.py': br'''# This file is part of Cockpit.\n+#\n+# Copyright (C) 2022 Red Hat, Inc.\n+#\n+# This program is free software: you can redistribute it and/or modify\n+# it under the terms of the GNU General Public License as published by\n+# the Free Software Foundation, either version 3 of the License, or\n+# (at your option) any later version.\n+#\n+# This program is distributed in the hope that it will be useful,\n+# but WITHOUT ANY WARRANTY; without even the implied warranty of\n+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n+# GNU General Public License for more details.\n+#\n+# You should have received a copy of the GNU General Public License\n+# along with this program. If not, see .\n+\n+import asyncio\n+import collections\n+import logging\n+from typing import Dict, List, Optional\n+\n+from .jsonutil import JsonObject, JsonValue\n+from .protocol import CockpitProblem, CockpitProtocolError, CockpitProtocolServer\n+\n+logger = logging.getLogger(__name__)\n+\n+\n+class ExecutionQueue:\n+ \"\"\"Temporarily delay calls to a given set of class methods.\n+\n+ Functions by replacing the named function at the instance __dict__\n+ level, effectively providing an override for exactly one instance\n+ of `method`'s object.\n+ Queues the invocations. Run them later with .run(), which also reverses\n+ the redirection by deleting the named methods from the instance.\n+ \"\"\"\n+ def __init__(self, methods):\n+ self.queue = collections.deque()\n+ self.methods = methods\n+\n+ for method in self.methods:\n+ self._wrap(method)\n+\n+ def _wrap(self, method):\n+ # NB: this function is stored in the instance dict and therefore\n+ # doesn't function as a descriptor, isn't a method, doesn't get bound,\n+ # and therefore doesn't receive a self parameter\n+ setattr(method.__self__, method.__func__.__name__, lambda *args: self.queue.append((method, args)))\n+\n+ def run(self):\n+ logger.debug('ExecutionQueue: Running %d queued method calls', len(self.queue))\n+ for method, args in self.queue:\n+ method(*args)\n+\n+ for method in self.methods:\n+ delattr(method.__self__, method.__func__.__name__)\n+\n+\n+class Endpoint:\n+ router: 'Router'\n+ __endpoint_frozen_queue: Optional[ExecutionQueue] = None\n+\n+ def __init__(self, router: 'Router'):\n+ router.add_endpoint(self)\n+ self.router = router\n+\n+ def freeze_endpoint(self):\n+ assert self.__endpoint_frozen_queue is None\n+ logger.debug('Freezing endpoint %s', self)\n+ self.__endpoint_frozen_queue = ExecutionQueue({self.do_channel_control, self.do_channel_data, self.do_kill})\n+\n+ def thaw_endpoint(self):\n+ assert self.__endpoint_frozen_queue is not None\n+ logger.debug('Thawing endpoint %s', self)\n+ self.__endpoint_frozen_queue.run()\n+ self.__endpoint_frozen_queue = None\n+\n+ # interface for receiving messages\n+ def do_close(self):\n+ raise NotImplementedError\n+\n+ def do_channel_control(self, channel: str, command: str, message: JsonObject) -> None:\n+ raise NotImplementedError\n+\n+ def do_channel_data(self, channel: str, data: bytes) -> None:\n+ raise NotImplementedError\n+\n+ def do_kill(self, host: 'str | None', group: 'str | None', message: JsonObject) -> None:\n+ raise NotImplementedError\n+\n+ # interface for sending messages\n+ def send_channel_data(self, channel: str, data: bytes) -> None:\n+ self.router.write_channel_data(channel, data)\n+\n+ def send_channel_control(\n+ self, channel: str, command: str, _msg: 'JsonObject | None', **kwargs: JsonValue\n+ ) -> None:\n+ self.router.write_control(_msg, channel=channel, command=command, **kwargs)\n+ if command == 'close':\n+ self.router.endpoints[self].remove(channel)\n+ self.router.drop_channel(channel)\n+\n+ def shutdown_endpoint(self, _msg: 'JsonObject | None' = None, **kwargs: JsonValue) -> None:\n+ self.router.shutdown_endpoint(self, _msg, **kwargs)\n+\n+\n+class RoutingError(CockpitProblem):\n+ pass\n+\n+\n+class RoutingRule:\n+ router: 'Router'\n+\n+ def __init__(self, router: 'Router'):\n+ self.router = router\n+\n+ def apply_rule(self, options: JsonObject) -> Optional[Endpoint]:\n+ \"\"\"Check if a routing rule applies to a given 'open' message.\n+\n+ This should inspect the options dictionary and do one of the following three things:\n+\n+ - return an Endpoint to handle this channel\n+ - raise a RoutingError to indicate that the open should be rejected\n+ - return None to let the next rule run\n+ \"\"\"\n+ raise NotImplementedError\n+\n+ def shutdown(self):\n+ raise NotImplementedError\n+\n+\n+class Router(CockpitProtocolServer):\n+ routing_rules: List[RoutingRule]\n+ open_channels: Dict[str, Endpoint]\n+ endpoints: 'dict[Endpoint, set[str]]'\n+ no_endpoints: asyncio.Event # set if endpoints dict is empty\n+ _eof: bool = False\n+\n+ def __init__(self, routing_rules: List[RoutingRule]):\n+ for rule in routing_rules:\n+ rule.router = self\n+ self.routing_rules = routing_rules\n+ self.open_channels = {}\n+ self.endpoints = {}\n+ self.no_endpoints = asyncio.Event()\n+ self.no_endpoints.set() # at first there are no endpoints\n+\n+ def check_rules(self, options: JsonObject) -> Endpoint:\n+ for rule in self.routing_rules:\n+ logger.debug(' applying rule %s', rule)\n+ endpoint = rule.apply_rule(options)\n+ if endpoint is not None:\n+ logger.debug(' resulting endpoint is %s', endpoint)\n+ return endpoint\n+ else:\n+ logger.debug(' No rules matched')\n+ raise RoutingError('not-supported')\n+\n+ def drop_channel(self, channel: str) -> None:\n+ try:\n+ self.open_channels.pop(channel)\n+ logger.debug('router dropped channel %s', channel)\n+ except KeyError:\n+ logger.error('trying to drop non-existent channel %s from %s', channel, self.open_channels)\n+\n+ def add_endpoint(self, endpoint: Endpoint) -> None:\n+ self.endpoints[endpoint] = set()\n+ self.no_endpoints.clear()\n+\n+ def shutdown_endpoint(self, endpoint: Endpoint, _msg: 'JsonObject | None' = None, **kwargs: JsonValue) -> None:\n+ channels = self.endpoints.pop(endpoint)\n+ logger.debug('shutdown_endpoint(%s, %s) will close %s', endpoint, kwargs, channels)\n+ for channel in channels:\n+ self.write_control(_msg, command='close', channel=channel, **kwargs)\n+ self.drop_channel(channel)\n+\n+ if not self.endpoints:\n+ self.no_endpoints.set()\n+\n+ # were we waiting to exit?\n+ if self._eof:\n+ logger.debug(' endpoints remaining: %r', self.endpoints)\n+ if not self.endpoints and self.transport:\n+ logger.debug(' close transport')\n+ self.transport.close()\n+\n+ def do_kill(self, host: 'str | None', group: 'str | None', message: JsonObject) -> None:\n+ endpoints = set(self.endpoints)\n+ logger.debug('do_kill(%s, %s). Considering %d endpoints.', host, group, len(endpoints))\n+ for endpoint in endpoints:\n+ endpoint.do_kill(host, group, message)\n+\n+ def channel_control_received(self, channel: str, command: str, message: JsonObject) -> None:\n+ # If this is an open message then we need to apply the routing rules to\n+ # figure out the correct endpoint to connect. If it's not an open\n+ # message, then we expect the endpoint to already exist.\n+ if command == 'open':\n+ if channel in self.open_channels:\n+ raise CockpitProtocolError('channel is already open')\n+\n+ try:\n+ logger.debug('Trying to find endpoint for new channel %s payload=%s', channel, message.get('payload'))\n+ endpoint = self.check_rules(message)\n+ except RoutingError as exc:\n+ self.write_control(exc.get_attrs(), command='close', channel=channel)\n+ return\n+\n+ self.open_channels[channel] = endpoint\n+ self.endpoints[endpoint].add(channel)\n+ else:\n+ try:\n+ endpoint = self.open_channels[channel]\n+ except KeyError:\n+ # sending to a non-existent channel can happen due to races and is not an error\n+ return\n+\n+ # At this point, we have the endpoint. Route the message.\n+ endpoint.do_channel_control(channel, command, message)\n+\n+ def channel_data_received(self, channel: str, data: bytes) -> None:\n+ try:\n+ endpoint = self.open_channels[channel]\n+ except KeyError:\n return\n \n- with top_fd:\n- for hwmon_name in os.listdir(top_fd):\n- with Handle.open(hwmon_name, os.O_RDONLY | os.O_DIRECTORY, dir_fd=top_fd) as subdir_fd:\n- for sensor in CPUTemperatureSampler.detect_cpu_sensors(subdir_fd):\n- yield f'{HWMON_PATH}/{hwmon_name}/{sensor}'\n+ endpoint.do_channel_data(channel, data)\n \n- def sample(self, samples: Samples) -> None:\n- if self.sensors is None:\n- self.sensors = list(CPUTemperatureSampler.scan_sensors())\n+ def eof_received(self) -> bool:\n+ logger.debug('eof_received(%r)', self)\n \n- for sensor_path in self.sensors:\n- with open(sensor_path) as sensor:\n- temperature = int(sensor.read().strip())\n- if temperature == 0:\n- return\n+ endpoints = set(self.endpoints)\n+ for endpoint in endpoints:\n+ endpoint.do_close()\n \n- samples['cpu.temperature'][sensor_path] = temperature / 1000\n+ self._eof = True\n+ logger.debug(' endpoints remaining: %r', self.endpoints)\n+ return bool(self.endpoints)\n \n+ _communication_done: Optional[asyncio.Future] = None\n \n-class DiskSampler(Sampler):\n- descriptions = [\n- SampleDescription('disk.all.read', 'bytes', 'counter', instanced=False),\n- SampleDescription('disk.all.written', 'bytes', 'counter', instanced=False),\n- SampleDescription('disk.dev.read', 'bytes', 'counter', instanced=True),\n- SampleDescription('disk.dev.written', 'bytes', 'counter', instanced=True),\n- ]\n+ def do_closed(self, exc: Optional[Exception]) -> None:\n+ # If we didn't send EOF yet, do it now.\n+ if not self._eof:\n+ self.eof_received()\n \n- def sample(self, samples: Samples) -> None:\n- with open('/proc/diskstats') as diskstats:\n- all_read_bytes = 0\n- all_written_bytes = 0\n+ if self._communication_done is not None:\n+ if exc is None:\n+ self._communication_done.set_result(None)\n+ else:\n+ self._communication_done.set_exception(exc)\n \n- for line in diskstats:\n- # https://www.kernel.org/doc/Documentation/ABI/testing/procfs-diskstats\n- fields = line.strip().split()\n- dev_major = fields[0]\n- dev_name = fields[2]\n- num_sectors_read = fields[5]\n- num_sectors_written = fields[9]\n+ async def communicate(self) -> None:\n+ \"\"\"Wait until communication is complete on the router and all endpoints are done.\"\"\"\n+ assert self._communication_done is None\n+ self._communication_done = asyncio.get_running_loop().create_future()\n+ try:\n+ await self._communication_done\n+ except (BrokenPipeError, ConnectionResetError):\n+ pass # these are normal occurrences when closed from the other side\n+ finally:\n+ self._communication_done = None\n \n- # ignore mdraid\n- if dev_major == '9':\n- continue\n+ # In an orderly exit, this is already done, but in case it wasn't\n+ # orderly, we need to make sure the endpoints shut down anyway...\n+ await self.no_endpoints.wait()\n+''',\n+ 'cockpit/_version.py': br'''__version__ = '316'\n+''',\n+ 'cockpit/peer.py': r'''# This file is part of Cockpit.\n+#\n+# Copyright (C) 2022 Red Hat, Inc.\n+#\n+# This program is free software: you can redistribute it and/or modify\n+# it under the terms of the GNU General Public License as published by\n+# the Free Software Foundation, either version 3 of the License, or\n+# (at your option) any later version.\n+#\n+# This program is distributed in the hope that it will be useful,\n+# but WITHOUT ANY WARRANTY; without even the implied warranty of\n+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n+# GNU General Public License for more details.\n+#\n+# You should have received a copy of the GNU General Public License\n+# along with this program. If not, see .\n \n- # ignore device-mapper\n- if dev_name.startswith('dm-'):\n- continue\n+import asyncio\n+import logging\n+import os\n+from typing import Callable, List, Optional, Sequence\n \n- # Skip partitions\n- if dev_name[:2] in ['sd', 'hd', 'vd'] and dev_name[-1].isdigit():\n- continue\n+from .jsonutil import JsonObject, JsonValue\n+from .packages import BridgeConfig\n+from .protocol import CockpitProblem, CockpitProtocol, CockpitProtocolError\n+from .router import Endpoint, Router, RoutingRule\n+from .transports import SubprocessProtocol, SubprocessTransport\n \n- # Ignore nvme partitions\n- if dev_name.startswith('nvme') and 'p' in dev_name:\n- continue\n+logger = logging.getLogger(__name__)\n \n- read_bytes = int(num_sectors_read) * 512\n- written_bytes = int(num_sectors_written) * 512\n \n- all_read_bytes += read_bytes\n- all_written_bytes += written_bytes\n+class PeerError(CockpitProblem):\n+ pass\n \n- samples['disk.dev.read'][dev_name] = read_bytes\n- samples['disk.dev.written'][dev_name] = written_bytes\n \n- samples['disk.all.read'] = all_read_bytes\n- samples['disk.all.written'] = all_written_bytes\n+class PeerExited(Exception):\n+ def __init__(self, exit_code: int):\n+ self.exit_code = exit_code\n \n \n-class CGroupSampler(Sampler):\n- descriptions = [\n- SampleDescription('cgroup.memory.usage', 'bytes', 'instant', instanced=True),\n- SampleDescription('cgroup.memory.limit', 'bytes', 'instant', instanced=True),\n- SampleDescription('cgroup.memory.sw-usage', 'bytes', 'instant', instanced=True),\n- SampleDescription('cgroup.memory.sw-limit', 'bytes', 'instant', instanced=True),\n- SampleDescription('cgroup.cpu.usage', 'millisec', 'counter', instanced=True),\n- SampleDescription('cgroup.cpu.shares', 'count', 'instant', instanced=True),\n- ]\n+class Peer(CockpitProtocol, SubprocessProtocol, Endpoint):\n+ done_callbacks: List[Callable[[], None]]\n+ init_future: Optional[asyncio.Future]\n \n- cgroups_v2: Optional[bool] = None\n+ def __init__(self, router: Router):\n+ super().__init__(router)\n \n- def sample(self, samples: Samples) -> None:\n- if self.cgroups_v2 is None:\n- self.cgroups_v2 = os.path.exists('/sys/fs/cgroup/cgroup.controllers')\n+ # All Peers start out frozen \u2014 we only unfreeze after we see the first 'init' message\n+ self.freeze_endpoint()\n \n- if self.cgroups_v2:\n- cgroups_v2_path = '/sys/fs/cgroup/'\n- for path, _, _, rootfd in os.fwalk(cgroups_v2_path):\n- cgroup = path.replace(cgroups_v2_path, '')\n+ self.init_future = asyncio.get_running_loop().create_future()\n+ self.done_callbacks = []\n \n- if not cgroup:\n- continue\n+ # Initialization\n+ async def do_connect_transport(self) -> None:\n+ raise NotImplementedError\n \n- samples['cgroup.memory.usage'][cgroup] = read_int_file(rootfd, 'memory.current', 0)\n- samples['cgroup.memory.limit'][cgroup] = read_int_file(rootfd, 'memory.max')\n- samples['cgroup.memory.sw-usage'][cgroup] = read_int_file(rootfd, 'memory.swap.current', 0)\n- samples['cgroup.memory.sw-limit'][cgroup] = read_int_file(rootfd, 'memory.swap.max')\n- samples['cgroup.cpu.shares'][cgroup] = read_int_file(rootfd, 'cpu.weight')\n- usage_usec = read_int_file(rootfd, 'cpu.stat', 0, key=b'usage_usec')\n- if usage_usec:\n- samples['cgroup.cpu.usage'][cgroup] = usage_usec / 1000\n+ async def spawn(self, argv: Sequence[str], env: Sequence[str], **kwargs) -> asyncio.Transport:\n+ # Not actually async...\n+ loop = asyncio.get_running_loop()\n+ user_env = dict(e.split('=', 1) for e in env)\n+ return SubprocessTransport(loop, self, argv, env=dict(os.environ, **user_env), **kwargs)\n+\n+ async def start(self, init_host: Optional[str] = None, **kwargs: JsonValue) -> JsonObject:\n+ \"\"\"Request that the Peer is started and connected to the router.\n+\n+ Creates the transport, connects it to the protocol, and participates in\n+ exchanging of init messages. If anything goes wrong, the connection\n+ will be closed and an exception will be raised.\n+\n+ The Peer starts out in a frozen state (ie: attempts to send messages to\n+ it will initially be queued). If init_host is not None then an init\n+ message is sent with the given 'host' field, plus any extra kwargs, and\n+ the queue is thawed. Otherwise, the caller is responsible for sending\n+ the init message and thawing the peer.\n+\n+ In any case, the return value is the init message from the peer.\n+ \"\"\"\n+ assert self.init_future is not None\n+\n+ def _connect_task_done(task: asyncio.Task) -> None:\n+ assert task is connect_task\n+ try:\n+ task.result()\n+ except asyncio.CancelledError: # we did that (below)\n+ pass # we want to ignore it\n+ except Exception as exc:\n+ self.close(exc)\n+\n+ connect_task = asyncio.create_task(self.do_connect_transport())\n+ connect_task.add_done_callback(_connect_task_done)\n+\n+ try:\n+ # Wait for something to happen:\n+ # - exception from our connection function\n+ # - receiving \"init\" from the other side\n+ # - receiving EOF from the other side\n+ # - .close() was called\n+ # - other transport exception\n+ init_message = await self.init_future\n+\n+ except (PeerExited, BrokenPipeError):\n+ # These are fairly generic errors. PeerExited means that we observed the process exiting.\n+ # BrokenPipeError means that we got EPIPE when attempting to write() to it. In both cases,\n+ # the process is gone, but it's not clear why. If the connection process is still running,\n+ # perhaps we'd get a better error message from it.\n+ await connect_task\n+ # Otherwise, re-raise\n+ raise\n+\n+ finally:\n+ self.init_future = None\n+\n+ # In any case (failure or success) make sure this is done.\n+ if not connect_task.done():\n+ connect_task.cancel()\n+\n+ if init_host is not None:\n+ logger.debug(' sending init message back, host %s', init_host)\n+ # Send \"init\" back\n+ self.write_control(None, command='init', version=1, host=init_host, **kwargs)\n+\n+ # Thaw the queued messages\n+ self.thaw_endpoint()\n+\n+ return init_message\n+\n+ # Background initialization\n+ def start_in_background(self, init_host: Optional[str] = None, **kwargs: JsonValue) -> None:\n+ def _start_task_done(task: asyncio.Task) -> None:\n+ assert task is start_task\n+\n+ try:\n+ task.result()\n+ except (OSError, PeerExited, CockpitProblem, asyncio.CancelledError):\n+ pass # Those are expected. Others will throw.\n+\n+ start_task = asyncio.create_task(self.start(init_host, **kwargs))\n+ start_task.add_done_callback(_start_task_done)\n+\n+ # Shutdown\n+ def add_done_callback(self, callback: Callable[[], None]) -> None:\n+ self.done_callbacks.append(callback)\n+\n+ # Handling of interesting events\n+ def do_superuser_init_done(self) -> None:\n+ pass\n+\n+ def do_authorize(self, message: JsonObject) -> None:\n+ pass\n+\n+ def transport_control_received(self, command: str, message: JsonObject) -> None:\n+ if command == 'init' and self.init_future is not None:\n+ logger.debug('Got init message with active init_future. Setting result.')\n+ self.init_future.set_result(message)\n+ elif command == 'authorize':\n+ self.do_authorize(message)\n+ elif command == 'superuser-init-done':\n+ self.do_superuser_init_done()\n else:\n- memory_path = '/sys/fs/cgroup/memory/'\n- for path, _, _, rootfd in os.fwalk(memory_path):\n- cgroup = path.replace(memory_path, '')\n+ raise CockpitProtocolError(f'Received unexpected control message {command}')\n \n- if not cgroup:\n- continue\n+ def eof_received(self) -> bool:\n+ # We always expect to be the ones to close the connection, so if we get\n+ # an EOF, then we consider it to be an error. This allows us to\n+ # distinguish close caused by unexpected EOF (but no errno from a\n+ # syscall failure) vs. close caused by calling .close() on our side.\n+ # The process is still running at this point, so keep it and handle\n+ # the error in process_exited().\n+ logger.debug('Peer %s received unexpected EOF', self.__class__.__name__)\n+ return True\n \n- samples['cgroup.memory.usage'][cgroup] = read_int_file(rootfd, 'memory.usage_in_bytes', 0)\n- samples['cgroup.memory.limit'][cgroup] = read_int_file(rootfd, 'memory.limit_in_bytes')\n- samples['cgroup.memory.sw-usage'][cgroup] = read_int_file(rootfd, 'memory.memsw.usage_in_bytes', 0)\n- samples['cgroup.memory.sw-limit'][cgroup] = read_int_file(rootfd, 'memory.memsw.limit_in_bytes')\n+ def do_closed(self, exc: Optional[Exception]) -> None:\n+ logger.debug('Peer %s connection lost %s %s', self.__class__.__name__, type(exc), exc)\n \n- cpu_path = '/sys/fs/cgroup/cpu/'\n- for path, _, _, rootfd in os.fwalk(cpu_path):\n- cgroup = path.replace(cpu_path, '')\n+ if exc is None:\n+ self.shutdown_endpoint(problem='terminated')\n+ elif isinstance(exc, PeerExited):\n+ # a common case is that the called peer does not exist\n+ if exc.exit_code == 127:\n+ self.shutdown_endpoint(problem='no-cockpit')\n+ else:\n+ self.shutdown_endpoint(problem='terminated', message=f'Peer exited with status {exc.exit_code}')\n+ elif isinstance(exc, CockpitProblem):\n+ self.shutdown_endpoint(exc.attrs)\n+ else:\n+ self.shutdown_endpoint(problem='internal-error',\n+ message=f\"[{exc.__class__.__name__}] {exc!s}\")\n \n- if not cgroup:\n- continue\n+ # If .start() is running, we need to make sure it stops running,\n+ # raising the correct exception.\n+ if self.init_future is not None and not self.init_future.done():\n+ if exc is not None:\n+ self.init_future.set_exception(exc)\n+ else:\n+ self.init_future.cancel()\n \n- samples['cgroup.cpu.shares'][cgroup] = read_int_file(rootfd, 'cpu.shares')\n- usage_nsec = read_int_file(rootfd, 'cpuacct.usage')\n- if usage_nsec:\n- samples['cgroup.cpu.usage'][cgroup] = usage_nsec / 1000000\n+ for callback in self.done_callbacks:\n+ callback()\n \n+ def process_exited(self) -> None:\n+ assert isinstance(self.transport, SubprocessTransport)\n+ logger.debug('Peer %s exited, status %d', self.__class__.__name__, self.transport.get_returncode())\n+ returncode = self.transport.get_returncode()\n+ assert isinstance(returncode, int)\n+ self.close(PeerExited(returncode))\n \n-class CGroupDiskIO(Sampler):\n- IO_RE = re.compile(rb'\\bread_bytes: (?P\\d+).*\\nwrite_bytes: (?P\\d+)', flags=re.S)\n- descriptions = [\n- SampleDescription('disk.cgroup.read', 'bytes', 'counter', instanced=True),\n- SampleDescription('disk.cgroup.written', 'bytes', 'counter', instanced=True),\n- ]\n+ # Forwarding data: from the peer to the router\n+ def channel_control_received(self, channel: str, command: str, message: JsonObject) -> None:\n+ if self.init_future is not None:\n+ raise CockpitProtocolError('Received unexpected channel control message before init')\n+ self.send_channel_control(channel, command, message)\n \n- @staticmethod\n- def get_cgroup_name(fd: int) -> str:\n- with Handle.open('cgroup', os.O_RDONLY, dir_fd=fd) as cgroup_fd:\n- cgroup_name = os.read(cgroup_fd, 2048).decode().strip()\n+ def channel_data_received(self, channel: str, data: bytes) -> None:\n+ if self.init_future is not None:\n+ raise CockpitProtocolError('Received unexpected channel data before init')\n+ self.send_channel_data(channel, data)\n \n- # Skip leading ::0/\n- return cgroup_name[4:]\n+ # Forwarding data: from the router to the peer\n+ def do_channel_control(self, channel: str, command: str, message: JsonObject) -> None:\n+ assert self.init_future is None\n+ self.write_control(message)\n \n- @staticmethod\n- def get_proc_io(fd: int) -> Tuple[int, int]:\n- with Handle.open('io', os.O_RDONLY, dir_fd=fd) as io_fd:\n- data = os.read(io_fd, 4096)\n+ def do_channel_data(self, channel: str, data: bytes) -> None:\n+ assert self.init_future is None\n+ self.write_channel_data(channel, data)\n \n- match = re.search(CGroupDiskIO.IO_RE, data)\n- if match:\n- proc_read = int(match.group('read'))\n- proc_write = int(match.group('write'))\n+ def do_kill(self, host: 'str | None', group: 'str | None', message: JsonObject) -> None:\n+ assert self.init_future is None\n+ self.write_control(message)\n \n- return proc_read, proc_write\n+ def do_close(self) -> None:\n+ self.close()\n \n- return 0, 0\n \n- def sample(self, samples: Samples):\n- with Handle.open('/proc', os.O_RDONLY | os.O_DIRECTORY) as proc_fd:\n- reads = samples['disk.cgroup.read']\n- writes = samples['disk.cgroup.written']\n+class ConfiguredPeer(Peer):\n+ config: BridgeConfig\n+ args: Sequence[str]\n+ env: Sequence[str]\n \n- for path in os.listdir(proc_fd):\n- # non-pid entries in proc are guaranteed to start with a character a-z\n- if path[0] < '0' or path[0] > '9':\n- continue\n+ def __init__(self, router: Router, config: BridgeConfig):\n+ self.config = config\n+ self.args = config.spawn\n+ self.env = config.environ\n+ super().__init__(router)\n \n- try:\n- with Handle.open(path, os.O_PATH, dir_fd=proc_fd) as pid_fd:\n- cgroup_name = self.get_cgroup_name(pid_fd)\n- proc_read, proc_write = self.get_proc_io(pid_fd)\n- except (FileNotFoundError, PermissionError, ProcessLookupError):\n- continue\n+ async def do_connect_transport(self) -> None:\n+ await self.spawn(self.args, self.env)\n \n- reads[cgroup_name] = reads.get(cgroup_name, 0) + proc_read\n- writes[cgroup_name] = writes.get(cgroup_name, 0) + proc_write\n \n+class PeerRoutingRule(RoutingRule):\n+ config: BridgeConfig\n+ match: JsonObject\n+ peer: Optional[Peer]\n \n-class NetworkSampler(Sampler):\n- descriptions = [\n- SampleDescription('network.interface.tx', 'bytes', 'counter', instanced=True),\n- SampleDescription('network.interface.rx', 'bytes', 'counter', instanced=True),\n- ]\n+ def __init__(self, router: Router, config: BridgeConfig):\n+ super().__init__(router)\n+ self.config = config\n+ self.match = config.match\n+ self.peer = None\n \n- def sample(self, samples: Samples) -> None:\n- with open(\"/proc/net/dev\") as network_samples:\n- for line in network_samples:\n- fields = line.split()\n+ def apply_rule(self, options: JsonObject) -> Optional[Peer]:\n+ # Check that we match\n \n- # Skip header line\n- if fields[0][-1] != ':':\n- continue\n+ for key, value in self.match.items():\n+ if key not in options:\n+ logger.debug(' rejecting because key %s is missing', key)\n+ return None\n+ if value is not None and options[key] != value:\n+ logger.debug(' rejecting because key %s has wrong value %s (vs %s)', key, options[key], value)\n+ return None\n \n- iface = fields[0][:-1]\n- samples['network.interface.rx'][iface] = int(fields[1])\n- samples['network.interface.tx'][iface] = int(fields[9])\n+ # Start the peer if it's not running already\n+ if self.peer is None:\n+ self.peer = ConfiguredPeer(self.router, self.config)\n+ self.peer.add_done_callback(self.peer_closed)\n+ assert self.router.init_host\n+ self.peer.start_in_background(init_host=self.router.init_host)\n \n+ return self.peer\n \n-class MountSampler(Sampler):\n- descriptions = [\n- SampleDescription('mount.total', 'bytes', 'instant', instanced=True),\n- SampleDescription('mount.used', 'bytes', 'instant', instanced=True),\n- ]\n+ def peer_closed(self):\n+ self.peer = None\n \n- def sample(self, samples: Samples) -> None:\n- with open('/proc/mounts') as mounts:\n- for line in mounts:\n- # Only look at real devices\n- if line[0] != '/':\n- continue\n+ def shutdown(self):\n+ if self.peer is not None:\n+ self.peer.close()\n \n- path = line.split()[1]\n- try:\n- res = os.statvfs(path)\n- except OSError:\n- continue\n- frsize = res.f_frsize\n- total = frsize * res.f_blocks\n- samples['mount.total'][path] = total\n- samples['mount.used'][path] = total - frsize * res.f_bfree\n \n+class PeersRoutingRule(RoutingRule):\n+ rules: List[PeerRoutingRule] = []\n \n-class BlockSampler(Sampler):\n- descriptions = [\n- SampleDescription('block.device.read', 'bytes', 'counter', instanced=True),\n- SampleDescription('block.device.written', 'bytes', 'counter', instanced=True),\n- ]\n+ def apply_rule(self, options: JsonObject) -> Optional[Endpoint]:\n+ logger.debug(' considering %d rules', len(self.rules))\n+ for rule in self.rules:\n+ logger.debug(' considering %s', rule.config.name)\n+ endpoint = rule.apply_rule(options)\n+ if endpoint is not None:\n+ logger.debug(' selected')\n+ return endpoint\n+ logger.debug(' no peer rules matched')\n+ return None\n \n- def sample(self, samples: Samples) -> None:\n- with open('/proc/diskstats') as diskstats:\n- for line in diskstats:\n- # https://www.kernel.org/doc/Documentation/ABI/testing/procfs-diskstats\n- [_, _, dev_name, _, _, sectors_read, _, _, _, sectors_written, *_] = line.strip().split()\n+ def set_configs(self, bridge_configs: Sequence[BridgeConfig]) -> None:\n+ old_rules = self.rules\n+ self.rules = []\n \n- samples['block.device.read'][dev_name] = int(sectors_read) * 512\n- samples['block.device.written'][dev_name] = int(sectors_written) * 512\n+ for config in bridge_configs:\n+ # Those are handled elsewhere...\n+ if config.privileged or 'host' in config.match:\n+ continue\n \n+ # Try to reuse an existing rule, if one exists...\n+ for rule in list(old_rules):\n+ if rule.config == config:\n+ old_rules.remove(rule)\n+ break\n+ else:\n+ # ... otherwise, create a new one.\n+ rule = PeerRoutingRule(self.router, config)\n \n-SAMPLERS = [\n- BlockSampler,\n- CGroupSampler,\n- CGroupDiskIO,\n- CPUSampler,\n- CPUTemperatureSampler,\n- DiskSampler,\n- MemorySampler,\n- MountSampler,\n- NetworkSampler,\n-]\n-''',\n+ self.rules.append(rule)\n+\n+ # close down the old rules that didn't get reclaimed\n+ for rule in old_rules:\n+ rule.shutdown()\n+\n+ def shutdown(self):\n+ for rule in self.rules:\n+ rule.shutdown()\n+'''.encode('utf-8'),\n 'cockpit/superuser.py': br'''# This file is part of Cockpit.\n #\n # Copyright (C) 2022 Red Hat, Inc.\n #\n # This program is free software: you can redistribute it and/or modify\n # it under the terms of the GNU General Public License as published by\n # the Free Software Foundation, either version 3 of the License, or\n@@ -749,14 +1302,749 @@\n def answer(self, reply: str) -> None:\n if self.pending_prompt is not None:\n logger.debug('responding to pending prompt')\n self.pending_prompt.set_result(reply)\n else:\n logger.debug('got Answer, but no prompt pending')\n ''',\n+ 'cockpit/config.py': br'''# This file is part of Cockpit.\n+#\n+# Copyright (C) 2023 Red Hat, Inc.\n+#\n+# This program is free software: you can redistribute it and/or modify\n+# it under the terms of the GNU General Public License as published by\n+# the Free Software Foundation, either version 3 of the License, or\n+# (at your option) any later version.\n+#\n+# This program is distributed in the hope that it will be useful,\n+# but WITHOUT ANY WARRANTY; without even the implied warranty of\n+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n+# GNU General Public License for more details.\n+#\n+# You should have received a copy of the GNU General Public License\n+# along with this program. If not, see .\n+\n+import configparser\n+import logging\n+import os\n+from pathlib import Path\n+\n+from cockpit._vendor.systemd_ctypes import bus\n+\n+logger = logging.getLogger(__name__)\n+\n+XDG_CONFIG_HOME = Path(os.getenv('XDG_CONFIG_HOME') or os.path.expanduser('~/.config'))\n+DOT_CONFIG_COCKPIT = XDG_CONFIG_HOME / 'cockpit'\n+\n+\n+def lookup_config(filename: str) -> Path:\n+ config_dirs = os.environ.get('XDG_CONFIG_DIRS', '/etc').split(':')\n+ fallback = None\n+ for config_dir in config_dirs:\n+ config_path = Path(config_dir, 'cockpit', filename)\n+ if not fallback:\n+ fallback = config_path\n+ if config_path.exists():\n+ logger.debug('lookup_config(%s): found %s', filename, config_path)\n+ return config_path\n+\n+ # default to the first entry in XDG_CONFIG_DIRS; that's not according to the spec,\n+ # but what Cockpit has done for years\n+ logger.debug('lookup_config(%s): defaulting to %s', filename, fallback)\n+ assert fallback # mypy; config_dirs always has at least one string\n+ return fallback\n+\n+\n+class Config(bus.Object, interface='cockpit.Config'):\n+ def __init__(self):\n+ self.reload()\n+\n+ @bus.Interface.Method(out_types='s', in_types='ss')\n+ def get_string(self, section, key):\n+ try:\n+ return self.config[section][key]\n+ except KeyError as exc:\n+ raise bus.BusError('cockpit.Config.KeyError', f'key {key} in section {section} does not exist') from exc\n+\n+ @bus.Interface.Method(out_types='u', in_types='ssuuu')\n+ def get_u_int(self, section, key, default, maximum, minimum):\n+ try:\n+ value = self.config[section][key]\n+ except KeyError:\n+ return default\n+\n+ try:\n+ int_val = int(value)\n+ except ValueError:\n+ logger.warning('cockpit.conf: [%s] %s is not an integer', section, key)\n+ return default\n+\n+ return min(max(int_val, minimum), maximum)\n+\n+ @bus.Interface.Method()\n+ def reload(self):\n+ self.config = configparser.ConfigParser(interpolation=None)\n+ cockpit_conf = lookup_config('cockpit.conf')\n+ logger.debug(\"cockpit.Config: loading %s\", cockpit_conf)\n+ # this may not exist, but it's ok to not have a config file and thus leave self.config empty\n+ self.config.read(cockpit_conf)\n+\n+\n+class Environment(bus.Object, interface='cockpit.Environment'):\n+ variables = bus.Interface.Property('a{ss}')\n+\n+ @variables.getter\n+ def get_variables(self):\n+ return os.environ.copy()\n+''',\n+ 'cockpit/__init__.py': br'''from ._version import __version__\n+\n+__all__ = (\n+ '__version__',\n+)\n+''',\n+ 'cockpit/packages.py': br'''# This file is part of Cockpit.\n+#\n+# Copyright (C) 2022 Red Hat, Inc.\n+#\n+# This program is free software: you can redistribute it and/or modify\n+# it under the terms of the GNU General Public License as published by\n+# the Free Software Foundation, either version 3 of the License, or\n+# (at your option) any later version.\n+#\n+# This program is distributed in the hope that it will be useful,\n+# but WITHOUT ANY WARRANTY; without even the implied warranty of\n+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n+# GNU General Public License for more details.\n+#\n+# You should have received a copy of the GNU General Public License\n+# along with this program. If not, see .\n+\n+import collections\n+import contextlib\n+import functools\n+import gzip\n+import io\n+import itertools\n+import json\n+import logging\n+import mimetypes\n+import os\n+import re\n+import shutil\n+from pathlib import Path\n+from typing import (\n+ BinaryIO,\n+ Callable,\n+ ClassVar,\n+ Dict,\n+ Iterable,\n+ List,\n+ NamedTuple,\n+ Optional,\n+ Pattern,\n+ Sequence,\n+ Tuple,\n+ TypeVar,\n+)\n+\n+from cockpit._vendor.systemd_ctypes import bus\n+\n+from . import config\n+from ._version import __version__\n+from .jsonutil import (\n+ JsonError,\n+ JsonObject,\n+ JsonValue,\n+ get_bool,\n+ get_dict,\n+ get_int,\n+ get_objv,\n+ get_str,\n+ get_strv,\n+ json_merge_patch,\n+ typechecked,\n+)\n+\n+logger = logging.getLogger(__name__)\n+\n+\n+# In practice, this is going to get called over and over again with exactly the\n+# same list. Let's try to cache the result.\n+@functools.lru_cache()\n+def parse_accept_language(accept_language: str) -> Sequence[str]:\n+ \"\"\"Parse the Accept-Language header, if it exists.\n+\n+ Returns an ordered list of languages, with fallbacks inserted, and\n+ truncated to the position where 'en' would have otherwise appeared, if\n+ applicable.\n+\n+ https://tools.ietf.org/html/rfc7231#section-5.3.5\n+ https://datatracker.ietf.org/doc/html/rfc4647#section-3.4\n+ \"\"\"\n+\n+ logger.debug('parse_accept_language(%r)', accept_language)\n+ locales_with_q = []\n+ for entry in accept_language.split(','):\n+ entry = entry.strip().lower()\n+ logger.debug(' entry %r', entry)\n+ locale, _, qstr = entry.partition(';q=')\n+ try:\n+ q = float(qstr or 1.0)\n+ except ValueError:\n+ continue # ignore malformed entry\n+\n+ while locale:\n+ logger.debug(' adding %r q=%r', locale, q)\n+ locales_with_q.append((locale, q))\n+ # strip off '-detail' suffixes until there's nothing left\n+ locale, _, _region = locale.rpartition('-')\n+\n+ # Sort the list by highest q value. Otherwise, this is a stable sort.\n+ locales_with_q.sort(key=lambda pair: pair[1], reverse=True)\n+ logger.debug(' sorted list is %r', locales_with_q)\n+\n+ # If we have 'en' anywhere in our list, ignore it and all items after it.\n+ # This will result in us getting an untranslated (ie: English) version if\n+ # none of the more-preferred languages are found, which is what we want.\n+ # We also take the chance to drop duplicate items. Note: both of these\n+ # things need to happen after sorting.\n+ results = []\n+ for locale, _q in locales_with_q:\n+ if locale == 'en':\n+ break\n+ if locale not in results:\n+ results.append(locale)\n+\n+ logger.debug(' results list is %r', results)\n+ return tuple(results)\n+\n+\n+def sortify_version(version: str) -> str:\n+ \"\"\"Convert a version string to a form that can be compared\"\"\"\n+ # 0-pad each numeric component. Only supports numeric versions like 1.2.3.\n+ return '.'.join(part.zfill(8) for part in version.split('.'))\n+\n+\n+@functools.lru_cache()\n+def get_libexecdir() -> str:\n+ \"\"\"Detect libexecdir on current machine\n+\n+ This only works for systems which have cockpit-ws installed.\n+ \"\"\"\n+ for candidate in ['/usr/local/libexec', '/usr/libexec', '/usr/local/lib/cockpit', '/usr/lib/cockpit']:\n+ if os.path.exists(os.path.join(candidate, 'cockpit-askpass')):\n+ return candidate\n+ else:\n+ logger.warning('Could not detect libexecdir')\n+ # give readable error messages\n+ return '/nonexistent/libexec'\n+\n+\n+# HACK: Type narrowing over Union types is not supported in the general case,\n+# but this works for the case we care about: knowing that when we pass in an\n+# JsonObject, we'll get an JsonObject back.\n+J = TypeVar('J', JsonObject, JsonValue)\n+\n+\n+def patch_libexecdir(obj: J) -> J:\n+ if isinstance(obj, str):\n+ if '${libexecdir}/cockpit-askpass' in obj:\n+ # extra-special case: we handle this internally\n+ abs_askpass = shutil.which('cockpit-askpass')\n+ if abs_askpass is not None:\n+ return obj.replace('${libexecdir}/cockpit-askpass', abs_askpass)\n+ return obj.replace('${libexecdir}', get_libexecdir())\n+ elif isinstance(obj, dict):\n+ return {key: patch_libexecdir(value) for key, value in obj.items()}\n+ elif isinstance(obj, list):\n+ return [patch_libexecdir(item) for item in obj]\n+ else:\n+ return obj\n+\n+\n+# A document is a binary stream with a Content-Type, optional Content-Encoding,\n+# and optional Content-Security-Policy\n+class Document(NamedTuple):\n+ data: BinaryIO\n+ content_type: str\n+ content_encoding: Optional[str] = None\n+ content_security_policy: Optional[str] = None\n+\n+\n+class PackagesListener:\n+ def packages_loaded(self) -> None:\n+ \"\"\"Called when the packages have been reloaded\"\"\"\n+\n+\n+class BridgeConfig(dict, JsonObject):\n+ def __init__(self, value: JsonObject):\n+ super().__init__(value)\n+\n+ self.label = get_str(self, 'label', None)\n+\n+ self.privileged = get_bool(self, 'privileged', default=False)\n+ self.match = get_dict(self, 'match', {})\n+ if not self.privileged and not self.match:\n+ raise JsonError(value, 'must have match rules or be privileged')\n+\n+ self.environ = get_strv(self, 'environ', ())\n+ self.spawn = get_strv(self, 'spawn')\n+ if not self.spawn:\n+ raise JsonError(value, 'spawn vector must be non-empty')\n+\n+ self.name = self.label or self.spawn[0]\n+\n+\n+class Condition:\n+ def __init__(self, value: JsonObject):\n+ try:\n+ (self.name, self.value), = value.items()\n+ except ValueError as exc:\n+ raise JsonError(value, 'must contain exactly one key/value pair') from exc\n+\n+\n+class Manifest(dict, JsonObject):\n+ # Skip version check when running out of the git checkout (__version__ is None)\n+ COCKPIT_VERSION = __version__ and sortify_version(__version__)\n+\n+ def __init__(self, path: Path, value: JsonObject):\n+ super().__init__(value)\n+ self.path = path\n+ self.name = get_str(self, 'name', self.path.name)\n+ self.bridges = get_objv(self, 'bridges', BridgeConfig)\n+ self.priority = get_int(self, 'priority', 1)\n+ self.csp = get_str(self, 'content-security-policy', '')\n+ self.conditions = get_objv(self, 'conditions', Condition)\n+\n+ # Skip version check when running out of the git checkout (COCKPIT_VERSION is None)\n+ if self.COCKPIT_VERSION is not None:\n+ requires = get_dict(self, 'requires', {})\n+ for name, version in requires.items():\n+ if name != 'cockpit':\n+ raise JsonError(name, 'non-cockpit requirement listed')\n+ if sortify_version(typechecked(version, str)) > self.COCKPIT_VERSION:\n+ raise JsonError(version, f'required cockpit version ({version}) not met')\n+\n+\n+class Package:\n+ # For po{,.manifest}.js files, the interesting part is the locale name\n+ PO_JS_RE: ClassVar[Pattern] = re.compile(r'(po|po\\.manifest)\\.([^.]+)\\.js(\\.gz)?')\n+\n+ # immutable after __init__\n+ manifest: Manifest\n+ name: str\n+ path: Path\n+ priority: int\n+\n+ # computed later\n+ translations: Optional[Dict[str, Dict[str, str]]] = None\n+ files: Optional[Dict[str, str]] = None\n+\n+ def __init__(self, manifest: Manifest):\n+ self.manifest = manifest\n+ self.name = manifest.name\n+ self.path = manifest.path\n+ self.priority = manifest.priority\n+\n+ def ensure_scanned(self) -> None:\n+ \"\"\"Ensure that the package has been scanned.\n+\n+ This allows us to defer scanning the files of the package until we know\n+ that we'll actually use it.\n+ \"\"\"\n+\n+ if self.files is not None:\n+ return\n+\n+ self.files = {}\n+ self.translations = {'po.js': {}, 'po.manifest.js': {}}\n+\n+ for file in self.path.rglob('*'):\n+ name = str(file.relative_to(self.path))\n+ if name in ['.', '..', 'manifest.json']:\n+ continue\n+\n+ po_match = Package.PO_JS_RE.fullmatch(name)\n+ if po_match:\n+ basename = po_match.group(1)\n+ locale = po_match.group(2)\n+ # Accept-Language is case-insensitive and uses '-' to separate variants\n+ lower_locale = locale.lower().replace('_', '-')\n+\n+ logger.debug('Adding translation %r %r -> %r', basename, lower_locale, name)\n+ self.translations[f'{basename}.js'][lower_locale] = name\n+ else:\n+ # strip out trailing '.gz' components\n+ basename = re.sub('.gz$', '', name)\n+ logger.debug('Adding content %r -> %r', basename, name)\n+ self.files[basename] = name\n+\n+ # If we see a filename like `x.min.js` we want to also offer it\n+ # at `x.js`, but only if `x.js(.gz)` itself is not present.\n+ # Note: this works for both the case where we found the `x.js`\n+ # first (it's already in the map) and also if we find it second\n+ # (it will be replaced in the map by the line just above).\n+ # See https://github.com/cockpit-project/cockpit/pull/19716\n+ self.files.setdefault(basename.replace('.min.', '.'), name)\n+\n+ # support old cockpit-po-plugin which didn't write po.manifest.??.js\n+ if not self.translations['po.manifest.js']:\n+ self.translations['po.manifest.js'] = self.translations['po.js']\n+\n+ def get_content_security_policy(self) -> str:\n+ policy = {\n+ \"default-src\": \"'self'\",\n+ \"connect-src\": \"'self'\",\n+ \"form-action\": \"'self'\",\n+ \"base-uri\": \"'self'\",\n+ \"object-src\": \"'none'\",\n+ \"font-src\": \"'self' data:\",\n+ \"img-src\": \"'self' data:\",\n+ }\n+\n+ for item in self.manifest.csp.split(';'):\n+ item = item.strip()\n+ if item:\n+ key, _, value = item.strip().partition(' ')\n+ policy[key] = value\n+\n+ return ' '.join(f'{k} {v};' for k, v in policy.items()) + ' block-all-mixed-content'\n+\n+ def load_file(self, filename: str) -> Document:\n+ content_type, content_encoding = mimetypes.guess_type(filename)\n+ content_security_policy = None\n+\n+ if content_type is None:\n+ content_type = 'text/plain'\n+ elif content_type.startswith('text/html'):\n+ content_security_policy = self.get_content_security_policy()\n+\n+ path = self.path / filename\n+ logger.debug(' loading data from %s', path)\n+\n+ return Document(path.open('rb'), content_type, content_encoding, content_security_policy)\n+\n+ def load_translation(self, path: str, locales: Sequence[str]) -> Document:\n+ self.ensure_scanned()\n+ assert self.translations is not None\n+\n+ # First match wins\n+ for locale in locales:\n+ with contextlib.suppress(KeyError):\n+ return self.load_file(self.translations[path][locale])\n+\n+ # We prefer to return an empty document than 404 in order to avoid\n+ # errors in the console when a translation can't be found\n+ return Document(io.BytesIO(), 'text/javascript')\n+\n+ def load_path(self, path: str, headers: JsonObject) -> Document:\n+ self.ensure_scanned()\n+ assert self.files is not None\n+ assert self.translations is not None\n+\n+ if path in self.translations:\n+ locales = parse_accept_language(get_str(headers, 'Accept-Language', ''))\n+ return self.load_translation(path, locales)\n+ else:\n+ return self.load_file(self.files[path])\n+\n+\n+class PackagesLoader:\n+ CONDITIONS: ClassVar[Dict[str, Callable[[str], bool]]] = {\n+ 'path-exists': os.path.exists,\n+ 'path-not-exists': lambda p: not os.path.exists(p),\n+ }\n+\n+ @classmethod\n+ def get_xdg_data_dirs(cls) -> Iterable[str]:\n+ try:\n+ yield os.environ['XDG_DATA_HOME']\n+ except KeyError:\n+ yield os.path.expanduser('~/.local/share')\n+\n+ try:\n+ yield from os.environ['XDG_DATA_DIRS'].split(':')\n+ except KeyError:\n+ yield from ('/usr/local/share', '/usr/share')\n+\n+ @classmethod\n+ def patch_manifest(cls, manifest: JsonObject, parent: Path) -> JsonObject:\n+ override_files = [\n+ parent / 'override.json',\n+ config.lookup_config(f'{parent.name}.override.json'),\n+ config.DOT_CONFIG_COCKPIT / f'{parent.name}.override.json',\n+ ]\n+\n+ for override_file in override_files:\n+ try:\n+ override: JsonValue = json.loads(override_file.read_bytes())\n+ except FileNotFoundError:\n+ continue\n+ except json.JSONDecodeError as exc:\n+ # User input error: report a warning\n+ logger.warning('%s: %s', override_file, exc)\n+\n+ if not isinstance(override, dict):\n+ logger.warning('%s: override file is not a dictionary', override_file)\n+ continue\n+\n+ manifest = json_merge_patch(manifest, override)\n+\n+ return patch_libexecdir(manifest)\n+\n+ @classmethod\n+ def load_manifests(cls) -> Iterable[Manifest]:\n+ for datadir in cls.get_xdg_data_dirs():\n+ logger.debug(\"Scanning for manifest files under %s\", datadir)\n+ for file in Path(datadir).glob('cockpit/*/manifest.json'):\n+ logger.debug(\"Considering file %s\", file)\n+ try:\n+ manifest = json.loads(file.read_text())\n+ except json.JSONDecodeError as exc:\n+ logger.error(\"%s: %s\", file, exc)\n+ continue\n+ if not isinstance(manifest, dict):\n+ logger.error(\"%s: json document isn't an object\", file)\n+ continue\n+\n+ parent = file.parent\n+ manifest = cls.patch_manifest(manifest, parent)\n+ try:\n+ yield Manifest(parent, manifest)\n+ except JsonError as exc:\n+ logger.warning('%s %s', file, exc)\n+\n+ def check_condition(self, condition: str, value: object) -> bool:\n+ check_fn = self.CONDITIONS[condition]\n+\n+ # All known predicates currently only work on strings\n+ if not isinstance(value, str):\n+ return False\n+\n+ return check_fn(value)\n+\n+ def check_conditions(self, manifest: Manifest) -> bool:\n+ for condition in manifest.conditions:\n+ try:\n+ okay = self.check_condition(condition.name, condition.value)\n+ except KeyError:\n+ # do *not* ignore manifests with unknown predicates, for forward compatibility\n+ logger.warning(' %s: ignoring unknown predicate in manifest: %s', manifest.path, condition.name)\n+ continue\n+\n+ if not okay:\n+ logger.debug(' hiding package %s as its %s condition is not met', manifest.path, condition)\n+ return False\n+\n+ return True\n+\n+ def load_packages(self) -> Iterable[Tuple[str, Package]]:\n+ logger.debug('Scanning for available package manifests:')\n+ # Sort all available packages into buckets by to their claimed name\n+ names: Dict[str, List[Manifest]] = collections.defaultdict(list)\n+ for manifest in self.load_manifests():\n+ logger.debug(' %s/manifest.json', manifest.path)\n+ names[manifest.name].append(manifest)\n+ logger.debug('done.')\n+\n+ logger.debug('Selecting packages to serve:')\n+ for name, candidates in names.items():\n+ # For each package name, iterate the candidates in descending\n+ # priority order and select the first one which passes all checks\n+ for candidate in sorted(candidates, key=lambda manifest: manifest.priority, reverse=True):\n+ try:\n+ if self.check_conditions(candidate):\n+ logger.debug(' creating package %s -> %s', name, candidate.path)\n+ yield name, Package(candidate)\n+ break\n+ except JsonError:\n+ logger.warning(' %s: ignoring package with invalid manifest file', candidate.path)\n+\n+ logger.debug(' ignoring %s: unmet conditions', candidate.path)\n+ logger.debug('done.')\n+\n+\n+class Packages(bus.Object, interface='cockpit.Packages'):\n+ loader: PackagesLoader\n+ listener: Optional[PackagesListener]\n+ packages: Dict[str, Package]\n+ saw_first_reload_hint: bool\n+\n+ def __init__(self, listener: Optional[PackagesListener] = None, loader: Optional[PackagesLoader] = None):\n+ self.listener = listener\n+ self.loader = loader or PackagesLoader()\n+ self.load()\n+\n+ # Reloading the Shell in the browser should reload the\n+ # packages. This is implemented by having the Shell call\n+ # reload_hint whenever it starts. The first call of this\n+ # method in each session is ignored so that packages are not\n+ # loaded twice right after logging in.\n+ #\n+ self.saw_first_reload_hint = False\n+\n+ def load(self) -> None:\n+ self.packages = dict(self.loader.load_packages())\n+ self.manifests = json.dumps({name: dict(package.manifest) for name, package in self.packages.items()})\n+ logger.debug('Packages loaded: %s', list(self.packages))\n+\n+ def show(self):\n+ for name in sorted(self.packages):\n+ package = self.packages[name]\n+ menuitems = []\n+ for entry in itertools.chain(\n+ package.manifest.get('menu', {}).values(),\n+ package.manifest.get('tools', {}).values()):\n+ with contextlib.suppress(KeyError):\n+ menuitems.append(entry['label'])\n+ print(f'{name:20} {\", \".join(menuitems):40} {package.path}')\n+\n+ def get_bridge_configs(self) -> Sequence[BridgeConfig]:\n+ def yield_configs():\n+ for package in sorted(self.packages.values(), key=lambda package: -package.priority):\n+ yield from package.manifest.bridges\n+ return tuple(yield_configs())\n+\n+ # D-Bus Interface\n+ manifests = bus.Interface.Property('s', value=\"{}\")\n+\n+ @bus.Interface.Method()\n+ def reload(self):\n+ self.load()\n+ if self.listener is not None:\n+ self.listener.packages_loaded()\n+\n+ @bus.Interface.Method()\n+ def reload_hint(self):\n+ if self.saw_first_reload_hint:\n+ self.reload()\n+ self.saw_first_reload_hint = True\n+\n+ def load_manifests_js(self, headers: JsonObject) -> Document:\n+ logger.debug('Serving /manifests.js')\n+\n+ chunks: List[bytes] = []\n+\n+ # Send the translations required for the manifest files, from each package\n+ locales = parse_accept_language(get_str(headers, 'Accept-Language', ''))\n+ for name, package in self.packages.items():\n+ if name in ['static', 'base1']:\n+ continue\n+\n+ # find_translation will always find at least 'en'\n+ translation = package.load_translation('po.manifest.js', locales)\n+ with translation.data:\n+ if translation.content_encoding == 'gzip':\n+ data = gzip.decompress(translation.data.read())\n+ else:\n+ data = translation.data.read()\n+\n+ chunks.append(data)\n+\n+ chunks.append(b\"\"\"\n+ (function (root, data) {\n+ if (typeof define === 'function' && define.amd) {\n+ define(data);\n+ }\n+\n+ if (typeof cockpit === 'object') {\n+ cockpit.manifests = data;\n+ } else {\n+ root.manifests = data;\n+ }\n+ }(this, \"\"\" + self.manifests.encode() + b\"\"\"))\"\"\")\n+\n+ return Document(io.BytesIO(b'\\n'.join(chunks)), 'text/javascript')\n+\n+ def load_manifests_json(self) -> Document:\n+ logger.debug('Serving /manifests.json')\n+ return Document(io.BytesIO(self.manifests.encode()), 'application/json')\n+\n+ PATH_RE = re.compile(\n+ r'/' # leading '/'\n+ r'(?:([^/]+)/)?' # optional leading path component\n+ r'((?:[^/]+/)*[^/]+)' # remaining path components\n+ )\n+\n+ def load_path(self, path: str, headers: JsonObject) -> Document:\n+ logger.debug('packages: serving %s', path)\n+\n+ match = self.PATH_RE.fullmatch(path)\n+ if match is None:\n+ raise ValueError(f'Invalid HTTP path {path}')\n+ packagename, filename = match.groups()\n+\n+ if packagename is not None:\n+ return self.packages[packagename].load_path(filename, headers)\n+ elif filename == 'manifests.js':\n+ return self.load_manifests_js(headers)\n+ elif filename == 'manifests.json':\n+ return self.load_manifests_json()\n+ else:\n+ raise KeyError\n+''',\n+ 'cockpit/polyfills.py': br'''# This file is part of Cockpit.\n+#\n+# Copyright (C) 2023 Red Hat, Inc.\n+#\n+# This program is free software: you can redistribute it and/or modify\n+# it under the terms of the GNU General Public License as published by\n+# the Free Software Foundation, either version 3 of the License, or\n+# (at your option) any later version.\n+#\n+# This program is distributed in the hope that it will be useful,\n+# but WITHOUT ANY WARRANTY; without even the implied warranty of\n+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n+# GNU General Public License for more details.\n+#\n+# You should have received a copy of the GNU General Public License\n+# along with this program. If not, see .\n+\n+import contextlib\n+import socket\n+\n+\n+def install():\n+ \"\"\"Add shims for older Python versions\"\"\"\n+\n+ # introduced in 3.9\n+ if not hasattr(socket, 'recv_fds'):\n+ import array\n+\n+ import _socket\n+\n+ def recv_fds(sock, bufsize, maxfds, flags=0):\n+ fds = array.array(\"i\")\n+ msg, ancdata, flags, addr = sock.recvmsg(bufsize, _socket.CMSG_LEN(maxfds * fds.itemsize))\n+ for cmsg_level, cmsg_type, cmsg_data in ancdata:\n+ if (cmsg_level == _socket.SOL_SOCKET and cmsg_type == _socket.SCM_RIGHTS):\n+ fds.frombytes(cmsg_data[:len(cmsg_data) - (len(cmsg_data) % fds.itemsize)])\n+ return msg, list(fds), flags, addr\n+\n+ socket.recv_fds = recv_fds\n+\n+ # introduced in 3.7\n+ if not hasattr(contextlib, 'AsyncExitStack'):\n+ class AsyncExitStack:\n+ async def __aenter__(self):\n+ self.cms = []\n+ return self\n+\n+ async def enter_async_context(self, cm):\n+ result = await cm.__aenter__()\n+ self.cms.append(cm)\n+ return result\n+\n+ async def __aexit__(self, exc_type, exc_value, traceback):\n+ for cm in self.cms:\n+ cm.__aexit__(exc_type, exc_value, traceback)\n+\n+ contextlib.AsyncExitStack = AsyncExitStack\n+''',\n 'cockpit/channel.py': r'''# This file is part of Cockpit.\n #\n # Copyright (C) 2022 Red Hat, Inc.\n #\n # This program is free software: you can redistribute it and/or modify\n # it under the terms of the GNU General Public License as published by\n # the Free Software Foundation, either version 3 of the License, or\n@@ -1300,172 +2588,14 @@\n try:\n while self.send_data(next(self.__generator)):\n pass\n except StopIteration as stop:\n self.done()\n self.close(stop.value)\n '''.encode('utf-8'),\n- 'cockpit/internal_endpoints.py': br'''# This file is part of Cockpit.\n-#\n-# Copyright (C) 2022 Red Hat, Inc.\n-#\n-# This program is free software: you can redistribute it and/or modify\n-# it under the terms of the GNU General Public License as published by\n-# the Free Software Foundation, either version 3 of the License, or\n-# (at your option) any later version.\n-#\n-# This program is distributed in the hope that it will be useful,\n-# but WITHOUT ANY WARRANTY; without even the implied warranty of\n-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n-# GNU General Public License for more details.\n-#\n-# You should have received a copy of the GNU General Public License\n-# along with this program. If not, see .\n-\n-import asyncio\n-import glob\n-import grp\n-import json\n-import logging\n-import os\n-import pwd\n-from pathlib import Path\n-from typing import Dict, Optional\n-\n-from cockpit._vendor.systemd_ctypes import Variant, bus, inotify, pathwatch\n-\n-from . import config\n-\n-logger = logging.getLogger(__name__)\n-\n-\n-class cockpit_LoginMessages(bus.Object):\n- messages: Optional[str] = None\n-\n- def __init__(self):\n- fdstr = os.environ.pop('COCKPIT_LOGIN_MESSAGES_MEMFD', None)\n- if fdstr is None:\n- logger.debug(\"COCKPIT_LOGIN_MESSAGES_MEMFD wasn't set. No login messages today.\")\n- return\n-\n- logger.debug(\"Trying to read login messages from fd %s\", fdstr)\n- try:\n- with open(int(fdstr), 'r') as login_messages:\n- login_messages.seek(0)\n- self.messages = login_messages.read()\n- except (ValueError, OSError, UnicodeDecodeError) as exc:\n- # ValueError - the envvar wasn't an int\n- # OSError - the fd wasn't open, or other read failure\n- # UnicodeDecodeError - didn't contain utf-8\n- # For all of these, we simply failed to get the message.\n- logger.debug(\"Reading login messages failed: %s\", exc)\n- else:\n- logger.debug(\"Successfully read login messages: %s\", self.messages)\n-\n- @bus.Interface.Method(out_types=['s'])\n- def get(self):\n- return self.messages or '{}'\n-\n- @bus.Interface.Method(out_types=[])\n- def dismiss(self):\n- self.messages = None\n-\n-\n-class cockpit_Machines(bus.Object):\n- path: Path\n- watch: pathwatch.PathWatch\n- pending_notify: Optional[asyncio.Handle]\n-\n- # D-Bus implementation\n- machines = bus.Interface.Property('a{sa{sv}}')\n-\n- @machines.getter\n- def get_machines(self) -> Dict[str, Dict[str, Variant]]:\n- results: Dict[str, Dict[str, Variant]] = {}\n-\n- for filename in glob.glob(f'{self.path}/*.json'):\n- with open(filename) as fp:\n- try:\n- contents = json.load(fp)\n- except json.JSONDecodeError:\n- logger.warning('Invalid JSON in file %s. Ignoring.', filename)\n- continue\n- # merge\n- for hostname, attrs in contents.items():\n- results[hostname] = {key: Variant(value) for key, value in attrs.items()}\n-\n- return results\n-\n- @bus.Interface.Method(in_types=['s', 's', 'a{sv}'])\n- def update(self, filename: str, hostname: str, attrs: Dict[str, Variant]) -> None:\n- try:\n- with self.path.joinpath(filename).open() as fp:\n- contents = json.load(fp)\n- except json.JSONDecodeError as exc:\n- # Refuse to replace corrupted file\n- raise bus.BusError('cockpit.Machines.Error', f'File {filename} is in invalid format: {exc}.') from exc\n- except FileNotFoundError:\n- # But an empty file is an expected case\n- contents = {}\n-\n- contents.setdefault(hostname, {}).update({key: value.value for key, value in attrs.items()})\n-\n- self.path.mkdir(parents=True, exist_ok=True)\n- with open(self.path.joinpath(filename), 'w') as fp:\n- json.dump(contents, fp, indent=2)\n-\n- def notify(self):\n- def _notify_now():\n- self.properties_changed('cockpit.Machines', {}, ['Machines'])\n- self.pending_notify = None\n-\n- # avoid a flurry of update notifications\n- if self.pending_notify is None:\n- self.pending_notify = asyncio.get_running_loop().call_later(1.0, _notify_now)\n-\n- # inotify events\n- def do_inotify_event(self, mask: inotify.Event, cookie: int, name: Optional[str]) -> None:\n- self.notify()\n-\n- def do_identity_changed(self, fd: Optional[int], errno: Optional[int]) -> None:\n- self.notify()\n-\n- def __init__(self):\n- self.path = config.lookup_config('machines.d')\n-\n- # ignore the first callback\n- self.pending_notify = ...\n- self.watch = pathwatch.PathWatch(str(self.path), self)\n- self.pending_notify = None\n-\n-\n-class cockpit_User(bus.Object):\n- name = bus.Interface.Property('s', value='')\n- full = bus.Interface.Property('s', value='')\n- id = bus.Interface.Property('i', value=0)\n- home = bus.Interface.Property('s', value='')\n- shell = bus.Interface.Property('s', value='')\n- groups = bus.Interface.Property('as', value=[])\n-\n- def __init__(self):\n- user = pwd.getpwuid(os.getuid())\n- self.name = user.pw_name\n- self.full = user.pw_gecos\n- self.id = user.pw_uid\n- self.home = user.pw_dir\n- self.shell = user.pw_shell\n- self.groups = [gr.gr_name for gr in grp.getgrall() if user.pw_name in gr.gr_mem]\n-\n-\n-EXPORTS = [\n- ('/LoginMessages', cockpit_LoginMessages),\n- ('/machines', cockpit_Machines),\n- ('/user', cockpit_User),\n-]\n-''',\n 'cockpit/beiboot.py': br'''# This file is part of Cockpit.\n #\n # Copyright (C) 2022 Red Hat, Inc.\n #\n # This program is free software: you can redistribute it and/or modify\n # it under the terms of the GNU General Public License as published by\n # the Free Software Foundation, either version 3 of the License, or\n@@ -1811,699 +2941,207 @@\n \n asyncio.run(run(args), debug=args.debug)\n \n \n if __name__ == '__main__':\n main()\n ''',\n- 'cockpit/bridge.py': r'''# This file is part of Cockpit.\n+ 'cockpit/jsonutil.py': r'''# This file is part of Cockpit.\n #\n-# Copyright (C) 2022 Red Hat, Inc.\n+# Copyright (C) 2023 Red Hat, Inc.\n #\n # This program is free software: you can redistribute it and/or modify\n # it under the terms of the GNU General Public License as published by\n # the Free Software Foundation, either version 3 of the License, or\n # (at your option) any later version.\n #\n # This program is distributed in the hope that it will be useful,\n # but WITHOUT ANY WARRANTY; without even the implied warranty of\n # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n # GNU General Public License for more details.\n #\n # You should have received a copy of the GNU General Public License\n # along with this program. If not, see .\n \n-import argparse\n-import asyncio\n-import contextlib\n-import json\n-import logging\n-import os\n-import pwd\n-import shlex\n-import socket\n-import stat\n-import subprocess\n-from typing import Iterable, List, Optional, Sequence, Tuple, Type\n-\n-from cockpit._vendor.ferny import interaction_client\n-from cockpit._vendor.systemd_ctypes import bus, run_async\n-\n-from . import polyfills\n-from ._version import __version__\n-from .channel import ChannelRoutingRule\n-from .channels import CHANNEL_TYPES\n-from .config import Config, Environment\n-from .internal_endpoints import EXPORTS\n-from .jsonutil import JsonError, JsonObject, get_dict\n-from .packages import BridgeConfig, Packages, PackagesListener\n-from .peer import PeersRoutingRule\n-from .remote import HostRoutingRule\n-from .router import Router\n-from .superuser import SuperuserRoutingRule\n-from .transports import StdioTransport\n-\n-logger = logging.getLogger(__name__)\n-\n-\n-class InternalBus:\n- exportees: List[bus.Slot]\n-\n- def __init__(self, exports: Iterable[Tuple[str, Type[bus.BaseObject]]]):\n- client_socket, server_socket = socket.socketpair()\n- self.client = bus.Bus.new(fd=client_socket.detach())\n- self.server = bus.Bus.new(fd=server_socket.detach(), server=True)\n- self.exportees = [self.server.add_object(path, cls()) for path, cls in exports]\n-\n- def export(self, path: str, obj: bus.BaseObject) -> None:\n- self.exportees.append(self.server.add_object(path, obj))\n-\n-\n-class Bridge(Router, PackagesListener):\n- internal_bus: InternalBus\n- packages: Optional[Packages]\n- bridge_configs: Sequence[BridgeConfig]\n- args: argparse.Namespace\n-\n- def __init__(self, args: argparse.Namespace):\n- self.internal_bus = InternalBus(EXPORTS)\n- self.bridge_configs = []\n- self.args = args\n-\n- self.superuser_rule = SuperuserRoutingRule(self, privileged=args.privileged)\n- self.internal_bus.export('/superuser', self.superuser_rule)\n-\n- self.internal_bus.export('/config', Config())\n- self.internal_bus.export('/environment', Environment())\n-\n- self.peers_rule = PeersRoutingRule(self)\n-\n- if args.beipack:\n- # Some special stuff for beipack\n- self.superuser_rule.set_configs((\n- BridgeConfig({\n- \"privileged\": True,\n- \"spawn\": [\"sudo\", \"-k\", \"-A\", \"python3\", \"-ic\", \"# cockpit-bridge\", \"--privileged\"],\n- \"environ\": [\"SUDO_ASKPASS=ferny-askpass\"],\n- }),\n- ))\n- self.packages = None\n- elif args.privileged:\n- self.packages = None\n- else:\n- self.packages = Packages(self)\n- self.internal_bus.export('/packages', self.packages)\n- self.packages_loaded()\n-\n- super().__init__([\n- HostRoutingRule(self),\n- self.superuser_rule,\n- ChannelRoutingRule(self, CHANNEL_TYPES),\n- self.peers_rule,\n- ])\n-\n- @staticmethod\n- def get_os_release():\n- try:\n- file = open('/etc/os-release', encoding='utf-8')\n- except FileNotFoundError:\n- try:\n- file = open('/usr/lib/os-release', encoding='utf-8')\n- except FileNotFoundError:\n- logger.warning(\"Neither /etc/os-release nor /usr/lib/os-release exists\")\n- return {}\n-\n- os_release = {}\n- for line in file.readlines():\n- line = line.strip()\n- if not line or line.startswith('#'):\n- continue\n- try:\n- k, v = line.split('=')\n- (v_parsed, ) = shlex.split(v) # expect exactly one token\n- except ValueError:\n- logger.warning('Ignoring invalid line in os-release: %r', line)\n- continue\n- os_release[k] = v_parsed\n- return os_release\n-\n- def do_init(self, message: JsonObject) -> None:\n- # we're only interested in the case where this is a dict, but\n- # 'superuser' may well be `False` and that's not an error\n- with contextlib.suppress(JsonError):\n- superuser = get_dict(message, 'superuser')\n- self.superuser_rule.init(superuser)\n-\n- def do_send_init(self) -> None:\n- init_args = {\n- 'capabilities': {'explicit-superuser': True},\n- 'command': 'init',\n- 'os-release': self.get_os_release(),\n- 'version': 1,\n- }\n-\n- if self.packages is not None:\n- init_args['packages'] = dict.fromkeys(self.packages.packages)\n-\n- self.write_control(init_args)\n-\n- # PackagesListener interface\n- def packages_loaded(self) -> None:\n- assert self.packages\n- bridge_configs = self.packages.get_bridge_configs()\n- if self.bridge_configs != bridge_configs:\n- self.superuser_rule.set_configs(bridge_configs)\n- self.peers_rule.set_configs(bridge_configs)\n- self.bridge_configs = bridge_configs\n-\n-\n-async def run(args) -> None:\n- logger.debug(\"Hi. How are you today?\")\n-\n- # Unit tests require this\n- me = pwd.getpwuid(os.getuid())\n- os.environ['HOME'] = me.pw_dir\n- os.environ['SHELL'] = me.pw_shell\n- os.environ['USER'] = me.pw_name\n-\n- logger.debug('Starting the router.')\n- router = Bridge(args)\n- StdioTransport(asyncio.get_running_loop(), router)\n-\n- logger.debug('Startup done. Looping until connection closes.')\n+from enum import Enum\n+from typing import Callable, Container, Dict, List, Mapping, Optional, Sequence, Type, TypeVar, Union\n \n- try:\n- await router.communicate()\n- except (BrokenPipeError, ConnectionResetError):\n- # not unexpected if the peer doesn't hang up cleanly\n- pass\n+JsonLiteral = Union[str, float, bool, None]\n \n+# immutable\n+JsonValue = Union['JsonObject', Sequence['JsonValue'], JsonLiteral]\n+JsonObject = Mapping[str, JsonValue]\n \n-def try_to_receive_stderr():\n- try:\n- ours, theirs = socket.socketpair()\n- with ours:\n- with theirs:\n- interaction_client.command(2, 'cockpit.send-stderr', fds=[theirs.fileno()])\n- _msg, fds, _flags, _addr = socket.recv_fds(ours, 1, 1)\n- except OSError:\n- return\n+# mutable\n+JsonDocument = Union['JsonDict', 'JsonList', JsonLiteral]\n+JsonDict = Dict[str, JsonDocument]\n+JsonList = List[JsonDocument]\n \n- try:\n- stderr_fd, = fds\n- # We're about to abruptly drop our end of the stderr socketpair that we\n- # share with the ferny agent. ferny would normally treat that as an\n- # unexpected error. Instruct it to do a clean exit, instead.\n- interaction_client.command(2, 'ferny.end')\n- os.dup2(stderr_fd, 2)\n- finally:\n- for fd in fds:\n- os.close(fd)\n \n+DT = TypeVar('DT')\n+T = TypeVar('T')\n \n-def setup_journald() -> bool:\n- # If stderr is a socket, prefer systemd-journal logging. This covers the\n- # case we're already connected to the journal but also the case where we're\n- # talking to the ferny agent, while leaving logging to file or terminal\n- # unaffected.\n- if not stat.S_ISSOCK(os.fstat(2).st_mode):\n- # not a socket? Don't redirect.\n- return False\n \n- try:\n- import systemd.journal # type: ignore[import]\n- except ImportError:\n- # No python3-systemd? Don't redirect.\n- return False\n+class JsonError(Exception):\n+ value: object\n \n- logging.root.addHandler(systemd.journal.JournalHandler())\n- return True\n+ def __init__(self, value: object, msg: str):\n+ super().__init__(msg)\n+ self.value = value\n \n \n-def setup_logging(*, debug: bool) -> None:\n- \"\"\"Setup our logger with optional filtering of modules if COCKPIT_DEBUG env is set\"\"\"\n+def typechecked(value: JsonValue, expected_type: Type[T]) -> T:\n+ \"\"\"Ensure a JSON value has the expected type, returning it if so.\"\"\"\n+ if not isinstance(value, expected_type):\n+ raise JsonError(value, f'must have type {expected_type.__name__}')\n+ return value\n \n- modules = os.getenv('COCKPIT_DEBUG', '')\n \n- # Either setup logging via journal or via formatted messages to stderr\n- if not setup_journald():\n- logging.basicConfig(format='%(name)s-%(levelname)s: %(message)s')\n+# We can't use None as a sentinel because it's often the actual default value\n+# EllipsisType is difficult because it's not available before 3.10.\n+# See https://peps.python.org/pep-0484/#support-for-singleton-types-in-unions\n+class _Empty(Enum):\n+ TOKEN = 0\n \n- if debug or modules == 'all':\n- logging.getLogger().setLevel(level=logging.DEBUG)\n- elif modules:\n- for module in modules.split(','):\n- module = module.strip()\n- if not module:\n- continue\n \n- logging.getLogger(module).setLevel(logging.DEBUG)\n+_empty = _Empty.TOKEN\n \n \n-def start_ssh_agent() -> None:\n- # Launch the agent so that it goes down with us on EOF; PDEATHSIG would be more robust,\n- # but it gets cleared on setgid ssh-agent, which some distros still do\n+def _get(obj: JsonObject, cast: Callable[[JsonValue], T], key: str, default: Union[DT, _Empty]) -> Union[T, DT]:\n try:\n- proc = subprocess.Popen(['ssh-agent', 'sh', '-ec', 'echo SSH_AUTH_SOCK=$SSH_AUTH_SOCK; read a'],\n- stdin=subprocess.PIPE, stdout=subprocess.PIPE, universal_newlines=True)\n- assert proc.stdout is not None\n-\n- # Wait for the agent to write at least one line and look for the\n- # listener socket. If we fail to find it, kill the agent \u2014 something\n- # went wrong.\n- for token in shlex.shlex(proc.stdout.readline(), punctuation_chars=True):\n- if token.startswith('SSH_AUTH_SOCK='):\n- os.environ['SSH_AUTH_SOCK'] = token.replace('SSH_AUTH_SOCK=', '', 1)\n- break\n- else:\n- proc.terminate()\n- proc.wait()\n-\n- except FileNotFoundError:\n- logger.debug(\"Couldn't start ssh-agent (FileNotFoundError)\")\n-\n- except OSError as exc:\n- logger.warning(\"Could not start ssh-agent: %s\", exc)\n-\n-\n-def main(*, beipack: bool = False) -> None:\n- polyfills.install()\n-\n- parser = argparse.ArgumentParser(description='cockpit-bridge is run automatically inside of a Cockpit session.')\n- parser.add_argument('--privileged', action='store_true', help='Privileged copy of the bridge')\n- parser.add_argument('--packages', action='store_true', help='Show Cockpit package information')\n- parser.add_argument('--bridges', action='store_true', help='Show Cockpit bridges information')\n- parser.add_argument('--debug', action='store_true', help='Enable debug output (very verbose)')\n- parser.add_argument('--version', action='store_true', help='Show Cockpit version information')\n- args = parser.parse_args()\n-\n- # This is determined by who calls us\n- args.beipack = beipack\n-\n- # If we were run with --privileged then our stderr is currently being\n- # consumed by the main bridge looking for startup-related error messages.\n- # Let's switch back to the original stderr stream, which has a side-effect\n- # of indicating that our startup is more or less complete. Any errors\n- # after this point will land in the journal.\n- if args.privileged:\n- try_to_receive_stderr()\n-\n- setup_logging(debug=args.debug)\n-\n- # Special modes\n- if args.packages:\n- Packages().show()\n- return\n- elif args.version:\n- print(f'Version: {__version__}\\nProtocol: 1')\n- return\n- elif args.bridges:\n- print(json.dumps([config.__dict__ for config in Packages().get_bridge_configs()], indent=2))\n- return\n-\n- # The privileged bridge doesn't need ssh-agent, but the main one does\n- if 'SSH_AUTH_SOCK' not in os.environ and not args.privileged:\n- start_ssh_agent()\n-\n- # asyncio.run() shim for Python 3.6 support\n- run_async(run(args), debug=args.debug)\n-\n-\n-if __name__ == '__main__':\n- main()\n-'''.encode('utf-8'),\n- 'cockpit/polyfills.py': br'''# This file is part of Cockpit.\n-#\n-# Copyright (C) 2023 Red Hat, Inc.\n-#\n-# This program is free software: you can redistribute it and/or modify\n-# it under the terms of the GNU General Public License as published by\n-# the Free Software Foundation, either version 3 of the License, or\n-# (at your option) any later version.\n-#\n-# This program is distributed in the hope that it will be useful,\n-# but WITHOUT ANY WARRANTY; without even the implied warranty of\n-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n-# GNU General Public License for more details.\n-#\n-# You should have received a copy of the GNU General Public License\n-# along with this program. If not, see .\n-\n-import contextlib\n-import socket\n-\n+ return cast(obj[key])\n+ except KeyError:\n+ if default is not _empty:\n+ return default\n+ raise JsonError(obj, f\"attribute '{key}' required\") from None\n+ except JsonError as exc:\n+ target = f\"attribute '{key}'\" + (' elements:' if exc.value is not obj[key] else ':')\n+ raise JsonError(obj, f\"{target} {exc!s}\") from exc\n \n-def install():\n- \"\"\"Add shims for older Python versions\"\"\"\n \n- # introduced in 3.9\n- if not hasattr(socket, 'recv_fds'):\n- import array\n+def get_bool(obj: JsonObject, key: str, default: Union[DT, _Empty] = _empty) -> Union[DT, bool]:\n+ return _get(obj, lambda v: typechecked(v, bool), key, default)\n \n- import _socket\n \n- def recv_fds(sock, bufsize, maxfds, flags=0):\n- fds = array.array(\"i\")\n- msg, ancdata, flags, addr = sock.recvmsg(bufsize, _socket.CMSG_LEN(maxfds * fds.itemsize))\n- for cmsg_level, cmsg_type, cmsg_data in ancdata:\n- if (cmsg_level == _socket.SOL_SOCKET and cmsg_type == _socket.SCM_RIGHTS):\n- fds.frombytes(cmsg_data[:len(cmsg_data) - (len(cmsg_data) % fds.itemsize)])\n- return msg, list(fds), flags, addr\n+def get_int(obj: JsonObject, key: str, default: Union[DT, _Empty] = _empty) -> Union[DT, int]:\n+ return _get(obj, lambda v: typechecked(v, int), key, default)\n \n- socket.recv_fds = recv_fds\n \n- # introduced in 3.7\n- if not hasattr(contextlib, 'AsyncExitStack'):\n- class AsyncExitStack:\n- async def __aenter__(self):\n- self.cms = []\n- return self\n+def get_str(obj: JsonObject, key: str, default: Union[DT, _Empty] = _empty) -> Union[DT, str]:\n+ return _get(obj, lambda v: typechecked(v, str), key, default)\n \n- async def enter_async_context(self, cm):\n- result = await cm.__aenter__()\n- self.cms.append(cm)\n- return result\n \n- async def __aexit__(self, exc_type, exc_value, traceback):\n- for cm in self.cms:\n- cm.__aexit__(exc_type, exc_value, traceback)\n+def get_str_or_none(obj: JsonObject, key: str, default: Optional[str]) -> Optional[str]:\n+ return _get(obj, lambda v: None if v is None else typechecked(v, str), key, default)\n \n- contextlib.AsyncExitStack = AsyncExitStack\n-''',\n- 'cockpit/remote.py': r'''# This file is part of Cockpit.\n-#\n-# Copyright (C) 2022 Red Hat, Inc.\n-#\n-# This program is free software: you can redistribute it and/or modify\n-# it under the terms of the GNU General Public License as published by\n-# the Free Software Foundation, either version 3 of the License, or\n-# (at your option) any later version.\n-#\n-# This program is distributed in the hope that it will be useful,\n-# but WITHOUT ANY WARRANTY; without even the implied warranty of\n-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n-# GNU General Public License for more details.\n-#\n-# You should have received a copy of the GNU General Public License\n-# along with this program. If not, see .\n \n-import getpass\n-import logging\n-import re\n-import socket\n-from typing import Dict, List, Optional, Tuple\n+def get_dict(obj: JsonObject, key: str, default: Union[DT, _Empty] = _empty) -> Union[DT, JsonObject]:\n+ return _get(obj, lambda v: typechecked(v, dict), key, default)\n \n-from cockpit._vendor import ferny\n \n-from .jsonutil import JsonObject, JsonValue, get_str, get_str_or_none\n-from .peer import Peer, PeerError\n-from .router import Router, RoutingRule\n+def get_object(\n+ obj: JsonObject,\n+ key: str,\n+ constructor: Callable[[JsonObject], T],\n+ default: Union[DT, _Empty] = _empty\n+) -> Union[DT, T]:\n+ return _get(obj, lambda v: constructor(typechecked(v, dict)), key, default)\n \n-logger = logging.getLogger(__name__)\n \n+def get_strv(obj: JsonObject, key: str, default: Union[DT, _Empty] = _empty) -> Union[DT, Sequence[str]]:\n+ def as_strv(value: JsonValue) -> Sequence[str]:\n+ return tuple(typechecked(item, str) for item in typechecked(value, list))\n+ return _get(obj, as_strv, key, default)\n \n-class PasswordResponder(ferny.AskpassHandler):\n- PASSPHRASE_RE = re.compile(r\"Enter passphrase for key '(.*)': \")\n \n- password: Optional[str]\n+def get_enum(\n+ obj: JsonObject, key: str, choices: Container[str], default: Union[DT, _Empty] = _empty\n+) -> Union[DT, str]:\n+ def as_choice(value: JsonValue) -> str:\n+ # mypy can't do `__eq__()`-based type narrowing...\n+ # https://github.com/python/mypy/issues/17101\n+ if isinstance(value, str) and value in choices:\n+ return value\n+ raise JsonError(value, f'invalid value \"{value}\" not in {choices}')\n+ return _get(obj, as_choice, key, default)\n \n- hostkeys_seen: List[Tuple[str, str, str, str, str]]\n- error_message: Optional[str]\n- password_attempts: int\n \n- def __init__(self, password: Optional[str]):\n- self.password = password\n+def get_objv(obj: JsonObject, key: str, constructor: Callable[[JsonObject], T]) -> Union[DT, Sequence[T]]:\n+ def as_objv(value: JsonValue) -> Sequence[T]:\n+ return tuple(constructor(typechecked(item, dict)) for item in typechecked(value, list))\n+ return _get(obj, as_objv, key, ())\n \n- self.hostkeys_seen = []\n- self.error_message = None\n- self.password_attempts = 0\n \n- async def do_hostkey(self, reason: str, host: str, algorithm: str, key: str, fingerprint: str) -> bool:\n- self.hostkeys_seen.append((reason, host, algorithm, key, fingerprint))\n- return False\n+def create_object(message: 'JsonObject | None', kwargs: JsonObject) -> JsonObject:\n+ \"\"\"Constructs a JSON object based on message and kwargs.\n \n- async def do_askpass(self, messages: str, prompt: str, hint: str) -> Optional[str]:\n- logger.debug('Got askpass(%s): %s', hint, prompt)\n+ If only message is given, it is returned, unmodified. If message is None,\n+ it is equivalent to an empty dictionary. A copy is always made.\n \n- match = PasswordResponder.PASSPHRASE_RE.fullmatch(prompt)\n- if match is not None:\n- # We never unlock private keys \u2014 we rather need to throw a\n- # specially-formatted error message which will cause the frontend\n- # to load the named key into the agent for us and try again.\n- path = match.group(1)\n- logger.debug(\"This is a passphrase request for %s, but we don't do those. Abort.\", path)\n- self.error_message = f'locked identity: {path}'\n- return None\n+ If kwargs are present, then any underscore ('_') present in a key name is\n+ rewritten to a dash ('-'). This is intended to bridge between the required\n+ Python syntax when providing kwargs and idiomatic JSON (which uses '-' for\n+ attributes). These values override values in message.\n \n- assert self.password is not None\n- assert self.password_attempts == 0\n- self.password_attempts += 1\n- return self.password\n+ The idea is that `message` should be used for passing data along, and\n+ kwargs used for data originating at a given call site, possibly including\n+ modifications to an original message.\n+ \"\"\"\n+ result = dict(message or {})\n \n+ for key, value in kwargs.items():\n+ # rewrite '_' (necessary in Python syntax kwargs list) to '-' (idiomatic JSON)\n+ json_key = key.replace('_', '-')\n+ result[json_key] = value\n \n-class SshPeer(Peer):\n- session: Optional[ferny.Session] = None\n- host: str\n- user: Optional[str]\n- password: Optional[str]\n- private: bool\n+ return result\n \n- async def do_connect_transport(self) -> None:\n- assert self.session is not None\n- logger.debug('Starting ssh session user=%s, host=%s, private=%s', self.user, self.host, self.private)\n \n- basename, colon, portstr = self.host.rpartition(':')\n- if colon and portstr.isdigit():\n- host = basename\n- port = int(portstr)\n+def json_merge_patch(current: JsonObject, patch: JsonObject) -> JsonObject:\n+ \"\"\"Perform a JSON merge patch (RFC 7396) using 'current' and 'patch'.\n+ Neither of the original dictionaries is modified \u2014 the result is returned.\n+ \"\"\"\n+ # Always take a copy ('result') \u2014 we never modify the input ('current')\n+ result = dict(current)\n+ for key, patch_value in patch.items():\n+ if isinstance(patch_value, Mapping):\n+ current_value = current.get(key, None)\n+ if not isinstance(current_value, Mapping):\n+ current_value = {}\n+ result[key] = json_merge_patch(current_value, patch_value)\n+ elif patch_value is not None:\n+ result[key] = patch_value\n else:\n- host = self.host\n- port = None\n-\n- responder = PasswordResponder(self.password)\n- options = {\"StrictHostKeyChecking\": 'yes'}\n+ result.pop(key, None)\n \n- if self.password is not None:\n- options.update(NumberOfPasswordPrompts='1')\n- else:\n- options.update(PasswordAuthentication=\"no\", KbdInteractiveAuthentication=\"no\")\n+ return result\n \n- try:\n- await self.session.connect(host, login_name=self.user, port=port,\n- handle_host_key=self.private, options=options,\n- interaction_responder=responder)\n- except (OSError, socket.gaierror) as exc:\n- logger.debug('connecting to host %s failed: %s', host, exc)\n- raise PeerError('no-host', error='no-host', message=str(exc)) from exc\n \n- except ferny.SshHostKeyError as exc:\n- if responder.hostkeys_seen:\n- # If we saw a hostkey then we can issue a detailed error message\n- # containing the key that would need to be accepted. That will\n- # cause the front-end to present a dialog.\n- _reason, host, algorithm, key, fingerprint = responder.hostkeys_seen[0]\n- error_args = {'host-key': f'{host} {algorithm} {key}', 'host-fingerprint': fingerprint}\n- else:\n- error_args = {}\n+def json_merge_and_filter_patch(current: JsonDict, patch: JsonDict) -> None:\n+ \"\"\"Perform a JSON merge patch (RFC 7396) modifying 'current' with 'patch'.\n+ Also modifies 'patch' to remove redundant operations.\n+ \"\"\"\n+ for key, patch_value in tuple(patch.items()):\n+ current_value = current.get(key, None)\n \n- if isinstance(exc, ferny.SshChangedHostKeyError):\n- error = 'invalid-hostkey'\n- elif self.private:\n- error = 'unknown-hostkey'\n+ if isinstance(patch_value, dict):\n+ if not isinstance(current_value, dict):\n+ current[key] = current_value = {}\n+ json_merge_and_filter_patch(current_value, patch_value)\n else:\n- # non-private session case. throw a generic error.\n- error = 'unknown-host'\n-\n- logger.debug('SshPeer got a %s %s; private %s, seen hostkeys %r; raising %s with extra args %r',\n- type(exc), exc, self.private, responder.hostkeys_seen, error, error_args)\n- raise PeerError(error, error_args, error=error, auth_method_results={}) from exc\n-\n- except ferny.SshAuthenticationError as exc:\n- logger.debug('authentication to host %s failed: %s', host, exc)\n-\n- results = dict.fromkeys(exc.methods, \"not-provided\")\n- if 'password' in results and self.password is not None:\n- if responder.password_attempts == 0:\n- results['password'] = 'not-tried'\n- else:\n- results['password'] = 'denied'\n-\n- raise PeerError('authentication-failed',\n- error=responder.error_message or 'authentication-failed',\n- auth_method_results=results) from exc\n-\n- except ferny.SshError as exc:\n- logger.debug('unknown failure connecting to host %s: %s', host, exc)\n- raise PeerError('internal-error', message=str(exc)) from exc\n-\n- args = self.session.wrap_subprocess_args(['cockpit-bridge'])\n- await self.spawn(args, [])\n-\n- def do_kill(self, host: 'str | None', group: 'str | None', message: JsonObject) -> None:\n- if host == self.host:\n- self.close()\n- elif host is None:\n- super().do_kill(host, group, message)\n-\n- def do_authorize(self, message: JsonObject) -> None:\n- if get_str(message, 'challenge').startswith('plain1:'):\n- cookie = get_str(message, 'cookie')\n- self.write_control(command='authorize', cookie=cookie, response=self.password or '')\n- self.password = None # once is enough...\n-\n- def do_superuser_init_done(self) -> None:\n- self.password = None\n-\n- def __init__(self, router: Router, host: str, user: Optional[str], options: JsonObject, *, private: bool) -> None:\n- super().__init__(router)\n- self.host = host\n- self.user = user\n- self.password = get_str(options, 'password', None)\n- self.private = private\n-\n- self.session = ferny.Session()\n-\n- superuser: JsonValue\n- init_superuser = get_str_or_none(options, 'init-superuser', None)\n- if init_superuser in (None, 'none'):\n- superuser = False\n- else:\n- superuser = {'id': init_superuser}\n-\n- self.start_in_background(init_host=host, superuser=superuser)\n-\n-\n-class HostRoutingRule(RoutingRule):\n- remotes: Dict[Tuple[str, Optional[str], Optional[str]], Peer]\n-\n- def __init__(self, router):\n- super().__init__(router)\n- self.remotes = {}\n-\n- def apply_rule(self, options: JsonObject) -> Optional[Peer]:\n- assert self.router is not None\n- assert self.router.init_host is not None\n-\n- host = get_str(options, 'host', self.router.init_host)\n- if host == self.router.init_host:\n- return None\n-\n- user = get_str(options, 'user', None)\n- # HACK: the front-end relies on this for tracking connections without an explicit user name;\n- # the user will then be determined by SSH (`User` in the config or the current user)\n- # See cockpit_router_normalize_host_params() in src/bridge/cockpitrouter.c\n- if user == getpass.getuser():\n- user = None\n- if not user:\n- user_from_host, _, _ = host.rpartition('@')\n- user = user_from_host or None # avoid ''\n-\n- if get_str(options, 'session', None) == 'private':\n- nonce = get_str(options, 'channel')\n+ json_merge_and_filter_patch(current_value, patch_value)\n+ if not patch_value:\n+ del patch[key]\n+ elif current_value == patch_value:\n+ del patch[key]\n+ elif patch_value is not None:\n+ current[key] = patch_value\n else:\n- nonce = None\n-\n- assert isinstance(host, str)\n- assert user is None or isinstance(user, str)\n- assert nonce is None or isinstance(nonce, str)\n-\n- key = host, user, nonce\n-\n- logger.debug('Request for channel %s is remote.', options)\n- logger.debug('key=%s', key)\n-\n- if key not in self.remotes:\n- logger.debug('%s is not among the existing remotes %s. Opening a new connection.', key, self.remotes)\n- peer = SshPeer(self.router, host, user, options, private=nonce is not None)\n- peer.add_done_callback(lambda: self.remotes.__delitem__(key))\n- self.remotes[key] = peer\n-\n- return self.remotes[key]\n-\n- def shutdown(self):\n- for peer in set(self.remotes.values()):\n- peer.close()\n+ del current[key]\n '''.encode('utf-8'),\n- 'cockpit/beipack.py': br'''# This file is part of Cockpit.\n-#\n-# Copyright (C) 2023 Red Hat, Inc.\n-#\n-# This program is free software: you can redistribute it and/or modify\n-# it under the terms of the GNU General Public License as published by\n-# the Free Software Foundation, either version 3 of the License, or\n-# (at your option) any later version.\n-#\n-# This program is distributed in the hope that it will be useful,\n-# but WITHOUT ANY WARRANTY; without even the implied warranty of\n-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n-# GNU General Public License for more details.\n-#\n-# You should have received a copy of the GNU General Public License\n-# along with this program. If not, see .\n-\n-import logging\n-import lzma\n-from typing import List, Sequence, Tuple\n-\n-from cockpit._vendor import ferny\n-from cockpit._vendor.bei import beipack\n-\n-from .data import read_cockpit_data_file\n-from .peer import Peer, PeerError\n-\n-logger = logging.getLogger(__name__)\n-\n-\n-def get_bridge_beipack_xz() -> Tuple[str, bytes]:\n- try:\n- bridge_beipack_xz = read_cockpit_data_file('cockpit-bridge.beipack.xz')\n- logger.debug('Got pre-built cockpit-bridge.beipack.xz')\n- except FileNotFoundError:\n- logger.debug('Pre-built cockpit-bridge.beipack.xz; building our own.')\n- # beipack ourselves\n- cockpit_contents = beipack.collect_module('cockpit', recursive=True)\n- bridge_beipack = beipack.pack(cockpit_contents, entrypoint='cockpit.bridge:main', args='beipack=True')\n- bridge_beipack_xz = lzma.compress(bridge_beipack.encode())\n- logger.debug(' ... done!')\n-\n- return 'cockpit/data/cockpit-bridge.beipack.xz', bridge_beipack_xz\n-\n-\n-class BridgeBeibootHelper(ferny.InteractionHandler):\n- # ferny.InteractionHandler ClassVar\n- commands = ['beiboot.provide', 'beiboot.exc']\n-\n- peer: Peer\n- payload: bytes\n- steps: Sequence[Tuple[str, Sequence[object]]]\n-\n- def __init__(self, peer: Peer, args: Sequence[str] = ()) -> None:\n- filename, payload = get_bridge_beipack_xz()\n-\n- self.peer = peer\n- self.payload = payload\n- self.steps = (('boot_xz', (filename, len(payload), tuple(args))),)\n-\n- async def run_command(self, command: str, args: Tuple, fds: List[int], stderr: str) -> None:\n- logger.debug('Got ferny request %s %s %s %s', command, args, fds, stderr)\n- if command == 'beiboot.provide':\n- try:\n- size, = args\n- assert size == len(self.payload)\n- except (AssertionError, ValueError) as exc:\n- raise PeerError('internal-error', message=f'ferny interaction error {exc!s}') from exc\n-\n- assert self.peer.transport is not None\n- logger.debug('Writing %d bytes of payload', len(self.payload))\n- self.peer.transport.write(self.payload)\n- elif command == 'beiboot.exc':\n- raise PeerError('internal-error', message=f'Remote exception: {args[0]}')\n- else:\n- raise PeerError('internal-error', message=f'Unexpected ferny interaction command {command}')\n-''',\n 'cockpit/protocol.py': br'''# This file is part of Cockpit.\n #\n # Copyright (C) 2022 Red Hat, Inc.\n #\n # This program is free software: you can redistribute it and/or modify\n # it under the terms of the GNU General Public License as published by\n # the Free Software Foundation, either version 3 of the License, or\n@@ -2754,1484 +3392,91 @@\n \n if self.authorizations is None or cookie not in self.authorizations:\n logger.warning('no matching authorize request')\n return\n \n self.authorizations[cookie].set_result(response)\n ''',\n- 'cockpit/packages.py': br'''# This file is part of Cockpit.\n-#\n-# Copyright (C) 2022 Red Hat, Inc.\n-#\n-# This program is free software: you can redistribute it and/or modify\n-# it under the terms of the GNU General Public License as published by\n-# the Free Software Foundation, either version 3 of the License, or\n-# (at your option) any later version.\n-#\n-# This program is distributed in the hope that it will be useful,\n-# but WITHOUT ANY WARRANTY; without even the implied warranty of\n-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n-# GNU General Public License for more details.\n-#\n-# You should have received a copy of the GNU General Public License\n-# along with this program. If not, see .\n-\n-import collections\n-import contextlib\n-import functools\n-import gzip\n-import io\n-import itertools\n-import json\n-import logging\n-import mimetypes\n-import os\n-import re\n-import shutil\n-from pathlib import Path\n-from typing import (\n- BinaryIO,\n- Callable,\n- ClassVar,\n- Dict,\n- Iterable,\n- List,\n- NamedTuple,\n- Optional,\n- Pattern,\n- Sequence,\n- Tuple,\n- TypeVar,\n-)\n-\n-from cockpit._vendor.systemd_ctypes import bus\n-\n-from . import config\n-from ._version import __version__\n-from .jsonutil import (\n- JsonError,\n- JsonObject,\n- JsonValue,\n- get_bool,\n- get_dict,\n- get_int,\n- get_objv,\n- get_str,\n- get_strv,\n- json_merge_patch,\n- typechecked,\n-)\n-\n-logger = logging.getLogger(__name__)\n-\n-\n-# In practice, this is going to get called over and over again with exactly the\n-# same list. Let's try to cache the result.\n-@functools.lru_cache()\n-def parse_accept_language(accept_language: str) -> Sequence[str]:\n- \"\"\"Parse the Accept-Language header, if it exists.\n-\n- Returns an ordered list of languages, with fallbacks inserted, and\n- truncated to the position where 'en' would have otherwise appeared, if\n- applicable.\n-\n- https://tools.ietf.org/html/rfc7231#section-5.3.5\n- https://datatracker.ietf.org/doc/html/rfc4647#section-3.4\n- \"\"\"\n-\n- logger.debug('parse_accept_language(%r)', accept_language)\n- locales_with_q = []\n- for entry in accept_language.split(','):\n- entry = entry.strip().lower()\n- logger.debug(' entry %r', entry)\n- locale, _, qstr = entry.partition(';q=')\n- try:\n- q = float(qstr or 1.0)\n- except ValueError:\n- continue # ignore malformed entry\n-\n- while locale:\n- logger.debug(' adding %r q=%r', locale, q)\n- locales_with_q.append((locale, q))\n- # strip off '-detail' suffixes until there's nothing left\n- locale, _, _region = locale.rpartition('-')\n-\n- # Sort the list by highest q value. Otherwise, this is a stable sort.\n- locales_with_q.sort(key=lambda pair: pair[1], reverse=True)\n- logger.debug(' sorted list is %r', locales_with_q)\n-\n- # If we have 'en' anywhere in our list, ignore it and all items after it.\n- # This will result in us getting an untranslated (ie: English) version if\n- # none of the more-preferred languages are found, which is what we want.\n- # We also take the chance to drop duplicate items. Note: both of these\n- # things need to happen after sorting.\n- results = []\n- for locale, _q in locales_with_q:\n- if locale == 'en':\n- break\n- if locale not in results:\n- results.append(locale)\n-\n- logger.debug(' results list is %r', results)\n- return tuple(results)\n-\n-\n-def sortify_version(version: str) -> str:\n- \"\"\"Convert a version string to a form that can be compared\"\"\"\n- # 0-pad each numeric component. Only supports numeric versions like 1.2.3.\n- return '.'.join(part.zfill(8) for part in version.split('.'))\n-\n-\n-@functools.lru_cache()\n-def get_libexecdir() -> str:\n- \"\"\"Detect libexecdir on current machine\n-\n- This only works for systems which have cockpit-ws installed.\n- \"\"\"\n- for candidate in ['/usr/local/libexec', '/usr/libexec', '/usr/local/lib/cockpit', '/usr/lib/cockpit']:\n- if os.path.exists(os.path.join(candidate, 'cockpit-askpass')):\n- return candidate\n- else:\n- logger.warning('Could not detect libexecdir')\n- # give readable error messages\n- return '/nonexistent/libexec'\n-\n-\n-# HACK: Type narrowing over Union types is not supported in the general case,\n-# but this works for the case we care about: knowing that when we pass in an\n-# JsonObject, we'll get an JsonObject back.\n-J = TypeVar('J', JsonObject, JsonValue)\n-\n-\n-def patch_libexecdir(obj: J) -> J:\n- if isinstance(obj, str):\n- if '${libexecdir}/cockpit-askpass' in obj:\n- # extra-special case: we handle this internally\n- abs_askpass = shutil.which('cockpit-askpass')\n- if abs_askpass is not None:\n- return obj.replace('${libexecdir}/cockpit-askpass', abs_askpass)\n- return obj.replace('${libexecdir}', get_libexecdir())\n- elif isinstance(obj, dict):\n- return {key: patch_libexecdir(value) for key, value in obj.items()}\n- elif isinstance(obj, list):\n- return [patch_libexecdir(item) for item in obj]\n- else:\n- return obj\n-\n-\n-# A document is a binary stream with a Content-Type, optional Content-Encoding,\n-# and optional Content-Security-Policy\n-class Document(NamedTuple):\n- data: BinaryIO\n- content_type: str\n- content_encoding: Optional[str] = None\n- content_security_policy: Optional[str] = None\n-\n-\n-class PackagesListener:\n- def packages_loaded(self) -> None:\n- \"\"\"Called when the packages have been reloaded\"\"\"\n-\n-\n-class BridgeConfig(dict, JsonObject):\n- def __init__(self, value: JsonObject):\n- super().__init__(value)\n-\n- self.label = get_str(self, 'label', None)\n-\n- self.privileged = get_bool(self, 'privileged', default=False)\n- self.match = get_dict(self, 'match', {})\n- if not self.privileged and not self.match:\n- raise JsonError(value, 'must have match rules or be privileged')\n-\n- self.environ = get_strv(self, 'environ', ())\n- self.spawn = get_strv(self, 'spawn')\n- if not self.spawn:\n- raise JsonError(value, 'spawn vector must be non-empty')\n-\n- self.name = self.label or self.spawn[0]\n-\n-\n-class Condition:\n- def __init__(self, value: JsonObject):\n- try:\n- (self.name, self.value), = value.items()\n- except ValueError as exc:\n- raise JsonError(value, 'must contain exactly one key/value pair') from exc\n-\n-\n-class Manifest(dict, JsonObject):\n- # Skip version check when running out of the git checkout (__version__ is None)\n- COCKPIT_VERSION = __version__ and sortify_version(__version__)\n-\n- def __init__(self, path: Path, value: JsonObject):\n- super().__init__(value)\n- self.path = path\n- self.name = get_str(self, 'name', self.path.name)\n- self.bridges = get_objv(self, 'bridges', BridgeConfig)\n- self.priority = get_int(self, 'priority', 1)\n- self.csp = get_str(self, 'content-security-policy', '')\n- self.conditions = get_objv(self, 'conditions', Condition)\n-\n- # Skip version check when running out of the git checkout (COCKPIT_VERSION is None)\n- if self.COCKPIT_VERSION is not None:\n- requires = get_dict(self, 'requires', {})\n- for name, version in requires.items():\n- if name != 'cockpit':\n- raise JsonError(name, 'non-cockpit requirement listed')\n- if sortify_version(typechecked(version, str)) > self.COCKPIT_VERSION:\n- raise JsonError(version, f'required cockpit version ({version}) not met')\n-\n-\n-class Package:\n- # For po{,.manifest}.js files, the interesting part is the locale name\n- PO_JS_RE: ClassVar[Pattern] = re.compile(r'(po|po\\.manifest)\\.([^.]+)\\.js(\\.gz)?')\n-\n- # immutable after __init__\n- manifest: Manifest\n- name: str\n- path: Path\n- priority: int\n-\n- # computed later\n- translations: Optional[Dict[str, Dict[str, str]]] = None\n- files: Optional[Dict[str, str]] = None\n-\n- def __init__(self, manifest: Manifest):\n- self.manifest = manifest\n- self.name = manifest.name\n- self.path = manifest.path\n- self.priority = manifest.priority\n-\n- def ensure_scanned(self) -> None:\n- \"\"\"Ensure that the package has been scanned.\n-\n- This allows us to defer scanning the files of the package until we know\n- that we'll actually use it.\n- \"\"\"\n-\n- if self.files is not None:\n- return\n-\n- self.files = {}\n- self.translations = {'po.js': {}, 'po.manifest.js': {}}\n-\n- for file in self.path.rglob('*'):\n- name = str(file.relative_to(self.path))\n- if name in ['.', '..', 'manifest.json']:\n- continue\n-\n- po_match = Package.PO_JS_RE.fullmatch(name)\n- if po_match:\n- basename = po_match.group(1)\n- locale = po_match.group(2)\n- # Accept-Language is case-insensitive and uses '-' to separate variants\n- lower_locale = locale.lower().replace('_', '-')\n-\n- logger.debug('Adding translation %r %r -> %r', basename, lower_locale, name)\n- self.translations[f'{basename}.js'][lower_locale] = name\n- else:\n- # strip out trailing '.gz' components\n- basename = re.sub('.gz$', '', name)\n- logger.debug('Adding content %r -> %r', basename, name)\n- self.files[basename] = name\n-\n- # If we see a filename like `x.min.js` we want to also offer it\n- # at `x.js`, but only if `x.js(.gz)` itself is not present.\n- # Note: this works for both the case where we found the `x.js`\n- # first (it's already in the map) and also if we find it second\n- # (it will be replaced in the map by the line just above).\n- # See https://github.com/cockpit-project/cockpit/pull/19716\n- self.files.setdefault(basename.replace('.min.', '.'), name)\n-\n- # support old cockpit-po-plugin which didn't write po.manifest.??.js\n- if not self.translations['po.manifest.js']:\n- self.translations['po.manifest.js'] = self.translations['po.js']\n-\n- def get_content_security_policy(self) -> str:\n- policy = {\n- \"default-src\": \"'self'\",\n- \"connect-src\": \"'self'\",\n- \"form-action\": \"'self'\",\n- \"base-uri\": \"'self'\",\n- \"object-src\": \"'none'\",\n- \"font-src\": \"'self' data:\",\n- \"img-src\": \"'self' data:\",\n- }\n-\n- for item in self.manifest.csp.split(';'):\n- item = item.strip()\n- if item:\n- key, _, value = item.strip().partition(' ')\n- policy[key] = value\n-\n- return ' '.join(f'{k} {v};' for k, v in policy.items()) + ' block-all-mixed-content'\n-\n- def load_file(self, filename: str) -> Document:\n- content_type, content_encoding = mimetypes.guess_type(filename)\n- content_security_policy = None\n-\n- if content_type is None:\n- content_type = 'text/plain'\n- elif content_type.startswith('text/html'):\n- content_security_policy = self.get_content_security_policy()\n-\n- path = self.path / filename\n- logger.debug(' loading data from %s', path)\n-\n- return Document(path.open('rb'), content_type, content_encoding, content_security_policy)\n-\n- def load_translation(self, path: str, locales: Sequence[str]) -> Document:\n- self.ensure_scanned()\n- assert self.translations is not None\n-\n- # First match wins\n- for locale in locales:\n- with contextlib.suppress(KeyError):\n- return self.load_file(self.translations[path][locale])\n-\n- # We prefer to return an empty document than 404 in order to avoid\n- # errors in the console when a translation can't be found\n- return Document(io.BytesIO(), 'text/javascript')\n-\n- def load_path(self, path: str, headers: JsonObject) -> Document:\n- self.ensure_scanned()\n- assert self.files is not None\n- assert self.translations is not None\n-\n- if path in self.translations:\n- locales = parse_accept_language(get_str(headers, 'Accept-Language', ''))\n- return self.load_translation(path, locales)\n- else:\n- return self.load_file(self.files[path])\n-\n-\n-class PackagesLoader:\n- CONDITIONS: ClassVar[Dict[str, Callable[[str], bool]]] = {\n- 'path-exists': os.path.exists,\n- 'path-not-exists': lambda p: not os.path.exists(p),\n- }\n-\n- @classmethod\n- def get_xdg_data_dirs(cls) -> Iterable[str]:\n- try:\n- yield os.environ['XDG_DATA_HOME']\n- except KeyError:\n- yield os.path.expanduser('~/.local/share')\n-\n- try:\n- yield from os.environ['XDG_DATA_DIRS'].split(':')\n- except KeyError:\n- yield from ('/usr/local/share', '/usr/share')\n-\n- @classmethod\n- def patch_manifest(cls, manifest: JsonObject, parent: Path) -> JsonObject:\n- override_files = [\n- parent / 'override.json',\n- config.lookup_config(f'{parent.name}.override.json'),\n- config.DOT_CONFIG_COCKPIT / f'{parent.name}.override.json',\n- ]\n-\n- for override_file in override_files:\n- try:\n- override: JsonValue = json.loads(override_file.read_bytes())\n- except FileNotFoundError:\n- continue\n- except json.JSONDecodeError as exc:\n- # User input error: report a warning\n- logger.warning('%s: %s', override_file, exc)\n-\n- if not isinstance(override, dict):\n- logger.warning('%s: override file is not a dictionary', override_file)\n- continue\n-\n- manifest = json_merge_patch(manifest, override)\n-\n- return patch_libexecdir(manifest)\n-\n- @classmethod\n- def load_manifests(cls) -> Iterable[Manifest]:\n- for datadir in cls.get_xdg_data_dirs():\n- logger.debug(\"Scanning for manifest files under %s\", datadir)\n- for file in Path(datadir).glob('cockpit/*/manifest.json'):\n- logger.debug(\"Considering file %s\", file)\n- try:\n- manifest = json.loads(file.read_text())\n- except json.JSONDecodeError as exc:\n- logger.error(\"%s: %s\", file, exc)\n- continue\n- if not isinstance(manifest, dict):\n- logger.error(\"%s: json document isn't an object\", file)\n- continue\n-\n- parent = file.parent\n- manifest = cls.patch_manifest(manifest, parent)\n- try:\n- yield Manifest(parent, manifest)\n- except JsonError as exc:\n- logger.warning('%s %s', file, exc)\n-\n- def check_condition(self, condition: str, value: object) -> bool:\n- check_fn = self.CONDITIONS[condition]\n-\n- # All known predicates currently only work on strings\n- if not isinstance(value, str):\n- return False\n-\n- return check_fn(value)\n-\n- def check_conditions(self, manifest: Manifest) -> bool:\n- for condition in manifest.conditions:\n- try:\n- okay = self.check_condition(condition.name, condition.value)\n- except KeyError:\n- # do *not* ignore manifests with unknown predicates, for forward compatibility\n- logger.warning(' %s: ignoring unknown predicate in manifest: %s', manifest.path, condition.name)\n- continue\n-\n- if not okay:\n- logger.debug(' hiding package %s as its %s condition is not met', manifest.path, condition)\n- return False\n-\n- return True\n-\n- def load_packages(self) -> Iterable[Tuple[str, Package]]:\n- logger.debug('Scanning for available package manifests:')\n- # Sort all available packages into buckets by to their claimed name\n- names: Dict[str, List[Manifest]] = collections.defaultdict(list)\n- for manifest in self.load_manifests():\n- logger.debug(' %s/manifest.json', manifest.path)\n- names[manifest.name].append(manifest)\n- logger.debug('done.')\n-\n- logger.debug('Selecting packages to serve:')\n- for name, candidates in names.items():\n- # For each package name, iterate the candidates in descending\n- # priority order and select the first one which passes all checks\n- for candidate in sorted(candidates, key=lambda manifest: manifest.priority, reverse=True):\n- try:\n- if self.check_conditions(candidate):\n- logger.debug(' creating package %s -> %s', name, candidate.path)\n- yield name, Package(candidate)\n- break\n- except JsonError:\n- logger.warning(' %s: ignoring package with invalid manifest file', candidate.path)\n-\n- logger.debug(' ignoring %s: unmet conditions', candidate.path)\n- logger.debug('done.')\n-\n-\n-class Packages(bus.Object, interface='cockpit.Packages'):\n- loader: PackagesLoader\n- listener: Optional[PackagesListener]\n- packages: Dict[str, Package]\n- saw_first_reload_hint: bool\n-\n- def __init__(self, listener: Optional[PackagesListener] = None, loader: Optional[PackagesLoader] = None):\n- self.listener = listener\n- self.loader = loader or PackagesLoader()\n- self.load()\n-\n- # Reloading the Shell in the browser should reload the\n- # packages. This is implemented by having the Shell call\n- # reload_hint whenever it starts. The first call of this\n- # method in each session is ignored so that packages are not\n- # loaded twice right after logging in.\n- #\n- self.saw_first_reload_hint = False\n-\n- def load(self) -> None:\n- self.packages = dict(self.loader.load_packages())\n- self.manifests = json.dumps({name: dict(package.manifest) for name, package in self.packages.items()})\n- logger.debug('Packages loaded: %s', list(self.packages))\n-\n- def show(self):\n- for name in sorted(self.packages):\n- package = self.packages[name]\n- menuitems = []\n- for entry in itertools.chain(\n- package.manifest.get('menu', {}).values(),\n- package.manifest.get('tools', {}).values()):\n- with contextlib.suppress(KeyError):\n- menuitems.append(entry['label'])\n- print(f'{name:20} {\", \".join(menuitems):40} {package.path}')\n-\n- def get_bridge_configs(self) -> Sequence[BridgeConfig]:\n- def yield_configs():\n- for package in sorted(self.packages.values(), key=lambda package: -package.priority):\n- yield from package.manifest.bridges\n- return tuple(yield_configs())\n-\n- # D-Bus Interface\n- manifests = bus.Interface.Property('s', value=\"{}\")\n-\n- @bus.Interface.Method()\n- def reload(self):\n- self.load()\n- if self.listener is not None:\n- self.listener.packages_loaded()\n-\n- @bus.Interface.Method()\n- def reload_hint(self):\n- if self.saw_first_reload_hint:\n- self.reload()\n- self.saw_first_reload_hint = True\n-\n- def load_manifests_js(self, headers: JsonObject) -> Document:\n- logger.debug('Serving /manifests.js')\n-\n- chunks: List[bytes] = []\n-\n- # Send the translations required for the manifest files, from each package\n- locales = parse_accept_language(get_str(headers, 'Accept-Language', ''))\n- for name, package in self.packages.items():\n- if name in ['static', 'base1']:\n- continue\n-\n- # find_translation will always find at least 'en'\n- translation = package.load_translation('po.manifest.js', locales)\n- with translation.data:\n- if translation.content_encoding == 'gzip':\n- data = gzip.decompress(translation.data.read())\n- else:\n- data = translation.data.read()\n-\n- chunks.append(data)\n-\n- chunks.append(b\"\"\"\n- (function (root, data) {\n- if (typeof define === 'function' && define.amd) {\n- define(data);\n- }\n-\n- if (typeof cockpit === 'object') {\n- cockpit.manifests = data;\n- } else {\n- root.manifests = data;\n- }\n- }(this, \"\"\" + self.manifests.encode() + b\"\"\"))\"\"\")\n-\n- return Document(io.BytesIO(b'\\n'.join(chunks)), 'text/javascript')\n-\n- def load_manifests_json(self) -> Document:\n- logger.debug('Serving /manifests.json')\n- return Document(io.BytesIO(self.manifests.encode()), 'application/json')\n-\n- PATH_RE = re.compile(\n- r'/' # leading '/'\n- r'(?:([^/]+)/)?' # optional leading path component\n- r'((?:[^/]+/)*[^/]+)' # remaining path components\n- )\n-\n- def load_path(self, path: str, headers: JsonObject) -> Document:\n- logger.debug('packages: serving %s', path)\n-\n- match = self.PATH_RE.fullmatch(path)\n- if match is None:\n- raise ValueError(f'Invalid HTTP path {path}')\n- packagename, filename = match.groups()\n-\n- if packagename is not None:\n- return self.packages[packagename].load_path(filename, headers)\n- elif filename == 'manifests.js':\n- return self.load_manifests_js(headers)\n- elif filename == 'manifests.json':\n- return self.load_manifests_json()\n- else:\n- raise KeyError\n-''',\n- 'cockpit/_version.py': br'''__version__ = '316'\n-''',\n- 'cockpit/peer.py': r'''# This file is part of Cockpit.\n+ 'cockpit/beipack.py': br'''# This file is part of Cockpit.\n #\n-# Copyright (C) 2022 Red Hat, Inc.\n+# Copyright (C) 2023 Red Hat, Inc.\n #\n # This program is free software: you can redistribute it and/or modify\n # it under the terms of the GNU General Public License as published by\n # the Free Software Foundation, either version 3 of the License, or\n # (at your option) any later version.\n #\n # This program is distributed in the hope that it will be useful,\n # but WITHOUT ANY WARRANTY; without even the implied warranty of\n # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n # GNU General Public License for more details.\n #\n # You should have received a copy of the GNU General Public License\n # along with this program. If not, see .\n \n-import asyncio\n import logging\n-import os\n-from typing import Callable, List, Optional, Sequence\n-\n-from .jsonutil import JsonObject, JsonValue\n-from .packages import BridgeConfig\n-from .protocol import CockpitProblem, CockpitProtocol, CockpitProtocolError\n-from .router import Endpoint, Router, RoutingRule\n-from .transports import SubprocessProtocol, SubprocessTransport\n-\n-logger = logging.getLogger(__name__)\n-\n-\n-class PeerError(CockpitProblem):\n- pass\n-\n-\n-class PeerExited(Exception):\n- def __init__(self, exit_code: int):\n- self.exit_code = exit_code\n-\n-\n-class Peer(CockpitProtocol, SubprocessProtocol, Endpoint):\n- done_callbacks: List[Callable[[], None]]\n- init_future: Optional[asyncio.Future]\n-\n- def __init__(self, router: Router):\n- super().__init__(router)\n-\n- # All Peers start out frozen \u2014 we only unfreeze after we see the first 'init' message\n- self.freeze_endpoint()\n-\n- self.init_future = asyncio.get_running_loop().create_future()\n- self.done_callbacks = []\n-\n- # Initialization\n- async def do_connect_transport(self) -> None:\n- raise NotImplementedError\n-\n- async def spawn(self, argv: Sequence[str], env: Sequence[str], **kwargs) -> asyncio.Transport:\n- # Not actually async...\n- loop = asyncio.get_running_loop()\n- user_env = dict(e.split('=', 1) for e in env)\n- return SubprocessTransport(loop, self, argv, env=dict(os.environ, **user_env), **kwargs)\n-\n- async def start(self, init_host: Optional[str] = None, **kwargs: JsonValue) -> JsonObject:\n- \"\"\"Request that the Peer is started and connected to the router.\n-\n- Creates the transport, connects it to the protocol, and participates in\n- exchanging of init messages. If anything goes wrong, the connection\n- will be closed and an exception will be raised.\n-\n- The Peer starts out in a frozen state (ie: attempts to send messages to\n- it will initially be queued). If init_host is not None then an init\n- message is sent with the given 'host' field, plus any extra kwargs, and\n- the queue is thawed. Otherwise, the caller is responsible for sending\n- the init message and thawing the peer.\n-\n- In any case, the return value is the init message from the peer.\n- \"\"\"\n- assert self.init_future is not None\n-\n- def _connect_task_done(task: asyncio.Task) -> None:\n- assert task is connect_task\n- try:\n- task.result()\n- except asyncio.CancelledError: # we did that (below)\n- pass # we want to ignore it\n- except Exception as exc:\n- self.close(exc)\n-\n- connect_task = asyncio.create_task(self.do_connect_transport())\n- connect_task.add_done_callback(_connect_task_done)\n-\n- try:\n- # Wait for something to happen:\n- # - exception from our connection function\n- # - receiving \"init\" from the other side\n- # - receiving EOF from the other side\n- # - .close() was called\n- # - other transport exception\n- init_message = await self.init_future\n-\n- except (PeerExited, BrokenPipeError):\n- # These are fairly generic errors. PeerExited means that we observed the process exiting.\n- # BrokenPipeError means that we got EPIPE when attempting to write() to it. In both cases,\n- # the process is gone, but it's not clear why. If the connection process is still running,\n- # perhaps we'd get a better error message from it.\n- await connect_task\n- # Otherwise, re-raise\n- raise\n-\n- finally:\n- self.init_future = None\n-\n- # In any case (failure or success) make sure this is done.\n- if not connect_task.done():\n- connect_task.cancel()\n-\n- if init_host is not None:\n- logger.debug(' sending init message back, host %s', init_host)\n- # Send \"init\" back\n- self.write_control(None, command='init', version=1, host=init_host, **kwargs)\n-\n- # Thaw the queued messages\n- self.thaw_endpoint()\n-\n- return init_message\n-\n- # Background initialization\n- def start_in_background(self, init_host: Optional[str] = None, **kwargs: JsonValue) -> None:\n- def _start_task_done(task: asyncio.Task) -> None:\n- assert task is start_task\n-\n- try:\n- task.result()\n- except (OSError, PeerExited, CockpitProblem, asyncio.CancelledError):\n- pass # Those are expected. Others will throw.\n-\n- start_task = asyncio.create_task(self.start(init_host, **kwargs))\n- start_task.add_done_callback(_start_task_done)\n-\n- # Shutdown\n- def add_done_callback(self, callback: Callable[[], None]) -> None:\n- self.done_callbacks.append(callback)\n-\n- # Handling of interesting events\n- def do_superuser_init_done(self) -> None:\n- pass\n-\n- def do_authorize(self, message: JsonObject) -> None:\n- pass\n-\n- def transport_control_received(self, command: str, message: JsonObject) -> None:\n- if command == 'init' and self.init_future is not None:\n- logger.debug('Got init message with active init_future. Setting result.')\n- self.init_future.set_result(message)\n- elif command == 'authorize':\n- self.do_authorize(message)\n- elif command == 'superuser-init-done':\n- self.do_superuser_init_done()\n- else:\n- raise CockpitProtocolError(f'Received unexpected control message {command}')\n-\n- def eof_received(self) -> bool:\n- # We always expect to be the ones to close the connection, so if we get\n- # an EOF, then we consider it to be an error. This allows us to\n- # distinguish close caused by unexpected EOF (but no errno from a\n- # syscall failure) vs. close caused by calling .close() on our side.\n- # The process is still running at this point, so keep it and handle\n- # the error in process_exited().\n- logger.debug('Peer %s received unexpected EOF', self.__class__.__name__)\n- return True\n-\n- def do_closed(self, exc: Optional[Exception]) -> None:\n- logger.debug('Peer %s connection lost %s %s', self.__class__.__name__, type(exc), exc)\n-\n- if exc is None:\n- self.shutdown_endpoint(problem='terminated')\n- elif isinstance(exc, PeerExited):\n- # a common case is that the called peer does not exist\n- if exc.exit_code == 127:\n- self.shutdown_endpoint(problem='no-cockpit')\n- else:\n- self.shutdown_endpoint(problem='terminated', message=f'Peer exited with status {exc.exit_code}')\n- elif isinstance(exc, CockpitProblem):\n- self.shutdown_endpoint(exc.attrs)\n- else:\n- self.shutdown_endpoint(problem='internal-error',\n- message=f\"[{exc.__class__.__name__}] {exc!s}\")\n-\n- # If .start() is running, we need to make sure it stops running,\n- # raising the correct exception.\n- if self.init_future is not None and not self.init_future.done():\n- if exc is not None:\n- self.init_future.set_exception(exc)\n- else:\n- self.init_future.cancel()\n-\n- for callback in self.done_callbacks:\n- callback()\n-\n- def process_exited(self) -> None:\n- assert isinstance(self.transport, SubprocessTransport)\n- logger.debug('Peer %s exited, status %d', self.__class__.__name__, self.transport.get_returncode())\n- returncode = self.transport.get_returncode()\n- assert isinstance(returncode, int)\n- self.close(PeerExited(returncode))\n-\n- # Forwarding data: from the peer to the router\n- def channel_control_received(self, channel: str, command: str, message: JsonObject) -> None:\n- if self.init_future is not None:\n- raise CockpitProtocolError('Received unexpected channel control message before init')\n- self.send_channel_control(channel, command, message)\n-\n- def channel_data_received(self, channel: str, data: bytes) -> None:\n- if self.init_future is not None:\n- raise CockpitProtocolError('Received unexpected channel data before init')\n- self.send_channel_data(channel, data)\n-\n- # Forwarding data: from the router to the peer\n- def do_channel_control(self, channel: str, command: str, message: JsonObject) -> None:\n- assert self.init_future is None\n- self.write_control(message)\n-\n- def do_channel_data(self, channel: str, data: bytes) -> None:\n- assert self.init_future is None\n- self.write_channel_data(channel, data)\n-\n- def do_kill(self, host: 'str | None', group: 'str | None', message: JsonObject) -> None:\n- assert self.init_future is None\n- self.write_control(message)\n-\n- def do_close(self) -> None:\n- self.close()\n-\n-\n-class ConfiguredPeer(Peer):\n- config: BridgeConfig\n- args: Sequence[str]\n- env: Sequence[str]\n-\n- def __init__(self, router: Router, config: BridgeConfig):\n- self.config = config\n- self.args = config.spawn\n- self.env = config.environ\n- super().__init__(router)\n-\n- async def do_connect_transport(self) -> None:\n- await self.spawn(self.args, self.env)\n-\n-\n-class PeerRoutingRule(RoutingRule):\n- config: BridgeConfig\n- match: JsonObject\n- peer: Optional[Peer]\n-\n- def __init__(self, router: Router, config: BridgeConfig):\n- super().__init__(router)\n- self.config = config\n- self.match = config.match\n- self.peer = None\n-\n- def apply_rule(self, options: JsonObject) -> Optional[Peer]:\n- # Check that we match\n-\n- for key, value in self.match.items():\n- if key not in options:\n- logger.debug(' rejecting because key %s is missing', key)\n- return None\n- if value is not None and options[key] != value:\n- logger.debug(' rejecting because key %s has wrong value %s (vs %s)', key, options[key], value)\n- return None\n-\n- # Start the peer if it's not running already\n- if self.peer is None:\n- self.peer = ConfiguredPeer(self.router, self.config)\n- self.peer.add_done_callback(self.peer_closed)\n- assert self.router.init_host\n- self.peer.start_in_background(init_host=self.router.init_host)\n-\n- return self.peer\n-\n- def peer_closed(self):\n- self.peer = None\n-\n- def shutdown(self):\n- if self.peer is not None:\n- self.peer.close()\n-\n-\n-class PeersRoutingRule(RoutingRule):\n- rules: List[PeerRoutingRule] = []\n-\n- def apply_rule(self, options: JsonObject) -> Optional[Endpoint]:\n- logger.debug(' considering %d rules', len(self.rules))\n- for rule in self.rules:\n- logger.debug(' considering %s', rule.config.name)\n- endpoint = rule.apply_rule(options)\n- if endpoint is not None:\n- logger.debug(' selected')\n- return endpoint\n- logger.debug(' no peer rules matched')\n- return None\n-\n- def set_configs(self, bridge_configs: Sequence[BridgeConfig]) -> None:\n- old_rules = self.rules\n- self.rules = []\n-\n- for config in bridge_configs:\n- # Those are handled elsewhere...\n- if config.privileged or 'host' in config.match:\n- continue\n-\n- # Try to reuse an existing rule, if one exists...\n- for rule in list(old_rules):\n- if rule.config == config:\n- old_rules.remove(rule)\n- break\n- else:\n- # ... otherwise, create a new one.\n- rule = PeerRoutingRule(self.router, config)\n-\n- self.rules.append(rule)\n-\n- # close down the old rules that didn't get reclaimed\n- for rule in old_rules:\n- rule.shutdown()\n-\n- def shutdown(self):\n- for rule in self.rules:\n- rule.shutdown()\n-'''.encode('utf-8'),\n- 'cockpit/router.py': br'''# This file is part of Cockpit.\n-#\n-# Copyright (C) 2022 Red Hat, Inc.\n-#\n-# This program is free software: you can redistribute it and/or modify\n-# it under the terms of the GNU General Public License as published by\n-# the Free Software Foundation, either version 3 of the License, or\n-# (at your option) any later version.\n-#\n-# This program is distributed in the hope that it will be useful,\n-# but WITHOUT ANY WARRANTY; without even the implied warranty of\n-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n-# GNU General Public License for more details.\n-#\n-# You should have received a copy of the GNU General Public License\n-# along with this program. If not, see .\n+import lzma\n+from typing import List, Sequence, Tuple\n \n-import asyncio\n-import collections\n-import logging\n-from typing import Dict, List, Optional\n+from cockpit._vendor import ferny\n+from cockpit._vendor.bei import beipack\n \n-from .jsonutil import JsonObject, JsonValue\n-from .protocol import CockpitProblem, CockpitProtocolError, CockpitProtocolServer\n+from .data import read_cockpit_data_file\n+from .peer import Peer, PeerError\n \n logger = logging.getLogger(__name__)\n \n \n-class ExecutionQueue:\n- \"\"\"Temporarily delay calls to a given set of class methods.\n-\n- Functions by replacing the named function at the instance __dict__\n- level, effectively providing an override for exactly one instance\n- of `method`'s object.\n- Queues the invocations. Run them later with .run(), which also reverses\n- the redirection by deleting the named methods from the instance.\n- \"\"\"\n- def __init__(self, methods):\n- self.queue = collections.deque()\n- self.methods = methods\n-\n- for method in self.methods:\n- self._wrap(method)\n-\n- def _wrap(self, method):\n- # NB: this function is stored in the instance dict and therefore\n- # doesn't function as a descriptor, isn't a method, doesn't get bound,\n- # and therefore doesn't receive a self parameter\n- setattr(method.__self__, method.__func__.__name__, lambda *args: self.queue.append((method, args)))\n-\n- def run(self):\n- logger.debug('ExecutionQueue: Running %d queued method calls', len(self.queue))\n- for method, args in self.queue:\n- method(*args)\n-\n- for method in self.methods:\n- delattr(method.__self__, method.__func__.__name__)\n-\n-\n-class Endpoint:\n- router: 'Router'\n- __endpoint_frozen_queue: Optional[ExecutionQueue] = None\n-\n- def __init__(self, router: 'Router'):\n- router.add_endpoint(self)\n- self.router = router\n-\n- def freeze_endpoint(self):\n- assert self.__endpoint_frozen_queue is None\n- logger.debug('Freezing endpoint %s', self)\n- self.__endpoint_frozen_queue = ExecutionQueue({self.do_channel_control, self.do_channel_data, self.do_kill})\n-\n- def thaw_endpoint(self):\n- assert self.__endpoint_frozen_queue is not None\n- logger.debug('Thawing endpoint %s', self)\n- self.__endpoint_frozen_queue.run()\n- self.__endpoint_frozen_queue = None\n-\n- # interface for receiving messages\n- def do_close(self):\n- raise NotImplementedError\n-\n- def do_channel_control(self, channel: str, command: str, message: JsonObject) -> None:\n- raise NotImplementedError\n-\n- def do_channel_data(self, channel: str, data: bytes) -> None:\n- raise NotImplementedError\n-\n- def do_kill(self, host: 'str | None', group: 'str | None', message: JsonObject) -> None:\n- raise NotImplementedError\n-\n- # interface for sending messages\n- def send_channel_data(self, channel: str, data: bytes) -> None:\n- self.router.write_channel_data(channel, data)\n-\n- def send_channel_control(\n- self, channel: str, command: str, _msg: 'JsonObject | None', **kwargs: JsonValue\n- ) -> None:\n- self.router.write_control(_msg, channel=channel, command=command, **kwargs)\n- if command == 'close':\n- self.router.endpoints[self].remove(channel)\n- self.router.drop_channel(channel)\n-\n- def shutdown_endpoint(self, _msg: 'JsonObject | None' = None, **kwargs: JsonValue) -> None:\n- self.router.shutdown_endpoint(self, _msg, **kwargs)\n-\n-\n-class RoutingError(CockpitProblem):\n- pass\n-\n-\n-class RoutingRule:\n- router: 'Router'\n-\n- def __init__(self, router: 'Router'):\n- self.router = router\n-\n- def apply_rule(self, options: JsonObject) -> Optional[Endpoint]:\n- \"\"\"Check if a routing rule applies to a given 'open' message.\n-\n- This should inspect the options dictionary and do one of the following three things:\n-\n- - return an Endpoint to handle this channel\n- - raise a RoutingError to indicate that the open should be rejected\n- - return None to let the next rule run\n- \"\"\"\n- raise NotImplementedError\n-\n- def shutdown(self):\n- raise NotImplementedError\n-\n-\n-class Router(CockpitProtocolServer):\n- routing_rules: List[RoutingRule]\n- open_channels: Dict[str, Endpoint]\n- endpoints: 'dict[Endpoint, set[str]]'\n- no_endpoints: asyncio.Event # set if endpoints dict is empty\n- _eof: bool = False\n-\n- def __init__(self, routing_rules: List[RoutingRule]):\n- for rule in routing_rules:\n- rule.router = self\n- self.routing_rules = routing_rules\n- self.open_channels = {}\n- self.endpoints = {}\n- self.no_endpoints = asyncio.Event()\n- self.no_endpoints.set() # at first there are no endpoints\n-\n- def check_rules(self, options: JsonObject) -> Endpoint:\n- for rule in self.routing_rules:\n- logger.debug(' applying rule %s', rule)\n- endpoint = rule.apply_rule(options)\n- if endpoint is not None:\n- logger.debug(' resulting endpoint is %s', endpoint)\n- return endpoint\n- else:\n- logger.debug(' No rules matched')\n- raise RoutingError('not-supported')\n-\n- def drop_channel(self, channel: str) -> None:\n- try:\n- self.open_channels.pop(channel)\n- logger.debug('router dropped channel %s', channel)\n- except KeyError:\n- logger.error('trying to drop non-existent channel %s from %s', channel, self.open_channels)\n+def get_bridge_beipack_xz() -> Tuple[str, bytes]:\n+ try:\n+ bridge_beipack_xz = read_cockpit_data_file('cockpit-bridge.beipack.xz')\n+ logger.debug('Got pre-built cockpit-bridge.beipack.xz')\n+ except FileNotFoundError:\n+ logger.debug('Pre-built cockpit-bridge.beipack.xz; building our own.')\n+ # beipack ourselves\n+ cockpit_contents = beipack.collect_module('cockpit', recursive=True)\n+ bridge_beipack = beipack.pack(cockpit_contents, entrypoint='cockpit.bridge:main', args='beipack=True')\n+ bridge_beipack_xz = lzma.compress(bridge_beipack.encode())\n+ logger.debug(' ... done!')\n \n- def add_endpoint(self, endpoint: Endpoint) -> None:\n- self.endpoints[endpoint] = set()\n- self.no_endpoints.clear()\n+ return 'cockpit/data/cockpit-bridge.beipack.xz', bridge_beipack_xz\n \n- def shutdown_endpoint(self, endpoint: Endpoint, _msg: 'JsonObject | None' = None, **kwargs: JsonValue) -> None:\n- channels = self.endpoints.pop(endpoint)\n- logger.debug('shutdown_endpoint(%s, %s) will close %s', endpoint, kwargs, channels)\n- for channel in channels:\n- self.write_control(_msg, command='close', channel=channel, **kwargs)\n- self.drop_channel(channel)\n \n- if not self.endpoints:\n- self.no_endpoints.set()\n+class BridgeBeibootHelper(ferny.InteractionHandler):\n+ # ferny.InteractionHandler ClassVar\n+ commands = ['beiboot.provide', 'beiboot.exc']\n \n- # were we waiting to exit?\n- if self._eof:\n- logger.debug(' endpoints remaining: %r', self.endpoints)\n- if not self.endpoints and self.transport:\n- logger.debug(' close transport')\n- self.transport.close()\n+ peer: Peer\n+ payload: bytes\n+ steps: Sequence[Tuple[str, Sequence[object]]]\n \n- def do_kill(self, host: 'str | None', group: 'str | None', message: JsonObject) -> None:\n- endpoints = set(self.endpoints)\n- logger.debug('do_kill(%s, %s). Considering %d endpoints.', host, group, len(endpoints))\n- for endpoint in endpoints:\n- endpoint.do_kill(host, group, message)\n+ def __init__(self, peer: Peer, args: Sequence[str] = ()) -> None:\n+ filename, payload = get_bridge_beipack_xz()\n \n- def channel_control_received(self, channel: str, command: str, message: JsonObject) -> None:\n- # If this is an open message then we need to apply the routing rules to\n- # figure out the correct endpoint to connect. If it's not an open\n- # message, then we expect the endpoint to already exist.\n- if command == 'open':\n- if channel in self.open_channels:\n- raise CockpitProtocolError('channel is already open')\n+ self.peer = peer\n+ self.payload = payload\n+ self.steps = (('boot_xz', (filename, len(payload), tuple(args))),)\n \n+ async def run_command(self, command: str, args: Tuple, fds: List[int], stderr: str) -> None:\n+ logger.debug('Got ferny request %s %s %s %s', command, args, fds, stderr)\n+ if command == 'beiboot.provide':\n try:\n- logger.debug('Trying to find endpoint for new channel %s payload=%s', channel, message.get('payload'))\n- endpoint = self.check_rules(message)\n- except RoutingError as exc:\n- self.write_control(exc.get_attrs(), command='close', channel=channel)\n- return\n+ size, = args\n+ assert size == len(self.payload)\n+ except (AssertionError, ValueError) as exc:\n+ raise PeerError('internal-error', message=f'ferny interaction error {exc!s}') from exc\n \n- self.open_channels[channel] = endpoint\n- self.endpoints[endpoint].add(channel)\n+ assert self.peer.transport is not None\n+ logger.debug('Writing %d bytes of payload', len(self.payload))\n+ self.peer.transport.write(self.payload)\n+ elif command == 'beiboot.exc':\n+ raise PeerError('internal-error', message=f'Remote exception: {args[0]}')\n else:\n- try:\n- endpoint = self.open_channels[channel]\n- except KeyError:\n- # sending to a non-existent channel can happen due to races and is not an error\n- return\n-\n- # At this point, we have the endpoint. Route the message.\n- endpoint.do_channel_control(channel, command, message)\n-\n- def channel_data_received(self, channel: str, data: bytes) -> None:\n- try:\n- endpoint = self.open_channels[channel]\n- except KeyError:\n- return\n-\n- endpoint.do_channel_data(channel, data)\n-\n- def eof_received(self) -> bool:\n- logger.debug('eof_received(%r)', self)\n-\n- endpoints = set(self.endpoints)\n- for endpoint in endpoints:\n- endpoint.do_close()\n-\n- self._eof = True\n- logger.debug(' endpoints remaining: %r', self.endpoints)\n- return bool(self.endpoints)\n-\n- _communication_done: Optional[asyncio.Future] = None\n-\n- def do_closed(self, exc: Optional[Exception]) -> None:\n- # If we didn't send EOF yet, do it now.\n- if not self._eof:\n- self.eof_received()\n-\n- if self._communication_done is not None:\n- if exc is None:\n- self._communication_done.set_result(None)\n- else:\n- self._communication_done.set_exception(exc)\n-\n- async def communicate(self) -> None:\n- \"\"\"Wait until communication is complete on the router and all endpoints are done.\"\"\"\n- assert self._communication_done is None\n- self._communication_done = asyncio.get_running_loop().create_future()\n- try:\n- await self._communication_done\n- except (BrokenPipeError, ConnectionResetError):\n- pass # these are normal occurrences when closed from the other side\n- finally:\n- self._communication_done = None\n-\n- # In an orderly exit, this is already done, but in case it wasn't\n- # orderly, we need to make sure the endpoints shut down anyway...\n- await self.no_endpoints.wait()\n-''',\n- 'cockpit/config.py': br'''# This file is part of Cockpit.\n-#\n-# Copyright (C) 2023 Red Hat, Inc.\n-#\n-# This program is free software: you can redistribute it and/or modify\n-# it under the terms of the GNU General Public License as published by\n-# the Free Software Foundation, either version 3 of the License, or\n-# (at your option) any later version.\n-#\n-# This program is distributed in the hope that it will be useful,\n-# but WITHOUT ANY WARRANTY; without even the implied warranty of\n-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n-# GNU General Public License for more details.\n-#\n-# You should have received a copy of the GNU General Public License\n-# along with this program. If not, see .\n-\n-import configparser\n-import logging\n-import os\n-from pathlib import Path\n-\n-from cockpit._vendor.systemd_ctypes import bus\n-\n-logger = logging.getLogger(__name__)\n-\n-XDG_CONFIG_HOME = Path(os.getenv('XDG_CONFIG_HOME') or os.path.expanduser('~/.config'))\n-DOT_CONFIG_COCKPIT = XDG_CONFIG_HOME / 'cockpit'\n-\n-\n-def lookup_config(filename: str) -> Path:\n- config_dirs = os.environ.get('XDG_CONFIG_DIRS', '/etc').split(':')\n- fallback = None\n- for config_dir in config_dirs:\n- config_path = Path(config_dir, 'cockpit', filename)\n- if not fallback:\n- fallback = config_path\n- if config_path.exists():\n- logger.debug('lookup_config(%s): found %s', filename, config_path)\n- return config_path\n-\n- # default to the first entry in XDG_CONFIG_DIRS; that's not according to the spec,\n- # but what Cockpit has done for years\n- logger.debug('lookup_config(%s): defaulting to %s', filename, fallback)\n- assert fallback # mypy; config_dirs always has at least one string\n- return fallback\n-\n-\n-class Config(bus.Object, interface='cockpit.Config'):\n- def __init__(self):\n- self.reload()\n-\n- @bus.Interface.Method(out_types='s', in_types='ss')\n- def get_string(self, section, key):\n- try:\n- return self.config[section][key]\n- except KeyError as exc:\n- raise bus.BusError('cockpit.Config.KeyError', f'key {key} in section {section} does not exist') from exc\n-\n- @bus.Interface.Method(out_types='u', in_types='ssuuu')\n- def get_u_int(self, section, key, default, maximum, minimum):\n- try:\n- value = self.config[section][key]\n- except KeyError:\n- return default\n-\n- try:\n- int_val = int(value)\n- except ValueError:\n- logger.warning('cockpit.conf: [%s] %s is not an integer', section, key)\n- return default\n-\n- return min(max(int_val, minimum), maximum)\n-\n- @bus.Interface.Method()\n- def reload(self):\n- self.config = configparser.ConfigParser(interpolation=None)\n- cockpit_conf = lookup_config('cockpit.conf')\n- logger.debug(\"cockpit.Config: loading %s\", cockpit_conf)\n- # this may not exist, but it's ok to not have a config file and thus leave self.config empty\n- self.config.read(cockpit_conf)\n-\n-\n-class Environment(bus.Object, interface='cockpit.Environment'):\n- variables = bus.Interface.Property('a{ss}')\n-\n- @variables.getter\n- def get_variables(self):\n- return os.environ.copy()\n-''',\n- 'cockpit/__init__.py': br'''from ._version import __version__\n-\n-__all__ = (\n- '__version__',\n-)\n+ raise PeerError('internal-error', message=f'Unexpected ferny interaction command {command}')\n ''',\n- 'cockpit/jsonutil.py': r'''# This file is part of Cockpit.\n-#\n-# Copyright (C) 2023 Red Hat, Inc.\n-#\n-# This program is free software: you can redistribute it and/or modify\n-# it under the terms of the GNU General Public License as published by\n-# the Free Software Foundation, either version 3 of the License, or\n-# (at your option) any later version.\n-#\n-# This program is distributed in the hope that it will be useful,\n-# but WITHOUT ANY WARRANTY; without even the implied warranty of\n-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n-# GNU General Public License for more details.\n-#\n-# You should have received a copy of the GNU General Public License\n-# along with this program. If not, see .\n-\n-from enum import Enum\n-from typing import Callable, Container, Dict, List, Mapping, Optional, Sequence, Type, TypeVar, Union\n-\n-JsonLiteral = Union[str, float, bool, None]\n-\n-# immutable\n-JsonValue = Union['JsonObject', Sequence['JsonValue'], JsonLiteral]\n-JsonObject = Mapping[str, JsonValue]\n-\n-# mutable\n-JsonDocument = Union['JsonDict', 'JsonList', JsonLiteral]\n-JsonDict = Dict[str, JsonDocument]\n-JsonList = List[JsonDocument]\n-\n-\n-DT = TypeVar('DT')\n-T = TypeVar('T')\n-\n-\n-class JsonError(Exception):\n- value: object\n-\n- def __init__(self, value: object, msg: str):\n- super().__init__(msg)\n- self.value = value\n-\n-\n-def typechecked(value: JsonValue, expected_type: Type[T]) -> T:\n- \"\"\"Ensure a JSON value has the expected type, returning it if so.\"\"\"\n- if not isinstance(value, expected_type):\n- raise JsonError(value, f'must have type {expected_type.__name__}')\n- return value\n-\n-\n-# We can't use None as a sentinel because it's often the actual default value\n-# EllipsisType is difficult because it's not available before 3.10.\n-# See https://peps.python.org/pep-0484/#support-for-singleton-types-in-unions\n-class _Empty(Enum):\n- TOKEN = 0\n-\n-\n-_empty = _Empty.TOKEN\n-\n-\n-def _get(obj: JsonObject, cast: Callable[[JsonValue], T], key: str, default: Union[DT, _Empty]) -> Union[T, DT]:\n- try:\n- return cast(obj[key])\n- except KeyError:\n- if default is not _empty:\n- return default\n- raise JsonError(obj, f\"attribute '{key}' required\") from None\n- except JsonError as exc:\n- target = f\"attribute '{key}'\" + (' elements:' if exc.value is not obj[key] else ':')\n- raise JsonError(obj, f\"{target} {exc!s}\") from exc\n-\n-\n-def get_bool(obj: JsonObject, key: str, default: Union[DT, _Empty] = _empty) -> Union[DT, bool]:\n- return _get(obj, lambda v: typechecked(v, bool), key, default)\n-\n-\n-def get_int(obj: JsonObject, key: str, default: Union[DT, _Empty] = _empty) -> Union[DT, int]:\n- return _get(obj, lambda v: typechecked(v, int), key, default)\n-\n-\n-def get_str(obj: JsonObject, key: str, default: Union[DT, _Empty] = _empty) -> Union[DT, str]:\n- return _get(obj, lambda v: typechecked(v, str), key, default)\n-\n-\n-def get_str_or_none(obj: JsonObject, key: str, default: Optional[str]) -> Optional[str]:\n- return _get(obj, lambda v: None if v is None else typechecked(v, str), key, default)\n-\n-\n-def get_dict(obj: JsonObject, key: str, default: Union[DT, _Empty] = _empty) -> Union[DT, JsonObject]:\n- return _get(obj, lambda v: typechecked(v, dict), key, default)\n-\n-\n-def get_object(\n- obj: JsonObject,\n- key: str,\n- constructor: Callable[[JsonObject], T],\n- default: Union[DT, _Empty] = _empty\n-) -> Union[DT, T]:\n- return _get(obj, lambda v: constructor(typechecked(v, dict)), key, default)\n-\n-\n-def get_strv(obj: JsonObject, key: str, default: Union[DT, _Empty] = _empty) -> Union[DT, Sequence[str]]:\n- def as_strv(value: JsonValue) -> Sequence[str]:\n- return tuple(typechecked(item, str) for item in typechecked(value, list))\n- return _get(obj, as_strv, key, default)\n-\n-\n-def get_enum(\n- obj: JsonObject, key: str, choices: Container[str], default: Union[DT, _Empty] = _empty\n-) -> Union[DT, str]:\n- def as_choice(value: JsonValue) -> str:\n- # mypy can't do `__eq__()`-based type narrowing...\n- # https://github.com/python/mypy/issues/17101\n- if isinstance(value, str) and value in choices:\n- return value\n- raise JsonError(value, f'invalid value \"{value}\" not in {choices}')\n- return _get(obj, as_choice, key, default)\n-\n-\n-def get_objv(obj: JsonObject, key: str, constructor: Callable[[JsonObject], T]) -> Union[DT, Sequence[T]]:\n- def as_objv(value: JsonValue) -> Sequence[T]:\n- return tuple(constructor(typechecked(item, dict)) for item in typechecked(value, list))\n- return _get(obj, as_objv, key, ())\n-\n-\n-def create_object(message: 'JsonObject | None', kwargs: JsonObject) -> JsonObject:\n- \"\"\"Constructs a JSON object based on message and kwargs.\n-\n- If only message is given, it is returned, unmodified. If message is None,\n- it is equivalent to an empty dictionary. A copy is always made.\n-\n- If kwargs are present, then any underscore ('_') present in a key name is\n- rewritten to a dash ('-'). This is intended to bridge between the required\n- Python syntax when providing kwargs and idiomatic JSON (which uses '-' for\n- attributes). These values override values in message.\n-\n- The idea is that `message` should be used for passing data along, and\n- kwargs used for data originating at a given call site, possibly including\n- modifications to an original message.\n- \"\"\"\n- result = dict(message or {})\n-\n- for key, value in kwargs.items():\n- # rewrite '_' (necessary in Python syntax kwargs list) to '-' (idiomatic JSON)\n- json_key = key.replace('_', '-')\n- result[json_key] = value\n-\n- return result\n-\n-\n-def json_merge_patch(current: JsonObject, patch: JsonObject) -> JsonObject:\n- \"\"\"Perform a JSON merge patch (RFC 7396) using 'current' and 'patch'.\n- Neither of the original dictionaries is modified \u2014 the result is returned.\n- \"\"\"\n- # Always take a copy ('result') \u2014 we never modify the input ('current')\n- result = dict(current)\n- for key, patch_value in patch.items():\n- if isinstance(patch_value, Mapping):\n- current_value = current.get(key, None)\n- if not isinstance(current_value, Mapping):\n- current_value = {}\n- result[key] = json_merge_patch(current_value, patch_value)\n- elif patch_value is not None:\n- result[key] = patch_value\n- else:\n- result.pop(key, None)\n-\n- return result\n-\n-\n-def json_merge_and_filter_patch(current: JsonDict, patch: JsonDict) -> None:\n- \"\"\"Perform a JSON merge patch (RFC 7396) modifying 'current' with 'patch'.\n- Also modifies 'patch' to remove redundant operations.\n- \"\"\"\n- for key, patch_value in tuple(patch.items()):\n- current_value = current.get(key, None)\n-\n- if isinstance(patch_value, dict):\n- if not isinstance(current_value, dict):\n- current[key] = current_value = {}\n- json_merge_and_filter_patch(current_value, patch_value)\n- else:\n- json_merge_and_filter_patch(current_value, patch_value)\n- if not patch_value:\n- del patch[key]\n- elif current_value == patch_value:\n- del patch[key]\n- elif patch_value is not None:\n- current[key] = patch_value\n- else:\n- del current[key]\n-'''.encode('utf-8'),\n 'cockpit/transports.py': br'''# This file is part of Cockpit.\n #\n # Copyright (C) 2022 Red Hat, Inc.\n #\n # This program is free software: you can redistribute it and/or modify\n # it under the terms of the GNU General Public License as published by\n # the Free Software Foundation, either version 3 of the License, or\n@@ -4777,14 +4022,330 @@\n self._loop.remove_reader(self._fd)\n os.close(self._fd)\n self._fd = -1\n \n def __del__(self) -> None:\n self.close()\n ''',\n+ 'cockpit/bridge.py': r'''# This file is part of Cockpit.\n+#\n+# Copyright (C) 2022 Red Hat, Inc.\n+#\n+# This program is free software: you can redistribute it and/or modify\n+# it under the terms of the GNU General Public License as published by\n+# the Free Software Foundation, either version 3 of the License, or\n+# (at your option) any later version.\n+#\n+# This program is distributed in the hope that it will be useful,\n+# but WITHOUT ANY WARRANTY; without even the implied warranty of\n+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n+# GNU General Public License for more details.\n+#\n+# You should have received a copy of the GNU General Public License\n+# along with this program. If not, see .\n+\n+import argparse\n+import asyncio\n+import contextlib\n+import json\n+import logging\n+import os\n+import pwd\n+import shlex\n+import socket\n+import stat\n+import subprocess\n+from typing import Iterable, List, Optional, Sequence, Tuple, Type\n+\n+from cockpit._vendor.ferny import interaction_client\n+from cockpit._vendor.systemd_ctypes import bus, run_async\n+\n+from . import polyfills\n+from ._version import __version__\n+from .channel import ChannelRoutingRule\n+from .channels import CHANNEL_TYPES\n+from .config import Config, Environment\n+from .internal_endpoints import EXPORTS\n+from .jsonutil import JsonError, JsonObject, get_dict\n+from .packages import BridgeConfig, Packages, PackagesListener\n+from .peer import PeersRoutingRule\n+from .remote import HostRoutingRule\n+from .router import Router\n+from .superuser import SuperuserRoutingRule\n+from .transports import StdioTransport\n+\n+logger = logging.getLogger(__name__)\n+\n+\n+class InternalBus:\n+ exportees: List[bus.Slot]\n+\n+ def __init__(self, exports: Iterable[Tuple[str, Type[bus.BaseObject]]]):\n+ client_socket, server_socket = socket.socketpair()\n+ self.client = bus.Bus.new(fd=client_socket.detach())\n+ self.server = bus.Bus.new(fd=server_socket.detach(), server=True)\n+ self.exportees = [self.server.add_object(path, cls()) for path, cls in exports]\n+\n+ def export(self, path: str, obj: bus.BaseObject) -> None:\n+ self.exportees.append(self.server.add_object(path, obj))\n+\n+\n+class Bridge(Router, PackagesListener):\n+ internal_bus: InternalBus\n+ packages: Optional[Packages]\n+ bridge_configs: Sequence[BridgeConfig]\n+ args: argparse.Namespace\n+\n+ def __init__(self, args: argparse.Namespace):\n+ self.internal_bus = InternalBus(EXPORTS)\n+ self.bridge_configs = []\n+ self.args = args\n+\n+ self.superuser_rule = SuperuserRoutingRule(self, privileged=args.privileged)\n+ self.internal_bus.export('/superuser', self.superuser_rule)\n+\n+ self.internal_bus.export('/config', Config())\n+ self.internal_bus.export('/environment', Environment())\n+\n+ self.peers_rule = PeersRoutingRule(self)\n+\n+ if args.beipack:\n+ # Some special stuff for beipack\n+ self.superuser_rule.set_configs((\n+ BridgeConfig({\n+ \"privileged\": True,\n+ \"spawn\": [\"sudo\", \"-k\", \"-A\", \"python3\", \"-ic\", \"# cockpit-bridge\", \"--privileged\"],\n+ \"environ\": [\"SUDO_ASKPASS=ferny-askpass\"],\n+ }),\n+ ))\n+ self.packages = None\n+ elif args.privileged:\n+ self.packages = None\n+ else:\n+ self.packages = Packages(self)\n+ self.internal_bus.export('/packages', self.packages)\n+ self.packages_loaded()\n+\n+ super().__init__([\n+ HostRoutingRule(self),\n+ self.superuser_rule,\n+ ChannelRoutingRule(self, CHANNEL_TYPES),\n+ self.peers_rule,\n+ ])\n+\n+ @staticmethod\n+ def get_os_release():\n+ try:\n+ file = open('/etc/os-release', encoding='utf-8')\n+ except FileNotFoundError:\n+ try:\n+ file = open('/usr/lib/os-release', encoding='utf-8')\n+ except FileNotFoundError:\n+ logger.warning(\"Neither /etc/os-release nor /usr/lib/os-release exists\")\n+ return {}\n+\n+ os_release = {}\n+ for line in file.readlines():\n+ line = line.strip()\n+ if not line or line.startswith('#'):\n+ continue\n+ try:\n+ k, v = line.split('=')\n+ (v_parsed, ) = shlex.split(v) # expect exactly one token\n+ except ValueError:\n+ logger.warning('Ignoring invalid line in os-release: %r', line)\n+ continue\n+ os_release[k] = v_parsed\n+ return os_release\n+\n+ def do_init(self, message: JsonObject) -> None:\n+ # we're only interested in the case where this is a dict, but\n+ # 'superuser' may well be `False` and that's not an error\n+ with contextlib.suppress(JsonError):\n+ superuser = get_dict(message, 'superuser')\n+ self.superuser_rule.init(superuser)\n+\n+ def do_send_init(self) -> None:\n+ init_args = {\n+ 'capabilities': {'explicit-superuser': True},\n+ 'command': 'init',\n+ 'os-release': self.get_os_release(),\n+ 'version': 1,\n+ }\n+\n+ if self.packages is not None:\n+ init_args['packages'] = dict.fromkeys(self.packages.packages)\n+\n+ self.write_control(init_args)\n+\n+ # PackagesListener interface\n+ def packages_loaded(self) -> None:\n+ assert self.packages\n+ bridge_configs = self.packages.get_bridge_configs()\n+ if self.bridge_configs != bridge_configs:\n+ self.superuser_rule.set_configs(bridge_configs)\n+ self.peers_rule.set_configs(bridge_configs)\n+ self.bridge_configs = bridge_configs\n+\n+\n+async def run(args) -> None:\n+ logger.debug(\"Hi. How are you today?\")\n+\n+ # Unit tests require this\n+ me = pwd.getpwuid(os.getuid())\n+ os.environ['HOME'] = me.pw_dir\n+ os.environ['SHELL'] = me.pw_shell\n+ os.environ['USER'] = me.pw_name\n+\n+ logger.debug('Starting the router.')\n+ router = Bridge(args)\n+ StdioTransport(asyncio.get_running_loop(), router)\n+\n+ logger.debug('Startup done. Looping until connection closes.')\n+\n+ try:\n+ await router.communicate()\n+ except (BrokenPipeError, ConnectionResetError):\n+ # not unexpected if the peer doesn't hang up cleanly\n+ pass\n+\n+\n+def try_to_receive_stderr():\n+ try:\n+ ours, theirs = socket.socketpair()\n+ with ours:\n+ with theirs:\n+ interaction_client.command(2, 'cockpit.send-stderr', fds=[theirs.fileno()])\n+ _msg, fds, _flags, _addr = socket.recv_fds(ours, 1, 1)\n+ except OSError:\n+ return\n+\n+ try:\n+ stderr_fd, = fds\n+ # We're about to abruptly drop our end of the stderr socketpair that we\n+ # share with the ferny agent. ferny would normally treat that as an\n+ # unexpected error. Instruct it to do a clean exit, instead.\n+ interaction_client.command(2, 'ferny.end')\n+ os.dup2(stderr_fd, 2)\n+ finally:\n+ for fd in fds:\n+ os.close(fd)\n+\n+\n+def setup_journald() -> bool:\n+ # If stderr is a socket, prefer systemd-journal logging. This covers the\n+ # case we're already connected to the journal but also the case where we're\n+ # talking to the ferny agent, while leaving logging to file or terminal\n+ # unaffected.\n+ if not stat.S_ISSOCK(os.fstat(2).st_mode):\n+ # not a socket? Don't redirect.\n+ return False\n+\n+ try:\n+ import systemd.journal # type: ignore[import]\n+ except ImportError:\n+ # No python3-systemd? Don't redirect.\n+ return False\n+\n+ logging.root.addHandler(systemd.journal.JournalHandler())\n+ return True\n+\n+\n+def setup_logging(*, debug: bool) -> None:\n+ \"\"\"Setup our logger with optional filtering of modules if COCKPIT_DEBUG env is set\"\"\"\n+\n+ modules = os.getenv('COCKPIT_DEBUG', '')\n+\n+ # Either setup logging via journal or via formatted messages to stderr\n+ if not setup_journald():\n+ logging.basicConfig(format='%(name)s-%(levelname)s: %(message)s')\n+\n+ if debug or modules == 'all':\n+ logging.getLogger().setLevel(level=logging.DEBUG)\n+ elif modules:\n+ for module in modules.split(','):\n+ module = module.strip()\n+ if not module:\n+ continue\n+\n+ logging.getLogger(module).setLevel(logging.DEBUG)\n+\n+\n+def start_ssh_agent() -> None:\n+ # Launch the agent so that it goes down with us on EOF; PDEATHSIG would be more robust,\n+ # but it gets cleared on setgid ssh-agent, which some distros still do\n+ try:\n+ proc = subprocess.Popen(['ssh-agent', 'sh', '-ec', 'echo SSH_AUTH_SOCK=$SSH_AUTH_SOCK; read a'],\n+ stdin=subprocess.PIPE, stdout=subprocess.PIPE, universal_newlines=True)\n+ assert proc.stdout is not None\n+\n+ # Wait for the agent to write at least one line and look for the\n+ # listener socket. If we fail to find it, kill the agent \u2014 something\n+ # went wrong.\n+ for token in shlex.shlex(proc.stdout.readline(), punctuation_chars=True):\n+ if token.startswith('SSH_AUTH_SOCK='):\n+ os.environ['SSH_AUTH_SOCK'] = token.replace('SSH_AUTH_SOCK=', '', 1)\n+ break\n+ else:\n+ proc.terminate()\n+ proc.wait()\n+\n+ except FileNotFoundError:\n+ logger.debug(\"Couldn't start ssh-agent (FileNotFoundError)\")\n+\n+ except OSError as exc:\n+ logger.warning(\"Could not start ssh-agent: %s\", exc)\n+\n+\n+def main(*, beipack: bool = False) -> None:\n+ polyfills.install()\n+\n+ parser = argparse.ArgumentParser(description='cockpit-bridge is run automatically inside of a Cockpit session.')\n+ parser.add_argument('--privileged', action='store_true', help='Privileged copy of the bridge')\n+ parser.add_argument('--packages', action='store_true', help='Show Cockpit package information')\n+ parser.add_argument('--bridges', action='store_true', help='Show Cockpit bridges information')\n+ parser.add_argument('--debug', action='store_true', help='Enable debug output (very verbose)')\n+ parser.add_argument('--version', action='store_true', help='Show Cockpit version information')\n+ args = parser.parse_args()\n+\n+ # This is determined by who calls us\n+ args.beipack = beipack\n+\n+ # If we were run with --privileged then our stderr is currently being\n+ # consumed by the main bridge looking for startup-related error messages.\n+ # Let's switch back to the original stderr stream, which has a side-effect\n+ # of indicating that our startup is more or less complete. Any errors\n+ # after this point will land in the journal.\n+ if args.privileged:\n+ try_to_receive_stderr()\n+\n+ setup_logging(debug=args.debug)\n+\n+ # Special modes\n+ if args.packages:\n+ Packages().show()\n+ return\n+ elif args.version:\n+ print(f'Version: {__version__}\\nProtocol: 1')\n+ return\n+ elif args.bridges:\n+ print(json.dumps([config.__dict__ for config in Packages().get_bridge_configs()], indent=2))\n+ return\n+\n+ # The privileged bridge doesn't need ssh-agent, but the main one does\n+ if 'SSH_AUTH_SOCK' not in os.environ and not args.privileged:\n+ start_ssh_agent()\n+\n+ # asyncio.run() shim for Python 3.6 support\n+ run_async(run(args), debug=args.debug)\n+\n+\n+if __name__ == '__main__':\n+ main()\n+'''.encode('utf-8'),\n 'cockpit/polkit.py': r'''# This file is part of Cockpit.\n #\n # Copyright (C) 2023 Red Hat, Inc.\n #\n # This program is free software: you can redistribute it and/or modify\n # it under the terms of the GNU General Public License as published by\n # the Free Software Foundation, either version 3 of the License, or\n@@ -4949,15 +4510,15 @@\n 'org.freedesktop.PolicyKit1.Authority',\n 'UnregisterAuthenticationAgent',\n '(sa{sv})s',\n self.subject, AGENT_DBUS_PATH)\n self.agent_slot.cancel()\n logger.debug('Unregistered agent for %r', self.subject)\n '''.encode('utf-8'),\n- 'cockpit/channels/metrics.py': br'''# This file is part of Cockpit.\n+ 'cockpit/samples.py': br'''# This file is part of Cockpit.\n #\n # Copyright (C) 2022 Red Hat, Inc.\n #\n # This program is free software: you can redistribute it and/or modify\n # it under the terms of the GNU General Public License as published by\n # the Free Software Foundation, either version 3 of the License, or\n # (at your option) any later version.\n@@ -4966,698 +4527,500 @@\n # but WITHOUT ANY WARRANTY; without even the implied warranty of\n # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n # GNU General Public License for more details.\n #\n # You should have received a copy of the GNU General Public License\n # along with this program. If not, see .\n \n-import asyncio\n-import json\n+import errno\n import logging\n-import sys\n-import time\n-from collections import defaultdict\n-from typing import Dict, List, NamedTuple, Optional, Set, Tuple, Union\n+import os\n+import re\n+from typing import Any, DefaultDict, Iterable, List, NamedTuple, Optional, Tuple\n \n-from ..channel import AsyncChannel, ChannelError\n-from ..jsonutil import JsonList\n-from ..samples import SAMPLERS, SampleDescription, Sampler, Samples\n+from cockpit._vendor.systemd_ctypes import Handle\n \n-logger = logging.getLogger(__name__)\n+USER_HZ = os.sysconf(os.sysconf_names['SC_CLK_TCK'])\n+MS_PER_JIFFY = 1000 / (USER_HZ if (USER_HZ > 0) else 100)\n+HWMON_PATH = '/sys/class/hwmon'\n \n+# we would like to do this, but mypy complains; https://github.com/python/mypy/issues/2900\n+# Samples = collections.defaultdict[str, Union[float, Dict[str, Union[float, None]]]]\n+Samples = DefaultDict[str, Any]\n \n-class MetricInfo(NamedTuple):\n- derive: Optional[str]\n- desc: SampleDescription\n+logger = logging.getLogger(__name__)\n \n \n-class InternalMetricsChannel(AsyncChannel):\n- payload = 'metrics1'\n- restrictions = [('source', 'internal')]\n+def read_int_file(rootfd: int, statfile: str, default: Optional[int] = None, key: bytes = b'') -> Optional[int]:\n+ # Not every stat is available, such as cpu.weight\n+ try:\n+ fd = os.open(statfile, os.O_RDONLY, dir_fd=rootfd)\n+ except FileNotFoundError:\n+ return None\n \n- metrics: List[MetricInfo]\n- samplers: Set\n- samplers_cache: Optional[Dict[str, Tuple[Sampler, SampleDescription]]] = None\n+ try:\n+ data = os.read(fd, 1024)\n+ except OSError as e:\n+ # cgroups can disappear between the open and read\n+ if e.errno != errno.ENODEV:\n+ logger.warning('Failed to read %s: %s', statfile, e)\n+ return None\n+ finally:\n+ os.close(fd)\n \n- interval: int = 1000\n- need_meta: bool = True\n- last_timestamp: float = 0\n- next_timestamp: float = 0\n+ if key:\n+ start = data.index(key) + len(key)\n+ end = data.index(b'\\n', start)\n+ data = data[start:end]\n \n- @classmethod\n- def ensure_samplers(cls):\n- if cls.samplers_cache is None:\n- cls.samplers_cache = {desc.name: (sampler, desc) for sampler in SAMPLERS for desc in sampler.descriptions}\n+ try:\n+ # 0 often means \"none\", so replace it with default value\n+ return int(data) or default\n+ except ValueError:\n+ # Some samples such as \"memory.max\" contains \"max\" when there is a no limit\n+ return None\n \n- def parse_options(self, options):\n- logger.debug('metrics internal open: %s, channel: %s', options, self.channel)\n \n- interval = options.get('interval', self.interval)\n- if not isinstance(interval, int) or interval <= 0 or interval > sys.maxsize:\n- raise ChannelError('protocol-error', message=f'invalid \"interval\" value: {interval}')\n+class SampleDescription(NamedTuple):\n+ name: str\n+ units: str\n+ semantics: str\n+ instanced: bool\n \n- self.interval = interval\n \n- metrics = options.get('metrics')\n- if not isinstance(metrics, list) or len(metrics) == 0:\n- logger.error('invalid \"metrics\" value: %s', metrics)\n- raise ChannelError('protocol-error', message='invalid \"metrics\" option was specified (not an array)')\n+class Sampler:\n+ descriptions: List[SampleDescription]\n \n- sampler_classes = set()\n- for metric in metrics:\n- # validate it's an object\n- name = metric.get('name')\n- units = metric.get('units')\n- derive = metric.get('derive')\n+ def sample(self, samples: Samples) -> None:\n+ raise NotImplementedError\n \n- try:\n- sampler, desc = self.samplers_cache[name]\n- except KeyError as exc:\n- logger.error('unsupported metric: %s', name)\n- raise ChannelError('not-supported', message=f'unsupported metric: {name}') from exc\n \n- if units and units != desc.units:\n- raise ChannelError('not-supported', message=f'{name} has units {desc.units}, not {units}')\n+class CPUSampler(Sampler):\n+ descriptions = [\n+ SampleDescription('cpu.basic.nice', 'millisec', 'counter', instanced=False),\n+ SampleDescription('cpu.basic.user', 'millisec', 'counter', instanced=False),\n+ SampleDescription('cpu.basic.system', 'millisec', 'counter', instanced=False),\n+ SampleDescription('cpu.basic.iowait', 'millisec', 'counter', instanced=False),\n \n- sampler_classes.add(sampler)\n- self.metrics.append(MetricInfo(derive=derive, desc=desc))\n+ SampleDescription('cpu.core.nice', 'millisec', 'counter', instanced=True),\n+ SampleDescription('cpu.core.user', 'millisec', 'counter', instanced=True),\n+ SampleDescription('cpu.core.system', 'millisec', 'counter', instanced=True),\n+ SampleDescription('cpu.core.iowait', 'millisec', 'counter', instanced=True),\n+ ]\n \n- self.samplers = {cls() for cls in sampler_classes}\n+ def sample(self, samples: Samples) -> None:\n+ with open('/proc/stat') as stat:\n+ for line in stat:\n+ if not line.startswith('cpu'):\n+ continue\n+ cpu, user, nice, system, _idle, iowait = line.split()[:6]\n+ core = cpu[3:] or None\n+ if core:\n+ prefix = 'cpu.core'\n+ samples[f'{prefix}.nice'][core] = int(nice) * MS_PER_JIFFY\n+ samples[f'{prefix}.user'][core] = int(user) * MS_PER_JIFFY\n+ samples[f'{prefix}.system'][core] = int(system) * MS_PER_JIFFY\n+ samples[f'{prefix}.iowait'][core] = int(iowait) * MS_PER_JIFFY\n+ else:\n+ prefix = 'cpu.basic'\n+ samples[f'{prefix}.nice'] = int(nice) * MS_PER_JIFFY\n+ samples[f'{prefix}.user'] = int(user) * MS_PER_JIFFY\n+ samples[f'{prefix}.system'] = int(system) * MS_PER_JIFFY\n+ samples[f'{prefix}.iowait'] = int(iowait) * MS_PER_JIFFY\n \n- def send_meta(self, samples: Samples, timestamp: float):\n- metrics: JsonList = []\n- for metricinfo in self.metrics:\n- if metricinfo.desc.instanced:\n- metrics.append({\n- 'name': metricinfo.desc.name,\n- 'units': metricinfo.desc.units,\n- 'instances': list(samples[metricinfo.desc.name].keys()),\n- 'semantics': metricinfo.desc.semantics\n- })\n- else:\n- metrics.append({\n- 'name': metricinfo.desc.name,\n- 'derive': metricinfo.derive, # type: ignore[dict-item]\n- 'units': metricinfo.desc.units,\n- 'semantics': metricinfo.desc.semantics\n- })\n \n- self.send_json(source='internal', interval=self.interval, timestamp=timestamp * 1000, metrics=metrics)\n- self.need_meta = False\n+class MemorySampler(Sampler):\n+ descriptions = [\n+ SampleDescription('memory.free', 'bytes', 'instant', instanced=False),\n+ SampleDescription('memory.used', 'bytes', 'instant', instanced=False),\n+ SampleDescription('memory.cached', 'bytes', 'instant', instanced=False),\n+ SampleDescription('memory.swap-used', 'bytes', 'instant', instanced=False),\n+ ]\n \n- def sample(self):\n- samples = defaultdict(dict)\n- for sampler in self.samplers:\n- sampler.sample(samples)\n- return samples\n+ def sample(self, samples: Samples) -> None:\n+ with open('/proc/meminfo') as meminfo:\n+ items = {k: int(v.strip(' kB\\n')) for line in meminfo for k, v in [line.split(':', 1)]}\n \n- def calculate_sample_rate(self, value: float, old_value: Optional[float]) -> Union[float, bool]:\n- if old_value is not None and self.last_timestamp:\n- return (value - old_value) / (self.next_timestamp - self.last_timestamp)\n- else:\n- return False\n+ samples['memory.free'] = 1024 * items['MemFree']\n+ samples['memory.used'] = 1024 * (items['MemTotal'] - items['MemAvailable'])\n+ samples['memory.cached'] = 1024 * (items['Buffers'] + items['Cached'])\n+ samples['memory.swap-used'] = 1024 * (items['SwapTotal'] - items['SwapFree'])\n \n- def send_updates(self, samples: Samples, last_samples: Samples):\n- data: List[Union[float, List[Optional[Union[float, bool]]]]] = []\n- timestamp = time.time()\n- self.next_timestamp = timestamp\n \n- for metricinfo in self.metrics:\n- value = samples[metricinfo.desc.name]\n+class CPUTemperatureSampler(Sampler):\n+ # Cache found sensors, as they can't be hotplugged.\n+ sensors: Optional[List[str]] = None\n \n- if metricinfo.desc.instanced:\n- old_value = last_samples[metricinfo.desc.name]\n- assert isinstance(value, dict)\n- assert isinstance(old_value, dict)\n+ descriptions = [\n+ SampleDescription('cpu.temperature', 'celsius', 'instant', instanced=True),\n+ ]\n \n- # If we have less or more keys the data changed, send a meta message.\n- if value.keys() != old_value.keys():\n- self.need_meta = True\n+ @staticmethod\n+ def detect_cpu_sensors(dir_fd: int) -> Iterable[str]:\n+ # Read the name file to decide what to do with this directory\n+ try:\n+ with Handle.open('name', os.O_RDONLY, dir_fd=dir_fd) as fd:\n+ name = os.read(fd, 1024).decode().strip()\n+ except FileNotFoundError:\n+ return\n \n- if metricinfo.derive == 'rate':\n- instances: List[Optional[Union[float, bool]]] = []\n- for key, val in value.items():\n- instances.append(self.calculate_sample_rate(val, old_value.get(key)))\n+ if name == 'atk0110':\n+ # only sample 'CPU Temperature' in atk0110\n+ predicate = (lambda label: label == 'CPU Temperature')\n+ elif name == 'cpu_thermal':\n+ # labels are not used on ARM\n+ predicate = None\n+ elif name == 'coretemp':\n+ # accept all labels on Intel\n+ predicate = None\n+ elif name in ['k8temp', 'k10temp']:\n+ predicate = None\n+ else:\n+ # Not a CPU sensor\n+ return\n \n- data.append(instances)\n- else:\n- data.append(list(value.values()))\n- else:\n- old_value = last_samples.get(metricinfo.desc.name)\n- assert not isinstance(value, dict)\n- assert not isinstance(old_value, dict)\n+ # Now scan the directory for inputs\n+ for input_filename in os.listdir(dir_fd):\n+ if not input_filename.endswith('_input'):\n+ continue\n \n- if metricinfo.derive == 'rate':\n- data.append(self.calculate_sample_rate(value, old_value))\n- else:\n- data.append(value)\n+ if predicate:\n+ # We need to check the label\n+ try:\n+ label_filename = input_filename.replace('_input', '_label')\n+ with Handle.open(label_filename, os.O_RDONLY, dir_fd=dir_fd) as fd:\n+ label = os.read(fd, 1024).decode().strip()\n+ except FileNotFoundError:\n+ continue\n \n- if self.need_meta:\n- self.send_meta(samples, timestamp)\n+ if not predicate(label):\n+ continue\n \n- self.last_timestamp = self.next_timestamp\n- self.send_data(json.dumps([data]).encode())\n+ yield input_filename\n \n- async def run(self, options):\n- self.metrics = []\n- self.samplers = set()\n+ @staticmethod\n+ def scan_sensors() -> Iterable[str]:\n+ try:\n+ top_fd = Handle.open(HWMON_PATH, os.O_RDONLY | os.O_DIRECTORY)\n+ except FileNotFoundError:\n+ return\n \n- InternalMetricsChannel.ensure_samplers()\n+ with top_fd:\n+ for hwmon_name in os.listdir(top_fd):\n+ with Handle.open(hwmon_name, os.O_RDONLY | os.O_DIRECTORY, dir_fd=top_fd) as subdir_fd:\n+ for sensor in CPUTemperatureSampler.detect_cpu_sensors(subdir_fd):\n+ yield f'{HWMON_PATH}/{hwmon_name}/{sensor}'\n \n- self.parse_options(options)\n- self.ready()\n+ def sample(self, samples: Samples) -> None:\n+ if self.sensors is None:\n+ self.sensors = list(CPUTemperatureSampler.scan_sensors())\n \n- last_samples = defaultdict(dict)\n- while True:\n- samples = self.sample()\n- self.send_updates(samples, last_samples)\n- last_samples = samples\n- await asyncio.sleep(self.interval / 1000)\n-''',\n- 'cockpit/channels/dbus.py': r'''# This file is part of Cockpit.\n-#\n-# Copyright (C) 2022 Red Hat, Inc.\n-#\n-# This program is free software: you can redistribute it and/or modify\n-# it under the terms of the GNU General Public License as published by\n-# the Free Software Foundation, either version 3 of the License, or\n-# (at your option) any later version.\n-#\n-# This program is distributed in the hope that it will be useful,\n-# but WITHOUT ANY WARRANTY; without even the implied warranty of\n-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n-# GNU General Public License for more details.\n-#\n-# You should have received a copy of the GNU General Public License\n-# along with this program. If not, see .\n+ for sensor_path in self.sensors:\n+ with open(sensor_path) as sensor:\n+ temperature = int(sensor.read().strip())\n+ if temperature == 0:\n+ return\n \n-# Missing stuff compared to the C bridge that we should probably add:\n-#\n-# - removing matches\n-# - removing watches\n-# - emitting of signals\n-# - publishing of objects\n-# - failing more gracefully in some cases (during open, etc)\n-#\n-# Stuff we might or might not do:\n-#\n-# - using non-default service names\n-#\n-# Stuff we should probably not do:\n-#\n-# - emulation of ObjectManager via recursive introspection\n-# - automatic detection of ObjectManager below the given path_namespace\n-# - recursive scraping of properties for new object paths\n-# (for path_namespace watches that don't hit an ObjectManager)\n+ samples['cpu.temperature'][sensor_path] = temperature / 1000\n \n-import asyncio\n-import errno\n-import json\n-import logging\n-import traceback\n-import xml.etree.ElementTree as ET\n \n-from cockpit._vendor import systemd_ctypes\n-from cockpit._vendor.systemd_ctypes import Bus, BusError, introspection\n+class DiskSampler(Sampler):\n+ descriptions = [\n+ SampleDescription('disk.all.read', 'bytes', 'counter', instanced=False),\n+ SampleDescription('disk.all.written', 'bytes', 'counter', instanced=False),\n+ SampleDescription('disk.dev.read', 'bytes', 'counter', instanced=True),\n+ SampleDescription('disk.dev.written', 'bytes', 'counter', instanced=True),\n+ ]\n \n-from ..channel import Channel, ChannelError\n+ def sample(self, samples: Samples) -> None:\n+ with open('/proc/diskstats') as diskstats:\n+ all_read_bytes = 0\n+ all_written_bytes = 0\n \n-logger = logging.getLogger(__name__)\n+ for line in diskstats:\n+ # https://www.kernel.org/doc/Documentation/ABI/testing/procfs-diskstats\n+ fields = line.strip().split()\n+ dev_major = fields[0]\n+ dev_name = fields[2]\n+ num_sectors_read = fields[5]\n+ num_sectors_written = fields[9]\n \n-# The dbusjson3 payload\n-#\n-# This channel payload type translates JSON encoded messages on a\n-# Cockpit channel to D-Bus messages, in a mostly straightforward way.\n-# See doc/protocol.md for a description of the basics.\n-#\n-# However, dbusjson3 offers some advanced features as well that are\n-# meant to support the \"magic\" DBusProxy objects implemented by\n-# cockpit.js. Those proxy objects \"magically\" expose all the methods\n-# and properties of a D-Bus interface without requiring any explicit\n-# binding code to be generated for a JavaScript client. A dbusjson3\n-# channel does this by doing automatic introspection and property\n-# retrieval without much direction from the JavaScript client.\n-#\n-# The details of what exactly is done is not specified very strictly,\n-# and the Python bridge will likely differ from the C bridge\n-# significantly. This will be informed by what existing code actually\n-# needs, and we might end up with a more concrete description of what\n-# a client can actually expect.\n-#\n-# Here is an example of a more complex scenario:\n-#\n-# - The client adds a \"watch\" for a path namespace. There is a\n-# ObjectManager at the given path and the bridge emits \"meta\" and\n-# \"notify\" messages to describe all interfaces and objects reported\n-# by that ObjectManager.\n-#\n-# - The client makes a method call that causes a new object with a new\n-# interface to appear at the ObjectManager. The bridge will send a\n-# \"meta\" and \"notify\" message to describe this new object.\n-#\n-# - Since the InterfacesAdded signal was emitted before the method\n-# reply, the bridge must send the \"meta\" and \"notify\" messages\n-# before the method reply message.\n-#\n-# - However, in order to construct the \"meta\" message, the bridge must\n-# perform a Introspect call, and consequently must delay sending the\n-# method reply until that call has finished.\n-#\n-# The Python bridge implements this delaying of messages with\n-# coroutines and a fair mutex. Every message coming from D-Bus will\n-# wait on the mutex for its turn to send its message on the Cockpit\n-# channel, and will keep that mutex locked until it is done with\n-# sending. Since the mutex is fair, everyone will nicely wait in line\n-# without messages getting re-ordered.\n-#\n-# The scenario above will play out like this:\n-#\n-# - While adding the initial \"watch\", the lock is held until the\n-# \"meta\" and \"notify\" messages have been sent.\n-#\n-# - Later, when the InterfacesAdded signal comes in that has been\n-# triggered by the method call, the mutex will be locked while the\n-# necessary introspection is going on.\n-#\n-# - The method reply will likely come while the mutex is locked, and\n-# the task for sending that reply on the Cockpit channel will enter\n-# the wait queue of the mutex.\n-#\n-# - Once the introspection is done and the new \"meta\" and \"notify\"\n-# messages have been sent, the mutex is unlocked, the method reply\n-# task acquires it, and sends its message.\n+ # ignore mdraid\n+ if dev_major == '9':\n+ continue\n \n+ # ignore device-mapper\n+ if dev_name.startswith('dm-'):\n+ continue\n \n-class InterfaceCache:\n- def __init__(self):\n- self.cache = {}\n- self.old = set() # Interfaces already returned by get_interface_if_new\n+ # Skip partitions\n+ if dev_name[:2] in ['sd', 'hd', 'vd'] and dev_name[-1].isdigit():\n+ continue\n \n- def inject(self, interfaces):\n- self.cache.update(interfaces)\n+ # Ignore nvme partitions\n+ if dev_name.startswith('nvme') and 'p' in dev_name:\n+ continue\n \n- async def introspect_path(self, bus, destination, object_path):\n- xml, = await bus.call_method_async(destination, object_path,\n- 'org.freedesktop.DBus.Introspectable',\n- 'Introspect')\n+ read_bytes = int(num_sectors_read) * 512\n+ written_bytes = int(num_sectors_written) * 512\n \n- et = ET.fromstring(xml)\n+ all_read_bytes += read_bytes\n+ all_written_bytes += written_bytes\n \n- interfaces = {tag.attrib['name']: introspection.parse_interface(tag) for tag in et.findall('interface')}\n+ samples['disk.dev.read'][dev_name] = read_bytes\n+ samples['disk.dev.written'][dev_name] = written_bytes\n \n- # Add all interfaces we found: we might use them later\n- self.inject(interfaces)\n+ samples['disk.all.read'] = all_read_bytes\n+ samples['disk.all.written'] = all_written_bytes\n \n- return interfaces\n \n- async def get_interface(self, interface_name, bus=None, destination=None, object_path=None):\n- try:\n- return self.cache[interface_name]\n- except KeyError:\n- pass\n+class CGroupSampler(Sampler):\n+ descriptions = [\n+ SampleDescription('cgroup.memory.usage', 'bytes', 'instant', instanced=True),\n+ SampleDescription('cgroup.memory.limit', 'bytes', 'instant', instanced=True),\n+ SampleDescription('cgroup.memory.sw-usage', 'bytes', 'instant', instanced=True),\n+ SampleDescription('cgroup.memory.sw-limit', 'bytes', 'instant', instanced=True),\n+ SampleDescription('cgroup.cpu.usage', 'millisec', 'counter', instanced=True),\n+ SampleDescription('cgroup.cpu.shares', 'count', 'instant', instanced=True),\n+ ]\n \n- if bus and object_path:\n- try:\n- await self.introspect_path(bus, destination, object_path)\n- except BusError:\n- pass\n+ cgroups_v2: Optional[bool] = None\n \n- return self.cache.get(interface_name)\n+ def sample(self, samples: Samples) -> None:\n+ if self.cgroups_v2 is None:\n+ self.cgroups_v2 = os.path.exists('/sys/fs/cgroup/cgroup.controllers')\n \n- async def get_interface_if_new(self, interface_name, bus, destination, object_path):\n- if interface_name in self.old:\n- return None\n- self.old.add(interface_name)\n- return await self.get_interface(interface_name, bus, destination, object_path)\n+ if self.cgroups_v2:\n+ cgroups_v2_path = '/sys/fs/cgroup/'\n+ for path, _, _, rootfd in os.fwalk(cgroups_v2_path):\n+ cgroup = path.replace(cgroups_v2_path, '')\n \n- async def get_signature(self, interface_name, method, bus=None, destination=None, object_path=None):\n- interface = await self.get_interface(interface_name, bus, destination, object_path)\n- if interface is None:\n- raise KeyError(f'Interface {interface_name} is not found')\n+ if not cgroup:\n+ continue\n \n- return ''.join(interface['methods'][method]['in'])\n+ samples['cgroup.memory.usage'][cgroup] = read_int_file(rootfd, 'memory.current', 0)\n+ samples['cgroup.memory.limit'][cgroup] = read_int_file(rootfd, 'memory.max')\n+ samples['cgroup.memory.sw-usage'][cgroup] = read_int_file(rootfd, 'memory.swap.current', 0)\n+ samples['cgroup.memory.sw-limit'][cgroup] = read_int_file(rootfd, 'memory.swap.max')\n+ samples['cgroup.cpu.shares'][cgroup] = read_int_file(rootfd, 'cpu.weight')\n+ usage_usec = read_int_file(rootfd, 'cpu.stat', 0, key=b'usage_usec')\n+ if usage_usec:\n+ samples['cgroup.cpu.usage'][cgroup] = usage_usec / 1000\n+ else:\n+ memory_path = '/sys/fs/cgroup/memory/'\n+ for path, _, _, rootfd in os.fwalk(memory_path):\n+ cgroup = path.replace(memory_path, '')\n \n+ if not cgroup:\n+ continue\n \n-def notify_update(notify, path, interface_name, props):\n- notify.setdefault(path, {})[interface_name] = {k: v.value for k, v in props.items()}\n+ samples['cgroup.memory.usage'][cgroup] = read_int_file(rootfd, 'memory.usage_in_bytes', 0)\n+ samples['cgroup.memory.limit'][cgroup] = read_int_file(rootfd, 'memory.limit_in_bytes')\n+ samples['cgroup.memory.sw-usage'][cgroup] = read_int_file(rootfd, 'memory.memsw.usage_in_bytes', 0)\n+ samples['cgroup.memory.sw-limit'][cgroup] = read_int_file(rootfd, 'memory.memsw.limit_in_bytes')\n \n+ cpu_path = '/sys/fs/cgroup/cpu/'\n+ for path, _, _, rootfd in os.fwalk(cpu_path):\n+ cgroup = path.replace(cpu_path, '')\n \n-class DBusChannel(Channel):\n- json_encoder = systemd_ctypes.JSONEncoder(indent=2)\n- payload = 'dbus-json3'\n+ if not cgroup:\n+ continue\n \n- matches = None\n- name = None\n- bus = None\n- owner = None\n+ samples['cgroup.cpu.shares'][cgroup] = read_int_file(rootfd, 'cpu.shares')\n+ usage_nsec = read_int_file(rootfd, 'cpuacct.usage')\n+ if usage_nsec:\n+ samples['cgroup.cpu.usage'][cgroup] = usage_nsec / 1000000\n \n- async def setup_name_owner_tracking(self):\n- def send_owner(owner):\n- # We must be careful not to send duplicate owner\n- # notifications. cockpit.js relies on that.\n- if self.owner != owner:\n- self.owner = owner\n- self.send_json(owner=owner)\n \n- def handler(message):\n- _name, _old, new = message.get_body()\n- send_owner(owner=new if new != \"\" else None)\n- self.add_signal_handler(handler,\n- sender='org.freedesktop.DBus',\n- path='/org/freedesktop/DBus',\n- interface='org.freedesktop.DBus',\n- member='NameOwnerChanged',\n- arg0=self.name)\n- try:\n- unique_name, = await self.bus.call_method_async(\"org.freedesktop.DBus\",\n- \"/org/freedesktop/DBus\",\n- \"org.freedesktop.DBus\",\n- \"GetNameOwner\", \"s\", self.name)\n- except BusError as error:\n- if error.name == \"org.freedesktop.DBus.Error.NameHasNoOwner\":\n- # Try to start it. If it starts successfully, we will\n- # get a NameOwnerChanged signal (which will set\n- # self.owner) before StartServiceByName returns.\n- try:\n- await self.bus.call_method_async(\"org.freedesktop.DBus\",\n- \"/org/freedesktop/DBus\",\n- \"org.freedesktop.DBus\",\n- \"StartServiceByName\", \"su\", self.name, 0)\n- except BusError as start_error:\n- logger.debug(\"Failed to start service '%s': %s\", self.name, start_error.message)\n- self.send_json(owner=None)\n- else:\n- logger.debug(\"Failed to get owner of service '%s': %s\", self.name, error.message)\n- else:\n- send_owner(unique_name)\n+class CGroupDiskIO(Sampler):\n+ IO_RE = re.compile(rb'\\bread_bytes: (?P\\d+).*\\nwrite_bytes: (?P\\d+)', flags=re.S)\n+ descriptions = [\n+ SampleDescription('disk.cgroup.read', 'bytes', 'counter', instanced=True),\n+ SampleDescription('disk.cgroup.written', 'bytes', 'counter', instanced=True),\n+ ]\n \n- def do_open(self, options):\n- self.cache = InterfaceCache()\n- self.name = options.get('name')\n- self.matches = []\n+ @staticmethod\n+ def get_cgroup_name(fd: int) -> str:\n+ with Handle.open('cgroup', os.O_RDONLY, dir_fd=fd) as cgroup_fd:\n+ cgroup_name = os.read(cgroup_fd, 2048).decode().strip()\n \n- bus = options.get('bus')\n- address = options.get('address')\n+ # Skip leading ::0/\n+ return cgroup_name[4:]\n \n- try:\n- if address is not None:\n- if bus is not None and bus != 'none':\n- raise ChannelError('protocol-error', message='only one of \"bus\" and \"address\" can be specified')\n- logger.debug('get bus with address %s for %s', address, self.name)\n- self.bus = Bus.new(address=address, bus_client=self.name is not None)\n- elif bus == 'internal':\n- logger.debug('get internal bus for %s', self.name)\n- self.bus = self.router.internal_bus.client\n- else:\n- if bus == 'session':\n- logger.debug('get session bus for %s', self.name)\n- self.bus = Bus.default_user()\n- elif bus == 'system' or bus is None:\n- logger.debug('get system bus for %s', self.name)\n- self.bus = Bus.default_system()\n- else:\n- raise ChannelError('protocol-error', message=f'invalid bus \"{bus}\"')\n- except OSError as exc:\n- raise ChannelError('protocol-error', message=f'failed to connect to {bus} bus: {exc}') from exc\n+ @staticmethod\n+ def get_proc_io(fd: int) -> Tuple[int, int]:\n+ with Handle.open('io', os.O_RDONLY, dir_fd=fd) as io_fd:\n+ data = os.read(io_fd, 4096)\n \n- try:\n- self.bus.attach_event(None, 0)\n- except OSError as err:\n- if err.errno != errno.EBUSY:\n- raise\n+ match = re.search(CGroupDiskIO.IO_RE, data)\n+ if match:\n+ proc_read = int(match.group('read'))\n+ proc_write = int(match.group('write'))\n \n- # This needs to be a fair mutex so that outgoing messages don't\n- # get re-ordered. asyncio.Lock is fair.\n- self.watch_processing_lock = asyncio.Lock()\n+ return proc_read, proc_write\n \n- if self.name is not None:\n- async def get_ready():\n- async with self.watch_processing_lock:\n- await self.setup_name_owner_tracking()\n- if self.owner:\n- self.ready(unique_name=self.owner)\n- else:\n- self.close({'problem': 'not-found'})\n- self.create_task(get_ready())\n- else:\n- self.ready()\n+ return 0, 0\n \n- def add_signal_handler(self, handler, **kwargs):\n- r = dict(**kwargs)\n- r['type'] = 'signal'\n- if 'sender' not in r and self.name is not None:\n- r['sender'] = self.name\n- # HACK - https://github.com/bus1/dbus-broker/issues/309\n- # path_namespace='/' in a rule does not work.\n- if r.get('path_namespace') == \"/\":\n- del r['path_namespace']\n+ def sample(self, samples: Samples):\n+ with Handle.open('/proc', os.O_RDONLY | os.O_DIRECTORY) as proc_fd:\n+ reads = samples['disk.cgroup.read']\n+ writes = samples['disk.cgroup.written']\n \n- def filter_owner(message):\n- if self.owner is not None and self.owner == message.get_sender():\n- handler(message)\n+ for path in os.listdir(proc_fd):\n+ # non-pid entries in proc are guaranteed to start with a character a-z\n+ if path[0] < '0' or path[0] > '9':\n+ continue\n \n- if self.name is not None and 'sender' in r and r['sender'] == self.name:\n- func = filter_owner\n- else:\n- func = handler\n- r_string = ','.join(f\"{key}='{value}'\" for key, value in r.items())\n- if not self.is_closing():\n- # this gets an EINTR very often especially on RHEL 8\n- while True:\n try:\n- match = self.bus.add_match(r_string, func)\n- break\n- except InterruptedError:\n- pass\n-\n- self.matches.append(match)\n-\n- def add_async_signal_handler(self, handler, **kwargs):\n- def sync_handler(message):\n- self.create_task(handler(message))\n- self.add_signal_handler(sync_handler, **kwargs)\n-\n- async def do_call(self, message):\n- path, iface, method, args = message['call']\n- cookie = message.get('id')\n- flags = message.get('flags')\n-\n- timeout = message.get('timeout')\n- if timeout is not None:\n- # sd_bus timeout is \u03bcs, cockpit API timeout is ms\n- timeout *= 1000\n- else:\n- # sd_bus has no \"indefinite\" timeout, so use MAX_UINT64\n- timeout = 2 ** 64 - 1\n-\n- # We have to figure out the signature of the call. Either we got told it:\n- signature = message.get('type')\n+ with Handle.open(path, os.O_PATH, dir_fd=proc_fd) as pid_fd:\n+ cgroup_name = self.get_cgroup_name(pid_fd)\n+ proc_read, proc_write = self.get_proc_io(pid_fd)\n+ except (FileNotFoundError, PermissionError, ProcessLookupError):\n+ continue\n \n- # ... or there aren't any arguments\n- if signature is None and len(args) == 0:\n- signature = ''\n+ reads[cgroup_name] = reads.get(cgroup_name, 0) + proc_read\n+ writes[cgroup_name] = writes.get(cgroup_name, 0) + proc_write\n \n- # ... or we need to introspect\n- if signature is None:\n- try:\n- logger.debug('Doing introspection request for %s %s', iface, method)\n- signature = await self.cache.get_signature(iface, method, self.bus, self.name, path)\n- except BusError as error:\n- self.send_json(error=[error.name, [f'Introspection: {error.message}']], id=cookie)\n- return\n- except KeyError:\n- self.send_json(\n- error=[\n- \"org.freedesktop.DBus.Error.UnknownMethod\",\n- [f\"Introspection data for method {iface} {method} not available\"]],\n- id=cookie)\n- return\n- except Exception as exc:\n- self.send_json(error=['python.error', [f'Introspection: {exc!s}']], id=cookie)\n- return\n \n- try:\n- method_call = self.bus.message_new_method_call(self.name, path, iface, method, signature, *args)\n- reply = await self.bus.call_async(method_call, timeout=timeout)\n- # If the method call has kicked off any signals related to\n- # watch processing, wait for that to be done.\n- async with self.watch_processing_lock:\n- # TODO: stop hard-coding the endian flag here.\n- self.send_json(\n- reply=[reply.get_body()], id=cookie,\n- flags=\"<\" if flags is not None else None,\n- type=reply.get_signature(True)) # noqa: FBT003\n- except BusError as error:\n- # actually, should send the fields from the message body\n- self.send_json(error=[error.name, [error.message]], id=cookie)\n- except Exception:\n- logger.exception(\"do_call(%s): generic exception\", message)\n- self.send_json(error=['python.error', [traceback.format_exc()]], id=cookie)\n+class NetworkSampler(Sampler):\n+ descriptions = [\n+ SampleDescription('network.interface.tx', 'bytes', 'counter', instanced=True),\n+ SampleDescription('network.interface.rx', 'bytes', 'counter', instanced=True),\n+ ]\n \n- async def do_add_match(self, message):\n- add_match = message['add-match']\n- logger.debug('adding match %s', add_match)\n+ def sample(self, samples: Samples) -> None:\n+ with open(\"/proc/net/dev\") as network_samples:\n+ for line in network_samples:\n+ fields = line.split()\n \n- async def match_hit(message):\n- logger.debug('got match')\n- async with self.watch_processing_lock:\n- self.send_json(signal=[\n- message.get_path(),\n- message.get_interface(),\n- message.get_member(),\n- list(message.get_body())\n- ])\n+ # Skip header line\n+ if fields[0][-1] != ':':\n+ continue\n \n- self.add_async_signal_handler(match_hit, **add_match)\n+ iface = fields[0][:-1]\n+ samples['network.interface.rx'][iface] = int(fields[1])\n+ samples['network.interface.tx'][iface] = int(fields[9])\n \n- async def setup_objectmanager_watch(self, path, interface_name, meta, notify):\n- # Watch the objects managed by the ObjectManager at \"path\".\n- # Properties are not watched, that is done by setup_path_watch\n- # below via recursive_props == True.\n \n- async def handler(message):\n- member = message.get_member()\n- if member == \"InterfacesAdded\":\n- (path, interface_props) = message.get_body()\n- logger.debug('interfaces added %s %s', path, interface_props)\n- meta = {}\n- notify = {}\n- async with self.watch_processing_lock:\n- for name, props in interface_props.items():\n- if interface_name is None or name == interface_name:\n- mm = await self.cache.get_interface_if_new(name, self.bus, self.name, path)\n- if mm:\n- meta.update({name: mm})\n- notify_update(notify, path, name, props)\n- self.send_json(meta=meta)\n- self.send_json(notify=notify)\n- elif member == \"InterfacesRemoved\":\n- (path, interfaces) = message.get_body()\n- logger.debug('interfaces removed %s %s', path, interfaces)\n- async with self.watch_processing_lock:\n- notify = {path: dict.fromkeys(interfaces)}\n- self.send_json(notify=notify)\n+class MountSampler(Sampler):\n+ descriptions = [\n+ SampleDescription('mount.total', 'bytes', 'instant', instanced=True),\n+ SampleDescription('mount.used', 'bytes', 'instant', instanced=True),\n+ ]\n \n- self.add_async_signal_handler(handler,\n- path=path,\n- interface=\"org.freedesktop.DBus.ObjectManager\")\n- objects, = await self.bus.call_method_async(self.name, path,\n- 'org.freedesktop.DBus.ObjectManager',\n- 'GetManagedObjects')\n- for p, ifaces in objects.items():\n- for iface, props in ifaces.items():\n- if interface_name is None or iface == interface_name:\n- mm = await self.cache.get_interface_if_new(iface, self.bus, self.name, p)\n- if mm:\n- meta.update({iface: mm})\n- notify_update(notify, p, iface, props)\n+ def sample(self, samples: Samples) -> None:\n+ with open('/proc/mounts') as mounts:\n+ for line in mounts:\n+ # Only look at real devices\n+ if line[0] != '/':\n+ continue\n \n- async def setup_path_watch(self, path, interface_name, recursive_props, meta, notify):\n- # Watch a single object at \"path\", but maybe also watch for\n- # property changes for all objects below \"path\".\n+ path = line.split()[1]\n+ try:\n+ res = os.statvfs(path)\n+ except OSError:\n+ continue\n+ frsize = res.f_frsize\n+ total = frsize * res.f_blocks\n+ samples['mount.total'][path] = total\n+ samples['mount.used'][path] = total - frsize * res.f_bfree\n \n- async def handler(message):\n- async with self.watch_processing_lock:\n- path = message.get_path()\n- name, props, invalids = message.get_body()\n- logger.debug('NOTIFY: %s %s %s %s', path, name, props, invalids)\n- for inv in invalids:\n- try:\n- reply, = await self.bus.call_method_async(self.name, path,\n- 'org.freedesktop.DBus.Properties', 'Get',\n- 'ss', name, inv)\n- except BusError as exc:\n- logger.debug('failed to fetch property %s.%s on %s %s: %s',\n- name, inv, self.name, path, str(exc))\n- continue\n- props[inv] = reply\n- notify = {}\n- notify_update(notify, path, name, props)\n- self.send_json(notify=notify)\n \n- this_meta = await self.cache.introspect_path(self.bus, self.name, path)\n- if interface_name is not None:\n- interface = this_meta.get(interface_name)\n- this_meta = {interface_name: interface}\n- meta.update(this_meta)\n- if recursive_props:\n- self.add_async_signal_handler(handler,\n- interface=\"org.freedesktop.DBus.Properties\",\n- path_namespace=path)\n- else:\n- self.add_async_signal_handler(handler,\n- interface=\"org.freedesktop.DBus.Properties\",\n- path=path)\n+class BlockSampler(Sampler):\n+ descriptions = [\n+ SampleDescription('block.device.read', 'bytes', 'counter', instanced=True),\n+ SampleDescription('block.device.written', 'bytes', 'counter', instanced=True),\n+ ]\n \n- for name in meta:\n- if name.startswith(\"org.freedesktop.DBus.\"):\n- continue\n- try:\n- props, = await self.bus.call_method_async(self.name, path,\n- 'org.freedesktop.DBus.Properties',\n- 'GetAll', 's', name)\n- notify_update(notify, path, name, props)\n- except BusError:\n- pass\n+ def sample(self, samples: Samples) -> None:\n+ with open('/proc/diskstats') as diskstats:\n+ for line in diskstats:\n+ # https://www.kernel.org/doc/Documentation/ABI/testing/procfs-diskstats\n+ [_, _, dev_name, _, _, sectors_read, _, _, _, sectors_written, *_] = line.strip().split()\n \n- async def do_watch(self, message):\n- watch = message['watch']\n- path = watch.get('path')\n- path_namespace = watch.get('path_namespace')\n- interface_name = watch.get('interface')\n- cookie = message.get('id')\n+ samples['block.device.read'][dev_name] = int(sectors_read) * 512\n+ samples['block.device.written'][dev_name] = int(sectors_written) * 512\n \n- path = path or path_namespace\n- recursive = path == path_namespace\n \n- if path is None or cookie is None:\n- logger.debug('ignored incomplete watch request %s', message)\n- self.send_json(error=['x.y.z', ['Not Implemented']], id=cookie)\n- self.send_json(reply=[], id=cookie)\n- return\n+SAMPLERS = [\n+ BlockSampler,\n+ CGroupSampler,\n+ CGroupDiskIO,\n+ CPUSampler,\n+ CPUTemperatureSampler,\n+ DiskSampler,\n+ MemorySampler,\n+ MountSampler,\n+ NetworkSampler,\n+]\n+''',\n+ 'cockpit/data/fail.html': br'''\n+\n+\n+ @@message@@\n+ \n+ \n+ \n+\n+\n+
\n+ \n+

@@message@@

\n+
\n+\n+\n+''',\n+ 'cockpit/data/__init__.py': br'''import sys\n \n- try:\n- async with self.watch_processing_lock:\n- meta = {}\n- notify = {}\n- await self.setup_path_watch(path, interface_name, recursive, meta, notify)\n- if recursive:\n- await self.setup_objectmanager_watch(path, interface_name, meta, notify)\n- self.send_json(meta=meta)\n- self.send_json(notify=notify)\n- self.send_json(reply=[], id=message['id'])\n- except BusError as error:\n- logger.debug(\"do_watch(%s) caught D-Bus error: %s\", message, error.message)\n- self.send_json(error=[error.name, [error.message]], id=cookie)\n+if sys.version_info >= (3, 11):\n+ import importlib.resources\n \n- async def do_meta(self, message):\n- self.cache.inject(message['meta'])\n+ def read_cockpit_data_file(filename: str) -> bytes:\n+ return (importlib.resources.files('cockpit.data') / filename).read_bytes()\n \n- def do_data(self, data):\n- message = json.loads(data)\n- logger.debug('receive dbus request %s %s', self.name, message)\n+else:\n+ import importlib.abc\n \n- if 'call' in message:\n- self.create_task(self.do_call(message))\n- elif 'add-match' in message:\n- self.create_task(self.do_add_match(message))\n- elif 'watch' in message:\n- self.create_task(self.do_watch(message))\n- elif 'meta' in message:\n- self.create_task(self.do_meta(message))\n- else:\n- logger.debug('ignored dbus request %s', message)\n- return\n+ def read_cockpit_data_file(filename: str) -> bytes:\n+ # https://github.com/python/mypy/issues/4182\n+ loader = __loader__ # type: ignore[name-defined]\n+ assert isinstance(loader, importlib.abc.ResourceLoader)\n \n- def do_close(self):\n- for slot in self.matches:\n- slot.cancel()\n- self.matches = []\n- self.close()\n-'''.encode('utf-8'),\n+ path = __file__.replace('__init__.py', filename)\n+ return loader.get_data(path)\n+''',\n 'cockpit/channels/filesystem.py': r'''# This file is part of Cockpit.\n #\n # Copyright (C) 2022 Red Hat, Inc.\n #\n # This program is free software: you can redistribute it and/or modify\n # it under the terms of the GNU General Public License as published by\n # the Free Software Foundation, either version 3 of the License, or\n@@ -6192,14 +5555,623 @@\n \n else:\n # PathWatch will call do_identity_changed(), which does the same as\n # above: calls either report_initial_state() or report_error(),\n # depending on if it was provided with an fd or an error code.\n self.path_watch = PathWatch(self.path, self)\n '''.encode('utf-8'),\n+ 'cockpit/channels/dbus.py': r'''# This file is part of Cockpit.\n+#\n+# Copyright (C) 2022 Red Hat, Inc.\n+#\n+# This program is free software: you can redistribute it and/or modify\n+# it under the terms of the GNU General Public License as published by\n+# the Free Software Foundation, either version 3 of the License, or\n+# (at your option) any later version.\n+#\n+# This program is distributed in the hope that it will be useful,\n+# but WITHOUT ANY WARRANTY; without even the implied warranty of\n+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n+# GNU General Public License for more details.\n+#\n+# You should have received a copy of the GNU General Public License\n+# along with this program. If not, see .\n+\n+# Missing stuff compared to the C bridge that we should probably add:\n+#\n+# - removing matches\n+# - removing watches\n+# - emitting of signals\n+# - publishing of objects\n+# - failing more gracefully in some cases (during open, etc)\n+#\n+# Stuff we might or might not do:\n+#\n+# - using non-default service names\n+#\n+# Stuff we should probably not do:\n+#\n+# - emulation of ObjectManager via recursive introspection\n+# - automatic detection of ObjectManager below the given path_namespace\n+# - recursive scraping of properties for new object paths\n+# (for path_namespace watches that don't hit an ObjectManager)\n+\n+import asyncio\n+import errno\n+import json\n+import logging\n+import traceback\n+import xml.etree.ElementTree as ET\n+\n+from cockpit._vendor import systemd_ctypes\n+from cockpit._vendor.systemd_ctypes import Bus, BusError, introspection\n+\n+from ..channel import Channel, ChannelError\n+\n+logger = logging.getLogger(__name__)\n+\n+# The dbusjson3 payload\n+#\n+# This channel payload type translates JSON encoded messages on a\n+# Cockpit channel to D-Bus messages, in a mostly straightforward way.\n+# See doc/protocol.md for a description of the basics.\n+#\n+# However, dbusjson3 offers some advanced features as well that are\n+# meant to support the \"magic\" DBusProxy objects implemented by\n+# cockpit.js. Those proxy objects \"magically\" expose all the methods\n+# and properties of a D-Bus interface without requiring any explicit\n+# binding code to be generated for a JavaScript client. A dbusjson3\n+# channel does this by doing automatic introspection and property\n+# retrieval without much direction from the JavaScript client.\n+#\n+# The details of what exactly is done is not specified very strictly,\n+# and the Python bridge will likely differ from the C bridge\n+# significantly. This will be informed by what existing code actually\n+# needs, and we might end up with a more concrete description of what\n+# a client can actually expect.\n+#\n+# Here is an example of a more complex scenario:\n+#\n+# - The client adds a \"watch\" for a path namespace. There is a\n+# ObjectManager at the given path and the bridge emits \"meta\" and\n+# \"notify\" messages to describe all interfaces and objects reported\n+# by that ObjectManager.\n+#\n+# - The client makes a method call that causes a new object with a new\n+# interface to appear at the ObjectManager. The bridge will send a\n+# \"meta\" and \"notify\" message to describe this new object.\n+#\n+# - Since the InterfacesAdded signal was emitted before the method\n+# reply, the bridge must send the \"meta\" and \"notify\" messages\n+# before the method reply message.\n+#\n+# - However, in order to construct the \"meta\" message, the bridge must\n+# perform a Introspect call, and consequently must delay sending the\n+# method reply until that call has finished.\n+#\n+# The Python bridge implements this delaying of messages with\n+# coroutines and a fair mutex. Every message coming from D-Bus will\n+# wait on the mutex for its turn to send its message on the Cockpit\n+# channel, and will keep that mutex locked until it is done with\n+# sending. Since the mutex is fair, everyone will nicely wait in line\n+# without messages getting re-ordered.\n+#\n+# The scenario above will play out like this:\n+#\n+# - While adding the initial \"watch\", the lock is held until the\n+# \"meta\" and \"notify\" messages have been sent.\n+#\n+# - Later, when the InterfacesAdded signal comes in that has been\n+# triggered by the method call, the mutex will be locked while the\n+# necessary introspection is going on.\n+#\n+# - The method reply will likely come while the mutex is locked, and\n+# the task for sending that reply on the Cockpit channel will enter\n+# the wait queue of the mutex.\n+#\n+# - Once the introspection is done and the new \"meta\" and \"notify\"\n+# messages have been sent, the mutex is unlocked, the method reply\n+# task acquires it, and sends its message.\n+\n+\n+class InterfaceCache:\n+ def __init__(self):\n+ self.cache = {}\n+ self.old = set() # Interfaces already returned by get_interface_if_new\n+\n+ def inject(self, interfaces):\n+ self.cache.update(interfaces)\n+\n+ async def introspect_path(self, bus, destination, object_path):\n+ xml, = await bus.call_method_async(destination, object_path,\n+ 'org.freedesktop.DBus.Introspectable',\n+ 'Introspect')\n+\n+ et = ET.fromstring(xml)\n+\n+ interfaces = {tag.attrib['name']: introspection.parse_interface(tag) for tag in et.findall('interface')}\n+\n+ # Add all interfaces we found: we might use them later\n+ self.inject(interfaces)\n+\n+ return interfaces\n+\n+ async def get_interface(self, interface_name, bus=None, destination=None, object_path=None):\n+ try:\n+ return self.cache[interface_name]\n+ except KeyError:\n+ pass\n+\n+ if bus and object_path:\n+ try:\n+ await self.introspect_path(bus, destination, object_path)\n+ except BusError:\n+ pass\n+\n+ return self.cache.get(interface_name)\n+\n+ async def get_interface_if_new(self, interface_name, bus, destination, object_path):\n+ if interface_name in self.old:\n+ return None\n+ self.old.add(interface_name)\n+ return await self.get_interface(interface_name, bus, destination, object_path)\n+\n+ async def get_signature(self, interface_name, method, bus=None, destination=None, object_path=None):\n+ interface = await self.get_interface(interface_name, bus, destination, object_path)\n+ if interface is None:\n+ raise KeyError(f'Interface {interface_name} is not found')\n+\n+ return ''.join(interface['methods'][method]['in'])\n+\n+\n+def notify_update(notify, path, interface_name, props):\n+ notify.setdefault(path, {})[interface_name] = {k: v.value for k, v in props.items()}\n+\n+\n+class DBusChannel(Channel):\n+ json_encoder = systemd_ctypes.JSONEncoder(indent=2)\n+ payload = 'dbus-json3'\n+\n+ matches = None\n+ name = None\n+ bus = None\n+ owner = None\n+\n+ async def setup_name_owner_tracking(self):\n+ def send_owner(owner):\n+ # We must be careful not to send duplicate owner\n+ # notifications. cockpit.js relies on that.\n+ if self.owner != owner:\n+ self.owner = owner\n+ self.send_json(owner=owner)\n+\n+ def handler(message):\n+ _name, _old, new = message.get_body()\n+ send_owner(owner=new if new != \"\" else None)\n+ self.add_signal_handler(handler,\n+ sender='org.freedesktop.DBus',\n+ path='/org/freedesktop/DBus',\n+ interface='org.freedesktop.DBus',\n+ member='NameOwnerChanged',\n+ arg0=self.name)\n+ try:\n+ unique_name, = await self.bus.call_method_async(\"org.freedesktop.DBus\",\n+ \"/org/freedesktop/DBus\",\n+ \"org.freedesktop.DBus\",\n+ \"GetNameOwner\", \"s\", self.name)\n+ except BusError as error:\n+ if error.name == \"org.freedesktop.DBus.Error.NameHasNoOwner\":\n+ # Try to start it. If it starts successfully, we will\n+ # get a NameOwnerChanged signal (which will set\n+ # self.owner) before StartServiceByName returns.\n+ try:\n+ await self.bus.call_method_async(\"org.freedesktop.DBus\",\n+ \"/org/freedesktop/DBus\",\n+ \"org.freedesktop.DBus\",\n+ \"StartServiceByName\", \"su\", self.name, 0)\n+ except BusError as start_error:\n+ logger.debug(\"Failed to start service '%s': %s\", self.name, start_error.message)\n+ self.send_json(owner=None)\n+ else:\n+ logger.debug(\"Failed to get owner of service '%s': %s\", self.name, error.message)\n+ else:\n+ send_owner(unique_name)\n+\n+ def do_open(self, options):\n+ self.cache = InterfaceCache()\n+ self.name = options.get('name')\n+ self.matches = []\n+\n+ bus = options.get('bus')\n+ address = options.get('address')\n+\n+ try:\n+ if address is not None:\n+ if bus is not None and bus != 'none':\n+ raise ChannelError('protocol-error', message='only one of \"bus\" and \"address\" can be specified')\n+ logger.debug('get bus with address %s for %s', address, self.name)\n+ self.bus = Bus.new(address=address, bus_client=self.name is not None)\n+ elif bus == 'internal':\n+ logger.debug('get internal bus for %s', self.name)\n+ self.bus = self.router.internal_bus.client\n+ else:\n+ if bus == 'session':\n+ logger.debug('get session bus for %s', self.name)\n+ self.bus = Bus.default_user()\n+ elif bus == 'system' or bus is None:\n+ logger.debug('get system bus for %s', self.name)\n+ self.bus = Bus.default_system()\n+ else:\n+ raise ChannelError('protocol-error', message=f'invalid bus \"{bus}\"')\n+ except OSError as exc:\n+ raise ChannelError('protocol-error', message=f'failed to connect to {bus} bus: {exc}') from exc\n+\n+ try:\n+ self.bus.attach_event(None, 0)\n+ except OSError as err:\n+ if err.errno != errno.EBUSY:\n+ raise\n+\n+ # This needs to be a fair mutex so that outgoing messages don't\n+ # get re-ordered. asyncio.Lock is fair.\n+ self.watch_processing_lock = asyncio.Lock()\n+\n+ if self.name is not None:\n+ async def get_ready():\n+ async with self.watch_processing_lock:\n+ await self.setup_name_owner_tracking()\n+ if self.owner:\n+ self.ready(unique_name=self.owner)\n+ else:\n+ self.close({'problem': 'not-found'})\n+ self.create_task(get_ready())\n+ else:\n+ self.ready()\n+\n+ def add_signal_handler(self, handler, **kwargs):\n+ r = dict(**kwargs)\n+ r['type'] = 'signal'\n+ if 'sender' not in r and self.name is not None:\n+ r['sender'] = self.name\n+ # HACK - https://github.com/bus1/dbus-broker/issues/309\n+ # path_namespace='/' in a rule does not work.\n+ if r.get('path_namespace') == \"/\":\n+ del r['path_namespace']\n+\n+ def filter_owner(message):\n+ if self.owner is not None and self.owner == message.get_sender():\n+ handler(message)\n+\n+ if self.name is not None and 'sender' in r and r['sender'] == self.name:\n+ func = filter_owner\n+ else:\n+ func = handler\n+ r_string = ','.join(f\"{key}='{value}'\" for key, value in r.items())\n+ if not self.is_closing():\n+ # this gets an EINTR very often especially on RHEL 8\n+ while True:\n+ try:\n+ match = self.bus.add_match(r_string, func)\n+ break\n+ except InterruptedError:\n+ pass\n+\n+ self.matches.append(match)\n+\n+ def add_async_signal_handler(self, handler, **kwargs):\n+ def sync_handler(message):\n+ self.create_task(handler(message))\n+ self.add_signal_handler(sync_handler, **kwargs)\n+\n+ async def do_call(self, message):\n+ path, iface, method, args = message['call']\n+ cookie = message.get('id')\n+ flags = message.get('flags')\n+\n+ timeout = message.get('timeout')\n+ if timeout is not None:\n+ # sd_bus timeout is \u03bcs, cockpit API timeout is ms\n+ timeout *= 1000\n+ else:\n+ # sd_bus has no \"indefinite\" timeout, so use MAX_UINT64\n+ timeout = 2 ** 64 - 1\n+\n+ # We have to figure out the signature of the call. Either we got told it:\n+ signature = message.get('type')\n+\n+ # ... or there aren't any arguments\n+ if signature is None and len(args) == 0:\n+ signature = ''\n+\n+ # ... or we need to introspect\n+ if signature is None:\n+ try:\n+ logger.debug('Doing introspection request for %s %s', iface, method)\n+ signature = await self.cache.get_signature(iface, method, self.bus, self.name, path)\n+ except BusError as error:\n+ self.send_json(error=[error.name, [f'Introspection: {error.message}']], id=cookie)\n+ return\n+ except KeyError:\n+ self.send_json(\n+ error=[\n+ \"org.freedesktop.DBus.Error.UnknownMethod\",\n+ [f\"Introspection data for method {iface} {method} not available\"]],\n+ id=cookie)\n+ return\n+ except Exception as exc:\n+ self.send_json(error=['python.error', [f'Introspection: {exc!s}']], id=cookie)\n+ return\n+\n+ try:\n+ method_call = self.bus.message_new_method_call(self.name, path, iface, method, signature, *args)\n+ reply = await self.bus.call_async(method_call, timeout=timeout)\n+ # If the method call has kicked off any signals related to\n+ # watch processing, wait for that to be done.\n+ async with self.watch_processing_lock:\n+ # TODO: stop hard-coding the endian flag here.\n+ self.send_json(\n+ reply=[reply.get_body()], id=cookie,\n+ flags=\"<\" if flags is not None else None,\n+ type=reply.get_signature(True)) # noqa: FBT003\n+ except BusError as error:\n+ # actually, should send the fields from the message body\n+ self.send_json(error=[error.name, [error.message]], id=cookie)\n+ except Exception:\n+ logger.exception(\"do_call(%s): generic exception\", message)\n+ self.send_json(error=['python.error', [traceback.format_exc()]], id=cookie)\n+\n+ async def do_add_match(self, message):\n+ add_match = message['add-match']\n+ logger.debug('adding match %s', add_match)\n+\n+ async def match_hit(message):\n+ logger.debug('got match')\n+ async with self.watch_processing_lock:\n+ self.send_json(signal=[\n+ message.get_path(),\n+ message.get_interface(),\n+ message.get_member(),\n+ list(message.get_body())\n+ ])\n+\n+ self.add_async_signal_handler(match_hit, **add_match)\n+\n+ async def setup_objectmanager_watch(self, path, interface_name, meta, notify):\n+ # Watch the objects managed by the ObjectManager at \"path\".\n+ # Properties are not watched, that is done by setup_path_watch\n+ # below via recursive_props == True.\n+\n+ async def handler(message):\n+ member = message.get_member()\n+ if member == \"InterfacesAdded\":\n+ (path, interface_props) = message.get_body()\n+ logger.debug('interfaces added %s %s', path, interface_props)\n+ meta = {}\n+ notify = {}\n+ async with self.watch_processing_lock:\n+ for name, props in interface_props.items():\n+ if interface_name is None or name == interface_name:\n+ mm = await self.cache.get_interface_if_new(name, self.bus, self.name, path)\n+ if mm:\n+ meta.update({name: mm})\n+ notify_update(notify, path, name, props)\n+ self.send_json(meta=meta)\n+ self.send_json(notify=notify)\n+ elif member == \"InterfacesRemoved\":\n+ (path, interfaces) = message.get_body()\n+ logger.debug('interfaces removed %s %s', path, interfaces)\n+ async with self.watch_processing_lock:\n+ notify = {path: dict.fromkeys(interfaces)}\n+ self.send_json(notify=notify)\n+\n+ self.add_async_signal_handler(handler,\n+ path=path,\n+ interface=\"org.freedesktop.DBus.ObjectManager\")\n+ objects, = await self.bus.call_method_async(self.name, path,\n+ 'org.freedesktop.DBus.ObjectManager',\n+ 'GetManagedObjects')\n+ for p, ifaces in objects.items():\n+ for iface, props in ifaces.items():\n+ if interface_name is None or iface == interface_name:\n+ mm = await self.cache.get_interface_if_new(iface, self.bus, self.name, p)\n+ if mm:\n+ meta.update({iface: mm})\n+ notify_update(notify, p, iface, props)\n+\n+ async def setup_path_watch(self, path, interface_name, recursive_props, meta, notify):\n+ # Watch a single object at \"path\", but maybe also watch for\n+ # property changes for all objects below \"path\".\n+\n+ async def handler(message):\n+ async with self.watch_processing_lock:\n+ path = message.get_path()\n+ name, props, invalids = message.get_body()\n+ logger.debug('NOTIFY: %s %s %s %s', path, name, props, invalids)\n+ for inv in invalids:\n+ try:\n+ reply, = await self.bus.call_method_async(self.name, path,\n+ 'org.freedesktop.DBus.Properties', 'Get',\n+ 'ss', name, inv)\n+ except BusError as exc:\n+ logger.debug('failed to fetch property %s.%s on %s %s: %s',\n+ name, inv, self.name, path, str(exc))\n+ continue\n+ props[inv] = reply\n+ notify = {}\n+ notify_update(notify, path, name, props)\n+ self.send_json(notify=notify)\n+\n+ this_meta = await self.cache.introspect_path(self.bus, self.name, path)\n+ if interface_name is not None:\n+ interface = this_meta.get(interface_name)\n+ this_meta = {interface_name: interface}\n+ meta.update(this_meta)\n+ if recursive_props:\n+ self.add_async_signal_handler(handler,\n+ interface=\"org.freedesktop.DBus.Properties\",\n+ path_namespace=path)\n+ else:\n+ self.add_async_signal_handler(handler,\n+ interface=\"org.freedesktop.DBus.Properties\",\n+ path=path)\n+\n+ for name in meta:\n+ if name.startswith(\"org.freedesktop.DBus.\"):\n+ continue\n+ try:\n+ props, = await self.bus.call_method_async(self.name, path,\n+ 'org.freedesktop.DBus.Properties',\n+ 'GetAll', 's', name)\n+ notify_update(notify, path, name, props)\n+ except BusError:\n+ pass\n+\n+ async def do_watch(self, message):\n+ watch = message['watch']\n+ path = watch.get('path')\n+ path_namespace = watch.get('path_namespace')\n+ interface_name = watch.get('interface')\n+ cookie = message.get('id')\n+\n+ path = path or path_namespace\n+ recursive = path == path_namespace\n+\n+ if path is None or cookie is None:\n+ logger.debug('ignored incomplete watch request %s', message)\n+ self.send_json(error=['x.y.z', ['Not Implemented']], id=cookie)\n+ self.send_json(reply=[], id=cookie)\n+ return\n+\n+ try:\n+ async with self.watch_processing_lock:\n+ meta = {}\n+ notify = {}\n+ await self.setup_path_watch(path, interface_name, recursive, meta, notify)\n+ if recursive:\n+ await self.setup_objectmanager_watch(path, interface_name, meta, notify)\n+ self.send_json(meta=meta)\n+ self.send_json(notify=notify)\n+ self.send_json(reply=[], id=message['id'])\n+ except BusError as error:\n+ logger.debug(\"do_watch(%s) caught D-Bus error: %s\", message, error.message)\n+ self.send_json(error=[error.name, [error.message]], id=cookie)\n+\n+ async def do_meta(self, message):\n+ self.cache.inject(message['meta'])\n+\n+ def do_data(self, data):\n+ message = json.loads(data)\n+ logger.debug('receive dbus request %s %s', self.name, message)\n+\n+ if 'call' in message:\n+ self.create_task(self.do_call(message))\n+ elif 'add-match' in message:\n+ self.create_task(self.do_add_match(message))\n+ elif 'watch' in message:\n+ self.create_task(self.do_watch(message))\n+ elif 'meta' in message:\n+ self.create_task(self.do_meta(message))\n+ else:\n+ logger.debug('ignored dbus request %s', message)\n+ return\n+\n+ def do_close(self):\n+ for slot in self.matches:\n+ slot.cancel()\n+ self.matches = []\n+ self.close()\n+'''.encode('utf-8'),\n+ 'cockpit/channels/trivial.py': br'''# This file is part of Cockpit.\n+#\n+# Copyright (C) 2022 Red Hat, Inc.\n+#\n+# This program is free software: you can redistribute it and/or modify\n+# it under the terms of the GNU General Public License as published by\n+# the Free Software Foundation, either version 3 of the License, or\n+# (at your option) any later version.\n+#\n+# This program is distributed in the hope that it will be useful,\n+# but WITHOUT ANY WARRANTY; without even the implied warranty of\n+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n+# GNU General Public License for more details.\n+#\n+# You should have received a copy of the GNU General Public License\n+# along with this program. If not, see .\n+\n+import logging\n+\n+from ..channel import Channel\n+\n+logger = logging.getLogger(__name__)\n+\n+\n+class EchoChannel(Channel):\n+ payload = 'echo'\n+\n+ def do_open(self, options):\n+ self.ready()\n+\n+ def do_data(self, data):\n+ self.send_data(data)\n+\n+ def do_done(self):\n+ self.done()\n+ self.close()\n+\n+\n+class NullChannel(Channel):\n+ payload = 'null'\n+\n+ def do_open(self, options):\n+ self.ready()\n+\n+ def do_close(self):\n+ self.close()\n+''',\n+ 'cockpit/channels/__init__.py': br'''# This file is part of Cockpit.\n+#\n+# Copyright (C) 2022 Red Hat, Inc.\n+#\n+# This program is free software: you can redistribute it and/or modify\n+# it under the terms of the GNU General Public License as published by\n+# the Free Software Foundation, either version 3 of the License, or\n+# (at your option) any later version.\n+#\n+# This program is distributed in the hope that it will be useful,\n+# but WITHOUT ANY WARRANTY; without even the implied warranty of\n+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n+# GNU General Public License for more details.\n+#\n+# You should have received a copy of the GNU General Public License\n+# along with this program. If not, see .\n+\n+from .dbus import DBusChannel\n+from .filesystem import FsInfoChannel, FsListChannel, FsReadChannel, FsReplaceChannel, FsWatchChannel\n+from .http import HttpChannel\n+from .metrics import InternalMetricsChannel\n+from .packages import PackagesChannel\n+from .stream import SocketStreamChannel, SubprocessStreamChannel\n+from .trivial import EchoChannel, NullChannel\n+\n+CHANNEL_TYPES = [\n+ DBusChannel,\n+ EchoChannel,\n+ FsInfoChannel,\n+ FsListChannel,\n+ FsReadChannel,\n+ FsReplaceChannel,\n+ FsWatchChannel,\n+ HttpChannel,\n+ InternalMetricsChannel,\n+ NullChannel,\n+ PackagesChannel,\n+ SubprocessStreamChannel,\n+ SocketStreamChannel,\n+]\n+''',\n 'cockpit/channels/packages.py': br'''# This file is part of Cockpit.\n #\n # Copyright (C) 2022 Red Hat, Inc.\n #\n # This program is free software: you can redistribute it and/or modify\n # it under the terms of the GNU General Public License as published by\n # the Free Software Foundation, either version 3 of the License, or\n@@ -6415,102 +6387,14 @@\n raise ChannelError('not-found') from error\n except PermissionError as error:\n raise ChannelError('access-denied') from error\n except OSError as error:\n logger.info(\"Failed to spawn %s: %s\", args, str(error))\n raise ChannelError('internal-error') from error\n ''',\n- 'cockpit/channels/trivial.py': br'''# This file is part of Cockpit.\n-#\n-# Copyright (C) 2022 Red Hat, Inc.\n-#\n-# This program is free software: you can redistribute it and/or modify\n-# it under the terms of the GNU General Public License as published by\n-# the Free Software Foundation, either version 3 of the License, or\n-# (at your option) any later version.\n-#\n-# This program is distributed in the hope that it will be useful,\n-# but WITHOUT ANY WARRANTY; without even the implied warranty of\n-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n-# GNU General Public License for more details.\n-#\n-# You should have received a copy of the GNU General Public License\n-# along with this program. If not, see .\n-\n-import logging\n-\n-from ..channel import Channel\n-\n-logger = logging.getLogger(__name__)\n-\n-\n-class EchoChannel(Channel):\n- payload = 'echo'\n-\n- def do_open(self, options):\n- self.ready()\n-\n- def do_data(self, data):\n- self.send_data(data)\n-\n- def do_done(self):\n- self.done()\n- self.close()\n-\n-\n-class NullChannel(Channel):\n- payload = 'null'\n-\n- def do_open(self, options):\n- self.ready()\n-\n- def do_close(self):\n- self.close()\n-''',\n- 'cockpit/channels/__init__.py': br'''# This file is part of Cockpit.\n-#\n-# Copyright (C) 2022 Red Hat, Inc.\n-#\n-# This program is free software: you can redistribute it and/or modify\n-# it under the terms of the GNU General Public License as published by\n-# the Free Software Foundation, either version 3 of the License, or\n-# (at your option) any later version.\n-#\n-# This program is distributed in the hope that it will be useful,\n-# but WITHOUT ANY WARRANTY; without even the implied warranty of\n-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n-# GNU General Public License for more details.\n-#\n-# You should have received a copy of the GNU General Public License\n-# along with this program. If not, see .\n-\n-from .dbus import DBusChannel\n-from .filesystem import FsInfoChannel, FsListChannel, FsReadChannel, FsReplaceChannel, FsWatchChannel\n-from .http import HttpChannel\n-from .metrics import InternalMetricsChannel\n-from .packages import PackagesChannel\n-from .stream import SocketStreamChannel, SubprocessStreamChannel\n-from .trivial import EchoChannel, NullChannel\n-\n-CHANNEL_TYPES = [\n- DBusChannel,\n- EchoChannel,\n- FsInfoChannel,\n- FsListChannel,\n- FsReadChannel,\n- FsReplaceChannel,\n- FsWatchChannel,\n- HttpChannel,\n- InternalMetricsChannel,\n- NullChannel,\n- PackagesChannel,\n- SubprocessStreamChannel,\n- SocketStreamChannel,\n-]\n-''',\n 'cockpit/channels/http.py': br'''# This file is part of Cockpit.\n #\n # Copyright (C) 2022 Red Hat, Inc.\n #\n # This program is free software: you can redistribute it and/or modify\n # it under the terms of the GNU General Public License as published by\n # the Free Software Foundation, either version 3 of the License, or\n@@ -6635,1562 +6519,222 @@\n except (OSError, IOError) as exc:\n raise ChannelError('not-found', message=str(exc)) from exc\n \n # Submit request in a thread and handle errors\n try:\n response = await loop.run_in_executor(None, self.request, connection, method, path, headers or {}, body)\n except (http.client.HTTPException, OSError) as exc:\n- raise ChannelError('terminated', message=str(exc)) from exc\n-\n- self.send_control(command='response',\n- status=response.status,\n- reason=response.reason,\n- headers=self.get_headers(response, binary=binary))\n-\n- # Receive the body and finish up\n- try:\n- while True:\n- block = await loop.run_in_executor(None, response.read1, self.BLOCK_SIZE)\n- if not block:\n- break\n- await self.write(block)\n-\n- logger.debug('reading response done')\n- # this returns immediately and does not read anything more, but updates the http.client's\n- # internal state machine to \"response done\"\n- block = response.read()\n- assert block == b''\n-\n- await loop.run_in_executor(None, connection.close)\n- except (http.client.HTTPException, OSError) as exc:\n- raise ChannelError('terminated', message=str(exc)) from exc\n-\n- self.done()\n-''',\n- 'cockpit/data/fail.html': br'''\n-\n-\n- @@message@@\n- \n- \n- \n-\n-\n-
\n- \n-

@@message@@

\n-
\n-\n-\n-''',\n- 'cockpit/data/__init__.py': br'''import sys\n-\n-if sys.version_info >= (3, 11):\n- import importlib.resources\n-\n- def read_cockpit_data_file(filename: str) -> bytes:\n- return (importlib.resources.files('cockpit.data') / filename).read_bytes()\n-\n-else:\n- import importlib.abc\n-\n- def read_cockpit_data_file(filename: str) -> bytes:\n- # https://github.com/python/mypy/issues/4182\n- loader = __loader__ # type: ignore[name-defined]\n- assert isinstance(loader, importlib.abc.ResourceLoader)\n-\n- path = __file__.replace('__init__.py', filename)\n- return loader.get_data(path)\n-''',\n- 'cockpit/_vendor/__init__.py': br'''''',\n- 'cockpit/_vendor/ferny/ssh_errors.py': br'''# ferny - asyncio SSH client library, using ssh(1)\n-#\n-# Copyright (C) 2023 Allison Karlitskaya \n-#\n-# This program is free software: you can redistribute it and/or modify\n-# it under the terms of the GNU General Public License as published by\n-# the Free Software Foundation, either version 3 of the License, or\n-# (at your option) any later version.\n-#\n-# This program is distributed in the hope that it will be useful,\n-# but WITHOUT ANY WARRANTY; without even the implied warranty of\n-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n-# GNU General Public License for more details.\n-#\n-# You should have received a copy of the GNU General Public License\n-# along with this program. If not, see .\n-\n-import ctypes\n-import errno\n-import os\n-import re\n-import socket\n-from typing import ClassVar, Iterable, Match, Pattern\n-\n-\n-class SshError(Exception):\n- PATTERN: ClassVar[Pattern]\n-\n- def __init__(self, match: 'Match | None', stderr: str) -> None:\n- super().__init__(match.group(0) if match is not None else stderr)\n- self.stderr = stderr\n-\n-\n-class SshAuthenticationError(SshError):\n- PATTERN = re.compile(r'^([^:]+): Permission denied \\(([^()]+)\\)\\.$', re.M)\n-\n- def __init__(self, match: Match, stderr: str) -> None:\n- super().__init__(match, stderr)\n- self.destination = match.group(1)\n- self.methods = match.group(2).split(',')\n- self.message = match.group(0)\n-\n-\n-# generic host key error for OSes without KnownHostsCommand support\n-class SshHostKeyError(SshError):\n- PATTERN = re.compile(r'^Host key verification failed.$', re.M)\n-\n-\n-# specific errors for OSes with KnownHostsCommand\n-class SshUnknownHostKeyError(SshHostKeyError):\n- PATTERN = re.compile(r'^No .* host key is known.*Host key verification failed.$', re.S | re.M)\n-\n-\n-class SshChangedHostKeyError(SshHostKeyError):\n- PATTERN = re.compile(r'warning.*remote host identification has changed', re.I)\n-\n-\n-# Functionality for mapping getaddrinfo()-family error messages to their\n-# equivalent Python exceptions.\n-def make_gaierror_map() -> 'Iterable[tuple[str, int]]':\n- libc = ctypes.CDLL(None)\n- libc.gai_strerror.restype = ctypes.c_char_p\n-\n- for key in dir(socket):\n- if key.startswith('EAI_'):\n- errnum = getattr(socket, key)\n- yield libc.gai_strerror(errnum).decode('utf-8'), errnum\n-\n-\n-gaierror_map = dict(make_gaierror_map())\n-\n-\n-# Functionality for passing strerror() error messages to their equivalent\n-# Python exceptions.\n-# There doesn't seem to be an official API for turning an errno into the\n-# correct subtype of OSError, and the list that cpython uses is hidden fairly\n-# deeply inside of the implementation. This is basically copied from the\n-# ADD_ERRNO() lines in _PyExc_InitState in cpython/Objects/exceptions.c\n-oserror_subclass_map = dict((errnum, cls) for cls, errnum in [\n- (BlockingIOError, errno.EAGAIN),\n- (BlockingIOError, errno.EALREADY),\n- (BlockingIOError, errno.EINPROGRESS),\n- (BlockingIOError, errno.EWOULDBLOCK),\n- (BrokenPipeError, errno.EPIPE),\n- (BrokenPipeError, errno.ESHUTDOWN),\n- (ChildProcessError, errno.ECHILD),\n- (ConnectionAbortedError, errno.ECONNABORTED),\n- (ConnectionRefusedError, errno.ECONNREFUSED),\n- (ConnectionResetError, errno.ECONNRESET),\n- (FileExistsError, errno.EEXIST),\n- (FileNotFoundError, errno.ENOENT),\n- (IsADirectoryError, errno.EISDIR),\n- (NotADirectoryError, errno.ENOTDIR),\n- (InterruptedError, errno.EINTR),\n- (PermissionError, errno.EACCES),\n- (PermissionError, errno.EPERM),\n- (ProcessLookupError, errno.ESRCH),\n- (TimeoutError, errno.ETIMEDOUT),\n-])\n-\n-\n-def get_exception_for_ssh_stderr(stderr: str) -> Exception:\n- stderr = stderr.replace('\\r\\n', '\\n') # fix line separators\n-\n- # check for the specific error messages first, then for generic SshHostKeyError\n- for ssh_cls in [SshAuthenticationError, SshChangedHostKeyError, SshUnknownHostKeyError, SshHostKeyError]:\n- match = ssh_cls.PATTERN.search(stderr)\n- if match is not None:\n- return ssh_cls(match, stderr)\n-\n- before, colon, after = stderr.rpartition(':')\n- if colon and after:\n- potential_strerror = after.strip()\n-\n- # DNS lookup errors\n- if potential_strerror in gaierror_map:\n- errnum = gaierror_map[potential_strerror]\n- return socket.gaierror(errnum, stderr)\n-\n- # Network connect errors\n- for errnum in errno.errorcode:\n- if os.strerror(errnum) == potential_strerror:\n- os_cls = oserror_subclass_map.get(errnum, OSError)\n- return os_cls(errnum, stderr)\n-\n- # No match? Generic.\n- return SshError(None, stderr)\n-''',\n- 'cockpit/_vendor/ferny/ssh_askpass.py': br'''import logging\n-import re\n-from typing import ClassVar, Match, Sequence\n-\n-from .interaction_agent import AskpassHandler\n-\n-logger = logging.getLogger(__name__)\n-\n-\n-class AskpassPrompt:\n- \"\"\"An askpass prompt resulting from a call to ferny-askpass.\n-\n- stderr: the contents of stderr from before ferny-askpass was called.\n- Likely related to previous failed operations.\n- messages: all but the last line of the prompt as handed to ferny-askpass.\n- Usually contains context about the question.\n- prompt: the last line handed to ferny-askpass. The prompt itself.\n- \"\"\"\n- stderr: str\n- messages: str\n- prompt: str\n-\n- def __init__(self, prompt: str, messages: str, stderr: str) -> None:\n- self.stderr = stderr\n- self.messages = messages\n- self.prompt = prompt\n-\n- def reply(self, response: str) -> None:\n- pass\n-\n- def close(self) -> None:\n- pass\n-\n- async def handle_via(self, responder: 'SshAskpassResponder') -> None:\n- try:\n- response = await self.dispatch(responder)\n- if response is not None:\n- self.reply(response)\n- finally:\n- self.close()\n-\n- async def dispatch(self, responder: 'SshAskpassResponder') -> 'str | None':\n- return await responder.do_prompt(self)\n-\n-\n-class SSHAskpassPrompt(AskpassPrompt):\n- # The valid answers to prompts of this type. If this is None then any\n- # answer is permitted. If it's a sequence then only answers from the\n- # sequence are permitted. If it's an empty sequence, then no answer is\n- # permitted (ie: the askpass callback should never return).\n- answers: 'ClassVar[Sequence[str] | None]' = None\n-\n- # Patterns to capture. `_pattern` *must* match.\n- _pattern: ClassVar[str]\n- # `_extra_patterns` can fill in extra class attributes if they match.\n- _extra_patterns: ClassVar[Sequence[str]] = ()\n-\n- def __init__(self, prompt: str, messages: str, stderr: str, match: Match) -> None:\n- super().__init__(prompt, messages, stderr)\n- self.__dict__.update(match.groupdict())\n-\n- for pattern in self._extra_patterns:\n- extra_match = re.search(with_helpers(pattern), messages, re.M)\n- if extra_match is not None:\n- self.__dict__.update(extra_match.groupdict())\n-\n-\n-# Specific prompts\n-HELPERS = {\n- \"%{algorithm}\": r\"(?P\\b[-\\w]+\\b)\",\n- \"%{filename}\": r\"(?P.+)\",\n- \"%{fingerprint}\": r\"(?PSHA256:[0-9A-Za-z+/]{43})\",\n- \"%{hostname}\": r\"(?P[^ @']+)\",\n- \"%{pkcs11_id}\": r\"(?P.+)\",\n- \"%{username}\": r\"(?P[^ @']+)\",\n-}\n-\n-\n-class SshPasswordPrompt(SSHAskpassPrompt):\n- _pattern = r\"%{username}@%{hostname}'s password: \"\n- username: 'str | None' = None\n- hostname: 'str | None' = None\n-\n- async def dispatch(self, responder: 'SshAskpassResponder') -> 'str | None':\n- return await responder.do_password_prompt(self)\n-\n-\n-class SshPassphrasePrompt(SSHAskpassPrompt):\n- _pattern = r\"Enter passphrase for key '%{filename}': \"\n- filename: str\n-\n- async def dispatch(self, responder: 'SshAskpassResponder') -> 'str | None':\n- return await responder.do_passphrase_prompt(self)\n-\n-\n-class SshFIDOPINPrompt(SSHAskpassPrompt):\n- _pattern = r\"Enter PIN for %{algorithm} key %{filename}: \"\n- algorithm: str\n- filename: str\n-\n- async def dispatch(self, responder: 'SshAskpassResponder') -> 'str | None':\n- return await responder.do_fido_pin_prompt(self)\n-\n-\n-class SshFIDOUserPresencePrompt(SSHAskpassPrompt):\n- _pattern = r\"Confirm user presence for key %{algorithm} %{fingerprint}\"\n- answers = ()\n- algorithm: str\n- fingerprint: str\n-\n- async def dispatch(self, responder: 'SshAskpassResponder') -> 'str | None':\n- return await responder.do_fido_user_presence_prompt(self)\n-\n-\n-class SshPKCS11PINPrompt(SSHAskpassPrompt):\n- _pattern = r\"Enter PIN for '%{pkcs11_id}': \"\n- pkcs11_id: str\n-\n- async def dispatch(self, responder: 'SshAskpassResponder') -> 'str | None':\n- return await responder.do_pkcs11_pin_prompt(self)\n-\n-\n-class SshHostKeyPrompt(SSHAskpassPrompt):\n- _pattern = r\"Are you sure you want to continue connecting \\(yes/no(/\\[fingerprint\\])?\\)\\? \"\n- _extra_patterns = [\n- r\"%{fingerprint}[.]$\",\n- r\"^%{algorithm} key fingerprint is\",\n- r\"^The fingerprint for the %{algorithm} key sent by the remote host is$\"\n- ]\n- answers = ('yes', 'no')\n- algorithm: str\n- fingerprint: str\n-\n- async def dispatch(self, responder: 'SshAskpassResponder') -> 'str | None':\n- return await responder.do_host_key_prompt(self)\n-\n-\n-def with_helpers(pattern: str) -> str:\n- for name, helper in HELPERS.items():\n- pattern = pattern.replace(name, helper)\n-\n- assert '%{' not in pattern\n- return pattern\n-\n-\n-def categorize_ssh_prompt(string: str, stderr: str) -> AskpassPrompt:\n- classes = [\n- SshFIDOPINPrompt,\n- SshFIDOUserPresencePrompt,\n- SshHostKeyPrompt,\n- SshPKCS11PINPrompt,\n- SshPassphrasePrompt,\n- SshPasswordPrompt,\n- ]\n-\n- # The last line is the line after the last newline character, excluding the\n- # optional final newline character. eg: \"x\\ny\\nLAST\\n\" or \"x\\ny\\nLAST\"\n- second_last_newline = string.rfind('\\n', 0, -1)\n- if second_last_newline >= 0:\n- last_line = string[second_last_newline + 1:]\n- extras = string[:second_last_newline + 1]\n- else:\n- last_line = string\n- extras = ''\n-\n- for cls in classes:\n- pattern = with_helpers(cls._pattern)\n- match = re.fullmatch(pattern, last_line)\n- if match is not None:\n- return cls(last_line, extras, stderr, match)\n-\n- return AskpassPrompt(last_line, extras, stderr)\n-\n-\n-class SshAskpassResponder(AskpassHandler):\n- async def do_askpass(self, stderr: str, prompt: str, hint: str) -> 'str | None':\n- return await categorize_ssh_prompt(prompt, stderr).dispatch(self)\n-\n- async def do_prompt(self, prompt: AskpassPrompt) -> 'str | None':\n- # Default fallback for unrecognised message types: unimplemented\n- return None\n-\n- async def do_fido_pin_prompt(self, prompt: SshFIDOPINPrompt) -> 'str | None':\n- return await self.do_prompt(prompt)\n-\n- async def do_fido_user_presence_prompt(self, prompt: SshFIDOUserPresencePrompt) -> 'str | None':\n- return await self.do_prompt(prompt)\n-\n- async def do_host_key_prompt(self, prompt: SshHostKeyPrompt) -> 'str | None':\n- return await self.do_prompt(prompt)\n-\n- async def do_pkcs11_pin_prompt(self, prompt: SshPKCS11PINPrompt) -> 'str | None':\n- return await self.do_prompt(prompt)\n-\n- async def do_passphrase_prompt(self, prompt: SshPassphrasePrompt) -> 'str | None':\n- return await self.do_prompt(prompt)\n-\n- async def do_password_prompt(self, prompt: SshPasswordPrompt) -> 'str | None':\n- return await self.do_prompt(prompt)\n-''',\n- 'cockpit/_vendor/ferny/session.py': r'''# ferny - asyncio SSH client library, using ssh(1)\n-#\n-# Copyright (C) 2022 Allison Karlitskaya \n-#\n-# This program is free software: you can redistribute it and/or modify\n-# it under the terms of the GNU General Public License as published by\n-# the Free Software Foundation, either version 3 of the License, or\n-# (at your option) any later version.\n-#\n-# This program is distributed in the hope that it will be useful,\n-# but WITHOUT ANY WARRANTY; without even the implied warranty of\n-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n-# GNU General Public License for more details.\n-#\n-# You should have received a copy of the GNU General Public License\n-# along with this program. If not, see .\n-\n-import asyncio\n-import ctypes\n-import functools\n-import logging\n-import os\n-import shlex\n-import signal\n-import subprocess\n-import tempfile\n-from typing import Mapping, Sequence\n-\n-from . import ssh_errors\n-from .interaction_agent import InteractionAgent, InteractionError, InteractionHandler, write_askpass_to_tmpdir\n-\n-prctl = ctypes.cdll.LoadLibrary('libc.so.6').prctl\n-logger = logging.getLogger(__name__)\n-PR_SET_PDEATHSIG = 1\n-\n-\n-@functools.lru_cache()\n-def has_feature(feature: str, teststr: str = 'x') -> bool:\n- try:\n- subprocess.check_output(['ssh', f'-o{feature} {teststr}', '-G', 'nonexisting'], stderr=subprocess.DEVNULL)\n- return True\n- except subprocess.CalledProcessError:\n- return False\n-\n-\n-class SubprocessContext:\n- def wrap_subprocess_args(self, args: Sequence[str]) -> Sequence[str]:\n- \"\"\"Return the args required to launch a process in the given context.\n-\n- For example, this might return a vector with\n- [\"sudo\"]\n- or\n- [\"flatpak-spawn\", \"--host\"]\n- prepended.\n-\n- It is also possible that more substantial changes may be performed.\n-\n- This function is not permitted to modify its argument, although it may\n- (optionally) return it unmodified, if no changes are required.\n- \"\"\"\n- return args\n-\n- def wrap_subprocess_env(self, env: Mapping[str, str]) -> Mapping[str, str]:\n- \"\"\"Return the envp required to launch a process in the given context.\n-\n- For example, this might set the \"SUDO_ASKPASS\" environment variable, if\n- needed.\n-\n- As with wrap_subprocess_args(), this function is not permitted to\n- modify its argument, although it may (optionally) return it unmodified\n- if no changes are required.\n- \"\"\"\n- return env\n-\n-\n-class Session(SubprocessContext, InteractionHandler):\n- # Set after .connect() called, even if failed\n- _controldir: 'tempfile.TemporaryDirectory | None' = None\n- _controlsock: 'str | None' = None\n-\n- # Set if connected, else None\n- _process: 'asyncio.subprocess.Process | None' = None\n-\n- async def connect(self,\n- destination: str,\n- handle_host_key: bool = False,\n- configfile: 'str | None' = None,\n- identity_file: 'str | None' = None,\n- login_name: 'str | None' = None,\n- options: 'Mapping[str, str] | None' = None,\n- pkcs11: 'str | None' = None,\n- port: 'int | None' = None,\n- interaction_responder: 'InteractionHandler | None' = None) -> None:\n- rundir = os.path.join(os.environ.get('XDG_RUNTIME_DIR', '/run'), 'ferny')\n- os.makedirs(rundir, exist_ok=True)\n- self._controldir = tempfile.TemporaryDirectory(dir=rundir)\n- self._controlsock = f'{self._controldir.name}/socket'\n-\n- # In general, we can't guarantee an accessible and executable version\n- # of this file, but since it's small and we're making a temporary\n- # directory anyway, let's just copy it into place and use it from\n- # there.\n- askpass_path = write_askpass_to_tmpdir(self._controldir.name)\n-\n- env = dict(os.environ)\n- env['SSH_ASKPASS'] = askpass_path\n- env['SSH_ASKPASS_REQUIRE'] = 'force'\n- # old SSH doesn't understand SSH_ASKPASS_REQUIRE and guesses based on DISPLAY instead\n- env['DISPLAY'] = '-'\n-\n- args = [\n- '-M',\n- '-N',\n- '-S', self._controlsock,\n- '-o', 'PermitLocalCommand=yes',\n- '-o', f'LocalCommand={askpass_path}',\n- ]\n-\n- if configfile is not None:\n- args.append(f'-F{configfile}')\n-\n- if identity_file is not None:\n- args.append(f'-i{identity_file}')\n-\n- if options is not None:\n- for key in options: # Note: Mapping may not have .items()\n- args.append(f'-o{key} {options[key]}')\n-\n- if pkcs11 is not None:\n- args.append(f'-I{pkcs11}')\n-\n- if port is not None:\n- args.append(f'-p{port}')\n-\n- if login_name is not None:\n- args.append(f'-l{login_name}')\n-\n- if handle_host_key and has_feature('KnownHostsCommand'):\n- args.extend([\n- '-o', f'KnownHostsCommand={askpass_path} %I %H %t %K %f',\n- '-o', 'StrictHostKeyChecking=yes',\n- ])\n-\n- agent = InteractionAgent([interaction_responder] if interaction_responder is not None else [])\n-\n- # SSH_ASKPASS_REQUIRE is not generally available, so use setsid\n- process = await asyncio.create_subprocess_exec(\n- *('/usr/bin/ssh', *args, destination), env=env,\n- start_new_session=True, stdin=asyncio.subprocess.DEVNULL,\n- stdout=asyncio.subprocess.DEVNULL, stderr=agent, # type: ignore\n- preexec_fn=lambda: prctl(PR_SET_PDEATHSIG, signal.SIGKILL))\n-\n- # This is tricky: we need to clean up the subprocess, but only in case\n- # if failure. Otherwise, we keep it around.\n- try:\n- await agent.communicate()\n- assert os.path.exists(self._controlsock)\n- self._process = process\n- except InteractionError as exc:\n- await process.wait()\n- raise ssh_errors.get_exception_for_ssh_stderr(str(exc)) from None\n- except BaseException:\n- # If we get here because the InteractionHandler raised an\n- # exception then SSH might still be running, and may even attempt\n- # further interactions (ie: 2nd attempt for password). We already\n- # have our exception and don't need any more info. Kill it.\n- try:\n- process.kill()\n- except ProcessLookupError:\n- pass # already exited? good.\n- await process.wait()\n- raise\n-\n- def is_connected(self) -> bool:\n- return self._process is not None\n-\n- async def wait(self) -> None:\n- assert self._process is not None\n- await self._process.wait()\n-\n- def exit(self) -> None:\n- assert self._process is not None\n- self._process.terminate()\n-\n- async def disconnect(self) -> None:\n- self.exit()\n- await self.wait()\n-\n- # Launching of processes\n- def wrap_subprocess_args(self, args: Sequence[str]) -> Sequence[str]:\n- assert self._controlsock is not None\n- # 1. We specify the hostname as the empty string: it will be ignored\n- # when ssh is trying to use the control socket, but in case the\n- # socket has stopped working, ssh will try to fall back to directly\n- # connecting, in which case an empty hostname will prevent that.\n- # 2. We need to quote the arguments \u2014 ssh will paste them together\n- # using only spaces, executing the result using the user's shell.\n- return ('ssh', '-S', self._controlsock, '', *map(shlex.quote, args))\n-'''.encode('utf-8'),\n- 'cockpit/_vendor/ferny/interaction_client.py': br'''#!/usr/bin/python3\n-\n-import array\n-import io\n-import os\n-import socket\n-import sys\n-from typing import Sequence\n-\n-\n-def command(stderr_fd: int, command: str, *args: object, fds: Sequence[int] = ()) -> None:\n- cmd_read, cmd_write = [io.open(*end) for end in zip(os.pipe(), 'rw')]\n-\n- with cmd_write:\n- with cmd_read:\n- with socket.fromfd(stderr_fd, socket.AF_UNIX, socket.SOCK_STREAM) as sock:\n- fd_array = array.array('i', (cmd_read.fileno(), *fds))\n- sock.sendmsg([b'\\0'], [(socket.SOL_SOCKET, socket.SCM_RIGHTS, fd_array)])\n-\n- cmd_write.write(repr((command, args)))\n-\n-\n-def askpass(stderr_fd: int, stdout_fd: int, args: 'list[str]', env: 'dict[str, str]') -> int:\n- ours, theirs = socket.socketpair()\n-\n- with theirs:\n- command(stderr_fd, 'ferny.askpass', args, env, fds=(theirs.fileno(), stdout_fd))\n-\n- with ours:\n- return int(ours.recv(16) or b'1')\n-\n-\n-def main() -> None:\n- if len(sys.argv) == 1:\n- command(2, 'ferny.end', [])\n- else:\n- sys.exit(askpass(2, 1, sys.argv, dict(os.environ)))\n-\n-\n-if __name__ == '__main__':\n- main()\n-''',\n- 'cockpit/_vendor/ferny/transport.py': br'''# ferny - asyncio SSH client library, using ssh(1)\n-#\n-# Copyright (C) 2023 Allison Karlitskaya \n-#\n-# This program is free software: you can redistribute it and/or modify\n-# it under the terms of the GNU General Public License as published by\n-# the Free Software Foundation, either version 3 of the License, or\n-# (at your option) any later version.\n-#\n-# This program is distributed in the hope that it will be useful,\n-# but WITHOUT ANY WARRANTY; without even the implied warranty of\n-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n-# GNU General Public License for more details.\n-#\n-# You should have received a copy of the GNU General Public License\n-# along with this program. If not, see .\n-\n-import asyncio\n-import contextlib\n-import logging\n-import typing\n-from typing import Any, Callable, Iterable, Sequence, TypeVar\n-\n-from .interaction_agent import InteractionAgent, InteractionHandler, get_running_loop\n-from .ssh_errors import get_exception_for_ssh_stderr\n-\n-logger = logging.getLogger(__name__)\n-\n-P = TypeVar('P', bound=asyncio.Protocol)\n-\n-\n-class SubprocessError(Exception):\n- returncode: int\n- stderr: str\n-\n- def __init__(self, returncode: int, stderr: str) -> None:\n- super().__init__(returncode, stderr)\n- self.returncode = returncode\n- self.stderr = stderr\n-\n-\n-class FernyTransport(asyncio.Transport, asyncio.SubprocessProtocol):\n- _agent: InteractionAgent\n- _exec_task: 'asyncio.Task[tuple[asyncio.SubprocessTransport, FernyTransport]]'\n- _is_ssh: bool\n- _protocol: asyncio.Protocol\n- _protocol_disconnected: bool = False\n-\n- # These get initialized in connection_made() and once set, never get unset.\n- _subprocess_transport: 'asyncio.SubprocessTransport | None' = None\n- _stdin_transport: 'asyncio.WriteTransport | None' = None\n- _stdout_transport: 'asyncio.ReadTransport | None' = None\n-\n- # We record events that might build towards a connection termination here\n- # and consider them from _consider_disconnect() in order to try to get the\n- # best possible Exception for the protocol, rather than just taking the\n- # first one (which is likely to be somewhat random).\n- _exception: 'Exception | None' = None\n- _stderr_output: 'str | None' = None\n- _returncode: 'int | None' = None\n- _transport_disconnected: bool = False\n- _closed: bool = False\n-\n- @classmethod\n- def spawn(\n- cls: 'type[typing.Self]',\n- protocol_factory: Callable[[], P],\n- args: Sequence[str],\n- loop: 'asyncio.AbstractEventLoop | None' = None,\n- interaction_handlers: Sequence[InteractionHandler] = (),\n- is_ssh: bool = True,\n- **kwargs: Any\n- ) -> 'tuple[typing.Self, P]':\n- \"\"\"Connects a FernyTransport to a protocol, using the given command.\n-\n- This spawns an external command and connects the stdin and stdout of\n- the command to the protocol returned by the factory.\n-\n- An instance of ferny.InteractionAgent is created and attached to the\n- stderr of the spawned process, using the provided handlers. It is the\n- responsibility of the caller to ensure that:\n- - a `ferny-askpass` client program is installed somewhere; and\n- - any relevant command-line arguments or environment variables are\n- passed correctly to the program to be spawned\n-\n- This function returns immediately and never raises exceptions, assuming\n- all preconditions are met.\n-\n- If spawning the process fails then connection_lost() will be\n- called with the relevant OSError, even before connection_made() is\n- called. This is somewhat non-standard behaviour, but is the easiest\n- way to report these errors without making this function async.\n-\n- Once the process is successfully executed, connection_made() will be\n- called and the transport can be used as normal. connection_lost() will\n- be called if the process exits or another error occurs.\n-\n- The return value of this function is the transport, but it exists in a\n- semi-initialized state. You can call .close() on it, but nothing else.\n- Once .connection_made() is called, you can call all the other\n- functions.\n-\n- After you call this function, `.connection_lost()` will be called on\n- your Protocol, exactly once, no matter what. Until that happens, you\n- are responsible for holding a reference to the returned transport.\n-\n- :param args: the full argv of the command to spawn\n- :param loop: the event loop to use. If none is provided, we use the\n- one which is (read: must be) currently running.\n- :param interaction_handlers: the handlers passed to the\n- InteractionAgent\n- :param is_ssh: whether we should attempt to interpret stderr as ssh\n- error messages\n- :param kwargs: anything else is passed through to `subprocess_exec()`\n- :returns: the usual `(Transport, Protocol)` pair\n- \"\"\"\n- logger.debug('spawn(%r, %r, %r)', cls, protocol_factory, args)\n-\n- protocol = protocol_factory()\n- self = cls(protocol)\n- self._is_ssh = is_ssh\n-\n- if loop is None:\n- loop = get_running_loop()\n-\n- self._agent = InteractionAgent(interaction_handlers, loop, self._interaction_completed)\n- kwargs.setdefault('stderr', self._agent.fileno())\n-\n- # As of Python 3.12 this isn't really asynchronous (since it uses the\n- # subprocess module, which blocks while waiting for the exec() to\n- # complete in the child), but we have to deal with the complication of\n- # the async interface anyway. Since we, ourselves, want to export a\n- # non-async interface, that means that we need a task here and a\n- # bottom-half handler below.\n- self._exec_task = loop.create_task(loop.subprocess_exec(lambda: self, *args, **kwargs))\n-\n- def exec_completed(task: asyncio.Task) -> None:\n- logger.debug('exec_completed(%r, %r)', self, task)\n- assert task is self._exec_task\n- try:\n- transport, me = task.result()\n- assert me is self\n- logger.debug(' success.')\n- except asyncio.CancelledError:\n- return # in that case, do nothing\n- except OSError as exc:\n- logger.debug(' OSError %r', exc)\n- self.close(exc)\n- return\n-\n- # Our own .connection_made() handler should have gotten called by\n- # now. Make sure everything got filled in properly.\n- assert self._subprocess_transport is transport\n- assert self._stdin_transport is not None\n- assert self._stdout_transport is not None\n-\n- # Ask the InteractionAgent to start processing stderr.\n- self._agent.start()\n-\n- self._exec_task.add_done_callback(exec_completed)\n-\n- return self, protocol\n-\n- def __init__(self, protocol: asyncio.Protocol) -> None:\n- self._protocol = protocol\n-\n- def _consider_disconnect(self) -> None:\n- logger.debug('_consider_disconnect(%r)', self)\n- # We cannot disconnect as long as any of these three things are happening\n- if not self._exec_task.done():\n- logger.debug(' exec_task still running %r', self._exec_task)\n- return\n-\n- if self._subprocess_transport is not None and not self._transport_disconnected:\n- logger.debug(' transport still connected %r', self._subprocess_transport)\n- return\n-\n- if self._stderr_output is None:\n- logger.debug(' agent still running')\n- return\n-\n- # All conditions for disconnection are satisfied.\n- if self._protocol_disconnected:\n- logger.debug(' already disconnected')\n- return\n- self._protocol_disconnected = True\n-\n- # Now we just need to determine what we report to the protocol...\n- if self._exception is not None:\n- # If we got an exception reported, that's our reason for closing.\n- logger.debug(' disconnect with exception %r', self._exception)\n- self._protocol.connection_lost(self._exception)\n- elif self._returncode == 0 or self._closed:\n- # If we called close() or have a zero return status, that's a clean\n- # exit, regardless of noise that might have landed in stderr.\n- logger.debug(' clean disconnect')\n- self._protocol.connection_lost(None)\n- elif self._is_ssh and self._returncode == 255:\n- # This is an error code due to an SSH failure. Try to interpret it.\n- logger.debug(' disconnect with ssh error %r', self._stderr_output)\n- self._protocol.connection_lost(get_exception_for_ssh_stderr(self._stderr_output))\n- else:\n- # Otherwise, report the stderr text and return code.\n- logger.debug(' disconnect with exit code %r, stderr %r', self._returncode, self._stderr_output)\n- # We surely have _returncode set here, since otherwise:\n- # - exec_task failed with an exception (which we handle above); or\n- # - we're still connected...\n- assert self._returncode is not None\n- self._protocol.connection_lost(SubprocessError(self._returncode, self._stderr_output))\n-\n- def _interaction_completed(self, future: 'asyncio.Future[str]') -> None:\n- logger.debug('_interaction_completed(%r, %r)', self, future)\n- try:\n- self._stderr_output = future.result()\n- logger.debug(' stderr: %r', self._stderr_output)\n- except Exception as exc:\n- logger.debug(' exception: %r', exc)\n- self._stderr_output = '' # we need to set this in order to complete\n- self.close(exc)\n-\n- self._consider_disconnect()\n-\n- # BaseProtocol implementation\n- def connection_made(self, transport: asyncio.BaseTransport) -> None:\n- logger.debug('connection_made(%r, %r)', self, transport)\n- assert isinstance(transport, asyncio.SubprocessTransport)\n- self._subprocess_transport = transport\n-\n- stdin_transport = transport.get_pipe_transport(0)\n- assert isinstance(stdin_transport, asyncio.WriteTransport)\n- self._stdin_transport = stdin_transport\n-\n- stdout_transport = transport.get_pipe_transport(1)\n- assert isinstance(stdout_transport, asyncio.ReadTransport)\n- self._stdout_transport = stdout_transport\n-\n- stderr_transport = transport.get_pipe_transport(2)\n- assert stderr_transport is None\n-\n- logger.debug('calling connection_made(%r, %r)', self, self._protocol)\n- self._protocol.connection_made(self)\n-\n- def connection_lost(self, exc: 'Exception | None') -> None:\n- logger.debug('connection_lost(%r, %r)', self, exc)\n- if self._exception is None:\n- self._exception = exc\n- self._transport_disconnected = True\n- self._consider_disconnect()\n-\n- # SubprocessProtocol implementation\n- def pipe_data_received(self, fd: int, data: bytes) -> None:\n- logger.debug('pipe_data_received(%r, %r, %r)', self, fd, len(data))\n- assert fd == 1 # stderr is handled separately\n- self._protocol.data_received(data)\n-\n- def pipe_connection_lost(self, fd: int, exc: 'Exception | None') -> None:\n- logger.debug('pipe_connection_lost(%r, %r, %r)', self, fd, exc)\n- assert fd in (0, 1) # stderr is handled separately\n-\n- # We treat this as a clean close\n- if isinstance(exc, BrokenPipeError):\n- exc = None\n-\n- # Record serious errors to propagate them to the protocol\n- # If this is a clean exit on stdout, report an EOF\n- if exc is not None:\n- self.close(exc)\n- elif fd == 1 and not self._closed:\n- if not self._protocol.eof_received():\n- self.close()\n-\n- def process_exited(self) -> None:\n- logger.debug('process_exited(%r)', self)\n- assert self._subprocess_transport is not None\n- self._returncode = self._subprocess_transport.get_returncode()\n- logger.debug(' ._returncode = %r', self._returncode)\n- self._agent.force_completion()\n-\n- def pause_writing(self) -> None:\n- logger.debug('pause_writing(%r)', self)\n- self._protocol.pause_writing()\n-\n- def resume_writing(self) -> None:\n- logger.debug('resume_writing(%r)', self)\n- self._protocol.resume_writing()\n-\n- # Transport implementation. Most of this is straight delegation.\n- def close(self, exc: 'Exception | None' = None) -> None:\n- logger.debug('close(%r, %r)', self, exc)\n- self._closed = True\n- if self._exception is None:\n- logger.debug(' setting exception %r', exc)\n- self._exception = exc\n- if not self._exec_task.done():\n- logger.debug(' cancelling _exec_task')\n- self._exec_task.cancel()\n- if self._subprocess_transport is not None:\n- logger.debug(' closing _subprocess_transport')\n- # https://github.com/python/cpython/issues/112800\n- with contextlib.suppress(PermissionError):\n- self._subprocess_transport.close()\n- self._agent.force_completion()\n-\n- def is_closing(self) -> bool:\n- assert self._subprocess_transport is not None\n- return self._subprocess_transport.is_closing()\n-\n- def get_extra_info(self, name: str, default: object = None) -> object:\n- assert self._subprocess_transport is not None\n- return self._subprocess_transport.get_extra_info(name, default)\n-\n- def set_protocol(self, protocol: asyncio.BaseProtocol) -> None:\n- assert isinstance(protocol, asyncio.Protocol)\n- self._protocol = protocol\n-\n- def get_protocol(self) -> asyncio.Protocol:\n- return self._protocol\n-\n- def is_reading(self) -> bool:\n- assert self._stdout_transport is not None\n- try:\n- return self._stdout_transport.is_reading()\n- except NotImplementedError:\n- # This is (incorrectly) unimplemented before Python 3.11\n- return not self._stdout_transport._paused # type:ignore[attr-defined]\n- except AttributeError:\n- # ...and in Python 3.6 it's even worse\n- try:\n- selector = self._stdout_transport._loop._selector # type:ignore[attr-defined]\n- selector.get_key(self._stdout_transport._fileno) # type:ignore[attr-defined]\n- return True\n- except KeyError:\n- return False\n-\n- def pause_reading(self) -> None:\n- assert self._stdout_transport is not None\n- self._stdout_transport.pause_reading()\n-\n- def resume_reading(self) -> None:\n- assert self._stdout_transport is not None\n- self._stdout_transport.resume_reading()\n-\n- def abort(self) -> None:\n- assert self._stdin_transport is not None\n- assert self._subprocess_transport is not None\n- self._stdin_transport.abort()\n- self._subprocess_transport.kill()\n-\n- def can_write_eof(self) -> bool:\n- assert self._stdin_transport is not None\n- return self._stdin_transport.can_write_eof() # will always be True\n-\n- def get_write_buffer_size(self) -> int:\n- assert self._stdin_transport is not None\n- return self._stdin_transport.get_write_buffer_size()\n-\n- def get_write_buffer_limits(self) -> 'tuple[int, int]':\n- assert self._stdin_transport is not None\n- return self._stdin_transport.get_write_buffer_limits()\n-\n- def set_write_buffer_limits(self, high: 'int | None' = None, low: 'int | None' = None) -> None:\n- assert self._stdin_transport is not None\n- return self._stdin_transport.set_write_buffer_limits(high, low)\n-\n- def write(self, data: bytes) -> None:\n- assert self._stdin_transport is not None\n- return self._stdin_transport.write(data)\n-\n- def writelines(self, list_of_data: Iterable[bytes]) -> None:\n- assert self._stdin_transport is not None\n- return self._stdin_transport.writelines(list_of_data)\n-\n- def write_eof(self) -> None:\n- assert self._stdin_transport is not None\n- return self._stdin_transport.write_eof()\n-\n- # We don't really implement SubprocessTransport, but provide these as\n- # \"extras\" to our user.\n- def get_pid(self) -> int:\n- assert self._subprocess_transport is not None\n- return self._subprocess_transport.get_pid()\n-\n- def get_returncode(self) -> 'int | None':\n- return self._returncode\n-\n- def kill(self) -> None:\n- assert self._subprocess_transport is not None\n- self._subprocess_transport.kill()\n-\n- def send_signal(self, number: int) -> None:\n- assert self._subprocess_transport is not None\n- self._subprocess_transport.send_signal(number)\n-\n- def terminate(self) -> None:\n- assert self._subprocess_transport is not None\n- self._subprocess_transport.terminate()\n-''',\n- 'cockpit/_vendor/ferny/py.typed': br'''''',\n- 'cockpit/_vendor/ferny/__init__.py': br'''from .interaction_agent import (\n- BEIBOOT_GADGETS,\n- COMMAND_TEMPLATE,\n- AskpassHandler,\n- InteractionAgent,\n- InteractionError,\n- InteractionHandler,\n- temporary_askpass,\n- write_askpass_to_tmpdir,\n-)\n-from .session import Session\n-from .ssh_askpass import (\n- AskpassPrompt,\n- SshAskpassResponder,\n- SshFIDOPINPrompt,\n- SshFIDOUserPresencePrompt,\n- SshHostKeyPrompt,\n- SshPassphrasePrompt,\n- SshPasswordPrompt,\n- SshPKCS11PINPrompt,\n-)\n-from .ssh_errors import (\n- SshAuthenticationError,\n- SshChangedHostKeyError,\n- SshError,\n- SshHostKeyError,\n- SshUnknownHostKeyError,\n-)\n-from .transport import FernyTransport, SubprocessError\n-\n-__all__ = [\n- 'AskpassHandler',\n- 'AskpassPrompt',\n- 'AuthenticationError',\n- 'BEIBOOT_GADGETS',\n- 'COMMAND_TEMPLATE',\n- 'ChangedHostKeyError',\n- 'FernyTransport',\n- 'HostKeyError',\n- 'InteractionAgent',\n- 'InteractionError',\n- 'InteractionHandler',\n- 'Session',\n- 'SshAskpassResponder',\n- 'SshAuthenticationError',\n- 'SshChangedHostKeyError',\n- 'SshError',\n- 'SshFIDOPINPrompt',\n- 'SshFIDOUserPresencePrompt',\n- 'SshHostKeyError',\n- 'SshHostKeyPrompt',\n- 'SshPKCS11PINPrompt',\n- 'SshPassphrasePrompt',\n- 'SshPasswordPrompt',\n- 'SshUnknownHostKeyError',\n- 'SubprocessError',\n- 'temporary_askpass',\n- 'write_askpass_to_tmpdir',\n-]\n-\n-__version__ = '0'\n-''',\n- 'cockpit/_vendor/ferny/askpass.py': br'''from .interaction_client import main\n-\n-if __name__ == '__main__':\n- main()\n-''',\n- 'cockpit/_vendor/ferny/interaction_agent.py': r'''# ferny - asyncio SSH client library, using ssh(1)\n-#\n-# Copyright (C) 2023 Allison Karlitskaya \n-#\n-# This program is free software: you can redistribute it and/or modify\n-# it under the terms of the GNU General Public License as published by\n-# the Free Software Foundation, either version 3 of the License, or\n-# (at your option) any later version.\n-#\n-# This program is distributed in the hope that it will be useful,\n-# but WITHOUT ANY WARRANTY; without even the implied warranty of\n-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n-# GNU General Public License for more details.\n-#\n-# You should have received a copy of the GNU General Public License\n-# along with this program. If not, see .\n-\n-import array\n-import ast\n-import asyncio\n-import contextlib\n-import logging\n-import os\n-import re\n-import socket\n-import tempfile\n-from typing import Any, Callable, ClassVar, Generator, Sequence\n-\n-from . import interaction_client\n-\n-logger = logging.getLogger(__name__)\n-\n-\n-COMMAND_RE = re.compile(b'\\0ferny\\0([^\\n]*)\\0\\0\\n')\n-COMMAND_TEMPLATE = '\\0ferny\\0{(command, args)!r}\\0\\0\\n'\n-\n-BEIBOOT_GADGETS = {\n- \"command\": fr\"\"\"\n- import sys\n- def command(command, *args):\n- sys.stderr.write(f{COMMAND_TEMPLATE!r})\n- sys.stderr.flush()\n- \"\"\",\n- \"end\": r\"\"\"\n- def end():\n- command('ferny.end')\n- \"\"\",\n-}\n-\n-\n-class InteractionError(Exception):\n- pass\n-\n-\n-try:\n- recv_fds = socket.recv_fds\n-except AttributeError:\n- # Python < 3.9\n-\n- def recv_fds(\n- sock: socket.socket, bufsize: int, maxfds: int, flags: int = 0\n- ) -> 'tuple[bytes, list[int], int, None]':\n- fds = array.array(\"i\")\n- msg, ancdata, flags, addr = sock.recvmsg(bufsize, socket.CMSG_LEN(maxfds * fds.itemsize))\n- for cmsg_level, cmsg_type, cmsg_data in ancdata:\n- if (cmsg_level == socket.SOL_SOCKET and cmsg_type == socket.SCM_RIGHTS):\n- fds.frombytes(cmsg_data[:len(cmsg_data) - (len(cmsg_data) % fds.itemsize)])\n- return msg, list(fds), flags, addr\n-\n-\n-def get_running_loop() -> asyncio.AbstractEventLoop:\n- try:\n- return asyncio.get_running_loop()\n- except AttributeError:\n- # Python 3.6\n- return asyncio.get_event_loop()\n-\n-\n-class InteractionHandler:\n- commands: ClassVar[Sequence[str]]\n-\n- async def run_command(self, command: str, args: 'tuple[object, ...]', fds: 'list[int]', stderr: str) -> None:\n- raise NotImplementedError\n-\n-\n-class AskpassHandler(InteractionHandler):\n- commands: ClassVar[Sequence[str]] = ('ferny.askpass',)\n-\n- async def do_askpass(self, messages: str, prompt: str, hint: str) -> 'str | None':\n- \"\"\"Prompt the user for an authentication or confirmation interaction.\n-\n- 'messages' is data that was sent to stderr before the interaction was requested.\n- 'prompt' is the interaction prompt.\n-\n- The expected response type depends on hint:\n-\n- - \"confirm\": ask for permission, returning \"yes\" if accepted\n- - example: authorizing agent operation\n-\n- - \"none\": show a request without need for a response\n- - example: please touch your authentication token\n-\n- - otherwise: return a password or other form of text token\n- - examples: enter password, unlock private key\n-\n- In any case, the function should properly handle cancellation. For the\n- \"none\" case, this will be the normal way to dismiss the dialog.\n- \"\"\"\n- return None\n-\n- async def do_hostkey(self, reason: str, host: str, algorithm: str, key: str, fingerprint: str) -> bool:\n- \"\"\"Prompt the user for a decision regarding acceptance of a host key.\n-\n- The \"reason\" will be either \"HOSTNAME\" or \"ADDRESS\" (if `CheckHostIP` is enabled).\n-\n- The host, algorithm, and key parameters are the values in the form that\n- they would appear one a single line in the known hosts file. The\n- fingerprint is the key fingerprint in the format that ssh would\n- normally present it to the user.\n-\n- In case the host key should be accepted, this function needs to return\n- True. Returning False means that ssh implements its default logic. To\n- interrupt the connection, raise an exception.\n- \"\"\"\n- return False\n-\n- async def do_custom_command(\n- self, command: str, args: 'tuple[object, ...]', fds: 'list[int]', stderr: str\n- ) -> None:\n- \"\"\"Handle a custom command.\n-\n- The command name, its arguments, the passed fds, and the stderr leading\n- up to the command invocation are all provided.\n-\n- See doc/interaction-protocol.md\n- \"\"\"\n-\n- async def _askpass_command(self, args: 'tuple[object, ...]', fds: 'list[int]', stderr: str) -> None:\n- logger.debug('_askpass_command(%s, %s, %s)', args, fds, stderr)\n- try:\n- argv, env = args\n- assert isinstance(argv, list)\n- assert all(isinstance(arg, str) for arg in argv)\n- assert isinstance(env, dict)\n- assert all(isinstance(key, str) and isinstance(val, str) for key, val in env.items())\n- assert len(fds) == 2\n- except (ValueError, TypeError, AssertionError) as exc:\n- logger.error('Invalid arguments to askpass interaction: %s, %s: %s', args, fds, exc)\n- return\n-\n- with open(fds.pop(0), 'w') as status, open(fds.pop(0), 'w') as stdout:\n- try:\n- loop = get_running_loop()\n- try:\n- task = asyncio.current_task()\n- except AttributeError:\n- task = asyncio.Task.current_task() # type:ignore[attr-defined] # (Python 3.6)\n- assert task is not None\n- loop.add_reader(status, task.cancel)\n-\n- if len(argv) == 2:\n- # normal askpass\n- prompt = argv[1]\n- hint = env.get('SSH_ASKPASS_PROMPT', '')\n- logger.debug('do_askpass(%r, %r, %r)', stderr, prompt, hint)\n- answer = await self.do_askpass(stderr, prompt, hint)\n- logger.debug('do_askpass answer %r', answer)\n- if answer is not None:\n- print(answer, file=stdout)\n- print(0, file=status)\n-\n- elif len(argv) == 6:\n- # KnownHostsCommand\n- argv0, reason, host, algorithm, key, fingerprint = argv\n- if reason in ['ADDRESS', 'HOSTNAME']:\n- logger.debug('do_hostkey(%r, %r, %r, %r, %r)', reason, host, algorithm, key, fingerprint)\n- if await self.do_hostkey(reason, host, algorithm, key, fingerprint):\n- print(host, algorithm, key, file=stdout)\n- else:\n- logger.debug('ignoring KnownHostsCommand reason %r', reason)\n-\n- print(0, file=status)\n-\n- else:\n- logger.error('Incorrect number of command-line arguments to ferny-askpass: %s', argv)\n- finally:\n- loop.remove_reader(status)\n-\n- async def run_command(self, command: str, args: 'tuple[object, ...]', fds: 'list[int]', stderr: str) -> None:\n- logger.debug('run_command(%s, %s, %s, %s)', command, args, fds, stderr)\n- if command == 'ferny.askpass':\n- await self._askpass_command(args, fds, stderr)\n- else:\n- await self.do_custom_command(command, args, fds, stderr)\n-\n-\n-class InteractionAgent:\n- _handlers: 'dict[str, InteractionHandler]'\n+ raise ChannelError('terminated', message=str(exc)) from exc\n \n- _loop: asyncio.AbstractEventLoop\n+ self.send_control(command='response',\n+ status=response.status,\n+ reason=response.reason,\n+ headers=self.get_headers(response, binary=binary))\n \n- _tasks: 'set[asyncio.Task]'\n+ # Receive the body and finish up\n+ try:\n+ while True:\n+ block = await loop.run_in_executor(None, response.read1, self.BLOCK_SIZE)\n+ if not block:\n+ break\n+ await self.write(block)\n \n- _buffer: bytearray\n- _ours: socket.socket\n- _theirs: socket.socket\n+ logger.debug('reading response done')\n+ # this returns immediately and does not read anything more, but updates the http.client's\n+ # internal state machine to \"response done\"\n+ block = response.read()\n+ assert block == b''\n \n- _completion_future: 'asyncio.Future[str]'\n- _pending_result: 'None | str | Exception' = None\n- _end: bool = False\n+ await loop.run_in_executor(None, connection.close)\n+ except (http.client.HTTPException, OSError) as exc:\n+ raise ChannelError('terminated', message=str(exc)) from exc\n \n- def _consider_completion(self) -> None:\n- logger.debug('_consider_completion(%r)', self)\n+ self.done()\n+''',\n+ 'cockpit/channels/metrics.py': br'''# This file is part of Cockpit.\n+#\n+# Copyright (C) 2022 Red Hat, Inc.\n+#\n+# This program is free software: you can redistribute it and/or modify\n+# it under the terms of the GNU General Public License as published by\n+# the Free Software Foundation, either version 3 of the License, or\n+# (at your option) any later version.\n+#\n+# This program is distributed in the hope that it will be useful,\n+# but WITHOUT ANY WARRANTY; without even the implied warranty of\n+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n+# GNU General Public License for more details.\n+#\n+# You should have received a copy of the GNU General Public License\n+# along with this program. If not, see .\n \n- if self._pending_result is None or self._tasks:\n- logger.debug(' but not ready yet')\n+import asyncio\n+import json\n+import logging\n+import sys\n+import time\n+from collections import defaultdict\n+from typing import Dict, List, NamedTuple, Optional, Set, Tuple, Union\n \n- elif self._completion_future.done():\n- logger.debug(' but already complete')\n+from ..channel import AsyncChannel, ChannelError\n+from ..jsonutil import JsonList\n+from ..samples import SAMPLERS, SampleDescription, Sampler, Samples\n \n- elif isinstance(self._pending_result, str):\n- logger.debug(' submitting stderr (%r) to completion_future', self._pending_result)\n- self._completion_future.set_result(self._pending_result)\n+logger = logging.getLogger(__name__)\n \n- else:\n- logger.debug(' submitting exception (%r) to completion_future')\n- self._completion_future.set_exception(self._pending_result)\n \n- def _result(self, result: 'str | Exception') -> None:\n- logger.debug('_result(%r, %r)', self, result)\n+class MetricInfo(NamedTuple):\n+ derive: Optional[str]\n+ desc: SampleDescription\n \n- if self._pending_result is None:\n- self._pending_result = result\n \n- if self._ours.fileno() != -1:\n- logger.debug(' remove_reader(%r)', self._ours)\n- self._loop.remove_reader(self._ours.fileno())\n+class InternalMetricsChannel(AsyncChannel):\n+ payload = 'metrics1'\n+ restrictions = [('source', 'internal')]\n \n- for task in self._tasks:\n- logger.debug(' cancel(%r)', task)\n- task.cancel()\n+ metrics: List[MetricInfo]\n+ samplers: Set\n+ samplers_cache: Optional[Dict[str, Tuple[Sampler, SampleDescription]]] = None\n \n- logger.debug(' closing sockets')\n- self._theirs.close() # idempotent\n- self._ours.close()\n+ interval: int = 1000\n+ need_meta: bool = True\n+ last_timestamp: float = 0\n+ next_timestamp: float = 0\n \n- self._consider_completion()\n+ @classmethod\n+ def ensure_samplers(cls):\n+ if cls.samplers_cache is None:\n+ cls.samplers_cache = {desc.name: (sampler, desc) for sampler in SAMPLERS for desc in sampler.descriptions}\n \n- def _invoke_command(self, stderr: bytes, command_blob: bytes, fds: 'list[int]') -> None:\n- logger.debug('_invoke_command(%r, %r, %r)', stderr, command_blob, fds)\n- try:\n- command, args = ast.literal_eval(command_blob.decode())\n- if not isinstance(command, str) or not isinstance(args, tuple):\n- raise TypeError('Invalid argument types')\n- except (UnicodeDecodeError, SyntaxError, ValueError, TypeError) as exc:\n- logger.error('Received invalid ferny command: %s: %s', command_blob, exc)\n- return\n+ def parse_options(self, options):\n+ logger.debug('metrics internal open: %s, channel: %s', options, self.channel)\n \n- if command == 'ferny.end':\n- self._end = True\n- self._result(self._buffer.decode(errors='replace'))\n- return\n+ interval = options.get('interval', self.interval)\n+ if not isinstance(interval, int) or interval <= 0 or interval > sys.maxsize:\n+ raise ChannelError('protocol-error', message=f'invalid \"interval\" value: {interval}')\n \n- try:\n- handler = self._handlers[command]\n- except KeyError:\n- logger.error('Received unhandled ferny command: %s', command)\n- return\n+ self.interval = interval\n \n- # The task is responsible for the list of fds and removing itself\n- # from the set.\n- task_fds = list(fds)\n- task = self._loop.create_task(handler.run_command(command, args, task_fds, stderr.decode()))\n+ metrics = options.get('metrics')\n+ if not isinstance(metrics, list) or len(metrics) == 0:\n+ logger.error('invalid \"metrics\" value: %s', metrics)\n+ raise ChannelError('protocol-error', message='invalid \"metrics\" option was specified (not an array)')\n \n- def bottom_half(completed_task: asyncio.Task) -> None:\n- assert completed_task is task\n- while task_fds:\n- os.close(task_fds.pop())\n- self._tasks.remove(task)\n+ sampler_classes = set()\n+ for metric in metrics:\n+ # validate it's an object\n+ name = metric.get('name')\n+ units = metric.get('units')\n+ derive = metric.get('derive')\n \n try:\n- task.result()\n- logger.debug('%r completed cleanly', handler)\n- except asyncio.CancelledError:\n- # this is not an error \u2014 it just means ferny-askpass exited via signal\n- logger.debug('%r was cancelled', handler)\n- except Exception as exc:\n- logger.debug('%r raised %r', handler, exc)\n- self._result(exc)\n-\n- self._consider_completion()\n+ sampler, desc = self.samplers_cache[name]\n+ except KeyError as exc:\n+ logger.error('unsupported metric: %s', name)\n+ raise ChannelError('not-supported', message=f'unsupported metric: {name}') from exc\n \n- task.add_done_callback(bottom_half)\n- self._tasks.add(task)\n- fds[:] = []\n+ if units and units != desc.units:\n+ raise ChannelError('not-supported', message=f'{name} has units {desc.units}, not {units}')\n \n- def _got_data(self, data: bytes, fds: 'list[int]') -> None:\n- logger.debug('_got_data(%r, %r)', data, fds)\n+ sampler_classes.add(sampler)\n+ self.metrics.append(MetricInfo(derive=derive, desc=desc))\n \n- if data == b'':\n- self._result(self._buffer.decode(errors='replace'))\n- return\n+ self.samplers = {cls() for cls in sampler_classes}\n \n- self._buffer.extend(data)\n+ def send_meta(self, samples: Samples, timestamp: float):\n+ metrics: JsonList = []\n+ for metricinfo in self.metrics:\n+ if metricinfo.desc.instanced:\n+ metrics.append({\n+ 'name': metricinfo.desc.name,\n+ 'units': metricinfo.desc.units,\n+ 'instances': list(samples[metricinfo.desc.name].keys()),\n+ 'semantics': metricinfo.desc.semantics\n+ })\n+ else:\n+ metrics.append({\n+ 'name': metricinfo.desc.name,\n+ 'derive': metricinfo.derive, # type: ignore[dict-item]\n+ 'units': metricinfo.desc.units,\n+ 'semantics': metricinfo.desc.semantics\n+ })\n \n- # Read zero or more \"remote\" messages\n- chunks = COMMAND_RE.split(self._buffer)\n- self._buffer = bytearray(chunks.pop())\n- while len(chunks) > 1:\n- self._invoke_command(chunks[0], chunks[1], [])\n- chunks = chunks[2:]\n+ self.send_json(source='internal', interval=self.interval, timestamp=timestamp * 1000, metrics=metrics)\n+ self.need_meta = False\n \n- # Maybe read one \"local\" message\n- if fds:\n- assert self._buffer.endswith(b'\\0'), self._buffer\n- stderr = self._buffer[:-1]\n- self._buffer = bytearray(b'')\n- with open(fds.pop(0), 'rb') as command_channel:\n- command = command_channel.read()\n- self._invoke_command(stderr, command, fds)\n+ def sample(self):\n+ samples = defaultdict(dict)\n+ for sampler in self.samplers:\n+ sampler.sample(samples)\n+ return samples\n \n- def _read_ready(self) -> None:\n- try:\n- data, fds, _flags, _addr = recv_fds(self._ours, 4096, 10, flags=socket.MSG_DONTWAIT)\n- except BlockingIOError:\n- return\n- except OSError as exc:\n- self._result(exc)\n+ def calculate_sample_rate(self, value: float, old_value: Optional[float]) -> Union[float, bool]:\n+ if old_value is not None and self.last_timestamp:\n+ return (value - old_value) / (self.next_timestamp - self.last_timestamp)\n else:\n- self._got_data(data, fds)\n- finally:\n- while fds:\n- os.close(fds.pop())\n-\n- def __init__(\n- self,\n- handlers: Sequence[InteractionHandler],\n- loop: 'asyncio.AbstractEventLoop | None' = None,\n- done_callback: 'Callable[[asyncio.Future[str]], None] | None' = None,\n- ) -> None:\n- self._loop = loop or get_running_loop()\n- self._completion_future = self._loop.create_future()\n- self._tasks = set()\n- self._handlers = {}\n+ return False\n \n- for handler in handlers:\n- for command in handler.commands:\n- self._handlers[command] = handler\n+ def send_updates(self, samples: Samples, last_samples: Samples):\n+ data: List[Union[float, List[Optional[Union[float, bool]]]]] = []\n+ timestamp = time.time()\n+ self.next_timestamp = timestamp\n \n- if done_callback is not None:\n- self._completion_future.add_done_callback(done_callback)\n+ for metricinfo in self.metrics:\n+ value = samples[metricinfo.desc.name]\n \n- self._theirs, self._ours = socket.socketpair(socket.AF_UNIX, socket.SOCK_STREAM)\n- self._buffer = bytearray()\n+ if metricinfo.desc.instanced:\n+ old_value = last_samples[metricinfo.desc.name]\n+ assert isinstance(value, dict)\n+ assert isinstance(old_value, dict)\n \n- def fileno(self) -> int:\n- return self._theirs.fileno()\n+ # If we have less or more keys the data changed, send a meta message.\n+ if value.keys() != old_value.keys():\n+ self.need_meta = True\n \n- def start(self) -> None:\n- logger.debug('start(%r)', self)\n- if self._ours.fileno() != -1:\n- logger.debug(' add_reader(%r)', self._ours)\n- self._loop.add_reader(self._ours.fileno(), self._read_ready)\n- else:\n- logger.debug(' ...but agent is already finished.')\n+ if metricinfo.derive == 'rate':\n+ instances: List[Optional[Union[float, bool]]] = []\n+ for key, val in value.items():\n+ instances.append(self.calculate_sample_rate(val, old_value.get(key)))\n \n- logger.debug(' close(%r)', self._theirs)\n- self._theirs.close()\n+ data.append(instances)\n+ else:\n+ data.append(list(value.values()))\n+ else:\n+ old_value = last_samples.get(metricinfo.desc.name)\n+ assert not isinstance(value, dict)\n+ assert not isinstance(old_value, dict)\n \n- def force_completion(self) -> None:\n- logger.debug('force_completion(%r)', self)\n+ if metricinfo.derive == 'rate':\n+ data.append(self.calculate_sample_rate(value, old_value))\n+ else:\n+ data.append(value)\n \n- # read any residual data on stderr, but don't process commands, and\n- # don't block\n- try:\n- if self._ours.fileno() != -1:\n- logger.debug(' draining pending stderr data (non-blocking)')\n- with contextlib.suppress(BlockingIOError):\n- while True:\n- data = self._ours.recv(4096, socket.MSG_DONTWAIT)\n- logger.debug(' got %d bytes', len(data))\n- if not data:\n- break\n- self._buffer.extend(data)\n- except OSError as exc:\n- self._result(exc)\n- else:\n- self._result(self._buffer.decode(errors='replace'))\n+ if self.need_meta:\n+ self.send_meta(samples, timestamp)\n \n- async def communicate(self) -> None:\n- logger.debug('_communicate(%r)', self)\n- try:\n- self.start()\n- # We assume that we are the only ones to write to\n- # self._completion_future. If we directly await it, though, it can\n- # also have a asyncio.CancelledError posted to it from outside.\n- # Shield it to prevent that from happening.\n- stderr = await asyncio.shield(self._completion_future)\n- logger.debug('_communicate(%r) stderr result is %r', self, stderr)\n- finally:\n- logger.debug('_communicate finished. Ensuring completion.')\n- self.force_completion()\n- if not self._end:\n- logger.debug('_communicate never saw ferny.end. raising InteractionError.')\n- raise InteractionError(stderr.strip())\n+ self.last_timestamp = self.next_timestamp\n+ self.send_data(json.dumps([data]).encode())\n \n+ async def run(self, options):\n+ self.metrics = []\n+ self.samplers = set()\n \n-def write_askpass_to_tmpdir(tmpdir: str) -> str:\n- askpass_path = os.path.join(tmpdir, 'ferny-askpass')\n- fd = os.open(askpass_path, os.O_CREAT | os.O_WRONLY | os.O_CLOEXEC | os.O_EXCL | os.O_NOFOLLOW, 0o777)\n- try:\n- os.write(fd, __loader__.get_data(interaction_client.__file__)) # type: ignore\n- finally:\n- os.close(fd)\n- return askpass_path\n+ InternalMetricsChannel.ensure_samplers()\n \n+ self.parse_options(options)\n+ self.ready()\n \n-@contextlib.contextmanager\n-def temporary_askpass(**kwargs: Any) -> Generator[str, None, None]:\n- with tempfile.TemporaryDirectory(**kwargs) as directory:\n- yield write_askpass_to_tmpdir(directory)\n-'''.encode('utf-8'),\n+ last_samples = defaultdict(dict)\n+ while True:\n+ samples = self.sample()\n+ self.send_updates(samples, last_samples)\n+ last_samples = samples\n+ await asyncio.sleep(self.interval / 1000)\n+''',\n+ 'cockpit/_vendor/__init__.py': br'''''',\n 'cockpit/_vendor/bei/bootloader.py': br'''# beiboot - Remote bootloader for Python\n #\n # Copyright (C) 2023 Allison Karlitskaya \n #\n # This program is free software: you can redistribute it and/or modify\n # it under the terms of the GNU General Public License as published by\n # the Free Software Foundation, either version 3 of the License, or\n@@ -8285,14 +6829,15 @@\n for spaces, text in yield_body(gadgets or {}, steps, imports):\n lines.append(frame_spaces + spaces + text)\n else:\n lines.append(frame_spaces + frame_text)\n \n return \"\".join(f\"{line}\\n\" for line in [*imports, *lines]) + \"\\n\"\n ''',\n+ 'cockpit/_vendor/bei/__init__.py': br'''''',\n 'cockpit/_vendor/bei/beiboot.py': br\"\"\"# beiboot - Remote bootloader for Python\n #\n # Copyright (C) 2022 Allison Karlitskaya \n #\n # This program is free software: you can redistribute it and/or modify\n # it under the terms of the GNU General Public License as published by\n # the Free Software Foundation, either version 3 of the License, or\n@@ -8446,14 +6991,36 @@\n os.execlp(command[0], *command)\n \n # Otherwise, \"full strength\"\n \n if __name__ == '__main__':\n main()\n \"\"\",\n+ 'cockpit/_vendor/bei/tmpfs.py': br'''import os\n+import subprocess\n+import sys\n+import tempfile\n+\n+\n+def main(*command: str) -> None:\n+ with tempfile.TemporaryDirectory() as tmpdir:\n+ os.chdir(tmpdir)\n+\n+ for key, value in __loader__.get_contents().items():\n+ if key.startswith('tmpfs/'):\n+ subdir = os.path.dirname(key)\n+ os.makedirs(subdir, exist_ok=True)\n+ with open(key, 'wb') as fp:\n+ fp.write(value)\n+\n+ os.chdir('tmpfs')\n+\n+ result = subprocess.run(command, check=False)\n+ sys.exit(result.returncode)\n+''',\n 'cockpit/_vendor/bei/beipack.py': br'''# beipack - Remote bootloader for Python\n #\n # Copyright (C) 2022 Allison Karlitskaya \n #\n # This program is free software: you can redistribute it and/or modify\n # it under the terms of the GNU General Public License as published by\n # the Free Software Foundation, either version 3 of the License, or\n@@ -8664,36 +7231,14 @@\n sys.exit('refusing to write compressed output to a terminal')\n sys.stdout.buffer.write(result)\n \n \n if __name__ == '__main__':\n main()\n ''',\n- 'cockpit/_vendor/bei/tmpfs.py': br'''import os\n-import subprocess\n-import sys\n-import tempfile\n-\n-\n-def main(*command: str) -> None:\n- with tempfile.TemporaryDirectory() as tmpdir:\n- os.chdir(tmpdir)\n-\n- for key, value in __loader__.get_contents().items():\n- if key.startswith('tmpfs/'):\n- subdir = os.path.dirname(key)\n- os.makedirs(subdir, exist_ok=True)\n- with open(key, 'wb') as fp:\n- fp.write(value)\n-\n- os.chdir('tmpfs')\n-\n- result = subprocess.run(command, check=False)\n- sys.exit(result.returncode)\n-''',\n 'cockpit/_vendor/bei/spawn.py': br'''\"\"\"Helper to create a beipack to spawn a command with files in a tmpdir\"\"\"\n \n import argparse\n import os\n import sys\n \n from . import pack, tmpfs\n@@ -8724,15 +7269,14 @@\n script = pack.pack(contents, '_beitmpfs:main', '*' + repr(args.command))\n sys.stdout.write(script)\n \n \n if __name__ == '__main__':\n main()\n ''',\n- 'cockpit/_vendor/bei/__init__.py': br'''''',\n 'cockpit/_vendor/bei/data/beipack_loader.py': br'''# beipack https://github.com/allisonkarlitskaya/beipack\n \n import importlib.abc\n import importlib.util\n import io\n import sys\n from types import ModuleType\n@@ -8825,14 +7369,1198 @@\n return (importlib.resources.files(__name__) / filename).read_text()\n else:\n def read_data_file(filename: str) -> str:\n loader = __loader__ # type: ignore[name-defined]\n data = loader.get_data(__file__.replace('__init__.py', filename))\n return data.decode('utf-8')\n ''',\n+ 'cockpit/_vendor/systemd_ctypes/librarywrapper.py': br'''# systemd_ctypes\n+#\n+# Copyright (C) 2022 Allison Karlitskaya \n+#\n+# This program is free software: you can redistribute it and/or modify\n+# it under the terms of the GNU General Public License as published by\n+# the Free Software Foundation, either version 3 of the License, or\n+# (at your option) any later version.\n+#\n+# This program is distributed in the hope that it will be useful,\n+# but WITHOUT ANY WARRANTY; without even the implied warranty of\n+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n+# GNU General Public License for more details.\n+#\n+# You should have received a copy of the GNU General Public License\n+# along with this program. If not, see .\n+\n+import ctypes\n+import inspect\n+import logging\n+import os\n+import sys\n+import types\n+from typing import (\n+ Any,\n+ Callable,\n+ Dict,\n+ Generic,\n+ NewType,\n+ NoReturn,\n+ Optional,\n+ Tuple,\n+ Type,\n+ TypeVar,\n+ Union,\n+)\n+\n+from . import typing\n+\n+# First in 3.10, and conditional import gives type errors\n+NoneType = type(None)\n+\n+logger = logging.getLogger(__name__)\n+\n+if typing.TYPE_CHECKING:\n+ CType = TypeVar(\"CType\", bound=ctypes._CData)\n+ Callback = ctypes._FuncPointer\n+else:\n+ CType = TypeVar(\"CType\")\n+ Callback = ctypes.c_void_p\n+\n+\n+if typing.TYPE_CHECKING:\n+ class Reference(Generic[CType], ctypes._Pointer[CType]):\n+ pass\n+\n+ def byref(x: CType) -> Reference[CType]:\n+ raise NotImplementedError\n+else:\n+ class Reference(Generic[CType]):\n+ pass\n+\n+ byref = ctypes.byref\n+\n+\n+UserData = Optional[ctypes.c_void_p]\n+\n+\n+class negative_errno(ctypes.c_int):\n+ def errcheck(self, func: Callable[..., object], _args: Tuple[object, ...]) -> int:\n+ result = self.value\n+ if result < 0:\n+ raise OSError(-result, f\"{func.__name__}: {os.strerror(-result)}\")\n+ return result\n+\n+\n+class utf8(ctypes.c_char_p):\n+ def errcheck(self, func: Callable[..., object], _args: Tuple[object, ...]) -> str:\n+ assert self.value is not None\n+ return self.value.decode()\n+\n+ @classmethod\n+ def from_param(cls, value: str) -> 'utf8':\n+ return cls(value.encode())\n+\n+\n+class utf8_or_null(ctypes.c_char_p):\n+ def errcheck(self,\n+ func: Callable[..., object],\n+ _args: Tuple[object, ...]) -> Optional[str]:\n+ return self.value.decode() if self.value is not None else None\n+\n+ @classmethod\n+ def from_param(cls, value: Optional[str]) -> 'utf8_or_null':\n+ return cls(value.encode() if value is not None else None)\n+\n+\n+class boolint(ctypes.c_int):\n+ def errcheck(self, func: Callable[..., object], _args: Tuple[object, ...]) -> bool:\n+ return bool(self.value)\n+\n+\n+WeakReference = NewType(\"WeakReference\", int)\n+Errno = typing.Annotated[NoReturn, \"errno\"]\n+\n+\n+type_map = {\n+ Union[None, Errno]: negative_errno, # technically returns int\n+ Union[bool, Errno]: negative_errno, # technically returns int\n+ Union[int, Errno]: negative_errno,\n+ bool: boolint,\n+ Optional[str]: utf8_or_null,\n+ str: utf8,\n+ int: ctypes.c_int,\n+ WeakReference: ctypes.c_void_p\n+}\n+\n+\n+def map_type(annotation: Any, global_vars: Dict[str, object]) -> Any:\n+ try:\n+ return type_map[annotation]\n+ except KeyError:\n+ pass # ... and try more cases below\n+\n+ if isinstance(annotation, typing.ForwardRef):\n+ annotation = annotation.__forward_arg__\n+\n+ if isinstance(annotation, str):\n+ annotation = global_vars[annotation]\n+\n+ origin = typing.get_origin(annotation)\n+ args = typing.get_args(annotation)\n+\n+ if origin is Reference:\n+ return ctypes.POINTER(map_type(args[0], global_vars))\n+\n+ elif origin is Union and NoneType in args:\n+ # the C pointer types are already nullable\n+ other_arg, = set(args) - {NoneType}\n+ return map_type(other_arg, global_vars)\n+\n+ elif origin is typing.Annotated:\n+ return args[1]\n+\n+ else:\n+ assert origin is None, origin\n+ return annotation\n+\n+\n+class ReferenceType(ctypes.c_void_p):\n+ @classmethod\n+ def _install_cfuncs(cls, cdll: ctypes.CDLL) -> None:\n+ logger.debug('Installing stubs for %s:', cls)\n+ stubs = tuple(cls.__dict__.items())\n+ for name, stub in stubs:\n+ if name.startswith(\"__\"):\n+ continue\n+ cls._wrap(cdll, stub)\n+\n+ cls._wrap(cdll, cls._ref)\n+ cls._wrap(cdll, cls._unref)\n+\n+ @classmethod\n+ def _wrap(cls, cdll: ctypes.CDLL, stub: object) -> None:\n+ stub_type = type(stub)\n+ if isinstance(stub, staticmethod):\n+ # In older Python versions, staticmethod() isn't considered\n+ # callable, doesn't have a name, and can't be introspected with\n+ # inspect.signature(). Unwrap it.\n+ stub = stub.__func__\n+ assert isinstance(stub, types.FunctionType)\n+ name = stub.__name__\n+ signature = inspect.signature(stub)\n+ stub_globals = sys.modules.get(cls.__module__).__dict__\n+\n+ func = cdll[f'{cls.__name__}_{name.lstrip(\"_\")}']\n+ func.argtypes = tuple(\n+ map_type(parameter.annotation, stub_globals)\n+ for parameter in signature.parameters.values()\n+ )\n+ func.restype = map_type(signature.return_annotation, stub_globals)\n+ errcheck = getattr(func.restype, 'errcheck', None)\n+ if errcheck is not None:\n+ func.errcheck = errcheck\n+\n+ logger.debug(' create wrapper %s.%s%s', cls.__name__, name, signature)\n+ logger.debug(' args %s res %s', func.argtypes, func.restype)\n+\n+ # ctypes function pointer objects don't implement the usual function\n+ # descriptor logic, which means they won't bind as methods. For static\n+ # methods, that's good, but for instance methods, we add a wrapper as\n+ # the easiest and most performant way to get the binding behaviour.\n+ if stub_type is not staticmethod:\n+ setattr(cls, name, lambda *args: func(*args))\n+ else:\n+ setattr(cls, name, func)\n+\n+ def _unref(self: 'ReferenceType') -> None:\n+ ...\n+\n+ def _ref(self: 'ReferenceType') -> None:\n+ ...\n+\n+ T = TypeVar(\"T\", bound='ReferenceType')\n+\n+ @classmethod\n+ def ref(cls: Type[T], origin: WeakReference) -> T:\n+ self = cls(origin)\n+ self._ref()\n+ return self\n+\n+ def __del__(self) -> None:\n+ if self.value is not None:\n+ self._unref()\n+''',\n+ 'cockpit/_vendor/systemd_ctypes/typing.py': br'''import typing\n+from typing import TYPE_CHECKING\n+\n+# The goal here is to continue to work on Python 3.6 while pretending to have\n+# access to some modern typing features. The shims provided here are only\n+# enough for what we need for systemd_ctypes to work at runtime.\n+\n+\n+if TYPE_CHECKING:\n+ # See https://github.com/python/mypy/issues/1153 for why we do this separately\n+ from typing import Annotated, ForwardRef, TypeGuard, get_args, get_origin\n+\n+else:\n+ # typing.get_args() and .get_origin() appeared in Python 3.8 but Annotated\n+ # arrived in 3.9. Unfortunately, it's difficult to implement a mocked up\n+ # version of Annotated which works with the real typing.get_args() and\n+ # .get_origin() in Python 3.8, so we use our own versions there as well.\n+ try:\n+ from typing import Annotated, get_args, get_origin\n+ except ImportError:\n+ class AnnotatedMeta(type):\n+ def __getitem__(cls, params):\n+ class AnnotatedType:\n+ __origin__ = Annotated\n+ __args__ = params\n+ return AnnotatedType\n+\n+ class Annotated(metaclass=AnnotatedMeta):\n+ pass\n+\n+ def get_args(annotation: typing.Any) -> typing.Tuple[typing.Any]:\n+ return getattr(annotation, '__args__', ())\n+\n+ def get_origin(annotation: typing.Any) -> typing.Any:\n+ return getattr(annotation, '__origin__', None)\n+\n+ try:\n+ from typing import ForwardRef\n+ except ImportError:\n+ from typing import _ForwardRef as ForwardRef\n+\n+ try:\n+ from typing import TypeGuard\n+ except ImportError:\n+ T = typing.TypeVar('T')\n+\n+ class TypeGuard(typing.Generic[T]):\n+ pass\n+\n+\n+__all__ = (\n+ 'Annotated',\n+ 'ForwardRef',\n+ 'TypeGuard',\n+ 'get_args',\n+ 'get_origin',\n+ 'TYPE_CHECKING',\n+)\n+''',\n+ 'cockpit/_vendor/systemd_ctypes/inotify.py': br'''# systemd_ctypes\n+#\n+# Copyright (C) 2022 Allison Karlitskaya \n+#\n+# This program is free software: you can redistribute it and/or modify\n+# it under the terms of the GNU General Public License as published by\n+# the Free Software Foundation, either version 3 of the License, or\n+# (at your option) any later version.\n+#\n+# This program is distributed in the hope that it will be useful,\n+# but WITHOUT ANY WARRANTY; without even the implied warranty of\n+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n+# GNU General Public License for more details.\n+#\n+# You should have received a copy of the GNU General Public License\n+# along with this program. If not, see .\n+\n+import ctypes\n+from enum import IntFlag, auto\n+from typing import Optional\n+\n+\n+class inotify_event(ctypes.Structure):\n+ _fields_ = (\n+ ('wd', ctypes.c_int32),\n+ ('mask', ctypes.c_uint32),\n+ ('cookie', ctypes.c_uint32),\n+ ('len', ctypes.c_uint32),\n+ )\n+\n+ @property\n+ def name(self) -> Optional[bytes]:\n+ if self.len == 0:\n+ return None\n+\n+ class event_with_name(ctypes.Structure):\n+ _fields_ = (*inotify_event._fields_, ('name', ctypes.c_char * self.len))\n+\n+ name = ctypes.cast(ctypes.addressof(self), ctypes.POINTER(event_with_name)).contents.name\n+ assert isinstance(name, bytes)\n+ return name\n+\n+\n+class Event(IntFlag):\n+ ACCESS = auto()\n+ MODIFY = auto()\n+ ATTRIB = auto()\n+ CLOSE_WRITE = auto()\n+ CLOSE_NOWRITE = auto()\n+ OPEN = auto()\n+ MOVED_FROM = auto()\n+ MOVED_TO = auto()\n+ CREATE = auto()\n+ DELETE = auto()\n+ DELETE_SELF = auto()\n+ MOVE_SELF = auto()\n+\n+ UNMOUNT = 1 << 13\n+ Q_OVERFLOW = auto()\n+ IGNORED = auto()\n+\n+ ONLYDIR = 1 << 24\n+ DONT_FOLLOW = auto()\n+ EXCL_UNLINK = auto()\n+\n+ MASK_CREATE = 1 << 28\n+ MASK_ADD = auto()\n+ ISDIR = auto()\n+ ONESHOT = auto()\n+\n+ CLOSE = CLOSE_WRITE | CLOSE_NOWRITE\n+ MOVE = MOVED_FROM | MOVED_TO\n+ CHANGED = (MODIFY | ATTRIB | CLOSE_WRITE | MOVE |\n+ CREATE | DELETE | DELETE_SELF | MOVE_SELF)\n+''',\n+ 'cockpit/_vendor/systemd_ctypes/pathwatch.py': br'''# systemd_ctypes\n+#\n+# Copyright (C) 2022 Allison Karlitskaya \n+#\n+# This program is free software: you can redistribute it and/or modify\n+# it under the terms of the GNU General Public License as published by\n+# the Free Software Foundation, either version 3 of the License, or\n+# (at your option) any later version.\n+#\n+# This program is distributed in the hope that it will be useful,\n+# but WITHOUT ANY WARRANTY; without even the implied warranty of\n+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n+# GNU General Public License for more details.\n+#\n+# You should have received a copy of the GNU General Public License\n+# along with this program. If not, see .\n+\n+import errno\n+import logging\n+import os\n+import stat\n+from typing import Any, List, Optional\n+\n+from .event import Event\n+from .inotify import Event as IN\n+\n+logger = logging.getLogger(__name__)\n+\n+\n+# inotify hard facts:\n+#\n+# DELETE_SELF doesn't get called until all references to an inode are gone\n+# - including open fds\n+# - including on directories\n+#\n+# ATTRIB gets called when unlinking files (because the link count changes) but\n+# not on directories. When unlinking an open directory, no events at all\n+# happen on the directory. ATTRIB also collects child events, which means we\n+# get a lot of unwanted noise.\n+#\n+# There's nothing like UNLINK_SELF, unfortunately.\n+#\n+# Even if it was possible to take this approach, it might not work: after\n+# you've opened the fd, it might get deleted before you can establish the watch\n+# on it.\n+#\n+# Additionally, systemd makes it impossible to register those events on\n+# symlinks (because it removes IN_DONT_FOLLOW in order to watch via\n+# /proc/self/fd).\n+#\n+# For all of these reasons, unfortunately, the best way seems to be to watch\n+# for CREATE|DELETE|MOVE events on each intermediate directory.\n+#\n+# Unfortunately there is no way to filter to only the name we're interested in,\n+# so we're gonna get a lot of unnecessary wakeups.\n+#\n+# Also: due to the above-mentioned race about watching after opening the fd,\n+# let's just always watch for both create and delete events *before* trying to\n+# open the fd. We could try to reduce the mask after the fact, but meh...\n+#\n+# We use a WatchInvalidator utility class to fill the role of \"Tell me when an\n+# event happened on this (directory) fd which impacted the name file\". We\n+# build a series of these when setting up a watch in order to find out if any\n+# part of the path leading to the monitored file changed.\n+\n+\n+class Handle(int):\n+ \"\"\"An integer subclass that makes it easier to work with file descriptors\"\"\"\n+\n+ def __new__(cls, fd: int = -1) -> 'Handle':\n+ return super(Handle, cls).__new__(cls, fd)\n+\n+ # separate __init__() to set _needs_close mostly to keep pylint quiet\n+ def __init__(self, fd: int = -1):\n+ super().__init__()\n+ self._needs_close = fd != -1\n+\n+ def __bool__(self) -> bool:\n+ return self != -1\n+\n+ def close(self) -> None:\n+ if self._needs_close:\n+ self._needs_close = False\n+ os.close(self)\n+\n+ def __eq__(self, value: object) -> bool:\n+ if int.__eq__(self, value): # also handles both == -1\n+ return True\n+\n+ if not isinstance(value, int): # other object is not an int\n+ return False\n+\n+ if not self or not value: # when only one == -1\n+ return False\n+\n+ return os.path.sameopenfile(self, value)\n+\n+ def __del__(self) -> None:\n+ if self._needs_close:\n+ self.close()\n+\n+ def __enter__(self) -> 'Handle':\n+ return self\n+\n+ def __exit__(self, _type: type, _value: object, _traceback: object) -> None:\n+ self.close()\n+\n+ @classmethod\n+ def open(cls, *args: Any, **kwargs: Any) -> 'Handle':\n+ return cls(os.open(*args, **kwargs))\n+\n+ def steal(self) -> 'Handle':\n+ self._needs_close = False\n+ return self.__class__(int(self))\n+\n+\n+class WatchInvalidator:\n+ _name: bytes\n+ _source: Optional[Event.Source]\n+ _watch: Optional['PathWatch']\n+\n+ def event(self, mask: IN, _cookie: int, name: Optional[bytes]) -> None:\n+ logger.debug('invalidator event %s %s', mask, name)\n+ if self._watch is not None:\n+ # If this node itself disappeared, that's definitely an\n+ # invalidation. Otherwise, the name needs to match.\n+ if IN.IGNORED in mask or self._name == name:\n+ logger.debug('Invalidating!')\n+ self._watch.invalidate()\n+\n+ def __init__(self, watch: 'PathWatch', event: Event, dirfd: int, name: str):\n+ self._watch = watch\n+ self._name = name.encode('utf-8')\n+\n+ # establishing invalidation watches is best-effort and can fail for a\n+ # number of reasons, including search (+x) but not read (+r) permission\n+ # on a particular path component, or exceeding limits on watches\n+ try:\n+ mask = IN.CREATE | IN.DELETE | IN.MOVE | IN.DELETE_SELF | IN.IGNORED\n+ self._source = event.add_inotify_fd(dirfd, mask, self.event)\n+ except OSError:\n+ self._source = None\n+\n+ def close(self) -> None:\n+ # This is a little bit tricky: systemd doesn't have a specific close\n+ # API outside of unref, so let's make it as explicit as possible.\n+ self._watch = None\n+ self._source = None\n+\n+\n+class PathStack(List[str]):\n+ def add_path(self, pathname: str) -> None:\n+ # TO DO: consider doing something reasonable with trailing slashes\n+ # this is a stack, popped from the end: push components in reverse\n+ self.extend(item for item in reversed(pathname.split('/')) if item)\n+ if pathname.startswith('/'):\n+ self.append('/')\n+\n+ def __init__(self, path: str):\n+ super().__init__()\n+ self.add_path(path)\n+\n+\n+class Listener:\n+ def do_inotify_event(self, mask: IN, cookie: int, name: Optional[bytes]) -> None:\n+ raise NotImplementedError\n+\n+ def do_identity_changed(self, fd: Optional[Handle], errno: Optional[int]) -> None:\n+ raise NotImplementedError\n+\n+\n+class PathWatch:\n+ _event: Event\n+ _listener: Listener\n+ _path: str\n+ _invalidators: List[WatchInvalidator]\n+ _errno: Optional[int]\n+ _source: Optional[Event.Source]\n+ _tag: Optional[None]\n+ _fd: Handle\n+\n+ def __init__(self, path: str, listener: Listener, event: Optional[Event] = None):\n+ self._event = event or Event.default()\n+ self._path = path\n+ self._listener = listener\n+\n+ self._invalidators = []\n+ self._errno = None\n+ self._source = None\n+ self._tag = None\n+ self._fd = Handle()\n+\n+ self.invalidate()\n+\n+ def got_event(self, mask: IN, cookie: int, name: Optional[bytes]) -> None:\n+ logger.debug('target event %s: %s %s %s', self._path, mask, cookie, name)\n+ self._listener.do_inotify_event(mask, cookie, name)\n+\n+ def invalidate(self) -> None:\n+ for invalidator in self._invalidators:\n+ invalidator.close()\n+ self._invalidators = []\n+\n+ try:\n+ fd = self.walk()\n+ except OSError as error:\n+ logger.debug('walk ended in error %d', error.errno)\n+\n+ if self._source or self._fd or self._errno != error.errno:\n+ logger.debug('Ending existing watches.')\n+ self._source = None\n+ self._fd.close()\n+ self._fd = Handle()\n+ self._errno = error.errno\n+\n+ logger.debug('Notifying of new error state %d', self._errno)\n+ self._listener.do_identity_changed(None, self._errno)\n+\n+ return\n+\n+ with fd:\n+ logger.debug('walk successful. Got fd %d', fd)\n+ if fd == self._fd:\n+ logger.debug('fd seems to refer to same file. Doing nothing.')\n+ return\n+\n+ logger.debug('This file is new for us. Removing old watch.')\n+ self._source = None\n+ self._fd.close()\n+ self._fd = fd.steal()\n+\n+ try:\n+ logger.debug('Establishing a new watch.')\n+ self._source = self._event.add_inotify_fd(self._fd, IN.CHANGED, self.got_event)\n+ logger.debug('Watching successfully. Notifying of new identity.')\n+ self._listener.do_identity_changed(self._fd, None)\n+ except OSError as error:\n+ logger.debug('Watching failed (%d). Notifying of new identity.', error.errno)\n+ self._listener.do_identity_changed(self._fd, error.errno)\n+\n+ def walk(self) -> Handle:\n+ remaining_symlink_lookups = 40\n+ remaining_components = PathStack(self._path)\n+ dirfd = Handle()\n+\n+ try:\n+ logger.debug('Starting path walk')\n+\n+ while remaining_components:\n+ logger.debug('r=%s dfd=%s', remaining_components, dirfd)\n+\n+ name = remaining_components.pop()\n+\n+ if dirfd and name != '/':\n+ self._invalidators.append(WatchInvalidator(self, self._event, dirfd, name))\n+\n+ with Handle.open(name, os.O_PATH | os.O_NOFOLLOW | os.O_CLOEXEC, dir_fd=dirfd) as fd:\n+ mode = os.fstat(fd).st_mode\n+\n+ if stat.S_ISLNK(mode):\n+ if remaining_symlink_lookups == 0:\n+ raise OSError(errno.ELOOP, os.strerror(errno.ELOOP))\n+ remaining_symlink_lookups -= 1\n+ linkpath = os.readlink('', dir_fd=fd)\n+ logger.debug('%s is a symlink. adding %s to components', name, linkpath)\n+ remaining_components.add_path(linkpath)\n+\n+ else:\n+ dirfd.close()\n+ dirfd = fd.steal()\n+\n+ return dirfd.steal()\n+\n+ finally:\n+ dirfd.close()\n+\n+ def close(self) -> None:\n+ for invalidator in self._invalidators:\n+ invalidator.close()\n+ self._invalidators = []\n+ self._source = None\n+ self._fd.close()\n+''',\n+ 'cockpit/_vendor/systemd_ctypes/bustypes.py': br'''# systemd_ctypes\n+#\n+# Copyright (C) 2023 Allison Karlitskaya \n+#\n+# This program is free software: you can redistribute it and/or modify\n+# it under the terms of the GNU General Public License as published by\n+# the Free Software Foundation, either version 3 of the License, or\n+# (at your option) any later version.\n+#\n+# This program is distributed in the hope that it will be useful,\n+# but WITHOUT ANY WARRANTY; without even the implied warranty of\n+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n+# GNU General Public License for more details.\n+#\n+# You should have received a copy of the GNU General Public License\n+# along with this program. If not, see .\n+\n+\n+# This file is responsible for creating functions to (de)serialize Python\n+# objects into and out of BusMessage objects.\n+#\n+# Each Type corresponds to a (possibly complex) D-Bus type. It has a .reader\n+# and a .writer property. The readers take a message and deserialize a single\n+# value from it, returning the value:\n+#\n+# def reader(message: BusMessage) -> object:\n+#\n+# The writers take a message and a value, and append the value to the message.\n+#\n+# def writer(message: BusMessage, value: object) -> None:\n+#\n+# The necessary information for the specific type of object to be handled is\n+# part of the function. No additional information needs to be provided.\n+\n+import binascii\n+import ctypes\n+import functools\n+import inspect\n+import json\n+import re\n+from enum import Enum\n+from typing import Any, Callable, ClassVar, Dict, Iterable, List, Optional, Sequence, Tuple, TypeVar, Union\n+\n+from . import libsystemd, typing\n+from .typing import Annotated, TypeGuard\n+\n+_object_path_re = re.compile(r'/|(/[A-Za-z0-9_]+)+')\n+\n+\n+def is_object_path(candidate: str) -> TypeGuard['BusType.objectpath']:\n+ return _object_path_re.fullmatch(candidate) is not None\n+\n+\n+def is_signature(candidate: str) -> TypeGuard['BusType.signature']:\n+ offset = 0\n+\n+ def maybe_pop(acceptable: str) -> Optional[str]:\n+ nonlocal offset\n+ char = candidate[offset]\n+ if char in acceptable:\n+ offset += 1\n+ return char\n+ else:\n+ return None\n+\n+ def pop(acceptable: str) -> str:\n+ char = maybe_pop(acceptable)\n+ assert char is not None\n+ return char\n+\n+ def find_next() -> None:\n+ first = pop('ybnqiuxtsogdva(') # valid first characters\n+ if first == 'a':\n+ if maybe_pop('{'): # dict\n+ pop('ybnqiuxtsogd') # key\n+ find_next() # value\n+ pop('}')\n+ else: # array\n+ find_next() # item\n+ elif first == '(': # structure\n+ find_next() # at least one item\n+ while not maybe_pop(')'):\n+ find_next() # and possibly more\n+\n+ try:\n+ while offset < len(candidate):\n+ find_next()\n+ return True\n+ except (AssertionError, IndexError):\n+ return False\n+\n+\n+def yield_base_helpers() -> Iterable[Tuple[str, object]]:\n+ for method in ['enter_container', 'exit_container', 'open_container', 'close_container',\n+ 'append_basic', 'read_basic', 'append_array', 'read_array']:\n+ yield method, libsystemd.libsystemd[f'sd_bus_message_{method}']\n+\n+ for name in ['size_t', 'char_p']:\n+ instance = getattr(ctypes, f'c_{name}')()\n+ yield f'{name}', instance\n+ yield f'{name}_ref', ctypes.byref(instance)\n+ yield f'{name}_setter', instance.__class__.value.__set__\n+\n+ for char in 'aervy':\n+ yield char, ctypes.c_char(ord(char))\n+\n+ # https://docs.python.org/3/c-api/unicode.html#c.PyUnicode_FromString\n+ to_bytes = ctypes.pythonapi.PyBytes_FromStringAndSize\n+ to_bytes.restype = ctypes.py_object\n+ yield 'to_bytes', to_bytes\n+\n+\n+_base_helpers = dict(yield_base_helpers())\n+\n+T = TypeVar('T')\n+\n+\n+def call_with_kwargs(func: Callable[..., T], kwargs: Dict[str, Any]) -> T:\n+ parameters = set(inspect.signature(func).parameters)\n+ return func(**{key: value for key, value in kwargs.items() if key in parameters})\n+\n+\n+class Type:\n+ _cache: ClassVar[Dict[Tuple[type, Tuple[object, ...]], 'Type']] = {}\n+\n+ __slots__ = 'typestring', 'bytes_typestring', 'writer', 'reader'\n+ typestring: str\n+ bytes_typestring: bytes\n+ reader: Callable[[libsystemd.sd_bus_message], object]\n+ writer: Callable[[libsystemd.sd_bus_message, object], None]\n+\n+ def __new__(cls, *args: Any) -> 'Type':\n+ instance = Type._cache.get((cls, args))\n+ if instance is None:\n+ instance = object.__new__(cls)\n+ Type._cache[(cls, args)] = instance\n+ return instance\n+\n+ def __init__(self, typestring: str, **kwargs: Any):\n+ self.typestring = typestring\n+ self.bytes_typestring = typestring.encode('ascii')\n+\n+ kwargs = dict(_base_helpers, **kwargs)\n+ self.writer = call_with_kwargs(self.get_writer, kwargs)\n+ self.reader = call_with_kwargs(self.get_reader, kwargs)\n+\n+ def __repr__(self) -> str:\n+ return f\"{self.__class__.__name__}('{self.typestring}')\"\n+\n+ def get_writer(self, **kwargs: object) -> Callable[[object, object], None]:\n+ raise NotImplementedError\n+\n+ def get_reader(self, **kwargs: object) -> Callable[[object], object]:\n+ raise NotImplementedError\n+\n+\n+class BasicType(Type):\n+ __slots__ = ()\n+\n+ def __init__(self, typestring: str, ctype, get_wrapper=None, **kwargs):\n+ variable = ctype() # NB: not thread-safe\n+ super().__init__(typestring, ctype=ctype, type_constant=ctypes.c_char(ord(typestring)),\n+ getter=get_wrapper or ctype.value.__get__, setter=ctype.value.__set__,\n+ variable=variable, reference=ctypes.byref(variable), **kwargs)\n+\n+ def get_reader(self, read_basic, type_constant, variable, reference, getter):\n+ def basic_reader(message: libsystemd.sd_bus_message) -> object:\n+ if read_basic(message, type_constant, reference) <= 0:\n+ raise StopIteration\n+ return getter(variable)\n+ return basic_reader\n+\n+\n+class FixedType(BasicType):\n+ __slots__ = ()\n+\n+ def get_writer(self, append_basic, type_constant, variable, reference, setter, getter):\n+ def fixed_writer(message: libsystemd.sd_bus_message, value: object) -> None:\n+ setter(variable, value)\n+ if getter(variable) != value:\n+ raise TypeError(f\"Cannot represent value {value} with type '{self.typestring}'\")\n+ append_basic(message, type_constant, reference)\n+ return fixed_writer\n+\n+\n+class StringLikeType(BasicType):\n+ __slots__ = ()\n+\n+ @staticmethod\n+ def get_guarded_conversion(typestring: str, guard: Callable[[str], bool]) -> Callable[[object], bytes]:\n+ def convert(candidate: object) -> bytes:\n+ if not isinstance(candidate, str):\n+ raise TypeError(f\"'{typestring}' encodes 'str', not '{candidate.__class__.__name__}'\")\n+ if not guard(candidate):\n+ raise ValueError(f\"Invalid value provided for type '{typestring}'\")\n+ return str.encode(candidate)\n+ return convert\n+\n+ def __init__(self, typestring: str, guard: Optional[Callable[[str], bool]] = None):\n+ # https://docs.python.org/3/c-api/unicode.html#c.PyUnicode_FromString\n+ to_unicode = ctypes.pythonapi.PyUnicode_FromString\n+ to_unicode.restype = ctypes.py_object\n+\n+ if guard is not None:\n+ convert = StringLikeType.get_guarded_conversion(typestring, guard)\n+ else:\n+ convert = str.encode # type: ignore[assignment] # can throw TypeError on call\n+\n+ super().__init__(typestring, ctypes.c_char_p, to_unicode, convert=convert)\n+\n+ def get_writer(self, append_basic, type_constant, convert):\n+ def string_writer(message: libsystemd.sd_bus_message, value: object) -> None:\n+ append_basic(message, type_constant, convert(value))\n+ return string_writer\n+\n+\n+class BytestringType(Type):\n+ __slots__ = ()\n+\n+ def get_writer(self, append_array, y, size_t_setter, size_t):\n+ def bytes_writer(message: libsystemd.sd_bus_message, value: object) -> None:\n+ if not isinstance(value, bytes):\n+ if isinstance(value, str):\n+ try:\n+ value = binascii.a2b_base64(value.encode('ascii')) # or decode base64\n+ except binascii.Error as exc:\n+ raise ValueError(\"'ay' cannot encode invalid base64 string\") from exc\n+ elif isinstance(value, (memoryview, bytearray)):\n+ value = bytes(value)\n+ else:\n+ raise TypeError(\"'ay' can only encode bytes-like or base64 string objects, \"\n+ f\"not '{value.__class__.__name__}'.\")\n+ size_t_setter(size_t, len(value))\n+ append_array(message, y, value, size_t)\n+ return bytes_writer\n+\n+ def get_reader(self, read_array, y, to_bytes, char_p, char_p_ref, size_t, size_t_ref):\n+ def bytes_reader(message):\n+ if read_array(message, y, char_p_ref, size_t_ref) <= 0:\n+ raise StopIteration\n+ return to_bytes(char_p, size_t)\n+ return bytes_reader\n+\n+\n+class ContainerType(Type):\n+ _typestring_template: ClassVar[str]\n+ __slots__ = 'item_types'\n+ item_types: Sequence[Type]\n+\n+ def __init__(self, *item_types: Type, **kwargs: Any):\n+ assert len(item_types) > 0\n+ item_typestrings = ''.join(item.typestring for item in item_types)\n+ self.item_types = item_types\n+ super().__init__(self._typestring_template.replace('_', item_typestrings),\n+ type_contents=ctypes.c_char_p(item_typestrings.encode('ascii')),\n+ **kwargs)\n+\n+\n+class ArrayType(ContainerType):\n+ _typestring_template = 'a_'\n+ __slots__ = ()\n+\n+ def __init__(self, item_type: Type):\n+ super().__init__(item_type,\n+ item_writer=item_type.writer,\n+ item_reader=item_type.reader,\n+ list_append=list.append)\n+\n+ def get_reader(self, enter_container, exit_container, list_append, item_reader):\n+ def array_reader(message: libsystemd.sd_bus_message) -> object:\n+ if enter_container(message, 0, None) <= 0:\n+ raise StopIteration\n+ result: List[object] = []\n+ try:\n+ while True:\n+ list_append(result, item_reader(message))\n+ except StopIteration:\n+ return result\n+ finally:\n+ exit_container(message)\n+ return array_reader\n+\n+ def get_writer(self, a, type_contents, open_container, close_container, item_writer):\n+ def array_writer(message: libsystemd.sd_bus_message, value: object) -> None:\n+ open_container(message, a, type_contents)\n+ for item in value: # type: ignore[attr-defined] # can throw TypeError\n+ item_writer(message, item)\n+ close_container(message)\n+ return array_writer\n+\n+\n+class StructType(ContainerType):\n+ _typestring_template = '(_)'\n+ __slots__ = ()\n+\n+ def get_reader(self, enter_container, exit_container):\n+ item_readers = tuple(item_type.reader for item_type in self.item_types)\n+\n+ def array_reader(message: libsystemd.sd_bus_message) -> object:\n+ if enter_container(message, 0, None) <= 0:\n+ raise StopIteration\n+ result = tuple(item_reader(message) for item_reader in item_readers)\n+ exit_container(message)\n+ return result\n+ return array_reader\n+\n+ def get_writer(self, r, type_contents, open_container, close_container):\n+ item_writers = tuple(item_type.writer for item_type in self.item_types)\n+\n+ def struct_writer(message: libsystemd.sd_bus_message, value: object) -> None:\n+ n_items = len(value) # type: ignore[arg-type] # can throw TypeError\n+ if n_items != len(item_writers):\n+ raise TypeError(f\"Wrong numbers of items ({n_items}) for structure type '{self.typestring}'\")\n+ open_container(message, r, type_contents)\n+ for item_writer, item in zip(item_writers, value): # type: ignore[call-overload] # can throw TypeError\n+ item_writer(message, item)\n+ close_container(message)\n+ return struct_writer\n+\n+\n+class DictionaryType(ContainerType):\n+ _typestring_template = 'a{_}'\n+ __slots__ = ()\n+\n+ def __init__(self, key_type: Type, value_type: Type):\n+ assert isinstance(key_type, BasicType)\n+ item_type = '{' + key_type.typestring + value_type.typestring + '}'\n+ super().__init__(key_type, value_type,\n+ key_reader=key_type.reader, key_writer=key_type.writer,\n+ value_reader=value_type.reader, value_writer=value_type.writer,\n+ item_type=ctypes.c_char_p(item_type.encode('ascii')))\n+\n+ def get_reader(self, enter_container, exit_container, key_reader, value_reader):\n+ def dict_reader(message: libsystemd.sd_bus_message) -> object:\n+ if enter_container(message, 0, None) <= 0: # array\n+ raise StopIteration\n+ result = {}\n+ while enter_container(message, 0, None) > 0: # entry\n+ key = key_reader(message)\n+ value = value_reader(message)\n+ result[key] = value\n+ exit_container(message)\n+ exit_container(message)\n+ return result\n+ return dict_reader\n+\n+ def get_writer(self, a, item_type, e, type_contents, open_container, close_container, key_writer, value_writer):\n+ def dict_writer(message: libsystemd.sd_bus_message, value: object) -> None:\n+ open_container(message, a, item_type) # array\n+ for key, val in value.items(): # type: ignore[attr-defined] # can raise AttributeError\n+ open_container(message, e, type_contents) # entry\n+ key_writer(message, key) # key\n+ value_writer(message, val) # value\n+ close_container(message) # end entry\n+ close_container(message) # end array\n+ return dict_writer\n+\n+\n+class VariantType(Type):\n+ __slots__ = ()\n+\n+ def get_reader(self, enter_container, exit_container):\n+ def variant_reader(message: libsystemd.sd_bus_message) -> object:\n+ if enter_container(message, 0, None) <= 0:\n+ raise StopIteration\n+ typestring = message.get_signature(False)\n+ type_, = from_signature(typestring)\n+ value = type_.reader(message)\n+ exit_container(message)\n+ return Variant(value, type_)\n+ return variant_reader\n+\n+ def get_writer(self, open_container, close_container, v):\n+ def variant_writer(message: libsystemd.sd_bus_message, value: object) -> None:\n+ if isinstance(value, Variant):\n+ type_ = value.type\n+ contents = value.value\n+ else:\n+ try:\n+ type_, = from_signature(value['t']) # type: ignore[index] # can throw TypeError\n+ contents = value['v'] # type: ignore[index] # can throw TypeError\n+ except KeyError as exc:\n+ raise TypeError(\"'v' can encode Variant objects, or mappings with 't' and 'v' keys\") from exc\n+\n+ open_container(message, v, type_.bytes_typestring)\n+ type_.writer(message, contents)\n+ close_container(message)\n+ return variant_writer\n+\n+\n+class Variant:\n+ __slots__ = 'type', 'value'\n+ type: Type\n+ value: object\n+\n+ def __init__(self, value: object, hint: object = None):\n+ if isinstance(hint, Type):\n+ self.type = hint\n+ elif isinstance(hint, str):\n+ self.type, = from_signature(hint)\n+ else:\n+ self.type = from_annotation(hint or value.__class__)\n+ self.value = value\n+\n+ def __repr__(self) -> str:\n+ return f\"systemd_ctypes.Variant({self.value}, '{self.type.typestring}')\"\n+\n+ def __eq__(self, other: object) -> bool:\n+ if isinstance(other, Variant):\n+ return self.type == other.type and self.value == other.value\n+ elif isinstance(other, dict):\n+ return (self.type,) == from_signature(other['t']) and self.value == other['v']\n+ else:\n+ return False\n+\n+ def __hash__(self) -> int:\n+ return hash(self.type) ^ hash(self.value)\n+\n+\n+class BusType(Enum):\n+ boolean = Annotated[bool, FixedType('b', ctypes.c_int, ctypes.c_int.__bool__)]\n+ byte = Annotated[int, FixedType('y', ctypes.c_uint8)]\n+ int16 = Annotated[int, FixedType('n', ctypes.c_int16)]\n+ uint16 = Annotated[int, FixedType('q', ctypes.c_uint16)]\n+ int32 = Annotated[int, FixedType('i', ctypes.c_int32)]\n+ uint32 = Annotated[int, FixedType('u', ctypes.c_uint32)]\n+ int64 = Annotated[int, FixedType('x', ctypes.c_int64)]\n+ uint64 = Annotated[int, FixedType('t', ctypes.c_uint64)]\n+ double = Annotated[float, FixedType('d', ctypes.c_double)]\n+ string = Annotated[str, StringLikeType('s')]\n+ objectpath = Annotated[str, StringLikeType('o', is_object_path)]\n+ signature = Annotated[str, StringLikeType('g', is_signature)]\n+ bytestring = Annotated[bytes, BytestringType('ay')]\n+ variant = Annotated[dict, VariantType('v')]\n+\n+\n+# mypy gets confused by enums, so just use Any\n+_base_equivalence_map: Dict[type, Any] = {\n+ bool: BusType.boolean,\n+ bytes: BusType.bytestring,\n+ int: BusType.int32,\n+ str: BusType.string,\n+ Variant: BusType.variant,\n+}\n+\n+_factory_map: Dict[object, Callable[..., Type]] = {\n+ dict: DictionaryType, Dict: DictionaryType,\n+ list: ArrayType, List: ArrayType,\n+ tuple: StructType, Tuple: StructType,\n+}\n+\n+\n+@functools.lru_cache()\n+def from_annotation(annotation: Union[str, type, BusType]) -> Type:\n+ # Simple Python types\n+ if isinstance(annotation, str):\n+ types = from_signature(annotation)\n+ if len(types) != 1:\n+ raise TypeError(f\"Signature '{annotation}' invalid as a type string \"\n+ f\"because it describes {len(types)} types, not one.\")\n+ return types[0]\n+\n+ if isinstance(annotation, type):\n+ annotation = _base_equivalence_map.get(annotation, annotation)\n+\n+ # Our own BusType types\n+ if isinstance(annotation, BusType):\n+ bus_type = typing.get_args(annotation.value)[1]\n+ assert isinstance(bus_type, Type)\n+ return bus_type\n+\n+ # Container types\n+ try:\n+ factory = _factory_map[typing.get_origin(annotation)]\n+ args = [from_annotation(arg) for arg in typing.get_args(annotation)]\n+ return factory(*args)\n+ except (AssertionError, AttributeError, KeyError, TypeError):\n+ raise TypeError(f\"Cannot interpret {annotation} as a dbus type\") from None\n+\n+\n+_base_typestring_map: Dict[str, Type] = {\n+ bustype.typestring: bustype for bustype in (from_annotation(entry) for entry in BusType)\n+}\n+\n+\n+@functools.lru_cache()\n+def from_signature(signature: str) -> Tuple[Type, ...]:\n+ stack = list(reversed(signature))\n+\n+ def get_one() -> Type:\n+ first = stack.pop()\n+ if first == 'a':\n+ if stack[-1] == 'y':\n+ first += stack.pop()\n+ elif stack[-1] == '{':\n+ stack.pop()\n+ return DictionaryType(*get_several('}'))\n+ else:\n+ return ArrayType(get_one())\n+ elif first == '(':\n+ return StructType(*get_several(')'))\n+\n+ return _base_typestring_map[first]\n+\n+ def get_several(end: str) -> Iterable[Type]:\n+ yield get_one()\n+ while stack[-1] != end:\n+ yield get_one()\n+ stack.pop()\n+\n+ def get_all() -> Iterable[Type]:\n+ while stack:\n+ yield get_one()\n+\n+ try:\n+ return tuple(get_all())\n+ except (AssertionError, IndexError, KeyError) as exc:\n+ raise TypeError(f\"Invalid type signature '{signature}'\") from exc\n+\n+\n+class MessageType:\n+ item_types: Sequence[Type]\n+ typestrings: List[str]\n+ signature: str\n+\n+ def __init__(self, item_types: Sequence[Union[str, type, BusType]]):\n+ self.item_types = [from_annotation(item_type) for item_type in item_types]\n+ self.typestrings = [item_type.typestring for item_type in self.item_types]\n+ self.signature = ''.join(self.typestrings)\n+\n+ def write(self, message: libsystemd.sd_bus_message, *items: object) -> None:\n+ assert len(items) == len(self.item_types)\n+ for item_type, item in zip(self.item_types, items):\n+ item_type.writer(message, item)\n+\n+ def read(self, message: libsystemd.sd_bus_message) -> Optional[Tuple[object, ...]]:\n+ if not message.has_signature(self.signature):\n+ return None\n+ return tuple(item_type.reader(message) for item_type in self.item_types)\n+\n+ def __len__(self) -> int:\n+ return len(self.item_types)\n+\n+\n+class JSONEncoder(json.JSONEncoder):\n+ def default(self, obj: object) -> object:\n+ if isinstance(obj, Variant):\n+ return {\"t\": obj.type.typestring, \"v\": obj.value}\n+ elif isinstance(obj, bytes):\n+ return binascii.b2a_base64(obj, newline=False).decode('ascii')\n+ return super().default(obj)\n+''',\n 'cockpit/_vendor/systemd_ctypes/event.py': br'''# systemd_ctypes\n #\n # Copyright (C) 2022 Allison Karlitskaya \n #\n # This program is free software: you can redistribute it and/or modify\n # it under the terms of the GNU General Public License as published by\n # the Free Software Foundation, either version 3 of the License, or\n@@ -8964,15 +8692,15 @@\n asyncio._systemd_ctypes_polyfills = True # type: ignore[attr-defined]\n \n asyncio.run(main, debug=debug)\n \n if polyfill:\n del asyncio.create_task, asyncio.get_running_loop, asyncio.run\n ''',\n- 'cockpit/_vendor/systemd_ctypes/inotify.py': br'''# systemd_ctypes\n+ 'cockpit/_vendor/systemd_ctypes/__init__.py': br'''# systemd_ctypes\n #\n # Copyright (C) 2022 Allison Karlitskaya \n #\n # This program is free software: you can redistribute it and/or modify\n # it under the terms of the GNU General Public License as published by\n # the Free Software Foundation, either version 3 of the License, or\n # (at your option) any later version.\n@@ -8981,71 +8709,129 @@\n # but WITHOUT ANY WARRANTY; without even the implied warranty of\n # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n # GNU General Public License for more details.\n #\n # You should have received a copy of the GNU General Public License\n # along with this program. If not, see .\n \n-import ctypes\n-from enum import IntFlag, auto\n-from typing import Optional\n+\"\"\"systemd_ctypes\"\"\"\n \n+__version__ = \"0\"\n \n-class inotify_event(ctypes.Structure):\n- _fields_ = (\n- ('wd', ctypes.c_int32),\n- ('mask', ctypes.c_uint32),\n- ('cookie', ctypes.c_uint32),\n- ('len', ctypes.c_uint32),\n- )\n+from .bus import Bus, BusError, BusMessage\n+from .bustypes import BusType, JSONEncoder, Variant\n+from .event import Event, EventLoopPolicy, run_async\n+from .pathwatch import Handle, PathWatch\n \n- @property\n- def name(self) -> Optional[bytes]:\n- if self.len == 0:\n- return None\n+__all__ = [\n+ \"Bus\",\n+ \"BusError\",\n+ \"BusMessage\",\n+ \"BusType\",\n+ \"Event\",\n+ \"EventLoopPolicy\",\n+ \"Handle\",\n+ \"JSONEncoder\",\n+ \"PathWatch\",\n+ \"Variant\",\n+ \"run_async\",\n+]\n+''',\n+ 'cockpit/_vendor/systemd_ctypes/introspection.py': br'''# systemd_ctypes\n+#\n+# Copyright (C) 2022 Allison Karlitskaya \n+#\n+# This program is free software: you can redistribute it and/or modify\n+# it under the terms of the GNU General Public License as published by\n+# the Free Software Foundation, either version 3 of the License, or\n+# (at your option) any later version.\n+#\n+# This program is distributed in the hope that it will be useful,\n+# but WITHOUT ANY WARRANTY; without even the implied warranty of\n+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n+# GNU General Public License for more details.\n+#\n+# You should have received a copy of the GNU General Public License\n+# along with this program. If not, see .\n \n- class event_with_name(ctypes.Structure):\n- _fields_ = (*inotify_event._fields_, ('name', ctypes.c_char * self.len))\n+import xml.etree.ElementTree as ET\n \n- name = ctypes.cast(ctypes.addressof(self), ctypes.POINTER(event_with_name)).contents.name\n- assert isinstance(name, bytes)\n- return name\n \n+def parse_method(method):\n+ return {\n+ \"in\": [tag.attrib['type'] for tag in method.findall(\"arg\") if tag.get('direction', 'in') == 'in'],\n+ \"out\": [tag.attrib['type'] for tag in method.findall(\"arg[@direction='out']\")]\n+ }\n \n-class Event(IntFlag):\n- ACCESS = auto()\n- MODIFY = auto()\n- ATTRIB = auto()\n- CLOSE_WRITE = auto()\n- CLOSE_NOWRITE = auto()\n- OPEN = auto()\n- MOVED_FROM = auto()\n- MOVED_TO = auto()\n- CREATE = auto()\n- DELETE = auto()\n- DELETE_SELF = auto()\n- MOVE_SELF = auto()\n \n- UNMOUNT = 1 << 13\n- Q_OVERFLOW = auto()\n- IGNORED = auto()\n+def parse_property(prop):\n+ return {\n+ \"flags\": 'w' if prop.attrib.get('access') == 'write' else 'r',\n+ \"type\": prop.attrib['type']\n+ }\n \n- ONLYDIR = 1 << 24\n- DONT_FOLLOW = auto()\n- EXCL_UNLINK = auto()\n \n- MASK_CREATE = 1 << 28\n- MASK_ADD = auto()\n- ISDIR = auto()\n- ONESHOT = auto()\n+def parse_signal(signal):\n+ return {\"in\": [tag.attrib['type'] for tag in signal.findall(\"arg\")]}\n \n- CLOSE = CLOSE_WRITE | CLOSE_NOWRITE\n- MOVE = MOVED_FROM | MOVED_TO\n- CHANGED = (MODIFY | ATTRIB | CLOSE_WRITE | MOVE |\n- CREATE | DELETE | DELETE_SELF | MOVE_SELF)\n+\n+def parse_interface(interface):\n+ return {\n+ \"methods\": {tag.attrib['name']: parse_method(tag) for tag in interface.findall('method')},\n+ \"properties\": {tag.attrib['name']: parse_property(tag) for tag in interface.findall('property')},\n+ \"signals\": {tag.attrib['name']: parse_signal(tag) for tag in interface.findall('signal')}\n+ }\n+\n+\n+def parse_xml(xml):\n+ et = ET.fromstring(xml)\n+ return {tag.attrib['name']: parse_interface(tag) for tag in et.findall('interface')}\n+\n+\n+# Pretend like this is a little bit functional\n+def element(tag, children=(), **kwargs):\n+ tag = ET.Element(tag, kwargs)\n+ tag.extend(children)\n+ return tag\n+\n+\n+def method_to_xml(name, method_info):\n+ return element('method', name=name,\n+ children=[\n+ element('arg', type=arg_type, direction=direction)\n+ for direction in ['in', 'out']\n+ for arg_type in method_info[direction]\n+ ])\n+\n+\n+def property_to_xml(name, property_info):\n+ return element('property', name=name,\n+ access='write' if property_info['flags'] == 'w' else 'read',\n+ type=property_info['type'])\n+\n+\n+def signal_to_xml(name, signal_info):\n+ return element('signal', name=name,\n+ children=[\n+ element('arg', type=arg_type) for arg_type in signal_info['in']\n+ ])\n+\n+\n+def interface_to_xml(name, interface_info):\n+ return element('interface', name=name,\n+ children=[\n+ *(method_to_xml(name, info) for name, info in interface_info['methods'].items()),\n+ *(property_to_xml(name, info) for name, info in interface_info['properties'].items()),\n+ *(signal_to_xml(name, info) for name, info in interface_info['signals'].items()),\n+ ])\n+\n+\n+def to_xml(interfaces):\n+ node = element('node', children=(interface_to_xml(name, members) for name, members in interfaces.items()))\n+ return ET.tostring(node, encoding='unicode')\n ''',\n 'cockpit/_vendor/systemd_ctypes/libsystemd.py': r'''# systemd_ctypes\n #\n # Copyright (C) 2022 Allison Karlitskaya \n #\n # This program is free software: you can redistribute it and/or modify\n # it under the terms of the GNU General Public License as published by\n@@ -9374,571 +9160,15 @@\n sd_bus_message,\n sd_bus_slot,\n sd_event,\n sd_event_source,\n }:\n cls._install_cfuncs(libsystemd)\n '''.encode('utf-8'),\n- 'cockpit/_vendor/systemd_ctypes/pathwatch.py': br'''# systemd_ctypes\n-#\n-# Copyright (C) 2022 Allison Karlitskaya \n-#\n-# This program is free software: you can redistribute it and/or modify\n-# it under the terms of the GNU General Public License as published by\n-# the Free Software Foundation, either version 3 of the License, or\n-# (at your option) any later version.\n-#\n-# This program is distributed in the hope that it will be useful,\n-# but WITHOUT ANY WARRANTY; without even the implied warranty of\n-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n-# GNU General Public License for more details.\n-#\n-# You should have received a copy of the GNU General Public License\n-# along with this program. If not, see .\n-\n-import errno\n-import logging\n-import os\n-import stat\n-from typing import Any, List, Optional\n-\n-from .event import Event\n-from .inotify import Event as IN\n-\n-logger = logging.getLogger(__name__)\n-\n-\n-# inotify hard facts:\n-#\n-# DELETE_SELF doesn't get called until all references to an inode are gone\n-# - including open fds\n-# - including on directories\n-#\n-# ATTRIB gets called when unlinking files (because the link count changes) but\n-# not on directories. When unlinking an open directory, no events at all\n-# happen on the directory. ATTRIB also collects child events, which means we\n-# get a lot of unwanted noise.\n-#\n-# There's nothing like UNLINK_SELF, unfortunately.\n-#\n-# Even if it was possible to take this approach, it might not work: after\n-# you've opened the fd, it might get deleted before you can establish the watch\n-# on it.\n-#\n-# Additionally, systemd makes it impossible to register those events on\n-# symlinks (because it removes IN_DONT_FOLLOW in order to watch via\n-# /proc/self/fd).\n-#\n-# For all of these reasons, unfortunately, the best way seems to be to watch\n-# for CREATE|DELETE|MOVE events on each intermediate directory.\n-#\n-# Unfortunately there is no way to filter to only the name we're interested in,\n-# so we're gonna get a lot of unnecessary wakeups.\n-#\n-# Also: due to the above-mentioned race about watching after opening the fd,\n-# let's just always watch for both create and delete events *before* trying to\n-# open the fd. We could try to reduce the mask after the fact, but meh...\n-#\n-# We use a WatchInvalidator utility class to fill the role of \"Tell me when an\n-# event happened on this (directory) fd which impacted the name file\". We\n-# build a series of these when setting up a watch in order to find out if any\n-# part of the path leading to the monitored file changed.\n-\n-\n-class Handle(int):\n- \"\"\"An integer subclass that makes it easier to work with file descriptors\"\"\"\n-\n- def __new__(cls, fd: int = -1) -> 'Handle':\n- return super(Handle, cls).__new__(cls, fd)\n-\n- # separate __init__() to set _needs_close mostly to keep pylint quiet\n- def __init__(self, fd: int = -1):\n- super().__init__()\n- self._needs_close = fd != -1\n-\n- def __bool__(self) -> bool:\n- return self != -1\n-\n- def close(self) -> None:\n- if self._needs_close:\n- self._needs_close = False\n- os.close(self)\n-\n- def __eq__(self, value: object) -> bool:\n- if int.__eq__(self, value): # also handles both == -1\n- return True\n-\n- if not isinstance(value, int): # other object is not an int\n- return False\n-\n- if not self or not value: # when only one == -1\n- return False\n-\n- return os.path.sameopenfile(self, value)\n-\n- def __del__(self) -> None:\n- if self._needs_close:\n- self.close()\n-\n- def __enter__(self) -> 'Handle':\n- return self\n-\n- def __exit__(self, _type: type, _value: object, _traceback: object) -> None:\n- self.close()\n-\n- @classmethod\n- def open(cls, *args: Any, **kwargs: Any) -> 'Handle':\n- return cls(os.open(*args, **kwargs))\n-\n- def steal(self) -> 'Handle':\n- self._needs_close = False\n- return self.__class__(int(self))\n-\n-\n-class WatchInvalidator:\n- _name: bytes\n- _source: Optional[Event.Source]\n- _watch: Optional['PathWatch']\n-\n- def event(self, mask: IN, _cookie: int, name: Optional[bytes]) -> None:\n- logger.debug('invalidator event %s %s', mask, name)\n- if self._watch is not None:\n- # If this node itself disappeared, that's definitely an\n- # invalidation. Otherwise, the name needs to match.\n- if IN.IGNORED in mask or self._name == name:\n- logger.debug('Invalidating!')\n- self._watch.invalidate()\n-\n- def __init__(self, watch: 'PathWatch', event: Event, dirfd: int, name: str):\n- self._watch = watch\n- self._name = name.encode('utf-8')\n-\n- # establishing invalidation watches is best-effort and can fail for a\n- # number of reasons, including search (+x) but not read (+r) permission\n- # on a particular path component, or exceeding limits on watches\n- try:\n- mask = IN.CREATE | IN.DELETE | IN.MOVE | IN.DELETE_SELF | IN.IGNORED\n- self._source = event.add_inotify_fd(dirfd, mask, self.event)\n- except OSError:\n- self._source = None\n-\n- def close(self) -> None:\n- # This is a little bit tricky: systemd doesn't have a specific close\n- # API outside of unref, so let's make it as explicit as possible.\n- self._watch = None\n- self._source = None\n-\n-\n-class PathStack(List[str]):\n- def add_path(self, pathname: str) -> None:\n- # TO DO: consider doing something reasonable with trailing slashes\n- # this is a stack, popped from the end: push components in reverse\n- self.extend(item for item in reversed(pathname.split('/')) if item)\n- if pathname.startswith('/'):\n- self.append('/')\n-\n- def __init__(self, path: str):\n- super().__init__()\n- self.add_path(path)\n-\n-\n-class Listener:\n- def do_inotify_event(self, mask: IN, cookie: int, name: Optional[bytes]) -> None:\n- raise NotImplementedError\n-\n- def do_identity_changed(self, fd: Optional[Handle], errno: Optional[int]) -> None:\n- raise NotImplementedError\n-\n-\n-class PathWatch:\n- _event: Event\n- _listener: Listener\n- _path: str\n- _invalidators: List[WatchInvalidator]\n- _errno: Optional[int]\n- _source: Optional[Event.Source]\n- _tag: Optional[None]\n- _fd: Handle\n-\n- def __init__(self, path: str, listener: Listener, event: Optional[Event] = None):\n- self._event = event or Event.default()\n- self._path = path\n- self._listener = listener\n-\n- self._invalidators = []\n- self._errno = None\n- self._source = None\n- self._tag = None\n- self._fd = Handle()\n-\n- self.invalidate()\n-\n- def got_event(self, mask: IN, cookie: int, name: Optional[bytes]) -> None:\n- logger.debug('target event %s: %s %s %s', self._path, mask, cookie, name)\n- self._listener.do_inotify_event(mask, cookie, name)\n-\n- def invalidate(self) -> None:\n- for invalidator in self._invalidators:\n- invalidator.close()\n- self._invalidators = []\n-\n- try:\n- fd = self.walk()\n- except OSError as error:\n- logger.debug('walk ended in error %d', error.errno)\n-\n- if self._source or self._fd or self._errno != error.errno:\n- logger.debug('Ending existing watches.')\n- self._source = None\n- self._fd.close()\n- self._fd = Handle()\n- self._errno = error.errno\n-\n- logger.debug('Notifying of new error state %d', self._errno)\n- self._listener.do_identity_changed(None, self._errno)\n-\n- return\n-\n- with fd:\n- logger.debug('walk successful. Got fd %d', fd)\n- if fd == self._fd:\n- logger.debug('fd seems to refer to same file. Doing nothing.')\n- return\n-\n- logger.debug('This file is new for us. Removing old watch.')\n- self._source = None\n- self._fd.close()\n- self._fd = fd.steal()\n-\n- try:\n- logger.debug('Establishing a new watch.')\n- self._source = self._event.add_inotify_fd(self._fd, IN.CHANGED, self.got_event)\n- logger.debug('Watching successfully. Notifying of new identity.')\n- self._listener.do_identity_changed(self._fd, None)\n- except OSError as error:\n- logger.debug('Watching failed (%d). Notifying of new identity.', error.errno)\n- self._listener.do_identity_changed(self._fd, error.errno)\n-\n- def walk(self) -> Handle:\n- remaining_symlink_lookups = 40\n- remaining_components = PathStack(self._path)\n- dirfd = Handle()\n-\n- try:\n- logger.debug('Starting path walk')\n-\n- while remaining_components:\n- logger.debug('r=%s dfd=%s', remaining_components, dirfd)\n-\n- name = remaining_components.pop()\n-\n- if dirfd and name != '/':\n- self._invalidators.append(WatchInvalidator(self, self._event, dirfd, name))\n-\n- with Handle.open(name, os.O_PATH | os.O_NOFOLLOW | os.O_CLOEXEC, dir_fd=dirfd) as fd:\n- mode = os.fstat(fd).st_mode\n-\n- if stat.S_ISLNK(mode):\n- if remaining_symlink_lookups == 0:\n- raise OSError(errno.ELOOP, os.strerror(errno.ELOOP))\n- remaining_symlink_lookups -= 1\n- linkpath = os.readlink('', dir_fd=fd)\n- logger.debug('%s is a symlink. adding %s to components', name, linkpath)\n- remaining_components.add_path(linkpath)\n-\n- else:\n- dirfd.close()\n- dirfd = fd.steal()\n-\n- return dirfd.steal()\n-\n- finally:\n- dirfd.close()\n-\n- def close(self) -> None:\n- for invalidator in self._invalidators:\n- invalidator.close()\n- self._invalidators = []\n- self._source = None\n- self._fd.close()\n-''',\n- 'cockpit/_vendor/systemd_ctypes/librarywrapper.py': br'''# systemd_ctypes\n-#\n-# Copyright (C) 2022 Allison Karlitskaya \n-#\n-# This program is free software: you can redistribute it and/or modify\n-# it under the terms of the GNU General Public License as published by\n-# the Free Software Foundation, either version 3 of the License, or\n-# (at your option) any later version.\n-#\n-# This program is distributed in the hope that it will be useful,\n-# but WITHOUT ANY WARRANTY; without even the implied warranty of\n-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n-# GNU General Public License for more details.\n-#\n-# You should have received a copy of the GNU General Public License\n-# along with this program. If not, see .\n-\n-import ctypes\n-import inspect\n-import logging\n-import os\n-import sys\n-import types\n-from typing import (\n- Any,\n- Callable,\n- Dict,\n- Generic,\n- NewType,\n- NoReturn,\n- Optional,\n- Tuple,\n- Type,\n- TypeVar,\n- Union,\n-)\n-\n-from . import typing\n-\n-# First in 3.10, and conditional import gives type errors\n-NoneType = type(None)\n-\n-logger = logging.getLogger(__name__)\n-\n-if typing.TYPE_CHECKING:\n- CType = TypeVar(\"CType\", bound=ctypes._CData)\n- Callback = ctypes._FuncPointer\n-else:\n- CType = TypeVar(\"CType\")\n- Callback = ctypes.c_void_p\n-\n-\n-if typing.TYPE_CHECKING:\n- class Reference(Generic[CType], ctypes._Pointer[CType]):\n- pass\n-\n- def byref(x: CType) -> Reference[CType]:\n- raise NotImplementedError\n-else:\n- class Reference(Generic[CType]):\n- pass\n-\n- byref = ctypes.byref\n-\n-\n-UserData = Optional[ctypes.c_void_p]\n-\n-\n-class negative_errno(ctypes.c_int):\n- def errcheck(self, func: Callable[..., object], _args: Tuple[object, ...]) -> int:\n- result = self.value\n- if result < 0:\n- raise OSError(-result, f\"{func.__name__}: {os.strerror(-result)}\")\n- return result\n-\n-\n-class utf8(ctypes.c_char_p):\n- def errcheck(self, func: Callable[..., object], _args: Tuple[object, ...]) -> str:\n- assert self.value is not None\n- return self.value.decode()\n-\n- @classmethod\n- def from_param(cls, value: str) -> 'utf8':\n- return cls(value.encode())\n-\n-\n-class utf8_or_null(ctypes.c_char_p):\n- def errcheck(self,\n- func: Callable[..., object],\n- _args: Tuple[object, ...]) -> Optional[str]:\n- return self.value.decode() if self.value is not None else None\n-\n- @classmethod\n- def from_param(cls, value: Optional[str]) -> 'utf8_or_null':\n- return cls(value.encode() if value is not None else None)\n-\n-\n-class boolint(ctypes.c_int):\n- def errcheck(self, func: Callable[..., object], _args: Tuple[object, ...]) -> bool:\n- return bool(self.value)\n-\n-\n-WeakReference = NewType(\"WeakReference\", int)\n-Errno = typing.Annotated[NoReturn, \"errno\"]\n-\n-\n-type_map = {\n- Union[None, Errno]: negative_errno, # technically returns int\n- Union[bool, Errno]: negative_errno, # technically returns int\n- Union[int, Errno]: negative_errno,\n- bool: boolint,\n- Optional[str]: utf8_or_null,\n- str: utf8,\n- int: ctypes.c_int,\n- WeakReference: ctypes.c_void_p\n-}\n-\n-\n-def map_type(annotation: Any, global_vars: Dict[str, object]) -> Any:\n- try:\n- return type_map[annotation]\n- except KeyError:\n- pass # ... and try more cases below\n-\n- if isinstance(annotation, typing.ForwardRef):\n- annotation = annotation.__forward_arg__\n-\n- if isinstance(annotation, str):\n- annotation = global_vars[annotation]\n-\n- origin = typing.get_origin(annotation)\n- args = typing.get_args(annotation)\n-\n- if origin is Reference:\n- return ctypes.POINTER(map_type(args[0], global_vars))\n-\n- elif origin is Union and NoneType in args:\n- # the C pointer types are already nullable\n- other_arg, = set(args) - {NoneType}\n- return map_type(other_arg, global_vars)\n-\n- elif origin is typing.Annotated:\n- return args[1]\n-\n- else:\n- assert origin is None, origin\n- return annotation\n-\n-\n-class ReferenceType(ctypes.c_void_p):\n- @classmethod\n- def _install_cfuncs(cls, cdll: ctypes.CDLL) -> None:\n- logger.debug('Installing stubs for %s:', cls)\n- stubs = tuple(cls.__dict__.items())\n- for name, stub in stubs:\n- if name.startswith(\"__\"):\n- continue\n- cls._wrap(cdll, stub)\n-\n- cls._wrap(cdll, cls._ref)\n- cls._wrap(cdll, cls._unref)\n-\n- @classmethod\n- def _wrap(cls, cdll: ctypes.CDLL, stub: object) -> None:\n- stub_type = type(stub)\n- if isinstance(stub, staticmethod):\n- # In older Python versions, staticmethod() isn't considered\n- # callable, doesn't have a name, and can't be introspected with\n- # inspect.signature(). Unwrap it.\n- stub = stub.__func__\n- assert isinstance(stub, types.FunctionType)\n- name = stub.__name__\n- signature = inspect.signature(stub)\n- stub_globals = sys.modules.get(cls.__module__).__dict__\n-\n- func = cdll[f'{cls.__name__}_{name.lstrip(\"_\")}']\n- func.argtypes = tuple(\n- map_type(parameter.annotation, stub_globals)\n- for parameter in signature.parameters.values()\n- )\n- func.restype = map_type(signature.return_annotation, stub_globals)\n- errcheck = getattr(func.restype, 'errcheck', None)\n- if errcheck is not None:\n- func.errcheck = errcheck\n-\n- logger.debug(' create wrapper %s.%s%s', cls.__name__, name, signature)\n- logger.debug(' args %s res %s', func.argtypes, func.restype)\n-\n- # ctypes function pointer objects don't implement the usual function\n- # descriptor logic, which means they won't bind as methods. For static\n- # methods, that's good, but for instance methods, we add a wrapper as\n- # the easiest and most performant way to get the binding behaviour.\n- if stub_type is not staticmethod:\n- setattr(cls, name, lambda *args: func(*args))\n- else:\n- setattr(cls, name, func)\n-\n- def _unref(self: 'ReferenceType') -> None:\n- ...\n-\n- def _ref(self: 'ReferenceType') -> None:\n- ...\n-\n- T = TypeVar(\"T\", bound='ReferenceType')\n-\n- @classmethod\n- def ref(cls: Type[T], origin: WeakReference) -> T:\n- self = cls(origin)\n- self._ref()\n- return self\n-\n- def __del__(self) -> None:\n- if self.value is not None:\n- self._unref()\n-''',\n- 'cockpit/_vendor/systemd_ctypes/typing.py': br'''import typing\n-from typing import TYPE_CHECKING\n-\n-# The goal here is to continue to work on Python 3.6 while pretending to have\n-# access to some modern typing features. The shims provided here are only\n-# enough for what we need for systemd_ctypes to work at runtime.\n-\n-\n-if TYPE_CHECKING:\n- # See https://github.com/python/mypy/issues/1153 for why we do this separately\n- from typing import Annotated, ForwardRef, TypeGuard, get_args, get_origin\n-\n-else:\n- # typing.get_args() and .get_origin() appeared in Python 3.8 but Annotated\n- # arrived in 3.9. Unfortunately, it's difficult to implement a mocked up\n- # version of Annotated which works with the real typing.get_args() and\n- # .get_origin() in Python 3.8, so we use our own versions there as well.\n- try:\n- from typing import Annotated, get_args, get_origin\n- except ImportError:\n- class AnnotatedMeta(type):\n- def __getitem__(cls, params):\n- class AnnotatedType:\n- __origin__ = Annotated\n- __args__ = params\n- return AnnotatedType\n-\n- class Annotated(metaclass=AnnotatedMeta):\n- pass\n-\n- def get_args(annotation: typing.Any) -> typing.Tuple[typing.Any]:\n- return getattr(annotation, '__args__', ())\n-\n- def get_origin(annotation: typing.Any) -> typing.Any:\n- return getattr(annotation, '__origin__', None)\n-\n- try:\n- from typing import ForwardRef\n- except ImportError:\n- from typing import _ForwardRef as ForwardRef\n-\n- try:\n- from typing import TypeGuard\n- except ImportError:\n- T = typing.TypeVar('T')\n-\n- class TypeGuard(typing.Generic[T]):\n- pass\n-\n-\n-__all__ = (\n- 'Annotated',\n- 'ForwardRef',\n- 'TypeGuard',\n- 'get_args',\n- 'get_origin',\n- 'TYPE_CHECKING',\n-)\n-''',\n+ 'cockpit/_vendor/systemd_ctypes/py.typed': br'''''',\n 'cockpit/_vendor/systemd_ctypes/bus.py': br'''# systemd_ctypes\n #\n # Copyright (C) 2022 Allison Karlitskaya \n #\n # This program is free software: you can redistribute it and/or modify\n # it under the terms of the GNU General Public License as published by\n # the Free Software Foundation, either version 3 of the License, or\n@@ -10793,608 +10023,721 @@\n try:\n method = self._find_member(interface, 'methods', name)\n assert isinstance(method, Interface.Method)\n return method._invoke(self, message)\n except Object.Method.Unhandled:\n return False\n ''',\n- 'cockpit/_vendor/systemd_ctypes/py.typed': br'''''',\n- 'cockpit/_vendor/systemd_ctypes/__init__.py': br'''# systemd_ctypes\n+ 'cockpit/_vendor/ferny/transport.py': br'''# ferny - asyncio SSH client library, using ssh(1)\n #\n-# Copyright (C) 2022 Allison Karlitskaya \n+# Copyright (C) 2023 Allison Karlitskaya \n #\n # This program is free software: you can redistribute it and/or modify\n # it under the terms of the GNU General Public License as published by\n # the Free Software Foundation, either version 3 of the License, or\n # (at your option) any later version.\n #\n # This program is distributed in the hope that it will be useful,\n # but WITHOUT ANY WARRANTY; without even the implied warranty of\n # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n # GNU General Public License for more details.\n #\n # You should have received a copy of the GNU General Public License\n # along with this program. If not, see .\n \n-\"\"\"systemd_ctypes\"\"\"\n+import asyncio\n+import contextlib\n+import logging\n+import typing\n+from typing import Any, Callable, Iterable, Sequence, TypeVar\n \n-__version__ = \"0\"\n+from .interaction_agent import InteractionAgent, InteractionHandler, get_running_loop\n+from .ssh_errors import get_exception_for_ssh_stderr\n \n-from .bus import Bus, BusError, BusMessage\n-from .bustypes import BusType, JSONEncoder, Variant\n-from .event import Event, EventLoopPolicy, run_async\n-from .pathwatch import Handle, PathWatch\n+logger = logging.getLogger(__name__)\n \n-__all__ = [\n- \"Bus\",\n- \"BusError\",\n- \"BusMessage\",\n- \"BusType\",\n- \"Event\",\n- \"EventLoopPolicy\",\n- \"Handle\",\n- \"JSONEncoder\",\n- \"PathWatch\",\n- \"Variant\",\n- \"run_async\",\n-]\n-''',\n- 'cockpit/_vendor/systemd_ctypes/bustypes.py': br'''# systemd_ctypes\n-#\n-# Copyright (C) 2023 Allison Karlitskaya \n-#\n-# This program is free software: you can redistribute it and/or modify\n-# it under the terms of the GNU General Public License as published by\n-# the Free Software Foundation, either version 3 of the License, or\n-# (at your option) any later version.\n-#\n-# This program is distributed in the hope that it will be useful,\n-# but WITHOUT ANY WARRANTY; without even the implied warranty of\n-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n-# GNU General Public License for more details.\n-#\n-# You should have received a copy of the GNU General Public License\n-# along with this program. If not, see .\n+P = TypeVar('P', bound=asyncio.Protocol)\n \n \n-# This file is responsible for creating functions to (de)serialize Python\n-# objects into and out of BusMessage objects.\n-#\n-# Each Type corresponds to a (possibly complex) D-Bus type. It has a .reader\n-# and a .writer property. The readers take a message and deserialize a single\n-# value from it, returning the value:\n-#\n-# def reader(message: BusMessage) -> object:\n-#\n-# The writers take a message and a value, and append the value to the message.\n-#\n-# def writer(message: BusMessage, value: object) -> None:\n-#\n-# The necessary information for the specific type of object to be handled is\n-# part of the function. No additional information needs to be provided.\n+class SubprocessError(Exception):\n+ returncode: int\n+ stderr: str\n \n-import binascii\n-import ctypes\n-import functools\n-import inspect\n-import json\n-import re\n-from enum import Enum\n-from typing import Any, Callable, ClassVar, Dict, Iterable, List, Optional, Sequence, Tuple, TypeVar, Union\n+ def __init__(self, returncode: int, stderr: str) -> None:\n+ super().__init__(returncode, stderr)\n+ self.returncode = returncode\n+ self.stderr = stderr\n \n-from . import libsystemd, typing\n-from .typing import Annotated, TypeGuard\n \n-_object_path_re = re.compile(r'/|(/[A-Za-z0-9_]+)+')\n+class FernyTransport(asyncio.Transport, asyncio.SubprocessProtocol):\n+ _agent: InteractionAgent\n+ _exec_task: 'asyncio.Task[tuple[asyncio.SubprocessTransport, FernyTransport]]'\n+ _is_ssh: bool\n+ _protocol: asyncio.Protocol\n+ _protocol_disconnected: bool = False\n \n+ # These get initialized in connection_made() and once set, never get unset.\n+ _subprocess_transport: 'asyncio.SubprocessTransport | None' = None\n+ _stdin_transport: 'asyncio.WriteTransport | None' = None\n+ _stdout_transport: 'asyncio.ReadTransport | None' = None\n \n-def is_object_path(candidate: str) -> TypeGuard['BusType.objectpath']:\n- return _object_path_re.fullmatch(candidate) is not None\n+ # We record events that might build towards a connection termination here\n+ # and consider them from _consider_disconnect() in order to try to get the\n+ # best possible Exception for the protocol, rather than just taking the\n+ # first one (which is likely to be somewhat random).\n+ _exception: 'Exception | None' = None\n+ _stderr_output: 'str | None' = None\n+ _returncode: 'int | None' = None\n+ _transport_disconnected: bool = False\n+ _closed: bool = False\n \n+ @classmethod\n+ def spawn(\n+ cls: 'type[typing.Self]',\n+ protocol_factory: Callable[[], P],\n+ args: Sequence[str],\n+ loop: 'asyncio.AbstractEventLoop | None' = None,\n+ interaction_handlers: Sequence[InteractionHandler] = (),\n+ is_ssh: bool = True,\n+ **kwargs: Any\n+ ) -> 'tuple[typing.Self, P]':\n+ \"\"\"Connects a FernyTransport to a protocol, using the given command.\n \n-def is_signature(candidate: str) -> TypeGuard['BusType.signature']:\n- offset = 0\n+ This spawns an external command and connects the stdin and stdout of\n+ the command to the protocol returned by the factory.\n \n- def maybe_pop(acceptable: str) -> Optional[str]:\n- nonlocal offset\n- char = candidate[offset]\n- if char in acceptable:\n- offset += 1\n- return char\n- else:\n- return None\n+ An instance of ferny.InteractionAgent is created and attached to the\n+ stderr of the spawned process, using the provided handlers. It is the\n+ responsibility of the caller to ensure that:\n+ - a `ferny-askpass` client program is installed somewhere; and\n+ - any relevant command-line arguments or environment variables are\n+ passed correctly to the program to be spawned\n \n- def pop(acceptable: str) -> str:\n- char = maybe_pop(acceptable)\n- assert char is not None\n- return char\n+ This function returns immediately and never raises exceptions, assuming\n+ all preconditions are met.\n \n- def find_next() -> None:\n- first = pop('ybnqiuxtsogdva(') # valid first characters\n- if first == 'a':\n- if maybe_pop('{'): # dict\n- pop('ybnqiuxtsogd') # key\n- find_next() # value\n- pop('}')\n- else: # array\n- find_next() # item\n- elif first == '(': # structure\n- find_next() # at least one item\n- while not maybe_pop(')'):\n- find_next() # and possibly more\n+ If spawning the process fails then connection_lost() will be\n+ called with the relevant OSError, even before connection_made() is\n+ called. This is somewhat non-standard behaviour, but is the easiest\n+ way to report these errors without making this function async.\n \n- try:\n- while offset < len(candidate):\n- find_next()\n- return True\n- except (AssertionError, IndexError):\n- return False\n+ Once the process is successfully executed, connection_made() will be\n+ called and the transport can be used as normal. connection_lost() will\n+ be called if the process exits or another error occurs.\n \n+ The return value of this function is the transport, but it exists in a\n+ semi-initialized state. You can call .close() on it, but nothing else.\n+ Once .connection_made() is called, you can call all the other\n+ functions.\n \n-def yield_base_helpers() -> Iterable[Tuple[str, object]]:\n- for method in ['enter_container', 'exit_container', 'open_container', 'close_container',\n- 'append_basic', 'read_basic', 'append_array', 'read_array']:\n- yield method, libsystemd.libsystemd[f'sd_bus_message_{method}']\n+ After you call this function, `.connection_lost()` will be called on\n+ your Protocol, exactly once, no matter what. Until that happens, you\n+ are responsible for holding a reference to the returned transport.\n \n- for name in ['size_t', 'char_p']:\n- instance = getattr(ctypes, f'c_{name}')()\n- yield f'{name}', instance\n- yield f'{name}_ref', ctypes.byref(instance)\n- yield f'{name}_setter', instance.__class__.value.__set__\n+ :param args: the full argv of the command to spawn\n+ :param loop: the event loop to use. If none is provided, we use the\n+ one which is (read: must be) currently running.\n+ :param interaction_handlers: the handlers passed to the\n+ InteractionAgent\n+ :param is_ssh: whether we should attempt to interpret stderr as ssh\n+ error messages\n+ :param kwargs: anything else is passed through to `subprocess_exec()`\n+ :returns: the usual `(Transport, Protocol)` pair\n+ \"\"\"\n+ logger.debug('spawn(%r, %r, %r)', cls, protocol_factory, args)\n \n- for char in 'aervy':\n- yield char, ctypes.c_char(ord(char))\n+ protocol = protocol_factory()\n+ self = cls(protocol)\n+ self._is_ssh = is_ssh\n \n- # https://docs.python.org/3/c-api/unicode.html#c.PyUnicode_FromString\n- to_bytes = ctypes.pythonapi.PyBytes_FromStringAndSize\n- to_bytes.restype = ctypes.py_object\n- yield 'to_bytes', to_bytes\n+ if loop is None:\n+ loop = get_running_loop()\n \n+ self._agent = InteractionAgent(interaction_handlers, loop, self._interaction_completed)\n+ kwargs.setdefault('stderr', self._agent.fileno())\n \n-_base_helpers = dict(yield_base_helpers())\n+ # As of Python 3.12 this isn't really asynchronous (since it uses the\n+ # subprocess module, which blocks while waiting for the exec() to\n+ # complete in the child), but we have to deal with the complication of\n+ # the async interface anyway. Since we, ourselves, want to export a\n+ # non-async interface, that means that we need a task here and a\n+ # bottom-half handler below.\n+ self._exec_task = loop.create_task(loop.subprocess_exec(lambda: self, *args, **kwargs))\n \n-T = TypeVar('T')\n+ def exec_completed(task: asyncio.Task) -> None:\n+ logger.debug('exec_completed(%r, %r)', self, task)\n+ assert task is self._exec_task\n+ try:\n+ transport, me = task.result()\n+ assert me is self\n+ logger.debug(' success.')\n+ except asyncio.CancelledError:\n+ return # in that case, do nothing\n+ except OSError as exc:\n+ logger.debug(' OSError %r', exc)\n+ self.close(exc)\n+ return\n \n+ # Our own .connection_made() handler should have gotten called by\n+ # now. Make sure everything got filled in properly.\n+ assert self._subprocess_transport is transport\n+ assert self._stdin_transport is not None\n+ assert self._stdout_transport is not None\n \n-def call_with_kwargs(func: Callable[..., T], kwargs: Dict[str, Any]) -> T:\n- parameters = set(inspect.signature(func).parameters)\n- return func(**{key: value for key, value in kwargs.items() if key in parameters})\n+ # Ask the InteractionAgent to start processing stderr.\n+ self._agent.start()\n \n+ self._exec_task.add_done_callback(exec_completed)\n \n-class Type:\n- _cache: ClassVar[Dict[Tuple[type, Tuple[object, ...]], 'Type']] = {}\n+ return self, protocol\n \n- __slots__ = 'typestring', 'bytes_typestring', 'writer', 'reader'\n- typestring: str\n- bytes_typestring: bytes\n- reader: Callable[[libsystemd.sd_bus_message], object]\n- writer: Callable[[libsystemd.sd_bus_message, object], None]\n+ def __init__(self, protocol: asyncio.Protocol) -> None:\n+ self._protocol = protocol\n \n- def __new__(cls, *args: Any) -> 'Type':\n- instance = Type._cache.get((cls, args))\n- if instance is None:\n- instance = object.__new__(cls)\n- Type._cache[(cls, args)] = instance\n- return instance\n+ def _consider_disconnect(self) -> None:\n+ logger.debug('_consider_disconnect(%r)', self)\n+ # We cannot disconnect as long as any of these three things are happening\n+ if not self._exec_task.done():\n+ logger.debug(' exec_task still running %r', self._exec_task)\n+ return\n \n- def __init__(self, typestring: str, **kwargs: Any):\n- self.typestring = typestring\n- self.bytes_typestring = typestring.encode('ascii')\n+ if self._subprocess_transport is not None and not self._transport_disconnected:\n+ logger.debug(' transport still connected %r', self._subprocess_transport)\n+ return\n \n- kwargs = dict(_base_helpers, **kwargs)\n- self.writer = call_with_kwargs(self.get_writer, kwargs)\n- self.reader = call_with_kwargs(self.get_reader, kwargs)\n+ if self._stderr_output is None:\n+ logger.debug(' agent still running')\n+ return\n \n- def __repr__(self) -> str:\n- return f\"{self.__class__.__name__}('{self.typestring}')\"\n+ # All conditions for disconnection are satisfied.\n+ if self._protocol_disconnected:\n+ logger.debug(' already disconnected')\n+ return\n+ self._protocol_disconnected = True\n \n- def get_writer(self, **kwargs: object) -> Callable[[object, object], None]:\n- raise NotImplementedError\n+ # Now we just need to determine what we report to the protocol...\n+ if self._exception is not None:\n+ # If we got an exception reported, that's our reason for closing.\n+ logger.debug(' disconnect with exception %r', self._exception)\n+ self._protocol.connection_lost(self._exception)\n+ elif self._returncode == 0 or self._closed:\n+ # If we called close() or have a zero return status, that's a clean\n+ # exit, regardless of noise that might have landed in stderr.\n+ logger.debug(' clean disconnect')\n+ self._protocol.connection_lost(None)\n+ elif self._is_ssh and self._returncode == 255:\n+ # This is an error code due to an SSH failure. Try to interpret it.\n+ logger.debug(' disconnect with ssh error %r', self._stderr_output)\n+ self._protocol.connection_lost(get_exception_for_ssh_stderr(self._stderr_output))\n+ else:\n+ # Otherwise, report the stderr text and return code.\n+ logger.debug(' disconnect with exit code %r, stderr %r', self._returncode, self._stderr_output)\n+ # We surely have _returncode set here, since otherwise:\n+ # - exec_task failed with an exception (which we handle above); or\n+ # - we're still connected...\n+ assert self._returncode is not None\n+ self._protocol.connection_lost(SubprocessError(self._returncode, self._stderr_output))\n \n- def get_reader(self, **kwargs: object) -> Callable[[object], object]:\n- raise NotImplementedError\n+ def _interaction_completed(self, future: 'asyncio.Future[str]') -> None:\n+ logger.debug('_interaction_completed(%r, %r)', self, future)\n+ try:\n+ self._stderr_output = future.result()\n+ logger.debug(' stderr: %r', self._stderr_output)\n+ except Exception as exc:\n+ logger.debug(' exception: %r', exc)\n+ self._stderr_output = '' # we need to set this in order to complete\n+ self.close(exc)\n \n+ self._consider_disconnect()\n \n-class BasicType(Type):\n- __slots__ = ()\n+ # BaseProtocol implementation\n+ def connection_made(self, transport: asyncio.BaseTransport) -> None:\n+ logger.debug('connection_made(%r, %r)', self, transport)\n+ assert isinstance(transport, asyncio.SubprocessTransport)\n+ self._subprocess_transport = transport\n \n- def __init__(self, typestring: str, ctype, get_wrapper=None, **kwargs):\n- variable = ctype() # NB: not thread-safe\n- super().__init__(typestring, ctype=ctype, type_constant=ctypes.c_char(ord(typestring)),\n- getter=get_wrapper or ctype.value.__get__, setter=ctype.value.__set__,\n- variable=variable, reference=ctypes.byref(variable), **kwargs)\n+ stdin_transport = transport.get_pipe_transport(0)\n+ assert isinstance(stdin_transport, asyncio.WriteTransport)\n+ self._stdin_transport = stdin_transport\n \n- def get_reader(self, read_basic, type_constant, variable, reference, getter):\n- def basic_reader(message: libsystemd.sd_bus_message) -> object:\n- if read_basic(message, type_constant, reference) <= 0:\n- raise StopIteration\n- return getter(variable)\n- return basic_reader\n+ stdout_transport = transport.get_pipe_transport(1)\n+ assert isinstance(stdout_transport, asyncio.ReadTransport)\n+ self._stdout_transport = stdout_transport\n \n+ stderr_transport = transport.get_pipe_transport(2)\n+ assert stderr_transport is None\n \n-class FixedType(BasicType):\n- __slots__ = ()\n+ logger.debug('calling connection_made(%r, %r)', self, self._protocol)\n+ self._protocol.connection_made(self)\n \n- def get_writer(self, append_basic, type_constant, variable, reference, setter, getter):\n- def fixed_writer(message: libsystemd.sd_bus_message, value: object) -> None:\n- setter(variable, value)\n- if getter(variable) != value:\n- raise TypeError(f\"Cannot represent value {value} with type '{self.typestring}'\")\n- append_basic(message, type_constant, reference)\n- return fixed_writer\n+ def connection_lost(self, exc: 'Exception | None') -> None:\n+ logger.debug('connection_lost(%r, %r)', self, exc)\n+ if self._exception is None:\n+ self._exception = exc\n+ self._transport_disconnected = True\n+ self._consider_disconnect()\n \n+ # SubprocessProtocol implementation\n+ def pipe_data_received(self, fd: int, data: bytes) -> None:\n+ logger.debug('pipe_data_received(%r, %r, %r)', self, fd, len(data))\n+ assert fd == 1 # stderr is handled separately\n+ self._protocol.data_received(data)\n \n-class StringLikeType(BasicType):\n- __slots__ = ()\n+ def pipe_connection_lost(self, fd: int, exc: 'Exception | None') -> None:\n+ logger.debug('pipe_connection_lost(%r, %r, %r)', self, fd, exc)\n+ assert fd in (0, 1) # stderr is handled separately\n \n- @staticmethod\n- def get_guarded_conversion(typestring: str, guard: Callable[[str], bool]) -> Callable[[object], bytes]:\n- def convert(candidate: object) -> bytes:\n- if not isinstance(candidate, str):\n- raise TypeError(f\"'{typestring}' encodes 'str', not '{candidate.__class__.__name__}'\")\n- if not guard(candidate):\n- raise ValueError(f\"Invalid value provided for type '{typestring}'\")\n- return str.encode(candidate)\n- return convert\n+ # We treat this as a clean close\n+ if isinstance(exc, BrokenPipeError):\n+ exc = None\n \n- def __init__(self, typestring: str, guard: Optional[Callable[[str], bool]] = None):\n- # https://docs.python.org/3/c-api/unicode.html#c.PyUnicode_FromString\n- to_unicode = ctypes.pythonapi.PyUnicode_FromString\n- to_unicode.restype = ctypes.py_object\n+ # Record serious errors to propagate them to the protocol\n+ # If this is a clean exit on stdout, report an EOF\n+ if exc is not None:\n+ self.close(exc)\n+ elif fd == 1 and not self._closed:\n+ if not self._protocol.eof_received():\n+ self.close()\n \n- if guard is not None:\n- convert = StringLikeType.get_guarded_conversion(typestring, guard)\n- else:\n- convert = str.encode # type: ignore[assignment] # can throw TypeError on call\n+ def process_exited(self) -> None:\n+ logger.debug('process_exited(%r)', self)\n+ assert self._subprocess_transport is not None\n+ self._returncode = self._subprocess_transport.get_returncode()\n+ logger.debug(' ._returncode = %r', self._returncode)\n+ self._agent.force_completion()\n \n- super().__init__(typestring, ctypes.c_char_p, to_unicode, convert=convert)\n+ def pause_writing(self) -> None:\n+ logger.debug('pause_writing(%r)', self)\n+ self._protocol.pause_writing()\n \n- def get_writer(self, append_basic, type_constant, convert):\n- def string_writer(message: libsystemd.sd_bus_message, value: object) -> None:\n- append_basic(message, type_constant, convert(value))\n- return string_writer\n+ def resume_writing(self) -> None:\n+ logger.debug('resume_writing(%r)', self)\n+ self._protocol.resume_writing()\n \n+ # Transport implementation. Most of this is straight delegation.\n+ def close(self, exc: 'Exception | None' = None) -> None:\n+ logger.debug('close(%r, %r)', self, exc)\n+ self._closed = True\n+ if self._exception is None:\n+ logger.debug(' setting exception %r', exc)\n+ self._exception = exc\n+ if not self._exec_task.done():\n+ logger.debug(' cancelling _exec_task')\n+ self._exec_task.cancel()\n+ if self._subprocess_transport is not None:\n+ logger.debug(' closing _subprocess_transport')\n+ # https://github.com/python/cpython/issues/112800\n+ with contextlib.suppress(PermissionError):\n+ self._subprocess_transport.close()\n+ self._agent.force_completion()\n \n-class BytestringType(Type):\n- __slots__ = ()\n+ def is_closing(self) -> bool:\n+ assert self._subprocess_transport is not None\n+ return self._subprocess_transport.is_closing()\n \n- def get_writer(self, append_array, y, size_t_setter, size_t):\n- def bytes_writer(message: libsystemd.sd_bus_message, value: object) -> None:\n- if not isinstance(value, bytes):\n- if isinstance(value, str):\n- try:\n- value = binascii.a2b_base64(value.encode('ascii')) # or decode base64\n- except binascii.Error as exc:\n- raise ValueError(\"'ay' cannot encode invalid base64 string\") from exc\n- elif isinstance(value, (memoryview, bytearray)):\n- value = bytes(value)\n- else:\n- raise TypeError(\"'ay' can only encode bytes-like or base64 string objects, \"\n- f\"not '{value.__class__.__name__}'.\")\n- size_t_setter(size_t, len(value))\n- append_array(message, y, value, size_t)\n- return bytes_writer\n+ def get_extra_info(self, name: str, default: object = None) -> object:\n+ assert self._subprocess_transport is not None\n+ return self._subprocess_transport.get_extra_info(name, default)\n \n- def get_reader(self, read_array, y, to_bytes, char_p, char_p_ref, size_t, size_t_ref):\n- def bytes_reader(message):\n- if read_array(message, y, char_p_ref, size_t_ref) <= 0:\n- raise StopIteration\n- return to_bytes(char_p, size_t)\n- return bytes_reader\n+ def set_protocol(self, protocol: asyncio.BaseProtocol) -> None:\n+ assert isinstance(protocol, asyncio.Protocol)\n+ self._protocol = protocol\n \n+ def get_protocol(self) -> asyncio.Protocol:\n+ return self._protocol\n \n-class ContainerType(Type):\n- _typestring_template: ClassVar[str]\n- __slots__ = 'item_types'\n- item_types: Sequence[Type]\n+ def is_reading(self) -> bool:\n+ assert self._stdout_transport is not None\n+ try:\n+ return self._stdout_transport.is_reading()\n+ except NotImplementedError:\n+ # This is (incorrectly) unimplemented before Python 3.11\n+ return not self._stdout_transport._paused # type:ignore[attr-defined]\n+ except AttributeError:\n+ # ...and in Python 3.6 it's even worse\n+ try:\n+ selector = self._stdout_transport._loop._selector # type:ignore[attr-defined]\n+ selector.get_key(self._stdout_transport._fileno) # type:ignore[attr-defined]\n+ return True\n+ except KeyError:\n+ return False\n \n- def __init__(self, *item_types: Type, **kwargs: Any):\n- assert len(item_types) > 0\n- item_typestrings = ''.join(item.typestring for item in item_types)\n- self.item_types = item_types\n- super().__init__(self._typestring_template.replace('_', item_typestrings),\n- type_contents=ctypes.c_char_p(item_typestrings.encode('ascii')),\n- **kwargs)\n+ def pause_reading(self) -> None:\n+ assert self._stdout_transport is not None\n+ self._stdout_transport.pause_reading()\n \n+ def resume_reading(self) -> None:\n+ assert self._stdout_transport is not None\n+ self._stdout_transport.resume_reading()\n \n-class ArrayType(ContainerType):\n- _typestring_template = 'a_'\n- __slots__ = ()\n+ def abort(self) -> None:\n+ assert self._stdin_transport is not None\n+ assert self._subprocess_transport is not None\n+ self._stdin_transport.abort()\n+ self._subprocess_transport.kill()\n \n- def __init__(self, item_type: Type):\n- super().__init__(item_type,\n- item_writer=item_type.writer,\n- item_reader=item_type.reader,\n- list_append=list.append)\n+ def can_write_eof(self) -> bool:\n+ assert self._stdin_transport is not None\n+ return self._stdin_transport.can_write_eof() # will always be True\n \n- def get_reader(self, enter_container, exit_container, list_append, item_reader):\n- def array_reader(message: libsystemd.sd_bus_message) -> object:\n- if enter_container(message, 0, None) <= 0:\n- raise StopIteration\n- result: List[object] = []\n- try:\n- while True:\n- list_append(result, item_reader(message))\n- except StopIteration:\n- return result\n- finally:\n- exit_container(message)\n- return array_reader\n+ def get_write_buffer_size(self) -> int:\n+ assert self._stdin_transport is not None\n+ return self._stdin_transport.get_write_buffer_size()\n \n- def get_writer(self, a, type_contents, open_container, close_container, item_writer):\n- def array_writer(message: libsystemd.sd_bus_message, value: object) -> None:\n- open_container(message, a, type_contents)\n- for item in value: # type: ignore[attr-defined] # can throw TypeError\n- item_writer(message, item)\n- close_container(message)\n- return array_writer\n+ def get_write_buffer_limits(self) -> 'tuple[int, int]':\n+ assert self._stdin_transport is not None\n+ return self._stdin_transport.get_write_buffer_limits()\n \n+ def set_write_buffer_limits(self, high: 'int | None' = None, low: 'int | None' = None) -> None:\n+ assert self._stdin_transport is not None\n+ return self._stdin_transport.set_write_buffer_limits(high, low)\n \n-class StructType(ContainerType):\n- _typestring_template = '(_)'\n- __slots__ = ()\n+ def write(self, data: bytes) -> None:\n+ assert self._stdin_transport is not None\n+ return self._stdin_transport.write(data)\n \n- def get_reader(self, enter_container, exit_container):\n- item_readers = tuple(item_type.reader for item_type in self.item_types)\n+ def writelines(self, list_of_data: Iterable[bytes]) -> None:\n+ assert self._stdin_transport is not None\n+ return self._stdin_transport.writelines(list_of_data)\n \n- def array_reader(message: libsystemd.sd_bus_message) -> object:\n- if enter_container(message, 0, None) <= 0:\n- raise StopIteration\n- result = tuple(item_reader(message) for item_reader in item_readers)\n- exit_container(message)\n- return result\n- return array_reader\n+ def write_eof(self) -> None:\n+ assert self._stdin_transport is not None\n+ return self._stdin_transport.write_eof()\n \n- def get_writer(self, r, type_contents, open_container, close_container):\n- item_writers = tuple(item_type.writer for item_type in self.item_types)\n+ # We don't really implement SubprocessTransport, but provide these as\n+ # \"extras\" to our user.\n+ def get_pid(self) -> int:\n+ assert self._subprocess_transport is not None\n+ return self._subprocess_transport.get_pid()\n \n- def struct_writer(message: libsystemd.sd_bus_message, value: object) -> None:\n- n_items = len(value) # type: ignore[arg-type] # can throw TypeError\n- if n_items != len(item_writers):\n- raise TypeError(f\"Wrong numbers of items ({n_items}) for structure type '{self.typestring}'\")\n- open_container(message, r, type_contents)\n- for item_writer, item in zip(item_writers, value): # type: ignore[call-overload] # can throw TypeError\n- item_writer(message, item)\n- close_container(message)\n- return struct_writer\n+ def get_returncode(self) -> 'int | None':\n+ return self._returncode\n \n+ def kill(self) -> None:\n+ assert self._subprocess_transport is not None\n+ self._subprocess_transport.kill()\n \n-class DictionaryType(ContainerType):\n- _typestring_template = 'a{_}'\n- __slots__ = ()\n+ def send_signal(self, number: int) -> None:\n+ assert self._subprocess_transport is not None\n+ self._subprocess_transport.send_signal(number)\n \n- def __init__(self, key_type: Type, value_type: Type):\n- assert isinstance(key_type, BasicType)\n- item_type = '{' + key_type.typestring + value_type.typestring + '}'\n- super().__init__(key_type, value_type,\n- key_reader=key_type.reader, key_writer=key_type.writer,\n- value_reader=value_type.reader, value_writer=value_type.writer,\n- item_type=ctypes.c_char_p(item_type.encode('ascii')))\n+ def terminate(self) -> None:\n+ assert self._subprocess_transport is not None\n+ self._subprocess_transport.terminate()\n+''',\n+ 'cockpit/_vendor/ferny/interaction_client.py': br'''#!/usr/bin/python3\n \n- def get_reader(self, enter_container, exit_container, key_reader, value_reader):\n- def dict_reader(message: libsystemd.sd_bus_message) -> object:\n- if enter_container(message, 0, None) <= 0: # array\n- raise StopIteration\n- result = {}\n- while enter_container(message, 0, None) > 0: # entry\n- key = key_reader(message)\n- value = value_reader(message)\n- result[key] = value\n- exit_container(message)\n- exit_container(message)\n- return result\n- return dict_reader\n+import array\n+import io\n+import os\n+import socket\n+import sys\n+from typing import Sequence\n \n- def get_writer(self, a, item_type, e, type_contents, open_container, close_container, key_writer, value_writer):\n- def dict_writer(message: libsystemd.sd_bus_message, value: object) -> None:\n- open_container(message, a, item_type) # array\n- for key, val in value.items(): # type: ignore[attr-defined] # can raise AttributeError\n- open_container(message, e, type_contents) # entry\n- key_writer(message, key) # key\n- value_writer(message, val) # value\n- close_container(message) # end entry\n- close_container(message) # end array\n- return dict_writer\n \n+def command(stderr_fd: int, command: str, *args: object, fds: Sequence[int] = ()) -> None:\n+ cmd_read, cmd_write = [io.open(*end) for end in zip(os.pipe(), 'rw')]\n \n-class VariantType(Type):\n- __slots__ = ()\n+ with cmd_write:\n+ with cmd_read:\n+ with socket.fromfd(stderr_fd, socket.AF_UNIX, socket.SOCK_STREAM) as sock:\n+ fd_array = array.array('i', (cmd_read.fileno(), *fds))\n+ sock.sendmsg([b'\\0'], [(socket.SOL_SOCKET, socket.SCM_RIGHTS, fd_array)])\n \n- def get_reader(self, enter_container, exit_container):\n- def variant_reader(message: libsystemd.sd_bus_message) -> object:\n- if enter_container(message, 0, None) <= 0:\n- raise StopIteration\n- typestring = message.get_signature(False)\n- type_, = from_signature(typestring)\n- value = type_.reader(message)\n- exit_container(message)\n- return Variant(value, type_)\n- return variant_reader\n+ cmd_write.write(repr((command, args)))\n \n- def get_writer(self, open_container, close_container, v):\n- def variant_writer(message: libsystemd.sd_bus_message, value: object) -> None:\n- if isinstance(value, Variant):\n- type_ = value.type\n- contents = value.value\n- else:\n- try:\n- type_, = from_signature(value['t']) # type: ignore[index] # can throw TypeError\n- contents = value['v'] # type: ignore[index] # can throw TypeError\n- except KeyError as exc:\n- raise TypeError(\"'v' can encode Variant objects, or mappings with 't' and 'v' keys\") from exc\n \n- open_container(message, v, type_.bytes_typestring)\n- type_.writer(message, contents)\n- close_container(message)\n- return variant_writer\n+def askpass(stderr_fd: int, stdout_fd: int, args: 'list[str]', env: 'dict[str, str]') -> int:\n+ ours, theirs = socket.socketpair()\n \n+ with theirs:\n+ command(stderr_fd, 'ferny.askpass', args, env, fds=(theirs.fileno(), stdout_fd))\n \n-class Variant:\n- __slots__ = 'type', 'value'\n- type: Type\n- value: object\n+ with ours:\n+ return int(ours.recv(16) or b'1')\n \n- def __init__(self, value: object, hint: object = None):\n- if isinstance(hint, Type):\n- self.type = hint\n- elif isinstance(hint, str):\n- self.type, = from_signature(hint)\n- else:\n- self.type = from_annotation(hint or value.__class__)\n- self.value = value\n \n- def __repr__(self) -> str:\n- return f\"systemd_ctypes.Variant({self.value}, '{self.type.typestring}')\"\n+def main() -> None:\n+ if len(sys.argv) == 1:\n+ command(2, 'ferny.end', [])\n+ else:\n+ sys.exit(askpass(2, 1, sys.argv, dict(os.environ)))\n \n- def __eq__(self, other: object) -> bool:\n- if isinstance(other, Variant):\n- return self.type == other.type and self.value == other.value\n- elif isinstance(other, dict):\n- return (self.type,) == from_signature(other['t']) and self.value == other['v']\n- else:\n- return False\n \n- def __hash__(self) -> int:\n- return hash(self.type) ^ hash(self.value)\n+if __name__ == '__main__':\n+ main()\n+''',\n+ 'cockpit/_vendor/ferny/__init__.py': br'''from .interaction_agent import (\n+ BEIBOOT_GADGETS,\n+ COMMAND_TEMPLATE,\n+ AskpassHandler,\n+ InteractionAgent,\n+ InteractionError,\n+ InteractionHandler,\n+ temporary_askpass,\n+ write_askpass_to_tmpdir,\n+)\n+from .session import Session\n+from .ssh_askpass import (\n+ AskpassPrompt,\n+ SshAskpassResponder,\n+ SshFIDOPINPrompt,\n+ SshFIDOUserPresencePrompt,\n+ SshHostKeyPrompt,\n+ SshPassphrasePrompt,\n+ SshPasswordPrompt,\n+ SshPKCS11PINPrompt,\n+)\n+from .ssh_errors import (\n+ SshAuthenticationError,\n+ SshChangedHostKeyError,\n+ SshError,\n+ SshHostKeyError,\n+ SshUnknownHostKeyError,\n+)\n+from .transport import FernyTransport, SubprocessError\n \n+__all__ = [\n+ 'AskpassHandler',\n+ 'AskpassPrompt',\n+ 'AuthenticationError',\n+ 'BEIBOOT_GADGETS',\n+ 'COMMAND_TEMPLATE',\n+ 'ChangedHostKeyError',\n+ 'FernyTransport',\n+ 'HostKeyError',\n+ 'InteractionAgent',\n+ 'InteractionError',\n+ 'InteractionHandler',\n+ 'Session',\n+ 'SshAskpassResponder',\n+ 'SshAuthenticationError',\n+ 'SshChangedHostKeyError',\n+ 'SshError',\n+ 'SshFIDOPINPrompt',\n+ 'SshFIDOUserPresencePrompt',\n+ 'SshHostKeyError',\n+ 'SshHostKeyPrompt',\n+ 'SshPKCS11PINPrompt',\n+ 'SshPassphrasePrompt',\n+ 'SshPasswordPrompt',\n+ 'SshUnknownHostKeyError',\n+ 'SubprocessError',\n+ 'temporary_askpass',\n+ 'write_askpass_to_tmpdir',\n+]\n \n-class BusType(Enum):\n- boolean = Annotated[bool, FixedType('b', ctypes.c_int, ctypes.c_int.__bool__)]\n- byte = Annotated[int, FixedType('y', ctypes.c_uint8)]\n- int16 = Annotated[int, FixedType('n', ctypes.c_int16)]\n- uint16 = Annotated[int, FixedType('q', ctypes.c_uint16)]\n- int32 = Annotated[int, FixedType('i', ctypes.c_int32)]\n- uint32 = Annotated[int, FixedType('u', ctypes.c_uint32)]\n- int64 = Annotated[int, FixedType('x', ctypes.c_int64)]\n- uint64 = Annotated[int, FixedType('t', ctypes.c_uint64)]\n- double = Annotated[float, FixedType('d', ctypes.c_double)]\n- string = Annotated[str, StringLikeType('s')]\n- objectpath = Annotated[str, StringLikeType('o', is_object_path)]\n- signature = Annotated[str, StringLikeType('g', is_signature)]\n- bytestring = Annotated[bytes, BytestringType('ay')]\n- variant = Annotated[dict, VariantType('v')]\n+__version__ = '0'\n+''',\n+ 'cockpit/_vendor/ferny/askpass.py': br'''from .interaction_client import main\n \n+if __name__ == '__main__':\n+ main()\n+''',\n+ 'cockpit/_vendor/ferny/ssh_askpass.py': br'''import logging\n+import re\n+from typing import ClassVar, Match, Sequence\n \n-# mypy gets confused by enums, so just use Any\n-_base_equivalence_map: Dict[type, Any] = {\n- bool: BusType.boolean,\n- bytes: BusType.bytestring,\n- int: BusType.int32,\n- str: BusType.string,\n- Variant: BusType.variant,\n-}\n+from .interaction_agent import AskpassHandler\n \n-_factory_map: Dict[object, Callable[..., Type]] = {\n- dict: DictionaryType, Dict: DictionaryType,\n- list: ArrayType, List: ArrayType,\n- tuple: StructType, Tuple: StructType,\n-}\n+logger = logging.getLogger(__name__)\n \n \n-@functools.lru_cache()\n-def from_annotation(annotation: Union[str, type, BusType]) -> Type:\n- # Simple Python types\n- if isinstance(annotation, str):\n- types = from_signature(annotation)\n- if len(types) != 1:\n- raise TypeError(f\"Signature '{annotation}' invalid as a type string \"\n- f\"because it describes {len(types)} types, not one.\")\n- return types[0]\n+class AskpassPrompt:\n+ \"\"\"An askpass prompt resulting from a call to ferny-askpass.\n \n- if isinstance(annotation, type):\n- annotation = _base_equivalence_map.get(annotation, annotation)\n+ stderr: the contents of stderr from before ferny-askpass was called.\n+ Likely related to previous failed operations.\n+ messages: all but the last line of the prompt as handed to ferny-askpass.\n+ Usually contains context about the question.\n+ prompt: the last line handed to ferny-askpass. The prompt itself.\n+ \"\"\"\n+ stderr: str\n+ messages: str\n+ prompt: str\n \n- # Our own BusType types\n- if isinstance(annotation, BusType):\n- bus_type = typing.get_args(annotation.value)[1]\n- assert isinstance(bus_type, Type)\n- return bus_type\n+ def __init__(self, prompt: str, messages: str, stderr: str) -> None:\n+ self.stderr = stderr\n+ self.messages = messages\n+ self.prompt = prompt\n \n- # Container types\n- try:\n- factory = _factory_map[typing.get_origin(annotation)]\n- args = [from_annotation(arg) for arg in typing.get_args(annotation)]\n- return factory(*args)\n- except (AssertionError, AttributeError, KeyError, TypeError):\n- raise TypeError(f\"Cannot interpret {annotation} as a dbus type\") from None\n+ def reply(self, response: str) -> None:\n+ pass\n \n+ def close(self) -> None:\n+ pass\n \n-_base_typestring_map: Dict[str, Type] = {\n- bustype.typestring: bustype for bustype in (from_annotation(entry) for entry in BusType)\n+ async def handle_via(self, responder: 'SshAskpassResponder') -> None:\n+ try:\n+ response = await self.dispatch(responder)\n+ if response is not None:\n+ self.reply(response)\n+ finally:\n+ self.close()\n+\n+ async def dispatch(self, responder: 'SshAskpassResponder') -> 'str | None':\n+ return await responder.do_prompt(self)\n+\n+\n+class SSHAskpassPrompt(AskpassPrompt):\n+ # The valid answers to prompts of this type. If this is None then any\n+ # answer is permitted. If it's a sequence then only answers from the\n+ # sequence are permitted. If it's an empty sequence, then no answer is\n+ # permitted (ie: the askpass callback should never return).\n+ answers: 'ClassVar[Sequence[str] | None]' = None\n+\n+ # Patterns to capture. `_pattern` *must* match.\n+ _pattern: ClassVar[str]\n+ # `_extra_patterns` can fill in extra class attributes if they match.\n+ _extra_patterns: ClassVar[Sequence[str]] = ()\n+\n+ def __init__(self, prompt: str, messages: str, stderr: str, match: Match) -> None:\n+ super().__init__(prompt, messages, stderr)\n+ self.__dict__.update(match.groupdict())\n+\n+ for pattern in self._extra_patterns:\n+ extra_match = re.search(with_helpers(pattern), messages, re.M)\n+ if extra_match is not None:\n+ self.__dict__.update(extra_match.groupdict())\n+\n+\n+# Specific prompts\n+HELPERS = {\n+ \"%{algorithm}\": r\"(?P\\b[-\\w]+\\b)\",\n+ \"%{filename}\": r\"(?P.+)\",\n+ \"%{fingerprint}\": r\"(?PSHA256:[0-9A-Za-z+/]{43})\",\n+ \"%{hostname}\": r\"(?P[^ @']+)\",\n+ \"%{pkcs11_id}\": r\"(?P.+)\",\n+ \"%{username}\": r\"(?P[^ @']+)\",\n }\n \n \n-@functools.lru_cache()\n-def from_signature(signature: str) -> Tuple[Type, ...]:\n- stack = list(reversed(signature))\n+class SshPasswordPrompt(SSHAskpassPrompt):\n+ _pattern = r\"%{username}@%{hostname}'s password: \"\n+ username: 'str | None' = None\n+ hostname: 'str | None' = None\n \n- def get_one() -> Type:\n- first = stack.pop()\n- if first == 'a':\n- if stack[-1] == 'y':\n- first += stack.pop()\n- elif stack[-1] == '{':\n- stack.pop()\n- return DictionaryType(*get_several('}'))\n- else:\n- return ArrayType(get_one())\n- elif first == '(':\n- return StructType(*get_several(')'))\n+ async def dispatch(self, responder: 'SshAskpassResponder') -> 'str | None':\n+ return await responder.do_password_prompt(self)\n \n- return _base_typestring_map[first]\n \n- def get_several(end: str) -> Iterable[Type]:\n- yield get_one()\n- while stack[-1] != end:\n- yield get_one()\n- stack.pop()\n+class SshPassphrasePrompt(SSHAskpassPrompt):\n+ _pattern = r\"Enter passphrase for key '%{filename}': \"\n+ filename: str\n \n- def get_all() -> Iterable[Type]:\n- while stack:\n- yield get_one()\n+ async def dispatch(self, responder: 'SshAskpassResponder') -> 'str | None':\n+ return await responder.do_passphrase_prompt(self)\n \n- try:\n- return tuple(get_all())\n- except (AssertionError, IndexError, KeyError) as exc:\n- raise TypeError(f\"Invalid type signature '{signature}'\") from exc\n \n+class SshFIDOPINPrompt(SSHAskpassPrompt):\n+ _pattern = r\"Enter PIN for %{algorithm} key %{filename}: \"\n+ algorithm: str\n+ filename: str\n \n-class MessageType:\n- item_types: Sequence[Type]\n- typestrings: List[str]\n- signature: str\n+ async def dispatch(self, responder: 'SshAskpassResponder') -> 'str | None':\n+ return await responder.do_fido_pin_prompt(self)\n \n- def __init__(self, item_types: Sequence[Union[str, type, BusType]]):\n- self.item_types = [from_annotation(item_type) for item_type in item_types]\n- self.typestrings = [item_type.typestring for item_type in self.item_types]\n- self.signature = ''.join(self.typestrings)\n \n- def write(self, message: libsystemd.sd_bus_message, *items: object) -> None:\n- assert len(items) == len(self.item_types)\n- for item_type, item in zip(self.item_types, items):\n- item_type.writer(message, item)\n+class SshFIDOUserPresencePrompt(SSHAskpassPrompt):\n+ _pattern = r\"Confirm user presence for key %{algorithm} %{fingerprint}\"\n+ answers = ()\n+ algorithm: str\n+ fingerprint: str\n \n- def read(self, message: libsystemd.sd_bus_message) -> Optional[Tuple[object, ...]]:\n- if not message.has_signature(self.signature):\n- return None\n- return tuple(item_type.reader(message) for item_type in self.item_types)\n+ async def dispatch(self, responder: 'SshAskpassResponder') -> 'str | None':\n+ return await responder.do_fido_user_presence_prompt(self)\n \n- def __len__(self) -> int:\n- return len(self.item_types)\n \n+class SshPKCS11PINPrompt(SSHAskpassPrompt):\n+ _pattern = r\"Enter PIN for '%{pkcs11_id}': \"\n+ pkcs11_id: str\n \n-class JSONEncoder(json.JSONEncoder):\n- def default(self, obj: object) -> object:\n- if isinstance(obj, Variant):\n- return {\"t\": obj.type.typestring, \"v\": obj.value}\n- elif isinstance(obj, bytes):\n- return binascii.b2a_base64(obj, newline=False).decode('ascii')\n- return super().default(obj)\n+ async def dispatch(self, responder: 'SshAskpassResponder') -> 'str | None':\n+ return await responder.do_pkcs11_pin_prompt(self)\n+\n+\n+class SshHostKeyPrompt(SSHAskpassPrompt):\n+ _pattern = r\"Are you sure you want to continue connecting \\(yes/no(/\\[fingerprint\\])?\\)\\? \"\n+ _extra_patterns = [\n+ r\"%{fingerprint}[.]$\",\n+ r\"^%{algorithm} key fingerprint is\",\n+ r\"^The fingerprint for the %{algorithm} key sent by the remote host is$\"\n+ ]\n+ answers = ('yes', 'no')\n+ algorithm: str\n+ fingerprint: str\n+\n+ async def dispatch(self, responder: 'SshAskpassResponder') -> 'str | None':\n+ return await responder.do_host_key_prompt(self)\n+\n+\n+def with_helpers(pattern: str) -> str:\n+ for name, helper in HELPERS.items():\n+ pattern = pattern.replace(name, helper)\n+\n+ assert '%{' not in pattern\n+ return pattern\n+\n+\n+def categorize_ssh_prompt(string: str, stderr: str) -> AskpassPrompt:\n+ classes = [\n+ SshFIDOPINPrompt,\n+ SshFIDOUserPresencePrompt,\n+ SshHostKeyPrompt,\n+ SshPKCS11PINPrompt,\n+ SshPassphrasePrompt,\n+ SshPasswordPrompt,\n+ ]\n+\n+ # The last line is the line after the last newline character, excluding the\n+ # optional final newline character. eg: \"x\\ny\\nLAST\\n\" or \"x\\ny\\nLAST\"\n+ second_last_newline = string.rfind('\\n', 0, -1)\n+ if second_last_newline >= 0:\n+ last_line = string[second_last_newline + 1:]\n+ extras = string[:second_last_newline + 1]\n+ else:\n+ last_line = string\n+ extras = ''\n+\n+ for cls in classes:\n+ pattern = with_helpers(cls._pattern)\n+ match = re.fullmatch(pattern, last_line)\n+ if match is not None:\n+ return cls(last_line, extras, stderr, match)\n+\n+ return AskpassPrompt(last_line, extras, stderr)\n+\n+\n+class SshAskpassResponder(AskpassHandler):\n+ async def do_askpass(self, stderr: str, prompt: str, hint: str) -> 'str | None':\n+ return await categorize_ssh_prompt(prompt, stderr).dispatch(self)\n+\n+ async def do_prompt(self, prompt: AskpassPrompt) -> 'str | None':\n+ # Default fallback for unrecognised message types: unimplemented\n+ return None\n+\n+ async def do_fido_pin_prompt(self, prompt: SshFIDOPINPrompt) -> 'str | None':\n+ return await self.do_prompt(prompt)\n+\n+ async def do_fido_user_presence_prompt(self, prompt: SshFIDOUserPresencePrompt) -> 'str | None':\n+ return await self.do_prompt(prompt)\n+\n+ async def do_host_key_prompt(self, prompt: SshHostKeyPrompt) -> 'str | None':\n+ return await self.do_prompt(prompt)\n+\n+ async def do_pkcs11_pin_prompt(self, prompt: SshPKCS11PINPrompt) -> 'str | None':\n+ return await self.do_prompt(prompt)\n+\n+ async def do_passphrase_prompt(self, prompt: SshPassphrasePrompt) -> 'str | None':\n+ return await self.do_prompt(prompt)\n+\n+ async def do_password_prompt(self, prompt: SshPasswordPrompt) -> 'str | None':\n+ return await self.do_prompt(prompt)\n ''',\n- 'cockpit/_vendor/systemd_ctypes/introspection.py': br'''# systemd_ctypes\n+ 'cockpit/_vendor/ferny/session.py': r'''# ferny - asyncio SSH client library, using ssh(1)\n #\n # Copyright (C) 2022 Allison Karlitskaya \n #\n # This program is free software: you can redistribute it and/or modify\n # it under the terms of the GNU General Public License as published by\n # the Free Software Foundation, either version 3 of the License, or\n # (at your option) any later version.\n@@ -11403,86 +10746,743 @@\n # but WITHOUT ANY WARRANTY; without even the implied warranty of\n # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n # GNU General Public License for more details.\n #\n # You should have received a copy of the GNU General Public License\n # along with this program. If not, see .\n \n-import xml.etree.ElementTree as ET\n+import asyncio\n+import ctypes\n+import functools\n+import logging\n+import os\n+import shlex\n+import signal\n+import subprocess\n+import tempfile\n+from typing import Mapping, Sequence\n \n+from . import ssh_errors\n+from .interaction_agent import InteractionAgent, InteractionError, InteractionHandler, write_askpass_to_tmpdir\n \n-def parse_method(method):\n- return {\n- \"in\": [tag.attrib['type'] for tag in method.findall(\"arg\") if tag.get('direction', 'in') == 'in'],\n- \"out\": [tag.attrib['type'] for tag in method.findall(\"arg[@direction='out']\")]\n- }\n+prctl = ctypes.cdll.LoadLibrary('libc.so.6').prctl\n+logger = logging.getLogger(__name__)\n+PR_SET_PDEATHSIG = 1\n \n \n-def parse_property(prop):\n- return {\n- \"flags\": 'w' if prop.attrib.get('access') == 'write' else 'r',\n- \"type\": prop.attrib['type']\n- }\n+@functools.lru_cache()\n+def has_feature(feature: str, teststr: str = 'x') -> bool:\n+ try:\n+ subprocess.check_output(['ssh', f'-o{feature} {teststr}', '-G', 'nonexisting'], stderr=subprocess.DEVNULL)\n+ return True\n+ except subprocess.CalledProcessError:\n+ return False\n \n \n-def parse_signal(signal):\n- return {\"in\": [tag.attrib['type'] for tag in signal.findall(\"arg\")]}\n+class SubprocessContext:\n+ def wrap_subprocess_args(self, args: Sequence[str]) -> Sequence[str]:\n+ \"\"\"Return the args required to launch a process in the given context.\n \n+ For example, this might return a vector with\n+ [\"sudo\"]\n+ or\n+ [\"flatpak-spawn\", \"--host\"]\n+ prepended.\n \n-def parse_interface(interface):\n- return {\n- \"methods\": {tag.attrib['name']: parse_method(tag) for tag in interface.findall('method')},\n- \"properties\": {tag.attrib['name']: parse_property(tag) for tag in interface.findall('property')},\n- \"signals\": {tag.attrib['name']: parse_signal(tag) for tag in interface.findall('signal')}\n- }\n+ It is also possible that more substantial changes may be performed.\n \n+ This function is not permitted to modify its argument, although it may\n+ (optionally) return it unmodified, if no changes are required.\n+ \"\"\"\n+ return args\n \n-def parse_xml(xml):\n- et = ET.fromstring(xml)\n- return {tag.attrib['name']: parse_interface(tag) for tag in et.findall('interface')}\n+ def wrap_subprocess_env(self, env: Mapping[str, str]) -> Mapping[str, str]:\n+ \"\"\"Return the envp required to launch a process in the given context.\n \n+ For example, this might set the \"SUDO_ASKPASS\" environment variable, if\n+ needed.\n \n-# Pretend like this is a little bit functional\n-def element(tag, children=(), **kwargs):\n- tag = ET.Element(tag, kwargs)\n- tag.extend(children)\n- return tag\n+ As with wrap_subprocess_args(), this function is not permitted to\n+ modify its argument, although it may (optionally) return it unmodified\n+ if no changes are required.\n+ \"\"\"\n+ return env\n \n \n-def method_to_xml(name, method_info):\n- return element('method', name=name,\n- children=[\n- element('arg', type=arg_type, direction=direction)\n- for direction in ['in', 'out']\n- for arg_type in method_info[direction]\n- ])\n+class Session(SubprocessContext, InteractionHandler):\n+ # Set after .connect() called, even if failed\n+ _controldir: 'tempfile.TemporaryDirectory | None' = None\n+ _controlsock: 'str | None' = None\n \n+ # Set if connected, else None\n+ _process: 'asyncio.subprocess.Process | None' = None\n \n-def property_to_xml(name, property_info):\n- return element('property', name=name,\n- access='write' if property_info['flags'] == 'w' else 'read',\n- type=property_info['type'])\n+ async def connect(self,\n+ destination: str,\n+ handle_host_key: bool = False,\n+ configfile: 'str | None' = None,\n+ identity_file: 'str | None' = None,\n+ login_name: 'str | None' = None,\n+ options: 'Mapping[str, str] | None' = None,\n+ pkcs11: 'str | None' = None,\n+ port: 'int | None' = None,\n+ interaction_responder: 'InteractionHandler | None' = None) -> None:\n+ rundir = os.path.join(os.environ.get('XDG_RUNTIME_DIR', '/run'), 'ferny')\n+ os.makedirs(rundir, exist_ok=True)\n+ self._controldir = tempfile.TemporaryDirectory(dir=rundir)\n+ self._controlsock = f'{self._controldir.name}/socket'\n+\n+ # In general, we can't guarantee an accessible and executable version\n+ # of this file, but since it's small and we're making a temporary\n+ # directory anyway, let's just copy it into place and use it from\n+ # there.\n+ askpass_path = write_askpass_to_tmpdir(self._controldir.name)\n \n+ env = dict(os.environ)\n+ env['SSH_ASKPASS'] = askpass_path\n+ env['SSH_ASKPASS_REQUIRE'] = 'force'\n+ # old SSH doesn't understand SSH_ASKPASS_REQUIRE and guesses based on DISPLAY instead\n+ env['DISPLAY'] = '-'\n \n-def signal_to_xml(name, signal_info):\n- return element('signal', name=name,\n- children=[\n- element('arg', type=arg_type) for arg_type in signal_info['in']\n- ])\n+ args = [\n+ '-M',\n+ '-N',\n+ '-S', self._controlsock,\n+ '-o', 'PermitLocalCommand=yes',\n+ '-o', f'LocalCommand={askpass_path}',\n+ ]\n \n+ if configfile is not None:\n+ args.append(f'-F{configfile}')\n \n-def interface_to_xml(name, interface_info):\n- return element('interface', name=name,\n- children=[\n- *(method_to_xml(name, info) for name, info in interface_info['methods'].items()),\n- *(property_to_xml(name, info) for name, info in interface_info['properties'].items()),\n- *(signal_to_xml(name, info) for name, info in interface_info['signals'].items()),\n- ])\n+ if identity_file is not None:\n+ args.append(f'-i{identity_file}')\n+\n+ if options is not None:\n+ for key in options: # Note: Mapping may not have .items()\n+ args.append(f'-o{key} {options[key]}')\n \n+ if pkcs11 is not None:\n+ args.append(f'-I{pkcs11}')\n \n-def to_xml(interfaces):\n- node = element('node', children=(interface_to_xml(name, members) for name, members in interfaces.items()))\n- return ET.tostring(node, encoding='unicode')\n+ if port is not None:\n+ args.append(f'-p{port}')\n+\n+ if login_name is not None:\n+ args.append(f'-l{login_name}')\n+\n+ if handle_host_key and has_feature('KnownHostsCommand'):\n+ args.extend([\n+ '-o', f'KnownHostsCommand={askpass_path} %I %H %t %K %f',\n+ '-o', 'StrictHostKeyChecking=yes',\n+ ])\n+\n+ agent = InteractionAgent([interaction_responder] if interaction_responder is not None else [])\n+\n+ # SSH_ASKPASS_REQUIRE is not generally available, so use setsid\n+ process = await asyncio.create_subprocess_exec(\n+ *('/usr/bin/ssh', *args, destination), env=env,\n+ start_new_session=True, stdin=asyncio.subprocess.DEVNULL,\n+ stdout=asyncio.subprocess.DEVNULL, stderr=agent, # type: ignore\n+ preexec_fn=lambda: prctl(PR_SET_PDEATHSIG, signal.SIGKILL))\n+\n+ # This is tricky: we need to clean up the subprocess, but only in case\n+ # if failure. Otherwise, we keep it around.\n+ try:\n+ await agent.communicate()\n+ assert os.path.exists(self._controlsock)\n+ self._process = process\n+ except InteractionError as exc:\n+ await process.wait()\n+ raise ssh_errors.get_exception_for_ssh_stderr(str(exc)) from None\n+ except BaseException:\n+ # If we get here because the InteractionHandler raised an\n+ # exception then SSH might still be running, and may even attempt\n+ # further interactions (ie: 2nd attempt for password). We already\n+ # have our exception and don't need any more info. Kill it.\n+ try:\n+ process.kill()\n+ except ProcessLookupError:\n+ pass # already exited? good.\n+ await process.wait()\n+ raise\n+\n+ def is_connected(self) -> bool:\n+ return self._process is not None\n+\n+ async def wait(self) -> None:\n+ assert self._process is not None\n+ await self._process.wait()\n+\n+ def exit(self) -> None:\n+ assert self._process is not None\n+ self._process.terminate()\n+\n+ async def disconnect(self) -> None:\n+ self.exit()\n+ await self.wait()\n+\n+ # Launching of processes\n+ def wrap_subprocess_args(self, args: Sequence[str]) -> Sequence[str]:\n+ assert self._controlsock is not None\n+ # 1. We specify the hostname as the empty string: it will be ignored\n+ # when ssh is trying to use the control socket, but in case the\n+ # socket has stopped working, ssh will try to fall back to directly\n+ # connecting, in which case an empty hostname will prevent that.\n+ # 2. We need to quote the arguments \u2014 ssh will paste them together\n+ # using only spaces, executing the result using the user's shell.\n+ return ('ssh', '-S', self._controlsock, '', *map(shlex.quote, args))\n+'''.encode('utf-8'),\n+ 'cockpit/_vendor/ferny/ssh_errors.py': br'''# ferny - asyncio SSH client library, using ssh(1)\n+#\n+# Copyright (C) 2023 Allison Karlitskaya \n+#\n+# This program is free software: you can redistribute it and/or modify\n+# it under the terms of the GNU General Public License as published by\n+# the Free Software Foundation, either version 3 of the License, or\n+# (at your option) any later version.\n+#\n+# This program is distributed in the hope that it will be useful,\n+# but WITHOUT ANY WARRANTY; without even the implied warranty of\n+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n+# GNU General Public License for more details.\n+#\n+# You should have received a copy of the GNU General Public License\n+# along with this program. If not, see .\n+\n+import ctypes\n+import errno\n+import os\n+import re\n+import socket\n+from typing import ClassVar, Iterable, Match, Pattern\n+\n+\n+class SshError(Exception):\n+ PATTERN: ClassVar[Pattern]\n+\n+ def __init__(self, match: 'Match | None', stderr: str) -> None:\n+ super().__init__(match.group(0) if match is not None else stderr)\n+ self.stderr = stderr\n+\n+\n+class SshAuthenticationError(SshError):\n+ PATTERN = re.compile(r'^([^:]+): Permission denied \\(([^()]+)\\)\\.$', re.M)\n+\n+ def __init__(self, match: Match, stderr: str) -> None:\n+ super().__init__(match, stderr)\n+ self.destination = match.group(1)\n+ self.methods = match.group(2).split(',')\n+ self.message = match.group(0)\n+\n+\n+# generic host key error for OSes without KnownHostsCommand support\n+class SshHostKeyError(SshError):\n+ PATTERN = re.compile(r'^Host key verification failed.$', re.M)\n+\n+\n+# specific errors for OSes with KnownHostsCommand\n+class SshUnknownHostKeyError(SshHostKeyError):\n+ PATTERN = re.compile(r'^No .* host key is known.*Host key verification failed.$', re.S | re.M)\n+\n+\n+class SshChangedHostKeyError(SshHostKeyError):\n+ PATTERN = re.compile(r'warning.*remote host identification has changed', re.I)\n+\n+\n+# Functionality for mapping getaddrinfo()-family error messages to their\n+# equivalent Python exceptions.\n+def make_gaierror_map() -> 'Iterable[tuple[str, int]]':\n+ libc = ctypes.CDLL(None)\n+ libc.gai_strerror.restype = ctypes.c_char_p\n+\n+ for key in dir(socket):\n+ if key.startswith('EAI_'):\n+ errnum = getattr(socket, key)\n+ yield libc.gai_strerror(errnum).decode('utf-8'), errnum\n+\n+\n+gaierror_map = dict(make_gaierror_map())\n+\n+\n+# Functionality for passing strerror() error messages to their equivalent\n+# Python exceptions.\n+# There doesn't seem to be an official API for turning an errno into the\n+# correct subtype of OSError, and the list that cpython uses is hidden fairly\n+# deeply inside of the implementation. This is basically copied from the\n+# ADD_ERRNO() lines in _PyExc_InitState in cpython/Objects/exceptions.c\n+oserror_subclass_map = dict((errnum, cls) for cls, errnum in [\n+ (BlockingIOError, errno.EAGAIN),\n+ (BlockingIOError, errno.EALREADY),\n+ (BlockingIOError, errno.EINPROGRESS),\n+ (BlockingIOError, errno.EWOULDBLOCK),\n+ (BrokenPipeError, errno.EPIPE),\n+ (BrokenPipeError, errno.ESHUTDOWN),\n+ (ChildProcessError, errno.ECHILD),\n+ (ConnectionAbortedError, errno.ECONNABORTED),\n+ (ConnectionRefusedError, errno.ECONNREFUSED),\n+ (ConnectionResetError, errno.ECONNRESET),\n+ (FileExistsError, errno.EEXIST),\n+ (FileNotFoundError, errno.ENOENT),\n+ (IsADirectoryError, errno.EISDIR),\n+ (NotADirectoryError, errno.ENOTDIR),\n+ (InterruptedError, errno.EINTR),\n+ (PermissionError, errno.EACCES),\n+ (PermissionError, errno.EPERM),\n+ (ProcessLookupError, errno.ESRCH),\n+ (TimeoutError, errno.ETIMEDOUT),\n+])\n+\n+\n+def get_exception_for_ssh_stderr(stderr: str) -> Exception:\n+ stderr = stderr.replace('\\r\\n', '\\n') # fix line separators\n+\n+ # check for the specific error messages first, then for generic SshHostKeyError\n+ for ssh_cls in [SshAuthenticationError, SshChangedHostKeyError, SshUnknownHostKeyError, SshHostKeyError]:\n+ match = ssh_cls.PATTERN.search(stderr)\n+ if match is not None:\n+ return ssh_cls(match, stderr)\n+\n+ before, colon, after = stderr.rpartition(':')\n+ if colon and after:\n+ potential_strerror = after.strip()\n+\n+ # DNS lookup errors\n+ if potential_strerror in gaierror_map:\n+ errnum = gaierror_map[potential_strerror]\n+ return socket.gaierror(errnum, stderr)\n+\n+ # Network connect errors\n+ for errnum in errno.errorcode:\n+ if os.strerror(errnum) == potential_strerror:\n+ os_cls = oserror_subclass_map.get(errnum, OSError)\n+ return os_cls(errnum, stderr)\n+\n+ # No match? Generic.\n+ return SshError(None, stderr)\n ''',\n+ 'cockpit/_vendor/ferny/py.typed': br'''''',\n+ 'cockpit/_vendor/ferny/interaction_agent.py': r'''# ferny - asyncio SSH client library, using ssh(1)\n+#\n+# Copyright (C) 2023 Allison Karlitskaya \n+#\n+# This program is free software: you can redistribute it and/or modify\n+# it under the terms of the GNU General Public License as published by\n+# the Free Software Foundation, either version 3 of the License, or\n+# (at your option) any later version.\n+#\n+# This program is distributed in the hope that it will be useful,\n+# but WITHOUT ANY WARRANTY; without even the implied warranty of\n+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n+# GNU General Public License for more details.\n+#\n+# You should have received a copy of the GNU General Public License\n+# along with this program. If not, see .\n+\n+import array\n+import ast\n+import asyncio\n+import contextlib\n+import logging\n+import os\n+import re\n+import socket\n+import tempfile\n+from typing import Any, Callable, ClassVar, Generator, Sequence\n+\n+from . import interaction_client\n+\n+logger = logging.getLogger(__name__)\n+\n+\n+COMMAND_RE = re.compile(b'\\0ferny\\0([^\\n]*)\\0\\0\\n')\n+COMMAND_TEMPLATE = '\\0ferny\\0{(command, args)!r}\\0\\0\\n'\n+\n+BEIBOOT_GADGETS = {\n+ \"command\": fr\"\"\"\n+ import sys\n+ def command(command, *args):\n+ sys.stderr.write(f{COMMAND_TEMPLATE!r})\n+ sys.stderr.flush()\n+ \"\"\",\n+ \"end\": r\"\"\"\n+ def end():\n+ command('ferny.end')\n+ \"\"\",\n+}\n+\n+\n+class InteractionError(Exception):\n+ pass\n+\n+\n+try:\n+ recv_fds = socket.recv_fds\n+except AttributeError:\n+ # Python < 3.9\n+\n+ def recv_fds(\n+ sock: socket.socket, bufsize: int, maxfds: int, flags: int = 0\n+ ) -> 'tuple[bytes, list[int], int, None]':\n+ fds = array.array(\"i\")\n+ msg, ancdata, flags, addr = sock.recvmsg(bufsize, socket.CMSG_LEN(maxfds * fds.itemsize))\n+ for cmsg_level, cmsg_type, cmsg_data in ancdata:\n+ if (cmsg_level == socket.SOL_SOCKET and cmsg_type == socket.SCM_RIGHTS):\n+ fds.frombytes(cmsg_data[:len(cmsg_data) - (len(cmsg_data) % fds.itemsize)])\n+ return msg, list(fds), flags, addr\n+\n+\n+def get_running_loop() -> asyncio.AbstractEventLoop:\n+ try:\n+ return asyncio.get_running_loop()\n+ except AttributeError:\n+ # Python 3.6\n+ return asyncio.get_event_loop()\n+\n+\n+class InteractionHandler:\n+ commands: ClassVar[Sequence[str]]\n+\n+ async def run_command(self, command: str, args: 'tuple[object, ...]', fds: 'list[int]', stderr: str) -> None:\n+ raise NotImplementedError\n+\n+\n+class AskpassHandler(InteractionHandler):\n+ commands: ClassVar[Sequence[str]] = ('ferny.askpass',)\n+\n+ async def do_askpass(self, messages: str, prompt: str, hint: str) -> 'str | None':\n+ \"\"\"Prompt the user for an authentication or confirmation interaction.\n+\n+ 'messages' is data that was sent to stderr before the interaction was requested.\n+ 'prompt' is the interaction prompt.\n+\n+ The expected response type depends on hint:\n+\n+ - \"confirm\": ask for permission, returning \"yes\" if accepted\n+ - example: authorizing agent operation\n+\n+ - \"none\": show a request without need for a response\n+ - example: please touch your authentication token\n+\n+ - otherwise: return a password or other form of text token\n+ - examples: enter password, unlock private key\n+\n+ In any case, the function should properly handle cancellation. For the\n+ \"none\" case, this will be the normal way to dismiss the dialog.\n+ \"\"\"\n+ return None\n+\n+ async def do_hostkey(self, reason: str, host: str, algorithm: str, key: str, fingerprint: str) -> bool:\n+ \"\"\"Prompt the user for a decision regarding acceptance of a host key.\n+\n+ The \"reason\" will be either \"HOSTNAME\" or \"ADDRESS\" (if `CheckHostIP` is enabled).\n+\n+ The host, algorithm, and key parameters are the values in the form that\n+ they would appear one a single line in the known hosts file. The\n+ fingerprint is the key fingerprint in the format that ssh would\n+ normally present it to the user.\n+\n+ In case the host key should be accepted, this function needs to return\n+ True. Returning False means that ssh implements its default logic. To\n+ interrupt the connection, raise an exception.\n+ \"\"\"\n+ return False\n+\n+ async def do_custom_command(\n+ self, command: str, args: 'tuple[object, ...]', fds: 'list[int]', stderr: str\n+ ) -> None:\n+ \"\"\"Handle a custom command.\n+\n+ The command name, its arguments, the passed fds, and the stderr leading\n+ up to the command invocation are all provided.\n+\n+ See doc/interaction-protocol.md\n+ \"\"\"\n+\n+ async def _askpass_command(self, args: 'tuple[object, ...]', fds: 'list[int]', stderr: str) -> None:\n+ logger.debug('_askpass_command(%s, %s, %s)', args, fds, stderr)\n+ try:\n+ argv, env = args\n+ assert isinstance(argv, list)\n+ assert all(isinstance(arg, str) for arg in argv)\n+ assert isinstance(env, dict)\n+ assert all(isinstance(key, str) and isinstance(val, str) for key, val in env.items())\n+ assert len(fds) == 2\n+ except (ValueError, TypeError, AssertionError) as exc:\n+ logger.error('Invalid arguments to askpass interaction: %s, %s: %s', args, fds, exc)\n+ return\n+\n+ with open(fds.pop(0), 'w') as status, open(fds.pop(0), 'w') as stdout:\n+ try:\n+ loop = get_running_loop()\n+ try:\n+ task = asyncio.current_task()\n+ except AttributeError:\n+ task = asyncio.Task.current_task() # type:ignore[attr-defined] # (Python 3.6)\n+ assert task is not None\n+ loop.add_reader(status, task.cancel)\n+\n+ if len(argv) == 2:\n+ # normal askpass\n+ prompt = argv[1]\n+ hint = env.get('SSH_ASKPASS_PROMPT', '')\n+ logger.debug('do_askpass(%r, %r, %r)', stderr, prompt, hint)\n+ answer = await self.do_askpass(stderr, prompt, hint)\n+ logger.debug('do_askpass answer %r', answer)\n+ if answer is not None:\n+ print(answer, file=stdout)\n+ print(0, file=status)\n+\n+ elif len(argv) == 6:\n+ # KnownHostsCommand\n+ argv0, reason, host, algorithm, key, fingerprint = argv\n+ if reason in ['ADDRESS', 'HOSTNAME']:\n+ logger.debug('do_hostkey(%r, %r, %r, %r, %r)', reason, host, algorithm, key, fingerprint)\n+ if await self.do_hostkey(reason, host, algorithm, key, fingerprint):\n+ print(host, algorithm, key, file=stdout)\n+ else:\n+ logger.debug('ignoring KnownHostsCommand reason %r', reason)\n+\n+ print(0, file=status)\n+\n+ else:\n+ logger.error('Incorrect number of command-line arguments to ferny-askpass: %s', argv)\n+ finally:\n+ loop.remove_reader(status)\n+\n+ async def run_command(self, command: str, args: 'tuple[object, ...]', fds: 'list[int]', stderr: str) -> None:\n+ logger.debug('run_command(%s, %s, %s, %s)', command, args, fds, stderr)\n+ if command == 'ferny.askpass':\n+ await self._askpass_command(args, fds, stderr)\n+ else:\n+ await self.do_custom_command(command, args, fds, stderr)\n+\n+\n+class InteractionAgent:\n+ _handlers: 'dict[str, InteractionHandler]'\n+\n+ _loop: asyncio.AbstractEventLoop\n+\n+ _tasks: 'set[asyncio.Task]'\n+\n+ _buffer: bytearray\n+ _ours: socket.socket\n+ _theirs: socket.socket\n+\n+ _completion_future: 'asyncio.Future[str]'\n+ _pending_result: 'None | str | Exception' = None\n+ _end: bool = False\n+\n+ def _consider_completion(self) -> None:\n+ logger.debug('_consider_completion(%r)', self)\n+\n+ if self._pending_result is None or self._tasks:\n+ logger.debug(' but not ready yet')\n+\n+ elif self._completion_future.done():\n+ logger.debug(' but already complete')\n+\n+ elif isinstance(self._pending_result, str):\n+ logger.debug(' submitting stderr (%r) to completion_future', self._pending_result)\n+ self._completion_future.set_result(self._pending_result)\n+\n+ else:\n+ logger.debug(' submitting exception (%r) to completion_future')\n+ self._completion_future.set_exception(self._pending_result)\n+\n+ def _result(self, result: 'str | Exception') -> None:\n+ logger.debug('_result(%r, %r)', self, result)\n+\n+ if self._pending_result is None:\n+ self._pending_result = result\n+\n+ if self._ours.fileno() != -1:\n+ logger.debug(' remove_reader(%r)', self._ours)\n+ self._loop.remove_reader(self._ours.fileno())\n+\n+ for task in self._tasks:\n+ logger.debug(' cancel(%r)', task)\n+ task.cancel()\n+\n+ logger.debug(' closing sockets')\n+ self._theirs.close() # idempotent\n+ self._ours.close()\n+\n+ self._consider_completion()\n+\n+ def _invoke_command(self, stderr: bytes, command_blob: bytes, fds: 'list[int]') -> None:\n+ logger.debug('_invoke_command(%r, %r, %r)', stderr, command_blob, fds)\n+ try:\n+ command, args = ast.literal_eval(command_blob.decode())\n+ if not isinstance(command, str) or not isinstance(args, tuple):\n+ raise TypeError('Invalid argument types')\n+ except (UnicodeDecodeError, SyntaxError, ValueError, TypeError) as exc:\n+ logger.error('Received invalid ferny command: %s: %s', command_blob, exc)\n+ return\n+\n+ if command == 'ferny.end':\n+ self._end = True\n+ self._result(self._buffer.decode(errors='replace'))\n+ return\n+\n+ try:\n+ handler = self._handlers[command]\n+ except KeyError:\n+ logger.error('Received unhandled ferny command: %s', command)\n+ return\n+\n+ # The task is responsible for the list of fds and removing itself\n+ # from the set.\n+ task_fds = list(fds)\n+ task = self._loop.create_task(handler.run_command(command, args, task_fds, stderr.decode()))\n+\n+ def bottom_half(completed_task: asyncio.Task) -> None:\n+ assert completed_task is task\n+ while task_fds:\n+ os.close(task_fds.pop())\n+ self._tasks.remove(task)\n+\n+ try:\n+ task.result()\n+ logger.debug('%r completed cleanly', handler)\n+ except asyncio.CancelledError:\n+ # this is not an error \u2014 it just means ferny-askpass exited via signal\n+ logger.debug('%r was cancelled', handler)\n+ except Exception as exc:\n+ logger.debug('%r raised %r', handler, exc)\n+ self._result(exc)\n+\n+ self._consider_completion()\n+\n+ task.add_done_callback(bottom_half)\n+ self._tasks.add(task)\n+ fds[:] = []\n+\n+ def _got_data(self, data: bytes, fds: 'list[int]') -> None:\n+ logger.debug('_got_data(%r, %r)', data, fds)\n+\n+ if data == b'':\n+ self._result(self._buffer.decode(errors='replace'))\n+ return\n+\n+ self._buffer.extend(data)\n+\n+ # Read zero or more \"remote\" messages\n+ chunks = COMMAND_RE.split(self._buffer)\n+ self._buffer = bytearray(chunks.pop())\n+ while len(chunks) > 1:\n+ self._invoke_command(chunks[0], chunks[1], [])\n+ chunks = chunks[2:]\n+\n+ # Maybe read one \"local\" message\n+ if fds:\n+ assert self._buffer.endswith(b'\\0'), self._buffer\n+ stderr = self._buffer[:-1]\n+ self._buffer = bytearray(b'')\n+ with open(fds.pop(0), 'rb') as command_channel:\n+ command = command_channel.read()\n+ self._invoke_command(stderr, command, fds)\n+\n+ def _read_ready(self) -> None:\n+ try:\n+ data, fds, _flags, _addr = recv_fds(self._ours, 4096, 10, flags=socket.MSG_DONTWAIT)\n+ except BlockingIOError:\n+ return\n+ except OSError as exc:\n+ self._result(exc)\n+ else:\n+ self._got_data(data, fds)\n+ finally:\n+ while fds:\n+ os.close(fds.pop())\n+\n+ def __init__(\n+ self,\n+ handlers: Sequence[InteractionHandler],\n+ loop: 'asyncio.AbstractEventLoop | None' = None,\n+ done_callback: 'Callable[[asyncio.Future[str]], None] | None' = None,\n+ ) -> None:\n+ self._loop = loop or get_running_loop()\n+ self._completion_future = self._loop.create_future()\n+ self._tasks = set()\n+ self._handlers = {}\n+\n+ for handler in handlers:\n+ for command in handler.commands:\n+ self._handlers[command] = handler\n+\n+ if done_callback is not None:\n+ self._completion_future.add_done_callback(done_callback)\n+\n+ self._theirs, self._ours = socket.socketpair(socket.AF_UNIX, socket.SOCK_STREAM)\n+ self._buffer = bytearray()\n+\n+ def fileno(self) -> int:\n+ return self._theirs.fileno()\n+\n+ def start(self) -> None:\n+ logger.debug('start(%r)', self)\n+ if self._ours.fileno() != -1:\n+ logger.debug(' add_reader(%r)', self._ours)\n+ self._loop.add_reader(self._ours.fileno(), self._read_ready)\n+ else:\n+ logger.debug(' ...but agent is already finished.')\n+\n+ logger.debug(' close(%r)', self._theirs)\n+ self._theirs.close()\n+\n+ def force_completion(self) -> None:\n+ logger.debug('force_completion(%r)', self)\n+\n+ # read any residual data on stderr, but don't process commands, and\n+ # don't block\n+ try:\n+ if self._ours.fileno() != -1:\n+ logger.debug(' draining pending stderr data (non-blocking)')\n+ with contextlib.suppress(BlockingIOError):\n+ while True:\n+ data = self._ours.recv(4096, socket.MSG_DONTWAIT)\n+ logger.debug(' got %d bytes', len(data))\n+ if not data:\n+ break\n+ self._buffer.extend(data)\n+ except OSError as exc:\n+ self._result(exc)\n+ else:\n+ self._result(self._buffer.decode(errors='replace'))\n+\n+ async def communicate(self) -> None:\n+ logger.debug('_communicate(%r)', self)\n+ try:\n+ self.start()\n+ # We assume that we are the only ones to write to\n+ # self._completion_future. If we directly await it, though, it can\n+ # also have a asyncio.CancelledError posted to it from outside.\n+ # Shield it to prevent that from happening.\n+ stderr = await asyncio.shield(self._completion_future)\n+ logger.debug('_communicate(%r) stderr result is %r', self, stderr)\n+ finally:\n+ logger.debug('_communicate finished. Ensuring completion.')\n+ self.force_completion()\n+ if not self._end:\n+ logger.debug('_communicate never saw ferny.end. raising InteractionError.')\n+ raise InteractionError(stderr.strip())\n+\n+\n+def write_askpass_to_tmpdir(tmpdir: str) -> str:\n+ askpass_path = os.path.join(tmpdir, 'ferny-askpass')\n+ fd = os.open(askpass_path, os.O_CREAT | os.O_WRONLY | os.O_CLOEXEC | os.O_EXCL | os.O_NOFOLLOW, 0o777)\n+ try:\n+ os.write(fd, __loader__.get_data(interaction_client.__file__)) # type: ignore\n+ finally:\n+ os.close(fd)\n+ return askpass_path\n+\n+\n+@contextlib.contextmanager\n+def temporary_askpass(**kwargs: Any) -> Generator[str, None, None]:\n+ with tempfile.TemporaryDirectory(**kwargs) as directory:\n+ yield write_askpass_to_tmpdir(directory)\n+'''.encode('utf-8'),\n }))\n from cockpit.bridge import main as main\n main(beipack=True)\n"}]}, {"source1": "./usr/lib/python3/dist-packages/cockpit-316.dist-info/direct_url.json", "source2": "./usr/lib/python3/dist-packages/cockpit-316.dist-info/direct_url.json", "unified_diff": null, "details": [{"source1": "Pretty-printed", "source2": "Pretty-printed", "comments": ["Similarity: 0.90625%", "Differences: {\"'archive_info'\": \"{'hash': \"", " \"'sha256=c65835a62db7f1d424f54241d98adb25d749fc610b537c5c288e56226a2ad3d6', \"", " \"'hashes': {'sha256': \"", " \"'c65835a62db7f1d424f54241d98adb25d749fc610b537c5c288e56226a2ad3d6'}}\"}"], "unified_diff": "@@ -1,9 +1,9 @@\n {\n \"archive_info\": {\n- \"hash\": \"sha256=431283aedc94efd58bdd7358fff964916c6d8bb302d4e28f273800960ac9d280\",\n+ \"hash\": \"sha256=c65835a62db7f1d424f54241d98adb25d749fc610b537c5c288e56226a2ad3d6\",\n \"hashes\": {\n- \"sha256\": \"431283aedc94efd58bdd7358fff964916c6d8bb302d4e28f273800960ac9d280\"\n+ \"sha256\": \"c65835a62db7f1d424f54241d98adb25d749fc610b537c5c288e56226a2ad3d6\"\n }\n },\n \"url\": \"file:///build/reproducible-path/cockpit-316/tmp/wheel/cockpit-316-py3-none-any.whl\"\n }\n"}]}]}]}]}]}