@open-e2ee/signal-protocol-sdk 8.2.0 → 9.1.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.
- package/ADAPTERS.md +15 -31
- package/ARCHITECTURE.md +5 -7
- package/CHANGELOG.md +128 -0
- package/README.md +52 -49
- package/SECURITY.md +2 -2
- package/client/README.md +11 -0
- package/dist/client/client.d.ts +21 -14
- package/dist/client/client.d.ts.map +1 -1
- package/dist/client/client.js +93 -78
- package/dist/client/client.js.map +1 -1
- package/dist/client/config.d.ts +10 -17
- package/dist/client/config.d.ts.map +1 -1
- package/dist/client/config.js.map +1 -1
- package/dist/client/event-hooks.js +27 -0
- package/dist/client/event-hooks.js.map +1 -1
- package/dist/client/group-receive-authorization.d.ts +5 -0
- package/dist/client/group-receive-authorization.d.ts.map +1 -0
- package/dist/client/group-receive-authorization.js +32 -0
- package/dist/client/group-receive-authorization.js.map +1 -0
- package/dist/client/group-sender-key-operations.d.ts +15 -0
- package/dist/client/group-sender-key-operations.d.ts.map +1 -0
- package/dist/client/group-sender-key-operations.js +31 -0
- package/dist/client/group-sender-key-operations.js.map +1 -0
- package/dist/client/groups.d.ts +3 -1
- package/dist/client/groups.d.ts.map +1 -1
- package/dist/client/groups.js +5 -2
- package/dist/client/groups.js.map +1 -1
- package/dist/client/hosted-sandbox-identity.d.ts +32 -0
- package/dist/client/hosted-sandbox-identity.d.ts.map +1 -0
- package/dist/client/hosted-sandbox-identity.js +157 -0
- package/dist/client/hosted-sandbox-identity.js.map +1 -0
- package/dist/client/hosted.d.ts +12 -2
- package/dist/client/hosted.d.ts.map +1 -1
- package/dist/client/hosted.js +12 -2
- package/dist/client/hosted.js.map +1 -1
- package/dist/client/index.d.ts +1 -1
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js +1 -1
- package/dist/client/index.js.map +1 -1
- package/dist/client/relay-subscription.d.ts +2 -0
- package/dist/client/relay-subscription.d.ts.map +1 -1
- package/dist/client/relay-subscription.js +3 -1
- package/dist/client/relay-subscription.js.map +1 -1
- package/dist/client/sender-key-distribution.d.ts.map +1 -1
- package/dist/client/sender-key-distribution.js +4 -1
- package/dist/client/sender-key-distribution.js.map +1 -1
- package/dist/client/signal-service-cipher.d.ts +4 -2
- package/dist/client/signal-service-cipher.d.ts.map +1 -1
- package/dist/client/signal-service-cipher.js +61 -51
- package/dist/client/signal-service-cipher.js.map +1 -1
- package/dist/client/types.d.ts +0 -3
- package/dist/client/types.d.ts.map +1 -1
- package/dist/client/types.js.map +1 -1
- package/dist/index.d.ts +28 -22
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +9 -18
- package/dist/index.js.map +1 -1
- package/dist/internal/crypto/pq/kyber.d.ts +1 -1
- package/dist/internal/crypto/pq/kyber.js +1 -1
- package/dist/internal/encoding/proto/sender-key-message.d.ts +2 -2
- package/dist/internal/encoding/proto/sender-key-message.d.ts.map +1 -1
- package/dist/internal/encoding/proto/sender-key-message.js +5 -2
- package/dist/internal/encoding/proto/sender-key-message.js.map +1 -1
- package/dist/internal/groups/manager.d.ts.map +1 -1
- package/dist/internal/groups/manager.js +5 -2
- package/dist/internal/groups/manager.js.map +1 -1
- package/dist/internal/groups/wire.d.ts +0 -2
- package/dist/internal/groups/wire.d.ts.map +1 -1
- package/dist/internal/groups/wire.js +0 -6
- package/dist/internal/groups/wire.js.map +1 -1
- package/dist/internal/manager/manager.d.ts.map +1 -1
- package/dist/internal/manager/manager.js +0 -1
- package/dist/internal/manager/manager.js.map +1 -1
- package/dist/internal/protocol/double-ratchet/ratchet.d.ts +0 -17
- package/dist/internal/protocol/double-ratchet/ratchet.d.ts.map +1 -1
- package/dist/internal/protocol/double-ratchet/ratchet.js +0 -4
- package/dist/internal/protocol/double-ratchet/ratchet.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/certificate.d.ts +2 -32
- package/dist/internal/protocol/sealed-sender/certificate.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/certificate.js +4 -85
- package/dist/internal/protocol/sealed-sender/certificate.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/index.d.ts +2 -2
- package/dist/internal/protocol/sealed-sender/index.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/index.js +2 -6
- package/dist/internal/protocol/sealed-sender/index.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/proto/index.d.ts +0 -19
- package/dist/internal/protocol/sealed-sender/proto/index.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/proto/index.js +1 -48
- package/dist/internal/protocol/sealed-sender/proto/index.js.map +1 -1
- package/dist/internal/protocol/sender-keys/manager.d.ts +9 -13
- package/dist/internal/protocol/sender-keys/manager.d.ts.map +1 -1
- package/dist/internal/protocol/sender-keys/manager.js +90 -95
- package/dist/internal/protocol/sender-keys/manager.js.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/incremental-kem.d.ts +0 -2
- package/dist/internal/protocol/spqr/ml-kem-braid/incremental-kem.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/incremental-kem.js +4 -12
- package/dist/internal/protocol/spqr/ml-kem-braid/incremental-kem.js.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/types.d.ts +1 -0
- package/dist/internal/protocol/spqr/ml-kem-braid/types.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/spqr.d.ts +1 -1
- package/dist/internal/protocol/spqr/spqr.js +1 -1
- package/dist/internal/protocol/x3dh/x3dh.d.ts.map +1 -1
- package/dist/internal/protocol/x3dh/x3dh.js +1 -1
- package/dist/internal/protocol/x3dh/x3dh.js.map +1 -1
- package/dist/internal/protocol/zk/credentials/credentials.d.ts +3 -54
- package/dist/internal/protocol/zk/credentials/credentials.d.ts.map +1 -1
- package/dist/internal/protocol/zk/credentials/credentials.js +4 -91
- package/dist/internal/protocol/zk/credentials/credentials.js.map +1 -1
- package/dist/internal/protocol/zk/credentials/endorsements.d.ts +3 -64
- package/dist/internal/protocol/zk/credentials/endorsements.d.ts.map +1 -1
- package/dist/internal/protocol/zk/credentials/endorsements.js +4 -134
- package/dist/internal/protocol/zk/credentials/endorsements.js.map +1 -1
- package/dist/internal/protocol/zk/credentials/index.d.ts +3 -3
- package/dist/internal/protocol/zk/credentials/index.d.ts.map +1 -1
- package/dist/internal/protocol/zk/credentials/index.js +3 -3
- package/dist/internal/protocol/zk/credentials/index.js.map +1 -1
- package/dist/internal/protocol/zk/credentials/issuance.d.ts +3 -26
- package/dist/internal/protocol/zk/credentials/issuance.d.ts.map +1 -1
- package/dist/internal/protocol/zk/credentials/issuance.js +3 -80
- package/dist/internal/protocol/zk/credentials/issuance.js.map +1 -1
- package/dist/internal/protocol/zk/credentials/presentation.d.ts +4 -73
- package/dist/internal/protocol/zk/credentials/presentation.d.ts.map +1 -1
- package/dist/internal/protocol/zk/credentials/presentation.js +4 -152
- package/dist/internal/protocol/zk/credentials/presentation.js.map +1 -1
- package/dist/internal/protocol/zk/groups/auth-credential.d.ts +1 -61
- package/dist/internal/protocol/zk/groups/auth-credential.d.ts.map +1 -1
- package/dist/internal/protocol/zk/groups/auth-credential.js +2 -196
- package/dist/internal/protocol/zk/groups/auth-credential.js.map +1 -1
- package/dist/internal/protocol/zk/groups/group-send-endorsement.d.ts +1 -86
- package/dist/internal/protocol/zk/groups/group-send-endorsement.d.ts.map +1 -1
- package/dist/internal/protocol/zk/groups/group-send-endorsement.js +1 -152
- package/dist/internal/protocol/zk/groups/group-send-endorsement.js.map +1 -1
- package/dist/internal/protocol/zk/groups/index.d.ts +4 -4
- package/dist/internal/protocol/zk/groups/index.d.ts.map +1 -1
- package/dist/internal/protocol/zk/groups/index.js +4 -4
- package/dist/internal/protocol/zk/groups/index.js.map +1 -1
- package/dist/internal/protocol/zk/groups/profile-key-credential.d.ts +2 -57
- package/dist/internal/protocol/zk/groups/profile-key-credential.d.ts.map +1 -1
- package/dist/internal/protocol/zk/groups/profile-key-credential.js +2 -174
- package/dist/internal/protocol/zk/groups/profile-key-credential.js.map +1 -1
- package/dist/internal/protocol/zk/groups/server-params.d.ts +8 -72
- package/dist/internal/protocol/zk/groups/server-params.d.ts.map +1 -1
- package/dist/internal/protocol/zk/groups/server-params.js +8 -108
- package/dist/internal/protocol/zk/groups/server-params.js.map +1 -1
- package/dist/internal/protocol/zk/proofs/sign.d.ts +1 -2
- package/dist/internal/protocol/zk/proofs/sign.d.ts.map +1 -1
- package/dist/internal/protocol/zk/proofs/sign.js +2 -11
- package/dist/internal/protocol/zk/proofs/sign.js.map +1 -1
- package/dist/internal/session/ratchet.d.ts.map +1 -1
- package/dist/internal/session/ratchet.js +0 -2
- package/dist/internal/session/ratchet.js.map +1 -1
- package/dist/local/store/key-value/adapter.d.ts +3 -3
- package/dist/local/store/key-value/adapter.d.ts.map +1 -1
- package/dist/local/store/key-value/adapter.js +30 -15
- package/dist/local/store/key-value/adapter.js.map +1 -1
- package/dist/local/store/key-value/backend-conformance.d.ts.map +1 -1
- package/dist/local/store/key-value/backend-conformance.js +25 -0
- package/dist/local/store/key-value/backend-conformance.js.map +1 -1
- package/dist/local/store/key-value/batch.d.ts +3 -1
- package/dist/local/store/key-value/batch.d.ts.map +1 -1
- package/dist/local/store/key-value/batch.js +9 -1
- package/dist/local/store/key-value/batch.js.map +1 -1
- package/dist/local/store/key-value/storage.d.ts +6 -0
- package/dist/local/store/key-value/storage.d.ts.map +1 -1
- package/dist/local/store/key-value/transactional-backend.d.ts +1 -1
- package/dist/local/store/key-value/transactional-backend.js +1 -1
- package/dist/local/store/memory/adapter.d.ts +3 -3
- package/dist/local/store/memory/adapter.d.ts.map +1 -1
- package/dist/local/store/memory/adapter.js +43 -18
- package/dist/local/store/memory/adapter.js.map +1 -1
- package/dist/local/store/sqlite/errors.d.ts +6 -0
- package/dist/local/store/sqlite/errors.d.ts.map +1 -1
- package/dist/local/store/sqlite/errors.js +6 -6
- package/dist/local/store/sqlite/errors.js.map +1 -1
- package/dist/local/store/sqlite/migrations.d.ts.map +1 -1
- package/dist/local/store/sqlite/migrations.js +18 -0
- package/dist/local/store/sqlite/migrations.js.map +1 -1
- package/dist/local/store/sqlite/models/skipped-sender-key.d.ts +3 -3
- package/dist/local/store/sqlite/models/skipped-sender-key.d.ts.map +1 -1
- package/dist/local/store/sqlite/models/skipped-sender-key.js +13 -17
- package/dist/local/store/sqlite/models/skipped-sender-key.js.map +1 -1
- package/dist/local/store/sqlite/store.d.ts +3 -3
- package/dist/local/store/sqlite/store.d.ts.map +1 -1
- package/dist/local/store/sqlite/store.js +17 -9
- package/dist/local/store/sqlite/store.js.map +1 -1
- package/dist/local/store/web/adapter.d.ts +3 -3
- package/dist/local/store/web/adapter.d.ts.map +1 -1
- package/dist/local/store/web/adapter.js +59 -20
- package/dist/local/store/web/adapter.js.map +1 -1
- package/dist/profile/contact-state.d.ts +0 -3
- package/dist/profile/contact-state.d.ts.map +1 -1
- package/dist/profile/contact-state.js +1 -32
- package/dist/profile/contact-state.js.map +1 -1
- package/dist/profile/index.d.ts +2 -1
- package/dist/profile/index.d.ts.map +1 -1
- package/dist/profile/index.js +2 -1
- package/dist/profile/index.js.map +1 -1
- package/dist/profile/unidentified-access.d.ts +12 -0
- package/dist/profile/unidentified-access.d.ts.map +1 -0
- package/dist/profile/unidentified-access.js +42 -0
- package/dist/profile/unidentified-access.js.map +1 -0
- package/dist/remote/relay/index.d.ts +4 -7
- package/dist/remote/relay/index.d.ts.map +1 -1
- package/dist/remote/relay/index.js +5 -7
- package/dist/remote/relay/index.js.map +1 -1
- package/dist/remote/relay/types.d.ts +3 -3
- package/dist/types/api.d.ts +29 -8
- package/dist/types/api.d.ts.map +1 -1
- package/dist/types/errors.d.ts +6 -0
- package/dist/types/errors.d.ts.map +1 -1
- package/dist/types/errors.js +6 -6
- package/dist/types/errors.js.map +1 -1
- package/dist/versions.d.ts +3 -3
- package/dist/versions.js +3 -3
- package/dist/zk/credentials.d.ts +2 -2
- package/dist/zk/credentials.js +2 -2
- package/dist/zk/groups.d.ts +3 -3
- package/dist/zk/groups.d.ts.map +1 -1
- package/dist/zk/groups.js +3 -3
- package/dist/zk/groups.js.map +1 -1
- package/docs/ASSURANCE.md +12 -14
- package/docs/CLIENT_COMPOSITION.md +11 -3
- package/docs/DEVIATIONS.md +24 -25
- package/docs/GETTING_STARTED.md +61 -323
- package/docs/INTERFACES.md +7 -7
- package/docs/PACKAGE_SURFACE.md +14 -16
- package/docs/RECIPES.md +7 -112
- package/groups/README.md +9 -1
- package/local/store/README.md +26 -6
- package/package.json +2 -31
- package/remote/README.md +14 -78
- package/remote/object-store/convex-r2/README.md +17 -49
- package/remote/relay/README.md +24 -18
- package/zk/README.md +6 -7
- package/dist/client/dual-store.d.ts +0 -70
- package/dist/client/dual-store.d.ts.map +0 -1
- package/dist/client/dual-store.js +0 -123
- package/dist/client/dual-store.js.map +0 -1
- package/dist/client/multi-device.d.ts +0 -74
- package/dist/client/multi-device.d.ts.map +0 -1
- package/dist/client/multi-device.js +0 -105
- package/dist/client/multi-device.js.map +0 -1
- package/dist/groups/server.d.ts +0 -10
- package/dist/groups/server.d.ts.map +0 -1
- package/dist/groups/server.js +0 -6
- package/dist/groups/server.js.map +0 -1
- package/dist/internal/encoding/index.d.ts +0 -2
- package/dist/internal/encoding/index.d.ts.map +0 -1
- package/dist/internal/encoding/index.js +0 -2
- package/dist/internal/encoding/index.js.map +0 -1
- package/dist/internal/groups/server-engine.d.ts +0 -118
- package/dist/internal/groups/server-engine.d.ts.map +0 -1
- package/dist/internal/groups/server-engine.js +0 -1268
- package/dist/internal/groups/server-engine.js.map +0 -1
- package/dist/internal/protocol/index.d.ts +0 -24
- package/dist/internal/protocol/index.d.ts.map +0 -1
- package/dist/internal/protocol/index.js +0 -9
- package/dist/internal/protocol/index.js.map +0 -1
- package/dist/internal/protocol/sealed-sender/trust-root.d.ts +0 -56
- package/dist/internal/protocol/sealed-sender/trust-root.d.ts.map +0 -1
- package/dist/internal/protocol/sealed-sender/trust-root.js +0 -90
- package/dist/internal/protocol/sealed-sender/trust-root.js.map +0 -1
- package/dist/internal/protocol/triple-ratchet/index.d.ts +0 -21
- package/dist/internal/protocol/triple-ratchet/index.d.ts.map +0 -1
- package/dist/internal/protocol/triple-ratchet/index.js +0 -19
- package/dist/internal/protocol/triple-ratchet/index.js.map +0 -1
- package/dist/internal/protocol/triple-ratchet/ratchet.d.ts +0 -233
- package/dist/internal/protocol/triple-ratchet/ratchet.d.ts.map +0 -1
- package/dist/internal/protocol/triple-ratchet/ratchet.js +0 -254
- package/dist/internal/protocol/triple-ratchet/ratchet.js.map +0 -1
- package/dist/internal/protocol/zk/proofs/index.d.ts +0 -13
- package/dist/internal/protocol/zk/proofs/index.d.ts.map +0 -1
- package/dist/internal/protocol/zk/proofs/index.js +0 -7
- package/dist/internal/protocol/zk/proofs/index.js.map +0 -1
- package/dist/local/store/sqlite/index.d.ts +0 -20
- package/dist/local/store/sqlite/index.d.ts.map +0 -1
- package/dist/local/store/sqlite/index.js +0 -18
- package/dist/local/store/sqlite/index.js.map +0 -1
- package/dist/remote/object-store/convex-r2/server/index.d.ts +0 -2
- package/dist/remote/object-store/convex-r2/server/index.d.ts.map +0 -1
- package/dist/remote/object-store/convex-r2/server/index.js +0 -2
- package/dist/remote/object-store/convex-r2/server/index.js.map +0 -1
- package/dist/remote/object-store/convex-r2/server.d.ts +0 -129
- package/dist/remote/object-store/convex-r2/server.d.ts.map +0 -1
- package/dist/remote/object-store/convex-r2/server.js +0 -244
- package/dist/remote/object-store/convex-r2/server.js.map +0 -1
- package/dist/remote/relay/memory/adapter.d.ts +0 -252
- package/dist/remote/relay/memory/adapter.d.ts.map +0 -1
- package/dist/remote/relay/memory/adapter.js +0 -1057
- package/dist/remote/relay/memory/adapter.js.map +0 -1
- package/dist/remote/relay/memory/failures.d.ts +0 -58
- package/dist/remote/relay/memory/failures.d.ts.map +0 -1
- package/dist/remote/relay/memory/failures.js +0 -124
- package/dist/remote/relay/memory/failures.js.map +0 -1
- package/dist/remote/relay/memory/group-server.d.ts +0 -13
- package/dist/remote/relay/memory/group-server.d.ts.map +0 -1
- package/dist/remote/relay/memory/group-server.js +0 -19
- package/dist/remote/relay/memory/group-server.js.map +0 -1
- package/dist/remote/relay/memory/index.d.ts +0 -11
- package/dist/remote/relay/memory/index.d.ts.map +0 -1
- package/dist/remote/relay/memory/index.js +0 -7
- package/dist/remote/relay/memory/index.js.map +0 -1
- package/examples/browser/README.md +0 -35
- package/examples/browser/index.html +0 -27
- package/examples/browser/src/exchange.ts +0 -69
- package/examples/browser/src/main.ts +0 -63
- package/examples/browser/src/style.css +0 -9
- package/examples/browser/src/worker.ts +0 -10
- package/examples/browser/vite.config.ts +0 -9
- package/remote/relay/memory/README.md +0 -72
- 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).
|
package/scripts/oe-groups.mjs
DELETED
|
@@ -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
|
-
}
|