eapol_ctx Struct Reference

Global (for all networks) EAPOL state machine context. More...

#include <eapol_sm.h>

Collaboration diagram for eapol_ctx:

Collaboration graph
[legend]

Data Fields

void * ctx
 Pointer to arbitrary upper level context.
int preauth
 IEEE 802.11i/RSN pre-authentication.
void(* cb )(struct eapol_sm *eapol, int success, void *ctx)
 Function to be called when EAPOL negotiation has been completed.
void * cb_ctx
 Callback context for cb().
void * msg_ctx
 Callback context for wpa_msg() calls.
void * scard_ctx
 Callback context for PC/SC scard_*() function calls.
void * eapol_send_ctx
 Callback context for eapol_send() calls.
void(* eapol_done_cb )(void *ctx)
 Function to be called at successful completion.
int(* eapol_send )(void *ctx, int type, const u8 *buf, size_t len)
 Send EAPOL packets.
int(* set_wep_key )(void *ctx, int unicast, int keyidx, const u8 *key, size_t keylen)
 Configure WEP keys.
void(* set_config_blob )(void *ctx, struct wpa_config_blob *blob)
 Set or add a named configuration blob.
const struct wpa_config_blob *(* get_config_blob )(void *ctx, const char *name)
 Get a named configuration blob.
void(* aborted_cached )(void *ctx)
 Notify that cached PMK attempt was aborted.
const char * opensc_engine_path
 Path to the OpenSSL engine for opensc.
const char * pkcs11_engine_path
 Path to the OpenSSL engine for PKCS#11.
const char * pkcs11_module_path
 Path to the OpenSSL OpenSC/PKCS#11 module.

Detailed Description

Global (for all networks) EAPOL state machine context.

Definition at line 78 of file eapol_sm.h.


Field Documentation

void(* eapol_ctx::aborted_cached)(void *ctx)
 

Notify that cached PMK attempt was aborted.

Parameters:
ctx Callback context (ctx)

void(* eapol_ctx::cb)(struct eapol_sm *eapol, int success, void *ctx)
 

Function to be called when EAPOL negotiation has been completed.

Parameters:
eapol Pointer to EAPOL state machine data
success Whether the authentication was completed successfully
ctx Pointer to context data (cb_ctx)
This optional callback function will be called when the EAPOL authentication has been completed. This allows the owner of the EAPOL state machine to process the key and terminate the EAPOL state machine. Currently, this is used only in RSN pre-authentication.

void(* eapol_ctx::eapol_done_cb)(void *ctx)
 

Function to be called at successful completion.

Parameters:
ctx Callback context (ctx)
This function is called at the successful completion of EAPOL authentication. If dynamic WEP keys are used, this is called only after all the expected keys have been received.

int(* eapol_ctx::eapol_send)(void *ctx, int type, const u8 *buf, size_t len)
 

Send EAPOL packets.

Parameters:
ctx Callback context (eapol_send_ctx)
type EAPOL type (IEEE802_1X_TYPE_*)
buf Pointer to EAPOL payload
len Length of the EAPOL payload
Returns:
0 on success, -1 on failure

const struct wpa_config_blob*(* eapol_ctx::get_config_blob)(void *ctx, const char *name)
 

Get a named configuration blob.

Parameters:
ctx Callback context (ctx)
name Name of the blob
Returns:
Pointer to blob data or NULL if not found

const char* eapol_ctx::opensc_engine_path
 

Path to the OpenSSL engine for opensc.

This is an OpenSSL specific configuration option for loading OpenSC engine (engine_opensc.so); if NULL, this engine is not loaded.

Definition at line 204 of file eapol_sm.h.

const char* eapol_ctx::pkcs11_engine_path
 

Path to the OpenSSL engine for PKCS#11.

This is an OpenSSL specific configuration option for loading PKCS#11 engine (engine_pkcs11.so); if NULL, this engine is not loaded.

Definition at line 213 of file eapol_sm.h.

const char* eapol_ctx::pkcs11_module_path
 

Path to the OpenSSL OpenSC/PKCS#11 module.

This is an OpenSSL specific configuration option for configuring path to OpenSC/PKCS#11 engine (opensc-pkcs11.so); if NULL, this module is not loaded.

Definition at line 223 of file eapol_sm.h.

int eapol_ctx::preauth
 

IEEE 802.11i/RSN pre-authentication.

This EAPOL state machine is used for IEEE 802.11i/RSN pre-authentication

Definition at line 92 of file eapol_sm.h.

void* eapol_ctx::scard_ctx
 

Callback context for PC/SC scard_*() function calls.

This context can be updated with eapol_sm_register_scard_ctx().

Definition at line 126 of file eapol_sm.h.

void(* eapol_ctx::set_config_blob)(void *ctx, struct wpa_config_blob *blob)
 

Set or add a named configuration blob.

Parameters:
ctx Callback context (ctx)
blob New value for the blob
Adds a new configuration blob or replaces the current value of an existing blob.

int(* eapol_ctx::set_wep_key)(void *ctx, int unicast, int keyidx, const u8 *key, size_t keylen)
 

Configure WEP keys.

Parameters:
ctx Callback context (ctx)
unicast Non-zero = unicast, 0 = multicast/broadcast key
keyidx Key index (0..3)
key WEP key
keylen Length of the WEP key
Returns:
0 on success, -1 on failure


The documentation for this struct was generated from the following file:
Generated on Sun Dec 31 13:55:54 2006 for wpa_supplicant by  doxygen 1.4.2