xref: /haiku/src/libs/compat/freebsd_wlan/net80211/ieee80211_input.c (revision b8a45b3a2df2379b4301bf3bd5949b9a105be4ba)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
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 #include "opt_wlan.h"
31 
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/mbuf.h>
35 #include <sys/malloc.h>
36 #include <sys/endian.h>
37 #include <sys/kernel.h>
38 #include <sys/epoch.h>
39 
40 #include <sys/socket.h>
41 
42 #include <net/ethernet.h>
43 #include <net/if.h>
44 #include <net/if_var.h>
45 #include <net/if_llc.h>
46 #include <net/if_media.h>
47 #include <net/if_private.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, IEEE80211_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 	int has_decrypted)
175 {
176 	struct ieee80211vap *vap = ni->ni_vap;
177 	struct ieee80211_frame *wh = mtod(m, struct ieee80211_frame *);
178 	struct ieee80211_frame *lwh;
179 	uint16_t rxseq;
180 	uint8_t fragno;
181 	uint8_t more_frag = wh->i_fc[1] & IEEE80211_FC1_MORE_FRAG;
182 	struct mbuf *mfrag;
183 
184 	KASSERT(!IEEE80211_IS_MULTICAST(wh->i_addr1), ("multicast fragm?"));
185 
186 	rxseq = le16toh(*(uint16_t *)wh->i_seq);
187 	fragno = rxseq & IEEE80211_SEQ_FRAG_MASK;
188 
189 	/* Quick way out, if there's nothing to defragment */
190 	if (!more_frag && fragno == 0 && ni->ni_rxfrag[0] == NULL)
191 		return m;
192 
193 	/* Temporarily set flag to remember if fragment was encrypted. */
194 	/* XXX use a non-packet altering storage for this in the future. */
195 	if (has_decrypted)
196 		wh->i_fc[1] |= IEEE80211_FC1_PROTECTED;
197 
198 	/*
199 	 * Remove frag to insure it doesn't get reaped by timer.
200 	 */
201 	if (ni->ni_table == NULL) {
202 		/*
203 		 * Should never happen.  If the node is orphaned (not in
204 		 * the table) then input packets should not reach here.
205 		 * Otherwise, a concurrent request that yanks the table
206 		 * should be blocked by other interlocking and/or by first
207 		 * shutting the driver down.  Regardless, be defensive
208 		 * here and just bail
209 		 */
210 		/* XXX need msg+stat */
211 		m_freem(m);
212 		return NULL;
213 	}
214 	IEEE80211_NODE_LOCK(ni->ni_table);
215 	mfrag = ni->ni_rxfrag[0];
216 	ni->ni_rxfrag[0] = NULL;
217 	IEEE80211_NODE_UNLOCK(ni->ni_table);
218 
219 	/*
220 	 * Validate new fragment is in order and
221 	 * related to the previous ones.
222 	 */
223 	if (mfrag != NULL) {
224 		uint16_t last_rxseq;
225 
226 		lwh = mtod(mfrag, struct ieee80211_frame *);
227 		last_rxseq = le16toh(*(uint16_t *)lwh->i_seq);
228 		/*
229 		 * NB: check seq # and frag together. Also check that both
230 		 * fragments are plaintext or that both are encrypted.
231 		 */
232 		if (rxseq == last_rxseq+1 &&
233 		    IEEE80211_ADDR_EQ(wh->i_addr1, lwh->i_addr1) &&
234 		    IEEE80211_ADDR_EQ(wh->i_addr2, lwh->i_addr2) &&
235 		    !((wh->i_fc[1] ^ lwh->i_fc[1]) & IEEE80211_FC1_PROTECTED)) {
236 			/* XXX clear MORE_FRAG bit? */
237 			/* track last seqnum and fragno */
238 			*(uint16_t *) lwh->i_seq = *(uint16_t *) wh->i_seq;
239 
240 			m_adj(m, hdrspace);		/* strip header */
241 			m_catpkt(mfrag, m);		/* concatenate */
242 		} else {
243 			/*
244 			 * Unrelated fragment or no space for it,
245 			 * clear current fragments.
246 			 */
247 			m_freem(mfrag);
248 			mfrag = NULL;
249 		}
250 	}
251 
252  	if (mfrag == NULL) {
253 		if (fragno != 0) {		/* !first fragment, discard */
254 			vap->iv_stats.is_rx_defrag++;
255 			IEEE80211_NODE_STAT(ni, rx_defrag);
256 			m_freem(m);
257 			return NULL;
258 		}
259 		mfrag = m;
260 	}
261 	if (more_frag) {			/* more to come, save */
262 		ni->ni_rxfragstamp = ticks;
263 		ni->ni_rxfrag[0] = mfrag;
264 		mfrag = NULL;
265 	}
266 	/* Remember to clear protected flag that was temporarily set. */
267 	if (mfrag != NULL) {
268 		wh = mtod(mfrag, struct ieee80211_frame *);
269 		wh->i_fc[1] &= ~IEEE80211_FC1_PROTECTED;
270 	}
271 	return mfrag;
272 }
273 
274 void
275 ieee80211_deliver_data(struct ieee80211vap *vap,
276 	struct ieee80211_node *ni, struct mbuf *m)
277 {
278 	struct epoch_tracker et;
279 	struct ether_header *eh = mtod(m, struct ether_header *);
280 	struct ifnet *ifp = vap->iv_ifp;
281 
282 	/* clear driver/net80211 flags before passing up */
283 	m->m_flags &= ~(M_MCAST | M_BCAST);
284 	m_clrprotoflags(m);
285 
286 	/* NB: see hostap_deliver_data, this path doesn't handle hostap */
287 	KASSERT(vap->iv_opmode != IEEE80211_M_HOSTAP, ("gack, hostap"));
288 	/*
289 	 * Do accounting.
290 	 */
291 	if_inc_counter(ifp, IFCOUNTER_IPACKETS, 1);
292 	IEEE80211_NODE_STAT(ni, rx_data);
293 	IEEE80211_NODE_STAT_ADD(ni, rx_bytes, m->m_pkthdr.len);
294 	if (ETHER_IS_MULTICAST(eh->ether_dhost)) {
295 		if (ETHER_IS_BROADCAST(eh->ether_dhost))
296 			m->m_flags |= M_BCAST;
297 		else
298 			m->m_flags |= M_MCAST;
299 		IEEE80211_NODE_STAT(ni, rx_mcast);
300 	} else
301 		IEEE80211_NODE_STAT(ni, rx_ucast);
302 	m->m_pkthdr.rcvif = ifp;
303 
304 	if (ni->ni_vlan != 0) {
305 		/* attach vlan tag */
306 		m->m_pkthdr.ether_vtag = ni->ni_vlan;
307 		m->m_flags |= M_VLANTAG;
308 	}
309 	NET_EPOCH_ENTER(et);
310 	ifp->if_input(ifp, m);
311 	NET_EPOCH_EXIT(et);
312 }
313 
314 struct mbuf *
315 ieee80211_decap(struct ieee80211vap *vap, struct mbuf *m, int hdrlen,
316 	uint8_t qos)
317 {
318 	struct ieee80211_qosframe_addr4 wh;
319 	struct ether_header *eh;
320 	struct llc *llc;
321 
322 	KASSERT(hdrlen <= sizeof(wh),
323 	    ("hdrlen %d > max %zd", hdrlen, sizeof(wh)));
324 
325 	if (m->m_len < hdrlen + sizeof(*llc) &&
326 	    (m = m_pullup(m, hdrlen + sizeof(*llc))) == NULL) {
327 		vap->iv_stats.is_rx_tooshort++;
328 		/* XXX msg */
329 		return NULL;
330 	}
331 	memcpy(&wh, mtod(m, caddr_t), hdrlen);
332 	llc = (struct llc *)(mtod(m, caddr_t) + hdrlen);
333 	if (llc->llc_dsap == LLC_SNAP_LSAP && llc->llc_ssap == LLC_SNAP_LSAP &&
334 	    llc->llc_control == LLC_UI && llc->llc_snap.org_code[0] == 0 &&
335 	    llc->llc_snap.org_code[1] == 0 && llc->llc_snap.org_code[2] == 0 &&
336 	    /* NB: preserve AppleTalk frames that have a native SNAP hdr */
337 	    !(llc->llc_snap.ether_type == htons(ETHERTYPE_AARP) ||
338 	      llc->llc_snap.ether_type == htons(ETHERTYPE_IPX)) &&
339 	    /* Do not want to touch A-MSDU frames. */
340 	    !(qos & IEEE80211_QOS_AMSDU)) {
341 		m_adj(m, hdrlen + sizeof(struct llc) - sizeof(*eh));
342 		llc = NULL;
343 	} else {
344 		m_adj(m, hdrlen - sizeof(*eh));
345 	}
346 	eh = mtod(m, struct ether_header *);
347 	switch (wh.i_fc[1] & IEEE80211_FC1_DIR_MASK) {
348 	case IEEE80211_FC1_DIR_NODS:
349 		IEEE80211_ADDR_COPY(eh->ether_dhost, wh.i_addr1);
350 		IEEE80211_ADDR_COPY(eh->ether_shost, wh.i_addr2);
351 		break;
352 	case IEEE80211_FC1_DIR_TODS:
353 		IEEE80211_ADDR_COPY(eh->ether_dhost, wh.i_addr3);
354 		IEEE80211_ADDR_COPY(eh->ether_shost, wh.i_addr2);
355 		break;
356 	case IEEE80211_FC1_DIR_FROMDS:
357 		IEEE80211_ADDR_COPY(eh->ether_dhost, wh.i_addr1);
358 		IEEE80211_ADDR_COPY(eh->ether_shost, wh.i_addr3);
359 		break;
360 	case IEEE80211_FC1_DIR_DSTODS:
361 		IEEE80211_ADDR_COPY(eh->ether_dhost, wh.i_addr3);
362 		IEEE80211_ADDR_COPY(eh->ether_shost, wh.i_addr4);
363 		break;
364 	}
365 #ifndef __NO_STRICT_ALIGNMENT
366 	if (!ALIGNED_POINTER(mtod(m, caddr_t) + sizeof(*eh), uint32_t)) {
367 		m = ieee80211_realign(vap, m, sizeof(*eh));
368 		if (m == NULL)
369 			return NULL;
370 	}
371 #endif /* !__NO_STRICT_ALIGNMENT */
372 	if (llc != NULL) {
373 		eh = mtod(m, struct ether_header *);
374 		eh->ether_type = htons(m->m_pkthdr.len - sizeof(*eh));
375 	}
376 	return m;
377 }
378 
379 /*
380  * Decap a frame encapsulated in a fast-frame/A-MSDU.
381  */
382 struct mbuf *
383 ieee80211_decap1(struct mbuf *m, int *framelen)
384 {
385 #define	FF_LLC_SIZE	(sizeof(struct ether_header) + sizeof(struct llc))
386 	struct ether_header *eh;
387 	struct llc *llc;
388 	const uint8_t llc_hdr_mac[ETHER_ADDR_LEN] = {
389 		/* MAC address matching the 802.2 LLC header */
390 		LLC_SNAP_LSAP, LLC_SNAP_LSAP, LLC_UI, 0, 0, 0
391 	};
392 
393 	/*
394 	 * The frame has an 802.3 header followed by an 802.2
395 	 * LLC header.  The encapsulated frame length is in the
396 	 * first header type field; save that and overwrite it
397 	 * with the true type field found in the second.  Then
398 	 * copy the 802.3 header up to where it belongs and
399 	 * adjust the mbuf contents to remove the void.
400 	 */
401 	if (m->m_len < FF_LLC_SIZE && (m = m_pullup(m, FF_LLC_SIZE)) == NULL)
402 		return NULL;
403 	eh = mtod(m, struct ether_header *);	/* 802.3 header is first */
404 
405 	/*
406 	 * Detect possible attack where a single 802.11 frame is processed
407 	 * as an A-MSDU frame due to an adversary setting the A-MSDU present
408 	 * bit in the 802.11 QoS header. [FragAttacks]
409 	 */
410 	if (memcmp(eh->ether_dhost, llc_hdr_mac, ETHER_ADDR_LEN) == 0)
411 		return NULL;
412 
413 	llc = (struct llc *)&eh[1];		/* 802.2 header follows */
414 	*framelen = ntohs(eh->ether_type)	/* encap'd frame size */
415 		  + sizeof(struct ether_header) - sizeof(struct llc);
416 	eh->ether_type = llc->llc_un.type_snap.ether_type;
417 	ovbcopy(eh, mtod(m, uint8_t *) + sizeof(struct llc),
418 		sizeof(struct ether_header));
419 	m_adj(m, sizeof(struct llc));
420 	return m;
421 #undef FF_LLC_SIZE
422 }
423 
424 /*
425  * Install received rate set information in the node's state block.
426  */
427 int
428 ieee80211_setup_rates(struct ieee80211_node *ni,
429 	const uint8_t *rates, const uint8_t *xrates, int flags)
430 {
431 	struct ieee80211vap *vap = ni->ni_vap;
432 	struct ieee80211_rateset *rs = &ni->ni_rates;
433 
434 	memset(rs, 0, sizeof(*rs));
435 	rs->rs_nrates = rates[1];
436 	memcpy(rs->rs_rates, rates + 2, rs->rs_nrates);
437 	if (xrates != NULL) {
438 		uint8_t nxrates;
439 		/*
440 		 * Tack on 11g extended supported rate element.
441 		 */
442 		nxrates = xrates[1];
443 		if (rs->rs_nrates + nxrates > IEEE80211_RATE_MAXSIZE) {
444 			nxrates = IEEE80211_RATE_MAXSIZE - rs->rs_nrates;
445 			IEEE80211_NOTE(vap, IEEE80211_MSG_XRATE, ni,
446 			    "extended rate set too large; only using "
447 			    "%u of %u rates", nxrates, xrates[1]);
448 			vap->iv_stats.is_rx_rstoobig++;
449 		}
450 		memcpy(rs->rs_rates + rs->rs_nrates, xrates+2, nxrates);
451 		rs->rs_nrates += nxrates;
452 	}
453 	return ieee80211_fix_rate(ni, rs, flags);
454 }
455 
456 /*
457  * Send a management frame error response to the specified
458  * station.  If ni is associated with the station then use
459  * it; otherwise allocate a temporary node suitable for
460  * transmitting the frame and then free the reference so
461  * it will go away as soon as the frame has been transmitted.
462  */
463 void
464 ieee80211_send_error(struct ieee80211_node *ni,
465 	const uint8_t mac[IEEE80211_ADDR_LEN], int subtype, int arg)
466 {
467 	struct ieee80211vap *vap = ni->ni_vap;
468 	int istmp;
469 
470 	if (ni == vap->iv_bss) {
471 		if (vap->iv_state != IEEE80211_S_RUN) {
472 			/*
473 			 * XXX hack until we get rid of this routine.
474 			 * We can be called prior to the vap reaching
475 			 * run state under certain conditions in which
476 			 * case iv_bss->ni_chan will not be setup.
477 			 * Check for this explicitly and and just ignore
478 			 * the request.
479 			 */
480 			return;
481 		}
482 		ni = ieee80211_tmp_node(vap, mac);
483 		if (ni == NULL) {
484 			/* XXX msg */
485 			return;
486 		}
487 		istmp = 1;
488 	} else
489 		istmp = 0;
490 	IEEE80211_SEND_MGMT(ni, subtype, arg);
491 	if (istmp)
492 		ieee80211_free_node(ni);
493 }
494 
495 int
496 ieee80211_alloc_challenge(struct ieee80211_node *ni)
497 {
498 	if (ni->ni_challenge == NULL)
499 		ni->ni_challenge = (uint32_t *)
500 		    IEEE80211_MALLOC(IEEE80211_CHALLENGE_LEN,
501 		      M_80211_NODE, IEEE80211_M_NOWAIT);
502 	if (ni->ni_challenge == NULL) {
503 		IEEE80211_NOTE(ni->ni_vap,
504 		    IEEE80211_MSG_DEBUG | IEEE80211_MSG_AUTH, ni,
505 		    "%s", "shared key challenge alloc failed");
506 		/* XXX statistic */
507 	}
508 	return (ni->ni_challenge != NULL);
509 }
510 
511 /*
512  * Parse a Beacon or ProbeResponse frame and return the
513  * useful information in an ieee80211_scanparams structure.
514  * Status is set to 0 if no problems were found; otherwise
515  * a bitmask of IEEE80211_BPARSE_* items is returned that
516  * describes the problems detected.
517  */
518 int
519 ieee80211_parse_beacon(struct ieee80211_node *ni, struct mbuf *m,
520 	struct ieee80211_channel *rxchan, struct ieee80211_scanparams *scan)
521 {
522 	struct ieee80211vap *vap = ni->ni_vap;
523 	struct ieee80211com *ic = ni->ni_ic;
524 	struct ieee80211_frame *wh;
525 	uint8_t *frm, *efrm;
526 
527 	wh = mtod(m, struct ieee80211_frame *);
528 	frm = (uint8_t *)&wh[1];
529 	efrm = mtod(m, uint8_t *) + m->m_len;
530 	scan->status = 0;
531 	/*
532 	 * beacon/probe response frame format
533 	 *
534 	 * XXX Update from 802.11-2012 - eg where HT is
535 	 *	[8] time stamp
536 	 *	[2] beacon interval
537 	 *	[2] capability information
538 	 *	[tlv] ssid
539 	 *	[tlv] supported rates
540 	 *	[tlv] country information
541 	 *	[tlv] channel switch announcement (CSA)
542 	 *	[tlv] parameter set (FH/DS)
543 	 *	[tlv] erp information
544 	 *	[tlv] extended supported rates
545 	 *	[tlv] WME
546 	 *	[tlv] WPA or RSN
547 	 *	[tlv] HT capabilities
548 	 *	[tlv] HT information
549 	 *	[tlv] VHT capabilities
550 	 *	[tlv] VHT information
551 	 *	[tlv] Atheros capabilities
552 	 *	[tlv] Mesh ID
553 	 *	[tlv] Mesh Configuration
554 	 */
555 	IEEE80211_VERIFY_LENGTH(efrm - frm, 12,
556 	    return (scan->status = IEEE80211_BPARSE_BADIELEN));
557 	memset(scan, 0, sizeof(*scan));
558 	scan->tstamp  = frm;				frm += 8;
559 	scan->bintval = le16toh(*(uint16_t *)frm);	frm += 2;
560 	scan->capinfo = le16toh(*(uint16_t *)frm);	frm += 2;
561 	scan->bchan = ieee80211_chan2ieee(ic, rxchan);
562 	scan->chan = scan->bchan;
563 	scan->ies = frm;
564 	scan->ies_len = efrm - frm;
565 
566 	while (efrm - frm > 1) {
567 		IEEE80211_VERIFY_LENGTH(efrm - frm, frm[1] + 2,
568 		    return (scan->status = IEEE80211_BPARSE_BADIELEN));
569 		switch (*frm) {
570 		case IEEE80211_ELEMID_SSID:
571 			scan->ssid = frm;
572 			break;
573 		case IEEE80211_ELEMID_RATES:
574 			scan->rates = frm;
575 			break;
576 		case IEEE80211_ELEMID_COUNTRY:
577 			scan->country = frm;
578 			break;
579 		case IEEE80211_ELEMID_CSA:
580 			scan->csa = frm;
581 			break;
582 		case IEEE80211_ELEMID_QUIET:
583 			scan->quiet = frm;
584 			break;
585 		case IEEE80211_ELEMID_FHPARMS:
586 			if (ic->ic_phytype == IEEE80211_T_FH) {
587 				scan->fhdwell = le16dec(&frm[2]);
588 				scan->chan = IEEE80211_FH_CHAN(frm[4], frm[5]);
589 				scan->fhindex = frm[6];
590 			}
591 			break;
592 		case IEEE80211_ELEMID_DSPARMS:
593 			/*
594 			 * XXX hack this since depending on phytype
595 			 * is problematic for multi-mode devices.
596 			 */
597 			if (ic->ic_phytype != IEEE80211_T_FH)
598 				scan->chan = frm[2];
599 			break;
600 		case IEEE80211_ELEMID_TIM:
601 			/* XXX ATIM? */
602 			scan->tim = frm;
603 			scan->timoff = frm - mtod(m, uint8_t *);
604 			break;
605 		case IEEE80211_ELEMID_IBSSPARMS:
606 		case IEEE80211_ELEMID_CFPARMS:
607 		case IEEE80211_ELEMID_PWRCNSTR:
608 		case IEEE80211_ELEMID_BSSLOAD:
609 		case IEEE80211_ELEMID_APCHANREP:
610 			/* NB: avoid debugging complaints */
611 			break;
612 		case IEEE80211_ELEMID_XRATES:
613 			scan->xrates = frm;
614 			break;
615 		case IEEE80211_ELEMID_ERP:
616 			if (frm[1] != 1) {
617 				IEEE80211_DISCARD_IE(vap,
618 				    IEEE80211_MSG_ELEMID, wh, "ERP",
619 				    "bad len %u", frm[1]);
620 				vap->iv_stats.is_rx_elem_toobig++;
621 				break;
622 			}
623 			scan->erp = frm[2] | 0x100;
624 			break;
625 		case IEEE80211_ELEMID_HTCAP:
626 			scan->htcap = frm;
627 			break;
628 		case IEEE80211_ELEMID_VHT_CAP:
629 			scan->vhtcap = frm;
630 			break;
631 		case IEEE80211_ELEMID_VHT_OPMODE:
632 			scan->vhtopmode = frm;
633 			break;
634 		case IEEE80211_ELEMID_RSN:
635 			scan->rsn = frm;
636 			break;
637 		case IEEE80211_ELEMID_HTINFO:
638 			scan->htinfo = frm;
639 			break;
640 #ifdef IEEE80211_SUPPORT_MESH
641 		case IEEE80211_ELEMID_MESHID:
642 			scan->meshid = frm;
643 			break;
644 		case IEEE80211_ELEMID_MESHCONF:
645 			scan->meshconf = frm;
646 			break;
647 #endif
648 		/* Extended capabilities; nothing handles it for now */
649 		case IEEE80211_ELEMID_EXTCAP:
650 			break;
651 		case IEEE80211_ELEMID_VENDOR:
652 			if (iswpaoui(frm))
653 				scan->wpa = frm;
654 			else if (iswmeparam(frm) || iswmeinfo(frm))
655 				scan->wme = frm;
656 #ifdef IEEE80211_SUPPORT_SUPERG
657 			else if (isatherosoui(frm))
658 				scan->ath = frm;
659 #endif
660 #ifdef IEEE80211_SUPPORT_TDMA
661 			else if (istdmaoui(frm))
662 				scan->tdma = frm;
663 #endif
664 			else if (vap->iv_flags_ht & IEEE80211_FHT_HTCOMPAT) {
665 				/*
666 				 * Accept pre-draft HT ie's if the
667 				 * standard ones have not been seen.
668 				 */
669 				if (ishtcapoui(frm)) {
670 					if (scan->htcap == NULL)
671 						scan->htcap = frm;
672 				} else if (ishtinfooui(frm)) {
673 					if (scan->htinfo == NULL)
674 						scan->htcap = frm;
675 				}
676 			}
677 			break;
678 		default:
679 			IEEE80211_DISCARD_IE(vap, IEEE80211_MSG_ELEMID,
680 			    wh, "unhandled",
681 			    "id %u, len %u", *frm, frm[1]);
682 			vap->iv_stats.is_rx_elem_unknown++;
683 			break;
684 		}
685 		frm += frm[1] + 2;
686 	}
687 	IEEE80211_VERIFY_ELEMENT(scan->rates, IEEE80211_RATE_MAXSIZE,
688 	    scan->status |= IEEE80211_BPARSE_RATES_INVALID);
689 	if (scan->rates != NULL && scan->xrates != NULL) {
690 		/*
691 		 * NB: don't process XRATES if RATES is missing.  This
692 		 * avoids a potential null ptr deref and should be ok
693 		 * as the return code will already note RATES is missing
694 		 * (so callers shouldn't otherwise process the frame).
695 		 */
696 		IEEE80211_VERIFY_ELEMENT(scan->xrates,
697 		    IEEE80211_RATE_MAXSIZE - scan->rates[1],
698 		    scan->status |= IEEE80211_BPARSE_XRATES_INVALID);
699 	}
700 	IEEE80211_VERIFY_ELEMENT(scan->ssid, IEEE80211_NWID_LEN,
701 	    scan->status |= IEEE80211_BPARSE_SSID_INVALID);
702 	if (scan->chan != scan->bchan && ic->ic_phytype != IEEE80211_T_FH) {
703 		/*
704 		 * Frame was received on a channel different from the
705 		 * one indicated in the DS params element id;
706 		 * silently discard it.
707 		 *
708 		 * NB: this can happen due to signal leakage.
709 		 *     But we should take it for FH phy because
710 		 *     the rssi value should be correct even for
711 		 *     different hop pattern in FH.
712 		 */
713 		IEEE80211_DISCARD(vap,
714 		    IEEE80211_MSG_ELEMID | IEEE80211_MSG_INPUT,
715 		    wh, NULL, "for off-channel %u (bchan=%u)",
716 		    scan->chan, scan->bchan);
717 		vap->iv_stats.is_rx_chanmismatch++;
718 		scan->status |= IEEE80211_BPARSE_OFFCHAN;
719 	}
720 	if (!(IEEE80211_BINTVAL_MIN <= scan->bintval &&
721 	      scan->bintval <= IEEE80211_BINTVAL_MAX)) {
722 		IEEE80211_DISCARD(vap,
723 		    IEEE80211_MSG_ELEMID | IEEE80211_MSG_INPUT,
724 		    wh, NULL, "bogus beacon interval (%d TU)",
725 		    (int) scan->bintval);
726 		vap->iv_stats.is_rx_badbintval++;
727 		scan->status |= IEEE80211_BPARSE_BINTVAL_INVALID;
728 	}
729 	if (scan->country != NULL) {
730 		/*
731 		 * Validate we have at least enough data to extract
732 		 * the country code.  Not sure if we should return an
733 		 * error instead of discarding the IE; consider this
734 		 * being lenient as we don't depend on the data for
735 		 * correct operation.
736 		 */
737 		IEEE80211_VERIFY_LENGTH(scan->country[1], 3 * sizeof(uint8_t),
738 		    scan->country = NULL);
739 	}
740 	if (scan->csa != NULL) {
741 		/*
742 		 * Validate Channel Switch Announcement; this must
743 		 * be the correct length or we toss the frame.
744 		 */
745 		IEEE80211_VERIFY_LENGTH(scan->csa[1], 3 * sizeof(uint8_t),
746 		    scan->status |= IEEE80211_BPARSE_CSA_INVALID);
747 	}
748 #ifdef IEEE80211_SUPPORT_MESH
749 	if (scan->meshid != NULL) {
750 		IEEE80211_VERIFY_ELEMENT(scan->meshid, IEEE80211_MESHID_LEN,
751 		    scan->status |= IEEE80211_BPARSE_MESHID_INVALID);
752 	}
753 #endif
754 	/*
755 	 * Process HT ie's.  This is complicated by our
756 	 * accepting both the standard ie's and the pre-draft
757 	 * vendor OUI ie's that some vendors still use/require.
758 	 */
759 	if (scan->htcap != NULL) {
760 		IEEE80211_VERIFY_LENGTH(scan->htcap[1],
761 		     scan->htcap[0] == IEEE80211_ELEMID_VENDOR ?
762 			 4 + sizeof(struct ieee80211_ie_htcap)-2 :
763 			 sizeof(struct ieee80211_ie_htcap)-2,
764 		     scan->htcap = NULL);
765 	}
766 	if (scan->htinfo != NULL) {
767 		IEEE80211_VERIFY_LENGTH(scan->htinfo[1],
768 		     scan->htinfo[0] == IEEE80211_ELEMID_VENDOR ?
769 			 4 + sizeof(struct ieee80211_ie_htinfo)-2 :
770 			 sizeof(struct ieee80211_ie_htinfo)-2,
771 		     scan->htinfo = NULL);
772 	}
773 
774 	/* Process VHT IEs */
775 	if (scan->vhtcap != NULL) {
776 		IEEE80211_VERIFY_LENGTH(scan->vhtcap[1],
777 		    sizeof(struct ieee80211_vht_cap),
778 		    scan->vhtcap = NULL);
779 	}
780 	if (scan->vhtopmode != NULL) {
781 		IEEE80211_VERIFY_LENGTH(scan->vhtopmode[1],
782 		    sizeof(struct ieee80211_vht_operation),
783 		    scan->vhtopmode = NULL);
784 	}
785 
786 	return scan->status;
787 }
788 
789 /*
790  * Parse an Action frame.  Return 0 on success, non-zero on failure.
791  */
792 int
793 ieee80211_parse_action(struct ieee80211_node *ni, struct mbuf *m)
794 {
795 	struct ieee80211vap *vap = ni->ni_vap;
796 	const struct ieee80211_action *ia;
797 	struct ieee80211_frame *wh;
798 	uint8_t *frm, *efrm;
799 
800 	/*
801 	 * action frame format:
802 	 *	[1] category
803 	 *	[1] action
804 	 *	[tlv] parameters
805 	 */
806 	wh = mtod(m, struct ieee80211_frame *);
807 	frm = (u_int8_t *)&wh[1];
808 	efrm = mtod(m, u_int8_t *) + m->m_len;
809 	IEEE80211_VERIFY_LENGTH(efrm - frm,
810 		sizeof(struct ieee80211_action), return EINVAL);
811 	ia = (const struct ieee80211_action *) frm;
812 
813 	vap->iv_stats.is_rx_action++;
814 	IEEE80211_NODE_STAT(ni, rx_action);
815 
816 	/* verify frame payloads but defer processing */
817 	switch (ia->ia_category) {
818 	case IEEE80211_ACTION_CAT_BA:
819 		switch (ia->ia_action) {
820 		case IEEE80211_ACTION_BA_ADDBA_REQUEST:
821 			IEEE80211_VERIFY_LENGTH(efrm - frm,
822 			    sizeof(struct ieee80211_action_ba_addbarequest),
823 			    return EINVAL);
824 			break;
825 		case IEEE80211_ACTION_BA_ADDBA_RESPONSE:
826 			IEEE80211_VERIFY_LENGTH(efrm - frm,
827 			    sizeof(struct ieee80211_action_ba_addbaresponse),
828 			    return EINVAL);
829 			break;
830 		case IEEE80211_ACTION_BA_DELBA:
831 			IEEE80211_VERIFY_LENGTH(efrm - frm,
832 			    sizeof(struct ieee80211_action_ba_delba),
833 			    return EINVAL);
834 			break;
835 		}
836 		break;
837 	case IEEE80211_ACTION_CAT_HT:
838 		switch (ia->ia_action) {
839 		case IEEE80211_ACTION_HT_TXCHWIDTH:
840 			IEEE80211_VERIFY_LENGTH(efrm - frm,
841 			    sizeof(struct ieee80211_action_ht_txchwidth),
842 			    return EINVAL);
843 			break;
844 		case IEEE80211_ACTION_HT_MIMOPWRSAVE:
845 			IEEE80211_VERIFY_LENGTH(efrm - frm,
846 			    sizeof(struct ieee80211_action_ht_mimopowersave),
847 			    return EINVAL);
848 			break;
849 		}
850 		break;
851 #ifdef IEEE80211_SUPPORT_MESH
852 	case IEEE80211_ACTION_CAT_MESH:
853 		switch (ia->ia_action) {
854 		case IEEE80211_ACTION_MESH_LMETRIC:
855 			/*
856 			 * XXX: verification is true only if we are using
857 			 * Airtime link metric (default)
858 			 */
859 			IEEE80211_VERIFY_LENGTH(efrm - frm,
860 			    sizeof(struct ieee80211_meshlmetric_ie),
861 			    return EINVAL);
862 			break;
863 		case IEEE80211_ACTION_MESH_HWMP:
864 			/* verify something */
865 			break;
866 		case IEEE80211_ACTION_MESH_GANN:
867 			IEEE80211_VERIFY_LENGTH(efrm - frm,
868 			    sizeof(struct ieee80211_meshgann_ie),
869 			    return EINVAL);
870 			break;
871 		case IEEE80211_ACTION_MESH_CC:
872 		case IEEE80211_ACTION_MESH_MCCA_SREQ:
873 		case IEEE80211_ACTION_MESH_MCCA_SREP:
874 		case IEEE80211_ACTION_MESH_MCCA_AREQ:
875 		case IEEE80211_ACTION_MESH_MCCA_ADVER:
876 		case IEEE80211_ACTION_MESH_MCCA_TRDOWN:
877 		case IEEE80211_ACTION_MESH_TBTT_REQ:
878 		case IEEE80211_ACTION_MESH_TBTT_RES:
879 			/* reject these early on, not implemented */
880 			IEEE80211_DISCARD(vap,
881 			    IEEE80211_MSG_ELEMID | IEEE80211_MSG_INPUT,
882 			    wh, NULL, "not implemented yet, act=0x%02X",
883 			    ia->ia_action);
884 			return EINVAL;
885 		}
886 		break;
887 	case IEEE80211_ACTION_CAT_SELF_PROT:
888 		/* If TA or RA group address discard silently */
889 		if (IEEE80211_IS_MULTICAST(wh->i_addr1) ||
890 			IEEE80211_IS_MULTICAST(wh->i_addr2))
891 			return EINVAL;
892 		/*
893 		 * XXX: Should we verify complete length now or it is
894 		 * to varying in sizes?
895 		 */
896 		switch (ia->ia_action) {
897 		case IEEE80211_ACTION_MESHPEERING_CONFIRM:
898 		case IEEE80211_ACTION_MESHPEERING_CLOSE:
899 			/* is not a peering candidate (yet) */
900 			if (ni == vap->iv_bss)
901 				return EINVAL;
902 			break;
903 		}
904 		break;
905 #endif
906 	case IEEE80211_ACTION_CAT_VHT:
907 		printf("%s: TODO: VHT handling!\n", __func__);
908 		break;
909 	}
910 	return 0;
911 }
912 
913 #ifdef IEEE80211_DEBUG
914 /*
915  * Debugging support.
916  */
917 void
918 ieee80211_ssid_mismatch(struct ieee80211vap *vap, const char *tag,
919 	uint8_t mac[IEEE80211_ADDR_LEN], uint8_t *ssid)
920 {
921 	printf("[%s] discard %s frame, ssid mismatch: ",
922 		ether_sprintf(mac), tag);
923 	ieee80211_print_essid(ssid + 2, ssid[1]);
924 	printf("\n");
925 }
926 
927 /*
928  * Return the bssid of a frame.
929  */
930 static const uint8_t *
931 ieee80211_getbssid(const struct ieee80211vap *vap,
932 	const struct ieee80211_frame *wh)
933 {
934 	if (vap->iv_opmode == IEEE80211_M_STA)
935 		return wh->i_addr2;
936 	if ((wh->i_fc[1] & IEEE80211_FC1_DIR_MASK) != IEEE80211_FC1_DIR_NODS)
937 		return wh->i_addr1;
938 	if ((wh->i_fc[0] & IEEE80211_FC0_SUBTYPE_MASK) == IEEE80211_FC0_SUBTYPE_PS_POLL)
939 		return wh->i_addr1;
940 	return wh->i_addr3;
941 }
942 
943 #include <machine/stdarg.h>
944 
945 void
946 ieee80211_note(const struct ieee80211vap *vap, const char *fmt, ...)
947 {
948 	char buf[256];		/* XXX */
949 	va_list ap;
950 	int len;
951 
952 	va_start(ap, fmt);
953 	len = vsnprintf(buf, sizeof(buf), fmt, ap);
954 	va_end(ap);
955 
956 	if_printf(vap->iv_ifp, "%s", buf);	/* NB: no \n */
957 
958 	if (len >= sizeof(buf))
959 		printf("%s: XXX buffer too small: len = %d\n", __func__, len);
960 }
961 
962 void
963 ieee80211_note_frame(const struct ieee80211vap *vap,
964 	const struct ieee80211_frame *wh,
965 	const char *fmt, ...)
966 {
967 	char buf[256];		/* XXX */
968 	va_list ap;
969 	int len;
970 
971 	va_start(ap, fmt);
972 	len = vsnprintf(buf, sizeof(buf), fmt, ap);
973 	va_end(ap);
974 	if_printf(vap->iv_ifp, "[%s] %s\n",
975 		ether_sprintf(ieee80211_getbssid(vap, wh)), buf);
976 
977 	if (len >= sizeof(buf))
978 		printf("%s: XXX buffer too small: len = %d\n", __func__, len);
979 }
980 
981 void
982 ieee80211_note_mac(const struct ieee80211vap *vap,
983 	const uint8_t mac[IEEE80211_ADDR_LEN],
984 	const char *fmt, ...)
985 {
986 	char buf[256];		/* XXX */
987 	va_list ap;
988 	int len;
989 
990 	va_start(ap, fmt);
991 	len = vsnprintf(buf, sizeof(buf), fmt, ap);
992 	va_end(ap);
993 	if_printf(vap->iv_ifp, "[%s] %s\n", ether_sprintf(mac), buf);
994 
995 	if (len >= sizeof(buf))
996 		printf("%s: XXX buffer too small: len = %d\n", __func__, len);
997 }
998 
999 void
1000 ieee80211_discard_frame(const struct ieee80211vap *vap,
1001 	const struct ieee80211_frame *wh,
1002 	const char *type, const char *fmt, ...)
1003 {
1004 	char buf[256];		/* XXX */
1005 	va_list ap;
1006 	int len;
1007 
1008 	va_start(ap, fmt);
1009 	len = vsnprintf(buf, sizeof(buf), fmt, ap);
1010 	va_end(ap);
1011 
1012 	if_printf(vap->iv_ifp, "[%s] discard %s frame, %s\n",
1013 	    ether_sprintf(ieee80211_getbssid(vap, wh)),
1014 	    type != NULL ? type : ieee80211_mgt_subtype_name(wh->i_fc[0]),
1015 	    buf);
1016 
1017 	if (len >= sizeof(buf))
1018 		printf("%s: XXX buffer too small: len = %d\n", __func__, len);
1019 }
1020 
1021 void
1022 ieee80211_discard_ie(const struct ieee80211vap *vap,
1023 	const struct ieee80211_frame *wh,
1024 	const char *type, const char *fmt, ...)
1025 {
1026 	char buf[256];		/* XXX */
1027 	va_list ap;
1028 	int len;
1029 
1030 	va_start(ap, fmt);
1031 	len = vsnprintf(buf, sizeof(buf), fmt, ap);
1032 	va_end(ap);
1033 
1034 	if_printf(vap->iv_ifp, "[%s] discard%s%s information element, %s\n",
1035 	    ether_sprintf(ieee80211_getbssid(vap, wh)),
1036 	    type != NULL ? " " : "", type != NULL ? type : "", buf);
1037 
1038 	if (len >= sizeof(buf))
1039 		printf("%s: XXX buffer too small: len = %d\n", __func__, len);
1040 }
1041 
1042 void
1043 ieee80211_discard_mac(const struct ieee80211vap *vap,
1044 	const uint8_t mac[IEEE80211_ADDR_LEN],
1045 	const char *type, const char *fmt, ...)
1046 {
1047 	char buf[256];		/* XXX */
1048 	va_list ap;
1049 	int len;
1050 
1051 	va_start(ap, fmt);
1052 	len = vsnprintf(buf, sizeof(buf), fmt, ap);
1053 	va_end(ap);
1054 
1055 	if_printf(vap->iv_ifp, "[%s] discard%s%s frame, %s\n",
1056 	    ether_sprintf(mac),
1057 	    type != NULL ? " " : "", type != NULL ? type : "", buf);
1058 
1059 	if (len >= sizeof(buf))
1060 		printf("%s: XXX buffer too small: len = %d\n", __func__, len);
1061 }
1062 #endif /* IEEE80211_DEBUG */
1063