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"
20 #include "config_ssid.h"
22 extern const char *wpa_supplicant_version;
23 extern const char *wpa_supplicant_license;
24 #ifndef CONFIG_NO_STDOUT_DEBUG
25 extern const char *wpa_supplicant_full_license1;
26 extern const char *wpa_supplicant_full_license2;
27 extern const char *wpa_supplicant_full_license3;
28 extern const char *wpa_supplicant_full_license4;
29 extern const char *wpa_supplicant_full_license5;
30 #endif /* CONFIG_NO_STDOUT_DEBUG */
33 struct wpa_supplicant;
37 struct wpa_scan_results;
38 struct hostapd_hw_modes;
39 struct wpa_driver_associate_params;
42 * Forward declarations of private structures used within the ctrl_iface
43 * backends. Other parts of wpa_supplicant do not have access to data stored in
46 struct ctrl_iface_priv;
47 struct ctrl_iface_global_priv;
48 struct wpas_dbus_priv;
51 * struct wpa_interface - Parameters for wpa_supplicant_add_iface()
53 struct wpa_interface {
55 * confname - Configuration name (file or profile) name
57 * This can also be %NULL when a configuration file is not used. In
58 * that case, ctrl_interface must be set to allow the interface to be
64 * ctrl_interface - Control interface parameter
66 * If a configuration file is not used, this variable can be used to
67 * set the ctrl_interface parameter that would have otherwise been read
68 * from the configuration file. If both confname and ctrl_interface are
69 * set, ctrl_interface is used to override the value from configuration
72 const char *ctrl_interface;
75 * driver - Driver interface name, or %NULL to use the default driver
80 * driver_param - Driver interface parameters
82 * If a configuration file is not used, this variable can be used to
83 * set the driver_param parameters that would have otherwise been read
84 * from the configuration file. If both confname and driver_param are
85 * set, driver_param is used to override the value from configuration
88 const char *driver_param;
91 * ifname - Interface name
96 * bridge_ifname - Optional bridge interface name
98 * If the driver interface (ifname) is included in a Linux bridge
99 * device, the bridge interface may need to be used for receiving EAPOL
100 * frames. This can be enabled by setting this variable to enable
101 * receiving of EAPOL frames from an additional interface.
103 const char *bridge_ifname;
107 * struct wpa_params - Parameters for wpa_supplicant_init()
111 * daemonize - Run %wpa_supplicant in the background
116 * wait_for_monitor - Wait for a monitor program before starting
118 int wait_for_monitor;
121 * pid_file - Path to a PID (process ID) file
123 * If this and daemonize are set, process ID of the background process
124 * will be written to the specified file.
129 * wpa_debug_level - Debugging verbosity level (e.g., MSG_INFO)
134 * wpa_debug_show_keys - Whether keying material is included in debug
136 * This parameter can be used to allow keying material to be included
137 * in debug messages. This is a security risk and this option should
138 * not be enabled in normal configuration. If needed during
139 * development or while troubleshooting, this option can provide more
140 * details for figuring out what is happening.
142 int wpa_debug_show_keys;
145 * wpa_debug_timestamp - Whether to include timestamp in debug messages
147 int wpa_debug_timestamp;
150 * ctrl_interface - Global ctrl_iface path/parameter
152 char *ctrl_interface;
155 * dbus_ctrl_interface - Enable the DBus control interface
157 int dbus_ctrl_interface;
160 * wpa_debug_file_path - Path of debug file or %NULL to use stdout
162 const char *wpa_debug_file_path;
165 * wpa_debug_syslog - Enable log output through syslog
167 int wpa_debug_syslog;
170 * override_driver - Optional driver parameter override
172 * This parameter can be used to override the driver parameter in
173 * dynamic interface addition to force a specific driver wrapper to be
176 char *override_driver;
179 * override_ctrl_interface - Optional ctrl_interface override
181 * This parameter can be used to override the ctrl_interface parameter
182 * in dynamic interface addition to force a control interface to be
185 char *override_ctrl_interface;
188 * entropy_file - Optional entropy file
190 * This parameter can be used to configure wpa_supplicant to maintain
191 * its internal entropy store over restarts.
196 struct p2p_srv_bonjour {
198 struct wpabuf *query;
202 struct p2p_srv_upnp {
209 * struct wpa_global - Internal, global data for all %wpa_supplicant interfaces
211 * This structure is initialized by calling wpa_supplicant_init() when starting
215 struct wpa_supplicant *ifaces;
216 struct wpa_params params;
217 struct ctrl_iface_global_priv *ctrl_iface;
218 struct wpas_dbus_priv *dbus;
221 struct os_time suspend_time;
222 struct p2p_data *p2p;
223 struct wpa_supplicant *p2p_group_formation;
224 u8 p2p_dev_addr[ETH_ALEN];
225 struct dl_list p2p_srv_bonjour; /* struct p2p_srv_bonjour */
226 struct dl_list p2p_srv_upnp; /* struct p2p_srv_upnp */
228 int cross_connection;
232 enum offchannel_send_action_result {
233 OFFCHANNEL_SEND_ACTION_SUCCESS /* Frame was send and acknowledged */,
234 OFFCHANNEL_SEND_ACTION_NO_ACK /* Frame was sent, but not acknowledged
236 OFFCHANNEL_SEND_ACTION_FAILED /* Frame was not sent due to a failure */
240 * struct wpa_supplicant - Internal data for wpa_supplicant interface
242 * This structure contains the internal data for core wpa_supplicant code. This
243 * should be only used directly from the core code. However, a pointer to this
244 * data is used from other files as an arbitrary context pointer in calls to
247 struct wpa_supplicant {
248 struct wpa_global *global;
249 struct wpa_supplicant *parent;
250 struct wpa_supplicant *next;
251 struct l2_packet_data *l2;
252 struct l2_packet_data *l2_br;
253 unsigned char own_addr[ETH_ALEN];
255 #ifdef CONFIG_CTRL_IFACE_DBUS
257 #endif /* CONFIG_CTRL_IFACE_DBUS */
258 #ifdef CONFIG_CTRL_IFACE_DBUS_NEW
260 char *dbus_groupobj_path;
261 #endif /* CONFIG_CTRL_IFACE_DBUS_NEW */
262 char bridge_ifname[16];
265 struct wpa_config *conf;
267 os_time_t last_michael_mic_error;
269 u8 pending_bssid[ETH_ALEN]; /* If wpa_state == WPA_ASSOCIATING, this
270 * field contains the target BSSID. */
271 int reassociate; /* reassociation requested */
272 int disconnected; /* all connections disabled; i.e., do no reassociate
273 * before this has been cleared */
274 struct wpa_ssid *current_ssid;
275 struct wpa_bss *current_bss;
276 int ap_ies_from_associnfo;
277 unsigned int assoc_freq;
279 /* Selected configuration (based on Beacon/ProbeResp WPA IE) */
284 int mgmt_group_cipher;
286 void *drv_priv; /* private data used by driver_ops */
287 void *global_drv_priv;
289 /* previous scan was wildcard when interleaving between
290 * wildcard scans and specific SSID scan when max_ssids=1 */
291 int prev_scan_wildcard;
292 struct wpa_ssid *prev_scan_ssid; /* previously scanned SSID;
293 * NULL = not yet initialized (start
294 * with wildcard SSID)
295 * WILDCARD_SSID_SCAN = wildcard
296 * SSID was used in the previous scan
298 #define WILDCARD_SSID_SCAN ((struct wpa_ssid *) 1)
300 struct wpa_ssid *prev_sched_ssid; /* last SSID used in sched scan */
301 int sched_scan_timeout;
302 int sched_scan_interval;
303 int first_sched_scan;
304 int sched_scan_timed_out;
306 void (*scan_res_handler)(struct wpa_supplicant *wpa_s,
307 struct wpa_scan_results *scan_res);
308 struct dl_list bss; /* struct wpa_bss::list */
309 struct dl_list bss_id; /* struct wpa_bss::list_id */
311 unsigned int bss_update_idx;
312 unsigned int bss_next_id;
314 struct wpa_driver_ops *driver;
315 int interface_removed; /* whether the network interface has been
318 struct eapol_sm *eapol;
320 struct ctrl_iface_priv *ctrl_iface;
322 enum wpa_states wpa_state;
326 int reassociated_connection;
328 int eapol_received; /* number of EAPOL packets received after the
329 * previous association event */
331 struct scard_data *scard;
333 unsigned char last_eapol_src[ETH_ALEN];
337 struct wpa_blacklist *blacklist;
339 int scan_req; /* manual scan request; this forces a scan even if there
340 * are no enabled networks in the configuration */
341 int scan_runs; /* number of scan runs since WPS was started */
342 int *next_scan_freqs;
343 int scan_interval; /* time in sec between scans to find suitable AP */
344 int normal_scans; /* normal scans run before sched_scan */
346 unsigned int drv_flags;
349 * A bitmap of supported protocols for probe response offload. See
350 * struct wpa_driver_capa in driver.h
352 unsigned int probe_resp_offloads;
355 int max_sched_scan_ssids;
356 int sched_scan_supported;
357 unsigned int max_match_sets;
358 unsigned int max_remain_on_chan;
359 unsigned int max_stations;
361 int pending_mic_error_report;
362 int pending_mic_error_pairwise;
363 int mic_errors_seen; /* Michael MIC errors with the current PTK */
365 struct wps_context *wps;
366 int wps_success; /* WPS success event received */
367 struct wps_er *wps_er;
368 int blacklist_cleared;
370 struct wpabuf *pending_eapol_rx;
371 struct os_time pending_eapol_rx_time;
372 u8 pending_eapol_rx_src[ETH_ALEN];
374 struct ibss_rsn *ibss_rsn;
386 u8 assoc_req_ie[200];
387 size_t assoc_req_ie_len;
390 u8 mobility_domain[2];
393 u8 prev_bssid[ETH_ALEN];
398 int sa_query_count; /* number of pending SA Query requests;
399 * 0 = no SA Query in progress */
400 int sa_query_timed_out;
401 u8 *sa_query_trans_id; /* buffer of WLAN_SA_QUERY_TR_ID_LEN *
402 * sa_query_count octets of pending
403 * SA Query transaction identifiers */
404 struct os_time sa_query_start;
406 #endif /* CONFIG_SME */
409 struct hostapd_iface *ap_iface;
410 void (*ap_configured_cb)(void *ctx, void *data);
411 void *ap_configured_cb_ctx;
412 void *ap_configured_cb_data;
413 #endif /* CONFIG_AP */
415 unsigned int off_channel_freq;
416 struct wpabuf *pending_action_tx;
417 u8 pending_action_src[ETH_ALEN];
418 u8 pending_action_dst[ETH_ALEN];
419 u8 pending_action_bssid[ETH_ALEN];
420 unsigned int pending_action_freq;
421 int pending_action_no_cck;
422 int pending_action_without_roc;
423 void (*pending_action_tx_status_cb)(struct wpa_supplicant *wpa_s,
424 unsigned int freq, const u8 *dst,
425 const u8 *src, const u8 *bssid,
426 const u8 *data, size_t data_len,
427 enum offchannel_send_action_result
429 unsigned int roc_waiting_drv_freq;
430 int action_tx_wait_time;
433 struct p2p_go_neg_results *go_params;
434 int create_p2p_iface;
435 u8 pending_interface_addr[ETH_ALEN];
436 char pending_interface_name[100];
437 int pending_interface_type;
439 unsigned int pending_listen_freq;
440 unsigned int pending_listen_duration;
442 NOT_P2P_GROUP_INTERFACE,
443 P2P_GROUP_INTERFACE_PENDING,
444 P2P_GROUP_INTERFACE_GO,
445 P2P_GROUP_INTERFACE_CLIENT
446 } p2p_group_interface;
447 struct p2p_group *p2p_group;
448 int p2p_long_listen; /* remaining time in long Listen state in ms */
451 u8 p2p_auth_invite[ETH_ALEN];
452 int p2p_sd_over_ctrl_iface;
453 int p2p_in_provisioning;
454 int pending_invite_ssid_id;
455 int show_group_started;
456 u8 go_dev_addr[ETH_ALEN];
457 int pending_pd_before_join;
458 u8 pending_join_iface_addr[ETH_ALEN];
459 u8 pending_join_dev_addr[ETH_ALEN];
460 int pending_join_wps_method;
461 int p2p_join_scan_count;
465 * Whether cross connection is disallowed by the AP to which this
466 * interface is associated (only valid if there is an association).
468 int cross_connect_disallowed;
471 * Whether this P2P group is configured to use cross connection (only
472 * valid if this is P2P GO interface). The actual cross connect packet
473 * forwarding may not be configured depending on the uplink status.
475 int cross_connect_enabled;
477 /* Whether cross connection forwarding is in use at the moment. */
478 int cross_connect_in_use;
481 * Uplink interface name for cross connection
483 char cross_connect_uplink[100];
486 P2P_GROUP_REMOVAL_UNKNOWN,
487 P2P_GROUP_REMOVAL_REQUESTED,
488 P2P_GROUP_REMOVAL_IDLE_TIMEOUT,
489 P2P_GROUP_REMOVAL_UNAVAILABLE
492 unsigned int p2p_cb_on_scan_complete:1;
493 #endif /* CONFIG_P2P */
495 struct wpa_ssid *bgscan_ssid;
496 const struct bgscan_ops *bgscan;
499 struct wpa_ssid *connect_without_scan;
503 unsigned int wps_freq;
504 int wps_fragment_size;
505 int auto_reconnect_disabled;
507 /* Channel preferences for AP/P2P GO use */
510 int best_overall_freq;
512 struct gas_query *gas;
514 #ifdef CONFIG_INTERWORKING
515 unsigned int fetch_anqp_in_progress:1;
516 unsigned int network_select:1;
517 unsigned int auto_select:1;
518 #endif /* CONFIG_INTERWORKING */
519 unsigned int drv_capa_known;
522 struct hostapd_hw_modes *modes;
531 /* wpa_supplicant.c */
532 void wpa_supplicant_apply_ht_overrides(
533 struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid,
534 struct wpa_driver_associate_params *params);
536 int wpa_set_wep_keys(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid);
538 int wpa_supplicant_reload_configuration(struct wpa_supplicant *wpa_s);
540 const char * wpa_supplicant_state_txt(enum wpa_states state);
541 int wpa_supplicant_update_mac_addr(struct wpa_supplicant *wpa_s);
542 int wpa_supplicant_driver_init(struct wpa_supplicant *wpa_s);
543 int wpa_supplicant_set_suites(struct wpa_supplicant *wpa_s,
544 struct wpa_bss *bss, struct wpa_ssid *ssid,
545 u8 *wpa_ie, size_t *wpa_ie_len);
546 void wpa_supplicant_associate(struct wpa_supplicant *wpa_s,
548 struct wpa_ssid *ssid);
549 void wpa_supplicant_set_non_wpa_policy(struct wpa_supplicant *wpa_s,
550 struct wpa_ssid *ssid);
551 void wpa_supplicant_initiate_eapol(struct wpa_supplicant *wpa_s);
552 void wpa_clear_keys(struct wpa_supplicant *wpa_s, const u8 *addr);
553 void wpa_supplicant_req_auth_timeout(struct wpa_supplicant *wpa_s,
555 void wpa_supplicant_set_state(struct wpa_supplicant *wpa_s,
556 enum wpa_states state);
557 struct wpa_ssid * wpa_supplicant_get_ssid(struct wpa_supplicant *wpa_s);
558 const char * wpa_supplicant_get_eap_mode(struct wpa_supplicant *wpa_s);
559 void wpa_supplicant_cancel_auth_timeout(struct wpa_supplicant *wpa_s);
560 void wpa_supplicant_deauthenticate(struct wpa_supplicant *wpa_s,
562 void wpa_supplicant_disassociate(struct wpa_supplicant *wpa_s,
565 void wpa_supplicant_enable_network(struct wpa_supplicant *wpa_s,
566 struct wpa_ssid *ssid);
567 void wpa_supplicant_disable_network(struct wpa_supplicant *wpa_s,
568 struct wpa_ssid *ssid);
569 void wpa_supplicant_select_network(struct wpa_supplicant *wpa_s,
570 struct wpa_ssid *ssid);
571 int wpa_supplicant_set_ap_scan(struct wpa_supplicant *wpa_s,
573 int wpa_supplicant_set_bss_expiration_age(struct wpa_supplicant *wpa_s,
574 unsigned int expire_age);
575 int wpa_supplicant_set_bss_expiration_count(struct wpa_supplicant *wpa_s,
576 unsigned int expire_count);
577 int wpa_supplicant_set_debug_params(struct wpa_global *global,
578 int debug_level, int debug_timestamp,
579 int debug_show_keys);
581 void wpa_show_license(void);
583 struct wpa_supplicant * wpa_supplicant_add_iface(struct wpa_global *global,
584 struct wpa_interface *iface);
585 int wpa_supplicant_remove_iface(struct wpa_global *global,
586 struct wpa_supplicant *wpa_s,
588 struct wpa_supplicant * wpa_supplicant_get_iface(struct wpa_global *global,
590 struct wpa_global * wpa_supplicant_init(struct wpa_params *params);
591 int wpa_supplicant_run(struct wpa_global *global);
592 void wpa_supplicant_deinit(struct wpa_global *global);
594 int wpa_supplicant_scard_init(struct wpa_supplicant *wpa_s,
595 struct wpa_ssid *ssid);
596 void wpa_supplicant_terminate_proc(struct wpa_global *global);
597 void wpa_supplicant_rx_eapol(void *ctx, const u8 *src_addr,
598 const u8 *buf, size_t len);
599 enum wpa_key_mgmt key_mgmt2driver(int key_mgmt);
600 enum wpa_cipher cipher_suite2driver(int cipher);
601 void wpa_supplicant_update_config(struct wpa_supplicant *wpa_s);
602 void wpa_supplicant_clear_status(struct wpa_supplicant *wpa_s);
603 void wpas_connection_failed(struct wpa_supplicant *wpa_s, const u8 *bssid);
604 int wpas_driver_bss_selection(struct wpa_supplicant *wpa_s);
607 void wpa_supplicant_mark_disassoc(struct wpa_supplicant *wpa_s);
608 int wpa_supplicant_connect(struct wpa_supplicant *wpa_s,
609 struct wpa_bss *selected,
610 struct wpa_ssid *ssid);
611 void wpa_supplicant_stop_countermeasures(void *eloop_ctx, void *sock_ctx);
612 void wpa_supplicant_delayed_mic_error_report(void *eloop_ctx, void *sock_ctx);
615 int eap_register_methods(void);
618 * Utility method to tell if a given network is a persistent group
619 * @ssid: Network object
620 * Returns: 1 if network is a persistent group, 0 otherwise
622 static inline int network_is_persistent_group(struct wpa_ssid *ssid)
624 return ((ssid->disabled == 2) || ssid->p2p_persistent_group);
627 #endif /* WPA_SUPPLICANT_I_H */