@open-e2ee/signal-protocol-sdk 11.0.0 → 12.0.1
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 +4 -4
- package/ARCHITECTURE.md +6 -8
- package/CHANGELOG.md +1348 -0
- package/README.md +1 -1
- package/SECURITY.md +2 -2
- package/TROUBLESHOOTING.md +8 -8
- package/client/README.md +70 -37
- package/device/README.md +39 -85
- package/dist/client/client.d.ts +334 -63
- package/dist/client/client.d.ts.map +1 -1
- package/dist/client/client.js +1175 -186
- package/dist/client/client.js.map +1 -1
- package/dist/client/config.d.ts +57 -42
- package/dist/client/config.d.ts.map +1 -1
- package/dist/client/config.js +1 -1
- package/dist/client/config.js.map +1 -1
- package/dist/client/constants.d.ts +42 -8
- package/dist/client/constants.d.ts.map +1 -1
- package/dist/client/constants.js +48 -3
- package/dist/client/constants.js.map +1 -1
- package/dist/client/content-adapter.d.ts +80 -0
- package/dist/client/content-adapter.d.ts.map +1 -1
- package/dist/client/content-adapter.js +225 -12
- package/dist/client/content-adapter.js.map +1 -1
- package/dist/client/delivery-error.d.ts +150 -0
- package/dist/client/delivery-error.d.ts.map +1 -0
- package/dist/client/delivery-error.js +226 -0
- package/dist/client/delivery-error.js.map +1 -0
- package/dist/client/delivery-status.d.ts +32 -6
- package/dist/client/delivery-status.d.ts.map +1 -1
- package/dist/client/delivery-status.js +61 -13
- package/dist/client/delivery-status.js.map +1 -1
- package/dist/client/device-set-reconciliation.d.ts +196 -0
- package/dist/client/device-set-reconciliation.d.ts.map +1 -0
- package/dist/client/device-set-reconciliation.js +282 -0
- package/dist/client/device-set-reconciliation.js.map +1 -0
- package/dist/client/distribution-records.d.ts +29 -0
- package/dist/client/distribution-records.d.ts.map +1 -0
- package/dist/client/distribution-records.js +33 -0
- package/dist/client/distribution-records.js.map +1 -0
- package/dist/client/event-hooks.d.ts +280 -14
- package/dist/client/event-hooks.d.ts.map +1 -1
- package/dist/client/event-hooks.js +8 -0
- package/dist/client/event-hooks.js.map +1 -1
- package/dist/client/group-device-set.d.ts +47 -0
- package/dist/client/group-device-set.d.ts.map +1 -0
- package/dist/client/group-device-set.js +65 -0
- package/dist/client/group-device-set.js.map +1 -0
- package/dist/client/group-fetcher.d.ts +116 -0
- package/dist/client/group-fetcher.d.ts.map +1 -0
- package/dist/client/group-fetcher.js +598 -0
- package/dist/client/group-fetcher.js.map +1 -0
- package/dist/client/group-outbox.d.ts +172 -10
- package/dist/client/group-outbox.d.ts.map +1 -1
- package/dist/client/group-outbox.js +915 -74
- package/dist/client/group-outbox.js.map +1 -1
- package/dist/client/group-receive-authorization.d.ts +127 -4
- package/dist/client/group-receive-authorization.d.ts.map +1 -1
- package/dist/client/group-receive-authorization.js +270 -20
- package/dist/client/group-receive-authorization.js.map +1 -1
- package/dist/client/group-sealed-sender.d.ts +3 -0
- package/dist/client/group-sealed-sender.d.ts.map +1 -1
- package/dist/client/group-sealed-sender.js +1 -0
- package/dist/client/group-sealed-sender.js.map +1 -1
- package/dist/client/group-sender-key-operations.d.ts +14 -3
- package/dist/client/group-sender-key-operations.d.ts.map +1 -1
- package/dist/client/group-sender-key-operations.js +26 -5
- package/dist/client/group-sender-key-operations.js.map +1 -1
- package/dist/client/groups.d.ts +5 -5
- package/dist/client/groups.d.ts.map +1 -1
- package/dist/client/groups.js +5 -4
- package/dist/client/groups.js.map +1 -1
- package/dist/client/hosted-anonymous-delivery.d.ts +61 -9
- package/dist/client/hosted-anonymous-delivery.d.ts.map +1 -1
- package/dist/client/hosted-anonymous-delivery.js +242 -48
- package/dist/client/hosted-anonymous-delivery.js.map +1 -1
- package/dist/client/hosted-assertion-id.d.ts +7 -0
- package/dist/client/hosted-assertion-id.d.ts.map +1 -0
- package/dist/client/hosted-assertion-id.js +51 -0
- package/dist/client/hosted-assertion-id.js.map +1 -0
- package/dist/client/hosted-mailbox-subscription.d.ts +34 -2
- package/dist/client/hosted-mailbox-subscription.d.ts.map +1 -1
- package/dist/client/hosted-mailbox-subscription.js +87 -17
- package/dist/client/hosted-mailbox-subscription.js.map +1 -1
- package/dist/client/hosted-push.d.ts +22 -4
- package/dist/client/hosted-push.d.ts.map +1 -1
- package/dist/client/hosted-push.js +75 -22
- package/dist/client/hosted-push.js.map +1 -1
- package/dist/client/hosted-transport.d.ts +22 -28
- package/dist/client/hosted-transport.d.ts.map +1 -1
- package/dist/client/hosted-transport.js +115 -55
- package/dist/client/hosted-transport.js.map +1 -1
- package/dist/client/hosted.d.ts +10 -4
- package/dist/client/hosted.d.ts.map +1 -1
- package/dist/client/hosted.js +10 -4
- package/dist/client/hosted.js.map +1 -1
- package/dist/client/index.d.ts +5 -3
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js +2 -0
- package/dist/client/index.js.map +1 -1
- package/dist/client/messages.d.ts +25 -3
- package/dist/client/messages.d.ts.map +1 -1
- package/dist/client/messages.js +111 -20
- package/dist/client/messages.js.map +1 -1
- package/dist/client/receive-admission.d.ts +58 -0
- package/dist/client/receive-admission.d.ts.map +1 -0
- package/dist/client/receive-admission.js +78 -0
- package/dist/client/receive-admission.js.map +1 -0
- package/dist/client/receive-expiry.d.ts +31 -0
- package/dist/client/receive-expiry.d.ts.map +1 -0
- package/dist/client/receive-expiry.js +35 -0
- package/dist/client/receive-expiry.js.map +1 -0
- package/dist/client/receive-hook-bound.d.ts +50 -0
- package/dist/client/receive-hook-bound.d.ts.map +1 -0
- package/dist/client/receive-hook-bound.js +115 -0
- package/dist/client/receive-hook-bound.js.map +1 -0
- package/dist/client/receive-queue.d.ts +299 -0
- package/dist/client/receive-queue.d.ts.map +1 -0
- package/dist/client/receive-queue.js +1420 -0
- package/dist/client/receive-queue.js.map +1 -0
- package/dist/client/receive-work-seed.d.ts +54 -0
- package/dist/client/receive-work-seed.d.ts.map +1 -0
- package/dist/client/receive-work-seed.js +116 -0
- package/dist/client/receive-work-seed.js.map +1 -0
- package/dist/client/recovery-driver.d.ts +25 -0
- package/dist/client/recovery-driver.d.ts.map +1 -0
- package/dist/client/recovery-driver.js +121 -0
- package/dist/client/recovery-driver.js.map +1 -0
- package/dist/client/relay-acceptance.d.ts +20 -7
- package/dist/client/relay-acceptance.d.ts.map +1 -1
- package/dist/client/relay-acceptance.js +30 -12
- package/dist/client/relay-acceptance.js.map +1 -1
- package/dist/client/relay-device-refusal.d.ts +18 -0
- package/dist/client/relay-device-refusal.d.ts.map +1 -1
- package/dist/client/relay-device-refusal.js +31 -0
- package/dist/client/relay-device-refusal.js.map +1 -1
- package/dist/client/relay-sealed-route.d.ts +36 -0
- package/dist/client/relay-sealed-route.d.ts.map +1 -0
- package/dist/client/relay-sealed-route.js +45 -0
- package/dist/client/relay-sealed-route.js.map +1 -0
- package/dist/client/relay-subscription.d.ts +56 -13
- package/dist/client/relay-subscription.d.ts.map +1 -1
- package/dist/client/relay-subscription.js +193 -123
- package/dist/client/relay-subscription.js.map +1 -1
- package/dist/client/resendable-content.d.ts +98 -0
- package/dist/client/resendable-content.d.ts.map +1 -0
- package/dist/client/resendable-content.js +136 -0
- package/dist/client/resendable-content.js.map +1 -0
- package/dist/client/retry-family.d.ts +57 -10
- package/dist/client/retry-family.d.ts.map +1 -1
- package/dist/client/retry-family.js +54 -12
- package/dist/client/retry-family.js.map +1 -1
- package/dist/client/retry-request-envelope.d.ts +107 -8
- package/dist/client/retry-request-envelope.d.ts.map +1 -1
- package/dist/client/retry-request-envelope.js +172 -23
- package/dist/client/retry-request-envelope.js.map +1 -1
- package/dist/client/retry-request-lifecycle.d.ts +70 -14
- package/dist/client/retry-request-lifecycle.d.ts.map +1 -1
- package/dist/client/retry-request-lifecycle.js +162 -32
- package/dist/client/retry-request-lifecycle.js.map +1 -1
- package/dist/client/retry-terminal-recovery.d.ts +100 -0
- package/dist/client/retry-terminal-recovery.d.ts.map +1 -0
- package/dist/client/retry-terminal-recovery.js +164 -0
- package/dist/client/retry-terminal-recovery.js.map +1 -0
- package/dist/client/retry-utils.d.ts +27 -0
- package/dist/client/retry-utils.d.ts.map +1 -1
- package/dist/client/retry-utils.js +46 -0
- package/dist/client/retry-utils.js.map +1 -1
- package/dist/client/retry.d.ts +100 -12
- package/dist/client/retry.d.ts.map +1 -1
- package/dist/client/retry.js +619 -116
- package/dist/client/retry.js.map +1 -1
- package/dist/client/sealed-sender.d.ts +23 -6
- package/dist/client/sealed-sender.d.ts.map +1 -1
- package/dist/client/sealed-sender.js +30 -6
- package/dist/client/sealed-sender.js.map +1 -1
- package/dist/client/sessions.d.ts +2 -2
- package/dist/client/sessions.js +2 -2
- package/dist/client/signal-service-cipher.d.ts +726 -19
- package/dist/client/signal-service-cipher.d.ts.map +1 -1
- package/dist/client/signal-service-cipher.js +2260 -342
- package/dist/client/signal-service-cipher.js.map +1 -1
- package/dist/client/state.d.ts +5 -0
- package/dist/client/state.d.ts.map +1 -1
- package/dist/client/state.js +11 -1
- package/dist/client/state.js.map +1 -1
- package/dist/client/storage-protection.d.ts +64 -0
- package/dist/client/storage-protection.d.ts.map +1 -0
- package/dist/client/storage-protection.js +150 -0
- package/dist/client/storage-protection.js.map +1 -0
- package/dist/client/types.d.ts +149 -15
- package/dist/client/types.d.ts.map +1 -1
- package/dist/client/types.js +1 -1
- package/dist/client/types.js.map +1 -1
- package/dist/device/constants.d.ts +0 -5
- package/dist/device/constants.d.ts.map +1 -1
- package/dist/device/constants.js +0 -5
- package/dist/device/constants.js.map +1 -1
- package/dist/device/expo/index.d.ts +4 -17
- package/dist/device/expo/index.d.ts.map +1 -1
- package/dist/device/expo/index.js +4 -23
- package/dist/device/expo/index.js.map +1 -1
- package/dist/device/index.d.ts +0 -2
- package/dist/device/index.d.ts.map +1 -1
- package/dist/device/index.js +0 -7
- package/dist/device/index.js.map +1 -1
- package/dist/device/lifecycle/manager.d.ts +5 -4
- package/dist/device/lifecycle/manager.d.ts.map +1 -1
- package/dist/device/lifecycle/manager.js +16 -16
- package/dist/device/lifecycle/manager.js.map +1 -1
- package/dist/device/lifecycle/types.d.ts +2 -2
- package/dist/device/lifecycle/types.d.ts.map +1 -1
- package/dist/device/react-native/index.d.ts +4 -15
- package/dist/device/react-native/index.d.ts.map +1 -1
- package/dist/device/react-native/index.js +4 -21
- package/dist/device/react-native/index.js.map +1 -1
- package/dist/device/types.d.ts +1 -1
- package/dist/groups/index.d.ts +1 -1
- package/dist/groups/index.d.ts.map +1 -1
- package/dist/index.d.ts +8 -6
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -1
- package/dist/index.js.map +1 -1
- package/dist/internal/crypto/ec/x25519-validation.d.ts +0 -1
- package/dist/internal/crypto/ec/x25519-validation.d.ts.map +1 -1
- package/dist/internal/crypto/ec/x25519-validation.js +0 -1
- package/dist/internal/crypto/ec/x25519-validation.js.map +1 -1
- package/dist/internal/crypto/validation.d.ts +2 -2
- package/dist/internal/groups/index.d.ts +1 -0
- package/dist/internal/groups/index.d.ts.map +1 -1
- package/dist/internal/groups/index.js +1 -0
- package/dist/internal/groups/index.js.map +1 -1
- package/dist/internal/groups/manager.d.ts +37 -16
- package/dist/internal/groups/manager.d.ts.map +1 -1
- package/dist/internal/groups/manager.js +46 -1
- package/dist/internal/groups/manager.js.map +1 -1
- package/dist/internal/groups/receive-record.d.ts +78 -0
- package/dist/internal/groups/receive-record.d.ts.map +1 -0
- package/dist/internal/groups/receive-record.js +43 -0
- package/dist/internal/groups/receive-record.js.map +1 -0
- package/dist/internal/groups/sdk-store.d.ts +27 -3
- package/dist/internal/groups/sdk-store.d.ts.map +1 -1
- package/dist/internal/groups/sdk-store.js +151 -19
- package/dist/internal/groups/sdk-store.js.map +1 -1
- package/dist/internal/groups/wire.d.ts +12 -1
- package/dist/internal/groups/wire.d.ts.map +1 -1
- package/dist/internal/groups/wire.js +36 -0
- package/dist/internal/groups/wire.js.map +1 -1
- package/dist/internal/manager/index.d.ts +1 -1
- package/dist/internal/manager/manager.d.ts +26 -20
- package/dist/internal/manager/manager.d.ts.map +1 -1
- package/dist/internal/manager/manager.js +64 -41
- package/dist/internal/manager/manager.js.map +1 -1
- package/dist/internal/protocol/double-ratchet/chains.d.ts +4 -18
- package/dist/internal/protocol/double-ratchet/chains.d.ts.map +1 -1
- package/dist/internal/protocol/double-ratchet/chains.js +23 -74
- package/dist/internal/protocol/double-ratchet/chains.js.map +1 -1
- package/dist/internal/protocol/double-ratchet/index.d.ts +1 -1
- package/dist/internal/protocol/double-ratchet/index.d.ts.map +1 -1
- package/dist/internal/protocol/double-ratchet/index.js +1 -1
- package/dist/internal/protocol/double-ratchet/index.js.map +1 -1
- package/dist/internal/protocol/double-ratchet/ratchet.d.ts +5 -7
- package/dist/internal/protocol/double-ratchet/ratchet.d.ts.map +1 -1
- package/dist/internal/protocol/double-ratchet/ratchet.js +4 -6
- 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 +2 -1
- package/dist/internal/protocol/pqxdh/pqxdh.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/types.d.ts +6 -8
- package/dist/internal/protocol/sealed-sender/types.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/types.js +8 -9
- package/dist/internal/protocol/sealed-sender/types.js.map +1 -1
- package/dist/internal/protocol/sender-keys/handoff-ledger.d.ts +110 -0
- package/dist/internal/protocol/sender-keys/handoff-ledger.d.ts.map +1 -0
- package/dist/internal/protocol/sender-keys/handoff-ledger.js +124 -0
- package/dist/internal/protocol/sender-keys/handoff-ledger.js.map +1 -0
- package/dist/internal/protocol/sender-keys/manager.d.ts +71 -62
- package/dist/internal/protocol/sender-keys/manager.d.ts.map +1 -1
- package/dist/internal/protocol/sender-keys/manager.js +228 -175
- package/dist/internal/protocol/sender-keys/manager.js.map +1 -1
- package/dist/internal/protocol/spqr/index.d.ts +2 -2
- 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/serialize.d.ts +9 -1
- package/dist/internal/protocol/spqr/serialize.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/serialize.js +56 -16
- package/dist/internal/protocol/spqr/serialize.js.map +1 -1
- package/dist/internal/protocol/spqr/spqr.d.ts +1 -14
- package/dist/internal/protocol/spqr/spqr.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/spqr.js +54 -42
- package/dist/internal/protocol/spqr/spqr.js.map +1 -1
- package/dist/internal/protocol/spqr/validate.d.ts +26 -6
- package/dist/internal/protocol/spqr/validate.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/validate.js +49 -21
- package/dist/internal/protocol/spqr/validate.js.map +1 -1
- package/dist/internal/sesame/index.d.ts +1 -1
- package/dist/internal/sesame/index.d.ts.map +1 -1
- package/dist/internal/sesame/index.js.map +1 -1
- package/dist/internal/sesame/manager.d.ts +66 -13
- package/dist/internal/sesame/manager.d.ts.map +1 -1
- package/dist/internal/sesame/manager.js +221 -87
- package/dist/internal/sesame/manager.js.map +1 -1
- package/dist/internal/sesame/types.d.ts +95 -17
- package/dist/internal/sesame/types.d.ts.map +1 -1
- package/dist/internal/sesame/types.js +17 -0
- package/dist/internal/sesame/types.js.map +1 -1
- package/dist/internal/session/builder.d.ts +5 -5
- package/dist/internal/session/builder.d.ts.map +1 -1
- package/dist/internal/session/builder.js +12 -17
- package/dist/internal/session/builder.js.map +1 -1
- package/dist/internal/session/cipher.d.ts +15 -13
- package/dist/internal/session/cipher.d.ts.map +1 -1
- package/dist/internal/session/cipher.js +41 -23
- package/dist/internal/session/cipher.js.map +1 -1
- package/dist/internal/session/factory.d.ts +5 -5
- package/dist/internal/session/factory.d.ts.map +1 -1
- package/dist/internal/session/factory.js +4 -4
- package/dist/internal/session/factory.js.map +1 -1
- package/dist/internal/session/handshake.d.ts +14 -16
- package/dist/internal/session/handshake.d.ts.map +1 -1
- package/dist/internal/session/handshake.js +18 -75
- package/dist/internal/session/handshake.js.map +1 -1
- package/dist/internal/session/index.d.ts +1 -1
- package/dist/internal/session/index.js +1 -1
- package/dist/internal/session/record-locks.d.ts +17 -6
- package/dist/internal/session/record-locks.d.ts.map +1 -1
- package/dist/internal/session/record-locks.js +43 -7
- package/dist/internal/session/record-locks.js.map +1 -1
- package/dist/internal/session/session-resolver.d.ts +1 -1
- package/dist/internal/session/session-resolver.js +1 -1
- package/dist/internal/session/state.d.ts +2 -2
- package/dist/internal/session/state.js +1 -1
- package/dist/internal/session/types.d.ts +5 -13
- package/dist/internal/session/types.d.ts.map +1 -1
- package/dist/internal/session/types.js +1 -1
- package/dist/keys/generation.d.ts +2 -2
- package/dist/keys/generation.js +2 -2
- package/dist/keys/types.d.ts +5 -5
- package/dist/keys/types.d.ts.map +1 -1
- package/dist/keys/types.js +1 -1
- package/dist/layers.d.ts +1 -1
- package/dist/layers.js +2 -2
- package/dist/layers.js.map +1 -1
- package/dist/local/store/expo/adapter.d.ts.map +1 -1
- package/dist/local/store/expo/adapter.js +12 -8
- package/dist/local/store/expo/adapter.js.map +1 -1
- package/dist/local/store/key-value/adapter.d.ts +76 -10
- package/dist/local/store/key-value/adapter.d.ts.map +1 -1
- package/dist/local/store/key-value/adapter.js +367 -61
- 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 +74 -0
- package/dist/local/store/key-value/backend-conformance.js.map +1 -1
- package/dist/local/store/key-value/batch.d.ts +2 -0
- package/dist/local/store/key-value/batch.d.ts.map +1 -1
- package/dist/local/store/key-value/batch.js +26 -0
- package/dist/local/store/key-value/batch.js.map +1 -1
- package/dist/local/store/key-value/receive-work.d.ts +55 -0
- package/dist/local/store/key-value/receive-work.d.ts.map +1 -0
- package/dist/local/store/key-value/receive-work.js +162 -0
- package/dist/local/store/key-value/receive-work.js.map +1 -0
- package/dist/local/store/key-value/send-log.d.ts +61 -0
- package/dist/local/store/key-value/send-log.d.ts.map +1 -0
- package/dist/local/store/key-value/send-log.js +430 -0
- package/dist/local/store/key-value/send-log.js.map +1 -0
- package/dist/local/store/key-value/sender-key-handoff.d.ts +68 -0
- package/dist/local/store/key-value/sender-key-handoff.d.ts.map +1 -0
- package/dist/local/store/key-value/sender-key-handoff.js +189 -0
- package/dist/local/store/key-value/sender-key-handoff.js.map +1 -0
- package/dist/local/store/key-value/storage.d.ts +15 -0
- package/dist/local/store/key-value/storage.d.ts.map +1 -1
- package/dist/local/store/keyed-index.d.ts +23 -0
- package/dist/local/store/keyed-index.d.ts.map +1 -0
- package/dist/local/store/keyed-index.js +41 -0
- package/dist/local/store/keyed-index.js.map +1 -0
- package/dist/local/store/memory/adapter.d.ts +44 -12
- package/dist/local/store/memory/adapter.d.ts.map +1 -1
- package/dist/local/store/memory/adapter.js +197 -46
- package/dist/local/store/memory/adapter.js.map +1 -1
- package/dist/local/store/memory/send-log.d.ts +42 -0
- package/dist/local/store/memory/send-log.d.ts.map +1 -0
- package/dist/local/store/memory/send-log.js +190 -0
- package/dist/local/store/memory/send-log.js.map +1 -0
- package/dist/local/store/node/adapter.d.ts.map +1 -1
- package/dist/local/store/node/adapter.js +8 -6
- package/dist/local/store/node/adapter.js.map +1 -1
- package/dist/local/store/react-native/adapter.d.ts.map +1 -1
- package/dist/local/store/react-native/adapter.js +12 -8
- package/dist/local/store/react-native/adapter.js.map +1 -1
- package/dist/local/store/receive-work.d.ts +87 -0
- package/dist/local/store/receive-work.d.ts.map +1 -0
- package/dist/local/store/receive-work.js +204 -0
- package/dist/local/store/receive-work.js.map +1 -0
- package/dist/local/store/received-content.d.ts +3 -3
- package/dist/local/store/received-content.d.ts.map +1 -1
- package/dist/local/store/received-content.js +2 -11
- package/dist/local/store/received-content.js.map +1 -1
- package/dist/local/store/reliability.d.ts +317 -18
- package/dist/local/store/reliability.d.ts.map +1 -1
- package/dist/local/store/reliability.js +371 -46
- package/dist/local/store/reliability.js.map +1 -1
- package/dist/local/store/send-log-order.d.ts +15 -0
- package/dist/local/store/send-log-order.d.ts.map +1 -0
- package/dist/local/store/send-log-order.js +24 -0
- package/dist/local/store/send-log-order.js.map +1 -0
- package/dist/local/store/sender-key-handoff-index.d.ts +38 -0
- package/dist/local/store/sender-key-handoff-index.d.ts.map +1 -0
- package/dist/local/store/sender-key-handoff-index.js +101 -0
- package/dist/local/store/sender-key-handoff-index.js.map +1 -0
- package/dist/local/store/sender-key-handoff-table.d.ts +29 -0
- package/dist/local/store/sender-key-handoff-table.d.ts.map +1 -0
- package/dist/local/store/sender-key-handoff-table.js +97 -0
- package/dist/local/store/sender-key-handoff-table.js.map +1 -0
- package/dist/local/store/sqlite/driver.d.ts +9 -0
- package/dist/local/store/sqlite/driver.d.ts.map +1 -1
- package/dist/local/store/sqlite/encryption.d.ts +8 -1
- package/dist/local/store/sqlite/encryption.d.ts.map +1 -1
- package/dist/local/store/sqlite/encryption.js +9 -0
- package/dist/local/store/sqlite/encryption.js.map +1 -1
- package/dist/local/store/sqlite/key-storage/index.d.ts +25 -4
- package/dist/local/store/sqlite/key-storage/index.d.ts.map +1 -1
- package/dist/local/store/sqlite/key-storage/index.js +68 -7
- package/dist/local/store/sqlite/key-storage/index.js.map +1 -1
- package/dist/local/store/sqlite/key-storage/message-records.d.ts +16 -4
- package/dist/local/store/sqlite/key-storage/message-records.d.ts.map +1 -1
- package/dist/local/store/sqlite/key-storage/message-records.js +49 -6
- package/dist/local/store/sqlite/key-storage/message-records.js.map +1 -1
- package/dist/local/store/sqlite/key-storage/metadata.d.ts +8 -7
- package/dist/local/store/sqlite/key-storage/metadata.d.ts.map +1 -1
- package/dist/local/store/sqlite/key-storage/metadata.js +17 -15
- package/dist/local/store/sqlite/key-storage/metadata.js.map +1 -1
- package/dist/local/store/sqlite/key-storage/receive-work.d.ts +27 -0
- package/dist/local/store/sqlite/key-storage/receive-work.d.ts.map +1 -0
- package/dist/local/store/sqlite/key-storage/receive-work.js +98 -0
- package/dist/local/store/sqlite/key-storage/receive-work.js.map +1 -0
- package/dist/local/store/sqlite/key-storage/send-log.d.ts +27 -0
- package/dist/local/store/sqlite/key-storage/send-log.d.ts.map +1 -0
- package/dist/local/store/sqlite/key-storage/send-log.js +178 -0
- package/dist/local/store/sqlite/key-storage/send-log.js.map +1 -0
- package/dist/local/store/sqlite/key-storage/sender-key-handoff.d.ts +27 -0
- package/dist/local/store/sqlite/key-storage/sender-key-handoff.d.ts.map +1 -0
- package/dist/local/store/sqlite/key-storage/sender-key-handoff.js +75 -0
- package/dist/local/store/sqlite/key-storage/sender-key-handoff.js.map +1 -0
- package/dist/local/store/sqlite/key-storage/session-trust.d.ts +2 -2
- package/dist/local/store/sqlite/key-storage/session-trust.js +5 -5
- package/dist/local/store/sqlite/key-storage/session-trust.js.map +1 -1
- package/dist/local/store/sqlite/migrations.d.ts.map +1 -1
- package/dist/local/store/sqlite/migrations.js +101 -0
- package/dist/local/store/sqlite/migrations.js.map +1 -1
- package/dist/local/store/sqlite/models/index.d.ts +2 -1
- package/dist/local/store/sqlite/models/index.d.ts.map +1 -1
- package/dist/local/store/sqlite/models/index.js +5 -1
- package/dist/local/store/sqlite/models/index.js.map +1 -1
- package/dist/local/store/sqlite/models/message-record.d.ts +15 -0
- package/dist/local/store/sqlite/models/message-record.d.ts.map +1 -1
- package/dist/local/store/sqlite/models/message-record.js +24 -0
- package/dist/local/store/sqlite/models/message-record.js.map +1 -1
- package/dist/local/store/sqlite/models/send-log.d.ts +51 -0
- package/dist/local/store/sqlite/models/send-log.d.ts.map +1 -0
- package/dist/local/store/sqlite/models/send-log.js +206 -0
- package/dist/local/store/sqlite/models/send-log.js.map +1 -0
- package/dist/local/store/sqlite/open-store.d.ts +9 -1
- package/dist/local/store/sqlite/open-store.d.ts.map +1 -1
- package/dist/local/store/sqlite/open-store.js +20 -1
- package/dist/local/store/sqlite/open-store.js.map +1 -1
- package/dist/local/store/sqlite/schema.d.ts +34 -1
- package/dist/local/store/sqlite/schema.d.ts.map +1 -1
- package/dist/local/store/sqlite/schema.js +14 -0
- package/dist/local/store/sqlite/schema.js.map +1 -1
- package/dist/local/store/sqlite/store.d.ts +61 -11
- package/dist/local/store/sqlite/store.d.ts.map +1 -1
- package/dist/local/store/sqlite/store.js +191 -27
- package/dist/local/store/sqlite/store.js.map +1 -1
- package/dist/local/store/sqlite/web/sqlite3mc/sqlite3.mjs +2 -1
- package/dist/local/store/sqlite/web/worker.d.ts +8 -0
- package/dist/local/store/sqlite/web/worker.d.ts.map +1 -1
- package/dist/local/store/sqlite/web/worker.js +64 -2
- package/dist/local/store/sqlite/web/worker.js.map +1 -1
- package/dist/local/store/web/adapter.d.ts +76 -8
- package/dist/local/store/web/adapter.d.ts.map +1 -1
- package/dist/local/store/web/adapter.js +579 -127
- package/dist/local/store/web/adapter.js.map +1 -1
- package/dist/local/store/web/receive-work.d.ts +57 -0
- package/dist/local/store/web/receive-work.d.ts.map +1 -0
- package/dist/local/store/web/receive-work.js +99 -0
- package/dist/local/store/web/receive-work.js.map +1 -0
- package/dist/local/store/web/send-log.d.ts +92 -0
- package/dist/local/store/web/send-log.d.ts.map +1 -0
- package/dist/local/store/web/send-log.js +267 -0
- package/dist/local/store/web/send-log.js.map +1 -0
- package/dist/local/store/web/sender-key-handoff.d.ts +81 -0
- package/dist/local/store/web/sender-key-handoff.d.ts.map +1 -0
- package/dist/local/store/web/sender-key-handoff.js +156 -0
- package/dist/local/store/web/sender-key-handoff.js.map +1 -0
- package/dist/local/store/web-sqlite/adapter.d.ts +2 -0
- package/dist/local/store/web-sqlite/adapter.d.ts.map +1 -1
- package/dist/local/store/web-sqlite/adapter.js +12 -6
- package/dist/local/store/web-sqlite/adapter.js.map +1 -1
- package/dist/local/vault/custody.d.ts +8 -0
- package/dist/local/vault/custody.d.ts.map +1 -0
- package/dist/local/vault/custody.js +9 -0
- package/dist/local/vault/custody.js.map +1 -0
- package/dist/local/vault/electron-safe-storage.d.ts +3 -1
- package/dist/local/vault/electron-safe-storage.d.ts.map +1 -1
- package/dist/local/vault/electron-safe-storage.js +2 -0
- package/dist/local/vault/electron-safe-storage.js.map +1 -1
- package/dist/local/vault/expo-secure-store.d.ts +3 -1
- package/dist/local/vault/expo-secure-store.d.ts.map +1 -1
- package/dist/local/vault/expo-secure-store.js +2 -0
- package/dist/local/vault/expo-secure-store.js.map +1 -1
- package/dist/local/vault/indexed-db.d.ts +3 -1
- package/dist/local/vault/indexed-db.d.ts.map +1 -1
- package/dist/local/vault/indexed-db.js +2 -0
- package/dist/local/vault/indexed-db.js.map +1 -1
- package/dist/local/vault/react-native-keychain.d.ts +3 -1
- package/dist/local/vault/react-native-keychain.d.ts.map +1 -1
- package/dist/local/vault/react-native-keychain.js +2 -0
- package/dist/local/vault/react-native-keychain.js.map +1 -1
- package/dist/remote/relay/device-set.d.ts +94 -0
- package/dist/remote/relay/device-set.d.ts.map +1 -0
- package/dist/remote/relay/device-set.js +156 -0
- package/dist/remote/relay/device-set.js.map +1 -0
- package/dist/remote/relay/types.d.ts +92 -107
- package/dist/remote/relay/types.d.ts.map +1 -1
- package/dist/safety/core.d.ts +15 -6
- package/dist/safety/core.d.ts.map +1 -1
- package/dist/safety/core.js +41 -27
- package/dist/safety/core.js.map +1 -1
- package/dist/safety/index.d.ts +2 -1
- package/dist/safety/index.d.ts.map +1 -1
- package/dist/safety/index.js +12 -18
- package/dist/safety/index.js.map +1 -1
- package/dist/types/api.d.ts +707 -62
- package/dist/types/api.d.ts.map +1 -1
- package/dist/types/errors.d.ts +14 -33
- package/dist/types/errors.d.ts.map +1 -1
- package/dist/types/errors.js +14 -24
- package/dist/types/errors.js.map +1 -1
- package/dist/types/messages.d.ts +2 -2
- package/dist/types/messages.js +1 -1
- package/dist/types/protocol-config.d.ts +175 -42
- package/dist/types/protocol-config.d.ts.map +1 -1
- package/dist/types/protocol-config.js +19 -38
- package/dist/types/protocol-config.js.map +1 -1
- package/dist/types/protocol-constants.d.ts +6 -6
- package/dist/types/protocol-constants.js +6 -6
- package/dist/types/session.d.ts +7 -7
- package/dist/types/session.d.ts.map +1 -1
- package/dist/types/session.js +39 -21
- package/dist/types/session.js.map +1 -1
- package/dist/username/link.d.ts +2 -2
- package/dist/username/link.js +2 -2
- package/dist/utils/origin-lock.d.ts +45 -0
- package/dist/utils/origin-lock.d.ts.map +1 -0
- package/dist/utils/origin-lock.js +80 -0
- package/dist/utils/origin-lock.js.map +1 -0
- package/docs/ASSURANCE.md +6 -6
- package/docs/CLIENT_COMPOSITION.md +2 -2
- package/docs/DEVIATIONS.md +677 -182
- package/docs/E2EE.md +1 -1
- package/docs/ERROR_HANDLING.md +165 -2
- package/docs/GETTING_STARTED.md +7 -4
- package/docs/INTERFACES.md +1 -1
- package/docs/PACKAGE_SURFACE.md +6 -5
- package/docs/PROTOCOL_POLICY.md +102 -22
- package/docs/RECIPES.md +3 -15
- package/docs/SECURITY.md +90 -5
- package/keys/README.md +3 -3
- package/local/store/README.md +78 -14
- package/local/store/key-value/README.md +14 -3
- package/local/store/node/README.md +8 -3
- package/local/store/web/README.md +9 -0
- package/local/store/web-sqlite/README.md +14 -2
- package/local/vault/README.md +21 -0
- package/package.json +1 -6
- package/remote/README.md +0 -1
- package/remote/relay/README.md +2 -2
- package/dist/device/provisioning.d.ts +0 -242
- package/dist/device/provisioning.d.ts.map +0 -1
- package/dist/device/provisioning.js +0 -421
- package/dist/device/provisioning.js.map +0 -1
- package/dist/internal/protocol/x3dh/index.d.ts +0 -15
- package/dist/internal/protocol/x3dh/index.d.ts.map +0 -1
- package/dist/internal/protocol/x3dh/index.js +0 -13
- package/dist/internal/protocol/x3dh/index.js.map +0 -1
- package/dist/internal/protocol/x3dh/x3dh.d.ts +0 -131
- package/dist/internal/protocol/x3dh/x3dh.d.ts.map +0 -1
- package/dist/internal/protocol/x3dh/x3dh.js +0 -261
- package/dist/internal/protocol/x3dh/x3dh.js.map +0 -1
|
@@ -1,9 +1,21 @@
|
|
|
1
1
|
import { EncryptionError, EncryptionErrorCode } from '../types/index.js';
|
|
2
2
|
import { SealedSenderAuthError } from '../types/errors.js';
|
|
3
|
+
import { ContentHint } from '../types/messages.js';
|
|
3
4
|
import * as CryptoUtils from '../internal/crypto/index.js';
|
|
4
|
-
import {
|
|
5
|
+
import { completeOutgoingMessageIntent, completeOutgoingSyncPhase, confirmOutgoingPreMessages, getOutgoingMessageIntent, outgoingMessageIntentResult, reconcileOutgoingGroupDeviceSet, reconcileOutgoingSyncMessages, repairOutgoingDeviceSet, replaceOutgoingGroupPreMessages, restartOutgoingDeviceSet, storeOutgoingMessageIntent, withOutgoingMessageIntentLock, } from '../local/store/reliability.js';
|
|
6
|
+
import { deviceSetRefusal, markDeviceSetRefusal } from '../remote/relay/device-set.js';
|
|
7
|
+
import { runDeviceSetPhase, syncPostReceipts, } from './device-set-reconciliation.js';
|
|
8
|
+
import { isStaleDeviceRefusal } from './relay-device-refusal.js';
|
|
9
|
+
import { groupDeviceKey, listedGroupDeviceChange, listedOwnDeviceChange, sharedBodyDevices, } from './group-device-set.js';
|
|
5
10
|
import { aggregateRelayAcceptance } from './relay-acceptance.js';
|
|
6
|
-
|
|
11
|
+
/**
|
|
12
|
+
* Post one stored device message. With a declaration, an identified post
|
|
13
|
+
* and an access-key sealed post declare the devices of the account. A
|
|
14
|
+
* group-token sealed post stays undeclared: the Relay takes a declaration on
|
|
15
|
+
* the group route only when each declared device has a destination in the
|
|
16
|
+
* post, and the post has one destination.
|
|
17
|
+
*/
|
|
18
|
+
async function sendStoredDeviceMessage(context, intent, message, forceIdentified = false, declaration) {
|
|
7
19
|
const relay = context.relay;
|
|
8
20
|
if (!relay)
|
|
9
21
|
throw new Error('Relay is required for a stored group transmission');
|
|
@@ -11,10 +23,10 @@ async function sendStoredDeviceMessage(context, intent, message, forceIdentified
|
|
|
11
23
|
if (message.sealedSenderDeliveryMode === 'required') {
|
|
12
24
|
throw new EncryptionError('Required group sealed-sender transport is unavailable', EncryptionErrorCode.SEALED_SENDER_REQUIRED, { recipientUserId: message.recipientUserId });
|
|
13
25
|
}
|
|
14
|
-
return sendStoredDeviceMessage(context, intent, message, true);
|
|
26
|
+
return sendStoredDeviceMessage(context, intent, message, true, declaration);
|
|
15
27
|
}
|
|
16
28
|
if (forceIdentified || !message.sealedSenderMessage) {
|
|
17
|
-
|
|
29
|
+
const acceptance = await context.postToRelay(() => relay.send({
|
|
18
30
|
targetUserId: message.recipientUserId,
|
|
19
31
|
targetDeviceId: message.recipientDeviceId,
|
|
20
32
|
senderUserId: context.senderUserId,
|
|
@@ -24,7 +36,14 @@ async function sendStoredDeviceMessage(context, intent, message, forceIdentified
|
|
|
24
36
|
deliveryClass: 'user-visible',
|
|
25
37
|
timestamp: message.timestamp,
|
|
26
38
|
clientMessageId: intent.clientMessageId,
|
|
39
|
+
...(message.recipientRegistrationId !== undefined && {
|
|
40
|
+
recipientRegistrationId: message.recipientRegistrationId,
|
|
41
|
+
}),
|
|
42
|
+
...(intent.contentHint !== undefined && { contentHint: intent.contentHint }),
|
|
43
|
+
...(declaration && { declaredDeviceIds: declaration.deviceIds }),
|
|
27
44
|
}), false);
|
|
45
|
+
declaration?.routes.set(acceptance, 'identified-direct');
|
|
46
|
+
return acceptance;
|
|
28
47
|
}
|
|
29
48
|
const auth = message.sealedSenderAuthorization === 'access_key' && message.sealedSenderAccessKey
|
|
30
49
|
? {
|
|
@@ -38,15 +57,199 @@ async function sendStoredDeviceMessage(context, intent, message, forceIdentified
|
|
|
38
57
|
if (message.sealedSenderDeliveryMode === 'required') {
|
|
39
58
|
throw new Error('Required group sealed-sender authorization is unavailable');
|
|
40
59
|
}
|
|
41
|
-
return sendStoredDeviceMessage(context, intent, message, true);
|
|
60
|
+
return sendStoredDeviceMessage(context, intent, message, true, declaration);
|
|
42
61
|
}
|
|
43
|
-
|
|
62
|
+
if (!declaration || auth.type !== 'accessKey') {
|
|
63
|
+
return context.sendPreparedSealedDevice(intent, message, auth);
|
|
64
|
+
}
|
|
65
|
+
const acceptance = await context.sendPreparedSealedDevice(intent, message, auth, declaration.deviceIds);
|
|
66
|
+
declaration.routes.set(acceptance, 'anonymous-direct');
|
|
67
|
+
return acceptance;
|
|
44
68
|
}
|
|
45
|
-
|
|
69
|
+
/**
|
|
70
|
+
* Post one `sender_key` device message of a group send. When the Relay
|
|
71
|
+
* refuses the device conclusively, the device is repaired once in this
|
|
72
|
+
* attempt: its session is refreshed, it gets the key of the send, and the
|
|
73
|
+
* new device message goes out after the pre-message. One intent write
|
|
74
|
+
* replaces the messages of the device before the posts. When a repair of
|
|
75
|
+
* the pre-message refreshes the session again, the device message is
|
|
76
|
+
* prepared again under the new session before its post. A second refusal of
|
|
77
|
+
* the device message fails the item. When `refused` is true, the Relay has
|
|
78
|
+
* already refused the device as stale in the shared post, so the repair
|
|
79
|
+
* starts with no first post. When the device list no longer shows the device
|
|
80
|
+
* at the repair of its pre-message, the intent has dropped the device
|
|
81
|
+
* message. The destination then settles as refused with no post, and the
|
|
82
|
+
* function resolves to undefined.
|
|
83
|
+
*/
|
|
84
|
+
async function sendGroupDeviceMessage(context, intent, message, forceIdentified, required, refused = false) {
|
|
85
|
+
if (!refused || message.messageType !== 'sender_key') {
|
|
86
|
+
try {
|
|
87
|
+
return await sendStoredDeviceMessage(context, intent, message, forceIdentified);
|
|
88
|
+
}
|
|
89
|
+
catch (error) {
|
|
90
|
+
if (message.messageType !== 'sender_key' || !context.isConclusiveDeviceRejection(error)) {
|
|
91
|
+
throw error;
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
const repair = await context.repairStaleDevice(intent, message);
|
|
96
|
+
await reconcileOutgoingGroupDeviceSet(context.storage, intent.clientMessageId, {
|
|
97
|
+
removed: [{ userId: message.recipientUserId, deviceId: message.recipientDeviceId }],
|
|
98
|
+
preMessages: repair.preMessages,
|
|
99
|
+
deviceMessages: [repair.deviceMessage],
|
|
100
|
+
syncMessages: [],
|
|
101
|
+
});
|
|
102
|
+
const dispatched = await dispatchPreMessages(context, intent, repair.preMessages, required);
|
|
103
|
+
const device = { userId: message.recipientUserId, deviceId: message.recipientDeviceId };
|
|
104
|
+
if (dispatched.removed.some((removed) => groupDeviceKey(removed) === groupDeviceKey(device))) {
|
|
105
|
+
return undefined;
|
|
106
|
+
}
|
|
107
|
+
const { renewed } = await renewRefreshedDeviceMessages(context, dispatched.intent, dispatched.refreshed, [repair.deviceMessage]);
|
|
108
|
+
return sendStoredDeviceMessage(context, intent, renewed[0] ?? repair.deviceMessage, forceIdentified);
|
|
109
|
+
}
|
|
110
|
+
/**
|
|
111
|
+
* Post stored pre-messages. Each one is authorized before any post, and a
|
|
112
|
+
* pre-message sealed at this dispatch is stored before its post, so a replay
|
|
113
|
+
* posts the same sealed bytes. Each pre-message is then accepted or dropped.
|
|
114
|
+
* The handoff row of an accepted pre-message is written after the acceptance
|
|
115
|
+
* and before the intent confirms the pre-message, so a crash between them
|
|
116
|
+
* sends at most one extra distribution. A dropped pre-message writes no row.
|
|
117
|
+
* The intent then keeps only the pre-messages that the relay did not accept,
|
|
118
|
+
* so a replay posts only those. The same write removes the device message of
|
|
119
|
+
* each device that the device list no longer shows. Resolves to the intent
|
|
120
|
+
* after the confirmation, to each device whose session a repair refreshed,
|
|
121
|
+
* and to each device that the device list no longer shows.
|
|
122
|
+
*/
|
|
123
|
+
async function dispatchPreMessages(context, intent, preMessages, required) {
|
|
124
|
+
let current = intent;
|
|
125
|
+
const transports = await context.prepareEach(preMessages, (message) => context.authorizePreMessage(intent.recipientId, message, required));
|
|
126
|
+
const sealedNow = transports.flatMap((transport, index) => transport.message === preMessages[index]
|
|
127
|
+
? []
|
|
128
|
+
: [{ expected: preMessages[index], replacement: transport.message }]);
|
|
129
|
+
if (sealedNow.length > 0) {
|
|
130
|
+
current = await replaceOutgoingGroupPreMessages(context.storage, intent.clientMessageId, sealedNow);
|
|
131
|
+
}
|
|
132
|
+
const transportOf = new Map(transports.map((transport) => [transport.message, transport]));
|
|
133
|
+
const dispatched = current;
|
|
134
|
+
const settled = [];
|
|
135
|
+
const refreshed = [];
|
|
136
|
+
const removed = [];
|
|
137
|
+
try {
|
|
138
|
+
await context.sendPhase(transports.map((transport) => transport.message), async (message) => {
|
|
139
|
+
const posted = await context.postPreMessage(dispatched, transportOf.get(message), required);
|
|
140
|
+
if (posted.outcome === 'accepted') {
|
|
141
|
+
await context.recordSenderKeyHandoff(intent.recipientId, posted.message);
|
|
142
|
+
}
|
|
143
|
+
const device = {
|
|
144
|
+
userId: posted.message.recipientUserId,
|
|
145
|
+
deviceId: posted.message.recipientDeviceId,
|
|
146
|
+
};
|
|
147
|
+
if (posted.outcome === 'removed')
|
|
148
|
+
removed.push(device);
|
|
149
|
+
if (posted.refreshed)
|
|
150
|
+
refreshed.push(device);
|
|
151
|
+
if (posted.message.clientMessageId !== undefined) {
|
|
152
|
+
settled.push(posted.message.clientMessageId);
|
|
153
|
+
}
|
|
154
|
+
}, 'pre-message');
|
|
155
|
+
}
|
|
156
|
+
finally {
|
|
157
|
+
if (settled.length > 0 || removed.length > 0) {
|
|
158
|
+
current = await confirmOutgoingPreMessages(context.storage, intent.clientMessageId, settled, removed);
|
|
159
|
+
}
|
|
160
|
+
}
|
|
161
|
+
return { intent: current, refreshed, removed };
|
|
162
|
+
}
|
|
163
|
+
/**
|
|
164
|
+
* The devices that leave the shared body of this attempt, and the intent
|
|
165
|
+
* after their device messages are renewed. A device leaves when a
|
|
166
|
+
* pre-message repair in this attempt refreshed its session, or when its
|
|
167
|
+
* current session has a registration other than the one that the stored
|
|
168
|
+
* shared body names. The second check reads the sessions on each attempt, so
|
|
169
|
+
* a replay finds the device after an attempt that failed or stopped before
|
|
170
|
+
* the device got its own post. The Relay refuses the copy of such a device in
|
|
171
|
+
* the shared body, so the device gets its own post. A refreshed device gets a
|
|
172
|
+
* new device message. Another leaving device gets one only when its stored
|
|
173
|
+
* device message names a registration other than that of the session.
|
|
174
|
+
*
|
|
175
|
+
* A leaving device whose session has no handoff row gets the key of the send
|
|
176
|
+
* in a pre-message, as the repair of a refused device does. The renewal and
|
|
177
|
+
* the pre-messages go in one intent write, and the pre-messages are accepted
|
|
178
|
+
* or dropped before the device posts. On the attempt that prepared the send,
|
|
179
|
+
* the distribution is at the chain index of the group message, so the device
|
|
180
|
+
* decrypts it. A replay gives the current distribution, and the device
|
|
181
|
+
* recovers the stored message through its retry request and the resend of a
|
|
182
|
+
* logged send. A device that a repair of its pre-message refreshes gets a
|
|
183
|
+
* device message under its new session, and the confirmation removes the
|
|
184
|
+
* device message of a device that the device list no longer shows.
|
|
185
|
+
*/
|
|
186
|
+
async function leaveStaleSharedBody(context, intent, refreshed, groupCiphertext, required) {
|
|
187
|
+
const left = new Set(refreshed.map(groupDeviceKey));
|
|
188
|
+
const leaving = [...refreshed];
|
|
189
|
+
const body = intent.groupSharedMessage
|
|
190
|
+
? sharedBodyDevices(intent.groupSharedMessage)
|
|
191
|
+
: new Map();
|
|
192
|
+
const checks = await context.prepareEach(intent.deviceMessages, async (message) => {
|
|
193
|
+
const device = { userId: message.recipientUserId, deviceId: message.recipientDeviceId };
|
|
194
|
+
const named = body.get(groupDeviceKey(device));
|
|
195
|
+
if (named === undefined || left.has(groupDeviceKey(device)))
|
|
196
|
+
return undefined;
|
|
197
|
+
const current = await context.remoteRegistrationId(device);
|
|
198
|
+
if (current === undefined || current === named)
|
|
199
|
+
return undefined;
|
|
200
|
+
return { device, renew: message.recipientRegistrationId !== current };
|
|
201
|
+
});
|
|
202
|
+
const renew = [...refreshed];
|
|
203
|
+
for (const check of checks) {
|
|
204
|
+
if (!check)
|
|
205
|
+
continue;
|
|
206
|
+
left.add(groupDeviceKey(check.device));
|
|
207
|
+
leaving.push(check.device);
|
|
208
|
+
if (check.renew)
|
|
209
|
+
renew.push(check.device);
|
|
210
|
+
}
|
|
211
|
+
const preMessages = leaving.length > 0 ? await context.prepareSenderKeyHandoffs(intent, leaving) : [];
|
|
212
|
+
const renewal = await renewRefreshedDeviceMessages(context, intent, renew, intent.deviceMessages, groupCiphertext, preMessages);
|
|
213
|
+
if (preMessages.length === 0)
|
|
214
|
+
return { intent: renewal.intent, left };
|
|
215
|
+
const dispatched = await dispatchPreMessages(context, renewal.intent, preMessages, required);
|
|
216
|
+
const again = await renewRefreshedDeviceMessages(context, dispatched.intent, dispatched.refreshed, dispatched.intent.deviceMessages, groupCiphertext);
|
|
217
|
+
return { intent: again.intent, left };
|
|
218
|
+
}
|
|
219
|
+
/**
|
|
220
|
+
* Give each device in `refreshed` that has a message in `messages` a new
|
|
221
|
+
* device message with the registration of its current session, in one intent
|
|
222
|
+
* write. The earlier message names the earlier registration, so the Relay
|
|
223
|
+
* refuses it, and the shared body of the send names the earlier registration
|
|
224
|
+
* too. The new device message goes in its own post. The same write stores
|
|
225
|
+
* `preMessages`. Resolves to the intent after the write, and to the new
|
|
226
|
+
* device messages.
|
|
227
|
+
*/
|
|
228
|
+
async function renewRefreshedDeviceMessages(context, intent, refreshed, messages, groupCiphertext = intent.groupCiphertext, preMessages = []) {
|
|
229
|
+
const keys = new Set(refreshed.map(groupDeviceKey));
|
|
230
|
+
const stale = messages.filter((message) => keys.has(groupDeviceKey({ userId: message.recipientUserId, deviceId: message.recipientDeviceId })));
|
|
231
|
+
if (stale.length === 0 && preMessages.length === 0)
|
|
232
|
+
return { intent, renewed: [] };
|
|
233
|
+
if (!groupCiphertext)
|
|
234
|
+
throw new Error('Corrupt group outbox intent');
|
|
235
|
+
const renewed = await context.prepareEach(stale, (message) => context.prepareDeviceMessage({ userId: message.recipientUserId, deviceId: message.recipientDeviceId }, intent.recipientId, groupCiphertext, intent.clientTimestamp, intent.contentHint));
|
|
236
|
+
const written = await reconcileOutgoingGroupDeviceSet(context.storage, intent.clientMessageId, {
|
|
237
|
+
removed: stale.map((message) => ({
|
|
238
|
+
userId: message.recipientUserId,
|
|
239
|
+
deviceId: message.recipientDeviceId,
|
|
240
|
+
})),
|
|
241
|
+
preMessages,
|
|
242
|
+
deviceMessages: renewed,
|
|
243
|
+
syncMessages: [],
|
|
244
|
+
});
|
|
245
|
+
return { intent: written, renewed };
|
|
246
|
+
}
|
|
247
|
+
async function sendStoredGroupIntent(context, initialIntent, plaintextBytes) {
|
|
46
248
|
let intent = initialIntent;
|
|
47
249
|
if (intent.kind !== 'group')
|
|
48
250
|
throw new Error('Expected a group outbox intent');
|
|
49
|
-
|
|
251
|
+
const groupCiphertext = intent.groupCiphertext;
|
|
252
|
+
if (!groupCiphertext)
|
|
50
253
|
throw new Error('Corrupt group outbox intent');
|
|
51
254
|
const relay = context.relay;
|
|
52
255
|
if (!relay) {
|
|
@@ -58,46 +261,42 @@ async function sendStoredGroupIntent(context, initialIntent) {
|
|
|
58
261
|
groupId: intent.recipientId,
|
|
59
262
|
};
|
|
60
263
|
await completeOutgoingMessageIntent(context.storage, intent.clientMessageId, localResult);
|
|
264
|
+
await completeSendLog(context, intent);
|
|
61
265
|
return localResult;
|
|
62
266
|
}
|
|
63
267
|
let messageId = `group-${intent.recipientId}-${String(intent.clientTimestamp)}`;
|
|
64
268
|
let timestamp = intent.clientTimestamp;
|
|
65
269
|
let sharedSucceeded = false;
|
|
66
270
|
let skippedUsers = [];
|
|
271
|
+
let refusedDestinationCount;
|
|
272
|
+
let sharedRefusals = [];
|
|
67
273
|
// The relay's answer to each post of the group message, for the send's acceptance.
|
|
68
274
|
const acceptances = [];
|
|
69
|
-
//
|
|
70
|
-
//
|
|
71
|
-
//
|
|
275
|
+
// The privacy policy of the pre-messages is checked before any post. A
|
|
276
|
+
// required send posts no pre-message that names the sender, and a send
|
|
277
|
+
// that cannot seal one posts nothing.
|
|
72
278
|
const preMessages = intent.preMessages ?? [];
|
|
73
|
-
const
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
timestamp: message.timestamp,
|
|
85
|
-
clientMessageId: message.clientMessageId,
|
|
86
|
-
recipientRegistrationId: message.recipientRegistrationId,
|
|
87
|
-
}), false);
|
|
88
|
-
if (message.clientMessageId !== undefined)
|
|
89
|
-
accepted.push(message.clientMessageId);
|
|
90
|
-
}, 'pre-message');
|
|
91
|
-
}
|
|
92
|
-
catch (error) {
|
|
93
|
-
if (accepted.length > 0) {
|
|
94
|
-
await confirmOutgoingPreMessages(context.storage, intent.clientMessageId, accepted);
|
|
95
|
-
}
|
|
96
|
-
throw error;
|
|
97
|
-
}
|
|
98
|
-
if (intent.groupSenderKeyDistributionId) {
|
|
99
|
-
await context.confirmSenderKeyDistributionSent(intent.recipientId, intent.groupSenderKeyDistributionId);
|
|
279
|
+
const required = context.deliveryMode === 'required' ||
|
|
280
|
+
intent.transportMode === 'sealed_sender_required' ||
|
|
281
|
+
preMessages.some((message) => message.sealedSenderDeliveryMode === 'required');
|
|
282
|
+
if (preMessages.length > 0) {
|
|
283
|
+
// One refresh covers the pre-messages and the group message.
|
|
284
|
+
await context.refreshPreMessageEndorsements(intent.recipientId, [
|
|
285
|
+
...new Set([
|
|
286
|
+
...preMessages.map((message) => message.recipientUserId),
|
|
287
|
+
...(intent.groupSharedMessage?.recipientUserIds ?? []),
|
|
288
|
+
]),
|
|
289
|
+
]);
|
|
100
290
|
}
|
|
291
|
+
// Every pre-message is accepted or dropped before the group message.
|
|
292
|
+
const dispatched = await dispatchPreMessages(context, intent, preMessages, required);
|
|
293
|
+
intent = dispatched.intent;
|
|
294
|
+
// A device that a pre-message repair refreshed, or whose session no longer
|
|
295
|
+
// has the registration that the shared body names, leaves the shared body
|
|
296
|
+
// of this attempt. It gets the key of the send when it has no handoff row,
|
|
297
|
+
// and its own post under its current registration.
|
|
298
|
+
const leaving = await leaveStaleSharedBody(context, intent, dispatched.refreshed, groupCiphertext, required);
|
|
299
|
+
intent = leaving.intent;
|
|
101
300
|
if (intent.groupSharedMessage?.deliveryMode === 'required' &&
|
|
102
301
|
!relay.sendMultiRecipientUnidentified) {
|
|
103
302
|
throw new EncryptionError('Required group sealed-sender transport is unavailable', EncryptionErrorCode.SEALED_SENDER_REQUIRED, { groupId: intent.recipientId });
|
|
@@ -116,6 +315,8 @@ async function sendStoredGroupIntent(context, initialIntent) {
|
|
|
116
315
|
messageId = result.messageId;
|
|
117
316
|
timestamp = result.serverTimestamp;
|
|
118
317
|
skippedUsers = result.uuids404;
|
|
318
|
+
refusedDestinationCount = result.refusedDestinationCount;
|
|
319
|
+
sharedRefusals = result.refusals ?? [];
|
|
119
320
|
sharedSucceeded = true;
|
|
120
321
|
acceptances.push(result);
|
|
121
322
|
}
|
|
@@ -128,55 +329,682 @@ async function sendStoredGroupIntent(context, initialIntent) {
|
|
|
128
329
|
}
|
|
129
330
|
}
|
|
130
331
|
}
|
|
131
|
-
|
|
332
|
+
// A device that the shared body does not name gets its own post. A replay
|
|
333
|
+
// keeps the stored body, so a device that the replay added is one. A
|
|
334
|
+
// device that left the shared body of this attempt is one too.
|
|
335
|
+
const sharedDevices = sharedSucceeded
|
|
336
|
+
? sharedBodyDevices(intent.groupSharedMessage)
|
|
337
|
+
: new Map();
|
|
338
|
+
for (const device of leaving.left)
|
|
339
|
+
sharedDevices.delete(device);
|
|
340
|
+
// The group-token receipt names each refused destination with its code. A
|
|
341
|
+
// destination that the Relay refused as STALE_DEVICE leaves the shared set
|
|
342
|
+
// and gets the device repair once. The refused count alone names no
|
|
343
|
+
// device, so the send infers nothing from it.
|
|
344
|
+
const refusedDevices = new Set(sharedRefusals
|
|
345
|
+
.filter((refusal) => refusal.code === 'STALE_DEVICE')
|
|
346
|
+
.map(groupDeviceKey)
|
|
347
|
+
.filter((key) => sharedDevices.has(key)));
|
|
348
|
+
for (const key of refusedDevices)
|
|
349
|
+
sharedDevices.delete(key);
|
|
132
350
|
const usersToRepair = new Set(skippedUsers);
|
|
133
351
|
const forceIdentified = Boolean(intent.groupSharedMessage && !sharedSucceeded);
|
|
134
|
-
const devicePosts = intent.deviceMessages.filter((message) => !
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
const
|
|
138
|
-
acceptances.push(...
|
|
139
|
-
if (messageId.startsWith('group-') &&
|
|
140
|
-
messageId =
|
|
141
|
-
timestamp =
|
|
352
|
+
const devicePosts = intent.deviceMessages.filter((message) => !sharedDevices.has(groupDeviceKey({ userId: message.recipientUserId, deviceId: message.recipientDeviceId })) || usersToRepair.has(message.recipientUserId));
|
|
353
|
+
const posting = intent;
|
|
354
|
+
const results = await context.sendPhase(devicePosts, (message) => sendGroupDeviceMessage(context, posting, message, forceIdentified, required, refusedDevices.has(groupDeviceKey({ userId: message.recipientUserId, deviceId: message.recipientDeviceId }))), 'device');
|
|
355
|
+
const posted = results.filter((result) => result !== undefined);
|
|
356
|
+
acceptances.push(...posted);
|
|
357
|
+
if (messageId.startsWith('group-') && posted[0]) {
|
|
358
|
+
messageId = posted[0].messageId;
|
|
359
|
+
timestamp = posted[0].serverTimestamp;
|
|
142
360
|
}
|
|
143
361
|
if (skippedUsers.length > 0) {
|
|
144
362
|
const refreshed = await context.resolveMemberDevices(intent.recipientId, {
|
|
145
363
|
clientMessageId: intent.clientMessageId,
|
|
146
364
|
groupMemberUserIds: skippedUsers,
|
|
147
365
|
});
|
|
148
|
-
const
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
366
|
+
const { added } = listedGroupDeviceChange(intent, refreshed, context.senderUserId);
|
|
367
|
+
if (added.length > 0) {
|
|
368
|
+
// The pre-messages come first. They give each added device a session
|
|
369
|
+
// and the key of the send, so its device message names the
|
|
370
|
+
// registration of that session, and the device can decrypt it.
|
|
371
|
+
const handoffs = await context.prepareSenderKeyHandoffs(intent, refreshed);
|
|
372
|
+
const additions = await context.prepareEach(added, (member) => context.prepareDeviceMessage(member, intent.recipientId, groupCiphertext, intent.clientTimestamp, intent.contentHint));
|
|
373
|
+
// A device that the repair adds gets a send log row before its post.
|
|
374
|
+
if (isLoggedSend(intent)) {
|
|
375
|
+
await context.storage.appendSendLogRecipients(intent.clientMessageId, sendLogDevices(additions));
|
|
376
|
+
}
|
|
377
|
+
intent = await reconcileOutgoingGroupDeviceSet(context.storage, intent.clientMessageId, {
|
|
378
|
+
removed: [],
|
|
379
|
+
preMessages: handoffs,
|
|
380
|
+
deviceMessages: additions,
|
|
381
|
+
syncMessages: [],
|
|
382
|
+
});
|
|
383
|
+
const dispatchedHandoffs = await dispatchPreMessages(context, intent, handoffs, required);
|
|
384
|
+
// A device that a repair of its pre-message refreshed gets a device
|
|
385
|
+
// message under its new session before its post.
|
|
386
|
+
const renewal = await renewRefreshedDeviceMessages(context, dispatchedHandoffs.intent, dispatchedHandoffs.refreshed, additions, groupCiphertext);
|
|
387
|
+
intent = renewal.intent;
|
|
388
|
+
// The confirmation of the pre-messages removed the device message of
|
|
389
|
+
// each device that the device list no longer shows. Only the additions
|
|
390
|
+
// that the intent still holds get a post.
|
|
391
|
+
const removedKeys = new Set(dispatchedHandoffs.removed.map(groupDeviceKey));
|
|
392
|
+
const renewedOf = new Map(renewal.renewed.map((message) => [
|
|
393
|
+
groupDeviceKey({ userId: message.recipientUserId, deviceId: message.recipientDeviceId }),
|
|
394
|
+
message,
|
|
395
|
+
]));
|
|
153
396
|
const extended = intent;
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
397
|
+
const additionResults = await context.sendPhase(additions.flatMap((message) => {
|
|
398
|
+
const key = groupDeviceKey({
|
|
399
|
+
userId: message.recipientUserId,
|
|
400
|
+
deviceId: message.recipientDeviceId,
|
|
401
|
+
});
|
|
402
|
+
return removedKeys.has(key) ? [] : [renewedOf.get(key) ?? message];
|
|
403
|
+
}), (message) => sendGroupDeviceMessage(context, extended, message, false, required), 'device');
|
|
404
|
+
acceptances.push(...additionResults.filter((result) => result !== undefined));
|
|
405
|
+
}
|
|
406
|
+
}
|
|
407
|
+
// The sync copies start after every device post settles. They go to the
|
|
408
|
+
// sender's own devices, so they are identified in every privacy mode: the
|
|
409
|
+
// relay already knows the account that owns the destination mailbox.
|
|
410
|
+
const syncing = intent;
|
|
411
|
+
const rebuildSyncMessage = async (deviceId) => {
|
|
412
|
+
const [message] = await context.prepareSyncMessages(syncing.recipientId, await transcriptContent(context, syncing, plaintextBytes), syncing.clientTimestamp, syncing.clientMessageId, [{ userId: context.senderUserId, deviceId }]);
|
|
413
|
+
return message;
|
|
414
|
+
};
|
|
415
|
+
await context.sendPhase(intent.syncMessages, (message) => context.postSyncMessage(syncing, message, rebuildSyncMessage), 'sync');
|
|
169
416
|
const result = {
|
|
170
417
|
clientMessageId: intent.clientMessageId,
|
|
171
418
|
messageId,
|
|
172
419
|
timestamp,
|
|
173
420
|
recipientDeviceCount: intent.groupRecipientDeviceCount ?? intent.deviceMessages.length,
|
|
174
421
|
...aggregateRelayAcceptance(acceptances),
|
|
422
|
+
...(refusedDestinationCount !== undefined && { refusedDestinationCount }),
|
|
175
423
|
groupId: intent.recipientId,
|
|
176
424
|
};
|
|
177
425
|
await completeOutgoingMessageIntent(context.storage, intent.clientMessageId, result);
|
|
426
|
+
await completeSendLog(context, intent);
|
|
178
427
|
return result;
|
|
179
428
|
}
|
|
429
|
+
/** The device of a stored device message. */
|
|
430
|
+
function messageDevice(message) {
|
|
431
|
+
return { userId: message.recipientUserId, deviceId: message.recipientDeviceId };
|
|
432
|
+
}
|
|
433
|
+
/** True when a send must not post a pre-message or a body that names the sender. */
|
|
434
|
+
function requiresSealedSender(context, intent) {
|
|
435
|
+
return (context.deliveryMode === 'required' ||
|
|
436
|
+
intent.transportMode === 'sealed_sender_required' ||
|
|
437
|
+
(intent.preMessages ?? []).some((message) => message.sealedSenderDeliveryMode === 'required'));
|
|
438
|
+
}
|
|
439
|
+
/**
|
|
440
|
+
* Seal the shared body of a declared group send again, for the device
|
|
441
|
+
* messages that the intent holds after a repair (RQ3 of the device-set
|
|
442
|
+
* contract). The group ciphertext does not change, so a device post that
|
|
443
|
+
* the Relay accepted in the same pass replays byte for byte. Only the
|
|
444
|
+
* accounts of the refused body take part, and each account is wholly in the
|
|
445
|
+
* new body or wholly out of it. Resolves to null when no account remains in
|
|
446
|
+
* a body.
|
|
447
|
+
*/
|
|
448
|
+
async function resealSharedBody(context, intent, deviceMessages) {
|
|
449
|
+
const body = intent.groupSharedMessage;
|
|
450
|
+
const accounts = new Set(body.recipientUserIds);
|
|
451
|
+
const members = deviceMessages
|
|
452
|
+
.filter((message) => accounts.has(message.recipientUserId))
|
|
453
|
+
.map(messageDevice);
|
|
454
|
+
const resealed = await context.prepareSharedMessage(intent.recipientId, members, intent.groupCiphertext, intent.contentHint);
|
|
455
|
+
return resealed ?? null;
|
|
456
|
+
}
|
|
457
|
+
/**
|
|
458
|
+
* Mark a refusal of an undeclared device post as a stale refusal of its
|
|
459
|
+
* device, so the reconciliation repairs the device with the others of the
|
|
460
|
+
* pass. Any other error is returned unchanged.
|
|
461
|
+
*/
|
|
462
|
+
function asDeviceSetFailure(error, device) {
|
|
463
|
+
if (deviceSetRefusal(error) || !isStaleDeviceRefusal(error) || !(error instanceof Error)) {
|
|
464
|
+
return error;
|
|
465
|
+
}
|
|
466
|
+
return markDeviceSetRefusal(error, {
|
|
467
|
+
kind: 'stale',
|
|
468
|
+
accounts: [{ userId: device.userId, staleDeviceIds: [device.deviceId] }],
|
|
469
|
+
});
|
|
470
|
+
}
|
|
471
|
+
/**
|
|
472
|
+
* Post a stored group intent on a relay that compares device sets (§5.5 of
|
|
473
|
+
* the device-set contract).
|
|
474
|
+
*
|
|
475
|
+
* Each pass posts the pending pre-messages, then the shared body, then a
|
|
476
|
+
* device post for each device that the body does not name. The shared post
|
|
477
|
+
* declares the devices of the body for each account. Each device post
|
|
478
|
+
* declares the devices of its account that the device posts address. After
|
|
479
|
+
* a refusal, the repair archives and removes each extra device, refreshes
|
|
480
|
+
* each stale device, starts a session with each missing device, gives each
|
|
481
|
+
* refreshed or added device the key of the send and a device message of the
|
|
482
|
+
* stored group ciphertext, and seals the body again while the Relay has not
|
|
483
|
+
* accepted it. The repair and the new restart count commit in one write.
|
|
484
|
+
*
|
|
485
|
+
* An account is wholly in the body or wholly in the device posts. A repair
|
|
486
|
+
* of an account of the body seals the body again with all devices of the
|
|
487
|
+
* account, and never moves one device of it to a device post. After the
|
|
488
|
+
* Relay accepts the body, no pass posts it again, and no refusal names an
|
|
489
|
+
* account of it, because the Relay refuses a whole post.
|
|
490
|
+
*
|
|
491
|
+
* The recipient result is stored before the sync phase. A failed sync phase
|
|
492
|
+
* gives `syncPending` and does not fail the send.
|
|
493
|
+
*/
|
|
494
|
+
async function sendDeclaredGroupIntent(context, deviceSets, initialIntent, plaintextBytes) {
|
|
495
|
+
let intent = initialIntent;
|
|
496
|
+
if (intent.kind !== 'group')
|
|
497
|
+
throw new Error('Expected a group outbox intent');
|
|
498
|
+
const groupCiphertext = intent.groupCiphertext;
|
|
499
|
+
if (!groupCiphertext)
|
|
500
|
+
throw new Error('Corrupt group outbox intent');
|
|
501
|
+
const relay = context.relay;
|
|
502
|
+
if (!relay)
|
|
503
|
+
throw new Error('Relay is required for a declared group send');
|
|
504
|
+
const clientMessageId = intent.clientMessageId;
|
|
505
|
+
const groupId = intent.recipientId;
|
|
506
|
+
// The body receipt, once the Relay accepted the body in a pass.
|
|
507
|
+
let sharedReceipt;
|
|
508
|
+
// True when the body cannot go out sealed, so every device gets its own
|
|
509
|
+
// identified post, as in an 11.x send.
|
|
510
|
+
let forceIdentified = false;
|
|
511
|
+
// The route of each declared acceptance of the last pass. A pass that
|
|
512
|
+
// reuses the body receipt records its route again.
|
|
513
|
+
const routes = new Map();
|
|
514
|
+
// The registration that each post of the last pass named, for the repair.
|
|
515
|
+
let posted = new Map();
|
|
516
|
+
// The listed devices with no prekey bundle at the last repair. The intent
|
|
517
|
+
// stores them, so a replay starts a session with each before its first post.
|
|
518
|
+
let unposted = [...(intent.deviceSetBundleMissing?.recipient ?? [])];
|
|
519
|
+
// The accounts that the last pass refused here, because they had no post.
|
|
520
|
+
let unpostedAccounts = new Set();
|
|
521
|
+
const bodyOpen = () => Boolean(intent.groupSharedMessage && !sharedReceipt && !forceIdentified);
|
|
522
|
+
const pass = async () => {
|
|
523
|
+
routes.clear();
|
|
524
|
+
posted = new Map();
|
|
525
|
+
const required = requiresSealedSender(context, intent);
|
|
526
|
+
const pending = intent.preMessages ?? [];
|
|
527
|
+
if (pending.length > 0) {
|
|
528
|
+
// One refresh covers the pre-messages and the group message.
|
|
529
|
+
await context.refreshPreMessageEndorsements(groupId, [
|
|
530
|
+
...new Set([
|
|
531
|
+
...pending.map((message) => message.recipientUserId),
|
|
532
|
+
...(bodyOpen() ? intent.groupSharedMessage.recipientUserIds : []),
|
|
533
|
+
]),
|
|
534
|
+
]);
|
|
535
|
+
// Every pre-message is accepted or dropped before the group message.
|
|
536
|
+
const dispatched = await dispatchPreMessages(context, intent, pending, required);
|
|
537
|
+
intent = dispatched.intent;
|
|
538
|
+
const touched = [...dispatched.refreshed, ...dispatched.removed];
|
|
539
|
+
if (touched.length > 0) {
|
|
540
|
+
// A device that a pre-message repair refreshed gets a device message
|
|
541
|
+
// under its new session. A body that names a touched device is
|
|
542
|
+
// sealed again in the same write.
|
|
543
|
+
const refreshedKeys = new Set(dispatched.refreshed.map(groupDeviceKey));
|
|
544
|
+
const stale = intent.deviceMessages.filter((message) => refreshedKeys.has(groupDeviceKey(messageDevice(message))));
|
|
545
|
+
const renewed = await context.prepareEach(stale, (message) => context.prepareDeviceMessage(messageDevice(message), groupId, groupCiphertext, intent.clientTimestamp, intent.contentHint));
|
|
546
|
+
const touchedAccounts = new Set(touched.map((device) => device.userId));
|
|
547
|
+
let groupSharedMessage;
|
|
548
|
+
if (bodyOpen() &&
|
|
549
|
+
intent.groupSharedMessage.recipientUserIds.some((userId) => touchedAccounts.has(userId))) {
|
|
550
|
+
groupSharedMessage = await resealSharedBody(context, intent, [
|
|
551
|
+
...intent.deviceMessages.filter((message) => !refreshedKeys.has(groupDeviceKey(messageDevice(message)))),
|
|
552
|
+
...renewed,
|
|
553
|
+
]);
|
|
554
|
+
}
|
|
555
|
+
if (stale.length > 0 || groupSharedMessage !== undefined) {
|
|
556
|
+
intent = await reconcileOutgoingGroupDeviceSet(context.storage, clientMessageId, {
|
|
557
|
+
removed: stale.map(messageDevice),
|
|
558
|
+
preMessages: [],
|
|
559
|
+
deviceMessages: renewed,
|
|
560
|
+
syncMessages: [],
|
|
561
|
+
...(groupSharedMessage !== undefined && { groupSharedMessage }),
|
|
562
|
+
});
|
|
563
|
+
}
|
|
564
|
+
}
|
|
565
|
+
}
|
|
566
|
+
const posts = [];
|
|
567
|
+
let bodyDevices = new Map();
|
|
568
|
+
const body = intent.groupSharedMessage;
|
|
569
|
+
if (body?.deliveryMode === 'required' && !relay.sendMultiRecipientUnidentified) {
|
|
570
|
+
throw new EncryptionError('Required group sealed-sender transport is unavailable', EncryptionErrorCode.SEALED_SENDER_REQUIRED, { groupId });
|
|
571
|
+
}
|
|
572
|
+
if (body && !relay.sendMultiRecipientUnidentified)
|
|
573
|
+
forceIdentified = true;
|
|
574
|
+
if (body && !forceIdentified) {
|
|
575
|
+
bodyDevices = sharedBodyDevices(body);
|
|
576
|
+
const bodyPosts = (outcome) => {
|
|
577
|
+
for (const key of bodyDevices.keys()) {
|
|
578
|
+
const [userId, deviceId] = key.split('\u0000');
|
|
579
|
+
posts.push({ device: { userId, deviceId: Number(deviceId) }, outcome });
|
|
580
|
+
}
|
|
581
|
+
};
|
|
582
|
+
if (sharedReceipt) {
|
|
583
|
+
routes.set(sharedReceipt, 'anonymous-group');
|
|
584
|
+
bodyPosts({ ok: true, value: sharedReceipt });
|
|
585
|
+
}
|
|
586
|
+
else {
|
|
587
|
+
const auth = await context.resolveGroupAuthorization(body.groupId, body.recipientUserIds);
|
|
588
|
+
if (!auth) {
|
|
589
|
+
if (body.deliveryMode === 'required') {
|
|
590
|
+
throw new Error('Required group sealed-sender authorization is unavailable');
|
|
591
|
+
}
|
|
592
|
+
forceIdentified = true;
|
|
593
|
+
bodyDevices = new Map();
|
|
594
|
+
}
|
|
595
|
+
else {
|
|
596
|
+
const declared = new Map();
|
|
597
|
+
for (const [key, registrationId] of bodyDevices) {
|
|
598
|
+
const [userId, deviceId] = key.split('\u0000');
|
|
599
|
+
declared.set(userId, [...(declared.get(userId) ?? []), Number(deviceId)]);
|
|
600
|
+
posted.set(key, registrationId);
|
|
601
|
+
}
|
|
602
|
+
const deviceSetsOfBody = [...declared].map(([userId, deviceIds]) => ({
|
|
603
|
+
userId,
|
|
604
|
+
deviceIds: deviceIds.sort((a, b) => a - b),
|
|
605
|
+
}));
|
|
606
|
+
try {
|
|
607
|
+
const receipt = await context.postToRelay(() => relay.sendMultiRecipientUnidentified(body.sentMessageBase64, auth, intent.clientTimestamp, 'user-visible', body.recipientUserIds, clientMessageId, undefined, undefined, deviceSetsOfBody), true);
|
|
608
|
+
sharedReceipt = receipt;
|
|
609
|
+
routes.set(receipt, 'anonymous-group');
|
|
610
|
+
bodyPosts({ ok: true, value: receipt });
|
|
611
|
+
}
|
|
612
|
+
catch (error) {
|
|
613
|
+
if (!(error instanceof SealedSenderAuthError)) {
|
|
614
|
+
bodyPosts({ ok: false, error });
|
|
615
|
+
}
|
|
616
|
+
else {
|
|
617
|
+
if (body.deliveryMode === 'required')
|
|
618
|
+
throw error;
|
|
619
|
+
await context.prepareEach(body.recipientUserIds, (recipientUserId) => context.reportIdentifiedFallback(recipientUserId));
|
|
620
|
+
forceIdentified = true;
|
|
621
|
+
bodyDevices = new Map();
|
|
622
|
+
}
|
|
623
|
+
}
|
|
624
|
+
}
|
|
625
|
+
}
|
|
626
|
+
}
|
|
627
|
+
// A device that the body does not name gets its own post. Each post
|
|
628
|
+
// declares the devices of its account that the device posts address.
|
|
629
|
+
const devicePosts = intent.deviceMessages.filter((message) => !bodyDevices.has(groupDeviceKey(messageDevice(message))));
|
|
630
|
+
const declared = new Map();
|
|
631
|
+
for (const message of devicePosts) {
|
|
632
|
+
declared.set(message.recipientUserId, [
|
|
633
|
+
...(declared.get(message.recipientUserId) ?? []),
|
|
634
|
+
message.recipientDeviceId,
|
|
635
|
+
]);
|
|
636
|
+
posted.set(groupDeviceKey(messageDevice(message)), message.recipientRegistrationId);
|
|
637
|
+
}
|
|
638
|
+
for (const deviceIds of declared.values())
|
|
639
|
+
deviceIds.sort((a, b) => a - b);
|
|
640
|
+
const posting = intent;
|
|
641
|
+
posts.push(...(await context.sendPhase(devicePosts, async (message) => {
|
|
642
|
+
const device = messageDevice(message);
|
|
643
|
+
try {
|
|
644
|
+
const value = await sendStoredDeviceMessage(context, posting, message, forceIdentified, {
|
|
645
|
+
deviceIds: declared.get(message.recipientUserId),
|
|
646
|
+
routes,
|
|
647
|
+
});
|
|
648
|
+
return { device, outcome: { ok: true, value } };
|
|
649
|
+
}
|
|
650
|
+
catch (error) {
|
|
651
|
+
return { device, outcome: { ok: false, error: asDeviceSetFailure(error, device) } };
|
|
652
|
+
}
|
|
653
|
+
}, 'device')));
|
|
654
|
+
// An account whose devices all lack a bundle has no post to refuse. It
|
|
655
|
+
// is refused here as missing those devices, so the pass counts.
|
|
656
|
+
const addressed = new Set([
|
|
657
|
+
...declared.keys(),
|
|
658
|
+
...[...bodyDevices.keys()].map((key) => key.split('\u0000')[0]),
|
|
659
|
+
]);
|
|
660
|
+
const refusedHere = new Map();
|
|
661
|
+
for (const device of unposted) {
|
|
662
|
+
if (addressed.has(device.userId))
|
|
663
|
+
continue;
|
|
664
|
+
refusedHere.set(device.userId, [...(refusedHere.get(device.userId) ?? []), device.deviceId]);
|
|
665
|
+
}
|
|
666
|
+
unpostedAccounts = new Set(refusedHere.keys());
|
|
667
|
+
for (const [userId, missingDeviceIds] of refusedHere) {
|
|
668
|
+
posts.push({
|
|
669
|
+
device: { userId, deviceId: missingDeviceIds[0] },
|
|
670
|
+
outcome: {
|
|
671
|
+
ok: false,
|
|
672
|
+
error: markDeviceSetRefusal(new Error('No device of the account has a session'), {
|
|
673
|
+
kind: 'mismatch',
|
|
674
|
+
accounts: [{ userId, missingDeviceIds, extraDeviceIds: [] }],
|
|
675
|
+
}),
|
|
676
|
+
},
|
|
677
|
+
});
|
|
678
|
+
}
|
|
679
|
+
return posts;
|
|
680
|
+
};
|
|
681
|
+
const repair = async (repairs, restarts) => {
|
|
682
|
+
const removed = [];
|
|
683
|
+
const ready = [];
|
|
684
|
+
const bundleMissing = [];
|
|
685
|
+
for (const account of repairs) {
|
|
686
|
+
const repaired = await deviceSets.repairDevices(account, (device) => posted.get(groupDeviceKey(device)), unpostedAccounts.has(account.userId));
|
|
687
|
+
removed.push(...repaired.removed);
|
|
688
|
+
ready.push(...repaired.ready);
|
|
689
|
+
bundleMissing.push(...repaired.bundleMissing);
|
|
690
|
+
}
|
|
691
|
+
const removedKeys = new Set(removed.map(groupDeviceKey));
|
|
692
|
+
// A removed device loses its pending pre-message in the repair write, so
|
|
693
|
+
// the handoff of a refreshed device is prepared without it.
|
|
694
|
+
const remaining = {
|
|
695
|
+
...intent,
|
|
696
|
+
preMessages: (intent.preMessages ?? []).filter((message) => !removedKeys.has(groupDeviceKey(messageDevice(message)))),
|
|
697
|
+
};
|
|
698
|
+
const preMessages = ready.length > 0 ? await context.prepareSenderKeyHandoffs(remaining, ready) : [];
|
|
699
|
+
const deviceMessages = await context.prepareEach(ready, (device) => context.prepareDeviceMessage(device, groupId, groupCiphertext, intent.clientTimestamp, intent.contentHint));
|
|
700
|
+
// A device that the repair adds gets a send log row before its post.
|
|
701
|
+
if (isLoggedSend(intent) && deviceMessages.length > 0) {
|
|
702
|
+
await context.storage.appendSendLogRecipients(clientMessageId, sendLogDevices(deviceMessages));
|
|
703
|
+
}
|
|
704
|
+
let groupSharedMessage;
|
|
705
|
+
const bodyAccounts = new Set(intent.groupSharedMessage?.recipientUserIds ?? []);
|
|
706
|
+
if (bodyOpen() && repairs.some((account) => bodyAccounts.has(account.userId))) {
|
|
707
|
+
groupSharedMessage = await resealSharedBody(context, intent, [
|
|
708
|
+
...intent.deviceMessages.filter((message) => !removedKeys.has(groupDeviceKey(messageDevice(message)))),
|
|
709
|
+
...deviceMessages,
|
|
710
|
+
]);
|
|
711
|
+
}
|
|
712
|
+
intent = await repairOutgoingDeviceSet(context.storage, clientMessageId, {
|
|
713
|
+
phase: 'recipient',
|
|
714
|
+
restarts,
|
|
715
|
+
removed,
|
|
716
|
+
bundleMissing,
|
|
717
|
+
preMessages,
|
|
718
|
+
deviceMessages,
|
|
719
|
+
...(groupSharedMessage !== undefined && { groupSharedMessage }),
|
|
720
|
+
});
|
|
721
|
+
unposted = bundleMissing;
|
|
722
|
+
return { bundleMissing };
|
|
723
|
+
};
|
|
724
|
+
const posts = await runDeviceSetPhase({
|
|
725
|
+
phase: 'recipient',
|
|
726
|
+
clientMessageId,
|
|
727
|
+
restarts: intent.deviceSetRestarts?.recipient ?? 0,
|
|
728
|
+
pass,
|
|
729
|
+
repair,
|
|
730
|
+
unresolve: (unresolved) => deviceSets.unresolve(clientMessageId, unresolved),
|
|
731
|
+
wait: (milliseconds) => deviceSets.wait(milliseconds),
|
|
732
|
+
logFailure: (device, error) => deviceSets.logFailure(device, error),
|
|
733
|
+
});
|
|
734
|
+
// The body receipt answers each device of the body, so it counts once.
|
|
735
|
+
const accepted = [
|
|
736
|
+
...new Set(posts.flatMap((post) => (post.outcome.ok ? [post.outcome.value] : []))),
|
|
737
|
+
];
|
|
738
|
+
const first = sharedReceipt ?? accepted[0];
|
|
739
|
+
const result = {
|
|
740
|
+
clientMessageId,
|
|
741
|
+
messageId: first?.messageId ?? `group-${groupId}-${String(intent.clientTimestamp)}`,
|
|
742
|
+
timestamp: first?.serverTimestamp ?? intent.clientTimestamp,
|
|
743
|
+
recipientDeviceCount: intent.groupRecipientDeviceCount ?? intent.deviceMessages.length,
|
|
744
|
+
...aggregateRelayAcceptance(accepted),
|
|
745
|
+
...(sharedReceipt?.refusedDestinationCount !== undefined && {
|
|
746
|
+
refusedDestinationCount: sharedReceipt.refusedDestinationCount,
|
|
747
|
+
}),
|
|
748
|
+
groupId,
|
|
749
|
+
};
|
|
750
|
+
// The sync phase runs when the intent holds a sync copy, or when a
|
|
751
|
+
// receipt sets needsSync. With needsSync and no own record, the send
|
|
752
|
+
// reads the own list once. When that read fails, the sync phase stays
|
|
753
|
+
// pending with no sync messages, and a replay reads it.
|
|
754
|
+
let current = (await getOutgoingMessageIntent(context.storage, clientMessageId)) ?? intent;
|
|
755
|
+
let syncUnread = false;
|
|
756
|
+
if (current.syncMessages.length === 0 &&
|
|
757
|
+
accepted.some((acceptance) => acceptance.needsSync === true)) {
|
|
758
|
+
const added = await addDeclaredGroupSync(context, deviceSets, current, plaintextBytes);
|
|
759
|
+
current = added.intent;
|
|
760
|
+
syncUnread = added.unread;
|
|
761
|
+
}
|
|
762
|
+
const syncPhase = current.syncMessages.length > 0;
|
|
763
|
+
await completeOutgoingMessageIntent(context.storage, clientMessageId, result, {
|
|
764
|
+
syncPending: syncPhase || syncUnread,
|
|
765
|
+
});
|
|
766
|
+
const sync = syncPhase
|
|
767
|
+
? await runDeclaredGroupSync(context, deviceSets, current, plaintextBytes)
|
|
768
|
+
: { synced: true, accepted: [] };
|
|
769
|
+
await completeSendLog(context, current);
|
|
770
|
+
const completed = {
|
|
771
|
+
...result,
|
|
772
|
+
...((!sync.synced || syncUnread) && { syncPending: true }),
|
|
773
|
+
};
|
|
774
|
+
return deviceSets.markUnchecked(completed, [
|
|
775
|
+
...accepted.flatMap((acceptance) => {
|
|
776
|
+
const route = routes.get(acceptance);
|
|
777
|
+
return route ? [[acceptance, route]] : [];
|
|
778
|
+
}),
|
|
779
|
+
...syncPostReceipts(sync.accepted),
|
|
780
|
+
], clientMessageId);
|
|
781
|
+
}
|
|
782
|
+
/**
|
|
783
|
+
* Add the sync copies of a group intent from one read of the own device
|
|
784
|
+
* list. A logged send gets a send log row for each copy. A failed read is
|
|
785
|
+
* logged and does not fail the send.
|
|
786
|
+
*
|
|
787
|
+
* @returns The intent, and true when the read failed
|
|
788
|
+
*/
|
|
789
|
+
async function addDeclaredGroupSync(context, deviceSets, intent, plaintextBytes) {
|
|
790
|
+
try {
|
|
791
|
+
const ownDevices = await deviceSets.readOwnDevices();
|
|
792
|
+
const syncMessages = ownDevices.length > 0
|
|
793
|
+
? await context.prepareSyncMessages(intent.recipientId, await transcriptContent(context, intent, plaintextBytes), intent.clientTimestamp, intent.clientMessageId, ownDevices)
|
|
794
|
+
: [];
|
|
795
|
+
if (syncMessages.length === 0)
|
|
796
|
+
return { intent, unread: false };
|
|
797
|
+
if (isLoggedSend(intent)) {
|
|
798
|
+
await context.storage.appendSendLogRecipients(intent.clientMessageId, sendLogDevices(syncMessages));
|
|
799
|
+
}
|
|
800
|
+
return {
|
|
801
|
+
intent: await reconcileOutgoingSyncMessages(context.storage, intent.clientMessageId, [], syncMessages),
|
|
802
|
+
unread: false,
|
|
803
|
+
};
|
|
804
|
+
}
|
|
805
|
+
catch (error) {
|
|
806
|
+
deviceSets.warn('Could not read the own device list for the sync phase of a send', error);
|
|
807
|
+
return { intent, unread: true };
|
|
808
|
+
}
|
|
809
|
+
}
|
|
810
|
+
/**
|
|
811
|
+
* Run the declared sync phase of a completed group intent. A device that a
|
|
812
|
+
* repair refreshes or adds gets a transcript of the logged content when the
|
|
813
|
+
* send is logged, and a send log row.
|
|
814
|
+
*/
|
|
815
|
+
function runDeclaredGroupSync(context, deviceSets, intent, plaintextBytes) {
|
|
816
|
+
return deviceSets.runSyncPhase(intent, async (device) => {
|
|
817
|
+
const [message] = await context.prepareSyncMessages(intent.recipientId, await transcriptContent(context, intent, plaintextBytes), intent.clientTimestamp, intent.clientMessageId, [{ userId: context.senderUserId, deviceId: device.deviceId }]);
|
|
818
|
+
if (message && isLoggedSend(intent)) {
|
|
819
|
+
await context.storage.appendSendLogRecipients(intent.clientMessageId, sendLogDevices([message]));
|
|
820
|
+
}
|
|
821
|
+
return message;
|
|
822
|
+
});
|
|
823
|
+
}
|
|
824
|
+
/**
|
|
825
|
+
* Replay a stored group send on a relay that compares device sets. A
|
|
826
|
+
* terminal send starts a new run at 0 restarts. A completed send with a
|
|
827
|
+
* pending sync phase posts only its sync messages. A send that is not
|
|
828
|
+
* terminal resumes with its stored restart count. The replay reads no device
|
|
829
|
+
* list: the Relay comparison finds each change. The one exception is a
|
|
830
|
+
* pending sync phase with no sync message and no stored own device with no
|
|
831
|
+
* bundle: the send could not read the own device list, and the replay reads
|
|
832
|
+
* it. A stored device with no bundle goes through the sync phase, which
|
|
833
|
+
* refuses it as missing and retries it as the live run does.
|
|
834
|
+
*/
|
|
835
|
+
async function replayDeclaredGroupIntent(context, deviceSets, existing, plaintextBytes) {
|
|
836
|
+
const intent = await restartOutgoingDeviceSet(context.storage, existing.clientMessageId);
|
|
837
|
+
const stored = outgoingMessageIntentResult(intent);
|
|
838
|
+
if (!stored)
|
|
839
|
+
return sendDeclaredGroupIntent(context, deviceSets, intent, plaintextBytes);
|
|
840
|
+
if (!intent.syncPending) {
|
|
841
|
+
await completeSendLog(context, intent);
|
|
842
|
+
return stored;
|
|
843
|
+
}
|
|
844
|
+
const { syncPending: _pending, ...result } = stored;
|
|
845
|
+
let current = intent;
|
|
846
|
+
if (current.syncMessages.length === 0 &&
|
|
847
|
+
(current.deviceSetBundleMissing?.sync ?? []).length === 0) {
|
|
848
|
+
const added = await addDeclaredGroupSync(context, deviceSets, current, plaintextBytes);
|
|
849
|
+
if (added.unread)
|
|
850
|
+
return stored;
|
|
851
|
+
current = added.intent;
|
|
852
|
+
if (current.syncMessages.length === 0) {
|
|
853
|
+
await completeOutgoingSyncPhase(context.storage, current.clientMessageId);
|
|
854
|
+
await completeSendLog(context, current);
|
|
855
|
+
return result;
|
|
856
|
+
}
|
|
857
|
+
}
|
|
858
|
+
const sync = await runDeclaredGroupSync(context, deviceSets, current, plaintextBytes);
|
|
859
|
+
await completeSendLog(context, current);
|
|
860
|
+
return deviceSets.markUnchecked(sync.synced ? result : { ...result, syncPending: true }, syncPostReceipts(sync.accepted), current.clientMessageId);
|
|
861
|
+
}
|
|
862
|
+
/**
|
|
863
|
+
* Read the device lists of the members and of the sender's own account again
|
|
864
|
+
* before the replay of a stored group send, and apply them to the intent in
|
|
865
|
+
* one write. Each message of a device that the reads no longer list leaves
|
|
866
|
+
* the intent. The stored shared body does not change.
|
|
867
|
+
*/
|
|
868
|
+
async function rereadStoredGroupDevices(context, intent, plaintextBytes) {
|
|
869
|
+
if (!context.relay)
|
|
870
|
+
return intent;
|
|
871
|
+
const members = await rereadMemberDevices(context, intent);
|
|
872
|
+
const own = await rereadOwnDevices(context, intent, plaintextBytes);
|
|
873
|
+
if (!members && !own)
|
|
874
|
+
return intent;
|
|
875
|
+
return reconcileOutgoingGroupDeviceSet(context.storage, intent.clientMessageId, {
|
|
876
|
+
removed: [...(members?.removed ?? []), ...(own?.removed ?? [])],
|
|
877
|
+
preMessages: members?.preMessages ?? [],
|
|
878
|
+
deviceMessages: members?.deviceMessages ?? [],
|
|
879
|
+
syncMessages: own?.syncMessages ?? [],
|
|
880
|
+
});
|
|
881
|
+
}
|
|
882
|
+
/**
|
|
883
|
+
* The change that a new read of the member device lists makes to a stored
|
|
884
|
+
* group send, or undefined when the read changes nothing. Each listed device
|
|
885
|
+
* of another member that the send does not reach gets the key of the send
|
|
886
|
+
* from the current distribution, and a device message of the stored group
|
|
887
|
+
* ciphertext. A device that the replay adds cannot decrypt the stored
|
|
888
|
+
* message, because the current distribution is past its chain index. It
|
|
889
|
+
* recovers through its retry request and the resend of a logged send, so it
|
|
890
|
+
* gets a send log row here.
|
|
891
|
+
*
|
|
892
|
+
* Signal encrypts the message again for the devices of each attempt. The
|
|
893
|
+
* replay here keeps the stored ciphertext. The Relay keys each delivery
|
|
894
|
+
* operation by its message ID and refuses another operation under the same
|
|
895
|
+
* ID with RETRY_CONFLICT, so a new group ciphertext under the clientMessageId
|
|
896
|
+
* of the send would conflict with the posts that the Relay already holds. A
|
|
897
|
+
* device that the replay adds therefore gets the content only when the send
|
|
898
|
+
* is `Resendable`.
|
|
899
|
+
*/
|
|
900
|
+
async function rereadMemberDevices(context, intent) {
|
|
901
|
+
const groupCiphertext = intent.groupCiphertext;
|
|
902
|
+
if (!groupCiphertext || !intent.groupMemberUserIds?.length)
|
|
903
|
+
return undefined;
|
|
904
|
+
const listed = await context.resolveMemberDevices(intent.recipientId, {
|
|
905
|
+
clientMessageId: intent.clientMessageId,
|
|
906
|
+
groupMemberUserIds: intent.groupMemberUserIds,
|
|
907
|
+
});
|
|
908
|
+
const { unlisted, added } = listedGroupDeviceChange(intent, listed, context.senderUserId);
|
|
909
|
+
if (unlisted.length === 0 && added.length === 0)
|
|
910
|
+
return undefined;
|
|
911
|
+
// The complete device list of each member with an added device.
|
|
912
|
+
const addedUsers = new Set(added.map((member) => member.userId));
|
|
913
|
+
const handoffs = await context.prepareSenderKeyHandoffs(intent, listed.filter((member) => addedUsers.has(member.userId)));
|
|
914
|
+
const deviceMessages = await context.prepareEach(added, (member) => context.prepareDeviceMessage(member, intent.recipientId, groupCiphertext, intent.clientTimestamp, intent.contentHint));
|
|
915
|
+
if (isLoggedSend(intent) && deviceMessages.length > 0) {
|
|
916
|
+
await context.storage.appendSendLogRecipients(intent.clientMessageId, sendLogDevices(deviceMessages));
|
|
917
|
+
}
|
|
918
|
+
return { removed: unlisted, preMessages: handoffs, deviceMessages, syncMessages: [] };
|
|
919
|
+
}
|
|
920
|
+
/**
|
|
921
|
+
* The change that a new read of the sender's own device list makes to the
|
|
922
|
+
* sync copies of a stored group send, or undefined when the read changes
|
|
923
|
+
* nothing. Each sync copy of an own device that the read no longer lists
|
|
924
|
+
* leaves the intent. Each listed own device with no sync copy gets a
|
|
925
|
+
* transcript. The transcript of a logged send carries the logged content, so
|
|
926
|
+
* it is equal to the content that the other devices got. With no logged
|
|
927
|
+
* content, the transcript carries the content as the group gets it now.
|
|
928
|
+
*/
|
|
929
|
+
async function rereadOwnDevices(context, intent, plaintextBytes) {
|
|
930
|
+
const ownDevices = await context.resolveOwnDevices();
|
|
931
|
+
const { unlisted, added } = listedOwnDeviceChange(intent.syncMessages, ownDevices.map((device) => device.deviceId));
|
|
932
|
+
if (unlisted.length === 0 && added.length === 0)
|
|
933
|
+
return undefined;
|
|
934
|
+
const addedDevices = ownDevices.filter((device) => added.includes(device.deviceId));
|
|
935
|
+
const syncMessages = addedDevices.length > 0
|
|
936
|
+
? await context.prepareSyncMessages(intent.recipientId, await transcriptContent(context, intent, plaintextBytes), intent.clientTimestamp, intent.clientMessageId, addedDevices)
|
|
937
|
+
: [];
|
|
938
|
+
if (isLoggedSend(intent) && syncMessages.length > 0) {
|
|
939
|
+
await context.storage.appendSendLogRecipients(intent.clientMessageId, sendLogDevices(syncMessages));
|
|
940
|
+
}
|
|
941
|
+
return {
|
|
942
|
+
removed: unlisted.map((deviceId) => ({ userId: context.senderUserId, deviceId })),
|
|
943
|
+
preMessages: [],
|
|
944
|
+
deviceMessages: [],
|
|
945
|
+
syncMessages,
|
|
946
|
+
};
|
|
947
|
+
}
|
|
948
|
+
/**
|
|
949
|
+
* The content of a sent transcript of a stored group send. A logged send
|
|
950
|
+
* gives its logged content, so the transcript is equal to the content that
|
|
951
|
+
* the other devices got. With no logged content, the transcript carries the
|
|
952
|
+
* content as the group gets it now.
|
|
953
|
+
*/
|
|
954
|
+
async function transcriptContent(context, intent, plaintextBytes) {
|
|
955
|
+
return ((await loggedContent(context, intent)) ??
|
|
956
|
+
(await context.prepareContent(intent.recipientId, plaintextBytes)));
|
|
957
|
+
}
|
|
958
|
+
/** The logged content of a send, or undefined when the send is not logged or no row remains. */
|
|
959
|
+
async function loggedContent(context, intent) {
|
|
960
|
+
if (!isLoggedSend(intent))
|
|
961
|
+
return undefined;
|
|
962
|
+
const [row] = await context.storage.getSendLogRecipients(intent.clientMessageId);
|
|
963
|
+
if (!row)
|
|
964
|
+
return undefined;
|
|
965
|
+
const entry = await context.storage.getSendLogEntry(intent.clientMessageId, row);
|
|
966
|
+
return entry?.payload.plaintext;
|
|
967
|
+
}
|
|
968
|
+
/** True when the send logs its content for a resend. Only a `Resendable` send is logged. */
|
|
969
|
+
function isLoggedSend(intent) {
|
|
970
|
+
return intent.contentHint === ContentHint.Resendable;
|
|
971
|
+
}
|
|
972
|
+
/** The devices of stored device messages, as send log recipients. */
|
|
973
|
+
function sendLogDevices(messages) {
|
|
974
|
+
return messages.map((message) => ({
|
|
975
|
+
userId: message.recipientUserId,
|
|
976
|
+
deviceId: message.recipientDeviceId,
|
|
977
|
+
}));
|
|
978
|
+
}
|
|
979
|
+
/** Every device that a group intent sends the content to: the members, then the sync devices. */
|
|
980
|
+
function intentSendLogDevices(intent) {
|
|
981
|
+
return sendLogDevices([...intent.deviceMessages, ...intent.syncMessages]);
|
|
982
|
+
}
|
|
983
|
+
/**
|
|
984
|
+
* Write the send log entry of a resendable send. The entry is written before
|
|
985
|
+
* the intent and before any post, so a device that gets the message always
|
|
986
|
+
* has a row. A failed write throws, and the send posts nothing. The entry is
|
|
987
|
+
* written once: a stored intent proves it was written, so a replay never
|
|
988
|
+
* writes it again. A row that an E2EE receipt, `forgetSentContent`, or the
|
|
989
|
+
* retention sweep deleted stays deleted.
|
|
990
|
+
*/
|
|
991
|
+
async function storeSendLog(context, intent, plaintextBytes) {
|
|
992
|
+
const recipients = intentSendLogDevices(intent);
|
|
993
|
+
if (!isLoggedSend(intent) || recipients.length === 0)
|
|
994
|
+
return;
|
|
995
|
+
await context.storage.storeSendLogEntry({
|
|
996
|
+
clientMessageId: intent.clientMessageId,
|
|
997
|
+
groupId: intent.recipientId,
|
|
998
|
+
clientTimestamp: intent.clientTimestamp,
|
|
999
|
+
contentHint: ContentHint.Resendable,
|
|
1000
|
+
plaintext: plaintextBytes,
|
|
1001
|
+
}, recipients);
|
|
1002
|
+
}
|
|
1003
|
+
/** Mark the send log entry of a finished resendable send complete. */
|
|
1004
|
+
async function completeSendLog(context, intent) {
|
|
1005
|
+
if (isLoggedSend(intent))
|
|
1006
|
+
await context.storage.markSendLogComplete(intent.clientMessageId);
|
|
1007
|
+
}
|
|
180
1008
|
export async function sendGroupWithExactOutbox(context, groupId, plaintextBytes, options) {
|
|
181
1009
|
return withOutgoingMessageIntentLock(context.storage, options.clientMessageId, async () => {
|
|
182
1010
|
const plaintextDigest = CryptoUtils.bytesToBase64(await CryptoUtils.sha256(plaintextBytes));
|
|
@@ -190,22 +1018,30 @@ export async function sendGroupWithExactOutbox(context, groupId, plaintextBytes,
|
|
|
190
1018
|
JSON.stringify(existing.groupMemberUserIds) !== JSON.stringify(groupMemberUserIds)) {
|
|
191
1019
|
throw new Error('A clientMessageId cannot identify two different logical sends');
|
|
192
1020
|
}
|
|
193
|
-
if (
|
|
1021
|
+
if (context.deviceSets && context.relay) {
|
|
1022
|
+
return replayDeclaredGroupIntent(context, context.deviceSets, existing, plaintextBytes);
|
|
1023
|
+
}
|
|
1024
|
+
if (existing.result) {
|
|
1025
|
+
await completeSendLog(context, existing);
|
|
194
1026
|
return existing.result;
|
|
195
|
-
|
|
1027
|
+
}
|
|
1028
|
+
return sendStoredGroupIntent(context, await rereadStoredGroupDevices(context, existing, plaintextBytes), plaintextBytes);
|
|
196
1029
|
}
|
|
197
1030
|
const clientTimestamp = options.timestamp ?? Date.now();
|
|
1031
|
+
// The digest above covers the caller's content, so a replay compares
|
|
1032
|
+
// like with like. The group gets the content with its context.
|
|
1033
|
+
const contentBytes = await context.prepareContent(groupId, plaintextBytes);
|
|
198
1034
|
// One device-list read for each member in this send.
|
|
199
1035
|
let memberRead;
|
|
200
1036
|
const readMembers = () => (memberRead ??= context.resolveMemberDevices(groupId, options));
|
|
201
|
-
const preparedPayload = await context.preparePayload(groupId,
|
|
1037
|
+
const preparedPayload = await context.preparePayload(groupId, contentBytes, { ...options, timestamp: clientTimestamp }, readMembers);
|
|
202
1038
|
const encryptedMessageBase64 = preparedPayload.ciphertext;
|
|
203
1039
|
const members = context.relay ? await readMembers() : [];
|
|
204
1040
|
const otherMembers = members.filter((member) => member.userId !== context.senderUserId);
|
|
205
|
-
const groupSharedMessage = await context.prepareSharedMessage(groupId, otherMembers, encryptedMessageBase64);
|
|
206
|
-
const deviceMessages = await context.prepareEach(otherMembers, (member) => context.prepareDeviceMessage(member, groupId, encryptedMessageBase64, clientTimestamp));
|
|
1041
|
+
const groupSharedMessage = await context.prepareSharedMessage(groupId, otherMembers, encryptedMessageBase64, options.contentHint);
|
|
1042
|
+
const deviceMessages = await context.prepareEach(otherMembers, (member) => context.prepareDeviceMessage(member, groupId, encryptedMessageBase64, clientTimestamp, options.contentHint));
|
|
207
1043
|
const syncMessages = context.relay
|
|
208
|
-
? await context.prepareSyncMessages(groupId,
|
|
1044
|
+
? await context.prepareSyncMessages(groupId, contentBytes, clientTimestamp, options.clientMessageId, await context.resolveOwnDevices())
|
|
209
1045
|
: [];
|
|
210
1046
|
const intent = {
|
|
211
1047
|
kind: 'group',
|
|
@@ -231,9 +1067,14 @@ export async function sendGroupWithExactOutbox(context, groupId, plaintextBytes,
|
|
|
231
1067
|
groupSenderKeyDistributionId: preparedPayload.senderKeyDistributionId,
|
|
232
1068
|
}),
|
|
233
1069
|
...(groupSharedMessage && { groupSharedMessage }),
|
|
1070
|
+
...(options.contentHint !== undefined && { contentHint: options.contentHint }),
|
|
234
1071
|
};
|
|
1072
|
+
await storeSendLog(context, intent, contentBytes);
|
|
235
1073
|
await storeOutgoingMessageIntent(context.storage, intent);
|
|
236
|
-
|
|
1074
|
+
if (context.deviceSets && context.relay) {
|
|
1075
|
+
return sendDeclaredGroupIntent(context, context.deviceSets, intent, plaintextBytes);
|
|
1076
|
+
}
|
|
1077
|
+
return sendStoredGroupIntent(context, intent, plaintextBytes);
|
|
237
1078
|
});
|
|
238
1079
|
}
|
|
239
1080
|
//# sourceMappingURL=group-outbox.js.map
|