eapol/eapol_framework/eapol_common/type/tls_peap/tls/include/tls_extension.h
changeset 0 c8830336c852
child 2 1c7bc153c08e
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/eapol/eapol_framework/eapol_common/type/tls_peap/tls/include/tls_extension.h	Thu Dec 17 08:47:43 2009 +0200
@@ -0,0 +1,179 @@
+/*
+* 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(_TLS_EXTENSION_H_)
+#define _TLS_EXTENSION_H_
+
+#if defined(USE_EAP_TLS_SESSION_TICKET)
+
+#include "eap_tools.h"
+#include "eap_array.h"
+#include "eap_variable_data.h"
+#if defined(USE_FAST_EAP_TYPE)
+#include "eap_fast_tlv_header.h"
+#endif //#if defined(USE_FAST_EAP_TYPE)
+
+/** @file */
+
+/**
+ * This is enumeration of TLS competion actions.
+ */
+enum tls_extension_type_e
+{
+	tls_extension_type_none = 65535,               ///< Initialization value means no type.
+	tls_extension_type_server_name = 0,            ///< Server Name Indication, see RFC 4366
+	tls_extension_type_max_frame_length = 1,       ///< Maximum Fragment Length Negotiation, see RFC 4366
+	tls_extension_type_client_certificate_url = 2, ///< Client Certificate URLs, see RFC 4366
+	tls_extension_type_trusted_ca_keys = 3,        ///< Trusted CA Indication, see RFC 4366
+	tls_extension_type_truncated_hmac = 4,         ///< Truncated HMAC, see RFC 4366
+	tls_extension_type_status_request = 5,         ///< Certificate Status Request, see RFC 4366
+	tls_extension_type_session_ticket = 35,        ///< Session Ticket, see RFC 4507
+};
+
+//----------------------------------------------------------------------------
+
+
+/// This class defines one TLS completion action.
+class EAP_EXPORT tls_extension_c
+: public eap_variable_data_c
+{
+private:
+	//--------------------------------------------------
+
+	/// This is pointer to the tools class. @see abs_eap_am_tools_c.
+	abs_eap_am_tools_c * const m_am_tools;
+
+	/// This variable stores the lifetime hint of extension.
+	u32_t m_lifetime_hint;
+
+	/// This variable stores the type of extension.
+	tls_extension_type_e m_type;
+
+#if defined(USE_FAST_EAP_TYPE)
+	/// This variable stores the PAC-Type for fast access.
+	eap_fast_pac_type_e m_pac_type;
+#endif //#if defined(USE_FAST_EAP_TYPE)
+
+	/// This indicates whether this object was generated successfully.
+	bool m_is_valid;
+
+	/**
+	 * The set_is_valid() function sets the state of the object valid.
+	 * The creator of this object calls this function after it is initialized. 
+	 */
+	EAP_FUNC_IMPORT void set_is_valid();
+
+	//--------------------------------------------------
+protected:
+	//--------------------------------------------------
+
+	//--------------------------------------------------
+public:
+	//--------------------------------------------------
+
+	/**
+	 * Destructor does nothing special.
+	 */
+	EAP_FUNC_IMPORT virtual ~tls_extension_c();
+
+	/**
+	 * Constructor initializes object.
+	 */
+	EAP_FUNC_IMPORT tls_extension_c(
+		abs_eap_am_tools_c * const tools);
+
+	/**
+	 * Function copies the object.
+	 */
+	tls_extension_c * copy() const;
+
+	/**
+	 * Object must indicate it's validity.
+	 * If object initialization fails this function must return false.
+	 * @return This function returns the validity of this object.
+	 */
+	EAP_FUNC_IMPORT bool get_is_valid();
+
+	/**
+	 * This function sets the extension lifitime hint.
+	 */
+	EAP_FUNC_IMPORT void set_lifetime_hint(const u32_t lifetime_hint);
+
+	/**
+	 * This function gets the extension lifetime hint.
+	 */
+	EAP_FUNC_IMPORT u32_t get_lifetime_hint() const;
+
+	/**
+	 * This function sets the extension type.
+	 */
+	EAP_FUNC_IMPORT void set_type(const tls_extension_type_e type);
+
+	/**
+	 * This function gets the extension type.
+	 */
+	EAP_FUNC_IMPORT tls_extension_type_e get_type() const;
+
+#if defined(USE_FAST_EAP_TYPE)
+
+	/// This function stores the PAC-Type for fast access.
+	EAP_FUNC_IMPORT void set_pac_type(const eap_fast_pac_type_e pac_type);
+
+	/// This function returns the PAC-Type for fast access.
+	EAP_FUNC_IMPORT eap_fast_pac_type_e get_pac_type() const;
+
+#endif //#if defined(USE_FAST_EAP_TYPE)
+
+	/**
+	 * This function gets the debug string of the extension type.
+	 */
+	EAP_FUNC_IMPORT static eap_const_string  get_type_string(tls_extension_type_e type);
+
+	/**
+	 * This function gets the extension from the array of extensions.
+	 */
+	EAP_FUNC_IMPORT static const tls_extension_c * get_tls_extension(
+		const tls_extension_type_e tls_extension_type,
+		EAP_TEMPLATE_CONST eap_array_c<tls_extension_c> * const tls_extensions,
+		abs_eap_am_tools_c * const am_tools);
+
+#if defined(USE_FAST_EAP_TYPE)
+	/**
+	 * This function gets the extension from the array of extensions.
+	 */
+	EAP_FUNC_IMPORT static const tls_extension_c * get_tls_extension(
+		const tls_extension_type_e tls_extension_type,
+		const eap_fast_pac_type_e pac_type,
+		EAP_TEMPLATE_CONST eap_array_c<tls_extension_c> * const tls_extensions,
+		abs_eap_am_tools_c * const am_tools);
+#endif //#if defined(USE_FAST_EAP_TYPE)
+
+	// 
+	//--------------------------------------------------
+}; // class tls_extension_c
+
+
+//--------------------------------------------------
+
+#endif //#if defined(USE_EAP_TLS_SESSION_TICKET)
+
+#endif //#if !defined(_TLS_EXTENSION_H_)
+
+// End.