eap_i.h

Go to the documentation of this file.

/*
 * hostapd / EAP Authenticator state machine internal structures (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_I_H
#define EAP_I_H

#include "wpabuf.h"
#include "eap_server/eap.h"
#include "eap_common/eap_common.h"

/* RFC 4137 - EAP Standalone Authenticator */

struct eap_method {
        int vendor;
        EapType method;
        const char *name;

        void * (*init)(struct eap_sm *sm);
        void * (*initPickUp)(struct eap_sm *sm);
        void (*reset)(struct eap_sm *sm, void *priv);

        struct wpabuf * (*buildReq)(struct eap_sm *sm, void *priv, u8 id);
        int (*getTimeout)(struct eap_sm *sm, void *priv);
        Boolean (*check)(struct eap_sm *sm, void *priv,
                         struct wpabuf *respData);
        void (*process)(struct eap_sm *sm, void *priv,
                        struct wpabuf *respData);
        Boolean (*isDone)(struct eap_sm *sm, void *priv);
        u8 * (*getKey)(struct eap_sm *sm, void *priv, size_t *len);
        /* isSuccess is not specified in draft-ietf-eap-statemachine-05.txt,
         * but it is useful in implementing Policy.getDecision() */
        Boolean (*isSuccess)(struct eap_sm *sm, void *priv);

        void (*free)(struct eap_method *method);

#define EAP_SERVER_METHOD_INTERFACE_VERSION 1

        int version;

        struct eap_method *next;

        u8 * (*get_emsk)(struct eap_sm *sm, void *priv, size_t *len);
};

struct eap_sm {
        enum {
                EAP_DISABLED, EAP_INITIALIZE, EAP_IDLE, EAP_RECEIVED,
                EAP_INTEGRITY_CHECK, EAP_METHOD_RESPONSE, EAP_METHOD_REQUEST,
                EAP_PROPOSE_METHOD, EAP_SELECT_ACTION, EAP_SEND_REQUEST,
                EAP_DISCARD, EAP_NAK, EAP_RETRANSMIT, EAP_SUCCESS, EAP_FAILURE,
                EAP_TIMEOUT_FAILURE, EAP_PICK_UP_METHOD,
                EAP_INITIALIZE_PASSTHROUGH, EAP_IDLE2, EAP_RETRANSMIT2,
                EAP_RECEIVED2, EAP_DISCARD2, EAP_SEND_REQUEST2,
                EAP_AAA_REQUEST, EAP_AAA_RESPONSE, EAP_AAA_IDLE,
                EAP_TIMEOUT_FAILURE2, EAP_FAILURE2, EAP_SUCCESS2
        } EAP_state;

        /* Constants */
        int MaxRetrans;

        struct eap_eapol_interface eap_if;

        /* Full authenticator state machine local variables */

        /* Long-term (maintained betwen packets) */
        EapType currentMethod;
        int currentId;
        enum {
                METHOD_PROPOSED, METHOD_CONTINUE, METHOD_END
        } methodState;
        int retransCount;
        struct wpabuf *lastReqData;
        int methodTimeout;

        /* Short-term (not maintained between packets) */
        Boolean rxResp;
        int respId;
        EapType respMethod;
        int respVendor;
        u32 respVendorMethod;
        Boolean ignore;
        enum {
                DECISION_SUCCESS, DECISION_FAILURE, DECISION_CONTINUE,
                DECISION_PASSTHROUGH
        } decision;

        /* Miscellaneous variables */
        const struct eap_method *m; /* selected EAP method */
        /* not defined in RFC 4137 */
        Boolean changed;
        void *eapol_ctx, *msg_ctx;
        struct eapol_callbacks *eapol_cb;
        void *eap_method_priv;
        u8 *identity;
        size_t identity_len;
        /* Whether Phase 2 method should validate identity match */
        int require_identity_match;
        int lastId; /* Identifier used in the last EAP-Packet */
        struct eap_user *user;
        int user_eap_method_index;
        int init_phase2;
        void *ssl_ctx;
        void *eap_sim_db_priv;
        Boolean backend_auth;
        Boolean update_user;
        int eap_server;

        int num_rounds;
        enum {
                METHOD_PENDING_NONE, METHOD_PENDING_WAIT, METHOD_PENDING_CONT
        } method_pending;

        u8 *auth_challenge;
        u8 *peer_challenge;

        u8 *pac_opaque_encr_key;
        u8 *eap_fast_a_id;
        size_t eap_fast_a_id_len;
        char *eap_fast_a_id_info;
        enum {
                NO_PROV, ANON_PROV, AUTH_PROV, BOTH_PROV
        } eap_fast_prov;
        int pac_key_lifetime;
        int pac_key_refresh_time;
        int eap_sim_aka_result_ind;
        int tnc;
        struct wps_context *wps;
        struct wpabuf *assoc_wps_ie;

        Boolean start_reauth;

        u8 peer_addr[ETH_ALEN];
};

int eap_user_get(struct eap_sm *sm, const u8 *identity, size_t identity_len,
                 int phase2);
void eap_sm_process_nak(struct eap_sm *sm, const u8 *nak_list, size_t len);

#endif /* EAP_I_H */