tee_internal_se_api.h

/*
 *
 * Copyright (C) 2012-2019, Samsung Electronics Co., Ltd.
 *
 */

#ifndef __TEE_INTERNAL_SE_H__
#define __TEE_INTERNAL_SE_H__

#include <tee_internal_api.h>
#include <stdbool.h>

#ifdef  __cplusplus
extern "C" {
#endif

/************************************ Types **********************************/

/* Also, added "gpd.tee.se.version" */
#define TEE_SE_API_1_1                (0x01010000)

enum tee_secure_element_function_id {
    ID_TEE_SE_Service_Open = 0x0101,
    ID_TEE_SE_Service_Close = 0x0102,
    ID_TEE_SE_Service_Get_Readers = 0x0103,
    ID_TEE_SE_Reader_Get_Properties = 0x0201,
    ID_TEE_SE_Reader_Get_Name = 0x0202,
    ID_TEE_SE_Reader_Open_Session = 0x0203,
    ID_TEE_SE_Reader_Close_Sessions = 0x0204,
    ID_TEE_SE_Session_Get_ATR = 0x0301,
    ID_TEE_SE_Session_Is_Closed = 0x0302,
    ID_TEE_SE_Session_Close = 0x0303,
    ID_TEE_SE_Session_Close_Channels = 0x0304,
    ID_TEE_SE_Session_Open_Basic_Channel = 0x0305,
    ID_TEE_SE_Session_Open_Logical_Channel = 0x0306,
    ID_TEE_SE_Channel_Close = 0x0401,
    ID_TEE_SE_Channel_Select_Next = 0x0402,
    ID_TEE_SE_Channel_Get_Select_Response = 0x0403,
    ID_TEE_SE_Channel_Transmit = 0x0404,
    ID_TEE_SE_Channel_Get_Response_Length = 0x0405,
    ID_TEE_SE_Secure_Channel_Open = 0x0601,
    ID_TEE_SE_Secure_Channel_Get_Security_Level = 0x0602,
    ID_TEE_SE_Secure_Channel_Close = 0x0603
};
/* Handles */
typedef struct __TEE_SEServiceHandle *TEE_SEServiceHandle;
typedef struct __TEE_SEReaderHandle  *TEE_SEReaderHandle;
typedef struct __TEE_SESessionHandle *TEE_SESessionHandle;
typedef struct __TEE_SEChannelHandle *TEE_SEChannelHandle;

/*****************************************************************************/

/******************************* User TA Lib API *****************************/

/*****************************************************************************
*                                                                           *
*                                SEService Class                            *
*                                                                           *
*                The service level is the entry point to the API,           *
*                allowing one to gain access to the TEE SE API.             *
*                                                                           *
*****************************************************************************/

DSO_EXPORT TEE_Result TEE_SEServiceOpen(TEE_SEServiceHandle *seServiceHandle);

DSO_EXPORT void TEE_SEServiceClose(TEE_SEServiceHandle seServiceHandle);

DSO_EXPORT TEE_Result
TEE_SEServiceGetReaders(TEE_SEServiceHandle  seServiceHandle,
                        TEE_SEReaderHandle  *seReaderHandleList,
                        uint32_t            *seReaderHandleListLen);

/*****************************************************************************
*                                                                           *
*                                SEReader Class                             *
*                                                                           *
*                The reader level allows an application to choose a reader  *
*                once enumerated by the service level. Sessions are opened  *
*                on a Secure Element inserted in a reader.                  *
*                                                                           *
*****************************************************************************/

typedef struct __TEE_SEReaderProperties {
    bool sePresent;             
    bool teeOnly;               
    bool selectResponseEnable;  
} TEE_SEReaderProperties;

DSO_EXPORT void
TEE_SEReaderGetProperties(TEE_SEReaderHandle      seReaderHandle,
                          TEE_SEReaderProperties *readerProperties);

DSO_EXPORT TEE_Result TEE_SEReaderGetName(TEE_SEReaderHandle  seReaderHandle,
                                          char               *readerName,
                                          uint32_t           *readerNameLen);

DSO_EXPORT TEE_Result
TEE_SEReaderOpenSession(TEE_SEReaderHandle   seReaderHandle,
                        TEE_SESessionHandle *seSessionHandle);

DSO_EXPORT void
TEE_SEReaderCloseSessions(TEE_SEReaderHandle seReaderHandle);

/*****************************************************************************
*                                                                           *
*                                SESession Class                            *
*                                                                           *
*                The session level is used to retrieve the ATR and          *
*                to open channels to SE applications.                       *
*                                                                           *
*****************************************************************************/

typedef struct __TEE_SEAID {
    uint8_t *buffer;    
    uint32_t bufferLen; 
} TEE_SEAID;

DSO_EXPORT TEE_Result TEE_SESessionGetATR(TEE_SESessionHandle  seSessionHandle,
                                          void                *atr,
                                          uint32_t            *atrLen);

DSO_EXPORT TEE_Result
TEE_SESessionIsClosed(TEE_SESessionHandle seSessionHandle);

DSO_EXPORT void TEE_SESessionClose(TEE_SESessionHandle seSessionHandle);

DSO_EXPORT void
TEE_SESessionCloseChannels(TEE_SESessionHandle seSessionHandle);

DSO_EXPORT TEE_Result
TEE_SESessionOpenBasicChannel(TEE_SESessionHandle  seSessionHandle,
                              TEE_SEAID           *seAID,
                              TEE_SEChannelHandle *seChannelHandle);

DSO_EXPORT TEE_Result
TEE_SESessionOpenLogicalChannel(TEE_SESessionHandle  seSessionHandle,
                                TEE_SEAID           *seAID,
                                TEE_SEChannelHandle *seChannelHandle);

/*****************************************************************************
*                                                                           *
*                                SEChannel Class                            *
*                                                                           *
*                The channel level is used by applications to exchange      *
*                APDUs with the SE application.                             *
*                                                                           *
*****************************************************************************/

DSO_EXPORT void TEE_SEChannelClose(TEE_SEChannelHandle seChannelHandle);

DSO_EXPORT TEE_Result
TEE_SEChannelSelectNext(TEE_SEChannelHandle seChannelHandle);

DSO_EXPORT TEE_Result
TEE_SEChannelGetSelectResponse(TEE_SEChannelHandle seChannelHandle,
                               void *response, uint32_t *responseLen);

DSO_EXPORT TEE_Result
TEE_SEChannelTransmit(TEE_SEChannelHandle seChannelHandle,
                      void *command,
                      uint32_t  commandLen,
                      void *response,
                      uint32_t *responseLen);

DSO_EXPORT TEE_Result
TEE_SEChannelGetResponseLength(TEE_SEChannelHandle seChannelHandle,
                               uint32_t *responseLen);

/*****************************************************************************
*                                                                           *
*                           Secure Channel (SCP)                            *
*                                                                           *
*****************************************************************************/

typedef enum {
    TEE_SC_TYPE_SCP02  = 0x00, 
    TEE_SC_TYPE_SCP03  = 0x01, 
    TEE_SC_TYPE_SCP11a = 0x02, 
    TEE_SC_TYPE_SCP11b = 0x03, 
} TEES_SC_SecureChannelType;

typedef struct __TEE_SC_OID {
    uint8_t *buffer;    
    uint32_t bufferLen; 
} TEE_SC_OID;

/* Warning: in TEESE API doc enum from p.6.2.2.3 and p.6.2.4
 *           has not members C_ENC and R_ENC, but T.6-3 and T.6-5 has,
 *           so added additional constants */
typedef enum {
    TEE_SC_NO_SECURE_MESSAGING = 0x00,  
    TEE_AUTHENTICATE           = 0x80,  
    TEE_SC_C_MAC               = 0x01,  
    TEE_SC_C_ENC               = 0x02,  
    TEE_SC_R_MAC               = 0x10,  
    TEE_SC_R_ENC               = 0x20,  
    TEE_SC_CR_MAC              = 0x11,  
    TEE_SC_C_ENC_MAC           = 0x03,  
    TEE_SC_R_ENC_MAC           = 0x30,  
    TEE_SC_CR_ENC_MAC          = 0x33,  
} TEE_SC_SecurityLevel;

typedef struct __TEE_SC_CardKeyRef {
    uint8_t scKeyID;  
    uint8_t scKeyVersion; 
} TEE_SC_CardKeyRef;

typedef enum {
    TEE_SC_BASE_KEY = 0,    
    TEE_SC_KEY_SET  = 1,    
} TEE_SC_KeyType;

typedef struct __TEE_SC_KeySetRef {
    TEE_ObjectHandle scKeyEncHandle;    
    TEE_ObjectHandle scKeyMacHandle;    
} TEE_SC_KeySetRef;

typedef struct __TEE_SC_DeviceKeyRef {
    TEE_SC_KeyType scKeyType; 
    union {
        TEE_ObjectHandle scBaseKeyHandle;   
        TEE_SC_KeySetRef scKeySetRef;       
    }; 
} TEE_SC_DeviceKeyRef;


typedef struct __TEE_SC_Params {
    uint8_t                 scType;          
    TEE_SC_OID              scOID;           
    TEE_SC_SecurityLevel    scSecurityLevel; 
    TEE_SC_CardKeyRef       scCardKeyRef;    
    TEE_SC_DeviceKeyRef     scDeviceKeyRef;  
} TEE_SC_Params;

DSO_EXPORT TEE_Result
TEE_SESecureChannelOpen(TEE_SEChannelHandle  seChannelHandle,
                        TEE_SC_Params       *scParams);

DSO_EXPORT int
TEE_SESecureChannelGetSecurityLevel(TEE_SEChannelHandle seChannelHandle);

DSO_EXPORT void TEE_SESecureChannelClose(TEE_SEChannelHandle seChannelHandle);

/*****************************************************************************/

#ifdef  __cplusplus
}
#endif

#endif /* __TEE_INTERNAL_SE_H__ */