xref: /freebsd/contrib/wpa/src/eapol_auth/eapol_auth_sm.h (revision 52c2bb75163559a6e2866ad374a7de67a4ea1273)
1 /*
2  * IEEE 802.1X-2004 Authenticator - EAPOL state machine
3  * Copyright (c) 2002-2015, Jouni Malinen <j@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 EAPOL_AUTH_SM_H
10 #define EAPOL_AUTH_SM_H
11 
12 #define EAPOL_SM_PREAUTH BIT(0)
13 #define EAPOL_SM_WAIT_START BIT(1)
14 #define EAPOL_SM_USES_WPA BIT(2)
15 #define EAPOL_SM_FROM_PMKSA_CACHE BIT(3)
16 
17 struct eapol_auth_config {
18 	int eap_reauth_period;
19 	int wpa;
20 	int individual_wep_key_len;
21 	int eap_server;
22 	void *ssl_ctx;
23 	void *msg_ctx;
24 	void *eap_sim_db_priv;
25 	char *eap_req_id_text; /* a copy of this will be allocated */
26 	size_t eap_req_id_text_len;
27 	int erp_send_reauth_start;
28 	char *erp_domain; /* a copy of this will be allocated */
29 	int erp; /* Whether ERP is enabled on authentication server */
30 	unsigned int tls_session_lifetime;
31 	unsigned int tls_flags;
32 	u8 *pac_opaque_encr_key;
33 	u8 *eap_fast_a_id;
34 	size_t eap_fast_a_id_len;
35 	char *eap_fast_a_id_info;
36 	int eap_fast_prov;
37 	int pac_key_lifetime;
38 	int pac_key_refresh_time;
39 	int eap_sim_aka_result_ind;
40 	int tnc;
41 	struct wps_context *wps;
42 	int fragment_size;
43 	u16 pwd_group;
44 	int pbc_in_m1;
45 	const u8 *server_id;
46 	size_t server_id_len;
47 
48 	/* Opaque context pointer to owner data for callback functions */
49 	void *ctx;
50 };
51 
52 struct eap_user;
53 struct eap_server_erp_key;
54 
55 typedef enum {
56 	EAPOL_LOGGER_DEBUG, EAPOL_LOGGER_INFO, EAPOL_LOGGER_WARNING
57 } eapol_logger_level;
58 
59 enum eapol_event {
60 	EAPOL_AUTH_SM_CHANGE,
61 	EAPOL_AUTH_REAUTHENTICATE
62 };
63 
64 struct eapol_auth_cb {
65 	void (*eapol_send)(void *ctx, void *sta_ctx, u8 type, const u8 *data,
66 			   size_t datalen);
67 	void (*aaa_send)(void *ctx, void *sta_ctx, const u8 *data,
68 			 size_t datalen);
69 	void (*finished)(void *ctx, void *sta_ctx, int success, int preauth,
70 			 int remediation);
71 	int (*get_eap_user)(void *ctx, const u8 *identity, size_t identity_len,
72 			    int phase2, struct eap_user *user);
73 	int (*sta_entry_alive)(void *ctx, const u8 *addr);
74 	void (*logger)(void *ctx, const u8 *addr, eapol_logger_level level,
75 		       const char *txt);
76 	void (*set_port_authorized)(void *ctx, void *sta_ctx, int authorized);
77 	void (*abort_auth)(void *ctx, void *sta_ctx);
78 	void (*tx_key)(void *ctx, void *sta_ctx);
79 	void (*eapol_event)(void *ctx, void *sta_ctx, enum eapol_event type);
80 	struct eap_server_erp_key * (*erp_get_key)(void *ctx,
81 						   const char *keyname);
82 	int (*erp_add_key)(void *ctx, struct eap_server_erp_key *erp);
83 };
84 
85 
86 struct eapol_authenticator * eapol_auth_init(struct eapol_auth_config *conf,
87 					     struct eapol_auth_cb *cb);
88 void eapol_auth_deinit(struct eapol_authenticator *eapol);
89 struct eapol_state_machine *
90 eapol_auth_alloc(struct eapol_authenticator *eapol, const u8 *addr,
91 		 int flags, const struct wpabuf *assoc_wps_ie,
92 		 const struct wpabuf *assoc_p2p_ie, void *sta_ctx,
93 		 const char *identity, const char *radius_cui);
94 void eapol_auth_free(struct eapol_state_machine *sm);
95 void eapol_auth_step(struct eapol_state_machine *sm);
96 int eapol_auth_dump_state(struct eapol_state_machine *sm, char *buf,
97 			  size_t buflen);
98 int eapol_auth_eap_pending_cb(struct eapol_state_machine *sm, void *ctx);
99 void eapol_auth_reauthenticate(struct eapol_state_machine *sm);
100 int eapol_auth_set_conf(struct eapol_state_machine *sm, const char *param,
101 			const char *value);
102 
103 #endif /* EAPOL_AUTH_SM_H */
104