Manu review: use signObject() everywhere it can be used

matrix-org · Dec 7, 2018 · 038dd3f · 038dd3f
1 parent 014599b
commit 038dd3f
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 36 deletions.
diff --git a/matrix-sdk/src/androidTest/java/org/matrix/androidsdk/common/CryptoTestHelper.kt b/matrix-sdk/src/androidTest/java/org/matrix/androidsdk/common/CryptoTestHelper.kt
@@ -374,7 +374,7 @@ class CryptoTestHelper(val mTestHelper: CommonTestHelper) {
     fun createFakeMegolmBackupAuthData(): MegolmBackupAuthData {
         return MegolmBackupAuthData(
                 publicKey = "abcdefg",
-                signatures = HashMap<String, Any>().apply {
+                signatures = HashMap<String, Map<String, String>>().apply {
                     this["something"] = HashMap<String, String>().apply {
                         this["ed25519:something"] = "hijklmnop"
                     }

diff --git a/matrix-sdk/src/main/java/org/matrix/androidsdk/crypto/MXCrypto.java b/matrix-sdk/src/main/java/org/matrix/androidsdk/crypto/MXCrypto.java
@@ -1513,17 +1513,25 @@ public Map<String, Object> encryptMessage(Map<String, Object> payloadFields, Lis
 
     /**
      * Sign Object
-     * // TODO Also use this method internally
+     * <p>
+     * Example:
+     * <pre>
+     *     {
+     *         "[MY_USER_ID]": {
+     *             "ed25519:[MY_DEVICE_ID]": "sign(str)"
+     *         }
+     *     }
+     * </pre>
      *
-     * @param str
-     * @return
+     * @param strToSign the String to sign and to include in the Map
+     * @return a Map (see example)
      */
-    public Map<String, Object> signObject(String str) {
-        Map<String, Object> result = new HashMap<>();
+    public Map<String, Map<String, String>> signObject(String strToSign) {
+        Map<String, Map<String, String>> result = new HashMap<>();
 
-        Map<String, Object> content = new HashMap<>();
+        Map<String, String> content = new HashMap<>();
 
-        content.put("ed25519:" + mMyDevice.deviceId, mOlmDevice.signMessage(str));
+        content.put("ed25519:" + mMyDevice.deviceId, mOlmDevice.signMessage(strToSign));
 
         result.put(mMyDevice.userId, content);
 
@@ -1864,15 +1872,7 @@ public void run() {
     private void uploadDeviceKeys(ApiCallback<KeysUploadResponse> callback) {
         // Prepare the device keys data to send
         // Sign it
-        String signature = mOlmDevice.signJSON(mMyDevice.signalableJSONDictionary());
-
-        Map<String, String> submap = new HashMap<>();
-        submap.put("ed25519:" + mMyDevice.deviceId, signature);
-
-        Map<String, Map<String, String>> map = new HashMap<>();
-        map.put(mSession.getMyUserId(), submap);
-
-        mMyDevice.signatures = map;
+        mMyDevice.signatures = signObject(JsonUtils.getCanonicalizedJsonString(mMyDevice.signalableJSONDictionary()));
 
         // For now, we set the device id explicitly, as we may not be using the
         // same one as used in login.
@@ -2156,13 +2156,7 @@ private void uploadOneTimeKeys(final ApiCallback<KeysUploadResponse> callback) {
                 k.put("key", curve25519Map.get(key_id));
 
                 // the key is also signed
-                String signature = mOlmDevice.signJSON(k);
-                Map<String, String> submap = new HashMap<>();
-                submap.put("ed25519:" + mMyDevice.deviceId, signature);
-
-                Map<String, Map<String, String>> map = new HashMap<>();
-                map.put(mSession.getMyUserId(), submap);
-                k.put("signatures", map);
+                k.put("signatures", signObject(JsonUtils.getCanonicalizedJsonString(k)));
 
                 oneTimeJson.put("signed_curve25519:" + key_id, k);
             }

diff --git a/matrix-sdk/src/main/java/org/matrix/androidsdk/crypto/MXOlmDevice.java b/matrix-sdk/src/main/java/org/matrix/androidsdk/crypto/MXOlmDevice.java
@@ -172,17 +172,6 @@ public String signMessage(String message) {
         return null;
     }
 
-    /**
-     * Signs a JSON dictionary with the ed25519 key for this account.
-     * The signature is done on canonical version of the JSON.
-     *
-     * @param JSONDictionary the JSON to be signed.
-     * @return the base64-encoded signature
-     */
-    public String signJSON(Map<String, Object> JSONDictionary) {
-        return signMessage(JsonUtils.getCanonicalizedJsonString(JSONDictionary));
-    }
-
     /**
      * @return The current (unused, unpublished) one-time keys for this account.
      */

diff --git a/matrix-sdk/src/main/java/org/matrix/androidsdk/crypto/keysbackup/MegolmBackupAuthData.kt b/matrix-sdk/src/main/java/org/matrix/androidsdk/crypto/keysbackup/MegolmBackupAuthData.kt
@@ -32,7 +32,7 @@ data class MegolmBackupAuthData(
         /**
          * Signatures of the public key.
          */
-        val signatures: MutableMap<String, Any>? = null
+        val signatures: Map<String, Map<String, String>>? = null
 ) {
     /**
      * Same as the parent [MXJSONModel JSONDictionary] but return only