/*

* ============================================================================

*  Name        : ./accesssec/eapol/eapol_framework/wapi_common/src/wapi_session_core.cpp

*  Part of     : WAPI / WAPI       *** Info from the SWAD

*  Description : WAPI authentication

*  Version     : %version: 16.1.1 % << Don't touch! Updated by Synergy at check-out.

*

*  Copyright © 2001-2009 Nokia.  All rights reserved.

*  This material, including documentation and any related computer

*  programs, is protected by copyright controlled by Nokia.  All

*  rights are reserved.  Copying, including reproducing, storing,

*  adapting or translating, any or all of this material requires the

*  prior written consent of Nokia.  This material also contains

*  confidential information which may not be disclosed to others

*  without the prior written consent of Nokia.

* ============================================================================

* Template version: 4.1.1

*/

// This is enumeration of WAPI source code.

#if defined(USE_EAP_MINIMUM_RELEASE_TRACES)

	#undef EAP_FILE_NUMBER_ENUM

	#define EAP_FILE_NUMBER_ENUM 20004

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

#include "eap_state_notification.h"

#include "eap_network_id_selector.h"

#include "abs_eap_am_mutex.h"

#include "eap_config.h"

#include "wapi_core.h"

#include "eap_buffer.h"

#include "eap_automatic_variable.h"

#include "wai_protocol_packet_header.h"

#include "wapi_strings.h"

#include "eapol_session_key.h"

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

// 

EAP_FUNC_EXPORT wapi_session_core_c::~wapi_session_core_c()

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

	EAP_TRACE_DEBUG(

		m_am_tools, 

		TRACE_FLAGS_DEFAULT, 

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

		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 wapi_session_core_c::wapi_session_core_c(

	abs_eap_am_tools_c * const tools,

	abs_wapi_core_c * const partner,

	const bool is_client_when_true)

: m_partner(partner)

, m_am_tools(tools)

, m_session_map(tools, this)

, m_remove_session_timeout(WAPI_SESSION_CORE_REMOVE_SESSION_TIMEOUT)

, m_is_client(is_client_when_true)

, m_is_valid(false)

, m_use_wapi_session_core_reset_session(true)

, m_shutdown_was_called(false)

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

	EAP_TRACE_DEBUG(

		m_am_tools, 

		TRACE_FLAGS_DEFAULT, 

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

		this,

		dynamic_cast<abs_eap_base_timer_c *>(this)));

	set_is_valid();

	EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

}

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

//

EAP_FUNC_EXPORT abs_wapi_core_c * wapi_session_core_c::get_partner()

{

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

	return m_partner;

}

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

//

EAP_FUNC_EXPORT void wapi_session_core_c::set_is_valid()

{

	m_is_valid = true;

}

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

//

EAP_FUNC_EXPORT bool wapi_session_core_c::get_is_valid()

{

	return m_is_valid;

}

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

EAP_FUNC_EXPORT eap_status_e wapi_session_core_c::reset()

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

	EAP_TRACE_DEBUG(

		m_am_tools, 

		TRACE_FLAGS_DEFAULT, 

		(EAPL("wapi_session_core_c::reset(): this = 0x%08x => 0x%08x.\n"),

		this,

		dynamic_cast<abs_eap_base_timer_c *>(this)));

	eap_status_e status = m_session_map.for_each(shutdown_operation, true);

	(void)EAP_STATUS_RETURN(m_am_tools, status);

	status = m_session_map.reset();

	(void)EAP_STATUS_RETURN(m_am_tools, status);

	m_partner->cancel_timer(this, WAPI_SESSION_CORE_REMOVE_SESSION_ID);

	EAP_TRACE_DEBUG(

		m_am_tools, 

		TRACE_FLAGS_DEFAULT, 

		(EAPL("TIMER: WAPI_SESSION_CORE_REMOVE_SESSION_ID cancelled, %s.\n"),

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

	EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

	return EAP_STATUS_RETURN(m_am_tools, status);

}

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

//

EAP_FUNC_EXPORT wapi_core_c * wapi_session_core_c::create_new_session(

	const eap_am_network_id_c * const receive_network_id)

{

	eap_status_e status = eap_status_process_general_error;

	// Create a new session.

	wapi_core_c * const session = new wapi_core_c(

		m_am_tools,

		this,

		m_is_client,

		receive_network_id);

	if (session == 0)

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		(void)EAP_STATUS_RETURN(m_am_tools, eap_status_allocation_error);

		return 0;

	}

	if (session->get_is_valid() == false)

	{

		session->shutdown();

		delete session;

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		(void)EAP_STATUS_RETURN(m_am_tools, eap_status_allocation_error);

		return 0;

	}

	status = session->configure();

	if (status != eap_status_ok)

	{

		session->shutdown();

		delete session;

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		(void)EAP_STATUS_RETURN(m_am_tools, status);

		return 0;

	}

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

	if (send_network_id.get_is_valid_data() == false)

	{

		session->shutdown();

		delete session;

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		(void)EAP_STATUS_RETURN(m_am_tools, eap_status_allocation_error);

		return 0;

	}

	eap_network_id_selector_c selector(

		m_am_tools,

		&send_network_id);

	if (selector.get_is_valid() == false)

	{

		session->shutdown();

		delete session;

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		(void)EAP_STATUS_RETURN(m_am_tools, eap_status_allocation_error);

		return 0;

	}

	EAP_TRACE_DATA_DEBUG(

		m_am_tools,

		TRACE_FLAGS_DEFAULT,

		(EAPL("create_new_session() WAPI session"),

		 selector.get_data(selector.get_data_length()),

		 selector.get_data_length()));

	status = m_session_map.add_handler(&selector, session);

	if (status != eap_status_ok)

	{

		session->shutdown();

		delete session;

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		(void)EAP_STATUS_RETURN(m_am_tools, status);

		return 0;

	}

	return session;

}

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

//

EAP_FUNC_EXPORT eap_status_e wapi_session_core_c::reset_or_remove_session(

	wapi_core_c ** const session,

	const eap_network_id_selector_c * const selector,

	const bool reset_immediately)

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

	eap_status_e status(eap_status_process_general_error);

	if (session == 0

		|| *session == 0

		|| selector == 0)

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, eap_status_illegal_parameter);

	}

	if (m_use_wapi_session_core_reset_session == true)

	{

		// This will reuse session.

		EAP_TRACE_DEBUG(

			m_am_tools, 

			TRACE_FLAGS_DEFAULT, 

			(EAPL("wapi_session_core_c::reset_or_remove_session(): resets session, session 0x%08x.\n"),

			(*session)));

		// NOTE, this delayed reset of session is used bacause the device is so slow in some cases

		// (e.g. it cannot respond to WPA 4-Way Handshake message fast enough)

		if (reset_immediately == true)

		{

			(*session)->unset_marked_removed();

			status = (*session)->reset();

		}

		else

		{

			// This will delay reset to wapi_core_c::packet_process().

			status = eap_status_ok;

		}

	}

	else

	{

		//  This will cause shutdown of the session.

		status = eap_status_process_general_error;

	}

	if (status != eap_status_ok)

	{

		// We cannot reuse the session.

		EAP_TRACE_DEBUG(

			m_am_tools, 

			TRACE_FLAGS_DEFAULT, 

			(EAPL("wapi_session_core_c::reset_or_remove_session(): shutdown session, session 0x%08x.\n"),

			(*session)));

		(*session)->shutdown();

		(*session) = 0;

		status = m_session_map.remove_handler(selector, true);

		if (status != eap_status_ok)

		{

			EAP_TRACE_DEBUG(

				m_am_tools, 

				TRACE_FLAGS_DEFAULT, 

				(EAPL("ERROR: wapi_session_core_c::reset_or_remove_session(): m_session_map.remove_type(), eap_status_e %d\n"),

				status));

			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("wapi_session_core_c::reset_or_remove_session(): session NOT reused.\n")));

	}

	else

	{

		EAP_TRACE_DEBUG(

			m_am_tools, 

			TRACE_FLAGS_DEFAULT, 

			(EAPL("wapi_session_core_c::reset_or_remove_session(): session reused, session 0x%08x.\n"),

			(*session)));

	}

	EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

	return EAP_STATUS_RETURN(m_am_tools, status);

}

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

//

EAP_FUNC_EXPORT eap_status_e wapi_session_core_c::packet_process(

	const eap_am_network_id_c * const receive_network_id,

	eap_general_header_base_c * const packet_data,

	const u32_t packet_length)

{

	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;

	// Each WAPI authentication session includes its own wapi_core_c object.

	// WAPI authentication sessions are separated by eap_am_network_id_c object.

	if (packet_data == 0

		|| packet_length < eap_header_base_c::get_header_length())

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, eap_status_process_illegal_packet_error);

	}

	if (receive_network_id == 0

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

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, eap_status_illegal_parameter);

	}

	wai_protocol_packet_header_c wai(

		m_am_tools,

		packet_data->get_header_buffer(packet_length),

		packet_length);

	if (wai.get_is_valid() == false)

	{

		EAP_TRACE_ERROR(

			m_am_tools, 

			TRACE_FLAGS_DEFAULT, 

			(EAPL("wapi_session_core_c::packet_process(): %s, packet buffer corrupted.\n"),

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

			 ));

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, eap_status_header_corrupted);

	}

	EAP_TRACE_DATA_DEBUG(

		m_am_tools, 

		EAP_TRACE_FLAGS_MESSAGE_DATA|TRACE_TEST_VECTORS, 

		(EAPL("WAI-packet"),

		 wai.get_header_buffer(packet_length),

		 packet_length));

	WAI_PROTOCOL_PACKET_TRACE_HEADER("->", &wai, m_is_client);

	status = wai.check_header();

	if (status != eap_status_ok)

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, status);

	}

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

	if (send_network_id.get_is_valid_data() == false)

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, eap_status_allocation_error);

	}

	eap_network_id_selector_c selector(

		m_am_tools,

		&send_network_id);

	if (selector.get_is_valid() == false)

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, eap_status_allocation_error);

	}

	EAP_TRACE_DATA_DEBUG(

		m_am_tools,

		TRACE_FLAGS_DEFAULT,

		(EAPL("packet_process() WAPI-session"),

		 selector.get_data(selector.get_data_length()),

		 selector.get_data_length()));

	wapi_core_c *session = m_session_map.get_handler(&selector);

	if (session == 0)

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, eap_status_handler_does_not_exists_error);

	}

	if (session != 0)

	{

		status = session->packet_process(

			receive_network_id,

			&wai,

			packet_length);

	}

	else

	{

		status = eap_status_illegal_eap_type;

	}

	EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

	return EAP_STATUS_RETURN(m_am_tools, status);

}

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

//

EAP_FUNC_EXPORT eap_status_e wapi_session_core_c::packet_send(

	const eap_am_network_id_c * const send_network_id,

	eap_buf_chain_wr_c * const sent_packet,

	const u32_t header_offset,

	const u32_t data_length,

	const u32_t buffer_length)

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

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

	EAP_ASSERT(header_offset < sent_packet->get_data_length());

	EAP_ASSERT(data_length <= sent_packet->get_data_length());

	EAP_ASSERT(sent_packet->get_data_length() <= buffer_length);

	wai_protocol_packet_header_c wai(

		m_am_tools,

		sent_packet->get_data_offset(header_offset, data_length),

		data_length);

	if (wai.get_is_valid() == false)

	{

		EAP_TRACE_ERROR(

			m_am_tools, 

			TRACE_FLAGS_DEFAULT, 

			(EAPL("wapi_session_core_c::packet_process(): %s, packet buffer corrupted.\n"),

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

			 ));

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, eap_status_header_corrupted);

	}

	EAP_TRACE_DATA_DEBUG(

		m_am_tools, 

		EAP_TRACE_FLAGS_MESSAGE_DATA|TRACE_TEST_VECTORS, 

		(EAPL("WAI-packet"),

		 wai.get_header_buffer(data_length),

		 data_length));

	WAI_PROTOCOL_PACKET_TRACE_HEADER("<-", &wai, m_is_client);

	eap_status_e status = m_partner->packet_send(

		send_network_id, sent_packet, header_offset, data_length, buffer_length);

	EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

	return EAP_STATUS_RETURN(m_am_tools, status);

}

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

//

EAP_FUNC_EXPORT u32_t wapi_session_core_c::get_header_offset(

	u32_t * const MTU,

	u32_t * const trailer_length)

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

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

	const u32_t offset = m_partner->get_header_offset(MTU, trailer_length);

	EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

	return offset;

}

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

//

EAP_FUNC_EXPORT eap_status_e wapi_session_core_c::configure()

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

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

	{

		// This is optional.