Files
securebit-chat/doc
lockbitchat 6e82cfcae2 feat(descriptor): SBQ2 connection descriptor format; release v5.8.0
The SB1 invitation runs 2000-2400 characters and needs QR version 38-40, past
the point where a single code is scannable, so the app falls back to an
animated multi-frame QR. SBQ2 is a fixed binary layout carrying only what
brings up DTLS -- ICE credentials, certificate fingerprint, candidates -- with
the SDP rebuilt from a template by a strict serializer. Measured on real Chrome
and Firefox SDP across four network profiles: 98-149 bytes, QR version 6-8.

Key material is meant to move to the DataChannel, bound by a commitment in the
descriptor. That half does not exist yet, so nothing calls this module: the
format is landed for review and freeze, not wired into the connection path.
doc/DESCRIPTOR-SBQ2.md records the gate on phase 3.

The decoder is a parser of hostile input: fixed offsets, explicit lengths,
deny-by-default on reserved values and unknown TLV extension types, trailing
bytes rejected, ICE credentials alphabet-checked so a CRLF cannot reach the
serializer. No compression -- DEFLATE adds bytes on this payload, and dropping
it removes the decompression-bomb surface with it.

Candidate pruning keeps coverage before count: one candidate per (family, type,
transport) survives before any surplus, so an IPv6-only or UDP-blocked path
cannot be pruned away by a v4-first sort.

Tests cover round-trip against captured Chrome and Firefox SDP, IPv6 and NAT64
addresses, ICE-TCP candidates, the TLV area, clock skew, one-shot binding and
SAS transcript coverage.
2026-08-06 11:54:05 -04:00
..

Documentation

Technical documentation for SecureBit.chat. Start with the project README if you are looking for an overview or a quick start.

Document What it covers
ARCHITECTURE.md How a session is established, verified and torn down, and where each guarantee comes from
CRYPTOGRAPHY.md Key schedule, the Double Ratchet, SAS verification, memory handling
CONFIGURATION.md Deployment, ICE and TURN setup, privacy modes, file transfer policy
CALLS.md Voice and video: codec choices, adaptation, and why each value was picked
API.md Internal interfaces of the WebRTC manager and file transfer system
CONTRIBUTING.md Development workflow and what needs extra review
USE-POLICY.md Terms of use, intended use, and the limits of what the software can protect

Security policy and vulnerability reporting live in SECURITY.md at the repository root, where GitHub expects to find them.

Keeping this accurate

These documents describe the current release and are expected to change with it. Every value quoted here (limits, timeouts, algorithm parameters) is taken from the source rather than restated from memory, so if you change one in code, change it here in the same commit. CONTRIBUTING.md lists which documents are affected by which areas of the code.