@open-e2ee/signal-protocol-sdk 0.1.0-alpha.1 → 0.1.0-alpha.10
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 +24 -24
- package/ARCHITECTURE.md +4 -4
- package/CHANGELOG.md +1319 -0
- package/COMMERCIAL.md +56 -0
- package/NOTICE +3 -1
- package/README.md +40 -35
- package/SECURITY.md +15 -1
- package/blocking/README.md +5 -5
- package/client/README.md +5 -5
- package/dist/blocking/index.d.ts +2 -2
- package/dist/blocking/index.d.ts.map +1 -1
- package/dist/blocking/index.js +1 -1
- package/dist/blocking/index.js.map +1 -1
- package/dist/blocking/manager.d.ts +7 -7
- package/dist/blocking/manager.d.ts.map +1 -1
- package/dist/blocking/manager.js +3 -3
- package/dist/blocking/manager.js.map +1 -1
- package/dist/blocking/types.d.ts +4 -4
- package/dist/blocking/types.d.ts.map +1 -1
- package/dist/blocking/types.js +1 -1
- package/dist/client/client.d.ts +48 -41
- package/dist/client/client.d.ts.map +1 -1
- package/dist/client/client.js +160 -101
- package/dist/client/client.js.map +1 -1
- package/dist/client/compose.d.ts +15 -10
- package/dist/client/compose.d.ts.map +1 -1
- package/dist/client/compose.js +2 -0
- package/dist/client/compose.js.map +1 -1
- package/dist/client/config.d.ts +68 -34
- package/dist/client/config.d.ts.map +1 -1
- package/dist/client/config.js.map +1 -1
- package/dist/client/content-adapter.d.ts +4 -4
- package/dist/client/content-adapter.d.ts.map +1 -1
- package/dist/client/content-adapter.js +1 -1
- package/dist/client/content-adapter.js.map +1 -1
- package/dist/client/dual-store.d.ts +5 -5
- package/dist/client/dual-store.d.ts.map +1 -1
- package/dist/client/dual-store.js.map +1 -1
- package/dist/client/endorsement-manager.d.ts +23 -2
- package/dist/client/endorsement-manager.d.ts.map +1 -1
- package/dist/client/endorsement-manager.js +37 -12
- package/dist/client/endorsement-manager.js.map +1 -1
- package/dist/client/event-hooks.d.ts +1 -1
- package/dist/client/groups.d.ts +29 -29
- package/dist/client/groups.d.ts.map +1 -1
- package/dist/client/groups.js +54 -37
- package/dist/client/groups.js.map +1 -1
- package/dist/client/headless.d.ts +12 -12
- package/dist/client/headless.d.ts.map +1 -1
- package/dist/client/headless.js +9 -9
- package/dist/client/headless.js.map +1 -1
- package/dist/client/index.d.ts +4 -4
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js +1 -1
- package/dist/client/index.js.map +1 -1
- package/dist/client/key-rotation-core.d.ts +11 -11
- package/dist/client/key-rotation-core.d.ts.map +1 -1
- package/dist/client/key-rotation-core.js +22 -22
- package/dist/client/key-rotation-core.js.map +1 -1
- package/dist/client/media.d.ts +2 -2
- package/dist/client/media.js +5 -5
- package/dist/client/media.js.map +1 -1
- package/dist/client/messages.js +2 -2
- package/dist/client/messages.js.map +1 -1
- package/dist/client/prekeys.js +1 -1
- package/dist/client/prekeys.js.map +1 -1
- package/dist/client/relay-subscription.d.ts +2 -2
- package/dist/client/relay-subscription.d.ts.map +1 -1
- package/dist/client/relay-subscription.js +18 -1
- package/dist/client/relay-subscription.js.map +1 -1
- package/dist/client/retry.js +1 -1
- package/dist/client/retry.js.map +1 -1
- package/dist/client/sealed-sender-ops.d.ts +28 -2
- package/dist/client/sealed-sender-ops.d.ts.map +1 -1
- package/dist/client/sealed-sender-ops.js +40 -10
- package/dist/client/sealed-sender-ops.js.map +1 -1
- package/dist/client/sessions.d.ts.map +1 -1
- package/dist/client/sessions.js +3 -0
- package/dist/client/sessions.js.map +1 -1
- package/dist/client/signal-service-cipher.d.ts +34 -11
- package/dist/client/signal-service-cipher.d.ts.map +1 -1
- package/dist/client/signal-service-cipher.js +149 -75
- package/dist/client/signal-service-cipher.js.map +1 -1
- package/dist/client/types.d.ts +28 -15
- package/dist/client/types.d.ts.map +1 -1
- package/dist/client/types.js.map +1 -1
- package/dist/device/connection.js +2 -2
- package/dist/device/connection.js.map +1 -1
- package/dist/device/device-id.d.ts.map +1 -1
- package/dist/device/device-id.js +4 -4
- package/dist/device/device-id.js.map +1 -1
- package/dist/device/provisioning.d.ts +5 -5
- package/dist/device/provisioning.d.ts.map +1 -1
- package/dist/device/provisioning.js +9 -9
- package/dist/device/provisioning.js.map +1 -1
- package/dist/device/transfer.d.ts.map +1 -1
- package/dist/device/transfer.js +14 -14
- package/dist/device/transfer.js.map +1 -1
- package/dist/files/index.d.ts +1 -1
- package/dist/files/index.js +1 -1
- package/dist/groups/index.d.ts +4 -4
- package/dist/groups/index.d.ts.map +1 -1
- package/dist/groups/index.js +3 -3
- package/dist/groups/index.js.map +1 -1
- package/dist/hooks/use-connection-presence.d.ts +5 -5
- package/dist/hooks/use-connection-presence.d.ts.map +1 -1
- package/dist/hooks/use-connection-presence.js +5 -5
- package/dist/hooks/use-connection-presence.js.map +1 -1
- package/dist/hooks/use-group-membership.d.ts +2 -2
- package/dist/hooks/use-key-rotation.js +2 -2
- package/dist/hooks/use-key-rotation.js.map +1 -1
- package/dist/index.d.ts +29 -22
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +20 -13
- package/dist/index.js.map +1 -1
- package/dist/internal/crypto/ec/x25519-validation.d.ts.map +1 -1
- package/dist/internal/crypto/ec/x25519-validation.js +4 -4
- package/dist/internal/crypto/ec/x25519-validation.js.map +1 -1
- package/dist/internal/crypto/index.d.ts +1 -1
- package/dist/internal/crypto/index.d.ts.map +1 -1
- package/dist/internal/crypto/index.js +2 -2
- package/dist/internal/crypto/index.js.map +1 -1
- package/dist/internal/crypto/kdf/hkdf.d.ts +1 -1
- package/dist/internal/crypto/kdf/hkdf.d.ts.map +1 -1
- package/dist/internal/crypto/kdf/hkdf.js +2 -2
- package/dist/internal/crypto/kdf/hkdf.js.map +1 -1
- package/dist/internal/crypto/key-prefix.d.ts +1 -1
- package/dist/internal/crypto/key-prefix.js +1 -1
- package/dist/internal/crypto/pq/kyber.d.ts +1 -1
- package/dist/internal/crypto/pq/kyber.js +1 -1
- package/dist/internal/crypto/random.d.ts +9 -0
- package/dist/internal/crypto/random.d.ts.map +1 -1
- package/dist/internal/crypto/random.js +16 -0
- package/dist/internal/crypto/random.js.map +1 -1
- package/dist/internal/crypto/symmetric/aes-gcm-siv.d.ts +1 -1
- package/dist/internal/crypto/symmetric/aes-gcm-siv.js +1 -1
- package/dist/internal/crypto/symmetric/mac.d.ts +3 -3
- package/dist/internal/crypto/symmetric/mac.js +3 -3
- package/dist/internal/crypto/utils.d.ts +2 -2
- package/dist/internal/crypto/utils.js +2 -2
- package/dist/internal/encoding/proto/envelope.d.ts +21 -21
- package/dist/internal/encoding/proto/envelope.d.ts.map +1 -1
- package/dist/internal/encoding/proto/envelope.js +25 -25
- package/dist/internal/encoding/proto/envelope.js.map +1 -1
- package/dist/internal/encoding/proto/index.d.ts +2 -2
- package/dist/internal/encoding/proto/index.d.ts.map +1 -1
- package/dist/internal/encoding/proto/index.js +3 -3
- package/dist/internal/encoding/proto/index.js.map +1 -1
- package/dist/internal/encoding/proto/pq-ratchet-serialize.d.ts +5 -5
- package/dist/internal/encoding/proto/pq-ratchet-serialize.d.ts.map +1 -1
- package/dist/internal/encoding/proto/pq-ratchet-serialize.js +4 -4
- package/dist/internal/encoding/proto/pq-ratchet-serialize.js.map +1 -1
- package/dist/internal/encoding/proto/primitives.d.ts +261 -6
- package/dist/internal/encoding/proto/primitives.d.ts.map +1 -1
- package/dist/internal/encoding/proto/primitives.js +468 -6
- package/dist/internal/encoding/proto/primitives.js.map +1 -1
- package/dist/internal/encoding/proto/sender-key-message.d.ts +4 -3
- package/dist/internal/encoding/proto/sender-key-message.d.ts.map +1 -1
- package/dist/internal/encoding/proto/sender-key-message.js +97 -76
- package/dist/internal/encoding/proto/sender-key-message.js.map +1 -1
- package/dist/internal/encoding/proto/signal-message.d.ts +39 -34
- package/dist/internal/encoding/proto/signal-message.d.ts.map +1 -1
- package/dist/internal/encoding/proto/signal-message.js +236 -152
- package/dist/internal/encoding/proto/signal-message.js.map +1 -1
- package/dist/internal/groups/access-control.d.ts +170 -0
- package/dist/internal/groups/access-control.d.ts.map +1 -0
- package/dist/internal/groups/access-control.js +284 -0
- package/dist/internal/groups/access-control.js.map +1 -0
- package/dist/internal/groups/change-actions.d.ts +57 -0
- package/dist/internal/groups/change-actions.d.ts.map +1 -0
- package/dist/internal/groups/change-actions.js +827 -0
- package/dist/internal/groups/change-actions.js.map +1 -0
- package/dist/internal/groups/change-authorization.d.ts +16 -0
- package/dist/internal/groups/change-authorization.d.ts.map +1 -0
- package/dist/internal/groups/change-authorization.js +120 -0
- package/dist/internal/groups/change-authorization.js.map +1 -0
- package/dist/internal/{groups-v2 → groups}/encrypted-state.d.ts +12 -2
- package/dist/internal/groups/encrypted-state.d.ts.map +1 -0
- package/dist/internal/{groups-v2 → groups}/encrypted-state.js +122 -22
- package/dist/internal/groups/encrypted-state.js.map +1 -0
- package/dist/internal/groups/group-id.d.ts +9 -9
- package/dist/internal/groups/group-id.d.ts.map +1 -1
- package/dist/internal/groups/group-id.js +11 -12
- package/dist/internal/groups/group-id.js.map +1 -1
- package/dist/internal/groups/index.d.ts +16 -6
- package/dist/internal/groups/index.d.ts.map +1 -1
- package/dist/internal/groups/index.js +9 -1
- package/dist/internal/groups/index.js.map +1 -1
- package/dist/internal/groups/invite-link.d.ts.map +1 -0
- package/dist/internal/groups/invite-link.js.map +1 -0
- package/dist/internal/{groups-v2 → groups}/manager.d.ts +212 -43
- package/dist/internal/groups/manager.d.ts.map +1 -0
- package/dist/internal/groups/manager.js +1945 -0
- package/dist/internal/groups/manager.js.map +1 -0
- package/dist/internal/groups/sdk-store.d.ts +32 -0
- package/dist/internal/groups/sdk-store.d.ts.map +1 -0
- package/dist/internal/groups/sdk-store.js +111 -0
- package/dist/internal/groups/sdk-store.js.map +1 -0
- package/dist/internal/groups/server-engine.d.ts +98 -0
- package/dist/internal/groups/server-engine.d.ts.map +1 -0
- package/dist/internal/groups/server-engine.js +1235 -0
- package/dist/internal/groups/server-engine.js.map +1 -0
- package/dist/internal/groups/trust-root.d.ts +32 -0
- package/dist/internal/groups/trust-root.d.ts.map +1 -0
- package/dist/internal/groups/trust-root.js +91 -0
- package/dist/internal/groups/trust-root.js.map +1 -0
- package/dist/internal/{groups-v2 → groups}/types.d.ts +190 -41
- package/dist/internal/groups/types.d.ts.map +1 -0
- package/dist/internal/{groups-v2 → groups}/types.js +3 -2
- package/dist/internal/groups/types.js.map +1 -0
- package/dist/internal/groups/wire.d.ts +68 -0
- package/dist/internal/groups/wire.d.ts.map +1 -0
- package/dist/internal/groups/wire.js +708 -0
- package/dist/internal/groups/wire.js.map +1 -0
- package/dist/internal/manager/manager.d.ts +4 -4
- package/dist/internal/manager/manager.d.ts.map +1 -1
- package/dist/internal/manager/manager.js +28 -17
- package/dist/internal/manager/manager.js.map +1 -1
- package/dist/internal/protocol/double-ratchet/chains.d.ts +1 -1
- package/dist/internal/protocol/double-ratchet/chains.d.ts.map +1 -1
- package/dist/internal/protocol/double-ratchet/chains.js +10 -10
- package/dist/internal/protocol/double-ratchet/chains.js.map +1 -1
- package/dist/internal/protocol/double-ratchet/ratchet.d.ts +3 -3
- package/dist/internal/protocol/double-ratchet/ratchet.d.ts.map +1 -1
- package/dist/internal/protocol/double-ratchet/ratchet.js +3 -3
- package/dist/internal/protocol/double-ratchet/ratchet.js.map +1 -1
- package/dist/internal/protocol/pqxdh/pqxdh.d.ts.map +1 -1
- package/dist/internal/protocol/pqxdh/pqxdh.js +3 -3
- package/dist/internal/protocol/pqxdh/pqxdh.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/decryption-v2.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/decryption-v2.js +32 -18
- 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 +35 -21
- package/dist/internal/protocol/sealed-sender/decryption.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/encryption-v2.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/encryption-v2.js +8 -14
- package/dist/internal/protocol/sealed-sender/encryption-v2.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/encryption.d.ts +9 -4
- package/dist/internal/protocol/sealed-sender/encryption.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/encryption.js +7 -15
- package/dist/internal/protocol/sealed-sender/encryption.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/proto/index.d.ts +56 -11
- package/dist/internal/protocol/sealed-sender/proto/index.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/proto/index.js +272 -157
- package/dist/internal/protocol/sealed-sender/proto/index.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/trust-root.d.ts +45 -0
- package/dist/internal/protocol/sealed-sender/trust-root.d.ts.map +1 -0
- package/dist/internal/protocol/sealed-sender/trust-root.js +77 -0
- package/dist/internal/protocol/sealed-sender/trust-root.js.map +1 -0
- package/dist/internal/protocol/sealed-sender/types.d.ts +65 -10
- package/dist/internal/protocol/sealed-sender/types.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/types.js +44 -1
- package/dist/internal/protocol/sealed-sender/types.js.map +1 -1
- package/dist/internal/protocol/sender-keys/index.d.ts +1 -1
- package/dist/internal/protocol/sender-keys/manager.d.ts +41 -4
- package/dist/internal/protocol/sender-keys/manager.d.ts.map +1 -1
- package/dist/internal/protocol/sender-keys/manager.js +113 -12
- package/dist/internal/protocol/sender-keys/manager.js.map +1 -1
- package/dist/internal/protocol/spqr/index.d.ts +1 -1
- package/dist/internal/protocol/spqr/index.js +1 -1
- package/dist/internal/protocol/spqr/message.d.ts +1 -1
- package/dist/internal/protocol/spqr/message.js +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/rs/codec.d.ts +3 -3
- package/dist/internal/protocol/spqr/ml-kem-braid/rs/codec.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/rs/index.js +2 -2
- package/dist/internal/protocol/spqr/ml-kem-braid/rs/index.js.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/rs/lagrange.d.ts +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/rs/lagrange.js +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/rs/lagrange.js.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/serialize.d.ts +8 -2
- package/dist/internal/protocol/spqr/ml-kem-braid/serialize.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/serialize.js +335 -152
- package/dist/internal/protocol/spqr/ml-kem-braid/serialize.js.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/state-machine.js +5 -5
- 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 +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/types.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/spqr.d.ts +10 -10
- package/dist/internal/protocol/spqr/spqr.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/spqr.js +14 -14
- package/dist/internal/protocol/spqr/spqr.js.map +1 -1
- package/dist/internal/protocol/triple-ratchet/ratchet.d.ts +3 -3
- package/dist/internal/protocol/triple-ratchet/ratchet.d.ts.map +1 -1
- package/dist/internal/protocol/triple-ratchet/ratchet.js +5 -5
- package/dist/internal/protocol/triple-ratchet/ratchet.js.map +1 -1
- package/dist/internal/protocol/username/generate.d.ts +1 -1
- package/dist/internal/protocol/username/generate.js +1 -1
- package/dist/internal/protocol/username/hash.d.ts +1 -1
- package/dist/internal/protocol/username/hash.js +1 -1
- package/dist/internal/protocol/username/link.d.ts +1 -1
- package/dist/internal/protocol/username/link.js +1 -1
- package/dist/internal/protocol/username/proof.d.ts +1 -1
- package/dist/internal/protocol/username/proof.js +1 -1
- package/dist/internal/protocol/x3dh/x3dh.d.ts.map +1 -1
- package/dist/internal/protocol/x3dh/x3dh.js +6 -6
- package/dist/internal/protocol/x3dh/x3dh.js.map +1 -1
- package/dist/internal/protocol/zk/groups/auth-credential.d.ts +14 -11
- package/dist/internal/protocol/zk/groups/auth-credential.d.ts.map +1 -1
- package/dist/internal/protocol/zk/groups/auth-credential.js +68 -29
- package/dist/internal/protocol/zk/groups/auth-credential.js.map +1 -1
- package/dist/internal/protocol/zk/groups/client-zk-group-cipher.d.ts +2 -2
- package/dist/internal/protocol/zk/groups/client-zk-group-cipher.js +2 -2
- package/dist/internal/protocol/zk/groups/server-params.d.ts +1 -1
- package/dist/internal/protocol/zk/groups/server-params.d.ts.map +1 -1
- package/dist/internal/protocol/zk/groups/server-params.js.map +1 -1
- package/dist/internal/protocol/zk/groups/uid-struct.d.ts +2 -0
- package/dist/internal/protocol/zk/groups/uid-struct.d.ts.map +1 -1
- package/dist/internal/protocol/zk/groups/uid-struct.js +4 -0
- package/dist/internal/protocol/zk/groups/uid-struct.js.map +1 -1
- package/dist/internal/sesame/device-registry.d.ts +18 -13
- package/dist/internal/sesame/device-registry.d.ts.map +1 -1
- package/dist/internal/sesame/device-registry.js +13 -9
- package/dist/internal/sesame/device-registry.js.map +1 -1
- package/dist/internal/sesame/manager.d.ts +1 -1
- package/dist/internal/sesame/manager.d.ts.map +1 -1
- package/dist/internal/sesame/manager.js +66 -34
- package/dist/internal/sesame/manager.js.map +1 -1
- package/dist/internal/sesame/types.d.ts.map +1 -1
- package/dist/internal/sesame/types.js +7 -2
- package/dist/internal/sesame/types.js.map +1 -1
- package/dist/internal/session/builder.js +3 -3
- package/dist/internal/session/builder.js.map +1 -1
- package/dist/internal/session/cipher.d.ts +2 -2
- package/dist/internal/session/cipher.d.ts.map +1 -1
- package/dist/internal/session/cipher.js +38 -30
- package/dist/internal/session/cipher.js.map +1 -1
- package/dist/internal/session/decryption.d.ts +1 -1
- package/dist/internal/session/decryption.js +10 -10
- package/dist/internal/session/decryption.js.map +1 -1
- package/dist/internal/session/factory.d.ts.map +1 -1
- package/dist/internal/session/factory.js +3 -3
- package/dist/internal/session/factory.js.map +1 -1
- package/dist/internal/session/handshake.d.ts.map +1 -1
- package/dist/internal/session/handshake.js +3 -3
- package/dist/internal/session/handshake.js.map +1 -1
- package/dist/internal/session/keys.d.ts +1 -1
- package/dist/internal/session/ratchet.d.ts.map +1 -1
- package/dist/internal/session/ratchet.js +4 -4
- package/dist/internal/session/ratchet.js.map +1 -1
- package/dist/internal/session/types.d.ts +2 -2
- package/dist/internal/session/types.d.ts.map +1 -1
- package/dist/internal/session/validation.d.ts.map +1 -1
- package/dist/internal/session/validation.js +3 -3
- package/dist/internal/session/validation.js.map +1 -1
- package/dist/keys/generation.d.ts +4 -3
- package/dist/keys/generation.d.ts.map +1 -1
- package/dist/keys/generation.js +2 -2
- package/dist/keys/generation.js.map +1 -1
- package/dist/keys/identity.d.ts +32 -0
- package/dist/keys/identity.d.ts.map +1 -1
- package/dist/keys/identity.js +55 -0
- package/dist/keys/identity.js.map +1 -1
- package/dist/keys/index.d.ts +1 -1
- package/dist/keys/index.d.ts.map +1 -1
- package/dist/keys/index.js +1 -1
- package/dist/keys/index.js.map +1 -1
- package/dist/keys/types.d.ts +1 -1
- package/dist/keys/types.d.ts.map +1 -1
- package/dist/layers.d.ts +5 -5
- package/dist/layers.d.ts.map +1 -1
- package/dist/layers.js +9 -9
- package/dist/layers.js.map +1 -1
- package/dist/local/store/expo/adapter.d.ts +28 -25
- package/dist/local/store/expo/adapter.d.ts.map +1 -1
- package/dist/local/store/expo/adapter.js +125 -113
- package/dist/local/store/expo/adapter.js.map +1 -1
- package/dist/local/store/expo/database-key.d.ts +2 -2
- package/dist/local/store/expo/database-key.d.ts.map +1 -1
- package/dist/local/store/expo/database-key.js +5 -5
- package/dist/local/store/expo/database-key.js.map +1 -1
- package/dist/local/store/expo/db.d.ts +13 -10
- package/dist/local/store/expo/db.d.ts.map +1 -1
- package/dist/local/store/expo/db.js +8 -3
- package/dist/local/store/expo/db.js.map +1 -1
- package/dist/local/store/expo/index.d.ts +5 -7
- package/dist/local/store/expo/index.d.ts.map +1 -1
- package/dist/local/store/expo/index.js +3 -3
- package/dist/local/store/expo/index.js.map +1 -1
- package/dist/local/store/expo/key-storage.d.ts +1 -1
- package/dist/local/store/expo/key-storage.d.ts.map +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/index.d.ts +1 -1
- package/dist/local/store/expo/models/index.d.ts.map +1 -1
- package/dist/local/store/expo/models/index.js +2 -2
- package/dist/local/store/expo/models/index.js.map +1 -1
- package/dist/local/store/expo/models/local-identity.d.ts +1 -1
- package/dist/local/store/expo/models/local-identity.js +1 -1
- package/dist/local/store/expo/models/sender-key.d.ts +101 -77
- package/dist/local/store/expo/models/sender-key.d.ts.map +1 -1
- package/dist/local/store/expo/models/sender-key.js +154 -124
- package/dist/local/store/expo/models/sender-key.js.map +1 -1
- package/dist/local/store/expo/schema.d.ts +135 -33
- package/dist/local/store/expo/schema.d.ts.map +1 -1
- package/dist/local/store/expo/schema.js +37 -8
- package/dist/local/store/expo/schema.js.map +1 -1
- package/dist/local/store/expo/secure-store-options.d.ts +2 -2
- package/dist/local/store/expo/secure-store-options.d.ts.map +1 -1
- package/dist/local/store/expo/secure-store-options.js +1 -1
- package/dist/local/store/expo/secure-store-options.js.map +1 -1
- package/dist/local/store/index.d.ts +9 -9
- package/dist/local/store/index.d.ts.map +1 -1
- package/dist/local/store/index.js +9 -9
- package/dist/local/store/index.js.map +1 -1
- package/dist/local/store/{mock → memory}/adapter.d.ts +14 -7
- package/dist/local/store/memory/adapter.d.ts.map +1 -0
- package/dist/local/store/{mock → memory}/adapter.js +156 -58
- package/dist/local/store/memory/adapter.js.map +1 -0
- package/dist/local/store/memory/failures.d.ts +34 -0
- package/dist/local/store/memory/failures.d.ts.map +1 -0
- package/dist/local/store/memory/failures.js +75 -0
- package/dist/local/store/memory/failures.js.map +1 -0
- package/dist/local/store/memory/index.d.ts +11 -0
- package/dist/local/store/memory/index.d.ts.map +1 -0
- package/dist/local/store/memory/index.js +7 -0
- package/dist/local/store/memory/index.js.map +1 -0
- package/dist/local/store/node/adapter.d.ts +56 -7
- package/dist/local/store/node/adapter.d.ts.map +1 -1
- package/dist/local/store/node/adapter.js +458 -11
- package/dist/local/store/node/adapter.js.map +1 -1
- package/dist/local/store/node/database-key.js +1 -1
- package/dist/local/store/node/database.d.ts +68 -0
- package/dist/local/store/node/database.d.ts.map +1 -1
- package/dist/local/store/node/database.js +203 -20
- package/dist/local/store/node/database.js.map +1 -1
- package/dist/local/store/node/index.d.ts +4 -4
- package/dist/local/store/node/index.d.ts.map +1 -1
- package/dist/local/store/node/index.js +3 -3
- package/dist/local/store/node/index.js.map +1 -1
- package/dist/local/store/react-native/adapter.d.ts +44 -5
- package/dist/local/store/react-native/adapter.d.ts.map +1 -1
- package/dist/local/store/react-native/adapter.js +177 -22
- package/dist/local/store/react-native/adapter.js.map +1 -1
- package/dist/local/store/react-native/index.d.ts +4 -4
- package/dist/local/store/react-native/index.d.ts.map +1 -1
- package/dist/local/store/react-native/index.js +3 -3
- package/dist/local/store/react-native/index.js.map +1 -1
- package/dist/local/store/react-native/storage.d.ts +2 -2
- package/dist/local/store/web/adapter.d.ts +5 -4
- package/dist/local/store/web/adapter.d.ts.map +1 -1
- package/dist/local/store/web/adapter.js +54 -10
- package/dist/local/store/web/adapter.js.map +1 -1
- package/dist/local/store/web/index.d.ts +4 -4
- package/dist/local/store/web/index.d.ts.map +1 -1
- package/dist/local/store/web/index.js +3 -3
- package/dist/local/store/web/index.js.map +1 -1
- package/dist/local/vault/expo-secure-store.d.ts +2 -2
- package/dist/local/vault/expo-secure-store.d.ts.map +1 -1
- package/dist/local/vault/expo-secure-store.js +5 -5
- package/dist/local/vault/expo-secure-store.js.map +1 -1
- package/dist/local/vault/index.d.ts +3 -3
- package/dist/local/vault/index.d.ts.map +1 -1
- package/dist/local/vault/index.js +1 -1
- package/dist/local/vault/index.js.map +1 -1
- package/dist/logger.d.ts +4 -4
- package/dist/logger.d.ts.map +1 -1
- package/dist/logger.js +5 -5
- package/dist/logger.js.map +1 -1
- package/dist/media/index.d.ts +7 -7
- package/dist/media/index.d.ts.map +1 -1
- package/dist/media/index.js +2 -2
- package/dist/profile/cipher.d.ts +1 -1
- package/dist/profile/cipher.js +1 -1
- package/dist/profile/contact-state.d.ts +1 -1
- package/dist/profile/contact-state.d.ts.map +1 -1
- package/dist/profile/contact-state.js +3 -3
- package/dist/profile/contact-state.js.map +1 -1
- package/dist/profile/crypto.d.ts +1 -1
- package/dist/profile/crypto.js +1 -1
- package/dist/profile/profile-key.d.ts.map +1 -1
- package/dist/profile/profile-key.js +3 -3
- package/dist/profile/profile-key.js.map +1 -1
- package/dist/profile/update-service.d.ts +2 -2
- package/dist/profile/update-service.d.ts.map +1 -1
- package/dist/profile/update-service.js +2 -2
- package/dist/profile/update-service.js.map +1 -1
- package/dist/remote/object-store/convex-r2/server.d.ts +1 -1
- package/dist/remote/object-store/convex-r2/storage.d.ts +2 -2
- package/dist/remote/object-store/convex-r2/storage.d.ts.map +1 -1
- package/dist/remote/object-store/index.d.ts +1 -1
- package/dist/remote/object-store/index.d.ts.map +1 -1
- package/dist/remote/object-store/s3/storage.d.ts +3 -3
- package/dist/remote/object-store/s3/storage.d.ts.map +1 -1
- package/dist/remote/object-store/s3/storage.js +1 -1
- package/dist/remote/object-store/types.d.ts +1 -1
- package/dist/remote/object-store/types.d.ts.map +1 -1
- package/dist/remote/relay/convex/backend.d.ts +405 -0
- package/dist/remote/relay/convex/backend.d.ts.map +1 -0
- package/dist/remote/relay/convex/backend.js +687 -0
- package/dist/remote/relay/convex/backend.js.map +1 -0
- package/dist/remote/relay/convex/component/_generated/api.d.ts +58 -0
- package/dist/remote/relay/convex/component/_generated/api.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/_generated/api.js +31 -0
- package/dist/remote/relay/convex/component/_generated/api.js.map +1 -0
- package/dist/remote/relay/convex/component/_generated/component.d.ts +483 -0
- package/dist/remote/relay/convex/component/_generated/component.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/_generated/component.js +11 -0
- package/dist/remote/relay/convex/component/_generated/component.js.map +1 -0
- package/dist/remote/relay/convex/component/_generated/dataModel.d.ts +46 -0
- package/dist/remote/relay/convex/component/_generated/dataModel.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/_generated/dataModel.js +11 -0
- package/dist/remote/relay/convex/component/_generated/dataModel.js.map +1 -0
- package/dist/remote/relay/convex/component/_generated/server.d.ts +129 -0
- package/dist/remote/relay/convex/component/_generated/server.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/_generated/server.js +79 -0
- package/dist/remote/relay/convex/component/_generated/server.js.map +1 -0
- package/dist/remote/relay/convex/component/accounts.d.ts +43 -0
- package/dist/remote/relay/convex/component/accounts.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/accounts.js +181 -0
- package/dist/remote/relay/convex/component/accounts.js.map +1 -0
- package/dist/remote/relay/convex/component/certificates.d.ts +10 -0
- package/dist/remote/relay/convex/component/certificates.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/certificates.js +117 -0
- package/dist/remote/relay/convex/component/certificates.js.map +1 -0
- package/dist/remote/relay/convex/component/cleanup.d.ts +32 -0
- package/dist/remote/relay/convex/component/cleanup.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/cleanup.js +146 -0
- package/dist/remote/relay/convex/component/cleanup.js.map +1 -0
- package/dist/remote/relay/convex/component/convex.config.d.ts +5 -0
- package/dist/remote/relay/convex/component/convex.config.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/convex.config.js +33 -0
- package/dist/remote/relay/convex/component/convex.config.js.map +1 -0
- package/dist/remote/relay/convex/component/crons.d.ts +3 -0
- package/dist/remote/relay/convex/component/crons.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/crons.js +10 -0
- package/dist/remote/relay/convex/component/crons.js.map +1 -0
- package/dist/remote/relay/convex/component/devices.d.ts +101 -0
- package/dist/remote/relay/convex/component/devices.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/devices.js +299 -0
- package/dist/remote/relay/convex/component/devices.js.map +1 -0
- package/dist/remote/relay/convex/component/errors.d.ts +22 -0
- package/dist/remote/relay/convex/component/errors.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/errors.js +17 -0
- package/dist/remote/relay/convex/component/errors.js.map +1 -0
- package/dist/remote/relay/convex/component/groups.d.ts +63 -0
- package/dist/remote/relay/convex/component/groups.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/groups.js +341 -0
- package/dist/remote/relay/convex/component/groups.js.map +1 -0
- package/dist/remote/relay/convex/component/keys.d.ts +130 -0
- package/dist/remote/relay/convex/component/keys.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/keys.js +578 -0
- package/dist/remote/relay/convex/component/keys.js.map +1 -0
- package/dist/remote/relay/convex/component/messages.d.ts +119 -0
- package/dist/remote/relay/convex/component/messages.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/messages.js +723 -0
- package/dist/remote/relay/convex/component/messages.js.map +1 -0
- package/dist/remote/relay/convex/component/provisioning.d.ts +92 -0
- package/dist/remote/relay/convex/component/provisioning.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/provisioning.js +359 -0
- package/dist/remote/relay/convex/component/provisioning.js.map +1 -0
- package/dist/remote/relay/convex/component/runtime.d.ts +18 -0
- package/dist/remote/relay/convex/component/runtime.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/runtime.js +142 -0
- package/dist/remote/relay/convex/component/runtime.js.map +1 -0
- package/dist/remote/relay/convex/component/schema.d.ts +358 -0
- package/dist/remote/relay/convex/component/schema.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/schema.js +287 -0
- package/dist/remote/relay/convex/component/schema.js.map +1 -0
- package/dist/remote/relay/convex/component/zkAuth.d.ts +12 -0
- package/dist/remote/relay/convex/component/zkAuth.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/zkAuth.js +71 -0
- package/dist/remote/relay/convex/component/zkAuth.js.map +1 -0
- package/dist/remote/relay/convex/constants.d.ts +3 -0
- package/dist/remote/relay/convex/constants.d.ts.map +1 -0
- package/dist/remote/relay/convex/constants.js +3 -0
- package/dist/remote/relay/convex/constants.js.map +1 -0
- package/dist/remote/relay/convex/group-server.d.ts +29 -24
- package/dist/remote/relay/convex/group-server.d.ts.map +1 -1
- package/dist/remote/relay/convex/group-server.js +62 -28
- package/dist/remote/relay/convex/group-server.js.map +1 -1
- package/dist/remote/relay/convex/index.d.ts +14 -11
- package/dist/remote/relay/convex/index.d.ts.map +1 -1
- package/dist/remote/relay/convex/index.js +9 -7
- package/dist/remote/relay/convex/index.js.map +1 -1
- package/dist/remote/relay/convex/relay.d.ts +67 -80
- package/dist/remote/relay/convex/relay.d.ts.map +1 -1
- package/dist/remote/relay/convex/relay.js +143 -59
- package/dist/remote/relay/convex/relay.js.map +1 -1
- package/dist/remote/relay/convex/types.d.ts +16 -103
- package/dist/remote/relay/convex/types.d.ts.map +1 -1
- package/dist/remote/relay/convex/types.js +8 -13
- package/dist/remote/relay/convex/types.js.map +1 -1
- package/dist/remote/relay/index.d.ts +7 -7
- package/dist/remote/relay/index.d.ts.map +1 -1
- package/dist/remote/relay/index.js +7 -7
- package/dist/remote/relay/index.js.map +1 -1
- package/dist/remote/relay/{mock → memory}/adapter.d.ts +55 -31
- package/dist/remote/relay/memory/adapter.d.ts.map +1 -0
- package/dist/remote/relay/{mock → memory}/adapter.js +276 -135
- package/dist/remote/relay/memory/adapter.js.map +1 -0
- package/dist/remote/relay/memory/failures.d.ts +58 -0
- package/dist/remote/relay/memory/failures.d.ts.map +1 -0
- package/dist/remote/relay/memory/failures.js +123 -0
- package/dist/remote/relay/memory/failures.js.map +1 -0
- package/dist/remote/relay/memory/group-server.d.ts +9 -0
- package/dist/remote/relay/memory/group-server.d.ts.map +1 -0
- package/dist/remote/relay/memory/group-server.js +9 -0
- package/dist/remote/relay/memory/group-server.js.map +1 -0
- package/dist/remote/relay/memory/index.d.ts +11 -0
- package/dist/remote/relay/memory/index.d.ts.map +1 -0
- package/dist/remote/relay/memory/index.js +7 -0
- package/dist/remote/relay/memory/index.js.map +1 -0
- package/dist/remote/relay/types.d.ts +99 -86
- package/dist/remote/relay/types.d.ts.map +1 -1
- package/dist/remote/relay/types.js +2 -3
- package/dist/remote/relay/types.js.map +1 -1
- package/dist/safety/protobuf.d.ts +1 -1
- package/dist/safety/protobuf.d.ts.map +1 -1
- package/dist/types/api.d.ts +42 -17
- package/dist/types/api.d.ts.map +1 -1
- package/dist/types/errors.d.ts +2 -2
- package/dist/types/errors.d.ts.map +1 -1
- package/dist/types/errors.js +2 -2
- package/dist/types/errors.js.map +1 -1
- package/dist/types/messages.d.ts +1 -1
- package/dist/types/protocol-config.d.ts +71 -4
- package/dist/types/protocol-config.d.ts.map +1 -1
- package/dist/types/protocol-config.js +63 -2
- package/dist/types/protocol-config.js.map +1 -1
- package/dist/types/protocol-constants.d.ts +1 -1
- package/dist/types/protocol-constants.js +1 -1
- package/dist/utils/binary-transfer.d.ts +1 -1
- package/dist/utils/errors.d.ts +2 -2
- package/dist/utils/errors.js +2 -2
- package/dist/utils/retry.d.ts +4 -3
- package/dist/utils/retry.d.ts.map +1 -1
- package/dist/utils/retry.js +20 -1
- package/dist/utils/retry.js.map +1 -1
- package/dist/zk/groups.d.ts +1 -1
- package/dist/zk/groups.js +1 -1
- package/docs/ASSURANCE.md +12 -8
- package/docs/CLIENT_COMPOSITION.md +32 -76
- package/docs/DEVIATIONS.md +944 -0
- package/docs/E2EE.md +71 -6
- package/docs/ERROR_HANDLING.md +8 -1
- package/docs/GETTING_STARTED.md +22 -18
- package/docs/INTERFACES.md +22 -22
- package/docs/PACKAGE_SURFACE.md +22 -16
- package/docs/PROTOCOL_POLICY.md +11 -2
- package/docs/RECIPES.md +17 -13
- package/docs/SECURITY.md +8 -0
- package/files/README.md +1 -1
- package/groups/README.md +16 -5
- package/local/store/README.md +14 -12
- package/local/store/expo/README.md +15 -6
- package/local/store/memory/README.md +58 -0
- package/local/store/node/README.md +8 -1
- package/local/store/react-native/README.md +1 -1
- package/local/store/web/README.md +1 -1
- package/local/vault/README.md +3 -3
- package/package.json +29 -13
- package/remote/README.md +19 -19
- package/remote/object-store/README.md +3 -3
- package/remote/object-store/convex-r2/README.md +1 -1
- package/remote/object-store/s3/README.md +1 -1
- package/remote/relay/README.md +7 -7
- package/remote/relay/convex/README.md +10 -4
- package/remote/relay/convex/component/README.md +428 -0
- package/remote/relay/memory/README.md +69 -0
- package/scripts/oe-groups.mjs +162 -0
- package/types/README.md +1 -1
- package/dist/internal/groups-v2/access-control.d.ts +0 -101
- package/dist/internal/groups-v2/access-control.d.ts.map +0 -1
- package/dist/internal/groups-v2/access-control.js +0 -184
- package/dist/internal/groups-v2/access-control.js.map +0 -1
- package/dist/internal/groups-v2/change-actions.d.ts +0 -35
- package/dist/internal/groups-v2/change-actions.d.ts.map +0 -1
- package/dist/internal/groups-v2/change-actions.js +0 -358
- package/dist/internal/groups-v2/change-actions.js.map +0 -1
- package/dist/internal/groups-v2/encrypted-state.d.ts.map +0 -1
- package/dist/internal/groups-v2/encrypted-state.js.map +0 -1
- package/dist/internal/groups-v2/index.d.ts +0 -14
- package/dist/internal/groups-v2/index.d.ts.map +0 -1
- package/dist/internal/groups-v2/index.js +0 -11
- package/dist/internal/groups-v2/index.js.map +0 -1
- package/dist/internal/groups-v2/invite-link.d.ts.map +0 -1
- package/dist/internal/groups-v2/invite-link.js.map +0 -1
- package/dist/internal/groups-v2/manager.d.ts.map +0 -1
- package/dist/internal/groups-v2/manager.js +0 -1093
- package/dist/internal/groups-v2/manager.js.map +0 -1
- package/dist/internal/groups-v2/types.d.ts.map +0 -1
- package/dist/internal/groups-v2/types.js.map +0 -1
- package/dist/local/store/mock/adapter.d.ts.map +0 -1
- package/dist/local/store/mock/adapter.js.map +0 -1
- package/dist/local/store/mock/index.d.ts +0 -10
- package/dist/local/store/mock/index.d.ts.map +0 -1
- package/dist/local/store/mock/index.js +0 -6
- package/dist/local/store/mock/index.js.map +0 -1
- package/dist/remote/relay/mock/adapter.d.ts.map +0 -1
- package/dist/remote/relay/mock/adapter.js.map +0 -1
- package/dist/remote/relay/mock/index.d.ts +0 -10
- package/dist/remote/relay/mock/index.d.ts.map +0 -1
- package/dist/remote/relay/mock/index.js +0 -6
- package/dist/remote/relay/mock/index.js.map +0 -1
- package/docs/api/README.md +0 -471
- package/docs/api/classes/EncryptionError.md +0 -112
- package/docs/api/classes/EndorsementManager.md +0 -307
- package/docs/api/classes/SealedSenderAuthError.md +0 -127
- package/docs/api/classes/ServerDerivedKeyPair.md +0 -68
- package/docs/api/classes/ServerDerivedPublicKey.md +0 -33
- package/docs/api/classes/ServerRootKeyPair.md +0 -94
- package/docs/api/classes/ServerRootPublicKey.md +0 -72
- package/docs/api/classes/SignalBlockingManager.md +0 -106
- package/docs/api/classes/SignalProtocolClient.md +0 -2651
- package/docs/api/classes/VerificationFailure.md +0 -25
- package/docs/api/enumerations/ContentHint.md +0 -63
- package/docs/api/enumerations/EncryptionErrorCode.md +0 -488
- package/docs/api/enumerations/IdentityKeyChange.md +0 -65
- package/docs/api/enumerations/MessageType.md +0 -29
- package/docs/api/enumerations/TrustDirection.md +0 -33
- package/docs/api/enumerations/TypingAction.md +0 -31
- package/docs/api/functions/createDefaultSignalContentAdapter.md +0 -13
- package/docs/api/functions/createDefaultSignalLogger.md +0 -36
- package/docs/api/functions/createGroupId.md +0 -32
- package/docs/api/functions/createSignalProtocolClient.md +0 -36
- package/docs/api/functions/createSignalProtocolClientConfig.md +0 -24
- package/docs/api/functions/extractGroupId.md +0 -32
- package/docs/api/functions/formatVersion.md +0 -25
- package/docs/api/functions/isCompatible.md +0 -31
- package/docs/api/functions/isGroupId.md +0 -37
- package/docs/api/functions/isSealedSenderAuthError.md +0 -25
- package/docs/api/functions/parseVersion.md +0 -29
- package/docs/api/functions/resolveSPQRLimits.md +0 -21
- package/docs/api/functions/resolveSignalLogger.md +0 -42
- package/docs/api/interfaces/AccountIdentityProvisioning.md +0 -43
- package/docs/api/interfaces/AccountIdentityRotation.md +0 -69
- package/docs/api/interfaces/AttachmentTransferOptions.md +0 -49
- package/docs/api/interfaces/BlockedRecipientEntry.md +0 -25
- package/docs/api/interfaces/BlockedRecipientsSyncInput.md +0 -27
- package/docs/api/interfaces/ConfigurationSyncInput.md +0 -19
- package/docs/api/interfaces/CredentialPublicKey.md +0 -25
- package/docs/api/interfaces/DataMessageInput.md +0 -21
- package/docs/api/interfaces/DecryptedEnvelope.md +0 -95
- package/docs/api/interfaces/DecryptedGroup.md +0 -86
- package/docs/api/interfaces/DeviceInfo.md +0 -79
- package/docs/api/interfaces/DeviceRecord.md +0 -87
- package/docs/api/interfaces/DeviceRegistration.md +0 -27
- package/docs/api/interfaces/DoubleRatchetConfig.md +0 -36
- package/docs/api/interfaces/EcOneTimePreKey.md +0 -27
- package/docs/api/interfaces/EcSignedPreKey.md +0 -39
- package/docs/api/interfaces/EcSignedPreKeyUpload.md +0 -50
- package/docs/api/interfaces/EncryptionErrorContext.md +0 -51
- package/docs/api/interfaces/Envelope.md +0 -154
- package/docs/api/interfaces/ForceKeyResetResult.md +0 -37
- package/docs/api/interfaces/GroupAuthorization.md +0 -23
- package/docs/api/interfaces/GroupChangeEntry.md +0 -42
- package/docs/api/interfaces/GroupMemberDevice.md +0 -26
- package/docs/api/interfaces/IEcOneTimePreKeyStore.md +0 -86
- package/docs/api/interfaces/IEcSignedPreKeyStore.md +0 -132
- package/docs/api/interfaces/IGroupServer.md +0 -120
- package/docs/api/interfaces/IGroupStateStore.md +0 -128
- package/docs/api/interfaces/IIdentityKeyStore.md +0 -312
- package/docs/api/interfaces/IKemPreKeyStore.md +0 -144
- package/docs/api/interfaces/IKyberLastResortPreKeyStore.md +0 -111
- package/docs/api/interfaces/ILogger.md +0 -117
- package/docs/api/interfaces/IProtocolStore.md +0 -1033
- package/docs/api/interfaces/ISenderKeyStore.md +0 -417
- package/docs/api/interfaces/ISesameStore.md +0 -249
- package/docs/api/interfaces/ISessionStore.md +0 -178
- package/docs/api/interfaces/ISignalLocalSecretVault.md +0 -71
- package/docs/api/interfaces/ISignalLocalStore.md +0 -2053
- package/docs/api/interfaces/ISignalProtocolClient.md +0 -1183
- package/docs/api/interfaces/ISignalProtocolManager.md +0 -272
- package/docs/api/interfaces/ISignalRelayServer.md +0 -1329
- package/docs/api/interfaces/IdentityKeyPair.md +0 -49
- package/docs/api/interfaces/IncomingEnvelope.md +0 -91
- package/docs/api/interfaces/InspectedSignalContent.md +0 -43
- package/docs/api/interfaces/KDFChain.md +0 -31
- package/docs/api/interfaces/KemLastResortPreKeyUpload.md +0 -50
- package/docs/api/interfaces/KeyPair.md +0 -23
- package/docs/api/interfaces/KyberPreKey.md +0 -42
- package/docs/api/interfaces/MLKEMBraidAgentState.md +0 -191
- package/docs/api/interfaces/MLKEMBraidMessage.md +0 -49
- package/docs/api/interfaces/MediaAttachmentDeleteSyncInput.md +0 -31
- package/docs/api/interfaces/MessageHeader.md +0 -49
- package/docs/api/interfaces/MessageRecord.md +0 -86
- package/docs/api/interfaces/ParsedReceiptContent.md +0 -19
- package/docs/api/interfaces/ParsedTypingContent.md +0 -19
- package/docs/api/interfaces/PreKeyMaintenanceStore.md +0 -87
- package/docs/api/interfaces/PreKeyMessage.md +0 -159
- package/docs/api/interfaces/PreKeyStatusResult.md +0 -21
- package/docs/api/interfaces/PreKeyUpload.md +0 -42
- package/docs/api/interfaces/ProcessEnvelopeOptions.md +0 -72
- package/docs/api/interfaces/ProtocolAddress.md +0 -38
- package/docs/api/interfaces/ProtocolStrategyConfig.md +0 -91
- package/docs/api/interfaces/RatchetMessage.md +0 -96
- package/docs/api/interfaces/ReadSyncEntryInput.md +0 -19
- package/docs/api/interfaces/ReceiverChain.md +0 -43
- package/docs/api/interfaces/RecipientUsernameSyncInput.md +0 -31
- package/docs/api/interfaces/RelayPreKeyBundle.md +0 -254
- package/docs/api/interfaces/RemoteObjectDownload.md +0 -33
- package/docs/api/interfaces/RemoteObjectUpload.md +0 -49
- package/docs/api/interfaces/ResolvedSPQRInfoStrings.md +0 -27
- package/docs/api/interfaces/ResolvedSPQRLimits.md +0 -37
- package/docs/api/interfaces/RetryRequest.md +0 -80
- package/docs/api/interfaces/SCKAState.md +0 -65
- package/docs/api/interfaces/SPQRLimits.md +0 -40
- package/docs/api/interfaces/SPQRState.md +0 -191
- package/docs/api/interfaces/SafetyNumber.md +0 -60
- package/docs/api/interfaces/SafetyNumberConfirmation.md +0 -46
- package/docs/api/interfaces/SealedSenderConfig.md +0 -70
- package/docs/api/interfaces/SendOptions.md +0 -191
- package/docs/api/interfaces/SendResult.md +0 -93
- package/docs/api/interfaces/SenderKeyDistributionMessage.md +0 -43
- package/docs/api/interfaces/SenderKeyState.md +0 -76
- package/docs/api/interfaces/SenderKeysConfig.md +0 -65
- package/docs/api/interfaces/SentSyncTranscriptInput.md +0 -31
- package/docs/api/interfaces/ServiceId.md +0 -19
- package/docs/api/interfaces/SesameMessage.md +0 -84
- package/docs/api/interfaces/SesameStats.md +0 -57
- package/docs/api/interfaces/SessionHealthResult.md +0 -120
- package/docs/api/interfaces/SessionRecord.md +0 -80
- package/docs/api/interfaces/SessionRecordMetadata.md +0 -109
- package/docs/api/interfaces/SessionState.md +0 -368
- package/docs/api/interfaces/SessionTrustCommit.md +0 -58
- package/docs/api/interfaces/SignalBlockingHooks.md +0 -44
- package/docs/api/interfaces/SignalBlockingManagerOptions.md +0 -31
- package/docs/api/interfaces/SignalBlockingMirror.md +0 -30
- package/docs/api/interfaces/SignalBlockingStore.md +0 -83
- package/docs/api/interfaces/SignalContentAdapter.md +0 -325
- package/docs/api/interfaces/SignalProtocolClientAdapterConfig.md +0 -44
- package/docs/api/interfaces/SignalProtocolClientCompositionOptions.md +0 -693
- package/docs/api/interfaces/SignalProtocolClientConfig.md +0 -839
- package/docs/api/interfaces/SignalProtocolClientDeleteLocalAttachmentInput.md +0 -25
- package/docs/api/interfaces/SignalProtocolClientHooks.md +0 -506
- package/docs/api/interfaces/SignalProtocolClientIdentityConfig.md +0 -35
- package/docs/api/interfaces/SignalProtocolClientLoadLocalAttachmentInput.md +0 -187
- package/docs/api/interfaces/SignalProtocolClientLoadedLocalAttachment.md +0 -19
- package/docs/api/interfaces/SignalProtocolClientMedia.md +0 -83
- package/docs/api/interfaces/SignalProtocolClientMediaCompletedResult.md +0 -25
- package/docs/api/interfaces/SignalProtocolClientMediaConfig.md +0 -157
- package/docs/api/interfaces/SignalProtocolClientMediaDownloadCompletedResult.md +0 -37
- package/docs/api/interfaces/SignalProtocolClientMediaDownloadNotNeededResult.md +0 -25
- package/docs/api/interfaces/SignalProtocolClientMediaFailedResult.md +0 -19
- package/docs/api/interfaces/SignalProtocolClientMediaOperationOptions.md +0 -53
- package/docs/api/interfaces/SignalProtocolClientMediaPendingResult.md +0 -19
- package/docs/api/interfaces/SignalProtocolClientMediaProcessResult.md +0 -43
- package/docs/api/interfaces/SignalProtocolClientMediaSkippedResult.md +0 -25
- package/docs/api/interfaces/SignalProtocolClientMediaUploadCompletedResult.md +0 -31
- package/docs/api/interfaces/SignalProtocolClientProcessPendingMediaOptions.md +0 -87
- package/docs/api/interfaces/SignalProtocolClientSaveDownloadedAttachmentInput.md +0 -25
- package/docs/api/interfaces/SignalProtocolClientSaveUploadedAttachmentInput.md +0 -25
- package/docs/api/interfaces/SignalProtocolClientSyncDeleteInput.md +0 -19
- package/docs/api/interfaces/SignalProtocolConfig.md +0 -50
- package/docs/api/interfaces/SignalRemoteObjectStore.md +0 -88
- package/docs/api/interfaces/SkippedSenderMessageKey.md +0 -26
- package/docs/api/interfaces/TaskNotificationAckSyncInput.md +0 -31
- package/docs/api/interfaces/TripleRatchetState.md +0 -64
- package/docs/api/interfaces/UserRecord.md +0 -71
- package/docs/api/interfaces/UsernameStateSyncInput.md +0 -19
- package/docs/api/interfaces/VerificationStateSyncInput.md +0 -31
- package/docs/api/interfaces/VersionNegotiationState.md +0 -84
- package/docs/api/interfaces/ViewOnceOpenSyncInput.md +0 -19
- package/docs/api/namespaces/ProtocolAddress/README.md +0 -33
- package/docs/api/namespaces/ProtocolAddress/functions/create.md +0 -41
- package/docs/api/namespaces/ProtocolAddress/functions/equals.md +0 -39
- package/docs/api/namespaces/ProtocolAddress/functions/fromStorageKey.md +0 -36
- package/docs/api/namespaces/ProtocolAddress/functions/isUser.md +0 -39
- package/docs/api/namespaces/ProtocolAddress/functions/isValid.md +0 -34
- package/docs/api/namespaces/ProtocolAddress/functions/parse.md +0 -41
- package/docs/api/namespaces/ProtocolAddress/functions/toStorageKey.md +0 -38
- package/docs/api/namespaces/ProtocolAddress/functions/toString.md +0 -34
- package/docs/api/namespaces/SessionRecord/README.md +0 -30
- package/docs/api/namespaces/SessionRecord/functions/archiveCurrent.md +0 -40
- package/docs/api/namespaces/SessionRecord/functions/archiveCurrentState.md +0 -34
- package/docs/api/namespaces/SessionRecord/functions/create.md +0 -25
- package/docs/api/namespaces/SessionRecord/functions/deserialize.md +0 -29
- package/docs/api/namespaces/SessionRecord/functions/findSession.md +0 -34
- package/docs/api/namespaces/SessionRecord/functions/getAllSessions.md +0 -25
- package/docs/api/namespaces/SessionRecord/functions/getArchivedCount.md +0 -25
- package/docs/api/namespaces/SessionRecord/functions/hasCurrentSession.md +0 -25
- package/docs/api/namespaces/SessionRecord/functions/hasUsableSenderChain.md +0 -36
- package/docs/api/namespaces/SessionRecord/functions/promoteSession.md +0 -34
- package/docs/api/namespaces/SessionRecord/functions/serialize.md +0 -28
- package/docs/api/namespaces/SessionRecord/variables/MAX_ARCHIVED_SESSIONS.md +0 -14
- package/docs/api/namespaces/SessionState/README.md +0 -15
- package/docs/api/namespaces/SessionState/functions/getSessionId.md +0 -32
- package/docs/api/namespaces/blocking/README.md +0 -43
- package/docs/api/namespaces/encoding/README.md +0 -33
- package/docs/api/namespaces/encoding/functions/base64ToUrlSafe.md +0 -28
- package/docs/api/namespaces/encoding/functions/bytesToBase64.md +0 -21
- package/docs/api/namespaces/encoding/functions/bytesToString.md +0 -21
- package/docs/api/namespaces/encoding/functions/bytesToUrlSafeBase64.md +0 -33
- package/docs/api/namespaces/encoding/functions/concatBytes.md +0 -21
- package/docs/api/namespaces/encoding/functions/stringToBytes.md +0 -21
- package/docs/api/namespaces/encoding/functions/urlSafeToBase64.md +0 -27
- package/docs/api/namespaces/keys/README.md +0 -126
- package/docs/api/namespaces/keys/functions/acceptContactIdentityRotation.md +0 -33
- package/docs/api/namespaces/keys/functions/assertIdentityCommitment.md +0 -25
- package/docs/api/namespaces/keys/functions/compositeIdentitiesEqual.md +0 -23
- package/docs/api/namespaces/keys/functions/createCompositeIdentityV1.md +0 -19
- package/docs/api/namespaces/keys/functions/createPreKeySignatureContext.md +0 -31
- package/docs/api/namespaces/keys/functions/createUnverifiedContactIdentityRecord.md +0 -23
- package/docs/api/namespaces/keys/functions/decodeCompositeIdentityV1.md +0 -19
- package/docs/api/namespaces/keys/functions/deriveIdentityCommitment.md +0 -19
- package/docs/api/namespaces/keys/functions/encodeCompositeIdentityV1.md +0 -19
- package/docs/api/namespaces/keys/functions/evaluateContactIdentityCandidate.md +0 -27
- package/docs/api/namespaces/keys/functions/generateEcOneTimePreKeys.md +0 -37
- package/docs/api/namespaces/keys/functions/generateEcSignedPreKey.md +0 -39
- package/docs/api/namespaces/keys/functions/generateEcSignedPreKeyId.md +0 -21
- package/docs/api/namespaces/keys/functions/generateIdentityKeyPair.md +0 -24
- package/docs/api/namespaces/keys/functions/generateKemOneTimePreKeys.md +0 -47
- package/docs/api/namespaces/keys/functions/generateKyberLastResortPreKey.md +0 -37
- package/docs/api/namespaces/keys/functions/generateRegistrationId.md +0 -13
- package/docs/api/namespaces/keys/functions/signMlKem1024PreKey.md +0 -29
- package/docs/api/namespaces/keys/functions/signPreKey.md +0 -31
- package/docs/api/namespaces/keys/functions/validateContactIdentityRecord.md +0 -19
- package/docs/api/namespaces/keys/functions/verifyContactIdentityRecord.md +0 -31
- package/docs/api/namespaces/keys/functions/verifyMlKem1024PreKey.md +0 -33
- package/docs/api/namespaces/keys/functions/verifyPreKeySignature.md +0 -35
- package/docs/api/namespaces/keys/interfaces/CompositeIdentityV1.md +0 -33
- package/docs/api/namespaces/keys/interfaces/ContactIdentityRecord.md +0 -53
- package/docs/api/namespaces/keys/interfaces/KemOneTimePreKey.md +0 -43
- package/docs/api/namespaces/keys/type-aliases/IdentityCandidateStatus.md +0 -9
- package/docs/api/namespaces/keys/type-aliases/IdentityTrustState.md +0 -9
- package/docs/api/namespaces/keys/type-aliases/IdentityType.md +0 -9
- package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_ED25519_TAG.md +0 -9
- package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_LENGTH.md +0 -9
- package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_VERSION.md +0 -9
- package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_X25519_TAG.md +0 -9
- package/docs/api/namespaces/keys/variables/IDENTITY_COMMITMENT_V1_DOMAIN.md +0 -9
- package/docs/api/namespaces/keys/variables/PREKEY_ALGORITHM_ML_KEM_1024.md +0 -9
- package/docs/api/namespaces/keys/variables/PREKEY_ALGORITHM_X25519.md +0 -9
- package/docs/api/namespaces/keys/variables/PREKEY_SIGNATURE_V1_DOMAIN.md +0 -9
- package/docs/api/namespaces/media/README.md +0 -105
- package/docs/api/namespaces/media/classes/MediaAttachmentError.md +0 -57
- package/docs/api/namespaces/media/functions/createByteRangeMediaAttachmentTransfer.md +0 -19
- package/docs/api/namespaces/media/functions/createMediaAttachmentDeliveryId.md +0 -29
- package/docs/api/namespaces/media/functions/createMediaAttachmentId.md +0 -19
- package/docs/api/namespaces/media/functions/createMediaAttachmentMessage.md +0 -25
- package/docs/api/namespaces/media/functions/createMediaAttachmentPointer.md +0 -19
- package/docs/api/namespaces/media/functions/createTusMediaAttachmentTransfer.md +0 -19
- package/docs/api/namespaces/media/functions/deleteMediaAttachment.md +0 -23
- package/docs/api/namespaces/media/functions/executeMediaAttachmentJob.md +0 -23
- package/docs/api/namespaces/media/functions/isMediaAttachmentFlagSet.md +0 -19
- package/docs/api/namespaces/media/functions/parseMediaAttachmentMessage.md +0 -19
- package/docs/api/namespaces/media/functions/planMediaAttachmentCleanup.md +0 -23
- package/docs/api/namespaces/media/functions/planMediaAttachmentCleanupJobs.md +0 -19
- package/docs/api/namespaces/media/functions/planMediaAttachmentDeleteSync.md +0 -19
- package/docs/api/namespaces/media/functions/planMediaAttachmentDownloadJob.md +0 -19
- package/docs/api/namespaces/media/functions/planMediaAttachmentOpen.md +0 -19
- package/docs/api/namespaces/media/functions/planMediaAttachmentProcessing.md +0 -19
- package/docs/api/namespaces/media/functions/planMediaAttachmentUploadJob.md +0 -19
- package/docs/api/namespaces/media/functions/prepareMediaAttachmentUpload.md +0 -30
- package/docs/api/namespaces/media/functions/resolveMediaAttachment.md +0 -30
- package/docs/api/namespaces/media/functions/serializeMediaAttachmentMessage.md +0 -25
- package/docs/api/namespaces/media/functions/validateMediaAttachmentPolicy.md +0 -23
- package/docs/api/namespaces/media/interfaces/ByteRangeMediaAttachmentPartialStore.md +0 -68
- package/docs/api/namespaces/media/interfaces/ByteRangeMediaAttachmentTransferOptions.md +0 -91
- package/docs/api/namespaces/media/interfaces/DeleteMediaAttachmentOptions.md +0 -25
- package/docs/api/namespaces/media/interfaces/DeleteMediaAttachmentResult.md +0 -19
- package/docs/api/namespaces/media/interfaces/ExecuteMediaAttachmentJobOptions.md +0 -157
- package/docs/api/namespaces/media/interfaces/MediaAttachmentBackgroundJob.md +0 -85
- package/docs/api/namespaces/media/interfaces/MediaAttachmentCleanupPlan.md +0 -37
- package/docs/api/namespaces/media/interfaces/MediaAttachmentJobExecutionResult.md +0 -55
- package/docs/api/namespaces/media/interfaces/MediaAttachmentMessage.md +0 -31
- package/docs/api/namespaces/media/interfaces/MediaAttachmentOpenDecision.md +0 -31
- package/docs/api/namespaces/media/interfaces/MediaAttachmentPointer.md +0 -133
- package/docs/api/namespaces/media/interfaces/MediaAttachmentPolicy.md +0 -67
- package/docs/api/namespaces/media/interfaces/MediaAttachmentProcessingPlan.md +0 -73
- package/docs/api/namespaces/media/interfaces/MediaAttachmentProgress.md +0 -69
- package/docs/api/namespaces/media/interfaces/MediaAttachmentResumeState.md +0 -37
- package/docs/api/namespaces/media/interfaces/MediaAttachmentRetryOptions.md +0 -31
- package/docs/api/namespaces/media/interfaces/MediaAttachmentTransfer.md +0 -51
- package/docs/api/namespaces/media/interfaces/MediaAttachmentTransferCheckpoint.md +0 -69
- package/docs/api/namespaces/media/interfaces/MediaAttachmentTransferOptions.md +0 -67
- package/docs/api/namespaces/media/interfaces/MediaAttachmentUploadJobData.md +0 -19
- package/docs/api/namespaces/media/interfaces/MediaAttachmentUploadResponse.md +0 -25
- package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentCleanupJobsInput.md +0 -61
- package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentDeleteSyncInput.md +0 -25
- package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentDownloadJobInput.md +0 -161
- package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentOpenInput.md +0 -25
- package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentProcessingInput.md +0 -83
- package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentUploadJobInput.md +0 -147
- package/docs/api/namespaces/media/interfaces/PrepareMediaAttachmentUploadOptions.md +0 -144
- package/docs/api/namespaces/media/interfaces/ResolveMediaAttachmentOptions.md +0 -55
- package/docs/api/namespaces/media/interfaces/ResolvedMediaAttachment.md +0 -109
- package/docs/api/namespaces/media/interfaces/TusMediaAttachmentTransferOptions.md +0 -85
- package/docs/api/namespaces/media/type-aliases/CreateMediaAttachmentPointerInput.md +0 -15
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentCheckpointCallback.md +0 -19
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentCleanupReason.md +0 -9
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentErrorCode.md +0 -9
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentFlag.md +0 -9
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobExecutionStatus.md +0 -9
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobOperation.md +0 -9
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobPriority.md +0 -9
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobSkipReason.md +0 -9
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobSource.md +0 -9
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentKnownIds.md +0 -9
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentMessageType.md +0 -9
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentProgressCallback.md +0 -19
- package/docs/api/namespaces/media/variables/MEDIA_ATTACHMENT_POLICY_DEFAULTS.md +0 -47
- package/docs/api/namespaces/media/variables/MEDIA_ATTACHMENT_POLICY_PRESETS.md +0 -95
- package/docs/api/namespaces/media/variables/MediaAttachmentCleanupReason.md +0 -27
- package/docs/api/namespaces/media/variables/MediaAttachmentErrorCode.md +0 -75
- package/docs/api/namespaces/media/variables/MediaAttachmentFlag.md +0 -23
- package/docs/api/namespaces/media/variables/MediaAttachmentJobExecutionStatus.md +0 -19
- package/docs/api/namespaces/media/variables/MediaAttachmentJobOperation.md +0 -31
- package/docs/api/namespaces/media/variables/MediaAttachmentJobPriority.md +0 -23
- package/docs/api/namespaces/media/variables/MediaAttachmentJobSource.md +0 -51
- package/docs/api/namespaces/media/variables/MediaAttachmentMessageType.md +0 -15
- package/docs/api/namespaces/media/variables/downloadMediaAttachment.md +0 -30
- package/docs/api/namespaces/safety/README.md +0 -61
- package/docs/api/namespaces/safety/classes/DisplayableFingerprint.md +0 -108
- package/docs/api/namespaces/safety/classes/Fingerprint.md +0 -104
- package/docs/api/namespaces/safety/classes/ScannableFingerprint.md +0 -209
- package/docs/api/namespaces/safety/functions/base64ToBytes.md +0 -21
- package/docs/api/namespaces/safety/functions/clearFingerprintCache.md +0 -15
- package/docs/api/namespaces/safety/functions/compareSafetyNumbers.md +0 -25
- package/docs/api/namespaces/safety/functions/createFingerprintData.md +0 -60
- package/docs/api/namespaces/safety/functions/extractQrData.md +0 -34
- package/docs/api/namespaces/safety/functions/generateCompositeSafetyNumber.md +0 -39
- package/docs/api/namespaces/safety/functions/generateEmojiFingerprint.md +0 -24
- package/docs/api/namespaces/safety/functions/generateSingleKeyReferenceSafetyNumber.md +0 -51
- package/docs/api/namespaces/safety/functions/generateVerifySchemeUrl.md +0 -32
- package/docs/api/namespaces/safety/functions/generateVerifyUrl.md +0 -49
- package/docs/api/namespaces/safety/functions/isValidSafetyNumber.md +0 -21
- package/docs/api/namespaces/safety/functions/isVerifyUrl.md +0 -45
- package/docs/api/namespaces/safety/functions/parseVerifyUrl.md +0 -31
- package/docs/api/namespaces/safety/interfaces/FingerprintData.md +0 -52
- package/docs/api/namespaces/safety/interfaces/SafetyNumber.md +0 -49
- package/docs/api/namespaces/safety/interfaces/VerifyLinkConfig.md +0 -28
- package/docs/api/namespaces/safety/interfaces/VerifyUrlParams.md +0 -49
- package/docs/api/namespaces/safety/type-aliases/CompareResult.md +0 -21
- package/docs/api/namespaces/safety/variables/DEFAULT_VERIFY_LINK_CONFIG.md +0 -12
- package/docs/api/namespaces/safety/variables/FINGERPRINT_ITERATIONS.md +0 -12
- package/docs/api/namespaces/safety/variables/FINGERPRINT_VERSION.md +0 -12
- package/docs/api/namespaces/safety/variables/VERIFY_BASE_URL.md +0 -11
- package/docs/api/namespaces/safety/variables/VERIFY_SCHEME_URL.md +0 -11
- package/docs/api/type-aliases/Base64.md +0 -20
- package/docs/api/type-aliases/BraidPolicy.md +0 -11
- package/docs/api/type-aliases/Bytes.md +0 -20
- package/docs/api/type-aliases/Ciphertext.md +0 -21
- package/docs/api/type-aliases/DeviceType.md +0 -11
- package/docs/api/type-aliases/DownloadedAttachment.md +0 -11
- package/docs/api/type-aliases/GroupId.md +0 -27
- package/docs/api/type-aliases/Hex.md +0 -20
- package/docs/api/type-aliases/HookName.md +0 -11
- package/docs/api/type-aliases/PostQuantumPolicy.md +0 -11
- package/docs/api/type-aliases/PreparedAttachmentUpload.md +0 -14
- package/docs/api/type-aliases/PrivateKey.md +0 -22
- package/docs/api/type-aliases/ProgressCallback.md +0 -45
- package/docs/api/type-aliases/PublicKey.md +0 -22
- package/docs/api/type-aliases/RemoteObjectCompleteUploadRequest.md +0 -19
- package/docs/api/type-aliases/RemoteObjectDeleteRequest.md +0 -19
- package/docs/api/type-aliases/RemoteObjectDownloadRequest.md +0 -19
- package/docs/api/type-aliases/RemoteObjectUploadRequest.md +0 -42
- package/docs/api/type-aliases/SCKAMode.md +0 -11
- package/docs/api/type-aliases/SealedSenderAuth.md +0 -15
- package/docs/api/type-aliases/SignalProtocolClientMediaCleanupInput.md +0 -9
- package/docs/api/type-aliases/SignalProtocolClientMediaCleanupResult.md +0 -9
- package/docs/api/type-aliases/SignalProtocolClientMediaDownloadInput.md +0 -9
- package/docs/api/type-aliases/SignalProtocolClientMediaDownloadResult.md +0 -9
- package/docs/api/type-aliases/SignalProtocolClientMediaOperationResult.md +0 -9
- package/docs/api/type-aliases/SignalProtocolClientMediaUploadInput.md +0 -9
- package/docs/api/type-aliases/SignalProtocolClientMediaUploadResult.md +0 -9
- package/docs/api/type-aliases/Signature.md +0 -21
- package/docs/api/type-aliases/Unsubscribe.md +0 -15
- package/docs/api/variables/BraidPolicy.md +0 -21
- package/docs/api/variables/DEFAULT_DEVICE_ID.md +0 -12
- package/docs/api/variables/DOUBLE_RATCHET_SPEC.md +0 -11
- package/docs/api/variables/GROUP_V2_PREFIX.md +0 -11
- package/docs/api/variables/KEY_REFRESH_INTERVAL_MS_DEFAULT.md +0 -11
- package/docs/api/variables/MAX_MESSAGE_KEYS.md +0 -14
- package/docs/api/variables/MAX_PREKEY_AGE_MS_DEFAULT.md +0 -11
- package/docs/api/variables/MAX_RECEIVER_CHAINS.md +0 -14
- package/docs/api/variables/MAX_REGISTRATION_ID.md +0 -16
- package/docs/api/variables/MAX_SKIP.md +0 -11
- package/docs/api/variables/MESSAGE_FORMAT.md +0 -11
- package/docs/api/variables/MIN_REGISTRATION_ID.md +0 -16
- package/docs/api/variables/ML_KEM_BRAID_SPEC.md +0 -11
- package/docs/api/variables/ONE_TIME_PREKEY_BATCH_SIZE.md +0 -21
- package/docs/api/variables/PQXDH_SPEC.md +0 -11
- package/docs/api/variables/PostQuantumPolicy.md +0 -21
- package/docs/api/variables/SENDER_KEY_FORMAT.md +0 -11
- package/docs/api/variables/SENDER_KEY_SPEC.md +0 -11
- package/docs/api/variables/SESAME_SPEC.md +0 -11
- package/docs/api/variables/SESSION_FORMAT.md +0 -11
- package/docs/api/variables/SPQR_LIMITS_DEFAULTS.md +0 -11
- package/docs/api/variables/X3DH_SPEC.md +0 -9
- package/docs/api/variables/defaultSignalLogger.md +0 -32
- package/local/store/mock/README.md +0 -27
- package/remote/relay/mock/README.md +0 -32
- /package/dist/internal/{groups-v2 → groups}/invite-link.d.ts +0 -0
- /package/dist/internal/{groups-v2 → groups}/invite-link.js +0 -0
|
@@ -0,0 +1,428 @@
|
|
|
1
|
+
# Convex Signal Protocol component
|
|
2
|
+
|
|
3
|
+
This installable Convex component owns the complete relay backend: account and
|
|
4
|
+
device registration, identity and prekey storage, message queues, sealed-sender
|
|
5
|
+
delivery, retry requests, provisioning, sender certificates, canonical
|
|
6
|
+
encrypted group state, anonymous group authorization, credential issuance, and
|
|
7
|
+
group-send endorsements. The app owns only its
|
|
8
|
+
authentication-to-protocol-identity mapping and thin public wrappers.
|
|
9
|
+
|
|
10
|
+
## Install the component
|
|
11
|
+
|
|
12
|
+
Mount the component in the app's Convex configuration:
|
|
13
|
+
|
|
14
|
+
```ts
|
|
15
|
+
// convex/convex.config.ts
|
|
16
|
+
import { defineApp } from 'convex/server';
|
|
17
|
+
import { v } from 'convex/values';
|
|
18
|
+
import signalProtocol from '@open-e2ee/signal-protocol-sdk/convex.config';
|
|
19
|
+
|
|
20
|
+
const app = defineApp({
|
|
21
|
+
env: { OE_GROUPS_SERVER_SECRET: v.optional(v.string()) },
|
|
22
|
+
});
|
|
23
|
+
app.use(signalProtocol, {
|
|
24
|
+
env: { OE_GROUPS_SERVER_SECRET: app.env.OE_GROUPS_SERVER_SECRET },
|
|
25
|
+
});
|
|
26
|
+
export default app;
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
The `env` forwarding is load-bearing: Convex components are isolated from the
|
|
30
|
+
app's environment variables, so without it the component cannot see the
|
|
31
|
+
deployment's `OE_GROUPS_SERVER_SECRET` and every group, credential-issuance,
|
|
32
|
+
and sender-certificate call fails at runtime. The messaging, device, key, and
|
|
33
|
+
provisioning namespaces work without the secret.
|
|
34
|
+
|
|
35
|
+
The component owns these isolated tables. They do not appear in the app schema
|
|
36
|
+
and need no package-specific prefixes:
|
|
37
|
+
|
|
38
|
+
- `accounts`: reverse lookup from application account IDs to protocol service
|
|
39
|
+
identifiers and sealed-sender access keys.
|
|
40
|
+
- `devices` and `deviceHeartbeats`: device lifecycle and presence state.
|
|
41
|
+
- `identityKeys` and `identityRegistrations`: account-scoped composite
|
|
42
|
+
identities and device-scoped registration IDs.
|
|
43
|
+
- `ecPreKeys`, `ecSignedPreKeys`, `kemOneTimePreKeys`, and
|
|
44
|
+
`kemLastResortPreKeys`: the four prekey kinds, including durable one-time-key
|
|
45
|
+
consumption tombstones.
|
|
46
|
+
- `messages` and `retryRequests`: device delivery and retry queues.
|
|
47
|
+
- `provisioningSessions`: the linked-device provisioning state machine.
|
|
48
|
+
- `senderCertificates`: cached account/device certificate material.
|
|
49
|
+
- `groups`, `groupChanges`, and `groupSnapshots`: canonical encrypted group
|
|
50
|
+
state, immutable signed changes, and per-version signed snapshots.
|
|
51
|
+
|
|
52
|
+
The component derives **no** membership map from group state. Group reads and
|
|
53
|
+
writes are authorized entirely by zero-knowledge presentations, so `groups`,
|
|
54
|
+
`groupChanges`, and `groupSnapshots` never name an account, and there is no
|
|
55
|
+
`getGroupMembers` endpoint anywhere in the relay surface. Membership is
|
|
56
|
+
local-first: each client resolves fan-out recipients from its own decrypted
|
|
57
|
+
group state and passes their user IDs with the send
|
|
58
|
+
(`SendOptions.groupMemberUserIds`); the relay expands users to devices via
|
|
59
|
+
`getActiveDevices`.
|
|
60
|
+
|
|
61
|
+
See [Group metadata privacy](#group-metadata-privacy) for what the relay can
|
|
62
|
+
still infer from delivery traffic. The absence of a membership endpoint is not
|
|
63
|
+
by itself a metadata-privacy guarantee.
|
|
64
|
+
|
|
65
|
+
The mounted `@convex-dev/rate-limiter` child component separately owns its
|
|
66
|
+
isolated `rateLimits` table.
|
|
67
|
+
|
|
68
|
+
The tables store the latest canonical encrypted state, the exact accepted and
|
|
69
|
+
signed action bytes, and every historical encrypted snapshot with its cached
|
|
70
|
+
S14 baseline signature. They never store the group master key, group secret
|
|
71
|
+
parameters, plaintext group attributes, or the server secret.
|
|
72
|
+
|
|
73
|
+
Storage grows with one full encrypted snapshot per accepted version and is
|
|
74
|
+
never pruned. Old snapshots are load-bearing: `getGroupChanges` serves signed
|
|
75
|
+
history from them, so deleting rows breaks catch-up for clients behind that
|
|
76
|
+
version. A snapshot-compaction protocol is future work; budget storage as
|
|
77
|
+
O(versions × state size) per group.
|
|
78
|
+
|
|
79
|
+
## Mount the public wrappers
|
|
80
|
+
|
|
81
|
+
Create the wrapper once with the mounted component reference and the app's
|
|
82
|
+
authentication hook:
|
|
83
|
+
|
|
84
|
+
```ts
|
|
85
|
+
// convex/relayBackend.ts
|
|
86
|
+
import { components } from './_generated/api';
|
|
87
|
+
import { defineConvexSignalProtocolBackend } from '@open-e2ee/signal-protocol-sdk/remote/relay/convex';
|
|
88
|
+
import { resolveProtocolIdentity } from './auth';
|
|
89
|
+
|
|
90
|
+
export const signalRelay = defineConvexSignalProtocolBackend(
|
|
91
|
+
components.signalProtocol,
|
|
92
|
+
{
|
|
93
|
+
identify: async (ctx) => {
|
|
94
|
+
const identity = await resolveProtocolIdentity(ctx);
|
|
95
|
+
return {
|
|
96
|
+
userId: identity.userId,
|
|
97
|
+
aciBytes: identity.aciBytes,
|
|
98
|
+
pniBytes: identity.pniBytes,
|
|
99
|
+
};
|
|
100
|
+
},
|
|
101
|
+
}
|
|
102
|
+
);
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
The relay reads these functions through `api.signal`, so the modules must live
|
|
106
|
+
inside that namespace rather than at the top of `convex/`:
|
|
107
|
+
|
|
108
|
+
```ts
|
|
109
|
+
// convex/signal/groups.ts
|
|
110
|
+
import { signalRelay } from '../relayBackend';
|
|
111
|
+
|
|
112
|
+
export const {
|
|
113
|
+
createGroup,
|
|
114
|
+
getGroup,
|
|
115
|
+
getGroupJoinInfo,
|
|
116
|
+
getGroupChanges,
|
|
117
|
+
submitGroupChange,
|
|
118
|
+
refreshGroupSendEndorsements,
|
|
119
|
+
} = signalRelay.groups;
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
```ts
|
|
123
|
+
// convex/signal/zkAuth.ts
|
|
124
|
+
import { signalRelay } from '../relayBackend';
|
|
125
|
+
|
|
126
|
+
export const {
|
|
127
|
+
issueAuthCredentialMutation,
|
|
128
|
+
issueProfileKeyCredentialMutation,
|
|
129
|
+
} = signalRelay.zkAuth;
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
Mount the remaining relay namespaces alongside those group modules:
|
|
133
|
+
|
|
134
|
+
```ts
|
|
135
|
+
// convex/signal/messages.ts
|
|
136
|
+
import { signalRelay } from '../relayBackend';
|
|
137
|
+
export const {
|
|
138
|
+
send,
|
|
139
|
+
getPendingMessages,
|
|
140
|
+
markDelivered,
|
|
141
|
+
getActiveDevices,
|
|
142
|
+
sendUnidentified,
|
|
143
|
+
sendMultiRecipientUnidentified,
|
|
144
|
+
sendRetryRequest,
|
|
145
|
+
getPendingRetryRequests,
|
|
146
|
+
markRetryRequestHandled,
|
|
147
|
+
} = signalRelay.messages;
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
```ts
|
|
151
|
+
// convex/signal/devices.ts
|
|
152
|
+
import { signalRelay } from '../relayBackend';
|
|
153
|
+
export const {
|
|
154
|
+
getDevices,
|
|
155
|
+
registerDevice,
|
|
156
|
+
removeDevice,
|
|
157
|
+
markDeviceConnected,
|
|
158
|
+
markDeviceDisconnected,
|
|
159
|
+
presenceHeartbeat,
|
|
160
|
+
} = signalRelay.devices;
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
```ts
|
|
164
|
+
// convex/signal/keys.ts
|
|
165
|
+
import { signalRelay } from '../relayBackend';
|
|
166
|
+
export const {
|
|
167
|
+
uploadIdentityKey,
|
|
168
|
+
getIdentityKey,
|
|
169
|
+
uploadPreKeys,
|
|
170
|
+
fetchPreKeyBundle,
|
|
171
|
+
getPreKeyCount,
|
|
172
|
+
clearStaleKemPreKeys,
|
|
173
|
+
uploadEcSignedPreKey,
|
|
174
|
+
uploadKemLastResortPreKey,
|
|
175
|
+
getEcSignedPreKeyMetadata,
|
|
176
|
+
getKemLastResortPreKeyMetadata,
|
|
177
|
+
} = signalRelay.keys;
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
```ts
|
|
181
|
+
// convex/signal/certificates.ts
|
|
182
|
+
import { signalRelay } from '../relayBackend';
|
|
183
|
+
export const { issueSenderCertificate } = signalRelay.certificates;
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
```ts
|
|
187
|
+
// convex/signal/provisioning.ts
|
|
188
|
+
import { signalRelay } from '../relayBackend';
|
|
189
|
+
export const {
|
|
190
|
+
createProvisioningSession,
|
|
191
|
+
connectNewDevice,
|
|
192
|
+
sendProvisioningMessage,
|
|
193
|
+
getProvisioningMessage,
|
|
194
|
+
completeProvisioning,
|
|
195
|
+
acknowledgeProvisioning,
|
|
196
|
+
rollbackProvisioning,
|
|
197
|
+
deleteProvisioningSession,
|
|
198
|
+
} = signalRelay.provisioning;
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
`messages` owns identified and sealed delivery, multi-recipient fan-out, retry
|
|
202
|
+
queues, and message/device lookup reads. `devices` owns registration, removal,
|
|
203
|
+
connection state, and presence. `keys` owns identity provisioning and
|
|
204
|
+
compare-and-swap rotation, prekey upload, atomic one-time-key consumption, and
|
|
205
|
+
key metadata. `certificates` issues sender certificates for registered
|
|
206
|
+
account/device identities. `provisioning` owns the linked-device session state
|
|
207
|
+
machine through acknowledgment or rollback.
|
|
208
|
+
|
|
209
|
+
The account-scoped wrappers resolve the caller identity on the server and
|
|
210
|
+
inject the application `userId`, raw ACI, and optional PNI bytes into the
|
|
211
|
+
isolated component. Client-supplied owner IDs are never trusted. Credential
|
|
212
|
+
issuance also resolves identity. Group wrappers pass client arguments through
|
|
213
|
+
untouched because group reads and writes authenticate membership solely through
|
|
214
|
+
the supplied zero-knowledge presentation.
|
|
215
|
+
|
|
216
|
+
`sendUnidentified` and `sendMultiRecipientUnidentified` are the deliberate
|
|
217
|
+
exception: those sealed-sender paths do **not** call `identify`. They authorize
|
|
218
|
+
the bearer request with the target's unidentified-access key or verified group
|
|
219
|
+
send material, preserving delivery without an authenticated application
|
|
220
|
+
session. Rejections are structured `ConvexError` data, and the relay adapter
|
|
221
|
+
decides whether to fall back to identified delivery by reading
|
|
222
|
+
`data.code === 'UNAUTHORIZED'` — not by matching on the message text. A
|
|
223
|
+
deployment that wraps or re-throws component rejections must preserve `code`,
|
|
224
|
+
or a sealed send that should have retried on the identified path will surface
|
|
225
|
+
as a hard failure instead.
|
|
226
|
+
|
|
227
|
+
A recipient's unidentified-access key is registered as a side effect of the
|
|
228
|
+
zero-knowledge profile-key credential flow
|
|
229
|
+
(`issueProfileKeyCredentialMutation`). Until a recipient has completed that
|
|
230
|
+
flow, access-key-authorized sealed sends to them are rejected and the client
|
|
231
|
+
falls back to identified delivery — messages still arrive, but without sender
|
|
232
|
+
anonymity. Deployments that want sealed sender for 1:1 messaging must drive
|
|
233
|
+
the profile-key credential flow during account setup, not lazily.
|
|
234
|
+
|
|
235
|
+
`identify` must return the authenticated account's real ACI, and its real PNI
|
|
236
|
+
or **no PNI at all**, plus the application-owned `userId` used for relay
|
|
237
|
+
routing. Never substitute a shared placeholder value for accounts without a
|
|
238
|
+
PNI: credentials are matched by ACI-or-PNI alias, so a constant PNI issued to
|
|
239
|
+
every account would let any authenticated user act on any PNI-addressed pending
|
|
240
|
+
membership. An absent PNI must be absent.
|
|
241
|
+
|
|
242
|
+
## Retention and rate limiting
|
|
243
|
+
|
|
244
|
+
Component-owned interval jobs delete expired seven-day messages hourly,
|
|
245
|
+
expired seven-day retry requests hourly, expired provisioning sessions every
|
|
246
|
+
minute, and stale KEM prekeys daily. Cleanup mutations delete bounded batches
|
|
247
|
+
and schedule immediate continuations until the indexed range is empty.
|
|
248
|
+
|
|
249
|
+
Completing a provisioning session grants the acknowledgment its own full
|
|
250
|
+
session TTL. A link that is never acknowledged within that window is rolled
|
|
251
|
+
back by the cron: the device it created is deleted together with all of its
|
|
252
|
+
key material, queued messages, and heartbeats. Teardown matches the device's
|
|
253
|
+
`linkedAt` stamp recorded at completion, so a device legitimately
|
|
254
|
+
re-registered into a freed slot is never reaped by a stale session.
|
|
255
|
+
|
|
256
|
+
Prekey-bundle fetches use the mounted `@convex-dev/rate-limiter` child
|
|
257
|
+
component. Each authenticated fetcher/target-account pair receives ten fetches
|
|
258
|
+
per fixed one-minute window. The eleventh request fails with structured
|
|
259
|
+
`RATE_LIMITED` data and HTTP-equivalent status 429.
|
|
260
|
+
|
|
261
|
+
## Upgrading: clear `messages` before deploying this version
|
|
262
|
+
|
|
263
|
+
This version drops two shapes from the `messages` table: the optional
|
|
264
|
+
`groupId` field, and `plaintext_content` from the `messageType` union.
|
|
265
|
+
|
|
266
|
+
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
|
+
one whose `messageType` is `plaintext_content`, therefore fails the deploy —
|
|
269
|
+
and no migration mutation can fix it, because the deploy that would ship the
|
|
270
|
+
mutation is the deploy that fails. The order has to be: clear first, deploy
|
|
271
|
+
second.
|
|
272
|
+
|
|
273
|
+
Messages are transient by design. The table has a seven-day TTL and an hourly
|
|
274
|
+
cleanup cron, and undelivered messages are re-requested by clients through the
|
|
275
|
+
retry path, so clearing it is a normal operation rather than data loss.
|
|
276
|
+
|
|
277
|
+
Check whether the deployment has anything to clear — still on the previous
|
|
278
|
+
version, since the table lives inside the component rather than the app:
|
|
279
|
+
|
|
280
|
+
```sh
|
|
281
|
+
npx convex data messages --component signalProtocol
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
Add `--prod` or `--deployment <name-or-reference>` to target a deployment other
|
|
285
|
+
than your dev one. A deployment that has never relayed a group message and
|
|
286
|
+
never had a caller pass `plaintext_content` has no affected rows and needs no
|
|
287
|
+
action — no send path in this SDK ever produced the latter.
|
|
288
|
+
|
|
289
|
+
If there are rows, either wait or clear:
|
|
290
|
+
|
|
291
|
+
- **Wait.** Stop sending, and the hourly cleanup cron drains the table as the
|
|
292
|
+
seven-day retention window expires. No manual step, but it takes a week.
|
|
293
|
+
- **Clear.** In the Convex dashboard, select the `signalProtocol` component,
|
|
294
|
+
open the `messages` table, and clear it. Undelivered messages are lost;
|
|
295
|
+
clients re-request them over the retry path.
|
|
296
|
+
|
|
297
|
+
Deploy once the table is empty.
|
|
298
|
+
|
|
299
|
+
## Secret initialization and pinned trust root
|
|
300
|
+
|
|
301
|
+
From the Convex app directory, run:
|
|
302
|
+
|
|
303
|
+
```sh
|
|
304
|
+
npx oe-groups trust-root
|
|
305
|
+
```
|
|
306
|
+
|
|
307
|
+
Add `--prod` for the default production deployment or
|
|
308
|
+
`--deployment <name-or-reference>` for another deployment. The command checks
|
|
309
|
+
`OE_GROUPS_SERVER_SECRET`, generates a cryptographically random 32-byte seed
|
|
310
|
+
only when it is absent, writes it to the selected Convex deployment through
|
|
311
|
+
stdin, and prints two labelled base64 roots — the serialized group trust root
|
|
312
|
+
and the Ed25519 sender-certificate root. Pin both in the client build; see
|
|
313
|
+
[Sender certificate trust root](#sender-certificate-trust-root) for where each
|
|
314
|
+
one goes. Never fetch and trust either at runtime.
|
|
315
|
+
|
|
316
|
+
The seed remains in the Convex environment and deterministically derives all
|
|
317
|
+
four server keypairs. It is never written to a Convex table or log. Back up the
|
|
318
|
+
deployment secret: deleting or replacing it rotates the trust root and strands
|
|
319
|
+
clients pinned to the previous deployment.
|
|
320
|
+
|
|
321
|
+
## Sender certificate trust root
|
|
322
|
+
|
|
323
|
+
`certificates.issueSenderCertificate` signs sender certificates with an Ed25519
|
|
324
|
+
key pair deterministically derived from the deployment secret, domain-separated
|
|
325
|
+
from the group signing key by distinct KDF labels
|
|
326
|
+
(`open-e2ee:sealed-sender:root:v1` / `:server:v1`). Clients verify inbound
|
|
327
|
+
sealed-sender certificates against the matching Ed25519 **root** public key.
|
|
328
|
+
|
|
329
|
+
`oe-groups trust-root` prints both roots, labelled:
|
|
330
|
+
|
|
331
|
+
```
|
|
332
|
+
group trust root: <base64>
|
|
333
|
+
sealed sender trust root: <base64>
|
|
334
|
+
```
|
|
335
|
+
|
|
336
|
+
They are pinned in different places and are not interchangeable — the group
|
|
337
|
+
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; never
|
|
339
|
+
fetch either from a relay at runtime, since a relay that chooses the root it is
|
|
340
|
+
validated against can mint certificates for any sender.
|
|
341
|
+
|
|
342
|
+
Both are derived from the same deployment secret, so rotating
|
|
343
|
+
`OE_GROUPS_SERVER_SECRET` rotates both and strands clients pinned to either
|
|
344
|
+
previous value.
|
|
345
|
+
|
|
346
|
+
With `trustRoots` left empty, inbound sealed-sender validation stays disabled
|
|
347
|
+
and sends fall back to identified delivery — messages still arrive, but the
|
|
348
|
+
sender is disclosed to the relay.
|
|
349
|
+
|
|
350
|
+
## Group metadata privacy
|
|
351
|
+
|
|
352
|
+
The relay cannot read message contents, cannot derive membership from group
|
|
353
|
+
state, and no longer sees a group identifier on the two channels that used to
|
|
354
|
+
carry one.
|
|
355
|
+
|
|
356
|
+
**Closed: the distribution identifier in the frame.** The identified send path
|
|
357
|
+
stores the framed `SenderKeyMessage` as its `ciphertext`, and that frame's
|
|
358
|
+
`distributionUuid` is **not** encrypted. It used to embed
|
|
359
|
+
`groupId:senderUserId:senderDeviceId:timestamp`, so the group and the sender's
|
|
360
|
+
device were readable straight out of the ciphertext column — and, worse than a
|
|
361
|
+
column, off every message in flight to any relay on the path. Sealed sender did
|
|
362
|
+
not help: it hides the frame from the relay but not from the rest of the path,
|
|
363
|
+
and it is disabled until the trust root is exported (see above), so group
|
|
364
|
+
traffic takes the identified path anyway. Distribution identifiers are now
|
|
365
|
+
opaque random UUIDs carrying no group, sender, device, or clock, as the
|
|
366
|
+
reference implementation uses, as the sender-keys specification now requires.
|
|
367
|
+
|
|
368
|
+
**Closed: the `groupId` column.** Every `messages` row used to store a plaintext
|
|
369
|
+
`groupId` next to `targetUserId` for the seven-day retention window. The column
|
|
370
|
+
is gone. What replaces it is a `sender_key` message type, which tells the
|
|
371
|
+
receiver to decrypt the payload as a framed `SenderKeyMessage` and nothing more:
|
|
372
|
+
the receiver reads the opaque distribution identifier out of the frame and
|
|
373
|
+
resolves the group against its own sender key store. No group identifier
|
|
374
|
+
travels on an envelope, sealed or not.
|
|
375
|
+
|
|
376
|
+
**Open: the group partition itself.** Removing the identifier removed the
|
|
377
|
+
group's *name*, not the ability to group rows. Be precise about what is left,
|
|
378
|
+
because the difference matters and it is easy to overstate:
|
|
379
|
+
|
|
380
|
+
- The frame's `distributionUuid` is unencrypted and is stored verbatim inside
|
|
381
|
+
`messages.ciphertext` — the paragraph above says as much. It is opaque, but
|
|
382
|
+
it is stable for the life of a sender key, and nothing rotates keys on a
|
|
383
|
+
timer. Grouping rows by it recovers the recipient set for a sender's group
|
|
384
|
+
traffic.
|
|
385
|
+
- Sender keys encrypt once and fan out, so every recipient row of one send
|
|
386
|
+
carries a byte-identical `ciphertext`. Grouping by that recovers the
|
|
387
|
+
recipient set of a single send, which is sharper than the old column.
|
|
388
|
+
- The fan-out stamps one `timestamp` across every recipient row, and passes
|
|
389
|
+
through one `clientMessageId` when the application supplies one.
|
|
390
|
+
- `sendMultiRecipientUnidentified` hands the relay the roster explicitly, in
|
|
391
|
+
one call — the sealed-sender path names the recipient set outright.
|
|
392
|
+
|
|
393
|
+
So the relay cannot learn *which* group, or its name, membership list, or
|
|
394
|
+
attributes — but it can still partition delivery pairs into unlabeled groups,
|
|
395
|
+
and any one of those channels suffices. That is a real improvement on a
|
|
396
|
+
plaintext `groupId`, which handed over a stable, meaningful, cross-send label;
|
|
397
|
+
it is not anonymity of the partition. The `sender_key` type is also a
|
|
398
|
+
single-column filter isolating group traffic from pairwise traffic, which the
|
|
399
|
+
old design did not offer — group messages used to hide among `ciphertext` rows.
|
|
400
|
+
|
|
401
|
+
**Still visible.** Delivery metadata itself: who sent to whom, when, and how
|
|
402
|
+
much. Every relay sees this. Sealed sender removes the sender from the
|
|
403
|
+
identified half of it.
|
|
404
|
+
|
|
405
|
+
## Authorization is account-scoped, not device-scoped
|
|
406
|
+
|
|
407
|
+
`identify` maps an authenticated session to an account (`userId`), with no
|
|
408
|
+
device. Every account-scoped endpoint therefore authorizes at account
|
|
409
|
+
granularity, and the `deviceId` arguments are routing selectors chosen by the
|
|
410
|
+
caller rather than authenticated claims. Concretely, any session for an account
|
|
411
|
+
can read and delete **any** of that account's device queues
|
|
412
|
+
(`getPendingMessages`, `markDelivered`), send as any of its device IDs
|
|
413
|
+
(`send.senderDeviceId`), and upload or rotate key material for any of its
|
|
414
|
+
devices (`keys`).
|
|
415
|
+
|
|
416
|
+
This is the intended model — a compromised session already holds the account —
|
|
417
|
+
but it means the component provides no isolation *between* an account's own
|
|
418
|
+
devices. Deployments that need device isolation must issue device-scoped
|
|
419
|
+
sessions and enforce the binding in their own `identify` wrapper; the component
|
|
420
|
+
cannot do it while its identity has no device field.
|
|
421
|
+
|
|
422
|
+
## Profile-key issuance threat model
|
|
423
|
+
|
|
424
|
+
`issueProfileKeyCredentialMutation` receives the raw 32-byte profile key. The
|
|
425
|
+
group server therefore sees the plaintext profile key at issuance time. The
|
|
426
|
+
credential proof hides it in later group presentations, but issuance in this
|
|
427
|
+
credential layer is not blinded. Blinded issuance is a future credential-layer
|
|
428
|
+
candidate and is explicitly outside this component's scope.
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
# In-Memory Relay
|
|
2
|
+
|
|
3
|
+
`InMemorySignalProtocolRelayServer` implements `ISignalProtocolRelayServer` in memory for examples
|
|
4
|
+
and local application development.
|
|
5
|
+
|
|
6
|
+
Real protocol and cryptography; simulated in-memory infrastructure.
|
|
7
|
+
|
|
8
|
+
## Why it exists
|
|
9
|
+
|
|
10
|
+
It provides device registration, public-prekey exchange, and encrypted-envelope
|
|
11
|
+
delivery without deploying a backend. It is a development adapter, not an
|
|
12
|
+
authorization or durability boundary.
|
|
13
|
+
|
|
14
|
+
## Usage
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
// Real protocol and cryptography; simulated in-memory infrastructure.
|
|
18
|
+
import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
19
|
+
import { inMemoryStore } from "@open-e2ee/signal-protocol-sdk/local/store/memory";
|
|
20
|
+
import { inMemoryRelay } from "@open-e2ee/signal-protocol-sdk/remote/relay/memory";
|
|
21
|
+
|
|
22
|
+
const relay = inMemoryRelay();
|
|
23
|
+
const client = await createSignalProtocolClient({
|
|
24
|
+
identity: { userId: "alice" },
|
|
25
|
+
adapters: { storage: inMemoryStore(), relay },
|
|
26
|
+
});
|
|
27
|
+
|
|
28
|
+
await client.syncToServer();
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
All registered devices, public keys, mailboxes, and provisioning state disappear
|
|
32
|
+
with the adapter. It performs no real account authentication, rate limiting,
|
|
33
|
+
abuse prevention, or durable delivery and must not be used in production.
|
|
34
|
+
|
|
35
|
+
## Deterministic failure and recovery exercises
|
|
36
|
+
|
|
37
|
+
Failure mode is opt-in and seeded. The default `inMemoryRelay()` remains the
|
|
38
|
+
deterministic happy path:
|
|
39
|
+
|
|
40
|
+
```ts
|
|
41
|
+
// Real protocol and cryptography; simulated in-memory infrastructure.
|
|
42
|
+
import { inMemoryRelay } from "@open-e2ee/signal-protocol-sdk/remote/relay/memory";
|
|
43
|
+
|
|
44
|
+
const relay = inMemoryRelay({
|
|
45
|
+
failures: {
|
|
46
|
+
seed: 7,
|
|
47
|
+
latencyMs: 20,
|
|
48
|
+
duplicateDeliveryEvery: 3,
|
|
49
|
+
reorderDeliveryPairs: true,
|
|
50
|
+
rejectAuthorization: true,
|
|
51
|
+
exhaustOneTimePreKeys: true,
|
|
52
|
+
},
|
|
53
|
+
});
|
|
54
|
+
|
|
55
|
+
relay.failures.disconnect("bob", 1);
|
|
56
|
+
// Sends remain in Bob's encrypted mailbox.
|
|
57
|
+
relay.failures.reconnect("bob", 1);
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
`flushReordered()` releases an unmatched final envelope. `configure()` changes
|
|
61
|
+
a scenario without rebuilding clients. Authorization rejection raises
|
|
62
|
+
`SealedSenderAuthError`, allowing the client's documented identified-delivery
|
|
63
|
+
fallback. One-time-prekey exhaustion withholds both EC and KEM one-time keys but
|
|
64
|
+
keeps the KEM last-resort key, so strict-PQ examples exercise the intended
|
|
65
|
+
post-quantum recovery path rather than a silent classical downgrade. Failure
|
|
66
|
+
selection uses the configured seed and delivery count, never `Math.random()` or
|
|
67
|
+
wall-clock time.
|
|
68
|
+
|
|
69
|
+
See the parent [relay guide](../README.md).
|
|
@@ -0,0 +1,162 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
import { randomBytes } from 'node:crypto';
|
|
4
|
+
import { spawnSync } from 'node:child_process';
|
|
5
|
+
import { fileURLToPath, pathToFileURL } from 'node:url';
|
|
6
|
+
import path from 'node:path';
|
|
7
|
+
|
|
8
|
+
const SECRET_ENV_VAR = 'OE_GROUPS_SERVER_SECRET';
|
|
9
|
+
|
|
10
|
+
function usage(message) {
|
|
11
|
+
if (message) process.stderr.write(`${message}\n\n`);
|
|
12
|
+
process.stderr.write(
|
|
13
|
+
'Usage: oe-groups trust-root [--prod | --deployment <deployment>]\n'
|
|
14
|
+
);
|
|
15
|
+
process.exitCode = 2;
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
function deploymentArgs(args) {
|
|
19
|
+
if (args.length === 0) return [];
|
|
20
|
+
if (args.length === 1 && args[0] === '--prod') return ['--prod'];
|
|
21
|
+
if (
|
|
22
|
+
args.length === 2 &&
|
|
23
|
+
args[0] === '--deployment' &&
|
|
24
|
+
args[1].trim().length > 0
|
|
25
|
+
) {
|
|
26
|
+
return args;
|
|
27
|
+
}
|
|
28
|
+
usage('Invalid deployment arguments');
|
|
29
|
+
return null;
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
function runConvex(args, options = {}) {
|
|
33
|
+
const command = process.platform === 'win32' ? 'npx.cmd' : 'npx';
|
|
34
|
+
const result = spawnSync(command, ['convex', 'env', ...args], {
|
|
35
|
+
cwd: process.cwd(),
|
|
36
|
+
encoding: 'utf8',
|
|
37
|
+
input: options.input,
|
|
38
|
+
stdio: ['pipe', 'pipe', 'pipe'],
|
|
39
|
+
});
|
|
40
|
+
if (result.error) throw result.error;
|
|
41
|
+
if (result.status !== 0) {
|
|
42
|
+
const detail = result.stderr?.trim();
|
|
43
|
+
throw new Error(
|
|
44
|
+
detail
|
|
45
|
+
? `Convex environment command failed: ${detail}`
|
|
46
|
+
: `Convex environment command exited with status ${result.status}`
|
|
47
|
+
);
|
|
48
|
+
}
|
|
49
|
+
return result.stdout ?? '';
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
function requireSeed(encoded) {
|
|
53
|
+
const normalized = encoded.trim();
|
|
54
|
+
const seed = Buffer.from(normalized, 'base64');
|
|
55
|
+
if (
|
|
56
|
+
seed.length !== 32 ||
|
|
57
|
+
seed.toString('base64') !== normalized
|
|
58
|
+
) {
|
|
59
|
+
throw new Error(
|
|
60
|
+
`${SECRET_ENV_VAR} must be canonical base64 encoding exactly 32 bytes`
|
|
61
|
+
);
|
|
62
|
+
}
|
|
63
|
+
return new Uint8Array(seed);
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
async function printTrustRoot(args) {
|
|
67
|
+
const selectedDeployment = deploymentArgs(args);
|
|
68
|
+
if (!selectedDeployment) return;
|
|
69
|
+
|
|
70
|
+
const names = runConvex([
|
|
71
|
+
'list',
|
|
72
|
+
'--names-only',
|
|
73
|
+
...selectedDeployment,
|
|
74
|
+
])
|
|
75
|
+
.split(/\r?\n/)
|
|
76
|
+
.map((name) => name.trim())
|
|
77
|
+
.filter(Boolean);
|
|
78
|
+
|
|
79
|
+
let seed;
|
|
80
|
+
if (names.includes(SECRET_ENV_VAR)) {
|
|
81
|
+
seed = requireSeed(
|
|
82
|
+
runConvex(['get', SECRET_ENV_VAR, ...selectedDeployment])
|
|
83
|
+
);
|
|
84
|
+
} else {
|
|
85
|
+
seed = new Uint8Array(randomBytes(32));
|
|
86
|
+
const encoded = Buffer.from(seed).toString('base64');
|
|
87
|
+
runConvex(
|
|
88
|
+
['set', SECRET_ENV_VAR, ...selectedDeployment],
|
|
89
|
+
{ input: `${encoded}\n` }
|
|
90
|
+
);
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
const scriptDirectory = path.dirname(fileURLToPath(import.meta.url));
|
|
94
|
+
const [
|
|
95
|
+
{ generateServerSecretParams, getServerPublicParams },
|
|
96
|
+
{ encodeGroupTrustRoot },
|
|
97
|
+
{ deriveSealedSenderRootPublicKey },
|
|
98
|
+
] = await Promise.all([
|
|
99
|
+
// pathToFileURL: dynamic import of a bare absolute path fails on
|
|
100
|
+
// Windows, where the ESM loader requires a file:// URL.
|
|
101
|
+
import(
|
|
102
|
+
pathToFileURL(
|
|
103
|
+
path.join(
|
|
104
|
+
scriptDirectory,
|
|
105
|
+
'../dist/internal/protocol/zk/groups/server-params.js'
|
|
106
|
+
)
|
|
107
|
+
).href
|
|
108
|
+
),
|
|
109
|
+
import(
|
|
110
|
+
pathToFileURL(
|
|
111
|
+
path.join(
|
|
112
|
+
scriptDirectory,
|
|
113
|
+
'../dist/internal/groups/trust-root.js'
|
|
114
|
+
)
|
|
115
|
+
).href
|
|
116
|
+
),
|
|
117
|
+
import(
|
|
118
|
+
pathToFileURL(
|
|
119
|
+
path.join(
|
|
120
|
+
scriptDirectory,
|
|
121
|
+
'../dist/internal/protocol/sealed-sender/trust-root.js'
|
|
122
|
+
)
|
|
123
|
+
).href
|
|
124
|
+
),
|
|
125
|
+
]);
|
|
126
|
+
const secretParams = generateServerSecretParams(seed);
|
|
127
|
+
seed.fill(0);
|
|
128
|
+
const publicParams = getServerPublicParams(secretParams);
|
|
129
|
+
const trustRoot = encodeGroupTrustRoot({
|
|
130
|
+
credentialPublicKey: publicParams.credentialPublicKey,
|
|
131
|
+
serverSigningPublicKey: publicParams.signingPublicKey,
|
|
132
|
+
profileKeyCredentialPublicKey:
|
|
133
|
+
publicParams.profileKeyCredentialPublicKey,
|
|
134
|
+
endorsementRootPublicKey: publicParams.endorsementPublicKey,
|
|
135
|
+
});
|
|
136
|
+
const sealedSenderRoot = await deriveSealedSenderRootPublicKey(
|
|
137
|
+
secretParams.signingKeyPair.signingKey
|
|
138
|
+
);
|
|
139
|
+
|
|
140
|
+
// Two independently pinned roots, printed with labels because they go to
|
|
141
|
+
// different places in the client build and are not interchangeable.
|
|
142
|
+
process.stdout.write(
|
|
143
|
+
`group trust root: ${Buffer.from(trustRoot).toString('base64')}\n`
|
|
144
|
+
);
|
|
145
|
+
process.stdout.write(
|
|
146
|
+
`sealed sender trust root: ${Buffer.from(sealedSenderRoot).toString('base64')}\n`
|
|
147
|
+
);
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
const [command, ...args] = process.argv.slice(2);
|
|
151
|
+
if (command !== 'trust-root') {
|
|
152
|
+
usage(command ? `Unknown command: ${command}` : undefined);
|
|
153
|
+
} else {
|
|
154
|
+
try {
|
|
155
|
+
await printTrustRoot(args);
|
|
156
|
+
} catch (error) {
|
|
157
|
+
process.stderr.write(
|
|
158
|
+
`${error instanceof Error ? error.message : String(error)}\n`
|
|
159
|
+
);
|
|
160
|
+
process.exitCode = 1;
|
|
161
|
+
}
|
|
162
|
+
}
|