From 73f68c76fb05037bd7fe71688ce39eb1f526a385 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Thu, 6 May 2021 15:10:43 +0200 Subject: [PATCH 01/62] pantalaimon: Bump the allowed nio version --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 307f84b..0d18eac 100644 --- a/setup.py +++ b/setup.py @@ -29,7 +29,7 @@ setup( "cachetools >= 3.0.0", "prompt_toolkit > 2, < 4", "typing;python_version<'3.5'", - "matrix-nio[e2e] >= 0.14, < 0.18" + "matrix-nio[e2e] >= 0.14, < 0.19" ], extras_require={ "ui": [ From 87169df413b00f0491b483fd1a3cc296797741fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Fri, 14 May 2021 13:53:51 +0200 Subject: [PATCH 02/62] pantalaimon: Bump our version --- CHANGELOG.md | 8 ++++++++ pantalaimon/main.py | 2 +- pantalaimon/panctl.py | 2 +- setup.py | 2 +- 4 files changed, 11 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 46d7c45..c1dba35 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## 0.9.3 2021-05-14 + +### Changed + +- [[#73f68c7]] Bump the allowed nio version + +[73f68c7]: https://github.com/matrix-org/pantalaimon/commit/73f68c76fb05037bd7fe71688ce39eb1f526a385 + ## 0.9.2 2021-03-10 ### Changed diff --git a/pantalaimon/main.py b/pantalaimon/main.py index 6c69c82..0108cdb 100644 --- a/pantalaimon/main.py +++ b/pantalaimon/main.py @@ -259,7 +259,7 @@ async def daemon(context, log_level, debug_encryption, config, data_path): "connect to pantalaimon." ) ) -@click.version_option(version="0.9.2", prog_name="pantalaimon") +@click.version_option(version="0.9.3", prog_name="pantalaimon") @click.option( "--log-level", type=click.Choice(["error", "warning", "info", "debug"]), diff --git a/pantalaimon/panctl.py b/pantalaimon/panctl.py index e67e429..1b486cc 100644 --- a/pantalaimon/panctl.py +++ b/pantalaimon/panctl.py @@ -690,7 +690,7 @@ class PanCtl: "the pantalaimon daemon." ) ) -@click.version_option(version="0.9.2", prog_name="panctl") +@click.version_option(version="0.9.3", prog_name="panctl") def main(): loop = asyncio.get_event_loop() glib_loop = GLib.MainLoop() diff --git a/setup.py b/setup.py index 0d18eac..011d3e4 100644 --- a/setup.py +++ b/setup.py @@ -7,7 +7,7 @@ with open("README.md", encoding="utf-8") as f: setup( name="pantalaimon", - version="0.9.2", + version="0.9.3", url="https://github.com/matrix-org/pantalaimon", author="The Matrix.org Team", author_email="poljar@termina.org.uk", From 7b4cc0527d7fc17c0995700d52f582668577e768 Mon Sep 17 00:00:00 2001 From: Alexander Manning Date: Fri, 14 May 2021 13:25:29 +0100 Subject: [PATCH 03/62] Encrypt Thumbnails When a client sends a thumbnail with their media message, encrypt the thumbnail too. --- pantalaimon/daemon.py | 11 +++++++++++ pantalaimon/store.py | 13 +++++++++++++ 2 files changed, 24 insertions(+) diff --git a/pantalaimon/daemon.py b/pantalaimon/daemon.py index 10f1799..1d0afe4 100755 --- a/pantalaimon/daemon.py +++ b/pantalaimon/daemon.py @@ -954,6 +954,17 @@ class ProxyDaemon: ) media_content = media_info.to_content(content, upload_info.mimetype) + if media_content["info"].get("thumbnail_url", False): + ( + thumb_upload_info, + thumb_media_info, + ) = self._get_upload_and_media_info( + "thumbnail_url", media_content["info"] + ) + if thumb_upload_info and thumb_media_info: + media_content = thumb_media_info.to_thumbnail( + media_content, thumb_upload_info.mimetype + ) response = await client.room_send( room_id, msgtype, media_content, txnid, ignore_unverified diff --git a/pantalaimon/store.py b/pantalaimon/store.py index c1b4691..135936f 100644 --- a/pantalaimon/store.py +++ b/pantalaimon/store.py @@ -60,6 +60,19 @@ class MediaInfo: return content + def to_thumbnail(self, content: Dict, mime_type: str) -> Dict[Any, Any]: + content["info"]["thumbnail_file"] = { + "v": "v2", + "key": self.key, + "iv": self.iv, + "hashes": self.hashes, + "url": content["info"]["thumbnail_url"], + "mimetype": mime_type, + } + + return content + + @attr.s class UploadInfo: From 5e81131ecf4e0b67fef09589d9610743da6e7319 Mon Sep 17 00:00:00 2001 From: Alexander Manning Date: Fri, 14 May 2021 16:35:20 +0100 Subject: [PATCH 04/62] Remove return from MediaInfo.to_thumbnail() and from MediaInfo.to_content() --- pantalaimon/daemon.py | 12 ++++++------ pantalaimon/store.py | 4 ---- 2 files changed, 6 insertions(+), 10 deletions(-) diff --git a/pantalaimon/daemon.py b/pantalaimon/daemon.py index 1d0afe4..9693c9c 100755 --- a/pantalaimon/daemon.py +++ b/pantalaimon/daemon.py @@ -953,21 +953,21 @@ class ProxyDaemon: body=await response.transport_response.read(), ) - media_content = media_info.to_content(content, upload_info.mimetype) - if media_content["info"].get("thumbnail_url", False): + media_info.to_content(content, upload_info.mimetype) + if content["info"].get("thumbnail_url", False): ( thumb_upload_info, thumb_media_info, ) = self._get_upload_and_media_info( - "thumbnail_url", media_content["info"] + "thumbnail_url", content["info"] ) if thumb_upload_info and thumb_media_info: - media_content = thumb_media_info.to_thumbnail( - media_content, thumb_upload_info.mimetype + thumb_media_info.to_thumbnail( + content, thumb_upload_info.mimetype ) response = await client.room_send( - room_id, msgtype, media_content, txnid, ignore_unverified + room_id, msgtype, content, txnid, ignore_unverified ) else: response = await client.room_send( diff --git a/pantalaimon/store.py b/pantalaimon/store.py index 135936f..3e647f6 100644 --- a/pantalaimon/store.py +++ b/pantalaimon/store.py @@ -58,7 +58,6 @@ class MediaInfo: "mimetype": mime_type, } - return content def to_thumbnail(self, content: Dict, mime_type: str) -> Dict[Any, Any]: content["info"]["thumbnail_file"] = { @@ -70,9 +69,6 @@ class MediaInfo: "mimetype": mime_type, } - return content - - @attr.s class UploadInfo: From eabd5f5b51e4221b162ab3c8e8a6de926fa2c7af Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Fri, 28 May 2021 14:20:18 +0200 Subject: [PATCH 05/62] pantalaimon: Add a config option to drop old room keys This patch adds a config option that enables a mode wher a proxy will only keep the latest room key from a sender in a certain room. This is useful for bots that use pantalaimon since they are mostly only interested in the latest messages and don't care about room history. --- contrib/pantalaimon.conf | 1 + docs/man/pantalaimon.5 | 5 ++++ docs/man/pantalaimon.5.md | 9 ++++++- pantalaimon/config.py | 6 +++++ pantalaimon/main.py | 5 +++- pantalaimon/store.py | 49 +++++++++++++++++++++++++++++++++++++-- 6 files changed, 71 insertions(+), 4 deletions(-) diff --git a/contrib/pantalaimon.conf b/contrib/pantalaimon.conf index 69a7465..dc4cedc 100644 --- a/contrib/pantalaimon.conf +++ b/contrib/pantalaimon.conf @@ -12,3 +12,4 @@ Proxy = http://localhost:8080 SSL = False IgnoreVerification = False UseKeyring = True +DropOldKeys = False diff --git a/docs/man/pantalaimon.5 b/docs/man/pantalaimon.5 index 448ef3a..62b281e 100644 --- a/docs/man/pantalaimon.5 +++ b/docs/man/pantalaimon.5 @@ -51,6 +51,11 @@ This option configures if a proxy instance should use the OS keyring to store its own access tokens. The access tokens are required for the daemon to resume operation. If this is set to "No", access tokens are stored in the pantalaimon database in plaintext. Defaults to "Yes". +.It Cm DropOldKeys +This option configures if a proxy instance should only keep the latest version +of a room key from a certain user around. This effectively means that only newly +incoming messages will be decryptable, the proxy will be unable to decrypt the +room history. Defaults to "No". .It Cm SearchRequests This option configures if the proxy should make additional HTTP requests to the server when clients use the search API endpoint. Some data that is required to diff --git a/docs/man/pantalaimon.5.md b/docs/man/pantalaimon.5.md index fc197ec..4a78e80 100644 --- a/docs/man/pantalaimon.5.md +++ b/docs/man/pantalaimon.5.md @@ -62,6 +62,13 @@ The following keys are optional in the proxy instance sections: > operation. If this is set to "No", access tokens are stored in the pantalaimon > database in plaintext. Defaults to "Yes". +**DropOldKeys** + +> This option configures if a proxy instance should only keep the latest version +> of a room key from a certain user around. This effectively means that only newly +> incoming messages will be decryptable, the proxy will be unable to decrypt the +> room history. Defaults to "No". + Aditional to the homeserver section a special section with the name **Default** can be used to configure the following values for all homeservers: @@ -150,4 +157,4 @@ pantalaimon(8) was written by Damir Jelić <[poljar@termina.org.uk](mailto:poljar@termina.org.uk)>. -Linux 5.1.3-arch2-1-ARCH - May 8, 2019 +Linux 5.11.16-arch1-1 - May 8, 2019 diff --git a/pantalaimon/config.py b/pantalaimon/config.py index 2a01714..5a5ca4f 100644 --- a/pantalaimon/config.py +++ b/pantalaimon/config.py @@ -39,6 +39,7 @@ class PanConfigParser(configparser.ConfigParser): "IndexingBatchSize": "100", "HistoryFetchDelay": "3000", "DebugEncryption": "False", + "DropOldKeys": "False", }, converters={ "address": parse_address, @@ -121,6 +122,8 @@ class ServerConfig: the room history. history_fetch_delay (int): The delay between room history fetching requests in seconds. + drop_old_keys (bool): Should Pantalaimon only keep the most recent + decryption key around. """ name = attr.ib(type=str) @@ -137,6 +140,7 @@ class ServerConfig: index_encrypted_only = attr.ib(type=bool, default=True) indexing_batch_size = attr.ib(type=int, default=100) history_fetch_delay = attr.ib(type=int, default=3) + drop_old_keys = attr.ib(type=bool, default=False) @attr.s @@ -229,6 +233,7 @@ class PanConfig: f"already defined before." ) listen_set.add(listen_tuple) + drop_old_keys = section.getboolean("DropOldKeys") server_conf = ServerConfig( section_name, @@ -243,6 +248,7 @@ class PanConfig: index_encrypted_only, indexing_batch_size, history_fetch_delay / 1000, + drop_old_keys, ) self.servers[section_name] = server_conf diff --git a/pantalaimon/main.py b/pantalaimon/main.py index 0108cdb..3a5d067 100644 --- a/pantalaimon/main.py +++ b/pantalaimon/main.py @@ -29,6 +29,7 @@ from logbook import StderrHandler from pantalaimon.config import PanConfig, PanConfigError, parse_log_level from pantalaimon.daemon import ProxyDaemon from pantalaimon.log import logger +from pantalaimon.store import KeyDroppingSqliteStore from pantalaimon.thread_messages import DaemonResponse from pantalaimon.ui import UI_ENABLED @@ -47,6 +48,8 @@ def create_dirs(data_dir, conf_dir): async def init(data_dir, server_conf, send_queue, recv_queue): """Initialize the proxy and the http server.""" + store_class = KeyDroppingSqliteStore if server_conf.drop_old_keys else None + proxy = ProxyDaemon( server_conf.name, server_conf.homeserver, @@ -56,6 +59,7 @@ async def init(data_dir, server_conf, send_queue, recv_queue): recv_queue=recv_queue.async_q if recv_queue else None, proxy=server_conf.proxy.geturl() if server_conf.proxy else None, ssl=None if server_conf.ssl is True else False, + client_store_class=store_class, ) # 100 MB max POST size @@ -101,7 +105,6 @@ async def init(data_dir, server_conf, send_queue, recv_queue): r"/_matrix/client/r0/profile/{userId}/avatar_url", proxy.profile, ), - ] ) app.router.add_route("*", "/" + "{proxyPath:.*}", proxy.router) diff --git a/pantalaimon/store.py b/pantalaimon/store.py index 3e647f6..0d1afd5 100644 --- a/pantalaimon/store.py +++ b/pantalaimon/store.py @@ -18,10 +18,12 @@ from collections import defaultdict from typing import Any, Dict, List, Optional, Tuple import attr -from nio.crypto import TrustState +from nio.crypto import TrustState, GroupSessionStore from nio.store import ( Accounts, + MegolmInboundSessions, DeviceKeys, + SqliteStore, DeviceTrustState, use_database, use_database_atomic, @@ -29,7 +31,6 @@ from nio.store import ( from peewee import SQL, DoesNotExist, ForeignKeyField, Model, SqliteDatabase, TextField from cachetools import LRUCache - MAX_LOADED_MEDIA = 10000 MAX_LOADED_UPLOAD = 10000 @@ -452,3 +453,47 @@ class PanStore: store[account.user_id] = device_store return store + + +class KeyDroppingSqliteStore(SqliteStore): + @use_database + def save_inbound_group_session(self, session): + """Save the provided Megolm inbound group session to the database. + + Args: + session (InboundGroupSession): The session to save. + """ + account = self._get_account() + assert account + + MegolmInboundSessions.delete().where( + MegolmInboundSessions.sender_key == session.sender_key, + MegolmInboundSessions.account == account, + MegolmInboundSessions.room_id == session.room_id, + ).execute() + + super().save_inbound_group_session(session) + + @use_database + def load_inbound_group_sessions(self): + store = super().load_inbound_group_sessions() + + return KeyDroppingGroupSessionStore.from_group_session_store(store) + + +class KeyDroppingGroupSessionStore(GroupSessionStore): + def from_group_session_store(store): + new_store = KeyDroppingGroupSessionStore() + new_store._entries = store._entries + + return new_store + + def add(self, session) -> bool: + room_id = session.room_id + sender_key = session.sender_key + if session in self._entries[room_id][sender_key].values(): + return False + + self._entries[room_id][sender_key].clear() + self._entries[room_id][sender_key][session.id] = session + return True From 90cdc5545162afa28b70c5f5f2f7e8e6636b8f80 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Fri, 28 May 2021 14:30:04 +0200 Subject: [PATCH 06/62] pantalaimon: Reformat our source files using black --- pantalaimon/daemon.py | 52 +++++++++++++++++++++++++++++++++---------- pantalaimon/store.py | 13 +++++------ 2 files changed, 46 insertions(+), 19 deletions(-) diff --git a/pantalaimon/daemon.py b/pantalaimon/daemon.py index 9693c9c..a807724 100755 --- a/pantalaimon/daemon.py +++ b/pantalaimon/daemon.py @@ -85,6 +85,7 @@ CORS_HEADERS = { class NotDecryptedAvailableError(Exception): """Exception that signals that no decrypted upload is available""" + pass @@ -864,8 +865,9 @@ class ProxyDaemon: if not upload_info or not media_info: raise NotDecryptedAvailableError - response, decrypted_file = await self._load_decrypted_file(media_info.mxc_server, media_info.mxc_path, - upload_info.filename) + response, decrypted_file = await self._load_decrypted_file( + media_info.mxc_server, media_info.mxc_path, upload_info.filename + ) if response is None and decrypted_file is None: raise NotDecryptedAvailableError @@ -923,10 +925,17 @@ class ProxyDaemon: # The room isn't encrypted just forward the message. if not encrypt: content_msgtype = content.get("msgtype") - if content_msgtype in ["m.image", "m.video", "m.audio", "m.file"] or msgtype == "m.room.avatar": + if ( + content_msgtype in ["m.image", "m.video", "m.audio", "m.file"] + or msgtype == "m.room.avatar" + ): try: - content = await self._map_decrypted_uri("url", content, request, client) - return await self.forward_to_web(request, data=json.dumps(content), token=client.access_token) + content = await self._map_decrypted_uri( + "url", content, request, client + ) + return await self.forward_to_web( + request, data=json.dumps(content), token=client.access_token + ) except ClientConnectionError as e: return web.Response(status=500, text=str(e)) except (KeyError, NotDecryptedAvailableError): @@ -939,8 +948,13 @@ class ProxyDaemon: async def _send(ignore_unverified=False): try: content_msgtype = content.get("msgtype") - if content_msgtype in ["m.image", "m.video", "m.audio", "m.file"] or msgtype == "m.room.avatar": - upload_info, media_info = self._get_upload_and_media_info("url", content) + if ( + content_msgtype in ["m.image", "m.video", "m.audio", "m.file"] + or msgtype == "m.room.avatar" + ): + upload_info, media_info = self._get_upload_and_media_info( + "url", content + ) if not upload_info or not media_info: response = await client.room_send( room_id, msgtype, content, txnid, ignore_unverified @@ -1169,14 +1183,22 @@ class ProxyDaemon: body=await response.transport_response.read(), ) - self.store.save_upload(self.name, response.content_uri, file_name, content_type) + self.store.save_upload( + self.name, response.content_uri, file_name, content_type + ) mxc = urlparse(response.content_uri) mxc_server = mxc.netloc.strip("/") mxc_path = mxc.path.strip("/") logger.info(f"Adding media info for {mxc_server}/{mxc_path} to the store") - media_info = MediaInfo(mxc_server, mxc_path, maybe_keys["key"], maybe_keys["iv"], maybe_keys["hashes"]) + media_info = MediaInfo( + mxc_server, + mxc_path, + maybe_keys["key"], + maybe_keys["iv"], + maybe_keys["hashes"], + ) self.store.save_media(self.name, media_info) return web.Response( @@ -1250,8 +1272,12 @@ class ProxyDaemon: return self._not_json try: - content = await self._map_decrypted_uri("avatar_url", content, request, client) - return await self.forward_to_web(request, data=json.dumps(content), token=client.access_token) + content = await self._map_decrypted_uri( + "avatar_url", content, request, client + ) + return await self.forward_to_web( + request, data=json.dumps(content), token=client.access_token + ) except ClientConnectionError as e: return web.Response(status=500, text=str(e)) except (KeyError, NotDecryptedAvailableError): @@ -1263,7 +1289,9 @@ class ProxyDaemon: file_name = request.match_info.get("file_name") try: - response, decrypted_file = await self._load_decrypted_file(server_name, media_id, file_name) + response, decrypted_file = await self._load_decrypted_file( + server_name, media_id, file_name + ) if response is None and decrypted_file is None: return await self.forward_to_web(request) diff --git a/pantalaimon/store.py b/pantalaimon/store.py index 0d1afd5..f1c35e9 100644 --- a/pantalaimon/store.py +++ b/pantalaimon/store.py @@ -51,15 +51,14 @@ class MediaInfo: def to_content(self, content: Dict, mime_type: str) -> Dict[Any, Any]: content["file"] = { - "v": "v2", - "key": self.key, - "iv": self.iv, - "hashes": self.hashes, - "url": content["url"], - "mimetype": mime_type, + "v": "v2", + "key": self.key, + "iv": self.iv, + "hashes": self.hashes, + "url": content["url"], + "mimetype": mime_type, } - def to_thumbnail(self, content: Dict, mime_type: str) -> Dict[Any, Any]: content["info"]["thumbnail_file"] = { "v": "v2", From 2b359c22d2bd3138de17d952f685c687daca9563 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Mon, 17 May 2021 10:36:52 +0200 Subject: [PATCH 07/62] store: Split out the media cache loading logic from the load media method --- pantalaimon/daemon.py | 2 +- pantalaimon/store.py | 42 ++++++++++++++++++++++-------------------- tests/store_test.py | 4 ++-- 3 files changed, 25 insertions(+), 23 deletions(-) diff --git a/pantalaimon/daemon.py b/pantalaimon/daemon.py index a807724..b238ba7 100755 --- a/pantalaimon/daemon.py +++ b/pantalaimon/daemon.py @@ -121,7 +121,7 @@ class ProxyDaemon: self.hostname = self.homeserver.hostname self.store = PanStore(self.data_dir) accounts = self.store.load_users(self.name) - self.media_info = self.store.load_media(self.name) + self.media_info = self.store.load_media_cache(self.name) self.upload_info = self.store.load_upload(self.name) for user_id, device_id in accounts: diff --git a/pantalaimon/store.py b/pantalaimon/store.py index f1c35e9..60a36a4 100644 --- a/pantalaimon/store.py +++ b/pantalaimon/store.py @@ -254,32 +254,34 @@ class PanStore: hashes=media.hashes, ).on_conflict_ignore().execute() + @use_database + def load_media_cache(self, server): + server, _ = Servers.get_or_create(name=server) + media_cache = LRUCache(maxsize=MAX_LOADED_MEDIA) + + for i, m in enumerate(server.media): + if i > MAX_LOADED_MEDIA: + break + + media = MediaInfo(m.mxc_server, m.mxc_path, m.key, m.iv, m.hashes) + media_cache[(m.mxc_server, m.mxc_path)] = media + + return media_cache + @use_database def load_media(self, server, mxc_server=None, mxc_path=None): server, _ = Servers.get_or_create(name=server) - if not mxc_path: - media_cache = LRUCache(maxsize=MAX_LOADED_MEDIA) + m = PanMediaInfo.get_or_none( + PanMediaInfo.server == server, + PanMediaInfo.mxc_server == mxc_server, + PanMediaInfo.mxc_path == mxc_path, + ) - for i, m in enumerate(server.media): - if i > MAX_LOADED_MEDIA: - break + if not m: + return None - media = MediaInfo(m.mxc_server, m.mxc_path, m.key, m.iv, m.hashes) - media_cache[(m.mxc_server, m.mxc_path)] = media - - return media_cache - else: - m = PanMediaInfo.get_or_none( - PanMediaInfo.server == server, - PanMediaInfo.mxc_server == mxc_server, - PanMediaInfo.mxc_path == mxc_path, - ) - - if not m: - return None - - return MediaInfo(m.mxc_server, m.mxc_path, m.key, m.iv, m.hashes) + return MediaInfo(m.mxc_server, m.mxc_path, m.key, m.iv, m.hashes) @use_database_atomic def replace_fetcher_task(self, server, pan_user, old_task, new_task): diff --git a/tests/store_test.py b/tests/store_test.py index fe7411e..1d16e10 100644 --- a/tests/store_test.py +++ b/tests/store_test.py @@ -153,7 +153,7 @@ class TestClass(object): def test_media_storage(self, panstore): server_name = "test" - media_cache = panstore.load_media(server_name) + media_cache = panstore.load_media_cache(server_name) assert not media_cache event = self.encrypted_media_event @@ -171,7 +171,7 @@ class TestClass(object): panstore.save_media(server_name, media) - media_cache = panstore.load_media(server_name) + media_cache = panstore.load_media_cache(server_name) assert (mxc_server, mxc_path) in media_cache media_info = media_cache[(mxc_server, mxc_path)] From a7286dfc9fd889eb58da33e899561494bea30f5f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Thu, 3 Jun 2021 10:39:37 +0200 Subject: [PATCH 08/62] pantalaimon: Bumb the version --- CHANGELOG.md | 16 ++++++++++++++++ pantalaimon/main.py | 2 +- pantalaimon/panctl.py | 2 +- setup.py | 2 +- 4 files changed, 19 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c1dba35..7403103 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## 0.9.3 2021-05-14 +### Added + +- [[#98]] Add the ability to remove old room keys +- [[#95]] Encrypt thumbnails uploaded by a client + +### Fixed + +- [[#96]] Split out the media cache loading logic to avoid returning the + whole LRU cache when it shouldn't + +[#98]: https://github.com/matrix-org/pantalaimon/pull/98 +[#96]: https://github.com/matrix-org/pantalaimon/pull/96 +[#95]: https://github.com/matrix-org/pantalaimon/pull/95 + +## 0.9.3 2021-05-14 + ### Changed - [[#73f68c7]] Bump the allowed nio version diff --git a/pantalaimon/main.py b/pantalaimon/main.py index 3a5d067..271a706 100644 --- a/pantalaimon/main.py +++ b/pantalaimon/main.py @@ -262,7 +262,7 @@ async def daemon(context, log_level, debug_encryption, config, data_path): "connect to pantalaimon." ) ) -@click.version_option(version="0.9.3", prog_name="pantalaimon") +@click.version_option(version="0.10.0", prog_name="pantalaimon") @click.option( "--log-level", type=click.Choice(["error", "warning", "info", "debug"]), diff --git a/pantalaimon/panctl.py b/pantalaimon/panctl.py index 1b486cc..26344a1 100644 --- a/pantalaimon/panctl.py +++ b/pantalaimon/panctl.py @@ -690,7 +690,7 @@ class PanCtl: "the pantalaimon daemon." ) ) -@click.version_option(version="0.9.3", prog_name="panctl") +@click.version_option(version="0.10.0", prog_name="panctl") def main(): loop = asyncio.get_event_loop() glib_loop = GLib.MainLoop() diff --git a/setup.py b/setup.py index 011d3e4..a604a44 100644 --- a/setup.py +++ b/setup.py @@ -7,7 +7,7 @@ with open("README.md", encoding="utf-8") as f: setup( name="pantalaimon", - version="0.9.3", + version="0.10.0", url="https://github.com/matrix-org/pantalaimon", author="The Matrix.org Team", author_email="poljar@termina.org.uk", From 48fd7037727696f379205e6e60f7d7cb078da3e1 Mon Sep 17 00:00:00 2001 From: CortexPE Date: Mon, 21 Jun 2021 17:24:02 +0800 Subject: [PATCH 09/62] Patch #90 --- pantalaimon/daemon.py | 30 ++++++++++-------------------- 1 file changed, 10 insertions(+), 20 deletions(-) diff --git a/pantalaimon/daemon.py b/pantalaimon/daemon.py index b238ba7..71f474a 100755 --- a/pantalaimon/daemon.py +++ b/pantalaimon/daemon.py @@ -835,9 +835,7 @@ class ProxyDaemon: body=await response.read(), ) - def _get_upload_and_media_info(self, content_key, content): - content_uri = content[content_key] - + def _get_upload_and_media_info(self, content_uri: str): try: upload_info = self.upload_info[content_uri] except KeyError: @@ -847,7 +845,6 @@ class ProxyDaemon: self.upload_info[content_uri] = upload_info - content_uri = content[content_key] mxc = urlparse(content_uri) mxc_server = mxc.netloc.strip("/") mxc_path = mxc.path.strip("/") @@ -860,8 +857,8 @@ class ProxyDaemon: return upload_info, media_info - async def _map_decrypted_uri(self, content_key, content, request, client): - upload_info, media_info = self._get_upload_and_media_info(content_key, content) + async def _decrypt_uri(self, content_uri, client): + upload_info, media_info = self._get_upload_and_media_info(content_uri) if not upload_info or not media_info: raise NotDecryptedAvailableError @@ -877,7 +874,7 @@ class ProxyDaemon: decrypted_upload, _ = await client.upload( data_provider=BufferedReader(BytesIO(decrypted_file)), - content_type=response.content_type, + content_type=upload_info.mimetype, filename=upload_info.filename, encrypt=False, filesize=len(decrypted_file), @@ -886,9 +883,7 @@ class ProxyDaemon: if not isinstance(decrypted_upload, UploadResponse): raise NotDecryptedAvailableError - content[content_key] = decrypted_upload.content_uri - - return content + return decrypted_upload.content_uri async def send_message(self, request): access_token = self.get_access_token(request) @@ -930,9 +925,8 @@ class ProxyDaemon: or msgtype == "m.room.avatar" ): try: - content = await self._map_decrypted_uri( - "url", content, request, client - ) + content["url"] = await self._decrypt_uri(content["url"], client) + content["info"]["thumbnail_url"] = await self._decrypt_uri(content["info"]["thumbnail_url"], client) return await self.forward_to_web( request, data=json.dumps(content), token=client.access_token ) @@ -952,9 +946,7 @@ class ProxyDaemon: content_msgtype in ["m.image", "m.video", "m.audio", "m.file"] or msgtype == "m.room.avatar" ): - upload_info, media_info = self._get_upload_and_media_info( - "url", content - ) + upload_info, media_info = self._get_upload_and_media_info(content["url"]) if not upload_info or not media_info: response = await client.room_send( room_id, msgtype, content, txnid, ignore_unverified @@ -973,7 +965,7 @@ class ProxyDaemon: thumb_upload_info, thumb_media_info, ) = self._get_upload_and_media_info( - "thumbnail_url", content["info"] + content["info"]["thumbnail_url"] ) if thumb_upload_info and thumb_media_info: thumb_media_info.to_thumbnail( @@ -1272,9 +1264,7 @@ class ProxyDaemon: return self._not_json try: - content = await self._map_decrypted_uri( - "avatar_url", content, request, client - ) + content["avatar_url"] = await self._decrypt_uri(content["avatar_url"], client) return await self.forward_to_web( request, data=json.dumps(content), token=client.access_token ) From c455b37b67573531fd0f96a292d67fac32173b09 Mon Sep 17 00:00:00 2001 From: CortexPE Date: Mon, 21 Jun 2021 17:32:51 +0800 Subject: [PATCH 10/62] prevent touching thumbnail info when not needed --- pantalaimon/daemon.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pantalaimon/daemon.py b/pantalaimon/daemon.py index 71f474a..a2f5a37 100755 --- a/pantalaimon/daemon.py +++ b/pantalaimon/daemon.py @@ -926,7 +926,8 @@ class ProxyDaemon: ): try: content["url"] = await self._decrypt_uri(content["url"], client) - content["info"]["thumbnail_url"] = await self._decrypt_uri(content["info"]["thumbnail_url"], client) + if "info" in content and "thumbnail_url" in content["info"]: + content["info"]["thumbnail_url"] = await self._decrypt_uri(content["info"]["thumbnail_url"], client) return await self.forward_to_web( request, data=json.dumps(content), token=client.access_token ) From 95bf21765708d4c85257f882cfbfde2487f1e55b Mon Sep 17 00:00:00 2001 From: CortexPE Date: Fri, 2 Jul 2021 19:45:40 +0800 Subject: [PATCH 11/62] patch KeyError on sync --- pantalaimon/client.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pantalaimon/client.py b/pantalaimon/client.py index b2d2a72..76d31a2 100644 --- a/pantalaimon/client.py +++ b/pantalaimon/client.py @@ -905,7 +905,7 @@ class PanClient(AsyncClient): self.handle_to_device_from_sync_body(body) - for room_id, room_dict in body["rooms"]["join"].items(): + for room_id, room_dict in body.get("rooms", {}).get("join", {}).items(): try: if not self.rooms[room_id].encrypted: logger.info( @@ -920,7 +920,7 @@ class PanClient(AsyncClient): # pan sync stream did. Let's assume that the room is encrypted. pass - for event in room_dict["timeline"]["events"]: + for event in room_dict.get("timeline", {}).get("events", []): if "type" not in event: continue From c36aca183b1cbac7eadeac028744151196c34ef5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Tue, 6 Jul 2021 10:41:23 +0200 Subject: [PATCH 12/62] pantalaimon: Bump our version --- CHANGELOG.md | 14 +++++++++++++- pantalaimon/main.py | 2 +- pantalaimon/panctl.py | 2 +- setup.py | 2 +- 4 files changed, 16 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7403103..f3a6066 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,19 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## 0.9.3 2021-05-14 +## 0.10.1 2021-07-06 + +### Fixed + +- [[#100]] Don't require the rooms dicts in the sync response +- [[#99]] Thumbnails not generating for media uploaded in unencrypted rooms + whole LRU cache when it shouldn't + +[#100]: https://github.com/matrix-org/pantalaimon/pull/100 +[#99]: https://github.com/matrix-org/pantalaimon/pull/99 + + +## 0.10.0 2021-05-14 ### Added diff --git a/pantalaimon/main.py b/pantalaimon/main.py index 271a706..84e9429 100644 --- a/pantalaimon/main.py +++ b/pantalaimon/main.py @@ -262,7 +262,7 @@ async def daemon(context, log_level, debug_encryption, config, data_path): "connect to pantalaimon." ) ) -@click.version_option(version="0.10.0", prog_name="pantalaimon") +@click.version_option(version="0.10.1", prog_name="pantalaimon") @click.option( "--log-level", type=click.Choice(["error", "warning", "info", "debug"]), diff --git a/pantalaimon/panctl.py b/pantalaimon/panctl.py index 26344a1..7f76bf9 100644 --- a/pantalaimon/panctl.py +++ b/pantalaimon/panctl.py @@ -690,7 +690,7 @@ class PanCtl: "the pantalaimon daemon." ) ) -@click.version_option(version="0.10.0", prog_name="panctl") +@click.version_option(version="0.10.1", prog_name="panctl") def main(): loop = asyncio.get_event_loop() glib_loop = GLib.MainLoop() diff --git a/setup.py b/setup.py index a604a44..7f7d78f 100644 --- a/setup.py +++ b/setup.py @@ -7,7 +7,7 @@ with open("README.md", encoding="utf-8") as f: setup( name="pantalaimon", - version="0.10.0", + version="0.10.1", url="https://github.com/matrix-org/pantalaimon", author="The Matrix.org Team", author_email="poljar@termina.org.uk", From 340dbf2eb6d2c3f3a20f985bdd25cca0934bec78 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Wed, 14 Jul 2021 10:44:03 +0200 Subject: [PATCH 13/62] pantalaimon: Prevent the sending of messages if the client didn't sync Pantalaimon depends on the room state to be present to decide correctly if a message should be encrypted or now. The room state is fetched from the server every time we restart, this means that failure to fetch room states from the server would hinder us from doing the correct decision. This patch prevents a downgrade to sending unencrypted messages if we're unable to sync at least once with the server. --- pantalaimon/client.py | 5 ++++- pantalaimon/daemon.py | 17 ++++++++++++++++- 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/pantalaimon/client.py b/pantalaimon/client.py index 76d31a2..e0188f2 100644 --- a/pantalaimon/client.py +++ b/pantalaimon/client.py @@ -410,6 +410,10 @@ class PanClient(AsyncClient): except (asyncio.CancelledError, KeyboardInterrupt): return + @property + def has_been_synced(self) -> bool: + self.last_sync_token is not None + async def sync_tasks(self, response): if self.index: await self.index.commit_events() @@ -540,7 +544,6 @@ class PanClient(AsyncClient): timeout = 30000 sync_filter = {"room": {"state": {"lazy_load_members": True}}} next_batch = self.pan_store.load_token(self.server_name, self.user_id) - self.last_sync_token = next_batch # We don't store any room state so initial sync needs to be with the # full_state parameter. Subsequent ones are normal. diff --git a/pantalaimon/daemon.py b/pantalaimon/daemon.py index a2f5a37..bb9b8e5 100755 --- a/pantalaimon/daemon.py +++ b/pantalaimon/daemon.py @@ -902,7 +902,22 @@ class ProxyDaemon: room = client.rooms[room_id] encrypt = room.encrypted except KeyError: - return await self.forward_to_web(request, token=client.access_token) + if client.has_been_synced: + return await self.forward_to_web(request, token=client.access_token) + else: + logger.error( + "The internal Pantalaimon client did not manage " + "to sync with the server." + ) + return web.json_response( + { + "errcode": "M_UNKNOWN", + "error": "The pantalaimon client did not manage to sync with " + "the server", + }, + headers=CORS_HEADERS, + status=500, + ) # Don't encrypt reactions for now - they are weird and clients # need to support them like this. From f875499d6b0a9d968270872a4a81527517dd703e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Wed, 14 Jul 2021 11:05:02 +0200 Subject: [PATCH 14/62] pantalaimon: Fix some formatting issues --- pantalaimon/daemon.py | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/pantalaimon/daemon.py b/pantalaimon/daemon.py index bb9b8e5..bdba6a8 100755 --- a/pantalaimon/daemon.py +++ b/pantalaimon/daemon.py @@ -942,7 +942,9 @@ class ProxyDaemon: try: content["url"] = await self._decrypt_uri(content["url"], client) if "info" in content and "thumbnail_url" in content["info"]: - content["info"]["thumbnail_url"] = await self._decrypt_uri(content["info"]["thumbnail_url"], client) + content["info"]["thumbnail_url"] = await self._decrypt_uri( + content["info"]["thumbnail_url"], client + ) return await self.forward_to_web( request, data=json.dumps(content), token=client.access_token ) @@ -962,7 +964,9 @@ class ProxyDaemon: content_msgtype in ["m.image", "m.video", "m.audio", "m.file"] or msgtype == "m.room.avatar" ): - upload_info, media_info = self._get_upload_and_media_info(content["url"]) + upload_info, media_info = self._get_upload_and_media_info( + content["url"] + ) if not upload_info or not media_info: response = await client.room_send( room_id, msgtype, content, txnid, ignore_unverified @@ -1280,7 +1284,9 @@ class ProxyDaemon: return self._not_json try: - content["avatar_url"] = await self._decrypt_uri(content["avatar_url"], client) + content["avatar_url"] = await self._decrypt_uri( + content["avatar_url"], client + ) return await self.forward_to_web( request, data=json.dumps(content), token=client.access_token ) From a9f6ad2c7e08c72e8274a6bdf2954edf1c2d6b15 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Wed, 14 Jul 2021 12:25:39 +0200 Subject: [PATCH 15/62] pantalaimon: Don't forward messages if we think the room isn't joined --- pantalaimon/daemon.py | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/pantalaimon/daemon.py b/pantalaimon/daemon.py index bdba6a8..bbec91a 100755 --- a/pantalaimon/daemon.py +++ b/pantalaimon/daemon.py @@ -897,13 +897,22 @@ class ProxyDaemon: room_id = request.match_info["room_id"] - # The room is not in the joined rooms list, just forward it. try: room = client.rooms[room_id] encrypt = room.encrypted except KeyError: + # The room is not in the joined rooms list, either the pan client + # didn't manage to sync the state or we're not joined, in either + # case send an error response. if client.has_been_synced: - return await self.forward_to_web(request, token=client.access_token) + return web.json_response( + { + "errcode": "M_FORBIDDEN", + "error": "You do not have permission to send the event." + }, + headers=CORS_HEADERS, + status=403, + ) else: logger.error( "The internal Pantalaimon client did not manage " From e3be7bee3be0ceeae07b067ec4c90f5849b9763f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Wed, 14 Jul 2021 13:48:16 +0200 Subject: [PATCH 16/62] pantalaimon: Bump our version --- CHANGELOG.md | 9 +++++++++ pantalaimon/main.py | 2 +- pantalaimon/panctl.py | 2 +- setup.py | 4 ++-- 4 files changed, 13 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f3a6066..c0dda50 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,15 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## 0.10.2 2021-07-14 + +### Fixed + +- [[#103]] Prevent E2EE downgrade on failed syncs + +[#103]: https://github.com/matrix-org/pantalaimon/pull/103 + + ## 0.10.1 2021-07-06 ### Fixed diff --git a/pantalaimon/main.py b/pantalaimon/main.py index 84e9429..fe5e167 100644 --- a/pantalaimon/main.py +++ b/pantalaimon/main.py @@ -262,7 +262,7 @@ async def daemon(context, log_level, debug_encryption, config, data_path): "connect to pantalaimon." ) ) -@click.version_option(version="0.10.1", prog_name="pantalaimon") +@click.version_option(version="0.10.2", prog_name="pantalaimon") @click.option( "--log-level", type=click.Choice(["error", "warning", "info", "debug"]), diff --git a/pantalaimon/panctl.py b/pantalaimon/panctl.py index 7f76bf9..fdb9921 100644 --- a/pantalaimon/panctl.py +++ b/pantalaimon/panctl.py @@ -690,7 +690,7 @@ class PanCtl: "the pantalaimon daemon." ) ) -@click.version_option(version="0.10.1", prog_name="panctl") +@click.version_option(version="0.10.2", prog_name="panctl") def main(): loop = asyncio.get_event_loop() glib_loop = GLib.MainLoop() diff --git a/setup.py b/setup.py index 7f7d78f..b13317a 100644 --- a/setup.py +++ b/setup.py @@ -7,7 +7,7 @@ with open("README.md", encoding="utf-8") as f: setup( name="pantalaimon", - version="0.10.1", + version="0.10.2", url="https://github.com/matrix-org/pantalaimon", author="The Matrix.org Team", author_email="poljar@termina.org.uk", @@ -29,7 +29,7 @@ setup( "cachetools >= 3.0.0", "prompt_toolkit > 2, < 4", "typing;python_version<'3.5'", - "matrix-nio[e2e] >= 0.14, < 0.19" + "matrix-nio[e2e] >= 0.18, < 0.19" ], extras_require={ "ui": [ From 054a3bcb0b39a33553a9898153443056dc1832fd Mon Sep 17 00:00:00 2001 From: "Jan Alexander Steffens (heftig)" Date: Thu, 26 Aug 2021 20:29:53 +0200 Subject: [PATCH 17/62] pantalaimon: Forward raw path instead of quoting the decoded path If the original path had quoted slash characters (`%2F`), the code decoded them and then left them unquoted, causing the forwarded request to fail. An example is trying to ban a user with a slash in their name using Mjolnir, which PUTs a state event with `rule:` in the URL. Use the undecoded path to avoid this. --- pantalaimon/daemon.py | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/pantalaimon/daemon.py b/pantalaimon/daemon.py index bbec91a..ffe0f57 100755 --- a/pantalaimon/daemon.py +++ b/pantalaimon/daemon.py @@ -482,9 +482,7 @@ class ProxyDaemon: assert session - path = urllib.parse.quote( - request.path - ) # re-encode path stuff like room aliases + path = request.raw_path method = request.method headers = CIMultiDict(request.headers) From ed7aa55ef0eeac9112c6902a86823c218ef40ee2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Thu, 2 Sep 2021 11:42:50 +0200 Subject: [PATCH 18/62] pantalaimon: Bump our version --- CHANGELOG.md | 10 ++++++++++ pantalaimon/panctl.py | 2 +- setup.py | 2 +- 3 files changed, 12 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c0dda50..1c4dfcb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,16 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## 0.10.3 2021-09-02 + +### Fixed + +- [[#105]] Use the raw_path when forwarding requests, avoiding URL + decoding/encoding issues. + +[#105]: https://github.com/matrix-org/pantalaimon/pull/105 + + ## 0.10.2 2021-07-14 ### Fixed diff --git a/pantalaimon/panctl.py b/pantalaimon/panctl.py index fdb9921..f418099 100644 --- a/pantalaimon/panctl.py +++ b/pantalaimon/panctl.py @@ -690,7 +690,7 @@ class PanCtl: "the pantalaimon daemon." ) ) -@click.version_option(version="0.10.2", prog_name="panctl") +@click.version_option(version="0.10.3", prog_name="panctl") def main(): loop = asyncio.get_event_loop() glib_loop = GLib.MainLoop() diff --git a/setup.py b/setup.py index b13317a..0eda577 100644 --- a/setup.py +++ b/setup.py @@ -7,7 +7,7 @@ with open("README.md", encoding="utf-8") as f: setup( name="pantalaimon", - version="0.10.2", + version="0.10.3", url="https://github.com/matrix-org/pantalaimon", author="The Matrix.org Team", author_email="poljar@termina.org.uk", From cd36ca68d5edb2d33f5a015ab04d8be4bf037912 Mon Sep 17 00:00:00 2001 From: Andrea Spacca Date: Sat, 4 Sep 2021 13:13:50 +0200 Subject: [PATCH 19/62] thumbnail_url can be None --- pantalaimon/daemon.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/pantalaimon/daemon.py b/pantalaimon/daemon.py index ffe0f57..d080bfb 100755 --- a/pantalaimon/daemon.py +++ b/pantalaimon/daemon.py @@ -948,7 +948,10 @@ class ProxyDaemon: ): try: content["url"] = await self._decrypt_uri(content["url"], client) - if "info" in content and "thumbnail_url" in content["info"]: + if ( + "info" in content and "thumbnail_url" in content["info"] + and not content["info"]["thumbnail_url"] == None + ): content["info"]["thumbnail_url"] = await self._decrypt_uri( content["info"]["thumbnail_url"], client ) From e5fb0b7f17c16ede41b87a5cb3feaf2fd7c95935 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Wed, 2 Feb 2022 14:59:40 +0100 Subject: [PATCH 20/62] ci: Enable github CI --- .github/workflows/ci.yml | 45 ++++++++++++++++++++++++++++++++++++++++ tox.ini | 13 +++--------- 2 files changed, 48 insertions(+), 10 deletions(-) create mode 100644 .github/workflows/ci.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..4872347 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,45 @@ +name: Build Status + +on: [push, pull_request] + +jobs: + build: + + runs-on: ubuntu-latest + strategy: + matrix: + python-version: ['3.8', '3.9', '3.10'] + + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python-version }} + - name: Install Tox and any other packages + run: | + wget https://gitlab.matrix.org/matrix-org/olm/-/archive/master/olm-master.tar.bz2 + tar -xvf olm-master.tar.bz2 + pushd olm-master && make && sudo make PREFIX="/usr" install && popd + rm -r olm-master + pip install tox + - name: Run Tox + run: tox -e py + + coverage: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + - name: Setup Python + uses: actions/setup-python@v2 + with: + python-version: "3.10" + - name: Install Tox and any other packages + run: | + wget https://gitlab.matrix.org/matrix-org/olm/-/archive/master/olm-master.tar.bz2 + tar -xvf olm-master.tar.bz2 + pushd olm-master && make && sudo make PREFIX="/usr" install && popd + rm -r olm-master + pip install tox + - name: Run Tox + run: tox -e coverage diff --git a/tox.ini b/tox.ini index 2fb9dd8..c3a2630 100644 --- a/tox.ini +++ b/tox.ini @@ -1,21 +1,14 @@ -# content of: tox.ini , put in same dir as setup.py [tox] -envlist = py38,py39,coverage -[testenv] -basepython = - py38: python3.8 - py39: python3.9 - py3: python3.9 +envlist = coverage +[testenv] deps = -rtest-requirements.txt install_command = pip install {opts} {packages} -passenv = TOXENV CI TRAVIS TRAVIS_* +passenv = TOXENV CI commands = pytest -usedevelop = True [testenv:coverage] -basepython = python3.9 commands = pytest --cov=pantalaimon --cov-report term-missing coverage xml From c89e87c22af991d07327d710d9862c5521c739b6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Wed, 2 Feb 2022 14:41:18 +0100 Subject: [PATCH 21/62] fix(daemon): Don't use the raw path if we need to sanitize filters Using the raw path sabotages the filter sanitization. --- pantalaimon/daemon.py | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/pantalaimon/daemon.py b/pantalaimon/daemon.py index d080bfb..68cbb97 100755 --- a/pantalaimon/daemon.py +++ b/pantalaimon/daemon.py @@ -460,6 +460,7 @@ class ProxyDaemon: data=None, # type: bytes session=None, # type: aiohttp.ClientSession token=None, # type: str + use_raw_path=True, # type: bool ): # type: (...) -> aiohttp.ClientResponse """Forward the given request to our configured homeserver. @@ -474,6 +475,10 @@ class ProxyDaemon: should be used to forward the request. token (str, optional): The access token that should be used for the request. + use_raw_path (str, optional): Should the raw path be used from the + request or should we use the path and re-encode it. Some may need + their filters to be sanitized, this requires the parsed version of + the path, otherise we leave the path as is. """ if not session: if not self.default_session: @@ -482,7 +487,7 @@ class ProxyDaemon: assert session - path = request.raw_path + path = request.raw_path if use_raw_path else urllib.parse.quote(request.path) method = request.method headers = CIMultiDict(request.headers) @@ -761,7 +766,7 @@ class ProxyDaemon: try: response = await self.forward_request( - request, params=query, token=client.access_token + request, params=query, token=client.access_token, use_raw_path=False ) except ClientConnectionError as e: return web.Response(status=500, text=str(e)) @@ -809,7 +814,9 @@ class ProxyDaemon: query["filter"] = request_filter try: - response = await self.forward_request(request, params=query) + response = await self.forward_request( + request, params=query, use_raw_path=False + ) except ClientConnectionError as e: return web.Response(status=500, text=str(e)) From e62cfe068aa32408a7eb78a95aa1764b6f432011 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Wed, 2 Feb 2022 14:44:49 +0100 Subject: [PATCH 22/62] fix(daemon): Don't use strip to filter Bearer from auth header Using strip might remove more than what is intended here. --- pantalaimon/daemon.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/pantalaimon/daemon.py b/pantalaimon/daemon.py index 68cbb97..f8fa159 100755 --- a/pantalaimon/daemon.py +++ b/pantalaimon/daemon.py @@ -418,7 +418,9 @@ class ProxyDaemon: access_token = request.query.get("access_token", "") if not access_token: - access_token = request.headers.get("Authorization", "").strip("Bearer ") + access_token = request.headers.get("Authorization", "").replace( + "Bearer ", "", 1 + ) return access_token From 3dd80517070b1817c0e60553e177f2ab0096f319 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Wed, 2 Feb 2022 14:43:30 +0100 Subject: [PATCH 23/62] chore: Style fixes --- pantalaimon/daemon.py | 7 ++++--- pantalaimon/index.py | 1 - pantalaimon/main.py | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/pantalaimon/daemon.py b/pantalaimon/daemon.py index f8fa159..aec62ea 100755 --- a/pantalaimon/daemon.py +++ b/pantalaimon/daemon.py @@ -915,7 +915,7 @@ class ProxyDaemon: return web.json_response( { "errcode": "M_FORBIDDEN", - "error": "You do not have permission to send the event." + "error": "You do not have permission to send the event.", }, headers=CORS_HEADERS, status=403, @@ -958,8 +958,9 @@ class ProxyDaemon: try: content["url"] = await self._decrypt_uri(content["url"], client) if ( - "info" in content and "thumbnail_url" in content["info"] - and not content["info"]["thumbnail_url"] == None + "info" in content + and "thumbnail_url" in content["info"] + and content["info"]["thumbnail_url"] is not None ): content["info"]["thumbnail_url"] = await self._decrypt_uri( content["info"]["thumbnail_url"], client diff --git a/pantalaimon/index.py b/pantalaimon/index.py index 5c8e02b..7350e58 100644 --- a/pantalaimon/index.py +++ b/pantalaimon/index.py @@ -501,6 +501,5 @@ if False: return search_result - else: INDEXING_ENABLED = False diff --git a/pantalaimon/main.py b/pantalaimon/main.py index fe5e167..2f25f64 100644 --- a/pantalaimon/main.py +++ b/pantalaimon/main.py @@ -63,7 +63,7 @@ async def init(data_dir, server_conf, send_queue, recv_queue): ) # 100 MB max POST size - app = web.Application(client_max_size=1024 ** 2 * 100) + app = web.Application(client_max_size=1024**2 * 100) app.add_routes( [ From 86060a2f7561d40bd142c8bc1847e151c3d40dff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Thu, 3 Feb 2022 11:42:37 +0100 Subject: [PATCH 24/62] fix(panctl): Allow GLib to be imported from pgi Some distributions seem to have renamed the gi module to pgi, try to import GLib from pgi if importing from gi fails. --- pantalaimon/panctl.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/pantalaimon/panctl.py b/pantalaimon/panctl.py index f418099..db7869f 100644 --- a/pantalaimon/panctl.py +++ b/pantalaimon/panctl.py @@ -23,7 +23,12 @@ from typing import List import attr import click -from gi.repository import GLib + +try: + from gi.repository import GLib +except ModuleNotFoundError: + from pgi.repository import GLib + from prompt_toolkit import __version__ as ptk_version from prompt_toolkit import HTML, PromptSession, print_formatted_text from prompt_toolkit.completion import Completer, Completion, PathCompleter From 82fcbf8e855fbe99cda05ff5128a5fbb9e58a2e0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Thu, 3 Feb 2022 11:45:07 +0100 Subject: [PATCH 25/62] fix(pancl): Ensure that we create a event loop at the start --- pantalaimon/panctl.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pantalaimon/panctl.py b/pantalaimon/panctl.py index db7869f..7ae82a6 100644 --- a/pantalaimon/panctl.py +++ b/pantalaimon/panctl.py @@ -697,7 +697,7 @@ class PanCtl: ) @click.version_option(version="0.10.3", prog_name="panctl") def main(): - loop = asyncio.get_event_loop() + loop = asyncio.new_event_loop() glib_loop = GLib.MainLoop() try: From 85c7b685e5c48a43ad74876edd6d7973fa7883ed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Fri, 4 Feb 2022 15:15:45 +0100 Subject: [PATCH 26/62] Bump our version --- CHANGELOG.md | 13 +++++++++++++ pantalaimon/main.py | 2 +- pantalaimon/panctl.py | 2 +- setup.py | 4 ++-- 4 files changed, 17 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1c4dfcb..168f740 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,19 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## 0.10.4 2022-02-04 + +### Fixed + +- [[#122]] Fix the GLib import for panctl on some distributions +- [[#120]] Don't use strip to filter Bearer from the auth header +- [[#118]] Don't use the raw path if we need to sanitize filters, fixing room + history fetching for Fractal + +[#122]: https://github.com/matrix-org/pantalaimon/pull/122 +[#120]: https://github.com/matrix-org/pantalaimon/pull/120 +[#118]: https://github.com/matrix-org/pantalaimon/pull/118 + ## 0.10.3 2021-09-02 ### Fixed diff --git a/pantalaimon/main.py b/pantalaimon/main.py index 2f25f64..8ffb6ed 100644 --- a/pantalaimon/main.py +++ b/pantalaimon/main.py @@ -262,7 +262,7 @@ async def daemon(context, log_level, debug_encryption, config, data_path): "connect to pantalaimon." ) ) -@click.version_option(version="0.10.2", prog_name="pantalaimon") +@click.version_option(version="0.10.4", prog_name="pantalaimon") @click.option( "--log-level", type=click.Choice(["error", "warning", "info", "debug"]), diff --git a/pantalaimon/panctl.py b/pantalaimon/panctl.py index 7ae82a6..8652a4c 100644 --- a/pantalaimon/panctl.py +++ b/pantalaimon/panctl.py @@ -695,7 +695,7 @@ class PanCtl: "the pantalaimon daemon." ) ) -@click.version_option(version="0.10.3", prog_name="panctl") +@click.version_option(version="0.10.4", prog_name="panctl") def main(): loop = asyncio.new_event_loop() glib_loop = GLib.MainLoop() diff --git a/setup.py b/setup.py index 0eda577..5495f67 100644 --- a/setup.py +++ b/setup.py @@ -7,7 +7,7 @@ with open("README.md", encoding="utf-8") as f: setup( name="pantalaimon", - version="0.10.3", + version="0.10.4", url="https://github.com/matrix-org/pantalaimon", author="The Matrix.org Team", author_email="poljar@termina.org.uk", @@ -29,7 +29,7 @@ setup( "cachetools >= 3.0.0", "prompt_toolkit > 2, < 4", "typing;python_version<'3.5'", - "matrix-nio[e2e] >= 0.18, < 0.19" + "matrix-nio[e2e] >= 0.18, < 0.20" ], extras_require={ "ui": [ From eb4f3b54b4a4df807ea069aba2085362e05a05a6 Mon Sep 17 00:00:00 2001 From: Kim Brose Date: Tue, 5 Apr 2022 13:27:00 +0200 Subject: [PATCH 27/62] clarify wording in README#Usage --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index af1563b..39056c0 100644 --- a/README.md +++ b/README.md @@ -96,7 +96,7 @@ IgnoreVerification = True Usage ===== -While pantalaimon is a daemon, it is meant to be run as your own user. It won't +While pantalaimon is a daemon, it is meant to be run as the same user as the app it is proxying for. It won't verify devices for you automatically, unless configured to do so, and requires user interaction to verify, ignore or blacklist devices. A more complete description of Pantalaimon can be found in the [man page](docs/man/pantalaimon.8.md). From 109ceed0bb53b07c9c1b4ff94e806b044f397b8d Mon Sep 17 00:00:00 2001 From: Alfonso Montero Date: Fri, 29 Apr 2022 12:20:37 +0000 Subject: [PATCH 28/62] Readme: add alternate Docker build method --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index af1563b..3ddb32b 100644 --- a/README.md +++ b/README.md @@ -77,6 +77,10 @@ docker build -t pantalaimon . # volume below is for where Pantalaimon should dump some data. docker run -it --rm -v /path/to/pantalaimon/dir:/data -p 8008:8008 pantalaimon ``` +The Docker image in the above example can alternatively be built straight from any branch or tag without the need to clone the repo, just by using this syntax: +```bash +docker build -t pantalaimon github.com/matrix-org/pantalaimon#master +``` An example `pantalaimon.conf` for Docker is: ```conf From 2883df45c061ca2830818f0a2c153c0a1f405564 Mon Sep 17 00:00:00 2001 From: Christian Paul Date: Mon, 5 Sep 2022 11:09:19 +0200 Subject: [PATCH 29/62] Update pantalaimon.8.md: it's own -> its own --- docs/man/pantalaimon.8.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/man/pantalaimon.8.md b/docs/man/pantalaimon.8.md index 431d5a4..004e5f2 100644 --- a/docs/man/pantalaimon.8.md +++ b/docs/man/pantalaimon.8.md @@ -24,7 +24,7 @@ behalf of the client. is supposed to run as your own user and listen to connections on a non-privileged port. A client needs to log in using the standard Matrix HTTP calls to register itself to the daemon, such a registered user is called a pan -user and will have it's own sync loop to keep up with the server. Multiple matrix +user and will have its own sync loop to keep up with the server. Multiple matrix clients can connect and use the same pan user. If user interaction is required From 6b7b87bb6a0f4cd341e2b9ae0d5d94c7aa317dd5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Tue, 24 May 2022 15:05:58 +0200 Subject: [PATCH 30/62] fix(daemon): Make sure the token variable is declared --- pantalaimon/daemon.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/pantalaimon/daemon.py b/pantalaimon/daemon.py index aec62ea..e9704d1 100755 --- a/pantalaimon/daemon.py +++ b/pantalaimon/daemon.py @@ -125,6 +125,8 @@ class ProxyDaemon: self.upload_info = self.store.load_upload(self.name) for user_id, device_id in accounts: + token = None + if self.conf.keyring: try: token = keyring.get_password( From 4254a5d9d50183a37df28e93d0a2d3fd63ceb33e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Mon, 12 Sep 2022 13:44:23 +0200 Subject: [PATCH 31/62] feat(daemon): Proxy the v3 endpoints as well --- pantalaimon/main.py | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/pantalaimon/main.py b/pantalaimon/main.py index 8ffb6ed..3002ee1 100644 --- a/pantalaimon/main.py +++ b/pantalaimon/main.py @@ -68,28 +68,45 @@ async def init(data_dir, server_conf, send_queue, recv_queue): app.add_routes( [ web.post("/_matrix/client/r0/login", proxy.login), + web.post("/_matrix/client/v3/login", proxy.login), web.get("/_matrix/client/r0/sync", proxy.sync), + web.get("/_matrix/client/v3/sync", proxy.sync), web.get("/_matrix/client/r0/rooms/{room_id}/messages", proxy.messages), + web.get("/_matrix/client/v3/rooms/{room_id}/messages", proxy.messages), web.put( r"/_matrix/client/r0/rooms/{room_id}/send/{event_type}/{txnid}", proxy.send_message, ), + web.put( + r"/_matrix/client/v3/rooms/{room_id}/send/{event_type}/{txnid}", + proxy.send_message, + ), web.post( r"/_matrix/client/r0/rooms/{room_id}/send/{event_type}", proxy.send_message, ), web.post("/_matrix/client/r0/user/{user_id}/filter", proxy.filter), + web.post("/_matrix/client/v3/user/{user_id}/filter", proxy.filter), web.post("/.well-known/matrix/client", proxy.well_known), web.get("/.well-known/matrix/client", proxy.well_known), web.post("/_matrix/client/r0/search", proxy.search), + web.post("/_matrix/client/v3/search", proxy.search), web.options("/_matrix/client/r0/search", proxy.search_opts), + web.options("/_matrix/client/v3/search", proxy.search_opts), web.get( "/_matrix/media/v1/download/{server_name}/{media_id}", proxy.download ), + web.get( + "/_matrix/media/v3/download/{server_name}/{media_id}", proxy.download + ), web.get( "/_matrix/media/v1/download/{server_name}/{media_id}/{file_name}", proxy.download, ), + web.get( + "/_matrix/media/v3/download/{server_name}/{media_id}/{file_name}", + proxy.download, + ), web.get( "/_matrix/media/r0/download/{server_name}/{media_id}", proxy.download ), @@ -101,10 +118,18 @@ async def init(data_dir, server_conf, send_queue, recv_queue): r"/_matrix/media/r0/upload", proxy.upload, ), + web.post( + r"/_matrix/media/v3/upload", + proxy.upload, + ), web.put( r"/_matrix/client/r0/profile/{userId}/avatar_url", proxy.profile, ), + web.put( + r"/_matrix/client/v3/profile/{userId}/avatar_url", + proxy.profile, + ), ] ) app.router.add_route("*", "/" + "{proxyPath:.*}", proxy.router) From 64a3fb0a48ad6659a28dc9773f95f5e80abd8989 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Wed, 28 Sep 2022 16:32:39 +0200 Subject: [PATCH 32/62] chore: Fix a bunch of typos --- README.md | 2 +- docs/man/panctl.1 | 2 +- docs/man/panctl.md | 2 +- docs/man/pantalaimon.5 | 2 +- docs/man/pantalaimon.5.md | 2 +- pantalaimon/client.py | 4 ++-- pantalaimon/config.py | 4 ++-- pantalaimon/daemon.py | 20 ++++++++++---------- pantalaimon/panctl.py | 2 +- pantalaimon/ui.py | 36 ++++++++++++++++++------------------ tests/pan_client_test.py | 8 ++++---- 11 files changed, 42 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index 9f6b174..47916d8 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ Pantalaimon can also be found on pypi: pip install pantalaimon -Pantalaimon contains a dbus based UI that can be used to controll the daemon. +Pantalaimon contains a dbus based UI that can be used to control the daemon. The dbus based UI is completely optional and needs to be installed with the daemon: diff --git a/docs/man/panctl.1 b/docs/man/panctl.1 index e1ebb8e..705dd97 100644 --- a/docs/man/panctl.1 +++ b/docs/man/panctl.1 @@ -51,7 +51,7 @@ The message will be sent away after all devices are marked as ignored. In contrast to the .Cm send-anyways command this command cancels the sending of a message to an encrypted room with -unverified devices and gives the user the oportunity to verify or blacklist +unverified devices and gives the user the opportunity to verify or blacklist devices as they see fit. .It Cm import-keys Ar pan-user Ar file Ar passphrase Import end-to-end encryption keys from the given file for the given pan-user. diff --git a/docs/man/panctl.md b/docs/man/panctl.md index ed733f5..30fa8f4 100644 --- a/docs/man/panctl.md +++ b/docs/man/panctl.md @@ -74,7 +74,7 @@ are as follows: > In contrast to the > **send-anyways** > command this command cancels the sending of a message to an encrypted room with -> unverified devices and gives the user the oportunity to verify or blacklist +> unverified devices and gives the user the opportunity to verify or blacklist > devices as they see fit. **import-keys** *pan-user* *file* *passphrase* diff --git a/docs/man/pantalaimon.5 b/docs/man/pantalaimon.5 index 62b281e..01fd2d1 100644 --- a/docs/man/pantalaimon.5 +++ b/docs/man/pantalaimon.5 @@ -86,7 +86,7 @@ The amount of time to wait between room message history requests to the Homeserver in ms. Defaults to 3000. .El .Pp -Aditional to the homeserver section a special section with the name +Additional to the homeserver section a special section with the name .Cm Default can be used to configure the following values for all homeservers: .Cm ListenAddress , diff --git a/docs/man/pantalaimon.5.md b/docs/man/pantalaimon.5.md index 4a78e80..60be6f8 100644 --- a/docs/man/pantalaimon.5.md +++ b/docs/man/pantalaimon.5.md @@ -69,7 +69,7 @@ The following keys are optional in the proxy instance sections: > incoming messages will be decryptable, the proxy will be unable to decrypt the > room history. Defaults to "No". -Aditional to the homeserver section a special section with the name +Additional to the homeserver section a special section with the name **Default** can be used to configure the following values for all homeservers: **ListenAddress**, diff --git a/pantalaimon/client.py b/pantalaimon/client.py index e0188f2..5b4ce05 100644 --- a/pantalaimon/client.py +++ b/pantalaimon/client.py @@ -735,7 +735,7 @@ class PanClient(AsyncClient): pass response = ( - f"Succesfully continued the key requests from " + f"Successfully continued the key requests from " f"{message.user_id} via {message.device_id}" ) ret = "m.ok" @@ -760,7 +760,7 @@ class PanClient(AsyncClient): if cancelled: response = ( - f"Succesfully cancelled key requests from " + f"Successfully cancelled key requests from " f"{message.user_id} via {message.device_id}" ) ret = "m.ok" diff --git a/pantalaimon/config.py b/pantalaimon/config.py index 5a5ca4f..8ee51d2 100644 --- a/pantalaimon/config.py +++ b/pantalaimon/config.py @@ -31,7 +31,7 @@ class PanConfigParser(configparser.ConfigParser): "IgnoreVerification": "False", "ListenAddress": "localhost", "ListenPort": "8009", - "LogLevel": "warnig", + "LogLevel": "warning", "Notifications": "on", "UseKeyring": "yes", "SearchRequests": "off", @@ -113,7 +113,7 @@ class ServerConfig: E2E encrypted messages. keyring (bool): Enable or disable the OS keyring for the storage of access tokens. - search_requests (bool): Enable or disable aditional Homeserver requests + search_requests (bool): Enable or disable additional Homeserver requests for the search API endpoint. index_encrypted_only (bool): Enable or disable message indexing fro non-encrypted rooms. diff --git a/pantalaimon/daemon.py b/pantalaimon/daemon.py index e9704d1..3264cab 100755 --- a/pantalaimon/daemon.py +++ b/pantalaimon/daemon.py @@ -227,7 +227,7 @@ class ProxyDaemon: if ret: msg = ( - f"Device {device.id} of user " f"{device.user_id} succesfully verified." + f"Device {device.id} of user " f"{device.user_id} successfully verified." ) await client.send_update_device(device) else: @@ -242,7 +242,7 @@ class ProxyDaemon: if ret: msg = ( f"Device {device.id} of user " - f"{device.user_id} succesfully unverified." + f"{device.user_id} successfully unverified." ) await client.send_update_device(device) else: @@ -257,7 +257,7 @@ class ProxyDaemon: if ret: msg = ( f"Device {device.id} of user " - f"{device.user_id} succesfully blacklisted." + f"{device.user_id} successfully blacklisted." ) await client.send_update_device(device) else: @@ -274,7 +274,7 @@ class ProxyDaemon: if ret: msg = ( f"Device {device.id} of user " - f"{device.user_id} succesfully unblacklisted." + f"{device.user_id} successfully unblacklisted." ) await client.send_update_device(device) else: @@ -358,7 +358,7 @@ class ProxyDaemon: else: info_msg = ( - f"Succesfully exported keys for {client.user_id} " f"to {path}" + f"Successfully exported keys for {client.user_id} " f"to {path}" ) logger.info(info_msg) await self.send_response( @@ -381,7 +381,7 @@ class ProxyDaemon: ) else: info_msg = ( - f"Succesfully imported keys for {client.user_id} " f"from {path}" + f"Successfully imported keys for {client.user_id} " f"from {path}" ) logger.info(info_msg) await self.send_response( @@ -482,7 +482,7 @@ class ProxyDaemon: use_raw_path (str, optional): Should the raw path be used from the request or should we use the path and re-encode it. Some may need their filters to be sanitized, this requires the parsed version of - the path, otherise we leave the path as is. + the path, otherwise we leave the path as is. """ if not session: if not self.default_session: @@ -616,7 +616,7 @@ class ProxyDaemon: await pan_client.close() return - logger.info(f"Succesfully started new background sync client for " f"{user_id}") + logger.info(f"Successfully started new background sync client for " f"{user_id}") await self.send_ui_message( UpdateUsersMessage(self.name, user_id, pan_client.device_id) @@ -682,7 +682,7 @@ class ProxyDaemon: if user_id and access_token: logger.info( - f"User: {user} succesfully logged in, starting " + f"User: {user} successfully logged in, starting " f"a background sync client." ) await self.start_pan_client( @@ -1033,7 +1033,7 @@ class ProxyDaemon: except SendRetryError as e: return web.Response(status=503, text=str(e)) - # Aquire a semaphore here so we only send out one + # Acquire a semaphore here so we only send out one # UnverifiedDevicesSignal sem = client.send_semaphores[room_id] diff --git a/pantalaimon/panctl.py b/pantalaimon/panctl.py index 8652a4c..088bcaa 100644 --- a/pantalaimon/panctl.py +++ b/pantalaimon/panctl.py @@ -464,7 +464,7 @@ class PanCtl: def sas_done(self, pan_user, user_id, device_id, _): print( f"Device {device_id} of user {user_id}" - f" succesfully verified for pan user {pan_user}." + f" successfully verified for pan user {pan_user}." ) def show_sas_invite(self, pan_user, user_id, device_id, _): diff --git a/pantalaimon/ui.py b/pantalaimon/ui.py index cedca65..813b67e 100644 --- a/pantalaimon/ui.py +++ b/pantalaimon/ui.py @@ -470,14 +470,14 @@ if UI_ENABLED: self.bus.publish("org.pantalaimon1", self.control_if, self.device_if) def unverified_notification(self, message): - notificaton = notify2.Notification( + notification = notify2.Notification( "Unverified devices.", message=( f"There are unverified devices in the room " f"{message.room_display_name}." ), ) - notificaton.set_category("im") + notification.set_category("im") def send_cb(notification, action_key, user_data): message = user_data @@ -488,20 +488,20 @@ if UI_ENABLED: self.control_if.CancelSending(message.pan_user, message.room_id) if "actions" in notify2.get_server_caps(): - notificaton.add_action("send", "Send anyways", send_cb, message) - notificaton.add_action("cancel", "Cancel sending", cancel_cb, message) + notification.add_action("send", "Send anyways", send_cb, message) + notification.add_action("cancel", "Cancel sending", cancel_cb, message) - notificaton.show() + notification.show() def sas_invite_notification(self, message): - notificaton = notify2.Notification( + notification = notify2.Notification( "Key verification invite", message=( f"{message.user_id} via {message.device_id} has started " f"a key verification process." ), ) - notificaton.set_category("im") + notification.set_category("im") def accept_cb(notification, action_key, user_data): message = user_data @@ -516,17 +516,17 @@ if UI_ENABLED: ) if "actions" in notify2.get_server_caps(): - notificaton.add_action("accept", "Accept", accept_cb, message) - notificaton.add_action("cancel", "Cancel", cancel_cb, message) + notification.add_action("accept", "Accept", accept_cb, message) + notification.add_action("cancel", "Cancel", cancel_cb, message) - notificaton.show() + notification.show() def sas_show_notification(self, message): emojis = [x[0] for x in message.emoji] emoji_str = " ".join(emojis) - notificaton = notify2.Notification( + notification = notify2.Notification( "Short authentication string", message=( f"Short authentication string for the key verification of" @@ -534,7 +534,7 @@ if UI_ENABLED: f"{emoji_str}" ), ) - notificaton.set_category("im") + notification.set_category("im") def confirm_cb(notification, action_key, user_data): message = user_data @@ -549,21 +549,21 @@ if UI_ENABLED: ) if "actions" in notify2.get_server_caps(): - notificaton.add_action("confirm", "Confirm", confirm_cb, message) - notificaton.add_action("cancel", "Cancel", cancel_cb, message) + notification.add_action("confirm", "Confirm", confirm_cb, message) + notification.add_action("cancel", "Cancel", cancel_cb, message) - notificaton.show() + notification.show() def sas_done_notification(self, message): - notificaton = notify2.Notification( + notification = notify2.Notification( "Device successfully verified.", message=( f"Device {message.device_id} of user {message.user_id} " f"successfully verified." ), ) - notificaton.set_category("im") - notificaton.show() + notification.set_category("im") + notification.show() def message_callback(self): try: diff --git a/tests/pan_client_test.py b/tests/pan_client_test.py index 7202698..5932432 100644 --- a/tests/pan_client_test.py +++ b/tests/pan_client_test.py @@ -28,7 +28,7 @@ ALICE_ID = "@alice:example.org" async def client(tmpdir, loop): store = PanStore(tmpdir) queue = janus.Queue() - conf = ServerConfig("example", "https://exapmle.org") + conf = ServerConfig("example", "https://example.org") conf.history_fetch_delay = 0.1 store.save_server_user("example", "@example:example.org") @@ -421,7 +421,7 @@ class TestClass(object): tasks = client.pan_store.load_fetcher_tasks(client.server_name, client.user_id) assert len(tasks) == 1 - # Check that the task is our prev_batch from the sync resposne + # Check that the task is our prev_batch from the sync response assert tasks[0].room_id == TEST_ROOM_ID assert tasks[0].token == "t392-516_47314_0_7_1_1_1_11444_1" @@ -431,7 +431,7 @@ class TestClass(object): tasks = client.pan_store.load_fetcher_tasks(client.server_name, client.user_id) assert len(tasks) == 1 - # Check that the task is our end token from the messages resposne + # Check that the task is our end token from the messages response assert tasks[0].room_id == TEST_ROOM_ID assert tasks[0].token == "t47409-4357353_219380_26003_2265" @@ -519,7 +519,7 @@ class TestClass(object): ) assert len(tasks) == 1 - # Check that the task is our end token from the messages resposne + # Check that the task is our end token from the messages response assert tasks[0].room_id == TEST_ROOM_ID assert tasks[0].token == "t47409-4357353_219380_26003_2265" From b5a419e488fe985b0d2ef9a8212e71c27ea6a7d6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Wed, 28 Sep 2022 16:46:36 +0200 Subject: [PATCH 33/62] chore: Bump our version --- CHANGELOG.md | 13 +++++++++++++ pantalaimon/main.py | 2 +- pantalaimon/panctl.py | 2 +- setup.py | 4 ++-- 4 files changed, 17 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 168f740..e654661 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,19 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## 0.10.5 2022-09-28 + +### Added + +- [[#137]] Proxy the v3 endpoints as well + +### Fixed + +- [[#130]] Make sure the token variable is declared + +[#137]: https://github.com/matrix-org/pantalaimon/pull/137 +[#130]: https://github.com/matrix-org/pantalaimon/pull/130 + ## 0.10.4 2022-02-04 ### Fixed diff --git a/pantalaimon/main.py b/pantalaimon/main.py index 3002ee1..0ab42d6 100644 --- a/pantalaimon/main.py +++ b/pantalaimon/main.py @@ -287,7 +287,7 @@ async def daemon(context, log_level, debug_encryption, config, data_path): "connect to pantalaimon." ) ) -@click.version_option(version="0.10.4", prog_name="pantalaimon") +@click.version_option(version="0.10.5", prog_name="pantalaimon") @click.option( "--log-level", type=click.Choice(["error", "warning", "info", "debug"]), diff --git a/pantalaimon/panctl.py b/pantalaimon/panctl.py index 088bcaa..1f97fe7 100644 --- a/pantalaimon/panctl.py +++ b/pantalaimon/panctl.py @@ -695,7 +695,7 @@ class PanCtl: "the pantalaimon daemon." ) ) -@click.version_option(version="0.10.4", prog_name="panctl") +@click.version_option(version="0.10.5", prog_name="panctl") def main(): loop = asyncio.new_event_loop() glib_loop = GLib.MainLoop() diff --git a/setup.py b/setup.py index 5495f67..46798ba 100644 --- a/setup.py +++ b/setup.py @@ -7,7 +7,7 @@ with open("README.md", encoding="utf-8") as f: setup( name="pantalaimon", - version="0.10.4", + version="0.10.5", url="https://github.com/matrix-org/pantalaimon", author="The Matrix.org Team", author_email="poljar@termina.org.uk", @@ -29,7 +29,7 @@ setup( "cachetools >= 3.0.0", "prompt_toolkit > 2, < 4", "typing;python_version<'3.5'", - "matrix-nio[e2e] >= 0.18, < 0.20" + "matrix-nio[e2e] >= 0.20, < 0.21" ], extras_require={ "ui": [ From 127373fdcc91c5a4403e25444526822e59083a0d Mon Sep 17 00:00:00 2001 From: Igor Artemenko Date: Tue, 6 Dec 2022 12:38:38 +0000 Subject: [PATCH 34/62] Fix typo --- pantalaimon/client.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pantalaimon/client.py b/pantalaimon/client.py index 5b4ce05..be32859 100644 --- a/pantalaimon/client.py +++ b/pantalaimon/client.py @@ -135,7 +135,7 @@ class InvalidLimit(Exception): class SqliteQStore(SqliteStore): def _create_database(self): return SqliteQueueDatabase( - self.database_path, pragmas=(("foregign_keys", 1), ("secure_delete", 1)) + self.database_path, pragmas=(("foreign_keys", 1), ("secure_delete", 1)) ) def close(self): From 313a5d528c0eb6c6c0246c6325199d0605b7c344 Mon Sep 17 00:00:00 2001 From: Igor Artemenko Date: Thu, 12 Jan 2023 16:26:24 +0000 Subject: [PATCH 35/62] Decrypt initial message after joining new DM Suppose that Alice logs in using Element. Before this change, when Bob would send a DM to Alice through Pantalaimon, Alice would not be able to decrypt Bob's initial message. Instead, she would see "Unable to decrypt: The sender's device has not sent us the keys for this message." and Pantalaimon's olmsessions table would have no associated records. Any future messages would be visible however. On the other hand, when Alice (using Element) is the one to send the first DM to Bob, he can decrypt the initial message. For Pantalaimon to execute /keys/claim, get_missing_sessions must return the invitee's device (and log "Missing session for device"). If Pantalaimon calls this method too soon, then self.device_store will not have the device. To populate self.device_store before Pantalaimon calls get_missing_sessions, it must execute /keys/query (and invoke _handle_key_query) earlier, during the /createRoom request. Pantalaimon does execute the /keys/query request during a sync after the server finishes creating the DM (and logs "Adding new device to the device store for user"), but only after checking unsuccessfully for the device in self.device_store. After this change, Pantalaimon executes /keys/claim, there is one record in olmsessions, and Alice can decrypt Bob's initial message. --- pantalaimon/daemon.py | 21 +++++++++++++++++++++ pantalaimon/main.py | 2 ++ 2 files changed, 23 insertions(+) diff --git a/pantalaimon/daemon.py b/pantalaimon/daemon.py index 3264cab..d241aff 100755 --- a/pantalaimon/daemon.py +++ b/pantalaimon/daemon.py @@ -793,6 +793,27 @@ class ProxyDaemon: body=await response.read(), ) + async def createRoom(self, request): + try: + content = await request.json() + except (JSONDecodeError, ContentTypeError): + return self._not_json + + invite = content.get("invite", ()) + if invite: + access_token = self.get_access_token(request) + + if not access_token: + return self._missing_token + + client = await self._find_client(access_token) + if not client: + return self._unknown_token + + client.users_for_key_query.update(invite) + + return await self.forward_to_web(request) + async def messages(self, request): access_token = self.get_access_token(request) diff --git a/pantalaimon/main.py b/pantalaimon/main.py index 0ab42d6..cd27170 100644 --- a/pantalaimon/main.py +++ b/pantalaimon/main.py @@ -71,6 +71,8 @@ async def init(data_dir, server_conf, send_queue, recv_queue): web.post("/_matrix/client/v3/login", proxy.login), web.get("/_matrix/client/r0/sync", proxy.sync), web.get("/_matrix/client/v3/sync", proxy.sync), + web.post("/_matrix/client/r0/createRoom", proxy.createRoom), + web.post("/_matrix/client/v3/createRoom", proxy.createRoom), web.get("/_matrix/client/r0/rooms/{room_id}/messages", proxy.messages), web.get("/_matrix/client/v3/rooms/{room_id}/messages", proxy.messages), web.put( From 807deb94ee9e39bb570a904960d750e8d0dd5086 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gerber=20L=C3=B3r=C3=A1nt=20Viktor?= Date: Fri, 3 Feb 2023 05:45:50 +0100 Subject: [PATCH 36/62] fix media --- pantalaimon/daemon.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pantalaimon/daemon.py b/pantalaimon/daemon.py index 3264cab..c5e4ac4 100755 --- a/pantalaimon/daemon.py +++ b/pantalaimon/daemon.py @@ -1273,7 +1273,7 @@ class ProxyDaemon: client = next(iter(self.pan_clients.values())) try: - response = await client.download(server_name, media_id, file_name) + response = await client.download(server_name=server_name, media_id=media_id, filename=file_name) except ClientConnectionError as e: raise e From 6638393042654b3f497ac1ea4b5f550b7024b490 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Thu, 25 May 2023 19:57:25 +0200 Subject: [PATCH 37/62] Fix tox --- tox.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tox.ini b/tox.ini index c3a2630..d90feda 100644 --- a/tox.ini +++ b/tox.ini @@ -5,7 +5,7 @@ envlist = coverage deps = -rtest-requirements.txt install_command = pip install {opts} {packages} -passenv = TOXENV CI +passenv = TOXENV,CI commands = pytest [testenv:coverage] From 3968c69aa846889970df1372ba9aa54c1c5e4290 Mon Sep 17 00:00:00 2001 From: Igor Artemenko Date: Wed, 5 Apr 2023 16:17:04 +0000 Subject: [PATCH 38/62] Set Pantalaimon presence to offline Before this change, Pantalaimon users would always appear online because that is the default state when the /sync endpoint's set_presence parameter is not set. By explicitly setting the parameter to "offline", only the user-facing client (which executes its own /sync request) affects the presence state. --- pantalaimon/client.py | 1 + 1 file changed, 1 insertion(+) diff --git a/pantalaimon/client.py b/pantalaimon/client.py index be32859..ececee3 100644 --- a/pantalaimon/client.py +++ b/pantalaimon/client.py @@ -554,6 +554,7 @@ class PanClient(AsyncClient): full_state=True, since=next_batch, loop_sleep_time=loop_sleep_time, + set_presence="offline", ) ) self.task = task From 8b2a1173fd228e536024ecda49d36671ff16de70 Mon Sep 17 00:00:00 2001 From: Hank Greenburg Date: Tue, 1 Oct 2024 18:50:43 -0700 Subject: [PATCH 39/62] update README with new setup instructions --- README.md | 39 ++++++++++++++++++++++++++++++++++++++- 1 file changed, 38 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 47916d8..0573108 100644 --- a/README.md +++ b/README.md @@ -111,7 +111,7 @@ specifies one or more homeservers for pantalaimon to connect to. A minimal pantalaimon configuration looks like this: ```dosini [local-matrix] -Homeserver = https://localhost:8448 +Homeserver = https://localhost:443 ListenAddress = localhost ListenPort = 8009 ``` @@ -140,3 +140,40 @@ To control the daemon an interactive utility is provided in the form of `panctl` can be used to verify, blacklist or ignore devices, import or export session keys, or to introspect devices of users that we share encrypted rooms with. + +### Setup +This is all coming from an excellent comment that you can find [here](https://github.com/matrix-org/pantalaimon/issues/154#issuecomment-1951591191). + + + +1) Ensure you have an OS keyring installed. In my case I installed gnome-keyring. You may also want a GUI like seahorse to inspect the keyring. (pantalaimon will work without a keyring but your client will have to log in with the password every time pantalaimon is restarted, instead of being able to reuse the access token from the previous successful login.) + +2) In case you have prior attempts, clean the slate by deleting the ~/.local/share/pantalaimon directory. + +3) Start pantalaimon. + +4) Connect a client to the ListenAddress:ListenPort you specified in pantalaimon.conf, eg to 127.0.0.1:8009, using the same username and password you would've used to login to your homeserver directly. + +5) The login should succeed, but at this point all encrypted messages will fail to decrypt. This is fine. + +6) Start another client that you were already using for your encrypted chats previously. In my case this was app.element.io, so the rest of the steps here assume that. + +7) Run panctl. At the prompt, run start-verification . here is the full user ID like @arnavion:arnavion.dev. If you only have the one Element session, panctl will show you the device ID as an autocomplete hint so you don't have to look it up. If you do need to look it up, go to Element -> profile icon -> All Settings -> Sessions, expand the "Current session" item, and the "Session ID" is the device ID. + +8) In Element you will see a popup "Incoming Verification Request". Click "Continue". It will change to a popup containing some emojis, and panctl will print the same emojis. Click the "They match" button. It will now change to a popup like "Waiting for other client to confirm..." + +9) In panctl, run confirm-verification , ie the same command as before but with confirm-verification instead of start-verification. + +10) At this point, if you look at all your sessions in Element (profile icon -> All Settings -> Sessions), you should see "pantalaimon" in the "Other sessions" list as a "Verified" session. + +11) Export the E2E room keys that Element was using via profile icon -> Security & Privacy -> Export E2E room keys. Pick any password and then save the file to some path. + +12) Back in panctl, run import-keys . After a few seconds, in the output of pantalaimon, you should see a log like INFO: pantalaimon: Successfully imported keys for from + +13) Close and restart the client you had used in step 5, ie the one you want to connect to pantalaimon. Now, finally, you should be able to see the encrypted chats be decrypted. + +14) Delete the E2E room keys backup file from step 12. You don't need it any more. + +15) If in step 11 you had other unverified sessions from pantalaimon from your prior attempts, you can sign out of them too. + +You will probably have to repeat steps 12-15 any time you start a new encrypted chat in Element. From 634ac7ed68580ef8afafc02a82bf33e7c1c31259 Mon Sep 17 00:00:00 2001 From: Hank Greenburg Date: Tue, 1 Oct 2024 19:14:39 -0700 Subject: [PATCH 40/62] chore: remove depreciated dependency pydbus for dasbus --- pantalaimon/panctl.py | 6 +++--- pantalaimon/ui.py | 26 +++++++++++++------------- setup.py | 2 +- 3 files changed, 17 insertions(+), 17 deletions(-) diff --git a/pantalaimon/panctl.py b/pantalaimon/panctl.py index 1f97fe7..6519d8b 100644 --- a/pantalaimon/panctl.py +++ b/pantalaimon/panctl.py @@ -34,7 +34,7 @@ from prompt_toolkit import HTML, PromptSession, print_formatted_text from prompt_toolkit.completion import Completer, Completion, PathCompleter from prompt_toolkit.document import Document from prompt_toolkit.patch_stdout import patch_stdout -from pydbus import SessionBus +from dasbus.connection import SessionMessageBus PTK2 = ptk_version.startswith("2.") @@ -404,8 +404,8 @@ class PanCtl: commands = list(command_help.keys()) def __attrs_post_init__(self): - self.bus = SessionBus() - self.pan_bus = self.bus.get("org.pantalaimon1") + self.bus = SessionMessageBus() + self.pan_bus = self.bus.get_connection("org.pantalaimon1") self.ctl = self.pan_bus["org.pantalaimon1.control"] self.devices = self.pan_bus["org.pantalaimon1.devices"] diff --git a/pantalaimon/ui.py b/pantalaimon/ui.py index 813b67e..08e7e50 100644 --- a/pantalaimon/ui.py +++ b/pantalaimon/ui.py @@ -17,7 +17,7 @@ from importlib import util UI_ENABLED = ( util.find_spec("gi") is not None and util.find_spec("gi.repository") is not None - and util.find_spec("pydbus") is not None + and util.find_spec("dasbus") is not None ) if UI_ENABLED: @@ -28,8 +28,8 @@ if UI_ENABLED: import dbus import notify2 from gi.repository import GLib - from pydbus import SessionBus - from pydbus.generic import signal + from dasbus import SessionMessageBus + from dasbus.signal import Signal from dbus.mainloop.glib import DBusGMainLoop from nio import RoomKeyRequest, RoomKeyRequestCancellation @@ -123,8 +123,8 @@ if UI_ENABLED: """ - Response = signal() - UnverifiedDevices = signal() + Response = Signal() + UnverifiedDevices = Signal() def __init__(self, queue, server_list, id_counter): self.queue = queue @@ -297,13 +297,13 @@ if UI_ENABLED: """ - VerificationInvite = signal() - VerificationCancel = signal() - VerificationString = signal() - VerificationDone = signal() + VerificationInvite = Signal() + VerificationCancel = Signal() + VerificationString = Signal() + VerificationDone = Signal() - KeyRequest = signal() - KeyRequestCancel = signal() + KeyRequest = Signal() + KeyRequestCancel = Signal() def __init__(self, queue, id_counter): self.device_list = dict() @@ -466,8 +466,8 @@ if UI_ENABLED: self.control_if = Control(self.send_queue, self.server_list, id_counter) self.device_if = Devices(self.send_queue, id_counter) - self.bus = SessionBus() - self.bus.publish("org.pantalaimon1", self.control_if, self.device_if) + self.bus = SessionMessageBus() + self.bus.publish_object("org.pantalaimon1", self.control_if, self.device_if) def unverified_notification(self, message): notification = notify2.Notification( diff --git a/setup.py b/setup.py index 46798ba..75e0184 100644 --- a/setup.py +++ b/setup.py @@ -35,7 +35,7 @@ setup( "ui": [ "dbus-python >= 1.2, < 1.3", "PyGObject >= 3.36, < 3.39", - "pydbus >= 0.6, < 0.7", + "dasbus == 1.71", "notify2 >= 0.3, < 0.4", ] }, From 76dc74d250ee4d626da01c31725b46ae3ace5222 Mon Sep 17 00:00:00 2001 From: Hank Greenburg Date: Tue, 1 Oct 2024 19:20:29 -0700 Subject: [PATCH 41/62] chore: Format code with ruff --- pantalaimon/client.py | 12 ++++---- pantalaimon/config.py | 1 - pantalaimon/daemon.py | 14 +++++---- pantalaimon/index.py | 1 - pantalaimon/store.py | 1 - setup.py | 13 +++++---- tests/conftest.py | 47 +++++++++++++----------------- tests/pan_client_test.py | 8 +++-- tests/proxy_test.py | 34 +++++++++------------- tests/store_test.py | 63 ++++++++++++++++++++++------------------ 10 files changed, 96 insertions(+), 98 deletions(-) diff --git a/pantalaimon/client.py b/pantalaimon/client.py index ececee3..882f6be 100644 --- a/pantalaimon/client.py +++ b/pantalaimon/client.py @@ -709,7 +709,6 @@ class PanClient(AsyncClient): for share in self.get_active_key_requests( message.user_id, message.device_id ): - continued = True if not self.continue_key_share(share): @@ -811,8 +810,9 @@ class PanClient(AsyncClient): if not isinstance(event, MegolmEvent): logger.warn( - "Encrypted event is not a megolm event:" - "\n{}".format(pformat(event_dict)) + "Encrypted event is not a megolm event:" "\n{}".format( + pformat(event_dict) + ) ) return False @@ -836,9 +836,9 @@ class PanClient(AsyncClient): decrypted_event.source["content"]["url"] = decrypted_event.url if decrypted_event.thumbnail_url: - decrypted_event.source["content"]["info"][ - "thumbnail_url" - ] = decrypted_event.thumbnail_url + decrypted_event.source["content"]["info"]["thumbnail_url"] = ( + decrypted_event.thumbnail_url + ) event_dict.update(decrypted_event.source) event_dict["decrypted"] = True diff --git a/pantalaimon/config.py b/pantalaimon/config.py index 8ee51d2..a5e59d1 100644 --- a/pantalaimon/config.py +++ b/pantalaimon/config.py @@ -186,7 +186,6 @@ class PanConfig: try: for section_name, section in config.items(): - if section_name == "Default": continue diff --git a/pantalaimon/daemon.py b/pantalaimon/daemon.py index c5e4ac4..2e48ac6 100755 --- a/pantalaimon/daemon.py +++ b/pantalaimon/daemon.py @@ -227,7 +227,8 @@ class ProxyDaemon: if ret: msg = ( - f"Device {device.id} of user " f"{device.user_id} successfully verified." + f"Device {device.id} of user " + f"{device.user_id} successfully verified." ) await client.send_update_device(device) else: @@ -309,7 +310,6 @@ class ProxyDaemon: DeviceUnblacklistMessage, ), ): - device = client.device_store[message.user_id].get(message.device_id, None) if not device: @@ -616,7 +616,9 @@ class ProxyDaemon: await pan_client.close() return - logger.info(f"Successfully started new background sync client for " f"{user_id}") + logger.info( + f"Successfully started new background sync client for " f"{user_id}" + ) await self.send_ui_message( UpdateUsersMessage(self.name, user_id, pan_client.device_id) @@ -733,7 +735,7 @@ class ProxyDaemon: return decryption_method(body, ignore_failures=False) except EncryptionError: logger.info("Error decrypting sync, waiting for next pan " "sync") - await client.synced.wait(), + (await client.synced.wait(),) logger.info("Pan synced, retrying decryption.") try: @@ -1273,7 +1275,9 @@ class ProxyDaemon: client = next(iter(self.pan_clients.values())) try: - response = await client.download(server_name=server_name, media_id=media_id, filename=file_name) + response = await client.download( + server_name=server_name, media_id=media_id, filename=file_name + ) except ClientConnectionError as e: raise e diff --git a/pantalaimon/index.py b/pantalaimon/index.py index 7350e58..e4f4aa0 100644 --- a/pantalaimon/index.py +++ b/pantalaimon/index.py @@ -230,7 +230,6 @@ if False: ) for message in query: - event = message.event event_dict = { diff --git a/pantalaimon/store.py b/pantalaimon/store.py index 60a36a4..ee6f377 100644 --- a/pantalaimon/store.py +++ b/pantalaimon/store.py @@ -431,7 +431,6 @@ class PanStore: device_store = defaultdict(dict) for d in account.device_keys: - if d.deleted: continue diff --git a/setup.py b/setup.py index 46798ba..5b5fe45 100644 --- a/setup.py +++ b/setup.py @@ -11,8 +11,7 @@ setup( url="https://github.com/matrix-org/pantalaimon", author="The Matrix.org Team", author_email="poljar@termina.org.uk", - description=("A Matrix proxy daemon that adds E2E encryption " - "capabilities."), + description=("A Matrix proxy daemon that adds E2E encryption " "capabilities."), long_description=long_description, long_description_content_type="text/markdown", license="Apache License, Version 2.0", @@ -29,7 +28,7 @@ setup( "cachetools >= 3.0.0", "prompt_toolkit > 2, < 4", "typing;python_version<'3.5'", - "matrix-nio[e2e] >= 0.20, < 0.21" + "matrix-nio[e2e] >= 0.20, < 0.21", ], extras_require={ "ui": [ @@ -40,8 +39,10 @@ setup( ] }, entry_points={ - "console_scripts": ["pantalaimon=pantalaimon.main:main", - "panctl=pantalaimon.panctl:main"], + "console_scripts": [ + "pantalaimon=pantalaimon.main:main", + "panctl=pantalaimon.panctl:main", + ], }, - zip_safe=False + zip_safe=False, ) diff --git a/tests/conftest.py b/tests/conftest.py index 6103f77..ceb8902 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -34,11 +34,9 @@ class Provider(BaseProvider): def client(self): return ClientInfo(faker.mx_id(), faker.access_token()) - def avatar_url(self): return "mxc://{}/{}#auto".format( - faker.hostname(), - "".join(choices(ascii_letters) for i in range(24)) + faker.hostname(), "".join(choices(ascii_letters) for i in range(24)) ) def olm_key_pair(self): @@ -56,7 +54,6 @@ class Provider(BaseProvider): ) - faker.add_provider(Provider) @@ -80,13 +77,7 @@ def tempdir(): @pytest.fixture def panstore(tempdir): for _ in range(10): - store = SqliteStore( - faker.mx_id(), - faker.device_id(), - tempdir, - "", - "pan.db" - ) + store = SqliteStore(faker.mx_id(), faker.device_id(), tempdir, "", "pan.db") account = OlmAccount() store.save_account(account) @@ -130,21 +121,23 @@ async def pan_proxy_server(tempdir, aiohttp_server): recv_queue=ui_queue.async_q, proxy=None, ssl=False, - client_store_class=SqliteStore + client_store_class=SqliteStore, ) - app.add_routes([ - web.post("/_matrix/client/r0/login", proxy.login), - web.get("/_matrix/client/r0/sync", proxy.sync), - web.get("/_matrix/client/r0/rooms/{room_id}/messages", proxy.messages), - web.put( - r"/_matrix/client/r0/rooms/{room_id}/send/{event_type}/{txnid}", - proxy.send_message - ), - web.post("/_matrix/client/r0/user/{user_id}/filter", proxy.filter), - web.post("/_matrix/client/r0/search", proxy.search), - web.options("/_matrix/client/r0/search", proxy.search_opts), - ]) + app.add_routes( + [ + web.post("/_matrix/client/r0/login", proxy.login), + web.get("/_matrix/client/r0/sync", proxy.sync), + web.get("/_matrix/client/r0/rooms/{room_id}/messages", proxy.messages), + web.put( + r"/_matrix/client/r0/rooms/{room_id}/send/{event_type}/{txnid}", + proxy.send_message, + ), + web.post("/_matrix/client/r0/user/{user_id}/filter", proxy.filter), + web.post("/_matrix/client/r0/search", proxy.search), + web.options("/_matrix/client/r0/search", proxy.search_opts), + ] + ) server = await aiohttp_server(app) @@ -161,7 +154,7 @@ async def running_proxy(pan_proxy_server, aioresponse, aiohttp_client): "access_token": "abc123", "device_id": "GHTYAJCE", "home_server": "example.org", - "user_id": "@example:example.org" + "user_id": "@example:example.org", } aioclient = await aiohttp_client(server) @@ -170,7 +163,7 @@ async def running_proxy(pan_proxy_server, aioresponse, aiohttp_client): "https://example.org/_matrix/client/r0/login", status=200, payload=login_response, - repeat=True + repeat=True, ) await aioclient.post( @@ -179,7 +172,7 @@ async def running_proxy(pan_proxy_server, aioresponse, aiohttp_client): "type": "m.login.password", "user": "example", "password": "wordpass", - } + }, ) yield server, aioclient, proxy, queues diff --git a/tests/pan_client_test.py b/tests/pan_client_test.py index 5932432..318d1b3 100644 --- a/tests/pan_client_test.py +++ b/tests/pan_client_test.py @@ -380,7 +380,9 @@ class TestClass(object): ) aioresponse.get( - sync_url, status=200, payload=self.initial_sync_response, + sync_url, + status=200, + payload=self.initial_sync_response, ) aioresponse.get(sync_url, status=200, payload=self.empty_sync, repeat=True) @@ -454,7 +456,9 @@ class TestClass(object): ) aioresponse.get( - sync_url, status=200, payload=self.initial_sync_response, + sync_url, + status=200, + payload=self.initial_sync_response, ) aioresponse.get(sync_url, status=200, payload=self.empty_sync, repeat=True) diff --git a/tests/proxy_test.py b/tests/proxy_test.py index b50379e..f0856d8 100644 --- a/tests/proxy_test.py +++ b/tests/proxy_test.py @@ -27,7 +27,7 @@ class TestClass(object): "access_token": "abc123", "device_id": "GHTYAJCE", "home_server": "example.org", - "user_id": "@example:example.org" + "user_id": "@example:example.org", } @property @@ -36,12 +36,7 @@ class TestClass(object): @property def keys_upload_response(self): - return { - "one_time_key_counts": { - "curve25519": 10, - "signed_curve25519": 20 - } - } + return {"one_time_key_counts": {"curve25519": 10, "signed_curve25519": 20}} @property def example_devices(self): @@ -52,10 +47,7 @@ class TestClass(object): devices[device.user_id][device.id] = device bob_device = OlmDevice( - BOB_ID, - BOB_DEVICE, - {"ed25519": BOB_ONETIME, - "curve25519": BOB_CURVE} + BOB_ID, BOB_DEVICE, {"ed25519": BOB_ONETIME, "curve25519": BOB_CURVE} ) devices[BOB_ID][BOB_DEVICE] = bob_device @@ -71,7 +63,7 @@ class TestClass(object): "https://example.org/_matrix/client/r0/login", status=200, payload=self.login_response, - repeat=True + repeat=True, ) assert not daemon.pan_clients @@ -82,7 +74,7 @@ class TestClass(object): "type": "m.login.password", "user": "example", "password": "wordpass", - } + }, ) assert resp.status == 200 @@ -105,11 +97,11 @@ class TestClass(object): "https://example.org/_matrix/client/r0/login", status=200, payload=self.login_response, - repeat=True + repeat=True, ) sync_url = re.compile( - r'^https://example\.org/_matrix/client/r0/sync\?access_token=.*' + r"^https://example\.org/_matrix/client/r0/sync\?access_token=.*" ) aioresponse.get( @@ -124,14 +116,16 @@ class TestClass(object): "type": "m.login.password", "user": "example", "password": "wordpass", - } + }, ) # Check that the pan client started to sync after logging in. pan_client = list(daemon.pan_clients.values())[0] assert len(pan_client.rooms) == 1 - async def test_pan_client_keys_upload(self, pan_proxy_server, aiohttp_client, aioresponse): + async def test_pan_client_keys_upload( + self, pan_proxy_server, aiohttp_client, aioresponse + ): server, daemon, _ = pan_proxy_server client = await aiohttp_client(server) @@ -140,11 +134,11 @@ class TestClass(object): "https://example.org/_matrix/client/r0/login", status=200, payload=self.login_response, - repeat=True + repeat=True, ) sync_url = re.compile( - r'^https://example\.org/_matrix/client/r0/sync\?access_token=.*' + r"^https://example\.org/_matrix/client/r0/sync\?access_token=.*" ) aioresponse.get( @@ -169,7 +163,7 @@ class TestClass(object): "type": "m.login.password", "user": "example", "password": "wordpass", - } + }, ) pan_client = list(daemon.pan_clients.values())[0] diff --git a/tests/store_test.py b/tests/store_test.py index 1d16e10..13acfb0 100644 --- a/tests/store_test.py +++ b/tests/store_test.py @@ -27,7 +27,7 @@ class TestClass(object): "type": "m.room.message", "unsigned": {"age": 43289803095}, "user_id": "@example2:localhost", - "age": 43289803095 + "age": 43289803095, } ) @@ -43,39 +43,41 @@ class TestClass(object): "type": "m.room.message", "unsigned": {"age": 43289803095}, "user_id": "@example2:localhost", - "age": 43289803095 + "age": 43289803095, } ) @property def encrypted_media_event(self): - return RoomEncryptedMedia.from_dict({ - "room_id": "!testroom:localhost", - "event_id": "$15163622445EBvZK:localhost", - "origin_server_ts": 1516362244030, - "sender": "@example2:localhost", - "type": "m.room.message", - "content": { - "body": "orange_cat.jpg", - "msgtype": "m.image", - "file": { - "v": "v2", - "key": { - "alg": "A256CTR", - "ext": True, - "k": "yx0QvkgYlasdWEsdalkejaHBzCkKEBAp3tB7dGtWgrs", - "key_ops": ["encrypt", "decrypt"], - "kty": "oct" + return RoomEncryptedMedia.from_dict( + { + "room_id": "!testroom:localhost", + "event_id": "$15163622445EBvZK:localhost", + "origin_server_ts": 1516362244030, + "sender": "@example2:localhost", + "type": "m.room.message", + "content": { + "body": "orange_cat.jpg", + "msgtype": "m.image", + "file": { + "v": "v2", + "key": { + "alg": "A256CTR", + "ext": True, + "k": "yx0QvkgYlasdWEsdalkejaHBzCkKEBAp3tB7dGtWgrs", + "key_ops": ["encrypt", "decrypt"], + "kty": "oct", + }, + "iv": "0pglXX7fspIBBBBAEERLFd", + "hashes": { + "sha256": "eXRDFvh+aXsQRj8a+5ZVVWUQ9Y6u9DYiz4tq1NvbLu8" + }, + "url": "mxc://localhost/maDtasSiPFjROFMnlwxIhhyW", + "mimetype": "image/jpeg", }, - "iv": "0pglXX7fspIBBBBAEERLFd", - "hashes": { - "sha256": "eXRDFvh+aXsQRj8a+5ZVVWUQ9Y6u9DYiz4tq1NvbLu8" - }, - "url": "mxc://localhost/maDtasSiPFjROFMnlwxIhhyW", - "mimetype": "image/jpeg" - } + }, } - }) + ) def test_account_loading(self, panstore): accounts = panstore.load_all_users() @@ -131,6 +133,7 @@ class TestClass(object): pytest.skip("Indexing needs to be enabled to test this") from pantalaimon.index import Index, IndexStore + loop = asyncio.get_event_loop() store = IndexStore("example", tempdir) @@ -148,8 +151,10 @@ class TestClass(object): assert len(result["results"]) == 1 assert result["count"] == 1 assert result["results"][0]["result"] == self.test_event.source - assert (result["results"][0]["context"]["events_after"][0] - == self.another_event.source) + assert ( + result["results"][0]["context"]["events_after"][0] + == self.another_event.source + ) def test_media_storage(self, panstore): server_name = "test" From 369f73f3fb53975fd1f448ede53e021fd2afe85a Mon Sep 17 00:00:00 2001 From: Hank Greenburg Date: Tue, 1 Oct 2024 19:27:30 -0700 Subject: [PATCH 42/62] chore: removing unused imports --- pantalaimon/client.py | 1 - pantalaimon/index.py | 1 - pantalaimon/main.py | 1 - pantalaimon/store.py | 2 +- tests/proxy_test.py | 2 -- tests/store_test.py | 5 +---- 6 files changed, 2 insertions(+), 10 deletions(-) diff --git a/pantalaimon/client.py b/pantalaimon/client.py index 882f6be..f2f6895 100644 --- a/pantalaimon/client.py +++ b/pantalaimon/client.py @@ -16,7 +16,6 @@ import asyncio import os from collections import defaultdict from pprint import pformat -from typing import Any, Dict, Optional from urllib.parse import urlparse from aiohttp.client_exceptions import ClientConnectionError diff --git a/pantalaimon/index.py b/pantalaimon/index.py index e4f4aa0..3d49614 100644 --- a/pantalaimon/index.py +++ b/pantalaimon/index.py @@ -23,7 +23,6 @@ if False: import json import os from functools import partial - from typing import Any, Dict, List, Optional, Tuple import attr import tantivy diff --git a/pantalaimon/main.py b/pantalaimon/main.py index 0ab42d6..abc411c 100644 --- a/pantalaimon/main.py +++ b/pantalaimon/main.py @@ -15,7 +15,6 @@ import asyncio import os import signal -from typing import Optional import click import janus diff --git a/pantalaimon/store.py b/pantalaimon/store.py index ee6f377..0dfe045 100644 --- a/pantalaimon/store.py +++ b/pantalaimon/store.py @@ -15,7 +15,7 @@ import json import os from collections import defaultdict -from typing import Any, Dict, List, Optional, Tuple +from typing import Any, Dict import attr from nio.crypto import TrustState, GroupSessionStore diff --git a/tests/proxy_test.py b/tests/proxy_test.py index f0856d8..ecf515e 100644 --- a/tests/proxy_test.py +++ b/tests/proxy_test.py @@ -1,9 +1,7 @@ -import asyncio import json import re from collections import defaultdict -from aiohttp import web from nio.crypto import OlmDevice from conftest import faker diff --git a/tests/store_test.py b/tests/store_test.py index 13acfb0..2ecef85 100644 --- a/tests/store_test.py +++ b/tests/store_test.py @@ -1,12 +1,10 @@ import asyncio -import pdb import pprint import pytest from nio import RoomMessage, RoomEncryptedMedia from urllib.parse import urlparse -from conftest import faker from pantalaimon.index import INDEXING_ENABLED from pantalaimon.store import FetchTask, MediaInfo, UploadInfo @@ -81,7 +79,6 @@ class TestClass(object): def test_account_loading(self, panstore): accounts = panstore.load_all_users() - # pdb.set_trace() assert len(accounts) == 10 def test_token_saving(self, panstore, access_token): @@ -132,7 +129,7 @@ class TestClass(object): if not INDEXING_ENABLED: pytest.skip("Indexing needs to be enabled to test this") - from pantalaimon.index import Index, IndexStore + from pantalaimon.index import IndexStore loop = asyncio.get_event_loop() From 5caaaf565176144adb35d12ca5e0c5a918e19444 Mon Sep 17 00:00:00 2001 From: Hank Greenburg Date: Wed, 2 Oct 2024 18:12:51 -0700 Subject: [PATCH 43/62] chore: Add code fences to the README --- README.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 0573108..412db2a 100644 --- a/README.md +++ b/README.md @@ -146,34 +146,35 @@ This is all coming from an excellent comment that you can find [here](https://gi -1) Ensure you have an OS keyring installed. In my case I installed gnome-keyring. You may also want a GUI like seahorse to inspect the keyring. (pantalaimon will work without a keyring but your client will have to log in with the password every time pantalaimon is restarted, instead of being able to reuse the access token from the previous successful login.) +1) Ensure you have an OS keyring installed. In my case I installed `gnome-keyring`. You may also want a GUI like `seahorse` to inspect the keyring. (pantalaimon will work without a keyring but your client will have to log in with the password every time `pantalaimon` is restarted, instead of being able to reuse the access token from the previous successful login.) -2) In case you have prior attempts, clean the slate by deleting the ~/.local/share/pantalaimon directory. +2) In case you have prior attempts, clean the slate by deleting the `~/.local/share/pantalaimon` directory. -3) Start pantalaimon. +3) Start `pantalaimon`. -4) Connect a client to the ListenAddress:ListenPort you specified in pantalaimon.conf, eg to 127.0.0.1:8009, using the same username and password you would've used to login to your homeserver directly. +4) Connect a client to the `ListenAddress:ListenPort` you specified in `pantalaimon.conf`, eg to `127.0.0.1:8009`, using the same username and password you would've used to login to your homeserver directly. 5) The login should succeed, but at this point all encrypted messages will fail to decrypt. This is fine. -6) Start another client that you were already using for your encrypted chats previously. In my case this was app.element.io, so the rest of the steps here assume that. +6) Start another client that you were already using for your encrypted chats previously. In my case this was `app.element.io`, so the rest of the steps here assume that. -7) Run panctl. At the prompt, run start-verification . here is the full user ID like @arnavion:arnavion.dev. If you only have the one Element session, panctl will show you the device ID as an autocomplete hint so you don't have to look it up. If you do need to look it up, go to Element -> profile icon -> All Settings -> Sessions, expand the "Current session" item, and the "Session ID" is the device ID. +7) Run `panctl`. At the prompt, run `start-verification `. `` here is the full user ID like `@arnavion:arnavion.dev`. If you only have the one Element session, `panctl` will show you the device ID as an autocomplete hint so you don't have to look it up. If you do need to look it up, go to Element -> profile icon -> All Settings -> Sessions, expand the "Current session" item, and the "Session ID" is the device ID. -8) In Element you will see a popup "Incoming Verification Request". Click "Continue". It will change to a popup containing some emojis, and panctl will print the same emojis. Click the "They match" button. It will now change to a popup like "Waiting for other client to confirm..." +8) In Element you will see a popup "Incoming Verification Request". Click "Continue". It will change to a popup containing some emojis, and `panctl` will print the same emojis. Click the "They match" button. It will now change to a popup like "Waiting for other client to confirm..." -9) In panctl, run confirm-verification , ie the same command as before but with confirm-verification instead of start-verification. +9) In `panctl`, run `confirm-verification `, ie the same command as before but with `confirm-verification` instead of `start-verification`. 10) At this point, if you look at all your sessions in Element (profile icon -> All Settings -> Sessions), you should see "pantalaimon" in the "Other sessions" list as a "Verified" session. 11) Export the E2E room keys that Element was using via profile icon -> Security & Privacy -> Export E2E room keys. Pick any password and then save the file to some path. -12) Back in panctl, run import-keys . After a few seconds, in the output of pantalaimon, you should see a log like INFO: pantalaimon: Successfully imported keys for from +12) Back in `panctl`, run `import-keys `. After a few seconds, in the output of `pantalaimon`, you should see a log like `INFO: pantalaimon: Successfully imported keys for from `. -13) Close and restart the client you had used in step 5, ie the one you want to connect to pantalaimon. Now, finally, you should be able to see the encrypted chats be decrypted. +13) Close and restart the client you had used in step 5, ie the one you want to connect to `pantalaimon`. Now, finally, you should be able to see the encrypted chats be decrypted. 14) Delete the E2E room keys backup file from step 12. You don't need it any more. + 15) If in step 11 you had other unverified sessions from pantalaimon from your prior attempts, you can sign out of them too. -You will probably have to repeat steps 12-15 any time you start a new encrypted chat in Element. +You will probably have to repeat steps 11-14 any time you start a new encrypted chat in Element. From 5426d5bf9d5109f113bdf10a6133eefdcacad2ff Mon Sep 17 00:00:00 2001 From: Hank Greenburg Date: Mon, 28 Oct 2024 20:07:12 -0700 Subject: [PATCH 44/62] chore: upgrade matrix-nio and fix dasbus version --- setup.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/setup.py b/setup.py index 379f76f..5b9abec 100644 --- a/setup.py +++ b/setup.py @@ -28,13 +28,13 @@ setup( "cachetools >= 3.0.0", "prompt_toolkit > 2, < 4", "typing;python_version<'3.5'", - "matrix-nio[e2e] >= 0.20, < 0.21", + "matrix-nio[e2e] >= 0.24, < 0.25.2", ], extras_require={ "ui": [ "dbus-python >= 1.2, < 1.3", "PyGObject >= 3.36, < 3.39", - "dasbus == 1.71", + "dasbus == 1.7", "notify2 >= 0.3, < 0.4", ] }, From e2abab1ecc8a5cfec171f164456d10a514d4216e Mon Sep 17 00:00:00 2001 From: Hank Greenburg Date: Mon, 28 Oct 2024 20:11:44 -0700 Subject: [PATCH 45/62] chore: update pip install instructions in README --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 412db2a..0e45f28 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,11 @@ Installing pantalaimon works like usually with python packages: python setup.py install +or you can use `pip` and install it with: +``` +pip install .[ui] +``` + Pantalaimon can also be found on pypi: pip install pantalaimon From bfb3b0615342c7625ceae7f95bc91fe9d2e3d54c Mon Sep 17 00:00:00 2001 From: Hank Greenburg Date: Mon, 28 Oct 2024 20:13:16 -0700 Subject: [PATCH 46/62] docs: Update how to install packages with package manager --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 0e45f28..7f2bd2d 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,9 @@ or you can use `pip` and install it with: pip install .[ui] ``` +It is recommended that you create a virtual environment first or install dependencies +via your package manager. They are usually found with `python-`. + Pantalaimon can also be found on pypi: pip install pantalaimon From 93a1fcb36fcf0d11a69e982f4a977d94159d7ad0 Mon Sep 17 00:00:00 2001 From: Icy-Thought Date: Fri, 1 Nov 2024 18:36:20 +0100 Subject: [PATCH 47/62] chore: update PyGObject dependency --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 5b9abec..fde2d4e 100644 --- a/setup.py +++ b/setup.py @@ -33,7 +33,7 @@ setup( extras_require={ "ui": [ "dbus-python >= 1.2, < 1.3", - "PyGObject >= 3.36, < 3.39", + "PyGObject >= 3.46, < 3.50", "dasbus == 1.7", "notify2 >= 0.3, < 0.4", ] From e9fb8a4a57cd2179f6ef9645e910b864a55413f1 Mon Sep 17 00:00:00 2001 From: Hank Greenburg Date: Wed, 20 Nov 2024 20:20:36 -0800 Subject: [PATCH 48/62] chore: change from appdirs to platformdirs --- pantalaimon/main.py | 2 +- setup.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pantalaimon/main.py b/pantalaimon/main.py index 3468365..741937e 100644 --- a/pantalaimon/main.py +++ b/pantalaimon/main.py @@ -22,7 +22,7 @@ import keyring import logbook import nio from aiohttp import web -from appdirs import user_config_dir, user_data_dir +from platformdirs import user_config_dir, user_data_dir from logbook import StderrHandler from pantalaimon.config import PanConfig, PanConfigError, parse_log_level diff --git a/setup.py b/setup.py index fde2d4e..bba80e6 100644 --- a/setup.py +++ b/setup.py @@ -19,7 +19,7 @@ setup( install_requires=[ "attrs >= 19.3.0", "aiohttp >= 3.6, < 4.0", - "appdirs >= 1.4.4", + "platformdirs >= 4.3.6", "click >= 7.1.2", "keyring >= 21.2.1", "logbook >= 1.5.3", From 29d18653dcd4c7cd5ebeea2521b7f17607d67c38 Mon Sep 17 00:00:00 2001 From: Arka Dash Date: Thu, 5 Dec 2024 00:07:03 +0530 Subject: [PATCH 49/62] Using shlex.split instead str.split --- pantalaimon/panctl.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pantalaimon/panctl.py b/pantalaimon/panctl.py index 6519d8b..8e087d0 100644 --- a/pantalaimon/panctl.py +++ b/pantalaimon/panctl.py @@ -20,6 +20,7 @@ import sys from collections import defaultdict from itertools import zip_longest from typing import List +from shlex import split import attr import click @@ -589,7 +590,7 @@ class PanCtl: parser = PanctlParser(self.commands) try: - args = parser.parse_args(result.split()) + args = parser.parse_args(split(result)) except ParseError: continue From 42cdcc251924a7c99528fa56b1c77824865c0ffc Mon Sep 17 00:00:00 2001 From: Arka Dash Date: Thu, 5 Dec 2024 11:07:05 +0530 Subject: [PATCH 50/62] set posix to False --- pantalaimon/panctl.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pantalaimon/panctl.py b/pantalaimon/panctl.py index 8e087d0..a6e6c89 100644 --- a/pantalaimon/panctl.py +++ b/pantalaimon/panctl.py @@ -590,7 +590,7 @@ class PanCtl: parser = PanctlParser(self.commands) try: - args = parser.parse_args(split(result)) + args = parser.parse_args(split(result, posix=False)) except ParseError: continue From 26d9a55ce88dfaeb4507c1a7f85cada6debba9f1 Mon Sep 17 00:00:00 2001 From: Hank Greenburg Date: Sun, 29 Dec 2024 20:09:14 -0800 Subject: [PATCH 51/62] fix: revert ui.py to pydbus --- pantalaimon/ui.py | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/pantalaimon/ui.py b/pantalaimon/ui.py index 08e7e50..813b67e 100644 --- a/pantalaimon/ui.py +++ b/pantalaimon/ui.py @@ -17,7 +17,7 @@ from importlib import util UI_ENABLED = ( util.find_spec("gi") is not None and util.find_spec("gi.repository") is not None - and util.find_spec("dasbus") is not None + and util.find_spec("pydbus") is not None ) if UI_ENABLED: @@ -28,8 +28,8 @@ if UI_ENABLED: import dbus import notify2 from gi.repository import GLib - from dasbus import SessionMessageBus - from dasbus.signal import Signal + from pydbus import SessionBus + from pydbus.generic import signal from dbus.mainloop.glib import DBusGMainLoop from nio import RoomKeyRequest, RoomKeyRequestCancellation @@ -123,8 +123,8 @@ if UI_ENABLED: """ - Response = Signal() - UnverifiedDevices = Signal() + Response = signal() + UnverifiedDevices = signal() def __init__(self, queue, server_list, id_counter): self.queue = queue @@ -297,13 +297,13 @@ if UI_ENABLED: """ - VerificationInvite = Signal() - VerificationCancel = Signal() - VerificationString = Signal() - VerificationDone = Signal() + VerificationInvite = signal() + VerificationCancel = signal() + VerificationString = signal() + VerificationDone = signal() - KeyRequest = Signal() - KeyRequestCancel = Signal() + KeyRequest = signal() + KeyRequestCancel = signal() def __init__(self, queue, id_counter): self.device_list = dict() @@ -466,8 +466,8 @@ if UI_ENABLED: self.control_if = Control(self.send_queue, self.server_list, id_counter) self.device_if = Devices(self.send_queue, id_counter) - self.bus = SessionMessageBus() - self.bus.publish_object("org.pantalaimon1", self.control_if, self.device_if) + self.bus = SessionBus() + self.bus.publish("org.pantalaimon1", self.control_if, self.device_if) def unverified_notification(self, message): notification = notify2.Notification( From c3ee162802cc08d219860fef8912ea4cef436d9f Mon Sep 17 00:00:00 2001 From: Hank Greenburg Date: Sun, 29 Dec 2024 20:11:25 -0800 Subject: [PATCH 52/62] fix: revert steup.py to use pydbus --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index bba80e6..aeb1a6b 100644 --- a/setup.py +++ b/setup.py @@ -34,7 +34,7 @@ setup( "ui": [ "dbus-python >= 1.2, < 1.3", "PyGObject >= 3.46, < 3.50", - "dasbus == 1.7", + "pydbus >= 0.6, < 0.7", "notify2 >= 0.3, < 0.4", ] }, From 0f52d303d48301171a9c39dbd6f86765e2b45aff Mon Sep 17 00:00:00 2001 From: Hank Greenburg Date: Sun, 29 Dec 2024 20:12:44 -0800 Subject: [PATCH 53/62] fix: revert panctl.py to pydbus --- pantalaimon/panctl.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pantalaimon/panctl.py b/pantalaimon/panctl.py index a6e6c89..f37ab88 100644 --- a/pantalaimon/panctl.py +++ b/pantalaimon/panctl.py @@ -35,7 +35,7 @@ from prompt_toolkit import HTML, PromptSession, print_formatted_text from prompt_toolkit.completion import Completer, Completion, PathCompleter from prompt_toolkit.document import Document from prompt_toolkit.patch_stdout import patch_stdout -from dasbus.connection import SessionMessageBus +from pydbus import SessionBus PTK2 = ptk_version.startswith("2.") @@ -405,8 +405,8 @@ class PanCtl: commands = list(command_help.keys()) def __attrs_post_init__(self): - self.bus = SessionMessageBus() - self.pan_bus = self.bus.get_connection("org.pantalaimon1") + self.bus = SessionBus() + self.pan_bus = self.bus.get("org.pantalaimon1") self.ctl = self.pan_bus["org.pantalaimon1.control"] self.devices = self.pan_bus["org.pantalaimon1.devices"] From 659bf093f8fe4accb8ec893c3c983d094d9ce90d Mon Sep 17 00:00:00 2001 From: Hank Greenburg Date: Sun, 6 Apr 2025 17:51:29 -0700 Subject: [PATCH 54/62] =?UTF-8?q?chore:=20Fix=20failing=20tests=20by=20rem?= =?UTF-8?q?oving=20unused=20fixture=20=F0=9F=A5=B6?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- tests/pan_client_test.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tests/pan_client_test.py b/tests/pan_client_test.py index 318d1b3..67f130f 100644 --- a/tests/pan_client_test.py +++ b/tests/pan_client_test.py @@ -25,7 +25,7 @@ ALICE_ID = "@alice:example.org" @pytest.fixture -async def client(tmpdir, loop): +async def client(tmpdir): store = PanStore(tmpdir) queue = janus.Queue() conf = ServerConfig("example", "https://example.org") @@ -371,7 +371,7 @@ class TestClass(object): await client.loop_stop() - async def test_history_fetching_tasks(self, client, aioresponse, loop): + async def test_history_fetching_tasks(self, client, aioresponse): if not INDEXING_ENABLED: pytest.skip("Indexing needs to be enabled to test this") @@ -447,7 +447,7 @@ class TestClass(object): await client.loop_stop() - async def test_history_fetching_resume(self, client, aioresponse, loop): + async def test_history_fetching_resume(self, client, aioresponse): if not INDEXING_ENABLED: pytest.skip("Indexing needs to be enabled to test this") From 5c68db3971da41a882016fd228f2782c487b6878 Mon Sep 17 00:00:00 2001 From: Hank Greenburg Date: Tue, 3 Jun 2025 10:39:25 -0700 Subject: [PATCH 55/62] =?UTF-8?q?build:=20Add=20manpages=20to=20distributi?= =?UTF-8?q?on=20=F0=9F=92=AE?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- setup.py | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/setup.py b/setup.py index aeb1a6b..9f0584e 100644 --- a/setup.py +++ b/setup.py @@ -1,17 +1,34 @@ # -*- coding: utf-8 -*- from setuptools import find_packages, setup +import os with open("README.md", encoding="utf-8") as f: long_description = f.read() + +def get_manpages(): + """ + This function goes and gets all the man pages so they can be installed when + the package is installed. + """ + man_pages = [] + for root, _, files in os.walk("docs/man"): + for file in files: + if file.endswith((".1", ".5", ".8")): + man_section = file.split(".")[-1] + dest_dir = os.path.join("share", "man", f"man{man_section}") + man_pages.append((dest_dir, [os.path.join(root, file)])) + return man_pages + + setup( name="pantalaimon", version="0.10.5", url="https://github.com/matrix-org/pantalaimon", author="The Matrix.org Team", author_email="poljar@termina.org.uk", - description=("A Matrix proxy daemon that adds E2E encryption " "capabilities."), + description=("A Matrix proxy daemon that adds E2E encryption capabilities."), long_description=long_description, long_description_content_type="text/markdown", license="Apache License, Version 2.0", @@ -45,4 +62,5 @@ setup( ], }, zip_safe=False, + data_files=get_manpages(), ) From da7f426c60f907905e18221d39a9ce1948344b61 Mon Sep 17 00:00:00 2001 From: Hank Greenburg Date: Tue, 3 Jun 2025 17:26:32 -0700 Subject: [PATCH 56/62] =?UTF-8?q?build:=20Fixing=20tests=20with=20async=20?= =?UTF-8?q?=F0=9F=A5=9D?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- pytest.ini | 2 ++ test-requirements.txt | 1 + tox.ini | 1 + 3 files changed, 4 insertions(+) create mode 100644 pytest.ini diff --git a/pytest.ini b/pytest.ini new file mode 100644 index 0000000..d280de0 --- /dev/null +++ b/pytest.ini @@ -0,0 +1,2 @@ +[pytest] +asyncio_mode = auto \ No newline at end of file diff --git a/test-requirements.txt b/test-requirements.txt index 36816bf..e16edb3 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -5,4 +5,5 @@ pytest-cov faker aiohttp pytest-aiohttp +pytest-asyncio aioresponses diff --git a/tox.ini b/tox.ini index d90feda..c19ce56 100644 --- a/tox.ini +++ b/tox.ini @@ -18,5 +18,6 @@ deps = -rtest-requirements.txt coverage codecov>=1.4.0 + pytest-asyncio setenv = COVERAGE_FILE=.coverage From a7be6cbfcb95dd9d761d230526f1be1c8013d25e Mon Sep 17 00:00:00 2001 From: Hank Greenburg Date: Tue, 3 Jun 2025 17:41:48 -0700 Subject: [PATCH 57/62] =?UTF-8?q?chore:=20pin=20package=20versions=20for?= =?UTF-8?q?=20testing=20=F0=9F=8F=B5=EF=B8=8F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- test-requirements.txt | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/test-requirements.txt b/test-requirements.txt index e16edb3..570aea6 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,9 +1,9 @@ -pytest -pytest-flake8 -pytest-isort -pytest-cov -faker -aiohttp -pytest-aiohttp -pytest-asyncio -aioresponses +pytest==8.3.5 +pytest-flake8==1.3.0 +pytest-isort==4.0.0 +pytest-cov==6.1.1 +faker==37.1.0 +aiohttp==3.11.16 +pytest-aiohttp==1.1.0 +pytest-asyncio==0.26.0 +aioresponses==0.7.8 From 50cb9c41a8b9945c9c34a33295ef0c6bdecf88a5 Mon Sep 17 00:00:00 2001 From: Hank Greenburg Date: Tue, 3 Jun 2025 17:46:08 -0700 Subject: [PATCH 58/62] chore: Removed unused file --- pytest.ini | 2 -- 1 file changed, 2 deletions(-) delete mode 100644 pytest.ini diff --git a/pytest.ini b/pytest.ini deleted file mode 100644 index d280de0..0000000 --- a/pytest.ini +++ /dev/null @@ -1,2 +0,0 @@ -[pytest] -asyncio_mode = auto \ No newline at end of file From b42b24019a8a407a15c3c1574c00e21095310a30 Mon Sep 17 00:00:00 2001 From: Hank Greenburg Date: Tue, 3 Jun 2025 17:48:50 -0700 Subject: [PATCH 59/62] =?UTF-8?q?chore:=20Pin=20different=20version=20of?= =?UTF-8?q?=20pytest-flake8=20=F0=9F=98=B5=E2=80=8D=F0=9F=92=AB?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- test-requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test-requirements.txt b/test-requirements.txt index 570aea6..fe924a0 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,5 +1,5 @@ pytest==8.3.5 -pytest-flake8==1.3.0 +pytest-flake8==1.2.2 pytest-isort==4.0.0 pytest-cov==6.1.1 faker==37.1.0 From dcf02179a9cde1506bee43a772ecf4ccd8299f1c Mon Sep 17 00:00:00 2001 From: Hank Greenburg Date: Tue, 3 Jun 2025 17:53:36 -0700 Subject: [PATCH 60/62] UGH, why is the CI not seeing these package versions???????? --- test-requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test-requirements.txt b/test-requirements.txt index fe924a0..662440f 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,7 +1,7 @@ pytest==8.3.5 pytest-flake8==1.2.2 pytest-isort==4.0.0 -pytest-cov==6.1.1 +pytest-cov==5.0.0 faker==37.1.0 aiohttp==3.11.16 pytest-aiohttp==1.1.0 From 5f041b25d2810828a5908f4c7fbacf6553ec6c1b Mon Sep 17 00:00:00 2001 From: Hank Greenburg Date: Tue, 3 Jun 2025 17:56:59 -0700 Subject: [PATCH 61/62] Work, I beg of you. --- test-requirements.txt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/test-requirements.txt b/test-requirements.txt index 662440f..bdbc671 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -2,8 +2,8 @@ pytest==8.3.5 pytest-flake8==1.2.2 pytest-isort==4.0.0 pytest-cov==5.0.0 -faker==37.1.0 -aiohttp==3.11.16 -pytest-aiohttp==1.1.0 -pytest-asyncio==0.26.0 -aioresponses==0.7.8 +faker<=37.1.0 +aiohttp<=3.11.16 +pytest-aiohttp<=1.1.0 +pytest-asyncio<=0.26.0 +aioresponses<=0.7.8 From 34432fe059028b081ddf7fbeb008d2e9d7974ec5 Mon Sep 17 00:00:00 2001 From: Aurelia Date: Wed, 4 Jun 2025 00:42:44 +0200 Subject: [PATCH 62/62] ci: add docker build and release --- .github/workflows/docker.yml | 53 ++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 .github/workflows/docker.yml diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml new file mode 100644 index 0000000..56531f5 --- /dev/null +++ b/.github/workflows/docker.yml @@ -0,0 +1,53 @@ +name: Create and publish a docker image + +on: + workflow_dispatch: + push: + branches: + - master + tags: + - '\d+.\d+.\d+' + pull_request: + branches: + - master + +env: + REGISTRY: ghcr.io + IMAGE_NAME: ${{ github.repository }} + +jobs: + build: + runs-on: ubuntu-latest + + permissions: + contents: read + packages: write + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Log in to container registry + uses: docker/login-action@v3 + with: + registry: ${{ env.REGISTRY }} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Extract metadata + id: meta + uses: docker/metadata-action@v5 + with: + images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} + tags: | + type=ref,event=branch + type=ref,event=tag,prefix=v + type=sha + + - name: Build and push docker image + uses: docker/build-push-action@v6 + with: + context: . + push: ${{ github.event_name != 'pull_request' }} + tags: ${{ steps.meta.outputs.tags }} + labels: ${{ steps.meta.outputs.labels }}