@open-e2ee/signal-protocol-sdk 10.1.0 → 12.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/ADAPTERS.md +4 -4
- package/ARCHITECTURE.md +6 -8
- package/CHANGELOG.md +1413 -0
- package/README.md +1 -1
- package/SECURITY.md +2 -2
- package/TROUBLESHOOTING.md +1 -1
- package/client/README.md +84 -37
- package/device/README.md +39 -85
- package/dist/client/client.d.ts +342 -62
- package/dist/client/client.d.ts.map +1 -1
- package/dist/client/client.js +1195 -179
- package/dist/client/client.js.map +1 -1
- package/dist/client/config.d.ts +40 -32
- 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 +308 -6
- package/dist/client/event-hooks.d.ts.map +1 -1
- package/dist/client/event-hooks.js +9 -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-device-standing.d.ts +52 -0
- package/dist/client/hosted-device-standing.d.ts.map +1 -0
- package/dist/client/hosted-device-standing.js +74 -0
- package/dist/client/hosted-device-standing.js.map +1 -0
- package/dist/client/hosted-mailbox-subscription.d.ts +48 -3
- package/dist/client/hosted-mailbox-subscription.d.ts.map +1 -1
- package/dist/client/hosted-mailbox-subscription.js +288 -74
- 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 +167 -69
- package/dist/client/hosted-transport.js.map +1 -1
- package/dist/client/hosted.d.ts +22 -5
- package/dist/client/hosted.d.ts.map +1 -1
- package/dist/client/hosted.js +122 -45
- package/dist/client/hosted.js.map +1 -1
- package/dist/client/index.d.ts +6 -4
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js +3 -1
- 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 +118 -17
- package/dist/client/messages.js.map +1 -1
- package/dist/client/one-time-prekey-refill.d.ts +7 -0
- package/dist/client/one-time-prekey-refill.d.ts.map +1 -1
- package/dist/client/one-time-prekey-refill.js +5 -1
- package/dist/client/one-time-prekey-refill.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 +30 -0
- package/dist/client/relay-acceptance.d.ts.map +1 -1
- package/dist/client/relay-acceptance.js +55 -0
- 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 +220 -150
- 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 +68 -19
- package/dist/client/retry-family.d.ts.map +1 -1
- package/dist/client/retry-family.js +59 -17
- package/dist/client/retry-family.js.map +1 -1
- package/dist/client/retry-request-envelope.d.ts +145 -18
- package/dist/client/retry-request-envelope.d.ts.map +1 -1
- package/dist/client/retry-request-envelope.js +301 -64
- package/dist/client/retry-request-envelope.js.map +1 -1
- package/dist/client/retry-request-lifecycle.d.ts +157 -0
- package/dist/client/retry-request-lifecycle.d.ts.map +1 -0
- package/dist/client/retry-request-lifecycle.js +437 -0
- package/dist/client/retry-request-lifecycle.js.map +1 -0
- 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 +106 -18
- package/dist/client/retry.d.ts.map +1 -1
- package/dist/client/retry.js +687 -139
- 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 +2265 -343
- 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 +20 -19
- package/dist/internal/manager/manager.d.ts.map +1 -1
- package/dist/internal/manager/manager.js +56 -39
- 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 +13 -11
- package/dist/internal/session/cipher.d.ts.map +1 -1
- package/dist/internal/session/cipher.js +40 -22
- 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 +4 -12
- 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 +411 -14
- package/dist/local/store/reliability.d.ts.map +1 -1
- package/dist/local/store/reliability.js +532 -58
- 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/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/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 +104 -110
- 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/dist/utils/retry.d.ts +2 -0
- package/dist/utils/retry.d.ts.map +1 -1
- package/dist/utils/retry.js +7 -0
- package/dist/utils/retry.js.map +1 -1
- 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 +235 -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
|
@@ -0,0 +1,196 @@
|
|
|
1
|
+
import { type DeviceSetRefusal } from '../remote/relay/device-set.js';
|
|
2
|
+
import { type RelayPostAcceptance } from './relay-acceptance.js';
|
|
3
|
+
/**
|
|
4
|
+
* The device-set reconciliation of a declared send.
|
|
5
|
+
*
|
|
6
|
+
* A send that declares its device sets posts every device of one phase in a
|
|
7
|
+
* pass. When the Relay refuses the declaration of a post, the send repairs
|
|
8
|
+
* every device that the refusals of the pass name, adds one to the restart
|
|
9
|
+
* count of the phase in the same write, and posts the phase again. A device
|
|
10
|
+
* that the Relay accepted in an earlier pass gets its stored bytes again,
|
|
11
|
+
* and the Relay answers with the stored receipt. The recipient phase and the
|
|
12
|
+
* sync phase each have at most 10 restarts, so at most 11 posts.
|
|
13
|
+
*/
|
|
14
|
+
/** The most restarts of one phase of a declared send. */
|
|
15
|
+
export declare const DEVICE_SET_RESTARTS_MAXIMUM = 10;
|
|
16
|
+
/**
|
|
17
|
+
* The wait before the next pass after a repair that found no prekey bundle
|
|
18
|
+
* for a listed device: 250 ms, then 500 ms, then 1 s for each later pass.
|
|
19
|
+
*/
|
|
20
|
+
export declare function deviceSetBundleRetryDelay(consecutiveMisses: number): number;
|
|
21
|
+
/** A phase of a declared send. The recipient phase runs first. */
|
|
22
|
+
export type DeviceSetPhase = 'recipient' | 'sync';
|
|
23
|
+
/** One device of a declared send: an account and one of its devices. */
|
|
24
|
+
export interface DeviceSetDevice {
|
|
25
|
+
readonly userId: string;
|
|
26
|
+
readonly deviceId: number;
|
|
27
|
+
}
|
|
28
|
+
/** The devices of one account that the last refusal of a phase named. */
|
|
29
|
+
export interface DeviceSetRefusalAccount {
|
|
30
|
+
readonly userId: string;
|
|
31
|
+
readonly missingDeviceIds: readonly number[];
|
|
32
|
+
readonly extraDeviceIds: readonly number[];
|
|
33
|
+
readonly staleDeviceIds: readonly number[];
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* The last refusal of a phase. `DEVICE_SET_MISMATCH` and `STALE_DEVICE` are
|
|
37
|
+
* the Relay's answers. `BUNDLE_NOT_FOUND` is a listed device that had no
|
|
38
|
+
* prekey bundle when the send repaired it.
|
|
39
|
+
*/
|
|
40
|
+
export interface DeviceSetLastRefusal {
|
|
41
|
+
readonly code: 'DEVICE_SET_MISMATCH' | 'STALE_DEVICE' | 'BUNDLE_NOT_FOUND';
|
|
42
|
+
readonly accounts: readonly DeviceSetRefusalAccount[];
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Why a phase of a declared send ended without the acceptance of every
|
|
46
|
+
* device. `exhausted`: the Relay refused the declaration after the 10th
|
|
47
|
+
* restart. `expired`: the Relay refused a restart post with
|
|
48
|
+
* `OPERATION_EXPIRED`, because the operation epoch of the send is outside
|
|
49
|
+
* its admission window.
|
|
50
|
+
*/
|
|
51
|
+
export type DeviceSetUnresolvedReason = 'exhausted' | 'expired';
|
|
52
|
+
/** The terminal record of a phase that ended without reconciliation. */
|
|
53
|
+
export interface DeviceSetUnresolved {
|
|
54
|
+
readonly phase: DeviceSetPhase;
|
|
55
|
+
readonly reason: DeviceSetUnresolvedReason;
|
|
56
|
+
readonly restarts: number;
|
|
57
|
+
/** Absent when the phase resumed from a stored count and ended before a refusal. */
|
|
58
|
+
readonly lastRefusal?: DeviceSetLastRefusal;
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* A declared send that ended without the acceptance of every device. The
|
|
62
|
+
* devices in `acceptedDevices` stay accepted. The outbox keeps the send as
|
|
63
|
+
* terminal, and the SDK does not post it again. A call of `send()` with the
|
|
64
|
+
* same `clientMessageId` starts a new run at 0 restarts.
|
|
65
|
+
*
|
|
66
|
+
* `isOutgoingMessageError` is true for this error.
|
|
67
|
+
*/
|
|
68
|
+
export declare class DeviceSetReconciliationError extends Error {
|
|
69
|
+
readonly name = "DeviceSetReconciliationError";
|
|
70
|
+
readonly reason: DeviceSetUnresolvedReason;
|
|
71
|
+
readonly phase: DeviceSetPhase;
|
|
72
|
+
readonly restarts: number;
|
|
73
|
+
readonly lastRefusal: DeviceSetLastRefusal | undefined;
|
|
74
|
+
readonly acceptedDevices: readonly DeviceSetDevice[];
|
|
75
|
+
readonly unresolvedDevices: readonly DeviceSetDevice[];
|
|
76
|
+
readonly clientMessageId: string;
|
|
77
|
+
constructor(unresolved: DeviceSetUnresolved, devices: {
|
|
78
|
+
readonly acceptedDevices: readonly DeviceSetDevice[];
|
|
79
|
+
readonly unresolvedDevices: readonly DeviceSetDevice[];
|
|
80
|
+
}, clientMessageId: string);
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* The route of a send whose Relay did not mark a declared post as compared.
|
|
84
|
+
* `identified-direct`: an identified post to one device. `anonymous-direct`:
|
|
85
|
+
* a sealed post to one device. `anonymous-group`: the shared sealed post of a
|
|
86
|
+
* group send.
|
|
87
|
+
*/
|
|
88
|
+
export type RelayProtocolRoute = 'identified-direct' | 'anonymous-direct' | 'anonymous-group';
|
|
89
|
+
/** The code of a Relay answer that does not follow the device-set contract. */
|
|
90
|
+
export type RelayProtocolErrorCode = 'DEVICE_SET_UNCHECKED';
|
|
91
|
+
/**
|
|
92
|
+
* A Relay accepted a declared post without the `deviceSetChecked` mark. The
|
|
93
|
+
* send is delivered and its result does not change, because a second post
|
|
94
|
+
* could deliver the message twice. The client reports the error once for the
|
|
95
|
+
* send through `onRelayProtocolError`. A sync payload of a method such as
|
|
96
|
+
* `syncReadToLinkedDevices` has no send ID, so its error has no
|
|
97
|
+
* `clientMessageId`.
|
|
98
|
+
*/
|
|
99
|
+
export declare class RelayProtocolError extends Error {
|
|
100
|
+
readonly code: RelayProtocolErrorCode;
|
|
101
|
+
readonly clientMessageId: string | undefined;
|
|
102
|
+
readonly route: RelayProtocolRoute;
|
|
103
|
+
readonly name = "RelayProtocolError";
|
|
104
|
+
constructor(code: RelayProtocolErrorCode, clientMessageId: string | undefined, route: RelayProtocolRoute);
|
|
105
|
+
}
|
|
106
|
+
/** Mark a send result with the protocol error of its send. */
|
|
107
|
+
export declare function markRelayProtocolError<T extends object>(result: T, error: RelayProtocolError): T;
|
|
108
|
+
/** The protocol error that a send result is marked with, if any. */
|
|
109
|
+
export declare function relayProtocolErrorOf(result: unknown): RelayProtocolError | undefined;
|
|
110
|
+
/** The receipt of one accepted declared post and the route of the post. */
|
|
111
|
+
export type DeclaredPostReceipt = readonly [RelayPostAcceptance, RelayProtocolRoute];
|
|
112
|
+
/** The end of the declared sync phase of a send. */
|
|
113
|
+
export interface DeclaredSyncOutcome {
|
|
114
|
+
/** True when every sync post was accepted. */
|
|
115
|
+
readonly synced: boolean;
|
|
116
|
+
/** The receipt of each accepted sync post of every pass. */
|
|
117
|
+
readonly accepted: readonly RelayPostAcceptance[];
|
|
118
|
+
}
|
|
119
|
+
/** The receipts of accepted sync posts. A sync copy is an identified post to an own device. */
|
|
120
|
+
export declare function syncPostReceipts(accepted: readonly RelayPostAcceptance[]): DeclaredPostReceipt[];
|
|
121
|
+
/**
|
|
122
|
+
* The protocol error of the first receipt that has no `deviceSetChecked`
|
|
123
|
+
* mark, or undefined when the Relay marked each receipt.
|
|
124
|
+
*/
|
|
125
|
+
export declare function uncheckedDeclaredPost(receipts: readonly DeclaredPostReceipt[], clientMessageId: string | undefined): RelayProtocolError | undefined;
|
|
126
|
+
/** The repairs of one account that the refusals of a pass name. */
|
|
127
|
+
export interface DeviceSetAccountRepair {
|
|
128
|
+
readonly userId: string;
|
|
129
|
+
readonly missingDeviceIds: readonly number[];
|
|
130
|
+
readonly extraDeviceIds: readonly number[];
|
|
131
|
+
readonly staleDeviceIds: readonly number[];
|
|
132
|
+
}
|
|
133
|
+
/**
|
|
134
|
+
* Merge the refusals of one pass by account. The posts of one account in a
|
|
135
|
+
* pass share one declaration, so no device is both missing and extra. A
|
|
136
|
+
* device that is extra is not also repaired as stale.
|
|
137
|
+
*/
|
|
138
|
+
export declare function mergeDeviceSetRefusals(refusals: readonly DeviceSetRefusal[]): DeviceSetAccountRepair[];
|
|
139
|
+
/** The answer to one device post of a pass. */
|
|
140
|
+
export interface DeviceSetPost<T> {
|
|
141
|
+
readonly device: DeviceSetDevice;
|
|
142
|
+
readonly outcome: {
|
|
143
|
+
readonly ok: true;
|
|
144
|
+
readonly value: T;
|
|
145
|
+
} | {
|
|
146
|
+
readonly ok: false;
|
|
147
|
+
readonly error: unknown;
|
|
148
|
+
};
|
|
149
|
+
}
|
|
150
|
+
/** What a repair of one pass did. */
|
|
151
|
+
export interface DeviceSetRepairOutcome {
|
|
152
|
+
/** The listed devices that had no prekey bundle. The next pass waits first. */
|
|
153
|
+
readonly bundleMissing: readonly DeviceSetDevice[];
|
|
154
|
+
}
|
|
155
|
+
/** One phase of a declared send, as the reconciliation runs it. */
|
|
156
|
+
export interface DeviceSetPhaseRun<T> {
|
|
157
|
+
readonly phase: DeviceSetPhase;
|
|
158
|
+
readonly clientMessageId: string;
|
|
159
|
+
/** The restart count that the outbox holds for the phase. */
|
|
160
|
+
readonly restarts: number;
|
|
161
|
+
/** Post every device of the phase once with its declaration. */
|
|
162
|
+
pass(): Promise<readonly DeviceSetPost<T>[]>;
|
|
163
|
+
/**
|
|
164
|
+
* Repair the devices that the refusals name, and commit the repair with
|
|
165
|
+
* the new restart count in one write.
|
|
166
|
+
*/
|
|
167
|
+
repair(repairs: readonly DeviceSetAccountRepair[], restarts: number): Promise<DeviceSetRepairOutcome>;
|
|
168
|
+
/** Record the terminal state of the phase. */
|
|
169
|
+
unresolve(unresolved: DeviceSetUnresolved): Promise<void>;
|
|
170
|
+
/** Wait before the next pass. Rejects when the send stops. */
|
|
171
|
+
wait(milliseconds: number): Promise<void>;
|
|
172
|
+
/** Log a failure of a pass that does not decide the phase. */
|
|
173
|
+
logFailure?(device: DeviceSetDevice, error: unknown): void;
|
|
174
|
+
}
|
|
175
|
+
/**
|
|
176
|
+
* Run one phase of a declared send until every device post is accepted.
|
|
177
|
+
*
|
|
178
|
+
* After a pass, the first rule that applies decides:
|
|
179
|
+
* 1. A stopped send throws `RelayWorkStopped`.
|
|
180
|
+
* 2. A restart post that the Relay refused with `OPERATION_EXPIRED` ends the
|
|
181
|
+
* phase with `expired`. The restart count does not change.
|
|
182
|
+
* 3. A device-set refusal repairs every device that the refusals of the pass
|
|
183
|
+
* name, and starts the phase again. After the 10th restart it ends the
|
|
184
|
+
* phase with `exhausted`.
|
|
185
|
+
* 4. Any other failure throws the failure of the first failed device.
|
|
186
|
+
*
|
|
187
|
+
* @returns The answers of the last pass, all accepted
|
|
188
|
+
* @throws {DeviceSetReconciliationError} when the phase ends unresolved
|
|
189
|
+
*/
|
|
190
|
+
export declare function runDeviceSetPhase<T>(run: DeviceSetPhaseRun<T>): Promise<readonly DeviceSetPost<T>[]>;
|
|
191
|
+
/**
|
|
192
|
+
* Wait for a time, or reject with `RelayWorkStopped` when the stop signal
|
|
193
|
+
* aborts first.
|
|
194
|
+
*/
|
|
195
|
+
export declare function waitUnlessStopped(milliseconds: number, stopSignal?: AbortSignal): Promise<void>;
|
|
196
|
+
//# sourceMappingURL=device-set-reconciliation.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"device-set-reconciliation.d.ts","sourceRoot":"","sources":["../../client/device-set-reconciliation.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,gBAAgB,EACtB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAyB,KAAK,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAGrF;;;;;;;;;;GAUG;AAEH,yDAAyD;AACzD,eAAO,MAAM,2BAA2B,KAAK,CAAC;AAE9C;;;GAGG;AACH,wBAAgB,yBAAyB,CAAC,iBAAiB,EAAE,MAAM,GAAG,MAAM,CAI3E;AAED,kEAAkE;AAClE,MAAM,MAAM,cAAc,GAAG,WAAW,GAAG,MAAM,CAAC;AAElD,wEAAwE;AACxE,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B;AAED,yEAAyE;AACzE,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,gBAAgB,EAAE,SAAS,MAAM,EAAE,CAAC;IAC7C,QAAQ,CAAC,cAAc,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3C,QAAQ,CAAC,cAAc,EAAE,SAAS,MAAM,EAAE,CAAC;CAC5C;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,IAAI,EAAE,qBAAqB,GAAG,cAAc,GAAG,kBAAkB,CAAC;IAC3E,QAAQ,CAAC,QAAQ,EAAE,SAAS,uBAAuB,EAAE,CAAC;CACvD;AAED;;;;;;GAMG;AACH,MAAM,MAAM,yBAAyB,GAAG,WAAW,GAAG,SAAS,CAAC;AAEhE,wEAAwE;AACxE,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC;IAC/B,QAAQ,CAAC,MAAM,EAAE,yBAAyB,CAAC;IAC3C,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,oFAAoF;IACpF,QAAQ,CAAC,WAAW,CAAC,EAAE,oBAAoB,CAAC;CAC7C;AAED;;;;;;;GAOG;AACH,qBAAa,4BAA6B,SAAQ,KAAK;IACrD,SAAkB,IAAI,kCAAkC;IACxD,QAAQ,CAAC,MAAM,EAAE,yBAAyB,CAAC;IAC3C,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC;IAC/B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,WAAW,EAAE,oBAAoB,GAAG,SAAS,CAAC;IACvD,QAAQ,CAAC,eAAe,EAAE,SAAS,eAAe,EAAE,CAAC;IACrD,QAAQ,CAAC,iBAAiB,EAAE,SAAS,eAAe,EAAE,CAAC;IACvD,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IAEjC,YACE,UAAU,EAAE,mBAAmB,EAC/B,OAAO,EAAE;QACP,QAAQ,CAAC,eAAe,EAAE,SAAS,eAAe,EAAE,CAAC;QACrD,QAAQ,CAAC,iBAAiB,EAAE,SAAS,eAAe,EAAE,CAAC;KACxD,EACD,eAAe,EAAE,MAAM,EAcxB;CACF;AAED;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG,mBAAmB,GAAG,kBAAkB,GAAG,iBAAiB,CAAC;AAE9F,+EAA+E;AAC/E,MAAM,MAAM,sBAAsB,GAAG,sBAAsB,CAAC;AAE5D;;;;;;;GAOG;AACH,qBAAa,kBAAmB,SAAQ,KAAK;IAIzC,QAAQ,CAAC,IAAI,EAAE,sBAAsB;IACrC,QAAQ,CAAC,eAAe,EAAE,MAAM,GAAG,SAAS;IAC5C,QAAQ,CAAC,KAAK,EAAE,kBAAkB;IALpC,SAAkB,IAAI,wBAAwB;IAE9C,YACW,IAAI,EAAE,sBAAsB,EAC5B,eAAe,EAAE,MAAM,GAAG,SAAS,EACnC,KAAK,EAAE,kBAAkB,EAGnC;CACF;AAID,8DAA8D;AAC9D,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,kBAAkB,GAAG,CAAC,CAGhG;AAED,oEAAoE;AACpE,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,kBAAkB,GAAG,SAAS,CAIpF;AAED,2EAA2E;AAC3E,MAAM,MAAM,mBAAmB,GAAG,SAAS,CAAC,mBAAmB,EAAE,kBAAkB,CAAC,CAAC;AAErF,oDAAoD;AACpD,MAAM,WAAW,mBAAmB;IAClC,8CAA8C;IAC9C,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,4DAA4D;IAC5D,QAAQ,CAAC,QAAQ,EAAE,SAAS,mBAAmB,EAAE,CAAC;CACnD;AAED,+FAA+F;AAC/F,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,SAAS,mBAAmB,EAAE,GACvC,mBAAmB,EAAE,CAEvB;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CACnC,QAAQ,EAAE,SAAS,mBAAmB,EAAE,EACxC,eAAe,EAAE,MAAM,GAAG,SAAS,GAClC,kBAAkB,GAAG,SAAS,CAKhC;AAED,mEAAmE;AACnE,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,gBAAgB,EAAE,SAAS,MAAM,EAAE,CAAC;IAC7C,QAAQ,CAAC,cAAc,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3C,QAAQ,CAAC,cAAc,EAAE,SAAS,MAAM,EAAE,CAAC;CAC5C;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CACpC,QAAQ,EAAE,SAAS,gBAAgB,EAAE,GACpC,sBAAsB,EAAE,CAmC1B;AAmBD,+CAA+C;AAC/C,MAAM,WAAW,aAAa,CAAC,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAC;IACjC,QAAQ,CAAC,OAAO,EAAE;QAAE,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC;QAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;KAAE,GAAG;QAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC;QAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAA;KAAE,CAAC;CAC9G;AAED,qCAAqC;AACrC,MAAM,WAAW,sBAAsB;IACrC,+EAA+E;IAC/E,QAAQ,CAAC,aAAa,EAAE,SAAS,eAAe,EAAE,CAAC;CACpD;AAED,mEAAmE;AACnE,MAAM,WAAW,iBAAiB,CAAC,CAAC;IAClC,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC;IAC/B,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,6DAA6D;IAC7D,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,gEAAgE;IAChE,IAAI,IAAI,OAAO,CAAC,SAAS,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC7C;;;OAGG;IACH,MAAM,CAAC,OAAO,EAAE,SAAS,sBAAsB,EAAE,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;IACtG,8CAA8C;IAC9C,SAAS,CAAC,UAAU,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1D,8DAA8D;IAC9D,IAAI,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1C,8DAA8D;IAC9D,UAAU,CAAC,CAAC,MAAM,EAAE,eAAe,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAAC;CAC5D;AAMD;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,iBAAiB,CAAC,CAAC,EACvC,GAAG,EAAE,iBAAiB,CAAC,CAAC,CAAC,GACxB,OAAO,CAAC,SAAS,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,CAgGtC;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAa/F"}
|
|
@@ -0,0 +1,282 @@
|
|
|
1
|
+
import { deviceSetRefusal, } from '../remote/relay/device-set.js';
|
|
2
|
+
import { relayOperationRefusal } from './relay-acceptance.js';
|
|
3
|
+
import { RelayWorkStopped } from './relay-work.js';
|
|
4
|
+
/**
|
|
5
|
+
* The device-set reconciliation of a declared send.
|
|
6
|
+
*
|
|
7
|
+
* A send that declares its device sets posts every device of one phase in a
|
|
8
|
+
* pass. When the Relay refuses the declaration of a post, the send repairs
|
|
9
|
+
* every device that the refusals of the pass name, adds one to the restart
|
|
10
|
+
* count of the phase in the same write, and posts the phase again. A device
|
|
11
|
+
* that the Relay accepted in an earlier pass gets its stored bytes again,
|
|
12
|
+
* and the Relay answers with the stored receipt. The recipient phase and the
|
|
13
|
+
* sync phase each have at most 10 restarts, so at most 11 posts.
|
|
14
|
+
*/
|
|
15
|
+
/** The most restarts of one phase of a declared send. */
|
|
16
|
+
export const DEVICE_SET_RESTARTS_MAXIMUM = 10;
|
|
17
|
+
/**
|
|
18
|
+
* The wait before the next pass after a repair that found no prekey bundle
|
|
19
|
+
* for a listed device: 250 ms, then 500 ms, then 1 s for each later pass.
|
|
20
|
+
*/
|
|
21
|
+
export function deviceSetBundleRetryDelay(consecutiveMisses) {
|
|
22
|
+
if (consecutiveMisses <= 1)
|
|
23
|
+
return 250;
|
|
24
|
+
if (consecutiveMisses === 2)
|
|
25
|
+
return 500;
|
|
26
|
+
return 1000;
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* A declared send that ended without the acceptance of every device. The
|
|
30
|
+
* devices in `acceptedDevices` stay accepted. The outbox keeps the send as
|
|
31
|
+
* terminal, and the SDK does not post it again. A call of `send()` with the
|
|
32
|
+
* same `clientMessageId` starts a new run at 0 restarts.
|
|
33
|
+
*
|
|
34
|
+
* `isOutgoingMessageError` is true for this error.
|
|
35
|
+
*/
|
|
36
|
+
export class DeviceSetReconciliationError extends Error {
|
|
37
|
+
name = 'DeviceSetReconciliationError';
|
|
38
|
+
reason;
|
|
39
|
+
phase;
|
|
40
|
+
restarts;
|
|
41
|
+
lastRefusal;
|
|
42
|
+
acceptedDevices;
|
|
43
|
+
unresolvedDevices;
|
|
44
|
+
clientMessageId;
|
|
45
|
+
constructor(unresolved, devices, clientMessageId) {
|
|
46
|
+
super(unresolved.reason === 'exhausted'
|
|
47
|
+
? `The Relay refused the device sets of the ${unresolved.phase} phase after ${String(unresolved.restarts)} restarts`
|
|
48
|
+
: `The Relay refused a restart of the ${unresolved.phase} phase because the operation expired`);
|
|
49
|
+
this.reason = unresolved.reason;
|
|
50
|
+
this.phase = unresolved.phase;
|
|
51
|
+
this.restarts = unresolved.restarts;
|
|
52
|
+
this.lastRefusal = unresolved.lastRefusal;
|
|
53
|
+
this.acceptedDevices = devices.acceptedDevices;
|
|
54
|
+
this.unresolvedDevices = devices.unresolvedDevices;
|
|
55
|
+
this.clientMessageId = clientMessageId;
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* A Relay accepted a declared post without the `deviceSetChecked` mark. The
|
|
60
|
+
* send is delivered and its result does not change, because a second post
|
|
61
|
+
* could deliver the message twice. The client reports the error once for the
|
|
62
|
+
* send through `onRelayProtocolError`. A sync payload of a method such as
|
|
63
|
+
* `syncReadToLinkedDevices` has no send ID, so its error has no
|
|
64
|
+
* `clientMessageId`.
|
|
65
|
+
*/
|
|
66
|
+
export class RelayProtocolError extends Error {
|
|
67
|
+
code;
|
|
68
|
+
clientMessageId;
|
|
69
|
+
route;
|
|
70
|
+
name = 'RelayProtocolError';
|
|
71
|
+
constructor(code, clientMessageId, route) {
|
|
72
|
+
super('The Relay accepted a declared post without comparing its device set');
|
|
73
|
+
this.code = code;
|
|
74
|
+
this.clientMessageId = clientMessageId;
|
|
75
|
+
this.route = route;
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
const relayProtocolErrors = new WeakMap();
|
|
79
|
+
/** Mark a send result with the protocol error of its send. */
|
|
80
|
+
export function markRelayProtocolError(result, error) {
|
|
81
|
+
if (!relayProtocolErrors.has(result))
|
|
82
|
+
relayProtocolErrors.set(result, error);
|
|
83
|
+
return result;
|
|
84
|
+
}
|
|
85
|
+
/** The protocol error that a send result is marked with, if any. */
|
|
86
|
+
export function relayProtocolErrorOf(result) {
|
|
87
|
+
return result !== null && typeof result === 'object'
|
|
88
|
+
? relayProtocolErrors.get(result)
|
|
89
|
+
: undefined;
|
|
90
|
+
}
|
|
91
|
+
/** The receipts of accepted sync posts. A sync copy is an identified post to an own device. */
|
|
92
|
+
export function syncPostReceipts(accepted) {
|
|
93
|
+
return accepted.map((acceptance) => [acceptance, 'identified-direct']);
|
|
94
|
+
}
|
|
95
|
+
/**
|
|
96
|
+
* The protocol error of the first receipt that has no `deviceSetChecked`
|
|
97
|
+
* mark, or undefined when the Relay marked each receipt.
|
|
98
|
+
*/
|
|
99
|
+
export function uncheckedDeclaredPost(receipts, clientMessageId) {
|
|
100
|
+
const unchecked = receipts.find(([acceptance]) => acceptance.deviceSetChecked !== true);
|
|
101
|
+
return unchecked
|
|
102
|
+
? new RelayProtocolError('DEVICE_SET_UNCHECKED', clientMessageId, unchecked[1])
|
|
103
|
+
: undefined;
|
|
104
|
+
}
|
|
105
|
+
/**
|
|
106
|
+
* Merge the refusals of one pass by account. The posts of one account in a
|
|
107
|
+
* pass share one declaration, so no device is both missing and extra. A
|
|
108
|
+
* device that is extra is not also repaired as stale.
|
|
109
|
+
*/
|
|
110
|
+
export function mergeDeviceSetRefusals(refusals) {
|
|
111
|
+
const accounts = new Map();
|
|
112
|
+
const account = (userId) => {
|
|
113
|
+
let entry = accounts.get(userId);
|
|
114
|
+
if (!entry) {
|
|
115
|
+
entry = { missing: new Set(), extra: new Set(), stale: new Set() };
|
|
116
|
+
accounts.set(userId, entry);
|
|
117
|
+
}
|
|
118
|
+
return entry;
|
|
119
|
+
};
|
|
120
|
+
for (const refusal of refusals) {
|
|
121
|
+
for (const refused of refusal.accounts) {
|
|
122
|
+
const entry = account(refused.userId);
|
|
123
|
+
if ('staleDeviceIds' in refused) {
|
|
124
|
+
for (const deviceId of refused.staleDeviceIds)
|
|
125
|
+
entry.stale.add(deviceId);
|
|
126
|
+
}
|
|
127
|
+
else {
|
|
128
|
+
for (const deviceId of refused.missingDeviceIds)
|
|
129
|
+
entry.missing.add(deviceId);
|
|
130
|
+
for (const deviceId of refused.extraDeviceIds)
|
|
131
|
+
entry.extra.add(deviceId);
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
const sorted = (devices) => [...devices].sort((a, b) => a - b);
|
|
136
|
+
return [...accounts].map(([userId, entry]) => {
|
|
137
|
+
for (const deviceId of entry.extra)
|
|
138
|
+
entry.missing.delete(deviceId);
|
|
139
|
+
for (const deviceId of entry.extra)
|
|
140
|
+
entry.stale.delete(deviceId);
|
|
141
|
+
return {
|
|
142
|
+
userId,
|
|
143
|
+
missingDeviceIds: sorted(entry.missing),
|
|
144
|
+
extraDeviceIds: sorted(entry.extra),
|
|
145
|
+
staleDeviceIds: sorted(entry.stale),
|
|
146
|
+
};
|
|
147
|
+
});
|
|
148
|
+
}
|
|
149
|
+
function lastRefusalOf(refusals, repairs) {
|
|
150
|
+
return {
|
|
151
|
+
code: refusals.some((refusal) => refusal.kind === 'mismatch')
|
|
152
|
+
? 'DEVICE_SET_MISMATCH'
|
|
153
|
+
: 'STALE_DEVICE',
|
|
154
|
+
accounts: repairs.map((repair) => ({
|
|
155
|
+
userId: repair.userId,
|
|
156
|
+
missingDeviceIds: [...repair.missingDeviceIds],
|
|
157
|
+
extraDeviceIds: [...repair.extraDeviceIds],
|
|
158
|
+
staleDeviceIds: [...repair.staleDeviceIds],
|
|
159
|
+
})),
|
|
160
|
+
};
|
|
161
|
+
}
|
|
162
|
+
function deviceKey(device) {
|
|
163
|
+
return `${device.userId}\u0000${String(device.deviceId)}`;
|
|
164
|
+
}
|
|
165
|
+
/**
|
|
166
|
+
* Run one phase of a declared send until every device post is accepted.
|
|
167
|
+
*
|
|
168
|
+
* After a pass, the first rule that applies decides:
|
|
169
|
+
* 1. A stopped send throws `RelayWorkStopped`.
|
|
170
|
+
* 2. A restart post that the Relay refused with `OPERATION_EXPIRED` ends the
|
|
171
|
+
* phase with `expired`. The restart count does not change.
|
|
172
|
+
* 3. A device-set refusal repairs every device that the refusals of the pass
|
|
173
|
+
* name, and starts the phase again. After the 10th restart it ends the
|
|
174
|
+
* phase with `exhausted`.
|
|
175
|
+
* 4. Any other failure throws the failure of the first failed device.
|
|
176
|
+
*
|
|
177
|
+
* @returns The answers of the last pass, all accepted
|
|
178
|
+
* @throws {DeviceSetReconciliationError} when the phase ends unresolved
|
|
179
|
+
*/
|
|
180
|
+
export async function runDeviceSetPhase(run) {
|
|
181
|
+
let restarts = run.restarts;
|
|
182
|
+
let lastRefusal;
|
|
183
|
+
let bundleMisses = 0;
|
|
184
|
+
const accepted = new Map();
|
|
185
|
+
const unresolve = async (reason, posts, named) => {
|
|
186
|
+
const unresolved = {
|
|
187
|
+
phase: run.phase,
|
|
188
|
+
reason,
|
|
189
|
+
restarts,
|
|
190
|
+
...(lastRefusal && { lastRefusal }),
|
|
191
|
+
};
|
|
192
|
+
await run.unresolve(unresolved);
|
|
193
|
+
const unresolvedDevices = new Map();
|
|
194
|
+
for (const post of posts) {
|
|
195
|
+
if (!post.outcome.ok && !accepted.has(deviceKey(post.device))) {
|
|
196
|
+
unresolvedDevices.set(deviceKey(post.device), post.device);
|
|
197
|
+
}
|
|
198
|
+
}
|
|
199
|
+
for (const device of named) {
|
|
200
|
+
if (!accepted.has(deviceKey(device)))
|
|
201
|
+
unresolvedDevices.set(deviceKey(device), device);
|
|
202
|
+
}
|
|
203
|
+
throw new DeviceSetReconciliationError(unresolved, {
|
|
204
|
+
acceptedDevices: [...accepted.values()],
|
|
205
|
+
unresolvedDevices: [...unresolvedDevices.values()],
|
|
206
|
+
}, run.clientMessageId);
|
|
207
|
+
};
|
|
208
|
+
for (;;) {
|
|
209
|
+
const posts = await run.pass();
|
|
210
|
+
for (const post of posts) {
|
|
211
|
+
if (post.outcome.ok)
|
|
212
|
+
accepted.set(deviceKey(post.device), post.device);
|
|
213
|
+
}
|
|
214
|
+
const failures = posts.flatMap((post) => post.outcome.ok ? [] : [{ device: post.device, error: post.outcome.error }]);
|
|
215
|
+
if (failures.length === 0)
|
|
216
|
+
return posts;
|
|
217
|
+
const stopped = failures.find((failure) => failure.error instanceof RelayWorkStopped);
|
|
218
|
+
if (stopped)
|
|
219
|
+
throw stopped.error;
|
|
220
|
+
if (restarts > 0 &&
|
|
221
|
+
failures.some((failure) => relayOperationRefusal(failure.error) === 'OPERATION_EXPIRED')) {
|
|
222
|
+
return unresolve('expired', posts, []);
|
|
223
|
+
}
|
|
224
|
+
const refusals = failures.flatMap((failure) => {
|
|
225
|
+
const refusal = deviceSetRefusal(failure.error);
|
|
226
|
+
return refusal ? [refusal] : [];
|
|
227
|
+
});
|
|
228
|
+
if (refusals.length === 0) {
|
|
229
|
+
for (const failure of failures.slice(1))
|
|
230
|
+
run.logFailure?.(failure.device, failure.error);
|
|
231
|
+
throw failures[0].error;
|
|
232
|
+
}
|
|
233
|
+
const repairs = mergeDeviceSetRefusals(refusals);
|
|
234
|
+
lastRefusal = lastRefusalOf(refusals, repairs);
|
|
235
|
+
if (restarts >= DEVICE_SET_RESTARTS_MAXIMUM) {
|
|
236
|
+
const named = repairs.flatMap((repair) => [...repair.missingDeviceIds, ...repair.staleDeviceIds].map((deviceId) => ({
|
|
237
|
+
userId: repair.userId,
|
|
238
|
+
deviceId,
|
|
239
|
+
})));
|
|
240
|
+
return unresolve('exhausted', posts, named);
|
|
241
|
+
}
|
|
242
|
+
restarts += 1;
|
|
243
|
+
const { bundleMissing } = await run.repair(repairs, restarts);
|
|
244
|
+
if (bundleMissing.length === 0) {
|
|
245
|
+
bundleMisses = 0;
|
|
246
|
+
continue;
|
|
247
|
+
}
|
|
248
|
+
bundleMisses += 1;
|
|
249
|
+
lastRefusal = {
|
|
250
|
+
code: 'BUNDLE_NOT_FOUND',
|
|
251
|
+
accounts: [...new Set(bundleMissing.map((device) => device.userId))].map((userId) => ({
|
|
252
|
+
userId,
|
|
253
|
+
missingDeviceIds: bundleMissing
|
|
254
|
+
.filter((device) => device.userId === userId)
|
|
255
|
+
.map((device) => device.deviceId),
|
|
256
|
+
extraDeviceIds: [],
|
|
257
|
+
staleDeviceIds: [],
|
|
258
|
+
})),
|
|
259
|
+
};
|
|
260
|
+
await run.wait(deviceSetBundleRetryDelay(bundleMisses));
|
|
261
|
+
}
|
|
262
|
+
}
|
|
263
|
+
/**
|
|
264
|
+
* Wait for a time, or reject with `RelayWorkStopped` when the stop signal
|
|
265
|
+
* aborts first.
|
|
266
|
+
*/
|
|
267
|
+
export function waitUnlessStopped(milliseconds, stopSignal) {
|
|
268
|
+
if (stopSignal?.aborted)
|
|
269
|
+
return Promise.reject(new RelayWorkStopped());
|
|
270
|
+
return new Promise((resolve, reject) => {
|
|
271
|
+
const onAbort = () => {
|
|
272
|
+
clearTimeout(timer);
|
|
273
|
+
reject(new RelayWorkStopped());
|
|
274
|
+
};
|
|
275
|
+
const timer = setTimeout(() => {
|
|
276
|
+
stopSignal?.removeEventListener('abort', onAbort);
|
|
277
|
+
resolve();
|
|
278
|
+
}, milliseconds);
|
|
279
|
+
stopSignal?.addEventListener('abort', onAbort, { once: true });
|
|
280
|
+
});
|
|
281
|
+
}
|
|
282
|
+
//# sourceMappingURL=device-set-reconciliation.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"device-set-reconciliation.js","sourceRoot":"","sources":["../../client/device-set-reconciliation.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,GAEjB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,qBAAqB,EAA4B,MAAM,oBAAoB,CAAC;AACrF,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEhD;;;;;;;;;;GAUG;AAEH,yDAAyD;AACzD,MAAM,CAAC,MAAM,2BAA2B,GAAG,EAAE,CAAC;AAE9C;;;GAGG;AACH,MAAM,UAAU,yBAAyB,CAAC,iBAAyB;IACjE,IAAI,iBAAiB,IAAI,CAAC;QAAE,OAAO,GAAG,CAAC;IACvC,IAAI,iBAAiB,KAAK,CAAC;QAAE,OAAO,GAAG,CAAC;IACxC,OAAO,IAAI,CAAC;AACd,CAAC;AA+CD;;;;;;;GAOG;AACH,MAAM,OAAO,4BAA6B,SAAQ,KAAK;IACnC,IAAI,GAAG,8BAA8B,CAAC;IAC/C,MAAM,CAA4B;IAClC,KAAK,CAAiB;IACtB,QAAQ,CAAS;IACjB,WAAW,CAAmC;IAC9C,eAAe,CAA6B;IAC5C,iBAAiB,CAA6B;IAC9C,eAAe,CAAS;IAEjC,YACE,UAA+B,EAC/B,OAGC,EACD,eAAuB;QAEvB,KAAK,CACH,UAAU,CAAC,MAAM,KAAK,WAAW;YAC/B,CAAC,CAAC,4CAA4C,UAAU,CAAC,KAAK,gBAAgB,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,WAAW;YACpH,CAAC,CAAC,sCAAsC,UAAU,CAAC,KAAK,sCAAsC,CACjG,CAAC;QACF,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;QAChC,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;QAC9B,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;QACpC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC;QAC1C,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;QAC/C,IAAI,CAAC,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC;QACnD,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;IACzC,CAAC;CACF;AAaD;;;;;;;GAOG;AACH,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAIhC,IAAI;IACJ,eAAe;IACf,KAAK;IALE,IAAI,GAAG,oBAAoB,CAAC;IAE9C,YACW,IAA4B,EAC5B,eAAmC,EACnC,KAAyB;QAElC,KAAK,CAAC,qEAAqE,CAAC,CAAC;oBAJpE,IAAI;+BACJ,eAAe;qBACf,KAAK;IAGhB,CAAC;CACF;AAED,MAAM,mBAAmB,GAAG,IAAI,OAAO,EAA8B,CAAC;AAEtE,8DAA8D;AAC9D,MAAM,UAAU,sBAAsB,CAAmB,MAAS,EAAE,KAAyB;IAC3F,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,MAAM,CAAC;QAAE,mBAAmB,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAC7E,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,oEAAoE;AACpE,MAAM,UAAU,oBAAoB,CAAC,MAAe;IAClD,OAAO,MAAM,KAAK,IAAI,IAAI,OAAO,MAAM,KAAK,QAAQ;QAClD,CAAC,CAAC,mBAAmB,CAAC,GAAG,CAAC,MAAM,CAAC;QACjC,CAAC,CAAC,SAAS,CAAC;AAChB,CAAC;AAaD,+FAA+F;AAC/F,MAAM,UAAU,gBAAgB,CAC9B,QAAwC;IAExC,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,UAAU,EAAE,mBAAmB,CAAU,CAAC,CAAC;AAClF,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,qBAAqB,CACnC,QAAwC,EACxC,eAAmC;IAEnC,MAAM,SAAS,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,gBAAgB,KAAK,IAAI,CAAC,CAAC;IACxF,OAAO,SAAS;QACd,CAAC,CAAC,IAAI,kBAAkB,CAAC,sBAAsB,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;QAC/E,CAAC,CAAC,SAAS,CAAC;AAChB,CAAC;AAUD;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CACpC,QAAqC;IAErC,MAAM,QAAQ,GAAG,IAAI,GAAG,EAGrB,CAAC;IACJ,MAAM,OAAO,GAAG,CAAC,MAAc,EAAE,EAAE;QACjC,IAAI,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACjC,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,KAAK,GAAG,EAAE,OAAO,EAAE,IAAI,GAAG,EAAE,EAAE,KAAK,EAAE,IAAI,GAAG,EAAE,EAAE,KAAK,EAAE,IAAI,GAAG,EAAE,EAAE,CAAC;YACnE,QAAQ,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC9B,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IACF,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,KAAK,MAAM,OAAO,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YACvC,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACtC,IAAI,gBAAgB,IAAI,OAAO,EAAE,CAAC;gBAChC,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,cAAc;oBAAE,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YAC3E,CAAC;iBAAM,CAAC;gBACN,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,gBAAgB;oBAAE,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBAC7E,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,cAAc;oBAAE,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YAC3E,CAAC;QACH,CAAC;IACH,CAAC;IACD,MAAM,MAAM,GAAG,CAAC,OAAoB,EAAE,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5E,OAAO,CAAC,GAAG,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,EAAE;QAC3C,KAAK,MAAM,QAAQ,IAAI,KAAK,CAAC,KAAK;YAAE,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACnE,KAAK,MAAM,QAAQ,IAAI,KAAK,CAAC,KAAK;YAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACjE,OAAO;YACL,MAAM;YACN,gBAAgB,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC;YACvC,cAAc,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;YACnC,cAAc,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;SACpC,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,aAAa,CACpB,QAAqC,EACrC,OAA0C;IAE1C,OAAO;QACL,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,UAAU,CAAC;YAC3D,CAAC,CAAC,qBAAqB;YACvB,CAAC,CAAC,cAAc;QAClB,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YACjC,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,gBAAgB,EAAE,CAAC,GAAG,MAAM,CAAC,gBAAgB,CAAC;YAC9C,cAAc,EAAE,CAAC,GAAG,MAAM,CAAC,cAAc,CAAC;YAC1C,cAAc,EAAE,CAAC,GAAG,MAAM,CAAC,cAAc,CAAC;SAC3C,CAAC,CAAC;KACJ,CAAC;AACJ,CAAC;AAmCD,SAAS,SAAS,CAAC,MAAuB;IACxC,OAAO,GAAG,MAAM,CAAC,MAAM,SAAS,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;AAC5D,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,GAAyB;IAEzB,IAAI,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;IAC5B,IAAI,WAA6C,CAAC;IAClD,IAAI,YAAY,GAAG,CAAC,CAAC;IACrB,MAAM,QAAQ,GAAG,IAAI,GAAG,EAA2B,CAAC;IACpD,MAAM,SAAS,GAAG,KAAK,EACrB,MAAiC,EACjC,KAAkC,EAClC,KAAiC,EACjB,EAAE;QAClB,MAAM,UAAU,GAAwB;YACtC,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,MAAM;YACN,QAAQ;YACR,GAAG,CAAC,WAAW,IAAI,EAAE,WAAW,EAAE,CAAC;SACpC,CAAC;QACF,MAAM,GAAG,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QAChC,MAAM,iBAAiB,GAAG,IAAI,GAAG,EAA2B,CAAC;QAC7D,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;gBAC9D,iBAAiB,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;YAC7D,CAAC;QACH,CAAC;QACD,KAAK,MAAM,MAAM,IAAI,KAAK,EAAE,CAAC;YAC3B,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;gBAAE,iBAAiB,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC;QACzF,CAAC;QACD,MAAM,IAAI,4BAA4B,CACpC,UAAU,EACV;YACE,eAAe,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC;YACvC,iBAAiB,EAAE,CAAC,GAAG,iBAAiB,CAAC,MAAM,EAAE,CAAC;SACnD,EACD,GAAG,CAAC,eAAe,CACpB,CAAC;IACJ,CAAC,CAAC;IAEF,SAAS,CAAC;QACR,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;QAC/B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,IAAI,CAAC,OAAO,CAAC,EAAE;gBAAE,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QACzE,CAAC;QACD,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CACtC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAC5E,CAAC;QACF,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,KAAK,CAAC;QAExC,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,YAAY,gBAAgB,CAAC,CAAC;QACtF,IAAI,OAAO;YAAE,MAAM,OAAO,CAAC,KAAK,CAAC;QACjC,IACE,QAAQ,GAAG,CAAC;YACZ,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,qBAAqB,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,mBAAmB,CAAC,EACxF,CAAC;YACD,OAAO,SAAS,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QACzC,CAAC;QAED,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC5C,MAAM,OAAO,GAAG,gBAAgB,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAChD,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAClC,CAAC,CAAC,CAAC;QACH,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC1B,KAAK,MAAM,OAAO,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;gBAAE,GAAG,CAAC,UAAU,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;YACzF,MAAM,QAAQ,CAAC,CAAC,CAAE,CAAC,KAAK,CAAC;QAC3B,CAAC;QAED,MAAM,OAAO,GAAG,sBAAsB,CAAC,QAAQ,CAAC,CAAC;QACjD,WAAW,GAAG,aAAa,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC/C,IAAI,QAAQ,IAAI,2BAA2B,EAAE,CAAC;YAC5C,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CACvC,CAAC,GAAG,MAAM,CAAC,gBAAgB,EAAE,GAAG,MAAM,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;gBACxE,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,QAAQ;aACT,CAAC,CAAC,CACJ,CAAC;YACF,OAAO,SAAS,CAAC,WAAW,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAC9C,CAAC;QAED,QAAQ,IAAI,CAAC,CAAC;QACd,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,GAAG,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAC9D,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/B,YAAY,GAAG,CAAC,CAAC;YACjB,SAAS;QACX,CAAC;QACD,YAAY,IAAI,CAAC,CAAC;QAClB,WAAW,GAAG;YACZ,IAAI,EAAE,kBAAkB;YACxB,QAAQ,EAAE,CAAC,GAAG,IAAI,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;gBACpF,MAAM;gBACN,gBAAgB,EAAE,aAAa;qBAC5B,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC;qBAC5C,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC;gBACnC,cAAc,EAAE,EAAE;gBAClB,cAAc,EAAE,EAAE;aACnB,CAAC,CAAC;SACJ,CAAC;QACF,MAAM,GAAG,CAAC,IAAI,CAAC,yBAAyB,CAAC,YAAY,CAAC,CAAC,CAAC;IAC1D,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAAC,YAAoB,EAAE,UAAwB;IAC9E,IAAI,UAAU,EAAE,OAAO;QAAE,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,gBAAgB,EAAE,CAAC,CAAC;IACvE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,GAAG,EAAE;YACnB,YAAY,CAAC,KAAK,CAAC,CAAC;YACpB,MAAM,CAAC,IAAI,gBAAgB,EAAE,CAAC,CAAC;QACjC,CAAC,CAAC;QACF,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;YAC5B,UAAU,EAAE,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAClD,OAAO,EAAE,CAAC;QACZ,CAAC,EAAE,YAAY,CAAC,CAAC;QACjB,UAAU,EAAE,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;AACL,CAAC"}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Sender key distributions and pairwise message records.
|
|
3
|
+
*
|
|
4
|
+
* A distribution carries the chain key of the sender's group chain. The
|
|
5
|
+
* chain key rests only in the sender key store. A MessageRecord keeps the
|
|
6
|
+
* plaintext of a pairwise send so the sender can answer a retry request, so
|
|
7
|
+
* the record of a send keeps the plaintext without its distribution (see
|
|
8
|
+
* `SignalProtocolContentAdapter.withoutSenderKeyDistribution`). A send that
|
|
9
|
+
* carries only a distribution keeps no record.
|
|
10
|
+
*
|
|
11
|
+
* An earlier version kept the whole plaintext. A one-time sweep at client
|
|
12
|
+
* start removes the distribution from each stored record, and the retry
|
|
13
|
+
* handler removes one that it finds at lookup.
|
|
14
|
+
*/
|
|
15
|
+
import type { Logger } from '../logger.js';
|
|
16
|
+
import type { SignalProtocolLocalStore } from '../types/api.js';
|
|
17
|
+
import type { SignalProtocolContentAdapter } from './content-adapter.js';
|
|
18
|
+
/** The metadata key that records a completed sweep. */
|
|
19
|
+
export declare const DISTRIBUTION_RECORDS_SWEPT_MARKER = "migration:skdm-records-removed";
|
|
20
|
+
type DistributionRecordStore = Pick<SignalProtocolLocalStore, 'getMetadata' | 'setMetadata' | 'rewriteMessageRecords'>;
|
|
21
|
+
/**
|
|
22
|
+
* Remove the sender key distribution from every stored message record, once
|
|
23
|
+
* per store. A record that holds only a distribution is deleted, and the
|
|
24
|
+
* other content of a record is kept. The marker is written only after the
|
|
25
|
+
* sweep succeeds, so a failed sweep runs again at the next start.
|
|
26
|
+
*/
|
|
27
|
+
export declare function removeDistributionsFromMessageRecords(storage: DistributionRecordStore, adapter: SignalProtocolContentAdapter, logger: Required<Logger>): Promise<void>;
|
|
28
|
+
export {};
|
|
29
|
+
//# sourceMappingURL=distribution-records.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"distribution-records.d.ts","sourceRoot":"","sources":["../../client/distribution-records.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAC7D,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,mBAAmB,CAAC;AAEtE,uDAAuD;AACvD,eAAO,MAAM,iCAAiC,mCAAmC,CAAC;AAElF,KAAK,uBAAuB,GAAG,IAAI,CACjC,wBAAwB,EACxB,aAAa,GAAG,aAAa,GAAG,uBAAuB,CACxD,CAAC;AAEF;;;;;GAKG;AACH,wBAAsB,qCAAqC,CACzD,OAAO,EAAE,uBAAuB,EAChC,OAAO,EAAE,4BAA4B,EACrC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,GACvB,OAAO,CAAC,IAAI,CAAC,CAUf"}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Sender key distributions and pairwise message records.
|
|
3
|
+
*
|
|
4
|
+
* A distribution carries the chain key of the sender's group chain. The
|
|
5
|
+
* chain key rests only in the sender key store. A MessageRecord keeps the
|
|
6
|
+
* plaintext of a pairwise send so the sender can answer a retry request, so
|
|
7
|
+
* the record of a send keeps the plaintext without its distribution (see
|
|
8
|
+
* `SignalProtocolContentAdapter.withoutSenderKeyDistribution`). A send that
|
|
9
|
+
* carries only a distribution keeps no record.
|
|
10
|
+
*
|
|
11
|
+
* An earlier version kept the whole plaintext. A one-time sweep at client
|
|
12
|
+
* start removes the distribution from each stored record, and the retry
|
|
13
|
+
* handler removes one that it finds at lookup.
|
|
14
|
+
*/
|
|
15
|
+
/** The metadata key that records a completed sweep. */
|
|
16
|
+
export const DISTRIBUTION_RECORDS_SWEPT_MARKER = 'migration:skdm-records-removed';
|
|
17
|
+
/**
|
|
18
|
+
* Remove the sender key distribution from every stored message record, once
|
|
19
|
+
* per store. A record that holds only a distribution is deleted, and the
|
|
20
|
+
* other content of a record is kept. The marker is written only after the
|
|
21
|
+
* sweep succeeds, so a failed sweep runs again at the next start.
|
|
22
|
+
*/
|
|
23
|
+
export async function removeDistributionsFromMessageRecords(storage, adapter, logger) {
|
|
24
|
+
if ((await storage.getMetadata(DISTRIBUTION_RECORDS_SWEPT_MARKER)) !== null)
|
|
25
|
+
return;
|
|
26
|
+
const changed = await storage.rewriteMessageRecords((record) => adapter.withoutSenderKeyDistribution(record.plaintext));
|
|
27
|
+
await storage.setMetadata(DISTRIBUTION_RECORDS_SWEPT_MARKER, String(Date.now()));
|
|
28
|
+
logger.info('Removed sender key distributions from message records', {
|
|
29
|
+
category: 'E2EE',
|
|
30
|
+
data: { changed },
|
|
31
|
+
});
|
|
32
|
+
}
|
|
33
|
+
//# sourceMappingURL=distribution-records.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"distribution-records.js","sourceRoot":"","sources":["../../client/distribution-records.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAMH,uDAAuD;AACvD,MAAM,CAAC,MAAM,iCAAiC,GAAG,gCAAgC,CAAC;AAOlF;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,qCAAqC,CACzD,OAAgC,EAChC,OAAqC,EACrC,MAAwB;IAExB,IAAI,CAAC,MAAM,OAAO,CAAC,WAAW,CAAC,iCAAiC,CAAC,CAAC,KAAK,IAAI;QAAE,OAAO;IACpF,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,qBAAqB,CAAC,CAAC,MAAM,EAAE,EAAE,CAC7D,OAAO,CAAC,4BAA4B,CAAC,MAAM,CAAC,SAAS,CAAC,CACvD,CAAC;IACF,MAAM,OAAO,CAAC,WAAW,CAAC,iCAAiC,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IACjF,MAAM,CAAC,IAAI,CAAC,uDAAuD,EAAE;QACnE,QAAQ,EAAE,MAAM;QAChB,IAAI,EAAE,EAAE,OAAO,EAAE;KAClB,CAAC,CAAC;AACL,CAAC"}
|