1 /*
2 * wpa_supplicant - Internal definitions
3 * Copyright (c) 2003-2010, Jouni Malinen <j@w1.fi>
4 *
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.
8 *
9 * Alternatively, this software may be distributed under the terms of BSD
10 * license.
11 *
12 * See README and COPYING for more details.
13 */
14
15 #ifndef WPA_SUPPLICANT_I_H
16 #define WPA_SUPPLICANT_I_H
17
18 #include "utils/list.h"
19 #include "common/defs.h"
20 #include "config_ssid.h"
21
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 */
31
32 struct wpa_sm;
33 struct wpa_supplicant;
34 struct ibss_rsn;
35 struct scan_info;
36 struct wpa_bss;
37 struct wpa_scan_results;
38 struct hostapd_hw_modes;
39
40 /*
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
43 * these structures.
44 */
45 struct ctrl_iface_priv;
46 struct ctrl_iface_global_priv;
47 struct wpas_dbus_priv;
48
49 /**
50 * struct wpa_interface - Parameters for wpa_supplicant_add_iface()
51 */
52 struct wpa_interface {
53 /**
54 * confname - Configuration name (file or profile) name
55 *
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
58 * configured.
59 */
60 const char *confname;
61
62 /**
63 * ctrl_interface - Control interface parameter
64 *
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
69 * file.
70 */
71 const char *ctrl_interface;
72
73 /**
74 * driver - Driver interface name, or %NULL to use the default driver
75 */
76 const char *driver;
77
78 /**
79 * driver_param - Driver interface parameters
80 *
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
85 * file.
86 */
87 const char *driver_param;
88
89 /**
90 * ifname - Interface name
91 */
92 const char *ifname;
93
94 /**
95 * bridge_ifname - Optional bridge interface name
96 *
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.
101 */
102 const char *bridge_ifname;
103 };
104
105 /**
106 * struct wpa_params - Parameters for wpa_supplicant_init()
107 */
108 struct wpa_params {
109 /**
110 * daemonize - Run %wpa_supplicant in the background
111 */
112 int daemonize;
113
114 /**
115 * wait_for_monitor - Wait for a monitor program before starting
116 */
117 int wait_for_monitor;
118
119 /**
120 * pid_file - Path to a PID (process ID) file
121 *
122 * If this and daemonize are set, process ID of the background process
123 * will be written to the specified file.
124 */
125 char *pid_file;
126
127 /**
128 * wpa_debug_level - Debugging verbosity level (e.g., MSG_INFO)
129 */
130 int wpa_debug_level;
131
132 /**
133 * wpa_debug_show_keys - Whether keying material is included in debug
134 *
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.
140 */
141 int wpa_debug_show_keys;
142
143 /**
144 * wpa_debug_timestamp - Whether to include timestamp in debug messages
145 */
146 int wpa_debug_timestamp;
147
148 /**
149 * ctrl_interface - Global ctrl_iface path/parameter
150 */
151 char *ctrl_interface;
152
153 /**
154 * dbus_ctrl_interface - Enable the DBus control interface
155 */
156 int dbus_ctrl_interface;
157
158 /**
159 * wpa_debug_file_path - Path of debug file or %NULL to use stdout
160 */
161 const char *wpa_debug_file_path;
162
163 /**
164 * wpa_debug_syslog - Enable log output through syslog
165 */
166 int wpa_debug_syslog;
167
168 /**
169 * override_driver - Optional driver parameter override
170 *
171 * This parameter can be used to override the driver parameter in
172 * dynamic interface addition to force a specific driver wrapper to be
173 * used instead.
174 */
175 char *override_driver;
176
177 /**
178 * override_ctrl_interface - Optional ctrl_interface override
179 *
180 * This parameter can be used to override the ctrl_interface parameter
181 * in dynamic interface addition to force a control interface to be
182 * created.
183 */
184 char *override_ctrl_interface;
185
186 /**
187 * entropy_file - Optional entropy file
188 *
189 * This parameter can be used to configure wpa_supplicant to maintain
190 * its internal entropy store over restarts.
191 */
192 char *entropy_file;
193 };
194
195 struct p2p_srv_bonjour {
196 struct dl_list list;
197 struct wpabuf *query;
198 struct wpabuf *resp;
199 };
200
201 struct p2p_srv_upnp {
202 struct dl_list list;
203 u8 version;
204 char *service;
205 };
206
207 /**
208 * struct wpa_global - Internal, global data for all %wpa_supplicant interfaces
209 *
210 * This structure is initialized by calling wpa_supplicant_init() when starting
211 * %wpa_supplicant.
212 */
213 struct wpa_global {
214 struct wpa_supplicant *ifaces;
215 struct wpa_params params;
216 struct ctrl_iface_global_priv *ctrl_iface;
217 struct wpas_dbus_priv *dbus;
218 void **drv_priv;
219 size_t drv_count;
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 */
226 int p2p_disabled;
227 int cross_connection;
228 };
229
230
231 struct wpa_client_mlme {
232 #ifdef CONFIG_CLIENT_MLME
233 enum {
234 IEEE80211_DISABLED, IEEE80211_AUTHENTICATE,
235 IEEE80211_ASSOCIATE, IEEE80211_ASSOCIATED,
236 IEEE80211_IBSS_SEARCH, IEEE80211_IBSS_JOINED
237 } state;
238 u8 prev_bssid[ETH_ALEN];
239 u8 ssid[32];
240 size_t ssid_len;
241 u16 aid;
242 u16 ap_capab, capab;
243 u8 *extra_ie; /* to be added to the end of AssocReq */
244 size_t extra_ie_len;
245 u8 *extra_probe_ie; /* to be added to the end of ProbeReq */
246 size_t extra_probe_ie_len;
247 enum wpa_key_mgmt key_mgmt;
248
249 /* The last AssocReq/Resp IEs */
250 u8 *assocreq_ies, *assocresp_ies;
251 size_t assocreq_ies_len, assocresp_ies_len;
252
253 int auth_tries, assoc_tries;
254
255 unsigned int ssid_set:1;
256 unsigned int bssid_set:1;
257 unsigned int prev_bssid_set:1;
258 unsigned int authenticated:1;
259 unsigned int associated:1;
260 unsigned int probereq_poll:1;
261 unsigned int use_protection:1;
262 unsigned int create_ibss:1;
263 unsigned int mixed_cell:1;
264 unsigned int wmm_enabled:1;
265
266 struct os_time last_probe;
267
268 unsigned int auth_algs; /* bitfield of allowed auth algs
269 * (WPA_AUTH_ALG_*) */
270 int auth_alg; /* currently used IEEE 802.11 authentication algorithm */
271 int auth_transaction;
272
273 struct os_time ibss_join_req;
274 u8 *probe_resp; /* ProbeResp template for IBSS */
275 size_t probe_resp_len;
276 u32 supp_rates_bits;
277
278 int wmm_last_param_set;
279
280 int sta_scanning;
281 int scan_hw_mode_idx;
282 int scan_channel_idx;
283 enum { SCAN_SET_CHANNEL, SCAN_SEND_PROBE } scan_state;
284 struct os_time last_scan_completed;
285 int scan_oper_channel;
286 int scan_oper_freq;
287 int scan_oper_phymode;
288 u8 scan_ssid[32];
289 size_t scan_ssid_len;
290 int scan_skip_11b;
291 int *scan_freqs;
292
293 struct ieee80211_sta_bss *sta_bss_list;
294 #define STA_HASH_SIZE 256
295 #define STA_HASH(sta) (sta[5])
296 struct ieee80211_sta_bss *sta_bss_hash[STA_HASH_SIZE];
297
298 int cts_protect_erp_frames;
299
300 enum hostapd_hw_mode phymode; /* current mode */
301 struct hostapd_hw_modes *modes;
302 size_t num_modes;
303 unsigned int hw_modes; /* bitfield of allowed hardware modes;
304 * (1 << HOSTAPD_MODE_*) */
305 int num_curr_rates;
306 int *curr_rates;
307 int freq; /* The current frequency in MHz */
308 int channel; /* The current IEEE 802.11 channel number */
309
310 #ifdef CONFIG_IEEE80211R
311 u8 current_md[6];
312 u8 *ft_ies;
313 size_t ft_ies_len;
314 #endif /* CONFIG_IEEE80211R */
315
316 void (*public_action_cb)(void *ctx, const u8 *buf, size_t len,
317 int freq);
318 void *public_action_cb_ctx;
319
320 #else /* CONFIG_CLIENT_MLME */
321 int dummy; /* to keep MSVC happy */
322 #endif /* CONFIG_CLIENT_MLME */
323 };
324
325 /**
326 * struct wpa_supplicant - Internal data for wpa_supplicant interface
327 *
328 * This structure contains the internal data for core wpa_supplicant code. This
329 * should be only used directly from the core code. However, a pointer to this
330 * data is used from other files as an arbitrary context pointer in calls to
331 * core functions.
332 */
333 struct wpa_supplicant {
334 struct wpa_global *global;
335 struct wpa_supplicant *parent;
336 struct wpa_supplicant *next;
337 struct l2_packet_data *l2;
338 struct l2_packet_data *l2_br;
339 unsigned char own_addr[ETH_ALEN];
340 char ifname[100];
341 #ifdef CONFIG_CTRL_IFACE_DBUS
342 char *dbus_path;
343 #endif /* CONFIG_CTRL_IFACE_DBUS */
344 #ifdef CONFIG_CTRL_IFACE_DBUS_NEW
345 char *dbus_new_path;
346 char *dbus_groupobj_path;
347 #endif /* CONFIG_CTRL_IFACE_DBUS_NEW */
348 char bridge_ifname[16];
349
350 char *confname;
351 struct wpa_config *conf;
352 int countermeasures;
353 os_time_t last_michael_mic_error;
354 u8 bssid[ETH_ALEN];
355 u8 pending_bssid[ETH_ALEN]; /* If wpa_state == WPA_ASSOCIATING, this
356 * field contains the targer BSSID. */
357 int reassociate; /* reassociation requested */
358 int disconnected; /* all connections disabled; i.e., do no reassociate
359 * before this has been cleared */
360 struct wpa_ssid *current_ssid;
361 struct wpa_bss *current_bss;
362 int ap_ies_from_associnfo;
363 unsigned int assoc_freq;
364
365 /* Selected configuration (based on Beacon/ProbeResp WPA IE) */
366 int pairwise_cipher;
367 int group_cipher;
368 int key_mgmt;
369 int mgmt_group_cipher;
370
371 void *drv_priv; /* private data used by driver_ops */
372 void *global_drv_priv;
373
374 struct wpa_ssid *prev_scan_ssid; /* previously scanned SSID;
375 * NULL = not yet initialized (start
376 * with wildcard SSID)
377 * WILDCARD_SSID_SCAN = wildcard
378 * SSID was used in the previous scan
379 */
380 #define WILDCARD_SSID_SCAN ((struct wpa_ssid *) 1)
381
382 void (*scan_res_handler)(struct wpa_supplicant *wpa_s,
383 struct wpa_scan_results *scan_res);
384 struct dl_list bss; /* struct wpa_bss::list */
385 struct dl_list bss_id; /* struct wpa_bss::list_id */
386 size_t num_bss;
387 unsigned int bss_update_idx;
388 unsigned int bss_next_id;
389
390 struct wpa_driver_ops *driver;
391 int interface_removed; /* whether the network interface has been
392 * removed */
393 struct wpa_sm *wpa;
394 struct eapol_sm *eapol;
395
396 struct ctrl_iface_priv *ctrl_iface;
397
398 enum wpa_states wpa_state;
399 int scanning;
400 int new_connection;
401 int reassociated_connection;
402
403 int eapol_received; /* number of EAPOL packets received after the
404 * previous association event */
405
406 struct scard_data *scard;
407
408 unsigned char last_eapol_src[ETH_ALEN];
409
410 int keys_cleared;
411
412 struct wpa_blacklist *blacklist;
413
414 int scan_req; /* manual scan request; this forces a scan even if there
415 * are no enabled networks in the configuration */
416 int scan_runs; /* number of scan runs since WPS was started */
417 int *next_scan_freqs;
418 int scan_interval; /* time in sec between scans to find suitable AP */
419
420 struct wpa_client_mlme mlme;
421 unsigned int drv_flags;
422 int max_scan_ssids;
423 unsigned int max_remain_on_chan;
424 unsigned int max_stations;
425
426 int pending_mic_error_report;
427 int pending_mic_error_pairwise;
428 int mic_errors_seen; /* Michael MIC errors with the current PTK */
429
430 struct wps_context *wps;
431 int wps_success; /* WPS success event received */
432 struct wps_er *wps_er;
433 int blacklist_cleared;
434
435 struct wpabuf *pending_eapol_rx;
436 struct os_time pending_eapol_rx_time;
437 u8 pending_eapol_rx_src[ETH_ALEN];
438
439 struct ibss_rsn *ibss_rsn;
440
441 int set_sta_uapsd;
442 int sta_uapsd;
443 int set_ap_uapsd;
444 int ap_uapsd;
445
446 #ifdef CONFIG_SME
447 struct {
448 u8 ssid[32];
449 size_t ssid_len;
450 int freq;
451 u8 assoc_req_ie[200];
452 size_t assoc_req_ie_len;
453 int mfp;
454 int ft_used;
455 u8 mobility_domain[2];
456 u8 *ft_ies;
457 size_t ft_ies_len;
458 u8 prev_bssid[ETH_ALEN];
459 int prev_bssid_set;
460 int auth_alg;
461
462 int sa_query_count; /* number of pending SA Query requests;
463 * 0 = no SA Query in progress */
464 int sa_query_timed_out;
465 u8 *sa_query_trans_id; /* buffer of WLAN_SA_QUERY_TR_ID_LEN *
466 * sa_query_count octets of pending
467 * SA Query transaction identifiers */
468 struct os_time sa_query_start;
469 } sme;
470 #endif /* CONFIG_SME */
471
472 #ifdef CONFIG_AP
473 struct hostapd_iface *ap_iface;
474 void (*ap_configured_cb)(void *ctx, void *data);
475 void *ap_configured_cb_ctx;
476 void *ap_configured_cb_data;
477 #endif /* CONFIG_AP */
478
479 #ifdef CONFIG_P2P
480 struct p2p_go_neg_results *go_params;
481 int create_p2p_iface;
482 u8 pending_interface_addr[ETH_ALEN];
483 char pending_interface_name[100];
484 int pending_interface_type;
485 int p2p_group_idx;
486 unsigned int off_channel_freq;
487 struct wpabuf *pending_action_tx;
488 u8 pending_action_src[ETH_ALEN];
489 u8 pending_action_dst[ETH_ALEN];
490 u8 pending_action_bssid[ETH_ALEN];
491 unsigned int pending_action_freq;
492 int pending_action_without_roc;
493 unsigned int pending_listen_freq;
494 unsigned int pending_listen_duration;
495 enum {
496 NOT_P2P_GROUP_INTERFACE,
497 P2P_GROUP_INTERFACE_PENDING,
498 P2P_GROUP_INTERFACE_GO,
499 P2P_GROUP_INTERFACE_CLIENT
500 } p2p_group_interface;
501 struct p2p_group *p2p_group;
502 int p2p_long_listen; /* remaining time in long Listen state in ms */
503 char p2p_pin[10];
504 int p2p_wps_method;
505 u8 p2p_auth_invite[ETH_ALEN];
506 int p2p_sd_over_ctrl_iface;
507 int p2p_in_provisioning;
508 int pending_invite_ssid_id;
509 int show_group_started;
510 u8 go_dev_addr[ETH_ALEN];
511 int pending_pd_before_join;
512 u8 pending_join_iface_addr[ETH_ALEN];
513 u8 pending_join_dev_addr[ETH_ALEN];
514 int pending_join_wps_method;
515 int p2p_join_scan_count;
516 unsigned int roc_waiting_drv_freq;
517 int action_tx_wait_time;
518 int force_long_sd;
519
520 /*
521 * Whether cross connection is disallowed by the AP to which this
522 * interface is associated (only valid if there is an association).
523 */
524 int cross_connect_disallowed;
525
526 /*
527 * Whether this P2P group is configured to use cross connection (only
528 * valid if this is P2P GO interface). The actual cross connect packet
529 * forwarding may not be configured depending on the uplink status.
530 */
531 int cross_connect_enabled;
532
533 /* Whether cross connection forwarding is in use at the moment. */
534 int cross_connect_in_use;
535
536 /*
537 * Uplink interface name for cross connection
538 */
539 char cross_connect_uplink[100];
540
541 enum {
542 P2P_GROUP_REMOVAL_UNKNOWN,
543 P2P_GROUP_REMOVAL_REQUESTED,
544 P2P_GROUP_REMOVAL_IDLE_TIMEOUT,
545 P2P_GROUP_REMOVAL_UNAVAILABLE
546 } removal_reason;
547 #endif /* CONFIG_P2P */
548
549 struct wpa_ssid *bgscan_ssid;
550 const struct bgscan_ops *bgscan;
551 void *bgscan_priv;
552
553 struct wpa_ssid *connect_without_scan;
554
555 int after_wps;
556 unsigned int wps_freq;
557 int wps_fragment_size;
558 int auto_reconnect_disabled;
559
560 /* Channel preferences for AP/P2P GO use */
561 int best_24_freq;
562 int best_5_freq;
563 int best_overall_freq;
564 };
565
566
567 /* wpa_supplicant.c */
568 int wpa_set_wep_keys(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid);
569
570 int wpa_supplicant_reload_configuration(struct wpa_supplicant *wpa_s);
571
572 const char * wpa_supplicant_state_txt(enum wpa_states state);
573 int wpa_supplicant_driver_init(struct wpa_supplicant *wpa_s);
574 int wpa_supplicant_set_suites(struct wpa_supplicant *wpa_s,
575 struct wpa_bss *bss, struct wpa_ssid *ssid,
576 u8 *wpa_ie, size_t *wpa_ie_len);
577 void wpa_supplicant_associate(struct wpa_supplicant *wpa_s,
578 struct wpa_bss *bss,
579 struct wpa_ssid *ssid);
580 void wpa_supplicant_set_non_wpa_policy(struct wpa_supplicant *wpa_s,
581 struct wpa_ssid *ssid);
582 void wpa_supplicant_initiate_eapol(struct wpa_supplicant *wpa_s);
583 void wpa_clear_keys(struct wpa_supplicant *wpa_s, const u8 *addr);
584 void wpa_supplicant_req_auth_timeout(struct wpa_supplicant *wpa_s,
585 int sec, int usec);
586 void wpa_supplicant_set_state(struct wpa_supplicant *wpa_s,
587 enum wpa_states state);
588 struct wpa_ssid * wpa_supplicant_get_ssid(struct wpa_supplicant *wpa_s);
589 const char * wpa_supplicant_get_eap_mode(struct wpa_supplicant *wpa_s);
590 void wpa_supplicant_cancel_auth_timeout(struct wpa_supplicant *wpa_s);
591 void wpa_supplicant_deauthenticate(struct wpa_supplicant *wpa_s,
592 int reason_code);
593 void wpa_supplicant_disassociate(struct wpa_supplicant *wpa_s,
594 int reason_code);
595
596 void wpa_supplicant_enable_network(struct wpa_supplicant *wpa_s,
597 struct wpa_ssid *ssid);
598 void wpa_supplicant_disable_network(struct wpa_supplicant *wpa_s,
599 struct wpa_ssid *ssid);
600 void wpa_supplicant_select_network(struct wpa_supplicant *wpa_s,
601 struct wpa_ssid *ssid);
602 int wpa_supplicant_set_ap_scan(struct wpa_supplicant *wpa_s,
603 int ap_scan);
604 int wpa_supplicant_set_bss_expiration_age(struct wpa_supplicant *wpa_s,
605 unsigned int expire_age);
606 int wpa_supplicant_set_bss_expiration_count(struct wpa_supplicant *wpa_s,
607 unsigned int expire_count);
608 int wpa_supplicant_set_debug_params(struct wpa_global *global,
609 int debug_level, int debug_timestamp,
610 int debug_show_keys);
611
612 void wpa_show_license(void);
613
614 struct wpa_supplicant * wpa_supplicant_add_iface(struct wpa_global *global,
615 struct wpa_interface *iface);
616 int wpa_supplicant_remove_iface(struct wpa_global *global,
617 struct wpa_supplicant *wpa_s,
618 int terminate);
619 struct wpa_supplicant * wpa_supplicant_get_iface(struct wpa_global *global,
620 const char *ifname);
621 struct wpa_global * wpa_supplicant_init(struct wpa_params *params);
622 int wpa_supplicant_run(struct wpa_global *global);
623 void wpa_supplicant_deinit(struct wpa_global *global);
624
625 int wpa_supplicant_scard_init(struct wpa_supplicant *wpa_s,
626 struct wpa_ssid *ssid);
627 void wpa_supplicant_terminate_proc(struct wpa_global *global);
628 void wpa_supplicant_rx_eapol(void *ctx, const u8 *src_addr,
629 const u8 *buf, size_t len);
630 enum wpa_key_mgmt key_mgmt2driver(int key_mgmt);
631 enum wpa_cipher cipher_suite2driver(int cipher);
632 void wpa_supplicant_update_config(struct wpa_supplicant *wpa_s);
633 void wpa_supplicant_clear_status(struct wpa_supplicant *wpa_s);
634 void ieee80211_sta_free_hw_features(struct hostapd_hw_modes *hw_features,
635 size_t num_hw_features);
636 void wpas_connection_failed(struct wpa_supplicant *wpa_s, const u8 *bssid);
637
638 /* events.c */
639 void wpa_supplicant_mark_disassoc(struct wpa_supplicant *wpa_s);
640 #ifdef ANDROID_BRCM_P2P_PATCH
641 int wpa_supplicant_connect(struct wpa_supplicant *wpa_s,
642 #else
643 void wpa_supplicant_connect(struct wpa_supplicant *wpa_s,
644 #endif /* ANDROID_BRCM_P2P_PATCH */
645 struct wpa_bss *selected,
646 struct wpa_ssid *ssid);
647
648 /* eap_register.c */
649 int eap_register_methods(void);
650
651 /**
652 * Utility method to tell if a given network is a persistent group
653 * @ssid: Network object
654 * Returns: 1 if network is a persistent group, 0 otherwise
655 */
network_is_persistent_group(struct wpa_ssid * ssid)656 static inline int network_is_persistent_group(struct wpa_ssid *ssid)
657 {
658 return ((ssid->disabled == 2) || ssid->p2p_persistent_group);
659 }
660
661 #endif /* WPA_SUPPLICANT_I_H */
662