xref: /freebsd/contrib/wpa/src/eapol_auth/eapol_auth_sm.h (revision bb15ca603fa442c72dde3f3cb8b46db6970e3950)
1 /*
2  * IEEE 802.1X-2004 Authenticator - EAPOL state machine
3  * Copyright (c) 2002-2009, 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 EAPOL_AUTH_SM_H
16 #define EAPOL_AUTH_SM_H
17 
18 #define EAPOL_SM_PREAUTH BIT(0)
19 #define EAPOL_SM_WAIT_START BIT(1)
20 #define EAPOL_SM_USES_WPA BIT(2)
21 #define EAPOL_SM_FROM_PMKSA_CACHE BIT(3)
22 
23 struct eapol_auth_config {
24 	int eap_reauth_period;
25 	int wpa;
26 	int individual_wep_key_len;
27 	int eap_server;
28 	void *ssl_ctx;
29 	void *msg_ctx;
30 	void *eap_sim_db_priv;
31 	char *eap_req_id_text; /* a copy of this will be allocated */
32 	size_t eap_req_id_text_len;
33 	u8 *pac_opaque_encr_key;
34 	u8 *eap_fast_a_id;
35 	size_t eap_fast_a_id_len;
36 	char *eap_fast_a_id_info;
37 	int eap_fast_prov;
38 	int pac_key_lifetime;
39 	int pac_key_refresh_time;
40 	int eap_sim_aka_result_ind;
41 	int tnc;
42 	struct wps_context *wps;
43 
44 	/* Opaque context pointer to owner data for callback functions */
45 	void *ctx;
46 };
47 
48 struct eap_user;
49 
50 typedef enum {
51 	EAPOL_LOGGER_DEBUG, EAPOL_LOGGER_INFO, EAPOL_LOGGER_WARNING
52 } eapol_logger_level;
53 
54 enum eapol_event {
55 	EAPOL_AUTH_SM_CHANGE,
56 	EAPOL_AUTH_REAUTHENTICATE
57 };
58 
59 struct eapol_auth_cb {
60 	void (*eapol_send)(void *ctx, void *sta_ctx, u8 type, const u8 *data,
61 			   size_t datalen);
62 	void (*aaa_send)(void *ctx, void *sta_ctx, const u8 *data,
63 			 size_t datalen);
64 	void (*finished)(void *ctx, void *sta_ctx, int success, int preauth);
65 	int (*get_eap_user)(void *ctx, const u8 *identity, size_t identity_len,
66 			    int phase2, struct eap_user *user);
67 	int (*sta_entry_alive)(void *ctx, const u8 *addr);
68 	void (*logger)(void *ctx, const u8 *addr, eapol_logger_level level,
69 		       const char *txt);
70 	void (*set_port_authorized)(void *ctx, void *sta_ctx, int authorized);
71 	void (*abort_auth)(void *ctx, void *sta_ctx);
72 	void (*tx_key)(void *ctx, void *sta_ctx);
73 	void (*eapol_event)(void *ctx, void *sta_ctx, enum eapol_event type);
74 };
75 
76 
77 struct eapol_authenticator * eapol_auth_init(struct eapol_auth_config *conf,
78 					     struct eapol_auth_cb *cb);
79 void eapol_auth_deinit(struct eapol_authenticator *eapol);
80 struct eapol_state_machine *
81 eapol_auth_alloc(struct eapol_authenticator *eapol, const u8 *addr,
82 		 int flags, const struct wpabuf *assoc_wps_ie, void *sta_ctx);
83 void eapol_auth_free(struct eapol_state_machine *sm);
84 void eapol_auth_step(struct eapol_state_machine *sm);
85 void eapol_auth_dump_state(FILE *f, const char *prefix,
86 			   struct eapol_state_machine *sm);
87 int eapol_auth_eap_pending_cb(struct eapol_state_machine *sm, void *ctx);
88 
89 #endif /* EAPOL_AUTH_SM_H */
90