/*

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

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

#include "eap_type_mschapv2_header.h"

#include "eap_type_mschapv2.h"

#include "eap_type_mschapv2_credential_store.h"

#include "eap_buffer.h"

#include "eap_config.h"

#include "eap_master_session_key.h"

#include "eap_automatic_variable.h"

/**

* Constructor initializes all member attributes.

*/

EAP_FUNC_EXPORT eap_type_mschapv2_c::eap_type_mschapv2_c(

	abs_eap_am_tools_c * const tools,

	abs_eap_base_type_c * const partner,

	eap_am_type_mschapv2_c * const am_type_mschapv2,

	const bool free_am_type_mschapv2,

	const bool is_client_when_true,

	const eap_am_network_id_c * const receive_network_id)

	: eap_base_type_c(tools, partner)

	, m_am_type_mschapv2(am_type_mschapv2)

	, m_am_tools(tools)

	, m_session(tools, is_client_when_true)

	, m_send_network_id(tools)

	, m_rand(tools)

	, m_username_utf8(tools)

	, m_password_utf8(tools)

	, m_old_password_utf8(tools)

	, m_password_hash(tools)

	, m_password_hash_hash(tools)

#if defined(USE_FAST_EAP_TYPE)

	, m_client_EAP_FAST_challenge(tools)

	, m_server_EAP_FAST_challenge(tools)

#endif //#if defined(USE_FAST_EAP_TYPE)

	, m_offset(0)

	, m_mtu_length(0)

	, m_trailer_length(0)

	, m_error_code(0)

	, m_is_valid(false)

	, m_is_client(is_client_when_true)

	, m_free_am_type_mschapv2(free_am_type_mschapv2)

	, m_is_pending(false)

	, m_identity_asked(false)

	, m_wait_eap_success(false)

	, m_wait_eap_success_packet(true)

	, m_is_reauthentication(false)

	, m_is_notification_sent(false)

	, m_shutdown_was_called(false)

	, m_password_prompt_enabled(true)

	, m_identifier(0)

	, m_mschapv2id(0)

#if defined(EAP_USE_TTLS_PLAIN_MS_CHAP_V2_HACK)

	, m_use_implicit_challenge(false)

#endif //#if defined(EAP_USE_TTLS_PLAIN_MS_CHAP_V2_HACK)

#if defined(EAP_MSCHAPV2_SERVER)

	, m_do_password_expiration_tests(false)

	, m_password_expired(false)

#endif //#if defined(EAP_MSCHAPV2_SERVER)

	, m_do_wrong_password_tests(false)

	, m_use_eap_expanded_type(false)

#if defined(USE_FAST_EAP_TYPE)

	, m_use_EAP_FAST_full_key(false)

	, m_use_EAP_FAST_challenge(false)

#endif //#if defined(USE_FAST_EAP_TYPE)

{

	EAP_TRACE_DEBUG(

		m_am_tools, 

		TRACE_FLAGS_DEFAULT, 

		(EAPL("eap_type_mschapv2_c::eap_type_mschapv2_c(): this = 0x%08x, ")

		 EAPL("partner 0x%08x, type partner 0x%08x, compiled %s %s\n"),

		 this,

		 partner,

		 get_type_partner(),

		__DATE__,

		__TIME__));

	m_am_type_mschapv2->set_am_partner(this);

	{

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

		eap_status_e status = m_send_network_id.set_copy_of_network_id(&send_network_id);

		if (status != eap_status_ok

			|| m_send_network_id.get_is_valid_data() == false)

		{

			(void)EAP_STATUS_RETURN(m_am_tools, eap_status_allocation_error);

			return;

		}

	}

	m_is_valid = true;

}

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

EAP_FUNC_EXPORT eap_type_mschapv2_c::~eap_type_mschapv2_c()

{

	EAP_TRACE_DEBUG(

		m_am_tools, 

		TRACE_FLAGS_DEFAULT, 

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

		this));

	EAP_ASSERT(m_shutdown_was_called == true);	

	if (m_free_am_type_mschapv2 == true)

	{

		delete m_am_type_mschapv2;

	}

	m_free_am_type_mschapv2 = false;

}

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

EAP_FUNC_EXPORT eap_status_e eap_type_mschapv2_c::shutdown()

{

	EAP_TRACE_DEBUG(

		m_am_tools, 

		TRACE_FLAGS_DEFAULT, 

		(EAPL("eap_type_mschapv2_c::shutdown(): this = 0x%08x, m_session.get_state()=%d, m_is_notification_sent=%d\n"),

		this,

		m_session.get_state(),

		m_is_notification_sent));

	EAP_TRACE_RETURN_STRING(m_am_tools, "returns: eap_type_mschapv2_c::shutdown()");

	m_am_type_mschapv2->shutdown();

	m_shutdown_was_called = true;

	if (m_session.get_state() != eap_type_mschapv2_state_none)

	{

		if (m_is_notification_sent == false)

		{

			finish_unsuccessful_authentication(false);

		}

	}

	return EAP_STATUS_RETURN(m_am_tools, eap_status_ok);

}

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

EAP_FUNC_EXPORT void eap_type_mschapv2_c::set_is_valid()

{

	m_is_valid = true;

}

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

EAP_FUNC_EXPORT bool eap_type_mschapv2_c::get_is_valid()

{

	return m_is_valid;

}

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

EAP_FUNC_EXPORT bool eap_type_mschapv2_c::get_is_client() 

{

	return m_is_client;

}

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

void eap_type_mschapv2_c::send_error_notification(const eap_status_e error)

{

	// Notifies the lower level of an authentication error.

	eap_state_notification_c notification(

		m_am_tools,

		&m_send_network_id,

		m_is_client,

		eap_state_notification_eap,

		eap_protocol_layer_general,

		eap_type_mschapv2,

		eap_state_none,

		eap_general_state_authentication_error,

		0,

		false);

	notification.set_authentication_error(error);

	get_type_partner()->state_notification(&notification);

}

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

eap_buf_chain_wr_c * eap_type_mschapv2_c::create_send_packet(u32_t length)

{

	eap_buf_chain_wr_c * packet = new eap_buf_chain_wr_c(

		eap_write_buffer, 

		m_am_tools,

		length + m_offset + m_trailer_length);

	if (!packet)

	{

		return 0;

	}

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

	{

		delete packet;

		return 0;

	}

	packet->set_data_length(length + m_offset);

	return packet;

}

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

eap_status_e eap_type_mschapv2_c::packet_send(

	eap_buf_chain_wr_c * const data,

	const u32_t data_length)

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

	if (m_mtu_length < data_length)

	{

		return EAP_STATUS_RETURN(m_am_tools, eap_status_process_general_error);

	}

	if (data->get_is_valid_data() == false)

	{

		EAP_TRACE_DEBUG(m_am_tools, TRACE_FLAGS_DEFAULT, (EAPL("packet buffer corrupted.\n")));

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, eap_status_allocation_error);

	}

	eap_status_e status = get_type_partner()->packet_send(

		&m_send_network_id,

		data,

		m_offset,

		data_length,

		data->get_buffer_length());

	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_mschapv2_c::finish_successful_authentication()

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

	EAP_TRACE_DEBUG(

		m_am_tools,

		TRACE_FLAGS_DEFAULT,

		(EAPL("EAP_type_MSCHAPV2: %s: EAP-SUCCESS: function: eap_type_mschapv2_c::finish_successful_authentication()\n"),

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

	EAP_TRACE_RETURN_STRING(m_am_tools, "returns: eap_type_mschapv2_c::finish_successful_authentication()");

	eap_state_notification_c notification(

		m_am_tools,

		&m_send_network_id,

		m_is_client,

		eap_state_notification_eap,

		eap_protocol_layer_eap,

		eap_type_mschapv2,

		eap_state_none,

		eap_state_authentication_finished_successfully,

		m_identifier,

		true);

	get_type_partner()->state_notification(&notification);

	// set notification flag

	m_is_notification_sent = true;

	// Store credential for reauthentication (client only)

	//if (m_is_client)

	{

		eap_variable_data_c key(m_am_tools);

		eap_status_e status = m_am_type_mschapv2->get_memory_store_key(&key);

		if (status != eap_status_ok)

		{

			EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

			return EAP_STATUS_RETURN(m_am_tools, status);

		}

		status = key.add_data(

			&m_is_client,

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

		}

		// Remove the old data. Do not care status.

		(void) m_am_tools->memory_store_remove_data(&key);

		EAP_TRACE_DEBUG(

			m_am_tools,

			TRACE_FLAGS_DEFAULT,

			(EAPL("%s: EAP_type_MSCHAPV2: finish_successful_authentication(): Credentials removed from mem store\n"),

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

		// Store the creditials always, if the password prompt is NOT enabled or

		// if the Session is valid.

		if(m_password_prompt_enabled == false 

			|| m_am_type_mschapv2->is_session_valid() == true)

		{

			EAP_TRACE_DEBUG(

				m_am_tools,

				TRACE_FLAGS_DEFAULT,

				(EAPL("%s: EAP_type_MSCHAPV2: finish_successful_authentication(): Session valid or PW prompt disabled, Storing Credentials\n"),

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

			eap_tlv_message_data_c tlv_data(m_am_tools);

			status = tlv_data.add_message_data(

				eap_type_mschapv2_stored_username,

				m_username_utf8.get_data_length(),

				m_username_utf8.get_data());

			if (status != eap_status_ok)

			{

				EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

				return EAP_STATUS_RETURN(m_am_tools, status);

			}

			status = tlv_data.add_message_data(

				eap_type_mschapv2_stored_password,

				m_password_utf8.get_data_length(),

				m_password_utf8.get_data());

			if (status != eap_status_ok)

			{

				EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

				return EAP_STATUS_RETURN(m_am_tools, status);

			}

#if defined(EAP_MSCHAPV2_SERVER)

			status = tlv_data.add_message_data(

				eap_type_mschapv2_stored_password_expired_flag,

				sizeof(m_password_expired),

				&m_password_expired);

			if (status != eap_status_ok)

			{

				EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

				return EAP_STATUS_RETURN(m_am_tools, status);

			}

#endif //#if defined(EAP_MSCHAPV2_SERVER)

			status = m_am_tools->memory_store_add_data(

				&key,

				&tlv_data,

				eap_type_default_credential_timeout);

			if (status != eap_status_ok)

			{

				EAP_TRACE_DEBUG(

					m_am_tools,

					TRACE_FLAGS_DEFAULT,

					(EAPL("EAP_type_MSCHAPV2: finish_successful_authentication(): cannot store credentials\n")));

				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("%s: EAP_type_MSCHAPV2: finish_successful_authentication(): Credentials stored \n"),

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

		} // End of if(m_password_prompt_enabled == true ....

	}

	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_mschapv2_c::finish_unsuccessful_authentication(

	const bool authentication_cancelled)

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

	EAP_TRACE_DEBUG(

		m_am_tools,

		TRACE_FLAGS_DEFAULT,

		(EAPL("ERROR: %s: EAP_type_MSCHAPV2: FAILED: function: eap_type_mschapv2_c::finish_unsuccessful_authentication()\n"),

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

	EAP_TRACE_RETURN_STRING(m_am_tools, "returns: eap_type_mschapv2_c::finish_unsuccessful_authentication()");

	if (m_is_client == true)

	{

		if (authentication_cancelled == true)

		{

			eap_state_notification_c notification(

				m_am_tools,

				&m_send_network_id,

				m_is_client,

				eap_state_notification_eap,

				eap_protocol_layer_general, // This must be used with eap_general_state_authentication_cancelled.

				eap_type_mschapv2,

				eap_state_none,

				eap_general_state_authentication_cancelled,

				m_identifier,

				false);

			notification.set_authentication_error(eap_status_authentication_failure);

			get_type_partner()->state_notification(&notification);

		}

		else

		{			

			eap_state_notification_c notification(

				m_am_tools,

				&m_send_network_id,

				m_is_client,

				eap_state_notification_eap,

				eap_protocol_layer_eap,

				eap_type_mschapv2,

				eap_state_none,

				eap_state_authentication_terminated_unsuccessfully,

				m_identifier,

				false);

			notification.set_authentication_error(eap_status_authentication_failure);

			get_type_partner()->state_notification(&notification);

		}		

#if defined(USE_USER_NOTIFICATIONS)

		eap_variable_data_c string(m_am_tools);

		eap_status_e status = m_am_type_mschapv2->read_auth_failure_string(EAP_MSCHAPV2_ERROR_AUTHENTICATION_FAILURE, string);

		if (status == eap_status_ok)

		{

			eap_state_notification_c notification(

				m_am_tools,

				&m_send_network_id,

				m_is_client,

				eap_state_notification_eap,

				eap_protocol_layer_general, // This must be used with eap_general_state_show_notification_string.

				eap_type_mschapv2,

				eap_state_none,

				eap_general_state_show_notification_string,

				0,

				false);

			status = notification.set_notification_string(&string, true);

			if (status == eap_status_ok)

			{

				get_type_partner()->state_notification(&notification);

			}

		}

#endif //#if defined(USE_USER_NOTIFICATIONS)

	}

	else

	{			

		eap_state_notification_c notification(

			m_am_tools,

			&m_send_network_id,

			m_is_client,

			eap_state_notification_eap,

			eap_protocol_layer_eap,

			eap_type_mschapv2,

			eap_state_none,

			eap_state_authentication_terminated_unsuccessfully,

			m_identifier,

			false);

		notification.set_authentication_error(eap_status_authentication_failure);

		get_type_partner()->state_notification(&notification);

	}

	EAP_TRACE_DEBUG(

		m_am_tools,

		TRACE_FLAGS_DEFAULT,

		(EAPL("%s: EAP_type_MSCHAPV2: finish_unsuccessful_authentication(): EAP-FAILED\n"),

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

	// set notification flag

	m_is_notification_sent = true;

	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_mschapv2_c::packet_process(

	const eap_am_network_id_c * const /*receive_network_id*/,

	eap_header_wr_c * const received_eap,

	const u32_t eap_packet_length)

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

	eap_status_e status = eap_status_drop_packet_quietly;

	if (eap_packet_length > received_eap->get_header_buffer_length())

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, eap_status_drop_packet_quietly);

	}