ETSI TS 102 240 V17.0.0 (2021-11)

Smart Cards; UICC Application Programming Interface and Loader Requirements; Service description (Release 17)

RTS/SET-R0263vh00

General Information

• Status: Not Published
• Technical Committee: SET REQ - SET-REQ
• Current Stage: 12 - Completion
• Due Date: 29-Oct-2021
• Completion Date: 15-Nov-2021
• Mandate: M/441

Standards Content (Sample)

ETSI TS 102 240 V17.0.0 (2021-11)






TECHNICAL SPECIFICATION
Smart Cards;
UICC Application Programming Interface and
Loader Requirements;
Service description
(Release 17)

---------------------- Page: 1 ----------------------
Release 17 2 ETSI TS 102 240 V17.0.0 (2021-11)

Reference
RTS/SCP-R0263vh00
Keywords
API, smart card
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE

Tel.: [phone]  Fax: [phone]

Siret N° 348 623 562 00017 - APE 7112B
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° w061004871

Important notice
The present document can be downloaded from:
http://www.etsi.org/standards-search
The present document may be made available in electronic versions and/or in print. The content of any electronic and/or
print versions of the present document shall not be modified without the prior written authorization of ETSI. In case of any
existing or perceived difference in contents between such versions and/or in print, the prevailing version of an ETSI
deliverable is the one made publicly available in PDF format at www.etsi.org/deliver.
Users of the present document should be aware that the document may be subject to revision or change of status.
Information on the current status of this and other ETSI documents is available at
https://portal.etsi.org/TB/ETSIDeliverableStatus.aspx
If you find errors in the present document, please send your comment to one of the following services:
https://portal.etsi.org/People/CommiteeSupportStaff.aspx
Notice of disclaimer & limitation of liability
The information provided in the present deliverable is directed solely to professionals who have the appropriate degree of
experience to understand and interpret its content in accordance with generally accepted engineering or
other professional standard and applicable regulations.
No recommendation as to products and services or vendors is made or should be implied.
No representation or warranty is made that this deliverable is technically accurate or sufficient or conforms to any law
and/or governmental rule and/or regulation and further, no representation or warranty is made of merchantability or fitness
for any particular purpose or against infringement of intellectual property rights.
In no event shall ETSI be held liable for loss of profits or any other incidental or consequential damages.

Any software contained in this deliverable is provided "AS IS" with no warranties, express or implied, including but not
limited to, the warranties of merchantability, fitness for a particular purpose and non-infringement of intellectual property
rights and ETSI shall not be held liable in any event for any damages whatsoever (including, without limitation, damages
for loss of profits, business interruption, loss of information, or any other pecuniary loss) arising out of or related to the use
of or inability to use the software.
Copyright Notification
No part may be reproduced or utilized in any form or by any means, electronic or mechanical, including photocopying and
microfilm except as authorized by written permission of ETSI.
The content of the PDF version shall not be modified without the written authorization of ETSI.
The copyright and the foregoing restriction extend to reproduction in all media.

© ETSI 2021.
All rights reserved.

ETSI

---------------------- Page: 2 ----------------------
Release 17 3 ETSI TS 102 240 V17.0.0 (2021-11)
Contents
Intellectual Property Rights . 5
Foreword . 5
Modal verbs terminology . 6
1 Scope . 7
2 References . 7
2.1 Normative references . 7
2.2 Informative references . 8
3 Definition of terms, symbols and abbreviations . 8
3.1 Terms . 8
3.2 Symbols . 9
3.3 Abbreviations . 9
4 Description . 10
4.0 System overview . 10
4.1 Design of UICC based applications using the UICC API . 11
4.2 UICC API architecture . 12
4.3 UICC file data access . 13
4.4 UICC BER-TLV file access . 13
5 Card interoperability. 13
5.1 Loader requirements . 13
5.2 Application transport . 14
6 Applet activation . 14
6.1 Applet triggering . 14
6.2 Applet selection . 15
7 Applet life cycle management . 15
7.0 Overview . 15
7.1 Applet preparation . 15
7.2 Loading . 16
7.2.0 Overview . 16
7.2.1 Arbitration. 16
7.2.2 Transport . 16
7.2.3 Verification . 16
7.2.4 Linking . 16
7.3 Installation/registration/reactivation . 16
7.4 Configuration . 17
7.5 Execution . 17
7.6 Deactivation . 17
7.7 Removal . 17
8 Security management . 17
8.1 Management of applets . 17
8.2 Applet certification . 17
9 API compatibility . 17
9.1 Level of compatibility . 17
9.2 Compatibility at the interface . 17
9.3 Compatibility at the programming interface . 18
9.4 Accessibility of the programming interface . 18
10 API extensibility . 18
10.0 General requirements . 18
10.1 Evolution of UICC/terminal interface (ETSI TS 102 221) . 18
10.2 Evolution of CAT application toolkit (ETSI TS 102 223) . 18
10.3 Interworking with other systems . 18
10.4 Evolution of UICC/terminal contactless interface (ETSI TS 102 622 and ETSI TS 102 613) . 18
ETSI

---------------------- Page: 3 ----------------------
Release 17 4 ETSI TS 102 240 V17.0.0 (2021-11)
10.5 HCI low-level support . 19
10.5.1 Use case . 19
10.5.2 Requirements . 19
10.6 Application API for Secure messaging over HTTPS . 20
10.6.1 Use Cases (informative) . 20
10.6.2 Requirements (normative) . 20
10.7 Machine to Machine (M2M) UICC applications. 20
10.8 Secure Channel between UICC and terminal . 21
11 Data and function sharing and access control . 21
11.1 Sharing resources between applets . 21
11.2 Access to data . 21
12 Technology considerations . 22
12.1 UICC hardware requirements . 22
12.2 Technology limitations . 22
12.2.1 Memory recovery . 22
12.3 Evolution . 22
12.3.1 Remote Procedure Call (RPC) . 22
13 Enhanced Runtime Environment . 22
13.0 Overview . 22
13.1 Interworking between multiple hardware and logical UICC/terminal interfaces . 22
13.2 Support for TCP and UDP . 22
13.3 Support for HTTP . 23
13.4 Support for Card Application Toolkit (CAT) . 23
13.5 Secure communication . 23
13.6 Events . 23
13.7 Access to the enhanced UICC API framework . 23
13.8 Inter-application communication . 23
13.9 Backward compatibility . 24
14 Support of Multiple Secure Elements and Multiplexed Logical Interfaces . 24
Annex A (informative): Change history . 25
History . 26

ETSI

---------------------- Page: 4 ----------------------
Release 17 5 ETSI TS 102 240 V17.0.0 (2021-11)
Intellectual Property Rights
Essential patents
IPRs essential or potentially essential to normative deliverables may have been declared to ETSI. The declarations
pertaining to these essential IPRs, if any, are publicly available for ETSI members and non-members, and can be
found in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to
ETSI in respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the
ETSI Web server (https://ipr.etsi.org/).
Pursuant to the ETSI Directives including the ETSI IPR Policy, no investigation regarding the essentiality of IPRs,
including IPR searches, has been carried out by ETSI. No guarantee can be given as to the existence of other IPRs not
referenced in ETSI SR 000 314 (or the updates on the ETSI Web server) which are, or may be, or may become,
essential to the present document.
Trademarks
The present document may include trademarks and/or tradenames which are asserted and/or registered by their owners.
ETSI claims no ownership of these except for any which are indicated as being the property of ETSI, and conveys no
right to use or reproduce any trademark and/or tradename. Mention of those trademarks in the present document does
not constitute an endorsement by ETSI of products, services or organizations associated with those trademarks.
DECT™, PLUGTESTS™, UMTS™ and the ETSI logo are trademarks of ETSI registered for the benefit of its

Members. 3GPP™ and LTE™ are trademarks of ETSI registered for the benefit of its Members and of the 3GPP
Organizational Partners. oneM2M™ logo is a trademark of ETSI registered for the benefit of its Members and of the
®
oneM2M Partners. GSM and the GSM logo are trademarks registered and owned by the GSM Association.
Foreword
This Technical Specification (TS) has been produced by ETSI Technical Committee Smart Card Platform (SCP).
It is based on work originally done by the 3GPP group in "TSG-Terminals WG3" and by "ETSI Special Mobile Group
(SMG)".
The present document details the stage 1 aspects (overall service description) for the support of a UICC Application
Programming Interface (API).
The contents of the present document are subject to continuing work within TC SCP and may change following formal
TC SCP approval. If TC SCP modifies the contents of the present document, it will then be republished by ETSI with
an identifying change of release date and an increase in version number as follows:
Version x.y.z
where:
x the first digit:
0 early working draft;
1 presented to TC SCP for information;
2 presented to TC SCP for approval;
3 or greater indicates TC SCP approved document under change control.
y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections,
updates, etc.
z the third digit is incremented when editorial only changes have been incorporated in the document.
ETSI

---------------------- Page: 5 ----------------------
Release 17 6 ETSI TS 102 240 V17.0.0 (2021-11)
Modal verbs terminology
In the present document "shall", "shall not", "should", "should not", "may", "need not", "will", "will not", "can" and
"cannot" are to be interpreted as described in clause 3.2 of the ETSI Drafting Rules (Verbal forms for the expression of
provisions).
"must" and "must not" are NOT allowed in ETSI deliverables except when used in direct citation.
ETSI

---------------------- Page: 6 ----------------------
Release 17 7 ETSI TS 102 240 V17.0.0 (2021-11)
1 Scope
The present document defines the service description of the UICC Application Programming Interface (UICC API)
internal to the UICC. Stage one is an overall service description, and does not deal with the implementation details of
the API.
The present document includes information applicable to network operators, service providers and terminal, UICC,
Network Access Application (NAA) providers, switch and database manufacturers.
The present document contains the core requirements, which are sufficient to provide a complete service.
It is highly desirable however, that technical solutions for a UICC API should be sufficiently flexible to allow for
possible enhancements. Additional functionalities not documented in the present document may implement
requirements which are considered outside the scope of the present document. This additional functionality may be on a
network wide basis, nation-wide basis or particular to a group of users. It is expected that such additional functionality
does not compromise conformance to the core requirements of the service.
2 References
2.1 Normative references
References are either specific (identified by date of publication and/or edition number or version number) or
non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the
referenced document (including any amendments) applies.
• In the case of a reference to a TC SCP document, a non specific reference implicitly refers to the latest version
of that document in the same Release as the present document.
Referenced documents which are not found to be publicly available in the expected location might be found at
https://docbox.etsi.org/Reference/.
NOTE: While any hyperlinks included in this clause were valid at the time of publication, ETSI cannot guarantee
their long term validity.
The following referenced documents are necessary for the application of the present document.
[1] ETSI TS 102 221: "Smart cards; UICC-Terminal interface; Physical and logical characteristics
(Release 7)".
[2] ETSI TS 102 223: "Smart cards; Card Application Toolkit (CAT) (Release 7)".
[3] ISO/IEC 7816-4: "Identification cards - Integrated circuit cards - Part 4: Organization, security and
commands for interchange".
[4] ETSI TS 102 622: "Smart Cards; UICC - Contactless Front-end (CLF) Interface; Host Controller
Interface (HCI)".
[5] ETSI TS 102 613: "Smart Cards; UICC - Contactless Front-end (CLF) Interface; Physical and data
link layer characteristics".
[6] ETSI TS 102 600: "Smart Cards; UICC-Terminal interface; Characteristics of the USB interface".
[7] ETSI TS 102 483: "Smart cards; UICC-Terminal interface; Internet Protocol connectivity between
UICC and terminal".
[8] ETSI TS 102 484: "Smart Cards; Secure channel between a UICC and an end-point terminal".
[9] OMA: "Smartcard Web Server Enabler Architecture", OMA-AD-Smartcard-Web-Server-V1-0-
20070209-C.
[10] ETSI TS 102 412: "Smart Cards; Smart Card Platform Requirements Stage 1".
ETSI

---------------------- Page: 7 ----------------------
Release 17 8 ETSI TS 102 240 V17.0.0 (2021-11)
[11] ETSI TS 102 127: "Smart Cards; Transport protocol for CAT applications; Stage 2".
[12] ETSI TS 102 225: "Smart Cards; Secured packet structure for UICC based applications".
[13] ETSI TS 102 226: "Smart Cards; Remote APDU structure for UICC based applications".
[14] ETSI TS 131 130: "Digital cellular telecommunications system (Phase 2+); Universal Mobile
Telecommunications System (UMTS); LTE; (U)SIM Application Programming Interface (API);
(U)SIM API for Java Card (3GPP TS 31.130 Release 9)".
[15] ETSI TS 102 267: "Smart Cards; Connection Oriented Service API for the Java Card (™)
platform".
[16] ETSI TS 102 241: "Smart Cards; UICC Application Programming Interface (UICC API) for Java
Card (™)".
2.2 Informative references
References are either specific (identified by date of publication and/or edition number or version number) or
non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the
referenced document (including any amendments) applies.
• In the case of a reference to a TC SCP document, a non specific reference implicitly refers to the latest version
of that document in the same Release as the present document.
NOTE: While any hyperlinks included in this clause were valid at the time of publication, ETSI cannot guarantee
their long term validity.
The following referenced documents are not necessary for the application of the present document but they assist the
user with regard to a particular subject area.
Not applicable.
3 Definition of terms, symbols and abbreviations
3.1 Terms
For the purposes of the present document, the following terms apply:
applet: application built up using a number of modules which will run under the control of a virtual machine
application: in the scope of the present document either an applet or a web-application
bytecode: machine independent code generated by a bytecode compiler and executed by a bytecode interpreter
data structure: collection of related data values such as the age, birth date and height of an individual
framework: set of Application Programming Interface (API) functions and data structures for developing applications
and for providing system services to those applications
function: callable and executable body of computer instructions which perform a specific computation or data
processing task
logical Secure Element (SE): SE functionalities, applications and files grouped together to act like a SE (e.g. UICC)
when multiple logical SE interfaces are supported
logical SE interface: logical connection between an endpoint in the terminal and one logical SE
module: collection of functions and data structures which implement an entire application or a particular application
feature or capability
ETSI

---------------------- Page: 8 ----------------------
Release 17 9 ETSI TS 102 240 V17.0.0 (2021-11)
Secure Element (SE): tamper-resistant dedicated platform, consisting of hardware and software, capable of securely
hosting applications and their confidential and cryptographic data and providing a secure application execution
environment, e.g. the UICC
servlet: application built up using a number of modules responding to incoming Internet protocol request (e.g. TCP,
HTTP, HTTPS, etc.)
NOTE: A Servlet runs under the control of a Servlet engine.
servlet engine: part of the enhanced UICC API framework, responsible for handling incoming requests via the TCP/IP
protocol (e.g. HTTP/HTTPS) and dispatching them to the web-application
toolkit applet: applet loaded onto the UICC seen by the mobile as being part of the UICC toolkit application and
containing only the code necessary to run the application
NOTE: These applets might be downloaded over the radio interface.
trusted party: entity trusted by the card issuer with respect to security related services and activities
Universal Integrated Circuit Card Application Programming Interface (UICC API) framework: part of the UICC
responsible for the handling of applications (including triggering and loading)
NOTE: It also contains the library for the proactive API.
virtual machine: part of the run-time environment responsible for interpreting the bytecode
web-application: at least one Servlet or a combination of one or more Servlets, additional modules, applets, and static
content
3.2 Symbols
Void.
3.3 Abbreviations
For the purposes of the present document, the following abbreviations apply:
AID Applet IDentifier
APDU Application Protocol Data Unit
API Application Programming Interface
AVN Applet Version Number
BER Bit Error Rate
CAD Card Acceptance Device
CAT Card Application Toolkit
CLF ContactLess Front-end
EPOS Electronic Point Of Sale
HCI Host Controller Interface
HTTP Hypertext Transfer Protocol
IFD InterFace Device
IP Internet Protocol
LSE Logical SE
LSI Logical SE Interface
MExE Mobile Execution Environment
NAA Network Access Application
OTA Over The Air
P2P Peer to Peer
PSK Pre shared Secret Key
RF Radio Frequency technology
RPC Remote Procedure Call
SE Secure Element
SSL Secure Socket Layer
TAG nominal datum that encodes the name of a data object
ETSI

---------------------- Page: 9 ----------------------
Release 17 10 ETSI TS 102 240 V17.0.0 (2021-11)
TCP Transmission Control Protocol
TLS Transport Layer Security
TLV Tag, Length, Value
UDP User Datagram Protocol
UICC Universal Integrated Circuit Card
WAP Wireless Application Protocol
4 Description
4.0 System overview
The present document describes the high level requirements for an API for the UICC. This API shall allow application
programmers easy access to the functions and data described in ETSI TS 102 221 [1] and ETSI TS 102 223 [2], such
that UICC based services can be developed and loaded onto UICCs, quickly and, if necessary, remotely, after the UICC
has been issued. Figure 1 shows a high level system architecture.

Application
↔
AIDx. TARx
AID
Card
Application Card
Operator
AID1,TAR1
Applet1
TAR2
Applet2
…
…
Trusted
Application
AID
Trusted
AIDn,TARn
Appletn
UICC
Communication
Terminal ↔
AIDx TARx
…
Management

Figure 1: Toolkit applet management and communication
ETSI

---------------------- Page: 10 ----------------------
Release 17 11 ETSI TS 102 240
...