No protocol or message-protection changes. The version in the application header was a literal and had fallen behind, showing v5.6.0 while running 5.7.1. It now comes from package.json, and a test fails if a hard-coded one reappears or if meta.json, the README badge, the changelog and the docs disagree about the release. Documentation reorganised so that everything technical lives in doc/ with an index, and the root keeps only what belongs there by convention: README, SECURITY, CHANGELOG and LICENSE. - SECURITY.md rewritten. It listed a supported release line three major versions out of date and made claims the software does not make. It now states what is guaranteed, what is not, and how to report a problem. - SECURITY_DISCLAIMER.md and RESPONSIBLE_USE.md merged into doc/USE-POLICY.md, which says what the software cannot protect against rather than listing generic advice. - doc/SECURITY-ARCHITECTURE.md renamed to doc/ARCHITECTURE.md and rewritten around the session lifecycle, what verification gates, and how recovery works. - doc/CRYPTOGRAPHY.md rewritten: key schedule, the Double Ratchet, framing, and memory handling, with values taken from the source rather than restated. - doc/CONFIGURATION.md rewritten with the real file-type policy, ICE and TURN guidance, and the deployment caching rules that matter. - docs/webrtc-config.md moved to doc/CALLS.md and rewritten; the obsolete docs/webrtc-audit.md, a working document full of stale line numbers, removed along with the docs/ directory. - doc/CONTRIBUTING.md records what the recent regressions taught us about writing tests that can actually fail. - doc/README.md added as an index. Internal security review notes are excluded from the repository via .gitignore. Those describe attack paths against specific releases in enough detail to reproduce them, which is useful privately and harmful in public while users are still updating.
176 lines
8.0 KiB
Markdown
176 lines
8.0 KiB
Markdown
# Architecture
|
|
|
|
SecureBit.chat is a browser application with no backend. Two browsers negotiate a
|
|
direct WebRTC connection, derive keys from an ECDH exchange, and confirm each
|
|
other's identity by comparing a short code out of band. Everything after that
|
|
runs between the two endpoints.
|
|
|
|
There is no server in the message path, and there is no signalling service. The
|
|
offer and the answer are moved between the two people by whatever channel they
|
|
already have (a QR code, a pasted block of text, a link). That choice shapes the
|
|
rest of the design: the out-of-band channel is untrusted, so the protocol assumes
|
|
an attacker can read and rewrite anything travelling over it, and the safety code
|
|
comparison is what closes that gap.
|
|
|
|
## Session lifecycle
|
|
|
|
```text
|
|
1. Invitation Peer A generates an ECDH key pair, an SDP offer and a session
|
|
salt, and exports them as a single invitation.
|
|
|
|
2. Response Peer B validates the invitation, derives the shared secret,
|
|
and returns its own keys and SDP as a response.
|
|
|
|
3. Transport up DTLS completes and the data channel opens. At this point both
|
|
sides hold session keys, but neither knows who the other is.
|
|
|
|
4. Verification Both sides display the same safety code. The users compare it
|
|
over a channel an attacker cannot impersonate and enter it.
|
|
|
|
5. Verified Only now does the session accept traffic that changes state,
|
|
and only now does the chat open.
|
|
```
|
|
|
|
Step 3 is the one worth dwelling on. Completing the handshake proves that someone
|
|
performed a key exchange. It does not prove who. Anyone positioned on the
|
|
out-of-band channel can substitute their own keys and complete step 3 with both
|
|
people at once. Step 4 is the only step that distinguishes the intended peer, so
|
|
everything that could be useful to an impostor waits for it.
|
|
|
|
## What verification gates
|
|
|
|
Verification is enforced, not merely displayed. Until both sides confirm:
|
|
|
|
- reconnection signalling is refused
|
|
- call setup is refused
|
|
- message deletion and delivery receipts are refused
|
|
- incoming file transfers are refused
|
|
|
|
The verification exchange itself and liveness probes run earlier, because they
|
|
have to. That set is an allowlist in the code
|
|
(`POST_VERIFICATION_CONTROL_TYPES`), and anything not on it is rejected by
|
|
default rather than passed through.
|
|
|
|
The verified state is set in one place, which refuses the transition unless the
|
|
local user has actually confirmed the code. Three incorrect entries end the
|
|
session.
|
|
|
|
## Message protection layers
|
|
|
|
```text
|
|
ECDH P-384 exchange
|
|
|
|
|
HKDF key schedule
|
|
|
|
|
.........................................................
|
|
| | | | |
|
|
message MAC metadata fingerprint ratchet root
|
|
key key key (safety code) |
|
|
Double Ratchet
|
|
per-message keys
|
|
```
|
|
|
|
Chat content is encrypted with a ratchet-derived key when both peers support the
|
|
ratchet, and with the session message key otherwise. Either way it reaches the
|
|
interface through a single authenticated path. Frames that fail authentication
|
|
are dropped rather than displayed, so nothing appears in a conversation that has
|
|
not been verified as coming from the peer holding the session keys.
|
|
|
|
## Forward secrecy
|
|
|
|
Per-message keys come from a chain key through a one-way function and are
|
|
destroyed after a single use, so a key held now cannot reconstruct an earlier
|
|
one. Each change of direction in the conversation introduces a fresh ECDH key
|
|
pair, which re-keys the session root and moves it away from any state an attacker
|
|
may have captured.
|
|
|
|
Out-of-order delivery is supported within fixed bounds: 512 skipped keys per
|
|
chain, 1024 retained in total, expiring after five minutes. These are a resource
|
|
control rather than a tuning parameter, because the message number is supplied by
|
|
the peer.
|
|
|
|
Incoming frames are authenticated before any ratchet state is committed. A frame
|
|
that fails leaves the ratchet untouched, so a malformed or forged frame cannot
|
|
desynchronise an established session.
|
|
|
|
[CRYPTOGRAPHY.md](CRYPTOGRAPHY.md) has the key schedule and the frame format.
|
|
|
|
## Session recovery
|
|
|
|
A network path can break without anything closing: switching from Wi-Fi to a
|
|
mobile network, a NAT rebind, a tunnel. The data channel keeps reporting itself
|
|
as open while packets stop arriving.
|
|
|
|
Recovery renegotiates only the transport path, using an ICE restart carried over
|
|
the existing encrypted channel. The DTLS session, the session keys, the ratchet
|
|
state and the message history all sit above ICE and survive it, so a repaired
|
|
connection is the same session and needs no new verification.
|
|
|
|
Silence alone is not treated as a dead peer. A backgrounded tab is frozen by the
|
|
browser and answers nothing, while ICE consent checks continue in the browser's
|
|
network stack. A connected ICE state therefore means a silent peer is asleep, not
|
|
gone. Only an unanswered probe on a degraded path starts recovery.
|
|
|
|
Recovery gives up when it cannot succeed: when nothing has arrived from the peer
|
|
since the break (no route exists for the renegotiation), or when the ICE agent
|
|
produces no candidate pairs at all (restarting cannot rebind it). A session that
|
|
cannot be recovered is closed and its data wiped rather than left half alive.
|
|
|
|
## File transfer
|
|
|
|
1. The sender emits metadata.
|
|
2. The receiver validates name, size, type and abuse limits.
|
|
3. The receiver is shown an Accept or Reject prompt.
|
|
4. No receive buffers are allocated before acceptance.
|
|
5. Chunks are transmitted only after acceptance.
|
|
6. Completed buffers are retained within a bounded window.
|
|
|
|
Voice notes reuse this pipeline and inherit its per-file AES-GCM session key,
|
|
chunking and SHA-256 integrity check. They differ in three ways: the audio is
|
|
recorded in the browser, the duration and waveform travel as unsigned
|
|
presentation metadata (the audio bytes stay covered by the signed hash), and the
|
|
receiver accepts them without a prompt so they can play inline.
|
|
|
|
That last point is why the receiver decides what counts as a voice note. The
|
|
sender's claim is not enough: a transfer qualifies only if it declares a
|
|
recognised audio MIME type, stays under 4 MB, and fits a per-session budget of
|
|
64 MB. Anything else is handled as an ordinary file and goes through the normal
|
|
prompt. This keeps the convenience of voice notes from becoming a channel for
|
|
unattended transfers.
|
|
|
|
## Disconnect
|
|
|
|
The disconnect path clears:
|
|
|
|
- WebRTC channels and peer connection handles
|
|
- timers, deferred retries, cover traffic and decoy traffic
|
|
- pending transfer state and consent waits
|
|
- verification state and session key material
|
|
- ratchet state: the root key, both chain keys and every retained message key are
|
|
overwritten rather than only dereferenced
|
|
- React file transfer callbacks and stale interface state
|
|
|
|
Values that cannot be overwritten in JavaScript are documented as such rather
|
|
than reported as cleared. See the memory handling section of
|
|
[CRYPTOGRAPHY.md](CRYPTOGRAPHY.md).
|
|
|
|
## Multiple conversations
|
|
|
|
Each conversation gets its own manager instance, peer connection, key material
|
|
and verification state, held in a map keyed by session. Nothing is shared between
|
|
them, so two conversations cannot mix, and closing one leaves the others
|
|
connected.
|
|
|
|
## Code layout
|
|
|
|
| Path | Responsibility |
|
|
| --- | --- |
|
|
| `src/network/EnhancedSecureWebRTCManager.js` | Connection lifecycle, verification, session state, message routing |
|
|
| `src/network/webrtc/` | Call stack: SDP handling, audio and video senders, network adaptation |
|
|
| `src/crypto/DoubleRatchet.js` | Forward secrecy: root and chain keys, DH ratchet, skipped keys |
|
|
| `src/crypto/EnhancedSecureCryptoUtils.js` | Key generation, key schedule, message encryption, sanitization |
|
|
| `src/crypto/cose-qr.js` | Invitation packing for QR transport |
|
|
| `src/transfer/EnhancedSecureFileTransfer.js` | Chunked encrypted transfers, consent, type policy |
|
|
| `src/state/sessionsStore.js` | Reducer for the set of open conversations |
|
|
| `src/app.jsx` | Interface and message rendering |
|