xref: /freebsd/contrib/wpa/wpa_supplicant/wpa_supplicant_i.h (revision 1f4bcc459a76b7aa664f3fd557684cd0ba6da352)
1 /*
2  * wpa_supplicant - Internal definitions
3  * Copyright (c) 2003-2014, 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 WPA_SUPPLICANT_I_H
10 #define WPA_SUPPLICANT_I_H
11 
12 #include "utils/list.h"
13 #include "common/defs.h"
14 #include "common/sae.h"
15 #include "common/wpa_ctrl.h"
16 #include "wps/wps_defs.h"
17 #include "config_ssid.h"
18 #include "wmm_ac.h"
19 
20 extern const char *const wpa_supplicant_version;
21 extern const char *const wpa_supplicant_license;
22 #ifndef CONFIG_NO_STDOUT_DEBUG
23 extern const char *const wpa_supplicant_full_license1;
24 extern const char *const wpa_supplicant_full_license2;
25 extern const char *const wpa_supplicant_full_license3;
26 extern const char *const wpa_supplicant_full_license4;
27 extern const char *const wpa_supplicant_full_license5;
28 #endif /* CONFIG_NO_STDOUT_DEBUG */
29 
30 struct wpa_sm;
31 struct wpa_supplicant;
32 struct ibss_rsn;
33 struct scan_info;
34 struct wpa_bss;
35 struct wpa_scan_results;
36 struct hostapd_hw_modes;
37 struct wpa_driver_associate_params;
38 
39 /*
40  * Forward declarations of private structures used within the ctrl_iface
41  * backends. Other parts of wpa_supplicant do not have access to data stored in
42  * these structures.
43  */
44 struct ctrl_iface_priv;
45 struct ctrl_iface_global_priv;
46 struct wpas_dbus_priv;
47 
48 /**
49  * struct wpa_interface - Parameters for wpa_supplicant_add_iface()
50  */
51 struct wpa_interface {
52 	/**
53 	 * confname - Configuration name (file or profile) name
54 	 *
55 	 * This can also be %NULL when a configuration file is not used. In
56 	 * that case, ctrl_interface must be set to allow the interface to be
57 	 * configured.
58 	 */
59 	const char *confname;
60 
61 	/**
62 	 * confanother - Additional configuration name (file or profile) name
63 	 *
64 	 * This can also be %NULL when the additional configuration file is not
65 	 * used.
66 	 */
67 	const char *confanother;
68 
69 	/**
70 	 * ctrl_interface - Control interface parameter
71 	 *
72 	 * If a configuration file is not used, this variable can be used to
73 	 * set the ctrl_interface parameter that would have otherwise been read
74 	 * from the configuration file. If both confname and ctrl_interface are
75 	 * set, ctrl_interface is used to override the value from configuration
76 	 * file.
77 	 */
78 	const char *ctrl_interface;
79 
80 	/**
81 	 * driver - Driver interface name, or %NULL to use the default driver
82 	 */
83 	const char *driver;
84 
85 	/**
86 	 * driver_param - Driver interface parameters
87 	 *
88 	 * If a configuration file is not used, this variable can be used to
89 	 * set the driver_param parameters that would have otherwise been read
90 	 * from the configuration file. If both confname and driver_param are
91 	 * set, driver_param is used to override the value from configuration
92 	 * file.
93 	 */
94 	const char *driver_param;
95 
96 	/**
97 	 * ifname - Interface name
98 	 */
99 	const char *ifname;
100 
101 	/**
102 	 * bridge_ifname - Optional bridge interface name
103 	 *
104 	 * If the driver interface (ifname) is included in a Linux bridge
105 	 * device, the bridge interface may need to be used for receiving EAPOL
106 	 * frames. This can be enabled by setting this variable to enable
107 	 * receiving of EAPOL frames from an additional interface.
108 	 */
109 	const char *bridge_ifname;
110 
111 	/**
112 	 * p2p_mgmt - Interface used for P2P management (P2P Device operations)
113 	 *
114 	 * Indicates whether wpas_p2p_init() must be called for this interface.
115 	 * This is used only when the driver supports a dedicated P2P Device
116 	 * interface that is not a network interface.
117 	 */
118 	int p2p_mgmt;
119 };
120 
121 /**
122  * struct wpa_params - Parameters for wpa_supplicant_init()
123  */
124 struct wpa_params {
125 	/**
126 	 * daemonize - Run %wpa_supplicant in the background
127 	 */
128 	int daemonize;
129 
130 	/**
131 	 * wait_for_monitor - Wait for a monitor program before starting
132 	 */
133 	int wait_for_monitor;
134 
135 	/**
136 	 * pid_file - Path to a PID (process ID) file
137 	 *
138 	 * If this and daemonize are set, process ID of the background process
139 	 * will be written to the specified file.
140 	 */
141 	char *pid_file;
142 
143 	/**
144 	 * wpa_debug_level - Debugging verbosity level (e.g., MSG_INFO)
145 	 */
146 	int wpa_debug_level;
147 
148 	/**
149 	 * wpa_debug_show_keys - Whether keying material is included in debug
150 	 *
151 	 * This parameter can be used to allow keying material to be included
152 	 * in debug messages. This is a security risk and this option should
153 	 * not be enabled in normal configuration. If needed during
154 	 * development or while troubleshooting, this option can provide more
155 	 * details for figuring out what is happening.
156 	 */
157 	int wpa_debug_show_keys;
158 
159 	/**
160 	 * wpa_debug_timestamp - Whether to include timestamp in debug messages
161 	 */
162 	int wpa_debug_timestamp;
163 
164 	/**
165 	 * ctrl_interface - Global ctrl_iface path/parameter
166 	 */
167 	char *ctrl_interface;
168 
169 	/**
170 	 * ctrl_interface_group - Global ctrl_iface group
171 	 */
172 	char *ctrl_interface_group;
173 
174 	/**
175 	 * dbus_ctrl_interface - Enable the DBus control interface
176 	 */
177 	int dbus_ctrl_interface;
178 
179 	/**
180 	 * wpa_debug_file_path - Path of debug file or %NULL to use stdout
181 	 */
182 	const char *wpa_debug_file_path;
183 
184 	/**
185 	 * wpa_debug_syslog - Enable log output through syslog
186 	 */
187 	int wpa_debug_syslog;
188 
189 	/**
190 	 * wpa_debug_tracing - Enable log output through Linux tracing
191 	 */
192 	int wpa_debug_tracing;
193 
194 	/**
195 	 * override_driver - Optional driver parameter override
196 	 *
197 	 * This parameter can be used to override the driver parameter in
198 	 * dynamic interface addition to force a specific driver wrapper to be
199 	 * used instead.
200 	 */
201 	char *override_driver;
202 
203 	/**
204 	 * override_ctrl_interface - Optional ctrl_interface override
205 	 *
206 	 * This parameter can be used to override the ctrl_interface parameter
207 	 * in dynamic interface addition to force a control interface to be
208 	 * created.
209 	 */
210 	char *override_ctrl_interface;
211 
212 	/**
213 	 * entropy_file - Optional entropy file
214 	 *
215 	 * This parameter can be used to configure wpa_supplicant to maintain
216 	 * its internal entropy store over restarts.
217 	 */
218 	char *entropy_file;
219 
220 #ifdef CONFIG_P2P
221 	/**
222 	 * conf_p2p_dev - Configuration file used to hold the
223 	 * P2P Device configuration parameters.
224 	 *
225 	 * This can also be %NULL. In such a case, if a P2P Device dedicated
226 	 * interfaces is created, the main configuration file will be used.
227 	 */
228 	char *conf_p2p_dev;
229 #endif /* CONFIG_P2P */
230 
231 };
232 
233 struct p2p_srv_bonjour {
234 	struct dl_list list;
235 	struct wpabuf *query;
236 	struct wpabuf *resp;
237 };
238 
239 struct p2p_srv_upnp {
240 	struct dl_list list;
241 	u8 version;
242 	char *service;
243 };
244 
245 /**
246  * struct wpa_global - Internal, global data for all %wpa_supplicant interfaces
247  *
248  * This structure is initialized by calling wpa_supplicant_init() when starting
249  * %wpa_supplicant.
250  */
251 struct wpa_global {
252 	struct wpa_supplicant *ifaces;
253 	struct wpa_params params;
254 	struct ctrl_iface_global_priv *ctrl_iface;
255 	struct wpas_dbus_priv *dbus;
256 	void **drv_priv;
257 	size_t drv_count;
258 	struct os_time suspend_time;
259 	struct p2p_data *p2p;
260 	struct wpa_supplicant *p2p_init_wpa_s;
261 	struct wpa_supplicant *p2p_group_formation;
262 	struct wpa_supplicant *p2p_invite_group;
263 	u8 p2p_dev_addr[ETH_ALEN];
264 	struct os_reltime p2p_go_wait_client;
265 	struct dl_list p2p_srv_bonjour; /* struct p2p_srv_bonjour */
266 	struct dl_list p2p_srv_upnp; /* struct p2p_srv_upnp */
267 	int p2p_disabled;
268 	int cross_connection;
269 	struct wpa_freq_range_list p2p_disallow_freq;
270 	struct wpa_freq_range_list p2p_go_avoid_freq;
271 	enum wpa_conc_pref {
272 		WPA_CONC_PREF_NOT_SET,
273 		WPA_CONC_PREF_STA,
274 		WPA_CONC_PREF_P2P
275 	} conc_pref;
276 	unsigned int p2p_per_sta_psk:1;
277 	unsigned int p2p_fail_on_wps_complete:1;
278 	unsigned int p2p_24ghz_social_channels:1;
279 	unsigned int pending_p2ps_group:1;
280 	unsigned int pending_group_iface_for_p2ps:1;
281 
282 #ifdef CONFIG_WIFI_DISPLAY
283 	int wifi_display;
284 #define MAX_WFD_SUBELEMS 10
285 	struct wpabuf *wfd_subelem[MAX_WFD_SUBELEMS];
286 #endif /* CONFIG_WIFI_DISPLAY */
287 
288 	struct psk_list_entry *add_psk; /* From group formation */
289 };
290 
291 
292 /**
293  * struct wpa_radio - Internal data for per-radio information
294  *
295  * This structure is used to share data about configured interfaces
296  * (struct wpa_supplicant) that share the same physical radio, e.g., to allow
297  * better coordination of offchannel operations.
298  */
299 struct wpa_radio {
300 	char name[16]; /* from driver_ops get_radio_name() or empty if not
301 			* available */
302 	unsigned int external_scan_running:1;
303 	struct dl_list ifaces; /* struct wpa_supplicant::radio_list entries */
304 	struct dl_list work; /* struct wpa_radio_work::list entries */
305 };
306 
307 /**
308  * struct wpa_radio_work - Radio work item
309  */
310 struct wpa_radio_work {
311 	struct dl_list list;
312 	unsigned int freq; /* known frequency (MHz) or 0 for multiple/unknown */
313 	const char *type;
314 	struct wpa_supplicant *wpa_s;
315 	void (*cb)(struct wpa_radio_work *work, int deinit);
316 	void *ctx;
317 	unsigned int started:1;
318 	struct os_reltime time;
319 };
320 
321 int radio_add_work(struct wpa_supplicant *wpa_s, unsigned int freq,
322 		   const char *type, int next,
323 		   void (*cb)(struct wpa_radio_work *work, int deinit),
324 		   void *ctx);
325 void radio_work_done(struct wpa_radio_work *work);
326 void radio_remove_works(struct wpa_supplicant *wpa_s,
327 			const char *type, int remove_all);
328 void radio_work_check_next(struct wpa_supplicant *wpa_s);
329 struct wpa_radio_work *
330 radio_work_pending(struct wpa_supplicant *wpa_s, const char *type);
331 
332 struct wpa_connect_work {
333 	unsigned int sme:1;
334 	unsigned int bss_removed:1;
335 	struct wpa_bss *bss;
336 	struct wpa_ssid *ssid;
337 };
338 
339 int wpas_valid_bss_ssid(struct wpa_supplicant *wpa_s, struct wpa_bss *test_bss,
340 			struct wpa_ssid *test_ssid);
341 void wpas_connect_work_free(struct wpa_connect_work *cwork);
342 void wpas_connect_work_done(struct wpa_supplicant *wpa_s);
343 
344 struct wpa_external_work {
345 	unsigned int id;
346 	char type[100];
347 	unsigned int timeout;
348 };
349 
350 /**
351  * offchannel_send_action_result - Result of offchannel send Action frame
352  */
353 enum offchannel_send_action_result {
354 	OFFCHANNEL_SEND_ACTION_SUCCESS /**< Frame was send and acknowledged */,
355 	OFFCHANNEL_SEND_ACTION_NO_ACK /**< Frame was sent, but not acknowledged
356 				       */,
357 	OFFCHANNEL_SEND_ACTION_FAILED /**< Frame was not sent due to a failure
358 				       */
359 };
360 
361 struct wps_ap_info {
362 	u8 bssid[ETH_ALEN];
363 	enum wps_ap_info_type {
364 		WPS_AP_NOT_SEL_REG,
365 		WPS_AP_SEL_REG,
366 		WPS_AP_SEL_REG_OUR
367 	} type;
368 	unsigned int tries;
369 	struct os_reltime last_attempt;
370 	unsigned int pbc_active;
371 	u8 uuid[WPS_UUID_LEN];
372 };
373 
374 struct wpa_ssid_value {
375 	u8 ssid[SSID_MAX_LEN];
376 	size_t ssid_len;
377 };
378 
379 #define WPA_FREQ_USED_BY_INFRA_STATION BIT(0)
380 #define WPA_FREQ_USED_BY_P2P_CLIENT BIT(1)
381 
382 struct wpa_used_freq_data {
383 	int freq;
384 	unsigned int flags;
385 };
386 
387 #define RRM_NEIGHBOR_REPORT_TIMEOUT 1 /* 1 second for AP to send a report */
388 
389 /*
390  * struct rrm_data - Data used for managing RRM features
391  */
392 struct rrm_data {
393 	/* rrm_used - indication regarding the current connection */
394 	unsigned int rrm_used:1;
395 
396 	/*
397 	 * notify_neighbor_rep - Callback for notifying report requester
398 	 */
399 	void (*notify_neighbor_rep)(void *ctx, struct wpabuf *neighbor_rep);
400 
401 	/*
402 	 * neighbor_rep_cb_ctx - Callback context
403 	 * Received in the callback registration, and sent to the callback
404 	 * function as a parameter.
405 	 */
406 	void *neighbor_rep_cb_ctx;
407 
408 	/* next_neighbor_rep_token - Next request's dialog token */
409 	u8 next_neighbor_rep_token;
410 };
411 
412 enum wpa_supplicant_test_failure {
413 	WPAS_TEST_FAILURE_NONE,
414 	WPAS_TEST_FAILURE_SCAN_TRIGGER,
415 };
416 
417 /**
418  * struct wpa_supplicant - Internal data for wpa_supplicant interface
419  *
420  * This structure contains the internal data for core wpa_supplicant code. This
421  * should be only used directly from the core code. However, a pointer to this
422  * data is used from other files as an arbitrary context pointer in calls to
423  * core functions.
424  */
425 struct wpa_supplicant {
426 	struct wpa_global *global;
427 	struct wpa_radio *radio; /* shared radio context */
428 	struct dl_list radio_list; /* list head: struct wpa_radio::ifaces */
429 	struct wpa_supplicant *parent;
430 	struct wpa_supplicant *next;
431 	struct l2_packet_data *l2;
432 	struct l2_packet_data *l2_br;
433 	unsigned char own_addr[ETH_ALEN];
434 	unsigned char perm_addr[ETH_ALEN];
435 	char ifname[100];
436 #ifdef CONFIG_CTRL_IFACE_DBUS
437 	char *dbus_path;
438 #endif /* CONFIG_CTRL_IFACE_DBUS */
439 #ifdef CONFIG_CTRL_IFACE_DBUS_NEW
440 	char *dbus_new_path;
441 	char *dbus_groupobj_path;
442 #ifdef CONFIG_AP
443 	char *preq_notify_peer;
444 #endif /* CONFIG_AP */
445 #endif /* CONFIG_CTRL_IFACE_DBUS_NEW */
446 	char bridge_ifname[16];
447 
448 	char *confname;
449 	char *confanother;
450 
451 	struct wpa_config *conf;
452 	int countermeasures;
453 	struct os_reltime last_michael_mic_error;
454 	u8 bssid[ETH_ALEN];
455 	u8 pending_bssid[ETH_ALEN]; /* If wpa_state == WPA_ASSOCIATING, this
456 				     * field contains the target BSSID. */
457 	int reassociate; /* reassociation requested */
458 	int reassoc_same_bss; /* reassociating to the same bss */
459 	int disconnected; /* all connections disabled; i.e., do no reassociate
460 			   * before this has been cleared */
461 	struct wpa_ssid *current_ssid;
462 	struct wpa_ssid *last_ssid;
463 	struct wpa_bss *current_bss;
464 	int ap_ies_from_associnfo;
465 	unsigned int assoc_freq;
466 
467 	/* Selected configuration (based on Beacon/ProbeResp WPA IE) */
468 	int pairwise_cipher;
469 	int group_cipher;
470 	int key_mgmt;
471 	int wpa_proto;
472 	int mgmt_group_cipher;
473 
474 	void *drv_priv; /* private data used by driver_ops */
475 	void *global_drv_priv;
476 
477 	u8 *bssid_filter;
478 	size_t bssid_filter_count;
479 
480 	u8 *disallow_aps_bssid;
481 	size_t disallow_aps_bssid_count;
482 	struct wpa_ssid_value *disallow_aps_ssid;
483 	size_t disallow_aps_ssid_count;
484 
485 	enum set_band setband;
486 
487 	/* Preferred network for the next connection attempt */
488 	struct wpa_ssid *next_ssid;
489 
490 	/* previous scan was wildcard when interleaving between
491 	 * wildcard scans and specific SSID scan when max_ssids=1 */
492 	int prev_scan_wildcard;
493 	struct wpa_ssid *prev_scan_ssid; /* previously scanned SSID;
494 					  * NULL = not yet initialized (start
495 					  * with wildcard SSID)
496 					  * WILDCARD_SSID_SCAN = wildcard
497 					  * SSID was used in the previous scan
498 					  */
499 #define WILDCARD_SSID_SCAN ((struct wpa_ssid *) 1)
500 
501 	struct wpa_ssid *prev_sched_ssid; /* last SSID used in sched scan */
502 	int sched_scan_timeout;
503 	int sched_scan_interval;
504 	int first_sched_scan;
505 	int sched_scan_timed_out;
506 
507 	void (*scan_res_handler)(struct wpa_supplicant *wpa_s,
508 				 struct wpa_scan_results *scan_res);
509 	struct dl_list bss; /* struct wpa_bss::list */
510 	struct dl_list bss_id; /* struct wpa_bss::list_id */
511 	size_t num_bss;
512 	unsigned int bss_update_idx;
513 	unsigned int bss_next_id;
514 
515 	 /*
516 	  * Pointers to BSS entries in the order they were in the last scan
517 	  * results.
518 	  */
519 	struct wpa_bss **last_scan_res;
520 	unsigned int last_scan_res_used;
521 	unsigned int last_scan_res_size;
522 	struct os_reltime last_scan;
523 
524 	const struct wpa_driver_ops *driver;
525 	int interface_removed; /* whether the network interface has been
526 				* removed */
527 	struct wpa_sm *wpa;
528 	struct eapol_sm *eapol;
529 
530 	struct ctrl_iface_priv *ctrl_iface;
531 
532 	enum wpa_states wpa_state;
533 	struct wpa_radio_work *scan_work;
534 	int scanning;
535 	int sched_scanning;
536 	int new_connection;
537 
538 	int eapol_received; /* number of EAPOL packets received after the
539 			     * previous association event */
540 
541 	struct scard_data *scard;
542 	char imsi[20];
543 	int mnc_len;
544 
545 	unsigned char last_eapol_src[ETH_ALEN];
546 
547 	unsigned int keys_cleared; /* bitfield of key indexes that the driver is
548 				    * known not to be configured with a key */
549 
550 	struct wpa_blacklist *blacklist;
551 
552 	/**
553 	 * extra_blacklist_count - Sum of blacklist counts after last connection
554 	 *
555 	 * This variable is used to maintain a count of temporary blacklisting
556 	 * failures (maximum number for any BSS) over blacklist clear
557 	 * operations. This is needed for figuring out whether there has been
558 	 * failures prior to the last blacklist clear operation which happens
559 	 * whenever no other not-blacklisted BSS candidates are available. This
560 	 * gets cleared whenever a connection has been established successfully.
561 	 */
562 	int extra_blacklist_count;
563 
564 	/**
565 	 * scan_req - Type of the scan request
566 	 */
567 	enum scan_req_type {
568 		/**
569 		 * NORMAL_SCAN_REQ - Normal scan request
570 		 *
571 		 * This is used for scans initiated by wpa_supplicant to find an
572 		 * AP for a connection.
573 		 */
574 		NORMAL_SCAN_REQ,
575 
576 		/**
577 		 * INITIAL_SCAN_REQ - Initial scan request
578 		 *
579 		 * This is used for the first scan on an interface to force at
580 		 * least one scan to be run even if the configuration does not
581 		 * include any enabled networks.
582 		 */
583 		INITIAL_SCAN_REQ,
584 
585 		/**
586 		 * MANUAL_SCAN_REQ - Manual scan request
587 		 *
588 		 * This is used for scans where the user request a scan or
589 		 * a specific wpa_supplicant operation (e.g., WPS) requires scan
590 		 * to be run.
591 		 */
592 		MANUAL_SCAN_REQ
593 	} scan_req, last_scan_req;
594 	enum wpa_states scan_prev_wpa_state;
595 	struct os_reltime scan_trigger_time, scan_start_time;
596 	/* Minimum freshness requirement for connection purposes */
597 	struct os_reltime scan_min_time;
598 	int scan_runs; /* number of scan runs since WPS was started */
599 	int *next_scan_freqs;
600 	int *manual_scan_freqs;
601 	int *manual_sched_scan_freqs;
602 	unsigned int manual_scan_passive:1;
603 	unsigned int manual_scan_use_id:1;
604 	unsigned int manual_scan_only_new:1;
605 	unsigned int own_scan_requested:1;
606 	unsigned int own_scan_running:1;
607 	unsigned int clear_driver_scan_cache:1;
608 	unsigned int manual_scan_id;
609 	int scan_interval; /* time in sec between scans to find suitable AP */
610 	int normal_scans; /* normal scans run before sched_scan */
611 	int scan_for_connection; /* whether the scan request was triggered for
612 				  * finding a connection */
613 #define MAX_SCAN_ID 16
614 	int scan_id[MAX_SCAN_ID];
615 	unsigned int scan_id_count;
616 
617 	struct wpa_ssid_value *ssids_from_scan_req;
618 	unsigned int num_ssids_from_scan_req;
619 
620 	u64 drv_flags;
621 	unsigned int drv_enc;
622 	unsigned int drv_smps_modes;
623 	unsigned int drv_rrm_flags;
624 
625 	/*
626 	 * A bitmap of supported protocols for probe response offload. See
627 	 * struct wpa_driver_capa in driver.h
628 	 */
629 	unsigned int probe_resp_offloads;
630 
631 	/* extended capabilities supported by the driver */
632 	const u8 *extended_capa, *extended_capa_mask;
633 	unsigned int extended_capa_len;
634 
635 	int max_scan_ssids;
636 	int max_sched_scan_ssids;
637 	int sched_scan_supported;
638 	unsigned int max_match_sets;
639 	unsigned int max_remain_on_chan;
640 	unsigned int max_stations;
641 
642 	int pending_mic_error_report;
643 	int pending_mic_error_pairwise;
644 	int mic_errors_seen; /* Michael MIC errors with the current PTK */
645 
646 	struct wps_context *wps;
647 	int wps_success; /* WPS success event received */
648 	struct wps_er *wps_er;
649 	unsigned int wps_run;
650 	struct os_reltime wps_pin_start_time;
651 	int blacklist_cleared;
652 
653 	struct wpabuf *pending_eapol_rx;
654 	struct os_reltime pending_eapol_rx_time;
655 	u8 pending_eapol_rx_src[ETH_ALEN];
656 	unsigned int last_eapol_matches_bssid:1;
657 	unsigned int eap_expected_failure:1;
658 	unsigned int reattach:1; /* reassociation to the same BSS requested */
659 	unsigned int mac_addr_changed:1;
660 	unsigned int added_vif:1;
661 
662 	struct os_reltime last_mac_addr_change;
663 	int last_mac_addr_style;
664 
665 	struct ibss_rsn *ibss_rsn;
666 
667 	int set_sta_uapsd;
668 	int sta_uapsd;
669 	int set_ap_uapsd;
670 	int ap_uapsd;
671 
672 #ifdef CONFIG_SME
673 	struct {
674 		u8 ssid[SSID_MAX_LEN];
675 		size_t ssid_len;
676 		int freq;
677 		u8 assoc_req_ie[200];
678 		size_t assoc_req_ie_len;
679 		int mfp;
680 		int ft_used;
681 		u8 mobility_domain[2];
682 		u8 *ft_ies;
683 		size_t ft_ies_len;
684 		u8 prev_bssid[ETH_ALEN];
685 		int prev_bssid_set;
686 		int auth_alg;
687 		int proto;
688 
689 		int sa_query_count; /* number of pending SA Query requests;
690 				     * 0 = no SA Query in progress */
691 		int sa_query_timed_out;
692 		u8 *sa_query_trans_id; /* buffer of WLAN_SA_QUERY_TR_ID_LEN *
693 					* sa_query_count octets of pending
694 					* SA Query transaction identifiers */
695 		struct os_reltime sa_query_start;
696 		struct os_reltime last_unprot_disconnect;
697 		enum { HT_SEC_CHAN_UNKNOWN,
698 		       HT_SEC_CHAN_ABOVE,
699 		       HT_SEC_CHAN_BELOW } ht_sec_chan;
700 		u8 sched_obss_scan;
701 		u16 obss_scan_int;
702 		u16 bss_max_idle_period;
703 #ifdef CONFIG_SAE
704 		struct sae_data sae;
705 		struct wpabuf *sae_token;
706 		int sae_group_index;
707 		unsigned int sae_pmksa_caching:1;
708 #endif /* CONFIG_SAE */
709 	} sme;
710 #endif /* CONFIG_SME */
711 
712 #ifdef CONFIG_AP
713 	struct hostapd_iface *ap_iface;
714 	void (*ap_configured_cb)(void *ctx, void *data);
715 	void *ap_configured_cb_ctx;
716 	void *ap_configured_cb_data;
717 #endif /* CONFIG_AP */
718 
719 	struct hostapd_iface *ifmsh;
720 #ifdef CONFIG_MESH
721 	struct mesh_rsn *mesh_rsn;
722 	int mesh_if_idx;
723 	unsigned int mesh_if_created:1;
724 	unsigned int mesh_ht_enabled:1;
725 	int mesh_auth_block_duration; /* sec */
726 #endif /* CONFIG_MESH */
727 
728 	unsigned int off_channel_freq;
729 	struct wpabuf *pending_action_tx;
730 	u8 pending_action_src[ETH_ALEN];
731 	u8 pending_action_dst[ETH_ALEN];
732 	u8 pending_action_bssid[ETH_ALEN];
733 	unsigned int pending_action_freq;
734 	int pending_action_no_cck;
735 	int pending_action_without_roc;
736 	unsigned int pending_action_tx_done:1;
737 	void (*pending_action_tx_status_cb)(struct wpa_supplicant *wpa_s,
738 					    unsigned int freq, const u8 *dst,
739 					    const u8 *src, const u8 *bssid,
740 					    const u8 *data, size_t data_len,
741 					    enum offchannel_send_action_result
742 					    result);
743 	unsigned int roc_waiting_drv_freq;
744 	int action_tx_wait_time;
745 
746 	int p2p_mgmt;
747 
748 #ifdef CONFIG_P2P
749 	struct p2p_go_neg_results *go_params;
750 	int create_p2p_iface;
751 	u8 pending_interface_addr[ETH_ALEN];
752 	char pending_interface_name[100];
753 	int pending_interface_type;
754 	int p2p_group_idx;
755 	unsigned int pending_listen_freq;
756 	unsigned int pending_listen_duration;
757 	enum {
758 		NOT_P2P_GROUP_INTERFACE,
759 		P2P_GROUP_INTERFACE_PENDING,
760 		P2P_GROUP_INTERFACE_GO,
761 		P2P_GROUP_INTERFACE_CLIENT
762 	} p2p_group_interface;
763 	struct p2p_group *p2p_group;
764 	int p2p_long_listen; /* remaining time in long Listen state in ms */
765 	char p2p_pin[10];
766 	int p2p_wps_method;
767 	u8 p2p_auth_invite[ETH_ALEN];
768 	int p2p_sd_over_ctrl_iface;
769 	int p2p_in_provisioning;
770 	int p2p_in_invitation;
771 	int p2p_invite_go_freq;
772 	int pending_invite_ssid_id;
773 	int show_group_started;
774 	u8 go_dev_addr[ETH_ALEN];
775 	int pending_pd_before_join;
776 	u8 pending_join_iface_addr[ETH_ALEN];
777 	u8 pending_join_dev_addr[ETH_ALEN];
778 	int pending_join_wps_method;
779 	u8 p2p_join_ssid[SSID_MAX_LEN];
780 	size_t p2p_join_ssid_len;
781 	int p2p_join_scan_count;
782 	int auto_pd_scan_retry;
783 	int force_long_sd;
784 	u16 pending_pd_config_methods;
785 	enum {
786 		NORMAL_PD, AUTO_PD_GO_NEG, AUTO_PD_JOIN, AUTO_PD_ASP
787 	} pending_pd_use;
788 
789 	/*
790 	 * Whether cross connection is disallowed by the AP to which this
791 	 * interface is associated (only valid if there is an association).
792 	 */
793 	int cross_connect_disallowed;
794 
795 	/*
796 	 * Whether this P2P group is configured to use cross connection (only
797 	 * valid if this is P2P GO interface). The actual cross connect packet
798 	 * forwarding may not be configured depending on the uplink status.
799 	 */
800 	int cross_connect_enabled;
801 
802 	/* Whether cross connection forwarding is in use at the moment. */
803 	int cross_connect_in_use;
804 
805 	/*
806 	 * Uplink interface name for cross connection
807 	 */
808 	char cross_connect_uplink[100];
809 
810 	unsigned int p2p_auto_join:1;
811 	unsigned int p2p_auto_pd:1;
812 	unsigned int p2p_persistent_group:1;
813 	unsigned int p2p_fallback_to_go_neg:1;
814 	unsigned int p2p_pd_before_go_neg:1;
815 	unsigned int p2p_go_ht40:1;
816 	unsigned int p2p_go_vht:1;
817 	unsigned int user_initiated_pd:1;
818 	unsigned int p2p_go_group_formation_completed:1;
819 	unsigned int group_formation_reported:1;
820 	unsigned int waiting_presence_resp;
821 	int p2p_first_connection_timeout;
822 	unsigned int p2p_nfc_tag_enabled:1;
823 	unsigned int p2p_peer_oob_pk_hash_known:1;
824 	unsigned int p2p_disable_ip_addr_req:1;
825 	unsigned int p2ps_method_config_any:1;
826 	unsigned int p2p_cli_probe:1;
827 	int p2p_persistent_go_freq;
828 	int p2p_persistent_id;
829 	int p2p_go_intent;
830 	int p2p_connect_freq;
831 	struct os_reltime p2p_auto_started;
832 	struct wpa_ssid *p2p_last_4way_hs_fail;
833 	struct wpa_radio_work *p2p_scan_work;
834 	struct wpa_radio_work *p2p_listen_work;
835 	struct wpa_radio_work *p2p_send_action_work;
836 
837 	u16 p2p_oob_dev_pw_id; /* OOB Device Password Id for group formation */
838 	struct wpabuf *p2p_oob_dev_pw; /* OOB Device Password for group
839 					* formation */
840 	u8 p2p_peer_oob_pubkey_hash[WPS_OOB_PUBKEY_HASH_LEN];
841 	u8 p2p_ip_addr_info[3 * 4];
842 
843 	/* group common frequencies */
844 	int *p2p_group_common_freqs;
845 	unsigned int p2p_group_common_freqs_num;
846 	u8 p2ps_join_addr[ETH_ALEN];
847 #endif /* CONFIG_P2P */
848 
849 	struct wpa_ssid *bgscan_ssid;
850 	const struct bgscan_ops *bgscan;
851 	void *bgscan_priv;
852 
853 	const struct autoscan_ops *autoscan;
854 	struct wpa_driver_scan_params *autoscan_params;
855 	void *autoscan_priv;
856 
857 	struct wpa_ssid *connect_without_scan;
858 
859 	struct wps_ap_info *wps_ap;
860 	size_t num_wps_ap;
861 	int wps_ap_iter;
862 
863 	int after_wps;
864 	int known_wps_freq;
865 	unsigned int wps_freq;
866 	int wps_fragment_size;
867 	int auto_reconnect_disabled;
868 
869 	 /* Channel preferences for AP/P2P GO use */
870 	int best_24_freq;
871 	int best_5_freq;
872 	int best_overall_freq;
873 
874 	struct gas_query *gas;
875 
876 #ifdef CONFIG_INTERWORKING
877 	unsigned int fetch_anqp_in_progress:1;
878 	unsigned int network_select:1;
879 	unsigned int auto_select:1;
880 	unsigned int auto_network_select:1;
881 	unsigned int interworking_fast_assoc_tried:1;
882 	unsigned int fetch_all_anqp:1;
883 	unsigned int fetch_osu_info:1;
884 	unsigned int fetch_osu_waiting_scan:1;
885 	unsigned int fetch_osu_icon_in_progress:1;
886 	struct wpa_bss *interworking_gas_bss;
887 	unsigned int osu_icon_id;
888 	struct osu_provider *osu_prov;
889 	size_t osu_prov_count;
890 	struct os_reltime osu_icon_fetch_start;
891 	unsigned int num_osu_scans;
892 	unsigned int num_prov_found;
893 #endif /* CONFIG_INTERWORKING */
894 	unsigned int drv_capa_known;
895 
896 	struct {
897 		struct hostapd_hw_modes *modes;
898 		u16 num_modes;
899 		u16 flags;
900 	} hw;
901 	enum local_hw_capab {
902 		CAPAB_NO_HT_VHT,
903 		CAPAB_HT,
904 		CAPAB_HT40,
905 		CAPAB_VHT,
906 	} hw_capab;
907 #ifdef CONFIG_MACSEC
908 	struct ieee802_1x_kay *kay;
909 #endif /* CONFIG_MACSEC */
910 
911 	int pno;
912 	int pno_sched_pending;
913 
914 	/* WLAN_REASON_* reason codes. Negative if locally generated. */
915 	int disconnect_reason;
916 
917 	struct ext_password_data *ext_pw;
918 
919 	struct wpabuf *last_gas_resp, *prev_gas_resp;
920 	u8 last_gas_addr[ETH_ALEN], prev_gas_addr[ETH_ALEN];
921 	u8 last_gas_dialog_token, prev_gas_dialog_token;
922 
923 	unsigned int no_keep_alive:1;
924 	unsigned int ext_mgmt_frame_handling:1;
925 	unsigned int ext_eapol_frame_io:1;
926 	unsigned int wmm_ac_supported:1;
927 	unsigned int ext_work_in_progress:1;
928 	unsigned int own_disconnect_req:1;
929 
930 #define MAC_ADDR_RAND_SCAN       BIT(0)
931 #define MAC_ADDR_RAND_SCHED_SCAN BIT(1)
932 #define MAC_ADDR_RAND_PNO        BIT(2)
933 #define MAC_ADDR_RAND_ALL        (MAC_ADDR_RAND_SCAN | \
934 				  MAC_ADDR_RAND_SCHED_SCAN | \
935 				  MAC_ADDR_RAND_PNO)
936 	unsigned int mac_addr_rand_supported;
937 	unsigned int mac_addr_rand_enable;
938 
939 	/* MAC Address followed by mask (2 * ETH_ALEN) */
940 	u8 *mac_addr_scan;
941 	u8 *mac_addr_sched_scan;
942 	u8 *mac_addr_pno;
943 
944 #ifdef CONFIG_WNM
945 	u8 wnm_dialog_token;
946 	u8 wnm_reply;
947 	u8 wnm_num_neighbor_report;
948 	u8 wnm_mode;
949 	u16 wnm_dissoc_timer;
950 	u8 wnm_bss_termination_duration[12];
951 	struct neighbor_report *wnm_neighbor_report_elements;
952 	struct os_reltime wnm_cand_valid_until;
953 	u8 wnm_cand_from_bss[ETH_ALEN];
954 #endif /* CONFIG_WNM */
955 
956 #ifdef CONFIG_TESTING_GET_GTK
957 	u8 last_gtk[32];
958 	size_t last_gtk_len;
959 #endif /* CONFIG_TESTING_GET_GTK */
960 
961 	unsigned int num_multichan_concurrent;
962 	struct wpa_radio_work *connect_work;
963 
964 	unsigned int ext_work_id;
965 
966 	struct wpabuf *vendor_elem[NUM_VENDOR_ELEM_FRAMES];
967 
968 #ifdef CONFIG_TESTING_OPTIONS
969 	struct l2_packet_data *l2_test;
970 	unsigned int extra_roc_dur;
971 	enum wpa_supplicant_test_failure test_failure;
972 #endif /* CONFIG_TESTING_OPTIONS */
973 
974 	struct wmm_ac_assoc_data *wmm_ac_assoc_info;
975 	struct wmm_tspec_element *tspecs[WMM_AC_NUM][TS_DIR_IDX_COUNT];
976 	struct wmm_ac_addts_request *addts_request;
977 	u8 wmm_ac_last_dialog_token;
978 	struct wmm_tspec_element *last_tspecs;
979 	u8 last_tspecs_count;
980 
981 	struct rrm_data rrm;
982 
983 #ifdef CONFIG_FST
984 	struct fst_iface *fst;
985 	const struct wpabuf *fst_ies;
986 	struct wpabuf *received_mb_ies;
987 #endif /* CONFIG_FST */
988 };
989 
990 
991 /* wpa_supplicant.c */
992 void wpa_supplicant_apply_ht_overrides(
993 	struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid,
994 	struct wpa_driver_associate_params *params);
995 void wpa_supplicant_apply_vht_overrides(
996 	struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid,
997 	struct wpa_driver_associate_params *params);
998 
999 int wpa_set_wep_keys(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid);
1000 int wpa_supplicant_set_wpa_none_key(struct wpa_supplicant *wpa_s,
1001 				    struct wpa_ssid *ssid);
1002 
1003 int wpa_supplicant_reload_configuration(struct wpa_supplicant *wpa_s);
1004 
1005 const char * wpa_supplicant_state_txt(enum wpa_states state);
1006 int wpa_supplicant_update_mac_addr(struct wpa_supplicant *wpa_s);
1007 int wpa_supplicant_driver_init(struct wpa_supplicant *wpa_s);
1008 int wpa_supplicant_set_suites(struct wpa_supplicant *wpa_s,
1009 			      struct wpa_bss *bss, struct wpa_ssid *ssid,
1010 			      u8 *wpa_ie, size_t *wpa_ie_len);
1011 void wpa_supplicant_associate(struct wpa_supplicant *wpa_s,
1012 			      struct wpa_bss *bss,
1013 			      struct wpa_ssid *ssid);
1014 void wpa_supplicant_set_non_wpa_policy(struct wpa_supplicant *wpa_s,
1015 				       struct wpa_ssid *ssid);
1016 void wpa_supplicant_initiate_eapol(struct wpa_supplicant *wpa_s);
1017 void wpa_clear_keys(struct wpa_supplicant *wpa_s, const u8 *addr);
1018 void wpa_supplicant_req_auth_timeout(struct wpa_supplicant *wpa_s,
1019 				     int sec, int usec);
1020 void wpa_supplicant_reinit_autoscan(struct wpa_supplicant *wpa_s);
1021 void wpa_supplicant_set_state(struct wpa_supplicant *wpa_s,
1022 			      enum wpa_states state);
1023 struct wpa_ssid * wpa_supplicant_get_ssid(struct wpa_supplicant *wpa_s);
1024 const char * wpa_supplicant_get_eap_mode(struct wpa_supplicant *wpa_s);
1025 void wpa_supplicant_cancel_auth_timeout(struct wpa_supplicant *wpa_s);
1026 void wpa_supplicant_deauthenticate(struct wpa_supplicant *wpa_s,
1027 				   int reason_code);
1028 
1029 void wpa_supplicant_enable_network(struct wpa_supplicant *wpa_s,
1030 				   struct wpa_ssid *ssid);
1031 void wpa_supplicant_disable_network(struct wpa_supplicant *wpa_s,
1032 				    struct wpa_ssid *ssid);
1033 void wpa_supplicant_select_network(struct wpa_supplicant *wpa_s,
1034 				   struct wpa_ssid *ssid);
1035 int wpas_set_pkcs11_engine_and_module_path(struct wpa_supplicant *wpa_s,
1036 					   const char *pkcs11_engine_path,
1037 					   const char *pkcs11_module_path);
1038 int wpa_supplicant_set_ap_scan(struct wpa_supplicant *wpa_s,
1039 			       int ap_scan);
1040 int wpa_supplicant_set_bss_expiration_age(struct wpa_supplicant *wpa_s,
1041 					  unsigned int expire_age);
1042 int wpa_supplicant_set_bss_expiration_count(struct wpa_supplicant *wpa_s,
1043 					    unsigned int expire_count);
1044 int wpa_supplicant_set_scan_interval(struct wpa_supplicant *wpa_s,
1045 				     int scan_interval);
1046 int wpa_supplicant_set_debug_params(struct wpa_global *global,
1047 				    int debug_level, int debug_timestamp,
1048 				    int debug_show_keys);
1049 void free_hw_features(struct wpa_supplicant *wpa_s);
1050 
1051 void wpa_show_license(void);
1052 
1053 struct wpa_supplicant * wpa_supplicant_add_iface(struct wpa_global *global,
1054 						 struct wpa_interface *iface,
1055 						 struct wpa_supplicant *parent);
1056 int wpa_supplicant_remove_iface(struct wpa_global *global,
1057 				struct wpa_supplicant *wpa_s,
1058 				int terminate);
1059 struct wpa_supplicant * wpa_supplicant_get_iface(struct wpa_global *global,
1060 						 const char *ifname);
1061 struct wpa_global * wpa_supplicant_init(struct wpa_params *params);
1062 int wpa_supplicant_run(struct wpa_global *global);
1063 void wpa_supplicant_deinit(struct wpa_global *global);
1064 
1065 int wpa_supplicant_scard_init(struct wpa_supplicant *wpa_s,
1066 			      struct wpa_ssid *ssid);
1067 void wpa_supplicant_terminate_proc(struct wpa_global *global);
1068 void wpa_supplicant_rx_eapol(void *ctx, const u8 *src_addr,
1069 			     const u8 *buf, size_t len);
1070 void wpa_supplicant_update_config(struct wpa_supplicant *wpa_s);
1071 void wpa_supplicant_clear_status(struct wpa_supplicant *wpa_s);
1072 void wpas_connection_failed(struct wpa_supplicant *wpa_s, const u8 *bssid);
1073 int wpas_driver_bss_selection(struct wpa_supplicant *wpa_s);
1074 int wpas_is_p2p_prioritized(struct wpa_supplicant *wpa_s);
1075 void wpas_auth_failed(struct wpa_supplicant *wpa_s, char *reason);
1076 void wpas_clear_temp_disabled(struct wpa_supplicant *wpa_s,
1077 			      struct wpa_ssid *ssid, int clear_failures);
1078 int disallowed_bssid(struct wpa_supplicant *wpa_s, const u8 *bssid);
1079 int disallowed_ssid(struct wpa_supplicant *wpa_s, const u8 *ssid,
1080 		    size_t ssid_len);
1081 void wpas_request_connection(struct wpa_supplicant *wpa_s);
1082 int wpas_build_ext_capab(struct wpa_supplicant *wpa_s, u8 *buf, size_t buflen);
1083 int wpas_update_random_addr(struct wpa_supplicant *wpa_s, int style);
1084 int wpas_update_random_addr_disassoc(struct wpa_supplicant *wpa_s);
1085 void add_freq(int *freqs, int *num_freqs, int freq);
1086 
1087 void wpas_rrm_reset(struct wpa_supplicant *wpa_s);
1088 void wpas_rrm_process_neighbor_rep(struct wpa_supplicant *wpa_s,
1089 				   const u8 *report, size_t report_len);
1090 int wpas_rrm_send_neighbor_rep_request(struct wpa_supplicant *wpa_s,
1091 				       const struct wpa_ssid *ssid,
1092 				       void (*cb)(void *ctx,
1093 						  struct wpabuf *neighbor_rep),
1094 				       void *cb_ctx);
1095 void wpas_rrm_handle_link_measurement_request(struct wpa_supplicant *wpa_s,
1096 					      const u8 *src,
1097 					      const u8 *frame, size_t len,
1098 					      int rssi);
1099 
1100 /**
1101  * wpa_supplicant_ctrl_iface_ctrl_rsp_handle - Handle a control response
1102  * @wpa_s: Pointer to wpa_supplicant data
1103  * @ssid: Pointer to the network block the reply is for
1104  * @field: field the response is a reply for
1105  * @value: value (ie, password, etc) for @field
1106  * Returns: 0 on success, non-zero on error
1107  *
1108  * Helper function to handle replies to control interface requests.
1109  */
1110 int wpa_supplicant_ctrl_iface_ctrl_rsp_handle(struct wpa_supplicant *wpa_s,
1111 					      struct wpa_ssid *ssid,
1112 					      const char *field,
1113 					      const char *value);
1114 
1115 void ibss_mesh_setup_freq(struct wpa_supplicant *wpa_s,
1116 			  const struct wpa_ssid *ssid,
1117 			  struct hostapd_freq_params *freq);
1118 
1119 /* events.c */
1120 void wpa_supplicant_mark_disassoc(struct wpa_supplicant *wpa_s);
1121 int wpa_supplicant_connect(struct wpa_supplicant *wpa_s,
1122 			   struct wpa_bss *selected,
1123 			   struct wpa_ssid *ssid);
1124 void wpa_supplicant_stop_countermeasures(void *eloop_ctx, void *sock_ctx);
1125 void wpa_supplicant_delayed_mic_error_report(void *eloop_ctx, void *sock_ctx);
1126 void wnm_bss_keep_alive_deinit(struct wpa_supplicant *wpa_s);
1127 int wpa_supplicant_fast_associate(struct wpa_supplicant *wpa_s);
1128 struct wpa_bss * wpa_supplicant_pick_network(struct wpa_supplicant *wpa_s,
1129 					     struct wpa_ssid **selected_ssid);
1130 
1131 /* eap_register.c */
1132 int eap_register_methods(void);
1133 
1134 /**
1135  * Utility method to tell if a given network is for persistent group storage
1136  * @ssid: Network object
1137  * Returns: 1 if network is a persistent group, 0 otherwise
1138  */
1139 static inline int network_is_persistent_group(struct wpa_ssid *ssid)
1140 {
1141 	return ssid->disabled == 2 && ssid->p2p_persistent_group;
1142 }
1143 
1144 int wpas_network_disabled(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid);
1145 int wpas_get_ssid_pmf(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid);
1146 
1147 int wpas_init_ext_pw(struct wpa_supplicant *wpa_s);
1148 
1149 void dump_freq_data(struct wpa_supplicant *wpa_s, const char *title,
1150 		    struct wpa_used_freq_data *freqs_data,
1151 		    unsigned int len);
1152 
1153 int get_shared_radio_freqs_data(struct wpa_supplicant *wpa_s,
1154 				struct wpa_used_freq_data *freqs_data,
1155 				unsigned int len);
1156 int get_shared_radio_freqs(struct wpa_supplicant *wpa_s,
1157 			   int *freq_array, unsigned int len);
1158 
1159 void wpas_network_reenabled(void *eloop_ctx, void *timeout_ctx);
1160 
1161 #ifdef CONFIG_FST
1162 
1163 struct fst_wpa_obj;
1164 
1165 void fst_wpa_supplicant_fill_iface_obj(struct wpa_supplicant *wpa_s,
1166 				       struct fst_wpa_obj *iface_obj);
1167 
1168 #endif /* CONFIG_FST */
1169 
1170 #endif /* WPA_SUPPLICANT_I_H */
1171