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