@open-e2ee/signal-protocol-sdk 0.1.0-alpha.7 → 0.1.0-alpha.9

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 (655) hide show
  1. package/ADAPTERS.md +1 -1
  2. package/CHANGELOG.md +767 -2
  3. package/COMMERCIAL.md +56 -0
  4. package/README.md +13 -8
  5. package/SECURITY.md +15 -1
  6. package/client/README.md +1 -1
  7. package/dist/client/client.d.ts.map +1 -1
  8. package/dist/client/client.js +16 -8
  9. package/dist/client/client.js.map +1 -1
  10. package/dist/client/config.d.ts +12 -2
  11. package/dist/client/config.d.ts.map +1 -1
  12. package/dist/client/config.js.map +1 -1
  13. package/dist/client/endorsement-manager.d.ts +19 -2
  14. package/dist/client/endorsement-manager.d.ts.map +1 -1
  15. package/dist/client/endorsement-manager.js +26 -10
  16. package/dist/client/endorsement-manager.js.map +1 -1
  17. package/dist/client/headless.d.ts +1 -1
  18. package/dist/client/headless.js +1 -1
  19. package/dist/client/sealed-sender-ops.d.ts +27 -1
  20. package/dist/client/sealed-sender-ops.d.ts.map +1 -1
  21. package/dist/client/sealed-sender-ops.js +36 -6
  22. package/dist/client/sealed-sender-ops.js.map +1 -1
  23. package/dist/client/signal-service-cipher.d.ts +16 -1
  24. package/dist/client/signal-service-cipher.d.ts.map +1 -1
  25. package/dist/client/signal-service-cipher.js +112 -52
  26. package/dist/client/signal-service-cipher.js.map +1 -1
  27. package/dist/client/types.d.ts +20 -7
  28. package/dist/client/types.d.ts.map +1 -1
  29. package/dist/client/types.js.map +1 -1
  30. package/dist/index.d.ts +7 -0
  31. package/dist/index.d.ts.map +1 -1
  32. package/dist/index.js +7 -0
  33. package/dist/index.js.map +1 -1
  34. package/dist/internal/crypto/index.d.ts +1 -1
  35. package/dist/internal/crypto/index.d.ts.map +1 -1
  36. package/dist/internal/crypto/index.js +1 -1
  37. package/dist/internal/crypto/index.js.map +1 -1
  38. package/dist/internal/crypto/random.d.ts +9 -0
  39. package/dist/internal/crypto/random.d.ts.map +1 -1
  40. package/dist/internal/crypto/random.js +16 -0
  41. package/dist/internal/crypto/random.js.map +1 -1
  42. package/dist/internal/groups/manager.d.ts +37 -5
  43. package/dist/internal/groups/manager.d.ts.map +1 -1
  44. package/dist/internal/groups/manager.js +98 -15
  45. package/dist/internal/groups/manager.js.map +1 -1
  46. package/dist/internal/groups/server-engine.d.ts +48 -2
  47. package/dist/internal/groups/server-engine.d.ts.map +1 -1
  48. package/dist/internal/groups/server-engine.js +122 -13
  49. package/dist/internal/groups/server-engine.js.map +1 -1
  50. package/dist/internal/protocol/sealed-sender/decryption-v2.d.ts.map +1 -1
  51. package/dist/internal/protocol/sealed-sender/decryption-v2.js +32 -18
  52. package/dist/internal/protocol/sealed-sender/decryption-v2.js.map +1 -1
  53. package/dist/internal/protocol/sealed-sender/decryption.d.ts.map +1 -1
  54. package/dist/internal/protocol/sealed-sender/decryption.js +33 -19
  55. package/dist/internal/protocol/sealed-sender/decryption.js.map +1 -1
  56. package/dist/internal/protocol/sealed-sender/encryption-v2.d.ts.map +1 -1
  57. package/dist/internal/protocol/sealed-sender/encryption-v2.js +8 -14
  58. package/dist/internal/protocol/sealed-sender/encryption-v2.js.map +1 -1
  59. package/dist/internal/protocol/sealed-sender/encryption.d.ts +9 -4
  60. package/dist/internal/protocol/sealed-sender/encryption.d.ts.map +1 -1
  61. package/dist/internal/protocol/sealed-sender/encryption.js +7 -15
  62. package/dist/internal/protocol/sealed-sender/encryption.js.map +1 -1
  63. package/dist/internal/protocol/sealed-sender/proto/index.d.ts +6 -7
  64. package/dist/internal/protocol/sealed-sender/proto/index.d.ts.map +1 -1
  65. package/dist/internal/protocol/sealed-sender/proto/index.js +5 -7
  66. package/dist/internal/protocol/sealed-sender/proto/index.js.map +1 -1
  67. package/dist/internal/protocol/sealed-sender/trust-root.d.ts +45 -0
  68. package/dist/internal/protocol/sealed-sender/trust-root.d.ts.map +1 -0
  69. package/dist/internal/protocol/sealed-sender/trust-root.js +77 -0
  70. package/dist/internal/protocol/sealed-sender/trust-root.js.map +1 -0
  71. package/dist/internal/protocol/sealed-sender/types.d.ts +64 -9
  72. package/dist/internal/protocol/sealed-sender/types.d.ts.map +1 -1
  73. package/dist/internal/protocol/sealed-sender/types.js +43 -0
  74. package/dist/internal/protocol/sealed-sender/types.js.map +1 -1
  75. package/dist/internal/protocol/sender-keys/manager.d.ts +37 -0
  76. package/dist/internal/protocol/sender-keys/manager.d.ts.map +1 -1
  77. package/dist/internal/protocol/sender-keys/manager.js +108 -7
  78. package/dist/internal/protocol/sender-keys/manager.js.map +1 -1
  79. package/dist/local/store/expo/adapter.d.ts +14 -15
  80. package/dist/local/store/expo/adapter.d.ts.map +1 -1
  81. package/dist/local/store/expo/adapter.js +109 -102
  82. package/dist/local/store/expo/adapter.js.map +1 -1
  83. package/dist/local/store/expo/db.d.ts +4 -1
  84. package/dist/local/store/expo/db.d.ts.map +1 -1
  85. package/dist/local/store/expo/db.js +5 -0
  86. package/dist/local/store/expo/db.js.map +1 -1
  87. package/dist/local/store/expo/index.d.ts +0 -2
  88. package/dist/local/store/expo/index.d.ts.map +1 -1
  89. package/dist/local/store/expo/index.js +1 -1
  90. package/dist/local/store/expo/index.js.map +1 -1
  91. package/dist/local/store/expo/models/index.d.ts +1 -1
  92. package/dist/local/store/expo/models/index.d.ts.map +1 -1
  93. package/dist/local/store/expo/models/index.js +2 -2
  94. package/dist/local/store/expo/models/index.js.map +1 -1
  95. package/dist/local/store/expo/models/sender-key.d.ts +101 -77
  96. package/dist/local/store/expo/models/sender-key.d.ts.map +1 -1
  97. package/dist/local/store/expo/models/sender-key.js +154 -124
  98. package/dist/local/store/expo/models/sender-key.js.map +1 -1
  99. package/dist/local/store/expo/schema.d.ts +134 -32
  100. package/dist/local/store/expo/schema.d.ts.map +1 -1
  101. package/dist/local/store/expo/schema.js +36 -7
  102. package/dist/local/store/expo/schema.js.map +1 -1
  103. package/dist/local/store/mock/adapter.d.ts +1 -0
  104. package/dist/local/store/mock/adapter.d.ts.map +1 -1
  105. package/dist/local/store/mock/adapter.js +18 -0
  106. package/dist/local/store/mock/adapter.js.map +1 -1
  107. package/dist/local/store/node/adapter.d.ts +53 -4
  108. package/dist/local/store/node/adapter.d.ts.map +1 -1
  109. package/dist/local/store/node/adapter.js +456 -9
  110. package/dist/local/store/node/adapter.js.map +1 -1
  111. package/dist/local/store/node/database.d.ts +68 -0
  112. package/dist/local/store/node/database.d.ts.map +1 -1
  113. package/dist/local/store/node/database.js +201 -18
  114. package/dist/local/store/node/database.js.map +1 -1
  115. package/dist/local/store/react-native/adapter.d.ts +39 -0
  116. package/dist/local/store/react-native/adapter.d.ts.map +1 -1
  117. package/dist/local/store/react-native/adapter.js +163 -8
  118. package/dist/local/store/react-native/adapter.js.map +1 -1
  119. package/dist/local/store/web/adapter.d.ts +1 -0
  120. package/dist/local/store/web/adapter.d.ts.map +1 -1
  121. package/dist/local/store/web/adapter.js +33 -1
  122. package/dist/local/store/web/adapter.js.map +1 -1
  123. package/dist/remote/relay/convex/backend.d.ts +405 -0
  124. package/dist/remote/relay/convex/backend.d.ts.map +1 -0
  125. package/dist/remote/relay/convex/backend.js +687 -0
  126. package/dist/remote/relay/convex/backend.js.map +1 -0
  127. package/dist/remote/relay/convex/component/_generated/api.d.ts +58 -0
  128. package/dist/remote/relay/convex/component/_generated/api.d.ts.map +1 -0
  129. package/dist/remote/relay/convex/component/_generated/api.js +31 -0
  130. package/dist/remote/relay/convex/component/_generated/api.js.map +1 -0
  131. package/dist/remote/relay/convex/component/_generated/component.d.ts +483 -0
  132. package/dist/remote/relay/convex/component/_generated/component.d.ts.map +1 -0
  133. package/dist/remote/relay/convex/component/_generated/component.js +11 -0
  134. package/dist/remote/relay/convex/component/_generated/component.js.map +1 -0
  135. package/dist/remote/relay/convex/component/_generated/dataModel.d.ts +46 -0
  136. package/dist/remote/relay/convex/component/_generated/dataModel.d.ts.map +1 -0
  137. package/dist/remote/relay/convex/component/_generated/dataModel.js +11 -0
  138. package/dist/remote/relay/convex/component/_generated/dataModel.js.map +1 -0
  139. package/dist/remote/relay/convex/component/_generated/server.d.ts +129 -0
  140. package/dist/remote/relay/convex/component/_generated/server.d.ts.map +1 -0
  141. package/dist/remote/relay/convex/component/_generated/server.js +79 -0
  142. package/dist/remote/relay/convex/component/_generated/server.js.map +1 -0
  143. package/dist/remote/relay/convex/component/accounts.d.ts +43 -0
  144. package/dist/remote/relay/convex/component/accounts.d.ts.map +1 -0
  145. package/dist/remote/relay/convex/component/accounts.js +181 -0
  146. package/dist/remote/relay/convex/component/accounts.js.map +1 -0
  147. package/dist/remote/relay/convex/component/certificates.d.ts +10 -0
  148. package/dist/remote/relay/convex/component/certificates.d.ts.map +1 -0
  149. package/dist/remote/relay/convex/component/certificates.js +122 -0
  150. package/dist/remote/relay/convex/component/certificates.js.map +1 -0
  151. package/dist/remote/relay/convex/component/cleanup.d.ts +32 -0
  152. package/dist/remote/relay/convex/component/cleanup.d.ts.map +1 -0
  153. package/dist/remote/relay/convex/component/cleanup.js +146 -0
  154. package/dist/remote/relay/convex/component/cleanup.js.map +1 -0
  155. package/dist/remote/relay/convex/component/convex.config.d.ts +5 -0
  156. package/dist/remote/relay/convex/component/convex.config.d.ts.map +1 -0
  157. package/dist/remote/relay/convex/component/convex.config.js +33 -0
  158. package/dist/remote/relay/convex/component/convex.config.js.map +1 -0
  159. package/dist/remote/relay/convex/component/crons.d.ts +3 -0
  160. package/dist/remote/relay/convex/component/crons.d.ts.map +1 -0
  161. package/dist/remote/relay/convex/component/crons.js +10 -0
  162. package/dist/remote/relay/convex/component/crons.js.map +1 -0
  163. package/dist/remote/relay/convex/component/devices.d.ts +101 -0
  164. package/dist/remote/relay/convex/component/devices.d.ts.map +1 -0
  165. package/dist/remote/relay/convex/component/devices.js +299 -0
  166. package/dist/remote/relay/convex/component/devices.js.map +1 -0
  167. package/dist/remote/relay/convex/component/errors.d.ts +22 -0
  168. package/dist/remote/relay/convex/component/errors.d.ts.map +1 -0
  169. package/dist/remote/relay/convex/component/errors.js +17 -0
  170. package/dist/remote/relay/convex/component/errors.js.map +1 -0
  171. package/dist/remote/relay/convex/component/groups.d.ts +63 -0
  172. package/dist/remote/relay/convex/component/groups.d.ts.map +1 -0
  173. package/dist/remote/relay/convex/component/groups.js +341 -0
  174. package/dist/remote/relay/convex/component/groups.js.map +1 -0
  175. package/dist/remote/relay/convex/component/keys.d.ts +130 -0
  176. package/dist/remote/relay/convex/component/keys.d.ts.map +1 -0
  177. package/dist/remote/relay/convex/component/keys.js +578 -0
  178. package/dist/remote/relay/convex/component/keys.js.map +1 -0
  179. package/dist/remote/relay/convex/component/messages.d.ts +119 -0
  180. package/dist/remote/relay/convex/component/messages.d.ts.map +1 -0
  181. package/dist/remote/relay/convex/component/messages.js +723 -0
  182. package/dist/remote/relay/convex/component/messages.js.map +1 -0
  183. package/dist/remote/relay/convex/component/provisioning.d.ts +92 -0
  184. package/dist/remote/relay/convex/component/provisioning.d.ts.map +1 -0
  185. package/dist/remote/relay/convex/component/provisioning.js +359 -0
  186. package/dist/remote/relay/convex/component/provisioning.js.map +1 -0
  187. package/dist/remote/relay/convex/component/runtime.d.ts +18 -0
  188. package/dist/remote/relay/convex/component/runtime.d.ts.map +1 -0
  189. package/dist/remote/relay/convex/component/runtime.js +142 -0
  190. package/dist/remote/relay/convex/component/runtime.js.map +1 -0
  191. package/dist/remote/relay/convex/component/schema.d.ts +358 -0
  192. package/dist/remote/relay/convex/component/schema.d.ts.map +1 -0
  193. package/dist/remote/relay/convex/component/schema.js +287 -0
  194. package/dist/remote/relay/convex/component/schema.js.map +1 -0
  195. package/dist/remote/relay/convex/component/zkAuth.d.ts +12 -0
  196. package/dist/remote/relay/convex/component/zkAuth.d.ts.map +1 -0
  197. package/dist/remote/relay/convex/component/zkAuth.js +71 -0
  198. package/dist/remote/relay/convex/component/zkAuth.js.map +1 -0
  199. package/dist/remote/relay/convex/constants.d.ts +3 -0
  200. package/dist/remote/relay/convex/constants.d.ts.map +1 -0
  201. package/dist/remote/relay/convex/constants.js +3 -0
  202. package/dist/remote/relay/convex/constants.js.map +1 -0
  203. package/dist/remote/relay/convex/group-server.d.ts +9 -6
  204. package/dist/remote/relay/convex/group-server.d.ts.map +1 -1
  205. package/dist/remote/relay/convex/group-server.js +17 -11
  206. package/dist/remote/relay/convex/group-server.js.map +1 -1
  207. package/dist/remote/relay/convex/index.d.ts +4 -1
  208. package/dist/remote/relay/convex/index.d.ts.map +1 -1
  209. package/dist/remote/relay/convex/index.js +3 -1
  210. package/dist/remote/relay/convex/index.js.map +1 -1
  211. package/dist/remote/relay/convex/relay.d.ts +44 -65
  212. package/dist/remote/relay/convex/relay.d.ts.map +1 -1
  213. package/dist/remote/relay/convex/relay.js +61 -36
  214. package/dist/remote/relay/convex/relay.js.map +1 -1
  215. package/dist/remote/relay/convex/types.d.ts +16 -103
  216. package/dist/remote/relay/convex/types.d.ts.map +1 -1
  217. package/dist/remote/relay/convex/types.js +8 -13
  218. package/dist/remote/relay/convex/types.js.map +1 -1
  219. package/dist/remote/relay/index.d.ts +1 -1
  220. package/dist/remote/relay/index.d.ts.map +1 -1
  221. package/dist/remote/relay/index.js.map +1 -1
  222. package/dist/remote/relay/mock/adapter.d.ts +4 -9
  223. package/dist/remote/relay/mock/adapter.d.ts.map +1 -1
  224. package/dist/remote/relay/mock/adapter.js +39 -22
  225. package/dist/remote/relay/mock/adapter.js.map +1 -1
  226. package/dist/remote/relay/types.d.ts +57 -75
  227. package/dist/remote/relay/types.d.ts.map +1 -1
  228. package/dist/remote/relay/types.js +0 -1
  229. package/dist/remote/relay/types.js.map +1 -1
  230. package/dist/types/api.d.ts +21 -0
  231. package/dist/types/api.d.ts.map +1 -1
  232. package/dist/types/protocol-config.d.ts +51 -0
  233. package/dist/types/protocol-config.d.ts.map +1 -1
  234. package/dist/types/protocol-config.js +46 -0
  235. package/dist/types/protocol-config.js.map +1 -1
  236. package/docs/ASSURANCE.md +10 -6
  237. package/docs/CLIENT_COMPOSITION.md +23 -69
  238. package/docs/DEVIATIONS.md +44 -11
  239. package/docs/E2EE.md +71 -6
  240. package/docs/GETTING_STARTED.md +1 -1
  241. package/docs/PACKAGE_SURFACE.md +6 -5
  242. package/docs/RECIPES.md +1 -1
  243. package/docs/SECURITY.md +8 -0
  244. package/local/store/README.md +3 -1
  245. package/local/store/expo/README.md +10 -1
  246. package/local/store/node/README.md +8 -1
  247. package/package.json +12 -7
  248. package/remote/relay/convex/README.md +1 -1
  249. package/remote/relay/convex/component/README.md +428 -0
  250. package/scripts/oe-groups.mjs +21 -1
  251. package/dist/remote/relay/convex/server/index.d.ts +0 -2
  252. package/dist/remote/relay/convex/server/index.d.ts.map +0 -1
  253. package/dist/remote/relay/convex/server/index.js +0 -2
  254. package/dist/remote/relay/convex/server/index.js.map +0 -1
  255. package/dist/remote/relay/convex/server.d.ts +0 -150
  256. package/dist/remote/relay/convex/server.d.ts.map +0 -1
  257. package/dist/remote/relay/convex/server.js +0 -506
  258. package/dist/remote/relay/convex/server.js.map +0 -1
  259. package/docs/api/README.md +0 -471
  260. package/docs/api/classes/EncryptionError.md +0 -112
  261. package/docs/api/classes/EndorsementManager.md +0 -325
  262. package/docs/api/classes/SealedSenderAuthError.md +0 -127
  263. package/docs/api/classes/ServerDerivedKeyPair.md +0 -68
  264. package/docs/api/classes/ServerDerivedPublicKey.md +0 -33
  265. package/docs/api/classes/ServerRootKeyPair.md +0 -94
  266. package/docs/api/classes/ServerRootPublicKey.md +0 -72
  267. package/docs/api/classes/SignalProtocolBlockingManager.md +0 -106
  268. package/docs/api/classes/SignalProtocolClient.md +0 -2654
  269. package/docs/api/classes/VerificationFailure.md +0 -25
  270. package/docs/api/enumerations/ContentHint.md +0 -63
  271. package/docs/api/enumerations/EncryptionErrorCode.md +0 -488
  272. package/docs/api/enumerations/IdentityKeyChange.md +0 -65
  273. package/docs/api/enumerations/MessageType.md +0 -29
  274. package/docs/api/enumerations/TrustDirection.md +0 -33
  275. package/docs/api/enumerations/TypingAction.md +0 -31
  276. package/docs/api/functions/createDefaultSignalProtocolContentAdapter.md +0 -13
  277. package/docs/api/functions/createDefaultSignalProtocolLogger.md +0 -36
  278. package/docs/api/functions/createGroupId.md +0 -32
  279. package/docs/api/functions/createSignalProtocolClient.md +0 -36
  280. package/docs/api/functions/createSignalProtocolClientConfig.md +0 -24
  281. package/docs/api/functions/decodeGroupTrustRoot.md +0 -21
  282. package/docs/api/functions/encodeGroupTrustRoot.md +0 -28
  283. package/docs/api/functions/extractGroupId.md +0 -32
  284. package/docs/api/functions/formatVersion.md +0 -25
  285. package/docs/api/functions/isCompatible.md +0 -31
  286. package/docs/api/functions/isGroupId.md +0 -37
  287. package/docs/api/functions/isSealedSenderAuthError.md +0 -25
  288. package/docs/api/functions/parseVersion.md +0 -29
  289. package/docs/api/functions/resolveSPQRLimits.md +0 -21
  290. package/docs/api/functions/resolveSignalProtocolLogger.md +0 -42
  291. package/docs/api/interfaces/AccountIdentityProvisioning.md +0 -43
  292. package/docs/api/interfaces/AccountIdentityRotation.md +0 -69
  293. package/docs/api/interfaces/AttachmentTransferOptions.md +0 -49
  294. package/docs/api/interfaces/BlockedRecipientEntry.md +0 -25
  295. package/docs/api/interfaces/BlockedRecipientsSyncInput.md +0 -27
  296. package/docs/api/interfaces/ConfigurationSyncInput.md +0 -19
  297. package/docs/api/interfaces/CredentialPublicKey.md +0 -25
  298. package/docs/api/interfaces/DataMessageInput.md +0 -21
  299. package/docs/api/interfaces/DecryptedEnvelope.md +0 -95
  300. package/docs/api/interfaces/DecryptedGroup.md +0 -86
  301. package/docs/api/interfaces/DeviceInfo.md +0 -79
  302. package/docs/api/interfaces/DeviceRecord.md +0 -87
  303. package/docs/api/interfaces/DeviceRegistration.md +0 -27
  304. package/docs/api/interfaces/DoubleRatchetConfig.md +0 -36
  305. package/docs/api/interfaces/EcOneTimePreKey.md +0 -27
  306. package/docs/api/interfaces/EcSignedPreKey.md +0 -39
  307. package/docs/api/interfaces/EcSignedPreKeyUpload.md +0 -50
  308. package/docs/api/interfaces/EncryptionErrorContext.md +0 -51
  309. package/docs/api/interfaces/Envelope.md +0 -154
  310. package/docs/api/interfaces/ForceKeyResetResult.md +0 -37
  311. package/docs/api/interfaces/GroupAuthorization.md +0 -23
  312. package/docs/api/interfaces/GroupChangeEntry.md +0 -42
  313. package/docs/api/interfaces/GroupMemberDevice.md +0 -26
  314. package/docs/api/interfaces/GroupTrustRoot.md +0 -33
  315. package/docs/api/interfaces/IEcOneTimePreKeyStore.md +0 -86
  316. package/docs/api/interfaces/IEcSignedPreKeyStore.md +0 -133
  317. package/docs/api/interfaces/IGroupServer.md +0 -120
  318. package/docs/api/interfaces/IGroupStateStore.md +0 -128
  319. package/docs/api/interfaces/IIdentityKeyStore.md +0 -312
  320. package/docs/api/interfaces/IKemPreKeyStore.md +0 -144
  321. package/docs/api/interfaces/IKyberLastResortPreKeyStore.md +0 -112
  322. package/docs/api/interfaces/ILogger.md +0 -117
  323. package/docs/api/interfaces/IProtocolStore.md +0 -1033
  324. package/docs/api/interfaces/IRelayGroupServer.md +0 -60
  325. package/docs/api/interfaces/ISenderKeyStore.md +0 -417
  326. package/docs/api/interfaces/ISesameStore.md +0 -249
  327. package/docs/api/interfaces/ISessionStore.md +0 -178
  328. package/docs/api/interfaces/ISignalProtocolClient.md +0 -1185
  329. package/docs/api/interfaces/ISignalProtocolLocalSecretVault.md +0 -71
  330. package/docs/api/interfaces/ISignalProtocolLocalStore.md +0 -2053
  331. package/docs/api/interfaces/ISignalProtocolManager.md +0 -272
  332. package/docs/api/interfaces/ISignalProtocolRelayServer.md +0 -1337
  333. package/docs/api/interfaces/IdentityKeyPair.md +0 -49
  334. package/docs/api/interfaces/IncomingEnvelope.md +0 -91
  335. package/docs/api/interfaces/InspectedSignalProtocolContent.md +0 -43
  336. package/docs/api/interfaces/KDFChain.md +0 -31
  337. package/docs/api/interfaces/KemLastResortPreKeyUpload.md +0 -50
  338. package/docs/api/interfaces/KeyPair.md +0 -23
  339. package/docs/api/interfaces/KyberPreKey.md +0 -42
  340. package/docs/api/interfaces/MLKEMBraidAgentState.md +0 -191
  341. package/docs/api/interfaces/MLKEMBraidMessage.md +0 -49
  342. package/docs/api/interfaces/MediaAttachmentDeleteSyncInput.md +0 -31
  343. package/docs/api/interfaces/MessageHeader.md +0 -49
  344. package/docs/api/interfaces/MessageRecord.md +0 -86
  345. package/docs/api/interfaces/ParsedReceiptContent.md +0 -19
  346. package/docs/api/interfaces/ParsedTypingContent.md +0 -19
  347. package/docs/api/interfaces/PreKeyMaintenanceStore.md +0 -88
  348. package/docs/api/interfaces/PreKeyMessage.md +0 -159
  349. package/docs/api/interfaces/PreKeyStatusResult.md +0 -21
  350. package/docs/api/interfaces/PreKeyUpload.md +0 -42
  351. package/docs/api/interfaces/ProcessEnvelopeOptions.md +0 -72
  352. package/docs/api/interfaces/ProtocolAddress.md +0 -38
  353. package/docs/api/interfaces/ProtocolStrategyConfig.md +0 -91
  354. package/docs/api/interfaces/RatchetMessage.md +0 -96
  355. package/docs/api/interfaces/ReadSyncEntryInput.md +0 -19
  356. package/docs/api/interfaces/ReceiverChain.md +0 -43
  357. package/docs/api/interfaces/RecipientUsernameSyncInput.md +0 -31
  358. package/docs/api/interfaces/RelayPreKeyBundle.md +0 -254
  359. package/docs/api/interfaces/RemoteObjectDownload.md +0 -33
  360. package/docs/api/interfaces/RemoteObjectUpload.md +0 -49
  361. package/docs/api/interfaces/ResolvedSPQRInfoStrings.md +0 -27
  362. package/docs/api/interfaces/ResolvedSPQRLimits.md +0 -37
  363. package/docs/api/interfaces/RetryRequest.md +0 -80
  364. package/docs/api/interfaces/SCKAState.md +0 -65
  365. package/docs/api/interfaces/SPQRLimits.md +0 -40
  366. package/docs/api/interfaces/SPQRState.md +0 -191
  367. package/docs/api/interfaces/SafetyNumber.md +0 -60
  368. package/docs/api/interfaces/SafetyNumberConfirmation.md +0 -46
  369. package/docs/api/interfaces/SealedSenderConfig.md +0 -70
  370. package/docs/api/interfaces/SendOptions.md +0 -191
  371. package/docs/api/interfaces/SendResult.md +0 -93
  372. package/docs/api/interfaces/SenderKeyDistributionMessage.md +0 -43
  373. package/docs/api/interfaces/SenderKeyState.md +0 -76
  374. package/docs/api/interfaces/SenderKeysConfig.md +0 -65
  375. package/docs/api/interfaces/SentSyncTranscriptInput.md +0 -31
  376. package/docs/api/interfaces/ServiceId.md +0 -19
  377. package/docs/api/interfaces/SesameMessage.md +0 -84
  378. package/docs/api/interfaces/SesameStats.md +0 -57
  379. package/docs/api/interfaces/SessionHealthResult.md +0 -120
  380. package/docs/api/interfaces/SessionRecord.md +0 -80
  381. package/docs/api/interfaces/SessionRecordMetadata.md +0 -109
  382. package/docs/api/interfaces/SessionState.md +0 -368
  383. package/docs/api/interfaces/SessionTrustCommit.md +0 -58
  384. package/docs/api/interfaces/SignalProtocolBlockingHooks.md +0 -44
  385. package/docs/api/interfaces/SignalProtocolBlockingManagerOptions.md +0 -31
  386. package/docs/api/interfaces/SignalProtocolBlockingMirror.md +0 -30
  387. package/docs/api/interfaces/SignalProtocolBlockingStore.md +0 -83
  388. package/docs/api/interfaces/SignalProtocolClientAdapterConfig.md +0 -44
  389. package/docs/api/interfaces/SignalProtocolClientCompositionOptions.md +0 -731
  390. package/docs/api/interfaces/SignalProtocolClientConfig.md +0 -895
  391. package/docs/api/interfaces/SignalProtocolClientDeleteLocalAttachmentInput.md +0 -25
  392. package/docs/api/interfaces/SignalProtocolClientHooks.md +0 -506
  393. package/docs/api/interfaces/SignalProtocolClientIdentityConfig.md +0 -51
  394. package/docs/api/interfaces/SignalProtocolClientLoadLocalAttachmentInput.md +0 -187
  395. package/docs/api/interfaces/SignalProtocolClientLoadedLocalAttachment.md +0 -19
  396. package/docs/api/interfaces/SignalProtocolClientMedia.md +0 -83
  397. package/docs/api/interfaces/SignalProtocolClientMediaCompletedResult.md +0 -25
  398. package/docs/api/interfaces/SignalProtocolClientMediaConfig.md +0 -157
  399. package/docs/api/interfaces/SignalProtocolClientMediaDownloadCompletedResult.md +0 -37
  400. package/docs/api/interfaces/SignalProtocolClientMediaDownloadNotNeededResult.md +0 -25
  401. package/docs/api/interfaces/SignalProtocolClientMediaFailedResult.md +0 -19
  402. package/docs/api/interfaces/SignalProtocolClientMediaOperationOptions.md +0 -53
  403. package/docs/api/interfaces/SignalProtocolClientMediaPendingResult.md +0 -19
  404. package/docs/api/interfaces/SignalProtocolClientMediaProcessResult.md +0 -43
  405. package/docs/api/interfaces/SignalProtocolClientMediaSkippedResult.md +0 -25
  406. package/docs/api/interfaces/SignalProtocolClientMediaUploadCompletedResult.md +0 -31
  407. package/docs/api/interfaces/SignalProtocolClientProcessPendingMediaOptions.md +0 -87
  408. package/docs/api/interfaces/SignalProtocolClientSaveDownloadedAttachmentInput.md +0 -25
  409. package/docs/api/interfaces/SignalProtocolClientSaveUploadedAttachmentInput.md +0 -25
  410. package/docs/api/interfaces/SignalProtocolClientSyncDeleteInput.md +0 -19
  411. package/docs/api/interfaces/SignalProtocolConfig.md +0 -50
  412. package/docs/api/interfaces/SignalProtocolContentAdapter.md +0 -325
  413. package/docs/api/interfaces/SignalProtocolRemoteObjectStore.md +0 -88
  414. package/docs/api/interfaces/SkippedSenderMessageKey.md +0 -26
  415. package/docs/api/interfaces/TaskNotificationAckSyncInput.md +0 -31
  416. package/docs/api/interfaces/TripleRatchetState.md +0 -64
  417. package/docs/api/interfaces/UserRecord.md +0 -71
  418. package/docs/api/interfaces/UsernameStateSyncInput.md +0 -19
  419. package/docs/api/interfaces/VerificationStateSyncInput.md +0 -31
  420. package/docs/api/interfaces/VersionNegotiationState.md +0 -84
  421. package/docs/api/interfaces/ViewOnceOpenSyncInput.md +0 -19
  422. package/docs/api/namespaces/ProtocolAddress/README.md +0 -33
  423. package/docs/api/namespaces/ProtocolAddress/functions/create.md +0 -41
  424. package/docs/api/namespaces/ProtocolAddress/functions/equals.md +0 -39
  425. package/docs/api/namespaces/ProtocolAddress/functions/fromStorageKey.md +0 -36
  426. package/docs/api/namespaces/ProtocolAddress/functions/isUser.md +0 -39
  427. package/docs/api/namespaces/ProtocolAddress/functions/isValid.md +0 -34
  428. package/docs/api/namespaces/ProtocolAddress/functions/parse.md +0 -41
  429. package/docs/api/namespaces/ProtocolAddress/functions/toStorageKey.md +0 -38
  430. package/docs/api/namespaces/ProtocolAddress/functions/toString.md +0 -34
  431. package/docs/api/namespaces/SessionRecord/README.md +0 -30
  432. package/docs/api/namespaces/SessionRecord/functions/archiveCurrent.md +0 -40
  433. package/docs/api/namespaces/SessionRecord/functions/archiveCurrentState.md +0 -34
  434. package/docs/api/namespaces/SessionRecord/functions/create.md +0 -25
  435. package/docs/api/namespaces/SessionRecord/functions/deserialize.md +0 -29
  436. package/docs/api/namespaces/SessionRecord/functions/findSession.md +0 -34
  437. package/docs/api/namespaces/SessionRecord/functions/getAllSessions.md +0 -25
  438. package/docs/api/namespaces/SessionRecord/functions/getArchivedCount.md +0 -25
  439. package/docs/api/namespaces/SessionRecord/functions/hasCurrentSession.md +0 -25
  440. package/docs/api/namespaces/SessionRecord/functions/hasUsableSenderChain.md +0 -36
  441. package/docs/api/namespaces/SessionRecord/functions/promoteSession.md +0 -34
  442. package/docs/api/namespaces/SessionRecord/functions/serialize.md +0 -28
  443. package/docs/api/namespaces/SessionRecord/variables/MAX_ARCHIVED_SESSIONS.md +0 -14
  444. package/docs/api/namespaces/SessionState/README.md +0 -15
  445. package/docs/api/namespaces/SessionState/functions/getSessionId.md +0 -32
  446. package/docs/api/namespaces/blocking/README.md +0 -43
  447. package/docs/api/namespaces/encoding/README.md +0 -33
  448. package/docs/api/namespaces/encoding/functions/base64ToUrlSafe.md +0 -28
  449. package/docs/api/namespaces/encoding/functions/bytesToBase64.md +0 -21
  450. package/docs/api/namespaces/encoding/functions/bytesToString.md +0 -21
  451. package/docs/api/namespaces/encoding/functions/bytesToUrlSafeBase64.md +0 -33
  452. package/docs/api/namespaces/encoding/functions/concatBytes.md +0 -21
  453. package/docs/api/namespaces/encoding/functions/stringToBytes.md +0 -21
  454. package/docs/api/namespaces/encoding/functions/urlSafeToBase64.md +0 -27
  455. package/docs/api/namespaces/keys/README.md +0 -130
  456. package/docs/api/namespaces/keys/functions/acceptContactIdentityRotation.md +0 -33
  457. package/docs/api/namespaces/keys/functions/assertIdentityCommitment.md +0 -25
  458. package/docs/api/namespaces/keys/functions/canonicalizeDeviceIdentityKey.md +0 -30
  459. package/docs/api/namespaces/keys/functions/compareDeviceIdentityKeys.md +0 -28
  460. package/docs/api/namespaces/keys/functions/compositeIdentitiesEqual.md +0 -23
  461. package/docs/api/namespaces/keys/functions/createCompositeIdentityV1.md +0 -19
  462. package/docs/api/namespaces/keys/functions/createPreKeySignatureContext.md +0 -31
  463. package/docs/api/namespaces/keys/functions/createUnverifiedContactIdentityRecord.md +0 -23
  464. package/docs/api/namespaces/keys/functions/decodeCompositeIdentityV1.md +0 -19
  465. package/docs/api/namespaces/keys/functions/deriveIdentityCommitment.md +0 -19
  466. package/docs/api/namespaces/keys/functions/encodeCompositeIdentityV1.md +0 -19
  467. package/docs/api/namespaces/keys/functions/evaluateContactIdentityCandidate.md +0 -27
  468. package/docs/api/namespaces/keys/functions/generateEcOneTimePreKeys.md +0 -37
  469. package/docs/api/namespaces/keys/functions/generateEcSignedPreKey.md +0 -39
  470. package/docs/api/namespaces/keys/functions/generateEcSignedPreKeyId.md +0 -21
  471. package/docs/api/namespaces/keys/functions/generateIdentityKeyPair.md +0 -24
  472. package/docs/api/namespaces/keys/functions/generateKemOneTimePreKeys.md +0 -47
  473. package/docs/api/namespaces/keys/functions/generateKyberLastResortPreKey.md +0 -37
  474. package/docs/api/namespaces/keys/functions/generateRegistrationId.md +0 -13
  475. package/docs/api/namespaces/keys/functions/isValidDeviceIdentityKey.md +0 -22
  476. package/docs/api/namespaces/keys/functions/signMlKem1024PreKey.md +0 -29
  477. package/docs/api/namespaces/keys/functions/signPreKey.md +0 -31
  478. package/docs/api/namespaces/keys/functions/validateContactIdentityRecord.md +0 -19
  479. package/docs/api/namespaces/keys/functions/verifyContactIdentityRecord.md +0 -31
  480. package/docs/api/namespaces/keys/functions/verifyMlKem1024PreKey.md +0 -33
  481. package/docs/api/namespaces/keys/functions/verifyPreKeySignature.md +0 -35
  482. package/docs/api/namespaces/keys/interfaces/CompositeIdentityV1.md +0 -33
  483. package/docs/api/namespaces/keys/interfaces/ContactIdentityRecord.md +0 -53
  484. package/docs/api/namespaces/keys/interfaces/KemOneTimePreKey.md +0 -43
  485. package/docs/api/namespaces/keys/type-aliases/IdentityCandidateStatus.md +0 -9
  486. package/docs/api/namespaces/keys/type-aliases/IdentityTrustState.md +0 -9
  487. package/docs/api/namespaces/keys/type-aliases/IdentityType.md +0 -9
  488. package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_ED25519_TAG.md +0 -9
  489. package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_LENGTH.md +0 -9
  490. package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_VERSION.md +0 -9
  491. package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_X25519_TAG.md +0 -9
  492. package/docs/api/namespaces/keys/variables/IDENTITY_COMMITMENT_V1_DOMAIN.md +0 -9
  493. package/docs/api/namespaces/keys/variables/PREKEY_ALGORITHM_ML_KEM_1024.md +0 -9
  494. package/docs/api/namespaces/keys/variables/PREKEY_ALGORITHM_X25519.md +0 -9
  495. package/docs/api/namespaces/keys/variables/PREKEY_SIGNATURE_V1_DOMAIN.md +0 -9
  496. package/docs/api/namespaces/keys/variables/UNPINNED_DEVICE_IDENTITY_KEY.md +0 -18
  497. package/docs/api/namespaces/media/README.md +0 -105
  498. package/docs/api/namespaces/media/classes/MediaAttachmentError.md +0 -57
  499. package/docs/api/namespaces/media/functions/createByteRangeMediaAttachmentTransfer.md +0 -19
  500. package/docs/api/namespaces/media/functions/createMediaAttachmentDeliveryId.md +0 -29
  501. package/docs/api/namespaces/media/functions/createMediaAttachmentId.md +0 -19
  502. package/docs/api/namespaces/media/functions/createMediaAttachmentMessage.md +0 -25
  503. package/docs/api/namespaces/media/functions/createMediaAttachmentPointer.md +0 -19
  504. package/docs/api/namespaces/media/functions/createTusMediaAttachmentTransfer.md +0 -19
  505. package/docs/api/namespaces/media/functions/deleteMediaAttachment.md +0 -23
  506. package/docs/api/namespaces/media/functions/executeMediaAttachmentJob.md +0 -23
  507. package/docs/api/namespaces/media/functions/isMediaAttachmentFlagSet.md +0 -19
  508. package/docs/api/namespaces/media/functions/parseMediaAttachmentMessage.md +0 -19
  509. package/docs/api/namespaces/media/functions/planMediaAttachmentCleanup.md +0 -23
  510. package/docs/api/namespaces/media/functions/planMediaAttachmentCleanupJobs.md +0 -19
  511. package/docs/api/namespaces/media/functions/planMediaAttachmentDeleteSync.md +0 -19
  512. package/docs/api/namespaces/media/functions/planMediaAttachmentDownloadJob.md +0 -19
  513. package/docs/api/namespaces/media/functions/planMediaAttachmentOpen.md +0 -19
  514. package/docs/api/namespaces/media/functions/planMediaAttachmentProcessing.md +0 -19
  515. package/docs/api/namespaces/media/functions/planMediaAttachmentUploadJob.md +0 -19
  516. package/docs/api/namespaces/media/functions/prepareMediaAttachmentUpload.md +0 -30
  517. package/docs/api/namespaces/media/functions/resolveMediaAttachment.md +0 -30
  518. package/docs/api/namespaces/media/functions/serializeMediaAttachmentMessage.md +0 -25
  519. package/docs/api/namespaces/media/functions/validateMediaAttachmentPolicy.md +0 -23
  520. package/docs/api/namespaces/media/interfaces/ByteRangeMediaAttachmentPartialStore.md +0 -68
  521. package/docs/api/namespaces/media/interfaces/ByteRangeMediaAttachmentTransferOptions.md +0 -91
  522. package/docs/api/namespaces/media/interfaces/DeleteMediaAttachmentOptions.md +0 -25
  523. package/docs/api/namespaces/media/interfaces/DeleteMediaAttachmentResult.md +0 -19
  524. package/docs/api/namespaces/media/interfaces/ExecuteMediaAttachmentJobOptions.md +0 -157
  525. package/docs/api/namespaces/media/interfaces/MediaAttachmentBackgroundJob.md +0 -85
  526. package/docs/api/namespaces/media/interfaces/MediaAttachmentCleanupPlan.md +0 -37
  527. package/docs/api/namespaces/media/interfaces/MediaAttachmentJobExecutionResult.md +0 -55
  528. package/docs/api/namespaces/media/interfaces/MediaAttachmentMessage.md +0 -31
  529. package/docs/api/namespaces/media/interfaces/MediaAttachmentOpenDecision.md +0 -31
  530. package/docs/api/namespaces/media/interfaces/MediaAttachmentPointer.md +0 -133
  531. package/docs/api/namespaces/media/interfaces/MediaAttachmentPolicy.md +0 -67
  532. package/docs/api/namespaces/media/interfaces/MediaAttachmentProcessingPlan.md +0 -73
  533. package/docs/api/namespaces/media/interfaces/MediaAttachmentProgress.md +0 -69
  534. package/docs/api/namespaces/media/interfaces/MediaAttachmentResumeState.md +0 -37
  535. package/docs/api/namespaces/media/interfaces/MediaAttachmentRetryOptions.md +0 -31
  536. package/docs/api/namespaces/media/interfaces/MediaAttachmentTransfer.md +0 -51
  537. package/docs/api/namespaces/media/interfaces/MediaAttachmentTransferCheckpoint.md +0 -69
  538. package/docs/api/namespaces/media/interfaces/MediaAttachmentTransferOptions.md +0 -67
  539. package/docs/api/namespaces/media/interfaces/MediaAttachmentUploadJobData.md +0 -19
  540. package/docs/api/namespaces/media/interfaces/MediaAttachmentUploadResponse.md +0 -25
  541. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentCleanupJobsInput.md +0 -61
  542. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentDeleteSyncInput.md +0 -25
  543. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentDownloadJobInput.md +0 -161
  544. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentOpenInput.md +0 -25
  545. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentProcessingInput.md +0 -83
  546. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentUploadJobInput.md +0 -147
  547. package/docs/api/namespaces/media/interfaces/PrepareMediaAttachmentUploadOptions.md +0 -144
  548. package/docs/api/namespaces/media/interfaces/ResolveMediaAttachmentOptions.md +0 -55
  549. package/docs/api/namespaces/media/interfaces/ResolvedMediaAttachment.md +0 -109
  550. package/docs/api/namespaces/media/interfaces/TusMediaAttachmentTransferOptions.md +0 -85
  551. package/docs/api/namespaces/media/type-aliases/CreateMediaAttachmentPointerInput.md +0 -15
  552. package/docs/api/namespaces/media/type-aliases/MediaAttachmentCheckpointCallback.md +0 -19
  553. package/docs/api/namespaces/media/type-aliases/MediaAttachmentCleanupReason.md +0 -9
  554. package/docs/api/namespaces/media/type-aliases/MediaAttachmentErrorCode.md +0 -9
  555. package/docs/api/namespaces/media/type-aliases/MediaAttachmentFlag.md +0 -9
  556. package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobExecutionStatus.md +0 -9
  557. package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobOperation.md +0 -9
  558. package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobPriority.md +0 -9
  559. package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobSkipReason.md +0 -9
  560. package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobSource.md +0 -9
  561. package/docs/api/namespaces/media/type-aliases/MediaAttachmentKnownIds.md +0 -9
  562. package/docs/api/namespaces/media/type-aliases/MediaAttachmentMessageType.md +0 -9
  563. package/docs/api/namespaces/media/type-aliases/MediaAttachmentProgressCallback.md +0 -19
  564. package/docs/api/namespaces/media/variables/MEDIA_ATTACHMENT_POLICY_DEFAULTS.md +0 -47
  565. package/docs/api/namespaces/media/variables/MEDIA_ATTACHMENT_POLICY_PRESETS.md +0 -95
  566. package/docs/api/namespaces/media/variables/MediaAttachmentCleanupReason.md +0 -27
  567. package/docs/api/namespaces/media/variables/MediaAttachmentErrorCode.md +0 -75
  568. package/docs/api/namespaces/media/variables/MediaAttachmentFlag.md +0 -23
  569. package/docs/api/namespaces/media/variables/MediaAttachmentJobExecutionStatus.md +0 -19
  570. package/docs/api/namespaces/media/variables/MediaAttachmentJobOperation.md +0 -31
  571. package/docs/api/namespaces/media/variables/MediaAttachmentJobPriority.md +0 -23
  572. package/docs/api/namespaces/media/variables/MediaAttachmentJobSource.md +0 -51
  573. package/docs/api/namespaces/media/variables/MediaAttachmentMessageType.md +0 -15
  574. package/docs/api/namespaces/media/variables/downloadMediaAttachment.md +0 -30
  575. package/docs/api/namespaces/safety/README.md +0 -61
  576. package/docs/api/namespaces/safety/classes/DisplayableFingerprint.md +0 -108
  577. package/docs/api/namespaces/safety/classes/Fingerprint.md +0 -104
  578. package/docs/api/namespaces/safety/classes/ScannableFingerprint.md +0 -209
  579. package/docs/api/namespaces/safety/functions/base64ToBytes.md +0 -21
  580. package/docs/api/namespaces/safety/functions/clearFingerprintCache.md +0 -15
  581. package/docs/api/namespaces/safety/functions/compareSafetyNumbers.md +0 -25
  582. package/docs/api/namespaces/safety/functions/createFingerprintData.md +0 -60
  583. package/docs/api/namespaces/safety/functions/extractQrData.md +0 -34
  584. package/docs/api/namespaces/safety/functions/generateCompositeSafetyNumber.md +0 -39
  585. package/docs/api/namespaces/safety/functions/generateEmojiFingerprint.md +0 -24
  586. package/docs/api/namespaces/safety/functions/generateSingleKeyReferenceSafetyNumber.md +0 -51
  587. package/docs/api/namespaces/safety/functions/generateVerifySchemeUrl.md +0 -32
  588. package/docs/api/namespaces/safety/functions/generateVerifyUrl.md +0 -49
  589. package/docs/api/namespaces/safety/functions/isValidSafetyNumber.md +0 -21
  590. package/docs/api/namespaces/safety/functions/isVerifyUrl.md +0 -45
  591. package/docs/api/namespaces/safety/functions/parseVerifyUrl.md +0 -31
  592. package/docs/api/namespaces/safety/interfaces/FingerprintData.md +0 -52
  593. package/docs/api/namespaces/safety/interfaces/SafetyNumber.md +0 -49
  594. package/docs/api/namespaces/safety/interfaces/VerifyLinkConfig.md +0 -28
  595. package/docs/api/namespaces/safety/interfaces/VerifyUrlParams.md +0 -49
  596. package/docs/api/namespaces/safety/type-aliases/CompareResult.md +0 -21
  597. package/docs/api/namespaces/safety/variables/DEFAULT_VERIFY_LINK_CONFIG.md +0 -12
  598. package/docs/api/namespaces/safety/variables/FINGERPRINT_ITERATIONS.md +0 -12
  599. package/docs/api/namespaces/safety/variables/FINGERPRINT_VERSION.md +0 -12
  600. package/docs/api/namespaces/safety/variables/VERIFY_BASE_URL.md +0 -11
  601. package/docs/api/namespaces/safety/variables/VERIFY_SCHEME_URL.md +0 -11
  602. package/docs/api/type-aliases/Base64.md +0 -20
  603. package/docs/api/type-aliases/BraidPolicy.md +0 -11
  604. package/docs/api/type-aliases/Bytes.md +0 -20
  605. package/docs/api/type-aliases/Ciphertext.md +0 -21
  606. package/docs/api/type-aliases/DeviceType.md +0 -11
  607. package/docs/api/type-aliases/DownloadedAttachment.md +0 -11
  608. package/docs/api/type-aliases/GroupId.md +0 -27
  609. package/docs/api/type-aliases/Hex.md +0 -20
  610. package/docs/api/type-aliases/HookName.md +0 -11
  611. package/docs/api/type-aliases/PostQuantumPolicy.md +0 -11
  612. package/docs/api/type-aliases/PreparedAttachmentUpload.md +0 -14
  613. package/docs/api/type-aliases/PrivateKey.md +0 -22
  614. package/docs/api/type-aliases/ProgressCallback.md +0 -45
  615. package/docs/api/type-aliases/PublicKey.md +0 -22
  616. package/docs/api/type-aliases/RemoteObjectCompleteUploadRequest.md +0 -19
  617. package/docs/api/type-aliases/RemoteObjectDeleteRequest.md +0 -19
  618. package/docs/api/type-aliases/RemoteObjectDownloadRequest.md +0 -19
  619. package/docs/api/type-aliases/RemoteObjectUploadRequest.md +0 -42
  620. package/docs/api/type-aliases/SCKAMode.md +0 -11
  621. package/docs/api/type-aliases/SealedSenderAuth.md +0 -15
  622. package/docs/api/type-aliases/SignalProtocolClientMediaCleanupInput.md +0 -9
  623. package/docs/api/type-aliases/SignalProtocolClientMediaCleanupResult.md +0 -9
  624. package/docs/api/type-aliases/SignalProtocolClientMediaDownloadInput.md +0 -9
  625. package/docs/api/type-aliases/SignalProtocolClientMediaDownloadResult.md +0 -9
  626. package/docs/api/type-aliases/SignalProtocolClientMediaOperationResult.md +0 -9
  627. package/docs/api/type-aliases/SignalProtocolClientMediaUploadInput.md +0 -9
  628. package/docs/api/type-aliases/SignalProtocolClientMediaUploadResult.md +0 -9
  629. package/docs/api/type-aliases/Signature.md +0 -21
  630. package/docs/api/type-aliases/Unsubscribe.md +0 -15
  631. package/docs/api/variables/BraidPolicy.md +0 -21
  632. package/docs/api/variables/DEFAULT_DEVICE_ID.md +0 -12
  633. package/docs/api/variables/DOUBLE_RATCHET_SPEC.md +0 -11
  634. package/docs/api/variables/GROUP_ID_PREFIX.md +0 -11
  635. package/docs/api/variables/GROUP_TRUST_ROOT_VERSION.md +0 -11
  636. package/docs/api/variables/KEY_REFRESH_INTERVAL_MS_DEFAULT.md +0 -11
  637. package/docs/api/variables/MAX_MESSAGE_KEYS.md +0 -14
  638. package/docs/api/variables/MAX_PREKEY_AGE_MS_DEFAULT.md +0 -11
  639. package/docs/api/variables/MAX_RECEIVER_CHAINS.md +0 -14
  640. package/docs/api/variables/MAX_REGISTRATION_ID.md +0 -16
  641. package/docs/api/variables/MAX_SKIP.md +0 -11
  642. package/docs/api/variables/MESSAGE_FORMAT.md +0 -11
  643. package/docs/api/variables/MIN_REGISTRATION_ID.md +0 -16
  644. package/docs/api/variables/ML_KEM_BRAID_SPEC.md +0 -11
  645. package/docs/api/variables/ONE_TIME_PREKEY_BATCH_SIZE.md +0 -21
  646. package/docs/api/variables/PQXDH_SPEC.md +0 -11
  647. package/docs/api/variables/PostQuantumPolicy.md +0 -21
  648. package/docs/api/variables/SENDER_KEY_FORMAT.md +0 -11
  649. package/docs/api/variables/SENDER_KEY_SPEC.md +0 -11
  650. package/docs/api/variables/SESAME_SPEC.md +0 -11
  651. package/docs/api/variables/SESSION_FORMAT.md +0 -11
  652. package/docs/api/variables/SPQR_LIMITS_DEFAULTS.md +0 -11
  653. package/docs/api/variables/X3DH_SPEC.md +0 -9
  654. package/docs/api/variables/defaultSignalProtocolLogger.md +0 -32
  655. package/remote/relay/convex/server/README.md +0 -146
@@ -197,10 +197,61 @@ export interface SenderKeysConfig {
197
197
  /**
198
198
  * Maximum age for locally generated sender keys before rotation.
199
199
  *
200
+ * Clamped to the range {@link SENDER_KEY_AGE_FLOOR} to
201
+ * {@link SENDER_KEY_AGE_CEILING}; a value outside it is treated as the bound
202
+ * it passed, and a value that is not a positive finite number falls back to
203
+ * the default.
204
+ *
200
205
  * @default 1209600000
201
206
  */
202
207
  maxSenderKeyAge?: number;
203
208
  }
209
+ /**
210
+ * Hard upper bound on {@link SenderKeysConfig.maxSenderKeyAge}, in
211
+ * milliseconds.
212
+ *
213
+ * A sender key is the one piece of group key material that no ratchet
214
+ * refreshes: it advances a chain forward on every send, so it gives forward
215
+ * secrecy against a later compromise, but a member who holds the key at time
216
+ * T can read everything sent under it afterwards. Only rotation ends that,
217
+ * and rotation is what this bound guarantees eventually happens. Membership
218
+ * changes normally force it sooner; the age bound is what covers a group
219
+ * whose membership never changes.
220
+ *
221
+ * Ninety days matches the ceiling the reference implementation applies to its
222
+ * own remotely configured value. The difference here is who is being bounded:
223
+ * the reference clamps a value it sets itself, whereas this SDK takes the
224
+ * value from the host application, so the clamp is the only thing keeping a
225
+ * deployment from disabling rotation outright by configuring an age no key
226
+ * will reach.
227
+ */
228
+ export declare const SENDER_KEY_AGE_CEILING: number;
229
+ /**
230
+ * Hard lower bound on {@link SenderKeysConfig.maxSenderKeyAge}, in
231
+ * milliseconds.
232
+ *
233
+ * Unlike the ceiling this is not a security bound — rotating sooner is
234
+ * strictly safer — it is an availability one, and it exists because expiry is
235
+ * enforced on a key that a *send* has to rotate and redistribute. When a key
236
+ * expires the send path generates a new one, fans a distribution message out
237
+ * to every other member over sequential network calls, then retries the
238
+ * encrypt, which re-checks the age of the key it just created. If the
239
+ * configured age is shorter than that fan-out takes, the retry finds the new
240
+ * key already expired and the send fails permanently, having burned a rotation
241
+ * and a message to every member on each attempt.
242
+ *
243
+ * An hour is well clear of that: even a group at the membership limit, with a
244
+ * distribution message to each member, finishes its fan-out in minutes at
245
+ * worst. It is also low enough to leave deliberately aggressive rotation
246
+ * policies intact, which a bound measured in days would not.
247
+ *
248
+ * A configured age below this is treated as the bound rather than rejected,
249
+ * because the value that reaches it is usually a unit mistake — this field is
250
+ * milliseconds, so a host that means fourteen days and passes `14` lands here
251
+ * — and the safe reading of "rotate far more often than I asked" is to rotate
252
+ * as often as the implementation can actually deliver.
253
+ */
254
+ export declare const SENDER_KEY_AGE_FLOOR: number;
204
255
  /**
205
256
  * Default values for Sender Keys configuration.
206
257
  */
@@ -1 +1 @@
1
- {"version":3,"file":"protocol-config.d.ts","sourceRoot":"","sources":["../../types/protocol-config.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,iBAAiB;aAC5B,QAAQ,EAAE,UAAU;aACpB,UAAU,EAAE,YAAY;CAChB,CAAC;AAEX,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,OAAO,iBAAiB,CAAC,CAAC;AAE3F;;GAEG;AACH,eAAO,MAAM,WAAW;aACtB,QAAQ,EAAE,UAAU;aACpB,QAAQ,EAAE,UAAU;CACZ,CAAC;AAEX,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,WAAW,CAAC,CAAC;AAEzE;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;;;;OAQG;IACH,WAAW,CAAC,EAAE,iBAAiB,CAAC;IAEhC;;;;;;;;;;OAUG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,CAAC,EAAE,oBAAoB,GAAG,sBAAsB,CAsB9F;AAED;;;;;;GAMG;AACH,wBAAgB,6BAA6B,CAAC,MAAM,CAAC,EAAE;IACrD,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAChC,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;CAC3C,GAAG,sBAAsB,GAAG,SAAS,CAqBrC;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,kBAAkB,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,0DAA0D;IAC1D,SAAS,EAAE,OAAO,CAAC;IACnB,iEAAiE;IACjE,iBAAiB,EAAE,OAAO,CAAC;IAC3B,6DAA6D;IAC7D,qBAAqB,EAAE,OAAO,CAAC;IAC/B,8DAA8D;IAC9D,uBAAuB,CAAC,EAAE,uBAAuB,CAAC;IAClD,gDAAgD;IAChD,aAAa,EAAE,MAAM,CAAC;IACtB,uCAAuC;IACvC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,QAAQ,GAAG,OAAO,CAAC;AAE1C;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,qCAAqC;IACrC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,iDAAiD;IACjD,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,+DAA+D;IAC/D,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;;;;GAKG;AACH,MAAM,WAAW,UAAU;IACzB,8DAA8D;IAC9D,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,wDAAwD;IACxD,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,8CAA8C;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,wCAAwC;IACxC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,qCAAqC;IACrC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,2CAA2C;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;;;;;OAQG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAEjC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB;;OAEG;IACH,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IAExC;;OAEG;IACH,kBAAkB,CAAC,EAAE,CAAC,KAAK,EAAE,sBAAsB,KAAK,IAAI,CAAC;IAE7D;;OAEG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,eAAO,MAAM,oBAAoB;aAC/B,cAAc,EAAE,cAAc;aAC9B,eAAe,EAAE,KAAK;aACtB,cAAc,EAAE,IAAI;aACpB,eAAe;CACP,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,qBAAqB,IAAI,CAAC;AAEvC;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,MAAM,CAAC;IACzB,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,gBAAgB,EAAE,MAAM,CAAC;IACzB,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,4BAA4B,CAAC,YAAY,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzE;;OAEG;IACH,+BAA+B,CAAC,YAAY,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5E;;OAEG;IACH,0BAA0B,CACxB,gBAAgB,EAAE,MAAM,EACxB,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,+BAA+B,CAAC,CAAC;IAE5C;;OAEG;IACH,mBAAmB,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;CAClF;AAED;;GAEG;AACH,eAAO,MAAM,+BAA+B,QAA0B,CAAC;AAEvE;;GAEG;AACH,eAAO,MAAM,yBAAyB,QAA2B,CAAC;AAElE;;GAEG;AACH,eAAO,MAAM,gCAAgC,QAAsB,CAAC;AAEpE;;GAEG;AACH,eAAO,MAAM,iCAAiC,QAA2B,CAAC;AAE1E;;GAEG;AACH,eAAO,MAAM,0BAA0B,KAAK,CAAC;AAE7C;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,kBAAkB,wCAAwC,CAAC;AAExE;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,aAAa,CAAC;AAE5C;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,0CAA0C;IAC1C,KAAK,EAAE,OAAO,CAAC;IACf,gEAAgE;IAChE,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,iDAAiD;IACjD,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CACtC,MAAM,CAAC,EAAE,sBAAsB,GAC9B,0BAA0B,CAyB5B;AAED;;GAEG;AACH,wBAAgB,6BAA6B,CAC3C,MAAM,CAAC,EAAE,sBAAsB,GAC9B,QAAQ,CAAC,IAAI,CAAC,sBAAsB,EAAE,UAAU,GAAG,wBAAwB,CAAC,CAAC,GAC9E,IAAI,CACF,sBAAsB,EACpB,oBAAoB,GACpB,oBAAoB,GACpB,iBAAiB,GACjB,YAAY,GACZ,uBAAuB,CAC1B,CAUF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,0DAA0D;IAC1D,cAAc,EAAE,MAAM,CAAC;IACvB,oDAAoD;IACpD,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,eAAO,MAAM,oBAAoB,EAAE,kBAGlC,CAAC;AAEF;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,CAAC,EAAE,UAAU,GAAG,kBAAkB,CAKzE;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,MAAM,CAAC,EAAE,sBAAsB,GAAG,QAAQ,CAEzE;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,yBAAyB;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,wBAAgB,6BAA6B,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,8BAA8B,CAQ/F"}
1
+ {"version":3,"file":"protocol-config.d.ts","sourceRoot":"","sources":["../../types/protocol-config.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,iBAAiB;aAC5B,QAAQ,EAAE,UAAU;aACpB,UAAU,EAAE,YAAY;CAChB,CAAC;AAEX,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,OAAO,iBAAiB,CAAC,CAAC;AAE3F;;GAEG;AACH,eAAO,MAAM,WAAW;aACtB,QAAQ,EAAE,UAAU;aACpB,QAAQ,EAAE,UAAU;CACZ,CAAC;AAEX,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,WAAW,CAAC,CAAC;AAEzE;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;;;;OAQG;IACH,WAAW,CAAC,EAAE,iBAAiB,CAAC;IAEhC;;;;;;;;;;OAUG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,CAAC,EAAE,oBAAoB,GAAG,sBAAsB,CAsB9F;AAED;;;;;;GAMG;AACH,wBAAgB,6BAA6B,CAAC,MAAM,CAAC,EAAE;IACrD,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAChC,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;CAC3C,GAAG,sBAAsB,GAAG,SAAS,CAqBrC;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,kBAAkB,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,0DAA0D;IAC1D,SAAS,EAAE,OAAO,CAAC;IACnB,iEAAiE;IACjE,iBAAiB,EAAE,OAAO,CAAC;IAC3B,6DAA6D;IAC7D,qBAAqB,EAAE,OAAO,CAAC;IAC/B,8DAA8D;IAC9D,uBAAuB,CAAC,EAAE,uBAAuB,CAAC;IAClD,gDAAgD;IAChD,aAAa,EAAE,MAAM,CAAC;IACtB,uCAAuC;IACvC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,QAAQ,GAAG,OAAO,CAAC;AAE1C;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,qCAAqC;IACrC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,iDAAiD;IACjD,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,+DAA+D;IAC/D,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;;;;GAKG;AACH,MAAM,WAAW,UAAU;IACzB,8DAA8D;IAC9D,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,wDAAwD;IACxD,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,8CAA8C;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,wCAAwC;IACxC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,qCAAqC;IACrC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,2CAA2C;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;;;;;OAQG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAEjC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB;;OAEG;IACH,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IAExC;;OAEG;IACH,kBAAkB,CAAC,EAAE,CAAC,KAAK,EAAE,sBAAsB,KAAK,IAAI,CAAC;IAE7D;;OAEG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;;;OASG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,sBAAsB,QAA2B,CAAC;AAE/D;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,oBAAoB,QAAiB,CAAC;AAEnD;;GAEG;AACH,eAAO,MAAM,oBAAoB;aAC/B,cAAc,EAAE,cAAc;aAC9B,eAAe,EAAE,KAAK;aACtB,cAAc,EAAE,IAAI;aACpB,eAAe;CACP,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,qBAAqB,IAAI,CAAC;AAEvC;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,MAAM,CAAC;IACzB,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,gBAAgB,EAAE,MAAM,CAAC;IACzB,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,4BAA4B,CAAC,YAAY,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzE;;OAEG;IACH,+BAA+B,CAAC,YAAY,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5E;;OAEG;IACH,0BAA0B,CACxB,gBAAgB,EAAE,MAAM,EACxB,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,+BAA+B,CAAC,CAAC;IAE5C;;OAEG;IACH,mBAAmB,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;CAClF;AAED;;GAEG;AACH,eAAO,MAAM,+BAA+B,QAA0B,CAAC;AAEvE;;GAEG;AACH,eAAO,MAAM,yBAAyB,QAA2B,CAAC;AAElE;;GAEG;AACH,eAAO,MAAM,gCAAgC,QAAsB,CAAC;AAEpE;;GAEG;AACH,eAAO,MAAM,iCAAiC,QAA2B,CAAC;AAE1E;;GAEG;AACH,eAAO,MAAM,0BAA0B,KAAK,CAAC;AAE7C;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,kBAAkB,wCAAwC,CAAC;AAExE;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,aAAa,CAAC;AAE5C;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,0CAA0C;IAC1C,KAAK,EAAE,OAAO,CAAC;IACf,gEAAgE;IAChE,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,iDAAiD;IACjD,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CACtC,MAAM,CAAC,EAAE,sBAAsB,GAC9B,0BAA0B,CAyB5B;AAED;;GAEG;AACH,wBAAgB,6BAA6B,CAC3C,MAAM,CAAC,EAAE,sBAAsB,GAC9B,QAAQ,CAAC,IAAI,CAAC,sBAAsB,EAAE,UAAU,GAAG,wBAAwB,CAAC,CAAC,GAC9E,IAAI,CACF,sBAAsB,EACpB,oBAAoB,GACpB,oBAAoB,GACpB,iBAAiB,GACjB,YAAY,GACZ,uBAAuB,CAC1B,CAUF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,0DAA0D;IAC1D,cAAc,EAAE,MAAM,CAAC;IACvB,oDAAoD;IACpD,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,eAAO,MAAM,oBAAoB,EAAE,kBAGlC,CAAC;AAEF;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,CAAC,EAAE,UAAU,GAAG,kBAAkB,CAKzE;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,MAAM,CAAC,EAAE,sBAAsB,GAAG,QAAQ,CAEzE;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,yBAAyB;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,wBAAgB,6BAA6B,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,8BAA8B,CAQ/F"}
@@ -65,6 +65,52 @@ export function resolveSignalProtocolStrategy(config) {
65
65
  ...protocolConfigToStrategy(config.protocol),
66
66
  };
67
67
  }
68
+ /**
69
+ * Hard upper bound on {@link SenderKeysConfig.maxSenderKeyAge}, in
70
+ * milliseconds.
71
+ *
72
+ * A sender key is the one piece of group key material that no ratchet
73
+ * refreshes: it advances a chain forward on every send, so it gives forward
74
+ * secrecy against a later compromise, but a member who holds the key at time
75
+ * T can read everything sent under it afterwards. Only rotation ends that,
76
+ * and rotation is what this bound guarantees eventually happens. Membership
77
+ * changes normally force it sooner; the age bound is what covers a group
78
+ * whose membership never changes.
79
+ *
80
+ * Ninety days matches the ceiling the reference implementation applies to its
81
+ * own remotely configured value. The difference here is who is being bounded:
82
+ * the reference clamps a value it sets itself, whereas this SDK takes the
83
+ * value from the host application, so the clamp is the only thing keeping a
84
+ * deployment from disabling rotation outright by configuring an age no key
85
+ * will reach.
86
+ */
87
+ export const SENDER_KEY_AGE_CEILING = 90 * 24 * 60 * 60 * 1000;
88
+ /**
89
+ * Hard lower bound on {@link SenderKeysConfig.maxSenderKeyAge}, in
90
+ * milliseconds.
91
+ *
92
+ * Unlike the ceiling this is not a security bound — rotating sooner is
93
+ * strictly safer — it is an availability one, and it exists because expiry is
94
+ * enforced on a key that a *send* has to rotate and redistribute. When a key
95
+ * expires the send path generates a new one, fans a distribution message out
96
+ * to every other member over sequential network calls, then retries the
97
+ * encrypt, which re-checks the age of the key it just created. If the
98
+ * configured age is shorter than that fan-out takes, the retry finds the new
99
+ * key already expired and the send fails permanently, having burned a rotation
100
+ * and a message to every member on each attempt.
101
+ *
102
+ * An hour is well clear of that: even a group at the membership limit, with a
103
+ * distribution message to each member, finishes its fan-out in minutes at
104
+ * worst. It is also low enough to leave deliberately aggressive rotation
105
+ * policies intact, which a bound measured in days would not.
106
+ *
107
+ * A configured age below this is treated as the bound rather than rejected,
108
+ * because the value that reaches it is usually a unit mistake — this field is
109
+ * milliseconds, so a host that means fourteen days and passes `14` lands here
110
+ * — and the safe reading of "rotate far more often than I asked" is to rotate
111
+ * as often as the implementation can actually deliver.
112
+ */
113
+ export const SENDER_KEY_AGE_FLOOR = 60 * 60 * 1000;
68
114
  /**
69
115
  * Default values for Sender Keys configuration.
70
116
  */
@@ -1 +1 @@
1
- {"version":3,"file":"protocol-config.js","sourceRoot":"","sources":["../../types/protocol-config.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAIH;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,QAAQ,EAAE,UAAU;IACpB,UAAU,EAAE,YAAY;CAChB,CAAC;AAIX;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,QAAQ,EAAE,UAAU;IACpB,QAAQ,EAAE,UAAU;CACZ,CAAC;AAoCX;;GAEG;AACH,MAAM,UAAU,wBAAwB,CAAC,MAA6B;IACpE,MAAM,WAAW,GAAG,MAAM,EAAE,WAAW,IAAI,iBAAiB,CAAC,QAAQ,CAAC;IACtE,MAAM,KAAK,GAAG,MAAM,EAAE,KAAK,IAAI,WAAW,CAAC,QAAQ,CAAC;IAEpD,IAAI,sBAA+B,CAAC;IACpC,IAAI,WAAW,KAAK,iBAAiB,CAAC,QAAQ,EAAE,CAAC;QAC/C,sBAAsB,GAAG,KAAK,CAAC;IACjC,CAAC;SAAM,IAAI,WAAW,KAAK,iBAAiB,CAAC,UAAU,EAAE,CAAC;QACxD,sBAAsB,GAAG,IAAI,CAAC;IAChC,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,KAAK,CAAC,mCAAmC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED,IAAI,KAAK,KAAK,WAAW,CAAC,QAAQ,EAAE,CAAC;QACnC,OAAO,EAAE,sBAAsB,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;IACvD,CAAC;IAED,IAAI,KAAK,KAAK,WAAW,CAAC,QAAQ,EAAE,CAAC;QACnC,OAAO,EAAE,sBAAsB,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC;IACxD,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,6BAA6B,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;AAChE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,6BAA6B,CAAC,MAG7C;IACC,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC;QACtB,OAAO,MAAM,EAAE,gBAAgB,CAAC;IAClC,CAAC;IAED,IAAI,MAAM,CAAC,gBAAgB,EAAE,sBAAsB,KAAK,SAAS,EAAE,CAAC;QAClE,MAAM,IAAI,KAAK,CACb,yGAAyG,CAC1G,CAAC;IACJ,CAAC;IAED,IAAI,MAAM,CAAC,gBAAgB,EAAE,QAAQ,KAAK,SAAS,EAAE,CAAC;QACpD,MAAM,IAAI,KAAK,CACb,+EAA+E,CAChF,CAAC;IACJ,CAAC;IAED,OAAO;QACL,GAAG,MAAM,CAAC,gBAAgB;QAC1B,GAAG,wBAAwB,CAAC,MAAM,CAAC,QAAQ,CAAC;KAC7C,CAAC;AACJ,CAAC;AAyJD;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,cAAc,EAAE,cAAc;IAC9B,eAAe,EAAE,KAAK;IACtB,cAAc,EAAE,IAAI;IACpB,eAAe,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI;CACjC,CAAC;AAEX;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC;AAmDvC;;GAEG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAEvE;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAElE;;GAEG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAEpE;;GAEG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAE1E;;GAEG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,EAAE,CAAC;AAE7C;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,qCAAqC,CAAC;AAExE;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,UAAU,CAAC;AAc5C;;GAEG;AACH,MAAM,UAAU,wBAAwB,CACtC,MAA+B;IAE/B,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,MAAM,MAAM,GAAa,EAAE,CAAC;IAE5B,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;IAC3C,CAAC;IAED,IAAI,MAAM,CAAC,sBAAsB,EAAE,CAAC;QAClC,QAAQ,CAAC,IAAI,CACX,8FAA8F,CAC/F,CAAC;IACJ,CAAC;IAED,IAAI,MAAM,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACjC,QAAQ,CAAC,IAAI,CACX,oGAAoG,CACrG,CAAC;IACJ,CAAC;IAED,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC;QAC1B,QAAQ;QACR,MAAM;KACP,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,6BAA6B,CAC3C,MAA+B;IAU/B,OAAO;QACL,sBAAsB,EAAE,MAAM,EAAE,sBAAsB,IAAI,KAAK;QAC/D,QAAQ,EAAE,MAAM,EAAE,QAAQ,IAAI,OAAO;QACrC,kBAAkB,EAAE,MAAM,EAAE,kBAAkB;QAC9C,kBAAkB,EAAE,MAAM,EAAE,kBAAkB;QAC9C,eAAe,EAAE,MAAM,EAAE,eAAe;QACxC,UAAU,EAAE,MAAM,EAAE,UAAU;QAC9B,qBAAqB,EAAE,MAAM,EAAE,qBAAqB;KACrD,CAAC;AACJ,CAAC;AAYD;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAuB;IACtD,cAAc,EAAE,KAAK;IACrB,iBAAiB,EAAE,IAAI;CACxB,CAAC;AAEF;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAAC,MAAmB;IACnD,OAAO;QACL,cAAc,EAAE,MAAM,EAAE,cAAc,IAAI,oBAAoB,CAAC,cAAc;QAC7E,iBAAiB,EAAE,MAAM,EAAE,iBAAiB,IAAI,oBAAoB,CAAC,iBAAiB;KACvF,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,MAA+B;IAC7D,OAAO,MAAM,EAAE,QAAQ,IAAI,OAAO,CAAC;AACrC,CAAC;AAYD;;GAEG;AACH,MAAM,UAAU,6BAA6B,CAAC,QAAiB;IAC7D,IAAI,QAAQ,EAAE,CAAC;QACb,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;IAC7C,CAAC;IACD,OAAO;QACL,KAAK,EAAE,kBAAkB;QACzB,IAAI,EAAE,iBAAiB;KACxB,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"protocol-config.js","sourceRoot":"","sources":["../../types/protocol-config.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAIH;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,QAAQ,EAAE,UAAU;IACpB,UAAU,EAAE,YAAY;CAChB,CAAC;AAIX;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,QAAQ,EAAE,UAAU;IACpB,QAAQ,EAAE,UAAU;CACZ,CAAC;AAoCX;;GAEG;AACH,MAAM,UAAU,wBAAwB,CAAC,MAA6B;IACpE,MAAM,WAAW,GAAG,MAAM,EAAE,WAAW,IAAI,iBAAiB,CAAC,QAAQ,CAAC;IACtE,MAAM,KAAK,GAAG,MAAM,EAAE,KAAK,IAAI,WAAW,CAAC,QAAQ,CAAC;IAEpD,IAAI,sBAA+B,CAAC;IACpC,IAAI,WAAW,KAAK,iBAAiB,CAAC,QAAQ,EAAE,CAAC;QAC/C,sBAAsB,GAAG,KAAK,CAAC;IACjC,CAAC;SAAM,IAAI,WAAW,KAAK,iBAAiB,CAAC,UAAU,EAAE,CAAC;QACxD,sBAAsB,GAAG,IAAI,CAAC;IAChC,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,KAAK,CAAC,mCAAmC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED,IAAI,KAAK,KAAK,WAAW,CAAC,QAAQ,EAAE,CAAC;QACnC,OAAO,EAAE,sBAAsB,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;IACvD,CAAC;IAED,IAAI,KAAK,KAAK,WAAW,CAAC,QAAQ,EAAE,CAAC;QACnC,OAAO,EAAE,sBAAsB,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC;IACxD,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,6BAA6B,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;AAChE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,6BAA6B,CAAC,MAG7C;IACC,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC;QACtB,OAAO,MAAM,EAAE,gBAAgB,CAAC;IAClC,CAAC;IAED,IAAI,MAAM,CAAC,gBAAgB,EAAE,sBAAsB,KAAK,SAAS,EAAE,CAAC;QAClE,MAAM,IAAI,KAAK,CACb,yGAAyG,CAC1G,CAAC;IACJ,CAAC;IAED,IAAI,MAAM,CAAC,gBAAgB,EAAE,QAAQ,KAAK,SAAS,EAAE,CAAC;QACpD,MAAM,IAAI,KAAK,CACb,+EAA+E,CAChF,CAAC;IACJ,CAAC;IAED,OAAO;QACL,GAAG,MAAM,CAAC,gBAAgB;QAC1B,GAAG,wBAAwB,CAAC,MAAM,CAAC,QAAQ,CAAC;KAC7C,CAAC;AACJ,CAAC;AA8JD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAE/D;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAEnD;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,cAAc,EAAE,cAAc;IAC9B,eAAe,EAAE,KAAK;IACtB,cAAc,EAAE,IAAI;IACpB,eAAe,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI;CACjC,CAAC;AAEX;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC;AAmDvC;;GAEG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAEvE;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAElE;;GAEG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAEpE;;GAEG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAE1E;;GAEG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,EAAE,CAAC;AAE7C;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,qCAAqC,CAAC;AAExE;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,UAAU,CAAC;AAc5C;;GAEG;AACH,MAAM,UAAU,wBAAwB,CACtC,MAA+B;IAE/B,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,MAAM,MAAM,GAAa,EAAE,CAAC;IAE5B,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;IAC3C,CAAC;IAED,IAAI,MAAM,CAAC,sBAAsB,EAAE,CAAC;QAClC,QAAQ,CAAC,IAAI,CACX,8FAA8F,CAC/F,CAAC;IACJ,CAAC;IAED,IAAI,MAAM,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACjC,QAAQ,CAAC,IAAI,CACX,oGAAoG,CACrG,CAAC;IACJ,CAAC;IAED,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC;QAC1B,QAAQ;QACR,MAAM;KACP,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,6BAA6B,CAC3C,MAA+B;IAU/B,OAAO;QACL,sBAAsB,EAAE,MAAM,EAAE,sBAAsB,IAAI,KAAK;QAC/D,QAAQ,EAAE,MAAM,EAAE,QAAQ,IAAI,OAAO;QACrC,kBAAkB,EAAE,MAAM,EAAE,kBAAkB;QAC9C,kBAAkB,EAAE,MAAM,EAAE,kBAAkB;QAC9C,eAAe,EAAE,MAAM,EAAE,eAAe;QACxC,UAAU,EAAE,MAAM,EAAE,UAAU;QAC9B,qBAAqB,EAAE,MAAM,EAAE,qBAAqB;KACrD,CAAC;AACJ,CAAC;AAYD;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAuB;IACtD,cAAc,EAAE,KAAK;IACrB,iBAAiB,EAAE,IAAI;CACxB,CAAC;AAEF;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAAC,MAAmB;IACnD,OAAO;QACL,cAAc,EAAE,MAAM,EAAE,cAAc,IAAI,oBAAoB,CAAC,cAAc;QAC7E,iBAAiB,EAAE,MAAM,EAAE,iBAAiB,IAAI,oBAAoB,CAAC,iBAAiB;KACvF,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,MAA+B;IAC7D,OAAO,MAAM,EAAE,QAAQ,IAAI,OAAO,CAAC;AACrC,CAAC;AAYD;;GAEG;AACH,MAAM,UAAU,6BAA6B,CAAC,QAAiB;IAC7D,IAAI,QAAQ,EAAE,CAAC;QACb,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;IAC7C,CAAC;IACD,OAAO;QACL,KAAK,EAAE,kBAAkB;QACzB,IAAI,EAAE,iBAAiB;KACxB,CAAC;AACJ,CAAC"}
package/docs/ASSURANCE.md CHANGED
@@ -29,20 +29,24 @@ files that nobody could run would look like assurance without being any.
29
29
  Every change to the source repository runs the full set of automated checks,
30
30
  and an export is only cut from a revision where they pass.
31
31
 
32
- Most recent full run — 2026-07-24:
32
+ Most recent full run — 2026-07-28:
33
33
 
34
34
  | | |
35
35
  |---|---|
36
- | Modules executed | 351 |
37
- | Assertions | 5,875 |
38
- | Passed | 5,874 |
39
- | Skipped | 1 |
36
+ | Modules executed | 372 |
37
+ | Assertions | 6,552 |
38
+ | Passed | 6,550 |
39
+ | Skipped | 2 |
40
40
  | Failed | 0 |
41
- | Wall time | 96 s |
41
+ | Wall time | 395 s |
42
42
 
43
43
  Longer-running performance and endurance checks are excluded from that figure
44
44
  and run under separate commands.
45
45
 
46
+ The table above is not hand-edited: release tooling regenerates it from a real
47
+ run, refuses to write figures from a failing run, and the release gate refuses
48
+ to cut an export when the figures are more than three days old.
49
+
46
50
  Coverage spans, in the terms this documentation uses elsewhere:
47
51
 
48
52
  - **Conformance scenarios** — session, group, and sealed-sender invariants
@@ -11,68 +11,6 @@ grouped under device storage, while remote encrypted bytes are supplied by an
11
11
  explicit object-store adapter. The current API passes protocol storage as
12
12
  `adapters.storage` and remote attachment storage as `adapters.remoteObjectStore`.
13
13
 
14
- ## Target Composition
15
-
16
- The target public shape should make platform setup a factory problem, not a
17
- store-by-store wiring exercise:
18
-
19
- ```ts
20
- import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
21
- import { createExpoDeviceStorage } from "@open-e2ee/signal-protocol-sdk/device/storage/expo";
22
- import { convexR2ObjectStore } from "@open-e2ee/signal-protocol-sdk/remote/object-store/convex-r2";
23
- import { convexRelay } from "@open-e2ee/signal-protocol-sdk/remote/relay/convex";
24
- import { api } from "../convex/_generated/api";
25
-
26
- const signal = await createSignalProtocolClient({
27
- identity: { userId, deviceId },
28
- adapters: {
29
- deviceStorage: createExpoDeviceStorage({ database, files }),
30
- relay: convexRelay({ convex, api, currentUserId: userId }),
31
- remoteObjectStore: convexR2ObjectStore({
32
- convex,
33
- api: api.signalObjectStore,
34
- }),
35
- },
36
- protocol: {
37
- postQuantum: "required",
38
- braid: "required",
39
- },
40
- });
41
- ```
42
-
43
- Explicit facets preserve modularity for custom runtimes and independently
44
- verifiable integrations:
45
-
46
- ```ts
47
- const signal = await createSignalProtocolClient({
48
- identity: { userId, deviceId },
49
- adapters: {
50
- deviceStorage: {
51
- protocol: protocolStore,
52
- messages: messageStore,
53
- files: fileStore,
54
- },
55
- relay,
56
- remoteObjectStore,
57
- },
58
- });
59
- ```
60
-
61
- The target receive path should also be message-first:
62
-
63
- ```ts
64
- const unsubscribe = signal.messages.subscribe(
65
- { conversationId },
66
- async (message) => {
67
- await appMessages.render(message);
68
- },
69
- );
70
- ```
71
-
72
- Low-level hooks may remain available for advanced integrations, but ordinary
73
- app code should not depend on hook registration order or manual relay
74
- subscription startup.
75
-
76
14
  ## Local Client
77
15
 
78
16
  <!-- mock-snippet:run client-composition-local-client expect="" -->
@@ -113,7 +51,7 @@ const signal = await createSignalProtocolClient({
113
51
  identity: { userId, deviceId: 1 },
114
52
  adapters: {
115
53
  // Expo storage owns this device's private keys and session state.
116
- storage: expoStore({ relay }),
54
+ storage: expoStore(),
117
55
  relay,
118
56
  },
119
57
  logger,
@@ -155,10 +93,10 @@ const signal = await createSignalProtocolClient({
155
93
 
156
94
  The current durable media queue does not require a second queue adapter. It
157
95
  stores bounded job metadata in `adapters.storage` under SDK-owned namespaced
158
- keys. The target message-first API will move this state behind
159
- `deviceStorage.messages` and local bytes behind `deviceStorage.files`, so app
160
- code does not have to compose queue callbacks for ordinary sends. Do not add a
161
- parallel public `signal.media.*` API once message attachment helpers exist.
96
+ keys. The intended future shape moves this behind grouped device storage — see
97
+ [Future direction](#future-direction-not-shipped) — so app code does not have
98
+ to compose queue callbacks for ordinary sends. Do not add a parallel public
99
+ `signal.media.*` API once message attachment helpers exist.
162
100
 
163
101
  ## Direct Client Creation
164
102
 
@@ -181,11 +119,27 @@ const signal = await SignalProtocolClient.create(userId, {
181
119
  - Keep platform choices in `adapters`.
182
120
  - Keep account/device identity in `identity`.
183
121
  - Keep product security policy in `protocol`.
184
- - Treat `adapters.storage` and `adapters.remoteObjectStore` as current API names; the
185
- target public DX is `deviceStorage` plus `remoteObjectStore`.
186
122
  - Keep app logging, hooks, sealed sender, groups, and sender-key options at the
187
123
  top level so they match `SignalProtocolClient.create()`.
188
124
  - Use `protocol.postQuantum: 'compatible'` only when the product explicitly
189
125
  supports peers with no post-quantum material.
190
126
  - Use `protocol.braid: 'disabled'` only when a product-reviewed constraint
191
127
  explicitly selects direct SPQR.
128
+
129
+ ## Future Direction (Not Shipped)
130
+
131
+ > **Nothing in this section exists in the package.** `deviceStorage`,
132
+ > `createExpoDeviceStorage`, and `signal.messages.subscribe` are design intent
133
+ > for a future release, recorded here so the direction is public. Importing
134
+ > them fails today. The shipped API is everything above this heading.
135
+
136
+ The intended future shape makes platform setup a factory problem rather than a
137
+ store-by-store wiring exercise: a grouped `deviceStorage` adapter with
138
+ `protocol`, `messages`, and `files` facets in place of today's flat
139
+ `adapters.storage`, a per-platform factory such as a future
140
+ `createExpoDeviceStorage({ database, files })`, and a message-first receive
141
+ path shaped like `signal.messages.subscribe({ conversationId }, handler)` in
142
+ place of hook registration plus manual `startRelaySubscription()`. Low-level
143
+ hooks would remain for advanced integrations. When this lands it will be a
144
+ breaking change and this guide will lead with it; until then, wire the current
145
+ API.
@@ -69,7 +69,7 @@ model and what is out of scope.
69
69
  | **SPQR / ML-KEM Braid** | ML-KEM Braid rev. 1 | **Deviation.** Same protocol, same KDF labels, same Reed–Solomon parameters, byte-identical message framing — except `hek = SHA3-256(ek_seed ‖ ek_vector)`, the operand order the specification states, which is the reverse of `libsignal`'s implementation | The normative text was followed over the executable reference | Wire-visible. Headers, ciphertexts, and shared secrets diverge; a braid session cannot complete a single epoch against `libsignal`'s implementation. Also means the KEM is not FIPS 203 in braid mode |
70
70
  | **Triple Ratchet** | `libsignal` `triple_ratchet.rs` | **Faithful.** The PQ secret enters as the HKDF salt at message-key expansion, same label, same order | — | The braiding construction follows the ML-KEM Braid specification |
71
71
  | **Sesame** | Sesame rev. 2 | **Deviation** on session expiry (§4.2 applies only to unacknowledged sessions) and on deleted devices (hard-removed rather than marked stale). **Extensions:** QR provisioning, device transfer, encrypted device names, identity-change gating, a 5-device cap | Product requirements the specification does not address | Hard deletion **drops the MAXLATENCY window, so in-flight messages from a just-removed device become permanently undecryptable**. Device transfer clones ratchet state, which weakens the forward-secrecy bound |
72
- | **Sealed sender v1** | `libsignal` `sealed_sender.rs` | **Deviation.** Correct labels, cipher, and MAC length, but the 96-byte HKDF output is split `(cipher, mac, chain)` where `libsignal` splits `(chain, cipher, mac)`; keys in the salt omit the `0x05` type byte; the inner envelope is a hand-rolled varint format rather than the `UnidentifiedSenderMessage.Message` protobuf | The slice order and the missing prefix are unintentional; the envelope is a deliberate simplification | Self-consistent and secure, but every v1 key sits in a different slot than `libsignal`'s. The envelope also drops the message-type field |
72
+ | **Sealed sender v1** | `libsignal` `sealed_sender.rs` | **Deviation.** Correct labels, cipher, and MAC length, but the 96-byte HKDF output is split `(cipher, mac, chain)` where `libsignal` splits `(chain, cipher, mac)`; keys in the salt omit the `0x05` type byte; the inner envelope is a hand-rolled varint format rather than the `UnidentifiedSenderMessage.Message` protobuf, though it now carries the same message-type values | The slice order and the missing prefix are unintentional; the framing is a deliberate simplification | Self-consistent and secure, but every v1 key sits in a different slot than `libsignal`'s |
73
73
  | **Sealed sender v2** | `libsignal` `sealed_sender.rs` | **Faithful** on all four labels, the KEM, AES-256-GCM-SIV, the multi-recipient binary format, and the `0x3FFF` registration-ID mask | — | The v2 construction follows `libsignal` |
74
74
  | **Delivery token** | `libsignal` `profile_key.rs` | **Faithful.** `deriveAccessKey` follows `libsignal`'s `ProfileKey::derive_access_key`, and reproduces `libsignal`'s published known-answer values | — | Not an SDK invention, despite what the module name suggests |
75
75
  | **Sender keys** | `libsignal` `sender_keys.rs` | **Deviation.** Protobuf field numbers and `0x33` framing match, and the `0x01`/`0x02` seeds match, but message-key derivation **omits HKDF-Extract**, signatures are Ed25519 not XEdDSA, and `distributionUuid` carries a UTF-8 string rather than 16 UUID bytes | The Ed25519 choice follows the identity profile; the missing Extract appears unintentional | Group message keys differ from `libsignal`'s for the same chain key. Confirmed numerically, not merely by inspection |
@@ -700,10 +700,34 @@ internally inconsistent about this.
700
700
 
701
701
  **The inner envelope is a hand-rolled varint format**
702
702
  (`internal/protocol/sealed-sender/encryption.ts:46-86`) rather than the
703
- `UnidentifiedSenderMessage.Message` protobuf. It omits the message-type field that
704
- `libsignal` uses to dispatch between prekey and regular messages
705
- ([`sealed_sender.rs:2055-2075`][ss]); the unseal path reconstructs the envelope
706
- with a fixed type instead.
703
+ `UnidentifiedSenderMessage.Message` protobuf. It does carry the message-type
704
+ field `libsignal` uses to dispatch between prekey, regular, sender-key, and
705
+ plaintext payloads ([`sealed_sender.rs:2055-2075`][ss]), as a leading byte
706
+ using `libsignal`'s enum values, so the framing differs but the dispatch does
707
+ not. Through 0.1.0-alpha.7 the field was absent and the unseal path
708
+ reconstructed the envelope with a fixed type, which made sealed group messages
709
+ undecryptable as group messages.
710
+
711
+ **`PLAINTEXT_CONTENT` (8) is a known wire value that this SDK rejects.**
712
+ `libsignal` uses it to carry a `DecryptionErrorMessage` when no session exists
713
+ to encrypt one under ([`sealed_sender.rs:2055-2075`][ss]). This SDK delivers
714
+ decryption-error signals over a dedicated relay channel instead — the
715
+ `retryRequests` table and `sendRetryRequest`, per Sesame §4.1 — so no send path
716
+ produces the type and no decrypt path consumes it. It is therefore rejected at
717
+ the envelope parse (`internal/protocol/sealed-sender/types.ts`) rather than
718
+ mapped to an envelope type with no handler. The enum retains the member so the
719
+ wire values stay a faithful record, and `envelopeTypeForContent` throws on it so
720
+ that adding a member without a route fails loudly. A peer that sends one gets a
721
+ clean parse failure, not a payload routed into the pairwise ratchet.
722
+
723
+ Note the cost when debugging interop. The parsers throw a single generic error
724
+ for every malformed envelope, so a peer implementation that legitimately sends
725
+ `PLAINTEXT_CONTENT` fails with `Sealed sender verification failed` — the same
726
+ string a MAC mismatch produces. The uniformity is deliberate and the parse runs
727
+ after authentication, so nothing here is an oracle; but if sealed messages from
728
+ one particular peer stack fail with that error while messages from this SDK
729
+ succeed, check the leading content-type byte before treating it as a
730
+ cryptographic failure.
707
731
 
708
732
  ### 6.3 The delivery token follows `libsignal`, not an SDK invention
709
733
 
@@ -740,10 +764,19 @@ AES-256-CBC with the derived IV matches, and the capacity constants match.
740
764
  Three things do not:
741
765
 
742
766
  **`distributionUuid` carries a UTF-8 string, not 16 UUID bytes.** The SDK writes
743
- `groupId:userId:deviceId:timestamp`
744
- (`internal/protocol/sender-keys/manager.ts:266`, `:493`); `libsignal` writes
745
- exactly 16 raw bytes and rejects anything else on parse. Related: `chain_id` is
746
- an FNV-1a hash of that string rather than a random 31-bit value.
767
+ the 36-character textual form of a random UUIDv4
768
+ (`internal/protocol/sender-keys/manager.ts:279`, `:932`); `libsignal` writes
769
+ exactly the 16 raw bytes and rejects anything else on parse. The value is now
770
+ the same *kind* of thing `libsignal` uses — an opaque random identifier
771
+ unrelated to the group — but the encoding still differs, so the frames remain
772
+ mutually unparseable. Related: `chain_id` is an FNV-1a hash of that string
773
+ rather than a random 31-bit value.
774
+
775
+ Until recently the SDK wrote `groupId:userId:deviceId:timestamp` here, which was
776
+ a metadata leak rather than a format deviation: `distributionUuid` sits outside
777
+ the ciphertext, so every relay on the path could read the plaintext group and
778
+ sender off each message. That is fixed; the sender-keys specification now
779
+ requires the identifier to be opaque.
747
780
 
748
781
  **Signatures are Ed25519, not XEdDSA**, per §1.2 — and `libsignal` serializes the
749
782
  signing key as 33 bytes where the SDK uses 32.
@@ -793,8 +826,8 @@ presentations, and the **server** validates every action against the group's
793
826
  access control before signing and persisting the accepted result. The
794
827
  enforcement rules are the SDK's own specified S1–S14 contract rather than
795
828
  Signal Messenger's server implementation, and the shipped enforcing server
796
- (`internal/groups/server-engine.ts`, with a Convex adapter at
797
- `remote/relay/convex/server.ts`) implements that contract. Clients verify the
829
+ (`internal/groups/server-engine.ts`, with an installable Convex component)
830
+ implements that contract. Clients verify the
798
831
  server's signature, group binding, strict version sequence, and pre-state
799
832
  authorization on every applied change.
800
833
 
package/docs/E2EE.md CHANGED
@@ -1,13 +1,21 @@
1
1
  # End-to-End Encryption
2
2
 
3
- `@open-e2ee/signal-protocol-sdk` provides end-to-end encryption based on the Signal
4
- Protocol: X3DH / PQXDH key agreement and the Double Ratchet, extended with the
5
- Sparse Post-Quantum Ratchet (SPQR / ML-KEM-BRAID).
3
+ > Navigation: [README](../README.md) | [Getting Started](./GETTING_STARTED.md) |
4
+ > [Security Model](./SECURITY.md) | [Architecture](../ARCHITECTURE.md)
5
+
6
+ `@open-e2ee/signal-protocol-sdk` provides end-to-end encryption based on the
7
+ Signal Protocol: X3DH / PQXDH key agreement and the Double Ratchet, extended
8
+ with the Sparse Post-Quantum Ratchet (SPQR / ML-KEM Braid).
6
9
 
7
10
  End-to-end encryption means plaintext exists only on the sender's and
8
11
  recipient's devices. A relay or server sees ciphertext envelopes and routing
9
12
  metadata, never message contents or long-term private keys.
10
13
 
14
+ This page explains what that changes about how you build. If you have only ever
15
+ built server-authoritative applications, most of the work of adopting E2EE is
16
+ absorbing these changes — the cryptography itself is the part the SDK already
17
+ did.
18
+
11
19
  ## Security Guarantees
12
20
 
13
21
  - **End-to-end encryption** — message contents are encrypted on the sender's
@@ -20,11 +28,67 @@ metadata, never message contents or long-term private keys.
20
28
  heals the session after a key compromise, so future messages regain
21
29
  confidentiality once fresh ratchet keys are exchanged.
22
30
  - **Post-quantum confidentiality** — PQXDH and the SPQR ratchet mix ML-KEM
23
- (Kyber) shared secrets into key agreement and continuous ratcheting, providing
24
- resistance against harvest-now-decrypt-later adversaries.
31
+ (FIPS 203) shared secrets into key agreement and continuous ratcheting,
32
+ providing resistance against harvest-now-decrypt-later adversaries.
25
33
  - **Authentication & integrity** — messages are authenticated (AEAD + MACs) and
26
34
  identities are verifiable through safety numbers.
27
35
 
36
+ ## What changes about your architecture
37
+
38
+ ### The server becomes a relay
39
+
40
+ In a server-authoritative app, the database holds the truth and the backend
41
+ reads it to do its job. With E2EE the relay carries sealed envelopes: it can
42
+ route, store, and meter them, but it cannot read, search, filter, moderate, or
43
+ render them. Server-side features that assume plaintext — full-text search,
44
+ content previews, server-rendered notifications, analytics over message
45
+ content — do not degrade; they stop existing, and their replacements live on
46
+ the device. The [architecture overview](../ARCHITECTURE.md) shows exactly which
47
+ responsibilities sit on which side of that line.
48
+
49
+ ### The device becomes the source of truth
50
+
51
+ Message history, session state, and keys live in device-local storage — that is
52
+ why the `storage` adapter is required, not optional. Ratchet state mutates on
53
+ every decrypt and must persist atomically; treating local storage as a cache
54
+ that can be dropped and refetched corrupts sessions irrecoverably. The
55
+ [integration interfaces](./INTERFACES.md) exist to make that contract explicit.
56
+
57
+ ### Identity becomes a set of device keys
58
+
59
+ A user is no longer a row with a password hash; a user is a set of devices,
60
+ each with its own identity key. Adding a second device is a protocol operation
61
+ (linking), not a login. Removing one is revocation, not a session delete. Trust
62
+ is established per `(userId, identityType)` and verified with safety numbers —
63
+ see [Recipes](./RECIPES.md) for the multi-device and verification flows.
64
+
65
+ ### Recovery becomes a product decision
66
+
67
+ When the server never has the keys, "forgot password" cannot restore content.
68
+ What recovery looks like — device-to-device transfer, an encrypted backup a
69
+ user can lose, or accepting history loss — is an application policy with real
70
+ security tradeoffs in every direction. The SDK does not silently choose one for
71
+ you. The considerations are laid out in the hosted guides at
72
+ [docs.open-e2ee.dev](https://docs.open-e2ee.dev).
73
+
74
+ ### Metadata remains visible
75
+
76
+ E2EE protects content, not existence. The relay still observes envelope sizes,
77
+ timing, and routing — who is talking to whom, when, and how much. Sealed sender
78
+ narrows what the relay learns about senders, with published limits stated
79
+ plainly in the [security model](./SECURITY.md). Do not describe an E2EE product
80
+ as anonymous; the two properties are different, and conflating them is the most
81
+ common overclaim in this space.
82
+
83
+ ### Failure modes are new
84
+
85
+ Sessions can desynchronize; identity keys change when someone reinstalls;
86
+ messages arrive out of order or reference skipped keys; one-time prekeys run
87
+ out. These are protocol realities, not bugs, and the SDK surfaces them as
88
+ explicit states and errors rather than hiding them — see
89
+ [Error Handling](./ERROR_HANDLING.md) for what each one means and what your
90
+ application should do about it.
91
+
28
92
  ## Verifiability
29
93
 
30
94
  The implementation uses narrow protocol seams, explicit state transitions, and
@@ -32,4 +96,5 @@ injectable storage and relay boundaries so security properties can be evaluated
32
96
  independently. This documentation describes intended behavior; it is not a
33
97
  third-party security certification.
34
98
 
35
- See also [SECURITY.md](../SECURITY.md) and [ARCHITECTURE.md](../ARCHITECTURE.md).
99
+ See also [SECURITY.md](./SECURITY.md), [ASSURANCE.md](./ASSURANCE.md), and
100
+ [ARCHITECTURE.md](../ARCHITECTURE.md).
@@ -336,7 +336,7 @@ const signal = await createSignalProtocolClient({
336
336
  identity: { userId },
337
337
  adapters: {
338
338
  // Storage owns this device's private keys and session state.
339
- storage: expoStore({ relay }),
339
+ storage: expoStore(),
340
340
  relay,
341
341
  },
342
342
  });
@@ -64,7 +64,7 @@ Expo storage or Convex helpers.
64
64
  - `@open-e2ee/signal-protocol-sdk/remote/relay`
65
65
  - `@open-e2ee/signal-protocol-sdk/remote/relay/convex`
66
66
  - `@open-e2ee/signal-protocol-sdk/remote/relay/convex/relay`
67
- - `@open-e2ee/signal-protocol-sdk/remote/relay/convex/server`
67
+ - `@open-e2ee/signal-protocol-sdk/convex.config`
68
68
  - `@open-e2ee/signal-protocol-sdk/remote/relay/mock`
69
69
  - `@open-e2ee/signal-protocol-sdk/remote/relay/types`
70
70
  - `@open-e2ee/signal-protocol-sdk/remote/object-store`
@@ -145,10 +145,11 @@ Expo storage or Convex helpers.
145
145
 
146
146
  - `ConvexSignalProtocolRelayServer` for Convex-backed apps
147
147
  - `convexRelay()` for Convex-backed composition
148
- - `defineConvexGroupServer()` via the server-only
149
- `@open-e2ee/signal-protocol-sdk/remote/relay/convex/server` entry point,
150
- with the `oe-groups` CLI (`npx oe-groups trust-root`) for secret
151
- initialization and trust-root export
148
+ - the installable component from
149
+ `@open-e2ee/signal-protocol-sdk/convex.config`, with public handlers from
150
+ `defineConvexSignalProtocolBackend()` and the `oe-groups` CLI
151
+ (`npx oe-groups trust-root`) for secret initialization and trust-root
152
+ export
152
153
  - `MockSignalProtocolRelayServer` / `mockRelay()` for local development
153
154
  - custom implementations via `ISignalProtocolRelayServer`
154
155
 
package/docs/RECIPES.md CHANGED
@@ -118,7 +118,7 @@ const signal = await createSignalProtocolClient({
118
118
  identity: { userId },
119
119
  adapters: {
120
120
  // Storage owns this device's private keys and session state.
121
- storage: expoStore({ relay }),
121
+ storage: expoStore(),
122
122
  relay,
123
123
  },
124
124
  });
package/docs/SECURITY.md CHANGED
@@ -140,6 +140,14 @@ compromised application code, a stolen unlocked device, or an attacker who also
140
140
  obtains the adapter encryption key. Browser IndexedDB and caller-provided React
141
141
  Native storage inherit their host application's security boundary.
142
142
 
143
+ Group sender key state never leaves the device. A sender key record holds the
144
+ chain key every message key on that chain derives from and the sender's private
145
+ signature key; together they are enough to read a sender's group messages and to
146
+ forge new ones, so no adapter transmits them and no relay contract accepts them.
147
+ The same rule covers the message keys held for out-of-order group messages.
148
+ Local adapters bound that skipped-key store so a peer cannot grow it without
149
+ limit by skipping ever further ahead.
150
+
143
151
  Relay and remote object-store adapters receive public key material, routing
144
152
  metadata, and opaque ciphertext required by their contracts. TLS,
145
153
  authorization, abuse controls, atomic prekey consumption, and access logging
@@ -38,7 +38,9 @@ operational behavior require further deployment evidence.
38
38
 
39
39
  - `NodeSignalProtocolStore` from `@open-e2ee/signal-protocol-sdk/local/store/node`
40
40
 
41
- Use this for non-mobile environments that need a filesystem-backed store.
41
+ Use this for non-mobile environments that need a filesystem-backed store. It
42
+ implements the full core store contract, including SESAME records, sender-key
43
+ state, retry message records, and recovery helpers.
42
44
 
43
45
  ## Composition
44
46
 
@@ -49,6 +49,15 @@ configuration, apply the supplied key before schema access, create or migrate
49
49
  the exported tables, and return the matching raw and Drizzle handles. SQLCipher
50
50
  requires a development build and is not available in Expo Go.
51
51
 
52
+ Every table this store exports holds material that must not leave the device.
53
+ That includes the group `sender_keys` and `skipped_sender_keys` tables, whose
54
+ rows contain the sender chain key, the sender's private signature key, and
55
+ individual message keys — enough to read and to forge a sender's group
56
+ messages. They are stored unencrypted at the row level because SQLCipher
57
+ encrypts the database file itself, so the database key is the only thing that
58
+ protects them. Do not back these tables up to a server or sync them between
59
+ devices.
60
+
52
61
  ## Client usage
53
62
 
54
63
  ```ts
@@ -58,7 +67,7 @@ import { expoStore } from "@open-e2ee/signal-protocol-sdk/local/store/expo";
58
67
  const client = await createSignalProtocolClient({
59
68
  identity: { userId },
60
69
  adapters: {
61
- storage: expoStore({ relay }),
70
+ storage: expoStore(),
62
71
  relay,
63
72
  },
64
73
  });
@@ -1,8 +1,15 @@
1
1
  # Node Store
2
2
 
3
- `NodeSignalProtocolStore` implements `ISignalProtocolLocalStore` for Node.js using encrypted,
3
+ `NodeSignalProtocolStore` provides Node.js protocol storage using encrypted,
4
4
  crash-durable filesystem state.
5
5
 
6
+ It implements all of `ISignalProtocolLocalStore` — identity, prekeys, sessions,
7
+ Kyber prekeys, Sesame device records, sender keys, and message records — so
8
+ multi-device and group flows work in Node without a custom adapter. The class
9
+ declares `implements ISignalProtocolLocalStore`, so the compiler rejects any
10
+ build in which a member is missing or its signature drifts; that check is the
11
+ guarantee behind this paragraph, not a manual audit.
12
+
6
13
  ## Why it exists
7
14
 
8
15
  Servers, command-line tools, and desktop processes may need persistent protocol