@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
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { hostedAssertionIdentifier } from "./hosted-assertion-id.js";
|
|
1
2
|
import { utf8Decode, websocketUrl } from "../internal/platform/index.js";
|
|
2
3
|
import AsyncLock from "async-lock";
|
|
3
4
|
import { createCompositeIdentityV1, decodeCompositeIdentityV1, encodeCompositeIdentityV1, } from "../keys/identity.js";
|
|
@@ -8,11 +9,13 @@ import { presenceHttpBody, } from "./hosted-presence-frames.js";
|
|
|
8
9
|
import { subscribeHostedMailbox, } from "./hosted-mailbox-subscription.js";
|
|
9
10
|
import { HostedGroupServer } from "./hosted-groups.js";
|
|
10
11
|
import { relayProtocolHeaders, throwIfUpgradeRequired } from "./relay-protocol.js";
|
|
11
|
-
import {
|
|
12
|
+
import { HostedRelayDeviceUnknownError, throwIfDeviceRevoked, } from "./hosted-device-standing.js";
|
|
13
|
+
import { HostedAnonymousDelivery, HostedAnonymousDeliveryError, decodeHostedAnonymousEnvelope, } from "./hosted-anonymous-delivery.js";
|
|
12
14
|
import { createAdapterRelayFanOut } from "./relay-work.js";
|
|
13
15
|
import { withRelayRequestDeadline } from "./relay-request-deadline.js";
|
|
14
16
|
import { applyPreKeyUploads, parseHostedPreKeyStatus, parseStoredPendingPublication, parseStoredPublication, publicationMatchesStatus, registrationPreKey, statusPreKeys, storedPreKey, storedPublication, } from "./hosted-prekey-publication.js";
|
|
15
17
|
import { declareRefusesRemovedDevices, markRelayDeviceRefusal, } from "./relay-device-refusal.js";
|
|
18
|
+
import { declareComparesDeviceSets, deviceSetRefusal, markDeviceSetRefusal, parseDeviceSetRefusal, } from "../remote/relay/device-set.js";
|
|
16
19
|
import { RelayReceiptInbox, declareRelayReceiptIntake, decodeRelayDeliveryReceipts, } from "./relay-receipt-intake.js";
|
|
17
20
|
import { RelayReceiptJoin, declareRelayReceiptJoin, } from "./relay-receipt-join.js";
|
|
18
21
|
const SESSION_METADATA_PREFIX = "hostedRelay.session.v1:";
|
|
@@ -61,6 +64,26 @@ export class HostedRelayHttpError extends Error {
|
|
|
61
64
|
this.retryable = options?.retryable ?? false;
|
|
62
65
|
}
|
|
63
66
|
}
|
|
67
|
+
/**
|
|
68
|
+
* The Relay refusal codes that end a subscription when the Relay marks them
|
|
69
|
+
* not retryable: a deleted account or device, a missing resource, and an
|
|
70
|
+
* expired operation. The same request gets the same refusal again.
|
|
71
|
+
*/
|
|
72
|
+
const CONCLUSIVE_REFUSAL_CODES = new Set([
|
|
73
|
+
"AUTHORITY_DENIED",
|
|
74
|
+
"NOT_FOUND",
|
|
75
|
+
"OPERATION_EXPIRED",
|
|
76
|
+
]);
|
|
77
|
+
/**
|
|
78
|
+
* Returns true for a Relay refusal that a retry gets again. A refusal that the
|
|
79
|
+
* Relay marks `retryable`, for example a missing binding during a Relay
|
|
80
|
+
* outage, is not conclusive.
|
|
81
|
+
*/
|
|
82
|
+
function isConclusiveRefusal(error) {
|
|
83
|
+
return (error instanceof HostedRelayHttpError &&
|
|
84
|
+
!error.retryable &&
|
|
85
|
+
CONCLUSIVE_REFUSAL_CODES.has(error.code));
|
|
86
|
+
}
|
|
64
87
|
/**
|
|
65
88
|
* A durable delivery whose mailbox reset inside its acknowledgment hold
|
|
66
89
|
* answers 503 `DELIVERY_UNCERTAIN`. The operation identifier makes a repeat
|
|
@@ -157,19 +180,23 @@ async function parseResponse(response) {
|
|
|
157
180
|
throw new Error("Signal Protocol Relay returned invalid JSON");
|
|
158
181
|
}
|
|
159
182
|
if (!response.ok) {
|
|
160
|
-
// `UPGRADE_REQUIRED`
|
|
161
|
-
// `authenticatedPost` and every other retry, which matches only
|
|
162
|
-
// `HostedRelayHttpError`, never repeat
|
|
163
|
-
// `HostedRelayHttpError` whose `retryable` is true: the Relay
|
|
164
|
-
// a version above the newest one that it serves, which
|
|
165
|
-
// a Relay rollback.
|
|
183
|
+
// `UPGRADE_REQUIRED` and `DEVICE_REVOKED` are terminal at any error
|
|
184
|
+
// status, so `authenticatedPost` and every other retry, which matches only
|
|
185
|
+
// a `HostedRelayHttpError`, never repeat them. `PROTOCOL_UNSUPPORTED`
|
|
186
|
+
// stays a `HostedRelayHttpError` whose `retryable` is true: the Relay
|
|
187
|
+
// sends it for a version above the newest one that it serves, which
|
|
188
|
+
// happens only after a Relay rollback.
|
|
166
189
|
throwIfUpgradeRequired(response.status, parsed);
|
|
190
|
+
throwIfDeviceRevoked(response.status, parsed);
|
|
167
191
|
const error = record(parsed) && record(parsed.error) ? parsed.error : {};
|
|
168
192
|
const code = typeof error.code === "string" ? error.code : "UNKNOWN";
|
|
169
193
|
const message = typeof error.message === "string"
|
|
170
194
|
? error.message
|
|
171
195
|
: "Signal Protocol Relay request failed";
|
|
196
|
+
// A refused declared post names the devices of each account in
|
|
197
|
+
// `details`. The error keeps them for the device-set reconciliation.
|
|
172
198
|
throw new HostedRelayHttpError(response.status, code, message, {
|
|
199
|
+
...(record(error.details) ? { data: { details: error.details } } : {}),
|
|
173
200
|
retryable: error.retryable === true,
|
|
174
201
|
});
|
|
175
202
|
}
|
|
@@ -208,23 +235,6 @@ async function postJson(connection, path, body, token) {
|
|
|
208
235
|
return parseResponse(response);
|
|
209
236
|
});
|
|
210
237
|
}
|
|
211
|
-
function assertionIdentifier(assertion) {
|
|
212
|
-
const parts = assertion.split(".");
|
|
213
|
-
if (parts.length !== 3) {
|
|
214
|
-
throw new Error("Identity provider returned an invalid assertion");
|
|
215
|
-
}
|
|
216
|
-
let claims;
|
|
217
|
-
try {
|
|
218
|
-
claims = JSON.parse(utf8Decode(decodeBase64Url(parts[1], "Assertion claims")));
|
|
219
|
-
}
|
|
220
|
-
catch {
|
|
221
|
-
throw new Error("Identity provider returned an invalid assertion");
|
|
222
|
-
}
|
|
223
|
-
if (!record(claims) || typeof claims.jti !== "string" || !claims.jti) {
|
|
224
|
-
throw new Error("Identity provider returned an invalid assertion");
|
|
225
|
-
}
|
|
226
|
-
return claims.jti;
|
|
227
|
-
}
|
|
228
238
|
function serializedPreKey(prekey) {
|
|
229
239
|
return {
|
|
230
240
|
algorithm: prekey.algorithm,
|
|
@@ -265,7 +275,7 @@ async function registrationMaterialFingerprint(identity, registrationId, prekeys
|
|
|
265
275
|
async function registrationChallenge(request) {
|
|
266
276
|
return sha256(concatBytes(request.assertionPurpose === "recover"
|
|
267
277
|
? RECOVERY_CHALLENGE_LABEL
|
|
268
|
-
: REGISTRATION_CHALLENGE_LABEL, text(relayScopeId(request.connection)), text(
|
|
278
|
+
: REGISTRATION_CHALLENGE_LABEL, text(relayScopeId(request.connection)), text(await hostedAssertionIdentifier(request.assertion, request.assertionPurpose, request.operationId)), text(request.operationId), text(await registrationMaterialFingerprint(request.signalIdentity, request.registrationId, request.registrationPreKeys))));
|
|
269
279
|
}
|
|
270
280
|
async function sessionMetadataKey(connection) {
|
|
271
281
|
return `${SESSION_METADATA_PREFIX}${bytesToUrlSafeBase64(await sha256(concatBytes(stringToBytes(connection.publishableKey), new Uint8Array([0]), connection.relayScopeId)))}`;
|
|
@@ -418,6 +428,10 @@ export class HostedRelayHttpTransport {
|
|
|
418
428
|
// The Relay refuses a removed device's mailbox on every send path before
|
|
419
429
|
// its device list shows the removal, so a direct send may post first.
|
|
420
430
|
declareRefusesRemovedDevices(this);
|
|
431
|
+
// The Relay compares a declared device set on every send route, and
|
|
432
|
+
// answers a difference with DEVICE_SET_MISMATCH or a declared
|
|
433
|
+
// STALE_DEVICE.
|
|
434
|
+
declareComparesDeviceSets(this);
|
|
421
435
|
// The Relay sends Relay delivery receipts to the sender, and replies to
|
|
422
436
|
// each acknowledgment with the messages whose receipt it owns.
|
|
423
437
|
declareRelayReceiptIntake(this, this.receiptInbox);
|
|
@@ -430,11 +444,15 @@ export class HostedRelayHttpTransport {
|
|
|
430
444
|
setUnidentifiedAccessKey: (userId, accessKey) => this.setUnidentifiedAccessKey(userId, accessKey),
|
|
431
445
|
};
|
|
432
446
|
this.fanOut = createAdapterRelayFanOut(this);
|
|
433
|
-
this.anonymousDelivery = new HostedAnonymousDelivery(connection, this.fanOut, async (accountAddress, deviceId) => {
|
|
447
|
+
this.anonymousDelivery = new HostedAnonymousDelivery(connection, this.fanOut, async (accountAddress, deviceId, declaredDeviceIds) => {
|
|
434
448
|
const key = `${accountAddress}\0${deviceId}`;
|
|
435
449
|
if (!this.destinationGenerations.has(key))
|
|
436
450
|
await this.lookUpDestinations(accountAddress);
|
|
437
451
|
const generation = this.destinationGenerations.get(key);
|
|
452
|
+
// A declared post gets the refusal that the Relay would give, so
|
|
453
|
+
// the send removes the device and posts again.
|
|
454
|
+
if (generation === undefined && declaredDeviceIds !== undefined)
|
|
455
|
+
throw markDeviceSetRefusal(new HostedAnonymousDeliveryError(409, "DEVICE_SET_MISMATCH"), this.directoryDeviceSetRefusal(accountAddress, declaredDeviceIds));
|
|
438
456
|
if (generation === undefined)
|
|
439
457
|
throw missingDestination(accountAddress, deviceId);
|
|
440
458
|
return { accountAddress, deviceId, generation };
|
|
@@ -545,14 +563,27 @@ export class HostedRelayHttpTransport {
|
|
|
545
563
|
const nonce = await generateRandomBytes(32);
|
|
546
564
|
const challenge = await sha256(concatBytes(TOKEN_REFRESH_CHALLENGE_LABEL, text(this.session.relayScopeId), text(this.session.canonicalAccountId), uint32be(this.session.deviceId), uint32be(this.session.generation), uint32be(this.session.mailboxGeneration), text(String(requestedAtSeconds)), lengthPrefixed(nonce)));
|
|
547
565
|
const proof = await this.deviceAuthentication.signChallenge(challenge);
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
566
|
+
let value;
|
|
567
|
+
try {
|
|
568
|
+
value = await postJson(this.connection, "/identity/token", {
|
|
569
|
+
accountAddress: this.session.canonicalAccountId,
|
|
570
|
+
// The Relay checks this key against the keys that a recovery revoked.
|
|
571
|
+
deviceAuthenticationPublicKey: bytesToBase64(this.deviceAuthentication.publicKey),
|
|
572
|
+
deviceId: this.session.deviceId,
|
|
573
|
+
deviceProof: bytesToBase64(proof),
|
|
574
|
+
nonce: bytesToUrlSafeBase64(nonce),
|
|
575
|
+
publishableKey: this.connection.publishableKey,
|
|
576
|
+
requestedAtSeconds,
|
|
577
|
+
});
|
|
578
|
+
}
|
|
579
|
+
catch (error) {
|
|
580
|
+
// A token refusal names this device, so it is not a
|
|
581
|
+
// `HostedRelayHttpError`. A catch that reads `NOT_FOUND` as a missing
|
|
582
|
+
// destination cannot take it.
|
|
583
|
+
if (error instanceof HostedRelayHttpError && error.code === "NOT_FOUND")
|
|
584
|
+
throw new HostedRelayDeviceUnknownError(error.status, error.message);
|
|
585
|
+
throw error;
|
|
586
|
+
}
|
|
556
587
|
if (!record(value) || typeof value.deviceToken !== "string") {
|
|
557
588
|
throw new Error("Signal Protocol Relay returned an invalid device token");
|
|
558
589
|
}
|
|
@@ -806,17 +837,21 @@ export class HostedRelayHttpTransport {
|
|
|
806
837
|
}
|
|
807
838
|
/**
|
|
808
839
|
* One mailbox page. Its `relayReceipts` holds for this pull only: a page
|
|
809
|
-
* carries `receipts` only when it is true.
|
|
840
|
+
* carries `receipts` only when it is true. With `cursor`, the page starts
|
|
841
|
+
* after the last message of the page that issued it. The cursor is opaque.
|
|
810
842
|
*/
|
|
811
|
-
async pullIncoming() {
|
|
843
|
+
async pullIncoming(cursor) {
|
|
812
844
|
const value = await this.authenticatedPost("/mailbox/pull", {
|
|
813
845
|
publishableKey: this.connection.publishableKey,
|
|
846
|
+
...(cursor === undefined ? {} : { cursor }),
|
|
814
847
|
});
|
|
815
848
|
if (!record(value) ||
|
|
816
849
|
!Array.isArray(value.messages) ||
|
|
817
850
|
(value.relayReceipts !== undefined &&
|
|
818
851
|
typeof value.relayReceipts !== "boolean") ||
|
|
819
|
-
(value.receipts !== undefined && value.relayReceipts !== true)
|
|
852
|
+
(value.receipts !== undefined && value.relayReceipts !== true) ||
|
|
853
|
+
(value.nextCursor !== undefined &&
|
|
854
|
+
(typeof value.nextCursor !== "string" || value.nextCursor === ""))) {
|
|
820
855
|
throw new Error("Signal Protocol Relay returned an invalid mailbox page");
|
|
821
856
|
}
|
|
822
857
|
return {
|
|
@@ -824,6 +859,9 @@ export class HostedRelayHttpTransport {
|
|
|
824
859
|
receipts: value.receipts === undefined
|
|
825
860
|
? []
|
|
826
861
|
: decodeRelayDeliveryReceipts(value.receipts),
|
|
862
|
+
...(value.nextCursor === undefined
|
|
863
|
+
? {}
|
|
864
|
+
: { nextCursor: value.nextCursor }),
|
|
827
865
|
};
|
|
828
866
|
}
|
|
829
867
|
/** One retained mailbox message, from a pull page or a `durable-message` frame. */
|
|
@@ -909,8 +947,59 @@ export class HostedRelayHttpTransport {
|
|
|
909
947
|
if (value !== undefined)
|
|
910
948
|
throw new Error("Signal Protocol Relay access-key receipt is invalid");
|
|
911
949
|
}
|
|
912
|
-
async sendMultiRecipientUnidentified(sentMessageBase64, auth, timestamp, deliveryClass, recipientUserIds, clientMessageId, operationEpochMilliseconds, contentKind) {
|
|
913
|
-
|
|
950
|
+
async sendMultiRecipientUnidentified(sentMessageBase64, auth, timestamp, deliveryClass, recipientUserIds, clientMessageId, operationEpochMilliseconds, contentKind, deviceSets) {
|
|
951
|
+
try {
|
|
952
|
+
return await this.anonymousDelivery.send(sentMessageBase64, auth, timestamp, deliveryClass, recipientUserIds, clientMessageId, operationEpochMilliseconds, contentKind, deviceSets);
|
|
953
|
+
}
|
|
954
|
+
catch (error) {
|
|
955
|
+
// A refused declared post can name a re-registered device, so the
|
|
956
|
+
// next post reads each named account's mailbox generations again.
|
|
957
|
+
const refusal = deviceSetRefusal(error);
|
|
958
|
+
if (refusal !== undefined)
|
|
959
|
+
this.forgetDestinationGenerations(refusal.accounts);
|
|
960
|
+
throw error;
|
|
961
|
+
}
|
|
962
|
+
}
|
|
963
|
+
/** Drops the cached mailbox generations of each named account. */
|
|
964
|
+
forgetDestinationGenerations(accounts) {
|
|
965
|
+
for (const { userId } of accounts) {
|
|
966
|
+
for (const key of this.destinationGenerations.keys()) {
|
|
967
|
+
if (key.startsWith(`${userId}\0`))
|
|
968
|
+
this.destinationGenerations.delete(key);
|
|
969
|
+
}
|
|
970
|
+
}
|
|
971
|
+
}
|
|
972
|
+
/**
|
|
973
|
+
* The refusal that the Relay would give a declared post whose device the
|
|
974
|
+
* directory does not list: the declared set differs from the directory.
|
|
975
|
+
* The directory read just before it filled the cache for the account.
|
|
976
|
+
*/
|
|
977
|
+
directoryDeviceSetRefusal(userId, declaredDeviceIds) {
|
|
978
|
+
const listed = new Set();
|
|
979
|
+
for (const key of this.destinationGenerations.keys()) {
|
|
980
|
+
if (!key.startsWith(`${userId}\0`))
|
|
981
|
+
continue;
|
|
982
|
+
const deviceId = Number(key.slice(userId.length + 1));
|
|
983
|
+
if (userId === this.session.canonicalAccountId &&
|
|
984
|
+
deviceId === this.session.deviceId)
|
|
985
|
+
continue;
|
|
986
|
+
listed.add(deviceId);
|
|
987
|
+
}
|
|
988
|
+
const declared = new Set(declaredDeviceIds);
|
|
989
|
+
return {
|
|
990
|
+
kind: "mismatch",
|
|
991
|
+
accounts: [
|
|
992
|
+
{
|
|
993
|
+
userId,
|
|
994
|
+
missingDeviceIds: [...listed]
|
|
995
|
+
.filter((id) => !declared.has(id))
|
|
996
|
+
.sort((a, b) => a - b),
|
|
997
|
+
extraDeviceIds: [...declared]
|
|
998
|
+
.filter((id) => !listed.has(id))
|
|
999
|
+
.sort((a, b) => a - b),
|
|
1000
|
+
},
|
|
1001
|
+
],
|
|
1002
|
+
};
|
|
914
1003
|
}
|
|
915
1004
|
/**
|
|
916
1005
|
* Acknowledges messages and Relay receipts over HTTP. The response lists,
|
|
@@ -990,8 +1079,8 @@ export class HostedRelayHttpTransport {
|
|
|
990
1079
|
postPresence(request) {
|
|
991
1080
|
return this.authenticatedPost("/presence", presenceHttpBody(this.connection.publishableKey, request));
|
|
992
1081
|
}
|
|
993
|
-
async pullMailbox() {
|
|
994
|
-
return this.pullIncoming();
|
|
1082
|
+
async pullMailbox(cursor) {
|
|
1083
|
+
return this.pullIncoming(cursor);
|
|
995
1084
|
}
|
|
996
1085
|
/**
|
|
997
1086
|
* Acknowledges one pull page. The Relay takes at most 100 ids in each list,
|
|
@@ -1062,8 +1151,19 @@ export class HostedRelayHttpTransport {
|
|
|
1062
1151
|
await this.directory(envelope.targetUserId);
|
|
1063
1152
|
generation = this.destinationGenerations.get(key);
|
|
1064
1153
|
}
|
|
1154
|
+
if (generation === undefined && envelope.declaredDeviceIds !== undefined) {
|
|
1155
|
+
throw markDeviceSetRefusal(new HostedRelayHttpError(409, "DEVICE_SET_MISMATCH", "The declared device set differs from the device directory"), this.directoryDeviceSetRefusal(envelope.targetUserId, envelope.declaredDeviceIds));
|
|
1156
|
+
}
|
|
1065
1157
|
if (generation === undefined)
|
|
1066
1158
|
throw missingDestination(envelope.targetUserId, envelope.targetDeviceId);
|
|
1159
|
+
const deviceSets = envelope.declaredDeviceIds === undefined
|
|
1160
|
+
? undefined
|
|
1161
|
+
: [
|
|
1162
|
+
{
|
|
1163
|
+
accountAddress: envelope.targetUserId,
|
|
1164
|
+
deviceIds: [...envelope.declaredDeviceIds],
|
|
1165
|
+
},
|
|
1166
|
+
];
|
|
1067
1167
|
let value;
|
|
1068
1168
|
let attempts = 0;
|
|
1069
1169
|
try {
|
|
@@ -1084,6 +1184,7 @@ export class HostedRelayHttpTransport {
|
|
|
1084
1184
|
...(envelope.recipientRegistrationId === undefined
|
|
1085
1185
|
? {}
|
|
1086
1186
|
: { recipientRegistrationId: envelope.recipientRegistrationId }),
|
|
1187
|
+
...(deviceSets === undefined ? {} : { deviceSets }),
|
|
1087
1188
|
});
|
|
1088
1189
|
});
|
|
1089
1190
|
}
|
|
@@ -1092,6 +1193,13 @@ export class HostedRelayHttpTransport {
|
|
|
1092
1193
|
userId: envelope.targetUserId,
|
|
1093
1194
|
deviceId: envelope.targetDeviceId,
|
|
1094
1195
|
};
|
|
1196
|
+
if (deviceSets !== undefined && error instanceof HostedRelayHttpError) {
|
|
1197
|
+
const refusal = parseDeviceSetRefusal(error.code, error.data?.details);
|
|
1198
|
+
if (refusal !== undefined) {
|
|
1199
|
+
this.forgetDestinationGenerations(refusal.accounts);
|
|
1200
|
+
throw markDeviceSetRefusal(error, refusal);
|
|
1201
|
+
}
|
|
1202
|
+
}
|
|
1095
1203
|
if (error instanceof HostedRelayHttpError &&
|
|
1096
1204
|
error.code === "STALE_DEVICE") {
|
|
1097
1205
|
throw markRelayDeviceRefusal(new HostedRelayHttpError(error.status, error.code, error.message, {
|
|
@@ -1115,7 +1223,10 @@ export class HostedRelayHttpTransport {
|
|
|
1115
1223
|
(value.duplicate !== undefined && typeof value.duplicate !== "boolean") ||
|
|
1116
1224
|
(value.expiresAt !== undefined &&
|
|
1117
1225
|
(!Number.isSafeInteger(value.expiresAt) ||
|
|
1118
|
-
value.expiresAt <= 0))
|
|
1226
|
+
value.expiresAt <= 0)) ||
|
|
1227
|
+
(value.deviceSetChecked !== undefined &&
|
|
1228
|
+
value.deviceSetChecked !== true) ||
|
|
1229
|
+
(value.needsSync !== undefined && typeof value.needsSync !== "boolean")) {
|
|
1119
1230
|
throw new Error("Signal Protocol Relay returned an invalid delivery receipt");
|
|
1120
1231
|
}
|
|
1121
1232
|
// An ephemeral receipt carries neither field, so each one is optional.
|
|
@@ -1132,6 +1243,10 @@ export class HostedRelayHttpTransport {
|
|
|
1132
1243
|
...(typeof value.expiresAt === "number"
|
|
1133
1244
|
? { expiresAt: value.expiresAt }
|
|
1134
1245
|
: {}),
|
|
1246
|
+
...(value.deviceSetChecked === true ? { deviceSetChecked: true } : {}),
|
|
1247
|
+
...(typeof value.needsSync === "boolean"
|
|
1248
|
+
? { needsSync: value.needsSync }
|
|
1249
|
+
: {}),
|
|
1135
1250
|
};
|
|
1136
1251
|
}
|
|
1137
1252
|
subscribe(userId, deviceId, onEnvelope, options) {
|
|
@@ -1160,6 +1275,7 @@ export class HostedRelayHttpTransport {
|
|
|
1160
1275
|
}
|
|
1161
1276
|
},
|
|
1162
1277
|
authenticate: async () => {
|
|
1278
|
+
const previous = this.session.deviceToken;
|
|
1163
1279
|
const token = await this.token();
|
|
1164
1280
|
const url = websocketUrl(`${identifiedEndpoint(this.connection)}/mailbox/connect`, [["publishableKey", this.connection.publishableKey]]);
|
|
1165
1281
|
return {
|
|
@@ -1168,12 +1284,18 @@ export class HostedRelayHttpTransport {
|
|
|
1168
1284
|
renewAt: (tokenExpiration(token, this.session) -
|
|
1169
1285
|
DEVICE_TOKEN_REFRESH_SECONDS) *
|
|
1170
1286
|
1_000,
|
|
1287
|
+
refreshed: token !== previous,
|
|
1171
1288
|
};
|
|
1172
1289
|
},
|
|
1290
|
+
isConclusiveRefusal,
|
|
1173
1291
|
decodeDurable: (message) => this.incomingEnvelope(message),
|
|
1174
|
-
pull: async () => {
|
|
1175
|
-
const { messages, receipts } = await this.pullIncoming();
|
|
1176
|
-
return {
|
|
1292
|
+
pull: async (cursor) => {
|
|
1293
|
+
const { messages, receipts, nextCursor } = await this.pullIncoming(cursor);
|
|
1294
|
+
return {
|
|
1295
|
+
messages: messages,
|
|
1296
|
+
receipts,
|
|
1297
|
+
...(nextCursor === undefined ? {} : { nextCursor }),
|
|
1298
|
+
};
|
|
1177
1299
|
},
|
|
1178
1300
|
acknowledge: (messageIds, receiptIds) => this.acknowledge(messageIds, receiptIds),
|
|
1179
1301
|
receive: onEnvelope,
|
|
@@ -1377,30 +1499,6 @@ export class HostedRelayHttpTransport {
|
|
|
1377
1499
|
async removeDevice(_userId, _deviceId) {
|
|
1378
1500
|
unsupported("direct device removal");
|
|
1379
1501
|
}
|
|
1380
|
-
async createProvisioningSession(_userId, _key) {
|
|
1381
|
-
unsupported("legacy provisioning sessions");
|
|
1382
|
-
}
|
|
1383
|
-
async connectNewDevice(_sessionId, _key, _metadata) {
|
|
1384
|
-
unsupported("legacy provisioning sessions");
|
|
1385
|
-
}
|
|
1386
|
-
async sendProvisioningMessage(_sessionId, _message, _userId) {
|
|
1387
|
-
unsupported("legacy provisioning sessions");
|
|
1388
|
-
}
|
|
1389
|
-
async getProvisioningMessage(_sessionId) {
|
|
1390
|
-
unsupported("legacy provisioning sessions");
|
|
1391
|
-
}
|
|
1392
|
-
async completeProvisioning(_sessionId, _metadata) {
|
|
1393
|
-
unsupported("legacy provisioning sessions");
|
|
1394
|
-
}
|
|
1395
|
-
async acknowledgeProvisioning(_sessionId) {
|
|
1396
|
-
unsupported("legacy provisioning sessions");
|
|
1397
|
-
}
|
|
1398
|
-
async rollbackProvisioning(_sessionId) {
|
|
1399
|
-
unsupported("legacy provisioning sessions");
|
|
1400
|
-
}
|
|
1401
|
-
async deleteProvisioningSession(_sessionId, _userId) {
|
|
1402
|
-
unsupported("legacy provisioning sessions");
|
|
1403
|
-
}
|
|
1404
1502
|
async createGroupState(groupId, state, authorization) {
|
|
1405
1503
|
return this.groups.createGroup(groupId, state, authorization);
|
|
1406
1504
|
}
|