1 /* 2 * wpa_supplicant - Internal definitions 3 * Copyright (c) 2003-2010, Jouni Malinen <j (at) 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 16 extern const char *wpa_supplicant_version; 17 extern const char *wpa_supplicant_license; 18 #ifndef CONFIG_NO_STDOUT_DEBUG 19 extern const char *wpa_supplicant_full_license1; 20 extern const char *wpa_supplicant_full_license2; 21 extern const char *wpa_supplicant_full_license3; 22 extern const char *wpa_supplicant_full_license4; 23 extern const char *wpa_supplicant_full_license5; 24 #endif /* CONFIG_NO_STDOUT_DEBUG */ 25 26 struct wpa_sm; 27 struct wpa_supplicant; 28 struct ibss_rsn; 29 struct scan_info; 30 struct wpa_bss; 31 struct wpa_scan_results; 32 struct hostapd_hw_modes; 33 struct 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 */ 40 struct ctrl_iface_priv; 41 struct ctrl_iface_global_priv; 42 struct wpas_dbus_priv; 43 44 /** 45 * struct wpa_interface - Parameters for wpa_supplicant_add_iface() 46 */ 47 struct 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 */ 103 struct 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 190 struct p2p_srv_bonjour { 191 struct dl_list list; 192 struct wpabuf *query; 193 struct wpabuf *resp; 194 }; 195 196 struct 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 */ 208 struct 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 233 enum 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 */ 248 struct 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 #ifdef ANDROID_P2P 280 unsigned int assoc_retries; 281 #endif 282 283 /* Selected configuration (based on Beacon/ProbeResp WPA IE) */ 284 int pairwise_cipher; 285 int group_cipher; 286 int key_mgmt; 287 int wpa_proto; 288 int mgmt_group_cipher; 289 290 void *drv_priv; /* private data used by driver_ops */ 291 void *global_drv_priv; 292 293 /* previous scan was wildcard when interleaving between 294 * wildcard scans and specific SSID scan when max_ssids=1 */ 295 int prev_scan_wildcard; 296 struct wpa_ssid *prev_scan_ssid; /* previously scanned SSID; 297 * NULL = not yet initialized (start 298 * with wildcard SSID) 299 * WILDCARD_SSID_SCAN = wildcard 300 * SSID was used in the previous scan 301 */ 302 #define WILDCARD_SSID_SCAN ((struct wpa_ssid *) 1) 303 304 struct wpa_ssid *prev_sched_ssid; /* last SSID used in sched scan */ 305 int sched_scan_timeout; 306 int sched_scan_interval; 307 int first_sched_scan; 308 int sched_scan_timed_out; 309 310 void (*scan_res_handler)(struct wpa_supplicant *wpa_s, 311 struct wpa_scan_results *scan_res); 312 struct dl_list bss; /* struct wpa_bss::list */ 313 struct dl_list bss_id; /* struct wpa_bss::list_id */ 314 size_t num_bss; 315 unsigned int bss_update_idx; 316 unsigned int bss_next_id; 317 318 struct wpa_driver_ops *driver; 319 int interface_removed; /* whether the network interface has been 320 * removed */ 321 struct wpa_sm *wpa; 322 struct eapol_sm *eapol; 323 324 struct ctrl_iface_priv *ctrl_iface; 325 326 enum wpa_states wpa_state; 327 int scanning; 328 int sched_scanning; 329 int new_connection; 330 int reassociated_connection; 331 332 int eapol_received; /* number of EAPOL packets received after the 333 * previous association event */ 334 335 struct scard_data *scard; 336 337 unsigned char last_eapol_src[ETH_ALEN]; 338 339 int keys_cleared; 340 341 struct wpa_blacklist *blacklist; 342 343 int scan_req; /* manual scan request; this forces a scan even if there 344 * are no enabled networks in the configuration */ 345 int scan_runs; /* number of scan runs since WPS was started */ 346 int *next_scan_freqs; 347 int scan_interval; /* time in sec between scans to find suitable AP */ 348 int normal_scans; /* normal scans run before sched_scan */ 349 350 unsigned int drv_flags; 351 352 /* 353 * A bitmap of supported protocols for probe response offload. See 354 * struct wpa_driver_capa in driver.h 355 */ 356 unsigned int probe_resp_offloads; 357 358 int max_scan_ssids; 359 int max_sched_scan_ssids; 360 int sched_scan_supported; 361 unsigned int max_match_sets; 362 unsigned int max_remain_on_chan; 363 unsigned int max_stations; 364 365 int pending_mic_error_report; 366 int pending_mic_error_pairwise; 367 int mic_errors_seen; /* Michael MIC errors with the current PTK */ 368 369 struct wps_context *wps; 370 int wps_success; /* WPS success event received */ 371 struct wps_er *wps_er; 372 int blacklist_cleared; 373 374 struct wpabuf *pending_eapol_rx; 375 struct os_time pending_eapol_rx_time; 376 u8 pending_eapol_rx_src[ETH_ALEN]; 377 378 struct ibss_rsn *ibss_rsn; 379 380 int set_sta_uapsd; 381 int sta_uapsd; 382 int set_ap_uapsd; 383 int ap_uapsd; 384 385 #ifdef CONFIG_SME 386 struct { 387 u8 ssid[32]; 388 size_t ssid_len; 389 int freq; 390 u8 assoc_req_ie[200]; 391 size_t assoc_req_ie_len; 392 int mfp; 393 int ft_used; 394 u8 mobility_domain[2]; 395 u8 *ft_ies; 396 size_t ft_ies_len; 397 u8 prev_bssid[ETH_ALEN]; 398 int prev_bssid_set; 399 int auth_alg; 400 int proto; 401 402 int sa_query_count; /* number of pending SA Query requests; 403 * 0 = no SA Query in progress */ 404 int sa_query_timed_out; 405 u8 *sa_query_trans_id; /* buffer of WLAN_SA_QUERY_TR_ID_LEN * 406 * sa_query_count octets of pending 407 * SA Query transaction identifiers */ 408 struct os_time sa_query_start; 409 } sme; 410 #endif /* CONFIG_SME */ 411 412 #ifdef CONFIG_AP 413 struct hostapd_iface *ap_iface; 414 void (*ap_configured_cb)(void *ctx, void *data); 415 void *ap_configured_cb_ctx; 416 void *ap_configured_cb_data; 417 #endif /* CONFIG_AP */ 418 419 unsigned int off_channel_freq; 420 struct wpabuf *pending_action_tx; 421 u8 pending_action_src[ETH_ALEN]; 422 u8 pending_action_dst[ETH_ALEN]; 423 u8 pending_action_bssid[ETH_ALEN]; 424 unsigned int pending_action_freq; 425 int pending_action_no_cck; 426 int pending_action_without_roc; 427 void (*pending_action_tx_status_cb)(struct wpa_supplicant *wpa_s, 428 unsigned int freq, const u8 *dst, 429 const u8 *src, const u8 *bssid, 430 const u8 *data, size_t data_len, 431 enum offchannel_send_action_result 432 result); 433 unsigned int roc_waiting_drv_freq; 434 int action_tx_wait_time; 435 436 #ifdef CONFIG_P2P 437 struct p2p_go_neg_results *go_params; 438 int create_p2p_iface; 439 u8 pending_interface_addr[ETH_ALEN]; 440 char pending_interface_name[100]; 441 int pending_interface_type; 442 int p2p_group_idx; 443 unsigned int pending_listen_freq; 444 unsigned int pending_listen_duration; 445 enum { 446 NOT_P2P_GROUP_INTERFACE, 447 P2P_GROUP_INTERFACE_PENDING, 448 P2P_GROUP_INTERFACE_GO, 449 P2P_GROUP_INTERFACE_CLIENT 450 } p2p_group_interface; 451 struct p2p_group *p2p_group; 452 int p2p_long_listen; /* remaining time in long Listen state in ms */ 453 char p2p_pin[10]; 454 int p2p_wps_method; 455 u8 p2p_auth_invite[ETH_ALEN]; 456 int p2p_sd_over_ctrl_iface; 457 int p2p_in_provisioning; 458 int pending_invite_ssid_id; 459 int show_group_started; 460 u8 go_dev_addr[ETH_ALEN]; 461 int pending_pd_before_join; 462 u8 pending_join_iface_addr[ETH_ALEN]; 463 u8 pending_join_dev_addr[ETH_ALEN]; 464 int pending_join_wps_method; 465 int p2p_join_scan_count; 466 int force_long_sd; 467 468 /* 469 * Whether cross connection is disallowed by the AP to which this 470 * interface is associated (only valid if there is an association). 471 */ 472 int cross_connect_disallowed; 473 474 /* 475 * Whether this P2P group is configured to use cross connection (only 476 * valid if this is P2P GO interface). The actual cross connect packet 477 * forwarding may not be configured depending on the uplink status. 478 */ 479 int cross_connect_enabled; 480 481 /* Whether cross connection forwarding is in use at the moment. */ 482 int cross_connect_in_use; 483 484 /* 485 * Uplink interface name for cross connection 486 */ 487 char cross_connect_uplink[100]; 488 489 enum { 490 P2P_GROUP_REMOVAL_UNKNOWN, 491 P2P_GROUP_REMOVAL_REQUESTED, 492 P2P_GROUP_REMOVAL_IDLE_TIMEOUT, 493 P2P_GROUP_REMOVAL_UNAVAILABLE, 494 #ifdef ANDROID_P2P 495 P2P_GROUP_REMOVAL_FREQ_CONFLICT 496 #endif 497 } removal_reason; 498 499 unsigned int p2p_cb_on_scan_complete:1; 500 #endif /* CONFIG_P2P */ 501 502 struct wpa_ssid *bgscan_ssid; 503 const struct bgscan_ops *bgscan; 504 void *bgscan_priv; 505 506 struct wpa_ssid *connect_without_scan; 507 508 int after_wps; 509 int known_wps_freq; 510 unsigned int wps_freq; 511 int wps_fragment_size; 512 int auto_reconnect_disabled; 513 514 /* Channel preferences for AP/P2P GO use */ 515 int best_24_freq; 516 int best_5_freq; 517 int best_overall_freq; 518 519 struct gas_query *gas; 520 521 #ifdef CONFIG_INTERWORKING 522 unsigned int fetch_anqp_in_progress:1; 523 unsigned int network_select:1; 524 unsigned int auto_select:1; 525 #endif /* CONFIG_INTERWORKING */ 526 unsigned int drv_capa_known; 527 528 struct { 529 struct hostapd_hw_modes *modes; 530 u16 num_modes; 531 u16 flags; 532 } hw; 533 534 int pno; 535 }; 536 537 538 /* wpa_supplicant.c */ 539 void wpa_supplicant_apply_ht_overrides( 540 struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid, 541 struct wpa_driver_associate_params *params); 542 543 int wpa_set_wep_keys(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid); 544 545 int wpa_supplicant_reload_configuration(struct wpa_supplicant *wpa_s); 546 547 const char * wpa_supplicant_state_txt(enum wpa_states state); 548 int wpa_supplicant_update_mac_addr(struct wpa_supplicant *wpa_s); 549 int wpa_supplicant_driver_init(struct wpa_supplicant *wpa_s); 550 int wpa_supplicant_set_suites(struct wpa_supplicant *wpa_s, 551 struct wpa_bss *bss, struct wpa_ssid *ssid, 552 u8 *wpa_ie, size_t *wpa_ie_len); 553 void wpa_supplicant_associate(struct wpa_supplicant *wpa_s, 554 struct wpa_bss *bss, 555 struct wpa_ssid *ssid); 556 void wpa_supplicant_set_non_wpa_policy(struct wpa_supplicant *wpa_s, 557 struct wpa_ssid *ssid); 558 void wpa_supplicant_initiate_eapol(struct wpa_supplicant *wpa_s); 559 void wpa_clear_keys(struct wpa_supplicant *wpa_s, const u8 *addr); 560 void wpa_supplicant_req_auth_timeout(struct wpa_supplicant *wpa_s, 561 int sec, int usec); 562 void wpa_supplicant_set_state(struct wpa_supplicant *wpa_s, 563 enum wpa_states state); 564 struct wpa_ssid * wpa_supplicant_get_ssid(struct wpa_supplicant *wpa_s); 565 const char * wpa_supplicant_get_eap_mode(struct wpa_supplicant *wpa_s); 566 void wpa_supplicant_cancel_auth_timeout(struct wpa_supplicant *wpa_s); 567 void wpa_supplicant_deauthenticate(struct wpa_supplicant *wpa_s, 568 int reason_code); 569 void wpa_supplicant_disassociate(struct wpa_supplicant *wpa_s, 570 int reason_code); 571 572 void wpa_supplicant_enable_network(struct wpa_supplicant *wpa_s, 573 struct wpa_ssid *ssid); 574 void wpa_supplicant_disable_network(struct wpa_supplicant *wpa_s, 575 struct wpa_ssid *ssid); 576 void wpa_supplicant_select_network(struct wpa_supplicant *wpa_s, 577 struct wpa_ssid *ssid); 578 int wpa_supplicant_set_ap_scan(struct wpa_supplicant *wpa_s, 579 int ap_scan); 580 int wpa_supplicant_set_bss_expiration_age(struct wpa_supplicant *wpa_s, 581 unsigned int expire_age); 582 int wpa_supplicant_set_bss_expiration_count(struct wpa_supplicant *wpa_s, 583 unsigned int expire_count); 584 int wpa_supplicant_set_debug_params(struct wpa_global *global, 585 int debug_level, int debug_timestamp, 586 int debug_show_keys); 587 588 void wpa_show_license(void); 589 590 struct wpa_supplicant * wpa_supplicant_add_iface(struct wpa_global *global, 591 struct wpa_interface *iface); 592 int wpa_supplicant_remove_iface(struct wpa_global *global, 593 struct wpa_supplicant *wpa_s, 594 int terminate); 595 struct wpa_supplicant * wpa_supplicant_get_iface(struct wpa_global *global, 596 const char *ifname); 597 struct wpa_global * wpa_supplicant_init(struct wpa_params *params); 598 int wpa_supplicant_run(struct wpa_global *global); 599 void wpa_supplicant_deinit(struct wpa_global *global); 600 601 int wpa_supplicant_scard_init(struct wpa_supplicant *wpa_s, 602 struct wpa_ssid *ssid); 603 void wpa_supplicant_terminate_proc(struct wpa_global *global); 604 void wpa_supplicant_rx_eapol(void *ctx, const u8 *src_addr, 605 const u8 *buf, size_t len); 606 enum wpa_key_mgmt key_mgmt2driver(int key_mgmt); 607 enum wpa_cipher cipher_suite2driver(int cipher); 608 void wpa_supplicant_update_config(struct wpa_supplicant *wpa_s); 609 void wpa_supplicant_clear_status(struct wpa_supplicant *wpa_s); 610 void wpas_connection_failed(struct wpa_supplicant *wpa_s, const u8 *bssid); 611 int wpas_driver_bss_selection(struct wpa_supplicant *wpa_s); 612 #ifdef ANDROID_P2P 613 int wpas_is_p2p_prioritized(struct wpa_supplicant *wpa_s); 614 #endif 615 616 /* events.c */ 617 void wpa_supplicant_mark_disassoc(struct wpa_supplicant *wpa_s); 618 int wpa_supplicant_connect(struct wpa_supplicant *wpa_s, 619 struct wpa_bss *selected, 620 struct wpa_ssid *ssid); 621 void wpa_supplicant_stop_countermeasures(void *eloop_ctx, void *sock_ctx); 622 void wpa_supplicant_delayed_mic_error_report(void *eloop_ctx, void *sock_ctx); 623 624 /* eap_register.c */ 625 int eap_register_methods(void); 626 627 /** 628 * Utility method to tell if a given network is a persistent group 629 * @ssid: Network object 630 * Returns: 1 if network is a persistent group, 0 otherwise 631 */ 632 static inline int network_is_persistent_group(struct wpa_ssid *ssid) 633 { 634 return ((ssid->disabled == 2) || ssid->p2p_persistent_group); 635 } 636 637 #endif /* WPA_SUPPLICANT_I_H */ 638
