gba/inc/gbauicc.h
changeset 0 164170e6151a
equal deleted inserted replaced
-1:000000000000 0:164170e6151a
       
     1 /*
       
     2 * Copyright (c) 2007 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 "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:  Functionality for accessing uicc
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef _GBAUICC_H_
       
    20 #define _GBAUICC_H_
       
    21 
       
    22 #include <e32base.h>
       
    23 
       
    24 _LIT8(KAKAV1, "USIM");
       
    25 _LIT8(KSIMV1, "SIM");
       
    26 _LIT8(KISIMV1, "ISIM");
       
    27 _LIT8(KUICC_DEFAULT, "");
       
    28 
       
    29 #define GBAUICC_INTERFACE  0x2000F86B
       
    30 
       
    31 const TUid KGBAUICCInterfaceUID = { GBAUICC_INTERFACE };
       
    32 
       
    33 /**
       
    34 * An abstract interface for accessing applications on UICC. Use this interface to query identity and authentication parameters from UICC.
       
    35 */
       
    36 class MUICCInterface
       
    37     {
       
    38     public:
       
    39 
       
    40         /**
       
    41          * Fetches identity stored on the UICC
       
    42          * param stores
       
    43          * exception if UICC is not accessible call will leave
       
    44          * result is returned 3GPP TS 23.003: "3rd Generation Partnership Project; Technical Specification Group Core Network; Numbering, addressing and identification".
       
    45          */
       
    46         virtual void QueryIdentityL(TDes8& aIdentity) = 0;
       
    47    
       
    48         /**
       
    49          * Fetches Home network domain name
       
    50          * exception if UICC is not accessible call will leave
       
    51          * result is returned 
       
    52          * see 3GPP TS 23.003: "3rd Generation Partnership Project; Technical Specification Group Core Network; Numbering, addressing and identification".
       
    53          */
       
    54         virtual void QueryHomeNetworkDnL(TDes8& aHNDN) = 0;
       
    55 
       
    56         /**
       
    57          * Queries authentication vector from UICC application
       
    58          * param challenge in
       
    59          * param calculated response
       
    60          * return true on success false on failure
       
    61          * exception if UICC is not accessible call will leave
       
    62          */
       
    63         virtual TBool QueryAuthenticationL(const TDesC8& aNonce, TDes8& aResponse, TDes8& aResync ) = 0; 
       
    64   
       
    65         /**
       
    66          * Fetches key material from UICC
       
    67          * param resulting key material
       
    68          */
       
    69         virtual void QueryKeyMaterialL  (   const TDesC8& aKeyMaterial,
       
    70                                             const TDesC8& aRand,
       
    71                                             const TDesC8& aIMPI,
       
    72                                             const TDesC8& aUTF8_NAF_ID,
       
    73                                             TDes8& aDerivedKey )  = 0; 
       
    74   
       
    75        /**
       
    76         * Fetches the master keys in what ever format they exist
       
    77         */
       
    78        virtual TBool QueryKs(TDes8& aKS) =0;
       
    79 
       
    80 
       
    81        /**
       
    82         * Check if the 2G interface
       
    83         * Return ETrue when only 2G interface available 
       
    84         */
       
    85        virtual TBool InterfaceIs2G() = 0;
       
    86 
       
    87 
       
    88         /**
       
    89          * The API used to update B-TID and key lifetime
       
    90          */
       
    91         virtual TInt UpdateGBADataL( const TDesC8& aBTID, const TDesC8& aLifetime ) = 0;
       
    92 
       
    93         /**
       
    94          * API to get the GBA_U availability
       
    95          * Set aGBAAvail to ETrue if smart card is GBA_U card
       
    96          */
       
    97         virtual void QueryGBAUAvailabilityL( TBool& aGBAAvail ) = 0;
       
    98     
       
    99         /**
       
   100          * delete the objects
       
   101          */
       
   102         virtual void Release() = 0;
       
   103         
       
   104         /*
       
   105          * Notify the smart card is changed
       
   106          */
       
   107          virtual void NotifyCardChangeL() = 0; 
       
   108     }; 
       
   109 
       
   110 #endif // _GBAUICC_H_
       
   111 //EOF
       
   112 
       
   113