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;
350 struct wpa_driver_ops *driver;
351 int interface_removed; /* whether the network interface has been
354 struct eapol_sm *eapol;
356 struct ctrl_iface_priv *ctrl_iface;
358 enum wpa_states wpa_state;
362 int reassociated_connection;
364 int eapol_received; /* number of EAPOL packets received after the
365 * previous association event */
367 struct scard_data *scard;
371 #endif /* PCSC_FUNCS */
373 unsigned char last_eapol_src[ETH_ALEN];
377 struct wpa_blacklist *blacklist;
379 int scan_req; /* manual scan request; this forces a scan even if there
380 * are no enabled networks in the configuration */
381 int scan_runs; /* number of scan runs since WPS was started */
382 int *next_scan_freqs;
383 int scan_interval; /* time in sec between scans to find suitable AP */
384 int normal_scans; /* normal scans run before sched_scan */
386 unsigned int drv_flags;
387 unsigned int drv_enc;
390 * A bitmap of supported protocols for probe response offload. See
391 * struct wpa_driver_capa in driver.h
393 unsigned int probe_resp_offloads;
396 int max_sched_scan_ssids;
397 int sched_scan_supported;
398 unsigned int max_match_sets;
399 unsigned int max_remain_on_chan;
400 unsigned int max_stations;
402 int pending_mic_error_report;
403 int pending_mic_error_pairwise;
404 int mic_errors_seen; /* Michael MIC errors with the current PTK */
406 struct wps_context *wps;
407 int wps_success; /* WPS success event received */
408 struct wps_er *wps_er;
409 int blacklist_cleared;
411 struct wpabuf *pending_eapol_rx;
412 struct os_time pending_eapol_rx_time;
413 u8 pending_eapol_rx_src[ETH_ALEN];
415 struct ibss_rsn *ibss_rsn;
427 u8 assoc_req_ie[200];
428 size_t assoc_req_ie_len;
431 u8 mobility_domain[2];
434 u8 prev_bssid[ETH_ALEN];
439 int sa_query_count; /* number of pending SA Query requests;
440 * 0 = no SA Query in progress */
441 int sa_query_timed_out;
442 u8 *sa_query_trans_id; /* buffer of WLAN_SA_QUERY_TR_ID_LEN *
443 * sa_query_count octets of pending
444 * SA Query transaction identifiers */
445 struct os_time sa_query_start;
448 u16 bss_max_idle_period;
450 #endif /* CONFIG_SME */
453 struct hostapd_iface *ap_iface;
454 void (*ap_configured_cb)(void *ctx, void *data);
455 void *ap_configured_cb_ctx;
456 void *ap_configured_cb_data;
457 #endif /* CONFIG_AP */
459 unsigned int off_channel_freq;
460 struct wpabuf *pending_action_tx;
461 u8 pending_action_src[ETH_ALEN];
462 u8 pending_action_dst[ETH_ALEN];
463 u8 pending_action_bssid[ETH_ALEN];
464 unsigned int pending_action_freq;
465 int pending_action_no_cck;
466 int pending_action_without_roc;
467 void (*pending_action_tx_status_cb)(struct wpa_supplicant *wpa_s,
468 unsigned int freq, const u8 *dst,
469 const u8 *src, const u8 *bssid,
470 const u8 *data, size_t data_len,
471 enum offchannel_send_action_result
473 unsigned int roc_waiting_drv_freq;
474 int action_tx_wait_time;
477 struct p2p_go_neg_results *go_params;
478 int create_p2p_iface;
479 u8 pending_interface_addr[ETH_ALEN];
480 char pending_interface_name[100];
481 int pending_interface_type;
483 unsigned int pending_listen_freq;
484 unsigned int pending_listen_duration;
486 NOT_P2P_GROUP_INTERFACE,
487 P2P_GROUP_INTERFACE_PENDING,
488 P2P_GROUP_INTERFACE_GO,
489 P2P_GROUP_INTERFACE_CLIENT
490 } p2p_group_interface;
491 struct p2p_group *p2p_group;
492 int p2p_long_listen; /* remaining time in long Listen state in ms */
495 u8 p2p_auth_invite[ETH_ALEN];
496 int p2p_sd_over_ctrl_iface;
497 int p2p_in_provisioning;
498 int pending_invite_ssid_id;
499 int show_group_started;
500 u8 go_dev_addr[ETH_ALEN];
501 int pending_pd_before_join;
502 u8 pending_join_iface_addr[ETH_ALEN];
503 u8 pending_join_dev_addr[ETH_ALEN];
504 int pending_join_wps_method;
505 int p2p_join_scan_count;
506 int auto_pd_scan_retry;
508 u16 pending_pd_config_methods;
510 NORMAL_PD, AUTO_PD_GO_NEG, AUTO_PD_JOIN
514 * Whether cross connection is disallowed by the AP to which this
515 * interface is associated (only valid if there is an association).
517 int cross_connect_disallowed;
520 * Whether this P2P group is configured to use cross connection (only
521 * valid if this is P2P GO interface). The actual cross connect packet
522 * forwarding may not be configured depending on the uplink status.
524 int cross_connect_enabled;
526 /* Whether cross connection forwarding is in use at the moment. */
527 int cross_connect_in_use;
530 * Uplink interface name for cross connection
532 char cross_connect_uplink[100];
534 unsigned int p2p_cb_on_scan_complete:1;
535 unsigned int sta_scan_pending:1;
536 unsigned int p2p_auto_join:1;
537 unsigned int p2p_auto_pd:1;
538 unsigned int p2p_persistent_group:1;
539 unsigned int p2p_fallback_to_go_neg:1;
540 unsigned int p2p_pd_before_go_neg:1;
541 unsigned int p2p_go_ht40:1;
542 int p2p_persistent_id;
544 int p2p_connect_freq;
545 struct os_time p2p_auto_started;
546 #endif /* CONFIG_P2P */
548 struct wpa_ssid *bgscan_ssid;
549 const struct bgscan_ops *bgscan;
552 const struct autoscan_ops *autoscan;
553 struct wpa_driver_scan_params *autoscan_params;
556 struct wpa_ssid *connect_without_scan;
558 struct wps_ap_info *wps_ap;
564 unsigned int wps_freq;
565 int wps_fragment_size;
566 int auto_reconnect_disabled;
568 /* Channel preferences for AP/P2P GO use */
571 int best_overall_freq;
573 struct gas_query *gas;
575 #ifdef CONFIG_INTERWORKING
576 unsigned int fetch_anqp_in_progress:1;
577 unsigned int network_select:1;
578 unsigned int auto_select:1;
579 unsigned int auto_network_select:1;
580 #endif /* CONFIG_INTERWORKING */
581 unsigned int drv_capa_known;
584 struct hostapd_hw_modes *modes;
591 /* WLAN_REASON_* reason codes. Negative if locally generated. */
592 int disconnect_reason;
594 struct ext_password_data *ext_pw;
596 struct wpabuf *last_gas_resp;
597 u8 last_gas_addr[ETH_ALEN];
598 u8 last_gas_dialog_token;
602 /* wpa_supplicant.c */
603 void wpa_supplicant_apply_ht_overrides(
604 struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid,
605 struct wpa_driver_associate_params *params);
607 int wpa_set_wep_keys(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid);
609 int wpa_supplicant_reload_configuration(struct wpa_supplicant *wpa_s);
611 const char * wpa_supplicant_state_txt(enum wpa_states state);
612 int wpa_supplicant_update_mac_addr(struct wpa_supplicant *wpa_s);
613 int wpa_supplicant_driver_init(struct wpa_supplicant *wpa_s);
614 int wpa_supplicant_set_suites(struct wpa_supplicant *wpa_s,
615 struct wpa_bss *bss, struct wpa_ssid *ssid,
616 u8 *wpa_ie, size_t *wpa_ie_len);
617 void wpa_supplicant_associate(struct wpa_supplicant *wpa_s,
619 struct wpa_ssid *ssid);
620 void wpa_supplicant_set_non_wpa_policy(struct wpa_supplicant *wpa_s,
621 struct wpa_ssid *ssid);
622 void wpa_supplicant_initiate_eapol(struct wpa_supplicant *wpa_s);
623 void wpa_clear_keys(struct wpa_supplicant *wpa_s, const u8 *addr);
624 void wpa_supplicant_req_auth_timeout(struct wpa_supplicant *wpa_s,
626 void wpa_supplicant_reinit_autoscan(struct wpa_supplicant *wpa_s);
627 void wpa_supplicant_set_state(struct wpa_supplicant *wpa_s,
628 enum wpa_states state);
629 struct wpa_ssid * wpa_supplicant_get_ssid(struct wpa_supplicant *wpa_s);
630 const char * wpa_supplicant_get_eap_mode(struct wpa_supplicant *wpa_s);
631 void wpa_supplicant_cancel_auth_timeout(struct wpa_supplicant *wpa_s);
632 void wpa_supplicant_deauthenticate(struct wpa_supplicant *wpa_s,
634 void wpa_supplicant_disassociate(struct wpa_supplicant *wpa_s,
637 void wpa_supplicant_enable_network(struct wpa_supplicant *wpa_s,
638 struct wpa_ssid *ssid);
639 void wpa_supplicant_disable_network(struct wpa_supplicant *wpa_s,
640 struct wpa_ssid *ssid);
641 void wpa_supplicant_select_network(struct wpa_supplicant *wpa_s,
642 struct wpa_ssid *ssid);
643 int wpa_supplicant_set_ap_scan(struct wpa_supplicant *wpa_s,
645 int wpa_supplicant_set_bss_expiration_age(struct wpa_supplicant *wpa_s,
646 unsigned int expire_age);
647 int wpa_supplicant_set_bss_expiration_count(struct wpa_supplicant *wpa_s,
648 unsigned int expire_count);
649 int wpa_supplicant_set_scan_interval(struct wpa_supplicant *wpa_s,
651 int wpa_supplicant_set_debug_params(struct wpa_global *global,
652 int debug_level, int debug_timestamp,
653 int debug_show_keys);
654 void free_hw_features(struct wpa_supplicant *wpa_s);
656 void wpa_show_license(void);
658 struct wpa_supplicant * wpa_supplicant_add_iface(struct wpa_global *global,
659 struct wpa_interface *iface);
660 int wpa_supplicant_remove_iface(struct wpa_global *global,
661 struct wpa_supplicant *wpa_s,
663 struct wpa_supplicant * wpa_supplicant_get_iface(struct wpa_global *global,
665 struct wpa_global * wpa_supplicant_init(struct wpa_params *params);
666 int wpa_supplicant_run(struct wpa_global *global);
667 void wpa_supplicant_deinit(struct wpa_global *global);
669 int wpa_supplicant_scard_init(struct wpa_supplicant *wpa_s,
670 struct wpa_ssid *ssid);
671 void wpa_supplicant_terminate_proc(struct wpa_global *global);
672 void wpa_supplicant_rx_eapol(void *ctx, const u8 *src_addr,
673 const u8 *buf, size_t len);
674 enum wpa_key_mgmt key_mgmt2driver(int key_mgmt);
675 enum wpa_cipher cipher_suite2driver(int cipher);
676 void wpa_supplicant_update_config(struct wpa_supplicant *wpa_s);
677 void wpa_supplicant_clear_status(struct wpa_supplicant *wpa_s);
678 void wpas_connection_failed(struct wpa_supplicant *wpa_s, const u8 *bssid);
679 int wpas_driver_bss_selection(struct wpa_supplicant *wpa_s);
680 int wpas_is_p2p_prioritized(struct wpa_supplicant *wpa_s);
681 void wpas_auth_failed(struct wpa_supplicant *wpa_s);
682 void wpas_clear_temp_disabled(struct wpa_supplicant *wpa_s,
683 struct wpa_ssid *ssid, int clear_failures);
684 void wpa_supplicant_proc_40mhz_intolerant(struct wpa_supplicant *wpa_s);
687 * wpa_supplicant_ctrl_iface_ctrl_rsp_handle - Handle a control response
688 * @wpa_s: Pointer to wpa_supplicant data
689 * @ssid: Pointer to the network block the reply is for
690 * @field: field the response is a reply for
691 * @value: value (ie, password, etc) for @field
692 * Returns: 0 on success, non-zero on error
694 * Helper function to handle replies to control interface requests.
696 int wpa_supplicant_ctrl_iface_ctrl_rsp_handle(struct wpa_supplicant *wpa_s,
697 struct wpa_ssid *ssid,
702 void wpa_supplicant_mark_disassoc(struct wpa_supplicant *wpa_s);
703 int wpa_supplicant_connect(struct wpa_supplicant *wpa_s,
704 struct wpa_bss *selected,
705 struct wpa_ssid *ssid);
706 void wpa_supplicant_stop_countermeasures(void *eloop_ctx, void *sock_ctx);
707 void wpa_supplicant_delayed_mic_error_report(void *eloop_ctx, void *sock_ctx);
708 void wnm_bss_keep_alive_deinit(struct wpa_supplicant *wpa_s);
711 int eap_register_methods(void);
714 * Utility method to tell if a given network is a persistent group
715 * @ssid: Network object
716 * Returns: 1 if network is a persistent group, 0 otherwise
718 static inline int network_is_persistent_group(struct wpa_ssid *ssid)
720 return ((ssid->disabled == 2) || ssid->p2p_persistent_group);
723 int wpas_network_disabled(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid);
725 int wpas_init_ext_pw(struct wpa_supplicant *wpa_s);
727 #endif /* WPA_SUPPLICANT_I_H */