eapol/eapol_framework/eapol_common/am/include/abs_tls_am_application_eap_fast.h
changeset 0 c8830336c852
child 2 1c7bc153c08e
equal deleted inserted replaced
-1:000000000000 0:c8830336c852
       
     1 /*
       
     2 * Copyright (c) 2001-2006 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of the License "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  EAP and WLAN authentication protocols.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 #if !defined(_ABS_TLS_AM_APPLICATION_EAP_FAST_H_)
       
    22 #define _ABS_TLS_AM_APPLICATION_EAP_FAST_H_
       
    23 
       
    24 #if defined(USE_FAST_EAP_TYPE)
       
    25 
       
    26 #include "eap_am_export.h"
       
    27 #include "eap_array.h"
       
    28 
       
    29 #if defined(USE_EAP_TLS_SESSION_TICKET)
       
    30 class tls_extension_c;
       
    31 #endif // #if defined(USE_EAP_TLS_SESSION_TICKET)
       
    32 
       
    33 /// This class declares the functions adaptation module of TLS
       
    34 /// requires from the TLS.
       
    35 class EAP_EXPORT abs_tls_am_application_eap_fast_c
       
    36 {
       
    37 private:
       
    38 	//--------------------------------------------------
       
    39 
       
    40 	//--------------------------------------------------
       
    41 protected:
       
    42 	//--------------------------------------------------
       
    43 
       
    44 	//--------------------------------------------------
       
    45 public:
       
    46 	//--------------------------------------------------
       
    47 
       
    48 	/// Destructor does nothing.
       
    49 	virtual ~abs_tls_am_application_eap_fast_c()
       
    50 	{
       
    51 	}
       
    52 
       
    53 	/// Constructor does nothing.
       
    54 	abs_tls_am_application_eap_fast_c()
       
    55 	{
       
    56 	}
       
    57 
       
    58 	/**
       
    59 	 * This function call completes initialize_PAC_store() function call.
       
    60 	 * After all imported PAC files are handled, AM must call this function.
       
    61 	 * EAP-FAST authentication will continue within this function call.
       
    62 	 */
       
    63 	virtual eap_status_e complete_initialize_PAC_store(
       
    64 		const eap_fast_completion_operation_e completion_operation,
       
    65 		const eap_fast_initialize_pac_store_completion_e completion) = 0;
       
    66 
       
    67 	/**
       
    68 	 * This function call completes query_pac_of_type() function call.
       
    69 	 * This function is used in test server.
       
    70 	 */
       
    71 	virtual eap_status_e complete_query_pac_of_type(
       
    72 		const eap_fast_variable_data_c * const pac_tlv,
       
    73 		const eap_fast_pac_type_e pac_type) = 0;
       
    74 
       
    75 	/**
       
    76 	 * This function call completes verify_pac() function call.
       
    77 	 * This function is used in test server.
       
    78 	 */
       
    79 	virtual eap_status_e complete_verify_pac(
       
    80 		const eap_status_e verification_status,
       
    81 		const eap_fast_pac_type_e pac_type) = 0;
       
    82 
       
    83 	/**
       
    84 	 * This function call removes cached PAC store data.
       
    85 	 */
       
    86 	virtual eap_status_e remove_cached_pac_store_data() = 0;
       
    87 
       
    88 	// This is commented in eap_fast_pac_store_c::add_imported_PAC_file().
       
    89 	virtual eap_status_e add_imported_PAC_file(
       
    90 		const eap_variable_data_c * const in_IAP_reference,
       
    91 		const eap_fast_pac_store_data_c * const in_opt_group_reference_and_data,
       
    92 		const eap_variable_data_c * const in_imported_PAC_data,
       
    93 		const eap_variable_data_c * const in_imported_PAC_filename) = 0;
       
    94 
       
    95 	// This is commented in eap_fast_pac_store_c::remove_IAP_reference().
       
    96 	virtual eap_status_e remove_IAP_reference(
       
    97 		const eap_variable_data_c * const in_IAP_reference,
       
    98 		const eap_fast_pac_store_data_c * const in_opt_group_reference_and_data) = 0;
       
    99 
       
   100 
       
   101 	// This is commented in eap_fast_pac_store_c::complete_query_user_permission_for_A_ID().
       
   102 	virtual eap_status_e complete_query_user_permission_for_A_ID(
       
   103 		const eap_status_e in_completion_status,
       
   104 		const eap_fast_pac_store_pending_operation_e in_pending_operation) = 0;
       
   105 
       
   106 	// This is commented in eap_fast_pac_store_c::complete_read_PAC_store_data().
       
   107 	virtual eap_status_e complete_read_PAC_store_data(
       
   108 		const eap_status_e in_completion_status,
       
   109 		const eap_fast_pac_store_pending_operation_e in_pending_operation,
       
   110 		EAP_TEMPLATE_CONST eap_array_c<eap_fast_pac_store_data_c> * const in_references_and_data_blocks) = 0;
       
   111 	
       
   112 	// This is commented in eap_fast_pac_store_c::complete_write_PAC_store_data().
       
   113 	virtual eap_status_e complete_write_PAC_store_data(
       
   114 		const eap_status_e in_completion_status,
       
   115 		const eap_fast_pac_store_pending_operation_e in_pending_operation) = 0;
       
   116 
       
   117 	//--------------------------------------------------
       
   118 }; // class abs_tls_am_application_eap_fast_c
       
   119 
       
   120 #endif //#if defined(USE_FAST_EAP_TYPE)
       
   121 
       
   122 #endif //#if !defined(_ABS_TLS_AM_APPLICATION_EAP_FAST_H_)
       
   123 
       
   124 //--------------------------------------------------
       
   125 
       
   126 
       
   127 
       
   128 // End.