wpa_supplicant_i.h revision 2fb777c379ad560c309c54b96c2c13291da23f54 
1/*
2 * wpa_supplicant - Internal definitions
3 * Copyright (c) 2003-2010, Jouni Malinen <j@w1.fi>
4 *
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
7 */
8
9#ifndef WPA_SUPPLICANT_I_H
10#define WPA_SUPPLICANT_I_H
11
12#include "utils/list.h"
13#include "common/defs.h"
14#include "config_ssid.h"
15
16extern const char *wpa_supplicant_version;
17extern const char *wpa_supplicant_license;
18#ifndef CONFIG_NO_STDOUT_DEBUG
19extern const char *wpa_supplicant_full_license1;
20extern const char *wpa_supplicant_full_license2;
21extern const char *wpa_supplicant_full_license3;
22extern const char *wpa_supplicant_full_license4;
23extern const char *wpa_supplicant_full_license5;
24#endif /* CONFIG_NO_STDOUT_DEBUG */
25
26struct wpa_sm;
27struct wpa_supplicant;
28struct ibss_rsn;
29struct scan_info;
30struct wpa_bss;
31struct wpa_scan_results;
32struct hostapd_hw_modes;
33struct wpa_driver_associate_params;
34
35/*
36 * Forward declarations of private structures used within the ctrl_iface
37 * backends. Other parts of wpa_supplicant do not have access to data stored in
38 * these structures.
39 */
40struct ctrl_iface_priv;
41struct ctrl_iface_global_priv;
42struct wpas_dbus_priv;
43
44/**
45 * struct wpa_interface - Parameters for wpa_supplicant_add_iface()
46 */
47struct wpa_interface {
48	/**
49	 * confname - Configuration name (file or profile) name
50	 *
51	 * This can also be %NULL when a configuration file is not used. In
52	 * that case, ctrl_interface must be set to allow the interface to be
53	 * configured.
54	 */
55	const char *confname;
56
57	/**
58	 * ctrl_interface - Control interface parameter
59	 *
60	 * If a configuration file is not used, this variable can be used to
61	 * set the ctrl_interface parameter that would have otherwise been read
62	 * from the configuration file. If both confname and ctrl_interface are
63	 * set, ctrl_interface is used to override the value from configuration
64	 * file.
65	 */
66	const char *ctrl_interface;
67
68	/**
69	 * driver - Driver interface name, or %NULL to use the default driver
70	 */
71	const char *driver;
72
73	/**
74	 * driver_param - Driver interface parameters
75	 *
76	 * If a configuration file is not used, this variable can be used to
77	 * set the driver_param parameters that would have otherwise been read
78	 * from the configuration file. If both confname and driver_param are
79	 * set, driver_param is used to override the value from configuration
80	 * file.
81	 */
82	const char *driver_param;
83
84	/**
85	 * ifname - Interface name
86	 */
87	const char *ifname;
88
89	/**
90	 * bridge_ifname - Optional bridge interface name
91	 *
92	 * If the driver interface (ifname) is included in a Linux bridge
93	 * device, the bridge interface may need to be used for receiving EAPOL
94	 * frames. This can be enabled by setting this variable to enable
95	 * receiving of EAPOL frames from an additional interface.
96	 */
97	const char *bridge_ifname;
98};
99
100/**
101 * struct wpa_params - Parameters for wpa_supplicant_init()
102 */
103struct wpa_params {
104	/**
105	 * daemonize - Run %wpa_supplicant in the background
106	 */
107	int daemonize;
108
109	/**
110	 * wait_for_monitor - Wait for a monitor program before starting
111	 */
112	int wait_for_monitor;
113
114	/**
115	 * pid_file - Path to a PID (process ID) file
116	 *
117	 * If this and daemonize are set, process ID of the background process
118	 * will be written to the specified file.
119	 */
120	char *pid_file;
121
122	/**
123	 * wpa_debug_level - Debugging verbosity level (e.g., MSG_INFO)
124	 */
125	int wpa_debug_level;
126
127	/**
128	 * wpa_debug_show_keys - Whether keying material is included in debug
129	 *
130	 * This parameter can be used to allow keying material to be included
131	 * in debug messages. This is a security risk and this option should
132	 * not be enabled in normal configuration. If needed during
133	 * development or while troubleshooting, this option can provide more
134	 * details for figuring out what is happening.
135	 */
136	int wpa_debug_show_keys;
137
138	/**
139	 * wpa_debug_timestamp - Whether to include timestamp in debug messages
140	 */
141	int wpa_debug_timestamp;
142
143	/**
144	 * ctrl_interface - Global ctrl_iface path/parameter
145	 */
146	char *ctrl_interface;
147
148	/**
149	 * dbus_ctrl_interface - Enable the DBus control interface
150	 */
151	int dbus_ctrl_interface;
152
153	/**
154	 * wpa_debug_file_path - Path of debug file or %NULL to use stdout
155	 */
156	const char *wpa_debug_file_path;
157
158	/**
159	 * wpa_debug_syslog - Enable log output through syslog
160	 */
161	int wpa_debug_syslog;
162
163	/**
164	 * override_driver - Optional driver parameter override
165	 *
166	 * This parameter can be used to override the driver parameter in
167	 * dynamic interface addition to force a specific driver wrapper to be
168	 * used instead.
169	 */
170	char *override_driver;
171
172	/**
173	 * override_ctrl_interface - Optional ctrl_interface override
174	 *
175	 * This parameter can be used to override the ctrl_interface parameter
176	 * in dynamic interface addition to force a control interface to be
177	 * created.
178	 */
179	char *override_ctrl_interface;
180
181	/**
182	 * entropy_file - Optional entropy file
183	 *
184	 * This parameter can be used to configure wpa_supplicant to maintain
185	 * its internal entropy store over restarts.
186	 */
187	char *entropy_file;
188};
189
190struct p2p_srv_bonjour {
191	struct dl_list list;
192	struct wpabuf *query;
193	struct wpabuf *resp;
194};
195
196struct p2p_srv_upnp {
197	struct dl_list list;
198	u8 version;
199	char *service;
200};
201
202/**
203 * struct wpa_global - Internal, global data for all %wpa_supplicant interfaces
204 *
205 * This structure is initialized by calling wpa_supplicant_init() when starting
206 * %wpa_supplicant.
207 */
208struct wpa_global {
209	struct wpa_supplicant *ifaces;
210	struct wpa_params params;
211	struct ctrl_iface_global_priv *ctrl_iface;
212	struct wpas_dbus_priv *dbus;
213	void **drv_priv;
214	size_t drv_count;
215	struct os_time suspend_time;
216	struct p2p_data *p2p;
217	struct wpa_supplicant *p2p_group_formation;
218	u8 p2p_dev_addr[ETH_ALEN];
219	struct dl_list p2p_srv_bonjour; /* struct p2p_srv_bonjour */
220	struct dl_list p2p_srv_upnp; /* struct p2p_srv_upnp */
221	int p2p_disabled;
222#ifdef ANDROID_P2P
223	enum wpa_conc_pref {
224		WPA_CONC_PREF_NOT_SET,
225		WPA_CONC_PREF_STA,
226		WPA_CONC_PREF_P2P
227	} conc_pref;
228#endif
229	int cross_connection;
230};
231
232
233enum offchannel_send_action_result {
234	OFFCHANNEL_SEND_ACTION_SUCCESS /* Frame was send and acknowledged */,
235	OFFCHANNEL_SEND_ACTION_NO_ACK /* Frame was sent, but not acknowledged
236				       */,
237	OFFCHANNEL_SEND_ACTION_FAILED /* Frame was not sent due to a failure */
238};
239
240/**
241 * struct wpa_supplicant - Internal data for wpa_supplicant interface
242 *
243 * This structure contains the internal data for core wpa_supplicant code. This
244 * should be only used directly from the core code. However, a pointer to this
245 * data is used from other files as an arbitrary context pointer in calls to
246 * core functions.
247 */
248struct wpa_supplicant {
249	struct wpa_global *global;
250	struct wpa_supplicant *parent;
251	struct wpa_supplicant *next;
252	struct l2_packet_data *l2;
253	struct l2_packet_data *l2_br;
254	unsigned char own_addr[ETH_ALEN];
255	char ifname[100];
256#ifdef CONFIG_CTRL_IFACE_DBUS
257	char *dbus_path;
258#endif /* CONFIG_CTRL_IFACE_DBUS */
259#ifdef CONFIG_CTRL_IFACE_DBUS_NEW
260	char *dbus_new_path;
261	char *dbus_groupobj_path;
262#endif /* CONFIG_CTRL_IFACE_DBUS_NEW */
263	char bridge_ifname[16];
264
265	char *confname;
266	struct wpa_config *conf;
267	int countermeasures;
268	os_time_t last_michael_mic_error;
269	u8 bssid[ETH_ALEN];
270	u8 pending_bssid[ETH_ALEN]; /* If wpa_state == WPA_ASSOCIATING, this
271				     * field contains the target BSSID. */
272	int reassociate; /* reassociation requested */
273	int disconnected; /* all connections disabled; i.e., do no reassociate
274			   * before this has been cleared */
275	struct wpa_ssid *current_ssid;
276	struct wpa_bss *current_bss;
277	int ap_ies_from_associnfo;
278	unsigned int assoc_freq;
279
280	/* Selected configuration (based on Beacon/ProbeResp WPA IE) */
281	int pairwise_cipher;
282	int group_cipher;
283	int key_mgmt;
284	int wpa_proto;
285	int mgmt_group_cipher;
286
287	void *drv_priv; /* private data used by driver_ops */
288	void *global_drv_priv;
289
290	/* previous scan was wildcard when interleaving between
291	 * wildcard scans and specific SSID scan when max_ssids=1 */
292	int prev_scan_wildcard;
293	struct wpa_ssid *prev_scan_ssid; /* previously scanned SSID;
294					  * NULL = not yet initialized (start
295					  * with wildcard SSID)
296					  * WILDCARD_SSID_SCAN = wildcard
297					  * SSID was used in the previous scan
298					  */
299#define WILDCARD_SSID_SCAN ((struct wpa_ssid *) 1)
300
301	struct wpa_ssid *prev_sched_ssid; /* last SSID used in sched scan */
302	int sched_scan_timeout;
303	int sched_scan_interval;
304	int first_sched_scan;
305	int sched_scan_timed_out;
306
307	void (*scan_res_handler)(struct wpa_supplicant *wpa_s,
308				 struct wpa_scan_results *scan_res);
309	struct dl_list bss; /* struct wpa_bss::list */
310	struct dl_list bss_id; /* struct wpa_bss::list_id */
311	size_t num_bss;
312	unsigned int bss_update_idx;
313	unsigned int bss_next_id;
314
315	struct wpa_driver_ops *driver;
316	int interface_removed; /* whether the network interface has been
317				* removed */
318	struct wpa_sm *wpa;
319	struct eapol_sm *eapol;
320
321	struct ctrl_iface_priv *ctrl_iface;
322
323	enum wpa_states wpa_state;
324	int scanning;
325	int sched_scanning;
326	int new_connection;
327	int reassociated_connection;
328
329	int eapol_received; /* number of EAPOL packets received after the
330			     * previous association event */
331
332	struct scard_data *scard;
333
334	unsigned char last_eapol_src[ETH_ALEN];
335
336	int keys_cleared;
337
338	struct wpa_blacklist *blacklist;
339
340	int scan_req; /* manual scan request; this forces a scan even if there
341		       * are no enabled networks in the configuration */
342	int scan_runs; /* number of scan runs since WPS was started */
343	int *next_scan_freqs;
344	int scan_interval; /* time in sec between scans to find suitable AP */
345	int normal_scans; /* normal scans run before sched_scan */
346
347	unsigned int drv_flags;
348
349	/*
350	 * A bitmap of supported protocols for probe response offload. See
351	 * struct wpa_driver_capa in driver.h
352	 */
353	unsigned int probe_resp_offloads;
354
355	int max_scan_ssids;
356	int max_sched_scan_ssids;
357	int sched_scan_supported;
358	unsigned int max_match_sets;
359	unsigned int max_remain_on_chan;
360	unsigned int max_stations;
361
362	int pending_mic_error_report;
363	int pending_mic_error_pairwise;
364	int mic_errors_seen; /* Michael MIC errors with the current PTK */
365
366	struct wps_context *wps;
367	int wps_success; /* WPS success event received */
368	struct wps_er *wps_er;
369	int blacklist_cleared;
370
371	struct wpabuf *pending_eapol_rx;
372	struct os_time pending_eapol_rx_time;
373	u8 pending_eapol_rx_src[ETH_ALEN];
374
375	struct ibss_rsn *ibss_rsn;
376
377	int set_sta_uapsd;
378	int sta_uapsd;
379	int set_ap_uapsd;
380	int ap_uapsd;
381
382#ifdef CONFIG_SME
383	struct {
384		u8 ssid[32];
385		size_t ssid_len;
386		int freq;
387		u8 assoc_req_ie[200];
388		size_t assoc_req_ie_len;
389		int mfp;
390		int ft_used;
391		u8 mobility_domain[2];
392		u8 *ft_ies;
393		size_t ft_ies_len;
394		u8 prev_bssid[ETH_ALEN];
395		int prev_bssid_set;
396		int auth_alg;
397		int proto;
398
399		int sa_query_count; /* number of pending SA Query requests;
400				     * 0 = no SA Query in progress */
401		int sa_query_timed_out;
402		u8 *sa_query_trans_id; /* buffer of WLAN_SA_QUERY_TR_ID_LEN *
403					* sa_query_count octets of pending
404					* SA Query transaction identifiers */
405		struct os_time sa_query_start;
406	} sme;
407#endif /* CONFIG_SME */
408
409#ifdef CONFIG_AP
410	struct hostapd_iface *ap_iface;
411	void (*ap_configured_cb)(void *ctx, void *data);
412	void *ap_configured_cb_ctx;
413	void *ap_configured_cb_data;
414#endif /* CONFIG_AP */
415
416	unsigned int off_channel_freq;
417	struct wpabuf *pending_action_tx;
418	u8 pending_action_src[ETH_ALEN];
419	u8 pending_action_dst[ETH_ALEN];
420	u8 pending_action_bssid[ETH_ALEN];
421	unsigned int pending_action_freq;
422	int pending_action_no_cck;
423	int pending_action_without_roc;
424	void (*pending_action_tx_status_cb)(struct wpa_supplicant *wpa_s,
425					    unsigned int freq, const u8 *dst,
426					    const u8 *src, const u8 *bssid,
427					    const u8 *data, size_t data_len,
428					    enum offchannel_send_action_result
429					    result);
430	unsigned int roc_waiting_drv_freq;
431	int action_tx_wait_time;
432
433#ifdef CONFIG_P2P
434	struct p2p_go_neg_results *go_params;
435	int create_p2p_iface;
436	u8 pending_interface_addr[ETH_ALEN];
437	char pending_interface_name[100];
438	int pending_interface_type;
439	int p2p_group_idx;
440	unsigned int pending_listen_freq;
441	unsigned int pending_listen_duration;
442	enum {
443		NOT_P2P_GROUP_INTERFACE,
444		P2P_GROUP_INTERFACE_PENDING,
445		P2P_GROUP_INTERFACE_GO,
446		P2P_GROUP_INTERFACE_CLIENT
447	} p2p_group_interface;
448	struct p2p_group *p2p_group;
449	int p2p_long_listen; /* remaining time in long Listen state in ms */
450	char p2p_pin[10];
451	int p2p_wps_method;
452	u8 p2p_auth_invite[ETH_ALEN];
453	int p2p_sd_over_ctrl_iface;
454	int p2p_in_provisioning;
455	int pending_invite_ssid_id;
456	int show_group_started;
457	u8 go_dev_addr[ETH_ALEN];
458	int pending_pd_before_join;
459	u8 pending_join_iface_addr[ETH_ALEN];
460	u8 pending_join_dev_addr[ETH_ALEN];
461	int pending_join_wps_method;
462	int p2p_join_scan_count;
463	int force_long_sd;
464
465	/*
466	 * Whether cross connection is disallowed by the AP to which this
467	 * interface is associated (only valid if there is an association).
468	 */
469	int cross_connect_disallowed;
470
471	/*
472	 * Whether this P2P group is configured to use cross connection (only
473	 * valid if this is P2P GO interface). The actual cross connect packet
474	 * forwarding may not be configured depending on the uplink status.
475	 */
476	int cross_connect_enabled;
477
478	/* Whether cross connection forwarding is in use at the moment. */
479	int cross_connect_in_use;
480
481	/*
482	 * Uplink interface name for cross connection
483	 */
484	char cross_connect_uplink[100];
485
486	enum {
487		P2P_GROUP_REMOVAL_UNKNOWN,
488		P2P_GROUP_REMOVAL_REQUESTED,
489		P2P_GROUP_REMOVAL_IDLE_TIMEOUT,
490		P2P_GROUP_REMOVAL_UNAVAILABLE,
491#ifdef ANDROID_P2P
492		P2P_GROUP_REMOVAL_FREQ_CONFLICT
493#endif
494	} removal_reason;
495
496	unsigned int p2p_cb_on_scan_complete:1;
497#endif /* CONFIG_P2P */
498
499	struct wpa_ssid *bgscan_ssid;
500	const struct bgscan_ops *bgscan;
501	void *bgscan_priv;
502
503	struct wpa_ssid *connect_without_scan;
504
505	int after_wps;
506	int known_wps_freq;
507	unsigned int wps_freq;
508	int wps_fragment_size;
509	int auto_reconnect_disabled;
510
511	 /* Channel preferences for AP/P2P GO use */
512	int best_24_freq;
513	int best_5_freq;
514	int best_overall_freq;
515
516	struct gas_query *gas;
517
518#ifdef CONFIG_INTERWORKING
519	unsigned int fetch_anqp_in_progress:1;
520	unsigned int network_select:1;
521	unsigned int auto_select:1;
522#endif /* CONFIG_INTERWORKING */
523	unsigned int drv_capa_known;
524
525	struct {
526		struct hostapd_hw_modes *modes;
527		u16 num_modes;
528		u16 flags;
529	} hw;
530
531	int pno;
532};
533
534
535/* wpa_supplicant.c */
536void wpa_supplicant_apply_ht_overrides(
537	struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid,
538	struct wpa_driver_associate_params *params);
539
540int wpa_set_wep_keys(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid);
541
542int wpa_supplicant_reload_configuration(struct wpa_supplicant *wpa_s);
543
544const char * wpa_supplicant_state_txt(enum wpa_states state);
545int wpa_supplicant_update_mac_addr(struct wpa_supplicant *wpa_s);
546int wpa_supplicant_driver_init(struct wpa_supplicant *wpa_s);
547int wpa_supplicant_set_suites(struct wpa_supplicant *wpa_s,
548			      struct wpa_bss *bss, struct wpa_ssid *ssid,
549			      u8 *wpa_ie, size_t *wpa_ie_len);
550void wpa_supplicant_associate(struct wpa_supplicant *wpa_s,
551			      struct wpa_bss *bss,
552			      struct wpa_ssid *ssid);
553void wpa_supplicant_set_non_wpa_policy(struct wpa_supplicant *wpa_s,
554				       struct wpa_ssid *ssid);
555void wpa_supplicant_initiate_eapol(struct wpa_supplicant *wpa_s);
556void wpa_clear_keys(struct wpa_supplicant *wpa_s, const u8 *addr);
557void wpa_supplicant_req_auth_timeout(struct wpa_supplicant *wpa_s,
558				     int sec, int usec);
559void wpa_supplicant_set_state(struct wpa_supplicant *wpa_s,
560			      enum wpa_states state);
561struct wpa_ssid * wpa_supplicant_get_ssid(struct wpa_supplicant *wpa_s);
562const char * wpa_supplicant_get_eap_mode(struct wpa_supplicant *wpa_s);
563void wpa_supplicant_cancel_auth_timeout(struct wpa_supplicant *wpa_s);
564void wpa_supplicant_deauthenticate(struct wpa_supplicant *wpa_s,
565				   int reason_code);
566void wpa_supplicant_disassociate(struct wpa_supplicant *wpa_s,
567				 int reason_code);
568
569void wpa_supplicant_enable_network(struct wpa_supplicant *wpa_s,
570				   struct wpa_ssid *ssid);
571void wpa_supplicant_disable_network(struct wpa_supplicant *wpa_s,
572				    struct wpa_ssid *ssid);
573void wpa_supplicant_select_network(struct wpa_supplicant *wpa_s,
574				   struct wpa_ssid *ssid);
575int wpa_supplicant_set_ap_scan(struct wpa_supplicant *wpa_s,
576			       int ap_scan);
577int wpa_supplicant_set_bss_expiration_age(struct wpa_supplicant *wpa_s,
578					  unsigned int expire_age);
579int wpa_supplicant_set_bss_expiration_count(struct wpa_supplicant *wpa_s,
580					    unsigned int expire_count);
581int wpa_supplicant_set_debug_params(struct wpa_global *global,
582				    int debug_level, int debug_timestamp,
583				    int debug_show_keys);
584
585void wpa_show_license(void);
586
587struct wpa_supplicant * wpa_supplicant_add_iface(struct wpa_global *global,
588						 struct wpa_interface *iface);
589int wpa_supplicant_remove_iface(struct wpa_global *global,
590				struct wpa_supplicant *wpa_s,
591				int terminate);
592struct wpa_supplicant * wpa_supplicant_get_iface(struct wpa_global *global,
593						 const char *ifname);
594struct wpa_global * wpa_supplicant_init(struct wpa_params *params);
595int wpa_supplicant_run(struct wpa_global *global);
596void wpa_supplicant_deinit(struct wpa_global *global);
597
598int wpa_supplicant_scard_init(struct wpa_supplicant *wpa_s,
599			      struct wpa_ssid *ssid);
600void wpa_supplicant_terminate_proc(struct wpa_global *global);
601void wpa_supplicant_rx_eapol(void *ctx, const u8 *src_addr,
602			     const u8 *buf, size_t len);
603enum wpa_key_mgmt key_mgmt2driver(int key_mgmt);
604enum wpa_cipher cipher_suite2driver(int cipher);
605void wpa_supplicant_update_config(struct wpa_supplicant *wpa_s);
606void wpa_supplicant_clear_status(struct wpa_supplicant *wpa_s);
607void wpas_connection_failed(struct wpa_supplicant *wpa_s, const u8 *bssid);
608int wpas_driver_bss_selection(struct wpa_supplicant *wpa_s);
609#ifdef ANDROID_P2P
610int wpas_is_p2p_prioritized(struct wpa_supplicant *wpa_s);
611#endif
612
613/* events.c */
614void wpa_supplicant_mark_disassoc(struct wpa_supplicant *wpa_s);
615int wpa_supplicant_connect(struct wpa_supplicant *wpa_s,
616			   struct wpa_bss *selected,
617			   struct wpa_ssid *ssid);
618void wpa_supplicant_stop_countermeasures(void *eloop_ctx, void *sock_ctx);
619void wpa_supplicant_delayed_mic_error_report(void *eloop_ctx, void *sock_ctx);
620
621/* eap_register.c */
622int eap_register_methods(void);
623
624/**
625 * Utility method to tell if a given network is a persistent group
626 * @ssid: Network object
627 * Returns: 1 if network is a persistent group, 0 otherwise
628 */
629static inline int network_is_persistent_group(struct wpa_ssid *ssid)
630{
631	return ((ssid->disabled == 2) || ssid->p2p_persistent_group);
632}
633
634#endif /* WPA_SUPPLICANT_I_H */
635