File: encrypt_megolm.py

package info (click to toggle)
mautrix-python 0.20.7-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 1,812 kB
  • sloc: python: 19,103; makefile: 16
file content (370 lines) | stat: -rw-r--r-- 15,082 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
# Copyright (c) 2022 Tulir Asokan
#
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
from typing import Any, Dict, List, Tuple, Union
from collections import defaultdict
from datetime import datetime, timedelta
import asyncio
import json
import time

from mautrix.errors import EncryptionError, SessionShareError
from mautrix.types import (
    DeviceID,
    DeviceIdentity,
    EncryptedMegolmEventContent,
    EncryptionAlgorithm,
    EventType,
    IdentityKey,
    RelatesTo,
    RoomID,
    RoomKeyWithheldCode,
    RoomKeyWithheldEventContent,
    Serializable,
    SessionID,
    SigningKey,
    TrustState,
    UserID,
)

from .device_lists import DeviceListMachine
from .encrypt_olm import OlmEncryptionMachine
from .sessions import InboundGroupSession, OutboundGroupSession, Session


class Sentinel:
    pass


already_shared = Sentinel()
key_missing = Sentinel()

DeviceSessionWrapper = Tuple[Session, DeviceIdentity]
DeviceMap = Dict[UserID, Dict[DeviceID, DeviceSessionWrapper]]
SessionEncryptResult = Union[
    type(already_shared),  # already shared
    DeviceSessionWrapper,  # share successful
    RoomKeyWithheldEventContent,  # won't share
    type(key_missing),  # missing device
]


class MegolmEncryptionMachine(OlmEncryptionMachine, DeviceListMachine):
    _megolm_locks: Dict[RoomID, asyncio.Lock]
    _sharing_group_session: Dict[RoomID, asyncio.Event]

    def __init__(self) -> None:
        super().__init__()
        self._megolm_locks = defaultdict(lambda: asyncio.Lock())
        self._sharing_group_session = {}

    async def encrypt_megolm_event(
        self, room_id: RoomID, event_type: EventType, content: Any
    ) -> EncryptedMegolmEventContent:
        """
        Encrypt an event for a specific room using Megolm.

        Args:
            room_id: The room to encrypt the message for.
            event_type: The event type.
            content: The event content. Using the content structs in the mautrix.types
                module is recommended.

        Returns:
            The encrypted event content.

        Raises:
            EncryptionError: If a group session has not been shared.
                Use :meth:`share_group_session` to share a group session if this error is raised.
        """
        # The crypto store is async, so we need to make sure only one thing is writing at a time.
        async with self._megolm_locks[room_id]:
            return await self._encrypt_megolm_event(room_id, event_type, content)

    async def _encrypt_megolm_event(
        self, room_id: RoomID, event_type: EventType, content: Any
    ) -> EncryptedMegolmEventContent:
        self.log.debug(f"Encrypting event of type {event_type} for {room_id}")
        session = await self.crypto_store.get_outbound_group_session(room_id)
        if not session:
            raise EncryptionError("No group session created")
        ciphertext = session.encrypt(
            json.dumps(
                {
                    "room_id": room_id,
                    "type": event_type.serialize(),
                    "content": (
                        content.serialize() if isinstance(content, Serializable) else content
                    ),
                }
            )
        )
        try:
            relates_to = content.relates_to
        except AttributeError:
            try:
                relates_to = RelatesTo.deserialize(content["m.relates_to"])
            except KeyError:
                relates_to = None
        await self.crypto_store.update_outbound_group_session(session)
        return EncryptedMegolmEventContent(
            sender_key=self.account.identity_key,
            device_id=self.client.device_id,
            ciphertext=ciphertext,
            session_id=SessionID(session.id),
            relates_to=relates_to,
        )

    def is_sharing_group_session(self, room_id: RoomID) -> bool:
        """
        Check if there's a group session being shared for a specific room

        Args:
            room_id: The room ID to check.

        Returns:
            True if a group session share is in progress, False if not
        """
        return room_id in self._sharing_group_session

    async def wait_group_session_share(self, room_id: RoomID) -> None:
        """
        Wait for a group session to be shared.

        Args:
            room_id: The room ID to wait for.
        """
        try:
            event = self._sharing_group_session[room_id]
            await event.wait()
        except KeyError:
            pass

    async def share_group_session(self, room_id: RoomID, users: List[UserID]) -> None:
        """
        Create a Megolm session for a specific room and share it with the given list of users.

        Note that you must not call this method again before the previous share has finished.
        You should either lock calls yourself, or use :meth:`wait_group_session_share` to use
        built-in locking capabilities.

        Args:
            room_id: The room to create the session for.
            users: The list of users to share the session with.

        Raises:
            SessionShareError: If something went wrong while sharing the session.
        """
        if room_id in self._sharing_group_session:
            raise SessionShareError("Already sharing group session for that room")
        self._sharing_group_session[room_id] = asyncio.Event()
        try:
            await self._share_group_session(room_id, users)
        finally:
            self._sharing_group_session.pop(room_id).set()

    async def _share_group_session(self, room_id: RoomID, users: List[UserID]) -> None:
        session = await self.crypto_store.get_outbound_group_session(room_id)
        if session and session.shared and not session.expired:
            raise SessionShareError("Group session has already been shared")
        if not session or session.expired:
            session = await self._new_outbound_group_session(room_id)
        self.log.debug(f"Sharing group session {session.id} for room {room_id} with {users}")

        olm_sessions: DeviceMap = defaultdict(lambda: {})
        withhold_key_msgs = defaultdict(lambda: {})
        missing_sessions: Dict[UserID, Dict[DeviceID, DeviceIdentity]] = defaultdict(lambda: {})
        fetch_keys = []

        for user_id in users:
            devices = await self.crypto_store.get_devices(user_id)
            if devices is None:
                self.log.debug(
                    f"get_devices returned nil for {user_id}, will fetch keys and retry"
                )
                fetch_keys.append(user_id)
            elif len(devices) == 0:
                self.log.debug(f"{user_id} has no devices, skipping")
            else:
                self.log.debug(f"Trying to encrypt group session {session.id} for {user_id}")
                for device_id, device in devices.items():
                    result = await self._find_olm_sessions(session, user_id, device_id, device)
                    if isinstance(result, RoomKeyWithheldEventContent):
                        withhold_key_msgs[user_id][device_id] = result
                    elif result == key_missing:
                        missing_sessions[user_id][device_id] = device
                    elif isinstance(result, tuple):
                        olm_sessions[user_id][device_id] = result

        if fetch_keys:
            self.log.debug(f"Fetching missing keys for {fetch_keys}")
            fetched_keys = await self._fetch_keys(users, include_untracked=True)
            for user_id, devices in fetched_keys.items():
                missing_sessions[user_id] = devices

        if missing_sessions:
            self.log.debug(f"Creating missing outbound sessions {missing_sessions}")
            try:
                await self._create_outbound_sessions(missing_sessions)
            except Exception:
                self.log.exception("Failed to create missing outbound sessions")

        for user_id, devices in missing_sessions.items():
            for device_id, device in devices.items():
                result = await self._find_olm_sessions(session, user_id, device_id, device)
                if isinstance(result, RoomKeyWithheldEventContent):
                    withhold_key_msgs[user_id][device_id] = result
                elif isinstance(result, tuple):
                    olm_sessions[user_id][device_id] = result
                # We don't care about missing keys at this point

        if len(olm_sessions) > 0:
            async with self._olm_lock:
                await self._encrypt_and_share_group_session(session, olm_sessions)
        if len(withhold_key_msgs) > 0:
            event_count = sum(len(map) for map in withhold_key_msgs.values())
            self.log.debug(
                f"Sending {event_count} to-device events to report {session.id} is withheld"
            )
            await self.client.send_to_device(EventType.ROOM_KEY_WITHHELD, withhold_key_msgs)
            await self.client.send_to_device(
                EventType.ORG_MATRIX_ROOM_KEY_WITHHELD, withhold_key_msgs
            )
        self.log.info(f"Group session {session.id} for {room_id} successfully shared")
        session.shared = True
        await self.crypto_store.add_outbound_group_session(session)

    async def _new_outbound_group_session(self, room_id: RoomID) -> OutboundGroupSession:
        session = OutboundGroupSession(room_id)

        encryption_info = await self.state_store.get_encryption_info(room_id)
        if encryption_info:
            if encryption_info.algorithm != EncryptionAlgorithm.MEGOLM_V1:
                raise SessionShareError("Room encryption algorithm is not supported")
            session.max_messages = encryption_info.rotation_period_msgs or session.max_messages
            session.max_age = (
                timedelta(milliseconds=encryption_info.rotation_period_ms)
                if encryption_info.rotation_period_ms
                else session.max_age
            )
            self.log.debug(
                "Got stored encryption state event and configured session to rotate "
                f"after {session.max_messages} messages or {session.max_age}"
            )

        if not self.dont_store_outbound_keys:
            await self._create_group_session(
                self.account.identity_key,
                self.account.signing_key,
                room_id,
                SessionID(session.id),
                session.session_key,
                max_messages=session.max_messages,
                max_age=session.max_age,
                is_scheduled=False,
            )
        return session

    async def _encrypt_and_share_group_session(
        self, session: OutboundGroupSession, olm_sessions: DeviceMap
    ):
        msgs = defaultdict(lambda: {})
        count = 0
        for user_id, devices in olm_sessions.items():
            count += len(devices)
            for device_id, (olm_session, device_identity) in devices.items():
                msgs[user_id][device_id] = await self._encrypt_olm_event(
                    olm_session, device_identity, EventType.ROOM_KEY, session.share_content
                )
        self.log.debug(
            f"Sending to-device events to {count} devices of {len(msgs)} users "
            f"to share {session.id}"
        )
        await self.client.send_to_device(EventType.TO_DEVICE_ENCRYPTED, msgs)

    async def _create_group_session(
        self,
        sender_key: IdentityKey,
        signing_key: SigningKey,
        room_id: RoomID,
        session_id: SessionID,
        session_key: str,
        max_age: Union[timedelta, int],
        max_messages: int,
        is_scheduled: bool = False,
    ) -> None:
        start = time.monotonic()
        session = InboundGroupSession(
            session_key=session_key,
            signing_key=signing_key,
            sender_key=sender_key,
            room_id=room_id,
            received_at=datetime.utcnow(),
            max_age=max_age,
            max_messages=max_messages,
            is_scheduled=is_scheduled,
        )
        olm_duration = time.monotonic() - start
        if olm_duration > 5:
            self.log.warning(f"Creating inbound group session took {olm_duration:.3f} seconds!")
        if session_id != session.id:
            self.log.warning(f"Mismatching session IDs: expected {session_id}, got {session.id}")
            session_id = session.id
        await self.crypto_store.put_group_session(room_id, sender_key, session_id, session)
        self._mark_session_received(session_id)
        self.log.debug(
            f"Created inbound group session {room_id}/{sender_key}/{session_id} "
            f"(max {max_age} / {max_messages} messages, {is_scheduled=})"
        )

    async def _find_olm_sessions(
        self,
        session: OutboundGroupSession,
        user_id: UserID,
        device_id: DeviceID,
        device: DeviceIdentity,
    ) -> SessionEncryptResult:
        key = (user_id, device_id)
        if key in session.users_ignored or key in session.users_shared_with:
            return already_shared
        elif user_id == self.client.mxid and device_id == self.client.device_id:
            session.users_ignored.add(key)
            return already_shared

        trust = await self.resolve_trust(device)
        if trust == TrustState.BLACKLISTED:
            self.log.debug(
                f"Not encrypting group session {session.id} for {device_id} "
                f"of {user_id}: device is blacklisted"
            )
            session.users_ignored.add(key)
            return RoomKeyWithheldEventContent(
                room_id=session.room_id,
                algorithm=EncryptionAlgorithm.MEGOLM_V1,
                session_id=SessionID(session.id),
                sender_key=self.account.identity_key,
                code=RoomKeyWithheldCode.BLACKLISTED,
                reason="Device is blacklisted",
            )
        elif self.send_keys_min_trust > trust:
            self.log.debug(
                f"Not encrypting group session {session.id} for {device_id} "
                f"of {user_id}: device is not trusted "
                f"(min: {self.send_keys_min_trust}, device: {trust})"
            )
            session.users_ignored.add(key)
            return RoomKeyWithheldEventContent(
                room_id=session.room_id,
                algorithm=EncryptionAlgorithm.MEGOLM_V1,
                session_id=SessionID(session.id),
                sender_key=self.account.identity_key,
                code=RoomKeyWithheldCode.UNVERIFIED,
                reason="This device does not encrypt messages for unverified devices",
            )
        device_session = await self.crypto_store.get_latest_session(device.identity_key)
        if not device_session:
            return key_missing
        session.users_shared_with.add(key)
        return device_session, device