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