lockbitchat
3212138a0d
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.
3.5 KiB
3.5 KiB
API Notes
EnhancedSecureWebRTCManager
Verification
confirmVerification(userCode)validates a manually entered SAS code.- Verification succeeds only after both local and remote confirmations are present.
isVerifiedis assigned in one place (_setVerifiedStatus), which refuses any SAS-based transition without a recorded local confirmation.- Control frames listed in
POST_VERIFICATION_CONTROL_TYPES(reconnection signalling, call setup, message deletion, delivery receipts) are only acted on after verification. The set is an allowlist; unrecognised frame types are rejected by the chat channel's default-deny branch. - Protocol version
4.1is enforced during offer/answer processing.
Forward secrecy
isRatchetActive()reports whether the Double Ratchet is running on this connection. It is negotiated: both peers advertiseRATCHET_VERSIONin the offer and answer, and a peer that does not falls back to per-session keys._ratchet.canEncryptis false on the joining peer until the inviting peer's first message arrives, because the sending chain does not exist until then. Callers must check it rather than assume; the send path falls back to session keys for those first frames._ratchet.getState()returns counters and the number of retained keys for diagnostics. It exposes no key material.- Ratcheted chat arrives as
MESSAGE_TYPES.RATCHET_MESSAGEwithh(the header string, used verbatim as AES-GCM additional data) andc(base64 body). The header must be passed back todecrypt()exactly as received; re-serialising it can change a byte and fail authentication.
Privacy mode
- relay-only configuration sets WebRTC
iceTransportPolicyto"relay". - TURN availability is checked before claiming IP protection.
File transfer callbacks
setFileTransferCallbacks(onProgress, onReceived, onError, onIncomingRequest)updates manager fields and any liveEnhancedSecureFileTransferinstance.- Passing
nullvalues detaches callbacks from the active transfer system.
Voice messages
sendFile(file, options)accepts an optionaloptionsobject.options.voice({ dur, bars }) marks the transfer as a voice note and rides along as unsigned metadata;options.uiIdcorrelates progress events to a UI bubble before thefileIdresolves.onProgressreceives{ fileId, uiId, direction, progress, isVoice, voice }.onIncomingFileRequestandonReceivedincludeisVoiceandvoiceso the UI can auto-accept and render a voice bubble instead of a file card.- The
isVoicea callback receives is the receiver's verdict, not the sender's claim:validateIncomingMetadataclears it unless the transfer declares a recognised audio MIME type and fits the per-note and per-session size budgets. A transfer that fails those checks is not rejected; it simply loses the consent-free shortcut and is offered as a normal file.
EnhancedSecureFileTransfer
Incoming transfers
- metadata is validated before prompting
- acceptance is explicit
- receive buffers are allocated only after consent
- file type acceptance is allowlist-based
Cleanup
- pending sender consent promises are rejected on cleanup
- consent timeouts are cleared immediately
- retained received buffers are bounded
- evicted download handles fail with a user-facing availability message
SecurePersistentKeyStorage
- metadata is encrypted before storage
- legacy plaintext records migrate lazily
- corrupted encrypted metadata is ignored safely