wpa_supplicant/wpa_supplicant_i.h

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