/*

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

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

#include "eap_core_nak_info.h"

#include "eap_state_notification.h"

#include "eap_network_id_selector.h"

#include "eap_buffer.h"

#include "eap_header_string.h"

#include "eap_automatic_variable.h"

/**

 * This is the character that separates routing realms.

 */

const u8_t EAP_NAI_ROUTING_REALM_SEPARATOR[] = "!";

/**

 * This is the at character of NAI.

 */

const u8_t EAP_NAI_AT_CHARACTER[] = "@";

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

// 

EAP_FUNC_EXPORT eap_core_c::~eap_core_c()

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

	EAP_TRACE_DEBUG(

		m_am_tools, 

		TRACE_FLAGS_DEFAULT, 

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

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

		(m_is_tunneled_eap == true) ? "tunneled": "outer most",

		this,

		dynamic_cast<abs_eap_base_timer_c *>(this)));

	EAP_ASSERT(m_shutdown_was_called == true);

	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_core_c::eap_core_c(

	abs_eap_am_tools_c * const tools,

	abs_eap_core_c * const partner,

	const bool is_client_when_true,

	const eap_am_network_id_c * const receive_network_id,

	const bool is_tunneled_eap)

	: m_partner(partner)

	, m_am_tools(tools)

	, m_type_map(tools, this)

	, m_current_eap_type(eap_type_none)

	, m_default_eap_type(eap_type_none)

	, m_eap_identity(tools)

	, m_eap_header_offset(0u)

	, m_MTU(0u)

	, m_trailer_length(0u)

	, m_receive_network_id(tools)

	, m_retransmission(0)

	, m_retransmission_time(EAP_CORE_RETRANSMISSION_TIME)

	, m_retransmission_counter(EAP_CORE_RETRANSMISSION_COUNTER)

	, m_session_timeout(EAP_CORE_SESSION_TIMEOUT)

	, m_eap_core_failure_received_timeout(EAP_CORE_FAILURE_RECEIVED_TIMEOUT)

	, m_remove_session_timeout(EAP_CORE_REMOVE_SESSION_TIMEOUT)

#if defined(USE_EAP_CORE_WAIT_REQUEST_TYPE_TIMER)

	, m_wait_eap_request_type_timeout(EAP_CORE_WAIT_EAP_REQUEST_TYPE_TIMEOUT)

	, m_wait_eap_request_type_timeout_set(false)

#endif //#if defined(USE_EAP_CORE_WAIT_REQUEST_TYPE_TIMER)

	, m_eap_identity_request_identifier_client(0)

	, m_is_client(is_client_when_true)

	, m_is_client_role(is_client_when_true)

	, m_is_valid(false)

	, m_client_restart_authentication_initiated(false)

	, m_marked_removed(false)

	, m_eap_identity_response_accepted(false)

	, m_shutdown_was_called(false)

	, m_eap_type_response_sent(false)

	, m_is_tunneled_eap(is_tunneled_eap)

#if defined(USE_EAP_CORE_SERVER)

	, m_process_eap_nak_immediately(EAP_CORE_PROCESS_EAP_NAK_IMMEDIATELY)

	, m_nak_process_timer_active(false)

	, m_eap_identity_request_send(false)

	, m_eap_identity_response_received(false)

	, m_eap_failure_sent(false)

	, m_send_eap_success_after_notification(false)

#if defined(USE_EAP_CORE_WAIT_REQUEST_TYPE_TIMER)

	, m_skip_eap_request_identity(false)

#endif //#if defined(USE_EAP_CORE_WAIT_REQUEST_TYPE_TIMER)

#endif //#if defined(USE_EAP_CORE_SERVER)

	, m_use_eap_expanded_type(false)

	, m_ignore_eap_failure(false)

	, m_ignore_notifications(false)

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

	EAP_TRACE_DEBUG(

		m_am_tools, 

		TRACE_FLAGS_DEFAULT, 

		(EAPL("eap_core_c::eap_core_c(): %s, %s, this = 0x%08x => 0x%08x, compiled %s %s.\n"),

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

		(m_is_tunneled_eap == true) ? "tunneled": "outer most",

		this,

		dynamic_cast<abs_eap_base_timer_c *>(this),

		__DATE__,

		__TIME__));

	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);

		return;

	}

	set_is_valid();

	EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

}

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

//

EAP_FUNC_EXPORT abs_eap_core_c * eap_core_c::get_partner()

{

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

	return m_partner;

}

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

//

EAP_FUNC_EXPORT void eap_core_c::set_partner(abs_eap_core_c * const partner)

{

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

	m_partner = partner;

}

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

//

EAP_FUNC_EXPORT void eap_core_c::set_is_valid()

{

	m_is_valid = true;

}

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

//

EAP_FUNC_EXPORT bool eap_core_c::get_is_valid()

{

	return m_is_valid;

}

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

//

EAP_FUNC_EXPORT void eap_core_c::object_increase_reference_count()

{

}

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

//

EAP_FUNC_EXPORT u32_t eap_core_c::object_decrease_reference_count()

{

	return 0u;

}

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

//

EAP_FUNC_EXPORT bool eap_core_c::get_marked_removed()

{

	return m_marked_removed;

}

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

//

EAP_FUNC_EXPORT void eap_core_c::set_marked_removed()

{

	m_marked_removed = true;

}

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

//

EAP_FUNC_EXPORT void eap_core_c::unset_marked_removed()

{

	m_marked_removed = false;

}

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

//

EAP_FUNC_EXPORT void eap_core_c::ignore_notifications()

{

	m_ignore_notifications = true;

}

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

//

eap_status_e eap_core_c::initialize_asynchronous_init_remove_eap_session(

	const u32_t remove_session_timeout)

{

	EAP_TRACE_DEBUG(

		m_am_tools, 

		TRACE_FLAGS_DEFAULT, 

		(EAPL("eap_core_c::initialize_asynchronous_init_remove_eap_session(): %s.\n"),

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

	eap_status_e status = eap_status_process_general_error;

	if (m_is_client_role == false)

	{

		// Server stops re-transmissions.

		// Client can re-transmit until session is removed.

		cancel_retransmission();

	}

	cancel_eap_failure_timeout();

	cancel_session_timeout();

#if defined(USE_EAP_CORE_WAIT_REQUEST_TYPE_TIMER)

	if (m_is_tunneled_eap == false

		&& m_is_client_role == true)

	{

		cancel_wait_eap_request_type_timeout();

	}

#endif //#if defined(USE_EAP_CORE_WAIT_REQUEST_TYPE_TIMER)

	set_marked_removed();

	if (remove_session_timeout == 0ul)

	{

		status = asynchronous_init_remove_eap_session();

	}

	else

	{

		EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

		cancel_asynchronous_init_remove_eap_session();

		status = m_partner->set_timer(

			this,

			EAP_CORE_REMOVE_SESSION_TIMEOUT_ID,

			0,

			remove_session_timeout);

		if (status != eap_status_ok)

		{

			EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

			return EAP_STATUS_RETURN(m_am_tools, status);

		}

		EAP_TRACE_DEBUG(

			m_am_tools, 

			TRACE_FLAGS_DEFAULT, 

			(EAPL("TIMER: %s: %s, EAP_CORE_REMOVE_SESSION_TIMEOUT_ID set %d ms, this = 0x%08x.\n"),

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

			 (m_is_tunneled_eap == true) ? "tunneled": "outer most",

			 remove_session_timeout,

			 this));

	}

	EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

	return EAP_STATUS_RETURN(m_am_tools, status);

}

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

eap_status_e eap_core_c::cancel_asynchronous_init_remove_eap_session()

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

	if (m_partner != 0)

	{

		eap_status_e status = m_partner->cancel_timer(

			this,

			EAP_CORE_REMOVE_SESSION_TIMEOUT_ID);

		EAP_UNREFERENCED_PARAMETER(status); // in release

		EAP_TRACE_DEBUG(

			m_am_tools, 

			TRACE_FLAGS_DEFAULT, 

			(EAPL("TIMER: %s: %s, EAP_CORE_REMOVE_SESSION_TIMEOUT_ID cancelled status %d, this = 0x%08x.\n"),

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

			 (m_is_tunneled_eap == true) ? "tunneled": "outer most",

			 status,

			 this));

	}

	EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

	return EAP_STATUS_RETURN(m_am_tools, eap_status_ok);

}

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

//

eap_status_e eap_core_c::asynchronous_init_remove_eap_session()

{

	EAP_TRACE_DEBUG(

		m_am_tools, 

		TRACE_FLAGS_DEFAULT, 

		(EAPL("eap_core_c::asynchronous_init_remove_eap_session(): %s.\n"),

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

		eap_am_network_id_c send_network_id(

			m_am_tools,

			m_receive_network_id.get_destination_id(),

			m_receive_network_id.get_source_id(),

			m_receive_network_id.get_type());

		eap_status_e status = m_partner->asynchronous_init_remove_eap_session(

			&send_network_id);

	return EAP_STATUS_RETURN(m_am_tools, status);

}

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

//

eap_status_e eap_core_c::init_end_of_session(

	const abs_eap_state_notification_c * const state)

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

	EAP_TRACE_DEBUG(

		m_am_tools, 

		TRACE_FLAGS_DEFAULT, 

		(EAPL("eap_core_c::init_end_of_session(): %s.\n"),

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

	eap_status_e status(eap_status_process_general_error);

	// Normally we will remove session after authentication ends.

	// Remove session only if the stack is not already being deleted

	if (m_shutdown_was_called == false)

	{

		#if defined(USE_EAPOL_KEY_STATE) && defined(USE_EAP_CORE_RESTART_AUTHENTICATION)

			#error ERROR: USE_EAPOL_KEY_STATE and USE_EAP_CORE_RESTART_AUTHENTICATION cannot be used same time.

		#endif //#if defined(USE_EAPOL_KEY_STATE) && defined(USE_EAP_CORE_RESTART_AUTHENTICATION)

		#if defined(USE_EAP_CORE_SIMULATOR_VERSION) && defined(USE_EAP_CORE_RESTART_AUTHENTICATION)

			// Simulator reuses current session.

			status = restart_authentication(

				state->get_send_network_id(),

				m_is_client);

			if (status != eap_status_ok)

			{

				EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

				return EAP_STATUS_RETURN(m_am_tools, status);

			}

		#elif defined(USE_EAP_CORE_SIMULATOR_VERSION) && defined(USE_EAPOL_KEY_STATE)

			EAP_TRACE_DEBUG(

				m_am_tools,

				TRACE_FLAGS_DEFAULT,

				(EAPL("eap_core_c::state_notification(): %s, %s, Ignored notification: ")

				 EAPL("Protocol layer %d, EAP type 0x%02x, State transition from ")

				 EAPL("%d=%s to %d=%s, client %d.\n"),

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

				 (m_is_tunneled_eap == true) ? "tunneled": "outer most",

				 state->get_protocol_layer(), 

				 state->get_protocol(), 

				 state->get_previous_state(), 

				 state->get_previous_state_string(), 

				 state->get_current_state(), 

				 state->get_current_state_string(),

				 state->get_is_client()));

		#endif //#if defined(USE_EAP_CORE_SIMULATOR_VERSION)

		status = initialize_asynchronous_init_remove_eap_session(m_remove_session_timeout);

		if (status != eap_status_ok)

		{

			EAP_UNREFERENCED_PARAMETER(state);

			EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

			return EAP_STATUS_RETURN(m_am_tools, status);

		}

	}

	else

	{

		EAP_TRACE_DEBUG(

			m_am_tools,

			TRACE_FLAGS_DEFAULT,

			(EAPL("eap_core_c::state_notification(): %s, %s, Ignored notification: ")

			 EAPL("Protocol layer %d, EAP type 0x%02x, State transition from ")

			 EAPL("%d=%s to %d=%s, client %d when shutdown was called.\n"),

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

			 (m_is_tunneled_eap == true) ? "tunneled": "outer most",

			 state->get_protocol_layer(), 

			 state->get_protocol(), 

			 state->get_previous_state(), 

			 state->get_previous_state_string(), 

			 state->get_current_state(), 

			 state->get_current_state_string(),

			 state->get_is_client()));

		status = eap_status_ok;

	}

	EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

	return EAP_STATUS_RETURN(m_am_tools, status);

}

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

EAP_FUNC_EXPORT void eap_core_c::state_notification(

	const abs_eap_state_notification_c * const state)

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

	eap_status_string_c status_string;

	eap_header_string_c eap_string;

	EAP_UNREFERENCED_PARAMETER(status_string); // in release

	EAP_UNREFERENCED_PARAMETER(eap_string); // in release

	EAP_TRACE_DEBUG(

		m_am_tools, 

		TRACE_FLAGS_DEFAULT, 

		(EAPL("eap_core_c::state_notification(), %s, %s, protocol_layer %d=%s, protocol %d=%s, EAP-type 0x%08x=%s.\n"),

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

		(m_is_tunneled_eap == true) ? "tunneled": "outer most",

		state->get_protocol_layer(),

		state->get_protocol_layer_string(),

		state->get_protocol(),

		state->get_protocol_string(),

		convert_eap_type_to_u32_t(state->get_eap_type()),

		eap_string.get_eap_type_string(state->get_eap_type())));

	EAP_TRACE_DEBUG(

		m_am_tools, 

		TRACE_FLAGS_DEFAULT, 

		(EAPL("eap_core_c::state_notification(), %s, %s, current_state %d=%s, error %d=%s.\n"),

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

		(m_is_tunneled_eap == true) ? "tunneled": "outer most",

		state->get_current_state(),

		state->get_current_state_string(),

		state->get_authentication_error(),

		status_string.get_status_string(state->get_authentication_error())));

	if (m_ignore_notifications == true

		|| m_partner == 0)

	{

		return;

	}

	// Check if the notification is from the current active type

	if (state->get_protocol_layer() == eap_protocol_layer_general)

	{

		 // These notications are allowed always.

	}

	else if (state->get_protocol_layer() == eap_protocol_layer_eap

		&& state->get_eap_type() != m_current_eap_type)

	{

		EAP_TRACE_DEBUG(

			m_am_tools,

			TRACE_FLAGS_DEFAULT,

			(EAPL("eap_core_c::state_notification(): %s, %s, Ignored notification: ")

			 EAPL("Protocol layer %d, non-active EAP type 0x%02x, current EAP type 0x%08x, State transition from ")

			 EAPL("%d=%s to %d=%s, client %d\n"),

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

			 (m_is_tunneled_eap == true) ? "tunneled": "outer most",

			state->get_protocol_layer(),

			state->get_protocol(),

			convert_eap_type_to_u32_t(m_current_eap_type),

			state->get_previous_state(),

			state->get_previous_state_string(),

			state->get_current_state(),

			state->get_current_state_string(),

			state->get_is_client()));

		return;

	}

	if (state->get_protocol_layer() == eap_protocol_layer_eap)

	{

		if (state->get_current_state() == eap_state_identity_response_received)

		{

			m_eap_identity_response_accepted = true;

			EAP_TRACE_DEBUG(

				m_am_tools,