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