eapol/eapol_framework/eapol_symbian/am/include/eap_am_type_gsmsim_symbian_simulator.h
changeset 49 43351a4f2da3
parent 26 9abfd4f00d37
equal deleted inserted replaced
47:712b4ffd76bb 49:43351a4f2da3
    22 #if !defined(_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H_)
    22 #if !defined(_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H_)
    23 #define _EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H_
    23 #define _EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H_
    24 
    24 
    25 #include "eap_tools.h"
    25 #include "eap_tools.h"
    26 #include "eap_am_export.h"
    26 #include "eap_am_export.h"
       
    27 // Start: added by script change_export_macros.sh.
       
    28 #if defined(EAP_NO_EXPORT_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H)
       
    29 	#define EAP_CLASS_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H EAP_NONSHARABLE 
       
    30 	#define EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H 
       
    31 	#define EAP_C_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H 
       
    32 	#define EAP_FUNC_EXPORT_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H 
       
    33 	#define EAP_C_FUNC_EXPORT_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H 
       
    34 #elif defined(EAP_EXPORT_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H)
       
    35 	#define EAP_CLASS_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H EAP_EXPORT 
       
    36 	#define EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H EAP_FUNC_EXPORT 
       
    37 	#define EAP_C_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H EAP_C_FUNC_EXPORT 
       
    38 	#define EAP_FUNC_EXPORT_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H EAP_FUNC_EXPORT 
       
    39 	#define EAP_C_FUNC_EXPORT_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H EAP_C_FUNC_EXPORT 
       
    40 #else
       
    41 	#define EAP_CLASS_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H EAP_IMPORT 
       
    42 	#define EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H EAP_FUNC_IMPORT 
       
    43 	#define EAP_C_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H EAP_C_FUNC_IMPORT 
       
    44 	#define EAP_FUNC_EXPORT_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H 
       
    45 	#define EAP_C_FUNC_EXPORT_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H 
       
    46 #endif
       
    47 // End: added by script change_export_macros.sh.
    27 #include "abs_eap_base_type.h"
    48 #include "abs_eap_base_type.h"
    28 #include "eap_am_type_gsmsim.h"
    49 #include "eap_am_type_gsmsim.h"
    29 #include "EapPluginInterface.h"
    50 #include "EapPluginInterface.h"
    30 
    51 
    31 // 
    52 // 
    32 class EAP_EXPORT eap_am_type_gsmsim_simulator_c
    53 class EAP_CLASS_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H eap_am_type_gsmsim_simulator_c
    33 : public eap_am_type_gsmsim_c
    54 : public eap_am_type_gsmsim_c
    34 {
    55 {
    35 private:
    56 private:
    36 	//--------------------------------------------------
    57 	//--------------------------------------------------
    37 
    58 
    50 	//--------------------------------------------------
    71 	//--------------------------------------------------
    51 public:
    72 public:
    52 	//--------------------------------------------------
    73 	//--------------------------------------------------
    53 
    74 
    54 	// 
    75 	// 
    55 	EAP_FUNC_IMPORT virtual ~eap_am_type_gsmsim_simulator_c();
    76 	EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H virtual ~eap_am_type_gsmsim_simulator_c();
    56 
    77 
    57 	// 
    78 	// 
    58 	EAP_FUNC_IMPORT eap_am_type_gsmsim_simulator_c(
    79 	EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H eap_am_type_gsmsim_simulator_c(
    59 		abs_eap_am_tools_c * const m_am_tools,
    80 		abs_eap_am_tools_c * const m_am_tools,
    60 		abs_eap_base_type_c * const partner,
    81 		abs_eap_base_type_c * const partner,
    61 		const CEapPluginInterface::TIndexType aIndexType,
    82 		const CEapPluginInterface::TIndexType aIndexType,
    62 		const TInt aIndex);
    83 		const TInt aIndex);
    63 
    84 
    64 	EAP_FUNC_IMPORT eap_status_e configure();
    85 	EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H eap_status_e configure();
    65 
    86 
    66 	//
    87 	//
    67 	EAP_FUNC_IMPORT eap_status_e shutdown();
    88 	EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H eap_status_e shutdown();
    68 
    89 
    69 	// 
    90 	// 
    70 	EAP_FUNC_IMPORT eap_status_e query_SIM_imsi(
    91 	EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H eap_status_e query_SIM_imsi(
    71 		u8_t * const imsi, const u32_t max_length, u32_t * const imsi_length);
    92 		u8_t * const imsi, const u32_t max_length, u32_t * const imsi_length);
    72 
    93 
    73 	//
    94 	//
    74 	EAP_FUNC_IMPORT eap_status_e store_pseudonym_id(
    95 	EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H eap_status_e store_pseudonym_id(
    75 		const eap_am_network_id_c * const network_id,
    96 		const eap_am_network_id_c * const network_id,
    76 		const eap_variable_data_c * const pseudonym);
    97 		const eap_variable_data_c * const pseudonym);
    77 
    98 
    78 	//
    99 	//
    79 	EAP_FUNC_IMPORT eap_status_e store_reauthentication_id(
   100 	EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H eap_status_e store_reauthentication_id(
    80 		const eap_am_network_id_c * const network_id,
   101 		const eap_am_network_id_c * const network_id,
    81 		const eap_variable_data_c * const reauthentication_identity);
   102 		const eap_variable_data_c * const reauthentication_identity);
    82 
   103 
    83 	//
   104 	//
    84 	EAP_FUNC_IMPORT eap_status_e query_SIM_IMSI_or_pseudonym_or_reauthentication_id(
   105 	EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H eap_status_e query_SIM_IMSI_or_pseudonym_or_reauthentication_id(
    85 		const bool must_be_synchronous,
   106 		const bool must_be_synchronous,
    86 		eap_variable_data_c * const IMSI,
   107 		eap_variable_data_c * const IMSI,
    87 		eap_variable_data_c * const pseudonym_identity,
   108 		eap_variable_data_c * const pseudonym_identity,
    88 		eap_variable_data_c * const reauthentication_identity,
   109 		eap_variable_data_c * const reauthentication_identity,
    89 		eap_variable_data_c * const automatic_realm, ///< If this is not used, do not add any data to this parameter.
   110 		eap_variable_data_c * const automatic_realm, ///< If this is not used, do not add any data to this parameter.
    91 		const gsmsim_payload_AT_type_e required_identity,
   112 		const gsmsim_payload_AT_type_e required_identity,
    92 		const eap_type_gsmsim_complete_e required_completion,
   113 		const eap_type_gsmsim_complete_e required_completion,
    93 		const u8_t received_eap_identifier);
   114 		const u8_t received_eap_identifier);
    94 
   115 
    95 	//
   116 	//
    96 	EAP_FUNC_IMPORT eap_status_e cancel_SIM_IMSI_or_pseudonym_or_reauthentication_id_query();
   117 	EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H eap_status_e cancel_SIM_IMSI_or_pseudonym_or_reauthentication_id_query();
    97 
   118 
    98 	//
   119 	//
    99 	EAP_FUNC_IMPORT eap_status_e query_SIM_kc_and_sres(
   120 	EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H eap_status_e query_SIM_kc_and_sres(
   100 		const u8_t * const imsi, const u32_t imsi_length,
   121 		const u8_t * const imsi, const u32_t imsi_length,
   101 		const u8_t * const rand, const u32_t rand_length,
   122 		const u8_t * const rand, const u32_t rand_length,
   102 		u8_t * const kc, u32_t * const kc_length,
   123 		u8_t * const kc, u32_t * const kc_length,
   103 		u8_t * const sres, u32_t * const sres_length);
   124 		u8_t * const sres, u32_t * const sres_length);
   104 
   125 
   105 	//
   126 	//
   106 	EAP_FUNC_IMPORT eap_status_e handle_gsmsim_notification(eap_gsmsim_notification_codes_e gsmsim_notification_code);
   127 	EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H eap_status_e handle_gsmsim_notification(eap_gsmsim_notification_codes_e gsmsim_notification_code);
   107 
   128 
   108 
   129 
   109 #if defined(USE_EAP_TYPE_SERVER_GSMSIM)
   130 #if defined(USE_EAP_TYPE_SERVER_GSMSIM)
   110 	//
   131 	//
   111 	EAP_FUNC_IMPORT eap_status_e query_SIM_triplets(
   132 	EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H eap_status_e query_SIM_triplets(
   112 		const bool must_be_synchronous,
   133 		const bool must_be_synchronous,
   113 		const eap_variable_data_c * const username,
   134 		const eap_variable_data_c * const username,
   114 		eap_variable_data_c * const imsi,
   135 		eap_variable_data_c * const imsi,
   115 		eap_type_sim_triplet_array_c * const triplets,
   136 		eap_type_sim_triplet_array_c * const triplets,
   116 		eap_type_gsmsim_identity_type * const type);
   137 		eap_type_gsmsim_identity_type * const type);
   117 #endif //#if defined(USE_EAP_TYPE_SERVER_GSMSIM)
   138 #endif //#if defined(USE_EAP_TYPE_SERVER_GSMSIM)
   118 
   139 
   119 
   140 
   120 #if defined(USE_EAP_TYPE_SERVER_GSMSIM)
   141 #if defined(USE_EAP_TYPE_SERVER_GSMSIM)
   121 	//
   142 	//
   122 	EAP_FUNC_IMPORT eap_status_e cancel_SIM_triplets_query();
   143 	EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H eap_status_e cancel_SIM_triplets_query();
   123 #endif //#if defined(USE_EAP_TYPE_SERVER_GSMSIM)
   144 #endif //#if defined(USE_EAP_TYPE_SERVER_GSMSIM)
   124 
   145 
   125 	//
   146 	//
   126 	EAP_FUNC_IMPORT eap_status_e query_SIM_kc_sres(
   147 	EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H eap_status_e query_SIM_kc_sres(
   127 		const bool must_be_synchronous,
   148 		const bool must_be_synchronous,
   128 		//const eap_variable_data_c * const imsi,
   149 		//const eap_variable_data_c * const imsi,
   129 		const eap_variable_data_c * const n_rands,
   150 		const eap_variable_data_c * const n_rands,
   130 		eap_variable_data_c * const n_kc,
   151 		eap_variable_data_c * const n_kc,
   131 		eap_variable_data_c * const n_sres);
   152 		eap_variable_data_c * const n_sres);
   132 
   153 
   133 	//
   154 	//
   134 	EAP_FUNC_IMPORT eap_status_e cancel_SIM_kc_sres_query();
   155 	EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H eap_status_e cancel_SIM_kc_sres_query();
   135 
   156 
   136 	//
   157 	//
   137 	EAP_FUNC_IMPORT eap_status_e generate_encryption_IV(
   158 	EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H eap_status_e generate_encryption_IV(
   138 		eap_variable_data_c * const encryption_IV,
   159 		eap_variable_data_c * const encryption_IV,
   139 		const u32_t IV_length);
   160 		const u32_t IV_length);
   140 
   161 
   141 	//
   162 	//
   142 	EAP_FUNC_IMPORT eap_status_e generate_pseudonym_id(
   163 	EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H eap_status_e generate_pseudonym_id(
   143 		const eap_am_network_id_c * const network_id,
   164 		const eap_am_network_id_c * const network_id,
   144 		const eap_variable_data_c * const imsi,
   165 		const eap_variable_data_c * const imsi,
   145 		eap_variable_data_c * const pseudonym,
   166 		eap_variable_data_c * const pseudonym,
   146 		const u32_t maximum_pseudonym_length);
   167 		const u32_t maximum_pseudonym_length);
   147 
   168 
   148 	//
   169 	//
   149 	EAP_FUNC_IMPORT eap_status_e generate_reauthentication_id(
   170 	EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H eap_status_e generate_reauthentication_id(
   150 		const eap_am_network_id_c * const network_id,
   171 		const eap_am_network_id_c * const network_id,
   151 		const eap_variable_data_c * const imsi,
   172 		const eap_variable_data_c * const imsi,
   152 		eap_variable_data_c * const reauthentication_identity,
   173 		eap_variable_data_c * const reauthentication_identity,
   153 		const u32_t maximum_reauthentication_identity_length);
   174 		const u32_t maximum_reauthentication_identity_length);
   154 
   175 
   155 	//
   176 	//
   156 	EAP_FUNC_IMPORT eap_status_e store_reauth_parameters(
   177 	EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H eap_status_e store_reauth_parameters(
   157 		const eap_variable_data_c * const XKEY,
   178 		const eap_variable_data_c * const XKEY,
   158 		const eap_variable_data_c * const K_aut,
   179 		const eap_variable_data_c * const K_aut,
   159 		const eap_variable_data_c * const K_encr,
   180 		const eap_variable_data_c * const K_encr,
   160 		const u32_t reauth_counter);
   181 		const u32_t reauth_counter);
   161 
   182 
   162 	//
   183 	//
   163 	EAP_FUNC_IMPORT eap_status_e authentication_finished(
   184 	EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H eap_status_e authentication_finished(
   164 		const bool true_when_successfull,
   185 		const bool true_when_successfull,
   165 		const eap_gsmsim_authentication_type_e authentication_type,
   186 		const eap_gsmsim_authentication_type_e authentication_type,
   166 		const eap_type_gsmsim_identity_type identity_type);
   187 		const eap_type_gsmsim_identity_type identity_type);
   167 
   188 
   168 	//
   189 	//
   169 	EAP_FUNC_IMPORT eap_status_e query_reauth_parameters(
   190 	EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H eap_status_e query_reauth_parameters(
   170 		eap_variable_data_c * const XKEY,
   191 		eap_variable_data_c * const XKEY,
   171 		eap_variable_data_c * const K_aut,
   192 		eap_variable_data_c * const K_aut,
   172 		eap_variable_data_c * const K_encr,
   193 		eap_variable_data_c * const K_encr,
   173 		u32_t * const reauth_counter);
   194 		u32_t * const reauth_counter);
   174 
   195 
   175 	//
   196 	//
   176 	EAP_FUNC_IMPORT eap_status_e increase_reauth_counter();
   197 	EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H eap_status_e increase_reauth_counter();
   177 
   198 
   178 
   199 
   179 #if defined(USE_EAP_TYPE_SERVER_GSMSIM)
   200 #if defined(USE_EAP_TYPE_SERVER_GSMSIM)
   180 	//
   201 	//
   181 	EAP_FUNC_IMPORT eap_status_e query_imsi_from_username(
   202 	EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H eap_status_e query_imsi_from_username(
   182 		const bool must_be_synchronous,
   203 		const bool must_be_synchronous,
   183 		const u8_t next_eap_identifier,
   204 		const u8_t next_eap_identifier,
   184 		const eap_am_network_id_c * const network_id,
   205 		const eap_am_network_id_c * const network_id,
   185 		const eap_variable_data_c * const username,
   206 		const eap_variable_data_c * const username,
   186 		eap_variable_data_c * const imsi,
   207 		eap_variable_data_c * const imsi,
   188 		const eap_type_gsmsim_complete_e completion_action);
   209 		const eap_type_gsmsim_complete_e completion_action);
   189 #endif //#if defined(USE_EAP_TYPE_SERVER_GSMSIM)
   210 #endif //#if defined(USE_EAP_TYPE_SERVER_GSMSIM)
   190 
   211 
   191 
   212 
   192 	//
   213 	//
   193 	EAP_FUNC_IMPORT eap_status_e cancel_imsi_from_username_query();
   214 	EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H eap_status_e cancel_imsi_from_username_query();
   194 
   215 
   195 	//
   216 	//
   196 	EAP_FUNC_IMPORT eap_status_e check_is_rand_unused(const eap_variable_data_c * const n_rands);
   217 	EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H eap_status_e check_is_rand_unused(const eap_variable_data_c * const n_rands);
   197 
   218 
   198 	EAP_FUNC_IMPORT eap_status_e set_rand_is_used(const eap_variable_data_c * const n_rands);
   219 	EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H eap_status_e set_rand_is_used(const eap_variable_data_c * const n_rands);
   199 
   220 
   200 	EAP_FUNC_IMPORT void set_is_valid();
   221 	EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H void set_is_valid();
   201 
   222 
   202 	EAP_FUNC_IMPORT bool get_is_valid();
   223 	EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H bool get_is_valid();
   203 
   224 
   204 	//
   225 	//
   205 	EAP_FUNC_IMPORT eap_status_e type_configure_read(
   226 	EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H eap_status_e type_configure_read(
   206 		const eap_configuration_field_c * const field,
   227 		const eap_configuration_field_c * const field,
   207 		eap_variable_data_c * const data);
   228 		eap_variable_data_c * const data);
   208 
   229 
   209 	//
   230 	//
   210 	EAP_FUNC_IMPORT eap_status_e type_configure_write(
   231 	EAP_FUNC_VISIBILITY_EAP_AM_TYPE_GSMSIM_SYMBIAN_SIMULATOR_H eap_status_e type_configure_write(
   211 		const eap_configuration_field_c * const field,
   232 		const eap_configuration_field_c * const field,
   212 		eap_variable_data_c * const data);
   233 		eap_variable_data_c * const data);
   213 
   234 
   214 	//--------------------------------------------------
   235 	//--------------------------------------------------
   215 }; // class eap_am_type_gsmsim_simulator_c
   236 }; // class eap_am_type_gsmsim_simulator_c