2 * wpa_supplicant - Internal definitions
3 * Copyright (c) 2003-2010, 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,
245 enum offchannel_send_action_result {
246 OFFCHANNEL_SEND_ACTION_SUCCESS /* Frame was send and acknowledged */,
247 OFFCHANNEL_SEND_ACTION_NO_ACK /* Frame was sent, but not acknowledged
249 OFFCHANNEL_SEND_ACTION_FAILED /* Frame was not sent due to a failure */
253 * struct wpa_supplicant - Internal data for wpa_supplicant interface
255 * This structure contains the internal data for core wpa_supplicant code. This
256 * should be only used directly from the core code. However, a pointer to this
257 * data is used from other files as an arbitrary context pointer in calls to
260 struct wpa_supplicant {
261 struct wpa_global *global;
262 struct wpa_supplicant *parent;
263 struct wpa_supplicant *next;
264 struct l2_packet_data *l2;
265 struct l2_packet_data *l2_br;
266 unsigned char own_addr[ETH_ALEN];
268 #ifdef CONFIG_CTRL_IFACE_DBUS
270 #endif /* CONFIG_CTRL_IFACE_DBUS */
271 #ifdef CONFIG_CTRL_IFACE_DBUS_NEW
273 char *dbus_groupobj_path;
275 char *preq_notify_peer;
276 #endif /* CONFIG_AP */
277 #endif /* CONFIG_CTRL_IFACE_DBUS_NEW */
278 char bridge_ifname[16];
281 struct wpa_config *conf;
283 os_time_t last_michael_mic_error;
285 u8 pending_bssid[ETH_ALEN]; /* If wpa_state == WPA_ASSOCIATING, this
286 * field contains the target BSSID. */
287 int reassociate; /* reassociation requested */
288 int disconnected; /* all connections disabled; i.e., do no reassociate
289 * before this has been cleared */
290 struct wpa_ssid *current_ssid;
291 struct wpa_bss *current_bss;
292 int ap_ies_from_associnfo;
293 unsigned int assoc_freq;
295 /* Selected configuration (based on Beacon/ProbeResp WPA IE) */
300 int mgmt_group_cipher;
302 void *drv_priv; /* private data used by driver_ops */
303 void *global_drv_priv;
306 size_t bssid_filter_count;
308 /* previous scan was wildcard when interleaving between
309 * wildcard scans and specific SSID scan when max_ssids=1 */
310 int prev_scan_wildcard;
311 struct wpa_ssid *prev_scan_ssid; /* previously scanned SSID;
312 * NULL = not yet initialized (start
313 * with wildcard SSID)
314 * WILDCARD_SSID_SCAN = wildcard
315 * SSID was used in the previous scan
317 #define WILDCARD_SSID_SCAN ((struct wpa_ssid *) 1)
319 struct wpa_ssid *prev_sched_ssid; /* last SSID used in sched scan */
320 int sched_scan_timeout;
321 int sched_scan_interval;
322 int first_sched_scan;
323 int sched_scan_timed_out;
325 void (*scan_res_handler)(struct wpa_supplicant *wpa_s,
326 struct wpa_scan_results *scan_res);
327 struct dl_list bss; /* struct wpa_bss::list */
328 struct dl_list bss_id; /* struct wpa_bss::list_id */
330 unsigned int bss_update_idx;
331 unsigned int bss_next_id;
333 struct wpa_driver_ops *driver;
334 int interface_removed; /* whether the network interface has been
337 struct eapol_sm *eapol;
339 struct ctrl_iface_priv *ctrl_iface;
341 enum wpa_states wpa_state;
345 int reassociated_connection;
347 int eapol_received; /* number of EAPOL packets received after the
348 * previous association event */
350 struct scard_data *scard;
354 #endif /* PCSC_FUNCS */
356 unsigned char last_eapol_src[ETH_ALEN];
360 struct wpa_blacklist *blacklist;
362 int scan_req; /* manual scan request; this forces a scan even if there
363 * are no enabled networks in the configuration */
364 int scan_runs; /* number of scan runs since WPS was started */
365 int *next_scan_freqs;
366 int scan_interval; /* time in sec between scans to find suitable AP */
367 int normal_scans; /* normal scans run before sched_scan */
369 unsigned int drv_flags;
370 unsigned int drv_enc;
373 * A bitmap of supported protocols for probe response offload. See
374 * struct wpa_driver_capa in driver.h
376 unsigned int probe_resp_offloads;
379 int max_sched_scan_ssids;
380 int sched_scan_supported;
381 unsigned int max_match_sets;
382 unsigned int max_remain_on_chan;
383 unsigned int max_stations;
385 int pending_mic_error_report;
386 int pending_mic_error_pairwise;
387 int mic_errors_seen; /* Michael MIC errors with the current PTK */
389 struct wps_context *wps;
390 int wps_success; /* WPS success event received */
391 struct wps_er *wps_er;
392 int blacklist_cleared;
394 struct wpabuf *pending_eapol_rx;
395 struct os_time pending_eapol_rx_time;
396 u8 pending_eapol_rx_src[ETH_ALEN];
398 struct ibss_rsn *ibss_rsn;
410 u8 assoc_req_ie[200];
411 size_t assoc_req_ie_len;
414 u8 mobility_domain[2];
417 u8 prev_bssid[ETH_ALEN];
422 int sa_query_count; /* number of pending SA Query requests;
423 * 0 = no SA Query in progress */
424 int sa_query_timed_out;
425 u8 *sa_query_trans_id; /* buffer of WLAN_SA_QUERY_TR_ID_LEN *
426 * sa_query_count octets of pending
427 * SA Query transaction identifiers */
428 struct os_time sa_query_start;
431 u16 bss_max_idle_period;
433 #endif /* CONFIG_SME */
436 struct hostapd_iface *ap_iface;
437 void (*ap_configured_cb)(void *ctx, void *data);
438 void *ap_configured_cb_ctx;
439 void *ap_configured_cb_data;
440 #endif /* CONFIG_AP */
442 unsigned int off_channel_freq;
443 struct wpabuf *pending_action_tx;
444 u8 pending_action_src[ETH_ALEN];
445 u8 pending_action_dst[ETH_ALEN];
446 u8 pending_action_bssid[ETH_ALEN];
447 unsigned int pending_action_freq;
448 int pending_action_no_cck;
449 int pending_action_without_roc;
450 void (*pending_action_tx_status_cb)(struct wpa_supplicant *wpa_s,
451 unsigned int freq, const u8 *dst,
452 const u8 *src, const u8 *bssid,
453 const u8 *data, size_t data_len,
454 enum offchannel_send_action_result
456 unsigned int roc_waiting_drv_freq;
457 int action_tx_wait_time;
460 struct p2p_go_neg_results *go_params;
461 int create_p2p_iface;
462 u8 pending_interface_addr[ETH_ALEN];
463 char pending_interface_name[100];
464 int pending_interface_type;
466 unsigned int pending_listen_freq;
467 unsigned int pending_listen_duration;
469 NOT_P2P_GROUP_INTERFACE,
470 P2P_GROUP_INTERFACE_PENDING,
471 P2P_GROUP_INTERFACE_GO,
472 P2P_GROUP_INTERFACE_CLIENT
473 } p2p_group_interface;
474 struct p2p_group *p2p_group;
475 int p2p_long_listen; /* remaining time in long Listen state in ms */
478 u8 p2p_auth_invite[ETH_ALEN];
479 int p2p_sd_over_ctrl_iface;
480 int p2p_in_provisioning;
481 int pending_invite_ssid_id;
482 int show_group_started;
483 u8 go_dev_addr[ETH_ALEN];
484 int pending_pd_before_join;
485 u8 pending_join_iface_addr[ETH_ALEN];
486 u8 pending_join_dev_addr[ETH_ALEN];
487 int pending_join_wps_method;
488 int p2p_join_scan_count;
489 int auto_pd_scan_retry;
491 u16 pending_pd_config_methods;
493 NORMAL_PD, AUTO_PD_GO_NEG, AUTO_PD_JOIN
497 * Whether cross connection is disallowed by the AP to which this
498 * interface is associated (only valid if there is an association).
500 int cross_connect_disallowed;
503 * Whether this P2P group is configured to use cross connection (only
504 * valid if this is P2P GO interface). The actual cross connect packet
505 * forwarding may not be configured depending on the uplink status.
507 int cross_connect_enabled;
509 /* Whether cross connection forwarding is in use at the moment. */
510 int cross_connect_in_use;
513 * Uplink interface name for cross connection
515 char cross_connect_uplink[100];
518 P2P_GROUP_REMOVAL_UNKNOWN,
519 P2P_GROUP_REMOVAL_REQUESTED,
520 P2P_GROUP_REMOVAL_IDLE_TIMEOUT,
521 P2P_GROUP_REMOVAL_UNAVAILABLE,
522 P2P_GROUP_REMOVAL_GO_ENDING_SESSION,
524 P2P_GROUP_REMOVAL_FREQ_CONFLICT
528 unsigned int p2p_cb_on_scan_complete:1;
529 unsigned int p2p_auto_join:1;
530 unsigned int p2p_auto_pd:1;
531 unsigned int p2p_persistent_group:1;
532 unsigned int p2p_fallback_to_go_neg:1;
533 unsigned int p2p_pd_before_go_neg:1;
534 int p2p_persistent_id;
536 int p2p_connect_freq;
537 struct os_time p2p_auto_started;
538 #endif /* CONFIG_P2P */
540 struct wpa_ssid *bgscan_ssid;
541 const struct bgscan_ops *bgscan;
544 const struct autoscan_ops *autoscan;
545 struct wpa_driver_scan_params *autoscan_params;
548 struct wpa_ssid *connect_without_scan;
552 unsigned int wps_freq;
553 int wps_fragment_size;
554 int auto_reconnect_disabled;
556 /* Channel preferences for AP/P2P GO use */
559 int best_overall_freq;
561 struct gas_query *gas;
563 #ifdef CONFIG_INTERWORKING
564 unsigned int fetch_anqp_in_progress:1;
565 unsigned int network_select:1;
566 unsigned int auto_select:1;
567 #endif /* CONFIG_INTERWORKING */
568 unsigned int drv_capa_known;
571 struct hostapd_hw_modes *modes;
578 /* WLAN_REASON_* reason codes. Negative if locally generated. */
579 int disconnect_reason;
583 /* wpa_supplicant.c */
584 void wpa_supplicant_apply_ht_overrides(
585 struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid,
586 struct wpa_driver_associate_params *params);
588 int wpa_set_wep_keys(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid);
590 int wpa_supplicant_reload_configuration(struct wpa_supplicant *wpa_s);
592 const char * wpa_supplicant_state_txt(enum wpa_states state);
593 int wpa_supplicant_update_mac_addr(struct wpa_supplicant *wpa_s);
594 int wpa_supplicant_driver_init(struct wpa_supplicant *wpa_s);
595 int wpa_supplicant_set_suites(struct wpa_supplicant *wpa_s,
596 struct wpa_bss *bss, struct wpa_ssid *ssid,
597 u8 *wpa_ie, size_t *wpa_ie_len);
598 void wpa_supplicant_associate(struct wpa_supplicant *wpa_s,
600 struct wpa_ssid *ssid);
601 void wpa_supplicant_set_non_wpa_policy(struct wpa_supplicant *wpa_s,
602 struct wpa_ssid *ssid);
603 void wpa_supplicant_initiate_eapol(struct wpa_supplicant *wpa_s);
604 void wpa_clear_keys(struct wpa_supplicant *wpa_s, const u8 *addr);
605 void wpa_supplicant_req_auth_timeout(struct wpa_supplicant *wpa_s,
607 void wpa_supplicant_reinit_autoscan(struct wpa_supplicant *wpa_s);
608 void wpa_supplicant_set_state(struct wpa_supplicant *wpa_s,
609 enum wpa_states state);
610 struct wpa_ssid * wpa_supplicant_get_ssid(struct wpa_supplicant *wpa_s);
611 const char * wpa_supplicant_get_eap_mode(struct wpa_supplicant *wpa_s);
612 void wpa_supplicant_cancel_auth_timeout(struct wpa_supplicant *wpa_s);
613 void wpa_supplicant_deauthenticate(struct wpa_supplicant *wpa_s,
615 void wpa_supplicant_disassociate(struct wpa_supplicant *wpa_s,
618 void wpa_supplicant_enable_network(struct wpa_supplicant *wpa_s,
619 struct wpa_ssid *ssid);
620 void wpa_supplicant_disable_network(struct wpa_supplicant *wpa_s,
621 struct wpa_ssid *ssid);
622 void wpa_supplicant_select_network(struct wpa_supplicant *wpa_s,
623 struct wpa_ssid *ssid);
624 int wpa_supplicant_set_ap_scan(struct wpa_supplicant *wpa_s,
626 int wpa_supplicant_set_bss_expiration_age(struct wpa_supplicant *wpa_s,
627 unsigned int expire_age);
628 int wpa_supplicant_set_bss_expiration_count(struct wpa_supplicant *wpa_s,
629 unsigned int expire_count);
630 int wpa_supplicant_set_scan_interval(struct wpa_supplicant *wpa_s,
632 int wpa_supplicant_set_debug_params(struct wpa_global *global,
633 int debug_level, int debug_timestamp,
634 int debug_show_keys);
635 void free_hw_features(struct wpa_supplicant *wpa_s);
637 void wpa_show_license(void);
639 struct wpa_supplicant * wpa_supplicant_add_iface(struct wpa_global *global,
640 struct wpa_interface *iface);
641 int wpa_supplicant_remove_iface(struct wpa_global *global,
642 struct wpa_supplicant *wpa_s,
644 struct wpa_supplicant * wpa_supplicant_get_iface(struct wpa_global *global,
646 struct wpa_global * wpa_supplicant_init(struct wpa_params *params);
647 int wpa_supplicant_run(struct wpa_global *global);
648 void wpa_supplicant_deinit(struct wpa_global *global);
650 int wpa_supplicant_scard_init(struct wpa_supplicant *wpa_s,
651 struct wpa_ssid *ssid);
652 void wpa_supplicant_terminate_proc(struct wpa_global *global);
653 void wpa_supplicant_rx_eapol(void *ctx, const u8 *src_addr,
654 const u8 *buf, size_t len);
655 enum wpa_key_mgmt key_mgmt2driver(int key_mgmt);
656 enum wpa_cipher cipher_suite2driver(int cipher);
657 void wpa_supplicant_update_config(struct wpa_supplicant *wpa_s);
658 void wpa_supplicant_clear_status(struct wpa_supplicant *wpa_s);
659 void wpas_connection_failed(struct wpa_supplicant *wpa_s, const u8 *bssid);
660 int wpas_driver_bss_selection(struct wpa_supplicant *wpa_s);
661 int wpas_is_p2p_prioritized(struct wpa_supplicant *wpa_s);
662 void wpa_supplicant_proc_40mhz_intolerant(struct wpa_supplicant *wpa_s);
665 * wpa_supplicant_ctrl_iface_ctrl_rsp_handle - Handle a control response
666 * @wpa_s: Pointer to wpa_supplicant data
667 * @ssid: Pointer to the network block the reply is for
668 * @field: field the response is a reply for
669 * @value: value (ie, password, etc) for @field
670 * Returns: 0 on success, non-zero on error
672 * Helper function to handle replies to control interface requests.
674 int wpa_supplicant_ctrl_iface_ctrl_rsp_handle(struct wpa_supplicant *wpa_s,
675 struct wpa_ssid *ssid,
680 void wpa_supplicant_mark_disassoc(struct wpa_supplicant *wpa_s);
681 int wpa_supplicant_connect(struct wpa_supplicant *wpa_s,
682 struct wpa_bss *selected,
683 struct wpa_ssid *ssid);
684 void wpa_supplicant_stop_countermeasures(void *eloop_ctx, void *sock_ctx);
685 void wpa_supplicant_delayed_mic_error_report(void *eloop_ctx, void *sock_ctx);
686 void wnm_bss_keep_alive_deinit(struct wpa_supplicant *wpa_s);
689 int eap_register_methods(void);
692 * Utility method to tell if a given network is a persistent group
693 * @ssid: Network object
694 * Returns: 1 if network is a persistent group, 0 otherwise
696 static inline int network_is_persistent_group(struct wpa_ssid *ssid)
698 return ((ssid->disabled == 2) || ssid->p2p_persistent_group);
701 int wpas_network_disabled(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid);
703 #endif /* WPA_SUPPLICANT_I_H */