/*

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

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

#include "eap_variable_data.h"

#include "eap_tools.h"

#include "eap_type_all.h"

#include "eapol_wlan_authentication.h"

#include "eapol_ethernet_header.h"

#include "ethernet_core.h"

#include "eap_crypto_api.h"

#include "eap_header_string.h"

#include "eap_rogue_ap_entry.h"

#include "abs_eap_state_notification.h"

#include "eapol_session_key.h"

#include "eap_buffer.h"

#include "eap_config.h"

#include "eap_array_algorithms.h"

#include "eap_state_notification.h"

#include "eap_automatic_variable.h"

// LOCAL CONSTANTS

enum eapol_am_core_timer_id_e

{

	EAPOL_WLAN_AUTHENTICATION_TIMER_FAILED_COMPLETELY_ID,

	EAPOL_WLAN_AUTHENTICATION_TIMER_THIS_AP_FAILED_ID,

	EAPOL_WLAN_AUTHENTICATION_TIMER_NO_RESPONSE_ID,

	EAPOL_WLAN_AUTHENTICATION_TIMER_AUTHENTICATION_CANCELLED_ID

};

#if defined(USE_EAPOL_WLAN_AUTHENTICATION_MUTEX)

	#if defined(USE_TEST_WLAN_AUTHENTICATION_MUTEX)

		#error "You cannot define both USE_EAPOL_WLAN_AUTHENTICATION_MUTEX and USE_TEST_WLAN_AUTHENTICATION_MUTEX."

	#endif

	#define WAUTH_ENTER_MUTEX(tools) { tools->enter_global_mutex(); }

	#define WAUTH_LEAVE_MUTEX(tools) { tools->leave_global_mutex(); }

#else

	#define WAUTH_ENTER_MUTEX(tools)

	#define WAUTH_LEAVE_MUTEX(tools)

#endif //#if defined(USE_EAPOL_WLAN_AUTHENTICATION_MUTEX)

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

EAP_FUNC_EXPORT eapol_wlan_authentication_c * eapol_wlan_authentication_c::new_eapol_wlan_authentication(

	abs_eap_am_tools_c * const tools,

	abs_eapol_wlan_authentication_c * const partner,

	const bool is_client_when_true,

	const abs_eapol_wlan_database_reference_if_c * const wlan_database_reference

	)

{

	EAP_TRACE_DEBUG(

		tools, 

		TRACE_FLAGS_DEFAULT, 

		(EAPL("partner calls: eapol_wlan_authentication_c::new_eapol_wlan_authentication()\n")));

	EAP_TRACE_RETURN_STRING(tools, "returns to partner: eapol_wlan_authentication_c::new_eapol_wlan_authentication()");

	eapol_am_wlan_authentication_c * m_am_wauth = eapol_am_wlan_authentication_c::new_eapol_am_wlan_authentication(

		tools,

		is_client_when_true,

		wlan_database_reference);

	if (m_am_wauth == 0

		|| m_am_wauth->get_is_valid() == false)

	{

		// ERROR.

		if (m_am_wauth != 0)

		{

			EAP_TRACE_DEBUG(

				tools,

				TRACE_FLAGS_ALWAYS|TRACE_FLAGS_DEFAULT, 

				(EAPL("calls: eapol_wlan_authentication_c::new_eapol_wlan_authentication(): m_am_wauth->shutdown(): %s.\n"),

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

			m_am_wauth->shutdown();

			delete m_am_wauth;

			m_am_wauth = 0;

		}

		return 0;

	}

	eapol_wlan_authentication_c * wauth = new eapol_wlan_authentication_c(tools, partner, m_am_wauth, is_client_when_true);

	if (wauth == 0

		|| wauth->get_is_valid() == false)

	{

		// ERROR.

		if (wauth != 0)

		{

			wauth->shutdown();

			delete wauth;

		}

		return 0;

	}

	EAP_TRACE_DEBUG(

		tools,

		TRACE_FLAGS_ALWAYS|TRACE_FLAGS_DEFAULT, 

		(EAPL("calls: eapol_wlan_authentication_c::new_eapol_wlan_authentication(): m_am_wauth->set_am_partner(): %s.\n"),

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

	m_am_wauth->set_am_partner(

		wauth

#if defined(USE_EAP_SIMPLE_CONFIG)

		, wauth

#endif // #if defined(USE_EAP_SIMPLE_CONFIG)

		);

	return wauth;

}	

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

EAP_FUNC_EXPORT eapol_wlan_authentication_c::eapol_wlan_authentication_c(

	abs_eap_am_tools_c * const tools,

	abs_eapol_wlan_authentication_c * const partner,

	eapol_am_wlan_authentication_c * const am_wauth, ///< eapol_wlan_authentication_c must always delete the am_wauth object.

	const bool is_client_when_true)

: m_partner(partner)

, m_am_wauth(am_wauth)

, m_ethernet_core(0)

, m_am_tools(tools)

, m_selected_eap_types(tools)

, m_wpa_preshared_key_hash(tools)

, m_authentication_type(eapol_key_authentication_type_none)

, m_802_11_authentication_mode(eapol_key_802_11_authentication_mode_none)

, m_received_WPA_IE(tools) // WLM must give only the WPA IE to EAPOL

, m_sent_WPA_IE(tools)

, m_group_key_cipher_suite(eapol_RSNA_key_header_c::eapol_RSNA_cipher_none)

, m_pairwise_key_cipher_suite(eapol_RSNA_key_header_c::eapol_RSNA_cipher_none)

, m_current_eap_index(0ul)

, m_authentication_counter(0u)

, m_successful_authentications(0u)

, m_failed_authentications(0u)

, m_is_valid(false)

, m_is_client(is_client_when_true)

, m_shutdown_was_called(false)

#if defined(USE_EAP_ERROR_TESTS)

, m_randomly_drop_packets(false)

, m_randomly_drop_packets_probability(0u)

, m_error_probability(0u)

, m_generate_multiple_error_packets(0u)

, m_packet_index(0u)

, m_enable_random_errors(false)

, m_manipulate_ethernet_header(false)

, m_send_original_packet_first(false)

#endif //#if defined(USE_EAP_ERROR_TESTS)

{

	EAP_TRACE_DEBUG(

		m_am_tools, 

		TRACE_FLAGS_DEFAULT, 

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

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

		this,

		dynamic_cast<abs_eap_base_timer_c *>(this),

		__DATE__,

		__TIME__));

	EAP_TRACE_RETURN_STRING(m_am_tools, "returns: eapol_wlan_authentication_c::eapol_wlan_authentication_c()");

	if (m_am_wauth == 0

		|| m_am_wauth->get_is_valid() == false)

	{

		// ERROR.

		if (m_am_wauth != 0)

		{

			EAP_TRACE_DEBUG(

				m_am_tools,

				TRACE_FLAGS_ALWAYS|TRACE_FLAGS_DEFAULT, 

				(EAPL("calls: eapol_wlan_authentication_c::eapol_wlan_authentication_c(): m_am_wauth->shutdown(): %s.\n"),

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

			m_am_wauth->shutdown();

			delete am_wauth;

		}

		return;

	}

	if (m_am_tools == 0

		|| m_am_tools->get_is_valid() == false)

	{

		// ERROR.

		if (m_am_wauth != 0)

		{

			EAP_TRACE_DEBUG(

				m_am_tools,

				TRACE_FLAGS_ALWAYS|TRACE_FLAGS_DEFAULT, 

				(EAPL("calls: eapol_wlan_authentication_c::eapol_wlan_authentication_c(): m_am_wauth->shutdown(): %s.\n"),

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

			m_am_wauth->shutdown();

			delete am_wauth;

		}

		return;

	}

	m_is_valid = true;

}	

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

EAP_FUNC_EXPORT eapol_wlan_authentication_c::~eapol_wlan_authentication_c()

{

	EAP_TRACE_DEBUG(

		m_am_tools, 

		TRACE_FLAGS_DEFAULT, 

		(EAPL("partner calls: eapol_wlan_authentication_c::~eapol_wlan_authentication_c(): this = 0x%08x\n"),

		this));

	EAP_TRACE_RETURN_STRING(m_am_tools, "returns to partner: eapol_wlan_authentication_c::~eapol_wlan_authentication_c()");

	EAP_ASSERT(m_shutdown_was_called == true);

}

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

//

EAP_FUNC_EXPORT eap_status_e eapol_wlan_authentication_c::shutdown()

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

	EAP_TRACE_DEBUG(

		m_am_tools,

		TRACE_FLAGS_DEFAULT,

		(EAPL("partner calls: eapol_wlan_authentication_c::shutdown(); %s, m_shutdown_was_called=%d\n"),

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

		m_shutdown_was_called));

	EAP_TRACE_RETURN_STRING(m_am_tools, "returns to partner: eapol_wlan_authentication_c::shutdown()");

	if (m_shutdown_was_called == true)

	{

		// Shutdown was already called once.

		return EAP_STATUS_RETURN(m_am_tools, eap_status_ok);

	}

	m_shutdown_was_called = true;

	// Cancel timer	

	cancel_all_timers();

	// Delete upper stack if it still exists

	if (m_ethernet_core != 0)

	{

		WAUTH_ENTER_MUTEX(m_am_tools);

		EAP_TRACE_DEBUG(

			m_am_tools,

			TRACE_FLAGS_ALWAYS|TRACE_FLAGS_DEFAULT, 

			(EAPL("calls eapol: eapol_wlan_authentication_c::shutdown(): m_ethernet_core->shutdown(): %s.\n"),

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

		eap_status_e status = m_ethernet_core->shutdown();

		EAP_UNREFERENCED_PARAMETER(status);

		EAP_TRACE_DEBUG(

			m_am_tools,

			TRACE_FLAGS_ALWAYS|TRACE_FLAGS_DEFAULT, 

			(EAPL("returns from eapol: eapol_wlan_authentication_c::shutdown(): m_ethernet_core->shutdown(): %s, status = %s.\n"),

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

			eap_status_string_c::get_status_string(status)));

		WAUTH_LEAVE_MUTEX(m_am_tools);

		delete m_ethernet_core;

		m_ethernet_core = 0;

	}

	// Print some statistics

	if (m_is_client)

	{

		EAP_TRACE_ALWAYS(

			m_am_tools,

			TRACE_FLAGS_ALWAYS|TRACE_TEST_VECTORS,

			(EAPL("eapol_wlan_authentication_c::shutdown(): client authentication SUCCESS %d, FAILED %d, count %d\n"),

			m_successful_authentications,

			m_failed_authentications,

			m_authentication_counter));	

	}

	else

	{

		EAP_TRACE_ALWAYS(

			m_am_tools,

			TRACE_FLAGS_ALWAYS|TRACE_TEST_VECTORS,

			(EAPL("eapol_wlan_authentication_c::shutdown(): server authentication SUCCESS %d, FAILED %d, count %d\n"),

			m_successful_authentications,

			m_failed_authentications,

			m_authentication_counter));

	}

	if (m_am_wauth != 0)

	{

		EAP_TRACE_DEBUG(

			m_am_tools,

			TRACE_FLAGS_ALWAYS|TRACE_FLAGS_DEFAULT, 

			(EAPL("calls: eapol_wlan_authentication_c::shutdown(): m_am_wauth->shutdown(): %s.\n"),

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

		m_am_wauth->shutdown();

		delete m_am_wauth;

		m_am_wauth = 0;

	}

	EAP_TRACE_DEBUG(

		m_am_tools,

		TRACE_FLAGS_DEFAULT,

		(EAPL("WAUTH EXITING.\n")));

	EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

	return eap_status_ok;

}

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

//

eap_status_e eapol_wlan_authentication_c::cancel_all_authentication_sessions()

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);	

	EAP_TRACE_DEBUG(

		m_am_tools,

		TRACE_FLAGS_DEFAULT,

		(EAPL("eapol_wlan_authentication_c::cancel_all_authentication_sessions(): %s\n"),

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

	eap_status_e status(eap_status_process_general_error);

	if (m_ethernet_core != 0)

	{

		WAUTH_ENTER_MUTEX(m_am_tools);

		EAP_TRACE_DEBUG(

			m_am_tools,

			TRACE_FLAGS_ALWAYS|TRACE_FLAGS_DEFAULT, 

			(EAPL("calls eapol: eapol_wlan_authentication_c::cancel_all_authentication_sessions(): m_ethernet_core->cancel_all_authentication_sessions(): %s.\n"),

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

		status = m_ethernet_core->cancel_all_authentication_sessions();

		EAP_TRACE_DEBUG(

			m_am_tools,

			TRACE_FLAGS_ALWAYS|TRACE_FLAGS_DEFAULT, 

			(EAPL("returns from eapol: eapol_wlan_authentication_c::cancel_all_authentication_sessions(): m_ethernet_core->cancel_all_authentication_sessions(): %s, status = %s.\n"),

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

			eap_status_string_c::get_status_string(status)));

		WAUTH_LEAVE_MUTEX(m_am_tools);

	}

	else

	{

		EAP_TRACE_DEBUG(

			m_am_tools,

			TRACE_FLAGS_DEFAULT,

			(EAPL("eapol_wlan_authentication_c::cancel_all_authentication_sessions(): Stack did not exists.\n")));

		status = eap_status_process_general_error;

	}

	EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);	

	return EAP_STATUS_RETURN(m_am_tools, status);

}

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

//

EAP_FUNC_EXPORT eap_status_e eapol_wlan_authentication_c::start_authentication(

	const eap_variable_data_c * const SSID,

	const eapol_key_authentication_type_e selected_eapol_key_authentication_type,

	const eap_variable_data_c * const wpa_preshared_key,

	const bool WPA_override_enabled

#if defined(USE_EAPOL_KEY_STATE_OPTIMIZED_4_WAY_HANDSHAKE)

	,

	const eap_am_network_id_c * const receive_network_id ///< source includes remote address, destination includes local address.

#endif //#if defined(USE_EAPOL_KEY_STATE_OPTIMIZED_4_WAY_HANDSHAKE)

	)

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);	

	EAP_TRACE_DEBUG(

		m_am_tools,

		TRACE_FLAGS_DEFAULT,

		(EAPL("partner calls: eapol_wlan_authentication_c::start_authentication(): %s\n"),

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

	EAP_TRACE_DEBUG(

		m_am_tools,

		TRACE_FLAGS_DEFAULT,

		(EAPL("Starting authentication, selected_eapol_key_authentication_type = %d.\n"),

		selected_eapol_key_authentication_type));

	EAP_TRACE_RETURN_STRING(m_am_tools, "returns to partner: eapol_wlan_authentication_c::start_authentication()");

	eap_status_e status(eap_status_ok);

	status = cancel_all_authentication_sessions();

	if (status != eap_status_ok)

	{

		(void) EAP_STATUS_RETURN(m_am_tools, status);

	}

	m_authentication_type = selected_eapol_key_authentication_type;

	EAP_TRACE_DEBUG(

		m_am_tools,

		TRACE_FLAGS_ALWAYS|TRACE_FLAGS_DEFAULT, 

		(EAPL("calls: eapol_wlan_authentication_c::start_authentication(): m_am_wauth->set_wlan_parameters(): %s.\n"),

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

	status = m_am_wauth->set_wlan_parameters(

		SSID,

		WPA_override_enabled,

		wpa_preshared_key,

		selected_eapol_key_authentication_type);

	if (status != eap_status_ok)

	{

		(void) disassociation(0); // Note we have no addresses yet.

		(void) eapol_indication(

			0, // Note we have no addresses yet.

			eapol_wlan_authentication_state_failed_completely);

		return EAP_STATUS_RETURN(m_am_tools, status);

	}

	EAP_TRACE_DEBUG(

		m_am_tools,

		TRACE_FLAGS_ALWAYS|TRACE_FLAGS_DEFAULT, 

		(EAPL("calls: eapol_wlan_authentication_c::start_authentication(): m_am_wauth->reset_eap_configuration(): %s.\n"),

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

	status = m_am_wauth->reset_eap_configuration();

	if (status != eap_status_ok)

	{

		(void) disassociation(0); // Note we have no addresses yet.

		(void) eapol_indication(

			0, // Note we have no addresses yet.

			eapol_wlan_authentication_state_failed_completely);

		return EAP_STATUS_RETURN(m_am_tools, status);

	}

	EAP_TRACE_DEBUG(

		m_am_tools,

		TRACE_FLAGS_ALWAYS|TRACE_FLAGS_DEFAULT, 

		(EAPL("calls: eapol_wlan_authentication_c::start_authentication(): m_am_wauth->get_selected_eap_types(): %s.\n"),

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

	status = m_am_wauth->get_selected_eap_types(&m_selected_eap_types);

	if (status != eap_status_ok)

	{

		return EAP_STATUS_RETURN(m_am_tools, status);

	}

	EAP_TRACE_DEBUG(

		m_am_tools,

		TRACE_FLAGS_ALWAYS|TRACE_FLAGS_DEFAULT, 

		(EAPL("calls: eapol_wlan_authentication_c::start_authentication(): m_am_wauth->get_wlan_configuration(): %s.\n"),

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

	status = m_am_wauth->get_wlan_configuration(

		&m_wpa_preshared_key_hash);

	if (status != eap_status_ok)

	{

		return EAP_STATUS_RETURN(m_am_tools, status);

	}

	// Start new authentication from scratch.

	if (m_authentication_type == eapol_key_authentication_type_RSNA_PSK

		|| m_authentication_type == eapol_key_authentication_type_WPA_PSK)

	{

		// WPA Pre-shared key mode

		m_802_11_authentication_mode = eapol_key_802_11_authentication_mode_open;

		if (m_authentication_type == eapol_key_authentication_type_RSNA_PSK)

		{

			EAP_TRACE_ALWAYS(

				m_am_tools,

				TRACE_FLAGS_ALWAYS|TRACE_FLAGS_DEFAULT, 

				(EAPL("start_authentication(): Trying auth mode OPEN and WPA2-PSK.\n")));

		}

		else

		{

			EAP_TRACE_ALWAYS(

				m_am_tools,

				TRACE_FLAGS_ALWAYS|TRACE_FLAGS_DEFAULT, 

				(EAPL("start_authentication(): Trying auth mode OPEN and WPA-PSK.\n")));

		}

	}

	else //if (wpa_preshared_key == 0

		//|| wpa_preshared_key->get_is_valid_data() == false

		//|| WPA_override_enabled == false)

	{

		// Check the first enabled type