Home | History | Annotate | Download | only in rsn_supp
      1 /*
      2  * wpa_supplicant - WPA definitions
      3  * Copyright (c) 2003-2007, 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 
     16 struct wpa_sm;
     17 struct eapol_sm;
     18 struct wpa_config_blob;
     19 
     20 struct wpa_sm_ctx {
     21 	void *ctx; /* pointer to arbitrary upper level context */
     22 	void *msg_ctx; /* upper level context for wpa_msg() calls */
     23 
     24 	void (*set_state)(void *ctx, enum wpa_states state);
     25 	enum wpa_states (*get_state)(void *ctx);
     26 	void (*deauthenticate)(void * ctx, int reason_code);
     27 	void (*disassociate)(void *ctx, int reason_code);
     28 	int (*set_key)(void *ctx, enum wpa_alg alg,
     29 		       const u8 *addr, int key_idx, int set_tx,
     30 		       const u8 *seq, size_t seq_len,
     31 		       const u8 *key, size_t key_len);
     32 	void * (*get_network_ctx)(void *ctx);
     33 	int (*get_bssid)(void *ctx, u8 *bssid);
     34 	int (*ether_send)(void *ctx, const u8 *dest, u16 proto, const u8 *buf,
     35 			  size_t len);
     36 	int (*get_beacon_ie)(void *ctx);
     37 	void (*cancel_auth_timeout)(void *ctx);
     38 	u8 * (*alloc_eapol)(void *ctx, u8 type, const void *data, u16 data_len,
     39 			    size_t *msg_len, void **data_pos);
     40 	int (*add_pmkid)(void *ctx, const u8 *bssid, const u8 *pmkid);
     41 	int (*remove_pmkid)(void *ctx, const u8 *bssid, const u8 *pmkid);
     42 	void (*set_config_blob)(void *ctx, struct wpa_config_blob *blob);
     43 	const struct wpa_config_blob * (*get_config_blob)(void *ctx,
     44 							  const char *name);
     45 	int (*mlme_setprotection)(void *ctx, const u8 *addr,
     46 				  int protection_type, int key_type);
     47 	int (*update_ft_ies)(void *ctx, const u8 *md, const u8 *ies,
     48 			     size_t ies_len);
     49 	int (*send_ft_action)(void *ctx, u8 action, const u8 *target_ap,
     50 			      const u8 *ies, size_t ies_len);
     51 	int (*mark_authenticated)(void *ctx, const u8 *target_ap);
     52 #ifdef CONFIG_TDLS
     53 	int (*tdls_get_capa)(void *ctx, int *tdls_supported,
     54 			     int *tdls_ext_setup);
     55 	int (*send_tdls_mgmt)(void *ctx, const u8 *dst,
     56 			      u8 action_code, u8 dialog_token,
     57 			      u16 status_code, const u8 *buf, size_t len);
     58 	int (*tdls_oper)(void *ctx, int oper, const u8 *peer);
     59 	int (*tdls_peer_addset)(void *ctx, const u8 *addr, int add,
     60 				u16 capability, const u8 *supp_rates,
     61 				size_t supp_rates_len);
     62 #endif /* CONFIG_TDLS */
     63 	void (*set_rekey_offload)(void *ctx, const u8 *kek, const u8 *kck,
     64 				  const u8 *replay_ctr);
     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 	WPA_PARAM_MFP
     79 };
     80 
     81 struct rsn_supp_config {
     82 	void *network_ctx;
     83 	int peerkey_enabled;
     84 	int allowed_pairwise_cipher; /* bitfield of WPA_CIPHER_* */
     85 	int proactive_key_caching;
     86 	int eap_workaround;
     87 	void *eap_conf_ctx;
     88 	const u8 *ssid;
     89 	size_t ssid_len;
     90 	int wpa_ptk_rekey;
     91 };
     92 
     93 #ifndef CONFIG_NO_WPA
     94 
     95 struct wpa_sm * wpa_sm_init(struct wpa_sm_ctx *ctx);
     96 void wpa_sm_deinit(struct wpa_sm *sm);
     97 void wpa_sm_notify_assoc(struct wpa_sm *sm, const u8 *bssid);
     98 void wpa_sm_notify_disassoc(struct wpa_sm *sm);
     99 void wpa_sm_set_pmk(struct wpa_sm *sm, const u8 *pmk, size_t pmk_len);
    100 void wpa_sm_set_pmk_from_pmksa(struct wpa_sm *sm);
    101 void wpa_sm_set_fast_reauth(struct wpa_sm *sm, int fast_reauth);
    102 void wpa_sm_set_scard_ctx(struct wpa_sm *sm, void *scard_ctx);
    103 void wpa_sm_set_config(struct wpa_sm *sm, struct rsn_supp_config *config);
    104 void wpa_sm_set_own_addr(struct wpa_sm *sm, const u8 *addr);
    105 void wpa_sm_set_ifname(struct wpa_sm *sm, const char *ifname,
    106 		       const char *bridge_ifname);
    107 void wpa_sm_set_eapol(struct wpa_sm *sm, struct eapol_sm *eapol);
    108 int wpa_sm_set_assoc_wpa_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
    109 int wpa_sm_set_assoc_wpa_ie_default(struct wpa_sm *sm, u8 *wpa_ie,
    110 				    size_t *wpa_ie_len);
    111 int wpa_sm_set_ap_wpa_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
    112 int wpa_sm_set_ap_rsn_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
    113 int wpa_sm_get_mib(struct wpa_sm *sm, char *buf, size_t buflen);
    114 
    115 int wpa_sm_set_param(struct wpa_sm *sm, enum wpa_sm_conf_params param,
    116 		     unsigned int value);
    117 unsigned int wpa_sm_get_param(struct wpa_sm *sm,
    118 			      enum wpa_sm_conf_params param);
    119 
    120 int wpa_sm_get_status(struct wpa_sm *sm, char *buf, size_t buflen,
    121 		      int verbose);
    122 
    123 void wpa_sm_key_request(struct wpa_sm *sm, int error, int pairwise);
    124 
    125 int wpa_parse_wpa_ie(const u8 *wpa_ie, size_t wpa_ie_len,
    126 		     struct wpa_ie_data *data);
    127 
    128 void wpa_sm_aborted_cached(struct wpa_sm *sm);
    129 int wpa_sm_rx_eapol(struct wpa_sm *sm, const u8 *src_addr,
    130 		    const u8 *buf, size_t len);
    131 int wpa_sm_parse_own_wpa_ie(struct wpa_sm *sm, struct wpa_ie_data *data);
    132 int wpa_sm_pmksa_cache_list(struct wpa_sm *sm, char *buf, size_t len);
    133 void wpa_sm_drop_sa(struct wpa_sm *sm);
    134 int wpa_sm_has_ptk(struct wpa_sm *sm);
    135 
    136 void wpa_sm_update_replay_ctr(struct wpa_sm *sm, const u8 *replay_ctr);
    137 
    138 void wpa_sm_pmksa_cache_flush(struct wpa_sm *sm, void *network_ctx);
    139 
    140 #else /* CONFIG_NO_WPA */
    141 
    142 static inline struct wpa_sm * wpa_sm_init(struct wpa_sm_ctx *ctx)
    143 {
    144 	return (struct wpa_sm *) 1;
    145 }
    146 
    147 static inline void wpa_sm_deinit(struct wpa_sm *sm)
    148 {
    149 }
    150 
    151 static inline void wpa_sm_notify_assoc(struct wpa_sm *sm, const u8 *bssid)
    152 {
    153 }
    154 
    155 static inline void wpa_sm_notify_disassoc(struct wpa_sm *sm)
    156 {
    157 }
    158 
    159 static inline void wpa_sm_set_pmk(struct wpa_sm *sm, const u8 *pmk,
    160 				  size_t pmk_len)
    161 {
    162 }
    163 
    164 static inline void wpa_sm_set_pmk_from_pmksa(struct wpa_sm *sm)
    165 {
    166 }
    167 
    168 static inline void wpa_sm_set_fast_reauth(struct wpa_sm *sm, int fast_reauth)
    169 {
    170 }
    171 
    172 static inline void wpa_sm_set_scard_ctx(struct wpa_sm *sm, void *scard_ctx)
    173 {
    174 }
    175 
    176 static inline void wpa_sm_set_config(struct wpa_sm *sm,
    177 				     struct rsn_supp_config *config)
    178 {
    179 }
    180 
    181 static inline void wpa_sm_set_own_addr(struct wpa_sm *sm, const u8 *addr)
    182 {
    183 }
    184 
    185 static inline void wpa_sm_set_ifname(struct wpa_sm *sm, const char *ifname,
    186 				     const char *bridge_ifname)
    187 {
    188 }
    189 
    190 static inline void wpa_sm_set_eapol(struct wpa_sm *sm, struct eapol_sm *eapol)
    191 {
    192 }
    193 
    194 static inline int wpa_sm_set_assoc_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_assoc_wpa_ie_default(struct wpa_sm *sm,
    201 						  u8 *wpa_ie,
    202 						  size_t *wpa_ie_len)
    203 {
    204 	return -1;
    205 }
    206 
    207 static inline int wpa_sm_set_ap_wpa_ie(struct wpa_sm *sm, const u8 *ie,
    208 				       size_t len)
    209 {
    210 	return -1;
    211 }
    212 
    213 static inline int wpa_sm_set_ap_rsn_ie(struct wpa_sm *sm, const u8 *ie,
    214 				       size_t len)
    215 {
    216 	return -1;
    217 }
    218 
    219 static inline int wpa_sm_get_mib(struct wpa_sm *sm, char *buf, size_t buflen)
    220 {
    221 	return 0;
    222 }
    223 
    224 static inline int wpa_sm_set_param(struct wpa_sm *sm,
    225 				   enum wpa_sm_conf_params param,
    226 				   unsigned int value)
    227 {
    228 	return -1;
    229 }
    230 
    231 static inline unsigned int wpa_sm_get_param(struct wpa_sm *sm,
    232 					    enum wpa_sm_conf_params param)
    233 {
    234 	return 0;
    235 }
    236 
    237 static inline int wpa_sm_get_status(struct wpa_sm *sm, char *buf,
    238 				    size_t buflen, int verbose)
    239 {
    240 	return 0;
    241 }
    242 
    243 static inline void wpa_sm_key_request(struct wpa_sm *sm, int error,
    244 				      int pairwise)
    245 {
    246 }
    247 
    248 static inline int wpa_parse_wpa_ie(const u8 *wpa_ie, size_t wpa_ie_len,
    249 				   struct wpa_ie_data *data)
    250 {
    251 	return -1;
    252 }
    253 
    254 static inline void wpa_sm_aborted_cached(struct wpa_sm *sm)
    255 {
    256 }
    257 
    258 static inline int wpa_sm_rx_eapol(struct wpa_sm *sm, const u8 *src_addr,
    259 				  const u8 *buf, size_t len)
    260 {
    261 	return -1;
    262 }
    263 
    264 static inline int wpa_sm_parse_own_wpa_ie(struct wpa_sm *sm,
    265 					  struct wpa_ie_data *data)
    266 {
    267 	return -1;
    268 }
    269 
    270 static inline int wpa_sm_pmksa_cache_list(struct wpa_sm *sm, char *buf,
    271 					  size_t len)
    272 {
    273 	return -1;
    274 }
    275 
    276 static inline void wpa_sm_drop_sa(struct wpa_sm *sm)
    277 {
    278 }
    279 
    280 static inline int wpa_sm_has_ptk(struct wpa_sm *sm)
    281 {
    282 	return 0;
    283 }
    284 
    285 static inline void wpa_sm_update_replay_ctr(struct wpa_sm *sm,
    286 					    const u8 *replay_ctr)
    287 {
    288 }
    289 
    290 static inline void wpa_sm_pmksa_cache_flush(struct wpa_sm *sm,
    291 					    void *network_ctx)
    292 {
    293 }
    294 
    295 #endif /* CONFIG_NO_WPA */
    296 
    297 #ifdef CONFIG_PEERKEY
    298 int wpa_sm_stkstart(struct wpa_sm *sm, const u8 *peer);
    299 #else /* CONFIG_PEERKEY */
    300 static inline int wpa_sm_stkstart(struct wpa_sm *sm, const u8 *peer)
    301 {
    302 	return -1;
    303 }
    304 #endif /* CONFIG_PEERKEY */
    305 
    306 #ifdef CONFIG_IEEE80211R
    307 
    308 int wpa_sm_set_ft_params(struct wpa_sm *sm, const u8 *ies, size_t ies_len);
    309 int wpa_ft_prepare_auth_request(struct wpa_sm *sm, const u8 *mdie);
    310 int wpa_ft_process_response(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
    311 			    int ft_action, const u8 *target_ap,
    312 			    const u8 *ric_ies, size_t ric_ies_len);
    313 int wpa_ft_is_completed(struct wpa_sm *sm);
    314 int wpa_ft_validate_reassoc_resp(struct wpa_sm *sm, const u8 *ies,
    315 				 size_t ies_len, const u8 *src_addr);
    316 int wpa_ft_start_over_ds(struct wpa_sm *sm, const u8 *target_ap,
    317 			 const u8 *mdie);
    318 
    319 #else /* CONFIG_IEEE80211R */
    320 
    321 static inline int
    322 wpa_sm_set_ft_params(struct wpa_sm *sm, const u8 *ies, size_t ies_len)
    323 {
    324 	return 0;
    325 }
    326 
    327 static inline int wpa_ft_prepare_auth_request(struct wpa_sm *sm,
    328 					      const u8 *mdie)
    329 {
    330 	return 0;
    331 }
    332 
    333 static inline int
    334 wpa_ft_process_response(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
    335 			int ft_action, const u8 *target_ap)
    336 {
    337 	return 0;
    338 }
    339 
    340 static inline int wpa_ft_is_completed(struct wpa_sm *sm)
    341 {
    342 	return 0;
    343 }
    344 
    345 static inline int
    346 wpa_ft_validate_reassoc_resp(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
    347 			     const u8 *src_addr)
    348 {
    349 	return -1;
    350 }
    351 
    352 #endif /* CONFIG_IEEE80211R */
    353 
    354 
    355 /* tdls.c */
    356 void wpa_tdls_ap_ies(struct wpa_sm *sm, const u8 *ies, size_t len);
    357 void wpa_tdls_assoc_resp_ies(struct wpa_sm *sm, const u8 *ies, size_t len);
    358 int wpa_tdls_start(struct wpa_sm *sm, const u8 *addr);
    359 int wpa_tdls_reneg(struct wpa_sm *sm, const u8 *addr);
    360 int wpa_tdls_send_teardown(struct wpa_sm *sm, const u8 *addr, u16 reason_code);
    361 int wpa_tdls_teardown_link(struct wpa_sm *sm, const u8 *addr, u16 reason_code);
    362 int wpa_tdls_send_discovery_request(struct wpa_sm *sm, const u8 *addr);
    363 int wpa_tdls_init(struct wpa_sm *sm);
    364 void wpa_tdls_deinit(struct wpa_sm *sm);
    365 void wpa_tdls_enable(struct wpa_sm *sm, int enabled);
    366 void wpa_tdls_disable_link(struct wpa_sm *sm, const u8 *addr);
    367 int wpa_tdls_is_external_setup(struct wpa_sm *sm);
    368 
    369 #endif /* WPA_H */
    370