1 /*
2 * IEEE 802.11 Common routines
3 * Copyright (c) 2002-2019, Jouni Malinen <j@w1.fi>
4 *
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
7 */
8
9 #ifndef IEEE802_11_COMMON_H
10 #define IEEE802_11_COMMON_H
11
12 #include "defs.h"
13 #include "ieee802_11_defs.h"
14
15 struct element {
16 u8 id;
17 u8 datalen;
18 u8 data[];
19 } STRUCT_PACKED;
20
21 struct hostapd_hw_modes;
22
23 #define MAX_NOF_MB_IES_SUPPORTED 5
24
25 struct mb_ies_info {
26 struct {
27 const u8 *ie;
28 u8 ie_len;
29 } ies[MAX_NOF_MB_IES_SUPPORTED];
30 u8 nof_ies;
31 };
32
33 /* Parsed Information Elements */
34 struct ieee802_11_elems {
35 const u8 *ssid;
36 const u8 *supp_rates;
37 const u8 *ds_params;
38 const u8 *challenge;
39 const u8 *erp_info;
40 const u8 *ext_supp_rates;
41 const u8 *wpa_ie;
42 const u8 *rsn_ie;
43 const u8 *rsnxe;
44 const u8 *wmm; /* WMM Information or Parameter Element */
45 const u8 *wmm_tspec;
46 const u8 *wps_ie;
47 const u8 *supp_channels;
48 const u8 *mdie;
49 const u8 *ftie;
50 const u8 *timeout_int;
51 const u8 *ht_capabilities;
52 const u8 *ht_operation;
53 const u8 *mesh_config;
54 const u8 *mesh_id;
55 const u8 *peer_mgmt;
56 const u8 *vht_capabilities;
57 const u8 *vht_operation;
58 const u8 *opmode_notif;
59 const u8 *vendor_ht_cap;
60 const u8 *vendor_vht;
61 const u8 *p2p;
62 const u8 *wfd;
63 const u8 *link_id;
64 const u8 *interworking;
65 const u8 *qos_map_set;
66 const u8 *hs20;
67 const u8 *ext_capab;
68 const u8 *bss_max_idle_period;
69 const u8 *ssid_list;
70 const u8 *osen;
71 const u8 *mbo;
72 const u8 *ampe;
73 const u8 *mic;
74 const u8 *pref_freq_list;
75 const u8 *supp_op_classes;
76 const u8 *rrm_enabled;
77 const u8 *cag_number;
78 const u8 *ap_csn;
79 const u8 *fils_indic;
80 const u8 *dils;
81 const u8 *assoc_delay_info;
82 const u8 *fils_req_params;
83 const u8 *fils_key_confirm;
84 const u8 *fils_session;
85 const u8 *fils_hlp;
86 const u8 *fils_ip_addr_assign;
87 const u8 *key_delivery;
88 const u8 *wrapped_data;
89 const u8 *fils_pk;
90 const u8 *fils_nonce;
91 const u8 *owe_dh;
92 const u8 *power_capab;
93 const u8 *roaming_cons_sel;
94 const u8 *password_id;
95 const u8 *oci;
96 const u8 *multi_ap;
97 const u8 *he_capabilities;
98 const u8 *he_operation;
99 const u8 *short_ssid_list;
100 const u8 *he_6ghz_band_cap;
101 const u8 *sae_pk;
102 const u8 *s1g_capab;
103 const u8 *pasn_params;
104 const u8 *eht_capabilities;
105 const u8 *eht_operation;
106 const u8 *basic_mle;
107 const u8 *probe_req_mle;
108 const u8 *reconf_mle;
109 const u8 *tdls_mle;
110 const u8 *prior_access_mle;
111 const u8 *mbssid_known_bss;
112
113 u8 ssid_len;
114 u8 supp_rates_len;
115 u8 challenge_len;
116 u8 ext_supp_rates_len;
117 u8 wpa_ie_len;
118 u8 rsn_ie_len;
119 u8 rsnxe_len;
120 u8 wmm_len; /* 7 = WMM Information; 24 = WMM Parameter */
121 u8 wmm_tspec_len;
122 u8 wps_ie_len;
123 u8 supp_channels_len;
124 u8 mdie_len;
125 u8 ftie_len;
126 u8 mesh_config_len;
127 u8 mesh_id_len;
128 u8 peer_mgmt_len;
129 u8 vendor_ht_cap_len;
130 u8 vendor_vht_len;
131 u8 p2p_len;
132 u8 wfd_len;
133 u8 interworking_len;
134 u8 qos_map_set_len;
135 u8 hs20_len;
136 u8 ext_capab_len;
137 u8 ssid_list_len;
138 u8 osen_len;
139 u8 mbo_len;
140 u8 ampe_len;
141 u8 mic_len;
142 u8 pref_freq_list_len;
143 u8 supp_op_classes_len;
144 u8 rrm_enabled_len;
145 u8 cag_number_len;
146 u8 fils_indic_len;
147 u8 dils_len;
148 u8 fils_req_params_len;
149 u8 fils_key_confirm_len;
150 size_t fils_hlp_len;
151 u8 fils_ip_addr_assign_len;
152 u8 key_delivery_len;
153 size_t wrapped_data_len;
154 u8 fils_pk_len;
155 u8 owe_dh_len;
156 u8 power_capab_len;
157 u8 roaming_cons_sel_len;
158 u8 password_id_len;
159 u8 oci_len;
160 u8 multi_ap_len;
161 u8 he_capabilities_len;
162 u8 he_operation_len;
163 u8 short_ssid_list_len;
164 u8 sae_pk_len;
165 u8 pasn_params_len;
166 u8 eht_capabilities_len;
167 u8 eht_operation_len;
168 size_t basic_mle_len;
169 size_t probe_req_mle_len;
170 size_t reconf_mle_len;
171 size_t tdls_mle_len;
172 size_t prior_access_mle_len;
173 u8 mbssid_known_bss_len;
174
175 struct mb_ies_info mb_ies;
176
177 size_t fte_defrag_len;
178
179 /*
180 * The number of fragment elements to be skipped after a known
181 * fragmented element.
182 */
183 unsigned int num_frag_elems;
184 };
185
186 typedef enum { ParseOK = 0, ParseUnknown = 1, ParseFailed = -1 } ParseRes;
187
188 ParseRes ieee802_11_parse_elems(const u8 *start, size_t len,
189 struct ieee802_11_elems *elems,
190 int show_errors);
191 void ieee802_11_elems_clear_ids(struct ieee802_11_elems *elems,
192 const u8 *ids, size_t num);
193 void ieee802_11_elems_clear_ext_ids(struct ieee802_11_elems *elems,
194 const u8 *ids, size_t num);
195 ParseRes ieee802_11_parse_link_assoc_req(const u8 *start, size_t len,
196 struct ieee802_11_elems *elems,
197 struct wpabuf *mlbuf,
198 u8 link_id, bool show_errors);
199 int ieee802_11_ie_count(const u8 *ies, size_t ies_len);
200 struct wpabuf * ieee802_11_vendor_ie_concat(const u8 *ies, size_t ies_len,
201 u32 oui_type);
202 struct ieee80211_hdr;
203 const u8 * get_hdr_bssid(const struct ieee80211_hdr *hdr, size_t len);
204
205 struct hostapd_wmm_ac_params {
206 int cwmin;
207 int cwmax;
208 int aifs;
209 int txop_limit; /* in units of 32us */
210 int admission_control_mandatory;
211 };
212
213 int hostapd_config_wmm_ac(struct hostapd_wmm_ac_params wmm_ac_params[],
214 const char *name, const char *val);
215
216 struct hostapd_tx_queue_params {
217 int aifs;
218 int cwmin;
219 int cwmax;
220 int burst; /* maximum burst time in 0.1 ms, i.e., 10 = 1 ms */
221 };
222
223 #define NUM_TX_QUEUES 4
224
225 int hostapd_config_tx_queue(struct hostapd_tx_queue_params queue[],
226 const char *name, const char *val);
227 enum hostapd_hw_mode ieee80211_freq_to_chan(int freq, u8 *channel);
228 int ieee80211_chan_to_freq(const char *country, u8 op_class, u8 chan);
229 enum hostapd_hw_mode
230 ieee80211_freq_to_channel_ext(unsigned int freq, int sec_channel,
231 enum oper_chan_width chanwidth,
232 u8 *op_class, u8 *channel);
233 int ieee80211_chaninfo_to_channel(unsigned int freq, enum chan_width chanwidth,
234 int sec_channel, u8 *op_class, u8 *channel);
235 int ieee80211_is_dfs(int freq, const struct hostapd_hw_modes *modes,
236 u16 num_modes);
237 int is_dfs_global_op_class(u8 op_class);
238 enum phy_type ieee80211_get_phy_type(int freq, int ht, int vht);
239
240 int supp_rates_11b_only(struct ieee802_11_elems *elems);
241 int mb_ies_info_by_ies(struct mb_ies_info *info, const u8 *ies_buf,
242 size_t ies_len);
243 struct wpabuf * mb_ies_by_info(struct mb_ies_info *info);
244
245 const char * fc2str(u16 fc);
246 const char * reason2str(u16 reason);
247 const char * status2str(u16 status);
248
249 struct oper_class_map {
250 enum hostapd_hw_mode mode;
251 u8 op_class;
252 u8 min_chan;
253 u8 max_chan;
254 u8 inc;
255 enum { BW20, BW40PLUS, BW40MINUS, BW40, BW80, BW2160, BW160, BW80P80,
256 BW4320, BW6480, BW8640} bw;
257 enum { P2P_SUPP, NO_P2P_SUPP } p2p;
258 };
259
260 extern const struct oper_class_map global_op_class[];
261 extern size_t global_op_class_size;
262
263 const u8 * get_ie(const u8 *ies, size_t len, u8 eid);
264 const u8 * get_ie_nth(const u8 *ies, size_t len, u8 eid, int nth);
265 const u8 * get_ie_ext(const u8 *ies, size_t len, u8 ext);
266 const u8 * get_vendor_ie(const u8 *ies, size_t len, u32 vendor_type);
267
268 size_t mbo_add_ie(u8 *buf, size_t len, const u8 *attr, size_t attr_len);
269
270 size_t add_multi_ap_ie(u8 *buf, size_t len, u8 value);
271
272 struct country_op_class {
273 u8 country_op_class;
274 u8 global_op_class;
275 };
276
277 u8 country_to_global_op_class(const char *country, u8 op_class);
278
279 const struct oper_class_map * get_oper_class(const char *country, u8 op_class);
280 int oper_class_bw_to_int(const struct oper_class_map *map);
281 int center_idx_to_bw_6ghz(u8 idx);
282 bool is_6ghz_freq(int freq);
283 bool is_6ghz_op_class(u8 op_class);
284 bool is_6ghz_psc_frequency(int freq);
285 int get_6ghz_sec_channel(int channel);
286
287 int ieee802_11_parse_candidate_list(const char *pos, u8 *nei_rep,
288 size_t nei_rep_len);
289
290 int ieee802_11_ext_capab(const u8 *ie, unsigned int capab);
291 bool ieee802_11_rsnx_capab_len(const u8 *rsnxe, size_t rsnxe_len,
292 unsigned int capab);
293 bool ieee802_11_rsnx_capab(const u8 *rsnxe, unsigned int capab);
294 int op_class_to_bandwidth(u8 op_class);
295 enum oper_chan_width op_class_to_ch_width(u8 op_class);
296
297 /* element iteration helpers */
298 #define for_each_element(_elem, _data, _datalen) \
299 for (_elem = (const struct element *) (_data); \
300 (const u8 *) (_data) + (_datalen) - (const u8 *) _elem >= \
301 (int) sizeof(*_elem) && \
302 (const u8 *) (_data) + (_datalen) - (const u8 *) _elem >= \
303 (int) sizeof(*_elem) + _elem->datalen; \
304 _elem = (const struct element *) (_elem->data + _elem->datalen))
305
306 #define for_each_element_id(element, _id, data, datalen) \
307 for_each_element(element, data, datalen) \
308 if (element->id == (_id))
309
310 #define for_each_element_extid(element, extid, _data, _datalen) \
311 for_each_element(element, _data, _datalen) \
312 if (element->id == WLAN_EID_EXTENSION && \
313 element->datalen > 0 && \
314 element->data[0] == (extid))
315
316 #define for_each_subelement(sub, element) \
317 for_each_element(sub, (element)->data, (element)->datalen)
318
319 #define for_each_subelement_id(sub, id, element) \
320 for_each_element_id(sub, id, (element)->data, (element)->datalen)
321
322 #define for_each_subelement_extid(sub, extid, element) \
323 for_each_element_extid(sub, extid, (element)->data, (element)->datalen)
324
325 /**
326 * for_each_element_completed - Determine if element parsing consumed all data
327 * @element: Element pointer after for_each_element() or friends
328 * @data: Same data pointer as passed to for_each_element() or friends
329 * @datalen: Same data length as passed to for_each_element() or friends
330 *
331 * This function returns 1 if all the data was parsed or considered
332 * while walking the elements. Only use this if your for_each_element()
333 * loop cannot be broken out of, otherwise it always returns 0.
334 *
335 * If some data was malformed, this returns %false since the last parsed
336 * element will not fill the whole remaining data.
337 */
for_each_element_completed(const struct element * element,const void * data,size_t datalen)338 static inline int for_each_element_completed(const struct element *element,
339 const void *data, size_t datalen)
340 {
341 return (const u8 *) element == (const u8 *) data + datalen;
342 }
343
344 struct ieee80211_edmg_config;
345
346 void hostapd_encode_edmg_chan(int edmg_enable, u8 edmg_channel,
347 int primary_channel,
348 struct ieee80211_edmg_config *edmg);
349
350 int ieee802_edmg_is_allowed(struct ieee80211_edmg_config allowed,
351 struct ieee80211_edmg_config requested);
352
353 struct wpabuf * ieee802_11_defrag_data(const u8 *data, size_t len,
354 bool ext_elem);
355 struct wpabuf * ieee802_11_defrag(struct ieee802_11_elems *elems,
356 u8 eid, u8 eid_ext);
357 struct wpabuf * ieee802_11_defrag_mle(struct ieee802_11_elems *elems, u8 type);
358 const u8 * get_ml_ie(const u8 *ies, size_t len, u8 type);
359 const u8 * get_basic_mle_mld_addr(const u8 *buf, size_t len);
360
361 int get_max_nss_capability(struct ieee802_11_elems *elems, int parse_for_rx);
362
363 struct supported_chan_width {
364 u8 is_160_supported;
365 u8 is_80p80_supported;
366 u8 is_320_supported;
367 };
368
369 struct supported_chan_width get_supported_channel_width(struct ieee802_11_elems *elems);
370
371 enum chan_width get_operation_channel_width(struct ieee802_11_elems *elems);
372
373 enum chan_width get_sta_operation_chan_width(enum chan_width ap_operation_chan_width,
374 struct supported_chan_width sta_supported_width);
375
376 unsigned int is_ap_t2lm_negotiation_supported(const u8 *mle, size_t mle_len);
377 #endif /* IEEE802_11_COMMON_H */
378