eapol/eapol_framework/eapol_common/type/simple_config/eap/include/eap_type_simple_config_header.h
/*
* 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.
*
*/
/*
* %version: 11 %
*/
#if !defined(_EAP_SIMPLE_CONFIG_HEADER_H_)
#define _EAP_SIMPLE_CONFIG_HEADER_H_
#if defined(USE_EAP_SIMPLE_CONFIG)
#include "eap_tools.h"
#include "eap_header.h"
#include "simple_config_types.h"
/** @file */
const u8_t SIMPLE_CONFIG_NAI_AT_BYTE = '@';
#if !defined(USE_EAP_EXPANDED_TYPES)
#error You MUST define USE_EAP_EXPANDED_TYPES compiler flag. WFA Simple Config uses that.
#endif //#if !defined(USE_EAP_EXPANDED_TYPES)
//----------------------------------------------------------------------------
/// This class defines header of SIMPLE_CONFIG EAP-type.
/**
* Here is a figure of header of SIMPLE_CONFIG EAP-type.
* Subtype-Data is m_length-sizeof(eap_simple_config_header_c) data octets that follows eap_simple_config_header_c.
* @code
* EAP/SIMPLE_CONFIG-header:
* 0 1 2 3
* 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* | Code | Identifier | Length |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* | Type | Vendor-Id |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* | Vendor-Type |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* | Op-Code | Flags | Message Length |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* | Message Data...
* +-+-+-+-+-+-+-+-+-+
* @endcode
*
*/
class EAP_EXPORT eap_simple_config_header_c
: public eap_header_base_c
{
private:
//--------------------------------------------------
/// This is pointer to the tools class.
abs_eap_am_tools_c * const m_am_tools;
enum message_fields
{
SIMPLE_CONFIG_MESSAGE_LENGTH_FIELD_SIZE = 2u,
};
enum bit_shifts
{
m_flag_shift_reserved = 0x02,
};
//--------------------------------------------------
protected:
//--------------------------------------------------
enum delta_offsets
{
m_op_code_delta_offset = 0,
m_flag_delta_offset = m_op_code_delta_offset+sizeof(u8_t),
m_data_or_message_length_delta_offset = m_flag_delta_offset+sizeof(u8_t),
};
//--------------------------------------------------
public:
//--------------------------------------------------
enum bit_masks
{
m_flag_mask_more_fragments = 0x01,
m_flag_mask_simple_config_length_included = 0x02,
m_flag_mask_reserved = 0xfc,
};
enum op_code_e
{
op_code_none = 0x00,
op_code_WSC_Start = 0x01,
op_code_WSC_ACK = 0x02,
op_code_WSC_NACK = 0x03,
op_code_WSC_MSG = 0x04,
op_code_WSC_Done = 0x05,
op_code_FRAG_ACK = 0x06,
};
EAP_FUNC_IMPORT virtual ~eap_simple_config_header_c();
//
EAP_FUNC_IMPORT eap_simple_config_header_c(
abs_eap_am_tools_c * const tools,
u8_t * const header_begin,
const u32_t header_buffer_length);
EAP_FUNC_IMPORT eap_code_value_e get_eap_code() const;
EAP_FUNC_IMPORT u8_t get_eap_identifier() const;
EAP_FUNC_IMPORT u16_t get_eap_length() const;
EAP_FUNC_IMPORT eap_type_value_e get_eap_type() const;
EAP_FUNC_IMPORT u16_t get_data_length() const;
EAP_FUNC_IMPORT u32_t get_simple_config_min_header_length() const;
EAP_FUNC_IMPORT static u32_t get_simple_config_max_header_length();
EAP_FUNC_IMPORT u32_t get_header_length() const;
EAP_FUNC_IMPORT u32_t get_start_offset_of_data() const;
EAP_FUNC_IMPORT u8_t * get_data_offset(
abs_eap_am_tools_c * const m_am_tools,
const u32_t offset,
const u32_t contignuous_bytes) const;
EAP_FUNC_IMPORT u8_t * get_data(
abs_eap_am_tools_c * const m_am_tools,
const u32_t contignuous_bytes) const;
EAP_FUNC_IMPORT u32_t get_sc_op_code_offset() const;
EAP_FUNC_IMPORT u32_t get_sc_flags_offset() const;
EAP_FUNC_IMPORT u32_t get_sc_length_offset() const;
EAP_FUNC_IMPORT op_code_e get_sc_op_code() const;
EAP_FUNC_IMPORT u8_t * get_simple_config_flags() const;
EAP_FUNC_IMPORT bool get_simple_config_flag_bit(
const u32_t mask) const;
EAP_FUNC_IMPORT u8_t get_simple_config_flag_value(
const u32_t mask,
const u32_t shift) const;
EAP_FUNC_IMPORT bool get_flag_simple_config_length_included() const;
EAP_FUNC_IMPORT bool get_flag_more_fragments() const;
EAP_FUNC_IMPORT u8_t get_flag_reserved() const;
EAP_FUNC_IMPORT eap_status_e get_simple_config_message_length(
u32_t * const simple_config_length) const;
EAP_FUNC_IMPORT eap_status_e check_header(
abs_eap_am_tools_c * const tools,
const bool is_client_when_true) const;
EAP_FUNC_IMPORT eap_const_string get_code_string() const;
EAP_FUNC_IMPORT eap_const_string get_eap_type_string() const;
EAP_FUNC_IMPORT eap_const_string get_sc_op_code_string() const;
EAP_FUNC_IMPORT void set_eap_code(const eap_code_value_e p_code);
EAP_FUNC_IMPORT void set_eap_identifier(const u8_t p_identifier);
EAP_FUNC_IMPORT void set_eap_length(
const u16_t p_length,
const bool expanded_type_when_true);
EAP_FUNC_IMPORT void set_eap_type(
const eap_type_value_e p_type,
const bool expanded_type_when_true);
EAP_FUNC_IMPORT void set_sc_op_code(const op_code_e op_code);
EAP_FUNC_IMPORT void set_simple_config_flag_value(
const u8_t value,
const u32_t mask,
const u32_t shift) const;
EAP_FUNC_IMPORT void set_simple_config_flag_bit(const bool flag, u32_t mask) const;
EAP_FUNC_IMPORT void set_flag_reserved(const u8_t reserved);
EAP_FUNC_IMPORT void set_flag_simple_config_length_included(const bool simple_config_length_included);
EAP_FUNC_IMPORT void set_flag_more_fragments(const bool more_fragments);
EAP_FUNC_IMPORT void set_data_length(
const u32_t p_data_length,
const bool expanded_type_when_true);
EAP_FUNC_IMPORT void set_simple_config_message_length(const u32_t simple_config_length);
EAP_FUNC_IMPORT void reset_header(
abs_eap_am_tools_c * const m_am_tools,
const u32_t buffer_length,
const bool expanded_type_when_true);
//
//--------------------------------------------------
}; // class eap_simple_config_header_c
//--------------------------------------------------
#endif //#if defined(USE_EAP_SIMPLE_CONFIG)
#endif //#if !defined(_EAP_SIMPLE_CONFIG_HEADER_H_)
// End.