@open-e2ee/signal-protocol-sdk 8.2.0 → 9.0.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 (276) hide show
  1. package/ADAPTERS.md +13 -31
  2. package/ARCHITECTURE.md +5 -7
  3. package/CHANGELOG.md +105 -0
  4. package/README.md +36 -48
  5. package/SECURITY.md +2 -2
  6. package/client/README.md +9 -0
  7. package/dist/client/client.d.ts +21 -14
  8. package/dist/client/client.d.ts.map +1 -1
  9. package/dist/client/client.js +93 -78
  10. package/dist/client/client.js.map +1 -1
  11. package/dist/client/config.d.ts +10 -17
  12. package/dist/client/config.d.ts.map +1 -1
  13. package/dist/client/config.js.map +1 -1
  14. package/dist/client/event-hooks.js +27 -0
  15. package/dist/client/event-hooks.js.map +1 -1
  16. package/dist/client/group-receive-authorization.d.ts +5 -0
  17. package/dist/client/group-receive-authorization.d.ts.map +1 -0
  18. package/dist/client/group-receive-authorization.js +32 -0
  19. package/dist/client/group-receive-authorization.js.map +1 -0
  20. package/dist/client/group-sender-key-operations.d.ts +15 -0
  21. package/dist/client/group-sender-key-operations.d.ts.map +1 -0
  22. package/dist/client/group-sender-key-operations.js +31 -0
  23. package/dist/client/group-sender-key-operations.js.map +1 -0
  24. package/dist/client/groups.d.ts +3 -1
  25. package/dist/client/groups.d.ts.map +1 -1
  26. package/dist/client/groups.js +5 -2
  27. package/dist/client/groups.js.map +1 -1
  28. package/dist/client/relay-subscription.d.ts +2 -0
  29. package/dist/client/relay-subscription.d.ts.map +1 -1
  30. package/dist/client/relay-subscription.js +3 -1
  31. package/dist/client/relay-subscription.js.map +1 -1
  32. package/dist/client/sender-key-distribution.d.ts.map +1 -1
  33. package/dist/client/sender-key-distribution.js +4 -1
  34. package/dist/client/sender-key-distribution.js.map +1 -1
  35. package/dist/client/signal-service-cipher.d.ts +4 -2
  36. package/dist/client/signal-service-cipher.d.ts.map +1 -1
  37. package/dist/client/signal-service-cipher.js +61 -51
  38. package/dist/client/signal-service-cipher.js.map +1 -1
  39. package/dist/index.d.ts +27 -21
  40. package/dist/index.d.ts.map +1 -1
  41. package/dist/index.js +8 -17
  42. package/dist/index.js.map +1 -1
  43. package/dist/internal/crypto/pq/kyber.d.ts +1 -1
  44. package/dist/internal/crypto/pq/kyber.js +1 -1
  45. package/dist/internal/encoding/proto/sender-key-message.d.ts +2 -2
  46. package/dist/internal/encoding/proto/sender-key-message.d.ts.map +1 -1
  47. package/dist/internal/encoding/proto/sender-key-message.js +5 -2
  48. package/dist/internal/encoding/proto/sender-key-message.js.map +1 -1
  49. package/dist/internal/groups/manager.d.ts.map +1 -1
  50. package/dist/internal/groups/manager.js +5 -2
  51. package/dist/internal/groups/manager.js.map +1 -1
  52. package/dist/internal/groups/wire.d.ts +0 -2
  53. package/dist/internal/groups/wire.d.ts.map +1 -1
  54. package/dist/internal/groups/wire.js +0 -6
  55. package/dist/internal/groups/wire.js.map +1 -1
  56. package/dist/internal/manager/manager.d.ts.map +1 -1
  57. package/dist/internal/manager/manager.js +0 -1
  58. package/dist/internal/manager/manager.js.map +1 -1
  59. package/dist/internal/protocol/double-ratchet/ratchet.d.ts +0 -17
  60. package/dist/internal/protocol/double-ratchet/ratchet.d.ts.map +1 -1
  61. package/dist/internal/protocol/double-ratchet/ratchet.js +0 -4
  62. package/dist/internal/protocol/double-ratchet/ratchet.js.map +1 -1
  63. package/dist/internal/protocol/sealed-sender/certificate.d.ts +2 -32
  64. package/dist/internal/protocol/sealed-sender/certificate.d.ts.map +1 -1
  65. package/dist/internal/protocol/sealed-sender/certificate.js +4 -85
  66. package/dist/internal/protocol/sealed-sender/certificate.js.map +1 -1
  67. package/dist/internal/protocol/sealed-sender/index.d.ts +2 -2
  68. package/dist/internal/protocol/sealed-sender/index.d.ts.map +1 -1
  69. package/dist/internal/protocol/sealed-sender/index.js +2 -6
  70. package/dist/internal/protocol/sealed-sender/index.js.map +1 -1
  71. package/dist/internal/protocol/sealed-sender/proto/index.d.ts +0 -19
  72. package/dist/internal/protocol/sealed-sender/proto/index.d.ts.map +1 -1
  73. package/dist/internal/protocol/sealed-sender/proto/index.js +1 -48
  74. package/dist/internal/protocol/sealed-sender/proto/index.js.map +1 -1
  75. package/dist/internal/protocol/sender-keys/manager.d.ts +9 -13
  76. package/dist/internal/protocol/sender-keys/manager.d.ts.map +1 -1
  77. package/dist/internal/protocol/sender-keys/manager.js +90 -95
  78. package/dist/internal/protocol/sender-keys/manager.js.map +1 -1
  79. package/dist/internal/protocol/spqr/ml-kem-braid/incremental-kem.d.ts +0 -2
  80. package/dist/internal/protocol/spqr/ml-kem-braid/incremental-kem.d.ts.map +1 -1
  81. package/dist/internal/protocol/spqr/ml-kem-braid/incremental-kem.js +4 -12
  82. package/dist/internal/protocol/spqr/ml-kem-braid/incremental-kem.js.map +1 -1
  83. package/dist/internal/protocol/spqr/ml-kem-braid/types.d.ts +1 -0
  84. package/dist/internal/protocol/spqr/ml-kem-braid/types.d.ts.map +1 -1
  85. package/dist/internal/protocol/spqr/spqr.d.ts +1 -1
  86. package/dist/internal/protocol/spqr/spqr.js +1 -1
  87. package/dist/internal/protocol/x3dh/x3dh.d.ts.map +1 -1
  88. package/dist/internal/protocol/x3dh/x3dh.js +1 -1
  89. package/dist/internal/protocol/x3dh/x3dh.js.map +1 -1
  90. package/dist/internal/protocol/zk/credentials/credentials.d.ts +3 -54
  91. package/dist/internal/protocol/zk/credentials/credentials.d.ts.map +1 -1
  92. package/dist/internal/protocol/zk/credentials/credentials.js +4 -91
  93. package/dist/internal/protocol/zk/credentials/credentials.js.map +1 -1
  94. package/dist/internal/protocol/zk/credentials/endorsements.d.ts +3 -64
  95. package/dist/internal/protocol/zk/credentials/endorsements.d.ts.map +1 -1
  96. package/dist/internal/protocol/zk/credentials/endorsements.js +4 -134
  97. package/dist/internal/protocol/zk/credentials/endorsements.js.map +1 -1
  98. package/dist/internal/protocol/zk/credentials/index.d.ts +3 -3
  99. package/dist/internal/protocol/zk/credentials/index.d.ts.map +1 -1
  100. package/dist/internal/protocol/zk/credentials/index.js +3 -3
  101. package/dist/internal/protocol/zk/credentials/index.js.map +1 -1
  102. package/dist/internal/protocol/zk/credentials/issuance.d.ts +3 -26
  103. package/dist/internal/protocol/zk/credentials/issuance.d.ts.map +1 -1
  104. package/dist/internal/protocol/zk/credentials/issuance.js +3 -80
  105. package/dist/internal/protocol/zk/credentials/issuance.js.map +1 -1
  106. package/dist/internal/protocol/zk/credentials/presentation.d.ts +4 -73
  107. package/dist/internal/protocol/zk/credentials/presentation.d.ts.map +1 -1
  108. package/dist/internal/protocol/zk/credentials/presentation.js +4 -152
  109. package/dist/internal/protocol/zk/credentials/presentation.js.map +1 -1
  110. package/dist/internal/protocol/zk/groups/auth-credential.d.ts +1 -61
  111. package/dist/internal/protocol/zk/groups/auth-credential.d.ts.map +1 -1
  112. package/dist/internal/protocol/zk/groups/auth-credential.js +2 -196
  113. package/dist/internal/protocol/zk/groups/auth-credential.js.map +1 -1
  114. package/dist/internal/protocol/zk/groups/group-send-endorsement.d.ts +1 -86
  115. package/dist/internal/protocol/zk/groups/group-send-endorsement.d.ts.map +1 -1
  116. package/dist/internal/protocol/zk/groups/group-send-endorsement.js +1 -152
  117. package/dist/internal/protocol/zk/groups/group-send-endorsement.js.map +1 -1
  118. package/dist/internal/protocol/zk/groups/index.d.ts +4 -4
  119. package/dist/internal/protocol/zk/groups/index.d.ts.map +1 -1
  120. package/dist/internal/protocol/zk/groups/index.js +4 -4
  121. package/dist/internal/protocol/zk/groups/index.js.map +1 -1
  122. package/dist/internal/protocol/zk/groups/profile-key-credential.d.ts +2 -57
  123. package/dist/internal/protocol/zk/groups/profile-key-credential.d.ts.map +1 -1
  124. package/dist/internal/protocol/zk/groups/profile-key-credential.js +2 -174
  125. package/dist/internal/protocol/zk/groups/profile-key-credential.js.map +1 -1
  126. package/dist/internal/protocol/zk/groups/server-params.d.ts +8 -72
  127. package/dist/internal/protocol/zk/groups/server-params.d.ts.map +1 -1
  128. package/dist/internal/protocol/zk/groups/server-params.js +8 -108
  129. package/dist/internal/protocol/zk/groups/server-params.js.map +1 -1
  130. package/dist/internal/protocol/zk/proofs/sign.d.ts +1 -2
  131. package/dist/internal/protocol/zk/proofs/sign.d.ts.map +1 -1
  132. package/dist/internal/protocol/zk/proofs/sign.js +2 -11
  133. package/dist/internal/protocol/zk/proofs/sign.js.map +1 -1
  134. package/dist/internal/session/ratchet.d.ts.map +1 -1
  135. package/dist/internal/session/ratchet.js +0 -2
  136. package/dist/internal/session/ratchet.js.map +1 -1
  137. package/dist/local/store/key-value/adapter.d.ts +3 -3
  138. package/dist/local/store/key-value/adapter.d.ts.map +1 -1
  139. package/dist/local/store/key-value/adapter.js +30 -15
  140. package/dist/local/store/key-value/adapter.js.map +1 -1
  141. package/dist/local/store/key-value/backend-conformance.d.ts.map +1 -1
  142. package/dist/local/store/key-value/backend-conformance.js +25 -0
  143. package/dist/local/store/key-value/backend-conformance.js.map +1 -1
  144. package/dist/local/store/key-value/batch.d.ts +3 -1
  145. package/dist/local/store/key-value/batch.d.ts.map +1 -1
  146. package/dist/local/store/key-value/batch.js +9 -1
  147. package/dist/local/store/key-value/batch.js.map +1 -1
  148. package/dist/local/store/key-value/storage.d.ts +6 -0
  149. package/dist/local/store/key-value/storage.d.ts.map +1 -1
  150. package/dist/local/store/key-value/transactional-backend.d.ts +1 -1
  151. package/dist/local/store/key-value/transactional-backend.js +1 -1
  152. package/dist/local/store/memory/adapter.d.ts +3 -3
  153. package/dist/local/store/memory/adapter.d.ts.map +1 -1
  154. package/dist/local/store/memory/adapter.js +43 -18
  155. package/dist/local/store/memory/adapter.js.map +1 -1
  156. package/dist/local/store/sqlite/migrations.d.ts.map +1 -1
  157. package/dist/local/store/sqlite/migrations.js +18 -0
  158. package/dist/local/store/sqlite/migrations.js.map +1 -1
  159. package/dist/local/store/sqlite/models/skipped-sender-key.d.ts +3 -3
  160. package/dist/local/store/sqlite/models/skipped-sender-key.d.ts.map +1 -1
  161. package/dist/local/store/sqlite/models/skipped-sender-key.js +13 -17
  162. package/dist/local/store/sqlite/models/skipped-sender-key.js.map +1 -1
  163. package/dist/local/store/sqlite/store.d.ts +3 -3
  164. package/dist/local/store/sqlite/store.d.ts.map +1 -1
  165. package/dist/local/store/sqlite/store.js +17 -9
  166. package/dist/local/store/sqlite/store.js.map +1 -1
  167. package/dist/local/store/web/adapter.d.ts +3 -3
  168. package/dist/local/store/web/adapter.d.ts.map +1 -1
  169. package/dist/local/store/web/adapter.js +59 -20
  170. package/dist/local/store/web/adapter.js.map +1 -1
  171. package/dist/remote/relay/index.d.ts +4 -7
  172. package/dist/remote/relay/index.d.ts.map +1 -1
  173. package/dist/remote/relay/index.js +5 -7
  174. package/dist/remote/relay/index.js.map +1 -1
  175. package/dist/remote/relay/types.d.ts +3 -3
  176. package/dist/types/api.d.ts +29 -8
  177. package/dist/types/api.d.ts.map +1 -1
  178. package/dist/versions.d.ts +3 -3
  179. package/dist/versions.js +3 -3
  180. package/dist/zk/credentials.d.ts +2 -2
  181. package/dist/zk/credentials.js +2 -2
  182. package/dist/zk/groups.d.ts +3 -3
  183. package/dist/zk/groups.d.ts.map +1 -1
  184. package/dist/zk/groups.js +3 -3
  185. package/dist/zk/groups.js.map +1 -1
  186. package/docs/ASSURANCE.md +12 -14
  187. package/docs/CLIENT_COMPOSITION.md +9 -3
  188. package/docs/DEVIATIONS.md +24 -25
  189. package/docs/GETTING_STARTED.md +42 -320
  190. package/docs/INTERFACES.md +7 -7
  191. package/docs/PACKAGE_SURFACE.md +14 -16
  192. package/docs/RECIPES.md +6 -112
  193. package/groups/README.md +9 -1
  194. package/local/store/README.md +26 -6
  195. package/package.json +1 -30
  196. package/remote/README.md +12 -78
  197. package/remote/object-store/convex-r2/README.md +17 -49
  198. package/remote/relay/README.md +21 -18
  199. package/zk/README.md +6 -7
  200. package/dist/client/dual-store.d.ts +0 -70
  201. package/dist/client/dual-store.d.ts.map +0 -1
  202. package/dist/client/dual-store.js +0 -123
  203. package/dist/client/dual-store.js.map +0 -1
  204. package/dist/client/multi-device.d.ts +0 -74
  205. package/dist/client/multi-device.d.ts.map +0 -1
  206. package/dist/client/multi-device.js +0 -105
  207. package/dist/client/multi-device.js.map +0 -1
  208. package/dist/groups/server.d.ts +0 -10
  209. package/dist/groups/server.d.ts.map +0 -1
  210. package/dist/groups/server.js +0 -6
  211. package/dist/groups/server.js.map +0 -1
  212. package/dist/internal/encoding/index.d.ts +0 -2
  213. package/dist/internal/encoding/index.d.ts.map +0 -1
  214. package/dist/internal/encoding/index.js +0 -2
  215. package/dist/internal/encoding/index.js.map +0 -1
  216. package/dist/internal/groups/server-engine.d.ts +0 -118
  217. package/dist/internal/groups/server-engine.d.ts.map +0 -1
  218. package/dist/internal/groups/server-engine.js +0 -1268
  219. package/dist/internal/groups/server-engine.js.map +0 -1
  220. package/dist/internal/protocol/index.d.ts +0 -24
  221. package/dist/internal/protocol/index.d.ts.map +0 -1
  222. package/dist/internal/protocol/index.js +0 -9
  223. package/dist/internal/protocol/index.js.map +0 -1
  224. package/dist/internal/protocol/sealed-sender/trust-root.d.ts +0 -56
  225. package/dist/internal/protocol/sealed-sender/trust-root.d.ts.map +0 -1
  226. package/dist/internal/protocol/sealed-sender/trust-root.js +0 -90
  227. package/dist/internal/protocol/sealed-sender/trust-root.js.map +0 -1
  228. package/dist/internal/protocol/triple-ratchet/index.d.ts +0 -21
  229. package/dist/internal/protocol/triple-ratchet/index.d.ts.map +0 -1
  230. package/dist/internal/protocol/triple-ratchet/index.js +0 -19
  231. package/dist/internal/protocol/triple-ratchet/index.js.map +0 -1
  232. package/dist/internal/protocol/triple-ratchet/ratchet.d.ts +0 -233
  233. package/dist/internal/protocol/triple-ratchet/ratchet.d.ts.map +0 -1
  234. package/dist/internal/protocol/triple-ratchet/ratchet.js +0 -254
  235. package/dist/internal/protocol/triple-ratchet/ratchet.js.map +0 -1
  236. package/dist/internal/protocol/zk/proofs/index.d.ts +0 -13
  237. package/dist/internal/protocol/zk/proofs/index.d.ts.map +0 -1
  238. package/dist/internal/protocol/zk/proofs/index.js +0 -7
  239. package/dist/internal/protocol/zk/proofs/index.js.map +0 -1
  240. package/dist/local/store/sqlite/index.d.ts +0 -20
  241. package/dist/local/store/sqlite/index.d.ts.map +0 -1
  242. package/dist/local/store/sqlite/index.js +0 -18
  243. package/dist/local/store/sqlite/index.js.map +0 -1
  244. package/dist/remote/object-store/convex-r2/server/index.d.ts +0 -2
  245. package/dist/remote/object-store/convex-r2/server/index.d.ts.map +0 -1
  246. package/dist/remote/object-store/convex-r2/server/index.js +0 -2
  247. package/dist/remote/object-store/convex-r2/server/index.js.map +0 -1
  248. package/dist/remote/object-store/convex-r2/server.d.ts +0 -129
  249. package/dist/remote/object-store/convex-r2/server.d.ts.map +0 -1
  250. package/dist/remote/object-store/convex-r2/server.js +0 -244
  251. package/dist/remote/object-store/convex-r2/server.js.map +0 -1
  252. package/dist/remote/relay/memory/adapter.d.ts +0 -252
  253. package/dist/remote/relay/memory/adapter.d.ts.map +0 -1
  254. package/dist/remote/relay/memory/adapter.js +0 -1057
  255. package/dist/remote/relay/memory/adapter.js.map +0 -1
  256. package/dist/remote/relay/memory/failures.d.ts +0 -58
  257. package/dist/remote/relay/memory/failures.d.ts.map +0 -1
  258. package/dist/remote/relay/memory/failures.js +0 -124
  259. package/dist/remote/relay/memory/failures.js.map +0 -1
  260. package/dist/remote/relay/memory/group-server.d.ts +0 -13
  261. package/dist/remote/relay/memory/group-server.d.ts.map +0 -1
  262. package/dist/remote/relay/memory/group-server.js +0 -19
  263. package/dist/remote/relay/memory/group-server.js.map +0 -1
  264. package/dist/remote/relay/memory/index.d.ts +0 -11
  265. package/dist/remote/relay/memory/index.d.ts.map +0 -1
  266. package/dist/remote/relay/memory/index.js +0 -7
  267. package/dist/remote/relay/memory/index.js.map +0 -1
  268. package/examples/browser/README.md +0 -35
  269. package/examples/browser/index.html +0 -27
  270. package/examples/browser/src/exchange.ts +0 -69
  271. package/examples/browser/src/main.ts +0 -63
  272. package/examples/browser/src/style.css +0 -9
  273. package/examples/browser/src/worker.ts +0 -10
  274. package/examples/browser/vite.config.ts +0 -9
  275. package/remote/relay/memory/README.md +0 -72
  276. package/scripts/oe-groups.mjs +0 -166
@@ -1,72 +0,0 @@
1
- # In-Memory Relay
2
-
3
- `InMemorySignalProtocolRelayServer` implements `SignalProtocolRelayServer` in memory for examples
4
- and local application development.
5
-
6
- The protocol and cryptography are real. The adapter simulates the
7
- infrastructure in memory.
8
-
9
- ## Why it exists
10
-
11
- It provides device registration, public-prekey exchange, and encrypted-envelope
12
- delivery without deploying a backend. It is a development adapter, not an
13
- authorization or durability boundary.
14
-
15
- ## Usage
16
-
17
- <!-- doc-snippet:run memory-relay-client expect="" -->
18
- ```ts
19
- // Real protocol and cryptography; simulated in-memory infrastructure.
20
- import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
21
- import { inMemoryStore } from "@open-e2ee/signal-protocol-sdk/local/store/memory";
22
- import { inMemoryRelay } from "@open-e2ee/signal-protocol-sdk/remote/relay/memory";
23
-
24
- const relay = inMemoryRelay();
25
- const client = await createSignalProtocolClient({
26
- identity: { userId: "alice" },
27
- adapters: { storage: inMemoryStore(), relay },
28
- });
29
-
30
- await client.syncToServer();
31
- ```
32
-
33
- All registered devices, public keys, mailboxes, and provisioning state disappear
34
- with the adapter. It does not authenticate accounts, limit rates, prevent
35
- abuse, or deliver durably. Never use it in production.
36
-
37
- ## Deterministic failure and recovery exercises
38
-
39
- Failure mode is opt-in and seeded. The default `inMemoryRelay()` remains the
40
- deterministic happy path:
41
-
42
- <!-- doc-snippet:run memory-relay-failure-injection expect="" -->
43
- ```ts
44
- // Real protocol and cryptography; simulated in-memory infrastructure.
45
- import { inMemoryRelay } from "@open-e2ee/signal-protocol-sdk/remote/relay/memory";
46
-
47
- const relay = inMemoryRelay({
48
- failures: {
49
- seed: 7,
50
- latencyMs: 20,
51
- duplicateDeliveryEvery: 3,
52
- reorderDeliveryPairs: true,
53
- rejectAuthorization: true,
54
- exhaustOneTimePreKeys: true,
55
- },
56
- });
57
-
58
- relay.failures.disconnect("bob", 1);
59
- // Sends remain in Bob's encrypted mailbox.
60
- relay.failures.reconnect("bob", 1);
61
- ```
62
-
63
- `flushReordered()` releases an unmatched final envelope. `configure()` changes
64
- a scenario without rebuilding clients. Authorization rejection raises
65
- `SealedSenderAuthError`, allowing the client's documented identified-delivery
66
- fallback. One-time-prekey exhaustion withholds both EC and KEM one-time keys but
67
- keeps the KEM last-resort key. Strict-PQ examples therefore exercise the
68
- intended post-quantum recovery path rather than a silent classical downgrade. Failure
69
- selection uses the configured seed and delivery count, never `Math.random()` or
70
- wall-clock time.
71
-
72
- See the parent [relay guide](../README.md).
@@ -1,166 +0,0 @@
1
- #!/usr/bin/env node
2
-
3
- import { randomBytes } from 'node:crypto';
4
- import { spawnSync } from 'node:child_process';
5
- import { fileURLToPath, pathToFileURL } from 'node:url';
6
- import path from 'node:path';
7
-
8
- const SECRET_ENV_VAR = 'OE_GROUPS_SERVER_SECRET';
9
-
10
- function usage(message) {
11
- if (message) process.stderr.write(`${message}\n\n`);
12
- process.stderr.write(
13
- 'Usage: oe-groups trust-root [--prod | --deployment <deployment>]\n'
14
- );
15
- process.exitCode = 2;
16
- }
17
-
18
- function deploymentArgs(args) {
19
- if (args.length === 0) return [];
20
- if (args.length === 1 && args[0] === '--prod') return ['--prod'];
21
- if (
22
- args.length === 2 &&
23
- args[0] === '--deployment' &&
24
- args[1].trim().length > 0
25
- ) {
26
- return args;
27
- }
28
- usage('Invalid deployment arguments');
29
- return null;
30
- }
31
-
32
- function runConvex(args, options = {}) {
33
- const command = process.platform === 'win32' ? 'npx.cmd' : 'npx';
34
- const result = spawnSync(command, ['convex', 'env', ...args], {
35
- cwd: process.cwd(),
36
- encoding: 'utf8',
37
- input: options.input,
38
- stdio: ['pipe', 'pipe', 'pipe'],
39
- });
40
- if (result.error) throw result.error;
41
- if (result.status !== 0) {
42
- const detail = result.stderr?.trim();
43
- throw new Error(
44
- detail
45
- ? `Convex environment command failed: ${detail}`
46
- : `Convex environment command exited with status ${result.status}`
47
- );
48
- }
49
- return result.stdout ?? '';
50
- }
51
-
52
- function requireSeed(encoded) {
53
- const normalized = encoded.trim();
54
- const seed = Buffer.from(normalized, 'base64');
55
- if (
56
- seed.length !== 32 ||
57
- seed.toString('base64') !== normalized
58
- ) {
59
- throw new Error(
60
- `${SECRET_ENV_VAR} must be canonical base64 encoding exactly 32 bytes`
61
- );
62
- }
63
- return new Uint8Array(seed);
64
- }
65
-
66
- async function printTrustRoot(args) {
67
- const selectedDeployment = deploymentArgs(args);
68
- if (!selectedDeployment) return;
69
-
70
- const names = runConvex([
71
- 'list',
72
- '--names-only',
73
- ...selectedDeployment,
74
- ])
75
- .split(/\r?\n/)
76
- .map((name) => name.trim())
77
- .filter(Boolean);
78
-
79
- let seed;
80
- if (names.includes(SECRET_ENV_VAR)) {
81
- seed = requireSeed(
82
- runConvex(['get', SECRET_ENV_VAR, ...selectedDeployment])
83
- );
84
- } else {
85
- seed = new Uint8Array(randomBytes(32));
86
- const encoded = Buffer.from(seed).toString('base64');
87
- runConvex(
88
- ['set', SECRET_ENV_VAR, ...selectedDeployment],
89
- { input: `${encoded}\n` }
90
- );
91
- }
92
-
93
- const scriptDirectory = path.dirname(fileURLToPath(import.meta.url));
94
- const [
95
- { generateServerSecretParams, getServerPublicParams },
96
- { encodeGroupTrustRoot },
97
- { deriveSealedSenderRootPublicKey, deriveSealedSenderScopeId },
98
- ] = await Promise.all([
99
- // pathToFileURL: dynamic import of a bare absolute path fails on
100
- // Windows, where the ESM loader requires a file:// URL.
101
- import(
102
- pathToFileURL(
103
- path.join(
104
- scriptDirectory,
105
- '../dist/internal/protocol/zk/groups/server-params.js'
106
- )
107
- ).href
108
- ),
109
- import(
110
- pathToFileURL(
111
- path.join(
112
- scriptDirectory,
113
- '../dist/internal/groups/trust-root.js'
114
- )
115
- ).href
116
- ),
117
- import(
118
- pathToFileURL(
119
- path.join(
120
- scriptDirectory,
121
- '../dist/internal/protocol/sealed-sender/trust-root.js'
122
- )
123
- ).href
124
- ),
125
- ]);
126
- const secretParams = generateServerSecretParams(seed);
127
- seed.fill(0);
128
- const publicParams = getServerPublicParams(secretParams);
129
- const trustRoot = encodeGroupTrustRoot({
130
- credentialPublicKey: publicParams.credentialPublicKey,
131
- serverSigningPublicKey: publicParams.signingPublicKey,
132
- profileKeyCredentialPublicKey:
133
- publicParams.profileKeyCredentialPublicKey,
134
- endorsementRootPublicKey: publicParams.endorsementPublicKey,
135
- });
136
- const sealedSenderRoot = await deriveSealedSenderRootPublicKey(
137
- secretParams.signingKeyPair.signingKey
138
- );
139
- const sealedSenderScope = await deriveSealedSenderScopeId(sealedSenderRoot);
140
-
141
- // Two independently pinned roots, printed with labels because they go to
142
- // different places in the client build and are not interchangeable.
143
- process.stdout.write(
144
- `group trust root: ${Buffer.from(trustRoot).toString('base64')}\n`
145
- );
146
- process.stdout.write(
147
- `sealed sender trust root: ${Buffer.from(sealedSenderRoot).toString('base64')}\n`
148
- );
149
- process.stdout.write(
150
- `sealed sender relay scope: ${Buffer.from(sealedSenderScope).toString('base64')}\n`
151
- );
152
- }
153
-
154
- const [command, ...args] = process.argv.slice(2);
155
- if (command !== 'trust-root') {
156
- usage(command ? `Unknown command: ${command}` : undefined);
157
- } else {
158
- try {
159
- await printTrustRoot(args);
160
- } catch (error) {
161
- process.stderr.write(
162
- `${error instanceof Error ? error.message : String(error)}\n`
163
- );
164
- process.exitCode = 1;
165
- }
166
- }