How guy5116/burrow works
Burrow is a peer-to-peer, end-to-end encrypted chat application. A user initializes a protected identity, creates or uses a one-time invite (or connects to a saved contact), establishes a secure peer session, then exchanges text and optionally transfers pictures or files. The CLI/TUI and desktop GUI are separate front ends to the core engine. The graph also shows storage, transport, protocol, and media-processing layers. Some subsystem links rely on SOURCE INDEX references or README statements; unsampled implementation details are not inferred.
Main entry points: engine.go Core engine · session.go Encrypted sessions · transfer.go File transfers · store.go Encrypted store
Components 20
User interfaces
- CLI commands
cmd/burrow/cmds.go - CLI runtime
cmd/burrow/run.go - Terminal UI
internal/ui/tui/tui.go - UI commands
internal/ui/common/commands.go - Desktop UI
internal/ui/gui/main.go - GUI application
internal/ui/gui/app.go
Chat engine
- Core engine
internal/core/engine.go - Peer messaging
internal/core/peer.go - File transfers
internal/core/transfer.go
Identity and protocol
- Identity keys
internal/identity/identity.go - Invites
internal/invite/invite.go - Secure handshake
internal/handshake/handshake.go - Encrypted sessions
internal/session/session.go - Wire protocol
internal/wire/payloads.go
Networking
- Transport selection
internal/core/transports.go - TCP transport
internal/transport/tcp/tcp.go - Tor transport
internal/transport/tor/tor.go
Persistence and media
- Encrypted store
internal/store/store.go - Image handling
internal/media/strip.go
Other components
- Chat user
Connections 28
- Chat user → CLI commands: runs commands
README.md - CLI commands → CLI runtime: starts chat
- CLI runtime → Terminal UI: opens terminal UI
cmd/burrow/run.go - Terminal UI → UI commands: uses commands
internal/ui/tui/tui.go - UI commands → Core engine: calls chat API
internal/ui/common/commands.go - Chat user → Desktop UI: uses desktop app
README.md - Desktop UI → GUI application: starts application
- GUI application → Core engine: starts engine
internal/ui/gui/app.go - CLI commands → Encrypted store: loads store
cmd/burrow/cmds.go - GUI application → Encrypted store: opens store
internal/ui/gui/app.go - Core engine → Encrypted store: persists state
internal/core/engine.go - Core engine → Invites: uses invites
internal/core/engine.go - Core engine → Identity keys: uses identity
internal/core/engine.go - Core engine → Secure handshake: runs handshake
internal/core/engine.go - Core engine → Encrypted sessions: creates sessions
internal/core/engine.go - Core engine → Transport selection: selects transports
internal/core/engine.go - Core engine → Peer messaging: routes peer events
internal/core/engine.go - Peer messaging → Encrypted sessions: uses session
internal/core/peer.go - Core engine → File transfers: handles transfers
internal/core/transfer.go - File transfers → Encrypted sessions: sends streams
internal/core/transfer.go - File transfers → Encrypted store: stores received files
internal/core/transfer.go - File transfers → Image handling: checks image data
internal/core/transfer.go - Secure handshake → Wire protocol: encodes handshake
internal/handshake/handshake.go - Secure handshake → Identity keys: uses keys
internal/handshake/handshake.go - Encrypted sessions → Wire protocol: frames messages
internal/session/session.go - Encrypted sessions → Identity keys: uses peer keys
internal/session/session.go - Transport selection → TCP transport: uses TCP
- Transport selection → Tor transport: supports Tor