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
;
41 * Forward declarations of private structures used within the ctrl_iface
42 * backends. Other parts of wpa_supplicant do not have access to data stored in
45 struct ctrl_iface_priv
;
46 struct ctrl_iface_global_priv
;
47 struct wpas_dbus_priv
;
50 * struct wpa_interface - Parameters for wpa_supplicant_add_iface()
52 struct wpa_interface
{
54 * confname - Configuration name (file or profile) name
56 * This can also be %NULL when a configuration file is not used. In
57 * that case, ctrl_interface must be set to allow the interface to be
63 * ctrl_interface - Control interface parameter
65 * If a configuration file is not used, this variable can be used to
66 * set the ctrl_interface parameter that would have otherwise been read
67 * from the configuration file. If both confname and ctrl_interface are
68 * set, ctrl_interface is used to override the value from configuration
71 const char *ctrl_interface
;
74 * driver - Driver interface name, or %NULL to use the default driver
79 * driver_param - Driver interface parameters
81 * If a configuration file is not used, this variable can be used to
82 * set the driver_param parameters that would have otherwise been read
83 * from the configuration file. If both confname and driver_param are
84 * set, driver_param is used to override the value from configuration
87 const char *driver_param
;
90 * ifname - Interface name
95 * bridge_ifname - Optional bridge interface name
97 * If the driver interface (ifname) is included in a Linux bridge
98 * device, the bridge interface may need to be used for receiving EAPOL
99 * frames. This can be enabled by setting this variable to enable
100 * receiving of EAPOL frames from an additional interface.
102 const char *bridge_ifname
;
106 * struct wpa_params - Parameters for wpa_supplicant_init()
110 * daemonize - Run %wpa_supplicant in the background
115 * wait_for_monitor - Wait for a monitor program before starting
117 int wait_for_monitor
;
120 * pid_file - Path to a PID (process ID) file
122 * If this and daemonize are set, process ID of the background process
123 * will be written to the specified file.
128 * wpa_debug_level - Debugging verbosity level (e.g., MSG_INFO)
133 * wpa_debug_show_keys - Whether keying material is included in debug
135 * This parameter can be used to allow keying material to be included
136 * in debug messages. This is a security risk and this option should
137 * not be enabled in normal configuration. If needed during
138 * development or while troubleshooting, this option can provide more
139 * details for figuring out what is happening.
141 int wpa_debug_show_keys
;
144 * wpa_debug_timestamp - Whether to include timestamp in debug messages
146 int wpa_debug_timestamp
;
149 * ctrl_interface - Global ctrl_iface path/parameter
151 char *ctrl_interface
;
154 * dbus_ctrl_interface - Enable the DBus control interface
156 int dbus_ctrl_interface
;
159 * wpa_debug_file_path - Path of debug file or %NULL to use stdout
161 const char *wpa_debug_file_path
;
164 * wpa_debug_syslog - Enable log output through syslog
166 int wpa_debug_syslog
;
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
{
208 * struct wpa_global - Internal, global data for all %wpa_supplicant interfaces
210 * This structure is initialized by calling wpa_supplicant_init() when starting
214 struct wpa_supplicant
*ifaces
;
215 struct wpa_params params
;
216 struct ctrl_iface_global_priv
*ctrl_iface
;
217 struct wpas_dbus_priv
*dbus
;
220 struct os_time suspend_time
;
221 struct p2p_data
*p2p
;
222 struct wpa_supplicant
*p2p_group_formation
;
223 u8 p2p_dev_addr
[ETH_ALEN
];
224 struct dl_list p2p_srv_bonjour
; /* struct p2p_srv_bonjour */
225 struct dl_list p2p_srv_upnp
; /* struct p2p_srv_upnp */
227 int cross_connection
;
231 enum offchannel_send_action_result
{
232 OFFCHANNEL_SEND_ACTION_SUCCESS
/* Frame was send and acknowledged */,
233 OFFCHANNEL_SEND_ACTION_NO_ACK
/* Frame was sent, but not acknowledged
235 OFFCHANNEL_SEND_ACTION_FAILED
/* Frame was not sent due to a failure */
239 * struct wpa_supplicant - Internal data for wpa_supplicant interface
241 * This structure contains the internal data for core wpa_supplicant code. This
242 * should be only used directly from the core code. However, a pointer to this
243 * data is used from other files as an arbitrary context pointer in calls to
246 struct wpa_supplicant
{
247 struct wpa_global
*global
;
248 struct wpa_supplicant
*parent
;
249 struct wpa_supplicant
*next
;
250 struct l2_packet_data
*l2
;
251 struct l2_packet_data
*l2_br
;
252 unsigned char own_addr
[ETH_ALEN
];
254 #ifdef CONFIG_CTRL_IFACE_DBUS
256 #endif /* CONFIG_CTRL_IFACE_DBUS */
257 #ifdef CONFIG_CTRL_IFACE_DBUS_NEW
259 char *dbus_groupobj_path
;
260 #endif /* CONFIG_CTRL_IFACE_DBUS_NEW */
261 char bridge_ifname
[16];
264 struct wpa_config
*conf
;
266 os_time_t last_michael_mic_error
;
268 u8 pending_bssid
[ETH_ALEN
]; /* If wpa_state == WPA_ASSOCIATING, this
269 * field contains the target BSSID. */
270 int reassociate
; /* reassociation requested */
271 int disconnected
; /* all connections disabled; i.e., do no reassociate
272 * before this has been cleared */
273 struct wpa_ssid
*current_ssid
;
274 struct wpa_bss
*current_bss
;
275 int ap_ies_from_associnfo
;
276 unsigned int assoc_freq
;
278 /* Selected configuration (based on Beacon/ProbeResp WPA IE) */
283 int mgmt_group_cipher
;
285 void *drv_priv
; /* private data used by driver_ops */
286 void *global_drv_priv
;
288 struct wpa_ssid
*prev_scan_ssid
; /* previously scanned SSID;
289 * NULL = not yet initialized (start
290 * with wildcard SSID)
291 * WILDCARD_SSID_SCAN = wildcard
292 * SSID was used in the previous scan
294 #define WILDCARD_SSID_SCAN ((struct wpa_ssid *) 1)
296 struct wpa_ssid
*prev_sched_ssid
; /* last SSID used in sched scan */
297 int sched_scan_timeout
;
298 int sched_scan_interval
;
299 int first_sched_scan
;
300 int sched_scan_timed_out
;
302 void (*scan_res_handler
)(struct wpa_supplicant
*wpa_s
,
303 struct wpa_scan_results
*scan_res
);
304 struct dl_list bss
; /* struct wpa_bss::list */
305 struct dl_list bss_id
; /* struct wpa_bss::list_id */
307 unsigned int bss_update_idx
;
308 unsigned int bss_next_id
;
310 struct wpa_driver_ops
*driver
;
311 int interface_removed
; /* whether the network interface has been
314 struct eapol_sm
*eapol
;
316 struct ctrl_iface_priv
*ctrl_iface
;
318 enum wpa_states wpa_state
;
322 int reassociated_connection
;
324 int eapol_received
; /* number of EAPOL packets received after the
325 * previous association event */
327 struct scard_data
*scard
;
329 unsigned char last_eapol_src
[ETH_ALEN
];
333 struct wpa_blacklist
*blacklist
;
335 int scan_req
; /* manual scan request; this forces a scan even if there
336 * are no enabled networks in the configuration */
337 int scan_runs
; /* number of scan runs since WPS was started */
338 int *next_scan_freqs
;
339 int scan_interval
; /* time in sec between scans to find suitable AP */
340 int normal_scans
; /* normal scans run before sched_scan */
342 unsigned int drv_flags
;
345 * A bitmap of supported protocols for probe response offload. See
346 * struct wpa_driver_capa in driver.h
348 unsigned int probe_resp_offloads
;
351 int max_sched_scan_ssids
;
352 int sched_scan_supported
;
353 unsigned int max_match_sets
;
354 unsigned int max_remain_on_chan
;
355 unsigned int max_stations
;
357 int pending_mic_error_report
;
358 int pending_mic_error_pairwise
;
359 int mic_errors_seen
; /* Michael MIC errors with the current PTK */
361 struct wps_context
*wps
;
362 int wps_success
; /* WPS success event received */
363 struct wps_er
*wps_er
;
364 int blacklist_cleared
;
366 struct wpabuf
*pending_eapol_rx
;
367 struct os_time pending_eapol_rx_time
;
368 u8 pending_eapol_rx_src
[ETH_ALEN
];
370 struct ibss_rsn
*ibss_rsn
;
382 u8 assoc_req_ie
[200];
383 size_t assoc_req_ie_len
;
386 u8 mobility_domain
[2];
389 u8 prev_bssid
[ETH_ALEN
];
394 int sa_query_count
; /* number of pending SA Query requests;
395 * 0 = no SA Query in progress */
396 int sa_query_timed_out
;
397 u8
*sa_query_trans_id
; /* buffer of WLAN_SA_QUERY_TR_ID_LEN *
398 * sa_query_count octets of pending
399 * SA Query transaction identifiers */
400 struct os_time sa_query_start
;
402 #endif /* CONFIG_SME */
405 struct hostapd_iface
*ap_iface
;
406 void (*ap_configured_cb
)(void *ctx
, void *data
);
407 void *ap_configured_cb_ctx
;
408 void *ap_configured_cb_data
;
409 #endif /* CONFIG_AP */
411 unsigned int off_channel_freq
;
412 struct wpabuf
*pending_action_tx
;
413 u8 pending_action_src
[ETH_ALEN
];
414 u8 pending_action_dst
[ETH_ALEN
];
415 u8 pending_action_bssid
[ETH_ALEN
];
416 unsigned int pending_action_freq
;
417 int pending_action_no_cck
;
418 int pending_action_without_roc
;
419 void (*pending_action_tx_status_cb
)(struct wpa_supplicant
*wpa_s
,
420 unsigned int freq
, const u8
*dst
,
421 const u8
*src
, const u8
*bssid
,
422 const u8
*data
, size_t data_len
,
423 enum offchannel_send_action_result
425 unsigned int roc_waiting_drv_freq
;
426 int action_tx_wait_time
;
429 struct p2p_go_neg_results
*go_params
;
430 int create_p2p_iface
;
431 u8 pending_interface_addr
[ETH_ALEN
];
432 char pending_interface_name
[100];
433 int pending_interface_type
;
435 unsigned int pending_listen_freq
;
436 unsigned int pending_listen_duration
;
438 NOT_P2P_GROUP_INTERFACE
,
439 P2P_GROUP_INTERFACE_PENDING
,
440 P2P_GROUP_INTERFACE_GO
,
441 P2P_GROUP_INTERFACE_CLIENT
442 } p2p_group_interface
;
443 struct p2p_group
*p2p_group
;
444 int p2p_long_listen
; /* remaining time in long Listen state in ms */
447 u8 p2p_auth_invite
[ETH_ALEN
];
448 int p2p_sd_over_ctrl_iface
;
449 int p2p_in_provisioning
;
450 int pending_invite_ssid_id
;
451 int show_group_started
;
452 u8 go_dev_addr
[ETH_ALEN
];
453 int pending_pd_before_join
;
454 u8 pending_join_iface_addr
[ETH_ALEN
];
455 u8 pending_join_dev_addr
[ETH_ALEN
];
456 int pending_join_wps_method
;
457 int p2p_join_scan_count
;
461 * Whether cross connection is disallowed by the AP to which this
462 * interface is associated (only valid if there is an association).
464 int cross_connect_disallowed
;
467 * Whether this P2P group is configured to use cross connection (only
468 * valid if this is P2P GO interface). The actual cross connect packet
469 * forwarding may not be configured depending on the uplink status.
471 int cross_connect_enabled
;
473 /* Whether cross connection forwarding is in use at the moment. */
474 int cross_connect_in_use
;
477 * Uplink interface name for cross connection
479 char cross_connect_uplink
[100];
482 P2P_GROUP_REMOVAL_UNKNOWN
,
483 P2P_GROUP_REMOVAL_REQUESTED
,
484 P2P_GROUP_REMOVAL_IDLE_TIMEOUT
,
485 P2P_GROUP_REMOVAL_UNAVAILABLE
488 unsigned int p2p_cb_on_scan_complete
:1;
489 #endif /* CONFIG_P2P */
491 struct wpa_ssid
*bgscan_ssid
;
492 const struct bgscan_ops
*bgscan
;
495 struct wpa_ssid
*connect_without_scan
;
498 unsigned int wps_freq
;
499 int wps_fragment_size
;
500 int auto_reconnect_disabled
;
502 /* Channel preferences for AP/P2P GO use */
505 int best_overall_freq
;
507 struct gas_query
*gas
;
509 #ifdef CONFIG_INTERWORKING
510 unsigned int fetch_anqp_in_progress
:1;
511 unsigned int network_select
:1;
512 unsigned int auto_select
:1;
513 #endif /* CONFIG_INTERWORKING */
514 unsigned int drv_capa_known
;
517 struct hostapd_hw_modes
*modes
;
526 /* wpa_supplicant.c */
527 int wpa_set_wep_keys(struct wpa_supplicant
*wpa_s
, struct wpa_ssid
*ssid
);
529 int wpa_supplicant_reload_configuration(struct wpa_supplicant
*wpa_s
);
531 const char * wpa_supplicant_state_txt(enum wpa_states state
);
532 int wpa_supplicant_update_mac_addr(struct wpa_supplicant
*wpa_s
);
533 int wpa_supplicant_driver_init(struct wpa_supplicant
*wpa_s
);
534 int wpa_supplicant_set_suites(struct wpa_supplicant
*wpa_s
,
535 struct wpa_bss
*bss
, struct wpa_ssid
*ssid
,
536 u8
*wpa_ie
, size_t *wpa_ie_len
);
537 void wpa_supplicant_associate(struct wpa_supplicant
*wpa_s
,
539 struct wpa_ssid
*ssid
);
540 void wpa_supplicant_set_non_wpa_policy(struct wpa_supplicant
*wpa_s
,
541 struct wpa_ssid
*ssid
);
542 void wpa_supplicant_initiate_eapol(struct wpa_supplicant
*wpa_s
);
543 void wpa_clear_keys(struct wpa_supplicant
*wpa_s
, const u8
*addr
);
544 void wpa_supplicant_req_auth_timeout(struct wpa_supplicant
*wpa_s
,
546 void wpa_supplicant_set_state(struct wpa_supplicant
*wpa_s
,
547 enum wpa_states state
);
548 struct wpa_ssid
* wpa_supplicant_get_ssid(struct wpa_supplicant
*wpa_s
);
549 const char * wpa_supplicant_get_eap_mode(struct wpa_supplicant
*wpa_s
);
550 void wpa_supplicant_cancel_auth_timeout(struct wpa_supplicant
*wpa_s
);
551 void wpa_supplicant_deauthenticate(struct wpa_supplicant
*wpa_s
,
553 void wpa_supplicant_disassociate(struct wpa_supplicant
*wpa_s
,
556 void wpa_supplicant_enable_network(struct wpa_supplicant
*wpa_s
,
557 struct wpa_ssid
*ssid
);
558 void wpa_supplicant_disable_network(struct wpa_supplicant
*wpa_s
,
559 struct wpa_ssid
*ssid
);
560 void wpa_supplicant_select_network(struct wpa_supplicant
*wpa_s
,
561 struct wpa_ssid
*ssid
);
562 int wpa_supplicant_set_ap_scan(struct wpa_supplicant
*wpa_s
,
564 int wpa_supplicant_set_bss_expiration_age(struct wpa_supplicant
*wpa_s
,
565 unsigned int expire_age
);
566 int wpa_supplicant_set_bss_expiration_count(struct wpa_supplicant
*wpa_s
,
567 unsigned int expire_count
);
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
);
593 void wpas_connection_failed(struct wpa_supplicant
*wpa_s
, const u8
*bssid
);
594 int wpas_driver_bss_selection(struct wpa_supplicant
*wpa_s
);
597 void wpa_supplicant_mark_disassoc(struct wpa_supplicant
*wpa_s
);
598 int wpa_supplicant_connect(struct wpa_supplicant
*wpa_s
,
599 struct wpa_bss
*selected
,
600 struct wpa_ssid
*ssid
);
601 void wpa_supplicant_stop_countermeasures(void *eloop_ctx
, void *sock_ctx
);
602 void wpa_supplicant_delayed_mic_error_report(void *eloop_ctx
, void *sock_ctx
);
605 int eap_register_methods(void);
608 * Utility method to tell if a given network is a persistent group
609 * @ssid: Network object
610 * Returns: 1 if network is a persistent group, 0 otherwise
612 static inline int network_is_persistent_group(struct wpa_ssid
*ssid
)
614 return ((ssid
->disabled
== 2) || ssid
->p2p_persistent_group
);
617 #endif /* WPA_SUPPLICANT_I_H */