iodine-rs is a progressive rewrite of the original iodine DNS tunneling software in Rust, aiming to be compatible with the iodine project as of commit 517d729. This software allows IPv4 data tunneling through DNS servers, useful in scenarios where internet access is firewalled, but DNS queries are allowed.
The project is actively being ported from C to safe, idiomatic, and secure Rust using the tokio async runtime. Current implemented capabilities include:
- Unified CLI: Execution mode dispatch for both client (
iodine) and server (iodined) logic. - Async TUN Integration: Cross-platform, asynchronous packet reading/writing to OS-level TUN devices.
- DNS Protocol Parsing: Custom, zero-copy parsing and serialization of DNS headers, questions, and resource records.
- Protocol Encodings: Full Rust implementations of the iodine protocol's custom Base32, Base64, and Base128 encodings, alongside domain-name packing utilities.
- Cryptography: Integrated MD5 challenge/response authentication logic.
- Server State Management: Virtual IP pooling, user authentication, downstream packet queues, and an LRU-based DNS cache.
- Incremental Rewriting: The C codebase is progressively rewritten in Rust, ensuring that the project compiles at every step.
- Intended Compatibility: Maintains compatibility with the iodine protocol and aims to offer the same functionality in a more secure and modern language.
- Safety and Performance: Leverages Rust's memory safety guarantees and high-performance asynchronous networking, moving away from raw stack buffers and manual pointer arithmetic.
- Maintain Compatibility: Ensure
iodine-rsmaintains compatibility with legacy iodine clients and servers. - Progressive Migration: Modules will be progressively rewritten in Rust from the original C codebase, ensuring continuous compilation.
- Enhanced Safety: Introduce Rust's memory safety and concurrency features to reduce vulnerabilities present in C.
Feel free to contribute to the project by opening issues, submitting pull requests, or offering feedback. Please refer to AGENTS.md and REWRITE_PLAN.md for architectural guidelines, strict linting rules, and the current migration roadmap.
For any questions or suggestions, reach out to the maintainer at iodine-rs@oss.joefang.org.