xref: /dragonfly/contrib/wpa_supplicant/src/eapol_auth/eapol_auth_sm.h (revision 3a84a4273475ed07d0ab1c2dfeffdfedef35d9cd)
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_teap_auth;
40           int eap_teap_pac_no_inner;
41           int eap_sim_aka_result_ind;
42           int eap_sim_id;
43           int tnc;
44           struct wps_context *wps;
45           int fragment_size;
46           u16 pwd_group;
47           int pbc_in_m1;
48           const u8 *server_id;
49           size_t server_id_len;
50 
51           /* Opaque context pointer to owner data for callback functions */
52           void *ctx;
53 };
54 
55 struct eap_user;
56 struct eap_server_erp_key;
57 
58 typedef enum {
59           EAPOL_LOGGER_DEBUG, EAPOL_LOGGER_INFO, EAPOL_LOGGER_WARNING
60 } eapol_logger_level;
61 
62 enum eapol_event {
63           EAPOL_AUTH_SM_CHANGE,
64           EAPOL_AUTH_REAUTHENTICATE
65 };
66 
67 struct eapol_auth_cb {
68           void (*eapol_send)(void *ctx, void *sta_ctx, u8 type, const u8 *data,
69                                  size_t datalen);
70           void (*aaa_send)(void *ctx, void *sta_ctx, const u8 *data,
71                                size_t datalen);
72           void (*finished)(void *ctx, void *sta_ctx, int success, int preauth,
73                                int remediation);
74           int (*get_eap_user)(void *ctx, const u8 *identity, size_t identity_len,
75                                   int phase2, struct eap_user *user);
76           int (*sta_entry_alive)(void *ctx, const u8 *addr);
77           void (*logger)(void *ctx, const u8 *addr, eapol_logger_level level,
78                            const char *txt);
79           void (*set_port_authorized)(void *ctx, void *sta_ctx, int authorized);
80           void (*abort_auth)(void *ctx, void *sta_ctx);
81           void (*tx_key)(void *ctx, void *sta_ctx);
82           void (*eapol_event)(void *ctx, void *sta_ctx, enum eapol_event type);
83           struct eap_server_erp_key * (*erp_get_key)(void *ctx,
84                                                                const char *keyname);
85           int (*erp_add_key)(void *ctx, struct eap_server_erp_key *erp);
86 };
87 
88 
89 struct eapol_authenticator * eapol_auth_init(struct eapol_auth_config *conf,
90                                                        struct eapol_auth_cb *cb);
91 void eapol_auth_deinit(struct eapol_authenticator *eapol);
92 struct eapol_state_machine *
93 eapol_auth_alloc(struct eapol_authenticator *eapol, const u8 *addr,
94                      int flags, const struct wpabuf *assoc_wps_ie,
95                      const struct wpabuf *assoc_p2p_ie, void *sta_ctx,
96                      const char *identity, const char *radius_cui);
97 void eapol_auth_free(struct eapol_state_machine *sm);
98 void eapol_auth_step(struct eapol_state_machine *sm);
99 int eapol_auth_dump_state(struct eapol_state_machine *sm, char *buf,
100                                 size_t buflen);
101 int eapol_auth_eap_pending_cb(struct eapol_state_machine *sm, void *ctx);
102 void eapol_auth_reauthenticate(struct eapol_state_machine *sm);
103 int eapol_auth_set_conf(struct eapol_state_machine *sm, const char *param,
104                               const char *value);
105 
106 #endif /* EAPOL_AUTH_SM_H */
107