31 releases

0.9.0 Sep 12, 2021
0.8.1 Dec 30, 2020
0.7.0 Aug 4, 2017
0.6.1 Jun 19, 2017
0.1.0 Mar 26, 2015

#128 in Network programming

Download history 3101/week @ 2021-07-07 2650/week @ 2021-07-14 2188/week @ 2021-07-21 2719/week @ 2021-07-28 2437/week @ 2021-08-04 2592/week @ 2021-08-11 2522/week @ 2021-08-18 2193/week @ 2021-08-25 1751/week @ 2021-09-01 2266/week @ 2021-09-08 2722/week @ 2021-09-15 1962/week @ 2021-09-22 2436/week @ 2021-09-29 3356/week @ 2021-10-06 3732/week @ 2021-10-13 2474/week @ 2021-10-20

10,814 downloads per month
Used in 28 crates (26 directly)

MIT/Apache

68KB
1.5K SLoC

pcap Build status Crates.io Docs.rs

Documentation

This is a Rust language crate for accessing the packet sniffing capabilities of pcap (or wpcap on Windows). If you need anything feel free to post an issue or submit a pull request!

Features:

  • List devices
  • Open capture handle on a device or savefiles
  • Get packets from the capture handle
  • Filter packets using BPF programs
  • List/set/get datalink link types
  • Configure some parameters like promiscuity and buffer length
  • Write packets to savefiles
  • Inject packets into an interface

See examples for usage.

Building

As of 0.8.0 this crate uses Rust 2018 and requires a compiler version >= 1.40.0.

As of 0.9.0 the capture-stream feature requires a compiler version >= 1.45.0.

Windows

Install WinPcap.

Download the WinPcap Developer's Pack. Add the /Lib or /Lib/x64 folder to your LIB environment variable.

Linux

On Debian based Linux, install libpcap-dev. If not running as root, you need to set capabilities like so: sudo setcap cap_net_raw,cap_net_admin=eip path/to/bin

Mac OS X

libpcap should be installed on Mac OS X by default.

Note: A timeout of zero may cause pcap::Capture::next to hang and never return (because it waits for the timeout to expire before returning). This can be fixed by using a non-zero timeout (as the libpcap manual recommends) and calling pcap::Capture::next in a loop.

Library Location

If LIBPCAP_LIBDIR environment variable is set when building the crate, it will be added to the linker search path - this allows linking against a specific libpcap.

Library Version

The crate will automatically try to detect the installed libpcap/wpcap version by loading it during the build and calling pcap_lib_version. If for some reason this is not suitable, you can specify the desired library version by setting the environment variable LIBPCAP_VER to the desired version (e.g. env LIBPCAP_VER=1.5.0). The version number is used to determine which library calls to include in the compilation.

Optional Features

capture-stream

Use the capture-stream feature to enable support for streamed packet captures. This feature is supported only on ubuntu and macosx.

[dependencies]
pcap = { version = "0.9", features = ["capture-stream"] }

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~0–1.1MB
~21K SLoC