/*
* 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: 12 %
*/
#if !defined(_AKA_RESULT_H_)
#define _AKA_RESULT_H_
#include "eap_variable_data.h"
#include "eap_am_export.h"
#include "eap_type_aka_header.h"
class EAP_EXPORT aka_fixed_data_c
{
private:
//--------------------------------------------------
bool m_is_valid;
aka_payload_AT_header_c m_original_header;
u16_t m_type;
u16_t m_data;
//--------------------------------------------------
protected:
//--------------------------------------------------
//--------------------------------------------------
public:
//--------------------------------------------------
EAP_FUNC_IMPORT virtual ~aka_fixed_data_c();
EAP_FUNC_IMPORT aka_fixed_data_c(
abs_eap_am_tools_c * const tools);
EAP_FUNC_IMPORT bool get_is_valid() const;
EAP_FUNC_IMPORT const aka_payload_AT_header_c * get_original_header();
EAP_FUNC_IMPORT u16_t get_type(abs_eap_am_tools_c * const m_am_tools) const;
EAP_FUNC_IMPORT u16_t get_data(abs_eap_am_tools_c * const m_am_tools) const;
EAP_FUNC_IMPORT void set_data(
const aka_payload_AT_header_c * const original_header,
const u16_t type, const u16_t data);
//--------------------------------------------------
}; // class aka_fixed_data_c
class EAP_EXPORT aka_variable_data_c
{
private:
//--------------------------------------------------
abs_eap_am_tools_c * const m_am_tools;
eap_variable_data_c m_data;
aka_payload_AT_header_c m_original_header;
bool m_payload_included;
//--------------------------------------------------
protected:
//--------------------------------------------------
//--------------------------------------------------
public:
//--------------------------------------------------
EAP_FUNC_IMPORT virtual ~aka_variable_data_c();
EAP_FUNC_IMPORT aka_variable_data_c(abs_eap_am_tools_c * const tools);
EAP_FUNC_IMPORT const aka_payload_AT_header_c * get_original_header() const;
EAP_FUNC_IMPORT eap_status_e set_buffer(
const aka_payload_AT_header_c * const original_header,
u8_t *buffer,
const u32_t buffer_length,
const bool free_buffer,
const bool is_writable);
EAP_FUNC_IMPORT bool get_payload_included() const;
EAP_FUNC_IMPORT u32_t get_data_length() const;
EAP_FUNC_IMPORT u8_t * get_data(const u32_t data_length) const;
EAP_FUNC_IMPORT eap_variable_data_c * get_payload_buffer();
EAP_FUNC_IMPORT bool get_is_valid() const;
EAP_FUNC_IMPORT eap_status_e reset();
//--------------------------------------------------
}; // class aka_variable_data_c
//--------------------------------------------------
//
class EAP_EXPORT aka_payloads_c
{
private:
//--------------------------------------------------
abs_eap_am_tools_c * const m_am_tools;
eap_variable_data_c m_all_payloads;
aka_variable_data_c m_nonce_s;
aka_variable_data_c m_MAC;
aka_variable_data_c m_ENCR_DATA;
aka_variable_data_c m_IDENTITY_payload;
aka_variable_data_c m_padding_payload;
aka_variable_data_c m_RAND;
aka_variable_data_c m_AUTN;
aka_variable_data_c m_AUTS;
aka_variable_data_c m_RES;
aka_variable_data_c m_PERMANENT_ID_REQ;
aka_variable_data_c m_FULLAUTH_ID_REQ;
aka_variable_data_c m_ANY_ID_REQ;
aka_variable_data_c m_IV;
aka_variable_data_c m_NEXT_PSEUDONYM;
aka_variable_data_c m_NEXT_REAUTH_ID;
aka_variable_data_c m_NOTIFICATION;
aka_variable_data_c m_COUNTER;
aka_variable_data_c m_COUNTER_TOO_SMALL;
aka_variable_data_c m_CLIENT_ERROR_CODE;
aka_variable_data_c m_RESULT_IND;
aka_variable_data_c m_CHECKCODE;
aka_payload_AT_type_e m_unknown_payload;
bool m_includes_other_version_than_1;
bool m_is_valid;
//--------------------------------------------------
protected:
//--------------------------------------------------
//--------------------------------------------------
public:
//--------------------------------------------------
enum eap_aka_payload_status_e
{
eap_aka_payload_status_optional,
eap_aka_payload_status_must_be,
eap_aka_payload_status_must_not_be
};
EAP_FUNC_IMPORT virtual ~aka_payloads_c();
EAP_FUNC_IMPORT aka_payloads_c(
abs_eap_am_tools_c * const tools);
EAP_FUNC_IMPORT bool check_one_payload(
const eap_aka_payload_status_e status,
const aka_variable_data_c * const payload);
/** This function checks the correct set of payloads are included in the message.
* NOTE do not change the order of parameters.
* Add new payload type to the last of the parameter list.
*/
EAP_FUNC_IMPORT bool check_payloads(
const eap_aka_payload_status_e nonce_s,
const eap_aka_payload_status_e MAC,
const eap_aka_payload_status_e ENCR_DATA,
const eap_aka_payload_status_e IDENTITY,
const eap_aka_payload_status_e padding,
const eap_aka_payload_status_e n_RANDs,
const eap_aka_payload_status_e AUTN,
const eap_aka_payload_status_e AUTS,
const eap_aka_payload_status_e RES,
const eap_aka_payload_status_e PERMANENT_ID_REQ,
const eap_aka_payload_status_e FULLAUTH_ID_REQ,
const eap_aka_payload_status_e ANY_ID_REQ,
const eap_aka_payload_status_e IV,
const eap_aka_payload_status_e NEXT_PSEUDONYM,
const eap_aka_payload_status_e NEXT_REAUTH_ID,
const eap_aka_payload_status_e NOTIFICATION,
const eap_aka_payload_status_e COUNTER,
const eap_aka_payload_status_e COUNTER_TOO_SMALL,
const eap_aka_payload_status_e CLIENT_ERROR_CODE,
const eap_aka_payload_status_e RESULT_IND,
const eap_aka_payload_status_e CHECKCODE
);
eap_variable_data_c * const get_all_payloads()
{
return static_cast<eap_variable_data_c *>(&m_all_payloads);
}
aka_variable_data_c * const get_NONCE_S()
{
return static_cast<aka_variable_data_c *>(&m_nonce_s);
}
aka_variable_data_c * const get_MAC()
{
return static_cast<aka_variable_data_c *>(&m_MAC);
}
aka_variable_data_c * const get_ENCR_DATA()
{
return static_cast<aka_variable_data_c *>(&m_ENCR_DATA);
}
aka_variable_data_c * const get_IDENTITY_payload()
{
return static_cast<aka_variable_data_c *>(&m_IDENTITY_payload);
}
aka_variable_data_c * const get_padding_payload()
{
return static_cast<aka_variable_data_c *>(&m_padding_payload);
}
aka_variable_data_c * const get_RAND()
{
return static_cast<aka_variable_data_c *>(&m_RAND);
}
aka_variable_data_c * const get_AUTN()
{
return static_cast<aka_variable_data_c *>(&m_AUTN);
}
aka_variable_data_c * const get_AUTS()
{
return static_cast<aka_variable_data_c *>(&m_AUTS);
}
aka_variable_data_c * const get_RES()
{
return static_cast<aka_variable_data_c *>(&m_RES);
}
aka_variable_data_c * const get_PERMANENT_ID_REQ()
{
return static_cast<aka_variable_data_c *>(&m_PERMANENT_ID_REQ);
}
aka_variable_data_c * const get_FULLAUTH_ID_REQ()
{
return static_cast<aka_variable_data_c *>(&m_FULLAUTH_ID_REQ);
}
aka_variable_data_c * const get_ANY_ID_REQ()
{
return static_cast<aka_variable_data_c *>(&m_ANY_ID_REQ);
}
aka_variable_data_c * const get_IV()
{
return static_cast<aka_variable_data_c *>(&m_IV);
}
aka_variable_data_c * const get_NEXT_PSEUDONYM()
{
return static_cast<aka_variable_data_c *>(&m_NEXT_PSEUDONYM);
}
aka_variable_data_c * const get_NEXT_REAUTH_ID()
{
return static_cast<aka_variable_data_c *>(&m_NEXT_REAUTH_ID);
}
aka_variable_data_c * const get_NOTIFICATION()
{
return static_cast<aka_variable_data_c *>(&m_NOTIFICATION);
}
aka_variable_data_c * const get_RESULT_IND()
{
return static_cast<aka_variable_data_c *>(&m_RESULT_IND);
}
aka_variable_data_c * const get_CHECKCODE()
{
return static_cast<aka_variable_data_c *>(&m_CHECKCODE);
}
aka_variable_data_c * const get_CLIENT_ERROR_CODE()
{
return static_cast<aka_variable_data_c *>(&m_CLIENT_ERROR_CODE);
}
aka_variable_data_c * const get_COUNTER()
{
return static_cast<aka_variable_data_c *>(&m_COUNTER);
}
aka_variable_data_c * const get_COUNTER_TOO_SMALL()
{
return static_cast<aka_variable_data_c *>(&m_COUNTER_TOO_SMALL);
}
void set_includes_unknown_attribute(const aka_payload_AT_type_e unknown_payload);
aka_payload_AT_type_e get_includes_unknown_attribute();
void set_includes_other_version_than_1(const bool includes_other_version_than_1);
bool get_includes_other_version_than_1();
bool get_is_valid() const;
//--------------------------------------------------
}; // class aka_payloads_c
#endif //#if !defined(_AKA_RESULT_H_)
//--------------------------------------------------
// End.