| deploy | ||
| docs | ||
| scripts | ||
| src | ||
| tests | ||
| .gitignore | ||
| Cargo.toml | ||
| echoircd.conf.bak-20260816-114429 | ||
| echoircd.conf.example | ||
| echoircd.conf.permchannels | ||
| README.md | ||
About
echoIRCd is a full IRC + IRCv3 server built from the ground up in safe Rust
(#![forbid(unsafe_code)]) with just two dependencies — openssl for TLS and
mio for the socket engine. A single lock-free core thread owns all state; a
pool of epoll reactor threads (one per core) drives the connections around it
— TLS crypto and all — without an async runtime. It ships 100+ commands, the
complete channel & user mode set,
28 IRCv3 capabilities, server-to-server linking, a services interface, TLS,
WebSocket, GeoIP, layered anti-spam, and a JSON-RPC control plane — with every
operational limit configurable and nothing hardcoded.
Features
- Full IRC core — registration, channels (
JOIN/PART/KICK/INVITE/KNOCK/CYCLE/REMOVE/TOPIC), messaging (PRIVMSG/NOTICE/TAGMSG, CTCP), and info (WHO/WHOIS/WHOWAS/LIST/STATS/MAP/LUSERS/MOTD). - Complete mode set — prefixes
qaohv(+ a network-staff!prefix), list modesbeIgXw, keyed/limit/flood/redirect/history/anticaps params, the full flag set, all the standard user modes, and matching + acting extbans (g y r j s G b,m c n). - IRCv3 — 28 capabilities including
message-tags+msgid,server-time,labeled-response,batch,echo-message,account-tag, CHATHISTORY, multiline, message-redaction, read-marker, relaymsg, andWATCH/MONITOR/SILENCE/callerid. - Operators —
OPER/KILL/WALLOPS/GLOBOPS, theSA*/CHG*/SET*override toolbox, x-lines (K/G/Z/E/SHUN/QLINE/CBAN) persisted to disk, staff prefix (operprefix/OJOIN), rank-gatedhidelist/hidemode, and a reload-safeREHASH. - Services & accounts — SASL PLAIN/EXTERNAL relayed over S2S, the
SVS*/ENCAP/METADATAinterface, account-gated modes, and optional ircd-side account registration. - Server-to-server linking —
UID/FJOINnetburst, cross-server users and channels, multi-hop routing, nick-collision handling and clean netsplit. - Security & anti-spam — TLS with cert fingerprints, keyed host cloaking, DNSBL, connection/message flood limits, mixed-script & gibberish detection, CAPTCHA / PONG-cookie / arithmetic gates, and DCC filtering.
- GeoIP — a native MaxMind
.mmdbreader with aG:<cc>geoban,GEOIPcommand, and WHOIS country line. - Transports & control — a native WebSocket layer (
ws:///wss://), a from-scratch forward-confirmed DNS resolver, and a token-authenticated JSON-RPC control plane over HTTP.
Quick start
git clone https://git.devtronic.pro/fedserv/echoIRCd
cd echoIRCd
cp echoircd.conf.example echoircd.conf # edit: oper pass, cloak_key, TLS paths
cargo run --release # reads ./echoircd.conf
Then point a client at it: /server 127.0.0.1 6667 (or 6697 for TLS once a
certificate is configured).
Documentation
The full manual lives in docs/:
- Building & running · Configuration · Architecture
- Channel & user modes · Operators · Server linking & services
- IRCv3 · Anti-abuse & flood protection · Deployment
Configuration
Configuration is a plain key = value file; see
echoircd.conf.example for the full, documented set of
keys. Your live echoircd.conf is gitignored — it holds secrets (oper password,
cloak key, link password), so never commit it. Generate a TLS certificate into
tls/ with the one-liner in the example config.
Architecture
A single core thread owns every User and Channel, so command and module
code is ordinary single-threaded logic over &mut Server — no Arc<Mutex<…>>
anywhere. The I/O edge feeds it events over channels:
- A pool of
mioepoll reactors drives client sockets — an acceptor round-robins each connection onto a worker (one per core by default), and each worker frames lines and runs TLS handshakes and record crypto non-blocking in-thread. So the socket work and the crypto spread across cores while the state core stays single-threaded and lock-free. (Proxied TLS and server links keep a thread each; there are few of them.) - Resilience is built in. Slow work (KDF hashing, DNS, disk snapshots) runs off the core so a flood can't freeze it; each event and each connection's I/O is panic-isolated so one bad client can't crash the server; a watchdog flags a stuck core; and half-open/stalled connections are reaped on a timer.
Why a raw reactor and not async? IRC is one large shared mutable graph, and
almost every command mutates it and then broadcasts. With one thread owning all of
it, handlers are plain synchronous code — no locks, no .await, no Send + 'static
bounds. A multi-threaded async runtime would force that shared state behind mutexes
or an actor mailbox, and a channel broadcast is serialized anyway, so you'd pay for
parallelism the workload can't use. mio is the same readiness layer async runtimes
build on, so you keep the scaling without the runtime. What does parallelize —
the socket syscalls and TLS crypto — runs in the reactor pool; scaling past one
machine is done by linking servers, not threading one harder.
Memory safety is structural: Uid handles instead of raw pointers, an Extensible
typemap instead of void* module data (freed on drop), and compiled-in trait
objects instead of a fragile plugin ABI. Full design notes:
docs/architecture.md.
Extending
Three small extension points, each one file + one table line — full reference and
a tutorial in docs/api/:
- Commands (
src/command.rs,src/coremods/) — a handler withname,min_params,before_reg,handle(&mut Server, uid, params). - Modes (
src/mode.rs) — channel/user modes asChanMode/UserModehandler objects; adding one never touches the parser. - Modules (
src/module.rs,src/modules/) — lifecycle hooks; pre-hooks can Deny a register/command/message, notify-hooks fire after.
Links
- Repository — https://git.devtronic.pro/fedserv/echoIRCd
- Issues — https://git.devtronic.pro/fedserv/echoIRCd/issues
- Documentation —
docs/ - Config reference —
echoircd.conf.example
License
echoIRCd is released under the MIT License. It is original Rust —
no code is copied or translated from any other project, enforced on every edit by
scripts/native-rust-guard.sh (no unsafe, no C/FFI, dependencies limited to
openssl + mio).