Home | History | Annotate | Download | only in rsn_supp
      1 /*
      2  * wpa_supplicant - WPA definitions
      3  * Copyright (c) 2003-2015, Jouni Malinen <j (at) w1.fi>
      4  *
      5  * This software may be distributed under the terms of the BSD license.
      6  * See README for more details.
      7  */
      8 
      9 #ifndef WPA_H
     10 #define WPA_H
     11 
     12 #include "common/defs.h"
     13 #include "common/eapol_common.h"
     14 #include "common/wpa_common.h"
     15 #include "common/ieee802_11_defs.h"
     16 
     17 struct wpa_sm;
     18 struct eapol_sm;
     19 struct wpa_config_blob;
     20 struct hostapd_freq_params;
     21 
     22 struct wpa_sm_ctx {
     23 	void *ctx; /* pointer to arbitrary upper level context */
     24 	void *msg_ctx; /* upper level context for wpa_msg() calls */
     25 
     26 	void (*set_state)(void *ctx, enum wpa_states state);
     27 	enum wpa_states (*get_state)(void *ctx);
     28 	void (*deauthenticate)(void * ctx, int reason_code);
     29 	int (*set_key)(void *ctx, enum wpa_alg alg,
     30 		       const u8 *addr, int key_idx, int set_tx,
     31 		       const u8 *seq, size_t seq_len,
     32 		       const u8 *key, size_t key_len);
     33 	void * (*get_network_ctx)(void *ctx);
     34 	int (*get_bssid)(void *ctx, u8 *bssid);
     35 	int (*ether_send)(void *ctx, const u8 *dest, u16 proto, const u8 *buf,
     36 			  size_t len);
     37 	int (*get_beacon_ie)(void *ctx);
     38 	void (*cancel_auth_timeout)(void *ctx);
     39 	u8 * (*alloc_eapol)(void *ctx, u8 type, const void *data, u16 data_len,
     40 			    size_t *msg_len, void **data_pos);
     41 	int (*add_pmkid)(void *ctx, const u8 *bssid, const u8 *pmkid);
     42 	int (*remove_pmkid)(void *ctx, const u8 *bssid, const u8 *pmkid);
     43 	void (*set_config_blob)(void *ctx, struct wpa_config_blob *blob);
     44 	const struct wpa_config_blob * (*get_config_blob)(void *ctx,
     45 							  const char *name);
     46 	int (*mlme_setprotection)(void *ctx, const u8 *addr,
     47 				  int protection_type, int key_type);
     48 	int (*update_ft_ies)(void *ctx, const u8 *md, const u8 *ies,
     49 			     size_t ies_len);
     50 	int (*send_ft_action)(void *ctx, u8 action, const u8 *target_ap,
     51 			      const u8 *ies, size_t ies_len);
     52 	int (*mark_authenticated)(void *ctx, const u8 *target_ap);
     53 #ifdef CONFIG_TDLS
     54 	int (*tdls_get_capa)(void *ctx, int *tdls_supported,
     55 			     int *tdls_ext_setup, int *tdls_chan_switch);
     56 	int (*send_tdls_mgmt)(void *ctx, const u8 *dst,
     57 			      u8 action_code, u8 dialog_token,
     58 			      u16 status_code, u32 peer_capab,
     59 			      int initiator, const u8 *buf, size_t len);
     60 	int (*tdls_oper)(void *ctx, int oper, const u8 *peer);
     61 	int (*tdls_peer_addset)(void *ctx, const u8 *addr, int add, u16 aid,
     62 				u16 capability, const u8 *supp_rates,
     63 				size_t supp_rates_len,
     64 				const struct ieee80211_ht_capabilities *ht_capab,
     65 				const struct ieee80211_vht_capabilities *vht_capab,
     66 				u8 qosinfo, int wmm, const u8 *ext_capab,
     67 				size_t ext_capab_len, const u8 *supp_channels,
     68 				size_t supp_channels_len,
     69 				const u8 *supp_oper_classes,
     70 				size_t supp_oper_classes_len);
     71 	int (*tdls_enable_channel_switch)(
     72 		void *ctx, const u8 *addr, u8 oper_class,
     73 		const struct hostapd_freq_params *params);
     74 	int (*tdls_disable_channel_switch)(void *ctx, const u8 *addr);
     75 #endif /* CONFIG_TDLS */
     76 	void (*set_rekey_offload)(void *ctx, const u8 *kek, size_t kek_len,
     77 				  const u8 *kck, size_t kck_len,
     78 				  const u8 *replay_ctr);
     79 	int (*key_mgmt_set_pmk)(void *ctx, const u8 *pmk, size_t pmk_len);
     80 };
     81 
     82 
     83 enum wpa_sm_conf_params {
     84 	RSNA_PMK_LIFETIME /* dot11RSNAConfigPMKLifetime */,
     85 	RSNA_PMK_REAUTH_THRESHOLD /* dot11RSNAConfigPMKReauthThreshold */,
     86 	RSNA_SA_TIMEOUT /* dot11RSNAConfigSATimeout */,
     87 	WPA_PARAM_PROTO,
     88 	WPA_PARAM_PAIRWISE,
     89 	WPA_PARAM_GROUP,
     90 	WPA_PARAM_KEY_MGMT,
     91 	WPA_PARAM_MGMT_GROUP,
     92 	WPA_PARAM_RSN_ENABLED,
     93 	WPA_PARAM_MFP
     94 };
     95 
     96 struct rsn_supp_config {
     97 	void *network_ctx;
     98 	int peerkey_enabled;
     99 	int allowed_pairwise_cipher; /* bitfield of WPA_CIPHER_* */
    100 	int proactive_key_caching;
    101 	int eap_workaround;
    102 	void *eap_conf_ctx;
    103 	const u8 *ssid;
    104 	size_t ssid_len;
    105 	int wpa_ptk_rekey;
    106 	int p2p;
    107 };
    108 
    109 #ifndef CONFIG_NO_WPA
    110 
    111 struct wpa_sm * wpa_sm_init(struct wpa_sm_ctx *ctx);
    112 void wpa_sm_deinit(struct wpa_sm *sm);
    113 void wpa_sm_notify_assoc(struct wpa_sm *sm, const u8 *bssid);
    114 void wpa_sm_notify_disassoc(struct wpa_sm *sm);
    115 void wpa_sm_set_pmk(struct wpa_sm *sm, const u8 *pmk, size_t pmk_len,
    116 		    const u8 *bssid);
    117 void wpa_sm_set_pmk_from_pmksa(struct wpa_sm *sm);
    118 void wpa_sm_set_fast_reauth(struct wpa_sm *sm, int fast_reauth);
    119 void wpa_sm_set_scard_ctx(struct wpa_sm *sm, void *scard_ctx);
    120 void wpa_sm_set_config(struct wpa_sm *sm, struct rsn_supp_config *config);
    121 void wpa_sm_set_own_addr(struct wpa_sm *sm, const u8 *addr);
    122 void wpa_sm_set_ifname(struct wpa_sm *sm, const char *ifname,
    123 		       const char *bridge_ifname);
    124 void wpa_sm_set_eapol(struct wpa_sm *sm, struct eapol_sm *eapol);
    125 int wpa_sm_set_assoc_wpa_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
    126 int wpa_sm_set_assoc_wpa_ie_default(struct wpa_sm *sm, u8 *wpa_ie,
    127 				    size_t *wpa_ie_len);
    128 int wpa_sm_set_ap_wpa_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
    129 int wpa_sm_set_ap_rsn_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
    130 int wpa_sm_get_mib(struct wpa_sm *sm, char *buf, size_t buflen);
    131 
    132 int wpa_sm_set_param(struct wpa_sm *sm, enum wpa_sm_conf_params param,
    133 		     unsigned int value);
    134 
    135 int wpa_sm_get_status(struct wpa_sm *sm, char *buf, size_t buflen,
    136 		      int verbose);
    137 int wpa_sm_pmf_enabled(struct wpa_sm *sm);
    138 
    139 void wpa_sm_key_request(struct wpa_sm *sm, int error, int pairwise);
    140 
    141 int wpa_parse_wpa_ie(const u8 *wpa_ie, size_t wpa_ie_len,
    142 		     struct wpa_ie_data *data);
    143 
    144 void wpa_sm_aborted_cached(struct wpa_sm *sm);
    145 int wpa_sm_rx_eapol(struct wpa_sm *sm, const u8 *src_addr,
    146 		    const u8 *buf, size_t len);
    147 int wpa_sm_parse_own_wpa_ie(struct wpa_sm *sm, struct wpa_ie_data *data);
    148 int wpa_sm_pmksa_cache_list(struct wpa_sm *sm, char *buf, size_t len);
    149 void wpa_sm_drop_sa(struct wpa_sm *sm);
    150 int wpa_sm_has_ptk(struct wpa_sm *sm);
    151 
    152 void wpa_sm_update_replay_ctr(struct wpa_sm *sm, const u8 *replay_ctr);
    153 
    154 void wpa_sm_pmksa_cache_flush(struct wpa_sm *sm, void *network_ctx);
    155 
    156 int wpa_sm_get_p2p_ip_addr(struct wpa_sm *sm, u8 *buf);
    157 
    158 void wpa_sm_set_rx_replay_ctr(struct wpa_sm *sm, const u8 *rx_replay_counter);
    159 void wpa_sm_set_ptk_kck_kek(struct wpa_sm *sm,
    160 			    const u8 *ptk_kck, size_t ptk_kck_len,
    161 			    const u8 *ptk_kek, size_t ptk_kek_len);
    162 
    163 #else /* CONFIG_NO_WPA */
    164 
    165 static inline struct wpa_sm * wpa_sm_init(struct wpa_sm_ctx *ctx)
    166 {
    167 	return (struct wpa_sm *) 1;
    168 }
    169 
    170 static inline void wpa_sm_deinit(struct wpa_sm *sm)
    171 {
    172 }
    173 
    174 static inline void wpa_sm_notify_assoc(struct wpa_sm *sm, const u8 *bssid)
    175 {
    176 }
    177 
    178 static inline void wpa_sm_notify_disassoc(struct wpa_sm *sm)
    179 {
    180 }
    181 
    182 static inline void wpa_sm_set_pmk(struct wpa_sm *sm, const u8 *pmk,
    183 				  size_t pmk_len)
    184 {
    185 }
    186 
    187 static inline void wpa_sm_set_pmk_from_pmksa(struct wpa_sm *sm)
    188 {
    189 }
    190 
    191 static inline void wpa_sm_set_fast_reauth(struct wpa_sm *sm, int fast_reauth)
    192 {
    193 }
    194 
    195 static inline void wpa_sm_set_scard_ctx(struct wpa_sm *sm, void *scard_ctx)
    196 {
    197 }
    198 
    199 static inline void wpa_sm_set_config(struct wpa_sm *sm,
    200 				     struct rsn_supp_config *config)
    201 {
    202 }
    203 
    204 static inline void wpa_sm_set_own_addr(struct wpa_sm *sm, const u8 *addr)
    205 {
    206 }
    207 
    208 static inline void wpa_sm_set_ifname(struct wpa_sm *sm, const char *ifname,
    209 				     const char *bridge_ifname)
    210 {
    211 }
    212 
    213 static inline void wpa_sm_set_eapol(struct wpa_sm *sm, struct eapol_sm *eapol)
    214 {
    215 }
    216 
    217 static inline int wpa_sm_set_assoc_wpa_ie(struct wpa_sm *sm, const u8 *ie,
    218 					  size_t len)
    219 {
    220 	return -1;
    221 }
    222 
    223 static inline int wpa_sm_set_assoc_wpa_ie_default(struct wpa_sm *sm,
    224 						  u8 *wpa_ie,
    225 						  size_t *wpa_ie_len)
    226 {
    227 	return -1;
    228 }
    229 
    230 static inline int wpa_sm_set_ap_wpa_ie(struct wpa_sm *sm, const u8 *ie,
    231 				       size_t len)
    232 {
    233 	return -1;
    234 }
    235 
    236 static inline int wpa_sm_set_ap_rsn_ie(struct wpa_sm *sm, const u8 *ie,
    237 				       size_t len)
    238 {
    239 	return -1;
    240 }
    241 
    242 static inline int wpa_sm_get_mib(struct wpa_sm *sm, char *buf, size_t buflen)
    243 {
    244 	return 0;
    245 }
    246 
    247 static inline int wpa_sm_set_param(struct wpa_sm *sm,
    248 				   enum wpa_sm_conf_params param,
    249 				   unsigned int value)
    250 {
    251 	return -1;
    252 }
    253 
    254 static inline int wpa_sm_get_status(struct wpa_sm *sm, char *buf,
    255 				    size_t buflen, int verbose)
    256 {
    257 	return 0;
    258 }
    259 
    260 static inline int wpa_sm_pmf_enabled(struct wpa_sm *sm)
    261 {
    262 	return 0;
    263 }
    264 
    265 static inline void wpa_sm_key_request(struct wpa_sm *sm, int error,
    266 				      int pairwise)
    267 {
    268 }
    269 
    270 static inline int wpa_parse_wpa_ie(const u8 *wpa_ie, size_t wpa_ie_len,
    271 				   struct wpa_ie_data *data)
    272 {
    273 	return -1;
    274 }
    275 
    276 static inline void wpa_sm_aborted_cached(struct wpa_sm *sm)
    277 {
    278 }
    279 
    280 static inline int wpa_sm_rx_eapol(struct wpa_sm *sm, const u8 *src_addr,
    281 				  const u8 *buf, size_t len)
    282 {
    283 	return -1;
    284 }
    285 
    286 static inline int wpa_sm_parse_own_wpa_ie(struct wpa_sm *sm,
    287 					  struct wpa_ie_data *data)
    288 {
    289 	return -1;
    290 }
    291 
    292 static inline int wpa_sm_pmksa_cache_list(struct wpa_sm *sm, char *buf,
    293 					  size_t len)
    294 {
    295 	return -1;
    296 }
    297 
    298 static inline void wpa_sm_drop_sa(struct wpa_sm *sm)
    299 {
    300 }
    301 
    302 static inline int wpa_sm_has_ptk(struct wpa_sm *sm)
    303 {
    304 	return 0;
    305 }
    306 
    307 static inline void wpa_sm_update_replay_ctr(struct wpa_sm *sm,
    308 					    const u8 *replay_ctr)
    309 {
    310 }
    311 
    312 static inline void wpa_sm_pmksa_cache_flush(struct wpa_sm *sm,
    313 					    void *network_ctx)
    314 {
    315 }
    316 
    317 static inline void wpa_sm_set_rx_replay_ctr(struct wpa_sm *sm,
    318 					    const u8 *rx_replay_counter)
    319 {
    320 }
    321 
    322 static inline void wpa_sm_set_ptk_kck_kek(struct wpa_sm *sm, const u8 *ptk_kck,
    323 					  const u8 *ptk_kek)
    324 {
    325 }
    326 
    327 #endif /* CONFIG_NO_WPA */
    328 
    329 #ifdef CONFIG_PEERKEY
    330 int wpa_sm_stkstart(struct wpa_sm *sm, const u8 *peer);
    331 int wpa_sm_rx_eapol_peerkey(struct wpa_sm *sm, const u8 *src_addr,
    332 			    const u8 *buf, size_t len);
    333 #else /* CONFIG_PEERKEY */
    334 static inline int wpa_sm_stkstart(struct wpa_sm *sm, const u8 *peer)
    335 {
    336 	return -1;
    337 }
    338 
    339 static inline int wpa_sm_rx_eapol_peerkey(struct wpa_sm *sm, const u8 *src_addr,
    340 					  const u8 *buf, size_t len)
    341 {
    342 	return 0;
    343 }
    344 #endif /* CONFIG_PEERKEY */
    345 
    346 #ifdef CONFIG_IEEE80211R
    347 
    348 int wpa_sm_set_ft_params(struct wpa_sm *sm, const u8 *ies, size_t ies_len);
    349 int wpa_ft_prepare_auth_request(struct wpa_sm *sm, const u8 *mdie);
    350 int wpa_ft_process_response(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
    351 			    int ft_action, const u8 *target_ap,
    352 			    const u8 *ric_ies, size_t ric_ies_len);
    353 int wpa_ft_is_completed(struct wpa_sm *sm);
    354 void wpa_reset_ft_completed(struct wpa_sm *sm);
    355 int wpa_ft_validate_reassoc_resp(struct wpa_sm *sm, const u8 *ies,
    356 				 size_t ies_len, const u8 *src_addr);
    357 int wpa_ft_start_over_ds(struct wpa_sm *sm, const u8 *target_ap,
    358 			 const u8 *mdie);
    359 
    360 #else /* CONFIG_IEEE80211R */
    361 
    362 static inline int
    363 wpa_sm_set_ft_params(struct wpa_sm *sm, const u8 *ies, size_t ies_len)
    364 {
    365 	return 0;
    366 }
    367 
    368 static inline int wpa_ft_prepare_auth_request(struct wpa_sm *sm,
    369 					      const u8 *mdie)
    370 {
    371 	return 0;
    372 }
    373 
    374 static inline int
    375 wpa_ft_process_response(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
    376 			int ft_action, const u8 *target_ap)
    377 {
    378 	return 0;
    379 }
    380 
    381 static inline int wpa_ft_is_completed(struct wpa_sm *sm)
    382 {
    383 	return 0;
    384 }
    385 
    386 static inline void wpa_reset_ft_completed(struct wpa_sm *sm)
    387 {
    388 }
    389 
    390 static inline int
    391 wpa_ft_validate_reassoc_resp(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
    392 			     const u8 *src_addr)
    393 {
    394 	return -1;
    395 }
    396 
    397 #endif /* CONFIG_IEEE80211R */
    398 
    399 
    400 /* tdls.c */
    401 void wpa_tdls_ap_ies(struct wpa_sm *sm, const u8 *ies, size_t len);
    402 void wpa_tdls_assoc_resp_ies(struct wpa_sm *sm, const u8 *ies, size_t len);
    403 int wpa_tdls_start(struct wpa_sm *sm, const u8 *addr);
    404 void wpa_tdls_remove(struct wpa_sm *sm, const u8 *addr);
    405 int wpa_tdls_teardown_link(struct wpa_sm *sm, const u8 *addr, u16 reason_code);
    406 int wpa_tdls_send_discovery_request(struct wpa_sm *sm, const u8 *addr);
    407 int wpa_tdls_init(struct wpa_sm *sm);
    408 void wpa_tdls_teardown_peers(struct wpa_sm *sm);
    409 void wpa_tdls_deinit(struct wpa_sm *sm);
    410 void wpa_tdls_enable(struct wpa_sm *sm, int enabled);
    411 void wpa_tdls_disable_unreachable_link(struct wpa_sm *sm, const u8 *addr);
    412 const char * wpa_tdls_get_link_status(struct wpa_sm *sm, const u8 *addr);
    413 int wpa_tdls_is_external_setup(struct wpa_sm *sm);
    414 int wpa_tdls_enable_chan_switch(struct wpa_sm *sm, const u8 *addr,
    415 				u8 oper_class,
    416 				struct hostapd_freq_params *freq_params);
    417 int wpa_tdls_disable_chan_switch(struct wpa_sm *sm, const u8 *addr);
    418 
    419 int wpa_wnmsleep_install_key(struct wpa_sm *sm, u8 subelem_id, u8 *buf);
    420 
    421 #endif /* WPA_H */
    422