/*

* Copyright (c) 2001-2006 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of the License "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:  EAP and WLAN authentication protocols.

*

*/

#if !defined(_GSMSIM_CORE_H_)

#define _GSMSIM_CORE_H_

#include "eap_tools.h"

#include "eap_am_export.h"

#include "eap_base_type.h"

#include "eap_variable_data.h"

#include "eap_type_gsmsim_types.h"

#include "eap_type_gsmsim_payloads.h"

#include "eap_type_gsmsim_state.h"

#include "abs_eap_base_timer.h"

#include "abs_eap_am_type_gsmsim.h"

#include "eap_master_session_key.h"

class eap_type_gsmsim_MAC_attributes_c;

class eap_am_type_gsmsim_c;

class crypto_hmac_c;

//#define USE_EAP_GSMSIM_VERIFY_STATES

//--------------------------------------------------

/// This class is implementation of GSMSIM EAP-type.

class EAP_EXPORT eap_type_gsmsim_c

: public abs_eap_type_gsmsim_state_c

, public abs_eap_am_type_gsmsim_c

, public abs_eap_base_timer_c

, public eap_base_type_c

{

private:

	//--------------------------------------------------

	/// This is pointer to the tools class.

	abs_eap_am_tools_c * const m_am_tools;

	//--------------------------------------------------

#if !defined(NO_EAP_TYPE_GSMSIM_MESSAGE_STATE_CHECK)

	/// This attribute stores the valid GSMSIM states (eap_type_gsmsim_state_variable_e).

	/// Each eap_type_gsmsim_state_variable_parameters_c includes the valid 

	/// GSMSIM messages within the state.

	eap_type_gsmsim_state_variable_parameters_c m_parameters[eap_type_gsmsim_state_last_value];

#endif //#if !defined(NO_EAP_TYPE_GSMSIM_MESSAGE_STATE_CHECK)

	/// This is the current state.

	eap_type_gsmsim_state_variable_e m_state;

	/// This is the saved previous state. On error case this is the state where continue.

	eap_type_gsmsim_state_variable_e m_saved_previous_state;

	/// This is network identity of the sent packet from this handler.

	eap_am_network_id_c m_send_network_id;

	/// This is the NONCE_MT. Client generates NONCE_MT and sends it to server

	/// within the EAP-Response/SIM/Start message.

	eap_variable_data_c m_nonce_mt;

	/// This is the NONCE_S. Server generates NONCE_S and sends it to client

	/// within the EAP-Request/SIM/Re-authentication message.

	eap_variable_data_c m_nonce_s;

	// - - - - - - - - - - - - - - - - - - - -

	/// Server sends IV to client within EAP-Request/SIM/Challenge message.

	/// The AT_IV payload is optional.

	gsmsim_variable_data_c m_IV;

	/// EAP-Request/SIM/Challenge message must be saved until n*Kc and n*SRES are get from SIM.

	eap_variable_data_c m_saved_EAP_packet;

	// - - - - - - - - - - - - - - - - - - - -

	/// XKEY = SHA1(n*Kc| NONCE_MT)

	eap_variable_data_c m_XKEY;

	/// K_encr is the first 16 octets of generated Key_block:s.

	eap_variable_data_c m_K_encr;

	/// K_aut is the 16 octets after K_encr of generated Key_block:s.

	eap_variable_data_c m_K_aut;

	/// m_master_session_key is the 20 octets after m_K_aut of generated Key_block:s.

	eap_master_session_key_c m_master_session_key;

	// - - - - - - - - - - - - - - - - - - - -

	/// This is the real IMSI.

	eap_variable_data_c m_IMSI;

	/// This is the pseudonym for IMSI. This is used only if server supports use of pseudonym.

	eap_variable_data_c m_pseudonym;

	/// This is the reauthentication identity. This is used only if server supports use of reauthentication identity.

	eap_variable_data_c m_reauthentication_identity;

	/// This is the automatic realm generated in AM of EAP-SIM.

	/// Note this could be invalid data when automatic realm is not used.

	/// The m_automatic_realm_read flag tells whether m_automatic_realm is read from AM of EAP-SIM.

	eap_variable_data_c m_automatic_realm;

	/// This flag tells whether automatic realm is read from AM of EAP-SIM.

	/// Note the data of m_automatic_realm could be invalid data when it is not used.

	bool m_automatic_realm_read;

	/// This is identity used in authentication. This is real IMSI or pseudonym.

	/// Pseudonym is used only if server supports use of pseudonym.

	eap_variable_data_c m_identity;

	/// This is the NAI. Format is "username@realm".

	eap_variable_data_c m_NAI;

	eap_variable_data_c m_n_rands;

	eap_variable_data_c m_n_sres;

	/// This variable stores the received GSMSIM version list.

	eap_variable_data_c m_gsmsim_version_list;

#if defined(USE_EAP_TYPE_SERVER_GSMSIM)

	/// Here is stored the received triplets.

	eap_type_sim_triplet_array_c *m_triplets;

#endif //#if defined(USE_EAP_TYPE_SERVER_GSMSIM)

	u32_t m_reauthentication_counter;

	gsmsim_payload_AT_type_e m_include_identity_to_start_response;

	/// Identity of this type is included in start response.

	gsmsim_payload_AT_type_e m_start_response_includes_identity;

	/// This flag indicates whether the EAP-Failure was received.

	/// On successfull authentication bogus EAP-Failure is ignored.

	bool m_failure_message_received;

	/// This flag indicated whether the authentication was successfull (true).

	bool m_authentication_finished_successfully;

	/// This variable stores the last used EAP-Identifier.

	/// Client will always send EAP-Response with this identifier.

	/// Server will always send EAP-Request with this identifier increased by one.

	/// Server increase this identifier after successfull packet send.

	u8_t m_last_eap_identifier;

	eap_gsmsim_version m_gsmsim_selected_version;

	eap_variable_data_c m_2_digit_mnc_map_of_mcc_of_imsi_array;

	eap_variable_data_c m_uma_automatic_realm_prefix;

	bool m_use_uma_profile;

	//--------------------------------------------------

	/// This is pointer to adaptation module of GSMSIM EAP type.

	eap_am_type_gsmsim_c * const m_am_type_gsmsim;

#if defined(_DEBUG) && defined(USE_EAP_GSMSIM_TEST_VECTORS)

	eap_variable_data_c m_nonce_mt_file;

#endif //#if defined(_DEBUG) && defined(USE_EAP_GSMSIM_TEST_VECTORS)

	eap_variable_data_c m_manual_username;

	eap_variable_data_c m_manual_realm;

	/// This eap_gsmsim_version array is the supported GSMSIM version list.

	eap_gsmsim_version m_supported_versions[GSMSIM_LAST_VERSION];

	/// This is offset in bytes of the EAP-type header in the packet buffer.

	/// Offset is described in abs_eap_base_type_c::get_header_offset().

	u32_t m_gsmsim_header_offset;

	/// This is maximum transfer unit in bytes.

	/// MTU is described in abs_eap_base_type_c::get_header_offset().

	u32_t m_MTU;

	/// This is length of the trailer in bytes.

	/// Trailer length is described in abs_eap_base_type_c::get_header_offset().

	u32_t m_trailer_length;

	/// This is minimum count of RAND challenges accepted.

	u32_t m_minimum_rand_count;

	u32_t m_length_of_mnc;

	/// This stores the current authentication type.

	/// Look at the m_identity_type too.

	eap_gsmsim_authentication_type_e m_authentication_type;

	/// This stores the current identity type.

	/// NOTE there is one stupid case where m_identity_type is GSMSIM_IDENTITY_TYPE_RE_AUTH_ID

	/// and m_authentication_type is GSMSIM_AUTHENTICATION_TYPE_FULL_AUTH.

	/// Look at the Chapter "Fast Re-authentication Procedure when Counter is Too Small"

	/// in the EAP-SIM specification.

	/// Because of that illogical specification we need separate 

	/// attributes for authentication type and identity type.

	eap_type_gsmsim_identity_type m_identity_type;

	/// This is the first client error.

	eap_gsmsim_client_error_code_e m_client_error_code;

	/// This is saved GSMSIM notificatoin code.

	/// If this value is eap_gsmsim_notification_none, no notification is stored.

	eap_gsmsim_notification_codes_e m_gsmsim_notification_code;

	u32_t m_failure_message_delay_time;

	/// This indicates whether this object was generated successfully.

	bool m_is_valid;

	/// This indicates whether this object is client (true) or server (false).

	/// In terms of EAP-protocol whether this network entity is EAP-supplicant (true) or EAP-authenticator (false).

	bool m_is_client;

	/// True value of this flag indicates the EAP-Success packet must be received

	/// in successfull authentication of clien.

	/// This value is configured with EAP_GSMSIM_wait_eap_success_packet.

	bool m_wait_eap_success_packet;

	/// True value of this flag indicates the identifier of the EAP-Response/Identity must be checked.

	/// This is not possible cases where identifier of the EAP-Request/Identity is generated by other network entities.

	bool m_check_identifier_of_eap_identity_response;

	/// True value means m_am_type_gsmsim is allocated within eap_type_gsmsim_c

	/// and m_am_type_gsmsim must be freed in destructor.

	bool m_free_am_type_gsmsim;

#if defined(USE_EAP_TYPE_GSMSIM_OWN_RE_TRANSMISSION)

	/// True value means client responds to all re-transmitted EAP-SIM packets.

	/// False value means client does not respond to any re-transmitted EAP-SIM packets.

	bool m_client_responds_retransmitted_packets;

#endif //#if defined(USE_EAP_TYPE_GSMSIM_OWN_RE_TRANSMISSION)

	/// True value means this is a test version of GSMSIM.

	bool m_gsmsim_test_version;

	/// True value means server refuses EAP-identity randomly.

	/// False value means does not refuse EAP-identity randomly.

	/// NOTE EAP_GSMSIM_test_version option must be true also.

	bool m_gsmsim_randomly_refuse_eap_identity;

	/// This flag forces check of NAI realm. Realm must be the same as given in EAP_GSMSIM_manual_realm configuration option.

	/// Default value is false, check is not done by default.

	bool m_check_nai_realm;

	/// This is for testing purposes. True value will cause failed test of re-authentication counter.

	bool m_fail_reauthentication_counter_check;

	/// True value of this flag allows acception of EAP-Response/Identity.

	/// False value does not accept EAP-Response/Identity. Instead identity is queried

	/// in EAP-Request/SIM/Start with AT_ANY_ID_REQ attribute.

	bool m_accept_eap_identity_response;

	/// True value of this flag returns random

	/// identity on EAP-Response/Identity.

	/// False value returns real identity

	/// (IMSI, pseudonym or re-authentication identity).

	bool m_use_random_identity_on_eap_identity_response;

	/// This flag is set true when shutdown() function is called.

	bool m_shutdown_was_called;

	/// This flag is set true when reset() function is called.

	/// This flag prevent multiple subsequent calls of rset() function.

	bool m_reset_was_called;

	/// This flag tells whether the client should check uniqueness of RANDs (true) or not (false).

	bool m_do_rand_uniqueness_check;

	/// This flag tells whether the pseudonym identity could be used (true) or not (false).

	bool m_use_pseudonym_identity;

	/// This flag tells whether the re-authentication identity could be used (true) or not (false).

	bool m_use_reauthentication_identity;

	/// This is set true when erroneus packet is received.

	bool m_erroneus_packet_received;

	/// This is set true when SIM notification packet is received.

	bool m_sim_notification_packet_received;

	/// This flag allows use of Windows RAS identity in EAP-Identity/Response.

	/// EAP-Request/Start will include identity query attribute.

	bool m_use_manual_username;

	/// Default value is false. That will cause use of automatic realm.

	/// If this is true then

	/// cf_str_EAP_GSMSIM_manual_realm is used as the realm.

	bool m_use_manual_realm;

	bool m_randomly_fail_successfull_authentication;

	bool m_allow_use_result_indication;

	bool m_use_result_indication;

	bool m_use_eap_expanded_type;

	//--------------------------------------------------

	/**

	 * This function stores the last encryption IV. In CBC-mode previous encrypted block is

	 * used as a IV of next block.

	 */

	eap_status_e store_last_encryption_iv(const eap_variable_data_c * const encryption_IV);

	/**

	 * This function selects best version from version list payload.

	 */

	EAP_FUNC_IMPORT eap_gsmsim_version select_version(

		const gsmsim_variable_data_c * const version_payload,

		bool * const includes_other_version_than_1);

	/**

	 * This function returns string of the current state. This is for trace purposes.

	 */

	EAP_FUNC_IMPORT eap_const_string get_state_string() const;

	/**

	 * This function returns string of the current state. This is for trace purposes.

	 */

	EAP_FUNC_IMPORT eap_const_string get_saved_previous_state_string() const;

	/**

	 * This function sets the new state and notifies the lower layer of this change.

	 */

	void set_state(eap_type_gsmsim_state_variable_e state);

	#define GSMSIM_STATE_COUNT(array) (sizeof(array)/sizeof(array[0]))

	/**

	 * This function checks the valid states.

	 */

	bool verify_states(

		const eap_type_gsmsim_state_variable_e * const valid_states,

		const u32_t count) const;

#if !defined(NO_EAP_TYPE_GSMSIM_MESSAGE_STATE_CHECK)

	/**

	 * This function checks the received GSMSIM subtype is valid in current state.

	 * This is used for quick check.

	 */

	EAP_FUNC_IMPORT eap_status_e check_valid_state(gsmsim_subtype_e type);

	/**

	 * This function returns the eap_type_gsmsim_state_variable_parameters_c object of current state.

	 */

	EAP_FUNC_IMPORT const eap_type_gsmsim_state_variable_parameters_c * get_state_variable();

#endif //#if !defined(NO_EAP_TYPE_GSMSIM_MESSAGE_STATE_CHECK)

	/**

	 * This function saves the current m_state to m_saved_previous_state.

	 * The saved state is restored in error case.

	 */

	EAP_FUNC_IMPORT void save_current_state();

	/**

	 * This function restores the saved state.

	 */

	EAP_FUNC_IMPORT void restore_saved_previous_state();

	/**

	 * This function stores identity.

	 */

	EAP_FUNC_IMPORT eap_status_e store_identity(

		const eap_variable_data_c * const IMSI_or_pseudonym,

		const bool IMSI_is_used);

#if !defined(NO_EAP_TYPE_GSMSIM_MESSAGE_STATE_CHECK)

	/**

	 * This function initializes the allowed messages within one specific state.

	 */

	EAP_FUNC_IMPORT void initialize_state(

		const eap_type_gsmsim_state_variable_e state,

		const bool must_be_initiator,

		const bool must_be_responder,

		const gsmsim_subtype_e type0,

		const gsmsim_subtype_e type1,

		const gsmsim_subtype_e type2,

		const gsmsim_subtype_e type3);

#endif //#if !defined(NO_EAP_TYPE_GSMSIM_MESSAGE_STATE_CHECK)

	/**

	 * This function expands key and seed data to key_length of expansion.

	 *  expansion_0 = prf(key, seed | 0)

	 *  expansion_i = prf(key, expansion_i-1 | seed | i), where i = 1, 2...

	 */

	EAP_FUNC_IMPORT eap_status_e data_exp(

		const u32_t key_length,

		eap_variable_data_c * const expansion,

		const eap_variable_data_c * const key,

		const eap_variable_data_c * const seed);

	/**

	 * This function generates K_encr, K_aut and master_session_key.

	 */

	EAP_FUNC_IMPORT eap_status_e generate_shared_secred_keys(

		const u32_t key_length,

		const eap_variable_data_c * const n_Kc,

		const eap_variable_data_c * const n_sres,

		eap_variable_data_c * const XKEY,

		eap_variable_data_c * const K_encr,

		eap_variable_data_c * const K_aut,

		eap_variable_data_c * const master_session_key);

	/**

	 * This function generates K_encr, K_aut and master_session_key.

	 */

	EAP_FUNC_IMPORT eap_status_e generate_reauth_shared_secred_keys(

		const u32_t key_length,

		const eap_variable_data_c * const orig_XKEY,

		const u32_t reauth_counter,

		const eap_variable_data_c * const reauth_identity,

		const eap_variable_data_c * const reauth_nonce_s,

		eap_variable_data_c * const master_session_key);

#if defined(USE_EAP_TYPE_SERVER_GSMSIM)

	/**

	 * This function stores pointer to the received triplet array.

	 */

	void set_triplets(eap_type_sim_triplet_array_c * const triplets);

#endif //#if defined(USE_EAP_TYPE_SERVER_GSMSIM)

	/**

	 * This function saves version list from version list payload.

	 */

	EAP_FUNC_IMPORT eap_status_e save_version(

		const u16_t * const payload_version_list,

		const u32_t version_count,

		const eap_gsmsim_version selected_version);

	/**

	 * This function generates a new NAI from domain and IMSI.

	 */

	EAP_FUNC_IMPORT eap_status_e generate_nai(

		eap_variable_data_c * const new_nai, ///< This is the new generated NAI.

		const bool use_manual_default_realm, ///< When true uses realm parameter, when false generates automatic realm.

		const eap_variable_data_c * const realm, ///< This is the domain part of the NAI.

		const eap_variable_data_c * const id_IMSI_or_pseydonym, ///< This is IMSI or pseudonym.

		const bool id_is_imsi, ///< This parameter tells whether id_IMSI_or_pseydonym is IMSI (true) or pseudonym (false).

		const eap_variable_data_c * const IMSI, ///< This parameter must be IMSI always.

		const eap_variable_data_c * const automatic_realm, ///< This could be zero pointer if this is not used.

		const u32_t length_of_mnc

		);

	/**

	 * This function adds generic attribute payload to GSMSIM message.

	 * @param gsmsim is pointer to EAP header including GSMSIM fields.

	 * @param maximum_buffer_size is the maximum length of sent packet.

	 * @param eap_header_size is length of EAP header.

	 * See also gsmsim_header_c and eap_header_base_c.

	 * @param data_offset is the offset of inserted payloads in GSMSIM EAP packet.

	 * It is the value of GSMSIM sub-type data.

	 * @param data_free is the remaining free GSMSIM data buffer size.

	 * @param buffer_free is the remaining free packet buffer size.

	 * @param buffer_offset is the offset from the begin of the packet buffer

	 * to the end of the last data payload.

	 * @param data_payload is the new payload to be added.

	 * @param data_payload_type is the attribute payload type to be added.

	 *

	 * See also eap_type_gsmsim_c::update_payload_indexes().

	 *

	 * Format of the payload is as follows:

	 * @code

	 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

	 * | AT type       | Payload Length|       Reserved                |

	 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

	 * | Any variable length payload                                   |

	 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

	 * @endcode

	 */

	EAP_FUNC_IMPORT eap_status_e add_variable_payload(

		gsmsim_header_c * const gsmsim,

		const u32_t maximum_buffer_size,

		const u32_t eap_header_size,

		u32_t * const data_offset,

		u32_t * const data_free,

		u32_t * const buffer_free,

		u32_t * const buffer_offset,

		const eap_variable_data_c * const data_payload,

		const gsmsim_payload_AT_type_e data_payload_type);

	/**

	 * This function adds IMSI or pseudonym attribute payload to GSMSIM message.

	 * @param gsmsim is pointer to EAP header including GSMSIM fields.

	 * @param maximum_buffer_size is the maximum length of sent packet.

	 * @param eap_header_size is length of EAP header.

	 * See also gsmsim_header_c and eap_header_base_c.

	 * @param data_offset is the offset of inserted payloads in GSMSIM EAP packet.

	 * It is the value of GSMSIM sub-type data.

	 * @param data_free is the remaining free GSMSIM data buffer size.

	 * @param buffer_free is the remaining free packet buffer size.

	 * @param buffer_offset is the offset from the begin of the packet buffer

	 * to the end of the last data payload.

	 * @param pseudonym_or_imsi is the IMSI or pseudonym payload to be added.

	 * @param data_payload_type is the attribute payload type to be added.

	 *

	 * See also eap_type_gsmsim_c::update_payload_indexes().

	 *

	 * Format of the payload is as follows: