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