/*

* 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.

*

*/

// This is enumeration of EAPOL source code.

#if defined(USE_EAP_MINIMUM_RELEASE_TRACES)

	#undef EAP_FILE_NUMBER_ENUM

	#define EAP_FILE_NUMBER_ENUM 77 

	#undef EAP_FILE_NUMBER_DATE 

	#define EAP_FILE_NUMBER_DATE 1127594498 

#endif //#if defined(USE_EAP_MINIMUM_RELEASE_TRACES)

#include "eap_am_memory.h"

#include "eap_tools.h"

#include "eap_type_gsmsim.h"

#include "eap_type_gsmsim_header.h"

#include "eap_type_gsmsim_payloads.h"

#include "eap_type_gsmsim_mac_attributes.h"

#include "abs_eap_am_type_gsmsim.h"

#include "eap_crypto_api.h"

#include "eap_state_notification.h"

#include "abs_eap_am_mutex.h"

#include "eap_automatic_variable.h"

#include "eap_am_type_gsmsim.h"

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

/** @file */

// 

EAP_FUNC_EXPORT eap_type_gsmsim_c::~eap_type_gsmsim_c()

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

	EAP_TRACE_DEBUG(

		m_am_tools, 

		TRACE_FLAGS_DEFAULT, 

		(EAPL("eap_type_gsmsim_c::~eap_type_gsmsim_c(): this = 0x%08x => 0x%08x\n"),

		this,

		dynamic_cast<abs_eap_base_timer_c *>(this)));

	EAP_ASSERT(m_shutdown_was_called == true);

	if (m_free_am_type_gsmsim == true

		&& m_am_type_gsmsim != 0)

	{

		delete m_am_type_gsmsim;

	}

	EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

}

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

#if defined(_WIN32) && !defined(__GNUC__)

	#pragma warning( disable : 4355 ) // 'this' : used in base member initializer list

#endif

// 

EAP_FUNC_EXPORT eap_type_gsmsim_c::eap_type_gsmsim_c(

	abs_eap_am_tools_c * const tools,

	abs_eap_base_type_c * const partner,

	eap_am_type_gsmsim_c * const am_type_gsmsim,

	const bool free_am_type_gsmsim,

	const bool is_client_when_true,

	const eap_am_network_id_c * const receive_network_id)

	: eap_base_type_c(tools, partner)

	, m_am_tools(tools)

	, m_state(eap_type_gsmsim_state_none)

	, m_saved_previous_state(eap_type_gsmsim_state_none)

	, m_send_network_id(m_am_tools)

	, m_nonce_mt(m_am_tools)

	, m_nonce_s(m_am_tools)

	, m_IV(m_am_tools)

	, m_saved_EAP_packet(m_am_tools)

	, m_XKEY(m_am_tools)

	, m_K_encr(m_am_tools)

	, m_K_aut(m_am_tools)

	, m_master_session_key(m_am_tools, eap_type_gsmsim)

	, m_IMSI(m_am_tools)

	, m_pseudonym(m_am_tools)

	, m_reauthentication_identity(m_am_tools)

	, m_automatic_realm(m_am_tools)

	, m_automatic_realm_read(false)

	, m_identity(m_am_tools)

	, m_NAI(m_am_tools)

	, m_n_rands(m_am_tools)

	, m_n_sres(m_am_tools)

	, m_gsmsim_version_list(m_am_tools)

#if defined(USE_EAP_TYPE_SERVER_GSMSIM)

	, m_triplets(0)

#endif //#if defined(USE_EAP_TYPE_SERVER_GSMSIM)

	, m_reauthentication_counter(0u)

	, m_include_identity_to_start_response(gsmsim_payload_NONE)

	, m_start_response_includes_identity(gsmsim_payload_NONE)

	, m_failure_message_received(false)

	, m_authentication_finished_successfully(false)

	, m_last_eap_identifier(0)

	, m_gsmsim_selected_version(GSMSIM_ILLEGAL_VERSION)

	, m_2_digit_mnc_map_of_mcc_of_imsi_array(tools)

	, m_uma_automatic_realm_prefix(tools)

	, m_use_uma_profile(false)

	, m_am_type_gsmsim(am_type_gsmsim)

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

	, m_nonce_mt_file(tools)

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

	, m_manual_username(tools)

	, m_manual_realm(tools)

	, m_gsmsim_header_offset(0u)

	, m_MTU(0u)

	, m_trailer_length(0u)

	, m_minimum_rand_count(EAP_TYPE_GSMSIM_DEFAULT_MINIMUM_RAND_COUNT)

	, m_length_of_mnc(EAP_TYPE_GSMSIM_DEFAULT_MNC_LENGTH_3_BYTES)

	, m_authentication_type(GSMSIM_AUTHENTICATION_TYPE_NONE)

	, m_identity_type(GSMSIM_IDENTITY_TYPE_NONE)

	, m_client_error_code(eap_gsmsim_client_error_code_none)

	, m_gsmsim_notification_code(eap_gsmsim_notification_none)

	, m_failure_message_delay_time(EAP_TYPE_GSMSIM_TIMER_TIMEOUT_VALUE_DELAY_FAILURE_MESSAGE_SENT)

	, m_is_valid(false)

	, m_is_client(is_client_when_true)

	, m_wait_eap_success_packet(true)

	, m_check_identifier_of_eap_identity_response(false)

	, m_free_am_type_gsmsim(free_am_type_gsmsim)

#if defined(USE_EAP_TYPE_GSMSIM_OWN_RE_TRANSMISSION)

	, m_client_responds_retransmitted_packets(false)

#endif //#if defined(USE_EAP_TYPE_GSMSIM_OWN_RE_TRANSMISSION)

	, m_gsmsim_test_version(false)

	, m_gsmsim_randomly_refuse_eap_identity(false)

	, m_check_nai_realm(false)

	, m_fail_reauthentication_counter_check(false)

	, m_accept_eap_identity_response(true)

	, m_use_random_identity_on_eap_identity_response(false)

	, m_shutdown_was_called(false)

	, m_reset_was_called(false)

	, m_do_rand_uniqueness_check(true)

	, m_use_pseudonym_identity(true)

	, m_use_reauthentication_identity(true)

	, m_erroneus_packet_received(false)

	, m_sim_notification_packet_received(false)

	, m_use_manual_username(false)

	, m_use_manual_realm(false)

	, m_randomly_fail_successfull_authentication(false)

	, m_allow_use_result_indication(true)

	, m_use_result_indication(false)

	, m_use_eap_expanded_type(false)

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

	EAP_TRACE_DEBUG(

		m_am_tools, 

		TRACE_FLAGS_DEFAULT, 

		(EAPL("eap_type_gsmsim_c::eap_type_gsmsim_c(): this = 0x%08x => 0x%08x, ")

		 EAPL("partner 0x%08x, type partner 0x%08x, compiled %s %s\n"),

		 this,

		 dynamic_cast<abs_eap_base_timer_c *>(this),

		 partner,

		 get_type_partner(),

		__DATE__,

		__TIME__));

	// This is the only supported version.

	m_supported_versions[0] = GSMSIM_VERSION_1;

	if (m_am_type_gsmsim == 0)

	{

		// Something wrong with AM.

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return;

	}

	m_am_type_gsmsim->set_am_partner(this);

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

#if !defined(NO_EAP_TYPE_GSMSIM_MESSAGE_STATE_CHECK)

	initialize_state(eap_type_gsmsim_state_pending_kc_sres_query, false, false,

		gsmsim_subtype_Notification,

		gsmsim_subtype_Challenge, // Re-transmitted EAP-Request/SIM/Challenge is allowed.

		gsmsim_subtype_NONE,

		gsmsim_subtype_NONE);

	initialize_state(eap_type_gsmsim_state_pending_triplet_query, false, false,

		gsmsim_subtype_Notification,

		gsmsim_subtype_Start, // Note EAP-Response/SIM/Start message is allowed here, eap_type_gsmsim_c::handle_start_response_message() will drop EAP-Response/SIM/Start message quietly.

		gsmsim_subtype_Client_Error,

		gsmsim_subtype_Challenge); // Re-transmitted EAP-Response/SIM/Challenge is allowed.

	initialize_state(eap_type_gsmsim_state_waiting_for_start_request, false, false,

		gsmsim_subtype_Notification,

		gsmsim_subtype_Start,

		gsmsim_subtype_NONE,

		gsmsim_subtype_NONE);

	initialize_state(eap_type_gsmsim_state_pseydonym_waiting_for_start_request, false, false,

		gsmsim_subtype_Notification,

		gsmsim_subtype_Start,

		gsmsim_subtype_Re_authentication,

		gsmsim_subtype_NONE);

	initialize_state(eap_type_gsmsim_state_imsi_waiting_for_start_request, false, false,

		gsmsim_subtype_Notification,

		gsmsim_subtype_Start,

		gsmsim_subtype_NONE,

		gsmsim_subtype_NONE);

	initialize_state(eap_type_gsmsim_state_waiting_for_start_response, true, false,

		gsmsim_subtype_Notification,

		gsmsim_subtype_Start,

		gsmsim_subtype_Client_Error,

		gsmsim_subtype_NONE);

	initialize_state(eap_type_gsmsim_state_waiting_for_notification_request_success, false, true,

		gsmsim_subtype_Notification,

		gsmsim_subtype_Challenge,

		gsmsim_subtype_Re_authentication,

		gsmsim_subtype_NONE);

	initialize_state(eap_type_gsmsim_state_waiting_for_notification_response_failure, true, false,

		gsmsim_subtype_Notification,

		gsmsim_subtype_NONE,

		gsmsim_subtype_NONE,

		gsmsim_subtype_NONE);

	initialize_state(eap_type_gsmsim_state_waiting_for_notification_response_success, true, false,

		gsmsim_subtype_Notification,

		gsmsim_subtype_NONE,

		gsmsim_subtype_NONE,

		gsmsim_subtype_NONE);

	initialize_state(eap_type_gsmsim_state_waiting_for_start_response_with_at_permanent_identity, true, false,

		gsmsim_subtype_Notification,

		gsmsim_subtype_Start,

		gsmsim_subtype_Client_Error,

		gsmsim_subtype_NONE);

	initialize_state(eap_type_gsmsim_state_waiting_for_start_response_with_at_full_auth_identity, true, false,

		gsmsim_subtype_Notification,

		gsmsim_subtype_Start,

		gsmsim_subtype_Client_Error,

		gsmsim_subtype_NONE);

	initialize_state(eap_type_gsmsim_state_waiting_for_start_response_with_at_any_identity, true, false,

		gsmsim_subtype_Notification,

		gsmsim_subtype_Start,

		gsmsim_subtype_Client_Error,

		gsmsim_subtype_NONE);

	initialize_state(eap_type_gsmsim_state_analyse_start_request, false, false,

		gsmsim_subtype_Notification,

		gsmsim_subtype_NONE,

		gsmsim_subtype_NONE,

		gsmsim_subtype_NONE);

	initialize_state(eap_type_gsmsim_state_waiting_for_challenge_request, false, false,

		gsmsim_subtype_Notification,

		gsmsim_subtype_Challenge,

		gsmsim_subtype_Start,

		gsmsim_subtype_NONE);

	initialize_state(eap_type_gsmsim_state_waiting_for_challenge_response, false, false,

		gsmsim_subtype_Notification,

		gsmsim_subtype_Challenge,

		gsmsim_subtype_Start,

		gsmsim_subtype_Client_Error);

	initialize_state(eap_type_gsmsim_state_waiting_for_reauth_request, false, false,

		gsmsim_subtype_Notification,

		gsmsim_subtype_Re_authentication,

		gsmsim_subtype_Start,

		gsmsim_subtype_NONE);

	initialize_state(eap_type_gsmsim_state_waiting_for_reauth_response, false, false,

		gsmsim_subtype_Notification,

		gsmsim_subtype_Re_authentication,

		gsmsim_subtype_Start,

		gsmsim_subtype_Client_Error);

	initialize_state(eap_type_gsmsim_state_success, false, false,

		gsmsim_subtype_Notification,

		gsmsim_subtype_Challenge,

		gsmsim_subtype_NONE,

		gsmsim_subtype_NONE);

	initialize_state(eap_type_gsmsim_state_waiting_for_success, false, false,

		gsmsim_subtype_Notification,

		gsmsim_subtype_Challenge,

		gsmsim_subtype_Re_authentication,

		gsmsim_subtype_NONE);

	initialize_state(eap_type_gsmsim_state_failure, false, false,

		gsmsim_subtype_NONE,

		gsmsim_subtype_NONE,

		gsmsim_subtype_NONE,

		gsmsim_subtype_NONE);

#endif //#if !defined(NO_EAP_TYPE_GSMSIM_MESSAGE_STATE_CHECK)

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

	{

		// Here we swap the addresses.

		eap_am_network_id_c send_network_id(m_am_tools,

			receive_network_id->get_destination_id(),

			receive_network_id->get_source_id(),

			receive_network_id->get_type());

		eap_status_e status = m_send_network_id.set_copy_of_network_id(&send_network_id);

		if (status != eap_status_ok

			|| m_send_network_id.get_is_valid_data() == false)

		{

			(void)EAP_STATUS_RETURN(m_am_tools, eap_status_allocation_error);

			return;

		}

	}

	set_is_valid();

	EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

}

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

#if !defined(NO_EAP_TYPE_GSMSIM_MESSAGE_STATE_CHECK)

//

void eap_type_gsmsim_c::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)

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

	m_parameters[(state)].init_state(must_be_initiator, must_be_responder,

		type0, type1, type2, type3);

	EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

}

#endif //#if !defined(NO_EAP_TYPE_GSMSIM_MESSAGE_STATE_CHECK)

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

/**

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

 * used as a IV of next block.

 */

eap_status_e eap_type_gsmsim_c::store_last_encryption_iv(const eap_variable_data_c * const encryption_IV)

{

	return m_IV.get_payload_buffer()->set_copy_of_buffer(encryption_IV);

}

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

EAP_FUNC_EXPORT eap_gsmsim_version eap_type_gsmsim_c::select_version(

	const gsmsim_variable_data_c * const version_payload,

	bool * const includes_other_version_than_1)

{

	u32_t version_payload_length = version_payload->get_original_header()->get_data_length();

	u32_t real_payload_length = version_payload->get_original_header()->get_reserved();

	eap_gsmsim_version selected_version = GSMSIM_ILLEGAL_VERSION;

	if (real_payload_length == 0

		|| real_payload_length > version_payload_length)

	{

		return GSMSIM_ILLEGAL_VERSION;

	}

	u32_t version_count = real_payload_length/sizeof(u16_t);

	u16_t *payload_version_list = reinterpret_cast<u16_t *>(version_payload->get_original_header()->get_data(real_payload_length));

	for (u32_t ind = 0u; ind < version_count; ind++)

	{

		u8_t * const payload_version_network_order = reinterpret_cast<u8_t *>(&(payload_version_list[ind]));

		u16_t payload_version_host_order

			= eap_read_u16_t_network_order(payload_version_network_order, sizeof(u16_t));

		if (payload_version_host_order == static_cast<u16_t>(GSMSIM_VERSION_1))

		{

			selected_version = static_cast<eap_gsmsim_version>(payload_version_host_order);

		}

		else if (payload_version_host_order != static_cast<u16_t>(GSMSIM_VERSION_1))

		{

			*includes_other_version_than_1 = true;

		}

	}

	return selected_version;

}

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

EAP_FUNC_EXPORT eap_const_string eap_type_gsmsim_c::get_identity_string(const eap_type_gsmsim_identity_type identity_type)

{

#if defined(USE_EAP_TRACE_STRINGS)

	EAP_IF_RETURN_STRING(identity_type, GSMSIM_IDENTITY_TYPE_NONE)

	else EAP_IF_RETURN_STRING(identity_type, GSMSIM_IDENTITY_TYPE_IMSI_ID)

	else EAP_IF_RETURN_STRING(identity_type, GSMSIM_IDENTITY_TYPE_PSEUDONYM_ID)

	else EAP_IF_RETURN_STRING(identity_type, GSMSIM_IDENTITY_TYPE_RE_AUTH_ID)

	else

#endif // #if defined(USE_EAP_TRACE_STRINGS)

	{

		EAP_UNREFERENCED_PARAMETER(identity_type);

		return EAPL("Unknown AKA identity");

	}

}

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

EAP_FUNC_EXPORT eap_const_string eap_type_gsmsim_c::get_state_string(eap_type_gsmsim_state_variable_e state)

{

#if defined(USE_EAP_TRACE_STRINGS)

	EAP_IF_RETURN_STRING(state, eap_type_gsmsim_state_waiting_for_identity_request)

	else EAP_IF_RETURN_STRING(state, eap_type_gsmsim_state_pending_identity_query)

	else EAP_IF_RETURN_STRING(state, eap_type_gsmsim_state_waiting_for_start_request)

	else EAP_IF_RETURN_STRING(state, eap_type_gsmsim_state_imsi_waiting_for_start_request)

	else EAP_IF_RETURN_STRING(state, eap_type_gsmsim_state_pseydonym_waiting_for_start_request)

	else EAP_IF_RETURN_STRING(state, eap_type_gsmsim_state_analyse_start_request)

	else EAP_IF_RETURN_STRING(state, eap_type_gsmsim_state_waiting_for_challenge_request)

	else EAP_IF_RETURN_STRING(state, eap_type_gsmsim_state_analyses_challenge_request)

	else EAP_IF_RETURN_STRING(state, eap_type_gsmsim_state_pending_kc_sres_query)

	else EAP_IF_RETURN_STRING(state, eap_type_gsmsim_state_waiting_for_success)

	else EAP_IF_RETURN_STRING(state, eap_type_gsmsim_state_waiting_for_reauth_request)

	else EAP_IF_RETURN_STRING(state, eap_type_gsmsim_state_analyses_reauthentication_request)

	else EAP_IF_RETURN_STRING(state, eap_type_gsmsim_state_pending_pseudonym_decode_query)

	else EAP_IF_RETURN_STRING(state, eap_type_gsmsim_state_waiting_for_identity_response)

	else EAP_IF_RETURN_STRING(state, eap_type_gsmsim_state_waiting_for_start_response_with_at_permanent_identity)

	else EAP_IF_RETURN_STRING(state, eap_type_gsmsim_state_waiting_for_start_response_with_at_full_auth_identity)

	else EAP_IF_RETURN_STRING(state, eap_type_gsmsim_state_waiting_for_start_response_with_at_any_identity)

	else EAP_IF_RETURN_STRING(state, eap_type_gsmsim_state_waiting_for_start_response)

	else EAP_IF_RETURN_STRING(state, eap_type_gsmsim_state_waiting_for_challenge_response)

	else EAP_IF_RETURN_STRING(state, eap_type_gsmsim_state_pending_triplet_query)

	else EAP_IF_RETURN_STRING(state, eap_type_gsmsim_state_analyses_challenge_response)

	else EAP_IF_RETURN_STRING(state, eap_type_gsmsim_state_analyses_start_response)

	else EAP_IF_RETURN_STRING(state, eap_type_gsmsim_state_waiting_for_notification_request_success)

	else EAP_IF_RETURN_STRING(state, eap_type_gsmsim_state_waiting_for_notification_response_failure)

	else EAP_IF_RETURN_STRING(state, eap_type_gsmsim_state_waiting_for_notification_response_success)

	else EAP_IF_RETURN_STRING(state, eap_type_gsmsim_state_waiting_for_reauth_response)

	else EAP_IF_RETURN_STRING(state, eap_type_gsmsim_state_analyses_reauthentication_response)

	else EAP_IF_RETURN_STRING(state, eap_type_gsmsim_state_success)

	else EAP_IF_RETURN_STRING(state, eap_type_gsmsim_state_failure)

	else

#else

EAP_UNREFERENCED_PARAMETER(state);

#endif // #if defined(USE_EAP_TRACE_STRINGS)

	{

		return EAPL("Unknown GSMSIM state");

	}

}

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

EAP_FUNC_EXPORT eap_const_string eap_type_gsmsim_c::get_state_string() const

{

	return get_state_string(m_state);

}

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

EAP_FUNC_EXPORT eap_const_string eap_type_gsmsim_c::get_saved_previous_state_string() const

{

	return get_state_string(m_saved_previous_state);

}

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

/**

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

 */

void eap_type_gsmsim_c::set_state(eap_type_gsmsim_state_variable_e state)

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

	eap_type_gsmsim_state_variable_e previous_state = m_state;

	EAP_TRACE_DEBUG(

		m_am_tools, 

		TRACE_FLAGS_DEFAULT, 

		(EAPL("eap_type_gsmsim_c::set_state(): old state %d=%s\n"),

		 m_state,

		 get_state_string()));

	EAP_TRACE_DEBUG(

		m_am_tools, 

		TRACE_FLAGS_DEFAULT, 

		(EAPL("eap_type_gsmsim_c::set_state(): new state %d=%s\n"),

		 state,

		 get_state_string(state)));

	m_state = state;

	eap_type_gsmsim_state_notification_c notification(

		m_am_tools,

		&m_send_network_id,

		m_is_client,

		eap_state_notification_eap,

		eap_protocol_layer_eap_type,

		eap_type_gsmsim,

		previous_state,

		state,

		m_last_eap_identifier,

		false);

	state_notification(&notification);

	EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

}