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