--- /srv/reproducible-results/rbuild-debian/r-b-build.1Aue177E/b1/cockpit_319-1_armhf.changes
+++ /srv/reproducible-results/rbuild-debian/r-b-build.1Aue177E/b2/cockpit_319-1_armhf.changes
├── Files
│ @@ -1,10 +1,10 @@
│
│ 034b567b1aa5c0b712df7c69582115c4 138540 debug optional cockpit-bridge-dbgsym_319-1_armhf.deb
│ - f429ff2483019ab8bb2872c1086af774 356356 admin optional cockpit-bridge_319-1_armhf.deb
│ + c040ebe6c407f813cafd79042fe68df2 356756 admin optional cockpit-bridge_319-1_armhf.deb
│ f3de7834ba899560a10d26cec1515b22 132160 doc optional cockpit-doc_319-1_all.deb
│ 0d78da864e2350727c59928bb282cab5 832280 admin optional cockpit-networkmanager_319-1_all.deb
│ 54418c37ac86a8098b031ec312b2fff8 945804 admin optional cockpit-packagekit_319-1_all.deb
│ ae70b1f02abbc37eb4c451c35968e4d9 560952 admin optional cockpit-sosreport_319-1_all.deb
│ 09ec42a47220741ac1184b676f0277c1 889556 admin optional cockpit-storaged_319-1_all.deb
│ 83bfd3cebe1cfb5d1c97d424c5fdcdc2 3314380 admin optional cockpit-system_319-1_all.deb
│ 8546f7f0bdc3ec6a866bc837aa617439 4716 debug optional cockpit-tests-dbgsym_319-1_armhf.deb
├── cockpit-bridge_319-1_armhf.deb
│ ├── file list
│ │ @@ -1,3 +1,3 @@
│ │ -rw-r--r-- 0 0 0 4 2024-06-26 12:54:15.000000 debian-binary
│ │ -rw-r--r-- 0 0 0 3884 2024-06-26 12:54:15.000000 control.tar.xz
│ │ --rw-r--r-- 0 0 0 352280 2024-06-26 12:54:15.000000 data.tar.xz
│ │ +-rw-r--r-- 0 0 0 352680 2024-06-26 12:54:15.000000 data.tar.xz
│ ├── control.tar.xz
│ │ ├── control.tar
│ │ │ ├── ./md5sums
│ │ │ │ ├── ./md5sums
│ │ │ │ │┄ Files differ
│ ├── data.tar.xz
│ │ ├── data.tar
│ │ │ ├── file list
│ │ │ │ @@ -60,15 +60,15 @@
│ │ │ │ -rw-r--r-- 0 root (0) root (0) 6644 2024-06-26 12:54:15.000000 ./usr/lib/python3/dist-packages/cockpit/channels/metrics.py
│ │ │ │ -rw-r--r-- 0 root (0) root (0) 4051 2024-06-26 12:54:15.000000 ./usr/lib/python3/dist-packages/cockpit/channels/packages.py
│ │ │ │ -rw-r--r-- 0 root (0) root (0) 4872 2024-06-26 12:54:15.000000 ./usr/lib/python3/dist-packages/cockpit/channels/stream.py
│ │ │ │ -rw-r--r-- 0 root (0) root (0) 1187 2024-06-26 12:54:15.000000 ./usr/lib/python3/dist-packages/cockpit/channels/trivial.py
│ │ │ │ -rw-r--r-- 0 root (0) root (0) 3188 2024-06-26 12:54:15.000000 ./usr/lib/python3/dist-packages/cockpit/config.py
│ │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2024-06-26 12:54:15.000000 ./usr/lib/python3/dist-packages/cockpit/data/
│ │ │ │ -rw-r--r-- 0 root (0) root (0) 574 2024-06-26 12:54:15.000000 ./usr/lib/python3/dist-packages/cockpit/data/__init__.py
│ │ │ │ --rw-r--r-- 0 root (0) root (0) 87188 2024-06-26 12:54:15.000000 ./usr/lib/python3/dist-packages/cockpit/data/cockpit-bridge.beipack.xz
│ │ │ │ +-rw-r--r-- 0 root (0) root (0) 87568 2024-06-26 12:54:15.000000 ./usr/lib/python3/dist-packages/cockpit/data/cockpit-bridge.beipack.xz
│ │ │ │ -rw-r--r-- 0 root (0) root (0) 3212 2024-06-26 12:54:15.000000 ./usr/lib/python3/dist-packages/cockpit/data/fail.html
│ │ │ │ -rw-r--r-- 0 root (0) root (0) 5875 2024-06-26 12:54:15.000000 ./usr/lib/python3/dist-packages/cockpit/internal_endpoints.py
│ │ │ │ -rw-r--r-- 0 root (0) root (0) 7242 2024-06-26 12:54:15.000000 ./usr/lib/python3/dist-packages/cockpit/jsonutil.py
│ │ │ │ -rw-r--r-- 0 root (0) root (0) 21539 2024-06-26 12:54:15.000000 ./usr/lib/python3/dist-packages/cockpit/packages.py
│ │ │ │ -rw-r--r-- 0 root (0) root (0) 12729 2024-06-26 12:54:15.000000 ./usr/lib/python3/dist-packages/cockpit/peer.py
│ │ │ │ -rw-r--r-- 0 root (0) root (0) 7580 2024-06-26 12:54:15.000000 ./usr/lib/python3/dist-packages/cockpit/polkit.py
│ │ │ │ -rw-r--r-- 0 root (0) root (0) 2031 2024-06-26 12:54:15.000000 ./usr/lib/python3/dist-packages/cockpit/polyfills.py
│ │ │ ├── ./usr/lib/python3/dist-packages/cockpit/data/cockpit-bridge.beipack.xz
│ │ │ │ ├── cockpit-bridge.beipack
│ │ │ │ │┄ Ordering differences only
│ │ │ │ │ @@ -64,14 +64,2335 @@
│ │ │ │ │ ) -> Optional[importlib.machinery.ModuleSpec]:
│ │ │ │ │ if fullname not in self.modules:
│ │ │ │ │ return None
│ │ │ │ │ return importlib.util.spec_from_loader(fullname, self)
│ │ │ │ │
│ │ │ │ │ import sys
│ │ │ │ │ sys.meta_path.insert(0, BeipackLoader({
│ │ │ │ │ + 'cockpit/router.py': br'''# This file is part of Cockpit.
│ │ │ │ │ +#
│ │ │ │ │ +# Copyright (C) 2022 Red Hat, Inc.
│ │ │ │ │ +#
│ │ │ │ │ +# This program is free software: you can redistribute it and/or modify
│ │ │ │ │ +# it under the terms of the GNU General Public License as published by
│ │ │ │ │ +# the Free Software Foundation, either version 3 of the License, or
│ │ │ │ │ +# (at your option) any later version.
│ │ │ │ │ +#
│ │ │ │ │ +# This program is distributed in the hope that it will be useful,
│ │ │ │ │ +# but WITHOUT ANY WARRANTY; without even the implied warranty of
│ │ │ │ │ +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
│ │ │ │ │ +# GNU General Public License for more details.
│ │ │ │ │ +#
│ │ │ │ │ +# You should have received a copy of the GNU General Public License
│ │ │ │ │ +# along with this program. If not, see .
│ │ │ │ │ +
│ │ │ │ │ +import asyncio
│ │ │ │ │ +import collections
│ │ │ │ │ +import logging
│ │ │ │ │ +from typing import Dict, List, Optional
│ │ │ │ │ +
│ │ │ │ │ +from .jsonutil import JsonObject, JsonValue
│ │ │ │ │ +from .protocol import CockpitProblem, CockpitProtocolError, CockpitProtocolServer
│ │ │ │ │ +
│ │ │ │ │ +logger = logging.getLogger(__name__)
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class ExecutionQueue:
│ │ │ │ │ + """Temporarily delay calls to a given set of class methods.
│ │ │ │ │ +
│ │ │ │ │ + Functions by replacing the named function at the instance __dict__
│ │ │ │ │ + level, effectively providing an override for exactly one instance
│ │ │ │ │ + of `method`'s object.
│ │ │ │ │ + Queues the invocations. Run them later with .run(), which also reverses
│ │ │ │ │ + the redirection by deleting the named methods from the instance.
│ │ │ │ │ + """
│ │ │ │ │ + def __init__(self, methods):
│ │ │ │ │ + self.queue = collections.deque()
│ │ │ │ │ + self.methods = methods
│ │ │ │ │ +
│ │ │ │ │ + for method in self.methods:
│ │ │ │ │ + self._wrap(method)
│ │ │ │ │ +
│ │ │ │ │ + def _wrap(self, method):
│ │ │ │ │ + # NB: this function is stored in the instance dict and therefore
│ │ │ │ │ + # doesn't function as a descriptor, isn't a method, doesn't get bound,
│ │ │ │ │ + # and therefore doesn't receive a self parameter
│ │ │ │ │ + setattr(method.__self__, method.__func__.__name__, lambda *args: self.queue.append((method, args)))
│ │ │ │ │ +
│ │ │ │ │ + def run(self):
│ │ │ │ │ + logger.debug('ExecutionQueue: Running %d queued method calls', len(self.queue))
│ │ │ │ │ + for method, args in self.queue:
│ │ │ │ │ + method(*args)
│ │ │ │ │ +
│ │ │ │ │ + for method in self.methods:
│ │ │ │ │ + delattr(method.__self__, method.__func__.__name__)
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class Endpoint:
│ │ │ │ │ + router: 'Router'
│ │ │ │ │ + __endpoint_frozen_queue: Optional[ExecutionQueue] = None
│ │ │ │ │ +
│ │ │ │ │ + def __init__(self, router: 'Router'):
│ │ │ │ │ + router.add_endpoint(self)
│ │ │ │ │ + self.router = router
│ │ │ │ │ +
│ │ │ │ │ + def freeze_endpoint(self):
│ │ │ │ │ + assert self.__endpoint_frozen_queue is None
│ │ │ │ │ + logger.debug('Freezing endpoint %s', self)
│ │ │ │ │ + self.__endpoint_frozen_queue = ExecutionQueue({self.do_channel_control, self.do_channel_data, self.do_kill})
│ │ │ │ │ +
│ │ │ │ │ + def thaw_endpoint(self):
│ │ │ │ │ + assert self.__endpoint_frozen_queue is not None
│ │ │ │ │ + logger.debug('Thawing endpoint %s', self)
│ │ │ │ │ + self.__endpoint_frozen_queue.run()
│ │ │ │ │ + self.__endpoint_frozen_queue = None
│ │ │ │ │ +
│ │ │ │ │ + # interface for receiving messages
│ │ │ │ │ + def do_close(self):
│ │ │ │ │ + raise NotImplementedError
│ │ │ │ │ +
│ │ │ │ │ + def do_channel_control(self, channel: str, command: str, message: JsonObject) -> None:
│ │ │ │ │ + raise NotImplementedError
│ │ │ │ │ +
│ │ │ │ │ + def do_channel_data(self, channel: str, data: bytes) -> None:
│ │ │ │ │ + raise NotImplementedError
│ │ │ │ │ +
│ │ │ │ │ + def do_kill(self, host: 'str | None', group: 'str | None', message: JsonObject) -> None:
│ │ │ │ │ + raise NotImplementedError
│ │ │ │ │ +
│ │ │ │ │ + # interface for sending messages
│ │ │ │ │ + def send_channel_data(self, channel: str, data: bytes) -> None:
│ │ │ │ │ + self.router.write_channel_data(channel, data)
│ │ │ │ │ +
│ │ │ │ │ + def send_channel_control(
│ │ │ │ │ + self, channel: str, command: str, _msg: 'JsonObject | None', **kwargs: JsonValue
│ │ │ │ │ + ) -> None:
│ │ │ │ │ + self.router.write_control(_msg, channel=channel, command=command, **kwargs)
│ │ │ │ │ + if command == 'close':
│ │ │ │ │ + self.router.endpoints[self].remove(channel)
│ │ │ │ │ + self.router.drop_channel(channel)
│ │ │ │ │ +
│ │ │ │ │ + def shutdown_endpoint(self, _msg: 'JsonObject | None' = None, **kwargs: JsonValue) -> None:
│ │ │ │ │ + self.router.shutdown_endpoint(self, _msg, **kwargs)
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class RoutingError(CockpitProblem):
│ │ │ │ │ + pass
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class RoutingRule:
│ │ │ │ │ + router: 'Router'
│ │ │ │ │ +
│ │ │ │ │ + def __init__(self, router: 'Router'):
│ │ │ │ │ + self.router = router
│ │ │ │ │ +
│ │ │ │ │ + def apply_rule(self, options: JsonObject) -> Optional[Endpoint]:
│ │ │ │ │ + """Check if a routing rule applies to a given 'open' message.
│ │ │ │ │ +
│ │ │ │ │ + This should inspect the options dictionary and do one of the following three things:
│ │ │ │ │ +
│ │ │ │ │ + - return an Endpoint to handle this channel
│ │ │ │ │ + - raise a RoutingError to indicate that the open should be rejected
│ │ │ │ │ + - return None to let the next rule run
│ │ │ │ │ + """
│ │ │ │ │ + raise NotImplementedError
│ │ │ │ │ +
│ │ │ │ │ + def shutdown(self):
│ │ │ │ │ + raise NotImplementedError
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class Router(CockpitProtocolServer):
│ │ │ │ │ + routing_rules: List[RoutingRule]
│ │ │ │ │ + open_channels: Dict[str, Endpoint]
│ │ │ │ │ + endpoints: 'dict[Endpoint, set[str]]'
│ │ │ │ │ + no_endpoints: asyncio.Event # set if endpoints dict is empty
│ │ │ │ │ + _eof: bool = False
│ │ │ │ │ +
│ │ │ │ │ + def __init__(self, routing_rules: List[RoutingRule]):
│ │ │ │ │ + for rule in routing_rules:
│ │ │ │ │ + rule.router = self
│ │ │ │ │ + self.routing_rules = routing_rules
│ │ │ │ │ + self.open_channels = {}
│ │ │ │ │ + self.endpoints = {}
│ │ │ │ │ + self.no_endpoints = asyncio.Event()
│ │ │ │ │ + self.no_endpoints.set() # at first there are no endpoints
│ │ │ │ │ +
│ │ │ │ │ + def check_rules(self, options: JsonObject) -> Endpoint:
│ │ │ │ │ + for rule in self.routing_rules:
│ │ │ │ │ + logger.debug(' applying rule %s', rule)
│ │ │ │ │ + endpoint = rule.apply_rule(options)
│ │ │ │ │ + if endpoint is not None:
│ │ │ │ │ + logger.debug(' resulting endpoint is %s', endpoint)
│ │ │ │ │ + return endpoint
│ │ │ │ │ + else:
│ │ │ │ │ + logger.debug(' No rules matched')
│ │ │ │ │ + raise RoutingError('not-supported')
│ │ │ │ │ +
│ │ │ │ │ + def drop_channel(self, channel: str) -> None:
│ │ │ │ │ + try:
│ │ │ │ │ + self.open_channels.pop(channel)
│ │ │ │ │ + logger.debug('router dropped channel %s', channel)
│ │ │ │ │ + except KeyError:
│ │ │ │ │ + logger.error('trying to drop non-existent channel %s from %s', channel, self.open_channels)
│ │ │ │ │ +
│ │ │ │ │ + def add_endpoint(self, endpoint: Endpoint) -> None:
│ │ │ │ │ + self.endpoints[endpoint] = set()
│ │ │ │ │ + self.no_endpoints.clear()
│ │ │ │ │ +
│ │ │ │ │ + def shutdown_endpoint(self, endpoint: Endpoint, _msg: 'JsonObject | None' = None, **kwargs: JsonValue) -> None:
│ │ │ │ │ + channels = self.endpoints.pop(endpoint)
│ │ │ │ │ + logger.debug('shutdown_endpoint(%s, %s) will close %s', endpoint, kwargs, channels)
│ │ │ │ │ + for channel in channels:
│ │ │ │ │ + self.write_control(_msg, command='close', channel=channel, **kwargs)
│ │ │ │ │ + self.drop_channel(channel)
│ │ │ │ │ +
│ │ │ │ │ + if not self.endpoints:
│ │ │ │ │ + self.no_endpoints.set()
│ │ │ │ │ +
│ │ │ │ │ + # were we waiting to exit?
│ │ │ │ │ + if self._eof:
│ │ │ │ │ + logger.debug(' endpoints remaining: %r', self.endpoints)
│ │ │ │ │ + if not self.endpoints and self.transport:
│ │ │ │ │ + logger.debug(' close transport')
│ │ │ │ │ + self.transport.close()
│ │ │ │ │ +
│ │ │ │ │ + def do_kill(self, host: 'str | None', group: 'str | None', message: JsonObject) -> None:
│ │ │ │ │ + endpoints = set(self.endpoints)
│ │ │ │ │ + logger.debug('do_kill(%s, %s). Considering %d endpoints.', host, group, len(endpoints))
│ │ │ │ │ + for endpoint in endpoints:
│ │ │ │ │ + endpoint.do_kill(host, group, message)
│ │ │ │ │ +
│ │ │ │ │ + def channel_control_received(self, channel: str, command: str, message: JsonObject) -> None:
│ │ │ │ │ + # If this is an open message then we need to apply the routing rules to
│ │ │ │ │ + # figure out the correct endpoint to connect. If it's not an open
│ │ │ │ │ + # message, then we expect the endpoint to already exist.
│ │ │ │ │ + if command == 'open':
│ │ │ │ │ + if channel in self.open_channels:
│ │ │ │ │ + raise CockpitProtocolError('channel is already open')
│ │ │ │ │ +
│ │ │ │ │ + try:
│ │ │ │ │ + logger.debug('Trying to find endpoint for new channel %s payload=%s', channel, message.get('payload'))
│ │ │ │ │ + endpoint = self.check_rules(message)
│ │ │ │ │ + except RoutingError as exc:
│ │ │ │ │ + self.write_control(exc.get_attrs(), command='close', channel=channel)
│ │ │ │ │ + return
│ │ │ │ │ +
│ │ │ │ │ + self.open_channels[channel] = endpoint
│ │ │ │ │ + self.endpoints[endpoint].add(channel)
│ │ │ │ │ + else:
│ │ │ │ │ + try:
│ │ │ │ │ + endpoint = self.open_channels[channel]
│ │ │ │ │ + except KeyError:
│ │ │ │ │ + # sending to a non-existent channel can happen due to races and is not an error
│ │ │ │ │ + return
│ │ │ │ │ +
│ │ │ │ │ + # At this point, we have the endpoint. Route the message.
│ │ │ │ │ + endpoint.do_channel_control(channel, command, message)
│ │ │ │ │ +
│ │ │ │ │ + def channel_data_received(self, channel: str, data: bytes) -> None:
│ │ │ │ │ + try:
│ │ │ │ │ + endpoint = self.open_channels[channel]
│ │ │ │ │ + except KeyError:
│ │ │ │ │ + return
│ │ │ │ │ +
│ │ │ │ │ + endpoint.do_channel_data(channel, data)
│ │ │ │ │ +
│ │ │ │ │ + def eof_received(self) -> bool:
│ │ │ │ │ + logger.debug('eof_received(%r)', self)
│ │ │ │ │ +
│ │ │ │ │ + endpoints = set(self.endpoints)
│ │ │ │ │ + for endpoint in endpoints:
│ │ │ │ │ + endpoint.do_close()
│ │ │ │ │ +
│ │ │ │ │ + self._eof = True
│ │ │ │ │ + logger.debug(' endpoints remaining: %r', self.endpoints)
│ │ │ │ │ + return bool(self.endpoints)
│ │ │ │ │ +
│ │ │ │ │ + _communication_done: Optional[asyncio.Future] = None
│ │ │ │ │ +
│ │ │ │ │ + def do_closed(self, exc: Optional[Exception]) -> None:
│ │ │ │ │ + # If we didn't send EOF yet, do it now.
│ │ │ │ │ + if not self._eof:
│ │ │ │ │ + self.eof_received()
│ │ │ │ │ +
│ │ │ │ │ + if self._communication_done is not None:
│ │ │ │ │ + if exc is None:
│ │ │ │ │ + self._communication_done.set_result(None)
│ │ │ │ │ + else:
│ │ │ │ │ + self._communication_done.set_exception(exc)
│ │ │ │ │ +
│ │ │ │ │ + async def communicate(self) -> None:
│ │ │ │ │ + """Wait until communication is complete on the router and all endpoints are done."""
│ │ │ │ │ + assert self._communication_done is None
│ │ │ │ │ + self._communication_done = asyncio.get_running_loop().create_future()
│ │ │ │ │ + try:
│ │ │ │ │ + await self._communication_done
│ │ │ │ │ + except (BrokenPipeError, ConnectionResetError):
│ │ │ │ │ + pass # these are normal occurrences when closed from the other side
│ │ │ │ │ + finally:
│ │ │ │ │ + self._communication_done = None
│ │ │ │ │ +
│ │ │ │ │ + # In an orderly exit, this is already done, but in case it wasn't
│ │ │ │ │ + # orderly, we need to make sure the endpoints shut down anyway...
│ │ │ │ │ + await self.no_endpoints.wait()
│ │ │ │ │ +''',
│ │ │ │ │ + 'cockpit/peer.py': r'''# This file is part of Cockpit.
│ │ │ │ │ +#
│ │ │ │ │ +# Copyright (C) 2022 Red Hat, Inc.
│ │ │ │ │ +#
│ │ │ │ │ +# This program is free software: you can redistribute it and/or modify
│ │ │ │ │ +# it under the terms of the GNU General Public License as published by
│ │ │ │ │ +# the Free Software Foundation, either version 3 of the License, or
│ │ │ │ │ +# (at your option) any later version.
│ │ │ │ │ +#
│ │ │ │ │ +# This program is distributed in the hope that it will be useful,
│ │ │ │ │ +# but WITHOUT ANY WARRANTY; without even the implied warranty of
│ │ │ │ │ +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
│ │ │ │ │ +# GNU General Public License for more details.
│ │ │ │ │ +#
│ │ │ │ │ +# You should have received a copy of the GNU General Public License
│ │ │ │ │ +# along with this program. If not, see .
│ │ │ │ │ +
│ │ │ │ │ +import asyncio
│ │ │ │ │ +import logging
│ │ │ │ │ +import os
│ │ │ │ │ +from typing import Callable, List, Optional, Sequence
│ │ │ │ │ +
│ │ │ │ │ +from .jsonutil import JsonObject, JsonValue
│ │ │ │ │ +from .packages import BridgeConfig
│ │ │ │ │ +from .protocol import CockpitProblem, CockpitProtocol, CockpitProtocolError
│ │ │ │ │ +from .router import Endpoint, Router, RoutingRule
│ │ │ │ │ +from .transports import SubprocessProtocol, SubprocessTransport
│ │ │ │ │ +
│ │ │ │ │ +logger = logging.getLogger(__name__)
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class PeerError(CockpitProblem):
│ │ │ │ │ + pass
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class PeerExited(Exception):
│ │ │ │ │ + def __init__(self, exit_code: int):
│ │ │ │ │ + self.exit_code = exit_code
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class Peer(CockpitProtocol, SubprocessProtocol, Endpoint):
│ │ │ │ │ + done_callbacks: List[Callable[[], None]]
│ │ │ │ │ + init_future: Optional[asyncio.Future]
│ │ │ │ │ +
│ │ │ │ │ + def __init__(self, router: Router):
│ │ │ │ │ + super().__init__(router)
│ │ │ │ │ +
│ │ │ │ │ + # All Peers start out frozen — we only unfreeze after we see the first 'init' message
│ │ │ │ │ + self.freeze_endpoint()
│ │ │ │ │ +
│ │ │ │ │ + self.init_future = asyncio.get_running_loop().create_future()
│ │ │ │ │ + self.done_callbacks = []
│ │ │ │ │ +
│ │ │ │ │ + # Initialization
│ │ │ │ │ + async def do_connect_transport(self) -> None:
│ │ │ │ │ + raise NotImplementedError
│ │ │ │ │ +
│ │ │ │ │ + async def spawn(self, argv: Sequence[str], env: Sequence[str], **kwargs) -> asyncio.Transport:
│ │ │ │ │ + # Not actually async...
│ │ │ │ │ + loop = asyncio.get_running_loop()
│ │ │ │ │ + user_env = dict(e.split('=', 1) for e in env)
│ │ │ │ │ + return SubprocessTransport(loop, self, argv, env=dict(os.environ, **user_env), **kwargs)
│ │ │ │ │ +
│ │ │ │ │ + async def start(self, init_host: Optional[str] = None, **kwargs: JsonValue) -> JsonObject:
│ │ │ │ │ + """Request that the Peer is started and connected to the router.
│ │ │ │ │ +
│ │ │ │ │ + Creates the transport, connects it to the protocol, and participates in
│ │ │ │ │ + exchanging of init messages. If anything goes wrong, the connection
│ │ │ │ │ + will be closed and an exception will be raised.
│ │ │ │ │ +
│ │ │ │ │ + The Peer starts out in a frozen state (ie: attempts to send messages to
│ │ │ │ │ + it will initially be queued). If init_host is not None then an init
│ │ │ │ │ + message is sent with the given 'host' field, plus any extra kwargs, and
│ │ │ │ │ + the queue is thawed. Otherwise, the caller is responsible for sending
│ │ │ │ │ + the init message and thawing the peer.
│ │ │ │ │ +
│ │ │ │ │ + In any case, the return value is the init message from the peer.
│ │ │ │ │ + """
│ │ │ │ │ + assert self.init_future is not None
│ │ │ │ │ +
│ │ │ │ │ + def _connect_task_done(task: asyncio.Task) -> None:
│ │ │ │ │ + assert task is connect_task
│ │ │ │ │ + try:
│ │ │ │ │ + task.result()
│ │ │ │ │ + except asyncio.CancelledError: # we did that (below)
│ │ │ │ │ + pass # we want to ignore it
│ │ │ │ │ + except Exception as exc:
│ │ │ │ │ + self.close(exc)
│ │ │ │ │ +
│ │ │ │ │ + connect_task = asyncio.create_task(self.do_connect_transport())
│ │ │ │ │ + connect_task.add_done_callback(_connect_task_done)
│ │ │ │ │ +
│ │ │ │ │ + try:
│ │ │ │ │ + # Wait for something to happen:
│ │ │ │ │ + # - exception from our connection function
│ │ │ │ │ + # - receiving "init" from the other side
│ │ │ │ │ + # - receiving EOF from the other side
│ │ │ │ │ + # - .close() was called
│ │ │ │ │ + # - other transport exception
│ │ │ │ │ + init_message = await self.init_future
│ │ │ │ │ +
│ │ │ │ │ + except (PeerExited, BrokenPipeError):
│ │ │ │ │ + # These are fairly generic errors. PeerExited means that we observed the process exiting.
│ │ │ │ │ + # BrokenPipeError means that we got EPIPE when attempting to write() to it. In both cases,
│ │ │ │ │ + # the process is gone, but it's not clear why. If the connection process is still running,
│ │ │ │ │ + # perhaps we'd get a better error message from it.
│ │ │ │ │ + await connect_task
│ │ │ │ │ + # Otherwise, re-raise
│ │ │ │ │ + raise
│ │ │ │ │ +
│ │ │ │ │ + finally:
│ │ │ │ │ + self.init_future = None
│ │ │ │ │ +
│ │ │ │ │ + # In any case (failure or success) make sure this is done.
│ │ │ │ │ + if not connect_task.done():
│ │ │ │ │ + connect_task.cancel()
│ │ │ │ │ +
│ │ │ │ │ + if init_host is not None:
│ │ │ │ │ + logger.debug(' sending init message back, host %s', init_host)
│ │ │ │ │ + # Send "init" back
│ │ │ │ │ + self.write_control(None, command='init', version=1, host=init_host, **kwargs)
│ │ │ │ │ +
│ │ │ │ │ + # Thaw the queued messages
│ │ │ │ │ + self.thaw_endpoint()
│ │ │ │ │ +
│ │ │ │ │ + return init_message
│ │ │ │ │ +
│ │ │ │ │ + # Background initialization
│ │ │ │ │ + def start_in_background(self, init_host: Optional[str] = None, **kwargs: JsonValue) -> None:
│ │ │ │ │ + def _start_task_done(task: asyncio.Task) -> None:
│ │ │ │ │ + assert task is start_task
│ │ │ │ │ +
│ │ │ │ │ + try:
│ │ │ │ │ + task.result()
│ │ │ │ │ + except (OSError, PeerExited, CockpitProblem, asyncio.CancelledError):
│ │ │ │ │ + pass # Those are expected. Others will throw.
│ │ │ │ │ +
│ │ │ │ │ + start_task = asyncio.create_task(self.start(init_host, **kwargs))
│ │ │ │ │ + start_task.add_done_callback(_start_task_done)
│ │ │ │ │ +
│ │ │ │ │ + # Shutdown
│ │ │ │ │ + def add_done_callback(self, callback: Callable[[], None]) -> None:
│ │ │ │ │ + self.done_callbacks.append(callback)
│ │ │ │ │ +
│ │ │ │ │ + # Handling of interesting events
│ │ │ │ │ + def do_superuser_init_done(self) -> None:
│ │ │ │ │ + pass
│ │ │ │ │ +
│ │ │ │ │ + def do_authorize(self, message: JsonObject) -> None:
│ │ │ │ │ + pass
│ │ │ │ │ +
│ │ │ │ │ + def transport_control_received(self, command: str, message: JsonObject) -> None:
│ │ │ │ │ + if command == 'init' and self.init_future is not None:
│ │ │ │ │ + logger.debug('Got init message with active init_future. Setting result.')
│ │ │ │ │ + self.init_future.set_result(message)
│ │ │ │ │ + elif command == 'authorize':
│ │ │ │ │ + self.do_authorize(message)
│ │ │ │ │ + elif command == 'superuser-init-done':
│ │ │ │ │ + self.do_superuser_init_done()
│ │ │ │ │ + else:
│ │ │ │ │ + raise CockpitProtocolError(f'Received unexpected control message {command}')
│ │ │ │ │ +
│ │ │ │ │ + def eof_received(self) -> bool:
│ │ │ │ │ + # We always expect to be the ones to close the connection, so if we get
│ │ │ │ │ + # an EOF, then we consider it to be an error. This allows us to
│ │ │ │ │ + # distinguish close caused by unexpected EOF (but no errno from a
│ │ │ │ │ + # syscall failure) vs. close caused by calling .close() on our side.
│ │ │ │ │ + # The process is still running at this point, so keep it and handle
│ │ │ │ │ + # the error in process_exited().
│ │ │ │ │ + logger.debug('Peer %s received unexpected EOF', self.__class__.__name__)
│ │ │ │ │ + return True
│ │ │ │ │ +
│ │ │ │ │ + def do_closed(self, exc: Optional[Exception]) -> None:
│ │ │ │ │ + logger.debug('Peer %s connection lost %s %s', self.__class__.__name__, type(exc), exc)
│ │ │ │ │ +
│ │ │ │ │ + if exc is None:
│ │ │ │ │ + self.shutdown_endpoint(problem='terminated')
│ │ │ │ │ + elif isinstance(exc, PeerExited):
│ │ │ │ │ + # a common case is that the called peer does not exist
│ │ │ │ │ + if exc.exit_code == 127:
│ │ │ │ │ + self.shutdown_endpoint(problem='no-cockpit')
│ │ │ │ │ + else:
│ │ │ │ │ + self.shutdown_endpoint(problem='terminated', message=f'Peer exited with status {exc.exit_code}')
│ │ │ │ │ + elif isinstance(exc, CockpitProblem):
│ │ │ │ │ + self.shutdown_endpoint(exc.attrs)
│ │ │ │ │ + else:
│ │ │ │ │ + self.shutdown_endpoint(problem='internal-error',
│ │ │ │ │ + message=f"[{exc.__class__.__name__}] {exc!s}")
│ │ │ │ │ +
│ │ │ │ │ + # If .start() is running, we need to make sure it stops running,
│ │ │ │ │ + # raising the correct exception.
│ │ │ │ │ + if self.init_future is not None and not self.init_future.done():
│ │ │ │ │ + if exc is not None:
│ │ │ │ │ + self.init_future.set_exception(exc)
│ │ │ │ │ + else:
│ │ │ │ │ + self.init_future.cancel()
│ │ │ │ │ +
│ │ │ │ │ + for callback in self.done_callbacks:
│ │ │ │ │ + callback()
│ │ │ │ │ +
│ │ │ │ │ + def process_exited(self) -> None:
│ │ │ │ │ + assert isinstance(self.transport, SubprocessTransport)
│ │ │ │ │ + logger.debug('Peer %s exited, status %d', self.__class__.__name__, self.transport.get_returncode())
│ │ │ │ │ + returncode = self.transport.get_returncode()
│ │ │ │ │ + assert isinstance(returncode, int)
│ │ │ │ │ + self.close(PeerExited(returncode))
│ │ │ │ │ +
│ │ │ │ │ + # Forwarding data: from the peer to the router
│ │ │ │ │ + def channel_control_received(self, channel: str, command: str, message: JsonObject) -> None:
│ │ │ │ │ + if self.init_future is not None:
│ │ │ │ │ + raise CockpitProtocolError('Received unexpected channel control message before init')
│ │ │ │ │ + self.send_channel_control(channel, command, message)
│ │ │ │ │ +
│ │ │ │ │ + def channel_data_received(self, channel: str, data: bytes) -> None:
│ │ │ │ │ + if self.init_future is not None:
│ │ │ │ │ + raise CockpitProtocolError('Received unexpected channel data before init')
│ │ │ │ │ + self.send_channel_data(channel, data)
│ │ │ │ │ +
│ │ │ │ │ + # Forwarding data: from the router to the peer
│ │ │ │ │ + def do_channel_control(self, channel: str, command: str, message: JsonObject) -> None:
│ │ │ │ │ + assert self.init_future is None
│ │ │ │ │ + self.write_control(message)
│ │ │ │ │ +
│ │ │ │ │ + def do_channel_data(self, channel: str, data: bytes) -> None:
│ │ │ │ │ + assert self.init_future is None
│ │ │ │ │ + self.write_channel_data(channel, data)
│ │ │ │ │ +
│ │ │ │ │ + def do_kill(self, host: 'str | None', group: 'str | None', message: JsonObject) -> None:
│ │ │ │ │ + assert self.init_future is None
│ │ │ │ │ + self.write_control(message)
│ │ │ │ │ +
│ │ │ │ │ + def do_close(self) -> None:
│ │ │ │ │ + self.close()
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class ConfiguredPeer(Peer):
│ │ │ │ │ + config: BridgeConfig
│ │ │ │ │ + args: Sequence[str]
│ │ │ │ │ + env: Sequence[str]
│ │ │ │ │ +
│ │ │ │ │ + def __init__(self, router: Router, config: BridgeConfig):
│ │ │ │ │ + self.config = config
│ │ │ │ │ + self.args = config.spawn
│ │ │ │ │ + self.env = config.environ
│ │ │ │ │ + super().__init__(router)
│ │ │ │ │ +
│ │ │ │ │ + async def do_connect_transport(self) -> None:
│ │ │ │ │ + await self.spawn(self.args, self.env)
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class PeerRoutingRule(RoutingRule):
│ │ │ │ │ + config: BridgeConfig
│ │ │ │ │ + match: JsonObject
│ │ │ │ │ + peer: Optional[Peer]
│ │ │ │ │ +
│ │ │ │ │ + def __init__(self, router: Router, config: BridgeConfig):
│ │ │ │ │ + super().__init__(router)
│ │ │ │ │ + self.config = config
│ │ │ │ │ + self.match = config.match
│ │ │ │ │ + self.peer = None
│ │ │ │ │ +
│ │ │ │ │ + def apply_rule(self, options: JsonObject) -> Optional[Peer]:
│ │ │ │ │ + # Check that we match
│ │ │ │ │ +
│ │ │ │ │ + for key, value in self.match.items():
│ │ │ │ │ + if key not in options:
│ │ │ │ │ + logger.debug(' rejecting because key %s is missing', key)
│ │ │ │ │ + return None
│ │ │ │ │ + if value is not None and options[key] != value:
│ │ │ │ │ + logger.debug(' rejecting because key %s has wrong value %s (vs %s)', key, options[key], value)
│ │ │ │ │ + return None
│ │ │ │ │ +
│ │ │ │ │ + # Start the peer if it's not running already
│ │ │ │ │ + if self.peer is None:
│ │ │ │ │ + self.peer = ConfiguredPeer(self.router, self.config)
│ │ │ │ │ + self.peer.add_done_callback(self.peer_closed)
│ │ │ │ │ + assert self.router.init_host
│ │ │ │ │ + self.peer.start_in_background(init_host=self.router.init_host)
│ │ │ │ │ +
│ │ │ │ │ + return self.peer
│ │ │ │ │ +
│ │ │ │ │ + def peer_closed(self):
│ │ │ │ │ + self.peer = None
│ │ │ │ │ +
│ │ │ │ │ + def shutdown(self):
│ │ │ │ │ + if self.peer is not None:
│ │ │ │ │ + self.peer.close()
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class PeersRoutingRule(RoutingRule):
│ │ │ │ │ + rules: List[PeerRoutingRule] = []
│ │ │ │ │ +
│ │ │ │ │ + def apply_rule(self, options: JsonObject) -> Optional[Endpoint]:
│ │ │ │ │ + logger.debug(' considering %d rules', len(self.rules))
│ │ │ │ │ + for rule in self.rules:
│ │ │ │ │ + logger.debug(' considering %s', rule.config.name)
│ │ │ │ │ + endpoint = rule.apply_rule(options)
│ │ │ │ │ + if endpoint is not None:
│ │ │ │ │ + logger.debug(' selected')
│ │ │ │ │ + return endpoint
│ │ │ │ │ + logger.debug(' no peer rules matched')
│ │ │ │ │ + return None
│ │ │ │ │ +
│ │ │ │ │ + def set_configs(self, bridge_configs: Sequence[BridgeConfig]) -> None:
│ │ │ │ │ + old_rules = self.rules
│ │ │ │ │ + self.rules = []
│ │ │ │ │ +
│ │ │ │ │ + for config in bridge_configs:
│ │ │ │ │ + # Those are handled elsewhere...
│ │ │ │ │ + if config.privileged or 'host' in config.match:
│ │ │ │ │ + continue
│ │ │ │ │ +
│ │ │ │ │ + # Try to reuse an existing rule, if one exists...
│ │ │ │ │ + for rule in list(old_rules):
│ │ │ │ │ + if rule.config == config:
│ │ │ │ │ + old_rules.remove(rule)
│ │ │ │ │ + break
│ │ │ │ │ + else:
│ │ │ │ │ + # ... otherwise, create a new one.
│ │ │ │ │ + rule = PeerRoutingRule(self.router, config)
│ │ │ │ │ +
│ │ │ │ │ + self.rules.append(rule)
│ │ │ │ │ +
│ │ │ │ │ + # close down the old rules that didn't get reclaimed
│ │ │ │ │ + for rule in old_rules:
│ │ │ │ │ + rule.shutdown()
│ │ │ │ │ +
│ │ │ │ │ + def shutdown(self):
│ │ │ │ │ + for rule in self.rules:
│ │ │ │ │ + rule.shutdown()
│ │ │ │ │ +'''.encode('utf-8'),
│ │ │ │ │ + 'cockpit/polkit.py': r'''# This file is part of Cockpit.
│ │ │ │ │ +#
│ │ │ │ │ +# Copyright (C) 2023 Red Hat, Inc.
│ │ │ │ │ +#
│ │ │ │ │ +# This program is free software: you can redistribute it and/or modify
│ │ │ │ │ +# it under the terms of the GNU General Public License as published by
│ │ │ │ │ +# the Free Software Foundation, either version 3 of the License, or
│ │ │ │ │ +# (at your option) any later version.
│ │ │ │ │ +#
│ │ │ │ │ +# This program is distributed in the hope that it will be useful,
│ │ │ │ │ +# but WITHOUT ANY WARRANTY; without even the implied warranty of
│ │ │ │ │ +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
│ │ │ │ │ +# GNU General Public License for more details.
│ │ │ │ │ +#
│ │ │ │ │ +# You should have received a copy of the GNU General Public License
│ │ │ │ │ +# along with this program. If not, see .
│ │ │ │ │ +
│ │ │ │ │ +import asyncio
│ │ │ │ │ +import locale
│ │ │ │ │ +import logging
│ │ │ │ │ +import os
│ │ │ │ │ +import pwd
│ │ │ │ │ +from typing import Dict, List, Sequence, Tuple
│ │ │ │ │ +
│ │ │ │ │ +from cockpit._vendor.ferny import AskpassHandler
│ │ │ │ │ +from cockpit._vendor.systemd_ctypes import Variant, bus
│ │ │ │ │ +
│ │ │ │ │ +# that path is valid on at least Debian, Fedora/RHEL, and Arch
│ │ │ │ │ +HELPER_PATH = '/usr/lib/polkit-1/polkit-agent-helper-1'
│ │ │ │ │ +
│ │ │ │ │ +AGENT_DBUS_PATH = '/PolkitAgent'
│ │ │ │ │ +
│ │ │ │ │ +logger = logging.getLogger(__name__)
│ │ │ │ │ +
│ │ │ │ │ +Identity = Tuple[str, Dict[str, Variant]]
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +# https://www.freedesktop.org/software/polkit/docs/latest/eggdbus-interface-org.freedesktop.PolicyKit1.AuthenticationAgent.html
│ │ │ │ │ +
│ │ │ │ │ +# Note that we don't implement the CancelAuthentication() API. pkexec gets called in a way that has no opportunity to
│ │ │ │ │ +# cancel an ongoing authentication from the pkexec side. On the UI side cancellation is implemented via the standard
│ │ │ │ │ +# asyncio process mechanism. If we ever need CancelAuthentication(), we could keep a cookie → get_current_task()
│ │ │ │ │ +# mapping, but that method is not available for Python 3.6 yet.
│ │ │ │ │ +
│ │ │ │ │ +class org_freedesktop_PolicyKit1_AuthenticationAgent(bus.Object):
│ │ │ │ │ + def __init__(self, responder: AskpassHandler):
│ │ │ │ │ + super().__init__()
│ │ │ │ │ + self.responder = responder
│ │ │ │ │ +
│ │ │ │ │ + # confusingly named: this actually does the whole authentication dialog, see docs
│ │ │ │ │ + @bus.Interface.Method('', ['s', 's', 's', 'a{ss}', 's', 'a(sa{sv})'])
│ │ │ │ │ + async def begin_authentication(self, action_id: str, message: str, icon_name: str,
│ │ │ │ │ + details: Dict[str, str], cookie: str, identities: Sequence[Identity]) -> None:
│ │ │ │ │ + logger.debug('BeginAuthentication: action %s, message "%s", icon %s, details %s, cookie %s, identities %r',
│ │ │ │ │ + action_id, message, icon_name, details, cookie, identities)
│ │ │ │ │ + # only support authentication as ourselves, as we don't yet have the
│ │ │ │ │ + # protocol plumbing and UI to select an admin user
│ │ │ │ │ + my_uid = os.geteuid()
│ │ │ │ │ + for (auth_type, subject) in identities:
│ │ │ │ │ + if auth_type == 'unix-user' and 'uid' in subject and subject['uid'].value == my_uid:
│ │ │ │ │ + logger.debug('Authentication subject %s matches our uid %d', subject, my_uid)
│ │ │ │ │ + break
│ │ │ │ │ + else:
│ │ │ │ │ + logger.warning('Not supporting authentication as any of %s', identities)
│ │ │ │ │ + return
│ │ │ │ │ +
│ │ │ │ │ + user_name = pwd.getpwuid(my_uid).pw_name
│ │ │ │ │ + process = await asyncio.create_subprocess_exec(HELPER_PATH, user_name, cookie,
│ │ │ │ │ + stdin=asyncio.subprocess.PIPE,
│ │ │ │ │ + stdout=asyncio.subprocess.PIPE)
│ │ │ │ │ + try:
│ │ │ │ │ + await self._communicate(process)
│ │ │ │ │ + except asyncio.CancelledError:
│ │ │ │ │ + logger.debug('Cancelled authentication')
│ │ │ │ │ + process.terminate()
│ │ │ │ │ + finally:
│ │ │ │ │ + res = await process.wait()
│ │ │ │ │ + logger.debug('helper exited with code %i', res)
│ │ │ │ │ +
│ │ │ │ │ + async def _communicate(self, process: asyncio.subprocess.Process) -> None:
│ │ │ │ │ + assert process.stdin
│ │ │ │ │ + assert process.stdout
│ │ │ │ │ +
│ │ │ │ │ + messages: List[str] = []
│ │ │ │ │ +
│ │ │ │ │ + async for line in process.stdout:
│ │ │ │ │ + logger.debug('Read line from helper: %s', line)
│ │ │ │ │ + command, _, value = line.strip().decode().partition(' ')
│ │ │ │ │ +
│ │ │ │ │ + # usually: PAM_PROMPT_ECHO_OFF Password: \n
│ │ │ │ │ + if command.startswith('PAM_PROMPT'):
│ │ │ │ │ + # Don't pass this to the UI if it's "Password" (the usual case),
│ │ │ │ │ + # so that superuser.py uses the translated default
│ │ │ │ │ + if value.startswith('Password'):
│ │ │ │ │ + value = ''
│ │ │ │ │ +
│ │ │ │ │ + # flush out accumulated info/error messages
│ │ │ │ │ + passwd = await self.responder.do_askpass('\n'.join(messages), value, '')
│ │ │ │ │ + messages.clear()
│ │ │ │ │ + if passwd is None:
│ │ │ │ │ + logger.debug('got PAM_PROMPT %s, but do_askpass returned None', value)
│ │ │ │ │ + raise asyncio.CancelledError('no password given')
│ │ │ │ │ + logger.debug('got PAM_PROMPT %s, do_askpass returned a password', value)
│ │ │ │ │ + process.stdin.write(passwd.encode())
│ │ │ │ │ + process.stdin.write(b'\n')
│ │ │ │ │ + del passwd # don't keep this around longer than necessary
│ │ │ │ │ + await process.stdin.drain()
│ │ │ │ │ + logger.debug('got PAM_PROMPT, wrote password to helper')
│ │ │ │ │ + elif command in ('PAM_TEXT_INFO', 'PAM_ERROR'):
│ │ │ │ │ + messages.append(value)
│ │ │ │ │ + elif command == 'SUCCESS':
│ │ │ │ │ + logger.debug('Authentication succeeded')
│ │ │ │ │ + break
│ │ │ │ │ + elif command == 'FAILURE':
│ │ │ │ │ + logger.warning('Authentication failed')
│ │ │ │ │ + break
│ │ │ │ │ + else:
│ │ │ │ │ + logger.warning('Unknown line from helper, aborting: %s', line)
│ │ │ │ │ + process.terminate()
│ │ │ │ │ + break
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class PolkitAgent:
│ │ │ │ │ + """Register polkit agent when required
│ │ │ │ │ +
│ │ │ │ │ + Use this as a context manager to ensure that the agent gets unregistered again.
│ │ │ │ │ + """
│ │ │ │ │ + def __init__(self, responder: AskpassHandler):
│ │ │ │ │ + self.responder = responder
│ │ │ │ │ + self.agent_slot = None
│ │ │ │ │ +
│ │ │ │ │ + async def __aenter__(self):
│ │ │ │ │ + try:
│ │ │ │ │ + self.system_bus = bus.Bus.default_system()
│ │ │ │ │ + except OSError as e:
│ │ │ │ │ + logger.warning('cannot connect to system bus, not registering polkit agent: %s', e)
│ │ │ │ │ + return self
│ │ │ │ │ +
│ │ │ │ │ + try:
│ │ │ │ │ + # may refine that with a D-Bus call to logind
│ │ │ │ │ + self.subject = ('unix-session', {'session-id': Variant(os.environ['XDG_SESSION_ID'], 's')})
│ │ │ │ │ + except KeyError:
│ │ │ │ │ + logger.debug('XDG_SESSION_ID not set, not registering polkit agent')
│ │ │ │ │ + return self
│ │ │ │ │ +
│ │ │ │ │ + agent_object = org_freedesktop_PolicyKit1_AuthenticationAgent(self.responder)
│ │ │ │ │ + self.agent_slot = self.system_bus.add_object(AGENT_DBUS_PATH, agent_object)
│ │ │ │ │ +
│ │ │ │ │ + # register agent
│ │ │ │ │ + locale_name = locale.setlocale(locale.LC_MESSAGES, None)
│ │ │ │ │ + await self.system_bus.call_method_async(
│ │ │ │ │ + 'org.freedesktop.PolicyKit1',
│ │ │ │ │ + '/org/freedesktop/PolicyKit1/Authority',
│ │ │ │ │ + 'org.freedesktop.PolicyKit1.Authority',
│ │ │ │ │ + 'RegisterAuthenticationAgent',
│ │ │ │ │ + '(sa{sv})ss',
│ │ │ │ │ + self.subject, locale_name, AGENT_DBUS_PATH)
│ │ │ │ │ + logger.debug('Registered agent for %r and locale %s', self.subject, locale_name)
│ │ │ │ │ + return self
│ │ │ │ │ +
│ │ │ │ │ + async def __aexit__(self, _exc_type, _exc_value, _traceback):
│ │ │ │ │ + if self.agent_slot:
│ │ │ │ │ + await self.system_bus.call_method_async(
│ │ │ │ │ + 'org.freedesktop.PolicyKit1',
│ │ │ │ │ + '/org/freedesktop/PolicyKit1/Authority',
│ │ │ │ │ + 'org.freedesktop.PolicyKit1.Authority',
│ │ │ │ │ + 'UnregisterAuthenticationAgent',
│ │ │ │ │ + '(sa{sv})s',
│ │ │ │ │ + self.subject, AGENT_DBUS_PATH)
│ │ │ │ │ + self.agent_slot.cancel()
│ │ │ │ │ + logger.debug('Unregistered agent for %r', self.subject)
│ │ │ │ │ +'''.encode('utf-8'),
│ │ │ │ │ + 'cockpit/polyfills.py': br'''# This file is part of Cockpit.
│ │ │ │ │ +#
│ │ │ │ │ +# Copyright (C) 2023 Red Hat, Inc.
│ │ │ │ │ +#
│ │ │ │ │ +# This program is free software: you can redistribute it and/or modify
│ │ │ │ │ +# it under the terms of the GNU General Public License as published by
│ │ │ │ │ +# the Free Software Foundation, either version 3 of the License, or
│ │ │ │ │ +# (at your option) any later version.
│ │ │ │ │ +#
│ │ │ │ │ +# This program is distributed in the hope that it will be useful,
│ │ │ │ │ +# but WITHOUT ANY WARRANTY; without even the implied warranty of
│ │ │ │ │ +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
│ │ │ │ │ +# GNU General Public License for more details.
│ │ │ │ │ +#
│ │ │ │ │ +# You should have received a copy of the GNU General Public License
│ │ │ │ │ +# along with this program. If not, see .
│ │ │ │ │ +
│ │ │ │ │ +import contextlib
│ │ │ │ │ +import socket
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +def install():
│ │ │ │ │ + """Add shims for older Python versions"""
│ │ │ │ │ +
│ │ │ │ │ + # introduced in 3.9
│ │ │ │ │ + if not hasattr(socket, 'recv_fds'):
│ │ │ │ │ + import array
│ │ │ │ │ +
│ │ │ │ │ + import _socket
│ │ │ │ │ +
│ │ │ │ │ + def recv_fds(sock, bufsize, maxfds, flags=0):
│ │ │ │ │ + fds = array.array("i")
│ │ │ │ │ + msg, ancdata, flags, addr = sock.recvmsg(bufsize, _socket.CMSG_LEN(maxfds * fds.itemsize))
│ │ │ │ │ + for cmsg_level, cmsg_type, cmsg_data in ancdata:
│ │ │ │ │ + if (cmsg_level == _socket.SOL_SOCKET and cmsg_type == _socket.SCM_RIGHTS):
│ │ │ │ │ + fds.frombytes(cmsg_data[:len(cmsg_data) - (len(cmsg_data) % fds.itemsize)])
│ │ │ │ │ + return msg, list(fds), flags, addr
│ │ │ │ │ +
│ │ │ │ │ + socket.recv_fds = recv_fds
│ │ │ │ │ +
│ │ │ │ │ + # introduced in 3.7
│ │ │ │ │ + if not hasattr(contextlib, 'AsyncExitStack'):
│ │ │ │ │ + class AsyncExitStack:
│ │ │ │ │ + async def __aenter__(self):
│ │ │ │ │ + self.cms = []
│ │ │ │ │ + return self
│ │ │ │ │ +
│ │ │ │ │ + async def enter_async_context(self, cm):
│ │ │ │ │ + result = await cm.__aenter__()
│ │ │ │ │ + self.cms.append(cm)
│ │ │ │ │ + return result
│ │ │ │ │ +
│ │ │ │ │ + async def __aexit__(self, exc_type, exc_value, traceback):
│ │ │ │ │ + for cm in self.cms:
│ │ │ │ │ + cm.__aexit__(exc_type, exc_value, traceback)
│ │ │ │ │ +
│ │ │ │ │ + contextlib.AsyncExitStack = AsyncExitStack
│ │ │ │ │ +''',
│ │ │ │ │ + 'cockpit/samples.py': br'''# This file is part of Cockpit.
│ │ │ │ │ +#
│ │ │ │ │ +# Copyright (C) 2022 Red Hat, Inc.
│ │ │ │ │ +#
│ │ │ │ │ +# This program is free software: you can redistribute it and/or modify
│ │ │ │ │ +# it under the terms of the GNU General Public License as published by
│ │ │ │ │ +# the Free Software Foundation, either version 3 of the License, or
│ │ │ │ │ +# (at your option) any later version.
│ │ │ │ │ +#
│ │ │ │ │ +# This program is distributed in the hope that it will be useful,
│ │ │ │ │ +# but WITHOUT ANY WARRANTY; without even the implied warranty of
│ │ │ │ │ +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
│ │ │ │ │ +# GNU General Public License for more details.
│ │ │ │ │ +#
│ │ │ │ │ +# You should have received a copy of the GNU General Public License
│ │ │ │ │ +# along with this program. If not, see .
│ │ │ │ │ +
│ │ │ │ │ +import errno
│ │ │ │ │ +import logging
│ │ │ │ │ +import os
│ │ │ │ │ +import re
│ │ │ │ │ +from typing import Any, DefaultDict, Iterable, List, NamedTuple, Optional, Tuple
│ │ │ │ │ +
│ │ │ │ │ +from cockpit._vendor.systemd_ctypes import Handle
│ │ │ │ │ +
│ │ │ │ │ +USER_HZ = os.sysconf(os.sysconf_names['SC_CLK_TCK'])
│ │ │ │ │ +MS_PER_JIFFY = 1000 / (USER_HZ if (USER_HZ > 0) else 100)
│ │ │ │ │ +HWMON_PATH = '/sys/class/hwmon'
│ │ │ │ │ +
│ │ │ │ │ +# we would like to do this, but mypy complains; https://github.com/python/mypy/issues/2900
│ │ │ │ │ +# Samples = collections.defaultdict[str, Union[float, Dict[str, Union[float, None]]]]
│ │ │ │ │ +Samples = DefaultDict[str, Any]
│ │ │ │ │ +
│ │ │ │ │ +logger = logging.getLogger(__name__)
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +def read_int_file(rootfd: int, statfile: str, default: Optional[int] = None, key: bytes = b'') -> Optional[int]:
│ │ │ │ │ + # Not every stat is available, such as cpu.weight
│ │ │ │ │ + try:
│ │ │ │ │ + fd = os.open(statfile, os.O_RDONLY, dir_fd=rootfd)
│ │ │ │ │ + except FileNotFoundError:
│ │ │ │ │ + return None
│ │ │ │ │ +
│ │ │ │ │ + try:
│ │ │ │ │ + data = os.read(fd, 1024)
│ │ │ │ │ + except OSError as e:
│ │ │ │ │ + # cgroups can disappear between the open and read
│ │ │ │ │ + if e.errno != errno.ENODEV:
│ │ │ │ │ + logger.warning('Failed to read %s: %s', statfile, e)
│ │ │ │ │ + return None
│ │ │ │ │ + finally:
│ │ │ │ │ + os.close(fd)
│ │ │ │ │ +
│ │ │ │ │ + if key:
│ │ │ │ │ + start = data.index(key) + len(key)
│ │ │ │ │ + end = data.index(b'\n', start)
│ │ │ │ │ + data = data[start:end]
│ │ │ │ │ +
│ │ │ │ │ + try:
│ │ │ │ │ + # 0 often means "none", so replace it with default value
│ │ │ │ │ + return int(data) or default
│ │ │ │ │ + except ValueError:
│ │ │ │ │ + # Some samples such as "memory.max" contains "max" when there is a no limit
│ │ │ │ │ + return None
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class SampleDescription(NamedTuple):
│ │ │ │ │ + name: str
│ │ │ │ │ + units: str
│ │ │ │ │ + semantics: str
│ │ │ │ │ + instanced: bool
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class Sampler:
│ │ │ │ │ + descriptions: List[SampleDescription]
│ │ │ │ │ +
│ │ │ │ │ + def sample(self, samples: Samples) -> None:
│ │ │ │ │ + raise NotImplementedError
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class CPUSampler(Sampler):
│ │ │ │ │ + descriptions = [
│ │ │ │ │ + SampleDescription('cpu.basic.nice', 'millisec', 'counter', instanced=False),
│ │ │ │ │ + SampleDescription('cpu.basic.user', 'millisec', 'counter', instanced=False),
│ │ │ │ │ + SampleDescription('cpu.basic.system', 'millisec', 'counter', instanced=False),
│ │ │ │ │ + SampleDescription('cpu.basic.iowait', 'millisec', 'counter', instanced=False),
│ │ │ │ │ +
│ │ │ │ │ + SampleDescription('cpu.core.nice', 'millisec', 'counter', instanced=True),
│ │ │ │ │ + SampleDescription('cpu.core.user', 'millisec', 'counter', instanced=True),
│ │ │ │ │ + SampleDescription('cpu.core.system', 'millisec', 'counter', instanced=True),
│ │ │ │ │ + SampleDescription('cpu.core.iowait', 'millisec', 'counter', instanced=True),
│ │ │ │ │ + ]
│ │ │ │ │ +
│ │ │ │ │ + def sample(self, samples: Samples) -> None:
│ │ │ │ │ + with open('/proc/stat') as stat:
│ │ │ │ │ + for line in stat:
│ │ │ │ │ + if not line.startswith('cpu'):
│ │ │ │ │ + continue
│ │ │ │ │ + cpu, user, nice, system, _idle, iowait = line.split()[:6]
│ │ │ │ │ + core = cpu[3:] or None
│ │ │ │ │ + if core:
│ │ │ │ │ + prefix = 'cpu.core'
│ │ │ │ │ + samples[f'{prefix}.nice'][core] = int(nice) * MS_PER_JIFFY
│ │ │ │ │ + samples[f'{prefix}.user'][core] = int(user) * MS_PER_JIFFY
│ │ │ │ │ + samples[f'{prefix}.system'][core] = int(system) * MS_PER_JIFFY
│ │ │ │ │ + samples[f'{prefix}.iowait'][core] = int(iowait) * MS_PER_JIFFY
│ │ │ │ │ + else:
│ │ │ │ │ + prefix = 'cpu.basic'
│ │ │ │ │ + samples[f'{prefix}.nice'] = int(nice) * MS_PER_JIFFY
│ │ │ │ │ + samples[f'{prefix}.user'] = int(user) * MS_PER_JIFFY
│ │ │ │ │ + samples[f'{prefix}.system'] = int(system) * MS_PER_JIFFY
│ │ │ │ │ + samples[f'{prefix}.iowait'] = int(iowait) * MS_PER_JIFFY
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class MemorySampler(Sampler):
│ │ │ │ │ + descriptions = [
│ │ │ │ │ + SampleDescription('memory.free', 'bytes', 'instant', instanced=False),
│ │ │ │ │ + SampleDescription('memory.used', 'bytes', 'instant', instanced=False),
│ │ │ │ │ + SampleDescription('memory.cached', 'bytes', 'instant', instanced=False),
│ │ │ │ │ + SampleDescription('memory.swap-used', 'bytes', 'instant', instanced=False),
│ │ │ │ │ + ]
│ │ │ │ │ +
│ │ │ │ │ + def sample(self, samples: Samples) -> None:
│ │ │ │ │ + with open('/proc/meminfo') as meminfo:
│ │ │ │ │ + items = {k: int(v.strip(' kB\n')) for line in meminfo for k, v in [line.split(':', 1)]}
│ │ │ │ │ +
│ │ │ │ │ + samples['memory.free'] = 1024 * items['MemFree']
│ │ │ │ │ + samples['memory.used'] = 1024 * (items['MemTotal'] - items['MemAvailable'])
│ │ │ │ │ + samples['memory.cached'] = 1024 * (items['Buffers'] + items['Cached'])
│ │ │ │ │ + samples['memory.swap-used'] = 1024 * (items['SwapTotal'] - items['SwapFree'])
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class CPUTemperatureSampler(Sampler):
│ │ │ │ │ + # Cache found sensors, as they can't be hotplugged.
│ │ │ │ │ + sensors: Optional[List[str]] = None
│ │ │ │ │ +
│ │ │ │ │ + descriptions = [
│ │ │ │ │ + SampleDescription('cpu.temperature', 'celsius', 'instant', instanced=True),
│ │ │ │ │ + ]
│ │ │ │ │ +
│ │ │ │ │ + @staticmethod
│ │ │ │ │ + def detect_cpu_sensors(dir_fd: int) -> Iterable[str]:
│ │ │ │ │ + # Read the name file to decide what to do with this directory
│ │ │ │ │ + try:
│ │ │ │ │ + with Handle.open('name', os.O_RDONLY, dir_fd=dir_fd) as fd:
│ │ │ │ │ + name = os.read(fd, 1024).decode().strip()
│ │ │ │ │ + except FileNotFoundError:
│ │ │ │ │ + return
│ │ │ │ │ +
│ │ │ │ │ + if name == 'atk0110':
│ │ │ │ │ + # only sample 'CPU Temperature' in atk0110
│ │ │ │ │ + predicate = (lambda label: label == 'CPU Temperature')
│ │ │ │ │ + elif name == 'cpu_thermal':
│ │ │ │ │ + # labels are not used on ARM
│ │ │ │ │ + predicate = None
│ │ │ │ │ + elif name == 'coretemp':
│ │ │ │ │ + # accept all labels on Intel
│ │ │ │ │ + predicate = None
│ │ │ │ │ + elif name in ['k8temp', 'k10temp']:
│ │ │ │ │ + predicate = None
│ │ │ │ │ + else:
│ │ │ │ │ + # Not a CPU sensor
│ │ │ │ │ + return
│ │ │ │ │ +
│ │ │ │ │ + # Now scan the directory for inputs
│ │ │ │ │ + for input_filename in os.listdir(dir_fd):
│ │ │ │ │ + if not input_filename.endswith('_input'):
│ │ │ │ │ + continue
│ │ │ │ │ +
│ │ │ │ │ + if predicate:
│ │ │ │ │ + # We need to check the label
│ │ │ │ │ + try:
│ │ │ │ │ + label_filename = input_filename.replace('_input', '_label')
│ │ │ │ │ + with Handle.open(label_filename, os.O_RDONLY, dir_fd=dir_fd) as fd:
│ │ │ │ │ + label = os.read(fd, 1024).decode().strip()
│ │ │ │ │ + except FileNotFoundError:
│ │ │ │ │ + continue
│ │ │ │ │ +
│ │ │ │ │ + if not predicate(label):
│ │ │ │ │ + continue
│ │ │ │ │ +
│ │ │ │ │ + yield input_filename
│ │ │ │ │ +
│ │ │ │ │ + @staticmethod
│ │ │ │ │ + def scan_sensors() -> Iterable[str]:
│ │ │ │ │ + try:
│ │ │ │ │ + top_fd = Handle.open(HWMON_PATH, os.O_RDONLY | os.O_DIRECTORY)
│ │ │ │ │ + except FileNotFoundError:
│ │ │ │ │ + return
│ │ │ │ │ +
│ │ │ │ │ + with top_fd:
│ │ │ │ │ + for hwmon_name in os.listdir(top_fd):
│ │ │ │ │ + with Handle.open(hwmon_name, os.O_RDONLY | os.O_DIRECTORY, dir_fd=top_fd) as subdir_fd:
│ │ │ │ │ + for sensor in CPUTemperatureSampler.detect_cpu_sensors(subdir_fd):
│ │ │ │ │ + yield f'{HWMON_PATH}/{hwmon_name}/{sensor}'
│ │ │ │ │ +
│ │ │ │ │ + def sample(self, samples: Samples) -> None:
│ │ │ │ │ + if self.sensors is None:
│ │ │ │ │ + self.sensors = list(CPUTemperatureSampler.scan_sensors())
│ │ │ │ │ +
│ │ │ │ │ + for sensor_path in self.sensors:
│ │ │ │ │ + with open(sensor_path) as sensor:
│ │ │ │ │ + temperature = int(sensor.read().strip())
│ │ │ │ │ + if temperature == 0:
│ │ │ │ │ + return
│ │ │ │ │ +
│ │ │ │ │ + samples['cpu.temperature'][sensor_path] = temperature / 1000
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class DiskSampler(Sampler):
│ │ │ │ │ + descriptions = [
│ │ │ │ │ + SampleDescription('disk.all.read', 'bytes', 'counter', instanced=False),
│ │ │ │ │ + SampleDescription('disk.all.written', 'bytes', 'counter', instanced=False),
│ │ │ │ │ + SampleDescription('disk.dev.read', 'bytes', 'counter', instanced=True),
│ │ │ │ │ + SampleDescription('disk.dev.written', 'bytes', 'counter', instanced=True),
│ │ │ │ │ + ]
│ │ │ │ │ +
│ │ │ │ │ + def sample(self, samples: Samples) -> None:
│ │ │ │ │ + with open('/proc/diskstats') as diskstats:
│ │ │ │ │ + all_read_bytes = 0
│ │ │ │ │ + all_written_bytes = 0
│ │ │ │ │ +
│ │ │ │ │ + for line in diskstats:
│ │ │ │ │ + # https://www.kernel.org/doc/Documentation/ABI/testing/procfs-diskstats
│ │ │ │ │ + fields = line.strip().split()
│ │ │ │ │ + dev_major = fields[0]
│ │ │ │ │ + dev_name = fields[2]
│ │ │ │ │ + num_sectors_read = fields[5]
│ │ │ │ │ + num_sectors_written = fields[9]
│ │ │ │ │ +
│ │ │ │ │ + # ignore mdraid
│ │ │ │ │ + if dev_major == '9':
│ │ │ │ │ + continue
│ │ │ │ │ +
│ │ │ │ │ + # ignore device-mapper
│ │ │ │ │ + if dev_name.startswith('dm-'):
│ │ │ │ │ + continue
│ │ │ │ │ +
│ │ │ │ │ + # Skip partitions
│ │ │ │ │ + if dev_name[:2] in ['sd', 'hd', 'vd'] and dev_name[-1].isdigit():
│ │ │ │ │ + continue
│ │ │ │ │ +
│ │ │ │ │ + # Ignore nvme partitions
│ │ │ │ │ + if dev_name.startswith('nvme') and 'p' in dev_name:
│ │ │ │ │ + continue
│ │ │ │ │ +
│ │ │ │ │ + read_bytes = int(num_sectors_read) * 512
│ │ │ │ │ + written_bytes = int(num_sectors_written) * 512
│ │ │ │ │ +
│ │ │ │ │ + all_read_bytes += read_bytes
│ │ │ │ │ + all_written_bytes += written_bytes
│ │ │ │ │ +
│ │ │ │ │ + samples['disk.dev.read'][dev_name] = read_bytes
│ │ │ │ │ + samples['disk.dev.written'][dev_name] = written_bytes
│ │ │ │ │ +
│ │ │ │ │ + samples['disk.all.read'] = all_read_bytes
│ │ │ │ │ + samples['disk.all.written'] = all_written_bytes
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class CGroupSampler(Sampler):
│ │ │ │ │ + descriptions = [
│ │ │ │ │ + SampleDescription('cgroup.memory.usage', 'bytes', 'instant', instanced=True),
│ │ │ │ │ + SampleDescription('cgroup.memory.limit', 'bytes', 'instant', instanced=True),
│ │ │ │ │ + SampleDescription('cgroup.memory.sw-usage', 'bytes', 'instant', instanced=True),
│ │ │ │ │ + SampleDescription('cgroup.memory.sw-limit', 'bytes', 'instant', instanced=True),
│ │ │ │ │ + SampleDescription('cgroup.cpu.usage', 'millisec', 'counter', instanced=True),
│ │ │ │ │ + SampleDescription('cgroup.cpu.shares', 'count', 'instant', instanced=True),
│ │ │ │ │ + ]
│ │ │ │ │ +
│ │ │ │ │ + cgroups_v2: Optional[bool] = None
│ │ │ │ │ +
│ │ │ │ │ + def sample(self, samples: Samples) -> None:
│ │ │ │ │ + if self.cgroups_v2 is None:
│ │ │ │ │ + self.cgroups_v2 = os.path.exists('/sys/fs/cgroup/cgroup.controllers')
│ │ │ │ │ +
│ │ │ │ │ + if self.cgroups_v2:
│ │ │ │ │ + cgroups_v2_path = '/sys/fs/cgroup/'
│ │ │ │ │ + for path, _, _, rootfd in os.fwalk(cgroups_v2_path):
│ │ │ │ │ + cgroup = path.replace(cgroups_v2_path, '')
│ │ │ │ │ +
│ │ │ │ │ + if not cgroup:
│ │ │ │ │ + continue
│ │ │ │ │ +
│ │ │ │ │ + samples['cgroup.memory.usage'][cgroup] = read_int_file(rootfd, 'memory.current', 0)
│ │ │ │ │ + samples['cgroup.memory.limit'][cgroup] = read_int_file(rootfd, 'memory.max')
│ │ │ │ │ + samples['cgroup.memory.sw-usage'][cgroup] = read_int_file(rootfd, 'memory.swap.current', 0)
│ │ │ │ │ + samples['cgroup.memory.sw-limit'][cgroup] = read_int_file(rootfd, 'memory.swap.max')
│ │ │ │ │ + samples['cgroup.cpu.shares'][cgroup] = read_int_file(rootfd, 'cpu.weight')
│ │ │ │ │ + usage_usec = read_int_file(rootfd, 'cpu.stat', 0, key=b'usage_usec')
│ │ │ │ │ + if usage_usec:
│ │ │ │ │ + samples['cgroup.cpu.usage'][cgroup] = usage_usec / 1000
│ │ │ │ │ + else:
│ │ │ │ │ + memory_path = '/sys/fs/cgroup/memory/'
│ │ │ │ │ + for path, _, _, rootfd in os.fwalk(memory_path):
│ │ │ │ │ + cgroup = path.replace(memory_path, '')
│ │ │ │ │ +
│ │ │ │ │ + if not cgroup:
│ │ │ │ │ + continue
│ │ │ │ │ +
│ │ │ │ │ + samples['cgroup.memory.usage'][cgroup] = read_int_file(rootfd, 'memory.usage_in_bytes', 0)
│ │ │ │ │ + samples['cgroup.memory.limit'][cgroup] = read_int_file(rootfd, 'memory.limit_in_bytes')
│ │ │ │ │ + samples['cgroup.memory.sw-usage'][cgroup] = read_int_file(rootfd, 'memory.memsw.usage_in_bytes', 0)
│ │ │ │ │ + samples['cgroup.memory.sw-limit'][cgroup] = read_int_file(rootfd, 'memory.memsw.limit_in_bytes')
│ │ │ │ │ +
│ │ │ │ │ + cpu_path = '/sys/fs/cgroup/cpu/'
│ │ │ │ │ + for path, _, _, rootfd in os.fwalk(cpu_path):
│ │ │ │ │ + cgroup = path.replace(cpu_path, '')
│ │ │ │ │ +
│ │ │ │ │ + if not cgroup:
│ │ │ │ │ + continue
│ │ │ │ │ +
│ │ │ │ │ + samples['cgroup.cpu.shares'][cgroup] = read_int_file(rootfd, 'cpu.shares')
│ │ │ │ │ + usage_nsec = read_int_file(rootfd, 'cpuacct.usage')
│ │ │ │ │ + if usage_nsec:
│ │ │ │ │ + samples['cgroup.cpu.usage'][cgroup] = usage_nsec / 1000000
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class CGroupDiskIO(Sampler):
│ │ │ │ │ + IO_RE = re.compile(rb'\bread_bytes: (?P\d+).*\nwrite_bytes: (?P\d+)', flags=re.S)
│ │ │ │ │ + descriptions = [
│ │ │ │ │ + SampleDescription('disk.cgroup.read', 'bytes', 'counter', instanced=True),
│ │ │ │ │ + SampleDescription('disk.cgroup.written', 'bytes', 'counter', instanced=True),
│ │ │ │ │ + ]
│ │ │ │ │ +
│ │ │ │ │ + @staticmethod
│ │ │ │ │ + def get_cgroup_name(fd: int) -> str:
│ │ │ │ │ + with Handle.open('cgroup', os.O_RDONLY, dir_fd=fd) as cgroup_fd:
│ │ │ │ │ + cgroup_name = os.read(cgroup_fd, 2048).decode().strip()
│ │ │ │ │ +
│ │ │ │ │ + # Skip leading ::0/
│ │ │ │ │ + return cgroup_name[4:]
│ │ │ │ │ +
│ │ │ │ │ + @staticmethod
│ │ │ │ │ + def get_proc_io(fd: int) -> Tuple[int, int]:
│ │ │ │ │ + with Handle.open('io', os.O_RDONLY, dir_fd=fd) as io_fd:
│ │ │ │ │ + data = os.read(io_fd, 4096)
│ │ │ │ │ +
│ │ │ │ │ + match = re.search(CGroupDiskIO.IO_RE, data)
│ │ │ │ │ + if match:
│ │ │ │ │ + proc_read = int(match.group('read'))
│ │ │ │ │ + proc_write = int(match.group('write'))
│ │ │ │ │ +
│ │ │ │ │ + return proc_read, proc_write
│ │ │ │ │ +
│ │ │ │ │ + return 0, 0
│ │ │ │ │ +
│ │ │ │ │ + def sample(self, samples: Samples):
│ │ │ │ │ + with Handle.open('/proc', os.O_RDONLY | os.O_DIRECTORY) as proc_fd:
│ │ │ │ │ + reads = samples['disk.cgroup.read']
│ │ │ │ │ + writes = samples['disk.cgroup.written']
│ │ │ │ │ +
│ │ │ │ │ + for path in os.listdir(proc_fd):
│ │ │ │ │ + # non-pid entries in proc are guaranteed to start with a character a-z
│ │ │ │ │ + if path[0] < '0' or path[0] > '9':
│ │ │ │ │ + continue
│ │ │ │ │ +
│ │ │ │ │ + try:
│ │ │ │ │ + with Handle.open(path, os.O_PATH, dir_fd=proc_fd) as pid_fd:
│ │ │ │ │ + cgroup_name = self.get_cgroup_name(pid_fd)
│ │ │ │ │ + proc_read, proc_write = self.get_proc_io(pid_fd)
│ │ │ │ │ + except (FileNotFoundError, PermissionError, ProcessLookupError):
│ │ │ │ │ + continue
│ │ │ │ │ +
│ │ │ │ │ + reads[cgroup_name] = reads.get(cgroup_name, 0) + proc_read
│ │ │ │ │ + writes[cgroup_name] = writes.get(cgroup_name, 0) + proc_write
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class NetworkSampler(Sampler):
│ │ │ │ │ + descriptions = [
│ │ │ │ │ + SampleDescription('network.interface.tx', 'bytes', 'counter', instanced=True),
│ │ │ │ │ + SampleDescription('network.interface.rx', 'bytes', 'counter', instanced=True),
│ │ │ │ │ + ]
│ │ │ │ │ +
│ │ │ │ │ + def sample(self, samples: Samples) -> None:
│ │ │ │ │ + with open("/proc/net/dev") as network_samples:
│ │ │ │ │ + for line in network_samples:
│ │ │ │ │ + fields = line.split()
│ │ │ │ │ +
│ │ │ │ │ + # Skip header line
│ │ │ │ │ + if fields[0][-1] != ':':
│ │ │ │ │ + continue
│ │ │ │ │ +
│ │ │ │ │ + iface = fields[0][:-1]
│ │ │ │ │ + samples['network.interface.rx'][iface] = int(fields[1])
│ │ │ │ │ + samples['network.interface.tx'][iface] = int(fields[9])
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class MountSampler(Sampler):
│ │ │ │ │ + descriptions = [
│ │ │ │ │ + SampleDescription('mount.total', 'bytes', 'instant', instanced=True),
│ │ │ │ │ + SampleDescription('mount.used', 'bytes', 'instant', instanced=True),
│ │ │ │ │ + ]
│ │ │ │ │ +
│ │ │ │ │ + def sample(self, samples: Samples) -> None:
│ │ │ │ │ + with open('/proc/mounts') as mounts:
│ │ │ │ │ + for line in mounts:
│ │ │ │ │ + # Only look at real devices
│ │ │ │ │ + if line[0] != '/':
│ │ │ │ │ + continue
│ │ │ │ │ +
│ │ │ │ │ + path = line.split()[1]
│ │ │ │ │ + try:
│ │ │ │ │ + res = os.statvfs(path)
│ │ │ │ │ + except OSError:
│ │ │ │ │ + continue
│ │ │ │ │ + frsize = res.f_frsize
│ │ │ │ │ + total = frsize * res.f_blocks
│ │ │ │ │ + samples['mount.total'][path] = total
│ │ │ │ │ + samples['mount.used'][path] = total - frsize * res.f_bfree
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class BlockSampler(Sampler):
│ │ │ │ │ + descriptions = [
│ │ │ │ │ + SampleDescription('block.device.read', 'bytes', 'counter', instanced=True),
│ │ │ │ │ + SampleDescription('block.device.written', 'bytes', 'counter', instanced=True),
│ │ │ │ │ + ]
│ │ │ │ │ +
│ │ │ │ │ + def sample(self, samples: Samples) -> None:
│ │ │ │ │ + with open('/proc/diskstats') as diskstats:
│ │ │ │ │ + for line in diskstats:
│ │ │ │ │ + # https://www.kernel.org/doc/Documentation/ABI/testing/procfs-diskstats
│ │ │ │ │ + [_, _, dev_name, _, _, sectors_read, _, _, _, sectors_written, *_] = line.strip().split()
│ │ │ │ │ +
│ │ │ │ │ + samples['block.device.read'][dev_name] = int(sectors_read) * 512
│ │ │ │ │ + samples['block.device.written'][dev_name] = int(sectors_written) * 512
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +SAMPLERS = [
│ │ │ │ │ + BlockSampler,
│ │ │ │ │ + CGroupSampler,
│ │ │ │ │ + CGroupDiskIO,
│ │ │ │ │ + CPUSampler,
│ │ │ │ │ + CPUTemperatureSampler,
│ │ │ │ │ + DiskSampler,
│ │ │ │ │ + MemorySampler,
│ │ │ │ │ + MountSampler,
│ │ │ │ │ + NetworkSampler,
│ │ │ │ │ +]
│ │ │ │ │ +''',
│ │ │ │ │ + 'cockpit/protocol.py': br'''# This file is part of Cockpit.
│ │ │ │ │ +#
│ │ │ │ │ +# Copyright (C) 2022 Red Hat, Inc.
│ │ │ │ │ +#
│ │ │ │ │ +# This program is free software: you can redistribute it and/or modify
│ │ │ │ │ +# it under the terms of the GNU General Public License as published by
│ │ │ │ │ +# the Free Software Foundation, either version 3 of the License, or
│ │ │ │ │ +# (at your option) any later version.
│ │ │ │ │ +#
│ │ │ │ │ +# This program is distributed in the hope that it will be useful,
│ │ │ │ │ +# but WITHOUT ANY WARRANTY; without even the implied warranty of
│ │ │ │ │ +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
│ │ │ │ │ +# GNU General Public License for more details.
│ │ │ │ │ +#
│ │ │ │ │ +# You should have received a copy of the GNU General Public License
│ │ │ │ │ +# along with this program. If not, see .
│ │ │ │ │ +
│ │ │ │ │ +import asyncio
│ │ │ │ │ +import json
│ │ │ │ │ +import logging
│ │ │ │ │ +import traceback
│ │ │ │ │ +import uuid
│ │ │ │ │ +
│ │ │ │ │ +from .jsonutil import JsonError, JsonObject, JsonValue, create_object, get_int, get_str, get_str_or_none, typechecked
│ │ │ │ │ +
│ │ │ │ │ +logger = logging.getLogger(__name__)
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class CockpitProblem(Exception):
│ │ │ │ │ + """A type of exception that carries a problem code and a message.
│ │ │ │ │ +
│ │ │ │ │ + Depending on the scope, this is used to handle shutting down:
│ │ │ │ │ +
│ │ │ │ │ + - an individual channel (sends problem code in the close message)
│ │ │ │ │ + - peer connections (sends problem code in close message for each open channel)
│ │ │ │ │ + - the main stdio interaction with the bridge
│ │ │ │ │ +
│ │ │ │ │ + It is usually thrown in response to some violation of expected protocol
│ │ │ │ │ + when parsing messages, connecting to a peer, or opening a channel.
│ │ │ │ │ + """
│ │ │ │ │ + attrs: JsonObject
│ │ │ │ │ +
│ │ │ │ │ + def __init__(self, problem: str, _msg: 'JsonObject | None' = None, **kwargs: JsonValue) -> None:
│ │ │ │ │ + kwargs['problem'] = problem
│ │ │ │ │ + self.attrs = create_object(_msg, kwargs)
│ │ │ │ │ + super().__init__(get_str(self.attrs, 'message', problem))
│ │ │ │ │ +
│ │ │ │ │ + def get_attrs(self) -> JsonObject:
│ │ │ │ │ + if self.attrs['problem'] == 'internal-error' and self.__cause__ is not None:
│ │ │ │ │ + return dict(self.attrs, cause=traceback.format_exception(
│ │ │ │ │ + self.__cause__.__class__, self.__cause__, self.__cause__.__traceback__
│ │ │ │ │ + ))
│ │ │ │ │ + else:
│ │ │ │ │ + return self.attrs
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class CockpitProtocolError(CockpitProblem):
│ │ │ │ │ + def __init__(self, message: str, problem: str = 'protocol-error'):
│ │ │ │ │ + super().__init__(problem, message=message)
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class CockpitProtocol(asyncio.Protocol):
│ │ │ │ │ + """A naive implementation of the Cockpit frame protocol
│ │ │ │ │ +
│ │ │ │ │ + We need to use this because Python's SelectorEventLoop doesn't supported
│ │ │ │ │ + buffered protocols.
│ │ │ │ │ + """
│ │ │ │ │ + transport: 'asyncio.Transport | None' = None
│ │ │ │ │ + buffer = b''
│ │ │ │ │ + _closed: bool = False
│ │ │ │ │ + _communication_done: 'asyncio.Future[None] | None' = None
│ │ │ │ │ +
│ │ │ │ │ + def do_ready(self) -> None:
│ │ │ │ │ + pass
│ │ │ │ │ +
│ │ │ │ │ + def do_closed(self, exc: 'Exception | None') -> None:
│ │ │ │ │ + pass
│ │ │ │ │ +
│ │ │ │ │ + def transport_control_received(self, command: str, message: JsonObject) -> None:
│ │ │ │ │ + raise NotImplementedError
│ │ │ │ │ +
│ │ │ │ │ + def channel_control_received(self, channel: str, command: str, message: JsonObject) -> None:
│ │ │ │ │ + raise NotImplementedError
│ │ │ │ │ +
│ │ │ │ │ + def channel_data_received(self, channel: str, data: bytes) -> None:
│ │ │ │ │ + raise NotImplementedError
│ │ │ │ │ +
│ │ │ │ │ + def frame_received(self, frame: bytes) -> None:
│ │ │ │ │ + header, _, data = frame.partition(b'\n')
│ │ │ │ │ +
│ │ │ │ │ + if header != b'':
│ │ │ │ │ + channel = header.decode('ascii')
│ │ │ │ │ + logger.debug('data received: %d bytes of data for channel %s', len(data), channel)
│ │ │ │ │ + self.channel_data_received(channel, data)
│ │ │ │ │ +
│ │ │ │ │ + else:
│ │ │ │ │ + self.control_received(data)
│ │ │ │ │ +
│ │ │ │ │ + def control_received(self, data: bytes) -> None:
│ │ │ │ │ + try:
│ │ │ │ │ + message = typechecked(json.loads(data), dict)
│ │ │ │ │ + command = get_str(message, 'command')
│ │ │ │ │ + channel = get_str(message, 'channel', None)
│ │ │ │ │ +
│ │ │ │ │ + if channel is not None:
│ │ │ │ │ + logger.debug('channel control received %s', message)
│ │ │ │ │ + self.channel_control_received(channel, command, message)
│ │ │ │ │ + else:
│ │ │ │ │ + logger.debug('transport control received %s', message)
│ │ │ │ │ + self.transport_control_received(command, message)
│ │ │ │ │ +
│ │ │ │ │ + except (json.JSONDecodeError, JsonError) as exc:
│ │ │ │ │ + raise CockpitProtocolError(f'control message: {exc!s}') from exc
│ │ │ │ │ +
│ │ │ │ │ + def consume_one_frame(self, data: bytes) -> int:
│ │ │ │ │ + """Consumes a single frame from view.
│ │ │ │ │ +
│ │ │ │ │ + Returns positive if a number of bytes were consumed, or negative if no
│ │ │ │ │ + work can be done because of a given number of bytes missing.
│ │ │ │ │ + """
│ │ │ │ │ +
│ │ │ │ │ + try:
│ │ │ │ │ + newline = data.index(b'\n')
│ │ │ │ │ + except ValueError as exc:
│ │ │ │ │ + if len(data) < 10:
│ │ │ │ │ + # Let's try reading more
│ │ │ │ │ + return len(data) - 10
│ │ │ │ │ + raise CockpitProtocolError("size line is too long") from exc
│ │ │ │ │ +
│ │ │ │ │ + try:
│ │ │ │ │ + length = int(data[:newline])
│ │ │ │ │ + except ValueError as exc:
│ │ │ │ │ + raise CockpitProtocolError("frame size is not an integer") from exc
│ │ │ │ │ +
│ │ │ │ │ + start = newline + 1
│ │ │ │ │ + end = start + length
│ │ │ │ │ +
│ │ │ │ │ + if end > len(data):
│ │ │ │ │ + # We need to read more
│ │ │ │ │ + return len(data) - end
│ │ │ │ │ +
│ │ │ │ │ + # We can consume a full frame
│ │ │ │ │ + self.frame_received(data[start:end])
│ │ │ │ │ + return end
│ │ │ │ │ +
│ │ │ │ │ + def connection_made(self, transport: asyncio.BaseTransport) -> None:
│ │ │ │ │ + logger.debug('connection_made(%s)', transport)
│ │ │ │ │ + assert isinstance(transport, asyncio.Transport)
│ │ │ │ │ + self.transport = transport
│ │ │ │ │ + self.do_ready()
│ │ │ │ │ +
│ │ │ │ │ + if self._closed:
│ │ │ │ │ + logger.debug(' but the protocol already was closed, so closing transport')
│ │ │ │ │ + transport.close()
│ │ │ │ │ +
│ │ │ │ │ + def connection_lost(self, exc: 'Exception | None') -> None:
│ │ │ │ │ + logger.debug('connection_lost')
│ │ │ │ │ + assert self.transport is not None
│ │ │ │ │ + self.transport = None
│ │ │ │ │ + self.close(exc)
│ │ │ │ │ +
│ │ │ │ │ + def close(self, exc: 'Exception | None' = None) -> None:
│ │ │ │ │ + if self._closed:
│ │ │ │ │ + return
│ │ │ │ │ + self._closed = True
│ │ │ │ │ +
│ │ │ │ │ + if self.transport:
│ │ │ │ │ + self.transport.close()
│ │ │ │ │ +
│ │ │ │ │ + self.do_closed(exc)
│ │ │ │ │ +
│ │ │ │ │ + def write_channel_data(self, channel: str, payload: bytes) -> None:
│ │ │ │ │ + """Send a given payload (bytes) on channel (string)"""
│ │ │ │ │ + # Channel is certainly ascii (as enforced by .encode() below)
│ │ │ │ │ + frame_length = len(channel + '\n') + len(payload)
│ │ │ │ │ + header = f'{frame_length}\n{channel}\n'.encode('ascii')
│ │ │ │ │ + if self.transport is not None:
│ │ │ │ │ + logger.debug('writing to transport %s', self.transport)
│ │ │ │ │ + self.transport.write(header + payload)
│ │ │ │ │ + else:
│ │ │ │ │ + logger.debug('cannot write to closed transport')
│ │ │ │ │ +
│ │ │ │ │ + def write_control(self, _msg: 'JsonObject | None' = None, **kwargs: JsonValue) -> None:
│ │ │ │ │ + """Write a control message. See jsonutil.create_object() for details."""
│ │ │ │ │ + logger.debug('sending control message %r %r', _msg, kwargs)
│ │ │ │ │ + pretty = json.dumps(create_object(_msg, kwargs), indent=2) + '\n'
│ │ │ │ │ + self.write_channel_data('', pretty.encode())
│ │ │ │ │ +
│ │ │ │ │ + def data_received(self, data: bytes) -> None:
│ │ │ │ │ + try:
│ │ │ │ │ + self.buffer += data
│ │ │ │ │ + while self.buffer:
│ │ │ │ │ + result = self.consume_one_frame(self.buffer)
│ │ │ │ │ + if result <= 0:
│ │ │ │ │ + return
│ │ │ │ │ + self.buffer = self.buffer[result:]
│ │ │ │ │ + except CockpitProtocolError as exc:
│ │ │ │ │ + self.close(exc)
│ │ │ │ │ +
│ │ │ │ │ + def eof_received(self) -> bool:
│ │ │ │ │ + return False
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +# Helpful functionality for "server"-side protocol implementations
│ │ │ │ │ +class CockpitProtocolServer(CockpitProtocol):
│ │ │ │ │ + init_host: 'str | None' = None
│ │ │ │ │ + authorizations: 'dict[str, asyncio.Future[str]] | None' = None
│ │ │ │ │ +
│ │ │ │ │ + def do_send_init(self) -> None:
│ │ │ │ │ + raise NotImplementedError
│ │ │ │ │ +
│ │ │ │ │ + def do_init(self, message: JsonObject) -> None:
│ │ │ │ │ + pass
│ │ │ │ │ +
│ │ │ │ │ + def do_kill(self, host: 'str | None', group: 'str | None', message: JsonObject) -> None:
│ │ │ │ │ + raise NotImplementedError
│ │ │ │ │ +
│ │ │ │ │ + def transport_control_received(self, command: str, message: JsonObject) -> None:
│ │ │ │ │ + if command == 'init':
│ │ │ │ │ + if get_int(message, 'version') != 1:
│ │ │ │ │ + raise CockpitProtocolError('incorrect version number')
│ │ │ │ │ + self.init_host = get_str(message, 'host')
│ │ │ │ │ + self.do_init(message)
│ │ │ │ │ + elif command == 'kill':
│ │ │ │ │ + self.do_kill(get_str_or_none(message, 'host', None), get_str_or_none(message, 'group', None), message)
│ │ │ │ │ + elif command == 'authorize':
│ │ │ │ │ + self.do_authorize(message)
│ │ │ │ │ + else:
│ │ │ │ │ + raise CockpitProtocolError(f'unexpected control message {command} received')
│ │ │ │ │ +
│ │ │ │ │ + def do_ready(self) -> None:
│ │ │ │ │ + self.do_send_init()
│ │ │ │ │ +
│ │ │ │ │ + # authorize request/response API
│ │ │ │ │ + async def request_authorization(
│ │ │ │ │ + self, challenge: str, timeout: 'int | None' = None, **kwargs: JsonValue
│ │ │ │ │ + ) -> str:
│ │ │ │ │ + if self.authorizations is None:
│ │ │ │ │ + self.authorizations = {}
│ │ │ │ │ + cookie = str(uuid.uuid4())
│ │ │ │ │ + future = asyncio.get_running_loop().create_future()
│ │ │ │ │ + try:
│ │ │ │ │ + self.authorizations[cookie] = future
│ │ │ │ │ + self.write_control(None, command='authorize', challenge=challenge, cookie=cookie, **kwargs)
│ │ │ │ │ + return await asyncio.wait_for(future, timeout)
│ │ │ │ │ + finally:
│ │ │ │ │ + self.authorizations.pop(cookie)
│ │ │ │ │ +
│ │ │ │ │ + def do_authorize(self, message: JsonObject) -> None:
│ │ │ │ │ + cookie = get_str(message, 'cookie')
│ │ │ │ │ + response = get_str(message, 'response')
│ │ │ │ │ +
│ │ │ │ │ + if self.authorizations is None or cookie not in self.authorizations:
│ │ │ │ │ + logger.warning('no matching authorize request')
│ │ │ │ │ + return
│ │ │ │ │ +
│ │ │ │ │ + self.authorizations[cookie].set_result(response)
│ │ │ │ │ +''',
│ │ │ │ │ + 'cockpit/bridge.py': r'''# This file is part of Cockpit.
│ │ │ │ │ +#
│ │ │ │ │ +# Copyright (C) 2022 Red Hat, Inc.
│ │ │ │ │ +#
│ │ │ │ │ +# This program is free software: you can redistribute it and/or modify
│ │ │ │ │ +# it under the terms of the GNU General Public License as published by
│ │ │ │ │ +# the Free Software Foundation, either version 3 of the License, or
│ │ │ │ │ +# (at your option) any later version.
│ │ │ │ │ +#
│ │ │ │ │ +# This program is distributed in the hope that it will be useful,
│ │ │ │ │ +# but WITHOUT ANY WARRANTY; without even the implied warranty of
│ │ │ │ │ +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
│ │ │ │ │ +# GNU General Public License for more details.
│ │ │ │ │ +#
│ │ │ │ │ +# You should have received a copy of the GNU General Public License
│ │ │ │ │ +# along with this program. If not, see .
│ │ │ │ │ +
│ │ │ │ │ +import argparse
│ │ │ │ │ +import asyncio
│ │ │ │ │ +import contextlib
│ │ │ │ │ +import json
│ │ │ │ │ +import logging
│ │ │ │ │ +import os
│ │ │ │ │ +import pwd
│ │ │ │ │ +import shlex
│ │ │ │ │ +import socket
│ │ │ │ │ +import stat
│ │ │ │ │ +import subprocess
│ │ │ │ │ +from typing import Iterable, List, Optional, Sequence, Tuple, Type
│ │ │ │ │ +
│ │ │ │ │ +from cockpit._vendor.ferny import interaction_client
│ │ │ │ │ +from cockpit._vendor.systemd_ctypes import bus, run_async
│ │ │ │ │ +
│ │ │ │ │ +from . import polyfills
│ │ │ │ │ +from ._version import __version__
│ │ │ │ │ +from .channel import ChannelRoutingRule
│ │ │ │ │ +from .channels import CHANNEL_TYPES
│ │ │ │ │ +from .config import Config, Environment
│ │ │ │ │ +from .internal_endpoints import EXPORTS
│ │ │ │ │ +from .jsonutil import JsonError, JsonObject, get_dict
│ │ │ │ │ +from .packages import BridgeConfig, Packages, PackagesListener
│ │ │ │ │ +from .peer import PeersRoutingRule
│ │ │ │ │ +from .remote import HostRoutingRule
│ │ │ │ │ +from .router import Router
│ │ │ │ │ +from .superuser import SuperuserRoutingRule
│ │ │ │ │ +from .transports import StdioTransport
│ │ │ │ │ +
│ │ │ │ │ +logger = logging.getLogger(__name__)
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class InternalBus:
│ │ │ │ │ + exportees: List[bus.Slot]
│ │ │ │ │ +
│ │ │ │ │ + def __init__(self, exports: Iterable[Tuple[str, Type[bus.BaseObject]]]):
│ │ │ │ │ + client_socket, server_socket = socket.socketpair()
│ │ │ │ │ + self.client = bus.Bus.new(fd=client_socket.detach())
│ │ │ │ │ + self.server = bus.Bus.new(fd=server_socket.detach(), server=True)
│ │ │ │ │ + self.exportees = [self.server.add_object(path, cls()) for path, cls in exports]
│ │ │ │ │ +
│ │ │ │ │ + def export(self, path: str, obj: bus.BaseObject) -> None:
│ │ │ │ │ + self.exportees.append(self.server.add_object(path, obj))
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class Bridge(Router, PackagesListener):
│ │ │ │ │ + internal_bus: InternalBus
│ │ │ │ │ + packages: Optional[Packages]
│ │ │ │ │ + bridge_configs: Sequence[BridgeConfig]
│ │ │ │ │ + args: argparse.Namespace
│ │ │ │ │ +
│ │ │ │ │ + def __init__(self, args: argparse.Namespace):
│ │ │ │ │ + self.internal_bus = InternalBus(EXPORTS)
│ │ │ │ │ + self.bridge_configs = []
│ │ │ │ │ + self.args = args
│ │ │ │ │ +
│ │ │ │ │ + self.superuser_rule = SuperuserRoutingRule(self, privileged=args.privileged)
│ │ │ │ │ + self.internal_bus.export('/superuser', self.superuser_rule)
│ │ │ │ │ +
│ │ │ │ │ + self.internal_bus.export('/config', Config())
│ │ │ │ │ + self.internal_bus.export('/environment', Environment())
│ │ │ │ │ +
│ │ │ │ │ + self.peers_rule = PeersRoutingRule(self)
│ │ │ │ │ +
│ │ │ │ │ + if args.beipack:
│ │ │ │ │ + # Some special stuff for beipack
│ │ │ │ │ + self.superuser_rule.set_configs((
│ │ │ │ │ + BridgeConfig({
│ │ │ │ │ + "privileged": True,
│ │ │ │ │ + "spawn": ["sudo", "-k", "-A", "python3", "-ic", "# cockpit-bridge", "--privileged"],
│ │ │ │ │ + "environ": ["SUDO_ASKPASS=ferny-askpass"],
│ │ │ │ │ + }),
│ │ │ │ │ + ))
│ │ │ │ │ + self.packages = None
│ │ │ │ │ + elif args.privileged:
│ │ │ │ │ + self.packages = None
│ │ │ │ │ + else:
│ │ │ │ │ + self.packages = Packages(self)
│ │ │ │ │ + self.internal_bus.export('/packages', self.packages)
│ │ │ │ │ + self.packages_loaded()
│ │ │ │ │ +
│ │ │ │ │ + super().__init__([
│ │ │ │ │ + HostRoutingRule(self),
│ │ │ │ │ + self.superuser_rule,
│ │ │ │ │ + ChannelRoutingRule(self, CHANNEL_TYPES),
│ │ │ │ │ + self.peers_rule,
│ │ │ │ │ + ])
│ │ │ │ │ +
│ │ │ │ │ + @staticmethod
│ │ │ │ │ + def get_os_release():
│ │ │ │ │ + try:
│ │ │ │ │ + file = open('/etc/os-release', encoding='utf-8')
│ │ │ │ │ + except FileNotFoundError:
│ │ │ │ │ + try:
│ │ │ │ │ + file = open('/usr/lib/os-release', encoding='utf-8')
│ │ │ │ │ + except FileNotFoundError:
│ │ │ │ │ + logger.warning("Neither /etc/os-release nor /usr/lib/os-release exists")
│ │ │ │ │ + return {}
│ │ │ │ │ +
│ │ │ │ │ + os_release = {}
│ │ │ │ │ + for line in file.readlines():
│ │ │ │ │ + line = line.strip()
│ │ │ │ │ + if not line or line.startswith('#'):
│ │ │ │ │ + continue
│ │ │ │ │ + try:
│ │ │ │ │ + k, v = line.split('=')
│ │ │ │ │ + (v_parsed, ) = shlex.split(v) # expect exactly one token
│ │ │ │ │ + except ValueError:
│ │ │ │ │ + logger.warning('Ignoring invalid line in os-release: %r', line)
│ │ │ │ │ + continue
│ │ │ │ │ + os_release[k] = v_parsed
│ │ │ │ │ + return os_release
│ │ │ │ │ +
│ │ │ │ │ + def do_init(self, message: JsonObject) -> None:
│ │ │ │ │ + # we're only interested in the case where this is a dict, but
│ │ │ │ │ + # 'superuser' may well be `False` and that's not an error
│ │ │ │ │ + with contextlib.suppress(JsonError):
│ │ │ │ │ + superuser = get_dict(message, 'superuser')
│ │ │ │ │ + self.superuser_rule.init(superuser)
│ │ │ │ │ +
│ │ │ │ │ + def do_send_init(self) -> None:
│ │ │ │ │ + init_args = {
│ │ │ │ │ + 'capabilities': {'explicit-superuser': True},
│ │ │ │ │ + 'command': 'init',
│ │ │ │ │ + 'os-release': self.get_os_release(),
│ │ │ │ │ + 'version': 1,
│ │ │ │ │ + }
│ │ │ │ │ +
│ │ │ │ │ + if self.packages is not None:
│ │ │ │ │ + init_args['packages'] = dict.fromkeys(self.packages.packages)
│ │ │ │ │ +
│ │ │ │ │ + self.write_control(init_args)
│ │ │ │ │ +
│ │ │ │ │ + # PackagesListener interface
│ │ │ │ │ + def packages_loaded(self) -> None:
│ │ │ │ │ + assert self.packages
│ │ │ │ │ + bridge_configs = self.packages.get_bridge_configs()
│ │ │ │ │ + if self.bridge_configs != bridge_configs:
│ │ │ │ │ + self.superuser_rule.set_configs(bridge_configs)
│ │ │ │ │ + self.peers_rule.set_configs(bridge_configs)
│ │ │ │ │ + self.bridge_configs = bridge_configs
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +async def run(args) -> None:
│ │ │ │ │ + logger.debug("Hi. How are you today?")
│ │ │ │ │ +
│ │ │ │ │ + # Unit tests require this
│ │ │ │ │ + me = pwd.getpwuid(os.getuid())
│ │ │ │ │ + os.environ['HOME'] = me.pw_dir
│ │ │ │ │ + os.environ['SHELL'] = me.pw_shell
│ │ │ │ │ + os.environ['USER'] = me.pw_name
│ │ │ │ │ +
│ │ │ │ │ + logger.debug('Starting the router.')
│ │ │ │ │ + router = Bridge(args)
│ │ │ │ │ + StdioTransport(asyncio.get_running_loop(), router)
│ │ │ │ │ +
│ │ │ │ │ + logger.debug('Startup done. Looping until connection closes.')
│ │ │ │ │ +
│ │ │ │ │ + try:
│ │ │ │ │ + await router.communicate()
│ │ │ │ │ + except (BrokenPipeError, ConnectionResetError):
│ │ │ │ │ + # not unexpected if the peer doesn't hang up cleanly
│ │ │ │ │ + pass
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +def try_to_receive_stderr():
│ │ │ │ │ + try:
│ │ │ │ │ + ours, theirs = socket.socketpair()
│ │ │ │ │ + with ours:
│ │ │ │ │ + with theirs:
│ │ │ │ │ + interaction_client.command(2, 'cockpit.send-stderr', fds=[theirs.fileno()])
│ │ │ │ │ + _msg, fds, _flags, _addr = socket.recv_fds(ours, 1, 1)
│ │ │ │ │ + except OSError:
│ │ │ │ │ + return
│ │ │ │ │ +
│ │ │ │ │ + try:
│ │ │ │ │ + stderr_fd, = fds
│ │ │ │ │ + # We're about to abruptly drop our end of the stderr socketpair that we
│ │ │ │ │ + # share with the ferny agent. ferny would normally treat that as an
│ │ │ │ │ + # unexpected error. Instruct it to do a clean exit, instead.
│ │ │ │ │ + interaction_client.command(2, 'ferny.end')
│ │ │ │ │ + os.dup2(stderr_fd, 2)
│ │ │ │ │ + finally:
│ │ │ │ │ + for fd in fds:
│ │ │ │ │ + os.close(fd)
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +def setup_journald() -> bool:
│ │ │ │ │ + # If stderr is a socket, prefer systemd-journal logging. This covers the
│ │ │ │ │ + # case we're already connected to the journal but also the case where we're
│ │ │ │ │ + # talking to the ferny agent, while leaving logging to file or terminal
│ │ │ │ │ + # unaffected.
│ │ │ │ │ + if not stat.S_ISSOCK(os.fstat(2).st_mode):
│ │ │ │ │ + # not a socket? Don't redirect.
│ │ │ │ │ + return False
│ │ │ │ │ +
│ │ │ │ │ + try:
│ │ │ │ │ + import systemd.journal # type: ignore[import]
│ │ │ │ │ + except ImportError:
│ │ │ │ │ + # No python3-systemd? Don't redirect.
│ │ │ │ │ + return False
│ │ │ │ │ +
│ │ │ │ │ + logging.root.addHandler(systemd.journal.JournalHandler())
│ │ │ │ │ + return True
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +def setup_logging(*, debug: bool) -> None:
│ │ │ │ │ + """Setup our logger with optional filtering of modules if COCKPIT_DEBUG env is set"""
│ │ │ │ │ +
│ │ │ │ │ + modules = os.getenv('COCKPIT_DEBUG', '')
│ │ │ │ │ +
│ │ │ │ │ + # Either setup logging via journal or via formatted messages to stderr
│ │ │ │ │ + if not setup_journald():
│ │ │ │ │ + logging.basicConfig(format='%(name)s-%(levelname)s: %(message)s')
│ │ │ │ │ +
│ │ │ │ │ + if debug or modules == 'all':
│ │ │ │ │ + logging.getLogger().setLevel(level=logging.DEBUG)
│ │ │ │ │ + elif modules:
│ │ │ │ │ + for module in modules.split(','):
│ │ │ │ │ + module = module.strip()
│ │ │ │ │ + if not module:
│ │ │ │ │ + continue
│ │ │ │ │ +
│ │ │ │ │ + logging.getLogger(module).setLevel(logging.DEBUG)
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +def start_ssh_agent() -> None:
│ │ │ │ │ + # Launch the agent so that it goes down with us on EOF; PDEATHSIG would be more robust,
│ │ │ │ │ + # but it gets cleared on setgid ssh-agent, which some distros still do
│ │ │ │ │ + try:
│ │ │ │ │ + proc = subprocess.Popen(['ssh-agent', 'sh', '-ec', 'echo SSH_AUTH_SOCK=$SSH_AUTH_SOCK; read a'],
│ │ │ │ │ + stdin=subprocess.PIPE, stdout=subprocess.PIPE, universal_newlines=True)
│ │ │ │ │ + assert proc.stdout is not None
│ │ │ │ │ +
│ │ │ │ │ + # Wait for the agent to write at least one line and look for the
│ │ │ │ │ + # listener socket. If we fail to find it, kill the agent — something
│ │ │ │ │ + # went wrong.
│ │ │ │ │ + for token in shlex.shlex(proc.stdout.readline(), punctuation_chars=True):
│ │ │ │ │ + if token.startswith('SSH_AUTH_SOCK='):
│ │ │ │ │ + os.environ['SSH_AUTH_SOCK'] = token.replace('SSH_AUTH_SOCK=', '', 1)
│ │ │ │ │ + break
│ │ │ │ │ + else:
│ │ │ │ │ + proc.terminate()
│ │ │ │ │ + proc.wait()
│ │ │ │ │ +
│ │ │ │ │ + except FileNotFoundError:
│ │ │ │ │ + logger.debug("Couldn't start ssh-agent (FileNotFoundError)")
│ │ │ │ │ +
│ │ │ │ │ + except OSError as exc:
│ │ │ │ │ + logger.warning("Could not start ssh-agent: %s", exc)
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +def main(*, beipack: bool = False) -> None:
│ │ │ │ │ + polyfills.install()
│ │ │ │ │ +
│ │ │ │ │ + parser = argparse.ArgumentParser(description='cockpit-bridge is run automatically inside of a Cockpit session.')
│ │ │ │ │ + parser.add_argument('--privileged', action='store_true', help='Privileged copy of the bridge')
│ │ │ │ │ + parser.add_argument('--packages', action='store_true', help='Show Cockpit package information')
│ │ │ │ │ + parser.add_argument('--bridges', action='store_true', help='Show Cockpit bridges information')
│ │ │ │ │ + parser.add_argument('--debug', action='store_true', help='Enable debug output (very verbose)')
│ │ │ │ │ + parser.add_argument('--version', action='store_true', help='Show Cockpit version information')
│ │ │ │ │ + args = parser.parse_args()
│ │ │ │ │ +
│ │ │ │ │ + # This is determined by who calls us
│ │ │ │ │ + args.beipack = beipack
│ │ │ │ │ +
│ │ │ │ │ + # If we were run with --privileged then our stderr is currently being
│ │ │ │ │ + # consumed by the main bridge looking for startup-related error messages.
│ │ │ │ │ + # Let's switch back to the original stderr stream, which has a side-effect
│ │ │ │ │ + # of indicating that our startup is more or less complete. Any errors
│ │ │ │ │ + # after this point will land in the journal.
│ │ │ │ │ + if args.privileged:
│ │ │ │ │ + try_to_receive_stderr()
│ │ │ │ │ +
│ │ │ │ │ + setup_logging(debug=args.debug)
│ │ │ │ │ +
│ │ │ │ │ + # Special modes
│ │ │ │ │ + if args.packages:
│ │ │ │ │ + Packages().show()
│ │ │ │ │ + return
│ │ │ │ │ + elif args.version:
│ │ │ │ │ + print(f'Version: {__version__}\nProtocol: 1')
│ │ │ │ │ + return
│ │ │ │ │ + elif args.bridges:
│ │ │ │ │ + print(json.dumps([config.__dict__ for config in Packages().get_bridge_configs()], indent=2))
│ │ │ │ │ + return
│ │ │ │ │ +
│ │ │ │ │ + # The privileged bridge doesn't need ssh-agent, but the main one does
│ │ │ │ │ + if 'SSH_AUTH_SOCK' not in os.environ and not args.privileged:
│ │ │ │ │ + start_ssh_agent()
│ │ │ │ │ +
│ │ │ │ │ + # asyncio.run() shim for Python 3.6 support
│ │ │ │ │ + run_async(run(args), debug=args.debug)
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +if __name__ == '__main__':
│ │ │ │ │ + main()
│ │ │ │ │ +'''.encode('utf-8'),
│ │ │ │ │ + 'cockpit/remote.py': r'''# This file is part of Cockpit.
│ │ │ │ │ +#
│ │ │ │ │ +# Copyright (C) 2022 Red Hat, Inc.
│ │ │ │ │ +#
│ │ │ │ │ +# This program is free software: you can redistribute it and/or modify
│ │ │ │ │ +# it under the terms of the GNU General Public License as published by
│ │ │ │ │ +# the Free Software Foundation, either version 3 of the License, or
│ │ │ │ │ +# (at your option) any later version.
│ │ │ │ │ +#
│ │ │ │ │ +# This program is distributed in the hope that it will be useful,
│ │ │ │ │ +# but WITHOUT ANY WARRANTY; without even the implied warranty of
│ │ │ │ │ +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
│ │ │ │ │ +# GNU General Public License for more details.
│ │ │ │ │ +#
│ │ │ │ │ +# You should have received a copy of the GNU General Public License
│ │ │ │ │ +# along with this program. If not, see .
│ │ │ │ │ +
│ │ │ │ │ +import getpass
│ │ │ │ │ +import logging
│ │ │ │ │ +import re
│ │ │ │ │ +import socket
│ │ │ │ │ +from typing import Dict, List, Optional, Tuple
│ │ │ │ │ +
│ │ │ │ │ +from cockpit._vendor import ferny
│ │ │ │ │ +
│ │ │ │ │ +from .jsonutil import JsonObject, JsonValue, get_str, get_str_or_none
│ │ │ │ │ +from .peer import Peer, PeerError
│ │ │ │ │ +from .router import Router, RoutingRule
│ │ │ │ │ +
│ │ │ │ │ +logger = logging.getLogger(__name__)
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class PasswordResponder(ferny.AskpassHandler):
│ │ │ │ │ + PASSPHRASE_RE = re.compile(r"Enter passphrase for key '(.*)': ")
│ │ │ │ │ +
│ │ │ │ │ + password: Optional[str]
│ │ │ │ │ +
│ │ │ │ │ + hostkeys_seen: List[Tuple[str, str, str, str, str]]
│ │ │ │ │ + error_message: Optional[str]
│ │ │ │ │ + password_attempts: int
│ │ │ │ │ +
│ │ │ │ │ + def __init__(self, password: Optional[str]):
│ │ │ │ │ + self.password = password
│ │ │ │ │ +
│ │ │ │ │ + self.hostkeys_seen = []
│ │ │ │ │ + self.error_message = None
│ │ │ │ │ + self.password_attempts = 0
│ │ │ │ │ +
│ │ │ │ │ + async def do_hostkey(self, reason: str, host: str, algorithm: str, key: str, fingerprint: str) -> bool:
│ │ │ │ │ + self.hostkeys_seen.append((reason, host, algorithm, key, fingerprint))
│ │ │ │ │ + return False
│ │ │ │ │ +
│ │ │ │ │ + async def do_askpass(self, messages: str, prompt: str, hint: str) -> Optional[str]:
│ │ │ │ │ + logger.debug('Got askpass(%s): %s', hint, prompt)
│ │ │ │ │ +
│ │ │ │ │ + match = PasswordResponder.PASSPHRASE_RE.fullmatch(prompt)
│ │ │ │ │ + if match is not None:
│ │ │ │ │ + # We never unlock private keys — we rather need to throw a
│ │ │ │ │ + # specially-formatted error message which will cause the frontend
│ │ │ │ │ + # to load the named key into the agent for us and try again.
│ │ │ │ │ + path = match.group(1)
│ │ │ │ │ + logger.debug("This is a passphrase request for %s, but we don't do those. Abort.", path)
│ │ │ │ │ + self.error_message = f'locked identity: {path}'
│ │ │ │ │ + return None
│ │ │ │ │ +
│ │ │ │ │ + assert self.password is not None
│ │ │ │ │ + assert self.password_attempts == 0
│ │ │ │ │ + self.password_attempts += 1
│ │ │ │ │ + return self.password
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class SshPeer(Peer):
│ │ │ │ │ + session: Optional[ferny.Session] = None
│ │ │ │ │ + host: str
│ │ │ │ │ + user: Optional[str]
│ │ │ │ │ + password: Optional[str]
│ │ │ │ │ + private: bool
│ │ │ │ │ +
│ │ │ │ │ + async def do_connect_transport(self) -> None:
│ │ │ │ │ + assert self.session is not None
│ │ │ │ │ + logger.debug('Starting ssh session user=%s, host=%s, private=%s', self.user, self.host, self.private)
│ │ │ │ │ +
│ │ │ │ │ + basename, colon, portstr = self.host.rpartition(':')
│ │ │ │ │ + if colon and portstr.isdigit():
│ │ │ │ │ + host = basename
│ │ │ │ │ + port = int(portstr)
│ │ │ │ │ + else:
│ │ │ │ │ + host = self.host
│ │ │ │ │ + port = None
│ │ │ │ │ +
│ │ │ │ │ + responder = PasswordResponder(self.password)
│ │ │ │ │ + options = {"StrictHostKeyChecking": 'yes'}
│ │ │ │ │ +
│ │ │ │ │ + if self.password is not None:
│ │ │ │ │ + options.update(NumberOfPasswordPrompts='1')
│ │ │ │ │ + else:
│ │ │ │ │ + options.update(PasswordAuthentication="no", KbdInteractiveAuthentication="no")
│ │ │ │ │ +
│ │ │ │ │ + try:
│ │ │ │ │ + await self.session.connect(host, login_name=self.user, port=port,
│ │ │ │ │ + handle_host_key=self.private, options=options,
│ │ │ │ │ + interaction_responder=responder)
│ │ │ │ │ + except (OSError, socket.gaierror) as exc:
│ │ │ │ │ + logger.debug('connecting to host %s failed: %s', host, exc)
│ │ │ │ │ + raise PeerError('no-host', error='no-host', message=str(exc)) from exc
│ │ │ │ │ +
│ │ │ │ │ + except ferny.SshHostKeyError as exc:
│ │ │ │ │ + if responder.hostkeys_seen:
│ │ │ │ │ + # If we saw a hostkey then we can issue a detailed error message
│ │ │ │ │ + # containing the key that would need to be accepted. That will
│ │ │ │ │ + # cause the front-end to present a dialog.
│ │ │ │ │ + _reason, host, algorithm, key, fingerprint = responder.hostkeys_seen[0]
│ │ │ │ │ + error_args = {'host-key': f'{host} {algorithm} {key}', 'host-fingerprint': fingerprint}
│ │ │ │ │ + else:
│ │ │ │ │ + error_args = {}
│ │ │ │ │ +
│ │ │ │ │ + if isinstance(exc, ferny.SshChangedHostKeyError):
│ │ │ │ │ + error = 'invalid-hostkey'
│ │ │ │ │ + elif self.private:
│ │ │ │ │ + error = 'unknown-hostkey'
│ │ │ │ │ + else:
│ │ │ │ │ + # non-private session case. throw a generic error.
│ │ │ │ │ + error = 'unknown-host'
│ │ │ │ │ +
│ │ │ │ │ + logger.debug('SshPeer got a %s %s; private %s, seen hostkeys %r; raising %s with extra args %r',
│ │ │ │ │ + type(exc), exc, self.private, responder.hostkeys_seen, error, error_args)
│ │ │ │ │ + raise PeerError(error, error_args, error=error, auth_method_results={}) from exc
│ │ │ │ │ +
│ │ │ │ │ + except ferny.SshAuthenticationError as exc:
│ │ │ │ │ + logger.debug('authentication to host %s failed: %s', host, exc)
│ │ │ │ │ +
│ │ │ │ │ + results = dict.fromkeys(exc.methods, "not-provided")
│ │ │ │ │ + if 'password' in results and self.password is not None:
│ │ │ │ │ + if responder.password_attempts == 0:
│ │ │ │ │ + results['password'] = 'not-tried'
│ │ │ │ │ + else:
│ │ │ │ │ + results['password'] = 'denied'
│ │ │ │ │ +
│ │ │ │ │ + raise PeerError('authentication-failed',
│ │ │ │ │ + error=responder.error_message or 'authentication-failed',
│ │ │ │ │ + auth_method_results=results) from exc
│ │ │ │ │ +
│ │ │ │ │ + except ferny.SshError as exc:
│ │ │ │ │ + logger.debug('unknown failure connecting to host %s: %s', host, exc)
│ │ │ │ │ + raise PeerError('internal-error', message=str(exc)) from exc
│ │ │ │ │ +
│ │ │ │ │ + args = self.session.wrap_subprocess_args(['cockpit-bridge'])
│ │ │ │ │ + await self.spawn(args, [])
│ │ │ │ │ +
│ │ │ │ │ + def do_kill(self, host: 'str | None', group: 'str | None', message: JsonObject) -> None:
│ │ │ │ │ + if host == self.host:
│ │ │ │ │ + self.close()
│ │ │ │ │ + elif host is None:
│ │ │ │ │ + super().do_kill(host, group, message)
│ │ │ │ │ +
│ │ │ │ │ + def do_authorize(self, message: JsonObject) -> None:
│ │ │ │ │ + if get_str(message, 'challenge').startswith('plain1:'):
│ │ │ │ │ + cookie = get_str(message, 'cookie')
│ │ │ │ │ + self.write_control(command='authorize', cookie=cookie, response=self.password or '')
│ │ │ │ │ + self.password = None # once is enough...
│ │ │ │ │ +
│ │ │ │ │ + def do_superuser_init_done(self) -> None:
│ │ │ │ │ + self.password = None
│ │ │ │ │ +
│ │ │ │ │ + def __init__(self, router: Router, host: str, user: Optional[str], options: JsonObject, *, private: bool) -> None:
│ │ │ │ │ + super().__init__(router)
│ │ │ │ │ + self.host = host
│ │ │ │ │ + self.user = user
│ │ │ │ │ + self.password = get_str(options, 'password', None)
│ │ │ │ │ + self.private = private
│ │ │ │ │ +
│ │ │ │ │ + self.session = ferny.Session()
│ │ │ │ │ +
│ │ │ │ │ + superuser: JsonValue
│ │ │ │ │ + init_superuser = get_str_or_none(options, 'init-superuser', None)
│ │ │ │ │ + if init_superuser in (None, 'none'):
│ │ │ │ │ + superuser = False
│ │ │ │ │ + else:
│ │ │ │ │ + superuser = {'id': init_superuser}
│ │ │ │ │ +
│ │ │ │ │ + self.start_in_background(init_host=host, superuser=superuser)
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class HostRoutingRule(RoutingRule):
│ │ │ │ │ + remotes: Dict[Tuple[str, Optional[str], Optional[str]], Peer]
│ │ │ │ │ +
│ │ │ │ │ + def __init__(self, router):
│ │ │ │ │ + super().__init__(router)
│ │ │ │ │ + self.remotes = {}
│ │ │ │ │ +
│ │ │ │ │ + def apply_rule(self, options: JsonObject) -> Optional[Peer]:
│ │ │ │ │ + assert self.router is not None
│ │ │ │ │ + assert self.router.init_host is not None
│ │ │ │ │ +
│ │ │ │ │ + host = get_str(options, 'host', self.router.init_host)
│ │ │ │ │ + if host == self.router.init_host:
│ │ │ │ │ + return None
│ │ │ │ │ +
│ │ │ │ │ + user = get_str(options, 'user', None)
│ │ │ │ │ + # HACK: the front-end relies on this for tracking connections without an explicit user name;
│ │ │ │ │ + # the user will then be determined by SSH (`User` in the config or the current user)
│ │ │ │ │ + # See cockpit_router_normalize_host_params() in src/bridge/cockpitrouter.c
│ │ │ │ │ + if user == getpass.getuser():
│ │ │ │ │ + user = None
│ │ │ │ │ + if not user:
│ │ │ │ │ + user_from_host, _, _ = host.rpartition('@')
│ │ │ │ │ + user = user_from_host or None # avoid ''
│ │ │ │ │ +
│ │ │ │ │ + if get_str(options, 'session', None) == 'private':
│ │ │ │ │ + nonce = get_str(options, 'channel')
│ │ │ │ │ + else:
│ │ │ │ │ + nonce = None
│ │ │ │ │ +
│ │ │ │ │ + assert isinstance(host, str)
│ │ │ │ │ + assert user is None or isinstance(user, str)
│ │ │ │ │ + assert nonce is None or isinstance(nonce, str)
│ │ │ │ │ +
│ │ │ │ │ + key = host, user, nonce
│ │ │ │ │ +
│ │ │ │ │ + logger.debug('Request for channel %s is remote.', options)
│ │ │ │ │ + logger.debug('key=%s', key)
│ │ │ │ │ +
│ │ │ │ │ + if key not in self.remotes:
│ │ │ │ │ + logger.debug('%s is not among the existing remotes %s. Opening a new connection.', key, self.remotes)
│ │ │ │ │ + peer = SshPeer(self.router, host, user, options, private=nonce is not None)
│ │ │ │ │ + peer.add_done_callback(lambda: self.remotes.__delitem__(key))
│ │ │ │ │ + self.remotes[key] = peer
│ │ │ │ │ +
│ │ │ │ │ + return self.remotes[key]
│ │ │ │ │ +
│ │ │ │ │ + def shutdown(self):
│ │ │ │ │ + for peer in set(self.remotes.values()):
│ │ │ │ │ + peer.close()
│ │ │ │ │ +'''.encode('utf-8'),
│ │ │ │ │ + 'cockpit/superuser.py': br'''# This file is part of Cockpit.
│ │ │ │ │ +#
│ │ │ │ │ +# Copyright (C) 2022 Red Hat, Inc.
│ │ │ │ │ +#
│ │ │ │ │ +# This program is free software: you can redistribute it and/or modify
│ │ │ │ │ +# it under the terms of the GNU General Public License as published by
│ │ │ │ │ +# the Free Software Foundation, either version 3 of the License, or
│ │ │ │ │ +# (at your option) any later version.
│ │ │ │ │ +#
│ │ │ │ │ +# This program is distributed in the hope that it will be useful,
│ │ │ │ │ +# but WITHOUT ANY WARRANTY; without even the implied warranty of
│ │ │ │ │ +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
│ │ │ │ │ +# GNU General Public License for more details.
│ │ │ │ │ +#
│ │ │ │ │ +# You should have received a copy of the GNU General Public License
│ │ │ │ │ +# along with this program. If not, see .
│ │ │ │ │ +
│ │ │ │ │ +import array
│ │ │ │ │ +import asyncio
│ │ │ │ │ +import contextlib
│ │ │ │ │ +import getpass
│ │ │ │ │ +import logging
│ │ │ │ │ +import os
│ │ │ │ │ +import socket
│ │ │ │ │ +from tempfile import TemporaryDirectory
│ │ │ │ │ +from typing import List, Optional, Sequence, Tuple
│ │ │ │ │ +
│ │ │ │ │ +from cockpit._vendor import ferny
│ │ │ │ │ +from cockpit._vendor.bei.bootloader import make_bootloader
│ │ │ │ │ +from cockpit._vendor.systemd_ctypes import Variant, bus
│ │ │ │ │ +
│ │ │ │ │ +from .beipack import BridgeBeibootHelper
│ │ │ │ │ +from .jsonutil import JsonObject, get_str
│ │ │ │ │ +from .packages import BridgeConfig
│ │ │ │ │ +from .peer import ConfiguredPeer, Peer, PeerError
│ │ │ │ │ +from .polkit import PolkitAgent
│ │ │ │ │ +from .router import Router, RoutingError, RoutingRule
│ │ │ │ │ +
│ │ │ │ │ +logger = logging.getLogger(__name__)
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class SuperuserPeer(ConfiguredPeer):
│ │ │ │ │ + responder: ferny.AskpassHandler
│ │ │ │ │ +
│ │ │ │ │ + def __init__(self, router: Router, config: BridgeConfig, responder: ferny.AskpassHandler):
│ │ │ │ │ + super().__init__(router, config)
│ │ │ │ │ + self.responder = responder
│ │ │ │ │ +
│ │ │ │ │ + async def do_connect_transport(self) -> None:
│ │ │ │ │ + async with contextlib.AsyncExitStack() as context:
│ │ │ │ │ + if 'pkexec' in self.args:
│ │ │ │ │ + logger.debug('connecting polkit superuser peer transport %r', self.args)
│ │ │ │ │ + await context.enter_async_context(PolkitAgent(self.responder))
│ │ │ │ │ + else:
│ │ │ │ │ + logger.debug('connecting non-polkit superuser peer transport %r', self.args)
│ │ │ │ │ +
│ │ │ │ │ + responders: 'list[ferny.InteractionHandler]' = [self.responder]
│ │ │ │ │ +
│ │ │ │ │ + if '# cockpit-bridge' in self.args:
│ │ │ │ │ + logger.debug('going to beiboot superuser bridge %r', self.args)
│ │ │ │ │ + helper = BridgeBeibootHelper(self, ['--privileged'])
│ │ │ │ │ + responders.append(helper)
│ │ │ │ │ + stage1 = make_bootloader(helper.steps, gadgets=ferny.BEIBOOT_GADGETS).encode()
│ │ │ │ │ + else:
│ │ │ │ │ + stage1 = None
│ │ │ │ │ +
│ │ │ │ │ + agent = ferny.InteractionAgent(responders)
│ │ │ │ │ +
│ │ │ │ │ + if 'SUDO_ASKPASS=ferny-askpass' in self.env:
│ │ │ │ │ + tmpdir = context.enter_context(TemporaryDirectory())
│ │ │ │ │ + ferny_askpass = ferny.write_askpass_to_tmpdir(tmpdir)
│ │ │ │ │ + env: Sequence[str] = [f'SUDO_ASKPASS={ferny_askpass}']
│ │ │ │ │ + else:
│ │ │ │ │ + env = self.env
│ │ │ │ │ +
│ │ │ │ │ + transport = await self.spawn(self.args, env, stderr=agent, start_new_session=True)
│ │ │ │ │ +
│ │ │ │ │ + if stage1 is not None:
│ │ │ │ │ + transport.write(stage1)
│ │ │ │ │ +
│ │ │ │ │ + try:
│ │ │ │ │ + await agent.communicate()
│ │ │ │ │ + except ferny.InteractionError as exc:
│ │ │ │ │ + raise PeerError('authentication-failed', message=str(exc)) from exc
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class CockpitResponder(ferny.AskpassHandler):
│ │ │ │ │ + commands = ('ferny.askpass', 'cockpit.send-stderr')
│ │ │ │ │ +
│ │ │ │ │ + async def do_custom_command(self, command: str, args: Tuple, fds: List[int], stderr: str) -> None:
│ │ │ │ │ + if command == 'cockpit.send-stderr':
│ │ │ │ │ + with socket.socket(fileno=fds[0]) as sock:
│ │ │ │ │ + fds.pop(0)
│ │ │ │ │ + # socket.send_fds(sock, [b'\0'], [2]) # New in Python 3.9
│ │ │ │ │ + sock.sendmsg([b'\0'], [(socket.SOL_SOCKET, socket.SCM_RIGHTS, array.array("i", [2]))])
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class AuthorizeResponder(CockpitResponder):
│ │ │ │ │ + def __init__(self, router: Router):
│ │ │ │ │ + self.router = router
│ │ │ │ │ +
│ │ │ │ │ + async def do_askpass(self, messages: str, prompt: str, hint: str) -> str:
│ │ │ │ │ + hexuser = ''.join(f'{c:02x}' for c in getpass.getuser().encode('ascii'))
│ │ │ │ │ + return await self.router.request_authorization(f'plain1:{hexuser}')
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +class SuperuserRoutingRule(RoutingRule, CockpitResponder, bus.Object, interface='cockpit.Superuser'):
│ │ │ │ │ + superuser_configs: Sequence[BridgeConfig] = ()
│ │ │ │ │ + pending_prompt: Optional[asyncio.Future]
│ │ │ │ │ + peer: Optional[SuperuserPeer]
│ │ │ │ │ +
│ │ │ │ │ + # D-Bus signals
│ │ │ │ │ + prompt = bus.Interface.Signal('s', 's', 's', 'b', 's') # message, prompt, default, echo, error
│ │ │ │ │ +
│ │ │ │ │ + # D-Bus properties
│ │ │ │ │ + bridges = bus.Interface.Property('as', value=[])
│ │ │ │ │ + current = bus.Interface.Property('s', value='none')
│ │ │ │ │ + methods = bus.Interface.Property('a{sv}', value={})
│ │ │ │ │ +
│ │ │ │ │ + # RoutingRule
│ │ │ │ │ + def apply_rule(self, options: JsonObject) -> Optional[Peer]:
│ │ │ │ │ + superuser = options.get('superuser')
│ │ │ │ │ +
│ │ │ │ │ + if not superuser or self.current == 'root':
│ │ │ │ │ + # superuser not requested, or already superuser? Next rule.
│ │ │ │ │ + return None
│ │ │ │ │ + elif self.peer or superuser == 'try':
│ │ │ │ │ + # superuser requested and active? Return it.
│ │ │ │ │ + # 'try' requested? Either return the peer, or None.
│ │ │ │ │ + return self.peer
│ │ │ │ │ + else:
│ │ │ │ │ + # superuser requested, but not active? That's an error.
│ │ │ │ │ + raise RoutingError('access-denied')
│ │ │ │ │ +
│ │ │ │ │ + # ferny.AskpassHandler
│ │ │ │ │ + async def do_askpass(self, messages: str, prompt: str, hint: str) -> Optional[str]:
│ │ │ │ │ + assert self.pending_prompt is None
│ │ │ │ │ + echo = hint == "confirm"
│ │ │ │ │ + self.pending_prompt = asyncio.get_running_loop().create_future()
│ │ │ │ │ + try:
│ │ │ │ │ + logger.debug('prompting for %s', prompt)
│ │ │ │ │ + # with sudo, all stderr messages are treated as warning/errors by the UI
│ │ │ │ │ + # (such as the lecture or "wrong password"), so pass them in the "error" field
│ │ │ │ │ + self.prompt('', prompt, '', echo, messages)
│ │ │ │ │ + return await self.pending_prompt
│ │ │ │ │ + finally:
│ │ │ │ │ + self.pending_prompt = None
│ │ │ │ │ +
│ │ │ │ │ + def __init__(self, router: Router, *, privileged: bool = False):
│ │ │ │ │ + super().__init__(router)
│ │ │ │ │ +
│ │ │ │ │ + self.pending_prompt = None
│ │ │ │ │ + self.peer = None
│ │ │ │ │ + self.startup = None
│ │ │ │ │ +
│ │ │ │ │ + if privileged or os.getuid() == 0:
│ │ │ │ │ + self.current = 'root'
│ │ │ │ │ +
│ │ │ │ │ + def peer_done(self):
│ │ │ │ │ + self.current = 'none'
│ │ │ │ │ + self.peer = None
│ │ │ │ │ +
│ │ │ │ │ + async def go(self, name: str, responder: ferny.AskpassHandler) -> None:
│ │ │ │ │ + if self.current != 'none':
│ │ │ │ │ + raise bus.BusError('cockpit.Superuser.Error', 'Superuser bridge already running')
│ │ │ │ │ +
│ │ │ │ │ + assert self.peer is None
│ │ │ │ │ + assert self.startup is None
│ │ │ │ │ +
│ │ │ │ │ + for config in self.superuser_configs:
│ │ │ │ │ + if name in (config.name, 'any'):
│ │ │ │ │ + break
│ │ │ │ │ + else:
│ │ │ │ │ + raise bus.BusError('cockpit.Superuser.Error', f'Unknown superuser bridge type "{name}"')
│ │ │ │ │ +
│ │ │ │ │ + self.current = 'init'
│ │ │ │ │ + self.peer = SuperuserPeer(self.router, config, responder)
│ │ │ │ │ + self.peer.add_done_callback(self.peer_done)
│ │ │ │ │ +
│ │ │ │ │ + try:
│ │ │ │ │ + await self.peer.start(init_host=self.router.init_host)
│ │ │ │ │ + except asyncio.CancelledError:
│ │ │ │ │ + raise bus.BusError('cockpit.Superuser.Error.Cancelled', 'Operation aborted') from None
│ │ │ │ │ + except (OSError, PeerError) as exc:
│ │ │ │ │ + raise bus.BusError('cockpit.Superuser.Error', str(exc)) from exc
│ │ │ │ │ +
│ │ │ │ │ + self.current = self.peer.config.name
│ │ │ │ │ +
│ │ │ │ │ + def set_configs(self, configs: Sequence[BridgeConfig]):
│ │ │ │ │ + logger.debug("set_configs() with %d items", len(configs))
│ │ │ │ │ + configs = [config for config in configs if config.privileged]
│ │ │ │ │ + self.superuser_configs = tuple(configs)
│ │ │ │ │ + self.bridges = [config.name for config in self.superuser_configs]
│ │ │ │ │ + self.methods = {c.label: Variant({'label': Variant(c.label)}, 'a{sv}') for c in configs if c.label}
│ │ │ │ │ +
│ │ │ │ │ + logger.debug(" bridges are now %s", self.bridges)
│ │ │ │ │ +
│ │ │ │ │ + # If the currently active bridge config is not in the new set of configs, stop it
│ │ │ │ │ + if self.peer is not None:
│ │ │ │ │ + if self.peer.config not in self.superuser_configs:
│ │ │ │ │ + logger.debug(" stopping superuser bridge '%s': it disappeared from configs", self.peer.config.name)
│ │ │ │ │ + self.stop()
│ │ │ │ │ +
│ │ │ │ │ + def cancel_prompt(self):
│ │ │ │ │ + if self.pending_prompt is not None:
│ │ │ │ │ + self.pending_prompt.cancel()
│ │ │ │ │ + self.pending_prompt = None
│ │ │ │ │ +
│ │ │ │ │ + def shutdown(self):
│ │ │ │ │ + self.cancel_prompt()
│ │ │ │ │ +
│ │ │ │ │ + if self.peer is not None:
│ │ │ │ │ + self.peer.close()
│ │ │ │ │ +
│ │ │ │ │ + # close() should have disconnected the peer immediately
│ │ │ │ │ + assert self.peer is None
│ │ │ │ │ +
│ │ │ │ │ + # Connect-on-startup functionality
│ │ │ │ │ + def init(self, params: JsonObject) -> None:
│ │ │ │ │ + name = get_str(params, 'id', 'any')
│ │ │ │ │ + responder = AuthorizeResponder(self.router)
│ │ │ │ │ + self._init_task = asyncio.create_task(self.go(name, responder))
│ │ │ │ │ + self._init_task.add_done_callback(self._init_done)
│ │ │ │ │ +
│ │ │ │ │ + def _init_done(self, task: 'asyncio.Task[None]') -> None:
│ │ │ │ │ + logger.debug('superuser init done! %s', task.exception())
│ │ │ │ │ + self.router.write_control(command='superuser-init-done')
│ │ │ │ │ + del self._init_task
│ │ │ │ │ +
│ │ │ │ │ + # D-Bus methods
│ │ │ │ │ + @bus.Interface.Method(in_types=['s'])
│ │ │ │ │ + async def start(self, name: str) -> None:
│ │ │ │ │ + await self.go(name, self)
│ │ │ │ │ +
│ │ │ │ │ + @bus.Interface.Method()
│ │ │ │ │ + def stop(self) -> None:
│ │ │ │ │ + self.shutdown()
│ │ │ │ │ +
│ │ │ │ │ + @bus.Interface.Method(in_types=['s'])
│ │ │ │ │ + def answer(self, reply: str) -> None:
│ │ │ │ │ + if self.pending_prompt is not None:
│ │ │ │ │ + logger.debug('responding to pending prompt')
│ │ │ │ │ + self.pending_prompt.set_result(reply)
│ │ │ │ │ + else:
│ │ │ │ │ + logger.debug('got Answer, but no prompt pending')
│ │ │ │ │ +''',
│ │ │ │ │ 'cockpit/transports.py': br'''# This file is part of Cockpit.
│ │ │ │ │ #
│ │ │ │ │ # Copyright (C) 2022 Red Hat, Inc.
│ │ │ │ │ #
│ │ │ │ │ # This program is free software: you can redistribute it and/or modify
│ │ │ │ │ # it under the terms of the GNU General Public License as published by
│ │ │ │ │ # the Free Software Foundation, either version 3 of the License, or
│ │ │ │ │ @@ -617,17 +2938,17 @@
│ │ │ │ │ self._loop.remove_reader(self._fd)
│ │ │ │ │ os.close(self._fd)
│ │ │ │ │ self._fd = -1
│ │ │ │ │
│ │ │ │ │ def __del__(self) -> None:
│ │ │ │ │ self.close()
│ │ │ │ │ ''',
│ │ │ │ │ - 'cockpit/polkit.py': r'''# This file is part of Cockpit.
│ │ │ │ │ + 'cockpit/internal_endpoints.py': br'''# This file is part of Cockpit.
│ │ │ │ │ #
│ │ │ │ │ -# Copyright (C) 2023 Red Hat, Inc.
│ │ │ │ │ +# Copyright (C) 2022 Red Hat, Inc.
│ │ │ │ │ #
│ │ │ │ │ # This program is free software: you can redistribute it and/or modify
│ │ │ │ │ # it under the terms of the GNU General Public License as published by
│ │ │ │ │ # the Free Software Foundation, either version 3 of the License, or
│ │ │ │ │ # (at your option) any later version.
│ │ │ │ │ #
│ │ │ │ │ # This program is distributed in the hope that it will be useful,
│ │ │ │ │ @@ -635,168 +2956,163 @@
│ │ │ │ │ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
│ │ │ │ │ # GNU General Public License for more details.
│ │ │ │ │ #
│ │ │ │ │ # You should have received a copy of the GNU General Public License
│ │ │ │ │ # along with this program. If not, see .
│ │ │ │ │
│ │ │ │ │ import asyncio
│ │ │ │ │ -import locale
│ │ │ │ │ +import glob
│ │ │ │ │ +import grp
│ │ │ │ │ +import json
│ │ │ │ │ import logging
│ │ │ │ │ import os
│ │ │ │ │ import pwd
│ │ │ │ │ -from typing import Dict, List, Sequence, Tuple
│ │ │ │ │ -
│ │ │ │ │ -from cockpit._vendor.ferny import AskpassHandler
│ │ │ │ │ -from cockpit._vendor.systemd_ctypes import Variant, bus
│ │ │ │ │ +from pathlib import Path
│ │ │ │ │ +from typing import Dict, Optional
│ │ │ │ │
│ │ │ │ │ -# that path is valid on at least Debian, Fedora/RHEL, and Arch
│ │ │ │ │ -HELPER_PATH = '/usr/lib/polkit-1/polkit-agent-helper-1'
│ │ │ │ │ +from cockpit._vendor.systemd_ctypes import Variant, bus, inotify, pathwatch
│ │ │ │ │
│ │ │ │ │ -AGENT_DBUS_PATH = '/PolkitAgent'
│ │ │ │ │ +from . import config
│ │ │ │ │
│ │ │ │ │ logger = logging.getLogger(__name__)
│ │ │ │ │
│ │ │ │ │ -Identity = Tuple[str, Dict[str, Variant]]
│ │ │ │ │
│ │ │ │ │ +class cockpit_LoginMessages(bus.Object):
│ │ │ │ │ + messages: Optional[str] = None
│ │ │ │ │
│ │ │ │ │ -# https://www.freedesktop.org/software/polkit/docs/latest/eggdbus-interface-org.freedesktop.PolicyKit1.AuthenticationAgent.html
│ │ │ │ │ + def __init__(self):
│ │ │ │ │ + fdstr = os.environ.pop('COCKPIT_LOGIN_MESSAGES_MEMFD', None)
│ │ │ │ │ + if fdstr is None:
│ │ │ │ │ + logger.debug("COCKPIT_LOGIN_MESSAGES_MEMFD wasn't set. No login messages today.")
│ │ │ │ │ + return
│ │ │ │ │
│ │ │ │ │ -# Note that we don't implement the CancelAuthentication() API. pkexec gets called in a way that has no opportunity to
│ │ │ │ │ -# cancel an ongoing authentication from the pkexec side. On the UI side cancellation is implemented via the standard
│ │ │ │ │ -# asyncio process mechanism. If we ever need CancelAuthentication(), we could keep a cookie → get_current_task()
│ │ │ │ │ -# mapping, but that method is not available for Python 3.6 yet.
│ │ │ │ │ + logger.debug("Trying to read login messages from fd %s", fdstr)
│ │ │ │ │ + try:
│ │ │ │ │ + with open(int(fdstr), 'r') as login_messages:
│ │ │ │ │ + login_messages.seek(0)
│ │ │ │ │ + self.messages = login_messages.read()
│ │ │ │ │ + except (ValueError, OSError, UnicodeDecodeError) as exc:
│ │ │ │ │ + # ValueError - the envvar wasn't an int
│ │ │ │ │ + # OSError - the fd wasn't open, or other read failure
│ │ │ │ │ + # UnicodeDecodeError - didn't contain utf-8
│ │ │ │ │ + # For all of these, we simply failed to get the message.
│ │ │ │ │ + logger.debug("Reading login messages failed: %s", exc)
│ │ │ │ │ + else:
│ │ │ │ │ + logger.debug("Successfully read login messages: %s", self.messages)
│ │ │ │ │
│ │ │ │ │ -class org_freedesktop_PolicyKit1_AuthenticationAgent(bus.Object):
│ │ │ │ │ - def __init__(self, responder: AskpassHandler):
│ │ │ │ │ - super().__init__()
│ │ │ │ │ - self.responder = responder
│ │ │ │ │ + @bus.Interface.Method(out_types=['s'])
│ │ │ │ │ + def get(self):
│ │ │ │ │ + return self.messages or '{}'
│ │ │ │ │
│ │ │ │ │ - # confusingly named: this actually does the whole authentication dialog, see docs
│ │ │ │ │ - @bus.Interface.Method('', ['s', 's', 's', 'a{ss}', 's', 'a(sa{sv})'])
│ │ │ │ │ - async def begin_authentication(self, action_id: str, message: str, icon_name: str,
│ │ │ │ │ - details: Dict[str, str], cookie: str, identities: Sequence[Identity]) -> None:
│ │ │ │ │ - logger.debug('BeginAuthentication: action %s, message "%s", icon %s, details %s, cookie %s, identities %r',
│ │ │ │ │ - action_id, message, icon_name, details, cookie, identities)
│ │ │ │ │ - # only support authentication as ourselves, as we don't yet have the
│ │ │ │ │ - # protocol plumbing and UI to select an admin user
│ │ │ │ │ - my_uid = os.geteuid()
│ │ │ │ │ - for (auth_type, subject) in identities:
│ │ │ │ │ - if auth_type == 'unix-user' and 'uid' in subject and subject['uid'].value == my_uid:
│ │ │ │ │ - logger.debug('Authentication subject %s matches our uid %d', subject, my_uid)
│ │ │ │ │ - break
│ │ │ │ │ - else:
│ │ │ │ │ - logger.warning('Not supporting authentication as any of %s', identities)
│ │ │ │ │ - return
│ │ │ │ │ + @bus.Interface.Method(out_types=[])
│ │ │ │ │ + def dismiss(self):
│ │ │ │ │ + self.messages = None
│ │ │ │ │
│ │ │ │ │ - user_name = pwd.getpwuid(my_uid).pw_name
│ │ │ │ │ - process = await asyncio.create_subprocess_exec(HELPER_PATH, user_name, cookie,
│ │ │ │ │ - stdin=asyncio.subprocess.PIPE,
│ │ │ │ │ - stdout=asyncio.subprocess.PIPE)
│ │ │ │ │ +
│ │ │ │ │ +class cockpit_Machines(bus.Object):
│ │ │ │ │ + path: Path
│ │ │ │ │ + watch: pathwatch.PathWatch
│ │ │ │ │ + pending_notify: Optional[asyncio.Handle]
│ │ │ │ │ +
│ │ │ │ │ + # D-Bus implementation
│ │ │ │ │ + machines = bus.Interface.Property('a{sa{sv}}')
│ │ │ │ │ +
│ │ │ │ │ + @machines.getter
│ │ │ │ │ + def get_machines(self) -> Dict[str, Dict[str, Variant]]:
│ │ │ │ │ + results: Dict[str, Dict[str, Variant]] = {}
│ │ │ │ │ +
│ │ │ │ │ + for filename in glob.glob(f'{self.path}/*.json'):
│ │ │ │ │ + with open(filename) as fp:
│ │ │ │ │ + try:
│ │ │ │ │ + contents = json.load(fp)
│ │ │ │ │ + except json.JSONDecodeError:
│ │ │ │ │ + logger.warning('Invalid JSON in file %s. Ignoring.', filename)
│ │ │ │ │ + continue
│ │ │ │ │ + # merge
│ │ │ │ │ + for hostname, attrs in contents.items():
│ │ │ │ │ + results[hostname] = {key: Variant(value) for key, value in attrs.items()}
│ │ │ │ │ +
│ │ │ │ │ + return results
│ │ │ │ │ +
│ │ │ │ │ + @bus.Interface.Method(in_types=['s', 's', 'a{sv}'])
│ │ │ │ │ + def update(self, filename: str, hostname: str, attrs: Dict[str, Variant]) -> None:
│ │ │ │ │ try:
│ │ │ │ │ - await self._communicate(process)
│ │ │ │ │ - except asyncio.CancelledError:
│ │ │ │ │ - logger.debug('Cancelled authentication')
│ │ │ │ │ - process.terminate()
│ │ │ │ │ - finally:
│ │ │ │ │ - res = await process.wait()
│ │ │ │ │ - logger.debug('helper exited with code %i', res)
│ │ │ │ │ + with self.path.joinpath(filename).open() as fp:
│ │ │ │ │ + contents = json.load(fp)
│ │ │ │ │ + except json.JSONDecodeError as exc:
│ │ │ │ │ + # Refuse to replace corrupted file
│ │ │ │ │ + raise bus.BusError('cockpit.Machines.Error', f'File {filename} is in invalid format: {exc}.') from exc
│ │ │ │ │ + except FileNotFoundError:
│ │ │ │ │ + # But an empty file is an expected case
│ │ │ │ │ + contents = {}
│ │ │ │ │
│ │ │ │ │ - async def _communicate(self, process: asyncio.subprocess.Process) -> None:
│ │ │ │ │ - assert process.stdin
│ │ │ │ │ - assert process.stdout
│ │ │ │ │ + contents.setdefault(hostname, {}).update({key: value.value for key, value in attrs.items()})
│ │ │ │ │
│ │ │ │ │ - messages: List[str] = []
│ │ │ │ │ + self.path.mkdir(parents=True, exist_ok=True)
│ │ │ │ │ + with open(self.path.joinpath(filename), 'w') as fp:
│ │ │ │ │ + json.dump(contents, fp, indent=2)
│ │ │ │ │
│ │ │ │ │ - async for line in process.stdout:
│ │ │ │ │ - logger.debug('Read line from helper: %s', line)
│ │ │ │ │ - command, _, value = line.strip().decode().partition(' ')
│ │ │ │ │ + def notify(self):
│ │ │ │ │ + def _notify_now():
│ │ │ │ │ + self.properties_changed('cockpit.Machines', {}, ['Machines'])
│ │ │ │ │ + self.pending_notify = None
│ │ │ │ │
│ │ │ │ │ - # usually: PAM_PROMPT_ECHO_OFF Password: \n
│ │ │ │ │ - if command.startswith('PAM_PROMPT'):
│ │ │ │ │ - # Don't pass this to the UI if it's "Password" (the usual case),
│ │ │ │ │ - # so that superuser.py uses the translated default
│ │ │ │ │ - if value.startswith('Password'):
│ │ │ │ │ - value = ''
│ │ │ │ │ + # avoid a flurry of update notifications
│ │ │ │ │ + if self.pending_notify is None:
│ │ │ │ │ + self.pending_notify = asyncio.get_running_loop().call_later(1.0, _notify_now)
│ │ │ │ │
│ │ │ │ │ - # flush out accumulated info/error messages
│ │ │ │ │ - passwd = await self.responder.do_askpass('\n'.join(messages), value, '')
│ │ │ │ │ - messages.clear()
│ │ │ │ │ - if passwd is None:
│ │ │ │ │ - logger.debug('got PAM_PROMPT %s, but do_askpass returned None', value)
│ │ │ │ │ - raise asyncio.CancelledError('no password given')
│ │ │ │ │ - logger.debug('got PAM_PROMPT %s, do_askpass returned a password', value)
│ │ │ │ │ - process.stdin.write(passwd.encode())
│ │ │ │ │ - process.stdin.write(b'\n')
│ │ │ │ │ - del passwd # don't keep this around longer than necessary
│ │ │ │ │ - await process.stdin.drain()
│ │ │ │ │ - logger.debug('got PAM_PROMPT, wrote password to helper')
│ │ │ │ │ - elif command in ('PAM_TEXT_INFO', 'PAM_ERROR'):
│ │ │ │ │ - messages.append(value)
│ │ │ │ │ - elif command == 'SUCCESS':
│ │ │ │ │ - logger.debug('Authentication succeeded')
│ │ │ │ │ - break
│ │ │ │ │ - elif command == 'FAILURE':
│ │ │ │ │ - logger.warning('Authentication failed')
│ │ │ │ │ - break
│ │ │ │ │ - else:
│ │ │ │ │ - logger.warning('Unknown line from helper, aborting: %s', line)
│ │ │ │ │ - process.terminate()
│ │ │ │ │ - break
│ │ │ │ │ + # inotify events
│ │ │ │ │ + def do_inotify_event(self, mask: inotify.Event, cookie: int, name: Optional[str]) -> None:
│ │ │ │ │ + self.notify()
│ │ │ │ │
│ │ │ │ │ + def do_identity_changed(self, fd: Optional[int], errno: Optional[int]) -> None:
│ │ │ │ │ + self.notify()
│ │ │ │ │
│ │ │ │ │ -class PolkitAgent:
│ │ │ │ │ - """Register polkit agent when required
│ │ │ │ │ + def __init__(self):
│ │ │ │ │ + self.path = config.lookup_config('machines.d')
│ │ │ │ │
│ │ │ │ │ - Use this as a context manager to ensure that the agent gets unregistered again.
│ │ │ │ │ - """
│ │ │ │ │ - def __init__(self, responder: AskpassHandler):
│ │ │ │ │ - self.responder = responder
│ │ │ │ │ - self.agent_slot = None
│ │ │ │ │ + # ignore the first callback
│ │ │ │ │ + self.pending_notify = ...
│ │ │ │ │ + self.watch = pathwatch.PathWatch(str(self.path), self)
│ │ │ │ │ + self.pending_notify = None
│ │ │ │ │
│ │ │ │ │ - async def __aenter__(self):
│ │ │ │ │ - try:
│ │ │ │ │ - self.system_bus = bus.Bus.default_system()
│ │ │ │ │ - except OSError as e:
│ │ │ │ │ - logger.warning('cannot connect to system bus, not registering polkit agent: %s', e)
│ │ │ │ │ - return self
│ │ │ │ │
│ │ │ │ │ - try:
│ │ │ │ │ - # may refine that with a D-Bus call to logind
│ │ │ │ │ - self.subject = ('unix-session', {'session-id': Variant(os.environ['XDG_SESSION_ID'], 's')})
│ │ │ │ │ - except KeyError:
│ │ │ │ │ - logger.debug('XDG_SESSION_ID not set, not registering polkit agent')
│ │ │ │ │ - return self
│ │ │ │ │ +class cockpit_User(bus.Object):
│ │ │ │ │ + name = bus.Interface.Property('s', value='')
│ │ │ │ │ + full = bus.Interface.Property('s', value='')
│ │ │ │ │ + id = bus.Interface.Property('i', value=0)
│ │ │ │ │ + gid = bus.Interface.Property('i', value=0)
│ │ │ │ │ + home = bus.Interface.Property('s', value='')
│ │ │ │ │ + shell = bus.Interface.Property('s', value='')
│ │ │ │ │ + groups = bus.Interface.Property('as', value=[])
│ │ │ │ │
│ │ │ │ │ - agent_object = org_freedesktop_PolicyKit1_AuthenticationAgent(self.responder)
│ │ │ │ │ - self.agent_slot = self.system_bus.add_object(AGENT_DBUS_PATH, agent_object)
│ │ │ │ │ + def __init__(self):
│ │ │ │ │ + user = pwd.getpwuid(os.getuid())
│ │ │ │ │ + self.name = user.pw_name
│ │ │ │ │ + self.full = user.pw_gecos
│ │ │ │ │ + self.id = user.pw_uid
│ │ │ │ │ + self.gid = user.pw_gid
│ │ │ │ │ + self.home = user.pw_dir
│ │ │ │ │ + self.shell = user.pw_shell
│ │ │ │ │
│ │ │ │ │ - # register agent
│ │ │ │ │ - locale_name = locale.setlocale(locale.LC_MESSAGES, None)
│ │ │ │ │ - await self.system_bus.call_method_async(
│ │ │ │ │ - 'org.freedesktop.PolicyKit1',
│ │ │ │ │ - '/org/freedesktop/PolicyKit1/Authority',
│ │ │ │ │ - 'org.freedesktop.PolicyKit1.Authority',
│ │ │ │ │ - 'RegisterAuthenticationAgent',
│ │ │ │ │ - '(sa{sv})ss',
│ │ │ │ │ - self.subject, locale_name, AGENT_DBUS_PATH)
│ │ │ │ │ - logger.debug('Registered agent for %r and locale %s', self.subject, locale_name)
│ │ │ │ │ - return self
│ │ │ │ │ + # We want the primary group first in the list, without duplicates.
│ │ │ │ │ + # This is a bit awkward because `set()` is unordered...
│ │ │ │ │ + groups = [grp.getgrgid(user.pw_gid).gr_name]
│ │ │ │ │ + for gr in grp.getgrall():
│ │ │ │ │ + if user.pw_name in gr.gr_mem and gr.gr_name not in groups:
│ │ │ │ │ + groups.append(gr.gr_name)
│ │ │ │ │ + self.groups = groups
│ │ │ │ │
│ │ │ │ │ - async def __aexit__(self, _exc_type, _exc_value, _traceback):
│ │ │ │ │ - if self.agent_slot:
│ │ │ │ │ - await self.system_bus.call_method_async(
│ │ │ │ │ - 'org.freedesktop.PolicyKit1',
│ │ │ │ │ - '/org/freedesktop/PolicyKit1/Authority',
│ │ │ │ │ - 'org.freedesktop.PolicyKit1.Authority',
│ │ │ │ │ - 'UnregisterAuthenticationAgent',
│ │ │ │ │ - '(sa{sv})s',
│ │ │ │ │ - self.subject, AGENT_DBUS_PATH)
│ │ │ │ │ - self.agent_slot.cancel()
│ │ │ │ │ - logger.debug('Unregistered agent for %r', self.subject)
│ │ │ │ │ -'''.encode('utf-8'),
│ │ │ │ │ +
│ │ │ │ │ +EXPORTS = [
│ │ │ │ │ + ('/LoginMessages', cockpit_LoginMessages),
│ │ │ │ │ + ('/machines', cockpit_Machines),
│ │ │ │ │ + ('/user', cockpit_User),
│ │ │ │ │ +]
│ │ │ │ │ +''',
│ │ │ │ │ 'cockpit/beipack.py': br'''# This file is part of Cockpit.
│ │ │ │ │ #
│ │ │ │ │ # Copyright (C) 2023 Red Hat, Inc.
│ │ │ │ │ #
│ │ │ │ │ # This program is free software: you can redistribute it and/or modify
│ │ │ │ │ # it under the terms of the GNU General Public License as published by
│ │ │ │ │ # the Free Software Foundation, either version 3 of the License, or
│ │ │ │ │ @@ -866,16 +3182,14 @@
│ │ │ │ │ logger.debug('Writing %d bytes of payload', len(self.payload))
│ │ │ │ │ self.peer.transport.write(self.payload)
│ │ │ │ │ elif command == 'beiboot.exc':
│ │ │ │ │ raise PeerError('internal-error', message=f'Remote exception: {args[0]}')
│ │ │ │ │ else:
│ │ │ │ │ raise PeerError('internal-error', message=f'Unexpected ferny interaction command {command}')
│ │ │ │ │ ''',
│ │ │ │ │ - 'cockpit/_version.py': br'''__version__ = '319'
│ │ │ │ │ -''',
│ │ │ │ │ 'cockpit/jsonutil.py': r'''# This file is part of Cockpit.
│ │ │ │ │ #
│ │ │ │ │ # Copyright (C) 2023 Red Hat, Inc.
│ │ │ │ │ #
│ │ │ │ │ # This program is free software: you can redistribute it and/or modify
│ │ │ │ │ # it under the terms of the GNU General Public License as published by
│ │ │ │ │ # the Free Software Foundation, either version 3 of the License, or
│ │ │ │ │ @@ -1061,15 +3375,15 @@
│ │ │ │ │ elif current_value == patch_value:
│ │ │ │ │ del patch[key]
│ │ │ │ │ elif patch_value is not None:
│ │ │ │ │ current[key] = patch_value
│ │ │ │ │ else:
│ │ │ │ │ del current[key]
│ │ │ │ │ '''.encode('utf-8'),
│ │ │ │ │ - 'cockpit/polyfills.py': br'''# This file is part of Cockpit.
│ │ │ │ │ + 'cockpit/config.py': br'''# This file is part of Cockpit.
│ │ │ │ │ #
│ │ │ │ │ # Copyright (C) 2023 Red Hat, Inc.
│ │ │ │ │ #
│ │ │ │ │ # This program is free software: you can redistribute it and/or modify
│ │ │ │ │ # it under the terms of the GNU General Public License as published by
│ │ │ │ │ # the Free Software Foundation, either version 3 of the License, or
│ │ │ │ │ # (at your option) any later version.
│ │ │ │ │ @@ -1078,321 +3392,92 @@
│ │ │ │ │ # but WITHOUT ANY WARRANTY; without even the implied warranty of
│ │ │ │ │ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
│ │ │ │ │ # GNU General Public License for more details.
│ │ │ │ │ #
│ │ │ │ │ # You should have received a copy of the GNU General Public License
│ │ │ │ │ # along with this program. If not, see .
│ │ │ │ │
│ │ │ │ │ -import contextlib
│ │ │ │ │ -import socket
│ │ │ │ │ -
│ │ │ │ │ -
│ │ │ │ │ -def install():
│ │ │ │ │ - """Add shims for older Python versions"""
│ │ │ │ │ -
│ │ │ │ │ - # introduced in 3.9
│ │ │ │ │ - if not hasattr(socket, 'recv_fds'):
│ │ │ │ │ - import array
│ │ │ │ │ -
│ │ │ │ │ - import _socket
│ │ │ │ │ -
│ │ │ │ │ - def recv_fds(sock, bufsize, maxfds, flags=0):
│ │ │ │ │ - fds = array.array("i")
│ │ │ │ │ - msg, ancdata, flags, addr = sock.recvmsg(bufsize, _socket.CMSG_LEN(maxfds * fds.itemsize))
│ │ │ │ │ - for cmsg_level, cmsg_type, cmsg_data in ancdata:
│ │ │ │ │ - if (cmsg_level == _socket.SOL_SOCKET and cmsg_type == _socket.SCM_RIGHTS):
│ │ │ │ │ - fds.frombytes(cmsg_data[:len(cmsg_data) - (len(cmsg_data) % fds.itemsize)])
│ │ │ │ │ - return msg, list(fds), flags, addr
│ │ │ │ │ -
│ │ │ │ │ - socket.recv_fds = recv_fds
│ │ │ │ │ -
│ │ │ │ │ - # introduced in 3.7
│ │ │ │ │ - if not hasattr(contextlib, 'AsyncExitStack'):
│ │ │ │ │ - class AsyncExitStack:
│ │ │ │ │ - async def __aenter__(self):
│ │ │ │ │ - self.cms = []
│ │ │ │ │ - return self
│ │ │ │ │ -
│ │ │ │ │ - async def enter_async_context(self, cm):
│ │ │ │ │ - result = await cm.__aenter__()
│ │ │ │ │ - self.cms.append(cm)
│ │ │ │ │ - return result
│ │ │ │ │ -
│ │ │ │ │ - async def __aexit__(self, exc_type, exc_value, traceback):
│ │ │ │ │ - for cm in self.cms:
│ │ │ │ │ - cm.__aexit__(exc_type, exc_value, traceback)
│ │ │ │ │ -
│ │ │ │ │ - contextlib.AsyncExitStack = AsyncExitStack
│ │ │ │ │ -''',
│ │ │ │ │ - 'cockpit/router.py': br'''# This file is part of Cockpit.
│ │ │ │ │ -#
│ │ │ │ │ -# Copyright (C) 2022 Red Hat, Inc.
│ │ │ │ │ -#
│ │ │ │ │ -# This program is free software: you can redistribute it and/or modify
│ │ │ │ │ -# it under the terms of the GNU General Public License as published by
│ │ │ │ │ -# the Free Software Foundation, either version 3 of the License, or
│ │ │ │ │ -# (at your option) any later version.
│ │ │ │ │ -#
│ │ │ │ │ -# This program is distributed in the hope that it will be useful,
│ │ │ │ │ -# but WITHOUT ANY WARRANTY; without even the implied warranty of
│ │ │ │ │ -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
│ │ │ │ │ -# GNU General Public License for more details.
│ │ │ │ │ -#
│ │ │ │ │ -# You should have received a copy of the GNU General Public License
│ │ │ │ │ -# along with this program. If not, see .
│ │ │ │ │ -
│ │ │ │ │ -import asyncio
│ │ │ │ │ -import collections
│ │ │ │ │ +import configparser
│ │ │ │ │ import logging
│ │ │ │ │ -from typing import Dict, List, Optional
│ │ │ │ │ +import os
│ │ │ │ │ +from pathlib import Path
│ │ │ │ │
│ │ │ │ │ -from .jsonutil import JsonObject, JsonValue
│ │ │ │ │ -from .protocol import CockpitProblem, CockpitProtocolError, CockpitProtocolServer
│ │ │ │ │ +from cockpit._vendor.systemd_ctypes import bus
│ │ │ │ │
│ │ │ │ │ logger = logging.getLogger(__name__)
│ │ │ │ │
│ │ │ │ │ +XDG_CONFIG_HOME = Path(os.getenv('XDG_CONFIG_HOME') or os.path.expanduser('~/.config'))
│ │ │ │ │ +DOT_CONFIG_COCKPIT = XDG_CONFIG_HOME / 'cockpit'
│ │ │ │ │
│ │ │ │ │ -class ExecutionQueue:
│ │ │ │ │ - """Temporarily delay calls to a given set of class methods.
│ │ │ │ │ -
│ │ │ │ │ - Functions by replacing the named function at the instance __dict__
│ │ │ │ │ - level, effectively providing an override for exactly one instance
│ │ │ │ │ - of `method`'s object.
│ │ │ │ │ - Queues the invocations. Run them later with .run(), which also reverses
│ │ │ │ │ - the redirection by deleting the named methods from the instance.
│ │ │ │ │ - """
│ │ │ │ │ - def __init__(self, methods):
│ │ │ │ │ - self.queue = collections.deque()
│ │ │ │ │ - self.methods = methods
│ │ │ │ │ -
│ │ │ │ │ - for method in self.methods:
│ │ │ │ │ - self._wrap(method)
│ │ │ │ │ -
│ │ │ │ │ - def _wrap(self, method):
│ │ │ │ │ - # NB: this function is stored in the instance dict and therefore
│ │ │ │ │ - # doesn't function as a descriptor, isn't a method, doesn't get bound,
│ │ │ │ │ - # and therefore doesn't receive a self parameter
│ │ │ │ │ - setattr(method.__self__, method.__func__.__name__, lambda *args: self.queue.append((method, args)))
│ │ │ │ │ -
│ │ │ │ │ - def run(self):
│ │ │ │ │ - logger.debug('ExecutionQueue: Running %d queued method calls', len(self.queue))
│ │ │ │ │ - for method, args in self.queue:
│ │ │ │ │ - method(*args)
│ │ │ │ │ -
│ │ │ │ │ - for method in self.methods:
│ │ │ │ │ - delattr(method.__self__, method.__func__.__name__)
│ │ │ │ │ -
│ │ │ │ │ -
│ │ │ │ │ -class Endpoint:
│ │ │ │ │ - router: 'Router'
│ │ │ │ │ - __endpoint_frozen_queue: Optional[ExecutionQueue] = None
│ │ │ │ │ -
│ │ │ │ │ - def __init__(self, router: 'Router'):
│ │ │ │ │ - router.add_endpoint(self)
│ │ │ │ │ - self.router = router
│ │ │ │ │ -
│ │ │ │ │ - def freeze_endpoint(self):
│ │ │ │ │ - assert self.__endpoint_frozen_queue is None
│ │ │ │ │ - logger.debug('Freezing endpoint %s', self)
│ │ │ │ │ - self.__endpoint_frozen_queue = ExecutionQueue({self.do_channel_control, self.do_channel_data, self.do_kill})
│ │ │ │ │ -
│ │ │ │ │ - def thaw_endpoint(self):
│ │ │ │ │ - assert self.__endpoint_frozen_queue is not None
│ │ │ │ │ - logger.debug('Thawing endpoint %s', self)
│ │ │ │ │ - self.__endpoint_frozen_queue.run()
│ │ │ │ │ - self.__endpoint_frozen_queue = None
│ │ │ │ │ -
│ │ │ │ │ - # interface for receiving messages
│ │ │ │ │ - def do_close(self):
│ │ │ │ │ - raise NotImplementedError
│ │ │ │ │ -
│ │ │ │ │ - def do_channel_control(self, channel: str, command: str, message: JsonObject) -> None:
│ │ │ │ │ - raise NotImplementedError
│ │ │ │ │ -
│ │ │ │ │ - def do_channel_data(self, channel: str, data: bytes) -> None:
│ │ │ │ │ - raise NotImplementedError
│ │ │ │ │ -
│ │ │ │ │ - def do_kill(self, host: 'str | None', group: 'str | None', message: JsonObject) -> None:
│ │ │ │ │ - raise NotImplementedError
│ │ │ │ │ -
│ │ │ │ │ - # interface for sending messages
│ │ │ │ │ - def send_channel_data(self, channel: str, data: bytes) -> None:
│ │ │ │ │ - self.router.write_channel_data(channel, data)
│ │ │ │ │ -
│ │ │ │ │ - def send_channel_control(
│ │ │ │ │ - self, channel: str, command: str, _msg: 'JsonObject | None', **kwargs: JsonValue
│ │ │ │ │ - ) -> None:
│ │ │ │ │ - self.router.write_control(_msg, channel=channel, command=command, **kwargs)
│ │ │ │ │ - if command == 'close':
│ │ │ │ │ - self.router.endpoints[self].remove(channel)
│ │ │ │ │ - self.router.drop_channel(channel)
│ │ │ │ │ -
│ │ │ │ │ - def shutdown_endpoint(self, _msg: 'JsonObject | None' = None, **kwargs: JsonValue) -> None:
│ │ │ │ │ - self.router.shutdown_endpoint(self, _msg, **kwargs)
│ │ │ │ │ -
│ │ │ │ │ -
│ │ │ │ │ -class RoutingError(CockpitProblem):
│ │ │ │ │ - pass
│ │ │ │ │ -
│ │ │ │ │ -
│ │ │ │ │ -class RoutingRule:
│ │ │ │ │ - router: 'Router'
│ │ │ │ │ -
│ │ │ │ │ - def __init__(self, router: 'Router'):
│ │ │ │ │ - self.router = router
│ │ │ │ │ -
│ │ │ │ │ - def apply_rule(self, options: JsonObject) -> Optional[Endpoint]:
│ │ │ │ │ - """Check if a routing rule applies to a given 'open' message.
│ │ │ │ │ -
│ │ │ │ │ - This should inspect the options dictionary and do one of the following three things:
│ │ │ │ │ -
│ │ │ │ │ - - return an Endpoint to handle this channel
│ │ │ │ │ - - raise a RoutingError to indicate that the open should be rejected
│ │ │ │ │ - - return None to let the next rule run
│ │ │ │ │ - """
│ │ │ │ │ - raise NotImplementedError
│ │ │ │ │ -
│ │ │ │ │ - def shutdown(self):
│ │ │ │ │ - raise NotImplementedError
│ │ │ │ │
│ │ │ │ │ +def lookup_config(filename: str) -> Path:
│ │ │ │ │ + config_dirs = os.environ.get('XDG_CONFIG_DIRS', '/etc').split(':')
│ │ │ │ │ + fallback = None
│ │ │ │ │ + for config_dir in config_dirs:
│ │ │ │ │ + config_path = Path(config_dir, 'cockpit', filename)
│ │ │ │ │ + if not fallback:
│ │ │ │ │ + fallback = config_path
│ │ │ │ │ + if config_path.exists():
│ │ │ │ │ + logger.debug('lookup_config(%s): found %s', filename, config_path)
│ │ │ │ │ + return config_path
│ │ │ │ │
│ │ │ │ │ -class Router(CockpitProtocolServer):
│ │ │ │ │ - routing_rules: List[RoutingRule]
│ │ │ │ │ - open_channels: Dict[str, Endpoint]
│ │ │ │ │ - endpoints: 'dict[Endpoint, set[str]]'
│ │ │ │ │ - no_endpoints: asyncio.Event # set if endpoints dict is empty
│ │ │ │ │ - _eof: bool = False
│ │ │ │ │ + # default to the first entry in XDG_CONFIG_DIRS; that's not according to the spec,
│ │ │ │ │ + # but what Cockpit has done for years
│ │ │ │ │ + logger.debug('lookup_config(%s): defaulting to %s', filename, fallback)
│ │ │ │ │ + assert fallback # mypy; config_dirs always has at least one string
│ │ │ │ │ + return fallback
│ │ │ │ │
│ │ │ │ │ - def __init__(self, routing_rules: List[RoutingRule]):
│ │ │ │ │ - for rule in routing_rules:
│ │ │ │ │ - rule.router = self
│ │ │ │ │ - self.routing_rules = routing_rules
│ │ │ │ │ - self.open_channels = {}
│ │ │ │ │ - self.endpoints = {}
│ │ │ │ │ - self.no_endpoints = asyncio.Event()
│ │ │ │ │ - self.no_endpoints.set() # at first there are no endpoints
│ │ │ │ │
│ │ │ │ │ - def check_rules(self, options: JsonObject) -> Endpoint:
│ │ │ │ │ - for rule in self.routing_rules:
│ │ │ │ │ - logger.debug(' applying rule %s', rule)
│ │ │ │ │ - endpoint = rule.apply_rule(options)
│ │ │ │ │ - if endpoint is not None:
│ │ │ │ │ - logger.debug(' resulting endpoint is %s', endpoint)
│ │ │ │ │ - return endpoint
│ │ │ │ │ - else:
│ │ │ │ │ - logger.debug(' No rules matched')
│ │ │ │ │ - raise RoutingError('not-supported')
│ │ │ │ │ +class Config(bus.Object, interface='cockpit.Config'):
│ │ │ │ │ + def __init__(self):
│ │ │ │ │ + self.reload()
│ │ │ │ │
│ │ │ │ │ - def drop_channel(self, channel: str) -> None:
│ │ │ │ │ + @bus.Interface.Method(out_types='s', in_types='ss')
│ │ │ │ │ + def get_string(self, section, key):
│ │ │ │ │ try:
│ │ │ │ │ - self.open_channels.pop(channel)
│ │ │ │ │ - logger.debug('router dropped channel %s', channel)
│ │ │ │ │ - except KeyError:
│ │ │ │ │ - logger.error('trying to drop non-existent channel %s from %s', channel, self.open_channels)
│ │ │ │ │ -
│ │ │ │ │ - def add_endpoint(self, endpoint: Endpoint) -> None:
│ │ │ │ │ - self.endpoints[endpoint] = set()
│ │ │ │ │ - self.no_endpoints.clear()
│ │ │ │ │ -
│ │ │ │ │ - def shutdown_endpoint(self, endpoint: Endpoint, _msg: 'JsonObject | None' = None, **kwargs: JsonValue) -> None:
│ │ │ │ │ - channels = self.endpoints.pop(endpoint)
│ │ │ │ │ - logger.debug('shutdown_endpoint(%s, %s) will close %s', endpoint, kwargs, channels)
│ │ │ │ │ - for channel in channels:
│ │ │ │ │ - self.write_control(_msg, command='close', channel=channel, **kwargs)
│ │ │ │ │ - self.drop_channel(channel)
│ │ │ │ │ -
│ │ │ │ │ - if not self.endpoints:
│ │ │ │ │ - self.no_endpoints.set()
│ │ │ │ │ -
│ │ │ │ │ - # were we waiting to exit?
│ │ │ │ │ - if self._eof:
│ │ │ │ │ - logger.debug(' endpoints remaining: %r', self.endpoints)
│ │ │ │ │ - if not self.endpoints and self.transport:
│ │ │ │ │ - logger.debug(' close transport')
│ │ │ │ │ - self.transport.close()
│ │ │ │ │ -
│ │ │ │ │ - def do_kill(self, host: 'str | None', group: 'str | None', message: JsonObject) -> None:
│ │ │ │ │ - endpoints = set(self.endpoints)
│ │ │ │ │ - logger.debug('do_kill(%s, %s). Considering %d endpoints.', host, group, len(endpoints))
│ │ │ │ │ - for endpoint in endpoints:
│ │ │ │ │ - endpoint.do_kill(host, group, message)
│ │ │ │ │ -
│ │ │ │ │ - def channel_control_received(self, channel: str, command: str, message: JsonObject) -> None:
│ │ │ │ │ - # If this is an open message then we need to apply the routing rules to
│ │ │ │ │ - # figure out the correct endpoint to connect. If it's not an open
│ │ │ │ │ - # message, then we expect the endpoint to already exist.
│ │ │ │ │ - if command == 'open':
│ │ │ │ │ - if channel in self.open_channels:
│ │ │ │ │ - raise CockpitProtocolError('channel is already open')
│ │ │ │ │ -
│ │ │ │ │ - try:
│ │ │ │ │ - logger.debug('Trying to find endpoint for new channel %s payload=%s', channel, message.get('payload'))
│ │ │ │ │ - endpoint = self.check_rules(message)
│ │ │ │ │ - except RoutingError as exc:
│ │ │ │ │ - self.write_control(exc.get_attrs(), command='close', channel=channel)
│ │ │ │ │ - return
│ │ │ │ │ -
│ │ │ │ │ - self.open_channels[channel] = endpoint
│ │ │ │ │ - self.endpoints[endpoint].add(channel)
│ │ │ │ │ - else:
│ │ │ │ │ - try:
│ │ │ │ │ - endpoint = self.open_channels[channel]
│ │ │ │ │ - except KeyError:
│ │ │ │ │ - # sending to a non-existent channel can happen due to races and is not an error
│ │ │ │ │ - return
│ │ │ │ │ -
│ │ │ │ │ - # At this point, we have the endpoint. Route the message.
│ │ │ │ │ - endpoint.do_channel_control(channel, command, message)
│ │ │ │ │ + return self.config[section][key]
│ │ │ │ │ + except KeyError as exc:
│ │ │ │ │ + raise bus.BusError('cockpit.Config.KeyError', f'key {key} in section {section} does not exist') from exc
│ │ │ │ │
│ │ │ │ │ - def channel_data_received(self, channel: str, data: bytes) -> None:
│ │ │ │ │ + @bus.Interface.Method(out_types='u', in_types='ssuuu')
│ │ │ │ │ + def get_u_int(self, section, key, default, maximum, minimum):
│ │ │ │ │ try:
│ │ │ │ │ - endpoint = self.open_channels[channel]
│ │ │ │ │ + value = self.config[section][key]
│ │ │ │ │ except KeyError:
│ │ │ │ │ - return
│ │ │ │ │ -
│ │ │ │ │ - endpoint.do_channel_data(channel, data)
│ │ │ │ │ -
│ │ │ │ │ - def eof_received(self) -> bool:
│ │ │ │ │ - logger.debug('eof_received(%r)', self)
│ │ │ │ │ + return default
│ │ │ │ │
│ │ │ │ │ - endpoints = set(self.endpoints)
│ │ │ │ │ - for endpoint in endpoints:
│ │ │ │ │ - endpoint.do_close()
│ │ │ │ │ + try:
│ │ │ │ │ + int_val = int(value)
│ │ │ │ │ + except ValueError:
│ │ │ │ │ + logger.warning('cockpit.conf: [%s] %s is not an integer', section, key)
│ │ │ │ │ + return default
│ │ │ │ │
│ │ │ │ │ - self._eof = True
│ │ │ │ │ - logger.debug(' endpoints remaining: %r', self.endpoints)
│ │ │ │ │ - return bool(self.endpoints)
│ │ │ │ │ + return min(max(int_val, minimum), maximum)
│ │ │ │ │
│ │ │ │ │ - _communication_done: Optional[asyncio.Future] = None
│ │ │ │ │ + @bus.Interface.Method()
│ │ │ │ │ + def reload(self):
│ │ │ │ │ + self.config = configparser.ConfigParser(interpolation=None)
│ │ │ │ │ + cockpit_conf = lookup_config('cockpit.conf')
│ │ │ │ │ + logger.debug("cockpit.Config: loading %s", cockpit_conf)
│ │ │ │ │ + # this may not exist, but it's ok to not have a config file and thus leave self.config empty
│ │ │ │ │ + self.config.read(cockpit_conf)
│ │ │ │ │
│ │ │ │ │ - def do_closed(self, exc: Optional[Exception]) -> None:
│ │ │ │ │ - # If we didn't send EOF yet, do it now.
│ │ │ │ │ - if not self._eof:
│ │ │ │ │ - self.eof_received()
│ │ │ │ │
│ │ │ │ │ - if self._communication_done is not None:
│ │ │ │ │ - if exc is None:
│ │ │ │ │ - self._communication_done.set_result(None)
│ │ │ │ │ - else:
│ │ │ │ │ - self._communication_done.set_exception(exc)
│ │ │ │ │ +class Environment(bus.Object, interface='cockpit.Environment'):
│ │ │ │ │ + variables = bus.Interface.Property('a{ss}')
│ │ │ │ │
│ │ │ │ │ - async def communicate(self) -> None:
│ │ │ │ │ - """Wait until communication is complete on the router and all endpoints are done."""
│ │ │ │ │ - assert self._communication_done is None
│ │ │ │ │ - self._communication_done = asyncio.get_running_loop().create_future()
│ │ │ │ │ - try:
│ │ │ │ │ - await self._communication_done
│ │ │ │ │ - except (BrokenPipeError, ConnectionResetError):
│ │ │ │ │ - pass # these are normal occurrences when closed from the other side
│ │ │ │ │ - finally:
│ │ │ │ │ - self._communication_done = None
│ │ │ │ │ + @variables.getter
│ │ │ │ │ + def get_variables(self):
│ │ │ │ │ + return os.environ.copy()
│ │ │ │ │ +''',
│ │ │ │ │ + 'cockpit/__init__.py': br'''from ._version import __version__
│ │ │ │ │
│ │ │ │ │ - # In an orderly exit, this is already done, but in case it wasn't
│ │ │ │ │ - # orderly, we need to make sure the endpoints shut down anyway...
│ │ │ │ │ - await self.no_endpoints.wait()
│ │ │ │ │ +__all__ = (
│ │ │ │ │ + '__version__',
│ │ │ │ │ +)
│ │ │ │ │ ''',
│ │ │ │ │ 'cockpit/beiboot.py': br'''# This file is part of Cockpit.
│ │ │ │ │ #
│ │ │ │ │ # Copyright (C) 2022 Red Hat, Inc.
│ │ │ │ │ #
│ │ │ │ │ # This program is free software: you can redistribute it and/or modify
│ │ │ │ │ # it under the terms of the GNU General Public License as published by
│ │ │ │ │ @@ -1739,15 +3824,17 @@
│ │ │ │ │
│ │ │ │ │ asyncio.run(run(args), debug=args.debug)
│ │ │ │ │
│ │ │ │ │
│ │ │ │ │ if __name__ == '__main__':
│ │ │ │ │ main()
│ │ │ │ │ ''',
│ │ │ │ │ - 'cockpit/samples.py': br'''# This file is part of Cockpit.
│ │ │ │ │ + 'cockpit/_version.py': br'''__version__ = '319'
│ │ │ │ │ +''',
│ │ │ │ │ + 'cockpit/channel.py': r'''# This file is part of Cockpit.
│ │ │ │ │ #
│ │ │ │ │ # Copyright (C) 2022 Red Hat, Inc.
│ │ │ │ │ #
│ │ │ │ │ # This program is free software: you can redistribute it and/or modify
│ │ │ │ │ # it under the terms of the GNU General Public License as published by
│ │ │ │ │ # the Free Software Foundation, either version 3 of the License, or
│ │ │ │ │ # (at your option) any later version.
│ │ │ │ │ @@ -1756,1250 +3843,599 @@
│ │ │ │ │ # but WITHOUT ANY WARRANTY; without even the implied warranty of
│ │ │ │ │ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
│ │ │ │ │ # GNU General Public License for more details.
│ │ │ │ │ #
│ │ │ │ │ # You should have received a copy of the GNU General Public License
│ │ │ │ │ # along with this program. If not, see .
│ │ │ │ │
│ │ │ │ │ -import errno
│ │ │ │ │ +import asyncio
│ │ │ │ │ +import codecs
│ │ │ │ │ +import json
│ │ │ │ │ import logging
│ │ │ │ │ -import os
│ │ │ │ │ -import re
│ │ │ │ │ -from typing import Any, DefaultDict, Iterable, List, NamedTuple, Optional, Tuple
│ │ │ │ │ -
│ │ │ │ │ -from cockpit._vendor.systemd_ctypes import Handle
│ │ │ │ │ -
│ │ │ │ │ -USER_HZ = os.sysconf(os.sysconf_names['SC_CLK_TCK'])
│ │ │ │ │ -MS_PER_JIFFY = 1000 / (USER_HZ if (USER_HZ > 0) else 100)
│ │ │ │ │ -HWMON_PATH = '/sys/class/hwmon'
│ │ │ │ │ +import traceback
│ │ │ │ │ +import typing
│ │ │ │ │ +from typing import BinaryIO, Callable, ClassVar, Collection, Generator, Mapping, Sequence, Type
│ │ │ │ │
│ │ │ │ │ -# we would like to do this, but mypy complains; https://github.com/python/mypy/issues/2900
│ │ │ │ │ -# Samples = collections.defaultdict[str, Union[float, Dict[str, Union[float, None]]]]
│ │ │ │ │ -Samples = DefaultDict[str, Any]
│ │ │ │ │ +from .jsonutil import JsonError, JsonObject, JsonValue, create_object, get_bool, get_enum, get_str
│ │ │ │ │ +from .protocol import CockpitProblem
│ │ │ │ │ +from .router import Endpoint, Router, RoutingRule
│ │ │ │ │
│ │ │ │ │ logger = logging.getLogger(__name__)
│ │ │ │ │
│ │ │ │ │
│ │ │ │ │ -def read_int_file(rootfd: int, statfile: str, default: Optional[int] = None, key: bytes = b'') -> Optional[int]:
│ │ │ │ │ - # Not every stat is available, such as cpu.weight
│ │ │ │ │ - try:
│ │ │ │ │ - fd = os.open(statfile, os.O_RDONLY, dir_fd=rootfd)
│ │ │ │ │ - except FileNotFoundError:
│ │ │ │ │ - return None
│ │ │ │ │ -
│ │ │ │ │ - try:
│ │ │ │ │ - data = os.read(fd, 1024)
│ │ │ │ │ - except OSError as e:
│ │ │ │ │ - # cgroups can disappear between the open and read
│ │ │ │ │ - if e.errno != errno.ENODEV:
│ │ │ │ │ - logger.warning('Failed to read %s: %s', statfile, e)
│ │ │ │ │ - return None
│ │ │ │ │ - finally:
│ │ │ │ │ - os.close(fd)
│ │ │ │ │ -
│ │ │ │ │ - if key:
│ │ │ │ │ - start = data.index(key) + len(key)
│ │ │ │ │ - end = data.index(b'\n', start)
│ │ │ │ │ - data = data[start:end]
│ │ │ │ │ -
│ │ │ │ │ - try:
│ │ │ │ │ - # 0 often means "none", so replace it with default value
│ │ │ │ │ - return int(data) or default
│ │ │ │ │ - except ValueError:
│ │ │ │ │ - # Some samples such as "memory.max" contains "max" when there is a no limit
│ │ │ │ │ - return None
│ │ │ │ │ -
│ │ │ │ │ -
│ │ │ │ │ -class SampleDescription(NamedTuple):
│ │ │ │ │ - name: str
│ │ │ │ │ - units: str
│ │ │ │ │ - semantics: str
│ │ │ │ │ - instanced: bool
│ │ │ │ │ -
│ │ │ │ │ -
│ │ │ │ │ -class Sampler:
│ │ │ │ │ - descriptions: List[SampleDescription]
│ │ │ │ │ -
│ │ │ │ │ - def sample(self, samples: Samples) -> None:
│ │ │ │ │ - raise NotImplementedError
│ │ │ │ │ -
│ │ │ │ │ -
│ │ │ │ │ -class CPUSampler(Sampler):
│ │ │ │ │ - descriptions = [
│ │ │ │ │ - SampleDescription('cpu.basic.nice', 'millisec', 'counter', instanced=False),
│ │ │ │ │ - SampleDescription('cpu.basic.user', 'millisec', 'counter', instanced=False),
│ │ │ │ │ - SampleDescription('cpu.basic.system', 'millisec', 'counter', instanced=False),
│ │ │ │ │ - SampleDescription('cpu.basic.iowait', 'millisec', 'counter', instanced=False),
│ │ │ │ │ -
│ │ │ │ │ - SampleDescription('cpu.core.nice', 'millisec', 'counter', instanced=True),
│ │ │ │ │ - SampleDescription('cpu.core.user', 'millisec', 'counter', instanced=True),
│ │ │ │ │ - SampleDescription('cpu.core.system', 'millisec', 'counter', instanced=True),
│ │ │ │ │ - SampleDescription('cpu.core.iowait', 'millisec', 'counter', instanced=True),
│ │ │ │ │ - ]
│ │ │ │ │ -
│ │ │ │ │ - def sample(self, samples: Samples) -> None:
│ │ │ │ │ - with open('/proc/stat') as stat:
│ │ │ │ │ - for line in stat:
│ │ │ │ │ - if not line.startswith('cpu'):
│ │ │ │ │ - continue
│ │ │ │ │ - cpu, user, nice, system, _idle, iowait = line.split()[:6]
│ │ │ │ │ - core = cpu[3:] or None
│ │ │ │ │ - if core:
│ │ │ │ │ - prefix = 'cpu.core'
│ │ │ │ │ - samples[f'{prefix}.nice'][core] = int(nice) * MS_PER_JIFFY
│ │ │ │ │ - samples[f'{prefix}.user'][core] = int(user) * MS_PER_JIFFY
│ │ │ │ │ - samples[f'{prefix}.system'][core] = int(system) * MS_PER_JIFFY
│ │ │ │ │ - samples[f'{prefix}.iowait'][core] = int(iowait) * MS_PER_JIFFY
│ │ │ │ │ - else:
│ │ │ │ │ - prefix = 'cpu.basic'
│ │ │ │ │ - samples[f'{prefix}.nice'] = int(nice) * MS_PER_JIFFY
│ │ │ │ │ - samples[f'{prefix}.user'] = int(user) * MS_PER_JIFFY
│ │ │ │ │ - samples[f'{prefix}.system'] = int(system) * MS_PER_JIFFY
│ │ │ │ │ - samples[f'{prefix}.iowait'] = int(iowait) * MS_PER_JIFFY
│ │ │ │ │ -
│ │ │ │ │ -
│ │ │ │ │ -class MemorySampler(Sampler):
│ │ │ │ │ - descriptions = [
│ │ │ │ │ - SampleDescription('memory.free', 'bytes', 'instant', instanced=False),
│ │ │ │ │ - SampleDescription('memory.used', 'bytes', 'instant', instanced=False),
│ │ │ │ │ - SampleDescription('memory.cached', 'bytes', 'instant', instanced=False),
│ │ │ │ │ - SampleDescription('memory.swap-used', 'bytes', 'instant', instanced=False),
│ │ │ │ │ - ]
│ │ │ │ │ -
│ │ │ │ │ - def sample(self, samples: Samples) -> None:
│ │ │ │ │ - with open('/proc/meminfo') as meminfo:
│ │ │ │ │ - items = {k: int(v.strip(' kB\n')) for line in meminfo for k, v in [line.split(':', 1)]}
│ │ │ │ │ -
│ │ │ │ │ - samples['memory.free'] = 1024 * items['MemFree']
│ │ │ │ │ - samples['memory.used'] = 1024 * (items['MemTotal'] - items['MemAvailable'])
│ │ │ │ │ - samples['memory.cached'] = 1024 * (items['Buffers'] + items['Cached'])
│ │ │ │ │ - samples['memory.swap-used'] = 1024 * (items['SwapTotal'] - items['SwapFree'])
│ │ │ │ │ -
│ │ │ │ │ -
│ │ │ │ │ -class CPUTemperatureSampler(Sampler):
│ │ │ │ │ - # Cache found sensors, as they can't be hotplugged.
│ │ │ │ │ - sensors: Optional[List[str]] = None
│ │ │ │ │ -
│ │ │ │ │ - descriptions = [
│ │ │ │ │ - SampleDescription('cpu.temperature', 'celsius', 'instant', instanced=True),
│ │ │ │ │ - ]
│ │ │ │ │ -
│ │ │ │ │ - @staticmethod
│ │ │ │ │ - def detect_cpu_sensors(dir_fd: int) -> Iterable[str]:
│ │ │ │ │ - # Read the name file to decide what to do with this directory
│ │ │ │ │ - try:
│ │ │ │ │ - with Handle.open('name', os.O_RDONLY, dir_fd=dir_fd) as fd:
│ │ │ │ │ - name = os.read(fd, 1024).decode().strip()
│ │ │ │ │ - except FileNotFoundError:
│ │ │ │ │ - return
│ │ │ │ │ -
│ │ │ │ │ - if name == 'atk0110':
│ │ │ │ │ - # only sample 'CPU Temperature' in atk0110
│ │ │ │ │ - predicate = (lambda label: label == 'CPU Temperature')
│ │ │ │ │ - elif name == 'cpu_thermal':
│ │ │ │ │ - # labels are not used on ARM
│ │ │ │ │ - predicate = None
│ │ │ │ │ - elif name == 'coretemp':
│ │ │ │ │ - # accept all labels on Intel
│ │ │ │ │ - predicate = None
│ │ │ │ │ - elif name in ['k8temp', 'k10temp']:
│ │ │ │ │ - predicate = None
│ │ │ │ │ - else:
│ │ │ │ │ - # Not a CPU sensor
│ │ │ │ │ - return
│ │ │ │ │ -
│ │ │ │ │ - # Now scan the directory for inputs
│ │ │ │ │ - for input_filename in os.listdir(dir_fd):
│ │ │ │ │ - if not input_filename.endswith('_input'):
│ │ │ │ │ - continue
│ │ │ │ │ -
│ │ │ │ │ - if predicate:
│ │ │ │ │ - # We need to check the label
│ │ │ │ │ - try:
│ │ │ │ │ - label_filename = input_filename.replace('_input', '_label')
│ │ │ │ │ - with Handle.open(label_filename, os.O_RDONLY, dir_fd=dir_fd) as fd:
│ │ │ │ │ - label = os.read(fd, 1024).decode().strip()
│ │ │ │ │ - except FileNotFoundError:
│ │ │ │ │ - continue
│ │ │ │ │ -
│ │ │ │ │ - if not predicate(label):
│ │ │ │ │ - continue
│ │ │ │ │ -
│ │ │ │ │ - yield input_filename
│ │ │ │ │ -
│ │ │ │ │ - @staticmethod
│ │ │ │ │ - def scan_sensors() -> Iterable[str]:
│ │ │ │ │ - try:
│ │ │ │ │ - top_fd = Handle.open(HWMON_PATH, os.O_RDONLY | os.O_DIRECTORY)
│ │ │ │ │ - except FileNotFoundError:
│ │ │ │ │ - return
│ │ │ │ │ -
│ │ │ │ │ - with top_fd:
│ │ │ │ │ - for hwmon_name in os.listdir(top_fd):
│ │ │ │ │ - with Handle.open(hwmon_name, os.O_RDONLY | os.O_DIRECTORY, dir_fd=top_fd) as subdir_fd:
│ │ │ │ │ - for sensor in CPUTemperatureSampler.detect_cpu_sensors(subdir_fd):
│ │ │ │ │ - yield f'{HWMON_PATH}/{hwmon_name}/{sensor}'
│ │ │ │ │ -
│ │ │ │ │ - def sample(self, samples: Samples) -> None:
│ │ │ │ │ - if self.sensors is None:
│ │ │ │ │ - self.sensors = list(CPUTemperatureSampler.scan_sensors())
│ │ │ │ │ -
│ │ │ │ │ - for sensor_path in self.sensors:
│ │ │ │ │ - with open(sensor_path) as sensor:
│ │ │ │ │ - temperature = int(sensor.read().strip())
│ │ │ │ │ - if temperature == 0:
│ │ │ │ │ - return
│ │ │ │ │ -
│ │ │ │ │ - samples['cpu.temperature'][sensor_path] = temperature / 1000
│ │ │ │ │ -
│ │ │ │ │ -
│ │ │ │ │ -class DiskSampler(Sampler):
│ │ │ │ │ - descriptions = [
│ │ │ │ │ - SampleDescription('disk.all.read', 'bytes', 'counter', instanced=False),
│ │ │ │ │ - SampleDescription('disk.all.written', 'bytes', 'counter', instanced=False),
│ │ │ │ │ - SampleDescription('disk.dev.read', 'bytes', 'counter', instanced=True),
│ │ │ │ │ - SampleDescription('disk.dev.written', 'bytes', 'counter', instanced=True),
│ │ │ │ │ - ]
│ │ │ │ │ -
│ │ │ │ │ - def sample(self, samples: Samples) -> None:
│ │ │ │ │ - with open('/proc/diskstats') as diskstats:
│ │ │ │ │ - all_read_bytes = 0
│ │ │ │ │ - all_written_bytes = 0
│ │ │ │ │ -
│ │ │ │ │ - for line in diskstats:
│ │ │ │ │ - # https://www.kernel.org/doc/Documentation/ABI/testing/procfs-diskstats
│ │ │ │ │ - fields = line.strip().split()
│ │ │ │ │ - dev_major = fields[0]
│ │ │ │ │ - dev_name = fields[2]
│ │ │ │ │ - num_sectors_read = fields[5]
│ │ │ │ │ - num_sectors_written = fields[9]
│ │ │ │ │ -
│ │ │ │ │ - # ignore mdraid
│ │ │ │ │ - if dev_major == '9':
│ │ │ │ │ - continue
│ │ │ │ │ -
│ │ │ │ │ - # ignore device-mapper
│ │ │ │ │ - if dev_name.startswith('dm-'):
│ │ │ │ │ - continue
│ │ │ │ │ -
│ │ │ │ │ - # Skip partitions
│ │ │ │ │ - if dev_name[:2] in ['sd', 'hd', 'vd'] and dev_name[-1].isdigit():
│ │ │ │ │ - continue
│ │ │ │ │ +if typing.TYPE_CHECKING:
│ │ │ │ │ + _T = typing.TypeVar('_T')
│ │ │ │ │ + _P = typing.ParamSpec("_P")
│ │ │ │ │
│ │ │ │ │ - # Ignore nvme partitions
│ │ │ │ │ - if dev_name.startswith('nvme') and 'p' in dev_name:
│ │ │ │ │ - continue
│ │ │ │ │
│ │ │ │ │ - read_bytes = int(num_sectors_read) * 512
│ │ │ │ │ - written_bytes = int(num_sectors_written) * 512
│ │ │ │ │ +class ChannelRoutingRule(RoutingRule):
│ │ │ │ │ + table: 'dict[str, list[Type[Channel]]]'
│ │ │ │ │
│ │ │ │ │ - all_read_bytes += read_bytes
│ │ │ │ │ - all_written_bytes += written_bytes
│ │ │ │ │ + def __init__(self, router: Router, channel_types: 'Collection[Type[Channel]]'):
│ │ │ │ │ + super().__init__(router)
│ │ │ │ │ + self.table = {}
│ │ │ │ │
│ │ │ │ │ - samples['disk.dev.read'][dev_name] = read_bytes
│ │ │ │ │ - samples['disk.dev.written'][dev_name] = written_bytes
│ │ │ │ │ + # Sort the channels into buckets by payload type
│ │ │ │ │ + for cls in channel_types:
│ │ │ │ │ + entry = self.table.setdefault(cls.payload, [])
│ │ │ │ │ + entry.append(cls)
│ │ │ │ │
│ │ │ │ │ - samples['disk.all.read'] = all_read_bytes
│ │ │ │ │ - samples['disk.all.written'] = all_written_bytes
│ │ │ │ │ + # Within each bucket, sort the channels so those with more
│ │ │ │ │ + # restrictions are considered first.
│ │ │ │ │ + for entry in self.table.values():
│ │ │ │ │ + entry.sort(key=lambda cls: len(cls.restrictions), reverse=True)
│ │ │ │ │
│ │ │ │ │ + def check_restrictions(self, restrictions: 'Collection[tuple[str, object]]', options: JsonObject) -> bool:
│ │ │ │ │ + for key, expected_value in restrictions:
│ │ │ │ │ + our_value = options.get(key)
│ │ │ │ │
│ │ │ │ │ -class CGroupSampler(Sampler):
│ │ │ │ │ - descriptions = [
│ │ │ │ │ - SampleDescription('cgroup.memory.usage', 'bytes', 'instant', instanced=True),
│ │ │ │ │ - SampleDescription('cgroup.memory.limit', 'bytes', 'instant', instanced=True),
│ │ │ │ │ - SampleDescription('cgroup.memory.sw-usage', 'bytes', 'instant', instanced=True),
│ │ │ │ │ - SampleDescription('cgroup.memory.sw-limit', 'bytes', 'instant', instanced=True),
│ │ │ │ │ - SampleDescription('cgroup.cpu.usage', 'millisec', 'counter', instanced=True),
│ │ │ │ │ - SampleDescription('cgroup.cpu.shares', 'count', 'instant', instanced=True),
│ │ │ │ │ - ]
│ │ │ │ │ + # If the match rule specifies that a value must be present and
│ │ │ │ │ + # we don't have it, then fail.
│ │ │ │ │ + if our_value is None:
│ │ │ │ │ + return False
│ │ │ │ │
│ │ │ │ │ - cgroups_v2: Optional[bool] = None
│ │ │ │ │ + # If the match rule specified a specific expected value, and
│ │ │ │ │ + # our value doesn't match it, then fail.
│ │ │ │ │ + if expected_value is not None and our_value != expected_value:
│ │ │ │ │ + return False
│ │ │ │ │
│ │ │ │ │ - def sample(self, samples: Samples) -> None:
│ │ │ │ │ - if self.cgroups_v2 is None:
│ │ │ │ │ - self.cgroups_v2 = os.path.exists('/sys/fs/cgroup/cgroup.controllers')
│ │ │ │ │ + # Everything checked out
│ │ │ │ │ + return True
│ │ │ │ │
│ │ │ │ │ - if self.cgroups_v2:
│ │ │ │ │ - cgroups_v2_path = '/sys/fs/cgroup/'
│ │ │ │ │ - for path, _, _, rootfd in os.fwalk(cgroups_v2_path):
│ │ │ │ │ - cgroup = path.replace(cgroups_v2_path, '')
│ │ │ │ │ + def apply_rule(self, options: JsonObject) -> 'Channel | None':
│ │ │ │ │ + assert self.router is not None
│ │ │ │ │
│ │ │ │ │ - if not cgroup:
│ │ │ │ │ - continue
│ │ │ │ │ + payload = options.get('payload')
│ │ │ │ │ + if not isinstance(payload, str):
│ │ │ │ │ + return None
│ │ │ │ │
│ │ │ │ │ - samples['cgroup.memory.usage'][cgroup] = read_int_file(rootfd, 'memory.current', 0)
│ │ │ │ │ - samples['cgroup.memory.limit'][cgroup] = read_int_file(rootfd, 'memory.max')
│ │ │ │ │ - samples['cgroup.memory.sw-usage'][cgroup] = read_int_file(rootfd, 'memory.swap.current', 0)
│ │ │ │ │ - samples['cgroup.memory.sw-limit'][cgroup] = read_int_file(rootfd, 'memory.swap.max')
│ │ │ │ │ - samples['cgroup.cpu.shares'][cgroup] = read_int_file(rootfd, 'cpu.weight')
│ │ │ │ │ - usage_usec = read_int_file(rootfd, 'cpu.stat', 0, key=b'usage_usec')
│ │ │ │ │ - if usage_usec:
│ │ │ │ │ - samples['cgroup.cpu.usage'][cgroup] = usage_usec / 1000
│ │ │ │ │ + for cls in self.table.get(payload, []):
│ │ │ │ │ + if self.check_restrictions(cls.restrictions, options):
│ │ │ │ │ + return cls(self.router)
│ │ │ │ │ else:
│ │ │ │ │ - memory_path = '/sys/fs/cgroup/memory/'
│ │ │ │ │ - for path, _, _, rootfd in os.fwalk(memory_path):
│ │ │ │ │ - cgroup = path.replace(memory_path, '')
│ │ │ │ │ -
│ │ │ │ │ - if not cgroup:
│ │ │ │ │ - continue
│ │ │ │ │ -
│ │ │ │ │ - samples['cgroup.memory.usage'][cgroup] = read_int_file(rootfd, 'memory.usage_in_bytes', 0)
│ │ │ │ │ - samples['cgroup.memory.limit'][cgroup] = read_int_file(rootfd, 'memory.limit_in_bytes')
│ │ │ │ │ - samples['cgroup.memory.sw-usage'][cgroup] = read_int_file(rootfd, 'memory.memsw.usage_in_bytes', 0)
│ │ │ │ │ - samples['cgroup.memory.sw-limit'][cgroup] = read_int_file(rootfd, 'memory.memsw.limit_in_bytes')
│ │ │ │ │ -
│ │ │ │ │ - cpu_path = '/sys/fs/cgroup/cpu/'
│ │ │ │ │ - for path, _, _, rootfd in os.fwalk(cpu_path):
│ │ │ │ │ - cgroup = path.replace(cpu_path, '')
│ │ │ │ │ -
│ │ │ │ │ - if not cgroup:
│ │ │ │ │ - continue
│ │ │ │ │ -
│ │ │ │ │ - samples['cgroup.cpu.shares'][cgroup] = read_int_file(rootfd, 'cpu.shares')
│ │ │ │ │ - usage_nsec = read_int_file(rootfd, 'cpuacct.usage')
│ │ │ │ │ - if usage_nsec:
│ │ │ │ │ - samples['cgroup.cpu.usage'][cgroup] = usage_nsec / 1000000
│ │ │ │ │ -
│ │ │ │ │ -
│ │ │ │ │ -class CGroupDiskIO(Sampler):
│ │ │ │ │ - IO_RE = re.compile(rb'\bread_bytes: (?P\d+).*\nwrite_bytes: (?P\d+)', flags=re.S)
│ │ │ │ │ - descriptions = [
│ │ │ │ │ - SampleDescription('disk.cgroup.read', 'bytes', 'counter', instanced=True),
│ │ │ │ │ - SampleDescription('disk.cgroup.written', 'bytes', 'counter', instanced=True),
│ │ │ │ │ - ]
│ │ │ │ │ -
│ │ │ │ │ - @staticmethod
│ │ │ │ │ - def get_cgroup_name(fd: int) -> str:
│ │ │ │ │ - with Handle.open('cgroup', os.O_RDONLY, dir_fd=fd) as cgroup_fd:
│ │ │ │ │ - cgroup_name = os.read(cgroup_fd, 2048).decode().strip()
│ │ │ │ │ -
│ │ │ │ │ - # Skip leading ::0/
│ │ │ │ │ - return cgroup_name[4:]
│ │ │ │ │ -
│ │ │ │ │ - @staticmethod
│ │ │ │ │ - def get_proc_io(fd: int) -> Tuple[int, int]:
│ │ │ │ │ - with Handle.open('io', os.O_RDONLY, dir_fd=fd) as io_fd:
│ │ │ │ │ - data = os.read(io_fd, 4096)
│ │ │ │ │ -
│ │ │ │ │ - match = re.search(CGroupDiskIO.IO_RE, data)
│ │ │ │ │ - if match:
│ │ │ │ │ - proc_read = int(match.group('read'))
│ │ │ │ │ - proc_write = int(match.group('write'))
│ │ │ │ │ -
│ │ │ │ │ - return proc_read, proc_write
│ │ │ │ │ -
│ │ │ │ │ - return 0, 0
│ │ │ │ │ -
│ │ │ │ │ - def sample(self, samples: Samples):
│ │ │ │ │ - with Handle.open('/proc', os.O_RDONLY | os.O_DIRECTORY) as proc_fd:
│ │ │ │ │ - reads = samples['disk.cgroup.read']
│ │ │ │ │ - writes = samples['disk.cgroup.written']
│ │ │ │ │ -
│ │ │ │ │ - for path in os.listdir(proc_fd):
│ │ │ │ │ - # non-pid entries in proc are guaranteed to start with a character a-z
│ │ │ │ │ - if path[0] < '0' or path[0] > '9':
│ │ │ │ │ - continue
│ │ │ │ │ -
│ │ │ │ │ - try:
│ │ │ │ │ - with Handle.open(path, os.O_PATH, dir_fd=proc_fd) as pid_fd:
│ │ │ │ │ - cgroup_name = self.get_cgroup_name(pid_fd)
│ │ │ │ │ - proc_read, proc_write = self.get_proc_io(pid_fd)
│ │ │ │ │ - except (FileNotFoundError, PermissionError, ProcessLookupError):
│ │ │ │ │ - continue
│ │ │ │ │ -
│ │ │ │ │ - reads[cgroup_name] = reads.get(cgroup_name, 0) + proc_read
│ │ │ │ │ - writes[cgroup_name] = writes.get(cgroup_name, 0) + proc_write
│ │ │ │ │ -
│ │ │ │ │ -
│ │ │ │ │ -class NetworkSampler(Sampler):
│ │ │ │ │ - descriptions = [
│ │ │ │ │ - SampleDescription('network.interface.tx', 'bytes', 'counter', instanced=True),
│ │ │ │ │ - SampleDescription('network.interface.rx', 'bytes', 'counter', instanced=True),
│ │ │ │ │ - ]
│ │ │ │ │ -
│ │ │ │ │ - def sample(self, samples: Samples) -> None:
│ │ │ │ │ - with open("/proc/net/dev") as network_samples:
│ │ │ │ │ - for line in network_samples:
│ │ │ │ │ - fields = line.split()
│ │ │ │ │ -
│ │ │ │ │ - # Skip header line
│ │ │ │ │ - if fields[0][-1] != ':':
│ │ │ │ │ - continue
│ │ │ │ │ -
│ │ │ │ │ - iface = fields[0][:-1]
│ │ │ │ │ - samples['network.interface.rx'][iface] = int(fields[1])
│ │ │ │ │ - samples['network.interface.tx'][iface] = int(fields[9])
│ │ │ │ │ -
│ │ │ │ │ -
│ │ │ │ │ -class MountSampler(Sampler):
│ │ │ │ │ - descriptions = [
│ │ │ │ │ - SampleDescription('mount.total', 'bytes', 'instant', instanced=True),
│ │ │ │ │ - SampleDescription('mount.used', 'bytes', 'instant', instanced=True),
│ │ │ │ │ - ]
│ │ │ │ │ -
│ │ │ │ │ - def sample(self, samples: Samples) -> None:
│ │ │ │ │ - with open('/proc/mounts') as mounts:
│ │ │ │ │ - for line in mounts:
│ │ │ │ │ - # Only look at real devices
│ │ │ │ │ - if line[0] != '/':
│ │ │ │ │ - continue
│ │ │ │ │ -
│ │ │ │ │ - path = line.split()[1]
│ │ │ │ │ - try:
│ │ │ │ │ - res = os.statvfs(path)
│ │ │ │ │ - except OSError:
│ │ │ │ │ - continue
│ │ │ │ │ - frsize = res.f_frsize
│ │ │ │ │ - total = frsize * res.f_blocks
│ │ │ │ │ - samples['mount.total'][path] = total
│ │ │ │ │ - samples['mount.used'][path] = total - frsize * res.f_bfree
│ │ │ │ │ -
│ │ │ │ │ -
│ │ │ │ │ -class BlockSampler(Sampler):
│ │ │ │ │ - descriptions = [
│ │ │ │ │ - SampleDescription('block.device.read', 'bytes', 'counter', instanced=True),
│ │ │ │ │ - SampleDescription('block.device.written', 'bytes', 'counter', instanced=True),
│ │ │ │ │ - ]
│ │ │ │ │ -
│ │ │ │ │ - def sample(self, samples: Samples) -> None:
│ │ │ │ │ - with open('/proc/diskstats') as diskstats:
│ │ │ │ │ - for line in diskstats:
│ │ │ │ │ - # https://www.kernel.org/doc/Documentation/ABI/testing/procfs-diskstats
│ │ │ │ │ - [_, _, dev_name, _, _, sectors_read, _, _, _, sectors_written, *_] = line.strip().split()
│ │ │ │ │ -
│ │ │ │ │ - samples['block.device.read'][dev_name] = int(sectors_read) * 512
│ │ │ │ │ - samples['block.device.written'][dev_name] = int(sectors_written) * 512
│ │ │ │ │ -
│ │ │ │ │ -
│ │ │ │ │ -SAMPLERS = [
│ │ │ │ │ - BlockSampler,
│ │ │ │ │ - CGroupSampler,
│ │ │ │ │ - CGroupDiskIO,
│ │ │ │ │ - CPUSampler,
│ │ │ │ │ - CPUTemperatureSampler,
│ │ │ │ │ - DiskSampler,
│ │ │ │ │ - MemorySampler,
│ │ │ │ │ - MountSampler,
│ │ │ │ │ - NetworkSampler,
│ │ │ │ │ -]
│ │ │ │ │ -''',
│ │ │ │ │ - 'cockpit/bridge.py': r'''# This file is part of Cockpit.
│ │ │ │ │ -#
│ │ │ │ │ -# Copyright (C) 2022 Red Hat, Inc.
│ │ │ │ │ -#
│ │ │ │ │ -# This program is free software: you can redistribute it and/or modify
│ │ │ │ │ -# it under the terms of the GNU General Public License as published by
│ │ │ │ │ -# the Free Software Foundation, either version 3 of the License, or
│ │ │ │ │ -# (at your option) any later version.
│ │ │ │ │ -#
│ │ │ │ │ -# This program is distributed in the hope that it will be useful,
│ │ │ │ │ -# but WITHOUT ANY WARRANTY; without even the implied warranty of
│ │ │ │ │ -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
│ │ │ │ │ -# GNU General Public License for more details.
│ │ │ │ │ -#
│ │ │ │ │ -# You should have received a copy of the GNU General Public License
│ │ │ │ │ -# along with this program. If not, see .
│ │ │ │ │ -
│ │ │ │ │ -import argparse
│ │ │ │ │ -import asyncio
│ │ │ │ │ -import contextlib
│ │ │ │ │ -import json
│ │ │ │ │ -import logging
│ │ │ │ │ -import os
│ │ │ │ │ -import pwd
│ │ │ │ │ -import shlex
│ │ │ │ │ -import socket
│ │ │ │ │ -import stat
│ │ │ │ │ -import subprocess
│ │ │ │ │ -from typing import Iterable, List, Optional, Sequence, Tuple, Type
│ │ │ │ │ -
│ │ │ │ │ -from cockpit._vendor.ferny import interaction_client
│ │ │ │ │ -from cockpit._vendor.systemd_ctypes import bus, run_async
│ │ │ │ │ -
│ │ │ │ │ -from . import polyfills
│ │ │ │ │ -from ._version import __version__
│ │ │ │ │ -from .channel import ChannelRoutingRule
│ │ │ │ │ -from .channels import CHANNEL_TYPES
│ │ │ │ │ -from .config import Config, Environment
│ │ │ │ │ -from .internal_endpoints import EXPORTS
│ │ │ │ │ -from .jsonutil import JsonError, JsonObject, get_dict
│ │ │ │ │ -from .packages import BridgeConfig, Packages, PackagesListener
│ │ │ │ │ -from .peer import PeersRoutingRule
│ │ │ │ │ -from .remote import HostRoutingRule
│ │ │ │ │ -from .router import Router
│ │ │ │ │ -from .superuser import SuperuserRoutingRule
│ │ │ │ │ -from .transports import StdioTransport
│ │ │ │ │ -
│ │ │ │ │ -logger = logging.getLogger(__name__)
│ │ │ │ │ -
│ │ │ │ │ + return None
│ │ │ │ │
│ │ │ │ │ -class InternalBus:
│ │ │ │ │ - exportees: List[bus.Slot]
│ │ │ │ │ + def shutdown(self):
│ │ │ │ │ + pass # we don't hold any state
│ │ │ │ │
│ │ │ │ │ - def __init__(self, exports: Iterable[Tuple[str, Type[bus.BaseObject]]]):
│ │ │ │ │ - client_socket, server_socket = socket.socketpair()
│ │ │ │ │ - self.client = bus.Bus.new(fd=client_socket.detach())
│ │ │ │ │ - self.server = bus.Bus.new(fd=server_socket.detach(), server=True)
│ │ │ │ │ - self.exportees = [self.server.add_object(path, cls()) for path, cls in exports]
│ │ │ │ │
│ │ │ │ │ - def export(self, path: str, obj: bus.BaseObject) -> None:
│ │ │ │ │ - self.exportees.append(self.server.add_object(path, obj))
│ │ │ │ │ +class ChannelError(CockpitProblem):
│ │ │ │ │ + pass
│ │ │ │ │
│ │ │ │ │
│ │ │ │ │ -class Bridge(Router, PackagesListener):
│ │ │ │ │ - internal_bus: InternalBus
│ │ │ │ │ - packages: Optional[Packages]
│ │ │ │ │ - bridge_configs: Sequence[BridgeConfig]
│ │ │ │ │ - args: argparse.Namespace
│ │ │ │ │ +class Channel(Endpoint):
│ │ │ │ │ + # Values borrowed from C implementation
│ │ │ │ │ + BLOCK_SIZE = 16 * 1024
│ │ │ │ │ + SEND_WINDOW = 2 * 1024 * 1024
│ │ │ │ │
│ │ │ │ │ - def __init__(self, args: argparse.Namespace):
│ │ │ │ │ - self.internal_bus = InternalBus(EXPORTS)
│ │ │ │ │ - self.bridge_configs = []
│ │ │ │ │ - self.args = args
│ │ │ │ │ + # Flow control book-keeping
│ │ │ │ │ + _send_pings: bool = False
│ │ │ │ │ + _out_sequence: int = 0
│ │ │ │ │ + _out_window: int = SEND_WINDOW
│ │ │ │ │ + _ack_bytes: bool
│ │ │ │ │
│ │ │ │ │ - self.superuser_rule = SuperuserRoutingRule(self, privileged=args.privileged)
│ │ │ │ │ - self.internal_bus.export('/superuser', self.superuser_rule)
│ │ │ │ │ + # Task management
│ │ │ │ │ + _tasks: 'set[asyncio.Task]'
│ │ │ │ │ + _close_args: 'JsonObject | None' = None
│ │ │ │ │
│ │ │ │ │ - self.internal_bus.export('/config', Config())
│ │ │ │ │ - self.internal_bus.export('/environment', Environment())
│ │ │ │ │ + # Must be filled in by the channel implementation
│ │ │ │ │ + payload: 'ClassVar[str]'
│ │ │ │ │ + restrictions: 'ClassVar[Sequence[tuple[str, object]]]' = ()
│ │ │ │ │
│ │ │ │ │ - self.peers_rule = PeersRoutingRule(self)
│ │ │ │ │ + # These get filled in from .do_open()
│ │ │ │ │ + channel = ''
│ │ │ │ │ + group = ''
│ │ │ │ │ + is_binary: bool
│ │ │ │ │ + decoder: 'codecs.IncrementalDecoder | None'
│ │ │ │ │
│ │ │ │ │ - if args.beipack:
│ │ │ │ │ - # Some special stuff for beipack
│ │ │ │ │ - self.superuser_rule.set_configs((
│ │ │ │ │ - BridgeConfig({
│ │ │ │ │ - "privileged": True,
│ │ │ │ │ - "spawn": ["sudo", "-k", "-A", "python3", "-ic", "# cockpit-bridge", "--privileged"],
│ │ │ │ │ - "environ": ["SUDO_ASKPASS=ferny-askpass"],
│ │ │ │ │ - }),
│ │ │ │ │ - ))
│ │ │ │ │ - self.packages = None
│ │ │ │ │ - elif args.privileged:
│ │ │ │ │ - self.packages = None
│ │ │ │ │ - else:
│ │ │ │ │ - self.packages = Packages(self)
│ │ │ │ │ - self.internal_bus.export('/packages', self.packages)
│ │ │ │ │ - self.packages_loaded()
│ │ │ │ │ + # input
│ │ │ │ │ + def do_control(self, command: str, message: JsonObject) -> None:
│ │ │ │ │ + # Break the various different kinds of control messages out into the
│ │ │ │ │ + # things that our subclass may be interested in handling. We drop the
│ │ │ │ │ + # 'message' field for handlers that don't need it.
│ │ │ │ │ + if command == 'open':
│ │ │ │ │ + self._tasks = set()
│ │ │ │ │ + self.channel = get_str(message, 'channel')
│ │ │ │ │ + if get_bool(message, 'flow-control', default=False):
│ │ │ │ │ + self._send_pings = True
│ │ │ │ │ + self._ack_bytes = get_enum(message, 'send-acks', ['bytes'], None) is not None
│ │ │ │ │ + self.group = get_str(message, 'group', 'default')
│ │ │ │ │ + self.is_binary = get_enum(message, 'binary', ['raw'], None) is not None
│ │ │ │ │ + self.decoder = None
│ │ │ │ │ + self.freeze_endpoint()
│ │ │ │ │ + self.do_open(message)
│ │ │ │ │ + elif command == 'ready':
│ │ │ │ │ + self.do_ready()
│ │ │ │ │ + elif command == 'done':
│ │ │ │ │ + self.do_done()
│ │ │ │ │ + elif command == 'close':
│ │ │ │ │ + self.do_close()
│ │ │ │ │ + elif command == 'ping':
│ │ │ │ │ + self.do_ping(message)
│ │ │ │ │ + elif command == 'pong':
│ │ │ │ │ + self.do_pong(message)
│ │ │ │ │ + elif command == 'options':
│ │ │ │ │ + self.do_options(message)
│ │ │ │ │
│ │ │ │ │ - super().__init__([
│ │ │ │ │ - HostRoutingRule(self),
│ │ │ │ │ - self.superuser_rule,
│ │ │ │ │ - ChannelRoutingRule(self, CHANNEL_TYPES),
│ │ │ │ │ - self.peers_rule,
│ │ │ │ │ - ])
│ │ │ │ │ + def do_channel_control(self, channel: str, command: str, message: JsonObject) -> None:
│ │ │ │ │ + # Already closing? Ignore.
│ │ │ │ │ + if self._close_args is not None:
│ │ │ │ │ + return
│ │ │ │ │
│ │ │ │ │ - @staticmethod
│ │ │ │ │ - def get_os_release():
│ │ │ │ │ + # Catch errors and turn them into close messages
│ │ │ │ │ try:
│ │ │ │ │ - file = open('/etc/os-release', encoding='utf-8')
│ │ │ │ │ - except FileNotFoundError:
│ │ │ │ │ - try:
│ │ │ │ │ - file = open('/usr/lib/os-release', encoding='utf-8')
│ │ │ │ │ - except FileNotFoundError:
│ │ │ │ │ - logger.warning("Neither /etc/os-release nor /usr/lib/os-release exists")
│ │ │ │ │ - return {}
│ │ │ │ │ -
│ │ │ │ │ - os_release = {}
│ │ │ │ │ - for line in file.readlines():
│ │ │ │ │ - line = line.strip()
│ │ │ │ │ - if not line or line.startswith('#'):
│ │ │ │ │ - continue
│ │ │ │ │ try:
│ │ │ │ │ - k, v = line.split('=')
│ │ │ │ │ - (v_parsed, ) = shlex.split(v) # expect exactly one token
│ │ │ │ │ - except ValueError:
│ │ │ │ │ - logger.warning('Ignoring invalid line in os-release: %r', line)
│ │ │ │ │ - continue
│ │ │ │ │ - os_release[k] = v_parsed
│ │ │ │ │ - return os_release
│ │ │ │ │ -
│ │ │ │ │ - def do_init(self, message: JsonObject) -> None:
│ │ │ │ │ - # we're only interested in the case where this is a dict, but
│ │ │ │ │ - # 'superuser' may well be `False` and that's not an error
│ │ │ │ │ - with contextlib.suppress(JsonError):
│ │ │ │ │ - superuser = get_dict(message, 'superuser')
│ │ │ │ │ - self.superuser_rule.init(superuser)
│ │ │ │ │ -
│ │ │ │ │ - def do_send_init(self) -> None:
│ │ │ │ │ - init_args = {
│ │ │ │ │ - 'capabilities': {'explicit-superuser': True},
│ │ │ │ │ - 'command': 'init',
│ │ │ │ │ - 'os-release': self.get_os_release(),
│ │ │ │ │ - 'version': 1,
│ │ │ │ │ - }
│ │ │ │ │ -
│ │ │ │ │ - if self.packages is not None:
│ │ │ │ │ - init_args['packages'] = dict.fromkeys(self.packages.packages)
│ │ │ │ │ -
│ │ │ │ │ - self.write_control(init_args)
│ │ │ │ │ -
│ │ │ │ │ - # PackagesListener interface
│ │ │ │ │ - def packages_loaded(self) -> None:
│ │ │ │ │ - assert self.packages
│ │ │ │ │ - bridge_configs = self.packages.get_bridge_configs()
│ │ │ │ │ - if self.bridge_configs != bridge_configs:
│ │ │ │ │ - self.superuser_rule.set_configs(bridge_configs)
│ │ │ │ │ - self.peers_rule.set_configs(bridge_configs)
│ │ │ │ │ - self.bridge_configs = bridge_configs
│ │ │ │ │ -
│ │ │ │ │ -
│ │ │ │ │ -async def run(args) -> None:
│ │ │ │ │ - logger.debug("Hi. How are you today?")
│ │ │ │ │ + self.do_control(command, message)
│ │ │ │ │ + except JsonError as exc:
│ │ │ │ │ + raise ChannelError('protocol-error', message=str(exc)) from exc
│ │ │ │ │ + except ChannelError as exc:
│ │ │ │ │ + self.close(exc.get_attrs())
│ │ │ │ │
│ │ │ │ │ - # Unit tests require this
│ │ │ │ │ - me = pwd.getpwuid(os.getuid())
│ │ │ │ │ - os.environ['HOME'] = me.pw_dir
│ │ │ │ │ - os.environ['SHELL'] = me.pw_shell
│ │ │ │ │ - os.environ['USER'] = me.pw_name
│ │ │ │ │ + def do_kill(self, host: 'str | None', group: 'str | None', _message: JsonObject) -> None:
│ │ │ │ │ + # Already closing? Ignore.
│ │ │ │ │ + if self._close_args is not None:
│ │ │ │ │ + return
│ │ │ │ │
│ │ │ │ │ - logger.debug('Starting the router.')
│ │ │ │ │ - router = Bridge(args)
│ │ │ │ │ - StdioTransport(asyncio.get_running_loop(), router)
│ │ │ │ │ + if host is not None:
│ │ │ │ │ + return
│ │ │ │ │ + if group is not None and self.group != group:
│ │ │ │ │ + return
│ │ │ │ │ + self.do_close()
│ │ │ │ │
│ │ │ │ │ - logger.debug('Startup done. Looping until connection closes.')
│ │ │ │ │ + # At least this one really ought to be implemented...
│ │ │ │ │ + def do_open(self, options: JsonObject) -> None:
│ │ │ │ │ + raise NotImplementedError
│ │ │ │ │
│ │ │ │ │ - try:
│ │ │ │ │ - await router.communicate()
│ │ │ │ │ - except (BrokenPipeError, ConnectionResetError):
│ │ │ │ │ - # not unexpected if the peer doesn't hang up cleanly
│ │ │ │ │ + # ... but many subclasses may reasonably want to ignore some of these.
│ │ │ │ │ + def do_ready(self) -> None:
│ │ │ │ │ pass
│ │ │ │ │
│ │ │ │ │ + def do_done(self) -> None:
│ │ │ │ │ + pass
│ │ │ │ │
│ │ │ │ │ -def try_to_receive_stderr():
│ │ │ │ │ - try:
│ │ │ │ │ - ours, theirs = socket.socketpair()
│ │ │ │ │ - with ours:
│ │ │ │ │ - with theirs:
│ │ │ │ │ - interaction_client.command(2, 'cockpit.send-stderr', fds=[theirs.fileno()])
│ │ │ │ │ - _msg, fds, _flags, _addr = socket.recv_fds(ours, 1, 1)
│ │ │ │ │ - except OSError:
│ │ │ │ │ - return
│ │ │ │ │ + def do_close(self) -> None:
│ │ │ │ │ + self.close()
│ │ │ │ │
│ │ │ │ │ - try:
│ │ │ │ │ - stderr_fd, = fds
│ │ │ │ │ - # We're about to abruptly drop our end of the stderr socketpair that we
│ │ │ │ │ - # share with the ferny agent. ferny would normally treat that as an
│ │ │ │ │ - # unexpected error. Instruct it to do a clean exit, instead.
│ │ │ │ │ - interaction_client.command(2, 'ferny.end')
│ │ │ │ │ - os.dup2(stderr_fd, 2)
│ │ │ │ │ - finally:
│ │ │ │ │ - for fd in fds:
│ │ │ │ │ - os.close(fd)
│ │ │ │ │ + def do_options(self, message: JsonObject) -> None:
│ │ │ │ │ + raise ChannelError('not-supported', message='This channel does not implement "options"')
│ │ │ │ │
│ │ │ │ │ + # 'reasonable' default, overridden in other channels for receive-side flow control
│ │ │ │ │ + def do_ping(self, message: JsonObject) -> None:
│ │ │ │ │ + self.send_pong(message)
│ │ │ │ │
│ │ │ │ │ -def setup_journald() -> bool:
│ │ │ │ │ - # If stderr is a socket, prefer systemd-journal logging. This covers the
│ │ │ │ │ - # case we're already connected to the journal but also the case where we're
│ │ │ │ │ - # talking to the ferny agent, while leaving logging to file or terminal
│ │ │ │ │ - # unaffected.
│ │ │ │ │ - if not stat.S_ISSOCK(os.fstat(2).st_mode):
│ │ │ │ │ - # not a socket? Don't redirect.
│ │ │ │ │ - return False
│ │ │ │ │ + def send_ack(self, data: bytes) -> None:
│ │ │ │ │ + if self._ack_bytes:
│ │ │ │ │ + self.send_control('ack', bytes=len(data))
│ │ │ │ │
│ │ │ │ │ - try:
│ │ │ │ │ - import systemd.journal # type: ignore[import]
│ │ │ │ │ - except ImportError:
│ │ │ │ │ - # No python3-systemd? Don't redirect.
│ │ │ │ │ - return False
│ │ │ │ │ + def do_channel_data(self, channel: str, data: bytes) -> None:
│ │ │ │ │ + # Already closing? Ignore.
│ │ │ │ │ + if self._close_args is not None:
│ │ │ │ │ + return
│ │ │ │ │
│ │ │ │ │ - logging.root.addHandler(systemd.journal.JournalHandler())
│ │ │ │ │ - return True
│ │ │ │ │ + # Catch errors and turn them into close messages
│ │ │ │ │ + try:
│ │ │ │ │ + if not self.do_data(data):
│ │ │ │ │ + self.send_ack(data)
│ │ │ │ │ + except ChannelError as exc:
│ │ │ │ │ + self.close(exc.get_attrs())
│ │ │ │ │
│ │ │ │ │ + def do_data(self, data: bytes) -> 'bool | None':
│ │ │ │ │ + """Handles incoming data to the channel.
│ │ │ │ │
│ │ │ │ │ -def setup_logging(*, debug: bool) -> None:
│ │ │ │ │ - """Setup our logger with optional filtering of modules if COCKPIT_DEBUG env is set"""
│ │ │ │ │ + Return value is True if the channel takes care of send acks on its own,
│ │ │ │ │ + in which case it should call self.send_ack() on `data` at some point.
│ │ │ │ │ + None or False means that the acknowledgement is sent automatically."""
│ │ │ │ │ + # By default, channels can't receive data.
│ │ │ │ │ + del data
│ │ │ │ │ + self.close()
│ │ │ │ │ + return True
│ │ │ │ │
│ │ │ │ │ - modules = os.getenv('COCKPIT_DEBUG', '')
│ │ │ │ │ + # output
│ │ │ │ │ + def ready(self, **kwargs: JsonValue) -> None:
│ │ │ │ │ + self.thaw_endpoint()
│ │ │ │ │ + self.send_control(command='ready', **kwargs)
│ │ │ │ │
│ │ │ │ │ - # Either setup logging via journal or via formatted messages to stderr
│ │ │ │ │ - if not setup_journald():
│ │ │ │ │ - logging.basicConfig(format='%(name)s-%(levelname)s: %(message)s')
│ │ │ │ │ + def __decode_frame(self, data: bytes, *, final: bool = False) -> str:
│ │ │ │ │ + assert self.decoder is not None
│ │ │ │ │ + try:
│ │ │ │ │ + return self.decoder.decode(data, final=final)
│ │ │ │ │ + except UnicodeDecodeError as exc:
│ │ │ │ │ + raise ChannelError('protocol-error', message=str(exc)) from exc
│ │ │ │ │
│ │ │ │ │ - if debug or modules == 'all':
│ │ │ │ │ - logging.getLogger().setLevel(level=logging.DEBUG)
│ │ │ │ │ - elif modules:
│ │ │ │ │ - for module in modules.split(','):
│ │ │ │ │ - module = module.strip()
│ │ │ │ │ - if not module:
│ │ │ │ │ - continue
│ │ │ │ │ + def done(self) -> None:
│ │ │ │ │ + # any residue from partial send_data() frames? this is invalid, fail the channel
│ │ │ │ │ + if self.decoder is not None:
│ │ │ │ │ + self.__decode_frame(b'', final=True)
│ │ │ │ │ + self.send_control(command='done')
│ │ │ │ │
│ │ │ │ │ - logging.getLogger(module).setLevel(logging.DEBUG)
│ │ │ │ │ + # tasks and close management
│ │ │ │ │ + def is_closing(self) -> bool:
│ │ │ │ │ + return self._close_args is not None
│ │ │ │ │
│ │ │ │ │ + def _close_now(self) -> None:
│ │ │ │ │ + self.shutdown_endpoint(self._close_args)
│ │ │ │ │
│ │ │ │ │ -def start_ssh_agent() -> None:
│ │ │ │ │ - # Launch the agent so that it goes down with us on EOF; PDEATHSIG would be more robust,
│ │ │ │ │ - # but it gets cleared on setgid ssh-agent, which some distros still do
│ │ │ │ │ - try:
│ │ │ │ │ - proc = subprocess.Popen(['ssh-agent', 'sh', '-ec', 'echo SSH_AUTH_SOCK=$SSH_AUTH_SOCK; read a'],
│ │ │ │ │ - stdin=subprocess.PIPE, stdout=subprocess.PIPE, universal_newlines=True)
│ │ │ │ │ - assert proc.stdout is not None
│ │ │ │ │ + def _task_done(self, task):
│ │ │ │ │ + # Strictly speaking, we should read the result and check for exceptions but:
│ │ │ │ │ + # - exceptions bubbling out of the task are programming errors
│ │ │ │ │ + # - the only thing we'd do with it anyway, is to show it
│ │ │ │ │ + # - Python already does that with its "Task exception was never retrieved" messages
│ │ │ │ │ + self._tasks.remove(task)
│ │ │ │ │ + if self._close_args is not None and not self._tasks:
│ │ │ │ │ + self._close_now()
│ │ │ │ │
│ │ │ │ │ - # Wait for the agent to write at least one line and look for the
│ │ │ │ │ - # listener socket. If we fail to find it, kill the agent — something
│ │ │ │ │ - # went wrong.
│ │ │ │ │ - for token in shlex.shlex(proc.stdout.readline(), punctuation_chars=True):
│ │ │ │ │ - if token.startswith('SSH_AUTH_SOCK='):
│ │ │ │ │ - os.environ['SSH_AUTH_SOCK'] = token.replace('SSH_AUTH_SOCK=', '', 1)
│ │ │ │ │ - break
│ │ │ │ │ - else:
│ │ │ │ │ - proc.terminate()
│ │ │ │ │ - proc.wait()
│ │ │ │ │ + def create_task(self, coroutine, name=None):
│ │ │ │ │ + """Create a task associated with the channel.
│ │ │ │ │
│ │ │ │ │ - except FileNotFoundError:
│ │ │ │ │ - logger.debug("Couldn't start ssh-agent (FileNotFoundError)")
│ │ │ │ │ + All tasks must exit before the channel can close. You may not create
│ │ │ │ │ + new tasks after calling .close().
│ │ │ │ │ + """
│ │ │ │ │ + assert self._close_args is None
│ │ │ │ │ + task = asyncio.create_task(coroutine)
│ │ │ │ │ + self._tasks.add(task)
│ │ │ │ │ + task.add_done_callback(self._task_done)
│ │ │ │ │ + return task
│ │ │ │ │
│ │ │ │ │ - except OSError as exc:
│ │ │ │ │ - logger.warning("Could not start ssh-agent: %s", exc)
│ │ │ │ │ + def close(self, close_args: 'JsonObject | None' = None) -> None:
│ │ │ │ │ + """Requests the channel to be closed.
│ │ │ │ │
│ │ │ │ │ + After you call this method, you won't get anymore `.do_*()` calls.
│ │ │ │ │
│ │ │ │ │ -def main(*, beipack: bool = False) -> None:
│ │ │ │ │ - polyfills.install()
│ │ │ │ │ + This will wait for any running tasks to complete before sending the
│ │ │ │ │ + close message.
│ │ │ │ │ + """
│ │ │ │ │ + if self._close_args is not None:
│ │ │ │ │ + # close already requested
│ │ │ │ │ + return
│ │ │ │ │ + self._close_args = close_args or {}
│ │ │ │ │ + if not self._tasks:
│ │ │ │ │ + self._close_now()
│ │ │ │ │
│ │ │ │ │ - parser = argparse.ArgumentParser(description='cockpit-bridge is run automatically inside of a Cockpit session.')
│ │ │ │ │ - parser.add_argument('--privileged', action='store_true', help='Privileged copy of the bridge')
│ │ │ │ │ - parser.add_argument('--packages', action='store_true', help='Show Cockpit package information')
│ │ │ │ │ - parser.add_argument('--bridges', action='store_true', help='Show Cockpit bridges information')
│ │ │ │ │ - parser.add_argument('--debug', action='store_true', help='Enable debug output (very verbose)')
│ │ │ │ │ - parser.add_argument('--version', action='store_true', help='Show Cockpit version information')
│ │ │ │ │ - args = parser.parse_args()
│ │ │ │ │ + def send_bytes(self, data: bytes) -> bool:
│ │ │ │ │ + """Send binary data and handle book-keeping for flow control.
│ │ │ │ │
│ │ │ │ │ - # This is determined by who calls us
│ │ │ │ │ - args.beipack = beipack
│ │ │ │ │ + The flow control is "advisory". The data is sent immediately, even if
│ │ │ │ │ + it's larger than the window. In general you should try to send packets
│ │ │ │ │ + which are approximately Channel.BLOCK_SIZE in size.
│ │ │ │ │
│ │ │ │ │ - # If we were run with --privileged then our stderr is currently being
│ │ │ │ │ - # consumed by the main bridge looking for startup-related error messages.
│ │ │ │ │ - # Let's switch back to the original stderr stream, which has a side-effect
│ │ │ │ │ - # of indicating that our startup is more or less complete. Any errors
│ │ │ │ │ - # after this point will land in the journal.
│ │ │ │ │ - if args.privileged:
│ │ │ │ │ - try_to_receive_stderr()
│ │ │ │ │ + Returns True if there is still room in the window, or False if you
│ │ │ │ │ + should stop writing for now. In that case, `.do_resume_send()` will be
│ │ │ │ │ + called later when there is more room.
│ │ │ │ │
│ │ │ │ │ - setup_logging(debug=args.debug)
│ │ │ │ │ + Be careful with text channels (i.e. without binary="raw"): you are responsible
│ │ │ │ │ + for ensuring that @data is valid UTF-8. This isn't validated here for
│ │ │ │ │ + efficiency reasons.
│ │ │ │ │ + """
│ │ │ │ │ + self.send_channel_data(self.channel, data)
│ │ │ │ │
│ │ │ │ │ - # Special modes
│ │ │ │ │ - if args.packages:
│ │ │ │ │ - Packages().show()
│ │ │ │ │ - return
│ │ │ │ │ - elif args.version:
│ │ │ │ │ - print(f'Version: {__version__}\nProtocol: 1')
│ │ │ │ │ - return
│ │ │ │ │ - elif args.bridges:
│ │ │ │ │ - print(json.dumps([config.__dict__ for config in Packages().get_bridge_configs()], indent=2))
│ │ │ │ │ - return
│ │ │ │ │ + if self._send_pings:
│ │ │ │ │ + out_sequence = self._out_sequence + len(data)
│ │ │ │ │ + if self._out_sequence // Channel.BLOCK_SIZE != out_sequence // Channel.BLOCK_SIZE:
│ │ │ │ │ + self.send_control(command='ping', sequence=out_sequence)
│ │ │ │ │ + self._out_sequence = out_sequence
│ │ │ │ │
│ │ │ │ │ - # The privileged bridge doesn't need ssh-agent, but the main one does
│ │ │ │ │ - if 'SSH_AUTH_SOCK' not in os.environ and not args.privileged:
│ │ │ │ │ - start_ssh_agent()
│ │ │ │ │ + return self._out_sequence < self._out_window
│ │ │ │ │
│ │ │ │ │ - # asyncio.run() shim for Python 3.6 support
│ │ │ │ │ - run_async(run(args), debug=args.debug)
│ │ │ │ │ + def send_data(self, data: bytes) -> bool:
│ │ │ │ │ + """Send data and transparently handle UTF-8 for text channels
│ │ │ │ │
│ │ │ │ │ + Use this for channels which can be text, but are not guaranteed to get
│ │ │ │ │ + valid UTF-8 frames -- i.e. multi-byte characters may be split across
│ │ │ │ │ + frames. This is expensive, so prefer send_text() or send_bytes() wherever
│ │ │ │ │ + possible.
│ │ │ │ │ + """
│ │ │ │ │ + if self.is_binary:
│ │ │ │ │ + return self.send_bytes(data)
│ │ │ │ │
│ │ │ │ │ -if __name__ == '__main__':
│ │ │ │ │ - main()
│ │ │ │ │ -'''.encode('utf-8'),
│ │ │ │ │ - 'cockpit/peer.py': r'''# This file is part of Cockpit.
│ │ │ │ │ -#
│ │ │ │ │ -# Copyright (C) 2022 Red Hat, Inc.
│ │ │ │ │ -#
│ │ │ │ │ -# This program is free software: you can redistribute it and/or modify
│ │ │ │ │ -# it under the terms of the GNU General Public License as published by
│ │ │ │ │ -# the Free Software Foundation, either version 3 of the License, or
│ │ │ │ │ -# (at your option) any later version.
│ │ │ │ │ -#
│ │ │ │ │ -# This program is distributed in the hope that it will be useful,
│ │ │ │ │ -# but WITHOUT ANY WARRANTY; without even the implied warranty of
│ │ │ │ │ -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
│ │ │ │ │ -# GNU General Public License for more details.
│ │ │ │ │ -#
│ │ │ │ │ -# You should have received a copy of the GNU General Public License
│ │ │ │ │ -# along with this program. If not, see .
│ │ │ │ │ + # for text channels we must avoid splitting UTF-8 multi-byte characters,
│ │ │ │ │ + # as these can't be sent to a WebSocket (and are often confusing for text streams as well)
│ │ │ │ │ + if self.decoder is None:
│ │ │ │ │ + self.decoder = codecs.getincrementaldecoder('utf-8')(errors='strict')
│ │ │ │ │ + return self.send_text(self.__decode_frame(data))
│ │ │ │ │
│ │ │ │ │ -import asyncio
│ │ │ │ │ -import logging
│ │ │ │ │ -import os
│ │ │ │ │ -from typing import Callable, List, Optional, Sequence
│ │ │ │ │ + def send_text(self, data: str) -> bool:
│ │ │ │ │ + """Send UTF-8 string data and handle book-keeping for flow control.
│ │ │ │ │
│ │ │ │ │ -from .jsonutil import JsonObject, JsonValue
│ │ │ │ │ -from .packages import BridgeConfig
│ │ │ │ │ -from .protocol import CockpitProblem, CockpitProtocol, CockpitProtocolError
│ │ │ │ │ -from .router import Endpoint, Router, RoutingRule
│ │ │ │ │ -from .transports import SubprocessProtocol, SubprocessTransport
│ │ │ │ │ + Similar to `send_bytes`, but for text data. The data is sent as UTF-8 encoded bytes.
│ │ │ │ │ + """
│ │ │ │ │ + return self.send_bytes(data.encode())
│ │ │ │ │
│ │ │ │ │ -logger = logging.getLogger(__name__)
│ │ │ │ │ + def send_json(self, _msg: 'JsonObject | None' = None, **kwargs: JsonValue) -> bool:
│ │ │ │ │ + pretty = self.json_encoder.encode(create_object(_msg, kwargs)) + '\n'
│ │ │ │ │ + return self.send_text(pretty)
│ │ │ │ │
│ │ │ │ │ + def do_pong(self, message):
│ │ │ │ │ + if not self._send_pings: # huh?
│ │ │ │ │ + logger.warning("Got wild pong on channel %s", self.channel)
│ │ │ │ │ + return
│ │ │ │ │
│ │ │ │ │ -class PeerError(CockpitProblem):
│ │ │ │ │ - pass
│ │ │ │ │ + self._out_window = message['sequence'] + Channel.SEND_WINDOW
│ │ │ │ │ + if self._out_sequence < self._out_window:
│ │ │ │ │ + self.do_resume_send()
│ │ │ │ │
│ │ │ │ │ + def do_resume_send(self) -> None:
│ │ │ │ │ + """Called to indicate that the channel may start sending again."""
│ │ │ │ │ + # change to `raise NotImplementedError` after everyone implements it
│ │ │ │ │
│ │ │ │ │ -class PeerExited(Exception):
│ │ │ │ │ - def __init__(self, exit_code: int):
│ │ │ │ │ - self.exit_code = exit_code
│ │ │ │ │ + json_encoder: 'ClassVar[json.JSONEncoder]' = json.JSONEncoder(indent=2)
│ │ │ │ │
│ │ │ │ │ + def send_control(self, command: str, **kwargs: JsonValue) -> None:
│ │ │ │ │ + self.send_channel_control(self.channel, command, None, **kwargs)
│ │ │ │ │
│ │ │ │ │ -class Peer(CockpitProtocol, SubprocessProtocol, Endpoint):
│ │ │ │ │ - done_callbacks: List[Callable[[], None]]
│ │ │ │ │ - init_future: Optional[asyncio.Future]
│ │ │ │ │ + def send_pong(self, message: JsonObject) -> None:
│ │ │ │ │ + self.send_channel_control(self.channel, 'pong', message)
│ │ │ │ │
│ │ │ │ │ - def __init__(self, router: Router):
│ │ │ │ │ - super().__init__(router)
│ │ │ │ │
│ │ │ │ │ - # All Peers start out frozen — we only unfreeze after we see the first 'init' message
│ │ │ │ │ - self.freeze_endpoint()
│ │ │ │ │ +class ProtocolChannel(Channel, asyncio.Protocol):
│ │ │ │ │ + """A channel subclass that implements the asyncio Protocol interface.
│ │ │ │ │
│ │ │ │ │ - self.init_future = asyncio.get_running_loop().create_future()
│ │ │ │ │ - self.done_callbacks = []
│ │ │ │ │ + In effect, data sent to this channel will be written to the connected
│ │ │ │ │ + transport, and vice-versa. Flow control is supported.
│ │ │ │ │
│ │ │ │ │ - # Initialization
│ │ │ │ │ - async def do_connect_transport(self) -> None:
│ │ │ │ │ - raise NotImplementedError
│ │ │ │ │ + The default implementation of the .do_open() method calls the
│ │ │ │ │ + .create_transport() abstract method. This method should return a transport
│ │ │ │ │ + which will be used for communication on the channel.
│ │ │ │ │
│ │ │ │ │ - async def spawn(self, argv: Sequence[str], env: Sequence[str], **kwargs) -> asyncio.Transport:
│ │ │ │ │ - # Not actually async...
│ │ │ │ │ - loop = asyncio.get_running_loop()
│ │ │ │ │ - user_env = dict(e.split('=', 1) for e in env)
│ │ │ │ │ - return SubprocessTransport(loop, self, argv, env=dict(os.environ, **user_env), **kwargs)
│ │ │ │ │ + Otherwise, if the subclass implements .do_open() itself, it is responsible
│ │ │ │ │ + for setting up the connection and ensuring that .connection_made() is called.
│ │ │ │ │ + """
│ │ │ │ │ + _transport: 'asyncio.Transport | None'
│ │ │ │ │ + _send_pongs: bool = True
│ │ │ │ │ + _last_ping: 'JsonObject | None' = None
│ │ │ │ │ + _create_transport_task: 'asyncio.Task[asyncio.Transport] | None' = None
│ │ │ │ │
│ │ │ │ │ - async def start(self, init_host: Optional[str] = None, **kwargs: JsonValue) -> JsonObject:
│ │ │ │ │ - """Request that the Peer is started and connected to the router.
│ │ │ │ │ + # read-side EOF handling
│ │ │ │ │ + _close_on_eof: bool = False
│ │ │ │ │ + _eof: bool = False
│ │ │ │ │
│ │ │ │ │ - Creates the transport, connects it to the protocol, and participates in
│ │ │ │ │ - exchanging of init messages. If anything goes wrong, the connection
│ │ │ │ │ - will be closed and an exception will be raised.
│ │ │ │ │ + async def create_transport(self, loop: asyncio.AbstractEventLoop, options: JsonObject) -> asyncio.Transport:
│ │ │ │ │ + """Creates the transport for this channel, according to options.
│ │ │ │ │
│ │ │ │ │ - The Peer starts out in a frozen state (ie: attempts to send messages to
│ │ │ │ │ - it will initially be queued). If init_host is not None then an init
│ │ │ │ │ - message is sent with the given 'host' field, plus any extra kwargs, and
│ │ │ │ │ - the queue is thawed. Otherwise, the caller is responsible for sending
│ │ │ │ │ - the init message and thawing the peer.
│ │ │ │ │ + The event loop for the transport is passed to the function. The
│ │ │ │ │ + protocol for the transport is the channel object, itself (self).
│ │ │ │ │
│ │ │ │ │ - In any case, the return value is the init message from the peer.
│ │ │ │ │ + This needs to be implemented by the subclass.
│ │ │ │ │ """
│ │ │ │ │ - assert self.init_future is not None
│ │ │ │ │ -
│ │ │ │ │ - def _connect_task_done(task: asyncio.Task) -> None:
│ │ │ │ │ - assert task is connect_task
│ │ │ │ │ - try:
│ │ │ │ │ - task.result()
│ │ │ │ │ - except asyncio.CancelledError: # we did that (below)
│ │ │ │ │ - pass # we want to ignore it
│ │ │ │ │ - except Exception as exc:
│ │ │ │ │ - self.close(exc)
│ │ │ │ │ + raise NotImplementedError
│ │ │ │ │
│ │ │ │ │ - connect_task = asyncio.create_task(self.do_connect_transport())
│ │ │ │ │ - connect_task.add_done_callback(_connect_task_done)
│ │ │ │ │ + def do_open(self, options: JsonObject) -> None:
│ │ │ │ │ + loop = asyncio.get_running_loop()
│ │ │ │ │ + self._create_transport_task = asyncio.create_task(self.create_transport(loop, options))
│ │ │ │ │ + self._create_transport_task.add_done_callback(self.create_transport_done)
│ │ │ │ │
│ │ │ │ │ + def create_transport_done(self, task: 'asyncio.Task[asyncio.Transport]') -> None:
│ │ │ │ │ + assert task is self._create_transport_task
│ │ │ │ │ + self._create_transport_task = None
│ │ │ │ │ try:
│ │ │ │ │ - # Wait for something to happen:
│ │ │ │ │ - # - exception from our connection function
│ │ │ │ │ - # - receiving "init" from the other side
│ │ │ │ │ - # - receiving EOF from the other side
│ │ │ │ │ - # - .close() was called
│ │ │ │ │ - # - other transport exception
│ │ │ │ │ - init_message = await self.init_future
│ │ │ │ │ + transport = task.result()
│ │ │ │ │ + except ChannelError as exc:
│ │ │ │ │ + self.close(exc.get_attrs())
│ │ │ │ │ + return
│ │ │ │ │
│ │ │ │ │ - except (PeerExited, BrokenPipeError):
│ │ │ │ │ - # These are fairly generic errors. PeerExited means that we observed the process exiting.
│ │ │ │ │ - # BrokenPipeError means that we got EPIPE when attempting to write() to it. In both cases,
│ │ │ │ │ - # the process is gone, but it's not clear why. If the connection process is still running,
│ │ │ │ │ - # perhaps we'd get a better error message from it.
│ │ │ │ │ - await connect_task
│ │ │ │ │ - # Otherwise, re-raise
│ │ │ │ │ - raise
│ │ │ │ │ + self.connection_made(transport)
│ │ │ │ │ + self.ready()
│ │ │ │ │
│ │ │ │ │ - finally:
│ │ │ │ │ - self.init_future = None
│ │ │ │ │ + def connection_made(self, transport: asyncio.BaseTransport) -> None:
│ │ │ │ │ + assert isinstance(transport, asyncio.Transport)
│ │ │ │ │ + self._transport = transport
│ │ │ │ │
│ │ │ │ │ - # In any case (failure or success) make sure this is done.
│ │ │ │ │ - if not connect_task.done():
│ │ │ │ │ - connect_task.cancel()
│ │ │ │ │ + def _get_close_args(self) -> JsonObject:
│ │ │ │ │ + return {}
│ │ │ │ │
│ │ │ │ │ - if init_host is not None:
│ │ │ │ │ - logger.debug(' sending init message back, host %s', init_host)
│ │ │ │ │ - # Send "init" back
│ │ │ │ │ - self.write_control(None, command='init', version=1, host=init_host, **kwargs)
│ │ │ │ │ + def connection_lost(self, exc: 'Exception | None') -> None:
│ │ │ │ │ + self.close(self._get_close_args())
│ │ │ │ │
│ │ │ │ │ - # Thaw the queued messages
│ │ │ │ │ - self.thaw_endpoint()
│ │ │ │ │ + def do_data(self, data: bytes) -> None:
│ │ │ │ │ + assert self._transport is not None
│ │ │ │ │ + self._transport.write(data)
│ │ │ │ │
│ │ │ │ │ - return init_message
│ │ │ │ │ + def do_done(self) -> None:
│ │ │ │ │ + assert self._transport is not None
│ │ │ │ │ + if self._transport.can_write_eof():
│ │ │ │ │ + self._transport.write_eof()
│ │ │ │ │
│ │ │ │ │ - # Background initialization
│ │ │ │ │ - def start_in_background(self, init_host: Optional[str] = None, **kwargs: JsonValue) -> None:
│ │ │ │ │ - def _start_task_done(task: asyncio.Task) -> None:
│ │ │ │ │ - assert task is start_task
│ │ │ │ │ + def do_close(self) -> None:
│ │ │ │ │ + if self._transport is not None:
│ │ │ │ │ + self._transport.close()
│ │ │ │ │
│ │ │ │ │ - try:
│ │ │ │ │ - task.result()
│ │ │ │ │ - except (OSError, PeerExited, CockpitProblem, asyncio.CancelledError):
│ │ │ │ │ - pass # Those are expected. Others will throw.
│ │ │ │ │ + def data_received(self, data: bytes) -> None:
│ │ │ │ │ + assert self._transport is not None
│ │ │ │ │ + if not self.send_data(data):
│ │ │ │ │ + self._transport.pause_reading()
│ │ │ │ │
│ │ │ │ │ - start_task = asyncio.create_task(self.start(init_host, **kwargs))
│ │ │ │ │ - start_task.add_done_callback(_start_task_done)
│ │ │ │ │ + def do_resume_send(self) -> None:
│ │ │ │ │ + assert self._transport is not None
│ │ │ │ │ + self._transport.resume_reading()
│ │ │ │ │
│ │ │ │ │ - # Shutdown
│ │ │ │ │ - def add_done_callback(self, callback: Callable[[], None]) -> None:
│ │ │ │ │ - self.done_callbacks.append(callback)
│ │ │ │ │ + def close_on_eof(self) -> None:
│ │ │ │ │ + """Mark the channel to be closed on EOF.
│ │ │ │ │
│ │ │ │ │ - # Handling of interesting events
│ │ │ │ │ - def do_superuser_init_done(self) -> None:
│ │ │ │ │ - pass
│ │ │ │ │ + Normally, ProtocolChannel tries to keep the channel half-open after
│ │ │ │ │ + receiving EOF from the transport. This instructs that the channel
│ │ │ │ │ + should be closed on EOF.
│ │ │ │ │
│ │ │ │ │ - def do_authorize(self, message: JsonObject) -> None:
│ │ │ │ │ - pass
│ │ │ │ │ + If EOF was already received, then calling this function will close the
│ │ │ │ │ + channel immediately.
│ │ │ │ │
│ │ │ │ │ - def transport_control_received(self, command: str, message: JsonObject) -> None:
│ │ │ │ │ - if command == 'init' and self.init_future is not None:
│ │ │ │ │ - logger.debug('Got init message with active init_future. Setting result.')
│ │ │ │ │ - self.init_future.set_result(message)
│ │ │ │ │ - elif command == 'authorize':
│ │ │ │ │ - self.do_authorize(message)
│ │ │ │ │ - elif command == 'superuser-init-done':
│ │ │ │ │ - self.do_superuser_init_done()
│ │ │ │ │ - else:
│ │ │ │ │ - raise CockpitProtocolError(f'Received unexpected control message {command}')
│ │ │ │ │ + If you don't call this function, you are responsible for closing the
│ │ │ │ │ + channel yourself.
│ │ │ │ │ + """
│ │ │ │ │ + self._close_on_eof = True
│ │ │ │ │ + if self._eof:
│ │ │ │ │ + assert self._transport is not None
│ │ │ │ │ + self._transport.close()
│ │ │ │ │
│ │ │ │ │ def eof_received(self) -> bool:
│ │ │ │ │ - # We always expect to be the ones to close the connection, so if we get
│ │ │ │ │ - # an EOF, then we consider it to be an error. This allows us to
│ │ │ │ │ - # distinguish close caused by unexpected EOF (but no errno from a
│ │ │ │ │ - # syscall failure) vs. close caused by calling .close() on our side.
│ │ │ │ │ - # The process is still running at this point, so keep it and handle
│ │ │ │ │ - # the error in process_exited().
│ │ │ │ │ - logger.debug('Peer %s received unexpected EOF', self.__class__.__name__)
│ │ │ │ │ - return True
│ │ │ │ │ -
│ │ │ │ │ - def do_closed(self, exc: Optional[Exception]) -> None:
│ │ │ │ │ - logger.debug('Peer %s connection lost %s %s', self.__class__.__name__, type(exc), exc)
│ │ │ │ │ + self._eof = True
│ │ │ │ │ + self.done()
│ │ │ │ │ + return not self._close_on_eof
│ │ │ │ │
│ │ │ │ │ - if exc is None:
│ │ │ │ │ - self.shutdown_endpoint(problem='terminated')
│ │ │ │ │ - elif isinstance(exc, PeerExited):
│ │ │ │ │ - # a common case is that the called peer does not exist
│ │ │ │ │ - if exc.exit_code == 127:
│ │ │ │ │ - self.shutdown_endpoint(problem='no-cockpit')
│ │ │ │ │ - else:
│ │ │ │ │ - self.shutdown_endpoint(problem='terminated', message=f'Peer exited with status {exc.exit_code}')
│ │ │ │ │ - elif isinstance(exc, CockpitProblem):
│ │ │ │ │ - self.shutdown_endpoint(exc.attrs)
│ │ │ │ │ + # Channel receive-side flow control
│ │ │ │ │ + def do_ping(self, message):
│ │ │ │ │ + if self._send_pongs:
│ │ │ │ │ + self.send_pong(message)
│ │ │ │ │ else:
│ │ │ │ │ - self.shutdown_endpoint(problem='internal-error',
│ │ │ │ │ - message=f"[{exc.__class__.__name__}] {exc!s}")
│ │ │ │ │ -
│ │ │ │ │ - # If .start() is running, we need to make sure it stops running,
│ │ │ │ │ - # raising the correct exception.
│ │ │ │ │ - if self.init_future is not None and not self.init_future.done():
│ │ │ │ │ - if exc is not None:
│ │ │ │ │ - self.init_future.set_exception(exc)
│ │ │ │ │ - else:
│ │ │ │ │ - self.init_future.cancel()
│ │ │ │ │ -
│ │ │ │ │ - for callback in self.done_callbacks:
│ │ │ │ │ - callback()
│ │ │ │ │ -
│ │ │ │ │ - def process_exited(self) -> None:
│ │ │ │ │ - assert isinstance(self.transport, SubprocessTransport)
│ │ │ │ │ - logger.debug('Peer %s exited, status %d', self.__class__.__name__, self.transport.get_returncode())
│ │ │ │ │ - returncode = self.transport.get_returncode()
│ │ │ │ │ - assert isinstance(returncode, int)
│ │ │ │ │ - self.close(PeerExited(returncode))
│ │ │ │ │ -
│ │ │ │ │ - # Forwarding data: from the peer to the router
│ │ │ │ │ - def channel_control_received(self, channel: str, command: str, message: JsonObject) -> None:
│ │ │ │ │ - if self.init_future is not None:
│ │ │ │ │ - raise CockpitProtocolError('Received unexpected channel control message before init')
│ │ │ │ │ - self.send_channel_control(channel, command, message)
│ │ │ │ │ -
│ │ │ │ │ - def channel_data_received(self, channel: str, data: bytes) -> None:
│ │ │ │ │ - if self.init_future is not None:
│ │ │ │ │ - raise CockpitProtocolError('Received unexpected channel data before init')
│ │ │ │ │ - self.send_channel_data(channel, data)
│ │ │ │ │ -
│ │ │ │ │ - # Forwarding data: from the router to the peer
│ │ │ │ │ - def do_channel_control(self, channel: str, command: str, message: JsonObject) -> None:
│ │ │ │ │ - assert self.init_future is None
│ │ │ │ │ - self.write_control(message)
│ │ │ │ │ -
│ │ │ │ │ - def do_channel_data(self, channel: str, data: bytes) -> None:
│ │ │ │ │ - assert self.init_future is None
│ │ │ │ │ - self.write_channel_data(channel, data)
│ │ │ │ │ -
│ │ │ │ │ - def do_kill(self, host: 'str | None', group: 'str | None', message: JsonObject) -> None:
│ │ │ │ │ - assert self.init_future is None
│ │ │ │ │ - self.write_control(message)
│ │ │ │ │ -
│ │ │ │ │ - def do_close(self) -> None:
│ │ │ │ │ - self.close()
│ │ │ │ │ -
│ │ │ │ │ -
│ │ │ │ │ -class ConfiguredPeer(Peer):
│ │ │ │ │ - config: BridgeConfig
│ │ │ │ │ - args: Sequence[str]
│ │ │ │ │ - env: Sequence[str]
│ │ │ │ │ -
│ │ │ │ │ - def __init__(self, router: Router, config: BridgeConfig):
│ │ │ │ │ - self.config = config
│ │ │ │ │ - self.args = config.spawn
│ │ │ │ │ - self.env = config.environ
│ │ │ │ │ - super().__init__(router)
│ │ │ │ │ -
│ │ │ │ │ - async def do_connect_transport(self) -> None:
│ │ │ │ │ - await self.spawn(self.args, self.env)
│ │ │ │ │ -
│ │ │ │ │ -
│ │ │ │ │ -class PeerRoutingRule(RoutingRule):
│ │ │ │ │ - config: BridgeConfig
│ │ │ │ │ - match: JsonObject
│ │ │ │ │ - peer: Optional[Peer]
│ │ │ │ │ -
│ │ │ │ │ - def __init__(self, router: Router, config: BridgeConfig):
│ │ │ │ │ - super().__init__(router)
│ │ │ │ │ - self.config = config
│ │ │ │ │ - self.match = config.match
│ │ │ │ │ - self.peer = None
│ │ │ │ │ -
│ │ │ │ │ - def apply_rule(self, options: JsonObject) -> Optional[Peer]:
│ │ │ │ │ - # Check that we match
│ │ │ │ │ -
│ │ │ │ │ - for key, value in self.match.items():
│ │ │ │ │ - if key not in options:
│ │ │ │ │ - logger.debug(' rejecting because key %s is missing', key)
│ │ │ │ │ - return None
│ │ │ │ │ - if value is not None and options[key] != value:
│ │ │ │ │ - logger.debug(' rejecting because key %s has wrong value %s (vs %s)', key, options[key], value)
│ │ │ │ │ - return None
│ │ │ │ │ -
│ │ │ │ │ - # Start the peer if it's not running already
│ │ │ │ │ - if self.peer is None:
│ │ │ │ │ - self.peer = ConfiguredPeer(self.router, self.config)
│ │ │ │ │ - self.peer.add_done_callback(self.peer_closed)
│ │ │ │ │ - assert self.router.init_host
│ │ │ │ │ - self.peer.start_in_background(init_host=self.router.init_host)
│ │ │ │ │ -
│ │ │ │ │ - return self.peer
│ │ │ │ │ -
│ │ │ │ │ - def peer_closed(self):
│ │ │ │ │ - self.peer = None
│ │ │ │ │ -
│ │ │ │ │ - def shutdown(self):
│ │ │ │ │ - if self.peer is not None:
│ │ │ │ │ - self.peer.close()
│ │ │ │ │ -
│ │ │ │ │ -
│ │ │ │ │ -class PeersRoutingRule(RoutingRule):
│ │ │ │ │ - rules: List[PeerRoutingRule] = []
│ │ │ │ │ -
│ │ │ │ │ - def apply_rule(self, options: JsonObject) -> Optional[Endpoint]:
│ │ │ │ │ - logger.debug(' considering %d rules', len(self.rules))
│ │ │ │ │ - for rule in self.rules:
│ │ │ │ │ - logger.debug(' considering %s', rule.config.name)
│ │ │ │ │ - endpoint = rule.apply_rule(options)
│ │ │ │ │ - if endpoint is not None:
│ │ │ │ │ - logger.debug(' selected')
│ │ │ │ │ - return endpoint
│ │ │ │ │ - logger.debug(' no peer rules matched')
│ │ │ │ │ - return None
│ │ │ │ │ -
│ │ │ │ │ - def set_configs(self, bridge_configs: Sequence[BridgeConfig]) -> None:
│ │ │ │ │ - old_rules = self.rules
│ │ │ │ │ - self.rules = []
│ │ │ │ │ -
│ │ │ │ │ - for config in bridge_configs:
│ │ │ │ │ - # Those are handled elsewhere...
│ │ │ │ │ - if config.privileged or 'host' in config.match:
│ │ │ │ │ - continue
│ │ │ │ │ + # we'll have to pong later
│ │ │ │ │ + self._last_ping = message
│ │ │ │ │
│ │ │ │ │ - # Try to reuse an existing rule, if one exists...
│ │ │ │ │ - for rule in list(old_rules):
│ │ │ │ │ - if rule.config == config:
│ │ │ │ │ - old_rules.remove(rule)
│ │ │ │ │ - break
│ │ │ │ │ - else:
│ │ │ │ │ - # ... otherwise, create a new one.
│ │ │ │ │ - rule = PeerRoutingRule(self.router, config)
│ │ │ │ │ + def pause_writing(self) -> None:
│ │ │ │ │ + # We can't actually stop writing, but we can stop replying to pings
│ │ │ │ │ + self._send_pongs = False
│ │ │ │ │
│ │ │ │ │ - self.rules.append(rule)
│ │ │ │ │ + def resume_writing(self) -> None:
│ │ │ │ │ + self._send_pongs = True
│ │ │ │ │ + if self._last_ping is not None:
│ │ │ │ │ + self.send_pong(self._last_ping)
│ │ │ │ │ + self._last_ping = None
│ │ │ │ │
│ │ │ │ │ - # close down the old rules that didn't get reclaimed
│ │ │ │ │ - for rule in old_rules:
│ │ │ │ │ - rule.shutdown()
│ │ │ │ │
│ │ │ │ │ - def shutdown(self):
│ │ │ │ │ - for rule in self.rules:
│ │ │ │ │ - rule.shutdown()
│ │ │ │ │ -'''.encode('utf-8'),
│ │ │ │ │ - 'cockpit/internal_endpoints.py': br'''# This file is part of Cockpit.
│ │ │ │ │ -#
│ │ │ │ │ -# Copyright (C) 2022 Red Hat, Inc.
│ │ │ │ │ -#
│ │ │ │ │ -# This program is free software: you can redistribute it and/or modify
│ │ │ │ │ -# it under the terms of the GNU General Public License as published by
│ │ │ │ │ -# the Free Software Foundation, either version 3 of the License, or
│ │ │ │ │ -# (at your option) any later version.
│ │ │ │ │ -#
│ │ │ │ │ -# This program is distributed in the hope that it will be useful,
│ │ │ │ │ -# but WITHOUT ANY WARRANTY; without even the implied warranty of
│ │ │ │ │ -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
│ │ │ │ │ -# GNU General Public License for more details.
│ │ │ │ │ -#
│ │ │ │ │ -# You should have received a copy of the GNU General Public License
│ │ │ │ │ -# along with this program. If not, see .
│ │ │ │ │ +class AsyncChannel(Channel):
│ │ │ │ │ + """A subclass for async/await-style implementation of channels, with flow control
│ │ │ │ │
│ │ │ │ │ -import asyncio
│ │ │ │ │ -import glob
│ │ │ │ │ -import grp
│ │ │ │ │ -import json
│ │ │ │ │ -import logging
│ │ │ │ │ -import os
│ │ │ │ │ -import pwd
│ │ │ │ │ -from pathlib import Path
│ │ │ │ │ -from typing import Dict, Optional
│ │ │ │ │ + This subclass provides asynchronous `read()` and `write()` calls for
│ │ │ │ │ + subclasses, with familiar semantics. `write()` doesn't buffer, so the
│ │ │ │ │ + `done()` method on the base channel class can be used in a way similar to
│ │ │ │ │ + `shutdown()`. A high-level `sendfile()` method is available to send the
│ │ │ │ │ + entire contents of a binary-mode file-like object.
│ │ │ │ │
│ │ │ │ │ -from cockpit._vendor.systemd_ctypes import Variant, bus, inotify, pathwatch
│ │ │ │ │ + The subclass must provide an async `run()` function, which will be spawned
│ │ │ │ │ + as a task. The task is cancelled when the channel is closed.
│ │ │ │ │
│ │ │ │ │ -from . import config
│ │ │ │ │ + On the receiving side, the channel will respond to flow control pings to
│ │ │ │ │ + indicate that it has received the data, but only after it has been consumed
│ │ │ │ │ + by `read()`.
│ │ │ │ │
│ │ │ │ │ -logger = logging.getLogger(__name__)
│ │ │ │ │ + On the sending side, write() will block if the channel backs up.
│ │ │ │ │ + """
│ │ │ │ │
│ │ │ │ │ + # Receive-side flow control: intermix pings and data in the queue and reply
│ │ │ │ │ + # to pings as we dequeue them. EOF is None. This is a buffer: since we
│ │ │ │ │ + # need to handle do_data() without blocking, we have no choice.
│ │ │ │ │ + receive_queue: 'asyncio.Queue[bytes | JsonObject | None]'
│ │ │ │ │ + loop: asyncio.AbstractEventLoop
│ │ │ │ │
│ │ │ │ │ -class cockpit_LoginMessages(bus.Object):
│ │ │ │ │ - messages: Optional[str] = None
│ │ │ │ │ + # Send-side flow control
│ │ │ │ │ + write_waiter = None
│ │ │ │ │
│ │ │ │ │ - def __init__(self):
│ │ │ │ │ - fdstr = os.environ.pop('COCKPIT_LOGIN_MESSAGES_MEMFD', None)
│ │ │ │ │ - if fdstr is None:
│ │ │ │ │ - logger.debug("COCKPIT_LOGIN_MESSAGES_MEMFD wasn't set. No login messages today.")
│ │ │ │ │ - return
│ │ │ │ │ + async def run(self, options: JsonObject) -> 'JsonObject | None':
│ │ │ │ │ + raise NotImplementedError
│ │ │ │ │
│ │ │ │ │ - logger.debug("Trying to read login messages from fd %s", fdstr)
│ │ │ │ │ + async def run_wrapper(self, options: JsonObject) -> None:
│ │ │ │ │ try:
│ │ │ │ │ - with open(int(fdstr), 'r') as login_messages:
│ │ │ │ │ - login_messages.seek(0)
│ │ │ │ │ - self.messages = login_messages.read()
│ │ │ │ │ - except (ValueError, OSError, UnicodeDecodeError) as exc:
│ │ │ │ │ - # ValueError - the envvar wasn't an int
│ │ │ │ │ - # OSError - the fd wasn't open, or other read failure
│ │ │ │ │ - # UnicodeDecodeError - didn't contain utf-8
│ │ │ │ │ - # For all of these, we simply failed to get the message.
│ │ │ │ │ - logger.debug("Reading login messages failed: %s", exc)
│ │ │ │ │ - else:
│ │ │ │ │ - logger.debug("Successfully read login messages: %s", self.messages)
│ │ │ │ │ -
│ │ │ │ │ - @bus.Interface.Method(out_types=['s'])
│ │ │ │ │ - def get(self):
│ │ │ │ │ - return self.messages or '{}'
│ │ │ │ │ -
│ │ │ │ │ - @bus.Interface.Method(out_types=[])
│ │ │ │ │ - def dismiss(self):
│ │ │ │ │ - self.messages = None
│ │ │ │ │ -
│ │ │ │ │ -
│ │ │ │ │ -class cockpit_Machines(bus.Object):
│ │ │ │ │ - path: Path
│ │ │ │ │ - watch: pathwatch.PathWatch
│ │ │ │ │ - pending_notify: Optional[asyncio.Handle]
│ │ │ │ │ -
│ │ │ │ │ - # D-Bus implementation
│ │ │ │ │ - machines = bus.Interface.Property('a{sa{sv}}')
│ │ │ │ │ -
│ │ │ │ │ - @machines.getter
│ │ │ │ │ - def get_machines(self) -> Dict[str, Dict[str, Variant]]:
│ │ │ │ │ - results: Dict[str, Dict[str, Variant]] = {}
│ │ │ │ │ -
│ │ │ │ │ - for filename in glob.glob(f'{self.path}/*.json'):
│ │ │ │ │ - with open(filename) as fp:
│ │ │ │ │ - try:
│ │ │ │ │ - contents = json.load(fp)
│ │ │ │ │ - except json.JSONDecodeError:
│ │ │ │ │ - logger.warning('Invalid JSON in file %s. Ignoring.', filename)
│ │ │ │ │ - continue
│ │ │ │ │ - # merge
│ │ │ │ │ - for hostname, attrs in contents.items():
│ │ │ │ │ - results[hostname] = {key: Variant(value) for key, value in attrs.items()}
│ │ │ │ │ -
│ │ │ │ │ - return results
│ │ │ │ │ + self.loop = asyncio.get_running_loop()
│ │ │ │ │ + self.close(await self.run(options))
│ │ │ │ │ + except asyncio.CancelledError: # user requested close
│ │ │ │ │ + self.close()
│ │ │ │ │ + except ChannelError as exc:
│ │ │ │ │ + self.close(exc.get_attrs())
│ │ │ │ │ + except BaseException:
│ │ │ │ │ + self.close({'problem': 'internal-error', 'cause': traceback.format_exc()})
│ │ │ │ │ + raise
│ │ │ │ │
│ │ │ │ │ - @bus.Interface.Method(in_types=['s', 's', 'a{sv}'])
│ │ │ │ │ - def update(self, filename: str, hostname: str, attrs: Dict[str, Variant]) -> None:
│ │ │ │ │ - try:
│ │ │ │ │ - with self.path.joinpath(filename).open() as fp:
│ │ │ │ │ - contents = json.load(fp)
│ │ │ │ │ - except json.JSONDecodeError as exc:
│ │ │ │ │ - # Refuse to replace corrupted file
│ │ │ │ │ - raise bus.BusError('cockpit.Machines.Error', f'File {filename} is in invalid format: {exc}.') from exc
│ │ │ │ │ - except FileNotFoundError:
│ │ │ │ │ - # But an empty file is an expected case
│ │ │ │ │ - contents = {}
│ │ │ │ │ + async def read(self) -> 'bytes | None':
│ │ │ │ │ + # Three possibilities for what we'll find:
│ │ │ │ │ + # - None (EOF) → return None
│ │ │ │ │ + # - a ping → send a pong
│ │ │ │ │ + # - bytes (possibly empty) → ack the receipt, and return it
│ │ │ │ │ + while True:
│ │ │ │ │ + item = await self.receive_queue.get()
│ │ │ │ │ + if item is None:
│ │ │ │ │ + return None
│ │ │ │ │ + if isinstance(item, Mapping):
│ │ │ │ │ + self.send_pong(item)
│ │ │ │ │ + else:
│ │ │ │ │ + self.send_ack(item)
│ │ │ │ │ + return item
│ │ │ │ │
│ │ │ │ │ - contents.setdefault(hostname, {}).update({key: value.value for key, value in attrs.items()})
│ │ │ │ │ + async def write(self, data: bytes) -> None:
│ │ │ │ │ + if not self.send_data(data):
│ │ │ │ │ + self.write_waiter = self.loop.create_future()
│ │ │ │ │ + await self.write_waiter
│ │ │ │ │
│ │ │ │ │ - self.path.mkdir(parents=True, exist_ok=True)
│ │ │ │ │ - with open(self.path.joinpath(filename), 'w') as fp:
│ │ │ │ │ - json.dump(contents, fp, indent=2)
│ │ │ │ │ + async def in_thread(self, fn: 'Callable[_P, _T]', *args: '_P.args', **kwargs: '_P.kwargs') -> '_T':
│ │ │ │ │ + return await self.loop.run_in_executor(None, fn, *args, **kwargs)
│ │ │ │ │
│ │ │ │ │ - def notify(self):
│ │ │ │ │ - def _notify_now():
│ │ │ │ │ - self.properties_changed('cockpit.Machines', {}, ['Machines'])
│ │ │ │ │ - self.pending_notify = None
│ │ │ │ │ + async def sendfile(self, stream: BinaryIO) -> None:
│ │ │ │ │ + with stream:
│ │ │ │ │ + while True:
│ │ │ │ │ + data = await self.loop.run_in_executor(None, stream.read, Channel.BLOCK_SIZE)
│ │ │ │ │ + if data == b'':
│ │ │ │ │ + break
│ │ │ │ │ + await self.write(data)
│ │ │ │ │
│ │ │ │ │ - # avoid a flurry of update notifications
│ │ │ │ │ - if self.pending_notify is None:
│ │ │ │ │ - self.pending_notify = asyncio.get_running_loop().call_later(1.0, _notify_now)
│ │ │ │ │ + self.done()
│ │ │ │ │
│ │ │ │ │ - # inotify events
│ │ │ │ │ - def do_inotify_event(self, mask: inotify.Event, cookie: int, name: Optional[str]) -> None:
│ │ │ │ │ - self.notify()
│ │ │ │ │ + def do_resume_send(self) -> None:
│ │ │ │ │ + if self.write_waiter is not None:
│ │ │ │ │ + self.write_waiter.set_result(None)
│ │ │ │ │ + self.write_waiter = None
│ │ │ │ │
│ │ │ │ │ - def do_identity_changed(self, fd: Optional[int], errno: Optional[int]) -> None:
│ │ │ │ │ - self.notify()
│ │ │ │ │ + def do_open(self, options: JsonObject) -> None:
│ │ │ │ │ + self.receive_queue = asyncio.Queue()
│ │ │ │ │ + self._run_task = self.create_task(self.run_wrapper(options),
│ │ │ │ │ + name=f'{self.__class__.__name__}.run_wrapper({options})')
│ │ │ │ │
│ │ │ │ │ - def __init__(self):
│ │ │ │ │ - self.path = config.lookup_config('machines.d')
│ │ │ │ │ + def do_done(self) -> None:
│ │ │ │ │ + self.receive_queue.put_nowait(None)
│ │ │ │ │
│ │ │ │ │ - # ignore the first callback
│ │ │ │ │ - self.pending_notify = ...
│ │ │ │ │ - self.watch = pathwatch.PathWatch(str(self.path), self)
│ │ │ │ │ - self.pending_notify = None
│ │ │ │ │ + def do_close(self) -> None:
│ │ │ │ │ + self._run_task.cancel()
│ │ │ │ │
│ │ │ │ │ + def do_ping(self, message: JsonObject) -> None:
│ │ │ │ │ + self.receive_queue.put_nowait(message)
│ │ │ │ │
│ │ │ │ │ -class cockpit_User(bus.Object):
│ │ │ │ │ - name = bus.Interface.Property('s', value='')
│ │ │ │ │ - full = bus.Interface.Property('s', value='')
│ │ │ │ │ - id = bus.Interface.Property('i', value=0)
│ │ │ │ │ - gid = bus.Interface.Property('i', value=0)
│ │ │ │ │ - home = bus.Interface.Property('s', value='')
│ │ │ │ │ - shell = bus.Interface.Property('s', value='')
│ │ │ │ │ - groups = bus.Interface.Property('as', value=[])
│ │ │ │ │ + def do_data(self, data: bytes) -> bool:
│ │ │ │ │ + self.receive_queue.put_nowait(data)
│ │ │ │ │ + return True # we will send the 'ack' later (from read())
│ │ │ │ │
│ │ │ │ │ - def __init__(self):
│ │ │ │ │ - user = pwd.getpwuid(os.getuid())
│ │ │ │ │ - self.name = user.pw_name
│ │ │ │ │ - self.full = user.pw_gecos
│ │ │ │ │ - self.id = user.pw_uid
│ │ │ │ │ - self.gid = user.pw_gid
│ │ │ │ │ - self.home = user.pw_dir
│ │ │ │ │ - self.shell = user.pw_shell
│ │ │ │ │
│ │ │ │ │ - # We want the primary group first in the list, without duplicates.
│ │ │ │ │ - # This is a bit awkward because `set()` is unordered...
│ │ │ │ │ - groups = [grp.getgrgid(user.pw_gid).gr_name]
│ │ │ │ │ - for gr in grp.getgrall():
│ │ │ │ │ - if user.pw_name in gr.gr_mem and gr.gr_name not in groups:
│ │ │ │ │ - groups.append(gr.gr_name)
│ │ │ │ │ - self.groups = groups
│ │ │ │ │ +class GeneratorChannel(Channel):
│ │ │ │ │ + """A trivial Channel subclass for sending data from a generator with flow control.
│ │ │ │ │
│ │ │ │ │ + Calls the .do_yield_data() generator with the options from the open message
│ │ │ │ │ + and sends the data which it yields. If the generator returns a value it
│ │ │ │ │ + will be used for the close message.
│ │ │ │ │ + """
│ │ │ │ │ + __generator: 'Generator[bytes, None, JsonObject]'
│ │ │ │ │
│ │ │ │ │ -EXPORTS = [
│ │ │ │ │ - ('/LoginMessages', cockpit_LoginMessages),
│ │ │ │ │ - ('/machines', cockpit_Machines),
│ │ │ │ │ - ('/user', cockpit_User),
│ │ │ │ │ -]
│ │ │ │ │ -''',
│ │ │ │ │ + def do_yield_data(self, options: JsonObject) -> 'Generator[bytes, None, JsonObject]':
│ │ │ │ │ + raise NotImplementedError
│ │ │ │ │ +
│ │ │ │ │ + def do_open(self, options: JsonObject) -> None:
│ │ │ │ │ + self.__generator = self.do_yield_data(options)
│ │ │ │ │ + self.do_resume_send()
│ │ │ │ │ +
│ │ │ │ │ + def do_resume_send(self) -> None:
│ │ │ │ │ + try:
│ │ │ │ │ + while self.send_data(next(self.__generator)):
│ │ │ │ │ + pass
│ │ │ │ │ + except StopIteration as stop:
│ │ │ │ │ + self.done()
│ │ │ │ │ + self.close(stop.value)
│ │ │ │ │ +'''.encode('utf-8'),
│ │ │ │ │ 'cockpit/packages.py': br'''# This file is part of Cockpit.
│ │ │ │ │ #
│ │ │ │ │ # Copyright (C) 2022 Red Hat, Inc.
│ │ │ │ │ #
│ │ │ │ │ # This program is free software: you can redistribute it and/or modify
│ │ │ │ │ # it under the terms of the GNU General Public License as published by
│ │ │ │ │ # the Free Software Foundation, either version 3 of the License, or
│ │ │ │ │ @@ -3573,15 +5009,79 @@
│ │ │ │ │ elif filename == 'manifests.js':
│ │ │ │ │ return self.load_manifests_js(headers)
│ │ │ │ │ elif filename == 'manifests.json':
│ │ │ │ │ return self.load_manifests_json()
│ │ │ │ │ else:
│ │ │ │ │ raise KeyError
│ │ │ │ │ ''',
│ │ │ │ │ - 'cockpit/channel.py': r'''# This file is part of Cockpit.
│ │ │ │ │ + 'cockpit/data/__init__.py': br'''import sys
│ │ │ │ │ +
│ │ │ │ │ +if sys.version_info >= (3, 11):
│ │ │ │ │ + import importlib.resources
│ │ │ │ │ +
│ │ │ │ │ + def read_cockpit_data_file(filename: str) -> bytes:
│ │ │ │ │ + return (importlib.resources.files('cockpit.data') / filename).read_bytes()
│ │ │ │ │ +
│ │ │ │ │ +else:
│ │ │ │ │ + import importlib.abc
│ │ │ │ │ +
│ │ │ │ │ + def read_cockpit_data_file(filename: str) -> bytes:
│ │ │ │ │ + # https://github.com/python/mypy/issues/4182
│ │ │ │ │ + loader = __loader__ # type: ignore[name-defined]
│ │ │ │ │ + assert isinstance(loader, importlib.abc.ResourceLoader)
│ │ │ │ │ +
│ │ │ │ │ + path = __file__.replace('__init__.py', filename)
│ │ │ │ │ + return loader.get_data(path)
│ │ │ │ │ +''',
│ │ │ │ │ + 'cockpit/data/fail.html': br'''
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ + @@message@@
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +
│ │ │ │ │ +
@@message@@
│ │ │ │ │ +
│ │ │ │ │ -
│ │ │ │ │ -
@@message@@
│ │ │ │ │ -