Merge branch 'decrypt-heartbeats' into 'main'

Don't fail on decrypting heartbeats

See merge request poezio/slixmpp-omemo!12

examples/echo_client.py

@@ -150,6 +150,11 @@ class EchoBot(ClientXMPP):
         try:
             encrypted = msg['omemo_encrypted']
             body = self['xep_0384'].decrypt_message(encrypted, mfrom, allow_untrusted)
+            # decrypt_message returns Optional[str]. It is possible to get
+            # body-less OMEMO message (see KeyTransportMessages), currently
+            # used for example to send heartbeats to other devices.
+            if body is None:
+                return None
             decoded = body.decode('utf8')
             if self.is_command(decoded):
                 await self.handle_command(mto, mtype, decoded)

slixmpp_omemo/__init__.py

@@ -650,9 +650,10 @@ class XEP_0384(BasePlugin):
         allow_untrusted: bool = False,
     ) -> Optional[str]:
         header = encrypted['header']
-        if encrypted['payload']['value'] is None:
+
-            raise ErroneousPayload('The payload element was empty')
+        payload = None
-        payload = b64dec(encrypted['payload']['value'])
+        if encrypted['payload']['value'] is not None:
+            payload = b64dec(encrypted['payload']['value'])
 
         jid = sender.bare
         sid = int(header['sid'])
@@ -674,15 +675,26 @@ class XEP_0384(BasePlugin):
         # XXX: 'cipher' is part of KeyTransportMessages and is used when no payload
         # is passed. We do not implement this yet.
         try:
-            body = self._omemo.decryptMessage(
+            if payload is None:
-                jid,
+                self._omemo.decryptRatchetFowardingMessage(
-                sid,
+                    jid,
-                iv,
+                    sid,
-                message,
+                    iv,
-                isPrekeyMessage,
+                    message,
-                payload,
+                    isPrekeyMessage,
-                allow_untrusted=allow_untrusted,
+                    allow_untrusted=allow_untrusted,
-            )
+                )
+                body = None
+            else:
+                body = self._omemo.decryptMessage(
+                    jid,
+                    sid,
+                    iv,
+                    message,
+                    isPrekeyMessage,
+                    payload,
+                    allow_untrusted=allow_untrusted,
+                )
         except (omemo.exceptions.NoSessionException,):
             # This might happen when the sender is sending using a session
             # that we don't know about (deleted session storage, etc.). In