start working on Sync example (reply to to_device messages)

[matrix_esp_thesis] / src / matrix.h

diff --git a/src/matrix.h b/src/matrix.h
index 60561aa04087d4c0c81d5881a9a235e216120e18..da0e85930b726169adbcd3fd0dcbe663b58f884f 100644 (file)
--- a/src/matrix.h
+++ b/src/matrix.h
@@ -11,49 +11,87 @@
 \r
 \r
 #define USER_ID_SIZE 64\r
 \r
 \r
 #define USER_ID_SIZE 64\r

+#define ROOM_ID_SIZE 128\r

 #define SERVER_SIZE 20\r
 #define ACCESS_TOKEN_SIZE 40\r
 #define DEVICE_ID_SIZE 20\r
 #define EXPIRE_MS_SIZE 20\r
 #define REFRESH_TOKEN_SIZE 20\r
 #define SERVER_SIZE 20\r
 #define ACCESS_TOKEN_SIZE 40\r
 #define DEVICE_ID_SIZE 20\r
 #define EXPIRE_MS_SIZE 20\r
 #define REFRESH_TOKEN_SIZE 20\r

-#define MAX_URL_LEN 128\r
+#define MAX_URL_LEN 1024\r

 \r
 #define OLM_IDENTITY_KEYS_JSON_SIZE 128\r
 #define DEVICE_KEY_SIZE 44\r
 #define SIGNING_KEY_SIZE 44\r
 \r
 #define OLM_IDENTITY_KEYS_JSON_SIZE 128\r
 #define DEVICE_KEY_SIZE 44\r
 #define SIGNING_KEY_SIZE 44\r

+#define ONETIME_KEY_SIZE 44\r

 \r
 #define KEY_SHARE_EVENT_LEN 1024\r
 \r
 #define OLM_ACCOUNT_MEMORY_SIZE 7528\r
 \r
 #define KEY_SHARE_EVENT_LEN 1024\r
 \r
 #define OLM_ACCOUNT_MEMORY_SIZE 7528\r

-#define OLM_ACCOUNT_RANDOM_SIZE 32+32\r
+#define OLM_ACCOUNT_RANDOM_SIZE (32+32)\r

 \r
 #define OLM_SESSION_MEMORY_SIZE 3352\r
 #define OLM_ENCRYPT_RANDOM_SIZE 32\r
 \r
 #define OLM_SESSION_MEMORY_SIZE 3352\r
 #define OLM_ENCRYPT_RANDOM_SIZE 32\r

+#define OLM_OUTBOUND_SESSION_RANDOM_SIZE (32*2)\r
+\r
+#define OLM_ONETIME_KEYS_RANDOM_SIZE (32*10)\r
+#define OLM_KEY_ID_SIZE 32\r
+\r
+#define OLM_SIGNATURE_SIZE 128\r

 \r
 #define MEGOLM_OUTBOUND_SESSION_MEMORY_SIZE 232\r
 #define MEGOLM_SESSION_ID_SIZE 44\r
 #define MEGOLM_SESSION_KEY_SIZE 306\r
 #define MEGOLM_INIT_RANDOM_SIZE (4*32 + 32)\r
 \r
 \r
 #define MEGOLM_OUTBOUND_SESSION_MEMORY_SIZE 232\r
 #define MEGOLM_SESSION_ID_SIZE 44\r
 #define MEGOLM_SESSION_KEY_SIZE 306\r
 #define MEGOLM_INIT_RANDOM_SIZE (4*32 + 32)\r
 \r

+#define JSON_ONETIME_KEY_SIZE 128\r
+#define JSON_ONETIME_KEY_SIGNED_SIZE 256\r
+#define JSON_SIGNATURE_SIZE 256\r
+\r

 #define NUM_MEGOLM_SESSIONS 10\r
 #define NUM_OLM_SESSIONS 10\r
 #define NUM_DEVICES 10\r
 \r
 #define NUM_MEGOLM_SESSIONS 10\r
 #define NUM_OLM_SESSIONS 10\r
 #define NUM_DEVICES 10\r
 \r

-void\r
-Randomize(uint8_t * random, int randomLen);\r
-\r
-bool\r
-JsonEscape(\r
-    char * sIn, int sInLen,\r
-    char * sOut, int sOutCap);\r
+// Matrix Device\r

 \r
 typedef struct MatrixDevice {\r
     char deviceId[DEVICE_ID_SIZE];\r
     char deviceKey[DEVICE_KEY_SIZE];\r
 \r
 typedef struct MatrixDevice {\r
     char deviceId[DEVICE_ID_SIZE];\r
     char deviceKey[DEVICE_KEY_SIZE];\r

+    char signingKey[SIGNING_KEY_SIZE];\r

 } MatrixDevice;\r
 \r
 } MatrixDevice;\r
 \r

+\r
+// Matrix Olm Account\r
+\r
+typedef struct MatrixOlmAccount {\r
+    OlmAccount * account;\r
+    char memory[OLM_ACCOUNT_MEMORY_SIZE];\r
+} MatrixOlmAccount;\r
+\r
+bool\r
+MatrixOlmAccountInit(\r
+    MatrixOlmAccount * account);\r
+\r
+bool\r
+MatrixOlmAccountUnpickle(\r
+    MatrixOlmAccount * account,\r
+    void * pickled, int pickledLen,\r
+    const void * key, int keyLen);\r
+\r
+bool\r
+MatrixOlmAccountGetDeviceKey(\r
+    MatrixOlmAccount * account,\r
+    char * key, int keyCap);\r
+    \r
+bool\r
+MatrixOlmAccountGetSigningKey(\r
+    MatrixOlmAccount * account,\r
+    char * key, int keyCap);\r
+\r
+\r
+// Matrix Olm Session\r
+\r

 typedef struct MatrixOlmSession {\r
 typedef struct MatrixOlmSession {\r

-    const char * deviceId;\r
+    const char * deviceId; // TODO: char[]\r

 \r
     int type;\r
     OlmSession * session;\r
 \r
     int type;\r
     OlmSession * session;\r


@@ -61,9 +99,19 @@ typedef struct MatrixOlmSession {
 } MatrixOlmSession;\r
 \r
 bool\r
 } MatrixOlmSession;\r
 \r
 bool\r

-MatrixOlmSessionInit(\r
+MatrixOlmSessionUnpickle(\r

     MatrixOlmSession * session,\r
     MatrixOlmSession * session,\r

-    const char * deviceId);\r
+    const char * deviceId,\r
+    void * pickled, int pickledLen,\r
+    const void * key, int keyLen);\r
+\r
+bool\r
+MatrixOlmSessionTo(\r
+    MatrixOlmSession * session,\r
+    OlmAccount * olmAccount,\r
+    const char * deviceId,\r
+    const char * deviceKey,\r
+    const char * deviceOnetimeKey);\r

 \r
 bool\r
 MatrixOlmSessionEncrypt(\r
 \r
 bool\r
 MatrixOlmSessionEncrypt(\r


@@ -71,14 +119,28 @@ MatrixOlmSessionEncrypt(
     const char * plaintext,\r
     char * outBuffer, int outBufferCap);\r
 \r
     const char * plaintext,\r
     char * outBuffer, int outBufferCap);\r
 \r

+bool\r
+MatrixOlmSessionDecrypt(\r
+    MatrixOlmSession * session,\r
+    size_t messageType,\r
+    char * encrypted,\r
+    char * outBuffer, int outBufferCap);\r

 \r
 \r
 \r
 \r

+// Matrix Megolm Session\r
+\r

 typedef struct MatrixMegolmInSession {\r
     OlmInboundGroupSession * session;\r
 } MatrixMegolmInSession;\r
 \r
 typedef struct MatrixMegolmInSession {\r
     OlmInboundGroupSession * session;\r
 } MatrixMegolmInSession;\r
 \r

+bool\r
+MatrixMegolmInSessionDecrypt(\r
+    MatrixMegolmInSession * megolmInSession,\r
+    const char * encrypted,\r
+    char * outDecrypted, int outDecryptedCap);\r
+\r

 typedef struct MatrixMegolmOutSession {\r
 typedef struct MatrixMegolmOutSession {\r

-    const char * roomId;\r
+    char roomId[ROOM_ID_SIZE];\r

 \r
     OlmOutboundGroupSession * session;\r
     char memory[MEGOLM_OUTBOUND_SESSION_MEMORY_SIZE];\r
 \r
     OlmOutboundGroupSession * session;\r
     char memory[MEGOLM_OUTBOUND_SESSION_MEMORY_SIZE];\r


@@ -91,18 +153,30 @@ bool
 MatrixMegolmOutSessionInit(\r
     MatrixMegolmOutSession * session,\r
     const char * roomId);\r
 MatrixMegolmOutSessionInit(\r
     MatrixMegolmOutSession * session,\r
     const char * roomId);\r

-    \r
+\r

 bool\r
 MatrixMegolmOutSessionEncrypt(\r
     MatrixMegolmOutSession * session,\r
     const char * plaintext,\r
     char * outBuffer, int outBufferCap);\r
 \r
 bool\r
 MatrixMegolmOutSessionEncrypt(\r
     MatrixMegolmOutSession * session,\r
     const char * plaintext,\r
     char * outBuffer, int outBufferCap);\r
 \r

+bool\r
+MatrixMegolmOutSessionSave(\r
+    MatrixMegolmOutSession * session,\r
+    const char * filename,\r
+    const char * key);\r
+    \r
+bool\r
+MatrixMegolmOutSessionLoad(\r
+    MatrixMegolmOutSession * session,\r
+    const char * filename,\r
+    const char * key);\r
+\r

 \r
 \r

+// Matrix Client\r

 \r
 typedef struct MatrixClient {\r
 \r
 typedef struct MatrixClient {\r

-    OlmAccount * olmAccount;\r
-    char olmAccountMemory[OLM_ACCOUNT_MEMORY_SIZE];\r
+    MatrixOlmAccount olmAccount;\r

 \r
     MatrixMegolmInSession megolmInSessions[NUM_MEGOLM_SESSIONS];\r
     int numMegolmInSessions;\r
 \r
     MatrixMegolmInSession megolmInSessions[NUM_MEGOLM_SESSIONS];\r
     int numMegolmInSessions;\r


@@ -114,8 +188,8 @@ typedef struct MatrixClient {
     MatrixDevice devices[NUM_DEVICES];\r
     int numDevices;\r
     \r
     MatrixDevice devices[NUM_DEVICES];\r
     int numDevices;\r
     \r

-    char deviceKey[DEVICE_KEY_SIZE];\r
-    char signingKey[DEVICE_KEY_SIZE];\r
+    // char deviceKey[DEVICE_KEY_SIZE];\r
+    // char signingKey[DEVICE_KEY_SIZE];\r

 \r
     char userId[USER_ID_SIZE];\r
     char server[SERVER_SIZE];\r
 \r
     char userId[USER_ID_SIZE];\r
     char server[SERVER_SIZE];\r


@@ -132,6 +206,16 @@ MatrixClientInit(
     MatrixClient * client,\r
     const char * server);\r
 \r
     MatrixClient * client,\r
     const char * server);\r
 \r

+bool\r
+MatrixClientSave(\r
+    MatrixClient * client,\r
+    const char * filename);\r
+\r
+bool\r
+MatrixClientLoad(\r
+    MatrixClient * client,\r
+    const char * filename);\r
+\r

 bool\r
 MatrixClientSetAccessToken(\r
     MatrixClient * client,\r
 bool\r
 MatrixClientSetAccessToken(\r
     MatrixClient * client,\r


@@ -142,6 +226,31 @@ MatrixClientSetDeviceId(
     MatrixClient * client,\r
     const char * deviceId);\r
 \r
     MatrixClient * client,\r
     const char * deviceId);\r
 \r

+bool\r
+MatrixClientSetUserId(\r
+    MatrixClient * client,\r
+    const char * userId);\r
+\r
+bool\r
+MatrixClientGenerateOnetimeKeys(\r
+    MatrixClient * client,\r
+    int numberOfKeys);\r
+\r
+bool\r
+MatrixClientUploadOnetimeKeys(\r
+    MatrixClient * client);\r
+\r
+bool\r
+MatrixClientUploadDeviceKey(\r
+    MatrixClient * client);\r
+\r
+bool\r
+MatrixClientClaimOnetimeKey(\r
+    MatrixClient * client,\r
+    const char * userId,\r
+    const char * deviceId,\r
+    char * outOnetimeKey, int outOnetimeKeyCap);\r
+\r

 bool\r
 MatrixClientLoginPassword(\r
     MatrixClient * client,\r
 bool\r
 MatrixClientLoginPassword(\r
     MatrixClient * client,\r


@@ -166,11 +275,27 @@ MatrixClientSendEventEncrypted(
 bool\r
 MatrixClientSync(\r
     MatrixClient * client,\r
 bool\r
 MatrixClientSync(\r
     MatrixClient * client,\r

-    char * outSyncBuffer, int outSyncCap);\r
+    char * outSync, int outSyncCap,\r
+    const char * nextBatch);\r
+\r
+bool\r
+MatrixClientGetRoomEvent(\r
+    MatrixClient * client,\r
+    const char * roomId,\r
+    const char * eventId,\r
+    char * outEvent, int outEventCap);\r

 \r
 bool\r
 MatrixClientShareMegolmOutSession(\r
     MatrixClient * client,\r
 \r
 bool\r
 MatrixClientShareMegolmOutSession(\r
     MatrixClient * client,\r

+    const char * userId,\r
+    const char * deviceId,\r
+    MatrixMegolmOutSession * session);\r
+\r
+bool\r
+MatrixClientShareMegolmOutSessionTest(\r
+    MatrixClient * client,\r
+    const char * userId,\r

     const char * deviceId,\r
     MatrixMegolmOutSession * session);\r
 \r
     const char * deviceId,\r
     MatrixMegolmOutSession * session);\r
 \r


@@ -186,9 +311,25 @@ MatrixClientSetMegolmOutSession(
     const char * roomId,\r
     MatrixMegolmOutSession session);\r
 \r
     const char * roomId,\r
     MatrixMegolmOutSession session);\r
 \r

+bool\r
+MatrixClientInitMegolmOutSession(\r
+    MatrixClient * client,\r
+    const char * roomId);\r
+    \r
+bool\r
+MatrixClientRequestMegolmInSession(\r
+    MatrixClient * client,\r
+    const char * roomId,\r
+    const char * sessionId,\r
+    const char * senderKey,\r
+    const char * userId,\r
+    const char * deviceId, // TODO: remove deviceId (query all devices)\r
+    MatrixMegolmInSession * outMegolmInSession);\r
+\r

 bool\r
 MatrixClientGetOlmSession(\r
     MatrixClient * client,\r
 bool\r
 MatrixClientGetOlmSession(\r
     MatrixClient * client,\r

+    const char * userId,\r

     const char * deviceId,\r
     MatrixOlmSession ** outSession);\r
 \r
     const char * deviceId,\r
     MatrixOlmSession ** outSession);\r
 \r


@@ -209,27 +350,42 @@ MatrixClientSendToDeviceEncrypted(
     const char * msgType);\r
 \r
 bool\r
     const char * msgType);\r
 \r
 bool\r

-MatrixClientGetDeviceKey(\r
+MatrixClientSendDummy(\r

     MatrixClient * client,\r
     MatrixClient * client,\r

-    const char * deviceId,\r
-    char * outDeviceKey, int outDeviceKeyCap);\r
+    const char * userId,\r
+    const char * deviceId);\r

 \r
 bool\r
 \r
 bool\r

-MatrixClientGetDeviceKey(\r
+MatrixClientRequestDeviceKey(\r

     MatrixClient * client,\r
     const char * deviceId,\r
     char * outDeviceKey, int outDeviceKeyCap);\r
     MatrixClient * client,\r
     const char * deviceId,\r
     char * outDeviceKey, int outDeviceKeyCap);\r

+    \r
+bool\r
+MatrixClientRequestSigningKey(\r
+    MatrixClient * client,\r
+    const char * deviceId,\r
+    char * outSigningKey, int outSigningKeyCap);\r

 \r
 bool\r
 MatrixClientRequestDeviceKeys(\r
     MatrixClient * client);\r
 \r
 \r
 bool\r
 MatrixClientRequestDeviceKeys(\r
     MatrixClient * client);\r
 \r

+bool\r
+MatrixClientDeleteDevice(\r
+    MatrixClient * client);\r
+\r
+\r

 \r
 \r
 bool\r
 MatrixHttpInit(\r
     MatrixClient * client);\r
 \r
 \r
 \r
 bool\r
 MatrixHttpInit(\r
     MatrixClient * client);\r
 \r

+bool\r
+MatrixHttpConnect(\r
+    MatrixClient * client);\r
+\r

 bool\r
 MatrixHttpDeinit(\r
     MatrixClient * client);\r
 bool\r
 MatrixHttpDeinit(\r
     MatrixClient * client);\r


@@ -257,4 +413,20 @@ MatrixHttpPut(
     char * outResponseBuffer, int outResponseCap,\r
     bool authenticated);\r
 \r
     char * outResponseBuffer, int outResponseCap,\r
     bool authenticated);\r
 \r

+// util\r
+\r
+void\r
+Randomize(uint8_t * random, int randomLen);\r
+\r
+bool\r
+JsonEscape(\r
+    const char * sIn, int sInLen,\r
+    char * sOut, int sOutCap);\r
+    \r
+bool\r
+JsonSign(\r
+    MatrixClient * client,\r
+    const char * sIn, int sInLen,\r
+    char * sOut, int sOutCap);\r
+\r

 #endif\r
 #endif\r