@open-e2ee/signal-protocol-sdk 0.1.0-alpha.3 → 0.1.0-alpha.4

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.
@@ -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 Signal's implementation, which means
76
+ braid sessions do not interoperate with Signal'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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@open-e2ee/signal-protocol-sdk",
3
- "version": "0.1.0-alpha.3",
3
+ "version": "0.1.0-alpha.4",
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",
@@ -290,6 +290,7 @@
290
290
  "dist",
291
291
  "docs/ASSURANCE.md",
292
292
  "docs/CLIENT_COMPOSITION.md",
293
+ "docs/DEVIATIONS.md",
293
294
  "docs/DOCUMENTATION_STANDARDS.md",
294
295
  "docs/E2EE.md",
295
296
  "docs/ERROR_HANDLING.md",