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);
  66 #endif /* CONFIG_TDLS */
  67         void (*set_rekey_offload)(void *ctx, const u8 *kek, const u8 *kck,
  68                                   const u8 *replay_ctr);
  69 };
  70
  71
  72 enum wpa_sm_conf_params {
  73         RSNA_PMK_LIFETIME /* dot11RSNAConfigPMKLifetime */,
  74         RSNA_PMK_REAUTH_THRESHOLD /* dot11RSNAConfigPMKReauthThreshold */,
  75         RSNA_SA_TIMEOUT /* dot11RSNAConfigSATimeout */,
  76         WPA_PARAM_PROTO,
  77         WPA_PARAM_PAIRWISE,
  78         WPA_PARAM_GROUP,
  79         WPA_PARAM_KEY_MGMT,
  80         WPA_PARAM_MGMT_GROUP,
  81         WPA_PARAM_RSN_ENABLED,
  82         WPA_PARAM_MFP
  83 };
  84
  85 struct rsn_supp_config {
  86         void *network_ctx;
  87         int peerkey_enabled;
  88         int allowed_pairwise_cipher; /* bitfield of WPA_CIPHER_* */
  89         int proactive_key_caching;
  90         int eap_workaround;
  91         void *eap_conf_ctx;
  92         const u8 *ssid;
  93         size_t ssid_len;
  94         int wpa_ptk_rekey;
  95 };
  96
  97 #ifndef CONFIG_NO_WPA
  98
  99 struct wpa_sm * wpa_sm_init(struct wpa_sm_ctx *ctx);
 100 void wpa_sm_deinit(struct wpa_sm *sm);
 101 void wpa_sm_notify_assoc(struct wpa_sm *sm, const u8 *bssid);
 102 void wpa_sm_notify_disassoc(struct wpa_sm *sm);
 103 void wpa_sm_set_pmk(struct wpa_sm *sm, const u8 *pmk, size_t pmk_len);
 104 void wpa_sm_set_pmk_from_pmksa(struct wpa_sm *sm);
 105 void wpa_sm_set_fast_reauth(struct wpa_sm *sm, int fast_reauth);
 106 void wpa_sm_set_scard_ctx(struct wpa_sm *sm, void *scard_ctx);
 107 void wpa_sm_set_config(struct wpa_sm *sm, struct rsn_supp_config *config);
 108 void wpa_sm_set_own_addr(struct wpa_sm *sm, const u8 *addr);
 109 void wpa_sm_set_ifname(struct wpa_sm *sm, const char *ifname,
 110                        const char *bridge_ifname);
 111 void wpa_sm_set_eapol(struct wpa_sm *sm, struct eapol_sm *eapol);
 112 int wpa_sm_set_assoc_wpa_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
 113 int wpa_sm_set_assoc_wpa_ie_default(struct wpa_sm *sm, u8 *wpa_ie,
 114                                     size_t *wpa_ie_len);
 115 int wpa_sm_set_ap_wpa_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
 116 int wpa_sm_set_ap_rsn_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
 117 int wpa_sm_get_mib(struct wpa_sm *sm, char *buf, size_t buflen);
 118
 119 int wpa_sm_set_param(struct wpa_sm *sm, enum wpa_sm_conf_params param,
 120                      unsigned int value);
 121 unsigned int wpa_sm_get_param(struct wpa_sm *sm,
 122                               enum wpa_sm_conf_params param);
 123
 124 int wpa_sm_get_status(struct wpa_sm *sm, char *buf, size_t buflen,
 125                       int verbose);
 126 int wpa_sm_pmf_enabled(struct wpa_sm *sm);
 127
 128 void wpa_sm_key_request(struct wpa_sm *sm, int error, int pairwise);
 129
 130 int wpa_parse_wpa_ie(const u8 *wpa_ie, size_t wpa_ie_len,
 131                      struct wpa_ie_data *data);
 132
 133 void wpa_sm_aborted_cached(struct wpa_sm *sm);
 134 int wpa_sm_rx_eapol(struct wpa_sm *sm, const u8 *src_addr,
 135                     const u8 *buf, size_t len);
 136 int wpa_sm_parse_own_wpa_ie(struct wpa_sm *sm, struct wpa_ie_data *data);
 137 int wpa_sm_pmksa_cache_list(struct wpa_sm *sm, char *buf, size_t len);
 138 void wpa_sm_drop_sa(struct wpa_sm *sm);
 139 int wpa_sm_has_ptk(struct wpa_sm *sm);
 140
 141 void wpa_sm_update_replay_ctr(struct wpa_sm *sm, const u8 *replay_ctr);
 142
 143 void wpa_sm_pmksa_cache_flush(struct wpa_sm *sm, void *network_ctx);
 144
 145 #else /* CONFIG_NO_WPA */
 146
 147 static inline struct wpa_sm * wpa_sm_init(struct wpa_sm_ctx *ctx)
 148 {
 149         return (struct wpa_sm *) 1;
 150 }
 151
 152 static inline void wpa_sm_deinit(struct wpa_sm *sm)
 153 {
 154 }
 155
 156 static inline void wpa_sm_notify_assoc(struct wpa_sm *sm, const u8 *bssid)
 157 {
 158 }
 159
 160 static inline void wpa_sm_notify_disassoc(struct wpa_sm *sm)
 161 {
 162 }
 163
 164 static inline void wpa_sm_set_pmk(struct wpa_sm *sm, const u8 *pmk,
 165                                   size_t pmk_len)
 166 {
 167 }
 168
 169 static inline void wpa_sm_set_pmk_from_pmksa(struct wpa_sm *sm)
 170 {
 171 }
 172
 173 static inline void wpa_sm_set_fast_reauth(struct wpa_sm *sm, int fast_reauth)
 174 {
 175 }
 176
 177 static inline void wpa_sm_set_scard_ctx(struct wpa_sm *sm, void *scard_ctx)
 178 {
 179 }
 180
 181 static inline void wpa_sm_set_config(struct wpa_sm *sm,
 182                                      struct rsn_supp_config *config)
 183 {
 184 }
 185
 186 static inline void wpa_sm_set_own_addr(struct wpa_sm *sm, const u8 *addr)
 187 {
 188 }
 189
 190 static inline void wpa_sm_set_ifname(struct wpa_sm *sm, const char *ifname,
 191                                      const char *bridge_ifname)
 192 {
 193 }
 194
 195 static inline void wpa_sm_set_eapol(struct wpa_sm *sm, struct eapol_sm *eapol)
 196 {
 197 }
 198
 199 static inline int wpa_sm_set_assoc_wpa_ie(struct wpa_sm *sm, const u8 *ie,
 200                                           size_t len)
 201 {
 202         return -1;
 203 }
 204
 205 static inline int wpa_sm_set_assoc_wpa_ie_default(struct wpa_sm *sm,
 206                                                   u8 *wpa_ie,
 207                                                   size_t *wpa_ie_len)
 208 {
 209         return -1;
 210 }
 211
 212 static inline int wpa_sm_set_ap_wpa_ie(struct wpa_sm *sm, const u8 *ie,
 213                                        size_t len)
 214 {
 215         return -1;
 216 }
 217
 218 static inline int wpa_sm_set_ap_rsn_ie(struct wpa_sm *sm, const u8 *ie,
 219                                        size_t len)
 220 {
 221         return -1;
 222 }
 223
 224 static inline int wpa_sm_get_mib(struct wpa_sm *sm, char *buf, size_t buflen)
 225 {
 226         return 0;
 227 }
 228
 229 static inline int wpa_sm_set_param(struct wpa_sm *sm,
 230                                    enum wpa_sm_conf_params param,
 231                                    unsigned int value)
 232 {
 233         return -1;
 234 }
 235
 236 static inline unsigned int wpa_sm_get_param(struct wpa_sm *sm,
 237                                             enum wpa_sm_conf_params param)
 238 {
 239         return 0;
 240 }
 241
 242 static inline int wpa_sm_get_status(struct wpa_sm *sm, char *buf,
 243                                     size_t buflen, int verbose)
 244 {
 245         return 0;
 246 }
 247
 248 static inline int wpa_sm_pmf_enabled(struct wpa_sm *sm)
 249 {
 250         return 0;
 251 }
 252
 253 static inline void wpa_sm_key_request(struct wpa_sm *sm, int error,
 254                                       int pairwise)
 255 {
 256 }
 257
 258 static inline int wpa_parse_wpa_ie(const u8 *wpa_ie, size_t wpa_ie_len,
 259                                    struct wpa_ie_data *data)
 260 {
 261         return -1;
 262 }
 263
 264 static inline void wpa_sm_aborted_cached(struct wpa_sm *sm)
 265 {
 266 }
 267
 268 static inline int wpa_sm_rx_eapol(struct wpa_sm *sm, const u8 *src_addr,
 269                                   const u8 *buf, size_t len)
 270 {
 271         return -1;
 272 }
 273
 274 static inline int wpa_sm_parse_own_wpa_ie(struct wpa_sm *sm,
 275                                           struct wpa_ie_data *data)
 276 {
 277         return -1;
 278 }
 279
 280 static inline int wpa_sm_pmksa_cache_list(struct wpa_sm *sm, char *buf,
 281                                           size_t len)
 282 {
 283         return -1;
 284 }
 285
 286 static inline void wpa_sm_drop_sa(struct wpa_sm *sm)
 287 {
 288 }
 289
 290 static inline int wpa_sm_has_ptk(struct wpa_sm *sm)
 291 {
 292         return 0;
 293 }
 294
 295 static inline void wpa_sm_update_replay_ctr(struct wpa_sm *sm,
 296                                             const u8 *replay_ctr)
 297 {
 298 }
 299
 300 static inline void wpa_sm_pmksa_cache_flush(struct wpa_sm *sm,
 301                                             void *network_ctx)
 302 {
 303 }
 304
 305 #endif /* CONFIG_NO_WPA */
 306
 307 #ifdef CONFIG_PEERKEY
 308 int wpa_sm_stkstart(struct wpa_sm *sm, const u8 *peer);
 309 #else /* CONFIG_PEERKEY */
 310 static inline int wpa_sm_stkstart(struct wpa_sm *sm, const u8 *peer)
 311 {
 312         return -1;
 313 }
 314 #endif /* CONFIG_PEERKEY */
 315
 316 #ifdef CONFIG_IEEE80211R
 317
 318 int wpa_sm_set_ft_params(struct wpa_sm *sm, const u8 *ies, size_t ies_len);
 319 int wpa_ft_prepare_auth_request(struct wpa_sm *sm, const u8 *mdie);
 320 int wpa_ft_process_response(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
 321                             int ft_action, const u8 *target_ap,
 322                             const u8 *ric_ies, size_t ric_ies_len);
 323 int wpa_ft_is_completed(struct wpa_sm *sm);
 324 void wpa_reset_ft_completed(struct wpa_sm *sm);
 325 int wpa_ft_validate_reassoc_resp(struct wpa_sm *sm, const u8 *ies,
 326                                  size_t ies_len, const u8 *src_addr);
 327 int wpa_ft_start_over_ds(struct wpa_sm *sm, const u8 *target_ap,
 328                          const u8 *mdie);
 329
 330 #else /* CONFIG_IEEE80211R */
 331
 332 static inline int
 333 wpa_sm_set_ft_params(struct wpa_sm *sm, const u8 *ies, size_t ies_len)
 334 {
 335         return 0;
 336 }
 337
 338 static inline int wpa_ft_prepare_auth_request(struct wpa_sm *sm,
 339                                               const u8 *mdie)
 340 {
 341         return 0;
 342 }
 343
 344 static inline int
 345 wpa_ft_process_response(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
 346                         int ft_action, const u8 *target_ap)
 347 {
 348         return 0;
 349 }
 350
 351 static inline int wpa_ft_is_completed(struct wpa_sm *sm)
 352 {
 353         return 0;
 354 }
 355
 356 static inline void wpa_reset_ft_completed(struct wpa_sm *sm)
 357 {
 358 }
 359
 360 static inline int
 361 wpa_ft_validate_reassoc_resp(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
 362                              const u8 *src_addr)
 363 {
 364         return -1;
 365 }
 366
 367 #endif /* CONFIG_IEEE80211R */
 368
 369
 370 /* tdls.c */
 371 void wpa_tdls_ap_ies(struct wpa_sm *sm, const u8 *ies, size_t len);
 372 void wpa_tdls_assoc_resp_ies(struct wpa_sm *sm, const u8 *ies, size_t len);
 373 int wpa_tdls_start(struct wpa_sm *sm, const u8 *addr);
 374 void wpa_tdls_remove(struct wpa_sm *sm, const u8 *addr);
 375 int wpa_tdls_send_teardown(struct wpa_sm *sm, const u8 *addr, u16 reason_code);
 376 int wpa_tdls_teardown_link(struct wpa_sm *sm, const u8 *addr, u16 reason_code);
 377 int wpa_tdls_send_discovery_request(struct wpa_sm *sm, const u8 *addr);
 378 int wpa_tdls_init(struct wpa_sm *sm);
 379 void wpa_tdls_teardown_peers(struct wpa_sm *sm);
 380 void wpa_tdls_deinit(struct wpa_sm *sm);
 381 void wpa_tdls_enable(struct wpa_sm *sm, int enabled);
 382 void wpa_tdls_disable_link(struct wpa_sm *sm, const u8 *addr);
 383 int wpa_tdls_is_external_setup(struct wpa_sm *sm);
 384
 385 int wpa_wnmsleep_install_key(struct wpa_sm *sm, u8 subelem_id, u8 *buf);
 386
 387 #endif /* WPA_H */