HS 2.0R2: Add WNM-Notification Request for Subscription Remediation
[mech_eap.git] / wpa_supplicant / hs20_supplicant.c
1 /*
2  * Copyright (c) 2009, Atheros Communications, Inc.
3  * Copyright (c) 2011-2012, 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
11 #include "common.h"
12 #include "eloop.h"
13 #include "common/ieee802_11_common.h"
14 #include "common/ieee802_11_defs.h"
15 #include "common/gas.h"
16 #include "common/wpa_ctrl.h"
17 #include "wpa_supplicant_i.h"
18 #include "driver_i.h"
19 #include "config.h"
20 #include "bss.h"
21 #include "gas_query.h"
22 #include "interworking.h"
23 #include "hs20_supplicant.h"
24
25
26 void wpas_hs20_add_indication(struct wpabuf *buf, int pps_mo_id)
27 {
28         u8 conf;
29
30         wpabuf_put_u8(buf, WLAN_EID_VENDOR_SPECIFIC);
31         wpabuf_put_u8(buf, pps_mo_id >= 0 ? 7 : 5);
32         wpabuf_put_be24(buf, OUI_WFA);
33         wpabuf_put_u8(buf, HS20_INDICATION_OUI_TYPE);
34         conf = HS20_VERSION;
35         if (pps_mo_id >= 0)
36                 conf |= HS20_PPS_MO_ID_PRESENT;
37         wpabuf_put_u8(buf, conf);
38         if (pps_mo_id >= 0)
39                 wpabuf_put_le16(buf, pps_mo_id);
40 }
41
42
43 int is_hs20_network(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid,
44                     struct wpa_bss *bss)
45 {
46         if (!wpa_s->conf->hs20 || !ssid)
47                 return 0;
48
49         if (ssid->parent_cred)
50                 return 1;
51
52         if (bss && !wpa_bss_get_vendor_ie(bss, HS20_IE_VENDOR_TYPE))
53                 return 0;
54
55         /*
56          * This may catch some non-Hotspot 2.0 cases, but it is safer to do that
57          * than cause Hotspot 2.0 connections without indication element getting
58          * added. Non-Hotspot 2.0 APs should ignore the unknown vendor element.
59          */
60
61         if (!(ssid->key_mgmt & WPA_KEY_MGMT_IEEE8021X))
62                 return 0;
63         if (!(ssid->pairwise_cipher & WPA_CIPHER_CCMP))
64                 return 0;
65         if (ssid->proto != WPA_PROTO_RSN)
66                 return 0;
67
68         return 1;
69 }
70
71
72 int hs20_get_pps_mo_id(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid)
73 {
74         struct wpa_cred *cred;
75
76         if (ssid == NULL || ssid->parent_cred == NULL)
77                 return 0;
78
79         for (cred = wpa_s->conf->cred; cred; cred = cred->next) {
80                 if (ssid->parent_cred == cred)
81                         return cred->update_identifier;
82         }
83
84         return 0;
85 }
86
87
88 struct wpabuf * hs20_build_anqp_req(u32 stypes, const u8 *payload,
89                                     size_t payload_len)
90 {
91         struct wpabuf *buf;
92         u8 *len_pos;
93
94         buf = gas_anqp_build_initial_req(0, 100 + payload_len);
95         if (buf == NULL)
96                 return NULL;
97
98         len_pos = gas_anqp_add_element(buf, ANQP_VENDOR_SPECIFIC);
99         wpabuf_put_be24(buf, OUI_WFA);
100         wpabuf_put_u8(buf, HS20_ANQP_OUI_TYPE);
101         if (stypes == BIT(HS20_STYPE_NAI_HOME_REALM_QUERY)) {
102                 wpabuf_put_u8(buf, HS20_STYPE_NAI_HOME_REALM_QUERY);
103                 wpabuf_put_u8(buf, 0); /* Reserved */
104                 if (payload)
105                         wpabuf_put_data(buf, payload, payload_len);
106         } else {
107                 u8 i;
108                 wpabuf_put_u8(buf, HS20_STYPE_QUERY_LIST);
109                 wpabuf_put_u8(buf, 0); /* Reserved */
110                 for (i = 0; i < 32; i++) {
111                         if (stypes & BIT(i))
112                                 wpabuf_put_u8(buf, i);
113                 }
114         }
115         gas_anqp_set_element_len(buf, len_pos);
116
117         gas_anqp_set_len(buf);
118
119         return buf;
120 }
121
122
123 int hs20_anqp_send_req(struct wpa_supplicant *wpa_s, const u8 *dst, u32 stypes,
124                        const u8 *payload, size_t payload_len)
125 {
126         struct wpabuf *buf;
127         int ret = 0;
128         int freq;
129         struct wpa_bss *bss;
130         int res;
131
132         freq = wpa_s->assoc_freq;
133         bss = wpa_bss_get_bssid(wpa_s, dst);
134         if (bss) {
135                 wpa_bss_anqp_unshare_alloc(bss);
136                 freq = bss->freq;
137         }
138         if (freq <= 0)
139                 return -1;
140
141         wpa_printf(MSG_DEBUG, "HS20: ANQP Query Request to " MACSTR " for "
142                    "subtypes 0x%x", MAC2STR(dst), stypes);
143
144         buf = hs20_build_anqp_req(stypes, payload, payload_len);
145         if (buf == NULL)
146                 return -1;
147
148         res = gas_query_req(wpa_s->gas, dst, freq, buf, anqp_resp_cb, wpa_s);
149         if (res < 0) {
150                 wpa_printf(MSG_DEBUG, "ANQP: Failed to send Query Request");
151                 wpabuf_free(buf);
152                 ret = -1;
153         } else
154                 wpa_printf(MSG_DEBUG, "ANQP: Query started with dialog token "
155                            "%u", res);
156
157         return ret;
158 }
159
160
161 void hs20_parse_rx_hs20_anqp_resp(struct wpa_supplicant *wpa_s,
162                                   const u8 *sa, const u8 *data, size_t slen)
163 {
164         const u8 *pos = data;
165         u8 subtype;
166         struct wpa_bss *bss = wpa_bss_get_bssid(wpa_s, sa);
167         struct wpa_bss_anqp *anqp = NULL;
168
169         if (slen < 2)
170                 return;
171
172         if (bss)
173                 anqp = bss->anqp;
174
175         subtype = *pos++;
176         slen--;
177
178         pos++; /* Reserved */
179         slen--;
180
181         switch (subtype) {
182         case HS20_STYPE_CAPABILITY_LIST:
183                 wpa_msg(wpa_s, MSG_INFO, "RX-HS20-ANQP " MACSTR
184                         " HS Capability List", MAC2STR(sa));
185                 wpa_hexdump_ascii(MSG_DEBUG, "HS Capability List", pos, slen);
186                 break;
187         case HS20_STYPE_OPERATOR_FRIENDLY_NAME:
188                 wpa_msg(wpa_s, MSG_INFO, "RX-HS20-ANQP " MACSTR
189                         " Operator Friendly Name", MAC2STR(sa));
190                 wpa_hexdump_ascii(MSG_DEBUG, "oper friendly name", pos, slen);
191                 if (anqp) {
192                         wpabuf_free(anqp->hs20_operator_friendly_name);
193                         anqp->hs20_operator_friendly_name =
194                                 wpabuf_alloc_copy(pos, slen);
195                 }
196                 break;
197         case HS20_STYPE_WAN_METRICS:
198                 wpa_hexdump(MSG_DEBUG, "WAN Metrics", pos, slen);
199                 if (slen < 13) {
200                         wpa_dbg(wpa_s, MSG_DEBUG, "HS 2.0: Too short WAN "
201                                 "Metrics value from " MACSTR, MAC2STR(sa));
202                         break;
203                 }
204                 wpa_msg(wpa_s, MSG_INFO, "RX-HS20-ANQP " MACSTR
205                         " WAN Metrics %02x:%u:%u:%u:%u:%u", MAC2STR(sa),
206                         pos[0], WPA_GET_LE32(pos + 1), WPA_GET_LE32(pos + 5),
207                         pos[9], pos[10], WPA_GET_LE16(pos + 11));
208                 if (anqp) {
209                         wpabuf_free(anqp->hs20_wan_metrics);
210                         anqp->hs20_wan_metrics = wpabuf_alloc_copy(pos, slen);
211                 }
212                 break;
213         case HS20_STYPE_CONNECTION_CAPABILITY:
214                 wpa_msg(wpa_s, MSG_INFO, "RX-HS20-ANQP " MACSTR
215                         " Connection Capability", MAC2STR(sa));
216                 wpa_hexdump_ascii(MSG_DEBUG, "conn capability", pos, slen);
217                 if (anqp) {
218                         wpabuf_free(anqp->hs20_connection_capability);
219                         anqp->hs20_connection_capability =
220                                 wpabuf_alloc_copy(pos, slen);
221                 }
222                 break;
223         case HS20_STYPE_OPERATING_CLASS:
224                 wpa_msg(wpa_s, MSG_INFO, "RX-HS20-ANQP " MACSTR
225                         " Operating Class", MAC2STR(sa));
226                 wpa_hexdump_ascii(MSG_DEBUG, "Operating Class", pos, slen);
227                 if (anqp) {
228                         wpabuf_free(anqp->hs20_operating_class);
229                         anqp->hs20_operating_class =
230                                 wpabuf_alloc_copy(pos, slen);
231                 }
232                 break;
233         default:
234                 wpa_printf(MSG_DEBUG, "HS20: Unsupported subtype %u", subtype);
235                 break;
236         }
237 }
238
239
240 void hs20_rx_subscription_remediation(struct wpa_supplicant *wpa_s,
241                                       const char *url, u8 osu_method)
242 {
243         if (url)
244                 wpa_msg(wpa_s, MSG_INFO, HS20_SUBSCRIPTION_REMEDIATION "%u %s",
245                         osu_method, url);
246         else
247                 wpa_msg(wpa_s, MSG_INFO, HS20_SUBSCRIPTION_REMEDIATION);
248 }