@open-e2ee/signal-protocol-sdk 0.3.0 → 1.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.
- package/ADAPTERS.md +7 -0
- package/ARCHITECTURE.md +2 -0
- package/CHANGELOG.md +96 -5
- package/README.md +67 -102
- package/SECURITY.md +2 -2
- package/THIRD_PARTY_NOTICES.md +1 -1
- package/TROUBLESHOOTING.md +7 -0
- package/blocking/README.md +1 -0
- package/client/README.md +10 -0
- package/device/README.md +12 -5
- package/dist/client/client.d.ts +3 -2
- package/dist/client/client.d.ts.map +1 -1
- package/dist/client/client.js +58 -25
- package/dist/client/client.js.map +1 -1
- package/dist/client/config.d.ts +46 -7
- package/dist/client/config.d.ts.map +1 -1
- package/dist/client/config.js +2 -2
- package/dist/client/config.js.map +1 -1
- package/dist/client/group-outbox.d.ts +38 -0
- package/dist/client/group-outbox.d.ts.map +1 -0
- package/dist/client/group-outbox.js +221 -0
- package/dist/client/group-outbox.js.map +1 -0
- package/dist/client/group-sealed-sender.d.ts +28 -0
- package/dist/client/group-sealed-sender.d.ts.map +1 -0
- package/dist/client/group-sealed-sender.js +74 -0
- package/dist/client/group-sealed-sender.js.map +1 -0
- package/dist/client/groups.d.ts.map +1 -1
- package/dist/client/groups.js +14 -4
- package/dist/client/groups.js.map +1 -1
- package/dist/client/hosted-push.d.ts +77 -0
- package/dist/client/hosted-push.d.ts.map +1 -0
- package/dist/client/hosted-push.js +90 -0
- package/dist/client/hosted-push.js.map +1 -0
- package/dist/client/hosted.d.ts +207 -0
- package/dist/client/hosted.d.ts.map +1 -0
- package/dist/client/hosted.js +505 -0
- package/dist/client/hosted.js.map +1 -0
- package/dist/client/index.d.ts +4 -2
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js +2 -0
- package/dist/client/index.js.map +1 -1
- package/dist/client/relay-subscription.d.ts.map +1 -1
- package/dist/client/relay-subscription.js +34 -7
- package/dist/client/relay-subscription.js.map +1 -1
- package/dist/client/{sealed-sender-ops.d.ts → sealed-sender.d.ts} +39 -22
- package/dist/client/sealed-sender.d.ts.map +1 -0
- package/dist/client/sealed-sender.js +296 -0
- package/dist/client/sealed-sender.js.map +1 -0
- package/dist/client/signal-service-cipher.d.ts +23 -26
- package/dist/client/signal-service-cipher.d.ts.map +1 -1
- package/dist/client/signal-service-cipher.js +465 -706
- package/dist/client/signal-service-cipher.js.map +1 -1
- package/dist/client/types.d.ts +18 -3
- package/dist/client/types.d.ts.map +1 -1
- package/dist/client/types.js +6 -0
- package/dist/client/types.js.map +1 -1
- package/dist/device/index.d.ts +2 -2
- package/dist/device/index.d.ts.map +1 -1
- package/dist/device/index.js +1 -1
- package/dist/device/index.js.map +1 -1
- package/dist/device/transfer.d.ts +7 -43
- package/dist/device/transfer.d.ts.map +1 -1
- package/dist/device/transfer.js +31 -150
- package/dist/device/transfer.js.map +1 -1
- package/dist/device/types.d.ts +6 -47
- package/dist/device/types.d.ts.map +1 -1
- package/dist/device/types.js +1 -1
- package/dist/device/types.js.map +1 -1
- package/dist/index.d.ts +5 -4
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +5 -5
- package/dist/index.js.map +1 -1
- package/dist/internal/encoding/proto/pq-ratchet-serialize.js +1 -1
- package/dist/internal/encoding/proto/pq-ratchet-serialize.js.map +1 -1
- package/dist/internal/encoding/proto/primitives.js +1 -1
- package/dist/internal/encoding/proto/primitives.js.map +1 -1
- package/dist/internal/groups/manager.d.ts +3 -3
- package/dist/internal/groups/manager.d.ts.map +1 -1
- package/dist/internal/groups/manager.js +5 -4
- package/dist/internal/groups/manager.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/certificate.d.ts +10 -4
- package/dist/internal/protocol/sealed-sender/certificate.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/certificate.js +64 -7
- package/dist/internal/protocol/sealed-sender/certificate.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/decryption.d.ts +34 -47
- package/dist/internal/protocol/sealed-sender/decryption.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/decryption.js +95 -182
- package/dist/internal/protocol/sealed-sender/decryption.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/encryption.d.ts +49 -64
- package/dist/internal/protocol/sealed-sender/encryption.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/encryption.js +120 -123
- package/dist/internal/protocol/sealed-sender/encryption.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/index.d.ts +5 -7
- package/dist/internal/protocol/sealed-sender/index.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/index.js +4 -12
- package/dist/internal/protocol/sealed-sender/index.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/{v2-helpers.d.ts → multi-recipient-crypto.d.ts} +1 -1
- package/dist/internal/protocol/sealed-sender/multi-recipient-crypto.d.ts.map +1 -0
- package/dist/internal/protocol/sealed-sender/{v2-helpers.js → multi-recipient-crypto.js} +1 -1
- package/dist/internal/protocol/sealed-sender/multi-recipient-crypto.js.map +1 -0
- package/dist/internal/protocol/sealed-sender/{v2-binary.d.ts → multi-recipient-message.d.ts} +3 -2
- package/dist/internal/protocol/sealed-sender/multi-recipient-message.d.ts.map +1 -0
- package/dist/internal/protocol/sealed-sender/{v2-binary.js → multi-recipient-message.js} +16 -8
- package/dist/internal/protocol/sealed-sender/multi-recipient-message.js.map +1 -0
- package/dist/internal/protocol/sealed-sender/proto/index.d.ts +3 -0
- package/dist/internal/protocol/sealed-sender/proto/index.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/proto/index.js +25 -2
- package/dist/internal/protocol/sealed-sender/proto/index.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/trust-root.d.ts +11 -1
- package/dist/internal/protocol/sealed-sender/trust-root.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/trust-root.js +13 -1
- package/dist/internal/protocol/sealed-sender/trust-root.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/types.d.ts +20 -135
- package/dist/internal/protocol/sealed-sender/types.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/types.js +15 -6
- package/dist/internal/protocol/sealed-sender/types.js.map +1 -1
- package/dist/internal/protocol/sender-keys/manager.d.ts +22 -1
- package/dist/internal/protocol/sender-keys/manager.d.ts.map +1 -1
- package/dist/internal/protocol/sender-keys/manager.js +39 -4
- package/dist/internal/protocol/sender-keys/manager.js.map +1 -1
- package/dist/internal/protocol/spqr/braid-serialize.js +1 -1
- package/dist/internal/protocol/spqr/braid-serialize.js.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/state-machine.js +4 -4
- package/dist/internal/protocol/spqr/ml-kem-braid/state-machine.js.map +1 -1
- package/dist/internal/protocol/zk/groups/index.d.ts +1 -1
- package/dist/internal/protocol/zk/groups/index.d.ts.map +1 -1
- package/dist/internal/protocol/zk/groups/index.js +1 -1
- package/dist/internal/protocol/zk/groups/index.js.map +1 -1
- package/dist/internal/protocol/zk/groups/profile-key-credential.d.ts +37 -12
- package/dist/internal/protocol/zk/groups/profile-key-credential.d.ts.map +1 -1
- package/dist/internal/protocol/zk/groups/profile-key-credential.js +104 -31
- package/dist/internal/protocol/zk/groups/profile-key-credential.js.map +1 -1
- package/dist/internal/sesame/types.d.ts +0 -2
- package/dist/internal/sesame/types.d.ts.map +1 -1
- package/dist/internal/sesame/types.js +0 -2
- package/dist/internal/sesame/types.js.map +1 -1
- package/dist/local/store/expo/adapter.d.ts +1 -0
- package/dist/local/store/expo/adapter.d.ts.map +1 -1
- package/dist/local/store/expo/adapter.js +3 -0
- package/dist/local/store/expo/adapter.js.map +1 -1
- package/dist/local/store/expo/key-storage.d.ts +1 -0
- package/dist/local/store/expo/key-storage.d.ts.map +1 -1
- package/dist/local/store/expo/key-storage.js +4 -0
- package/dist/local/store/expo/key-storage.js.map +1 -1
- package/dist/local/store/memory/adapter.d.ts +1 -0
- package/dist/local/store/memory/adapter.d.ts.map +1 -1
- package/dist/local/store/memory/adapter.js +4 -0
- package/dist/local/store/memory/adapter.js.map +1 -1
- package/dist/local/store/node/adapter.d.ts +1 -0
- package/dist/local/store/node/adapter.d.ts.map +1 -1
- package/dist/local/store/node/adapter.js +3 -0
- package/dist/local/store/node/adapter.js.map +1 -1
- package/dist/local/store/node/database.d.ts +1 -0
- package/dist/local/store/node/database.d.ts.map +1 -1
- package/dist/local/store/node/database.js +5 -0
- package/dist/local/store/node/database.js.map +1 -1
- package/dist/local/store/react-native/adapter.d.ts +1 -0
- package/dist/local/store/react-native/adapter.d.ts.map +1 -1
- package/dist/local/store/react-native/adapter.js +4 -0
- package/dist/local/store/react-native/adapter.js.map +1 -1
- package/dist/local/store/react-native/reference-backend.js +1 -1
- package/dist/local/store/react-native/reference-backend.js.map +1 -1
- package/dist/local/store/reliability.d.ts +63 -0
- package/dist/local/store/reliability.d.ts.map +1 -0
- package/dist/local/store/reliability.js +219 -0
- package/dist/local/store/reliability.js.map +1 -0
- package/dist/local/store/web/adapter.d.ts +1 -0
- package/dist/local/store/web/adapter.d.ts.map +1 -1
- package/dist/local/store/web/adapter.js +5 -0
- package/dist/local/store/web/adapter.js.map +1 -1
- package/dist/media/index.d.ts +0 -1
- package/dist/media/index.d.ts.map +1 -1
- package/dist/media/index.js +0 -1
- package/dist/media/index.js.map +1 -1
- package/dist/remote/relay/convex/backend.d.ts +6 -16
- package/dist/remote/relay/convex/backend.d.ts.map +1 -1
- package/dist/remote/relay/convex/backend.js +12 -21
- package/dist/remote/relay/convex/backend.js.map +1 -1
- package/dist/remote/relay/convex/component/_generated/component.d.ts +9 -16
- package/dist/remote/relay/convex/component/_generated/component.d.ts.map +1 -1
- package/dist/remote/relay/convex/component/certificates.d.ts.map +1 -1
- package/dist/remote/relay/convex/component/certificates.js +14 -5
- package/dist/remote/relay/convex/component/certificates.js.map +1 -1
- package/dist/remote/relay/convex/component/messages.d.ts +2 -15
- package/dist/remote/relay/convex/component/messages.d.ts.map +1 -1
- package/dist/remote/relay/convex/component/messages.js +14 -48
- package/dist/remote/relay/convex/component/messages.js.map +1 -1
- package/dist/remote/relay/convex/component/schema.d.ts +5 -3
- package/dist/remote/relay/convex/component/schema.js +2 -1
- package/dist/remote/relay/convex/component/schema.js.map +1 -1
- package/dist/remote/relay/convex/component/zkAuth.d.ts +7 -1
- package/dist/remote/relay/convex/component/zkAuth.d.ts.map +1 -1
- package/dist/remote/relay/convex/component/zkAuth.js +29 -14
- package/dist/remote/relay/convex/component/zkAuth.js.map +1 -1
- package/dist/remote/relay/convex/relay.d.ts +2 -5
- package/dist/remote/relay/convex/relay.d.ts.map +1 -1
- package/dist/remote/relay/convex/relay.js +17 -47
- package/dist/remote/relay/convex/relay.js.map +1 -1
- package/dist/remote/relay/memory/adapter.d.ts +4 -10
- package/dist/remote/relay/memory/adapter.d.ts.map +1 -1
- package/dist/remote/relay/memory/adapter.js +31 -34
- package/dist/remote/relay/memory/adapter.js.map +1 -1
- package/dist/remote/relay/types.d.ts +6 -19
- package/dist/remote/relay/types.d.ts.map +1 -1
- package/dist/types/api.d.ts +2 -0
- package/dist/types/api.d.ts.map +1 -1
- package/dist/types/errors.d.ts +3 -1
- package/dist/types/errors.d.ts.map +1 -1
- package/dist/types/errors.js +4 -2
- package/dist/types/errors.js.map +1 -1
- package/dist/types/protocol-config.d.ts +1 -1
- package/dist/username/link.d.ts.map +1 -1
- package/dist/username/link.js +1 -1
- package/dist/username/link.js.map +1 -1
- package/dist/utils/retry.d.ts +2 -1
- package/dist/utils/retry.d.ts.map +1 -1
- package/dist/utils/retry.js +2 -1
- package/dist/utils/retry.js.map +1 -1
- package/docs/ASSURANCE.md +16 -10
- package/docs/CLIENT_COMPOSITION.md +3 -0
- package/docs/DEVIATIONS.md +32 -61
- package/docs/DOCUMENTATION_STANDARDS.md +28 -0
- package/docs/ERROR_HANDLING.md +91 -60
- package/docs/GETTING_STARTED.md +27 -1
- package/docs/INTERFACES.md +5 -0
- package/docs/PACKAGE_SURFACE.md +1 -0
- package/docs/PROTOCOL_POLICY.md +6 -0
- package/docs/RECIPES.md +9 -0
- package/docs/SECURITY.md +6 -0
- package/encoding/README.md +1 -0
- package/files/README.md +1 -0
- package/groups/README.md +1 -0
- package/keys/README.md +2 -0
- package/local/store/README.md +2 -0
- package/local/store/expo/README.md +2 -0
- package/local/store/memory/README.md +2 -0
- package/local/store/node/README.md +1 -0
- package/local/store/react-native/README.md +2 -0
- package/local/store/web/README.md +1 -0
- package/local/vault/README.md +1 -0
- package/media/README.md +2 -0
- package/package.json +4 -2
- package/profile/README.md +1 -0
- package/remote/README.md +6 -0
- package/remote/object-store/README.md +1 -0
- package/remote/object-store/convex-r2/README.md +2 -0
- package/remote/object-store/s3/README.md +1 -0
- package/remote/relay/README.md +2 -0
- package/remote/relay/convex/README.md +1 -0
- package/remote/relay/convex/component/README.md +29 -14
- package/remote/relay/memory/README.md +2 -0
- package/safety/README.md +1 -0
- package/scripts/oe-groups.mjs +5 -1
- package/sealed-sender/README.md +1 -0
- package/types/README.md +1 -0
- package/username/README.md +1 -0
- package/utils/README.md +1 -0
- package/zk/README.md +1 -0
- package/dist/client/sealed-sender-ops.d.ts.map +0 -1
- package/dist/client/sealed-sender-ops.js +0 -203
- package/dist/client/sealed-sender-ops.js.map +0 -1
- package/dist/internal/protocol/sealed-sender/decryption-v2.d.ts +0 -46
- package/dist/internal/protocol/sealed-sender/decryption-v2.d.ts.map +0 -1
- package/dist/internal/protocol/sealed-sender/decryption-v2.js +0 -198
- package/dist/internal/protocol/sealed-sender/decryption-v2.js.map +0 -1
- package/dist/internal/protocol/sealed-sender/encryption-v2.d.ts +0 -56
- package/dist/internal/protocol/sealed-sender/encryption-v2.d.ts.map +0 -1
- package/dist/internal/protocol/sealed-sender/encryption-v2.js +0 -163
- package/dist/internal/protocol/sealed-sender/encryption-v2.js.map +0 -1
- package/dist/internal/protocol/sealed-sender/v2-binary.d.ts.map +0 -1
- package/dist/internal/protocol/sealed-sender/v2-binary.js.map +0 -1
- package/dist/internal/protocol/sealed-sender/v2-helpers.d.ts.map +0 -1
- package/dist/internal/protocol/sealed-sender/v2-helpers.js.map +0 -1
package/local/store/README.md
CHANGED
|
@@ -142,6 +142,7 @@ state, retry message records, and recovery helpers.
|
|
|
142
142
|
|
|
143
143
|
## Composition
|
|
144
144
|
|
|
145
|
+
<!-- doc-snippet:skip requires-external-context -->
|
|
145
146
|
```ts
|
|
146
147
|
import { SignalProtocolClient } from '@open-e2ee/signal-protocol-sdk';
|
|
147
148
|
import { ExpoSignalProtocolStore } from '@open-e2ee/signal-protocol-sdk/local/store/expo';
|
|
@@ -169,6 +170,7 @@ An `ISignalProtocolLocalStore` implementation must preserve:
|
|
|
169
170
|
|
|
170
171
|
The current persisted session record shape is version `4`:
|
|
171
172
|
|
|
173
|
+
<!-- doc-snippet:skip requires-external-context -->
|
|
172
174
|
```ts
|
|
173
175
|
interface SessionRecord {
|
|
174
176
|
currentSession: SessionState | null;
|
|
@@ -18,6 +18,7 @@ Compose the exported table definitions into the application schema, configure
|
|
|
18
18
|
the database bindings once during bootstrap, and apply the database key before
|
|
19
19
|
the first query:
|
|
20
20
|
|
|
21
|
+
<!-- doc-snippet:skip requires-external-context -->
|
|
21
22
|
```ts
|
|
22
23
|
import {
|
|
23
24
|
configureSignalProtocolExpoDbBindings,
|
|
@@ -65,6 +66,7 @@ Do not back these tables up to a server or sync them between devices.
|
|
|
65
66
|
|
|
66
67
|
## Client usage
|
|
67
68
|
|
|
69
|
+
<!-- doc-snippet:skip requires-external-context -->
|
|
68
70
|
```ts
|
|
69
71
|
import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
70
72
|
import { expoStore } from "@open-e2ee/signal-protocol-sdk/local/store/expo";
|
|
@@ -14,6 +14,7 @@ security or persistence boundary.
|
|
|
14
14
|
|
|
15
15
|
## Usage
|
|
16
16
|
|
|
17
|
+
<!-- doc-snippet:run memory-store-client expect="" -->
|
|
17
18
|
```ts
|
|
18
19
|
// Real protocol and cryptography; simulated in-memory infrastructure.
|
|
19
20
|
import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
@@ -33,6 +34,7 @@ application discards the adapter. Never use this adapter for production accounts
|
|
|
33
34
|
Failure mode is opt-in. A seed and cadence replay the same failing writes, or
|
|
34
35
|
you can target the next named store operation:
|
|
35
36
|
|
|
37
|
+
<!-- doc-snippet:run memory-store-failure-injection expect="" -->
|
|
36
38
|
```ts
|
|
37
39
|
// Real protocol and cryptography; simulated in-memory infrastructure.
|
|
38
40
|
import {
|
|
@@ -20,6 +20,7 @@ boundary while allowing each deployment to choose an explicit data directory.
|
|
|
20
20
|
|
|
21
21
|
## Usage
|
|
22
22
|
|
|
23
|
+
<!-- doc-snippet:skip requires-external-context -->
|
|
23
24
|
```ts
|
|
24
25
|
import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
25
26
|
import { nodeStore } from "@open-e2ee/signal-protocol-sdk/local/store/node";
|
|
@@ -11,6 +11,7 @@ needed for trust, session, and one-time-prekey transitions.
|
|
|
11
11
|
|
|
12
12
|
## Usage
|
|
13
13
|
|
|
14
|
+
<!-- doc-snippet:skip requires-external-context -->
|
|
14
15
|
```ts
|
|
15
16
|
import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
16
17
|
import {
|
|
@@ -40,6 +41,7 @@ your application supplies. The package therefore exports a
|
|
|
40
41
|
backend-conformance kit. Run it against your backend from your application's
|
|
41
42
|
own tests:
|
|
42
43
|
|
|
44
|
+
<!-- doc-snippet:skip requires-external-context -->
|
|
43
45
|
```ts
|
|
44
46
|
import {
|
|
45
47
|
assertBackendConformance,
|
|
@@ -11,6 +11,7 @@ the browser-origin threat model explicit.
|
|
|
11
11
|
|
|
12
12
|
## Usage
|
|
13
13
|
|
|
14
|
+
<!-- doc-snippet:skip requires-external-context -->
|
|
14
15
|
```ts
|
|
15
16
|
import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
16
17
|
import { indexedDbStore } from "@open-e2ee/signal-protocol-sdk/local/store/web";
|
package/local/vault/README.md
CHANGED
package/media/README.md
CHANGED
|
@@ -18,6 +18,7 @@ The remote object store never receives the media key or plaintext.
|
|
|
18
18
|
|
|
19
19
|
## Upload and send
|
|
20
20
|
|
|
21
|
+
<!-- doc-snippet:skip requires-external-context -->
|
|
21
22
|
```ts
|
|
22
23
|
import {
|
|
23
24
|
createMediaAttachmentMessage,
|
|
@@ -43,6 +44,7 @@ await signal.send(
|
|
|
43
44
|
|
|
44
45
|
## Receive and open
|
|
45
46
|
|
|
47
|
+
<!-- doc-snippet:skip requires-external-context -->
|
|
46
48
|
```ts
|
|
47
49
|
import {
|
|
48
50
|
parseMediaAttachmentMessage,
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@open-e2ee/signal-protocol-sdk",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "1.0.0",
|
|
4
4
|
"description": "Signal Protocol E2EE SDK for TypeScript — Expo, React Native, browser, and Node. Post-quantum PQXDH and Double Ratchet.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"open-e2ee",
|
|
@@ -353,7 +353,8 @@
|
|
|
353
353
|
"build:fix-esm": "node ./scripts/fix-esm-specifiers.mjs ./dist",
|
|
354
354
|
"clean": "rm -rf dist",
|
|
355
355
|
"typecheck": "tsc --noEmit -p tsconfig.build.json",
|
|
356
|
-
"docs:api": "npx -y -p typedoc@0.28 -p typedoc-plugin-markdown@4 -p typescript@5.8 typedoc && node ./scripts/normalize-api-doc-paths.mjs",
|
|
356
|
+
"docs:api": "npx -y -p typedoc@0.28.20 -p typedoc-plugin-markdown@4.12.0 -p typescript@5.8.3 typedoc && node ./scripts/normalize-api-doc-paths.mjs",
|
|
357
|
+
"docs:api:check": "npm run docs:api && git diff --exit-code -- docs/api && test -z \"$(git ls-files --others --exclude-standard docs/api)\"",
|
|
357
358
|
"prepare": "npm run build",
|
|
358
359
|
"prepublishOnly": "npm run build"
|
|
359
360
|
},
|
|
@@ -435,6 +436,7 @@
|
|
|
435
436
|
"devDependencies": {
|
|
436
437
|
"@convex-dev/r2": "^0.10.2",
|
|
437
438
|
"@convex-dev/rate-limiter": "^0.3.2",
|
|
439
|
+
"@swc/core": "^1.15.43",
|
|
438
440
|
"@types/async-lock": "^1.4.0",
|
|
439
441
|
"@types/node": "^22.0.0",
|
|
440
442
|
"@types/react": "^19.0.0",
|
package/profile/README.md
CHANGED
package/remote/README.md
CHANGED
|
@@ -29,6 +29,7 @@ replaceable and prevent them from owning private keys or plaintext.
|
|
|
29
29
|
|
|
30
30
|
## Composition
|
|
31
31
|
|
|
32
|
+
<!-- doc-snippet:skip requires-production-adapters -->
|
|
32
33
|
```ts
|
|
33
34
|
import { SignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
34
35
|
import {
|
|
@@ -95,6 +96,7 @@ application installs, mounts, and configures `@convex-dev/r2`, owns the R2
|
|
|
95
96
|
bucket and credentials, and exposes authenticated app-owned functions for
|
|
96
97
|
create, download, completion, and deletion.
|
|
97
98
|
|
|
99
|
+
<!-- doc-snippet:skip requires-external-context -->
|
|
98
100
|
```ts
|
|
99
101
|
import { SignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
100
102
|
import { convexR2ObjectStore } from "@open-e2ee/signal-protocol-sdk/remote/object-store/convex-r2";
|
|
@@ -118,6 +120,7 @@ time-sensitive credentials or await provider metadata. The functions
|
|
|
118
120
|
The optional server entry point removes repetitive broker plumbing without
|
|
119
121
|
taking ownership away from the application:
|
|
120
122
|
|
|
123
|
+
<!-- doc-snippet:skip requires-external-context -->
|
|
121
124
|
```ts
|
|
122
125
|
// convex/signalObjectStore.ts
|
|
123
126
|
import { R2 } from "@convex-dev/r2";
|
|
@@ -174,6 +177,7 @@ on that backend. The broker follows the same identity contract: it receives a
|
|
|
174
177
|
retry-stable `requestId`, reserves the private provider key, and returns the
|
|
175
178
|
canonical `objectId`.
|
|
176
179
|
|
|
180
|
+
<!-- doc-snippet:skip requires-external-context -->
|
|
177
181
|
```ts
|
|
178
182
|
import { s3ObjectStore } from "@open-e2ee/signal-protocol-sdk/remote/object-store/s3";
|
|
179
183
|
|
|
@@ -194,7 +198,9 @@ needed to authorize and construct short-lived operations.
|
|
|
194
198
|
|
|
195
199
|
Use `InMemorySignalProtocolRelayServer` when multiple clients need a shared in-memory relay:
|
|
196
200
|
|
|
201
|
+
<!-- doc-snippet:run remote-shared-memory-relay expect="" -->
|
|
197
202
|
```ts
|
|
203
|
+
// Real protocol and cryptography; simulated in-memory infrastructure.
|
|
198
204
|
import { SignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
199
205
|
import { InMemorySignalProtocolRelayServer } from "@open-e2ee/signal-protocol-sdk/remote/relay/memory";
|
|
200
206
|
import { InMemorySignalProtocolStore } from "@open-e2ee/signal-protocol-sdk/local/store/memory";
|
|
@@ -13,6 +13,7 @@ component ownership into the SDK.
|
|
|
13
13
|
|
|
14
14
|
## Client usage
|
|
15
15
|
|
|
16
|
+
<!-- doc-snippet:skip requires-external-context -->
|
|
16
17
|
```ts
|
|
17
18
|
import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
18
19
|
import { convexR2ObjectStore } from "@open-e2ee/signal-protocol-sdk/remote/object-store/convex-r2";
|
|
@@ -40,6 +41,7 @@ by `ConvexR2ObjectStoreApi`.
|
|
|
40
41
|
The server-only subpath supplies validators and broker mechanics while keeping
|
|
41
42
|
authorization and persistence in application callbacks:
|
|
42
43
|
|
|
44
|
+
<!-- doc-snippet:skip requires-external-context -->
|
|
43
45
|
```ts
|
|
44
46
|
import { R2 } from "@convex-dev/r2";
|
|
45
47
|
import {
|
package/remote/relay/README.md
CHANGED
|
@@ -13,7 +13,9 @@ plaintext ownership to the backend.
|
|
|
13
13
|
|
|
14
14
|
## Local usage
|
|
15
15
|
|
|
16
|
+
<!-- doc-snippet:run relay-memory-client expect="" -->
|
|
16
17
|
```ts
|
|
18
|
+
// Real protocol and cryptography; simulated in-memory infrastructure.
|
|
17
19
|
import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
18
20
|
import { inMemoryStore } from "@open-e2ee/signal-protocol-sdk/local/store/memory";
|
|
19
21
|
import { inMemoryRelay } from "@open-e2ee/signal-protocol-sdk/remote/relay/memory";
|
|
@@ -21,6 +21,7 @@ functions, retention policy, and operational controls.
|
|
|
21
21
|
Organize the application functions under one generated module namespace, then
|
|
22
22
|
pass that namespace directly:
|
|
23
23
|
|
|
24
|
+
<!-- doc-snippet:skip requires-external-context -->
|
|
24
25
|
```ts
|
|
25
26
|
import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
26
27
|
import {
|
|
@@ -16,6 +16,7 @@ public wrappers.
|
|
|
16
16
|
|
|
17
17
|
Mount the component in the app's Convex configuration:
|
|
18
18
|
|
|
19
|
+
<!-- doc-snippet:skip requires-external-context -->
|
|
19
20
|
```ts
|
|
20
21
|
// convex/convex.config.ts
|
|
21
22
|
import { defineApp } from 'convex/server';
|
|
@@ -89,6 +90,7 @@ O(versions × state size) per group.
|
|
|
89
90
|
Create the wrapper once with the mounted component reference and the app's
|
|
90
91
|
authentication hook:
|
|
91
92
|
|
|
93
|
+
<!-- doc-snippet:skip requires-external-context -->
|
|
92
94
|
```ts
|
|
93
95
|
// convex/relayBackend.ts
|
|
94
96
|
import { components } from './_generated/api';
|
|
@@ -113,6 +115,7 @@ export const signalRelay = defineConvexSignalProtocolBackend(
|
|
|
113
115
|
The relay reads these functions through `api.signal`, so the modules must live
|
|
114
116
|
inside that namespace rather than at the top of `convex/`:
|
|
115
117
|
|
|
118
|
+
<!-- doc-snippet:skip requires-external-context -->
|
|
116
119
|
```ts
|
|
117
120
|
// convex/signal/groups.ts
|
|
118
121
|
import { signalRelay } from '../relayBackend';
|
|
@@ -127,6 +130,7 @@ export const {
|
|
|
127
130
|
} = signalRelay.groups;
|
|
128
131
|
```
|
|
129
132
|
|
|
133
|
+
<!-- doc-snippet:skip requires-external-context -->
|
|
130
134
|
```ts
|
|
131
135
|
// convex/signal/zkAuth.ts
|
|
132
136
|
import { signalRelay } from '../relayBackend';
|
|
@@ -139,6 +143,7 @@ export const {
|
|
|
139
143
|
|
|
140
144
|
Mount the remaining relay namespaces alongside those group modules:
|
|
141
145
|
|
|
146
|
+
<!-- doc-snippet:skip requires-external-context -->
|
|
142
147
|
```ts
|
|
143
148
|
// convex/signal/messages.ts
|
|
144
149
|
import { signalRelay } from '../relayBackend';
|
|
@@ -147,7 +152,6 @@ export const {
|
|
|
147
152
|
getPendingMessages,
|
|
148
153
|
markDelivered,
|
|
149
154
|
getActiveDevices,
|
|
150
|
-
sendUnidentified,
|
|
151
155
|
sendMultiRecipientUnidentified,
|
|
152
156
|
sendRetryRequest,
|
|
153
157
|
getPendingRetryRequests,
|
|
@@ -155,6 +159,7 @@ export const {
|
|
|
155
159
|
} = signalRelay.messages;
|
|
156
160
|
```
|
|
157
161
|
|
|
162
|
+
<!-- doc-snippet:skip requires-external-context -->
|
|
158
163
|
```ts
|
|
159
164
|
// convex/signal/devices.ts
|
|
160
165
|
import { signalRelay } from '../relayBackend';
|
|
@@ -168,6 +173,7 @@ export const {
|
|
|
168
173
|
} = signalRelay.devices;
|
|
169
174
|
```
|
|
170
175
|
|
|
176
|
+
<!-- doc-snippet:skip requires-external-context -->
|
|
171
177
|
```ts
|
|
172
178
|
// convex/signal/keys.ts
|
|
173
179
|
import { signalRelay } from '../relayBackend';
|
|
@@ -185,12 +191,14 @@ export const {
|
|
|
185
191
|
} = signalRelay.keys;
|
|
186
192
|
```
|
|
187
193
|
|
|
194
|
+
<!-- doc-snippet:skip requires-external-context -->
|
|
188
195
|
```ts
|
|
189
196
|
// convex/signal/certificates.ts
|
|
190
197
|
import { signalRelay } from '../relayBackend';
|
|
191
198
|
export const { issueSenderCertificate } = signalRelay.certificates;
|
|
192
199
|
```
|
|
193
200
|
|
|
201
|
+
<!-- doc-snippet:skip requires-external-context -->
|
|
194
202
|
```ts
|
|
195
203
|
// convex/signal/provisioning.ts
|
|
196
204
|
import { signalRelay } from '../relayBackend';
|
|
@@ -223,8 +231,8 @@ issuance also resolves identity. Group wrappers pass client arguments through
|
|
|
223
231
|
untouched because group reads and writes authenticate membership solely through
|
|
224
232
|
the supplied zero-knowledge presentation.
|
|
225
233
|
|
|
226
|
-
`
|
|
227
|
-
|
|
234
|
+
`sendMultiRecipientUnidentified` is the deliberate exception: this
|
|
235
|
+
sealed-sender path does **not** call `identify`. It authorizes
|
|
228
236
|
the bearer request with the target's unidentified-access key or verified group
|
|
229
237
|
send material, which keeps delivery available without an authenticated
|
|
230
238
|
application session. Rejections carry structured `ConvexError` data. The relay
|
|
@@ -321,8 +329,8 @@ Add `--prod` for the default production deployment or
|
|
|
321
329
|
- generates a cryptographically random 32-byte seed only when the secret is
|
|
322
330
|
absent
|
|
323
331
|
- writes the seed to the selected Convex deployment through stdin
|
|
324
|
-
- prints
|
|
325
|
-
|
|
332
|
+
- prints the serialized group trust root, the Ed25519 sender-certificate root,
|
|
333
|
+
and the sender-certificate relay scope as labeled base64 values
|
|
326
334
|
|
|
327
335
|
Pin both in the client build. See
|
|
328
336
|
[Sender certificate trust root](#sender-certificate-trust-root) for where each
|
|
@@ -341,18 +349,21 @@ from the group signing key by distinct KDF labels
|
|
|
341
349
|
(`open-e2ee:sealed-sender:root:v1` / `:server:v1`). Clients verify inbound
|
|
342
350
|
sealed-sender certificates against the matching Ed25519 **root** public key.
|
|
343
351
|
|
|
344
|
-
`oe-groups trust-root` prints both roots,
|
|
352
|
+
`oe-groups trust-root` prints both roots, labeled:
|
|
345
353
|
|
|
346
354
|
```
|
|
347
355
|
group trust root: <base64>
|
|
348
356
|
sealed sender trust root: <base64>
|
|
357
|
+
sealed sender relay scope: <base64>
|
|
349
358
|
```
|
|
350
359
|
|
|
351
360
|
The two roots go in different places and are not interchangeable. The group
|
|
352
361
|
trust root goes into the group configuration, and the sealed-sender root into
|
|
353
|
-
`sealedSender.trustRoots` in the client build.
|
|
354
|
-
|
|
355
|
-
|
|
362
|
+
`sealedSender.trustRoots` in the client build. Put the matching relay scope into
|
|
363
|
+
`sealedSender.relayScopeId`, and configure the operator-owned issuer revocation
|
|
364
|
+
list in `sealedSender.revokedIssuerKeyIds`. Pin these values at build time.
|
|
365
|
+
Never fetch them from a relay at runtime, because a relay that chooses its own
|
|
366
|
+
validation policy can mint certificates for any sender.
|
|
356
367
|
|
|
357
368
|
The component derives both from the same deployment secret, so rotating
|
|
358
369
|
`OE_GROUPS_SERVER_SECRET` rotates both and strands clients pinned to either
|
|
@@ -442,8 +453,12 @@ The component cannot do it while its identity has no device field.
|
|
|
442
453
|
|
|
443
454
|
## Profile-key issuance threat model
|
|
444
455
|
|
|
445
|
-
`issueProfileKeyCredentialMutation` receives
|
|
446
|
-
group server
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
456
|
+
`issueProfileKeyCredentialMutation` receives a 160-byte blinded request bound
|
|
457
|
+
to the authenticated ACI. The group server sees the ACI and redemption window,
|
|
458
|
+
but it does not receive the raw 32-byte profile key or the client's ephemeral
|
|
459
|
+
blinding secret. The client unblinds and verifies the response before it uses
|
|
460
|
+
the credential in a group presentation.
|
|
461
|
+
|
|
462
|
+
`setUnidentifiedAccessKeyMutation` is a separate delivery-authorization seam.
|
|
463
|
+
It receives only the 16-byte access key that the client derives from its
|
|
464
|
+
profile key. Credential issuance does not derive or register that access key.
|
|
@@ -14,6 +14,7 @@ authorization or durability boundary.
|
|
|
14
14
|
|
|
15
15
|
## Usage
|
|
16
16
|
|
|
17
|
+
<!-- doc-snippet:run memory-relay-client expect="" -->
|
|
17
18
|
```ts
|
|
18
19
|
// Real protocol and cryptography; simulated in-memory infrastructure.
|
|
19
20
|
import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
@@ -38,6 +39,7 @@ abuse, or deliver durably. Never use it in production.
|
|
|
38
39
|
Failure mode is opt-in and seeded. The default `inMemoryRelay()` remains the
|
|
39
40
|
deterministic happy path:
|
|
40
41
|
|
|
42
|
+
<!-- doc-snippet:run memory-relay-failure-injection expect="" -->
|
|
41
43
|
```ts
|
|
42
44
|
// Real protocol and cryptography; simulated in-memory infrastructure.
|
|
43
45
|
import { inMemoryRelay } from "@open-e2ee/signal-protocol-sdk/remote/relay/memory";
|
package/safety/README.md
CHANGED
package/scripts/oe-groups.mjs
CHANGED
|
@@ -94,7 +94,7 @@ async function printTrustRoot(args) {
|
|
|
94
94
|
const [
|
|
95
95
|
{ generateServerSecretParams, getServerPublicParams },
|
|
96
96
|
{ encodeGroupTrustRoot },
|
|
97
|
-
{ deriveSealedSenderRootPublicKey },
|
|
97
|
+
{ deriveSealedSenderRootPublicKey, deriveSealedSenderScopeId },
|
|
98
98
|
] = await Promise.all([
|
|
99
99
|
// pathToFileURL: dynamic import of a bare absolute path fails on
|
|
100
100
|
// Windows, where the ESM loader requires a file:// URL.
|
|
@@ -136,6 +136,7 @@ async function printTrustRoot(args) {
|
|
|
136
136
|
const sealedSenderRoot = await deriveSealedSenderRootPublicKey(
|
|
137
137
|
secretParams.signingKeyPair.signingKey
|
|
138
138
|
);
|
|
139
|
+
const sealedSenderScope = await deriveSealedSenderScopeId(sealedSenderRoot);
|
|
139
140
|
|
|
140
141
|
// Two independently pinned roots, printed with labels because they go to
|
|
141
142
|
// different places in the client build and are not interchangeable.
|
|
@@ -145,6 +146,9 @@ async function printTrustRoot(args) {
|
|
|
145
146
|
process.stdout.write(
|
|
146
147
|
`sealed sender trust root: ${Buffer.from(sealedSenderRoot).toString('base64')}\n`
|
|
147
148
|
);
|
|
149
|
+
process.stdout.write(
|
|
150
|
+
`sealed sender relay scope: ${Buffer.from(sealedSenderScope).toString('base64')}\n`
|
|
151
|
+
);
|
|
148
152
|
}
|
|
149
153
|
|
|
150
154
|
const [command, ...args] = process.argv.slice(2);
|
package/sealed-sender/README.md
CHANGED
package/types/README.md
CHANGED
package/username/README.md
CHANGED
package/utils/README.md
CHANGED
package/zk/README.md
CHANGED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"sealed-sender-ops.d.ts","sourceRoot":"","sources":["../../client/sealed-sender-ops.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AACnD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAA+B,KAAK,OAAO,EAAE,MAAM,WAAW,CAAC;AAEtE,OAAO,EACL,uBAAuB,EAGxB,MAAM,0CAA0C,CAAC;AAElD;;;;;;;;;;;;;;;GAeG;AACH,OAAO,EAAE,CAAC;AACV,wBAAsB,WAAW,CAC/B,gBAAgB,EAAE,MAAM,EACxB,uBAAuB,EAAE,MAAM,EAC/B,qBAAqB,EAAE,UAAU,EACjC,uBAAuB,EAAE,UAAU,EACnC,OAAO,EAAE,kBAAkB,EAC3B,eAAe,CAAC,EAAE,OAAO,EACzB,WAAW,CAAC,EAAE,uBAAuB,GACpC,OAAO,CAAC,MAAM,CAAC,CAkCjB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,aAAa,CACjC,sBAAsB,EAAE,MAAM,EAC9B,wBAAwB,EAAE,UAAU,EACpC,aAAa,EAAE,MAAM,EACrB,iBAAiB,EAAE,MAAM,EACzB,MAAM,EAAE,kBAAkB,EAC1B,cAAc,CAAC,EAAE,OAAO,GACvB,OAAO,CAAC;IACT,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,WAAW,EAAE,uBAAuB,CAAC;CACtC,CAAC,CAgED;AA8ED;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CACjC,gBAAgB,EAAE,QAAQ,EAC1B,QAAQ,EAAE;IACR,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,WAAW,EAAE,uBAAuB,CAAC;CACtC,GACA,QAAQ,CAQV;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,sBAAsB,CACpC,WAAW,EAAE,uBAAuB,GACnC,QAAQ,CAAC,aAAa,CAAC,CAUzB"}
|