@open-e2ee/signal-protocol-sdk 0.2.2 → 0.3.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 +17 -16
- package/CHANGELOG.md +49 -0
- package/COMMERCIAL.md +6 -6
- package/NOTICE +1 -1
- package/README.md +44 -34
- package/SECURITY.md +16 -13
- package/TROUBLESHOOTING.md +5 -5
- package/blocking/README.md +6 -5
- package/client/README.md +5 -5
- package/device/README.md +8 -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/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 +22 -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 -25
- package/dist/internal/sesame/types.d.ts.map +1 -1
- package/dist/internal/sesame/types.js +2 -2
- 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 -11
- package/dist/media/index.js +9 -9
- 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 +4 -4
- package/dist/remote/relay/convex/backend.js +3 -3
- package/dist/remote/relay/convex/backend.js.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.map +1 -1
- package/dist/remote/relay/convex/component/messages.js +89 -82
- 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.js +25 -24
- 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.map +1 -1
- package/dist/utils/retry.js +2 -4
- package/dist/utils/retry.js.map +1 -1
- package/docs/ASSURANCE.md +82 -74
- package/docs/CLIENT_COMPOSITION.md +19 -15
- package/docs/DEVIATIONS.md +507 -425
- package/docs/DOCUMENTATION_STANDARDS.md +24 -24
- package/docs/E2EE.md +45 -42
- package/docs/ERROR_HANDLING.md +29 -105
- package/docs/GETTING_STARTED.md +24 -25
- package/docs/INTERFACES.md +27 -18
- package/docs/PACKAGE_SURFACE.md +23 -21
- package/docs/PROTOCOL_POLICY.md +19 -13
- package/docs/RECIPES.md +4 -4
- package/docs/SECURITY.md +72 -60
- package/encoding/README.md +2 -2
- package/files/README.md +1 -1
- package/groups/README.md +4 -3
- package/hooks/README.md +2 -2
- package/keys/README.md +15 -14
- package/local/store/README.md +82 -67
- package/local/store/expo/README.md +17 -12
- package/local/store/memory/README.md +4 -3
- package/local/store/node/README.md +8 -6
- package/local/store/react-native/README.md +14 -12
- package/local/store/web/README.md +31 -26
- package/local/vault/README.md +4 -4
- package/media/README.md +6 -5
- package/package.json +2 -2
- package/profile/README.md +7 -7
- package/remote/README.md +20 -18
- package/remote/object-store/README.md +8 -4
- package/remote/object-store/convex-r2/README.md +3 -3
- package/remote/object-store/s3/README.md +10 -5
- package/remote/relay/convex/README.md +5 -5
- package/remote/relay/convex/component/README.md +145 -124
- package/remote/relay/memory/README.md +6 -5
- package/safety/README.md +1 -1
- package/sealed-sender/README.md +3 -2
- package/types/README.md +1 -1
- package/utils/README.md +4 -4
|
@@ -31,10 +31,14 @@ const remoteObjectStore: SignalProtocolRemoteObjectStore = {
|
|
|
31
31
|
};
|
|
32
32
|
```
|
|
33
33
|
|
|
34
|
-
The backend must
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
34
|
+
The backend must:
|
|
35
|
+
|
|
36
|
+
- scope `requestId` to the authenticated principal
|
|
37
|
+
- return the same reservation for retries
|
|
38
|
+
- generate the canonical `objectId`
|
|
39
|
+
- keep the provider key private
|
|
40
|
+
- enforce size and content-type policy
|
|
41
|
+
- authorize every download, completion, and deletion
|
|
38
42
|
|
|
39
43
|
Provider adapters:
|
|
40
44
|
|
|
@@ -69,10 +69,10 @@ export const {
|
|
|
69
69
|
|
|
70
70
|
The callbacks must authenticate and authorize each operation and persist the
|
|
71
71
|
`requestId -> objectId -> providerKey` mapping. The helper derives expiry from
|
|
72
|
-
the actual signed operation
|
|
73
|
-
checks the reserved content type and byte length before completion.
|
|
72
|
+
the actual signed operation and synchronizes provider metadata in an action. It
|
|
73
|
+
also checks the reserved content type and byte length before completion.
|
|
74
74
|
|
|
75
|
-
Deletion is asynchronous at the provider boundary
|
|
75
|
+
Deletion is asynchronous at the provider boundary. The public mutation
|
|
76
76
|
atomically records the application removal and asks the R2 component to schedule
|
|
77
77
|
its retried deletion action. Applications that need confirmed physical removal
|
|
78
78
|
must track that completion separately.
|
|
@@ -24,11 +24,16 @@ const remoteObjectStore = s3ObjectStore({
|
|
|
24
24
|
});
|
|
25
25
|
```
|
|
26
26
|
|
|
27
|
-
The broker must
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
27
|
+
The broker must:
|
|
28
|
+
|
|
29
|
+
- authenticate the caller
|
|
30
|
+
- make upload reservation idempotent
|
|
31
|
+
- generate opaque object identifiers and private provider keys
|
|
32
|
+
- restrict signed operations to the reserved key and expected method
|
|
33
|
+
- enforce content length and content type
|
|
34
|
+
|
|
35
|
+
Bucket names, credentials, and unrestricted SDK clients must not cross into the
|
|
36
|
+
application client.
|
|
32
37
|
|
|
33
38
|
See the [object-store guide](../README.md) and
|
|
34
39
|
[media guide](../../../media/README.md).
|
|
@@ -6,8 +6,9 @@ to `ISignalProtocolRelayServer`.
|
|
|
6
6
|
## Why it exists
|
|
7
7
|
|
|
8
8
|
Convex generated references retain precise query and mutation types but do not
|
|
9
|
-
implement the SDK relay contract directly. The adapter
|
|
10
|
-
|
|
9
|
+
implement the SDK relay contract directly. The adapter maps those references
|
|
10
|
+
onto the contract on the client, and leaves backend registration and policy in
|
|
11
|
+
the application.
|
|
11
12
|
|
|
12
13
|
## Ownership boundary
|
|
13
14
|
|
|
@@ -48,9 +49,8 @@ without widening the generated references.
|
|
|
48
49
|
|
|
49
50
|
To serve groups from this deployment, also mount the
|
|
50
51
|
[Convex Signal Protocol component](./component/README.md) inside the same namespace
|
|
51
|
-
(`convex/signal/groups.ts` and `convex/signal/zkAuth.ts`)
|
|
52
|
-
advertises its `groupServer` capability only when both modules
|
|
53
|
-
configured.
|
|
52
|
+
(`convex/signal/groups.ts` and `convex/signal/zkAuth.ts`). The relay
|
|
53
|
+
advertises its `groupServer` capability only when you configure both modules.
|
|
54
54
|
|
|
55
55
|
Public-key reads may be available to authenticated peers, but every write must
|
|
56
56
|
derive ownership from server-side authentication rather than trusting a
|
|
@@ -1,11 +1,16 @@
|
|
|
1
1
|
# Convex Signal Protocol component
|
|
2
2
|
|
|
3
|
-
This installable Convex component owns the complete relay backend:
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
3
|
+
This installable Convex component owns the complete relay backend:
|
|
4
|
+
|
|
5
|
+
- account and device registration
|
|
6
|
+
- identity and prekey storage
|
|
7
|
+
- message queues, sealed-sender delivery, and retry requests
|
|
8
|
+
- provisioning and sender certificates
|
|
9
|
+
- canonical encrypted group state and anonymous group authorization
|
|
10
|
+
- credential issuance and group-send endorsements
|
|
11
|
+
|
|
12
|
+
The app owns only its authentication-to-protocol-identity mapping and thin
|
|
13
|
+
public wrappers.
|
|
9
14
|
|
|
10
15
|
## Install the component
|
|
11
16
|
|
|
@@ -26,11 +31,11 @@ app.use(signalProtocol, {
|
|
|
26
31
|
export default app;
|
|
27
32
|
```
|
|
28
33
|
|
|
29
|
-
The `env` forwarding is load-bearing
|
|
30
|
-
app's environment variables
|
|
31
|
-
deployment's `OE_GROUPS_SERVER_SECRET
|
|
32
|
-
and sender-certificate call fails at runtime. The
|
|
33
|
-
provisioning namespaces work without the secret.
|
|
34
|
+
The `env` forwarding is load-bearing. Convex isolates each component from the
|
|
35
|
+
app's environment variables. Without the forwarding, the component cannot see
|
|
36
|
+
the deployment's `OE_GROUPS_SERVER_SECRET`, and every group,
|
|
37
|
+
credential-issuance, and sender-certificate call fails at runtime. The
|
|
38
|
+
messaging, device, key, and provisioning namespaces work without the secret.
|
|
34
39
|
|
|
35
40
|
The component owns these isolated tables. They do not appear in the app schema
|
|
36
41
|
and need no package-specific prefixes:
|
|
@@ -49,14 +54,13 @@ and need no package-specific prefixes:
|
|
|
49
54
|
- `groups`, `groupChanges`, and `groupSnapshots`: canonical encrypted group
|
|
50
55
|
state, immutable signed changes, and per-version signed snapshots.
|
|
51
56
|
|
|
52
|
-
The component derives **no** membership map from group state.
|
|
53
|
-
|
|
54
|
-
`groupChanges`, and `groupSnapshots` never name an account, and
|
|
55
|
-
`getGroupMembers` endpoint
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
`getActiveDevices`.
|
|
57
|
+
The component derives **no** membership map from group state. Zero-knowledge
|
|
58
|
+
presentations authorize every group read and write. Therefore `groups`,
|
|
59
|
+
`groupChanges`, and `groupSnapshots` never name an account, and the relay
|
|
60
|
+
surface has no `getGroupMembers` endpoint. Membership is local-first. Each
|
|
61
|
+
client resolves fan-out recipients from its own decrypted group state and
|
|
62
|
+
passes their user IDs with the send (`SendOptions.groupMemberUserIds`). The
|
|
63
|
+
relay expands users to devices through `getActiveDevices`.
|
|
60
64
|
|
|
61
65
|
See [Group metadata privacy](#group-metadata-privacy) for what the relay can
|
|
62
66
|
still infer from delivery traffic. The absence of a membership endpoint is not
|
|
@@ -65,15 +69,19 @@ by itself a metadata-privacy guarantee.
|
|
|
65
69
|
The mounted `@convex-dev/rate-limiter` child component separately owns its
|
|
66
70
|
isolated `rateLimits` table.
|
|
67
71
|
|
|
68
|
-
The tables store
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
+
The tables store:
|
|
73
|
+
|
|
74
|
+
- the latest canonical encrypted state
|
|
75
|
+
- the exact accepted and signed action bytes
|
|
76
|
+
- every historical encrypted snapshot with its cached S14 baseline signature
|
|
77
|
+
|
|
78
|
+
They never store the group master key, group secret parameters, plaintext group
|
|
79
|
+
attributes, or the server secret.
|
|
72
80
|
|
|
73
81
|
Storage grows with one full encrypted snapshot per accepted version and is
|
|
74
82
|
never pruned. Old snapshots are load-bearing: `getGroupChanges` serves signed
|
|
75
83
|
history from them, so deleting rows breaks catch-up for clients behind that
|
|
76
|
-
version. A snapshot-compaction protocol is future work
|
|
84
|
+
version. A snapshot-compaction protocol is future work. Budget storage as
|
|
77
85
|
O(versions × state size) per group.
|
|
78
86
|
|
|
79
87
|
## Mount the public wrappers
|
|
@@ -198,13 +206,15 @@ export const {
|
|
|
198
206
|
} = signalRelay.provisioning;
|
|
199
207
|
```
|
|
200
208
|
|
|
201
|
-
`messages` owns identified and sealed delivery, multi-recipient fan-out,
|
|
202
|
-
queues, and message/device lookup reads.
|
|
203
|
-
connection state, and presence.
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
209
|
+
- `messages` owns identified and sealed delivery, multi-recipient fan-out,
|
|
210
|
+
retry queues, and message/device lookup reads.
|
|
211
|
+
- `devices` owns registration, removal, connection state, and presence.
|
|
212
|
+
- `keys` owns identity provisioning and compare-and-swap rotation, prekey
|
|
213
|
+
upload, atomic one-time-key consumption, and key metadata.
|
|
214
|
+
- `certificates` issues sender certificates for registered account/device
|
|
215
|
+
identities.
|
|
216
|
+
- `provisioning` owns the linked-device session state machine through
|
|
217
|
+
acknowledgment or rollback.
|
|
208
218
|
|
|
209
219
|
The account-scoped wrappers resolve the caller identity on the server and
|
|
210
220
|
inject the application `userId`, raw ACI, and optional PNI bytes into the
|
|
@@ -216,28 +226,28 @@ the supplied zero-knowledge presentation.
|
|
|
216
226
|
`sendUnidentified` and `sendMultiRecipientUnidentified` are the deliberate
|
|
217
227
|
exception: those sealed-sender paths do **not** call `identify`. They authorize
|
|
218
228
|
the bearer request with the target's unidentified-access key or verified group
|
|
219
|
-
send material,
|
|
220
|
-
session. Rejections
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
falls back to identified delivery
|
|
229
|
+
send material, which keeps delivery available without an authenticated
|
|
230
|
+
application session. Rejections carry structured `ConvexError` data. The relay
|
|
231
|
+
adapter reads `data.code === 'UNAUTHORIZED'` to decide the fallback to
|
|
232
|
+
identified delivery, and never matches on the message text. A deployment that
|
|
233
|
+
wraps or re-throws component rejections must preserve `code`. If it drops
|
|
234
|
+
`code`, a sealed send that must retry on the identified path surfaces as a hard
|
|
235
|
+
failure instead.
|
|
236
|
+
|
|
237
|
+
The zero-knowledge profile-key credential flow
|
|
238
|
+
(`issueProfileKeyCredentialMutation`) registers a recipient's
|
|
239
|
+
unidentified-access key as a side effect. Until a recipient completes that flow,
|
|
240
|
+
the component rejects access-key-authorized sealed sends to them, and the client
|
|
241
|
+
falls back to identified delivery. Messages still arrive, but without sender
|
|
232
242
|
anonymity. Deployments that want sealed sender for 1:1 messaging must drive
|
|
233
243
|
the profile-key credential flow during account setup, not lazily.
|
|
234
244
|
|
|
235
245
|
`identify` must return the authenticated account's real ACI, and its real PNI
|
|
236
246
|
or **no PNI at all**, plus the application-owned `userId` used for relay
|
|
237
247
|
routing. Never substitute a shared placeholder value for accounts without a
|
|
238
|
-
PNI
|
|
239
|
-
every account would let any authenticated user act on any
|
|
240
|
-
membership. An absent PNI must be absent.
|
|
248
|
+
PNI. The credential layer matches by ACI-or-PNI alias. A constant PNI issued to
|
|
249
|
+
every account would therefore let any authenticated user act on any
|
|
250
|
+
PNI-addressed pending membership. An absent PNI must be absent.
|
|
241
251
|
|
|
242
252
|
## Retention and rate limiting
|
|
243
253
|
|
|
@@ -247,11 +257,11 @@ minute, and stale KEM prekeys daily. Cleanup mutations delete bounded batches
|
|
|
247
257
|
and schedule immediate continuations until the indexed range is empty.
|
|
248
258
|
|
|
249
259
|
Completing a provisioning session grants the acknowledgment its own full
|
|
250
|
-
session TTL.
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
`linkedAt` stamp recorded at completion
|
|
254
|
-
|
|
260
|
+
session TTL. The cron rolls back a link that nobody acknowledges within that
|
|
261
|
+
window. It deletes the device the link created, together with all of its key
|
|
262
|
+
material, queued messages, and heartbeats. Teardown matches the device's
|
|
263
|
+
`linkedAt` stamp recorded at completion. A stale session therefore never reaps
|
|
264
|
+
a device that a legitimate re-registration put into the freed slot.
|
|
255
265
|
|
|
256
266
|
Prekey-bundle fetches use the mounted `@convex-dev/rate-limiter` child
|
|
257
267
|
component. Each authenticated fetcher/target-account pair receives ten fetches
|
|
@@ -264,35 +274,35 @@ This version drops two shapes from the `messages` table: the optional
|
|
|
264
274
|
`groupId` field, and `plaintext_content` from the `messageType` union.
|
|
265
275
|
|
|
266
276
|
Convex validates every existing document against the new schema **during the
|
|
267
|
-
push**, before any of your code runs. A stored row carrying a `groupId`, or
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
second.
|
|
277
|
+
push**, before any of your code runs. A stored row carrying a `groupId`, or one
|
|
278
|
+
whose `messageType` is `plaintext_content`, therefore fails the deploy. No
|
|
279
|
+
migration mutation can fix it, because the deploy that would ship the mutation
|
|
280
|
+
is the deploy that fails. The order has to be: clear first, deploy second.
|
|
272
281
|
|
|
273
282
|
Messages are transient by design. The table has a seven-day TTL and an hourly
|
|
274
|
-
cleanup cron
|
|
275
|
-
|
|
283
|
+
cleanup cron. Clients re-request undelivered messages through the retry path,
|
|
284
|
+
so clearing the table is a normal operation rather than data loss.
|
|
276
285
|
|
|
277
|
-
Check whether the deployment has anything to clear
|
|
278
|
-
version,
|
|
286
|
+
Check whether the deployment has anything to clear. Run the check while the
|
|
287
|
+
deployment is still on the previous version, because the table lives inside the
|
|
288
|
+
component rather than the app:
|
|
279
289
|
|
|
280
290
|
```sh
|
|
281
291
|
npx convex data messages --component signalProtocol
|
|
282
292
|
```
|
|
283
293
|
|
|
284
294
|
Add `--prod` or `--deployment <name-or-reference>` to target a deployment other
|
|
285
|
-
than your dev one. A deployment that
|
|
286
|
-
|
|
287
|
-
action
|
|
295
|
+
than your dev one. A deployment that never relayed a group message, and never
|
|
296
|
+
had a caller pass `plaintext_content`, has no affected rows and needs no
|
|
297
|
+
action. No send path in this SDK ever produced the latter.
|
|
288
298
|
|
|
289
299
|
If there are rows, either wait or clear:
|
|
290
300
|
|
|
291
|
-
- **Wait
|
|
301
|
+
- **Wait**. Stop sending, and the hourly cleanup cron drains the table as the
|
|
292
302
|
seven-day retention window expires. No manual step, but it takes a week.
|
|
293
|
-
- **Clear
|
|
294
|
-
open the `messages` table, and clear it. Undelivered messages are lost
|
|
295
|
-
|
|
303
|
+
- **Clear**. In the Convex dashboard, select the `signalProtocol` component,
|
|
304
|
+
open the `messages` table, and clear it. Undelivered messages are lost.
|
|
305
|
+
Clients re-request them over the retry path.
|
|
296
306
|
|
|
297
307
|
Deploy once the table is empty.
|
|
298
308
|
|
|
@@ -305,11 +315,16 @@ npx oe-groups trust-root
|
|
|
305
315
|
```
|
|
306
316
|
|
|
307
317
|
Add `--prod` for the default production deployment or
|
|
308
|
-
`--deployment <name-or-reference>` for another deployment. The command
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
318
|
+
`--deployment <name-or-reference>` for another deployment. The command:
|
|
319
|
+
|
|
320
|
+
- checks `OE_GROUPS_SERVER_SECRET`
|
|
321
|
+
- generates a cryptographically random 32-byte seed only when the secret is
|
|
322
|
+
absent
|
|
323
|
+
- writes the seed to the selected Convex deployment through stdin
|
|
324
|
+
- prints two labelled base64 roots: the serialized group trust root and the
|
|
325
|
+
Ed25519 sender-certificate root
|
|
326
|
+
|
|
327
|
+
Pin both in the client build. See
|
|
313
328
|
[Sender certificate trust root](#sender-certificate-trust-root) for where each
|
|
314
329
|
one goes. Never fetch and trust either at runtime.
|
|
315
330
|
|
|
@@ -333,53 +348,56 @@ group trust root: <base64>
|
|
|
333
348
|
sealed sender trust root: <base64>
|
|
334
349
|
```
|
|
335
350
|
|
|
336
|
-
|
|
351
|
+
The two roots go in different places and are not interchangeable. The group
|
|
337
352
|
trust root goes into the group configuration, and the sealed-sender root into
|
|
338
|
-
`sealedSender.trustRoots` in the client build. Pin both at build time
|
|
339
|
-
fetch either from a relay at runtime,
|
|
340
|
-
|
|
353
|
+
`sealedSender.trustRoots` in the client build. Pin both at build time. Never
|
|
354
|
+
fetch either from a relay at runtime, because a relay that chooses its own
|
|
355
|
+
validation root can mint certificates for any sender.
|
|
341
356
|
|
|
342
|
-
|
|
357
|
+
The component derives both from the same deployment secret, so rotating
|
|
343
358
|
`OE_GROUPS_SERVER_SECRET` rotates both and strands clients pinned to either
|
|
344
359
|
previous value.
|
|
345
360
|
|
|
346
|
-
With `trustRoots` left empty, inbound sealed-sender validation stays disabled
|
|
347
|
-
and sends fall back to identified delivery
|
|
348
|
-
|
|
361
|
+
With `trustRoots` left empty, inbound sealed-sender validation stays disabled,
|
|
362
|
+
and sends fall back to identified delivery. Messages still arrive, but they
|
|
363
|
+
disclose the sender to the relay.
|
|
349
364
|
|
|
350
365
|
## Group metadata privacy
|
|
351
366
|
|
|
352
|
-
The relay cannot read message contents
|
|
353
|
-
state
|
|
354
|
-
carry one.
|
|
367
|
+
The relay cannot read message contents and cannot derive membership from group
|
|
368
|
+
state. It also no longer sees a group identifier on the two channels that used
|
|
369
|
+
to carry one.
|
|
355
370
|
|
|
356
|
-
**Closed: the distribution identifier in the frame
|
|
371
|
+
**Closed: the distribution identifier in the frame**. The identified send path
|
|
357
372
|
stores the framed `SenderKeyMessage` as its `ciphertext`, and that frame's
|
|
358
373
|
`distributionUuid` is **not** encrypted. It used to embed
|
|
359
|
-
`groupId:senderUserId:senderDeviceId:timestamp
|
|
360
|
-
device were readable straight out of the ciphertext column
|
|
361
|
-
column, off every message in flight to any relay on
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
374
|
+
`groupId:senderUserId:senderDeviceId:timestamp`. The group and the sender's
|
|
375
|
+
device were therefore readable straight out of the ciphertext column. Worse
|
|
376
|
+
than a column, they were readable off every message in flight to any relay on
|
|
377
|
+
the path.
|
|
378
|
+
|
|
379
|
+
Sealed sender did not help. It hides the frame from the relay, but not from the
|
|
380
|
+
rest of the path. The component also keeps sealed sender disabled until you
|
|
381
|
+
export the trust root (see above), so group traffic takes the identified path
|
|
382
|
+
anyway. Distribution identifiers are now opaque random UUIDs carrying no group,
|
|
383
|
+
sender, device, or clock, as the reference implementation uses, as the
|
|
384
|
+
sender-keys specification now requires.
|
|
385
|
+
|
|
386
|
+
**Closed: the `groupId` column**. Every `messages` row used to store a plaintext
|
|
369
387
|
`groupId` next to `targetUserId` for the seven-day retention window. The column
|
|
370
|
-
is gone
|
|
371
|
-
receiver to decrypt the payload as a framed `SenderKeyMessage` and nothing
|
|
372
|
-
|
|
373
|
-
resolves the group against its own sender key store. No group identifier
|
|
388
|
+
is gone, and a `sender_key` message type replaces it. The type tells the
|
|
389
|
+
receiver to decrypt the payload as a framed `SenderKeyMessage` and nothing
|
|
390
|
+
more. The receiver reads the opaque distribution identifier out of the frame
|
|
391
|
+
and resolves the group against its own sender key store. No group identifier
|
|
374
392
|
travels on an envelope, sealed or not.
|
|
375
393
|
|
|
376
|
-
**Open: the group partition itself
|
|
394
|
+
**Open: the group partition itself**. Removing the identifier removed the
|
|
377
395
|
group's *name*, not the ability to group rows. Be precise about what is left,
|
|
378
396
|
because the difference matters and it is easy to overstate:
|
|
379
397
|
|
|
380
|
-
- The frame
|
|
381
|
-
`messages.ciphertext
|
|
382
|
-
|
|
398
|
+
- The frame leaves `distributionUuid` unencrypted, and the row stores it
|
|
399
|
+
verbatim inside `messages.ciphertext`. The paragraph above says as much. It
|
|
400
|
+
is opaque, but stable for the life of a sender key. Nothing rotates keys on a
|
|
383
401
|
timer. Grouping rows by it recovers the recipient set for a sender's group
|
|
384
402
|
traffic.
|
|
385
403
|
- Sender keys encrypt once and fan out, so every recipient row of one send
|
|
@@ -388,17 +406,18 @@ because the difference matters and it is easy to overstate:
|
|
|
388
406
|
- The fan-out stamps one `timestamp` across every recipient row, and passes
|
|
389
407
|
through one `clientMessageId` when the application supplies one.
|
|
390
408
|
- `sendMultiRecipientUnidentified` hands the relay the roster explicitly, in
|
|
391
|
-
one call
|
|
409
|
+
one call. The sealed-sender path names the recipient set outright.
|
|
392
410
|
|
|
393
411
|
So the relay cannot learn *which* group, or its name, membership list, or
|
|
394
|
-
attributes
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
412
|
+
attributes. It can still partition delivery pairs into unlabeled groups, and
|
|
413
|
+
any one of those channels suffices. That is a real improvement on a plaintext
|
|
414
|
+
`groupId`, which handed over a stable, meaningful, cross-send label. It is not
|
|
415
|
+
anonymity of the partition. The `sender_key` type is also a single-column
|
|
416
|
+
filter that isolates group traffic from pairwise traffic. The old design did
|
|
417
|
+
not offer that filter, because group messages used to hide among `ciphertext`
|
|
418
|
+
rows.
|
|
419
|
+
|
|
420
|
+
**Still visible**. Delivery metadata itself: who sent to whom, when, and how
|
|
402
421
|
much. Every relay sees this. Sealed sender removes the sender from the
|
|
403
422
|
identified half of it.
|
|
404
423
|
|
|
@@ -406,18 +425,20 @@ identified half of it.
|
|
|
406
425
|
|
|
407
426
|
`identify` maps an authenticated session to an account (`userId`), with no
|
|
408
427
|
device. Every account-scoped endpoint therefore authorizes at account
|
|
409
|
-
granularity, and the `deviceId`
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
428
|
+
granularity, and the caller chooses each `deviceId` argument as a route
|
|
429
|
+
selector rather than an authenticated claim. Concretely, any session for an
|
|
430
|
+
account can:
|
|
431
|
+
|
|
432
|
+
- read and delete **any** of that account's device queues
|
|
433
|
+
(`getPendingMessages`, `markDelivered`)
|
|
434
|
+
- send as any of its device IDs (`send.senderDeviceId`)
|
|
435
|
+
- upload or rotate key material for any of its devices (`keys`)
|
|
436
|
+
|
|
437
|
+
This is the intended model, because a compromised session already holds the
|
|
438
|
+
account. It does mean that the component provides no isolation *between* an
|
|
439
|
+
account's own devices. Deployments that need device isolation must issue
|
|
440
|
+
device-scoped sessions and enforce the binding in their own `identify` wrapper.
|
|
441
|
+
The component cannot do it while its identity has no device field.
|
|
421
442
|
|
|
422
443
|
## Profile-key issuance threat model
|
|
423
444
|
|
|
@@ -3,7 +3,8 @@
|
|
|
3
3
|
`InMemorySignalProtocolRelayServer` implements `ISignalProtocolRelayServer` in memory for examples
|
|
4
4
|
and local application development.
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
The protocol and cryptography are real. The adapter simulates the
|
|
7
|
+
infrastructure in memory.
|
|
7
8
|
|
|
8
9
|
## Why it exists
|
|
9
10
|
|
|
@@ -29,8 +30,8 @@ await client.syncToServer();
|
|
|
29
30
|
```
|
|
30
31
|
|
|
31
32
|
All registered devices, public keys, mailboxes, and provisioning state disappear
|
|
32
|
-
with the adapter. It
|
|
33
|
-
abuse
|
|
33
|
+
with the adapter. It does not authenticate accounts, limit rates, prevent
|
|
34
|
+
abuse, or deliver durably. Never use it in production.
|
|
34
35
|
|
|
35
36
|
## Deterministic failure and recovery exercises
|
|
36
37
|
|
|
@@ -61,8 +62,8 @@ relay.failures.reconnect("bob", 1);
|
|
|
61
62
|
a scenario without rebuilding clients. Authorization rejection raises
|
|
62
63
|
`SealedSenderAuthError`, allowing the client's documented identified-delivery
|
|
63
64
|
fallback. One-time-prekey exhaustion withholds both EC and KEM one-time keys but
|
|
64
|
-
keeps the KEM last-resort key
|
|
65
|
-
post-quantum recovery path rather than a silent classical downgrade. Failure
|
|
65
|
+
keeps the KEM last-resort key. Strict-PQ examples therefore exercise the
|
|
66
|
+
intended post-quantum recovery path rather than a silent classical downgrade. Failure
|
|
66
67
|
selection uses the configured seed and delivery count, never `Math.random()` or
|
|
67
68
|
wall-clock time.
|
|
68
69
|
|
package/safety/README.md
CHANGED
|
@@ -35,7 +35,7 @@ Use the composite safety-number API for contact verification in this SDK
|
|
|
35
35
|
profile. The single-key helper is a lower-level reference primitive and does
|
|
36
36
|
not authenticate the complete composite identity.
|
|
37
37
|
|
|
38
|
-
The SDK creates comparison data
|
|
38
|
+
The SDK creates comparison data. The application owns QR rendering, scanning,
|
|
39
39
|
the verification user experience, and storage of the user's trust decision.
|
|
40
40
|
|
|
41
41
|
See the [keys guide](../keys/README.md) and
|
package/sealed-sender/README.md
CHANGED
|
@@ -6,8 +6,9 @@ that support authenticated sender-anonymous envelope delivery.
|
|
|
6
6
|
## Why it exists
|
|
7
7
|
|
|
8
8
|
A relay may need to authorize delivery without learning sender identity from
|
|
9
|
-
the outer request. The access key
|
|
10
|
-
|
|
9
|
+
the outer request. The module derives the access key from profile-key material.
|
|
10
|
+
A sender can present it through the relay's sealed-sender authorization
|
|
11
|
+
contract.
|
|
11
12
|
|
|
12
13
|
## Usage
|
|
13
14
|
|
package/types/README.md
CHANGED
|
@@ -25,7 +25,7 @@ const address = ProtocolAddress.create("bob", 1);
|
|
|
25
25
|
const encodedKey = asBase64(valueFromValidatedStorage);
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
-
TypeScript brands document validated representation
|
|
28
|
+
TypeScript brands document validated representation. They do not validate at
|
|
29
29
|
runtime by themselves. Use the provided validators or validate at the
|
|
30
30
|
untrusted boundary before applying a brand.
|
|
31
31
|
|
package/utils/README.md
CHANGED
|
@@ -26,11 +26,11 @@ const bundle = await withRetry(
|
|
|
26
26
|
);
|
|
27
27
|
```
|
|
28
28
|
|
|
29
|
-
`withRetry()` uses bounded exponential backoff with optional jitter.
|
|
30
|
-
protocol and identity failures
|
|
31
|
-
database-lock, and concurrency failures
|
|
29
|
+
`withRetry()` uses bounded exponential backoff with optional jitter. It does not
|
|
30
|
+
retry known protocol and identity failures. It does retry transient network,
|
|
31
|
+
timeout, database-lock, and concurrency failures.
|
|
32
32
|
|
|
33
|
-
|
|
33
|
+
Retry only a read-only or idempotent operation. The caller
|
|
34
34
|
must not wrap an arbitrary mutation without an idempotency contract.
|
|
35
35
|
|
|
36
36
|
See the [error-handling guide](../docs/ERROR_HANDLING.md) and
|