@open-e2ee/signal-protocol-sdk 8.1.0 → 8.2.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/CHANGELOG.md +153 -0
- package/README.md +2 -2
- package/SECURITY.md +2 -2
- package/device/README.md +16 -7
- package/dist/client/client.d.ts +4 -2
- package/dist/client/client.d.ts.map +1 -1
- package/dist/client/client.js +23 -18
- package/dist/client/client.js.map +1 -1
- package/dist/client/group-outbox.d.ts +31 -1
- package/dist/client/group-outbox.d.ts.map +1 -1
- package/dist/client/group-outbox.js +67 -58
- package/dist/client/group-outbox.js.map +1 -1
- package/dist/client/hosted-anonymous-delivery.d.ts +9 -1
- package/dist/client/hosted-anonymous-delivery.d.ts.map +1 -1
- package/dist/client/hosted-anonymous-delivery.js +61 -22
- package/dist/client/hosted-anonymous-delivery.js.map +1 -1
- package/dist/client/hosted-transport.d.ts +7 -0
- package/dist/client/hosted-transport.d.ts.map +1 -1
- package/dist/client/hosted-transport.js +44 -6
- package/dist/client/hosted-transport.js.map +1 -1
- package/dist/client/key-rotation.d.ts.map +1 -1
- package/dist/client/key-rotation.js +2 -4
- package/dist/client/key-rotation.js.map +1 -1
- package/dist/client/prekeys.d.ts.map +1 -1
- package/dist/client/prekeys.js +1 -1
- package/dist/client/prekeys.js.map +1 -1
- package/dist/client/relay-device-refusal.d.ts +32 -0
- package/dist/client/relay-device-refusal.d.ts.map +1 -0
- package/dist/client/relay-device-refusal.js +36 -0
- package/dist/client/relay-device-refusal.js.map +1 -0
- package/dist/client/relay-work.d.ts +26 -0
- package/dist/client/relay-work.d.ts.map +1 -1
- package/dist/client/relay-work.js +37 -0
- package/dist/client/relay-work.js.map +1 -1
- package/dist/client/sealed-sender.d.ts.map +1 -1
- package/dist/client/sealed-sender.js +12 -17
- package/dist/client/sealed-sender.js.map +1 -1
- package/dist/client/sessions.d.ts.map +1 -1
- package/dist/client/sessions.js +2 -4
- package/dist/client/sessions.js.map +1 -1
- package/dist/client/signal-service-cipher.d.ts +90 -4
- package/dist/client/signal-service-cipher.d.ts.map +1 -1
- package/dist/client/signal-service-cipher.js +425 -136
- package/dist/client/signal-service-cipher.js.map +1 -1
- package/dist/client/types.d.ts +7 -0
- package/dist/client/types.d.ts.map +1 -1
- package/dist/client/types.js.map +1 -1
- package/dist/internal/manager/manager.d.ts +8 -7
- package/dist/internal/manager/manager.d.ts.map +1 -1
- package/dist/internal/manager/manager.js +34 -36
- package/dist/internal/manager/manager.js.map +1 -1
- package/dist/internal/protocol/spqr/index.d.ts +1 -1
- package/dist/internal/protocol/spqr/index.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/index.js +2 -2
- package/dist/internal/protocol/spqr/index.js.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/rs/codec.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/rs/codec.js +1 -3
- package/dist/internal/protocol/spqr/ml-kem-braid/rs/codec.js.map +1 -1
- package/dist/internal/protocol/spqr/serialize.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/serialize.js +1 -4
- package/dist/internal/protocol/spqr/serialize.js.map +1 -1
- package/dist/internal/protocol/spqr/spqr.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/spqr.js +1 -2
- package/dist/internal/protocol/spqr/spqr.js.map +1 -1
- package/dist/internal/sesame/device-registry.d.ts +24 -4
- package/dist/internal/sesame/device-registry.d.ts.map +1 -1
- package/dist/internal/sesame/device-registry.js +55 -28
- package/dist/internal/sesame/device-registry.js.map +1 -1
- package/dist/internal/sesame/manager.d.ts +79 -11
- package/dist/internal/sesame/manager.d.ts.map +1 -1
- package/dist/internal/sesame/manager.js +381 -280
- package/dist/internal/sesame/manager.js.map +1 -1
- package/dist/internal/session/cipher.d.ts +0 -5
- package/dist/internal/session/cipher.d.ts.map +1 -1
- package/dist/internal/session/cipher.js +3 -9
- package/dist/internal/session/cipher.js.map +1 -1
- package/dist/internal/session/record-locks.d.ts +46 -0
- package/dist/internal/session/record-locks.d.ts.map +1 -0
- package/dist/internal/session/record-locks.js +72 -0
- package/dist/internal/session/record-locks.js.map +1 -0
- package/dist/local/store/expo/adapter.d.ts +8 -2
- package/dist/local/store/expo/adapter.d.ts.map +1 -1
- package/dist/local/store/expo/adapter.js +24 -3
- package/dist/local/store/expo/adapter.js.map +1 -1
- package/dist/local/store/expo/driver.d.ts +7 -0
- package/dist/local/store/expo/driver.d.ts.map +1 -1
- package/dist/local/store/expo/driver.js +16 -0
- package/dist/local/store/expo/driver.js.map +1 -1
- package/dist/local/store/key-value/adapter.d.ts.map +1 -1
- package/dist/local/store/key-value/adapter.js +61 -38
- package/dist/local/store/key-value/adapter.js.map +1 -1
- package/dist/local/store/memory/adapter.d.ts +10 -0
- package/dist/local/store/memory/adapter.d.ts.map +1 -1
- package/dist/local/store/memory/adapter.js +79 -55
- package/dist/local/store/memory/adapter.js.map +1 -1
- package/dist/local/store/reliability.d.ts +16 -0
- package/dist/local/store/reliability.d.ts.map +1 -1
- package/dist/local/store/reliability.js +58 -28
- package/dist/local/store/reliability.js.map +1 -1
- package/dist/local/store/sqlite/store.d.ts.map +1 -1
- package/dist/local/store/sqlite/store.js +36 -14
- package/dist/local/store/sqlite/store.js.map +1 -1
- package/dist/local/store/web/adapter.d.ts.map +1 -1
- package/dist/local/store/web/adapter.js +63 -53
- package/dist/local/store/web/adapter.js.map +1 -1
- package/dist/local/vault/electron-safe-storage.d.ts.map +1 -1
- package/dist/local/vault/electron-safe-storage.js +15 -2
- package/dist/local/vault/electron-safe-storage.js.map +1 -1
- package/dist/profile/index.d.ts +2 -1
- package/dist/profile/index.d.ts.map +1 -1
- package/dist/profile/index.js +2 -1
- package/dist/profile/index.js.map +1 -1
- package/dist/profile/own-profile-key.d.ts +42 -0
- package/dist/profile/own-profile-key.d.ts.map +1 -0
- package/dist/profile/own-profile-key.js +64 -0
- package/dist/profile/own-profile-key.js.map +1 -0
- package/dist/profile/profile-key.d.ts +1 -34
- package/dist/profile/profile-key.d.ts.map +1 -1
- package/dist/profile/profile-key.js +3 -63
- package/dist/profile/profile-key.js.map +1 -1
- package/dist/profile/update-service.js +1 -1
- package/dist/profile/update-service.js.map +1 -1
- package/dist/remote/relay/memory/adapter.d.ts.map +1 -1
- package/dist/remote/relay/memory/adapter.js +3 -4
- package/dist/remote/relay/memory/adapter.js.map +1 -1
- package/dist/username/link.d.ts.map +1 -1
- package/dist/username/link.js +1 -5
- package/dist/username/link.js.map +1 -1
- package/dist/utils/bounded-fan-out.d.ts +99 -0
- package/dist/utils/bounded-fan-out.d.ts.map +1 -0
- package/dist/utils/bounded-fan-out.js +180 -0
- package/dist/utils/bounded-fan-out.js.map +1 -0
- package/dist/utils/keyed-lock.d.ts +16 -0
- package/dist/utils/keyed-lock.d.ts.map +1 -0
- package/dist/utils/keyed-lock.js +39 -0
- package/dist/utils/keyed-lock.js.map +1 -0
- package/docs/ASSURANCE.md +62 -19
- package/docs/DEVIATIONS.md +21 -2
- package/examples/browser/index.html +1 -1
- package/hooks/README.md +11 -2
- package/local/store/expo/README.md +18 -5
- package/local/store/key-value/README.md +5 -3
- package/local/store/node/README.md +2 -1
- package/local/store/web-sqlite/README.md +28 -8
- package/local/vault/README.md +21 -2
- package/package.json +1 -1
- package/remote/object-store/convex-r2/README.md +10 -0
package/local/vault/README.md
CHANGED
|
@@ -108,6 +108,24 @@ The protection is that of the OS key store
|
|
|
108
108
|
refuses that key: on Linux, it accepts only a ciphertext that starts with
|
|
109
109
|
`v11`, the prefix of a key from a secret service.
|
|
110
110
|
|
|
111
|
+
On Linux, the vault gives these results for the backends of
|
|
112
|
+
`getSelectedStorageBackend()`:
|
|
113
|
+
|
|
114
|
+
| Backend | Secret store | Result |
|
|
115
|
+
|---|---|---|
|
|
116
|
+
| `gnome_libsecret` | GNOME Keyring | The vault works. |
|
|
117
|
+
| `kwallet5` | KWallet 5, and KWallet 6 through its `kwalletd5` name | The vault works. |
|
|
118
|
+
| `kwallet6` | KWallet 6 | The vault works. |
|
|
119
|
+
| `basic_text` | None | The vault refuses the backend. |
|
|
120
|
+
| `gnome_libsecret`, `kwallet5`, or `kwallet6` with no secret service | None: the fixed fallback key, `v10` | The vault refuses the key. |
|
|
121
|
+
| `gnome_libsecret`, `kwallet5`, or `kwallet6`, with the Chromium feature `SecretPortalKeyProviderUseForEncryption` and a Secret portal | The key of the Secret portal, `v12` | The vault refuses the key. |
|
|
122
|
+
|
|
123
|
+
The Secret portal of xdg-desktop-portal gives a key to each app. Outside a
|
|
124
|
+
Flatpak or Snap sandbox, Electron asks for the key as the Chromium app. Each
|
|
125
|
+
Electron app of the user then gets the same key. Electron uses the portal key
|
|
126
|
+
only with the `SecretPortalKeyProviderUseForEncryption` feature, which is off
|
|
127
|
+
by default. Without that feature, a running portal does not change the key.
|
|
128
|
+
|
|
111
129
|
The vault fails with an `EncryptionError` that has the code
|
|
112
130
|
`KEY_STORAGE_ERROR`:
|
|
113
131
|
|
|
@@ -116,8 +134,9 @@ The vault fails with an `EncryptionError` that has the code
|
|
|
116
134
|
- on Linux, when the backend is `basic_text`, which encrypts with a fixed
|
|
117
135
|
password, or `unknown`;
|
|
118
136
|
- on Linux, when a ciphertext does not start with `v11`, for example when no
|
|
119
|
-
secret service answered and `safeStorage` used its fixed key
|
|
120
|
-
file does not
|
|
137
|
+
secret service answered and `safeStorage` used its fixed key, or when
|
|
138
|
+
`safeStorage` used the key of the Secret portal. The vault file does not
|
|
139
|
+
change;
|
|
121
140
|
- when `safeStorage` cannot encrypt or decrypt, for example when the OS key
|
|
122
141
|
is gone or the macOS signature of the app is not valid. The Electron error
|
|
123
142
|
is the `originalError`. It can say that `safeStorage` is temporarily
|
package/package.json
CHANGED
|
@@ -11,6 +11,16 @@ operates inside the application backend. This adapter maps that generated API
|
|
|
11
11
|
to `SignalProtocolRemoteObjectStore` without moving storage policy, provider keys, or
|
|
12
12
|
component ownership into the SDK.
|
|
13
13
|
|
|
14
|
+
## Setup
|
|
15
|
+
|
|
16
|
+
Install the peer `convex` 1.42.1 or later. The server helper loads it to
|
|
17
|
+
define its functions. The client adapter loads no peer. The application
|
|
18
|
+
installs and mounts the `@convex-dev/r2` component in its own backend.
|
|
19
|
+
|
|
20
|
+
```sh
|
|
21
|
+
npm install convex
|
|
22
|
+
```
|
|
23
|
+
|
|
14
24
|
## Client usage
|
|
15
25
|
|
|
16
26
|
<!-- doc-snippet:skip requires-external-context -->
|