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
;
412 int pending_mic_error_report
;
413 int pending_mic_error_pairwise
;
414 int mic_errors_seen
; /* Michael MIC errors with the current PTK */
416 struct wps_context
*wps
;
417 int wps_success
; /* WPS success event received */
418 struct wps_er
*wps_er
;
419 int blacklist_cleared
;
421 struct wpabuf
*pending_eapol_rx
;
422 struct os_time pending_eapol_rx_time
;
423 u8 pending_eapol_rx_src
[ETH_ALEN
];
425 struct ibss_rsn
*ibss_rsn
;
432 u8 assoc_req_ie
[200];
433 size_t assoc_req_ie_len
;
436 u8 mobility_domain
[2];
439 u8 prev_bssid
[ETH_ALEN
];
443 #endif /* CONFIG_SME */
446 struct hostapd_iface
*ap_iface
;
447 void (*ap_configured_cb
)(void *ctx
, void *data
);
448 void *ap_configured_cb_ctx
;
449 void *ap_configured_cb_data
;
450 #endif /* CONFIG_AP */
453 struct p2p_go_neg_results
*go_params
;
454 int create_p2p_iface
;
455 u8 pending_interface_addr
[ETH_ALEN
];
456 char pending_interface_name
[IFNAMSIZ
];
457 int pending_interface_type
;
459 unsigned int off_channel_freq
;
460 struct wpabuf
*pending_action_tx
;
461 u8 pending_action_src
[ETH_ALEN
];
462 u8 pending_action_dst
[ETH_ALEN
];
463 u8 pending_action_bssid
[ETH_ALEN
];
464 unsigned int pending_action_freq
;
465 int pending_action_without_roc
;
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
;
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 unsigned int roc_waiting_drv_freq
;
492 * Whether cross connection is disallowed by the AP to which this
493 * interface is associated (only valid if there is an association).
495 int cross_connect_disallowed
;
498 * Whether this P2P group is configured to use cross connection (only
499 * valid if this is P2P GO interface). The actual cross connect packet
500 * forwarding may not be configured depending on the uplink status.
502 int cross_connect_enabled
;
504 /* Whether cross connection forwarding is in use at the moment. */
505 int cross_connect_in_use
;
508 * Uplink interface name for cross connection
510 char cross_connect_uplink
[100];
511 #endif /* CONFIG_P2P */
513 struct wpa_ssid
*bgscan_ssid
;
514 const struct bgscan_ops
*bgscan
;
517 int connect_without_scan
;
520 unsigned int wps_freq
;
521 int wps_fragment_size
;
525 /* wpa_supplicant.c */
526 int wpa_set_wep_keys(struct wpa_supplicant
*wpa_s
, struct wpa_ssid
*ssid
);
528 int wpa_supplicant_reload_configuration(struct wpa_supplicant
*wpa_s
);
530 const char * wpa_supplicant_state_txt(enum wpa_states state
);
531 int wpa_supplicant_driver_init(struct wpa_supplicant
*wpa_s
);
532 int wpa_supplicant_set_suites(struct wpa_supplicant
*wpa_s
,
533 struct wpa_bss
*bss
, struct wpa_ssid
*ssid
,
534 u8
*wpa_ie
, size_t *wpa_ie_len
);
535 void wpa_supplicant_associate(struct wpa_supplicant
*wpa_s
,
537 struct wpa_ssid
*ssid
);
538 void wpa_supplicant_set_non_wpa_policy(struct wpa_supplicant
*wpa_s
,
539 struct wpa_ssid
*ssid
);
540 void wpa_supplicant_initiate_eapol(struct wpa_supplicant
*wpa_s
);
541 void wpa_clear_keys(struct wpa_supplicant
*wpa_s
, const u8
*addr
);
542 void wpa_supplicant_req_auth_timeout(struct wpa_supplicant
*wpa_s
,
544 void wpa_supplicant_set_state(struct wpa_supplicant
*wpa_s
,
545 enum wpa_states state
);
546 struct wpa_ssid
* wpa_supplicant_get_ssid(struct wpa_supplicant
*wpa_s
);
547 void wpa_supplicant_cancel_auth_timeout(struct wpa_supplicant
*wpa_s
);
548 void wpa_supplicant_deauthenticate(struct wpa_supplicant
*wpa_s
,
550 void wpa_supplicant_disassociate(struct wpa_supplicant
*wpa_s
,
553 void wpa_supplicant_enable_network(struct wpa_supplicant
*wpa_s
,
554 struct wpa_ssid
*ssid
);
555 void wpa_supplicant_disable_network(struct wpa_supplicant
*wpa_s
,
556 struct wpa_ssid
*ssid
);
557 void wpa_supplicant_select_network(struct wpa_supplicant
*wpa_s
,
558 struct wpa_ssid
*ssid
);
559 int wpa_supplicant_set_ap_scan(struct wpa_supplicant
*wpa_s
,
561 int wpa_supplicant_set_debug_params(struct wpa_global
*global
,
562 int debug_level
, int debug_timestamp
,
563 int debug_show_keys
);
565 void wpa_show_license(void);
567 struct wpa_supplicant
* wpa_supplicant_add_iface(struct wpa_global
*global
,
568 struct wpa_interface
*iface
);
569 int wpa_supplicant_remove_iface(struct wpa_global
*global
,
570 struct wpa_supplicant
*wpa_s
);
571 struct wpa_supplicant
* wpa_supplicant_get_iface(struct wpa_global
*global
,
573 struct wpa_global
* wpa_supplicant_init(struct wpa_params
*params
);
574 int wpa_supplicant_run(struct wpa_global
*global
);
575 void wpa_supplicant_deinit(struct wpa_global
*global
);
577 int wpa_supplicant_scard_init(struct wpa_supplicant
*wpa_s
,
578 struct wpa_ssid
*ssid
);
579 void wpa_supplicant_terminate_proc(struct wpa_global
*global
);
580 void wpa_supplicant_rx_eapol(void *ctx
, const u8
*src_addr
,
581 const u8
*buf
, size_t len
);
582 enum wpa_key_mgmt
key_mgmt2driver(int key_mgmt
);
583 enum wpa_cipher
cipher_suite2driver(int cipher
);
584 void wpa_supplicant_update_config(struct wpa_supplicant
*wpa_s
);
585 void wpa_supplicant_clear_status(struct wpa_supplicant
*wpa_s
);
588 void wpa_supplicant_mark_disassoc(struct wpa_supplicant
*wpa_s
);
589 void wpa_supplicant_connect(struct wpa_supplicant
*wpa_s
,
590 struct wpa_bss
*selected
,
591 struct wpa_ssid
*ssid
);
594 int eap_register_methods(void);
596 #endif /* WPA_SUPPLICANT_I_H */