/*

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

*

*/

#if !defined(_EAP_TYPE_TLS_PEAP_TYPES_H_)

#define _EAP_TYPE_TLS_PEAP_TYPES_H_

#include "eap_buffer.h"

#include "eap_type_all_types.h"

#include "tls_peap_types.h"

#include "eap_configuration_field.h"

/** @file eap_type_tls_peap_types.h 

 *  @brief This file defines the constants of the TLS_PEAP EAP type.

 */

/**

 * This is the internal state of the TLS_PEAP EAP type.

 */

enum eap_type_tls_peap_state_variable_e

{

	eap_type_tls_peap_state_waiting_for_identity_request                          , ///< Client state waiting_for_identity_request

	eap_type_tls_peap_state_pending_identity_query                                , ///< Client state pending_identity_query

	eap_type_tls_peap_state_waiting_for_tls_start                                 , ///< Client state waiting_for_eap_start

	eap_type_tls_peap_state_process_tls_start                                     , ///< Client state process_tls_start

	eap_type_tls_peap_state_waiting_for_request                                   , ///< Client state waiting_for_request

	eap_type_tls_peap_state_waiting_for_success                                   , ///< Client state waiting_for_success

	eap_type_tls_peap_state_tppd_peapv1_waits_eap_success_or_tunneled_packet     , ///< Client state PEAPv1 waits EAP-Success or tunneled packet.

	eap_type_tls_peap_state_waiting_for_identity_response                         , ///< Server state waiting_for_identity_response

	eap_type_tls_peap_state_waiting_for_first_response                            , ///< Server state waiting_for_first_response, This is needed in PEAP version negotiation.

	eap_type_tls_peap_state_waiting_for_response                                  , ///< Server state waiting_for_response

	eap_type_tls_peap_state_waiting_for_empty_response                            , ///< Server state waiting_for_empty_response

	eap_type_tls_peap_state_waiting_for_empty_tppd_peap_v1_acknowledge           , ///< Server state waiting_for_empty_tppd_peap_v1_response

#if defined(EAP_USE_TTLS_PLAIN_MS_CHAP_V2_HACK)

	eap_type_tls_peap_state_server_waits_ttls_plain_ms_chap_v2_empty_ack          , ///< This is state notification to server to wait empty TTLS/plain MsChapv2 Ack.

#endif //#if defined(EAP_USE_TTLS_PLAIN_MS_CHAP_V2_HACK)

	eap_type_tls_peap_state_process_tls_message                                   , ///< Client or server state process_tls_message

	eap_type_tls_peap_state_success                                               , ///< State state_success

	eap_type_tls_peap_state_failure                                               , ///< State state_failure

	eap_type_tls_peap_state_last_value                                            , ///< Keep this enum the last one.

};

enum eap_type_tls_peap_reassembly_state_e

{

	eap_type_tls_peap_reassembly_state_none,

	eap_type_tls_peap_reassembly_state_wait_first_message,

	eap_type_tls_peap_reassembly_state_wait_last_fragment,

	eap_type_tls_peap_reassembly_state_message_reassembled,

};

/**

 * This is the type of the TLS_PEAP authentication.

 */

enum eap_tls_peap_authentication_type_e

{

	TLS_PEAP_AUTHENTICATION_TYPE_NONE,

	TLS_PEAP_AUTHENTICATION_TYPE_TLS,

	TLS_PEAP_AUTHENTICATION_TYPE_PEAP,

};

enum eap_type_tls_peap_stored_e

{

	eap_type_tls_peap_stored_none,

	eap_type_tls_peap_stored_session_id,

	eap_type_tls_peap_stored_master_secret,

	eap_type_tls_peap_stored_used_cipher_suite,

	eap_type_tls_peap_stored_count_of_session_resumes,

	eap_type_tls_peap_stored_test_every_cipher_suite_counter,

#if defined(USE_EAP_TLS_SESSION_TICKET)

	eap_type_tls_peap_stored_session_ticket_encryption_key,

	eap_type_tls_peap_stored_session_ticket_authentication_key,

	eap_type_tls_peap_stored_session_ticket_lifetime_hint,

	eap_type_tls_peap_stored_session_ticket_data,

#endif // #if defined(USE_EAP_TLS_SESSION_TICKET)

#if defined(USE_FAST_EAP_TYPE)

	eap_type_tls_peap_stored_tunnel_pac_is_fresh,

	eap_type_tls_peap_stored_tunnel_pac,

	eap_type_tls_peap_stored_user_authorization_pac,

	eap_type_tls_peap_stored_provisioning_successfull,

	eap_type_tls_peap_stored_provisioning_mode,

	eap_type_tls_peap_stored_provisioning_pac_type,

	eap_type_tls_peap_stored_tls_session_type,

#endif //#if defined(USE_FAST_EAP_TYPE)

};

/**

 * This is the size of the local send buffer.

 */

const u32_t EAP_TLS_PEAP_LOCAL_PACKET_BUFFER_LENGTH = EAP_MAX_LOCAL_PACKET_BUFFER_LENGTH;

/**

 * This is the at character used in NAI.

 */

const u8_t EAP_TLS_PEAP_AT_CHARACTER = '@';

/**

 * This is the maximum size of the EAP-TLS/PEAP message.

 * This value limits the maximum size of the received EAP-TLS/PEAP message.

 */

const u32_t EAP_TLS_PEAP_MAX_MESSAGE_LENGTH = 65536ul;

/**

 *  @defgroup EAP_TLS_PEAP_config_options Configuration options of EAP-TLS/PEAP.

 *  The following configuration options are read through abs_eap_base_type_c::read_configure() function.

 *  @{

 */

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_TLS_PEAP_use_manual_username,

	"EAP_TLS_PEAP_use_manual_username",

	eap_configure_type_boolean,

	false);

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_TLS_PEAP_manual_username,

	"EAP_TLS_PEAP_manual_username",

	eap_configure_type_string,

	false);

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_TLS_PEAP_use_manual_realm,

	"EAP_TLS_PEAP_use_manual_realm",

	eap_configure_type_boolean,

	false);

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_TLS_PEAP_manual_realm,

	"EAP_TLS_PEAP_manual_realm",

	eap_configure_type_string,

	false);

#if defined(USE_EAP_TLS_SESSION_TICKET)

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_TLS_PEAP_use_session_ticket,

	"EAP_TLS_PEAP_use_session_ticket",

	eap_configure_type_boolean,

	false);

#endif //#if defined(USE_EAP_TLS_SESSION_TICKET)

#if defined(USE_EAP_TLS_SESSION_TICKET)

EAP_CONFIGURATION_FIELD(

	cf_str_TLS_fail_with_illegal_session_ticket_or_pac,

	"TLS_fail_with_illegal_session_ticket_or_pac",

	eap_configure_type_boolean,

	false);

#endif //#if defined(USE_EAP_TLS_SESSION_TICKET)

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_TLS_PEAP_disable_certificates,

	"EAP_TLS_PEAP_disable_certificates",

	eap_configure_type_boolean,

	false);

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_TLS_PEAP_ttls_pap_password_prompt,

	"EAP_TLS_PEAP_ttls_pap_password_prompt",

	eap_configure_type_boolean,

	false);

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_TLS_PEAP_ttls_pap_username,

	"EAP_TLS_PEAP_ttls_pap_username",

	eap_configure_type_string,

	false);

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_TLS_PEAP_ttls_pap_password,

	"EAP_TLS_PEAP_ttls_pap_password",

	eap_configure_type_string,

	false);

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_TLS_PEAP_ttls_pap_max_session_validity_time,

	"EAP_TLS_PEAP_ttls_pap_max_session_validity_time",

	eap_configure_type_u32_t,

	false);

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_TLS_PEAP_ttls_pap_randomly_fail_password,

	"EAP_TLS_PEAP_ttls_pap_randomly_fail_password",

	eap_configure_type_boolean,

	false);

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_FAST_authority_identity,

	"EAP_FAST_authority_identity",

	eap_configure_type_string,

	false);

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_FAST_authority_identity_hex_data,

	"EAP_FAST_authority_identity",

	eap_configure_type_hex_data,

	false);

/**

 * This is boolean configuration option.

 * True value means every cipher suite is tested during test run.

 * False value means only selected cipher suite is tested. See EAP_TLS_PEAP_cipher_suite.

 * Default value is false.

 */

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_TLS_PEAP_test_every_cipher_suite,

	"EAP_TLS_PEAP_test_every_cipher_suite",

	eap_configure_type_boolean,

	false);

/**

 *  This u32_t configuration option is the cipher suite.

 *  Default value is 19 = 0x0013 (TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA).

 */

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_TLS_PEAP_cipher_suite,

	"EAP_TLS_PEAP_cipher_suite",

	eap_configure_type_u32_t,

	false);

/**

 *  This u32array_t configuration option is the array of accepted cipher suites.

 *  Default value is 19 = 0x0013 (TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA).

 */

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_TLS_PEAP_allowed_cipher_suites,

	"EAP_TLS_PEAP_allowed_cipher_suites",

	eap_configure_type_u32array,

	false);

/**

 *  This u32_t configuration option is the maximum count of session resumes.

 *  Default value is 0.

 */

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_TLS_PEAP_max_count_of_session_resumes,

	"EAP_TLS_PEAP_max_count_of_session_resumes",

	eap_configure_type_u32_t,

	false);

/**

 *  This u32_t configuration option is the count of session resumes.

 *  Default value is 0.

 */

#if defined(USE_EAP_FIXED_DATABASE_FIELDS)

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_TLS_PEAP_count_of_session_resumes,

	"EAP_TLS_PEAP_count_of_session_resumes",

	eap_configure_type_u32_t,

	false);

#else

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_TLS_PEAP_count_of_session_resumes,

	"session_resume_count",

	eap_configure_type_u32_t,

	false);

#endif

/**

 *  This hex data configuration option is the saved session ID.

 *  Default value is 0.

 */

#if defined(USE_EAP_FIXED_DATABASE_FIELDS)

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_TLS_PEAP_saved_session_id,

	"EAP_TLS_PEAP_saved_session_id",

	eap_configure_type_hex_data,

	false);

#else

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_TLS_PEAP_saved_session_id,

	"session_id",

	eap_configure_type_hex_data,

	false);

#endif

/**

 * This hex data or u32array configuration option value is list of EAP-types client accepts inside PEAP.

 * Values in the u32array are type of u32_t.

 * This is used in simulator testing.

 */

#if defined(USE_EAP_FIXED_DATABASE_FIELDS)

EAP_CONFIGURATION_FIELD(

	cf_str_PEAP_accepted_tunneled_client_types_hex_data,

	"PEAP_accepted_tunneled_client_types",

	eap_configure_type_hex_data,

	false);

EAP_CONFIGURATION_FIELD(

	cf_str_PEAP_accepted_tunneled_client_types_u32array,

	"PEAP_accepted_tunneled_client_types",

	eap_configure_type_u32array,

	false);

EAP_CONFIGURATION_FIELD(

	cf_str_PEAP_unaccepted_tunneled_client_types_hex_data,

	"PEAP_unaccepted_tunneled_client_types",

	eap_configure_type_hex_data,

	false);

EAP_CONFIGURATION_FIELD(

	cf_str_PEAP_unaccepted_tunneled_client_types_u32array,

	"PEAP_unaccepted_tunneled_client_types",

	eap_configure_type_u32array,

	false);	

#else

EAP_CONFIGURATION_FIELD(

	cf_str_PEAP_accepted_tunneled_client_types_hex_data,

	"PEAP_tunneled_types",

	eap_configure_type_hex_data,

	false);

EAP_CONFIGURATION_FIELD(

	cf_str_PEAP_accepted_tunneled_client_types_u32array,

	"PEAP_tunneled_types",

	eap_configure_type_u32array,

	false);

#endif

/**

 * This hex data or u32array configuration option value is list of EAP-types server accepts inside PEAP.

 * Values in the array are type of u32_t.

 * This is used in simulator testing.

 */

EAP_CONFIGURATION_FIELD(

	cf_str_PEAP_accepted_tunneled_server_types_hex_data,

	"PEAP_accepted_tunneled_server_types",

	eap_configure_type_hex_data,

	false);

EAP_CONFIGURATION_FIELD(

	cf_str_PEAP_accepted_tunneled_server_types_u32array,

	"PEAP_accepted_tunneled_server_types",

	eap_configure_type_u32array,

	false);

/**

 *  This boolean configuration option value true allows PEAP restore tunneled session.

 *  This means PEAP does not run the tunneled EAP-type when

 *  PEAP session is resumed successfully.

 *  Default value is true.

 */

EAP_CONFIGURATION_FIELD(

	cf_str_PEAP_allow_tunneled_session_resumption,

	"PEAP_allow_tunneled_session_resumption",

	eap_configure_type_boolean,

	false);

/**

 *  This boolean configuration option value true allows PEAP server restore tunneled session.

 *  This means PEAP version 0 does not run the tunneled EAP-type when

 *  PEAP session is resumed successfully.

 *  Default value is true.

 */

EAP_CONFIGURATION_FIELD(

	cf_str_PEAP_server_allow_tunneled_session_resumption,

	"PEAP_server_allow_tunneled_session_resumption",

	eap_configure_type_boolean,

	false);

/**

 *  This boolean configuration option value true commands PEAPv1 server use tunneled Extensions Request message.

 *  Default value is false.

 */

EAP_CONFIGURATION_FIELD(

	cf_str_PEAPv1_server_use_extensions_request,

	"PEAPv1_server_use_extensions_request",

	eap_configure_type_boolean,

	false);

/**

 *  This hex data configuration option is the saved master secret.

 *  Default value is 0.

 */

#if defined(USE_EAP_FIXED_DATABASE_FIELDS)

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_TLS_PEAP_saved_master_secret,

	"EAP_TLS_PEAP_saved_master_secret",

	eap_configure_type_hex_data,

	true);

#else

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_TLS_PEAP_saved_master_secret,

	"master_secret",

	eap_configure_type_hex_data,

	true);

#endif

/**

 *  This u32_t configuration option is the saved cipher suite.

 *  Default value is 0.

 */

#if defined(USE_EAP_FIXED_DATABASE_FIELDS)

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_TLS_PEAP_saved_cipher_suite,

	"EAP_TLS_PEAP_saved_cipher_suite",

	eap_configure_type_u32_t,

	false);

#else

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_TLS_PEAP_saved_cipher_suite,

	"saved_cipher_suite",

	eap_configure_type_u32_t,

	false);

#endif

/**

 *  This string configuration option is the filename for the client DSA certificate used 

 *  in EAP-type TLS_PEAP.

 */

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_TLS_PEAP_DSA_client_certificate_file,

	"EAP_TLS_PEAP_DSA_client_certificate_file",

	eap_configure_type_string,

	false);

/**

 *  This string configuration option is the filename for the client DSA private key used 

 *  in EAP-type TLS_PEAP.

 */

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_TLS_PEAP_DSA_client_private_key_file,

	"EAP_TLS_PEAP_DSA_client_private_key_file",

	eap_configure_type_string,

	false);

/**

 *  This string configuration option is the filename for the server DSA certificate used 

 *  in EAP-type TLS_PEAP.

 */

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_TLS_PEAP_DSA_server_certificate_file,

	"EAP_TLS_PEAP_DSA_server_certificate_file",

	eap_configure_type_string,

	false);

/**

 *  This string configuration option is the filename for the server DSA private key used 

 *  in EAP-type TLS_PEAP.

 */

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_TLS_PEAP_DSA_server_private_key_file,

	"EAP_TLS_PEAP_DSA_server_private_key_file",

	eap_configure_type_string,

	false);

/**

 *  This string configuration option is the filename for the client's CA 

 *	DSA certificate used for verifying server's identity in EAP-type TLS_PEAP.

 */

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_TLS_PEAP_DSA_client_ca_certificate_file,

	"EAP_TLS_PEAP_DSA_client_ca_certificate_file",

	eap_configure_type_string,

	false);

/**

 *  This string configuration option is the filename for the server's CA 

 *	DSA certificate used for verifying client's identity in EAP-type TLS_PEAP.

 */

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_TLS_PEAP_DSA_server_ca_certificate_file,

	"EAP_TLS_PEAP_DSA_server_ca_certificate_file",

	eap_configure_type_string,

	false);

/**

 *  This string configuration option is the filename for the client RSA certificate used 

 *  in EAP-type TLS_PEAP.

 */

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_TLS_PEAP_RSA_client_certificate_file,

	"EAP_TLS_PEAP_RSA_client_certificate_file",

	eap_configure_type_string,

	false);

/**

 *  This string configuration option is the filename for the client RSA private key used 

 *  in EAP-type TLS_PEAP.

 */

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_TLS_PEAP_RSA_client_private_key_file,

	"EAP_TLS_PEAP_RSA_client_private_key_file",

	eap_configure_type_string,

	false);

/**

 *  This string configuration option is the filename for the server RSA certificate used 

 *  in EAP-type TLS_PEAP.

 */

EAP_CONFIGURATION_FIELD(

	cf_str_EAP_TLS_PEAP_RSA_server_certificate_file,

	"EAP_TLS_PEAP_RSA_server_certificate_file",

	eap_configure_type_string,

	false);

/**

 *  This string configuration option is the filename for the server RSA private key used 

 *  in EAP-type TLS_PEAP.

 */

EAP_CONFIGURATION_FIELD(