matrix-js-sdk 41.8.0 → 41.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (458) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/README.md +1 -1
  3. package/lib/@types/AESEncryptedSecretStoragePayload.js +3 -1
  4. package/lib/@types/IIdentityServerProvider.js +3 -1
  5. package/lib/@types/PushRules.js +7 -7
  6. package/lib/@types/PushRules.js.map +1 -1
  7. package/lib/@types/auth.js +4 -4
  8. package/lib/@types/auth.js.map +1 -1
  9. package/lib/@types/beacon.js +2 -2
  10. package/lib/@types/beacon.js.map +1 -1
  11. package/lib/@types/common.js +3 -1
  12. package/lib/@types/crypto.js +3 -1
  13. package/lib/@types/event.js +20 -20
  14. package/lib/@types/event.js.map +1 -1
  15. package/lib/@types/events.js +3 -1
  16. package/lib/@types/extensible_events.js +6 -6
  17. package/lib/@types/extensible_events.js.map +1 -1
  18. package/lib/@types/global.d.js.map +1 -1
  19. package/lib/@types/json.js +3 -1
  20. package/lib/@types/local_notifications.js +3 -1
  21. package/lib/@types/location.js +4 -4
  22. package/lib/@types/location.js.map +1 -1
  23. package/lib/@types/matrix-sdk-crypto-wasm.d.js +3 -1
  24. package/lib/@types/media.js +3 -1
  25. package/lib/@types/membership.js +1 -1
  26. package/lib/@types/membership.js.map +1 -1
  27. package/lib/@types/partials.js +6 -6
  28. package/lib/@types/partials.js.map +1 -1
  29. package/lib/@types/polls.js +5 -5
  30. package/lib/@types/polls.js.map +1 -1
  31. package/lib/@types/read_receipts.js +2 -2
  32. package/lib/@types/read_receipts.js.map +1 -1
  33. package/lib/@types/registration.js +3 -1
  34. package/lib/@types/requests.js +1 -1
  35. package/lib/@types/requests.js.map +1 -1
  36. package/lib/@types/retention.js +1 -1
  37. package/lib/@types/retention.js.map +1 -1
  38. package/lib/@types/search.js +1 -1
  39. package/lib/@types/search.js.map +1 -1
  40. package/lib/@types/signed.js +3 -1
  41. package/lib/@types/spaces.js +3 -1
  42. package/lib/@types/state_events.js +3 -1
  43. package/lib/@types/synapse.js +3 -1
  44. package/lib/@types/sync.js +1 -1
  45. package/lib/@types/sync.js.map +1 -1
  46. package/lib/@types/threepids.js +1 -1
  47. package/lib/@types/threepids.js.map +1 -1
  48. package/lib/@types/topic.js +1 -1
  49. package/lib/@types/topic.js.map +1 -1
  50. package/lib/@types/uia.js +3 -1
  51. package/lib/NamespacedValue.js +8 -8
  52. package/lib/NamespacedValue.js.map +1 -1
  53. package/lib/ReEmitter.js +9 -16
  54. package/lib/ReEmitter.js.map +1 -1
  55. package/lib/ToDeviceMessageQueue.js +49 -57
  56. package/lib/ToDeviceMessageQueue.js.map +1 -1
  57. package/lib/autodiscovery.js +232 -247
  58. package/lib/autodiscovery.js.map +1 -1
  59. package/lib/base64.js +1 -1
  60. package/lib/base64.js.map +1 -1
  61. package/lib/browser-index.d.ts +2 -2
  62. package/lib/browser-index.d.ts.map +1 -1
  63. package/lib/browser-index.js +5 -5
  64. package/lib/browser-index.js.map +1 -1
  65. package/lib/capabilityPoller.js +19 -22
  66. package/lib/capabilityPoller.js.map +1 -1
  67. package/lib/client.d.ts +2 -8
  68. package/lib/client.d.ts.map +1 -1
  69. package/lib/client.js +2043 -2487
  70. package/lib/client.js.map +1 -1
  71. package/lib/common-crypto/CryptoBackend.js +2 -2
  72. package/lib/common-crypto/CryptoBackend.js.map +1 -1
  73. package/lib/common-crypto/key-passphrase.js.map +1 -1
  74. package/lib/content-helpers.js +43 -48
  75. package/lib/content-helpers.js.map +1 -1
  76. package/lib/content-repo.js +14 -24
  77. package/lib/content-repo.js.map +1 -1
  78. package/lib/crypto/store/base.js +6 -6
  79. package/lib/crypto/store/base.js.map +1 -1
  80. package/lib/crypto/store/indexeddb-crypto-store-backend.js +190 -238
  81. package/lib/crypto/store/indexeddb-crypto-store-backend.js.map +1 -1
  82. package/lib/crypto/store/indexeddb-crypto-store.js +25 -30
  83. package/lib/crypto/store/indexeddb-crypto-store.js.map +1 -1
  84. package/lib/crypto/store/localStorage-crypto-store.js +113 -145
  85. package/lib/crypto/store/localStorage-crypto-store.js.map +1 -1
  86. package/lib/crypto/store/memory-crypto-store.js +74 -105
  87. package/lib/crypto/store/memory-crypto-store.js.map +1 -1
  88. package/lib/crypto-api/CryptoEvent.js +1 -1
  89. package/lib/crypto-api/CryptoEvent.js.map +1 -1
  90. package/lib/crypto-api/CryptoEventHandlerMap.js +3 -1
  91. package/lib/crypto-api/index.d.ts +15 -6
  92. package/lib/crypto-api/index.d.ts.map +1 -1
  93. package/lib/crypto-api/index.js +22 -22
  94. package/lib/crypto-api/index.js.map +1 -1
  95. package/lib/crypto-api/key-passphrase.js +15 -23
  96. package/lib/crypto-api/key-passphrase.js.map +1 -1
  97. package/lib/crypto-api/keybackup.js +3 -1
  98. package/lib/crypto-api/recovery-key.js +11 -12
  99. package/lib/crypto-api/recovery-key.js.map +1 -1
  100. package/lib/crypto-api/verification.js +3 -3
  101. package/lib/crypto-api/verification.js.map +1 -1
  102. package/lib/digest.js +7 -14
  103. package/lib/digest.js.map +1 -1
  104. package/lib/embedded.d.ts.map +1 -1
  105. package/lib/embedded.js +380 -505
  106. package/lib/embedded.js.map +1 -1
  107. package/lib/errors.js +2 -2
  108. package/lib/errors.js.map +1 -1
  109. package/lib/event-mapper.js +10 -12
  110. package/lib/event-mapper.js.map +1 -1
  111. package/lib/extensible_events_v1/ExtensibleEvent.js.map +1 -1
  112. package/lib/extensible_events_v1/InvalidEventError.js.map +1 -1
  113. package/lib/extensible_events_v1/MessageEvent.js +11 -13
  114. package/lib/extensible_events_v1/MessageEvent.js.map +1 -1
  115. package/lib/extensible_events_v1/PollEndEvent.js +3 -4
  116. package/lib/extensible_events_v1/PollEndEvent.js.map +1 -1
  117. package/lib/extensible_events_v1/PollResponseEvent.js +5 -6
  118. package/lib/extensible_events_v1/PollResponseEvent.js.map +1 -1
  119. package/lib/extensible_events_v1/PollStartEvent.js +8 -10
  120. package/lib/extensible_events_v1/PollStartEvent.js.map +1 -1
  121. package/lib/extensible_events_v1/utilities.js.map +1 -1
  122. package/lib/feature.js +18 -31
  123. package/lib/feature.js.map +1 -1
  124. package/lib/filter-component.d.ts.map +1 -1
  125. package/lib/filter-component.js +20 -26
  126. package/lib/filter-component.js.map +1 -1
  127. package/lib/filter.js +14 -17
  128. package/lib/filter.js.map +1 -1
  129. package/lib/http-api/errors.js +28 -43
  130. package/lib/http-api/errors.js.map +1 -1
  131. package/lib/http-api/fetch.js +141 -159
  132. package/lib/http-api/fetch.js.map +1 -1
  133. package/lib/http-api/index.js +17 -20
  134. package/lib/http-api/index.js.map +1 -1
  135. package/lib/http-api/interface.js +1 -1
  136. package/lib/http-api/interface.js.map +1 -1
  137. package/lib/http-api/method.js +1 -1
  138. package/lib/http-api/method.js.map +1 -1
  139. package/lib/http-api/prefix.js +3 -3
  140. package/lib/http-api/prefix.js.map +1 -1
  141. package/lib/http-api/refresh.js +74 -94
  142. package/lib/http-api/refresh.js.map +1 -1
  143. package/lib/http-api/utils.d.ts +1 -1
  144. package/lib/http-api/utils.d.ts.map +1 -1
  145. package/lib/http-api/utils.js +34 -42
  146. package/lib/http-api/utils.js.map +1 -1
  147. package/lib/index.js.map +1 -1
  148. package/lib/indexeddb-helpers.js +3 -3
  149. package/lib/indexeddb-helpers.js.map +1 -1
  150. package/lib/indexeddb-worker.js.map +1 -1
  151. package/lib/interactive-auth.d.ts +5 -5
  152. package/lib/interactive-auth.d.ts.map +1 -1
  153. package/lib/interactive-auth.js +172 -204
  154. package/lib/interactive-auth.js.map +1 -1
  155. package/lib/logger.js +21 -57
  156. package/lib/logger.js.map +1 -1
  157. package/lib/matrix.js +7 -11
  158. package/lib/matrix.js.map +1 -1
  159. package/lib/matrixrtc/CallMembership.js +80 -74
  160. package/lib/matrixrtc/CallMembership.js.map +1 -1
  161. package/lib/matrixrtc/EncryptionManager.js +1 -1
  162. package/lib/matrixrtc/EncryptionManager.js.map +1 -1
  163. package/lib/matrixrtc/IKeyTransport.js +1 -1
  164. package/lib/matrixrtc/IKeyTransport.js.map +1 -1
  165. package/lib/matrixrtc/IMembershipManager.js +1 -1
  166. package/lib/matrixrtc/IMembershipManager.js.map +1 -1
  167. package/lib/matrixrtc/LivekitTransport.d.ts +1 -1
  168. package/lib/matrixrtc/LivekitTransport.js +4 -4
  169. package/lib/matrixrtc/LivekitTransport.js.map +1 -1
  170. package/lib/matrixrtc/MatrixRTCSession.js +137 -187
  171. package/lib/matrixrtc/MatrixRTCSession.js.map +1 -1
  172. package/lib/matrixrtc/MatrixRTCSessionManager.js +36 -41
  173. package/lib/matrixrtc/MatrixRTCSessionManager.js.map +1 -1
  174. package/lib/matrixrtc/MembershipManager.js +332 -378
  175. package/lib/matrixrtc/MembershipManager.js.map +1 -1
  176. package/lib/matrixrtc/MembershipManagerActionScheduler.js +54 -63
  177. package/lib/matrixrtc/MembershipManagerActionScheduler.js.map +1 -1
  178. package/lib/matrixrtc/RTCEncryptionManager.js +119 -143
  179. package/lib/matrixrtc/RTCEncryptionManager.js.map +1 -1
  180. package/lib/matrixrtc/ToDeviceKeyTransport.js +53 -58
  181. package/lib/matrixrtc/ToDeviceKeyTransport.js.map +1 -1
  182. package/lib/matrixrtc/index.js.map +1 -1
  183. package/lib/matrixrtc/membershipData/common.js +1 -1
  184. package/lib/matrixrtc/membershipData/common.js.map +1 -1
  185. package/lib/matrixrtc/membershipData/index.js.map +1 -1
  186. package/lib/matrixrtc/membershipData/rtc.js +15 -23
  187. package/lib/matrixrtc/membershipData/rtc.js.map +1 -1
  188. package/lib/matrixrtc/membershipData/session.js +4 -5
  189. package/lib/matrixrtc/membershipData/session.js.map +1 -1
  190. package/lib/matrixrtc/types.js +4 -6
  191. package/lib/matrixrtc/types.js.map +1 -1
  192. package/lib/matrixrtc/utils.js +4 -11
  193. package/lib/matrixrtc/utils.js.map +1 -1
  194. package/lib/models/MSC3089Branch.js +91 -116
  195. package/lib/models/MSC3089Branch.js.map +1 -1
  196. package/lib/models/MSC3089TreeSpace.js +209 -245
  197. package/lib/models/MSC3089TreeSpace.js.map +1 -1
  198. package/lib/models/ToDeviceMessage.js +3 -1
  199. package/lib/models/beacon.js +14 -13
  200. package/lib/models/beacon.js.map +1 -1
  201. package/lib/models/compare-event-ordering.js +13 -13
  202. package/lib/models/compare-event-ordering.js.map +1 -1
  203. package/lib/models/device.js +3 -3
  204. package/lib/models/device.js.map +1 -1
  205. package/lib/models/event-context.js +5 -8
  206. package/lib/models/event-context.js.map +1 -1
  207. package/lib/models/event-status.js +1 -1
  208. package/lib/models/event-status.js.map +1 -1
  209. package/lib/models/event-timeline-set.js +88 -94
  210. package/lib/models/event-timeline-set.js.map +1 -1
  211. package/lib/models/event-timeline.js +28 -30
  212. package/lib/models/event-timeline.js.map +1 -1
  213. package/lib/models/event.js +182 -226
  214. package/lib/models/event.js.map +1 -1
  215. package/lib/models/invites-ignorer-types.js +4 -4
  216. package/lib/models/invites-ignorer-types.js.map +1 -1
  217. package/lib/models/invites-ignorer.js +159 -179
  218. package/lib/models/invites-ignorer.js.map +1 -1
  219. package/lib/models/poll.js +71 -81
  220. package/lib/models/poll.js.map +1 -1
  221. package/lib/models/profile-keys.js +2 -2
  222. package/lib/models/profile-keys.js.map +1 -1
  223. package/lib/models/read-receipt.js +40 -56
  224. package/lib/models/read-receipt.js.map +1 -1
  225. package/lib/models/related-relations.js.map +1 -1
  226. package/lib/models/relations-container.js +22 -23
  227. package/lib/models/relations-container.js.map +1 -1
  228. package/lib/models/relations.js +133 -159
  229. package/lib/models/relations.js.map +1 -1
  230. package/lib/models/room-member.js +24 -29
  231. package/lib/models/room-member.js.map +1 -1
  232. package/lib/models/room-receipts.js +29 -43
  233. package/lib/models/room-receipts.js.map +1 -1
  234. package/lib/models/room-retention.js +74 -83
  235. package/lib/models/room-retention.js.map +1 -1
  236. package/lib/models/room-state.js +143 -172
  237. package/lib/models/room-state.js.map +1 -1
  238. package/lib/models/room-sticky-events.d.ts +1 -0
  239. package/lib/models/room-sticky-events.d.ts.map +1 -1
  240. package/lib/models/room-sticky-events.js +45 -65
  241. package/lib/models/room-sticky-events.js.map +1 -1
  242. package/lib/models/room-summary.js.map +1 -1
  243. package/lib/models/room.d.ts.map +1 -1
  244. package/lib/models/room.js +765 -909
  245. package/lib/models/room.js.map +1 -1
  246. package/lib/models/search-result.js +5 -5
  247. package/lib/models/search-result.js.map +1 -1
  248. package/lib/models/thread.js +225 -285
  249. package/lib/models/thread.js.map +1 -1
  250. package/lib/models/typed-event-emitter.js +7 -18
  251. package/lib/models/typed-event-emitter.js.map +1 -1
  252. package/lib/models/user.js +8 -8
  253. package/lib/models/user.js.map +1 -1
  254. package/lib/oidc/authorize.js +208 -241
  255. package/lib/oidc/authorize.js.map +1 -1
  256. package/lib/oidc/discovery.js +23 -36
  257. package/lib/oidc/discovery.js.map +1 -1
  258. package/lib/oidc/error.js +1 -1
  259. package/lib/oidc/error.js.map +1 -1
  260. package/lib/oidc/index.js +1 -0
  261. package/lib/oidc/index.js.map +1 -1
  262. package/lib/oidc/register.js +60 -66
  263. package/lib/oidc/register.js.map +1 -1
  264. package/lib/oidc/tokenRefresher.js +77 -91
  265. package/lib/oidc/tokenRefresher.js.map +1 -1
  266. package/lib/oidc/validate.js +18 -18
  267. package/lib/oidc/validate.js.map +1 -1
  268. package/lib/pushprocessor.js +71 -82
  269. package/lib/pushprocessor.js.map +1 -1
  270. package/lib/randomstring.js +9 -9
  271. package/lib/randomstring.js.map +1 -1
  272. package/lib/realtime-callbacks.js +25 -28
  273. package/lib/realtime-callbacks.js.map +1 -1
  274. package/lib/receipt-accumulator.d.ts +2 -0
  275. package/lib/receipt-accumulator.d.ts.map +1 -1
  276. package/lib/receipt-accumulator.js +14 -22
  277. package/lib/receipt-accumulator.js.map +1 -1
  278. package/lib/rendezvous/MSC4108SignInWithQR.js +271 -302
  279. package/lib/rendezvous/MSC4108SignInWithQR.js.map +1 -1
  280. package/lib/rendezvous/RendezvousChannel.js +3 -1
  281. package/lib/rendezvous/RendezvousCode.js +3 -1
  282. package/lib/rendezvous/RendezvousError.js.map +1 -1
  283. package/lib/rendezvous/RendezvousFailureReason.js +2 -2
  284. package/lib/rendezvous/RendezvousFailureReason.js.map +1 -1
  285. package/lib/rendezvous/RendezvousIntent.js +1 -1
  286. package/lib/rendezvous/RendezvousIntent.js.map +1 -1
  287. package/lib/rendezvous/RendezvousTransport.js +3 -1
  288. package/lib/rendezvous/channels/MSC4108SecureChannel.js +123 -147
  289. package/lib/rendezvous/channels/MSC4108SecureChannel.js.map +1 -1
  290. package/lib/rendezvous/index.js +44 -69
  291. package/lib/rendezvous/index.js.map +1 -1
  292. package/lib/rendezvous/transports/MSC4108RendezvousSession.d.ts +1 -1
  293. package/lib/rendezvous/transports/MSC4108RendezvousSession.js +134 -152
  294. package/lib/rendezvous/transports/MSC4108RendezvousSession.js.map +1 -1
  295. package/lib/retentionPolicy.js +6 -9
  296. package/lib/retentionPolicy.js.map +1 -1
  297. package/lib/room-hierarchy.js +52 -60
  298. package/lib/room-hierarchy.js.map +1 -1
  299. package/lib/rust-crypto/CrossSigningIdentity.js +94 -104
  300. package/lib/rust-crypto/CrossSigningIdentity.js.map +1 -1
  301. package/lib/rust-crypto/DehydratedDeviceManager.js +157 -190
  302. package/lib/rust-crypto/DehydratedDeviceManager.js.map +1 -1
  303. package/lib/rust-crypto/KeyClaimManager.js +18 -22
  304. package/lib/rust-crypto/KeyClaimManager.js.map +1 -1
  305. package/lib/rust-crypto/OutgoingRequestProcessor.js +109 -139
  306. package/lib/rust-crypto/OutgoingRequestProcessor.js.map +1 -1
  307. package/lib/rust-crypto/OutgoingRequestsManager.js +66 -80
  308. package/lib/rust-crypto/OutgoingRequestsManager.js.map +1 -1
  309. package/lib/rust-crypto/PerSessionKeyBackupDownloader.d.ts +1 -1
  310. package/lib/rust-crypto/PerSessionKeyBackupDownloader.js +196 -224
  311. package/lib/rust-crypto/PerSessionKeyBackupDownloader.js.map +1 -1
  312. package/lib/rust-crypto/RoomEncryptor.js +127 -143
  313. package/lib/rust-crypto/RoomEncryptor.js.map +1 -1
  314. package/lib/rust-crypto/backup.js +453 -549
  315. package/lib/rust-crypto/backup.js.map +1 -1
  316. package/lib/rust-crypto/constants.js +1 -1
  317. package/lib/rust-crypto/constants.js.map +1 -1
  318. package/lib/rust-crypto/device-converter.js +15 -28
  319. package/lib/rust-crypto/device-converter.js.map +1 -1
  320. package/lib/rust-crypto/index.js +103 -116
  321. package/lib/rust-crypto/index.js.map +1 -1
  322. package/lib/rust-crypto/libolm_migration.js +303 -365
  323. package/lib/rust-crypto/libolm_migration.js.map +1 -1
  324. package/lib/rust-crypto/rust-crypto.d.ts +5 -1
  325. package/lib/rust-crypto/rust-crypto.d.ts.map +1 -1
  326. package/lib/rust-crypto/rust-crypto.js +1067 -1332
  327. package/lib/rust-crypto/rust-crypto.js.map +1 -1
  328. package/lib/rust-crypto/secret-storage.js +12 -25
  329. package/lib/rust-crypto/secret-storage.js.map +1 -1
  330. package/lib/rust-crypto/verification.js +137 -189
  331. package/lib/rust-crypto/verification.js.map +1 -1
  332. package/lib/scheduler.js +44 -19
  333. package/lib/scheduler.js.map +1 -1
  334. package/lib/secret-storage.js +179 -213
  335. package/lib/secret-storage.js.map +1 -1
  336. package/lib/serverCapabilities.js +6 -9
  337. package/lib/serverCapabilities.js.map +1 -1
  338. package/lib/service-types.js +1 -1
  339. package/lib/service-types.js.map +1 -1
  340. package/lib/sliding-sync-sdk.d.ts.map +1 -1
  341. package/lib/sliding-sync-sdk.js +368 -424
  342. package/lib/sliding-sync-sdk.js.map +1 -1
  343. package/lib/sliding-sync.js +135 -171
  344. package/lib/sliding-sync.js.map +1 -1
  345. package/lib/store/index.js +3 -1
  346. package/lib/store/indexeddb-backend.js +3 -1
  347. package/lib/store/indexeddb-local-backend.js +194 -253
  348. package/lib/store/indexeddb-local-backend.js.map +1 -1
  349. package/lib/store/indexeddb-remote-backend.js +33 -63
  350. package/lib/store/indexeddb-remote-backend.js.map +1 -1
  351. package/lib/store/indexeddb-store-worker.js +22 -23
  352. package/lib/store/indexeddb-store-worker.js.map +1 -1
  353. package/lib/store/indexeddb.js +44 -71
  354. package/lib/store/indexeddb.js.map +1 -1
  355. package/lib/store/local-storage-events-emitter.js +2 -2
  356. package/lib/store/local-storage-events-emitter.js.map +1 -1
  357. package/lib/store/memory.js +34 -57
  358. package/lib/store/memory.js.map +1 -1
  359. package/lib/store/stub.js +22 -35
  360. package/lib/store/stub.js.map +1 -1
  361. package/lib/sync-accumulator.js +54 -66
  362. package/lib/sync-accumulator.js.map +1 -1
  363. package/lib/sync.d.ts.map +1 -1
  364. package/lib/sync.js +905 -998
  365. package/lib/sync.js.map +1 -1
  366. package/lib/testing.js +63 -105
  367. package/lib/testing.js.map +1 -1
  368. package/lib/thread-utils.js +1 -4
  369. package/lib/thread-utils.js.map +1 -1
  370. package/lib/timeline-window.js +89 -102
  371. package/lib/timeline-window.js.map +1 -1
  372. package/lib/types.js +1 -1
  373. package/lib/types.js.map +1 -1
  374. package/lib/utils/decryptAESSecretStorageItem.js +14 -25
  375. package/lib/utils/decryptAESSecretStorageItem.js.map +1 -1
  376. package/lib/utils/encryptAESSecretStorageItem.js +27 -38
  377. package/lib/utils/encryptAESSecretStorageItem.js.map +1 -1
  378. package/lib/utils/internal/deriveKeys.js +25 -32
  379. package/lib/utils/internal/deriveKeys.js.map +1 -1
  380. package/lib/utils/roomVersion.js +1 -1
  381. package/lib/utils/roomVersion.js.map +1 -1
  382. package/lib/utils.js +83 -135
  383. package/lib/utils.js.map +1 -1
  384. package/lib/version-support.js +3 -3
  385. package/lib/version-support.js.map +1 -1
  386. package/lib/webrtc/audioContext.js +5 -6
  387. package/lib/webrtc/audioContext.js.map +1 -1
  388. package/lib/webrtc/call.js +1081 -1250
  389. package/lib/webrtc/call.js.map +1 -1
  390. package/lib/webrtc/callEventHandler.js +202 -214
  391. package/lib/webrtc/callEventHandler.js.map +1 -1
  392. package/lib/webrtc/callEventTypes.js +2 -2
  393. package/lib/webrtc/callEventTypes.js.map +1 -1
  394. package/lib/webrtc/callFeed.js +18 -20
  395. package/lib/webrtc/callFeed.js.map +1 -1
  396. package/lib/webrtc/groupCall.js +513 -602
  397. package/lib/webrtc/groupCall.js.map +1 -1
  398. package/lib/webrtc/groupCallEventHandler.js +59 -62
  399. package/lib/webrtc/groupCallEventHandler.js.map +1 -1
  400. package/lib/webrtc/mediaHandler.js +198 -232
  401. package/lib/webrtc/mediaHandler.js.map +1 -1
  402. package/lib/webrtc/stats/callFeedStatsReporter.js +16 -20
  403. package/lib/webrtc/stats/callFeedStatsReporter.js.map +1 -1
  404. package/lib/webrtc/stats/callStatsReportGatherer.js +67 -75
  405. package/lib/webrtc/stats/callStatsReportGatherer.js.map +1 -1
  406. package/lib/webrtc/stats/callStatsReportSummary.js +3 -1
  407. package/lib/webrtc/stats/connectionStats.js.map +1 -1
  408. package/lib/webrtc/stats/connectionStatsBuilder.js +2 -2
  409. package/lib/webrtc/stats/connectionStatsBuilder.js.map +1 -1
  410. package/lib/webrtc/stats/connectionStatsReportBuilder.js +20 -24
  411. package/lib/webrtc/stats/connectionStatsReportBuilder.js.map +1 -1
  412. package/lib/webrtc/stats/groupCallStats.js +6 -8
  413. package/lib/webrtc/stats/groupCallStats.js.map +1 -1
  414. package/lib/webrtc/stats/media/mediaSsrcHandler.js +7 -8
  415. package/lib/webrtc/stats/media/mediaSsrcHandler.js.map +1 -1
  416. package/lib/webrtc/stats/media/mediaTrackHandler.js +7 -9
  417. package/lib/webrtc/stats/media/mediaTrackHandler.js.map +1 -1
  418. package/lib/webrtc/stats/media/mediaTrackStats.js +3 -3
  419. package/lib/webrtc/stats/media/mediaTrackStats.js.map +1 -1
  420. package/lib/webrtc/stats/media/mediaTrackStatsHandler.js +7 -7
  421. package/lib/webrtc/stats/media/mediaTrackStatsHandler.js.map +1 -1
  422. package/lib/webrtc/stats/statsReport.js +1 -1
  423. package/lib/webrtc/stats/statsReport.js.map +1 -1
  424. package/lib/webrtc/stats/statsReportEmitter.js.map +1 -1
  425. package/lib/webrtc/stats/summaryStatsReportGatherer.js +14 -14
  426. package/lib/webrtc/stats/summaryStatsReportGatherer.js.map +1 -1
  427. package/lib/webrtc/stats/trackStatsBuilder.js +32 -34
  428. package/lib/webrtc/stats/trackStatsBuilder.js.map +1 -1
  429. package/lib/webrtc/stats/transportStats.js +3 -1
  430. package/lib/webrtc/stats/transportStatsBuilder.js +9 -9
  431. package/lib/webrtc/stats/transportStatsBuilder.js.map +1 -1
  432. package/lib/webrtc/stats/valueFormatter.js +1 -1
  433. package/lib/webrtc/stats/valueFormatter.js.map +1 -1
  434. package/package.json +18 -33
  435. package/src/@types/global.d.ts +2 -2
  436. package/src/ToDeviceMessageQueue.ts +2 -2
  437. package/src/browser-index.ts +4 -4
  438. package/src/client.ts +15 -20
  439. package/src/crypto-api/index.ts +17 -6
  440. package/src/embedded.ts +4 -6
  441. package/src/filter-component.ts +1 -0
  442. package/src/http-api/utils.ts +1 -1
  443. package/src/interactive-auth.ts +11 -5
  444. package/src/matrixrtc/LivekitTransport.ts +1 -1
  445. package/src/matrixrtc/MatrixRTCSession.ts +1 -1
  446. package/src/models/MSC3089Branch.ts +1 -1
  447. package/src/models/room-sticky-events.ts +1 -0
  448. package/src/models/room.ts +9 -11
  449. package/src/receipt-accumulator.ts +2 -0
  450. package/src/rendezvous/index.ts +1 -1
  451. package/src/rendezvous/transports/MSC4108RendezvousSession.ts +2 -2
  452. package/src/rust-crypto/PerSessionKeyBackupDownloader.ts +1 -1
  453. package/src/rust-crypto/index.ts +6 -6
  454. package/src/rust-crypto/rust-crypto.ts +31 -7
  455. package/src/rust-crypto/verification.ts +1 -1
  456. package/src/sliding-sync-sdk.ts +5 -7
  457. package/src/store/indexeddb-local-backend.ts +3 -3
  458. package/src/sync.ts +6 -8
@@ -1,5 +1,3 @@
1
- import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
2
- import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
3
1
  /*
4
2
  Copyright 2023-2024 The Matrix.org Foundation C.I.C.
5
3
 
@@ -31,308 +29,276 @@ import decryptAESSecretStorageItem from "../utils/decryptAESSecretStorageItem.js
31
29
  *
32
30
  * @param args - Arguments object.
33
31
  */
34
- export function migrateFromLegacyCrypto(_x) {
35
- return _migrateFromLegacyCrypto.apply(this, arguments);
36
- }
37
- function _migrateFromLegacyCrypto() {
38
- _migrateFromLegacyCrypto = _asyncToGenerator(function* (args) {
39
- var _args$legacyMigration2;
40
- var logger = args.logger,
41
- legacyStore = args.legacyStore;
32
+ export async function migrateFromLegacyCrypto(args) {
33
+ const {
34
+ logger,
35
+ legacyStore
36
+ } = args;
42
37
 
43
- // initialise the rust matrix-sdk-crypto-wasm, if it hasn't already been done
44
- yield RustSdkCryptoJs.initAsync();
45
- if (!(yield legacyStore.containsData())) {
46
- // This store was never used. Nothing to migrate.
47
- return;
48
- }
49
- yield legacyStore.startup();
50
- var accountPickle = null;
51
- yield legacyStore.doTxn("readonly", [IndexedDBCryptoStore.STORE_ACCOUNT], txn => {
52
- legacyStore.getAccount(txn, acctPickle => {
53
- accountPickle = acctPickle;
54
- });
38
+ // initialise the rust matrix-sdk-crypto-wasm, if it hasn't already been done
39
+ await RustSdkCryptoJs.initAsync();
40
+ if (!(await legacyStore.containsData())) {
41
+ // This store was never used. Nothing to migrate.
42
+ return;
43
+ }
44
+ await legacyStore.startup();
45
+ let accountPickle = null;
46
+ await legacyStore.doTxn("readonly", [IndexedDBCryptoStore.STORE_ACCOUNT], txn => {
47
+ legacyStore.getAccount(txn, acctPickle => {
48
+ accountPickle = acctPickle;
55
49
  });
56
- if (!accountPickle) {
57
- // This store is not properly set up. Nothing to migrate.
58
- logger.debug("Legacy crypto store is not set up (no account found). Not migrating.");
59
- return;
60
- }
61
- var migrationState = yield legacyStore.getMigrationState();
62
- if (migrationState >= MigrationState.MEGOLM_SESSIONS_MIGRATED) {
63
- // All migration is done for now. The room list comes later, once we have an OlmMachine.
64
- return;
65
- }
66
- var nOlmSessions = yield countOlmSessions(logger, legacyStore);
67
- var nMegolmSessions = yield countMegolmSessions(logger, legacyStore);
68
- var totalSteps = 1 + nOlmSessions + nMegolmSessions;
69
- logger.info("Migrating data from legacy crypto store. ".concat(nOlmSessions, " olm sessions and ").concat(nMegolmSessions, " megolm sessions to migrate."));
70
- var stepsDone = 0;
71
- function onProgress(steps) {
72
- var _args$legacyMigration;
73
- stepsDone += steps;
74
- (_args$legacyMigration = args.legacyMigrationProgressListener) === null || _args$legacyMigration === void 0 || _args$legacyMigration.call(args, stepsDone, totalSteps);
75
- }
76
- onProgress(0);
77
- var pickleKey = new TextEncoder().encode(args.legacyPickleKey).slice();
78
- if (migrationState === MigrationState.NOT_STARTED) {
79
- logger.info("Migrating data from legacy crypto store. Step 1: base data");
80
- yield migrateBaseData(args.http, args.userId, args.deviceId, legacyStore, pickleKey, args.storeHandle, logger);
81
- migrationState = MigrationState.INITIAL_DATA_MIGRATED;
82
- yield legacyStore.setMigrationState(migrationState);
83
- }
84
- onProgress(1);
85
- if (migrationState === MigrationState.INITIAL_DATA_MIGRATED) {
86
- logger.info("Migrating data from legacy crypto store. Step 2: olm sessions (".concat(nOlmSessions, " sessions to migrate)."));
87
- yield migrateOlmSessions(logger, legacyStore, pickleKey, args.storeHandle, onProgress);
88
- migrationState = MigrationState.OLM_SESSIONS_MIGRATED;
89
- yield legacyStore.setMigrationState(migrationState);
90
- }
91
- if (migrationState === MigrationState.OLM_SESSIONS_MIGRATED) {
92
- logger.info("Migrating data from legacy crypto store. Step 3: megolm sessions (".concat(nMegolmSessions, " sessions to migrate)."));
93
- yield migrateMegolmSessions(logger, legacyStore, pickleKey, args.storeHandle, onProgress);
94
- migrationState = MigrationState.MEGOLM_SESSIONS_MIGRATED;
95
- yield legacyStore.setMigrationState(migrationState);
96
- }
97
-
98
- // Migration is done.
99
- (_args$legacyMigration2 = args.legacyMigrationProgressListener) === null || _args$legacyMigration2 === void 0 || _args$legacyMigration2.call(args, -1, -1);
100
- logger.info("Migration from legacy crypto store complete");
101
50
  });
102
- return _migrateFromLegacyCrypto.apply(this, arguments);
103
- }
104
- function migrateBaseData(_x2, _x3, _x4, _x5, _x6, _x7, _x8) {
105
- return _migrateBaseData.apply(this, arguments);
51
+ if (!accountPickle) {
52
+ // This store is not properly set up. Nothing to migrate.
53
+ logger.debug("Legacy crypto store is not set up (no account found). Not migrating.");
54
+ return;
55
+ }
56
+ let migrationState = await legacyStore.getMigrationState();
57
+ if (migrationState >= MigrationState.MEGOLM_SESSIONS_MIGRATED) {
58
+ // All migration is done for now. The room list comes later, once we have an OlmMachine.
59
+ return;
60
+ }
61
+ const nOlmSessions = await countOlmSessions(logger, legacyStore);
62
+ const nMegolmSessions = await countMegolmSessions(logger, legacyStore);
63
+ const totalSteps = 1 + nOlmSessions + nMegolmSessions;
64
+ logger.info(`Migrating data from legacy crypto store. ${nOlmSessions} olm sessions and ${nMegolmSessions} megolm sessions to migrate.`);
65
+ let stepsDone = 0;
66
+ function onProgress(steps) {
67
+ stepsDone += steps;
68
+ args.legacyMigrationProgressListener?.(stepsDone, totalSteps);
69
+ }
70
+ onProgress(0);
71
+ const pickleKey = new TextEncoder().encode(args.legacyPickleKey).slice();
72
+ if (migrationState === MigrationState.NOT_STARTED) {
73
+ logger.info("Migrating data from legacy crypto store. Step 1: base data");
74
+ await migrateBaseData(args.http, args.userId, args.deviceId, legacyStore, pickleKey, args.storeHandle, logger);
75
+ migrationState = MigrationState.INITIAL_DATA_MIGRATED;
76
+ await legacyStore.setMigrationState(migrationState);
77
+ }
78
+ onProgress(1);
79
+ if (migrationState === MigrationState.INITIAL_DATA_MIGRATED) {
80
+ logger.info(`Migrating data from legacy crypto store. Step 2: olm sessions (${nOlmSessions} sessions to migrate).`);
81
+ await migrateOlmSessions(logger, legacyStore, pickleKey, args.storeHandle, onProgress);
82
+ migrationState = MigrationState.OLM_SESSIONS_MIGRATED;
83
+ await legacyStore.setMigrationState(migrationState);
84
+ }
85
+ if (migrationState === MigrationState.OLM_SESSIONS_MIGRATED) {
86
+ logger.info(`Migrating data from legacy crypto store. Step 3: megolm sessions (${nMegolmSessions} sessions to migrate).`);
87
+ await migrateMegolmSessions(logger, legacyStore, pickleKey, args.storeHandle, onProgress);
88
+ migrationState = MigrationState.MEGOLM_SESSIONS_MIGRATED;
89
+ await legacyStore.setMigrationState(migrationState);
90
+ }
91
+
92
+ // Migration is done.
93
+ args.legacyMigrationProgressListener?.(-1, -1);
94
+ logger.info("Migration from legacy crypto store complete");
106
95
  }
107
- function _migrateBaseData() {
108
- _migrateBaseData = _asyncToGenerator(function* (http, userId, deviceId, legacyStore, pickleKey, storeHandle, logger) {
109
- var migrationData = new RustSdkCryptoJs.BaseMigrationData();
110
- migrationData.userId = new RustSdkCryptoJs.UserId(userId);
111
- migrationData.deviceId = new RustSdkCryptoJs.DeviceId(deviceId);
112
- yield legacyStore.doTxn("readonly", [IndexedDBCryptoStore.STORE_ACCOUNT], txn => legacyStore.getAccount(txn, a => {
113
- migrationData.pickledAccount = a !== null && a !== void 0 ? a : "";
114
- }));
115
- var recoveryKey = yield getAndDecryptCachedSecretKey(legacyStore, pickleKey, "m.megolm_backup.v1");
96
+ async function migrateBaseData(http, userId, deviceId, legacyStore, pickleKey, storeHandle, logger) {
97
+ const migrationData = new RustSdkCryptoJs.BaseMigrationData();
98
+ migrationData.userId = new RustSdkCryptoJs.UserId(userId);
99
+ migrationData.deviceId = new RustSdkCryptoJs.DeviceId(deviceId);
100
+ await legacyStore.doTxn("readonly", [IndexedDBCryptoStore.STORE_ACCOUNT], txn => legacyStore.getAccount(txn, a => {
101
+ migrationData.pickledAccount = a ?? "";
102
+ }));
103
+ const recoveryKey = await getAndDecryptCachedSecretKey(legacyStore, pickleKey, "m.megolm_backup.v1");
116
104
 
117
- // If we have a backup recovery key, we need to try to figure out which backup version it is for.
118
- // All we can really do is ask the server for the most recent version and check if the cached key we have matches.
119
- // It is possible that the backup has changed since last time his session was opened.
120
- if (recoveryKey) {
121
- var backupCallDone = false;
122
- var backupInfo = null;
123
- while (!backupCallDone) {
124
- try {
125
- backupInfo = yield requestKeyBackupVersion(http);
126
- backupCallDone = true;
127
- } catch (e) {
128
- logger.info("Failed to get backup version during migration, retrying in 2 seconds", e);
129
- // Retry until successful, use simple constant delay
130
- yield sleep(2000);
131
- }
105
+ // If we have a backup recovery key, we need to try to figure out which backup version it is for.
106
+ // All we can really do is ask the server for the most recent version and check if the cached key we have matches.
107
+ // It is possible that the backup has changed since last time his session was opened.
108
+ if (recoveryKey) {
109
+ let backupCallDone = false;
110
+ let backupInfo = null;
111
+ while (!backupCallDone) {
112
+ try {
113
+ backupInfo = await requestKeyBackupVersion(http);
114
+ backupCallDone = true;
115
+ } catch (e) {
116
+ logger.info("Failed to get backup version during migration, retrying in 2 seconds", e);
117
+ // Retry until successful, use simple constant delay
118
+ await sleep(2000);
132
119
  }
133
- if (backupInfo && backupInfo.algorithm == "m.megolm_backup.v1.curve25519-aes-sha2") {
134
- // check if the recovery key matches, as the active backup version may have changed since the key was cached
135
- // and the migration started.
136
- try {
137
- var _backupInfo$auth_data;
138
- var decryptionKey = RustSdkCryptoJs.BackupDecryptionKey.fromBase64(recoveryKey);
139
- var publicKey = (_backupInfo$auth_data = backupInfo.auth_data) === null || _backupInfo$auth_data === void 0 ? void 0 : _backupInfo$auth_data.public_key;
140
- var isValid = decryptionKey.megolmV1PublicKey.publicKeyBase64 == publicKey;
141
- if (isValid) {
142
- migrationData.backupVersion = backupInfo.version;
143
- migrationData.backupRecoveryKey = recoveryKey;
144
- } else {
145
- logger.debug("The backup key to migrate does not match the active backup version", "Cached pub key: ".concat(decryptionKey.megolmV1PublicKey.publicKeyBase64), "Active pub key: ".concat(publicKey));
146
- }
147
- } catch (e) {
148
- logger.warn("Failed to check if the backup key to migrate matches the active backup version", e);
120
+ }
121
+ if (backupInfo && backupInfo.algorithm == "m.megolm_backup.v1.curve25519-aes-sha2") {
122
+ // check if the recovery key matches, as the active backup version may have changed since the key was cached
123
+ // and the migration started.
124
+ try {
125
+ const decryptionKey = RustSdkCryptoJs.BackupDecryptionKey.fromBase64(recoveryKey);
126
+ const publicKey = backupInfo.auth_data?.public_key;
127
+ const isValid = decryptionKey.megolmV1PublicKey.publicKeyBase64 == publicKey;
128
+ if (isValid) {
129
+ migrationData.backupVersion = backupInfo.version;
130
+ migrationData.backupRecoveryKey = recoveryKey;
131
+ } else {
132
+ logger.debug("The backup key to migrate does not match the active backup version", `Cached pub key: ${decryptionKey.megolmV1PublicKey.publicKeyBase64}`, `Active pub key: ${publicKey}`);
149
133
  }
134
+ } catch (e) {
135
+ logger.warn("Failed to check if the backup key to migrate matches the active backup version", e);
150
136
  }
151
137
  }
152
- migrationData.privateCrossSigningMasterKey = yield getAndDecryptCachedSecretKey(legacyStore, pickleKey, "master");
153
- migrationData.privateCrossSigningSelfSigningKey = yield getAndDecryptCachedSecretKey(legacyStore, pickleKey, "self_signing");
154
- migrationData.privateCrossSigningUserSigningKey = yield getAndDecryptCachedSecretKey(legacyStore, pickleKey, "user_signing");
155
- yield RustSdkCryptoJs.Migration.migrateBaseData(migrationData, pickleKey, storeHandle, logger);
156
- });
157
- return _migrateBaseData.apply(this, arguments);
158
- }
159
- function countOlmSessions(_x9, _x0) {
160
- return _countOlmSessions.apply(this, arguments);
138
+ }
139
+ migrationData.privateCrossSigningMasterKey = await getAndDecryptCachedSecretKey(legacyStore, pickleKey, "master");
140
+ migrationData.privateCrossSigningSelfSigningKey = await getAndDecryptCachedSecretKey(legacyStore, pickleKey, "self_signing");
141
+ migrationData.privateCrossSigningUserSigningKey = await getAndDecryptCachedSecretKey(legacyStore, pickleKey, "user_signing");
142
+ await RustSdkCryptoJs.Migration.migrateBaseData(migrationData, pickleKey, storeHandle, logger);
161
143
  }
162
- function _countOlmSessions() {
163
- _countOlmSessions = _asyncToGenerator(function* (logger, legacyStore) {
164
- logger.debug("Counting olm sessions to be migrated");
165
- var nSessions;
166
- yield legacyStore.doTxn("readonly", [IndexedDBCryptoStore.STORE_SESSIONS], txn => legacyStore.countEndToEndSessions(txn, n => nSessions = n));
167
- return nSessions;
168
- });
169
- return _countOlmSessions.apply(this, arguments);
144
+ async function countOlmSessions(logger, legacyStore) {
145
+ logger.debug("Counting olm sessions to be migrated");
146
+ let nSessions;
147
+ await legacyStore.doTxn("readonly", [IndexedDBCryptoStore.STORE_SESSIONS], txn => legacyStore.countEndToEndSessions(txn, n => nSessions = n));
148
+ return nSessions;
170
149
  }
171
- function countMegolmSessions(_x1, _x10) {
172
- return _countMegolmSessions.apply(this, arguments);
173
- }
174
- function _countMegolmSessions() {
175
- _countMegolmSessions = _asyncToGenerator(function* (logger, legacyStore) {
176
- logger.debug("Counting megolm sessions to be migrated");
177
- return yield legacyStore.countEndToEndInboundGroupSessions();
178
- });
179
- return _countMegolmSessions.apply(this, arguments);
150
+ async function countMegolmSessions(logger, legacyStore) {
151
+ logger.debug("Counting megolm sessions to be migrated");
152
+ return await legacyStore.countEndToEndInboundGroupSessions();
180
153
  }
181
- function migrateOlmSessions(_x11, _x12, _x13, _x14, _x15) {
182
- return _migrateOlmSessions.apply(this, arguments);
183
- }
184
- function _migrateOlmSessions() {
185
- _migrateOlmSessions = _asyncToGenerator(function* (logger, legacyStore, pickleKey, storeHandle, onBatchDone) {
186
- // eslint-disable-next-line no-constant-condition
187
- while (true) {
188
- var batch = yield legacyStore.getEndToEndSessionsBatch();
189
- if (batch === null) return;
190
- logger.debug("Migrating batch of ".concat(batch.length, " olm sessions"));
191
- var migrationData = [];
192
- for (var session of batch) {
193
- var pickledSession = new RustSdkCryptoJs.PickledSession();
194
- pickledSession.senderKey = session.deviceKey;
195
- pickledSession.pickle = session.session;
196
- pickledSession.lastUseTime = pickledSession.creationTime = new Date(session.lastReceivedMessageTs);
197
- migrationData.push(pickledSession);
198
- }
199
- yield RustSdkCryptoJs.Migration.migrateOlmSessions(migrationData, pickleKey, storeHandle, logger);
200
- yield legacyStore.deleteEndToEndSessionsBatch(batch);
201
- onBatchDone(batch.length);
154
+ async function migrateOlmSessions(logger, legacyStore, pickleKey, storeHandle, onBatchDone) {
155
+ // eslint-disable-next-line no-constant-condition
156
+ while (true) {
157
+ const batch = await legacyStore.getEndToEndSessionsBatch();
158
+ if (batch === null) return;
159
+ logger.debug(`Migrating batch of ${batch.length} olm sessions`);
160
+ const migrationData = [];
161
+ for (const session of batch) {
162
+ const pickledSession = new RustSdkCryptoJs.PickledSession();
163
+ pickledSession.senderKey = session.deviceKey;
164
+ pickledSession.pickle = session.session;
165
+ pickledSession.lastUseTime = pickledSession.creationTime = new Date(session.lastReceivedMessageTs);
166
+ migrationData.push(pickledSession);
202
167
  }
203
- });
204
- return _migrateOlmSessions.apply(this, arguments);
168
+ await RustSdkCryptoJs.Migration.migrateOlmSessions(migrationData, pickleKey, storeHandle, logger);
169
+ await legacyStore.deleteEndToEndSessionsBatch(batch);
170
+ onBatchDone(batch.length);
171
+ }
205
172
  }
206
- function migrateMegolmSessions(_x16, _x17, _x18, _x19, _x20) {
207
- return _migrateMegolmSessions.apply(this, arguments);
173
+ async function migrateMegolmSessions(logger, legacyStore, pickleKey, storeHandle, onBatchDone) {
174
+ // eslint-disable-next-line no-constant-condition
175
+ while (true) {
176
+ const batch = await legacyStore.getEndToEndInboundGroupSessionsBatch();
177
+ if (batch === null) return;
178
+ logger.debug(`Migrating batch of ${batch.length} megolm sessions`);
179
+ const migrationData = [];
180
+ for (const session of batch) {
181
+ const sessionData = session.sessionData;
182
+ const pickledSession = new RustSdkCryptoJs.PickledInboundGroupSession();
183
+ pickledSession.pickle = sessionData.session;
184
+ pickledSession.roomId = new RustSdkCryptoJs.RoomId(sessionData.room_id);
185
+ pickledSession.senderKey = session.senderKey;
186
+ pickledSession.senderSigningKey = sessionData.keysClaimed?.["ed25519"];
187
+ pickledSession.backedUp = !session.needsBackup;
188
+
189
+ // The Rust SDK `imported` flag is used to indicate the authenticity status of a Megolm
190
+ // session, which tells us whether we can reliably tell which Olm device is the owner
191
+ // (creator) of the session.
192
+ //
193
+ // If `imported` is true, then we have no cryptographic proof that the session is owned
194
+ // by the device with the identity key `senderKey`.
195
+ //
196
+ // Only Megolm sessions received directly from the owning device via an encrypted
197
+ // `m.room_key` to-device message should have `imported` flag set to false. Megolm
198
+ // sessions received by any other currently available means (i.e. from a
199
+ // `m.forwarded_room_key`, from v1 asymmetric server-side key backup, imported from a
200
+ // file, etc) should have the `imported` flag set to true.
201
+ //
202
+ // Messages encrypted with such Megolm sessions will have a grey shield in the UI
203
+ // ("Authenticity of this message cannot be guaranteed").
204
+ //
205
+ // However, we don't want to bluntly mark all sessions as `imported` during migration
206
+ // because users will suddenly start seeing all their historic messages decorated with a
207
+ // grey shield, which would be seen as a non-actionable regression.
208
+ //
209
+ // In the legacy crypto stack, the flag encoding similar information was called
210
+ // `InboundGroupSessionData.untrusted`. The value of this flag was set as follows:
211
+ //
212
+ // - For outbound Megolm sessions created by our own device, `untrusted` is `undefined`.
213
+ // - For Megolm sessions received via a `m.room_key` to-device message, `untrusted` is
214
+ // `undefined`.
215
+ // - For Megolm sessions received via a `m.forwarded_room_key` to-device message,
216
+ // `untrusted` is `true`.
217
+ // - For Megolm sessions imported from a (v1 asymmetric / "legacy") server-side key
218
+ // backup, `untrusted` is `true`.
219
+ // - For Megolm sessions imported from a file, untrusted is `undefined`.
220
+ //
221
+ // The main difference between the legacy crypto stack and the Rust crypto stack is that
222
+ // the Rust stack considers sessions imported from a file as `imported` (not
223
+ // authenticated). This is because the Megolm session export file format does not
224
+ // encode this authenticity information.
225
+ //
226
+ // Given this migration is only a one-time thing, we make a concession to accept the
227
+ // loss of information in this case, to avoid degrading UX in a non-actionable way.
228
+ pickledSession.imported = sessionData.untrusted === true;
229
+ migrationData.push(pickledSession);
230
+ }
231
+ await RustSdkCryptoJs.Migration.migrateMegolmSessions(migrationData, pickleKey, storeHandle, logger);
232
+ await legacyStore.deleteEndToEndInboundGroupSessionsBatch(batch);
233
+ onBatchDone(batch.length);
234
+ }
208
235
  }
236
+
209
237
  /**
210
238
  * Determine if any room settings need migrating from the legacy store, and do so.
211
239
  *
212
240
  * @param args - Arguments object.
213
241
  */
214
- function _migrateMegolmSessions() {
215
- _migrateMegolmSessions = _asyncToGenerator(function* (logger, legacyStore, pickleKey, storeHandle, onBatchDone) {
216
- // eslint-disable-next-line no-constant-condition
217
- while (true) {
218
- var batch = yield legacyStore.getEndToEndInboundGroupSessionsBatch();
219
- if (batch === null) return;
220
- logger.debug("Migrating batch of ".concat(batch.length, " megolm sessions"));
221
- var migrationData = [];
222
- for (var session of batch) {
223
- var _sessionData$keysClai;
224
- var sessionData = session.sessionData;
225
- var pickledSession = new RustSdkCryptoJs.PickledInboundGroupSession();
226
- pickledSession.pickle = sessionData.session;
227
- pickledSession.roomId = new RustSdkCryptoJs.RoomId(sessionData.room_id);
228
- pickledSession.senderKey = session.senderKey;
229
- pickledSession.senderSigningKey = (_sessionData$keysClai = sessionData.keysClaimed) === null || _sessionData$keysClai === void 0 ? void 0 : _sessionData$keysClai["ed25519"];
230
- pickledSession.backedUp = !session.needsBackup;
231
-
232
- // The Rust SDK `imported` flag is used to indicate the authenticity status of a Megolm
233
- // session, which tells us whether we can reliably tell which Olm device is the owner
234
- // (creator) of the session.
235
- //
236
- // If `imported` is true, then we have no cryptographic proof that the session is owned
237
- // by the device with the identity key `senderKey`.
238
- //
239
- // Only Megolm sessions received directly from the owning device via an encrypted
240
- // `m.room_key` to-device message should have `imported` flag set to false. Megolm
241
- // sessions received by any other currently available means (i.e. from a
242
- // `m.forwarded_room_key`, from v1 asymmetric server-side key backup, imported from a
243
- // file, etc) should have the `imported` flag set to true.
244
- //
245
- // Messages encrypted with such Megolm sessions will have a grey shield in the UI
246
- // ("Authenticity of this message cannot be guaranteed").
247
- //
248
- // However, we don't want to bluntly mark all sessions as `imported` during migration
249
- // because users will suddenly start seeing all their historic messages decorated with a
250
- // grey shield, which would be seen as a non-actionable regression.
251
- //
252
- // In the legacy crypto stack, the flag encoding similar information was called
253
- // `InboundGroupSessionData.untrusted`. The value of this flag was set as follows:
254
- //
255
- // - For outbound Megolm sessions created by our own device, `untrusted` is `undefined`.
256
- // - For Megolm sessions received via a `m.room_key` to-device message, `untrusted` is
257
- // `undefined`.
258
- // - For Megolm sessions received via a `m.forwarded_room_key` to-device message,
259
- // `untrusted` is `true`.
260
- // - For Megolm sessions imported from a (v1 asymmetric / "legacy") server-side key
261
- // backup, `untrusted` is `true`.
262
- // - For Megolm sessions imported from a file, untrusted is `undefined`.
263
- //
264
- // The main difference between the legacy crypto stack and the Rust crypto stack is that
265
- // the Rust stack considers sessions imported from a file as `imported` (not
266
- // authenticated). This is because the Megolm session export file format does not
267
- // encode this authenticity information.
268
- //
269
- // Given this migration is only a one-time thing, we make a concession to accept the
270
- // loss of information in this case, to avoid degrading UX in a non-actionable way.
271
- pickledSession.imported = sessionData.untrusted === true;
272
- migrationData.push(pickledSession);
242
+ export async function migrateRoomSettingsFromLegacyCrypto({
243
+ logger,
244
+ legacyStore,
245
+ olmMachine
246
+ }) {
247
+ if (!(await legacyStore.containsData())) {
248
+ // This store was never used. Nothing to migrate.
249
+ return;
250
+ }
251
+ const migrationState = await legacyStore.getMigrationState();
252
+ if (migrationState >= MigrationState.ROOM_SETTINGS_MIGRATED) {
253
+ // We've already migrated the room settings.
254
+ return;
255
+ }
256
+ let rooms = {};
257
+ await legacyStore.doTxn("readwrite", [IndexedDBCryptoStore.STORE_ROOMS], txn => {
258
+ legacyStore.getEndToEndRooms(txn, result => {
259
+ rooms = result;
260
+ });
261
+ });
262
+ logger.debug(`Migrating ${Object.keys(rooms).length} sets of room settings`);
263
+ for (const [roomId, legacySettings] of Object.entries(rooms)) {
264
+ try {
265
+ const rustSettings = new RustSdkCryptoJs.RoomSettings();
266
+ if (legacySettings.algorithm !== "m.megolm.v1.aes-sha2") {
267
+ logger.warn(`Room ${roomId}: ignoring room with invalid algorithm ${legacySettings.algorithm}`);
268
+ continue;
273
269
  }
274
- yield RustSdkCryptoJs.Migration.migrateMegolmSessions(migrationData, pickleKey, storeHandle, logger);
275
- yield legacyStore.deleteEndToEndInboundGroupSessionsBatch(batch);
276
- onBatchDone(batch.length);
270
+ rustSettings.algorithm = RustSdkCryptoJs.EncryptionAlgorithm.MegolmV1AesSha2;
271
+ rustSettings.sessionRotationPeriodMs = legacySettings.rotation_period_ms;
272
+ rustSettings.sessionRotationPeriodMessages = legacySettings.rotation_period_msgs;
273
+ await olmMachine.setRoomSettings(new RustSdkCryptoJs.RoomId(roomId), rustSettings);
274
+
275
+ // We don't attempt to clear out the settings from the old store, or record where we've gotten up to,
276
+ // which means that if the app gets restarted while we're in the middle of this migration, we'll start
277
+ // again from scratch. So be it. Given that legacy crypto loads the whole room list into memory on startup
278
+ // anyway, we know it can't be that big.
279
+ } catch (e) {
280
+ logger.warn(`Room ${roomId}: ignoring settings ${JSON.stringify(legacySettings)} which caused error ${e}`);
277
281
  }
278
- });
279
- return _migrateMegolmSessions.apply(this, arguments);
282
+ }
283
+ logger.debug(`Completed room settings migration`);
284
+ await legacyStore.setMigrationState(MigrationState.ROOM_SETTINGS_MIGRATED);
280
285
  }
281
- export function migrateRoomSettingsFromLegacyCrypto(_x21) {
282
- return _migrateRoomSettingsFromLegacyCrypto.apply(this, arguments);
283
- }
284
- function _migrateRoomSettingsFromLegacyCrypto() {
285
- _migrateRoomSettingsFromLegacyCrypto = _asyncToGenerator(function* (_ref) {
286
- var logger = _ref.logger,
287
- legacyStore = _ref.legacyStore,
288
- olmMachine = _ref.olmMachine;
289
- if (!(yield legacyStore.containsData())) {
290
- // This store was never used. Nothing to migrate.
291
- return;
292
- }
293
- var migrationState = yield legacyStore.getMigrationState();
294
- if (migrationState >= MigrationState.ROOM_SETTINGS_MIGRATED) {
295
- // We've already migrated the room settings.
296
- return;
297
- }
298
- var rooms = {};
299
- yield legacyStore.doTxn("readwrite", [IndexedDBCryptoStore.STORE_ROOMS], txn => {
300
- legacyStore.getEndToEndRooms(txn, result => {
301
- rooms = result;
302
- });
286
+ async function getAndDecryptCachedSecretKey(legacyStore, legacyPickleKey, name) {
287
+ const key = await new Promise(resolve => {
288
+ legacyStore.doTxn("readonly", [IndexedDBCryptoStore.STORE_ACCOUNT], txn => {
289
+ legacyStore.getSecretStorePrivateKey(txn, resolve, name);
303
290
  });
304
- logger.debug("Migrating ".concat(Object.keys(rooms).length, " sets of room settings"));
305
- for (var _ref4 of Object.entries(rooms)) {
306
- var _ref3 = _slicedToArray(_ref4, 2);
307
- var roomId = _ref3[0];
308
- var legacySettings = _ref3[1];
309
- try {
310
- var rustSettings = new RustSdkCryptoJs.RoomSettings();
311
- if (legacySettings.algorithm !== "m.megolm.v1.aes-sha2") {
312
- logger.warn("Room ".concat(roomId, ": ignoring room with invalid algorithm ").concat(legacySettings.algorithm));
313
- continue;
314
- }
315
- rustSettings.algorithm = RustSdkCryptoJs.EncryptionAlgorithm.MegolmV1AesSha2;
316
- rustSettings.sessionRotationPeriodMs = legacySettings.rotation_period_ms;
317
- rustSettings.sessionRotationPeriodMessages = legacySettings.rotation_period_msgs;
318
- yield olmMachine.setRoomSettings(new RustSdkCryptoJs.RoomId(roomId), rustSettings);
319
-
320
- // We don't attempt to clear out the settings from the old store, or record where we've gotten up to,
321
- // which means that if the app gets restarted while we're in the middle of this migration, we'll start
322
- // again from scratch. So be it. Given that legacy crypto loads the whole room list into memory on startup
323
- // anyway, we know it can't be that big.
324
- } catch (e) {
325
- logger.warn("Room ".concat(roomId, ": ignoring settings ").concat(JSON.stringify(legacySettings), " which caused error ").concat(e));
326
- }
327
- }
328
- logger.debug("Completed room settings migration");
329
- yield legacyStore.setMigrationState(MigrationState.ROOM_SETTINGS_MIGRATED);
330
291
  });
331
- return _migrateRoomSettingsFromLegacyCrypto.apply(this, arguments);
332
- }
333
- function getAndDecryptCachedSecretKey(_x22, _x23, _x24) {
334
- return _getAndDecryptCachedSecretKey.apply(this, arguments);
292
+ if (key && key.ciphertext && key.iv && key.mac) {
293
+ return await decryptAESSecretStorageItem(key, legacyPickleKey, name);
294
+ } else if (key instanceof Uint8Array) {
295
+ // This is a legacy backward compatibility case where the key was stored in clear.
296
+ return encodeBase64(key);
297
+ } else {
298
+ return undefined;
299
+ }
335
300
  }
301
+
336
302
  /**
337
303
  * Check if the user's published identity (ie, public cross-signing keys) was trusted by the legacy session,
338
304
  * and if so mark it as trusted in the Rust session if needed.
@@ -352,26 +318,54 @@ function getAndDecryptCachedSecretKey(_x22, _x23, _x24) {
352
318
  *
353
319
  * @param args - Argument object.
354
320
  */
355
- function _getAndDecryptCachedSecretKey() {
356
- _getAndDecryptCachedSecretKey = _asyncToGenerator(function* (legacyStore, legacyPickleKey, name) {
357
- var key = yield new Promise(resolve => {
358
- legacyStore.doTxn("readonly", [IndexedDBCryptoStore.STORE_ACCOUNT], txn => {
359
- legacyStore.getSecretStorePrivateKey(txn, resolve, name);
360
- });
361
- });
362
- if (key && key.ciphertext && key.iv && key.mac) {
363
- return yield decryptAESSecretStorageItem(key, legacyPickleKey, name);
364
- } else if (key instanceof Uint8Array) {
365
- // This is a legacy backward compatibility case where the key was stored in clear.
366
- return encodeBase64(key);
367
- } else {
368
- return undefined;
369
- }
370
- });
371
- return _getAndDecryptCachedSecretKey.apply(this, arguments);
372
- }
373
- export function migrateLegacyLocalTrustIfNeeded(_x25) {
374
- return _migrateLegacyLocalTrustIfNeeded.apply(this, arguments);
321
+ export async function migrateLegacyLocalTrustIfNeeded(args) {
322
+ const {
323
+ legacyCryptoStore,
324
+ rustCrypto,
325
+ logger
326
+ } = args;
327
+ // Get the public cross-signing identity from rust.
328
+ const rustOwnIdentity = await rustCrypto.getOwnIdentity();
329
+ if (!rustOwnIdentity) {
330
+ // There are no cross-signing keys published server side, so nothing to do here.
331
+ return;
332
+ }
333
+ if (rustOwnIdentity.isVerified()) {
334
+ // The rust session already trusts the keys, so again, nothing to do.
335
+ return;
336
+ }
337
+ const legacyLocallyTrustedMSK = await getLegacyTrustedPublicMasterKeyBase64(legacyCryptoStore);
338
+ if (!legacyLocallyTrustedMSK) {
339
+ // The user never verified their identity in the legacy session, so nothing to do.
340
+ return;
341
+ }
342
+ const mskInfo = JSON.parse(rustOwnIdentity.masterKey);
343
+ if (!mskInfo.keys || Object.keys(mskInfo.keys).length === 0) {
344
+ // This should not happen, but let's be safe
345
+ logger.error("Post Migration | Unexpected error: no master key in the rust session.");
346
+ return;
347
+ }
348
+ const rustSeenMSK = Object.values(mskInfo.keys)[0];
349
+ if (rustSeenMSK && rustSeenMSK == legacyLocallyTrustedMSK) {
350
+ logger.info(`Post Migration: Migrating legacy trusted MSK: ${legacyLocallyTrustedMSK} to locally verified.`);
351
+ // Let's mark the user identity as locally verified as part of the migration.
352
+ await rustOwnIdentity.verify();
353
+ // As well as marking the MSK as trusted, `OlmMachine.verify` returns a
354
+ // `SignatureUploadRequest` which will publish a signature of the MSK using
355
+ // this device. In this case, we ignore the request: since the user hasn't
356
+ // actually re-verified the MSK, we don't publish a new signature. (`.verify`
357
+ // doesn't store the signature, and if we drop the request here it won't be
358
+ // retried.)
359
+ //
360
+ // Not publishing the signature is consistent with the behaviour of
361
+ // matrix-crypto-sdk when the private key is imported via
362
+ // `importCrossSigningKeys`, and when the identity is verified via interactive
363
+ // verification.
364
+ //
365
+ // [Aside: device signatures on the MSK are not considered by the rust-sdk to
366
+ // establish the trust of the user identity so in any case, what we actually do
367
+ // here is somewhat moot.]
368
+ }
375
369
  }
376
370
 
377
371
  /**
@@ -381,74 +375,18 @@ export function migrateLegacyLocalTrustIfNeeded(_x25) {
381
375
  *
382
376
  * @returns `null` if there were no cross signing keys or if they were not trusted. The trusted public master key if it was.
383
377
  */
384
- function _migrateLegacyLocalTrustIfNeeded() {
385
- _migrateLegacyLocalTrustIfNeeded = _asyncToGenerator(function* (args) {
386
- var legacyCryptoStore = args.legacyCryptoStore,
387
- rustCrypto = args.rustCrypto,
388
- logger = args.logger;
389
- // Get the public cross-signing identity from rust.
390
- var rustOwnIdentity = yield rustCrypto.getOwnIdentity();
391
- if (!rustOwnIdentity) {
392
- // There are no cross-signing keys published server side, so nothing to do here.
393
- return;
394
- }
395
- if (rustOwnIdentity.isVerified()) {
396
- // The rust session already trusts the keys, so again, nothing to do.
397
- return;
398
- }
399
- var legacyLocallyTrustedMSK = yield getLegacyTrustedPublicMasterKeyBase64(legacyCryptoStore);
400
- if (!legacyLocallyTrustedMSK) {
401
- // The user never verified their identity in the legacy session, so nothing to do.
402
- return;
403
- }
404
- var mskInfo = JSON.parse(rustOwnIdentity.masterKey);
405
- if (!mskInfo.keys || Object.keys(mskInfo.keys).length === 0) {
406
- // This should not happen, but let's be safe
407
- logger.error("Post Migration | Unexpected error: no master key in the rust session.");
408
- return;
409
- }
410
- var rustSeenMSK = Object.values(mskInfo.keys)[0];
411
- if (rustSeenMSK && rustSeenMSK == legacyLocallyTrustedMSK) {
412
- logger.info("Post Migration: Migrating legacy trusted MSK: ".concat(legacyLocallyTrustedMSK, " to locally verified."));
413
- // Let's mark the user identity as locally verified as part of the migration.
414
- yield rustOwnIdentity.verify();
415
- // As well as marking the MSK as trusted, `OlmMachine.verify` returns a
416
- // `SignatureUploadRequest` which will publish a signature of the MSK using
417
- // this device. In this case, we ignore the request: since the user hasn't
418
- // actually re-verified the MSK, we don't publish a new signature. (`.verify`
419
- // doesn't store the signature, and if we drop the request here it won't be
420
- // retried.)
421
- //
422
- // Not publishing the signature is consistent with the behaviour of
423
- // matrix-crypto-sdk when the private key is imported via
424
- // `importCrossSigningKeys`, and when the identity is verified via interactive
425
- // verification.
426
- //
427
- // [Aside: device signatures on the MSK are not considered by the rust-sdk to
428
- // establish the trust of the user identity so in any case, what we actually do
429
- // here is somewhat moot.]
430
- }
431
- });
432
- return _migrateLegacyLocalTrustIfNeeded.apply(this, arguments);
433
- }
434
- function getLegacyTrustedPublicMasterKeyBase64(_x26) {
435
- return _getLegacyTrustedPublicMasterKeyBase.apply(this, arguments);
436
- }
437
- function _getLegacyTrustedPublicMasterKeyBase() {
438
- _getLegacyTrustedPublicMasterKeyBase = _asyncToGenerator(function* (legacyStore) {
439
- var maybeTrustedKeys = null;
440
- yield legacyStore.doTxn("readonly", "account", txn => {
441
- legacyStore.getCrossSigningKeys(txn, keys => {
442
- // can be an empty object after resetting cross-signing keys, see storeTrustedSelfKeys
443
- var msk = keys === null || keys === void 0 ? void 0 : keys.master;
444
- if (msk && Object.keys(msk.keys).length != 0) {
445
- // `msk.keys` is an object with { [`ed25519:${pubKey}`]: pubKey }
446
- maybeTrustedKeys = Object.values(msk.keys)[0];
447
- }
448
- });
378
+ async function getLegacyTrustedPublicMasterKeyBase64(legacyStore) {
379
+ let maybeTrustedKeys = null;
380
+ await legacyStore.doTxn("readonly", "account", txn => {
381
+ legacyStore.getCrossSigningKeys(txn, keys => {
382
+ // can be an empty object after resetting cross-signing keys, see storeTrustedSelfKeys
383
+ const msk = keys?.master;
384
+ if (msk && Object.keys(msk.keys).length != 0) {
385
+ // `msk.keys` is an object with { [`ed25519:${pubKey}`]: pubKey }
386
+ maybeTrustedKeys = Object.values(msk.keys)[0];
387
+ }
449
388
  });
450
- return maybeTrustedKeys;
451
389
  });
452
- return _getLegacyTrustedPublicMasterKeyBase.apply(this, arguments);
390
+ return maybeTrustedKeys;
453
391
  }
454
392
  //# sourceMappingURL=libolm_migration.js.map