/*

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

	#undef EAP_FILE_NUMBER_DATE 

	#define EAP_FILE_NUMBER_DATE 1127594498 

#endif //#if defined(USE_EAP_MINIMUM_RELEASE_TRACES)

#include "eapol_rsna_key_header.h"

#include "eap_automatic_variable.h"

#include "eapol_key_state_string.h"

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

//

EAP_FUNC_EXPORT eapol_RSNA_key_header_c::~eapol_RSNA_key_header_c()

{

}

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

//

EAP_FUNC_EXPORT eapol_RSNA_key_header_c::eapol_RSNA_key_header_c(

	abs_eap_am_tools_c * const tools,

	const bool is_RSNA_when_true,

	const bool is_WPXM_when_true,

	void * const header_begin,

	const u32_t header_buffer_length)

	: eap_general_header_base_c(tools, header_begin, header_buffer_length)

	, m_am_tools(tools)

	, m_is_RSNA_when_true(is_RSNA_when_true)

	, m_is_WPXM_when_true(is_WPXM_when_true)

{

}

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

//

EAP_FUNC_EXPORT eap_status_e eapol_RSNA_key_header_c::set_key_information(const u16_t info)

{

	u8_t * const data = get_header_offset(m_offset_key_information, sizeof(u16_t));

	if (data != 0)

	{

		return eap_write_u16_t_network_order(data, sizeof(u16_t), info);

	}

	else

	{

		// ERROR.

		return EAP_STATUS_RETURN(m_am_tools, eap_status_allocation_error);

	}

}	

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

//

EAP_FUNC_EXPORT eapol_protocol_version_e eapol_RSNA_key_header_c::get_eapol_protocol_version() const

{

	const u8_t * const data = get_header_offset(m_offset_eapol_version, sizeof(u8_t));

	if (data != 0)

	{

		return static_cast<eapol_protocol_version_e>(*data);

	}

	else

	{

		return eapol_protocol_version_none;

	}

}

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

//

EAP_FUNC_EXPORT eapol_packet_type_e eapol_RSNA_key_header_c::get_eapol_packet_type() const

{

	const u8_t * const data = get_header_offset(m_offset_eapol_type, sizeof(u8_t));

	if (data != 0)

	{

		return static_cast<eapol_packet_type_e>(*data);

	}

	else

	{

		return eapol_packet_type_no_type;

	}

}

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

//

EAP_FUNC_EXPORT u16_t eapol_RSNA_key_header_c::get_eapol_packet_body_length() const

{

	const u8_t * const data = get_header_offset(m_offset_eapol_packet_body_length, sizeof(u16_t));

	if (data != 0)

	{

		return eap_read_u16_t_network_order(data, sizeof(u16_t));

	}

	else

	{

		return 0ul;

	}

}

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

//

EAP_FUNC_EXPORT u16_t eapol_RSNA_key_header_c::get_eapol_packet_length() const

{

	// m_offset_key_descriptor_type is the length of the EAPOL header.

	// Including fields Version, Type and Packet Body Length.

	return static_cast<u16_t>(get_eapol_packet_body_length() + m_offset_key_descriptor_type);

}

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

//

EAP_FUNC_EXPORT eapol_key_descriptor_type_e eapol_RSNA_key_header_c::get_key_descriptor_type() const

{

	const u8_t * const data = get_header_offset(m_offset_key_descriptor_type, sizeof(u8_t));

	if (data != 0)

	{

		return static_cast<eapol_key_descriptor_type_e>(*data);

	}

	else

	{

		return eapol_key_descriptor_type_none;

	}

}

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

//

EAP_FUNC_EXPORT u16_t eapol_RSNA_key_header_c::get_key_information() const

{

	const u8_t * const data = get_header_offset(m_offset_key_information, sizeof(u16_t));

	if (data != 0)

	{

		return eap_read_u16_t_network_order(data, sizeof(u16_t));

	}

	else

	{

		// ERROR.

		return 0ul;

	}

}	

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

//

EAP_FUNC_EXPORT eapol_RSNA_key_header_c::key_descriptor_version_e eapol_RSNA_key_header_c::get_key_information_key_descriptor_version() const

{

	const u16_t key_information = get_key_information();

	return static_cast<key_descriptor_version_e>((key_information & m_key_information_mask_key_descriptor_version)

		>> m_key_information_mask_key_descriptor_version_shift);

}

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

//

EAP_FUNC_EXPORT bool eapol_RSNA_key_header_c::get_key_information_key_type() const

{

	const u16_t key_information = get_key_information();

	const u16_t key_type = static_cast<u16_t>(key_information & m_key_information_mask_key_type);

	if (key_type != 0)

	{

		return true;

	}

	else

	{

		return false;

	}

}

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

//

EAP_FUNC_EXPORT u8_t eapol_RSNA_key_header_c::get_key_information_reserved_a() const

{

	EAP_ASSERT(m_is_RSNA_when_true == true || m_is_WPXM_when_true == true);

	const u16_t key_information = get_key_information();

	return static_cast<u8_t>((key_information & m_key_information_mask_reserved_a_RSNA)

		>> m_key_information_mask_reserved_a_shift_RSNA);

}

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

//

EAP_FUNC_EXPORT u8_t eapol_RSNA_key_header_c::get_key_information_key_index() const

{

	EAP_ASSERT(m_is_RSNA_when_true == false || m_is_WPXM_when_true == true);

	const u16_t key_information = get_key_information();

	return static_cast<u8_t>((key_information & m_key_information_mask_key_index_WPA)

		>> m_key_information_mask_key_index_shift_WPA);

}

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

//

EAP_FUNC_EXPORT bool eapol_RSNA_key_header_c::get_key_information_install() const

{

	const u16_t key_information = get_key_information();

	const u16_t key_type = static_cast<u16_t>(key_information & m_key_information_mask_install);

	if (key_type != 0)

	{

		return true;

	}

	else

	{

		return false;

	}

}

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

//

EAP_FUNC_EXPORT bool eapol_RSNA_key_header_c::get_key_information_key_ack() const

{

	const u16_t key_information = get_key_information();

	const u16_t key_type = static_cast<u16_t>(key_information & m_key_information_mask_key_ack);

	if (key_type != 0)

	{

		return true;

	}

	else

	{

		return false;

	}

}

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

//

EAP_FUNC_EXPORT bool eapol_RSNA_key_header_c::get_key_information_key_MIC() const

{

	const u16_t key_information = get_key_information();

	const u16_t key_type = static_cast<u16_t>(key_information & m_key_information_mask_key_MIC);

	if (key_type != 0)

	{

		return true;

	}

	else

	{

		return false;

	}

}

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

//

EAP_FUNC_EXPORT bool eapol_RSNA_key_header_c::get_key_information_secure() const

{

	const u16_t key_information = get_key_information();

	const u16_t key_type = static_cast<u16_t>(key_information & m_key_information_mask_secure);

	if (key_type != 0)

	{

		return true;

	}

	else

	{

		return false;

	}

}

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

//

EAP_FUNC_EXPORT bool eapol_RSNA_key_header_c::get_key_information_error() const

{

	const u16_t key_information = get_key_information();

	const u16_t key_type = static_cast<u16_t>(key_information & m_key_information_mask_error);

	if (key_type != 0)

	{

		return true;

	}

	else

	{

		return false;

	}

}

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

//

EAP_FUNC_EXPORT bool eapol_RSNA_key_header_c::get_key_information_request() const

{

	const u16_t key_information = get_key_information();

	const u16_t key_type = static_cast<u16_t>(key_information & m_key_information_mask_request);

	if (key_type != 0)

	{

		return true;

	}

	else

	{

		return false;

	}

}

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

//

EAP_FUNC_EXPORT bool eapol_RSNA_key_header_c::get_key_information_encrypted_key_data() const

{

	const u16_t key_information = get_key_information();

	const u16_t key_type = static_cast<u16_t>(key_information & m_key_information_mask_encrypted_key_data_RSNA);

	if (key_type != 0)

	{

		return true;

	}

	else

	{

		return false;

	}

}

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

//

EAP_FUNC_EXPORT u8_t eapol_RSNA_key_header_c::get_key_information_reserved_b() const

{

	const u16_t key_information = get_key_information();

	if (m_is_RSNA_when_true == true || m_is_WPXM_when_true == true)

	{

		return static_cast<u8_t>((key_information & m_key_information_mask_reserved_b_RSNA)

			>> m_key_information_mask_reserved_b_shift_RSNA);

	}

	else

	{

		return static_cast<u8_t>((key_information & m_key_information_mask_reserved_b_WPA)

			>> m_key_information_mask_reserved_b_shift_WPA);

	}

}

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

//

EAP_FUNC_EXPORT u16_t eapol_RSNA_key_header_c::get_key_length() const

{

	const u8_t * const data = get_header_offset(m_offset_key_length, sizeof(u16_t));

	if (data != 0)

	{

		return eap_read_u16_t_network_order(data, sizeof(u16_t));

	}

	else

	{

		return 0ul;

	}

}	

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

//

EAP_FUNC_EXPORT u64_t eapol_RSNA_key_header_c::get_key_replay_counter() const

{

	const u8_t * const data = get_header_offset(m_offset_key_replay_counter, EAPOL_RSNA_KEY_REPLY_COUNTER_SIZE);

	if (data != 0)

	{

		return eap_read_u64_t_network_order(data, EAPOL_RSNA_KEY_REPLY_COUNTER_SIZE);

	}

	else

	{

		return 0ul;

	}

}

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

//

EAP_FUNC_EXPORT u8_t * eapol_RSNA_key_header_c::get_key_NONCE() const

{

	u8_t * const data = get_header_offset(m_offset_key_NONCE, EAPOL_RSNA_KEY_NONCE_SIZE);

	return data;

}

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

//

EAP_FUNC_EXPORT u8_t * eapol_RSNA_key_header_c::get_EAPOL_key_IV() const

{

	u8_t * const data = get_header_offset(m_offset_EAPOL_key_IV, EAPOL_RSNA_EAPOL_KEY_IV_SIZE);

	return data;

}

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

//

EAP_FUNC_EXPORT u8_t * eapol_RSNA_key_header_c::get_key_RSC() const

{

	u8_t * const data = get_header_offset(m_offset_key_RSC, EAPOL_RSNA_KEY_RSC_SIZE);

	return data;

}

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

//

EAP_FUNC_EXPORT u8_t * eapol_RSNA_key_header_c::get_key_STA_MAC_address() const

{

	u8_t * const data = get_header_offset(m_offset_key_STA_MAC_address, EAPOL_RSNA_KEY_STA_MAC_ADDRESS_SIZE);

	return data;

}

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

//

EAP_FUNC_EXPORT u8_t * eapol_RSNA_key_header_c::get_key_reserved() const

{

	u8_t * const data = get_header_offset(m_offset_key_reserved, EAPOL_RSNA_KEY_RESERVED_SIZE);

	return data;

}

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

//

EAP_FUNC_EXPORT u8_t * eapol_RSNA_key_header_c::get_key_MIC() const

{

	u8_t * const data = get_header_offset(m_offset_key_MIC, EAPOL_RSNA_KEY_MIC_SIZE);

	return data;

}

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

//

EAP_FUNC_EXPORT u16_t eapol_RSNA_key_header_c::get_key_data_length() const

{

	const u8_t * const data = get_header_offset(m_offset_key_data_length, EAPOL_RSNA_KEY_DATA_LENGTH_SIZE);

	if (data != 0)

	{

		return eap_read_u16_t_network_order(data, EAPOL_RSNA_KEY_DATA_LENGTH_SIZE);

	}

	else

	{

		return 0ul;

	}

}

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

//

EAP_FUNC_EXPORT u8_t * eapol_RSNA_key_header_c::get_key_data(const u32_t key_length) const

{

	u8_t * const data = get_header_offset(

		m_offset_key_data,

		key_length);

	return data; // Data begins after the header.

}

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

//

EAP_FUNC_EXPORT u8_t * eapol_RSNA_key_header_c::get_key_data_offset(const u32_t offset, const u32_t key_length) const

{

	u8_t * const data = get_header_offset(

		m_offset_key_data + offset,

		key_length);

	return data; // Data begins after the header.

}

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

//

EAP_FUNC_EXPORT u16_t eapol_RSNA_key_header_c::get_header_length()

{

	return m_offset_key_data;

}

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

//

EAP_FUNC_EXPORT eap_status_e eapol_RSNA_key_header_c::set_eapol_protocol_version(const eapol_protocol_version_e version)

{

	u8_t * const data = get_header_offset(m_offset_eapol_version, sizeof(u8_t));

	if (data != 0)

	{

		*data = static_cast<u8_t>(version);

		return EAP_STATUS_RETURN(m_am_tools, eap_status_ok);

	}

	else

	{

		return EAP_STATUS_RETURN(m_am_tools, eap_status_allocation_error);

	}

}

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

//

EAP_FUNC_EXPORT eap_status_e eapol_RSNA_key_header_c::set_eapol_packet_type(const eapol_packet_type_e type)

{

	u8_t * const data = get_header_offset(m_offset_eapol_type, sizeof(u8_t));

	if (data != 0)

	{

		*data = static_cast<u8_t>(type);

		return EAP_STATUS_RETURN(m_am_tools, eap_status_ok);

	}

	else

	{

		return EAP_STATUS_RETURN(m_am_tools, eap_status_allocation_error);

	}

}

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

//