/*

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

	#undef EAP_FILE_NUMBER_DATE 

	#define EAP_FILE_NUMBER_DATE 1127594498 

#endif //#if defined(USE_EAP_MINIMUM_RELEASE_TRACES)

// INCLUDE FILES

#include "eap_am_memory.h"

#include "eap_tools.h"

#include "eap_am_type_gsmsim_symbian.h"

#include "abs_eap_am_crypto.h"

#include "abs_eap_am_mutex.h"

#include "eap_am_tools_symbian.h"

#include "eap_state_notification.h"

#include "EapSimDbDefaults.h"

#include "EapSimDbParameterNames.h"

#include "EapSimDbUtils.h"

#include "eap_am_trace_symbian.h"

#include <d32dbms.h>	// For DBMS

#include <s32strm.h> 	// For RReadStream

#if defined (USE_EAP_GSMSIM_INTERFACE) && !defined(__WINS__)

#include "EapSimInterface.h"	

#endif // End of #if defined (USE_EAP_GSMSIM_INTERFACE) && !defined(__WINS__)

const TUint SIM_IMSI_LENGTH = 15u;

const TUint KIdentityHeaderLength = 2;

const TUint KMaxSqlQueryLength = 512;

const TUint KMaxDBFieldNameLength = 255;

const TInt 	KDefaultColumnInView_One = 1; // For DB view.

const TInt 	KMicroSecsInASecond = 1000000; // 1000000 micro seconds is 1 second.

#if defined(__WINS__)

const char TEST_IMSI[] = "244070100000001";

#endif

// ================= MEMBER FUNCTIONS =======================

eap_am_type_gsmsim_symbian_c::eap_am_type_gsmsim_symbian_c(

	abs_eap_am_tools_c * const tools,

	abs_eap_base_type_c * const partner,

	const TIndexType aIndexType,

	const TInt aIndex,

	const eap_type_value_e aTunnelingType,

	const bool aIsClient,

	const eap_am_network_id_c * const receive_network_id)

: eap_am_type_gsmsim_c(tools)

, m_am_tools(static_cast<eap_am_tools_symbian_c*>(tools)) // Tools class must be of type eap_am_tools_symbian because

														  // this is Symbian specific code.

, m_partner(partner)

, m_triplet_file(tools)

, m_nai_realm(tools)

, m_index_type(aIndexType)

, m_index(aIndex)

, m_tunneling_type(aTunnelingType)

, m_is_valid(false)

, m_is_client(aIsClient)

, m_stored_reauth_id(tools)

, m_stored_pseudonym(tools)

, m_previous_imsi(tools)

, m_stored_required_completion(eap_type_gsmsim_complete_none)

, m_stored_received_eap_identifier(0)

, m_shutdown_was_called(false)

#if !defined (USE_EAP_GSMSIM_INTERFACE)

, m_sim_algorithm(tools)

#endif // #if !defined (USE_EAP_GSMSIM_INTERFACE)

, m_simulator_sim_algorithm(sim_algorithm_nokia_test_network_xor)

, m_simulator_sim_ki(tools)

, m_copy_of_n_rands(tools)

, m_n_kc(tools)

, m_n_sres(tools)

, m_uma_automatic_realm_prefix(tools)

, m_receive_network_id(tools)

, m_rands_handled(0)

, m_do_rand_uniqueness_check(true)

, m_max_session_time(0)

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

#ifdef USE_EAP_EXPANDED_TYPES

	m_tunneling_vendor_type = m_tunneling_type.get_vendor_type();

#else

	m_tunneling_vendor_type = static_cast<TUint>(m_tunneling_type);

#endif //#ifdef USE_EAP_EXPANDED_TYPES

	if (receive_network_id != 0

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

	{

		eap_status_e status = m_receive_network_id.set_copy_of_network_id(

			receive_network_id);

		if (status != eap_status_ok)

		{

			EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

			(void)EAP_STATUS_RETURN(m_am_tools, eap_status_allocation_error);

			return;

		}

	}

	set_is_valid();

	EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

}

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

void eap_am_type_gsmsim_symbian_c::ConstructL()

{

	// Open/create database

	EapSimDbUtils::OpenDatabaseL(m_database, m_session, m_index_type, m_index, m_tunneling_type);	

	// SIM IMSI, Kc and SRES are queried from SIM using SIM interface. 

	// If this is not used then Nokia test algorithms and test IMSI is used.

#if defined (USE_EAP_GSMSIM_INTERFACE)	&& !defined(__WINS__)

	if (m_is_client == true)

	{

		m_isa_if = CEapSimIsaInterface::NewL(m_am_tools, this);

	} 

	else

	{

		EAP_TRACE_ERROR(m_am_tools, TRACE_FLAGS_DEFAULT, (EAPL("ERROR: EAP-SIM server does not work at the moment in plugintester.\n")));

		User::Leave(KErrNotSupported);

	}

#endif //#if defined (USE_EAP_GSMSIM_INTERFACE)	&& !defined(__WINS__)

}

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

eap_am_type_gsmsim_symbian_c* eap_am_type_gsmsim_symbian_c::NewL(

	abs_eap_am_tools_c * const aTools,

	abs_eap_base_type_c * const aPartner,

	const TIndexType aIndexType,

	const TInt aIndex,

	const eap_type_value_e aTunnelingType,

	const bool aIsClient,

	const eap_am_network_id_c * const receive_network_id)

{

	eap_am_type_gsmsim_symbian_c* self = new(ELeave) eap_am_type_gsmsim_symbian_c(

		aTools, 

		aPartner, 

		aIndexType, 

		aIndex, 

		aTunnelingType,

		aIsClient,

		receive_network_id);

	CleanupStack::PushL(self);

	if (self->get_is_valid() != true)

	{

		User::Leave(KErrGeneral);

	}

	self->ConstructL();

	CleanupStack::Pop();

	return self;

}

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

EAP_FUNC_EXPORT eap_am_type_gsmsim_symbian_c::~eap_am_type_gsmsim_symbian_c()

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

	EAP_TRACE_DEBUG(

		m_am_tools, 

		TRACE_FLAGS_DEFAULT, 

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

		this));

	m_database.Close();

	m_session.Close();

#if defined(USE_EAP_GSMSIM_INTERFACE) && !defined(__WINS__)

	if (m_is_client == true)

	{

		delete m_isa_if;

	}

#endif //#if defined(USE_EAP_GSMSIM_INTERFACE) && !defined(__WINS__)

	EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

}

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

EAP_FUNC_EXPORT eap_status_e eap_am_type_gsmsim_symbian_c::store_reauth_parameters(

	const eap_variable_data_c * const XKEY,

	const eap_variable_data_c * const K_aut,

	const eap_variable_data_c * const K_encr,

	const u32_t reauth_counter)

{	

	// These kind of wrapper functions are needed because the Symbian L-functions must be executed in 

	// trap harness.

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

	// Send error if any of the parameters are invalid.

	if(XKEY == NULL 

		|| K_aut == NULL

		|| K_encr == NULL)

	{

		// Some of the parameters are invalid.

		EAP_TRACE_DEBUG(

			m_am_tools,

			TRACE_FLAGS_DEFAULT,

			(EAPL("eap_am_type_gsmsim_symbian_c::store_reauth_parameters: ")

			 EAPL("ERROR: Invalid parameters\n")));

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, eap_status_illegal_parameter);

	}

	// Send error if any of the parameters are too long.

	if(XKEY->get_data_length() > KMaxXKeyLengthInDB 

		|| K_aut->get_data_length() > KMaxK_autLengthInDB 

		|| K_encr->get_data_length() > KMaxK_encrLengthInDB )

	{

		// Some of the parameters are too long. Can't store them in DB.

		EAP_TRACE_DEBUG(

			m_am_tools,

			TRACE_FLAGS_DEFAULT,

			(EAPL("eap_am_type_gsmsim_symbian_c::store_reauth_parameters: ")

			 EAPL("Too long parameters. Length: XKEY=%d, K_aut=%d, K_encr=%d\n"),

			 XKEY->get_data_length(), K_aut->get_data_length(), K_encr->get_data_length()));

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, eap_status_illegal_parameter);

	}

	eap_status_e status(eap_status_ok);

	TRAPD(err, store_reauth_parametersL(XKEY, K_aut, K_encr, reauth_counter));

	if (err != KErrNone)

	{

		// Convert the leave error code to EAPOL stack error code.

		status = m_am_tools->convert_am_error_to_eapol_error(err);

		send_error_notification(status);

	} 	

	EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

	return EAP_STATUS_RETURN(m_am_tools, status);

}

void eap_am_type_gsmsim_symbian_c::store_reauth_parametersL(

	const eap_variable_data_c * const XKEY,

	const eap_variable_data_c * const K_aut,

	const eap_variable_data_c * const K_encr,

	const u32_t reauth_counter)

{	

	// The _L functions do the actual thing.

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

	// Form the insertion command

	HBufC* buf = HBufC::NewLC(KMaxSqlQueryLength);

	TPtr sqlStatement = buf->Des();

	_LIT(KSQLInsert, "SELECT %S, %S, %S, %S FROM %S WHERE %S=%d AND %S=%d AND %S=%d");

	sqlStatement.Format(KSQLInsert, &KXKey, &KK_aut, &KK_encr, &KReauthCounter, &KSimTableName, 

		&KServiceType, m_index_type, &KServiceIndex, m_index, &KTunnelingType, m_tunneling_vendor_type);

	// Evaluate view

	RDbView view;

	User::LeaveIfError(view.Prepare(m_database,TDbQuery(sqlStatement), TDbWindow::EUnlimited));

	CleanupClosePushL(view);

	User::LeaveIfError(view.EvaluateAll());

	// Create pointers to the data

	TPtrC8 key(XKEY->get_data(XKEY->get_data_length()), XKEY->get_data_length());

	TPtrC8 aut(K_aut->get_data(K_aut->get_data_length()), K_aut->get_data_length());

	TPtrC8 enc(K_encr->get_data(K_encr->get_data_length()), K_encr->get_data_length());

	// Update the columns in the database

	view.FirstL();	

	view.UpdateL();

	// Get column set so we get the correct column numbers

	CDbColSet* colSet = view.ColSetL();

	CleanupStack::PushL(colSet);	

	EAP_TRACE_DATA_DEBUG(

		m_am_tools,

		TRACE_FLAGS_DEFAULT,

		(EAPL("XKEY to DB"), key.Ptr(),	key.Length()));

	EAP_TRACE_DATA_DEBUG(

		m_am_tools,

		TRACE_FLAGS_DEFAULT,

		(EAPL("K_aut to DB"), aut.Ptr(),	aut.Length()));

	EAP_TRACE_DATA_DEBUG(

		m_am_tools,

		TRACE_FLAGS_DEFAULT,

		(EAPL("K_encr to DB"), enc.Ptr(),	enc.Length()));

	view.SetColL(colSet->ColNo(KXKey), key); // XKEY

	view.SetColL(colSet->ColNo(KK_aut), aut); // K_aut

	view.SetColL(colSet->ColNo(KK_encr), enc); // K_encr

	view.SetColL(colSet->ColNo(KReauthCounter), reauth_counter); // ReauthCounter

	CleanupStack::PopAndDestroy(colSet); // Delete colSet.	

	view.PutL();

	EAP_TRACE_DEBUG(

		m_am_tools,

		TRACE_FLAGS_DEFAULT,

		(EAPL("eap_am_type_gsmsim_symbian_c::store_reauth_keys_L(): %s, m_saved_reauth_counter %d.\n"),

		 (m_is_client == true ? "client": "server"),

		 reauth_counter));

	// Close database

	CleanupStack::PopAndDestroy(2); // view, buf

	EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

}

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

eap_status_e eap_am_type_gsmsim_symbian_c::authentication_finished(

	const bool true_when_successful,

	const eap_gsmsim_authentication_type_e authentication_type,

	const eap_type_gsmsim_identity_type identity_type)

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

	eap_status_e status(eap_status_ok);

	TInt err(KErrNone);	

	// Store the authentication time if the full authentication is successful

	if (true_when_successful == true

		&& authentication_type == GSMSIM_AUTHENTICATION_TYPE_FULL_AUTH)

	{

		TRAP(err,store_authentication_timeL());

		if (err != KErrNone)

		{

			status = m_am_tools->convert_am_error_to_eapol_error(err);

			send_error_notification(status);

		}

	}	

	if (true_when_successful == false)

	{

		if( identity_type == GSMSIM_IDENTITY_TYPE_IMSI_ID 

			|| identity_type == GSMSIM_IDENTITY_TYPE_PSEUDONYM_ID )

		{

			(void) store_pseudonym_id(0,0);

		}

		if( identity_type == GSMSIM_IDENTITY_TYPE_IMSI_ID 

			|| identity_type == GSMSIM_IDENTITY_TYPE_RE_AUTH_ID )

		{

			(void) store_reauthentication_id(0,0);			

		}

	}

	EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

	return EAP_STATUS_RETURN(m_am_tools, status);

}

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

EAP_FUNC_EXPORT eap_status_e eap_am_type_gsmsim_symbian_c::query_reauth_parameters(

	eap_variable_data_c * const reauth_XKEY,

	eap_variable_data_c * const reauth_K_aut,

	eap_variable_data_c * const reauth_K_encr,

	u32_t * const reauth_counter)

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);	

	eap_status_e status(eap_status_ok);

	TRAPD(err, query_reauth_parametersL(reauth_XKEY, reauth_K_aut, reauth_K_encr, reauth_counter));

	if (err != KErrNone)

	{

		status = m_am_tools->convert_am_error_to_eapol_error(err);

		send_error_notification(status);

	} 

	EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

	return EAP_STATUS_RETURN(m_am_tools, status);

}

void eap_am_type_gsmsim_symbian_c::query_reauth_parametersL(

	eap_variable_data_c * const reauth_XKEY,

	eap_variable_data_c * const reauth_K_aut,

	eap_variable_data_c * const reauth_K_encr,

	u32_t * const reauth_counter)

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

	HBufC* buf = HBufC::NewLC(KMaxSqlQueryLength);

	TPtr sqlStatement = buf->Des();

	// Form the query

	_LIT(KSQLQuery, "SELECT %S, %S, %S, %S FROM %S WHERE %S=%d AND %S=%d AND %S=%d");

	sqlStatement.Format(KSQLQuery, &KXKey, &KK_aut, &KK_encr, &KReauthCounter, &KSimTableName, 

		&KServiceType, m_index_type, &KServiceIndex, m_index, &KTunnelingType, m_tunneling_vendor_type);

	RDbView view;

	// Evaluate view

	User::LeaveIfError(view.Prepare(m_database, TDbQuery(sqlStatement)));

	CleanupClosePushL(view);

	User::LeaveIfError(view.EvaluateAll());	

	// Get the first (and only) row

	view.FirstL();

	view.GetL();

	// Get column set so we get the correct column numbers

	CDbColSet* colSet = view.ColSetL();

	CleanupStack::PushL(colSet);	

	// Get the values from DB

	TPtrC8 key = view.ColDes8(colSet->ColNo(KXKey));	

	TPtrC8 aut = view.ColDes8(colSet->ColNo(KK_aut));

	TPtrC8 enc = view.ColDes8(colSet->ColNo(KK_encr));

	EAP_TRACE_DATA_DEBUG(

		m_am_tools,

		TRACE_FLAGS_DEFAULT,

		(EAPL("XKEY from DB"), key.Ptr(),	key.Length()));

	EAP_TRACE_DATA_DEBUG(

		m_am_tools,

		TRACE_FLAGS_DEFAULT,

		(EAPL("K_aut from DB"), aut.Ptr(),	aut.Length()));

	EAP_TRACE_DATA_DEBUG(

		m_am_tools,

		TRACE_FLAGS_DEFAULT,

		(EAPL("K_encr from DB"), enc.Ptr(),	enc.Length()));

	eap_status_e status(eap_status_process_general_error);

	// Store the values to the supplied buffers

	status = reauth_XKEY->set_copy_of_buffer(key.Ptr(),key.Length());

	if (status != eap_status_ok)

	{

		User::Leave(

			m_am_tools->convert_eapol_error_to_am_error(

				EAP_STATUS_RETURN(m_am_tools, status)));

	}

	status = reauth_K_aut->set_copy_of_buffer(aut.Ptr(),aut.Length());

	if (status != eap_status_ok)

	{

		User::Leave(

			m_am_tools->convert_eapol_error_to_am_error(

				EAP_STATUS_RETURN(m_am_tools, status)));

	}

	status = reauth_K_encr->set_copy_of_buffer(enc.Ptr(),enc.Length());

	if (status != eap_status_ok)

	{

		User::Leave(

			m_am_tools->convert_eapol_error_to_am_error(

				EAP_STATUS_RETURN(m_am_tools, status)));

	}

	*reauth_counter = view.ColUint(colSet->ColNo(KReauthCounter));

	CleanupStack::PopAndDestroy(colSet); // Delete colSet.

	EAP_TRACE_DEBUG(

		m_am_tools,

		TRACE_FLAGS_DEFAULT,

		(EAPL("eap_am_type_gsmsim_symbian_c::query_reauth_parametersL(): %s, m_saved_reauth_counter %d.\n"),

		 (m_is_client == true ? "client": "server"),

		 *reauth_counter));

	// Close database

	CleanupStack::PopAndDestroy(2); // view, buf

	EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

}

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

EAP_FUNC_EXPORT eap_status_e eap_am_type_gsmsim_symbian_c::increase_reauth_counter()

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

	eap_status_e status(eap_status_ok);

	TRAPD(err, increase_reauth_counterL());

	if (err != KErrNone)

	{

		status = m_am_tools->convert_am_error_to_eapol_error(err);

		send_error_notification(status);

	} 		

	EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

	return EAP_STATUS_RETURN(m_am_tools, status);

}