Skip to content

fix(matrix): handle encrypted media in E2EE rooms #4196

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
elkimek wants to merge 1 commit into from
Closed

fix(matrix): handle encrypted media in E2EE rooms #4196

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 19 additions & 4 deletions gateway/platforms/matrix.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,11 @@ async def connect(self) -> bool:
client.add_event_callback(self._on_room_message_media, nio.RoomMessageAudio)
client.add_event_callback(self._on_room_message_media, nio.RoomMessageVideo)
client.add_event_callback(self._on_room_message_media, nio.RoomMessageFile)
# Encrypted media events (E2EE rooms where the file data is encrypted).
client.add_event_callback(self._on_room_message_media, nio.RoomEncryptedImage)
client.add_event_callback(self._on_room_message_media, nio.RoomEncryptedAudio)
client.add_event_callback(self._on_room_message_media, nio.RoomEncryptedVideo)
client.add_event_callback(self._on_room_message_media, nio.RoomEncryptedFile)
client.add_event_callback(self._on_invite, nio.InviteMemberEvent)

# If E2EE: handle encrypted events.
Expand Down Expand Up @@ -983,10 +988,10 @@ async def _on_room_message_media(self, room: Any, event: Any) -> None:
msg_type = MessageType.DOCUMENT
is_voice_message = False

if isinstance(event, nio.RoomMessageImage):
if isinstance(event, (nio.RoomMessageImage, nio.RoomEncryptedImage)):
msg_type = MessageType.PHOTO
media_type = event_mimetype or "image/png"
elif isinstance(event, nio.RoomMessageAudio):
elif isinstance(event, (nio.RoomMessageAudio, nio.RoomEncryptedAudio)):
# Check for MSC3245 voice flag: org.matrix.msc3245.voice: {}
source_content = getattr(event, "source", {}).get("content", {})
if source_content.get("org.matrix.msc3245.voice") is not None:
Expand All @@ -995,7 +1000,7 @@ async def _on_room_message_media(self, room: Any, event: Any) -> None:
else:
msg_type = MessageType.AUDIO
media_type = event_mimetype or "audio/ogg"
elif isinstance(event, nio.RoomMessageVideo):
elif isinstance(event, (nio.RoomMessageVideo, nio.RoomEncryptedVideo)):
msg_type = MessageType.VIDEO
media_type = event_mimetype or "video/mp4"
elif event_mimetype:
Expand All @@ -1013,8 +1018,18 @@ async def _on_room_message_media(self, room: Any, event: Any) -> None:
ext = ext_map.get(event_mimetype, ".jpg")
download_resp = await self._client.download(url)
if isinstance(download_resp, nio.DownloadResponse):
image_data = download_resp.body
# Decrypt attachment data for encrypted media events.
if hasattr(event, "key") and hasattr(event, "hashes") and hasattr(event, "iv"):
from nio.crypto import decrypt_attachment
image_data = decrypt_attachment(
image_data,
event.key.get("k", ""),
event.hashes.get("sha256", ""),
event.iv,
)
from gateway.platforms.base import cache_image_from_bytes
cached_path = cache_image_from_bytes(download_resp.body, ext=ext)
cached_path = cache_image_from_bytes(image_data, ext=ext)
logger.info("[Matrix] Cached user image at %s", cached_path)
except Exception as e:
logger.warning("[Matrix] Failed to cache image: %s", e)
Expand Down