2 * wpa_supplicant - Internal definitions
3 * Copyright (c) 2003-2010, Jouni Malinen <j@w1.fi>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
9 * Alternatively, this software may be distributed under the terms of BSD
12 * See README and COPYING for more details.
15 #ifndef WPA_SUPPLICANT_I_H
16 #define WPA_SUPPLICANT_I_H
18 #include "utils/list.h"
19 #include "common/defs.h"
21 extern const char *wpa_supplicant_version;
22 extern const char *wpa_supplicant_license;
23 #ifndef CONFIG_NO_STDOUT_DEBUG
24 extern const char *wpa_supplicant_full_license1;
25 extern const char *wpa_supplicant_full_license2;
26 extern const char *wpa_supplicant_full_license3;
27 extern const char *wpa_supplicant_full_license4;
28 extern const char *wpa_supplicant_full_license5;
29 #endif /* CONFIG_NO_STDOUT_DEBUG */
32 struct wpa_supplicant;
36 struct wpa_scan_results;
37 struct hostapd_hw_modes;
40 * Forward declarations of private structures used within the ctrl_iface
41 * backends. Other parts of wpa_supplicant do not have access to data stored in
44 struct ctrl_iface_priv;
45 struct ctrl_iface_global_priv;
46 struct wpas_dbus_priv;
49 * struct wpa_interface - Parameters for wpa_supplicant_add_iface()
51 struct wpa_interface {
53 * confname - Configuration name (file or profile) name
55 * This can also be %NULL when a configuration file is not used. In
56 * that case, ctrl_interface must be set to allow the interface to be
62 * ctrl_interface - Control interface parameter
64 * If a configuration file is not used, this variable can be used to
65 * set the ctrl_interface parameter that would have otherwise been read
66 * from the configuration file. If both confname and ctrl_interface are
67 * set, ctrl_interface is used to override the value from configuration
70 const char *ctrl_interface;
73 * driver - Driver interface name, or %NULL to use the default driver
78 * driver_param - Driver interface parameters
80 * If a configuration file is not used, this variable can be used to
81 * set the driver_param parameters that would have otherwise been read
82 * from the configuration file. If both confname and driver_param are
83 * set, driver_param is used to override the value from configuration
86 const char *driver_param;
89 * ifname - Interface name
94 * bridge_ifname - Optional bridge interface name
96 * If the driver interface (ifname) is included in a Linux bridge
97 * device, the bridge interface may need to be used for receiving EAPOL
98 * frames. This can be enabled by setting this variable to enable
99 * receiving of EAPOL frames from an additional interface.
101 const char *bridge_ifname;
105 * struct wpa_params - Parameters for wpa_supplicant_init()
109 * daemonize - Run %wpa_supplicant in the background
114 * wait_for_monitor - Wait for a monitor program before starting
116 int wait_for_monitor;
119 * pid_file - Path to a PID (process ID) file
121 * If this and daemonize are set, process ID of the background process
122 * will be written to the specified file.
127 * wpa_debug_level - Debugging verbosity level (e.g., MSG_INFO)
132 * wpa_debug_show_keys - Whether keying material is included in debug
134 * This parameter can be used to allow keying material to be included
135 * in debug messages. This is a security risk and this option should
136 * not be enabled in normal configuration. If needed during
137 * development or while troubleshooting, this option can provide more
138 * details for figuring out what is happening.
140 int wpa_debug_show_keys;
143 * wpa_debug_timestamp - Whether to include timestamp in debug messages
145 int wpa_debug_timestamp;
148 * ctrl_interface - Global ctrl_iface path/parameter
150 char *ctrl_interface;
153 * dbus_ctrl_interface - Enable the DBus control interface
155 int dbus_ctrl_interface;
158 * wpa_debug_file_path - Path of debug file or %NULL to use stdout
160 const char *wpa_debug_file_path;
163 * wpa_debug_syslog - Enable log output through syslog
165 int wpa_debug_syslog;
168 * override_driver - Optional driver parameter override
170 * This parameter can be used to override the driver parameter in
171 * dynamic interface addition to force a specific driver wrapper to be
174 char *override_driver;
177 * override_ctrl_interface - Optional ctrl_interface override
179 * This parameter can be used to override the ctrl_interface parameter
180 * in dynamic interface addition to force a control interface to be
183 char *override_ctrl_interface;
186 struct p2p_srv_bonjour {
188 struct wpabuf *query;
192 struct p2p_srv_upnp {
199 * struct wpa_global - Internal, global data for all %wpa_supplicant interfaces
201 * This structure is initialized by calling wpa_supplicant_init() when starting
205 struct wpa_supplicant *ifaces;
206 struct wpa_params params;
207 struct ctrl_iface_global_priv *ctrl_iface;
208 struct wpas_dbus_priv *dbus;
211 struct os_time suspend_time;
212 struct p2p_data *p2p;
213 struct wpa_supplicant *p2p_group_formation;
214 u8 p2p_dev_addr[ETH_ALEN];
215 struct dl_list p2p_srv_bonjour; /* struct p2p_srv_bonjour */
216 struct dl_list p2p_srv_upnp; /* struct p2p_srv_upnp */
218 int cross_connection;
222 struct wpa_client_mlme {
223 #ifdef CONFIG_CLIENT_MLME
225 IEEE80211_DISABLED, IEEE80211_AUTHENTICATE,
226 IEEE80211_ASSOCIATE, IEEE80211_ASSOCIATED,
227 IEEE80211_IBSS_SEARCH, IEEE80211_IBSS_JOINED
229 u8 prev_bssid[ETH_ALEN];
234 u8 *extra_ie; /* to be added to the end of AssocReq */
236 u8 *extra_probe_ie; /* to be added to the end of ProbeReq */
237 size_t extra_probe_ie_len;
238 enum wpa_key_mgmt key_mgmt;
240 /* The last AssocReq/Resp IEs */
241 u8 *assocreq_ies, *assocresp_ies;
242 size_t assocreq_ies_len, assocresp_ies_len;
244 int auth_tries, assoc_tries;
246 unsigned int ssid_set:1;
247 unsigned int bssid_set:1;
248 unsigned int prev_bssid_set:1;
249 unsigned int authenticated:1;
250 unsigned int associated:1;
251 unsigned int probereq_poll:1;
252 unsigned int use_protection:1;
253 unsigned int create_ibss:1;
254 unsigned int mixed_cell:1;
255 unsigned int wmm_enabled:1;
257 struct os_time last_probe;
259 unsigned int auth_algs; /* bitfield of allowed auth algs
260 * (WPA_AUTH_ALG_*) */
261 int auth_alg; /* currently used IEEE 802.11 authentication algorithm */
262 int auth_transaction;
264 struct os_time ibss_join_req;
265 u8 *probe_resp; /* ProbeResp template for IBSS */
266 size_t probe_resp_len;
269 int wmm_last_param_set;
272 int scan_hw_mode_idx;
273 int scan_channel_idx;
274 enum { SCAN_SET_CHANNEL, SCAN_SEND_PROBE } scan_state;
275 struct os_time last_scan_completed;
276 int scan_oper_channel;
278 int scan_oper_phymode;
280 size_t scan_ssid_len;
284 struct ieee80211_sta_bss *sta_bss_list;
285 #define STA_HASH_SIZE 256
286 #define STA_HASH(sta) (sta[5])
287 struct ieee80211_sta_bss *sta_bss_hash[STA_HASH_SIZE];
289 int cts_protect_erp_frames;
291 enum hostapd_hw_mode phymode; /* current mode */
292 struct hostapd_hw_modes *modes;
294 unsigned int hw_modes; /* bitfield of allowed hardware modes;
295 * (1 << HOSTAPD_MODE_*) */
298 int freq; /* The current frequency in MHz */
299 int channel; /* The current IEEE 802.11 channel number */
301 #ifdef CONFIG_IEEE80211R
305 #endif /* CONFIG_IEEE80211R */
307 void (*public_action_cb)(void *ctx, const u8 *buf, size_t len,
309 void *public_action_cb_ctx;
311 #else /* CONFIG_CLIENT_MLME */
312 int dummy; /* to keep MSVC happy */
313 #endif /* CONFIG_CLIENT_MLME */
317 * struct wpa_supplicant - Internal data for wpa_supplicant interface
319 * This structure contains the internal data for core wpa_supplicant code. This
320 * should be only used directly from the core code. However, a pointer to this
321 * data is used from other files as an arbitrary context pointer in calls to
324 struct wpa_supplicant {
325 struct wpa_global *global;
326 struct wpa_supplicant *parent;
327 struct wpa_supplicant *next;
328 struct l2_packet_data *l2;
329 struct l2_packet_data *l2_br;
330 unsigned char own_addr[ETH_ALEN];
332 #ifdef CONFIG_CTRL_IFACE_DBUS
334 #endif /* CONFIG_CTRL_IFACE_DBUS */
335 #ifdef CONFIG_CTRL_IFACE_DBUS_NEW
337 #endif /* CONFIG_CTRL_IFACE_DBUS_NEW */
338 char bridge_ifname[16];
341 struct wpa_config *conf;
343 os_time_t last_michael_mic_error;
345 u8 pending_bssid[ETH_ALEN]; /* If wpa_state == WPA_ASSOCIATING, this
346 * field contains the targer BSSID. */
347 int reassociate; /* reassociation requested */
348 int disconnected; /* all connections disabled; i.e., do no reassociate
349 * before this has been cleared */
350 struct wpa_ssid *current_ssid;
351 struct wpa_bss *current_bss;
352 int ap_ies_from_associnfo;
353 unsigned int assoc_freq;
355 /* Selected configuration (based on Beacon/ProbeResp WPA IE) */
359 int mgmt_group_cipher;
361 void *drv_priv; /* private data used by driver_ops */
362 void *global_drv_priv;
364 struct wpa_ssid *prev_scan_ssid; /* previously scanned SSID;
365 * NULL = not yet initialized (start
366 * with wildcard SSID)
367 * WILDCARD_SSID_SCAN = wildcard
368 * SSID was used in the previous scan
370 #define WILDCARD_SSID_SCAN ((struct wpa_ssid *) 1)
372 void (*scan_res_handler)(struct wpa_supplicant *wpa_s,
373 struct wpa_scan_results *scan_res);
374 struct dl_list bss; /* struct wpa_bss::list */
375 struct dl_list bss_id; /* struct wpa_bss::list_id */
377 unsigned int bss_update_idx;
378 unsigned int bss_next_id;
380 struct wpa_driver_ops *driver;
381 int interface_removed; /* whether the network interface has been
384 struct eapol_sm *eapol;
386 struct ctrl_iface_priv *ctrl_iface;
388 enum wpa_states wpa_state;
391 int reassociated_connection;
393 int eapol_received; /* number of EAPOL packets received after the
394 * previous association event */
396 struct scard_data *scard;
398 unsigned char last_eapol_src[ETH_ALEN];
402 struct wpa_blacklist *blacklist;
404 int scan_req; /* manual scan request; this forces a scan even if there
405 * are no enabled networks in the configuration */
406 int scan_runs; /* number of scan runs since WPS was started */
407 int *next_scan_freqs;
409 struct wpa_client_mlme mlme;
410 unsigned int drv_flags;
412 unsigned int max_remain_on_chan;
413 unsigned int max_stations;
415 int pending_mic_error_report;
416 int pending_mic_error_pairwise;
417 int mic_errors_seen; /* Michael MIC errors with the current PTK */
419 struct wps_context *wps;
420 int wps_success; /* WPS success event received */
421 struct wps_er *wps_er;
422 int blacklist_cleared;
424 struct wpabuf *pending_eapol_rx;
425 struct os_time pending_eapol_rx_time;
426 u8 pending_eapol_rx_src[ETH_ALEN];
428 struct ibss_rsn *ibss_rsn;
440 u8 assoc_req_ie[200];
441 size_t assoc_req_ie_len;
444 u8 mobility_domain[2];
447 u8 prev_bssid[ETH_ALEN];
451 int sa_query_count; /* number of pending SA Query requests;
452 * 0 = no SA Query in progress */
453 int sa_query_timed_out;
454 u8 *sa_query_trans_id; /* buffer of WLAN_SA_QUERY_TR_ID_LEN *
455 * sa_query_count octets of pending
456 * SA Query transaction identifiers */
457 struct os_time sa_query_start;
459 #endif /* CONFIG_SME */
462 struct hostapd_iface *ap_iface;
463 void (*ap_configured_cb)(void *ctx, void *data);
464 void *ap_configured_cb_ctx;
465 void *ap_configured_cb_data;
466 #endif /* CONFIG_AP */
469 struct p2p_go_neg_results *go_params;
470 int create_p2p_iface;
471 u8 pending_interface_addr[ETH_ALEN];
472 char pending_interface_name[100];
473 int pending_interface_type;
475 unsigned int off_channel_freq;
476 struct wpabuf *pending_action_tx;
477 u8 pending_action_src[ETH_ALEN];
478 u8 pending_action_dst[ETH_ALEN];
479 u8 pending_action_bssid[ETH_ALEN];
480 unsigned int pending_action_freq;
481 int pending_action_without_roc;
482 unsigned int pending_listen_freq;
483 unsigned int pending_listen_duration;
485 NOT_P2P_GROUP_INTERFACE,
486 P2P_GROUP_INTERFACE_PENDING,
487 P2P_GROUP_INTERFACE_GO,
488 P2P_GROUP_INTERFACE_CLIENT
489 } p2p_group_interface;
490 struct p2p_group *p2p_group;
491 int p2p_long_listen; /* remaining time in long Listen state in ms */
494 u8 p2p_auth_invite[ETH_ALEN];
495 int p2p_sd_over_ctrl_iface;
496 int p2p_in_provisioning;
497 int pending_invite_ssid_id;
498 int show_group_started;
499 u8 go_dev_addr[ETH_ALEN];
500 int pending_pd_before_join;
501 u8 pending_join_iface_addr[ETH_ALEN];
502 u8 pending_join_dev_addr[ETH_ALEN];
503 int pending_join_wps_method;
504 int p2p_join_scan_count;
505 unsigned int roc_waiting_drv_freq;
506 int action_tx_wait_time;
510 * Whether cross connection is disallowed by the AP to which this
511 * interface is associated (only valid if there is an association).
513 int cross_connect_disallowed;
516 * Whether this P2P group is configured to use cross connection (only
517 * valid if this is P2P GO interface). The actual cross connect packet
518 * forwarding may not be configured depending on the uplink status.
520 int cross_connect_enabled;
522 /* Whether cross connection forwarding is in use at the moment. */
523 int cross_connect_in_use;
526 * Uplink interface name for cross connection
528 char cross_connect_uplink[100];
531 P2P_GROUP_REMOVAL_UNKNOWN,
532 P2P_GROUP_REMOVAL_REQUESTED,
533 P2P_GROUP_REMOVAL_IDLE_TIMEOUT,
534 P2P_GROUP_REMOVAL_UNAVAILABLE
536 #endif /* CONFIG_P2P */
538 struct wpa_ssid *bgscan_ssid;
539 const struct bgscan_ops *bgscan;
542 int connect_without_scan;
545 unsigned int wps_freq;
546 int wps_fragment_size;
547 int auto_reconnect_disabled;
549 /* Channel preferences for AP/P2P GO use */
552 int best_overall_freq;
556 /* wpa_supplicant.c */
557 int wpa_set_wep_keys(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid);
559 int wpa_supplicant_reload_configuration(struct wpa_supplicant *wpa_s);
561 const char * wpa_supplicant_state_txt(enum wpa_states state);
562 int wpa_supplicant_driver_init(struct wpa_supplicant *wpa_s);
563 int wpa_supplicant_set_suites(struct wpa_supplicant *wpa_s,
564 struct wpa_bss *bss, struct wpa_ssid *ssid,
565 u8 *wpa_ie, size_t *wpa_ie_len);
566 void wpa_supplicant_associate(struct wpa_supplicant *wpa_s,
568 struct wpa_ssid *ssid);
569 void wpa_supplicant_set_non_wpa_policy(struct wpa_supplicant *wpa_s,
570 struct wpa_ssid *ssid);
571 void wpa_supplicant_initiate_eapol(struct wpa_supplicant *wpa_s);
572 void wpa_clear_keys(struct wpa_supplicant *wpa_s, const u8 *addr);
573 void wpa_supplicant_req_auth_timeout(struct wpa_supplicant *wpa_s,
575 void wpa_supplicant_set_state(struct wpa_supplicant *wpa_s,
576 enum wpa_states state);
577 struct wpa_ssid * wpa_supplicant_get_ssid(struct wpa_supplicant *wpa_s);
578 const char * wpa_supplicant_get_eap_mode(struct wpa_supplicant *wpa_s);
579 void wpa_supplicant_cancel_auth_timeout(struct wpa_supplicant *wpa_s);
580 void wpa_supplicant_deauthenticate(struct wpa_supplicant *wpa_s,
582 void wpa_supplicant_disassociate(struct wpa_supplicant *wpa_s,
585 void wpa_supplicant_enable_network(struct wpa_supplicant *wpa_s,
586 struct wpa_ssid *ssid);
587 void wpa_supplicant_disable_network(struct wpa_supplicant *wpa_s,
588 struct wpa_ssid *ssid);
589 void wpa_supplicant_select_network(struct wpa_supplicant *wpa_s,
590 struct wpa_ssid *ssid);
591 int wpa_supplicant_set_ap_scan(struct wpa_supplicant *wpa_s,
593 int wpa_supplicant_set_debug_params(struct wpa_global *global,
594 int debug_level, int debug_timestamp,
595 int debug_show_keys);
597 void wpa_show_license(void);
599 struct wpa_supplicant * wpa_supplicant_add_iface(struct wpa_global *global,
600 struct wpa_interface *iface);
601 int wpa_supplicant_remove_iface(struct wpa_global *global,
602 struct wpa_supplicant *wpa_s);
603 struct wpa_supplicant * wpa_supplicant_get_iface(struct wpa_global *global,
605 struct wpa_global * wpa_supplicant_init(struct wpa_params *params);
606 int wpa_supplicant_run(struct wpa_global *global);
607 void wpa_supplicant_deinit(struct wpa_global *global);
609 int wpa_supplicant_scard_init(struct wpa_supplicant *wpa_s,
610 struct wpa_ssid *ssid);
611 void wpa_supplicant_terminate_proc(struct wpa_global *global);
612 void wpa_supplicant_rx_eapol(void *ctx, const u8 *src_addr,
613 const u8 *buf, size_t len);
614 enum wpa_key_mgmt key_mgmt2driver(int key_mgmt);
615 enum wpa_cipher cipher_suite2driver(int cipher);
616 void wpa_supplicant_update_config(struct wpa_supplicant *wpa_s);
617 void wpa_supplicant_clear_status(struct wpa_supplicant *wpa_s);
618 void ieee80211_sta_free_hw_features(struct hostapd_hw_modes *hw_features,
619 size_t num_hw_features);
620 void wpas_connection_failed(struct wpa_supplicant *wpa_s, const u8 *bssid);
623 void wpa_supplicant_mark_disassoc(struct wpa_supplicant *wpa_s);
624 void wpa_supplicant_connect(struct wpa_supplicant *wpa_s,
625 struct wpa_bss *selected,
626 struct wpa_ssid *ssid);
629 int eap_register_methods(void);
631 #endif /* WPA_SUPPLICANT_I_H */