@open-e2ee/signal-protocol-sdk 0.2.3 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (601) hide show
  1. package/ADAPTERS.md +4 -4
  2. package/ARCHITECTURE.md +17 -16
  3. package/CHANGELOG.md +39 -0
  4. package/COMMERCIAL.md +6 -6
  5. package/NOTICE +1 -1
  6. package/README.md +44 -34
  7. package/SECURITY.md +16 -13
  8. package/TROUBLESHOOTING.md +5 -5
  9. package/blocking/README.md +6 -5
  10. package/client/README.md +5 -5
  11. package/device/README.md +8 -8
  12. package/dist/blocking/types.d.ts +2 -2
  13. package/dist/blocking/types.js +2 -2
  14. package/dist/client/client.d.ts +46 -45
  15. package/dist/client/client.d.ts.map +1 -1
  16. package/dist/client/client.js +61 -60
  17. package/dist/client/client.js.map +1 -1
  18. package/dist/client/config.d.ts +32 -32
  19. package/dist/client/constants.d.ts +7 -6
  20. package/dist/client/constants.d.ts.map +1 -1
  21. package/dist/client/constants.js +5 -4
  22. package/dist/client/constants.js.map +1 -1
  23. package/dist/client/dual-store.d.ts +2 -2
  24. package/dist/client/dual-store.js +2 -2
  25. package/dist/client/endorsement-manager.d.ts +14 -14
  26. package/dist/client/endorsement-manager.d.ts.map +1 -1
  27. package/dist/client/endorsement-manager.js +15 -15
  28. package/dist/client/endorsement-manager.js.map +1 -1
  29. package/dist/client/event-hooks.d.ts +16 -16
  30. package/dist/client/event-hooks.d.ts.map +1 -1
  31. package/dist/client/event-hooks.js +1 -1
  32. package/dist/client/event-hooks.js.map +1 -1
  33. package/dist/client/files.js +4 -4
  34. package/dist/client/files.js.map +1 -1
  35. package/dist/client/headless.d.ts +7 -7
  36. package/dist/client/headless.d.ts.map +1 -1
  37. package/dist/client/headless.js +4 -4
  38. package/dist/client/key-rotation-core.d.ts +19 -17
  39. package/dist/client/key-rotation-core.d.ts.map +1 -1
  40. package/dist/client/key-rotation-core.js +35 -31
  41. package/dist/client/key-rotation-core.js.map +1 -1
  42. package/dist/client/key-rotation.d.ts +8 -8
  43. package/dist/client/key-rotation.js +8 -8
  44. package/dist/client/media.d.ts +1 -1
  45. package/dist/client/messages.d.ts.map +1 -1
  46. package/dist/client/messages.js +13 -11
  47. package/dist/client/messages.js.map +1 -1
  48. package/dist/client/multi-device.d.ts +5 -4
  49. package/dist/client/multi-device.d.ts.map +1 -1
  50. package/dist/client/multi-device.js.map +1 -1
  51. package/dist/client/prekeys.d.ts +7 -7
  52. package/dist/client/prekeys.js +10 -10
  53. package/dist/client/prekeys.js.map +1 -1
  54. package/dist/client/relay-subscription.d.ts +3 -0
  55. package/dist/client/relay-subscription.d.ts.map +1 -1
  56. package/dist/client/relay-subscription.js +7 -4
  57. package/dist/client/relay-subscription.js.map +1 -1
  58. package/dist/client/retry-utils.d.ts +5 -6
  59. package/dist/client/retry-utils.d.ts.map +1 -1
  60. package/dist/client/retry-utils.js +5 -12
  61. package/dist/client/retry-utils.js.map +1 -1
  62. package/dist/client/retry.js +7 -7
  63. package/dist/client/retry.js.map +1 -1
  64. package/dist/client/sealed-sender-ops.d.ts +3 -3
  65. package/dist/client/sealed-sender-ops.js +5 -5
  66. package/dist/client/sealed-sender-ops.js.map +1 -1
  67. package/dist/client/sessions.d.ts +2 -2
  68. package/dist/client/sessions.js +2 -2
  69. package/dist/client/signal-service-cipher.d.ts +9 -9
  70. package/dist/client/signal-service-cipher.d.ts.map +1 -1
  71. package/dist/client/signal-service-cipher.js +41 -40
  72. package/dist/client/signal-service-cipher.js.map +1 -1
  73. package/dist/client/state.d.ts +1 -1
  74. package/dist/client/state.js +1 -1
  75. package/dist/client/types.d.ts +19 -19
  76. package/dist/client/types.d.ts.map +1 -1
  77. package/dist/device/connection.d.ts +1 -1
  78. package/dist/device/connection.js +2 -2
  79. package/dist/device/connection.js.map +1 -1
  80. package/dist/device/constants.d.ts +4 -4
  81. package/dist/device/constants.js +3 -3
  82. package/dist/device/device-id.d.ts +4 -4
  83. package/dist/device/device-id.js +4 -4
  84. package/dist/device/expo-metadata.d.ts +13 -11
  85. package/dist/device/expo-metadata.d.ts.map +1 -1
  86. package/dist/device/expo-metadata.js +13 -11
  87. package/dist/device/expo-metadata.js.map +1 -1
  88. package/dist/device/lifecycle/manager.d.ts +6 -6
  89. package/dist/device/lifecycle/manager.js +7 -7
  90. package/dist/device/lifecycle/types.d.ts +13 -13
  91. package/dist/device/lifecycle/types.d.ts.map +1 -1
  92. package/dist/device/lifecycle/utils.d.ts +2 -2
  93. package/dist/device/lifecycle/utils.js +5 -5
  94. package/dist/device/lifecycle/utils.js.map +1 -1
  95. package/dist/device/provisioning.d.ts +5 -4
  96. package/dist/device/provisioning.d.ts.map +1 -1
  97. package/dist/device/provisioning.js +5 -4
  98. package/dist/device/provisioning.js.map +1 -1
  99. package/dist/device/transfer.d.ts +2 -2
  100. package/dist/device/transfer.js +3 -3
  101. package/dist/device/transfer.js.map +1 -1
  102. package/dist/encoding/index.d.ts +3 -4
  103. package/dist/encoding/index.d.ts.map +1 -1
  104. package/dist/encoding/index.js.map +1 -1
  105. package/dist/files/index.d.ts +1 -1
  106. package/dist/files/index.js +1 -1
  107. package/dist/hooks/use-connection-presence.d.ts +1 -1
  108. package/dist/hooks/use-connection-presence.js +7 -7
  109. package/dist/hooks/use-connection-presence.js.map +1 -1
  110. package/dist/hooks/use-group-membership.d.ts +2 -2
  111. package/dist/hooks/use-group-membership.d.ts.map +1 -1
  112. package/dist/hooks/use-group-membership.js +6 -6
  113. package/dist/hooks/use-group-membership.js.map +1 -1
  114. package/dist/hooks/use-key-rotation.js +3 -3
  115. package/dist/hooks/use-key-rotation.js.map +1 -1
  116. package/dist/hooks/use-single-flight.d.ts +2 -2
  117. package/dist/hooks/use-single-flight.js +1 -1
  118. package/dist/index.d.ts +4 -3
  119. package/dist/index.d.ts.map +1 -1
  120. package/dist/index.js +22 -4
  121. package/dist/index.js.map +1 -1
  122. package/dist/internal/crypto/ec/ed25519.d.ts +6 -6
  123. package/dist/internal/crypto/ec/ed25519.js +6 -6
  124. package/dist/internal/crypto/ec/x25519-validation.d.ts.map +1 -1
  125. package/dist/internal/crypto/ec/x25519-validation.js +4 -2
  126. package/dist/internal/crypto/ec/x25519-validation.js.map +1 -1
  127. package/dist/internal/crypto/index.d.ts +2 -0
  128. package/dist/internal/crypto/index.d.ts.map +1 -1
  129. package/dist/internal/crypto/index.js +2 -0
  130. package/dist/internal/crypto/index.js.map +1 -1
  131. package/dist/internal/crypto/kdf/hkdf.d.ts +9 -8
  132. package/dist/internal/crypto/kdf/hkdf.d.ts.map +1 -1
  133. package/dist/internal/crypto/kdf/hkdf.js +11 -10
  134. package/dist/internal/crypto/kdf/hkdf.js.map +1 -1
  135. package/dist/internal/crypto/key-prefix.d.ts +3 -3
  136. package/dist/internal/crypto/key-prefix.js +3 -3
  137. package/dist/internal/crypto/pq/kyber.d.ts +7 -7
  138. package/dist/internal/crypto/pq/kyber.js +10 -10
  139. package/dist/internal/crypto/pq/kyber.js.map +1 -1
  140. package/dist/internal/crypto/random.d.ts +1 -1
  141. package/dist/internal/crypto/random.js +1 -1
  142. package/dist/internal/crypto/symmetric/aes-gcm-siv.js +1 -1
  143. package/dist/internal/crypto/symmetric/aes.js +4 -4
  144. package/dist/internal/crypto/symmetric/aes.js.map +1 -1
  145. package/dist/internal/crypto/symmetric/mac.d.ts +1 -1
  146. package/dist/internal/crypto/symmetric/mac.js +3 -3
  147. package/dist/internal/crypto/symmetric/padding.js +1 -1
  148. package/dist/internal/crypto/symmetric/padding.js.map +1 -1
  149. package/dist/internal/crypto/symmetric/streaming-aead.d.ts +7 -1
  150. package/dist/internal/crypto/symmetric/streaming-aead.d.ts.map +1 -1
  151. package/dist/internal/crypto/symmetric/streaming-aead.js +10 -4
  152. package/dist/internal/crypto/symmetric/streaming-aead.js.map +1 -1
  153. package/dist/internal/crypto/utils.d.ts +2 -2
  154. package/dist/internal/crypto/utils.d.ts.map +1 -1
  155. package/dist/internal/crypto/utils.js +16 -14
  156. package/dist/internal/crypto/utils.js.map +1 -1
  157. package/dist/internal/crypto/validation.d.ts +4 -4
  158. package/dist/internal/crypto/validation.js +2 -2
  159. package/dist/internal/encoding/proto/envelope.d.ts +1 -1
  160. package/dist/internal/encoding/proto/envelope.js +1 -1
  161. package/dist/internal/encoding/proto/index.d.ts +4 -4
  162. package/dist/internal/encoding/proto/index.js +4 -4
  163. package/dist/internal/encoding/proto/pq-ratchet-serialize.d.ts +28 -16
  164. package/dist/internal/encoding/proto/pq-ratchet-serialize.d.ts.map +1 -1
  165. package/dist/internal/encoding/proto/pq-ratchet-serialize.js +30 -18
  166. package/dist/internal/encoding/proto/pq-ratchet-serialize.js.map +1 -1
  167. package/dist/internal/encoding/proto/primitives.d.ts +45 -35
  168. package/dist/internal/encoding/proto/primitives.d.ts.map +1 -1
  169. package/dist/internal/encoding/proto/primitives.js +54 -43
  170. package/dist/internal/encoding/proto/primitives.js.map +1 -1
  171. package/dist/internal/encoding/proto/sender-key-message.d.ts +2 -2
  172. package/dist/internal/encoding/proto/sender-key-message.js +2 -2
  173. package/dist/internal/encoding/proto/signal-message.d.ts +13 -13
  174. package/dist/internal/encoding/proto/signal-message.d.ts.map +1 -1
  175. package/dist/internal/encoding/proto/signal-message.js +13 -13
  176. package/dist/internal/encoding/proto/signal-message.js.map +1 -1
  177. package/dist/internal/groups/access-control.d.ts +5 -5
  178. package/dist/internal/groups/access-control.js +6 -6
  179. package/dist/internal/groups/access-control.js.map +1 -1
  180. package/dist/internal/groups/change-actions.d.ts +4 -4
  181. package/dist/internal/groups/change-actions.js +3 -3
  182. package/dist/internal/groups/encrypted-state.js +1 -1
  183. package/dist/internal/groups/encrypted-state.js.map +1 -1
  184. package/dist/internal/groups/group-id.d.ts +1 -1
  185. package/dist/internal/groups/manager.d.ts +24 -23
  186. package/dist/internal/groups/manager.d.ts.map +1 -1
  187. package/dist/internal/groups/manager.js +40 -36
  188. package/dist/internal/groups/manager.js.map +1 -1
  189. package/dist/internal/groups/server-engine.d.ts +29 -21
  190. package/dist/internal/groups/server-engine.d.ts.map +1 -1
  191. package/dist/internal/groups/server-engine.js +55 -50
  192. package/dist/internal/groups/server-engine.js.map +1 -1
  193. package/dist/internal/groups/trust-root.d.ts +2 -2
  194. package/dist/internal/groups/trust-root.js +2 -2
  195. package/dist/internal/groups/types.d.ts +4 -4
  196. package/dist/internal/groups/types.d.ts.map +1 -1
  197. package/dist/internal/groups/wire.d.ts +6 -7
  198. package/dist/internal/groups/wire.d.ts.map +1 -1
  199. package/dist/internal/groups/wire.js +6 -7
  200. package/dist/internal/groups/wire.js.map +1 -1
  201. package/dist/internal/manager/manager.d.ts +14 -12
  202. package/dist/internal/manager/manager.d.ts.map +1 -1
  203. package/dist/internal/manager/manager.js +47 -41
  204. package/dist/internal/manager/manager.js.map +1 -1
  205. package/dist/internal/protocol/double-ratchet/chains.d.ts +8 -6
  206. package/dist/internal/protocol/double-ratchet/chains.d.ts.map +1 -1
  207. package/dist/internal/protocol/double-ratchet/chains.js +10 -8
  208. package/dist/internal/protocol/double-ratchet/chains.js.map +1 -1
  209. package/dist/internal/protocol/double-ratchet/index.d.ts +2 -2
  210. package/dist/internal/protocol/double-ratchet/index.js +2 -2
  211. package/dist/internal/protocol/double-ratchet/ratchet.d.ts +4 -4
  212. package/dist/internal/protocol/double-ratchet/ratchet.js +6 -6
  213. package/dist/internal/protocol/pqxdh/pqxdh.d.ts +21 -18
  214. package/dist/internal/protocol/pqxdh/pqxdh.d.ts.map +1 -1
  215. package/dist/internal/protocol/pqxdh/pqxdh.js +48 -42
  216. package/dist/internal/protocol/pqxdh/pqxdh.js.map +1 -1
  217. package/dist/internal/protocol/sealed-sender/decryption-v2.js +5 -5
  218. package/dist/internal/protocol/sealed-sender/decryption-v2.js.map +1 -1
  219. package/dist/internal/protocol/sealed-sender/decryption.d.ts.map +1 -1
  220. package/dist/internal/protocol/sealed-sender/decryption.js +11 -8
  221. package/dist/internal/protocol/sealed-sender/decryption.js.map +1 -1
  222. package/dist/internal/protocol/sealed-sender/delivery-token.d.ts +2 -2
  223. package/dist/internal/protocol/sealed-sender/delivery-token.js +2 -2
  224. package/dist/internal/protocol/sealed-sender/encryption-v2.js +1 -1
  225. package/dist/internal/protocol/sealed-sender/encryption-v2.js.map +1 -1
  226. package/dist/internal/protocol/sealed-sender/encryption.d.ts +2 -2
  227. package/dist/internal/protocol/sealed-sender/encryption.js +2 -2
  228. package/dist/internal/protocol/sealed-sender/proto/index.d.ts +25 -23
  229. package/dist/internal/protocol/sealed-sender/proto/index.d.ts.map +1 -1
  230. package/dist/internal/protocol/sealed-sender/proto/index.js +32 -30
  231. package/dist/internal/protocol/sealed-sender/proto/index.js.map +1 -1
  232. package/dist/internal/protocol/sealed-sender/trust-root.d.ts +10 -9
  233. package/dist/internal/protocol/sealed-sender/trust-root.d.ts.map +1 -1
  234. package/dist/internal/protocol/sealed-sender/trust-root.js +10 -9
  235. package/dist/internal/protocol/sealed-sender/trust-root.js.map +1 -1
  236. package/dist/internal/protocol/sealed-sender/types.d.ts +13 -14
  237. package/dist/internal/protocol/sealed-sender/types.d.ts.map +1 -1
  238. package/dist/internal/protocol/sealed-sender/types.js +7 -8
  239. package/dist/internal/protocol/sealed-sender/types.js.map +1 -1
  240. package/dist/internal/protocol/sealed-sender/v2-binary.d.ts +1 -1
  241. package/dist/internal/protocol/sealed-sender/v2-binary.js +2 -2
  242. package/dist/internal/protocol/sealed-sender/v2-binary.js.map +1 -1
  243. package/dist/internal/protocol/sender-keys/manager.d.ts +16 -14
  244. package/dist/internal/protocol/sender-keys/manager.d.ts.map +1 -1
  245. package/dist/internal/protocol/sender-keys/manager.js +37 -34
  246. package/dist/internal/protocol/sender-keys/manager.js.map +1 -1
  247. package/dist/internal/protocol/spqr/braid-serialize.d.ts +6 -6
  248. package/dist/internal/protocol/spqr/braid-serialize.js +5 -5
  249. package/dist/internal/protocol/spqr/braid-serialize.js.map +1 -1
  250. package/dist/internal/protocol/spqr/braid.d.ts +3 -3
  251. package/dist/internal/protocol/spqr/braid.js +7 -7
  252. package/dist/internal/protocol/spqr/braid.js.map +1 -1
  253. package/dist/internal/protocol/spqr/index.js +1 -1
  254. package/dist/internal/protocol/spqr/index.js.map +1 -1
  255. package/dist/internal/protocol/spqr/ml-kem-braid/chunk-domain.d.ts +3 -3
  256. package/dist/internal/protocol/spqr/ml-kem-braid/chunk-domain.js +3 -3
  257. package/dist/internal/protocol/spqr/ml-kem-braid/incremental-kem.js +1 -1
  258. package/dist/internal/protocol/spqr/ml-kem-braid/incremental-kem.js.map +1 -1
  259. package/dist/internal/protocol/spqr/ml-kem-braid/kdf.d.ts +1 -1
  260. package/dist/internal/protocol/spqr/ml-kem-braid/kdf.js +1 -1
  261. package/dist/internal/protocol/spqr/ml-kem-braid/kdf.js.map +1 -1
  262. package/dist/internal/protocol/spqr/ml-kem-braid/noble-pq/arithmetic.d.ts +4 -3
  263. package/dist/internal/protocol/spqr/ml-kem-braid/noble-pq/arithmetic.d.ts.map +1 -1
  264. package/dist/internal/protocol/spqr/ml-kem-braid/noble-pq/arithmetic.js +4 -3
  265. package/dist/internal/protocol/spqr/ml-kem-braid/noble-pq/arithmetic.js.map +1 -1
  266. package/dist/internal/protocol/spqr/ml-kem-braid/noble-pq/index.js +2 -2
  267. package/dist/internal/protocol/spqr/ml-kem-braid/progress.d.ts +1 -1
  268. package/dist/internal/protocol/spqr/ml-kem-braid/progress.js +1 -1
  269. package/dist/internal/protocol/spqr/ml-kem-braid/rs/codec.d.ts +15 -7
  270. package/dist/internal/protocol/spqr/ml-kem-braid/rs/codec.d.ts.map +1 -1
  271. package/dist/internal/protocol/spqr/ml-kem-braid/rs/codec.js +15 -7
  272. package/dist/internal/protocol/spqr/ml-kem-braid/rs/codec.js.map +1 -1
  273. package/dist/internal/protocol/spqr/ml-kem-braid/rs/galois/field.js +1 -1
  274. package/dist/internal/protocol/spqr/ml-kem-braid/rs/polynomial.d.ts +3 -3
  275. package/dist/internal/protocol/spqr/ml-kem-braid/rs/polynomial.js +1 -1
  276. package/dist/internal/protocol/spqr/ml-kem-braid/serialize.d.ts +7 -7
  277. package/dist/internal/protocol/spqr/ml-kem-braid/serialize.js +11 -11
  278. package/dist/internal/protocol/spqr/ml-kem-braid/serialize.js.map +1 -1
  279. package/dist/internal/protocol/spqr/ml-kem-braid/state-machine.d.ts +1 -1
  280. package/dist/internal/protocol/spqr/ml-kem-braid/state-machine.js +6 -6
  281. package/dist/internal/protocol/spqr/ml-kem-braid/state-machine.js.map +1 -1
  282. package/dist/internal/protocol/spqr/ml-kem-braid/types.d.ts +2 -2
  283. package/dist/internal/protocol/spqr/ml-kem-braid/types.d.ts.map +1 -1
  284. package/dist/internal/protocol/spqr/ml-kem-braid/types.js.map +1 -1
  285. package/dist/internal/protocol/spqr/serialize.d.ts +12 -12
  286. package/dist/internal/protocol/spqr/serialize.js +5 -5
  287. package/dist/internal/protocol/spqr/spqr.d.ts +6 -6
  288. package/dist/internal/protocol/spqr/spqr.d.ts.map +1 -1
  289. package/dist/internal/protocol/spqr/spqr.js +47 -42
  290. package/dist/internal/protocol/spqr/spqr.js.map +1 -1
  291. package/dist/internal/protocol/spqr/validate.d.ts +1 -1
  292. package/dist/internal/protocol/triple-ratchet/ratchet.d.ts +12 -12
  293. package/dist/internal/protocol/triple-ratchet/ratchet.d.ts.map +1 -1
  294. package/dist/internal/protocol/triple-ratchet/ratchet.js +11 -11
  295. package/dist/internal/protocol/triple-ratchet/ratchet.js.map +1 -1
  296. package/dist/internal/protocol/username/hash.d.ts.map +1 -1
  297. package/dist/internal/protocol/username/hash.js +6 -4
  298. package/dist/internal/protocol/username/hash.js.map +1 -1
  299. package/dist/internal/protocol/version.d.ts +3 -3
  300. package/dist/internal/protocol/version.js +1 -1
  301. package/dist/internal/protocol/x3dh/x3dh.d.ts +16 -16
  302. package/dist/internal/protocol/x3dh/x3dh.d.ts.map +1 -1
  303. package/dist/internal/protocol/x3dh/x3dh.js +15 -15
  304. package/dist/internal/protocol/x3dh/x3dh.js.map +1 -1
  305. package/dist/internal/protocol/zk/credentials/attributes.d.ts +7 -7
  306. package/dist/internal/protocol/zk/credentials/attributes.js +7 -7
  307. package/dist/internal/protocol/zk/credentials/credentials.d.ts +1 -1
  308. package/dist/internal/protocol/zk/credentials/credentials.js +1 -1
  309. package/dist/internal/protocol/zk/credentials/endorsements.d.ts +11 -11
  310. package/dist/internal/protocol/zk/credentials/endorsements.js +14 -14
  311. package/dist/internal/protocol/zk/credentials/issuance.d.ts +5 -1
  312. package/dist/internal/protocol/zk/credentials/issuance.d.ts.map +1 -1
  313. package/dist/internal/protocol/zk/credentials/issuance.js +5 -1
  314. package/dist/internal/protocol/zk/credentials/issuance.js.map +1 -1
  315. package/dist/internal/protocol/zk/credentials/presentation.d.ts +16 -16
  316. package/dist/internal/protocol/zk/credentials/presentation.d.ts.map +1 -1
  317. package/dist/internal/protocol/zk/credentials/presentation.js +18 -18
  318. package/dist/internal/protocol/zk/credentials/presentation.js.map +1 -1
  319. package/dist/internal/protocol/zk/groups/auth-credential.d.ts +22 -16
  320. package/dist/internal/protocol/zk/groups/auth-credential.d.ts.map +1 -1
  321. package/dist/internal/protocol/zk/groups/auth-credential.js +19 -14
  322. package/dist/internal/protocol/zk/groups/auth-credential.js.map +1 -1
  323. package/dist/internal/protocol/zk/groups/client-zk-group-cipher.d.ts +4 -4
  324. package/dist/internal/protocol/zk/groups/client-zk-group-cipher.js +4 -4
  325. package/dist/internal/protocol/zk/groups/group-params.d.ts +2 -2
  326. package/dist/internal/protocol/zk/groups/group-params.js +2 -2
  327. package/dist/internal/protocol/zk/groups/group-send-endorsement.d.ts +10 -9
  328. package/dist/internal/protocol/zk/groups/group-send-endorsement.d.ts.map +1 -1
  329. package/dist/internal/protocol/zk/groups/group-send-endorsement.js +9 -8
  330. package/dist/internal/protocol/zk/groups/group-send-endorsement.js.map +1 -1
  331. package/dist/internal/protocol/zk/groups/lizard.d.ts +1 -1
  332. package/dist/internal/protocol/zk/groups/lizard.js +4 -4
  333. package/dist/internal/protocol/zk/groups/lizard.js.map +1 -1
  334. package/dist/internal/protocol/zk/groups/profile-key-commitment.d.ts +3 -3
  335. package/dist/internal/protocol/zk/groups/profile-key-commitment.js +3 -3
  336. package/dist/internal/protocol/zk/groups/profile-key-credential.d.ts +11 -11
  337. package/dist/internal/protocol/zk/groups/profile-key-credential.js +7 -7
  338. package/dist/internal/protocol/zk/groups/profile-key-encryption.d.ts +2 -2
  339. package/dist/internal/protocol/zk/groups/profile-key-encryption.js +2 -2
  340. package/dist/internal/protocol/zk/groups/profile-key-struct.d.ts +2 -2
  341. package/dist/internal/protocol/zk/groups/profile-key-struct.js +2 -2
  342. package/dist/internal/protocol/zk/groups/profile-key-version.d.ts +2 -2
  343. package/dist/internal/protocol/zk/groups/profile-key-version.js +2 -2
  344. package/dist/internal/protocol/zk/groups/server-params.d.ts +1 -1
  345. package/dist/internal/protocol/zk/groups/server-params.js +1 -1
  346. package/dist/internal/protocol/zk/groups/uid-encryption.d.ts +4 -4
  347. package/dist/internal/protocol/zk/groups/uid-encryption.js +4 -4
  348. package/dist/internal/protocol/zk/groups/uid-struct.d.ts +2 -2
  349. package/dist/internal/protocol/zk/groups/uid-struct.js +3 -3
  350. package/dist/internal/protocol/zk/groups/uid-struct.js.map +1 -1
  351. package/dist/internal/protocol/zk/proofs/args.d.ts +3 -3
  352. package/dist/internal/protocol/zk/proofs/args.js +3 -3
  353. package/dist/internal/protocol/zk/proofs/sho-sha256.d.ts +3 -3
  354. package/dist/internal/protocol/zk/proofs/sho-sha256.js +3 -3
  355. package/dist/internal/protocol/zk/proofs/sho.d.ts +8 -7
  356. package/dist/internal/protocol/zk/proofs/sho.d.ts.map +1 -1
  357. package/dist/internal/protocol/zk/proofs/sho.js +8 -7
  358. package/dist/internal/protocol/zk/proofs/sho.js.map +1 -1
  359. package/dist/internal/protocol/zk/proofs/statement.d.ts +8 -6
  360. package/dist/internal/protocol/zk/proofs/statement.d.ts.map +1 -1
  361. package/dist/internal/protocol/zk/proofs/statement.js +8 -6
  362. package/dist/internal/protocol/zk/proofs/statement.js.map +1 -1
  363. package/dist/internal/sesame/manager.d.ts +23 -19
  364. package/dist/internal/sesame/manager.d.ts.map +1 -1
  365. package/dist/internal/sesame/manager.js +64 -54
  366. package/dist/internal/sesame/manager.js.map +1 -1
  367. package/dist/internal/sesame/types.d.ts +28 -25
  368. package/dist/internal/sesame/types.d.ts.map +1 -1
  369. package/dist/internal/sesame/types.js +2 -2
  370. package/dist/internal/sesame/types.js.map +1 -1
  371. package/dist/internal/sesame/validation.d.ts +2 -2
  372. package/dist/internal/sesame/validation.js +3 -3
  373. package/dist/internal/sesame/validation.js.map +1 -1
  374. package/dist/internal/session/builder.d.ts +8 -8
  375. package/dist/internal/session/builder.js +22 -22
  376. package/dist/internal/session/builder.js.map +1 -1
  377. package/dist/internal/session/cipher.d.ts +3 -3
  378. package/dist/internal/session/cipher.d.ts.map +1 -1
  379. package/dist/internal/session/cipher.js +51 -40
  380. package/dist/internal/session/cipher.js.map +1 -1
  381. package/dist/internal/session/decryption.js +11 -9
  382. package/dist/internal/session/decryption.js.map +1 -1
  383. package/dist/internal/session/factory.js +1 -1
  384. package/dist/internal/session/factory.js.map +1 -1
  385. package/dist/internal/session/handshake.d.ts +4 -4
  386. package/dist/internal/session/handshake.js +4 -4
  387. package/dist/internal/session/keys.d.ts +3 -4
  388. package/dist/internal/session/keys.d.ts.map +1 -1
  389. package/dist/internal/session/keys.js.map +1 -1
  390. package/dist/internal/session/ratchet.d.ts +8 -8
  391. package/dist/internal/session/ratchet.js +10 -10
  392. package/dist/internal/session/ratchet.js.map +1 -1
  393. package/dist/internal/session/session-resolver.d.ts +6 -6
  394. package/dist/internal/session/session-resolver.js +6 -6
  395. package/dist/internal/session/state.d.ts +12 -12
  396. package/dist/internal/session/state.d.ts.map +1 -1
  397. package/dist/internal/session/state.js +7 -7
  398. package/dist/internal/session/types.d.ts +20 -20
  399. package/dist/internal/session/types.d.ts.map +1 -1
  400. package/dist/internal/session/types.js +3 -3
  401. package/dist/internal/session/validation.d.ts +1 -1
  402. package/dist/internal/session/validation.js +4 -4
  403. package/dist/internal/session/validation.js.map +1 -1
  404. package/dist/keys/branded.d.ts +12 -12
  405. package/dist/keys/branded.js +3 -3
  406. package/dist/keys/generation.d.ts +4 -4
  407. package/dist/keys/generation.js +4 -4
  408. package/dist/keys/identity.d.ts +7 -7
  409. package/dist/keys/identity.d.ts.map +1 -1
  410. package/dist/keys/identity.js +7 -7
  411. package/dist/keys/identity.js.map +1 -1
  412. package/dist/keys/types.d.ts +16 -16
  413. package/dist/keys/types.d.ts.map +1 -1
  414. package/dist/layers.d.ts +1 -1
  415. package/dist/layers.js +1 -1
  416. package/dist/local/store/expo/adapter.d.ts +8 -8
  417. package/dist/local/store/expo/adapter.js +10 -10
  418. package/dist/local/store/expo/adapter.js.map +1 -1
  419. package/dist/local/store/expo/database-key.d.ts +7 -7
  420. package/dist/local/store/expo/database-key.js +7 -7
  421. package/dist/local/store/expo/key-storage.d.ts +1 -1
  422. package/dist/local/store/expo/key-storage.js +4 -4
  423. package/dist/local/store/expo/key-storage.js.map +1 -1
  424. package/dist/local/store/expo/models/kyber-prekey-used.d.ts +6 -6
  425. package/dist/local/store/expo/models/kyber-prekey-used.js +3 -3
  426. package/dist/local/store/expo/models/kyber-prekey.d.ts +1 -1
  427. package/dist/local/store/expo/models/kyber-prekey.js +1 -1
  428. package/dist/local/store/expo/models/message-record.d.ts +2 -2
  429. package/dist/local/store/expo/models/message-record.d.ts.map +1 -1
  430. package/dist/local/store/expo/models/message-record.js +1 -1
  431. package/dist/local/store/expo/models/message-record.js.map +1 -1
  432. package/dist/local/store/expo/models/sender-key.d.ts +11 -10
  433. package/dist/local/store/expo/models/sender-key.d.ts.map +1 -1
  434. package/dist/local/store/expo/models/sender-key.js +11 -10
  435. package/dist/local/store/expo/models/sender-key.js.map +1 -1
  436. package/dist/local/store/expo/schema.d.ts +2 -2
  437. package/dist/local/store/expo/schema.js +2 -2
  438. package/dist/local/store/expo/secure-store-options.d.ts +1 -1
  439. package/dist/local/store/memory/adapter.d.ts +2 -2
  440. package/dist/local/store/memory/adapter.js +12 -12
  441. package/dist/local/store/memory/adapter.js.map +1 -1
  442. package/dist/local/store/node/adapter.d.ts.map +1 -1
  443. package/dist/local/store/node/adapter.js +5 -4
  444. package/dist/local/store/node/adapter.js.map +1 -1
  445. package/dist/local/store/node/database-key.d.ts +8 -8
  446. package/dist/local/store/node/database-key.js +10 -10
  447. package/dist/local/store/node/database-key.js.map +1 -1
  448. package/dist/local/store/node/database.d.ts +5 -5
  449. package/dist/local/store/node/database.js +11 -11
  450. package/dist/local/store/node/database.js.map +1 -1
  451. package/dist/local/store/react-native/adapter.d.ts +6 -6
  452. package/dist/local/store/react-native/adapter.d.ts.map +1 -1
  453. package/dist/local/store/react-native/adapter.js +35 -32
  454. package/dist/local/store/react-native/adapter.js.map +1 -1
  455. package/dist/local/store/react-native/backend-conformance.d.ts +11 -10
  456. package/dist/local/store/react-native/backend-conformance.d.ts.map +1 -1
  457. package/dist/local/store/react-native/backend-conformance.js +13 -12
  458. package/dist/local/store/react-native/backend-conformance.js.map +1 -1
  459. package/dist/local/store/react-native/index.d.ts +1 -1
  460. package/dist/local/store/react-native/reference-backend.d.ts +14 -13
  461. package/dist/local/store/react-native/reference-backend.d.ts.map +1 -1
  462. package/dist/local/store/react-native/reference-backend.js +15 -14
  463. package/dist/local/store/react-native/reference-backend.js.map +1 -1
  464. package/dist/local/store/react-native/storage.d.ts +3 -3
  465. package/dist/local/store/web/adapter.d.ts +3 -3
  466. package/dist/local/store/web/adapter.d.ts.map +1 -1
  467. package/dist/local/store/web/adapter.js +30 -31
  468. package/dist/local/store/web/adapter.js.map +1 -1
  469. package/dist/local/store/web/index.d.ts +1 -1
  470. package/dist/local/vault/index.d.ts +2 -2
  471. package/dist/media/index.d.ts +11 -11
  472. package/dist/media/index.js +9 -9
  473. package/dist/profile/contact-state.d.ts +1 -1
  474. package/dist/profile/contact-state.js +1 -1
  475. package/dist/profile/profile-key.d.ts +2 -2
  476. package/dist/profile/profile-key.js +7 -6
  477. package/dist/profile/profile-key.js.map +1 -1
  478. package/dist/remote/object-store/index.d.ts +1 -1
  479. package/dist/remote/object-store/s3/storage.d.ts +1 -1
  480. package/dist/remote/object-store/types.d.ts +4 -4
  481. package/dist/remote/object-store/types.d.ts.map +1 -1
  482. package/dist/remote/relay/convex/backend.d.ts +4 -4
  483. package/dist/remote/relay/convex/backend.js +3 -3
  484. package/dist/remote/relay/convex/backend.js.map +1 -1
  485. package/dist/remote/relay/convex/component/accounts.d.ts +15 -13
  486. package/dist/remote/relay/convex/component/accounts.d.ts.map +1 -1
  487. package/dist/remote/relay/convex/component/accounts.js +31 -28
  488. package/dist/remote/relay/convex/component/accounts.js.map +1 -1
  489. package/dist/remote/relay/convex/component/certificates.js +1 -1
  490. package/dist/remote/relay/convex/component/cleanup.js +7 -7
  491. package/dist/remote/relay/convex/component/cleanup.js.map +1 -1
  492. package/dist/remote/relay/convex/component/convex.config.d.ts.map +1 -1
  493. package/dist/remote/relay/convex/component/convex.config.js +10 -8
  494. package/dist/remote/relay/convex/component/convex.config.js.map +1 -1
  495. package/dist/remote/relay/convex/component/devices.d.ts +21 -20
  496. package/dist/remote/relay/convex/component/devices.d.ts.map +1 -1
  497. package/dist/remote/relay/convex/component/devices.js +24 -23
  498. package/dist/remote/relay/convex/component/devices.js.map +1 -1
  499. package/dist/remote/relay/convex/component/groups.js +6 -6
  500. package/dist/remote/relay/convex/component/groups.js.map +1 -1
  501. package/dist/remote/relay/convex/component/messages.d.ts.map +1 -1
  502. package/dist/remote/relay/convex/component/messages.js +89 -82
  503. package/dist/remote/relay/convex/component/messages.js.map +1 -1
  504. package/dist/remote/relay/convex/component/provisioning.d.ts +3 -3
  505. package/dist/remote/relay/convex/component/provisioning.d.ts.map +1 -1
  506. package/dist/remote/relay/convex/component/provisioning.js +17 -16
  507. package/dist/remote/relay/convex/component/provisioning.js.map +1 -1
  508. package/dist/remote/relay/convex/component/runtime.d.ts.map +1 -1
  509. package/dist/remote/relay/convex/component/runtime.js +4 -2
  510. package/dist/remote/relay/convex/component/runtime.js.map +1 -1
  511. package/dist/remote/relay/convex/component/schema.js +25 -24
  512. package/dist/remote/relay/convex/component/schema.js.map +1 -1
  513. package/dist/remote/relay/convex/group-server.d.ts +3 -3
  514. package/dist/remote/relay/convex/group-server.js +3 -3
  515. package/dist/remote/relay/convex/relay.d.ts +3 -3
  516. package/dist/remote/relay/convex/relay.d.ts.map +1 -1
  517. package/dist/remote/relay/convex/relay.js +18 -17
  518. package/dist/remote/relay/convex/relay.js.map +1 -1
  519. package/dist/remote/relay/convex/types.d.ts +7 -7
  520. package/dist/remote/relay/convex/types.js +4 -4
  521. package/dist/remote/relay/memory/adapter.js +9 -9
  522. package/dist/remote/relay/memory/adapter.js.map +1 -1
  523. package/dist/remote/relay/types.d.ts +27 -27
  524. package/dist/remote/relay/types.d.ts.map +1 -1
  525. package/dist/safety/fingerprint.d.ts +7 -6
  526. package/dist/safety/fingerprint.d.ts.map +1 -1
  527. package/dist/safety/fingerprint.js +5 -4
  528. package/dist/safety/fingerprint.js.map +1 -1
  529. package/dist/safety/index.d.ts +6 -5
  530. package/dist/safety/index.d.ts.map +1 -1
  531. package/dist/safety/index.js +7 -6
  532. package/dist/safety/index.js.map +1 -1
  533. package/dist/safety/protobuf.js +2 -2
  534. package/dist/safety/protobuf.js.map +1 -1
  535. package/dist/safety/url.d.ts +5 -5
  536. package/dist/safety/url.js +6 -6
  537. package/dist/types/address.d.ts +2 -2
  538. package/dist/types/address.js +2 -2
  539. package/dist/types/api.d.ts +78 -73
  540. package/dist/types/api.d.ts.map +1 -1
  541. package/dist/types/errors.d.ts +63 -403
  542. package/dist/types/errors.d.ts.map +1 -1
  543. package/dist/types/errors.js +62 -537
  544. package/dist/types/errors.js.map +1 -1
  545. package/dist/types/messages.d.ts +16 -16
  546. package/dist/types/messages.d.ts.map +1 -1
  547. package/dist/types/messages.js +7 -7
  548. package/dist/types/messages.js.map +1 -1
  549. package/dist/types/protocol-config.d.ts +52 -49
  550. package/dist/types/protocol-config.d.ts.map +1 -1
  551. package/dist/types/protocol-config.js +36 -34
  552. package/dist/types/protocol-config.js.map +1 -1
  553. package/dist/types/protocol-constants.d.ts +2 -2
  554. package/dist/types/protocol-constants.js +2 -2
  555. package/dist/types/session.d.ts +62 -61
  556. package/dist/types/session.d.ts.map +1 -1
  557. package/dist/types/session.js +13 -14
  558. package/dist/types/session.js.map +1 -1
  559. package/dist/types/trust.d.ts +8 -8
  560. package/dist/types/trust.js +3 -3
  561. package/dist/utils/retry.d.ts.map +1 -1
  562. package/dist/utils/retry.js +2 -4
  563. package/dist/utils/retry.js.map +1 -1
  564. package/docs/ASSURANCE.md +82 -74
  565. package/docs/CLIENT_COMPOSITION.md +19 -15
  566. package/docs/DEVIATIONS.md +507 -425
  567. package/docs/DOCUMENTATION_STANDARDS.md +24 -24
  568. package/docs/E2EE.md +45 -42
  569. package/docs/ERROR_HANDLING.md +29 -105
  570. package/docs/GETTING_STARTED.md +24 -25
  571. package/docs/INTERFACES.md +27 -18
  572. package/docs/PACKAGE_SURFACE.md +23 -21
  573. package/docs/PROTOCOL_POLICY.md +19 -13
  574. package/docs/RECIPES.md +4 -4
  575. package/docs/SECURITY.md +72 -60
  576. package/encoding/README.md +2 -2
  577. package/files/README.md +1 -1
  578. package/groups/README.md +4 -3
  579. package/hooks/README.md +2 -2
  580. package/keys/README.md +15 -14
  581. package/local/store/README.md +82 -67
  582. package/local/store/expo/README.md +17 -12
  583. package/local/store/memory/README.md +4 -3
  584. package/local/store/node/README.md +8 -6
  585. package/local/store/react-native/README.md +14 -12
  586. package/local/store/web/README.md +31 -26
  587. package/local/vault/README.md +4 -4
  588. package/media/README.md +6 -5
  589. package/package.json +1 -1
  590. package/profile/README.md +7 -7
  591. package/remote/README.md +20 -18
  592. package/remote/object-store/README.md +8 -4
  593. package/remote/object-store/convex-r2/README.md +3 -3
  594. package/remote/object-store/s3/README.md +10 -5
  595. package/remote/relay/convex/README.md +5 -5
  596. package/remote/relay/convex/component/README.md +145 -124
  597. package/remote/relay/memory/README.md +6 -5
  598. package/safety/README.md +1 -1
  599. package/sealed-sender/README.md +3 -2
  600. package/types/README.md +1 -1
  601. package/utils/README.md +4 -4
@@ -1 +1 @@
1
- {"version":3,"file":"keys.js","sourceRoot":"","sources":["../../../internal/session/keys.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AA0EH,+EAA+E;AAC/E,wBAAwB;AACxB,+EAA+E;AAE/E;;;;;GAKG;AACH,MAAM,UAAU,SAAS,CAAC,GAAW;IACnC,OAAO,GAAc,CAAC;AACxB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAC,GAAW;IACpC,OAAO,GAAe,CAAC;AACzB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,GAAW;IACtC,OAAO,GAAiB,CAAC;AAC3B,CAAC;AA+GD,+EAA+E;AAC/E,YAAY;AACZ,+EAA+E;AAE/E;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAEpC;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,KAAK,CAAC;AAEvC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC"}
1
+ {"version":3,"file":"keys.js","sourceRoot":"","sources":["../../../internal/session/keys.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AA0EH,+EAA+E;AAC/E,wBAAwB;AACxB,+EAA+E;AAE/E;;;;;GAKG;AACH,MAAM,UAAU,SAAS,CAAC,GAAW;IACnC,OAAO,GAAc,CAAC;AACxB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAC,GAAW;IACpC,OAAO,GAAe,CAAC;AACzB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,GAAW;IACtC,OAAO,GAAiB,CAAC;AAC3B,CAAC;AA8GD,+EAA+E;AAC/E,YAAY;AACZ,+EAA+E;AAE/E;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAEpC;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,KAAK,CAAC;AAEvC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC"}
@@ -20,7 +20,7 @@ import type { DoubleRatchetConfig } from '../protocol/double-ratchet/index.js';
20
20
  *
21
21
  * TypeScript structural typing: When SessionState has non-null DHs/DHr,
22
22
  * it satisfies the DoubleRatchetState interface because:
23
- * - SessionState.DHs: { publicKey: string; privateKey: string } matches RatchetKeyPair
23
+ * - SessionState.DHs: `{ publicKey: string; privateKey: string }` matches RatchetKeyPair
24
24
  * - SessionState.DHr: string matches Base64 (which is string)
25
25
  * - All other ratchet fields (RK, CKs, CKr, etc.) have identical types
26
26
  *
@@ -35,7 +35,7 @@ export type ValidatedSessionState = SessionState & {
35
35
  /**
36
36
  * Type guard that validates and narrows SessionState to ValidatedSessionState.
37
37
  *
38
- * After this check passes, the session can be passed directly to
38
+ * After this check passes, callers can pass the session directly to
39
39
  * DoubleRatchetState-accepting functions via TypeScript's structural typing.
40
40
  *
41
41
  * @param session SessionState to validate
@@ -43,14 +43,14 @@ export type ValidatedSessionState = SessionState & {
43
43
  */
44
44
  export declare function isValidatedSession(session: SessionState): session is ValidatedSessionState;
45
45
  /**
46
- * Assert that session is validated for encryption, throwing descriptive error if not.
46
+ * Assert that the session is valid for encryption, and throw a descriptive error if not.
47
47
  *
48
48
  * For encryption, the session must be fully initialized:
49
- * - DHs, DHr must be set (DH ratchet keys)
50
- * - CKs must be set (sending chain key for deriving message keys)
49
+ * - DHs, DHr must hold values (DH ratchet keys)
50
+ * - CKs must hold a value (sending chain key for deriving message keys)
51
51
  *
52
52
  * For lazy-initialized responder sessions, encrypt should fail until
53
- * the first message has been received and decrypted (which triggers
53
+ * the session receives and decrypts the first message (which triggers
54
54
  * DHRatchet and sets all required keys).
55
55
  *
56
56
  * @param session SessionState to validate
@@ -59,7 +59,7 @@ export declare function isValidatedSession(session: SessionState): session is Va
59
59
  */
60
60
  export declare function assertValidatedSession(session: SessionState, operation: string): asserts session is ValidatedSessionState;
61
61
  /**
62
- * Perform DH ratchet step (purely classical EC).
62
+ * Run the DH ratchet step (purely classical EC).
63
63
  *
64
64
  * The DH ratchet has no interaction with PQ/SPQR state. All post-quantum work
65
65
  * happens in `spqrSend()` and `spqrRecv()`.
@@ -88,7 +88,7 @@ export declare function storeSkippedMessageKeys(session: SessionState, untilCoun
88
88
  /**
89
89
  * Clean up expired message keys from MKSKIPPED dictionary
90
90
  *
91
- * Design: For cleanup, we only need a validated session if we're going to
91
+ * Design: For cleanup, we only need a validated session if we are going to
92
92
  * run cleanup. If session is not validated, we silently skip (nothing to clean).
93
93
  *
94
94
  * Signal Protocol Section 8.4
@@ -19,7 +19,7 @@ import { performDHRatchetStep as moduleDHRatchetStep, storeSkippedKeys as module
19
19
  /**
20
20
  * Type guard that validates and narrows SessionState to ValidatedSessionState.
21
21
  *
22
- * After this check passes, the session can be passed directly to
22
+ * After this check passes, callers can pass the session directly to
23
23
  * DoubleRatchetState-accepting functions via TypeScript's structural typing.
24
24
  *
25
25
  * @param session SessionState to validate
@@ -30,14 +30,14 @@ export function isValidatedSession(session) {
30
30
  return session.DHs != null && session.DHr != null;
31
31
  }
32
32
  /**
33
- * Assert that session is validated for encryption, throwing descriptive error if not.
33
+ * Assert that the session is valid for encryption, and throw a descriptive error if not.
34
34
  *
35
35
  * For encryption, the session must be fully initialized:
36
- * - DHs, DHr must be set (DH ratchet keys)
37
- * - CKs must be set (sending chain key for deriving message keys)
36
+ * - DHs, DHr must hold values (DH ratchet keys)
37
+ * - CKs must hold a value (sending chain key for deriving message keys)
38
38
  *
39
39
  * For lazy-initialized responder sessions, encrypt should fail until
40
- * the first message has been received and decrypted (which triggers
40
+ * the session receives and decrypts the first message (which triggers
41
41
  * DHRatchet and sets all required keys).
42
42
  *
43
43
  * @param session SessionState to validate
@@ -59,7 +59,7 @@ export function assertValidatedSession(session, operation) {
59
59
  // DH Ratchet
60
60
  // ============================================================================
61
61
  /**
62
- * Perform DH ratchet step (purely classical EC).
62
+ * Run the DH ratchet step (purely classical EC).
63
63
  *
64
64
  * The DH ratchet has no interaction with PQ/SPQR state. All post-quantum work
65
65
  * happens in `spqrSend()` and `spqrRecv()`.
@@ -91,9 +91,9 @@ export async function performDHRatchetStep(session, receivedDHPublicKey, logger
91
91
  },
92
92
  });
93
93
  }
94
- // For lazy init, we need to create a temporary state with DHr set
95
- // so it satisfies DoubleRatchetState interface
96
- // The module will update DHr anyway, but we need valid types
94
+ // For lazy init, we need to create a temporary state with DHr set,
95
+ // so it satisfies the DoubleRatchetState interface.
96
+ // The module will update DHr anyway, but we need valid types.
97
97
  const stateForRatchet = session;
98
98
  // Pass session directly - mutations happen in place
99
99
  await moduleDHRatchetStep(stateForRatchet, receivedDHPublicKey, logger);
@@ -144,7 +144,7 @@ export async function storeSkippedMessageKeys(session, untilCounter, config = DE
144
144
  /**
145
145
  * Clean up expired message keys from MKSKIPPED dictionary
146
146
  *
147
- * Design: For cleanup, we only need a validated session if we're going to
147
+ * Design: For cleanup, we only need a validated session if we are going to
148
148
  * run cleanup. If session is not validated, we silently skip (nothing to clean).
149
149
  *
150
150
  * Signal Protocol Section 8.4
@@ -1 +1 @@
1
- {"version":3,"file":"ratchet.js","sourceRoot":"","sources":["../../../internal/session/ratchet.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAAE,2BAA2B,EAAgB,MAAM,cAAc,CAAC;AAEzE,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AACnE,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAGpE,OAAO,EACL,oBAAoB,IAAI,mBAAmB,EAC3C,gBAAgB,IAAI,sBAAsB,EAC1C,kBAAkB,IAAI,wBAAwB,GAC/C,MAAM,4BAA4B,CAAC;AA0BpC;;;;;;;;GAQG;AACH,MAAM,UAAU,kBAAkB,CAAC,OAAqB;IACtD,yFAAyF;IACzF,OAAO,OAAO,CAAC,GAAG,IAAI,IAAI,IAAI,OAAO,CAAC,GAAG,IAAI,IAAI,CAAC;AACpD,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,sBAAsB,CACpC,OAAqB,EACrB,SAAiB;IAEjB,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;QACjB,MAAM,IAAI,eAAe,CACvB,UAAU,SAAS,yCAAyC,EAC5D,mBAAmB,CAAC,iBAAiB,CACtC,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;QACjB,MAAM,IAAI,eAAe,CACvB,UAAU,SAAS,uEAAuE,EAC1F,mBAAmB,CAAC,iBAAiB,CACtC,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;QACjB,MAAM,IAAI,eAAe,CACvB,UAAU,SAAS,uEAAuE,EAC1F,mBAAmB,CAAC,iBAAiB,CACtC,CAAC;IACJ,CAAC;AACH,CAAC;AAED,+EAA+E;AAC/E,aAAa;AACb,+EAA+E;AAE/E;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,OAAqB,EACrB,mBAA2B,EAC3B,MAAM,GAAsB,2BAA2B;IAEvD,wEAAwE;IACxE,4EAA4E;IAC5E,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,KAAK,SAAS,CAAC;IAE7C,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;QACjB,MAAM,IAAI,eAAe,CACvB,kEAAkE,EAClE,mBAAmB,CAAC,iBAAiB,CACtC,CAAC;IACJ,CAAC;IAED,IAAI,UAAU,EAAE,CAAC;QACf,MAAM,CAAC,KAAK,CAAC,wDAAwD,EAAE;YACrE,QAAQ,EAAE,MAAM;YAChB,IAAI,EAAE;gBACJ,SAAS,EAAE,sBAAsB;gBACjC,kBAAkB,EAAE,mBAAmB,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC;aACzD;SACF,CAAC,CAAC;IACL,CAAC;IAED,kEAAkE;IAClE,+CAA+C;IAC/C,6DAA6D;IAC7D,MAAM,eAAe,GAAG,OAAwC,CAAC;IAEjE,oDAAoD;IACpD,MAAM,mBAAmB,CAAC,eAAe,EAAE,mBAAmB,EAAE,MAAM,CAAC,CAAC;IAExE,iDAAiD;IACjD,6EAA6E;IAC7E,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;QACjD,MAAM,IAAI,eAAe,CACvB,8CAA8C,EAC9C,mBAAmB,CAAC,iBAAiB,EACrC;YACE,SAAS,EAAE,sBAAsB;YACjC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG;YACrB,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG;YACrB,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG;SACtB,CACF,CAAC;IACJ,CAAC;AACH,CAAC;AAED,+EAA+E;AAC/E,sBAAsB;AACtB,+EAA+E;AAE/E;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC3C,OAAqB,EACrB,YAAoB,EACpB,MAAM,GAAwB,sBAAsB,EACpD,MAAM,GAAsB,2BAA2B;IAEvD,gEAAgE;IAChE,sBAAsB,CAAC,OAAO,EAAE,4BAA4B,CAAC,CAAC;IAE9D,IAAI,CAAC;QACH,oDAAoD;QACpD,MAAM,sBAAsB,CAC1B,OAA6B,EAC7B,YAAY,EACZ;YACE,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;YAC7C,oBAAoB,EAAE,MAAM,CAAC,oBAAoB;YACjD,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;YACzC,oBAAoB,EAAE,MAAM,CAAC,oBAAoB;SAClD,EACD,MAAM,CACP,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,2BAA2B,CAAC,EAAE,CAAC;YAClF,MAAM,IAAI,eAAe,CAAC,KAAK,CAAC,OAAO,EAAE,mBAAmB,CAAC,yBAAyB,CAAC,CAAC;QAC1F,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED,+EAA+E;AAC/E,UAAU;AACV,+EAA+E;AAE/E;;;;;;;GAOG;AACH,MAAM,UAAU,yBAAyB,CACvC,OAAqB,EACrB,MAAM,GAAwB,sBAAsB,EACpD,MAAM,GAAsB,2BAA2B;IAEvD,2DAA2D;IAC3D,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC;QACjC,OAAO;IACT,CAAC;IAED,iEAAiE;IACjE,wBAAwB,CACtB,OAA6B,EAC7B;QACE,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;QAC7C,oBAAoB,EAAE,MAAM,CAAC,oBAAoB;QACjD,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;QACzC,oBAAoB,EAAE,MAAM,CAAC,oBAAoB;KAClD,EACD,MAAM,CACP,CAAC;IAEF,4EAA4E;IAC5E,6BAA6B,CAAC,OAAO,CAAC,CAAC;AACzC,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,6BAA6B,CAAC,OAAqB;IAC1D,IAAI,CAAC,OAAO,CAAC,eAAe;QAAE,OAAO;IACrC,MAAM,MAAM,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,SAAS;IACjD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACvB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,CAAC;QACvD,IAAI,GAAG,GAAG,OAAO,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,SAAS,GAAG,MAAM,EAAE,CAAC;YAC1D,OAAO,OAAO,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;QACtC,CAAC;IACH,CAAC;AACH,CAAC"}
1
+ {"version":3,"file":"ratchet.js","sourceRoot":"","sources":["../../../internal/session/ratchet.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAAE,2BAA2B,EAAgB,MAAM,cAAc,CAAC;AAEzE,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AACnE,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAGpE,OAAO,EACL,oBAAoB,IAAI,mBAAmB,EAC3C,gBAAgB,IAAI,sBAAsB,EAC1C,kBAAkB,IAAI,wBAAwB,GAC/C,MAAM,4BAA4B,CAAC;AA0BpC;;;;;;;;GAQG;AACH,MAAM,UAAU,kBAAkB,CAAC,OAAqB;IACtD,yFAAyF;IACzF,OAAO,OAAO,CAAC,GAAG,IAAI,IAAI,IAAI,OAAO,CAAC,GAAG,IAAI,IAAI,CAAC;AACpD,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,sBAAsB,CACpC,OAAqB,EACrB,SAAiB;IAEjB,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;QACjB,MAAM,IAAI,eAAe,CACvB,UAAU,SAAS,yCAAyC,EAC5D,mBAAmB,CAAC,iBAAiB,CACtC,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;QACjB,MAAM,IAAI,eAAe,CACvB,UAAU,SAAS,uEAAuE,EAC1F,mBAAmB,CAAC,iBAAiB,CACtC,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;QACjB,MAAM,IAAI,eAAe,CACvB,UAAU,SAAS,uEAAuE,EAC1F,mBAAmB,CAAC,iBAAiB,CACtC,CAAC;IACJ,CAAC;AACH,CAAC;AAED,+EAA+E;AAC/E,aAAa;AACb,+EAA+E;AAE/E;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,OAAqB,EACrB,mBAA2B,EAC3B,MAAM,GAAsB,2BAA2B;IAEvD,wEAAwE;IACxE,4EAA4E;IAC5E,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,KAAK,SAAS,CAAC;IAE7C,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;QACjB,MAAM,IAAI,eAAe,CACvB,kEAAkE,EAClE,mBAAmB,CAAC,iBAAiB,CACtC,CAAC;IACJ,CAAC;IAED,IAAI,UAAU,EAAE,CAAC;QACf,MAAM,CAAC,KAAK,CAAC,wDAAwD,EAAE;YACrE,QAAQ,EAAE,MAAM;YAChB,IAAI,EAAE;gBACJ,SAAS,EAAE,sBAAsB;gBACjC,kBAAkB,EAAE,mBAAmB,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC;aACzD;SACF,CAAC,CAAC;IACL,CAAC;IAED,mEAAmE;IACnE,oDAAoD;IACpD,8DAA8D;IAC9D,MAAM,eAAe,GAAG,OAAwC,CAAC;IAEjE,oDAAoD;IACpD,MAAM,mBAAmB,CAAC,eAAe,EAAE,mBAAmB,EAAE,MAAM,CAAC,CAAC;IAExE,iDAAiD;IACjD,6EAA6E;IAC7E,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;QACjD,MAAM,IAAI,eAAe,CACvB,8CAA8C,EAC9C,mBAAmB,CAAC,iBAAiB,EACrC;YACE,SAAS,EAAE,sBAAsB;YACjC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG;YACrB,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG;YACrB,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG;SACtB,CACF,CAAC;IACJ,CAAC;AACH,CAAC;AAED,+EAA+E;AAC/E,sBAAsB;AACtB,+EAA+E;AAE/E;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC3C,OAAqB,EACrB,YAAoB,EACpB,MAAM,GAAwB,sBAAsB,EACpD,MAAM,GAAsB,2BAA2B;IAEvD,gEAAgE;IAChE,sBAAsB,CAAC,OAAO,EAAE,4BAA4B,CAAC,CAAC;IAE9D,IAAI,CAAC;QACH,oDAAoD;QACpD,MAAM,sBAAsB,CAC1B,OAA6B,EAC7B,YAAY,EACZ;YACE,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;YAC7C,oBAAoB,EAAE,MAAM,CAAC,oBAAoB;YACjD,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;YACzC,oBAAoB,EAAE,MAAM,CAAC,oBAAoB;SAClD,EACD,MAAM,CACP,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,2BAA2B,CAAC,EAAE,CAAC;YAClF,MAAM,IAAI,eAAe,CAAC,KAAK,CAAC,OAAO,EAAE,mBAAmB,CAAC,yBAAyB,CAAC,CAAC;QAC1F,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED,+EAA+E;AAC/E,UAAU;AACV,+EAA+E;AAE/E;;;;;;;GAOG;AACH,MAAM,UAAU,yBAAyB,CACvC,OAAqB,EACrB,MAAM,GAAwB,sBAAsB,EACpD,MAAM,GAAsB,2BAA2B;IAEvD,2DAA2D;IAC3D,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC;QACjC,OAAO;IACT,CAAC;IAED,iEAAiE;IACjE,wBAAwB,CACtB,OAA6B,EAC7B;QACE,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;QAC7C,oBAAoB,EAAE,MAAM,CAAC,oBAAoB;QACjD,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;QACzC,oBAAoB,EAAE,MAAM,CAAC,oBAAoB;KAClD,EACD,MAAM,CACP,CAAC;IAEF,4EAA4E;IAC5E,6BAA6B,CAAC,OAAO,CAAC,CAAC;AACzC,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,6BAA6B,CAAC,OAAqB;IAC1D,IAAI,CAAC,OAAO,CAAC,eAAe;QAAE,OAAO;IACrC,MAAM,MAAM,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,SAAS;IACjD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACvB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,CAAC;QACvD,IAAI,GAAG,GAAG,OAAO,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,SAAS,GAAG,MAAM,EAAE,CAAC;YAC1D,OAAO,OAAO,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;QACtC,CAAC;IACH,CAAC;AACH,CAAC"}
@@ -38,14 +38,14 @@ export interface DecryptionCandidate {
38
38
  *
39
39
  * **insertSession**: When establishing a new session, the current session
40
40
  * is archived and the new session becomes active. This handles the case
41
- * where we initiate a session while the other party also initiates one.
41
+ * where we start a session while the other party also starts one.
42
42
  *
43
43
  * **findDecryptingSessions**: Returns an ordered list of sessions to try
44
44
  * for decryption. Current session is tried first, then archived sessions.
45
45
  *
46
46
  * **promoteSession**: When we successfully decrypt on an archived session,
47
47
  * that session becomes the new active session (session convergence).
48
- * This ensures both parties eventually converge to the same session.
48
+ * Both parties therefore converge to the same session.
49
49
  *
50
50
  * **archiveCurrentSession**: Moves the current session to archived without
51
51
  * replacing it. Used when handling retry requests.
@@ -78,7 +78,7 @@ export declare class SessionResolver {
78
78
  * Insert a new session, archiving the current one if present.
79
79
  *
80
80
  * This is called when establishing a new session via X3DH/PQXDH.
81
- * If there's an existing session, it's moved to the archived list
81
+ * If there is an existing session, it is moved to the archived list
82
82
  * to handle race conditions (both parties initiating simultaneously).
83
83
  *
84
84
  * @param sessionRecord - Current SessionRecord (or null for first session)
@@ -97,7 +97,7 @@ export declare class SessionResolver {
97
97
  *
98
98
  * Note: Archived sessions are returned in object iteration order, which
99
99
  * is insertion order in modern JS engines. Ideally they would be sorted
100
- * by recency, but archived sessions don't have individual timestamps.
100
+ * by recency, but archived sessions do not have individual timestamps.
101
101
  * In practice, this is acceptable because:
102
102
  * 1. The current session handles 99%+ of decryptions
103
103
  * 2. Archived sessions are only tried for race condition edge cases
@@ -112,7 +112,7 @@ export declare class SessionResolver {
112
112
  *
113
113
  * When we successfully decrypt a message using an archived session,
114
114
  * that session should become the new active session. This is the
115
- * SESAME "convergence" mechanism that ensures both parties end up
115
+ * SESAME "convergence" mechanism that leaves both parties
116
116
  * using the same session.
117
117
  *
118
118
  * The current session is moved to archived, and the specified
@@ -127,7 +127,7 @@ export declare class SessionResolver {
127
127
  * Archive the current session without replacing it.
128
128
  *
129
129
  * Used when handling retry requests - the sender archives their
130
- * current session so they'll create a new one on the next send.
130
+ * current session so they will create a new one on the next send.
131
131
  *
132
132
  * @param sessionRecord - The SessionRecord to update
133
133
  * @param maxArchived - Maximum archived sessions to retain
@@ -22,14 +22,14 @@ import { CURRENT_SESSION_RECORD_VERSION, SessionRecord as SessionRecordNS, } fro
22
22
  *
23
23
  * **insertSession**: When establishing a new session, the current session
24
24
  * is archived and the new session becomes active. This handles the case
25
- * where we initiate a session while the other party also initiates one.
25
+ * where we start a session while the other party also starts one.
26
26
  *
27
27
  * **findDecryptingSessions**: Returns an ordered list of sessions to try
28
28
  * for decryption. Current session is tried first, then archived sessions.
29
29
  *
30
30
  * **promoteSession**: When we successfully decrypt on an archived session,
31
31
  * that session becomes the new active session (session convergence).
32
- * This ensures both parties eventually converge to the same session.
32
+ * Both parties therefore converge to the same session.
33
33
  *
34
34
  * **archiveCurrentSession**: Moves the current session to archived without
35
35
  * replacing it. Used when handling retry requests.
@@ -62,7 +62,7 @@ export class SessionResolver {
62
62
  * Insert a new session, archiving the current one if present.
63
63
  *
64
64
  * This is called when establishing a new session via X3DH/PQXDH.
65
- * If there's an existing session, it's moved to the archived list
65
+ * If there is an existing session, it is moved to the archived list
66
66
  * to handle race conditions (both parties initiating simultaneously).
67
67
  *
68
68
  * @param sessionRecord - Current SessionRecord (or null for first session)
@@ -107,7 +107,7 @@ export class SessionResolver {
107
107
  *
108
108
  * Note: Archived sessions are returned in object iteration order, which
109
109
  * is insertion order in modern JS engines. Ideally they would be sorted
110
- * by recency, but archived sessions don't have individual timestamps.
110
+ * by recency, but archived sessions do not have individual timestamps.
111
111
  * In practice, this is acceptable because:
112
112
  * 1. The current session handles 99%+ of decryptions
113
113
  * 2. Archived sessions are only tried for race condition edge cases
@@ -146,7 +146,7 @@ export class SessionResolver {
146
146
  *
147
147
  * When we successfully decrypt a message using an archived session,
148
148
  * that session should become the new active session. This is the
149
- * SESAME "convergence" mechanism that ensures both parties end up
149
+ * SESAME "convergence" mechanism that leaves both parties
150
150
  * using the same session.
151
151
  *
152
152
  * The current session is moved to archived, and the specified
@@ -177,7 +177,7 @@ export class SessionResolver {
177
177
  * Archive the current session without replacing it.
178
178
  *
179
179
  * Used when handling retry requests - the sender archives their
180
- * current session so they'll create a new one on the next send.
180
+ * current session so they will create a new one on the next send.
181
181
  *
182
182
  * @param sessionRecord - The SessionRecord to update
183
183
  * @param maxArchived - Maximum archived sessions to retain
@@ -70,7 +70,7 @@ interface SessionMetadataBase {
70
70
  /**
71
71
  * Uninitialized session state.
72
72
  *
73
- * Session has been created but no key exchange has started.
73
+ * The session exists, and no key exchange started yet.
74
74
  * Only valid operation: initialize()
75
75
  */
76
76
  export interface UninitializedSession extends SessionMetadataBase {
@@ -142,7 +142,7 @@ export interface ActiveSession extends SessionMetadataBase {
142
142
  /** Last activity timestamp */
143
143
  lastUsedAt: number;
144
144
  /**
145
- * Whether we've received at least one message in this session.
145
+ * Whether we received at least one message in this session.
146
146
  *
147
147
  * Unacknowledged PreKey sessions expire after 30 days
148
148
  * (MAX_UNACKNOWLEDGED_SESSION_AGE).
@@ -154,7 +154,7 @@ export interface ActiveSession extends SessionMetadataBase {
154
154
  /**
155
155
  * Rekeying session state.
156
156
  *
157
- * Session is undergoing key rotation.
157
+ * The session rotates its keys.
158
158
  * Limited operations until rotation completes.
159
159
  *
160
160
  * Note: Uses Section 3 variant (plaintext headers + MAC authentication).
@@ -164,7 +164,7 @@ export interface ActiveSession extends SessionMetadataBase {
164
164
  */
165
165
  export interface RekeyingSession extends Omit<ActiveSession, 'phase'> {
166
166
  phase: 'rekeying';
167
- /** Old keys being phased out */
167
+ /** Old keys that the session phases out */
168
168
  previousDHr?: PublicKey;
169
169
  previousCKr?: ChainKey;
170
170
  /** Rekey initiated timestamp */
@@ -173,7 +173,7 @@ export interface RekeyingSession extends Omit<ActiveSession, 'phase'> {
173
173
  /**
174
174
  * Expired session state.
175
175
  *
176
- * Session has timed out or been explicitly closed.
176
+ * The session timed out, or the caller closed it explicitly.
177
177
  * No operations allowed except archive/delete.
178
178
  *
179
179
  * Valid operations: archive(), delete()
@@ -210,7 +210,7 @@ export declare function isActive(state: TypedSessionState): state is ActiveSessi
210
210
  */
211
211
  export declare function isRekeying(state: TypedSessionState): state is RekeyingSession;
212
212
  /**
213
- * Check if session is expired.
213
+ * Check whether the session expired.
214
214
  */
215
215
  export declare function isExpired(state: TypedSessionState): state is ExpiredSession;
216
216
  /**
@@ -226,9 +226,9 @@ export declare function canEncrypt(state: TypedSessionState): state is ActiveSes
226
226
  */
227
227
  export declare function canDecrypt(state: TypedSessionState): state is ActiveSession | RekeyingSession;
228
228
  /**
229
- * Check if session is established (can communicate).
229
+ * Check whether the session can communicate.
230
230
  *
231
- * Active and rekeying sessions are established.
231
+ * Active and rekeying sessions can communicate.
232
232
  */
233
233
  export declare function isEstablished(state: TypedSessionState): state is ActiveSession | RekeyingSession;
234
234
  /**
@@ -236,7 +236,7 @@ export declare function isEstablished(state: TypedSessionState): state is Active
236
236
  */
237
237
  export declare function needsInitialization(state: TypedSessionState): state is UninitializedSession;
238
238
  /**
239
- * Check if session is waiting for first message.
239
+ * Check whether the session waits for the first message.
240
240
  */
241
241
  export declare function awaitingFirstMessage(state: TypedSessionState): state is PendingSession;
242
242
  /**
@@ -264,15 +264,15 @@ export declare const DEFAULT_SESSION_TIMEOUT_MS: number;
264
264
  /**
265
265
  * Rekey timeout (5 minutes in milliseconds).
266
266
  *
267
- * If rekey doesn't complete within this time, session should error.
267
+ * If rekey does not complete within this time, session should error.
268
268
  */
269
269
  export declare const REKEY_TIMEOUT_MS: number;
270
270
  /**
271
- * Check if session has timed out.
271
+ * Check whether the session timed out.
272
272
  *
273
273
  * @param state - Session state
274
274
  * @param timeout - Timeout duration in ms (default: 30 days)
275
- * @returns true if session has exceeded timeout
275
+ * @returns true if the session exceeded the timeout
276
276
  */
277
277
  export declare function hasTimedOut(state: TypedSessionState, timeout?: number): boolean;
278
278
  //# sourceMappingURL=state.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"state.d.ts","sourceRoot":"","sources":["../../../internal/session/state.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,KAAK,EAAE,mBAAmB,EAAE,eAAe,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAC9F,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAChD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAMzD;;;;;GAKG;AACH,OAAO,EAAE,CAAC;AACV,MAAM,MAAM,YAAY,GACpB,eAAe,GACf,SAAS,GACT,QAAQ,GACR,UAAU,GACV,SAAS,CAAC;AAMd;;GAEG;AACH,UAAU,mBAAmB;IAC3B,gCAAgC;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,kBAAkB;IAClB,YAAY,EAAE,eAAe,CAAC;IAC9B,6BAA6B;IAC7B,aAAa,EAAE,eAAe,CAAC;IAC/B,4BAA4B;IAC5B,eAAe,EAAE,eAAe,CAAC;IACjC,yDAAyD;IACzD,aAAa,EAAE,mBAAmB,CAAC;IACnC,cAAc,EAAE,mBAAmB,CAAC;IACpC,iCAAiC;IACjC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,oBAAqB,SAAQ,mBAAmB;IAC/D,KAAK,EAAE,eAAe,CAAC;CACxB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,cAAe,SAAQ,mBAAmB;IACzD,KAAK,EAAE,SAAS,CAAC;IACjB,iCAAiC;IACjC,EAAE,EAAE,OAAO,CAAC;IACZ,gDAAgD;IAChD,gBAAgB,CAAC,EAAE;QAAE,SAAS,EAAE,SAAS,CAAC;QAAC,UAAU,EAAE,UAAU,CAAA;KAAE,CAAC;IACpE,iEAAiE;IACjE,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,uFAAuF;IACvF,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,wFAAwF;IACxF,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,uCAAuC;IACvC,WAAW,EAAE,OAAO,CAAC;CACtB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,aAAc,SAAQ,mBAAmB;IACxD,KAAK,EAAE,QAAQ,CAAC;IAChB,eAAe;IACf,EAAE,EAAE,OAAO,CAAC;IACZ,8BAA8B;IAC9B,GAAG,EAAE;QAAE,SAAS,EAAE,SAAS,CAAC;QAAC,UAAU,EAAE,UAAU,CAAA;KAAE,CAAC;IACtD,2CAA2C;IAC3C,GAAG,EAAE,SAAS,CAAC;IACf,wBAAwB;IACxB,GAAG,EAAE,QAAQ,CAAC;IACd,0BAA0B;IAC1B,GAAG,EAAE,QAAQ,CAAC;IACd,6CAA6C;IAC7C,EAAE,EAAE,MAAM,CAAC;IACX,mDAAmD;IACnD,EAAE,EAAE,MAAM,CAAC;IACX,4BAA4B;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,gDAAgD;IAChD,cAAc,EAAE,aAAa,EAAE,CAAC;IAChC,8BAA8B;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB;;;;;;;OAOG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,eAAgB,SAAQ,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC;IACnE,KAAK,EAAE,UAAU,CAAC;IAClB,gCAAgC;IAChC,WAAW,CAAC,EAAE,SAAS,CAAC;IACxB,WAAW,CAAC,EAAE,QAAQ,CAAC;IACvB,gCAAgC;IAChC,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,cAAe,SAAQ,mBAAmB;IACzD,KAAK,EAAE,SAAS,CAAC;IACjB,2BAA2B;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,4BAA4B;IAC5B,gBAAgB,EAAE,SAAS,GAAG,gBAAgB,GAAG,OAAO,GAAG,YAAY,CAAC;IACxE,mDAAmD;IACnD,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GACzB,oBAAoB,GACpB,cAAc,GACd,aAAa,GACb,eAAe,GACf,cAAc,CAAC;AAMnB;;GAEG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK,IAAI,oBAAoB,CAEvF;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK,IAAI,cAAc,CAE3E;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK,IAAI,aAAa,CAEzE;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK,IAAI,eAAe,CAE7E;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK,IAAI,cAAc,CAE3E;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK,IAAI,aAAa,CAE3E;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK,IAAI,aAAa,GAAG,eAAe,CAE7F;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK,IAAI,aAAa,GAAG,eAAe,CAEhG;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK,IAAI,oBAAoB,CAE3F;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK,IAAI,cAAc,CAEtF;AAMD;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,YAAY,EAAE,YAAY,EAAE,CAMlE,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,YAAY,EAAE,EAAE,EAAE,YAAY,GAAG,OAAO,CAE/E;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,iBAAiB,GAAG,YAAY,CAE/D;AAMD;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,QAA2B,CAAC;AAEnE;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,QAAgB,CAAC;AAE9C;;;;;;GAMG;AACH,wBAAgB,WAAW,CACzB,KAAK,EAAE,iBAAiB,EACxB,OAAO,GAAE,MAAmC,GAC3C,OAAO,CAMT"}
1
+ {"version":3,"file":"state.d.ts","sourceRoot":"","sources":["../../../internal/session/state.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,KAAK,EAAE,mBAAmB,EAAE,eAAe,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAC9F,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAChD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAMzD;;;;;GAKG;AACH,OAAO,EAAE,CAAC;AACV,MAAM,MAAM,YAAY,GACpB,eAAe,GACf,SAAS,GACT,QAAQ,GACR,UAAU,GACV,SAAS,CAAC;AAMd;;GAEG;AACH,UAAU,mBAAmB;IAC3B,gCAAgC;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,kBAAkB;IAClB,YAAY,EAAE,eAAe,CAAC;IAC9B,6BAA6B;IAC7B,aAAa,EAAE,eAAe,CAAC;IAC/B,4BAA4B;IAC5B,eAAe,EAAE,eAAe,CAAC;IACjC,yDAAyD;IACzD,aAAa,EAAE,mBAAmB,CAAC;IACnC,cAAc,EAAE,mBAAmB,CAAC;IACpC,iCAAiC;IACjC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,oBAAqB,SAAQ,mBAAmB;IAC/D,KAAK,EAAE,eAAe,CAAC;CACxB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,cAAe,SAAQ,mBAAmB;IACzD,KAAK,EAAE,SAAS,CAAC;IACjB,iCAAiC;IACjC,EAAE,EAAE,OAAO,CAAC;IACZ,gDAAgD;IAChD,gBAAgB,CAAC,EAAE;QAAE,SAAS,EAAE,SAAS,CAAC;QAAC,UAAU,EAAE,UAAU,CAAA;KAAE,CAAC;IACpE,iEAAiE;IACjE,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,uFAAuF;IACvF,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,wFAAwF;IACxF,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,uCAAuC;IACvC,WAAW,EAAE,OAAO,CAAC;CACtB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,aAAc,SAAQ,mBAAmB;IACxD,KAAK,EAAE,QAAQ,CAAC;IAChB,eAAe;IACf,EAAE,EAAE,OAAO,CAAC;IACZ,8BAA8B;IAC9B,GAAG,EAAE;QAAE,SAAS,EAAE,SAAS,CAAC;QAAC,UAAU,EAAE,UAAU,CAAA;KAAE,CAAC;IACtD,2CAA2C;IAC3C,GAAG,EAAE,SAAS,CAAC;IACf,wBAAwB;IACxB,GAAG,EAAE,QAAQ,CAAC;IACd,0BAA0B;IAC1B,GAAG,EAAE,QAAQ,CAAC;IACd,6CAA6C;IAC7C,EAAE,EAAE,MAAM,CAAC;IACX,mDAAmD;IACnD,EAAE,EAAE,MAAM,CAAC;IACX,4BAA4B;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,gDAAgD;IAChD,cAAc,EAAE,aAAa,EAAE,CAAC;IAChC,8BAA8B;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB;;;;;;;OAOG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,eAAgB,SAAQ,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC;IACnE,KAAK,EAAE,UAAU,CAAC;IAClB,2CAA2C;IAC3C,WAAW,CAAC,EAAE,SAAS,CAAC;IACxB,WAAW,CAAC,EAAE,QAAQ,CAAC;IACvB,gCAAgC;IAChC,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,cAAe,SAAQ,mBAAmB;IACzD,KAAK,EAAE,SAAS,CAAC;IACjB,2BAA2B;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,4BAA4B;IAC5B,gBAAgB,EAAE,SAAS,GAAG,gBAAgB,GAAG,OAAO,GAAG,YAAY,CAAC;IACxE,mDAAmD;IACnD,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GACzB,oBAAoB,GACpB,cAAc,GACd,aAAa,GACb,eAAe,GACf,cAAc,CAAC;AAMnB;;GAEG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK,IAAI,oBAAoB,CAEvF;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK,IAAI,cAAc,CAE3E;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK,IAAI,aAAa,CAEzE;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK,IAAI,eAAe,CAE7E;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK,IAAI,cAAc,CAE3E;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK,IAAI,aAAa,CAE3E;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK,IAAI,aAAa,GAAG,eAAe,CAE7F;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK,IAAI,aAAa,GAAG,eAAe,CAEhG;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK,IAAI,oBAAoB,CAE3F;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK,IAAI,cAAc,CAEtF;AAMD;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,YAAY,EAAE,YAAY,EAAE,CAMlE,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,YAAY,EAAE,EAAE,EAAE,YAAY,GAAG,OAAO,CAE/E;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,iBAAiB,GAAG,YAAY,CAE/D;AAMD;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,QAA2B,CAAC;AAEnE;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,QAAgB,CAAC;AAE9C;;;;;;GAMG;AACH,wBAAgB,WAAW,CACzB,KAAK,EAAE,iBAAiB,EACxB,OAAO,GAAE,MAAmC,GAC3C,OAAO,CAMT"}
@@ -64,7 +64,7 @@ export function isRekeying(state) {
64
64
  return state.phase === 'rekeying';
65
65
  }
66
66
  /**
67
- * Check if session is expired.
67
+ * Check whether the session expired.
68
68
  */
69
69
  export function isExpired(state) {
70
70
  return state.phase === 'expired';
@@ -86,9 +86,9 @@ export function canDecrypt(state) {
86
86
  return state.phase === 'active' || state.phase === 'rekeying';
87
87
  }
88
88
  /**
89
- * Check if session is established (can communicate).
89
+ * Check whether the session can communicate.
90
90
  *
91
- * Active and rekeying sessions are established.
91
+ * Active and rekeying sessions can communicate.
92
92
  */
93
93
  export function isEstablished(state) {
94
94
  return state.phase === 'active' || state.phase === 'rekeying';
@@ -100,7 +100,7 @@ export function needsInitialization(state) {
100
100
  return state.phase === 'uninitialized';
101
101
  }
102
102
  /**
103
- * Check if session is waiting for first message.
103
+ * Check whether the session waits for the first message.
104
104
  */
105
105
  export function awaitingFirstMessage(state) {
106
106
  return state.phase === 'pending';
@@ -146,15 +146,15 @@ export const DEFAULT_SESSION_TIMEOUT_MS = 30 * 24 * 60 * 60 * 1000;
146
146
  /**
147
147
  * Rekey timeout (5 minutes in milliseconds).
148
148
  *
149
- * If rekey doesn't complete within this time, session should error.
149
+ * If rekey does not complete within this time, session should error.
150
150
  */
151
151
  export const REKEY_TIMEOUT_MS = 5 * 60 * 1000;
152
152
  /**
153
- * Check if session has timed out.
153
+ * Check whether the session timed out.
154
154
  *
155
155
  * @param state - Session state
156
156
  * @param timeout - Timeout duration in ms (default: 30 days)
157
- * @returns true if session has exceeded timeout
157
+ * @returns true if the session exceeded the timeout
158
158
  */
159
159
  export function hasTimedOut(state, timeout = DEFAULT_SESSION_TIMEOUT_MS) {
160
160
  if (state.phase === 'expired')
@@ -5,9 +5,9 @@
5
5
  * session establishment via X3DH/PQXDH key agreement.
6
6
  *
7
7
  * Session Identification:
8
- * - Sessions are LOOKED UP by ProtocolAddress (userId:deviceId)
9
- * - Session STATES are IDENTIFIED by baseKey (initiator's ephemeral public key)
10
- * - sessionId has been removed - use remoteAddress for lookup, baseKey for state ID
8
+ * - A ProtocolAddress (userId:deviceId) LOOKS UP a session
9
+ * - A baseKey (initiator's ephemeral public key) IDENTIFIES a session STATE
10
+ * - No sessionId remains. Use remoteAddress for lookup, baseKey for state ID
11
11
  *
12
12
  * @see https://signal.org/docs/specifications/x3dh/
13
13
  * @see https://signal.org/docs/specifications/pqxdh/
@@ -20,7 +20,7 @@ import type { ILogger } from '../../logger.js';
20
20
  /**
21
21
  * Input for building an initiator (Alice) session
22
22
  *
23
- * Note: sessionId has been removed. Sessions are identified by:
23
+ * Note: no sessionId remains. Two values identify a session:
24
24
  * - Lookup: remoteAddress (ProtocolAddress)
25
25
  * - State ID: baseKey (set automatically from ephemeral key)
26
26
  */
@@ -44,7 +44,7 @@ export interface SessionBuilderInitiatorInput {
44
44
  /**
45
45
  * Input for building a responder (Bob) session
46
46
  *
47
- * Note: sessionId has been removed. Sessions are identified by:
47
+ * Note: no sessionId remains. Two values identify a session:
48
48
  * - Lookup: remoteAddress (ProtocolAddress)
49
49
  * - State ID: baseKey (set from PreKeyMessage.senderEphemeralKey)
50
50
  */
@@ -76,9 +76,9 @@ export interface SessionBuilderResponderInput {
76
76
  export interface SessionBuilderInitiatorResult {
77
77
  /** The created session state */
78
78
  sessionState: SessionState;
79
- /** Kyber ciphertext to include in PreKeyMessage (if PQXDH was used) */
79
+ /** Kyber ciphertext to include in PreKeyMessage (PQXDH sessions only) */
80
80
  kyberCiphertext?: string;
81
- /** ID of Kyber prekey used (if PQXDH was used) */
81
+ /** ID of Kyber prekey used (PQXDH sessions only) */
82
82
  kyberPreKeyId?: number;
83
83
  /**
84
84
  * Original X3DH/PQXDH shared secret (SK) for Triple Ratchet initialization.
@@ -90,9 +90,9 @@ export interface SessionBuilderInitiatorResult {
90
90
  * Owned byte storage must be best-effort overwritten after use.
91
91
  */
92
92
  initialRootKeyForSPQR?: Uint8Array;
93
- /** Whether PQXDH (post-quantum) was used */
93
+ /** Whether the session used PQXDH (post-quantum) */
94
94
  usedPQXDH: boolean;
95
- /** Whether explicit X3DH compatibility fallback was used */
95
+ /** Whether the session used the explicit X3DH compatibility fallback */
96
96
  usedClassicalFallback?: boolean;
97
97
  }
98
98
  /**
@@ -101,13 +101,13 @@ export interface SessionBuilderInitiatorResult {
101
101
  export interface SessionBuilderResponderResult {
102
102
  /** The created session state */
103
103
  sessionState: SessionState;
104
- /** Whether PQXDH (post-quantum) was used */
104
+ /** Whether the session used PQXDH (post-quantum) */
105
105
  usedPQXDH: boolean;
106
- /** Whether explicit X3DH compatibility fallback was used */
106
+ /** Whether the session used the explicit X3DH compatibility fallback */
107
107
  usedClassicalFallback?: boolean;
108
108
  /**
109
109
  * Original X3DH/PQXDH shared secret (SK) for Triple Ratchet initialization.
110
- * Only present if PQXDH was used.
110
+ * Only present if the session used PQXDH.
111
111
  */
112
112
  initialRootKeyForSPQR?: Uint8Array;
113
113
  }
@@ -128,7 +128,7 @@ export interface KeyAgreementResult {
128
128
  usedSignedPreKeyId: number;
129
129
  /** ID of one-time prekey used (if any) */
130
130
  usedOneTimePreKeyId?: number;
131
- /** Kyber ciphertext (if PQXDH was used) */
131
+ /** Kyber ciphertext (PQXDH sessions only) */
132
132
  kyberCiphertext?: string;
133
133
  /** ID of Kyber prekey used (if any) */
134
134
  usedKyberPreKeyId?: number;
@@ -136,9 +136,9 @@ export interface KeyAgreementResult {
136
136
  kemOneTimePreKeyCiphertext?: string;
137
137
  /** ID of KEM one-time prekey used (if any) */
138
138
  usedKemOneTimePreKeyId?: number;
139
- /** Whether PQXDH was used */
139
+ /** Whether the session used PQXDH */
140
140
  usedPQXDH: boolean;
141
- /** Whether explicit X3DH compatibility fallback was used */
141
+ /** Whether the session used the explicit X3DH compatibility fallback */
142
142
  usedClassicalFallback?: boolean;
143
143
  }
144
144
  /**
@@ -149,9 +149,9 @@ export interface ResponderKeyAgreementResult {
149
149
  sharedSecret: Uint8Array;
150
150
  /** Additional derived bytes from HKDF */
151
151
  additionalDerivedBytes?: Uint8Array;
152
- /** Whether PQXDH was used */
152
+ /** Whether the session used PQXDH */
153
153
  usedPQXDH: boolean;
154
- /** Whether explicit X3DH compatibility fallback was used */
154
+ /** Whether the session used the explicit X3DH compatibility fallback */
155
155
  usedClassicalFallback?: boolean;
156
156
  }
157
157
  /**
@@ -163,7 +163,7 @@ export interface ResponderKeyAgreementResult {
163
163
  * This pattern keeps session establishment logic in the manager/orchestrator
164
164
  * while allowing SessionCipher to handle the decryption flow.
165
165
  *
166
- * Note: sessionId has been removed. Sessions are looked up by remoteAddress.
166
+ * Note: no sessionId remains. A remoteAddress looks up a session.
167
167
  */
168
168
  export type SessionEstablishmentCallback = (remoteAddress: ProtocolAddress, prekeyMessage: PreKeyMessage) => Promise<SessionState>;
169
169
  /**
@@ -191,8 +191,8 @@ export interface SessionCipherConfig {
191
191
  /**
192
192
  * Protocol strategy configuration.
193
193
  *
194
- * The cipher does not choose protocol behavior — session establishment
195
- * already did — but it is the layer that drives SPQR on every message, so
194
+ * The cipher does not choose protocol behavior, because session establishment
195
+ * already did. The cipher is the layer that drives SPQR on every message, so
196
196
  * the strategy's per-message diagnostic hooks are reported from here.
197
197
  */
198
198
  protocolStrategy?: ProtocolStrategyConfig;
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../internal/session/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,KAAK,EACV,eAAe,EACf,YAAY,EACZ,cAAc,EACd,eAAe,EACf,WAAW,EACX,gBAAgB,EAChB,YAAY,EACb,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,EAAE,yBAAyB,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC1F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAC1D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAM5C;;;;;;GAMG;AACH,OAAO,EAAE,CAAC;AACV,MAAM,WAAW,4BAA4B;IAC3C,oCAAoC;IACpC,YAAY,EAAE,eAAe,CAAC;IAC9B,+DAA+D;IAC/D,aAAa,EAAE,eAAe,CAAC;IAC/B,4BAA4B;IAC5B,eAAe,EAAE,eAAe,CAAC;IACjC,0CAA0C;IAC1C,YAAY,EAAE,YAAY,CAAC;IAC3B,4EAA4E;IAC5E,qBAAqB,EAAE,YAAY,CAAC;IACpC,iDAAiD;IACjD,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;IAC1C,gDAAgD;IAChD,MAAM,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;CAC5B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,4BAA4B;IAC3C,oCAAoC;IACpC,YAAY,EAAE,eAAe,CAAC;IAC9B,gFAAgF;IAChF,aAAa,EAAE,eAAe,CAAC;IAC/B,4BAA4B;IAC5B,eAAe,EAAE,eAAe,CAAC;IACjC,4BAA4B;IAC5B,aAAa,EAAE,aAAa,CAAC;IAC7B,wCAAwC;IACxC,cAAc,EAAE,cAAc,CAAC;IAC/B,mDAAmD;IACnD,eAAe,EAAE,eAAe,GAAG,IAAI,CAAC;IACxC,gDAAgD;IAChD,mBAAmB,EAAE,WAAW,GAAG,IAAI,CAAC;IACxC,sGAAsG;IACtG,gBAAgB,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAC1C,iDAAiD;IACjD,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;IAC1C,gDAAgD;IAChD,MAAM,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;CAC5B;AAMD;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,gCAAgC;IAChC,YAAY,EAAE,YAAY,CAAC;IAC3B,uEAAuE;IACvE,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,kDAAkD;IAClD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;;;;;OAQG;IACH,qBAAqB,CAAC,EAAE,UAAU,CAAC;IACnC,4CAA4C;IAC5C,SAAS,EAAE,OAAO,CAAC;IACnB,4DAA4D;IAC5D,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,gCAAgC;IAChC,YAAY,EAAE,YAAY,CAAC;IAC3B,4CAA4C;IAC5C,SAAS,EAAE,OAAO,CAAC;IACnB,4DAA4D;IAC5D,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,UAAU,CAAC;CACpC;AAMD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,uCAAuC;IACvC,YAAY,EAAE,UAAU,CAAC;IACzB,0DAA0D;IAC1D,sBAAsB,CAAC,EAAE,UAAU,CAAC;IACpC,wDAAwD;IACxD,gBAAgB,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC;IAC5D,+BAA+B;IAC/B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,0CAA0C;IAC1C,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,2CAA2C;IAC3C,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,uCAAuC;IACvC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,+CAA+C;IAC/C,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,8CAA8C;IAC9C,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,6BAA6B;IAC7B,SAAS,EAAE,OAAO,CAAC;IACnB,4DAA4D;IAC5D,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,uCAAuC;IACvC,YAAY,EAAE,UAAU,CAAC;IACzB,yCAAyC;IACzC,sBAAsB,CAAC,EAAE,UAAU,CAAC;IACpC,6BAA6B;IAC7B,SAAS,EAAE,OAAO,CAAC;IACnB,4DAA4D;IAC5D,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC;AAMD;;;;;;;;;;GAUG;AACH,MAAM,MAAM,4BAA4B,GAAG,CACzC,aAAa,EAAE,eAAe,EAC9B,aAAa,EAAE,aAAa,KACzB,OAAO,CAAC,YAAY,CAAC,CAAC;AAE3B;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,+CAA+C;IAC/C,UAAU,EAAE,yBAAyB,CAAC;IACtC;;;OAGG;IACH,gBAAgB,EAAE,4BAA4B,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;CAC3C"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../internal/session/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,KAAK,EACV,eAAe,EACf,YAAY,EACZ,cAAc,EACd,eAAe,EACf,WAAW,EACX,gBAAgB,EAChB,YAAY,EACb,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,EAAE,yBAAyB,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC1F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAC1D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAM5C;;;;;;GAMG;AACH,OAAO,EAAE,CAAC;AACV,MAAM,WAAW,4BAA4B;IAC3C,oCAAoC;IACpC,YAAY,EAAE,eAAe,CAAC;IAC9B,+DAA+D;IAC/D,aAAa,EAAE,eAAe,CAAC;IAC/B,4BAA4B;IAC5B,eAAe,EAAE,eAAe,CAAC;IACjC,0CAA0C;IAC1C,YAAY,EAAE,YAAY,CAAC;IAC3B,4EAA4E;IAC5E,qBAAqB,EAAE,YAAY,CAAC;IACpC,iDAAiD;IACjD,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;IAC1C,gDAAgD;IAChD,MAAM,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;CAC5B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,4BAA4B;IAC3C,oCAAoC;IACpC,YAAY,EAAE,eAAe,CAAC;IAC9B,gFAAgF;IAChF,aAAa,EAAE,eAAe,CAAC;IAC/B,4BAA4B;IAC5B,eAAe,EAAE,eAAe,CAAC;IACjC,4BAA4B;IAC5B,aAAa,EAAE,aAAa,CAAC;IAC7B,wCAAwC;IACxC,cAAc,EAAE,cAAc,CAAC;IAC/B,mDAAmD;IACnD,eAAe,EAAE,eAAe,GAAG,IAAI,CAAC;IACxC,gDAAgD;IAChD,mBAAmB,EAAE,WAAW,GAAG,IAAI,CAAC;IACxC,sGAAsG;IACtG,gBAAgB,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAC1C,iDAAiD;IACjD,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;IAC1C,gDAAgD;IAChD,MAAM,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;CAC5B;AAMD;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,gCAAgC;IAChC,YAAY,EAAE,YAAY,CAAC;IAC3B,yEAAyE;IACzE,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,oDAAoD;IACpD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;;;;;OAQG;IACH,qBAAqB,CAAC,EAAE,UAAU,CAAC;IACnC,oDAAoD;IACpD,SAAS,EAAE,OAAO,CAAC;IACnB,wEAAwE;IACxE,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,gCAAgC;IAChC,YAAY,EAAE,YAAY,CAAC;IAC3B,oDAAoD;IACpD,SAAS,EAAE,OAAO,CAAC;IACnB,wEAAwE;IACxE,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,UAAU,CAAC;CACpC;AAMD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,uCAAuC;IACvC,YAAY,EAAE,UAAU,CAAC;IACzB,0DAA0D;IAC1D,sBAAsB,CAAC,EAAE,UAAU,CAAC;IACpC,wDAAwD;IACxD,gBAAgB,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC;IAC5D,+BAA+B;IAC/B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,0CAA0C;IAC1C,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,6CAA6C;IAC7C,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,uCAAuC;IACvC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,+CAA+C;IAC/C,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,8CAA8C;IAC9C,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,qCAAqC;IACrC,SAAS,EAAE,OAAO,CAAC;IACnB,wEAAwE;IACxE,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,uCAAuC;IACvC,YAAY,EAAE,UAAU,CAAC;IACzB,yCAAyC;IACzC,sBAAsB,CAAC,EAAE,UAAU,CAAC;IACpC,qCAAqC;IACrC,SAAS,EAAE,OAAO,CAAC;IACnB,wEAAwE;IACxE,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC;AAMD;;;;;;;;;;GAUG;AACH,MAAM,MAAM,4BAA4B,GAAG,CACzC,aAAa,EAAE,eAAe,EAC9B,aAAa,EAAE,aAAa,KACzB,OAAO,CAAC,YAAY,CAAC,CAAC;AAE3B;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,+CAA+C;IAC/C,UAAU,EAAE,yBAAyB,CAAC;IACtC;;;OAGG;IACH,gBAAgB,EAAE,4BAA4B,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;CAC3C"}
@@ -5,9 +5,9 @@
5
5
  * session establishment via X3DH/PQXDH key agreement.
6
6
  *
7
7
  * Session Identification:
8
- * - Sessions are LOOKED UP by ProtocolAddress (userId:deviceId)
9
- * - Session STATES are IDENTIFIED by baseKey (initiator's ephemeral public key)
10
- * - sessionId has been removed - use remoteAddress for lookup, baseKey for state ID
8
+ * - A ProtocolAddress (userId:deviceId) LOOKS UP a session
9
+ * - A baseKey (initiator's ephemeral public key) IDENTIFIES a session STATE
10
+ * - No sessionId remains. Use remoteAddress for lookup, baseKey for state ID
11
11
  *
12
12
  * @see https://signal.org/docs/specifications/x3dh/
13
13
  * @see https://signal.org/docs/specifications/pqxdh/
@@ -32,7 +32,7 @@ export declare function decodeIdentityKeyOrDummy(key: Base64 | undefined): Uint8
32
32
  * 4. Exactly 32 bytes when decoded (256-bit key)
33
33
  *
34
34
  * NOTE: This throws on invalid keys, creating a timing side-channel.
35
- * Use only on the SEND path (where we're the sender and timing doesn't
35
+ * Use only on the SEND path (where we are the sender and timing does not
36
36
  * leak secrets). For the RECEIVE path, use decodeIdentityKeyOrDummy().
37
37
  *
38
38
  * @param key Base64-encoded identity key
@@ -34,7 +34,7 @@ export function decodeIdentityKeyOrDummy(key) {
34
34
  * 4. Exactly 32 bytes when decoded (256-bit key)
35
35
  *
36
36
  * NOTE: This throws on invalid keys, creating a timing side-channel.
37
- * Use only on the SEND path (where we're the sender and timing doesn't
37
+ * Use only on the SEND path (where we are the sender and timing does not
38
38
  * leak secrets). For the RECEIVE path, use decodeIdentityKeyOrDummy().
39
39
  *
40
40
  * @param key Base64-encoded identity key
@@ -81,7 +81,7 @@ export function validateIdentityKey(key, fieldName) {
81
81
  * @throws EncryptionError with SESSION_CORRUPTED if keys are swapped
82
82
  */
83
83
  export function validateSessionKeyOwnership(session, mySignedPreKeyPublic, logger = defaultSignalProtocolLogger) {
84
- // Skip validation if we don't have a signed prekey to compare
84
+ // Skip validation if we do not have a signed prekey to compare
85
85
  if (!mySignedPreKeyPublic) {
86
86
  logger.warn('Cannot validate session key ownership: no signed prekey available', {
87
87
  category: 'E2EE',
@@ -95,7 +95,7 @@ export function validateSessionKeyOwnership(session, mySignedPreKeyPublic, logge
95
95
  // DHr should NOT be our signed prekey (would indicate swapped keys)
96
96
  if (session.DHr !== undefined && session.DHr === mySignedPreKeyPublic) {
97
97
  // BUG DETECTED: DHr equals our own signed prekey
98
- // This means keys are swapped - we're trying to compute DH with ourselves
98
+ // This means keys are swapped - we are trying to compute DH with ourselves
99
99
  logger.error('Session corrupted: DHr equals our own signed prekey (keys swapped)', {
100
100
  category: 'SECURITY',
101
101
  data: {
@@ -202,7 +202,7 @@ export function validateSessionStateIntegrity(session, logger = defaultSignalPro
202
202
  reason: 'receiverChains_invalid_type',
203
203
  });
204
204
  }
205
- // DHr must not be an empty string if defined
205
+ // DHr must not be an empty string if defined.
206
206
  // Empty string DHr passes truthy checks but creates invalid keyIds for MKSKIPPED
207
207
  // (e.g., ":0" instead of "validKey:0"), corrupting skipped message key lookups.
208
208
  // An undefined/null DHr is valid (lazy init for responder's first message).