/*

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

	#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_type_gsmsim_header.h"

#include "eap_am_type_gsmsim.h"

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

/** @file */

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

// 

EAP_FUNC_EXPORT eap_status_e eap_type_gsmsim_c::generate_nai(

	eap_variable_data_c * const new_nai,

	const bool use_manual_default_realm,

	const eap_variable_data_c * const nai_realm,

	const eap_variable_data_c * const id_IMSI_or_pseudonym,

	const bool id_is_imsi,

	const eap_variable_data_c * const IMSI,

	const eap_variable_data_c * const automatic_realm,

	const u32_t length_of_mnc)

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

	if (id_IMSI_or_pseudonym == 0

		|| id_IMSI_or_pseudonym->get_is_valid_data() == false)

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, eap_status_process_general_error);

	}

	eap_status_e status = eap_status_not_supported;

	status = new_nai->init(id_IMSI_or_pseudonym->get_data_length()+1u);

	if (status != eap_status_ok)

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, status);

	}

	new_nai->set_is_valid();

	eap_variable_data_c local_username(m_am_tools);

	status = local_username.set_buffer_length(id_IMSI_or_pseudonym->get_data_length());

	if (status != eap_status_ok)

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, status);

	}

	local_username.set_data_length(id_IMSI_or_pseudonym->get_data_length());

	m_am_tools->memmove(

		local_username.get_data(id_IMSI_or_pseudonym->get_data_length()),

		id_IMSI_or_pseudonym->get_data(),

		id_IMSI_or_pseudonym->get_data_length());

	new_nai->set_data_length(0u);

	if (id_is_imsi == true)

	{

		// Note the first octet is reserved for IMSI prefix.

		status = new_nai->add_data(GSMSIM_IMSI_PREFIX_CHARACTER, 1u);

		if (status != eap_status_ok)

		{

			EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

			return EAP_STATUS_RETURN(m_am_tools, status);

		}

	}

	// This could be IMSI or pseudonym.

	status = new_nai->add_data(&local_username);

	if (status != eap_status_ok)

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, status);

	}

	if (use_manual_default_realm == true

		&& nai_realm != 0

		&& nai_realm->get_is_valid_data() == true)

	{

		if (nai_realm->get_data_length() > 0ul)

		{

			status = new_nai->add_data(GSMSIM_AT_CHARACTER, 1u);

			if (status != eap_status_ok)

			{

				EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

				return EAP_STATUS_RETURN(m_am_tools, status);

			}

		}

		status = new_nai->add_data(nai_realm);

		if (status != eap_status_ok)

		{

			EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

			return EAP_STATUS_RETURN(m_am_tools, status);

		}

	}

	else if (IMSI != 0

		&& IMSI->get_is_valid_data() == true

		&& IMSI->get_data_length() >= EAP_TYPE_GSMSIM_MINIMUM_IMSI_LENGTH)

	{

		status = new_nai->add_data(GSMSIM_AT_CHARACTER, 1u);

		if (status != eap_status_ok)

		{

			EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

			return EAP_STATUS_RETURN(m_am_tools, status);

		}

		if (automatic_realm != 0

			&& automatic_realm->get_is_valid_data() == true)

		{

			// We must use automatic realm.

			status = new_nai->add_data(automatic_realm);

			if (status != eap_status_ok)

			{

				EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

				return EAP_STATUS_RETURN(m_am_tools, status);

			}

		}

		else

		{

			// We must use automatic realm (Example: "wlan.mnc456.mcc123.3gppnetwork.org").

			status = new_nai->add_data(GSMSIM_OWLAN_ORG_PREFIX_STRING, GSMSIM_OWLAN_ORG_PREFIX_STRING_LENGTH);

			if (status != eap_status_ok)

			{

				EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

				return EAP_STATUS_RETURN(m_am_tools, status);

			}

			status = new_nai->add_data(GSMSIM_OWLAN_DOT_STRING, GSMSIM_OWLAN_DOT_STRING_LENGTH);

			if (status != eap_status_ok)

			{

				EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

				return EAP_STATUS_RETURN(m_am_tools, status);

			}

			status = new_nai->add_data(GSMSIM_OWLAN_MNC_STRING, GSMSIM_OWLAN_MNC_STRING_LENGTH);

			if (status != eap_status_ok)

			{

				EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

				return EAP_STATUS_RETURN(m_am_tools, status);

			}

			// MNC part.

			if (length_of_mnc == EAP_TYPE_GSMSIM_MNC_LENGTH_2_BYTES)

			{

				// Add zero digit.

				u8_t zero = '0';

				status = new_nai->add_data(&zero, sizeof(zero));

				if (status != eap_status_ok)

				{

					EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

					return EAP_STATUS_RETURN(m_am_tools, status);

				}

			}

			status = new_nai->add_data(IMSI->get_data_offset(EAP_TYPE_GSMSIM_MNC_OFFSET, length_of_mnc), length_of_mnc);

			if (status != eap_status_ok)

			{

				EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

				return EAP_STATUS_RETURN(m_am_tools, status);

			}

			status = new_nai->add_data(GSMSIM_OWLAN_DOT_STRING, GSMSIM_OWLAN_DOT_STRING_LENGTH);

			if (status != eap_status_ok)

			{

				EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

				return EAP_STATUS_RETURN(m_am_tools, status);

			}

			status = new_nai->add_data(GSMSIM_OWLAN_MCC_STRING, GSMSIM_OWLAN_MCC_STRING_LENGTH);

			if (status != eap_status_ok)

			{

				EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

				return EAP_STATUS_RETURN(m_am_tools, status);

			}

			// MCC part is in index 0 and it is 3 bytes long.

			status = new_nai->add_data(IMSI->get_data_offset(EAP_TYPE_GSMSIM_MCC_OFFSET, EAP_TYPE_GSMSIM_MCC_LENGTH), EAP_TYPE_GSMSIM_MCC_LENGTH);

			if (status != eap_status_ok)

			{

				EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

				return EAP_STATUS_RETURN(m_am_tools, status);

			}

			status = new_nai->add_data(GSMSIM_OWLAN_DOT_STRING, GSMSIM_OWLAN_DOT_STRING_LENGTH);

			if (status != eap_status_ok)

			{

				EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

				return EAP_STATUS_RETURN(m_am_tools, status);

			}

			status = new_nai->add_data(GSMSIM_OWLAN_ORG_STRING, GSMSIM_OWLAN_ORG_STRING_LENGTH);

			if (status != eap_status_ok)

			{

				EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

				return EAP_STATUS_RETURN(m_am_tools, status);

			}

		}

	}

	EAP_TRACE_DATA_DEBUG(m_am_tools, TRACE_FLAGS_DEFAULT, (EAPL("new_nai"),

		new_nai->get_data(),

		new_nai->get_data_length()));

	if (new_nai->get_data_length() < sizeof(u8_t))

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, eap_status_illegal_nai);

	}

	EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

	return EAP_STATUS_RETURN(m_am_tools, eap_status_ok);

}

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

//

EAP_FUNC_EXPORT eap_status_e eap_type_gsmsim_c::query_SIM_IMSI_or_pseudonym_or_reauthentication_id(

	eap_variable_data_c * const IMSI,

	eap_variable_data_c * const pseudonym_identity,

	eap_variable_data_c * const reauthentication_identity,

	eap_variable_data_c * const automatic_realm, ///< If this is not used, do not add any data to this parameter.

	u32_t * const length_of_mnc,

	const bool must_be_synchronous,

	const gsmsim_payload_AT_type_e required_identity,

	const eap_type_gsmsim_complete_e required_completion,

	const u8_t received_eap_identifier)

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

	EAP_ASSERT(m_am_tools->get_global_mutex()->get_is_reserved() == true);

	eap_status_e status = eap_status_process_general_error;

	save_current_state();

	set_state(eap_type_gsmsim_state_pending_identity_query);

	status = m_am_type_gsmsim->query_SIM_IMSI_or_pseudonym_or_reauthentication_id(

		must_be_synchronous,

		IMSI,

		pseudonym_identity,

		reauthentication_identity,

		automatic_realm,

		length_of_mnc,

		required_identity,

		required_completion,

		received_eap_identifier);

	if (status == eap_status_pending_request)

	{

		// This is pending query, that will be completed by complete_SIM_IMSI_or_pseudonym_or_reauthentication_id_query() call.

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, status);

	}

	else if (status == eap_status_completed_request)

	{

		// This is already completed by complete_SIM_IMSI_or_pseudonym_or_reauthentication_id_query() call.

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, status);

	}

	else if (status != eap_status_ok

		&& status != eap_status_success)

	{

		// This is an error case.

		restore_saved_previous_state();

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, status);

	}

	else if (status == eap_status_ok)

	{

		if (m_use_pseudonym_identity == false)

		{

			// We do not want use pseudonym identity.

			pseudonym_identity->reset();

		}

		if (m_use_reauthentication_identity == false)

		{

			// We do not want use re-authentication identity.

			reauthentication_identity->reset();

		}

	}

	EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

	return EAP_STATUS_RETURN(m_am_tools, status);

}

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

//

EAP_FUNC_EXPORT eap_status_e eap_type_gsmsim_c::check_rands(

	const eap_variable_data_c * const n_rands

	)

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

	EAP_ASSERT(m_am_tools->get_global_mutex()->get_is_reserved() == true);

	if ((n_rands->get_data_length() % SIM_RAND_LENGTH) != 0)

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, eap_status_illegal_data_payload);

	}

	const u32_t rand_count = n_rands->get_data_length() / SIM_RAND_LENGTH;

	if (rand_count < m_minimum_rand_count)

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, eap_status_not_enough_challenges);

	}

	u32_t ind = 0ul;

	for (ind = 0ul; ind+1ul < rand_count; ind++)

	{

		const u8_t * const rand_a = n_rands->get_data_offset(ind*SIM_RAND_LENGTH, SIM_RAND_LENGTH);

		for (u32_t b_ind = ind+1ul; b_ind < rand_count; b_ind++)

		{

			const u8_t * const rand_b = n_rands->get_data_offset(b_ind*SIM_RAND_LENGTH, SIM_RAND_LENGTH);

			if (rand_a == 0

				|| rand_b == 0

				|| m_am_tools->memcmp(rand_a, rand_b, SIM_RAND_LENGTH) == 0)

			{

				// ERROR: Two equal RANDs.

				EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

				return EAP_STATUS_RETURN(m_am_tools, eap_status_illegal_data_payload);

			}

		}

	}

	if (m_do_rand_uniqueness_check == true)

	{

		eap_status_e status = m_am_type_gsmsim->check_is_rand_unused(n_rands);

		if (status != eap_status_ok)

		{

			// ERROR: RAND is used already.

			EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

			return EAP_STATUS_RETURN(m_am_tools, eap_status_not_fresh_challenges);

		}

	}

	EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

	return EAP_STATUS_RETURN(m_am_tools, eap_status_ok);

}

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

//

EAP_FUNC_EXPORT eap_status_e eap_type_gsmsim_c::query_SIM_kc_sres(

	const eap_variable_data_c * const n_rands,

	eap_variable_data_c * const n_kc,

	eap_variable_data_c * const n_sres

	)

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

	EAP_ASSERT(m_am_tools->get_global_mutex()->get_is_reserved() == true);

	eap_status_e status = eap_status_process_general_error;

	status = check_rands(n_rands);

	if (status != eap_status_ok)

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, status);

	}

	status = m_n_rands.set_copy_of_buffer(n_rands);

	if (status != eap_status_ok)

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, status);

	}

   set_state(eap_type_gsmsim_state_pending_kc_sres_query);

	status = m_am_type_gsmsim->query_SIM_kc_sres(

		false,

		n_rands,

		n_kc,

		n_sres);

	if (status == eap_status_pending_request)

	{

		// This is pending query, that will be completed by complete_SIM_kc_sres() call.

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, status);

	}

	else if (status == eap_status_completed_request)

	{

		// This is already completed by complete_SIM_kc_sres() call.

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, status);

	}

	else if (status != eap_status_ok

		&& status != eap_status_success)

	{

		// This is a error case.

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, status);

	}

	EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

	return EAP_STATUS_RETURN(m_am_tools, status);

}

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

u32_t eap_type_gsmsim_c::get_mnc_length(const u32_t mcc)

{

	u32_t * const mcc_array = reinterpret_cast<u32_t *>(m_2_digit_mnc_map_of_mcc_of_imsi_array.get_data(

		m_2_digit_mnc_map_of_mcc_of_imsi_array.get_data_length()));

	u32_t count = m_2_digit_mnc_map_of_mcc_of_imsi_array.get_data_length() / sizeof(u32_t);

	for (u32_t ind = 0ul; ind < count; ind++)

	{

		if (mcc == mcc_array[ind])

		{

			return EAP_TYPE_GSMSIM_MNC_LENGTH_2_BYTES;

		}

	}

	return EAP_TYPE_GSMSIM_DEFAULT_MNC_LENGTH_3_BYTES;

}

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

eap_status_e eap_type_gsmsim_c::create_uma_realm(

	eap_variable_data_c * const automatic_realm,

	const eap_variable_data_c * const IMSI,

	const u32_t length_of_mnc)

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

	eap_status_e status(eap_status_ok);

	// Create special automatic realm for UMA.

	automatic_realm->reset();

	if (m_use_uma_profile == true)

	{

		// Create special automatic realm for UMA.

		automatic_realm->reset();

		if (m_uma_automatic_realm_prefix.get_is_valid_data() == true)

		{

			status = automatic_realm->add_data(&m_uma_automatic_realm_prefix);

		}

		if (status != eap_status_ok)

		{

			EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

			return EAP_STATUS_RETURN(m_am_tools, status);

		}

		if (automatic_realm->get_data_length() > 0ul)

		{

			status = automatic_realm->add_data(GSMSIM_OWLAN_DOT_STRING, GSMSIM_OWLAN_DOT_STRING_LENGTH);

			if (status != eap_status_ok)

			{

				EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

				return EAP_STATUS_RETURN(m_am_tools, status);

			}

		}

		status = automatic_realm->add_data(GSMSIM_OWLAN_MNC_STRING, GSMSIM_OWLAN_MNC_STRING_LENGTH);

		if (status != eap_status_ok)

		{

			EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

			return EAP_STATUS_RETURN(m_am_tools, status);

		}

		// MNC part.

		if (length_of_mnc == EAP_TYPE_GSMSIM_MNC_LENGTH_2_BYTES)

		{

			// Add zero digit.

			u8_t zero = '0';

			status = automatic_realm->add_data(&zero, sizeof(zero));

			if (status != eap_status_ok)

			{

				EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);