@open-e2ee/signal-protocol-sdk 0.1.0-alpha.1 → 0.1.0-alpha.2
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 +35 -0
- package/README.md +7 -15
- package/dist/client/client.d.ts +8 -5
- package/dist/client/client.d.ts.map +1 -1
- package/dist/client/client.js +8 -5
- package/dist/client/client.js.map +1 -1
- package/dist/client/prekeys.js +1 -1
- package/dist/client/prekeys.js.map +1 -1
- package/dist/internal/sesame/manager.d.ts.map +1 -1
- package/dist/internal/sesame/manager.js +45 -16
- package/dist/internal/sesame/manager.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/local/store/expo/adapter.d.ts +5 -1
- package/dist/local/store/expo/adapter.d.ts.map +1 -1
- package/dist/local/store/expo/adapter.js +9 -4
- package/dist/local/store/expo/adapter.js.map +1 -1
- package/dist/local/store/mock/adapter.d.ts.map +1 -1
- package/dist/local/store/mock/adapter.js +17 -7
- package/dist/local/store/mock/adapter.js.map +1 -1
- package/dist/types/api.d.ts +11 -7
- package/dist/types/api.d.ts.map +1 -1
- package/docs/ERROR_HANDLING.md +8 -1
- package/docs/api/classes/SignalProtocolClient.md +8 -5
- package/docs/api/interfaces/IEcSignedPreKeyStore.md +3 -2
- package/docs/api/interfaces/IKyberLastResortPreKeyStore.md +2 -1
- package/docs/api/interfaces/ISignalProtocolClient.md +4 -2
- package/docs/api/interfaces/ISignalProtocolManager.md +2 -2
- package/docs/api/namespaces/keys/README.md +4 -0
- package/docs/api/namespaces/keys/functions/canonicalizeDeviceIdentityKey.md +30 -0
- package/docs/api/namespaces/keys/functions/compareDeviceIdentityKeys.md +28 -0
- package/docs/api/namespaces/keys/functions/isValidDeviceIdentityKey.md +22 -0
- package/docs/api/namespaces/keys/variables/UNPINNED_DEVICE_IDENTITY_KEY.md +18 -0
- package/package.json +1 -1
|
@@ -38,11 +38,14 @@ const signedPreKey = await keys.generateEcSignedPreKey(signingKey);
|
|
|
38
38
|
- [PREKEY\_ALGORITHM\_ML\_KEM\_1024](variables/PREKEY_ALGORITHM_ML_KEM_1024.md)
|
|
39
39
|
- [PREKEY\_ALGORITHM\_X25519](variables/PREKEY_ALGORITHM_X25519.md)
|
|
40
40
|
- [PREKEY\_SIGNATURE\_V1\_DOMAIN](variables/PREKEY_SIGNATURE_V1_DOMAIN.md)
|
|
41
|
+
- [UNPINNED\_DEVICE\_IDENTITY\_KEY](variables/UNPINNED_DEVICE_IDENTITY_KEY.md)
|
|
41
42
|
|
|
42
43
|
## Functions
|
|
43
44
|
|
|
44
45
|
- [acceptContactIdentityRotation](functions/acceptContactIdentityRotation.md)
|
|
45
46
|
- [assertIdentityCommitment](functions/assertIdentityCommitment.md)
|
|
47
|
+
- [canonicalizeDeviceIdentityKey](functions/canonicalizeDeviceIdentityKey.md)
|
|
48
|
+
- [compareDeviceIdentityKeys](functions/compareDeviceIdentityKeys.md)
|
|
46
49
|
- [compositeIdentitiesEqual](functions/compositeIdentitiesEqual.md)
|
|
47
50
|
- [createCompositeIdentityV1](functions/createCompositeIdentityV1.md)
|
|
48
51
|
- [createPreKeySignatureContext](functions/createPreKeySignatureContext.md)
|
|
@@ -58,6 +61,7 @@ const signedPreKey = await keys.generateEcSignedPreKey(signingKey);
|
|
|
58
61
|
- [generateKemOneTimePreKeys](functions/generateKemOneTimePreKeys.md)
|
|
59
62
|
- [generateKyberLastResortPreKey](functions/generateKyberLastResortPreKey.md)
|
|
60
63
|
- [generateRegistrationId](functions/generateRegistrationId.md)
|
|
64
|
+
- [isValidDeviceIdentityKey](functions/isValidDeviceIdentityKey.md)
|
|
61
65
|
- [signMlKem1024PreKey](functions/signMlKem1024PreKey.md)
|
|
62
66
|
- [signPreKey](functions/signPreKey.md)
|
|
63
67
|
- [validateContactIdentityRecord](functions/validateContactIdentityRecord.md)
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
[**@open-e2ee/signal-protocol-sdk**](../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@open-e2ee/signal-protocol-sdk](../../../README.md) / [keys](../README.md) / canonicalizeDeviceIdentityKey
|
|
6
|
+
|
|
7
|
+
# Function: canonicalizeDeviceIdentityKey()
|
|
8
|
+
|
|
9
|
+
> **canonicalizeDeviceIdentityKey**(`bytes`, `label`): `Uint8Array`
|
|
10
|
+
|
|
11
|
+
Reduce `DeviceRecord.identityKey` bytes to their canonical form, rejecting
|
|
12
|
+
any other encoding at the storage boundary.
|
|
13
|
+
|
|
14
|
+
Every producer of device identity bytes goes through here so that a single
|
|
15
|
+
encoding reaches storage and comparison. Without it, two producers using two
|
|
16
|
+
encodings of the same key compare unequal and forge an identity-change event.
|
|
17
|
+
|
|
18
|
+
## Parameters
|
|
19
|
+
|
|
20
|
+
### bytes
|
|
21
|
+
|
|
22
|
+
`Uint8Array`
|
|
23
|
+
|
|
24
|
+
### label
|
|
25
|
+
|
|
26
|
+
`string`
|
|
27
|
+
|
|
28
|
+
## Returns
|
|
29
|
+
|
|
30
|
+
`Uint8Array`
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
[**@open-e2ee/signal-protocol-sdk**](../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@open-e2ee/signal-protocol-sdk](../../../README.md) / [keys](../README.md) / compareDeviceIdentityKeys
|
|
6
|
+
|
|
7
|
+
# Function: compareDeviceIdentityKeys()
|
|
8
|
+
|
|
9
|
+
> **compareDeviceIdentityKeys**(`pinned`, `incoming`): `"unpinned"` \| `"same"` \| `"changed"`
|
|
10
|
+
|
|
11
|
+
Compare two `DeviceRecord.identityKey` values.
|
|
12
|
+
|
|
13
|
+
Returns `'unpinned'` when no identity has been observed for the device yet,
|
|
14
|
+
which is first contact (a TOFU pin) and not a change.
|
|
15
|
+
|
|
16
|
+
## Parameters
|
|
17
|
+
|
|
18
|
+
### pinned
|
|
19
|
+
|
|
20
|
+
`Uint8Array`
|
|
21
|
+
|
|
22
|
+
### incoming
|
|
23
|
+
|
|
24
|
+
`Uint8Array`
|
|
25
|
+
|
|
26
|
+
## Returns
|
|
27
|
+
|
|
28
|
+
`"unpinned"` \| `"same"` \| `"changed"`
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
[**@open-e2ee/signal-protocol-sdk**](../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@open-e2ee/signal-protocol-sdk](../../../README.md) / [keys](../README.md) / isValidDeviceIdentityKey
|
|
6
|
+
|
|
7
|
+
# Function: isValidDeviceIdentityKey()
|
|
8
|
+
|
|
9
|
+
> **isValidDeviceIdentityKey**(`bytes`): `boolean`
|
|
10
|
+
|
|
11
|
+
Whether `bytes` is a well-formed `DeviceRecord.identityKey`: either unpinned
|
|
12
|
+
or exactly one canonical composite tuple.
|
|
13
|
+
|
|
14
|
+
## Parameters
|
|
15
|
+
|
|
16
|
+
### bytes
|
|
17
|
+
|
|
18
|
+
`Uint8Array`
|
|
19
|
+
|
|
20
|
+
## Returns
|
|
21
|
+
|
|
22
|
+
`boolean`
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
[**@open-e2ee/signal-protocol-sdk**](../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@open-e2ee/signal-protocol-sdk](../../../README.md) / [keys](../README.md) / UNPINNED\_DEVICE\_IDENTITY\_KEY
|
|
6
|
+
|
|
7
|
+
# Variable: UNPINNED\_DEVICE\_IDENTITY\_KEY
|
|
8
|
+
|
|
9
|
+
> `const` **UNPINNED\_DEVICE\_IDENTITY\_KEY**: `Uint8Array`
|
|
10
|
+
|
|
11
|
+
SESAME `DeviceRecord.identityKey` bytes for a device whose composite identity
|
|
12
|
+
has not been observed yet.
|
|
13
|
+
|
|
14
|
+
Zero length is the only representation of "not pinned". It must stay distinct
|
|
15
|
+
from a pinned tuple so that first contact performs a TOFU pin rather than
|
|
16
|
+
reporting an identity change, and it must never be a partial key: pinning
|
|
17
|
+
only the X25519 half would silently accept a peer that kept its DH key and
|
|
18
|
+
swapped its Ed25519 signing key.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@open-e2ee/signal-protocol-sdk",
|
|
3
|
-
"version": "0.1.0-alpha.
|
|
3
|
+
"version": "0.1.0-alpha.2",
|
|
4
4
|
"description": "Signal Protocol E2EE SDK for TypeScript — Expo, React Native, browser, and Node. Post-quantum PQXDH and Double Ratchet.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"open-e2ee",
|