SharpPcap学习总结

发表于 2024/03/16

作者 John Wei 16 分钟阅读

前言

SharpPcap是.NET环境中跨平台的抓包框架，对WinPcap和LibPcap进行了统一的封装，使用C#语言

本人的毕设需要使用WinPcap进行抓包解析，还需要做一个UI界面，正好.NET有这样一个库，同时还有WPF这样的UI框架，之前参与过Android项目，WPF的xaml布局写法和Android很类似，上手WPF难度应该不算很高，综合考虑下选择使用C#完成毕设（~~根本原因是C++用不顺手~~~）

理想是丰满的，现实是骨感的，当我兴致勃勃准备查找文档开始干的时候，发现怎么网上搜出来的例子跑不通。找到GitHub仓库，在Tutorial找到一篇文档，但是还是有例子跑不通，猜测是版本的问题，结果发现在releases中写“Please see nuget for releases”，这个nuget又是啥，咋还跑到那里去发布，后来了解到nuget是.NET的包管理平台，类似Java的Maven。一路搜索过去，倒是找到了SharpPcap的Nuget地址，但是还是找不到最新的文档，此时我的内心是崩溃的

没办法，只能硬着头皮看Tutorial的文档和反编译的源码慢慢调试了，在此记录一下SharpPcap新版本的API使用，SharpPcap版本为6.3.0

SharpPcap的GitHub仓库：dotpcap/sharppcap

PacketDotNet的GitHub仓库：dotpcap/packetnet

NuGet地址：NuGet Gallery SharpPcap 6.3.0

SharpPcap安装

SharpPcap已经发布在NuGet上，所以我们可以直接通过Visual Studio的NuGet管理器获取安装，这里使用Visual Studio 2022版本

安装SharpPcap

打开项目的NuGet管理器，点击浏览，在搜索框搜索SharpPcap，点击安装即可
查看依赖项

安装完成后，我们可以看到项目中的依赖项已经有了SharpPcap的依赖，其中也包含一个叫PacketDotNet的库，SharpPcap主要负责数据包的捕获，而PacketDotNet就是负责数据包的解析

在代码中使用SharpPcap

在代码中引入SharpPcap命名空间和PacketDotNet命名空间即可，打印版本检查是否可以正常使用

  


using System;
using SharpPcap;
using PacketDotNet;
     
namespace backend {
    public class Backend {
        public static void Main(string[] args) {
            // Tutorial中获取版本为string ver = SharpPcap.Version.VersionString;
            var version = Pcap.Version;
            var sharpPcapVersion = Pcap.SharpPcapVersion;
            Console.WriteLine(version);
            Console.WriteLine($"SharpPcapVersion = {sharpPcapVersion}");
        }
    }
}

可以打印出Npcap版本和SharpPcap版本，接下来就可以愉快的使用了

获取接口列表

在SharpPcap中获取接口列表非常简单，只需要一行代码

  
var list = CaptureDeviceList.Instance;

// 打印接口信息
foreach (var device in list) {
    Console.WriteLine(device);
}

获取到的CaptureDeviceList继承了ReadOnlyCollection<ILiveDevice>，是一个ILiveDevice类型的只读集合，由此可见获取到的设备实例是ILiveDevice类型的

ILiveDevice继承了ICaptureDevice和IInjectionDevice两个接口，这两个接口都继承了IPcapDevice接口，这两个接口中主要包含了各自功能模块的方法接口

  


// ILiveDevice
public interface ILiveDevice : ICaptureDevice , IInjectionDevice {
}

// IInjectionDevice
public interface IInjectionDevice : IPcapDevice {
    // 发送数据包
    void SendPacket(ReadOnlySpan<byte> p, ICaptureHeader header = null);
}

// ICaptureDevice
public interface ICaptureDevice : IPcapDevice {

    // 数据包捕获回调
    event PacketArrivalEventHandler OnPacketArrival;

    // 停止捕获回调
    event CaptureStoppedEventHandler OnCaptureStopped;

    // 是否开始捕获
    bool Started { get; }

    // 捕获超时时间
    TimeSpan StopCaptureTimeout { get; set; }

    // 开始异步捕获
    void StartCapture();

    // 停止捕获
    void StopCapture();

    // 开始同步捕获
    void Capture();

    // 捕获一个数据包
    GetPacketStatus GetNextPacket(out PacketCapture e);

    // 捕获统计信息
    ICaptureStatistics Statistics { get; }
}

IPcapDevice中包含了接口设备相关的信息

  


public interface IPcapDevice : IDisposable {
    
    // 设备名
    string Name { get; }

    // 设备描述
    string Description { get; }

    // 最后一次发生的错误信息
    string LastError { get; }

    // 过滤表达式
    string Filter { get; set; }

    // 设备MAC地址
    System.Net.NetworkInformation.PhysicalAddress MacAddress { get; }

    // 打开设备
    void Open(DeviceConfiguration configuration);

    // 关闭设备
    void Close();

    // 设备的链路层类型
    PacketDotNet.LinkLayers LinkType { get; }
}

打开接口并捕获

从上面的接口方法中，可以看到相关的打开、捕获等方法，基本使用如下

  


var devices = CaptureDeviceList.Instance;
// 获取第一个接口
var dev = devices[0];
// 设置捕获回调
device.OnPacketArrival += new PacketArrivalEventHandler(OnPacketArrival);
dev.Open();  // 打开接口
dev.StartCapture();  // 开始异步捕获
Console.ReadLine();  // 阻塞主进程
dev.StopCapture();  // 停止捕获
dev.Close();  // 关闭接口

// 回调捕获函数，捕获的包类型为PacketCapture
public static void OnPacketArrival(object sender, PacketCapture p) {
    var data = p.Data;  // 数据包数据，字节数组
    var date = p.Timeval.Date;  // 时间戳
    // ......
}

实际上这里使用的Open()是一个扩展方法，IPcapDevice接口中的Open()接收一个DeviceConfiguration类型的参数，表示启动配置，而在CaptureDeviceExtensions.cs文件中，对Open()和IInjectionDevice接口的SendPacket()做了扩展

DeviceConfiguration中有两个常用的属性

DeviceModes Mode：接口工作模式
- None：默认模式
- Promiscuous：混杂模式
int ReadTimeout：捕获超时时间

开启接口混杂模式和设置超时时间，可以调用CaptureDeviceExtensions.cs文件中的扩展

  
device.Open(mode: DeviceModes.Promiscuous, read_timeout: 1000);

捕获数据包

与WinPcap一样，SharpPcap也有回调捕获和非回调捕获两种方式，在SharpPcap新版本中，将两种方式返回的数据包类型统一为了PacketCapture类型

回调捕获

在ICaptureDevice接口中有两个委托属性，可以定义回调函数

PacketArrivalEventHandler OnPacketArrival

数据包捕获回调，函数类型为void OnPacketArrival(object sender, PacketCapture e)
CaptureStoppedEventHandler OnCaptureStopped

停止捕获回调，函数类型为void OnCaptureStop(object sender, CaptureStoppedEventStatus status)

在调用Open()之前，设置接口的OnPacketArrival属性即可设置捕获回调

  
device.OnPacketArrival += new PacketArrivalEventHandler(OnPacketArrival);

非回调捕获

使用ICaptureDevice接口中的GetNextPacket()获取一个数据包，该函数接收一个PacketCapture类型的输出参数，PacketCapture是数据包类型，返回值是GetPacketStatus枚举类型，表示捕获数据包的状态

  


public enum GetPacketStatus {
    // 超时
    ReadTimeout = 0,
	// 捕获到数据包
    PacketRead = 1,
	// 捕获错误
    Error = -1,
	// 捕获中止
    NoRemainingPackets = -2,
};

在While循环中持续获取数据包，不需要调用StartCapture()

  
var device = devices[index];
device.Open(mode: DeviceModes.Promiscuous, read_timeout: 1000);

while (device.GetNextPacket(out PacketCapture packet) == GetPacketStatus.PacketRead) {
    Console.WriteLine(packet.GetPacket().GetPacket());
}

device.Close();

过滤数据包

在SharpPcap中设置过滤数据包非常简单，只需要设置IPcapDevice接口中的Filter属性为过滤表达式即可

  
device.Filter = "ip6 and icmp6";  // 过滤ICMPv6包

数据包解析

数据包主要使用到PacketDotNet库，PacketDotNet中将几乎所有类型的数据包都封装了实体类，而它们都继承了Packet这个抽象父类，其中也包含一些用于解析的方法，主要用到下面两个方法

Packet.ParsePacket()：将PacketCapture解析为Packet对象，
Extract<T>()：从Packet对象中提取指定数据包类型，返回相应的数据包对象

基本使用如下

  


private static void OnPacketArrival(object s, PacketCapture packetCapture) {
    var packet = Packet.ParsePacket(
        packetCapture.Device.LinkType, 
        packetCapture.Data.ToArray()
    );
    // 也可通过以下方式获取
    // var packet = packetCaptrue.GetPacket().GetPacket();
    
    // 解析出来的首先是链路层对象，ParsePacket方法返回Packet父类引用，强转为子类
    var ethernet = packet as EthernetPacket ?? throw new NullReferenceException();
    var udp = ethernet.Extract<UdpPacket>();
    if (udp != null) {
        Console.WriteLine(udp);
    }
}

数据包解析的部分工作原理详见：SharpPcap数据包解析原理

堆文件处理

堆文件处理使用到LibPcap模块的功能，LibPcap中接口的父类为PcapDevice类，该类实现了ICaptureDevice接口

写入堆文件

写入文件主要使用CaptureFileWriterDevice类，它继承了PcapDevice类，主要使用以下方法

CaptureFileWriterDevice()：唯一构造器

传入写入文件名和打开模式，默认为打开并创建
Open()：打开接口

传入DeviceConfiguration，主要参数是链路层类型LinkLayers，要与捕获接口的链路层类型一致

在CaptureDeviceExtensions.cs中包含两个Open扩展函数
- void Open(this CaptureFileWriterDevice device, ICaptureDevice captureDevice)
- void Open(this CaptureFileWriterDevice device, LinkLayers linkLayerType = LinkLayers.Ethernet)
Write()：写入文件，有两个重载
- void Write(ReadOnlySpan<byte> p, ref PcapHeader h)
- void Write(ReadOnlySpan<byte> p)
- void Write(RawCapture p)

基本使用如下，注意在Windows中，文件的相对路径是相对于.exe可执行文件的路径

  


// 默认模式为打开并创建
CaptureFileWriterDevice writer = new("capture.pcap");
// 打开捕获接口
device.Open(mode: DeviceModes.Promiscuous, read_timeout: 1000);
// 打开写入接口
writer.Open(device);

device.OnPacketArrival += new(OnPacketArrival);
device.StartCapture();
Console.ReadLine();
device.StopCapture();
writer.Close();
device.Close();

private static void OnPacketArrival(object s, PacketCapture packetCapture) {
    // 当文件模式不是追加时，在回调中打开写入接口，每次打开会清空文件
    writer.Write(packetCapture.GetPacket());
}

读取堆文件

读取文件主要使用CaptureFileReaderDevice类，它继承了PcapDevice类，主要使用以下方法

CaptureFileReaderDevice()：唯一构造器，传入读取的文件名
Open()：打开接口
StartCapture()：开始读取文件

基本使用如下

  


CaptureFileReaderDevice reader = new("capture.pcap");
reader.Open();
// 设置读取到数据包的回调
reader.OnPacketArrival += new(OnPacketArrival);
// 开始读取
reader.StartCapture();
Console.ReadLine();
reader.StopCapture();
reader.Close();

private static void OnPacketArrival(object s, PacketCapture packetCapture) {
    Console.WriteLine(packetCapture.GetPacket().GetPacket().PrintHex());
}

发送数据包

发送单个数据包

使用IInjectionDevice接口中的SendPacket方法，CaptureDeviceExtensions.cs中包含该方法的四个扩展方法

void SendPacket(ReadOnlySpan<byte> p, ICaptureHeader header = null)
void SendPacket(this IInjectionDevice device, byte[] p, int size)
void SendPacket(this IInjectionDevice device, Packet p)
void SendPacket(this IInjectionDevice device, Packet p, int size)
void SendPacket(this IInjectionDevice device, RawCapture p, ICaptureHeader header = null)

基本使用如下，从文件中读取数据包发送

  
var device = devices[index];
device.Open(mode: DeviceModes.Promiscuous, read_timeout: 1000);

CaptureFileReaderDevice reader = new("capture.pcap");
reader.Open();

while (reader.GetNextPacket(out PacketCapture packet) == GetPacketStatus.PacketRead) { 
    device.SendPacket(packet.GetPacket());
}

发送队列

发送队列是WinPcap扩展功能，使用LibPcap模块，主要使用到SendQueue类，使用以下方法

SendQueue()：唯一构造器，传入队列大小，单位B
Add()：添加到发送队列，SendQueue.cs的SendQueueExtensions中包含它的四个扩展方法
- bool Add(PcapHeader header, byte[] packet)
- bool Add(this SendQueue queue, byte[] packet)
- bool Add(this SendQueue queue, Packet packet)
- bool Add(this SendQueue queue, RawCapture packet)
- bool Add(this SendQueue queue, byte[] packet, int seconds, int microseconds)
Transmit()：发送发送队列，传入PcapDevice类型接口对象，返回发送的字节数，有一个重载
- int Transmit(PcapDevice device, bool synchronized)
- int Transmit(PcapDevice device, SendQueueTransmitModes transmitMode)

基本使用如下，从文件中读取数据包添加到发送队列并发送

  


CaptureFileReaderDevice reader = new("capture.pcap");
reader.Open();

// 构造发送队列
SendQueue queue = new((int)reader.FileSize);

while (reader.GetNextPacket(out PacketCapture packet) == GetPacketStatus.PacketRead) {
    // 添加发送队列，传入RawCapture
    queue.Add(packet.GetPacket());
}

device.Open(mode: DeviceModes.Promiscuous, read_timeout: 1000);
// 在WinPcap下，ILiveDevice的运行时类型是LibPcapLiveDevice，强转为子类
// LibPcapLiveDevice继承了PcapDevice类，实现了ILiveDevice接口
// 使用LibPcapLiveDeviceList.Instance可直接获得LibPcapLiveDevice集合
queue.Transmit(device as LibPcapLiveDevice, true);

统计流量信息

使用到ICaptureDevice对象的Statistics属性，对于LibPcapLiveDevice对象，该属性不为null，该属性为ICaptureStatistics类型，包含以下属性

ReceivedPackets：已接收的数据包数量
DroppedPackets：丢失的数据包数量
InterfaceDroppedPackets：接口丢包数

基本使用如下

  


device.Open(mode: DeviceModes.Promiscuous, read_timeout: 1000);
device.OnPacketArrival += new(OnPacketArrival);
device.StartCapture();
Console.ReadLine();

// 获取统计信息
var statistics = device.Statistics;
Console.WriteLine($"接收{statistics?.ReceivedPackets}个包");
Console.WriteLine($"丢失{statistics?.DroppedPackets}个包");

device.StopCapture();
device.Close();

C# SharpPcap

本文由作者按照 CC BY 4.0 进行授权

前言

SharpPcap安装

获取接口列表

打开接口并捕获

捕获数据包

回调捕获

非回调捕获

过滤数据包

数据包解析

堆文件处理

写入堆文件

读取堆文件

发送数据包

发送单个数据包

发送队列

统计流量信息

热门标签