src/rsn_supp/wpa.h

   1 /*
   2  * wpa_supplicant - WPA definitions
   3  * Copyright (c) 2003-2007, Jouni Malinen <j@w1.fi>
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License version 2 as
   7  * published by the Free Software Foundation.
   8  *
   9  * Alternatively, this software may be distributed under the terms of BSD
  10  * license.
  11  *
  12  * See README and COPYING for more details.
  13  */
  14
  15 #ifndef WPA_H
  16 #define WPA_H
  17
  18 #include "common/defs.h"
  19 #include "common/eapol_common.h"
  20 #include "common/wpa_common.h"
  21
  22 struct wpa_sm;
  23 struct eapol_sm;
  24 struct wpa_config_blob;
  25
  26 struct wpa_sm_ctx {
  27         void *ctx; /* pointer to arbitrary upper level context */
  28         void *msg_ctx; /* upper level context for wpa_msg() calls */
  29
  30         void (*set_state)(void *ctx, enum wpa_states state);
  31         enum wpa_states (*get_state)(void *ctx);
  32         void (*deauthenticate)(void * ctx, int reason_code);
  33         void (*disassociate)(void *ctx, int reason_code);
  34         int (*set_key)(void *ctx, enum wpa_alg alg,
  35                        const u8 *addr, int key_idx, int set_tx,
  36                        const u8 *seq, size_t seq_len,
  37                        const u8 *key, size_t key_len);
  38         void * (*get_network_ctx)(void *ctx);
  39         int (*get_bssid)(void *ctx, u8 *bssid);
  40         int (*ether_send)(void *ctx, const u8 *dest, u16 proto, const u8 *buf,
  41                           size_t len);
  42         int (*get_beacon_ie)(void *ctx);
  43         void (*cancel_auth_timeout)(void *ctx);
  44         u8 * (*alloc_eapol)(void *ctx, u8 type, const void *data, u16 data_len,
  45                             size_t *msg_len, void **data_pos);
  46         int (*add_pmkid)(void *ctx, const u8 *bssid, const u8 *pmkid);
  47         int (*remove_pmkid)(void *ctx, const u8 *bssid, const u8 *pmkid);
  48         void (*set_config_blob)(void *ctx, struct wpa_config_blob *blob);
  49         const struct wpa_config_blob * (*get_config_blob)(void *ctx,
  50                                                           const char *name);
  51         int (*mlme_setprotection)(void *ctx, const u8 *addr,
  52                                   int protection_type, int key_type);
  53         int (*update_ft_ies)(void *ctx, const u8 *md, const u8 *ies,
  54                              size_t ies_len);
  55         int (*send_ft_action)(void *ctx, u8 action, const u8 *target_ap,
  56                               const u8 *ies, size_t ies_len);
  57         int (*mark_authenticated)(void *ctx, const u8 *target_ap);
  58 #ifdef CONFIG_TDLS
  59         int (*send_tdls_mgmt)(void *ctx, const u8 *dst,
  60                               u8 action_code, u8 dialog_token,
  61                               u16 status_code, const u8 *buf, size_t len);
  62         int (*tdls_oper)(void *ctx, int oper, const u8 *peer);
  63 #endif /* CONFIG_TDLS */
  64         void (*set_rekey_offload)(void *ctx, const u8 *kek, const u8 *kck,
  65                                   const u8 *replay_ctr);
  66 };
  67
  68
  69 enum wpa_sm_conf_params {
  70         RSNA_PMK_LIFETIME /* dot11RSNAConfigPMKLifetime */,
  71         RSNA_PMK_REAUTH_THRESHOLD /* dot11RSNAConfigPMKReauthThreshold */,
  72         RSNA_SA_TIMEOUT /* dot11RSNAConfigSATimeout */,
  73         WPA_PARAM_PROTO,
  74         WPA_PARAM_PAIRWISE,
  75         WPA_PARAM_GROUP,
  76         WPA_PARAM_KEY_MGMT,
  77         WPA_PARAM_MGMT_GROUP,
  78         WPA_PARAM_RSN_ENABLED,
  79         WPA_PARAM_MFP
  80 };
  81
  82 struct rsn_supp_config {
  83         void *network_ctx;
  84         int peerkey_enabled;
  85         int allowed_pairwise_cipher; /* bitfield of WPA_CIPHER_* */
  86         int proactive_key_caching;
  87         int eap_workaround;
  88         void *eap_conf_ctx;
  89         const u8 *ssid;
  90         size_t ssid_len;
  91         int wpa_ptk_rekey;
  92 };
  93
  94 #ifndef CONFIG_NO_WPA
  95
  96 struct wpa_sm * wpa_sm_init(struct wpa_sm_ctx *ctx);
  97 void wpa_sm_deinit(struct wpa_sm *sm);
  98 void wpa_sm_notify_assoc(struct wpa_sm *sm, const u8 *bssid);
  99 void wpa_sm_notify_disassoc(struct wpa_sm *sm);
 100 void wpa_sm_set_pmk(struct wpa_sm *sm, const u8 *pmk, size_t pmk_len);
 101 void wpa_sm_set_pmk_from_pmksa(struct wpa_sm *sm);
 102 void wpa_sm_set_fast_reauth(struct wpa_sm *sm, int fast_reauth);
 103 void wpa_sm_set_scard_ctx(struct wpa_sm *sm, void *scard_ctx);
 104 void wpa_sm_set_config(struct wpa_sm *sm, struct rsn_supp_config *config);
 105 void wpa_sm_set_own_addr(struct wpa_sm *sm, const u8 *addr);
 106 void wpa_sm_set_ifname(struct wpa_sm *sm, const char *ifname,
 107                        const char *bridge_ifname);
 108 void wpa_sm_set_eapol(struct wpa_sm *sm, struct eapol_sm *eapol);
 109 int wpa_sm_set_assoc_wpa_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
 110 int wpa_sm_set_assoc_wpa_ie_default(struct wpa_sm *sm, u8 *wpa_ie,
 111                                     size_t *wpa_ie_len);
 112 int wpa_sm_set_ap_wpa_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
 113 int wpa_sm_set_ap_rsn_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
 114 int wpa_sm_get_mib(struct wpa_sm *sm, char *buf, size_t buflen);
 115
 116 int wpa_sm_set_param(struct wpa_sm *sm, enum wpa_sm_conf_params param,
 117                      unsigned int value);
 118 unsigned int wpa_sm_get_param(struct wpa_sm *sm,
 119                               enum wpa_sm_conf_params param);
 120
 121 int wpa_sm_get_status(struct wpa_sm *sm, char *buf, size_t buflen,
 122                       int verbose);
 123
 124 void wpa_sm_key_request(struct wpa_sm *sm, int error, int pairwise);
 125
 126 int wpa_parse_wpa_ie(const u8 *wpa_ie, size_t wpa_ie_len,
 127                      struct wpa_ie_data *data);
 128
 129 void wpa_sm_aborted_cached(struct wpa_sm *sm);
 130 int wpa_sm_rx_eapol(struct wpa_sm *sm, const u8 *src_addr,
 131                     const u8 *buf, size_t len);
 132 int wpa_sm_parse_own_wpa_ie(struct wpa_sm *sm, struct wpa_ie_data *data);
 133 int wpa_sm_pmksa_cache_list(struct wpa_sm *sm, char *buf, size_t len);
 134 void wpa_sm_drop_sa(struct wpa_sm *sm);
 135 int wpa_sm_has_ptk(struct wpa_sm *sm);
 136
 137 void wpa_sm_update_replay_ctr(struct wpa_sm *sm, const u8 *replay_ctr);
 138
 139 void wpa_sm_pmksa_cache_flush(struct wpa_sm *sm, void *network_ctx);
 140
 141 #else /* CONFIG_NO_WPA */
 142
 143 static inline struct wpa_sm * wpa_sm_init(struct wpa_sm_ctx *ctx)
 144 {
 145         return (struct wpa_sm *) 1;
 146 }
 147
 148 static inline void wpa_sm_deinit(struct wpa_sm *sm)
 149 {
 150 }
 151
 152 static inline void wpa_sm_notify_assoc(struct wpa_sm *sm, const u8 *bssid)
 153 {
 154 }
 155
 156 static inline void wpa_sm_notify_disassoc(struct wpa_sm *sm)
 157 {
 158 }
 159
 160 static inline void wpa_sm_set_pmk(struct wpa_sm *sm, const u8 *pmk,
 161                                   size_t pmk_len)
 162 {
 163 }
 164
 165 static inline void wpa_sm_set_pmk_from_pmksa(struct wpa_sm *sm)
 166 {
 167 }
 168
 169 static inline void wpa_sm_set_fast_reauth(struct wpa_sm *sm, int fast_reauth)
 170 {
 171 }
 172
 173 static inline void wpa_sm_set_scard_ctx(struct wpa_sm *sm, void *scard_ctx)
 174 {
 175 }
 176
 177 static inline void wpa_sm_set_config(struct wpa_sm *sm,
 178                                      struct rsn_supp_config *config)
 179 {
 180 }
 181
 182 static inline void wpa_sm_set_own_addr(struct wpa_sm *sm, const u8 *addr)
 183 {
 184 }
 185
 186 static inline void wpa_sm_set_ifname(struct wpa_sm *sm, const char *ifname,
 187                                      const char *bridge_ifname)
 188 {
 189 }
 190
 191 static inline void wpa_sm_set_eapol(struct wpa_sm *sm, struct eapol_sm *eapol)
 192 {
 193 }
 194
 195 static inline int wpa_sm_set_assoc_wpa_ie(struct wpa_sm *sm, const u8 *ie,
 196                                           size_t len)
 197 {
 198         return -1;
 199 }
 200
 201 static inline int wpa_sm_set_assoc_wpa_ie_default(struct wpa_sm *sm,
 202                                                   u8 *wpa_ie,
 203                                                   size_t *wpa_ie_len)
 204 {
 205         return -1;
 206 }
 207
 208 static inline int wpa_sm_set_ap_wpa_ie(struct wpa_sm *sm, const u8 *ie,
 209                                        size_t len)
 210 {
 211         return -1;
 212 }
 213
 214 static inline int wpa_sm_set_ap_rsn_ie(struct wpa_sm *sm, const u8 *ie,
 215                                        size_t len)
 216 {
 217         return -1;
 218 }
 219
 220 static inline int wpa_sm_get_mib(struct wpa_sm *sm, char *buf, size_t buflen)
 221 {
 222         return 0;
 223 }
 224
 225 static inline int wpa_sm_set_param(struct wpa_sm *sm,
 226                                    enum wpa_sm_conf_params param,
 227                                    unsigned int value)
 228 {
 229         return -1;
 230 }
 231
 232 static inline unsigned int wpa_sm_get_param(struct wpa_sm *sm,
 233                                             enum wpa_sm_conf_params param)
 234 {
 235         return 0;
 236 }
 237
 238 static inline int wpa_sm_get_status(struct wpa_sm *sm, char *buf,
 239                                     size_t buflen, int verbose)
 240 {
 241         return 0;
 242 }
 243
 244 static inline void wpa_sm_key_request(struct wpa_sm *sm, int error,
 245                                       int pairwise)
 246 {
 247 }
 248
 249 static inline int wpa_parse_wpa_ie(const u8 *wpa_ie, size_t wpa_ie_len,
 250                                    struct wpa_ie_data *data)
 251 {
 252         return -1;
 253 }
 254
 255 static inline void wpa_sm_aborted_cached(struct wpa_sm *sm)
 256 {
 257 }
 258
 259 static inline int wpa_sm_rx_eapol(struct wpa_sm *sm, const u8 *src_addr,
 260                                   const u8 *buf, size_t len)
 261 {
 262         return -1;
 263 }
 264
 265 static inline int wpa_sm_parse_own_wpa_ie(struct wpa_sm *sm,
 266                                           struct wpa_ie_data *data)
 267 {
 268         return -1;
 269 }
 270
 271 static inline int wpa_sm_pmksa_cache_list(struct wpa_sm *sm, char *buf,
 272                                           size_t len)
 273 {
 274         return -1;
 275 }
 276
 277 static inline void wpa_sm_drop_sa(struct wpa_sm *sm)
 278 {
 279 }
 280
 281 static inline int wpa_sm_has_ptk(struct wpa_sm *sm)
 282 {
 283         return 0;
 284 }
 285
 286 static inline void wpa_sm_update_replay_ctr(struct wpa_sm *sm,
 287                                             const u8 *replay_ctr)
 288 {
 289 }
 290
 291 static inline void wpa_sm_pmksa_cache_flush(struct wpa_sm *sm,
 292                                             void *network_ctx)
 293 {
 294 }
 295
 296 #endif /* CONFIG_NO_WPA */
 297
 298 #ifdef CONFIG_PEERKEY
 299 int wpa_sm_stkstart(struct wpa_sm *sm, const u8 *peer);
 300 #else /* CONFIG_PEERKEY */
 301 static inline int wpa_sm_stkstart(struct wpa_sm *sm, const u8 *peer)
 302 {
 303         return -1;
 304 }
 305 #endif /* CONFIG_PEERKEY */
 306
 307 #ifdef CONFIG_IEEE80211R
 308
 309 int wpa_sm_set_ft_params(struct wpa_sm *sm, const u8 *ies, size_t ies_len);
 310 int wpa_ft_prepare_auth_request(struct wpa_sm *sm, const u8 *mdie);
 311 int wpa_ft_process_response(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
 312                             int ft_action, const u8 *target_ap,
 313                             const u8 *ric_ies, size_t ric_ies_len);
 314 int wpa_ft_is_completed(struct wpa_sm *sm);
 315 int wpa_ft_validate_reassoc_resp(struct wpa_sm *sm, const u8 *ies,
 316                                  size_t ies_len, const u8 *src_addr);
 317 int wpa_ft_start_over_ds(struct wpa_sm *sm, const u8 *target_ap,
 318                          const u8 *mdie);
 319
 320 #else /* CONFIG_IEEE80211R */
 321
 322 static inline int
 323 wpa_sm_set_ft_params(struct wpa_sm *sm, const u8 *ies, size_t ies_len)
 324 {
 325         return 0;
 326 }
 327
 328 static inline int wpa_ft_prepare_auth_request(struct wpa_sm *sm,
 329                                               const u8 *mdie)
 330 {
 331         return 0;
 332 }
 333
 334 static inline int
 335 wpa_ft_process_response(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
 336                         int ft_action, const u8 *target_ap)
 337 {
 338         return 0;
 339 }
 340
 341 static inline int wpa_ft_is_completed(struct wpa_sm *sm)
 342 {
 343         return 0;
 344 }
 345
 346 static inline int
 347 wpa_ft_validate_reassoc_resp(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
 348                              const u8 *src_addr)
 349 {
 350         return -1;
 351 }
 352
 353 #endif /* CONFIG_IEEE80211R */
 354
 355
 356 /* tdls.c */
 357 void wpa_tdls_ap_ies(struct wpa_sm *sm, const u8 *ies, size_t len);
 358 void wpa_tdls_assoc_resp_ies(struct wpa_sm *sm, const u8 *ies, size_t len);
 359 int wpa_tdls_start(struct wpa_sm *sm, const u8 *addr);
 360 int wpa_tdls_reneg(struct wpa_sm *sm, const u8 *addr);
 361 int wpa_tdls_recv_teardown_notify(struct wpa_sm *sm, const u8 *addr,
 362                                   u16 reason_code);
 363 int wpa_tdls_init(struct wpa_sm *sm);
 364 void wpa_tdls_deinit(struct wpa_sm *sm);
 365 void wpa_tdls_enable(struct wpa_sm *sm, int enabled);
 366
 367 #endif /* WPA_H */