/*
* 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: 18 %
*/

#ifndef _EAP_AM_TYPE_MSCHAPV2_SYMBIAN_H_
#define _EAP_AM_TYPE_MSCHAPV2_SYMBIAN_H_

//  INCLUDES
#include "eap_am_tools_symbian.h"
#include "abs_eap_base_type.h"
#include "eap_am_type_mschapv2.h"
#include "eap_type_mschapv2.h"
#include "EapMsChapV2NotifierStructs.h"
#include <EapType.h>
#include <d32dbms.h>

const TUint KDefaultTimeoutEAPMsChapV2 = 120000;

/**
* Class that implements the operating system dependent portion of EAP Ms-Chap-v2 protocol.
* For Symbian OS.
*/
class EAP_EXPORT eap_am_type_mschapv2_symbian_c
: public CActive, public eap_am_type_mschapv2_c
{
private:
	//--------------------------------------------------
	eap_am_tools_symbian_c * const m_am_tools;

	abs_eap_base_type_c * const m_partner;

	RDbs m_session;

	RDbNamedDatabase m_database;

	enum TState 
	{
		EHandlingUsernamePasswordQuery,
		EHandlingChangePasswordQuery,
	};

	TState m_state;

	RNotifier m_notifier;

	eap_variable_data_c * m_username_utf8;
	eap_variable_data_c * m_password_utf8;
	eap_variable_data_c * m_old_password_utf8;
	bool * m_password_prompt_enabled;
	bool m_is_identity_query;

	TEapMsChapV2UsernamePasswordInfo * m_username_password_io_ptr;
	TPckg<TEapMsChapV2UsernamePasswordInfo> * m_username_password_io_pckg_ptr;

	eap_am_network_id_c m_receive_network_id;

	TIndexType m_index_type;
	
	TInt m_index;

	eap_type_value_e m_tunneling_type;

	bool m_is_client;

	bool m_is_valid;

	bool m_shutdown_was_called;
	
	bool m_is_notifier_connected; // Tells if notifier server is connected.

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

	// This is the vendor-type for tunneling EAP type.
	// Valid for both expanded and non-expanded EAP types.
	// This is used since m_tunneling_type can not be used in the same way 
	// in expanded and non-expanded cases. 
	// Unlike EAP type, Tunneling type is still non-expanded
	// for both cases especially for using in the EAP databases.
	u32_t m_tunneling_vendor_type;	

	void send_error_notification(const eap_status_e error);

	bool is_session_validL();
	
	/**
	 * Stores current universal time as the the full authentication time
	 * in the database. Leaves if storing fails.
	 */
	void store_authentication_timeL();	

	//--------------------------------------------------
protected:
	//--------------------------------------------------

	eap_am_type_mschapv2_symbian_c(
		abs_eap_am_tools_c * const m_am_tools,
		abs_eap_base_type_c * const partner,
		const TIndexType aIndexType,
		const TInt aIndex,
		const eap_type_value_e aTunnelingType,
		const bool aIsClient,
		const eap_am_network_id_c * const receive_network_id);

	void ConstructL();

	void RunL();
	
	void DoCancel();

	void type_configure_updateL();

	//--------------------------------------------------
public:
	//--------------------------------------------------

	static eap_am_type_mschapv2_symbian_c* NewL(
		abs_eap_am_tools_c * const aTools,
		abs_eap_base_type_c * const aPartner,
		const TIndexType aIndexType,
		const TInt aIndex,
		const eap_type_value_e aTunnelingType,
		const bool aIsClient,
		const eap_am_network_id_c * const receive_network_id);

	// 
	EAP_FUNC_IMPORT virtual ~eap_am_type_mschapv2_symbian_c();

	eap_status_e show_username_password_dialog(
		eap_variable_data_c & username,
		eap_variable_data_c & password,
		bool & password_prompt_enabled,
		bool is_identity_query);

	eap_status_e show_change_password_dialog(
		eap_variable_data_c & username,
		eap_variable_data_c & old_password,
		eap_variable_data_c & password,
		bool & password_prompt_enabled);

	// 
	EAP_FUNC_IMPORT eap_status_e configure();

	EAP_FUNC_IMPORT eap_status_e reset();

	EAP_FUNC_IMPORT eap_status_e update_username_password();	

	EAP_FUNC_IMPORT void set_is_valid();

	EAP_FUNC_IMPORT bool get_is_valid();

	EAP_FUNC_IMPORT eap_status_e type_configure_read(
		const eap_configuration_field_c * const field,
		eap_variable_data_c * const data);

	void type_configure_readL(
		eap_config_string field,
		const u32_t field_length,
		eap_variable_data_c * const data);

	EAP_FUNC_IMPORT eap_status_e type_configure_write(
		const eap_configuration_field_c * const field,
		eap_variable_data_c * const data);

	EAP_FUNC_IMPORT eap_status_e shutdown();

	EAP_FUNC_IMPORT eap_status_e read_auth_failure_string(eap_mschapv2_error_e error_code, eap_variable_data_c &string);

	EAP_FUNC_IMPORT eap_status_e get_memory_store_key(eap_variable_data_c * const memory_store_key);
	
	/**
	 * 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 (using pw query) should be done if the session is not valid.
	 */
	bool is_session_valid();
	
	/**
	 * Stores current universal time as the the full authentication time
	 * in the database by calling the leaving function store_authentication_time_L.
	 * Returns appropriate error if storing fails. eap_status_ok for successful storing.
	 */
	eap_status_e store_authentication_time();	

}; // class eap_am_type_mschapv2_symbian_c


#endif // _EAP_AM_TYPE_MSCHAPV2_SYMBIAN_H_

// End of file
