Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wiresock/ndisapi-rs
Rust crate for interacting with the Windows Packet Filter driver.
https://github.com/wiresock/ndisapi-rs
filter packet rust windows
Last synced: about 1 month ago
JSON representation
Rust crate for interacting with the Windows Packet Filter driver.
- Host: GitHub
- URL: https://github.com/wiresock/ndisapi-rs
- Owner: wiresock
- License: apache-2.0
- Created: 2023-05-27T12:36:58.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-24T21:50:51.000Z (9 months ago)
- Last Synced: 2024-11-06T09:20:32.605Z (about 2 months ago)
- Topics: filter, packet, rust, windows
- Language: Rust
- Homepage: https://www.ntkernel.com/windows-packet-filter/
- Size: 165 KB
- Stars: 33
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NDISAPI
[](https://crates.io/crates/ndisapi)
[](https://docs.rs/ndisapi)
[](https://github.com/wiresock/ndisapi/blob/main/LICENSE)
NDISAPI is a Rust crate for interacting with the [Windows Packet Filter](https://www.ntkernel.com/windows-packet-filter/) driver. It provides an easy-to-use, safe, and efficient interface to efficiently filter (inspect and modify) raw network packets at the NDIS level of the network stack with minimal impact on network activity.
Windows Packet Filter (WinpkFilter) is a high-performance, lightweight packet filtering framework for Windows, enabling developers to efficiently inspect, modify, and control raw network packets at the NDIS level. With user-friendly APIs and support for various Windows versions, WinpkFilter simplifies network packet manipulation without requiring kernel-mode programming expertise.
## Features
- Enumerate network adapters
- Query and set network adapter properties
- Capture and analyze packets
- Filter and modify packets
- Send raw packets
## Dependencies
- Rust 1.58.0 or later
- Windows 7, 8, 10, or 11
- [Windows Packet Filter](https://github.com/wiresock/ndisapi/releases) driver installed
## Installation
Add the following to your `Cargo.toml` file:
```toml
[dependencies]
ndisapi = "0.6.0"
```
## Usage
Here's an example of how to enumerate network adapters and print their information:
```rust
use ndisapi::{MacAddress, Ndisapi};
fn main() {
let ndis = Ndisapi::new("NDISRD").expect("Failed to create NdisApi instance");
let adapters = ndis
.get_tcpip_bound_adapters_info()
.expect("Failed to enumerate adapters");
for adapter in adapters {
println!("Adapter: {:?}", adapter.get_name());
println!(
"Description: {:?}",
Ndisapi::get_friendly_adapter_name(adapter.get_name()).unwrap_or("Unknown".to_string())
);
println!(
"MAC Address: {:?}",
MacAddress::from_slice(adapter.get_hw_address()).unwrap_or_default()
);
println!("-------------------------------");
}
}
```
For more examples and in-depth usage, check out the [documentation](https://docs.rs/ndisapi).
## Demo
Here is an example of how to run the `listadapters` example:
```bash
S D:\github.com\ndisapi-rs> cargo run --example listadapters
Finished dev [unoptimized + debuginfo] target(s) in 0.12s
Running `target\debug\examples\listadapters.exe`
Detected Windows Packet Filter version 3.4.8
1. Local Area Connection* 10
\DEVICE\{EDEE8C42-F604-4A7B-BFAA-6B110923217E}
Medium: 0
MAC: 9A:47:3D:60:26:9D
MTU: 1500
FilterFlags: FilterFlags(0x0)
Getting OID_GEN_CURRENT_PACKET_FILTER Error: Data error (cyclic redundancy check).
OID_802_3_CURRENT_ADDRESS: 9A:47:3D:60:26:9D
2. vEthernet (Default Switch)
\DEVICE\{BD64DB34-23DF-45C4-909E-780272A98BAE}
Medium: 0
MAC: 00:15:5D:01:8C:00
MTU: 1500
FilterFlags: FilterFlags(0x0)
OID_GEN_CURRENT_PACKET_FILTER: 0x0000000B
OID_802_3_CURRENT_ADDRESS: 00:15:5D:01:8C:00
...
11. vEthernet (WLAN Virtual Switch)
\DEVICE\{05F9267C-C548-4822-8535-9A57F1A99DB7}
Medium: 0
MAC: 18:47:3D:60:26:9D
MTU: 1500
FilterFlags: FilterFlags(0x0)
OID_GEN_CURRENT_PACKET_FILTER: 0x0000000B
OID_802_3_CURRENT_ADDRESS: 18:47:3D:60:26:9D
System wide MTU decrement: 0
System wide network adapter startup filter mode: 0
Driver intermediate buffer pool size multiplier: 0
Effective intermediate buffer pool size: 2048
```
Following is the demonstration of the async-packthru example. For this scenario, we will assume that `vEthernet (WLAN Virtual Switch)` is the default internet connection
```bash
PS D:\github.com\ndisapi-rs> cargo run --example async-packthru -- --interface-index 11
Finished dev [unoptimized + debuginfo] target(s) in 0.11s
Running `target\debug\examples\async-packthru.exe --interface-index 11`
Detected Windows Packet Filter version 3.4.8
Using interface \DEVICE\{05F9267C-C548-4822-8535-9A57F1A99DB7}
Press ENTER to exit
```
## License
This project is licensed under the Apache License 2.0. See [LICENSE](https://github.com/wiresock/ndisapi/blob/main/LICENSE) for details.