libpcap库函数介绍

最新推荐文章于 2020-05-24 22:40:00 发布

lamdoc

最新推荐文章于 2020-05-24 22:40:00 发布

阅读量433

点赞数

分类专栏： Network

Network 专栏收录该内容

29 篇文章 0 订阅

订阅专栏

libpcap的英文意思是 Packet Capture library，即数据包捕获函数库。

该库提供的C函数接口可用于需要捕获经过网络接口（只要经过该接口，目标地址不一定为本机）数据包的系统开发上。

由 Berkeley大学Lawrence Berkeley National Laboratory研究院的Van Jacobson、Craig Leres和Steven McCanne编写。

该函数库支持Linux、Solaris和*BSD系统平台。

1. 主要接口函数说明如下：

函数名称：

pcap_t *pcap_open_live(char *device, int snaplen, int promisc, int to_ms, char *ebuf)

函数功能：获得用于捕获网络数据包的数据包捕获描述字。
参数说明：

device 参数为指定打开的网络设备名。

snaplen参数定义捕获数据的最大字节数。

promisc指定是否将网络接口置于混杂模式。

to_ms参数指*定超时时间（毫秒）。

ebuf参数则仅在pcap_open_live()函数出错返回NULL时用于传递错误消息。

函数名称：

pcap_t *pcap_open_offline(char *fname, char *ebuf)

函数功能：打开以前保存捕获数据包的文件，用于读取。
参数说明：

fname参数指定打开的文件名。该文件中的数据格式与tcpdump和tcpslice兼容。”-“为标准输入。

ebuf参数则仅在pcap_open_offline()函数出错返回NULL时用于传递错误消息。

函数名称：

pcap_dumper_t *pcap_dump_open(pcap_t *p, char *fname)

函数功能：打开用于保存捕获数据包的文件，用于写入。
参数说明：

fname 参数为”-“时表示标准输出。出错时返回NULL。

p参数为调用pcap_open_offline()或pcap_open_live()函数后返回的 pcap结构指针。

fname参数指定打开的文件名。如果返回NULL，则可调用pcap_geterr()函数获取错误消息。

函数名称：

char *pcap_lookupdev(char *errbuf)

函数功能：用于返回可被pcap_open_live()或pcap_lookupnet()函数调用的网络设备名指针。

参数说明：如果函数出错，则返回NULL，同时errbuf中存放相关的错误消息。

函数名称：

int pcap_lookupnet(char *device, bpf_u_int32 *netp,bpf_u_int32 *maskp, char *errbuf)

函数功能：获得指定网络设备的网络号和掩码。
参数说明：

netp参数和maskp参数都是bpf_u_int32指针。

如果函数出错，则返回-1，同时errbuf中存放相关的错误消息。

函数名称：

int pcap_dispatch(pcap_t *p, int cnt,pcap_handler callback, u_char *user)

函数功能：捕获并处理数据包。
参数说明：

cnt 参数指定函数返回前所处理数据包的最大值。

cnt=-1表示在一个缓冲区中处理所有的数据包。

cnt=0表示处理所有数据包，直到产生以下错误之一：读取到EOF；超时读取。

callback参数指定一个带有三个参数的回调函数，这三个参数为：

一个从pcap_dispatch()函数传递过来的 u_char指针，

一个pcap_pkthdr结构的指针，

和一个数据包大小的u_char指针。

如果成功则返回读取到的字节数。

读取到EOF时则返回零值。出错时则返回-1，此时可调用pcap_perror()或pcap_geterr()函数获取错误消息。

函数名称：

int pcap_loop(pcap_t *p, int cnt,pcap_handler callback, u_char *user)

函数功能：功能基本与pcap_dispatch()函数相同，只不过此函数在cnt个数据包被处理或出现错误时才返回，但读取超时不会返回。

而如果为 pcap_open_live()函数指定了一个非零值的超时设置，然后调用pcap_dispatch()函数，则当超时发生时 pcap_dispatch()函数会返回。

cnt参数为负值时pcap_loop()函数将始终循环运行，除非出现错误。

函数名称：

void pcap_dump(u_char *user, struct pcap_pkthdr *h,u_char *sp)

函数功能：向调用pcap_dump_open()函数打开的文件输出一个数据包。该函数可作为pcap_dispatch()函数的回调函数。

函数名称：

int pcap_compile(pcap_t *p, struct bpf_program *fp,char *str, int optimize, bpf_u_int32 netmask)

函数功能：将str参数指定的字符串编译到过滤程序中。
参数说明：

fp是一个bpf_program结构的指针，在pcap_compile()函数中被赋值。

optimize参数控制结果代码的优化。

netmask参数指定本地网络的网络掩码。

函数名称：int pcap_setfilter(pcap_t *p, struct bpf_program *fp)

int pcap_setfilter(pcap_t *p, struct bpf_program *fp)

函数功能：指定一个过滤程序。
参数说明：

fp参数是bpf_program结构指针，通常取自pcap_compile()函数调用。出错时返回-1；成功时返回0。

函数名称：

u_char *pcap_next(pcap_t *p, struct pcap_pkthdr *h)

函数功能：返回指向下一个数据包的u_char指针。

函数名称：

int pcap_datalink(pcap_t *p)

函数功能：返回数据链路层类型，例如DLT_EN10MB。

函数名称：

int pcap_snapshot(pcap_t *p)

函数功能：返回pcap_open_live被调用后的snapshot参数值。

函数名称：

int pcap_is_swapped(pcap_t *p)

函数功能：返回当前系统主机字节与被打开文件的字节顺序是否不同。

函数名称：

int pcap_major_version(pcap_t *p)

函数功能：返回写入被打开文件所使用的pcap函数的主版本号。

函数名称：

int pcap_minor_version(pcap_t *p)

函数功能：返回写入被打开文件所使用的pcap函数的辅版本号。

函数名称：

int pcap_stats(pcap_t *p, struct pcap_stat *ps)

函数功能：向pcap_stat结构赋值。成功时返回0。

这些数值包括了从开始捕获数据以来至今共捕获到的数据包统计。

如果出错或不支持数据包统计，则返回-1，且可调用pcap_perror()或pcap_geterr()函数来获取错误消息。

函数名称：

FILE *pcap_file(pcap_t *p)

函数功能：返回被打开文件的文件名。

函数名称：

int pcap_fileno(pcap_t *p)

函数功能：返回被打开文件的文件描述字号码。

函数名称：

void pcap_perror(pcap_t *p, char *prefix)

函数功能：在标准输出设备上显示最后一个pcap库错误消息。以prefix参数指定的字符串为消息头。

函数名称：

char *pcap_geterr(pcap_t *p)

函数功能：返回最后一个pcap库错误消息。

函数名称：

char *pcap_strerror(int error)

函数功能：如果strerror()函数不可用，则可调用pcap_strerror函数替代。

函数名称：

void pcap_close(pcap_t *p)

函数功能：关闭p参数相应的文件，并释放资源。

函数名称：

void pcap_dump_close(pcap_dumper_t *p)

函数功能：关闭相应的被打开文件。

2. libpcap的数据类型定义：

网卡地址描述:

struct pcap_addr
{
    pcap_addr * next;
    sockaddr * addr;
    sockaddr * netmask;
    sockaddr *broadaddr;
    sockaddr *dstaddr;
};

pcap_addr * next;
   如果非空，指向链表中一个元素的指针；空表示链表中的最后一个元素。
sockaddr * addr;
   指向包含一个地址的sockaddr的结构的指针。
sockaddr * netmask;
   如果非空，指向包含相对于addr指向的地址的一个网络掩码的结构。
sockaddr * broadaddr;
   如果非空，指向包含相对于addr指向的地址的一个广播地址，如果网络不支持广播可能为空。
sockaddr * dstaddr;
   如果非空，指向一个相对于addr指向的源地址的目的地址，如果网络不支持点对点通讯，则为空。

struct pcap_file_header {
    bpf_u_int32 magic;
    u_short version_major;
    u_short version_minor;
    bpf_int32 thiszone;    /* gmt to local correction */
    bpf_u_int32 sigfigs;    /* accuracy of timestamps */
    bpf_u_int32 snaplen;    /* max length saved portion of each pkt */
    bpf_u_int32 linktype;    /* data link type (LINKTYPE_*) */
};

bpf_u_int32 magic;

u_short version_major;
   Libpcap的主版本号。
u_shart version_minor;
   Libpcap的从版本号。
bpf_u_int32 sigfigs;
   时间戳描述。
bpf_u_int32 snaplen;
   保存的每个pkt的分片号的最大值。
bpf_u_int32 linktype;
   数据链的类型。
细节说明：
   libpcap dump文件头；
   libpcap dump文件中的第一个记录包含了一些标志的保存值，这些标志在打印阶段用到。这儿的很多域都是32位的int，所以compilers不用进行转化；这些文件需要具有跨层次的可交换性。
   无论如何不要改变结构的层次（包括仅仅改变这个结构中域的长度）；

/*网卡数据链的一个元素*/

struct pcap_if {        
    struct pcap_if *next;
    char *name;        /* name to hand to "pcap_open_live()" */
    char *description;    /* textual description of interface, or NULL */
    struct pcap_addr *addresses;
    u_int flags;        /* PCAP_IF_ interface flags */
};

pcap_if *next;
   如果非空，指向链的下一个元素。如果为空是链的最后一个元素。
char * name;
   指向一个字符串，该字符串是传给pcap_open_live()函数的设备名；
char * description;
   如果非空，指向一个对设备的人性化的描述字符串。
pcap_addr *addresses;
   指向网卡地址链中的第一个元素。
u_int flags;
   PCAP_IF_ 网卡的标志。现在唯一可用的标识是PCAP_IF_LOOKBACK,它被用来标识网卡是不是lookback网卡。

/*dump 文件中的数据包头*/

struct pcap_pkthdr {       
    struct timeval ts;    /* time stamp */
    bpf_u_int32 caplen;    /* length of portion present */
    bpf_u_int32 len;    /* length this packet (off wire) */
};

timeval ts;
   数据报时间戳；
bpf_u_int32 caplen;
   当前分片的长度；
dpf_u_int32 len;
   这个数据报的长度；
细节描述：
   在dump文件中的每个数据报都有这样一个报头。它用来处理不同数据报网卡的不同报头问题。

struct pcap_stat {        /*用来保存网卡静态变量的结构*/
    u_int ps_recv;        /* number of packets received */
    u_int ps_drop;        /* number of packets dropped */
    u_int ps_ifdrop;    /* drops by interface XXX not yet supported */
};

u_int ps_recv;
   接受数据报的数目；
u_int ps_drop;
   被驱动程序丢弃的数据报的数目；
u_int ps_ifdrop;
   被网卡丢弃的数据报的数目；

struct pcap_sf {    //pacap的savefile结构 定义
        FILE *rfile;    //该指针指向savefile文件
        int swapped;    //？
        int hdrsize;    //头大小吗？
        int version_major;//主版本号
        int version_minor;//从版本号
        u_char *base;//？
};

struct pcap_md { //？
        struct pcap_stat stat;
        /*XXX*/
        int use_bpf;            /* using kernel filter */
        u_long  TotPkts;        /* can't oflow for 79 hrs on ether */
        u_long  TotAccepted;    /* count accepted by filter */
        u_long  TotDrops;       /* count of dropped packets */
        long    TotMissed;      /* missed by i/f during this run */
        long    OrigMissed;     /* missed by i/f before this run */
#ifdef linux
        int     sock_packet;    /* using Linux 2.0 compatible interface */
        int     timeout;        /* timeout specified to pcap_open_live */
        int     clear_promisc;  /* must clear promiscuous mode when we close */
        int     cooked;         /* using SOCK_DGRAM rather than SOCK_RAW */
        int     lo_ifindex;     /* interface index of the loopback device */
        char    *device;        /* device name */
        struct pcap *next;      /* list of open promiscuous sock_packet pcaps */
#endif
};

struct pcap {    //这个结构很重要
        int fd;
        int snapshot;
        int linktype;
        int tzoff;              /* timezone offset */
        int offset;             /* offset for proper alignment */

        struct pcap_sf sf;
        struct pcap_md md;

        /*
         * Read buffer.
         */
        int bufsize;
        u_char *buffer;
        u_char *bp;
        int cc;

        /*
         * Place holder for pcap_next().
         */
        u_char *pkt;

        
        /*
         * Placeholder for filter code if bpf not in kernel.
         */
        struct bpf_program fcode;

        char errbuf[PCAP_ERRBUF_SIZE];
};

3. lipcap的声明：

#define PCAP_VERSION_MAJOR 2
    libpcap dump文件的主版本号；
#define PCAP_VERSION_MINOR   4   
    libpcap dump文件的从版本号；
#define PCAP_ERRBUF_SIZE   256
    用来存放libpcap出错信息的缓冲区的大小；
#define PCAP_IF_LOOPBACK   0x00000001
    网卡是回环网卡；
#define MODE_CAPT   0
    抓报模式，在调用pcap_setmode()时使用；
#define MODE_STAT   1
    静态模式，在调用pcap_setmode()时使用；

4. libpcap的类型定义：

typedef int bpf_int32   
    32bit 的整形；
typedef    u_int bpf_u_int32
    32bit 的无类型整形；
typedef pcap pcap_t
    Descriptor of an open capture instance（一个打开的捕获实例的描述符？）这个结构对用户是不透明的。
typedef pcap_dumper pcap_dumper_t
    libpcap保存文件的描述符。
typedef pcap_if pcap_if_t
    网卡链表的一个元素；
typedef pcap_addr pcap_addr_t
    网卡地址的表示；