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