2 * wpa_supplicant - Internal definitions
3 * Copyright (c) 2003-2012, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
9 #ifndef WPA_SUPPLICANT_I_H
10 #define WPA_SUPPLICANT_I_H
12 #include "utils/list.h"
13 #include "common/defs.h"
14 #include "common/sae.h"
15 #include "config_ssid.h"
17 extern const char *wpa_supplicant_version;
18 extern const char *wpa_supplicant_license;
19 #ifndef CONFIG_NO_STDOUT_DEBUG
20 extern const char *wpa_supplicant_full_license1;
21 extern const char *wpa_supplicant_full_license2;
22 extern const char *wpa_supplicant_full_license3;
23 extern const char *wpa_supplicant_full_license4;
24 extern const char *wpa_supplicant_full_license5;
25 #endif /* CONFIG_NO_STDOUT_DEBUG */
28 struct wpa_supplicant;
32 struct wpa_scan_results;
33 struct hostapd_hw_modes;
34 struct wpa_driver_associate_params;
37 * Forward declarations of private structures used within the ctrl_iface
38 * backends. Other parts of wpa_supplicant do not have access to data stored in
41 struct ctrl_iface_priv;
42 struct ctrl_iface_global_priv;
43 struct wpas_dbus_priv;
46 * struct wpa_interface - Parameters for wpa_supplicant_add_iface()
48 struct wpa_interface {
50 * confname - Configuration name (file or profile) name
52 * This can also be %NULL when a configuration file is not used. In
53 * that case, ctrl_interface must be set to allow the interface to be
59 * ctrl_interface - Control interface parameter
61 * If a configuration file is not used, this variable can be used to
62 * set the ctrl_interface parameter that would have otherwise been read
63 * from the configuration file. If both confname and ctrl_interface are
64 * set, ctrl_interface is used to override the value from configuration
67 const char *ctrl_interface;
70 * driver - Driver interface name, or %NULL to use the default driver
75 * driver_param - Driver interface parameters
77 * If a configuration file is not used, this variable can be used to
78 * set the driver_param parameters that would have otherwise been read
79 * from the configuration file. If both confname and driver_param are
80 * set, driver_param is used to override the value from configuration
83 const char *driver_param;
86 * ifname - Interface name
91 * bridge_ifname - Optional bridge interface name
93 * If the driver interface (ifname) is included in a Linux bridge
94 * device, the bridge interface may need to be used for receiving EAPOL
95 * frames. This can be enabled by setting this variable to enable
96 * receiving of EAPOL frames from an additional interface.
98 const char *bridge_ifname;
102 * struct wpa_params - Parameters for wpa_supplicant_init()
106 * daemonize - Run %wpa_supplicant in the background
111 * wait_for_monitor - Wait for a monitor program before starting
113 int wait_for_monitor;
116 * pid_file - Path to a PID (process ID) file
118 * If this and daemonize are set, process ID of the background process
119 * will be written to the specified file.
124 * wpa_debug_level - Debugging verbosity level (e.g., MSG_INFO)
129 * wpa_debug_show_keys - Whether keying material is included in debug
131 * This parameter can be used to allow keying material to be included
132 * in debug messages. This is a security risk and this option should
133 * not be enabled in normal configuration. If needed during
134 * development or while troubleshooting, this option can provide more
135 * details for figuring out what is happening.
137 int wpa_debug_show_keys;
140 * wpa_debug_timestamp - Whether to include timestamp in debug messages
142 int wpa_debug_timestamp;
145 * ctrl_interface - Global ctrl_iface path/parameter
147 char *ctrl_interface;
150 * dbus_ctrl_interface - Enable the DBus control interface
152 int dbus_ctrl_interface;
155 * wpa_debug_file_path - Path of debug file or %NULL to use stdout
157 const char *wpa_debug_file_path;
160 * wpa_debug_syslog - Enable log output through syslog
162 int wpa_debug_syslog;
165 * wpa_debug_tracing - Enable log output through Linux tracing
167 int wpa_debug_tracing;
170 * override_driver - Optional driver parameter override
172 * This parameter can be used to override the driver parameter in
173 * dynamic interface addition to force a specific driver wrapper to be
176 char *override_driver;
179 * override_ctrl_interface - Optional ctrl_interface override
181 * This parameter can be used to override the ctrl_interface parameter
182 * in dynamic interface addition to force a control interface to be
185 char *override_ctrl_interface;
188 * entropy_file - Optional entropy file
190 * This parameter can be used to configure wpa_supplicant to maintain
191 * its internal entropy store over restarts.
196 struct p2p_srv_bonjour {
198 struct wpabuf *query;
202 struct p2p_srv_upnp {
208 struct wpa_freq_range {
215 * struct wpa_global - Internal, global data for all %wpa_supplicant interfaces
217 * This structure is initialized by calling wpa_supplicant_init() when starting
221 struct wpa_supplicant *ifaces;
222 struct wpa_params params;
223 struct ctrl_iface_global_priv *ctrl_iface;
224 struct wpas_dbus_priv *dbus;
227 struct os_time suspend_time;
228 struct p2p_data *p2p;
229 struct wpa_supplicant *p2p_init_wpa_s;
230 struct wpa_supplicant *p2p_group_formation;
231 u8 p2p_dev_addr[ETH_ALEN];
232 struct dl_list p2p_srv_bonjour; /* struct p2p_srv_bonjour */
233 struct dl_list p2p_srv_upnp; /* struct p2p_srv_upnp */
235 int cross_connection;
236 struct wpa_freq_range *p2p_disallow_freq;
237 unsigned int num_p2p_disallow_freq;
239 WPA_CONC_PREF_NOT_SET,
243 unsigned int p2p_cb_on_scan_complete:1;
245 #ifdef CONFIG_WIFI_DISPLAY
247 #define MAX_WFD_SUBELEMS 10
248 struct wpabuf *wfd_subelem[MAX_WFD_SUBELEMS];
249 #endif /* CONFIG_WIFI_DISPLAY */
254 * offchannel_send_action_result - Result of offchannel send Action frame
256 enum offchannel_send_action_result {
257 OFFCHANNEL_SEND_ACTION_SUCCESS /**< Frame was send and acknowledged */,
258 OFFCHANNEL_SEND_ACTION_NO_ACK /**< Frame was sent, but not acknowledged
260 OFFCHANNEL_SEND_ACTION_FAILED /**< Frame was not sent due to a failure
266 enum wps_ap_info_type {
272 struct os_time last_attempt;
275 struct wpa_ssid_value {
281 * struct wpa_supplicant - Internal data for wpa_supplicant interface
283 * This structure contains the internal data for core wpa_supplicant code. This
284 * should be only used directly from the core code. However, a pointer to this
285 * data is used from other files as an arbitrary context pointer in calls to
288 struct wpa_supplicant {
289 struct wpa_global *global;
290 struct wpa_supplicant *parent;
291 struct wpa_supplicant *next;
292 struct l2_packet_data *l2;
293 struct l2_packet_data *l2_br;
294 unsigned char own_addr[ETH_ALEN];
296 #ifdef CONFIG_CTRL_IFACE_DBUS
298 #endif /* CONFIG_CTRL_IFACE_DBUS */
299 #ifdef CONFIG_CTRL_IFACE_DBUS_NEW
301 char *dbus_groupobj_path;
303 char *preq_notify_peer;
304 #endif /* CONFIG_AP */
305 #endif /* CONFIG_CTRL_IFACE_DBUS_NEW */
306 char bridge_ifname[16];
309 struct wpa_config *conf;
311 os_time_t last_michael_mic_error;
313 u8 pending_bssid[ETH_ALEN]; /* If wpa_state == WPA_ASSOCIATING, this
314 * field contains the target BSSID. */
315 int reassociate; /* reassociation requested */
316 int disconnected; /* all connections disabled; i.e., do no reassociate
317 * before this has been cleared */
318 struct wpa_ssid *current_ssid;
319 struct wpa_bss *current_bss;
320 int ap_ies_from_associnfo;
321 unsigned int assoc_freq;
323 /* Selected configuration (based on Beacon/ProbeResp WPA IE) */
328 int mgmt_group_cipher;
330 void *drv_priv; /* private data used by driver_ops */
331 void *global_drv_priv;
334 size_t bssid_filter_count;
336 u8 *disallow_aps_bssid;
337 size_t disallow_aps_bssid_count;
338 struct wpa_ssid_value *disallow_aps_ssid;
339 size_t disallow_aps_ssid_count;
341 /* previous scan was wildcard when interleaving between
342 * wildcard scans and specific SSID scan when max_ssids=1 */
343 int prev_scan_wildcard;
344 struct wpa_ssid *prev_scan_ssid; /* previously scanned SSID;
345 * NULL = not yet initialized (start
346 * with wildcard SSID)
347 * WILDCARD_SSID_SCAN = wildcard
348 * SSID was used in the previous scan
350 #define WILDCARD_SSID_SCAN ((struct wpa_ssid *) 1)
352 struct wpa_ssid *prev_sched_ssid; /* last SSID used in sched scan */
353 int sched_scan_timeout;
354 int sched_scan_interval;
355 int first_sched_scan;
356 int sched_scan_timed_out;
358 void (*scan_res_handler)(struct wpa_supplicant *wpa_s,
359 struct wpa_scan_results *scan_res);
360 struct dl_list bss; /* struct wpa_bss::list */
361 struct dl_list bss_id; /* struct wpa_bss::list_id */
363 unsigned int bss_update_idx;
364 unsigned int bss_next_id;
367 * Pointers to BSS entries in the order they were in the last scan
370 struct wpa_bss **last_scan_res;
371 unsigned int last_scan_res_used;
372 unsigned int last_scan_res_size;
374 struct os_time last_scan;
376 struct wpa_driver_ops *driver;
377 int interface_removed; /* whether the network interface has been
380 struct eapol_sm *eapol;
382 struct ctrl_iface_priv *ctrl_iface;
384 enum wpa_states wpa_state;
389 int eapol_received; /* number of EAPOL packets received after the
390 * previous association event */
392 struct scard_data *scard;
396 #endif /* PCSC_FUNCS */
398 unsigned char last_eapol_src[ETH_ALEN];
402 struct wpa_blacklist *blacklist;
405 * extra_blacklist_count - Sum of blacklist counts after last connection
407 * This variable is used to maintain a count of temporary blacklisting
408 * failures (maximum number for any BSS) over blacklist clear
409 * operations. This is needed for figuring out whether there has been
410 * failures prior to the last blacklist clear operation which happens
411 * whenever no other not-blacklisted BSS candidates are available. This
412 * gets cleared whenever a connection has been established successfully.
414 int extra_blacklist_count;
417 * scan_req - Type of the scan request
421 * NORMAL_SCAN_REQ - Normal scan request
423 * This is used for scans initiated by wpa_supplicant to find an
424 * AP for a connection.
429 * INITIAL_SCAN_REQ - Initial scan request
431 * This is used for the first scan on an interface to force at
432 * least one scan to be run even if the configuration does not
433 * include any enabled networks.
438 * MANUAL_SCAN_REQ - Manual scan request
440 * This is used for scans where the user request a scan or
441 * a specific wpa_supplicant operation (e.g., WPS) requires scan
446 int scan_runs; /* number of scan runs since WPS was started */
447 int *next_scan_freqs;
448 int scan_interval; /* time in sec between scans to find suitable AP */
449 int normal_scans; /* normal scans run before sched_scan */
450 int scan_for_connection; /* whether the scan request was triggered for
451 * finding a connection */
453 unsigned int drv_flags;
454 unsigned int drv_enc;
457 * A bitmap of supported protocols for probe response offload. See
458 * struct wpa_driver_capa in driver.h
460 unsigned int probe_resp_offloads;
463 int max_sched_scan_ssids;
464 int sched_scan_supported;
465 unsigned int max_match_sets;
466 unsigned int max_remain_on_chan;
467 unsigned int max_stations;
469 int pending_mic_error_report;
470 int pending_mic_error_pairwise;
471 int mic_errors_seen; /* Michael MIC errors with the current PTK */
473 struct wps_context *wps;
474 int wps_success; /* WPS success event received */
475 struct wps_er *wps_er;
476 int blacklist_cleared;
478 struct wpabuf *pending_eapol_rx;
479 struct os_time pending_eapol_rx_time;
480 u8 pending_eapol_rx_src[ETH_ALEN];
481 unsigned int last_eapol_matches_bssid:1;
483 struct ibss_rsn *ibss_rsn;
495 u8 assoc_req_ie[200];
496 size_t assoc_req_ie_len;
499 u8 mobility_domain[2];
502 u8 prev_bssid[ETH_ALEN];
507 int sa_query_count; /* number of pending SA Query requests;
508 * 0 = no SA Query in progress */
509 int sa_query_timed_out;
510 u8 *sa_query_trans_id; /* buffer of WLAN_SA_QUERY_TR_ID_LEN *
511 * sa_query_count octets of pending
512 * SA Query transaction identifiers */
513 struct os_time sa_query_start;
516 u16 bss_max_idle_period;
519 struct wpabuf *sae_token;
521 #endif /* CONFIG_SAE */
523 #endif /* CONFIG_SME */
526 struct hostapd_iface *ap_iface;
527 void (*ap_configured_cb)(void *ctx, void *data);
528 void *ap_configured_cb_ctx;
529 void *ap_configured_cb_data;
530 #endif /* CONFIG_AP */
532 unsigned int off_channel_freq;
533 struct wpabuf *pending_action_tx;
534 u8 pending_action_src[ETH_ALEN];
535 u8 pending_action_dst[ETH_ALEN];
536 u8 pending_action_bssid[ETH_ALEN];
537 unsigned int pending_action_freq;
538 int pending_action_no_cck;
539 int pending_action_without_roc;
540 void (*pending_action_tx_status_cb)(struct wpa_supplicant *wpa_s,
541 unsigned int freq, const u8 *dst,
542 const u8 *src, const u8 *bssid,
543 const u8 *data, size_t data_len,
544 enum offchannel_send_action_result
546 unsigned int roc_waiting_drv_freq;
547 int action_tx_wait_time;
550 struct p2p_go_neg_results *go_params;
551 int create_p2p_iface;
552 u8 pending_interface_addr[ETH_ALEN];
553 char pending_interface_name[100];
554 int pending_interface_type;
556 unsigned int pending_listen_freq;
557 unsigned int pending_listen_duration;
559 NOT_P2P_GROUP_INTERFACE,
560 P2P_GROUP_INTERFACE_PENDING,
561 P2P_GROUP_INTERFACE_GO,
562 P2P_GROUP_INTERFACE_CLIENT
563 } p2p_group_interface;
564 struct p2p_group *p2p_group;
565 int p2p_long_listen; /* remaining time in long Listen state in ms */
568 u8 p2p_auth_invite[ETH_ALEN];
569 int p2p_sd_over_ctrl_iface;
570 int p2p_in_provisioning;
571 int pending_invite_ssid_id;
572 int show_group_started;
573 u8 go_dev_addr[ETH_ALEN];
574 int pending_pd_before_join;
575 u8 pending_join_iface_addr[ETH_ALEN];
576 u8 pending_join_dev_addr[ETH_ALEN];
577 int pending_join_wps_method;
578 int p2p_join_scan_count;
579 int auto_pd_scan_retry;
581 u16 pending_pd_config_methods;
583 NORMAL_PD, AUTO_PD_GO_NEG, AUTO_PD_JOIN
587 * Whether cross connection is disallowed by the AP to which this
588 * interface is associated (only valid if there is an association).
590 int cross_connect_disallowed;
593 * Whether this P2P group is configured to use cross connection (only
594 * valid if this is P2P GO interface). The actual cross connect packet
595 * forwarding may not be configured depending on the uplink status.
597 int cross_connect_enabled;
599 /* Whether cross connection forwarding is in use at the moment. */
600 int cross_connect_in_use;
603 * Uplink interface name for cross connection
605 char cross_connect_uplink[100];
607 unsigned int sta_scan_pending:1;
608 unsigned int p2p_auto_join:1;
609 unsigned int p2p_auto_pd:1;
610 unsigned int p2p_persistent_group:1;
611 unsigned int p2p_fallback_to_go_neg:1;
612 unsigned int p2p_pd_before_go_neg:1;
613 unsigned int p2p_go_ht40:1;
614 unsigned int user_initiated_pd:1;
615 int p2p_persistent_go_freq;
616 int p2p_persistent_id;
618 int p2p_connect_freq;
619 struct os_time p2p_auto_started;
620 #endif /* CONFIG_P2P */
622 struct wpa_ssid *bgscan_ssid;
623 const struct bgscan_ops *bgscan;
626 const struct autoscan_ops *autoscan;
627 struct wpa_driver_scan_params *autoscan_params;
630 struct wpa_ssid *connect_without_scan;
632 struct wps_ap_info *wps_ap;
638 unsigned int wps_freq;
640 int wps_fragment_size;
641 int auto_reconnect_disabled;
643 /* Channel preferences for AP/P2P GO use */
646 int best_overall_freq;
648 struct gas_query *gas;
650 #ifdef CONFIG_INTERWORKING
651 unsigned int fetch_anqp_in_progress:1;
652 unsigned int network_select:1;
653 unsigned int auto_select:1;
654 unsigned int auto_network_select:1;
655 unsigned int fetch_all_anqp:1;
656 #endif /* CONFIG_INTERWORKING */
657 unsigned int drv_capa_known;
660 struct hostapd_hw_modes *modes;
667 /* WLAN_REASON_* reason codes. Negative if locally generated. */
668 int disconnect_reason;
670 struct ext_password_data *ext_pw;
672 struct wpabuf *last_gas_resp;
673 u8 last_gas_addr[ETH_ALEN];
674 u8 last_gas_dialog_token;
676 unsigned int no_keep_alive:1;
680 /* wpa_supplicant.c */
681 void wpa_supplicant_apply_ht_overrides(
682 struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid,
683 struct wpa_driver_associate_params *params);
685 int wpa_set_wep_keys(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid);
687 int wpa_supplicant_reload_configuration(struct wpa_supplicant *wpa_s);
689 const char * wpa_supplicant_state_txt(enum wpa_states state);
690 int wpa_supplicant_update_mac_addr(struct wpa_supplicant *wpa_s);
691 int wpa_supplicant_driver_init(struct wpa_supplicant *wpa_s);
692 int wpa_supplicant_set_suites(struct wpa_supplicant *wpa_s,
693 struct wpa_bss *bss, struct wpa_ssid *ssid,
694 u8 *wpa_ie, size_t *wpa_ie_len);
695 void wpa_supplicant_associate(struct wpa_supplicant *wpa_s,
697 struct wpa_ssid *ssid);
698 void wpa_supplicant_set_non_wpa_policy(struct wpa_supplicant *wpa_s,
699 struct wpa_ssid *ssid);
700 void wpa_supplicant_initiate_eapol(struct wpa_supplicant *wpa_s);
701 void wpa_clear_keys(struct wpa_supplicant *wpa_s, const u8 *addr);
702 void wpa_supplicant_req_auth_timeout(struct wpa_supplicant *wpa_s,
704 void wpa_supplicant_reinit_autoscan(struct wpa_supplicant *wpa_s);
705 void wpa_supplicant_set_state(struct wpa_supplicant *wpa_s,
706 enum wpa_states state);
707 struct wpa_ssid * wpa_supplicant_get_ssid(struct wpa_supplicant *wpa_s);
708 const char * wpa_supplicant_get_eap_mode(struct wpa_supplicant *wpa_s);
709 void wpa_supplicant_cancel_auth_timeout(struct wpa_supplicant *wpa_s);
710 void wpa_supplicant_deauthenticate(struct wpa_supplicant *wpa_s,
713 void wpa_supplicant_enable_network(struct wpa_supplicant *wpa_s,
714 struct wpa_ssid *ssid);
715 void wpa_supplicant_disable_network(struct wpa_supplicant *wpa_s,
716 struct wpa_ssid *ssid);
717 void wpa_supplicant_select_network(struct wpa_supplicant *wpa_s,
718 struct wpa_ssid *ssid);
719 int wpa_supplicant_set_ap_scan(struct wpa_supplicant *wpa_s,
721 int wpa_supplicant_set_bss_expiration_age(struct wpa_supplicant *wpa_s,
722 unsigned int expire_age);
723 int wpa_supplicant_set_bss_expiration_count(struct wpa_supplicant *wpa_s,
724 unsigned int expire_count);
725 int wpa_supplicant_set_scan_interval(struct wpa_supplicant *wpa_s,
727 int wpa_supplicant_set_debug_params(struct wpa_global *global,
728 int debug_level, int debug_timestamp,
729 int debug_show_keys);
730 void free_hw_features(struct wpa_supplicant *wpa_s);
732 void wpa_show_license(void);
734 struct wpa_supplicant * wpa_supplicant_add_iface(struct wpa_global *global,
735 struct wpa_interface *iface);
736 int wpa_supplicant_remove_iface(struct wpa_global *global,
737 struct wpa_supplicant *wpa_s,
739 struct wpa_supplicant * wpa_supplicant_get_iface(struct wpa_global *global,
741 struct wpa_global * wpa_supplicant_init(struct wpa_params *params);
742 int wpa_supplicant_run(struct wpa_global *global);
743 void wpa_supplicant_deinit(struct wpa_global *global);
745 int wpa_supplicant_scard_init(struct wpa_supplicant *wpa_s,
746 struct wpa_ssid *ssid);
747 void wpa_supplicant_terminate_proc(struct wpa_global *global);
748 void wpa_supplicant_rx_eapol(void *ctx, const u8 *src_addr,
749 const u8 *buf, size_t len);
750 enum wpa_key_mgmt key_mgmt2driver(int key_mgmt);
751 void wpa_supplicant_update_config(struct wpa_supplicant *wpa_s);
752 void wpa_supplicant_clear_status(struct wpa_supplicant *wpa_s);
753 void wpas_connection_failed(struct wpa_supplicant *wpa_s, const u8 *bssid);
754 int wpas_driver_bss_selection(struct wpa_supplicant *wpa_s);
755 int wpas_is_p2p_prioritized(struct wpa_supplicant *wpa_s);
756 void wpas_auth_failed(struct wpa_supplicant *wpa_s);
757 void wpas_clear_temp_disabled(struct wpa_supplicant *wpa_s,
758 struct wpa_ssid *ssid, int clear_failures);
759 int disallowed_bssid(struct wpa_supplicant *wpa_s, const u8 *bssid);
760 int disallowed_ssid(struct wpa_supplicant *wpa_s, const u8 *ssid,
762 void wpas_request_connection(struct wpa_supplicant *wpa_s);
763 int wpas_build_ext_capab(struct wpa_supplicant *wpa_s, u8 *buf);
766 * wpa_supplicant_ctrl_iface_ctrl_rsp_handle - Handle a control response
767 * @wpa_s: Pointer to wpa_supplicant data
768 * @ssid: Pointer to the network block the reply is for
769 * @field: field the response is a reply for
770 * @value: value (ie, password, etc) for @field
771 * Returns: 0 on success, non-zero on error
773 * Helper function to handle replies to control interface requests.
775 int wpa_supplicant_ctrl_iface_ctrl_rsp_handle(struct wpa_supplicant *wpa_s,
776 struct wpa_ssid *ssid,
781 void wpa_supplicant_mark_disassoc(struct wpa_supplicant *wpa_s);
782 int wpa_supplicant_connect(struct wpa_supplicant *wpa_s,
783 struct wpa_bss *selected,
784 struct wpa_ssid *ssid);
785 void wpa_supplicant_stop_countermeasures(void *eloop_ctx, void *sock_ctx);
786 void wpa_supplicant_delayed_mic_error_report(void *eloop_ctx, void *sock_ctx);
787 void wnm_bss_keep_alive_deinit(struct wpa_supplicant *wpa_s);
788 int wpa_supplicant_fast_associate(struct wpa_supplicant *wpa_s);
791 int eap_register_methods(void);
794 * Utility method to tell if a given network is a persistent group
795 * @ssid: Network object
796 * Returns: 1 if network is a persistent group, 0 otherwise
798 static inline int network_is_persistent_group(struct wpa_ssid *ssid)
800 return ((ssid->disabled == 2) || ssid->p2p_persistent_group);
803 int wpas_network_disabled(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid);
805 int wpas_init_ext_pw(struct wpa_supplicant *wpa_s);
807 #endif /* WPA_SUPPLICANT_I_H */