ETSI TS 102 588 V15.0.0 (2019-02)

Smart Cards; Application invocation Application Programming Interface (API) by a UICC webserver for Java Card™ platform (Release 15)

RTS/SCP-T102588v1500

General Information

• Status: Published
• Publication Date: 12-Feb-2019
• Technical Committee: SET TEC - SET-TEC
• Current Stage: 12 - Completion
• Due Date: 19-Feb-2019
• Completion Date: 13-Feb-2019

Standards Content (Sample)

ETSI TS 102 588 V15.0.0 (2019-02)






TECHNICAL SPECIFICATION
Smart Cards;
Application invocation
Application Programming Interface (API)
by a UICC webserver for Java Card™ platform
(Release 15)



---------------------- Page: 1 ----------------------
Release 15 2 ETSI TS 102 588 V15.0.0 (2019-02)



Reference
RTS/SCP-T102588v1500
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 - 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
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
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 2019.
All rights reserved.

TM TM TM
DECT , PLUGTESTS , UMTS and the ETSI logo are trademarks of ETSI registered for the benefit of its Members.
TM TM
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.
ETSI

---------------------- Page: 2 ----------------------
Release 15 3 ETSI TS 102 588 V15.0.0 (2019-02)
Contents
Intellectual Property Rights . 4
Foreword . 4
Modal verbs terminology . 4
1 Scope . 5
2 References . 5
2.1 Normative references . 5
2.2 Informative references . 6
3 Definition of terms, symbols and abbreviations . 6
3.1 Terms . 6
3.2 Symbols . 6
3.3 Abbreviations . 6
4 Description . 6
4.1 Architecture . 6
4.2 Registration and deregistration . 7
4.3 Invocation and Retrieval of Data . 8
4.4 Transfer of response data . 8
4.5 Response header management . 9
4.6 ProactiveHandler and ProactiveResponseHandler . 9
Annex A (normative): Application invocation API by a UICC Webserver for the Java
Card™ platform . 10
Annex B (normative): Application invocation API by a UICC Webserver for the Java
Card™ platform . 11
Annex C (normative): Application invocation API by a UICC Webserver for the Java
Card™ platform package version management . 12
Annex D (informative): Change history . 13
History . 14

ETSI

---------------------- Page: 3 ----------------------
Release 15 4 ETSI TS 102 588 V15.0.0 (2019-02)
Intellectual Property Rights
Essential patents
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
server (https://ipr.etsi.org/).
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
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.
Foreword
This Technical Specification (TS) has been produced by ETSI Technical Committee Smart Card Platform (SCP).
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.
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: 4 ----------------------
Release 15 5 ETSI TS 102 588 V15.0.0 (2019-02)
1 Scope
The present document defines an API that allows a UICC based SCWS defined by OMA to forward HTTP requests to
an Applet and to receive the response from the Applet. It also defines an API for the Applet to register and unregister to
the SCWS.
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.
Referenced documents which are not found to be publicly available in the expected location might be found at
https://docbox.etsi.org/Reference/.
• 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 necessary for the application of the present document.
[1] IETF RFC 2616: "Hypertext Transfer Protocol -- HTTP/1.1".
NOTE 1: Available at http://www.ietf.org/rfc/rfc2616.txt.
NOTE 2: IETF RFC 2616 has been obsoleted by IETF RFC 7230, IETF RFC 7231, IETF RFC 7232, IETF
RFC 7233, IETF RFC 7234, IETF RFC 7235.
[2] ETSI TS 102 241: "Smart Cards; UICC Application Programming Interface (UICC API) for Java
TM
Card ".
[3] OMA-AD-Smartcard-Web-Server-V1-0-20070209-C: "Smartcard -Web Server Enabler
Architecture".
[4] OMA-TS-Smartcard-Web-Server-V1-0-20070209-C: "Smartcard-Web-Server".
[5] ORACLE: "Application Programming Interface, Java Card™ Platform, 3.0.1 Classic Edition".
[6] ORACLE: "Runtime Environment Specification, Java Card™ Platform, 3.0.1 Classic Edition".
[7] ORACLE: "Virtual Machine Specification Java Card™ Platform, 3.0.1 Classic Edition".
NOTE: SUN Java Card Specifications can be downloaded at http://java.sun.com/products/javacard.
[8] ETSI TS 101 220: "Smart Cards; ETSI numbering system for telecommunication application
providers".
[9] ETSI TS 102 225: "Smart Cards; Secured packet structure for UICC based applications".
[10] ETSI TS 102 221: "Smart Cards; UICC-Terminal interface; Physical and logical characteristics".
ETSI

---------------------- Page: 5 ----------------------
Release 15 6 ETSI TS 102 588 V15.0.0 (2019-02)
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
Void.
3.2 Symbols
Void.
3.3 Abbreviations
For the purposes of the present document, the following abbreviations apply:
AID Application IDentifier
API Application Program Interface
CAT Card Application Toolkit
CAT_TP Card Application Toolkit Transport Protocol
FFS For Further Study
HTTP HyperText Transfer Protocol
JCRE Java Card™ Run-time Environment
OMA Open Mobile Alliance
SCWS Smart Card based Web Server
NOTE: According to OMA specifications [3] and [4].
URI Uniform Resource Identifier
4 Description
4.1 Architecture
The present document describes an API and a SCWS Runtime Environment that enables Java Card™ platform based
applets, defined in [5], [6], [7], to register to and unregister from an SCWS implemented in the UICC, defined by OMA
in [3] and [4].
ETSI

---------------------- Page: 6 ----------------------
Release 15 7 ETSI TS 102 588 V15.0.0 (2019-02)
The API enables a registered Applet to receive an incoming HTTP request that is forwarded by the SCWS. The API
provides the necessary methods to allow registered Applets to respond with a correctly formatted HTTP response to the
SCWS. The API provides means to the Applet to access the HTTP header data
...