eap.h

Go to the documentation of this file.

/*
 * EAP peer state machine functions (RFC 4137)
 * Copyright (c) 2004-2007, Jouni Malinen <j@w1.fi>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * Alternatively, this software may be distributed under the terms of BSD
 * license.
 *
 * See README and COPYING for more details.
 */

#ifndef EAP_H
#define EAP_H

#include "common/defs.h"
#include "eap_common/eap_defs.h"
#include "eap_peer/eap_methods.h"

struct eap_sm;
struct wpa_config_blob;
struct wpabuf;

struct eap_method_type {
        int vendor;
        u32 method;
};

#ifdef IEEE8021X_EAPOL

enum eapol_bool_var {
        EAPOL_eapSuccess,

        EAPOL_eapRestart,

        EAPOL_eapFail,

        EAPOL_eapResp,

        EAPOL_eapNoResp,

        EAPOL_eapReq,

        EAPOL_portEnabled,

        EAPOL_altAccept,

        EAPOL_altReject
};

enum eapol_int_var {
        EAPOL_idleWhile
};

struct eapol_callbacks {
        struct eap_peer_config * (*get_config)(void *ctx);

        Boolean (*get_bool)(void *ctx, enum eapol_bool_var variable);

        void (*set_bool)(void *ctx, enum eapol_bool_var variable,
                         Boolean value);

        unsigned int (*get_int)(void *ctx, enum eapol_int_var variable);

        void (*set_int)(void *ctx, enum eapol_int_var variable,
                        unsigned int value);

        struct wpabuf * (*get_eapReqData)(void *ctx);

        void (*set_config_blob)(void *ctx, struct wpa_config_blob *blob);

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

        void (*notify_pending)(void *ctx);

        void (*eap_param_needed)(void *ctx, const char *field,
                                 const char *txt);
};

struct eap_config {
        const char *opensc_engine_path;
        const char *pkcs11_engine_path;
        const char *pkcs11_module_path;
        struct wps_context *wps;
};

struct eap_sm * eap_peer_sm_init(void *eapol_ctx,
                                 struct eapol_callbacks *eapol_cb,
                                 void *msg_ctx, struct eap_config *conf);
void eap_peer_sm_deinit(struct eap_sm *sm);
int eap_peer_sm_step(struct eap_sm *sm);
void eap_sm_abort(struct eap_sm *sm);
int eap_sm_get_status(struct eap_sm *sm, char *buf, size_t buflen,
                      int verbose);
struct wpabuf * eap_sm_buildIdentity(struct eap_sm *sm, int id, int encrypted);
void eap_sm_request_identity(struct eap_sm *sm);
void eap_sm_request_password(struct eap_sm *sm);
void eap_sm_request_new_password(struct eap_sm *sm);
void eap_sm_request_pin(struct eap_sm *sm);
void eap_sm_request_otp(struct eap_sm *sm, const char *msg, size_t msg_len);
void eap_sm_request_passphrase(struct eap_sm *sm);
void eap_sm_notify_ctrl_attached(struct eap_sm *sm);
u32 eap_get_phase2_type(const char *name, int *vendor);
struct eap_method_type * eap_get_phase2_types(struct eap_peer_config *config,
                                              size_t *count);
void eap_set_fast_reauth(struct eap_sm *sm, int enabled);
void eap_set_workaround(struct eap_sm *sm, unsigned int workaround);
void eap_set_force_disabled(struct eap_sm *sm, int disabled);
int eap_key_available(struct eap_sm *sm);
void eap_notify_success(struct eap_sm *sm);
void eap_notify_lower_layer_success(struct eap_sm *sm);
const u8 * eap_get_eapKeyData(struct eap_sm *sm, size_t *len);
struct wpabuf * eap_get_eapRespData(struct eap_sm *sm);
void eap_register_scard_ctx(struct eap_sm *sm, void *ctx);
void eap_invalidate_cached_session(struct eap_sm *sm);

int eap_is_wps_pbc_enrollee(struct eap_peer_config *conf);
int eap_is_wps_pin_enrollee(struct eap_peer_config *conf);

#endif /* IEEE8021X_EAPOL */

#endif /* EAP_H */