2 * Copyright (c) 2009, Atheros Communications, Inc.
3 * Copyright (c) 2011-2013, Qualcomm Atheros, Inc.
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
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"
24 #include "blacklist.h"
25 #include "gas_query.h"
26 #include "interworking.h"
27 #include "hs20_supplicant.h"
31 #define OSU_MAX_ITEMS 10
33 struct osu_lang_string
{
45 unsigned int failed
:1;
50 u8 osu_ssid
[SSID_MAX_LEN
];
52 u8 osu_ssid2
[SSID_MAX_LEN
];
55 u32 osu_methods
; /* bit 0 = OMA-DM, bit 1 = SOAP-XML SPP */
58 struct osu_lang_string friendly_name
[OSU_MAX_ITEMS
];
59 size_t friendly_name_count
;
60 struct osu_lang_string serv_desc
[OSU_MAX_ITEMS
];
61 size_t serv_desc_count
;
62 struct osu_icon icon
[OSU_MAX_ITEMS
];
67 void hs20_configure_frame_filters(struct wpa_supplicant
*wpa_s
)
69 struct wpa_bss
*bss
= wpa_s
->current_bss
;
70 u8
*bssid
= wpa_s
->bssid
;
75 if (!bss
|| !is_hs20_network(wpa_s
, wpa_s
->current_ssid
, bss
)) {
77 "Not configuring frame filtering - BSS " MACSTR
78 " is not a Hotspot 2.0 network", MAC2STR(bssid
));
82 ie
= wpa_bss_get_vendor_ie(bss
, HS20_IE_VENDOR_TYPE
);
84 /* Check if DGAF disabled bit is zero (5th byte in the IE) */
87 "Not configuring frame filtering - Can't extract DGAF bit");
88 else if (!(ie
[6] & HS20_DGAF_DISABLED
))
89 filter
|= WPA_DATA_FRAME_FILTER_FLAG_GTK
;
91 ext_capa
= wpa_bss_get_ie(bss
, WLAN_EID_EXT_CAPAB
);
92 if (!ext_capa
|| ext_capa
[1] < 2) {
94 "Not configuring frame filtering - Can't extract Proxy ARP bit");
98 if (wpa_bss_ext_capab(bss
, WLAN_EXT_CAPAB_PROXY_ARP
))
99 filter
|= WPA_DATA_FRAME_FILTER_FLAG_ARP
|
100 WPA_DATA_FRAME_FILTER_FLAG_NA
;
102 wpa_drv_configure_frame_filters(wpa_s
, filter
);
106 void wpas_hs20_add_indication(struct wpabuf
*buf
, int pps_mo_id
, int ap_release
)
111 release
= (HS20_VERSION
>> 4) + 1;
112 if (ap_release
> 0 && release
> ap_release
)
113 release
= ap_release
;
117 wpabuf_put_u8(buf
, WLAN_EID_VENDOR_SPECIFIC
);
118 wpabuf_put_u8(buf
, pps_mo_id
>= 0 ? 7 : 5);
119 wpabuf_put_be24(buf
, OUI_WFA
);
120 wpabuf_put_u8(buf
, HS20_INDICATION_OUI_TYPE
);
121 conf
= (release
- 1) << 4;
123 conf
|= HS20_PPS_MO_ID_PRESENT
;
124 wpabuf_put_u8(buf
, conf
);
126 wpabuf_put_le16(buf
, pps_mo_id
);
130 void wpas_hs20_add_roam_cons_sel(struct wpabuf
*buf
,
131 const struct wpa_ssid
*ssid
)
133 if (!ssid
->roaming_consortium_selection
||
134 !ssid
->roaming_consortium_selection_len
)
137 wpabuf_put_u8(buf
, WLAN_EID_VENDOR_SPECIFIC
);
138 wpabuf_put_u8(buf
, 4 + ssid
->roaming_consortium_selection_len
);
139 wpabuf_put_be24(buf
, OUI_WFA
);
140 wpabuf_put_u8(buf
, HS20_ROAMING_CONS_SEL_OUI_TYPE
);
141 wpabuf_put_data(buf
, ssid
->roaming_consortium_selection
,
142 ssid
->roaming_consortium_selection_len
);
146 int get_hs20_version(struct wpa_bss
*bss
)
153 ie
= wpa_bss_get_vendor_ie(bss
, HS20_IE_VENDOR_TYPE
);
154 if (!ie
|| ie
[1] < 5)
157 return ((ie
[6] >> 4) & 0x0f) + 1;
161 int is_hs20_network(struct wpa_supplicant
*wpa_s
, struct wpa_ssid
*ssid
,
164 if (!wpa_s
->conf
->hs20
|| !ssid
)
167 if (ssid
->parent_cred
)
170 if (bss
&& !wpa_bss_get_vendor_ie(bss
, HS20_IE_VENDOR_TYPE
))
174 * This may catch some non-Hotspot 2.0 cases, but it is safer to do that
175 * than cause Hotspot 2.0 connections without indication element getting
176 * added. Non-Hotspot 2.0 APs should ignore the unknown vendor element.
179 if (!(ssid
->key_mgmt
& WPA_KEY_MGMT_IEEE8021X
))
181 if (!(ssid
->pairwise_cipher
& WPA_CIPHER_CCMP
))
183 if (ssid
->proto
!= WPA_PROTO_RSN
)
190 int hs20_get_pps_mo_id(struct wpa_supplicant
*wpa_s
, struct wpa_ssid
*ssid
)
192 struct wpa_cred
*cred
;
197 if (ssid
->update_identifier
)
198 return ssid
->update_identifier
;
200 if (ssid
->parent_cred
== NULL
)
203 for (cred
= wpa_s
->conf
->cred
; cred
; cred
= cred
->next
) {
204 if (ssid
->parent_cred
== cred
)
205 return cred
->update_identifier
;
212 void hs20_put_anqp_req(u32 stypes
, const u8
*payload
, size_t payload_len
,
220 len_pos
= gas_anqp_add_element(buf
, ANQP_VENDOR_SPECIFIC
);
221 wpabuf_put_be24(buf
, OUI_WFA
);
222 wpabuf_put_u8(buf
, HS20_ANQP_OUI_TYPE
);
223 if (stypes
== BIT(HS20_STYPE_NAI_HOME_REALM_QUERY
)) {
224 wpabuf_put_u8(buf
, HS20_STYPE_NAI_HOME_REALM_QUERY
);
225 wpabuf_put_u8(buf
, 0); /* Reserved */
227 wpabuf_put_data(buf
, payload
, payload_len
);
228 } else if (stypes
== BIT(HS20_STYPE_ICON_REQUEST
)) {
229 wpabuf_put_u8(buf
, HS20_STYPE_ICON_REQUEST
);
230 wpabuf_put_u8(buf
, 0); /* Reserved */
232 wpabuf_put_data(buf
, payload
, payload_len
);
235 wpabuf_put_u8(buf
, HS20_STYPE_QUERY_LIST
);
236 wpabuf_put_u8(buf
, 0); /* Reserved */
237 for (i
= 0; i
< 32; i
++) {
239 wpabuf_put_u8(buf
, i
);
242 gas_anqp_set_element_len(buf
, len_pos
);
244 gas_anqp_set_len(buf
);
248 static struct wpabuf
* hs20_build_anqp_req(u32 stypes
, const u8
*payload
,
253 buf
= gas_anqp_build_initial_req(0, 100 + payload_len
);
257 hs20_put_anqp_req(stypes
, payload
, payload_len
, buf
);
263 int hs20_anqp_send_req(struct wpa_supplicant
*wpa_s
, const u8
*dst
, u32 stypes
,
264 const u8
*payload
, size_t payload_len
, int inmem
)
271 struct icon_entry
*icon_entry
;
273 bss
= wpa_bss_get_bssid(wpa_s
, dst
);
275 wpa_printf(MSG_WARNING
,
276 "ANQP: Cannot send query to unknown BSS "
277 MACSTR
, MAC2STR(dst
));
281 wpa_bss_anqp_unshare_alloc(bss
);
284 wpa_printf(MSG_DEBUG
, "HS20: ANQP Query Request to " MACSTR
" for "
285 "subtypes 0x%x", MAC2STR(dst
), stypes
);
287 buf
= hs20_build_anqp_req(stypes
, payload
, payload_len
);
291 res
= gas_query_req(wpa_s
->gas
, dst
, freq
, 0, buf
, anqp_resp_cb
, wpa_s
);
293 wpa_printf(MSG_DEBUG
, "ANQP: Failed to send Query Request");
297 wpa_printf(MSG_DEBUG
, "ANQP: Query started with dialog token "
301 icon_entry
= os_zalloc(sizeof(struct icon_entry
));
304 os_memcpy(icon_entry
->bssid
, dst
, ETH_ALEN
);
305 icon_entry
->file_name
= os_malloc(payload_len
+ 1);
306 if (!icon_entry
->file_name
) {
310 os_memcpy(icon_entry
->file_name
, payload
, payload_len
);
311 icon_entry
->file_name
[payload_len
] = '\0';
312 icon_entry
->dialog_token
= res
;
314 dl_list_add(&wpa_s
->icon_head
, &icon_entry
->list
);
321 static struct icon_entry
* hs20_find_icon(struct wpa_supplicant
*wpa_s
,
323 const char *file_name
)
325 struct icon_entry
*icon
;
327 dl_list_for_each(icon
, &wpa_s
->icon_head
, struct icon_entry
, list
) {
328 if (os_memcmp(icon
->bssid
, bssid
, ETH_ALEN
) == 0 &&
329 os_strcmp(icon
->file_name
, file_name
) == 0 && icon
->image
)
337 int hs20_get_icon(struct wpa_supplicant
*wpa_s
, const u8
*bssid
,
338 const char *file_name
, size_t offset
, size_t size
,
339 char *reply
, size_t buf_len
)
341 struct icon_entry
*icon
;
347 wpa_printf(MSG_DEBUG
, "HS20: Get icon " MACSTR
" %s @ %u +%u (%u)",
348 MAC2STR(bssid
), file_name
, (unsigned int) offset
,
349 (unsigned int) size
, (unsigned int) buf_len
);
351 icon
= hs20_find_icon(wpa_s
, bssid
, file_name
);
352 if (!icon
|| !icon
->image
|| offset
>= icon
->image_len
)
354 if (size
> icon
->image_len
- offset
)
355 size
= icon
->image_len
- offset
;
356 out_size
= buf_len
- 3 /* max base64 padding */;
357 if (size
* 4 > out_size
* 3)
358 size
= out_size
* 3 / 4;
362 b64
= base64_encode(&icon
->image
[offset
], size
, &b64_size
);
363 if (b64
&& buf_len
>= b64_size
) {
364 os_memcpy(reply
, b64
, b64_size
);
365 reply_size
= b64_size
;
374 static void hs20_free_icon_entry(struct icon_entry
*icon
)
376 wpa_printf(MSG_DEBUG
, "HS20: Free stored icon from " MACSTR
377 " dialog_token=%u file_name=%s image_len=%u",
378 MAC2STR(icon
->bssid
), icon
->dialog_token
,
379 icon
->file_name
? icon
->file_name
: "N/A",
380 (unsigned int) icon
->image_len
);
381 os_free(icon
->file_name
);
382 os_free(icon
->image
);
387 int hs20_del_icon(struct wpa_supplicant
*wpa_s
, const u8
*bssid
,
388 const char *file_name
)
390 struct icon_entry
*icon
, *tmp
;
394 wpa_printf(MSG_DEBUG
, "HS20: Delete all stored icons");
396 wpa_printf(MSG_DEBUG
, "HS20: Delete all stored icons for "
397 MACSTR
, MAC2STR(bssid
));
399 wpa_printf(MSG_DEBUG
, "HS20: Delete stored icons for "
400 MACSTR
" file name %s", MAC2STR(bssid
), file_name
);
402 dl_list_for_each_safe(icon
, tmp
, &wpa_s
->icon_head
, struct icon_entry
,
404 if ((!bssid
|| os_memcmp(icon
->bssid
, bssid
, ETH_ALEN
) == 0) &&
406 os_strcmp(icon
->file_name
, file_name
) == 0)) {
407 dl_list_del(&icon
->list
);
408 hs20_free_icon_entry(icon
);
412 return count
== 0 ? -1 : 0;
416 static void hs20_set_osu_access_permission(const char *osu_dir
,
421 /* Get OSU directory information */
422 if (stat(osu_dir
, &statbuf
) < 0) {
423 wpa_printf(MSG_WARNING
, "Cannot stat the OSU directory %s",
428 if (chmod(fname
, statbuf
.st_mode
) < 0) {
429 wpa_printf(MSG_WARNING
,
430 "Cannot change the permissions for %s", fname
);
434 if (lchown(fname
, statbuf
.st_uid
, statbuf
.st_gid
) < 0) {
435 wpa_printf(MSG_WARNING
, "Cannot change the ownership for %s",
441 static void hs20_remove_duplicate_icons(struct wpa_supplicant
*wpa_s
,
442 struct icon_entry
*new_icon
)
444 struct icon_entry
*icon
, *tmp
;
446 dl_list_for_each_safe(icon
, tmp
, &wpa_s
->icon_head
, struct icon_entry
,
448 if (icon
== new_icon
)
450 if (os_memcmp(icon
->bssid
, new_icon
->bssid
, ETH_ALEN
) == 0 &&
451 os_strcmp(icon
->file_name
, new_icon
->file_name
) == 0) {
452 dl_list_del(&icon
->list
);
453 hs20_free_icon_entry(icon
);
459 static int hs20_process_icon_binary_file(struct wpa_supplicant
*wpa_s
,
460 const u8
*sa
, const u8
*pos
,
461 size_t slen
, u8 dialog_token
)
467 struct icon_entry
*icon
;
469 dl_list_for_each(icon
, &wpa_s
->icon_head
, struct icon_entry
, list
) {
470 if (icon
->dialog_token
== dialog_token
&& !icon
->image
&&
471 os_memcmp(icon
->bssid
, sa
, ETH_ALEN
) == 0) {
472 icon
->image
= os_memdup(pos
, slen
);
475 icon
->image_len
= slen
;
476 hs20_remove_duplicate_icons(wpa_s
, icon
);
477 wpa_msg(wpa_s
, MSG_INFO
,
478 RX_HS20_ICON MACSTR
" %s %u",
479 MAC2STR(sa
), icon
->file_name
,
480 (unsigned int) icon
->image_len
);
485 wpa_msg(wpa_s
, MSG_INFO
, RX_HS20_ANQP MACSTR
" Icon Binary File",
489 wpa_dbg(wpa_s
, MSG_DEBUG
, "HS 2.0: Too short Icon Binary File "
490 "value from " MACSTR
, MAC2STR(sa
));
494 wpa_printf(MSG_DEBUG
, "HS 2.0: Download Status Code %u", *pos
);
500 if ((size_t) 1 + pos
[0] > slen
) {
501 wpa_dbg(wpa_s
, MSG_DEBUG
, "HS 2.0: Too short Icon Binary File "
502 "value from " MACSTR
, MAC2STR(sa
));
505 wpa_hexdump_ascii(MSG_DEBUG
, "Icon Type", pos
+ 1, pos
[0]);
506 png
= os_strncasecmp((char *) pos
+ 1, "image/png", 9) == 0;
511 wpa_dbg(wpa_s
, MSG_DEBUG
, "HS 2.0: Too short Icon Binary File "
512 "value from " MACSTR
, MAC2STR(sa
));
515 data_len
= WPA_GET_LE16(pos
);
519 if (data_len
> slen
) {
520 wpa_dbg(wpa_s
, MSG_DEBUG
, "HS 2.0: Too short Icon Binary File "
521 "value from " MACSTR
, MAC2STR(sa
));
525 wpa_printf(MSG_DEBUG
, "Icon Binary Data: %u bytes", data_len
);
526 if (wpa_s
->conf
->osu_dir
== NULL
)
529 wpa_s
->osu_icon_id
++;
530 if (wpa_s
->osu_icon_id
== 0)
531 wpa_s
->osu_icon_id
++;
532 snprintf(fname
, sizeof(fname
), "%s/osu-icon-%u.%s",
533 wpa_s
->conf
->osu_dir
, wpa_s
->osu_icon_id
,
534 png
? "png" : "icon");
535 f
= fopen(fname
, "wb");
539 hs20_set_osu_access_permission(wpa_s
->conf
->osu_dir
, fname
);
541 if (fwrite(pos
, slen
, 1, f
) != 1) {
548 wpa_msg(wpa_s
, MSG_INFO
, RX_HS20_ANQP_ICON
"%s", fname
);
553 static void hs20_continue_icon_fetch(void *eloop_ctx
, void *sock_ctx
)
555 struct wpa_supplicant
*wpa_s
= eloop_ctx
;
556 if (wpa_s
->fetch_osu_icon_in_progress
)
557 hs20_next_osu_icon(wpa_s
);
561 static void hs20_osu_icon_fetch_result(struct wpa_supplicant
*wpa_s
, int res
)
564 struct os_reltime now
, tmp
;
567 os_get_reltime(&now
);
568 os_reltime_sub(&now
, &wpa_s
->osu_icon_fetch_start
, &tmp
);
569 dur
= tmp
.sec
* 1000 + tmp
.usec
/ 1000;
570 wpa_printf(MSG_DEBUG
, "HS 2.0: Icon fetch dur=%d ms res=%d",
573 for (i
= 0; i
< wpa_s
->osu_prov_count
; i
++) {
574 struct osu_provider
*osu
= &wpa_s
->osu_prov
[i
];
575 for (j
= 0; j
< osu
->icon_count
; j
++) {
576 struct osu_icon
*icon
= &osu
->icon
[j
];
577 if (icon
->id
|| icon
->failed
)
582 icon
->id
= wpa_s
->osu_icon_id
;
589 void hs20_parse_rx_hs20_anqp_resp(struct wpa_supplicant
*wpa_s
,
590 struct wpa_bss
*bss
, const u8
*sa
,
591 const u8
*data
, size_t slen
, u8 dialog_token
)
593 const u8
*pos
= data
;
595 struct wpa_bss_anqp
*anqp
= NULL
;
607 pos
++; /* Reserved */
611 case HS20_STYPE_CAPABILITY_LIST
:
612 wpa_msg(wpa_s
, MSG_INFO
, RX_HS20_ANQP MACSTR
613 " HS Capability List", MAC2STR(sa
));
614 wpa_hexdump_ascii(MSG_DEBUG
, "HS Capability List", pos
, slen
);
616 wpabuf_free(anqp
->hs20_capability_list
);
617 anqp
->hs20_capability_list
=
618 wpabuf_alloc_copy(pos
, slen
);
621 case HS20_STYPE_OPERATOR_FRIENDLY_NAME
:
622 wpa_msg(wpa_s
, MSG_INFO
, RX_HS20_ANQP MACSTR
623 " Operator Friendly Name", MAC2STR(sa
));
624 wpa_hexdump_ascii(MSG_DEBUG
, "oper friendly name", pos
, slen
);
626 wpabuf_free(anqp
->hs20_operator_friendly_name
);
627 anqp
->hs20_operator_friendly_name
=
628 wpabuf_alloc_copy(pos
, slen
);
631 case HS20_STYPE_WAN_METRICS
:
632 wpa_hexdump(MSG_DEBUG
, "WAN Metrics", pos
, slen
);
634 wpa_dbg(wpa_s
, MSG_DEBUG
, "HS 2.0: Too short WAN "
635 "Metrics value from " MACSTR
, MAC2STR(sa
));
638 wpa_msg(wpa_s
, MSG_INFO
, RX_HS20_ANQP MACSTR
639 " WAN Metrics %02x:%u:%u:%u:%u:%u", MAC2STR(sa
),
640 pos
[0], WPA_GET_LE32(pos
+ 1), WPA_GET_LE32(pos
+ 5),
641 pos
[9], pos
[10], WPA_GET_LE16(pos
+ 11));
643 wpabuf_free(anqp
->hs20_wan_metrics
);
644 anqp
->hs20_wan_metrics
= wpabuf_alloc_copy(pos
, slen
);
647 case HS20_STYPE_CONNECTION_CAPABILITY
:
648 wpa_msg(wpa_s
, MSG_INFO
, RX_HS20_ANQP MACSTR
649 " Connection Capability", MAC2STR(sa
));
650 wpa_hexdump_ascii(MSG_DEBUG
, "conn capability", pos
, slen
);
652 wpabuf_free(anqp
->hs20_connection_capability
);
653 anqp
->hs20_connection_capability
=
654 wpabuf_alloc_copy(pos
, slen
);
657 case HS20_STYPE_OPERATING_CLASS
:
658 wpa_msg(wpa_s
, MSG_INFO
, RX_HS20_ANQP MACSTR
659 " Operating Class", MAC2STR(sa
));
660 wpa_hexdump_ascii(MSG_DEBUG
, "Operating Class", pos
, slen
);
662 wpabuf_free(anqp
->hs20_operating_class
);
663 anqp
->hs20_operating_class
=
664 wpabuf_alloc_copy(pos
, slen
);
667 case HS20_STYPE_OSU_PROVIDERS_LIST
:
668 wpa_msg(wpa_s
, MSG_INFO
, RX_HS20_ANQP MACSTR
669 " OSU Providers list", MAC2STR(sa
));
670 wpa_s
->num_prov_found
++;
672 wpabuf_free(anqp
->hs20_osu_providers_list
);
673 anqp
->hs20_osu_providers_list
=
674 wpabuf_alloc_copy(pos
, slen
);
677 case HS20_STYPE_ICON_BINARY_FILE
:
678 ret
= hs20_process_icon_binary_file(wpa_s
, sa
, pos
, slen
,
680 if (wpa_s
->fetch_osu_icon_in_progress
) {
681 hs20_osu_icon_fetch_result(wpa_s
, ret
);
682 eloop_cancel_timeout(hs20_continue_icon_fetch
,
684 eloop_register_timeout(0, 0, hs20_continue_icon_fetch
,
688 case HS20_STYPE_OPERATOR_ICON_METADATA
:
689 wpa_msg(wpa_s
, MSG_INFO
, RX_HS20_ANQP MACSTR
690 " Operator Icon Metadata", MAC2STR(sa
));
691 wpa_hexdump(MSG_DEBUG
, "Operator Icon Metadata", pos
, slen
);
693 wpabuf_free(anqp
->hs20_operator_icon_metadata
);
694 anqp
->hs20_operator_icon_metadata
=
695 wpabuf_alloc_copy(pos
, slen
);
698 case HS20_STYPE_OSU_PROVIDERS_NAI_LIST
:
699 wpa_msg(wpa_s
, MSG_INFO
, RX_HS20_ANQP MACSTR
700 " OSU Providers NAI List", MAC2STR(sa
));
702 wpabuf_free(anqp
->hs20_osu_providers_nai_list
);
703 anqp
->hs20_osu_providers_nai_list
=
704 wpabuf_alloc_copy(pos
, slen
);
708 wpa_printf(MSG_DEBUG
, "HS20: Unsupported subtype %u", subtype
);
714 void hs20_notify_parse_done(struct wpa_supplicant
*wpa_s
)
716 if (!wpa_s
->fetch_osu_icon_in_progress
)
718 if (eloop_is_timeout_registered(hs20_continue_icon_fetch
, wpa_s
, NULL
))
721 * We are going through icon fetch, but no icon response was received.
722 * Assume this means the current AP could not provide an answer to avoid
723 * getting stuck in fetch iteration.
725 hs20_icon_fetch_failed(wpa_s
);
729 static void hs20_free_osu_prov_entry(struct osu_provider
*prov
)
734 void hs20_free_osu_prov(struct wpa_supplicant
*wpa_s
)
737 for (i
= 0; i
< wpa_s
->osu_prov_count
; i
++)
738 hs20_free_osu_prov_entry(&wpa_s
->osu_prov
[i
]);
739 os_free(wpa_s
->osu_prov
);
740 wpa_s
->osu_prov
= NULL
;
741 wpa_s
->osu_prov_count
= 0;
745 static void hs20_osu_fetch_done(struct wpa_supplicant
*wpa_s
)
751 wpa_s
->fetch_osu_info
= 0;
752 wpa_s
->fetch_osu_icon_in_progress
= 0;
754 if (wpa_s
->conf
->osu_dir
== NULL
) {
755 hs20_free_osu_prov(wpa_s
);
756 wpa_s
->fetch_anqp_in_progress
= 0;
760 snprintf(fname
, sizeof(fname
), "%s/osu-providers.txt",
761 wpa_s
->conf
->osu_dir
);
762 f
= fopen(fname
, "w");
764 wpa_msg(wpa_s
, MSG_INFO
,
765 "Could not write OSU provider information");
766 hs20_free_osu_prov(wpa_s
);
767 wpa_s
->fetch_anqp_in_progress
= 0;
771 hs20_set_osu_access_permission(wpa_s
->conf
->osu_dir
, fname
);
773 for (i
= 0; i
< wpa_s
->osu_prov_count
; i
++) {
774 struct osu_provider
*osu
= &wpa_s
->osu_prov
[i
];
777 fprintf(f
, "OSU-PROVIDER " MACSTR
"\n"
780 MAC2STR(osu
->bssid
), osu
->server_uri
, osu
->osu_methods
);
781 if (osu
->osu_ssid_len
) {
782 fprintf(f
, "osu_ssid=%s\n",
783 wpa_ssid_txt(osu
->osu_ssid
,
786 if (osu
->osu_ssid2_len
) {
787 fprintf(f
, "osu_ssid2=%s\n",
788 wpa_ssid_txt(osu
->osu_ssid2
,
789 osu
->osu_ssid2_len
));
792 fprintf(f
, "osu_nai=%s\n", osu
->osu_nai
);
793 if (osu
->osu_nai2
[0])
794 fprintf(f
, "osu_nai2=%s\n", osu
->osu_nai2
);
795 for (j
= 0; j
< osu
->friendly_name_count
; j
++) {
796 fprintf(f
, "friendly_name=%s:%s\n",
797 osu
->friendly_name
[j
].lang
,
798 osu
->friendly_name
[j
].text
);
800 for (j
= 0; j
< osu
->serv_desc_count
; j
++) {
801 fprintf(f
, "desc=%s:%s\n",
802 osu
->serv_desc
[j
].lang
,
803 osu
->serv_desc
[j
].text
);
805 for (j
= 0; j
< osu
->icon_count
; j
++) {
806 struct osu_icon
*icon
= &osu
->icon
[j
];
808 continue; /* could not fetch icon */
809 fprintf(f
, "icon=%u:%u:%u:%s:%s:%s\n",
810 icon
->id
, icon
->width
, icon
->height
, icon
->lang
,
811 icon
->icon_type
, icon
->filename
);
815 hs20_free_osu_prov(wpa_s
);
817 wpa_msg(wpa_s
, MSG_INFO
, "OSU provider fetch completed");
818 wpa_s
->fetch_anqp_in_progress
= 0;
822 void hs20_next_osu_icon(struct wpa_supplicant
*wpa_s
)
826 wpa_printf(MSG_DEBUG
, "HS 2.0: Ready to fetch next icon");
828 for (i
= 0; i
< wpa_s
->osu_prov_count
; i
++) {
829 struct osu_provider
*osu
= &wpa_s
->osu_prov
[i
];
830 for (j
= 0; j
< osu
->icon_count
; j
++) {
831 struct osu_icon
*icon
= &osu
->icon
[j
];
832 if (icon
->id
|| icon
->failed
)
835 wpa_printf(MSG_DEBUG
, "HS 2.0: Try to fetch icon '%s' "
836 "from " MACSTR
, icon
->filename
,
837 MAC2STR(osu
->bssid
));
838 os_get_reltime(&wpa_s
->osu_icon_fetch_start
);
839 if (hs20_anqp_send_req(wpa_s
, osu
->bssid
,
840 BIT(HS20_STYPE_ICON_REQUEST
),
841 (u8
*) icon
->filename
,
842 os_strlen(icon
->filename
),
851 wpa_printf(MSG_DEBUG
, "HS 2.0: No more icons to fetch");
852 hs20_osu_fetch_done(wpa_s
);
856 static void hs20_osu_add_prov(struct wpa_supplicant
*wpa_s
, struct wpa_bss
*bss
,
857 const u8
*osu_ssid
, u8 osu_ssid_len
,
858 const u8
*osu_ssid2
, u8 osu_ssid2_len
,
859 const u8
*pos
, size_t len
)
861 struct osu_provider
*prov
;
862 const u8
*end
= pos
+ len
;
865 u8 uri_len
, osu_method_len
, osu_nai_len
;
867 wpa_hexdump(MSG_DEBUG
, "HS 2.0: Parsing OSU Provider", pos
, len
);
868 prov
= os_realloc_array(wpa_s
->osu_prov
,
869 wpa_s
->osu_prov_count
+ 1,
873 wpa_s
->osu_prov
= prov
;
874 prov
= &prov
[wpa_s
->osu_prov_count
];
875 os_memset(prov
, 0, sizeof(*prov
));
877 os_memcpy(prov
->bssid
, bss
->bssid
, ETH_ALEN
);
878 os_memcpy(prov
->osu_ssid
, osu_ssid
, osu_ssid_len
);
879 prov
->osu_ssid_len
= osu_ssid_len
;
881 os_memcpy(prov
->osu_ssid2
, osu_ssid2
, osu_ssid2_len
);
882 prov
->osu_ssid2_len
= osu_ssid2_len
;
884 /* OSU Friendly Name Length */
886 wpa_printf(MSG_DEBUG
, "HS 2.0: Not enough room for OSU "
887 "Friendly Name Length");
890 len2
= WPA_GET_LE16(pos
);
892 if (len2
> end
- pos
) {
893 wpa_printf(MSG_DEBUG
, "HS 2.0: Not enough room for OSU "
894 "Friendly Name Duples");
900 /* OSU Friendly Name Duples */
901 while (pos
- pos2
>= 4 && prov
->friendly_name_count
< OSU_MAX_ITEMS
) {
902 struct osu_lang_string
*f
;
903 if (1 + pos2
[0] > pos
- pos2
|| pos2
[0] < 3) {
904 wpa_printf(MSG_DEBUG
, "Invalid OSU Friendly Name");
907 f
= &prov
->friendly_name
[prov
->friendly_name_count
++];
908 os_memcpy(f
->lang
, pos2
+ 1, 3);
909 os_memcpy(f
->text
, pos2
+ 1 + 3, pos2
[0] - 3);
915 wpa_printf(MSG_DEBUG
,
916 "HS 2.0: Not enough room for OSU Server URI length");
920 if (uri_len
> end
- pos
) {
921 wpa_printf(MSG_DEBUG
, "HS 2.0: Not enough room for OSU Server "
925 os_memcpy(prov
->server_uri
, pos
, uri_len
);
928 /* OSU Method list */
930 wpa_printf(MSG_DEBUG
, "HS 2.0: Not enough room for OSU Method "
934 osu_method_len
= pos
[0];
935 if (osu_method_len
> end
- pos
- 1) {
936 wpa_printf(MSG_DEBUG
, "HS 2.0: Not enough room for OSU Method "
941 pos
+= 1 + osu_method_len
;
944 prov
->osu_methods
|= BIT(*pos2
);
948 /* Icons Available Length */
950 wpa_printf(MSG_DEBUG
, "HS 2.0: Not enough room for Icons "
954 len2
= WPA_GET_LE16(pos
);
956 if (len2
> end
- pos
) {
957 wpa_printf(MSG_DEBUG
, "HS 2.0: Not enough room for Icons "
964 /* Icons Available */
966 struct osu_icon
*icon
= &prov
->icon
[prov
->icon_count
];
969 if (2 + 2 + 3 + 1 + 1 > pos
- pos2
) {
970 wpa_printf(MSG_DEBUG
, "HS 2.0: Invalid Icon Metadata");
974 icon
->width
= WPA_GET_LE16(pos2
);
976 icon
->height
= WPA_GET_LE16(pos2
);
978 os_memcpy(icon
->lang
, pos2
, 3);
982 if (flen
> pos
- pos2
) {
983 wpa_printf(MSG_DEBUG
, "HS 2.0: Not room for Icon Type");
986 os_memcpy(icon
->icon_type
, pos2
, flen
);
989 if (pos
- pos2
< 1) {
990 wpa_printf(MSG_DEBUG
, "HS 2.0: Not room for Icon "
995 if (flen
> pos
- pos2
) {
996 wpa_printf(MSG_DEBUG
, "HS 2.0: Not room for Icon "
1000 os_memcpy(icon
->filename
, pos2
, flen
);
1007 if (end
- pos
< 1) {
1008 wpa_printf(MSG_DEBUG
, "HS 2.0: Not enough room for OSU_NAI");
1011 osu_nai_len
= *pos
++;
1012 if (osu_nai_len
> end
- pos
) {
1013 wpa_printf(MSG_DEBUG
, "HS 2.0: Not enough room for OSU_NAI");
1016 os_memcpy(prov
->osu_nai
, pos
, osu_nai_len
);
1019 /* OSU Service Description Length */
1020 if (end
- pos
< 2) {
1021 wpa_printf(MSG_DEBUG
, "HS 2.0: Not enough room for OSU "
1022 "Service Description Length");
1025 len2
= WPA_GET_LE16(pos
);
1027 if (len2
> end
- pos
) {
1028 wpa_printf(MSG_DEBUG
, "HS 2.0: Not enough room for OSU "
1029 "Service Description Duples");
1035 /* OSU Service Description Duples */
1036 while (pos
- pos2
>= 4 && prov
->serv_desc_count
< OSU_MAX_ITEMS
) {
1037 struct osu_lang_string
*f
;
1040 descr_len
= *pos2
++;
1041 if (descr_len
> pos
- pos2
|| descr_len
< 3) {
1042 wpa_printf(MSG_DEBUG
, "Invalid OSU Service "
1046 f
= &prov
->serv_desc
[prov
->serv_desc_count
++];
1047 os_memcpy(f
->lang
, pos2
, 3);
1048 os_memcpy(f
->text
, pos2
+ 3, descr_len
- 3);
1052 wpa_printf(MSG_DEBUG
, "HS 2.0: Added OSU Provider through " MACSTR
,
1053 MAC2STR(bss
->bssid
));
1054 wpa_s
->osu_prov_count
++;
1058 void hs20_osu_icon_fetch(struct wpa_supplicant
*wpa_s
)
1060 struct wpa_bss
*bss
;
1061 struct wpabuf
*prov_anqp
;
1062 const u8
*pos
, *end
;
1064 const u8
*osu_ssid
, *osu_ssid2
;
1065 u8 osu_ssid_len
, osu_ssid2_len
;
1068 hs20_free_osu_prov(wpa_s
);
1070 dl_list_for_each(bss
, &wpa_s
->bss
, struct wpa_bss
, list
) {
1071 struct wpa_ie_data data
;
1074 if (bss
->anqp
== NULL
)
1076 prov_anqp
= bss
->anqp
->hs20_osu_providers_list
;
1077 if (prov_anqp
== NULL
)
1079 ie
= wpa_bss_get_ie(bss
, WLAN_EID_RSN
);
1080 if (ie
&& wpa_parse_wpa_ie(ie
, 2 + ie
[1], &data
) == 0 &&
1081 (data
.key_mgmt
& WPA_KEY_MGMT_OSEN
)) {
1082 osu_ssid2
= bss
->ssid
;
1083 osu_ssid2_len
= bss
->ssid_len
;
1088 wpa_printf(MSG_DEBUG
, "HS 2.0: Parsing OSU Providers list from "
1089 MACSTR
, MAC2STR(bss
->bssid
));
1090 wpa_hexdump_buf(MSG_DEBUG
, "HS 2.0: OSU Providers list",
1092 pos
= wpabuf_head(prov_anqp
);
1093 end
= pos
+ wpabuf_len(prov_anqp
);
1098 if (1 + pos
[0] > end
- pos
) {
1099 wpa_printf(MSG_DEBUG
, "HS 2.0: Not enough room for "
1103 osu_ssid_len
= *pos
++;
1104 if (osu_ssid_len
> SSID_MAX_LEN
) {
1105 wpa_printf(MSG_DEBUG
, "HS 2.0: Invalid OSU SSID "
1106 "Length %u", osu_ssid_len
);
1110 pos
+= osu_ssid_len
;
1112 if (end
- pos
< 1) {
1113 wpa_printf(MSG_DEBUG
, "HS 2.0: Not enough room for "
1114 "Number of OSU Providers");
1117 num_providers
= *pos
++;
1118 wpa_printf(MSG_DEBUG
, "HS 2.0: Number of OSU Providers: %u",
1122 while (end
- pos
> 2 && num_providers
> 0) {
1124 len
= WPA_GET_LE16(pos
);
1126 if (len
> (unsigned int) (end
- pos
))
1128 hs20_osu_add_prov(wpa_s
, bss
, osu_ssid
,
1129 osu_ssid_len
, osu_ssid2
,
1130 osu_ssid2_len
, pos
, len
);
1135 wpa_printf(MSG_DEBUG
, "HS 2.0: Ignored %d bytes of "
1136 "extra data after OSU Providers",
1140 prov_anqp
= bss
->anqp
->hs20_osu_providers_nai_list
;
1143 wpa_printf(MSG_DEBUG
,
1144 "HS 2.0: Parsing OSU Providers NAI List from "
1145 MACSTR
, MAC2STR(bss
->bssid
));
1146 wpa_hexdump_buf(MSG_DEBUG
, "HS 2.0: OSU Providers NAI List",
1148 pos
= wpabuf_head(prov_anqp
);
1149 end
= pos
+ wpabuf_len(prov_anqp
);
1151 while (end
- pos
> 0) {
1153 if (end
- pos
< len
) {
1154 wpa_printf(MSG_DEBUG
,
1155 "HS 2.0: Not enough room for OSU_NAI");
1158 if (num_providers
>= wpa_s
->osu_prov_count
) {
1159 wpa_printf(MSG_DEBUG
,
1160 "HS 2.0: Ignore unexpected OSU Provider NAI List entries");
1163 os_memcpy(wpa_s
->osu_prov
[num_providers
].osu_nai2
,
1170 wpa_s
->fetch_osu_icon_in_progress
= 1;
1171 hs20_next_osu_icon(wpa_s
);
1175 static void hs20_osu_scan_res_handler(struct wpa_supplicant
*wpa_s
,
1176 struct wpa_scan_results
*scan_res
)
1178 wpa_printf(MSG_DEBUG
, "OSU provisioning fetch scan completed");
1179 if (!wpa_s
->fetch_osu_waiting_scan
) {
1180 wpa_printf(MSG_DEBUG
, "OSU fetch have been canceled");
1183 wpa_s
->network_select
= 0;
1184 wpa_s
->fetch_all_anqp
= 1;
1185 wpa_s
->fetch_osu_info
= 1;
1186 wpa_s
->fetch_osu_icon_in_progress
= 0;
1188 interworking_start_fetch_anqp(wpa_s
);
1192 int hs20_fetch_osu(struct wpa_supplicant
*wpa_s
, int skip_scan
)
1194 if (wpa_s
->wpa_state
== WPA_INTERFACE_DISABLED
) {
1195 wpa_printf(MSG_DEBUG
, "HS 2.0: Cannot start fetch_osu - "
1196 "interface disabled");
1200 if (wpa_s
->scanning
) {
1201 wpa_printf(MSG_DEBUG
, "HS 2.0: Cannot start fetch_osu - "
1206 if (wpa_s
->conf
->osu_dir
== NULL
) {
1207 wpa_printf(MSG_DEBUG
, "HS 2.0: Cannot start fetch_osu - "
1208 "osu_dir not configured");
1212 if (wpa_s
->fetch_anqp_in_progress
|| wpa_s
->network_select
) {
1213 wpa_printf(MSG_DEBUG
, "HS 2.0: Cannot start fetch_osu - "
1214 "fetch in progress (%d, %d)",
1215 wpa_s
->fetch_anqp_in_progress
,
1216 wpa_s
->network_select
);
1220 wpa_msg(wpa_s
, MSG_INFO
, "Starting OSU provisioning information fetch");
1221 wpa_s
->num_osu_scans
= 0;
1222 wpa_s
->num_prov_found
= 0;
1224 wpa_s
->network_select
= 0;
1225 wpa_s
->fetch_all_anqp
= 1;
1226 wpa_s
->fetch_osu_info
= 1;
1227 wpa_s
->fetch_osu_icon_in_progress
= 0;
1229 interworking_start_fetch_anqp(wpa_s
);
1231 hs20_start_osu_scan(wpa_s
);
1238 void hs20_start_osu_scan(struct wpa_supplicant
*wpa_s
)
1240 wpa_s
->fetch_osu_waiting_scan
= 1;
1241 wpa_s
->num_osu_scans
++;
1242 wpa_s
->scan_req
= MANUAL_SCAN_REQ
;
1243 wpa_s
->scan_res_handler
= hs20_osu_scan_res_handler
;
1244 wpa_supplicant_req_scan(wpa_s
, 0, 0);
1248 void hs20_cancel_fetch_osu(struct wpa_supplicant
*wpa_s
)
1250 wpa_printf(MSG_DEBUG
, "Cancel OSU fetch");
1251 interworking_stop_fetch_anqp(wpa_s
);
1252 wpa_s
->fetch_osu_waiting_scan
= 0;
1253 wpa_s
->network_select
= 0;
1254 wpa_s
->fetch_osu_info
= 0;
1255 wpa_s
->fetch_osu_icon_in_progress
= 0;
1259 void hs20_icon_fetch_failed(struct wpa_supplicant
*wpa_s
)
1261 hs20_osu_icon_fetch_result(wpa_s
, -1);
1262 eloop_cancel_timeout(hs20_continue_icon_fetch
, wpa_s
, NULL
);
1263 eloop_register_timeout(0, 0, hs20_continue_icon_fetch
, wpa_s
, NULL
);
1267 void hs20_rx_subscription_remediation(struct wpa_supplicant
*wpa_s
,
1268 const char *url
, u8 osu_method
)
1271 wpa_msg(wpa_s
, MSG_INFO
, HS20_SUBSCRIPTION_REMEDIATION
"%u %s",
1274 wpa_msg(wpa_s
, MSG_INFO
, HS20_SUBSCRIPTION_REMEDIATION
);
1278 void hs20_rx_deauth_imminent_notice(struct wpa_supplicant
*wpa_s
, u8 code
,
1279 u16 reauth_delay
, const char *url
)
1281 if (!wpa_sm_pmf_enabled(wpa_s
->wpa
)) {
1282 wpa_printf(MSG_DEBUG
, "HS 2.0: Ignore deauthentication imminent notice since PMF was not enabled");
1286 wpa_msg(wpa_s
, MSG_INFO
, HS20_DEAUTH_IMMINENT_NOTICE
"%u %u %s",
1287 code
, reauth_delay
, url
);
1289 if (code
== HS20_DEAUTH_REASON_CODE_BSS
) {
1290 wpa_printf(MSG_DEBUG
, "HS 2.0: Add BSS to blacklist");
1291 wpa_blacklist_add(wpa_s
, wpa_s
->bssid
);
1292 /* TODO: For now, disable full ESS since some drivers may not
1293 * support disabling per BSS. */
1294 if (wpa_s
->current_ssid
) {
1295 struct os_reltime now
;
1296 os_get_reltime(&now
);
1297 if (now
.sec
+ reauth_delay
<=
1298 wpa_s
->current_ssid
->disabled_until
.sec
)
1300 wpa_printf(MSG_DEBUG
, "HS 2.0: Disable network for %u seconds (BSS)",
1302 wpa_s
->current_ssid
->disabled_until
.sec
=
1303 now
.sec
+ reauth_delay
;
1307 if (code
== HS20_DEAUTH_REASON_CODE_ESS
&& wpa_s
->current_ssid
) {
1308 struct os_reltime now
;
1309 os_get_reltime(&now
);
1310 if (now
.sec
+ reauth_delay
<=
1311 wpa_s
->current_ssid
->disabled_until
.sec
)
1313 wpa_printf(MSG_DEBUG
, "HS 2.0: Disable network for %u seconds",
1315 wpa_s
->current_ssid
->disabled_until
.sec
=
1316 now
.sec
+ reauth_delay
;
1321 void hs20_rx_t_c_acceptance(struct wpa_supplicant
*wpa_s
, const char *url
)
1323 if (!wpa_sm_pmf_enabled(wpa_s
->wpa
)) {
1324 wpa_printf(MSG_DEBUG
,
1325 "HS 2.0: Ignore Terms and Conditions Acceptance since PMF was not enabled");
1329 wpa_msg(wpa_s
, MSG_INFO
, HS20_T_C_ACCEPTANCE
"%s", url
);
1333 void hs20_init(struct wpa_supplicant
*wpa_s
)
1335 dl_list_init(&wpa_s
->icon_head
);
1339 void hs20_deinit(struct wpa_supplicant
*wpa_s
)
1341 eloop_cancel_timeout(hs20_continue_icon_fetch
, wpa_s
, NULL
);
1342 hs20_free_osu_prov(wpa_s
);
1343 if (wpa_s
->icon_head
.next
)
1344 hs20_del_icon(wpa_s
, NULL
, NULL
);