Add non-contributory public key checks

.github/workflows/test-manual.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.12", "3.11", "3.10", "3.9", "3.8"]
+        python-version: ["3.13", "3.12", "3.11", "3.10"]
         event-loop: [asyncio, uvloop]
 
     steps:

.github/workflows/test.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.12", "3.11", "3.10", "3.9", "3.8"]
+        python-version: ["3.13", "3.12", "3.11", "3.10"]
         event-loop: [asyncio, uvloop]
 
     steps:

.gitignore

@@ -74,3 +74,6 @@ gen
 
 # MyPy Cache
 .mypy_cache/
+
+# OS specific
+.DS_Store

CHANGELOG.rst

@@ -1,6 +1,14 @@
 Changelog
 *********
 
+Unreleased
+----------
+
+- Add support for Python 3.13
+- Drop support for Python versions below 3.10
+- Check for non-contributory public keys (Note: When using a modern-ish
+  libsodium version, this check is redundant)
+
 `8.0.0`_ (2024-08-21)
 ---------------------
 

setup.cfg

@@ -1,5 +1,5 @@
 [bdist_wheel]
-python-tag = py38.py39.py310.py311.py312
+python-tag = py310.py311.py312.py313
 
 [flake8]
 max-line-length = 90

tests/test_base.py

@@ -1,5 +1,7 @@
 import libnacl
+import libnacl.public
 import pytest
+from packaging.version import Version
 
 from threema.gateway import (
     e2e,
@@ -25,10 +27,35 @@ def test_incorrect_ciphertext(self):
             e2e._pk_decrypt(key_pair, nonce, data_encrypted + b'0')
         assert 'decrypt' in str(exc_info.value)
 
+    def test_invalid_non_contributory_public_key(self):
+        all_zero_public_key = libnacl.public.PublicKey(
+            bytes(libnacl.crypto_box_PUBLICKEYBYTES))
+        key_pair = key.Key.generate_secret_key, all_zero_public_key
+        data_in = b"meow"
+        nonce = b"0" * 24
+
+        with pytest.raises(libnacl.CryptError) as exc_info:
+            e2e._pk_encrypt(key_pair, data_in, nonce=nonce)
+        assert "Invalid public key (non-contributory)" in str(exc_info.value)
+
+        with pytest.raises(libnacl.CryptError) as exc_info:
+            e2e._pk_decrypt(key_pair, nonce, bytes(5))
+        assert "Invalid public key (non-contributory)" in str(exc_info.value)
+
     def test_valid(self):
         key_pair = key.Key.generate_pair()
         data_in = b'meow'
         nonce = b'0' * 24
         _, data_encrypted = e2e._pk_encrypt(key_pair, data_in, nonce=nonce)
         data_out = e2e._pk_decrypt(key_pair, nonce, data_encrypted)
         assert data_in == data_out
+
+    @pytest.mark.skipif(
+        Version(libnacl.sodium_version_string().decode("ascii")) < Version("1.0.7"),
+        reason="no zero-result check on X25519 in this libnacl backend")
+    def test_libsodium_non_contributory_public_key(self):
+        all_zero_pk = libnacl.public.PublicKey(bytes(libnacl.crypto_box_PUBLICKEYBYTES))
+        alice_sk, _ = key.Key.generate_pair()
+        with pytest.raises(libnacl.CryptError) as exc_info:
+            libnacl.public.Box(alice_sk, all_zero_pk)
+        assert 'Unable to compute shared key' in str(exc_info)

threema/gateway/e2e.py

@@ -82,6 +82,7 @@ def _pk_encrypt(key_pair: Tuple[Key, Key], data: bytes, nonce: Optional[bytes] =
     """
     # Assemble and encrypt the payload
     private, public = key_pair
+    Key.ensure_valid_public_key(public)
     box = libnacl.public.Box(sk=private, pk=public)
     return box.encrypt(data, nonce=nonce, pack_nonce=False)
 
@@ -103,6 +104,7 @@ def _pk_decrypt(key_pair: Tuple[Key, Key], nonce: bytes, data: bytes):
     """
     # Decrypt payload
     private, public = key_pair
+    Key.ensure_valid_public_key(public)
     box = libnacl.public.Box(sk=private, pk=public)
     return box.decrypt(data, nonce=nonce)
 
@@ -244,7 +246,7 @@ def add_callback_route(
     if receive_handler is None:
         receive_handler = Message.receive
     context = CallbackContext(
-        connection.secret.encode('ascii'),
+        connection.secret.encode('utf-8'),
         connection,
         message_handler,
         receive_handler,
@@ -1286,7 +1288,7 @@ async def pack(self, writer):
 
         # Pack payload (compact JSON encoding)
         try:
-            content = json.dumps(content, separators=(',', ':')).encode('ascii')
+            content = json.dumps(content, separators=(',', ':')).encode('utf-8')
         except UnicodeError as exc:
             raise MessageError('Could not encode JSON') from exc
 

threema/gateway/key.py

@@ -42,6 +42,10 @@ def hash(message, hash_type):
         return hmac.new(HMAC.keys[hash_type], message.encode('ascii'), hashlib.sha256)
 
 
+_NON_CONTRIBUTORY_PUBLIC_KEY = libnacl.public.PublicKey(
+    bytes(libnacl.crypto_box_PUBLICKEYBYTES))
+
+
 class Key:
     """
     Encode or decode a key.
@@ -154,3 +158,23 @@ def derive_public(private_key):
         Return the :class:`libnacl.public.PublicKey` instance.
         """
         return libnacl.public.PublicKey(private_key.pk)
+
+    @staticmethod
+    def ensure_valid_public_key(public_key):
+        """
+        Ensure a public key is valid.
+
+        Arguments:
+            - `public_key`: An instance of
+              :class:`libnacl.public.PublicKey`.
+
+        Raises :class:`libnacl.CryptError` if the public key is invalid.
+        """
+        if not isinstance(public_key, libnacl.public.PublicKey):
+            raise libnacl.CryptError("Invalid public key")
+        if len(public_key.pk) != libnacl.crypto_box_PUBLICKEYBYTES:
+            raise libnacl.CryptError("Invalid public key")
+
+        # Reject all-zero public keys (mon-contributory)
+        if public_key == _NON_CONTRIBUTORY_PUBLIC_KEY:
+            raise libnacl.CryptError("Invalid public key (non-contributory)")