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,
243 #ifdef CONFIG_WIFI_DISPLAY
245 #define MAX_WFD_SUBELEMS 10
246 struct wpabuf *wfd_subelem[MAX_WFD_SUBELEMS];
247 #endif /* CONFIG_WIFI_DISPLAY */
251 enum offchannel_send_action_result {
252 OFFCHANNEL_SEND_ACTION_SUCCESS /* Frame was send and acknowledged */,
253 OFFCHANNEL_SEND_ACTION_NO_ACK /* Frame was sent, but not acknowledged
255 OFFCHANNEL_SEND_ACTION_FAILED /* Frame was not sent due to a failure */
260 enum wps_ap_info_type {
266 struct os_time last_attempt;
270 * struct wpa_supplicant - Internal data for wpa_supplicant interface
272 * This structure contains the internal data for core wpa_supplicant code. This
273 * should be only used directly from the core code. However, a pointer to this
274 * data is used from other files as an arbitrary context pointer in calls to
277 struct wpa_supplicant {
278 struct wpa_global *global;
279 struct wpa_supplicant *parent;
280 struct wpa_supplicant *next;
281 struct l2_packet_data *l2;
282 struct l2_packet_data *l2_br;
283 unsigned char own_addr[ETH_ALEN];
285 #ifdef CONFIG_CTRL_IFACE_DBUS
287 #endif /* CONFIG_CTRL_IFACE_DBUS */
288 #ifdef CONFIG_CTRL_IFACE_DBUS_NEW
290 char *dbus_groupobj_path;
292 char *preq_notify_peer;
293 #endif /* CONFIG_AP */
294 #endif /* CONFIG_CTRL_IFACE_DBUS_NEW */
295 char bridge_ifname[16];
298 struct wpa_config *conf;
300 os_time_t last_michael_mic_error;
302 u8 pending_bssid[ETH_ALEN]; /* If wpa_state == WPA_ASSOCIATING, this
303 * field contains the target BSSID. */
304 int reassociate; /* reassociation requested */
305 int disconnected; /* all connections disabled; i.e., do no reassociate
306 * before this has been cleared */
307 struct wpa_ssid *current_ssid;
308 struct wpa_bss *current_bss;
309 int ap_ies_from_associnfo;
310 unsigned int assoc_freq;
312 /* Selected configuration (based on Beacon/ProbeResp WPA IE) */
317 int mgmt_group_cipher;
319 void *drv_priv; /* private data used by driver_ops */
320 void *global_drv_priv;
323 size_t bssid_filter_count;
325 /* previous scan was wildcard when interleaving between
326 * wildcard scans and specific SSID scan when max_ssids=1 */
327 int prev_scan_wildcard;
328 struct wpa_ssid *prev_scan_ssid; /* previously scanned SSID;
329 * NULL = not yet initialized (start
330 * with wildcard SSID)
331 * WILDCARD_SSID_SCAN = wildcard
332 * SSID was used in the previous scan
334 #define WILDCARD_SSID_SCAN ((struct wpa_ssid *) 1)
336 struct wpa_ssid *prev_sched_ssid; /* last SSID used in sched scan */
337 int sched_scan_timeout;
338 int sched_scan_interval;
339 int first_sched_scan;
340 int sched_scan_timed_out;
342 void (*scan_res_handler)(struct wpa_supplicant *wpa_s,
343 struct wpa_scan_results *scan_res);
344 struct dl_list bss; /* struct wpa_bss::list */
345 struct dl_list bss_id; /* struct wpa_bss::list_id */
347 unsigned int bss_update_idx;
348 unsigned int bss_next_id;
351 * Pointers to BSS entries in the order they were in the last scan
354 struct wpa_bss **last_scan_res;
355 unsigned int last_scan_res_used;
356 unsigned int last_scan_res_size;
358 struct os_time last_scan;
360 struct wpa_driver_ops *driver;
361 int interface_removed; /* whether the network interface has been
364 struct eapol_sm *eapol;
366 struct ctrl_iface_priv *ctrl_iface;
368 enum wpa_states wpa_state;
372 int reassociated_connection;
374 int eapol_received; /* number of EAPOL packets received after the
375 * previous association event */
377 struct scard_data *scard;
381 #endif /* PCSC_FUNCS */
383 unsigned char last_eapol_src[ETH_ALEN];
387 struct wpa_blacklist *blacklist;
389 int scan_req; /* manual scan request; this forces a scan even if there
390 * are no enabled networks in the configuration */
391 int scan_runs; /* number of scan runs since WPS was started */
392 int *next_scan_freqs;
393 int scan_interval; /* time in sec between scans to find suitable AP */
394 int normal_scans; /* normal scans run before sched_scan */
396 unsigned int drv_flags;
397 unsigned int drv_enc;
400 * A bitmap of supported protocols for probe response offload. See
401 * struct wpa_driver_capa in driver.h
403 unsigned int probe_resp_offloads;
406 int max_sched_scan_ssids;
407 int sched_scan_supported;
408 unsigned int max_match_sets;
409 unsigned int max_remain_on_chan;
410 unsigned int max_stations;
412 int pending_mic_error_report;
413 int pending_mic_error_pairwise;
414 int mic_errors_seen; /* Michael MIC errors with the current PTK */
416 struct wps_context *wps;
417 int wps_success; /* WPS success event received */
418 struct wps_er *wps_er;
419 int blacklist_cleared;
421 struct wpabuf *pending_eapol_rx;
422 struct os_time pending_eapol_rx_time;
423 u8 pending_eapol_rx_src[ETH_ALEN];
425 struct ibss_rsn *ibss_rsn;
437 u8 assoc_req_ie[200];
438 size_t assoc_req_ie_len;
441 u8 mobility_domain[2];
444 u8 prev_bssid[ETH_ALEN];
449 int sa_query_count; /* number of pending SA Query requests;
450 * 0 = no SA Query in progress */
451 int sa_query_timed_out;
452 u8 *sa_query_trans_id; /* buffer of WLAN_SA_QUERY_TR_ID_LEN *
453 * sa_query_count octets of pending
454 * SA Query transaction identifiers */
455 struct os_time sa_query_start;
458 u16 bss_max_idle_period;
460 #endif /* CONFIG_SME */
463 struct hostapd_iface *ap_iface;
464 void (*ap_configured_cb)(void *ctx, void *data);
465 void *ap_configured_cb_ctx;
466 void *ap_configured_cb_data;
467 #endif /* CONFIG_AP */
469 unsigned int off_channel_freq;
470 struct wpabuf *pending_action_tx;
471 u8 pending_action_src[ETH_ALEN];
472 u8 pending_action_dst[ETH_ALEN];
473 u8 pending_action_bssid[ETH_ALEN];
474 unsigned int pending_action_freq;
475 int pending_action_no_cck;
476 int pending_action_without_roc;
477 void (*pending_action_tx_status_cb)(struct wpa_supplicant *wpa_s,
478 unsigned int freq, const u8 *dst,
479 const u8 *src, const u8 *bssid,
480 const u8 *data, size_t data_len,
481 enum offchannel_send_action_result
483 unsigned int roc_waiting_drv_freq;
484 int action_tx_wait_time;
487 struct p2p_go_neg_results *go_params;
488 int create_p2p_iface;
489 u8 pending_interface_addr[ETH_ALEN];
490 char pending_interface_name[100];
491 int pending_interface_type;
493 unsigned int pending_listen_freq;
494 unsigned int pending_listen_duration;
496 NOT_P2P_GROUP_INTERFACE,
497 P2P_GROUP_INTERFACE_PENDING,
498 P2P_GROUP_INTERFACE_GO,
499 P2P_GROUP_INTERFACE_CLIENT
500 } p2p_group_interface;
501 struct p2p_group *p2p_group;
502 int p2p_long_listen; /* remaining time in long Listen state in ms */
505 u8 p2p_auth_invite[ETH_ALEN];
506 int p2p_sd_over_ctrl_iface;
507 int p2p_in_provisioning;
508 int pending_invite_ssid_id;
509 int show_group_started;
510 u8 go_dev_addr[ETH_ALEN];
511 int pending_pd_before_join;
512 u8 pending_join_iface_addr[ETH_ALEN];
513 u8 pending_join_dev_addr[ETH_ALEN];
514 int pending_join_wps_method;
515 int p2p_join_scan_count;
516 int auto_pd_scan_retry;
518 u16 pending_pd_config_methods;
520 NORMAL_PD, AUTO_PD_GO_NEG, AUTO_PD_JOIN
524 * Whether cross connection is disallowed by the AP to which this
525 * interface is associated (only valid if there is an association).
527 int cross_connect_disallowed;
530 * Whether this P2P group is configured to use cross connection (only
531 * valid if this is P2P GO interface). The actual cross connect packet
532 * forwarding may not be configured depending on the uplink status.
534 int cross_connect_enabled;
536 /* Whether cross connection forwarding is in use at the moment. */
537 int cross_connect_in_use;
540 * Uplink interface name for cross connection
542 char cross_connect_uplink[100];
544 unsigned int p2p_cb_on_scan_complete:1;
545 unsigned int sta_scan_pending:1;
546 unsigned int p2p_auto_join:1;
547 unsigned int p2p_auto_pd:1;
548 unsigned int p2p_persistent_group:1;
549 unsigned int p2p_fallback_to_go_neg:1;
550 unsigned int p2p_pd_before_go_neg:1;
551 unsigned int p2p_go_ht40:1;
552 int p2p_persistent_go_freq;
553 int p2p_persistent_id;
555 int p2p_connect_freq;
556 struct os_time p2p_auto_started;
557 #endif /* CONFIG_P2P */
559 struct wpa_ssid *bgscan_ssid;
560 const struct bgscan_ops *bgscan;
563 const struct autoscan_ops *autoscan;
564 struct wpa_driver_scan_params *autoscan_params;
567 struct wpa_ssid *connect_without_scan;
569 struct wps_ap_info *wps_ap;
575 unsigned int wps_freq;
576 int wps_fragment_size;
577 int auto_reconnect_disabled;
579 /* Channel preferences for AP/P2P GO use */
582 int best_overall_freq;
584 struct gas_query *gas;
586 #ifdef CONFIG_INTERWORKING
587 unsigned int fetch_anqp_in_progress:1;
588 unsigned int network_select:1;
589 unsigned int auto_select:1;
590 unsigned int auto_network_select:1;
591 #endif /* CONFIG_INTERWORKING */
592 unsigned int drv_capa_known;
595 struct hostapd_hw_modes *modes;
602 /* WLAN_REASON_* reason codes. Negative if locally generated. */
603 int disconnect_reason;
605 struct ext_password_data *ext_pw;
607 struct wpabuf *last_gas_resp;
608 u8 last_gas_addr[ETH_ALEN];
609 u8 last_gas_dialog_token;
613 /* wpa_supplicant.c */
614 void wpa_supplicant_apply_ht_overrides(
615 struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid,
616 struct wpa_driver_associate_params *params);
618 int wpa_set_wep_keys(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid);
620 int wpa_supplicant_reload_configuration(struct wpa_supplicant *wpa_s);
622 const char * wpa_supplicant_state_txt(enum wpa_states state);
623 int wpa_supplicant_update_mac_addr(struct wpa_supplicant *wpa_s);
624 int wpa_supplicant_driver_init(struct wpa_supplicant *wpa_s);
625 int wpa_supplicant_set_suites(struct wpa_supplicant *wpa_s,
626 struct wpa_bss *bss, struct wpa_ssid *ssid,
627 u8 *wpa_ie, size_t *wpa_ie_len);
628 void wpa_supplicant_associate(struct wpa_supplicant *wpa_s,
630 struct wpa_ssid *ssid);
631 void wpa_supplicant_set_non_wpa_policy(struct wpa_supplicant *wpa_s,
632 struct wpa_ssid *ssid);
633 void wpa_supplicant_initiate_eapol(struct wpa_supplicant *wpa_s);
634 void wpa_clear_keys(struct wpa_supplicant *wpa_s, const u8 *addr);
635 void wpa_supplicant_req_auth_timeout(struct wpa_supplicant *wpa_s,
637 void wpa_supplicant_reinit_autoscan(struct wpa_supplicant *wpa_s);
638 void wpa_supplicant_set_state(struct wpa_supplicant *wpa_s,
639 enum wpa_states state);
640 struct wpa_ssid * wpa_supplicant_get_ssid(struct wpa_supplicant *wpa_s);
641 const char * wpa_supplicant_get_eap_mode(struct wpa_supplicant *wpa_s);
642 void wpa_supplicant_cancel_auth_timeout(struct wpa_supplicant *wpa_s);
643 void wpa_supplicant_deauthenticate(struct wpa_supplicant *wpa_s,
645 void wpa_supplicant_disassociate(struct wpa_supplicant *wpa_s,
648 void wpa_supplicant_enable_network(struct wpa_supplicant *wpa_s,
649 struct wpa_ssid *ssid);
650 void wpa_supplicant_disable_network(struct wpa_supplicant *wpa_s,
651 struct wpa_ssid *ssid);
652 void wpa_supplicant_select_network(struct wpa_supplicant *wpa_s,
653 struct wpa_ssid *ssid);
654 int wpa_supplicant_set_ap_scan(struct wpa_supplicant *wpa_s,
656 int wpa_supplicant_set_bss_expiration_age(struct wpa_supplicant *wpa_s,
657 unsigned int expire_age);
658 int wpa_supplicant_set_bss_expiration_count(struct wpa_supplicant *wpa_s,
659 unsigned int expire_count);
660 int wpa_supplicant_set_scan_interval(struct wpa_supplicant *wpa_s,
662 int wpa_supplicant_set_debug_params(struct wpa_global *global,
663 int debug_level, int debug_timestamp,
664 int debug_show_keys);
665 void free_hw_features(struct wpa_supplicant *wpa_s);
667 void wpa_show_license(void);
669 struct wpa_supplicant * wpa_supplicant_add_iface(struct wpa_global *global,
670 struct wpa_interface *iface);
671 int wpa_supplicant_remove_iface(struct wpa_global *global,
672 struct wpa_supplicant *wpa_s,
674 struct wpa_supplicant * wpa_supplicant_get_iface(struct wpa_global *global,
676 struct wpa_global * wpa_supplicant_init(struct wpa_params *params);
677 int wpa_supplicant_run(struct wpa_global *global);
678 void wpa_supplicant_deinit(struct wpa_global *global);
680 int wpa_supplicant_scard_init(struct wpa_supplicant *wpa_s,
681 struct wpa_ssid *ssid);
682 void wpa_supplicant_terminate_proc(struct wpa_global *global);
683 void wpa_supplicant_rx_eapol(void *ctx, const u8 *src_addr,
684 const u8 *buf, size_t len);
685 enum wpa_key_mgmt key_mgmt2driver(int key_mgmt);
686 enum wpa_cipher cipher_suite2driver(int cipher);
687 void wpa_supplicant_update_config(struct wpa_supplicant *wpa_s);
688 void wpa_supplicant_clear_status(struct wpa_supplicant *wpa_s);
689 void wpas_connection_failed(struct wpa_supplicant *wpa_s, const u8 *bssid);
690 int wpas_driver_bss_selection(struct wpa_supplicant *wpa_s);
691 int wpas_is_p2p_prioritized(struct wpa_supplicant *wpa_s);
692 void wpas_auth_failed(struct wpa_supplicant *wpa_s);
693 void wpas_clear_temp_disabled(struct wpa_supplicant *wpa_s,
694 struct wpa_ssid *ssid, int clear_failures);
695 void wpa_supplicant_proc_40mhz_intolerant(struct wpa_supplicant *wpa_s);
698 * wpa_supplicant_ctrl_iface_ctrl_rsp_handle - Handle a control response
699 * @wpa_s: Pointer to wpa_supplicant data
700 * @ssid: Pointer to the network block the reply is for
701 * @field: field the response is a reply for
702 * @value: value (ie, password, etc) for @field
703 * Returns: 0 on success, non-zero on error
705 * Helper function to handle replies to control interface requests.
707 int wpa_supplicant_ctrl_iface_ctrl_rsp_handle(struct wpa_supplicant *wpa_s,
708 struct wpa_ssid *ssid,
713 void wpa_supplicant_mark_disassoc(struct wpa_supplicant *wpa_s);
714 int wpa_supplicant_connect(struct wpa_supplicant *wpa_s,
715 struct wpa_bss *selected,
716 struct wpa_ssid *ssid);
717 void wpa_supplicant_stop_countermeasures(void *eloop_ctx, void *sock_ctx);
718 void wpa_supplicant_delayed_mic_error_report(void *eloop_ctx, void *sock_ctx);
719 void wnm_bss_keep_alive_deinit(struct wpa_supplicant *wpa_s);
720 int wpas_select_network_from_last_scan(struct wpa_supplicant *wpa_s);
723 int eap_register_methods(void);
726 * Utility method to tell if a given network is a persistent group
727 * @ssid: Network object
728 * Returns: 1 if network is a persistent group, 0 otherwise
730 static inline int network_is_persistent_group(struct wpa_ssid *ssid)
732 return ((ssid->disabled == 2) || ssid->p2p_persistent_group);
735 int wpas_network_disabled(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid);
737 int wpas_init_ext_pw(struct wpa_supplicant *wpa_s);
739 #endif /* WPA_SUPPLICANT_I_H */