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;
39 * Forward declarations of private structures used within the ctrl_iface
40 * backends. Other parts of wpa_supplicant do not have access to data stored in
43 struct ctrl_iface_priv;
44 struct ctrl_iface_global_priv;
45 struct wpas_dbus_priv;
48 * struct wpa_interface - Parameters for wpa_supplicant_add_iface()
50 struct wpa_interface {
52 * confname - Configuration name (file or profile) name
54 * This can also be %NULL when a configuration file is not used. In
55 * that case, ctrl_interface must be set to allow the interface to be
61 * ctrl_interface - Control interface parameter
63 * If a configuration file is not used, this variable can be used to
64 * set the ctrl_interface parameter that would have otherwise been read
65 * from the configuration file. If both confname and ctrl_interface are
66 * set, ctrl_interface is used to override the value from configuration
69 const char *ctrl_interface;
72 * driver - Driver interface name, or %NULL to use the default driver
77 * driver_param - Driver interface parameters
79 * If a configuration file is not used, this variable can be used to
80 * set the driver_param parameters that would have otherwise been read
81 * from the configuration file. If both confname and driver_param are
82 * set, driver_param is used to override the value from configuration
85 const char *driver_param;
88 * ifname - Interface name
93 * bridge_ifname - Optional bridge interface name
95 * If the driver interface (ifname) is included in a Linux bridge
96 * device, the bridge interface may need to be used for receiving EAPOL
97 * frames. This can be enabled by setting this variable to enable
98 * receiving of EAPOL frames from an additional interface.
100 const char *bridge_ifname;
104 * struct wpa_params - Parameters for wpa_supplicant_init()
108 * daemonize - Run %wpa_supplicant in the background
113 * wait_for_monitor - Wait for a monitor program before starting
115 int wait_for_monitor;
118 * pid_file - Path to a PID (process ID) file
120 * If this and daemonize are set, process ID of the background process
121 * will be written to the specified file.
126 * wpa_debug_level - Debugging verbosity level (e.g., MSG_INFO)
131 * wpa_debug_show_keys - Whether keying material is included in debug
133 * This parameter can be used to allow keying material to be included
134 * in debug messages. This is a security risk and this option should
135 * not be enabled in normal configuration. If needed during
136 * development or while troubleshooting, this option can provide more
137 * details for figuring out what is happening.
139 int wpa_debug_show_keys;
142 * wpa_debug_timestamp - Whether to include timestamp in debug messages
144 int wpa_debug_timestamp;
147 * ctrl_interface - Global ctrl_iface path/parameter
149 char *ctrl_interface;
152 * dbus_ctrl_interface - Enable the DBus control interface
154 int dbus_ctrl_interface;
157 * wpa_debug_file_path - Path of debug file or %NULL to use stdout
159 const char *wpa_debug_file_path;
162 * wpa_debug_syslog - Enable log output through syslog
164 int wpa_debug_syslog;
167 * override_driver - Optional driver parameter override
169 * This parameter can be used to override the driver parameter in
170 * dynamic interface addition to force a specific driver wrapper to be
173 char *override_driver;
176 * override_ctrl_interface - Optional ctrl_interface override
178 * This parameter can be used to override the ctrl_interface parameter
179 * in dynamic interface addition to force a control interface to be
182 char *override_ctrl_interface;
185 struct p2p_srv_bonjour {
187 struct wpabuf *query;
191 struct p2p_srv_upnp {
198 * struct wpa_global - Internal, global data for all %wpa_supplicant interfaces
200 * This structure is initialized by calling wpa_supplicant_init() when starting
204 struct wpa_supplicant *ifaces;
205 struct wpa_params params;
206 struct ctrl_iface_global_priv *ctrl_iface;
207 struct wpas_dbus_priv *dbus;
210 struct os_time suspend_time;
211 struct p2p_data *p2p;
212 struct wpa_supplicant *p2p_group_formation;
213 u8 p2p_dev_addr[ETH_ALEN];
214 struct dl_list p2p_srv_bonjour; /* struct p2p_srv_bonjour */
215 struct dl_list p2p_srv_upnp; /* struct p2p_srv_upnp */
217 int cross_connection;
221 struct wpa_client_mlme {
222 #ifdef CONFIG_CLIENT_MLME
224 IEEE80211_DISABLED, IEEE80211_AUTHENTICATE,
225 IEEE80211_ASSOCIATE, IEEE80211_ASSOCIATED,
226 IEEE80211_IBSS_SEARCH, IEEE80211_IBSS_JOINED
228 u8 prev_bssid[ETH_ALEN];
233 u8 *extra_ie; /* to be added to the end of AssocReq */
235 u8 *extra_probe_ie; /* to be added to the end of ProbeReq */
236 size_t extra_probe_ie_len;
237 enum wpa_key_mgmt key_mgmt;
239 /* The last AssocReq/Resp IEs */
240 u8 *assocreq_ies, *assocresp_ies;
241 size_t assocreq_ies_len, assocresp_ies_len;
243 int auth_tries, assoc_tries;
245 unsigned int ssid_set:1;
246 unsigned int bssid_set:1;
247 unsigned int prev_bssid_set:1;
248 unsigned int authenticated:1;
249 unsigned int associated:1;
250 unsigned int probereq_poll:1;
251 unsigned int use_protection:1;
252 unsigned int create_ibss:1;
253 unsigned int mixed_cell:1;
254 unsigned int wmm_enabled:1;
256 struct os_time last_probe;
258 unsigned int auth_algs; /* bitfield of allowed auth algs
259 * (WPA_AUTH_ALG_*) */
260 int auth_alg; /* currently used IEEE 802.11 authentication algorithm */
261 int auth_transaction;
263 struct os_time ibss_join_req;
264 u8 *probe_resp; /* ProbeResp template for IBSS */
265 size_t probe_resp_len;
268 int wmm_last_param_set;
271 int scan_hw_mode_idx;
272 int scan_channel_idx;
273 enum { SCAN_SET_CHANNEL, SCAN_SEND_PROBE } scan_state;
274 struct os_time last_scan_completed;
275 int scan_oper_channel;
277 int scan_oper_phymode;
279 size_t scan_ssid_len;
283 struct ieee80211_sta_bss *sta_bss_list;
284 #define STA_HASH_SIZE 256
285 #define STA_HASH(sta) (sta[5])
286 struct ieee80211_sta_bss *sta_bss_hash[STA_HASH_SIZE];
288 int cts_protect_erp_frames;
290 enum hostapd_hw_mode phymode; /* current mode */
291 struct hostapd_hw_modes *modes;
293 unsigned int hw_modes; /* bitfield of allowed hardware modes;
294 * (1 << HOSTAPD_MODE_*) */
297 int freq; /* The current frequency in MHz */
298 int channel; /* The current IEEE 802.11 channel number */
300 #ifdef CONFIG_IEEE80211R
304 #endif /* CONFIG_IEEE80211R */
306 void (*public_action_cb)(void *ctx, const u8 *buf, size_t len,
308 void *public_action_cb_ctx;
310 #else /* CONFIG_CLIENT_MLME */
311 int dummy; /* to keep MSVC happy */
312 #endif /* CONFIG_CLIENT_MLME */
316 * struct wpa_supplicant - Internal data for wpa_supplicant interface
318 * This structure contains the internal data for core wpa_supplicant code. This
319 * should be only used directly from the core code. However, a pointer to this
320 * data is used from other files as an arbitrary context pointer in calls to
323 struct wpa_supplicant {
324 struct wpa_global *global;
325 struct wpa_supplicant *parent;
326 struct wpa_supplicant *next;
327 struct l2_packet_data *l2;
328 struct l2_packet_data *l2_br;
329 unsigned char own_addr[ETH_ALEN];
331 #ifdef CONFIG_CTRL_IFACE_DBUS
333 #endif /* CONFIG_CTRL_IFACE_DBUS */
334 #ifdef CONFIG_CTRL_IFACE_DBUS_NEW
336 #endif /* CONFIG_CTRL_IFACE_DBUS_NEW */
337 char bridge_ifname[16];
340 struct wpa_config *conf;
342 os_time_t last_michael_mic_error;
344 u8 pending_bssid[ETH_ALEN]; /* If wpa_state == WPA_ASSOCIATING, this
345 * field contains the targer BSSID. */
346 int reassociate; /* reassociation requested */
347 int disconnected; /* all connections disabled; i.e., do no reassociate
348 * before this has been cleared */
349 struct wpa_ssid *current_ssid;
350 struct wpa_bss *current_bss;
351 int ap_ies_from_associnfo;
352 unsigned int assoc_freq;
354 /* Selected configuration (based on Beacon/ProbeResp WPA IE) */
358 int mgmt_group_cipher;
360 void *drv_priv; /* private data used by driver_ops */
361 void *global_drv_priv;
363 struct wpa_ssid *prev_scan_ssid; /* previously scanned SSID;
364 * NULL = not yet initialized (start
365 * with wildcard SSID)
366 * WILDCARD_SSID_SCAN = wildcard
367 * SSID was used in the previous scan
369 #define WILDCARD_SSID_SCAN ((struct wpa_ssid *) 1)
371 void (*scan_res_handler)(struct wpa_supplicant *wpa_s,
372 struct wpa_scan_results *scan_res);
373 struct dl_list bss; /* struct wpa_bss::list */
374 struct dl_list bss_id; /* struct wpa_bss::list_id */
376 unsigned int bss_update_idx;
377 unsigned int bss_next_id;
379 struct wpa_driver_ops *driver;
380 int interface_removed; /* whether the network interface has been
383 struct eapol_sm *eapol;
385 struct ctrl_iface_priv *ctrl_iface;
387 enum wpa_states wpa_state;
390 int reassociated_connection;
392 int eapol_received; /* number of EAPOL packets received after the
393 * previous association event */
395 struct scard_data *scard;
397 unsigned char last_eapol_src[ETH_ALEN];
401 struct wpa_blacklist *blacklist;
403 int scan_req; /* manual scan request; this forces a scan even if there
404 * are no enabled networks in the configuration */
405 int scan_runs; /* number of scan runs since WPS was started */
407 struct wpa_client_mlme mlme;
408 unsigned int drv_flags;
410 unsigned int max_remain_on_chan;
411 unsigned int max_stations;
413 int pending_mic_error_report;
414 int pending_mic_error_pairwise;
415 int mic_errors_seen; /* Michael MIC errors with the current PTK */
417 struct wps_context *wps;
418 int wps_success; /* WPS success event received */
419 struct wps_er *wps_er;
420 int blacklist_cleared;
422 struct wpabuf *pending_eapol_rx;
423 struct os_time pending_eapol_rx_time;
424 u8 pending_eapol_rx_src[ETH_ALEN];
426 struct ibss_rsn *ibss_rsn;
438 u8 assoc_req_ie[200];
439 size_t assoc_req_ie_len;
442 u8 mobility_domain[2];
445 u8 prev_bssid[ETH_ALEN];
449 #endif /* CONFIG_SME */
452 struct hostapd_iface *ap_iface;
453 void (*ap_configured_cb)(void *ctx, void *data);
454 void *ap_configured_cb_ctx;
455 void *ap_configured_cb_data;
456 #endif /* CONFIG_AP */
459 struct p2p_go_neg_results *go_params;
460 int create_p2p_iface;
461 u8 pending_interface_addr[ETH_ALEN];
462 char pending_interface_name[IFNAMSIZ];
463 int pending_interface_type;
465 unsigned int off_channel_freq;
466 struct wpabuf *pending_action_tx;
467 u8 pending_action_src[ETH_ALEN];
468 u8 pending_action_dst[ETH_ALEN];
469 u8 pending_action_bssid[ETH_ALEN];
470 unsigned int pending_action_freq;
471 int pending_action_without_roc;
472 unsigned int pending_listen_freq;
473 unsigned int pending_listen_duration;
475 NOT_P2P_GROUP_INTERFACE,
476 P2P_GROUP_INTERFACE_PENDING,
477 P2P_GROUP_INTERFACE_GO,
478 P2P_GROUP_INTERFACE_CLIENT
479 } p2p_group_interface;
480 struct p2p_group *p2p_group;
484 u8 p2p_auth_invite[ETH_ALEN];
485 int p2p_sd_over_ctrl_iface;
486 int p2p_in_provisioning;
487 int pending_invite_ssid_id;
488 int show_group_started;
489 u8 go_dev_addr[ETH_ALEN];
490 int pending_pd_before_join;
491 u8 pending_join_iface_addr[ETH_ALEN];
492 u8 pending_join_dev_addr[ETH_ALEN];
493 int pending_join_wps_method;
494 unsigned int roc_waiting_drv_freq;
498 * Whether cross connection is disallowed by the AP to which this
499 * interface is associated (only valid if there is an association).
501 int cross_connect_disallowed;
504 * Whether this P2P group is configured to use cross connection (only
505 * valid if this is P2P GO interface). The actual cross connect packet
506 * forwarding may not be configured depending on the uplink status.
508 int cross_connect_enabled;
510 /* Whether cross connection forwarding is in use at the moment. */
511 int cross_connect_in_use;
514 * Uplink interface name for cross connection
516 char cross_connect_uplink[100];
517 #endif /* CONFIG_P2P */
519 struct wpa_ssid *bgscan_ssid;
520 const struct bgscan_ops *bgscan;
523 int connect_without_scan;
526 unsigned int wps_freq;
527 int wps_fragment_size;
528 int auto_reconnect_disabled;
532 /* wpa_supplicant.c */
533 int wpa_set_wep_keys(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid);
535 int wpa_supplicant_reload_configuration(struct wpa_supplicant *wpa_s);
537 const char * wpa_supplicant_state_txt(enum wpa_states state);
538 int wpa_supplicant_driver_init(struct wpa_supplicant *wpa_s);
539 int wpa_supplicant_set_suites(struct wpa_supplicant *wpa_s,
540 struct wpa_bss *bss, struct wpa_ssid *ssid,
541 u8 *wpa_ie, size_t *wpa_ie_len);
542 void wpa_supplicant_associate(struct wpa_supplicant *wpa_s,
544 struct wpa_ssid *ssid);
545 void wpa_supplicant_set_non_wpa_policy(struct wpa_supplicant *wpa_s,
546 struct wpa_ssid *ssid);
547 void wpa_supplicant_initiate_eapol(struct wpa_supplicant *wpa_s);
548 void wpa_clear_keys(struct wpa_supplicant *wpa_s, const u8 *addr);
549 void wpa_supplicant_req_auth_timeout(struct wpa_supplicant *wpa_s,
551 void wpa_supplicant_set_state(struct wpa_supplicant *wpa_s,
552 enum wpa_states state);
553 struct wpa_ssid * wpa_supplicant_get_ssid(struct wpa_supplicant *wpa_s);
554 void wpa_supplicant_cancel_auth_timeout(struct wpa_supplicant *wpa_s);
555 void wpa_supplicant_deauthenticate(struct wpa_supplicant *wpa_s,
557 void wpa_supplicant_disassociate(struct wpa_supplicant *wpa_s,
560 void wpa_supplicant_enable_network(struct wpa_supplicant *wpa_s,
561 struct wpa_ssid *ssid);
562 void wpa_supplicant_disable_network(struct wpa_supplicant *wpa_s,
563 struct wpa_ssid *ssid);
564 void wpa_supplicant_select_network(struct wpa_supplicant *wpa_s,
565 struct wpa_ssid *ssid);
566 int wpa_supplicant_set_ap_scan(struct wpa_supplicant *wpa_s,
568 int wpa_supplicant_set_debug_params(struct wpa_global *global,
569 int debug_level, int debug_timestamp,
570 int debug_show_keys);
572 void wpa_show_license(void);
574 struct wpa_supplicant * wpa_supplicant_add_iface(struct wpa_global *global,
575 struct wpa_interface *iface);
576 int wpa_supplicant_remove_iface(struct wpa_global *global,
577 struct wpa_supplicant *wpa_s);
578 struct wpa_supplicant * wpa_supplicant_get_iface(struct wpa_global *global,
580 struct wpa_global * wpa_supplicant_init(struct wpa_params *params);
581 int wpa_supplicant_run(struct wpa_global *global);
582 void wpa_supplicant_deinit(struct wpa_global *global);
584 int wpa_supplicant_scard_init(struct wpa_supplicant *wpa_s,
585 struct wpa_ssid *ssid);
586 void wpa_supplicant_terminate_proc(struct wpa_global *global);
587 void wpa_supplicant_rx_eapol(void *ctx, const u8 *src_addr,
588 const u8 *buf, size_t len);
589 enum wpa_key_mgmt key_mgmt2driver(int key_mgmt);
590 enum wpa_cipher cipher_suite2driver(int cipher);
591 void wpa_supplicant_update_config(struct wpa_supplicant *wpa_s);
592 void wpa_supplicant_clear_status(struct wpa_supplicant *wpa_s);
595 void wpa_supplicant_mark_disassoc(struct wpa_supplicant *wpa_s);
596 void wpa_supplicant_connect(struct wpa_supplicant *wpa_s,
597 struct wpa_bss *selected,
598 struct wpa_ssid *ssid);
601 int eap_register_methods(void);
603 #endif /* WPA_SUPPLICANT_I_H */