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