xref: /freebsd/sys/net80211/ieee80211_input.c (revision 42249ef2)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2001 Atsushi Onoe
5  * Copyright (c) 2002-2009 Sam Leffler, Errno Consulting
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
31 
32 #include "opt_wlan.h"
33 
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/mbuf.h>
37 #include <sys/malloc.h>
38 #include <sys/endian.h>
39 #include <sys/kernel.h>
40 
41 #include <sys/socket.h>
42 
43 #include <net/ethernet.h>
44 #include <net/if.h>
45 #include <net/if_var.h>
46 #include <net/if_llc.h>
47 #include <net/if_media.h>
48 #include <net/if_vlan_var.h>
49 
50 #include <net80211/ieee80211_var.h>
51 #include <net80211/ieee80211_input.h>
52 #ifdef IEEE80211_SUPPORT_MESH
53 #include <net80211/ieee80211_mesh.h>
54 #endif
55 
56 #include <net/bpf.h>
57 
58 #ifdef INET
59 #include <netinet/in.h>
60 #include <net/ethernet.h>
61 #endif
62 
63 static void
64 ieee80211_process_mimo(struct ieee80211_node *ni, struct ieee80211_rx_stats *rx)
65 {
66 	int i;
67 
68 	/* Verify the required MIMO bits are set */
69 	if ((rx->r_flags & (IEEE80211_R_C_CHAIN | IEEE80211_R_C_NF | IEEE80211_R_C_RSSI)) !=
70 	    (IEEE80211_R_C_CHAIN | IEEE80211_R_C_NF | IEEE80211_R_C_RSSI))
71 		return;
72 
73 	/* XXX This assumes the MIMO radios have both ctl and ext chains */
74 	for (i = 0; i < MIN(rx->c_chain, IEEE80211_MAX_CHAINS); i++) {
75 		IEEE80211_RSSI_LPF(ni->ni_mimo_rssi_ctl[i], rx->c_rssi_ctl[i]);
76 		IEEE80211_RSSI_LPF(ni->ni_mimo_rssi_ext[i], rx->c_rssi_ext[i]);
77 	}
78 
79 	/* XXX This also assumes the MIMO radios have both ctl and ext chains */
80 	for(i = 0; i < MIN(rx->c_chain, IEEE80211_MAX_CHAINS); i++) {
81 		ni->ni_mimo_noise_ctl[i] = rx->c_nf_ctl[i];
82 		ni->ni_mimo_noise_ext[i] = rx->c_nf_ext[i];
83 	}
84 	ni->ni_mimo_chains = rx->c_chain;
85 }
86 
87 int
88 ieee80211_input_mimo(struct ieee80211_node *ni, struct mbuf *m)
89 {
90 	struct ieee80211_rx_stats rxs;
91 
92 	/* try to read stats from mbuf */
93 	bzero(&rxs, sizeof(rxs));
94 	if (ieee80211_get_rx_params(m, &rxs) != 0)
95 		return (-1);
96 
97 	/* XXX should assert IEEE80211_R_NF and IEEE80211_R_RSSI are set */
98 	ieee80211_process_mimo(ni, &rxs);
99 
100 	//return ieee80211_input(ni, m, rx->rssi, rx->nf);
101 	return ni->ni_vap->iv_input(ni, m, &rxs, rxs.c_rssi, rxs.c_nf);
102 }
103 
104 int
105 ieee80211_input_all(struct ieee80211com *ic, struct mbuf *m, int rssi, int nf)
106 {
107 	struct ieee80211_rx_stats rx;
108 
109 	rx.r_flags = IEEE80211_R_NF | IEEE80211_R_RSSI;
110 	rx.c_nf = nf;
111 	rx.c_rssi = rssi;
112 
113 	if (!ieee80211_add_rx_params(m, &rx))
114 		return (-1);
115 
116 	return ieee80211_input_mimo_all(ic, m);
117 }
118 
119 int
120 ieee80211_input_mimo_all(struct ieee80211com *ic, struct mbuf *m)
121 {
122 	struct ieee80211vap *vap;
123 	int type = -1;
124 
125 	m->m_flags |= M_BCAST;		/* NB: mark for bpf tap'ing */
126 
127 	/* XXX locking */
128 	TAILQ_FOREACH(vap, &ic->ic_vaps, iv_next) {
129 		struct ieee80211_node *ni;
130 		struct mbuf *mcopy;
131 
132 		/* NB: could check for IFF_UP but this is cheaper */
133 		if (vap->iv_state == IEEE80211_S_INIT)
134 			continue;
135 		/*
136 		 * WDS vap's only receive directed traffic from the
137 		 * station at the ``far end''.  That traffic should
138 		 * be passed through the AP vap the station is associated
139 		 * to--so don't spam them with mcast frames.
140 		 */
141 		if (vap->iv_opmode == IEEE80211_M_WDS)
142 			continue;
143 		if (TAILQ_NEXT(vap, iv_next) != NULL) {
144 			/*
145 			 * Packet contents are changed by ieee80211_decap
146 			 * so do a deep copy of the packet.
147 			 * NB: tags are copied too.
148 			 */
149 			mcopy = m_dup(m, M_NOWAIT);
150 			if (mcopy == NULL) {
151 				/* XXX stat+msg */
152 				continue;
153 			}
154 		} else {
155 			mcopy = m;
156 			m = NULL;
157 		}
158 		ni = ieee80211_ref_node(vap->iv_bss);
159 		type = ieee80211_input_mimo(ni, mcopy);
160 		ieee80211_free_node(ni);
161 	}
162 	if (m != NULL)			/* no vaps, reclaim mbuf */
163 		m_freem(m);
164 	return type;
165 }
166 
167 /*
168  * This function reassembles fragments.
169  *
170  * XXX should handle 3 concurrent reassemblies per-spec.
171  */
172 struct mbuf *
173 ieee80211_defrag(struct ieee80211_node *ni, struct mbuf *m, int hdrspace)
174 {
175 	struct ieee80211vap *vap = ni->ni_vap;
176 	struct ieee80211_frame *wh = mtod(m, struct ieee80211_frame *);
177 	struct ieee80211_frame *lwh;
178 	uint16_t rxseq;
179 	uint8_t fragno;
180 	uint8_t more_frag = wh->i_fc[1] & IEEE80211_FC1_MORE_FRAG;
181 	struct mbuf *mfrag;
182 
183 	KASSERT(!IEEE80211_IS_MULTICAST(wh->i_addr1), ("multicast fragm?"));
184 
185 	rxseq = le16toh(*(uint16_t *)wh->i_seq);
186 	fragno = rxseq & IEEE80211_SEQ_FRAG_MASK;
187 
188 	/* Quick way out, if there's nothing to defragment */
189 	if (!more_frag && fragno == 0 && ni->ni_rxfrag[0] == NULL)
190 		return m;
191 
192 	/*
193 	 * Remove frag to insure it doesn't get reaped by timer.
194 	 */
195 	if (ni->ni_table == NULL) {
196 		/*
197 		 * Should never happen.  If the node is orphaned (not in
198 		 * the table) then input packets should not reach here.
199 		 * Otherwise, a concurrent request that yanks the table
200 		 * should be blocked by other interlocking and/or by first
201 		 * shutting the driver down.  Regardless, be defensive
202 		 * here and just bail
203 		 */
204 		/* XXX need msg+stat */
205 		m_freem(m);
206 		return NULL;
207 	}
208 	IEEE80211_NODE_LOCK(ni->ni_table);
209 	mfrag = ni->ni_rxfrag[0];
210 	ni->ni_rxfrag[0] = NULL;
211 	IEEE80211_NODE_UNLOCK(ni->ni_table);
212 
213 	/*
214 	 * Validate new fragment is in order and
215 	 * related to the previous ones.
216 	 */
217 	if (mfrag != NULL) {
218 		uint16_t last_rxseq;
219 
220 		lwh = mtod(mfrag, struct ieee80211_frame *);
221 		last_rxseq = le16toh(*(uint16_t *)lwh->i_seq);
222 		/* NB: check seq # and frag together */
223 		if (rxseq == last_rxseq+1 &&
224 		    IEEE80211_ADDR_EQ(wh->i_addr1, lwh->i_addr1) &&
225 		    IEEE80211_ADDR_EQ(wh->i_addr2, lwh->i_addr2)) {
226 			/* XXX clear MORE_FRAG bit? */
227 			/* track last seqnum and fragno */
228 			*(uint16_t *) lwh->i_seq = *(uint16_t *) wh->i_seq;
229 
230 			m_adj(m, hdrspace);		/* strip header */
231 			m_catpkt(mfrag, m);		/* concatenate */
232 		} else {
233 			/*
234 			 * Unrelated fragment or no space for it,
235 			 * clear current fragments.
236 			 */
237 			m_freem(mfrag);
238 			mfrag = NULL;
239 		}
240 	}
241 
242  	if (mfrag == NULL) {
243 		if (fragno != 0) {		/* !first fragment, discard */
244 			vap->iv_stats.is_rx_defrag++;
245 			IEEE80211_NODE_STAT(ni, rx_defrag);
246 			m_freem(m);
247 			return NULL;
248 		}
249 		mfrag = m;
250 	}
251 	if (more_frag) {			/* more to come, save */
252 		ni->ni_rxfragstamp = ticks;
253 		ni->ni_rxfrag[0] = mfrag;
254 		mfrag = NULL;
255 	}
256 	return mfrag;
257 }
258 
259 void
260 ieee80211_deliver_data(struct ieee80211vap *vap,
261 	struct ieee80211_node *ni, struct mbuf *m)
262 {
263 	struct ether_header *eh = mtod(m, struct ether_header *);
264 	struct ifnet *ifp = vap->iv_ifp;
265 
266 	/* clear driver/net80211 flags before passing up */
267 	m->m_flags &= ~(M_MCAST | M_BCAST);
268 	m_clrprotoflags(m);
269 
270 	/* NB: see hostap_deliver_data, this path doesn't handle hostap */
271 	KASSERT(vap->iv_opmode != IEEE80211_M_HOSTAP, ("gack, hostap"));
272 	/*
273 	 * Do accounting.
274 	 */
275 	if_inc_counter(ifp, IFCOUNTER_IPACKETS, 1);
276 	IEEE80211_NODE_STAT(ni, rx_data);
277 	IEEE80211_NODE_STAT_ADD(ni, rx_bytes, m->m_pkthdr.len);
278 	if (ETHER_IS_MULTICAST(eh->ether_dhost)) {
279 		if (ETHER_IS_BROADCAST(eh->ether_dhost))
280 			m->m_flags |= M_BCAST;
281 		else
282 			m->m_flags |= M_MCAST;
283 		IEEE80211_NODE_STAT(ni, rx_mcast);
284 	} else
285 		IEEE80211_NODE_STAT(ni, rx_ucast);
286 	m->m_pkthdr.rcvif = ifp;
287 
288 	if (ni->ni_vlan != 0) {
289 		/* attach vlan tag */
290 		m->m_pkthdr.ether_vtag = ni->ni_vlan;
291 		m->m_flags |= M_VLANTAG;
292 	}
293 	ifp->if_input(ifp, m);
294 }
295 
296 struct mbuf *
297 ieee80211_decap(struct ieee80211vap *vap, struct mbuf *m, int hdrlen)
298 {
299 	struct ieee80211_qosframe_addr4 wh;
300 	struct ether_header *eh;
301 	struct llc *llc;
302 
303 	KASSERT(hdrlen <= sizeof(wh),
304 	    ("hdrlen %d > max %zd", hdrlen, sizeof(wh)));
305 
306 	if (m->m_len < hdrlen + sizeof(*llc) &&
307 	    (m = m_pullup(m, hdrlen + sizeof(*llc))) == NULL) {
308 		vap->iv_stats.is_rx_tooshort++;
309 		/* XXX msg */
310 		return NULL;
311 	}
312 	memcpy(&wh, mtod(m, caddr_t), hdrlen);
313 	llc = (struct llc *)(mtod(m, caddr_t) + hdrlen);
314 	if (llc->llc_dsap == LLC_SNAP_LSAP && llc->llc_ssap == LLC_SNAP_LSAP &&
315 	    llc->llc_control == LLC_UI && llc->llc_snap.org_code[0] == 0 &&
316 	    llc->llc_snap.org_code[1] == 0 && llc->llc_snap.org_code[2] == 0 &&
317 	    /* NB: preserve AppleTalk frames that have a native SNAP hdr */
318 	    !(llc->llc_snap.ether_type == htons(ETHERTYPE_AARP) ||
319 	      llc->llc_snap.ether_type == htons(ETHERTYPE_IPX))) {
320 		m_adj(m, hdrlen + sizeof(struct llc) - sizeof(*eh));
321 		llc = NULL;
322 	} else {
323 		m_adj(m, hdrlen - sizeof(*eh));
324 	}
325 	eh = mtod(m, struct ether_header *);
326 	switch (wh.i_fc[1] & IEEE80211_FC1_DIR_MASK) {
327 	case IEEE80211_FC1_DIR_NODS:
328 		IEEE80211_ADDR_COPY(eh->ether_dhost, wh.i_addr1);
329 		IEEE80211_ADDR_COPY(eh->ether_shost, wh.i_addr2);
330 		break;
331 	case IEEE80211_FC1_DIR_TODS:
332 		IEEE80211_ADDR_COPY(eh->ether_dhost, wh.i_addr3);
333 		IEEE80211_ADDR_COPY(eh->ether_shost, wh.i_addr2);
334 		break;
335 	case IEEE80211_FC1_DIR_FROMDS:
336 		IEEE80211_ADDR_COPY(eh->ether_dhost, wh.i_addr1);
337 		IEEE80211_ADDR_COPY(eh->ether_shost, wh.i_addr3);
338 		break;
339 	case IEEE80211_FC1_DIR_DSTODS:
340 		IEEE80211_ADDR_COPY(eh->ether_dhost, wh.i_addr3);
341 		IEEE80211_ADDR_COPY(eh->ether_shost, wh.i_addr4);
342 		break;
343 	}
344 #ifndef __NO_STRICT_ALIGNMENT
345 	if (!ALIGNED_POINTER(mtod(m, caddr_t) + sizeof(*eh), uint32_t)) {
346 		m = ieee80211_realign(vap, m, sizeof(*eh));
347 		if (m == NULL)
348 			return NULL;
349 	}
350 #endif /* !__NO_STRICT_ALIGNMENT */
351 	if (llc != NULL) {
352 		eh = mtod(m, struct ether_header *);
353 		eh->ether_type = htons(m->m_pkthdr.len - sizeof(*eh));
354 	}
355 	return m;
356 }
357 
358 /*
359  * Decap a frame encapsulated in a fast-frame/A-MSDU.
360  */
361 struct mbuf *
362 ieee80211_decap1(struct mbuf *m, int *framelen)
363 {
364 #define	FF_LLC_SIZE	(sizeof(struct ether_header) + sizeof(struct llc))
365 	struct ether_header *eh;
366 	struct llc *llc;
367 
368 	/*
369 	 * The frame has an 802.3 header followed by an 802.2
370 	 * LLC header.  The encapsulated frame length is in the
371 	 * first header type field; save that and overwrite it
372 	 * with the true type field found in the second.  Then
373 	 * copy the 802.3 header up to where it belongs and
374 	 * adjust the mbuf contents to remove the void.
375 	 */
376 	if (m->m_len < FF_LLC_SIZE && (m = m_pullup(m, FF_LLC_SIZE)) == NULL)
377 		return NULL;
378 	eh = mtod(m, struct ether_header *);	/* 802.3 header is first */
379 	llc = (struct llc *)&eh[1];		/* 802.2 header follows */
380 	*framelen = ntohs(eh->ether_type)	/* encap'd frame size */
381 		  + sizeof(struct ether_header) - sizeof(struct llc);
382 	eh->ether_type = llc->llc_un.type_snap.ether_type;
383 	ovbcopy(eh, mtod(m, uint8_t *) + sizeof(struct llc),
384 		sizeof(struct ether_header));
385 	m_adj(m, sizeof(struct llc));
386 	return m;
387 #undef FF_LLC_SIZE
388 }
389 
390 /*
391  * Install received rate set information in the node's state block.
392  */
393 int
394 ieee80211_setup_rates(struct ieee80211_node *ni,
395 	const uint8_t *rates, const uint8_t *xrates, int flags)
396 {
397 	struct ieee80211vap *vap = ni->ni_vap;
398 	struct ieee80211_rateset *rs = &ni->ni_rates;
399 
400 	memset(rs, 0, sizeof(*rs));
401 	rs->rs_nrates = rates[1];
402 	memcpy(rs->rs_rates, rates + 2, rs->rs_nrates);
403 	if (xrates != NULL) {
404 		uint8_t nxrates;
405 		/*
406 		 * Tack on 11g extended supported rate element.
407 		 */
408 		nxrates = xrates[1];
409 		if (rs->rs_nrates + nxrates > IEEE80211_RATE_MAXSIZE) {
410 			nxrates = IEEE80211_RATE_MAXSIZE - rs->rs_nrates;
411 			IEEE80211_NOTE(vap, IEEE80211_MSG_XRATE, ni,
412 			    "extended rate set too large; only using "
413 			    "%u of %u rates", nxrates, xrates[1]);
414 			vap->iv_stats.is_rx_rstoobig++;
415 		}
416 		memcpy(rs->rs_rates + rs->rs_nrates, xrates+2, nxrates);
417 		rs->rs_nrates += nxrates;
418 	}
419 	return ieee80211_fix_rate(ni, rs, flags);
420 }
421 
422 /*
423  * Send a management frame error response to the specified
424  * station.  If ni is associated with the station then use
425  * it; otherwise allocate a temporary node suitable for
426  * transmitting the frame and then free the reference so
427  * it will go away as soon as the frame has been transmitted.
428  */
429 void
430 ieee80211_send_error(struct ieee80211_node *ni,
431 	const uint8_t mac[IEEE80211_ADDR_LEN], int subtype, int arg)
432 {
433 	struct ieee80211vap *vap = ni->ni_vap;
434 	int istmp;
435 
436 	if (ni == vap->iv_bss) {
437 		if (vap->iv_state != IEEE80211_S_RUN) {
438 			/*
439 			 * XXX hack until we get rid of this routine.
440 			 * We can be called prior to the vap reaching
441 			 * run state under certain conditions in which
442 			 * case iv_bss->ni_chan will not be setup.
443 			 * Check for this explicitly and and just ignore
444 			 * the request.
445 			 */
446 			return;
447 		}
448 		ni = ieee80211_tmp_node(vap, mac);
449 		if (ni == NULL) {
450 			/* XXX msg */
451 			return;
452 		}
453 		istmp = 1;
454 	} else
455 		istmp = 0;
456 	IEEE80211_SEND_MGMT(ni, subtype, arg);
457 	if (istmp)
458 		ieee80211_free_node(ni);
459 }
460 
461 int
462 ieee80211_alloc_challenge(struct ieee80211_node *ni)
463 {
464 	if (ni->ni_challenge == NULL)
465 		ni->ni_challenge = (uint32_t *)
466 		    IEEE80211_MALLOC(IEEE80211_CHALLENGE_LEN,
467 		      M_80211_NODE, IEEE80211_M_NOWAIT);
468 	if (ni->ni_challenge == NULL) {
469 		IEEE80211_NOTE(ni->ni_vap,
470 		    IEEE80211_MSG_DEBUG | IEEE80211_MSG_AUTH, ni,
471 		    "%s", "shared key challenge alloc failed");
472 		/* XXX statistic */
473 	}
474 	return (ni->ni_challenge != NULL);
475 }
476 
477 /*
478  * Parse a Beacon or ProbeResponse frame and return the
479  * useful information in an ieee80211_scanparams structure.
480  * Status is set to 0 if no problems were found; otherwise
481  * a bitmask of IEEE80211_BPARSE_* items is returned that
482  * describes the problems detected.
483  */
484 int
485 ieee80211_parse_beacon(struct ieee80211_node *ni, struct mbuf *m,
486 	struct ieee80211_channel *rxchan, struct ieee80211_scanparams *scan)
487 {
488 	struct ieee80211vap *vap = ni->ni_vap;
489 	struct ieee80211com *ic = ni->ni_ic;
490 	struct ieee80211_frame *wh;
491 	uint8_t *frm, *efrm;
492 
493 	wh = mtod(m, struct ieee80211_frame *);
494 	frm = (uint8_t *)&wh[1];
495 	efrm = mtod(m, uint8_t *) + m->m_len;
496 	scan->status = 0;
497 	/*
498 	 * beacon/probe response frame format
499 	 *
500 	 * XXX Update from 802.11-2012 - eg where HT is
501 	 *	[8] time stamp
502 	 *	[2] beacon interval
503 	 *	[2] capability information
504 	 *	[tlv] ssid
505 	 *	[tlv] supported rates
506 	 *	[tlv] country information
507 	 *	[tlv] channel switch announcement (CSA)
508 	 *	[tlv] parameter set (FH/DS)
509 	 *	[tlv] erp information
510 	 *	[tlv] extended supported rates
511 	 *	[tlv] WME
512 	 *	[tlv] WPA or RSN
513 	 *	[tlv] HT capabilities
514 	 *	[tlv] HT information
515 	 *	[tlv] VHT capabilities
516 	 *	[tlv] VHT information
517 	 *	[tlv] Atheros capabilities
518 	 *	[tlv] Mesh ID
519 	 *	[tlv] Mesh Configuration
520 	 */
521 	IEEE80211_VERIFY_LENGTH(efrm - frm, 12,
522 	    return (scan->status = IEEE80211_BPARSE_BADIELEN));
523 	memset(scan, 0, sizeof(*scan));
524 	scan->tstamp  = frm;				frm += 8;
525 	scan->bintval = le16toh(*(uint16_t *)frm);	frm += 2;
526 	scan->capinfo = le16toh(*(uint16_t *)frm);	frm += 2;
527 	scan->bchan = ieee80211_chan2ieee(ic, rxchan);
528 	scan->chan = scan->bchan;
529 	scan->ies = frm;
530 	scan->ies_len = efrm - frm;
531 
532 	while (efrm - frm > 1) {
533 		IEEE80211_VERIFY_LENGTH(efrm - frm, frm[1] + 2,
534 		    return (scan->status = IEEE80211_BPARSE_BADIELEN));
535 		switch (*frm) {
536 		case IEEE80211_ELEMID_SSID:
537 			scan->ssid = frm;
538 			break;
539 		case IEEE80211_ELEMID_RATES:
540 			scan->rates = frm;
541 			break;
542 		case IEEE80211_ELEMID_COUNTRY:
543 			scan->country = frm;
544 			break;
545 		case IEEE80211_ELEMID_CSA:
546 			scan->csa = frm;
547 			break;
548 		case IEEE80211_ELEMID_QUIET:
549 			scan->quiet = frm;
550 			break;
551 		case IEEE80211_ELEMID_FHPARMS:
552 			if (ic->ic_phytype == IEEE80211_T_FH) {
553 				scan->fhdwell = le16dec(&frm[2]);
554 				scan->chan = IEEE80211_FH_CHAN(frm[4], frm[5]);
555 				scan->fhindex = frm[6];
556 			}
557 			break;
558 		case IEEE80211_ELEMID_DSPARMS:
559 			/*
560 			 * XXX hack this since depending on phytype
561 			 * is problematic for multi-mode devices.
562 			 */
563 			if (ic->ic_phytype != IEEE80211_T_FH)
564 				scan->chan = frm[2];
565 			break;
566 		case IEEE80211_ELEMID_TIM:
567 			/* XXX ATIM? */
568 			scan->tim = frm;
569 			scan->timoff = frm - mtod(m, uint8_t *);
570 			break;
571 		case IEEE80211_ELEMID_IBSSPARMS:
572 		case IEEE80211_ELEMID_CFPARMS:
573 		case IEEE80211_ELEMID_PWRCNSTR:
574 		case IEEE80211_ELEMID_BSSLOAD:
575 		case IEEE80211_ELEMID_APCHANREP:
576 			/* NB: avoid debugging complaints */
577 			break;
578 		case IEEE80211_ELEMID_XRATES:
579 			scan->xrates = frm;
580 			break;
581 		case IEEE80211_ELEMID_ERP:
582 			if (frm[1] != 1) {
583 				IEEE80211_DISCARD_IE(vap,
584 				    IEEE80211_MSG_ELEMID, wh, "ERP",
585 				    "bad len %u", frm[1]);
586 				vap->iv_stats.is_rx_elem_toobig++;
587 				break;
588 			}
589 			scan->erp = frm[2] | 0x100;
590 			break;
591 		case IEEE80211_ELEMID_HTCAP:
592 			scan->htcap = frm;
593 			break;
594 		case IEEE80211_ELEMID_VHT_CAP:
595 			scan->vhtcap = frm;
596 			break;
597 		case IEEE80211_ELEMID_VHT_OPMODE:
598 			scan->vhtopmode = frm;
599 			break;
600 		case IEEE80211_ELEMID_RSN:
601 			scan->rsn = frm;
602 			break;
603 		case IEEE80211_ELEMID_HTINFO:
604 			scan->htinfo = frm;
605 			break;
606 #ifdef IEEE80211_SUPPORT_MESH
607 		case IEEE80211_ELEMID_MESHID:
608 			scan->meshid = frm;
609 			break;
610 		case IEEE80211_ELEMID_MESHCONF:
611 			scan->meshconf = frm;
612 			break;
613 #endif
614 		/* Extended capabilities; nothing handles it for now */
615 		case IEEE80211_ELEMID_EXTCAP:
616 			break;
617 		case IEEE80211_ELEMID_VENDOR:
618 			if (iswpaoui(frm))
619 				scan->wpa = frm;
620 			else if (iswmeparam(frm) || iswmeinfo(frm))
621 				scan->wme = frm;
622 #ifdef IEEE80211_SUPPORT_SUPERG
623 			else if (isatherosoui(frm))
624 				scan->ath = frm;
625 #endif
626 #ifdef IEEE80211_SUPPORT_TDMA
627 			else if (istdmaoui(frm))
628 				scan->tdma = frm;
629 #endif
630 			else if (vap->iv_flags_ht & IEEE80211_FHT_HTCOMPAT) {
631 				/*
632 				 * Accept pre-draft HT ie's if the
633 				 * standard ones have not been seen.
634 				 */
635 				if (ishtcapoui(frm)) {
636 					if (scan->htcap == NULL)
637 						scan->htcap = frm;
638 				} else if (ishtinfooui(frm)) {
639 					if (scan->htinfo == NULL)
640 						scan->htcap = frm;
641 				}
642 			}
643 			break;
644 		default:
645 			IEEE80211_DISCARD_IE(vap, IEEE80211_MSG_ELEMID,
646 			    wh, "unhandled",
647 			    "id %u, len %u", *frm, frm[1]);
648 			vap->iv_stats.is_rx_elem_unknown++;
649 			break;
650 		}
651 		frm += frm[1] + 2;
652 	}
653 	IEEE80211_VERIFY_ELEMENT(scan->rates, IEEE80211_RATE_MAXSIZE,
654 	    scan->status |= IEEE80211_BPARSE_RATES_INVALID);
655 	if (scan->rates != NULL && scan->xrates != NULL) {
656 		/*
657 		 * NB: don't process XRATES if RATES is missing.  This
658 		 * avoids a potential null ptr deref and should be ok
659 		 * as the return code will already note RATES is missing
660 		 * (so callers shouldn't otherwise process the frame).
661 		 */
662 		IEEE80211_VERIFY_ELEMENT(scan->xrates,
663 		    IEEE80211_RATE_MAXSIZE - scan->rates[1],
664 		    scan->status |= IEEE80211_BPARSE_XRATES_INVALID);
665 	}
666 	IEEE80211_VERIFY_ELEMENT(scan->ssid, IEEE80211_NWID_LEN,
667 	    scan->status |= IEEE80211_BPARSE_SSID_INVALID);
668 	if (scan->chan != scan->bchan && ic->ic_phytype != IEEE80211_T_FH) {
669 		/*
670 		 * Frame was received on a channel different from the
671 		 * one indicated in the DS params element id;
672 		 * silently discard it.
673 		 *
674 		 * NB: this can happen due to signal leakage.
675 		 *     But we should take it for FH phy because
676 		 *     the rssi value should be correct even for
677 		 *     different hop pattern in FH.
678 		 */
679 		IEEE80211_DISCARD(vap,
680 		    IEEE80211_MSG_ELEMID | IEEE80211_MSG_INPUT,
681 		    wh, NULL, "for off-channel %u (bchan=%u)",
682 		    scan->chan, scan->bchan);
683 		vap->iv_stats.is_rx_chanmismatch++;
684 		scan->status |= IEEE80211_BPARSE_OFFCHAN;
685 	}
686 	if (!(IEEE80211_BINTVAL_MIN <= scan->bintval &&
687 	      scan->bintval <= IEEE80211_BINTVAL_MAX)) {
688 		IEEE80211_DISCARD(vap,
689 		    IEEE80211_MSG_ELEMID | IEEE80211_MSG_INPUT,
690 		    wh, NULL, "bogus beacon interval (%d TU)",
691 		    (int) scan->bintval);
692 		vap->iv_stats.is_rx_badbintval++;
693 		scan->status |= IEEE80211_BPARSE_BINTVAL_INVALID;
694 	}
695 	if (scan->country != NULL) {
696 		/*
697 		 * Validate we have at least enough data to extract
698 		 * the country code.  Not sure if we should return an
699 		 * error instead of discarding the IE; consider this
700 		 * being lenient as we don't depend on the data for
701 		 * correct operation.
702 		 */
703 		IEEE80211_VERIFY_LENGTH(scan->country[1], 3 * sizeof(uint8_t),
704 		    scan->country = NULL);
705 	}
706 	if (scan->csa != NULL) {
707 		/*
708 		 * Validate Channel Switch Announcement; this must
709 		 * be the correct length or we toss the frame.
710 		 */
711 		IEEE80211_VERIFY_LENGTH(scan->csa[1], 3 * sizeof(uint8_t),
712 		    scan->status |= IEEE80211_BPARSE_CSA_INVALID);
713 	}
714 	/*
715 	 * Process HT ie's.  This is complicated by our
716 	 * accepting both the standard ie's and the pre-draft
717 	 * vendor OUI ie's that some vendors still use/require.
718 	 */
719 	if (scan->htcap != NULL) {
720 		IEEE80211_VERIFY_LENGTH(scan->htcap[1],
721 		     scan->htcap[0] == IEEE80211_ELEMID_VENDOR ?
722 			 4 + sizeof(struct ieee80211_ie_htcap)-2 :
723 			 sizeof(struct ieee80211_ie_htcap)-2,
724 		     scan->htcap = NULL);
725 	}
726 	if (scan->htinfo != NULL) {
727 		IEEE80211_VERIFY_LENGTH(scan->htinfo[1],
728 		     scan->htinfo[0] == IEEE80211_ELEMID_VENDOR ?
729 			 4 + sizeof(struct ieee80211_ie_htinfo)-2 :
730 			 sizeof(struct ieee80211_ie_htinfo)-2,
731 		     scan->htinfo = NULL);
732 	}
733 
734 	/* Process VHT IEs */
735 	if (scan->vhtcap != NULL) {
736 		IEEE80211_VERIFY_LENGTH(scan->vhtcap[1],
737 		    sizeof(struct ieee80211_ie_vhtcap) - 2,
738 		    scan->vhtcap = NULL);
739 	}
740 	if (scan->vhtopmode != NULL) {
741 		IEEE80211_VERIFY_LENGTH(scan->vhtopmode[1],
742 		    sizeof(struct ieee80211_ie_vht_operation) - 2,
743 		    scan->vhtopmode = NULL);
744 	}
745 
746 	return scan->status;
747 }
748 
749 /*
750  * Parse an Action frame.  Return 0 on success, non-zero on failure.
751  */
752 int
753 ieee80211_parse_action(struct ieee80211_node *ni, struct mbuf *m)
754 {
755 	struct ieee80211vap *vap = ni->ni_vap;
756 	const struct ieee80211_action *ia;
757 	struct ieee80211_frame *wh;
758 	uint8_t *frm, *efrm;
759 
760 	/*
761 	 * action frame format:
762 	 *	[1] category
763 	 *	[1] action
764 	 *	[tlv] parameters
765 	 */
766 	wh = mtod(m, struct ieee80211_frame *);
767 	frm = (u_int8_t *)&wh[1];
768 	efrm = mtod(m, u_int8_t *) + m->m_len;
769 	IEEE80211_VERIFY_LENGTH(efrm - frm,
770 		sizeof(struct ieee80211_action), return EINVAL);
771 	ia = (const struct ieee80211_action *) frm;
772 
773 	vap->iv_stats.is_rx_action++;
774 	IEEE80211_NODE_STAT(ni, rx_action);
775 
776 	/* verify frame payloads but defer processing */
777 	switch (ia->ia_category) {
778 	case IEEE80211_ACTION_CAT_BA:
779 		switch (ia->ia_action) {
780 		case IEEE80211_ACTION_BA_ADDBA_REQUEST:
781 			IEEE80211_VERIFY_LENGTH(efrm - frm,
782 			    sizeof(struct ieee80211_action_ba_addbarequest),
783 			    return EINVAL);
784 			break;
785 		case IEEE80211_ACTION_BA_ADDBA_RESPONSE:
786 			IEEE80211_VERIFY_LENGTH(efrm - frm,
787 			    sizeof(struct ieee80211_action_ba_addbaresponse),
788 			    return EINVAL);
789 			break;
790 		case IEEE80211_ACTION_BA_DELBA:
791 			IEEE80211_VERIFY_LENGTH(efrm - frm,
792 			    sizeof(struct ieee80211_action_ba_delba),
793 			    return EINVAL);
794 			break;
795 		}
796 		break;
797 	case IEEE80211_ACTION_CAT_HT:
798 		switch (ia->ia_action) {
799 		case IEEE80211_ACTION_HT_TXCHWIDTH:
800 			IEEE80211_VERIFY_LENGTH(efrm - frm,
801 			    sizeof(struct ieee80211_action_ht_txchwidth),
802 			    return EINVAL);
803 			break;
804 		case IEEE80211_ACTION_HT_MIMOPWRSAVE:
805 			IEEE80211_VERIFY_LENGTH(efrm - frm,
806 			    sizeof(struct ieee80211_action_ht_mimopowersave),
807 			    return EINVAL);
808 			break;
809 		}
810 		break;
811 #ifdef IEEE80211_SUPPORT_MESH
812 	case IEEE80211_ACTION_CAT_MESH:
813 		switch (ia->ia_action) {
814 		case IEEE80211_ACTION_MESH_LMETRIC:
815 			/*
816 			 * XXX: verification is true only if we are using
817 			 * Airtime link metric (default)
818 			 */
819 			IEEE80211_VERIFY_LENGTH(efrm - frm,
820 			    sizeof(struct ieee80211_meshlmetric_ie),
821 			    return EINVAL);
822 			break;
823 		case IEEE80211_ACTION_MESH_HWMP:
824 			/* verify something */
825 			break;
826 		case IEEE80211_ACTION_MESH_GANN:
827 			IEEE80211_VERIFY_LENGTH(efrm - frm,
828 			    sizeof(struct ieee80211_meshgann_ie),
829 			    return EINVAL);
830 			break;
831 		case IEEE80211_ACTION_MESH_CC:
832 		case IEEE80211_ACTION_MESH_MCCA_SREQ:
833 		case IEEE80211_ACTION_MESH_MCCA_SREP:
834 		case IEEE80211_ACTION_MESH_MCCA_AREQ:
835 		case IEEE80211_ACTION_MESH_MCCA_ADVER:
836 		case IEEE80211_ACTION_MESH_MCCA_TRDOWN:
837 		case IEEE80211_ACTION_MESH_TBTT_REQ:
838 		case IEEE80211_ACTION_MESH_TBTT_RES:
839 			/* reject these early on, not implemented */
840 			IEEE80211_DISCARD(vap,
841 			    IEEE80211_MSG_ELEMID | IEEE80211_MSG_INPUT,
842 			    wh, NULL, "not implemented yet, act=0x%02X",
843 			    ia->ia_action);
844 			return EINVAL;
845 		}
846 		break;
847 	case IEEE80211_ACTION_CAT_SELF_PROT:
848 		/* If TA or RA group address discard silently */
849 		if (IEEE80211_IS_MULTICAST(wh->i_addr1) ||
850 			IEEE80211_IS_MULTICAST(wh->i_addr2))
851 			return EINVAL;
852 		/*
853 		 * XXX: Should we verify complete length now or it is
854 		 * to varying in sizes?
855 		 */
856 		switch (ia->ia_action) {
857 		case IEEE80211_ACTION_MESHPEERING_CONFIRM:
858 		case IEEE80211_ACTION_MESHPEERING_CLOSE:
859 			/* is not a peering candidate (yet) */
860 			if (ni == vap->iv_bss)
861 				return EINVAL;
862 			break;
863 		}
864 		break;
865 #endif
866 	case IEEE80211_ACTION_CAT_VHT:
867 		printf("%s: TODO: VHT handling!\n", __func__);
868 		break;
869 	}
870 	return 0;
871 }
872 
873 #ifdef IEEE80211_DEBUG
874 /*
875  * Debugging support.
876  */
877 void
878 ieee80211_ssid_mismatch(struct ieee80211vap *vap, const char *tag,
879 	uint8_t mac[IEEE80211_ADDR_LEN], uint8_t *ssid)
880 {
881 	printf("[%s] discard %s frame, ssid mismatch: ",
882 		ether_sprintf(mac), tag);
883 	ieee80211_print_essid(ssid + 2, ssid[1]);
884 	printf("\n");
885 }
886 
887 /*
888  * Return the bssid of a frame.
889  */
890 static const uint8_t *
891 ieee80211_getbssid(const struct ieee80211vap *vap,
892 	const struct ieee80211_frame *wh)
893 {
894 	if (vap->iv_opmode == IEEE80211_M_STA)
895 		return wh->i_addr2;
896 	if ((wh->i_fc[1] & IEEE80211_FC1_DIR_MASK) != IEEE80211_FC1_DIR_NODS)
897 		return wh->i_addr1;
898 	if ((wh->i_fc[0] & IEEE80211_FC0_SUBTYPE_MASK) == IEEE80211_FC0_SUBTYPE_PS_POLL)
899 		return wh->i_addr1;
900 	return wh->i_addr3;
901 }
902 
903 #include <machine/stdarg.h>
904 
905 void
906 ieee80211_note(const struct ieee80211vap *vap, const char *fmt, ...)
907 {
908 	char buf[128];		/* XXX */
909 	va_list ap;
910 
911 	va_start(ap, fmt);
912 	vsnprintf(buf, sizeof(buf), fmt, ap);
913 	va_end(ap);
914 
915 	if_printf(vap->iv_ifp, "%s", buf);	/* NB: no \n */
916 }
917 
918 void
919 ieee80211_note_frame(const struct ieee80211vap *vap,
920 	const struct ieee80211_frame *wh,
921 	const char *fmt, ...)
922 {
923 	char buf[128];		/* XXX */
924 	va_list ap;
925 
926 	va_start(ap, fmt);
927 	vsnprintf(buf, sizeof(buf), fmt, ap);
928 	va_end(ap);
929 	if_printf(vap->iv_ifp, "[%s] %s\n",
930 		ether_sprintf(ieee80211_getbssid(vap, wh)), buf);
931 }
932 
933 void
934 ieee80211_note_mac(const struct ieee80211vap *vap,
935 	const uint8_t mac[IEEE80211_ADDR_LEN],
936 	const char *fmt, ...)
937 {
938 	char buf[128];		/* XXX */
939 	va_list ap;
940 
941 	va_start(ap, fmt);
942 	vsnprintf(buf, sizeof(buf), fmt, ap);
943 	va_end(ap);
944 	if_printf(vap->iv_ifp, "[%s] %s\n", ether_sprintf(mac), buf);
945 }
946 
947 void
948 ieee80211_discard_frame(const struct ieee80211vap *vap,
949 	const struct ieee80211_frame *wh,
950 	const char *type, const char *fmt, ...)
951 {
952 	va_list ap;
953 
954 	if_printf(vap->iv_ifp, "[%s] discard ",
955 		ether_sprintf(ieee80211_getbssid(vap, wh)));
956 	printf("%s frame, ", type != NULL ? type :
957 	    ieee80211_mgt_subtype_name(wh->i_fc[0]));
958 	va_start(ap, fmt);
959 	vprintf(fmt, ap);
960 	va_end(ap);
961 	printf("\n");
962 }
963 
964 void
965 ieee80211_discard_ie(const struct ieee80211vap *vap,
966 	const struct ieee80211_frame *wh,
967 	const char *type, const char *fmt, ...)
968 {
969 	va_list ap;
970 
971 	if_printf(vap->iv_ifp, "[%s] discard ",
972 		ether_sprintf(ieee80211_getbssid(vap, wh)));
973 	if (type != NULL)
974 		printf("%s information element, ", type);
975 	else
976 		printf("information element, ");
977 	va_start(ap, fmt);
978 	vprintf(fmt, ap);
979 	va_end(ap);
980 	printf("\n");
981 }
982 
983 void
984 ieee80211_discard_mac(const struct ieee80211vap *vap,
985 	const uint8_t mac[IEEE80211_ADDR_LEN],
986 	const char *type, const char *fmt, ...)
987 {
988 	va_list ap;
989 
990 	if_printf(vap->iv_ifp, "[%s] discard ", ether_sprintf(mac));
991 	if (type != NULL)
992 		printf("%s frame, ", type);
993 	else
994 		printf("frame, ");
995 	va_start(ap, fmt);
996 	vprintf(fmt, ap);
997 	va_end(ap);
998 	printf("\n");
999 }
1000 #endif /* IEEE80211_DEBUG */
1001