ETSI TS 131 130 V15.2.2 (2020-04)

ETSI TS 131 130 V15.2.2 (2020-04)
TECHNICAL SPECIFICATION
Digital cellular telecommunications system (Phase 2+) (GSM);
Universal Mobile Telecommunications System (UMTS);
LTE;
5G;
(U)SIM Application Programming Interface (API);
(U)SIM API for Java™ Card
(3GPP TS 31.130 version 15.2.2 Release 15)
---------------------- Page: 1 ----------------------
3GPP TS 31.130 version 15.2.2 Release 15 1 ETSI TS 131 130 V15.2.2 (2020-04)
Reference
RTS/TSGC-0631130vf22
Keywords
5G,GSM,LTE,UMTS
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
Siret N° 348 623 562 00017 - NAF 742 C
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88
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

If you find errors in the present document, please send your comment to one of the following services:

No part may be reproduced or utilized in any form or by any means, electronic or mechanical, including photocopying

The content of the PDF version shall not be modified without the written authorization of ETSI.

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

oneM2M™ logo is a trademark of ETSI registered for the benefit of its Members and

IPRs essential or potentially essential to normative deliverables may have been declared to ETSI. The information

pertaining to these essential IPRs, if any, is 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

Pursuant to the ETSI IPR Policy, no investigation, 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

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.

This Technical Specification (TS) has been produced by ETSI 3rd Generation Partnership Project (3GPP).

The present document may refer to technical specifications or reports using their 3GPP identities. These shall be

The cross reference between 3GPP and ETSI identities can be found under http://webapp.etsi.org/key/queryform.asp.

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

"must" and "must not" are NOT allowed in ETSI deliverables except when used in direct citation.

Intellectual Property Rights ........................................................................................................................ 2

Legal Notice ............................................................................................................................................... 2

Modal verbs terminology ............................................................................................................................ 2

Foreword ..................................................................................................................................................... 4

1 Scope ................................................................................................................................................ 6

2 References ........................................................................................................................................ 6

3 Definitions and abbreviations ........................................................................................................... 7

3.1 Definitions ................................................................................................................................................. 7

3.2 Abbreviations ............................................................................................................................................ 7

4 Description ....................................................................................................................................... 7

4.0 Overview ................................................................................................................................................... 7

4.1 (U)SIM Java Card™ Architecture ............................................................................................................. 8

5 File Access API ................................................................................................................................ 8

6 (U)SAT Framework ......................................................................................................................... 8

6.0 Overview ................................................................................................................................................... 8

6.1 Applet triggering ....................................................................................................................................... 9

6.1.1 Exception Handling ............................................................................................................................. 9

6.2 Definition of Events .................................................................................................................................. 9

6.3 Registration ............................................................................................................................................. 13

6.4 Proactive command handling .................................................................................................................. 13

6.5 Envelope response handling .................................................................................................................... 14

6.6 System Handler management .................................................................................................................. 14

6.7 (U)SAT Framework behaviour ................................................................................................................ 15

7 UICC toolkit applet ........................................................................................................................ 15

8 Geo Location API ........................................................................................................................... 15

9 SUCI API ....................................................................................................................................... 15

Annex A (normative): Java Card™ (U)SIM API ...................................................................... 16

Annex B (normative): Java Card™ (U)SIM API identifiers ................................................... 17

Annex C (normative): (U)SIM API package version management ......................................... 18

Annex D (normative): USIM API jar files ................................................................................. 20

Annex E (informative): Change History ...................................................................................... 21

History ...................................................................................................................................................... 24

This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP).

The contents of the present document are subject to continuing work within the TSG and may change following formal

TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an

y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections,

z the third digit is incremented when editorial only changes have been incorporated in the document.

The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in

The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided

insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced,

non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a

The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions

"might not" or "shall not" are used instead, depending upon the meaning intended.

The constructions "can" and "cannot" are not substitutes for "may" and "need not".

will indicates that something is certain or expected to happen as a result of action taken by an agency

will not indicates that something is certain or expected not to happen as a result of action taken by an

might indicates a likelihood that something will happen as a result of action taken by some agency the

might not indicates a likelihood that something will not happen as a result of action taken by some agency

is not (or any other negative verb in the indicative mood) indicates a statement of fact

The present document defines the (U)SIM Application Programming Interface extending the "UICC API for Java

This API allows to develop a (U)SAT application running together with a (U)SIM application and using GSM/3G

The present document includes information applicable to network operators, service providers, server – (U)SIM – and

The following documents contain provisions which, through reference in this text, constitute provisions of the present

- References are either specific (identified by date of publication, edition number, version number, etc.) or

- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including

a GSM document), a non-specific reference implicitly refers to the latest version of that document in the same

[4] 3GPP TS 51.011 Release 4: "Specification of the Subscriber Identity Module- Mobile Equipment

[6] 3GPP TS 31.101: "UICC-terminal interface; Physical and logical characteristics".

[8] 3GPP TS 51.014 Release 4: "Specification of the SIM Application Toolkit for the Subscriber

[9] 3GPP TS 31.115: "Secured packet structure for the (U)SIM Toolkit applications".

[11] ORACLE "Application Programming Interface, Java Card™ Platform, 3.0.1 Classic Edition".

[12] ORACLE "Runtime Environment Specification, Java Card™ Platform, 3.0.1 Classic Edition".

[13] ORACLE "Virtual Machine Specification Java Card™ Platform, 3.0.1 Classic Edition".

[15] IEC 61162-1: "Maritime navigation and radio communication equipment and systems – Digital

For the purposes of the present document, the terms and definitions defined in ETSI TS 102 241 [2] apply.

For the purposes of the present document, the abbreviations defined in ETSI TS 102 241 [2] apply.

This API is an extension to the ETSI TS 102 241 [2] "UICC API for Java Card™" and requires the implementation of

The classes and interfaces described in this specification inherit functionality from the classes and interfaces specified

The (U)SAT Framework described in this specification is an extension of the CAT Runtime Environment defined in

The overall architecture of the (U)SIM API is based on the "UICC API for Java Card™" defined in

The (U)SIM file access API consists of the package uicc.usim.access. This package defines additional constants to

those defined in the uicc.access package from ETSI TS 102 241 [2]. The access to the file system, defined in

TS 51.011 [4] and TS 31.102 [3], is the one specified in ETSI TS 102 241 [2] via the UICC FileView Interface. When

selecting a cyclic file the current record number is defined, this applies also to files located under DF .

The (U)SIM toolkit API consists of the uicc.usim.toolkit package for toolkit features defined in TS 31.111 [7] and

TS 51.014 [8], and is based on the uicc.toolkit package defined in ETSI TS 102 241 [2].

The following clause describes the handling of exceptions by the (U)SAT Framework in addition to the behaviour

If an Applet triggered by EVENT_FORMATTED_SMS_PP_ENV event throws an ISOException with the reason code

The following events can trigger a Toolkit Applet in addition to the events defined in ETSI TS 102 241 [2], all short

There are two ways for a card to receive a Short Message Point to Point: via an ENVELOPE(SMS-PP DOWNLOAD)

APDU as defined in TS 31.111 [7] and TS 51.014 [8] or an UPDATE RECORD EF APDU as defined in

TS 31.102 [3] and TS 51.011 [4]. The EF can be either located under the DF or under any ADF as defined in

- formatted according to TS 31.115 [9] or an other protocol to identify explicitly the toolkit applet for which the

- unformatted (e.g. a toolkit applet specific protocol ) then the (U)SAT Framework will pass this data to all

When the Short Message is received as Concatenated Short Messages as defined in TS 23.040 [10], it is the

responsibility of the (U)SAT Framework to link single Short Messages together to re – assemble the original message

before any further processing. The original Short Message shall be placed in one SMS TPDU TLV (with TP-UDL field

coded on one octet) included in the USATEnvelopeHandler. The concatenation control headers used to re-assemble the

short messages in the correct order shall not be present in the SMS TPDU. The TP-elements of the SMS TPDU and the

Address (TS – Service-Centre-Address) shall correspond to the ones in the last received Short Message (independently

The minimum requirement for the (U)SAT Framework is to process a concatenated short message with the following

Upon reception of a TS 31.115 [9] formatted Short Message Point to Point (Single or Concatenated) via an

- take the optional Application Data posted by the triggered toolkit applet if present;

Upon reception of an unformatted Short Message Point to Point (Single or Concatenated) via an ENVELOPE, the

NOTE: As a consequence of the EnvelopeResponseHandler availability rules specified in clause 6.6, only the

Upon reception of a TS 31.115 [9] formatted Short Message Point to Point (Single or Concatenated) via an UPDATE

- update the EF file with the data received, it is then up to the receiving toolkit applet to change the SMS stored

The USATEnvelopeHandler provided to the applet shall contain the following COMPREHENSION TLVs:

The Device Identities Comprehension TLV is used to store the information about the absolute record number in the

EF file and the value of the EF record status byte, and is formatted as defined below:

With the absolute record number the toolkit applet can update EF in absolute mode to change the received SMS (e.g.

For Concatenated Short Message the Absolute Record Number and the Record Status will correspond to the last

The value is the TS-Service-Centre-Address (RP-OA) of the last UPDATE RECORD EF APDU.

The AID comprehension TLV is present only if the EF file updated is under an ADF. The value is the AID of the

Upon reception of an unformatted Short Message Point to Point (Single or Concatenated) via UPDATE RECORD

- convert the UPDATE RECORD EF APDU data into a COMPREHENSION TLV List (as described for

The content of EF may have been modified by a previously triggered Toolkit Applet..

The received Cell Broadcast Message, via an ENVELOPE (CELL BROADCAST DOWNLOAD) APDU as defined in

- formatted according to TS 31.115 [9] or an other protocol to identify explicitly the toolkit applet for which the

- unformatted ( e.g. using a toolkit applet specific protocol ), then the (U)SAT Framework will pass this data to all

When the Cell Broadcast Message is received as multiple pages as defined in TS 23.041 [5], it is the responsibility of

the (U)SAT Framework to link single pages together to re-assemble the original message before any further processing.

The original Cell Broadcast message shall be placed in one Cell Broadcast page TLV included in the

USATEnvelopeHandler. The message parameters shall correspond to the ones in the last received Cell Broadcast page

Upon reception of a TS 31.115 [9] formatted Cell Broadcast message, the (U)SAT Framework shall:

Upon reception of an unformatted Cell Broadcast message, the (U)SAT Framework shall trigger all the Toolkit Applets

Upon reception of an ENVELOPE (MO SHORT MESSAGE CONTROL defined in TS 51.014 [8] and TS 31.111 [7])

APDU as defined in TS 31.101 [6] and TS 51.011 [4] the (U)SAT Framework shall trigger the Toolkit Applet

registered to this event. The (U)SAT Framework shall not allow more than one Toolkit Applet to be registered to this

event at a time(e.g. if a Toolkit Applet is registered to this event but not in selectable state the (U)SAT Framework shall

The received USSD String, via an ENVELOPE (USSD Data Download) APDU as defined in TS 31.111 [7], may be:

- formatted according to TS 31.115 [9] or an other protocol to identify explicitly the toolkit applet for which the

- unformatted (e.g. a toolkit applet specific protocol) then the (U)SAT Framework will pass this data to all

When the USSD Message is received as concatenated as defined in TS 31.115 [9], it is the responsibility of the (U)SAT

Framework to link single USSD Messages together to re-assemble the original message before any further processing.

The original USSD message shall be placed in one USSD String TLV included in the USATEnvelopeHandler. The

USSD String parameters (DCS, PFI, CCF) shall correspond to the ones in the last received USSD String (independently

Upon reception of a TS 31.115 [9] formatted USSD Message via an ENVELOPE, the (U)SAT Framework shall:

- take the optional Application Data posted by the triggered toolkit applet if present;

Upon reception of an unformatted USSD String via an ENVELOPE, the (U)SAT Framework shall trigger all the

NOTE: As a consequence of the EnvelopeResponseHandler availability rules specified in clause 6.6, only the

Upon reception of an ENVELOPE (Event Download) APDU command as defined in TS 31.111 [7] the (U)SAT

Framework shall trigger all the Toolkit applets registered to the corresponding event.

The following events defined in TS 31.111 [7] shall be raised upon reception of the corresponding APDU defined in