@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
package/docs/E2EE.md
CHANGED
|
@@ -1,13 +1,21 @@
|
|
|
1
1
|
# End-to-End Encryption
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
3
|
+
> Navigation: [README](../README.md) | [Getting Started](./GETTING_STARTED.md) |
|
|
4
|
+
> [Security Model](./SECURITY.md) | [Architecture](../ARCHITECTURE.md)
|
|
5
|
+
|
|
6
|
+
`@open-e2ee/signal-protocol-sdk` provides end-to-end encryption based on the
|
|
7
|
+
Signal Protocol: X3DH / PQXDH key agreement and the Double Ratchet, extended
|
|
8
|
+
with the Sparse Post-Quantum Ratchet (SPQR / ML-KEM Braid).
|
|
6
9
|
|
|
7
10
|
End-to-end encryption means plaintext exists only on the sender's and
|
|
8
11
|
recipient's devices. A relay or server sees ciphertext envelopes and routing
|
|
9
12
|
metadata, never message contents or long-term private keys.
|
|
10
13
|
|
|
14
|
+
This page explains what that changes about how you build. If you have only ever
|
|
15
|
+
built server-authoritative applications, most of the work of adopting E2EE is
|
|
16
|
+
absorbing these changes — the cryptography itself is the part the SDK already
|
|
17
|
+
did.
|
|
18
|
+
|
|
11
19
|
## Security Guarantees
|
|
12
20
|
|
|
13
21
|
- **End-to-end encryption** — message contents are encrypted on the sender's
|
|
@@ -20,11 +28,67 @@ metadata, never message contents or long-term private keys.
|
|
|
20
28
|
heals the session after a key compromise, so future messages regain
|
|
21
29
|
confidentiality once fresh ratchet keys are exchanged.
|
|
22
30
|
- **Post-quantum confidentiality** — PQXDH and the SPQR ratchet mix ML-KEM
|
|
23
|
-
(
|
|
24
|
-
resistance against harvest-now-decrypt-later adversaries.
|
|
31
|
+
(FIPS 203) shared secrets into key agreement and continuous ratcheting,
|
|
32
|
+
providing resistance against harvest-now-decrypt-later adversaries.
|
|
25
33
|
- **Authentication & integrity** — messages are authenticated (AEAD + MACs) and
|
|
26
34
|
identities are verifiable through safety numbers.
|
|
27
35
|
|
|
36
|
+
## What changes about your architecture
|
|
37
|
+
|
|
38
|
+
### The server becomes a relay
|
|
39
|
+
|
|
40
|
+
In a server-authoritative app, the database holds the truth and the backend
|
|
41
|
+
reads it to do its job. With E2EE the relay carries sealed envelopes: it can
|
|
42
|
+
route, store, and meter them, but it cannot read, search, filter, moderate, or
|
|
43
|
+
render them. Server-side features that assume plaintext — full-text search,
|
|
44
|
+
content previews, server-rendered notifications, analytics over message
|
|
45
|
+
content — do not degrade; they stop existing, and their replacements live on
|
|
46
|
+
the device. The [architecture overview](../ARCHITECTURE.md) shows exactly which
|
|
47
|
+
responsibilities sit on which side of that line.
|
|
48
|
+
|
|
49
|
+
### The device becomes the source of truth
|
|
50
|
+
|
|
51
|
+
Message history, session state, and keys live in device-local storage — that is
|
|
52
|
+
why the `storage` adapter is required, not optional. Ratchet state mutates on
|
|
53
|
+
every decrypt and must persist atomically; treating local storage as a cache
|
|
54
|
+
that can be dropped and refetched corrupts sessions irrecoverably. The
|
|
55
|
+
[integration interfaces](./INTERFACES.md) exist to make that contract explicit.
|
|
56
|
+
|
|
57
|
+
### Identity becomes a set of device keys
|
|
58
|
+
|
|
59
|
+
A user is no longer a row with a password hash; a user is a set of devices,
|
|
60
|
+
each with its own identity key. Adding a second device is a protocol operation
|
|
61
|
+
(linking), not a login. Removing one is revocation, not a session delete. Trust
|
|
62
|
+
is established per `(userId, identityType)` and verified with safety numbers —
|
|
63
|
+
see [Recipes](./RECIPES.md) for the multi-device and verification flows.
|
|
64
|
+
|
|
65
|
+
### Recovery becomes a product decision
|
|
66
|
+
|
|
67
|
+
When the server never has the keys, "forgot password" cannot restore content.
|
|
68
|
+
What recovery looks like — device-to-device transfer, an encrypted backup a
|
|
69
|
+
user can lose, or accepting history loss — is an application policy with real
|
|
70
|
+
security tradeoffs in every direction. The SDK does not silently choose one for
|
|
71
|
+
you. The considerations are laid out in the hosted guides at
|
|
72
|
+
[docs.open-e2ee.dev](https://docs.open-e2ee.dev).
|
|
73
|
+
|
|
74
|
+
### Metadata remains visible
|
|
75
|
+
|
|
76
|
+
E2EE protects content, not existence. The relay still observes envelope sizes,
|
|
77
|
+
timing, and routing — who is talking to whom, when, and how much. Sealed sender
|
|
78
|
+
narrows what the relay learns about senders, with published limits stated
|
|
79
|
+
plainly in the [security model](./SECURITY.md). Do not describe an E2EE product
|
|
80
|
+
as anonymous; the two properties are different, and conflating them is the most
|
|
81
|
+
common overclaim in this space.
|
|
82
|
+
|
|
83
|
+
### Failure modes are new
|
|
84
|
+
|
|
85
|
+
Sessions can desynchronize; identity keys change when someone reinstalls;
|
|
86
|
+
messages arrive out of order or reference skipped keys; one-time prekeys run
|
|
87
|
+
out. These are protocol realities, not bugs, and the SDK surfaces them as
|
|
88
|
+
explicit states and errors rather than hiding them — see
|
|
89
|
+
[Error Handling](./ERROR_HANDLING.md) for what each one means and what your
|
|
90
|
+
application should do about it.
|
|
91
|
+
|
|
28
92
|
## Verifiability
|
|
29
93
|
|
|
30
94
|
The implementation uses narrow protocol seams, explicit state transitions, and
|
|
@@ -32,4 +96,5 @@ injectable storage and relay boundaries so security properties can be evaluated
|
|
|
32
96
|
independently. This documentation describes intended behavior; it is not a
|
|
33
97
|
third-party security certification.
|
|
34
98
|
|
|
35
|
-
See also [SECURITY.md](
|
|
99
|
+
See also [SECURITY.md](./SECURITY.md), [ASSURANCE.md](./ASSURANCE.md), and
|
|
100
|
+
[ARCHITECTURE.md](../ARCHITECTURE.md).
|
package/docs/ERROR_HANDLING.md
CHANGED
|
@@ -368,7 +368,14 @@ if (isIdentityKeyChangedError(error)) {
|
|
|
368
368
|
// Don't silently accept - show security dialog
|
|
369
369
|
const accepted = await showSecurityWarningDialog(error);
|
|
370
370
|
if (accepted) {
|
|
371
|
-
|
|
371
|
+
// acceptIdentityRotation() takes the peer's new composite identity tuple,
|
|
372
|
+
// not the bare key carried on the error, and resets the sessions bound to
|
|
373
|
+
// the retired identity.
|
|
374
|
+
const userId = error.changedAddress.userId;
|
|
375
|
+
const identity = await relay.getIdentityKey(userId);
|
|
376
|
+
if (identity) {
|
|
377
|
+
await signal.acceptIdentityRotation(userId, identity);
|
|
378
|
+
}
|
|
372
379
|
}
|
|
373
380
|
}
|
|
374
381
|
```
|
package/docs/GETTING_STARTED.md
CHANGED
|
@@ -107,12 +107,14 @@ This is the target DX the package is moving toward. It is shown here so app
|
|
|
107
107
|
developers can understand the intended mental model while the current stable API
|
|
108
108
|
still uses `storage`, `remoteObjectStore`, hooks, and transition-only media helpers.
|
|
109
109
|
|
|
110
|
+
<!-- doc-snippet:skip target-message-api-not-yet-shipped -->
|
|
110
111
|
```ts
|
|
112
|
+
// Real protocol and cryptography; simulated in-memory infrastructure.
|
|
111
113
|
import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
112
114
|
import { createInMemoryDeviceStorage } from "@open-e2ee/signal-protocol-sdk/device/storage/memory";
|
|
113
|
-
import {
|
|
115
|
+
import { inMemoryRelay } from "@open-e2ee/signal-protocol-sdk/remote/relay/memory";
|
|
114
116
|
|
|
115
|
-
const relay =
|
|
117
|
+
const relay = inMemoryRelay();
|
|
116
118
|
|
|
117
119
|
const alice = await createSignalProtocolClient({
|
|
118
120
|
identity: { userId: "alice", deviceId: 1 },
|
|
@@ -180,8 +182,8 @@ const signal = await createSignalProtocolClient({
|
|
|
180
182
|
```
|
|
181
183
|
|
|
182
184
|
Attachments use the same message API. On Expo, pass the picker URI; the Signal
|
|
183
|
-
client copies or persists the bytes through `deviceStorage.files`
|
|
184
|
-
so retry can continue after restart:
|
|
185
|
+
Protocol client copies or persists the bytes through `deviceStorage.files`
|
|
186
|
+
before upload so retry can continue after restart:
|
|
185
187
|
|
|
186
188
|
```ts
|
|
187
189
|
await signal.messages.send({
|
|
@@ -222,16 +224,18 @@ current `signal.media.*` examples into lower-level transition or migration docs.
|
|
|
222
224
|
|
|
223
225
|
## Current Stable Local Clients
|
|
224
226
|
|
|
225
|
-
Use
|
|
227
|
+
Use the in-memory adapters for local examples and development:
|
|
226
228
|
the demo sends while Bob is offline, inspects the relay-visible ciphertext, and
|
|
227
229
|
then starts Bob's subscription to show the decrypted plaintext entering the app.
|
|
228
230
|
|
|
231
|
+
<!-- doc-snippet:run getting-started-stable-local-clients expect="bob decrypted: alice: hello" -->
|
|
229
232
|
```ts
|
|
233
|
+
// Real protocol and cryptography; simulated in-memory infrastructure.
|
|
230
234
|
import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
231
|
-
import {
|
|
232
|
-
import {
|
|
235
|
+
import { inMemoryStore } from "@open-e2ee/signal-protocol-sdk/local/store/memory";
|
|
236
|
+
import { inMemoryRelay } from "@open-e2ee/signal-protocol-sdk/remote/relay/memory";
|
|
233
237
|
|
|
234
|
-
const relay =
|
|
238
|
+
const relay = inMemoryRelay();
|
|
235
239
|
|
|
236
240
|
// The relay knows which devices exist, but it does not get plaintext.
|
|
237
241
|
await relay.registerDevice("alice", {
|
|
@@ -242,12 +246,12 @@ await relay.registerDevice("bob", { encryptedDeviceName: new ArrayBuffer(0) });
|
|
|
242
246
|
// Each client represents one device. Its protocol storage is local to that device.
|
|
243
247
|
const alice = await createSignalProtocolClient({
|
|
244
248
|
identity: { userId: "alice" },
|
|
245
|
-
adapters: { storage:
|
|
249
|
+
adapters: { storage: inMemoryStore(), relay },
|
|
246
250
|
});
|
|
247
251
|
|
|
248
252
|
const bob = await createSignalProtocolClient({
|
|
249
253
|
identity: { userId: "bob" },
|
|
250
|
-
adapters: { storage:
|
|
254
|
+
adapters: { storage: inMemoryStore(), relay },
|
|
251
255
|
});
|
|
252
256
|
|
|
253
257
|
await alice.syncToServer();
|
|
@@ -299,7 +303,7 @@ relay sees encrypted envelope: {
|
|
|
299
303
|
bob decrypted: alice: hello
|
|
300
304
|
```
|
|
301
305
|
|
|
302
|
-
The
|
|
306
|
+
The in-memory relay lets the example inspect what a server can see. The relay sees
|
|
303
307
|
metadata plus encrypted envelope bytes; it does not receive Bob's decrypted
|
|
304
308
|
message content. The first message often uses `prekey_bundle` to establish a
|
|
305
309
|
session, and later messages use `ciphertext`.
|
|
@@ -315,11 +319,11 @@ import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
|
315
319
|
import { expoStore } from "@open-e2ee/signal-protocol-sdk/local/store/expo";
|
|
316
320
|
import {
|
|
317
321
|
convexRelay,
|
|
318
|
-
type
|
|
322
|
+
type ConvexSignalProtocolRelayApi,
|
|
319
323
|
} from "@open-e2ee/signal-protocol-sdk/remote/relay/convex";
|
|
320
324
|
import { api } from "../convex/_generated/api";
|
|
321
325
|
|
|
322
|
-
const signalApi = api.signal satisfies
|
|
326
|
+
const signalApi = api.signal satisfies ConvexSignalProtocolRelayApi;
|
|
323
327
|
|
|
324
328
|
// The relay handles server-side public keys, devices, and encrypted envelopes.
|
|
325
329
|
const relay = convexRelay({
|
|
@@ -332,7 +336,7 @@ const signal = await createSignalProtocolClient({
|
|
|
332
336
|
identity: { userId },
|
|
333
337
|
adapters: {
|
|
334
338
|
// Storage owns this device's private keys and session state.
|
|
335
|
-
storage: expoStore(
|
|
339
|
+
storage: expoStore(),
|
|
336
340
|
relay,
|
|
337
341
|
},
|
|
338
342
|
});
|
|
@@ -522,8 +526,8 @@ partial-byte store. Native background download code should implement the same
|
|
|
522
526
|
`MediaAttachmentTransfer` interface.
|
|
523
527
|
|
|
524
528
|
For background-safe uploads, use the durable client operation. The current API
|
|
525
|
-
persists bounded recovery metadata through the existing Signal storage
|
|
526
|
-
the target message-first API moves that responsibility behind
|
|
529
|
+
persists bounded recovery metadata through the existing Signal Protocol storage
|
|
530
|
+
adapter; the target message-first API moves that responsibility behind
|
|
527
531
|
`deviceStorage.messages`. The operation tries the upload when it is due and
|
|
528
532
|
returns either a completed pointer or a pending job id for later recovery:
|
|
529
533
|
|
|
@@ -560,8 +564,8 @@ await signal.media.processPending({
|
|
|
560
564
|
```
|
|
561
565
|
|
|
562
566
|
On receive, ask the media planner what work this device should do. Your app
|
|
563
|
-
supplies the IDs it has already processed or cached; the Signal package
|
|
564
|
-
the safe next step without taking ownership of your app database:
|
|
567
|
+
supplies the IDs it has already processed or cached; the Signal Protocol package
|
|
568
|
+
returns the safe next step without taking ownership of your app database:
|
|
565
569
|
|
|
566
570
|
```ts
|
|
567
571
|
const mediaWork = media.planMediaAttachmentProcessing({
|
package/docs/INTERFACES.md
CHANGED
|
@@ -12,30 +12,30 @@ policy.
|
|
|
12
12
|
|
|
13
13
|
```text
|
|
14
14
|
SignalProtocolClient
|
|
15
|
-
├──
|
|
16
|
-
├──
|
|
17
|
-
├──
|
|
15
|
+
├── ISignalProtocolLocalStore device-local protocol state
|
|
16
|
+
├── ISignalProtocolRelayServer authenticated device, prekey, and envelope service
|
|
17
|
+
├── SignalProtocolRemoteObjectStore brokered encrypted-object operations (optional)
|
|
18
18
|
├── media callbacks application-owned attachment bytes and caches
|
|
19
19
|
└── lifecycle hooks application reactions and observability
|
|
20
20
|
|
|
21
21
|
Local-store bootstrap
|
|
22
|
-
└──
|
|
22
|
+
└── ISignalProtocolLocalSecretVault small platform-managed bootstrap secrets
|
|
23
23
|
```
|
|
24
24
|
|
|
25
25
|
The interfaces are public contracts, but they do not make an implementation
|
|
26
26
|
secure by themselves. Each adapter must preserve the ownership and atomicity
|
|
27
27
|
requirements described below.
|
|
28
28
|
|
|
29
|
-
## `
|
|
29
|
+
## `ISignalProtocolLocalStore`
|
|
30
30
|
|
|
31
|
-
`
|
|
31
|
+
`ISignalProtocolLocalStore` persists the current device's identities, prekeys, sessions,
|
|
32
32
|
sender keys, contact trust, retry records, and operational metadata.
|
|
33
33
|
|
|
34
34
|
```ts
|
|
35
|
-
import type {
|
|
35
|
+
import type { ISignalProtocolLocalStore } from "@open-e2ee/signal-protocol-sdk/local/store";
|
|
36
36
|
import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
37
37
|
|
|
38
|
-
const storage:
|
|
38
|
+
const storage: ISignalProtocolLocalStore = appProtocolStore;
|
|
39
39
|
|
|
40
40
|
const client = await createSignalProtocolClient({
|
|
41
41
|
identity: { userId },
|
|
@@ -56,16 +56,16 @@ A production implementation must:
|
|
|
56
56
|
Available adapters and their status are documented in the
|
|
57
57
|
[local-store guide](../local/store/README.md).
|
|
58
58
|
|
|
59
|
-
## `
|
|
59
|
+
## `ISignalProtocolLocalSecretVault`
|
|
60
60
|
|
|
61
|
-
`
|
|
61
|
+
`ISignalProtocolLocalSecretVault` is a deliberately small interface for bootstrap
|
|
62
62
|
secrets that must live outside the main local store, such as a database
|
|
63
63
|
encryption key.
|
|
64
64
|
|
|
65
65
|
```ts
|
|
66
|
-
import type {
|
|
66
|
+
import type { ISignalProtocolLocalSecretVault } from "@open-e2ee/signal-protocol-sdk";
|
|
67
67
|
|
|
68
|
-
const vault:
|
|
68
|
+
const vault: ISignalProtocolLocalSecretVault = {
|
|
69
69
|
getSecret: (name) => platformSecrets.getBytes(name),
|
|
70
70
|
setSecret: (name, value) => platformSecrets.setBytes(name, value),
|
|
71
71
|
deleteSecret: (name) => platformSecrets.delete(name),
|
|
@@ -77,23 +77,23 @@ device migration, uninstall persistence, and deletion behavior depend on the
|
|
|
77
77
|
selected platform service and host configuration. See the
|
|
78
78
|
[secret-vault guide](../local/vault/README.md).
|
|
79
79
|
|
|
80
|
-
## `
|
|
80
|
+
## `ISignalProtocolRelayServer`
|
|
81
81
|
|
|
82
|
-
`
|
|
82
|
+
`ISignalProtocolRelayServer` represents the authenticated application backend used for
|
|
83
83
|
device registration, account identity state, public prekeys, encrypted-envelope
|
|
84
84
|
delivery, provisioning, key rotation, and encrypted group coordination.
|
|
85
85
|
|
|
86
86
|
```ts
|
|
87
|
-
import type {
|
|
87
|
+
import type { ISignalProtocolRelayServer } from "@open-e2ee/signal-protocol-sdk/remote/relay";
|
|
88
88
|
import {
|
|
89
89
|
convexRelay,
|
|
90
|
-
type
|
|
90
|
+
type ConvexSignalProtocolRelayApi,
|
|
91
91
|
} from "@open-e2ee/signal-protocol-sdk/remote/relay/convex";
|
|
92
92
|
import { api } from "../convex/_generated/api";
|
|
93
93
|
|
|
94
|
-
const signalApi = api.signal satisfies
|
|
94
|
+
const signalApi = api.signal satisfies ConvexSignalProtocolRelayApi;
|
|
95
95
|
|
|
96
|
-
const relay:
|
|
96
|
+
const relay: ISignalProtocolRelayServer = convexRelay({
|
|
97
97
|
convex,
|
|
98
98
|
api: signalApi,
|
|
99
99
|
currentUserId: userId,
|
|
@@ -110,17 +110,17 @@ The relay stores public protocol material, ciphertext, and required routing
|
|
|
110
110
|
metadata. It must not require device private keys or decrypted message content.
|
|
111
111
|
See the [relay guide](../remote/relay/README.md).
|
|
112
112
|
|
|
113
|
-
## `
|
|
113
|
+
## `SignalProtocolRemoteObjectStore`
|
|
114
114
|
|
|
115
|
-
`
|
|
115
|
+
`SignalProtocolRemoteObjectStore` supplies short-lived upload and download operations
|
|
116
116
|
for already encrypted objects. It is provider-neutral and optional.
|
|
117
117
|
|
|
118
118
|
```ts
|
|
119
119
|
import type {
|
|
120
|
-
|
|
120
|
+
SignalProtocolRemoteObjectStore,
|
|
121
121
|
} from "@open-e2ee/signal-protocol-sdk/remote/object-store";
|
|
122
122
|
|
|
123
|
-
const remoteObjectStore:
|
|
123
|
+
const remoteObjectStore: SignalProtocolRemoteObjectStore = {
|
|
124
124
|
createUpload: (request) => appObjectBroker.createUpload(request),
|
|
125
125
|
createDownload: (request) => appObjectBroker.createDownload(request),
|
|
126
126
|
completeUpload: (request) => appObjectBroker.completeUpload(request),
|
package/docs/PACKAGE_SURFACE.md
CHANGED
|
@@ -64,7 +64,8 @@ Expo storage or Convex helpers.
|
|
|
64
64
|
- `@open-e2ee/signal-protocol-sdk/remote/relay`
|
|
65
65
|
- `@open-e2ee/signal-protocol-sdk/remote/relay/convex`
|
|
66
66
|
- `@open-e2ee/signal-protocol-sdk/remote/relay/convex/relay`
|
|
67
|
-
- `@open-e2ee/signal-protocol-sdk/
|
|
67
|
+
- `@open-e2ee/signal-protocol-sdk/convex.config`
|
|
68
|
+
- `@open-e2ee/signal-protocol-sdk/remote/relay/memory`
|
|
68
69
|
- `@open-e2ee/signal-protocol-sdk/remote/relay/types`
|
|
69
70
|
- `@open-e2ee/signal-protocol-sdk/remote/object-store`
|
|
70
71
|
- `@open-e2ee/signal-protocol-sdk/remote/object-store/convex-r2`
|
|
@@ -102,7 +103,7 @@ Expo storage or Convex helpers.
|
|
|
102
103
|
- `@open-e2ee/signal-protocol-sdk/local/store/expo`
|
|
103
104
|
- `@open-e2ee/signal-protocol-sdk/local/store/expo/db`
|
|
104
105
|
- `@open-e2ee/signal-protocol-sdk/local/store/expo/schema`
|
|
105
|
-
- `@open-e2ee/signal-protocol-sdk/local/store/
|
|
106
|
+
- `@open-e2ee/signal-protocol-sdk/local/store/memory`
|
|
106
107
|
- `@open-e2ee/signal-protocol-sdk/local/store/node`
|
|
107
108
|
- `@open-e2ee/signal-protocol-sdk/local/store/react-native`
|
|
108
109
|
- `@open-e2ee/signal-protocol-sdk/local/store/web`
|
|
@@ -120,8 +121,8 @@ Expo storage or Convex helpers.
|
|
|
120
121
|
|
|
121
122
|
### Development adapters
|
|
122
123
|
|
|
123
|
-
- `@open-e2ee/signal-protocol-sdk/remote/relay/
|
|
124
|
-
- `@open-e2ee/signal-protocol-sdk/local/store/
|
|
124
|
+
- `@open-e2ee/signal-protocol-sdk/remote/relay/memory`
|
|
125
|
+
- `@open-e2ee/signal-protocol-sdk/local/store/memory`
|
|
125
126
|
|
|
126
127
|
`internal/**` is implementation-only and not part of the supported external API.
|
|
127
128
|
|
|
@@ -142,24 +143,29 @@ Expo storage or Convex helpers.
|
|
|
142
143
|
|
|
143
144
|
### Relay implementations
|
|
144
145
|
|
|
145
|
-
- `
|
|
146
|
+
- `ConvexSignalProtocolRelayServer` for Convex-backed apps
|
|
146
147
|
- `convexRelay()` for Convex-backed composition
|
|
147
|
-
-
|
|
148
|
-
-
|
|
148
|
+
- the installable component from
|
|
149
|
+
`@open-e2ee/signal-protocol-sdk/convex.config`, with public handlers from
|
|
150
|
+
`defineConvexSignalProtocolBackend()` and the `oe-groups` CLI
|
|
151
|
+
(`npx oe-groups trust-root`) for secret initialization and trust-root
|
|
152
|
+
export
|
|
153
|
+
- `InMemorySignalProtocolRelayServer` / `inMemoryRelay()` for local development
|
|
154
|
+
- custom implementations via `ISignalProtocolRelayServer`
|
|
149
155
|
|
|
150
156
|
### Storage implementations
|
|
151
157
|
|
|
152
|
-
- `
|
|
158
|
+
- `ExpoSignalProtocolStore` for Expo / React Native
|
|
153
159
|
- `expoStore()` for Expo / React Native composition
|
|
154
160
|
- `@open-e2ee/signal-protocol-sdk/local/store/expo` also exports the Expo helpers
|
|
155
161
|
Signal Protocol composes directly: `getKeyStorage`, `getDatabaseKeyManager`,
|
|
156
162
|
`clearDatabaseKeyCache`, and `createPreKeyMaintenanceStore`
|
|
157
|
-
- `
|
|
158
|
-
- `
|
|
163
|
+
- `IndexedDbSignalProtocolStore` / `indexedDbStore()` for browsers (experimental)
|
|
164
|
+
- `ReactNativeSignalProtocolStore` / `reactNativeStore()` for bare React Native
|
|
159
165
|
(experimental; provide your own key-value backend)
|
|
160
|
-
- `
|
|
161
|
-
- `
|
|
162
|
-
- custom implementations via `
|
|
166
|
+
- `NodeSignalProtocolStore` / `nodeStore()` for Node environments
|
|
167
|
+
- `InMemorySignalProtocolStore` / `inMemoryStore()` for local development
|
|
168
|
+
- custom implementations via `ISignalProtocolLocalStore`
|
|
163
169
|
|
|
164
170
|
### Remote object storage
|
|
165
171
|
|
|
@@ -171,7 +177,7 @@ Expo storage or Convex helpers.
|
|
|
171
177
|
point
|
|
172
178
|
- `S3ObjectStore` via `@open-e2ee/signal-protocol-sdk/remote/object-store/s3`
|
|
173
179
|
- `s3ObjectStore()` for brokered Amazon S3 or S3-compatible storage
|
|
174
|
-
- custom implementations via `
|
|
180
|
+
- custom implementations via `SignalProtocolRemoteObjectStore`
|
|
175
181
|
|
|
176
182
|
`ConvexR2ObjectStore` is a client adapter for authenticated app-owned Convex
|
|
177
183
|
functions that wrap `@convex-dev/r2`; it is not the Convex component itself.
|
|
@@ -183,8 +189,8 @@ Both concrete adapters keep provider credentials in the application backend.
|
|
|
183
189
|
Remote object storage is a normal first-class integration point for encrypted
|
|
184
190
|
attachments and files, not a niche or internal-only adapter. Use
|
|
185
191
|
`attachment.transfer` when your app has a foreground, background, resumable, or
|
|
186
|
-
platform-native byte transfer implementation. The Signal package still
|
|
187
|
-
encryption, digest verification, retry decisions, and pointer metadata.
|
|
192
|
+
platform-native byte transfer implementation. The Signal Protocol package still
|
|
193
|
+
owns encryption, digest verification, retry decisions, and pointer metadata.
|
|
188
194
|
|
|
189
195
|
Object stores can return signed upload headers, and stores that return
|
|
190
196
|
`protocol: 'tus'` automatically use the built-in resumable TUS transfer helper.
|
package/docs/PROTOCOL_POLICY.md
CHANGED
|
@@ -1,6 +1,12 @@
|
|
|
1
1
|
# Protocol Policy Guide
|
|
2
2
|
|
|
3
|
-
> Navigation: [README](../README.md) | [ARCHITECTURE](../ARCHITECTURE.md) | [Security](./SECURITY.md) | [Getting Started](./GETTING_STARTED.md) | **Protocol Policy**
|
|
3
|
+
> Navigation: [README](../README.md) | [ARCHITECTURE](../ARCHITECTURE.md) | [Security](./SECURITY.md) | [Getting Started](./GETTING_STARTED.md) | **Protocol Policy** | [Deviations](./DEVIATIONS.md)
|
|
4
|
+
|
|
5
|
+
This document covers **which protocol modes run** and which fail closed. For
|
|
6
|
+
**how the profile differs from the published specifications and from
|
|
7
|
+
`libsignal`** — the composite identity, the Ed25519-instead-of-XEdDSA signature
|
|
8
|
+
scheme, the ML-KEM Braid `hek` operand order, and the rest — see
|
|
9
|
+
[Deviations](./DEVIATIONS.md).
|
|
4
10
|
|
|
5
11
|
The public Signal Protocol client policy is:
|
|
6
12
|
|
|
@@ -65,7 +71,10 @@ await createSignalProtocolClient({
|
|
|
65
71
|
|
|
66
72
|
`braid: 'required'` uses the specification-defined ML-KEM Braid SPQR profile
|
|
67
73
|
and is the default. HEK is `SHA3-256(ek_seed || ek_vector)`; that operand order
|
|
68
|
-
is part of the public compatibility boundary.
|
|
74
|
+
is part of the public compatibility boundary. It follows the ML-KEM Braid
|
|
75
|
+
specification text and is the reverse of `libsignal`'s implementation, which means
|
|
76
|
+
braid sessions do not interoperate with `libsignal`'s and the KEM in this mode is not
|
|
77
|
+
stock FIPS 203 — see [Deviations §4.1](./DEVIATIONS.md#41-the-hek-operand-order-diverges).
|
|
69
78
|
|
|
70
79
|
```ts
|
|
71
80
|
await createSignalProtocolClient({
|
package/docs/RECIPES.md
CHANGED
|
@@ -13,12 +13,14 @@ uses public exports only.
|
|
|
13
13
|
This local demo sends while Bob is offline so you can see the relay's encrypted
|
|
14
14
|
envelope and Bob's decrypted plaintext in the same workflow.
|
|
15
15
|
|
|
16
|
+
<!-- doc-snippet:run recipes-two-local-clients expect="bob decrypted: alice: hello" -->
|
|
16
17
|
```ts
|
|
18
|
+
// Real protocol and cryptography; simulated in-memory infrastructure.
|
|
17
19
|
import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
18
|
-
import {
|
|
19
|
-
import {
|
|
20
|
+
import { inMemoryStore } from "@open-e2ee/signal-protocol-sdk/local/store/memory";
|
|
21
|
+
import { inMemoryRelay } from "@open-e2ee/signal-protocol-sdk/remote/relay/memory";
|
|
20
22
|
|
|
21
|
-
const relay =
|
|
23
|
+
const relay = inMemoryRelay();
|
|
22
24
|
|
|
23
25
|
// The relay knows which devices exist, but it does not get plaintext.
|
|
24
26
|
await relay.registerDevice("alice", {
|
|
@@ -29,12 +31,12 @@ await relay.registerDevice("bob", { encryptedDeviceName: new ArrayBuffer(0) });
|
|
|
29
31
|
// Each client represents one device. Its storage is local to that device.
|
|
30
32
|
const alice = await createSignalProtocolClient({
|
|
31
33
|
identity: { userId: "alice" },
|
|
32
|
-
adapters: { storage:
|
|
34
|
+
adapters: { storage: inMemoryStore(), relay },
|
|
33
35
|
});
|
|
34
36
|
|
|
35
37
|
const bob = await createSignalProtocolClient({
|
|
36
38
|
identity: { userId: "bob" },
|
|
37
|
-
adapters: { storage:
|
|
39
|
+
adapters: { storage: inMemoryStore(), relay },
|
|
38
40
|
});
|
|
39
41
|
|
|
40
42
|
await alice.syncToServer();
|
|
@@ -97,12 +99,12 @@ Bob through the `onMessageDecrypted` hook.
|
|
|
97
99
|
import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
98
100
|
import {
|
|
99
101
|
convexRelay,
|
|
100
|
-
type
|
|
102
|
+
type ConvexSignalProtocolRelayApi,
|
|
101
103
|
} from "@open-e2ee/signal-protocol-sdk/remote/relay/convex";
|
|
102
104
|
import { expoStore } from "@open-e2ee/signal-protocol-sdk/local/store/expo";
|
|
103
105
|
import { api } from "../convex/_generated/api";
|
|
104
106
|
|
|
105
|
-
const signalApi = api.signal satisfies
|
|
107
|
+
const signalApi = api.signal satisfies ConvexSignalProtocolRelayApi;
|
|
106
108
|
|
|
107
109
|
// The relay handles server-side public keys, devices, and encrypted envelopes.
|
|
108
110
|
const relay = convexRelay({
|
|
@@ -116,7 +118,7 @@ const signal = await createSignalProtocolClient({
|
|
|
116
118
|
identity: { userId },
|
|
117
119
|
adapters: {
|
|
118
120
|
// Storage owns this device's private keys and session state.
|
|
119
|
-
storage: expoStore(
|
|
121
|
+
storage: expoStore(),
|
|
120
122
|
relay,
|
|
121
123
|
},
|
|
122
124
|
});
|
|
@@ -133,23 +135,25 @@ before creating the client.
|
|
|
133
135
|
|
|
134
136
|
## Local development
|
|
135
137
|
|
|
138
|
+
<!-- doc-snippet:run recipes-local-development expect="" -->
|
|
136
139
|
```ts
|
|
140
|
+
// Real protocol and cryptography; simulated in-memory infrastructure.
|
|
137
141
|
import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
138
|
-
import {
|
|
139
|
-
import {
|
|
142
|
+
import { inMemoryRelay } from "@open-e2ee/signal-protocol-sdk/remote/relay/memory";
|
|
143
|
+
import { inMemoryStore } from "@open-e2ee/signal-protocol-sdk/local/store/memory";
|
|
140
144
|
|
|
141
|
-
const relay =
|
|
145
|
+
const relay = inMemoryRelay();
|
|
142
146
|
|
|
143
147
|
const alice = await createSignalProtocolClient({
|
|
144
148
|
// `identity` is the app account/device being represented.
|
|
145
149
|
identity: { userId: "alice" },
|
|
146
150
|
// `adapters` are the concrete storage/relay implementation for this run.
|
|
147
|
-
adapters: { storage:
|
|
151
|
+
adapters: { storage: inMemoryStore(), relay },
|
|
148
152
|
});
|
|
149
153
|
|
|
150
154
|
const bob = await createSignalProtocolClient({
|
|
151
155
|
identity: { userId: "bob" },
|
|
152
|
-
adapters: { storage:
|
|
156
|
+
adapters: { storage: inMemoryStore(), relay },
|
|
153
157
|
});
|
|
154
158
|
```
|
|
155
159
|
|
package/docs/SECURITY.md
CHANGED
|
@@ -140,6 +140,14 @@ compromised application code, a stolen unlocked device, or an attacker who also
|
|
|
140
140
|
obtains the adapter encryption key. Browser IndexedDB and caller-provided React
|
|
141
141
|
Native storage inherit their host application's security boundary.
|
|
142
142
|
|
|
143
|
+
Group sender key state never leaves the device. A sender key record holds the
|
|
144
|
+
chain key every message key on that chain derives from and the sender's private
|
|
145
|
+
signature key; together they are enough to read a sender's group messages and to
|
|
146
|
+
forge new ones, so no adapter transmits them and no relay contract accepts them.
|
|
147
|
+
The same rule covers the message keys held for out-of-order group messages.
|
|
148
|
+
Local adapters bound that skipped-key store so a peer cannot grow it without
|
|
149
|
+
limit by skipping ever further ahead.
|
|
150
|
+
|
|
143
151
|
Relay and remote object-store adapters receive public key material, routing
|
|
144
152
|
metadata, and opaque ciphertext required by their contracts. TLS,
|
|
145
153
|
authorization, abuse controls, atomic prekey consumption, and access logging
|
package/files/README.md
CHANGED
|
@@ -29,7 +29,7 @@ const plaintext = await streamingDecrypt(
|
|
|
29
29
|
For a complete attachment workflow with upload brokering, retries, pointer
|
|
30
30
|
validation, and cleanup, use the
|
|
31
31
|
[`media`](../media/README.md) module with a
|
|
32
|
-
[`
|
|
32
|
+
[`SignalProtocolRemoteObjectStore`](../remote/object-store/README.md).
|
|
33
33
|
|
|
34
34
|
Applications remain responsible for file-system permissions, cache lifetime,
|
|
35
35
|
content rendering, and securely disposing of decrypted temporary files.
|
package/groups/README.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# Groups
|
|
2
2
|
|
|
3
|
-
The groups module provides group identifiers, encrypted
|
|
3
|
+
The groups module provides group identifiers, encrypted group state,
|
|
4
4
|
membership transitions, access-control checks, invite links, and the
|
|
5
|
-
`
|
|
5
|
+
`GroupManager` orchestration API.
|
|
6
6
|
|
|
7
7
|
## Why it exists
|
|
8
8
|
|
|
@@ -15,18 +15,23 @@ and sender-key rotation.
|
|
|
15
15
|
|
|
16
16
|
```ts
|
|
17
17
|
import {
|
|
18
|
-
|
|
18
|
+
GroupManager,
|
|
19
19
|
createGroupId,
|
|
20
20
|
type IGroupServer,
|
|
21
21
|
type IGroupStateStore,
|
|
22
22
|
} from "@open-e2ee/signal-protocol-sdk/groups";
|
|
23
23
|
|
|
24
|
-
const groups = new
|
|
24
|
+
const groups = new GroupManager({
|
|
25
25
|
store: appGroupStore as IGroupStateStore,
|
|
26
26
|
server: appGroupServer as IGroupServer,
|
|
27
27
|
issueCredential: () => appGroupCredentials.issue(),
|
|
28
28
|
credentialPublicKey,
|
|
29
|
+
serverSigningPublicKey,
|
|
29
30
|
aci: localAccountServiceId,
|
|
31
|
+
pni: localPhoneNumberServiceId,
|
|
32
|
+
issueProfileKeyCredential: () => appGroupCredentials.issueProfileKey(),
|
|
33
|
+
profileKeyCredentialPublicKey,
|
|
34
|
+
profileKey: localProfileKey,
|
|
30
35
|
});
|
|
31
36
|
|
|
32
37
|
const groupId = createGroupId(rawGroupId);
|
|
@@ -36,7 +41,13 @@ const state = await groups.syncGroup(groupId);
|
|
|
36
41
|
The server must enforce authenticated access and version sequencing without
|
|
37
42
|
receiving plaintext group attributes or group master keys. Membership removal
|
|
38
43
|
must also invalidate or rotate group messaging state through the callbacks
|
|
39
|
-
required by `
|
|
44
|
+
required by `GroupManagerOptions`. Every `getGroup()` response must include a
|
|
45
|
+
baseline signature over the group ID, version, and exact encrypted-state bytes;
|
|
46
|
+
the client verifies it before installing a first or post-revocation baseline.
|
|
47
|
+
|
|
48
|
+
Deployments whose server does not yet sign group changes must opt in explicitly
|
|
49
|
+
with `allowUnauthenticatedGroupHistory: true`; the SDK emits a security warning
|
|
50
|
+
because that mode has no authenticated group history.
|
|
40
51
|
|
|
41
52
|
See the [API reference](../docs/api/README.md) and
|
|
42
53
|
[security model](../docs/SECURITY.md).
|