/*

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

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

#include "eapol_key_header.h"

#include "eap_crypto_api.h"

#include "abs_eap_am_mutex.h"

#include "eap_state_notification.h"

#include "eap_automatic_variable.h"

#include "eapol_rsna_key_data_gtk_header.h"

#include "eap_buffer.h"

#include "eapol_rsna_key_data_payloads.h"

#include "abs_eapol_key_state.h"

#include "eapol_rc4_key_header.h"

#include "eapol_key_state_string.h"

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

//

eap_status_e eapol_key_state_c::create_4_way_handshake_message_2(

	eap_buf_chain_wr_c * const sent_packet,

	const u32_t eapol_header_offset,

	u32_t * const data_length,

	u32_t * const buffer_length,

	const u64_t received_key_replay_counter,

	const eapol_protocol_version_e received_eapol_version,

	const eapol_key_descriptor_type_e received_key_descriptor_type)

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

	eap_status_e status = eap_status_process_general_error;

	EAP_TRACE_DEBUG(

		m_am_tools, 

		TRACE_FLAGS_DEFAULT, 

		(EAPL("EAPOL_KEY: %s: eapol_key_state_c::create_4_way_handshake_message_2()\n"),

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

	// Only client (Supplicant) could create 4-Way Handshake message 2.

	EAP_ASSERT_ALWAYS(m_is_client == true);

	if (sent_packet == 0

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

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, eap_status_illegal_parameter);

	}

	if (m_SNonce.get_is_valid_data() == false

		|| m_SNonce.get_data_length() != eapol_RSNA_key_header_c::EAPOL_RSNA_KEY_NONCE_SIZE)

	{

		EAP_TRACE_ERROR(

			m_am_tools,

			TRACE_FLAGS_EAPOL_KEY_DATA_ERROR,

			(EAPL("ERROR: EAPOL_KEY: eapol_key_state_c::create_4_way_handshake_message_2(): ")

			 EAPL("m_SNonce is missing or corrupted.\n")));

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, eap_status_illegal_parameter);

	}

	if (m_supplicant_RSNA_IE.get_is_valid_data() == false

		|| m_supplicant_RSNA_IE.get_data_length() == 0ul

		|| m_supplicant_RSNA_IE.get_data_length()

		> eapol_RSNA_key_header_c::EAPOL_RSNA_KEY_DATA_MAXIMUM_RSN_IE_SIZE)

	{

		EAP_TRACE_ERROR(

			m_am_tools,

			TRACE_FLAGS_EAPOL_KEY_DATA_ERROR,

			(EAPL("ERROR: EAPOL_KEY: eapol_key_state_c::create_4_way_handshake_message_2(): ")

			 EAPL("m_supplicant_RSNA_IE is missing or corrupted.\n")));

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, eap_status_illegal_parameter);

	}

	u32_t eapol_key_data_length

		= eapol_RSNA_key_header_c::get_header_length()

		+ m_supplicant_RSNA_IE.get_data_length();

	*buffer_length

		= eapol_header_offset

		+ eapol_key_data_length;

	status = sent_packet->set_buffer_length(

		*buffer_length);

	if (status != eap_status_ok)

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, status);

	}

	sent_packet->set_data_length(

		sent_packet->get_buffer_length());

	eapol_RSNA_key_header_c eapol_key_message(

		m_am_tools,

		get_is_RSNA(),

		get_is_WPXM(),

		sent_packet->get_data_offset(eapol_header_offset, eapol_key_data_length),

		sent_packet->get_data_length());

	if (eapol_key_message.get_is_valid() == false)

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, eap_status_allocation_error);

	}

	status = eapol_key_message.reset_header(

		0ul,

		m_authentication_type,

		m_eapol_pairwise_cipher,

		received_key_replay_counter,

		true, // Pairwise key type bit is on.

		false, // Install bit is NOT set.

		false, // Key Ack bit is NOT set.

		true, // Key MIC bit is on.

		false, // Secure bit is NOT set.

		false, // Error bit is NOT set.

		false, // Request bit is NOT set.

		false, // STAKey bit is NOT set.

		false, // Encrypted Key Data bit is NOT set.

		received_eapol_version,

		received_key_descriptor_type);

	if (status != eap_status_ok)

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, status);

	}

	{

		// Add SNonce.

		u8_t * const nonce_field = eapol_key_message.get_key_NONCE();

		if (nonce_field == 0

			|| m_SNonce.get_data_length() != eapol_RSNA_key_header_c::EAPOL_RSNA_KEY_NONCE_SIZE)

		{

			EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

			return EAP_STATUS_RETURN(m_am_tools, eap_status_allocation_error);

		}

		m_am_tools->memmove(

			nonce_field,

			m_SNonce.get_data(eapol_RSNA_key_header_c::EAPOL_RSNA_KEY_NONCE_SIZE),

			eapol_RSNA_key_header_c::EAPOL_RSNA_KEY_NONCE_SIZE);

	}

	u32_t total_key_data_length(0ul);

	status = add_RSN_IE_payload(

		&eapol_key_message,

		&m_supplicant_RSNA_IE,

		&total_key_data_length);

	if (status != eap_status_ok)

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, status);

	}

	if (total_key_data_length > 0xffff)

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, eap_status_too_long_message);

	}

	status = eapol_key_message.set_key_data_length(

		static_cast<u16_t>(total_key_data_length));

	if (status != eap_status_ok)

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, status);

	}

	*data_length

		= eapol_key_message.get_header_length()

		+ eapol_key_message.get_key_data_length();

	status = eapol_key_message.set_eapol_packet_body_length(

		static_cast<u16_t>(*data_length - eapol_header_base_c::get_header_length()));

	if (status != eap_status_ok)

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, status);

	}

	const eap_variable_data_c * confirmation_key = &m_confirmation_KCK;

#if defined(EAP_USE_WPXM)

	if (get_is_WPXM() == true)

	{

		confirmation_key = &m_WPXM_WPXK1;

	}

#endif //#if defined(EAP_USE_WPXM)

	status = create_key_mic(

		&eapol_key_message,

		confirmation_key);

	if (status != eap_status_ok)

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, status);

	}

#if defined(USE_EAPOL_KEY_TEST_FAILURES)

	if (m_create_key_failure == eapol_key_state_wait_4_way_handshake_message_1)

	{

		m_create_key_failure = eapol_key_state_wait_4_way_handshake_message_3;

		status = eapol_key_message.zero_key_MIC(m_am_tools);

		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("WARNING: EAPOL_KEY: %s: error generated in eapol_key_state_c::create_4_way_handshake_message_2()\n"),

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

	}

#endif //#if defined(USE_EAPOL_KEY_TEST_FAILURES)

	sent_packet->set_data_length(

		eapol_header_offset + *data_length);

	TRACE_EAPOL_KEY_MESSAGE(

		"Send 4-Way Handshake Message 2",

		&eapol_key_message);

	EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

	return EAP_STATUS_RETURN(m_am_tools, status);

}

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

//

eap_status_e eapol_key_state_c::create_4_way_handshake_message_4(

	eap_buf_chain_wr_c * const sent_packet,

	const u32_t eapol_header_offset,

	u32_t * const data_length,

	u32_t * const buffer_length,

	const u64_t received_key_replay_counter,

	const bool received_secure_bit,

	const eapol_protocol_version_e received_eapol_version,

	const eapol_key_descriptor_type_e received_key_descriptor_type)

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

	eap_status_e status = eap_status_process_general_error;

	EAP_TRACE_DEBUG(

		m_am_tools, 

		TRACE_FLAGS_DEFAULT, 

		(EAPL("EAPOL_KEY: %s: eapol_key_state_c::create_4_way_handshake_message_4()\n"),

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

	// Only client (Supplicant) could create 4-Way Handshake message 4.

	EAP_ASSERT_ALWAYS(m_is_client == true);

	if (sent_packet == 0

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

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, eap_status_illegal_parameter);

	}

	u32_t eapol_key_data_length

		= eapol_RSNA_key_header_c::get_header_length();

	*buffer_length

		= eapol_header_offset

		+ eapol_key_data_length;

	status = sent_packet->set_buffer_length(

		*buffer_length);

	if (status != eap_status_ok)

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, status);

	}

	sent_packet->set_data_length(

		sent_packet->get_buffer_length());

	eapol_RSNA_key_header_c eapol_key_message(

		m_am_tools,

		get_is_RSNA(),

		get_is_WPXM(),

		sent_packet->get_data_offset(eapol_header_offset, eapol_key_data_length),

		sent_packet->get_data_length());

	if (eapol_key_message.get_is_valid() == false)

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, eap_status_allocation_error);

	}

	bool secure_bit = received_secure_bit; // Secure bit is the same as in the received WPA 4-Way Handshake message 3.

	if (get_is_RSNA() == true)

	{

		secure_bit = true; // Secure bit is on in RSNA.

	}

	status = eapol_key_message.reset_header(

		0ul,

		m_authentication_type,

		m_eapol_pairwise_cipher,

		received_key_replay_counter,

		true, // Pairwise key type bit is on.

		false, // Install bit is NOT set.

		false, // Key Ack bit is NOT set.

		true, // Key MIC bit is on.

		secure_bit,

		false, // Error bit is NOT set.

		false, // Request bit is NOT set.

		false, // STAKey bit is NOT set.

		false, // Encrypted Key Data bit is NOT set.

		received_eapol_version,

		received_key_descriptor_type);

	if (status != eap_status_ok)

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, status);

	}

	status = eapol_key_message.set_key_data_length(0ul);

	if (status != eap_status_ok)

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, status);

	}

	*data_length

		= eapol_key_message.get_header_length()

		+ eapol_key_message.get_key_data_length();

	status = eapol_key_message.set_eapol_packet_body_length(

		static_cast<u16_t>(*data_length - eapol_header_base_c::get_header_length()));

	if (status != eap_status_ok)

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, status);

	}

	status = create_key_mic(

		&eapol_key_message,

		&m_confirmation_KCK);

	if (status != eap_status_ok)

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, status);

	}

#if defined(USE_EAPOL_KEY_TEST_FAILURES)

	if (m_create_key_failure == eapol_key_state_wait_4_way_handshake_message_3)

	{

		m_create_key_failure = eapol_key_state_4_way_handshake_successfull;

		status = eapol_key_message.zero_key_MIC(m_am_tools);

		if (status != eap_status_ok)

		{

			EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

			return EAP_STATUS_RETURN(m_am_tools, status);

		}

		EAP_TRACE_ERROR(

			m_am_tools, 

			TRACE_FLAGS_DEFAULT, 

			(EAPL("WARNING: EAPOL_KEY: %s: error generated in eapol_key_state_c::create_4_way_handshake_message_4()\n"),

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

	}

#endif //#if defined(USE_EAPOL_KEY_TEST_FAILURES)

	sent_packet->set_data_length(

		eapol_header_offset + *data_length);

	TRACE_EAPOL_KEY_MESSAGE(

		"Send 4-Way Handshake Message 4",

		&eapol_key_message);

	EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

	return EAP_STATUS_RETURN(m_am_tools, status);

}

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

//

eap_status_e eapol_key_state_c::process_4_way_handshake_message_1(

	const eap_am_network_id_c * const receive_network_id,

	eapol_RSNA_key_header_c * const eapol_key_message,

	const u32_t /* packet_length */)

{

	EAP_TRACE_BEGIN(m_am_tools, TRACE_FLAGS_DEFAULT);

	EAP_UNREFERENCED_PARAMETER(receive_network_id);

	eap_status_e status = eap_status_process_general_error;

	eapol_key_state_string_c state_string;

	EAP_TRACE_DEBUG(

		m_am_tools, 

		TRACE_FLAGS_DEFAULT, 

		(EAPL("EAPOL_KEY: %s: eapol_key_state_c::process_4_way_handshake_message_1(): eapol_key_descriptor_type = %s = 0x%02x\n"),

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

		state_string.get_eapol_key_descriptor_type_string(eapol_key_message->get_key_descriptor_type()),

		eapol_key_message->get_key_descriptor_type()));

	EAP_TRACE_RETURN_STRING(m_am_tools, "returns: eapol_key_state_c::process_4_way_handshake_message_1()");

	// Only client (supplicant) could receive 4-Way Handshake message 1.

	EAP_ASSERT_ALWAYS(m_is_client == true);

	if (m_eapol_key_handshake_type == eapol_key_handshake_type_none)

	{

		// 4-Way Handshake started again.

		m_eapol_key_handshake_type = eapol_key_handshake_type_4_way_handshake;

		set_eapol_key_state(eapol_key_state_wait_4_way_handshake_message_1);

		EAP_TRACE_ALWAYS(

			m_am_tools,

			TRACE_FLAGS_DEFAULT,

			(EAPL("EAPOL_KEY: %s: process_4_way_handshake_message_1(): 4-Way Handshake restarted.\n"),

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

	}

	if (get_eapol_key_state() != eapol_key_state_wait_4_way_handshake_message_1

		&& get_eapol_key_state() != eapol_key_state_wait_4_way_handshake_message_3

		&& get_eapol_key_state() != eapol_key_state_4_way_handshake_successfull

		&& get_eapol_key_state() != eapol_key_state_preauthenticated

#if defined(EAP_USE_WPXM)

		&& get_eapol_key_state() != eapol_key_state_wpxm_reassociation_finished_successfull

#endif //#if defined(EAP_USE_WPXM)

		)

	{

		EAP_TRACE_ERROR(

			m_am_tools,

			TRACE_FLAGS_DEFAULT,

			(EAPL("WARNING: EAPOL_KEY: %s: process_4_way_handshake_message_1(): wrong state %s\n"),

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

			state_string.get_eapol_key_state_string(get_eapol_key_state())));

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, eap_status_wrong_eap_type_state);

	}

	// Some APs seems to behave incorrectly and

	// fills the IV field with non-zero stuff. For this reason don't verify the field to be 0.

	status = verify_field_is_zero(

		eapol_key_message->get_key_RSC(),

		eapol_RSNA_key_header_c::EAPOL_RSNA_KEY_RSC_SIZE);

	if (status != eap_status_ok)

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, status);

	}

	/**

	 * @{ In 802.11i D3.0 this field is Key ID instead of STA MAC address. }

	 */

	status = verify_field_is_zero(

		eapol_key_message->get_key_STA_MAC_address(),

		eapol_RSNA_key_header_c::EAPOL_RSNA_KEY_STA_MAC_ADDRESS_SIZE);

	if (status != eap_status_ok)

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, status);

	}

	if (m_allow_non_zero_mic_and_reserved_in_message_1 == false)

	{

		status = verify_field_is_zero(

			eapol_key_message->get_key_reserved(),

			eapol_RSNA_key_header_c::EAPOL_RSNA_KEY_RESERVED_SIZE);

		if (status != eap_status_ok)

		{

			EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

			return EAP_STATUS_RETURN(m_am_tools, status);

		}

		status = verify_field_is_zero(

			eapol_key_message->get_key_MIC(),

			eapol_RSNA_key_header_c::EAPOL_RSNA_KEY_MIC_SIZE);

		if (status != eap_status_ok)

		{

			EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

			return EAP_STATUS_RETURN(m_am_tools, status);

		}

	}

	// Save ANonce.

	const u8_t * const ANonce = eapol_key_message->get_key_NONCE();

	if (ANonce == 0)

	{

		EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

		return EAP_STATUS_RETURN(m_am_tools, eap_status_process_illegal_packet_error);

	}

	status = m_ANonce.set_copy_of_buffer(

		ANonce,

		eapol_RSNA_key_header_c::EAPOL_RSNA_KEY_NONCE_SIZE);