src/rsn_supp/wpa.h

   1 /*
   2  * wpa_supplicant - WPA definitions
   3  * Copyright (c) 2003-2007, 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, const u8 *bssid, const u8 *pmkid);
  42         int (*remove_pmkid)(void *ctx, const u8 *bssid, const u8 *pmkid);
  43         void (*set_config_blob)(void *ctx, struct wpa_config_blob *blob);
  44         const struct wpa_config_blob * (*get_config_blob)(void *ctx,
  45                                                           const char *name);
  46         int (*mlme_setprotection)(void *ctx, const u8 *addr,
  47                                   int protection_type, int key_type);
  48         int (*update_ft_ies)(void *ctx, const u8 *md, const u8 *ies,
  49                              size_t ies_len);
  50         int (*send_ft_action)(void *ctx, u8 action, const u8 *target_ap,
  51                               const u8 *ies, size_t ies_len);
  52         int (*mark_authenticated)(void *ctx, const u8 *target_ap);
  53 #ifdef CONFIG_TDLS
  54         int (*tdls_get_capa)(void *ctx, int *tdls_supported,
  55                              int *tdls_ext_setup, int *tdls_chan_switch);
  56         int (*send_tdls_mgmt)(void *ctx, const u8 *dst,
  57                               u8 action_code, u8 dialog_token,
  58                               u16 status_code, u32 peer_capab,
  59                               int initiator, const u8 *buf, size_t len);
  60         int (*tdls_oper)(void *ctx, int oper, const u8 *peer);
  61         int (*tdls_peer_addset)(void *ctx, const u8 *addr, int add, u16 aid,
  62                                 u16 capability, const u8 *supp_rates,
  63                                 size_t supp_rates_len,
  64                                 const struct ieee80211_ht_capabilities *ht_capab,
  65                                 const struct ieee80211_vht_capabilities *vht_capab,
  66                                 u8 qosinfo, int wmm, const u8 *ext_capab,
  67                                 size_t ext_capab_len, const u8 *supp_channels,
  68                                 size_t supp_channels_len,
  69                                 const u8 *supp_oper_classes,
  70                                 size_t supp_oper_classes_len);
  71         int (*tdls_enable_channel_switch)(
  72                 void *ctx, const u8 *addr, u8 oper_class,
  73                 const struct hostapd_freq_params *params);
  74         int (*tdls_disable_channel_switch)(void *ctx, const u8 *addr);
  75 #endif /* CONFIG_TDLS */
  76         void (*set_rekey_offload)(void *ctx, const u8 *kek, const u8 *kck,
  77                                   const u8 *replay_ctr);
  78         int (*key_mgmt_set_pmk)(void *ctx, const u8 *pmk, size_t pmk_len);
  79 };
  80
  81
  82 enum wpa_sm_conf_params {
  83         RSNA_PMK_LIFETIME /* dot11RSNAConfigPMKLifetime */,
  84         RSNA_PMK_REAUTH_THRESHOLD /* dot11RSNAConfigPMKReauthThreshold */,
  85         RSNA_SA_TIMEOUT /* dot11RSNAConfigSATimeout */,
  86         WPA_PARAM_PROTO,
  87         WPA_PARAM_PAIRWISE,
  88         WPA_PARAM_GROUP,
  89         WPA_PARAM_KEY_MGMT,
  90         WPA_PARAM_MGMT_GROUP,
  91         WPA_PARAM_RSN_ENABLED,
  92         WPA_PARAM_MFP
  93 };
  94
  95 struct rsn_supp_config {
  96         void *network_ctx;
  97         int peerkey_enabled;
  98         int allowed_pairwise_cipher; /* bitfield of WPA_CIPHER_* */
  99         int proactive_key_caching;
 100         int eap_workaround;
 101         void *eap_conf_ctx;
 102         const u8 *ssid;
 103         size_t ssid_len;
 104         int wpa_ptk_rekey;
 105         int p2p;
 106 };
 107
 108 #ifndef CONFIG_NO_WPA
 109
 110 struct wpa_sm * wpa_sm_init(struct wpa_sm_ctx *ctx);
 111 void wpa_sm_deinit(struct wpa_sm *sm);
 112 void wpa_sm_notify_assoc(struct wpa_sm *sm, const u8 *bssid);
 113 void wpa_sm_notify_disassoc(struct wpa_sm *sm);
 114 void wpa_sm_set_pmk(struct wpa_sm *sm, const u8 *pmk, size_t pmk_len,
 115                     const u8 *bssid);
 116 void wpa_sm_set_pmk_from_pmksa(struct wpa_sm *sm);
 117 void wpa_sm_set_fast_reauth(struct wpa_sm *sm, int fast_reauth);
 118 void wpa_sm_set_scard_ctx(struct wpa_sm *sm, void *scard_ctx);
 119 void wpa_sm_set_config(struct wpa_sm *sm, struct rsn_supp_config *config);
 120 void wpa_sm_set_own_addr(struct wpa_sm *sm, const u8 *addr);
 121 void wpa_sm_set_ifname(struct wpa_sm *sm, const char *ifname,
 122                        const char *bridge_ifname);
 123 void wpa_sm_set_eapol(struct wpa_sm *sm, struct eapol_sm *eapol);
 124 int wpa_sm_set_assoc_wpa_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
 125 int wpa_sm_set_assoc_wpa_ie_default(struct wpa_sm *sm, u8 *wpa_ie,
 126                                     size_t *wpa_ie_len);
 127 int wpa_sm_set_ap_wpa_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
 128 int wpa_sm_set_ap_rsn_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
 129 int wpa_sm_get_mib(struct wpa_sm *sm, char *buf, size_t buflen);
 130
 131 int wpa_sm_set_param(struct wpa_sm *sm, enum wpa_sm_conf_params param,
 132                      unsigned int value);
 133
 134 int wpa_sm_get_status(struct wpa_sm *sm, char *buf, size_t buflen,
 135                       int verbose);
 136 int wpa_sm_pmf_enabled(struct wpa_sm *sm);
 137
 138 void wpa_sm_key_request(struct wpa_sm *sm, int error, int pairwise);
 139
 140 int wpa_parse_wpa_ie(const u8 *wpa_ie, size_t wpa_ie_len,
 141                      struct wpa_ie_data *data);
 142
 143 void wpa_sm_aborted_cached(struct wpa_sm *sm);
 144 int wpa_sm_rx_eapol(struct wpa_sm *sm, const u8 *src_addr,
 145                     const u8 *buf, size_t len);
 146 int wpa_sm_parse_own_wpa_ie(struct wpa_sm *sm, struct wpa_ie_data *data);
 147 int wpa_sm_pmksa_cache_list(struct wpa_sm *sm, char *buf, size_t len);
 148 void wpa_sm_drop_sa(struct wpa_sm *sm);
 149 int wpa_sm_has_ptk(struct wpa_sm *sm);
 150
 151 void wpa_sm_update_replay_ctr(struct wpa_sm *sm, const u8 *replay_ctr);
 152
 153 void wpa_sm_pmksa_cache_flush(struct wpa_sm *sm, void *network_ctx);
 154
 155 int wpa_sm_get_p2p_ip_addr(struct wpa_sm *sm, u8 *buf);
 156
 157 void wpa_sm_set_rx_replay_ctr(struct wpa_sm *sm, const u8 *rx_replay_counter);
 158 void wpa_sm_set_ptk_kck_kek(struct wpa_sm *sm, const u8 *ptk_kck,
 159                             const u8 *ptk_kek);
 160
 161 #else /* CONFIG_NO_WPA */
 162
 163 static inline struct wpa_sm * wpa_sm_init(struct wpa_sm_ctx *ctx)
 164 {
 165         return (struct wpa_sm *) 1;
 166 }
 167
 168 static inline void wpa_sm_deinit(struct wpa_sm *sm)
 169 {
 170 }
 171
 172 static inline void wpa_sm_notify_assoc(struct wpa_sm *sm, const u8 *bssid)
 173 {
 174 }
 175
 176 static inline void wpa_sm_notify_disassoc(struct wpa_sm *sm)
 177 {
 178 }
 179
 180 static inline void wpa_sm_set_pmk(struct wpa_sm *sm, const u8 *pmk,
 181                                   size_t pmk_len)
 182 {
 183 }
 184
 185 static inline void wpa_sm_set_pmk_from_pmksa(struct wpa_sm *sm)
 186 {
 187 }
 188
 189 static inline void wpa_sm_set_fast_reauth(struct wpa_sm *sm, int fast_reauth)
 190 {
 191 }
 192
 193 static inline void wpa_sm_set_scard_ctx(struct wpa_sm *sm, void *scard_ctx)
 194 {
 195 }
 196
 197 static inline void wpa_sm_set_config(struct wpa_sm *sm,
 198                                      struct rsn_supp_config *config)
 199 {
 200 }
 201
 202 static inline void wpa_sm_set_own_addr(struct wpa_sm *sm, const u8 *addr)
 203 {
 204 }
 205
 206 static inline void wpa_sm_set_ifname(struct wpa_sm *sm, const char *ifname,
 207                                      const char *bridge_ifname)
 208 {
 209 }
 210
 211 static inline void wpa_sm_set_eapol(struct wpa_sm *sm, struct eapol_sm *eapol)
 212 {
 213 }
 214
 215 static inline int wpa_sm_set_assoc_wpa_ie(struct wpa_sm *sm, const u8 *ie,
 216                                           size_t len)
 217 {
 218         return -1;
 219 }
 220
 221 static inline int wpa_sm_set_assoc_wpa_ie_default(struct wpa_sm *sm,
 222                                                   u8 *wpa_ie,
 223                                                   size_t *wpa_ie_len)
 224 {
 225         return -1;
 226 }
 227
 228 static inline int wpa_sm_set_ap_wpa_ie(struct wpa_sm *sm, const u8 *ie,
 229                                        size_t len)
 230 {
 231         return -1;
 232 }
 233
 234 static inline int wpa_sm_set_ap_rsn_ie(struct wpa_sm *sm, const u8 *ie,
 235                                        size_t len)
 236 {
 237         return -1;
 238 }
 239
 240 static inline int wpa_sm_get_mib(struct wpa_sm *sm, char *buf, size_t buflen)
 241 {
 242         return 0;
 243 }
 244
 245 static inline int wpa_sm_set_param(struct wpa_sm *sm,
 246                                    enum wpa_sm_conf_params param,
 247                                    unsigned int value)
 248 {
 249         return -1;
 250 }
 251
 252 static inline int wpa_sm_get_status(struct wpa_sm *sm, char *buf,
 253                                     size_t buflen, int verbose)
 254 {
 255         return 0;
 256 }
 257
 258 static inline int wpa_sm_pmf_enabled(struct wpa_sm *sm)
 259 {
 260         return 0;
 261 }
 262
 263 static inline void wpa_sm_key_request(struct wpa_sm *sm, int error,
 264                                       int pairwise)
 265 {
 266 }
 267
 268 static inline int wpa_parse_wpa_ie(const u8 *wpa_ie, size_t wpa_ie_len,
 269                                    struct wpa_ie_data *data)
 270 {
 271         return -1;
 272 }
 273
 274 static inline void wpa_sm_aborted_cached(struct wpa_sm *sm)
 275 {
 276 }
 277
 278 static inline int wpa_sm_rx_eapol(struct wpa_sm *sm, const u8 *src_addr,
 279                                   const u8 *buf, size_t len)
 280 {
 281         return -1;
 282 }
 283
 284 static inline int wpa_sm_parse_own_wpa_ie(struct wpa_sm *sm,
 285                                           struct wpa_ie_data *data)
 286 {
 287         return -1;
 288 }
 289
 290 static inline int wpa_sm_pmksa_cache_list(struct wpa_sm *sm, char *buf,
 291                                           size_t len)
 292 {
 293         return -1;
 294 }
 295
 296 static inline void wpa_sm_drop_sa(struct wpa_sm *sm)
 297 {
 298 }
 299
 300 static inline int wpa_sm_has_ptk(struct wpa_sm *sm)
 301 {
 302         return 0;
 303 }
 304
 305 static inline void wpa_sm_update_replay_ctr(struct wpa_sm *sm,
 306                                             const u8 *replay_ctr)
 307 {
 308 }
 309
 310 static inline void wpa_sm_pmksa_cache_flush(struct wpa_sm *sm,
 311                                             void *network_ctx)
 312 {
 313 }
 314
 315 static inline void wpa_sm_set_rx_replay_ctr(struct wpa_sm *sm,
 316                                             const u8 *rx_replay_counter)
 317 {
 318 }
 319
 320 static inline void wpa_sm_set_ptk_kck_kek(struct wpa_sm *sm, const u8 *ptk_kck,
 321                                           const u8 *ptk_kek)
 322 {
 323 }
 324
 325 #endif /* CONFIG_NO_WPA */
 326
 327 #ifdef CONFIG_PEERKEY
 328 int wpa_sm_stkstart(struct wpa_sm *sm, const u8 *peer);
 329 int wpa_sm_rx_eapol_peerkey(struct wpa_sm *sm, const u8 *src_addr,
 330                             const u8 *buf, size_t len);
 331 #else /* CONFIG_PEERKEY */
 332 static inline int wpa_sm_stkstart(struct wpa_sm *sm, const u8 *peer)
 333 {
 334         return -1;
 335 }
 336
 337 static inline int wpa_sm_rx_eapol_peerkey(struct wpa_sm *sm, const u8 *src_addr,
 338                                           const u8 *buf, size_t len)
 339 {
 340         return 0;
 341 }
 342 #endif /* CONFIG_PEERKEY */
 343
 344 #ifdef CONFIG_IEEE80211R
 345
 346 int wpa_sm_set_ft_params(struct wpa_sm *sm, const u8 *ies, size_t ies_len);
 347 int wpa_ft_prepare_auth_request(struct wpa_sm *sm, const u8 *mdie);
 348 int wpa_ft_process_response(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
 349                             int ft_action, const u8 *target_ap,
 350                             const u8 *ric_ies, size_t ric_ies_len);
 351 int wpa_ft_is_completed(struct wpa_sm *sm);
 352 void wpa_reset_ft_completed(struct wpa_sm *sm);
 353 int wpa_ft_validate_reassoc_resp(struct wpa_sm *sm, const u8 *ies,
 354                                  size_t ies_len, const u8 *src_addr);
 355 int wpa_ft_start_over_ds(struct wpa_sm *sm, const u8 *target_ap,
 356                          const u8 *mdie);
 357
 358 #else /* CONFIG_IEEE80211R */
 359
 360 static inline int
 361 wpa_sm_set_ft_params(struct wpa_sm *sm, const u8 *ies, size_t ies_len)
 362 {
 363         return 0;
 364 }
 365
 366 static inline int wpa_ft_prepare_auth_request(struct wpa_sm *sm,
 367                                               const u8 *mdie)
 368 {
 369         return 0;
 370 }
 371
 372 static inline int
 373 wpa_ft_process_response(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
 374                         int ft_action, const u8 *target_ap)
 375 {
 376         return 0;
 377 }
 378
 379 static inline int wpa_ft_is_completed(struct wpa_sm *sm)
 380 {
 381         return 0;
 382 }
 383
 384 static inline void wpa_reset_ft_completed(struct wpa_sm *sm)
 385 {
 386 }
 387
 388 static inline int
 389 wpa_ft_validate_reassoc_resp(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
 390                              const u8 *src_addr)
 391 {
 392         return -1;
 393 }
 394
 395 #endif /* CONFIG_IEEE80211R */
 396
 397
 398 /* tdls.c */
 399 void wpa_tdls_ap_ies(struct wpa_sm *sm, const u8 *ies, size_t len);
 400 void wpa_tdls_assoc_resp_ies(struct wpa_sm *sm, const u8 *ies, size_t len);
 401 int wpa_tdls_start(struct wpa_sm *sm, const u8 *addr);
 402 void wpa_tdls_remove(struct wpa_sm *sm, const u8 *addr);
 403 int wpa_tdls_teardown_link(struct wpa_sm *sm, const u8 *addr, u16 reason_code);
 404 int wpa_tdls_send_discovery_request(struct wpa_sm *sm, const u8 *addr);
 405 int wpa_tdls_init(struct wpa_sm *sm);
 406 void wpa_tdls_teardown_peers(struct wpa_sm *sm);
 407 void wpa_tdls_deinit(struct wpa_sm *sm);
 408 void wpa_tdls_enable(struct wpa_sm *sm, int enabled);
 409 void wpa_tdls_disable_unreachable_link(struct wpa_sm *sm, const u8 *addr);
 410 const char * wpa_tdls_get_link_status(struct wpa_sm *sm, const u8 *addr);
 411 int wpa_tdls_is_external_setup(struct wpa_sm *sm);
 412 int wpa_tdls_enable_chan_switch(struct wpa_sm *sm, const u8 *addr,
 413                                 u8 oper_class,
 414                                 struct hostapd_freq_params *freq_params);
 415 int wpa_tdls_disable_chan_switch(struct wpa_sm *sm, const u8 *addr);
 416
 417 int wpa_wnmsleep_install_key(struct wpa_sm *sm, u8 subelem_id, u8 *buf);
 418
 419 #endif /* WPA_H */