src/rsn_supp/wpa.h

   1 /*
   2  * wpa_supplicant - WPA definitions
   3  * Copyright (c) 2003-2015, 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_H
  10 #define WPA_H
  11
  12 #include "common/defs.h"
  13 #include "common/eapol_common.h"
  14 #include "common/wpa_common.h"
  15 #include "common/ieee802_11_defs.h"
  16
  17 struct wpa_sm;
  18 struct eapol_sm;
  19 struct wpa_config_blob;
  20 struct hostapd_freq_params;
  21 struct wpa_channel_info;
  22
  23 struct wpa_sm_ctx {
  24         void *ctx; /* pointer to arbitrary upper level context */
  25         void *msg_ctx; /* upper level context for wpa_msg() calls */
  26
  27         void (*set_state)(void *ctx, enum wpa_states state);
  28         enum wpa_states (*get_state)(void *ctx);
  29         void (*deauthenticate)(void * ctx, u16 reason_code);
  30         void (*reconnect)(void *ctx);
  31         int (*set_key)(void *ctx, enum wpa_alg alg,
  32                        const u8 *addr, int key_idx, int set_tx,
  33                        const u8 *seq, size_t seq_len,
  34                        const u8 *key, size_t key_len, enum key_flag key_flag);
  35         void * (*get_network_ctx)(void *ctx);
  36         int (*get_bssid)(void *ctx, u8 *bssid);
  37         int (*ether_send)(void *ctx, const u8 *dest, u16 proto, const u8 *buf,
  38                           size_t len);
  39         int (*get_beacon_ie)(void *ctx);
  40         void (*cancel_auth_timeout)(void *ctx);
  41         u8 * (*alloc_eapol)(void *ctx, u8 type, const void *data, u16 data_len,
  42                             size_t *msg_len, void **data_pos);
  43         int (*add_pmkid)(void *ctx, void *network_ctx, const u8 *bssid,
  44                          const u8 *pmkid, const u8 *fils_cache_id,
  45                          const u8 *pmk, size_t pmk_len);
  46         int (*remove_pmkid)(void *ctx, void *network_ctx, const u8 *bssid,
  47                             const u8 *pmkid, const u8 *fils_cache_id);
  48         void (*set_config_blob)(void *ctx, struct wpa_config_blob *blob);
  49         const struct wpa_config_blob * (*get_config_blob)(void *ctx,
  50                                                           const char *name);
  51         int (*mlme_setprotection)(void *ctx, const u8 *addr,
  52                                   int protection_type, int key_type);
  53         int (*update_ft_ies)(void *ctx, const u8 *md, const u8 *ies,
  54                              size_t ies_len);
  55         int (*send_ft_action)(void *ctx, u8 action, const u8 *target_ap,
  56                               const u8 *ies, size_t ies_len);
  57         int (*mark_authenticated)(void *ctx, const u8 *target_ap);
  58 #ifdef CONFIG_TDLS
  59         int (*tdls_get_capa)(void *ctx, int *tdls_supported,
  60                              int *tdls_ext_setup, int *tdls_chan_switch);
  61         int (*send_tdls_mgmt)(void *ctx, const u8 *dst,
  62                               u8 action_code, u8 dialog_token,
  63                               u16 status_code, u32 peer_capab,
  64                               int initiator, const u8 *buf, size_t len);
  65         int (*tdls_oper)(void *ctx, int oper, const u8 *peer);
  66         int (*tdls_peer_addset)(void *ctx, const u8 *addr, int add, u16 aid,
  67                                 u16 capability, const u8 *supp_rates,
  68                                 size_t supp_rates_len,
  69                                 const struct ieee80211_ht_capabilities *ht_capab,
  70                                 const struct ieee80211_vht_capabilities *vht_capab,
  71                                 u8 qosinfo, int wmm, const u8 *ext_capab,
  72                                 size_t ext_capab_len, const u8 *supp_channels,
  73                                 size_t supp_channels_len,
  74                                 const u8 *supp_oper_classes,
  75                                 size_t supp_oper_classes_len);
  76         int (*tdls_enable_channel_switch)(
  77                 void *ctx, const u8 *addr, u8 oper_class,
  78                 const struct hostapd_freq_params *params);
  79         int (*tdls_disable_channel_switch)(void *ctx, const u8 *addr);
  80 #endif /* CONFIG_TDLS */
  81         void (*set_rekey_offload)(void *ctx, const u8 *kek, size_t kek_len,
  82                                   const u8 *kck, size_t kck_len,
  83                                   const u8 *replay_ctr);
  84         int (*key_mgmt_set_pmk)(void *ctx, const u8 *pmk, size_t pmk_len);
  85         void (*fils_hlp_rx)(void *ctx, const u8 *dst, const u8 *src,
  86                             const u8 *pkt, size_t pkt_len);
  87         int (*channel_info)(void *ctx, struct wpa_channel_info *ci);
  88 };
  89
  90
  91 enum wpa_sm_conf_params {
  92         RSNA_PMK_LIFETIME /* dot11RSNAConfigPMKLifetime */,
  93         RSNA_PMK_REAUTH_THRESHOLD /* dot11RSNAConfigPMKReauthThreshold */,
  94         RSNA_SA_TIMEOUT /* dot11RSNAConfigSATimeout */,
  95         WPA_PARAM_PROTO,
  96         WPA_PARAM_PAIRWISE,
  97         WPA_PARAM_GROUP,
  98         WPA_PARAM_KEY_MGMT,
  99         WPA_PARAM_MGMT_GROUP,
 100         WPA_PARAM_RSN_ENABLED,
 101         WPA_PARAM_MFP,
 102         WPA_PARAM_OCV,
 103         WPA_PARAM_SAE_PWE,
 104         WPA_PARAM_DENY_PTK0_REKEY,
 105         WPA_PARAM_EXT_KEY_ID,
 106         WPA_PARAM_USE_EXT_KEY_ID,
 107 };
 108
 109 struct rsn_supp_config {
 110         void *network_ctx;
 111         int allowed_pairwise_cipher; /* bitfield of WPA_CIPHER_* */
 112         int proactive_key_caching;
 113         int eap_workaround;
 114         void *eap_conf_ctx;
 115         const u8 *ssid;
 116         size_t ssid_len;
 117         int wpa_ptk_rekey;
 118         int wpa_deny_ptk0_rekey;
 119         int p2p;
 120         int wpa_rsc_relaxation;
 121         int owe_ptk_workaround;
 122         const u8 *fils_cache_id;
 123         int beacon_prot;
 124 };
 125
 126 #ifndef CONFIG_NO_WPA
 127
 128 struct wpa_sm * wpa_sm_init(struct wpa_sm_ctx *ctx);
 129 void wpa_sm_deinit(struct wpa_sm *sm);
 130 void wpa_sm_notify_assoc(struct wpa_sm *sm, const u8 *bssid);
 131 void wpa_sm_notify_disassoc(struct wpa_sm *sm);
 132 void wpa_sm_set_pmk(struct wpa_sm *sm, const u8 *pmk, size_t pmk_len,
 133                     const u8 *pmkid, const u8 *bssid);
 134 void wpa_sm_set_pmk_from_pmksa(struct wpa_sm *sm);
 135 void wpa_sm_set_fast_reauth(struct wpa_sm *sm, int fast_reauth);
 136 void wpa_sm_set_scard_ctx(struct wpa_sm *sm, void *scard_ctx);
 137 void wpa_sm_set_config(struct wpa_sm *sm, struct rsn_supp_config *config);
 138 void wpa_sm_set_own_addr(struct wpa_sm *sm, const u8 *addr);
 139 void wpa_sm_set_ifname(struct wpa_sm *sm, const char *ifname,
 140                        const char *bridge_ifname);
 141 void wpa_sm_set_eapol(struct wpa_sm *sm, struct eapol_sm *eapol);
 142 int wpa_sm_set_assoc_wpa_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
 143 int wpa_sm_set_assoc_wpa_ie_default(struct wpa_sm *sm, u8 *wpa_ie,
 144                                     size_t *wpa_ie_len);
 145 int wpa_sm_set_assoc_rsnxe_default(struct wpa_sm *sm, u8 *rsnxe,
 146                                    size_t *rsnxe_len);
 147 int wpa_sm_set_assoc_rsnxe(struct wpa_sm *sm, const u8 *ie, size_t len);
 148 int wpa_sm_set_ap_wpa_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
 149 int wpa_sm_set_ap_rsn_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
 150 int wpa_sm_set_ap_rsnxe(struct wpa_sm *sm, const u8 *ie, size_t len);
 151 int wpa_sm_get_mib(struct wpa_sm *sm, char *buf, size_t buflen);
 152
 153 int wpa_sm_set_param(struct wpa_sm *sm, enum wpa_sm_conf_params param,
 154                      unsigned int value);
 155
 156 int wpa_sm_get_status(struct wpa_sm *sm, char *buf, size_t buflen,
 157                       int verbose);
 158 int wpa_sm_pmf_enabled(struct wpa_sm *sm);
 159 int wpa_sm_ext_key_id(struct wpa_sm *sm);
 160 int wpa_sm_ext_key_id_active(struct wpa_sm *sm);
 161 int wpa_sm_ocv_enabled(struct wpa_sm *sm);
 162
 163 void wpa_sm_key_request(struct wpa_sm *sm, int error, int pairwise);
 164
 165 int wpa_parse_wpa_ie(const u8 *wpa_ie, size_t wpa_ie_len,
 166                      struct wpa_ie_data *data);
 167
 168 void wpa_sm_aborted_cached(struct wpa_sm *sm);
 169 int wpa_sm_rx_eapol(struct wpa_sm *sm, const u8 *src_addr,
 170                     const u8 *buf, size_t len);
 171 int wpa_sm_parse_own_wpa_ie(struct wpa_sm *sm, struct wpa_ie_data *data);
 172 int wpa_sm_pmksa_cache_list(struct wpa_sm *sm, char *buf, size_t len);
 173 struct rsn_pmksa_cache_entry * wpa_sm_pmksa_cache_head(struct wpa_sm *sm);
 174 struct rsn_pmksa_cache_entry *
 175 wpa_sm_pmksa_cache_add_entry(struct wpa_sm *sm,
 176                              struct rsn_pmksa_cache_entry * entry);
 177 void wpa_sm_pmksa_cache_add(struct wpa_sm *sm, const u8 *pmk, size_t pmk_len,
 178                             const u8 *pmkid, const u8 *bssid,
 179                             const u8 *fils_cache_id);
 180 int wpa_sm_pmksa_exists(struct wpa_sm *sm, const u8 *bssid,
 181                         const void *network_ctx);
 182 void wpa_sm_drop_sa(struct wpa_sm *sm);
 183 int wpa_sm_has_ptk(struct wpa_sm *sm);
 184 int wpa_sm_has_ptk_installed(struct wpa_sm *sm);
 185
 186 void wpa_sm_update_replay_ctr(struct wpa_sm *sm, const u8 *replay_ctr);
 187
 188 void wpa_sm_pmksa_cache_flush(struct wpa_sm *sm, void *network_ctx);
 189
 190 int wpa_sm_get_p2p_ip_addr(struct wpa_sm *sm, u8 *buf);
 191
 192 void wpa_sm_set_rx_replay_ctr(struct wpa_sm *sm, const u8 *rx_replay_counter);
 193 void wpa_sm_set_ptk_kck_kek(struct wpa_sm *sm,
 194                             const u8 *ptk_kck, size_t ptk_kck_len,
 195                             const u8 *ptk_kek, size_t ptk_kek_len);
 196 int wpa_fils_is_completed(struct wpa_sm *sm);
 197
 198 #else /* CONFIG_NO_WPA */
 199
 200 static inline struct wpa_sm * wpa_sm_init(struct wpa_sm_ctx *ctx)
 201 {
 202         return (struct wpa_sm *) 1;
 203 }
 204
 205 static inline void wpa_sm_deinit(struct wpa_sm *sm)
 206 {
 207 }
 208
 209 static inline void wpa_sm_notify_assoc(struct wpa_sm *sm, const u8 *bssid)
 210 {
 211 }
 212
 213 static inline void wpa_sm_notify_disassoc(struct wpa_sm *sm)
 214 {
 215 }
 216
 217 static inline void wpa_sm_set_pmk(struct wpa_sm *sm, const u8 *pmk,
 218                                   size_t pmk_len, const u8 *pmkid,
 219                                   const u8 *bssid)
 220 {
 221 }
 222
 223 static inline void wpa_sm_set_pmk_from_pmksa(struct wpa_sm *sm)
 224 {
 225 }
 226
 227 static inline void wpa_sm_set_fast_reauth(struct wpa_sm *sm, int fast_reauth)
 228 {
 229 }
 230
 231 static inline void wpa_sm_set_scard_ctx(struct wpa_sm *sm, void *scard_ctx)
 232 {
 233 }
 234
 235 static inline void wpa_sm_set_config(struct wpa_sm *sm,
 236                                      struct rsn_supp_config *config)
 237 {
 238 }
 239
 240 static inline void wpa_sm_set_own_addr(struct wpa_sm *sm, const u8 *addr)
 241 {
 242 }
 243
 244 static inline void wpa_sm_set_ifname(struct wpa_sm *sm, const char *ifname,
 245                                      const char *bridge_ifname)
 246 {
 247 }
 248
 249 static inline void wpa_sm_set_eapol(struct wpa_sm *sm, struct eapol_sm *eapol)
 250 {
 251 }
 252
 253 static inline int wpa_sm_set_assoc_wpa_ie(struct wpa_sm *sm, const u8 *ie,
 254                                           size_t len)
 255 {
 256         return -1;
 257 }
 258
 259 static inline int wpa_sm_set_assoc_wpa_ie_default(struct wpa_sm *sm,
 260                                                   u8 *wpa_ie,
 261                                                   size_t *wpa_ie_len)
 262 {
 263         return -1;
 264 }
 265
 266 static inline int wpa_sm_set_ap_wpa_ie(struct wpa_sm *sm, const u8 *ie,
 267                                        size_t len)
 268 {
 269         return -1;
 270 }
 271
 272 static inline int wpa_sm_set_ap_rsn_ie(struct wpa_sm *sm, const u8 *ie,
 273                                        size_t len)
 274 {
 275         return -1;
 276 }
 277
 278 static inline int wpa_sm_set_ap_rsnxe(struct wpa_sm *sm, const u8 *ie,
 279                                       size_t len)
 280 {
 281         return -1;
 282 }
 283
 284 static inline int wpa_sm_get_mib(struct wpa_sm *sm, char *buf, size_t buflen)
 285 {
 286         return 0;
 287 }
 288
 289 static inline int wpa_sm_set_param(struct wpa_sm *sm,
 290                                    enum wpa_sm_conf_params param,
 291                                    unsigned int value)
 292 {
 293         return -1;
 294 }
 295
 296 static inline int wpa_sm_get_status(struct wpa_sm *sm, char *buf,
 297                                     size_t buflen, int verbose)
 298 {
 299         return 0;
 300 }
 301
 302 static inline int wpa_sm_pmf_enabled(struct wpa_sm *sm)
 303 {
 304         return 0;
 305 }
 306
 307 static inline int wpa_sm_ext_key_id(struct wpa_sm *sm)
 308 {
 309         return 0;
 310 }
 311
 312 static inline int wpa_sm_ext_key_id_active(struct wpa_sm *sm)
 313 {
 314         return 0;
 315 }
 316
 317 static inline int wpa_sm_ocv_enabled(struct wpa_sm *sm)
 318 {
 319         return 0;
 320 }
 321
 322 static inline void wpa_sm_key_request(struct wpa_sm *sm, int error,
 323                                       int pairwise)
 324 {
 325 }
 326
 327 static inline int wpa_parse_wpa_ie(const u8 *wpa_ie, size_t wpa_ie_len,
 328                                    struct wpa_ie_data *data)
 329 {
 330         return -1;
 331 }
 332
 333 static inline void wpa_sm_aborted_cached(struct wpa_sm *sm)
 334 {
 335 }
 336
 337 static inline int wpa_sm_rx_eapol(struct wpa_sm *sm, const u8 *src_addr,
 338                                   const u8 *buf, size_t len)
 339 {
 340         return -1;
 341 }
 342
 343 static inline int wpa_sm_parse_own_wpa_ie(struct wpa_sm *sm,
 344                                           struct wpa_ie_data *data)
 345 {
 346         return -1;
 347 }
 348
 349 static inline int wpa_sm_pmksa_cache_list(struct wpa_sm *sm, char *buf,
 350                                           size_t len)
 351 {
 352         return -1;
 353 }
 354
 355 static inline void wpa_sm_drop_sa(struct wpa_sm *sm)
 356 {
 357 }
 358
 359 static inline int wpa_sm_has_ptk(struct wpa_sm *sm)
 360 {
 361         return 0;
 362 }
 363
 364 static inline void wpa_sm_update_replay_ctr(struct wpa_sm *sm,
 365                                             const u8 *replay_ctr)
 366 {
 367 }
 368
 369 static inline void wpa_sm_pmksa_cache_flush(struct wpa_sm *sm,
 370                                             void *network_ctx)
 371 {
 372 }
 373
 374 static inline void wpa_sm_set_rx_replay_ctr(struct wpa_sm *sm,
 375                                             const u8 *rx_replay_counter)
 376 {
 377 }
 378
 379 static inline void wpa_sm_set_ptk_kck_kek(struct wpa_sm *sm, const u8 *ptk_kck,
 380                                           size_t ptk_kck_len,
 381                                           const u8 *ptk_kek, size_t ptk_kek_len)
 382 {
 383 }
 384
 385 static inline int wpa_fils_is_completed(struct wpa_sm *sm)
 386 {
 387         return 0;
 388 }
 389
 390 #endif /* CONFIG_NO_WPA */
 391
 392 #ifdef CONFIG_IEEE80211R
 393
 394 int wpa_sm_set_ft_params(struct wpa_sm *sm, const u8 *ies, size_t ies_len);
 395 int wpa_ft_prepare_auth_request(struct wpa_sm *sm, const u8 *mdie);
 396 int wpa_ft_add_mdie(struct wpa_sm *sm, u8 *ies, size_t ies_len,
 397                     const u8 *mdie);
 398 const u8 * wpa_sm_get_ft_md(struct wpa_sm *sm);
 399 int wpa_ft_process_response(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
 400                             int ft_action, const u8 *target_ap,
 401                             const u8 *ric_ies, size_t ric_ies_len);
 402 int wpa_ft_is_completed(struct wpa_sm *sm);
 403 void wpa_reset_ft_completed(struct wpa_sm *sm);
 404 int wpa_ft_validate_reassoc_resp(struct wpa_sm *sm, const u8 *ies,
 405                                  size_t ies_len, const u8 *src_addr);
 406 int wpa_ft_start_over_ds(struct wpa_sm *sm, const u8 *target_ap,
 407                          const u8 *mdie);
 408
 409 #else /* CONFIG_IEEE80211R */
 410
 411 static inline int
 412 wpa_sm_set_ft_params(struct wpa_sm *sm, const u8 *ies, size_t ies_len)
 413 {
 414         return 0;
 415 }
 416
 417 static inline int wpa_ft_prepare_auth_request(struct wpa_sm *sm,
 418                                               const u8 *mdie)
 419 {
 420         return 0;
 421 }
 422
 423 static inline int wpa_ft_add_mdie(struct wpa_sm *sm, u8 *ies, size_t ies_len,
 424                                   const u8 *mdie)
 425 {
 426         return 0;
 427 }
 428
 429 static inline int
 430 wpa_ft_process_response(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
 431                         int ft_action, const u8 *target_ap)
 432 {
 433         return 0;
 434 }
 435
 436 static inline int wpa_ft_is_completed(struct wpa_sm *sm)
 437 {
 438         return 0;
 439 }
 440
 441 static inline void wpa_reset_ft_completed(struct wpa_sm *sm)
 442 {
 443 }
 444
 445 static inline int
 446 wpa_ft_validate_reassoc_resp(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
 447                              const u8 *src_addr)
 448 {
 449         return -1;
 450 }
 451
 452 #endif /* CONFIG_IEEE80211R */
 453
 454
 455 /* tdls.c */
 456 void wpa_tdls_ap_ies(struct wpa_sm *sm, const u8 *ies, size_t len);
 457 void wpa_tdls_assoc_resp_ies(struct wpa_sm *sm, const u8 *ies, size_t len);
 458 int wpa_tdls_start(struct wpa_sm *sm, const u8 *addr);
 459 void wpa_tdls_remove(struct wpa_sm *sm, const u8 *addr);
 460 int wpa_tdls_teardown_link(struct wpa_sm *sm, const u8 *addr, u16 reason_code);
 461 int wpa_tdls_send_discovery_request(struct wpa_sm *sm, const u8 *addr);
 462 int wpa_tdls_init(struct wpa_sm *sm);
 463 void wpa_tdls_teardown_peers(struct wpa_sm *sm);
 464 void wpa_tdls_deinit(struct wpa_sm *sm);
 465 void wpa_tdls_enable(struct wpa_sm *sm, int enabled);
 466 void wpa_tdls_disable_unreachable_link(struct wpa_sm *sm, const u8 *addr);
 467 const char * wpa_tdls_get_link_status(struct wpa_sm *sm, const u8 *addr);
 468 int wpa_tdls_is_external_setup(struct wpa_sm *sm);
 469 int wpa_tdls_enable_chan_switch(struct wpa_sm *sm, const u8 *addr,
 470                                 u8 oper_class,
 471                                 struct hostapd_freq_params *freq_params);
 472 int wpa_tdls_disable_chan_switch(struct wpa_sm *sm, const u8 *addr);
 473 #ifdef CONFIG_TDLS_TESTING
 474 extern unsigned int tdls_testing;
 475 #endif /* CONFIG_TDLS_TESTING */
 476
 477
 478 int wpa_wnmsleep_install_key(struct wpa_sm *sm, u8 subelem_id, u8 *buf);
 479 void wpa_sm_set_test_assoc_ie(struct wpa_sm *sm, struct wpabuf *buf);
 480 const u8 * wpa_sm_get_anonce(struct wpa_sm *sm);
 481 unsigned int wpa_sm_get_key_mgmt(struct wpa_sm *sm);
 482
 483 struct wpabuf * fils_build_auth(struct wpa_sm *sm, int dh_group, const u8 *md);
 484 int fils_process_auth(struct wpa_sm *sm, const u8 *bssid, const u8 *data,
 485                       size_t len);
 486 struct wpabuf * fils_build_assoc_req(struct wpa_sm *sm, const u8 **kek,
 487                                      size_t *kek_len, const u8 **snonce,
 488                                      const u8 **anonce,
 489                                      const struct wpabuf **hlp,
 490                                      unsigned int num_hlp);
 491 int fils_process_assoc_resp(struct wpa_sm *sm, const u8 *resp, size_t len);
 492
 493 struct wpabuf * owe_build_assoc_req(struct wpa_sm *sm, u16 group);
 494 int owe_process_assoc_resp(struct wpa_sm *sm, const u8 *bssid,
 495                            const u8 *resp_ies, size_t resp_ies_len);
 496
 497 void wpa_sm_set_reset_fils_completed(struct wpa_sm *sm, int set);
 498 void wpa_sm_set_fils_cache_id(struct wpa_sm *sm, const u8 *fils_cache_id);
 499 void wpa_sm_set_dpp_z(struct wpa_sm *sm, const struct wpabuf *z);
 500
 501 #endif /* WPA_H */