eapol/eapol_framework/eapol_common/am/include/abs_eap_am_radius.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_RADIUS_H_)
       
    22 #define _ABS_EAP_AM_TYPE_RADIUS_H_
       
    23 
       
    24 #include "eap_am_export.h"
       
    25 #include "eap_sim_triplets.h"
       
    26 #include "eap_radius_types.h"
       
    27 
       
    28 /// This class declares the functions adaptation module of RADIUS EAP type
       
    29 /// requires from the RADIUS EAP type.
       
    30 class EAP_EXPORT abs_eap_am_radius_c
       
    31 {
       
    32 private:
       
    33 	//--------------------------------------------------
       
    34 
       
    35 	//--------------------------------------------------
       
    36 protected:
       
    37 	//--------------------------------------------------
       
    38 
       
    39 	//--------------------------------------------------
       
    40 public:
       
    41 	//--------------------------------------------------
       
    42 
       
    43 	// 
       
    44 	virtual ~abs_eap_am_radius_c()
       
    45 	{
       
    46 	}
       
    47 
       
    48 	// 
       
    49 	abs_eap_am_radius_c()
       
    50 	{
       
    51 	}
       
    52 
       
    53 	virtual bool get_is_client() = 0;
       
    54 
       
    55 	/** Client adaptation module of RADIUS EAP type calls this function.
       
    56 	 *  AM gives IMSI and optional pseydonym to RADIUS EAP type.
       
    57 	 *  This function completes asyncronously query_SIM_IMSI_or_pseudonym_or_reauthentication_id() function call.
       
    58 	 */
       
    59 	virtual eap_status_e complete_SIM_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, ///< This could be zero pointer if this is not used.
       
    64 		const eap_radius_complete_e required_completion,
       
    65 		const u8_t received_eap_identifier,
       
    66 		const eap_status_e completion_status) = 0;
       
    67 
       
    68 
       
    69 #if defined(USE_EAP_TYPE_SERVER_RADIUS)
       
    70 	/** Server adaptation module of RADIUS EAP type calls this function.
       
    71 	 *  AM give triplets to RADIUS EAP type.
       
    72 	 *  This function completes asyncronously query_SIM_triplets() function call.
       
    73 	 */
       
    74 	virtual eap_status_e complete_SIM_triplets(
       
    75 		eap_type_sim_triplet_array_c * const triplets,
       
    76 		const eap_variable_data_c * const IMSI,
       
    77 		const eap_radius_triplet_status_e triplet_status,
       
    78 		const eap_radius_identity_type type,
       
    79 		const eap_status_e completion_status) = 0;
       
    80 #endif //#if defined(USE_EAP_TYPE_SERVER_RADIUS)
       
    81 
       
    82 
       
    83 	/** Client adaptation module of RADIUS EAP type calls this function.
       
    84 	 *  AM gives n RANDs, n Kcs and n SRESs to RADIUS EAP type.
       
    85 	 *  This function completes asyncronously query_SIM_kc_sres() function call.
       
    86 	 */
       
    87 	virtual eap_status_e complete_SIM_kc_sres(
       
    88 		const eap_variable_data_c * const n_rand,
       
    89 		const eap_variable_data_c * const n_kc,
       
    90 		const eap_variable_data_c * const n_sres,
       
    91 		const eap_status_e completion_status) = 0;
       
    92 
       
    93 
       
    94 #if defined(USE_EAP_TYPE_SERVER_RADIUS)
       
    95 	/** Server adaptation module of RADIUS EAP type calls this function.
       
    96 	 *  AM gives IMSI and username to RADIUS EAP type.
       
    97 	 *  This function completes asyncronously query_imsi_from_username() function call.
       
    98 	 */
       
    99 	virtual eap_status_e complete_imsi_from_username(
       
   100 		const u8_t next_eap_identifier,
       
   101 		const eap_am_network_id_c * const network_id,
       
   102 		const eap_variable_data_c * const username,
       
   103 		const eap_variable_data_c * const imsi,
       
   104 		const eap_radius_identity_type type,
       
   105 		const eap_status_e completion_status,
       
   106 		const eap_radius_complete_e completion_action) = 0;
       
   107 #endif //#if defined(USE_EAP_TYPE_SERVER_RADIUS)
       
   108 
       
   109 
       
   110 	//--------------------------------------------------
       
   111 }; // class abs_eap_am_radius_c
       
   112 
       
   113 #endif //#if !defined(_ABS_EAP_AM_TYPE_RADIUS_H_)
       
   114 
       
   115 //--------------------------------------------------
       
   116 
       
   117 
       
   118 
       
   119 // End.