eapol_supp_sm.h

/*
 * EAPOL supplicant state machines
 * 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 EAPOL_SUPP_SM_H
#define EAPOL_SUPP_SM_H

#include "common/defs.h"

typedef enum { Unauthorized, Authorized } PortStatus;
typedef enum { Auto, ForceUnauthorized, ForceAuthorized } PortControl;

struct eapol_config {
    int accept_802_1x_keys;

#define EAPOL_REQUIRE_KEY_UNICAST BIT(0)
#define EAPOL_REQUIRE_KEY_BROADCAST BIT(1)

    int required_keys;

    int fast_reauth;

    unsigned int workaround;

    int eap_disabled;

    int external_sim;

#define EAPOL_LOCAL_WPS_IN_USE BIT(0)
#define EAPOL_PEER_IS_WPS20_AP BIT(1)

    int wps;
};

struct eapol_sm;
struct wpa_config_blob;

enum eapol_supp_result {
    EAPOL_SUPP_RESULT_FAILURE,
    EAPOL_SUPP_RESULT_SUCCESS,
    EAPOL_SUPP_RESULT_EXPECTED_FAILURE
};

struct eapol_ctx {
    void *ctx;

    int preauth;

    void (*cb)(struct eapol_sm *eapol, enum eapol_supp_result result,
           void *ctx);

    void *cb_ctx;

    void *msg_ctx;

    void *scard_ctx;

    void *eapol_send_ctx;

    void (*eapol_done_cb)(void *ctx);

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

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

    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 (*aborted_cached)(void *ctx);

    const char *opensc_engine_path;

    const char *pkcs11_engine_path;

    const char *pkcs11_module_path;

    const char *openssl_ciphers;

    struct wps_context *wps;

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

    void (*port_cb)(void *ctx, int authorized);

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

    int cert_in_cb;

    void (*status_cb)(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_peer_config;
struct ext_password_data;

#ifdef IEEE8021X_EAPOL
struct eapol_sm *eapol_sm_init(struct eapol_ctx *ctx);
void eapol_sm_deinit(struct eapol_sm *sm);
void eapol_sm_step(struct eapol_sm *sm);
int eapol_sm_get_status(struct eapol_sm *sm, char *buf, size_t buflen,
            int verbose);
int eapol_sm_get_mib(struct eapol_sm *sm, char *buf, size_t buflen);
void eapol_sm_configure(struct eapol_sm *sm, int heldPeriod, int authPeriod,
            int startPeriod, int maxStart);
int eapol_sm_rx_eapol(struct eapol_sm *sm, const u8 *src, const u8 *buf,
              size_t len);
void eapol_sm_notify_tx_eapol_key(struct eapol_sm *sm);
void eapol_sm_notify_portEnabled(struct eapol_sm *sm, Boolean enabled);
void eapol_sm_notify_portValid(struct eapol_sm *sm, Boolean valid);
void eapol_sm_notify_eap_success(struct eapol_sm *sm, Boolean success);
void eapol_sm_notify_eap_fail(struct eapol_sm *sm, Boolean fail);
void eapol_sm_notify_config(struct eapol_sm *sm,
                struct eap_peer_config *config,
                const struct eapol_config *conf);
int eapol_sm_get_key(struct eapol_sm *sm, u8 *key, size_t len);
const u8 * eapol_sm_get_session_id(struct eapol_sm *sm, size_t *len);
void eapol_sm_notify_logoff(struct eapol_sm *sm, Boolean logoff);
void eapol_sm_notify_cached(struct eapol_sm *sm);
void eapol_sm_notify_pmkid_attempt(struct eapol_sm *sm);
void eapol_sm_register_scard_ctx(struct eapol_sm *sm, void *ctx);
void eapol_sm_notify_portControl(struct eapol_sm *sm, PortControl portControl);
void eapol_sm_notify_ctrl_attached(struct eapol_sm *sm);
void eapol_sm_notify_ctrl_response(struct eapol_sm *sm);
void eapol_sm_request_reauth(struct eapol_sm *sm);
void eapol_sm_notify_lower_layer_success(struct eapol_sm *sm, int in_eapol_sm);
void eapol_sm_invalidate_cached_session(struct eapol_sm *sm);
const char * eapol_sm_get_method_name(struct eapol_sm *sm);
void eapol_sm_set_ext_pw_ctx(struct eapol_sm *sm,
                 struct ext_password_data *ext);
int eapol_sm_failed(struct eapol_sm *sm);
void eapol_sm_erp_flush(struct eapol_sm *sm);
struct wpabuf * eapol_sm_build_erp_reauth_start(struct eapol_sm *sm);
void eapol_sm_process_erp_finish(struct eapol_sm *sm, const u8 *buf,
                 size_t len);
int eapol_sm_get_eap_proxy_imsi(struct eapol_sm *sm, char *imsi, size_t *len);
#else /* IEEE8021X_EAPOL */
static inline struct eapol_sm *eapol_sm_init(struct eapol_ctx *ctx)
{
    free(ctx);
    return (struct eapol_sm *) 1;
}
static inline void eapol_sm_deinit(struct eapol_sm *sm)
{
}
static inline void eapol_sm_step(struct eapol_sm *sm)
{
}
static inline int eapol_sm_get_status(struct eapol_sm *sm, char *buf,
                      size_t buflen, int verbose)
{
    return 0;
}
static inline int eapol_sm_get_mib(struct eapol_sm *sm, char *buf,
                   size_t buflen)
{
    return 0;
}
static inline void eapol_sm_configure(struct eapol_sm *sm, int heldPeriod,
                      int authPeriod, int startPeriod,
                      int maxStart)
{
}
static inline int eapol_sm_rx_eapol(struct eapol_sm *sm, const u8 *src,
                    const u8 *buf, size_t len)
{
    return 0;
}
static inline void eapol_sm_notify_tx_eapol_key(struct eapol_sm *sm)
{
}
static inline void eapol_sm_notify_portEnabled(struct eapol_sm *sm,
                           Boolean enabled)
{
}
static inline void eapol_sm_notify_portValid(struct eapol_sm *sm,
                         Boolean valid)
{
}
static inline void eapol_sm_notify_eap_success(struct eapol_sm *sm,
                           Boolean success)
{
}
static inline void eapol_sm_notify_eap_fail(struct eapol_sm *sm, Boolean fail)
{
}
static inline void eapol_sm_notify_config(struct eapol_sm *sm,
                      struct eap_peer_config *config,
                      struct eapol_config *conf)
{
}
static inline int eapol_sm_get_key(struct eapol_sm *sm, u8 *key, size_t len)
{
    return -1;
}
static inline const u8 *
eapol_sm_get_session_id(struct eapol_sm *sm, size_t *len)
{
    return NULL;
}
static inline void eapol_sm_notify_logoff(struct eapol_sm *sm, Boolean logoff)
{
}
static inline void eapol_sm_notify_cached(struct eapol_sm *sm)
{
}
static inline void eapol_sm_notify_pmkid_attempt(struct eapol_sm *sm)
{
}
#define eapol_sm_register_scard_ctx(sm, ctx) do { } while (0)
static inline void eapol_sm_notify_portControl(struct eapol_sm *sm,
                           PortControl portControl)
{
}
static inline void eapol_sm_notify_ctrl_attached(struct eapol_sm *sm)
{
}
static inline void eapol_sm_notify_ctrl_response(struct eapol_sm *sm)
{
}
static inline void eapol_sm_request_reauth(struct eapol_sm *sm)
{
}
static inline void eapol_sm_notify_lower_layer_success(struct eapol_sm *sm,
                               int in_eapol_sm)
{
}
static inline void eapol_sm_invalidate_cached_session(struct eapol_sm *sm)
{
}
static inline const char * eapol_sm_get_method_name(struct eapol_sm *sm)
{
    return NULL;
}
static inline void eapol_sm_set_ext_pw_ctx(struct eapol_sm *sm,
                       struct ext_password_data *ext)
{
}
static inline int eapol_sm_failed(struct eapol_sm *sm)
{
    return 0;
}
static inline void eapol_sm_erp_flush(struct eapol_sm *sm)
{
}
static inline struct wpabuf *
eapol_sm_build_erp_reauth_start(struct eapol_sm *sm)
{
    return NULL;
}
static inline void eapol_sm_process_erp_finish(struct eapol_sm *sm,
                           const u8 *buf, size_t len)
{
}
#endif /* IEEE8021X_EAPOL */

#endif /* EAPOL_SUPP_SM_H */