019dca1563713b760509cb8cc16c77ce7efa8a80
[mech_eap.git] / wpa_supplicant / wnm_sta.c
1 /*
2  * wpa_supplicant - WNM
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 "utils/includes.h"
10
11 #include "utils/common.h"
12 #include "common/ieee802_11_defs.h"
13 #include "common/ieee802_11_common.h"
14 #include "common/wpa_ctrl.h"
15 #include "rsn_supp/wpa.h"
16 #include "wpa_supplicant_i.h"
17 #include "driver_i.h"
18 #include "scan.h"
19 #include "ctrl_iface.h"
20 #include "bss.h"
21 #include "wnm_sta.h"
22 #include "hs20_supplicant.h"
23
24 #define MAX_TFS_IE_LEN  1024
25 #define WNM_MAX_NEIGHBOR_REPORT 10
26
27
28 /* get the TFS IE from driver */
29 static int ieee80211_11_get_tfs_ie(struct wpa_supplicant *wpa_s, u8 *buf,
30                                    u16 *buf_len, enum wnm_oper oper)
31 {
32         wpa_printf(MSG_DEBUG, "%s: TFS get operation %d", __func__, oper);
33
34         return wpa_drv_wnm_oper(wpa_s, oper, wpa_s->bssid, buf, buf_len);
35 }
36
37
38 /* set the TFS IE to driver */
39 static int ieee80211_11_set_tfs_ie(struct wpa_supplicant *wpa_s,
40                                    const u8 *addr, u8 *buf, u16 *buf_len,
41                                    enum wnm_oper oper)
42 {
43         wpa_printf(MSG_DEBUG, "%s: TFS set operation %d", __func__, oper);
44
45         return wpa_drv_wnm_oper(wpa_s, oper, addr, buf, buf_len);
46 }
47
48
49 /* MLME-SLEEPMODE.request */
50 int ieee802_11_send_wnmsleep_req(struct wpa_supplicant *wpa_s,
51                                  u8 action, u16 intval, struct wpabuf *tfs_req)
52 {
53         struct ieee80211_mgmt *mgmt;
54         int res;
55         size_t len;
56         struct wnm_sleep_element *wnmsleep_ie;
57         u8 *wnmtfs_ie;
58         u8 wnmsleep_ie_len;
59         u16 wnmtfs_ie_len;  /* possibly multiple IE(s) */
60         enum wnm_oper tfs_oper = action == 0 ? WNM_SLEEP_TFS_REQ_IE_ADD :
61                 WNM_SLEEP_TFS_REQ_IE_NONE;
62
63         wpa_printf(MSG_DEBUG, "WNM: Request to send WNM-Sleep Mode Request "
64                    "action=%s to " MACSTR,
65                    action == 0 ? "enter" : "exit",
66                    MAC2STR(wpa_s->bssid));
67
68         /* WNM-Sleep Mode IE */
69         wnmsleep_ie_len = sizeof(struct wnm_sleep_element);
70         wnmsleep_ie = os_zalloc(sizeof(struct wnm_sleep_element));
71         if (wnmsleep_ie == NULL)
72                 return -1;
73         wnmsleep_ie->eid = WLAN_EID_WNMSLEEP;
74         wnmsleep_ie->len = wnmsleep_ie_len - 2;
75         wnmsleep_ie->action_type = action;
76         wnmsleep_ie->status = WNM_STATUS_SLEEP_ACCEPT;
77         wnmsleep_ie->intval = host_to_le16(intval);
78         wpa_hexdump(MSG_DEBUG, "WNM: WNM-Sleep Mode element",
79                     (u8 *) wnmsleep_ie, wnmsleep_ie_len);
80
81         /* TFS IE(s) */
82         if (tfs_req) {
83                 wnmtfs_ie_len = wpabuf_len(tfs_req);
84                 wnmtfs_ie = os_malloc(wnmtfs_ie_len);
85                 if (wnmtfs_ie == NULL) {
86                         os_free(wnmsleep_ie);
87                         return -1;
88                 }
89                 os_memcpy(wnmtfs_ie, wpabuf_head(tfs_req), wnmtfs_ie_len);
90         } else {
91                 wnmtfs_ie = os_zalloc(MAX_TFS_IE_LEN);
92                 if (wnmtfs_ie == NULL) {
93                         os_free(wnmsleep_ie);
94                         return -1;
95                 }
96                 if (ieee80211_11_get_tfs_ie(wpa_s, wnmtfs_ie, &wnmtfs_ie_len,
97                                             tfs_oper)) {
98                         wnmtfs_ie_len = 0;
99                         os_free(wnmtfs_ie);
100                         wnmtfs_ie = NULL;
101                 }
102         }
103         wpa_hexdump(MSG_DEBUG, "WNM: TFS Request element",
104                     (u8 *) wnmtfs_ie, wnmtfs_ie_len);
105
106         mgmt = os_zalloc(sizeof(*mgmt) + wnmsleep_ie_len + wnmtfs_ie_len);
107         if (mgmt == NULL) {
108                 wpa_printf(MSG_DEBUG, "MLME: Failed to allocate buffer for "
109                            "WNM-Sleep Request action frame");
110                 os_free(wnmsleep_ie);
111                 os_free(wnmtfs_ie);
112                 return -1;
113         }
114
115         os_memcpy(mgmt->da, wpa_s->bssid, ETH_ALEN);
116         os_memcpy(mgmt->sa, wpa_s->own_addr, ETH_ALEN);
117         os_memcpy(mgmt->bssid, wpa_s->bssid, ETH_ALEN);
118         mgmt->frame_control = IEEE80211_FC(WLAN_FC_TYPE_MGMT,
119                                            WLAN_FC_STYPE_ACTION);
120         mgmt->u.action.category = WLAN_ACTION_WNM;
121         mgmt->u.action.u.wnm_sleep_req.action = WNM_SLEEP_MODE_REQ;
122         mgmt->u.action.u.wnm_sleep_req.dialogtoken = 1;
123         os_memcpy(mgmt->u.action.u.wnm_sleep_req.variable, wnmsleep_ie,
124                   wnmsleep_ie_len);
125         /* copy TFS IE here */
126         if (wnmtfs_ie_len > 0) {
127                 os_memcpy(mgmt->u.action.u.wnm_sleep_req.variable +
128                           wnmsleep_ie_len, wnmtfs_ie, wnmtfs_ie_len);
129         }
130
131         len = 1 + sizeof(mgmt->u.action.u.wnm_sleep_req) + wnmsleep_ie_len +
132                 wnmtfs_ie_len;
133
134         res = wpa_drv_send_action(wpa_s, wpa_s->assoc_freq, 0, wpa_s->bssid,
135                                   wpa_s->own_addr, wpa_s->bssid,
136                                   &mgmt->u.action.category, len, 0);
137         if (res < 0)
138                 wpa_printf(MSG_DEBUG, "Failed to send WNM-Sleep Request "
139                            "(action=%d, intval=%d)", action, intval);
140
141         os_free(wnmsleep_ie);
142         os_free(wnmtfs_ie);
143         os_free(mgmt);
144
145         return res;
146 }
147
148
149 static void wnm_sleep_mode_enter_success(struct wpa_supplicant *wpa_s,
150                                          u8 *tfsresp_ie_start,
151                                          u8 *tfsresp_ie_end)
152 {
153         wpa_drv_wnm_oper(wpa_s, WNM_SLEEP_ENTER_CONFIRM,
154                          wpa_s->bssid, NULL, NULL);
155         /* remove GTK/IGTK ?? */
156
157         /* set the TFS Resp IE(s) */
158         if (tfsresp_ie_start && tfsresp_ie_end &&
159             tfsresp_ie_end - tfsresp_ie_start >= 0) {
160                 u16 tfsresp_ie_len;
161                 tfsresp_ie_len = (tfsresp_ie_end + tfsresp_ie_end[1] + 2) -
162                         tfsresp_ie_start;
163                 wpa_printf(MSG_DEBUG, "TFS Resp IE(s) found");
164                 /* pass the TFS Resp IE(s) to driver for processing */
165                 if (ieee80211_11_set_tfs_ie(wpa_s, wpa_s->bssid,
166                                             tfsresp_ie_start,
167                                             &tfsresp_ie_len,
168                                             WNM_SLEEP_TFS_RESP_IE_SET))
169                         wpa_printf(MSG_DEBUG, "WNM: Fail to set TFS Resp IE");
170         }
171 }
172
173
174 static void wnm_sleep_mode_exit_success(struct wpa_supplicant *wpa_s,
175                                         const u8 *frm, u16 key_len_total)
176 {
177         u8 *ptr, *end;
178         u8 gtk_len;
179
180         wpa_drv_wnm_oper(wpa_s, WNM_SLEEP_EXIT_CONFIRM,  wpa_s->bssid,
181                          NULL, NULL);
182
183         /* Install GTK/IGTK */
184
185         /* point to key data field */
186         ptr = (u8 *) frm + 1 + 2;
187         end = ptr + key_len_total;
188         wpa_hexdump_key(MSG_DEBUG, "WNM: Key Data", ptr, key_len_total);
189
190         while (ptr + 1 < end) {
191                 if (ptr + 2 + ptr[1] > end) {
192                         wpa_printf(MSG_DEBUG, "WNM: Invalid Key Data element "
193                                    "length");
194                         if (end > ptr) {
195                                 wpa_hexdump(MSG_DEBUG, "WNM: Remaining data",
196                                             ptr, end - ptr);
197                         }
198                         break;
199                 }
200                 if (*ptr == WNM_SLEEP_SUBELEM_GTK) {
201                         if (ptr[1] < 11 + 5) {
202                                 wpa_printf(MSG_DEBUG, "WNM: Too short GTK "
203                                            "subelem");
204                                 break;
205                         }
206                         gtk_len = *(ptr + 4);
207                         if (ptr[1] < 11 + gtk_len ||
208                             gtk_len < 5 || gtk_len > 32) {
209                                 wpa_printf(MSG_DEBUG, "WNM: Invalid GTK "
210                                            "subelem");
211                                 break;
212                         }
213                         wpa_wnmsleep_install_key(
214                                 wpa_s->wpa,
215                                 WNM_SLEEP_SUBELEM_GTK,
216                                 ptr);
217                         ptr += 13 + gtk_len;
218 #ifdef CONFIG_IEEE80211W
219                 } else if (*ptr == WNM_SLEEP_SUBELEM_IGTK) {
220                         if (ptr[1] < 2 + 6 + WPA_IGTK_LEN) {
221                                 wpa_printf(MSG_DEBUG, "WNM: Too short IGTK "
222                                            "subelem");
223                                 break;
224                         }
225                         wpa_wnmsleep_install_key(wpa_s->wpa,
226                                                  WNM_SLEEP_SUBELEM_IGTK, ptr);
227                         ptr += 10 + WPA_IGTK_LEN;
228 #endif /* CONFIG_IEEE80211W */
229                 } else
230                         break; /* skip the loop */
231         }
232 }
233
234
235 static void ieee802_11_rx_wnmsleep_resp(struct wpa_supplicant *wpa_s,
236                                         const u8 *frm, int len)
237 {
238         /*
239          * Action [1] | Dialog Token [1] | Key Data Len [2] | Key Data |
240          * WNM-Sleep Mode IE | TFS Response IE
241          */
242         u8 *pos = (u8 *) frm; /* point to payload after the action field */
243         u16 key_len_total;
244         struct wnm_sleep_element *wnmsleep_ie = NULL;
245         /* multiple TFS Resp IE (assuming consecutive) */
246         u8 *tfsresp_ie_start = NULL;
247         u8 *tfsresp_ie_end = NULL;
248
249         if (len < 3)
250                 return;
251         key_len_total = WPA_GET_LE16(frm + 1);
252
253         wpa_printf(MSG_DEBUG, "WNM-Sleep Mode Response token=%u key_len_total=%d",
254                    frm[0], key_len_total);
255         pos += 3 + key_len_total;
256         if (pos > frm + len) {
257                 wpa_printf(MSG_INFO, "WNM: Too short frame for Key Data field");
258                 return;
259         }
260         while (pos - frm < len) {
261                 u8 ie_len = *(pos + 1);
262                 if (pos + 2 + ie_len > frm + len) {
263                         wpa_printf(MSG_INFO, "WNM: Invalid IE len %u", ie_len);
264                         break;
265                 }
266                 wpa_hexdump(MSG_DEBUG, "WNM: Element", pos, 2 + ie_len);
267                 if (*pos == WLAN_EID_WNMSLEEP)
268                         wnmsleep_ie = (struct wnm_sleep_element *) pos;
269                 else if (*pos == WLAN_EID_TFS_RESP) {
270                         if (!tfsresp_ie_start)
271                                 tfsresp_ie_start = pos;
272                         tfsresp_ie_end = pos;
273                 } else
274                         wpa_printf(MSG_DEBUG, "EID %d not recognized", *pos);
275                 pos += ie_len + 2;
276         }
277
278         if (!wnmsleep_ie) {
279                 wpa_printf(MSG_DEBUG, "No WNM-Sleep IE found");
280                 return;
281         }
282
283         if (wnmsleep_ie->status == WNM_STATUS_SLEEP_ACCEPT ||
284             wnmsleep_ie->status == WNM_STATUS_SLEEP_EXIT_ACCEPT_GTK_UPDATE) {
285                 wpa_printf(MSG_DEBUG, "Successfully recv WNM-Sleep Response "
286                            "frame (action=%d, intval=%d)",
287                            wnmsleep_ie->action_type, wnmsleep_ie->intval);
288                 if (wnmsleep_ie->action_type == WNM_SLEEP_MODE_ENTER) {
289                         wnm_sleep_mode_enter_success(wpa_s, tfsresp_ie_start,
290                                                      tfsresp_ie_end);
291                 } else if (wnmsleep_ie->action_type == WNM_SLEEP_MODE_EXIT) {
292                         wnm_sleep_mode_exit_success(wpa_s, frm, key_len_total);
293                 }
294         } else {
295                 wpa_printf(MSG_DEBUG, "Reject recv WNM-Sleep Response frame "
296                            "(action=%d, intval=%d)",
297                            wnmsleep_ie->action_type, wnmsleep_ie->intval);
298                 if (wnmsleep_ie->action_type == WNM_SLEEP_MODE_ENTER)
299                         wpa_drv_wnm_oper(wpa_s, WNM_SLEEP_ENTER_FAIL,
300                                          wpa_s->bssid, NULL, NULL);
301                 else if (wnmsleep_ie->action_type == WNM_SLEEP_MODE_EXIT)
302                         wpa_drv_wnm_oper(wpa_s, WNM_SLEEP_EXIT_FAIL,
303                                          wpa_s->bssid, NULL, NULL);
304         }
305 }
306
307
308 void wnm_deallocate_memory(struct wpa_supplicant *wpa_s)
309 {
310         int i;
311
312         for (i = 0; i < wpa_s->wnm_num_neighbor_report; i++) {
313                 os_free(wpa_s->wnm_neighbor_report_elements[i].meas_pilot);
314                 os_free(wpa_s->wnm_neighbor_report_elements[i].mul_bssid);
315         }
316
317         wpa_s->wnm_num_neighbor_report = 0;
318         os_free(wpa_s->wnm_neighbor_report_elements);
319         wpa_s->wnm_neighbor_report_elements = NULL;
320 }
321
322
323 static void wnm_parse_neighbor_report_elem(struct neighbor_report *rep,
324                                            u8 id, u8 elen, const u8 *pos)
325 {
326         switch (id) {
327         case WNM_NEIGHBOR_TSF:
328                 if (elen < 2 + 2) {
329                         wpa_printf(MSG_DEBUG, "WNM: Too short TSF");
330                         break;
331                 }
332                 rep->tsf_offset = WPA_GET_LE16(pos);
333                 rep->beacon_int = WPA_GET_LE16(pos + 2);
334                 rep->tsf_present = 1;
335                 break;
336         case WNM_NEIGHBOR_CONDENSED_COUNTRY_STRING:
337                 if (elen < 2) {
338                         wpa_printf(MSG_DEBUG, "WNM: Too short condensed "
339                                    "country string");
340                         break;
341                 }
342                 os_memcpy(rep->country, pos, 2);
343                 rep->country_present = 1;
344                 break;
345         case WNM_NEIGHBOR_BSS_TRANSITION_CANDIDATE:
346                 if (elen < 1) {
347                         wpa_printf(MSG_DEBUG, "WNM: Too short BSS transition "
348                                    "candidate");
349                         break;
350                 }
351                 rep->preference = pos[0];
352                 rep->preference_present = 1;
353                 break;
354         case WNM_NEIGHBOR_BSS_TERMINATION_DURATION:
355                 rep->bss_term_tsf = WPA_GET_LE64(pos);
356                 rep->bss_term_dur = WPA_GET_LE16(pos + 8);
357                 rep->bss_term_present = 1;
358                 break;
359         case WNM_NEIGHBOR_BEARING:
360                 if (elen < 8) {
361                         wpa_printf(MSG_DEBUG, "WNM: Too short neighbor "
362                                    "bearing");
363                         break;
364                 }
365                 rep->bearing = WPA_GET_LE16(pos);
366                 rep->distance = WPA_GET_LE32(pos + 2);
367                 rep->rel_height = WPA_GET_LE16(pos + 2 + 4);
368                 rep->bearing_present = 1;
369                 break;
370         case WNM_NEIGHBOR_MEASUREMENT_PILOT:
371                 if (elen < 1) {
372                         wpa_printf(MSG_DEBUG, "WNM: Too short measurement "
373                                    "pilot");
374                         break;
375                 }
376                 os_free(rep->meas_pilot);
377                 rep->meas_pilot = os_zalloc(sizeof(struct measurement_pilot));
378                 if (rep->meas_pilot == NULL)
379                         break;
380                 rep->meas_pilot->measurement_pilot = pos[0];
381                 rep->meas_pilot->subelem_len = elen - 1;
382                 os_memcpy(rep->meas_pilot->subelems, pos + 1, elen - 1);
383                 break;
384         case WNM_NEIGHBOR_RRM_ENABLED_CAPABILITIES:
385                 if (elen < 5) {
386                         wpa_printf(MSG_DEBUG, "WNM: Too short RRM enabled "
387                                    "capabilities");
388                         break;
389                 }
390                 os_memcpy(rep->rm_capab, pos, 5);
391                 rep->rm_capab_present = 1;
392                 break;
393         case WNM_NEIGHBOR_MULTIPLE_BSSID:
394                 if (elen < 1) {
395                         wpa_printf(MSG_DEBUG, "WNM: Too short multiple BSSID");
396                         break;
397                 }
398                 os_free(rep->mul_bssid);
399                 rep->mul_bssid = os_zalloc(sizeof(struct multiple_bssid));
400                 if (rep->mul_bssid == NULL)
401                         break;
402                 rep->mul_bssid->max_bssid_indicator = pos[0];
403                 rep->mul_bssid->subelem_len = elen - 1;
404                 os_memcpy(rep->mul_bssid->subelems, pos + 1, elen - 1);
405                 break;
406         }
407 }
408
409
410 static int wnm_nei_get_chan(struct wpa_supplicant *wpa_s, u8 op_class, u8 chan)
411 {
412         return ieee80211_chan_to_freq(NULL, op_class, chan);
413 }
414
415
416 static void wnm_parse_neighbor_report(struct wpa_supplicant *wpa_s,
417                                       const u8 *pos, u8 len,
418                                       struct neighbor_report *rep)
419 {
420         u8 left = len;
421
422         if (left < 13) {
423                 wpa_printf(MSG_DEBUG, "WNM: Too short neighbor report");
424                 return;
425         }
426
427         os_memcpy(rep->bssid, pos, ETH_ALEN);
428         rep->bssid_info = WPA_GET_LE32(pos + ETH_ALEN);
429         rep->regulatory_class = *(pos + 10);
430         rep->channel_number = *(pos + 11);
431         rep->phy_type = *(pos + 12);
432
433         pos += 13;
434         left -= 13;
435
436         while (left >= 2) {
437                 u8 id, elen;
438
439                 id = *pos++;
440                 elen = *pos++;
441                 wpa_printf(MSG_DEBUG, "WNM: Subelement id=%u len=%u", id, elen);
442                 left -= 2;
443                 if (elen > left) {
444                         wpa_printf(MSG_DEBUG,
445                                    "WNM: Truncated neighbor report subelement");
446                         break;
447                 }
448                 wnm_parse_neighbor_report_elem(rep, id, elen, pos);
449                 left -= elen;
450                 pos += elen;
451         }
452
453         rep->freq = wnm_nei_get_chan(wpa_s, rep->regulatory_class,
454                                      rep->channel_number);
455 }
456
457
458 static struct wpa_bss *
459 compare_scan_neighbor_results(struct wpa_supplicant *wpa_s)
460 {
461
462         u8 i;
463         struct wpa_bss *bss = wpa_s->current_bss;
464         struct wpa_bss *target;
465
466         if (!bss)
467                 return 0;
468
469         wpa_printf(MSG_DEBUG, "WNM: Current BSS " MACSTR " RSSI %d",
470                    MAC2STR(wpa_s->bssid), bss->level);
471
472         for (i = 0; i < wpa_s->wnm_num_neighbor_report; i++) {
473                 struct neighbor_report *nei;
474
475                 nei = &wpa_s->wnm_neighbor_report_elements[i];
476                 if (nei->preference_present && nei->preference == 0) {
477                         wpa_printf(MSG_DEBUG, "Skip excluded BSS " MACSTR,
478                                    MAC2STR(nei->bssid));
479                         continue;
480                 }
481
482                 target = wpa_bss_get_bssid(wpa_s, nei->bssid);
483                 if (!target) {
484                         wpa_printf(MSG_DEBUG, "Candidate BSS " MACSTR
485                                    " (pref %d) not found in scan results",
486                                    MAC2STR(nei->bssid),
487                                    nei->preference_present ? nei->preference :
488                                    -1);
489                         continue;
490                 }
491
492                 if (bss->ssid_len != target->ssid_len ||
493                     os_memcmp(bss->ssid, target->ssid, bss->ssid_len) != 0) {
494                         /*
495                          * TODO: Could consider allowing transition to another
496                          * ESS if PMF was enabled for the association.
497                          */
498                         wpa_printf(MSG_DEBUG, "Candidate BSS " MACSTR
499                                    " (pref %d) in different ESS",
500                                    MAC2STR(nei->bssid),
501                                    nei->preference_present ? nei->preference :
502                                    -1);
503                         continue;
504                 }
505
506                 if (target->level < bss->level && target->level < -80) {
507                         wpa_printf(MSG_DEBUG, "Candidate BSS " MACSTR
508                                    " (pref %d) does not have sufficient signal level (%d)",
509                                    MAC2STR(nei->bssid),
510                                    nei->preference_present ? nei->preference :
511                                    -1,
512                                    target->level);
513                         continue;
514                 }
515
516                 wpa_printf(MSG_DEBUG,
517                            "WNM: Found an acceptable preferred transition candidate BSS "
518                            MACSTR " (RSSI %d)",
519                            MAC2STR(nei->bssid), target->level);
520                 return target;
521         }
522
523         return NULL;
524 }
525
526
527 static void wnm_send_bss_transition_mgmt_resp(
528         struct wpa_supplicant *wpa_s, u8 dialog_token,
529         enum bss_trans_mgmt_status_code status, u8 delay,
530         const u8 *target_bssid)
531 {
532         u8 buf[1000], *pos;
533         struct ieee80211_mgmt *mgmt;
534         size_t len;
535
536         wpa_printf(MSG_DEBUG, "WNM: Send BSS Transition Management Response "
537                    "to " MACSTR " dialog_token=%u status=%u delay=%d",
538                    MAC2STR(wpa_s->bssid), dialog_token, status, delay);
539         if (!wpa_s->current_bss) {
540                 wpa_printf(MSG_DEBUG,
541                            "WNM: Current BSS not known - drop response");
542                 return;
543         }
544
545         mgmt = (struct ieee80211_mgmt *) buf;
546         os_memset(&buf, 0, sizeof(buf));
547         os_memcpy(mgmt->da, wpa_s->bssid, ETH_ALEN);
548         os_memcpy(mgmt->sa, wpa_s->own_addr, ETH_ALEN);
549         os_memcpy(mgmt->bssid, wpa_s->bssid, ETH_ALEN);
550         mgmt->frame_control = IEEE80211_FC(WLAN_FC_TYPE_MGMT,
551                                            WLAN_FC_STYPE_ACTION);
552         mgmt->u.action.category = WLAN_ACTION_WNM;
553         mgmt->u.action.u.bss_tm_resp.action = WNM_BSS_TRANS_MGMT_RESP;
554         mgmt->u.action.u.bss_tm_resp.dialog_token = dialog_token;
555         mgmt->u.action.u.bss_tm_resp.status_code = status;
556         mgmt->u.action.u.bss_tm_resp.bss_termination_delay = delay;
557         pos = mgmt->u.action.u.bss_tm_resp.variable;
558         if (target_bssid) {
559                 os_memcpy(pos, target_bssid, ETH_ALEN);
560                 pos += ETH_ALEN;
561         } else if (status == WNM_BSS_TM_ACCEPT) {
562                 /*
563                  * P802.11-REVmc clarifies that the Target BSSID field is always
564                  * present when status code is zero, so use a fake value here if
565                  * no BSSID is yet known.
566                  */
567                 os_memset(pos, 0, ETH_ALEN);
568                 pos += ETH_ALEN;
569         }
570
571         len = pos - (u8 *) &mgmt->u.action.category;
572
573         wpa_drv_send_action(wpa_s, wpa_s->assoc_freq, 0, wpa_s->bssid,
574                             wpa_s->own_addr, wpa_s->bssid,
575                             &mgmt->u.action.category, len, 0);
576 }
577
578
579 int wnm_scan_process(struct wpa_supplicant *wpa_s, int reply_on_fail)
580 {
581         struct wpa_bss *bss;
582         struct wpa_ssid *ssid = wpa_s->current_ssid;
583         enum bss_trans_mgmt_status_code status = WNM_BSS_TM_REJECT_UNSPECIFIED;
584
585         if (!wpa_s->wnm_neighbor_report_elements)
586                 return 0;
587
588         if (os_reltime_before(&wpa_s->wnm_cand_valid_until,
589                               &wpa_s->scan_trigger_time)) {
590                 wpa_printf(MSG_DEBUG, "WNM: Previously stored BSS transition candidate list is not valid anymore - drop it");
591                 wnm_deallocate_memory(wpa_s);
592                 return 0;
593         }
594
595         if (!wpa_s->current_bss ||
596             os_memcmp(wpa_s->wnm_cand_from_bss, wpa_s->current_bss->bssid,
597                       ETH_ALEN) != 0) {
598                 wpa_printf(MSG_DEBUG, "WNM: Stored BSS transition candidate list not from the current BSS - ignore it");
599                 return 0;
600         }
601
602         /* Compare the Neighbor Report and scan results */
603         bss = compare_scan_neighbor_results(wpa_s);
604         if (!bss) {
605                 wpa_printf(MSG_DEBUG, "WNM: No BSS transition candidate match found");
606                 status = WNM_BSS_TM_REJECT_NO_SUITABLE_CANDIDATES;
607                 goto send_bss_resp_fail;
608         }
609
610         /* Associate to the network */
611         /* Send the BSS Management Response - Accept */
612         if (wpa_s->wnm_reply) {
613                 wpa_s->wnm_reply = 0;
614                 wnm_send_bss_transition_mgmt_resp(wpa_s,
615                                                   wpa_s->wnm_dialog_token,
616                                                   WNM_BSS_TM_ACCEPT,
617                                                   0, bss->bssid);
618         }
619
620         if (bss == wpa_s->current_bss) {
621                 wpa_printf(MSG_DEBUG,
622                            "WNM: Already associated with the preferred candidate");
623                 return 1;
624         }
625
626         wpa_s->reassociate = 1;
627         wpa_supplicant_connect(wpa_s, bss, ssid);
628         wnm_deallocate_memory(wpa_s);
629         return 1;
630
631 send_bss_resp_fail:
632         if (!reply_on_fail)
633                 return 0;
634
635         /* Send reject response for all the failures */
636
637         if (wpa_s->wnm_reply) {
638                 wpa_s->wnm_reply = 0;
639                 wnm_send_bss_transition_mgmt_resp(wpa_s,
640                                                   wpa_s->wnm_dialog_token,
641                                                   status, 0, NULL);
642         }
643         wnm_deallocate_memory(wpa_s);
644
645         return 0;
646 }
647
648
649 static int cand_pref_compar(const void *a, const void *b)
650 {
651         const struct neighbor_report *aa = a;
652         const struct neighbor_report *bb = b;
653
654         if (!aa->preference_present && !bb->preference_present)
655                 return 0;
656         if (!aa->preference_present)
657                 return 1;
658         if (!bb->preference_present)
659                 return -1;
660         if (bb->preference > aa->preference)
661                 return 1;
662         if (bb->preference < aa->preference)
663                 return -1;
664         return 0;
665 }
666
667
668 static void wnm_sort_cand_list(struct wpa_supplicant *wpa_s)
669 {
670         if (!wpa_s->wnm_neighbor_report_elements)
671                 return;
672         qsort(wpa_s->wnm_neighbor_report_elements,
673               wpa_s->wnm_num_neighbor_report, sizeof(struct neighbor_report),
674               cand_pref_compar);
675 }
676
677
678 static void wnm_dump_cand_list(struct wpa_supplicant *wpa_s)
679 {
680         unsigned int i;
681
682         wpa_printf(MSG_DEBUG, "WNM: BSS Transition Candidate List");
683         if (!wpa_s->wnm_neighbor_report_elements)
684                 return;
685         for (i = 0; i < wpa_s->wnm_num_neighbor_report; i++) {
686                 struct neighbor_report *nei;
687
688                 nei = &wpa_s->wnm_neighbor_report_elements[i];
689                 wpa_printf(MSG_DEBUG, "%u: " MACSTR
690                            " info=0x%x op_class=%u chan=%u phy=%u pref=%d freq=%d",
691                            i, MAC2STR(nei->bssid), nei->bssid_info,
692                            nei->regulatory_class,
693                            nei->channel_number, nei->phy_type,
694                            nei->preference_present ? nei->preference : -1,
695                            nei->freq);
696         }
697 }
698
699
700 static int chan_supported(struct wpa_supplicant *wpa_s, int freq)
701 {
702         unsigned int i;
703
704         for (i = 0; i < wpa_s->hw.num_modes; i++) {
705                 struct hostapd_hw_modes *mode = &wpa_s->hw.modes[i];
706                 int j;
707
708                 for (j = 0; j < mode->num_channels; j++) {
709                         struct hostapd_channel_data *chan;
710
711                         chan = &mode->channels[j];
712                         if (chan->freq == freq &&
713                             !(chan->flag & HOSTAPD_CHAN_DISABLED))
714                                 return 1;
715                 }
716         }
717
718         return 0;
719 }
720
721
722 static void wnm_set_scan_freqs(struct wpa_supplicant *wpa_s)
723 {
724         int *freqs;
725         int num_freqs = 0;
726         unsigned int i;
727
728         if (!wpa_s->wnm_neighbor_report_elements)
729                 return;
730
731         if (wpa_s->hw.modes == NULL)
732                 return;
733
734         os_free(wpa_s->next_scan_freqs);
735         wpa_s->next_scan_freqs = NULL;
736
737         freqs = os_calloc(wpa_s->wnm_num_neighbor_report + 1, sizeof(int));
738         if (freqs == NULL)
739                 return;
740
741         for (i = 0; i < wpa_s->wnm_num_neighbor_report; i++) {
742                 struct neighbor_report *nei;
743
744                 nei = &wpa_s->wnm_neighbor_report_elements[i];
745                 if (nei->freq <= 0) {
746                         wpa_printf(MSG_DEBUG,
747                                    "WNM: Unknown neighbor operating frequency for "
748                                    MACSTR " - scan all channels",
749                                    MAC2STR(nei->bssid));
750                         os_free(freqs);
751                         return;
752                 }
753                 if (chan_supported(wpa_s, nei->freq))
754                         add_freq(freqs, &num_freqs, nei->freq);
755         }
756
757         if (num_freqs == 0) {
758                 os_free(freqs);
759                 return;
760         }
761
762         wpa_printf(MSG_DEBUG,
763                    "WNM: Scan %d frequencies based on transition candidate list",
764                    num_freqs);
765         wpa_s->next_scan_freqs = freqs;
766 }
767
768
769 static void ieee802_11_rx_bss_trans_mgmt_req(struct wpa_supplicant *wpa_s,
770                                              const u8 *pos, const u8 *end,
771                                              int reply)
772 {
773         unsigned int beacon_int;
774         u8 valid_int;
775
776         if (pos + 5 > end)
777                 return;
778
779         if (wpa_s->current_bss)
780                 beacon_int = wpa_s->current_bss->beacon_int;
781         else
782                 beacon_int = 100; /* best guess */
783
784         wpa_s->wnm_dialog_token = pos[0];
785         wpa_s->wnm_mode = pos[1];
786         wpa_s->wnm_dissoc_timer = WPA_GET_LE16(pos + 2);
787         valid_int = pos[4];
788         wpa_s->wnm_reply = reply;
789
790         wpa_printf(MSG_DEBUG, "WNM: BSS Transition Management Request: "
791                    "dialog_token=%u request_mode=0x%x "
792                    "disassoc_timer=%u validity_interval=%u",
793                    wpa_s->wnm_dialog_token, wpa_s->wnm_mode,
794                    wpa_s->wnm_dissoc_timer, valid_int);
795
796         pos += 5;
797
798         if (wpa_s->wnm_mode & WNM_BSS_TM_REQ_BSS_TERMINATION_INCLUDED) {
799                 if (pos + 12 > end) {
800                         wpa_printf(MSG_DEBUG, "WNM: Too short BSS TM Request");
801                         return;
802                 }
803                 os_memcpy(wpa_s->wnm_bss_termination_duration, pos, 12);
804                 pos += 12; /* BSS Termination Duration */
805         }
806
807         if (wpa_s->wnm_mode & WNM_BSS_TM_REQ_ESS_DISASSOC_IMMINENT) {
808                 char url[256];
809
810                 if (pos + 1 > end || pos + 1 + pos[0] > end) {
811                         wpa_printf(MSG_DEBUG, "WNM: Invalid BSS Transition "
812                                    "Management Request (URL)");
813                         return;
814                 }
815                 os_memcpy(url, pos + 1, pos[0]);
816                 url[pos[0]] = '\0';
817                 pos += 1 + pos[0];
818
819                 wpa_msg(wpa_s, MSG_INFO, ESS_DISASSOC_IMMINENT "%d %u %s",
820                         wpa_sm_pmf_enabled(wpa_s->wpa),
821                         wpa_s->wnm_dissoc_timer * beacon_int * 128 / 125, url);
822         }
823
824         if (wpa_s->wnm_mode & WNM_BSS_TM_REQ_DISASSOC_IMMINENT) {
825                 wpa_msg(wpa_s, MSG_INFO, "WNM: Disassociation Imminent - "
826                         "Disassociation Timer %u", wpa_s->wnm_dissoc_timer);
827                 if (wpa_s->wnm_dissoc_timer && !wpa_s->scanning) {
828                         /* TODO: mark current BSS less preferred for
829                          * selection */
830                         wpa_printf(MSG_DEBUG, "Trying to find another BSS");
831                         wpa_supplicant_req_scan(wpa_s, 0, 0);
832                 }
833         }
834
835         if (wpa_s->wnm_mode & WNM_BSS_TM_REQ_PREF_CAND_LIST_INCLUDED) {
836                 unsigned int valid_ms;
837
838                 wpa_msg(wpa_s, MSG_INFO, "WNM: Preferred List Available");
839                 wnm_deallocate_memory(wpa_s);
840                 wpa_s->wnm_neighbor_report_elements = os_zalloc(
841                         WNM_MAX_NEIGHBOR_REPORT *
842                         sizeof(struct neighbor_report));
843                 if (wpa_s->wnm_neighbor_report_elements == NULL)
844                         return;
845
846                 while (pos + 2 <= end &&
847                        wpa_s->wnm_num_neighbor_report < WNM_MAX_NEIGHBOR_REPORT)
848                 {
849                         u8 tag = *pos++;
850                         u8 len = *pos++;
851
852                         wpa_printf(MSG_DEBUG, "WNM: Neighbor report tag %u",
853                                    tag);
854                         if (pos + len > end) {
855                                 wpa_printf(MSG_DEBUG, "WNM: Truncated request");
856                                 return;
857                         }
858                         if (tag == WLAN_EID_NEIGHBOR_REPORT) {
859                                 struct neighbor_report *rep;
860                                 rep = &wpa_s->wnm_neighbor_report_elements[
861                                         wpa_s->wnm_num_neighbor_report];
862                                 wnm_parse_neighbor_report(wpa_s, pos, len, rep);
863                         }
864
865                         pos += len;
866                         wpa_s->wnm_num_neighbor_report++;
867                 }
868                 wnm_sort_cand_list(wpa_s);
869                 wnm_dump_cand_list(wpa_s);
870                 valid_ms = valid_int * beacon_int * 128 / 125;
871                 wpa_printf(MSG_DEBUG, "WNM: Candidate list valid for %u ms",
872                            valid_ms);
873                 os_get_reltime(&wpa_s->wnm_cand_valid_until);
874                 wpa_s->wnm_cand_valid_until.sec += valid_ms / 1000;
875                 wpa_s->wnm_cand_valid_until.usec += (valid_ms % 1000) * 1000;
876                 wpa_s->wnm_cand_valid_until.sec +=
877                         wpa_s->wnm_cand_valid_until.usec / 1000000;
878                 wpa_s->wnm_cand_valid_until.usec %= 1000000;
879                 os_memcpy(wpa_s->wnm_cand_from_bss, wpa_s->bssid, ETH_ALEN);
880
881                 if (wpa_s->last_scan_res_used > 0) {
882                         struct os_reltime now;
883
884                         os_get_reltime(&now);
885                         if (!os_reltime_expired(&now, &wpa_s->last_scan, 10)) {
886                                 wpa_printf(MSG_DEBUG,
887                                            "WNM: Try to use recent scan results");
888                                 if (wnm_scan_process(wpa_s, 0) > 0)
889                                         return;
890                                 wpa_printf(MSG_DEBUG,
891                                            "WNM: No match in previous scan results - try a new scan");
892                         }
893                 }
894
895                 wnm_set_scan_freqs(wpa_s);
896                 wpa_supplicant_req_scan(wpa_s, 0, 0);
897         } else if (reply) {
898                 enum bss_trans_mgmt_status_code status;
899                 if (wpa_s->wnm_mode & WNM_BSS_TM_REQ_ESS_DISASSOC_IMMINENT)
900                         status = WNM_BSS_TM_ACCEPT;
901                 else {
902                         wpa_msg(wpa_s, MSG_INFO, "WNM: BSS Transition Management Request did not include candidates");
903                         status = WNM_BSS_TM_REJECT_UNSPECIFIED;
904                 }
905                 wnm_send_bss_transition_mgmt_resp(wpa_s,
906                                                   wpa_s->wnm_dialog_token,
907                                                   status, 0, NULL);
908         }
909 }
910
911
912 int wnm_send_bss_transition_mgmt_query(struct wpa_supplicant *wpa_s,
913                                        u8 query_reason)
914 {
915         u8 buf[1000], *pos;
916         struct ieee80211_mgmt *mgmt;
917         size_t len;
918         int ret;
919
920         wpa_printf(MSG_DEBUG, "WNM: Send BSS Transition Management Query to "
921                    MACSTR " query_reason=%u",
922                    MAC2STR(wpa_s->bssid), query_reason);
923
924         mgmt = (struct ieee80211_mgmt *) buf;
925         os_memset(&buf, 0, sizeof(buf));
926         os_memcpy(mgmt->da, wpa_s->bssid, ETH_ALEN);
927         os_memcpy(mgmt->sa, wpa_s->own_addr, ETH_ALEN);
928         os_memcpy(mgmt->bssid, wpa_s->bssid, ETH_ALEN);
929         mgmt->frame_control = IEEE80211_FC(WLAN_FC_TYPE_MGMT,
930                                            WLAN_FC_STYPE_ACTION);
931         mgmt->u.action.category = WLAN_ACTION_WNM;
932         mgmt->u.action.u.bss_tm_query.action = WNM_BSS_TRANS_MGMT_QUERY;
933         mgmt->u.action.u.bss_tm_query.dialog_token = 1;
934         mgmt->u.action.u.bss_tm_query.query_reason = query_reason;
935         pos = mgmt->u.action.u.bss_tm_query.variable;
936
937         len = pos - (u8 *) &mgmt->u.action.category;
938
939         ret = wpa_drv_send_action(wpa_s, wpa_s->assoc_freq, 0, wpa_s->bssid,
940                                   wpa_s->own_addr, wpa_s->bssid,
941                                   &mgmt->u.action.category, len, 0);
942
943         return ret;
944 }
945
946
947 static void ieee802_11_rx_wnm_notif_req_wfa(struct wpa_supplicant *wpa_s,
948                                             const u8 *sa, const u8 *data,
949                                             int len)
950 {
951         const u8 *pos, *end, *next;
952         u8 ie, ie_len;
953
954         pos = data;
955         end = data + len;
956
957         while (pos + 1 < end) {
958                 ie = *pos++;
959                 ie_len = *pos++;
960                 wpa_printf(MSG_DEBUG, "WNM: WFA subelement %u len %u",
961                            ie, ie_len);
962                 if (ie_len > end - pos) {
963                         wpa_printf(MSG_DEBUG, "WNM: Not enough room for "
964                                    "subelement");
965                         break;
966                 }
967                 next = pos + ie_len;
968                 if (ie_len < 4) {
969                         pos = next;
970                         continue;
971                 }
972                 wpa_printf(MSG_DEBUG, "WNM: Subelement OUI %06x type %u",
973                            WPA_GET_BE24(pos), pos[3]);
974
975 #ifdef CONFIG_HS20
976                 if (ie == WLAN_EID_VENDOR_SPECIFIC && ie_len >= 5 &&
977                     WPA_GET_BE24(pos) == OUI_WFA &&
978                     pos[3] == HS20_WNM_SUB_REM_NEEDED) {
979                         /* Subscription Remediation subelement */
980                         const u8 *ie_end;
981                         u8 url_len;
982                         char *url;
983                         u8 osu_method;
984
985                         wpa_printf(MSG_DEBUG, "WNM: Subscription Remediation "
986                                    "subelement");
987                         ie_end = pos + ie_len;
988                         pos += 4;
989                         url_len = *pos++;
990                         if (url_len == 0) {
991                                 wpa_printf(MSG_DEBUG, "WNM: No Server URL included");
992                                 url = NULL;
993                                 osu_method = 1;
994                         } else {
995                                 if (pos + url_len + 1 > ie_end) {
996                                         wpa_printf(MSG_DEBUG, "WNM: Not enough room for Server URL (len=%u) and Server Method (left %d)",
997                                                    url_len,
998                                                    (int) (ie_end - pos));
999                                         break;
1000                                 }
1001                                 url = os_malloc(url_len + 1);
1002                                 if (url == NULL)
1003                                         break;
1004                                 os_memcpy(url, pos, url_len);
1005                                 url[url_len] = '\0';
1006                                 osu_method = pos[url_len];
1007                         }
1008                         hs20_rx_subscription_remediation(wpa_s, url,
1009                                                          osu_method);
1010                         os_free(url);
1011                         pos = next;
1012                         continue;
1013                 }
1014
1015                 if (ie == WLAN_EID_VENDOR_SPECIFIC && ie_len >= 8 &&
1016                     WPA_GET_BE24(pos) == OUI_WFA &&
1017                     pos[3] == HS20_WNM_DEAUTH_IMMINENT_NOTICE) {
1018                         const u8 *ie_end;
1019                         u8 url_len;
1020                         char *url;
1021                         u8 code;
1022                         u16 reauth_delay;
1023
1024                         ie_end = pos + ie_len;
1025                         pos += 4;
1026                         code = *pos++;
1027                         reauth_delay = WPA_GET_LE16(pos);
1028                         pos += 2;
1029                         url_len = *pos++;
1030                         wpa_printf(MSG_DEBUG, "WNM: HS 2.0 Deauthentication "
1031                                    "Imminent - Reason Code %u   "
1032                                    "Re-Auth Delay %u  URL Length %u",
1033                                    code, reauth_delay, url_len);
1034                         if (pos + url_len > ie_end)
1035                                 break;
1036                         url = os_malloc(url_len + 1);
1037                         if (url == NULL)
1038                                 break;
1039                         os_memcpy(url, pos, url_len);
1040                         url[url_len] = '\0';
1041                         hs20_rx_deauth_imminent_notice(wpa_s, code,
1042                                                        reauth_delay, url);
1043                         os_free(url);
1044                         pos = next;
1045                         continue;
1046                 }
1047 #endif /* CONFIG_HS20 */
1048
1049                 pos = next;
1050         }
1051 }
1052
1053
1054 static void ieee802_11_rx_wnm_notif_req(struct wpa_supplicant *wpa_s,
1055                                         const u8 *sa, const u8 *frm, int len)
1056 {
1057         const u8 *pos, *end;
1058         u8 dialog_token, type;
1059
1060         /* Dialog Token [1] | Type [1] | Subelements */
1061
1062         if (len < 2 || sa == NULL)
1063                 return;
1064         end = frm + len;
1065         pos = frm;
1066         dialog_token = *pos++;
1067         type = *pos++;
1068
1069         wpa_dbg(wpa_s, MSG_DEBUG, "WNM: Received WNM-Notification Request "
1070                 "(dialog_token %u type %u sa " MACSTR ")",
1071                 dialog_token, type, MAC2STR(sa));
1072         wpa_hexdump(MSG_DEBUG, "WNM-Notification Request subelements",
1073                     pos, end - pos);
1074
1075         if (wpa_s->wpa_state != WPA_COMPLETED ||
1076             os_memcmp(sa, wpa_s->bssid, ETH_ALEN) != 0) {
1077                 wpa_dbg(wpa_s, MSG_DEBUG, "WNM: WNM-Notification frame not "
1078                         "from our AP - ignore it");
1079                 return;
1080         }
1081
1082         switch (type) {
1083         case 1:
1084                 ieee802_11_rx_wnm_notif_req_wfa(wpa_s, sa, pos, end - pos);
1085                 break;
1086         default:
1087                 wpa_dbg(wpa_s, MSG_DEBUG, "WNM: Ignore unknown "
1088                         "WNM-Notification type %u", type);
1089                 break;
1090         }
1091 }
1092
1093
1094 void ieee802_11_rx_wnm_action(struct wpa_supplicant *wpa_s,
1095                               const struct ieee80211_mgmt *mgmt, size_t len)
1096 {
1097         const u8 *pos, *end;
1098         u8 act;
1099
1100         if (len < IEEE80211_HDRLEN + 2)
1101                 return;
1102
1103         pos = ((const u8 *) mgmt) + IEEE80211_HDRLEN + 1;
1104         act = *pos++;
1105         end = ((const u8 *) mgmt) + len;
1106
1107         wpa_printf(MSG_DEBUG, "WNM: RX action %u from " MACSTR,
1108                    act, MAC2STR(mgmt->sa));
1109         if (wpa_s->wpa_state < WPA_ASSOCIATED ||
1110             os_memcmp(mgmt->sa, wpa_s->bssid, ETH_ALEN) != 0) {
1111                 wpa_printf(MSG_DEBUG, "WNM: Ignore unexpected WNM Action "
1112                            "frame");
1113                 return;
1114         }
1115
1116         switch (act) {
1117         case WNM_BSS_TRANS_MGMT_REQ:
1118                 ieee802_11_rx_bss_trans_mgmt_req(wpa_s, pos, end,
1119                                                  !(mgmt->da[0] & 0x01));
1120                 break;
1121         case WNM_SLEEP_MODE_RESP:
1122                 ieee802_11_rx_wnmsleep_resp(wpa_s, pos, end - pos);
1123                 break;
1124         case WNM_NOTIFICATION_REQ:
1125                 ieee802_11_rx_wnm_notif_req(wpa_s, mgmt->sa, pos, end - pos);
1126                 break;
1127         default:
1128                 wpa_printf(MSG_ERROR, "WNM: Unknown request");
1129                 break;
1130         }
1131 }