eap.h

/*
 * EAP peer state machine functions (RFC 4137)
 * Copyright (c) 2004-2012, Jouni Malinen <j@w1.fi>
 *
 * This software may be distributed under the terms of the BSD license.
 * See README 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,

    EAPOL_eapTriggerStart
};

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, enum wpa_ctrl_req_type field,
                 const char *txt);

    void (*notify_cert)(void *ctx, int depth, const char *subject,
                const char *altsubject[], int num_altsubject,
                const char *cert_hash, const struct wpabuf *cert);

    void (*notify_status)(void *ctx, const char *status,
                  const char *parameter);

#ifdef CONFIG_EAP_PROXY

    void (*eap_proxy_cb)(void *ctx);

    void (*eap_proxy_notify_sim_status)(void *ctx,
                        enum eap_proxy_sim_state sim_state);
#endif /* CONFIG_EAP_PROXY */

    void (*set_anon_id)(void *ctx, const u8 *id, size_t len);
};

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

    int cert_in_cb;
};

struct eap_sm * eap_peer_sm_init(void *eapol_ctx,
                 const 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);
const char * eap_sm_get_method_name(struct eap_sm *sm);
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_request_sim(struct eap_sm *sm, const char *req);
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);
void eap_set_external_sim(struct eap_sm *sm, int external_sim);
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_eapSessionId(struct eap_sm *sm, size_t *len);
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);

struct ext_password_data;
void eap_sm_set_ext_pw_ctx(struct eap_sm *sm, struct ext_password_data *ext);
void eap_set_anon_id(struct eap_sm *sm, const u8 *id, size_t len);
int eap_peer_was_failure_expected(struct eap_sm *sm);
void eap_peer_erp_free_keys(struct eap_sm *sm);
struct wpabuf * eap_peer_build_erp_reauth_start(struct eap_sm *sm, u8 eap_id);
void eap_peer_finish(struct eap_sm *sm, const struct eap_hdr *hdr, size_t len);

#endif /* IEEE8021X_EAPOL */

#endif /* EAP_H */