@open-e2ee/signal-protocol-sdk 0.1.0-alpha.5 → 0.1.0-alpha.7
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 -15
- package/ARCHITECTURE.md +1 -1
- package/CHANGELOG.md +252 -2
- package/README.md +1 -1
- package/blocking/README.md +5 -5
- package/client/README.md +2 -2
- package/dist/blocking/index.d.ts +2 -2
- package/dist/blocking/index.d.ts.map +1 -1
- package/dist/blocking/index.js +1 -1
- package/dist/blocking/index.js.map +1 -1
- package/dist/blocking/manager.d.ts +7 -7
- package/dist/blocking/manager.d.ts.map +1 -1
- package/dist/blocking/manager.js +3 -3
- package/dist/blocking/manager.js.map +1 -1
- package/dist/blocking/types.d.ts +3 -3
- package/dist/blocking/types.d.ts.map +1 -1
- package/dist/client/client.d.ts +32 -28
- package/dist/client/client.d.ts.map +1 -1
- package/dist/client/client.js +127 -79
- package/dist/client/client.js.map +1 -1
- package/dist/client/compose.d.ts +12 -7
- package/dist/client/compose.d.ts.map +1 -1
- package/dist/client/compose.js +2 -0
- package/dist/client/compose.js.map +1 -1
- package/dist/client/config.d.ts +54 -30
- package/dist/client/config.d.ts.map +1 -1
- package/dist/client/config.js.map +1 -1
- package/dist/client/content-adapter.d.ts +4 -4
- package/dist/client/content-adapter.d.ts.map +1 -1
- package/dist/client/content-adapter.js +1 -1
- package/dist/client/content-adapter.js.map +1 -1
- package/dist/client/dual-store.d.ts +5 -5
- package/dist/client/dual-store.d.ts.map +1 -1
- package/dist/client/dual-store.js.map +1 -1
- package/dist/client/endorsement-manager.d.ts +4 -0
- package/dist/client/endorsement-manager.d.ts.map +1 -1
- package/dist/client/endorsement-manager.js +11 -2
- package/dist/client/endorsement-manager.js.map +1 -1
- package/dist/client/groups.d.ts +29 -29
- package/dist/client/groups.d.ts.map +1 -1
- package/dist/client/groups.js +54 -37
- package/dist/client/groups.js.map +1 -1
- package/dist/client/headless.d.ts +9 -9
- package/dist/client/headless.d.ts.map +1 -1
- package/dist/client/headless.js +6 -6
- package/dist/client/headless.js.map +1 -1
- package/dist/client/index.d.ts +2 -2
- 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/key-rotation-core.d.ts +7 -7
- package/dist/client/key-rotation-core.d.ts.map +1 -1
- package/dist/client/key-rotation-core.js +11 -11
- package/dist/client/key-rotation-core.js.map +1 -1
- package/dist/client/media.js.map +1 -1
- package/dist/client/relay-subscription.d.ts +2 -2
- package/dist/client/relay-subscription.d.ts.map +1 -1
- package/dist/client/relay-subscription.js +1 -1
- package/dist/client/relay-subscription.js.map +1 -1
- package/dist/client/retry.js.map +1 -1
- package/dist/client/sealed-sender-ops.d.ts +1 -1
- package/dist/client/sealed-sender-ops.d.ts.map +1 -1
- package/dist/client/sealed-sender-ops.js +3 -3
- package/dist/client/sealed-sender-ops.js.map +1 -1
- package/dist/client/signal-service-cipher.d.ts +15 -11
- package/dist/client/signal-service-cipher.d.ts.map +1 -1
- package/dist/client/signal-service-cipher.js +24 -15
- package/dist/client/signal-service-cipher.js.map +1 -1
- package/dist/client/types.d.ts +8 -8
- package/dist/client/types.d.ts.map +1 -1
- package/dist/device/connection.js +2 -2
- package/dist/device/connection.js.map +1 -1
- package/dist/device/device-id.d.ts.map +1 -1
- package/dist/device/device-id.js +4 -4
- package/dist/device/device-id.js.map +1 -1
- package/dist/device/provisioning.d.ts +2 -2
- package/dist/device/provisioning.d.ts.map +1 -1
- package/dist/device/provisioning.js +7 -7
- package/dist/device/provisioning.js.map +1 -1
- package/dist/device/transfer.d.ts.map +1 -1
- package/dist/device/transfer.js +14 -14
- package/dist/device/transfer.js.map +1 -1
- package/dist/files/index.d.ts +1 -1
- package/dist/files/index.js +1 -1
- package/dist/groups/index.d.ts +4 -4
- package/dist/groups/index.d.ts.map +1 -1
- package/dist/groups/index.js +3 -3
- package/dist/groups/index.js.map +1 -1
- package/dist/hooks/use-connection-presence.d.ts +3 -3
- package/dist/hooks/use-connection-presence.d.ts.map +1 -1
- package/dist/hooks/use-connection-presence.js +4 -4
- package/dist/hooks/use-connection-presence.js.map +1 -1
- package/dist/hooks/use-key-rotation.js +2 -2
- package/dist/hooks/use-key-rotation.js.map +1 -1
- package/dist/index.d.ts +15 -15
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +6 -6
- package/dist/index.js.map +1 -1
- package/dist/internal/crypto/ec/x25519-validation.d.ts.map +1 -1
- package/dist/internal/crypto/ec/x25519-validation.js +4 -4
- package/dist/internal/crypto/ec/x25519-validation.js.map +1 -1
- package/dist/internal/crypto/symmetric/mac.d.ts +3 -3
- package/dist/internal/crypto/symmetric/mac.js +3 -3
- package/dist/internal/encoding/proto/envelope.d.ts +21 -21
- package/dist/internal/encoding/proto/envelope.d.ts.map +1 -1
- package/dist/internal/encoding/proto/envelope.js +25 -25
- package/dist/internal/encoding/proto/envelope.js.map +1 -1
- package/dist/internal/encoding/proto/index.d.ts +2 -2
- package/dist/internal/encoding/proto/index.d.ts.map +1 -1
- package/dist/internal/encoding/proto/index.js +2 -2
- package/dist/internal/encoding/proto/index.js.map +1 -1
- package/dist/internal/encoding/proto/pq-ratchet-serialize.d.ts +3 -3
- package/dist/internal/encoding/proto/pq-ratchet-serialize.js +2 -2
- package/dist/internal/encoding/proto/signal-message.d.ts +33 -33
- package/dist/internal/encoding/proto/signal-message.d.ts.map +1 -1
- package/dist/internal/encoding/proto/signal-message.js +58 -58
- package/dist/internal/encoding/proto/signal-message.js.map +1 -1
- package/dist/internal/groups/access-control.d.ts +170 -0
- package/dist/internal/groups/access-control.d.ts.map +1 -0
- package/dist/internal/groups/access-control.js +284 -0
- package/dist/internal/groups/access-control.js.map +1 -0
- package/dist/internal/groups/change-actions.d.ts +57 -0
- package/dist/internal/groups/change-actions.d.ts.map +1 -0
- package/dist/internal/groups/change-actions.js +827 -0
- package/dist/internal/groups/change-actions.js.map +1 -0
- package/dist/internal/groups/change-authorization.d.ts +16 -0
- package/dist/internal/groups/change-authorization.d.ts.map +1 -0
- package/dist/internal/groups/change-authorization.js +120 -0
- package/dist/internal/groups/change-authorization.js.map +1 -0
- package/dist/internal/{groups-v2 → groups}/encrypted-state.d.ts +12 -2
- package/dist/internal/groups/encrypted-state.d.ts.map +1 -0
- package/dist/internal/{groups-v2 → groups}/encrypted-state.js +122 -22
- package/dist/internal/groups/encrypted-state.js.map +1 -0
- package/dist/internal/groups/group-id.d.ts +9 -9
- package/dist/internal/groups/group-id.d.ts.map +1 -1
- package/dist/internal/groups/group-id.js +11 -12
- package/dist/internal/groups/group-id.js.map +1 -1
- package/dist/internal/groups/index.d.ts +16 -6
- package/dist/internal/groups/index.d.ts.map +1 -1
- package/dist/internal/groups/index.js +9 -1
- package/dist/internal/groups/index.js.map +1 -1
- package/dist/internal/groups/invite-link.d.ts.map +1 -0
- package/dist/internal/groups/invite-link.js.map +1 -0
- package/dist/internal/{groups-v2 → groups}/manager.d.ts +175 -40
- package/dist/internal/groups/manager.d.ts.map +1 -0
- package/dist/internal/groups/manager.js +1862 -0
- package/dist/internal/groups/manager.js.map +1 -0
- package/dist/internal/groups/sdk-store.d.ts +32 -0
- package/dist/internal/groups/sdk-store.d.ts.map +1 -0
- package/dist/internal/groups/sdk-store.js +111 -0
- package/dist/internal/groups/sdk-store.js.map +1 -0
- package/dist/internal/groups/server-engine.d.ts +52 -0
- package/dist/internal/groups/server-engine.d.ts.map +1 -0
- package/dist/internal/groups/server-engine.js +1126 -0
- package/dist/internal/groups/server-engine.js.map +1 -0
- package/dist/internal/groups/trust-root.d.ts +32 -0
- package/dist/internal/groups/trust-root.d.ts.map +1 -0
- package/dist/internal/groups/trust-root.js +91 -0
- package/dist/internal/groups/trust-root.js.map +1 -0
- package/dist/internal/{groups-v2 → groups}/types.d.ts +188 -46
- package/dist/internal/groups/types.d.ts.map +1 -0
- package/dist/internal/{groups-v2 → groups}/types.js +3 -2
- package/dist/internal/groups/types.js.map +1 -0
- package/dist/internal/groups/wire.d.ts +68 -0
- package/dist/internal/groups/wire.d.ts.map +1 -0
- package/dist/internal/groups/wire.js +708 -0
- package/dist/internal/groups/wire.js.map +1 -0
- package/dist/internal/manager/manager.d.ts +3 -3
- package/dist/internal/manager/manager.d.ts.map +1 -1
- package/dist/internal/manager/manager.js +3 -3
- package/dist/internal/manager/manager.js.map +1 -1
- package/dist/internal/protocol/double-ratchet/chains.d.ts.map +1 -1
- package/dist/internal/protocol/double-ratchet/chains.js +9 -9
- package/dist/internal/protocol/double-ratchet/chains.js.map +1 -1
- package/dist/internal/protocol/double-ratchet/ratchet.d.ts +2 -2
- package/dist/internal/protocol/double-ratchet/ratchet.d.ts.map +1 -1
- package/dist/internal/protocol/double-ratchet/ratchet.js +2 -2
- package/dist/internal/protocol/double-ratchet/ratchet.js.map +1 -1
- package/dist/internal/protocol/pqxdh/pqxdh.d.ts.map +1 -1
- package/dist/internal/protocol/pqxdh/pqxdh.js +3 -3
- package/dist/internal/protocol/pqxdh/pqxdh.js.map +1 -1
- package/dist/internal/protocol/sender-keys/index.d.ts +1 -1
- package/dist/internal/protocol/sender-keys/manager.d.ts +3 -3
- package/dist/internal/protocol/sender-keys/manager.d.ts.map +1 -1
- package/dist/internal/protocol/sender-keys/manager.js +3 -3
- package/dist/internal/protocol/sender-keys/manager.js.map +1 -1
- package/dist/internal/protocol/spqr/spqr.d.ts +1 -1
- package/dist/internal/protocol/spqr/spqr.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/spqr.js +5 -5
- package/dist/internal/protocol/spqr/spqr.js.map +1 -1
- package/dist/internal/protocol/triple-ratchet/ratchet.d.ts +2 -2
- package/dist/internal/protocol/triple-ratchet/ratchet.d.ts.map +1 -1
- package/dist/internal/protocol/triple-ratchet/ratchet.js +4 -4
- package/dist/internal/protocol/triple-ratchet/ratchet.js.map +1 -1
- package/dist/internal/protocol/x3dh/x3dh.d.ts.map +1 -1
- package/dist/internal/protocol/x3dh/x3dh.js +3 -3
- package/dist/internal/protocol/x3dh/x3dh.js.map +1 -1
- package/dist/internal/protocol/zk/groups/auth-credential.d.ts +9 -7
- package/dist/internal/protocol/zk/groups/auth-credential.d.ts.map +1 -1
- package/dist/internal/protocol/zk/groups/auth-credential.js +68 -29
- package/dist/internal/protocol/zk/groups/auth-credential.js.map +1 -1
- package/dist/internal/protocol/zk/groups/server-params.d.ts +1 -1
- package/dist/internal/protocol/zk/groups/server-params.d.ts.map +1 -1
- package/dist/internal/protocol/zk/groups/server-params.js.map +1 -1
- package/dist/internal/protocol/zk/groups/uid-struct.d.ts +2 -0
- package/dist/internal/protocol/zk/groups/uid-struct.d.ts.map +1 -1
- package/dist/internal/protocol/zk/groups/uid-struct.js +4 -0
- package/dist/internal/protocol/zk/groups/uid-struct.js.map +1 -1
- package/dist/internal/sesame/device-registry.d.ts +7 -7
- package/dist/internal/sesame/device-registry.d.ts.map +1 -1
- package/dist/internal/sesame/device-registry.js +2 -2
- package/dist/internal/sesame/device-registry.js.map +1 -1
- package/dist/internal/sesame/manager.d.ts +1 -1
- package/dist/internal/sesame/manager.d.ts.map +1 -1
- package/dist/internal/sesame/manager.js +15 -15
- package/dist/internal/sesame/manager.js.map +1 -1
- package/dist/internal/session/builder.js +3 -3
- package/dist/internal/session/builder.js.map +1 -1
- package/dist/internal/session/cipher.d.ts +2 -2
- package/dist/internal/session/cipher.d.ts.map +1 -1
- package/dist/internal/session/cipher.js +30 -30
- package/dist/internal/session/cipher.js.map +1 -1
- package/dist/internal/session/decryption.d.ts +1 -1
- package/dist/internal/session/decryption.js +10 -10
- package/dist/internal/session/decryption.js.map +1 -1
- package/dist/internal/session/factory.d.ts.map +1 -1
- package/dist/internal/session/factory.js +3 -3
- package/dist/internal/session/factory.js.map +1 -1
- package/dist/internal/session/handshake.d.ts.map +1 -1
- package/dist/internal/session/handshake.js +3 -3
- package/dist/internal/session/handshake.js.map +1 -1
- package/dist/internal/session/ratchet.d.ts.map +1 -1
- package/dist/internal/session/ratchet.js +4 -4
- package/dist/internal/session/ratchet.js.map +1 -1
- package/dist/internal/session/types.d.ts +2 -2
- package/dist/internal/session/types.d.ts.map +1 -1
- package/dist/internal/session/validation.d.ts.map +1 -1
- package/dist/internal/session/validation.js +3 -3
- package/dist/internal/session/validation.js.map +1 -1
- package/dist/layers.d.ts +3 -3
- package/dist/layers.d.ts.map +1 -1
- package/dist/layers.js +7 -7
- package/dist/layers.js.map +1 -1
- package/dist/local/store/expo/adapter.d.ts +8 -8
- package/dist/local/store/expo/adapter.d.ts.map +1 -1
- package/dist/local/store/expo/adapter.js +7 -7
- package/dist/local/store/expo/adapter.js.map +1 -1
- package/dist/local/store/expo/database-key.d.ts +2 -2
- package/dist/local/store/expo/database-key.d.ts.map +1 -1
- package/dist/local/store/expo/database-key.js +5 -5
- package/dist/local/store/expo/database-key.js.map +1 -1
- package/dist/local/store/expo/db.d.ts +9 -9
- package/dist/local/store/expo/db.d.ts.map +1 -1
- package/dist/local/store/expo/db.js +2 -2
- package/dist/local/store/expo/db.js.map +1 -1
- package/dist/local/store/expo/index.d.ts +6 -6
- package/dist/local/store/expo/index.d.ts.map +1 -1
- package/dist/local/store/expo/index.js +3 -3
- package/dist/local/store/expo/index.js.map +1 -1
- package/dist/local/store/expo/key-storage.d.ts +1 -1
- package/dist/local/store/expo/key-storage.d.ts.map +1 -1
- package/dist/local/store/expo/key-storage.js +4 -4
- package/dist/local/store/expo/key-storage.js.map +1 -1
- package/dist/local/store/expo/secure-store-options.d.ts +1 -1
- package/dist/local/store/expo/secure-store-options.d.ts.map +1 -1
- package/dist/local/store/expo/secure-store-options.js +1 -1
- package/dist/local/store/expo/secure-store-options.js.map +1 -1
- package/dist/local/store/index.d.ts +9 -9
- package/dist/local/store/index.d.ts.map +1 -1
- package/dist/local/store/index.js +8 -8
- package/dist/local/store/index.js.map +1 -1
- package/dist/local/store/mock/adapter.d.ts +6 -6
- package/dist/local/store/mock/adapter.d.ts.map +1 -1
- package/dist/local/store/mock/adapter.js +2 -2
- package/dist/local/store/mock/adapter.js.map +1 -1
- package/dist/local/store/mock/index.d.ts +3 -3
- package/dist/local/store/mock/index.d.ts.map +1 -1
- package/dist/local/store/mock/index.js +3 -3
- package/dist/local/store/mock/index.js.map +1 -1
- package/dist/local/store/node/adapter.d.ts +4 -4
- package/dist/local/store/node/adapter.d.ts.map +1 -1
- package/dist/local/store/node/adapter.js +2 -2
- package/dist/local/store/node/adapter.js.map +1 -1
- package/dist/local/store/node/database.d.ts.map +1 -1
- package/dist/local/store/node/database.js +2 -2
- package/dist/local/store/node/database.js.map +1 -1
- package/dist/local/store/node/index.d.ts +4 -4
- package/dist/local/store/node/index.d.ts.map +1 -1
- package/dist/local/store/node/index.js +3 -3
- package/dist/local/store/node/index.js.map +1 -1
- package/dist/local/store/react-native/adapter.d.ts +5 -5
- package/dist/local/store/react-native/adapter.d.ts.map +1 -1
- package/dist/local/store/react-native/adapter.js +12 -12
- package/dist/local/store/react-native/adapter.js.map +1 -1
- package/dist/local/store/react-native/index.d.ts +4 -4
- package/dist/local/store/react-native/index.d.ts.map +1 -1
- package/dist/local/store/react-native/index.js +3 -3
- package/dist/local/store/react-native/index.js.map +1 -1
- package/dist/local/store/react-native/storage.d.ts +1 -1
- package/dist/local/store/web/adapter.d.ts +4 -4
- package/dist/local/store/web/adapter.d.ts.map +1 -1
- package/dist/local/store/web/adapter.js +7 -7
- package/dist/local/store/web/adapter.js.map +1 -1
- package/dist/local/store/web/index.d.ts +4 -4
- package/dist/local/store/web/index.d.ts.map +1 -1
- package/dist/local/store/web/index.js +3 -3
- package/dist/local/store/web/index.js.map +1 -1
- package/dist/local/vault/expo-secure-store.d.ts +2 -2
- package/dist/local/vault/expo-secure-store.d.ts.map +1 -1
- package/dist/local/vault/expo-secure-store.js +5 -5
- package/dist/local/vault/expo-secure-store.js.map +1 -1
- package/dist/local/vault/index.d.ts +2 -2
- package/dist/local/vault/index.d.ts.map +1 -1
- package/dist/local/vault/index.js +1 -1
- package/dist/local/vault/index.js.map +1 -1
- package/dist/logger.d.ts +3 -3
- package/dist/logger.d.ts.map +1 -1
- package/dist/logger.js +4 -4
- package/dist/logger.js.map +1 -1
- package/dist/media/index.d.ts +5 -5
- package/dist/media/index.d.ts.map +1 -1
- package/dist/profile/contact-state.d.ts.map +1 -1
- package/dist/profile/contact-state.js +2 -2
- package/dist/profile/contact-state.js.map +1 -1
- package/dist/profile/profile-key.d.ts.map +1 -1
- package/dist/profile/profile-key.js +2 -2
- package/dist/profile/profile-key.js.map +1 -1
- package/dist/profile/update-service.d.ts.map +1 -1
- package/dist/profile/update-service.js +2 -2
- package/dist/profile/update-service.js.map +1 -1
- package/dist/remote/object-store/convex-r2/storage.d.ts +2 -2
- package/dist/remote/object-store/convex-r2/storage.d.ts.map +1 -1
- package/dist/remote/object-store/index.d.ts +1 -1
- package/dist/remote/object-store/index.d.ts.map +1 -1
- package/dist/remote/object-store/s3/storage.d.ts +3 -3
- package/dist/remote/object-store/s3/storage.d.ts.map +1 -1
- package/dist/remote/object-store/s3/storage.js +1 -1
- package/dist/remote/object-store/types.d.ts +1 -1
- package/dist/remote/object-store/types.d.ts.map +1 -1
- package/dist/remote/relay/convex/group-server.d.ts +23 -21
- package/dist/remote/relay/convex/group-server.d.ts.map +1 -1
- package/dist/remote/relay/convex/group-server.js +49 -21
- package/dist/remote/relay/convex/group-server.js.map +1 -1
- package/dist/remote/relay/convex/index.d.ts +9 -9
- package/dist/remote/relay/convex/index.d.ts.map +1 -1
- package/dist/remote/relay/convex/index.js +5 -5
- package/dist/remote/relay/convex/index.js.map +1 -1
- package/dist/remote/relay/convex/relay.d.ts +26 -18
- package/dist/remote/relay/convex/relay.d.ts.map +1 -1
- package/dist/remote/relay/convex/relay.js +82 -23
- package/dist/remote/relay/convex/relay.js.map +1 -1
- package/dist/remote/relay/convex/server/index.d.ts +2 -0
- package/dist/remote/relay/convex/server/index.d.ts.map +1 -0
- package/dist/remote/relay/convex/server/index.js +2 -0
- package/dist/remote/relay/convex/server/index.js.map +1 -0
- package/dist/remote/relay/convex/server.d.ts +150 -0
- package/dist/remote/relay/convex/server.d.ts.map +1 -0
- package/dist/remote/relay/convex/server.js +506 -0
- package/dist/remote/relay/convex/server.js.map +1 -0
- package/dist/remote/relay/index.d.ts +7 -7
- package/dist/remote/relay/index.d.ts.map +1 -1
- package/dist/remote/relay/index.js +6 -6
- package/dist/remote/relay/index.js.map +1 -1
- package/dist/remote/relay/mock/adapter.d.ts +36 -18
- package/dist/remote/relay/mock/adapter.d.ts.map +1 -1
- package/dist/remote/relay/mock/adapter.js +75 -65
- package/dist/remote/relay/mock/adapter.js.map +1 -1
- package/dist/remote/relay/mock/failures.d.ts +1 -0
- package/dist/remote/relay/mock/failures.d.ts.map +1 -1
- package/dist/remote/relay/mock/failures.js +5 -0
- package/dist/remote/relay/mock/failures.js.map +1 -1
- package/dist/remote/relay/mock/group-server.d.ts +9 -0
- package/dist/remote/relay/mock/group-server.d.ts.map +1 -0
- package/dist/remote/relay/mock/group-server.js +9 -0
- package/dist/remote/relay/mock/group-server.js.map +1 -0
- package/dist/remote/relay/mock/index.d.ts +3 -3
- package/dist/remote/relay/mock/index.d.ts.map +1 -1
- package/dist/remote/relay/mock/index.js +3 -3
- package/dist/remote/relay/mock/index.js.map +1 -1
- package/dist/remote/relay/types.d.ts +56 -25
- package/dist/remote/relay/types.d.ts.map +1 -1
- package/dist/remote/relay/types.js +2 -2
- package/dist/types/api.d.ts +4 -4
- package/dist/types/api.d.ts.map +1 -1
- package/dist/types/messages.d.ts +1 -1
- package/dist/types/protocol-config.d.ts +17 -2
- package/dist/types/protocol-config.d.ts.map +1 -1
- package/dist/types/protocol-config.js +17 -2
- package/dist/types/protocol-config.js.map +1 -1
- package/dist/utils/retry.d.ts +2 -2
- package/dist/utils/retry.d.ts.map +1 -1
- package/dist/utils/retry.js +17 -0
- package/dist/utils/retry.js.map +1 -1
- package/docs/CLIENT_COMPOSITION.md +3 -3
- package/docs/DEVIATIONS.md +69 -50
- package/docs/GETTING_STARTED.md +3 -3
- package/docs/INTERFACES.md +22 -22
- package/docs/PACKAGE_SURFACE.md +15 -10
- package/docs/RECIPES.md +4 -4
- package/docs/api/classes/EndorsementManager.md +19 -1
- package/docs/api/classes/{SignalBlockingManager.md → SignalProtocolBlockingManager.md} +5 -5
- package/docs/api/classes/SignalProtocolClient.md +78 -78
- package/docs/api/functions/createDefaultSignalProtocolContentAdapter.md +13 -0
- package/docs/api/functions/{createDefaultSignalLogger.md → createDefaultSignalProtocolLogger.md} +5 -5
- package/docs/api/functions/createGroupId.md +1 -1
- package/docs/api/functions/decodeGroupTrustRoot.md +21 -0
- package/docs/api/functions/encodeGroupTrustRoot.md +28 -0
- package/docs/api/functions/extractGroupId.md +2 -2
- package/docs/api/functions/isGroupId.md +1 -1
- package/docs/api/functions/{resolveSignalLogger.md → resolveSignalProtocolLogger.md} +5 -5
- package/docs/api/interfaces/GroupTrustRoot.md +33 -0
- package/docs/api/interfaces/IProtocolStore.md +1 -1
- package/docs/api/interfaces/IRelayGroupServer.md +60 -0
- package/docs/api/interfaces/ISenderKeyStore.md +1 -1
- package/docs/api/interfaces/ISesameStore.md +1 -1
- package/docs/api/interfaces/ISignalProtocolClient.md +1 -1
- package/docs/api/interfaces/{ISignalLocalSecretVault.md → ISignalProtocolLocalSecretVault.md} +2 -2
- package/docs/api/interfaces/{ISignalLocalStore.md → ISignalProtocolLocalStore.md} +2 -2
- package/docs/api/interfaces/{ISignalRelayServer.md → ISignalProtocolRelayServer.md} +11 -3
- package/docs/api/interfaces/{InspectedSignalContent.md → InspectedSignalProtocolContent.md} +2 -2
- package/docs/api/interfaces/MLKEMBraidAgentState.md +1 -1
- package/docs/api/interfaces/MessageHeader.md +1 -1
- package/docs/api/interfaces/PreKeyMaintenanceStore.md +2 -2
- package/docs/api/interfaces/SealedSenderConfig.md +2 -2
- package/docs/api/interfaces/{SignalBlockingHooks.md → SignalProtocolBlockingHooks.md} +2 -2
- package/docs/api/interfaces/SignalProtocolBlockingManagerOptions.md +31 -0
- package/docs/api/interfaces/{SignalBlockingMirror.md → SignalProtocolBlockingMirror.md} +2 -2
- package/docs/api/interfaces/{SignalBlockingStore.md → SignalProtocolBlockingStore.md} +2 -2
- package/docs/api/interfaces/SignalProtocolClientAdapterConfig.md +3 -3
- package/docs/api/interfaces/SignalProtocolClientCompositionOptions.md +69 -31
- package/docs/api/interfaces/SignalProtocolClientConfig.md +93 -37
- package/docs/api/interfaces/SignalProtocolClientHooks.md +1 -1
- package/docs/api/interfaces/SignalProtocolClientIdentityConfig.md +16 -0
- package/docs/api/interfaces/SignalProtocolClientMediaConfig.md +2 -2
- package/docs/api/interfaces/{SignalContentAdapter.md → SignalProtocolContentAdapter.md} +4 -4
- package/docs/api/interfaces/{SignalRemoteObjectStore.md → SignalProtocolRemoteObjectStore.md} +2 -2
- package/docs/api/namespaces/blocking/README.md +10 -10
- package/docs/api/namespaces/keys/functions/generateKemOneTimePreKeys.md +1 -1
- package/docs/api/namespaces/media/interfaces/DeleteMediaAttachmentOptions.md +1 -1
- package/docs/api/namespaces/media/interfaces/ExecuteMediaAttachmentJobOptions.md +1 -1
- package/docs/api/namespaces/media/interfaces/PrepareMediaAttachmentUploadOptions.md +1 -1
- package/docs/api/namespaces/media/interfaces/ResolveMediaAttachmentOptions.md +1 -1
- package/docs/api/type-aliases/GroupId.md +2 -2
- package/docs/api/variables/GROUP_ID_PREFIX.md +11 -0
- package/docs/api/variables/GROUP_TRUST_ROOT_VERSION.md +11 -0
- package/docs/api/variables/MAX_RECEIVER_CHAINS.md +1 -1
- package/docs/api/variables/ONE_TIME_PREKEY_BATCH_SIZE.md +1 -1
- package/docs/api/variables/{defaultSignalLogger.md → defaultSignalProtocolLogger.md} +5 -5
- package/files/README.md +1 -1
- package/groups/README.md +16 -5
- package/local/store/README.md +10 -10
- package/local/store/expo/README.md +5 -5
- package/local/store/mock/README.md +1 -1
- package/local/store/node/README.md +1 -1
- package/local/store/react-native/README.md +1 -1
- package/local/store/web/README.md +1 -1
- package/local/vault/README.md +3 -3
- package/package.json +13 -2
- package/remote/README.md +19 -19
- package/remote/object-store/README.md +3 -3
- package/remote/object-store/convex-r2/README.md +1 -1
- package/remote/object-store/s3/README.md +1 -1
- package/remote/relay/README.md +2 -2
- package/remote/relay/convex/README.md +10 -4
- package/remote/relay/convex/server/README.md +146 -0
- package/remote/relay/mock/README.md +1 -1
- package/scripts/oe-groups.mjs +142 -0
- package/types/README.md +1 -1
- package/dist/internal/groups-v2/access-control.d.ts +0 -108
- package/dist/internal/groups-v2/access-control.d.ts.map +0 -1
- package/dist/internal/groups-v2/access-control.js +0 -191
- package/dist/internal/groups-v2/access-control.js.map +0 -1
- package/dist/internal/groups-v2/change-actions.d.ts +0 -40
- package/dist/internal/groups-v2/change-actions.d.ts.map +0 -1
- package/dist/internal/groups-v2/change-actions.js +0 -363
- package/dist/internal/groups-v2/change-actions.js.map +0 -1
- package/dist/internal/groups-v2/encrypted-state.d.ts.map +0 -1
- package/dist/internal/groups-v2/encrypted-state.js.map +0 -1
- package/dist/internal/groups-v2/index.d.ts +0 -19
- package/dist/internal/groups-v2/index.d.ts.map +0 -1
- package/dist/internal/groups-v2/index.js +0 -11
- package/dist/internal/groups-v2/index.js.map +0 -1
- package/dist/internal/groups-v2/invite-link.d.ts.map +0 -1
- package/dist/internal/groups-v2/invite-link.js.map +0 -1
- package/dist/internal/groups-v2/manager.d.ts.map +0 -1
- package/dist/internal/groups-v2/manager.js +0 -1095
- package/dist/internal/groups-v2/manager.js.map +0 -1
- package/dist/internal/groups-v2/types.d.ts.map +0 -1
- package/dist/internal/groups-v2/types.js.map +0 -1
- package/docs/api/functions/createDefaultSignalContentAdapter.md +0 -13
- package/docs/api/interfaces/SignalBlockingManagerOptions.md +0 -31
- package/docs/api/variables/GROUP_V2_PREFIX.md +0 -11
- /package/dist/internal/{groups-v2 → groups}/invite-link.d.ts +0 -0
- /package/dist/internal/{groups-v2 → groups}/invite-link.js +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Expo Store
|
|
2
2
|
|
|
3
|
-
`
|
|
3
|
+
`ExpoSignalProtocolStore` implements `ISignalProtocolLocalStore` for Expo and React Native with
|
|
4
4
|
an application-owned SQLite/Drizzle database and a database key held through
|
|
5
5
|
the local secret-vault boundary.
|
|
6
6
|
|
|
@@ -20,7 +20,7 @@ the first query:
|
|
|
20
20
|
|
|
21
21
|
```ts
|
|
22
22
|
import {
|
|
23
|
-
|
|
23
|
+
configureSignalProtocolExpoDbBindings,
|
|
24
24
|
} from "@open-e2ee/signal-protocol-sdk/local/store/expo/db";
|
|
25
25
|
import {
|
|
26
26
|
getDatabaseKeyManager,
|
|
@@ -32,18 +32,18 @@ await keyManager.initialize();
|
|
|
32
32
|
const sqlCipherPassword = await keyManager.getPassword();
|
|
33
33
|
|
|
34
34
|
const { rawDatabase, drizzleDatabase } =
|
|
35
|
-
await appDatabase.
|
|
35
|
+
await appDatabase.openEncryptedSignalProtocolDatabase({
|
|
36
36
|
password: sqlCipherPassword,
|
|
37
37
|
schema: signalSchema,
|
|
38
38
|
});
|
|
39
39
|
|
|
40
|
-
|
|
40
|
+
configureSignalProtocolExpoDbBindings({
|
|
41
41
|
getDrizzle: async () => drizzleDatabase,
|
|
42
42
|
getRawDatabase: () => rawDatabase,
|
|
43
43
|
});
|
|
44
44
|
```
|
|
45
45
|
|
|
46
|
-
`appDatabase.
|
|
46
|
+
`appDatabase.openEncryptedSignalProtocolDatabase` represents application-owned database
|
|
47
47
|
bootstrap. It must enable SQLCipher through the `expo-sqlite` native
|
|
48
48
|
configuration, apply the supplied key before schema access, create or migrate
|
|
49
49
|
the exported tables, and return the matching raw and Drizzle handles. SQLCipher
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# In-Memory Store
|
|
2
2
|
|
|
3
|
-
`
|
|
3
|
+
`MockSignalProtocolStore` implements `ISignalProtocolLocalStore` in memory for examples, local
|
|
4
4
|
development, and deterministic application prototypes.
|
|
5
5
|
|
|
6
6
|
Real protocol and cryptography; simulated in-memory infrastructure.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Bare React Native Store
|
|
2
2
|
|
|
3
|
-
`
|
|
3
|
+
`ReactNativeSignalProtocolStore` implements `ISignalProtocolLocalStore` for bare React Native
|
|
4
4
|
through an application-provided persistent key-value backend.
|
|
5
5
|
|
|
6
6
|
## Why it exists
|
package/local/vault/README.md
CHANGED
|
@@ -7,16 +7,16 @@ The local secret vault stores small bootstrap secrets through a minimal
|
|
|
7
7
|
|
|
8
8
|
Platform secret managers are appropriate for tiny keys and bootstrap values,
|
|
9
9
|
but not full session databases. Separating the vault from
|
|
10
|
-
`
|
|
10
|
+
`ISignalProtocolLocalStore` keeps platform limits explicit and lets a local store use a
|
|
11
11
|
vault-held wrapping key without placing every protocol record in the platform
|
|
12
12
|
keychain.
|
|
13
13
|
|
|
14
14
|
## Expo usage
|
|
15
15
|
|
|
16
16
|
```ts
|
|
17
|
-
import {
|
|
17
|
+
import { ExpoSecureStoreSignalProtocolSecretVault } from "@open-e2ee/signal-protocol-sdk/local/vault/expo-secure-store";
|
|
18
18
|
|
|
19
|
-
const vault = new
|
|
19
|
+
const vault = new ExpoSecureStoreSignalProtocolSecretVault();
|
|
20
20
|
|
|
21
21
|
await vault.setSecret("signal-store-wrapping-key", wrappingKey);
|
|
22
22
|
const restored = await vault.getSecret("signal-store-wrapping-key");
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@open-e2ee/signal-protocol-sdk",
|
|
3
|
-
"version": "0.1.0-alpha.
|
|
3
|
+
"version": "0.1.0-alpha.7",
|
|
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",
|
|
@@ -43,6 +43,9 @@
|
|
|
43
43
|
"main": "./dist/index.js",
|
|
44
44
|
"module": "./dist/index.js",
|
|
45
45
|
"types": "./dist/index.d.ts",
|
|
46
|
+
"bin": {
|
|
47
|
+
"oe-groups": "./scripts/oe-groups.mjs"
|
|
48
|
+
},
|
|
46
49
|
"exports": {
|
|
47
50
|
".": {
|
|
48
51
|
"types": "./dist/index.d.ts",
|
|
@@ -60,6 +63,10 @@
|
|
|
60
63
|
"types": "./dist/remote/relay/convex/relay.d.ts",
|
|
61
64
|
"default": "./dist/remote/relay/convex/relay.js"
|
|
62
65
|
},
|
|
66
|
+
"./remote/relay/convex/server": {
|
|
67
|
+
"types": "./dist/remote/relay/convex/server/index.d.ts",
|
|
68
|
+
"default": "./dist/remote/relay/convex/server/index.js"
|
|
69
|
+
},
|
|
63
70
|
"./remote/relay/mock": {
|
|
64
71
|
"types": "./dist/remote/relay/mock/index.d.ts",
|
|
65
72
|
"default": "./dist/remote/relay/mock/index.js"
|
|
@@ -321,8 +328,10 @@
|
|
|
321
328
|
"remote/object-store/s3/README.md",
|
|
322
329
|
"remote/relay/README.md",
|
|
323
330
|
"remote/relay/convex/README.md",
|
|
331
|
+
"remote/relay/convex/server/README.md",
|
|
324
332
|
"remote/relay/mock/README.md",
|
|
325
333
|
"safety/README.md",
|
|
334
|
+
"scripts/oe-groups.mjs",
|
|
326
335
|
"sealed-sender/README.md",
|
|
327
336
|
"types/README.md",
|
|
328
337
|
"username/README.md",
|
|
@@ -412,7 +421,8 @@
|
|
|
412
421
|
"overrides": {
|
|
413
422
|
"xcode": {
|
|
414
423
|
"uuid": "11.1.1"
|
|
415
|
-
}
|
|
424
|
+
},
|
|
425
|
+
"brace-expansion": "^5.0.8"
|
|
416
426
|
},
|
|
417
427
|
"devDependencies": {
|
|
418
428
|
"@convex-dev/r2": "^0.10.2",
|
|
@@ -420,6 +430,7 @@
|
|
|
420
430
|
"@types/node": "^22.0.0",
|
|
421
431
|
"@types/react": "^19.0.0",
|
|
422
432
|
"convex": "^1.42.3",
|
|
433
|
+
"convex-test": "^0.0.54",
|
|
423
434
|
"drizzle-orm": "^0.45.1",
|
|
424
435
|
"esbuild": "^0.27.0",
|
|
425
436
|
"expo": "~55.0.27",
|
package/remote/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Remote Guide
|
|
2
2
|
|
|
3
|
-
> Infrastructure | Implements `
|
|
3
|
+
> Infrastructure | Implements `ISignalProtocolRelayServer` and `SignalProtocolRemoteObjectStore` | [Architecture](../ARCHITECTURE.md)
|
|
4
4
|
|
|
5
5
|
The backend layer is responsible for server-owned protocol state: public
|
|
6
6
|
prekeys, device registration, encrypted-envelope delivery, and provisioning
|
|
@@ -17,32 +17,32 @@ replaceable and prevent them from owning private keys or plaintext.
|
|
|
17
17
|
|
|
18
18
|
### Relay
|
|
19
19
|
|
|
20
|
-
- `
|
|
21
|
-
- `
|
|
22
|
-
- custom implementations via `
|
|
20
|
+
- `ConvexSignalProtocolRelayServer` from `@open-e2ee/signal-protocol-sdk/remote/relay/convex`
|
|
21
|
+
- `MockSignalProtocolRelayServer` from `@open-e2ee/signal-protocol-sdk/remote/relay/mock`
|
|
22
|
+
- custom implementations via `ISignalProtocolRelayServer`
|
|
23
23
|
|
|
24
24
|
### Remote object storage
|
|
25
25
|
|
|
26
26
|
- `ConvexR2ObjectStore` from `@open-e2ee/signal-protocol-sdk/remote/object-store/convex-r2`
|
|
27
27
|
- `S3ObjectStore` from `@open-e2ee/signal-protocol-sdk/remote/object-store/s3`
|
|
28
|
-
- custom implementations via `
|
|
28
|
+
- custom implementations via `SignalProtocolRemoteObjectStore`
|
|
29
29
|
|
|
30
30
|
## Composition
|
|
31
31
|
|
|
32
32
|
```ts
|
|
33
33
|
import { SignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
34
34
|
import {
|
|
35
|
-
|
|
36
|
-
type
|
|
35
|
+
ConvexSignalProtocolRelayServer,
|
|
36
|
+
type ConvexSignalProtocolRelayApi,
|
|
37
37
|
} from "@open-e2ee/signal-protocol-sdk/remote/relay/convex";
|
|
38
|
-
import {
|
|
38
|
+
import { ExpoSignalProtocolStore } from "@open-e2ee/signal-protocol-sdk/local/store/expo";
|
|
39
39
|
import { api } from "../convex/_generated/api";
|
|
40
40
|
|
|
41
|
-
const signalApi = api.signal satisfies
|
|
41
|
+
const signalApi = api.signal satisfies ConvexSignalProtocolRelayApi;
|
|
42
42
|
|
|
43
43
|
const signal = await SignalProtocolClient.create(userId, {
|
|
44
|
-
storage: new
|
|
45
|
-
relay: new
|
|
44
|
+
storage: new ExpoSignalProtocolStore(),
|
|
45
|
+
relay: new ConvexSignalProtocolRelayServer(convex, signalApi, {
|
|
46
46
|
currentUserId: userId,
|
|
47
47
|
}),
|
|
48
48
|
});
|
|
@@ -50,7 +50,7 @@ const signal = await SignalProtocolClient.create(userId, {
|
|
|
50
50
|
|
|
51
51
|
## Relay Responsibilities
|
|
52
52
|
|
|
53
|
-
An `
|
|
53
|
+
An `ISignalProtocolRelayServer` implementation must preserve the package’s protocol semantics for:
|
|
54
54
|
|
|
55
55
|
- identity and prekey upload
|
|
56
56
|
- prekey bundle fetch
|
|
@@ -78,7 +78,7 @@ Bundle fetch must preserve one-time-prekey consumption semantics for concurrent
|
|
|
78
78
|
|
|
79
79
|
## Remote Object Storage
|
|
80
80
|
|
|
81
|
-
`
|
|
81
|
+
`SignalProtocolRemoteObjectStore` is optional and only needed for encrypted attachment/file flows.
|
|
82
82
|
|
|
83
83
|
In practice, attachment and encrypted file support is a common consumer path,
|
|
84
84
|
so object-store adapters should be treated as first-class integrations
|
|
@@ -190,22 +190,22 @@ needed to authorize and construct short-lived operations.
|
|
|
190
190
|
|
|
191
191
|
## Local development
|
|
192
192
|
|
|
193
|
-
Use `
|
|
193
|
+
Use `MockSignalProtocolRelayServer` when multiple clients need a shared in-memory relay:
|
|
194
194
|
|
|
195
195
|
```ts
|
|
196
196
|
import { SignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
197
|
-
import {
|
|
198
|
-
import {
|
|
197
|
+
import { MockSignalProtocolRelayServer } from "@open-e2ee/signal-protocol-sdk/remote/relay/mock";
|
|
198
|
+
import { MockSignalProtocolStore } from "@open-e2ee/signal-protocol-sdk/local/store/mock";
|
|
199
199
|
|
|
200
|
-
const relay = new
|
|
200
|
+
const relay = new MockSignalProtocolRelayServer();
|
|
201
201
|
|
|
202
202
|
const alice = await SignalProtocolClient.create("alice", {
|
|
203
|
-
storage: new
|
|
203
|
+
storage: new MockSignalProtocolStore(),
|
|
204
204
|
relay,
|
|
205
205
|
});
|
|
206
206
|
|
|
207
207
|
const bob = await SignalProtocolClient.create("bob", {
|
|
208
|
-
storage: new
|
|
208
|
+
storage: new MockSignalProtocolStore(),
|
|
209
209
|
relay,
|
|
210
210
|
});
|
|
211
211
|
```
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Remote Object Store
|
|
2
2
|
|
|
3
|
-
`
|
|
3
|
+
`SignalProtocolRemoteObjectStore` is the provider-neutral client contract for uploading,
|
|
4
4
|
downloading, completing, and deleting encrypted byte objects through
|
|
5
5
|
short-lived backend-brokered operations.
|
|
6
6
|
|
|
@@ -20,10 +20,10 @@ retry-stable requestId -> canonical objectId -> private provider key
|
|
|
20
20
|
|
|
21
21
|
```ts
|
|
22
22
|
import type {
|
|
23
|
-
|
|
23
|
+
SignalProtocolRemoteObjectStore,
|
|
24
24
|
} from "@open-e2ee/signal-protocol-sdk/remote/object-store";
|
|
25
25
|
|
|
26
|
-
const remoteObjectStore:
|
|
26
|
+
const remoteObjectStore: SignalProtocolRemoteObjectStore = {
|
|
27
27
|
createUpload: (request) => appStorageApi.createUpload(request),
|
|
28
28
|
createDownload: (request) => appStorageApi.createDownload(request),
|
|
29
29
|
completeUpload: (request) => appStorageApi.completeUpload(request),
|
|
@@ -8,7 +8,7 @@ application's bucket, credentials, schema, authorization, or metadata model.
|
|
|
8
8
|
|
|
9
9
|
The Convex client calls generated function references, while `@convex-dev/r2`
|
|
10
10
|
operates inside the application backend. This adapter maps that generated API
|
|
11
|
-
to `
|
|
11
|
+
to `SignalProtocolRemoteObjectStore` without moving storage policy, provider keys, or
|
|
12
12
|
component ownership into the SDK.
|
|
13
13
|
|
|
14
14
|
## Client usage
|
package/remote/relay/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Relay
|
|
2
2
|
|
|
3
|
-
The relay module defines `
|
|
3
|
+
The relay module defines `ISignalProtocolRelayServer`, the application-backend contract
|
|
4
4
|
for device discovery, public prekeys, encrypted envelopes, key rotation,
|
|
5
5
|
provisioning, and related synchronization.
|
|
6
6
|
|
|
@@ -28,7 +28,7 @@ const client = await createSignalProtocolClient({
|
|
|
28
28
|
await client.syncToServer();
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
For production, implement `
|
|
31
|
+
For production, implement `ISignalProtocolRelayServer` or use the
|
|
32
32
|
[Convex adapter](./convex/README.md). The application backend must authenticate
|
|
33
33
|
mutations, allocate linked-device IDs, consume one-time prekeys atomically,
|
|
34
34
|
enforce access policy, and store only encrypted envelopes plus required routing
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# Convex Relay Adapter
|
|
2
2
|
|
|
3
3
|
The Convex relay adapter maps an application-owned generated Convex API module
|
|
4
|
-
to `
|
|
4
|
+
to `ISignalProtocolRelayServer`.
|
|
5
5
|
|
|
6
6
|
## Why it exists
|
|
7
7
|
|
|
@@ -24,11 +24,11 @@ pass that namespace directly:
|
|
|
24
24
|
import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
25
25
|
import {
|
|
26
26
|
convexRelay,
|
|
27
|
-
type
|
|
27
|
+
type ConvexSignalProtocolRelayApi,
|
|
28
28
|
} from "@open-e2ee/signal-protocol-sdk/remote/relay/convex";
|
|
29
29
|
import { api } from "../convex/_generated/api";
|
|
30
30
|
|
|
31
|
-
const signalApi = api.signal satisfies
|
|
31
|
+
const signalApi = api.signal satisfies ConvexSignalProtocolRelayApi;
|
|
32
32
|
|
|
33
33
|
const relay = convexRelay({
|
|
34
34
|
convex,
|
|
@@ -43,9 +43,15 @@ const client = await createSignalProtocolClient({
|
|
|
43
43
|
```
|
|
44
44
|
|
|
45
45
|
The generated `api.signal` namespace must expose the nested functions described
|
|
46
|
-
by `
|
|
46
|
+
by `ConvexSignalProtocolRelayApi`. Use `satisfies` to get a compile-time diagnostic
|
|
47
47
|
without widening the generated references.
|
|
48
48
|
|
|
49
|
+
To serve groups from this deployment, also mount the
|
|
50
|
+
[Convex group server](./server/README.md) inside the same namespace
|
|
51
|
+
(`convex/signal/groups.ts` and `convex/signal/zkAuth.ts`); the relay
|
|
52
|
+
advertises its `groupServer` capability only when both modules are
|
|
53
|
+
configured.
|
|
54
|
+
|
|
49
55
|
Public-key reads may be available to authenticated peers, but every write must
|
|
50
56
|
derive ownership from server-side authentication rather than trusting a
|
|
51
57
|
client-supplied user ID.
|
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
# Convex group server
|
|
2
|
+
|
|
3
|
+
This server-only subpath provides the production group-server implementation
|
|
4
|
+
for Convex. It owns canonical encrypted group state, immutable signed changes,
|
|
5
|
+
per-version signed snapshots, anonymous group authorization, credential
|
|
6
|
+
issuance, and group-send endorsements.
|
|
7
|
+
|
|
8
|
+
Import it from:
|
|
9
|
+
|
|
10
|
+
```ts
|
|
11
|
+
import {
|
|
12
|
+
convexGroupServerTables,
|
|
13
|
+
defineConvexGroupServer,
|
|
14
|
+
} from "@open-e2ee/signal-protocol-sdk/remote/relay/convex/server";
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Schema
|
|
18
|
+
|
|
19
|
+
The component owns three package-scoped tables. Add them to the app schema:
|
|
20
|
+
|
|
21
|
+
```ts
|
|
22
|
+
// convex/schema.ts
|
|
23
|
+
import { defineSchema } from "convex/server";
|
|
24
|
+
import {
|
|
25
|
+
convexGroupServerTables,
|
|
26
|
+
} from "@open-e2ee/signal-protocol-sdk/remote/relay/convex/server";
|
|
27
|
+
|
|
28
|
+
export default defineSchema({
|
|
29
|
+
...convexGroupServerTables,
|
|
30
|
+
// App-owned tables...
|
|
31
|
+
});
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
The tables store the latest canonical encrypted state, the exact accepted and
|
|
35
|
+
signed action bytes, and every historical encrypted snapshot with its cached
|
|
36
|
+
S14 baseline signature. They never store the group master key, group secret
|
|
37
|
+
parameters, plaintext group attributes, or the server secret.
|
|
38
|
+
|
|
39
|
+
Storage grows with one full encrypted snapshot per accepted version and is
|
|
40
|
+
never pruned. Old snapshots are load-bearing: `getGroupChanges` serves signed
|
|
41
|
+
history from them, so deleting rows breaks catch-up for clients behind that
|
|
42
|
+
version. A snapshot-compaction protocol is future work; budget storage as
|
|
43
|
+
O(versions × state size) per group.
|
|
44
|
+
|
|
45
|
+
## Functions
|
|
46
|
+
|
|
47
|
+
The relay reads these functions through the same generated namespace as the
|
|
48
|
+
rest of the protocol API — `api.signal` in the
|
|
49
|
+
[Convex relay adapter](../README.md). The modules therefore must live inside
|
|
50
|
+
that namespace: `convex/signal/groups.ts` and `convex/signal/zkAuth.ts`, not
|
|
51
|
+
at the top of `convex/`. Both `groups` and `zkAuth` are optional on
|
|
52
|
+
`ConvexSignalProtocolRelayApi`, so a wrong location still compiles; the relay
|
|
53
|
+
then reports the missing `groupServer` capability on the first group call.
|
|
54
|
+
|
|
55
|
+
Create the handlers with the application's one authentication hook:
|
|
56
|
+
|
|
57
|
+
```ts
|
|
58
|
+
// convex/signal/groups.ts
|
|
59
|
+
import {
|
|
60
|
+
defineConvexGroupServer,
|
|
61
|
+
} from "@open-e2ee/signal-protocol-sdk/remote/relay/convex/server";
|
|
62
|
+
import { resolveProtocolIdentity } from "../auth";
|
|
63
|
+
|
|
64
|
+
const server = defineConvexGroupServer({
|
|
65
|
+
identify: async (ctx) => {
|
|
66
|
+
const identity = await resolveProtocolIdentity(ctx);
|
|
67
|
+
return {
|
|
68
|
+
aciBytes: identity.aciBytes,
|
|
69
|
+
pniBytes: identity.pniBytes,
|
|
70
|
+
};
|
|
71
|
+
},
|
|
72
|
+
});
|
|
73
|
+
|
|
74
|
+
export const {
|
|
75
|
+
createGroup,
|
|
76
|
+
getGroup,
|
|
77
|
+
getGroupJoinInfo,
|
|
78
|
+
getGroupChanges,
|
|
79
|
+
submitGroupChange,
|
|
80
|
+
refreshGroupSendEndorsements,
|
|
81
|
+
} = server;
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
Credential functions can be mounted from a second module so the generated API
|
|
85
|
+
matches `ConvexSignalProtocolRelayApi`:
|
|
86
|
+
|
|
87
|
+
```ts
|
|
88
|
+
// convex/signal/zkAuth.ts
|
|
89
|
+
import {
|
|
90
|
+
defineConvexGroupServer,
|
|
91
|
+
} from "@open-e2ee/signal-protocol-sdk/remote/relay/convex/server";
|
|
92
|
+
import { resolveProtocolIdentity } from "../auth";
|
|
93
|
+
|
|
94
|
+
const server = defineConvexGroupServer({
|
|
95
|
+
identify: async (ctx) => {
|
|
96
|
+
const identity = await resolveProtocolIdentity(ctx);
|
|
97
|
+
return {
|
|
98
|
+
aciBytes: identity.aciBytes,
|
|
99
|
+
pniBytes: identity.pniBytes,
|
|
100
|
+
};
|
|
101
|
+
},
|
|
102
|
+
});
|
|
103
|
+
|
|
104
|
+
export const {
|
|
105
|
+
issueAuthCredentialMutation,
|
|
106
|
+
issueProfileKeyCredentialMutation,
|
|
107
|
+
} = server;
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
The `identify` hook drives issuance only. Group reads and writes never trust the
|
|
111
|
+
app session for membership; they verify the supplied zero-knowledge
|
|
112
|
+
presentation and enforce S1–S14 over ciphertext.
|
|
113
|
+
|
|
114
|
+
`identify` must return the authenticated account's real ACI, and its real PNI
|
|
115
|
+
or **no PNI at all**. Never substitute a shared placeholder value for accounts
|
|
116
|
+
without a PNI: credentials are matched by ACI-or-PNI alias, so a constant PNI
|
|
117
|
+
issued to every account would let any authenticated user act on any
|
|
118
|
+
PNI-addressed pending membership. An absent PNI must be absent.
|
|
119
|
+
|
|
120
|
+
## Secret initialization and pinned trust root
|
|
121
|
+
|
|
122
|
+
From the Convex app directory, run:
|
|
123
|
+
|
|
124
|
+
```sh
|
|
125
|
+
npx oe-groups trust-root
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
Add `--prod` for the default production deployment or
|
|
129
|
+
`--deployment <name-or-reference>` for another deployment. The command checks
|
|
130
|
+
`OE_GROUPS_SERVER_SECRET`, generates a cryptographically random 32-byte seed
|
|
131
|
+
only when it is absent, writes it to the selected Convex deployment through
|
|
132
|
+
stdin, and prints the base64 serialized trust root. Pin that printed value in
|
|
133
|
+
the client build. Never fetch and trust it at runtime.
|
|
134
|
+
|
|
135
|
+
The seed remains in the Convex environment and deterministically derives all
|
|
136
|
+
four server keypairs. It is never written to a Convex table or log. Back up the
|
|
137
|
+
deployment secret: deleting or replacing it rotates the trust root and strands
|
|
138
|
+
clients pinned to the previous deployment.
|
|
139
|
+
|
|
140
|
+
## Profile-key issuance threat model
|
|
141
|
+
|
|
142
|
+
`issueProfileKeyCredentialMutation` receives the raw 32-byte profile key. The
|
|
143
|
+
group server therefore sees the plaintext profile key at issuance time. The
|
|
144
|
+
credential proof hides it in later group presentations, but issuance in this
|
|
145
|
+
credential layer is not blinded. Blinded issuance is a future credential-layer
|
|
146
|
+
candidate and is explicitly outside this component's scope.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# In-Memory Relay
|
|
2
2
|
|
|
3
|
-
`
|
|
3
|
+
`MockSignalProtocolRelayServer` implements `ISignalProtocolRelayServer` in memory for examples
|
|
4
4
|
and local application development.
|
|
5
5
|
|
|
6
6
|
Real protocol and cryptography; simulated in-memory infrastructure.
|
|
@@ -0,0 +1,142 @@
|
|
|
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
|
+
] = await Promise.all([
|
|
98
|
+
// pathToFileURL: dynamic import of a bare absolute path fails on
|
|
99
|
+
// Windows, where the ESM loader requires a file:// URL.
|
|
100
|
+
import(
|
|
101
|
+
pathToFileURL(
|
|
102
|
+
path.join(
|
|
103
|
+
scriptDirectory,
|
|
104
|
+
'../dist/internal/protocol/zk/groups/server-params.js'
|
|
105
|
+
)
|
|
106
|
+
).href
|
|
107
|
+
),
|
|
108
|
+
import(
|
|
109
|
+
pathToFileURL(
|
|
110
|
+
path.join(
|
|
111
|
+
scriptDirectory,
|
|
112
|
+
'../dist/internal/groups/trust-root.js'
|
|
113
|
+
)
|
|
114
|
+
).href
|
|
115
|
+
),
|
|
116
|
+
]);
|
|
117
|
+
const secretParams = generateServerSecretParams(seed);
|
|
118
|
+
seed.fill(0);
|
|
119
|
+
const publicParams = getServerPublicParams(secretParams);
|
|
120
|
+
const trustRoot = encodeGroupTrustRoot({
|
|
121
|
+
credentialPublicKey: publicParams.credentialPublicKey,
|
|
122
|
+
serverSigningPublicKey: publicParams.signingPublicKey,
|
|
123
|
+
profileKeyCredentialPublicKey:
|
|
124
|
+
publicParams.profileKeyCredentialPublicKey,
|
|
125
|
+
endorsementRootPublicKey: publicParams.endorsementPublicKey,
|
|
126
|
+
});
|
|
127
|
+
process.stdout.write(`${Buffer.from(trustRoot).toString('base64')}\n`);
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
const [command, ...args] = process.argv.slice(2);
|
|
131
|
+
if (command !== 'trust-root') {
|
|
132
|
+
usage(command ? `Unknown command: ${command}` : undefined);
|
|
133
|
+
} else {
|
|
134
|
+
try {
|
|
135
|
+
await printTrustRoot(args);
|
|
136
|
+
} catch (error) {
|
|
137
|
+
process.stderr.write(
|
|
138
|
+
`${error instanceof Error ? error.message : String(error)}\n`
|
|
139
|
+
);
|
|
140
|
+
process.exitCode = 1;
|
|
141
|
+
}
|
|
142
|
+
}
|