eapol/eapol_framework/eapol_common/am/include/abs_eap_am_type_aka.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_EAP_AM_TYPE_AKA_H_)
       
    22 #define _ABS_EAP_AM_TYPE_AKA_H_
       
    23 
       
    24 #include "eap_am_export.h"
       
    25 #include "eap_type_aka_authentication_vector.h"
       
    26 #include "eap_type_aka_types.h"
       
    27 
       
    28 /// This class declares the functions adaptation module of AKA EAP type
       
    29 /// requires from the AKA EAP type.
       
    30 class EAP_EXPORT abs_eap_am_type_aka_c
       
    31 {
       
    32 private:
       
    33 	//--------------------------------------------------
       
    34 
       
    35 	//--------------------------------------------------
       
    36 protected:
       
    37 	//--------------------------------------------------
       
    38 
       
    39 	//--------------------------------------------------
       
    40 public:
       
    41 	//--------------------------------------------------
       
    42 
       
    43 	// 
       
    44 	virtual ~abs_eap_am_type_aka_c()
       
    45 	{
       
    46 	}
       
    47 
       
    48 	// 
       
    49 	abs_eap_am_type_aka_c()
       
    50 	{
       
    51 	}
       
    52 
       
    53 	virtual bool get_is_client() = 0;
       
    54 
       
    55 	/** Client adaptation module of AKA EAP type calls this function.
       
    56 	 *  AM gives IMSI and optional pseydonym to AKA EAP type.
       
    57 	 *  This function completes asyncronously query_AKA_IMSI_or_pseudonym_or_reauthentication_id() function call.
       
    58 	 */
       
    59 	virtual eap_status_e complete_AKA_IMSI_or_pseudonym_or_reauthentication_id_query(
       
    60 		const eap_variable_data_c * const IMSI,
       
    61 		const eap_variable_data_c * const pseudonym,
       
    62 		const eap_variable_data_c * const reauthentication_identity,
       
    63 		const eap_variable_data_c * const automatic_realm, ///< If this is not used, do not add any data to this parameter.
       
    64 		const u32_t length_of_mnc,
       
    65 		const eap_type_aka_complete_e required_completion,
       
    66 		const u8_t received_eap_identifier,
       
    67 		const eap_status_e completion_status) = 0;
       
    68 
       
    69 	/** Server adaptation module of AKA EAP type calls this function.
       
    70 	 *  AM give triplets to AKA EAP type.
       
    71 	 *  This function completes asyncronously query_AKA_authentication_vector() function call.
       
    72 	 */
       
    73 	virtual eap_status_e complete_AKA_authentication_vector_query(
       
    74 		eap_type_aka_authentication_vector_c * const authentication_vector,
       
    75 		const eap_variable_data_c * const IMSI,
       
    76 		const eap_aka_authentication_vector_status_e authentication_vector_status,
       
    77 		const eap_type_aka_identity_type type,
       
    78 		const eap_status_e completion_status,
       
    79 		const u8_t next_eap_identifier) = 0;
       
    80 
       
    81 	/** Client adaptation module of AKA EAP type calls this function.
       
    82 	 *  AM gives n RANDs, n Kcs and n SRESs to AKA EAP type.
       
    83 	 *  This function completes asyncronously query_AKA_RES() function call.
       
    84 	 */
       
    85 	virtual eap_status_e complete_AKA_RES_query(
       
    86 		const eap_type_aka_authentication_vector_c * const authentication_vector,
       
    87 		const eap_status_e completion_status) = 0;
       
    88 
       
    89 	/** Server adaptation module of AKA EAP type calls this function.
       
    90 	 *  AM gives IMSI and username to AKA EAP type.
       
    91 	 *  This function completes asyncronously query_imsi_from_username() function call.
       
    92 	 */
       
    93 	virtual eap_status_e complete_imsi_from_username(
       
    94 		const u8_t next_eap_identifier,
       
    95 		const eap_am_network_id_c * const network_id,
       
    96 		const eap_variable_data_c * const username,
       
    97 		const eap_variable_data_c * const imsi,
       
    98 		const eap_type_aka_identity_type type,
       
    99 		const eap_status_e completion_status,
       
   100 		const eap_type_aka_complete_e completion_action) = 0;
       
   101 
       
   102 	/** Server adaptation module of AKA EAP type calls this function.
       
   103 	 *  AM gives new authentication vector to AKA EAP type.
       
   104 	 *  This function completes asyncronously query_re_syncronization() function call.
       
   105 	 */
       
   106 	virtual eap_status_e complete_re_syncronization_query(
       
   107 		const u8_t next_eap_identifier,
       
   108 		const eap_type_aka_authentication_vector_c * const authentication_vector) = 0;
       
   109 
       
   110 	//--------------------------------------------------
       
   111 }; // class abs_eap_am_type_aka_c
       
   112 
       
   113 #endif //#if !defined(_ABS_EAP_AM_TYPE_AKA_H_)
       
   114 
       
   115 //--------------------------------------------------
       
   116 
       
   117 
       
   118 
       
   119 // End.