eapol/eapol_framework/eapol_common/include/eap_pac_store_server_message_if.h
changeset 33 938269283a16
child 49 43351a4f2da3
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/eapol/eapol_framework/eapol_common/include/eap_pac_store_server_message_if.h	Fri Jun 11 13:40:22 2010 +0300
@@ -0,0 +1,188 @@
+/*
+* 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: %
+*/
+
+#if !defined(_EAP_PAC_STORE_SERVER_MESSAGE_IF_H_)
+#define _EAP_PAC_STORE_SERVER_MESSAGE_IF_H_
+
+#include "eap_tools.h"
+#include "eap_am_export.h"
+#include "abs_eap_session_core.h"
+#include "eap_variable_data.h"
+#include "abs_eap_am_mutex.h"
+#include "eap_session_core_base.h"
+#include "abs_eap_am_message_if.h"
+#include "eap_am_message_if.h"
+#include "eap_process_tlv_message_data.h"
+#include "abs_eap_am_pac_store.h"
+#include "eap_am_pac_store.h"
+
+
+/** @file */
+
+
+/// A eap_pac_store_server_message_if_c class implements the basic functionality of EAPOL.
+class EAP_EXPORT eap_pac_store_server_message_if_c
+: public abs_eap_am_pac_store_c
+, public eap_am_message_if_c
+, public abs_eap_base_timer_c
+{
+
+private:
+	//--------------------------------------------------
+
+	/// This is back pointer to object which created this object.
+	abs_eap_am_message_if_c * m_partner;
+
+	eap_am_pac_store_c * const m_am_client;
+
+	/// This is pointer to the tools class.
+	abs_eap_am_tools_c * const m_am_tools;
+
+	eap_status_e m_error_code;
+
+	eap_tlv_message_type_function_e m_error_function;
+
+	/// This indicates whether this object is client (true) or server (false).
+	/// In terms of EAP-protocol whether this network entity is EAP-supplicant (true) or EAP-authenticator (false).
+	bool m_is_client;
+
+	/// This indicates whether this object was generated successfully.
+	bool m_is_valid;
+
+	bool m_shutdown_was_called;
+
+	eap_status_e send_error_message(
+		const eap_status_e error_code,
+		const eap_tlv_message_type_function_e function);
+
+	eap_status_e send_message(eap_process_tlv_message_data_c * const message);
+
+	eap_status_e process_message_type_error(
+		EAP_TEMPLATE_CONST eap_array_c<eap_tlv_header_c> * const parameters);
+
+	eap_status_e process_message(eap_process_tlv_message_data_c * const message);
+
+	eap_status_e open_pac_store(EAP_TEMPLATE_CONST eap_array_c<eap_tlv_header_c> * const parameters);
+	eap_status_e create_device_seed(EAP_TEMPLATE_CONST eap_array_c<eap_tlv_header_c> * const parameters);
+    eap_status_e is_master_key_present(EAP_TEMPLATE_CONST eap_array_c<eap_tlv_header_c> * const parameters);
+    eap_status_e is_master_key_and_password_matching(EAP_TEMPLATE_CONST eap_array_c<eap_tlv_header_c> * const parameters);
+    eap_status_e create_and_save_master_key(EAP_TEMPLATE_CONST eap_array_c<eap_tlv_header_c> * const parameters);
+    eap_status_e compare_pac_store_password(EAP_TEMPLATE_CONST eap_array_c<eap_tlv_header_c> * const parameters);
+    eap_status_e is_pacstore_password_present(EAP_TEMPLATE_CONST eap_array_c<eap_tlv_header_c> * const parameters);
+    eap_status_e set_pac_store_password(EAP_TEMPLATE_CONST eap_array_c<eap_tlv_header_c> * const parameters);
+    eap_status_e destroy_pac_store(EAP_TEMPLATE_CONST eap_array_c<eap_tlv_header_c> * const parameters);
+	
+    eap_status_e set_eap_methods(
+		EAP_TEMPLATE_CONST eap_array_c<eap_tlv_header_c> * const parameters);
+
+	eap_status_e get_eap_methods(
+		EAP_TEMPLATE_CONST eap_array_c<eap_tlv_header_c> * const parameters);
+
+	eap_status_e get_certificate_lists(
+		EAP_TEMPLATE_CONST eap_array_c<eap_tlv_header_c> * const parameters);
+
+	//--------------------------------------------------
+protected:
+	//--------------------------------------------------
+
+	//--------------------------------------------------
+public:
+	//--------------------------------------------------
+
+	/**
+	 * The destructor deletes the m_eap_core object.
+	 */
+	EAP_FUNC_IMPORT virtual ~eap_pac_store_server_message_if_c();
+
+	/**
+	 * The constructor creates the eap_core object and initializes the m_eap_core
+	 * to point the eap_core object.
+	 * @param tools is pointer to the tools class. @see abs_eap_am_tools_c.
+	 */
+	EAP_FUNC_IMPORT eap_pac_store_server_message_if_c(
+		abs_eap_am_tools_c * const tools);
+
+	static eap_pac_store_server_message_if_c * new_eap_pac_store_server_message_if_c(
+	    abs_eap_am_tools_c * const tools);
+	
+	EAP_FUNC_IMPORT void set_partner(abs_eap_am_message_if_c * const partner);
+
+	EAP_FUNC_IMPORT eap_status_e process_data(const void * const data, const u32_t length);
+
+	// This is documented in abs_eap_stack_interface_c::configure().
+	EAP_FUNC_IMPORT eap_status_e configure(
+		const eap_variable_data_c * const client_configuration);
+
+	// This is documented in abs_eap_stack_interface_c::shutdown().
+	EAP_FUNC_IMPORT eap_status_e shutdown();
+
+	// This is documented in abs_eap_stack_interface_c::set_is_valid().
+	EAP_FUNC_IMPORT void set_is_valid();
+
+	// This is documented in abs_eap_stack_interface_c::get_is_valid().
+	EAP_FUNC_IMPORT bool get_is_valid();
+
+	// See abs_eap_base_timer_c::timer_expired().
+	EAP_FUNC_IMPORT eap_status_e timer_expired(
+		const u32_t id, void *data);
+
+	// See abs_eap_base_timer_c::timer_delete_data().
+	EAP_FUNC_IMPORT eap_status_e timer_delete_data(
+		const u32_t id, void *data);
+
+
+	EAP_FUNC_IMPORT eap_status_e complete_open_pac_store(
+        const eap_status_e completion_status);
+
+	EAP_FUNC_IMPORT eap_status_e complete_create_device_seed(
+        const eap_status_e completion_status);
+
+	EAP_FUNC_IMPORT eap_status_e complete_is_master_key_present(
+      const bool is_present);
+
+	EAP_FUNC_IMPORT eap_status_e complete_is_master_key_and_password_matching(
+      const bool is_matching);
+
+	EAP_FUNC_IMPORT eap_status_e complete_create_and_save_master_key(
+        const eap_status_e completion_status);
+
+	EAP_FUNC_IMPORT eap_status_e complete_is_pacstore_password_present(
+        const bool is_present);
+
+	EAP_FUNC_IMPORT eap_status_e complete_compare_pac_store_password(
+        const bool is_matching);
+
+	EAP_FUNC_IMPORT eap_status_e complete_set_pac_store_password(
+        const eap_status_e completion_status);
+
+	EAP_FUNC_IMPORT eap_status_e complete_destroy_pac_store(
+        const eap_status_e completion_status);
+
+	//--------------------------------------------------
+}; // class eap_pac_store_server_message_if_c
+
+#endif //#if !defined(_EAP_PAC_STORE_SERVER_MESSAGE_IF_H_)
+
+//--------------------------------------------------
+
+
+
+// End.