Siavash Sameni
|
2dbbc61dfe
|
Comprehensive documentation: architecture, usage, integration, progress, security
docs/ARCHITECTURE.md (531 lines):
System design, ASCII diagrams, crypto stack, dual-curve identity,
wire protocol (7 WireMessage variants), server/client architecture,
data flow diagrams, storage model, extensibility points
docs/USAGE.md (550 lines):
Complete user guide: installation, all CLI commands (10),
all TUI commands (20+), all web commands, file transfer,
identity management, aliases, groups, multi-device, backup,
keyboard shortcuts
docs/INTEGRATION.md (542 lines):
WarzonePhone concept, Ethereum/Web3, OIDC, DNS federation,
transport abstraction, multi-server mode, custom clients,
ntfy, how-to guides for extending message types/commands/storage
docs/PROGRESS.md (234 lines):
Timeline, Phase 1 (16 features), Phase 2 (16 features),
v0.0.20, 28 tests, bugs fixed, known limitations, Phase 3-7 roadmap
docs/SECURITY.md (438 lines):
Threat model, 8 crypto primitives, key derivation paths,
forward secrecy, Sender Keys trade-offs, seed security,
server trust, WASM security, known weaknesses,
comparison with Signal/Matrix/SimpleX
Total: 3,751 lines across 8 doc files.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
2026-03-28 05:25:46 +04:00 |
|
Siavash Sameni
|
60a7006ed9
|
Add documentation: protocol spec, server admin, client guide
docs/PROTOCOL.md (520 lines):
- Identity model (seed → Ed25519 + X25519 via HKDF)
- X3DH key exchange (4 DH operations, ASCII flow diagram)
- Double Ratchet (chain/DH ratchet, skipped keys, state machine)
- KDF chains with domain separation strings
- AEAD (ChaCha20-Poly1305)
- Wire format (WireMessage enum, bincode serialization)
- Pre-key bundle format and lifecycle
docs/SERVER.md (429 lines):
- Build and run instructions
- Full API reference with request/response examples
- Database structure (sled trees)
- Deployment (nginx reverse proxy, systemd unit)
- Security considerations
- Backup and recovery
docs/CLIENT.md (507 lines):
- Quick start guide
- All CLI commands with examples
- Identity management and mnemonic backup
- Web client usage and limitations
- Session and pre-key management
- Threat model table
- Troubleshooting guide
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
2026-03-26 21:59:19 +04:00 |
|