xref: /freebsd/sys/net80211/ieee80211_freebsd.c (revision d056fa046c6a91b90cd98165face0e42a33a5173)
1 /*-
2  * Copyright (c) 2003-2005 Sam Leffler, Errno Consulting
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. The name of the author may not be used to endorse or promote products
14  *    derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
30 
31 /*
32  * IEEE 802.11 support (FreeBSD-specific code)
33  */
34 #include <sys/param.h>
35 #include <sys/kernel.h>
36 #include <sys/systm.h>
37 #include <sys/linker.h>
38 #include <sys/mbuf.h>
39 #include <sys/module.h>
40 #include <sys/proc.h>
41 #include <sys/sysctl.h>
42 
43 #include <sys/socket.h>
44 
45 #include <net/if.h>
46 #include <net/if_media.h>
47 #include <net/ethernet.h>
48 #include <net/route.h>
49 
50 #include <net80211/ieee80211_var.h>
51 
52 SYSCTL_NODE(_net, OID_AUTO, wlan, CTLFLAG_RD, 0, "IEEE 80211 parameters");
53 
54 #ifdef IEEE80211_DEBUG
55 int	ieee80211_debug = 0;
56 SYSCTL_INT(_net_wlan, OID_AUTO, debug, CTLFLAG_RW, &ieee80211_debug,
57 	    0, "debugging printfs");
58 #endif
59 
60 static int
61 ieee80211_sysctl_inact(SYSCTL_HANDLER_ARGS)
62 {
63 	int inact = (*(int *)arg1) * IEEE80211_INACT_WAIT;
64 	int error;
65 
66 	error = sysctl_handle_int(oidp, &inact, 0, req);
67 	if (error || !req->newptr)
68 		return error;
69 	*(int *)arg1 = inact / IEEE80211_INACT_WAIT;
70 	return 0;
71 }
72 
73 static int
74 ieee80211_sysctl_parent(SYSCTL_HANDLER_ARGS)
75 {
76 	struct ieee80211com *ic = arg1;
77 	const char *name = ic->ic_ifp->if_xname;
78 
79 	return SYSCTL_OUT(req, name, strlen(name));
80 }
81 
82 void
83 ieee80211_sysctl_attach(struct ieee80211com *ic)
84 {
85 	struct sysctl_ctx_list *ctx;
86 	struct sysctl_oid *oid;
87 	char num[14];			/* sufficient for 32 bits */
88 
89 	MALLOC(ctx, struct sysctl_ctx_list *, sizeof(struct sysctl_ctx_list),
90 		M_DEVBUF, M_NOWAIT | M_ZERO);
91 	if (ctx == NULL) {
92 		if_printf(ic->ic_ifp, "%s: cannot allocate sysctl context!\n",
93 			__func__);
94 		return;
95 	}
96 	sysctl_ctx_init(ctx);
97 	snprintf(num, sizeof(num), "%u", ic->ic_vap);
98 	oid = SYSCTL_ADD_NODE(ctx, &SYSCTL_NODE_CHILDREN(_net, wlan),
99 		OID_AUTO, num, CTLFLAG_RD, NULL, "");
100 	SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(oid), OID_AUTO,
101 		"%parent", CTLFLAG_RD, ic, 0, ieee80211_sysctl_parent, "A",
102 		"parent device");
103 #ifdef IEEE80211_DEBUG
104 	ic->ic_debug = ieee80211_debug;
105 	SYSCTL_ADD_INT(ctx, SYSCTL_CHILDREN(oid), OID_AUTO,
106 		"debug", CTLFLAG_RW, &ic->ic_debug, 0,
107 		"control debugging printfs");
108 #endif
109 	/* XXX inherit from tunables */
110 	SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(oid), OID_AUTO,
111 		"inact_run", CTLTYPE_INT | CTLFLAG_RW, &ic->ic_inact_run, 0,
112 		ieee80211_sysctl_inact, "I",
113 		"station inactivity timeout (sec)");
114 	SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(oid), OID_AUTO,
115 		"inact_probe", CTLTYPE_INT | CTLFLAG_RW, &ic->ic_inact_probe, 0,
116 		ieee80211_sysctl_inact, "I",
117 		"station inactivity probe timeout (sec)");
118 	SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(oid), OID_AUTO,
119 		"inact_auth", CTLTYPE_INT | CTLFLAG_RW, &ic->ic_inact_auth, 0,
120 		ieee80211_sysctl_inact, "I",
121 		"station authentication timeout (sec)");
122 	SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(oid), OID_AUTO,
123 		"inact_init", CTLTYPE_INT | CTLFLAG_RW, &ic->ic_inact_init, 0,
124 		ieee80211_sysctl_inact, "I",
125 		"station initial state timeout (sec)");
126 	SYSCTL_ADD_INT(ctx, SYSCTL_CHILDREN(oid), OID_AUTO,
127 		"driver_caps", CTLFLAG_RW, &ic->ic_caps, 0,
128 		"driver capabilities");
129 	SYSCTL_ADD_INT(ctx, SYSCTL_CHILDREN(oid), OID_AUTO,
130 		"bmiss_max", CTLFLAG_RW, &ic->ic_bmiss_max, 0,
131 		"consecutive beacon misses before scanning");
132 	ic->ic_sysctl = ctx;
133 }
134 
135 void
136 ieee80211_sysctl_detach(struct ieee80211com *ic)
137 {
138 
139 	if (ic->ic_sysctl != NULL) {
140 		sysctl_ctx_free(ic->ic_sysctl);
141 		ic->ic_sysctl = NULL;
142 	}
143 }
144 
145 int
146 ieee80211_node_dectestref(struct ieee80211_node *ni)
147 {
148 	/* XXX need equivalent of atomic_dec_and_test */
149 	atomic_subtract_int(&ni->ni_refcnt, 1);
150 	return atomic_cmpset_int(&ni->ni_refcnt, 0, 1);
151 }
152 
153 /*
154  * Allocate and setup a management frame of the specified
155  * size.  We return the mbuf and a pointer to the start
156  * of the contiguous data area that's been reserved based
157  * on the packet length.  The data area is forced to 32-bit
158  * alignment and the buffer length to a multiple of 4 bytes.
159  * This is done mainly so beacon frames (that require this)
160  * can use this interface too.
161  */
162 struct mbuf *
163 ieee80211_getmgtframe(u_int8_t **frm, u_int pktlen)
164 {
165 	struct mbuf *m;
166 	u_int len;
167 
168 	/*
169 	 * NB: we know the mbuf routines will align the data area
170 	 *     so we don't need to do anything special.
171 	 */
172 	/* XXX 4-address frame? */
173 	len = roundup(sizeof(struct ieee80211_frame) + pktlen, 4);
174 	KASSERT(len <= MCLBYTES, ("802.11 mgt frame too large: %u", len));
175 	if (len < MINCLSIZE) {
176 		m = m_gethdr(M_NOWAIT, MT_DATA);
177 		/*
178 		 * Align the data in case additional headers are added.
179 		 * This should only happen when a WEP header is added
180 		 * which only happens for shared key authentication mgt
181 		 * frames which all fit in MHLEN.
182 		 */
183 		if (m != NULL)
184 			MH_ALIGN(m, len);
185 	} else
186 		m = m_getcl(M_NOWAIT, MT_DATA, M_PKTHDR);
187 	if (m != NULL) {
188 		m->m_data += sizeof(struct ieee80211_frame);
189 		*frm = m->m_data;
190 	}
191 	return m;
192 }
193 
194 #include <sys/libkern.h>
195 
196 void
197 get_random_bytes(void *p, size_t n)
198 {
199 	u_int8_t *dp = p;
200 
201 	while (n > 0) {
202 		u_int32_t v = arc4random();
203 		size_t nb = n > sizeof(u_int32_t) ? sizeof(u_int32_t) : n;
204 		bcopy(&v, dp, n > sizeof(u_int32_t) ? sizeof(u_int32_t) : n);
205 		dp += sizeof(u_int32_t), n -= nb;
206 	}
207 }
208 
209 void
210 ieee80211_notify_node_join(struct ieee80211com *ic, struct ieee80211_node *ni, int newassoc)
211 {
212 	struct ifnet *ifp = ic->ic_ifp;
213 	struct ieee80211_join_event iev;
214 
215 	memset(&iev, 0, sizeof(iev));
216 	if (ni == ic->ic_bss) {
217 		IEEE80211_ADDR_COPY(iev.iev_addr, ni->ni_bssid);
218 		rt_ieee80211msg(ifp, newassoc ?
219 			RTM_IEEE80211_ASSOC : RTM_IEEE80211_REASSOC,
220 			&iev, sizeof(iev));
221 		if_link_state_change(ifp, LINK_STATE_UP);
222 	} else {
223 		IEEE80211_ADDR_COPY(iev.iev_addr, ni->ni_macaddr);
224 		rt_ieee80211msg(ifp, newassoc ?
225 			RTM_IEEE80211_JOIN : RTM_IEEE80211_REJOIN,
226 			&iev, sizeof(iev));
227 	}
228 }
229 
230 void
231 ieee80211_notify_node_leave(struct ieee80211com *ic, struct ieee80211_node *ni)
232 {
233 	struct ifnet *ifp = ic->ic_ifp;
234 	struct ieee80211_leave_event iev;
235 
236 	if (ni == ic->ic_bss) {
237 		rt_ieee80211msg(ifp, RTM_IEEE80211_DISASSOC, NULL, 0);
238 		if_link_state_change(ifp, LINK_STATE_DOWN);
239 	} else {
240 		/* fire off wireless event station leaving */
241 		memset(&iev, 0, sizeof(iev));
242 		IEEE80211_ADDR_COPY(iev.iev_addr, ni->ni_macaddr);
243 		rt_ieee80211msg(ifp, RTM_IEEE80211_LEAVE, &iev, sizeof(iev));
244 	}
245 }
246 
247 void
248 ieee80211_notify_scan_done(struct ieee80211com *ic)
249 {
250 	struct ifnet *ifp = ic->ic_ifp;
251 
252 	IEEE80211_DPRINTF(ic, IEEE80211_MSG_SCAN, "%s\n", "notify scan done");
253 
254 	/* dispatch wireless event indicating scan completed */
255 	rt_ieee80211msg(ifp, RTM_IEEE80211_SCAN, NULL, 0);
256 }
257 
258 void
259 ieee80211_notify_replay_failure(struct ieee80211com *ic,
260 	const struct ieee80211_frame *wh, const struct ieee80211_key *k,
261 	u_int64_t rsc)
262 {
263 	struct ifnet *ifp = ic->ic_ifp;
264 
265 	IEEE80211_DPRINTF(ic, IEEE80211_MSG_CRYPTO,
266 	    "[%s] %s replay detected <rsc %ju, csc %ju, keyix %u rxkeyix %u>\n",
267 	    ether_sprintf(wh->i_addr2), k->wk_cipher->ic_name,
268 	    (intmax_t) rsc, (intmax_t) k->wk_keyrsc,
269 	    k->wk_keyix, k->wk_rxkeyix);
270 
271 	if (ifp != NULL) {		/* NB: for cipher test modules */
272 		struct ieee80211_replay_event iev;
273 
274 		IEEE80211_ADDR_COPY(iev.iev_dst, wh->i_addr1);
275 		IEEE80211_ADDR_COPY(iev.iev_src, wh->i_addr2);
276 		iev.iev_cipher = k->wk_cipher->ic_cipher;
277 		if (k->wk_rxkeyix != IEEE80211_KEYIX_NONE)
278 			iev.iev_keyix = k->wk_rxkeyix;
279 		else
280 			iev.iev_keyix = k->wk_keyix;
281 		iev.iev_keyrsc = k->wk_keyrsc;
282 		iev.iev_rsc = rsc;
283 		rt_ieee80211msg(ifp, RTM_IEEE80211_REPLAY, &iev, sizeof(iev));
284 	}
285 }
286 
287 void
288 ieee80211_notify_michael_failure(struct ieee80211com *ic,
289 	const struct ieee80211_frame *wh, u_int keyix)
290 {
291 	struct ifnet *ifp = ic->ic_ifp;
292 
293 	IEEE80211_DPRINTF(ic, IEEE80211_MSG_CRYPTO,
294 		"[%s] michael MIC verification failed <keyix %u>\n",
295 	       ether_sprintf(wh->i_addr2), keyix);
296 	ic->ic_stats.is_rx_tkipmic++;
297 
298 	if (ifp != NULL) {		/* NB: for cipher test modules */
299 		struct ieee80211_michael_event iev;
300 
301 		IEEE80211_ADDR_COPY(iev.iev_dst, wh->i_addr1);
302 		IEEE80211_ADDR_COPY(iev.iev_src, wh->i_addr2);
303 		iev.iev_cipher = IEEE80211_CIPHER_TKIP;
304 		iev.iev_keyix = keyix;
305 		rt_ieee80211msg(ifp, RTM_IEEE80211_MICHAEL, &iev, sizeof(iev));
306 	}
307 }
308 
309 void
310 ieee80211_load_module(const char *modname)
311 {
312 
313 #ifdef notyet
314 	(void)kern_kldload(curthread, modname, NULL);
315 #else
316 	printf("%s: load the %s module by hand for now.\n", __func__, modname);
317 #endif
318 }
319 
320 /*
321  * Module glue.
322  *
323  * NB: the module name is "wlan" for compatibility with NetBSD.
324  */
325 static int
326 wlan_modevent(module_t mod, int type, void *unused)
327 {
328 	switch (type) {
329 	case MOD_LOAD:
330 		if (bootverbose)
331 			printf("wlan: <802.11 Link Layer>\n");
332 		return 0;
333 	case MOD_UNLOAD:
334 		return 0;
335 	}
336 	return EINVAL;
337 }
338 
339 static moduledata_t wlan_mod = {
340 	"wlan",
341 	wlan_modevent,
342 	0
343 };
344 DECLARE_MODULE(wlan, wlan_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
345 MODULE_VERSION(wlan, 1);
346 MODULE_DEPEND(wlan, ether, 1, 1, 1);
347