hostapd/wpa.h

   1 /*
   2  * hostapd - IEEE 802.11i-2004 / WPA Authenticator
   3  * Copyright (c) 2004-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_AUTH_H
  16 #define WPA_AUTH_H
  17
  18 #include "defs.h"
  19 #include "eapol_common.h"
  20 #include "wpa_common.h"
  21
  22 #ifdef _MSC_VER
  23 #pragma pack(push, 1)
  24 #endif /* _MSC_VER */
  25
  26 /* IEEE Std 802.11r-2008, 11A.10.3 - Remote request/response frame definition
  27  */
  28 struct ft_rrb_frame {
  29         u8 frame_type; /* RSN_REMOTE_FRAME_TYPE_FT_RRB */
  30         u8 packet_type; /* FT_PACKET_REQUEST/FT_PACKET_RESPONSE */
  31         le16 action_length; /* little endian length of action_frame */
  32         u8 ap_address[ETH_ALEN];
  33         /*
  34          * Followed by action_length bytes of FT Action frame (from Category
  35          * field to the end of Action Frame body.
  36          */
  37 } STRUCT_PACKED;
  38
  39 #define RSN_REMOTE_FRAME_TYPE_FT_RRB 1
  40
  41 #define FT_PACKET_REQUEST 0
  42 #define FT_PACKET_RESPONSE 1
  43 /* Vendor-specific types for R0KH-R1KH protocol; not defined in 802.11r */
  44 #define FT_PACKET_R0KH_R1KH_PULL 200
  45 #define FT_PACKET_R0KH_R1KH_RESP 201
  46 #define FT_PACKET_R0KH_R1KH_PUSH 202
  47
  48 #define FT_R0KH_R1KH_PULL_DATA_LEN 44
  49 #define FT_R0KH_R1KH_RESP_DATA_LEN 76
  50 #define FT_R0KH_R1KH_PUSH_DATA_LEN 80
  51
  52 struct ft_r0kh_r1kh_pull_frame {
  53         u8 frame_type; /* RSN_REMOTE_FRAME_TYPE_FT_RRB */
  54         u8 packet_type; /* FT_PACKET_R0KH_R1KH_PULL */
  55         le16 data_length; /* little endian length of data (44) */
  56         u8 ap_address[ETH_ALEN];
  57
  58         u8 nonce[16];
  59         u8 pmk_r0_name[WPA_PMK_NAME_LEN];
  60         u8 r1kh_id[FT_R1KH_ID_LEN];
  61         u8 s1kh_id[ETH_ALEN];
  62         u8 pad[4]; /* 8-octet boundary for AES key wrap */
  63         u8 key_wrap_extra[8];
  64 } STRUCT_PACKED;
  65
  66 struct ft_r0kh_r1kh_resp_frame {
  67         u8 frame_type; /* RSN_REMOTE_FRAME_TYPE_FT_RRB */
  68         u8 packet_type; /* FT_PACKET_R0KH_R1KH_RESP */
  69         le16 data_length; /* little endian length of data (76) */
  70         u8 ap_address[ETH_ALEN];
  71
  72         u8 nonce[16]; /* copied from pull */
  73         u8 r1kh_id[FT_R1KH_ID_LEN]; /* copied from pull */
  74         u8 s1kh_id[ETH_ALEN]; /* copied from pull */
  75         u8 pmk_r1[PMK_LEN];
  76         u8 pmk_r1_name[WPA_PMK_NAME_LEN];
  77         u8 pad[4]; /* 8-octet boundary for AES key wrap */
  78         u8 key_wrap_extra[8];
  79 } STRUCT_PACKED;
  80
  81 struct ft_r0kh_r1kh_push_frame {
  82         u8 frame_type; /* RSN_REMOTE_FRAME_TYPE_FT_RRB */
  83         u8 packet_type; /* FT_PACKET_R0KH_R1KH_PUSH */
  84         le16 data_length; /* little endian length of data (80) */
  85         u8 ap_address[ETH_ALEN];
  86
  87         /* Encrypted with AES key-wrap */
  88         u8 timestamp[4]; /* current time in seconds since unix epoch, little
  89                           * endian */
  90         u8 r1kh_id[FT_R1KH_ID_LEN];
  91         u8 s1kh_id[ETH_ALEN];
  92         u8 pmk_r0_name[WPA_PMK_NAME_LEN];
  93         u8 pmk_r1[PMK_LEN];
  94         u8 pmk_r1_name[WPA_PMK_NAME_LEN];
  95         u8 key_wrap_extra[8];
  96 } STRUCT_PACKED;
  97
  98 #ifdef _MSC_VER
  99 #pragma pack(pop)
 100 #endif /* _MSC_VER */
 101
 102
 103 /* per STA state machine data */
 104
 105 struct wpa_authenticator;
 106 struct wpa_state_machine;
 107 struct rsn_pmksa_cache_entry;
 108 struct eapol_state_machine;
 109
 110
 111 struct ft_remote_r0kh {
 112         struct ft_remote_r0kh *next;
 113         u8 addr[ETH_ALEN];
 114         u8 id[FT_R0KH_ID_MAX_LEN];
 115         size_t id_len;
 116         u8 key[16];
 117 };
 118
 119
 120 struct ft_remote_r1kh {
 121         struct ft_remote_r1kh *next;
 122         u8 addr[ETH_ALEN];
 123         u8 id[FT_R1KH_ID_LEN];
 124         u8 key[16];
 125 };
 126
 127
 128 struct wpa_auth_config {
 129         int wpa;
 130         int wpa_key_mgmt;
 131         int wpa_pairwise;
 132         int wpa_group;
 133         int wpa_group_rekey;
 134         int wpa_strict_rekey;
 135         int wpa_gmk_rekey;
 136         int wpa_ptk_rekey;
 137         int rsn_pairwise;
 138         int rsn_preauth;
 139         int eapol_version;
 140         int peerkey;
 141         int wmm_enabled;
 142         int okc;
 143 #ifdef CONFIG_IEEE80211W
 144         enum {
 145                 WPA_NO_IEEE80211W = 0,
 146                 WPA_IEEE80211W_OPTIONAL = 1,
 147                 WPA_IEEE80211W_REQUIRED = 2
 148         } ieee80211w;
 149 #endif /* CONFIG_IEEE80211W */
 150 #ifdef CONFIG_IEEE80211R
 151 #define SSID_LEN 32
 152         u8 ssid[SSID_LEN];
 153         size_t ssid_len;
 154         u8 mobility_domain[MOBILITY_DOMAIN_ID_LEN];
 155         u8 r0_key_holder[FT_R0KH_ID_MAX_LEN];
 156         size_t r0_key_holder_len;
 157         u8 r1_key_holder[FT_R1KH_ID_LEN];
 158         u32 r0_key_lifetime;
 159         u32 reassociation_deadline;
 160         struct ft_remote_r0kh *r0kh_list;
 161         struct ft_remote_r1kh *r1kh_list;
 162         int pmk_r1_push;
 163 #endif /* CONFIG_IEEE80211R */
 164 };
 165
 166 typedef enum {
 167         LOGGER_DEBUG, LOGGER_INFO, LOGGER_WARNING
 168 } logger_level;
 169
 170 typedef enum {
 171         WPA_EAPOL_portEnabled, WPA_EAPOL_portValid, WPA_EAPOL_authorized,
 172         WPA_EAPOL_portControl_Auto, WPA_EAPOL_keyRun, WPA_EAPOL_keyAvailable,
 173         WPA_EAPOL_keyDone, WPA_EAPOL_inc_EapolFramesTx
 174 } wpa_eapol_variable;
 175
 176 struct wpa_auth_callbacks {
 177         void *ctx;
 178         void (*logger)(void *ctx, const u8 *addr, logger_level level,
 179                        const char *txt);
 180         void (*disconnect)(void *ctx, const u8 *addr, u16 reason);
 181         void (*mic_failure_report)(void *ctx, const u8 *addr);
 182         void (*set_eapol)(void *ctx, const u8 *addr, wpa_eapol_variable var,
 183                           int value);
 184         int (*get_eapol)(void *ctx, const u8 *addr, wpa_eapol_variable var);
 185         const u8 * (*get_psk)(void *ctx, const u8 *addr, const u8 *prev_psk);
 186         int (*get_msk)(void *ctx, const u8 *addr, u8 *msk, size_t *len);
 187         int (*set_key)(void *ctx, int vlan_id, wpa_alg alg, const u8 *addr,
 188                        int idx, u8 *key, size_t key_len);
 189         int (*get_seqnum)(void *ctx, const u8 *addr, int idx, u8 *seq);
 190         int (*get_seqnum_igtk)(void *ctx, const u8 *addr, int idx, u8 *seq);
 191         int (*send_eapol)(void *ctx, const u8 *addr, const u8 *data,
 192                           size_t data_len, int encrypt);
 193         int (*for_each_sta)(void *ctx, int (*cb)(struct wpa_state_machine *sm,
 194                                                  void *ctx), void *cb_ctx);
 195         int (*for_each_auth)(void *ctx, int (*cb)(struct wpa_authenticator *a,
 196                                                   void *ctx), void *cb_ctx);
 197         int (*send_ether)(void *ctx, const u8 *dst, u16 proto, const u8 *data,
 198                           size_t data_len);
 199 #ifdef CONFIG_IEEE80211R
 200         struct wpa_state_machine * (*add_sta)(void *ctx, const u8 *sta_addr);
 201         int (*send_ft_action)(void *ctx, const u8 *dst,
 202                               const u8 *data, size_t data_len);
 203 #endif /* CONFIG_IEEE80211R */
 204 };
 205
 206 struct wpa_authenticator * wpa_init(const u8 *addr,
 207                                     struct wpa_auth_config *conf,
 208                                     struct wpa_auth_callbacks *cb);
 209 void wpa_deinit(struct wpa_authenticator *wpa_auth);
 210 int wpa_reconfig(struct wpa_authenticator *wpa_auth,
 211                  struct wpa_auth_config *conf);
 212
 213 enum {
 214         WPA_IE_OK, WPA_INVALID_IE, WPA_INVALID_GROUP, WPA_INVALID_PAIRWISE,
 215         WPA_INVALID_AKMP, WPA_NOT_ENABLED, WPA_ALLOC_FAIL,
 216         WPA_MGMT_FRAME_PROTECTION_VIOLATION, WPA_INVALID_MGMT_GROUP_CIPHER,
 217         WPA_INVALID_MDIE, WPA_INVALID_PROTO
 218 };
 219
 220 int wpa_validate_wpa_ie(struct wpa_authenticator *wpa_auth,
 221                         struct wpa_state_machine *sm,
 222                         const u8 *wpa_ie, size_t wpa_ie_len,
 223                         const u8 *mdie, size_t mdie_len);
 224 int wpa_auth_uses_mfp(struct wpa_state_machine *sm);
 225 struct wpa_state_machine *
 226 wpa_auth_sta_init(struct wpa_authenticator *wpa_auth, const u8 *addr);
 227 void wpa_auth_sta_associated(struct wpa_authenticator *wpa_auth,
 228                              struct wpa_state_machine *sm);
 229 void wpa_auth_sta_no_wpa(struct wpa_state_machine *sm);
 230 void wpa_auth_sta_deinit(struct wpa_state_machine *sm);
 231 void wpa_receive(struct wpa_authenticator *wpa_auth,
 232                  struct wpa_state_machine *sm,
 233                  u8 *data, size_t data_len);
 234 typedef enum {
 235         WPA_AUTH, WPA_ASSOC, WPA_DISASSOC, WPA_DEAUTH, WPA_REAUTH,
 236         WPA_REAUTH_EAPOL, WPA_ASSOC_FT
 237 } wpa_event;
 238 void wpa_remove_ptk(struct wpa_state_machine *sm);
 239 void wpa_auth_sm_event(struct wpa_state_machine *sm, wpa_event event);
 240 void wpa_auth_sm_notify(struct wpa_state_machine *sm);
 241 void wpa_gtk_rekey(struct wpa_authenticator *wpa_auth);
 242 int wpa_get_mib(struct wpa_authenticator *wpa_auth, char *buf, size_t buflen);
 243 int wpa_get_mib_sta(struct wpa_state_machine *sm, char *buf, size_t buflen);
 244 void wpa_auth_countermeasures_start(struct wpa_authenticator *wpa_auth);
 245 int wpa_auth_pairwise_set(struct wpa_state_machine *sm);
 246 int wpa_auth_get_pairwise(struct wpa_state_machine *sm);
 247 int wpa_auth_sta_key_mgmt(struct wpa_state_machine *sm);
 248 int wpa_auth_sta_wpa_version(struct wpa_state_machine *sm);
 249 int wpa_auth_sta_clear_pmksa(struct wpa_state_machine *sm,
 250                              struct rsn_pmksa_cache_entry *entry);
 251 struct rsn_pmksa_cache_entry *
 252 wpa_auth_sta_get_pmksa(struct wpa_state_machine *sm);
 253 void wpa_auth_sta_local_mic_failure_report(struct wpa_state_machine *sm);
 254 const u8 * wpa_auth_get_wpa_ie(struct wpa_authenticator *wpa_auth,
 255                                size_t *len);
 256 int wpa_auth_pmksa_add(struct wpa_state_machine *sm, const u8 *pmk,
 257                        int session_timeout, struct eapol_state_machine *eapol);
 258 int wpa_auth_pmksa_add_preauth(struct wpa_authenticator *wpa_auth,
 259                                const u8 *pmk, size_t len, const u8 *sta_addr,
 260                                int session_timeout,
 261                                struct eapol_state_machine *eapol);
 262 int wpa_auth_sta_set_vlan(struct wpa_state_machine *sm, int vlan_id);
 263
 264 #ifdef CONFIG_IEEE80211R
 265 u8 * wpa_sm_write_assoc_resp_ies(struct wpa_state_machine *sm, u8 *pos,
 266                                  size_t max_len, int auth_alg,
 267                                  const u8 *req_ies, size_t req_ies_len);
 268 void wpa_ft_process_auth(struct wpa_state_machine *sm, const u8 *bssid,
 269                          u16 auth_transaction, const u8 *ies, size_t ies_len,
 270                          void (*cb)(void *ctx, const u8 *dst, const u8 *bssid,
 271                                     u16 auth_transaction, u16 resp,
 272                                     const u8 *ies, size_t ies_len),
 273                          void *ctx);
 274 u16 wpa_ft_validate_reassoc(struct wpa_state_machine *sm, const u8 *ies,
 275                             size_t ies_len);
 276 int wpa_ft_action_rx(struct wpa_state_machine *sm, const u8 *data, size_t len);
 277 int wpa_ft_rrb_rx(struct wpa_authenticator *wpa_auth, const u8 *src_addr,
 278                   const u8 *data, size_t data_len);
 279 void wpa_ft_push_pmk_r1(struct wpa_authenticator *wpa_auth, const u8 *addr);
 280 #endif /* CONFIG_IEEE80211R */
 281
 282 #endif /* WPA_AUTH_H */