@unwanted/matrix-sdk-mini 34.12.0-2 → 34.12.0-4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (492) hide show
  1. package/git-revision.txt +1 -1
  2. package/lib/@types/global.d.js +0 -2
  3. package/lib/@types/global.d.js.map +1 -1
  4. package/lib/browser-index.d.ts.map +1 -1
  5. package/lib/browser-index.js +0 -11
  6. package/lib/browser-index.js.map +1 -1
  7. package/lib/client.d.ts +2 -1221
  8. package/lib/client.d.ts.map +1 -1
  9. package/lib/client.js +331 -2821
  10. package/lib/client.js.map +1 -1
  11. package/lib/embedded.d.ts +0 -22
  12. package/lib/embedded.d.ts.map +1 -1
  13. package/lib/embedded.js +24 -166
  14. package/lib/embedded.js.map +1 -1
  15. package/lib/event-mapper.d.ts.map +1 -1
  16. package/lib/event-mapper.js +0 -4
  17. package/lib/event-mapper.js.map +1 -1
  18. package/lib/matrix.d.ts +0 -19
  19. package/lib/matrix.d.ts.map +1 -1
  20. package/lib/matrix.js +1 -26
  21. package/lib/matrix.js.map +1 -1
  22. package/lib/models/MSC3089Branch.d.ts.map +1 -1
  23. package/lib/models/MSC3089Branch.js +0 -3
  24. package/lib/models/MSC3089Branch.js.map +1 -1
  25. package/lib/models/event.d.ts +0 -94
  26. package/lib/models/event.d.ts.map +1 -1
  27. package/lib/models/event.js +0 -274
  28. package/lib/models/event.js.map +1 -1
  29. package/lib/models/poll.d.ts.map +1 -1
  30. package/lib/models/poll.js +1 -5
  31. package/lib/models/poll.js.map +1 -1
  32. package/lib/models/relations-container.d.ts.map +1 -1
  33. package/lib/models/relations-container.js +1 -7
  34. package/lib/models/relations-container.js.map +1 -1
  35. package/lib/models/relations.d.ts +0 -1
  36. package/lib/models/relations.d.ts.map +1 -1
  37. package/lib/models/relations.js +0 -8
  38. package/lib/models/relations.js.map +1 -1
  39. package/lib/models/room-state.d.ts.map +1 -1
  40. package/lib/models/room-state.js +10 -26
  41. package/lib/models/room-state.js.map +1 -1
  42. package/lib/models/room.d.ts +0 -18
  43. package/lib/models/room.d.ts.map +1 -1
  44. package/lib/models/room.js +94 -148
  45. package/lib/models/room.js.map +1 -1
  46. package/lib/models/thread.d.ts.map +1 -1
  47. package/lib/models/thread.js +0 -1
  48. package/lib/models/thread.js.map +1 -1
  49. package/lib/sliding-sync-sdk.d.ts +2 -3
  50. package/lib/sliding-sync-sdk.d.ts.map +1 -1
  51. package/lib/sliding-sync-sdk.js +41 -90
  52. package/lib/sliding-sync-sdk.js.map +1 -1
  53. package/lib/sync.d.ts +0 -12
  54. package/lib/sync.d.ts.map +1 -1
  55. package/lib/sync.js +1 -73
  56. package/lib/sync.js.map +1 -1
  57. package/lib/testing.d.ts +0 -48
  58. package/lib/testing.d.ts.map +1 -1
  59. package/lib/testing.js +0 -105
  60. package/lib/testing.js.map +1 -1
  61. package/lib/types.d.ts +0 -1
  62. package/lib/types.d.ts.map +1 -1
  63. package/lib/types.js.map +1 -1
  64. package/package.json +1 -3
  65. package/src/@types/global.d.ts +0 -3
  66. package/src/browser-index.ts +0 -11
  67. package/src/client.ts +60 -2882
  68. package/src/embedded.ts +3 -130
  69. package/src/event-mapper.ts +0 -4
  70. package/src/matrix.ts +0 -28
  71. package/src/models/MSC3089Branch.ts +0 -3
  72. package/src/models/event.ts +0 -289
  73. package/src/models/poll.ts +0 -6
  74. package/src/models/relations-container.ts +1 -8
  75. package/src/models/relations.ts +0 -8
  76. package/src/models/room-state.ts +2 -8
  77. package/src/models/room.ts +0 -62
  78. package/src/models/thread.ts +0 -1
  79. package/src/sliding-sync-sdk.ts +2 -72
  80. package/src/sync.ts +1 -98
  81. package/src/testing.ts +0 -108
  82. package/src/types.ts +0 -1
  83. package/CHANGELOG.md +0 -5910
  84. package/lib/@types/AESEncryptedSecretStoragePayload.d.ts +0 -14
  85. package/lib/@types/AESEncryptedSecretStoragePayload.d.ts.map +0 -1
  86. package/lib/@types/AESEncryptedSecretStoragePayload.js +0 -1
  87. package/lib/@types/AESEncryptedSecretStoragePayload.js.map +0 -1
  88. package/lib/@types/crypto.d.ts +0 -47
  89. package/lib/@types/crypto.d.ts.map +0 -1
  90. package/lib/@types/crypto.js +0 -1
  91. package/lib/@types/crypto.js.map +0 -1
  92. package/lib/@types/matrix-sdk-crypto-wasm.d.js +0 -1
  93. package/lib/@types/matrix-sdk-crypto-wasm.d.js.map +0 -1
  94. package/lib/common-crypto/CryptoBackend.d.ts +0 -240
  95. package/lib/common-crypto/CryptoBackend.d.ts.map +0 -1
  96. package/lib/common-crypto/CryptoBackend.js +0 -73
  97. package/lib/common-crypto/CryptoBackend.js.map +0 -1
  98. package/lib/common-crypto/key-passphrase.d.ts +0 -14
  99. package/lib/common-crypto/key-passphrase.d.ts.map +0 -1
  100. package/lib/common-crypto/key-passphrase.js +0 -33
  101. package/lib/common-crypto/key-passphrase.js.map +0 -1
  102. package/lib/crypto/CrossSigning.d.ts +0 -184
  103. package/lib/crypto/CrossSigning.d.ts.map +0 -1
  104. package/lib/crypto/CrossSigning.js +0 -718
  105. package/lib/crypto/CrossSigning.js.map +0 -1
  106. package/lib/crypto/DeviceList.d.ts +0 -216
  107. package/lib/crypto/DeviceList.d.ts.map +0 -1
  108. package/lib/crypto/DeviceList.js +0 -892
  109. package/lib/crypto/DeviceList.js.map +0 -1
  110. package/lib/crypto/EncryptionSetup.d.ts +0 -152
  111. package/lib/crypto/EncryptionSetup.d.ts.map +0 -1
  112. package/lib/crypto/EncryptionSetup.js +0 -356
  113. package/lib/crypto/EncryptionSetup.js.map +0 -1
  114. package/lib/crypto/OlmDevice.d.ts +0 -457
  115. package/lib/crypto/OlmDevice.d.ts.map +0 -1
  116. package/lib/crypto/OlmDevice.js +0 -1241
  117. package/lib/crypto/OlmDevice.js.map +0 -1
  118. package/lib/crypto/OutgoingRoomKeyRequestManager.d.ts +0 -109
  119. package/lib/crypto/OutgoingRoomKeyRequestManager.d.ts.map +0 -1
  120. package/lib/crypto/OutgoingRoomKeyRequestManager.js +0 -415
  121. package/lib/crypto/OutgoingRoomKeyRequestManager.js.map +0 -1
  122. package/lib/crypto/RoomList.d.ts +0 -26
  123. package/lib/crypto/RoomList.d.ts.map +0 -1
  124. package/lib/crypto/RoomList.js +0 -71
  125. package/lib/crypto/RoomList.js.map +0 -1
  126. package/lib/crypto/SecretSharing.d.ts +0 -24
  127. package/lib/crypto/SecretSharing.d.ts.map +0 -1
  128. package/lib/crypto/SecretSharing.js +0 -194
  129. package/lib/crypto/SecretSharing.js.map +0 -1
  130. package/lib/crypto/SecretStorage.d.ts +0 -55
  131. package/lib/crypto/SecretStorage.d.ts.map +0 -1
  132. package/lib/crypto/SecretStorage.js +0 -118
  133. package/lib/crypto/SecretStorage.js.map +0 -1
  134. package/lib/crypto/aes.d.ts +0 -6
  135. package/lib/crypto/aes.d.ts.map +0 -1
  136. package/lib/crypto/aes.js +0 -24
  137. package/lib/crypto/aes.js.map +0 -1
  138. package/lib/crypto/algorithms/base.d.ts +0 -156
  139. package/lib/crypto/algorithms/base.d.ts.map +0 -1
  140. package/lib/crypto/algorithms/base.js +0 -187
  141. package/lib/crypto/algorithms/base.js.map +0 -1
  142. package/lib/crypto/algorithms/index.d.ts +0 -4
  143. package/lib/crypto/algorithms/index.d.ts.map +0 -1
  144. package/lib/crypto/algorithms/index.js +0 -20
  145. package/lib/crypto/algorithms/index.js.map +0 -1
  146. package/lib/crypto/algorithms/megolm.d.ts +0 -385
  147. package/lib/crypto/algorithms/megolm.d.ts.map +0 -1
  148. package/lib/crypto/algorithms/megolm.js +0 -1822
  149. package/lib/crypto/algorithms/megolm.js.map +0 -1
  150. package/lib/crypto/algorithms/olm.d.ts +0 -5
  151. package/lib/crypto/algorithms/olm.d.ts.map +0 -1
  152. package/lib/crypto/algorithms/olm.js +0 -299
  153. package/lib/crypto/algorithms/olm.js.map +0 -1
  154. package/lib/crypto/api.d.ts +0 -32
  155. package/lib/crypto/api.d.ts.map +0 -1
  156. package/lib/crypto/api.js +0 -22
  157. package/lib/crypto/api.js.map +0 -1
  158. package/lib/crypto/backup.d.ts +0 -227
  159. package/lib/crypto/backup.d.ts.map +0 -1
  160. package/lib/crypto/backup.js +0 -824
  161. package/lib/crypto/backup.js.map +0 -1
  162. package/lib/crypto/crypto.d.ts +0 -3
  163. package/lib/crypto/crypto.d.ts.map +0 -1
  164. package/lib/crypto/crypto.js +0 -19
  165. package/lib/crypto/crypto.js.map +0 -1
  166. package/lib/crypto/dehydration.d.ts +0 -34
  167. package/lib/crypto/dehydration.d.ts.map +0 -1
  168. package/lib/crypto/dehydration.js +0 -252
  169. package/lib/crypto/dehydration.js.map +0 -1
  170. package/lib/crypto/device-converter.d.ts +0 -9
  171. package/lib/crypto/device-converter.d.ts.map +0 -1
  172. package/lib/crypto/device-converter.js +0 -42
  173. package/lib/crypto/device-converter.js.map +0 -1
  174. package/lib/crypto/deviceinfo.d.ts +0 -99
  175. package/lib/crypto/deviceinfo.d.ts.map +0 -1
  176. package/lib/crypto/deviceinfo.js +0 -148
  177. package/lib/crypto/deviceinfo.js.map +0 -1
  178. package/lib/crypto/index.d.ts +0 -1209
  179. package/lib/crypto/index.d.ts.map +0 -1
  180. package/lib/crypto/index.js +0 -4097
  181. package/lib/crypto/index.js.map +0 -1
  182. package/lib/crypto/key_passphrase.d.ts +0 -14
  183. package/lib/crypto/key_passphrase.d.ts.map +0 -1
  184. package/lib/crypto/key_passphrase.js +0 -44
  185. package/lib/crypto/key_passphrase.js.map +0 -1
  186. package/lib/crypto/keybackup.d.ts +0 -18
  187. package/lib/crypto/keybackup.d.ts.map +0 -1
  188. package/lib/crypto/keybackup.js +0 -1
  189. package/lib/crypto/keybackup.js.map +0 -1
  190. package/lib/crypto/olmlib.d.ts +0 -129
  191. package/lib/crypto/olmlib.d.ts.map +0 -1
  192. package/lib/crypto/olmlib.js +0 -492
  193. package/lib/crypto/olmlib.js.map +0 -1
  194. package/lib/crypto/recoverykey.d.ts +0 -2
  195. package/lib/crypto/recoverykey.d.ts.map +0 -1
  196. package/lib/crypto/recoverykey.js +0 -19
  197. package/lib/crypto/recoverykey.js.map +0 -1
  198. package/lib/crypto/store/base.d.ts +0 -252
  199. package/lib/crypto/store/base.d.ts.map +0 -1
  200. package/lib/crypto/store/base.js +0 -64
  201. package/lib/crypto/store/base.js.map +0 -1
  202. package/lib/crypto/store/indexeddb-crypto-store-backend.d.ts +0 -187
  203. package/lib/crypto/store/indexeddb-crypto-store-backend.d.ts.map +0 -1
  204. package/lib/crypto/store/indexeddb-crypto-store-backend.js +0 -1145
  205. package/lib/crypto/store/indexeddb-crypto-store-backend.js.map +0 -1
  206. package/lib/crypto/store/indexeddb-crypto-store.d.ts +0 -432
  207. package/lib/crypto/store/indexeddb-crypto-store.d.ts.map +0 -1
  208. package/lib/crypto/store/indexeddb-crypto-store.js +0 -728
  209. package/lib/crypto/store/indexeddb-crypto-store.js.map +0 -1
  210. package/lib/crypto/store/localStorage-crypto-store.d.ts +0 -119
  211. package/lib/crypto/store/localStorage-crypto-store.d.ts.map +0 -1
  212. package/lib/crypto/store/localStorage-crypto-store.js +0 -531
  213. package/lib/crypto/store/localStorage-crypto-store.js.map +0 -1
  214. package/lib/crypto/store/memory-crypto-store.d.ts +0 -215
  215. package/lib/crypto/store/memory-crypto-store.d.ts.map +0 -1
  216. package/lib/crypto/store/memory-crypto-store.js +0 -622
  217. package/lib/crypto/store/memory-crypto-store.js.map +0 -1
  218. package/lib/crypto/verification/Base.d.ts +0 -105
  219. package/lib/crypto/verification/Base.d.ts.map +0 -1
  220. package/lib/crypto/verification/Base.js +0 -372
  221. package/lib/crypto/verification/Base.js.map +0 -1
  222. package/lib/crypto/verification/Error.d.ts +0 -35
  223. package/lib/crypto/verification/Error.d.ts.map +0 -1
  224. package/lib/crypto/verification/Error.js +0 -86
  225. package/lib/crypto/verification/Error.js.map +0 -1
  226. package/lib/crypto/verification/IllegalMethod.d.ts +0 -15
  227. package/lib/crypto/verification/IllegalMethod.d.ts.map +0 -1
  228. package/lib/crypto/verification/IllegalMethod.js +0 -43
  229. package/lib/crypto/verification/IllegalMethod.js.map +0 -1
  230. package/lib/crypto/verification/QRCode.d.ts +0 -51
  231. package/lib/crypto/verification/QRCode.d.ts.map +0 -1
  232. package/lib/crypto/verification/QRCode.js +0 -277
  233. package/lib/crypto/verification/QRCode.js.map +0 -1
  234. package/lib/crypto/verification/SAS.d.ts +0 -27
  235. package/lib/crypto/verification/SAS.d.ts.map +0 -1
  236. package/lib/crypto/verification/SAS.js +0 -485
  237. package/lib/crypto/verification/SAS.js.map +0 -1
  238. package/lib/crypto/verification/SASDecimal.d.ts +0 -8
  239. package/lib/crypto/verification/SASDecimal.d.ts.map +0 -1
  240. package/lib/crypto/verification/SASDecimal.js +0 -34
  241. package/lib/crypto/verification/SASDecimal.js.map +0 -1
  242. package/lib/crypto/verification/request/Channel.d.ts +0 -18
  243. package/lib/crypto/verification/request/Channel.d.ts.map +0 -1
  244. package/lib/crypto/verification/request/Channel.js +0 -1
  245. package/lib/crypto/verification/request/Channel.js.map +0 -1
  246. package/lib/crypto/verification/request/InRoomChannel.d.ts +0 -113
  247. package/lib/crypto/verification/request/InRoomChannel.d.ts.map +0 -1
  248. package/lib/crypto/verification/request/InRoomChannel.js +0 -351
  249. package/lib/crypto/verification/request/InRoomChannel.js.map +0 -1
  250. package/lib/crypto/verification/request/ToDeviceChannel.d.ts +0 -105
  251. package/lib/crypto/verification/request/ToDeviceChannel.d.ts.map +0 -1
  252. package/lib/crypto/verification/request/ToDeviceChannel.js +0 -328
  253. package/lib/crypto/verification/request/ToDeviceChannel.js.map +0 -1
  254. package/lib/crypto/verification/request/VerificationRequest.d.ts +0 -227
  255. package/lib/crypto/verification/request/VerificationRequest.d.ts.map +0 -1
  256. package/lib/crypto/verification/request/VerificationRequest.js +0 -937
  257. package/lib/crypto/verification/request/VerificationRequest.js.map +0 -1
  258. package/lib/crypto-api/CryptoEvent.d.ts +0 -69
  259. package/lib/crypto-api/CryptoEvent.d.ts.map +0 -1
  260. package/lib/crypto-api/CryptoEvent.js +0 -33
  261. package/lib/crypto-api/CryptoEvent.js.map +0 -1
  262. package/lib/crypto-api/CryptoEventHandlerMap.d.ts +0 -16
  263. package/lib/crypto-api/CryptoEventHandlerMap.d.ts.map +0 -1
  264. package/lib/crypto-api/CryptoEventHandlerMap.js +0 -22
  265. package/lib/crypto-api/CryptoEventHandlerMap.js.map +0 -1
  266. package/lib/crypto-api/index.d.ts +0 -978
  267. package/lib/crypto-api/index.d.ts.map +0 -1
  268. package/lib/crypto-api/index.js +0 -304
  269. package/lib/crypto-api/index.js.map +0 -1
  270. package/lib/crypto-api/key-passphrase.d.ts +0 -11
  271. package/lib/crypto-api/key-passphrase.d.ts.map +0 -1
  272. package/lib/crypto-api/key-passphrase.js +0 -51
  273. package/lib/crypto-api/key-passphrase.js.map +0 -1
  274. package/lib/crypto-api/keybackup.d.ts +0 -88
  275. package/lib/crypto-api/keybackup.d.ts.map +0 -1
  276. package/lib/crypto-api/keybackup.js +0 -1
  277. package/lib/crypto-api/keybackup.js.map +0 -1
  278. package/lib/crypto-api/recovery-key.d.ts +0 -11
  279. package/lib/crypto-api/recovery-key.d.ts.map +0 -1
  280. package/lib/crypto-api/recovery-key.js +0 -65
  281. package/lib/crypto-api/recovery-key.js.map +0 -1
  282. package/lib/crypto-api/verification.d.ts +0 -344
  283. package/lib/crypto-api/verification.d.ts.map +0 -1
  284. package/lib/crypto-api/verification.js +0 -91
  285. package/lib/crypto-api/verification.js.map +0 -1
  286. package/lib/rendezvous/MSC4108SignInWithQR.d.ts +0 -112
  287. package/lib/rendezvous/MSC4108SignInWithQR.d.ts.map +0 -1
  288. package/lib/rendezvous/MSC4108SignInWithQR.js +0 -392
  289. package/lib/rendezvous/MSC4108SignInWithQR.js.map +0 -1
  290. package/lib/rendezvous/RendezvousChannel.d.ts +0 -27
  291. package/lib/rendezvous/RendezvousChannel.d.ts.map +0 -1
  292. package/lib/rendezvous/RendezvousChannel.js +0 -1
  293. package/lib/rendezvous/RendezvousChannel.js.map +0 -1
  294. package/lib/rendezvous/RendezvousCode.d.ts +0 -9
  295. package/lib/rendezvous/RendezvousCode.d.ts.map +0 -1
  296. package/lib/rendezvous/RendezvousCode.js +0 -1
  297. package/lib/rendezvous/RendezvousCode.js.map +0 -1
  298. package/lib/rendezvous/RendezvousError.d.ts +0 -6
  299. package/lib/rendezvous/RendezvousError.d.ts.map +0 -1
  300. package/lib/rendezvous/RendezvousError.js +0 -23
  301. package/lib/rendezvous/RendezvousError.js.map +0 -1
  302. package/lib/rendezvous/RendezvousFailureReason.d.ts +0 -31
  303. package/lib/rendezvous/RendezvousFailureReason.d.ts.map +0 -1
  304. package/lib/rendezvous/RendezvousFailureReason.js +0 -38
  305. package/lib/rendezvous/RendezvousFailureReason.js.map +0 -1
  306. package/lib/rendezvous/RendezvousIntent.d.ts +0 -5
  307. package/lib/rendezvous/RendezvousIntent.d.ts.map +0 -1
  308. package/lib/rendezvous/RendezvousIntent.js +0 -22
  309. package/lib/rendezvous/RendezvousIntent.js.map +0 -1
  310. package/lib/rendezvous/RendezvousTransport.d.ts +0 -36
  311. package/lib/rendezvous/RendezvousTransport.d.ts.map +0 -1
  312. package/lib/rendezvous/RendezvousTransport.js +0 -1
  313. package/lib/rendezvous/RendezvousTransport.js.map +0 -1
  314. package/lib/rendezvous/channels/MSC4108SecureChannel.d.ts +0 -58
  315. package/lib/rendezvous/channels/MSC4108SecureChannel.d.ts.map +0 -1
  316. package/lib/rendezvous/channels/MSC4108SecureChannel.js +0 -246
  317. package/lib/rendezvous/channels/MSC4108SecureChannel.js.map +0 -1
  318. package/lib/rendezvous/channels/index.d.ts +0 -2
  319. package/lib/rendezvous/channels/index.d.ts.map +0 -1
  320. package/lib/rendezvous/channels/index.js +0 -18
  321. package/lib/rendezvous/channels/index.js.map +0 -1
  322. package/lib/rendezvous/index.d.ts +0 -10
  323. package/lib/rendezvous/index.d.ts.map +0 -1
  324. package/lib/rendezvous/index.js +0 -23
  325. package/lib/rendezvous/index.js.map +0 -1
  326. package/lib/rendezvous/transports/MSC4108RendezvousSession.d.ts +0 -61
  327. package/lib/rendezvous/transports/MSC4108RendezvousSession.d.ts.map +0 -1
  328. package/lib/rendezvous/transports/MSC4108RendezvousSession.js +0 -253
  329. package/lib/rendezvous/transports/MSC4108RendezvousSession.js.map +0 -1
  330. package/lib/rendezvous/transports/index.d.ts +0 -2
  331. package/lib/rendezvous/transports/index.d.ts.map +0 -1
  332. package/lib/rendezvous/transports/index.js +0 -18
  333. package/lib/rendezvous/transports/index.js.map +0 -1
  334. package/lib/rust-crypto/CrossSigningIdentity.d.ts +0 -33
  335. package/lib/rust-crypto/CrossSigningIdentity.d.ts.map +0 -1
  336. package/lib/rust-crypto/CrossSigningIdentity.js +0 -157
  337. package/lib/rust-crypto/CrossSigningIdentity.js.map +0 -1
  338. package/lib/rust-crypto/DehydratedDeviceManager.d.ts +0 -98
  339. package/lib/rust-crypto/DehydratedDeviceManager.d.ts.map +0 -1
  340. package/lib/rust-crypto/DehydratedDeviceManager.js +0 -285
  341. package/lib/rust-crypto/DehydratedDeviceManager.js.map +0 -1
  342. package/lib/rust-crypto/KeyClaimManager.d.ts +0 -33
  343. package/lib/rust-crypto/KeyClaimManager.d.ts.map +0 -1
  344. package/lib/rust-crypto/KeyClaimManager.js +0 -82
  345. package/lib/rust-crypto/KeyClaimManager.js.map +0 -1
  346. package/lib/rust-crypto/OutgoingRequestProcessor.d.ts +0 -43
  347. package/lib/rust-crypto/OutgoingRequestProcessor.d.ts.map +0 -1
  348. package/lib/rust-crypto/OutgoingRequestProcessor.js +0 -195
  349. package/lib/rust-crypto/OutgoingRequestProcessor.js.map +0 -1
  350. package/lib/rust-crypto/OutgoingRequestsManager.d.ts +0 -47
  351. package/lib/rust-crypto/OutgoingRequestsManager.d.ts.map +0 -1
  352. package/lib/rust-crypto/OutgoingRequestsManager.js +0 -148
  353. package/lib/rust-crypto/OutgoingRequestsManager.js.map +0 -1
  354. package/lib/rust-crypto/PerSessionKeyBackupDownloader.d.ts +0 -120
  355. package/lib/rust-crypto/PerSessionKeyBackupDownloader.d.ts.map +0 -1
  356. package/lib/rust-crypto/PerSessionKeyBackupDownloader.js +0 -467
  357. package/lib/rust-crypto/PerSessionKeyBackupDownloader.js.map +0 -1
  358. package/lib/rust-crypto/RoomEncryptor.d.ts +0 -98
  359. package/lib/rust-crypto/RoomEncryptor.d.ts.map +0 -1
  360. package/lib/rust-crypto/RoomEncryptor.js +0 -299
  361. package/lib/rust-crypto/RoomEncryptor.js.map +0 -1
  362. package/lib/rust-crypto/backup.d.ts +0 -254
  363. package/lib/rust-crypto/backup.d.ts.map +0 -1
  364. package/lib/rust-crypto/backup.js +0 -837
  365. package/lib/rust-crypto/backup.js.map +0 -1
  366. package/lib/rust-crypto/constants.d.ts +0 -3
  367. package/lib/rust-crypto/constants.d.ts.map +0 -1
  368. package/lib/rust-crypto/constants.js +0 -19
  369. package/lib/rust-crypto/constants.js.map +0 -1
  370. package/lib/rust-crypto/device-converter.d.ts +0 -28
  371. package/lib/rust-crypto/device-converter.d.ts.map +0 -1
  372. package/lib/rust-crypto/device-converter.js +0 -123
  373. package/lib/rust-crypto/device-converter.js.map +0 -1
  374. package/lib/rust-crypto/index.d.ts +0 -61
  375. package/lib/rust-crypto/index.d.ts.map +0 -1
  376. package/lib/rust-crypto/index.js +0 -152
  377. package/lib/rust-crypto/index.js.map +0 -1
  378. package/lib/rust-crypto/libolm_migration.d.ts +0 -81
  379. package/lib/rust-crypto/libolm_migration.d.ts.map +0 -1
  380. package/lib/rust-crypto/libolm_migration.js +0 -459
  381. package/lib/rust-crypto/libolm_migration.js.map +0 -1
  382. package/lib/rust-crypto/rust-crypto.d.ts +0 -556
  383. package/lib/rust-crypto/rust-crypto.d.ts.map +0 -1
  384. package/lib/rust-crypto/rust-crypto.js +0 -2016
  385. package/lib/rust-crypto/rust-crypto.js.map +0 -1
  386. package/lib/rust-crypto/secret-storage.d.ts +0 -22
  387. package/lib/rust-crypto/secret-storage.d.ts.map +0 -1
  388. package/lib/rust-crypto/secret-storage.js +0 -63
  389. package/lib/rust-crypto/secret-storage.js.map +0 -1
  390. package/lib/rust-crypto/verification.d.ts +0 -319
  391. package/lib/rust-crypto/verification.d.ts.map +0 -1
  392. package/lib/rust-crypto/verification.js +0 -816
  393. package/lib/rust-crypto/verification.js.map +0 -1
  394. package/lib/secret-storage.d.ts +0 -370
  395. package/lib/secret-storage.d.ts.map +0 -1
  396. package/lib/secret-storage.js +0 -466
  397. package/lib/secret-storage.js.map +0 -1
  398. package/lib/utils/decryptAESSecretStorageItem.d.ts +0 -12
  399. package/lib/utils/decryptAESSecretStorageItem.d.ts.map +0 -1
  400. package/lib/utils/decryptAESSecretStorageItem.js +0 -50
  401. package/lib/utils/decryptAESSecretStorageItem.js.map +0 -1
  402. package/lib/utils/encryptAESSecretStorageItem.d.ts +0 -16
  403. package/lib/utils/encryptAESSecretStorageItem.d.ts.map +0 -1
  404. package/lib/utils/encryptAESSecretStorageItem.js +0 -68
  405. package/lib/utils/encryptAESSecretStorageItem.js.map +0 -1
  406. package/lib/utils/internal/deriveKeys.d.ts +0 -10
  407. package/lib/utils/internal/deriveKeys.d.ts.map +0 -1
  408. package/lib/utils/internal/deriveKeys.js +0 -60
  409. package/lib/utils/internal/deriveKeys.js.map +0 -1
  410. package/src/@types/AESEncryptedSecretStoragePayload.ts +0 -29
  411. package/src/@types/crypto.ts +0 -73
  412. package/src/@types/matrix-sdk-crypto-wasm.d.ts +0 -44
  413. package/src/common-crypto/CryptoBackend.ts +0 -302
  414. package/src/common-crypto/README.md +0 -4
  415. package/src/common-crypto/key-passphrase.ts +0 -43
  416. package/src/crypto/CrossSigning.ts +0 -773
  417. package/src/crypto/DeviceList.ts +0 -989
  418. package/src/crypto/EncryptionSetup.ts +0 -351
  419. package/src/crypto/OlmDevice.ts +0 -1500
  420. package/src/crypto/OutgoingRoomKeyRequestManager.ts +0 -485
  421. package/src/crypto/RoomList.ts +0 -70
  422. package/src/crypto/SecretSharing.ts +0 -240
  423. package/src/crypto/SecretStorage.ts +0 -136
  424. package/src/crypto/aes.ts +0 -23
  425. package/src/crypto/algorithms/base.ts +0 -236
  426. package/src/crypto/algorithms/index.ts +0 -20
  427. package/src/crypto/algorithms/megolm.ts +0 -2216
  428. package/src/crypto/algorithms/olm.ts +0 -381
  429. package/src/crypto/api.ts +0 -70
  430. package/src/crypto/backup.ts +0 -922
  431. package/src/crypto/crypto.ts +0 -18
  432. package/src/crypto/dehydration.ts +0 -272
  433. package/src/crypto/device-converter.ts +0 -45
  434. package/src/crypto/deviceinfo.ts +0 -158
  435. package/src/crypto/index.ts +0 -4414
  436. package/src/crypto/key_passphrase.ts +0 -42
  437. package/src/crypto/keybackup.ts +0 -47
  438. package/src/crypto/olmlib.ts +0 -539
  439. package/src/crypto/recoverykey.ts +0 -18
  440. package/src/crypto/store/base.ts +0 -348
  441. package/src/crypto/store/indexeddb-crypto-store-backend.ts +0 -1250
  442. package/src/crypto/store/indexeddb-crypto-store.ts +0 -845
  443. package/src/crypto/store/localStorage-crypto-store.ts +0 -579
  444. package/src/crypto/store/memory-crypto-store.ts +0 -680
  445. package/src/crypto/verification/Base.ts +0 -409
  446. package/src/crypto/verification/Error.ts +0 -76
  447. package/src/crypto/verification/IllegalMethod.ts +0 -50
  448. package/src/crypto/verification/QRCode.ts +0 -310
  449. package/src/crypto/verification/SAS.ts +0 -494
  450. package/src/crypto/verification/SASDecimal.ts +0 -37
  451. package/src/crypto/verification/request/Channel.ts +0 -34
  452. package/src/crypto/verification/request/InRoomChannel.ts +0 -371
  453. package/src/crypto/verification/request/ToDeviceChannel.ts +0 -354
  454. package/src/crypto/verification/request/VerificationRequest.ts +0 -976
  455. package/src/crypto-api/CryptoEvent.ts +0 -93
  456. package/src/crypto-api/CryptoEventHandlerMap.ts +0 -32
  457. package/src/crypto-api/index.ts +0 -1175
  458. package/src/crypto-api/key-passphrase.ts +0 -58
  459. package/src/crypto-api/keybackup.ts +0 -115
  460. package/src/crypto-api/recovery-key.ts +0 -69
  461. package/src/crypto-api/verification.ts +0 -408
  462. package/src/rendezvous/MSC4108SignInWithQR.ts +0 -444
  463. package/src/rendezvous/RendezvousChannel.ts +0 -48
  464. package/src/rendezvous/RendezvousCode.ts +0 -25
  465. package/src/rendezvous/RendezvousError.ts +0 -26
  466. package/src/rendezvous/RendezvousFailureReason.ts +0 -49
  467. package/src/rendezvous/RendezvousIntent.ts +0 -20
  468. package/src/rendezvous/RendezvousTransport.ts +0 -58
  469. package/src/rendezvous/channels/MSC4108SecureChannel.ts +0 -270
  470. package/src/rendezvous/channels/index.ts +0 -17
  471. package/src/rendezvous/index.ts +0 -25
  472. package/src/rendezvous/transports/MSC4108RendezvousSession.ts +0 -270
  473. package/src/rendezvous/transports/index.ts +0 -17
  474. package/src/rust-crypto/CrossSigningIdentity.ts +0 -183
  475. package/src/rust-crypto/DehydratedDeviceManager.ts +0 -306
  476. package/src/rust-crypto/KeyClaimManager.ts +0 -86
  477. package/src/rust-crypto/OutgoingRequestProcessor.ts +0 -236
  478. package/src/rust-crypto/OutgoingRequestsManager.ts +0 -143
  479. package/src/rust-crypto/PerSessionKeyBackupDownloader.ts +0 -501
  480. package/src/rust-crypto/RoomEncryptor.ts +0 -352
  481. package/src/rust-crypto/backup.ts +0 -881
  482. package/src/rust-crypto/constants.ts +0 -18
  483. package/src/rust-crypto/device-converter.ts +0 -128
  484. package/src/rust-crypto/index.ts +0 -237
  485. package/src/rust-crypto/libolm_migration.ts +0 -530
  486. package/src/rust-crypto/rust-crypto.ts +0 -2205
  487. package/src/rust-crypto/secret-storage.ts +0 -60
  488. package/src/rust-crypto/verification.ts +0 -830
  489. package/src/secret-storage.ts +0 -693
  490. package/src/utils/decryptAESSecretStorageItem.ts +0 -54
  491. package/src/utils/encryptAESSecretStorageItem.ts +0 -73
  492. package/src/utils/internal/deriveKeys.ts +0 -63
@@ -1,1209 +0,0 @@
1
- import type { IEventDecryptionResult, IMegolmSessionData } from "../@types/crypto.ts";
2
- import { ToDeviceMessageId } from "../@types/event.ts";
3
- import { IExportedDevice, OlmDevice } from "./OlmDevice.ts";
4
- import { IOlmDevice } from "./algorithms/megolm.ts";
5
- import * as olmlib from "./olmlib.ts";
6
- import { DeviceInfoMap, DeviceList } from "./DeviceList.ts";
7
- import { DeviceInfo } from "./deviceinfo.ts";
8
- import type { DecryptionAlgorithm } from "./algorithms/index.ts";
9
- import { CrossSigningInfo, DeviceTrustLevel, UserTrustLevel } from "./CrossSigning.ts";
10
- import { SecretStorage as LegacySecretStorage } from "./SecretStorage.ts";
11
- import { CrossSigningKey, ICreateSecretStorageOpts, IEncryptedEventInfo, IRecoveryKey } from "./api.ts";
12
- import { VerificationBase } from "./verification/Base.ts";
13
- import { VerificationRequest } from "./verification/request/VerificationRequest.ts";
14
- import { InRoomRequests } from "./verification/request/InRoomChannel.ts";
15
- import { DehydrationManager } from "./dehydration.ts";
16
- import { BackupManager } from "./backup.ts";
17
- import { IStore } from "../store/index.ts";
18
- import { Room, RoomEvent } from "../models/room.ts";
19
- import { RoomMemberEvent } from "../models/room-member.ts";
20
- import { MatrixEvent, MatrixEventEvent } from "../models/event.ts";
21
- import { ToDeviceBatch, ToDevicePayload } from "../models/ToDeviceMessage.ts";
22
- import { ClientEvent, IKeysUploadResponse, IUploadKeySignaturesResponse, MatrixClient } from "../client.ts";
23
- import { IRoomEncryption } from "./RoomList.ts";
24
- import { ISyncStateData } from "../sync.ts";
25
- import { CryptoStore } from "./store/base.ts";
26
- import { IVerificationChannel } from "./verification/request/Channel.ts";
27
- import { TypedEventEmitter } from "../models/typed-event-emitter.ts";
28
- import { IDeviceLists, IToDeviceEvent } from "../sync-accumulator.ts";
29
- import { ISignatures } from "../@types/signed.ts";
30
- import { IMessage } from "./algorithms/olm.ts";
31
- import { BackupDecryptor, CryptoBackend, OnSyncCompletedData } from "../common-crypto/CryptoBackend.ts";
32
- import { AddSecretStorageKeyOpts, SecretStorageKeyDescription, SecretStorageKeyObject, SecretStorageKeyTuple } from "../secret-storage.ts";
33
- import { ISecretRequest } from "./SecretSharing.ts";
34
- import { BackupTrustInfo, BootstrapCrossSigningOpts, CrossSigningKeyInfo, CrossSigningStatus, DeviceIsolationMode, DeviceVerificationStatus, EventEncryptionInfo, ImportRoomKeysOpts, KeyBackupCheck, KeyBackupInfo, OwnDeviceKeys, CryptoEventHandlerMap as CryptoApiCryptoEventHandlerMap, KeyBackupRestoreResult, KeyBackupRestoreOpts } from "../crypto-api/index.ts";
35
- import { DeviceMap } from "../models/device.ts";
36
- export type { BootstrapCrossSigningOpts as IBootstrapCrossSigningOpts, CryptoCallbacks as ICryptoCallbacks, } from "../crypto-api/index.ts";
37
- /**
38
- * verification method names
39
- */
40
- export declare const verificationMethods: {
41
- readonly RECIPROCATE_QR_CODE: string;
42
- readonly SAS: string;
43
- };
44
- export type VerificationMethod = keyof typeof verificationMethods | string;
45
- interface IInitOpts {
46
- exportedOlmDevice?: IExportedDevice;
47
- pickleKey?: string;
48
- }
49
- interface IRoomKey {
50
- room_id: string;
51
- algorithm: string;
52
- }
53
- /**
54
- * The parameters of a room key request. The details of the request may
55
- * vary with the crypto algorithm, but the management and storage layers for
56
- * outgoing requests expect it to have 'room_id' and 'session_id' properties.
57
- */
58
- export interface IRoomKeyRequestBody extends IRoomKey {
59
- session_id: string;
60
- sender_key: string;
61
- }
62
- export interface ICheckOwnCrossSigningTrustOpts {
63
- allowPrivateKeyRequests?: boolean;
64
- }
65
- interface IUserOlmSession {
66
- deviceIdKey: string;
67
- sessions: {
68
- sessionId: string;
69
- hasReceivedMessage: boolean;
70
- }[];
71
- }
72
- export interface IRoomKeyRequestRecipient {
73
- userId: string;
74
- deviceId: string;
75
- }
76
- interface ISignableObject {
77
- signatures?: ISignatures;
78
- unsigned?: object;
79
- }
80
- export interface IRequestsMap {
81
- getRequest(event: MatrixEvent): VerificationRequest | undefined;
82
- getRequestByChannel(channel: IVerificationChannel): VerificationRequest | undefined;
83
- setRequest(event: MatrixEvent, request: VerificationRequest): void;
84
- setRequestByChannel(channel: IVerificationChannel, request: VerificationRequest): void;
85
- }
86
- export interface IOlmEncryptedContent {
87
- algorithm: typeof olmlib.OLM_ALGORITHM;
88
- sender_key: string;
89
- ciphertext: Record<string, IMessage>;
90
- [ToDeviceMessageId]?: string;
91
- }
92
- export interface IMegolmEncryptedContent {
93
- algorithm: typeof olmlib.MEGOLM_ALGORITHM;
94
- sender_key: string;
95
- session_id: string;
96
- device_id: string;
97
- ciphertext: string;
98
- [ToDeviceMessageId]?: string;
99
- }
100
- export type IEncryptedContent = IOlmEncryptedContent | IMegolmEncryptedContent;
101
- export declare enum CryptoEvent {
102
- /** @deprecated Event not fired by the rust crypto */
103
- DeviceVerificationChanged = "deviceVerificationChanged",
104
- UserTrustStatusChanged = "userTrustStatusChanged",
105
- /** @deprecated Event not fired by the rust crypto */
106
- UserCrossSigningUpdated = "userCrossSigningUpdated",
107
- /** @deprecated Event not fired by the rust crypto */
108
- RoomKeyRequest = "crypto.roomKeyRequest",
109
- /** @deprecated Event not fired by the rust crypto */
110
- RoomKeyRequestCancellation = "crypto.roomKeyRequestCancellation",
111
- KeyBackupStatus = "crypto.keyBackupStatus",
112
- KeyBackupFailed = "crypto.keyBackupFailed",
113
- KeyBackupSessionsRemaining = "crypto.keyBackupSessionsRemaining",
114
- /**
115
- * Fires when a new valid backup decryption key is in cache.
116
- * This will happen when a secret is received from another session, from secret storage,
117
- * or when a new backup is created from this session.
118
- *
119
- * The payload is the version of the backup for which we have the key for.
120
- *
121
- * This event is only fired by the rust crypto backend.
122
- */
123
- KeyBackupDecryptionKeyCached = "crypto.keyBackupDecryptionKeyCached",
124
- /** @deprecated Event not fired by the rust crypto */
125
- KeySignatureUploadFailure = "crypto.keySignatureUploadFailure",
126
- /** @deprecated Use `VerificationRequestReceived`. */
127
- VerificationRequest = "crypto.verification.request",
128
- /**
129
- * Fires when a key verification request is received.
130
- *
131
- * The payload is a {@link Crypto.VerificationRequest}.
132
- */
133
- VerificationRequestReceived = "crypto.verificationRequestReceived",
134
- /** @deprecated Event not fired by the rust crypto */
135
- Warning = "crypto.warning",
136
- /** @deprecated Use {@link DevicesUpdated} instead when using rust crypto */
137
- WillUpdateDevices = "crypto.willUpdateDevices",
138
- DevicesUpdated = "crypto.devicesUpdated",
139
- KeysChanged = "crossSigning.keysChanged",
140
- /**
141
- * Fires when data is being migrated from legacy crypto to rust crypto.
142
- *
143
- * The payload is a pair `(progress, total)`, where `progress` is the number of steps completed so far, and
144
- * `total` is the total number of steps. When migration is complete, a final instance of the event is emitted, with
145
- * `progress === total === -1`.
146
- */
147
- LegacyCryptoStoreMigrationProgress = "crypto.legacyCryptoStoreMigrationProgress"
148
- }
149
- export type CryptoEventHandlerMap = CryptoApiCryptoEventHandlerMap & {
150
- /**
151
- * Fires when a device is marked as verified/unverified/blocked/unblocked by
152
- * {@link MatrixClient#setDeviceVerified | MatrixClient.setDeviceVerified} or
153
- * {@link MatrixClient#setDeviceBlocked | MatrixClient.setDeviceBlocked}.
154
- *
155
- * @param userId - the owner of the verified device
156
- * @param deviceId - the id of the verified device
157
- * @param deviceInfo - updated device information
158
- */
159
- [CryptoEvent.DeviceVerificationChanged]: (userId: string, deviceId: string, deviceInfo: DeviceInfo) => void;
160
- /**
161
- * Fires when we receive a room key request
162
- *
163
- * @param request - request details
164
- */
165
- [CryptoEvent.RoomKeyRequest]: (request: IncomingRoomKeyRequest) => void;
166
- /**
167
- * Fires when we receive a room key request cancellation
168
- */
169
- [CryptoEvent.RoomKeyRequestCancellation]: (request: IncomingRoomKeyRequestCancellation) => void;
170
- [CryptoEvent.KeySignatureUploadFailure]: (failures: IUploadKeySignaturesResponse["failures"], source: "checkOwnCrossSigningTrust" | "afterCrossSigningLocalKeyChange" | "setDeviceVerification", upload: (opts: {
171
- shouldEmit: boolean;
172
- }) => Promise<void>) => void;
173
- /**
174
- * Fires when a key verification is requested.
175
- *
176
- * Deprecated: use `CryptoEvent.VerificationRequestReceived`.
177
- */
178
- [CryptoEvent.VerificationRequest]: (request: VerificationRequest<any>) => void;
179
- /**
180
- * Fires when the app may wish to warn the user about something related
181
- * the end-to-end crypto.
182
- *
183
- * @param type - One of the strings listed above
184
- */
185
- [CryptoEvent.Warning]: (type: string) => void;
186
- [CryptoEvent.UserCrossSigningUpdated]: (userId: string) => void;
187
- [CryptoEvent.LegacyCryptoStoreMigrationProgress]: (progress: number, total: number) => void;
188
- };
189
- export declare class Crypto extends TypedEventEmitter<CryptoEvent, CryptoEventHandlerMap> implements CryptoBackend {
190
- readonly baseApis: MatrixClient;
191
- readonly userId: string;
192
- private readonly deviceId;
193
- private readonly clientStore;
194
- readonly cryptoStore: CryptoStore;
195
- /**
196
- * @returns The version of Olm.
197
- */
198
- static getOlmVersion(): [number, number, number];
199
- readonly backupManager: BackupManager;
200
- readonly crossSigningInfo: CrossSigningInfo;
201
- readonly olmDevice: OlmDevice;
202
- readonly deviceList: DeviceList;
203
- readonly dehydrationManager: DehydrationManager;
204
- readonly secretStorage: LegacySecretStorage;
205
- private readonly roomList;
206
- private readonly reEmitter;
207
- private readonly verificationMethods;
208
- readonly supportedAlgorithms: string[];
209
- private readonly outgoingRoomKeyRequestManager;
210
- private readonly toDeviceVerificationRequests;
211
- readonly inRoomVerificationRequests: InRoomRequests;
212
- private trustCrossSignedDevices;
213
- private lastOneTimeKeyCheck;
214
- private oneTimeKeyCheckInProgress;
215
- private roomEncryptors;
216
- private roomDecryptors;
217
- private deviceKeys;
218
- globalBlacklistUnverifiedDevices: boolean;
219
- globalErrorOnUnknownDevices: boolean;
220
- private receivedRoomKeyRequests;
221
- private receivedRoomKeyRequestCancellations;
222
- private processingRoomKeyRequests;
223
- private lazyLoadMembers;
224
- private roomDeviceTrackingState;
225
- private forceNewSessionRetryTime;
226
- private sendKeyRequestsImmediately;
227
- private oneTimeKeyCount?;
228
- private needsNewFallback?;
229
- private fallbackCleanup?;
230
- /**
231
- * Cryptography bits
232
- *
233
- * This module is internal to the js-sdk; the public API is via MatrixClient.
234
- *
235
- * @internal
236
- *
237
- * @param baseApis - base matrix api interface
238
- *
239
- * @param userId - The user ID for the local user
240
- *
241
- * @param deviceId - The identifier for this device.
242
- *
243
- * @param clientStore - the MatrixClient data store.
244
- *
245
- * @param cryptoStore - storage for the crypto layer.
246
- *
247
- * @param verificationMethods - Array of verification methods to use.
248
- * Each element can either be a string from MatrixClient.verificationMethods
249
- * or a class that implements a verification method.
250
- */
251
- constructor(baseApis: MatrixClient, userId: string, deviceId: string, clientStore: IStore, cryptoStore: CryptoStore, verificationMethods: Array<VerificationMethod | (typeof VerificationBase & {
252
- NAME: string;
253
- })>);
254
- /**
255
- * Initialise the crypto module so that it is ready for use
256
- *
257
- * Returns a promise which resolves once the crypto module is ready for use.
258
- *
259
- * @param exportedOlmDevice - (Optional) data from exported device
260
- * that must be re-created.
261
- */
262
- init({ exportedOlmDevice, pickleKey }?: IInitOpts): Promise<void>;
263
- /**
264
- * Implementation of {@link Crypto.CryptoApi#setDeviceIsolationMode}.
265
- */
266
- setDeviceIsolationMode(isolationMode: DeviceIsolationMode): void;
267
- /**
268
- * Implementation of {@link Crypto.CryptoApi#getVersion}.
269
- */
270
- getVersion(): string;
271
- /**
272
- * Whether to trust a others users signatures of their devices.
273
- * If false, devices will only be considered 'verified' if we have
274
- * verified that device individually (effectively disabling cross-signing).
275
- *
276
- * Default: true
277
- *
278
- * @returns True if trusting cross-signed devices
279
- */
280
- getTrustCrossSignedDevices(): boolean;
281
- /**
282
- * @deprecated Use {@link Crypto.CryptoApi#getTrustCrossSignedDevices}.
283
- */
284
- getCryptoTrustCrossSignedDevices(): boolean;
285
- /**
286
- * See getCryptoTrustCrossSignedDevices
287
- *
288
- * @param val - True to trust cross-signed devices
289
- */
290
- setTrustCrossSignedDevices(val: boolean): void;
291
- /**
292
- * @deprecated Use {@link Crypto.CryptoApi#setTrustCrossSignedDevices}.
293
- */
294
- setCryptoTrustCrossSignedDevices(val: boolean): void;
295
- /**
296
- * Create a recovery key from a user-supplied passphrase.
297
- *
298
- * @param password - Passphrase string that can be entered by the user
299
- * when restoring the backup as an alternative to entering the recovery key.
300
- * Optional.
301
- * @returns Object with public key metadata, encoded private
302
- * recovery key which should be disposed of after displaying to the user,
303
- * and raw private key to avoid round tripping if needed.
304
- */
305
- createRecoveryKeyFromPassphrase(password?: string): Promise<IRecoveryKey>;
306
- /**
307
- * Checks if the user has previously published cross-signing keys
308
- *
309
- * This means downloading the devicelist for the user and checking if the list includes
310
- * the cross-signing pseudo-device.
311
- *
312
- * @internal
313
- */
314
- userHasCrossSigningKeys(userId?: string): Promise<boolean>;
315
- /**
316
- * Checks whether cross signing:
317
- * - is enabled on this account and trusted by this device
318
- * - has private keys either cached locally or stored in secret storage
319
- *
320
- * If this function returns false, bootstrapCrossSigning() can be used
321
- * to fix things such that it returns true. That is to say, after
322
- * bootstrapCrossSigning() completes successfully, this function should
323
- * return true.
324
- *
325
- * The cross-signing API is currently UNSTABLE and may change without notice.
326
- *
327
- * @returns True if cross-signing is ready to be used on this device
328
- */
329
- isCrossSigningReady(): Promise<boolean>;
330
- /**
331
- * Checks whether secret storage:
332
- * - is enabled on this account
333
- * - is storing cross-signing private keys
334
- * - is storing session backup key (if enabled)
335
- *
336
- * If this function returns false, bootstrapSecretStorage() can be used
337
- * to fix things such that it returns true. That is to say, after
338
- * bootstrapSecretStorage() completes successfully, this function should
339
- * return true.
340
- *
341
- * The Secure Secret Storage API is currently UNSTABLE and may change without notice.
342
- *
343
- * @returns True if secret storage is ready to be used on this device
344
- */
345
- isSecretStorageReady(): Promise<boolean>;
346
- /**
347
- * Implementation of {@link Crypto.CryptoApi#getCrossSigningStatus}
348
- */
349
- getCrossSigningStatus(): Promise<CrossSigningStatus>;
350
- /**
351
- * Bootstrap cross-signing by creating keys if needed. If everything is already
352
- * set up, then no changes are made, so this is safe to run to ensure
353
- * cross-signing is ready for use.
354
- *
355
- * This function:
356
- * - creates new cross-signing keys if they are not found locally cached nor in
357
- * secret storage (if it has been setup)
358
- *
359
- * The cross-signing API is currently UNSTABLE and may change without notice.
360
- */
361
- bootstrapCrossSigning({ authUploadDeviceSigningKeys, setupNewCrossSigning, }?: BootstrapCrossSigningOpts): Promise<void>;
362
- /**
363
- * Bootstrap Secure Secret Storage if needed by creating a default key. If everything is
364
- * already set up, then no changes are made, so this is safe to run to ensure secret
365
- * storage is ready for use.
366
- *
367
- * This function
368
- * - creates a new Secure Secret Storage key if no default key exists
369
- * - if a key backup exists, it is migrated to store the key in the Secret
370
- * Storage
371
- * - creates a backup if none exists, and one is requested
372
- * - migrates Secure Secret Storage to use the latest algorithm, if an outdated
373
- * algorithm is found
374
- *
375
- * The Secure Secret Storage API is currently UNSTABLE and may change without notice.
376
- *
377
- * Returns:
378
- * A promise which resolves to key creation data for
379
- * SecretStorage#addKey: an object with `passphrase` etc fields.
380
- */
381
- bootstrapSecretStorage({ createSecretStorageKey, keyBackupInfo, setupNewKeyBackup, setupNewSecretStorage, getKeyBackupPassphrase, }?: ICreateSecretStorageOpts): Promise<void>;
382
- /**
383
- * Implementation of {@link Crypto.CryptoApi#resetKeyBackup}.
384
- */
385
- resetKeyBackup(): Promise<void>;
386
- /**
387
- * Implementation of {@link Crypto.CryptoApi#deleteKeyBackupVersion}.
388
- */
389
- deleteKeyBackupVersion(version: string): Promise<void>;
390
- /**
391
- * @deprecated Use {@link MatrixClient#secretStorage} and {@link SecretStorage.ServerSideSecretStorage#addKey}.
392
- */
393
- addSecretStorageKey(algorithm: string, opts: AddSecretStorageKeyOpts, keyID?: string): Promise<SecretStorageKeyObject>;
394
- /**
395
- * @deprecated Use {@link MatrixClient#secretStorage} and {@link SecretStorage.ServerSideSecretStorage#hasKey}.
396
- */
397
- hasSecretStorageKey(keyID?: string): Promise<boolean>;
398
- /**
399
- * @deprecated Use {@link MatrixClient#secretStorage} and {@link SecretStorage.ServerSideSecretStorage#getKey}.
400
- */
401
- getSecretStorageKey(keyID?: string): Promise<SecretStorageKeyTuple | null>;
402
- /**
403
- * @deprecated Use {@link MatrixClient#secretStorage} and {@link SecretStorage.ServerSideSecretStorage#store}.
404
- */
405
- storeSecret(name: string, secret: string, keys?: string[]): Promise<void>;
406
- /**
407
- * @deprecated Use {@link MatrixClient#secretStorage} and {@link SecretStorage.ServerSideSecretStorage#get}.
408
- */
409
- getSecret(name: string): Promise<string | undefined>;
410
- /**
411
- * @deprecated Use {@link MatrixClient#secretStorage} and {@link SecretStorage.ServerSideSecretStorage#isStored}.
412
- */
413
- isSecretStored(name: string): Promise<Record<string, SecretStorageKeyDescription> | null>;
414
- requestSecret(name: string, devices: string[]): ISecretRequest;
415
- /**
416
- * @deprecated Use {@link MatrixClient#secretStorage} and {@link SecretStorage.ServerSideSecretStorage#getDefaultKeyId}.
417
- */
418
- getDefaultSecretStorageKeyId(): Promise<string | null>;
419
- /**
420
- * @deprecated Use {@link MatrixClient#secretStorage} and {@link SecretStorage.ServerSideSecretStorage#setDefaultKeyId}.
421
- */
422
- setDefaultSecretStorageKeyId(k: string): Promise<void>;
423
- /**
424
- * @deprecated Use {@link MatrixClient#secretStorage} and {@link SecretStorage.ServerSideSecretStorage#checkKey}.
425
- */
426
- checkSecretStorageKey(key: Uint8Array, info: SecretStorageKeyDescription): Promise<boolean>;
427
- /**
428
- * Checks that a given secret storage private key matches a given public key.
429
- * This can be used by the getSecretStorageKey callback to verify that the
430
- * private key it is about to supply is the one that was requested.
431
- *
432
- * @param privateKey - The private key
433
- * @param expectedPublicKey - The public key
434
- * @returns true if the key matches, otherwise false
435
- */
436
- checkSecretStoragePrivateKey(privateKey: Uint8Array, expectedPublicKey: string): boolean;
437
- /**
438
- * Fetches the backup private key, if cached
439
- * @returns the key, if any, or null
440
- */
441
- getSessionBackupPrivateKey(): Promise<Uint8Array | null>;
442
- /**
443
- * Stores the session backup key to the cache
444
- * @param key - the private key
445
- * @returns a promise so you can catch failures
446
- */
447
- storeSessionBackupPrivateKey(key: ArrayLike<number>, version?: string): Promise<void>;
448
- /**
449
- * Implementation of {@link Crypto.loadSessionBackupPrivateKeyFromSecretStorage}.
450
- */
451
- loadSessionBackupPrivateKeyFromSecretStorage(): Promise<void>;
452
- /**
453
- * Get the current status of key backup.
454
- *
455
- * Implementation of {@link Crypto.CryptoApi.getActiveSessionBackupVersion}.
456
- */
457
- getActiveSessionBackupVersion(): Promise<string | null>;
458
- /**
459
- * Implementation of {@link Crypto.CryptoApi#getKeyBackupInfo}.
460
- */
461
- getKeyBackupInfo(): Promise<KeyBackupInfo | null>;
462
- /**
463
- * Determine if a key backup can be trusted.
464
- *
465
- * Implementation of {@link Crypto.CryptoApi.isKeyBackupTrusted}.
466
- */
467
- isKeyBackupTrusted(info: KeyBackupInfo): Promise<BackupTrustInfo>;
468
- /**
469
- * Force a re-check of the key backup and enable/disable it as appropriate.
470
- *
471
- * Implementation of {@link Crypto.CryptoApi.checkKeyBackupAndEnable}.
472
- */
473
- checkKeyBackupAndEnable(): Promise<KeyBackupCheck | null>;
474
- /**
475
- * Checks that a given cross-signing private key matches a given public key.
476
- * This can be used by the getCrossSigningKey callback to verify that the
477
- * private key it is about to supply is the one that was requested.
478
- *
479
- * @param privateKey - The private key
480
- * @param expectedPublicKey - The public key
481
- * @returns true if the key matches, otherwise false
482
- */
483
- checkCrossSigningPrivateKey(privateKey: Uint8Array, expectedPublicKey: string): boolean;
484
- /**
485
- * Run various follow-up actions after cross-signing keys have changed locally
486
- * (either by resetting the keys for the account or by getting them from secret
487
- * storage), such as signing the current device, upgrading device
488
- * verifications, etc.
489
- */
490
- private afterCrossSigningLocalKeyChange;
491
- /**
492
- * Check if a user's cross-signing key is a candidate for upgrading from device
493
- * verification.
494
- *
495
- * @param userId - the user whose cross-signing information is to be checked
496
- * @param crossSigningInfo - the cross-signing information to check
497
- */
498
- private checkForDeviceVerificationUpgrade;
499
- /**
500
- * Check if the cross-signing key is signed by a verified device.
501
- *
502
- * @param userId - the user ID whose key is being checked
503
- * @param key - the key that is being checked
504
- * @param devices - the user's devices. Should be a map from device ID
505
- * to device info
506
- */
507
- private checkForValidDeviceSignature;
508
- /**
509
- * Get the user's cross-signing key ID.
510
- *
511
- * @param type - The type of key to get the ID of. One of
512
- * "master", "self_signing", or "user_signing". Defaults to "master".
513
- *
514
- * @returns the key ID
515
- */
516
- getCrossSigningKeyId(type?: CrossSigningKey): Promise<string | null>;
517
- getCrossSigningId(type: string): string | null;
518
- /**
519
- * Get the cross signing information for a given user.
520
- *
521
- * @param userId - the user ID to get the cross-signing info for.
522
- *
523
- * @returns the cross signing information for the user.
524
- */
525
- getStoredCrossSigningForUser(userId: string): CrossSigningInfo | null;
526
- /**
527
- * Check whether a given user is trusted.
528
- *
529
- * @param userId - The ID of the user to check.
530
- *
531
- * @returns
532
- */
533
- checkUserTrust(userId: string): UserTrustLevel;
534
- /**
535
- * Implementation of {@link Crypto.CryptoApi.getUserVerificationStatus}.
536
- */
537
- getUserVerificationStatus(userId: string): Promise<UserTrustLevel>;
538
- /**
539
- * Implementation of {@link Crypto.CryptoApi.pinCurrentUserIdentity}.
540
- */
541
- pinCurrentUserIdentity(userId: string): Promise<void>;
542
- /**
543
- * Check whether a given device is trusted.
544
- *
545
- * @param userId - The ID of the user whose device is to be checked.
546
- * @param deviceId - The ID of the device to check
547
- */
548
- getDeviceVerificationStatus(userId: string, deviceId: string): Promise<DeviceVerificationStatus | null>;
549
- /**
550
- * @deprecated Use {@link Crypto.CryptoApi.getDeviceVerificationStatus}.
551
- */
552
- checkDeviceTrust(userId: string, deviceId: string): DeviceTrustLevel;
553
- /**
554
- * Check whether a given deviceinfo is trusted.
555
- *
556
- * @param userId - The ID of the user whose devices is to be checked.
557
- * @param device - The device info object to check
558
- *
559
- * @deprecated Use {@link Crypto.CryptoApi.getDeviceVerificationStatus}.
560
- */
561
- checkDeviceInfoTrust(userId: string, device?: DeviceInfo): DeviceTrustLevel;
562
- /**
563
- * Check whether one of our own devices is cross-signed by our
564
- * user's stored keys, regardless of whether we trust those keys yet.
565
- *
566
- * @param deviceId - The ID of the device to check
567
- *
568
- * @returns true if the device is cross-signed
569
- */
570
- checkIfOwnDeviceCrossSigned(deviceId: string): boolean;
571
- private onDeviceListUserCrossSigningUpdated;
572
- /**
573
- * Check the copy of our cross-signing key that we have in the device list and
574
- * see if we can get the private key. If so, mark it as trusted.
575
- */
576
- checkOwnCrossSigningTrust({ allowPrivateKeyRequests, }?: ICheckOwnCrossSigningTrustOpts): Promise<void>;
577
- /**
578
- * Implementation of {@link CryptoBackend#getBackupDecryptor}.
579
- */
580
- getBackupDecryptor(backupInfo: KeyBackupInfo, privKey: ArrayLike<number>): Promise<BackupDecryptor>;
581
- /**
582
- * Implementation of {@link CryptoBackend#importBackedUpRoomKeys}.
583
- */
584
- importBackedUpRoomKeys(keys: IMegolmSessionData[], backupVersion: string, opts?: ImportRoomKeysOpts): Promise<void>;
585
- /**
586
- * Store a set of keys as our own, trusted, cross-signing keys.
587
- *
588
- * @param keys - The new trusted set of keys
589
- */
590
- private storeTrustedSelfKeys;
591
- /**
592
- * Check if the master key is signed by a verified device, and if so, prompt
593
- * the application to mark it as verified.
594
- *
595
- * @param userId - the user ID whose key should be checked
596
- */
597
- private checkDeviceVerifications;
598
- /**
599
- */
600
- enableLazyLoading(): void;
601
- /**
602
- * Tell the crypto module to register for MatrixClient events which it needs to
603
- * listen for
604
- *
605
- * @param eventEmitter - event source where we can register
606
- * for event notifications
607
- */
608
- registerEventHandlers(eventEmitter: TypedEventEmitter<RoomMemberEvent.Membership | ClientEvent.ToDeviceEvent | RoomEvent.Timeline | MatrixEventEvent.Decrypted, any>): void;
609
- /**
610
- * @deprecated this does nothing and will be removed in a future version
611
- */
612
- start(): void;
613
- /** Stop background processes related to crypto */
614
- stop(): void;
615
- /**
616
- * Get the Ed25519 key for this device
617
- *
618
- * @returns base64-encoded ed25519 key.
619
- *
620
- * @deprecated Use {@link Crypto.CryptoApi#getOwnDeviceKeys}.
621
- */
622
- getDeviceEd25519Key(): string | null;
623
- /**
624
- * Get the Curve25519 key for this device
625
- *
626
- * @returns base64-encoded curve25519 key.
627
- *
628
- * @deprecated Use {@link Crypto.CryptoApi#getOwnDeviceKeys}
629
- */
630
- getDeviceCurve25519Key(): string | null;
631
- /**
632
- * Implementation of {@link Crypto.CryptoApi#getOwnDeviceKeys}.
633
- */
634
- getOwnDeviceKeys(): Promise<OwnDeviceKeys>;
635
- /**
636
- * Set the global override for whether the client should ever send encrypted
637
- * messages to unverified devices. This provides the default for rooms which
638
- * do not specify a value.
639
- *
640
- * @param value - whether to blacklist all unverified devices by default
641
- *
642
- * @deprecated Set {@link Crypto.CryptoApi#globalBlacklistUnverifiedDevices | CryptoApi.globalBlacklistUnverifiedDevices} directly.
643
- */
644
- setGlobalBlacklistUnverifiedDevices(value: boolean): void;
645
- /**
646
- * @returns whether to blacklist all unverified devices by default
647
- *
648
- * @deprecated Reference {@link Crypto.CryptoApi#globalBlacklistUnverifiedDevices | CryptoApi.globalBlacklistUnverifiedDevices} directly.
649
- */
650
- getGlobalBlacklistUnverifiedDevices(): boolean;
651
- /**
652
- * Upload the device keys to the homeserver.
653
- * @returns A promise that will resolve when the keys are uploaded.
654
- */
655
- uploadDeviceKeys(): Promise<IKeysUploadResponse>;
656
- getNeedsNewFallback(): boolean;
657
- private maybeUploadOneTimeKeys;
658
- private uploadOneTimeKeys;
659
- /**
660
- * Download the keys for a list of users and stores the keys in the session
661
- * store.
662
- * @param userIds - The users to fetch.
663
- * @param forceDownload - Always download the keys even if cached.
664
- *
665
- * @returns A promise which resolves to a map `userId->deviceId->{@link DeviceInfo}`.
666
- */
667
- downloadKeys(userIds: string[], forceDownload?: boolean): Promise<DeviceInfoMap>;
668
- /**
669
- * Get the stored device keys for a user id
670
- *
671
- * @param userId - the user to list keys for.
672
- *
673
- * @returns list of devices, or null if we haven't
674
- * managed to get a list of devices for this user yet.
675
- */
676
- getStoredDevicesForUser(userId: string): Array<DeviceInfo> | null;
677
- /**
678
- * Get the device information for the given list of users.
679
- *
680
- * @param userIds - The users to fetch.
681
- * @param downloadUncached - If true, download the device list for users whose device list we are not
682
- * currently tracking. Defaults to false, in which case such users will not appear at all in the result map.
683
- *
684
- * @returns A map `{@link DeviceMap}`.
685
- */
686
- getUserDeviceInfo(userIds: string[], downloadUncached?: boolean): Promise<DeviceMap>;
687
- /**
688
- * Get the stored keys for a single device
689
- *
690
- *
691
- * @returns device, or undefined
692
- * if we don't know about this device
693
- */
694
- getStoredDevice(userId: string, deviceId: string): DeviceInfo | undefined;
695
- /**
696
- * Save the device list, if necessary
697
- *
698
- * @param delay - Time in ms before which the save actually happens.
699
- * By default, the save is delayed for a short period in order to batch
700
- * multiple writes, but this behaviour can be disabled by passing 0.
701
- *
702
- * @returns true if the data was saved, false if
703
- * it was not (eg. because no changes were pending). The promise
704
- * will only resolve once the data is saved, so may take some time
705
- * to resolve.
706
- */
707
- saveDeviceList(delay: number): Promise<boolean>;
708
- /**
709
- * Mark the given device as locally verified.
710
- *
711
- * Implementation of {@link Crypto.CryptoApi#setDeviceVerified}.
712
- */
713
- setDeviceVerified(userId: string, deviceId: string, verified?: boolean): Promise<void>;
714
- /**
715
- * Blindly cross-sign one of our other devices.
716
- *
717
- * Implementation of {@link Crypto.CryptoApi#crossSignDevice}.
718
- */
719
- crossSignDevice(deviceId: string): Promise<void>;
720
- /**
721
- * Update the blocked/verified state of the given device
722
- *
723
- * @param userId - owner of the device
724
- * @param deviceId - unique identifier for the device or user's
725
- * cross-signing public key ID.
726
- *
727
- * @param verified - whether to mark the device as verified. Null to
728
- * leave unchanged.
729
- *
730
- * @param blocked - whether to mark the device as blocked. Null to
731
- * leave unchanged.
732
- *
733
- * @param known - whether to mark that the user has been made aware of
734
- * the existence of this device. Null to leave unchanged
735
- *
736
- * @param keys - The list of keys that was present
737
- * during the device verification. This will be double checked with the list
738
- * of keys the given device has currently.
739
- *
740
- * @returns updated DeviceInfo
741
- */
742
- setDeviceVerification(userId: string, deviceId: string, verified?: boolean | null, blocked?: boolean | null, known?: boolean | null, keys?: Record<string, string>): Promise<DeviceInfo | CrossSigningInfo | CrossSigningKeyInfo | undefined>;
743
- findVerificationRequestDMInProgress(roomId: string, userId?: string): VerificationRequest | undefined;
744
- getVerificationRequestsToDeviceInProgress(userId: string): VerificationRequest[];
745
- requestVerificationDM(userId: string, roomId: string): Promise<VerificationRequest>;
746
- /** @deprecated Use `requestOwnUserVerificationToDevice` or `requestDeviceVerification` */
747
- requestVerification(userId: string, devices?: string[]): Promise<VerificationRequest>;
748
- requestOwnUserVerification(): Promise<VerificationRequest>;
749
- requestDeviceVerification(userId: string, deviceId: string): Promise<VerificationRequest>;
750
- private requestVerificationWithChannel;
751
- beginKeyVerification(method: string, userId: string, deviceId: string, transactionId?: string | null): VerificationBase<any, any>;
752
- legacyDeviceVerification(userId: string, deviceId: string, method: VerificationMethod): Promise<VerificationRequest>;
753
- /**
754
- * Get information on the active olm sessions with a user
755
- * <p>
756
- * Returns a map from device id to an object with keys 'deviceIdKey' (the
757
- * device's curve25519 identity key) and 'sessions' (an array of objects in the
758
- * same format as that returned by
759
- * {@link OlmDevice#getSessionInfoForDevice}).
760
- * <p>
761
- * This method is provided for debugging purposes.
762
- *
763
- * @param userId - id of user to inspect
764
- */
765
- getOlmSessionsForUser(userId: string): Promise<Record<string, IUserOlmSession>>;
766
- /**
767
- * Get the device which sent an event
768
- *
769
- * @param event - event to be checked
770
- */
771
- getEventSenderDeviceInfo(event: MatrixEvent): DeviceInfo | null;
772
- /**
773
- * Get information about the encryption of an event
774
- *
775
- * @param event - event to be checked
776
- *
777
- * @returns An object with the fields:
778
- * - encrypted: whether the event is encrypted (if not encrypted, some of the
779
- * other properties may not be set)
780
- * - senderKey: the sender's key
781
- * - algorithm: the algorithm used to encrypt the event
782
- * - authenticated: whether we can be sure that the owner of the senderKey
783
- * sent the event
784
- * - sender: the sender's device information, if available
785
- * - mismatchedSender: if the event's ed25519 and curve25519 keys don't match
786
- * (only meaningful if `sender` is set)
787
- */
788
- getEventEncryptionInfo(event: MatrixEvent): IEncryptedEventInfo;
789
- /**
790
- * Implementation of {@link Crypto.CryptoApi.getEncryptionInfoForEvent}.
791
- */
792
- getEncryptionInfoForEvent(event: MatrixEvent): Promise<EventEncryptionInfo | null>;
793
- /**
794
- * Forces the current outbound group session to be discarded such
795
- * that another one will be created next time an event is sent.
796
- *
797
- * @param roomId - The ID of the room to discard the session for
798
- *
799
- * This should not normally be necessary.
800
- */
801
- forceDiscardSession(roomId: string): Promise<void>;
802
- /**
803
- * Configure a room to use encryption (ie, save a flag in the cryptoStore).
804
- *
805
- * @param roomId - The room ID to enable encryption in.
806
- *
807
- * @param config - The encryption config for the room.
808
- *
809
- * @param inhibitDeviceQuery - true to suppress device list query for
810
- * users in the room (for now). In case lazy loading is enabled,
811
- * the device query is always inhibited as the members are not tracked.
812
- *
813
- * @deprecated It is normally incorrect to call this method directly. Encryption
814
- * is enabled by receiving an `m.room.encryption` event (which we may have sent
815
- * previously).
816
- */
817
- setRoomEncryption(roomId: string, config: IRoomEncryption, inhibitDeviceQuery?: boolean): Promise<void>;
818
- /**
819
- * Set up encryption for a room.
820
- *
821
- * This is called when an <tt>m.room.encryption</tt> event is received. It saves a flag
822
- * for the room in the cryptoStore (if it wasn't already set), sets up an "encryptor" for
823
- * the room, and enables device-list tracking for the room.
824
- *
825
- * It does <em>not</em> initiate a device list query for the room. That is normally
826
- * done once we finish processing the sync, in onSyncCompleted.
827
- *
828
- * @param room - The room to enable encryption in.
829
- * @param config - The encryption config for the room.
830
- */
831
- private setRoomEncryptionImpl;
832
- /**
833
- * Make sure we are tracking the device lists for all users in this room.
834
- *
835
- * @param roomId - The room ID to start tracking devices in.
836
- * @returns when all devices for the room have been fetched and marked to track
837
- * @deprecated there's normally no need to call this function: device list tracking
838
- * will be enabled as soon as we have the full membership list.
839
- */
840
- trackRoomDevices(roomId: string): Promise<void>;
841
- /**
842
- * Make sure we are tracking the device lists for all users in this room.
843
- *
844
- * This is normally called when we are about to send an encrypted event, to make sure
845
- * we have all the devices in the room; but it is also called when processing an
846
- * m.room.encryption state event (if lazy-loading is disabled), or when members are
847
- * loaded (if lazy-loading is enabled), to prepare the device list.
848
- *
849
- * @param room - Room to enable device-list tracking in
850
- */
851
- private trackRoomDevicesImpl;
852
- /**
853
- * Try to make sure we have established olm sessions for all known devices for
854
- * the given users.
855
- *
856
- * @param users - list of user ids
857
- * @param force - If true, force a new Olm session to be created. Default false.
858
- *
859
- * @returns resolves once the sessions are complete, to
860
- * an Object mapping from userId to deviceId to
861
- * `IOlmSessionResult`
862
- */
863
- ensureOlmSessionsForUsers(users: string[], force?: boolean): Promise<Map<string, Map<string, olmlib.IOlmSessionResult>>>;
864
- /**
865
- * Get a list containing all of the room keys
866
- *
867
- * @returns a list of session export objects
868
- */
869
- exportRoomKeys(): Promise<IMegolmSessionData[]>;
870
- /**
871
- * Get a JSON list containing all of the room keys
872
- *
873
- * @returns a JSON string encoding a list of session
874
- * export objects, each of which is an IMegolmSessionData
875
- */
876
- exportRoomKeysAsJson(): Promise<string>;
877
- /**
878
- * Import a list of room keys previously exported by exportRoomKeys
879
- *
880
- * @param keys - a list of session export objects
881
- * @returns a promise which resolves once the keys have been imported
882
- */
883
- importRoomKeys(keys: IMegolmSessionData[], opts?: ImportRoomKeysOpts): Promise<void>;
884
- /**
885
- * Import a JSON string encoding a list of room keys previously
886
- * exported by exportRoomKeysAsJson
887
- *
888
- * @param keys - a JSON string encoding a list of session export
889
- * objects, each of which is an IMegolmSessionData
890
- * @param opts - options object
891
- * @returns a promise which resolves once the keys have been imported
892
- */
893
- importRoomKeysAsJson(keys: string, opts?: ImportRoomKeysOpts): Promise<void>;
894
- /**
895
- * Counts the number of end to end session keys that are waiting to be backed up
896
- * @returns Promise which resolves to the number of sessions requiring backup
897
- */
898
- countSessionsNeedingBackup(): Promise<number>;
899
- /**
900
- * Perform any background tasks that can be done before a message is ready to
901
- * send, in order to speed up sending of the message.
902
- *
903
- * @param room - the room the event is in
904
- */
905
- prepareToEncrypt(room: Room): void;
906
- /**
907
- * Encrypt an event according to the configuration of the room.
908
- *
909
- * @param event - event to be sent
910
- *
911
- * @param room - destination room.
912
- *
913
- * @returns Promise which resolves when the event has been
914
- * encrypted, or null if nothing was needed
915
- */
916
- encryptEvent(event: MatrixEvent, room: Room): Promise<void>;
917
- /**
918
- * Decrypt a received event
919
- *
920
- *
921
- * @returns resolves once we have
922
- * finished decrypting. Rejects with an `algorithms.DecryptionError` if there
923
- * is a problem decrypting the event.
924
- */
925
- decryptEvent(event: MatrixEvent): Promise<IEventDecryptionResult>;
926
- /**
927
- * Handle the notification from /sync that device lists have
928
- * been changed.
929
- *
930
- * @param deviceLists - device_lists field from /sync
931
- */
932
- processDeviceLists(deviceLists: IDeviceLists): Promise<void>;
933
- /**
934
- * Send a request for some room keys, if we have not already done so
935
- *
936
- * @param resend - whether to resend the key request if there is
937
- * already one
938
- *
939
- * @returns a promise that resolves when the key request is queued
940
- */
941
- requestRoomKey(requestBody: IRoomKeyRequestBody, recipients: IRoomKeyRequestRecipient[], resend?: boolean): Promise<void>;
942
- /**
943
- * Cancel any earlier room key request
944
- *
945
- * @param requestBody - parameters to match for cancellation
946
- */
947
- cancelRoomKeyRequest(requestBody: IRoomKeyRequestBody): void;
948
- /**
949
- * Re-send any outgoing key requests, eg after verification
950
- * @returns
951
- */
952
- cancelAndResendAllOutgoingKeyRequests(): Promise<void>;
953
- /**
954
- * handle an m.room.encryption event
955
- *
956
- * @param room - in which the event was received
957
- * @param event - encryption event to be processed
958
- */
959
- onCryptoEvent(room: Room, event: MatrixEvent): Promise<void>;
960
- /**
961
- * Called before the result of a sync is processed
962
- *
963
- * @param syncData - the data from the 'MatrixClient.sync' event
964
- */
965
- onSyncWillProcess(syncData: ISyncStateData): Promise<void>;
966
- /**
967
- * handle the completion of a /sync
968
- *
969
- * This is called after the processing of each successful /sync response.
970
- * It is an opportunity to do a batch process on the information received.
971
- *
972
- * @param syncData - the data from the 'MatrixClient.sync' event
973
- */
974
- onSyncCompleted(syncData: OnSyncCompletedData): Promise<void>;
975
- /**
976
- * Trigger the appropriate invalidations and removes for a given
977
- * device list
978
- *
979
- * @param deviceLists - device_lists field from /sync, or response from
980
- * /keys/changes
981
- */
982
- private evalDeviceListChanges;
983
- /**
984
- * Get a list of all the IDs of users we share an e2e room with
985
- * for which we are tracking devices already
986
- *
987
- * @returns List of user IDs
988
- */
989
- private getTrackedE2eUsers;
990
- /**
991
- * Get a list of the e2e-enabled rooms we are members of,
992
- * and for which we are already tracking the devices
993
- *
994
- * @returns
995
- */
996
- private getTrackedE2eRooms;
997
- /**
998
- * Encrypts and sends a given object via Olm to-device messages to a given
999
- * set of devices.
1000
- * @param userDeviceInfoArr - the devices to send to
1001
- * @param payload - fields to include in the encrypted payload
1002
- * @returns Promise which
1003
- * resolves once the message has been encrypted and sent to the given
1004
- * userDeviceMap, and returns the `{ contentMap, deviceInfoByDeviceId }`
1005
- * of the successfully sent messages.
1006
- *
1007
- * @deprecated Instead use {@link encryptToDeviceMessages} followed by {@link MatrixClient.queueToDevice}.
1008
- */
1009
- encryptAndSendToDevices(userDeviceInfoArr: IOlmDevice<DeviceInfo>[], payload: object): Promise<void>;
1010
- private prepareToDeviceBatch;
1011
- /**
1012
- * Implementation of {@link Crypto.CryptoApi#encryptToDeviceMessages}.
1013
- */
1014
- encryptToDeviceMessages(eventType: string, devices: {
1015
- userId: string;
1016
- deviceId: string;
1017
- }[], payload: ToDevicePayload): Promise<ToDeviceBatch>;
1018
- private onMembership;
1019
- preprocessToDeviceMessages(events: IToDeviceEvent[]): Promise<IToDeviceEvent[]>;
1020
- /**
1021
- * Stores the current one_time_key count which will be handled later (in a call of
1022
- * onSyncCompleted).
1023
- *
1024
- * @param currentCount - The current count of one_time_keys to be stored
1025
- */
1026
- private updateOneTimeKeyCount;
1027
- processKeyCounts(oneTimeKeysCounts?: Record<string, number>, unusedFallbackKeys?: string[]): Promise<void>;
1028
- private onToDeviceEvent;
1029
- /**
1030
- * Handle a key event
1031
- *
1032
- * @internal
1033
- * @param event - key event
1034
- */
1035
- private onRoomKeyEvent;
1036
- /**
1037
- * Handle a key withheld event
1038
- *
1039
- * @internal
1040
- * @param event - key withheld event
1041
- */
1042
- private onRoomKeyWithheldEvent;
1043
- /**
1044
- * Handle a general key verification event.
1045
- *
1046
- * @internal
1047
- * @param event - verification start event
1048
- */
1049
- private onKeyVerificationMessage;
1050
- /**
1051
- * Handle key verification requests sent as timeline events
1052
- *
1053
- * @internal
1054
- * @param event - the timeline event
1055
- * @param room - not used
1056
- * @param atStart - not used
1057
- * @param removed - not used
1058
- * @param whether - this is a live event
1059
- */
1060
- private onTimelineEvent;
1061
- private handleVerificationEvent;
1062
- /**
1063
- * Handle a toDevice event that couldn't be decrypted
1064
- *
1065
- * @internal
1066
- * @param event - undecryptable event
1067
- */
1068
- private onToDeviceBadEncrypted;
1069
- /**
1070
- * Handle a change in the membership state of a member of a room
1071
- *
1072
- * @internal
1073
- * @param event - event causing the change
1074
- * @param member - user whose membership changed
1075
- * @param oldMembership - previous membership
1076
- */
1077
- private onRoomMembership;
1078
- /**
1079
- * Called when we get an m.room_key_request event.
1080
- *
1081
- * @internal
1082
- * @param event - key request event
1083
- */
1084
- private onRoomKeyRequestEvent;
1085
- /**
1086
- * Process any m.room_key_request events which were queued up during the
1087
- * current sync.
1088
- *
1089
- * @internal
1090
- */
1091
- private processReceivedRoomKeyRequests;
1092
- /**
1093
- * Helper for processReceivedRoomKeyRequests
1094
- *
1095
- */
1096
- private processReceivedRoomKeyRequest;
1097
- /**
1098
- * Helper for processReceivedRoomKeyRequests
1099
- *
1100
- */
1101
- private processReceivedRoomKeyRequestCancellation;
1102
- /**
1103
- * Get a decryptor for a given room and algorithm.
1104
- *
1105
- * If we already have a decryptor for the given room and algorithm, return
1106
- * it. Otherwise try to instantiate it.
1107
- *
1108
- * @internal
1109
- *
1110
- * @param roomId - room id for decryptor. If undefined, a temporary
1111
- * decryptor is instantiated.
1112
- *
1113
- * @param algorithm - crypto algorithm
1114
- *
1115
- * @throws `DecryptionError` if the algorithm is unknown
1116
- */
1117
- getRoomDecryptor(roomId: string | null, algorithm: string): DecryptionAlgorithm;
1118
- /**
1119
- * Get all the room decryptors for a given encryption algorithm.
1120
- *
1121
- * @param algorithm - The encryption algorithm
1122
- *
1123
- * @returns An array of room decryptors
1124
- */
1125
- private getRoomDecryptors;
1126
- /**
1127
- * sign the given object with our ed25519 key
1128
- *
1129
- * @param obj - Object to which we will add a 'signatures' property
1130
- */
1131
- signObject<T extends ISignableObject & object>(obj: T): Promise<void>;
1132
- /**
1133
- * @returns true if the room with the supplied ID is encrypted. False if the
1134
- * room is not encrypted, or is unknown to us.
1135
- */
1136
- isRoomEncrypted(roomId: string): boolean;
1137
- /**
1138
- * Implementation of {@link Crypto.CryptoApi#isEncryptionEnabledInRoom}.
1139
- */
1140
- isEncryptionEnabledInRoom(roomId: string): Promise<boolean>;
1141
- /**
1142
- * @returns information about the encryption on the room with the supplied
1143
- * ID, or null if the room is not encrypted or unknown to us.
1144
- */
1145
- getRoomEncryption(roomId: string): IRoomEncryption | null;
1146
- /**
1147
- * Returns whether dehydrated devices are supported by the crypto backend
1148
- * and by the server.
1149
- */
1150
- isDehydrationSupported(): Promise<boolean>;
1151
- /**
1152
- * Stub function -- dehydration is not implemented here, so throw error
1153
- */
1154
- startDehydration(createNewKey?: boolean): Promise<void>;
1155
- /**
1156
- * Stub function -- restoreKeyBackup is not implemented here, so throw error
1157
- */
1158
- restoreKeyBackup(opts: KeyBackupRestoreOpts): Promise<KeyBackupRestoreResult>;
1159
- /**
1160
- * Stub function -- restoreKeyBackupWithPassphrase is not implemented here, so throw error
1161
- */
1162
- restoreKeyBackupWithPassphrase(passphrase: string, opts: KeyBackupRestoreOpts): Promise<KeyBackupRestoreResult>;
1163
- }
1164
- /**
1165
- * Fix up the backup key, that may be in the wrong format due to a bug in a
1166
- * migration step. Some backup keys were stored as a comma-separated list of
1167
- * integers, rather than a base64-encoded byte array. If this function is
1168
- * passed a string that looks like a list of integers rather than a base64
1169
- * string, it will attempt to convert it to the right format.
1170
- *
1171
- * @param key - the key to check
1172
- * @returns If the key is in the wrong format, then the fixed
1173
- * key will be returned. Otherwise null will be returned.
1174
- *
1175
- */
1176
- export declare function fixBackupKey(key?: string): string | null;
1177
- /**
1178
- * Represents a received m.room_key_request event
1179
- */
1180
- export declare class IncomingRoomKeyRequest {
1181
- /** user requesting the key */
1182
- readonly userId: string;
1183
- /** device requesting the key */
1184
- readonly deviceId: string;
1185
- /** unique id for the request */
1186
- readonly requestId: string;
1187
- readonly requestBody: IRoomKeyRequestBody;
1188
- /**
1189
- * callback which, when called, will ask
1190
- * the relevant crypto algorithm implementation to share the keys for
1191
- * this request.
1192
- */
1193
- share: () => void;
1194
- constructor(event: MatrixEvent);
1195
- }
1196
- /**
1197
- * Represents a received m.room_key_request cancellation
1198
- */
1199
- declare class IncomingRoomKeyRequestCancellation {
1200
- /** user requesting the cancellation */
1201
- readonly userId: string;
1202
- /** device requesting the cancellation */
1203
- readonly deviceId: string;
1204
- /** unique id for the request to be cancelled */
1205
- readonly requestId: string;
1206
- constructor(event: MatrixEvent);
1207
- }
1208
- export type { IEventDecryptionResult, IMegolmSessionData } from "../@types/crypto.ts";
1209
- //# sourceMappingURL=index.d.ts.map