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 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 */ 30 31 struct wpa_sm; 32 struct wpa_supplicant; 33 struct ibss_rsn; 34 struct scan_info; 35 struct wpa_bss; 36 struct wpa_scan_results; 37 38 /* 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 41 * these structures. 42 */ 43 struct ctrl_iface_priv; 44 struct ctrl_iface_global_priv; 45 struct wpas_dbus_priv; 46 47 /** 48 * struct wpa_interface - Parameters for wpa_supplicant_add_iface() 49 */ 50 struct wpa_interface { 51 /** 52 * confname - Configuration name (file or profile) name 53 * 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 56 * configured. 57 */ 58 const char *confname; 59 60 /** 61 * ctrl_interface - Control interface parameter 62 * 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 67 * file. 68 */ 69 const char *ctrl_interface; 70 71 /** 72 * driver - Driver interface name, or %NULL to use the default driver 73 */ 74 const char *driver; 75 76 /** 77 * driver_param - Driver interface parameters 78 * 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 83 * file. 84 */ 85 const char *driver_param; 86 87 /** 88 * ifname - Interface name 89 */ 90 const char *ifname; 91 92 /** 93 * bridge_ifname - Optional bridge interface name 94 * 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. 99 */ 100 const char *bridge_ifname; 101 }; 102 103 /** 104 * struct wpa_params - Parameters for wpa_supplicant_init() 105 */ 106 struct wpa_params { 107 /** 108 * daemonize - Run %wpa_supplicant in the background 109 */ 110 int daemonize; 111 112 /** 113 * wait_for_monitor - Wait for a monitor program before starting 114 */ 115 int wait_for_monitor; 116 117 /** 118 * pid_file - Path to a PID (process ID) file 119 * 120 * If this and daemonize are set, process ID of the background process 121 * will be written to the specified file. 122 */ 123 char *pid_file; 124 125 /** 126 * wpa_debug_level - Debugging verbosity level (e.g., MSG_INFO) 127 */ 128 int wpa_debug_level; 129 130 /** 131 * wpa_debug_show_keys - Whether keying material is included in debug 132 * 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. 138 */ 139 int wpa_debug_show_keys; 140 141 /** 142 * wpa_debug_timestamp - Whether to include timestamp in debug messages 143 */ 144 int wpa_debug_timestamp; 145 146 /** 147 * ctrl_interface - Global ctrl_iface path/parameter 148 */ 149 char *ctrl_interface; 150 151 /** 152 * dbus_ctrl_interface - Enable the DBus control interface 153 */ 154 int dbus_ctrl_interface; 155 156 /** 157 * wpa_debug_file_path - Path of debug file or %NULL to use stdout 158 */ 159 const char *wpa_debug_file_path; 160 161 /** 162 * wpa_debug_syslog - Enable log output through syslog 163 */ 164 int wpa_debug_syslog; 165 166 /** 167 * override_driver - Optional driver parameter override 168 * 169 * This parameter can be used to override the driver parameter in 170 * dynamic interface addition to force a specific driver wrapper to be 171 * used instead. 172 */ 173 char *override_driver; 174 175 /** 176 * override_ctrl_interface - Optional ctrl_interface override 177 * 178 * This parameter can be used to override the ctrl_interface parameter 179 * in dynamic interface addition to force a control interface to be 180 * created. 181 */ 182 char *override_ctrl_interface; 183 }; 184 185 /** 186 * struct wpa_global - Internal, global data for all %wpa_supplicant interfaces 187 * 188 * This structure is initialized by calling wpa_supplicant_init() when starting 189 * %wpa_supplicant. 190 */ 191 struct wpa_global { 192 struct wpa_supplicant *ifaces; 193 struct wpa_params params; 194 struct ctrl_iface_global_priv *ctrl_iface; 195 struct wpas_dbus_priv *dbus; 196 void **drv_priv; 197 size_t drv_count; 198 struct os_time suspend_time; 199 }; 200 201 202 struct wpa_client_mlme { 203 #ifdef CONFIG_CLIENT_MLME 204 enum { 205 IEEE80211_DISABLED, IEEE80211_AUTHENTICATE, 206 IEEE80211_ASSOCIATE, IEEE80211_ASSOCIATED, 207 IEEE80211_IBSS_SEARCH, IEEE80211_IBSS_JOINED 208 } state; 209 u8 prev_bssid[ETH_ALEN]; 210 u8 ssid[32]; 211 size_t ssid_len; 212 u16 aid; 213 u16 ap_capab, capab; 214 u8 *extra_ie; /* to be added to the end of AssocReq */ 215 size_t extra_ie_len; 216 u8 *extra_probe_ie; /* to be added to the end of ProbeReq */ 217 size_t extra_probe_ie_len; 218 enum wpa_key_mgmt key_mgmt; 219 220 /* The last AssocReq/Resp IEs */ 221 u8 *assocreq_ies, *assocresp_ies; 222 size_t assocreq_ies_len, assocresp_ies_len; 223 224 int auth_tries, assoc_tries; 225 226 unsigned int ssid_set:1; 227 unsigned int bssid_set:1; 228 unsigned int prev_bssid_set:1; 229 unsigned int authenticated:1; 230 unsigned int associated:1; 231 unsigned int probereq_poll:1; 232 unsigned int use_protection:1; 233 unsigned int create_ibss:1; 234 unsigned int mixed_cell:1; 235 unsigned int wmm_enabled:1; 236 237 struct os_time last_probe; 238 239 unsigned int auth_algs; /* bitfield of allowed auth algs 240 * (WPA_AUTH_ALG_*) */ 241 int auth_alg; /* currently used IEEE 802.11 authentication algorithm */ 242 int auth_transaction; 243 244 struct os_time ibss_join_req; 245 u8 *probe_resp; /* ProbeResp template for IBSS */ 246 size_t probe_resp_len; 247 u32 supp_rates_bits; 248 249 int wmm_last_param_set; 250 251 int sta_scanning; 252 int scan_hw_mode_idx; 253 int scan_channel_idx; 254 enum { SCAN_SET_CHANNEL, SCAN_SEND_PROBE } scan_state; 255 struct os_time last_scan_completed; 256 int scan_oper_channel; 257 int scan_oper_freq; 258 int scan_oper_phymode; 259 u8 scan_ssid[32]; 260 size_t scan_ssid_len; 261 int scan_skip_11b; 262 int *scan_freqs; 263 264 struct ieee80211_sta_bss *sta_bss_list; 265 #define STA_HASH_SIZE 256 266 #define STA_HASH(sta) (sta[5]) 267 struct ieee80211_sta_bss *sta_bss_hash[STA_HASH_SIZE]; 268 269 int cts_protect_erp_frames; 270 271 enum hostapd_hw_mode phymode; /* current mode */ 272 struct hostapd_hw_modes *modes; 273 size_t num_modes; 274 unsigned int hw_modes; /* bitfield of allowed hardware modes; 275 * (1 << HOSTAPD_MODE_*) */ 276 int num_curr_rates; 277 int *curr_rates; 278 int freq; /* The current frequency in MHz */ 279 int channel; /* The current IEEE 802.11 channel number */ 280 281 #ifdef CONFIG_IEEE80211R 282 u8 current_md[6]; 283 u8 *ft_ies; 284 size_t ft_ies_len; 285 #endif /* CONFIG_IEEE80211R */ 286 287 void (*public_action_cb)(void *ctx, const u8 *buf, size_t len, 288 int freq); 289 void *public_action_cb_ctx; 290 291 #else /* CONFIG_CLIENT_MLME */ 292 int dummy; /* to keep MSVC happy */ 293 #endif /* CONFIG_CLIENT_MLME */ 294 }; 295 296 /** 297 * struct wpa_supplicant - Internal data for wpa_supplicant interface 298 * 299 * This structure contains the internal data for core wpa_supplicant code. This 300 * should be only used directly from the core code. However, a pointer to this 301 * data is used from other files as an arbitrary context pointer in calls to 302 * core functions. 303 */ 304 struct wpa_supplicant { 305 struct wpa_global *global; 306 struct wpa_supplicant *next; 307 struct l2_packet_data *l2; 308 struct l2_packet_data *l2_br; 309 unsigned char own_addr[ETH_ALEN]; 310 char ifname[100]; 311 #ifdef CONFIG_CTRL_IFACE_DBUS 312 char *dbus_path; 313 #endif /* CONFIG_CTRL_IFACE_DBUS */ 314 #ifdef CONFIG_CTRL_IFACE_DBUS_NEW 315 char *dbus_new_path; 316 #endif /* CONFIG_CTRL_IFACE_DBUS_NEW */ 317 char bridge_ifname[16]; 318 319 char *confname; 320 struct wpa_config *conf; 321 int countermeasures; 322 os_time_t last_michael_mic_error; 323 u8 bssid[ETH_ALEN]; 324 u8 pending_bssid[ETH_ALEN]; /* If wpa_state == WPA_ASSOCIATING, this 325 * field contains the targer BSSID. */ 326 int reassociate; /* reassociation requested */ 327 int disconnected; /* all connections disabled; i.e., do no reassociate 328 * before this has been cleared */ 329 struct wpa_ssid *current_ssid; 330 struct wpa_bss *current_bss; 331 int ap_ies_from_associnfo; 332 unsigned int assoc_freq; 333 334 /* Selected configuration (based on Beacon/ProbeResp WPA IE) */ 335 int pairwise_cipher; 336 int group_cipher; 337 int key_mgmt; 338 int mgmt_group_cipher; 339 340 void *drv_priv; /* private data used by driver_ops */ 341 void *global_drv_priv; 342 343 struct wpa_ssid *prev_scan_ssid; /* previously scanned SSID; 344 * NULL = not yet initialized (start 345 * with wildcard SSID) 346 * WILDCARD_SSID_SCAN = wildcard 347 * SSID was used in the previous scan 348 */ 349 #define WILDCARD_SSID_SCAN ((struct wpa_ssid *) 1) 350 351 void (*scan_res_handler)(struct wpa_supplicant *wpa_s, 352 struct wpa_scan_results *scan_res); 353 struct dl_list bss; /* struct wpa_bss::list */ 354 struct dl_list bss_id; /* struct wpa_bss::list_id */ 355 size_t num_bss; 356 unsigned int bss_update_idx; 357 unsigned int bss_next_id; 358 359 struct wpa_driver_ops *driver; 360 int interface_removed; /* whether the network interface has been 361 * removed */ 362 struct wpa_sm *wpa; 363 struct eapol_sm *eapol; 364 365 struct ctrl_iface_priv *ctrl_iface; 366 367 enum wpa_states wpa_state; 368 int scanning; 369 int new_connection; 370 int reassociated_connection; 371 372 int eapol_received; /* number of EAPOL packets received after the 373 * previous association event */ 374 375 struct scard_data *scard; 376 377 unsigned char last_eapol_src[ETH_ALEN]; 378 379 int keys_cleared; 380 381 struct wpa_blacklist *blacklist; 382 383 int scan_req; /* manual scan request; this forces a scan even if there 384 * are no enabled networks in the configuration */ 385 int scan_res_tried; /* whether ap_scan=1 mode has tried to fetch scan 386 * results without a new scan request; this is used 387 * to speed up the first association if the driver 388 * has already available scan results. */ 389 int scan_runs; /* number of scan runs since WPS was started */ 390 391 struct wpa_client_mlme mlme; 392 unsigned int drv_flags; 393 int max_scan_ssids; 394 unsigned int max_remain_on_chan; 395 396 int pending_mic_error_report; 397 int pending_mic_error_pairwise; 398 int mic_errors_seen; /* Michael MIC errors with the current PTK */ 399 400 struct wps_context *wps; 401 int wps_success; /* WPS success event received */ 402 struct wps_er *wps_er; 403 int blacklist_cleared; 404 405 struct wpabuf *pending_eapol_rx; 406 struct os_time pending_eapol_rx_time; 407 u8 pending_eapol_rx_src[ETH_ALEN]; 408 409 struct ibss_rsn *ibss_rsn; 410 411 #ifdef CONFIG_SME 412 struct { 413 u8 ssid[32]; 414 size_t ssid_len; 415 int freq; 416 u8 assoc_req_ie[80]; 417 size_t assoc_req_ie_len; 418 int mfp; 419 int ft_used; 420 u8 mobility_domain[2]; 421 u8 *ft_ies; 422 size_t ft_ies_len; 423 u8 prev_bssid[ETH_ALEN]; 424 int prev_bssid_set; 425 int auth_alg; 426 } sme; 427 #endif /* CONFIG_SME */ 428 429 #ifdef CONFIG_AP 430 struct hostapd_iface *ap_iface; 431 void (*ap_configured_cb)(void *ctx, void *data); 432 void *ap_configured_cb_ctx; 433 void *ap_configured_cb_data; 434 #endif /* CONFIG_AP */ 435 436 struct wpa_ssid *bgscan_ssid; 437 const struct bgscan_ops *bgscan; 438 void *bgscan_priv; 439 440 int connect_without_scan; 441 442 int after_wps; 443 unsigned int wps_freq; 444 }; 445 446 447 /* wpa_supplicant.c */ 448 int wpa_set_wep_keys(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid); 449 450 int wpa_supplicant_reload_configuration(struct wpa_supplicant *wpa_s); 451 452 const char * wpa_supplicant_state_txt(enum wpa_states state); 453 int wpa_supplicant_driver_init(struct wpa_supplicant *wpa_s); 454 int wpa_supplicant_set_suites(struct wpa_supplicant *wpa_s, 455 struct wpa_bss *bss, struct wpa_ssid *ssid, 456 u8 *wpa_ie, size_t *wpa_ie_len); 457 void wpa_supplicant_associate(struct wpa_supplicant *wpa_s, 458 struct wpa_bss *bss, 459 struct wpa_ssid *ssid); 460 void wpa_supplicant_set_non_wpa_policy(struct wpa_supplicant *wpa_s, 461 struct wpa_ssid *ssid); 462 void wpa_supplicant_initiate_eapol(struct wpa_supplicant *wpa_s); 463 void wpa_clear_keys(struct wpa_supplicant *wpa_s, const u8 *addr); 464 void wpa_supplicant_req_auth_timeout(struct wpa_supplicant *wpa_s, 465 int sec, int usec); 466 void wpa_supplicant_set_state(struct wpa_supplicant *wpa_s, 467 enum wpa_states state); 468 struct wpa_ssid * wpa_supplicant_get_ssid(struct wpa_supplicant *wpa_s); 469 void wpa_supplicant_cancel_auth_timeout(struct wpa_supplicant *wpa_s); 470 void wpa_supplicant_deauthenticate(struct wpa_supplicant *wpa_s, 471 int reason_code); 472 void wpa_supplicant_disassociate(struct wpa_supplicant *wpa_s, 473 int reason_code); 474 475 void wpa_supplicant_enable_network(struct wpa_supplicant *wpa_s, 476 struct wpa_ssid *ssid); 477 void wpa_supplicant_disable_network(struct wpa_supplicant *wpa_s, 478 struct wpa_ssid *ssid); 479 void wpa_supplicant_select_network(struct wpa_supplicant *wpa_s, 480 struct wpa_ssid *ssid); 481 int wpa_supplicant_set_ap_scan(struct wpa_supplicant *wpa_s, 482 int ap_scan); 483 int wpa_supplicant_set_debug_params(struct wpa_global *global, 484 int debug_level, int debug_timestamp, 485 int debug_show_keys); 486 487 void wpa_show_license(void); 488 489 struct wpa_supplicant * wpa_supplicant_add_iface(struct wpa_global *global, 490 struct wpa_interface *iface); 491 int wpa_supplicant_remove_iface(struct wpa_global *global, 492 struct wpa_supplicant *wpa_s); 493 struct wpa_supplicant * wpa_supplicant_get_iface(struct wpa_global *global, 494 const char *ifname); 495 struct wpa_global * wpa_supplicant_init(struct wpa_params *params); 496 int wpa_supplicant_run(struct wpa_global *global); 497 void wpa_supplicant_deinit(struct wpa_global *global); 498 499 int wpa_supplicant_scard_init(struct wpa_supplicant *wpa_s, 500 struct wpa_ssid *ssid); 501 void wpa_supplicant_terminate_proc(struct wpa_global *global); 502 void wpa_supplicant_rx_eapol(void *ctx, const u8 *src_addr, 503 const u8 *buf, size_t len); 504 enum wpa_key_mgmt key_mgmt2driver(int key_mgmt); 505 enum wpa_cipher cipher_suite2driver(int cipher); 506 507 /* events.c */ 508 void wpa_supplicant_mark_disassoc(struct wpa_supplicant *wpa_s); 509 void wpa_supplicant_connect(struct wpa_supplicant *wpa_s, 510 struct wpa_bss *selected, 511 struct wpa_ssid *ssid); 512 513 /* eap_register.c */ 514 int eap_register_methods(void); 515 516 #endif /* WPA_SUPPLICANT_I_H */ 517