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