1 /*

     2 * ============================================================================

     3 *  Name        : ./accesssec/eapol/eapol_framework/wapi_common/include/abs_ec_am_certificate_store.h

     4 *  Part of     : WAPI / WAPI       *** Info from the SWAD

     5 *  Description : WAPI authentication

     6 *  Version     : %version: 11 % << Don't touch! Updated by Synergy at check-out.

     7 *

     8 *  Copyright © 2001-2009 Nokia.  All rights reserved.

     9 *  This material, including documentation and any related computer

    10 *  programs, is protected by copyright controlled by Nokia.  All

    11 *  rights are reserved.  Copying, including reproducing, storing,

    12 *  adapting or translating, any or all of this material requires the

    13 *  prior written consent of Nokia.  This material also contains

    14 *  confidential information which may not be disclosed to others

    15 *  without the prior written consent of Nokia.

    16 * ============================================================================

    17 * Template version: 4.2

    18 */

    19 

    20 

    21 

    22 #if !defined(_ABS_EC_AM_CERTIFICATE_STORE_H_)

    23 #define _ABS_EC_AM_CERTIFICATE_STORE_H_

    24 

    25 #if defined(USE_EC_CERTIFICATE_STORE)

    26 

    27 #include "eap_am_export.h"

    28 #include "eap_array.h"

    29 #include "wapi_types.h"

    30 #include "ec_cs_types.h"

    31 #include "ec_cs_data.h"

    32 

    33 /// This class declares the functions adaptation module of elliptic curve sertificate store

    34 /// requires from the elliptic curve sertificate store.

    35 class EAP_EXPORT abs_ec_am_certificate_store_c

    36 {

    37 private:

    38 	//--------------------------------------------------

    39 

    40 	//--------------------------------------------------

    41 protected:

    42 	//--------------------------------------------------

    43 

    44 	//--------------------------------------------------

    45 public:

    46 	//--------------------------------------------------

    47 

    48 	/// Destructor does nothing.

    49 	virtual ~abs_ec_am_certificate_store_c()

    50 	{

    51 	}

    52 

    53 	/// Constructor does nothing.

    54 	abs_ec_am_certificate_store_c()

    55 	{

    56 	}

    57 

    58 	/**

    59 	 * This function call completes initialize_certificate_store() function call.

    60 	 * After all imported certificate files are handled, AM must call this function.

    61 	 * WAPI authentication will continue within this function call.

    62 	 */

    63 	virtual eap_status_e complete_initialize_certificate_store(

    64 		const wapi_completion_operation_e completion_operation) = 0;

    65 

    66 	/**

    67 	 * This function call removes cached certificate store data.

    68 	 */

    69 	virtual eap_status_e remove_cached_certificate_store_data() = 0;

    70 

    71 	/**

    72 	 * This function call adds certificate to certificate store.

    73 	 * this function call is completed with complete_add_imported_certificate_file() function.

    74 	 */

    75 	virtual eap_status_e add_imported_certificate_file(

    76 		const eap_variable_data_c * const in_imported_certificate_file_data,

    77 		const eap_variable_data_c * const in_imported_certificate_filename) = 0;

    78 

    79 	/**

    80 	 * This function call completes read_certificate_store_data() function call.

    81 	 */

    82 	virtual eap_status_e complete_read_certificate_store_data(

    83 		const eap_status_e in_completion_status,

    84 		const ec_cs_pending_operation_e in_pending_operation,

    85 		EAP_TEMPLATE_CONST eap_array_c<ec_cs_data_c> * const in_references_and_data_blocks) = 0;

    86 	

    87 	/**

    88 	 * This function call completes write_certificate_store_data() function call.

    89 	 */

    90 	virtual eap_status_e complete_write_certificate_store_data(

    91 		const eap_status_e in_completion_status,

    92 		const ec_cs_pending_operation_e in_pending_operation) = 0;

    93 

    94 	/**

    95 	 * This function call queries list of certificates.

    96 	 */

    97 	virtual eap_status_e query_certificate_list() = 0;

    98 

    99 	/**

   100 	 * This function call starts import of certificate files.

   101 	 */

   102 	virtual eap_status_e start_certificate_import() = 0;

   103 

   104 	//--------------------------------------------------

   105 }; // class abs_ec_am_certificate_store_c

   106 

   107 #endif //#if defined(USE_EC_CERTIFICATE_STORE)

   108 

   109 #endif //#if !defined(_ABS_EC_AM_CERTIFICATE_STORE_H_)

   110 

   111 //--------------------------------------------------

   112 

   113 

   114 

   115 // End.