/*

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

	#undef EAP_FILE_NUMBER_DATE 

	#define EAP_FILE_NUMBER_DATE 1127594498 

#endif //#if defined(USE_EAP_MINIMUM_RELEASE_TRACES)

#if !defined(NO_EAPOL_KEY_STATE_SERVER)

#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_1(

	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 eapol_protocol_version_e used_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_1()\n"),

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

	// Only server (Authenticator) could create 4-Way Handshake message 1.

	EAP_ASSERT_ALWAYS(m_is_client == false);

	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_ANonce.get_is_valid_data() == false

		|| m_ANonce.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_1(): ")

			 EAPL("m_ANonce 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_PMKID.get_is_valid_data() == false

		|| m_PMKID.get_data_length()

		!= eapol_RSNA_key_header_c::EAPOL_RSNA_KEY_DATA_PMKID_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_1(): ")

			 EAPL("m_PMKID 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();

	if (get_is_RSNA() == true)

	{

		eapol_key_data_length += EAPOL_RSNA_4_WAY_HANDSHAKE_MESSAGE_1_KEY_DATA_LENGTH_BYTES;

	}

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

		get_key_reply_counter(),

		true, // Pairwise key type bit is on.

		false, // Install bit is NOT set.

		true, // Key Ack bit is on.

		false, // Key MIC bit is NOT set.

		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.

		used_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 ANonce.

		u8_t * const nonce_field = eapol_key_message.get_key_NONCE();

		if (nonce_field == 0

			|| m_ANonce.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_ANonce.get_data(eapol_RSNA_key_header_c::EAPOL_RSNA_KEY_NONCE_SIZE),

			eapol_RSNA_key_header_c::EAPOL_RSNA_KEY_NONCE_SIZE);

	}

	if (get_is_RSNA() == true)

	{

		if (m_skip_PMKID_key_data_in_message_1 == false)

		{

			// Add PMKID to Key Data.

			eapol_rsna_key_data_header_c key_data_header(

				m_am_tools,

				get_is_RSNA(),

				get_is_WPXM(),

				eapol_key_message.get_key_data(

						EAPOL_RSNA_4_WAY_HANDSHAKE_MESSAGE_1_KEY_DATA_LENGTH_BYTES),

				EAPOL_RSNA_4_WAY_HANDSHAKE_MESSAGE_1_KEY_DATA_LENGTH_BYTES);

			if (key_data_header.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 = key_data_header.reset_header();

			if (status != eap_status_ok)

			{

				EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

				return EAP_STATUS_RETURN(m_am_tools, status);

			}

			// Here Type and Length fields are NOT included.

			status = key_data_header.set_length(

				EAPOL_RSNA_4_WAY_HANDSHAKE_MESSAGE_1_KEY_DATA_LENGTH_BYTES - 2ul);

			if (status != eap_status_ok)

			{

				EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

				return EAP_STATUS_RETURN(m_am_tools, status);

			}

			status = key_data_header.set_payload_type(eapol_RSNA_key_payload_type_pmkid);

			if (status != eap_status_ok)

			{

				EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

				return EAP_STATUS_RETURN(m_am_tools, status);

			}

			u8_t * const PMKID_field = key_data_header.get_key_data_payload(

				eapol_RSNA_key_header_c::EAPOL_RSNA_KEY_DATA_PMKID_SIZE);

			if (PMKID_field == 0)

			{

				EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

				return EAP_STATUS_RETURN(m_am_tools, eap_status_allocation_error);

			}

			EAP_TRACE_DEBUG(m_am_tools, TRACE_FLAGS_DEFAULT|TRACE_TEST_VECTORS,

				(EAPL("EAPOL_KEY: PMKID_field = 0x%08x\n"),

				PMKID_field));

			EAP_TRACE_DATA_DEBUG(m_am_tools, TRACE_FLAGS_DEFAULT|TRACE_TEST_VECTORS,

				(EAPL("m_PMKID"),

				m_PMKID.get_data(eapol_RSNA_key_header_c::EAPOL_RSNA_KEY_DATA_PMKID_SIZE),

				eapol_RSNA_key_header_c::EAPOL_RSNA_KEY_DATA_PMKID_SIZE));

			m_am_tools->memmove(

				PMKID_field,

				m_PMKID.get_data(eapol_RSNA_key_header_c::EAPOL_RSNA_KEY_DATA_PMKID_SIZE),

				eapol_RSNA_key_header_c::EAPOL_RSNA_KEY_DATA_PMKID_SIZE);

			EAPOL_RSNA_KEY_DATA_TRACE_PAYLOAD(

				get_is_RSNA(),

				get_is_WPXM(),

				eapol_key_message.get_key_descriptor_type(),

				"Added EAPOL Key Data key_data_payload",

				&key_data_header,

				0ul);

			status = eapol_key_message.set_key_data_length(

				EAPOL_RSNA_4_WAY_HANDSHAKE_MESSAGE_1_KEY_DATA_LENGTH_BYTES);

			if (status != eap_status_ok)

			{

				EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

				return EAP_STATUS_RETURN(m_am_tools, status);

			}

		}

		u16_t key_length(0ul);

		status = get_key_length(

			m_eapol_pairwise_cipher,

			&key_length);

		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_length(key_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);

	}

	sent_packet->set_data_length(

		eapol_header_offset + *data_length);

	TRACE_EAPOL_KEY_MESSAGE(

		"Send 4-Way Handshake Message 1",

		&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_3(

	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 eapol_protocol_version_e used_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_3()\n"),

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

	// Only server (Authenticator) could create 4-Way Handshake message 3.

	EAP_ASSERT_ALWAYS(m_is_client == false);

	if (m_ANonce.get_is_valid_data() == false

		|| m_ANonce.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_3(): ")

			 EAPL("m_ANonce 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_authenticator_RSNA_IE.get_is_valid_data() == false

		|| m_authenticator_RSNA_IE.get_data_length() == 0ul

		|| m_authenticator_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_3(): ")

			 EAPL("m_authenticator_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_authenticator_RSNA_IE.get_data_length();

	u32_t extra_encryption_padding_and_block(0ul);

	if (m_eapol_pairwise_cipher == eapol_RSNA_key_header_c::eapol_RSNA_cipher_CCMP

		|| m_eapol_group_cipher == eapol_RSNA_key_header_c::eapol_RSNA_cipher_CCMP)

	{

		extra_encryption_padding_and_block = 2ul * EAP_CRYPTO_AES_WRAP_BLOCK_SIZE;

	}

	if ((get_is_RSNA() == true

			&& m_eapol_group_cipher != eapol_RSNA_key_header_c::eapol_RSNA_cipher_none)

		|| (get_is_WPXM() == true

				&& received_key_descriptor_type == eapol_key_descriptor_type_RSNA))

	{

		u16_t GTK_length = 0ul;

		status = get_key_length(m_eapol_group_cipher, &GTK_length);

		if (status != eap_status_ok)

		{

			EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

			return EAP_STATUS_RETURN(m_am_tools, status);

		}

		// Creates GTK.

		status = create_nonce(&m_group_GTK, GTK_length);

		if (status != eap_status_ok)

		{

			EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

			return EAP_STATUS_RETURN(m_am_tools, status);

		}

		eapol_key_data_length +=

			eapol_rsna_key_data_header_c::EAPOL_RSNA_KEY_HEADER_LENGTH

			+ eapol_rsna_key_data_header_c::EAPOL_RSNA_KEY_ID_AND_GROUP_KEY_HEADER_SIZE

			+ m_group_GTK.get_data_length();

	}

	*buffer_length

		= eapol_header_offset

		+ eapol_key_data_length

		+ extra_encryption_padding_and_block;

	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 = false; // Secure bit is NOT set in WPA.

	bool encrypted_key_data = false; // Encrypted Key Data bit is NOT set in WPA.

	if (get_is_RSNA() == true

		|| (get_is_WPXM() == true

				&& received_key_descriptor_type == eapol_key_descriptor_type_RSNA))

	{

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

		encrypted_key_data = true; // Encrypted Key Data bit is on in RSNA.

	}

	status = eapol_key_message.reset_header(

		0ul,

		m_authentication_type,

		m_eapol_pairwise_cipher,

		get_key_reply_counter(),

		true, // Pairwise key type bit is on.

		true, // Install bit is on. /** @{ This could be false when AP does not support key mapping keys. } */

		true, // Key Ack bit is on.

		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.

		encrypted_key_data,

		used_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 ANonce.

		u8_t * const nonce_field = eapol_key_message.get_key_NONCE();

		if (nonce_field == 0

			|| m_ANonce.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_ANonce.get_data(eapol_RSNA_key_header_c::EAPOL_RSNA_KEY_NONCE_SIZE),

			eapol_RSNA_key_header_c::EAPOL_RSNA_KEY_NONCE_SIZE);

	}

	if (m_eapol_pairwise_cipher == eapol_RSNA_key_header_c::eapol_RSNA_cipher_TKIP)

	{

		// Add Key IV.

		// Creates EAPOL-Key IV.

		status = create_nonce(&m_EAPOL_key_IV, eapol_RSNA_key_header_c::EAPOL_RSNA_EAPOL_KEY_IV_SIZE);

		if (status != eap_status_ok)

		{

			EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

			return EAP_STATUS_RETURN(m_am_tools, status);

		}

		u8_t * const key_iv_field = eapol_key_message.get_EAPOL_key_IV();

		if (key_iv_field == 0

			|| m_EAPOL_key_IV.get_data_length() < eapol_RSNA_key_header_c::EAPOL_RSNA_EAPOL_KEY_IV_SIZE)

		{

			EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

			return EAP_STATUS_RETURN(m_am_tools, eap_status_allocation_error);

		}

		// Note only the lower sixteen octets of the counter are value are used.

		u32_t offset = m_EAPOL_key_IV.get_data_length() - eapol_RSNA_key_header_c::EAPOL_RSNA_EAPOL_KEY_IV_SIZE;

		u8_t * const iv_data = m_EAPOL_key_IV.get_data_offset(offset, eapol_RSNA_key_header_c::EAPOL_RSNA_EAPOL_KEY_IV_SIZE);

		if (iv_data == 0)

		{

			EAP_TRACE_END(m_am_tools, TRACE_FLAGS_DEFAULT);

			return EAP_STATUS_RETURN(m_am_tools, eap_status_illegal_parameter);

		}

		m_am_tools->memmove(

			key_iv_field,

			iv_data,

			eapol_RSNA_key_header_c::EAPOL_RSNA_EAPOL_KEY_IV_SIZE);

	}

	/**

	 * @{ Missing payload: starting sequence Authenticator's STA will use in packets protected by GTK. }

	 */

	u32_t total_key_data_length(0ul);

	status = add_RSN_IE_payload(

		&eapol_key_message,

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

	}

	/**

	 * @{ Missing payload: a second RSN IE that is Authenticator's unicast cipher suite assigment. }

	 */

	/**