/*

* 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_AM_TYPE_TLS_PEAP_SYMBIAN_H_)

#define _EAP_AM_TYPE_TLS_PEAP_SYMBIAN_H_

#include "eap_tools.h"

#include "eap_variable_data.h"

#include "eap_am_export.h"

#include "abs_eap_am_type_tls_peap.h"

#include "eap_am_type_tls_peap.h"

#include "eap_am_network_id.h"

#include <d32dbms.h>

#include <EapType.h>

#include <unifiedcertstore.h>

#include <mctwritablecertstore.h>

#include <pkixcertchain.h>

#include "eap_auth_notifier.h"

#include "EapTlsPeapUtils.h"

#include <bigint.h>

#if defined(USE_FAST_EAP_TYPE)

#include "EapFastNotifierStruct.h"

#include <etelmm.h>

#endif

#include "EapTtlsPapDbInfoStruct.h"

class CX509Certificate;

class CEapTlsPeapCertInterface;

class eap_am_tools_symbian_c;

class abs_tls_am_application_eap_fast_c;

#ifdef USE_PAC_STORE

class CPacStoreDatabase;

class SInfoEntry;

#endif

#if defined(USE_EAP_CONFIGURATION_TO_SKIP_USER_INTERACTIONS)

class eap_file_config_c;

#endif

const TInt KMaxLabelLength = 64;

const TInt KMaxDatabaseTableName = 64;

const TInt KOffsetCorrection = 1;

#if defined(USE_FAST_EAP_TYPE)

const char KEapFastPacProvisResultKey[] = "eap_am_type_tls_peap_symbian_c prov. result";

const TInt KEapFastPacProvisResultType = 1;

const u32_t KEapFastPacProvisResultDefaultTimeout = 10000; // in milliseconds = 10 seconds

#endif

/// This class is interface to adaptation module of EAP/TLS and PEAP.

: public CActive

, public eap_am_type_tls_peap_c

, public abs_eap_base_timer_c

, public MNotificationCallback

{

public:

#if defined(USE_FAST_EAP_TYPE)

    enum TEapFastPacProvisResultValue

    {

    EEapFastPacProvisResultFailure, /* 0 */

    EEapFastPacProvisResultSuccess  /* 1 */  

    };

#endif

private: // data

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

	RFs m_session;

	RDbNamedDatabase m_database;

	enum TState 

	{

		EHandlingIdentityQuery,           /* 0 */

		EHandlingManualIdentityQuery,     /* 1 */

		EHandlingChainQuery,              /* 2 */

		EHandlingCipherSuiteQuery,        /* 3 */

    EHandlingDeviceSeedQuery,        /* 4 */

#if defined(USE_FAST_EAP_TYPE)            /* 5 */

		EHandlingNotifierQuery,           /* 6 */

		EPasswordQuery,                   /* 7 */

		EWrongPassword,                   /* 8 */

		EFilePasswordQuery,               /* 9 */

		EMasterkeyQuery,                  /* 10 */

		EPasswordCancel,                  /* 11 */

		EShowProvSuccesstNote,            /* 12 */

		EShowProvNotSuccesstNote,         /* 13 */

		ENotifierComplete,				/*14 */

#endif //#if defined(USE_FAST_EAP_TYPE)

		EPapUserNameAndPassword, /* 15 */

		EPapChallenge, /* 16 */

		ENone                             /* 17 */

	};

	TState m_state;

	TState m_prev_state;

	TIndexType m_index_type;

	TInt m_index;

	eap_type_value_e m_tunneling_type;

	abs_eap_base_type_c *m_partner;

	eap_am_tools_symbian_c *m_am_tools;

	abs_eap_am_type_tls_peap_c *m_am_partner;

	abs_tls_am_services_c * m_tls_am_partner;

#if defined(USE_FAST_EAP_TYPE)

	abs_tls_am_application_eap_fast_c * m_tls_application;

	enum TAlterTableCmd

	    {

	    EAddColumn,

	    ERemoveColumn

	    };

#endif //#if defined(USE_FAST_EAP_TYPE)

	bool m_is_valid;

	bool m_is_client;

	eap_type_value_e m_current_eap_type;

	TBufC<KMaxDatabaseTableName> m_db_table_name;

	TBufC<KMaxDatabaseTableName> m_db_user_cert_table_name;

	TBufC<KMaxDatabaseTableName> m_db_ca_cert_table_name;

	TBufC<KMaxDatabaseTableName> m_db_cipher_suite_table_name;

	TBufC<KMaxDatabaseTableName> m_db_name;

#if defined (USE_FAST_EAP_TYPE)	

	TBufC<KMaxDatabaseTableName> m_db_fast_special_table_name;

	RPointerArray<SInfoEntry> m_info_array;

#endif	

	u32_t m_max_count_of_session_resumes;

	tls_cipher_suites_e m_cipher_suite;

	CX509Certificate* m_ca_certificate;

	CX509Certificate* m_own_certificate;	

	CX509Certificate* m_peer_certificate;

	CEapTlsPeapCertInterface* m_cert_if;	

	EapCertificateEntry m_own_certificate_info;

	eap_am_network_id_c m_receive_network_id;

	u8_t m_eap_identifier;

	TKeyIdentifier m_subject_key_id;

	RPointerArray<EapCertificateEntry> m_allowed_ca_certs;

	RPointerArray<EapCertificateEntry> m_allowed_user_certs;

	RPointerArray<EapCertificateEntry> m_allowed_server_certs;

	RArray<TUint> m_allowed_cipher_suites;

	eap_variable_data_c m_peer_public_key;

	eap_variable_data_c m_param_p;

	eap_variable_data_c m_param_q;

	eap_variable_data_c m_param_g;

	bool m_shutdown_was_called;

	/// Tunneling EAP configuration data from EAP database.

	RPointerArray<TEapExpandedType> m_enabled_tunneling_exp_eap_array;

	RPointerArray<TEapExpandedType> m_disabled_tunneling_exp_eap_array;

	TBuf8<4> m_selector_output;

	eap_type_value_e m_tunneled_type;

	bool m_verify_certificate_realm;	

	bool m_allow_subdomain_matching;

	tls_alert_description_e m_latest_alert_description;

	bool m_use_manual_username;

	eap_variable_data_c m_manual_username;

	bool m_use_manual_realm;

	eap_variable_data_c m_manual_realm;

	bool m_tls_peap_server_authenticates_client_policy_flag;

	bool m_use_automatic_ca_certificate;

	/// This flag prevents double configuration. This can happen when 

	/// this class implements many interfaces.

	bool m_configured;

	// This holds the max session time read from the configuration file.

	TInt64 m_max_session_time;

#if defined(USE_EAP_TLS_SESSION_TICKET)

	/// This flag allows use of session ticket, see RFC 4507.

	bool m_use_session_ticket;

#endif //#if defined(USE_EAP_TLS_SESSION_TICKET)

#if defined(USE_FAST_EAP_TYPE)

	tls_extension_c * m_received_tunnel_pac_in_session_ticket;

	tls_extension_c * m_received_user_authorization_pac_in_session_ticket;

	eap_fast_pac_type_e m_saved_pac_type;

	eap_fast_completion_operation_e m_completion_operation;

	eap_status_e m_verification_status;

	eap_fast_pac_type_e m_pac_type;

	eap_variable_data_c m_PAC_store_password;

	eap_variable_data_c m_imported_PAC_data_password;

	eap_variable_data_c m_PAC_store_path;

	eap_variable_data_c m_EAP_FAST_IAP_reference;

	eap_variable_data_c m_EAP_FAST_Group_reference;

	eap_variable_data_c m_EAP_FAST_import_path;

	eap_status_e m_eap_fast_completion_status;

	eap_fast_pac_store_pending_operation_e m_eap_fast_pac_store_pending_operation;

	eap_array_c<eap_fast_pac_store_data_c> m_references_and_data_blocks;

	eap_array_c<eap_fast_pac_store_data_c> m_new_references_and_data_blocks;

	eap_array_c<eap_fast_pac_store_data_c> m_ready_references_and_data_blocks;

	bool m_serv_unauth_prov_mode;

	bool m_serv_auth_prov_mode;

    /* For MMETEL */

	// ETel connection.

    RTelServer iServer;

    RMobilePhone iPhone;

    // Stores the last queried Phone identities like manufacturer, model, 

    // revision and serial number

    RMobilePhone::TMobilePhoneIdentityV1 iDeviceId; 

    // Tells if MMETEL is connected already or not.

    TBool iMMETELConnectionStatus;    

    TBool m_completed_with_zero;   

	TBool m_verificationStatus;

	HBufC8* m_pacStorePWBuf8;

	EEapFastNotifierUserAction m_userAction;

	eap_pac_store_data_type_e m_pacStoreDataRefType;

	eap_fast_pac_store_data_c m_data_reference;

	eap_variable_data_c m_userResponse;

	eap_fast_pac_store_pending_operation_e m_pending_operation;

	TInt m_both_completed;

	TInt m_both_asked;

	TUint m_ready_references_array_index;

	eap_fast_completion_operation_e m_provisioning_mode;

	/**

	* This member is used to store completion operation value

	* in initialize_PAC_store() call from common side.

	* The value is given later in complete call.

	*/

	eap_fast_completion_operation_e iCompletionOperation;

	/**

	* This member is used to store initialize-pac-store-completion value

	* in initialize_PAC_store() call from common side.

	* The value is given later in complete call.

	*/

	eap_fast_initialize_pac_store_completion_e iCompletion;

#endif //#if defined(USE_FAST_EAP_TYPE)

#ifdef USE_PAC_STORE

	CPacStoreDatabase * iPacStoreDb;

#endif

#ifdef USE_EAP_CONFIGURATION_TO_SKIP_USER_INTERACTIONS

    TBool m_skip_user_interactions;

    /// This is object to handle file configuration.

    eap_file_config_c * m_fileconfig;

#endif

	/**

	* Maximum TTLS-PAP session time read from the configuration file.	

	*/

	TInt64 iEapTtlsPapMaxSessionConfigTime;

	/**

	* Provides asynch services used by the caller such as

    * query for TTLS-PAP user name and password.

    */

 //   eap_am_type_tls_peap_symbian_c* iCaller;

    eap_variable_data_c* iPacStoreDeviceSeed;

	CEapAuthNotifier* iEapAuthNotifier;

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

private: // methods

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

	abs_eap_am_type_tls_peap_c * get_am_partner();

	void type_configure_readL(

		eap_config_string field,

		const u32_t field_length,

		eap_variable_data_c * const data);

	void verify_certificate_chainL(

		EAP_TEMPLATE_CONST eap_array_c<eap_variable_data_c> * const certificate_chain,

		const tls_cipher_suites_e required_cipher_suite);

	void WriteBinaryParamL(

		eap_config_string field,

		const u32_t field_length,

		const eap_variable_data_c * const data);

	void WriteIntParamL(

		eap_config_string field,

		const u32_t field_length,

		eap_variable_data_c * const data);

	void WriteIntParamL(

		eap_config_string field,

		const u32_t field_length,

		const u32_t value);

	void get_identity_from_alternative_nameL(

		const CX509Certificate * const aCertificate, 

		eap_variable_data_c * const aIdentity);

	void get_identities_from_distinguished_namesL(

		const CX509Certificate * const aCertificate, 

		eap_variable_data_c * const aSubjectIdentity,

		eap_variable_data_c * const aIssuerIdentity);

	eap_status_e load_module(

		const eap_type_value_e type,

		const eap_type_value_e /* tunneling_type */,

		abs_eap_base_type_c * const partner,

		eap_base_type_c ** const eap_type,

		const bool is_client_when_true,

		const eap_am_network_id_c * const receive_network_id);

	eap_status_e check_is_valid_eap_type(const eap_type_value_e eap_type);

	eap_status_e get_eap_type_list(

		eap_array_c<eap_type_value_e> * const eap_type_list);

	eap_status_e unload_module(const eap_type_value_e type);

	void complete_signL(const RInteger& aR, const RInteger& aS, eap_status_e aStatus);

	eap_status_e get_realms_from_certificate(

		CX509Certificate* certificate,

		eap_variable_data_c * const subject_realm,

		eap_variable_data_c * const issuer_realm);

	void authentication_finishedL(

		const bool true_when_successful,

		const tls_session_type_e tls_session_type);

	void read_dsa_parametersL();

	eap_status_e SaveManualIdentityL( 

		const TBool use_manual_username,

		TDesC& manual_username,

		const TBool use_manual_realm,

		TDesC& manual_realm);

	void send_error_notification(const eap_status_e error);

	void ResetSessionIdL();

	/**

	 * Returns true if the full authenticated session is valid.

	 * It finds the difference between current time and the 

	 * last full authentication time. If the difference is less than the

	 * Maximum Session Validity Time, then session is valid, returns true.

	 * Otherwise returns false. 

	 * Full authentication should be done if the session is not valid.

	 */

	bool is_session_validL();

	/**

	 * Stores current universal time as the the full authentication time

	 * in the database. Returns KErrNone if storing succeeds.

	 */

	void store_authentication_timeL();

#ifdef USE_PAC_STORE

	void GetPacStoreDbDataL(

		const eap_pac_store_data_type_e aPacStoreDataType,

		eap_variable_data_c * aPacStoreData,

		const eap_variable_data_c * const aPacStoreReference = NULL);

#endif	// End: #ifdef USE_PAC_STORE	

#if defined(USE_FAST_EAP_TYPE)

	void ReadPACStoredataL(

		const eap_fast_pac_store_pending_operation_e in_pending_operation,

		EAP_TEMPLATE_CONST eap_array_c<eap_fast_pac_store_data_c> * const in_references);

	void WritePACStoreDataL(

		const eap_fast_pac_store_pending_operation_e in_pending_operation,

		EAP_TEMPLATE_CONST eap_array_c<eap_fast_pac_store_data_c> * const in_references_and_data_blocks);

	eap_status_e RemoveIAPReference();

	eap_status_e ImportFilesL();

	eap_status_e PasswordQueryL();

	eap_status_e CompletePasswordQueryL();

	eap_status_e CompleteFilePasswordQueryL();

	eap_status_e CompleteFilePasswordQuery();

	eap_status_e FinalCompleteReadPACStoreDataL(eap_status_e status);

	void ConvertUnicodeToAsciiL(const TDesC16& aFromUnicode, TDes8& aToAscii);

	eap_status_e ConfigureL();

	eap_status_e CreateMasterkeyL();

	eap_status_e QueryUserPermissionForAIDL(

			const eap_fast_variable_data_c * const in_pac_attribute_A_ID_info,

			const eap_fast_variable_data_c * const in_pac_attribute_A_ID);

	void CompleteAddImportedPACFileL(

			const eap_variable_data_c * const in_imported_PAC_filename,

			const eap_variable_data_c * const out_used_group_reference);

#endif //#if defined(USE_FAST_EAP_TYPE)		

    /**

    * Check whether password is older than allowed

    * by max TTLS-PAP session timeout.

    * 

    * @return ETrue - session is valid, EFalse - otherwise.

    */ 

	TBool IsTtlsPapSessionValidL();

	/**