wpa_supplicant_i.h revision 1.1.1.2.8.1
1 /* 2 * wpa_supplicant - Internal definitions 3 * Copyright (c) 2003-2010, Jouni Malinen <j (at) 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 enum offchannel_send_action_result { 232 OFFCHANNEL_SEND_ACTION_SUCCESS /* Frame was send and acknowledged */, 233 OFFCHANNEL_SEND_ACTION_NO_ACK /* Frame was sent, but not acknowledged 234 */, 235 OFFCHANNEL_SEND_ACTION_FAILED /* Frame was not sent due to a failure */ 236 }; 237 238 /** 239 * struct wpa_supplicant - Internal data for wpa_supplicant interface 240 * 241 * This structure contains the internal data for core wpa_supplicant code. This 242 * should be only used directly from the core code. However, a pointer to this 243 * data is used from other files as an arbitrary context pointer in calls to 244 * core functions. 245 */ 246 struct wpa_supplicant { 247 struct wpa_global *global; 248 struct wpa_supplicant *parent; 249 struct wpa_supplicant *next; 250 struct l2_packet_data *l2; 251 struct l2_packet_data *l2_br; 252 unsigned char own_addr[ETH_ALEN]; 253 char ifname[100]; 254 #ifdef CONFIG_CTRL_IFACE_DBUS 255 char *dbus_path; 256 #endif /* CONFIG_CTRL_IFACE_DBUS */ 257 #ifdef CONFIG_CTRL_IFACE_DBUS_NEW 258 char *dbus_new_path; 259 char *dbus_groupobj_path; 260 #endif /* CONFIG_CTRL_IFACE_DBUS_NEW */ 261 char bridge_ifname[16]; 262 263 char *confname; 264 struct wpa_config *conf; 265 int countermeasures; 266 os_time_t last_michael_mic_error; 267 u8 bssid[ETH_ALEN]; 268 u8 pending_bssid[ETH_ALEN]; /* If wpa_state == WPA_ASSOCIATING, this 269 * field contains the target BSSID. */ 270 int reassociate; /* reassociation requested */ 271 int disconnected; /* all connections disabled; i.e., do no reassociate 272 * before this has been cleared */ 273 struct wpa_ssid *current_ssid; 274 struct wpa_bss *current_bss; 275 int ap_ies_from_associnfo; 276 unsigned int assoc_freq; 277 278 /* Selected configuration (based on Beacon/ProbeResp WPA IE) */ 279 int pairwise_cipher; 280 int group_cipher; 281 int key_mgmt; 282 int wpa_proto; 283 int mgmt_group_cipher; 284 285 void *drv_priv; /* private data used by driver_ops */ 286 void *global_drv_priv; 287 288 struct wpa_ssid *prev_scan_ssid; /* previously scanned SSID; 289 * NULL = not yet initialized (start 290 * with wildcard SSID) 291 * WILDCARD_SSID_SCAN = wildcard 292 * SSID was used in the previous scan 293 */ 294 #define WILDCARD_SSID_SCAN ((struct wpa_ssid *) 1) 295 296 struct wpa_ssid *prev_sched_ssid; /* last SSID used in sched scan */ 297 int sched_scan_timeout; 298 int sched_scan_interval; 299 int first_sched_scan; 300 int sched_scan_timed_out; 301 302 void (*scan_res_handler)(struct wpa_supplicant *wpa_s, 303 struct wpa_scan_results *scan_res); 304 struct dl_list bss; /* struct wpa_bss::list */ 305 struct dl_list bss_id; /* struct wpa_bss::list_id */ 306 size_t num_bss; 307 unsigned int bss_update_idx; 308 unsigned int bss_next_id; 309 310 struct wpa_driver_ops *driver; 311 int interface_removed; /* whether the network interface has been 312 * removed */ 313 struct wpa_sm *wpa; 314 struct eapol_sm *eapol; 315 316 struct ctrl_iface_priv *ctrl_iface; 317 318 enum wpa_states wpa_state; 319 int scanning; 320 int sched_scanning; 321 int new_connection; 322 int reassociated_connection; 323 324 int eapol_received; /* number of EAPOL packets received after the 325 * previous association event */ 326 327 struct scard_data *scard; 328 329 unsigned char last_eapol_src[ETH_ALEN]; 330 331 int keys_cleared; 332 333 struct wpa_blacklist *blacklist; 334 335 int scan_req; /* manual scan request; this forces a scan even if there 336 * are no enabled networks in the configuration */ 337 int scan_runs; /* number of scan runs since WPS was started */ 338 int *next_scan_freqs; 339 int scan_interval; /* time in sec between scans to find suitable AP */ 340 341 unsigned int drv_flags; 342 int max_scan_ssids; 343 int max_sched_scan_ssids; 344 int sched_scan_supported; 345 unsigned int max_match_sets; 346 unsigned int max_remain_on_chan; 347 unsigned int max_stations; 348 349 int pending_mic_error_report; 350 int pending_mic_error_pairwise; 351 int mic_errors_seen; /* Michael MIC errors with the current PTK */ 352 353 struct wps_context *wps; 354 int wps_success; /* WPS success event received */ 355 struct wps_er *wps_er; 356 int blacklist_cleared; 357 358 struct wpabuf *pending_eapol_rx; 359 struct os_time pending_eapol_rx_time; 360 u8 pending_eapol_rx_src[ETH_ALEN]; 361 362 struct ibss_rsn *ibss_rsn; 363 364 int set_sta_uapsd; 365 int sta_uapsd; 366 int set_ap_uapsd; 367 int ap_uapsd; 368 369 #ifdef CONFIG_SME 370 struct { 371 u8 ssid[32]; 372 size_t ssid_len; 373 int freq; 374 u8 assoc_req_ie[200]; 375 size_t assoc_req_ie_len; 376 int mfp; 377 int ft_used; 378 u8 mobility_domain[2]; 379 u8 *ft_ies; 380 size_t ft_ies_len; 381 u8 prev_bssid[ETH_ALEN]; 382 int prev_bssid_set; 383 int auth_alg; 384 int proto; 385 386 int sa_query_count; /* number of pending SA Query requests; 387 * 0 = no SA Query in progress */ 388 int sa_query_timed_out; 389 u8 *sa_query_trans_id; /* buffer of WLAN_SA_QUERY_TR_ID_LEN * 390 * sa_query_count octets of pending 391 * SA Query transaction identifiers */ 392 struct os_time sa_query_start; 393 } sme; 394 #endif /* CONFIG_SME */ 395 396 #ifdef CONFIG_AP 397 struct hostapd_iface *ap_iface; 398 void (*ap_configured_cb)(void *ctx, void *data); 399 void *ap_configured_cb_ctx; 400 void *ap_configured_cb_data; 401 #endif /* CONFIG_AP */ 402 403 unsigned int off_channel_freq; 404 struct wpabuf *pending_action_tx; 405 u8 pending_action_src[ETH_ALEN]; 406 u8 pending_action_dst[ETH_ALEN]; 407 u8 pending_action_bssid[ETH_ALEN]; 408 unsigned int pending_action_freq; 409 int pending_action_no_cck; 410 int pending_action_without_roc; 411 void (*pending_action_tx_status_cb)(struct wpa_supplicant *wpa_s, 412 unsigned int freq, const u8 *dst, 413 const u8 *src, const u8 *bssid, 414 const u8 *data, size_t data_len, 415 enum offchannel_send_action_result 416 result); 417 unsigned int roc_waiting_drv_freq; 418 int action_tx_wait_time; 419 420 #ifdef CONFIG_P2P 421 struct p2p_go_neg_results *go_params; 422 int create_p2p_iface; 423 u8 pending_interface_addr[ETH_ALEN]; 424 char pending_interface_name[100]; 425 int pending_interface_type; 426 int p2p_group_idx; 427 unsigned int pending_listen_freq; 428 unsigned int pending_listen_duration; 429 enum { 430 NOT_P2P_GROUP_INTERFACE, 431 P2P_GROUP_INTERFACE_PENDING, 432 P2P_GROUP_INTERFACE_GO, 433 P2P_GROUP_INTERFACE_CLIENT 434 } p2p_group_interface; 435 struct p2p_group *p2p_group; 436 int p2p_long_listen; /* remaining time in long Listen state in ms */ 437 char p2p_pin[10]; 438 int p2p_wps_method; 439 u8 p2p_auth_invite[ETH_ALEN]; 440 int p2p_sd_over_ctrl_iface; 441 int p2p_in_provisioning; 442 int pending_invite_ssid_id; 443 int show_group_started; 444 u8 go_dev_addr[ETH_ALEN]; 445 int pending_pd_before_join; 446 u8 pending_join_iface_addr[ETH_ALEN]; 447 u8 pending_join_dev_addr[ETH_ALEN]; 448 int pending_join_wps_method; 449 int p2p_join_scan_count; 450 int force_long_sd; 451 452 /* 453 * Whether cross connection is disallowed by the AP to which this 454 * interface is associated (only valid if there is an association). 455 */ 456 int cross_connect_disallowed; 457 458 /* 459 * Whether this P2P group is configured to use cross connection (only 460 * valid if this is P2P GO interface). The actual cross connect packet 461 * forwarding may not be configured depending on the uplink status. 462 */ 463 int cross_connect_enabled; 464 465 /* Whether cross connection forwarding is in use at the moment. */ 466 int cross_connect_in_use; 467 468 /* 469 * Uplink interface name for cross connection 470 */ 471 char cross_connect_uplink[100]; 472 473 enum { 474 P2P_GROUP_REMOVAL_UNKNOWN, 475 P2P_GROUP_REMOVAL_REQUESTED, 476 P2P_GROUP_REMOVAL_IDLE_TIMEOUT, 477 P2P_GROUP_REMOVAL_UNAVAILABLE 478 } removal_reason; 479 480 unsigned int p2p_cb_on_scan_complete:1; 481 #endif /* CONFIG_P2P */ 482 483 struct wpa_ssid *bgscan_ssid; 484 const struct bgscan_ops *bgscan; 485 void *bgscan_priv; 486 487 struct wpa_ssid *connect_without_scan; 488 489 int after_wps; 490 unsigned int wps_freq; 491 int wps_fragment_size; 492 int auto_reconnect_disabled; 493 494 /* Channel preferences for AP/P2P GO use */ 495 int best_24_freq; 496 int best_5_freq; 497 int best_overall_freq; 498 499 struct gas_query *gas; 500 501 #ifdef CONFIG_INTERWORKING 502 unsigned int fetch_anqp_in_progress:1; 503 unsigned int network_select:1; 504 unsigned int auto_select:1; 505 #endif /* CONFIG_INTERWORKING */ 506 unsigned int drv_capa_known; 507 508 struct { 509 struct hostapd_hw_modes *modes; 510 u16 num_modes; 511 u16 flags; 512 } hw; 513 }; 514 515 516 /* wpa_supplicant.c */ 517 int wpa_set_wep_keys(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid); 518 519 int wpa_supplicant_reload_configuration(struct wpa_supplicant *wpa_s); 520 521 const char * wpa_supplicant_state_txt(enum wpa_states state); 522 int wpa_supplicant_update_mac_addr(struct wpa_supplicant *wpa_s); 523 int wpa_supplicant_driver_init(struct wpa_supplicant *wpa_s); 524 int wpa_supplicant_set_suites(struct wpa_supplicant *wpa_s, 525 struct wpa_bss *bss, struct wpa_ssid *ssid, 526 u8 *wpa_ie, size_t *wpa_ie_len); 527 void wpa_supplicant_associate(struct wpa_supplicant *wpa_s, 528 struct wpa_bss *bss, 529 struct wpa_ssid *ssid); 530 void wpa_supplicant_set_non_wpa_policy(struct wpa_supplicant *wpa_s, 531 struct wpa_ssid *ssid); 532 void wpa_supplicant_initiate_eapol(struct wpa_supplicant *wpa_s); 533 void wpa_clear_keys(struct wpa_supplicant *wpa_s, const u8 *addr); 534 void wpa_supplicant_req_auth_timeout(struct wpa_supplicant *wpa_s, 535 int sec, int usec); 536 void wpa_supplicant_set_state(struct wpa_supplicant *wpa_s, 537 enum wpa_states state); 538 struct wpa_ssid * wpa_supplicant_get_ssid(struct wpa_supplicant *wpa_s); 539 const char * wpa_supplicant_get_eap_mode(struct wpa_supplicant *wpa_s); 540 void wpa_supplicant_cancel_auth_timeout(struct wpa_supplicant *wpa_s); 541 void wpa_supplicant_deauthenticate(struct wpa_supplicant *wpa_s, 542 int reason_code); 543 void wpa_supplicant_disassociate(struct wpa_supplicant *wpa_s, 544 int reason_code); 545 546 void wpa_supplicant_enable_network(struct wpa_supplicant *wpa_s, 547 struct wpa_ssid *ssid); 548 void wpa_supplicant_disable_network(struct wpa_supplicant *wpa_s, 549 struct wpa_ssid *ssid); 550 void wpa_supplicant_select_network(struct wpa_supplicant *wpa_s, 551 struct wpa_ssid *ssid); 552 int wpa_supplicant_set_ap_scan(struct wpa_supplicant *wpa_s, 553 int ap_scan); 554 int wpa_supplicant_set_bss_expiration_age(struct wpa_supplicant *wpa_s, 555 unsigned int expire_age); 556 int wpa_supplicant_set_bss_expiration_count(struct wpa_supplicant *wpa_s, 557 unsigned int expire_count); 558 int wpa_supplicant_set_debug_params(struct wpa_global *global, 559 int debug_level, int debug_timestamp, 560 int debug_show_keys); 561 void free_hw_features(struct wpa_supplicant *wpa_s); 562 563 void wpa_show_license(void); 564 565 struct wpa_supplicant * wpa_supplicant_add_iface(struct wpa_global *global, 566 struct wpa_interface *iface); 567 int wpa_supplicant_remove_iface(struct wpa_global *global, 568 struct wpa_supplicant *wpa_s); 569 struct wpa_supplicant * wpa_supplicant_get_iface(struct wpa_global *global, 570 const char *ifname); 571 struct wpa_global * wpa_supplicant_init(struct wpa_params *params); 572 int wpa_supplicant_run(struct wpa_global *global); 573 void wpa_supplicant_deinit(struct wpa_global *global); 574 575 int wpa_supplicant_scard_init(struct wpa_supplicant *wpa_s, 576 struct wpa_ssid *ssid); 577 void wpa_supplicant_terminate_proc(struct wpa_global *global); 578 void wpa_supplicant_rx_eapol(void *ctx, const u8 *src_addr, 579 const u8 *buf, size_t len); 580 enum wpa_key_mgmt key_mgmt2driver(int key_mgmt); 581 enum wpa_cipher cipher_suite2driver(int cipher); 582 void wpa_supplicant_update_config(struct wpa_supplicant *wpa_s); 583 void wpa_supplicant_clear_status(struct wpa_supplicant *wpa_s); 584 void wpas_connection_failed(struct wpa_supplicant *wpa_s, const u8 *bssid); 585 int wpas_driver_bss_selection(struct wpa_supplicant *wpa_s); 586 587 /* events.c */ 588 void wpa_supplicant_mark_disassoc(struct wpa_supplicant *wpa_s); 589 int wpa_supplicant_connect(struct wpa_supplicant *wpa_s, 590 struct wpa_bss *selected, 591 struct wpa_ssid *ssid); 592 void wpa_supplicant_stop_countermeasures(void *eloop_ctx, void *sock_ctx); 593 void wpa_supplicant_delayed_mic_error_report(void *eloop_ctx, void *sock_ctx); 594 595 /* eap_register.c */ 596 int eap_register_methods(void); 597 598 /** 599 * Utility method to tell if a given network is a persistent group 600 * @ssid: Network object 601 * Returns: 1 if network is a persistent group, 0 otherwise 602 */ 603 static inline int network_is_persistent_group(struct wpa_ssid *ssid) 604 { 605 return ((ssid->disabled == 2) || ssid->p2p_persistent_group); 606 } 607 608 #endif /* WPA_SUPPLICANT_I_H */ 609
Indexes created Sat Mar 21 00:23:06 UTC 2026