xref: /freebsd/contrib/wpa/wpa_supplicant/mesh.c (revision ef0cb5db0af0d5d5b75b74f8e534fe601b7176d7)
1 /*
2  * WPA Supplicant - Basic mesh mode routines
3  * Copyright (c) 2013-2014, cozybit, Inc.  All rights reserved.
4  *
5  * This software may be distributed under the terms of the BSD license.
6  * See README for more details.
7  */
8 
9 #include "utils/includes.h"
10 
11 #include "utils/common.h"
12 #include "utils/eloop.h"
13 #include "utils/uuid.h"
14 #include "common/ieee802_11_defs.h"
15 #include "common/wpa_ctrl.h"
16 #include "ap/sta_info.h"
17 #include "ap/hostapd.h"
18 #include "ap/ieee802_11.h"
19 #include "config_ssid.h"
20 #include "config.h"
21 #include "wpa_supplicant_i.h"
22 #include "driver_i.h"
23 #include "notify.h"
24 #include "ap.h"
25 #include "mesh_mpm.h"
26 #include "mesh_rsn.h"
27 #include "mesh.h"
28 
29 
30 static void wpa_supplicant_mesh_deinit(struct wpa_supplicant *wpa_s)
31 {
32 	wpa_supplicant_mesh_iface_deinit(wpa_s, wpa_s->ifmsh);
33 	wpa_s->ifmsh = NULL;
34 	wpa_s->current_ssid = NULL;
35 	os_free(wpa_s->mesh_rsn);
36 	wpa_s->mesh_rsn = NULL;
37 	/* TODO: leave mesh (stop beacon). This will happen on link down
38 	 * anyway, so it's not urgent */
39 }
40 
41 
42 void wpa_supplicant_mesh_iface_deinit(struct wpa_supplicant *wpa_s,
43 				      struct hostapd_iface *ifmsh)
44 {
45 	if (!ifmsh)
46 		return;
47 
48 	if (ifmsh->mconf) {
49 		mesh_mpm_deinit(wpa_s, ifmsh);
50 		if (ifmsh->mconf->ies) {
51 			ifmsh->mconf->ies = NULL;
52 			/* We cannot free this struct
53 			 * because wpa_authenticator on
54 			 * hostapd side is also using it
55 			 * for now just set to NULL and
56 			 * let hostapd code free it.
57 			 */
58 		}
59 		os_free(ifmsh->mconf);
60 		ifmsh->mconf = NULL;
61 	}
62 
63 	/* take care of shared data */
64 	hostapd_interface_deinit(ifmsh);
65 	hostapd_interface_free(ifmsh);
66 }
67 
68 
69 static struct mesh_conf * mesh_config_create(struct wpa_ssid *ssid)
70 {
71 	struct mesh_conf *conf;
72 
73 	conf = os_zalloc(sizeof(struct mesh_conf));
74 	if (!conf)
75 		return NULL;
76 
77 	os_memcpy(conf->meshid, ssid->ssid, ssid->ssid_len);
78 	conf->meshid_len = ssid->ssid_len;
79 
80 	if (ssid->key_mgmt & WPA_KEY_MGMT_SAE)
81 		conf->security |= MESH_CONF_SEC_AUTH |
82 			MESH_CONF_SEC_AMPE;
83 	else
84 		conf->security |= MESH_CONF_SEC_NONE;
85 
86 	/* defaults */
87 	conf->mesh_pp_id = MESH_PATH_PROTOCOL_HWMP;
88 	conf->mesh_pm_id = MESH_PATH_METRIC_AIRTIME;
89 	conf->mesh_cc_id = 0;
90 	conf->mesh_sp_id = MESH_SYNC_METHOD_NEIGHBOR_OFFSET;
91 	conf->mesh_auth_id = (conf->security & MESH_CONF_SEC_AUTH) ? 1 : 0;
92 	conf->dot11MeshMaxRetries = ssid->dot11MeshMaxRetries;
93 	conf->dot11MeshRetryTimeout = ssid->dot11MeshRetryTimeout;
94 	conf->dot11MeshConfirmTimeout = ssid->dot11MeshConfirmTimeout;
95 	conf->dot11MeshHoldingTimeout = ssid->dot11MeshHoldingTimeout;
96 
97 	return conf;
98 }
99 
100 
101 static void wpas_mesh_copy_groups(struct hostapd_data *bss,
102 				  struct wpa_supplicant *wpa_s)
103 {
104 	int num_groups;
105 	size_t groups_size;
106 
107 	for (num_groups = 0; wpa_s->conf->sae_groups[num_groups] > 0;
108 	     num_groups++)
109 		;
110 
111 	groups_size = (num_groups + 1) * sizeof(wpa_s->conf->sae_groups[0]);
112 	bss->conf->sae_groups = os_malloc(groups_size);
113 	if (bss->conf->sae_groups)
114 		os_memcpy(bss->conf->sae_groups, wpa_s->conf->sae_groups,
115 			  groups_size);
116 }
117 
118 
119 static int wpa_supplicant_mesh_init(struct wpa_supplicant *wpa_s,
120 				    struct wpa_ssid *ssid)
121 {
122 	struct hostapd_iface *ifmsh;
123 	struct hostapd_data *bss;
124 	struct hostapd_config *conf;
125 	struct mesh_conf *mconf;
126 	int basic_rates_erp[] = { 10, 20, 55, 60, 110, 120, 240, -1 };
127 	static int default_groups[] = { 19, 20, 21, 25, 26, -1 };
128 	size_t len;
129 	int rate_len;
130 
131 	if (!wpa_s->conf->user_mpm) {
132 		/* not much for us to do here */
133 		wpa_msg(wpa_s, MSG_WARNING,
134 			"user_mpm is not enabled in configuration");
135 		return 0;
136 	}
137 
138 	wpa_s->ifmsh = ifmsh = os_zalloc(sizeof(*wpa_s->ifmsh));
139 	if (!ifmsh)
140 		return -ENOMEM;
141 
142 	ifmsh->drv_flags = wpa_s->drv_flags;
143 	ifmsh->num_bss = 1;
144 	ifmsh->bss = os_calloc(wpa_s->ifmsh->num_bss,
145 			       sizeof(struct hostapd_data *));
146 	if (!ifmsh->bss)
147 		goto out_free;
148 
149 	ifmsh->bss[0] = bss = os_zalloc(sizeof(struct hostapd_data));
150 	if (!bss)
151 		goto out_free;
152 
153 	os_memcpy(bss->own_addr, wpa_s->own_addr, ETH_ALEN);
154 	bss->driver = wpa_s->driver;
155 	bss->drv_priv = wpa_s->drv_priv;
156 	bss->iface = ifmsh;
157 	bss->mesh_sta_free_cb = mesh_mpm_free_sta;
158 	wpa_s->assoc_freq = ssid->frequency;
159 	wpa_s->current_ssid = ssid;
160 
161 	/* setup an AP config for auth processing */
162 	conf = hostapd_config_defaults();
163 	if (!conf)
164 		goto out_free;
165 
166 	bss->conf = *conf->bss;
167 	bss->conf->start_disabled = 1;
168 	bss->conf->mesh = MESH_ENABLED;
169 	bss->conf->ap_max_inactivity = wpa_s->conf->mesh_max_inactivity;
170 	bss->iconf = conf;
171 	ifmsh->conf = conf;
172 
173 	ifmsh->bss[0]->max_plinks = wpa_s->conf->max_peer_links;
174 	os_strlcpy(bss->conf->iface, wpa_s->ifname, sizeof(bss->conf->iface));
175 
176 	mconf = mesh_config_create(ssid);
177 	if (!mconf)
178 		goto out_free;
179 	ifmsh->mconf = mconf;
180 
181 	/* need conf->hw_mode for supported rates. */
182 	if (ssid->frequency == 0) {
183 		conf->hw_mode = HOSTAPD_MODE_IEEE80211G;
184 		conf->channel = 1;
185 	} else {
186 		conf->hw_mode = ieee80211_freq_to_chan(ssid->frequency,
187 						       &conf->channel);
188 	}
189 	if (conf->hw_mode == NUM_HOSTAPD_MODES) {
190 		wpa_printf(MSG_ERROR, "Unsupported mesh mode frequency: %d MHz",
191 			   ssid->frequency);
192 		goto out_free;
193 	}
194 
195 	if (ssid->mesh_basic_rates == NULL) {
196 		/*
197 		 * XXX: Hack! This is so an MPM which correctly sets the ERP
198 		 * mandatory rates as BSSBasicRateSet doesn't reject us. We
199 		 * could add a new hw_mode HOSTAPD_MODE_IEEE80211G_ERP, but
200 		 * this is way easier. This also makes our BSSBasicRateSet
201 		 * advertised in beacons match the one in peering frames, sigh.
202 		 */
203 		if (conf->hw_mode == HOSTAPD_MODE_IEEE80211G) {
204 			conf->basic_rates = os_malloc(sizeof(basic_rates_erp));
205 			if (!conf->basic_rates)
206 				goto out_free;
207 			os_memcpy(conf->basic_rates, basic_rates_erp,
208 				  sizeof(basic_rates_erp));
209 		}
210 	} else {
211 		rate_len = 0;
212 		while (1) {
213 			if (ssid->mesh_basic_rates[rate_len] < 1)
214 				break;
215 			rate_len++;
216 		}
217 		conf->basic_rates = os_calloc(rate_len + 1, sizeof(int));
218 		if (conf->basic_rates == NULL)
219 			goto out_free;
220 		os_memcpy(conf->basic_rates, ssid->mesh_basic_rates,
221 			  rate_len * sizeof(int));
222 		conf->basic_rates[rate_len] = -1;
223 	}
224 
225 	if (hostapd_setup_interface(ifmsh)) {
226 		wpa_printf(MSG_ERROR,
227 			   "Failed to initialize hostapd interface for mesh");
228 		return -1;
229 	}
230 
231 	if (wpa_drv_init_mesh(wpa_s)) {
232 		wpa_msg(wpa_s, MSG_ERROR, "Failed to init mesh in driver");
233 		return -1;
234 	}
235 
236 	if (mconf->security != MESH_CONF_SEC_NONE) {
237 		if (ssid->passphrase == NULL) {
238 			wpa_printf(MSG_ERROR,
239 				   "mesh: Passphrase for SAE not configured");
240 			goto out_free;
241 		}
242 
243 		bss->conf->wpa = ssid->proto;
244 		bss->conf->wpa_key_mgmt = ssid->key_mgmt;
245 
246 		if (wpa_s->conf->sae_groups &&
247 		    wpa_s->conf->sae_groups[0] > 0) {
248 			wpas_mesh_copy_groups(bss, wpa_s);
249 		} else {
250 			bss->conf->sae_groups =
251 				os_malloc(sizeof(default_groups));
252 			if (!bss->conf->sae_groups)
253 				goto out_free;
254 			os_memcpy(bss->conf->sae_groups, default_groups,
255 				  sizeof(default_groups));
256 		}
257 
258 		len = os_strlen(ssid->passphrase);
259 		bss->conf->ssid.wpa_passphrase =
260 			dup_binstr(ssid->passphrase, len);
261 
262 		wpa_s->mesh_rsn = mesh_rsn_auth_init(wpa_s, mconf);
263 		if (!wpa_s->mesh_rsn)
264 			goto out_free;
265 	}
266 
267 	wpa_supplicant_conf_ap_ht(wpa_s, ssid, conf);
268 
269 	return 0;
270 out_free:
271 	wpa_supplicant_mesh_deinit(wpa_s);
272 	return -ENOMEM;
273 }
274 
275 
276 void wpa_mesh_notify_peer(struct wpa_supplicant *wpa_s, const u8 *addr,
277 			  const u8 *ies, size_t ie_len)
278 {
279 	struct ieee802_11_elems elems;
280 
281 	wpa_msg(wpa_s, MSG_INFO,
282 		"new peer notification for " MACSTR, MAC2STR(addr));
283 
284 	if (ieee802_11_parse_elems(ies, ie_len, &elems, 0) == ParseFailed) {
285 		wpa_msg(wpa_s, MSG_INFO, "Could not parse beacon from " MACSTR,
286 			MAC2STR(addr));
287 		return;
288 	}
289 	wpa_mesh_new_mesh_peer(wpa_s, addr, &elems);
290 }
291 
292 
293 void wpa_supplicant_mesh_add_scan_ie(struct wpa_supplicant *wpa_s,
294 				     struct wpabuf **extra_ie)
295 {
296 	/* EID + 0-length (wildcard) mesh-id */
297 	size_t ielen = 2;
298 
299 	if (wpabuf_resize(extra_ie, ielen) == 0) {
300 		wpabuf_put_u8(*extra_ie, WLAN_EID_MESH_ID);
301 		wpabuf_put_u8(*extra_ie, 0);
302 	}
303 }
304 
305 
306 int wpa_supplicant_join_mesh(struct wpa_supplicant *wpa_s,
307 			     struct wpa_ssid *ssid)
308 {
309 	struct wpa_driver_mesh_join_params params;
310 	int ret = 0;
311 
312 	if (!ssid || !ssid->ssid || !ssid->ssid_len || !ssid->frequency) {
313 		ret = -ENOENT;
314 		goto out;
315 	}
316 
317 	wpa_supplicant_mesh_deinit(wpa_s);
318 
319 	os_memset(&params, 0, sizeof(params));
320 	params.meshid = ssid->ssid;
321 	params.meshid_len = ssid->ssid_len;
322 	ibss_mesh_setup_freq(wpa_s, ssid, &params.freq);
323 	wpa_s->mesh_ht_enabled = !!params.freq.ht_enabled;
324 	if (ssid->beacon_int > 0)
325 		params.beacon_int = ssid->beacon_int;
326 	else if (wpa_s->conf->beacon_int > 0)
327 		params.beacon_int = wpa_s->conf->beacon_int;
328 	params.max_peer_links = wpa_s->conf->max_peer_links;
329 
330 	if (ssid->key_mgmt & WPA_KEY_MGMT_SAE) {
331 		params.flags |= WPA_DRIVER_MESH_FLAG_SAE_AUTH;
332 		params.flags |= WPA_DRIVER_MESH_FLAG_AMPE;
333 		wpa_s->conf->user_mpm = 1;
334 	}
335 
336 	if (wpa_s->conf->user_mpm) {
337 		params.flags |= WPA_DRIVER_MESH_FLAG_USER_MPM;
338 		params.conf.flags &= ~WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS;
339 	} else {
340 		params.flags |= WPA_DRIVER_MESH_FLAG_DRIVER_MPM;
341 		params.conf.flags |= WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS;
342 	}
343 	params.conf.peer_link_timeout = wpa_s->conf->mesh_max_inactivity;
344 
345 	if (wpa_supplicant_mesh_init(wpa_s, ssid)) {
346 		wpa_msg(wpa_s, MSG_ERROR, "Failed to init mesh");
347 		wpa_drv_leave_mesh(wpa_s);
348 		ret = -1;
349 		goto out;
350 	}
351 
352 	if (wpa_s->ifmsh) {
353 		params.ies = wpa_s->ifmsh->mconf->ies;
354 		params.ie_len = wpa_s->ifmsh->mconf->ie_len;
355 		params.basic_rates = wpa_s->ifmsh->basic_rates;
356 	}
357 
358 	wpa_msg(wpa_s, MSG_INFO, "joining mesh %s",
359 		wpa_ssid_txt(ssid->ssid, ssid->ssid_len));
360 	ret = wpa_drv_join_mesh(wpa_s, &params);
361 	if (ret)
362 		wpa_msg(wpa_s, MSG_ERROR, "mesh join error=%d\n", ret);
363 
364 	/* hostapd sets the interface down until we associate */
365 	wpa_drv_set_operstate(wpa_s, 1);
366 
367 out:
368 	return ret;
369 }
370 
371 
372 int wpa_supplicant_leave_mesh(struct wpa_supplicant *wpa_s)
373 {
374 	int ret = 0;
375 
376 	wpa_msg(wpa_s, MSG_INFO, "leaving mesh");
377 
378 	/* Need to send peering close messages first */
379 	wpa_supplicant_mesh_deinit(wpa_s);
380 
381 	ret = wpa_drv_leave_mesh(wpa_s);
382 	if (ret)
383 		wpa_msg(wpa_s, MSG_ERROR, "mesh leave error=%d", ret);
384 
385 	wpa_drv_set_operstate(wpa_s, 1);
386 
387 	return ret;
388 }
389 
390 
391 static int mesh_attr_text(const u8 *ies, size_t ies_len, char *buf, char *end)
392 {
393 	struct ieee802_11_elems elems;
394 	char *mesh_id, *pos = buf;
395 	u8 *bss_basic_rate_set;
396 	int bss_basic_rate_set_len, ret, i;
397 
398 	if (ieee802_11_parse_elems(ies, ies_len, &elems, 0) == ParseFailed)
399 		return -1;
400 
401 	if (elems.mesh_id_len < 1)
402 		return 0;
403 
404 	mesh_id = os_malloc(elems.mesh_id_len + 1);
405 	if (mesh_id == NULL)
406 		return -1;
407 
408 	os_memcpy(mesh_id, elems.mesh_id, elems.mesh_id_len);
409 	mesh_id[elems.mesh_id_len] = '\0';
410 	ret = os_snprintf(pos, end - pos, "mesh_id=%s\n", mesh_id);
411 	os_free(mesh_id);
412 	if (os_snprintf_error(end - pos, ret))
413 		return pos - buf;
414 	pos += ret;
415 
416 	if (elems.mesh_config_len > 6) {
417 		ret = os_snprintf(pos, end - pos,
418 				  "active_path_selection_protocol_id=0x%02x\n"
419 				  "active_path_selection_metric_id=0x%02x\n"
420 				  "congestion_control_mode_id=0x%02x\n"
421 				  "synchronization_method_id=0x%02x\n"
422 				  "authentication_protocol_id=0x%02x\n"
423 				  "mesh_formation_info=0x%02x\n"
424 				  "mesh_capability=0x%02x\n",
425 				  elems.mesh_config[0], elems.mesh_config[1],
426 				  elems.mesh_config[2], elems.mesh_config[3],
427 				  elems.mesh_config[4], elems.mesh_config[5],
428 				  elems.mesh_config[6]);
429 		if (os_snprintf_error(end - pos, ret))
430 			return pos - buf;
431 		pos += ret;
432 	}
433 
434 	bss_basic_rate_set = os_malloc(elems.supp_rates_len +
435 		elems.ext_supp_rates_len);
436 	if (bss_basic_rate_set == NULL)
437 		return -1;
438 
439 	bss_basic_rate_set_len = 0;
440 	for (i = 0; i < elems.supp_rates_len; i++) {
441 		if (elems.supp_rates[i] & 0x80) {
442 			bss_basic_rate_set[bss_basic_rate_set_len++] =
443 				(elems.supp_rates[i] & 0x7f) * 5;
444 		}
445 	}
446 	for (i = 0; i < elems.ext_supp_rates_len; i++) {
447 		if (elems.ext_supp_rates[i] & 0x80) {
448 			bss_basic_rate_set[bss_basic_rate_set_len++] =
449 				(elems.ext_supp_rates[i] & 0x7f) * 5;
450 		}
451 	}
452 	if (bss_basic_rate_set_len > 0) {
453 		ret = os_snprintf(pos, end - pos, "bss_basic_rate_set=%d",
454 				  bss_basic_rate_set[0]);
455 		if (os_snprintf_error(end - pos, ret))
456 			return pos - buf;
457 		pos += ret;
458 
459 		for (i = 1; i < bss_basic_rate_set_len; i++) {
460 			ret = os_snprintf(pos, end - pos, " %d",
461 					  bss_basic_rate_set[i]);
462 			if (os_snprintf_error(end - pos, ret))
463 				return pos - buf;
464 			pos += ret;
465 		}
466 
467 		ret = os_snprintf(pos, end - pos, "\n");
468 		if (os_snprintf_error(end - pos, ret))
469 			return pos - buf;
470 		pos += ret;
471 	}
472 	os_free(bss_basic_rate_set);
473 
474 	return pos - buf;
475 }
476 
477 
478 int wpas_mesh_scan_result_text(const u8 *ies, size_t ies_len, char *buf,
479 			       char *end)
480 {
481 	return mesh_attr_text(ies, ies_len, buf, end);
482 }
483 
484 
485 static int wpas_mesh_get_ifname(struct wpa_supplicant *wpa_s, char *ifname,
486 				size_t len)
487 {
488 	char *ifname_ptr = wpa_s->ifname;
489 	int res;
490 
491 	res = os_snprintf(ifname, len, "mesh-%s-%d", ifname_ptr,
492 			  wpa_s->mesh_if_idx);
493 	if (os_snprintf_error(len, res) ||
494 	    (os_strlen(ifname) >= IFNAMSIZ &&
495 	     os_strlen(wpa_s->ifname) < IFNAMSIZ)) {
496 		/* Try to avoid going over the IFNAMSIZ length limit */
497 		res = os_snprintf(ifname, len, "mesh-%d", wpa_s->mesh_if_idx);
498 		if (os_snprintf_error(len, res))
499 			return -1;
500 	}
501 	wpa_s->mesh_if_idx++;
502 	return 0;
503 }
504 
505 
506 int wpas_mesh_add_interface(struct wpa_supplicant *wpa_s, char *ifname,
507 			    size_t len)
508 {
509 	struct wpa_interface iface;
510 	struct wpa_supplicant *mesh_wpa_s;
511 	u8 addr[ETH_ALEN];
512 
513 	if (ifname[0] == '\0' && wpas_mesh_get_ifname(wpa_s, ifname, len) < 0)
514 		return -1;
515 
516 	if (wpa_drv_if_add(wpa_s, WPA_IF_MESH, ifname, NULL, NULL, NULL, addr,
517 			   NULL) < 0) {
518 		wpa_printf(MSG_ERROR,
519 			   "mesh: Failed to create new mesh interface");
520 		return -1;
521 	}
522 	wpa_printf(MSG_INFO, "mesh: Created virtual interface %s addr "
523 		   MACSTR, ifname, MAC2STR(addr));
524 
525 	os_memset(&iface, 0, sizeof(iface));
526 	iface.ifname = ifname;
527 	iface.driver = wpa_s->driver->name;
528 	iface.driver_param = wpa_s->conf->driver_param;
529 	iface.ctrl_interface = wpa_s->conf->ctrl_interface;
530 
531 	mesh_wpa_s = wpa_supplicant_add_iface(wpa_s->global, &iface, wpa_s);
532 	if (!mesh_wpa_s) {
533 		wpa_printf(MSG_ERROR,
534 			   "mesh: Failed to create new wpa_supplicant interface");
535 		wpa_supplicant_remove_iface(wpa_s->global, wpa_s, 0);
536 		return -1;
537 	}
538 	mesh_wpa_s->mesh_if_created = 1;
539 	return 0;
540 }
541