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 };
 119
 120 #ifndef CONFIG_NO_WPA
 121
 122 struct wpa_sm * wpa_sm_init(struct wpa_sm_ctx *ctx);
 123 void wpa_sm_deinit(struct wpa_sm *sm);
 124 void wpa_sm_notify_assoc(struct wpa_sm *sm, const u8 *bssid);
 125 void wpa_sm_notify_disassoc(struct wpa_sm *sm);
 126 void wpa_sm_set_pmk(struct wpa_sm *sm, const u8 *pmk, size_t pmk_len,
 127                     const u8 *pmkid, const u8 *bssid);
 128 void wpa_sm_set_pmk_from_pmksa(struct wpa_sm *sm);
 129 void wpa_sm_set_fast_reauth(struct wpa_sm *sm, int fast_reauth);
 130 void wpa_sm_set_scard_ctx(struct wpa_sm *sm, void *scard_ctx);
 131 void wpa_sm_set_config(struct wpa_sm *sm, struct rsn_supp_config *config);
 132 void wpa_sm_set_own_addr(struct wpa_sm *sm, const u8 *addr);
 133 void wpa_sm_set_ifname(struct wpa_sm *sm, const char *ifname,
 134                        const char *bridge_ifname);
 135 void wpa_sm_set_eapol(struct wpa_sm *sm, struct eapol_sm *eapol);
 136 int wpa_sm_set_assoc_wpa_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
 137 int wpa_sm_set_assoc_wpa_ie_default(struct wpa_sm *sm, u8 *wpa_ie,
 138                                     size_t *wpa_ie_len);
 139 int wpa_sm_set_assoc_rsnxe_default(struct wpa_sm *sm, u8 *rsnxe,
 140                                    size_t *rsnxe_len);
 141 int wpa_sm_set_assoc_rsnxe(struct wpa_sm *sm, const u8 *ie, size_t len);
 142 int wpa_sm_set_ap_wpa_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
 143 int wpa_sm_set_ap_rsn_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
 144 int wpa_sm_set_ap_rsnxe(struct wpa_sm *sm, const u8 *ie, size_t len);
 145 int wpa_sm_get_mib(struct wpa_sm *sm, char *buf, size_t buflen);
 146
 147 int wpa_sm_set_param(struct wpa_sm *sm, enum wpa_sm_conf_params param,
 148                      unsigned int value);
 149
 150 int wpa_sm_get_status(struct wpa_sm *sm, char *buf, size_t buflen,
 151                       int verbose);
 152 int wpa_sm_pmf_enabled(struct wpa_sm *sm);
 153 int wpa_sm_ocv_enabled(struct wpa_sm *sm);
 154
 155 void wpa_sm_key_request(struct wpa_sm *sm, int error, int pairwise);
 156
 157 int wpa_parse_wpa_ie(const u8 *wpa_ie, size_t wpa_ie_len,
 158                      struct wpa_ie_data *data);
 159
 160 void wpa_sm_aborted_cached(struct wpa_sm *sm);
 161 int wpa_sm_rx_eapol(struct wpa_sm *sm, const u8 *src_addr,
 162                     const u8 *buf, size_t len);
 163 int wpa_sm_parse_own_wpa_ie(struct wpa_sm *sm, struct wpa_ie_data *data);
 164 int wpa_sm_pmksa_cache_list(struct wpa_sm *sm, char *buf, size_t len);
 165 struct rsn_pmksa_cache_entry * wpa_sm_pmksa_cache_head(struct wpa_sm *sm);
 166 struct rsn_pmksa_cache_entry *
 167 wpa_sm_pmksa_cache_add_entry(struct wpa_sm *sm,
 168                              struct rsn_pmksa_cache_entry * entry);
 169 void wpa_sm_pmksa_cache_add(struct wpa_sm *sm, const u8 *pmk, size_t pmk_len,
 170                             const u8 *pmkid, const u8 *bssid,
 171                             const u8 *fils_cache_id);
 172 int wpa_sm_pmksa_exists(struct wpa_sm *sm, const u8 *bssid,
 173                         const void *network_ctx);
 174 void wpa_sm_drop_sa(struct wpa_sm *sm);
 175 int wpa_sm_has_ptk(struct wpa_sm *sm);
 176 int wpa_sm_has_ptk_installed(struct wpa_sm *sm);
 177
 178 void wpa_sm_update_replay_ctr(struct wpa_sm *sm, const u8 *replay_ctr);
 179
 180 void wpa_sm_pmksa_cache_flush(struct wpa_sm *sm, void *network_ctx);
 181
 182 int wpa_sm_get_p2p_ip_addr(struct wpa_sm *sm, u8 *buf);
 183
 184 void wpa_sm_set_rx_replay_ctr(struct wpa_sm *sm, const u8 *rx_replay_counter);
 185 void wpa_sm_set_ptk_kck_kek(struct wpa_sm *sm,
 186                             const u8 *ptk_kck, size_t ptk_kck_len,
 187                             const u8 *ptk_kek, size_t ptk_kek_len);
 188 int wpa_fils_is_completed(struct wpa_sm *sm);
 189
 190 #else /* CONFIG_NO_WPA */
 191
 192 static inline struct wpa_sm * wpa_sm_init(struct wpa_sm_ctx *ctx)
 193 {
 194         return (struct wpa_sm *) 1;
 195 }
 196
 197 static inline void wpa_sm_deinit(struct wpa_sm *sm)
 198 {
 199 }
 200
 201 static inline void wpa_sm_notify_assoc(struct wpa_sm *sm, const u8 *bssid)
 202 {
 203 }
 204
 205 static inline void wpa_sm_notify_disassoc(struct wpa_sm *sm)
 206 {
 207 }
 208
 209 static inline void wpa_sm_set_pmk(struct wpa_sm *sm, const u8 *pmk,
 210                                   size_t pmk_len, const u8 *pmkid,
 211                                   const u8 *bssid)
 212 {
 213 }
 214
 215 static inline void wpa_sm_set_pmk_from_pmksa(struct wpa_sm *sm)
 216 {
 217 }
 218
 219 static inline void wpa_sm_set_fast_reauth(struct wpa_sm *sm, int fast_reauth)
 220 {
 221 }
 222
 223 static inline void wpa_sm_set_scard_ctx(struct wpa_sm *sm, void *scard_ctx)
 224 {
 225 }
 226
 227 static inline void wpa_sm_set_config(struct wpa_sm *sm,
 228                                      struct rsn_supp_config *config)
 229 {
 230 }
 231
 232 static inline void wpa_sm_set_own_addr(struct wpa_sm *sm, const u8 *addr)
 233 {
 234 }
 235
 236 static inline void wpa_sm_set_ifname(struct wpa_sm *sm, const char *ifname,
 237                                      const char *bridge_ifname)
 238 {
 239 }
 240
 241 static inline void wpa_sm_set_eapol(struct wpa_sm *sm, struct eapol_sm *eapol)
 242 {
 243 }
 244
 245 static inline int wpa_sm_set_assoc_wpa_ie(struct wpa_sm *sm, const u8 *ie,
 246                                           size_t len)
 247 {
 248         return -1;
 249 }
 250
 251 static inline int wpa_sm_set_assoc_wpa_ie_default(struct wpa_sm *sm,
 252                                                   u8 *wpa_ie,
 253                                                   size_t *wpa_ie_len)
 254 {
 255         return -1;
 256 }
 257
 258 static inline int wpa_sm_set_ap_wpa_ie(struct wpa_sm *sm, const u8 *ie,
 259                                        size_t len)
 260 {
 261         return -1;
 262 }
 263
 264 static inline int wpa_sm_set_ap_rsn_ie(struct wpa_sm *sm, const u8 *ie,
 265                                        size_t len)
 266 {
 267         return -1;
 268 }
 269
 270 static inline int wpa_sm_set_ap_rsnxe(struct wpa_sm *sm, const u8 *ie,
 271                                       size_t len)
 272 {
 273         return -1;
 274 }
 275
 276 static inline int wpa_sm_get_mib(struct wpa_sm *sm, char *buf, size_t buflen)
 277 {
 278         return 0;
 279 }
 280
 281 static inline int wpa_sm_set_param(struct wpa_sm *sm,
 282                                    enum wpa_sm_conf_params param,
 283                                    unsigned int value)
 284 {
 285         return -1;
 286 }
 287
 288 static inline int wpa_sm_get_status(struct wpa_sm *sm, char *buf,
 289                                     size_t buflen, int verbose)
 290 {
 291         return 0;
 292 }
 293
 294 static inline int wpa_sm_pmf_enabled(struct wpa_sm *sm)
 295 {
 296         return 0;
 297 }
 298
 299 static inline int wpa_sm_ocv_enabled(struct wpa_sm *sm)
 300 {
 301         return 0;
 302 }
 303
 304 static inline void wpa_sm_key_request(struct wpa_sm *sm, int error,
 305                                       int pairwise)
 306 {
 307 }
 308
 309 static inline int wpa_parse_wpa_ie(const u8 *wpa_ie, size_t wpa_ie_len,
 310                                    struct wpa_ie_data *data)
 311 {
 312         return -1;
 313 }
 314
 315 static inline void wpa_sm_aborted_cached(struct wpa_sm *sm)
 316 {
 317 }
 318
 319 static inline int wpa_sm_rx_eapol(struct wpa_sm *sm, const u8 *src_addr,
 320                                   const u8 *buf, size_t len)
 321 {
 322         return -1;
 323 }
 324
 325 static inline int wpa_sm_parse_own_wpa_ie(struct wpa_sm *sm,
 326                                           struct wpa_ie_data *data)
 327 {
 328         return -1;
 329 }
 330
 331 static inline int wpa_sm_pmksa_cache_list(struct wpa_sm *sm, char *buf,
 332                                           size_t len)
 333 {
 334         return -1;
 335 }
 336
 337 static inline void wpa_sm_drop_sa(struct wpa_sm *sm)
 338 {
 339 }
 340
 341 static inline int wpa_sm_has_ptk(struct wpa_sm *sm)
 342 {
 343         return 0;
 344 }
 345
 346 static inline void wpa_sm_update_replay_ctr(struct wpa_sm *sm,
 347                                             const u8 *replay_ctr)
 348 {
 349 }
 350
 351 static inline void wpa_sm_pmksa_cache_flush(struct wpa_sm *sm,
 352                                             void *network_ctx)
 353 {
 354 }
 355
 356 static inline void wpa_sm_set_rx_replay_ctr(struct wpa_sm *sm,
 357                                             const u8 *rx_replay_counter)
 358 {
 359 }
 360
 361 static inline void wpa_sm_set_ptk_kck_kek(struct wpa_sm *sm, const u8 *ptk_kck,
 362                                           size_t ptk_kck_len,
 363                                           const u8 *ptk_kek, size_t ptk_kek_len)
 364 {
 365 }
 366
 367 static inline int wpa_fils_is_completed(struct wpa_sm *sm)
 368 {
 369         return 0;
 370 }
 371
 372 #endif /* CONFIG_NO_WPA */
 373
 374 #ifdef CONFIG_IEEE80211R
 375
 376 int wpa_sm_set_ft_params(struct wpa_sm *sm, const u8 *ies, size_t ies_len);
 377 int wpa_ft_prepare_auth_request(struct wpa_sm *sm, const u8 *mdie);
 378 int wpa_ft_add_mdie(struct wpa_sm *sm, u8 *ies, size_t ies_len,
 379                     const u8 *mdie);
 380 const u8 * wpa_sm_get_ft_md(struct wpa_sm *sm);
 381 int wpa_ft_process_response(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
 382                             int ft_action, const u8 *target_ap,
 383                             const u8 *ric_ies, size_t ric_ies_len);
 384 int wpa_ft_is_completed(struct wpa_sm *sm);
 385 void wpa_reset_ft_completed(struct wpa_sm *sm);
 386 int wpa_ft_validate_reassoc_resp(struct wpa_sm *sm, const u8 *ies,
 387                                  size_t ies_len, const u8 *src_addr);
 388 int wpa_ft_start_over_ds(struct wpa_sm *sm, const u8 *target_ap,
 389                          const u8 *mdie);
 390
 391 #else /* CONFIG_IEEE80211R */
 392
 393 static inline int
 394 wpa_sm_set_ft_params(struct wpa_sm *sm, const u8 *ies, size_t ies_len)
 395 {
 396         return 0;
 397 }
 398
 399 static inline int wpa_ft_prepare_auth_request(struct wpa_sm *sm,
 400                                               const u8 *mdie)
 401 {
 402         return 0;
 403 }
 404
 405 static inline int wpa_ft_add_mdie(struct wpa_sm *sm, u8 *ies, size_t ies_len,
 406                                   const u8 *mdie)
 407 {
 408         return 0;
 409 }
 410
 411 static inline int
 412 wpa_ft_process_response(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
 413                         int ft_action, const u8 *target_ap)
 414 {
 415         return 0;
 416 }
 417
 418 static inline int wpa_ft_is_completed(struct wpa_sm *sm)
 419 {
 420         return 0;
 421 }
 422
 423 static inline void wpa_reset_ft_completed(struct wpa_sm *sm)
 424 {
 425 }
 426
 427 static inline int
 428 wpa_ft_validate_reassoc_resp(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
 429                              const u8 *src_addr)
 430 {
 431         return -1;
 432 }
 433
 434 #endif /* CONFIG_IEEE80211R */
 435
 436
 437 /* tdls.c */
 438 void wpa_tdls_ap_ies(struct wpa_sm *sm, const u8 *ies, size_t len);
 439 void wpa_tdls_assoc_resp_ies(struct wpa_sm *sm, const u8 *ies, size_t len);
 440 int wpa_tdls_start(struct wpa_sm *sm, const u8 *addr);
 441 void wpa_tdls_remove(struct wpa_sm *sm, const u8 *addr);
 442 int wpa_tdls_teardown_link(struct wpa_sm *sm, const u8 *addr, u16 reason_code);
 443 int wpa_tdls_send_discovery_request(struct wpa_sm *sm, const u8 *addr);
 444 int wpa_tdls_init(struct wpa_sm *sm);
 445 void wpa_tdls_teardown_peers(struct wpa_sm *sm);
 446 void wpa_tdls_deinit(struct wpa_sm *sm);
 447 void wpa_tdls_enable(struct wpa_sm *sm, int enabled);
 448 void wpa_tdls_disable_unreachable_link(struct wpa_sm *sm, const u8 *addr);
 449 const char * wpa_tdls_get_link_status(struct wpa_sm *sm, const u8 *addr);
 450 int wpa_tdls_is_external_setup(struct wpa_sm *sm);
 451 int wpa_tdls_enable_chan_switch(struct wpa_sm *sm, const u8 *addr,
 452                                 u8 oper_class,
 453                                 struct hostapd_freq_params *freq_params);
 454 int wpa_tdls_disable_chan_switch(struct wpa_sm *sm, const u8 *addr);
 455 #ifdef CONFIG_TDLS_TESTING
 456 extern unsigned int tdls_testing;
 457 #endif /* CONFIG_TDLS_TESTING */
 458
 459
 460 int wpa_wnmsleep_install_key(struct wpa_sm *sm, u8 subelem_id, u8 *buf);
 461 void wpa_sm_set_test_assoc_ie(struct wpa_sm *sm, struct wpabuf *buf);
 462 const u8 * wpa_sm_get_anonce(struct wpa_sm *sm);
 463 unsigned int wpa_sm_get_key_mgmt(struct wpa_sm *sm);
 464
 465 struct wpabuf * fils_build_auth(struct wpa_sm *sm, int dh_group, const u8 *md);
 466 int fils_process_auth(struct wpa_sm *sm, const u8 *bssid, const u8 *data,
 467                       size_t len);
 468 struct wpabuf * fils_build_assoc_req(struct wpa_sm *sm, const u8 **kek,
 469                                      size_t *kek_len, const u8 **snonce,
 470                                      const u8 **anonce,
 471                                      const struct wpabuf **hlp,
 472                                      unsigned int num_hlp);
 473 int fils_process_assoc_resp(struct wpa_sm *sm, const u8 *resp, size_t len);
 474
 475 struct wpabuf * owe_build_assoc_req(struct wpa_sm *sm, u16 group);
 476 int owe_process_assoc_resp(struct wpa_sm *sm, const u8 *bssid,
 477                            const u8 *resp_ies, size_t resp_ies_len);
 478
 479 void wpa_sm_set_reset_fils_completed(struct wpa_sm *sm, int set);
 480 void wpa_sm_set_fils_cache_id(struct wpa_sm *sm, const u8 *fils_cache_id);
 481 void wpa_sm_set_dpp_z(struct wpa_sm *sm, const struct wpabuf *z);
 482
 483 #endif /* WPA_H */