@open-e2ee/signal-protocol-sdk 7.2.0 → 8.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/ADAPTERS.md +54 -7
- package/ARCHITECTURE.md +1 -0
- package/CHANGELOG.md +503 -0
- package/README.md +9 -5
- package/SECURITY.md +2 -2
- package/THIRD_PARTY_NOTICES.md +429 -0
- package/client/README.md +1 -2
- package/device/README.md +50 -19
- package/dist/client/client.d.ts +31 -5
- package/dist/client/client.d.ts.map +1 -1
- package/dist/client/client.js +149 -90
- package/dist/client/client.js.map +1 -1
- package/dist/client/event-hooks.d.ts.map +1 -1
- package/dist/client/event-hooks.js +2 -0
- package/dist/client/event-hooks.js.map +1 -1
- package/dist/client/files.d.ts.map +1 -1
- package/dist/client/files.js +19 -2
- package/dist/client/files.js.map +1 -1
- package/dist/client/headless.d.ts +1 -1
- package/dist/client/headless.js +1 -1
- package/dist/client/hosted-anonymous-delivery.d.ts.map +1 -1
- package/dist/client/hosted-anonymous-delivery.js +2 -1
- package/dist/client/hosted-anonymous-delivery.js.map +1 -1
- package/dist/client/hosted-connection.d.ts +1 -1
- package/dist/client/hosted-connection.d.ts.map +1 -1
- package/dist/client/hosted-connection.js +8 -12
- package/dist/client/hosted-connection.js.map +1 -1
- package/dist/client/hosted-group-authority.d.ts.map +1 -1
- package/dist/client/hosted-group-authority.js +2 -1
- package/dist/client/hosted-group-authority.js.map +1 -1
- package/dist/client/hosted-groups.d.ts.map +1 -1
- package/dist/client/hosted-groups.js +2 -1
- package/dist/client/hosted-groups.js.map +1 -1
- package/dist/client/hosted-push.d.ts.map +1 -1
- package/dist/client/hosted-push.js +2 -1
- package/dist/client/hosted-push.js.map +1 -1
- package/dist/client/hosted-transport.d.ts.map +1 -1
- package/dist/client/hosted-transport.js +10 -11
- package/dist/client/hosted-transport.js.map +1 -1
- package/dist/client/hosted-trust.d.ts +11 -11
- package/dist/client/hosted-trust.d.ts.map +1 -1
- package/dist/client/hosted-trust.js +12 -12
- package/dist/client/hosted-trust.js.map +1 -1
- package/dist/client/messages.d.ts.map +1 -1
- package/dist/client/messages.js +6 -1
- package/dist/client/messages.js.map +1 -1
- package/dist/client/multi-device.d.ts.map +1 -1
- package/dist/client/multi-device.js +2 -1
- package/dist/client/multi-device.js.map +1 -1
- package/dist/client/relay-work.d.ts +30 -0
- package/dist/client/relay-work.d.ts.map +1 -0
- package/dist/client/relay-work.js +189 -0
- package/dist/client/relay-work.js.map +1 -0
- package/dist/client/retry.d.ts.map +1 -1
- package/dist/client/retry.js +2 -0
- package/dist/client/retry.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 +19 -11
- package/dist/client/signal-service-cipher.d.ts.map +1 -1
- package/dist/client/signal-service-cipher.js +48 -46
- package/dist/client/signal-service-cipher.js.map +1 -1
- package/dist/client/state.d.ts +8 -0
- package/dist/client/state.d.ts.map +1 -1
- package/dist/client/state.js +11 -0
- package/dist/client/state.js.map +1 -1
- package/dist/device/connection.d.ts +1 -1
- package/dist/device/connection.d.ts.map +1 -1
- package/dist/device/connection.js +4 -11
- package/dist/device/connection.js.map +1 -1
- package/dist/device/device-id.d.ts +10 -4
- package/dist/device/device-id.d.ts.map +1 -1
- package/dist/device/device-id.js +15 -9
- package/dist/device/device-id.js.map +1 -1
- package/dist/device/device-name-crypto.d.ts.map +1 -1
- package/dist/device/device-name-crypto.js +2 -2
- package/dist/device/device-name-crypto.js.map +1 -1
- package/dist/device/expo/index.d.ts +25 -8
- package/dist/device/expo/index.d.ts.map +1 -1
- package/dist/device/expo/index.js +58 -8
- package/dist/device/expo/index.js.map +1 -1
- package/dist/device/index.d.ts +2 -2
- package/dist/device/index.d.ts.map +1 -1
- package/dist/device/index.js +3 -2
- package/dist/device/index.js.map +1 -1
- package/dist/device/lifecycle/index.d.ts +4 -2
- package/dist/device/lifecycle/index.d.ts.map +1 -1
- package/dist/device/lifecycle/index.js.map +1 -1
- package/dist/device/lifecycle/manager.d.ts +12 -14
- package/dist/device/lifecycle/manager.d.ts.map +1 -1
- package/dist/device/lifecycle/manager.js +52 -97
- package/dist/device/lifecycle/manager.js.map +1 -1
- package/dist/device/lifecycle/types.d.ts +26 -16
- package/dist/device/lifecycle/types.d.ts.map +1 -1
- package/dist/device/lifecycle/utils.d.ts +8 -4
- package/dist/device/lifecycle/utils.d.ts.map +1 -1
- package/dist/device/lifecycle/utils.js +12 -16
- package/dist/device/lifecycle/utils.js.map +1 -1
- package/dist/device/provisioning.d.ts.map +1 -1
- package/dist/device/provisioning.js +6 -8
- package/dist/device/provisioning.js.map +1 -1
- package/dist/device/react-native/index.d.ts +40 -0
- package/dist/device/react-native/index.d.ts.map +1 -0
- package/dist/device/react-native/index.js +74 -0
- package/dist/device/react-native/index.js.map +1 -0
- package/dist/device/transfer.d.ts +15 -7
- package/dist/device/transfer.d.ts.map +1 -1
- package/dist/device/transfer.js +30 -22
- package/dist/device/transfer.js.map +1 -1
- package/dist/device/types.d.ts +15 -7
- package/dist/device/types.d.ts.map +1 -1
- package/dist/device/types.js.map +1 -1
- package/dist/device/vault-text.d.ts +13 -0
- package/dist/device/vault-text.d.ts.map +1 -0
- package/dist/device/vault-text.js +17 -0
- package/dist/device/vault-text.js.map +1 -0
- package/dist/index.d.ts +9 -5
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +9 -5
- package/dist/index.js.map +1 -1
- package/dist/internal/crypto/index.d.ts +3 -3
- package/dist/internal/crypto/index.d.ts.map +1 -1
- package/dist/internal/crypto/index.js +3 -3
- package/dist/internal/crypto/index.js.map +1 -1
- package/dist/internal/crypto/random-host.d.ts +1 -1
- package/dist/internal/crypto/random-host.d.ts.map +1 -1
- package/dist/internal/crypto/random-host.js +3 -2
- package/dist/internal/crypto/random-host.js.map +1 -1
- package/dist/internal/crypto/random-host.native.d.ts +6 -1
- package/dist/internal/crypto/random-host.native.d.ts.map +1 -1
- package/dist/internal/crypto/random-host.native.js +14 -10
- package/dist/internal/crypto/random-host.native.js.map +1 -1
- package/dist/internal/crypto/random-host.node.d.ts +1 -1
- package/dist/internal/crypto/random-host.node.d.ts.map +1 -1
- package/dist/internal/crypto/random-host.node.js +1 -1
- package/dist/internal/crypto/random-host.node.js.map +1 -1
- package/dist/internal/crypto/random.d.ts +12 -3
- package/dist/internal/crypto/random.d.ts.map +1 -1
- package/dist/internal/crypto/random.js +14 -3
- package/dist/internal/crypto/random.js.map +1 -1
- package/dist/internal/crypto/utils.d.ts.map +1 -1
- package/dist/internal/crypto/utils.js +10 -6
- package/dist/internal/crypto/utils.js.map +1 -1
- package/dist/internal/encoding/proto/primitives.d.ts +2 -0
- package/dist/internal/encoding/proto/primitives.d.ts.map +1 -1
- package/dist/internal/encoding/proto/primitives.js +2 -1
- package/dist/internal/encoding/proto/primitives.js.map +1 -1
- package/dist/internal/encoding/proto/signal-message.d.ts +1 -0
- package/dist/internal/encoding/proto/signal-message.d.ts.map +1 -1
- package/dist/internal/encoding/proto/signal-message.js +2 -1
- package/dist/internal/encoding/proto/signal-message.js.map +1 -1
- package/dist/internal/groups/authority-certificate.d.ts.map +1 -1
- package/dist/internal/groups/authority-certificate.js +2 -1
- package/dist/internal/groups/authority-certificate.js.map +1 -1
- package/dist/internal/groups/encrypted-state.d.ts.map +1 -1
- package/dist/internal/groups/encrypted-state.js +9 -7
- package/dist/internal/groups/encrypted-state.js.map +1 -1
- package/dist/internal/groups/invite-link.d.ts.map +1 -1
- package/dist/internal/groups/invite-link.js +2 -1
- package/dist/internal/groups/invite-link.js.map +1 -1
- package/dist/internal/groups/manager.d.ts.map +1 -1
- package/dist/internal/groups/manager.js +5 -5
- package/dist/internal/groups/manager.js.map +1 -1
- package/dist/internal/groups/sdk-store.d.ts.map +1 -1
- package/dist/internal/groups/sdk-store.js +4 -3
- package/dist/internal/groups/sdk-store.js.map +1 -1
- package/dist/internal/groups/server-engine.d.ts +6 -1
- package/dist/internal/groups/server-engine.d.ts.map +1 -1
- package/dist/internal/groups/server-engine.js +11 -15
- package/dist/internal/groups/server-engine.js.map +1 -1
- package/dist/internal/groups/wire.d.ts.map +1 -1
- package/dist/internal/groups/wire.js +2 -1
- package/dist/internal/groups/wire.js.map +1 -1
- package/dist/internal/platform/blob.d.ts +10 -0
- package/dist/internal/platform/blob.d.ts.map +1 -0
- package/dist/internal/platform/blob.js +30 -0
- package/dist/internal/platform/blob.js.map +1 -0
- package/dist/internal/platform/env.d.ts +13 -0
- package/dist/internal/platform/env.d.ts.map +1 -0
- package/dist/internal/platform/env.js +17 -0
- package/dist/internal/platform/env.js.map +1 -0
- package/dist/internal/platform/index.d.ts +5 -0
- package/dist/internal/platform/index.d.ts.map +1 -0
- package/dist/internal/platform/index.js +5 -0
- package/dist/internal/platform/index.js.map +1 -0
- package/dist/internal/platform/url.d.ts +72 -0
- package/dist/internal/platform/url.d.ts.map +1 -0
- package/dist/internal/platform/url.js +275 -0
- package/dist/internal/platform/url.js.map +1 -0
- package/dist/internal/platform/utf8.d.ts +28 -0
- package/dist/internal/platform/utf8.d.ts.map +1 -0
- package/dist/internal/platform/utf8.js +167 -0
- package/dist/internal/platform/utf8.js.map +1 -0
- package/dist/internal/protocol/sealed-sender/delivery-token.d.ts +1 -1
- package/dist/internal/protocol/sealed-sender/delivery-token.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/delivery-token.js +5 -10
- package/dist/internal/protocol/sealed-sender/delivery-token.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/proto/index.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/proto/index.js +2 -4
- package/dist/internal/protocol/sealed-sender/proto/index.js.map +1 -1
- package/dist/internal/protocol/sender-keys/manager.d.ts.map +1 -1
- package/dist/internal/protocol/sender-keys/manager.js +4 -3
- package/dist/internal/protocol/sender-keys/manager.js.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/noble-pq/index.d.ts +4 -4
- package/dist/internal/protocol/spqr/ml-kem-braid/noble-pq/index.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/noble-pq/index.js +8 -10
- package/dist/internal/protocol/spqr/ml-kem-braid/noble-pq/index.js.map +1 -1
- package/dist/internal/protocol/username/hash.d.ts.map +1 -1
- package/dist/internal/protocol/username/hash.js +18 -3
- package/dist/internal/protocol/username/hash.js.map +1 -1
- package/dist/internal/protocol/username/link.d.ts.map +1 -1
- package/dist/internal/protocol/username/link.js +2 -1
- package/dist/internal/protocol/username/link.js.map +1 -1
- package/dist/internal/protocol/username/proof.d.ts.map +1 -1
- package/dist/internal/protocol/username/proof.js +2 -1
- package/dist/internal/protocol/username/proof.js.map +1 -1
- package/dist/internal/sesame/device-registry.d.ts +16 -3
- package/dist/internal/sesame/device-registry.d.ts.map +1 -1
- package/dist/internal/sesame/device-registry.js +10 -7
- package/dist/internal/sesame/device-registry.js.map +1 -1
- package/dist/internal/sesame/index.d.ts +1 -1
- package/dist/internal/sesame/index.d.ts.map +1 -1
- package/dist/internal/sesame/manager.d.ts.map +1 -1
- package/dist/internal/sesame/manager.js +3 -2
- package/dist/internal/sesame/manager.js.map +1 -1
- package/dist/internal/session/index.d.ts +1 -2
- package/dist/internal/session/index.d.ts.map +1 -1
- package/dist/internal/session/index.js +1 -1
- package/dist/internal/session/index.js.map +1 -1
- package/dist/internal/session/validation.d.ts +0 -80
- package/dist/internal/session/validation.d.ts.map +1 -1
- package/dist/internal/session/validation.js +0 -134
- package/dist/internal/session/validation.js.map +1 -1
- package/dist/local/store/device-record.d.ts +18 -0
- package/dist/local/store/device-record.d.ts.map +1 -0
- package/dist/local/store/device-record.js +34 -0
- package/dist/local/store/device-record.js.map +1 -0
- package/dist/local/store/expo/adapter.d.ts +59 -238
- package/dist/local/store/expo/adapter.d.ts.map +1 -1
- package/dist/local/store/expo/adapter.js +83 -640
- package/dist/local/store/expo/adapter.js.map +1 -1
- package/dist/local/store/expo/driver.d.ts +16 -0
- package/dist/local/store/expo/driver.d.ts.map +1 -0
- package/dist/local/store/expo/driver.js +141 -0
- package/dist/local/store/expo/driver.js.map +1 -0
- package/dist/local/store/expo/index.d.ts +3 -12
- package/dist/local/store/expo/index.d.ts.map +1 -1
- package/dist/local/store/expo/index.js +1 -8
- package/dist/local/store/expo/index.js.map +1 -1
- package/dist/local/store/expo/maintenance.d.ts +3 -2
- package/dist/local/store/expo/maintenance.d.ts.map +1 -1
- package/dist/local/store/expo/maintenance.js +5 -34
- package/dist/local/store/expo/maintenance.js.map +1 -1
- package/dist/local/store/index.d.ts +10 -5
- package/dist/local/store/index.d.ts.map +1 -1
- package/dist/local/store/index.js +10 -5
- package/dist/local/store/index.js.map +1 -1
- package/dist/local/store/key-value/adapter.d.ts +326 -0
- package/dist/local/store/key-value/adapter.d.ts.map +1 -0
- package/dist/local/store/key-value/adapter.js +1472 -0
- package/dist/local/store/key-value/adapter.js.map +1 -0
- package/dist/local/store/{react-native → key-value}/backend-conformance.d.ts +6 -6
- package/dist/local/store/key-value/backend-conformance.d.ts.map +1 -0
- package/dist/local/store/{react-native → key-value}/backend-conformance.js +3 -3
- package/dist/local/store/key-value/backend-conformance.js.map +1 -0
- package/dist/local/store/key-value/batch.d.ts +41 -0
- package/dist/local/store/key-value/batch.d.ts.map +1 -0
- package/dist/local/store/key-value/batch.js +77 -0
- package/dist/local/store/key-value/batch.js.map +1 -0
- package/dist/local/store/key-value/device-record.d.ts +23 -0
- package/dist/local/store/key-value/device-record.d.ts.map +1 -0
- package/dist/local/store/key-value/device-record.js +33 -0
- package/dist/local/store/key-value/device-record.js.map +1 -0
- package/dist/local/store/key-value/index.d.ts +24 -0
- package/dist/local/store/key-value/index.d.ts.map +1 -0
- package/dist/local/store/key-value/index.js +8 -0
- package/dist/local/store/key-value/index.js.map +1 -0
- package/dist/local/store/key-value/realm/index.d.ts +83 -0
- package/dist/local/store/key-value/realm/index.d.ts.map +1 -0
- package/dist/local/store/key-value/realm/index.js +102 -0
- package/dist/local/store/key-value/realm/index.js.map +1 -0
- package/dist/local/store/{react-native → key-value}/storage.d.ts +6 -6
- package/dist/local/store/key-value/storage.d.ts.map +1 -0
- package/dist/local/store/key-value/storage.js.map +1 -0
- package/dist/local/store/key-value/transactional-backend.d.ts +50 -0
- package/dist/local/store/key-value/transactional-backend.d.ts.map +1 -0
- package/dist/local/store/key-value/transactional-backend.js +90 -0
- package/dist/local/store/key-value/transactional-backend.js.map +1 -0
- package/dist/local/store/key-value/value-key.d.ts +34 -0
- package/dist/local/store/key-value/value-key.d.ts.map +1 -0
- package/dist/local/store/key-value/value-key.js +83 -0
- package/dist/local/store/key-value/value-key.js.map +1 -0
- package/dist/local/store/memory/adapter.d.ts +8 -0
- package/dist/local/store/memory/adapter.d.ts.map +1 -1
- package/dist/local/store/memory/adapter.js +60 -75
- package/dist/local/store/memory/adapter.js.map +1 -1
- package/dist/local/store/node/adapter.d.ts +74 -130
- package/dist/local/store/node/adapter.d.ts.map +1 -1
- package/dist/local/store/node/adapter.js +83 -727
- package/dist/local/store/node/adapter.js.map +1 -1
- package/dist/local/store/node/index.d.ts +8 -6
- package/dist/local/store/node/index.d.ts.map +1 -1
- package/dist/local/store/node/index.js +3 -7
- package/dist/local/store/node/index.js.map +1 -1
- package/dist/local/store/node/maintenance.d.ts +5 -0
- package/dist/local/store/node/maintenance.d.ts.map +1 -0
- package/dist/local/store/node/maintenance.js +7 -0
- package/dist/local/store/node/maintenance.js.map +1 -0
- package/dist/local/store/node/owner-lock.d.ts +26 -0
- package/dist/local/store/node/owner-lock.d.ts.map +1 -0
- package/dist/local/store/node/owner-lock.js +88 -0
- package/dist/local/store/node/owner-lock.js.map +1 -0
- package/dist/local/store/react-native/adapter.d.ts +63 -274
- package/dist/local/store/react-native/adapter.d.ts.map +1 -1
- package/dist/local/store/react-native/adapter.js +80 -1406
- package/dist/local/store/react-native/adapter.js.map +1 -1
- package/dist/local/store/react-native/index.d.ts +7 -19
- package/dist/local/store/react-native/index.d.ts.map +1 -1
- package/dist/local/store/react-native/index.js +2 -7
- package/dist/local/store/react-native/index.js.map +1 -1
- package/dist/local/store/react-native/maintenance.d.ts +5 -0
- package/dist/local/store/react-native/maintenance.d.ts.map +1 -0
- package/dist/local/store/react-native/maintenance.js +7 -0
- package/dist/local/store/react-native/maintenance.js.map +1 -0
- package/dist/local/store/sqlite/better-sqlite3-multiple-ciphers-driver.d.ts +38 -0
- package/dist/local/store/sqlite/better-sqlite3-multiple-ciphers-driver.d.ts.map +1 -0
- package/dist/local/store/sqlite/better-sqlite3-multiple-ciphers-driver.js +196 -0
- package/dist/local/store/sqlite/better-sqlite3-multiple-ciphers-driver.js.map +1 -0
- package/dist/local/store/sqlite/database.d.ts +20 -0
- package/dist/local/store/sqlite/database.d.ts.map +1 -0
- package/dist/local/store/sqlite/database.js +41 -0
- package/dist/local/store/sqlite/database.js.map +1 -0
- package/dist/local/store/sqlite/driver.d.ts +138 -0
- package/dist/local/store/sqlite/driver.d.ts.map +1 -0
- package/dist/local/store/sqlite/driver.js +10 -0
- package/dist/local/store/sqlite/driver.js.map +1 -0
- package/dist/local/store/sqlite/encryption.d.ts +61 -0
- package/dist/local/store/sqlite/encryption.d.ts.map +1 -0
- package/dist/local/store/sqlite/encryption.js +98 -0
- package/dist/local/store/sqlite/encryption.js.map +1 -0
- package/dist/local/store/sqlite/errors.d.ts +70 -0
- package/dist/local/store/sqlite/errors.d.ts.map +1 -0
- package/dist/local/store/sqlite/errors.js +101 -0
- package/dist/local/store/sqlite/errors.js.map +1 -0
- package/dist/local/store/sqlite/executor.d.ts +22 -0
- package/dist/local/store/sqlite/executor.d.ts.map +1 -0
- package/dist/local/store/sqlite/executor.js +129 -0
- package/dist/local/store/sqlite/executor.js.map +1 -0
- package/dist/local/store/sqlite/index.d.ts +20 -0
- package/dist/local/store/sqlite/index.d.ts.map +1 -0
- package/dist/local/store/sqlite/index.js +18 -0
- package/dist/local/store/sqlite/index.js.map +1 -0
- package/dist/local/store/sqlite/key-storage/account.d.ts +45 -0
- package/dist/local/store/sqlite/key-storage/account.d.ts.map +1 -0
- package/dist/local/store/sqlite/key-storage/account.js +125 -0
- package/dist/local/store/sqlite/key-storage/account.js.map +1 -0
- package/dist/local/store/sqlite/key-storage/contact-identities.d.ts +19 -0
- package/dist/local/store/sqlite/key-storage/contact-identities.d.ts.map +1 -0
- package/dist/local/store/sqlite/key-storage/contact-identities.js +85 -0
- package/dist/local/store/sqlite/key-storage/contact-identities.js.map +1 -0
- package/dist/local/store/sqlite/key-storage/context.d.ts +19 -0
- package/dist/local/store/sqlite/key-storage/context.d.ts.map +1 -0
- package/dist/local/store/sqlite/key-storage/context.js +18 -0
- package/dist/local/store/sqlite/key-storage/context.js.map +1 -0
- package/dist/local/store/sqlite/key-storage/identity-keys.d.ts +18 -0
- package/dist/local/store/sqlite/key-storage/identity-keys.d.ts.map +1 -0
- package/dist/local/store/sqlite/key-storage/identity-keys.js +88 -0
- package/dist/local/store/sqlite/key-storage/identity-keys.js.map +1 -0
- package/dist/local/store/sqlite/key-storage/index.d.ts +108 -0
- package/dist/local/store/sqlite/key-storage/index.d.ts.map +1 -0
- package/dist/local/store/sqlite/key-storage/index.js +241 -0
- package/dist/local/store/sqlite/key-storage/index.js.map +1 -0
- package/dist/local/store/sqlite/key-storage/message-records.d.ts +41 -0
- package/dist/local/store/sqlite/key-storage/message-records.d.ts.map +1 -0
- package/dist/local/store/sqlite/key-storage/message-records.js +133 -0
- package/dist/local/store/sqlite/key-storage/message-records.js.map +1 -0
- package/dist/local/store/sqlite/key-storage/metadata.d.ts +16 -0
- package/dist/local/store/sqlite/key-storage/metadata.d.ts.map +1 -0
- package/dist/local/store/sqlite/key-storage/metadata.js +53 -0
- package/dist/local/store/sqlite/key-storage/metadata.js.map +1 -0
- package/dist/local/store/sqlite/key-storage/one-time-prekeys.d.ts +36 -0
- package/dist/local/store/sqlite/key-storage/one-time-prekeys.d.ts.map +1 -0
- package/dist/local/store/sqlite/key-storage/one-time-prekeys.js +129 -0
- package/dist/local/store/sqlite/key-storage/one-time-prekeys.js.map +1 -0
- package/dist/local/store/sqlite/key-storage/session-trust.d.ts +10 -0
- package/dist/local/store/sqlite/key-storage/session-trust.d.ts.map +1 -0
- package/dist/local/store/sqlite/key-storage/session-trust.js +88 -0
- package/dist/local/store/sqlite/key-storage/session-trust.js.map +1 -0
- package/dist/local/store/sqlite/key-storage/sessions.d.ts +50 -0
- package/dist/local/store/sqlite/key-storage/sessions.d.ts.map +1 -0
- package/dist/local/store/sqlite/key-storage/sessions.js +209 -0
- package/dist/local/store/sqlite/key-storage/sessions.js.map +1 -0
- package/dist/local/store/sqlite/key-storage/signed-prekeys.d.ts +69 -0
- package/dist/local/store/sqlite/key-storage/signed-prekeys.d.ts.map +1 -0
- package/dist/local/store/sqlite/key-storage/signed-prekeys.js +219 -0
- package/dist/local/store/sqlite/key-storage/signed-prekeys.js.map +1 -0
- package/dist/local/store/sqlite/maintenance.d.ts +7 -0
- package/dist/local/store/sqlite/maintenance.d.ts.map +1 -0
- package/dist/local/store/sqlite/maintenance.js +32 -0
- package/dist/local/store/sqlite/maintenance.js.map +1 -0
- package/dist/local/store/sqlite/migrations.d.ts +31 -0
- package/dist/local/store/sqlite/migrations.d.ts.map +1 -0
- package/dist/local/store/sqlite/migrations.js +232 -0
- package/dist/local/store/sqlite/migrations.js.map +1 -0
- package/dist/local/store/{expo → sqlite}/models/ec-one-time-prekey.d.ts +17 -22
- package/dist/local/store/sqlite/models/ec-one-time-prekey.d.ts.map +1 -0
- package/dist/local/store/{expo → sqlite}/models/ec-one-time-prekey.js +61 -99
- package/dist/local/store/sqlite/models/ec-one-time-prekey.js.map +1 -0
- package/dist/local/store/{expo → sqlite}/models/ec-signed-prekey.d.ts +22 -25
- package/dist/local/store/sqlite/models/ec-signed-prekey.d.ts.map +1 -0
- package/dist/local/store/{expo → sqlite}/models/ec-signed-prekey.js +82 -128
- package/dist/local/store/sqlite/models/ec-signed-prekey.js.map +1 -0
- package/dist/local/store/sqlite/models/identity-key-id.d.ts.map +1 -0
- package/dist/local/store/sqlite/models/identity-key-id.js.map +1 -0
- package/dist/local/store/{expo → sqlite}/models/index.d.ts +5 -5
- package/dist/local/store/sqlite/models/index.d.ts.map +1 -0
- package/dist/local/store/{expo → sqlite}/models/index.js +12 -5
- package/dist/local/store/sqlite/models/index.js.map +1 -0
- package/dist/local/store/{expo → sqlite}/models/kyber-one-time-prekey.d.ts +17 -20
- package/dist/local/store/sqlite/models/kyber-one-time-prekey.d.ts.map +1 -0
- package/dist/local/store/{expo → sqlite}/models/kyber-one-time-prekey.js +65 -105
- package/dist/local/store/sqlite/models/kyber-one-time-prekey.js.map +1 -0
- package/dist/local/store/{expo → sqlite}/models/kyber-prekey-used.d.ts +3 -3
- package/dist/local/store/sqlite/models/kyber-prekey-used.d.ts.map +1 -0
- package/dist/local/store/{expo → sqlite}/models/kyber-prekey-used.js +13 -25
- package/dist/local/store/sqlite/models/kyber-prekey-used.js.map +1 -0
- package/dist/local/store/{expo → sqlite}/models/kyber-prekey.d.ts +16 -19
- package/dist/local/store/sqlite/models/kyber-prekey.d.ts.map +1 -0
- package/dist/local/store/{expo → sqlite}/models/kyber-prekey.js +67 -111
- package/dist/local/store/sqlite/models/kyber-prekey.js.map +1 -0
- package/dist/local/store/sqlite/models/local-identity.d.ts +51 -0
- package/dist/local/store/sqlite/models/local-identity.d.ts.map +1 -0
- package/dist/local/store/sqlite/models/local-identity.js +150 -0
- package/dist/local/store/sqlite/models/local-identity.js.map +1 -0
- package/dist/local/store/{expo → sqlite}/models/message-record.d.ts +15 -44
- package/dist/local/store/sqlite/models/message-record.d.ts.map +1 -0
- package/dist/local/store/{expo → sqlite}/models/message-record.js +43 -109
- package/dist/local/store/sqlite/models/message-record.js.map +1 -0
- package/dist/local/store/sqlite/models/recipient-identity.d.ts +21 -0
- package/dist/local/store/sqlite/models/recipient-identity.d.ts.map +1 -0
- package/dist/local/store/sqlite/models/recipient-identity.js +59 -0
- package/dist/local/store/sqlite/models/recipient-identity.js.map +1 -0
- package/dist/local/store/sqlite/models/replaced-prekeys.d.ts +23 -0
- package/dist/local/store/sqlite/models/replaced-prekeys.d.ts.map +1 -0
- package/dist/local/store/sqlite/models/replaced-prekeys.js +42 -0
- package/dist/local/store/sqlite/models/replaced-prekeys.js.map +1 -0
- package/dist/local/store/{expo → sqlite}/models/sender-key.d.ts +22 -23
- package/dist/local/store/sqlite/models/sender-key.d.ts.map +1 -0
- package/dist/local/store/{expo → sqlite}/models/sender-key.js +66 -94
- package/dist/local/store/sqlite/models/sender-key.js.map +1 -0
- package/dist/local/store/sqlite/models/sesame-user-record.d.ts +32 -0
- package/dist/local/store/sqlite/models/sesame-user-record.d.ts.map +1 -0
- package/dist/local/store/sqlite/models/sesame-user-record.js +78 -0
- package/dist/local/store/sqlite/models/sesame-user-record.js.map +1 -0
- package/dist/local/store/{expo → sqlite}/models/session.d.ts +24 -20
- package/dist/local/store/sqlite/models/session.d.ts.map +1 -0
- package/dist/local/store/{expo → sqlite}/models/session.js +54 -72
- package/dist/local/store/sqlite/models/session.js.map +1 -0
- package/dist/local/store/sqlite/models/skipped-sender-key.d.ts +24 -0
- package/dist/local/store/sqlite/models/skipped-sender-key.d.ts.map +1 -0
- package/dist/local/store/sqlite/models/skipped-sender-key.js +62 -0
- package/dist/local/store/sqlite/models/skipped-sender-key.js.map +1 -0
- package/dist/local/store/sqlite/op-sqlite-driver.d.ts +14 -0
- package/dist/local/store/sqlite/op-sqlite-driver.d.ts.map +1 -0
- package/dist/local/store/sqlite/op-sqlite-driver.js +180 -0
- package/dist/local/store/sqlite/op-sqlite-driver.js.map +1 -0
- package/dist/local/store/sqlite/open-store.d.ts +83 -0
- package/dist/local/store/sqlite/open-store.d.ts.map +1 -0
- package/dist/local/store/sqlite/open-store.js +177 -0
- package/dist/local/store/sqlite/open-store.js.map +1 -0
- package/dist/local/store/sqlite/schema.d.ts +102 -0
- package/dist/local/store/sqlite/schema.d.ts.map +1 -0
- package/dist/local/store/sqlite/schema.js +61 -0
- package/dist/local/store/sqlite/schema.js.map +1 -0
- package/dist/local/store/sqlite/store.d.ts +199 -0
- package/dist/local/store/sqlite/store.d.ts.map +1 -0
- package/dist/local/store/sqlite/store.js +494 -0
- package/dist/local/store/sqlite/store.js.map +1 -0
- package/dist/local/store/sqlite/web/driver.d.ts +50 -0
- package/dist/local/store/sqlite/web/driver.d.ts.map +1 -0
- package/dist/local/store/sqlite/web/driver.js +169 -0
- package/dist/local/store/sqlite/web/driver.js.map +1 -0
- package/dist/local/store/sqlite/web/protocol.d.ts +80 -0
- package/dist/local/store/sqlite/web/protocol.d.ts.map +1 -0
- package/dist/local/store/sqlite/web/protocol.js +13 -0
- package/dist/local/store/sqlite/web/protocol.js.map +1 -0
- package/dist/local/store/sqlite/web/sqlite3mc/sqlite3.mjs +14526 -0
- package/dist/local/store/sqlite/web/sqlite3mc/sqlite3.wasm +0 -0
- package/dist/local/store/sqlite/web/worker.d.ts +36 -0
- package/dist/local/store/sqlite/web/worker.d.ts.map +1 -0
- package/dist/local/store/sqlite/web/worker.js +616 -0
- package/dist/local/store/sqlite/web/worker.js.map +1 -0
- package/dist/local/store/web/adapter.d.ts +5 -14
- package/dist/local/store/web/adapter.d.ts.map +1 -1
- package/dist/local/store/web/adapter.js +119 -106
- package/dist/local/store/web/adapter.js.map +1 -1
- package/dist/local/store/web/device-record.d.ts +23 -0
- package/dist/local/store/web/device-record.d.ts.map +1 -0
- package/dist/local/store/web/device-record.js +31 -0
- package/dist/local/store/web/device-record.js.map +1 -0
- package/dist/local/store/web-sqlite/adapter.d.ts +98 -0
- package/dist/local/store/web-sqlite/adapter.d.ts.map +1 -0
- package/dist/local/store/web-sqlite/adapter.js +151 -0
- package/dist/local/store/web-sqlite/adapter.js.map +1 -0
- package/dist/local/store/web-sqlite/index.d.ts +14 -0
- package/dist/local/store/web-sqlite/index.d.ts.map +1 -0
- package/dist/local/store/web-sqlite/index.js +3 -0
- package/dist/local/store/web-sqlite/index.js.map +1 -0
- package/dist/local/store/web-sqlite/maintenance.d.ts +5 -0
- package/dist/local/store/web-sqlite/maintenance.d.ts.map +1 -0
- package/dist/local/store/web-sqlite/maintenance.js +7 -0
- package/dist/local/store/web-sqlite/maintenance.js.map +1 -0
- package/dist/local/store/web-sqlite/store-locks.d.ts +33 -0
- package/dist/local/store/web-sqlite/store-locks.d.ts.map +1 -0
- package/dist/local/store/web-sqlite/store-locks.js +60 -0
- package/dist/local/store/web-sqlite/store-locks.js.map +1 -0
- package/dist/local/vault/electron-safe-storage.d.ts +45 -0
- package/dist/local/vault/electron-safe-storage.d.ts.map +1 -0
- package/dist/local/vault/electron-safe-storage.js +212 -0
- package/dist/local/vault/electron-safe-storage.js.map +1 -0
- package/dist/local/vault/index.d.ts +4 -2
- package/dist/local/vault/index.d.ts.map +1 -1
- package/dist/local/vault/indexed-db.d.ts +37 -0
- package/dist/local/vault/indexed-db.d.ts.map +1 -0
- package/dist/local/vault/indexed-db.js +102 -0
- package/dist/local/vault/indexed-db.js.map +1 -0
- package/dist/local/vault/react-native-keychain.d.ts +12 -0
- package/dist/local/vault/react-native-keychain.d.ts.map +1 -0
- package/dist/local/vault/react-native-keychain.js +71 -0
- package/dist/local/vault/react-native-keychain.js.map +1 -0
- package/dist/local/vault/require.d.ts +10 -0
- package/dist/local/vault/require.d.ts.map +1 -0
- package/dist/local/vault/require.js +16 -0
- package/dist/local/vault/require.js.map +1 -0
- package/dist/logger.d.ts.map +1 -1
- package/dist/logger.js +2 -1
- package/dist/logger.js.map +1 -1
- package/dist/media/index.d.ts.map +1 -1
- package/dist/media/index.js +2 -1
- package/dist/media/index.js.map +1 -1
- package/dist/profile/contact-state.d.ts.map +1 -1
- package/dist/profile/contact-state.js +2 -4
- package/dist/profile/contact-state.js.map +1 -1
- package/dist/profile/index.d.ts +0 -1
- package/dist/profile/index.d.ts.map +1 -1
- package/dist/profile/index.js +0 -2
- package/dist/profile/index.js.map +1 -1
- package/dist/profile/profile-key.d.ts +16 -11
- package/dist/profile/profile-key.d.ts.map +1 -1
- package/dist/profile/profile-key.js +29 -29
- package/dist/profile/profile-key.js.map +1 -1
- package/dist/profile/update-service.d.ts +6 -0
- package/dist/profile/update-service.d.ts.map +1 -1
- package/dist/profile/update-service.js +3 -1
- package/dist/profile/update-service.js.map +1 -1
- package/dist/remote/object-store/validation.d.ts.map +1 -1
- package/dist/remote/object-store/validation.js +2 -1
- package/dist/remote/object-store/validation.js.map +1 -1
- package/dist/remote/relay/memory/adapter.d.ts +2 -3
- package/dist/remote/relay/memory/adapter.d.ts.map +1 -1
- package/dist/remote/relay/memory/adapter.js +22 -30
- package/dist/remote/relay/memory/adapter.js.map +1 -1
- package/dist/remote/relay/memory/failures.d.ts.map +1 -1
- package/dist/remote/relay/memory/failures.js +2 -1
- package/dist/remote/relay/memory/failures.js.map +1 -1
- package/dist/remote/relay/memory/group-server.d.ts +5 -1
- package/dist/remote/relay/memory/group-server.d.ts.map +1 -1
- package/dist/remote/relay/memory/group-server.js +11 -1
- package/dist/remote/relay/memory/group-server.js.map +1 -1
- package/dist/safety/url.d.ts.map +1 -1
- package/dist/safety/url.js +21 -26
- package/dist/safety/url.js.map +1 -1
- package/dist/types/api.d.ts +15 -2
- package/dist/types/api.d.ts.map +1 -1
- package/dist/types/errors.d.ts +97 -1
- package/dist/types/errors.d.ts.map +1 -1
- package/dist/types/errors.js +105 -1
- package/dist/types/errors.js.map +1 -1
- package/dist/types/session.d.ts.map +1 -1
- package/dist/types/session.js +2 -1
- package/dist/types/session.js.map +1 -1
- package/dist/utils/retry.d.ts +2 -0
- package/dist/utils/retry.d.ts.map +1 -1
- package/dist/utils/retry.js +4 -2
- package/dist/utils/retry.js.map +1 -1
- package/docs/ASSURANCE.md +80 -8
- package/docs/CLIENT_COMPOSITION.md +1 -2
- package/docs/DEVIATIONS.md +1 -1
- package/docs/ERROR_HANDLING.md +6 -0
- package/docs/GETTING_STARTED.md +1 -2
- package/docs/PACKAGE_SURFACE.md +29 -11
- package/docs/RECIPES.md +1 -2
- package/examples/browser/index.html +1 -1
- package/local/store/README.md +117 -37
- package/local/store/expo/README.md +67 -47
- package/local/store/key-value/README.md +278 -0
- package/local/store/node/README.md +206 -46
- package/local/store/react-native/README.md +120 -61
- package/local/store/web/README.md +9 -0
- package/local/store/web-sqlite/README.md +202 -0
- package/local/vault/README.md +115 -2
- package/package.json +42 -23
- package/profile/README.md +9 -11
- package/remote/README.md +1 -2
- package/dist/local/store/expo/database-key.d.ts +0 -142
- package/dist/local/store/expo/database-key.d.ts.map +0 -1
- package/dist/local/store/expo/database-key.js +0 -312
- package/dist/local/store/expo/database-key.js.map +0 -1
- package/dist/local/store/expo/db.d.ts +0 -95
- package/dist/local/store/expo/db.d.ts.map +0 -1
- package/dist/local/store/expo/db.js +0 -147
- package/dist/local/store/expo/db.js.map +0 -1
- package/dist/local/store/expo/key-storage.d.ts +0 -429
- package/dist/local/store/expo/key-storage.d.ts.map +0 -1
- package/dist/local/store/expo/key-storage.js +0 -1361
- package/dist/local/store/expo/key-storage.js.map +0 -1
- package/dist/local/store/expo/models/ec-one-time-prekey.d.ts.map +0 -1
- package/dist/local/store/expo/models/ec-one-time-prekey.js.map +0 -1
- package/dist/local/store/expo/models/ec-signed-prekey.d.ts.map +0 -1
- package/dist/local/store/expo/models/ec-signed-prekey.js.map +0 -1
- package/dist/local/store/expo/models/identity-key-id.d.ts.map +0 -1
- package/dist/local/store/expo/models/identity-key-id.js.map +0 -1
- package/dist/local/store/expo/models/index.d.ts.map +0 -1
- package/dist/local/store/expo/models/index.js.map +0 -1
- package/dist/local/store/expo/models/kyber-one-time-prekey.d.ts.map +0 -1
- package/dist/local/store/expo/models/kyber-one-time-prekey.js.map +0 -1
- package/dist/local/store/expo/models/kyber-prekey-used.d.ts.map +0 -1
- package/dist/local/store/expo/models/kyber-prekey-used.js.map +0 -1
- package/dist/local/store/expo/models/kyber-prekey.d.ts.map +0 -1
- package/dist/local/store/expo/models/kyber-prekey.js.map +0 -1
- package/dist/local/store/expo/models/local-identity.d.ts +0 -52
- package/dist/local/store/expo/models/local-identity.d.ts.map +0 -1
- package/dist/local/store/expo/models/local-identity.js +0 -166
- package/dist/local/store/expo/models/local-identity.js.map +0 -1
- package/dist/local/store/expo/models/message-record.d.ts.map +0 -1
- package/dist/local/store/expo/models/message-record.js.map +0 -1
- package/dist/local/store/expo/models/recipient-identity.d.ts +0 -21
- package/dist/local/store/expo/models/recipient-identity.d.ts.map +0 -1
- package/dist/local/store/expo/models/recipient-identity.js +0 -66
- package/dist/local/store/expo/models/recipient-identity.js.map +0 -1
- package/dist/local/store/expo/models/replaced-prekey-utils.d.ts +0 -33
- package/dist/local/store/expo/models/replaced-prekey-utils.d.ts.map +0 -1
- package/dist/local/store/expo/models/replaced-prekey-utils.js +0 -54
- package/dist/local/store/expo/models/replaced-prekey-utils.js.map +0 -1
- package/dist/local/store/expo/models/sender-key.d.ts.map +0 -1
- package/dist/local/store/expo/models/sender-key.js.map +0 -1
- package/dist/local/store/expo/models/session.d.ts.map +0 -1
- package/dist/local/store/expo/models/session.js.map +0 -1
- package/dist/local/store/expo/schema.d.ts +0 -1917
- package/dist/local/store/expo/schema.d.ts.map +0 -1
- package/dist/local/store/expo/schema.js +0 -197
- package/dist/local/store/expo/schema.js.map +0 -1
- package/dist/local/store/node/database-encryption.d.ts +0 -109
- package/dist/local/store/node/database-encryption.d.ts.map +0 -1
- package/dist/local/store/node/database-encryption.js +0 -202
- package/dist/local/store/node/database-encryption.js.map +0 -1
- package/dist/local/store/node/database-file-commit.d.ts +0 -8
- package/dist/local/store/node/database-file-commit.d.ts.map +0 -1
- package/dist/local/store/node/database-file-commit.js +0 -62
- package/dist/local/store/node/database-file-commit.js.map +0 -1
- package/dist/local/store/node/database-key.d.ts +0 -129
- package/dist/local/store/node/database-key.d.ts.map +0 -1
- package/dist/local/store/node/database-key.js +0 -293
- package/dist/local/store/node/database-key.js.map +0 -1
- package/dist/local/store/node/database-lock.d.ts +0 -8
- package/dist/local/store/node/database-lock.d.ts.map +0 -1
- package/dist/local/store/node/database-lock.js +0 -44
- package/dist/local/store/node/database-lock.js.map +0 -1
- package/dist/local/store/node/database.d.ts +0 -226
- package/dist/local/store/node/database.d.ts.map +0 -1
- package/dist/local/store/node/database.js +0 -813
- package/dist/local/store/node/database.js.map +0 -1
- package/dist/local/store/react-native/backend-conformance.d.ts.map +0 -1
- package/dist/local/store/react-native/backend-conformance.js.map +0 -1
- package/dist/local/store/react-native/reference-backend.d.ts +0 -43
- package/dist/local/store/react-native/reference-backend.d.ts.map +0 -1
- package/dist/local/store/react-native/reference-backend.js +0 -178
- package/dist/local/store/react-native/reference-backend.js.map +0 -1
- package/dist/local/store/react-native/storage.d.ts.map +0 -1
- package/dist/local/store/react-native/storage.js.map +0 -1
- package/dist/profile/storage.d.ts +0 -61
- package/dist/profile/storage.d.ts.map +0 -1
- package/dist/profile/storage.js +0 -145
- package/dist/profile/storage.js.map +0 -1
- /package/dist/local/store/{react-native → key-value}/storage.js +0 -0
- /package/dist/local/store/{expo → sqlite}/models/identity-key-id.d.ts +0 -0
- /package/dist/local/store/{expo → sqlite}/models/identity-key-id.js +0 -0
package/README.md
CHANGED
|
@@ -11,7 +11,7 @@ Add encrypted messaging to Expo, React Native, browser, and Node applications. T
|
|
|
11
11
|
|
|
12
12
|
The default policy requires post-quantum session establishment and ratcheting. The protocol implementation is open source under the MIT License or the Apache License 2.0, at your option.
|
|
13
13
|
|
|
14
|
-
[**Run an encrypted exchange in your browser**](https://open-e2ee.dev/playground) · [Edit on StackBlitz](https://stackblitz.com/fork/github/open-e2ee/signal-protocol-js/tree/
|
|
14
|
+
[**Run an encrypted exchange in your browser**](https://open-e2ee.dev/playground) · [Edit on StackBlitz](https://stackblitz.com/fork/github/open-e2ee/signal-protocol-js/tree/v8.0.0/examples/browser) · [Run on Expo / Hermes](./examples/expo/README.md)
|
|
15
15
|
|
|
16
16
|
[](./LICENSE)
|
|
17
17
|
[](https://www.npmjs.com/package/@open-e2ee/signal-protocol-sdk)
|
|
@@ -43,7 +43,7 @@ The relay never needs message plaintext or device private keys.
|
|
|
43
43
|
|
|
44
44
|
OpenE2EE implements a versioned profile of the published Signal Protocol specifications. It is not affiliated with Signal Messenger and is **not wire-compatible with Signal Messenger or libsignal**. Messages, identities, and safety numbers do not interoperate. See the [notice](./NOTICE) and [documented deviations](./docs/DEVIATIONS.md).
|
|
45
45
|
|
|
46
|
-
Version `
|
|
46
|
+
Version `8.0.x`. Public APIs and persisted formats follow semantic versioning.
|
|
47
47
|
|
|
48
48
|
## Install
|
|
49
49
|
|
|
@@ -106,10 +106,12 @@ Choose the device-local store for your runtime. Then supply a relay that authent
|
|
|
106
106
|
|
|
107
107
|
| Runtime | Storage path | Deployment boundary |
|
|
108
108
|
|---|---|---|
|
|
109
|
-
| Expo | [`expoStore`](./local/store/expo/README.md) |
|
|
109
|
+
| Expo | [`expoStore`](./local/store/expo/README.md) | Enable SQLCipher in the expo-sqlite config plugin. The SDK owns the database file, its key, and its migrations. Requires a native development or release build. [Run the Hermes example](./examples/expo/README.md); Expo Go does not include SQLCipher. |
|
|
110
110
|
| Browser | [`indexedDbStore`](./local/store/web/README.md) | Use a secure context and a restrictive CSP. Same-origin JavaScript can access stored records and their key. [Browser setup](https://docs.open-e2ee.dev/start/browser). |
|
|
111
|
-
|
|
|
112
|
-
|
|
|
111
|
+
| Browser, SQLite | [`webSqliteStore`](./local/store/web-sqlite/README.md) | Needs the origin private file system and a CSP that allows `'wasm-unsafe-eval'`. The SDK owns the database file, its key, and its migrations. The key sits in IndexedDB in the same origin, so same-origin JavaScript can read it. |
|
|
112
|
+
| Bare React Native | [`reactNativeStore`](./local/store/react-native/README.md) | Enable SQLCipher with `"op-sqlite": { "sqlcipher": true }` in the app's `package.json`, and install `react-native-keychain`. The SDK owns the database file, its key, and its migrations. Requires a native build; with SQLCipher on, op-sqlite conflicts on iOS with `expo-sqlite`, `expo-updates`, and `use_frameworks!`. |
|
|
113
|
+
| Own key-value engine | [`keyValueStore`](./local/store/key-value/README.md) | Provide an atomic, durable key-value backend and a keychain-backed secret vault, and run the exported backend conformance kit. A Realm backend is included. |
|
|
114
|
+
| Node and Electron | [`nodeStore`](./local/store/node/README.md) | Install `better-sqlite3-multiple-ciphers` and pass a private directory on a local file system and a secret vault. In Electron, open it in the main process with the safeStorage vault. The SDK owns the database file, its key, and its migrations. |
|
|
113
115
|
|
|
114
116
|
React Native support starts at React Native 0.83.6 and Expo SDK 55. The peer ranges have no upper bound. CI checks these versions:
|
|
115
117
|
|
|
@@ -121,6 +123,8 @@ React Native support starts at React Native 0.83.6 and Expo SDK 55. The peer ran
|
|
|
121
123
|
|
|
122
124
|
React Native 0.84 and later use Hermes V1 by default. React Native 0.82 and later run only on the New Architecture.
|
|
123
125
|
|
|
126
|
+
On React Native and Expo, the SDK reads random bytes only from the global `crypto.getRandomValues`. Install `react-native-get-random-values` 2.x or `react-native-quick-crypto`, and load it before the first SDK call. Without a global source, the SDK throws `SecureRandomUnavailableError`.
|
|
127
|
+
|
|
124
128
|
The [adapter guide](./ADAPTERS.md) defines every storage, relay, vault, and object-store boundary. The [client composition guide](./docs/CLIENT_COMPOSITION.md) shows an Expo client on the OpenE2EE Signal Protocol Relay.
|
|
125
129
|
|
|
126
130
|
## Security and assurance
|
package/SECURITY.md
CHANGED
package/THIRD_PARTY_NOTICES.md
CHANGED
|
@@ -29,3 +29,432 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
29
29
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
30
30
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
31
31
|
SOFTWARE.
|
|
32
|
+
|
|
33
|
+
## SQLite3 Multiple Ciphers
|
|
34
|
+
|
|
35
|
+
`local/store/sqlite/web/sqlite3mc/sqlite3.mjs` and `sqlite3.wasm` are the
|
|
36
|
+
Wasm build of SQLite3 Multiple Ciphers 2.5.1 (SQLite 3.53.4). `sqlite3.wasm`
|
|
37
|
+
is unmodified. `sqlite3.mjs` carries the patches that
|
|
38
|
+
`local/store/sqlite/web/sqlite3mc/README.md` lists. The sections below cover
|
|
39
|
+
the code that this build contains.
|
|
40
|
+
|
|
41
|
+
The MIT License
|
|
42
|
+
|
|
43
|
+
Copyright (c) 2019-2026 Ulrich Telle
|
|
44
|
+
|
|
45
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
46
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
47
|
+
in the Software without restriction, including without limitation the rights
|
|
48
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
49
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
50
|
+
furnished to do so, subject to the following conditions:
|
|
51
|
+
|
|
52
|
+
The above copyright notice and this permission notice shall be included in all
|
|
53
|
+
copies or substantial portions of the Software.
|
|
54
|
+
|
|
55
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
56
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
57
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
58
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
59
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
60
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
61
|
+
SOFTWARE.
|
|
62
|
+
|
|
63
|
+
## SQLite
|
|
64
|
+
|
|
65
|
+
SQLite is in the public domain. The authors disclaim copyright to its source
|
|
66
|
+
code.
|
|
67
|
+
|
|
68
|
+
## AEGIS
|
|
69
|
+
|
|
70
|
+
The AEGIS cipher code in SQLite3 Multiple Ciphers comes from libaegis.
|
|
71
|
+
|
|
72
|
+
The MIT License
|
|
73
|
+
|
|
74
|
+
Copyright (c) 2023-2024 Frank Denis
|
|
75
|
+
|
|
76
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
77
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
78
|
+
in the Software without restriction, including without limitation the rights
|
|
79
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
80
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
81
|
+
furnished to do so, subject to the following conditions:
|
|
82
|
+
|
|
83
|
+
The above copyright notice and this permission notice shall be included in all
|
|
84
|
+
copies or substantial portions of the Software.
|
|
85
|
+
|
|
86
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
87
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
88
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
89
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
90
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
91
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
92
|
+
SOFTWARE.
|
|
93
|
+
|
|
94
|
+
## SHA-2 (Olivier Gay)
|
|
95
|
+
|
|
96
|
+
The SHA-256 and SHA-512 code in SQLite3 Multiple Ciphers.
|
|
97
|
+
|
|
98
|
+
Copyright (C) 2005, 2007 Olivier Gay <olivier.gay@a3.epfl.ch>
|
|
99
|
+
All rights reserved.
|
|
100
|
+
|
|
101
|
+
Redistribution and use in source and binary forms, with or without
|
|
102
|
+
modification, are permitted provided that the following conditions
|
|
103
|
+
are met:
|
|
104
|
+
1. Redistributions of source code must retain the above copyright
|
|
105
|
+
notice, this list of conditions and the following disclaimer.
|
|
106
|
+
2. Redistributions in binary form must reproduce the above copyright
|
|
107
|
+
notice, this list of conditions and the following disclaimer in the
|
|
108
|
+
documentation and/or other materials provided with the distribution.
|
|
109
|
+
3. Neither the name of the project nor the names of its contributors
|
|
110
|
+
may be used to endorse or promote products derived from this software
|
|
111
|
+
without specific prior written permission.
|
|
112
|
+
|
|
113
|
+
THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
|
|
114
|
+
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
115
|
+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
116
|
+
ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
|
|
117
|
+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
118
|
+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
119
|
+
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
120
|
+
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
121
|
+
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
122
|
+
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
123
|
+
SUCH DAMAGE.
|
|
124
|
+
|
|
125
|
+
## Argon2 and BLAKE2b
|
|
126
|
+
|
|
127
|
+
The Argon2 and BLAKE2b code in SQLite3 Multiple Ciphers is the Argon2
|
|
128
|
+
reference implementation, Copyright 2015 Daniel Dinu, Dmitry Khovratovich,
|
|
129
|
+
Jean-Philippe Aumasson, and Samuel Neves. It is used under the Creative
|
|
130
|
+
Commons CC0 1.0 Universal waiver
|
|
131
|
+
(<https://creativecommons.org/publicdomain/zero/1.0/>).
|
|
132
|
+
|
|
133
|
+
## fast-pbkdf2
|
|
134
|
+
|
|
135
|
+
The PBKDF2 code in SQLite3 Multiple Ciphers is fast-pbkdf2, written in 2015 by
|
|
136
|
+
Joseph Birr-Pixton and dedicated to the public domain under the Creative
|
|
137
|
+
Commons CC0 1.0 Universal waiver
|
|
138
|
+
(<https://creativecommons.org/publicdomain/zero/1.0/>).
|
|
139
|
+
|
|
140
|
+
## Public-domain components of SQLite3 Multiple Ciphers
|
|
141
|
+
|
|
142
|
+
These parts of SQLite3 Multiple Ciphers are in the public domain. The
|
|
143
|
+
SQLite3 Multiple Ciphers adaptations of them are covered by its MIT license
|
|
144
|
+
above.
|
|
145
|
+
|
|
146
|
+
- SHA-1.
|
|
147
|
+
- MD5, written by Alexander Peslyak (Solar Designer) in 2001.
|
|
148
|
+
- ChaCha20 and Poly1305, from the sqleet project.
|
|
149
|
+
- Rijndael (AES), based on the implementation by Vincent Rijmen, Antoon
|
|
150
|
+
Bosselaers, and Paulo Barreto.
|
|
151
|
+
- Ascon, from the Ascon reference implementation.
|
|
152
|
+
|
|
153
|
+
## Emscripten
|
|
154
|
+
|
|
155
|
+
The JavaScript glue and the runtime support code of the Wasm build come from
|
|
156
|
+
Emscripten.
|
|
157
|
+
|
|
158
|
+
```text
|
|
159
|
+
Emscripten is available under 2 licenses, the MIT license and the
|
|
160
|
+
University of Illinois/NCSA Open Source License.
|
|
161
|
+
|
|
162
|
+
Both are permissive open source licenses, with little if any
|
|
163
|
+
practical difference between them.
|
|
164
|
+
|
|
165
|
+
The reason for offering both is that (1) the MIT license is
|
|
166
|
+
well-known, while (2) the University of Illinois/NCSA Open Source
|
|
167
|
+
License allows Emscripten's code to be integrated upstream into
|
|
168
|
+
LLVM, which uses that license, should the opportunity arise.
|
|
169
|
+
|
|
170
|
+
The full text of both licenses follows.
|
|
171
|
+
|
|
172
|
+
==============================================================================
|
|
173
|
+
|
|
174
|
+
Copyright (c) 2010-2014 Emscripten authors, see AUTHORS file.
|
|
175
|
+
|
|
176
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
177
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
178
|
+
in the Software without restriction, including without limitation the rights
|
|
179
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
180
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
181
|
+
furnished to do so, subject to the following conditions:
|
|
182
|
+
|
|
183
|
+
The above copyright notice and this permission notice shall be included in
|
|
184
|
+
all copies or substantial portions of the Software.
|
|
185
|
+
|
|
186
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
187
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
188
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
189
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
190
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
191
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
192
|
+
THE SOFTWARE.
|
|
193
|
+
|
|
194
|
+
==============================================================================
|
|
195
|
+
|
|
196
|
+
Copyright (c) 2010-2014 Emscripten authors, see AUTHORS file.
|
|
197
|
+
All rights reserved.
|
|
198
|
+
|
|
199
|
+
Permission is hereby granted, free of charge, to any person obtaining a
|
|
200
|
+
copy of this software and associated documentation files (the
|
|
201
|
+
"Software"), to deal with the Software without restriction, including
|
|
202
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
|
203
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
|
204
|
+
permit persons to whom the Software is furnished to do so, subject to
|
|
205
|
+
the following conditions:
|
|
206
|
+
|
|
207
|
+
Redistributions of source code must retain the above copyright
|
|
208
|
+
notice, this list of conditions and the following disclaimers.
|
|
209
|
+
|
|
210
|
+
Redistributions in binary form must reproduce the above
|
|
211
|
+
copyright notice, this list of conditions and the following disclaimers
|
|
212
|
+
in the documentation and/or other materials provided with the
|
|
213
|
+
distribution.
|
|
214
|
+
|
|
215
|
+
Neither the names of Mozilla,
|
|
216
|
+
nor the names of its contributors may be used to endorse
|
|
217
|
+
or promote products derived from this Software without specific prior
|
|
218
|
+
written permission.
|
|
219
|
+
|
|
220
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
221
|
+
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
222
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
223
|
+
IN NO EVENT SHALL THE CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR
|
|
224
|
+
ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
|
225
|
+
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
|
226
|
+
SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE SOFTWARE.
|
|
227
|
+
|
|
228
|
+
==============================================================================
|
|
229
|
+
|
|
230
|
+
This program uses portions of Node.js source code located in src/library_path.js,
|
|
231
|
+
in accordance with the terms of the MIT license. Node's license follows:
|
|
232
|
+
|
|
233
|
+
"""
|
|
234
|
+
Copyright Joyent, Inc. and other Node contributors. All rights reserved.
|
|
235
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
236
|
+
of this software and associated documentation files (the "Software"), to
|
|
237
|
+
deal in the Software without restriction, including without limitation the
|
|
238
|
+
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
|
|
239
|
+
sell copies of the Software, and to permit persons to whom the Software is
|
|
240
|
+
furnished to do so, subject to the following conditions:
|
|
241
|
+
|
|
242
|
+
The above copyright notice and this permission notice shall be included in
|
|
243
|
+
all copies or substantial portions of the Software.
|
|
244
|
+
|
|
245
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
246
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
247
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
248
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
249
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
250
|
+
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
|
|
251
|
+
IN THE SOFTWARE.
|
|
252
|
+
"""
|
|
253
|
+
|
|
254
|
+
The musl libc project is bundled in this repo, and it has the MIT license, see
|
|
255
|
+
system/lib/libc/musl/COPYRIGHT
|
|
256
|
+
|
|
257
|
+
The third_party/ subdirectory contains code with other licenses. None of it is
|
|
258
|
+
used by default, but certain options use it (e.g., the optional closure compiler
|
|
259
|
+
flag will run closure compiler from third_party/).
|
|
260
|
+
```
|
|
261
|
+
|
|
262
|
+
## musl
|
|
263
|
+
|
|
264
|
+
The C library code in the Wasm build comes from musl, through Emscripten.
|
|
265
|
+
|
|
266
|
+
```text
|
|
267
|
+
musl as a whole is licensed under the following standard MIT license:
|
|
268
|
+
|
|
269
|
+
----------------------------------------------------------------------
|
|
270
|
+
Copyright © 2005-2020 Rich Felker, et al.
|
|
271
|
+
|
|
272
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
|
273
|
+
a copy of this software and associated documentation files (the
|
|
274
|
+
"Software"), to deal in the Software without restriction, including
|
|
275
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
|
276
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
|
277
|
+
permit persons to whom the Software is furnished to do so, subject to
|
|
278
|
+
the following conditions:
|
|
279
|
+
|
|
280
|
+
The above copyright notice and this permission notice shall be
|
|
281
|
+
included in all copies or substantial portions of the Software.
|
|
282
|
+
|
|
283
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
284
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
285
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
286
|
+
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
|
287
|
+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
|
288
|
+
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
|
289
|
+
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
290
|
+
----------------------------------------------------------------------
|
|
291
|
+
|
|
292
|
+
Authors/contributors include:
|
|
293
|
+
|
|
294
|
+
A. Wilcox
|
|
295
|
+
Ada Worcester
|
|
296
|
+
Alex Dowad
|
|
297
|
+
Alex Suykov
|
|
298
|
+
Alexander Monakov
|
|
299
|
+
Andre McCurdy
|
|
300
|
+
Andrew Kelley
|
|
301
|
+
Anthony G. Basile
|
|
302
|
+
Aric Belsito
|
|
303
|
+
Arvid Picciani
|
|
304
|
+
Bartosz Brachaczek
|
|
305
|
+
Benjamin Peterson
|
|
306
|
+
Bobby Bingham
|
|
307
|
+
Boris Brezillon
|
|
308
|
+
Brent Cook
|
|
309
|
+
Chris Spiegel
|
|
310
|
+
Clément Vasseur
|
|
311
|
+
Daniel Micay
|
|
312
|
+
Daniel Sabogal
|
|
313
|
+
Daurnimator
|
|
314
|
+
David Carlier
|
|
315
|
+
David Edelsohn
|
|
316
|
+
Denys Vlasenko
|
|
317
|
+
Dmitry Ivanov
|
|
318
|
+
Dmitry V. Levin
|
|
319
|
+
Drew DeVault
|
|
320
|
+
Emil Renner Berthing
|
|
321
|
+
Fangrui Song
|
|
322
|
+
Felix Fietkau
|
|
323
|
+
Felix Janda
|
|
324
|
+
Gianluca Anzolin
|
|
325
|
+
Hauke Mehrtens
|
|
326
|
+
He X
|
|
327
|
+
Hiltjo Posthuma
|
|
328
|
+
Isaac Dunham
|
|
329
|
+
Jaydeep Patil
|
|
330
|
+
Jens Gustedt
|
|
331
|
+
Jeremy Huntwork
|
|
332
|
+
Jo-Philipp Wich
|
|
333
|
+
Joakim Sindholt
|
|
334
|
+
John Spencer
|
|
335
|
+
Julien Ramseier
|
|
336
|
+
Justin Cormack
|
|
337
|
+
Kaarle Ritvanen
|
|
338
|
+
Khem Raj
|
|
339
|
+
Kylie McClain
|
|
340
|
+
Leah Neukirchen
|
|
341
|
+
Luca Barbato
|
|
342
|
+
Luka Perkov
|
|
343
|
+
Lynn Ochs
|
|
344
|
+
M Farkas-Dyck (Strake)
|
|
345
|
+
Mahesh Bodapati
|
|
346
|
+
Markus Wichmann
|
|
347
|
+
Masanori Ogino
|
|
348
|
+
Michael Clark
|
|
349
|
+
Michael Forney
|
|
350
|
+
Mikhail Kremnyov
|
|
351
|
+
Natanael Copa
|
|
352
|
+
Nicholas J. Kain
|
|
353
|
+
orc
|
|
354
|
+
Pascal Cuoq
|
|
355
|
+
Patrick Oppenlander
|
|
356
|
+
Petr Hosek
|
|
357
|
+
Petr Skocik
|
|
358
|
+
Pierre Carrier
|
|
359
|
+
Reini Urban
|
|
360
|
+
Rich Felker
|
|
361
|
+
Richard Pennington
|
|
362
|
+
Ryan Fairfax
|
|
363
|
+
Samuel Holland
|
|
364
|
+
Segev Finer
|
|
365
|
+
Shiz
|
|
366
|
+
sin
|
|
367
|
+
Solar Designer
|
|
368
|
+
Stefan Kristiansson
|
|
369
|
+
Stefan O'Rear
|
|
370
|
+
Szabolcs Nagy
|
|
371
|
+
Timo Teräs
|
|
372
|
+
Trutz Behn
|
|
373
|
+
Will Dietz
|
|
374
|
+
William Haddon
|
|
375
|
+
William Pitcock
|
|
376
|
+
|
|
377
|
+
Portions of this software are derived from third-party works licensed
|
|
378
|
+
under terms compatible with the above MIT license:
|
|
379
|
+
|
|
380
|
+
The TRE regular expression implementation (src/regex/reg* and
|
|
381
|
+
src/regex/tre*) is Copyright © 2001-2008 Ville Laurikari and licensed
|
|
382
|
+
under a 2-clause BSD license (license text in the source files). The
|
|
383
|
+
included version has been heavily modified by Rich Felker in 2012, in
|
|
384
|
+
the interests of size, simplicity, and namespace cleanliness.
|
|
385
|
+
|
|
386
|
+
Much of the math library code (src/math/* and src/complex/*) is
|
|
387
|
+
Copyright © 1993,2004 Sun Microsystems or
|
|
388
|
+
Copyright © 2003-2011 David Schultz or
|
|
389
|
+
Copyright © 2003-2009 Steven G. Kargl or
|
|
390
|
+
Copyright © 2003-2009 Bruce D. Evans or
|
|
391
|
+
Copyright © 2008 Stephen L. Moshier or
|
|
392
|
+
Copyright © 2017-2018 Arm Limited
|
|
393
|
+
and labelled as such in comments in the individual source files. All
|
|
394
|
+
have been licensed under extremely permissive terms.
|
|
395
|
+
|
|
396
|
+
The ARM memcpy code (src/string/arm/memcpy.S) is Copyright © 2008
|
|
397
|
+
The Android Open Source Project and is licensed under a two-clause BSD
|
|
398
|
+
license. It was taken from Bionic libc, used on Android.
|
|
399
|
+
|
|
400
|
+
The AArch64 memcpy and memset code (src/string/aarch64/*) are
|
|
401
|
+
Copyright © 1999-2019, Arm Limited.
|
|
402
|
+
|
|
403
|
+
The implementation of DES for crypt (src/crypt/crypt_des.c) is
|
|
404
|
+
Copyright © 1994 David Burren. It is licensed under a BSD license.
|
|
405
|
+
|
|
406
|
+
The implementation of blowfish crypt (src/crypt/crypt_blowfish.c) was
|
|
407
|
+
originally written by Solar Designer and placed into the public
|
|
408
|
+
domain. The code also comes with a fallback permissive license for use
|
|
409
|
+
in jurisdictions that may not recognize the public domain.
|
|
410
|
+
|
|
411
|
+
The smoothsort implementation (src/stdlib/qsort.c) is Copyright © 2011
|
|
412
|
+
Lynn Ochs and is licensed under an MIT-style license.
|
|
413
|
+
|
|
414
|
+
The x86_64 port was written by Nicholas J. Kain and is licensed under
|
|
415
|
+
the standard MIT terms.
|
|
416
|
+
|
|
417
|
+
The mips and microblaze ports were originally written by Richard
|
|
418
|
+
Pennington for use in the ellcc project. The original code was adapted
|
|
419
|
+
by Rich Felker for build system and code conventions during upstream
|
|
420
|
+
integration. It is licensed under the standard MIT terms.
|
|
421
|
+
|
|
422
|
+
The mips64 port was contributed by Imagination Technologies and is
|
|
423
|
+
licensed under the standard MIT terms.
|
|
424
|
+
|
|
425
|
+
The powerpc port was also originally written by Richard Pennington,
|
|
426
|
+
and later supplemented and integrated by John Spencer. It is licensed
|
|
427
|
+
under the standard MIT terms.
|
|
428
|
+
|
|
429
|
+
All other files which have no copyright comments are original works
|
|
430
|
+
produced specifically for use as part of this library, written either
|
|
431
|
+
by Rich Felker, the main author of the library, or by one or more
|
|
432
|
+
contibutors listed above. Details on authorship of individual files
|
|
433
|
+
can be found in the git version control history of the project. The
|
|
434
|
+
omission of copyright and license comments in each file is in the
|
|
435
|
+
interest of source tree size.
|
|
436
|
+
|
|
437
|
+
In addition, permission is hereby granted for all public header files
|
|
438
|
+
(include/* and arch/*/bits/*) and crt files intended to be linked into
|
|
439
|
+
applications (crt/*, ldso/dlstart.c, and arch/*/crt_arch.h) to omit
|
|
440
|
+
the copyright notice and permission notice otherwise required by the
|
|
441
|
+
license, and to use these files without any requirement of
|
|
442
|
+
attribution. These files include substantial contributions from:
|
|
443
|
+
|
|
444
|
+
Bobby Bingham
|
|
445
|
+
John Spencer
|
|
446
|
+
Nicholas J. Kain
|
|
447
|
+
Rich Felker
|
|
448
|
+
Richard Pennington
|
|
449
|
+
Stefan Kristiansson
|
|
450
|
+
Szabolcs Nagy
|
|
451
|
+
|
|
452
|
+
all of whom have explicitly granted such permission.
|
|
453
|
+
|
|
454
|
+
This file previously contained text expressing a belief that most of
|
|
455
|
+
the files covered by the above exception were sufficiently trivial not
|
|
456
|
+
to be subject to copyright, resulting in confusion over whether it
|
|
457
|
+
negated the permissions granted in the license. In the spirit of
|
|
458
|
+
permissive licensing, and of not having licensing issues being an
|
|
459
|
+
obstacle to adoption, that text has been removed.
|
|
460
|
+
```
|
package/client/README.md
CHANGED
|
@@ -38,11 +38,10 @@ await signal.encryptMessage(bob, 'hello');
|
|
|
38
38
|
import { createHostedSignalProtocolClient } from '@open-e2ee/signal-protocol-sdk';
|
|
39
39
|
import { expoStore } from '@open-e2ee/signal-protocol-sdk/local/store/expo';
|
|
40
40
|
|
|
41
|
-
// Initialize the application-owned Expo/SQLCipher database bindings first.
|
|
42
41
|
const signal = await createHostedSignalProtocolClient({
|
|
43
42
|
adapters: {
|
|
44
43
|
// Expo storage owns this device's private keys and session state.
|
|
45
|
-
storage: expoStore(),
|
|
44
|
+
storage: await expoStore(),
|
|
46
45
|
},
|
|
47
46
|
hosted: {
|
|
48
47
|
// The environment-scoped connection URL from the OpenE2EE console.
|
package/device/README.md
CHANGED
|
@@ -23,22 +23,43 @@ The primary device uses ID `1`. The backend allocates linked device IDs from
|
|
|
23
23
|
|
|
24
24
|
## Platform requirements
|
|
25
25
|
|
|
26
|
-
The
|
|
27
|
-
|
|
28
|
-
|
|
26
|
+
The shared device entries import no platform package. They keep the device ID
|
|
27
|
+
and lifecycle state in the `SignalProtocolLocalSecretVault` that the
|
|
28
|
+
application passes, and they take platform metadata as an input. They omit each
|
|
29
|
+
metadata field that the application does not supply.
|
|
30
|
+
|
|
31
|
+
Two platform entries read that metadata:
|
|
32
|
+
|
|
33
|
+
- `@open-e2ee/signal-protocol-sdk/device/expo` reads `react-native`,
|
|
34
|
+
`expo-constants`, and `expo-device`.
|
|
35
|
+
- `@open-e2ee/signal-protocol-sdk/device/react-native` reads `react-native` and
|
|
36
|
+
`react-native-device-info`.
|
|
37
|
+
|
|
38
|
+
Install the optional peer dependencies of the platform entry you use. The
|
|
39
|
+
lifecycle core is available from:
|
|
29
40
|
|
|
30
41
|
<!-- doc-snippet:skip requires-external-context -->
|
|
31
42
|
```ts
|
|
32
|
-
import {
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
43
|
+
import { DeviceLifecycleManager } from "@open-e2ee/signal-protocol-sdk/device/lifecycle";
|
|
44
|
+
import { getDeviceLifecyclePlatform } from "@open-e2ee/signal-protocol-sdk/device/expo";
|
|
45
|
+
import { ExpoSecureStoreSignalProtocolSecretVault } from "@open-e2ee/signal-protocol-sdk/local/vault/expo-secure-store";
|
|
46
|
+
|
|
47
|
+
const manager = new DeviceLifecycleManager(userId, {
|
|
48
|
+
vault: new ExpoSecureStoreSignalProtocolSecretVault(),
|
|
49
|
+
convex,
|
|
50
|
+
api,
|
|
51
|
+
keyStorage,
|
|
52
|
+
logger,
|
|
53
|
+
...getDeviceLifecyclePlatform(),
|
|
54
|
+
});
|
|
36
55
|
```
|
|
37
56
|
|
|
38
|
-
`DeviceLifecycleManager`
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
57
|
+
`DeviceLifecycleManager` takes the user ID and a `DeviceLifecycleDeps` object.
|
|
58
|
+
That object holds the secret vault, the Convex client, the generated backend
|
|
59
|
+
references, key operations, logging, and device metadata. The constructor
|
|
60
|
+
throws an `EncryptionError` with code `SECRET_VAULT_REQUIRED` when the vault
|
|
61
|
+
is absent. The application remains responsible for authenticated backend
|
|
62
|
+
functions and for placing initialization in its own startup lifecycle.
|
|
42
63
|
|
|
43
64
|
## Device ID access
|
|
44
65
|
|
|
@@ -49,10 +70,14 @@ import {
|
|
|
49
70
|
preloadDeviceId,
|
|
50
71
|
} from "@open-e2ee/signal-protocol-sdk/device/device-id";
|
|
51
72
|
|
|
52
|
-
await preloadDeviceId();
|
|
53
|
-
const deviceId = await getDeviceId();
|
|
73
|
+
await preloadDeviceId(secretVault);
|
|
74
|
+
const deviceId = await getDeviceId(secretVault);
|
|
54
75
|
```
|
|
55
76
|
|
|
77
|
+
Both functions read the device ID from the application's
|
|
78
|
+
`SignalProtocolLocalSecretVault`. With no vault, they throw an
|
|
79
|
+
`EncryptionError` with code `SECRET_VAULT_REQUIRED`.
|
|
80
|
+
|
|
56
81
|
`getDeviceIdSync()` returns the cached value or the primary-device default. Use
|
|
57
82
|
it only after preload or in code that can safely tolerate that fallback.
|
|
58
83
|
|
|
@@ -89,8 +114,8 @@ await provisionDevice(
|
|
|
89
114
|
);
|
|
90
115
|
```
|
|
91
116
|
|
|
92
|
-
The new device parses the QR data, joins the session, and
|
|
93
|
-
provisioning
|
|
117
|
+
The new device parses the QR data, joins the session, and then receives,
|
|
118
|
+
decrypts, and stores the provisioning message:
|
|
94
119
|
|
|
95
120
|
<!-- doc-snippet:skip requires-external-context -->
|
|
96
121
|
```ts
|
|
@@ -99,8 +124,8 @@ import {
|
|
|
99
124
|
parseProvisioningQR,
|
|
100
125
|
receiveProvisioningMessage,
|
|
101
126
|
} from "@open-e2ee/signal-protocol-sdk/device/provisioning";
|
|
102
|
-
// Reads
|
|
103
|
-
//
|
|
127
|
+
// Reads the local platform, so it is imported separately from the protocol
|
|
128
|
+
// itself. Use `./device/react-native` off Expo, or build the fields by hand.
|
|
104
129
|
import { getDeviceMetadata } from "@open-e2ee/signal-protocol-sdk/device/expo";
|
|
105
130
|
|
|
106
131
|
const {
|
|
@@ -143,14 +168,20 @@ import {
|
|
|
143
168
|
prepareNewDeviceTransfer,
|
|
144
169
|
prepareOldDeviceTransferWithBackup,
|
|
145
170
|
} from "@open-e2ee/signal-protocol-sdk/device";
|
|
171
|
+
import { getTransferDeviceInfo } from "@open-e2ee/signal-protocol-sdk/device/expo";
|
|
172
|
+
|
|
173
|
+
const device = getTransferDeviceInfo();
|
|
146
174
|
|
|
147
|
-
const receiving = await prepareNewDeviceTransfer();
|
|
175
|
+
const receiving = await prepareNewDeviceTransfer(device);
|
|
148
176
|
await appQr.show(receiving.qrCode);
|
|
149
177
|
|
|
150
|
-
const sending = await prepareOldDeviceTransferWithBackup(backupStorage);
|
|
178
|
+
const sending = await prepareOldDeviceTransferWithBackup(backupStorage, device);
|
|
151
179
|
const backup = await sending.getBackup();
|
|
152
180
|
```
|
|
153
181
|
|
|
182
|
+
The QR code and the backup carry only the metadata fields that `device`
|
|
183
|
+
supplies. Pass `{}` to send none.
|
|
184
|
+
|
|
154
185
|
The application owns transport selection, peer confirmation, progress UI,
|
|
155
186
|
interruption recovery, and wiping old-device state after a successful
|
|
156
187
|
replacement. Do not erase the old device before the new device validates and
|