wpa_supplicant 2.0版源代码阅读（2） ---- L2_packet模块

2. L2_packet模块

    L2_packet模块是wpa_supplicant软件中实现EAPOL帧的收发功能的模块。L2即网络协议层的数据链路层。wpa_supplicant针对不同的OS系统，采用了不同的抓包技术实现。windows平台采用NDIS协议驱动抓包技术，linux平台采用packet socket抓包技术。

    该模块的实现代码在目录wpa_supplicant/src/l2_packet中。

l2_packet_linux.c是linux系统下的收发EAPOL帧实现。

l2_packet_ndis.c是windows系统下使用ndisuio协议驱动实现收发EAPOL帧实现。

l2_packet_pcap是windows系统下使用winpcap协议驱动实现EAPOL收发，采用轮询的方式抓包。

l2_packet_winpcap是windows系统下使用winpcap协议驱动实现EAPOL收发，采用接收线程的方式抓包。相比l2_packet_pcap抓包，接收EAPOL帧的延迟从100ms降到了3ms。

l2_packet.h是api接口声明和struct l2_packet_data声明头文件。

2.1 l2_packet主要的接口函数说明

2.1.1 l2_packet_init

struct l2_packet_data * l2_packet_init(
    const char *ifname, const u8 *own_addr, unsigned short protocol,
    void (*rx_callback)(void *ctx, const u8 *src_addr,
                const u8 *buf, size_t len),
    void *rx_callback_ctx, int l2_hdr);

ifname: 网络设备名；

own_addr: mac地址

protocol：协议类型或者以太类型。如抓取EAPOL帧，以太类型为0x888E。

rx_callback: 接收到EAPOL帧的回调处理函数。

ctx：上面回调处理函数的回调参数。

l2_hrd：收发数据是否包含l2层以太头。通常设置为0，不包含。

l2_packet_init()函数在wpa_supplicant初始化时候调用。

2.1.2 l2_packet_deinit

wpa_supplicant退出或清除时调用，释放相关资源。

2.1.3 l2_packet_send

向驱动发送EAPOL帧接口函数。

2.1.4 l2_packet_notify_auth_start

该函数接口的实现只在l2_packet_winpcap中实现，因其采用创建一个线程抓包，所以在无线联网关联成功之后，唤醒l2_packet接收线程，准备获取EAPOL帧。

2.2 l2_packet模块的初始化

     wpa_supplicnat在初始化阶段调用l2_packet_init()函数。函数调用关系如下：

main --> wpa_supplicant_add_iface() --> wpa_supplicant_init_iface() -->wpa_supplicant_driver_init() --> wpa_supplicant_update_mac_addr() --> l2_packet_init()

int wpa_supplicant_update_mac_addr(struct wpa_supplicant *wpa_s)
{
	if (wpa_s->driver->send_eapol) {              
		const u8 *addr = wpa_drv_get_mac_addr(wpa_s);
		if (addr)
			os_memcpy(wpa_s->own_addr, addr, ETH_ALEN);
	} else if (!(wpa_s->drv_flags &
		     WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE)) {
		l2_packet_deinit(wpa_s->l2);
		wpa_s->l2 = l2_packet_init(wpa_s->ifname,
					   wpa_drv_get_mac_addr(wpa_s),
					   ETH_P_EAPOL,
					   wpa_supplicant_rx_eapol, wpa_s, 0);
		if (wpa_s->l2 == NULL)
			return -1;
	} else {
		const u8 *addr = wpa_drv_get_mac_addr(wpa_s);
		if (addr)
			os_memcpy(wpa_s->own_addr, addr, ETH_ALEN);
	}

	if (wpa_s->l2 && l2_packet_get_own_addr(wpa_s->l2, wpa_s->own_addr)) {
		wpa_msg(wpa_s, MSG_ERROR, "Failed to get own L2 address");
		return -1;
	}

	wpa_dbg(wpa_s, MSG_DEBUG, "Own MAC address: " MACSTR,
		MAC2STR(wpa_s->own_addr));
	wpa_sm_set_own_addr(wpa_s->wpa, wpa_s->own_addr);

	return 0;
}

1） wpa_s->drv->send_eapol函数指针是针对某些在嵌入式系统（非wince和linux）上采用wpa_supplicant开发使用的，在这种开发环境下，wpa_supplicant与无线驱动的EAPOL帧的收发可以直接交互，wpa_supplicnat直接调用注册的send_eapol函数把EAPOL帧发送到无线驱动。在linux和windows开发环境下，则不用设置send_eapol函数指针。

2）  (!(wpa_s->drv_flags &  WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE) 是判断驱动支持的功能标记，通常的无线驱动不支持WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE功能。所以可以开始调用l2_packet_init()函数。

3）调用函数l2_packet_init，参数包括网络设备名，网络设备MAC地址，需要抓包的以太帧类型，EAPOL帧接收回调处理函数wpa_supplicant_rx_eapol()，回调函数参数wpa_s, l2_hrd标记设置为0。

4）返回的参数是struct l2_packet_data，该数据结构根据l2_packet的不同实现定义不同，所以是在l2_packet_xxx.c中定义，在l2_packet.h中声明。

2.3 l2_packet_winpcap的实现分析

    l2_packet_winpcap是采用winpcap协议驱动抓包技术实现，另外创建一个线程负责接收EAPOL。该线程50ms唤醒一次或者由notify事件唤醒执行接收EAPOL帧。在收到EAPOL之后，通知wpa_supplicant，由wpa_supplicant的Event Loop模块调用注册的EAPOL帧接收处理函数wpa_supplicant_rx_eapol()。

   为什么不由EAPOL帧接收线程直接调用wpa_supplicant_rx_eapol()函数是因为wpa_supplicant的所有事件是在主线程中处理，其他线程（进程）不直接调用wpa_supplicant的处理函数。外部线程（进程）只是设置相关事件标记，由Event Loop模块（主进程）循环判断执行。这样的设计是基于两点考虑：

1）WPA认证实现不必太考虑性能问题。

2）因所有的处理都在主进程（Event Loop模块）中调用，不用考虑同步问题。简化了wpa_supplicant实现。

    EAPOL帧接收线程的帧接收和Event Loop线程的EAPOL帧处理是采用同步方式实现，所以不需要额外的缓存空间和队列机制。实现也比较简洁。

2.3.1 初始化

struct l2_packet_data * l2_packet_init(
	const char *ifname, const u8 *own_addr, unsigned short protocol,
	void (*rx_callback)(void *ctx, const u8 *src_addr,
			    const u8 *buf, size_t len),
	void *rx_callback_ctx, int l2_hdr)
{
	struct l2_packet_data *l2;
	DWORD thread_id;

	l2 = os_zalloc(sizeof(struct l2_packet_data));
	if (l2 == NULL)
		return NULL;
	if (os_strncmp(ifname, "\\Device\\NPF_", 12) == 0)
		os_strlcpy(l2->ifname, ifname, sizeof(l2->ifname));
	else
		os_snprintf(l2->ifname, sizeof(l2->ifname), "\\Device\\NPF_%s",
			    ifname);
	l2->rx_callback = rx_callback;
	l2->rx_callback_ctx = rx_callback_ctx;
	l2->l2_hdr = l2_hdr;

	if (own_addr)
		os_memcpy(l2->own_addr, own_addr, ETH_ALEN);

	if (l2_packet_init_libpcap(l2, protocol)) {
		os_free(l2);
		return NULL;
	}

	l2->rx_avail = CreateEvent(NULL, TRUE, FALSE, NULL);
	l2->rx_done = CreateEvent(NULL, TRUE, FALSE, NULL);
	l2->rx_notify = CreateEvent(NULL, TRUE, FALSE, NULL);
	if (l2->rx_avail == NULL || l2->rx_done == NULL ||
	    l2->rx_notify == NULL) {
		CloseHandle(l2->rx_avail);
		CloseHandle(l2->rx_done);
		CloseHandle(l2->rx_notify);
		pcap_close(l2->pcap);
		os_free(l2);
		return NULL;
	}

	eloop_register_event(l2->rx_avail, sizeof(l2->rx_avail),
			     l2_packet_rx_event, l2, NULL);

	l2->running = 1;
	l2->rx_thread = CreateThread(NULL, 0, l2_packet_receive_thread, l2, 0,
				     &thread_id);

	return l2;
}

代码分析：

1）分配struct l2_packet_data

2) 比较网络设备名是否是\\Device\\NPF_开头，在windows环境下，安装winpcap之后，所有的网络设备都增加了一个\\Device\\NPF_XXX的设备名。如果是\\Device\\NPF_开头，则直接使用，否则在原设备名前加\\Device\\NPF_。

3）设置struct l2_packet_data中的回调函数和回调参数。

4）调用l2_packet_init_libpcap()函数。该函数调用winpcap的libpcap库函数，打开网络设备，设置抓包的相关参数（最大包长2500字节，非混杂模式，1ms超时时间），并设置帧过滤条件（只接收EAPOL帧）。

5）创建三个事件：rx_avail,rx_done, rx_notify。

      rx_avail用于L2 PACKET EAPOL帧接收线程通知Event Loop进程EAPOL帧已经接收到，请求处理。

      rx_done则是由Event Loop进程在处理完EAPOL帧之后，通知L2 PACKET EAPOL帧接收线程已经处理完毕，可以接收下一帧。

     rx_notify是Event Loop进程在收到驱动的关联成功事件之后，通知L2 PACKET EAPOL帧接收线程唤醒，准备接收EAPOL帧。

6）调用eloop_register_event()函数，向Event Loop模块注册一个事件，即rx_avail。回调函数为l2_packet_rx_event。

7）置runing标记，表示l2_packet可以开始运行，并创建一接收线材l2_packet_receive_thread。

2.3.2 接收线程执行流程

static DWORD WINAPI l2_packet_receive_thread(LPVOID arg)
{
	struct l2_packet_data *l2 = arg;

	while (l2->running) {
		pcap_dispatch(l2->pcap, 1, l2_packet_receive_cb,
			      (u_char *) l2);
		if (l2->rx_no_wait > 0)
			l2->rx_no_wait--;
		if (WaitForSingleObject(l2->rx_notify,
					l2->rx_no_wait ? 0 : 50) ==
		    WAIT_OBJECT_0) {
			l2->rx_no_wait = no_wait_count;
			ResetEvent(l2->rx_notify);
		}
	}
	SetEvent(l2->rx_thread_done);
	ExitThread(0);
	return 0;
}

1）线程是个while循环处理函数。

2）调用pcap_dispatch(winpcap的libpcap API函数）获取winpcap协议驱动抓取的EAPOL帧。每次获取一帧。如果获取成功，则调用接收处理函数l2_packet_receive_cb()，其函数参数为l2

3 ) rx_no_wait是循环执行计数器。起始设置为0，然后线程调用WaitForSingleObject()，线程挂起等待rx_notify事件，或者睡眠50ms之后，继续执行。如果没有rx_notify事件，则rx_no_wait始终为0，线程则每隔50ms唤醒一次执行获取EAPOL帧的操作。如果在此期间，rx_notify事件触发（由wpa_supplicant的Event Loop模块收到无线驱动的关联成功事件之后触发rx_notify事件）。则设置rx_no_wait为750（默认值），并复位rx_notify事件。线程开始收包，执行750次循环，直到计数减为0。

2.3.3 接收线程中的pcap_dispatch()回调处理函数

static void l2_packet_receive_cb(u_char *user, const struct pcap_pkthdr *hdr,
				 const u_char *pkt_data)
{
	struct l2_packet_data *l2 = (struct l2_packet_data *) user;
	struct l2_ethhdr *ethhdr;

	if (pkt_data == NULL || hdr->caplen < sizeof(*ethhdr))
		return;

	ethhdr = (struct l2_ethhdr *) pkt_data;
	if (l2->l2_hdr) {
		l2->rx_buf = (u8 *) ethhdr;
		l2->rx_len = hdr->caplen;
	} else {
		l2->rx_buf = (u8 *) (ethhdr + 1);
		l2->rx_len = hdr->caplen - sizeof(*ethhdr);
	}
	l2->rx_src = ethhdr->h_source;
	SetEvent(l2->rx_avail);
	WaitForSingleObject(l2->rx_done, INFINITE);
	ResetEvent(l2->rx_done);
	l2->rx_no_wait = no_wait_count;
}

1） 回调参数转型，并判断帧指针是否为空，包长是否合法

2） 根据l2_hdr标记，EAPOL帧指针是否指向以太帧头，或者以太帧体。

3）设置以太帧源地址指针。

4）触发rx_avail事件。调用WaitForSingleObject无限等待rx_done事件触发。

5）复位rx_done事件，设置rx_no_wait为默认值750。准备接收线程的下次收包。

2.3.4 Event Loop模块的实际EAPOL帧处理调用

static void l2_packet_rx_event(void *eloop_data, void *user_data)
{
	struct l2_packet_data *l2 = eloop_data;
	l2->rx_callback(l2->rx_callback_ctx, l2->rx_src, l2->rx_buf,
			l2->rx_len);
	ResetEvent(l2->rx_avail);
	SetEvent(l2->rx_done);
}

wpa_supplicnat的Event Loop主进程在收到rx_avail事件之后，调用eloop_register_event注册的事件回调处理函数l2_packet_rx_event()。

1）调用rx_callback，即wpa_supplicant_rx_eapol（）函数。

2）复位rx_avail事件

3）设置rx_done事件，通知接收线程继续处理。

2.3.5 EAPOL帧发送

int l2_packet_send(struct l2_packet_data *l2, const u8 *dst_addr, u16 proto,
		   const u8 *buf, size_t len)
{
	int ret;
	struct l2_ethhdr *eth;

	if (l2 == NULL)
		return -1;

	if (l2->l2_hdr) {
		ret = pcap_sendpacket(l2->pcap, buf, len);
	} else {
		size_t mlen = sizeof(*eth) + len;
		eth = os_malloc(mlen);
		if (eth == NULL)
			return -1;

		os_memcpy(eth->h_dest, dst_addr, ETH_ALEN);
		os_memcpy(eth->h_source, l2->own_addr, ETH_ALEN);
		eth->h_proto = htons(proto);
		os_memcpy(eth + 1, buf, len);
		ret = pcap_sendpacket(l2->pcap, (u8 *) eth, mlen);
		os_free(eth);
	}

	return ret;
}

1）如果wpa_supplicant下发的帧包括以太头，则直接调用pcap_sendpacket通过协议驱动发送。

2）否则分配帧空间，设置以太帧头，拷贝帧体，调用pcap_sendpacket发送。

2.3.6 pcap抓包规则初始化配置函数l2_packet_init_libpcap

static int l2_packet_init_libpcap(struct l2_packet_data *l2,
				  unsigned short protocol)
{
	bpf_u_int32 pcap_maskp, pcap_netp;
	char pcap_filter[200], pcap_err[PCAP_ERRBUF_SIZE];
	struct bpf_program pcap_fp;

	pcap_lookupnet(l2->ifname, &pcap_netp, &pcap_maskp, pcap_err);
	l2->pcap = pcap_open_live(l2->ifname, 2500, 0, 1, pcap_err);
	if (l2->pcap == NULL) {
		fprintf(stderr, "pcap_open_live: %s\n", pcap_err);
		fprintf(stderr, "ifname='%s'\n", l2->ifname);
		return -1;
	}
	os_snprintf(pcap_filter, sizeof(pcap_filter),
		    "not ether src " MACSTR " and "
		    "( ether dst " MACSTR " or ether dst " MACSTR " ) and "
		    "ether proto 0x%x",
		    MAC2STR(l2->own_addr), /* do not receive own packets */
		    MAC2STR(l2->own_addr), MAC2STR(pae_group_addr),
		    protocol);
	if (pcap_compile(l2->pcap, &pcap_fp, pcap_filter, 1, pcap_netp) < 0) {
		fprintf(stderr, "pcap_compile: %s\n", pcap_geterr(l2->pcap));
		return -1;
	}

	if (pcap_setfilter(l2->pcap, &pcap_fp) < 0) {
		fprintf(stderr, "pcap_setfilter: %s\n", pcap_geterr(l2->pcap));
		return -1;
	}

	pcap_freecode(&pcap_fp);

	return 0;
}

1）pcap_lookupnet寻找与设备名匹配的网络设备信息

2）pcap_open_live打开文件句柄，设置抓包最大包长2500，非混杂模式，超时时间1ms

3）pcap_compile：编译规则，抓包过滤规则为源地址非本设备MAC地址，并且目的地址是本网络设备地址或者01:80:c2:00:00:03(PAE组播地址，是802.1x协议使用的端口认证实体组播地址），并且以太类型为EAPOL（0x888E）。

4）pcap_setfilter：设置过滤规则

5）pcap_freecode：释放文件句柄。

2.4 l2_packet_linux的实现分析

  在linux系统上，wpa_supplicant采用PACKET SOCKET技术抓取EAPOL帧。wpa_supplicant的Event Loop模块采用轮询方式获取EAPOL帧，并处理。

2.4.1 初始化

struct l2_packet_data * l2_packet_init(
	const char *ifname, const u8 *own_addr, unsigned short protocol,
	void (*rx_callback)(void *ctx, const u8 *src_addr,
			    const u8 *buf, size_t len),
	void *rx_callback_ctx, int l2_hdr)
{
	struct l2_packet_data *l2;
	struct ifreq ifr;
	struct sockaddr_ll ll;

	l2 = os_zalloc(sizeof(struct l2_packet_data));
	if (l2 == NULL)
		return NULL;
	os_strlcpy(l2->ifname, ifname, sizeof(l2->ifname));
	l2->rx_callback = rx_callback;
	l2->rx_callback_ctx = rx_callback_ctx;
	l2->l2_hdr = l2_hdr;

	l2->fd = socket(PF_PACKET, l2_hdr ? SOCK_RAW : SOCK_DGRAM,
			htons(protocol));
	if (l2->fd < 0) {
		wpa_printf(MSG_ERROR, "%s: socket(PF_PACKET): %s",
			   __func__, strerror(errno));
		os_free(l2);
		return NULL;
	}
	os_memset(&ifr, 0, sizeof(ifr));
	os_strlcpy(ifr.ifr_name, l2->ifname, sizeof(ifr.ifr_name));
	if (ioctl(l2->fd, SIOCGIFINDEX, &ifr) < 0) {
		wpa_printf(MSG_ERROR, "%s: ioctl[SIOCGIFINDEX]: %s",
			   __func__, strerror(errno));
		close(l2->fd);
		os_free(l2);
		return NULL;
	}
	l2->ifindex = ifr.ifr_ifindex;

	os_memset(&ll, 0, sizeof(ll));
	ll.sll_family = PF_PACKET;
	ll.sll_ifindex = ifr.ifr_ifindex;
	ll.sll_protocol = htons(protocol);
	if (bind(l2->fd, (struct sockaddr *) &ll, sizeof(ll)) < 0) {
		wpa_printf(MSG_ERROR, "%s: bind[PF_PACKET]: %s",
			   __func__, strerror(errno));
		close(l2->fd);
		os_free(l2);
		return NULL;
	}

	if (ioctl(l2->fd, SIOCGIFHWADDR, &ifr) < 0) {
		wpa_printf(MSG_ERROR, "%s: ioctl[SIOCGIFHWADDR]: %s",
			   __func__, strerror(errno));
		close(l2->fd);
		os_free(l2);
		return NULL;
	}
	os_memcpy(l2->own_addr, ifr.ifr_hwaddr.sa_data, ETH_ALEN);

	eloop_register_read_sock(l2->fd, l2_packet_receive, l2, NULL);

	return l2;
}

1）分配struct l2_packet_data，并设置回调函数和回调参数以及l2_hdr标记

2）调用socket创建端口文件句柄，其协议族为PF_PACKET，SOCK_TYPE根据是否包含以太帧头设置为SOCK_RAW或者SOCK_DGRAM，发送和接收到以太帧类型为EAPOL帧。

3）调用ioctl(l2->fd, SIOCGIFINDEX, &ifr)获取网络设备对应的索引值。

4）配置sockaddr_ll数据结构，调用bind函数绑定端口文件句柄。

5）调用ioctl(l2->fd, SIOCGIFHWADDR, &ifr）获取硬件MAC地址备用。

6）调用eloop_register_read_sock向wpa_supplicant的Event Loop模块注册一个读取socket的操作。事件触发的回调函数为l2_packet_receive。回调函数上下文参数为l2。

2.4.2 Event Loop模块如何调用l2_packet_receive?

在l2_packet_init()函数中调用了eloop_register_read_sock注册了一个读socket操作。在Event Loop模块的eloop_run()函数中，循环执行调用eloop_sock_table_dispatch(&eloop.readers, rfds)，对所有注册的读取socket的操作进行处理，通过调用FD_ISSET(table->table[i].sock, fds)判断socket文件句柄的状态是否发生变化，如果发生变化，则调用注册的回调函数（即l2_packet_receive)。

2.4.3 l2_packet_receive处理

static void l2_packet_receive(int sock, void *eloop_ctx, void *sock_ctx)
{
	struct l2_packet_data *l2 = eloop_ctx;
	u8 buf[2300];
	int res;
	struct sockaddr_ll ll;
	socklen_t fromlen;

	os_memset(&ll, 0, sizeof(ll));
	fromlen = sizeof(ll);
	res = recvfrom(sock, buf, sizeof(buf), 0, (struct sockaddr *) &ll,
		       &fromlen);
	if (res < 0) {
		wpa_printf(MSG_DEBUG, "l2_packet_receive - recvfrom: %s",
			   strerror(errno));
		return;
	}

	l2->rx_callback(l2->rx_callback_ctx, ll.sll_addr, buf, res);
}

1）调用recvfrom把接收到的EAPOL帧拷贝到buf缓存中（最长2300字节）。

2）调用注册的EAPOL接收处理函数，即wpa_supplicant_rx_eapol（）。

2.4.4 EAPOL帧的发送

int l2_packet_send(struct l2_packet_data *l2, const u8 *dst_addr, u16 proto,
		   const u8 *buf, size_t len)
{
	int ret;
	if (l2 == NULL)
		return -1;
	if (l2->l2_hdr) {
		ret = send(l2->fd, buf, len, 0);
		if (ret < 0)
			wpa_printf(MSG_ERROR, "l2_packet_send - send: %s",
				   strerror(errno));
	} else {
		struct sockaddr_ll ll;
		os_memset(&ll, 0, sizeof(ll));
		ll.sll_family = AF_PACKET;
		ll.sll_ifindex = l2->ifindex;
		ll.sll_protocol = htons(proto);
		ll.sll_halen = ETH_ALEN;
		os_memcpy(ll.sll_addr, dst_addr, ETH_ALEN);
		ret = sendto(l2->fd, buf, len, 0, (struct sockaddr *) &ll,
			     sizeof(ll));
		if (ret < 0) {
			wpa_printf(MSG_ERROR, "l2_packet_send - sendto: %s",
				   strerror(errno));
		}
	}
	return ret;
}

1）根据l2_hdr标记，如果l2_hdr配置为1，则直接发送原始数据。如果l2_hdr配置为0，则需要添加以太帧头进行发送。

2）根据两种情况，分别调用send（RAW）或者sendto（DGRAM）发送EAPOL帧。