total WIP skeleton for /room_keys API

synapse/handlers/e2e_room_keys.py

@@ -0,0 +1,60 @@
+# -*- coding: utf-8 -*-
+# Copyright 2017 New Vector Ltd
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import ujson as json
+import logging
+
+from canonicaljson import encode_canonical_json
+from twisted.internet import defer
+
+from synapse.api.errors import SynapseError, CodeMessageException
+from synapse.types import get_domain_from_id
+from synapse.util.logcontext import preserve_fn, make_deferred_yieldable
+from synapse.util.retryutils import NotRetryingDestination
+
+logger = logging.getLogger(__name__)
+
+
+class E2eRoomKeysHandler(object):
+    def __init__(self, hs):
+        self.store = hs.get_datastore()
+
+    @defer.inlineCallbacks
+    def get_room_keys(self, user_id, version, room_id, session_id):
+        results = yield self.store.get_e2e_room_keys(user_id, version, room_id, session_id)
+        defer.returnValue(results)
+
+    @defer.inlineCallbacks
+    def upload_room_keys(self, user_id, version, room_keys):
+
+        # TODO: Validate the JSON to make sure it has the right keys.
+
+        # go through the room_keys
+        for room_id in room_keys['rooms']:
+            for session_id in room_keys['rooms'][room_id]['sessions']:
+                session = room_keys['rooms'][room_id]['sessions'][session_id]
+
+                # get a lock
+
+                # get the room_key for this particular row
+                yield self.store.get_e2e_room_key()
+
+                # check whether we merge or not
+                if()
+
+                # if so, we set it
+                yield self.store.set_e2e_room_key()
+
+                # release the lock

synapse/rest/client/v2_alpha/room_keys.py

@@ -0,0 +1,56 @@
+# -*- coding: utf-8 -*-
+# Copyright 2017 New Vector Ltd
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import logging
+
+from twisted.internet import defer
+
+from synapse.api.errors import SynapseError
+from synapse.http.servlet import (
+    RestServlet, parse_json_object_from_request, parse_integer
+)
+from synapse.http.servlet import parse_string
+from synapse.types import StreamToken
+from ._base import client_v2_patterns
+
+logger = logging.getLogger(__name__)
+
+
+class RoomKeysUploadServlet(RestServlet):
+    PATTERNS = client_v2_patterns("/room_keys/keys(/(?P<room_id>[^/]+))?(/(?P<session_id>[^/]+))?$")
+
+    def __init__(self, hs):
+        """
+        Args:
+            hs (synapse.server.HomeServer): server
+        """
+        super(RoomKeysUploadServlet, self).__init__()
+        self.auth = hs.get_auth()
+        self.e2e_room_keys_handler = hs.get_e2e_room_keys_handler()
+
+    @defer.inlineCallbacks
+    def on_POST(self, request, room_id, session_id):
+        requester = yield self.auth.get_user_by_req(request, allow_guest=True)
+        user_id = requester.user.to_string()
+        body = parse_json_object_from_request(request)
+
+        result = yield self.e2e_room_keys_handler.upload_room_keys(
+            user_id, version, body
+        )
+        defer.returnValue((200, result))
+
+
+def register_servlets(hs, http_server):
+    RoomKeysUploadServlet(hs).register(http_server)

synapse/storage/e2e_room_keys.py

@@ -0,0 +1,133 @@
+# -*- coding: utf-8 -*-
+# Copyright 2017 New Vector Ltd
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from twisted.internet import defer
+
+from synapse.util.caches.descriptors import cached
+
+from canonicaljson import encode_canonical_json
+import ujson as json
+
+from ._base import SQLBaseStore
+
+
+class EndToEndRoomKeyStore(SQLBaseStore):
+
+    @defer.inlineCallbacks
+    def get_e2e_room_key(self, user_id, version, room_id, session_id):
+
+        row = yield self._simple_select_one(
+            table="e2e_room_keys",
+            keyvalues={
+                "user_id": user_id,
+                "version": version,
+                "room_id": room_id,
+                "session_id": session_id,
+            },
+            retcols=(
+                "first_message_index",
+                "forwarded_count",
+                "is_verified",
+                "session_data",
+            ),
+            desc="get_e2e_room_key",
+        )
+
+        defer.returnValue(row);
+
+    def set_e2e_room_key(self, user_id, version, room_id, session_id, room_key):
+
+        def _set_e2e_room_key_txn(txn):
+
+            self._simple_upsert(
+                txn,
+                table="e2e_room_keys",
+                keyvalues={
+                    "user_id": user_id,
+                    "room_id": room_id,
+                    "session_id": session_id,   
+                }
+                values=[
+                    {
+                        "version": version,
+                        "first_message_index": room_key['first_message_index'],
+                        "forwarded_count": room_key['forwarded_count'],
+                        "is_verified": room_key['is_verified'],
+                        "session_data": room_key['session_data'],
+                    }
+                ],
+                lock=False,
+            )
+
+            return True
+
+        return self.runInteraction(
+            "set_e2e_room_key", _set_e2e_room_key_txn
+        )
+
+
+    def set_e2e_room_keys(self, user_id, version, room_keys):
+
+        def _set_e2e_room_keys_txn(txn):
+
+            self._simple_insert_many_txn(
+                txn,
+                table="e2e_room_keys",
+                values=[
+                    {
+                        "user_id": user_id,
+                        "room_id": room_id,
+                        "session_id": session_id,
+                        "version": version,
+                        "first_message_index": room_keys['rooms'][room_id]['sessions'][session_id]['first_message_index'],
+                        "forwarded_count": room_keys['rooms'][room_id]['sessions'][session_id]['forwarded_count'],
+                        "is_verified": room_keys['rooms'][room_id]['sessions'][session_id]['is_verified'],
+                        "session_data": room_keys['rooms'][room_id]['sessions'][session_id]['session_data'],
+                    }
+                    for session_id in room_keys['rooms'][room_id]['sessions']
+                    for room_id in room_keys['rooms']
+                ]
+            )
+
+            return True
+
+        return self.runInteraction(
+            "set_e2e_room_keys", _set_e2e_room_keys_txn
+        )
+
+    @defer.inlineCallbacks
+    def get_e2e_room_keys(self, user_id, version, room_id, session_id):
+
+        keyvalues={
+            "user_id": user_id,
+            "version": version,
+        }
+        if room_id: keyvalues['room_id'] = room_id
+        if session_id: keyvalues['session_id'] = session_id
+
+        rows = yield self._simple_select_list(
+            table="e2e_room_keys",
+            keyvalues=keyvalues,
+            retcols=(
+                "first_message_index",
+                "forwarded_count",
+                "is_verified",
+                "session_data",
+            ),
+            desc="get_e2e_room_keys",
+        )
+
+        sessions = {}
+        sessions['rooms'][roomId]['sessions'][session_id] = row for row in rows;
+        defer.returnValue(sessions);

synapse/storage/schema/delta/46/e2e_room_keys.sql

@@ -0,0 +1,40 @@
+/* Copyright 2017 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+-- users' optionally backed up encrypted e2e sessions
+CREATE TABLE e2e_room_keys (
+    user_id TEXT NOT NULL,
+    room_id TEXT NOT NULL,
+    session_id TEXT NOT NULL,
+    version INT NOT NULL,
+    first_message_index INT,
+    forwarded_count INT,
+    is_verified BOOLEAN,
+    session_data TEXT NOT NULL
+);
+
+CREATE UNIQUE INDEX e2e_room_keys_user_idx ON e2e_room_keys(user_id);
+CREATE UNIQUE INDEX e2e_room_keys_room_idx ON e2e_room_keys(room_id);
+CREATE UNIQUE INDEX e2e_room_keys_session_idx ON e2e_room_keys(session_id);
+
+-- the versioning metadata about versions of users' encrypted e2e session backups
+CREATE TABLE e2e_room_key_versions (
+    user_id TEXT NOT NULL,
+    version INT NOT NULL,
+    algorithm TEXT NOT NULL,
+    dummy_session_data TEXT NOT NULL
+);
+
+CREATE UNIQUE INDEX e2e_room_key_user_idx ON e2e_room_keys(user_id);