rscap - Rust packet capture and transmission utilities
rscap is a multi-purpose library for low-level network packet capture and transmission. Its aims are twofold:
- To provide Rust-native platform APIs for packet capture and transmission (comparable to
libpcap, but written from the ground up in Rust) - To expose a robust and ergonomic API for building packets and accessing/modifying packet data fields in various network protocols (like
scapy, but with strong typing and significantly improved performance thanks to zero-allocation abstractions)
The rscap submodule focuses specifically on (1)--it provides safe, Rust-native APIs for capturing packets over network interfaces.
The sibling pkts crate handles building/dissecting specific protocols and packet types (2).
rscap provides both platform-specific and unified cross-platform APIs for capturing and
transmitting arbitrary packets. It currently supports the following features for each platform:
| Platform | Sniffing (RX) | Spoofing (TX) | Packet Filtering (BPF) | Memory-Mapped I/O |
|---|---|---|---|---|
| Linux | ✅ | ✅ | ✅ | ✅ |
| MacOS | ✅ | ✅ | ✅ | N/A |
| Windows (Npcap) | ✅ | ✅ | ⬜ | N/A |
| Windows (native) | ⬜ | N/A | ⬜ | ? |
| FreeBSD | ✅ | ✅ | ⬜ | ✅* |
| OpenBSD | ⬜ | ⬜ | ⬜ | N/A |
| NetBSD | ⬜ | ⬜ | ⬜ | N/A |
| DragonFly BSD | ⬜ | ⬜ | ⬜ | N/A |
| Solaris | ⬜ | ⬜ | ⬜ | ? |
| IllumOS | ⬜ | ⬜ | ⬜ | ? |
| AIX | ⬜ | ⬜ | ⬜ | ? |
* - FreeBSD supports only memory-mapped sniffing (RX)
Note that rscap is under active development--*BSD system support (with CI testing) will be implemented in the near future, whereas native Windows APIs and Solaris/IllumOS/AIX support are respectively in mid- and long-term plans.
In Progress:
- Compiling/assembling methods for more advanced filter programs (BPF)
- *BSD Continuous Integration (CI) testing
- Additional platform-specific configuration options
- Native Windows 10/11 capture support via reverse-engineered ioctl calls from
pktmon(RX only) - Solaris/IllumOS support via DLPI/
PF_SOCKET//dev/bpf(RX + TX) - AIX support
All Sniffer/Socket types implement synchronous blocking/nonblocking send() and recv() APIs.
In addition to this, rscap provides first-class support for the following async
runtimes via the AsyncSniffer type:
async Runtime |
Supported? |
|---|---|
async-std |
✅ |
smol |
✅ |
mio |
✅* |
tokio |
✅ |
* - on all platforms except for Windows
Like other crates managed by pkts.org, rscap aims to rely on a minimal set of dependencies
that are vetted and well-used in the Rust ecosystem. As such, rscap has only the following
dependencies:
libc,windows-sys- Exposes base types and functions needed for underlying system library calls.bitflags- Provides a simple, clean interface for accessing and modifying bitfields in packets. Used extensively in the rust ecosystem (e.g. byrustix,openssl,bindgen, etc.); includes no transitive dependencies.once_cell- Used in Windows implementation ofSniffer. Will be replaced with the standard library once certainOnceCellAPIs are stabilized; includes no transitive dependencies.pkts-common- Shared data types/methods betweenrscapandpkts; includes no transitive dependencies.
The following optional dependencies will be included once various async runtime features are implemented:
async-std- Included for async compatibility with theasync-stdruntimemio- Included for async compatibility with themioruntimesmol- Included for async compatibility with thesmolruntimetokio- Included for async compatibility with thetokioruntimeasync-io- Additional dependency for theasync-stdandsmolruntimes
We do not plan on adding in any additional dependencies to rscap. The one exception to this
rule is that some common structs (e.g. MacAddr, Interface) may be split out into a separate
crate in a future release.
This project is licensed under either of
at your option.
rscap is open to contribution--feel free to submit an issue or pull request if there's
something you'd like to add to this library.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in
rscap by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without
any additional terms or conditions.