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 "config_ssid.h"
16 extern const char *wpa_supplicant_version;
17 extern const char *wpa_supplicant_license;
18 #ifndef CONFIG_NO_STDOUT_DEBUG
19 extern const char *wpa_supplicant_full_license1;
20 extern const char *wpa_supplicant_full_license2;
21 extern const char *wpa_supplicant_full_license3;
22 extern const char *wpa_supplicant_full_license4;
23 extern const char *wpa_supplicant_full_license5;
24 #endif /* CONFIG_NO_STDOUT_DEBUG */
27 struct wpa_supplicant;
31 struct wpa_scan_results;
32 struct hostapd_hw_modes;
33 struct wpa_driver_associate_params;
36 * Forward declarations of private structures used within the ctrl_iface
37 * backends. Other parts of wpa_supplicant do not have access to data stored in
40 struct ctrl_iface_priv;
41 struct ctrl_iface_global_priv;
42 struct wpas_dbus_priv;
45 * struct wpa_interface - Parameters for wpa_supplicant_add_iface()
47 struct wpa_interface {
49 * confname - Configuration name (file or profile) name
51 * This can also be %NULL when a configuration file is not used. In
52 * that case, ctrl_interface must be set to allow the interface to be
58 * ctrl_interface - Control interface parameter
60 * If a configuration file is not used, this variable can be used to
61 * set the ctrl_interface parameter that would have otherwise been read
62 * from the configuration file. If both confname and ctrl_interface are
63 * set, ctrl_interface is used to override the value from configuration
66 const char *ctrl_interface;
69 * driver - Driver interface name, or %NULL to use the default driver
74 * driver_param - Driver interface parameters
76 * If a configuration file is not used, this variable can be used to
77 * set the driver_param parameters that would have otherwise been read
78 * from the configuration file. If both confname and driver_param are
79 * set, driver_param is used to override the value from configuration
82 const char *driver_param;
85 * ifname - Interface name
90 * bridge_ifname - Optional bridge interface name
92 * If the driver interface (ifname) is included in a Linux bridge
93 * device, the bridge interface may need to be used for receiving EAPOL
94 * frames. This can be enabled by setting this variable to enable
95 * receiving of EAPOL frames from an additional interface.
97 const char *bridge_ifname;
101 * struct wpa_params - Parameters for wpa_supplicant_init()
105 * daemonize - Run %wpa_supplicant in the background
110 * wait_for_monitor - Wait for a monitor program before starting
112 int wait_for_monitor;
115 * pid_file - Path to a PID (process ID) file
117 * If this and daemonize are set, process ID of the background process
118 * will be written to the specified file.
123 * wpa_debug_level - Debugging verbosity level (e.g., MSG_INFO)
128 * wpa_debug_show_keys - Whether keying material is included in debug
130 * This parameter can be used to allow keying material to be included
131 * in debug messages. This is a security risk and this option should
132 * not be enabled in normal configuration. If needed during
133 * development or while troubleshooting, this option can provide more
134 * details for figuring out what is happening.
136 int wpa_debug_show_keys;
139 * wpa_debug_timestamp - Whether to include timestamp in debug messages
141 int wpa_debug_timestamp;
144 * ctrl_interface - Global ctrl_iface path/parameter
146 char *ctrl_interface;
149 * dbus_ctrl_interface - Enable the DBus control interface
151 int dbus_ctrl_interface;
154 * wpa_debug_file_path - Path of debug file or %NULL to use stdout
156 const char *wpa_debug_file_path;
159 * wpa_debug_syslog - Enable log output through syslog
161 int wpa_debug_syslog;
164 * wpa_debug_tracing - Enable log output through Linux tracing
166 int wpa_debug_tracing;
169 * override_driver - Optional driver parameter override
171 * This parameter can be used to override the driver parameter in
172 * dynamic interface addition to force a specific driver wrapper to be
175 char *override_driver;
178 * override_ctrl_interface - Optional ctrl_interface override
180 * This parameter can be used to override the ctrl_interface parameter
181 * in dynamic interface addition to force a control interface to be
184 char *override_ctrl_interface;
187 * entropy_file - Optional entropy file
189 * This parameter can be used to configure wpa_supplicant to maintain
190 * its internal entropy store over restarts.
195 struct p2p_srv_bonjour {
197 struct wpabuf *query;
201 struct p2p_srv_upnp {
207 struct wpa_freq_range {
214 * struct wpa_global - Internal, global data for all %wpa_supplicant interfaces
216 * This structure is initialized by calling wpa_supplicant_init() when starting
220 struct wpa_supplicant *ifaces;
221 struct wpa_params params;
222 struct ctrl_iface_global_priv *ctrl_iface;
223 struct wpas_dbus_priv *dbus;
226 struct os_time suspend_time;
227 struct p2p_data *p2p;
228 struct wpa_supplicant *p2p_init_wpa_s;
229 struct wpa_supplicant *p2p_group_formation;
230 u8 p2p_dev_addr[ETH_ALEN];
231 struct dl_list p2p_srv_bonjour; /* struct p2p_srv_bonjour */
232 struct dl_list p2p_srv_upnp; /* struct p2p_srv_upnp */
234 int cross_connection;
235 struct wpa_freq_range *p2p_disallow_freq;
236 unsigned int num_p2p_disallow_freq;
238 WPA_CONC_PREF_NOT_SET,
242 unsigned int p2p_cb_on_scan_complete:1;
244 #ifdef CONFIG_WIFI_DISPLAY
246 #define MAX_WFD_SUBELEMS 10
247 struct wpabuf *wfd_subelem[MAX_WFD_SUBELEMS];
248 #endif /* CONFIG_WIFI_DISPLAY */
253 * offchannel_send_action_result - Result of offchannel send Action frame
255 enum offchannel_send_action_result {
256 OFFCHANNEL_SEND_ACTION_SUCCESS /**< Frame was send and acknowledged */,
257 OFFCHANNEL_SEND_ACTION_NO_ACK /**< Frame was sent, but not acknowledged
259 OFFCHANNEL_SEND_ACTION_FAILED /**< Frame was not sent due to a failure
265 enum wps_ap_info_type {
271 struct os_time last_attempt;
274 struct wpa_ssid_value {
280 * struct wpa_supplicant - Internal data for wpa_supplicant interface
282 * This structure contains the internal data for core wpa_supplicant code. This
283 * should be only used directly from the core code. However, a pointer to this
284 * data is used from other files as an arbitrary context pointer in calls to
287 struct wpa_supplicant {
288 struct wpa_global *global;
289 struct wpa_supplicant *parent;
290 struct wpa_supplicant *next;
291 struct l2_packet_data *l2;
292 struct l2_packet_data *l2_br;
293 unsigned char own_addr[ETH_ALEN];
295 #ifdef CONFIG_CTRL_IFACE_DBUS
297 #endif /* CONFIG_CTRL_IFACE_DBUS */
298 #ifdef CONFIG_CTRL_IFACE_DBUS_NEW
300 char *dbus_groupobj_path;
302 char *preq_notify_peer;
303 #endif /* CONFIG_AP */
304 #endif /* CONFIG_CTRL_IFACE_DBUS_NEW */
305 char bridge_ifname[16];
308 struct wpa_config *conf;
310 os_time_t last_michael_mic_error;
312 u8 pending_bssid[ETH_ALEN]; /* If wpa_state == WPA_ASSOCIATING, this
313 * field contains the target BSSID. */
314 int reassociate; /* reassociation requested */
315 int disconnected; /* all connections disabled; i.e., do no reassociate
316 * before this has been cleared */
317 struct wpa_ssid *current_ssid;
318 struct wpa_bss *current_bss;
319 int ap_ies_from_associnfo;
320 unsigned int assoc_freq;
322 /* Selected configuration (based on Beacon/ProbeResp WPA IE) */
327 int mgmt_group_cipher;
329 void *drv_priv; /* private data used by driver_ops */
330 void *global_drv_priv;
333 size_t bssid_filter_count;
335 u8 *disallow_aps_bssid;
336 size_t disallow_aps_bssid_count;
337 struct wpa_ssid_value *disallow_aps_ssid;
338 size_t disallow_aps_ssid_count;
340 /* previous scan was wildcard when interleaving between
341 * wildcard scans and specific SSID scan when max_ssids=1 */
342 int prev_scan_wildcard;
343 struct wpa_ssid *prev_scan_ssid; /* previously scanned SSID;
344 * NULL = not yet initialized (start
345 * with wildcard SSID)
346 * WILDCARD_SSID_SCAN = wildcard
347 * SSID was used in the previous scan
349 #define WILDCARD_SSID_SCAN ((struct wpa_ssid *) 1)
351 struct wpa_ssid *prev_sched_ssid; /* last SSID used in sched scan */
352 int sched_scan_timeout;
353 int sched_scan_interval;
354 int first_sched_scan;
355 int sched_scan_timed_out;
357 void (*scan_res_handler)(struct wpa_supplicant *wpa_s,
358 struct wpa_scan_results *scan_res);
359 struct dl_list bss; /* struct wpa_bss::list */
360 struct dl_list bss_id; /* struct wpa_bss::list_id */
362 unsigned int bss_update_idx;
363 unsigned int bss_next_id;
366 * Pointers to BSS entries in the order they were in the last scan
369 struct wpa_bss **last_scan_res;
370 unsigned int last_scan_res_used;
371 unsigned int last_scan_res_size;
373 struct os_time last_scan;
375 struct wpa_driver_ops *driver;
376 int interface_removed; /* whether the network interface has been
379 struct eapol_sm *eapol;
381 struct ctrl_iface_priv *ctrl_iface;
383 enum wpa_states wpa_state;
388 int eapol_received; /* number of EAPOL packets received after the
389 * previous association event */
391 struct scard_data *scard;
395 #endif /* PCSC_FUNCS */
397 unsigned char last_eapol_src[ETH_ALEN];
401 struct wpa_blacklist *blacklist;
404 * extra_blacklist_count - Sum of blacklist counts after last connection
406 * This variable is used to maintain a count of temporary blacklisting
407 * failures (maximum number for any BSS) over blacklist clear
408 * operations. This is needed for figuring out whether there has been
409 * failures prior to the last blacklist clear operation which happens
410 * whenever no other not-blacklisted BSS candidates are available. This
411 * gets cleared whenever a connection has been established successfully.
413 int extra_blacklist_count;
416 * scan_req - Type of the scan request
420 * NORMAL_SCAN_REQ - Normal scan request
422 * This is used for scans initiated by wpa_supplicant to find an
423 * AP for a connection.
428 * INITIAL_SCAN_REQ - Initial scan request
430 * This is used for the first scan on an interface to force at
431 * least one scan to be run even if the configuration does not
432 * include any enabled networks.
437 * MANUAL_SCAN_REQ - Manual scan request
439 * This is used for scans where the user request a scan or
440 * a specific wpa_supplicant operation (e.g., WPS) requires scan
445 int scan_runs; /* number of scan runs since WPS was started */
446 int *next_scan_freqs;
447 int scan_interval; /* time in sec between scans to find suitable AP */
448 int normal_scans; /* normal scans run before sched_scan */
449 int scan_for_connection; /* whether the scan request was triggered for
450 * finding a connection */
452 unsigned int drv_flags;
453 unsigned int drv_enc;
456 * A bitmap of supported protocols for probe response offload. See
457 * struct wpa_driver_capa in driver.h
459 unsigned int probe_resp_offloads;
462 int max_sched_scan_ssids;
463 int sched_scan_supported;
464 unsigned int max_match_sets;
465 unsigned int max_remain_on_chan;
466 unsigned int max_stations;
468 int pending_mic_error_report;
469 int pending_mic_error_pairwise;
470 int mic_errors_seen; /* Michael MIC errors with the current PTK */
472 struct wps_context *wps;
473 int wps_success; /* WPS success event received */
474 struct wps_er *wps_er;
475 int blacklist_cleared;
477 struct wpabuf *pending_eapol_rx;
478 struct os_time pending_eapol_rx_time;
479 u8 pending_eapol_rx_src[ETH_ALEN];
480 unsigned int last_eapol_matches_bssid:1;
481 unsigned int wnmsleep_used: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;
522 u16 sae_send_confirm;
524 #endif /* CONFIG_SME */
527 struct hostapd_iface *ap_iface;
528 void (*ap_configured_cb)(void *ctx, void *data);
529 void *ap_configured_cb_ctx;
530 void *ap_configured_cb_data;
531 #endif /* CONFIG_AP */
533 unsigned int off_channel_freq;
534 struct wpabuf *pending_action_tx;
535 u8 pending_action_src[ETH_ALEN];
536 u8 pending_action_dst[ETH_ALEN];
537 u8 pending_action_bssid[ETH_ALEN];
538 unsigned int pending_action_freq;
539 int pending_action_no_cck;
540 int pending_action_without_roc;
541 void (*pending_action_tx_status_cb)(struct wpa_supplicant *wpa_s,
542 unsigned int freq, const u8 *dst,
543 const u8 *src, const u8 *bssid,
544 const u8 *data, size_t data_len,
545 enum offchannel_send_action_result
547 unsigned int roc_waiting_drv_freq;
548 int action_tx_wait_time;
551 struct p2p_go_neg_results *go_params;
552 int create_p2p_iface;
553 u8 pending_interface_addr[ETH_ALEN];
554 char pending_interface_name[100];
555 int pending_interface_type;
557 unsigned int pending_listen_freq;
558 unsigned int pending_listen_duration;
560 NOT_P2P_GROUP_INTERFACE,
561 P2P_GROUP_INTERFACE_PENDING,
562 P2P_GROUP_INTERFACE_GO,
563 P2P_GROUP_INTERFACE_CLIENT
564 } p2p_group_interface;
565 struct p2p_group *p2p_group;
566 int p2p_long_listen; /* remaining time in long Listen state in ms */
569 u8 p2p_auth_invite[ETH_ALEN];
570 int p2p_sd_over_ctrl_iface;
571 int p2p_in_provisioning;
572 int pending_invite_ssid_id;
573 int show_group_started;
574 u8 go_dev_addr[ETH_ALEN];
575 int pending_pd_before_join;
576 u8 pending_join_iface_addr[ETH_ALEN];
577 u8 pending_join_dev_addr[ETH_ALEN];
578 int pending_join_wps_method;
579 int p2p_join_scan_count;
580 int auto_pd_scan_retry;
582 u16 pending_pd_config_methods;
584 NORMAL_PD, AUTO_PD_GO_NEG, AUTO_PD_JOIN
588 * Whether cross connection is disallowed by the AP to which this
589 * interface is associated (only valid if there is an association).
591 int cross_connect_disallowed;
594 * Whether this P2P group is configured to use cross connection (only
595 * valid if this is P2P GO interface). The actual cross connect packet
596 * forwarding may not be configured depending on the uplink status.
598 int cross_connect_enabled;
600 /* Whether cross connection forwarding is in use at the moment. */
601 int cross_connect_in_use;
604 * Uplink interface name for cross connection
606 char cross_connect_uplink[100];
608 unsigned int sta_scan_pending:1;
609 unsigned int p2p_auto_join:1;
610 unsigned int p2p_auto_pd:1;
611 unsigned int p2p_persistent_group:1;
612 unsigned int p2p_fallback_to_go_neg:1;
613 unsigned int p2p_pd_before_go_neg:1;
614 unsigned int p2p_go_ht40:1;
615 unsigned int user_initiated_pd:1;
616 int p2p_persistent_go_freq;
617 int p2p_persistent_id;
619 int p2p_connect_freq;
620 struct os_time p2p_auto_started;
621 #endif /* CONFIG_P2P */
623 struct wpa_ssid *bgscan_ssid;
624 const struct bgscan_ops *bgscan;
627 const struct autoscan_ops *autoscan;
628 struct wpa_driver_scan_params *autoscan_params;
631 struct wpa_ssid *connect_without_scan;
633 struct wps_ap_info *wps_ap;
639 unsigned int wps_freq;
641 int wps_fragment_size;
642 int auto_reconnect_disabled;
644 /* Channel preferences for AP/P2P GO use */
647 int best_overall_freq;
649 struct gas_query *gas;
651 #ifdef CONFIG_INTERWORKING
652 unsigned int fetch_anqp_in_progress:1;
653 unsigned int network_select:1;
654 unsigned int auto_select:1;
655 unsigned int auto_network_select:1;
656 unsigned int fetch_all_anqp:1;
657 #endif /* CONFIG_INTERWORKING */
658 unsigned int drv_capa_known;
661 struct hostapd_hw_modes *modes;
668 /* WLAN_REASON_* reason codes. Negative if locally generated. */
669 int disconnect_reason;
671 struct ext_password_data *ext_pw;
673 struct wpabuf *last_gas_resp;
674 u8 last_gas_addr[ETH_ALEN];
675 u8 last_gas_dialog_token;
677 unsigned int no_keep_alive:1;
681 /* wpa_supplicant.c */
682 void wpa_supplicant_apply_ht_overrides(
683 struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid,
684 struct wpa_driver_associate_params *params);
686 int wpa_set_wep_keys(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid);
688 int wpa_supplicant_reload_configuration(struct wpa_supplicant *wpa_s);
690 const char * wpa_supplicant_state_txt(enum wpa_states state);
691 int wpa_supplicant_update_mac_addr(struct wpa_supplicant *wpa_s);
692 int wpa_supplicant_driver_init(struct wpa_supplicant *wpa_s);
693 int wpa_supplicant_set_suites(struct wpa_supplicant *wpa_s,
694 struct wpa_bss *bss, struct wpa_ssid *ssid,
695 u8 *wpa_ie, size_t *wpa_ie_len);
696 void wpa_supplicant_associate(struct wpa_supplicant *wpa_s,
698 struct wpa_ssid *ssid);
699 void wpa_supplicant_set_non_wpa_policy(struct wpa_supplicant *wpa_s,
700 struct wpa_ssid *ssid);
701 void wpa_supplicant_initiate_eapol(struct wpa_supplicant *wpa_s);
702 void wpa_clear_keys(struct wpa_supplicant *wpa_s, const u8 *addr);
703 void wpa_supplicant_req_auth_timeout(struct wpa_supplicant *wpa_s,
705 void wpa_supplicant_reinit_autoscan(struct wpa_supplicant *wpa_s);
706 void wpa_supplicant_set_state(struct wpa_supplicant *wpa_s,
707 enum wpa_states state);
708 struct wpa_ssid * wpa_supplicant_get_ssid(struct wpa_supplicant *wpa_s);
709 const char * wpa_supplicant_get_eap_mode(struct wpa_supplicant *wpa_s);
710 void wpa_supplicant_cancel_auth_timeout(struct wpa_supplicant *wpa_s);
711 void wpa_supplicant_deauthenticate(struct wpa_supplicant *wpa_s,
714 void wpa_supplicant_enable_network(struct wpa_supplicant *wpa_s,
715 struct wpa_ssid *ssid);
716 void wpa_supplicant_disable_network(struct wpa_supplicant *wpa_s,
717 struct wpa_ssid *ssid);
718 void wpa_supplicant_select_network(struct wpa_supplicant *wpa_s,
719 struct wpa_ssid *ssid);
720 int wpa_supplicant_set_ap_scan(struct wpa_supplicant *wpa_s,
722 int wpa_supplicant_set_bss_expiration_age(struct wpa_supplicant *wpa_s,
723 unsigned int expire_age);
724 int wpa_supplicant_set_bss_expiration_count(struct wpa_supplicant *wpa_s,
725 unsigned int expire_count);
726 int wpa_supplicant_set_scan_interval(struct wpa_supplicant *wpa_s,
728 int wpa_supplicant_set_debug_params(struct wpa_global *global,
729 int debug_level, int debug_timestamp,
730 int debug_show_keys);
731 void free_hw_features(struct wpa_supplicant *wpa_s);
733 void wpa_show_license(void);
735 struct wpa_supplicant * wpa_supplicant_add_iface(struct wpa_global *global,
736 struct wpa_interface *iface);
737 int wpa_supplicant_remove_iface(struct wpa_global *global,
738 struct wpa_supplicant *wpa_s,
740 struct wpa_supplicant * wpa_supplicant_get_iface(struct wpa_global *global,
742 struct wpa_global * wpa_supplicant_init(struct wpa_params *params);
743 int wpa_supplicant_run(struct wpa_global *global);
744 void wpa_supplicant_deinit(struct wpa_global *global);
746 int wpa_supplicant_scard_init(struct wpa_supplicant *wpa_s,
747 struct wpa_ssid *ssid);
748 void wpa_supplicant_terminate_proc(struct wpa_global *global);
749 void wpa_supplicant_rx_eapol(void *ctx, const u8 *src_addr,
750 const u8 *buf, size_t len);
751 enum wpa_key_mgmt key_mgmt2driver(int key_mgmt);
752 enum wpa_cipher cipher_suite2driver(int cipher);
753 void wpa_supplicant_update_config(struct wpa_supplicant *wpa_s);
754 void wpa_supplicant_clear_status(struct wpa_supplicant *wpa_s);
755 void wpas_connection_failed(struct wpa_supplicant *wpa_s, const u8 *bssid);
756 int wpas_driver_bss_selection(struct wpa_supplicant *wpa_s);
757 int wpas_is_p2p_prioritized(struct wpa_supplicant *wpa_s);
758 void wpas_auth_failed(struct wpa_supplicant *wpa_s);
759 void wpas_clear_temp_disabled(struct wpa_supplicant *wpa_s,
760 struct wpa_ssid *ssid, int clear_failures);
761 int disallowed_bssid(struct wpa_supplicant *wpa_s, const u8 *bssid);
762 int disallowed_ssid(struct wpa_supplicant *wpa_s, const u8 *ssid,
764 void wpas_request_connection(struct wpa_supplicant *wpa_s);
765 int wpas_build_ext_capab(struct wpa_supplicant *wpa_s, u8 *buf);
768 * wpa_supplicant_ctrl_iface_ctrl_rsp_handle - Handle a control response
769 * @wpa_s: Pointer to wpa_supplicant data
770 * @ssid: Pointer to the network block the reply is for
771 * @field: field the response is a reply for
772 * @value: value (ie, password, etc) for @field
773 * Returns: 0 on success, non-zero on error
775 * Helper function to handle replies to control interface requests.
777 int wpa_supplicant_ctrl_iface_ctrl_rsp_handle(struct wpa_supplicant *wpa_s,
778 struct wpa_ssid *ssid,
783 void wpa_supplicant_mark_disassoc(struct wpa_supplicant *wpa_s);
784 int wpa_supplicant_connect(struct wpa_supplicant *wpa_s,
785 struct wpa_bss *selected,
786 struct wpa_ssid *ssid);
787 void wpa_supplicant_stop_countermeasures(void *eloop_ctx, void *sock_ctx);
788 void wpa_supplicant_delayed_mic_error_report(void *eloop_ctx, void *sock_ctx);
789 void wnm_bss_keep_alive_deinit(struct wpa_supplicant *wpa_s);
790 int wpas_select_network_from_last_scan(struct wpa_supplicant *wpa_s);
793 int eap_register_methods(void);
796 * Utility method to tell if a given network is a persistent group
797 * @ssid: Network object
798 * Returns: 1 if network is a persistent group, 0 otherwise
800 static inline int network_is_persistent_group(struct wpa_ssid *ssid)
802 return ((ssid->disabled == 2) || ssid->p2p_persistent_group);
805 int wpas_network_disabled(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid);
807 int wpas_init_ext_pw(struct wpa_supplicant *wpa_s);
809 #endif /* WPA_SUPPLICANT_I_H */