® GlobalPlatform Device Technology TEE Internal API Specification Version 1.0 Public Release December 2011 Document Reference: GPD_SPE_010 Copyright 2011 GlobalPlatform Inc. All Rights Reserved. Recipients of this document are invited to submit, with their comments, notification of any relevant patent rights or other intellectual property rights of which they may be aware which might be infringed by the implementation of the specification set forth in this document, and to provide supporting documentation. The technology provided or described herein is subject to updates, revisions, and extensions by GlobalPlatform. Use of this information is governed by the GlobalPlatform license agreement and any use inconsistent with that agreement is strictly prohibited. GlobalPlatform is a Trademark of GlobalPlatform, Inc. 2/202 TEE Internal API Specification – Public Release v1.0 This page intentionally left blank. Copyright 2011 GlobalPlatform Inc. All Rights Reserved. The technology provided or described herein is subject to updates, revisions, and extensions by GlobalPlatform. Use of this information is governed by the GlobalPlatform license agreement and any use inconsistent with that agreement is strictly prohibited. TEE Internal API Specification – Public Release v1.0 3/202 Contents 1 Introduction .......................................................................................................................... 10 1.1 Audience ............................................................................................................................................. 10 1.2 IPR Disclaimer..................................................................................................................................... 10 1.3 Normative References ........................................................................................................................ 11 1.4 Terminology and Definitions ................................................................................................................ 11 1.5 Abbreviations and Notations ............................................................................................................... 14 1.6 Revision History .................................................................................................................................. 15 2 Overview of the TEE Internal API ........................................................................................ 16 2.1 Trusted Applications ............................................................................................................................ 16 2.1.1 TA Interface .................................................................................................................................. 17 2.1.2 Instances, Sessions, Tasks, and Commands .............................................................................. 18 2.1.3 Sequential Execution of Entry Points ........................................................................................... 18 2.1.4 Cancellations ................................................................................................................................ 18 2.1.5 Unexpected Client Termination .................................................................................................... 19 2.1.6 Instance Types ............................................................................................................................. 19 2.1.7 Configuration, Development, and Management .......................................................................... 19 2.2 Error Handling ..................................................................................................................................... 20 2.2.1 Normal Errors ............................................................................................................................... 20 2.2.2 Programmer Errors ...................................................................................................................... 20 2.2.3 Panics ........................................................................................................................................... 20 2.3 Opaque Handles ................................................................................................................................. 21 2.4 Properties ............................................................................................................................................ 22 2.5 Trusted Storage API for Data and Keys .............................................................................................. 23 2.6 Cryptographic Operations API ............................................................................................................ 23 2.7 Time API .............................................................................................................................................. 24 2.8 Arithmetical API ................................................................................................................................... 24 3 Common Definitions ............................................................................................................ 25 3.1 Header File .......................................................................................................................................... 25 3.2 Data Types .......................................................................................................................................... 25 3.2.1 Basic Types .................................................................................................................................. 25 3.2.2 TEE_Result, TEEC_Result .......................................................................................................... 25 3.2.3 TEE_UUID, TEEC_UUID ............................................................................................................. 26 3.3 Constants ............................................................................................................................................ 27 3.3.1 Error Codes .................................................................................................................................. 27 3.4 Parameter Annotations ....................................................................................................................... 28 3.4.1 [in], [out], and [inout] ..................................................................................................................... 28 3.4.2 [outopt] ......................................................................................................................................... 28 3.4.3 [inbuf] ............................................................................................................................................ 28 3.4.4 [outbuf] ......................................................................................................................................... 29 3.4.5 [outbufopt] .................................................................................................................................... 29 3.4.6 [instring] and [instringopt] ............................................................................................................. 30 3.4.7 [outstring] and [outstringopt] ......................................................................................................... 30 3.4.8 [ctx] ............................................................................................................................................... 30 4 Trusted Core Framework API .............................................................................................. 31 4.1 Data Types .......................................................................................................................................... 32 4.1.1 TEE_Identity ................................................................................................................................. 32 4.1.2 TEE_Param .................................................................................................................................. 32 4.1.3 TEE_TASessionHandle ............................................................................................................... 32 Copyright 2011 GlobalPlatform Inc. All Rights Reserved. The technology provided or described herein is subject to updates, revisions, and extensions by GlobalPlatform. Use of this information is governed by the GlobalPlatform license agreement and any use inconsistent with that agreement is strictly prohibited. 4/202 TEE Internal API Specification – Public Release v1.0 4.1.4 TEE_PropSetHandle .................................................................................................................... 32 4.2 Constants ............................................................................................................................................ 33 4.2.1 Parameter Types .......................................................................................................................... 33 4.2.2 Login Types .................................................................................................................................. 33 4.2.3 Origin Codes ................................................................................................................................ 33 4.2.4 Property Set Pseudo-Handles.....................................................................................................