pkts - ergonomic, no-std-compatible packet construction and manipulation
pkts is a multi-purpose library for network packet capture/transmission and packet building. Its aims are twofold:
- To provide Rust-native platform tools 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)
pkts specifically accomplishes (2), while the sibling rscap library handles (1).
- Platform-independent interface for packet capture/transmission:
rscapprovides a single unified interface for capturing and transmitting packets across any supported platform. Additionally, the library exposes safe abstractions of platform-specific packet capture tools (such asAF_PACKET/PACKET_MMAPsockets in Linux) to support cases where fine-grained control or platform-specific features are desired. no-stdCompatible: every packet type in thepktscrate can be used without the standard library, and a specialLayerReftype can be used to access raw packet bytes without requiringalloc.- Robust APIs for building/modifying packets:
pktsprovides simple operations to combine various layers into a single packet, and to index into a different layers of a packet to retrieve or modify fields. Users ofscapymay find the API surprisingly familiar, especially for layer composition and indexing operations:
use layers::{ip::Ipv4, tcp::Tcp};
let pkt = Ip::new() / Tcp::new();
pkt[Tcp].set_sport(80);
pkt[Tcp].set_dport(12345);- Packet defragmentation/reordering: In some protocols, packets may be fragmented (such as IPv4) or arrive out-of-order (TCP, SCTP, etc.).
pktsovercomes both of these issues throughSequencetypes that transparently handle defragmentation and reordering.Sequencetypes can even be stacked so that application-layer data can easily be reassembled from captured packets. They even work inno-stdenvironments with or withoutalloc. - Stateful packet support: Many network protocols are stateful, and interpreting packets from such protocols can be difficult (if not impossible) to accomplish unless information about the protocol session is stored. Rscap provides
Sessiontypes that handle these kinds of packets--Sessions ensure that packets are validated based on the current expected state of the protocol. Just likeSequence,Sessiontypes are compatible withno-stdenvironments and do not requirealloc.
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.