@open-e2ee/signal-protocol-sdk 0.2.3 → 0.4.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 +11 -4
- package/ARCHITECTURE.md +19 -16
- package/CHANGELOG.md +72 -0
- package/COMMERCIAL.md +6 -6
- package/NOTICE +1 -1
- package/README.md +65 -93
- package/SECURITY.md +16 -13
- package/TROUBLESHOOTING.md +12 -5
- package/blocking/README.md +7 -5
- package/client/README.md +15 -5
- package/device/README.md +13 -8
- package/dist/blocking/types.d.ts +2 -2
- package/dist/blocking/types.js +2 -2
- package/dist/client/client.d.ts +46 -45
- package/dist/client/client.d.ts.map +1 -1
- package/dist/client/client.js +61 -60
- package/dist/client/client.js.map +1 -1
- package/dist/client/config.d.ts +32 -32
- package/dist/client/constants.d.ts +7 -6
- package/dist/client/constants.d.ts.map +1 -1
- package/dist/client/constants.js +5 -4
- package/dist/client/constants.js.map +1 -1
- package/dist/client/dual-store.d.ts +2 -2
- package/dist/client/dual-store.js +2 -2
- package/dist/client/endorsement-manager.d.ts +14 -14
- package/dist/client/endorsement-manager.d.ts.map +1 -1
- package/dist/client/endorsement-manager.js +15 -15
- package/dist/client/endorsement-manager.js.map +1 -1
- package/dist/client/event-hooks.d.ts +16 -16
- package/dist/client/event-hooks.d.ts.map +1 -1
- package/dist/client/event-hooks.js +1 -1
- package/dist/client/event-hooks.js.map +1 -1
- package/dist/client/files.js +4 -4
- package/dist/client/files.js.map +1 -1
- package/dist/client/groups.d.ts.map +1 -1
- package/dist/client/groups.js +14 -4
- package/dist/client/groups.js.map +1 -1
- package/dist/client/headless.d.ts +7 -7
- package/dist/client/headless.d.ts.map +1 -1
- package/dist/client/headless.js +4 -4
- package/dist/client/key-rotation-core.d.ts +19 -17
- package/dist/client/key-rotation-core.d.ts.map +1 -1
- package/dist/client/key-rotation-core.js +35 -31
- package/dist/client/key-rotation-core.js.map +1 -1
- package/dist/client/key-rotation.d.ts +8 -8
- package/dist/client/key-rotation.js +8 -8
- package/dist/client/media.d.ts +1 -1
- package/dist/client/messages.d.ts.map +1 -1
- package/dist/client/messages.js +13 -11
- package/dist/client/messages.js.map +1 -1
- package/dist/client/multi-device.d.ts +5 -4
- package/dist/client/multi-device.d.ts.map +1 -1
- package/dist/client/multi-device.js.map +1 -1
- package/dist/client/prekeys.d.ts +7 -7
- package/dist/client/prekeys.js +10 -10
- package/dist/client/prekeys.js.map +1 -1
- package/dist/client/relay-subscription.d.ts +3 -0
- package/dist/client/relay-subscription.d.ts.map +1 -1
- package/dist/client/relay-subscription.js +7 -4
- package/dist/client/relay-subscription.js.map +1 -1
- package/dist/client/retry-utils.d.ts +5 -6
- package/dist/client/retry-utils.d.ts.map +1 -1
- package/dist/client/retry-utils.js +5 -12
- package/dist/client/retry-utils.js.map +1 -1
- package/dist/client/retry.js +7 -7
- package/dist/client/retry.js.map +1 -1
- package/dist/client/sealed-sender-ops.d.ts +3 -3
- package/dist/client/sealed-sender-ops.js +5 -5
- package/dist/client/sealed-sender-ops.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 +9 -9
- package/dist/client/signal-service-cipher.d.ts.map +1 -1
- package/dist/client/signal-service-cipher.js +41 -40
- package/dist/client/signal-service-cipher.js.map +1 -1
- package/dist/client/state.d.ts +1 -1
- package/dist/client/state.js +1 -1
- package/dist/client/types.d.ts +19 -19
- package/dist/client/types.d.ts.map +1 -1
- package/dist/device/connection.d.ts +1 -1
- package/dist/device/connection.js +2 -2
- package/dist/device/connection.js.map +1 -1
- package/dist/device/constants.d.ts +4 -4
- package/dist/device/constants.js +3 -3
- package/dist/device/device-id.d.ts +4 -4
- package/dist/device/device-id.js +4 -4
- package/dist/device/expo-metadata.d.ts +13 -11
- package/dist/device/expo-metadata.d.ts.map +1 -1
- package/dist/device/expo-metadata.js +13 -11
- package/dist/device/expo-metadata.js.map +1 -1
- package/dist/device/lifecycle/manager.d.ts +6 -6
- package/dist/device/lifecycle/manager.js +7 -7
- package/dist/device/lifecycle/types.d.ts +13 -13
- package/dist/device/lifecycle/types.d.ts.map +1 -1
- package/dist/device/lifecycle/utils.d.ts +2 -2
- package/dist/device/lifecycle/utils.js +5 -5
- package/dist/device/lifecycle/utils.js.map +1 -1
- package/dist/device/provisioning.d.ts +5 -4
- package/dist/device/provisioning.d.ts.map +1 -1
- package/dist/device/provisioning.js +5 -4
- package/dist/device/provisioning.js.map +1 -1
- package/dist/device/transfer.d.ts +2 -2
- package/dist/device/transfer.js +3 -3
- package/dist/device/transfer.js.map +1 -1
- package/dist/encoding/index.d.ts +3 -4
- package/dist/encoding/index.d.ts.map +1 -1
- package/dist/encoding/index.js.map +1 -1
- package/dist/files/index.d.ts +1 -1
- package/dist/files/index.js +1 -1
- package/dist/hooks/use-connection-presence.d.ts +1 -1
- package/dist/hooks/use-connection-presence.js +7 -7
- package/dist/hooks/use-connection-presence.js.map +1 -1
- package/dist/hooks/use-group-membership.d.ts +2 -2
- package/dist/hooks/use-group-membership.d.ts.map +1 -1
- package/dist/hooks/use-group-membership.js +6 -6
- package/dist/hooks/use-group-membership.js.map +1 -1
- package/dist/hooks/use-key-rotation.js +3 -3
- package/dist/hooks/use-key-rotation.js.map +1 -1
- package/dist/hooks/use-single-flight.d.ts +2 -2
- package/dist/hooks/use-single-flight.js +1 -1
- package/dist/index.d.ts +4 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +21 -4
- package/dist/index.js.map +1 -1
- package/dist/internal/crypto/ec/ed25519.d.ts +6 -6
- package/dist/internal/crypto/ec/ed25519.js +6 -6
- package/dist/internal/crypto/ec/x25519-validation.d.ts.map +1 -1
- package/dist/internal/crypto/ec/x25519-validation.js +4 -2
- package/dist/internal/crypto/ec/x25519-validation.js.map +1 -1
- package/dist/internal/crypto/index.d.ts +2 -0
- package/dist/internal/crypto/index.d.ts.map +1 -1
- package/dist/internal/crypto/index.js +2 -0
- package/dist/internal/crypto/index.js.map +1 -1
- package/dist/internal/crypto/kdf/hkdf.d.ts +9 -8
- package/dist/internal/crypto/kdf/hkdf.d.ts.map +1 -1
- package/dist/internal/crypto/kdf/hkdf.js +11 -10
- package/dist/internal/crypto/kdf/hkdf.js.map +1 -1
- package/dist/internal/crypto/key-prefix.d.ts +3 -3
- package/dist/internal/crypto/key-prefix.js +3 -3
- package/dist/internal/crypto/pq/kyber.d.ts +7 -7
- package/dist/internal/crypto/pq/kyber.js +10 -10
- package/dist/internal/crypto/pq/kyber.js.map +1 -1
- package/dist/internal/crypto/random.d.ts +1 -1
- package/dist/internal/crypto/random.js +1 -1
- package/dist/internal/crypto/symmetric/aes-gcm-siv.js +1 -1
- package/dist/internal/crypto/symmetric/aes.js +4 -4
- package/dist/internal/crypto/symmetric/aes.js.map +1 -1
- package/dist/internal/crypto/symmetric/mac.d.ts +1 -1
- package/dist/internal/crypto/symmetric/mac.js +3 -3
- package/dist/internal/crypto/symmetric/padding.js +1 -1
- package/dist/internal/crypto/symmetric/padding.js.map +1 -1
- package/dist/internal/crypto/symmetric/streaming-aead.d.ts +7 -1
- package/dist/internal/crypto/symmetric/streaming-aead.d.ts.map +1 -1
- package/dist/internal/crypto/symmetric/streaming-aead.js +10 -4
- package/dist/internal/crypto/symmetric/streaming-aead.js.map +1 -1
- package/dist/internal/crypto/utils.d.ts +2 -2
- package/dist/internal/crypto/utils.d.ts.map +1 -1
- package/dist/internal/crypto/utils.js +16 -14
- package/dist/internal/crypto/utils.js.map +1 -1
- package/dist/internal/crypto/validation.d.ts +4 -4
- package/dist/internal/crypto/validation.js +2 -2
- package/dist/internal/encoding/proto/envelope.d.ts +1 -1
- package/dist/internal/encoding/proto/envelope.js +1 -1
- package/dist/internal/encoding/proto/index.d.ts +4 -4
- package/dist/internal/encoding/proto/index.js +4 -4
- package/dist/internal/encoding/proto/pq-ratchet-serialize.d.ts +28 -16
- package/dist/internal/encoding/proto/pq-ratchet-serialize.d.ts.map +1 -1
- package/dist/internal/encoding/proto/pq-ratchet-serialize.js +30 -18
- package/dist/internal/encoding/proto/pq-ratchet-serialize.js.map +1 -1
- package/dist/internal/encoding/proto/primitives.d.ts +45 -35
- package/dist/internal/encoding/proto/primitives.d.ts.map +1 -1
- package/dist/internal/encoding/proto/primitives.js +54 -43
- package/dist/internal/encoding/proto/primitives.js.map +1 -1
- package/dist/internal/encoding/proto/sender-key-message.d.ts +2 -2
- package/dist/internal/encoding/proto/sender-key-message.js +2 -2
- package/dist/internal/encoding/proto/signal-message.d.ts +13 -13
- package/dist/internal/encoding/proto/signal-message.d.ts.map +1 -1
- package/dist/internal/encoding/proto/signal-message.js +13 -13
- package/dist/internal/encoding/proto/signal-message.js.map +1 -1
- package/dist/internal/groups/access-control.d.ts +5 -5
- package/dist/internal/groups/access-control.js +6 -6
- package/dist/internal/groups/access-control.js.map +1 -1
- package/dist/internal/groups/change-actions.d.ts +4 -4
- package/dist/internal/groups/change-actions.js +3 -3
- package/dist/internal/groups/encrypted-state.js +1 -1
- package/dist/internal/groups/encrypted-state.js.map +1 -1
- package/dist/internal/groups/group-id.d.ts +1 -1
- package/dist/internal/groups/manager.d.ts +24 -23
- package/dist/internal/groups/manager.d.ts.map +1 -1
- package/dist/internal/groups/manager.js +40 -36
- package/dist/internal/groups/manager.js.map +1 -1
- package/dist/internal/groups/server-engine.d.ts +29 -21
- package/dist/internal/groups/server-engine.d.ts.map +1 -1
- package/dist/internal/groups/server-engine.js +55 -50
- package/dist/internal/groups/server-engine.js.map +1 -1
- package/dist/internal/groups/trust-root.d.ts +2 -2
- package/dist/internal/groups/trust-root.js +2 -2
- package/dist/internal/groups/types.d.ts +4 -4
- package/dist/internal/groups/types.d.ts.map +1 -1
- package/dist/internal/groups/wire.d.ts +6 -7
- package/dist/internal/groups/wire.d.ts.map +1 -1
- package/dist/internal/groups/wire.js +6 -7
- package/dist/internal/groups/wire.js.map +1 -1
- package/dist/internal/manager/manager.d.ts +14 -12
- package/dist/internal/manager/manager.d.ts.map +1 -1
- package/dist/internal/manager/manager.js +47 -41
- package/dist/internal/manager/manager.js.map +1 -1
- package/dist/internal/protocol/double-ratchet/chains.d.ts +8 -6
- package/dist/internal/protocol/double-ratchet/chains.d.ts.map +1 -1
- package/dist/internal/protocol/double-ratchet/chains.js +10 -8
- package/dist/internal/protocol/double-ratchet/chains.js.map +1 -1
- package/dist/internal/protocol/double-ratchet/index.d.ts +2 -2
- package/dist/internal/protocol/double-ratchet/index.js +2 -2
- package/dist/internal/protocol/double-ratchet/ratchet.d.ts +4 -4
- package/dist/internal/protocol/double-ratchet/ratchet.js +6 -6
- package/dist/internal/protocol/pqxdh/pqxdh.d.ts +21 -18
- package/dist/internal/protocol/pqxdh/pqxdh.d.ts.map +1 -1
- package/dist/internal/protocol/pqxdh/pqxdh.js +48 -42
- package/dist/internal/protocol/pqxdh/pqxdh.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/decryption-v2.js +5 -5
- package/dist/internal/protocol/sealed-sender/decryption-v2.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/decryption.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/decryption.js +11 -8
- package/dist/internal/protocol/sealed-sender/decryption.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/delivery-token.d.ts +2 -2
- package/dist/internal/protocol/sealed-sender/delivery-token.js +2 -2
- package/dist/internal/protocol/sealed-sender/encryption-v2.js +1 -1
- package/dist/internal/protocol/sealed-sender/encryption-v2.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/encryption.d.ts +2 -2
- package/dist/internal/protocol/sealed-sender/encryption.js +2 -2
- package/dist/internal/protocol/sealed-sender/proto/index.d.ts +25 -23
- package/dist/internal/protocol/sealed-sender/proto/index.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/proto/index.js +32 -30
- package/dist/internal/protocol/sealed-sender/proto/index.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/trust-root.d.ts +10 -9
- package/dist/internal/protocol/sealed-sender/trust-root.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/trust-root.js +10 -9
- package/dist/internal/protocol/sealed-sender/trust-root.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/types.d.ts +13 -14
- package/dist/internal/protocol/sealed-sender/types.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/types.js +7 -8
- package/dist/internal/protocol/sealed-sender/types.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/v2-binary.d.ts +1 -1
- package/dist/internal/protocol/sealed-sender/v2-binary.js +2 -2
- package/dist/internal/protocol/sealed-sender/v2-binary.js.map +1 -1
- package/dist/internal/protocol/sender-keys/manager.d.ts +16 -14
- package/dist/internal/protocol/sender-keys/manager.d.ts.map +1 -1
- package/dist/internal/protocol/sender-keys/manager.js +37 -34
- package/dist/internal/protocol/sender-keys/manager.js.map +1 -1
- package/dist/internal/protocol/spqr/braid-serialize.d.ts +6 -6
- package/dist/internal/protocol/spqr/braid-serialize.js +5 -5
- package/dist/internal/protocol/spqr/braid-serialize.js.map +1 -1
- package/dist/internal/protocol/spqr/braid.d.ts +3 -3
- package/dist/internal/protocol/spqr/braid.js +7 -7
- package/dist/internal/protocol/spqr/braid.js.map +1 -1
- package/dist/internal/protocol/spqr/index.js +1 -1
- package/dist/internal/protocol/spqr/index.js.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/chunk-domain.d.ts +3 -3
- package/dist/internal/protocol/spqr/ml-kem-braid/chunk-domain.js +3 -3
- package/dist/internal/protocol/spqr/ml-kem-braid/incremental-kem.js +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/incremental-kem.js.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/kdf.d.ts +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/kdf.js +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/kdf.js.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/noble-pq/arithmetic.d.ts +4 -3
- package/dist/internal/protocol/spqr/ml-kem-braid/noble-pq/arithmetic.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/noble-pq/arithmetic.js +4 -3
- package/dist/internal/protocol/spqr/ml-kem-braid/noble-pq/arithmetic.js.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/noble-pq/index.js +2 -2
- package/dist/internal/protocol/spqr/ml-kem-braid/progress.d.ts +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/progress.js +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/rs/codec.d.ts +15 -7
- package/dist/internal/protocol/spqr/ml-kem-braid/rs/codec.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/rs/codec.js +15 -7
- package/dist/internal/protocol/spqr/ml-kem-braid/rs/codec.js.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/rs/galois/field.js +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/rs/polynomial.d.ts +3 -3
- package/dist/internal/protocol/spqr/ml-kem-braid/rs/polynomial.js +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/serialize.d.ts +7 -7
- package/dist/internal/protocol/spqr/ml-kem-braid/serialize.js +11 -11
- package/dist/internal/protocol/spqr/ml-kem-braid/serialize.js.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/state-machine.d.ts +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/state-machine.js +6 -6
- package/dist/internal/protocol/spqr/ml-kem-braid/state-machine.js.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/types.d.ts +2 -2
- package/dist/internal/protocol/spqr/ml-kem-braid/types.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/types.js.map +1 -1
- package/dist/internal/protocol/spqr/serialize.d.ts +12 -12
- package/dist/internal/protocol/spqr/serialize.js +5 -5
- package/dist/internal/protocol/spqr/spqr.d.ts +6 -6
- package/dist/internal/protocol/spqr/spqr.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/spqr.js +47 -42
- package/dist/internal/protocol/spqr/spqr.js.map +1 -1
- package/dist/internal/protocol/spqr/validate.d.ts +1 -1
- package/dist/internal/protocol/triple-ratchet/ratchet.d.ts +12 -12
- package/dist/internal/protocol/triple-ratchet/ratchet.d.ts.map +1 -1
- package/dist/internal/protocol/triple-ratchet/ratchet.js +11 -11
- package/dist/internal/protocol/triple-ratchet/ratchet.js.map +1 -1
- package/dist/internal/protocol/username/hash.d.ts.map +1 -1
- package/dist/internal/protocol/username/hash.js +6 -4
- package/dist/internal/protocol/username/hash.js.map +1 -1
- package/dist/internal/protocol/version.d.ts +3 -3
- package/dist/internal/protocol/version.js +1 -1
- package/dist/internal/protocol/x3dh/x3dh.d.ts +16 -16
- package/dist/internal/protocol/x3dh/x3dh.d.ts.map +1 -1
- package/dist/internal/protocol/x3dh/x3dh.js +15 -15
- package/dist/internal/protocol/x3dh/x3dh.js.map +1 -1
- package/dist/internal/protocol/zk/credentials/attributes.d.ts +7 -7
- package/dist/internal/protocol/zk/credentials/attributes.js +7 -7
- package/dist/internal/protocol/zk/credentials/credentials.d.ts +1 -1
- package/dist/internal/protocol/zk/credentials/credentials.js +1 -1
- package/dist/internal/protocol/zk/credentials/endorsements.d.ts +11 -11
- package/dist/internal/protocol/zk/credentials/endorsements.js +14 -14
- package/dist/internal/protocol/zk/credentials/issuance.d.ts +5 -1
- package/dist/internal/protocol/zk/credentials/issuance.d.ts.map +1 -1
- package/dist/internal/protocol/zk/credentials/issuance.js +5 -1
- package/dist/internal/protocol/zk/credentials/issuance.js.map +1 -1
- package/dist/internal/protocol/zk/credentials/presentation.d.ts +16 -16
- package/dist/internal/protocol/zk/credentials/presentation.d.ts.map +1 -1
- package/dist/internal/protocol/zk/credentials/presentation.js +18 -18
- package/dist/internal/protocol/zk/credentials/presentation.js.map +1 -1
- package/dist/internal/protocol/zk/groups/auth-credential.d.ts +22 -16
- package/dist/internal/protocol/zk/groups/auth-credential.d.ts.map +1 -1
- package/dist/internal/protocol/zk/groups/auth-credential.js +19 -14
- package/dist/internal/protocol/zk/groups/auth-credential.js.map +1 -1
- package/dist/internal/protocol/zk/groups/client-zk-group-cipher.d.ts +4 -4
- package/dist/internal/protocol/zk/groups/client-zk-group-cipher.js +4 -4
- package/dist/internal/protocol/zk/groups/group-params.d.ts +2 -2
- package/dist/internal/protocol/zk/groups/group-params.js +2 -2
- package/dist/internal/protocol/zk/groups/group-send-endorsement.d.ts +10 -9
- package/dist/internal/protocol/zk/groups/group-send-endorsement.d.ts.map +1 -1
- package/dist/internal/protocol/zk/groups/group-send-endorsement.js +9 -8
- package/dist/internal/protocol/zk/groups/group-send-endorsement.js.map +1 -1
- package/dist/internal/protocol/zk/groups/lizard.d.ts +1 -1
- package/dist/internal/protocol/zk/groups/lizard.js +4 -4
- package/dist/internal/protocol/zk/groups/lizard.js.map +1 -1
- package/dist/internal/protocol/zk/groups/profile-key-commitment.d.ts +3 -3
- package/dist/internal/protocol/zk/groups/profile-key-commitment.js +3 -3
- package/dist/internal/protocol/zk/groups/profile-key-credential.d.ts +11 -11
- package/dist/internal/protocol/zk/groups/profile-key-credential.js +7 -7
- package/dist/internal/protocol/zk/groups/profile-key-encryption.d.ts +2 -2
- package/dist/internal/protocol/zk/groups/profile-key-encryption.js +2 -2
- package/dist/internal/protocol/zk/groups/profile-key-struct.d.ts +2 -2
- package/dist/internal/protocol/zk/groups/profile-key-struct.js +2 -2
- package/dist/internal/protocol/zk/groups/profile-key-version.d.ts +2 -2
- package/dist/internal/protocol/zk/groups/profile-key-version.js +2 -2
- package/dist/internal/protocol/zk/groups/server-params.d.ts +1 -1
- package/dist/internal/protocol/zk/groups/server-params.js +1 -1
- package/dist/internal/protocol/zk/groups/uid-encryption.d.ts +4 -4
- package/dist/internal/protocol/zk/groups/uid-encryption.js +4 -4
- package/dist/internal/protocol/zk/groups/uid-struct.d.ts +2 -2
- package/dist/internal/protocol/zk/groups/uid-struct.js +3 -3
- package/dist/internal/protocol/zk/groups/uid-struct.js.map +1 -1
- package/dist/internal/protocol/zk/proofs/args.d.ts +3 -3
- package/dist/internal/protocol/zk/proofs/args.js +3 -3
- package/dist/internal/protocol/zk/proofs/sho-sha256.d.ts +3 -3
- package/dist/internal/protocol/zk/proofs/sho-sha256.js +3 -3
- package/dist/internal/protocol/zk/proofs/sho.d.ts +8 -7
- package/dist/internal/protocol/zk/proofs/sho.d.ts.map +1 -1
- package/dist/internal/protocol/zk/proofs/sho.js +8 -7
- package/dist/internal/protocol/zk/proofs/sho.js.map +1 -1
- package/dist/internal/protocol/zk/proofs/statement.d.ts +8 -6
- package/dist/internal/protocol/zk/proofs/statement.d.ts.map +1 -1
- package/dist/internal/protocol/zk/proofs/statement.js +8 -6
- package/dist/internal/protocol/zk/proofs/statement.js.map +1 -1
- package/dist/internal/sesame/manager.d.ts +23 -19
- package/dist/internal/sesame/manager.d.ts.map +1 -1
- package/dist/internal/sesame/manager.js +64 -54
- package/dist/internal/sesame/manager.js.map +1 -1
- package/dist/internal/sesame/types.d.ts +28 -27
- package/dist/internal/sesame/types.d.ts.map +1 -1
- package/dist/internal/sesame/types.js +2 -4
- package/dist/internal/sesame/types.js.map +1 -1
- package/dist/internal/sesame/validation.d.ts +2 -2
- package/dist/internal/sesame/validation.js +3 -3
- package/dist/internal/sesame/validation.js.map +1 -1
- package/dist/internal/session/builder.d.ts +8 -8
- package/dist/internal/session/builder.js +22 -22
- package/dist/internal/session/builder.js.map +1 -1
- package/dist/internal/session/cipher.d.ts +3 -3
- package/dist/internal/session/cipher.d.ts.map +1 -1
- package/dist/internal/session/cipher.js +51 -40
- package/dist/internal/session/cipher.js.map +1 -1
- package/dist/internal/session/decryption.js +11 -9
- package/dist/internal/session/decryption.js.map +1 -1
- package/dist/internal/session/factory.js +1 -1
- package/dist/internal/session/factory.js.map +1 -1
- package/dist/internal/session/handshake.d.ts +4 -4
- package/dist/internal/session/handshake.js +4 -4
- package/dist/internal/session/keys.d.ts +3 -4
- package/dist/internal/session/keys.d.ts.map +1 -1
- package/dist/internal/session/keys.js.map +1 -1
- package/dist/internal/session/ratchet.d.ts +8 -8
- package/dist/internal/session/ratchet.js +10 -10
- package/dist/internal/session/ratchet.js.map +1 -1
- package/dist/internal/session/session-resolver.d.ts +6 -6
- package/dist/internal/session/session-resolver.js +6 -6
- package/dist/internal/session/state.d.ts +12 -12
- package/dist/internal/session/state.d.ts.map +1 -1
- package/dist/internal/session/state.js +7 -7
- package/dist/internal/session/types.d.ts +20 -20
- package/dist/internal/session/types.d.ts.map +1 -1
- package/dist/internal/session/types.js +3 -3
- package/dist/internal/session/validation.d.ts +1 -1
- package/dist/internal/session/validation.js +4 -4
- package/dist/internal/session/validation.js.map +1 -1
- package/dist/keys/branded.d.ts +12 -12
- package/dist/keys/branded.js +3 -3
- package/dist/keys/generation.d.ts +4 -4
- package/dist/keys/generation.js +4 -4
- package/dist/keys/identity.d.ts +7 -7
- package/dist/keys/identity.d.ts.map +1 -1
- package/dist/keys/identity.js +7 -7
- package/dist/keys/identity.js.map +1 -1
- package/dist/keys/types.d.ts +16 -16
- package/dist/keys/types.d.ts.map +1 -1
- package/dist/layers.d.ts +1 -1
- package/dist/layers.js +1 -1
- package/dist/local/store/expo/adapter.d.ts +8 -8
- package/dist/local/store/expo/adapter.js +10 -10
- package/dist/local/store/expo/adapter.js.map +1 -1
- package/dist/local/store/expo/database-key.d.ts +7 -7
- package/dist/local/store/expo/database-key.js +7 -7
- package/dist/local/store/expo/key-storage.d.ts +1 -1
- package/dist/local/store/expo/key-storage.js +4 -4
- package/dist/local/store/expo/key-storage.js.map +1 -1
- package/dist/local/store/expo/models/kyber-prekey-used.d.ts +6 -6
- package/dist/local/store/expo/models/kyber-prekey-used.js +3 -3
- package/dist/local/store/expo/models/kyber-prekey.d.ts +1 -1
- package/dist/local/store/expo/models/kyber-prekey.js +1 -1
- package/dist/local/store/expo/models/message-record.d.ts +2 -2
- package/dist/local/store/expo/models/message-record.d.ts.map +1 -1
- package/dist/local/store/expo/models/message-record.js +1 -1
- package/dist/local/store/expo/models/message-record.js.map +1 -1
- package/dist/local/store/expo/models/sender-key.d.ts +11 -10
- package/dist/local/store/expo/models/sender-key.d.ts.map +1 -1
- package/dist/local/store/expo/models/sender-key.js +11 -10
- package/dist/local/store/expo/models/sender-key.js.map +1 -1
- package/dist/local/store/expo/schema.d.ts +2 -2
- package/dist/local/store/expo/schema.js +2 -2
- package/dist/local/store/expo/secure-store-options.d.ts +1 -1
- package/dist/local/store/memory/adapter.d.ts +2 -2
- package/dist/local/store/memory/adapter.js +12 -12
- package/dist/local/store/memory/adapter.js.map +1 -1
- package/dist/local/store/node/adapter.d.ts.map +1 -1
- package/dist/local/store/node/adapter.js +5 -4
- package/dist/local/store/node/adapter.js.map +1 -1
- package/dist/local/store/node/database-key.d.ts +8 -8
- package/dist/local/store/node/database-key.js +10 -10
- package/dist/local/store/node/database-key.js.map +1 -1
- package/dist/local/store/node/database.d.ts +5 -5
- package/dist/local/store/node/database.js +11 -11
- package/dist/local/store/node/database.js.map +1 -1
- package/dist/local/store/react-native/adapter.d.ts +6 -6
- package/dist/local/store/react-native/adapter.d.ts.map +1 -1
- package/dist/local/store/react-native/adapter.js +35 -32
- package/dist/local/store/react-native/adapter.js.map +1 -1
- package/dist/local/store/react-native/backend-conformance.d.ts +11 -10
- package/dist/local/store/react-native/backend-conformance.d.ts.map +1 -1
- package/dist/local/store/react-native/backend-conformance.js +13 -12
- package/dist/local/store/react-native/backend-conformance.js.map +1 -1
- package/dist/local/store/react-native/index.d.ts +1 -1
- package/dist/local/store/react-native/reference-backend.d.ts +14 -13
- package/dist/local/store/react-native/reference-backend.d.ts.map +1 -1
- package/dist/local/store/react-native/reference-backend.js +15 -14
- package/dist/local/store/react-native/reference-backend.js.map +1 -1
- package/dist/local/store/react-native/storage.d.ts +3 -3
- package/dist/local/store/web/adapter.d.ts +3 -3
- package/dist/local/store/web/adapter.d.ts.map +1 -1
- package/dist/local/store/web/adapter.js +30 -31
- package/dist/local/store/web/adapter.js.map +1 -1
- package/dist/local/store/web/index.d.ts +1 -1
- package/dist/local/vault/index.d.ts +2 -2
- package/dist/media/index.d.ts +11 -12
- package/dist/media/index.d.ts.map +1 -1
- package/dist/media/index.js +9 -10
- package/dist/media/index.js.map +1 -1
- package/dist/profile/contact-state.d.ts +1 -1
- package/dist/profile/contact-state.js +1 -1
- package/dist/profile/profile-key.d.ts +2 -2
- package/dist/profile/profile-key.js +7 -6
- package/dist/profile/profile-key.js.map +1 -1
- package/dist/remote/object-store/index.d.ts +1 -1
- package/dist/remote/object-store/s3/storage.d.ts +1 -1
- package/dist/remote/object-store/types.d.ts +4 -4
- package/dist/remote/object-store/types.d.ts.map +1 -1
- package/dist/remote/relay/convex/backend.d.ts +6 -6
- package/dist/remote/relay/convex/backend.d.ts.map +1 -1
- package/dist/remote/relay/convex/backend.js +4 -4
- package/dist/remote/relay/convex/backend.js.map +1 -1
- package/dist/remote/relay/convex/component/_generated/component.d.ts +2 -2
- package/dist/remote/relay/convex/component/_generated/component.d.ts.map +1 -1
- package/dist/remote/relay/convex/component/accounts.d.ts +15 -13
- package/dist/remote/relay/convex/component/accounts.d.ts.map +1 -1
- package/dist/remote/relay/convex/component/accounts.js +31 -28
- package/dist/remote/relay/convex/component/accounts.js.map +1 -1
- package/dist/remote/relay/convex/component/certificates.js +1 -1
- package/dist/remote/relay/convex/component/cleanup.js +7 -7
- package/dist/remote/relay/convex/component/cleanup.js.map +1 -1
- package/dist/remote/relay/convex/component/convex.config.d.ts.map +1 -1
- package/dist/remote/relay/convex/component/convex.config.js +10 -8
- package/dist/remote/relay/convex/component/convex.config.js.map +1 -1
- package/dist/remote/relay/convex/component/devices.d.ts +21 -20
- package/dist/remote/relay/convex/component/devices.d.ts.map +1 -1
- package/dist/remote/relay/convex/component/devices.js +24 -23
- package/dist/remote/relay/convex/component/devices.js.map +1 -1
- package/dist/remote/relay/convex/component/groups.js +6 -6
- package/dist/remote/relay/convex/component/groups.js.map +1 -1
- package/dist/remote/relay/convex/component/messages.d.ts +2 -2
- package/dist/remote/relay/convex/component/messages.d.ts.map +1 -1
- package/dist/remote/relay/convex/component/messages.js +90 -83
- package/dist/remote/relay/convex/component/messages.js.map +1 -1
- package/dist/remote/relay/convex/component/provisioning.d.ts +3 -3
- package/dist/remote/relay/convex/component/provisioning.d.ts.map +1 -1
- package/dist/remote/relay/convex/component/provisioning.js +17 -16
- package/dist/remote/relay/convex/component/provisioning.js.map +1 -1
- package/dist/remote/relay/convex/component/runtime.d.ts.map +1 -1
- package/dist/remote/relay/convex/component/runtime.js +4 -2
- package/dist/remote/relay/convex/component/runtime.js.map +1 -1
- package/dist/remote/relay/convex/component/schema.d.ts +2 -2
- package/dist/remote/relay/convex/component/schema.js +26 -25
- package/dist/remote/relay/convex/component/schema.js.map +1 -1
- package/dist/remote/relay/convex/group-server.d.ts +3 -3
- package/dist/remote/relay/convex/group-server.js +3 -3
- package/dist/remote/relay/convex/relay.d.ts +3 -3
- package/dist/remote/relay/convex/relay.d.ts.map +1 -1
- package/dist/remote/relay/convex/relay.js +18 -17
- package/dist/remote/relay/convex/relay.js.map +1 -1
- package/dist/remote/relay/convex/types.d.ts +7 -7
- package/dist/remote/relay/convex/types.js +4 -4
- package/dist/remote/relay/memory/adapter.js +9 -9
- package/dist/remote/relay/memory/adapter.js.map +1 -1
- package/dist/remote/relay/types.d.ts +27 -27
- package/dist/remote/relay/types.d.ts.map +1 -1
- package/dist/safety/fingerprint.d.ts +7 -6
- package/dist/safety/fingerprint.d.ts.map +1 -1
- package/dist/safety/fingerprint.js +5 -4
- package/dist/safety/fingerprint.js.map +1 -1
- package/dist/safety/index.d.ts +6 -5
- package/dist/safety/index.d.ts.map +1 -1
- package/dist/safety/index.js +7 -6
- package/dist/safety/index.js.map +1 -1
- package/dist/safety/protobuf.js +2 -2
- package/dist/safety/protobuf.js.map +1 -1
- package/dist/safety/url.d.ts +5 -5
- package/dist/safety/url.js +6 -6
- package/dist/types/address.d.ts +2 -2
- package/dist/types/address.js +2 -2
- package/dist/types/api.d.ts +78 -73
- package/dist/types/api.d.ts.map +1 -1
- package/dist/types/errors.d.ts +63 -403
- package/dist/types/errors.d.ts.map +1 -1
- package/dist/types/errors.js +62 -537
- package/dist/types/errors.js.map +1 -1
- package/dist/types/messages.d.ts +16 -16
- package/dist/types/messages.d.ts.map +1 -1
- package/dist/types/messages.js +7 -7
- package/dist/types/messages.js.map +1 -1
- package/dist/types/protocol-config.d.ts +52 -49
- package/dist/types/protocol-config.d.ts.map +1 -1
- package/dist/types/protocol-config.js +36 -34
- package/dist/types/protocol-config.js.map +1 -1
- package/dist/types/protocol-constants.d.ts +2 -2
- package/dist/types/protocol-constants.js +2 -2
- package/dist/types/session.d.ts +62 -61
- package/dist/types/session.d.ts.map +1 -1
- package/dist/types/session.js +13 -14
- package/dist/types/session.js.map +1 -1
- package/dist/types/trust.d.ts +8 -8
- package/dist/types/trust.js +3 -3
- package/dist/utils/retry.d.ts +2 -1
- package/dist/utils/retry.d.ts.map +1 -1
- package/dist/utils/retry.js +4 -5
- package/dist/utils/retry.js.map +1 -1
- package/docs/ASSURANCE.md +89 -75
- package/docs/CLIENT_COMPOSITION.md +22 -15
- package/docs/DEVIATIONS.md +507 -425
- package/docs/DOCUMENTATION_STANDARDS.md +52 -24
- package/docs/E2EE.md +45 -42
- package/docs/ERROR_HANDLING.md +107 -152
- package/docs/GETTING_STARTED.md +44 -26
- package/docs/INTERFACES.md +32 -18
- package/docs/PACKAGE_SURFACE.md +24 -21
- package/docs/PROTOCOL_POLICY.md +25 -13
- package/docs/RECIPES.md +13 -4
- package/docs/SECURITY.md +72 -60
- package/encoding/README.md +3 -2
- package/files/README.md +2 -1
- package/groups/README.md +5 -3
- package/hooks/README.md +2 -2
- package/keys/README.md +17 -14
- package/local/store/README.md +84 -67
- package/local/store/expo/README.md +19 -12
- package/local/store/memory/README.md +6 -3
- package/local/store/node/README.md +9 -6
- package/local/store/react-native/README.md +16 -12
- package/local/store/web/README.md +32 -26
- package/local/vault/README.md +5 -4
- package/media/README.md +8 -5
- package/package.json +4 -2
- package/profile/README.md +8 -7
- package/remote/README.md +26 -18
- package/remote/object-store/README.md +9 -4
- package/remote/object-store/convex-r2/README.md +5 -3
- package/remote/object-store/s3/README.md +11 -5
- package/remote/relay/README.md +2 -0
- package/remote/relay/convex/README.md +6 -5
- package/remote/relay/convex/component/README.md +154 -124
- package/remote/relay/memory/README.md +8 -5
- package/safety/README.md +2 -1
- package/sealed-sender/README.md +4 -2
- package/types/README.md +2 -1
- package/username/README.md +1 -0
- package/utils/README.md +5 -4
- package/zk/README.md +1 -0
package/dist/client/config.d.ts
CHANGED
|
@@ -38,21 +38,21 @@ export interface SealedSenderConfig {
|
|
|
38
38
|
* Clients use these to validate the certificate chain:
|
|
39
39
|
* trust_root signs ServerCertificate -> ServerCertificate signs SenderCertificate
|
|
40
40
|
*
|
|
41
|
-
* Multiple roots
|
|
41
|
+
* Multiple roots work for key rotation scenarios.
|
|
42
42
|
*/
|
|
43
43
|
trustRoots: Uint8Array[];
|
|
44
44
|
/**
|
|
45
45
|
* Provider function that returns a serialized SenderCertificate (base64).
|
|
46
46
|
*
|
|
47
|
-
*
|
|
48
|
-
* certificate
|
|
49
|
-
* validity period (typically 24 hours).
|
|
47
|
+
* The client calls this lazily when it sends a sealed sender message and the
|
|
48
|
+
* cached certificate expired. The client caches the returned certificate for
|
|
49
|
+
* its validity period (typically 24 hours).
|
|
50
50
|
*
|
|
51
51
|
* @returns Base64-encoded serialized SenderCertificate
|
|
52
52
|
*/
|
|
53
53
|
certificateProvider?: () => Promise<string>;
|
|
54
54
|
/**
|
|
55
|
-
* Who
|
|
55
|
+
* Who may send sealed sender messages to this user.
|
|
56
56
|
*
|
|
57
57
|
* @default 'unrestricted'
|
|
58
58
|
*/
|
|
@@ -60,9 +60,9 @@ export interface SealedSenderConfig {
|
|
|
60
60
|
/**
|
|
61
61
|
* Optional host-provided contact profile state store.
|
|
62
62
|
*
|
|
63
|
-
* When present, the Signal Protocol client can use per-contact profile keys
|
|
64
|
-
* unidentified-access mode for direct-message sealed sender sends
|
|
65
|
-
*
|
|
63
|
+
* When present, the Signal Protocol client can use per-contact profile keys
|
|
64
|
+
* and unidentified-access mode for direct-message sealed sender sends. It
|
|
65
|
+
* does not import the host app's persistence layer.
|
|
66
66
|
*/
|
|
67
67
|
contactStateStore?: import('../profile/contact-state.js').ContactProfileStateStore;
|
|
68
68
|
}
|
|
@@ -93,7 +93,7 @@ export interface DoubleRatchetConfig {
|
|
|
93
93
|
*
|
|
94
94
|
* Application code should usually prefer `createSignalProtocolClient()`, which groups
|
|
95
95
|
* account identity, adapters, and protocol policy into a friendlier shape. Use
|
|
96
|
-
* this config directly when lower-level integration code already
|
|
96
|
+
* this config directly when lower-level integration code already flattened
|
|
97
97
|
* client options.
|
|
98
98
|
*
|
|
99
99
|
* @example
|
|
@@ -138,10 +138,10 @@ export interface SignalProtocolClientConfig {
|
|
|
138
138
|
* - 2-5 = Linked devices
|
|
139
139
|
*
|
|
140
140
|
* Device 1 bootstraps identity locally. Devices 2-5 must already have a
|
|
141
|
-
* provisioned identity imported into the provided storage before
|
|
142
|
-
* `SignalProtocolClient.create()
|
|
141
|
+
* provisioned identity imported into the provided storage before the app
|
|
142
|
+
* calls `SignalProtocolClient.create()`.
|
|
143
143
|
*
|
|
144
|
-
* Prekeys and sessions remain device-specific
|
|
144
|
+
* Prekeys and sessions remain device-specific. Devices share account identity.
|
|
145
145
|
* Maximum 5 devices per user (1 primary + 4 linked).
|
|
146
146
|
*
|
|
147
147
|
* @default 1 (primary device)
|
|
@@ -168,10 +168,10 @@ export interface SignalProtocolClientConfig {
|
|
|
168
168
|
* When `true`, generates and syncs both ACI and PNI identity keys, prekeys,
|
|
169
169
|
* and Kyber prekeys for applications that maintain both account identifiers.
|
|
170
170
|
*
|
|
171
|
-
* When `false` (default),
|
|
171
|
+
* When `false` (default), the client generates and synchronizes only ACI keys. Use
|
|
172
172
|
* this for applications whose account model does not require PNI keys.
|
|
173
173
|
*
|
|
174
|
-
*
|
|
174
|
+
* This leaves the PNI UUID on the users table alone. It can still exist for ZK
|
|
175
175
|
* group credentials without generating cryptographic keys.
|
|
176
176
|
*
|
|
177
177
|
* @default false
|
|
@@ -180,7 +180,7 @@ export interface SignalProtocolClientConfig {
|
|
|
180
180
|
/**
|
|
181
181
|
* This account's ACI for Group System credential presentation.
|
|
182
182
|
*
|
|
183
|
-
* Required when `groups
|
|
183
|
+
* Required when you configure `groups`.
|
|
184
184
|
*/
|
|
185
185
|
aci?: import('../internal/protocol/zk/groups/uid-struct.js').ServiceId;
|
|
186
186
|
/** This account's optional PNI for Group System credential presentation. */
|
|
@@ -215,7 +215,7 @@ export interface SignalProtocolClientConfig {
|
|
|
215
215
|
*/
|
|
216
216
|
relay?: ISignalProtocolRelayServer;
|
|
217
217
|
/**
|
|
218
|
-
* Remote object
|
|
218
|
+
* Remote object store adapter for encrypted file uploads (two-layer encryption)
|
|
219
219
|
*
|
|
220
220
|
* If provided, enables encrypted file upload (two-layer encryption):
|
|
221
221
|
* 1. Generate AES-256-GCM key
|
|
@@ -250,10 +250,10 @@ export interface SignalProtocolClientConfig {
|
|
|
250
250
|
/**
|
|
251
251
|
* App-owned media lifecycle callbacks for the SignalProtocolClient media queue.
|
|
252
252
|
*
|
|
253
|
-
* The
|
|
254
|
-
*
|
|
255
|
-
* state in the app layer
|
|
256
|
-
* app database ownership.
|
|
253
|
+
* The existing Signal Protocol local storage adapter persists the queue
|
|
254
|
+
* itself. These callbacks keep local bytes, plaintext caches, and product
|
|
255
|
+
* state in the app layer. There they can share file permissions, UI state,
|
|
256
|
+
* and app database ownership.
|
|
257
257
|
*
|
|
258
258
|
* @example
|
|
259
259
|
* ```typescript
|
|
@@ -479,7 +479,7 @@ export interface SignalProtocolClientConfig {
|
|
|
479
479
|
* - Errors and cleanup operations
|
|
480
480
|
*
|
|
481
481
|
* All hooks are optional and support both sync and async implementations.
|
|
482
|
-
* Hook errors are caught internally and
|
|
482
|
+
* Hook errors are caught internally and will not affect core functionality.
|
|
483
483
|
*
|
|
484
484
|
* Common use cases:
|
|
485
485
|
* - Cache invalidation (ContentManager, React Query)
|
|
@@ -531,7 +531,7 @@ export interface SignalProtocolClientConfig {
|
|
|
531
531
|
*/
|
|
532
532
|
throwDetailedErrors?: boolean;
|
|
533
533
|
/**
|
|
534
|
-
* Callback
|
|
534
|
+
* Callback for the moment one-time prekeys run low
|
|
535
535
|
*
|
|
536
536
|
* Called when prekey count drops below the threshold (default: 50).
|
|
537
537
|
* Use this to trigger prekey replenishment to prevent session
|
|
@@ -558,7 +558,7 @@ export interface SignalProtocolClientConfig {
|
|
|
558
558
|
/**
|
|
559
559
|
* Key refresh interval in milliseconds.
|
|
560
560
|
*
|
|
561
|
-
* Controls how often signed prekeys and Kyber (last-resort) prekeys
|
|
561
|
+
* Controls how often the client rotates signed prekeys and Kyber (last-resort) prekeys.
|
|
562
562
|
* Per PQXDH specification Section 3.2, both key types use the same rotation
|
|
563
563
|
* schedule for synchronized post-quantum security.
|
|
564
564
|
*
|
|
@@ -586,7 +586,7 @@ export interface SignalProtocolClientConfig {
|
|
|
586
586
|
/**
|
|
587
587
|
* Maximum allowed prekey age in milliseconds.
|
|
588
588
|
*
|
|
589
|
-
* If prekeys exceed this age,
|
|
589
|
+
* If prekeys exceed this age, the app should block message sending to force
|
|
590
590
|
* key rotation. Provides a safety buffer above keyRefreshIntervalMs.
|
|
591
591
|
*
|
|
592
592
|
* With the default two-day refresh interval, the default maximum age leaves
|
|
@@ -608,7 +608,7 @@ export interface SignalProtocolClientConfig {
|
|
|
608
608
|
/**
|
|
609
609
|
* Prekey check throttle interval in milliseconds.
|
|
610
610
|
*
|
|
611
|
-
* Controls how often
|
|
611
|
+
* Controls how often the client checks the prekey count on app activation.
|
|
612
612
|
* Prevents unnecessary server queries when the app is repeatedly foregrounded.
|
|
613
613
|
*
|
|
614
614
|
* @default 43200000 (12 hours)
|
|
@@ -624,12 +624,12 @@ export interface SignalProtocolClientConfig {
|
|
|
624
624
|
*/
|
|
625
625
|
preKeyMaintenance?: PreKeyMaintenanceStore;
|
|
626
626
|
/**
|
|
627
|
-
*
|
|
627
|
+
* Runs after the client rotates a group sender key.
|
|
628
628
|
*
|
|
629
629
|
* Useful for logging, analytics, or triggering UI updates when
|
|
630
|
-
*
|
|
630
|
+
* the client rotates sender keys after membership changes.
|
|
631
631
|
*
|
|
632
|
-
* @param groupId - The group whose sender key
|
|
632
|
+
* @param groupId - The group whose sender key changed
|
|
633
633
|
* @param newGeneration - The new generation number of the sender key
|
|
634
634
|
*
|
|
635
635
|
* @example
|
|
@@ -647,19 +647,19 @@ export interface SignalProtocolClientConfig {
|
|
|
647
647
|
/**
|
|
648
648
|
* Sealed Sender configuration for anonymous message delivery.
|
|
649
649
|
*
|
|
650
|
-
* When configured,
|
|
650
|
+
* When configured, the client wraps messages in sealed sender encryption
|
|
651
651
|
* that hides the sender's identity from the server. The recipient can
|
|
652
652
|
* still verify the sender via the embedded certificate.
|
|
653
653
|
*
|
|
654
654
|
* Requires:
|
|
655
655
|
* - A relay deployment secret (`OE_GROUPS_SERVER_SECRET`), from which the
|
|
656
|
-
* certificate signing keys
|
|
656
|
+
* relay derives the certificate signing keys. There is no separate signing-key
|
|
657
657
|
* variable.
|
|
658
658
|
* - The deployment's Ed25519 sender-certificate root public key pinned in
|
|
659
659
|
* `trustRoots` at build time. Print it with `npx oe-groups trust-root`,
|
|
660
660
|
* which reports it as `sealed sender trust root` alongside the group trust
|
|
661
|
-
* root. Never fetch it from a relay at runtime
|
|
662
|
-
* root
|
|
661
|
+
* root. Never fetch it from a relay at runtime. A relay that can choose
|
|
662
|
+
* the root that validates it can mint certificates for any sender.
|
|
663
663
|
*
|
|
664
664
|
* With `trustRoots` empty, inbound sealed-sender validation stays disabled
|
|
665
665
|
* and sends fall back to identified delivery, which deanonymizes the sender
|
|
@@ -7,8 +7,8 @@ import { ContentHint } from '../types/messages.js';
|
|
|
7
7
|
/**
|
|
8
8
|
* 14-day TTL for MessageRecords (SESAME spec Section 6.2)
|
|
9
9
|
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
10
|
+
* A retry request is unlikely to need a message older than this, so `stop()`
|
|
11
|
+
* discards it. Two call sites use this value:
|
|
12
12
|
* - handleRetryRequestAndResend() to reject expired messages
|
|
13
13
|
* - stop() to clean up old MessageRecords
|
|
14
14
|
*/
|
|
@@ -24,13 +24,13 @@ export declare const MESSAGE_RECORD_TTL_MS: number;
|
|
|
24
24
|
*/
|
|
25
25
|
export declare const MAX_RETRY_RESPONSES_PER_MESSAGE = 5;
|
|
26
26
|
/**
|
|
27
|
-
* Envelope types that
|
|
28
|
-
* Server-generated receipts are implicit
|
|
27
|
+
* Envelope types that take ContentHint.Implicit behavior.
|
|
28
|
+
* Server-generated receipts are implicit. Client-to-client implicit types
|
|
29
29
|
* (typing indicators, delivery receipts) use ContentHint.Implicit on the envelope.
|
|
30
30
|
*/
|
|
31
31
|
export declare const IMPLICIT_ENVELOPE_TYPES: readonly ['server_delivery_receipt'];
|
|
32
32
|
/**
|
|
33
|
-
* Check if a message
|
|
33
|
+
* Check if a message takes ContentHint.Implicit behavior.
|
|
34
34
|
*
|
|
35
35
|
* Implicit messages are ephemeral (typing indicators, receipts) and should be
|
|
36
36
|
* silently discarded on decryption failure - no ERROR logs, no retry requests.
|
|
@@ -39,7 +39,8 @@ export declare const IMPLICIT_ENVELOPE_TYPES: readonly ['server_delivery_receipt
|
|
|
39
39
|
* Server-generated delivery receipts are also implicit by envelope type.
|
|
40
40
|
*
|
|
41
41
|
* @param envelope - Message envelope with optional contentHint and messageType
|
|
42
|
-
* @returns true if the message is implicit and
|
|
42
|
+
* @returns true if the message is implicit, and the caller should discard it
|
|
43
|
+
* on failure
|
|
43
44
|
*/
|
|
44
45
|
export declare function isImplicitContentType(envelope: {
|
|
45
46
|
contentHint?: ContentHint;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../client/constants.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD;;;;;;;GAOG;AACH,OAAO,EAAE,CAAC;AACV,eAAO,MAAM,qBAAqB,QAA2B,CAAC;AAE9D;;;;;;;GAOG;AACH,eAAO,MAAM,+BAA+B,IAAI,CAAC;AAEjD;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,YAAI,yBAAyB,CAAU,CAAC;AAE5E
|
|
1
|
+
{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../client/constants.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD;;;;;;;GAOG;AACH,OAAO,EAAE,CAAC;AACV,eAAO,MAAM,qBAAqB,QAA2B,CAAC;AAE9D;;;;;;;GAOG;AACH,eAAO,MAAM,+BAA+B,IAAI,CAAC;AAEjD;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,YAAI,yBAAyB,CAAU,CAAC;AAE5E;;;;;;;;;;;;GAYG;AACH,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE;IAC9C,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,GAAG,OAAO,CAQV"}
|
package/dist/client/constants.js
CHANGED
|
@@ -15,13 +15,13 @@ export const MESSAGE_RECORD_TTL_MS = 14 * 24 * 60 * 60 * 1000; // 14 days
|
|
|
15
15
|
*/
|
|
16
16
|
export const MAX_RETRY_RESPONSES_PER_MESSAGE = 5;
|
|
17
17
|
/**
|
|
18
|
-
* Envelope types that
|
|
19
|
-
* Server-generated receipts are implicit
|
|
18
|
+
* Envelope types that take ContentHint.Implicit behavior.
|
|
19
|
+
* Server-generated receipts are implicit. Client-to-client implicit types
|
|
20
20
|
* (typing indicators, delivery receipts) use ContentHint.Implicit on the envelope.
|
|
21
21
|
*/
|
|
22
22
|
export const IMPLICIT_ENVELOPE_TYPES = ['server_delivery_receipt'];
|
|
23
23
|
/**
|
|
24
|
-
* Check if a message
|
|
24
|
+
* Check if a message takes ContentHint.Implicit behavior.
|
|
25
25
|
*
|
|
26
26
|
* Implicit messages are ephemeral (typing indicators, receipts) and should be
|
|
27
27
|
* silently discarded on decryption failure - no ERROR logs, no retry requests.
|
|
@@ -30,7 +30,8 @@ export const IMPLICIT_ENVELOPE_TYPES = ['server_delivery_receipt'];
|
|
|
30
30
|
* Server-generated delivery receipts are also implicit by envelope type.
|
|
31
31
|
*
|
|
32
32
|
* @param envelope - Message envelope with optional contentHint and messageType
|
|
33
|
-
* @returns true if the message is implicit and
|
|
33
|
+
* @returns true if the message is implicit, and the caller should discard it
|
|
34
|
+
* on failure
|
|
34
35
|
*/
|
|
35
36
|
export function isImplicitContentType(envelope) {
|
|
36
37
|
return (envelope.contentHint === ContentHint.Implicit ||
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../client/constants.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAWhD,MAAM,CAAC,MAAM,qBAAqB,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,UAAU;AAEzE;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,CAAC;AAEjD;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,yBAAyB,CAAU,CAAC;AAE5E
|
|
1
|
+
{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../client/constants.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAWhD,MAAM,CAAC,MAAM,qBAAqB,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,UAAU;AAEzE;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,CAAC;AAEjD;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,yBAAyB,CAAU,CAAC;AAE5E;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,qBAAqB,CAAC,QAGrC;IACC,OAAO,CACL,QAAQ,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ;QAC7C,CAAC,QAAQ,CAAC,WAAW,KAAK,SAAS;YACjC,uBAAuB,CAAC,QAAQ,CAC9B,QAAQ,CAAC,WAAuD,CACjE,CAAC,CACL,CAAC;AACJ,CAAC"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Dual Protocol Store
|
|
2
|
+
* Dual Protocol Store: ACI/PNI Identity Router
|
|
3
3
|
*
|
|
4
4
|
* Thin wrapper providing .aci() and .pni() views over KeyStorage,
|
|
5
5
|
* each pre-filling identityType for all operations.
|
|
@@ -46,7 +46,7 @@ export declare class IdentityTypedStore {
|
|
|
46
46
|
}>;
|
|
47
47
|
}
|
|
48
48
|
/**
|
|
49
|
-
* Dual protocol store
|
|
49
|
+
* Dual protocol store. Routes operations to ACI or PNI identity stores.
|
|
50
50
|
*
|
|
51
51
|
* Usage:
|
|
52
52
|
* ```typescript
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Dual Protocol Store
|
|
2
|
+
* Dual Protocol Store: ACI/PNI Identity Router
|
|
3
3
|
*
|
|
4
4
|
* Thin wrapper providing .aci() and .pni() views over KeyStorage,
|
|
5
5
|
* each pre-filling identityType for all operations.
|
|
@@ -89,7 +89,7 @@ export class IdentityTypedStore {
|
|
|
89
89
|
}
|
|
90
90
|
}
|
|
91
91
|
/**
|
|
92
|
-
* Dual protocol store
|
|
92
|
+
* Dual protocol store. Routes operations to ACI or PNI identity stores.
|
|
93
93
|
*
|
|
94
94
|
* Usage:
|
|
95
95
|
* ```typescript
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* EndorsementManager
|
|
2
|
+
* EndorsementManager: client-side fetch, cache, and token generation
|
|
3
3
|
* for GroupSendEndorsements.
|
|
4
4
|
*
|
|
5
5
|
* Lifecycle:
|
|
6
6
|
* 1. Client calls fetchAndCacheEndorsements() after group state sync
|
|
7
|
-
* 2.
|
|
7
|
+
* 2. The client validates endorsements (batch proof) and caches them to SQLite
|
|
8
8
|
* 3. On send, getTokenForRecipient() produces a 24-byte bearer token
|
|
9
9
|
* 4. For Sender Key multi-recipient sends, getCombinedToken() combines
|
|
10
10
|
* endorsements into a single token covering all recipients
|
|
@@ -25,18 +25,18 @@ import { type ILogger } from '../logger.js';
|
|
|
25
25
|
*/
|
|
26
26
|
export {};
|
|
27
27
|
/**
|
|
28
|
-
* One member's cached endorsement, paired with the ACI
|
|
28
|
+
* One member's cached endorsement, paired with the ACI the issuer endorsed.
|
|
29
29
|
*
|
|
30
30
|
* The ACI travels with the endorsement because the send path must tell the
|
|
31
|
-
* relay which identities its token endorses
|
|
32
|
-
* against those before reading any account
|
|
33
|
-
*
|
|
34
|
-
*
|
|
31
|
+
* relay which identities its token endorses. The relay verifies the token
|
|
32
|
+
* against those before reading any account. The identities that are *correct*
|
|
33
|
+
* to claim are exactly the ones the issuer endorsed at refresh
|
|
34
|
+
* time. They are not whatever a later lookup would resolve.
|
|
35
35
|
*/
|
|
36
36
|
export interface CachedMemberEndorsement {
|
|
37
37
|
/** Compressed endorsement point bytes. */
|
|
38
38
|
endorsement: Uint8Array;
|
|
39
|
-
/** 16-byte ACI the
|
|
39
|
+
/** 16-byte ACI the issuer endorsed. */
|
|
40
40
|
aciBytes: Uint8Array;
|
|
41
41
|
}
|
|
42
42
|
export interface EndorsementCacheStore {
|
|
@@ -64,7 +64,7 @@ export declare class EndorsementManager {
|
|
|
64
64
|
*/
|
|
65
65
|
needsRefresh(expiration: number): boolean;
|
|
66
66
|
/**
|
|
67
|
-
* Check
|
|
67
|
+
* Check whether cached endorsements expired.
|
|
68
68
|
*
|
|
69
69
|
* @param expiration - Cached endorsement expiration in epoch seconds
|
|
70
70
|
* @returns true if endorsements are past expiration
|
|
@@ -120,26 +120,26 @@ export declare class EndorsementManager {
|
|
|
120
120
|
aciBytesByUserId: Map<string, Uint8Array>;
|
|
121
121
|
} | null>;
|
|
122
122
|
/**
|
|
123
|
-
* Check
|
|
123
|
+
* Check whether any group member lacks a cached endorsement.
|
|
124
124
|
*
|
|
125
125
|
* Used in the pre-send endorsement refresh check.
|
|
126
126
|
*
|
|
127
127
|
* @param groupId - Group identifier
|
|
128
128
|
* @param memberUserIds - User IDs of all group members (excluding self)
|
|
129
|
-
* @returns true if any member
|
|
129
|
+
* @returns true if any member lacks one, false if all present or no cache
|
|
130
130
|
*/
|
|
131
131
|
isMissingAnyEndorsements(groupId: string, memberUserIds: string[]): Promise<boolean>;
|
|
132
132
|
/**
|
|
133
|
-
* Check whether endorsements
|
|
133
|
+
* Check whether endorsements need a refresh before sending.
|
|
134
134
|
*
|
|
135
135
|
* Checks three conditions:
|
|
136
136
|
* 1. No endorsements cached at all
|
|
137
137
|
* 2. Endorsements expire within 2 hours
|
|
138
|
-
* 3. Any group member
|
|
138
|
+
* 3. Any group member lacks an endorsement
|
|
139
139
|
*
|
|
140
140
|
* @param groupId - Group identifier
|
|
141
141
|
* @param memberUserIds - User IDs of all group members (excluding self)
|
|
142
|
-
* @returns Object indicating
|
|
142
|
+
* @returns Object indicating whether a refresh applies, and why
|
|
143
143
|
*
|
|
144
144
|
*/
|
|
145
145
|
shouldRefreshEndorsements(groupId: string, memberUserIds: string[]): Promise<{
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"endorsement-manager.d.ts","sourceRoot":"","sources":["../../client/endorsement-manager.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAcH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kDAAkD,CAAC;AAC5F,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,6CAA6C,CAAC;AACrF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2CAA2C,CAAC;AAE3E,OAAO,EAA+B,KAAK,OAAO,EAAE,MAAM,WAAW,CAAC;AAMtE;;GAEG;AACH,OAAO,EAAE,CAAC;AAOV;;;;;;;;GAQG;AACH,MAAM,WAAW,uBAAuB;IACtC,0CAA0C;IAC1C,WAAW,EAAE,UAAU,CAAC;IACxB,
|
|
1
|
+
{"version":3,"file":"endorsement-manager.d.ts","sourceRoot":"","sources":["../../client/endorsement-manager.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAcH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kDAAkD,CAAC;AAC5F,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,6CAA6C,CAAC;AACrF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2CAA2C,CAAC;AAE3E,OAAO,EAA+B,KAAK,OAAO,EAAE,MAAM,WAAW,CAAC;AAMtE;;GAEG;AACH,OAAO,EAAE,CAAC;AAOV;;;;;;;;GAQG;AACH,MAAM,WAAW,uBAAuB;IACtC,0CAA0C;IAC1C,WAAW,EAAE,UAAU,CAAC;IACxB,uCAAuC;IACvC,QAAQ,EAAE,UAAU,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC,qBAAqB,CACnB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC;QACT,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAC;QACnD,UAAU,EAAE,MAAM,CAAC;KACpB,GAAG,IAAI,CAAC,CAAC;IACV,iBAAiB,CACf,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,uBAAuB,CAAC,EAClD,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACnD;AAED,qBAAa,kBAAkB;IAE3B,OAAO,CAAC,QAAQ,CAAC,KAAK;IACtB,OAAO,CAAC,QAAQ,CAAC,wBAAwB;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM;IAHzB,YACmB,KAAK,EAAE,qBAAqB,EAC5B,wBAAwB,EAAE,mBAAmB,EAC7C,MAAM,GAAE,QAAQ,CAAC,OAAO,CAA+B,EACtE;IAEJ;;OAEG;IACH,8BAA8B,CAC5B,QAAQ,EAAE,mBAAmB,GAC5B,IAAI,CAWN;IAED;;;;;OAKG;IACH,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAGxC;IAED;;;;;OAKG;IACH,SAAS,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAGrC;IAED;;;;;;;;;;;;;;OAcG;IACG,2BAA2B,CAC/B,OAAO,EAAE,MAAM,EACf,yBAAyB,EAAE,UAAU,EACrC,gBAAgB,EAAE,SAAS,EAAE,EAC7B,aAAa,EAAE,MAAM,EAAE,EACvB,WAAW,EAAE,MAAM,EACnB,iBAAiB,EAAE,iBAAiB,GACnC,OAAO,CAAC,IAAI,CAAC,CAgDf;IAED;;;;;;;;;;OAUG;IACG,oBAAoB,CACxB,OAAO,EAAE,MAAM,EACf,eAAe,EAAE,MAAM,EACvB,iBAAiB,CAAC,EAAE,iBAAiB,GACpC,OAAO,CAAC;QACT,KAAK,EAAE,UAAU,CAAC;QAClB,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,UAAU,CAAC;KACtB,GAAG,IAAI,CAAC,CAkCR;IAED;;;;;;;;;;;OAWG;IACG,gBAAgB,CACpB,OAAO,EAAE,MAAM,EACf,gBAAgB,EAAE,MAAM,EAAE,EAC1B,iBAAiB,CAAC,EAAE,iBAAiB,GACpC,OAAO,CAAC;QACT,KAAK,EAAE,UAAU,CAAC;QAClB,UAAU,EAAE,MAAM,CAAC;QACnB,gBAAgB,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;KAC3C,GAAG,IAAI,CAAC,CAiDR;IAED;;;;;;;;OAQG;IACG,wBAAwB,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAYzF;IAED;;;;;;;;;;;;OAYG;IACG,yBAAyB,CAC7B,OAAO,EAAE,MAAM,EACf,aAAa,EAAE,MAAM,EAAE,GACtB,OAAO,CAAC;QACT,YAAY,EAAE,OAAO,CAAC;QACtB,MAAM,CAAC,EAAE,eAAe,GAAG,eAAe,GAAG,iBAAiB,CAAC;KAChE,CAAC,CAqBD;IAED;;;;;;OAMG;IACG,sBAAsB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAE3D;IAED;;;;OAIG;IACG,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAGjE;CACF"}
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* EndorsementManager
|
|
2
|
+
* EndorsementManager: client-side fetch, cache, and token generation
|
|
3
3
|
* for GroupSendEndorsements.
|
|
4
4
|
*
|
|
5
5
|
* Lifecycle:
|
|
6
6
|
* 1. Client calls fetchAndCacheEndorsements() after group state sync
|
|
7
|
-
* 2.
|
|
7
|
+
* 2. The client validates endorsements (batch proof) and caches them to SQLite
|
|
8
8
|
* 3. On send, getTokenForRecipient() produces a 24-byte bearer token
|
|
9
9
|
* 4. For Sender Key multi-recipient sends, getCombinedToken() combines
|
|
10
10
|
* endorsements into a single token covering all recipients
|
|
@@ -49,7 +49,7 @@ export class EndorsementManager {
|
|
|
49
49
|
return expiration - now < ENDORSEMENT_REFRESH_THRESHOLD_SECONDS;
|
|
50
50
|
}
|
|
51
51
|
/**
|
|
52
|
-
* Check
|
|
52
|
+
* Check whether cached endorsements expired.
|
|
53
53
|
*
|
|
54
54
|
* @param expiration - Cached endorsement expiration in epoch seconds
|
|
55
55
|
* @returns true if endorsements are past expiration
|
|
@@ -83,13 +83,13 @@ export class EndorsementManager {
|
|
|
83
83
|
const nowSeconds = Math.floor(Date.now() / 1000);
|
|
84
84
|
const receivedEndorsements = receiveEndorsements(endorsementsResponse, memberServiceIds, nowSeconds, groupSecretParams, this.endorsementRootPublicKey);
|
|
85
85
|
// Build the compressed endorsement map without a self-endorsement. Each
|
|
86
|
-
// entry keeps the ACI
|
|
86
|
+
// entry keeps the ACI the issuer endorsed. The send path claims exactly
|
|
87
87
|
// these identities to the relay, which verifies the token against them
|
|
88
88
|
// before reading any account.
|
|
89
89
|
const endorsementMap = new Map();
|
|
90
90
|
for (let i = 0; i < memberServiceIds.length; i++) {
|
|
91
91
|
const userId = memberUserIds[i];
|
|
92
|
-
// Skip self
|
|
92
|
+
// Skip self. We never send sealed sender to ourselves
|
|
93
93
|
if (userId === localUserId) {
|
|
94
94
|
continue;
|
|
95
95
|
}
|
|
@@ -133,7 +133,7 @@ export class EndorsementManager {
|
|
|
133
133
|
}
|
|
134
134
|
const entry = cached.endorsements.get(recipientUserId);
|
|
135
135
|
if (!entry) {
|
|
136
|
-
//
|
|
136
|
+
// The group possibly added this member after the last endorsement fetch
|
|
137
137
|
return null;
|
|
138
138
|
}
|
|
139
139
|
if (!groupSecretParams) {
|
|
@@ -174,13 +174,13 @@ export class EndorsementManager {
|
|
|
174
174
|
await this.cache.clearEndorsements(groupId);
|
|
175
175
|
return null;
|
|
176
176
|
}
|
|
177
|
-
// Decompress all endorsements
|
|
177
|
+
// Decompress all endorsements. If any member lacks one, bail out
|
|
178
178
|
const endorsements = [];
|
|
179
179
|
const aciBytesByUserId = new Map();
|
|
180
180
|
for (const userId of recipientUserIds) {
|
|
181
181
|
const entry = cached.endorsements.get(userId);
|
|
182
182
|
if (!entry) {
|
|
183
|
-
// Missing member endorsement
|
|
183
|
+
// Missing member endorsement. Cannot produce valid combined token.
|
|
184
184
|
// Caller should use shouldRefreshEndorsements() pre-send to avoid this.
|
|
185
185
|
this.logger.debug('Missing endorsement for member in getCombinedToken', {
|
|
186
186
|
category: 'E2EE',
|
|
@@ -209,20 +209,20 @@ export class EndorsementManager {
|
|
|
209
209
|
};
|
|
210
210
|
}
|
|
211
211
|
/**
|
|
212
|
-
* Check
|
|
212
|
+
* Check whether any group member lacks a cached endorsement.
|
|
213
213
|
*
|
|
214
214
|
* Used in the pre-send endorsement refresh check.
|
|
215
215
|
*
|
|
216
216
|
* @param groupId - Group identifier
|
|
217
217
|
* @param memberUserIds - User IDs of all group members (excluding self)
|
|
218
|
-
* @returns true if any member
|
|
218
|
+
* @returns true if any member lacks one, false if all present or no cache
|
|
219
219
|
*/
|
|
220
220
|
async isMissingAnyEndorsements(groupId, memberUserIds) {
|
|
221
221
|
if (memberUserIds.length === 0)
|
|
222
222
|
return false;
|
|
223
223
|
const cached = await this.cache.getCachedEndorsements(groupId);
|
|
224
224
|
if (!cached)
|
|
225
|
-
return true; // No cache at all
|
|
225
|
+
return true; // No cache at all. Nothing is present
|
|
226
226
|
for (const userId of memberUserIds) {
|
|
227
227
|
if (!cached.endorsements.has(userId)) {
|
|
228
228
|
return true;
|
|
@@ -231,16 +231,16 @@ export class EndorsementManager {
|
|
|
231
231
|
return false;
|
|
232
232
|
}
|
|
233
233
|
/**
|
|
234
|
-
* Check whether endorsements
|
|
234
|
+
* Check whether endorsements need a refresh before sending.
|
|
235
235
|
*
|
|
236
236
|
* Checks three conditions:
|
|
237
237
|
* 1. No endorsements cached at all
|
|
238
238
|
* 2. Endorsements expire within 2 hours
|
|
239
|
-
* 3. Any group member
|
|
239
|
+
* 3. Any group member lacks an endorsement
|
|
240
240
|
*
|
|
241
241
|
* @param groupId - Group identifier
|
|
242
242
|
* @param memberUserIds - User IDs of all group members (excluding self)
|
|
243
|
-
* @returns Object indicating
|
|
243
|
+
* @returns Object indicating whether a refresh applies, and why
|
|
244
244
|
*
|
|
245
245
|
*/
|
|
246
246
|
async shouldRefreshEndorsements(groupId, memberUserIds) {
|
|
@@ -253,7 +253,7 @@ export class EndorsementManager {
|
|
|
253
253
|
if (this.needsRefresh(cached.expiration)) {
|
|
254
254
|
return { needsRefresh: true, reason: 'expiring_soon' };
|
|
255
255
|
}
|
|
256
|
-
// At least one current member
|
|
256
|
+
// At least one current member lacks an endorsement.
|
|
257
257
|
for (const userId of memberUserIds) {
|
|
258
258
|
if (!cached.endorsements.has(userId)) {
|
|
259
259
|
return { needsRefresh: true, reason: 'missing_members' };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"endorsement-manager.js","sourceRoot":"","sources":["../../client/endorsement-manager.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EACL,mBAAmB,EACnB,+BAA+B,EAC/B,eAAe,EACf,kBAAkB,EAClB,mBAAmB,GACpB,MAAM,uDAAuD,CAAC;AAC/D,OAAO,EACL,mBAAmB,EACnB,qBAAqB,GAEtB,MAAM,kDAAkD,CAAC;AAI1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,2BAA2B,EAAgB,MAAM,WAAW,CAAC;AAUtE,MAAM,qCAAqC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC;AAqC1D,MAAM,OAAO,kBAAkB;IAEV,KAAK;IACL,wBAAwB;IACxB,MAAM;IAHzB,YACmB,KAA4B,EAC5B,wBAA6C,EAC7C,MAAM,GAAsB,2BAA2B;qBAFvD,KAAK;wCACL,wBAAwB;sBACxB,MAAM;IACtB,CAAC;IAEJ;;OAEG;IACH,8BAA8B,CAC5B,QAA6B;QAE7B,IACE,CAAC,iBAAiB,CAChB,IAAI,CAAC,wBAAwB,CAAC,EAAE,CAAC,OAAO,EAAE,EAC1C,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,CACtB,EACD,CAAC;YACD,MAAM,IAAI,KAAK,CACb,0EAA0E,CAC3E,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,YAAY,CAAC,UAAkB;QAC7B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;QAC1C,OAAO,UAAU,GAAG,GAAG,GAAG,qCAAqC,CAAC;IAClE,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,UAAkB;QAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;QAC1C,OAAO,GAAG,IAAI,UAAU,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,2BAA2B,CAC/B,OAAe,EACf,yBAAqC,EACrC,gBAA6B,EAC7B,aAAuB,EACvB,WAAmB,EACnB,iBAAoC;QAEpC,IAAI,gBAAgB,CAAC,MAAM,KAAK,aAAa,CAAC,MAAM,EAAE,CAAC;YACrD,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAC;QAClF,CAAC;QAED,8BAA8B;QAC9B,MAAM,oBAAoB,GAAG,+BAA+B,CAAC,yBAAyB,CAAC,CAAC;QAExF,8DAA8D;QAC9D,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;QACjD,MAAM,oBAAoB,GAAG,mBAAmB,CAC9C,oBAAoB,EACpB,gBAAgB,EAChB,UAAU,EACV,iBAAiB,EACjB,IAAI,CAAC,wBAAwB,CAC9B,CAAC;QAEF,wEAAwE;QACxE,
|
|
1
|
+
{"version":3,"file":"endorsement-manager.js","sourceRoot":"","sources":["../../client/endorsement-manager.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EACL,mBAAmB,EACnB,+BAA+B,EAC/B,eAAe,EACf,kBAAkB,EAClB,mBAAmB,GACpB,MAAM,uDAAuD,CAAC;AAC/D,OAAO,EACL,mBAAmB,EACnB,qBAAqB,GAEtB,MAAM,kDAAkD,CAAC;AAI1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,2BAA2B,EAAgB,MAAM,WAAW,CAAC;AAUtE,MAAM,qCAAqC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC;AAqC1D,MAAM,OAAO,kBAAkB;IAEV,KAAK;IACL,wBAAwB;IACxB,MAAM;IAHzB,YACmB,KAA4B,EAC5B,wBAA6C,EAC7C,MAAM,GAAsB,2BAA2B;qBAFvD,KAAK;wCACL,wBAAwB;sBACxB,MAAM;IACtB,CAAC;IAEJ;;OAEG;IACH,8BAA8B,CAC5B,QAA6B;QAE7B,IACE,CAAC,iBAAiB,CAChB,IAAI,CAAC,wBAAwB,CAAC,EAAE,CAAC,OAAO,EAAE,EAC1C,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,CACtB,EACD,CAAC;YACD,MAAM,IAAI,KAAK,CACb,0EAA0E,CAC3E,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,YAAY,CAAC,UAAkB;QAC7B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;QAC1C,OAAO,UAAU,GAAG,GAAG,GAAG,qCAAqC,CAAC;IAClE,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,UAAkB;QAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;QAC1C,OAAO,GAAG,IAAI,UAAU,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,2BAA2B,CAC/B,OAAe,EACf,yBAAqC,EACrC,gBAA6B,EAC7B,aAAuB,EACvB,WAAmB,EACnB,iBAAoC;QAEpC,IAAI,gBAAgB,CAAC,MAAM,KAAK,aAAa,CAAC,MAAM,EAAE,CAAC;YACrD,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAC;QAClF,CAAC;QAED,8BAA8B;QAC9B,MAAM,oBAAoB,GAAG,+BAA+B,CAAC,yBAAyB,CAAC,CAAC;QAExF,8DAA8D;QAC9D,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;QACjD,MAAM,oBAAoB,GAAG,mBAAmB,CAC9C,oBAAoB,EACpB,gBAAgB,EAChB,UAAU,EACV,iBAAiB,EACjB,IAAI,CAAC,wBAAwB,CAC9B,CAAC;QAEF,wEAAwE;QACxE,wEAAwE;QACxE,uEAAuE;QACvE,8BAA8B;QAC9B,MAAM,cAAc,GAAG,IAAI,GAAG,EAAmC,CAAC;QAClE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,gBAAgB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACjD,MAAM,MAAM,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;YAChC,sDAAsD;YACtD,IAAI,MAAM,KAAK,WAAW,EAAE,CAAC;gBAC3B,SAAS;YACX,CAAC;YACD,MAAM,UAAU,GAAG,oBAAoB,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC;YAClE,cAAc,CAAC,GAAG,CAAC,MAAM,EAAE;gBACzB,WAAW,EAAE,UAAU,CAAC,CAAC;gBACzB,QAAQ,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,IAAI;aACnC,CAAC,CAAC;QACL,CAAC;QAED,iDAAiD;QACjD,MAAM,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,OAAO,EAAE,cAAc,EAAE,oBAAoB,CAAC,UAAU,CAAC,CAAC;QAE7F,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gCAAgC,EAAE;YAClD,QAAQ,EAAE,MAAM;YAChB,IAAI,EAAE;gBACJ,OAAO;gBACP,WAAW,EAAE,gBAAgB,CAAC,MAAM;gBACpC,WAAW,EAAE,cAAc,CAAC,IAAI;gBAChC,UAAU,EAAE,oBAAoB,CAAC,UAAU;aAC5C;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,oBAAoB,CACxB,OAAe,EACf,eAAuB,EACvB,iBAAqC;QAMrC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;QAC/D,IAAI,CAAC,MAAM;YAAE,OAAO,IAAI,CAAC;QAEzB,kDAAkD;QAClD,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;YACtC,MAAM,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;YAC5C,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QACvD,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,wEAAwE;YACxE,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACvB,oDAAoD;YACpD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,+DAA+D;QAC/D,MAAM,UAAU,GAAG,IAAI,qBAAqB,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAChE,MAAM,WAAW,GAAG,UAAU,CAAC,UAAU,EAAE,CAAC;QAC5C,MAAM,SAAS,GAAG,mBAAmB,CAAC,wBAAwB,CAC5D,iBAAiB,CAAC,aAAa,CAAC,EAAE,CACnC,CAAC;QACF,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAChD,MAAM,SAAS,GAAG,eAAe,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC;QAC1E,OAAO;YACL,KAAK,EAAE,kBAAkB,CAAC,SAAS,CAAC;YACpC,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,QAAQ,EAAE,KAAK,CAAC,QAAQ;SACzB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAAe,EACf,gBAA0B,EAC1B,iBAAqC;QAMrC,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QAE/C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;QAC/D,IAAI,CAAC,MAAM;YAAE,OAAO,IAAI,CAAC;QAEzB,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;YACtC,MAAM,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;YAC5C,OAAO,IAAI,CAAC;QACd,CAAC;QAED,iEAAiE;QACjE,MAAM,YAAY,GAAkB,EAAE,CAAC;QACvC,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAAsB,CAAC;QACvD,KAAK,MAAM,MAAM,IAAI,gBAAgB,EAAE,CAAC;YACtC,MAAM,KAAK,GAAG,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YAC9C,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,mEAAmE;gBACnE,wEAAwE;gBACxE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,oDAAoD,EAAE;oBACtE,QAAQ,EAAE,MAAM;oBAChB,IAAI,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE;iBAC1B,CAAC,CAAC;gBACH,OAAO,IAAI,CAAC;YACd,CAAC;YACD,MAAM,UAAU,GAAG,IAAI,qBAAqB,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;YAChE,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC,CAAC;YAC3C,gBAAgB,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC/C,CAAC;QAED,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACvB,oDAAoD;YACpD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,0CAA0C;QAC1C,MAAM,QAAQ,GAAG,mBAAmB,CAAC,YAAY,CAAC,CAAC;QAEnD,qCAAqC;QACrC,MAAM,SAAS,GAAG,mBAAmB,CAAC,wBAAwB,CAC5D,iBAAiB,CAAC,aAAa,CAAC,EAAE,CACnC,CAAC;QACF,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC7C,MAAM,SAAS,GAAG,eAAe,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC;QAC1E,OAAO;YACL,KAAK,EAAE,kBAAkB,CAAC,SAAS,CAAC;YACpC,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,gBAAgB;SACjB,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,wBAAwB,CAAC,OAAe,EAAE,aAAuB;QACrE,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,KAAK,CAAC;QAE7C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;QAC/D,IAAI,CAAC,MAAM;YAAE,OAAO,IAAI,CAAC,CAAC,sCAAsC;QAEhE,KAAK,MAAM,MAAM,IAAI,aAAa,EAAE,CAAC;YACnC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;gBACrC,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,yBAAyB,CAC7B,OAAe,EACf,aAAuB;QAKvB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;QAE/D,+BAA+B;QAC/B,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC;QACzD,CAAC;QAED,wCAAwC;QACxC,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;YACzC,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC;QACzD,CAAC;QAED,oDAAoD;QACpD,KAAK,MAAM,MAAM,IAAI,aAAa,EAAE,CAAC;YACnC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;gBACrC,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC;YAC3D,CAAC;QACH,CAAC;QAED,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC;IACjC,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,sBAAsB,CAAC,OAAe;QAC1C,MAAM,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,mBAAmB,CAAC,OAAe;QACvC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;QAC/D,OAAO,MAAM,EAAE,UAAU,IAAI,IAAI,CAAC;IACpC,CAAC;CACF"}
|