]>
git.ipfire.org Git - thirdparty/hostap.git/blob - src/eapol_supp/eapol_supp_sm.h
3260c614810bb24dd426ee620d1bd3fd70882a9f
2 * EAPOL supplicant state machines
3 * Copyright (c) 2004-2008, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
9 #ifndef EAPOL_SUPP_SM_H
10 #define EAPOL_SUPP_SM_H
12 #include "common/defs.h"
14 typedef enum { Unauthorized
, Authorized
} PortStatus
;
15 typedef enum { Auto
, ForceUnauthorized
, ForceAuthorized
} PortControl
;
18 * struct eapol_config - Per network configuration for EAPOL state machines
22 * accept_802_1x_keys - Accept IEEE 802.1X (non-WPA) EAPOL-Key frames
24 * This variable should be set to 1 when using EAPOL state machines
25 * with non-WPA security policy to generate dynamic WEP keys. When
26 * using WPA, this should be set to 0 so that WPA state machine can
27 * process the EAPOL-Key frames.
29 int accept_802_1x_keys
;
31 #define EAPOL_REQUIRE_KEY_UNICAST BIT(0)
32 #define EAPOL_REQUIRE_KEY_BROADCAST BIT(1)
34 * required_keys - Which EAPOL-Key packets are required
36 * This variable determines which EAPOL-Key packets are required before
37 * marking connection authenticated. This is a bit field of
38 * EAPOL_REQUIRE_KEY_UNICAST and EAPOL_REQUIRE_KEY_BROADCAST flags.
43 * fast_reauth - Whether fast EAP reauthentication is enabled
48 * workaround - Whether EAP workarounds are enabled
50 unsigned int workaround
;
53 * eap_disabled - Whether EAP is disabled
59 struct wpa_config_blob
;
62 * struct eapol_ctx - Global (for all networks) EAPOL state machine context
66 * ctx - Pointer to arbitrary upper level context
71 * preauth - IEEE 802.11i/RSN pre-authentication
73 * This EAPOL state machine is used for IEEE 802.11i/RSN
79 * cb - Function to be called when EAPOL negotiation has been completed
80 * @eapol: Pointer to EAPOL state machine data
81 * @success: Whether the authentication was completed successfully
82 * @ctx: Pointer to context data (cb_ctx)
84 * This optional callback function will be called when the EAPOL
85 * authentication has been completed. This allows the owner of the
86 * EAPOL state machine to process the key and terminate the EAPOL state
87 * machine. Currently, this is used only in RSN pre-authentication.
89 void (*cb
)(struct eapol_sm
*eapol
, int success
, void *ctx
);
92 * cb_ctx - Callback context for cb()
97 * msg_ctx - Callback context for wpa_msg() calls
102 * scard_ctx - Callback context for PC/SC scard_*() function calls
104 * This context can be updated with eapol_sm_register_scard_ctx().
109 * eapol_send_ctx - Callback context for eapol_send() calls
111 void *eapol_send_ctx
;
114 * eapol_done_cb - Function to be called at successful completion
115 * @ctx: Callback context (ctx)
117 * This function is called at the successful completion of EAPOL
118 * authentication. If dynamic WEP keys are used, this is called only
119 * after all the expected keys have been received.
121 void (*eapol_done_cb
)(void *ctx
);
124 * eapol_send - Send EAPOL packets
125 * @ctx: Callback context (eapol_send_ctx)
126 * @type: EAPOL type (IEEE802_1X_TYPE_*)
127 * @buf: Pointer to EAPOL payload
128 * @len: Length of the EAPOL payload
129 * Returns: 0 on success, -1 on failure
131 int (*eapol_send
)(void *ctx
, int type
, const u8
*buf
, size_t len
);
134 * set_wep_key - Configure WEP keys
135 * @ctx: Callback context (ctx)
136 * @unicast: Non-zero = unicast, 0 = multicast/broadcast key
137 * @keyidx: Key index (0..3)
139 * @keylen: Length of the WEP key
140 * Returns: 0 on success, -1 on failure
142 int (*set_wep_key
)(void *ctx
, int unicast
, int keyidx
,
143 const u8
*key
, size_t keylen
);
146 * set_config_blob - Set or add a named configuration blob
147 * @ctx: Callback context (ctx)
148 * @blob: New value for the blob
150 * Adds a new configuration blob or replaces the current value of an
153 void (*set_config_blob
)(void *ctx
, struct wpa_config_blob
*blob
);
156 * get_config_blob - Get a named configuration blob
157 * @ctx: Callback context (ctx)
158 * @name: Name of the blob
159 * Returns: Pointer to blob data or %NULL if not found
161 const struct wpa_config_blob
* (*get_config_blob
)(void *ctx
,
165 * aborted_cached - Notify that cached PMK attempt was aborted
166 * @ctx: Callback context (ctx)
168 void (*aborted_cached
)(void *ctx
);
171 * opensc_engine_path - Path to the OpenSSL engine for opensc
173 * This is an OpenSSL specific configuration option for loading OpenSC
174 * engine (engine_opensc.so); if %NULL, this engine is not loaded.
176 const char *opensc_engine_path
;
179 * pkcs11_engine_path - Path to the OpenSSL engine for PKCS#11
181 * This is an OpenSSL specific configuration option for loading PKCS#11
182 * engine (engine_pkcs11.so); if %NULL, this engine is not loaded.
184 const char *pkcs11_engine_path
;
187 * pkcs11_module_path - Path to the OpenSSL OpenSC/PKCS#11 module
189 * This is an OpenSSL specific configuration option for configuring
190 * path to OpenSC/PKCS#11 engine (opensc-pkcs11.so); if %NULL, this
191 * module is not loaded.
193 const char *pkcs11_module_path
;
196 * wps - WPS context data
198 * This is only used by EAP-WSC and can be left %NULL if not available.
200 struct wps_context
*wps
;
203 * eap_param_needed - Notify that EAP parameter is needed
204 * @ctx: Callback context (ctx)
205 * @field: Field indicator (e.g., WPA_CTRL_REQ_EAP_IDENTITY)
206 * @txt: User readable text describing the required parameter
208 void (*eap_param_needed
)(void *ctx
, enum wpa_ctrl_req_type field
,
212 * port_cb - Set port authorized/unauthorized callback (optional)
213 * @ctx: Callback context (ctx)
214 * @authorized: Whether the supplicant port is now in authorized state
216 void (*port_cb
)(void *ctx
, int authorized
);
219 * cert_cb - Notification of a peer certificate
220 * @ctx: Callback context (ctx)
221 * @depth: Depth in certificate chain (0 = server)
222 * @subject: Subject of the peer certificate
223 * @cert_hash: SHA-256 hash of the certificate
224 * @cert: Peer certificate
226 void (*cert_cb
)(void *ctx
, int depth
, const char *subject
,
227 const char *cert_hash
, const struct wpabuf
*cert
);
230 * cert_in_cb - Include server certificates in callback
236 struct eap_peer_config
;
238 #ifdef IEEE8021X_EAPOL
239 struct eapol_sm
*eapol_sm_init(struct eapol_ctx
*ctx
);
240 void eapol_sm_deinit(struct eapol_sm
*sm
);
241 void eapol_sm_step(struct eapol_sm
*sm
);
242 int eapol_sm_get_status(struct eapol_sm
*sm
, char *buf
, size_t buflen
,
244 int eapol_sm_get_mib(struct eapol_sm
*sm
, char *buf
, size_t buflen
);
245 void eapol_sm_configure(struct eapol_sm
*sm
, int heldPeriod
, int authPeriod
,
246 int startPeriod
, int maxStart
);
247 int eapol_sm_rx_eapol(struct eapol_sm
*sm
, const u8
*src
, const u8
*buf
,
249 void eapol_sm_notify_tx_eapol_key(struct eapol_sm
*sm
);
250 void eapol_sm_notify_portEnabled(struct eapol_sm
*sm
, Boolean enabled
);
251 void eapol_sm_notify_portValid(struct eapol_sm
*sm
, Boolean valid
);
252 void eapol_sm_notify_eap_success(struct eapol_sm
*sm
, Boolean success
);
253 void eapol_sm_notify_eap_fail(struct eapol_sm
*sm
, Boolean fail
);
254 void eapol_sm_notify_config(struct eapol_sm
*sm
,
255 struct eap_peer_config
*config
,
256 const struct eapol_config
*conf
);
257 int eapol_sm_get_key(struct eapol_sm
*sm
, u8
*key
, size_t len
);
258 void eapol_sm_notify_logoff(struct eapol_sm
*sm
, Boolean logoff
);
259 void eapol_sm_notify_cached(struct eapol_sm
*sm
);
260 void eapol_sm_notify_pmkid_attempt(struct eapol_sm
*sm
, int attempt
);
261 void eapol_sm_register_scard_ctx(struct eapol_sm
*sm
, void *ctx
);
262 void eapol_sm_notify_portControl(struct eapol_sm
*sm
, PortControl portControl
);
263 void eapol_sm_notify_ctrl_attached(struct eapol_sm
*sm
);
264 void eapol_sm_notify_ctrl_response(struct eapol_sm
*sm
);
265 void eapol_sm_request_reauth(struct eapol_sm
*sm
);
266 void eapol_sm_notify_lower_layer_success(struct eapol_sm
*sm
, int in_eapol_sm
);
267 void eapol_sm_invalidate_cached_session(struct eapol_sm
*sm
);
268 const char * eapol_sm_get_method_name(struct eapol_sm
*sm
);
269 #else /* IEEE8021X_EAPOL */
270 static inline struct eapol_sm
*eapol_sm_init(struct eapol_ctx
*ctx
)
273 return (struct eapol_sm
*) 1;
275 static inline void eapol_sm_deinit(struct eapol_sm
*sm
)
278 static inline void eapol_sm_step(struct eapol_sm
*sm
)
281 static inline int eapol_sm_get_status(struct eapol_sm
*sm
, char *buf
,
282 size_t buflen
, int verbose
)
286 static inline int eapol_sm_get_mib(struct eapol_sm
*sm
, char *buf
,
291 static inline void eapol_sm_configure(struct eapol_sm
*sm
, int heldPeriod
,
292 int authPeriod
, int startPeriod
,
296 static inline int eapol_sm_rx_eapol(struct eapol_sm
*sm
, const u8
*src
,
297 const u8
*buf
, size_t len
)
301 static inline void eapol_sm_notify_tx_eapol_key(struct eapol_sm
*sm
)
304 static inline void eapol_sm_notify_portEnabled(struct eapol_sm
*sm
,
308 static inline void eapol_sm_notify_portValid(struct eapol_sm
*sm
,
312 static inline void eapol_sm_notify_eap_success(struct eapol_sm
*sm
,
316 static inline void eapol_sm_notify_eap_fail(struct eapol_sm
*sm
, Boolean fail
)
319 static inline void eapol_sm_notify_config(struct eapol_sm
*sm
,
320 struct eap_peer_config
*config
,
321 struct eapol_config
*conf
)
324 static inline int eapol_sm_get_key(struct eapol_sm
*sm
, u8
*key
, size_t len
)
328 static inline void eapol_sm_notify_logoff(struct eapol_sm
*sm
, Boolean logoff
)
331 static inline void eapol_sm_notify_cached(struct eapol_sm
*sm
)
334 #define eapol_sm_notify_pmkid_attempt(sm, attempt) do { } while (0)
335 #define eapol_sm_register_scard_ctx(sm, ctx) do { } while (0)
336 static inline void eapol_sm_notify_portControl(struct eapol_sm
*sm
,
337 PortControl portControl
)
340 static inline void eapol_sm_notify_ctrl_attached(struct eapol_sm
*sm
)
343 static inline void eapol_sm_notify_ctrl_response(struct eapol_sm
*sm
)
346 static inline void eapol_sm_request_reauth(struct eapol_sm
*sm
)
349 static inline void eapol_sm_notify_lower_layer_success(struct eapol_sm
*sm
,
353 static inline void eapol_sm_invalidate_cached_session(struct eapol_sm
*sm
)
356 static inline const char * eapol_sm_get_method_name(struct eapol_sm
*sm
)
360 #endif /* IEEE8021X_EAPOL */
362 #endif /* EAPOL_SUPP_SM_H */