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