Merge pull request #152 from majestrate/dm-delete-endpoints-2022-11-22

delete dm endpoints

Author: jagerman

setup.cfg

@@ -21,3 +21,5 @@ install_requires=
     oxenmq
     oxenc
     pyonionreq
+    tomli
+    sqlalchemy

sogs/model/message.py

@@ -42,6 +42,20 @@ def __init__(self, row=None, *, sender=None, recip=None, data=None):
         assert row is not None
         self._row = row
 
+    @staticmethod
+    def delete_all(*, recip=None, sender=None):
+        """Delete all messages sent to a user or from a user.
+        returns the number of rows affected.
+        """
+        if sum(bool(x) for x in (sender, recip)) != 1:
+            raise ValueError("delete_all(): exactly one of sender or recipient is required")
+
+        result = query(
+            f"DELETE FROM inbox WHERE {'recipient' if recip else 'sender'} = :id",
+            id=recip.id if recip else sender.id,
+        )
+        return result.rowcount
+
     @staticmethod
     def to(user, since=None, limit=None):
         """get all message for a user, returns a generator"""

sogs/routes/auth.py

@@ -121,6 +121,27 @@ def required_user_wrapper(*args, **kwargs):
     return required_user_wrapper
 
 
+def require_blind_user():
+    """Requires that the authenticated user is using a blinded pubkey for auth; aborts with 401
+    Unauthorized if the user has not authenticated with a blinded pubkey."""
+    require_user()
+    if not g.user.is_blinded:
+        abort_with_reason(http.UNAUTHORIZED, "This endpoint requires blinded pubkeys be used")
+
+
+def blind_user_required(f):
+    """Decorator for an endpoint that requires a user that is using a blinded public key;
+    this calls `require_blind_user()` at the beginning
+    of the request to abort the request as Unauthorized if that precondition is not met."""
+
+    @wraps(f)
+    def blind_user_wrapper(*args, **kwargs):
+        require_blind_user()
+        return f(*args, **kwargs)
+
+    return blind_user_wrapper
+
+
 def require_mod(room, *, admin=False):
     """Checks a room for moderator or admin permission; aborts with 401 Unauthorized if there is no
     user in the request, and 403 Forbidden if g.user does not have moderator (or admin, if

sogs/routes/dm.py

@@ -25,8 +25,6 @@ def _serialize_message(msg, include_message=True):
 
 def _box(out: bool, *, since=None):
     """handle inbox/outbox endpoints common logic"""
-    if not g.user.is_blinded:
-        abort(http.FORBIDDEN)
     limit = utils.get_int_param('limit', 100, min=1, max=256, truncate=True)
     get = Message.sent if out else Message.to
     msgs = [_serialize_message(msg) for msg in get(user=g.user, limit=limit, since=since)]
@@ -36,7 +34,7 @@ def _box(out: bool, *, since=None):
 
 
 @dm.get("/outbox")
-@auth.user_required
+@auth.blind_user_required
 def get_outbox():
     """
     Retrieves all of the user's sent messages (up to `limit`).
@@ -45,7 +43,7 @@ def get_outbox():
 
 
 @dm.get("/outbox/since/<int:msgid>")
-@auth.user_required
+@auth.blind_user_required
 def poll_outbox(msgid):
     """
     Polls for any DMs sent since the given id.
@@ -54,7 +52,7 @@ def poll_outbox(msgid):
 
 
 @dm.get("/inbox")
-@auth.user_required
+@auth.blind_user_required
 def get_inbox():
     """
     Retrieves all of the user's recieved messages (up to `limit`).
@@ -63,7 +61,7 @@ def get_inbox():
 
 
 @dm.get("/inbox/since/<int:msgid>")
-@auth.user_required
+@auth.blind_user_required
 def poll_inbox(msgid):
     """
     Polls for any DMs received since the given id.
@@ -112,3 +110,20 @@ def send_inbox(sid):
     with db.transaction():
         msg = Message(data=utils.decode_base64(message), recip=recip_user, sender=g.user)
     return jsonify(_serialize_message(msg, include_message=False)), http.CREATED
+
+
+@dm.delete("/inbox")
+@auth.blind_user_required
+def delete_inbox_items():
+    """
+    Deletes all of the user's received messages.
+
+    # Return value
+
+    Returns a JSON object with one key `"deleted"` set to the number of deleted messages.
+    """
+    ret = dict()
+    with db.transaction():
+        ret['deleted'] = Message.delete_all(recip=g.user)
+
+    return jsonify(ret), http.OK

tests/test_dm.py

@@ -1,11 +1,12 @@
-from request import sogs_get, sogs_post
+from request import sogs_get, sogs_post, sogs_delete
 from sogs import config
 from sogs.hashing import blake2b
 from sogs.utils import encode_base64
 from sogs.model.user import SystemUser
 import nacl.bindings as sodium
 from nacl.utils import random
 from util import from_now
+from itertools import product
 
 
 def test_dm_default_empty(client, blind_user):
@@ -89,3 +90,42 @@ def test_dm_send(client, blind_user, blind_user2):
     assert data.pop('posted_at') == from_now.seconds(0)
     assert data.pop('expires_at') == from_now.seconds(config.DM_EXPIRY)
     assert data == msg_expected
+
+
+def test_dm_delete(client, blind_user, blind_user2):
+    num_posts = 10
+    for sender, recip in product((blind_user, blind_user2), repeat=2):
+        # make DMs
+        for n in range(num_posts):
+            post = make_post(f"bep-{n}".encode('ascii'), sender=sender, to=recip)
+            r = sogs_post(client, f'/inbox/{recip.session_id}', post, sender)
+            assert r.status_code == 201
+
+        # get DMs
+        r = sogs_get(client, "/inbox", recip)
+        assert r.status_code == 200
+        posts = r.json
+        assert isinstance(posts, list)
+        assert len(posts) == num_posts
+
+        # delete DMs
+        r = sogs_delete(client, "/inbox", recip)
+        assert r.status_code == 200
+        assert r.json == {'deleted': num_posts}
+
+        # make sure it is empty
+        r = sogs_get(client, "/inbox", recip)
+        assert r.status_code == 200
+        posts = r.json
+        assert posts == []
+
+        # delete again when nothing is there
+        r = sogs_delete(client, "/inbox", recip)
+        assert r.status_code == 200
+        assert r.json == {'deleted': 0}
+
+        # make sure it is still empty (probably redundant but good to have)
+        r = sogs_get(client, "/inbox", recip)
+        assert r.status_code == 200
+        posts = r.json
+        assert posts == []