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 "defs.h"
  19 #include "eapol_common.h"
  20 #include "wpa_common.h"
  21
  22 #ifndef ETH_P_EAPOL
  23 #define ETH_P_EAPOL 0x888e
  24 #endif
  25
  26 #ifndef ETH_P_RSN_PREAUTH
  27 #define ETH_P_RSN_PREAUTH 0x88c7
  28 #endif
  29
  30 struct wpa_sm;
  31 struct eapol_sm;
  32 struct wpa_config_blob;
  33
  34 struct wpa_sm_ctx {
  35         void *ctx; /* pointer to arbitrary upper level context */
  36         void *msg_ctx; /* upper level context for wpa_msg() calls */
  37
  38         void (*set_state)(void *ctx, wpa_states state);
  39         wpa_states (*get_state)(void *ctx);
  40         void (*deauthenticate)(void * ctx, int reason_code);
  41         void (*disassociate)(void *ctx, int reason_code);
  42         int (*set_key)(void *ctx, wpa_alg alg,
  43                        const u8 *addr, int key_idx, int set_tx,
  44                        const u8 *seq, size_t seq_len,
  45                        const u8 *key, size_t key_len);
  46         void * (*get_network_ctx)(void *ctx);
  47         int (*get_bssid)(void *ctx, u8 *bssid);
  48         int (*ether_send)(void *ctx, const u8 *dest, u16 proto, const u8 *buf,
  49                           size_t len);
  50         int (*get_beacon_ie)(void *ctx);
  51         void (*cancel_auth_timeout)(void *ctx);
  52         u8 * (*alloc_eapol)(void *ctx, u8 type, const void *data, u16 data_len,
  53                             size_t *msg_len, void **data_pos);
  54         int (*add_pmkid)(void *ctx, const u8 *bssid, const u8 *pmkid);
  55         int (*remove_pmkid)(void *ctx, const u8 *bssid, const u8 *pmkid);
  56         void (*set_config_blob)(void *ctx, struct wpa_config_blob *blob);
  57         const struct wpa_config_blob * (*get_config_blob)(void *ctx,
  58                                                           const char *name);
  59         int (*mlme_setprotection)(void *ctx, const u8 *addr,
  60                                   int protection_type, int key_type);
  61         int (*update_ft_ies)(void *ctx, const u8 *md, const u8 *ies,
  62                              size_t ies_len);
  63         int (*send_ft_action)(void *ctx, u8 action, const u8 *target_ap,
  64                               const u8 *ies, size_t ies_len);
  65 };
  66
  67
  68 enum wpa_sm_conf_params {
  69         RSNA_PMK_LIFETIME /* dot11RSNAConfigPMKLifetime */,
  70         RSNA_PMK_REAUTH_THRESHOLD /* dot11RSNAConfigPMKReauthThreshold */,
  71         RSNA_SA_TIMEOUT /* dot11RSNAConfigSATimeout */,
  72         WPA_PARAM_PROTO,
  73         WPA_PARAM_PAIRWISE,
  74         WPA_PARAM_GROUP,
  75         WPA_PARAM_KEY_MGMT,
  76         WPA_PARAM_MGMT_GROUP,
  77         WPA_PARAM_RSN_ENABLED
  78 };
  79
  80 struct rsn_supp_config {
  81         void *network_ctx;
  82         int peerkey_enabled;
  83         int allowed_pairwise_cipher; /* bitfield of WPA_CIPHER_* */
  84         int proactive_key_caching;
  85         int eap_workaround;
  86         void *eap_conf_ctx;
  87         const u8 *ssid;
  88         size_t ssid_len;
  89         int wpa_ptk_rekey;
  90 };
  91
  92 #ifndef CONFIG_NO_WPA
  93
  94 struct wpa_sm * wpa_sm_init(struct wpa_sm_ctx *ctx);
  95 void wpa_sm_deinit(struct wpa_sm *sm);
  96 void wpa_sm_notify_assoc(struct wpa_sm *sm, const u8 *bssid);
  97 void wpa_sm_notify_disassoc(struct wpa_sm *sm);
  98 void wpa_sm_set_pmk(struct wpa_sm *sm, const u8 *pmk, size_t pmk_len);
  99 void wpa_sm_set_pmk_from_pmksa(struct wpa_sm *sm);
 100 void wpa_sm_set_fast_reauth(struct wpa_sm *sm, int fast_reauth);
 101 void wpa_sm_set_scard_ctx(struct wpa_sm *sm, void *scard_ctx);
 102 void wpa_sm_set_config(struct wpa_sm *sm, struct rsn_supp_config *config);
 103 void wpa_sm_set_own_addr(struct wpa_sm *sm, const u8 *addr);
 104 void wpa_sm_set_ifname(struct wpa_sm *sm, const char *ifname,
 105                        const char *bridge_ifname);
 106 void wpa_sm_set_eapol(struct wpa_sm *sm, struct eapol_sm *eapol);
 107 int wpa_sm_set_assoc_wpa_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
 108 int wpa_sm_set_assoc_wpa_ie_default(struct wpa_sm *sm, u8 *wpa_ie,
 109                                     size_t *wpa_ie_len);
 110 int wpa_sm_set_ap_wpa_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
 111 int wpa_sm_set_ap_rsn_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
 112 int wpa_sm_get_mib(struct wpa_sm *sm, char *buf, size_t buflen);
 113
 114 int wpa_sm_set_param(struct wpa_sm *sm, enum wpa_sm_conf_params param,
 115                      unsigned int value);
 116 unsigned int wpa_sm_get_param(struct wpa_sm *sm,
 117                               enum wpa_sm_conf_params param);
 118
 119 int wpa_sm_get_status(struct wpa_sm *sm, char *buf, size_t buflen,
 120                       int verbose);
 121
 122 void wpa_sm_key_request(struct wpa_sm *sm, int error, int pairwise);
 123
 124 int wpa_parse_wpa_ie(const u8 *wpa_ie, size_t wpa_ie_len,
 125                      struct wpa_ie_data *data);
 126
 127 void wpa_sm_aborted_cached(struct wpa_sm *sm);
 128 int wpa_sm_rx_eapol(struct wpa_sm *sm, const u8 *src_addr,
 129                     const u8 *buf, size_t len);
 130 int wpa_sm_parse_own_wpa_ie(struct wpa_sm *sm, struct wpa_ie_data *data);
 131 int wpa_sm_pmksa_cache_list(struct wpa_sm *sm, char *buf, size_t len);
 132
 133 #else /* CONFIG_NO_WPA */
 134
 135 static inline struct wpa_sm * wpa_sm_init(struct wpa_sm_ctx *ctx)
 136 {
 137         return (struct wpa_sm *) 1;
 138 }
 139
 140 static inline void wpa_sm_deinit(struct wpa_sm *sm)
 141 {
 142 }
 143
 144 static inline void wpa_sm_notify_assoc(struct wpa_sm *sm, const u8 *bssid)
 145 {
 146 }
 147
 148 static inline void wpa_sm_notify_disassoc(struct wpa_sm *sm)
 149 {
 150 }
 151
 152 static inline void wpa_sm_set_pmk(struct wpa_sm *sm, const u8 *pmk,
 153                                   size_t pmk_len)
 154 {
 155 }
 156
 157 static inline void wpa_sm_set_pmk_from_pmksa(struct wpa_sm *sm)
 158 {
 159 }
 160
 161 static inline void wpa_sm_set_fast_reauth(struct wpa_sm *sm, int fast_reauth)
 162 {
 163 }
 164
 165 static inline void wpa_sm_set_scard_ctx(struct wpa_sm *sm, void *scard_ctx)
 166 {
 167 }
 168
 169 static inline void wpa_sm_set_config(struct wpa_sm *sm,
 170                                      struct rsn_supp_config *config)
 171 {
 172 }
 173
 174 static inline void wpa_sm_set_own_addr(struct wpa_sm *sm, const u8 *addr)
 175 {
 176 }
 177
 178 static inline void wpa_sm_set_ifname(struct wpa_sm *sm, const char *ifname,
 179                                      const char *bridge_ifname)
 180 {
 181 }
 182
 183 static inline void wpa_sm_set_eapol(struct wpa_sm *sm, struct eapol_sm *eapol)
 184 {
 185 }
 186
 187 static inline int wpa_sm_set_assoc_wpa_ie(struct wpa_sm *sm, const u8 *ie,
 188                                           size_t len)
 189 {
 190         return -1;
 191 }
 192
 193 static inline int wpa_sm_set_assoc_wpa_ie_default(struct wpa_sm *sm,
 194                                                   u8 *wpa_ie,
 195                                                   size_t *wpa_ie_len)
 196 {
 197         return -1;
 198 }
 199
 200 static inline int wpa_sm_set_ap_wpa_ie(struct wpa_sm *sm, const u8 *ie,
 201                                        size_t len)
 202 {
 203         return -1;
 204 }
 205
 206 static inline int wpa_sm_set_ap_rsn_ie(struct wpa_sm *sm, const u8 *ie,
 207                                        size_t len)
 208 {
 209         return -1;
 210 }
 211
 212 static inline int wpa_sm_get_mib(struct wpa_sm *sm, char *buf, size_t buflen)
 213 {
 214         return 0;
 215 }
 216
 217 static inline int wpa_sm_set_param(struct wpa_sm *sm,
 218                                    enum wpa_sm_conf_params param,
 219                                    unsigned int value)
 220 {
 221         return -1;
 222 }
 223
 224 static inline unsigned int wpa_sm_get_param(struct wpa_sm *sm,
 225                                             enum wpa_sm_conf_params param)
 226 {
 227         return 0;
 228 }
 229
 230 static inline int wpa_sm_get_status(struct wpa_sm *sm, char *buf,
 231                                     size_t buflen, int verbose)
 232 {
 233         return 0;
 234 }
 235
 236 static inline void wpa_sm_key_request(struct wpa_sm *sm, int error,
 237                                       int pairwise)
 238 {
 239 }
 240
 241 static inline int wpa_parse_wpa_ie(const u8 *wpa_ie, size_t wpa_ie_len,
 242                                    struct wpa_ie_data *data)
 243 {
 244         return -1;
 245 }
 246
 247 static inline void wpa_sm_aborted_cached(struct wpa_sm *sm)
 248 {
 249 }
 250
 251 static inline int wpa_sm_rx_eapol(struct wpa_sm *sm, const u8 *src_addr,
 252                                   const u8 *buf, size_t len)
 253 {
 254         return -1;
 255 }
 256
 257 static inline int wpa_sm_parse_own_wpa_ie(struct wpa_sm *sm,
 258                                           struct wpa_ie_data *data)
 259 {
 260         return -1;
 261 }
 262
 263 static inline int wpa_sm_pmksa_cache_list(struct wpa_sm *sm, char *buf,
 264                                           size_t len)
 265 {
 266         return -1;
 267 }
 268
 269 #endif /* CONFIG_NO_WPA */
 270
 271 #ifdef CONFIG_PEERKEY
 272 int wpa_sm_stkstart(struct wpa_sm *sm, const u8 *peer);
 273 #else /* CONFIG_PEERKEY */
 274 static inline int wpa_sm_stkstart(struct wpa_sm *sm, const u8 *peer)
 275 {
 276         return -1;
 277 }
 278 #endif /* CONFIG_PEERKEY */
 279
 280 #ifdef CONFIG_IEEE80211R
 281
 282 int wpa_sm_set_ft_params(struct wpa_sm *sm, const u8 *mobility_domain,
 283                          const u8 *r0kh_id, size_t r0kh_id_len,
 284                          const u8 *r1kh_id);
 285 int wpa_ft_prepare_auth_request(struct wpa_sm *sm);
 286 int wpa_ft_process_response(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
 287                             int ft_action, const u8 *target_ap,
 288                             const u8 *ric_ies, size_t ric_ies_len);
 289 int wpa_ft_is_completed(struct wpa_sm *sm);
 290 int wpa_ft_validate_reassoc_resp(struct wpa_sm *sm, const u8 *ies,
 291                                  size_t ies_len, const u8 *src_addr);
 292 int wpa_ft_start_over_ds(struct wpa_sm *sm, const u8 *target_ap);
 293
 294 #else /* CONFIG_IEEE80211R */
 295
 296 static inline int
 297 wpa_sm_set_ft_params(struct wpa_sm *sm, const u8 *mobility_domain,
 298                      const u8 *r0kh_id, const u8 *r1kh_id)
 299 {
 300         return 0;
 301 }
 302
 303 static inline int wpa_ft_prepare_auth_request(struct wpa_sm *sm)
 304 {
 305         return 0;
 306 }
 307
 308 static inline int
 309 wpa_ft_process_response(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
 310                         int ft_action, const u8 *target_ap)
 311 {
 312         return 0;
 313 }
 314
 315 static inline int wpa_ft_is_completed(struct wpa_sm *sm)
 316 {
 317         return 0;
 318 }
 319
 320 static inline int
 321 wpa_ft_validate_reassoc_resp(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
 322                              const u8 *src_addr)
 323 {
 324         return -1;
 325 }
 326
 327 #endif /* CONFIG_IEEE80211R */
 328
 329 #endif /* WPA_H */