@open-e2ee/signal-protocol-sdk 8.1.0 → 9.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/ADAPTERS.md +13 -31
- package/ARCHITECTURE.md +5 -7
- package/CHANGELOG.md +258 -0
- package/README.md +36 -48
- package/SECURITY.md +2 -2
- package/client/README.md +9 -0
- package/device/README.md +16 -7
- package/dist/client/client.d.ts +25 -16
- package/dist/client/client.d.ts.map +1 -1
- package/dist/client/client.js +115 -95
- 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-outbox.d.ts +31 -1
- package/dist/client/group-outbox.d.ts.map +1 -1
- package/dist/client/group-outbox.js +67 -58
- package/dist/client/group-outbox.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-anonymous-delivery.d.ts +9 -1
- package/dist/client/hosted-anonymous-delivery.d.ts.map +1 -1
- package/dist/client/hosted-anonymous-delivery.js +61 -22
- package/dist/client/hosted-anonymous-delivery.js.map +1 -1
- package/dist/client/hosted-transport.d.ts +7 -0
- package/dist/client/hosted-transport.d.ts.map +1 -1
- package/dist/client/hosted-transport.js +44 -6
- package/dist/client/hosted-transport.js.map +1 -1
- package/dist/client/key-rotation.d.ts.map +1 -1
- package/dist/client/key-rotation.js +2 -4
- package/dist/client/key-rotation.js.map +1 -1
- package/dist/client/prekeys.d.ts.map +1 -1
- package/dist/client/prekeys.js +1 -1
- package/dist/client/prekeys.js.map +1 -1
- package/dist/client/relay-device-refusal.d.ts +32 -0
- package/dist/client/relay-device-refusal.d.ts.map +1 -0
- package/dist/client/relay-device-refusal.js +36 -0
- package/dist/client/relay-device-refusal.js.map +1 -0
- 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/relay-work.d.ts +26 -0
- package/dist/client/relay-work.d.ts.map +1 -1
- package/dist/client/relay-work.js +37 -0
- package/dist/client/relay-work.js.map +1 -1
- package/dist/client/sealed-sender.d.ts.map +1 -1
- package/dist/client/sealed-sender.js +12 -17
- package/dist/client/sealed-sender.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/sessions.d.ts.map +1 -1
- package/dist/client/sessions.js +2 -4
- package/dist/client/sessions.js.map +1 -1
- package/dist/client/signal-service-cipher.d.ts +94 -6
- package/dist/client/signal-service-cipher.d.ts.map +1 -1
- package/dist/client/signal-service-cipher.js +483 -184
- package/dist/client/signal-service-cipher.js.map +1 -1
- package/dist/client/types.d.ts +7 -0
- package/dist/client/types.d.ts.map +1 -1
- package/dist/client/types.js.map +1 -1
- package/dist/index.d.ts +27 -21
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +8 -17
- 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 +8 -7
- package/dist/internal/manager/manager.d.ts.map +1 -1
- package/dist/internal/manager/manager.js +34 -37
- 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/index.d.ts +1 -1
- package/dist/internal/protocol/spqr/index.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/index.js +2 -2
- package/dist/internal/protocol/spqr/index.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/rs/codec.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/rs/codec.js +1 -3
- package/dist/internal/protocol/spqr/ml-kem-braid/rs/codec.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/serialize.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/serialize.js +1 -4
- package/dist/internal/protocol/spqr/serialize.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 +2 -3
- package/dist/internal/protocol/spqr/spqr.js.map +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/sesame/device-registry.d.ts +24 -4
- package/dist/internal/sesame/device-registry.d.ts.map +1 -1
- package/dist/internal/sesame/device-registry.js +55 -28
- package/dist/internal/sesame/device-registry.js.map +1 -1
- package/dist/internal/sesame/manager.d.ts +79 -11
- package/dist/internal/sesame/manager.d.ts.map +1 -1
- package/dist/internal/sesame/manager.js +381 -280
- package/dist/internal/sesame/manager.js.map +1 -1
- package/dist/internal/session/cipher.d.ts +0 -5
- package/dist/internal/session/cipher.d.ts.map +1 -1
- package/dist/internal/session/cipher.js +3 -9
- package/dist/internal/session/cipher.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/internal/session/record-locks.d.ts +46 -0
- package/dist/internal/session/record-locks.d.ts.map +1 -0
- package/dist/internal/session/record-locks.js +72 -0
- package/dist/internal/session/record-locks.js.map +1 -0
- package/dist/local/store/expo/adapter.d.ts +8 -2
- package/dist/local/store/expo/adapter.d.ts.map +1 -1
- package/dist/local/store/expo/adapter.js +24 -3
- package/dist/local/store/expo/adapter.js.map +1 -1
- package/dist/local/store/expo/driver.d.ts +7 -0
- package/dist/local/store/expo/driver.d.ts.map +1 -1
- package/dist/local/store/expo/driver.js +16 -0
- package/dist/local/store/expo/driver.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 +91 -53
- 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 +13 -3
- package/dist/local/store/memory/adapter.d.ts.map +1 -1
- package/dist/local/store/memory/adapter.js +122 -73
- package/dist/local/store/memory/adapter.js.map +1 -1
- package/dist/local/store/reliability.d.ts +16 -0
- package/dist/local/store/reliability.d.ts.map +1 -1
- package/dist/local/store/reliability.js +58 -28
- package/dist/local/store/reliability.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 +53 -23
- 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 +122 -73
- package/dist/local/store/web/adapter.js.map +1 -1
- package/dist/local/vault/electron-safe-storage.d.ts.map +1 -1
- package/dist/local/vault/electron-safe-storage.js +15 -2
- package/dist/local/vault/electron-safe-storage.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/own-profile-key.d.ts +42 -0
- package/dist/profile/own-profile-key.d.ts.map +1 -0
- package/dist/profile/own-profile-key.js +64 -0
- package/dist/profile/own-profile-key.js.map +1 -0
- package/dist/profile/profile-key.d.ts +1 -34
- package/dist/profile/profile-key.d.ts.map +1 -1
- package/dist/profile/profile-key.js +3 -63
- package/dist/profile/profile-key.js.map +1 -1
- package/dist/profile/update-service.js +1 -1
- package/dist/profile/update-service.js.map +1 -1
- 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/username/link.d.ts.map +1 -1
- package/dist/username/link.js +1 -5
- package/dist/username/link.js.map +1 -1
- package/dist/utils/bounded-fan-out.d.ts +99 -0
- package/dist/utils/bounded-fan-out.d.ts.map +1 -0
- package/dist/utils/bounded-fan-out.js +180 -0
- package/dist/utils/bounded-fan-out.js.map +1 -0
- package/dist/utils/keyed-lock.d.ts +16 -0
- package/dist/utils/keyed-lock.d.ts.map +1 -0
- package/dist/utils/keyed-lock.js +39 -0
- package/dist/utils/keyed-lock.js.map +1 -0
- 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 +69 -28
- package/docs/CLIENT_COMPOSITION.md +9 -3
- package/docs/DEVIATIONS.md +45 -27
- package/docs/GETTING_STARTED.md +42 -320
- package/docs/INTERFACES.md +7 -7
- package/docs/PACKAGE_SURFACE.md +14 -16
- package/docs/RECIPES.md +6 -112
- package/groups/README.md +9 -1
- package/hooks/README.md +11 -2
- package/local/store/README.md +26 -6
- package/local/store/expo/README.md +18 -5
- package/local/store/key-value/README.md +5 -3
- package/local/store/node/README.md +2 -1
- package/local/store/web-sqlite/README.md +28 -8
- package/local/vault/README.md +21 -2
- package/package.json +1 -30
- package/remote/README.md +12 -78
- package/remote/object-store/convex-r2/README.md +20 -42
- package/remote/relay/README.md +21 -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 -1058
- 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
package/dist/client/client.js
CHANGED
|
@@ -10,18 +10,15 @@
|
|
|
10
10
|
*
|
|
11
11
|
* @example Basic usage
|
|
12
12
|
* ```typescript
|
|
13
|
-
* import {
|
|
14
|
-
* import { inMemoryStore } from '@open-e2ee/signal-protocol-sdk/local/store/memory';
|
|
15
|
-
* import { inMemoryRelay } from '@open-e2ee/signal-protocol-sdk/remote/relay/memory';
|
|
13
|
+
* import { createHostedSignalProtocolClient } from '@open-e2ee/signal-protocol-sdk';
|
|
16
14
|
*
|
|
17
|
-
*
|
|
18
|
-
* const signal = await
|
|
19
|
-
*
|
|
20
|
-
*
|
|
15
|
+
* // Supply a device-local store and the configured identity-provider callback.
|
|
16
|
+
* const signal = await createHostedSignalProtocolClient({
|
|
17
|
+
* adapters: { storage },
|
|
18
|
+
* hosted: { relayUrl, getIdentityAssertion },
|
|
21
19
|
* });
|
|
22
20
|
*
|
|
23
|
-
* await signal.
|
|
24
|
-
* await signal.send('bob', 'Hello!');
|
|
21
|
+
* await signal.send(recipientUserId, 'Hello!');
|
|
25
22
|
* ```
|
|
26
23
|
*
|
|
27
24
|
* @example With product security policy
|
|
@@ -50,17 +47,24 @@ import { DefaultSesameManager } from '../internal/sesame/index.js';
|
|
|
50
47
|
import { createCompositeIdentityV1 } from '../keys/identity.js';
|
|
51
48
|
import { EncryptionError, EncryptionErrorCode } from '../types/index.js';
|
|
52
49
|
import { base64ToBytes, bytesToBase64, constantTimeEqual } from '../internal/crypto/index.js';
|
|
50
|
+
import { deriveGroupSecretParams, getGroupPublicParams } from '../internal/protocol/zk/groups/index.js';
|
|
51
|
+
import { SERVICE_ID_ACI } from '../internal/protocol/zk/groups/uid-struct.js';
|
|
52
|
+
import { deserializeSenderCertificate, validateSenderCertificate, } from '../internal/protocol/sealed-sender/index.js';
|
|
53
|
+
import { deferHooks } from './event-hooks.js';
|
|
53
54
|
import { ProtocolAddress } from '../types/address.js';
|
|
54
|
-
import { getActiveIdentityTypes, resolveSignalProtocolStrategy, } from './config.js';
|
|
55
|
+
import { getActiveIdentityTypes, resolveSignalProtocolStrategy, SEALED_SENDER_CERTIFICATE_MARGIN_MS, } from './config.js';
|
|
55
56
|
import { resolveSignalProtocolLogger } from '../logger.js';
|
|
56
57
|
import { SenderKeyManager, } from '../internal/protocol/sender-keys/index.js';
|
|
57
58
|
import { createDefaultSignalProtocolContentAdapter, } from './content-adapter.js';
|
|
58
59
|
// Note: group utilities (isGroupId, extractGroupId, createGroupId) are used by SignalProtocolServiceCipher
|
|
59
60
|
import { isGroupId } from '../internal/groups/index.js';
|
|
61
|
+
import { GroupSenderKeyOperations } from './group-sender-key-operations.js';
|
|
62
|
+
import { createGroupReceiveAuthorizer } from './group-receive-authorization.js';
|
|
60
63
|
import { profileKeyExchange } from './profile-key-exchange.js';
|
|
61
64
|
import { SignalProtocolServiceCipher, sortEnvelopesForDecryption, } from './signal-service-cipher.js';
|
|
62
65
|
import { establishMultiDeviceSessions } from '../internal/sesame/device-registry.js';
|
|
63
66
|
import { isRetryableDecryptionError } from './retry-utils.js';
|
|
67
|
+
import { envelopeTypeForContent, unsealMessage } from './sealed-sender.js';
|
|
64
68
|
import { MESSAGE_RECORD_TTL_MS } from './constants.js';
|
|
65
69
|
import { ReceiptType } from './types.js';
|
|
66
70
|
import * as MessageOps from './messages.js';
|
|
@@ -72,7 +76,7 @@ import * as PreKeyOps from './prekeys.js';
|
|
|
72
76
|
import * as RetryOps from './retry.js';
|
|
73
77
|
import * as RelaySubscriptionOps from './relay-subscription.js';
|
|
74
78
|
import { SignalProtocolClientState, SIGNAL_PROTOCOL_CLIENT_CONSTANTS } from './state.js';
|
|
75
|
-
import { rethrowRelayWorkStopped } from './relay-work.js';
|
|
79
|
+
import { clientRelayFanOut, rethrowRelayWorkStopped } from './relay-work.js';
|
|
76
80
|
import { deleteMediaAttachment, resolveMediaAttachment, } from '../media/index.js';
|
|
77
81
|
import { StorageBackedSignalProtocolClientMedia } from './media.js';
|
|
78
82
|
// Group state (Signal Private Group System)
|
|
@@ -138,12 +142,16 @@ export class DefaultSignalProtocolClient {
|
|
|
138
142
|
_address; // Cached own address
|
|
139
143
|
// Group messaging support (Sender Keys)
|
|
140
144
|
senderKeyManager;
|
|
145
|
+
groupSenderKeys;
|
|
141
146
|
// Group state management
|
|
142
147
|
groupManager;
|
|
143
148
|
groupSessionFor;
|
|
144
149
|
groupStore;
|
|
150
|
+
groupReceiveAuthorizer;
|
|
145
151
|
// Cipher coordination (encrypts/decrypts, routes to appropriate cipher)
|
|
146
152
|
cipher;
|
|
153
|
+
// The relay request bound that every fan-out of this client shares
|
|
154
|
+
fanOut;
|
|
147
155
|
/**
|
|
148
156
|
* Durable media job facade backed by the configured Signal Protocol local store.
|
|
149
157
|
*
|
|
@@ -218,6 +226,8 @@ export class DefaultSignalProtocolClient {
|
|
|
218
226
|
this.contentAdapter = config.contentAdapter ?? createDefaultSignalProtocolContentAdapter();
|
|
219
227
|
// Dependency injection: use the provided relay adapter when configured.
|
|
220
228
|
this.relay = config.relay;
|
|
229
|
+
// A relay adapter that sends relay requests itself shares its bound.
|
|
230
|
+
this.fanOut = clientRelayFanOut(config.relay);
|
|
221
231
|
// Dependency injection: use the remote object store for encrypted attachments.
|
|
222
232
|
this.remoteObjectStore = config.remoteObjectStore;
|
|
223
233
|
// Dependency injection: Storage is always provided by create() callers.
|
|
@@ -246,6 +256,7 @@ export class DefaultSignalProtocolClient {
|
|
|
246
256
|
this.sesameManager.setMessageRecordStore(this._storage);
|
|
247
257
|
// Initialize Sender Key manager for group messaging
|
|
248
258
|
this.senderKeyManager = new SenderKeyManager(this._storage, config?.senderKeys, this.logger);
|
|
259
|
+
this.groupSenderKeys = new GroupSenderKeyOperations(this._storage, userId, deviceId);
|
|
249
260
|
// Initialize the group manager if configured
|
|
250
261
|
if (config?.groups) {
|
|
251
262
|
const groupConfig = config.groups;
|
|
@@ -296,8 +307,7 @@ export class DefaultSignalProtocolClient {
|
|
|
296
307
|
profileKeyCredentialPublicKey: trustRoot.profileKeyCredentialPublicKey,
|
|
297
308
|
profileKey: groupConfig.profileKey,
|
|
298
309
|
onSenderKeyRotation: async (groupId) => {
|
|
299
|
-
|
|
300
|
-
await this.rotateGroupSenderKey(groupId);
|
|
310
|
+
await this.groupSenderKeys.run(groupId, (rawGroupId) => GroupOps.rotateGroupSenderKey(this.ctx, this.senderKeyManager, rawGroupId, this.config.onGroupSenderKeyRotated, { distributionPending: true }));
|
|
301
311
|
},
|
|
302
312
|
onEndorsementsInvalidated: endorsementManager
|
|
303
313
|
? async (groupId) => {
|
|
@@ -312,7 +322,7 @@ export class DefaultSignalProtocolClient {
|
|
|
312
322
|
this.groupManager = this.groupSessionFor(config.groups).manager;
|
|
313
323
|
}
|
|
314
324
|
// Initialize cipher for encrypt/decrypt coordination
|
|
315
|
-
this.cipher = new SignalProtocolServiceCipher(this._userId, deviceId, this.sesameManager, this.senderKeyManager, this._storage, this.relay, this.remoteObjectStore, this.contentAdapter, this.logger);
|
|
325
|
+
this.cipher = new SignalProtocolServiceCipher(this._userId, deviceId, this.sesameManager, this.senderKeyManager, this._storage, this.relay, this.remoteObjectStore, this.contentAdapter, this.logger, this.fanOut);
|
|
316
326
|
if (this.groupManager) {
|
|
317
327
|
this.cipher.setGroupSendBarrierChecker((groupId) => this.groupManager.assertGroupSendAllowed(groupId));
|
|
318
328
|
}
|
|
@@ -335,11 +345,10 @@ export class DefaultSignalProtocolClient {
|
|
|
335
345
|
if (!identityKeyPair) {
|
|
336
346
|
throw new EncryptionError('No identity key pair for sealed sender', EncryptionErrorCode.INITIALIZATION_FAILED);
|
|
337
347
|
}
|
|
338
|
-
const { base64ToBytes: b64ToBytes } = await import('../internal/crypto/index.js');
|
|
339
348
|
return {
|
|
340
349
|
senderCertificateBase64: certBase64,
|
|
341
|
-
senderIdentityPrivate:
|
|
342
|
-
senderIdentityPublic:
|
|
350
|
+
senderIdentityPrivate: base64ToBytes(identityKeyPair.dhKey.privateKey),
|
|
351
|
+
senderIdentityPublic: base64ToBytes(identityKeyPair.dhKey.publicKey),
|
|
343
352
|
config: this.config.sealedSender,
|
|
344
353
|
};
|
|
345
354
|
});
|
|
@@ -354,25 +363,12 @@ export class DefaultSignalProtocolClient {
|
|
|
354
363
|
// Set up group secret params provider. Derives params from master key in store
|
|
355
364
|
if (this.groupStore) {
|
|
356
365
|
const store = this.groupStore;
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
this.cipher.setGroupReceiveAuthorizer(async (groupId, senderId) => {
|
|
360
|
-
if (!resolveAcis || !localAci) {
|
|
361
|
-
throw new Error('Group reception requires authenticated account ACI resolution');
|
|
362
|
-
}
|
|
363
|
-
const state = await store.getGroupState(groupId);
|
|
364
|
-
const senderAci = (await resolveAcis([senderId])).get(senderId);
|
|
365
|
-
if (!state || !senderAci ||
|
|
366
|
-
!state.members.some((member) => constantTimeEqual(member.aciBytes, senderAci)) ||
|
|
367
|
-
!state.members.some((member) => constantTimeEqual(member.aciBytes, localAci))) {
|
|
368
|
-
throw new Error('Group sender and recipient must be members of the verified local group');
|
|
369
|
-
}
|
|
370
|
-
});
|
|
366
|
+
this.groupReceiveAuthorizer = createGroupReceiveAuthorizer(store, config.aci?.uuid, config.groups?.resolveAciBytesByUserIds);
|
|
367
|
+
this.cipher.setGroupReceiveAuthorizer(this.groupReceiveAuthorizer);
|
|
371
368
|
this.cipher.setGroupSecretParamsProvider(async (groupId) => {
|
|
372
369
|
const masterKey = await store.getMasterKey(groupId);
|
|
373
370
|
if (!masterKey)
|
|
374
371
|
return null;
|
|
375
|
-
const { deriveGroupSecretParams } = await import('../internal/protocol/zk/groups/index.js');
|
|
376
372
|
return deriveGroupSecretParams(masterKey);
|
|
377
373
|
});
|
|
378
374
|
}
|
|
@@ -397,7 +393,6 @@ export class DefaultSignalProtocolClient {
|
|
|
397
393
|
const masterKey = await groupStore.getMasterKey(groupId);
|
|
398
394
|
if (!masterKey)
|
|
399
395
|
return false;
|
|
400
|
-
const { deriveGroupSecretParams, getGroupPublicParams } = await import('../internal/protocol/zk/groups/index.js');
|
|
401
396
|
const secretParams = deriveGroupSecretParams(masterKey);
|
|
402
397
|
// 3. Derive the protocol identifier, not the display identifier's UTF-8 bytes.
|
|
403
398
|
const groupIdBytes = getGroupPublicParams(secretParams).groupId;
|
|
@@ -410,7 +405,6 @@ export class DefaultSignalProtocolClient {
|
|
|
410
405
|
// 6. Build ACI→userId mapping from known members + self.
|
|
411
406
|
// Endorsements are issued in group-state member order, so we must
|
|
412
407
|
// build parallel arrays matching that order.
|
|
413
|
-
const { SERVICE_ID_ACI } = await import('../internal/protocol/zk/groups/uid-struct.js');
|
|
414
408
|
const allUserIds = [...memberUserIds, selfUserId];
|
|
415
409
|
const aciHexToUserId = new Map();
|
|
416
410
|
const resolvedAciBytes = groupConfig.resolveAciBytesByUserIds
|
|
@@ -490,7 +484,6 @@ export class DefaultSignalProtocolClient {
|
|
|
490
484
|
* @throws if no certificate provider is available
|
|
491
485
|
*/
|
|
492
486
|
async fetchSenderCertificate() {
|
|
493
|
-
const { SEALED_SENDER_CERTIFICATE_MARGIN_MS } = await import('./config.js');
|
|
494
487
|
const now = Date.now();
|
|
495
488
|
if (this.cachedSenderCertificate && now < this.cachedCertificateExpiry) {
|
|
496
489
|
return this.cachedSenderCertificate;
|
|
@@ -510,7 +503,6 @@ export class DefaultSignalProtocolClient {
|
|
|
510
503
|
else {
|
|
511
504
|
throw new EncryptionError('No sender certificate provider configured. Set sealedSender.certificateProvider or use a relay that supports fetchSenderCertificate.', EncryptionErrorCode.INITIALIZATION_FAILED);
|
|
512
505
|
}
|
|
513
|
-
const { deserializeSenderCertificate, validateSenderCertificate } = await import('../internal/protocol/sealed-sender/index.js');
|
|
514
506
|
let certificate;
|
|
515
507
|
try {
|
|
516
508
|
certificate = deserializeSenderCertificate(base64ToBytes(certBase64));
|
|
@@ -577,11 +569,10 @@ export class DefaultSignalProtocolClient {
|
|
|
577
569
|
* waits for the recipient's lock only until stop() stops the work.
|
|
578
570
|
*/
|
|
579
571
|
retryCallbacks(work, ctx) {
|
|
580
|
-
const sessions = this.sendSessionCallbacks(() => ctx);
|
|
581
572
|
return {
|
|
582
573
|
archiveSession: (address) => SessionOps.archiveSession(ctx, address),
|
|
583
574
|
establishSession: (address, bundle) => SessionOps.establishSession(ctx, this.sesameManager, address, bundle),
|
|
584
|
-
send: (recipientId, content, options) => this.
|
|
575
|
+
send: (recipientId, content, options) => this.sendWithContext(recipientId, content, options, ctx, work.stopSignal),
|
|
585
576
|
forcePreKeyRotation: () => this.regeneratePreKeysWithFreshIds(),
|
|
586
577
|
};
|
|
587
578
|
}
|
|
@@ -610,18 +601,22 @@ export class DefaultSignalProtocolClient {
|
|
|
610
601
|
}
|
|
611
602
|
/**
|
|
612
603
|
* Session callbacks of a send. Their session hooks run through the given
|
|
613
|
-
* context, so a send in relay work calls the app through that work.
|
|
614
|
-
*
|
|
604
|
+
* context, so a send in relay work calls the app through that work. Session
|
|
605
|
+
* setup sends its relay requests under the client's relay request bound, and
|
|
606
|
+
* the stop signal ends it. There are none without a relay.
|
|
615
607
|
*/
|
|
616
|
-
sendSessionCallbacks(context) {
|
|
608
|
+
sendSessionCallbacks(context, stopSignal) {
|
|
617
609
|
const relay = this.relay;
|
|
618
610
|
if (!relay)
|
|
619
611
|
return undefined;
|
|
620
612
|
const establishSession = (address, bundle) => SessionOps.establishSession(context(), this.sesameManager, address, bundle);
|
|
621
613
|
return {
|
|
622
|
-
establishSessions: (recipientUserId) => establishMultiDeviceSessions(this, relay, recipientUserId, {
|
|
614
|
+
establishSessions: (recipientUserId, listedDevices) => establishMultiDeviceSessions(this, relay, recipientUserId, {
|
|
623
615
|
establishSession,
|
|
624
616
|
rethrowFatal: rethrowRelayWorkStopped,
|
|
617
|
+
fanOut: this.fanOut,
|
|
618
|
+
stopSignal,
|
|
619
|
+
...(listedDevices && { listedDevices }),
|
|
625
620
|
}),
|
|
626
621
|
// Stale-device recovery archives the old session, fetches a fresh bundle,
|
|
627
622
|
// and establishes a replacement.
|
|
@@ -636,7 +631,7 @@ export class DefaultSignalProtocolClient {
|
|
|
636
631
|
data: { recipientUserId, recipientDeviceId },
|
|
637
632
|
});
|
|
638
633
|
// 2. Fetch fresh prekey bundle
|
|
639
|
-
const freshBundle = await relay.fetchPreKeyBundle(recipientUserId, recipientDeviceId);
|
|
634
|
+
const freshBundle = await this.fanOut.request(() => relay.fetchPreKeyBundle(recipientUserId, recipientDeviceId), stopSignal);
|
|
640
635
|
if (!freshBundle) {
|
|
641
636
|
this.logger.warn('No prekey bundle available for stale session refresh', {
|
|
642
637
|
category: 'E2EE',
|
|
@@ -672,6 +667,24 @@ export class DefaultSignalProtocolClient {
|
|
|
672
667
|
},
|
|
673
668
|
};
|
|
674
669
|
}
|
|
670
|
+
/**
|
|
671
|
+
* Run a task with hooks that the task queues and this method calls after
|
|
672
|
+
* the task settles. A task that holds a group's Sender Key lock uses it, so
|
|
673
|
+
* a hook can call a client method that takes the same lock.
|
|
674
|
+
*/
|
|
675
|
+
async withDeferredHooks(context, task) {
|
|
676
|
+
const deferred = deferHooks(context.hooks);
|
|
677
|
+
let result;
|
|
678
|
+
try {
|
|
679
|
+
result = await task({ ...context, hooks: deferred.hooks });
|
|
680
|
+
}
|
|
681
|
+
catch (error) {
|
|
682
|
+
await deferred.flush().catch(() => undefined);
|
|
683
|
+
throw error;
|
|
684
|
+
}
|
|
685
|
+
await deferred.flush();
|
|
686
|
+
return result;
|
|
687
|
+
}
|
|
675
688
|
/**
|
|
676
689
|
* Get relay subscription config
|
|
677
690
|
*/
|
|
@@ -697,7 +710,6 @@ export class DefaultSignalProtocolClient {
|
|
|
697
710
|
* @example
|
|
698
711
|
* ```typescript
|
|
699
712
|
* import { DefaultSignalProtocolClient } from '@open-e2ee/signal-protocol-sdk';
|
|
700
|
-
* import { inMemoryRelay } from '@open-e2ee/signal-protocol-sdk/remote/relay/memory';
|
|
701
713
|
*
|
|
702
714
|
* // Local-only primary device.
|
|
703
715
|
* const signal = await DefaultSignalProtocolClient.create('user-123', {
|
|
@@ -710,8 +722,8 @@ export class DefaultSignalProtocolClient {
|
|
|
710
722
|
* storage: provisionedLinkedDeviceStorage
|
|
711
723
|
* });
|
|
712
724
|
*
|
|
713
|
-
* // With relay
|
|
714
|
-
* const relay =
|
|
725
|
+
* // With an application-owned authenticated relay transport.
|
|
726
|
+
* const relay = appRelayTransport;
|
|
715
727
|
* const signal = await DefaultSignalProtocolClient.create('user-123', {
|
|
716
728
|
* storage,
|
|
717
729
|
* relay,
|
|
@@ -1163,7 +1175,6 @@ export class DefaultSignalProtocolClient {
|
|
|
1163
1175
|
async processIncomingEnvelope(envelope, options) {
|
|
1164
1176
|
// Handle sealed sender envelopes: unseal to reveal sender before decrypting
|
|
1165
1177
|
if (envelope.messageType === 'unidentified_sender' && this.config.sealedSender) {
|
|
1166
|
-
const { unsealMessage, envelopeTypeForContent } = await import('./sealed-sender.js');
|
|
1167
1178
|
const identityKeyPair = await this._storage.getIdentityKey();
|
|
1168
1179
|
if (!identityKeyPair) {
|
|
1169
1180
|
throw new EncryptionError('No identity key pair for sealed sender decryption', EncryptionErrorCode.DECRYPTION_FAILED);
|
|
@@ -1395,13 +1406,13 @@ export class DefaultSignalProtocolClient {
|
|
|
1395
1406
|
* ```
|
|
1396
1407
|
*/
|
|
1397
1408
|
async send(recipientId, content, options) {
|
|
1398
|
-
return this.
|
|
1409
|
+
return this.sendWithContext(recipientId, content, options, this.ctx, undefined);
|
|
1399
1410
|
}
|
|
1400
1411
|
/**
|
|
1401
|
-
* Send with
|
|
1412
|
+
* Send with session callbacks whose hooks run through the given context.
|
|
1402
1413
|
* The stop signal of relay work ends a wait for the recipient's lock.
|
|
1403
1414
|
*/
|
|
1404
|
-
async
|
|
1415
|
+
async sendWithContext(recipientId, content, options, context, stopSignal) {
|
|
1405
1416
|
// Normalize all inputs to Uint8Array before calling cipher.encrypt()
|
|
1406
1417
|
let plaintextBytes;
|
|
1407
1418
|
let clientTimestamp;
|
|
@@ -1424,10 +1435,14 @@ export class DefaultSignalProtocolClient {
|
|
|
1424
1435
|
await profileKeys?.offer(recipientId);
|
|
1425
1436
|
plaintextBytes = content; // already Uint8Array
|
|
1426
1437
|
}
|
|
1427
|
-
const
|
|
1438
|
+
const encrypt = (sendContext) => this.cipher.encrypt(recipientId, plaintextBytes, {
|
|
1428
1439
|
...options,
|
|
1429
1440
|
...(clientTimestamp !== undefined && { timestamp: clientTimestamp }),
|
|
1430
|
-
},
|
|
1441
|
+
}, this.sendSessionCallbacks(() => sendContext, stopSignal), stopSignal);
|
|
1442
|
+
// A group send sets up sessions while it holds the group's Sender Key lock.
|
|
1443
|
+
const result = await (isGroupId(recipientId)
|
|
1444
|
+
? this.withDeferredHooks(context, encrypt)
|
|
1445
|
+
: encrypt(context));
|
|
1431
1446
|
if (profileKey)
|
|
1432
1447
|
await profileKeys?.delivered(recipientId, profileKey);
|
|
1433
1448
|
return clientTimestamp !== undefined ? { ...result, clientTimestamp } : result;
|
|
@@ -1611,7 +1626,7 @@ export class DefaultSignalProtocolClient {
|
|
|
1611
1626
|
this.state.relayWork
|
|
1612
1627
|
.run((work) => {
|
|
1613
1628
|
const ctx = this.relayWorkContext(work);
|
|
1614
|
-
return RelaySubscriptionOps.handleRelayMessage({ ...ctx, cipher: this.cipher }, envelope, this.relaySubscriptionState, this.relaySubscriptionCallbacks(ctx), this.relaySubscriptionConfig);
|
|
1629
|
+
return RelaySubscriptionOps.handleRelayMessage({ ...ctx, cipher: this.cipher, stopSignal: work.stopSignal }, envelope, this.relaySubscriptionState, this.relaySubscriptionCallbacks(ctx), this.relaySubscriptionConfig);
|
|
1615
1630
|
})
|
|
1616
1631
|
.catch((error) => {
|
|
1617
1632
|
// The relay does not wait for the handler. It delivers the envelope again.
|
|
@@ -2056,7 +2071,7 @@ export class DefaultSignalProtocolClient {
|
|
|
2056
2071
|
* ```
|
|
2057
2072
|
*/
|
|
2058
2073
|
async createGroupSenderKey(groupId) {
|
|
2059
|
-
return GroupOps.createGroupSenderKey(this.ctx, this.senderKeyManager,
|
|
2074
|
+
return this.groupSenderKeys.run(groupId, (rawGroupId) => GroupOps.createGroupSenderKey(this.ctx, this.senderKeyManager, rawGroupId));
|
|
2060
2075
|
}
|
|
2061
2076
|
/**
|
|
2062
2077
|
* Process a sender key distribution message from another group member
|
|
@@ -2082,7 +2097,10 @@ export class DefaultSignalProtocolClient {
|
|
|
2082
2097
|
* ```
|
|
2083
2098
|
*/
|
|
2084
2099
|
async processGroupSenderKeyDistribution(groupId, senderId, senderDeviceId, message) {
|
|
2085
|
-
return
|
|
2100
|
+
return this.groupSenderKeys.run(groupId, async (rawGroupId) => {
|
|
2101
|
+
await this.groupReceiveAuthorizer?.(rawGroupId, senderId, 'distribution');
|
|
2102
|
+
return GroupOps.processSenderKeyDistribution(this.ctx, this.senderKeyManager, rawGroupId, senderId, senderDeviceId, message);
|
|
2103
|
+
});
|
|
2086
2104
|
}
|
|
2087
2105
|
/**
|
|
2088
2106
|
* Encrypt a message for group using sender key (O(1) encryption)
|
|
@@ -2107,9 +2125,9 @@ export class DefaultSignalProtocolClient {
|
|
|
2107
2125
|
* ```
|
|
2108
2126
|
*/
|
|
2109
2127
|
async encryptGroupMessage(groupId, plaintext) {
|
|
2110
|
-
return GroupOps.encryptGroupMessage(this.ctx, this.senderKeyManager,
|
|
2128
|
+
return this.groupSenderKeys.run(groupId, (rawGroupId) => GroupOps.encryptGroupMessage(this.ctx, this.senderKeyManager, rawGroupId, plaintext, this.groupManager
|
|
2111
2129
|
? (candidateGroupId) => this.groupManager.assertGroupSendAllowed(candidateGroupId)
|
|
2112
|
-
: undefined);
|
|
2130
|
+
: undefined));
|
|
2113
2131
|
}
|
|
2114
2132
|
/**
|
|
2115
2133
|
* Decrypt a group message from a sender
|
|
@@ -2135,7 +2153,10 @@ export class DefaultSignalProtocolClient {
|
|
|
2135
2153
|
* ```
|
|
2136
2154
|
*/
|
|
2137
2155
|
async decryptGroupMessage(groupId, senderId, senderDeviceId, framedMessage) {
|
|
2138
|
-
return
|
|
2156
|
+
return this.groupSenderKeys.run(groupId, async (rawGroupId) => {
|
|
2157
|
+
await this.groupReceiveAuthorizer?.(rawGroupId, senderId, 'message');
|
|
2158
|
+
return GroupOps.decryptGroupMessage(this.ctx, this.senderKeyManager, rawGroupId, senderId, senderDeviceId, framedMessage);
|
|
2159
|
+
});
|
|
2139
2160
|
}
|
|
2140
2161
|
/**
|
|
2141
2162
|
* Rotate sender key for a group (forward secrecy on membership changes).
|
|
@@ -2194,7 +2215,7 @@ export class DefaultSignalProtocolClient {
|
|
|
2194
2215
|
* @see handleGroupMembershipChange - Helper method for common membership patterns
|
|
2195
2216
|
*/
|
|
2196
2217
|
async rotateGroupSenderKey(groupId) {
|
|
2197
|
-
return GroupOps.rotateGroupSenderKey(this.ctx, this.senderKeyManager,
|
|
2218
|
+
return this.groupSenderKeys.run(groupId, (rawGroupId) => GroupOps.rotateGroupSenderKey(this.ctx, this.senderKeyManager, rawGroupId, this.config.onGroupSenderKeyRotated));
|
|
2198
2219
|
}
|
|
2199
2220
|
/**
|
|
2200
2221
|
* Delete sender key when leaving a group
|
|
@@ -2202,7 +2223,7 @@ export class DefaultSignalProtocolClient {
|
|
|
2202
2223
|
* @param groupId - Group identifier
|
|
2203
2224
|
*/
|
|
2204
2225
|
async deleteGroupSenderKey(groupId) {
|
|
2205
|
-
return GroupOps.deleteGroupSenderKey(this.ctx, this.senderKeyManager,
|
|
2226
|
+
return this.groupSenderKeys.run(groupId, (rawGroupId) => GroupOps.deleteGroupSenderKey(this.ctx, this.senderKeyManager, rawGroupId));
|
|
2206
2227
|
}
|
|
2207
2228
|
/**
|
|
2208
2229
|
* Check if we have a sender key for a group
|
|
@@ -2211,7 +2232,7 @@ export class DefaultSignalProtocolClient {
|
|
|
2211
2232
|
* @returns True if sender key exists for this device
|
|
2212
2233
|
*/
|
|
2213
2234
|
async hasGroupSenderKey(groupId) {
|
|
2214
|
-
return GroupOps.hasGroupSenderKey(this.ctx,
|
|
2235
|
+
return this.groupSenderKeys.run(groupId, (rawGroupId) => GroupOps.hasGroupSenderKey(this.ctx, rawGroupId));
|
|
2215
2236
|
}
|
|
2216
2237
|
/**
|
|
2217
2238
|
* Get the current sender key distribution message for a group
|
|
@@ -2222,7 +2243,7 @@ export class DefaultSignalProtocolClient {
|
|
|
2222
2243
|
* @returns Distribution message or null if no key exists
|
|
2223
2244
|
*/
|
|
2224
2245
|
async getGroupSenderKeyDistribution(groupId) {
|
|
2225
|
-
return GroupOps.getGroupSenderKeyDistribution(this.ctx,
|
|
2246
|
+
return this.groupSenderKeys.run(groupId, (rawGroupId) => GroupOps.getGroupSenderKeyDistribution(this.ctx, rawGroupId));
|
|
2226
2247
|
}
|
|
2227
2248
|
/**
|
|
2228
2249
|
* Distribute sender key to a specific user via pairwise encryption.
|
|
@@ -2245,21 +2266,23 @@ export class DefaultSignalProtocolClient {
|
|
|
2245
2266
|
* ```
|
|
2246
2267
|
*/
|
|
2247
2268
|
async distributeSenderKeyToUser(groupId, recipientUserId) {
|
|
2248
|
-
|
|
2249
|
-
if (recipientUserId === this.userId) {
|
|
2269
|
+
if (recipientUserId === this.userId)
|
|
2250
2270
|
return;
|
|
2251
|
-
|
|
2252
|
-
|
|
2253
|
-
|
|
2254
|
-
|
|
2255
|
-
|
|
2256
|
-
|
|
2257
|
-
|
|
2258
|
-
|
|
2259
|
-
|
|
2271
|
+
return this.withDeferredHooks(this.ctx, (context) => this.groupSenderKeys.run(groupId, async (rawGroupId) => {
|
|
2272
|
+
const distribution = await this.getOrCreateSenderKeyDistribution(rawGroupId);
|
|
2273
|
+
await this.sendSenderKeyDistribution(rawGroupId, recipientUserId, distribution, context);
|
|
2274
|
+
}));
|
|
2275
|
+
}
|
|
2276
|
+
/** Called only while this client holds the group's Sender Key operation. */
|
|
2277
|
+
async getOrCreateSenderKeyDistribution(groupId) {
|
|
2278
|
+
const distribution = await GroupOps.getGroupSenderKeyDistribution(this.ctx, groupId);
|
|
2279
|
+
if (distribution)
|
|
2280
|
+
return distribution;
|
|
2281
|
+
return (await GroupOps.createGroupSenderKey(this.ctx, this.senderKeyManager, groupId)).distributionMessage;
|
|
2282
|
+
}
|
|
2283
|
+
async sendSenderKeyDistribution(groupId, recipientUserId, distribution, context) {
|
|
2260
2284
|
const payload = this.contentAdapter.serializeSenderKeyDistributionText(groupId, distribution);
|
|
2261
|
-
|
|
2262
|
-
await this.send(recipientUserId, payload);
|
|
2285
|
+
await this.sendWithContext(recipientUserId, payload, undefined, context, undefined);
|
|
2263
2286
|
this.logger.debug('Distributed sender key to user', {
|
|
2264
2287
|
category: 'E2EE',
|
|
2265
2288
|
data: { groupId, recipientUserId, generation: distribution.generation },
|
|
@@ -2282,28 +2305,25 @@ export class DefaultSignalProtocolClient {
|
|
|
2282
2305
|
* ```
|
|
2283
2306
|
*/
|
|
2284
2307
|
async distributeGroupSenderKey(groupId, memberUserIds) {
|
|
2285
|
-
// Filter out self
|
|
2286
2308
|
const recipients = memberUserIds.filter((id) => id !== this.userId);
|
|
2287
|
-
if (recipients.length === 0)
|
|
2288
|
-
|
|
2309
|
+
if (recipients.length === 0)
|
|
2310
|
+
return;
|
|
2311
|
+
return this.withDeferredHooks(this.ctx, (context) => this.groupSenderKeys.run(groupId, async (rawGroupId) => {
|
|
2312
|
+
const distribution = await this.getOrCreateSenderKeyDistribution(rawGroupId);
|
|
2313
|
+
// Distribute to each member
|
|
2314
|
+
const results = await Promise.allSettled(recipients.map((userId) => this.sendSenderKeyDistribution(rawGroupId, userId, distribution, context)));
|
|
2315
|
+
// Count successes and failures
|
|
2316
|
+
const succeeded = results.filter((r) => r.status === 'fulfilled').length;
|
|
2317
|
+
const failed = results.filter((r) => r.status === 'rejected').length;
|
|
2318
|
+
this.logger.debug('Distributed sender key to group', {
|
|
2289
2319
|
category: 'E2EE',
|
|
2290
|
-
data: { groupId },
|
|
2320
|
+
data: { groupId: rawGroupId, succeeded, failed, total: recipients.length },
|
|
2291
2321
|
});
|
|
2292
|
-
|
|
2293
|
-
|
|
2294
|
-
|
|
2295
|
-
|
|
2296
|
-
|
|
2297
|
-
const succeeded = results.filter((r) => r.status === 'fulfilled').length;
|
|
2298
|
-
const failed = results.filter((r) => r.status === 'rejected').length;
|
|
2299
|
-
this.logger.debug('Distributed sender key to group', {
|
|
2300
|
-
category: 'E2EE',
|
|
2301
|
-
data: { groupId, succeeded, failed, total: recipients.length },
|
|
2302
|
-
});
|
|
2303
|
-
// If all failed, throw an error
|
|
2304
|
-
if (failed === recipients.length) {
|
|
2305
|
-
throw new EncryptionError(`Failed to distribute sender key to any group members`, EncryptionErrorCode.ENCRYPTION_FAILED);
|
|
2306
|
-
}
|
|
2322
|
+
// If all failed, throw an error
|
|
2323
|
+
if (failed === recipients.length) {
|
|
2324
|
+
throw new EncryptionError(`Failed to distribute sender key to any group members`, EncryptionErrorCode.ENCRYPTION_FAILED);
|
|
2325
|
+
}
|
|
2326
|
+
}));
|
|
2307
2327
|
}
|
|
2308
2328
|
// ============================================================================
|
|
2309
2329
|
// UTILITY METHODS
|
|
@@ -2390,7 +2410,7 @@ export class DefaultSignalProtocolClient {
|
|
|
2390
2410
|
* ```
|
|
2391
2411
|
*/
|
|
2392
2412
|
async getGroupSenderKeyStats(groupId, senderId, senderDeviceId) {
|
|
2393
|
-
return this.senderKeyManager.getStats(
|
|
2413
|
+
return this.groupSenderKeys.run(groupId, (rawGroupId) => this.senderKeyManager.getStats(rawGroupId, senderId, senderDeviceId));
|
|
2394
2414
|
}
|
|
2395
2415
|
/**
|
|
2396
2416
|
* Handle group membership change with appropriate sender key actions.
|