xref: /freebsd/contrib/wpa/wpa_supplicant/hs20_supplicant.c (revision 71e72c9e91c4b8007a4292e09669e8b549c29e97)
1 /*
2  * Copyright (c) 2009, Atheros Communications, Inc.
3  * Copyright (c) 2011-2013, Qualcomm Atheros, Inc.
4  *
5  * This software may be distributed under the terms of the BSD license.
6  * See README for more details.
7  */
8 
9 #include "includes.h"
10 #include <sys/stat.h>
11 
12 #include "common.h"
13 #include "eloop.h"
14 #include "common/ieee802_11_common.h"
15 #include "common/ieee802_11_defs.h"
16 #include "common/gas.h"
17 #include "common/wpa_ctrl.h"
18 #include "rsn_supp/wpa.h"
19 #include "wpa_supplicant_i.h"
20 #include "driver_i.h"
21 #include "config.h"
22 #include "scan.h"
23 #include "bss.h"
24 #include "bssid_ignore.h"
25 #include "gas_query.h"
26 #include "interworking.h"
27 #include "hs20_supplicant.h"
28 #include "base64.h"
29 #include "notify.h"
30 
31 
wpas_hs20_add_indication(struct wpabuf * buf,int pps_mo_id,int ap_release)32 void wpas_hs20_add_indication(struct wpabuf *buf, int pps_mo_id, int ap_release)
33 {
34 	int release;
35 	u8 conf;
36 
37 	release = (HS20_VERSION >> 4) + 1;
38 	if (ap_release > 0 && release > ap_release)
39 		release = ap_release;
40 	if (release < 2)
41 		pps_mo_id = -1;
42 
43 	wpabuf_put_u8(buf, WLAN_EID_VENDOR_SPECIFIC);
44 	wpabuf_put_u8(buf, pps_mo_id >= 0 ? 7 : 5);
45 	wpabuf_put_be24(buf, OUI_WFA);
46 	wpabuf_put_u8(buf, HS20_INDICATION_OUI_TYPE);
47 	conf = (release - 1) << 4;
48 	if (pps_mo_id >= 0)
49 		conf |= HS20_PPS_MO_ID_PRESENT;
50 	wpabuf_put_u8(buf, conf);
51 	if (pps_mo_id >= 0)
52 		wpabuf_put_le16(buf, pps_mo_id);
53 }
54 
55 
wpas_hs20_add_roam_cons_sel(struct wpabuf * buf,const struct wpa_ssid * ssid)56 void wpas_hs20_add_roam_cons_sel(struct wpabuf *buf,
57 				 const struct wpa_ssid *ssid)
58 {
59 	if (!ssid->roaming_consortium_selection ||
60 	    !ssid->roaming_consortium_selection_len)
61 		return;
62 
63 	wpabuf_put_u8(buf, WLAN_EID_VENDOR_SPECIFIC);
64 	wpabuf_put_u8(buf, 4 + ssid->roaming_consortium_selection_len);
65 	wpabuf_put_be24(buf, OUI_WFA);
66 	wpabuf_put_u8(buf, HS20_ROAMING_CONS_SEL_OUI_TYPE);
67 	wpabuf_put_data(buf, ssid->roaming_consortium_selection,
68 			ssid->roaming_consortium_selection_len);
69 }
70 
71 
get_hs20_version(struct wpa_bss * bss)72 int get_hs20_version(struct wpa_bss *bss)
73 {
74 	const u8 *ie;
75 
76 	if (!bss)
77 		return 0;
78 
79 	ie = wpa_bss_get_vendor_ie(bss, HS20_IE_VENDOR_TYPE);
80 	if (!ie || ie[1] < 5)
81 		return 0;
82 
83 	return ((ie[6] >> 4) & 0x0f) + 1;
84 }
85 
86 
is_hs20_network(struct wpa_supplicant * wpa_s,struct wpa_ssid * ssid,struct wpa_bss * bss)87 int is_hs20_network(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid,
88 		    struct wpa_bss *bss)
89 {
90 	if (!wpa_s->conf->hs20 || !ssid)
91 		return 0;
92 
93 	if (ssid->parent_cred)
94 		return 1;
95 
96 	if (bss && !wpa_bss_get_vendor_ie(bss, HS20_IE_VENDOR_TYPE))
97 		return 0;
98 
99 	/*
100 	 * This may catch some non-Hotspot 2.0 cases, but it is safer to do that
101 	 * than cause Hotspot 2.0 connections without indication element getting
102 	 * added. Non-Hotspot 2.0 APs should ignore the unknown vendor element.
103 	 */
104 
105 	if (!(ssid->key_mgmt & WPA_KEY_MGMT_IEEE8021X))
106 		return 0;
107 	if (!(ssid->pairwise_cipher & WPA_CIPHER_CCMP))
108 		return 0;
109 	if (ssid->proto != WPA_PROTO_RSN)
110 		return 0;
111 
112 	return 1;
113 }
114 
115 
hs20_get_pps_mo_id(struct wpa_supplicant * wpa_s,struct wpa_ssid * ssid)116 int hs20_get_pps_mo_id(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid)
117 {
118 	struct wpa_cred *cred;
119 
120 	if (ssid == NULL)
121 		return 0;
122 
123 	if (ssid->update_identifier)
124 		return ssid->update_identifier;
125 
126 	if (ssid->parent_cred == NULL)
127 		return 0;
128 
129 	for (cred = wpa_s->conf->cred; cred; cred = cred->next) {
130 		if (ssid->parent_cred == cred)
131 			return cred->update_identifier;
132 	}
133 
134 	return 0;
135 }
136 
137 
hs20_put_anqp_req(u32 stypes,const u8 * payload,size_t payload_len,struct wpabuf * buf)138 void hs20_put_anqp_req(u32 stypes, const u8 *payload, size_t payload_len,
139 		       struct wpabuf *buf)
140 {
141 	u8 *len_pos;
142 
143 	if (buf == NULL)
144 		return;
145 
146 	len_pos = gas_anqp_add_element(buf, ANQP_VENDOR_SPECIFIC);
147 	wpabuf_put_be24(buf, OUI_WFA);
148 	wpabuf_put_u8(buf, HS20_ANQP_OUI_TYPE);
149 	if (stypes == BIT(HS20_STYPE_NAI_HOME_REALM_QUERY)) {
150 		wpabuf_put_u8(buf, HS20_STYPE_NAI_HOME_REALM_QUERY);
151 		wpabuf_put_u8(buf, 0); /* Reserved */
152 		if (payload)
153 			wpabuf_put_data(buf, payload, payload_len);
154 	} else {
155 		u8 i;
156 		wpabuf_put_u8(buf, HS20_STYPE_QUERY_LIST);
157 		wpabuf_put_u8(buf, 0); /* Reserved */
158 		for (i = 0; i < 32; i++) {
159 			if (stypes & BIT(i))
160 				wpabuf_put_u8(buf, i);
161 		}
162 	}
163 	gas_anqp_set_element_len(buf, len_pos);
164 
165 	gas_anqp_set_len(buf);
166 }
167 
168 
hs20_build_anqp_req(u32 stypes,const u8 * payload,size_t payload_len)169 static struct wpabuf * hs20_build_anqp_req(u32 stypes, const u8 *payload,
170 					   size_t payload_len)
171 {
172 	struct wpabuf *buf;
173 
174 	buf = gas_anqp_build_initial_req(0, 100 + payload_len);
175 	if (buf == NULL)
176 		return NULL;
177 
178 	hs20_put_anqp_req(stypes, payload, payload_len, buf);
179 
180 	return buf;
181 }
182 
183 
hs20_anqp_send_req(struct wpa_supplicant * wpa_s,const u8 * dst,u32 stypes,const u8 * payload,size_t payload_len)184 int hs20_anqp_send_req(struct wpa_supplicant *wpa_s, const u8 *dst, u32 stypes,
185 		       const u8 *payload, size_t payload_len)
186 {
187 	struct wpabuf *buf;
188 	int ret = 0;
189 	int freq;
190 	struct wpa_bss *bss;
191 	int res;
192 
193 	bss = wpa_bss_get_bssid(wpa_s, dst);
194 	if (!bss) {
195 		wpa_printf(MSG_WARNING,
196 			   "ANQP: Cannot send query to unknown BSS "
197 			   MACSTR, MAC2STR(dst));
198 		return -1;
199 	}
200 
201 	wpa_bss_anqp_unshare_alloc(bss);
202 	freq = bss->freq;
203 
204 	wpa_printf(MSG_DEBUG, "HS20: ANQP Query Request to " MACSTR " for "
205 		   "subtypes 0x%x", MAC2STR(dst), stypes);
206 
207 	buf = hs20_build_anqp_req(stypes, payload, payload_len);
208 	if (buf == NULL)
209 		return -1;
210 
211 	res = gas_query_req(wpa_s->gas, dst, freq, 0, 0, buf, anqp_resp_cb,
212 			    wpa_s);
213 	if (res < 0) {
214 		wpa_printf(MSG_DEBUG, "ANQP: Failed to send Query Request");
215 		wpabuf_free(buf);
216 		return -1;
217 	} else
218 		wpa_printf(MSG_DEBUG, "ANQP: Query started with dialog token "
219 			   "%u", res);
220 
221 	return ret;
222 }
223 
224 
hs20_parse_rx_hs20_anqp_resp(struct wpa_supplicant * wpa_s,struct wpa_bss * bss,const u8 * sa,const u8 * data,size_t slen,u8 dialog_token)225 void hs20_parse_rx_hs20_anqp_resp(struct wpa_supplicant *wpa_s,
226 				  struct wpa_bss *bss, const u8 *sa,
227 				  const u8 *data, size_t slen, u8 dialog_token)
228 {
229 	const u8 *pos = data;
230 	u8 subtype;
231 	struct wpa_bss_anqp *anqp = NULL;
232 
233 	if (slen < 2)
234 		return;
235 
236 	if (bss)
237 		anqp = bss->anqp;
238 
239 	subtype = *pos++;
240 	slen--;
241 
242 	pos++; /* Reserved */
243 	slen--;
244 
245 	switch (subtype) {
246 	case HS20_STYPE_CAPABILITY_LIST:
247 		wpa_msg(wpa_s, MSG_INFO, RX_HS20_ANQP MACSTR
248 			" HS Capability List", MAC2STR(sa));
249 		wpa_hexdump_ascii(MSG_DEBUG, "HS Capability List", pos, slen);
250 		if (anqp) {
251 			wpabuf_free(anqp->hs20_capability_list);
252 			anqp->hs20_capability_list =
253 				wpabuf_alloc_copy(pos, slen);
254 		}
255 		break;
256 	case HS20_STYPE_OPERATOR_FRIENDLY_NAME:
257 		wpa_msg(wpa_s, MSG_INFO, RX_HS20_ANQP MACSTR
258 			" Operator Friendly Name", MAC2STR(sa));
259 		wpa_hexdump_ascii(MSG_DEBUG, "oper friendly name", pos, slen);
260 		if (anqp) {
261 			wpabuf_free(anqp->hs20_operator_friendly_name);
262 			anqp->hs20_operator_friendly_name =
263 				wpabuf_alloc_copy(pos, slen);
264 		}
265 		break;
266 	case HS20_STYPE_WAN_METRICS:
267 		wpa_hexdump(MSG_DEBUG, "WAN Metrics", pos, slen);
268 		if (slen < 13) {
269 			wpa_dbg(wpa_s, MSG_DEBUG, "HS 2.0: Too short WAN "
270 				"Metrics value from " MACSTR, MAC2STR(sa));
271 			break;
272 		}
273 		wpa_msg(wpa_s, MSG_INFO, RX_HS20_ANQP MACSTR
274 			" WAN Metrics %02x:%u:%u:%u:%u:%u", MAC2STR(sa),
275 			pos[0], WPA_GET_LE32(pos + 1), WPA_GET_LE32(pos + 5),
276 			pos[9], pos[10], WPA_GET_LE16(pos + 11));
277 		if (anqp) {
278 			wpabuf_free(anqp->hs20_wan_metrics);
279 			anqp->hs20_wan_metrics = wpabuf_alloc_copy(pos, slen);
280 		}
281 		break;
282 	case HS20_STYPE_CONNECTION_CAPABILITY:
283 		wpa_msg(wpa_s, MSG_INFO, RX_HS20_ANQP MACSTR
284 			" Connection Capability", MAC2STR(sa));
285 		wpa_hexdump_ascii(MSG_DEBUG, "conn capability", pos, slen);
286 		if (anqp) {
287 			wpabuf_free(anqp->hs20_connection_capability);
288 			anqp->hs20_connection_capability =
289 				wpabuf_alloc_copy(pos, slen);
290 		}
291 		break;
292 	case HS20_STYPE_OPERATING_CLASS:
293 		wpa_msg(wpa_s, MSG_INFO, RX_HS20_ANQP MACSTR
294 			" Operating Class", MAC2STR(sa));
295 		wpa_hexdump_ascii(MSG_DEBUG, "Operating Class", pos, slen);
296 		if (anqp) {
297 			wpabuf_free(anqp->hs20_operating_class);
298 			anqp->hs20_operating_class =
299 				wpabuf_alloc_copy(pos, slen);
300 		}
301 		break;
302 	default:
303 		wpa_printf(MSG_DEBUG, "HS20: Unsupported subtype %u", subtype);
304 		break;
305 	}
306 }
307 
308 
hs20_rx_deauth_imminent_notice(struct wpa_supplicant * wpa_s,u8 code,u16 reauth_delay,const char * url)309 void hs20_rx_deauth_imminent_notice(struct wpa_supplicant *wpa_s, u8 code,
310 				    u16 reauth_delay, const char *url)
311 {
312 	if (!wpa_sm_pmf_enabled(wpa_s->wpa)) {
313 		wpa_printf(MSG_DEBUG, "HS 2.0: Ignore deauthentication imminent notice since PMF was not enabled");
314 		return;
315 	}
316 
317 	wpa_msg(wpa_s, MSG_INFO, HS20_DEAUTH_IMMINENT_NOTICE "%u %u %s",
318 		code, reauth_delay, url);
319 
320 	if (code == HS20_DEAUTH_REASON_CODE_BSS) {
321 		wpa_printf(MSG_DEBUG, "HS 2.0: Add BSS to ignore list");
322 		wpa_bssid_ignore_add(wpa_s, wpa_s->bssid);
323 		/* TODO: For now, disable full ESS since some drivers may not
324 		 * support disabling per BSS. */
325 		if (wpa_s->current_ssid) {
326 			struct os_reltime now;
327 			os_get_reltime(&now);
328 			if (now.sec + reauth_delay <=
329 			    wpa_s->current_ssid->disabled_until.sec)
330 				return;
331 			wpa_printf(MSG_DEBUG, "HS 2.0: Disable network for %u seconds (BSS)",
332 				   reauth_delay);
333 			wpa_s->current_ssid->disabled_until.sec =
334 				now.sec + reauth_delay;
335 		}
336 	}
337 
338 	if (code == HS20_DEAUTH_REASON_CODE_ESS && wpa_s->current_ssid) {
339 		struct os_reltime now;
340 		os_get_reltime(&now);
341 		if (now.sec + reauth_delay <=
342 		    wpa_s->current_ssid->disabled_until.sec)
343 			return;
344 		wpa_printf(MSG_DEBUG, "HS 2.0: Disable network for %u seconds",
345 			   reauth_delay);
346 		wpa_s->current_ssid->disabled_until.sec =
347 			now.sec + reauth_delay;
348 	}
349 }
350 
351 
hs20_rx_t_c_acceptance(struct wpa_supplicant * wpa_s,const char * url)352 void hs20_rx_t_c_acceptance(struct wpa_supplicant *wpa_s, const char *url)
353 {
354 	if (!wpa_sm_pmf_enabled(wpa_s->wpa)) {
355 		wpa_printf(MSG_DEBUG,
356 			   "HS 2.0: Ignore Terms and Conditions Acceptance since PMF was not enabled");
357 		return;
358 	}
359 
360 	wpas_notify_hs20_t_c_acceptance(wpa_s, url);
361 }
362