Menu

GSMA · Specification

SGP.32v1.0.1

eSIM IoT Technical Specification

Specifies technical solutions for remote provisioning and management of eUICCs in IoT devices, supporting interoperability across deployment scenarios.

Version
v1.0.1
  1. v1.32026-05-22
  2. v1.22024-06-27
  3. v1.12024-04-26
  4. v1.0.12023-07-04
  5. v1.02023-05-26
Issued
2023-07-04
Source
Original DOCX

A formatted version of this document is not available yet; the text below is extracted clause by clause, so tables and figures may be incomplete.

Overview

This specification describes remote provisioning and management of eUICCs in IoT devices that are network-constrained, user-interface-constrained, or both. It covers the IoT eUICC architecture, roles, interfaces, security functions, profile delivery and management, and procedures for provisioning and configuration. It also defines interface functions and bindings, including HTTP, CoAP, ASN.1 and JSON, with informative mappings to LwM2M and MQTT. The technical solution provides a basis for interoperability across supported deployment scenarios.

  • eUICC
  • eSIM remote provisioning
  • HTTP
  • CoAP
  • LwM2M
  • MQTT

Overview generated automatically from the document's scope and outline. The document text is authoritative.

Changes since v1.0

3 clauses modified

Compared automatically clause by clause from the extracted text of both versions; differences only in layout, spacing or table cells are ignored. The documents are authoritative.

2.11.1.1.1 eIM Configuration Datamodified

…IONAL, counterValue [3] INTEGER OPTIONAL, -- initial counterValue for the eIM associationToken [4] INTEGER OPTIONAL, eimPublicKeyData [5] CHOICE { eimPublicKey … [6] SubjectPublicKeyInfo, -- public key of eIM, used for eUICC Package signature verification, where the encoding follows X.509 standard eimCertificate [7] Certificate -- certificate of eIM, used for eUICC Package signature verification, where the encoding follows X.509 standard } OPTIONAL, trustedPublicKeyDataTls [8][6] CHOICE { trustedEimPkTls [9] SubjectPublicKeyInfo, -- public key of eIM, used for TLS or DTLS, where the encoding follows X.509 standard trustedCertificateTls [10] Certificate -- either the certificate of eIM, used for (D)TLS, or the certificate of the CA, where the encoding follows X.509 standard } OPTIONAL, eimSupportedProtocol [11][7] EimSupportedProtocol OPTIONAL, euiccCiPKId [12][8] SubjectKeyIdentifier OPTIONAL -- CI Public Key Identifier supported on the eUICC for signature creation } EimIdType ::= INTEGER { eimIdTypeOid(1), eimIdTypeFqd… …

5.14.2 Function: (ESipa) GetBoundProfilePackagemodified

…to a previous normal execution of an Esipa.AuthenticateClient function through a TransactionID delivered by the SM-DP+. On reception of this function call, the … eIMEim SHALL call the ES9+’.GetBoundProfilePackage function based on the received input data. The input parameters of this function are identical to the those of ES9+ … downloadResponseOk received from eUICC into a prepareDownloadResponse with compactDownloadResponseOk in order to reduce the number of bytes to transmit to the … eIM.Eim. Before calling the ES9+’.GetBoundProfilePackage function, an eIMEim that receives a prepareDownloadResponse from an IPA with IPA Capability minimizeEsipaBytes SHALL restore the prepareDownloadResponse prepared by the eUICC based on the received prepareDownloadResponse and data already available to the eIMEim (smdpSigned2 and hashCc). Additional Input Data: Input data name Description Type No. MOC transactionId Transaction ID as generated by the SM-DP+ (section 3.1.… …

C.1 Document Historymodified

…lgorithms and Parameters for eIM Signing Key | CR0244R01 Clarification Interoperable profile | CR0245R01 Clarification Initialisation procedure | 26 May 2023 | … SGP.32 v1.0.1 | 04 July 2023 | Fix problems on the ASN.1 structure. | GSMA | Other Information Type Description Document Owner eSIM Group Editor / Company Gloria Trujillo, GSMA It is our intention to provide a quality product for your us… …

Contents
  1. 1 Introduction
  2. 1.1 Overview
  3. 1.2 Scope
  4. 1.3 Document Purpose
  5. 1.4 Intended Audience
  6. 1.5 Definition of Terms
  7. 1.6 Abbreviations
  8. 1.7 References
  9. 1.8 Conventions
  10. 1.9 References to SGP.22
  11. 2 General Architecture
  12. 2.1 General Architecture
  13. 2.1.1 Architecture Diagram with IPA in the IoT Device
  14. 2.1.2 Architecture Diagram with IPA in the eUICC
  15. 2.1.3 ASN.1
  16. 2.2 Roles
  17. 2.3 Interfaces
  18. 2.4 eUICC Architecture
  19. 2.4.1 eUICC Architecture Diagram
  20. 2.4.2 ECASD
  21. 2.4.3 ISD-R
  22. 2.4.4 ISD-P
  23. 2.4.5 Profile
  24. 2.4.6 Telecom Framework
  25. 2.4.7 Profile Package Interpreter
  26. 2.4.8 IPA in the eUICC
  27. 2.4.9 IPA Services
  28. 2.5 Profile Protection and Delivery
  29. 2.6 Security Overview
  30. 2.6.1 Relation to SGP.22
  31. 2.6.2 IoT Device Security
  32. 2.6.3 TLS Requirements
  33. 2.6.4 eIM Keys and eIM Certificates
  34. 2.7 Certificate Management
  35. 2.7.1 RSP Server Certificates
  36. 2.7.2 eUICC/EUM Certificates
  37. 2.7.3 eIM Certificates
  38. 2.8 Profile Policy Management
  39. 2.9 Profile State Management
  40. 2.9.1 Profile State Management by the eIM
  41. 2.9.2 Automatic Profile enabling of an IPA initiated Profile download from Default SM-DP+
  42. 2.10 eIM Configuration
  43. 2.10.1 eIM Configuration by eIM
  44. 2.10.2 eIM configuration by IPA
  45. 2.11 eIM Package Structures
  46. 2.11.1 eIM Package Request
  47. 2.11.2 eIM Package Result
  48. 3 Procedures
  49. 3.1 eIM and IPA Communication
  50. 3.1.1 Transferring eIM Package
  51. 3.1.2 Secure Connection Establishment
  52. 3.2 Profile Download and Installation
  53. 3.2.1 Profile Download Initiation
  54. 3.2.2 Common Mutual Authentication
  55. 3.2.3 Profile Download
  56. 3.3 eUICC Package Handling
  57. 3.3.1 Generic eUICC Package Download and Execution
  58. 3.4 Profile State Management
  59. 3.4.1 Enable Profile
  60. 3.4.2 Disable Profile
  61. 3.4.3 Delete Profile
  62. 3.4.4 Configure Automatic Profile Enabling by eIM
  63. 3.4.5 Configure Automatic Profile Enabling by IPA
  64. 3.5 eIM Configuration at eUICC
  65. 3.5.1 eIM Configuration Data managed by eIM
  66. 3.5.2 eIM Configuration Data managed by IPA
  67. 3.6 Error handling within an RSP session
  68. 3.7 Notification Delivery to Notification Receivers
  69. 3.8 IoT Device and eUICC Initialisation
  70. 3.9 SM-DS Use
  71. 3.9.1 Event Registration
  72. 3.9.2 Event Retrieval
  73. 3.9.3 Event Deletion
  74. 4 Data Elements
  75. 4.1 IPA Capabilities
  76. 4.2 eIM Supported Protocol
  77. 4.3 eIM Identifier
  78. 5 Functions
  79. 5.1 Overview of Functions per Interface
  80. 5.2 Server to Server Function Commonalities
  81. 5.2.1 Common Data Types
  82. 5.2.2 Request-Response Function
  83. 5.2.3 Notification Handler Function
  84. 5.2.4 Functions Input Header
  85. 5.2.5 Functions Output Header
  86. 5.2.6 Status Code
  87. 5.3 ES2+ (Operator -- SM-DP+)
  88. 5.4 ES6 (Operator -- eUICC)
  89. 5.5 ES8+ (SM-DP+ -- eUICC)
  90. 5.6 ES9+ (IPA -- SM-DP+)
  91. 5.7 ES9+’ (eIM -- SM-DP+)
  92. 5.7.1 Function (ES9+’): InitiateAuthentication
  93. 5.7.2 Function (ES9+’): GetBoundProfilePackage
  94. 5.7.3 Function (ES9+’): AuthenticateClient
  95. 5.7.4 Function (ES9+’): HandleNotification
  96. 5.7.5 Function (ES9+’): CancelSession
  97. 5.8 ES10a (IPA -- eUICC)
  98. 5.8.1 Function (ES10a): GetEuiccConfiguredAddresses
  99. 5.9 ES10b (IPA -- eUICC)
  100. 5.9.1 Function (ES10b): LoadEuiccPackage
  101. 5.9.2 Function (ES10b): GetEUICCInfo
  102. 5.9.3 Function (ES10b): GetEUICCChallenge
  103. 5.9.4 Function (ES10b): AddInitialEim
  104. 5.9.5 Function (ES10b): eUICCMemoryReset
  105. 5.9.6 Function (ES10b): AuthenticateServer
  106. 5.9.7 Function (ES10b): PrepareDownload
  107. 5.9.8 Function (ES10b): LoadBoundProfilePackage
  108. 5.9.9 Function (ES10b): CancelSession
  109. 5.9.10 Function (ES10b): GetCerts
  110. 5.9.11 Function (ES10b): RetrieveNotificationsList
  111. 5.9.12 Function (ES10b): RemoveNotificationFromList
  112. 5.9.13 Function (ES10b): GetRAT
  113. 5.9.14 Function (ES10b): GetProfilesInfo
  114. 5.9.15 Function (ES10b): EnableUsingDD
  115. 5.9.16 Function (ES10b): ProfileRollback
  116. 5.9.17 Function (ES10b): ConfigureAutomaticProfileEnabling
  117. 5.9.18 Function (ES10b): GetEimConfigurationData
  118. 5.9.19 Function (ES10b): GetEID
  119. 5.10 ES11 (IPA -- SM-DS)
  120. 5.11 ES11’ (eIM -- SM-DS)
  121. 5.12 ES12 (SM-DS -- SM-DP+)
  122. 5.13 ESep (eIM -- eUICC)
  123. 5.13.1 Function (ESep): Enable
  124. 5.13.2 Function (ESep): Disable
  125. 5.13.3 Function (ESep): Delete
  126. 5.13.4 Function (ESep): ListProfileInfo
  127. 5.13.5 Function (ESep): GetRAT
  128. 5.13.6 Function (ESep): ConfigureAutoEnable
  129. 5.13.7 Function (ESep): AddEim
  130. 5.13.8 Function (ESep): UpdateEim
  131. 5.13.9 Function (ESep): DeleteEim
  132. 5.13.10 Function (ESep): ListEim
  133. 5.14 ESipa (eIM -- IPA)
  134. 5.14.1 Function (ESipa): InitiateAuthentication
  135. 5.14.2 Function: (ESipa) GetBoundProfilePackage
  136. 5.14.3 Function: (Esipa) AuthenticateClient
  137. 5.14.4 Function (ESipa): TransferEimPackage
  138. 5.14.5 Function (ESipa): GetEimPackage
  139. 5.14.6 Function (ESipa): ProvideEimPackageResult
  140. 5.14.7 Function (ESipa): HandleNotification
  141. 5.14.8 Function (ESipa): CancelSession
  142. 6 Interface Binding
  143. 6.1 ESipa interface binding over HTTP
  144. 6.1.1 ASN.1 message definition
  145. 6.1.2 JSON message definition
  146. 6.2 ESipa interface binding over CoAP
  147. 6.3 ESipa function binding in ASN.1
  148. 6.3.1 ASN.1 structures for ESipa messages between IPA and eIM
  149. 6.3.2 ESipa functions provided by eIM
  150. 6.3.3 ESipa functions provided by IPA
  151. 6.4 ESipa function binding in JSON
  152. 6.4.1 List of functions
  153. A IoT Device Requirements (Normative)
  154. A.1 Functional IoT Device Requirements
  155. B Mapping of procedures to IoT protocols (Informative)
  156. B.1 LwM2M
  157. B.1.1 Secure connection
  158. B.1.2 LwM2M object
  159. B.1.3 Procedures
  160. B.2 MQTT
  161. B.2.1 Mapping of MQTT Roles
  162. B.2.2 Secure connection
  163. B.2.3 Description
  164. B.2.4 Procedures
  165. C Document Management (Informative)
  166. C.1 Document History

[A red and white logo Description automatically generated with low confidence]

eSIM IoT Technical Specification

Version 1.0.1

04 July 2023

Security Classification: Non-Confidential

Access to and distribution of this document is restricted to the persons permitted by the security classification. This document is subject to copyright protection. This document is to be used only for the purposes for which it has been supplied and information contained in it must not be disclosed or in any other way made available, in whole or in part, to persons other than those permitted under the security classification without the prior written approval of the Association.

Copyright Notice

Copyright © 2023 GSM Association

Disclaimer

The GSMA makes no representation, warranty or undertaking (express or implied) with respect to and does not accept any responsibility for, and hereby disclaims liability for the accuracy or completeness or timeliness of the information contained in this document. The information contained in this document may be subject to change without prior notice.

Compliance Notice

The information contain herein is in full compliance with the GSMA Antitrust Compliance Policy.

This Permanent Reference Document is classified by GSMA as an Industry Specification, as such it has been developed and is maintained by GSMA in accordance with the provisions set out GSMA AA.35 - Procedures for Industry Specifications.

1 Introduction

1.1 Overview

This document provides a technical description of the GSMA’s eSIM IoT Architecture and Requirements SGP.31 [1] specification.

1.2 Scope

This specification provides a technical description of:

-The remote provisioning and management of the eUICC in IoT Network Constrained and/or User Interface Constrained Devices.

-The eUICC architecture for IoT Devices.

-The interfaces used within the eSIM IoT architecture; and

-The security functions used within the eSIM IoT architecture.

1.3 Document Purpose

This document defines a technical solution for the remote provisioning and management of the eUICC in IoT Devices as defined in eSIM IoT Architecture and Requirements SGP.31 [1]. The adoption of this technical solution will provide the basis for global interoperability between different deployment scenarios supported by the eSIM IoT Architecture and Requirements SGP.31 [1].

1.4 Intended Audience

Technical experts working for Operators, eUICC solution providers, IoT Device vendors, standards organisations, network infrastructure vendors, Mobile Service Providers and IoT service providers and other impacted industry bodies.

1.5 Definition of Terms

-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Term                                             Description
------------------------------------------------ ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Activation Code                                  As defined in SGP.22 [4].

Associated eIM                                   As defined in SGP.31 [1].

Bound Profile Package                            As defined in SGP.31 [1].

Certificate                                      Public key certificate.

Certification Authority                          An authority which issues public key certificates.

CoAP                                             Constrained Application Protocol.

Device Baseband                                  A device component that manages the cellular radio functions.

DTLS                                             Datagram Transport Layer Security.

eIM Configuration Data                           As defined in SGP.31 [1].

eIM Configuration Operation                      As defined in SGP.31 [1].

eIM Package                                      Contains an eUICC Package, a request for IPA and/or eUICC data, a Profile download trigger (e.g., containing an Activation Code) or acknowledgements of eUICC Package Results and Notifications.

eIM Package Result                               Execution result of an eIM Package.

eUICC                                            As defined in SGP.22 [4].

eUICC Package                                    A signed package prepared by the eIM that contains either PSMO(s) or eCO(s). The package is verified and executed by the eUICC.

eUICC Package Result                             A signed package prepared by the eUICC that contains the execution result of the eUICC Package.

Event Record                                     As defined in SGP.22 [4].

Event Registration                               As defined in SGP.22 [4].

IoT                                              As defined in SGP.31 [1].

IoT Device                                       As defined in SGP.31 [1].

IPA Capabilities                                 Indicates to the eIM what the IPA is capable of related to the functional split of Profile download between the eIM and the IPA and the use of compact data object structures in ESipa functions.

Mobile Service Provider                          As defined in SGP.31 [1].

Network Constrained Device                       As defined in SGP.31 [1].

Notification                                     As defined in SGP.22 [4].

Notification Receivers                           As defined in SGP.31 [1].

Operational Profile                              As defined in SGP.22 [4].

Operator                                         As defined in SGP.22 [4].

Profile                                          As defined in SGP.22 [4].

Profile Metadata                                 As defined in SGP.22 [4].

Profile Package                                  As defined in SGP.31 [1].

Profile Package Interpreter                      An eUICC Operating System service that translates the Profile Package data into an installed Profile using the specific internal format of the target eUICC.

Profile State Management Operation (PSMO)        As defined in SGP.31 [1].

Provisioning Profile                             As defined in SGP.22 [4].

Registered PLMN                                  As defined in 3GPP TS 23.122 [19].

Rollback Mechanism                               As defined in SGP.31 [1].

Root SM-DS                                       As defined in SGP.22 [4].

RSP Server                                       As defined in SGP.22 [4].

Rules Authorisation Table                        As defined in SGP.22 [4].

Signed eCO                                       eIM Configuration Operation performed by an Associated eIM using signed eIM Configuration Operation that contains the eIM Configuration Data.

Subscription Manager Data Preparation (SM-DP+)   As defined in SGP.22 [4].

Subscription Manager Discovery Server (SM-DS)    As defined in SGP.22 [4].

Telecom Framework                                An eUICC Operating System service that provides standardised network authentication algorithms to the network authentication applications hosted in the ISD-Ps. Furthermore, it provides capabilities to configure the algorithm with necessary parameters in the Enabled Profile.

Test Profile                                     As defined in SGP.22 [4].

TLS                                              Transport Layer Security.

Unsigned eCO                                     Non-signed eIM Configuration Operation of the initial eIM.

User Interface Constrained Device                As defined in SGP.31 [1].
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

1.6 Abbreviations

-----------------------------------------------------------------------
Abbreviation           Description
---------------------- ------------------------------------------------
CA                     Certification Authority

CRL                    Certificate Revocation List

ECASD                  eUICC Controlling Authority Security Domain

eCO                    eIM Configuration Operation

EID                    eUICC-ID as defined in SGP.22 [4]

eIM                    eSIM IoT Remote Manager

EUM                    eUICC Manufacturer

IoT                    Internet of Things

IPA                    IoT Profile Assistant

IPAd                   IoT Profile Assistant in the IoT Device

IPAe                   IoT Profile Assistant in the eUICC

ISD-P                  Issuer Security Domain – Profile

ISD-R                  Issuer Security Domain – Root

NCD                    Network Constrained Device

OCSP                   Online Certificate Status Protocol

OTA                    Over The Air

PSMO                   Profile State Management Operation

RAT                    Rules Authorisation Table

RPLMN                  Registered Public Land Mobile Network

SM-DP+                 Subscription Manager Data Preparation +

SM-DS                  Subscription Manager Discovery Server

UICD                   User Interface Constrained Device
-----------------------------------------------------------------------

1.7 References

Ref

Document
Number

Title

[1]

SGP.31

eSIM IoT Architecture and Requirements, version 1.1

[2]

RFC 2119

Key words for use in RFCs to Indicate Requirement Levels, S. Bradner

[3]

RFC 8174

Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words

[4]

SGP.22

RSP Technical Specification, version 2.5

[5]

ETSI TS 102 223

Smart Cards; Card Application Toolkit (CAT)

[6]

SGP.02

GSMA Remote Provisioning of Embedded UICC Technical specification version 4.2

[7]

RFC 7252

The Constrained Application Protocol (CoAP)

[8]

RFC 5246

The Transport Layer Security (TLS) Protocol Version 1.2

[9]

RFC 8446

The Transport Layer Security (TLS) Protocol Version 1.3

[10]

RFC 6347

Datagram Transport Layer Security Version 1.2

[11]

RFC 9147

The Datagram Transport Layer Security (DTLS) Protocol Version 1.3

[12]

RFC 7959

Block-Wise Transfers in the Constrained Application Protocol (CoAP)

[13]

RFC 9175

Constrained Application Protocol (CoAP): Echo, Request-Tag, and Token Processing

[14]

RFC 9146

Connection Identifier for DTLS 1.2

[15]

RFC 8422

Elliptic Curve Cryptography (ECC) Cipher Suites for Transport Layer Security (TLS) Versions 1.2 and earlier

[16]

RFC 7027

Elliptic Curve Cryptography (ECC) Brainpool Curves for Transport Layer Security (TLS)

[17]

RFC 5289

TLS Elliptic Curve Cipher Suites with SHA-256/384 and AES Galois Counter Mode (GCM)

[18]

RFC 8410

Algorithm Identifiers for Ed25519, Ed448, X25519, and X448 for Use in the Internet X.509 Public Key Infrastructure

[19]

3GPP TS 23.122

3rd Generation Partnership Project;

Technical Specification Group Core Network and Terminals;

Non-Access-Stratum (NAS) functions related to Mobile Station (MS) in idle mode

[20]

RFC 5077

Transport Layer Security (TLS) Session Resumption without Server-Side State

[21]

RFC 6960

X.509 Internet Public Key Infrastructure Online Certificate Status Protocol – OCSP

[22]

3GPP TS 24.008

3rd Generation Partnership Project;

Technical Specification Group Core Network and Terminals;

Mobile radio interface Layer 3 specification;

Core network protocols;

Stage 3

[23]

MQTTs

MQTTs version 5.0 based on TLS

[24]

RFC 5639

Elliptic Curve Cryptography (ECC) Brainpool Standard Curves and Curve Generation

[25]

RFC 5280

Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile

[26]

ANSSI ECC

Avis relatif aux paramètres de courbes elliptiques définis par l'Etat français. JORF n°0241 du 16 octobre 2011 page 17533. texte n° 30. 2011

[27]

RFC 5480

Elliptic Curve Cryptography Subject Public Key Information

[28]

ISO 14888-3

IT Security techniques — Digital signatures with appendix — Part 3: Discrete logarithm-based mechanisms

[29]

TCA eUICC Profile Package

eUICC Profile Package: Interoperable Format Technical Specification

1.8 Conventions

“The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119 [2] and clarified by RFC 8174 [3], when, and only when, they appear in all capitals, as shown here.”

1.9 References to SGP.22

The present document contains several references to SGP.22 [4].

The following list maps the terms used by SGP.22 [4] to the terms used in the present document:

-LPA (Local Profile Assistant) refers to IPA.

2 General Architecture

This section contains a technical description and architecture of the eSIM IoT system for IoT Devices. The statements in this section define the basic characteristics that need to be taken into account when reviewing this specification.

2.1 General Architecture

This section further specifies the roles and interfaces associated with the Remote SIM Provisioning and Management of the eUICC for IoT Devices.

2.1.1 Architecture Diagram with IPA in the IoT Device

This section further specifies the roles and interfaces associated with the Remote SIM Provisioning and Management with the IPA in the IoT Device (Figure 1).

[Figure not reproduced — see the original document]

1.: eSIM IoT Functional Architecture (IPA in the IoT Device)

2.1.2 Architecture Diagram with IPA in the eUICC

This section further specifies the roles and interfaces associated with the Remote SIM Provisioning and Management with the IPA in the eUICC (Figure 2).[]

2.: eSIM IoT Functional Architecture (IPA in the eUICC)

2.1.3 ASN.1

The description of some data objects in this specification is based on ASN.1 specified in ITU‑T X.680 [49] and encoded in TLV structures using DER (Distinguished Encoding Rule) encoding as specified in ITU-T X.690 [50]. This provides a flexible description of those data objects.

Data structures in these specifications are defined in a single, self-contained, ASN.1 definition module called SGP32Definitions, with an ISO Object Identifier in the GSMA namespace. A number of definitions are imported from the RSPDefinitions module defined in SGP.22 [4].

ASN.1 definitions
-- ASN1START

SGP32Definitions {joint-iso-itu-t(2) international-organizations(23) gsma(146) rsp(1) asn1modules(1) sgp32v1(31)}

DEFINITIONS

AUTOMATIC TAGS

EXTENSIBILITY IMPLIED ::=

BEGIN

IMPORTS Certificate, SubjectPublicKeyInfo FROM PKIX1Explicit88 {iso(1) identified-organization(3) dod(6) internet(1) security(5) mechanisms(5) pkix(7) id-mod(0) id-pkix1-explicit(18)}

SubjectKeyIdentifier FROM PKIX1Implicit88 {iso(1) identified-organization(3) dod(6) internet(1) security(5) mechanisms(5) pkix(7) id-mod(0) id-pkix1-implicit(19)}

ProfileInfo, EuiccSigned1, CancelSessionReason, RetrieveNotificationsListResponse, ServerSigned1, RspCapability, Iccid, TransactionId, ProfileInfoListRequest, ProfileInfoListResponse, RulesAuthorisationTable, EUICCInfo1, DeviceInfo, VersionType, UICCCapability, SubjectKeyIndentifier, PprIds, CertificationDataObject, Octet1, Octet16, Octet32, PrepareDownloadResponse, PrepareDownloadResponseOk, PrepareDownloadResponseError, AuthenticateServerResponse, AuthenticateResponseOk, AuthenticateResponseError, CtxParams1, ProfileInstallationResult, ProfileInstallationResultData, OtherSignedNotification, EuiccSignPIR, ErrorResult, NotificationMetadata, CancelSessionResponse, CancelSessionResponseOk, CancelSessionResponseError, StoreMetadataRequest, SmdpSigned2, BoundProfilePackage FROM RSPDefinitions {joint-iso-itu-t(2) international-organizations(23) gsma(146) rsp(1) asn1modules(1) sgp22v2(2)};

-- ASN1STOP

Two encoding/decoding attributes are defined:

-AUTOMATIC TAGS means that the tags are defined automatically using the encoding rules unless a tag notation is present in a data object format definition.

-EXTENSIBILITY IMPLIED means that types MAY have elements that are not defined in this specification. This means that decoders SHALL be able to handle values with unspecified tags, either by processing them if they know their value content or ignoring them silently (without reporting an error) if they do not know them. This is useful when processing data definitions from a newer specification and to handle proprietary tag values.

As the eUICC cannot implement an off-the-shelf standard decoder, the requirement on extensibility SHALL NOT apply to the eUICC.

2.2 Roles

Roles are defined within SGP.31 [1] section 3.

2.3 Interfaces

The following table provides information about the interfaces within the architecture.

  --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
  Interface   Between                Description
  ----------- ---------- ----------- ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
  ES2+        Operator   SM-DP+      Used by the Operator to order Profiles for specific eUICCs as well as other administrative functions as defined in SGP.31 [1].

  ES6         Operator   eUICC       Used by the Operator for the management of Operator services via OTA services as defined in SGP.31 [1].

  ES8+        SM-DP+     eUICC       Provides a secure end-to-end channel between the SM-DP+ and the eUICC for the administration of the ISD-P and the associated Profile during download and installation. It provides Perfect Forward Secrecy as defined in SGP.31 [1].

  ES9+        SM-DP+     IPA         Used to provide a secure transport between the SM-DP+ and the IPA for the delivery of the Bound Profile Package as defined in SGP.31 [1].

  ES9+’       SM-DP+     eIM         Used to provide a secure transport between the SM-DP+ and the eIM for the delivery of the Bound Profile Package as defined in SGP.31 [1].

  ES10a       IPA        eUICC       Used between the IPA (in the IoT Device) and the eUICC to handle a Profile discovery as defined in SGP.31 [1].

  ES10b       IPA        eUICC       Used between the IPA (in the IoT Device) and the IPA Services to transfer a Bound Profile Package to the eUICC as defined in SGP.31 [1]. This interface plays no role in the decryption of Profile Packages.

  ES11        IPA        SM-DS       Used by the IPA to retrieve Event Records for the respective eUICC as defined in SGP.31 [1].

  ES11’       eIM        SM-DS       Used by the eIM to retrieve Event Records for the respective eUICC as defined in SGP.31 [1].

  ES12        SM-DP+     SM-DS       Used by the SM-DP+ to issue or remove Event Registrations on the SM-DS as defined in SGP.31 [1].

  ESep        eIM        eUICC       Logical end-to-end interface between the eIM and the eUICC used to transfer eUICC Packages for Profile State management and eIM configuration by eIM, as defined in SGP.31 [1].

  ESipa       eIM        IPA         Logical interface between an eIM and an IPA, as defined in SGP.31 [1], used to trigger a Profile download at the IPA and to provide a secure transport for the delivery of eUICC Packages, unless the underlying transport provides necessary security.
  --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

1.: Interfaces

NOTE: Support of the ES10c interface as defined in SGP.22 [4] is out of scope of this specification.

2.4 eUICC Architecture

This section describes the internal high-level architecture of the eUICC.

NOTE: The eUICC architecture is very similar to that used in SGP.22 [4].

2.4.1 eUICC Architecture Diagram

The IPA SHALL be located either in the IoT Device (IPAd) or in the eUICC (IPAe).

2.4.1.1 eUICC Architecture Diagram (IPA in the IoT Device)

The following diagram represents the eUICC architecture when the IPA is located in the IoT Device.

[Figure not reproduced — see the original document]

3.: Schematic Representation of the eUICC (IPA in the Device)

2.4.1.2 eUICC Architecture Diagram (IPA in the eUICC)

The following diagram represents the eUICC architecture when the IPA is located in the eUICC.

[Figure not reproduced — see the original document]

4.: Schematic Representation of the eUICC (IPA in the eUICC)

2.4.2 ECASD

The eUICC Controlling Authority Security Domain (ECASD) as defined in SGP.22 [4].

2.4.3 ISD-R

The ISD-R as defined in SGP.22 [4].

2.4.4 ISD-P

The ISD-P entity as defined in SGP.22 [4].

2.4.5 Profile

The Profile as defined in SGP.22 [4].

2.4.5.1 Operational Profile

The Operational Profile as defined in SGP.22 [4].

2.4.5.2 Provisioning Profile

The Provisioning Profile as defined in SGP.22 [4].

2.4.5.3 Test Profile

The Test Profile as defined in SGP.22 [4].

2.4.6 Telecom Framework

The Telecom Framework as defined in SGP.22 [4].

2.4.7 Profile Package Interpreter

The Profile Package Interpreter as defined in SGP.22 [4].

2.4.8 IPA in the eUICC

The IPAe is a functional element which provides similar features as those provided by the IPA in the IoT Device. The implementation of IPAe is OPTIONAL.

The technical implementation of the IPAe is EUM-specific.

2.4.9 IPA Services

This role provides the necessary access to the services and data required by functions of the IPA. These services include:

-Provide the address of the Root SM-DS and (if configured) the default SM-DP+

-Transfer Bound Profile Package from the IPAd to the ISD-P

-Provide list of installed Profiles and their Profile Metadata

-Retrieve EID

-Provide Profile State Management Operations

-Provide eUICC execution results and Notifications.

2.5 Profile Protection and Delivery

An Operator’s Profile is protected within a Profile Package prior to being downloaded to the eUICC as defined in section 2.5 of SGP.22 [4].

2.6 Security Overview

2.6.1 Relation to SGP.22

This specification SHALL re-use the overall security features specified in SGP.22 [4] section 2.6, unless otherwise specified.

2.6.2 IoT Device Security

IoT Devices will be located in a wide variety of environments. It is a basic assumption that in addition to the measures described in this specification, these IoT Devices will have adequate security measures applied in order to provide whatever protection is required to satisfy the security policy for the use-case.
Descriptions of these additional measures are out of scope of this specification.

2.6.3 TLS Requirements

TLS v1.2 as defined in RFC 5246 [8] SHALL be the minimal version for any TLS connection in this specification.

DTLS v1.2 as defined in RFC 6347 [10] SHALL be the minimal version for any DTLS connection in this specification.

2.6.3.1 TLS Requirements for communication to the RSP Servers

For communication with SM-DP+ and SM-DS, all the TLS requirements defined in section 2.6.6 and 6.1 (and its subsections) of SGP.22 [4] SHALL apply, where the IPA plays the role of the LPA. In addition, the following requirements apply:

-TLS with server authentication SHALL be used over ES9+’ (eIM with SM-DP+), and ES11’ (eIM with SM-DS).

NOTE: Here the eIM is playing the role of the LPA.

-TLS with mutual authentication MAY be used over ES2+. If TLS with mutual authentication is not used over ES2+, ES2+ SHALL be protected with level of security equivalent to TLS.

2.6.3.2 TLS/DTLS Requirements for communication to the eIM

NOTE: The following TLS/DTLS requirements for communication with the eIM applies to section 3.1.2.1 and 3.1.2.2.

TLS v1.3 as defined in RFC8446 [9] and DTLS v1.3 as defined in RFC 9147 [11] MAY be supported for the communication over ESipa (IPA with eIM).

TLS with server authentication SHALL be used. The client (e.g., IPA) either directly trusts the server (i.e., eIM) Certificate or public key, or trusts the CA to which the server Certificate chains back or trusts an intermediate CA along the path.

The following elliptic curve(s) SHALL be supported:

-NIST P-256 with the namedCurve secp256r1 (23) as defined in RFC 8422 [15]

The following elliptic curves MAY be supported:

-brainpoolP256r1(26) as defined in RFC 7027 [16],

-NIST P-384 with the namedCurve secp384r1 (24) as defined in RFC 8422 [15],

-Ed25519 as defined in RFC 8410 [18], and x25519 with the namedCurve x25519 (29) as defined in RFC 8422 [15]

The following cipher suites SHALL be supported:

-For (D)TLS 1.2

-TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 as defined in RFC 5289 [17]

-TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 as defined in RFC 5289 [17]

-For (D)TLS 1.3

-TLS_AES_128_GCM_SHA256 as defined in TLS 1.3 (RFC 8446 [9])

-TLS_AES_256_GCM_SHA384 as defined in TLS 1.3 (RFC 8446 [9])

The following cipher suites MAY be supported:

-For (D)TLS 1.2

-TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 as defined in RFC 5289 [17]

-For (D)TLS 1.3

-TLS_CHACHA20_POLY1305_SHA256 as defined in TLS 1.3 (RFC 8446 [9])

2.6.4 eIM Keys and eIM Certificates

2.6.4.1 eIM Keys and eIM Certificates Naming Conventions

The eIM keys and eIM Certificates used in this specification are named according to the conventions described in this section.

The general name structure is: <XX>. <YY>. <ZZ>

Where:

-<XX> designates the nature of the element, the following values are defined:

-PK: the public key of an asymmetric key pair

-SK: the private key of an asymmetric key pair

-CERT: a Certificate containing a public key

-<YY> designates the owner of the element, the following values are defined:

-EIM: an eIM

-<ZZ> designates the usage of the element, the following values are defined:

-ECDSA: for a digital signature

-TLS: for TLS connection establishment

-DTLS: for DTLS connection establishment

Examples:

-PK.EIM.ECDSA: Public key of an eIM, used to verify an eIM signature.

-CERT.EIM.TLS: Certificate of the eIM, used to establish TLS connection.

2.6.4.2 Algorithms and Parameters for eIM Signing Key

This section provides the values to be set in 'AlgorithmIdentifier.algorithm' and 'AlgorithmIdentifier.parameters' fields of the eIM signing key for each of the algorithms used in this specification.

For section 'subjectPublicKeyInfo' the following settings SHALL apply:

'AlgorithmIdentifier.algorithm' field SHALL be set to: "iso (1) member-body (2) us (840) ansi-X9-62(10045) keyType (2) ecPublicKey (1)" as defined in RFC 5480 [27], or

'AlgorithmIdentifier.parameters' field SHALL be set to:

-for BrainpoolP256r1: "iso (1) identified-organization (3) teletrust (36) algorithm (3) signatureAlgorithm (3) ecSign (2) ecStdCurvesAndGeneration (8) ellipticCurve (1) versionOne (1) brainpoolP256r1 (7)" as defined in RFC 5639 [24]

-for NIST P-256: "iso (1) member-body (2) us (840) ansi-X9-62 (10045) curves (3) prime (1) prime256v1(7)" as defined in RFC 5480 [27]

2.6.4.3 eIM Signing Certificate (CERT.EIM.ECDSA)

This specification supports X.509 certificate format as defined in RFC 5280 [25].

The table below describes the common fields that a CERT.EIM.ECDSA SHALL contain.

Certificate common fields

Field

Value Description

tbsCertificate

Data to be signed

Field

Value Description

version

Version SHALL be 3.

serialNumber

Certificate serial number.

signature

Contains the algorithm identifier used to compute the value of the field 'signatureValue'.

NOTE: The algorithm identifier value SHALL be the same as the one of the field 'signatureAlgorithm'.

issuer

Distinguished Name of the entity that has signed the certificate.

validity

Validity period of the eIM Certificate.

subject

Distinguished Name of the entity owning the certificate. The following DN components SHALL be used:

CN=<eIMiD> -- mandatory

C=<country code> -- mandatory

O=<company> -- optional

OU=<organizational unit> -- optional

L=<locality> -- optional

subjectPublicKeyInfo

Contains the algorithm identifier, parameters, and public key value.

Algorithm identifier and parameters SHALL be set according to section 2.6.4.2

subjectPublicKeyInfo.subjectPublicKey contains the public key value and SHALL be coded as defined in RFC 5480 [27].

Extension for Authority Key Identifier (RFC 5280 [17] section 4.2.1.1)

extnID = id-ce-authorityKeyIdentifier
critical = false
extnValue = <Identifier of the public key to verify this certificate>

To identify the CA public key that has to be used to verify this certificate.

Extensions for Key Usage (RFC 5280 [17] section 4.2.1.3)

Extension for Key usage (RFC 5280 [25] section 4.2.1.3):
extnID = id-ce-keyUsage
critical = true
extnValue = digitalSignature (0)

Other extensions

CRL and OCSP SHOULD NOT be defined, since the eUICC will have no means to access those.

Policies SHOULD NOT be defined since they will increase the certificate size.

Subject Alternative Names SHOULD NOT be specified.

signatureAlgorithm

Section 2.6.4.2

signatureValue

Signature computed accordingly to one of the possible algorithms listed in section 2.6.4.2

2.: eIM Certificate fields

2.7 Certificate Management

2.7.1 RSP Server Certificates

The RSP Server Certificate management and verification SHALL follow what is specified in SGP.22 [4].

2.7.2 eUICC/EUM Certificates

The RSP Certificate revocation management as defined in SGP.22 [4] does not apply to the eUICC. Therefore, the revocation management is not supported by the eUICC and the IPA or eIM SHALL NOT pass any revocation information (CRL, OCSP) to the eUICC.

The eUICC Certificates (i.e., CERT.EUICC.ECDSA) according to SGP.22 [4] SHALL be used.

2.7.3 eIM Certificates

The following Certificates MAY be supported, and MAY be revoked at any time:

-eIM Certificate for signing eUICC Packages (if any)

-eIM DTLS/TLS Certificate (if any)

The issuance, verification and revocation of eIM Certificates for signing eUICC Packages are implementation specific and out of scope of this specification.

If an eIM utilizes DTLS/TLS for ESipa protection, the eIM SHALL use a Certificate or Public Key. The eIM DTLS/TLS Certificate (if any) or the CA that issues the eIM DTLS/TLS Certificate SHALL be trusted by the IPA. This CA MAY be public or private. In case of TLS, there SHALL be means for the IPAd to check the revocation status of this Certificate either through CRL or OCSP [21] made available by the issuing CA. The eIM MAY provide OCSP stapling. In case of DTLS, revocation status SHALL NOT be checked.

NOTE: For constrained IoT Devices, a private CA allows for flexibility in configuring how many sub CA layers are utilized or in defining the CA lifecycle.

A Certificate listed in a CRL SHALL be considered as definitively revoked (i.e., the 'Hold' state is not considered).

2.8 Profile Policy Management

Profile Policy Management provides mechanisms by which Profile Owners can enforce the conditions of use under which services are provided. Please refer to section 2.9 of SGP.22 [4] for details on this.

2.9 Profile State Management

Profile State Management Operation is related to the state update of a Profile in a dedicated ISD-P on the eUICC (e.g.: enable Profile, disable Profile, delete Profile, list Profile information).

2.9.1 Profile State Management by the eIM

Profile State Management is performed by an eIM. For this purpose, the eIM SHALL prepare a signed eUICC Package. For Profile State Management, an eUICC Package contains one or more PSMOs.

The eUICC Package is provided from the eIM to the IPA via ESipa. IPA transfers the eUICC Package to the eUICC via ES10b. The eUICC verifies the signature of the eUICC Package and, upon successful verification, executes the eUICC Package and generates a signed eUICC Package Result. The eUICC Package Result is provided to the IPA that provides it to the eIM. The eIM verifies the signature of the eUICC Package Result before processing the execution result of the eUICC Package.

All the procedure of Profile State Management by the eIM are described in section 3.4.

2.9.2 Automatic Profile enabling of an IPA initiated Profile download from Default SM-DP+

The IPA MAY initiate a Profile download request towards the eUICC by instructing the use of the default SM-DP+. Subsequent to successful download and installation, the IPA MAY also request the eUICC to enable this newly downloaded Profile. The eUICC MAY be configured to support the automatic enabling by:

-EUMs during eUICC manufacturing,

-An Associated eIM via PSMO, or

-IPA via ES10b only if there is no Associated eIM.

If automatic enabling is not configured within the eUICC, the request for automatic Profile enabling SHALL be rejected.

An eUICC configured to support the automatic enabling and requested by IPA to automatically enable a particular Profile, SHALL verify that the OID and FQDN of the SM-DP+ from where the Profile is downloaded match to the default SM-DP+ data (OID and FQDN) stored in the eUICC (see section 3.2.3.1). The storage of the default SM-DP+ data MAY be performed according to the following options:

-during eUICC manufacturing,

-by an Associated eIM, or

-the IPA only if there is no Associated eIM.

NOTE: SM-DS triggered Profile download and automatic enabling without signed PSMO from any potentially Associated eIM is not specified in this version of the specification.

2.10 eIM Configuration

In order to perform Profile State Management Operation on a given eUICC, an eIM SHALL be associated with this eUICC. For every Associated eIM the eUICC stores the eIM Configuration Data (see section 2.11.2.1.1) that is used by the eUICC for verification of signed PSMOs and Signed eIM Configuration Operations as part of eUICC Package(s).

eIM Configuration Operations MAY be performed at different stages within the eUICC or IoT Device life cycle as described in SGP.31 [1].

NOTE: Annex B of SGP.31 [1] describes the different eIM Configuration scenarios.

2.10.1 eIM Configuration by eIM

If an eUICC has an Associated eIM, only Signed eIM Configuration SHALL be accepted by the eUICC after successful verification of the signature of the Associated eIM. Any Unsigned eCO SHALL be rejected by the eUICC.

When an eUICC has one or more Associated eIMs, a signed eUICC Package SHALL be prepared by one of the Associated eIM to make changes to the eIM Configuration Data of the eUICC. The signed eUICC Package SHALL be transferred from the eIM to the IPAd via ESipa (see also Annex B.5 of SGP.31 [1]) and further to the eUICC where it will be processed. The details are described in section 3.5.1.

The signed eUICC Package contains one or more eIM Configuration Operations. The following eIM Configuration Operations MAY be supported by the eIM and SHALL be supported by the eUICC:

-addEim: Adds an Associated eIM to the eUICC by providing its eIM Configuration Data including the eimID to the eUICC.

-deleteEim: Deletes an Associated eIM identified by its eimID from the eUICC. If the successfully deleted Associated eIM was the last available Associated eIM, the eUICC SHALL allow ES10b.AddInitialEim again.

-updateEim: Updates eIM Configuration Data, i.e., the public key or Certificate and the related anti-replay counter value of an Associated eIM with a given eimID within the eUICC while keeping the same eimID.

-listEim: Requests the eUICC to provide a list of all currently configured Associated eIMs to the eIM.

NOTE: Replacing an existing Associated eIM with a new Associated eIM could be realized by first adding a new Associated eIM and then deleting the existing Associated eIM.

NOTE: How the eIM triggers the IPA is out of scope of this specification.

2.10.2 eIM configuration by IPA

If an eUICC does not have an Associated eIM, the eUICC SHALL accept Unsigned eCO.

To enable Unsigned eCO, the IPAd MAY and the eUICC SHALL support the following function:

-ES10b.AddInitialEim: Adds eIM Configuration Data of a particular eIM with a given eimID to an eUICC that does not yet contain any Associated eIM.

NOTE: Mechanisms and functions used for Unsigned eCO at eUICC production (see Annex B.1 of SGP.31 [1]) are out of scope of this specification.

In addition, the eUICC and the IPAd MAY support ES10b.eUICCMemoryReset to completely remove all eIM Configuration Data of all Associated eIMs from the eUICC.

NOTE: The security of this mechanism is left to the implementation as described in SGP.31 [1].

2.11 eIM Package Structures

This section describes the structure of eIM Package requests and responses that comprise:

-Signed eUICC Package and its execution result.

-IPA and/or eUICC data

-Profile Download trigger

-List of Notifications

-Acknowledgements of eUICC Package Results and Notifications

2.11.1 eIM Package Request

The eIM Package request contains either:

-an EuiccPackageRequest,

-an IpaEuiccDataRequest,

-a ProfileDownloadTrigger, or

-an EimAcknowledgements

data object.

2.11.1.1 EuiccPackageRequest

The signed eUICC Package structure SHALL be encoded in the ASN.1 data object as shown below.

ASN.1 definitions
-- ASN1START

EuiccPackageRequest ::= [81] SEQUENCE { -- Tag ' BF51', #SupportedForPsmoV1.0.0#

euiccPackageSigned EuiccPackageSigned,

eimSignature [APPLICATION 55] OCTET STRING -- Tag '5F37'

}

EuiccPackageSigned ::= SEQUENCE {

eimId [0] UTF8String,

eidValue [APPLICATION 26] Octet16, -- Tag '5A'

counterValue [1] INTEGER,

transactionId [2] TransactionId OPTIONAL,

euiccPackage EuiccPackage

}

EuiccPackage ::= CHOICE {

psmoList SEQUENCE OF Psmo, -- #SupportedForPsmoV1.0.0#

ecoList SEQUENCE OF Eco -- #SupportedForEcoV1.0.0#

}

-- ASN1STOP

The euiccPackageSigned includes:

-eIM identifier (eimId) : identifier of the eIM that issues the eUICC Package. See section 4.3.

-EID (eidValue) of the targeted eUICC.

-Counter value (counterValue) used by the eIM for replay protection. Each eIM manages its own counter. The eIM increments its counterValue by 1 for each eUICC Package being sent to the target eUICC. The eUICC implementation SHALL be able to handle counter values at least up to value of 8388607 (0x7FFFFF), included.

-Optional Transaction ID (transactionId, see [4]).

-eUICC Package (euiccPackage) consisting of either PSMOs or eCOs.

The eIM SHALL sign the euiccPackageSigned data object concatenated with the associationToken data object (retrieved from the eIM Configuration Data) to create the eimSignature. If no association token is configured in the eIM Configuration Data, the associationToken data object SHALL be used with the value set to zero (i.e., '84 01 00') for creating the signature.

The eUICC returns the same eimId, transactionId and counterValue in the eUICC Package Result, which allows the eIM to link a received eUICC Package Result to a sent eUICC Package.

2.11.1.1.1 eIM Configuration Data

The eIM Configuration Data stored by the eUICC for each Associated eIM consists of:

-eimId: uniquely identifies the Associated eIM within the eUICC. See section 4.3.

-eimFqdn: Identifier of the eIM that issues the eUICC Package encoded as a FQDN.

-eimIdType: For more information regarding eIM identifier types (EimIdType) see section 4.3.

-counterValue: used to protect against replay of eUICC Packages sent by the eIM. The highest received counterValue per Associated eIM is stored within the eUICC. The eUICC implementation SHALL be able to handle counter values at least up to value of 8388607 (0x7FFFFF), included. The eUICC SHALL return the error code counterValueOutOfRange in case the counterValue exceeds the maximum value supported by the eUICC.

-associationToken: optional, for replay protection. The association token is the value of one global counter on each eUICC, which SHALL start at zero and SHALL be incremented to generate the next association token each time an association token is requested (i.e., the first association token will be 1). It SHALL NOT be possible to reset the counter by any mechanism (e.g., eUICC Memory Reset).

NOTE: The association token can protect against an attack scenario where a whole sequence of operations beginning with AddInitialEim is replayed after a reset of the eIM Configuration Data. It is optional to configure this mechanism for an eIM.

-eimPublicKeyData: eIM public key data either as a raw public key (eimPublicKey) or as a Certificate (eimCertificate) , used for eUICC Package verification.

-trustedPublicKeyDataTls: either eIM public key (trustedEimPkTls) or a Certificate (trustedCertificateTls) used for TLS/DTLS. The trustedCertificateTls is a certificate that is trusted in the chain of certificates ending with the eIM certificate (leaf certificate). This certificate MAY be the certificate of the eIM itself, or the certificate of the root CA or the certificate of a trusted intermediate CA. This certificate SHALL contain the SubjectKeyIdentifier extension. A root CA or intermediate CA certificate SHALL include the BasicConstraints extension with the value of “cA” set to TRUE[25]. The IPAd MAY ignore this field.

-eimSupportedProtocol: For more information regarding eIM protocol support (EimSupportedProtocol) see section 4.2.

-euiccCiPKId: CI Public Key Identier allowing to select the eUICC Certificate for signing eUICC Package Results returned to this eIM. If not provided, the first entry of euiccCiPKIdListForSigning in eUICCInfo2 SHALL be used as euiccCiPKId..

NOTE: trustedCertificateTls data object is needed if the IoT Device uses the IPAe and the eIM Package transfer use eimRetrieveHttps or eimRetrieveCoaps. This will allow to avoid any potential failure of the TLS/DTLS session.

When adding, updating, or retrieving eIM Configuration Data for a particular eIM from the eUICC the following ASN.1 data object is used, where the optionality of certain fields is described below:

ASN.1 definitions
-- ASN1START

EimConfigurationData ::= SEQUENCE {

eimId [0] UTF8String, -- eimId of eIM

eimFqdn [1] UTF8String OPTIONAL, -- FQDN of eIM

eimIdType [2] EimIdType OPTIONAL,

counterValue [3] INTEGER OPTIONAL, -- initial counterValue for the eIM

associationToken [4] INTEGER OPTIONAL,

eimPublicKeyData [5] CHOICE {

eimPublicKey SubjectPublicKeyInfo, -- public key of eIM, used for eUICC Package signature verification, where the encoding follows X.509 standard

eimCertificate Certificate -- certificate of eIM, used for eUICC Package signature verification, where the encoding follows X.509 standard

} OPTIONAL,

trustedPublicKeyDataTls [6] CHOICE {

     trustedEimPkTls SubjectPublicKeyInfo, -- public key of eIM, used for TLS or DTLS, where the encoding follows X.509 standard

     trustedCertificateTls Certificate -- either the certificate of eIM, used for (D)TLS, or the certificate of the CA, where the encoding follows X.509 standard

   } OPTIONAL,

eimSupportedProtocol [7] EimSupportedProtocol OPTIONAL,

euiccCiPKId [8] SubjectKeyIdentifier OPTIONAL -- CI Public Key Identifier supported on the eUICC for signature creation

}

EimIdType ::= INTEGER {

eimIdTypeOid(1),

eimIdTypeFqdn(2),

eimIdTypeProprietary(3)

}

EimSupportedProtocol ::= BIT STRING {

eimRetrieveHttps(0),

eimRetrieveCoaps(1),

eimInjectHttps(2),

eimInjectCoaps(3),

eimProprietary(4)

}

-- ASN1STOP

2.11.1.1.2 eUICC Package Request Containing eCOs

The eCOs within the eUICC Package request SHALL be encoded in the ASN.1 data object as shown below.

ASN.1 definitions
-- ASN1START

Eco ::= CHOICE {

addEim [8] EimConfigurationData, -- for eIM configuration data see 2.11.1

deleteEim [9] SEQUENCE {eimId [0] UTF8String},

updateEim [10] EimConfigurationData,

listEim [11] SEQUENCE {}

}

-- ASN1STOP

If the eCO is the addition of an Associated eIM (addEim), then eimId, counterValue and eimPublicKeyData SHALL be provided as part of the EimConfigurationData data object.

The trustedPublicKeyDataTls is optional in EimConfigurationData data object. It SHOULD be provided in addEim if the IpaMode in eUICCInfo2 is ipae, and if the eimSupportedProtocol contains eimRetrieveHttps or eimRetrieveCoaps.

The eimFqdn is optional for the eIM to provide in EimConfigurationData data object. It SHALL NOT be provided if eimIdTypeFqdn is present in that EimConfigurationData data object, to avoid redundancy with eimId.

The eimIdType is optional for the eIM to provide in EimConfigurationData data object. If not provided, the eUICC SHALL assign the value eimIdTypeProprietary before storing the eIM Configuration Data.If the eUICC is requested to calculate an association token for the new Associated eIM, the associationToken data object SHALL be provided with the value set to -1. Otherwise, the data object SHALL NOT be provided.

The eimSupportedProtocol is optional for the eIM to provide in EimConfigurationData data object. If not provided, the eUICC SHALL assign the value where only the eimProprietary bit is set before storing the eIM Configuration Data.

The euiccCiPKId is optional for the eIM to provide in EimConfigurationData. If not provided, the eUICC SHALL assign the value of first entry of euiccCiPKIdListForSigning in eUICCInfo2 before storing the eIM Configuration Data.

If the eCO is the update of the configuration of an Associated eIM (updateEim), then eimId of the target Associated eIM and at least one of either counterValue, eimPublicKeyData, eimIdType, eimFqdn, eimSupportedProtocol or euiccCiPKId SHALL be provided as part of the EimConfigurationData data object. The associationToken data object SHALL NOT be provided.

NOTE: It is not possible to update eimId.

Updating counterValue to a lower value without also updating eimPublicKeyData SHALL NOT be permitted.

If the eCO is the deletion of an Associated eIM (deleteEim), then only the eimId of the target Associated eIM SHALL be provided.

2.11.1.1.3 eUICC Package Request Containing PSMOs

The PSMOs within the eUICC Package request SHALL be encoded in the ASN.1 data object as shown below.

ASN.1 definitions
-- ASN1START

Psmo ::= CHOICE {

enable [3] SEQUENCE {

iccid [APPLICATION 26] Iccid,

rollbackFlag NULL OPTIONAL

},

disable [4] SEQUENCE {iccid [APPLICATION 26] Iccid},

delete [5] SEQUENCE {iccid [APPLICATION 26] Iccid},

listProfileInfo [45] ProfileInfoListRequest, -- Tag 'BF2D'

getRAT [6] SEQUENCE {},

configureAutoEnable [7] SEQUENCE {

autoEnableFlag [0] NULL OPTIONAL,

smdpOid [1] OBJECT IDENTIFIER OPTIONAL,

smdpAddress [2] UTF8String OPTIONAL

}

}

-- ASN1STOP

The iccid indicates the Target Profile at the eUICC as defined in SGP.22 [4].

The rollbackFlag is presented by the eIM within the enable PSMO. The IPA MAY trigger the Rollback Mechanism using the ES10b.ProfileRollback function if the newly enabled Profile fails to provide connectivity.

The listProfileInfo SHALL be coded and processed as defined in SGP.22 [4] section 5.7.15.

Automatic Profile enabling is activated when autoEnableFlag is present in the configureAutoEnable command and deactivated when autoEnableFlag is not present. The configuration of automatic enabling data (smdpOid and smdpAddress for default SM-DP+) for use in the automatic Profile enabling is possible independently of the whether autoEnableFlag is present or not.

At most one enable command SHALL occur in an eUICC Package.

At most one disable command SHALL occur in an eUICC Package.

A listProfileInfo command SHALL NOT occur after an enable, disable or delete command in an eUICC Package. If this situation occurs the response SHALL indicate the error profileChangeOngoing.

2.11.1.2 IpaEuiccDataRequest

The IpaEuiccDataRequest is used by the eIM to retrieve data from eUICC and/or IPA. It SHALL be encoded as follows:

ASN.1 definitions
-- ASN1START

IpaEuiccDataRequest ::= [82] SEQUENCE { -- Tag BF52

tagList [APPLICATION 28] OCTET STRING, -- Tag '5C'

euiccCiPKId SubjectKeyIdentifier OPTIONAL, -- CI Public Key Identifier supported on the eUICC for signature creation

searchCriteria [1] CHOICE {

seqNumber [0] INTEGER,

profileManagementOperation [1] NotificationEvent,

euiccPackageResults [2] NULL

} OPTIONAL

}

-- ASN1STOP

The eIM MAY request one or more IPA and eUICC data items by listing each tag of a requested item in the tagList of IpaEuiccDataRequest. The following IPA and eUICC data and tags are defined:

-Default SM-DP+ address (see SGP.22 [4]), tag '80’.

-eUICCInfo1 (see section 5.9.2 of this specification), tag 'BF20'.

-eUICCInfo2 (see section 5.9.2 of this specification), tag 'BF22'.

-Root SM-DS address (see SGP.22 [4]), tag '83'.

-Association token (see sections 2.11.1 and 5.9.18 of this specification), tag '84'.

-EUM certificate (see SGP.22 [4]), tag 'A5'.

-eUICC certificate (see SGP.22 [4]), tag 'A6'.

-IPA Capabilities (see section 4.1), tag '88'.

-Device Information (see SGP.22 [4] section 4.2), tag 'A9'.

-List of Notifications and/or eUICC Package Results (see section 5.9.11 of this specification), tag 'BF2B’.

In order to select between multiple of EUM certificates and eUICC certificates within the eUICC the eIM MAY provide the CI Public Key Identifier (euiccCiPKId). If euiccCiPKId is not provided, the first entry of euiccCiPKIdListForSigning in eUICCInfo2 SHALL be used as euiccCiPKId when selecting the EUM certificate and/or eUICC certificate to return.

The searchCriteria data object can be used to filter the list of Notifications and/or eUICC Package Results that SHALL be returned by the IPA and eUICC as defined in section 5.9.11.

IPA uses the following functions to obtain eUICC data: ES10b.GetEUICCInfo (see section 5.9.2), ES10b.GetCerts (see section 5.9.10), ES10b.GetEID (see section 5.9.19), ES10b. RetrieveNotificationsList (see section 5.9.11), ES10a.GetEuiccConfiguredAddresses (see section 5.8.1) and ES10b.GetEimConfigurationData (see section 5.9.18). IPA SHALL support providing at least the association token and the IPA Capabilities to the eIM. The rest of the IPA and eUICC data are not mandatory to support by IPA but depends on the IPA Capabilities. If a particular IPA or eUICC data is not supported by IPA it is simply ignored by IPA when building the IpaEuiccDataResponse structure (see section 2.11.2.2). Depending on IPA Capabilities the IPA SHALL support the following:

-An IPA having IPA Capability eimCtxParams1Generation SHALL support providing deviceInfo to the eIM.

-An IPA having IPA Capability minimizeEsipaBytes SHALL support providing euiccInfo1, euiccInfo2, eumCertificate, and euiccCertificate to the eIM.

2.11.1.3 ProfileDownloadTriggerRequest

The ProfileDownloadTriggerRequest SHALL be encoded as follows:

ASN.1 definitions
-- ASN1START

ProfileDownloadTriggerRequest ::= [84] SEQUENCE { -- Tag 'BF54'

profileDownloadData [0] ProfileDownloadData OPTIONAL,

eimTransactionId [2] TransactionId OPTIONAL

}

ProfileDownloadData ::= CHOICE {

activationCode [0] UTF8String (SIZE(0..255)),

contactDefaultSmdp [1] NULL,

contactSmds [2] SEQUENCE {

smdsAddress UTF8String OPTIONAL

}

}

-- ASN1STOP

The eIM SHALL provide ProfileDownloadTriggerRequest data object as follows.

-If and only if the IPA indicates eimDownloadDataHandling in IPA Capabilities and the eIM requests the IPA to call ESipa.InitiateAuthentication function, an empty data object is provided (i.e., without profileDownloadData). The IPA continues with the indirect Profile download or Event Retrieval procedure.

-Otherwise profileDownloadData is provided, containing one of the following:

-activationCode, if the eIM provides an Activation Code.

-contactDefaultSmdp, if the eIM requests the IPA to contact the default SM‑DP+ address that is available in the IoT Device.

-contactSmds, if the eIM requests the IPA to contact the SM‑DS address that is available in the IoT Device (smdsAddress is absent) or specified by the eIM (smdsAddress is present). This triggers the retrieval of the SM-DP+ Address and EventID from the SM-DS, either over ES11 as defined in section 3.6.2 of SGP.22 [4] or over ESipa and ES11’ as defined in section 3.9.2.2 of this document.

For each use case the IPA continues with the corresponding direct/indirect Profile download or Event Retrieval procedure depending on its capability.

The eIM transaction identifier (eimTransactionId) is OPTIONAL for the eIM to include in the ProfileDownloadTriggerRequest. It MAY be used for linking a ProfileDownloadTriggerRequest to a ProfileInstallationResult in a direct Profile download scenario.

2.11.1.4 EimAcknowledgements

The EimAcknowledgements structure is sent from the eIM to the IPA to inform the IPA that the eIM successfully received Notifications and/or eUICC Package Results sent from the IPA to the eIM. The structure contains the sequence number(s) of received Notifications and/or eUICC Package Results and is defined as follows:

ASN.1 definitions
-- ASN1START

EimAcknowledgements ::= [83] SEQUENCE OF SequenceNumber -- Tag BF53

SequenceNumber ::= [0] INTEGER

-- ASN1STOP

2.11.2 eIM Package Result

The eIM Package Result contains either:

-an EuiccPackageResult,

-an EuiccPackageResult concatenated with a RetrieveNotificationsListResponse (see SGP.22 [4]) or

-IpaEuiccDataResponse

data object.

2.11.2.1 EuiccPackageResult

Before processing the PSMOs or the eCOs in the eUICC Package, the eUICC verifies the signed eUICC Package as defined in sections 3.3 and 5.9.1.

Upon successful verification of the signed eUICC Package, the PSMOs or eCOs in the eUICC Package are executed sequentially by the eUICC until the end is reached or an error is encountered for a PSMO or an eCO. Upon finishing the execution of the signed eUICC Package, the eUICC produces a signed eUICC Package Result (euiccPackageResultSigned) containing the PSMO or eCO execution result(s).

A signed eUICC Package Result with PSMO or eCO processing result(s) (euiccPackageResultSigned) SHALL be kept by the eUICC (which can hold one or several such signed eUICC Package Result) until explicitly deleted by the IPA, after successful delivery to the eIM. Before being deleted, the signed eUICC Package Result(s) MAY be retrieved at any time by the IPA. The unsigned and signed eUICC Package error results generated from eUICC Package verification errors (euiccPackageErrorUnsigned and euiccPackageErrorSigned) are not kept by the eUICC.

When the eUICC needs to store a new signed eUICC Package Result with PSMO or eCO processing result(s) and if there is not enough space, the eUICC SHALL delete one or more of the previously stored signed eUICC Package Results in order of their sequence number, beginning with the lowest.

The eUICC Package Result SHALL be encoded in the ASN.1 data object as shown below.

ASN.1 definitions
-- ASN1START

EuiccPackageResult ::= [81] CHOICE { -- Tag 'BF51' #SupportedForPsmoV1.0.0#

euiccPackageResultSigned EuiccPackageResultSigned,

euiccPackageErrorSigned EuiccPackageErrorSigned,

euiccPackageErrorUnsigned EuiccPackageErrorUnsigned

}

EuiccPackageResultSigned ::= SEQUENCE {

euiccPackageResultDataSigned EuiccPackageResultDataSigned,

euiccSignEPR [APPLICATION 55] OCTET STRING -- Tag '5F37'

}

EuiccPackageResultDataSigned ::= SEQUENCE { -- #SupportedForPsmoV1.0.0#

eimId [0] UTF8String,

counterValue [1] INTEGER,

transactionId[2] TransactionId OPTIONAL,

seqNumber [3] INTEGER,

euiccResult SEQUENCE OF EuiccResultData

}

EuiccResultData ::= CHOICE {

enableResult [3] EnableProfileResult,

disableResult [4] DisableProfileResult,

deleteResult [5] DeleteProfileResult,

listProfileInfoResult [45] ProfileInfoListResponse,

getRATResult [6] RulesAuthorisationTable, -- see SGP.22

configureAutoEnableResult [7] ConfigureAutoEnableResult,

addEimResult [8] AddEimResult,

deleteEimResult [9] DeleteEimResult,

updateEimResult [10] UpdateEimResult,

listEimResult [11] ListEimResult,

rollbackResult [12] RollbackProfileResult,

processingTerminated INTEGER {

resultSizeOverflow(1),

unknownOrDamagedCommand(2),

interruption(3),

undefinedError(127)

}

}

EuiccPackageErrorSigned ::= SEQUENCE {

euiccPackageErrorDataSigned EuiccPackageErrorDataSigned,

euiccSignEPE [APPLICATION 55] OCTET STRING -- Tag '5F37'

}

EuiccPackageErrorDataSigned ::= SEQUENCE {

eimId [0] UTF8String,

counterValue [1] INTEGER,

transactionId [2] TransactionId OPTIONAL,

euiccPackageErrorCode EuiccPackageErrorCode

}

EuiccPackageErrorCode ::= INTEGER { invalidEid(3), replayError(4),

counterValueOutOfRange(6), sizeOverflow(15), undefinedError(127)}

EuiccPackageErrorUnsigned ::= SEQUENCE {

eimId [0] UTF8String,

associationToken [4] INTEGER OPTIONAL

}

ConfigureAutoEnableResult ::= INTEGER {

ok(0),

insufficientMemory(1),

commandError(7),

undefinedError(127)

}

EnableProfileResult ::= INTEGER {

ok(0),

iccidOrAidNotFound(1),

profileNotInDisabledState(2),

undefinedError(127)

}

DisableProfileResult ::= INTEGER {

ok(0),

iccidOrAidNotFound(1),

profileNotInEnabledState(2),

undefinedError(127)

}

DeleteProfileResult ::= INTEGER {

ok(0),

iccidOrAidNotFound(1),

profileNotInDisabledState(2),

undefinedError(127)

}

ProfileInfoListResponse ::= [45] CHOICE {

profileInfoListOk SEQUENCE OF ProfileInfo, -- see SGP.22

profileInfoListError ProfileInfoListError

}

ProfileInfoListError ::= INTEGER {

incorrectInputValues(1),

profileChangeOngoing (11),

undefinedError(127)

}

RollbackProfileResult ::= INTEGER {

ok(0),

undefinedError(127)

}

AddEimResult ::= CHOICE {

associationToken [4] INTEGER,

addEimResultCode INTEGER {

ok(0),

insufficientMemory(1),

ciPKUnknown(3),

invalidAssociationToken(5),

counterValueOutOfRange(6),

commandError(7),

undefinedError(127)

}

}

DeleteEimResult ::= INTEGER {

ok(0),

eimNotFound(1),

lastEimDeleted(2), -- no eIM Configuration Data available in eUICC,

commandError(7),

undefinedError(127)

}

UpdateEimResult ::= INTEGER {

ok(0),

eimNotFound (1),

ciPKUnknown(3),

counterValueOutOfRange(6),

commandError(7),

undefinedError(127)

}

ListEimResult ::= CHOICE {

eimIdList SEQUENCE OF EimIdInfo,

listEimError INTEGER {

commandError(7),

undefinedError(127)

}

}

EimIdInfo ::= SEQUENCE {

eimId [0] UTF8String,

eimIdType [4] EimIdType OPTIONAL -- present in case of eimIdTypeOid and eimIdTypeFqdn

}

-- ASN1STOP

The transaction identifier (transactionId) is OPTIONAL to use by the eIM in the signed eUICC Package. If it was included in the signed eUICC Package, the eUICC SHALL include the same transactionId in the signed eUICC Package Result.

euiccSignEPR and euiccSignEPE SHALL be created using the SK.EUICC.ECDSA and verified using the related PK.EUICC.ECDSA. In case there are more than one SK.EUICC.ECDSA available for signing, the SK.EUICC.ECDSA chaining back to the CI public key identified by the euiccCiPKId of the eIM Configuration Data (of the Associated eIM for which the eUICC Package Result is intended) SHALL be used. euiccSignEPR SHALL apply on the concatenated data objects euiccPackageResultDataSigned and eimSignature. euiccSignEPE SHALL apply on the concatenated data objects euiccPackageErrorDataSigned and eimSignature.

The eIM SHALL use the PK.EUICC.ECDSA from CERT.EUICC.ECDSA to verify the signature euiccSignEPR and euiccSignEPE. The eIM SHALL verify CERT.EUICC.ECDSA.

2.11.2.2 IpaEuiccDataResponse

The IpaEuiccDataResponse SHALL be encoded as follows:

ASN.1 definitions
-- ASN1START

IpaEuiccDataResponse ::= [82] CHOICE { -- Tag 'BF52'

ipaEuiccData IpaEuiccData,

ipaEuiccDataError INTEGER {

incorrectTagList (1),

euiccCiPKIdNotFound(5),

undefinedError(127)

}

}

IpaEuiccData ::= SEQUENCE {

defaultSmdpAddress [0] UTF8String OPTIONAL, -- Tag '80'

euiccInfo1 [32] EUICCInfo1 OPTIONAL, -- Tag 'BF20'

euiccInfo2 [34] EUICCInfo2 OPTIONAL, -- Tag 'BF22'

rootSmdsAddress [3] UTF8String OPTIONAL, -- Tag '83'

associationToken [4] INTEGER OPTIONAL, -- Tag '84'

eumCertificate [5] Certificate OPTIONAL, -- Tag 'A5'

euiccCertificate [6] Certificate OPTIONAL, -- Tag 'A6'

ipaCapabilities [8] IpaCapabilities OPTIONAL, -- Tag '88'

deviceInfo [9] DeviceInfo OPTIONAL, -- Tag 'A9'

notificationsList [43] RetrieveNotificationsListResponse OPTIONAL -- Tag 'BF2B'.

}

-- ASN1STOP

If the associationToken is requested, but no association token is configured for the eIM, the associationToken data object SHALL be absent in the response.

An IPA with IPA Capability minimizeEsipaBytes SHOULD include each pending Notification in notificationsList in compact format as described in section 5.14.7.

2.11.2.3 ProfileDownloadTriggerResult

The ProfileDownloadTriggerResult SHALL be encoded as follows:

ASN.1 definitions
-- ASN1START

ProfileDownloadTriggerResult ::= [84] SEQUENCE { -- tag 'BF54'

eimTransactionId [2] TransactionId OPTIONAL,

profileDownloadTriggerResultData CHOICE {

profileInstallationResult [55] ProfileInstallationResult, -- see SGP.22 [4]

profileDownloadError SEQUENCE {

errorResponse OCTET STRING OPTIONAL

}

}

}

-- ASN1STOP

The IPA SHALL send ProfileDownloadTriggerResult to inform the eIM about the result of a direct Profile download that was requested by the eIM.

-If the eIM provided a transaction identifier (eimTransactionId) in ProfileDownloadTriggerRequest, the IPA SHALL return the same transaction identifier in ProfileDownloadTriggerResult. Otherwise, eimTransactionId SHALL NOT be present.

-If the IPA successfully downloaded a Profile and obtained a Profile Installation Result as a response of ES10b.LoadBoundProfilePackage function calls, the IPA SHALL return the Profile Installation Result in profileInstallationResult. Otherwise, the IPA SHALL return a profileDownloadError that MAY include an errorResponse..

-The errorResponse, if present, SHALL include the error response of an ES10b function or an ES9+ function with ASN.1 binding that the IPA encountered during the Profile download procedure.

NOTE: the errorResponse for an error response of an ES9+ function with JSON binding is FFS.

3 Procedures

This section specifies the procedures associated with eUICC for IoT Devices.

Some call flows illustrate the case where the IPA is in the Device (IPAd). Such call flows with an IPAe would be identical except that all ES10 calls become internal to the eUICC and out of scope of this specification.

3.1 eIM and IPA Communication

This section defines the procedures between the eIM and the IPA.

3.1.1 Transferring eIM Package

These procedures are used to transfer an eIM Package from the eIM to the IPA. It could be the IPA which retrieves any pending command from the eIM (section 3.1.1.1 eIM Package Retrieval), or the eIM which directly sends the command to the IPA (section 3.1.1.2 eIM Package Injection). The eIM SHALL support at least, one of these procedures. The IPA implementing ESipa SHALL support, at least, one of these procedures.

If ESipa is established between the eIM and the IPA, the eIM and IPA SHALL support the same mode (“eIM Package retrieval” or “eIM Package injection”) and use the same secure connection method (see section 3.1.2).

NOTE: An eIM intended to serve many different types of IoT Devices is recommended to support both procedures (“eIM Package Retrieval” and “eIM Package Injection”).

3.1.1.1 eIM Package Retrieval

This procedure is used by the IPA to retrieve any pending eIM Package from the eIM.

Diagram source (PlantUML)
@startuml

hide footbox

skinparam sequenceMessageAlign center

skinparam sequenceArrowFontSize 11

skinparam noteFontSize 11

skinparam monochrome true

skinparam lifelinestrategy solid

participant "<b>eIM" as EIM

participant "<b>IPA" as IPA

rnote over EIM, IPA : [1] [Secure connection establishment]

loop until ESipa.GetEimPackage response is noEimPackageAvailable

IPA -> EIM : [2] ESipa.GetEimPackage request (EID)

EIM -> EIM : [3] Fetch pending eIM Package(s) for the EID

EIM -> IPA : [4] ESipa.GetEimPackage response (eIM Package)

rnote over IPA : [5] [Process the eIM Package]

alt If the IPA needs acknowledgement of sending eIM Package Result

IPA -> EIM : [6] ESipa. ProvideEimPackageResult request (eIM Package Result, [Notification(s)])

EIM -> EIM : [7] Manage eIM Package queue

EIM -> IPA : [8] ESipa.ProvideEimPackageResult response (sequence numbers)

else Otherwise

IPA -> EIM : [9] ESipa.HandleNotifications (eIM Package Result)

EIM -> EIM : [10] Manage eIM Package queue

EIM -> IPA : [11] OK

end

end@enduml

[Application Description automatically generated with medium confidence]

5.  : eIM Package Retrieval

Start Conditions:

The IoT Device can trigger the IPA through an internal event (e.g., a timer expiration) without any knowledge about pending eIM Package. The IPA could also be informed, via a push Notification, about pending eIM Package in the eIM. For instance, the eIM or a backend system of the IoT Device maker can notify the IPA via out-of-band channel about pending eIM Package. The push Notification mechanism is out of scope of this document.

The IPA has the address (configured or retrieved using GetEimConfigurationData) of the Associated eIM.

Procedure:

  1. The eIM and IPA establish a secure connection as defined in section 3.1.2.

  2. The IPA calls ESipa.GetEimPackage function including EID.

  3. The eIM fetches pending eIM Package(s) for the EID.

  4. The eIM returns the eIM Package to the IPA.

  5. The IPA processes the eIM Package.

If the IPA sends eIM Package Result together with Notifications, or if the IPA needs acknowledgements of sending eIM Package Result and optionally Notifications, the procedure continues in step (6). Otherwise, the procedure continues in step (9).

  6. The IPA calls ESipa.ProvideEimPackageResult function including the eIM Package Result and optionally one or more Notifications.

  7. The eIM processes the eIM Package Result and manages the eIM Packages pending in the queue for the eUICC.

  8. The eIM acknowledges the reception of the eIM Package Result and optionally Notifications by returning the corresponding sequence numbers.

  9. The IPA calls ESipa.HandleNotification function comprising either the eIM Package Result or a Notification.

  10. The eIM processes the eIM Package Result and manages the eIM Packages pending in the queue for the eUICC.

  11. The eIM returns OK.

The IPA MAY repeat the above procedure until the eIM response is noEimPackageAvailable.

3.1.1.2 eIM Package Injection

This procedure is used by the eIM to inject eIM Package to the IPA.

Diagram source (PlantUML)
@startuml

hide footbox

skinparam sequenceMessageAlign center

skinparam sequenceArrowFontSize 11

skinparam noteFontSize 11

skinparam monochrome true

skinparam lifelinestrategy solid

participant "<b>eIM" as EIM

participant "<b>IPA" as IPA

rnote over EIM, IPA : [1] [Secure connection establishment]

EIM -> IPA : [2] ESipa.TransferEimPackage (eIM Package)

rnote over IPA : [3] [Process the eIM Package]

IPA -> EIM : [4] ESipa.TransferEimPackage response (Execution result)

@enduml

[C:\Users\gtrujillo\Desktop\eSIM Group\eSIMWG7\eSIMWG7#56\MicrosoftTeams-image.png]

6.: eIM Package Injection

Start Conditions:

The eIM and the IPA could be part of a whole system responsible of maintaining the communication between the eIM and the IPA.

Procedure:

1.The eIM and IPA establish a secure connection as defined in section 3.1.2.

NOTE: the hosting system (e.g.: device management system) allows the eIM to retrieve the EID of the IoT Device.

1.The eIM calls ESipa.TransferEimPackage function to the IPA comprising the eIM Package.

NOTE: It is implementation specific how this command is transferred from the eIM to the IPA using the underlying transport protocol. See examples in Annex B.

2.The IPA processes the eIM Package.

3.The IPA returns the eIM Package Result to the eIM.

3.1.2 Secure Connection Establishment

The present document does not mandate any protocol between the eIM and the IPA for conveying an eIM Package. However, the protocol SHALL provide at least the integrity and the confidentiality of messages.

This permits IoT Device deployments using any suitable protocol for the exchange of eIM Packages and the delivery of Bound Profile Packages.

If ESipa is providing the protocol to transport ESipa messages as shown in Figure 7, the following ones are suggested:

-HTTP over TCP with TLS security.

NOTE: This could be used by a UICD which is not an NCD.

-CoAP over UDP with DTLS security.

NOTE: This mode could be used by an NCD.

[Graphical user interface Description automatically generated with medium confidence]

7.: ESipa (eIM -- IPA)

If the IoT Device has already implemented an interface and protocol with an external entity (e.g., a server) that is used for other functions of the IoT Device as shown in Figure 8, this underlying interface and its protocol can be used to transport ESipa messages.

[Graphical user interface, application Description automatically generated]

8.ESipa (eIM -- IPA), using underlying protocol to transport ESipa messages

3.1.2.1 Secure Connection using HTTP over TCP

If HTTP/TLS (HTTPS) is used between the IPA and the eIM, the specification details in this section SHALL apply.

The HTTP/TLS (HTTPS) secure connection mode is used with server authentication. This means that only the eIM is authenticated by the IPA. If HTTPS is used, the TLS requirements defined in section 2.6.3.2 SHALL apply to the TLS session between IPA and eIM.

The ESipa functions requests and functions responses are sent over HTTPS. The interface binding over HTTP SHALL follow section 6.

NOTE: It is RECOMMENDED to use HTTP/TLS wherever TCP is available and working.

3.1.2.2 Secure Connection over CoAP

If CoAP with DTLS security is used between the IPA and the eIM, the specification details in this section SHALL apply.

The DTLS secure connection mode is used with server authentication. This means that only the eIM is authenticated by the IPA.

If CoAP is used, the DTLS requirements defined in section 2.6.3.2 SHALL apply to the DTLS session between IPA and eIM.

The ESipa functions requests and functions responses SHALL be sent over CoAP. The interface binding over CoAP SHALL follow section 6.

If DTLS 1.2 is used, IPA and eIM SHOULD use Connection ID (CID) as per RFC 9146 [14] to maintain the current DTLS association for better reliability.

If DTLS 1.2 is used, IPA SHOULD implement both and eIM SHOULD implement at least one of the following session resumption methods:

-The Session Identifiers as defined in RFC 5246 [8], or

-The Session Tickets as defined in RFC 5077 [20].

3.1.2.3 Secure Connection by underlying transport layer

This mode is used when the underlying transport layer supported by the IoT Device can transport ESipa messages.

ESipa messages SHALL be protected in terms of confidentiality, integrity, and authenticity.

This mode is not specified by this document. It’s out of scope how the ESipa messages are conveyed. Hence, the compatibility of the exchanges between the IPA and eIM is ultimately the responsibility of the integrator.

Annex B gives some deployments scenario using the underlying transport layer.

3.2 Profile Download and Installation

3.2.1 Profile Download Initiation

This procedure is identical to the Profile Download Initiation Procedure defined in section 3.1.1 of SGP.22 [4].

3.2.2 Common Mutual Authentication

This procedure is identical to Common Mutual Authentication Procedure defined in section 3.1.2 of SGP.22 [4]. It defines the mutual authentication procedure between the eUICC and the RSP Server.

3.2.3 Profile Download

3.2.3.1 Direct Profile Download

This section describes the Profile download and installation procedure where the IoT Device directly connects to the SM-DP+.

Diagram source (PlantUML)
@startuml

hide footbox

skinparam sequenceMessageAlign center

skinparam sequenceArrowFontSize 11

skinparam noteFontSize 11

skinparam monochrome true

skinparam lifelinestrategy solid

participant "<b>Operator" as OP

participant "<b>SM-DP+" as DP

participant "<b>eIM" as EIM

participant "<b>IPA" as IPA

participant "<b>eUICC" as E

group If option (a) and AC is available to eIM

rnote over EIM : [1] eIM parses the AC to retrieve SM-DP+ Address, Activation Code Token, [SM-DP+ OID]

end

group If IPA obtains a profile download trigger from eIM Package

alt IPA-initiated

rnote over EIM, IPA : [2a] eIM Package Retrieval Procedure including secure connection establishment (section 3.1.1.1)

else eIM-initiated

rnote over EIM, IPA : [2b] eIM Package Injection Procedure including secure connection establishment (section 3.1.1.2)

end

rnote over IPA : [3] IPA parses the eIM Package and obtains profile \ndownload trigger that contain AC, or SM-DP+ Address and EventID \nor instruction to use the Default SM-DP+ Address

end

group If option (a) and AC is available to IPA

rnote over IPA : [4] IPA parses AC to retrieve SM-DP+ Address, Activation Code Token, [SM-DP+ OID]

end

rnote over DP, E #FFFFFF

[5]

- Execution of common mutual authentication procedure as defined in section 3.1.2 of SGP.22 [4].

- If automatic Profile enabling is activated, the eUICC SHALL verify that the download is coming from the default SM-DP+ configured in the eUICC.

If the verification is successful the eUICC SHALL grant automatic enabling for this Profile.

endrnote

rnote over DP #FFFFFF

[6]

- Look for Profile download pending order

- Eligibility Check using Device Info, euiccInfo2

endrnote

Group Opt.

DP -> OP : [7] ES2+.HandleDownloadProgressInfo(...)

OP --> DP : OK

end

DP --> IPA : [error]

rnote over DP #FFFFFF

[8]

- Build Profile Metadata

- Check if download retry

- Build smdpSigned2 = {TransactionID,

Confirmation Code Required Flag, [bppEuiccOtpk]}

- Compute smdpSignature2 over smdpSigned2 and euiccSignature1

endrnote

DP -> IPA : [9] TransactionID, Profile Metadata, smdpSigned2, smdpSignature2, CERT.DPpb.ECDSA

group [10] Check if ProfileMetadata \ncontains PPR(s)

rnote over IPA #FFFFFF

endrnote

IPA -> E : [ES10b.GetRAT]

E --> IPA : [RAT]

IPA -> E : [ES10b.GetProfilesInfo]

E --> IPA : [ProfileInfoListOk]

end

rnote over DP, E #FFFFFF

[11] sub-procedure Profile Download and Installation – Download Confirmation as defined in section 3.1.3.2 of SGP.22 [4]

endrnote

rnote over IPA, E #FFFFFF

[12] IPA installs the Profile to the eUICC as defined in sub-procedure

Profile Installation in section 3.1.3.3 of SGP.22 [4]

endrnote

IPA -> EIM : [13] ["ESipa.HandleNotification" function]

group [14].

IPA -> DP : "ES9+.HandleNotification" function

rnote over DP

SM-DP+ SHALL continue the procedure as defined

in section 3.1.3.3 of SGP.22 [4] step 8 to 10

endrnote

end

group opt

rnote over IPA #FFFFFF

[15]

If option (c) was used, the IPA MAY request automatic Profile enabling (ES10b.EnableUsingDD).

- In this case, execute steps (15) and (16).

- Otherwise the procedure SHALL stop.

endrnote

end

group opt

rnote over E #FFFFFF

[16]

If automatic Profile enabling was granted in step (5),

the eUICC SHALL enable the Profile and generate

enable Notifications as configured.

endrnote

end

rnote over IPA #FFFFFF

[17]

IPA SHALL retrieve and send any new Notifications

generated due to the Profile enabling

to Notification Receivers

according to section 3.5 of SGP.22 [4].

Endrnote

@enduml

[Diagram Description automatically generated]

9.: Direct Profile Download

Start Conditions:

In addition to the start conditions required by the Common Mutual Authentication procedure defined in section 3.1.2 of SGP.22 [4], this procedure requires the following start conditions depending on the following exclusive options in step 1:

Option (a) use of an Activation Code: The eIM or IPA has an Activation Code that is coded as defined in section 4.1 of SGP.22 [4].

Option (b) use of SM-DS: The eIM or the IPA has retrieved the SM-DP+ Address and EventID from an SM-DS, as defined in section 3.6.2 of SGP.22 [4].

Option (c) use of default SM-DP+: The IPA has the default SM-DP+ Address (e.g.: by calling the function ES10a.GetEuiccConfiguredAddresses).

Procedure:

If option (a) is used and the Activation Code is available to the eIM, the eIM parses the Activation Code and finds the SM-DP+ address, Activation Code Token, and optional SM-DP+ OID. If the format of the Activation Code is invalid, the procedure SHALL stop.

In case of a Profile download trigger from an eIM Package: a secure connection is established between the IPA and the eIM for the IPA to obtain the eIM Package. How this is triggered is out of scope of this specification. There are two options for the delivery of the eIM Package to the IPA:

-The eIM Package Retrieval Procedure defined in section 3.1.1.1 is executed between the IPA and the eIM, or

-The eIM Package Injection Procedure defined in section 3.1.1.2 is executed between the IPA and the eIM.

The IPA parses the eIM Package received in step 2. The IPA identifies if the eIM Package contains a ProfileDownloadTriggerRequest. If option (a) is used this trigger SHALL contain the Activation Code. If option (b) is used this trigger contains the SM-DP+ Address and EventID. If option (c) is used this trigger contains instruction to use the default SM-DP+ Address. If the format of the trigger profile download eIM Package is invalid, or data needed by IPA to perform the profile download is missing, the procedure SHALL stop.

If option (a) is used, the IPA parses the Activation Code and finds the SM-DP+ Address, Activation Code Token, and optional SM-DP+ OID. If the format of the Activation Code is invalid, the procedure SHALL stop.

The common mutual authentication procedure defined in section 3.1.2 of SGP.22 [4] SHALL be executed. When this procedure is used for Profile download and installation, SM-XX is SM-DP+. CERT.XXauth.ECDSA, PK.XXauth.ECDSA and SK.XXauth.ECDSA are CERT.DPauth.ECDSA, PK.DPauth.ECDSA and SK.DPauth.ECDSA respectively. ESXX is ES9+.

During the common mutual authentication procedure at step (10) in section 3.1.2 of SGP.22 [4], the IPA SHALL verify that the SM-DP+ OID contained in the CERT.DPauth.ECDSA returned by the SM-DP+ is identical to the SM-DP+ OID if the IPA has acquired it from the Activation Code at step (1). If the comparison fails, the procedure SHALL stop.

During the common mutual authentication procedure at step (10) in section 3.1.2 of SGP.22 [4], the IPA SHALL build the ctxParams1 data object to provide the MatchingID, Device Info to the eUICC for signature. The value of the MatchingID SHALL be set as follows:

-If an Activation Code is used (option (a)), the MatchingID value SHALL be set to Activation Code Token.

-If an SM-DS is used (option (b)), the MatchingID value SHALL be set to EventID.

-If a default SM-DP+ is used (option (c)), the MatchingID SHALL be missing.

If automatic Profile enabling is activated, the eUICC SHALL verify that the download is coming from the default SM-DP+ configured in the eUICC. If the verification is successful, the eUICC SHALL grant automatic enabling for this Profile.

After having successfully authenticated the eUICC at the end of the step (5) above, the SM-DP+ SHALL:

-Verify that there is a related pending Profile download order for the provided MatchingID.

-If this Profile download order is already linked to an EID, verify that it matches the EID of the authenticated eUICC.

-Verify that the Profile corresponding to the pending Profile download order is in 'Released' state, or, in case of a retry due to a previous installation failure, in 'Downloaded' state (section 3.1.6 of SGP.22 [4]).

If any of these verifications fail, the SM-DP+ SHALL return the relevant error status and the procedure SHALL stop.

The SM-DP+ SHALL increment the count of download attempts for the identified Profile. If the maximum number of attempts has been exceeded, the SM-DP+ SHALL terminate the corresponding Profile download order and notify the Operator by calling the "ES2+.HandleDownloadProgressInfo" function with an operation status indicating 'Failed' with the relevant error status, and the procedure SHALL be stopped. Otherwise, the SM-DP+ SHALL perform appropriate eligibility checks, based on the Device Info and/or eUICCInfo2. These checks SHALL include the check if the eUICC can install one more Profile. See Annex F of SGP.22 [4] for more information on Eligibility checks.

(Optional step) Depending on the agreed behaviour with the Operator (out of scope of this specification), the SM-DP+ SHALL notify the Operator with the outcome of the eligibility check using the function “ES2+.HandleDownloadProgressInfo”. The SM-DP+ SHALL provide the EID, the ICCID, the identification of the point reached (in that case it SHALL be ‘Eligibility check’), the timestamp when this point was reached, and the execution result of this step.

NOTE: This notification step MAY be done asynchronously.

If the eligibility check fails, the SM-DP+ SHALL:

-set the Profile corresponding with the pending Profile download order in ‘Error’ state (section 3.1.6 of SGP.22 [4]).

-return an error status to the IPA and the procedure SHALL stop.

Otherwise, the SM-DP+ SHALL:

-Determine whether the Profile is already bound to the EID from a previous unsuccessful download attempt. If so, the SM-DP+ MAY include the otPK.Euicc.ECKA obtained in the previous session in the smdpSigned2 data structure.

-Determine if a Confirmation Code is required for this pending order.

NOTE: How the Confirmation Code is sent to the IoT Device is out of the scope of this specification.

-Generate a smdpSigned2 data structure containing the TransactionID and the Confirmation Code Required Flag.

-Compute the smdpSignature2 over smdpSigned2 and euiccSignature1 using the SK.DPpb.ECDSA.

The SM-DP+ returns the TransactionID, ProfileMetadata, smdpSigned2, smdpSignature2 and CERT.DPpb.ECDSA to the IPA.

On reception of the SM-DP+ response, the IPA that SHALL verify the Profile Metadata according to section 3.2 (Profile Download and Installation) of SGP.22 [4]. For this verification, the IPA MAY use previously fetched Rules Authorisation Table and/or list of installed Profiles. If the IPA has not already fetched the required information, the IPA SHALL request those from the eUICC by calling the ES10b.GetRAT and/or ES10b.GetProfilesInfo functions. If the verification fails, the IPA SHALL trigger the cancellation of the on-going RSP session and terminate the procedure.

The IPA and eUICC process ES10b.PrepareDownload function call as defined in section 5.7.5 of SGP.22 [4] and the ongoing RSP session SHALL continue with the sub-procedure Profile Download and Installation – Download Confirmation as defined in section 3.1.3.2 of SGP.22 [4].

The IPA installs the Profile to the eUICC as defined in section 3.1.3.3 (Sub-procedure Profile Installation) of SGP.22 [4].

In case of a Profile download trigger from an eIM Package: the IPA SHALL send the ProfileDownloadTriggerResult to the eIM as defined in section 2.11.2.3 by using the function "ESipa.HandleNotification".

NOTE: This step is executed whenever an error is reported between steps 5 and 12.

On reception of the "ES9+.HandleNotification" function, the SM-DP+ SHALL proceed as defined in section 3.1.3.3 of SGP.22 [4] step 8 to 10.

If option (c) was used, the IPA MAY request automatic Profile enabling by calling ES10b.EnableUsingDD. In this case steps (15) and (16) SHALL be executed. Otherwise, the procedure SHALL stop.

If automatic Profile enabling was granted in step (5), the eUICC SHALL enable the Profile and generate enable Notifications as configured.

The IPA SHALL retrieve and send any new Notifications generated due to the Profile enabling to Notification Receivers according to section 3.5 of SGP.22 [4].

3.2.3.2 Indirect Profile Download

This section describes the indirect Profile download and installation procedure where the eIM is used as a proxy between the IoT Device and the SM-DP+.

Diagram source (PlantUML)
@startuml

hide footbox

skinparam sequenceMessageAlign center

skinparam sequenceArrowFontSize 11

skinparam noteFontSize 11

skinparam monochrome true

skinparam lifelinestrategy solid

participant "<b>SM-DP+" as DP

participant "<b>eIM" as EIM

participant "<b>IPA" as IPA

participant "<b>eUICC" as E

group If option (a) and AC is available to eIM

rnote over EIM : [1] eIM parses the AC to retrieve SM-DP+ Address, Activation Code Token, [SM-DP+ OID]

end

group If IPA obtains a Profile download trigger from eIM Package

alt IPA-initiated

rnote over EIM, IPA : [2a] eIM Package Retrieval Procedure including secure connection establishment (section 3.1.1.1)

else eIM-initiated

rnote over EIM, IPA : [2b] eIM Package Injection Procedure including secure connection establishment (section 3.1.1.2)

end

rnote over IPA : [] IPA parses the eIM Package and obtains Profile \ndownload trigger including e.g. an AC

end

group If option (a) and AC is available to IPA

rnote over IPA : [4] IPA parses AC to retrieve SM-DP+ Address, Activation Code Token, [SM-DP+ OID]

end

opt Get euiccInfo1 if not yet retrieved by IPA or eIM

IPA -> E : [5] ES10b.GetEuiccInfo

E --> IPA : euiccInfo1

end

IPA -> E : [6] ES10b.GetEuiccChallenge

E -> IPA : euiccChallenge

group If a secure connection is not yet established

rnote over EIM, IPA : [7] Establish secure connection

end

IPA -> EIM : [8] ESipa.InitiateAuthentication request

rnote over EIM, DP : [9] Establish HTTPS connection

rnote over EIM, DP : [10] ES9+'.InitiateAuthentication function

EIM -> IPA : [11] ESipa.InitiateAuthentication response

rnote over IPA, E: [12] ES10b.AuthenticateServer function

IPA -> EIM : [13] ESipa.AuthenticateClient request

rnote over EIM, DP : [14] ES9+'.AuthenticateClient function

EIM -> IPA : [15] ESipa.AuthenticateClient response

rnote over IPA, E: [16] ES10b.PrepareDownload function

IPA -> EIM : [17] ESipa.GetBoundProfilePackage request

rnote over EIM, DP : [18] ES9+'.GetBoundProfilePackage function

EIM -> IPA : [19] ESipa.GetBoundProfilePackage response

group [20] Profile Installation Procedure

rnote over IPA, E : Profile Installation

IPA -> EIM : [a] ESipa.HandleNotification

EIM -> IPA : [b] ACK

IPA -> E : [c] ES10b.RemoveNotificationFromList

EIM -> DP : [d] ES9+'.HandleNotification

end

rnote over DP : [21] Step 8-10 section 3.1.3.3 of SGP.22

@enduml

[PlantUML diagram]

10.: Indirect Profile Download and Installation

Start Conditions:

In addition to the start conditions required by the Common Mutual Authentication procedure defined in section 3.1.2 of SGP.22 [4], this procedure requires the following start conditions depending on the following exclusive options in step 1:

Option (a) use of an Activation Code: The eIM or IPA has an Activation Code that is coded as defined in section 4.1 of SGP.22 [4].

Option (b) use of SM-DS: The eIM has retrieved the SM-DP+ Address and EventID from the SM-DS, as defined in section 3.9.2.2 of this document.

Option (c) use of default SM-DP+: The eIM or the IPA has the default SM-DP+ Address.

Procedure:

If option (a) is used and the Activation Code is available to the eIM, the eIM parses the Activation Code and finds the SM-DP+ address, Activation Code Token, and optional SM-DP+ OID. If the format of the Activation Code is invalid, the procedure SHALL stop.

In case a Profile download trigger from an eIM Package: a secure connection is established between the IPA and the eIM for IPA to obtain the eIM Package. How this is triggered is out of scope of this specification. There are two options for the delivery of the eIM Package to the IPA:

a)The eIM Package Retrieval Procedure defined in section 3.1.1.1 is executed between the IPA and the eIM.

b)The eIM Package Injection Procedure defined in section 3.1.1.2 is executed between the IPA and the eIM.

The IPA parses the eIM Package received in step 2. The IPA identifies that the eIM Package contains a ProfileDownloadTriggerRequest. If option (a) is used this trigger MAY contain the Activation Code. Alternatively, the eIM handles the AC (see IPA Capability eimDownloadDataHandling). If option (b) is used this trigger MAY contain the SM-DP+ Address and EventID (formatted as an Activation Code), if handled by IPA. If option (c) is used this trigger MAY contain information to use the default SM-DP+ Address. If the format of the trigger profile download eIM Package is invalid, or data needed by IPA to perform the profile download is missing, the procedure SHALL stop.

If the IPA retrieved an Activation Code in step 3, or if IPA retrieved an Activation Code by some other means outside of this specification before the start of this procedure, the IPA parses the Activation Code and finds the SM-DP+ address, Activation Code Token, and optional SM-DP+ OID. If the format of the Activation Code is invalid, the procedure SHALL stop.

If euiccInfo1 is not yet retrieved by the eIM or IPA, the IPA MAY request euiccInfo1 from the eUICC by calling ES10b.GetEuiccInfo (see section 5.9.2).

The IPA requests an eUICC Challenge from the eUICC by calling the ES10.GetEUICCChallenge function (see section 5.9.3).

A secure connection is established between the IPA and the eIM if it is not yet established.

The IPA calls ESipa.InitiateAuthentication function comprising eUICC Challenge, optionally SM-DP+ FQDN, and optionally euiccInfo1(see IPA Capability minimizeEsipaBytes). If the IPA does not provide SM-DP+ FQDN or euiccInfo1, the eIM SHALL identify the relevant information.

The eIM establishes an HTTPS connection with the SM-DP+ in server authentication mode according to SGP.22 [4].

The eIM and the SM-DP+ process ES9+'.InitiateAuthentication function comprising eUICC Challenge, SM-DP+ FQDN, and euiccInfo1 as defined in section 5.6.1 of SGP.22 [4]. If the SM-DP+ FQDN provided in ES9+'.InitiateAuthentication in step 9 did not come from IPA (was not obtained from IPA in step 7 e.g., due to IPA has capability eimDownloadDataHandling), the eIM SHALL verify that this SM-DP+ FQDN matches the SM-DP+ FQDN returned by the SM-DP+ (in serverSigned1). If not, the procedure SHALL be stopped. If the Activation Code contains the SM-DP+ OID and is available to the eIM, the eIM SHALL check that the SM-DP+ OID from the AC matches the SM-DP+ OID of the SM-DP+ Certificate (serverCertificate). If not, the procedure SHALL be stopped.

The eIM sends the ESipa.InitiateAuthentication response to the IPA, based on the ES9+'.InitiateAuthentication response from the SM-DP+. The eIM SHALL additionally provide ctxParams1 as defined in SGP.22 [4] if the IPA does not generate it (see IPA capability eimCtxParams1Generation).

The IPA and eUICC process ES10b.AuthenticateServer function call as defined in section 5.7.13 of SGP.22 [4].

The IPA calls ESipa.AuthenticateClient function comprising euiccSigned1 or compactEuiccSigned1, euiccSignature1, optionally CERT.EUM.ECDSA, and optionally CERT.EUICC.ECDSA. If the IPA does not provide CERT.EUM.ECDSA and CERT.EUICC.ECDSA and/or provide the compactEuiccSigned1 instead of euiccSigned1 (see IPA Capability minimizeEsipaBytes), the eIM SHALL identify the relevant information and build euiccSigned1.

The eIM and SM-DP+ process the ES9+'.AuthenticateClient function as defined in 5.6.3 of SGP.22 [4].

The eIM sends the ESipa.AuthenticateClient response to the IPA, based on the ES9+'.AuthenticateClient response from the SM-DP+. If the response returns an error, IPA SHALL trigger the cancellation of the on-going RSP session (see section 3.2.3.3) with reason sessionAborted and the procedure SHALL stop.

-If the IPA is capable of verifying the Profile Metadata, the eIM SHALL provide the Profile Metadata to IPA that SHALL verify the Profile Metadata according to section 3.1.3 (Profile Download and Installation) of SGP.22 [4]. For this verification, the IPA MAY use previously fetched Rules Authorisation Table and/or list of installed Profiles. If the IPA has not already fetched the required information, the IPA SHALL request those from the eUICC by calling the ES10b.GetRAT and/or ES10b.GetProfilesInfo functions. If the verification fails, the IPA SHALL trigger the cancellation of the on-going RSP session (see section 3.2.3.3) and terminate the procedure.

-If the IPA is not capable of verifying the Profile Metadata (see IPA Capability eimProfileMetadataVerification) according to section 3.1.3 (Profile Download and Installation) of SGP.22 [4], the eIM SHALL verify the Profile Metadata and SHALL NOT provide the Profile Metadata to IPA. For this verification, the eIM SHALL use Rules Authorisation Table and information on installed Profiles available to the eIM, e.g., obtained prior to the start of this procedure using the PSMOs getRAT and listProfileInfo. If the verification fails, the eIM SHALL return an error code to IPA and terminate the procedure. The error code triggers IPA to cancel the on-going RSP session with SM-DP+ according to section 3.2.3.3. The cancel session reason (pprNotAllowed) to be used by IPA when calling the ESipa.CancelSession is given by the error code.

The IPA and eUICC process ES10b.PrepareDownload function call as defined in section 5.7.5 of SGP.22 [4].

The IPA calls ESipa.GetBoundProfilePackage function comprising euiccSignature2 and either euiccSigned2 or compactEuiccSigned2. If compactEuiccSigned2 is provided (see IPA Capability minimizeEsipaBytes), the eIM SHALL identify the relevant information and build euiccSigned2.

The eIM and SM-DP+ process ES9+'.GetBoundProfilePackage function as defined in section 5.6.2 of SGP.22 [4].

NOTE: In the ES9+'.GetBoundProfilePackage function request, the eIM forwards the ESipa.GetBoundProfilePackage function request.

The eIM sends the ESipa.GetBoundProfilePackage response to the IPA, based on the ES9+'.GetBoundProfilePackage response from the SM-DP+. If the eIM or IPA previously verified the Profile Metadata in step (14), the eIM or IPA SHOULD check if the Profile Metadata has been changed. If so, IPA SHALL be triggered to cancel the on-going RSP session with the SM-DP+ (see section 3.2.3.3) with cancel session reason metadataMismatch and the procedure SHALL be terminated. In case of eIM performing the check (see IPA Capability eimProfileMetadataVerification), the eIM SHALL return an error code that triggers IPA to cancel the session and also indicates the cancel session reason (metadataMismatch) to be used.

The IPA installs the Profile to the eUICC as defined in section 3.1.3.3 (Sub-procedure Profile Installation) of SGP.22 [4]. In case of errors during the installation of the Profile the cancel session procedure in section 3.2.3.3 is triggered with cancel session reason loadBppExecutionError and the procedure SHALL stop. The following changes are made to the Notification procedure compared to section 3.1.3.3 of SGP.22 [4]:

a)The IPA calls ESipa.HandleNotification function comprising ProfileInstallationResult. If a compact version of the ProfileInstallationResult is provided (see IPA Capability minimizeEsipaBytes), the eIM SHALL identify the relevant information and build the full ProfileInstallationResult.

b)The eIM acknowledges the reception of the ProfileInstallationResult.

c)Upon acknowledgement of successful reception of the ProfileInstallationResult, IPA calls the ES10b.RemoveNotificationFromList function with corresponding seqNumber as input parameter and the eUICC deletes the ProfileInstallationResult from its memory.

d)The eIM and SM-DP+ process ES9+’.HandleNotification function as defined in section 5.7.4 of this document.

On reception of the ES9+’.HandleNotification function, the SM-DP+ SHALL proceed as defined in section 3.1.3.3 of SGP.22 [4] step 8 to 10.

3.2.3.3 Cancel Session Procedure for Indirect Profile Download

This section describes the cancel session call flow used to cancel an indirect Profile download session. This procedure can occur due to an error at the following steps of the protocol:

-after the response to "ESipa.AuthenticateClient"

-after the response to "ESipa.GetBoundProfilePackage"

Diagram source (PlantUML)
@startuml

skinparam monochrome true

skinparam ArrowColor Black

skinparam lifelinestrategy solid

skinparam sequenceMessageAlign center

skinparam noteBackgroundColor #FFFFFF

skinparam participantBackgroundColor #FFFFFF

hide footbox

participant "<b>SM-DP+" as DP

participant "<b>eIM" as eIM

participant "<b>IPAd" as IPA

participant "<b>eUICC" as E

IPA -> E : [1] ES10b.CancelSession(TransactionID, reason)

rnote over E

[2]

- Generate euiccCancelSessionSigned = {

TransactionID, reason}

- Compute euiccCancelSessionSignature

over euiccCancelSessionSigned

endrnote

E --> IPA : [3] cancelSessionResponseOk

rnote over IPA

[Stop procedure if the reason is sessionAborted]

endrnote

IPA -> eIM : [4] ESipa.CancelSession(TransactionID, cancelSessionResponseOk)

eIM -> DP : [4] ES9+’.CancelSession(TransactionID, cancelSessionResponseOk)

rnote over DP

[5]

- Retrieve the on-going RSP session

- Verify euiccCancelSessionSignature

- Verify the SM-DP+ OID

endrnote

DP --> eIM : [ERROR]

eIM --> IPA : [ERROR]

rnote over DP

[6] Process the reason according to SGP.22 [4]

endrnote

DP --> eIM : [10] OK

eIM --> IPA : [10] OK

@enduml

[Diagram Description automatically generated]

11.Cancel Session Procedure

Start Conditions:

This procedure can be used in the following cases.

Reasons in the response to "ESipa.AuthenticateClient":

-The IPAd receives “pprNotAllowed” error in the response to "ESipa.AuthenticateClient" due to that eIM, when verifying the Profile Metadata, discovered that the PPR(s) in the Profile Metadata are not allowed according to the Rules Authorisation Table, or PPR1 is present in the Profile Metadata and an Operational Profile is already installed on the eUICC. In this case the reason code for step (1) SHALL be pprNotAllowed.

-The IPAd receives any other error in the response to "ESipa.AuthenticateClient". In this case the reason for step (1) SHALL be sessionAborted.

Cancel reasons after "ESipa.AuthenticateClient" related to Profile download:

-The IPAd verifies Profile Metadata and discovers that the PPR(s) in the Profile Metadata are not allowed according to the Rules Authorisation Table, or PPR1 is present in the Profile Metadata and an Operational Profile is already installed on the eUICC. In these cases, the reason code for step (1) SHALL be pprNotAllowed.

Reasons in the response to "ESipa.GetBoundProfilePackage":

-The IPAd receives “profileMetadataMismatch” error in the response to "ESipa.GetBoundProfilePackage" due to that eIM discovered that the Profile Metadata in the Bound Profile Package does not match the Profile Metadata received previously in the response to "ES9+’.AuthenticateClient". In this case the reason code for step (1) SHALL be metadataMismatch.

Cancel reasons after "ESipa.GetBoundProfilePackage":

-The IPAd discovers that the Profile Metadata in the Bound Profile Package does not match the Profile Metadata received previously in the response to "ESipa.AuthenticateClient". In this case the reason for step (1) SHALL be metadataMismatch.

-The IPAd has encountered an error while installing a Bound Profile Package. In this case the reason for step (1) SHALL be loadBppExecutionError.

Procedure:

1.The IPAd SHALL call the "ES10b.CancelSession" function with input data comprising the TransactionID and the reason.

2.The eUICC SHALL:

-Generate the euiccCancelSessionSigned data object containing the TransactionID and the reason provided by the IPAd.

-Compute the euiccCancelSessionSignature over euiccCancelSessionSigned using the SK.EUICC.ECDSA corresponding to the euiccCiPKIdToBeUsed as received during the common mutual authentication procedure.

3.The eUICC SHALL return the euiccCancelSessionSigned and euiccCancelSessionSignature. If the reason is sessionAborted, the IPAd SHALL ignore the response from the eUICC and stop the procedure.

4.The IPAd SHALL call the "ESipa.CancelSession" function with input data comprising TransactionID, euiccCancelSessionSigned and euiccCancelSessionSignature. Upon receiving the "ESipa.CancelSession" function call, the eIM SHALL call the "ES9+’.CancelSession" function with the input data from "ESipa.CancelSession".

5.On reception of the "ES9+’.CancelSession" function, the SM-DP+ SHALL:

-Retrieve the on-going RSP session identified by the TransactionID. If the TransactionID is unknown, the SM-DP+ SHALL return a function execution status 'Failed' with relevant status code and the procedure SHALL stop.

-Verify the euiccCancelSessionSignature performed over euiccCancelSessionSigned using the PK.EUICC.ECDSA associated with the ongoing RSP session. If the signature is invalid, the SM-DP+ SHALL return a function execution status 'Failed' with relevant status code and the procedure SHALL stop.

-Verify that the received OID is the same value as the one contained in the CERT.DPauth.ECDSA used during the common mutual authentication procedure. If the value does not match, the SM-DP+ SHALL return a function execution status 'Failed' with relevant status code and the procedure SHALL stop.

6.The SM-DP+ SHALL process the error reason according to steps 5 to 7 in Section 3.1.3.1 of SGP.22 [4].

7.The SM-DP+ SHALL return a function execution status 'Executed-Success' and the procedure SHALL stop. The eIM returns the function execution status from "ES9+’.CancelSession" function as the function execution status of "ESipa.CancelSession".

3.3 eUICC Package Handling

3.3.1 Generic eUICC Package Download and Execution

This procedure describes the download of an eUICC Package contained within an eIM Package. It also describes how to process the eUICC Package and how to return a signed result of the eUICC Package execution to the eIM.

NOTE: The Sub-procedures for Profile State Management, described in section 3.4, and eIM Configuration, as described in section 3.5.1, are executed in step 5 of the procedure described in this section.

Diagram source (PlantUML)
@startuml

skinparam monochrome true

skinparam ArrowColor Black

skinparam lifelinestrategy solid

skinparam sequenceMessageAlign center

skinparam noteBackgroundColor #FFFFFF

skinparam participantBackgroundColor #FFFFFF

skinparam ParticipantPadding 70

hide footbox

participant "<b>SM-DP+" as DP

participant "<b>eIM" as eIM

participant "<b>IPAd" as IPA

participant "<b>eUICC" as E

participant "<b>Device Baseband" as DevBB

rnote left IPA

[1]

- Build euiccPackageSigned = {eimId, eidValue, counterValue, [transactionId], euiccPackage}

and compute eimSignature over euiccPackageSigned

- Build eIMPackage

endrnote

rnote over eIM, IPA: [2] Transfer eIM Package containing signed \n eUICC Package from eIM to IPAd (see section 3.1.1)

group Process the eIM Package

IPA -> E : [3] ES10b.LoadEuiccPackage (eUICC Package)

rnote over E: [4] Verify the eIM signature \nand check EID and replay counter

E --> IPA : [ERROR]

loop Up to the number of\n PSMOs/eCOs in the eUICC Package

rnote over E

[5] Execute PSMO/eCO

endrnote

end

rnote over E: [6] Generate and sign the result of the eUICC Package \nincluding eUICC sequence number

end

opt If enable or disable PSMO

E -> DevBB: [7a] REFRESH

DevBB -> E: Terminal Response or RESET

rnote over E

[7b] Profile(s) are enabled and/or disabled

endrnote

rnote over DevBB

[Network attach procedure

with the newly enabled Profile]

end rnote

end opt

E -> IPA : [8] Signed eUICC Package Result

group If the IPAd sends eUICC Package Result and Notifications to the eIM in a single eIM Package Result

IPA -> E : [9] ES10b.RetrieveNotificationsList

E -> IPA : List of pending Notifications

end

rnote over eIM, IPA: [10] Transfer eIM Package Result containing signed eUICC Package Result \nand optionally Notifications list from IPAd to eIM (see section 3.1.1)

rnote over eIM: [11] Extract eUICC Package Result, \nverify the eUICC signature and check \nsequence number to prevent replay

rnote over eIM: [12] Process the result of the eUICC Package

rnote over eIM, IPA: [13] Acknowledge successfully received signed eUICC Package Result\n and Notifications if any.

group [14] For each pending Notification obtained by the eIM in step 10

eIM -> DP : ES9+’.HandleNotification

DP -> eIM : ACK

end

group Delete eUICC Package Result and Notifications

loop

IPA -> E : [15] ES10b.RemoveNotificationFromList

rnote over E: [16] Delete eUICC Package Result / Notification

end

end

group [17] If IPAd sends Notifications using ES9+.HandleNotification or ESipa.HandleNotification

rnote over DP, E #FFFFFF : [Refer to procedure Notification Delivery to Notification Receivers]

end

@enduml

[PlantUML diagram]

12.: Generic eUICC Package Download and Execution

Start Condition:

This procedure requires the following start conditions:

-The eUICC is associated with the eIM and has the eIM public key and eIM ID.

-The eIM has received a request to perform a PSMO/eCO for the particular eUICC and has the EID of the eUICC in its storage along with the current value of the counter for replay protection as well as the relevant information of the target Profile in the eUICC.

-A Secure Connection between the eIM and the IPA is established.

Procedure:

1.The eIM SHALL prepare the eUICC Package structure including signing the eUICC Package using the eIM private key. The signed data includes, for the particular eUICC, the eIMID, the EID and the current value incremented by 1 of the counters for replay protection of eUICC Packages obtained from eIM storage. The current value of the counter for replay protection in eIM storage is updated accordingly. The eIM then builds the eIM Package containing the signed eUICC Package. TransactionId, if included, MAY be used for linking an eUICC Package with an eUICC Package Result.

2.The eIM SHALL transfer the eIM Package (containing the signed eUICC Package) to the IPAd as described in section 3.1.1.

3.IPAd then processes the eIM Package. The IPAd SHALL call ES10b.LoadEuiccPackage to provide the signed eUICC Package to the eUICC.

4.The eUICC SHALL verify the eIM signature and check the EID and replay counter. See details in section 5.9.1. In case of error, the eUICC SHALL return an error message and the procedure SHALL stop.

5.If all verifications are successful, the eUICC SHALL process the eUICC Package. The PSMOs or eCOs in the eUICC Package SHALL be executed sequentially by the eUICC until the end is reached or an error is encountered for a PSMO/eCO. If an interruption (e.g. power loss) occurs during the processing of the ES10b.LoadEuiccPackage command, the eUICC SHALL restore its original state prior to execution, see details in section 5.9.1.

6.The eUICC SHALL generate the result of the eUICC Package execution and sign it using the eUICC private key SK.EUICC.ECDSA. The signed data includes the next (not used) value of the eUICC sequence number (defined in SGP.22 [4] for use with Notifications) and the eUICC sequence number is incremented by 1 within the eUICC. The eUICC SHALL update the stored counter value to the counter value of the signed eUICC Package received in step 4.

7.If the eUICC Package contained an enable and/or disable PSMOs:

a.the eUICC SHALL send the REFRESH command in "eUICC Profile State Change" mode (if supported by the Device) or "UICC Reset" mode to the Device, according to ETSI TS 102 223 [5], to prepare the IoT Device for a change in Profile state.

b.Upon reception of the Terminal Response or after the RESET, the ISD-R SHALL:

i.Disable the profile (if any) marked "to be disabled" or "to be disabled and deleted".

ii. Enable the profile (if any) marked "to be enabled".

If the eUICC Package contained one or several delete PSMO, the ISD-R SHALL delete any Profile marked "to be deleted" (or "to be disabled and deleted").

8.The IPAd obtains the signed eUICC Package Result from the eUICC.

9.If the IPAd sends eUICC Package Result and Notifications to the eIM in a single eIM Package Result and if the eUICC Package contains PSMO(s), the IPAd SHALL retrieve pending Notifications by calling ES10b.RetrieveNotificationsList function.

10.The IPAd SHALL transfer the eIM Package Result containing the signed eUICC Package Result to the eIM. The details on the transfer of the eIM Package Result depends on the underlying ESipa transport and is further described in section 3.1.1. If the IPAd sends eUICC Package Result and Notifications to the eIM in a single eIM Package Result (using ESipa.ProvideEimPackageResult), the IPAd SHALL, in case of a non-empty list of pending Notifications, include the list of pending Notifications (RetrieveNotificationsListResponse as defined in SGP.22 [4]) together with the signed eUICC Package Result in the eIM Package Result. In case of an IPAd with IPA Capability minimizeEsipaBytes, the IPAd SHOULD include each pending Notification in the list in compact format as described in section 5.14.7.

If the IPAd does not send Notifications together with the eUICC Package Result, the IPAd MAY use ESipa.HandleNotifications instead to send the eUICC Package Result to the eIM.

If the IPAd fails sending the eIM Package Result to the eIM due to a lack of connectivity, it SHOULD apply the Profile Rollback procedure described below.

1.The eIM SHALL extract the eUICC Package Result and verify the eUICC signature of the signed eUICC Package Result using the public key PK.EUICC.ECDSA of the eUICC obtained from the eUICC Certificate in the eIM storage. Upon successful verification, the eIM SHALL retrieve the counter value included in the eUICC Package Result and map it to the related eUICC Package. It SHALL then check that the sequence number contained in the eUICC Package Result is greater than the value of the sequence number currently stored in the eIM for the particular eUICC. If all checks are successful, the eIM SHALL update the stored value of the sequence number for the particular eUICC to the value of the signed eUICC Package Result. If any of the checks fail, the eIM SHALL stop the processing of the eUICC Package Result. In case the eIM received pending Notifications in step 10, the eIM continues the execution in step 13 to acknowledge the received Notifications (but not the eUICC Package Result) and sends the received Notifications to Notification Receivers (see step 14).

2.The eIM SHALL process the result of the eUICC Package execution.

3.If the eIM Package Result was transmitted using the ESipa.ProvideEimPackageResult function (resp. the response to ESipa.TransferEimPackage), then the eIM SHALL acknowledge the signed eUICC Package Result and Notifications (if any) that were successfully processed by sending their sequence numbers in the response to ESipa.ProvideEimPackageResult (resp. the next call to ESipa.TransferEimPackage).

11.If the If the eIM Package Result was transmitted using ESipa.HandleNotifications, then the eIM does not acknowledge the signed eUICC Package Result and received Notifications (if any). In case the eIM received pending Notifications in step 10, the eIM SHALL forward them to the Notification Receivers. If a pending Notification is in compact format (see IPA Capability minimizeEsipaBytes), the eIM SHALL identify the relevant information and build the full pending Notification before forwarding the Notification to the Notification Receiver.

12.IPAd SHALL call ES10b.RemoveNotificationFromList (see SGP.22 [4]) one or more times to delete the eUICC Package Result and pending Notifications for which acknowledgement has been received. The eUICC Package Result and each pending Notification to be deleted are identified by the sequence number(s) received in step 13.

13.The eUICC SHALL delete the eUICC Package Result or pending Notification from its memory.

14.If IPAd sends Notifications using ES9+.HandleNotification or ESipa.HandleNotification, the IPAd SHALL continue execution according to procedure “Notification Delivery to Notification Receivers.”

Profile Rollback Procedure:

If the IPAd fails sending the eIM Package Result to the eIM due to a lack of connectivity, it SHOULD call the ES10b.ProfileRollback function (see section 5.9.16) to request the eUICC to roll back to the previously Enabled Profile (if any).

If the result of ES10b.ProfileRollback indicates successful processing (the eUICC returns 'ok'), then a new eUICC Package Result is available, and the IPAd SHALL:

-Discard the previous eIM Package Result, i.e., the IPAd SHALL NOT send this eIM Package Result to the eIM and SHALL call ES10b.RemoveNotificationFromList (see SGP.22 [4]) to delete the related eUICC Package Result.

-The IPAd SHALL build a new eIM Package Result including the new eUICC Package Result returned by the ES10b.ProfileRollback command and try to send this new eIM Package Result to the eIM.

NOTE: As Profiles have returned to their states prior to the processing of the eUICC Package Request, as an optimization, the IPA may inquire which Notifications (if any) were generated by the processing of the eUICC Package Request and ES10b.ProfileRollback command and decide to discard such Notifications without sending them to the eIM.

3.4 Profile State Management

3.4.1 Enable Profile

This procedure defines the execution of an Enable command contained within a eUICC Package as defined in 3.3.1 Generic eUICC Package Download and Execution, used to enable a Profile already downloaded and installed on an eUICC.

Diagram source (PlantUML)
@startuml

skinparam monochrome true

skinparam ArrowColor Black

skinparam lifelinestrategy solid

skinparam sequenceMessageAlign center

skinparam noteBackgroundColor #FFFFFF

skinparam participantBackgroundColor #FFFFFF

hide footbox

participant "<b>eUICC\n<b>IPA Services (ISD-R)" as IPAServices

rnote over IPAServices

[1] Profile identification

[2] Verify Profile state

End rnote

rnote over IPAServices

[3] Mark Target Profile "to be enabled" and, if granted, record "usage of Rollback Mechanism is allowed"

endrnote

rnote over IPAServices

[4] Generate Enable PSMO execution result

data structure (enableResult)

and continue as described in 3.3.1

endrnote

@enduml

[Graphical user interface, application, table Description automatically generated]

13.: Enable Profile

Start Conditions:

A Profile is already downloaded and installed in the eUICC. A eUICC Package containing an 'Enable Profile' is received within an "ES10b.LoadEuiccPackage" by the eUICC as described in 3.3.1 Generic eUICC Package Download and Execution.

The eIM signature the EID, and replay counter are verified as defined in 3.3.1 Generic eUICC Package Download and Execution.

Procedure:

If an Enable command has already been processed in this eUICC Package, then the ISD-R SHALL stop the procedure with a result indicating a failure.

1.The ISD-R SHALL find the Target Profile with the ICCID. If the Target Profile is not found, the ISD-R SHALL stop the procedure with a result indicating a failure.

2.The ISD-R SHALL verify the state of the Target Profile and, if usage of the Rollback Mechanism is granted, whether a Profile is currently enabled (or marked as "to be disabled"). If the Target Profile is not in Disabled state, or if usage of the Rollback Mechanism is granted and there is no currently Enabled Profile (or no Profile marked as "to be disabled"), then the ISD-R SHALL stop the procedure with a result indicating a failure.

3.The eUICC SHALL mark the target Profile “to be enabled” and the currently Enabled Profile (if any) "to be disabled” and SHALL record whether usage of the Rollback Mechanism is granted (together with a reference to the Profile (if any) which is to be disabled).

4.The eUICC SHALL generate the PSMO execution result data structure indicating the result of the PSMO 'Enable Profile’, and the procedure continues as described in section 3.3.1.

End Conditions:

The Target Profile is marked “to be enabled” and the currently Enabled Profile (if any) is marked "to be disabled". If granted, the authorisation to use the Rollback Mechanism has been recorded (together with a reference to the Profile (if any) which is to be disabled).

The signed eUICC Package execution result data structure containing the result of Enable command is stored in the eUICC.

3.4.2 Disable Profile

This procedure defines the execution of an Disable command contained within a eUICC Package as defined in 3.3.1 Generic eUICC Package Download and Execution, used to disable a Profile already downloaded and installed on an eUICC.

Diagram source (PlantUML)
@startuml

skinparam monochrome true

skinparam ArrowColor Black

skinparam lifelinestrategy solid

skinparam sequenceMessageAlign center

skinparam noteBackgroundColor #FFFFFF

skinparam participantBackgroundColor #FFFFFF

hide footbox

participant "<b>eUICC\n<b>IPA Services (ISD-R)" as IPAServices

rnote over IPAServices

[1] Profile identification

[2] Verify Profile state

[3] Mark profile Target profile as ‘to be disabled’

End rnote

rnote over IPAServices

[4] Generate Disable PSMO execution result data structure (disableResult)

endrnote

@enduml

[PlantUML diagram]

14.: Disable Profile

Start Conditions: A Profile is already downloaded and installed in the eUICC.

A eUICC Package containing a 'Disable Profile' is received within an "ES10b.LoadEuiccPackage" by the eUICC as described in 3.3.1 Generic eUICC Package Download and Execution.

The eIM signature, the EID, and replay counter are verified as defined in 3.3.1 Generic eUICC Package Download and Execution.

Procedure:

If a Disable or an Enable command has already been processed in this eUICC Package, then the ISD-R SHALL stop the procedure with a result indicating a failure.

1.The ISD-R SHALL find the Target Profile with the ICCID. If the Target Profile is not found, the ISD-R SHALL stop the procedure with a result indicating a failure.

2.The ISD-R SHALL verify the state of the Target Profile. If the Target Profile is not in Enabled state, the ISD-R SHALL stop the procedure with a result indicating a failure.

3.The eUICC SHALL mark the Target Profile “to be disabled”.

4.The eUICC SHALL generate the PSMO execution result data structure indicating the result of the PSMO 'Disable Profile’, and the procedure continues as described in section 3.3.1.

End Conditions:

The Target Profile is marked “to be disabled”.

The signed eUICC Package execution result data structure containing the result of disabled Profile is stored in the eUICC.

NOTE: To maintain connectivity, a Disable command needs to be followed by an Enable command in the same eUICC Package.

3.4.3 Delete Profile

This procedure defines the execution of a Delete command contained within a eUICC Package as defined in 3.3.1 Generic eUICC Package Download and Execution, used to delete a Profile already downloaded and installed on an eUICC.

An eUICC Package SHALL NOT include an Enable command with granted usage of the Rollback Mechanism and a Delete command, where the Delete command would try to delete the Profile to which the IPA might want to roll back.

Diagram source (PlantUML)
@startuml

skinparam monochrome true

skinparam ArrowColor Black

skinparam lifelinestrategy solid

skinparam sequenceMessageAlign center

skinparam noteBackgroundColor #FFFFFF

skinparam participantBackgroundColor #FFFFFF

hide footbox

participant "<b>eUICC\n<b>IPA Services (ISD-R)" as IPAServices

rnote over IPAServices

[1] Profile identification

[2] Verify the profile state of the targeted profile

endrnote

alt If the Target Profile is in Disabled state\n and is not marked “to be enabled”

rnote over IPAServices

[2.a] eUICC shall delete the Target Profile

endrnote

else If the Target Profile is in Enabled state and marked “to be disabled”:

rnote over IPAServices

[2.b] eUICC shall re-mark the Target Profile “to be disabled and deleted”.

endrnote

else If the Target Profile is in Enabled state and is not marked “to be disabled”

rnote over IPAServices

[2.c] the ISD-R SHALL indicate a failure in the PSMO execution result.

endrnote

end

rnote over IPAServices

[3] The eUICC SHALL generate the PSMO execution result data structure state

result of the PSMO 'Delete Profile' as described in section 3.3.1

endrnote

@enduml

[Generated by PlantUML]

15.: Delete Profile

Start Conditions:

A Profile is already downloaded and installed in the eUICC. An eUICC Package containing a 'Delete Profile' is received within an "ES10b.LoadEuiccPackage" by the eUICC as described in 3.3.1 Generic eUICC Package Download and Execution.

The eIM signature the EID, and replay counter are verified as defined in 3.3.1 Generic eUICC Package Download and Execution.

Procedure:

1.The ISD-R SHALL find the Target Profile with the ICCID. If the Target Profile is not found, then the ISD-R SHALL stop the procedure with a result indicating a failure.

2.The ISD-R SHALL verify the state of the Target Profile.

a.If the Target Profile is either in Disabled state and is not marked “to be enabled”, or in Enabled state and marked "to be disabled" and is not currently referenced by the Rollback Mechanism (see Enable command), then the eUICC SHALL delete the Target Profile.

b.If the Target Profile is in Enabled state and marked “to be disabled” then the eUICC SHALL re-mark the Target Profile “to be disabled and deleted”.

c.If the Target Profile is in Enabled state and is not marked “to be disabled” or is in Disabled state (or marked "to be disabled") but is currently referenced by the Rollback Mechanism (see Enable command), then the ISD-R SHALL indicate a failure in the PSMO execution result.

3.The eUICC SHALL generate the PSMO execution result data structure indicating the result of the PSMO 'Delete Profile' as described in section 3.3.1.

End Conditions:

The Target Profile is either deleted, marked “to be disabled and deleted” or remains in “enabled” state and a failure is indicated in the signed eUICC Package execution result.

If the Target Profile is deleted, all the associated data of this Profile is deleted.

The signed eUICC Package execution result data structure containing the result of Delete Profile is stored in the eUICC.

3.4.4 Configure Automatic Profile Enabling by eIM

This procedure defines the execution of a configureAutoEnable command contained within an eUICC Package as defined in 3.3.1 Generic eUICC Package Download and Execution, used to activate or deactivate automatic Profile enabling in the eUICC and to add or update automatic enabling data used in the automatic Profile enabling using default SM-DP+.

Diagram source (PlantUML)
@startuml

skinparam monochrome true

skinparam ArrowColor Black

skinparam lifelinestrategy solid

skinparam sequenceMessageAlign center

skinparam noteBackgroundColor #FFFFFF

skinparam participantBackgroundColor #FFFFFF

hide footbox

participant "<b>eUICC\n<b>IPA Services (ISD-R)" as IPAServices

rnote over IPAServices

[1] Activate/deactivate automatic Profile enabling

endrnote

rnote over IPAServices

[2] Store automatic enabling data if present in the command

endrnote

rnote over IPAServices

[3] Generate configureAutoEnable PSMO execution result data structure (configureAutoEnableResult)

endrnote

@enduml

[Table Description automatically generated]

16.: Configure Automatic Profile Enabling by eIM

Start Conditions:

An eUICC Package containing a 'configureAutoEnable' command was received within an "ES10b.LoadEuiccPackage" by the eUICC.

The eIM signature, the EID, and replay counter has been verified (see 3.3.1 Generic eUICC Package Download and Execution).

Procedure:

1.If autoEnableFlag is present and automatic Profile enabling is not activated, the ISD-R SHALL activate automatic Profile enabling. If autoEnableFlag is not present and automatic Profile enabling is activated, the ISD-R SHALL deactivate automatic Profile enabling. In all other cases, the automatic Profile enabling state is left unchanged.

2.If present, the ISD-R SHALL store automatic enabling data (smdpOid and smdpAddress for default SM-DP+) for use in the automatic Profile enabling.

3.The eUICC SHALL generate the PSMO execution result data structure indicating the result of the PSMO 'Configure Automatic Profile Enabling' and the procedure continues as described in section 3.3.1.

3.4.5 Configure Automatic Profile Enabling by IPA

This procedure describes the procedure to configure automatic Profile enabling using default SM-DP+ requested by IPA.

Diagram source (PlantUML)
@startuml

skinparam monochrome true

skinparam ArrowColor Black

skinparam lifelinestrategy solid

skinparam sequenceMessageAlign center

skinparam noteBackgroundColor #FFFFFF

skinparam participantBackgroundColor #FFFFFF

hide footbox

participant "<b>IPA" as IPA

participant "<b>eUICC (ISD-R)" as eUICC

IPA -> eUICC : [1] ES10b.ConfigureAutomaticProfileEnabling([autoEnableFlag],[smdpOid],[smdpAddress])

alt If any eIM Configuration Data is already present in the eUICC

eUICC --> IPA : [2] error

else Otherwise

rnote over eUICC

[3] Activate/deactivate automatic Profile enabling

[4] Store the automatic enabling data (smdpOid and smdpAddress), if present

end rnote

eUICC --> IPA : [5] OK

end

@enduml

[Table Description automatically generated]

17.: Configure Automatic Profile Enabling by IPA

Start Conditions:

The eUICC does not contain any eIM Configuration Data.

Procedure:

1.The IPA calls "ES10b.ConfigureAutomaticProfileEnabling" function optionally comprising autoEnableFlag, smdpOid, and smdpAddress.

2.If any eIM Configuration Data is already present in the eUICC, the eUICC SHALL return an error and the procedure SHALL stop. Otherwise, the procedure continues in step (3).

3.If autoEnableFlag is present and automatic Profile enabling is not activated, the eUICC SHALL activate automatic Profile enabling. If autoEnableFlag is not present and automatic Profile enabling is activated, the eUICC SHALL deactivate automatic Profile enabling. In all other cases, the automatic Profile enabling state is left unchanged.

4.If present, the eUICC SHALL store automatic enabling data (smdpOid and smdpAddress for default SM-DP+) for use in the automatic Profile enabling.

5.The eUICC returns ok to the IPA.

3.5 eIM Configuration at eUICC

3.5.1 eIM Configuration Data managed by eIM

This section describes the procedures related to managing eIM Configuration Data requested by the eIM. All the initiated requests by the eIM SHALL be signed by an Associated eIM and verified by the eUICC.

The eIM initiated procedures are to:

-Add a new eIM Configuration Data.

-Delete an existing eIM Configuration Data.

-Update an existing eIM Configuration Data.

3.5.1.1 Addition of eIM Configuration Data

Diagram source (PlantUML)
@startuml

skinparam monochrome true

skinparam ArrowColor Black

skinparam lifelinestrategy solid

skinparam sequenceMessageAlign center

skinparam noteBackgroundColor #FFFFFF

skinparam participantBackgroundColor #FFFFFF

hide footbox

participant "<b>eUICC (ISD-R)" as eUICC

rnote over eUICC

[1] Add eIM Configuration Data to eUICC storage

end rnote

rnote over eUICC

[2] Generate addEIM eCO execution result data structure (addEimResult)

endrnote

@enduml

[PlantUML diagram]

18.Addition of eIM Configuration Data

Start Conditions:

-A eUICC Package containing an 'addEim' was received within an "ES10b.LoadEuiccPackage" by the eUICC.

-The eUICC contains eIM Configuration Data of at least one Associated eIM and the eUICC Package was verified as defined in section 3.3.1.

Procedure:

1.Upon successful verifications of the eUICC Package (see section 3.3.1), the ISD-R SHALL add the eIM Configuration Data of the new eIM to its list of Associated eIMs. The eUICC SHALL stop the procedure indicating a failure if:

a.the eUICC does not have sufficient memory to store the new eIM (“eimInsufficientMemory”)

b.no eimId is provided in the eUICC Package (“commandError”)

c.the provided eimId belongs to an eIM already associated with the eUICC (“commandError”)

d.the provided euiccCiPKId is not an entry within euiccCiPKIdListForSigning in eUICCInfo2 (“ciPKUnknown”)

e.any other error during command execution occurs (“undefinedError”).

2.The procedure continues as defined in section 3.3.1.

End Conditions:

eIM Configuration Data of the new eIM is added to the list of Associated eIMs within the eUICC.

The new eUICC is added to the list of eUICCs within the eIM.

3.5.1.2 Deletion of eIM Configuration Data

Diagram source (PlantUML)
@startuml

skinparam monochrome true

skinparam ArrowColor Black

skinparam lifelinestrategy solid

skinparam sequenceMessageAlign center

skinparam noteBackgroundColor #FFFFFF

skinparam participantBackgroundColor #FFFFFF

hide footbox

participant "<b>eUICC (ISD-R)" as eUICC

rnote over eUICC

[1] Find target eIM

end rnote

rnote over eUICC

[2] Remove eIM Configuration Data from eUICC

endrnote

rnote over eUICC

[3] Generate deleteEim eCO execution result data structure (deleteEimResult)

endrnote

@enduml

[PlantUML diagram]

19.Deletion of eIM Configuration Data

Start Conditions:

-A eUICC Package containing a 'deleteEim' was received within an "ES10b.LoadEuiccPackage" by the eUICC.

-The eUICC contains eIM Configuration Data of at least one Associated eIM and the verifications as defined in section 3.3.1 were performed.

Procedure:

1.Upon successful verifications of the eUICC Package (see section 3.3.1), the ISD-R SHALL find the eIM Configuration Data of the target eIM in its list of Associated eIMs. The eUICC SHALL stop the procedure indicating a failure if:

a.the eUICC does not find the eimId within its list of Associated eIMs (“eimNotFound”)

b.in case no eimId is provided in the eUICC Package (“commandError”)

c.any other error during command execution occurs (“undefinedError”).

2.The eUICC SHALL remove the eIM Configuration Data from its list of Associated eIMs. If the target Associated eIM to be deleted is the requesting eIM, the eUICC SHALL include the relevant information into the eCO execution result and SHALL only delete the eIM Configuration Data after the eCO execution result was generated and signed. If the target Associated eIM to be deleted is the last available Associated eIM within the eUICC, the eUICC SHALL set its state such, that it allows for addition of eIM Configuration Data using Unsigned eCO and SHALL return “lastEimDeleted” within its eCO execution result.

3.The procedure continues as defined in section 3.3.1.

End Conditions:

eIM Configuration Data of the target eIM is deleted from the list of Associated eIMs within the eUICC.

3.5.1.3 Update of eIM Configuration Data

Diagram source (PlantUML)
@startuml

skinparam monochrome true

skinparam ArrowColor Black

skinparam lifelinestrategy solid

skinparam sequenceMessageAlign center

skinparam noteBackgroundColor #FFFFFF

skinparam participantBackgroundColor #FFFFFF

hide footbox

participant "<b>eUICC (ISD-R)" as eUICC

rnote over eUICC

[1] Update eIM Configuration Data in eUICC storage

end rnote

rnote over eUICC

[2] Generate updateEim eCO execution result data structure (updateEimResult)

endrnote

@enduml

[Graphical user interface, application, table Description automatically generated]

20.Update of eIM Configuration Data

Start Conditions:

-A eUICC Package containing an 'updateEim' was received within an "ES10b.LoadEuiccPackage" by the eUICC.

-The eUICC contains eIM Configuration Data of at least one Associated eIM and the eUICC Package was verified as defined in section 3.3.1.

Procedure:

1.Upon successful verifications of the eUICC Package (see section 3.3.1), the ISD-R SHALL update the eIM Configuration Data of the eIM addressed by the provided

“eimID”. The eUICC SHALL stop the procedure indicating a failure if:

a.the eIM cannot be found in the list of Associated eIMs or no “eimID” is provided in the eUICC Package (“eimNotFound”)

b.neither the “counterValue” nor the “eimPublicKeyData” are included in the eUICC Package (“commandError”)

c.the “counterValue” is updated to a value lower than the currently stored value while the “eimPublicKeyData” are not updated (“commandError”).

d.the provided euiccCiPKId is not an entry within euiccCiPKIdListForSigning in eUICCInfo2 (“ciPKUnknown”)

e.any other error during command execution occurs (“undefinedError”)

2.The procedure continues as defined in section 3.3.1.

End Conditions:

The eIM Configuration Data of the targeted eIM is updated within the list of Associated eIMs within the eUICC.

3.5.1.4 Request for a list of Associated eIMs

Diagram source (PlantUML)
@startuml

skinparam monochrome true

skinparam ArrowColor Black

skinparam lifelinestrategy solid

skinparam sequenceMessageAlign center

skinparam noteBackgroundColor #FFFFFF

skinparam participantBackgroundColor #FFFFFF

hide footbox

participant "<b>eUICC (ISD-R)" as eUICC

rnote over eUICC

[1] List associated eIMs (listEim)

end rnote

rnote over eUICC

[2] Generate listEim eCO execution result data structure (listEimResult)

endrnote

@enduml

[Graphical user interface, text, application, table Description automatically generated]

21.Request for a list of Associated eIMs

Start Conditions:

-A eUICC Package containing a 'listEim' was received within an "ES10b.LoadEuiccPackage" by the eUICC.

-The eUICC contains eIM Configuration Data of at least one Associated eIM and the eUICC Package was verified as defined in section 3.3.1.

Procedure:

1.Upon successful verifications of the eUICC Package (see section 3.3.1), the ISD-R SHALL provide as a result the eIM identifier(s) of Associated eIM(s).

2.The procedure continues as defined in section 3.3.1.

End Conditions:

The eIM identifier of Associated eIM(s) can be provided through the signed eUICC Package Result to the IPA and via eIM Package Result to the eIM.

3.5.2 eIM Configuration Data managed by IPA

This section describes the procedures related to managing eIM Configuration Data requested by the IPA. All the initiated requests by the IPA SHALL be protected as per the ES10 security.

The IPA initiated procedures are to:

-Add of an initial eIM Configuration Data.

-Complete removal of eIM Configuration Data.

NOTE: The protection of IPA initiated request is implementation specific under the responsibility of IoT Device manufacturer.

3.5.2.1 Addition of initial eIM Configuration Data

Diagram source (PlantUML)
@startuml

skinparam monochrome true

skinparam ArrowColor Black

skinparam lifelinestrategy solid

skinparam sequenceMessageAlign center

skinparam noteBackgroundColor #FFFFFF

skinparam participantBackgroundColor #FFFFFF

hide footbox

participant "<b>IPA" as IPA

participant "<b>eUICC (ISD-R)" as eUICC

IPA -> eUICC : [1] ES10b.AddInitialEim(EimConfigurationData)

alt If any eIM Configuration Data is already present in the eUICC

eUICC --> IPA : [2] error

else Otherwise

rnote over eUICC

[3] Store the eIM Configuration Data

end rnote

eUICC --> IPA : [4] AddInitialEimResponse

end

@enduml

[Table Description automatically generated]

22.Addition of initial eIM Configuration Data

Start Conditions:

-The eUICC does not contain any eIM Configuration Data.

Procedure:

1.The IPA calls "ES10b.AddInitialEim" function comprising eIM Configuration Data (EimConfigurationData).

2.If any eIM Configuration Data is already present in the eUICC, the eUICC SHALL return an error and the and the procedure SHALL stop. Otherwise, the procedure continues in step (3).

3.If requested, the eUICC SHALL calculate the association token and store it together with the eIM Configuration Data.

4.The eUICC returns the AddInitialEimResponse to the IPA.

End Conditions:

-The eUICC is associated with the eIM as per the eIM Configuration Data.

NOTE: In case IPAe is used, the addition of initial eIM Configuration Data uses the EimConfigurationData structure. How the eIM Configuration Data is sent to the eUICC is implementation specific.

3.5.2.2 Deletion of all eIM Configuration Data

Diagram source (PlantUML)
@startuml

skinparam monochrome true

skinparam ArrowColor Black

skinparam lifelinestrategy solid

skinparam sequenceMessageAlign center

skinparam noteBackgroundColor #FFFFFF

skinparam participantBackgroundColor #FFFFFF

hide footbox

participant "<b>IPA" as IPA

participant "<b>eUICC (ISD-R)" as eUICC

IPA -> eUICC : [1] ES10b.EuiccMemoryReset(resetEimConfigData)

rnote over eUICC

[2] Removes all eIM Configuration Data

end rnote

eUICC --> IPA : [3] ok or nothingToDelete

@enduml

[Graphical user interface, text, application Description automatically generated]

23.:Deletion of all eIM Configuration Data

Start Conditions:

-None

Procedure:

1.The IPA calls "ES10b.EuiccMemoryReset" function with resetEimConfigData bit set to one.

2.The eUICC removes all eIM Configuration Data.

3.The eUICC returns ok or nothingToDelete.

End Conditions:

-The eUICC does not contain any eIM Configuration Data.

3.5.2.3 Reading eIM Configuration Data

Diagram source (PlantUML)
@startuml

skinparam monochrome true

skinparam ArrowColor Black

skinparam lifelinestrategy solid

skinparam sequenceMessageAlign center

skinparam noteBackgroundColor #FFFFFF

skinparam participantBackgroundColor #FFFFFF

hide footbox

participant "<b>IPA" as IPA

participant "<b>eUICC (ISD-R)" as eUICC

IPA -> eUICC : [1] ES10b.GetEimConfigurationData

eUICC --> IPA : [2] List of EimConfigurationData

@enduml

[Graphical user interface, text, application, email Description automatically generated]

24.: Reading eIM Configuration Data by IPA

Start Conditions:

-None

Procedure:

1.The IPA calls "ES10b.GetEimConfigurationData" function.

2.The eUICC returns the list of eIM Configuration Data stored in the eUICC to the IPA.

End Conditions:

-None

3.6 Error handling within an RSP session

The RSP sessions comprise a sequence of operations between the SM-DP+, the IPA, the eUICC, and/or the eIM over a period of time. In addition to errors reported by ES9+, ES9+', ES10 and/or ESipa functions, other conditions MAY impact the successful execution of this procedure. The IPA SHOULD indicate such failures to external entities, e.g., a device management platform; however, the specific presentation of these errors is out of the scope of this document.

The IPA SHOULD NOT initiate a new RSP session while there is an active RSP session. However, in the event that this does occur, the eUICC SHALL discard its session state with the possible exception that unused one-time keys MAY be stored for future retries, when a new RSP session is started with "ES10b.GetEUICCChallenge".

If an eUICC Memory Reset or eUICC Test Memory Reset is successfully processed during an RSP session, the eUICC SHALL discard its session state.

An RSP Session MAY fail because of a communications failure between the IPA and the RSP Server, or the IPA and the eIM. The IPA MAY retry the failed RSP session for a period of time. The IPA SHALL reset its own session state when all retry attempts have failed.

An RSP Session could fail while the IPA is invoking an ES10 function for reasons other than an error status reported by the eUICC. Examples of such failures include:

-In the case of a removable eUICC card, the card is unexpectedly removed.

-The IoT Device is powered off, e.g., by running out of the battery or by the user.

-A software fault could cause a crash of the IPA, host IoT Device, and/or baseband processor.

When possible (e.g., when power is restored), the IPA SHOULD provide an appropriate error indication to external entities, e.g., the device management platform, and MAY restart the relevant procedure. The specific presentation of such an error Notification is out of scope of this document.

3.7 Notification Delivery to Notification Receivers

This procedure describes the delivery of Notifications to Notification Receivers. Notifications MAY also be delivered together with an eUICC Package Result as described in Section 3.3.1.

Diagram source (PlantUML)
@startuml

skinparam monochrome true

skinparam ArrowColor Black

skinparam lifelinestrategy solid

skinparam sequenceMessageAlign center

skinparam noteBackgroundColor #FFFFFF

skinparam participantBackgroundColor #FFFFFF

skinparam ParticipantPadding 70

hide footbox

participant "<b>SM-DP+" as DP

participant "<b>eIM" as eIM

participant "<b>IPAd" as IPA

participant "<b>eUICC" as E

IPA -> E : [1] ES10b.RetrieveNotificationsList

E -> IPA : List of pending Notifications

group If pending Notifictions to be delivered

group For each pending Notification

alt [2a] Direct ES9+ interface to SM-DP+

IPA -> DP : ES9+.HandleNotification

DP -> IPA : ACK

else [2b] No direct ES9+ interface to SM-DP+

IPA -> eIM : ESipa.HandleNotification

eIM -> IPA : ACK

eIM -> DP : ES9+’.HandleNotification

DP -> eIM : ACK

end

IPA -> E : [3] ES10b.RemoveNotificationFromList

rnote over E: [4] Delete Notification

end

end

@enduml

[Diagram Description automatically generated]

25.: Notification Delivery to Notification Receivers

Start Condition:

This procedure requires the following start conditions:

-A Secure Connection between the eIM and the IPAd is established.

-Either a profile installation or a PSMO has been executed such that one or more Notifications MAY have been generated by the eUICC.

-IPAd is configured to send Notifications using ES9+.HandleNotification or ESipa.HandleNotification.

Procedure:

1.The IPAd SHALL retrieve pending Notifications by calling the ES10b.RetrieveNotificationsList function.

2.In case of a non-empty list of pending Notifications, IPAd SHALL deliver the pending Notifications to the Notification Receivers:

a.If a direct ES9+ interface to the SM-DP+ is used to deliver Notifications, the IPAd SHALL send the Notifications by using the ES9+.HandleNotification function as described in section 5.6.4 of SGP.22 [4].

b.If Notifications are delivered via the eIM to the SM-DP+, the IPAd SHALL send the Notifications to the eIM by using the ESipa.HandleNotification function as described in section 5.14.7 of this document and the eIM SHALL forward them to the Notification Receivers by using the ES9+’.HandleNotification function as described in section 5.7.4 of this document. In case of an IPAd with IPA Capability minimizeEsipaBytes the IPAd SHOULD send Notifications in compact format as described in Section 5.14.7. An eIM receiving a pending Notification in compact format SHALL identify the relevant information and build the full pending Notification before forwarding the Notification to the Notification Receiver.

3.IPAd SHALL call ES10b.RemoveNotificationFromList (see SGP.22 [4]) to delete the pending Notification for which acknowledgement has been received.

4.The eUICC SHALL delete the pending Notification.

3.8 IoT Device and eUICC Initialisation

The IoT Device and eUICC SHALL be initialised according to SGP.22 [4] sections 3.4.1, 3.4.2, 3.4.3 and 5.7.1.

3.9 SM-DS Use

3.9.1 Event Registration

Event Registration SHALL follow the procedure defined in section 3.6.1 of SGP.22 [4].

3.9.2 Event Retrieval

3.9.2.1 Event Retrieval by the IPA

The Event Retrieval by the IPA SHALL follow the procedure defined in section 3.6.2 of SGP.22 [4]. The IPA plays the role of the LPA.

3.9.2.2 Event Retrieval by the eIM

This section describes the indirect Event retrieval from SM-DS to eIM.

Diagram source (PlantUML)
@startuml

hide footbox

skinparam sequenceMessageAlign center

skinparam sequenceArrowFontSize 11

skinparam noteFontSize 11

skinparam monochrome true

skinparam lifelinestrategy solid

participant "<b>SM-DS" as DS

participant "<b>eIM" as EIM

participant "<b>IPA" as IPA

participant "<b>eUICC" as E

group If IPA obtains a profile download trigger from eIM Package

alt IPA-initiated

rnote over EIM, IPA : [1a] eIM Package Retrieval Procedure including secure connection establishment (section 3.1.1.1)

else eIM-initiated

rnote over EIM, IPA : [1b] eIM Package Injection Procedure including secure connection establishment (section 3.1.1.2)

end

rnote over IPA : [2] IPA parses the eIM Package and obtains profile \ndownload trigger

end

opt Get euiccInfo1 if not yet retrieved by IPA or eIM

IPA -> E : [3] ES10b.GetEuiccInfo

E --> IPA : euiccInfo1

end

IPA -> E : [4] ES10b.GetEuiccChallenge

E -> IPA : euiccChallenge

group If a secure connection is not yet established

rnote over EIM, IPA : [5] Establish secure connection

end

IPA -> EIM : [6] ESipa.InitiateAuthentication request

rnote over EIM, DS : [7] Establish HTTPS connection

rnote over EIM, DS : [8] ES11'.InitiateAuthentication function

EIM -> IPA : [9] ESipa.InitiateAuthentication response

rnote over IPA, E: [10] ES10b.AuthenticateServer function

IPA -> EIM : [11] ESipa.AuthenticateClient request

rnote over EIM, DS : [12] ES11'.AuthenticateClient function

rnote over EIM : [13] Parse Event entry/ies \nobtained from the SM-DS

EIM -> IPA : [14] ESipa.AuthenticateClient response

@enduml

[Diagram Description automatically generated]

26.: Event Retrieval by the eIM

Start Conditions:

In addition to the start conditions required by the Common Mutual Authentication procedure defined in section 3.1.2 of SGP.22 [4], this procedure requires the following start condition:

The eIM and/or the IPA has the SM-DS Address.

Procedure:

1.In case a Profile download trigger from an eIM Package: a secure connection is established between the IPA and the eIM for IPA to obtain the eIM Package. How this is triggered is out of scope of this specification. There are two options for the delivery of the eIM Package to the IPA:

a)The eIM Package Retrieval Procedure defined in section 3.1.1.1 is executed between the IPA and the eIM.

b)The eIM Package Injection Procedure defined in section 3.1.1.2 is executed between the IPA and the eIM.

2.The IPA parses the eIM Package received in step 1. The IPA identifies that the eIM Package contains a ProfileDownloadTriggerRequest. To trigger event retrieval from the SM-DS, the ProfileDownloadTriggerRequest is either an empty data object (i.e., without profileDownloadData) or contains a profileDownloadData with contactSmds. In the first case the IPA is not expected to provide SM-DS FQDN in step (6) whereas in the latter case the IPA is expected to provide SM-DS FQDN in step (6). If the format of ProfileDownloadTriggerRequest is invalid, or data needed by IPA for the event retrieval is missing, the procedure SHALL stop.

3.If euiccInfo1 is not yet retrieved by the eIM or IPA, the IPA MAY request euiccInfo1 from the eUICC by calling ES10b.GetEuiccInfo (see section 5.9.2).

4.The IPA requests an eUICC Challenge from the eUICC by calling the ES10b.GetEUICCChallenge function (see section 5.9.3).

5.A secure connection is established between the IPA and the eIM if it is not yet established.

6.The IPA calls ESipa.InitiateAuthentication function comprising eUICC Challenge, optionally SM-DS FQDN, and optionally euiccInfo1 (see IPA Capability minimizeEsipaBytes). If the IPA does not provide SM-DS FQDN or euiccInfo1, the eIM SHALL identify the relevant information.

7.The eIM establishes an HTTPS connection with the SM-DS in server authentication mode according to SGP.22 [4].

8.The eIM and the SM-DS process ES11'.InitiateAuthentication function comprising eUICC Challenge, SM-DS FQDN, and euiccInfo1 as defined in section 5.6.1 of SGP.22 [4]. If the SM-DS FQDN provided in ES11'.InitiateAuthentication did not come from IPA (was not obtained from IPA in step 6 e.g., due to IPA has capability eimDownloadDataHandling), the eIM SHALL verify that this SM-DS FQDN matches the SM-DS FQDN returned by the SM-DS (in serverSigned1). If not, the procedure SHALL stop.

9.The eIM sends the ESipa.InitiateAuthentication response to the IPA, based on the ES11'.InitiateAuthentication response from the SM-DS. The eIM SHALL additionally provide ctxParams1 as defined in SGP.22 [4] if the IPA does not generate it. (see IPA capability eimCtxParams1Generation).

10.The IPA and eUICC process ES10b.AuthenticateServer function call as defined in section 5.7.13 of SGP.22 [4].

11.The IPA calls ESipa.AuthenticateClient function comprising euiccSigned1 or compactEuiccSigned1, euiccSignature1, optionally CERT.EUM.ECDSA, and optionally CERT.EUICC.ECDSA. If the IPA does not provide CERT.EUM.ECDSA and CERT.EUICC.ECDSA and/or provide the compactEuiccSigned1 instead of euiccSigned1 (see IPA Capability minimizeEsipaBytes), the eIM SHALL identify the relevant information and build euiccSigned1.

12.The eIM and SM-DS process the ES11'.AuthenticateClient function as defined in 5.6.3 of SGP.22 [4].

13.The eIM parses the Event entry/ies obtained from the ES11'.AuthenticateClient from the SM-DS.

14.The eIM sends the ESipa.AuthenticateClient response to the IPA, based on the ES11'.AuthenticateClient response from the SM-DS. In case of a successful ES11'.AuthenticateClient response the eIM sends only the transactionId (without including eventEntries). The eIM MAY include a ProfileDownloadTriggerRequest data object in order to trigger the IPA to start downloading a new Profile. In case of an error, IPA SHALL trigger the cancellation of the on-going RSP session (see section 3.2.3.3) with reason sessionAborted and the procedure SHALL stop.

3.9.3 Event Deletion

Event Deletion SHALL follow the procedure defined in section 3.6.3 of SGP.22 [4].

4 Data Elements

4.1 IPA Capabilities

The IPA Capabilities are intended for the eIM for the functional split related to profile download between the eIM and the IPA and the use of compact data object structures in ESipa functions. In addition, IPA Capabilities MAY indicate the support of eIM Package transfer including the type of connection over ESipa.

IPA Capabilities SHALL include:

-Support for direct profile download

-Support for indirect profile download

-Support for eIM handled download data (e.g. Activation Code) during indirect profile download.

-Support for eIM generated ctxParams1 during indirect profile download.

-Support for eIM performed Profile Metadata verification during indirect profile download.

-Use of compact data objects to minimize number of transferred ESipa bytes during indirect profile download.

IPA Capabilities MAY include support for eIM Package transfer over ESipa:

-eIM Package retrieval using HTTPs over TCP (see section 3.1.2.1)

-eIM Package retrieval using CoAP/DTLS over UDP (see section 3.1.2.2)

-eIM Package injection using HTTPs over TCP (see section 3.1.2.1)

-eIM Package injection using CoAP/DTLS over UDP (see section 3.1.2.2)

-proprietary

IPA Capabilities data object structure is defined as follows:

ASN.1 definitions
-- ASN1START

IpaCapabilities ::= SEQUENCE {

ipaFeatures [0] BIT STRING {

directRspServerCommunication (0),

indirectRspServerCommunication (1),

eimDownloadDataHandling (2),

eimCtxParams1Generation (3),

eimProfileMetadataVerification (4),

minimizeEsipaBytes (5)

},

ipaSupportedProtocols [1] BIT STRING {

ipaRetrieveHttps(0),

ipaRetrieveCoaps(1),

ipaInjectHttps(2),

ipaInjectCoaps(3),

ipaProprietary(4)

} OPTIONAL

}

-- ASN1STOP

ipaFeatures indicates the features supported by the IPA:

-The directRspServerCommunication set to 1 indicates that IPA supports direct Profile download according to Section 3.2.3.1. This includes direct delivery of Notifications to the SM-DP+.

-The indirectRspServerCommunication set to 1 indicates that IPA supports indirect Profile download according to Section 3.2.3.2. This includes delivery of Notifications via the eIM to SM-DP+.

-An IPA supporting indirect profile download MAY further have the following capabilities:

-The eimDownloadDataHandling set to 1 indicates that IPA does not handle download data such as Activation Codes, SM-DP+ data retrieved from SM-DS, and default SM-DP+ address during indirect Profile download and expects Activation Codes and Event Records to remain at the eIM where the eIM parses and extracts the relevant data such as SM-DP+ address, matchingId, and SM-DP+ OID for use in ESipa.InitiateAuthentication.

-The eimCtxParams1Generation set to 1 indicates that IPA does not support generation of CtxParams1 and expects the eIM to generate and provide CtxParams1 to IPA as part of ESipa.InitiateAuthentication.

-The eimProfileMetadataVerification set to 1 indicates that IPA does not support verification of Profile Metadata and expects the eIM to verify Profile Metadata as part of ESipa.AuthenticateClient. It is also expected that eIM checks as part of ESipa.GetBoundProfilePackage that the Profile Metadata provided in the BPP matches the Profile Metadata in ESipa.AuthenticateClient.

-The minimizeEsipaBytes set to 1 indicates that IPA uses compact data objects and avoids sending data over ESipa that the other party already knows in order to minimize the number of transmitted bytes between IPA and eIM. It is expected that the eIM is able to identify missing parts (bytes) and re-build full data object structures. The eIM MAY leverage pre-configured static eUICC data, eUICC data obtained from another IoT Device within the same batch for which the data is common, eUICC data read from the IoT Device, and session data obtained from the SM-DP+. For more information refer to the profile download related ESipa function descriptions in Section 5.14.

ipaSupportedProtocols indicates which eIM Package transfer (see 3.1.1) is supported by the IPA:

-ipaRetrieveHttps set to 1 indicates support for eIM Package retrieval (see section 3.1.1.1) using HTTPs over TCP as described in section 3.1.2.1

-ipaRetrieveCoaps set to 1 indicates support for eIM Package retrieval (see section 3.1.1.1) using CoAP/DTLS over UDP as described in section 3.1.2.2

-ipaInjectHttps set to 1 indicates support for eIM Package injection (see section 3.1.1.2) using HTTPs over TCP as described in section 3.1.2.1

-ipaInjectCoaps set to 1 indicates support for eIM Package injection (see section 3.1.1.2) using CoAP/DTLS over UDP as described in section 3.1.2.2

ipaProprietary set to 1 indicates support of a transport protocol not described in section 3.1.2.

The eIM SHALL obtain IPA Capabilities to determine whether it is able to support profile download and profile management for the particular IoT Device/IPA. IPA Capabilities MAY be obtained out-of-band from the IoT Device owner/user, or it MAY be requested from IPA in an eIM Package.

4.2 eIM Supported Protocol

EimSupportedProtocol indicates which transport protocol, and eIM Package transfer method is supported by the eIM over ESipa. eimRetrieveHttps set to 1 indicates support for eIM Package retrieval (see section 3.1.1.1) using HTTPs over TCP as described in section 3.1.2.1

-eimRetrieveCoaps set to 1 indicates support for eIM Package retrieval (see section 3.1.1.1) using CoAP/DTLS over UDP as described in section 3.1.2.2

-eimInjectHttps set to 1 indicates support for eIM Package injection (see section 3.1.1.2) using HTTPs over TCP as described in section 3.1.2.1

-eimInjectCoaps set to 1 indicates support for eIM Package injection (see section 3.1.1.2) using CoAP/DTLS over UDP as described in section 3.1.2.2

-eimProprietary set to 1 indicates support of a transport protocol not described in section 3.1.2.

4.3 eIM Identifier

The eimId is an eIM identifier that SHALL exist uniquely within the eUICC’s list of Associated eIMs. The eimId is a text string (ASN.1 type UTF8String) as shown in section 2.11.1.1.1 and section 2.11.1.1.2. The total length of the eimId SHALL not exceed 128 Bytes.

The eimId text string MAY be of the following types as defined by EimIdType in section 2.11.1.1.1: OID, FQDN, and Proprietary.

Where an eIM operator holds or can request an OID assignment, an eIM OID SHOULD be allocated to the eIM and used to encode the eimId.

An eimId of type eimIdTypeOid SHALL be encoded using the OID, as allocated by https://www.iana.org/assignments/enterprise-numbers/enterprise-numbers, with the following child nodes:

-eim (999): indicates that this is an eIM.

-eimOwner (x): identifies the eIM owner, where “x” is freely chosen by the eimOwner.

NOTE: If the eIM owner is identical to the enterprise indicated in the OID prefix, the same value can be used.

-eimInstance (y): identifies an eIM instance, where “y” is freely chosen by the eimOwner.

NOTE: Prefix is iso.org.dod.internet.private.enterprise (1.3.6.1.4.1).

NOTE: An example OID “iso.org.dod.internet.private.company.eim.eimowner.124” is encoded as follows: “1.3.6.1.4.12345.999.10.124”.

An eimId of type eimIdTypeFqdn SHALL be encoded as a FQDN.

NOTE: An example could be: “eim.enterprise.com”.

For an eimId of type eimIdTypeProprietary the eimId value can be freely chosen, following the requirements set out in this section.

5 Functions

5.1 Overview of Functions per Interface

This section provides the description of the interfaces and functions within the Remote SIM Provisioning and Management system involving the eUICC, including the following:

eUICC Interfaces

-ES6: The interface used by the Operator to manage the content of their Profile.

-ES8+: Provides a secure end-to-end channel between the SM-DP+ and the eUICC for the administration of the ISD-P and the associated Profile during download and installation.

-ES9+: Used to provide a secure transport between the SM-DP+ and the IPAe for the delivery of the Profile Package.

-ES10a: Used by the IPAd to get the configured addresses from the eUICC for Root SM-DS, and optionally the default SM-DP+.

-ES10b: Used by the IPAd to transfer a Profile Package to the eUICC.

-ES11: Interface between the IPAe and an SM-DS (Alternative SM-DS or Root SM-DS) for the Event retrieval.

-ESipa: Interface between an eIM and an IPA used to trigger a Profile download at the IPA and to provide a secure transport for the delivery of eUICC Packages unless the underlying transport provides necessary security.

-ESep: Logical end-to-end interface between the eIM and the eUICC used to transfer eUICC Packages for Profile State Management and eIM configuration by eIM.

Server to Server Interfaces

-ES2+: Interface between the Operator and the SM-DP+ used by the Operator to order Profile Package preparation.

-ES12: Interface between the SM-DP+ and an SM-DS (Alternative SM-DS or Root SM-DS) for the Event management.

Device to RSP Server Interfaces

-ES9+: Used to provide a secure transport between the SM-DP+ and the IPAd for the delivery of the Profile Package.

-ES11: Interface between the IPAd and an SM-DS (Alternative SM-DS or Root SM-DS) for the Event retrieval.

eIM interfaces

-ES9+’: Used to provide a secure transport between the SM-DP+ and the eIM for the delivery of the Bound Profile Package.

-ESipa: Interface between an eIM and an IPA used to trigger a Profile download at the IPA and to provide a secure transport for the delivery of eUICC Packages unless the underlying transport provides necessary security.

-ESep: Logical end-to-end interface between the eIM and the eUICC used to transfer eUICC Packages for Profile State Management and eIM configuration by eIM.

-ES11’: Interface between the eIM and the SM-DS (Alternative SM-DS or Root SM-DS) for the Event retrieval.

The following table presents the normative list of all the functions that are defined in this section.

Request-Response Functions:

Interface

Functions

Function

provider Role

ES2+

As defined in section 5.3 of SGP.22 [4].

SM-DP+

ES6

As defined in section 5.2 of SGP.22 [4].

ISD-P

ES8+

As defined in section 5.5 of SGP.22 [4].

eUICC

ES9+

As defined in section 5.6 of SGP.22 [4].

SM-DP+

ES9+’

InitiateAuthentication

GetBoundProfilePackage

AuthenticateClient

HandleNotification

CancelSession

ES10a

As defined in section 5.7 of SGP.22 [4].

ISD-R (IPA Services)

GetEuiccConfiguredAddresses

ES10b

LoadEuiccPackage

ISD-R (IPA Services)

GetEUICCInfo

GetEUICCChallenge

AddInitialEim

eUICCMemoryReset

AuthenticateServer

PrepareDownload

LoadBoundProfilePackage

CancelSession

GetCerts

GetEID

RetrieveNotificationsList

RemoveNotificationFromList

GetRAT

GetProfilesInfo

EnableUsingDD

ProfileRollback

ConfigureAutomaticProfileEnabling

GetEimConfigurationData

ES11

As defined in section 5.8 of SGP.22 [4].

SM-DS

ES11’

As defined in section 5.8 of SGP.22 [4].

SM-DS

ES12

As defined in section 5.9 of SGP.22 [4].

SM-DS

ESipa

TransferEimPackage

IPA

InitiateAuthentication

eIM

GetBoundProfilePackage

AuthenticateClient

GetEimPackage

ProvideEimPackageResult

HandleNotification

CancelSession

ESep

Enable

eUICC

Disable

Delete

ListProfileInfo

GetRAT

ConfigureAutoEnable

AddEim

UpdateEim

DeleteEim

ListEim

3.: Request-Response Functions

Notification Handler Functions:

Interface

Notification handler functions

Function

handler/recipient

ES2+

As defined in section 5.3 of SGP.22 [4].

Operator

ES9+

HandleNotification

SM-DP+

ES9+’

HandleNotification

SM-DP+

ESipa

HandleNotification

eIM

4.: Notification Handler Functions

5.2 Server to Server Function Commonalities

Each function represents an entry point that is provided by a Role (function provider), and that can be called by other Roles (function requester).

5.2.1 Common Data Types

  -----------------------------------------------------------------------
  Type name     Description                       Type definition
  ------------- --------------------------------- -----------------------

  -----------------------------------------------------------------------

5.: Common data types

5.2.2 Request-Response Function

As defined in section 5.2.2 of SGP.22 [4].

5.2.3 Notification Handler Function

As defined in section 5.2.3 of SGP.22 [4].

5.2.4 Functions Input Header

As defined in section 5.2.4 of SGP.22 [4].

5.2.5 Functions Output Header

As defined in section 5.2.5 of SGP.22 [4].

5.2.6 Status Code

This specification relies on subject codes and reason codes as defined in section 5.2.6 of SGP.22 [4]. In addition, this specification defines additional codes.

5.2.6.1 Subject Code

Hereunder are listed the subject codes used in this specification:

1.Generic (as defined in SGP.02 [6])

1.1. Function Requester (as defined in SGP.02 [6])

1.2. Function Provider (as defined in SGP.02 [6])

1.3. Protocol (as defined in SGP.02 [6])

1.3.1. Protocol Format (as defined in SGP.02 [6])

1.3.2. Protocol Version (as defined in SGP.02 [6])

1.6. Function (as defined in SGP.02 [6])

8.eUICC Remote Provisioning (as defined in SGP.02 [6])

8.1. eUICC (as defined in SGP.02 [6])

8.1.1. EID (as defined in SGP.02 [6])

8.1.2. EUM Certificate (as defined in SGP.22 [4])

8.1.3. eUICC Certificate (as defined in SGP.22 [4])

8.2. Profile (as defined in SGP.02 [6])

8.2.1. Profile ICCID (as defined in SGP.02 [6])

8.2.5. Profile Type (as defined in SGP.02 [6])

8.2.6. Matching ID (as defined in SGP.22 [4])

8.2.7. Confirmation Code (as defined in SGP.22 [4])

8.2.8. PPR (as defined in SGP.22 [4])

8.2.9. Profile Metadata (as defined in SGP.22 [4])

8.2.10. Bound Profile Package (as defined in SGP.22 [4])

8.8. SM-DP+ (as defined in SGP.22 [4])

8.8.1. SM-DP+ Address (as defined in SGP.22 [4])

8.8.2. Security configuration (as defined in SGP.22 [4])

8.8.3. Specification Version Number (SVN) (as defined in SGP.22 [4])

8.8.4. SM-DP+ Certificate (as defined in SGP.22 [4])

8.8.5 Download order (as defined in SGP.22 [4])

8.9. SM-DS (as defined in SGP.22 [4])

8.9.1. SM-DS Address (as defined in SGP.22 [4])

8.9.2. Security configuration (as defined in SGP.22 [4])

8.9.3. Specification Version Number (SVN) (as defined in SGP.22 [4])

8.9.4 SM-DS Certificate (as defined in SGP.22 [4])

8.9.5. Event Record (as defined in SGP.22 [4])

8.10. RSP Operation (as defined in SGP.22 [4])

8.10.1. TransactionId (as defined in SGP.22 [4])

8.11. GSMA CI (as defined in SGP.22 [4])

8.11.1. Public Key (PK) (as defined in SGP.22 [4])

5.2.6.2 Reason Code

Hereunder are listed the reason codes used in this specification:

1.Access Error (as defined in SGP.02 [6])

1.1. Unknown (Identification or Authentication) (as defined in SGP.02 [6])

1.2. Not Allowed (Authorisation) (as defined in SGP.02 [6])

2.Format Error (as defined in SGP.02 [6])

2.1. Invalid (as defined in SGP.02 [6])

2.2. Mandatory Element Missing (as defined in SGP.02 [6])

2.3. Conditional Element Missing (as defined in SGP.02 [6])

3.Conditions of Use Not Satisfied (as defined in SGP.02 [6])

3.1. Unsupported (as defined in SGP.02 [6])

3.3. Already in Use (Uniqueness) (as defined in SGP.02 [6])

3.7. Unavailable (as defined in SGP.02 [6])

3.8. Refused (as defined in SGP.02 [6])

3.9. Unknown (as defined in SGP.02 [6])

3.10. Invalid Association (as defined in SGP.22 [6])

3.11. Value has Changed (as defined in SGP.22 [6])

4.Processing Error (as defined in SGP.02 [6)

4.2. Execution Error (as defined in SGP.02 [6)

4.3. Stopped on Warning (as defined in SGP.02 [6])

4.8. Insufficient Memory (as defined in SGP.02 [6])

4.10 Time to Live Expired (as defined in SGP.22 [4])

5.Transport Error (as defined in SGP.02 [6])

5.1. Inaccessible (as defined in SGP.02 [6])

6.Security Error (as defined in SGP.02 [6])

6.1. Verification Failed (as defined in SGP.02 [26)

6.3. Expired (as defined in SGP.22 [4])

6.4. Maximum number of retries exceeded (as defined in SGP.22 [4])

5.2.6.3 Common Function Status Code

As defined in SGP.02 [6].

5.3 ES2+ (Operator -- SM-DP+)

ES2+ is the interface between:

-The Operator.

-SM-DP+

This interface is used by the Operator to order the Profile Package preparation for specific eUICC(s) and the delivery of the Profile Package from the SM-DP+. This interface is identical to the one defined in section 5.3 of SGP.22 [4].

5.4 ES6 (Operator -- eUICC)

ES6 is the interface between:

-The Operator.

-eUICC (Enabled Profile)

This interface is used by the Operator to make modifications on their Profile in the eUICC using legacy OTA mechanisms. This interface is identical to the one defined in section 5.4 of SGP.22 [4].

NOTE : SCP80 over SMS might not be supported in ES6 in case of NCD.

5.5 ES8+ (SM-DP+ -- eUICC)

The ES8+ is the interface between:

-The SM-DP+ (Profile Package Binding function).

-The eUICC.

This interface is intended to be tunnelled either over:

-the ES9+ and ES10b interfaces for direct profile download (i.e., the IPA directly communicates with the SM-DP+) as shown in Figure 19 or

-ES9+', ESipa, and ES10b for indirect profile download (i.e., the IPA communicates with the SM-DP+ via the eIM) as shown in Figure 20.

[Figure not reproduced — see the original document]

27.: ES8+ interface through ES9+ and ES10b

[Figure not reproduced — see the original document]

28.: ES8+ through ES9+’ ESipa, and ES10b

The ES8+ functions are addressed to the eUICC through a secure channel established between the Profile Package Binding function of the SM-DP+ and the eUICC.

All the functions related to ES8+ SHALL be processed as defined in section 5.5 of SGP.22 [4]. They are called by the SM-DP+ and executed by the eUICC.

5.6 ES9+ (IPA -- SM-DP+)

ES9+ is the interface between:

•The IPA entity.

•The SM-DP+

The IPA SHALL communicate with the SM-DP+ secured by HTTPS in server authentication mode as described in SGP.22 [4] section 2.6.6.

This interface is identical to the ES9+ interface defined in section 5.6 of SGP.22 [4], where the IPA plays the role of LPA.

5.7 ES9+’ (eIM -- SM-DP+)

ES9+’ is the interface between:

-The eIM entity.

-The SM-DP+.

The eIM SHALL communicate with the SM-DP+ secured by HTTPS in server authentication mode as described in SGP.22 [4] section 5.6 using the TLS requirements in SGP.22 [4] section 2.6.6.

5.7.1 Function (ES9+’): InitiateAuthentication

Related Procedures: Profile Download and Installation

Function Provider Entity: SM-DP+

Description:

This function SHALL be called by the eIM to authenticate the SM-DP+.

This function is identical to the ES9+.InitiateAuthentication function defined in section 5.6.1 of SGP.22 [4], where the eIM plays the role of LPA. In addition, in case the IPA has sent all the necessary input data in ESipa.InitiateAuthentication request, the eIM SHALL forward it as ES9+'.InitiateAuthentication request. Otherwise, the eIM SHALL complete the missing input data as described in ES9+.InitiateAuthentication function.

5.7.2 Function (ES9+’): GetBoundProfilePackage

Related Procedures: Profile Download and Installation

Function Provider Entity: SM-DP+

Description:

This function SHALL be called by the eIM to request the delivery and the binding of a Profile Package for the eUICC.

This function is identical to the ES9+.GetBoundProfilePackage function defined in section 5.6.2 of SGP.22 [4], where the eIM plays the role of LPA.

5.7.3 Function (ES9+’): AuthenticateClient

Related Procedures: Profile Download and Installation

Function Provider Entity: SM-DP+

Description:

This function SHALL be called by the eIM to request the authentication of the eUICC by the SM-DP+.

This function is identical to the ES9+.AuthenticateClient function defined in section 5.6.3 of SGP.22 [4], where the eIM plays the role of LPA.

5.7.4 Function (ES9+’): HandleNotification

Related Procedures: Profile Download and Installation

Function Provider Entity: SM-DP+

Description:

This function SHALL be called by the eIM to notify the SM-DP+ that a Profile Management Operation has successfully been performed on the eUICC.

This function is identical to the ES9+.HandleNotification function defined in section 5.6.4 of SGP.22 [4], where the eIM plays the role of LPA. In addition, in case the IPA has sent all the necessary input data in ESipa.HandleNotification request, the eIM SHALL forward it as ES9+'.HandleNotification request. Otherwise, the eIM SHALL complete the missing input data as described in ES9+.HandleNotification function.

5.7.5 Function (ES9+’): CancelSession

Related Procedures: Profile Download and Installation

Function Provider Entity: SM-DP+

Description:

This function SHALL be called by the eIM to request the cancellation of an on-going RSP session.

This function is identical to the ES9+.CancelSession function defined in section 5.6.5 of SGP.22 [4], where the eIM plays the role of LPA. In addition, in case the IPA has sent all the necessary input data in ESipa.CancelSession request, the eIM SHALL forward it as ES9+'.CancelSession request. Otherwise, the eIM SHALL complete the missing input data as described in ES9+.CancelSession function.

5.8 ES10a (IPA -- eUICC)

5.8.1 Function (ES10a): GetEuiccConfiguredAddresses

Related Procedures: Profile Download and Installation

Function Provider Entity: ISD-R (IPA Services)

Description:

This function is identical to the ES10a.GetEuiccConfiguredAddresses function defined in section 5.7.3 of SGP.22 [4], where the IPA plays the role of LPA.

5.9 ES10b (IPA -- eUICC)

5.9.1 Function (ES10b): LoadEuiccPackage

Related Procedures: Generic eUICC Package Download and Execution

Function Provider Entity: ISD-R (IPA Services)

Description:

This function executes a eUICC Package.

On reception of this command, the eUICC SHALL:

•Retrieve the public key of the Associated eIM using the eimId in euiccPackageSigned. If the eimId is unknown, the eUICC SHALL return an unsigned eUICC Package error result (euiccPackageErrorUnsigned) containing the eimId received in the euiccPackageSigned.

-Verify the eimSignature created upon euiccPackageSigned concatenated with associationToken using the retrieved eIM public key. If no association token is configured for the eIM, the associationToken data object SHALL be used with the value set to zero for verifying the signature. If the signature is invalid, the eUICC SHALL return an unsigned eUICC Package error result (euiccPackageErrorUnsigned) containing the eimId received in the euiccPackageSigned. If and only if an association token is configured for the eIM, the eUICC SHALL return the associationToken in the error result.

-Verify that the eidValue in euiccPackageSigned matches its own EID. If the EID verification fails, the eUICC SHALL return a signed eUICC error result (euiccPackageErrorSigned) containing the invalidEid error code.

-Verify that the counterValue in euiccPackageSigned is greater than the counter value stored in the eUICC for the Associated eIM. If the counter value verification fails, the eUICC SHALL return a signed eUICC Package error result (euiccPackageErrorSigned) containing the replayError error code.

-Reset any authorisation previously granted to use the Profile Rollback Mechanism (and any related data).

-Execute PSMO(s) or eCO(s) contained in the eUICC Package and generate the corresponding PSMO or eCO result(s) (euiccResultData) sequentially.

If the eUICC encounters an error for a PSMO or an eCO, the eUICC SHALL terminate processing of the remaining command sequence and generate euiccResultData containing processingTerminated with the following error codes:

-For a PSMO 'List Profile Info' request, if the eUICC cannot generate the euiccResultData due to the size limit of the response data, the error code SHALL be resultSizeOverflow.

NOTE: this could happen, e.g., when retrieving Profile Metadata of multiple Profiles containing large icons.

-If a PSMO or an eCO in the eUICC Package is unknown or unsupported, or the command data cannot be interpreted, the error code SHALL be unknownOrDamagedCommand.

-Generate a signed eUICC Package Result (euiccPackageResultSigned) with the execution results of the PSMOs/eCOs (euiccResultData). The eUICC Package Result SHALL be signed using SK.EUICC.ECDSA. In case there are more than one SK.EUICC.ECDSA available for signing, the SK.EUICC.ECDSA chaining back to the CI public key identified by the euiccCiPKId of the eIM Configuration Data (of the Associated eIM for which the eUICC Package Result is intended) SHALL be used. The signed data includes the next (not used) value of the sequence number (defined in SGP.22 [4] for use with Notifications).

-Increment the sequence number in eUICC storage by 1.

-Update the counter value stored in the eUICC for the Associated eIM to the counterValue received in the euiccPackageSigned.

-Return the signed eUICC Package Result (euiccPackageResultSigned).

The ES10b.LoadEuiccPackage function SHALL be processed in an atomic way, meaning that in case of non-resumable interruption (e.g., power loss), the eUICC SHALL revert all performed changes related to PSMOs or eCOs within that eUICC Package. The eUICC SHALL restore its original state prior to execution of the ES10b.LoadEuiccPackage, including the counterValue. Any intermediate result generated for the eUICC Package SHALL be discarded.

NOTE: In case of non-resumable interruption the ISD-R withdraws the previously received eUICC Package.

The IPAd MAY call the ES10b.LoadEuiccPackage command again, including the same eUICC Package, if it detects that the previous processing was interrupted.

NOTE: How the IPA detects the interruption and how an IPA resubmits the eUICC Package is out of scope.

Command Data

The EuiccPackageRequest as defined in section 2.11.1.1.

Response Data

The EuiccPackageResult as defined in section 2.11.2.1.

5.9.2 Function (ES10b): GetEUICCInfo

Related Procedures: Profile Download and Installation

Function Provider Entity: ISD-R (IPA Services)

Description:

This function is identical to the ES10b.GetEUICCInfo function defined in section 5.7.8 of SGP.22 [4], where the IPA plays the role of LPA.

The response data for EUICCInfo2 SHALL follow the ASN.1 message definition below replacing the EUICCInfo2 described in section 5.7.8 and Annex H of SGP.22 [4].

NOTE: EUICCInfo2 in this specification is based on EUICCInfo2 as defined in SGP.22 [4] but has been extended for IoT purposes.

ASN.1 definitions
-- ASN1START

EUICCInfo2 ::= [34] SEQUENCE { -- Tag 'BF22'

profileVersion [1] VersionType, -- Base eUICC Profile package version supported

svn [2] VersionType, -- GSMA SGP.22 version supported (SVN)referenced by SGP.32

euiccFirmwareVer [3] VersionType, -- eUICC Firmware version

extCardResource [4] OCTET STRING, -- Extended Card Resource Information according to ETSI TS 102 226

uiccCapability [5] UICCCapability,

ts102241Version [6] VersionType OPTIONAL,

globalplatformVersion [7] VersionType OPTIONAL,

rspCapability [8] RspCapability,

euiccCiPKIdListForVerification [9] SEQUENCE OF SubjectKeyIdentifier, -- List of CI Public Key Identifiers supported on the eUICC for signature verification

euiccCiPKIdListForSigning [10] SEQUENCE OF SubjectKeyIdentifier, -- List of CI Public Key Identifier supported on the eUICC for signature creation

euiccCategory [11] INTEGER {

other(0),

basicEuicc(1),

mediumEuicc(2),

contactlessEuicc(3)

} OPTIONAL,

forbiddenProfilePolicyRules [25] PprIds OPTIONAL, -- Tag '99'

ppVersion VersionType, -- Protection Profile version

sasAcreditationNumber UTF8String (SIZE(0..64)),

certificationDataObject [12] CertificationDataObject OPTIONAL,

treProperties [13] BIT STRING {

isDiscrete(0),

isIntegrated(1),

usesRemoteMemory(2) -- refers to the usage of remote memory protected by the Remote Memory Protection Function described in SGP.21 [4]

} OPTIONAL,

treProductReference [14] UTF8String OPTIONAL, -- Platform_Label as defined in GlobalPlatform DLOA specification [57]

additionalEuiccProfilePackageVersions [15] SEQUENCE OF VersionType OPTIONAL,

ipaMode [16] IpaMode OPTIONAL, -- active IPA, mandatory within SGP.32

rfu2 [17] SEQUENCE OF SubjectKeyIdentifier OPTIONAL, -- not used by this version of SGP.32.

rfu3 [18] OCTET STRING (SIZE(0..32)) OPTIONAL, -- not used by this version of SGP.32

rfu4 [19] VersionType OPTIONAL, -- not used by this version of SGP.32

iotSpecificInfo [20] IoTSpecificInfo OPTIONAL -- mandatory within SGP.32

}

-- Definition of IoTSpecificInfo

IoTSpecificInfo ::= SEQUENCE {

iotVersion [0] SEQUENCE OF VersionType -- SGP.32 version(s) supported by the eUICC, at least one must be present

}

-- Definition of IpaMode

IpaMode ::= INTEGER {

ipad (0), -- IPAd is active

ipae (1) -- IPAe is active

}

-- ASN1STOP

The procedures related to the eUICC Profile Package versioning and associated to profileVersion, additionalEuiccProfilePackageVersions and uiccCapability are described in section 5.7.8 of SGP.22 [4].

NOTE : as part of the TCA eUICC Profile Package specification [29], in version v3.3 a new Profile type called “IoT Minimal Profile” has been introduced with the intention to be useful for the provisioning of eUICCs in Network Constrained Devices.

The rfu2, rfu3, and rfu4 fields are reserved for future use. The eUICC SHALL NOT include these fields in euiccInfo2. The SM-DP+ SHOULD ignore these fields if received with iotSpecificInfo being present.

5.9.3 Function (ES10b): GetEUICCChallenge

Related Procedures: Profile Download and Installation

Function Provider Entity: ISD-R (IPA Services)

Description:

This function is identical to the ES10b.GetEUICCChallenge function defined in section 5.7.7 of SGP.22 [4], where the IPA plays the role of LPA.

5.9.4 Function (ES10b): AddInitialEim

Related Procedures: Addition of initial eIM by IPAd

Function Provider Entity: eUICC (ISD-R)

Description:

This function is used by the IPAd to store eIM Configuration Data to the eUICC in case the eUICC does not contain any eIM Configuration Data.

Upon reception of this function call, the eUICC SHALL:

-Check if any eIM Configuration Data is already present in the eUICC. If so, the eUICC SHALL return an error code unsignedEimConfigDisallowed.

-Check if the eUICC has enough memory to store the list of provided eIM Configuration Data. If not, the eUICC SHALL return an error code insufficientMemory.

-Check that the sub-field euiccCiPKId of EimConfigurationData in each entry of the eimConfigurationDataList, if present, is a valid entry within euiccCiPKIdListForSigning in eUICCInfo2. If not, the eUICC SHALL return an error code ciPKUnknown.

-If requested for an Associated eIM, calculate an associationToken.

-Store the provided list of eIM Configuration Data, including the associationToken (if requested).

-Return the associationToken for each Associated eIM where it is requested.

NOTE: Any further addition of eIM Configuration Data can be performed by an Associated eIM using signed eUICC Packages containing eCO(s) as defined in section 3.5.1.1.

The function SHALL be performed in an atomic way, meaning that in case of any error during the command execution, the command SHALL stop and SHALL leave the eIM Configuration Data in their original state prior to command execution.

Command Data

The command data SHALL be coded as follows:

ASN.1 definitions
-- ASN1START

AddInitialEimRequest ::= [87] SEQUENCE { -- Tag 'BF57'

eimConfigurationDataList [0] SEQUENCE OF EimConfigurationData

}

-- ASN1STOP

The following sub-fields of EimConfigurationData SHALL be present in each entry of the eimConfigurationDataList:

-eimId;

-counterValue; and

-either eimPublicKey or eimCertificate.

The eimIdType, , the associationToken (with the value set to -1 to request the calculation of an association token for the new Associated eIM) and eimFqdn are optional for the IPA to provide in each EimConfigurationData. If not provided, the eUICC SHALL assign the value eimIdTypeProprietary before storing the eIM Configuration Data. The eimSupportedProtocol is optional for the IPA to provide in EimConfigurationData. If not provided, the eUICC SHALL assign the value where only the eimProprietary bit is set before storing the eIM Configuration Data. The euiccCiPKId is optional for the IPA to provide in EimConfigurationData. If not provided, the eUICC SHALL assign the value of first entry of euiccCiPKIdListForSigning in eUICCInfo2 before storing the eIM Configuration Data. The trustedPublicKeyDataTls is optional for the IPAd to provide in each EimConfigurationData data object.

NOTE: It is IPA's responsibility to correctly formulate each entry, including the uniqueness of eimId, and the eUICC is not mandated to check the validity.

Response Data

The response data SHALL be coded as follows:

ASN.1 definitions
-- ASN1START

AddInitialEimResponse ::= [87] CHOICE { -- Tag 'BF57'

addInitialEimOk SEQUENCE OF CHOICE {

associationToken [4] INTEGER,

addOk NULL

},

addInitialEimError INTEGER {

insufficientMemory(1),

unsignedEimConfigDisallowed(2),

ciPKUnknown(3),

invalidAssociationToken(5),

counterValueOutOfRange(6),

undefinedError(127)

}

}

-- ASN1STOP

5.9.5 Function (ES10b): eUICCMemoryReset

Related Procedures: eUICC Memory Reset

Function Provider Entity: ISD-R (IPA Services)

Description:

This function deletes selected subsets of the Profiles stored on an eUICC regardless of their enabled status or any Profile Policy Rules. The following subsets are defined:

-Operational Profiles

-Test Profiles that were not pre-installed (i.e., Test Profiles that were "field loaded")

NOTE: The identification of pre-installed Test Profiles is out of the scope of this specification.

The eUICC returns a status in resetResult indicating whether any Profiles were deleted.

-The eUICC returns ok if at least one Profile is deleted.

-The eUICC returns nothingToDelete if no Profile is deleted.

This function can also be used to:

-Reset the default SM-DP+ address to its initial value. In this context both ok and nothingToDelete response in resetResult indicates a successful execution of resetting the default SM-DP+ address.

-Remove all eIM Configuration Data. The execution result of this operation is returned in resetEimResult as described below.

-Reset the configuration of the automatic Profile enabling. The execution result of this operation is returned in resetAutoEnableConfigResult as described below.

Any combination MAY be specified in the request.

If the eUICC does not support Test Profiles, then a request to delete them is ignored.

The eUICC Memory Reset SHALL be performed in an atomic and non-reversible way in case of external interruptions (e.g., power loss): the eUICC SHALL continue the processing of that command upon the next eUICC power on. In case of any other error during the command execution, the command SHALL stop and SHALL leave the eUICC and the involved Profiles in their original states prior to command execution.

NOTE: How this command is protected from misuse is implementation specific.

Upon reception of the eUICCMemoryReset function and dependent on the parameters set, the eUICC SHALL perform the following:

-If there is an Enabled Profile with a proactive session ongoing, the eUICC SHALL perform one of the following:

-terminate the command and return error code catBusy.

-internally terminate the proactive session and prepare to send the REFRESH command as the next proactive command. If a TERMINAL RESPONSE is still outstanding, the REFRESH command SHALL only be sent after reception of the TERMINAL RESPONSE.

NOTE: In case of the catBusy error, the Device MAY take implementation-dependent action to terminate the proactive command session, and MAY send the eUICC Memory Reset command again without any further End User interaction.

-Delete all the selected ISD-Ps with their Profiles regardless of their enabled status or Profile Policy Rules and all related Profiles Metadata stored in the ISD-R and prepare resetResult.

-For each deleted Profile, the eUICC SHALL generate as many Notifications as configured in its Profile Metadata (notificationConfigurationInfo) in the format of OtherSignedNotification.

-Reset the default SM-DP+ address to its default value.

-Remove all eIM Configuration Data of all Associated eIMs and prepare resetEimResult.

-If there is no eIM Configuration Data to be removed, the eUICC SHALL return error code nothingToDelete.

-If the command is not supported by the eUICC, the eUICC SHALL return error code eimResetNotSupported.

-Reset the configuration of the automatic Profile enabling by deactivating automatic Profile enabling and removing any automatic enabling data for use with automatic Profile enabling. The eUICC SHALL also prepare resetAutoEnableConfigResult.

-If the command is not supported by the eUICC, the eUICC SHALL return error code resetAECNotSupported.

-Return EuiccMemoryResetResponse including resetResult, and if resetEimConfigData and/or resetAutoEnableConfig bits were set in the command data, additionally including resetEimResult and/or resetAutoEnableConfig, respectively.

-If there was an Enabled Profile, the ISD-R SHALL send a REFRESH proactive command to the Device with mode "UICC Reset".

Command Data

The command data SHALL be coded as follows:

EuiccMemoryResetRequest ::= [52] SEQUENCE { -- Tag 'BF34'

resetOptions [2] BIT STRING {

deleteOperationalProfiles(0),

deleteFieldLoadedTestProfiles(1),

resetDefaultSmdpAddress(2),

resetEimConfigData(3),

resetAutoEnableConfig(4)

}

}

Response Data

The response data SHALL be coded as follows:

EuiccMemoryResetResponse ::= [52] SEQUENCE { -- Tag 'BF34'

resetResult INTEGER {ok(0), nothingToDelete(1), catBusy(5), undefinedError(127)},

resetEimResult [1] INTEGER {ok(0), nothingToDelete(1), eimResetNotSupported(2), undefinedError(127)} OPTIONAL,

resetAutoEnableConfigResult [2] INTEGER {ok(0), resetAECNotSupported(1), undefinedError(127)} OPTIONAL

}

5.9.6 Function (ES10b): AuthenticateServer

Related Procedures: Profile Download and Installation

Function Provider Entity: ISD-R (IPA Services)

Description:

This function is identical to the ES10b.AuthenticateServer function defined in section 5.7.13 of SGP.22 [4], where the IPA plays the role of LPA, with the following additional eUICC behaviour after attaching the received RSP Server Certificate in the RSP session context:

-If automatic Profile enabling is activated, the eUICC SHALL verify that the OID in the RSP Server Certificate and FQDN in serverSigned1 match to the Default SM-DP+ data (OID and FQDN) stored in the eUICC. If the verification is successful, the eUICC SHALL grant automatic enabling of the Profile. Regardless of the verification result, the eUICC continues the processing of this function by generating euiccSigned1.

5.9.7 Function (ES10b): PrepareDownload

Related Procedures: Profile Download and Installation

Function Provider Entity: ISD-R (IPA Services)

Description:

This function is identical to the ES10b.PrepareDownload function defined in section 5.7.5 of SGP.22 [4], where the IPA plays the role of LPA.

5.9.8 Function (ES10b): LoadBoundProfilePackage

Related Procedures: Profile Download and Installation

Function Provider Entity: ISD-R (IPA Services)

Description:

This function is identical to the ES10b.LoadBoundProfilePackage function defined in section 5.7.6 of SGP.22 [4], where the IPA plays the role of LPA.

5.9.9 Function (ES10b): CancelSession

Related Procedures: Profile Download and Installation

Function Provider Entity: ISD-R (IPA Services)

Description:

This function is identical to the ES10b.CancelSession function defined in section 5.7.14 of SGP.22 [4], where the IPA plays the role of LPA, with the following additional eUICC behaviour:

-The eUICC SHALL revoke any grant to automatically enable a Profile.

5.9.10 Function (ES10b): GetCerts

Related Procedures: Profile Download and Installation

Function Provider Entity: ISD-R (IPA Services)

Description:

This function is used by the IPA to retrieve the eUICC Certificate and the EUM Certificate from the eUICC. This function can be used at any time by the IPA.

In order to select between multiple of EUM certificates and eUICC certificates within the eUICC the IPA MAY provide the CI Public Key Identifier (euiccCiPKId). If euiccCiPKId is not provided, the first entry of euiccCiPKIdListForSigning in eUICCInfo1 / eUICCInfo2 is used as euiccCiPKId when selecting the EUM certificate and/or eUICC certificate to return.

Command Data

The command data SHALL be coded as follows:

ASN.1 definitions
-- ASN1START

GetCertsRequest ::= [86] SEQUENCE { -- Tag 'BF56'

euiccCiPKId SubjectKeyIdentifier OPTIONAL -- CI Public Key Identifier supported on the eUICC for signature creation

}

-- ASN1STOP

Response Data

The response data SHALL be coded as follows:

ASN.1 definitions
-- ASN1START

GetCertsResponse ::= [86] CHOICE { -- Tag 'BF56'

certs SEQUENCE {

eumCertificate [5] Certificate, -- Tag 'A5'

euiccCertificate [6] Certificate -- Tag 'A6'

},

getCertsError INTEGER {invalidCiPKId(1), undfinedError(127)}

}

-- ASN1STOP

5.9.11 Function (ES10b): RetrieveNotificationsList

Related Procedures: Generic eUICC Package Download and Execution

Function Provider Entity: ISD-R (IPA Services)

Description:

This function retrieves the list of pending Notifications for installed Profiles and/or eUICC Package Results.

Command Data

The command data SHALL be coded as follows:

RetrieveNotificationsListRequest ::= [43] SEQUENCE { -- Tag 'BF2B'

searchCriteria CHOICE {

seqNumber [0] INTEGER,

profileManagementOperation [1] NotificationEvent,

euiccPackageResults [2] NULL

} OPTIONAL

}

The searchCriteria data object can be used to filter the list of Notifications and/or eUICC Package Results that the eUICC SHALL return.

-seqNumber indicates that the eUICC SHALL return either a Notification or an eUICC Package Result that has the sequnce number.

-A bit set to 1 in the profileManagementOperation indicates that the eUICC SHALL return all the Notifications corresponding to this type. The type notificationInstall SHALL include ProfileInstallationResult.

-euiccPackageResults indicates that the eUICC SHALL return all the eUICC Package Results.

If searchCriteria data object is omitted, the eUICC SHALL return all stored Notifications and eUICC Package Results in notificationAndEprList.

Response Data

The response data SHALL contain the list of PendingNotification data objects and/or EuiccPackageResult data objects. The list SHALL be filtered according to the command data. The eUICC MAY provide the Notifications and/or eUICC Package Results in any order within each list. The list SHALL be empty if there are no pending Notifications or eUICC Package Results matching the filtering criteria.

The following is the definition of the RetrieveNotificationsListResponse data object

ASN.1 definitions
-- ASN1START

RetrieveNotificationsListResponse ::= [43] CHOICE { -- Tag 'BF2B'

notificationList SEQUENCE OF PendingNotification,

notificationsListResultError INTEGER { undefinedError(127)}, euiccPackageResultList SEQUENCE OF EuiccPackageResult,

notificationAndEprList SEQUENCE {

notificationList SEQUENCE OF PendingNotification,

euiccPackageResultList SEQUENCE OF EuiccPackageResult

}

}

-- ASN1STOP

The PendingNotification is either a ProfileInstallationResult or an OtherSignedNotification according to definition in section 5.7.10 of SGP.22 [4].

5.9.12 Function (ES10b): RemoveNotificationFromList

Related Procedures: Profile Download and Installation, Generic eUICC Package Download and Execution

Function Provider Entity: ISD-R (IPA Services)

Description:

This function is identical to the ES10b.RemoveNotificationFromList function defined in section 5.7.11 of SGP.22 [4], where the IPA plays the role of LPA, with the addition that besides Notifications the function is also used to delete eUICC Package Results. Hence, the provided seqNumber in NotificationSentRequest provided by IPA is either a seqNumber of a Notification or a seqNumber of an eUICC Package Result.

5.9.13 Function (ES10b): GetRAT

Related Procedures: Profile Download and Installation

Function Provider Entity: ISD-R (IPA Services)

Description:

This function is identical to the ES10b.GetRAT function defined in section 5.7.22 of SGP.22 [4], where the IPA plays the role of LPA.

5.9.14 Function (ES10b): GetProfilesInfo

Related Procedures: Profile Download and Installation

Function Provider Entity: ISD-R (IPA Services)

Description:

This function is identical to the ES10c.GetProfilesInfo function defined in section 5.7.15 of SGP.22 [4], where the IPA plays the role of LPA.

5.9.15 Function (ES10b): EnableUsingDD

Related Procedures: Profile Download and Installation

Function Provider Entity: ISD-R (IPA Services)

Description:

This function is used by IPA to request automatic Profile enabling without eIM involvement. The eUICC MAY be configured to support the automatic enabling.

On reception of this function call, the eUICC SHALL:

-Verify that, except for Notification retrieval commands, the previous ES10 command was an ES10b.LoadBoundProfilePackage. If not, the eUICC SHALL return an error code noSessionContext.

-Verify that automatic enabling was granted for the newly installed Profile. If not, the eUICC SHALL return an error code autoEnableNotAvailable.

-Enable the newly installed Profile and generate enable Notifications as configured.

Command Data

The command data SHALL be encoded as follows:

ASN.1 definitions
-- ASN1START

EnableUsingDDRequest ::= [90] SEQUENCE { -- Tag 'BF5A'

}

-- ASN1STOP

Response Data

The response data SHALL be encoded as follows:

ASN.1 definitions
-- ASN1START

EnableUsingDDResponse ::= [90] SEQUENCE { -- Tag 'BF5A'

enableUsingDDResult [0] INTEGER {

ok(0),

autoEnableNotAvailable(1),

noSessionContext(4),

undefinedError(127)

}

}

-- ASN1STOP

5.9.16 Function (ES10b): ProfileRollback

Related Procedures: Generic eUICC Package Download and Execution, Profile State Management.

Function Provider Entity: ISD-R (IPA Services)

Description:

This function is used by the IPA to request to roll back to the previously Enabled Profile, if any. If the usage of the Rollback Mechanism had been previously granted by the eIM (i.e., in the last enable PSMO), this function disables the currently Enabled Profile and enables the Profile, if any, that was enabled before the processing of the last eUICC Package. This SHALL be performed in an atomic way, meaning that in case of any error during the command execution, the command SHALL stop and SHALL leave the involved Profiles in their original states (prior to command execution).

NOTE: Before calling the ProfileRollback function with the refreshFlag not being set, the IoT Device has the responsibility to ensure that the relevant conditions for use are met, as indicated for the ES10c.EnableProfile function in section 3.2.1 of SGP.22 [4].

In the following procedure, the Target Profile designates the Profile (if any) that was enabled before the processing of the last eUICC Package, and which is to be re-enabled.

Upon reception of the ProfileRollback command, the eUICC SHALL:

-Check whether the usage of the Rollback Mechanism had been previously granted by the eIM. If not, the procedure SHALL stop, and the result of this command SHALL indicate an error ('rollbackNotAllowed').

-Check whether a Profile is currently enabled. If not, the procedure SHALL stop, and the result of this command shall indicate an error ('commandError').

If the refreshFlag is not set, the eUICC SHALL:

-Check whether there is a proactive session ongoing (which the Device did not terminate). If so:

-the eUICC MAY terminate the ProfileRollback command with error 'catBusy'.

-If the eUICC does not terminate the ProfileRollback command with error 'catBusy', the eUICC SHALL internally terminate the proactive session and ignore any incoming TERMINAL RESPONSE from that proactive session.

-Close all logical channels which still have an application of the currently Enabled Profile selected (which the Device did not close), without generating an error.

-Reset the PIN status.

-Disable the currently Enabled Profile.

-Enable the Target Profile (if any).

-Implicitly select the MF on the basic logical channel.

-Generate a new eUICC Package Result including an additional ProfileRollbackResult (see Response Data below).

-Return 'ok' and the newly generated eUICC Package Result to the IPA.

NOTE: For subsequent actions by the Device following the enablement of the Target Profile, see ES10c.EnableProfile function in section 3.2.1 of SGP.22 [4].

If the refreshFlag is set:

-If there is a proactive session ongoing;

-The eUICC MAY terminate the ProfileRollback command with error 'catBusy'.

-If the eUICC does not terminate the ProfileRollback command with error 'catBusy', the eUICC SHALL internally terminate the proactive session and send the REFRESH command as the next proactive command. If a TERMINAL RESPONSE is still outstanding, the REFRESH command SHALL only be sent after reception of the TERMINAL RESPONSE.

-Otherwise, the eUICC SHALL:

-Mark the currently Enabled Profile as "to be disabled".

-Mark the Target Profile (if any) as "to be enabled".

-Generate a new eUICC Package Result including an additional ProfileRollbackResult (see Response Data below)

-Return 'ok' and the newly generated eUICC Package Result to the IPA.

-Send the REFRESH command in "eUICC Profile State Change" mode (if supported by the Device) or "UICC Reset" mode to the Device according to ETSI TS 102 223 [5].

-Upon reception of the Terminal Response with result "command performed successfully" or upon reset of the eUICC, disable the currently Enabled Profile and enable the Target Profile (if any).

-Upon reception of the Terminal Response with result "temporary problem with executing command" or "permanent problem with executing command", the eUICC SHALL NOT disable the currently Enabled Profile nor Enable the Target Profile (if any). Subsequent actions are implementation specific.

The eUICC MAY start a new proactive UICC session only after a new TERMINAL PROFILE command is executed.

-If the currently Enabled Profile was successfully disabled, the eUICC SHALL generate as many Notifications as configured in its metadata (notificationConfigurationInfo) in the format of OtherSignedNotification.

-If the Target Profile is successfully enabled, the eUICC SHALL generate as many Notifications as configured in its metadata (notificationConfigurationInfo) in the format of OtherSignedNotification.

Command Data

The command data SHALL be coded as follows:

ASN.1 definitions
-- ASN1START

ProfileRollbackRequest ::= [88] SEQUENCE { -- Tag 'BF58'

refreshFlag BOOLEAN -- indicating whether REFRESH is required

}

-- ASN1STOP

Response Data

The response data SHALL be coded as follows:

ASN.1 definitions
-- ASN1START

ProfileRollbackResponse ::= [88] SEQUENCE { -- Tag 'BF58'

cmdResult INTEGER {

ok(0),

rollbackNotAllowed(1), -- Usage of rollback was not granted by the eIM

catBusy(5),

commandError(7),

undefinedError(127)

},

eUICCPackageResult [81] EuiccPackageResult OPTIONAL

}

-- ASN1STOP

The eUICCPackageResult SHALL be present if the cmdResult is 'ok' (i.e., a Rollback Mechanism has been executed by the eUICC). In this case, the eUICCPackageResult SHALL include the same eimId, counterValue, transactionId as the result generated for the previous eUICC Package, its seqNumber SHALL be incremented, and its eUICCResultData SHALL include the same PSMO results followed by an additional RollbackProfileResult (see section 2.11.2.1).

5.9.17 Function (ES10b): ConfigureAutomaticProfileEnabling

Related Procedures: Configure automatic Profile enabling by IPA.

Function Provider Entity: eUICC (ISD-R)

Description:

This function is used by the IPA to activate or deactivate automatic Profile enabling in the eUICC and to add or update automatic enabling data used in the automatic Profile enabling.

Upon reception of this function call, the eUICC SHALL:

-Check if any eIM Configuration Data is already present in the eUICC. If so, the eUICC SHALL return an error code unsignedAutoEnableConfigDisallowed.

-Check if autoEnableFlag is present in the command data. If autoEnableFlag is present and automatic Profile enabling is not activated, the eUICC SHALL activate automatic Profile enabling. If autoEnableFlag is not present and automatic Profile enabling is activated, the eUICC SHALL deactivate automatic Profile enabling. In all other cases, the automatic Profile enabling state is left unchanged.

-Check if automatic enabling data (smdpOid and smdpAddress for default SM-DP+) is present in the command data. If so, and the eUICC has enough memory to store the automatic enabling data, the eUICC SHALL store the automatic enabling data for use in the automatic Profile enabling. If there is not enough memory, the eUICC SHALL return an error code insufficientMemory.

The function SHALL be performed in an atomic way, meaning that in case of any error during the command execution, the command SHALL stop and SHALL leave the automatic Profile enabling configuration in its original state prior to command execution.

Command Data

The command data SHALL be coded as follows:

ASN.1 definitions
-- ASN1START

ConfigureAutoProfileEnablingRequest ::= [89] SEQUENCE { -- Tag 'BF59'

autoEnableFlag [0] NULL OPTIONAL,

smdpOid [1] OBJECT IDENTIFIER OPTIONAL,

smdpAddress [2] UTF8String OPTIONAL

}

-- ASN1STOP

Response Data

The response data SHALL be coded as follows:

ASN.1 definitions
-- ASN1START

ConfigureAutoProfileEnablingResponse ::= [89] SEQUENCE { -- Tag 'BF59'

configAutoEnableResult [0] INTEGER {

ok(0),

insufficientMemory(1),

unsignedAutoEnableConfigDisallowed(2),

undefinedError(127)

}

}

-- ASN1STOP

5.9.18 Function (ES10b): GetEimConfigurationData

Related Procedures: Reading eIM Configuration Data by IPA

Function Provider Entity: eUICC (ISD-R)

Description:

This function is used by the IPA to read eIM Configuration Data stored in the eUICC.

Command Data

The command data SHALL be coded as follows:

ASN.1 definitions
-- ASN1START

GetEimConfigurationDataRequest ::= [85] SEQUENCE { -- Tag 'BF55'

}

-- ASN1STOP

Response Data

The response data SHALL be coded as follows:

ASN.1 definitions
-- ASN1START

GetEimConfigurationDataResponse ::= [85] SEQUENCE { -- Tag 'BF55'

eimConfigurationDataList [0] SEQUENCE OF EimConfigurationData

}

-- ASN1STOP

In each EimConfigurationData entry of the eimConfigurationDataList, the eUICC SHALL provide eimId, eimFqdn (if present), eimIdType, eimSupportedProtocol, and, if configured, associationToken, and MAY additionally provide either eimPublicKey or eimCertificate. The eUICC SHALL NOT provide counterValue.

5.9.19 Function (ES10b): GetEID

Related Procedures: Profile Download and Installation

Function Provider Entity: ISD-R (IPA Services)

Description:

This function is identical to the ES10c.GetEID function defined in section 5.7.20 of SGP.22 [4], where the IPA plays the role of LPA.

5.10 ES11 (IPA -- SM-DS)

ES11 is the interface to retrieve Event Records (see section 3.9.2.1) between:

-The IPA entity.

-The SM-DS.

The IPA SHALL communicate with the SM-DS secured by TLS in server authentication mode as described in section 2.6.4 of this document.

This interface is identical to the ES11 interface defined in section 5.8 of SGP.22 [4], where the IPA plays the role of LPA.

5.11 ES11’ (eIM -- SM-DS)

ES11’ is the interface to retrieve Event Records (see section 3.9.2.2) between:

-The eIM entity.

-The SM-DS.

The eIM SHALL communicate with the SM-DS secured by TLS in server authentication mode as described in section 2.6.4 of this document.

This interface is identical to the ES11 interface defined in section 5.8 of SGP.22 [4], where the eIM plays the role of LPA.

5.12 ES12 (SM-DS -- SM-DP+)

The ES12 is used by the SM-DP+ to manage Event Registration (see section 3.9.1) and Event Deletion (see section 3.9.3). This interface is identical to the one defined in section 5.9 of SGP.22 [4].

5.13 ESep (eIM -- eUICC)

ESep is the interface between:

-The eIM entity.

-The eUICC.

The ESep interface is based on the eIM sending a signed EuiccPackageRequest to the eUICC containing PSMO(s) or eCO(s) and receiving a signed EuiccPackageResult in return from the eUICC containing the execution results. The ESep functions are the PSMOs and eCOs in the eUICC Package.

5.13.1 Function (ESep): Enable

Related Procedures: Profile State Mangement

Function Provider Entity: eUICC

Description:

This function enables an installed Profile in the eUICC. The input data is the enable structure defined in section 2.11.1.1.3 and the output is the enableResult structure defined in section 2.11.2.1. The function is further described in the Enable Profile procedure defined in section 3.4.1.

5.13.2 Function (ESep): Disable

Related Procedures: Profile State Mangement

Function Provider Entity: eUICC

Description:

This function disables an enabled Profile in the eUICC. The input data is the disable structure defined in section 2.11.1.1.3 and the output is the disableResult structure defined in section 2.11.2.1. The function is further described in the Disable Profile procedure defined in section 3.4.2.

5.13.3 Function (ESep): Delete

Related Procedures: Profile State Mangement

Function Provider Entity: eUICC

Description:

This function deletes an installed Profile in the eUICC. The input data is the delete structure defined in section 2.11.1.1.3 and the output is the deleteResult structure defined in section 2.11.2.1. The function is further described in the Delete Profile procedure defined in section 3.4.3.

5.13.4 Function (ESep): ListProfileInfo

Related Procedures: Indirect Profile Download

Function Provider Entity: eUICC

Description:

This function allows the eIM to retrieve the list of Profile information for installed Profiles including their current state (Enabled/Disabled) and their associated Profile Metadata. The input data is the listProfileInfo structure defined in section 2.11.1.1.3 and the output is the listProfileInfoResult structure defined in section 2.11.2.1.

5.13.5 Function (ESep): GetRAT

Related Procedures: Indirect Profile Download

Function Provider Entity: eUICC

Description:

This function allows the eIM to retrieve the Rules Authorisation Table (RAT) from the eUICC. The input data is the getRAT structure defined in section 2.11.1.1.3 and the output is the getRATResult structure defined in section 2.11.2.1.

5.13.6 Function (ESep): ConfigureAutoEnable

Related Procedures: Direct Profile Download

Function Provider Entity: eUICC

Description:

This function configures the automatic enabling of a Profile in the eUICC. The input data is the configureAutoEnable structure defined in section 2.11.1.1.3 and the output is the configureAutoEnableResult structure defined in section 2.11.2.1. The function is further described in the Configure Automatic Profile Enabling by eIM procedure defined in section 3.4.4.

5.13.7 Function (ESep): AddEim

Related Procedures: Addition of eIM Configuration Data

Function Provider Entity: eUICC

Description:

This function adds an Associated eIM to the eUICC by providing its eIM Configuration Data including the eimID to the eUICC. The input data is the addEim structure defined in section 2.11.1.1.2 and the output is the addEimResult structure defined in section 2.11.2.1. The function is further described in the Addition of eIM Configuration Data procedure defined in section 3.5.1.1.

5.13.8 Function (ESep): UpdateEim

Related Procedures: Update of eIM Configuration Data

Function Provider Entity: eUICC

Description:

This function updates eIM Configuration Data, i.e., the public key or Certificate and the related anti-replay counter value of an Associated eIM with a given eimID within the eUICC while keeping the same eimID. The input data is the updateEim structure defined in section 2.11.1.1.2 and the output is the updateEimResult structure defined in section 2.11.2.1. The function is further described in the Update of eIM Configuration Data procedure defined in section 3.5.1.3.

5.13.9 Function (ESep): DeleteEim

Related Procedures: Deletion of eIM Configuration Data

Function Provider Entity: eUICC

Description:

This function deletes an Associated eIM identified by its eimID from the eUICC. If the successfully deleted Associated eIM was the last available Associated eIM, the eUICC SHALL allow ES10b.AddInitialEim again. The input data is the deleteEim structure defined in section 2.11.1.1.2 and the output is the deleteEimResult structure defined in section 2.11.2.1. The function is further described in the Deletion of eIM Configuration Data procedure defined in section 3.5.1.2.

5.13.10 Function (ESep): ListEim

Related Procedures: Request for a list of Associated eIMs

Function Provider Entity: eUICC

Description:

This function requests the eUICC to provide a list of all currently configured Associated eIMs to the eIM. The input data is the listEim structure defined in section 2.11.1.1.2 and the output is the listEimResult structure defined in section 2.11.2.1. The function is further described in the Request for a list of Associated eIMs procedure defined in section 3.5.1.4.

5.14 ESipa (eIM -- IPA)

This ESipa interface is used between:

-The IPA entity

-The eIM entity.

This section defines the different functions used through the ESipa interface.

5.14.1 Function (ESipa): InitiateAuthentication

Related Procedures: Profile Download and Installation

Function Provider Entity: eIM

Description:

This function requests the SM-DP+/SM-DS authentication via the eIM. This follows the ES10b.GetEUICCChallenge by the IPA, where the IPA retrieves the relevant information from the eUICC and provides it to the eIM. The eIM SHALL send this information to the SM-DP+/SM-DS to initiate mutual authentication between the eUICC and the SM-DP+/SM-DS.

On reception of this function call, the eIM SHALL call the ES9+'.InitiateAuthentication function / ES11’.InitiateAuthentication based on the received input data. The eIM SHALL identify any missing input data before calling the ES9+’.InitiateAuthentication function/ ES11’.InitiateAuthentication.

The input parameters of this function are identical to those of ES9+.InitiateAuthentication / ES11’.InitiateAuthentication defined in section 5.6.1/5.8.1 of SGP.22 [4], except the following change in MOC column of the input data table where the euiccInfo1 and smdpAddress are OPTIONAL. An IPA with IPA Capability minimizeEsipaBytes SHOULD NOT send euiccInfo1 and smdpAddress in order to reduce the number of transmitted bytes. In case an Activation Code is used, an IPA with IPA Capability eimDownloadDataHandling SHALL not send smdpAddress.

Additional Input Data:

  -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
  Input data name                                                              Description                                                                                                                                       Type         No.   MOC
  ---------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------------------------------- ------------ ----- -----
  euiccChallenge                                                               euiccChallenge generated by the eUICC. IPA can retrieve the euiccChallenge from the eUICC by calling "ES10b.GetEUICCChallenge" (section 5.9.3).   Binary[16]   1     M

  euiccInfo1                                                                   euiccInfo1 of the eUICC. IPA can retrieve the euiccInfo1 by calling "ES10b.GetEUICCInfo" (section 5.9.2).                                         Binary⁽¹⁾    1     O

  smdpAddress                                                                  The SM-DP+/SM-DS Address as known and provided by the IPA.                                                                                        FQDN         1     O

  NOTE 1: euiccInfo1 SHALL be provided as an encoded EuiccInfo1 data object.
  -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

6.: InitiateAuthentication Additional Input Data

Upon receiving the ES9+’.InitiateAuthentication / ES11’.InitiateAuthentication response, the eIM SHALL perform the following:

-If the smdpAddress provided as input to ES9+’.InitiateAuthentication / ES11’.InitiateAuthentication did not come from IPA (not present in ESipa.InitiateAuthentication e.g., due to IPA has capability eimDownloadDataHandling), the eIM SHALL verify that the serverAddress in serverSigned1 returned by the SM-DP+/SM-DS matches the smdpAddress that the eIM provided as input in ES9+'.InitiateAuthentication. If not, the procedure SHALL stop and return an error.

-If the Activation Code contains the SM-DP+ OID and is available to the eIM (e.g., due to IPA has capability eimDownloadDataHandling), the eIM SHALL check that the SM-DP+ OID from the Activation Code matches the SM-DP+ OID of the SM-DP+ Certificate (serverCertificate). If not, the procedure SHALL stop and return an error.

-If IPA does not generate ctxParams1 (see IPA capability eimCtxParams1Generation), the eIM SHALL generate ctxParams1 based on matchingId DeviceInfo. DeviceInfo MAY be common for several IoT Devices and MAY have been retrieved from one IoT Device and re-used for other IoT Devices.

The eIM SHALL prepare the ESipa.InitiateAuthentication response. The output parameters of this function are identical to those of ES9+.InitiateAuthentication / ES11’.InitiateAuthentication defined in section 5.6.1/5.8.1 of SGP.22 [4] with the following modifications:

-transactionId is conditional since it is also part of serverSigned1 and SHALL NOT be sent by the eIM to an IPA with IPA Capability minimizeEsipaBytes (i.e., IPA is capable of extracting transactionId from serverSigned1),

-euiccCiPKIdToBeUsed SHALL be sent in truncated form (instead of the full CI Public Key Identifier) to an IPA with IPA Capability minimizeEsipaBytes to minimize the number of transmitted bytes.

-ctxParams1 SHALL be provided to IPA if IPA is not capable of generating it (IPA capability eimCtxParams1Generation),

-matchingId SHALL be provided to the IPA if IPA generates ctxParams1 and the matchingId is available to the eIM but not available to the IPA.

Additional Output Data:

Output data name

Description

Type

No.

MOC

transactionId

Transaction ID as generated by the SM-DP+/SM-DS (section 3.1.1.4 of SGP.22 [4]).

Binary[1-16]

1

C

serverSigned1

The data object signed by the SM-DP+.

Binary⁽¹⁾

1

M

serverSignature1

SM-DP+/SM-DS signature

Binary⁽¹⁾

1

M

euiccCiPKIdToBeUsed

CI Public Key Identifier to be used by the eUICC for signature.

Binary^((1,2))

1

M

serverCertificate

SM-DP+/SM-DS Certificate (CERT.DPauth.ECDSA/ CERT.DSauth.ECDSA)

Binary⁽¹⁾

1

M

matchingId

Matching ID/Event ID as defined in SGP.22 [4] identifying a specific management order at the SM-DP+/SM-DS.

UTF8String

1

C⁽³⁾

ctxParams1

Data structure used in Common Mutual Authentication.

Binary⁽¹⁾

1

C⁽³⁾

NOTE 1: serverSigned1, serverSignature1, euiccCiPKIdToBeUsed, serverCertificate, and ctxParams1 are data objects defined in section 5.7.13 (function "ES10b.AuthenticateServer") of SGP.22 [4]. They SHALL be returned as encoded data objects including the tags defined for them in the AuthenticateServerRequest data object.

NOTE 2: euiccCiPKIdToBeUsed contains either the full CI Public Key Identifier or a truncated version of the CI Public Key Identifier where only enough leading bytes of the CI Public Key Identifier are provided for IPA to be able to uniquely locate and extract the chosen CI Public Key Identifier from the euiccCiPKIdListForSigning of eUICCInfo1. If the euiccCiPKIdListForSigning only contains one CI Public Key Identifier, the euiccCiPKIdToBeUsed encoded data object in truncated form indicates a zero length CI Public Key Identifier. The euiccCiPKIdToBeUsed SHALL be sent in truncated form to an IPA with IPA Capability minimizeEsipaBytes. Otherwise, the full CI Public Key Identifier SHALL be used.

NOTE 3: matchingId and ctxParams1 are conditional since either the IPA or the eIM generates the ctxParams1. If the IPA generates ctxParams1 and the matchingId is available to the eIM but not available to the IPA, the eIM SHALL provide the Matching ID to IPA.

7.: InitiateAuthentication Additional Output Data

The error codes returned by ESipa.InitiateAuthentication SHALL be the same as those of ES9+’.InitiateAuthentication / ES11’.InitiateAuthentication with the following additions:

-smdpAddressMismatch – indicates an error when matching SM-DP+/SM-DS Address sent in ES9+’.InitiateAuthentication with / ES11’.InitiateAuthentication SM-DP+/SM-DS Address received from the SM-DP+/SM-DS,

-smdpOidMismatch – indicates an error when matching SM-DP+ OID from AC with SM-DP+ OID from SM-DP+ Certificate.

5.14.2 Function: (ESipa) GetBoundProfilePackage

Related Procedures: Profile Download and Installation

Function Provider Entity: eIM

Description:

This function requests the delivery and the binding of a Profile Package for the eUICC.

This function is correlated to a previous normal execution of an Esipa.AuthenticateClient function through a TransactionID delivered by the SM-DP+.

On reception of this function call, the Eim SHALL call the ES9+’.GetBoundProfilePackage function based on the received input data. The input parameters of this function are identical to the those of ES9+.GetBoundProfilePackage defined in section 5.6.2 of SGP.22 [4]. However, the prepareDownloadResponse is extended according to the below ASN.1 structure where a compactDownloadResponseOk is added. An IPA with IPA Capability minimizeEsipaBytes SHOULD re-encode a prepareDownloadResponse with downloadResponseOk received from eUICC into a prepareDownloadResponse with compactDownloadResponseOk in order to reduce the number of bytes to transmit to the Eim. Before calling the ES9+’.GetBoundProfilePackage function, an Eim that receives a prepareDownloadResponse from an IPA with IPA Capability minimizeEsipaBytes SHALL restore the prepareDownloadResponse prepared by the eUICC based on the received prepareDownloadResponse and data already available to the Eim (smdpSigned2 and hashCc).

Additional Input Data:

  ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
  Input data name                                                                                        Description                                                                                                                                                                                                                                      Type           No.   MOC
  ------------------------------------------------------------------------------------------------------ ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ -------------- ----- -----
  transactionId                                                                                          Transaction ID as generated by the SM-DP+ (section 3.1.1.4 of SGP.22 [4]).                                                                                                                                                                       Binary[1-16]   1     M

  prepareDownloadResponse                                                                                PrepareDownloadResponse data object defined in section 5.7.5 of SGP.22 extended with compactDownloadResponseOk (see structure below). IPA retrieves prepareDownloadResponse from the eUICC by calling “ES10b.PrepareDownload” (section 5.9.7).   Binary⁽¹⁾      1     M

  NOTE 1: prepareDownloadResponse SHALL be provided as an encoded PrepareDownloadResponse data object.
  ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

8.: GetBoundProfilePackage Additional Input Data

ASN.1 definitions
-- ASN1START

PrepareDownloadResponse ::= [33] CHOICE { -- Tag 'BF21'

downloadResponseOk PrepareDownloadResponseOk,

downloadResponseError PrepareDownloadResponseError,

compactDownloadResponseOk CompactPrepareDownloadResponseOk

}

CompactPrepareDownloadResponseOk ::= SEQUENCE {

compactEuiccSigned2 CompactEuiccSigned2, -- Compact version of EuiccSigned2

euiccSignature2 [APPLICATION 55] OCTET STRING -- tag '5F37' signature on EuiccSigned2

}

CompactEuiccSigned2 ::= SEQUENCE {

euiccOtpk [APPLICATION 73] OCTET STRING OPTIONAL, -- otPK.EUICC.ECKA, tag '5F49' euiccOtpk is always present except if bppEuiccOtpk was chosen by the eUICC

hashCc Octet32 OPTIONAL -- Hash of confirmation code, if not received from Eim

}

-- ASN1STOP

Upon receiving the ES9+’.GetBoundProfilePackage response, the Eim SHALL perform the following:

-If the Eim verified the Profile Metadata in Esipa.AuthenticateClient (due to IPA Capability eimProfileMetadataVerification), the Eim SHOULD parse the boundProfilePackage received from SM-DP+, extract the Profile Metadata (encoded in the StoreMetadataRequest field), and check that the Profile Metadata has not changed. If it has changed, the Eim SHALL return an error code to IPA indicating Metadata mismatch and terminate the procedure. The error code SHALL trigger the IPA to cancel the on-going RSP session with SM-DP+ using Esipa.CancelSession. The cancel session reason code to be used by IPA when calling the Esipa.CancelSession SHALL be given by the error code, i.e., Metadata mismatch.

The Eim SHALL prepare the Esipa.GetBoundProfilePackage response. The output parameters of this function are identical to the those of ES9+.GetBoundProfilePackage defined in section 5.6.2 of SGP.22 [4] except for that transactionId is conditional. The transactionId is also part of boundProfilePackage. An Eim SHALL NOT send the transactionId to an IPA with IPA Capability minimizeEsipaBytes (i.e., IPA is capable of extracting transactionId from boundProfilePackage). Otherwise, the Eim SHALL send the transactionId.

Additional Output Data:

  ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
  Output data name                                                                               Description                                                                                                               Type           No.   MOC
  ---------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -------------- ----- -----
  transactionId                                                                                  Transaction ID as generated by the SM-DP+ (section 3.1.1.4 of SGP.22 [4]).                                                Binary[1-16]   1     C

  boundProfilePackage                                                                            Bound Profile Package data object to be transferred to the eUICC using "ES10b.LoadBoundProfilePackage" (section 5.9.8).   Binary⁽¹⁾      1     M

  NOTE 1: boundProfilePackage SHALL be provided as an encoded BoundProfilePackage data object.
  ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

9.: GetBoundProfilePackage Additional Output Data

The error codes returned by Esipa.GetBoundProfilePackage SHALL be the same as those of ES9+’.GetBoundProfilePackage with the following additions:

-profileMetadataMismatch – indicates an error when matching Profile Metadata received in the ES9+’.AuthenticateClient and Profile Metadata in the BPP.

5.14.3 Function: (Esipa) AuthenticateClient

Related Procedures: Profile Download and Installation

Function Provider Entity: eIM

Description:

This function SHALL be called by the IPA to request the authentication of the eUICC by the SM-DP+/SM-DS.

This function is correlated to a previous normal execution of an ESipa.InitiateAuthentication through a TransactionID delivered by the SM-DP+/SM-DS.

On reception of this function call, the eIM SHALL call the ES9+’.AuthenticateClient / ES11’.AuthenticateClient function based on the received input data. The input parameters of this function are identical to the those of ES9+.AuthenticateClient ES11’.AuthenticateClient defined in section 5.6.3/5.8.2 of SGP.22 [4]. However, the authenticateServerResponse is extended according to the below ASN.1 structure where a compactAuthenticateResponseOk is added. An IPA with IPA Capability minimizeEsipaBytes SHOULD re-encode an authenticateServerResponse with authenticateResponseOk received from eUICC into an authenticateServerResponse with compactAuthenticateResponseOk in order to reduce the number of bytes to transmit to the eIM. Before calling the ES9+’.AuthenticateClient / ES11’.AuthenticateClient function, an eIM that receives an authenticateServerResponse from an IPA with IPA Capability minimizeEsipaBytes SHALL restore the authenticateServerResponse prepared by the eUICC based on the received authenticateServerResponse and data already available to the eIM (serverSigned1, eUICCInfo2, ctxParams1, euiccCertificate, and eumCertificate).

The compactAuthenticateResponseOk option SHALL allow two ways for IPA to reduce the number of transmitted bytes:

-IPA avoids sending the eUICC Certificate and/or the EUM Certificate, and

-IPA sends a compact version of euiccSigned1, where only non-static parts of euiccInfo2 and optionally also ctxParams1 are included.

Additional Input Data:

  ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
  Input data name                                                                                              Description                                                                                                                                                                                                                                                    Type           No.   MOC
  ------------------------------------------------------------------------------------------------------------ -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- -------------- ----- -----
  transactionId                                                                                                Transaction ID as generated by the SM-DP+/SM-DS (section 3.1.1.4 of SGP.22 [4]).                                                                                                                                                                               Binary[1-16]   1     M

  authenticateServerResponse                                                                                   AuthenticateServerResponse data object defined in section 5.7.13 of SGP.22 extended with compactAuthenticateResponseOk (see structure below). IPA retrieves authenticateServerResponse from the eUICC by calling "ES10b.AuthenticateServer" (section 5.9.6).   Binary⁽¹⁾      1     M

  NOTE 1: authenticateServerResponse SHALL be provided as an encoded AuthenticateServerResponse data object.
  ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

10.: AuthenticateClient Additional Input Data

ASN.1 definitions
-- ASN1START

AuthenticateServerResponse ::= [56] CHOICE { -- Tag 'BF38'

authenticateResponseOk AuthenticateResponseOk,

authenticateResponseError AuthenticateResponseError,

compactAuthenticateResponseOk CompactAuthenticateResponseOk

}

CompactAuthenticateResponseOk ::= SEQUENCE {

signedData CHOICE {

euiccSigned1 EuiccSigned1,

compactEuiccSigned1 [0] CompactEuiccSigned1 -- Compact version of EuiccSigned1

},

euiccSignature1 [APPLICATION 55] OCTET STRING, -- tag 5F37 signature on EuiccSigned1

euiccCertificate [1] Certificate OPTIONAL, -- eUICC Certificate (CERT.EUICC.ECDSA)

eumCertificate [2] Certificate OPTIONAL -- EUM Certificate (CERT.EUM.ECDSA)

}

CompactEuiccSigned1 ::= SEQUENCE {

extCardResource [4] OCTET STRING, -- Extended Card Resource Information according to ETSI TS 102 226 extracted from euiccInfo2,

ctxParams1 [2] CtxParams1 OPTIONAL -- ctxParams1 may be left out by IPA if eIM ctxParams1 was received from the eIM

}

-- ASN1STOP

Upon receiving the ES9+’.AuthenticateClient response, the eIM SHALL perform the following:

-If the IPA is not capable of verifying the Profile Metadata (see IPA Capability eimProfileMetadataVerification), the eIM SHALL verify the Profile Metadata. If the verification fails, the eIM SHALL return an error code to IPA and terminate the procedure. The error code SHALL trigger IPA to cancel the on-going RSP session with SM-DP+ using ESipa.CancelSession. The cancel session reason (e.g., PPR not allowed) to be used by IPA when calling the ESipa.CancelSession is given by the error code.

Upon receiving the ES11’.AuthenticateClient response, the eIM SHALL perform the following:

-Extract Event entries from the ES11’.AuthenticateClient response. Optionally, prepare and provide a ProfileDownloadTriggerRequest as part of ESipa.AuthenticateClient response to trigger the IPA to initiate download of a new Profile where information obtained from the Event entries are leveraged.

The eIM SHALL prepare the ESipa.AuthenticateClient response. The output parameters of this function are identical to the those of ES9+.AuthenticateClient / ES11.AuthenticateClient defined in section 5.6.3 / 5.8.2 of SGP.22 [4] except for that:

-If smdpSign2 is provided, transactionId is optional since it is also part of smdpSigned2 and the eIM SHALL NOT send the transactionId to an IPA with IPA capability minimizeEsipaBytes (i.e., IPA is capable of extracting transactionId from smdpSigned2),

-profileMetadata from ES9+’.AuthenticateClient SHALL NOT be sent by eIM to IPA if IPA is not capable of verifying profileMetadata (see IPA Capability eimProfileMetadataVerification),

-hashCc (Hash of the confirmation code) from ES9+’.AuthenticateClient MAY be provided if a confirmation code is requested by the SM-DP+ and the confirmation code is available to the eIM,

-eventEntries from ES11’.AuthenticateClient are not forwarded to the IPA,

-a ProfileDownloadTriggerRequest data object MAY be provided in case the ESipa.AuthenticateClient originates from ES11’.AuthenticateClient.

Additional Output Data:

  --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
  Output data name                                                                                                                                                                                                                                                                                                                                                                                                           Description                                                                            Type           No.   MOC
  -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- -------------------------------------------------------------------------------------- -------------- ----- -----
  transactionId                                                                                                                                                                                                                                                                                                                                                                                                              Transaction ID as generated by the SM-DP+ (section 3.1.1.4 of SGP.22 [4]).             Binary[1-16]   1     C

  profileMetadata                                                                                                                                                                                                                                                                                                                                                                                                            Profile Metadata to check against eUICC settings.                                      Binary⁽¹⁾      1     C

  smdpSigned2                                                                                                                                                                                                                                                                                                                                                                                                                The data to be signed by the SM-DP+.                                                   Binary⁽¹⁾      1     C

  smdpSignature2                                                                                                                                                                                                                                                                                                                                                                                                             SM-DP+ signature                                                                       Binary⁽¹⁾      1     C

  smdpCertificate                                                                                                                                                                                                                                                                                                                                                                                                            SM-DP+ Certificate (CERT.DPpb.ECDSA)                                                   Binary⁽¹⁾      1     C

  hashCc                                                                                                                                                                                                                                                                                                                                                                                                                     Hash of the confirmation code if confirmation code is requested and available to eIM   Binary⁽¹⁾      1     O

  profileDownloadTrigger                                                                                                                                                                                                                                                                                                                                                                                                     Profile download trigger (see section 2.11.2.3 ProfileDownloadTriggerRequest)          Binary         1     O

  NOTE 1: profileMetadata is the data object StoreMetadataRequest defined in section 5.5.3 (function "ES8+.StoreMetadata"); smdpSigned2, smdpSignature2 and smdpCertificate are data objects defined in section 5.7.5 (function "ES10b.PrepareDownload") of SGP.22 [4]. They SHALL be returned as encoded data objects including the tags defined for them in the StoreMetadataRequest/PrepareDownloadRequest data object.
  --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

11.: AuthenticateClient Additional Output Data

The error codes returned by ESipa.AuthenticateClient SHALL be the same as those of ES9+’.AuthenticateClient with the following additions:

-pprNotAllowed – indicates PPRs in Profile Metadata are not allowed by the Rules Authorisation Table.

5.14.4 Function (ESipa): TransferEimPackage

Related Procedures: eIM Package injection

Function Provider Entity: IPA

Description:

This function is used by the eIM to transfer single eIM Package to the IPA.

On reception of the function call:

-In case the eIM Package contains an eUICC Package (EuiccPackageRequest), the IPA SHALL:

-Call the "ES10b.LoadEuiccPackage" function of the ISD-R with its relevant input data,

-collect the eUICC Package execution result from the eUICC to notify the eIM about the result of the operation,

-and in case the IPA detects that the eIM cannot be notified about the result of the eIM Package execution then the IPA SHOULD call the "ES10b.ProfileRollback" function (see section 5.9.16) of the ISD-R as defined in section 3.3.1. The response to the eIM Package execution SHALL be then collected again after the Rollback operation.

NOTE: In case the IPA detects that the eIM cannot be notified about the result, the IPA can retry notifying the eIM at a later stage prior to calling the function “ES10b.ProfileRollback”.

-If the IPA sends Notifications together with the eUICC Package Result in the eIM Package Result and if the eUICC Package contains PSMO(s): retrieve pending Notifications by calling ES10b.RetrieveNotificationsList and, if a non-empty list of pending Notifications, include the list of pending Notifications (RetrieveNotificationsListResponse as defined in SGP.22 [4]) after the signed eUICC Package Result in the eIM Package. In case of an IPA with IPA Capability minimizeEsipaBytes, the IPA SHOULD include each Notification in the list in compact format as described in section 5.14.7.

-In case the eIM Package contains a request for IPA and/or eUICC data (IpaEuiccDataRequest) the IPA SHALL collect the requested data and return the IpaEuiccDataResponse structure.

-In case the eIM Package contains a Profile download trigger request (ProfileDownloadTriggerRequest), the IPA SHALL:

-Parse ProfileDownloadTriggerRequest to obtain any necessary data needed for the Profile download (e.g., an Activation Code).

-If the ProfileDownloadTriggerRequest indicates direct Profile download, the IPA SHALL return the eimPackageReceived structure.

-If the ProfileDownloadTriggerRequest indicates indirect Profile download, the IPA MAY return the eimPackageReceived structure.

NOTE: After sending ProfileDownloadTriggerRequest indicating indirect Profile download to the IPA, the eIM expects either eimPackageReceived structure followed by the ESipa.InitiateAuthentication function call or directly the ESipa.InitiateAuthentication function call. In the latter case successful reception of the ProfileDownloadTriggerRequest is implicit.

-Proceed with the suitable Profile download and installation procedure as described in section 3.2.

-In case the eIM Package contains the EimAcknowledgements structure with one or more sequence numbers of Notifications and/or eUICC Package Results, the IPA SHALL:

-Return the eimPackageReceived structure.

-For each sequence number, call the ES10b.RemoveNotificationFromList function where the eUICC deletes the Notification/eUICC Package Result identified by SequenceNumber from its memory.

This function SHALL return one of the following:

-A 'Function execution status' with 'Executed-Success' indicating that the eIM Package has been successfully executed and an eIM Package Result is generated.

-A 'Function execution status' indicating 'Failed' with a status code as defined in section 5.2.6 or a specific status code as defined in the following table.

Additional input data:

  ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
  Input data name                                                                                                                                                                                               Description                                                                           Type       No.      MOC
  ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------- ---------- -------- ------
  EuiccPackageRequest                                                                                                                                                                                           The eUICC Package Request                                                             Binary     1        C⁽¹⁾

  IpaEuiccDataRequest                                                                                                                                                                                           The request for IPA and/or eUICC data                                                 Binary     1        C⁽¹⁾

  ProfileDownloadTriggerRequest                                                                                                                                                                                 The request for IPA to trigger profile download                                       Binary     1        C⁽¹⁾

  EimAcknowledgements                                                                                                                                                                                           Sequence number(s) of Notifications and/or eUICC Package Results to be acknowledged   Binary     1        C⁽¹⁾

  NOTE 1: The eIM Package SHALL either contain an EuiccPackageRequest data object, an IpaEuiccDataRequest data object, ProfileDownloadTriggerRequest data object, or an EimAcknowledgements data object or a.
  ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

12.: TransferEimPackage Additional Input Data

Additional Output data:

Output data name

Description

Type

No.

MOC

EuiccPackageResult

The result of eUICC Package processing

Binary

1

C⁽¹⁾

IpaEuiccDataResponse

The response containing requested IPA and/or eUICC data

Binary

1

C⁽¹⁾

RetrieveNotificationsListResponse

List of pending Notifications

Binary

1

C^((1,2))

NOTE 1: The eIM Package Result MAY contain either an EuiccPackageResult data object, an EuiccPackageResult data object concatenated with a RetrieveNotificationsListResponse data object, or an IpaEuiccDataResponse data object, or a simple acknowledgement that the eIM Package was successfully received (eimPackageReceived).

NOTE 2: The RetrieveNotificationsListResponse data object, if included, SHALL be sent together with an EuiccPackageResult in the same eIM Package Result.

13.: TransferEimPackage Additional Output Data

5.14.5 Function (ESipa): GetEimPackage

Related Procedures: eIM Package retrieval

Function Provider Entity: eIM

Description:

This function is used by the IPA to retrieve an eIM Package.

The IPA provides the EID as an input to the function call.

The IPA MAY notify the eIM that one or several changes occurred in the eUICC (e.g. list of Profiles, Profiles states, …). In that case, the eIM SHOULD update its information about the eUICC.

NOTE : In case multiple eIMs are associated to the eUICC, an eIM might not be aware of changes triggered by another eIM. Whenever the IPA would connect to a different eIM than the one who has triggered those changes, it could include a hint for the eIM to retrieve updated information from the eUICC.

The IPA MAY include the identity of the last PLMN the IoT Device registered to, in order for the eIM to detect a roaming situation.

On reception of the function call the eIM SHALL:

-Check if there is any eIM Package available for the eUICC identified by the EID.

-If so, the eIM SHALL return a single eIM Package. If multiple eIM Packages are pending for the eUICC, it is eIM implementation-specific to select one of the pending eIM Packages.

-Otherwise, the eIM SHALL return a status code "EID – Unavailable".

NOTE: In case the IPA detects that the eIM cannot be notified about the result, the IPA can retry notifying the eIM at a later stage prior to calling the function “ES10b.ProfileRollback”.

The eIM MAY perform additional operations, which are out of scope of this specification.

This function SHALL return one of the following:

-A 'Function execution status' with 'Executed-Success' indicating that an eIM Package has been successfully identified.

-A 'Function execution status' indicating 'Failed' with a status code as defined in section 5.2.6 or a specific status code as defined in the following table.

Additional input data:

  -----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
  Input data name     Description                                                                                                                     Type         No.        MOC
  ------------------- ------------------------------------------------------------------------------------------------------------------------------- ------------ ---------- -------
  Eid                 The EID of the eUICC for which the eIM Package SHALL be retrieved                                                               EID          1          M

  NotifyStateChange   Notification to the eIM that it SHOULD update its information about the eUICC (e.g. list of Profiles, Profile states...)        (empty)      1          O

  RPLMN               Identifier of the last Registered PLMN (RPLMN), as defined in 3GPP TS 23.122 [19] and coded as defined in 3GPP TS 24.008 [22]   Binary       1          O
  -----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

14.: GetEimPackage Additional Input Data

Additional output data:

  ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
  Output data name                                                                                                               Description                                       Type       No.     MOC
  ------------------------------------------------------------------------------------------------------------------------------ ------------------------------------------------- ---------- ------- ------
  EuiccPackageRequest                                                                                                            The eUICC Package Request                         Binary     1       C⁽¹⁾

  IpaEuiccDataRequest                                                                                                            The request for IPA and/or eUICC data             Binary     1       C⁽¹⁾

  ProfileDownloadTriggerRequest                                                                                                  The request for IPA to trigger profile download   Binary     1       C⁽¹⁾

  NOTE 1: Either one and only one of EuiccPackageRequest, IpaEuiccDataRequest or ProfileDownloadTriggerRequest can be present.
  ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

15.: GetEimPackage Additional Output Data

Specific Status Codes

Subject

Code

Subject

Reason

code

Reason

Description

8.1.1

EID

3.7

Unavailable

No pending eIM Package for the EID.

16.: GetEimPackage Additional Output Data

5.14.6 Function (ESipa): ProvideEimPackageResult

Related Procedures: eIM Package Retrieval

Function Provider Entity: eIM

Description:

This function is used by the IPA to deliver an eIM Package Result optionally including one or more Notifications to the eIM in the same function call.

On reception of the function call the eIM SHALL:

-Process the eIM Package Result. For that, the eIM SHALL:

-If the eIM Package Result contains EuiccPackageResult (possibly within ePRAndNotifications data object):

-Verify the eUICC signature using PK.EUICC.ECDSA of the eUICC. If the signature is invalid, the eIM SHALL discard the input.

-Check if the sequence number of the EuiccPackageResult is greater than the expected sequence number of the eUICC. If not, the eIM SHALL discard the input.

-Manage the eIM Packages pending for the eUICC.

-Update the expected sequence number of the eUICC to the received sequence number.

-If the eIM Package Result contains IpaEuiccDataResponse:

-Store the received IPA and/or eUICC information for future use.

-If the eIM Package Result contains a notificationList data object within ePRAndNotifications:

-If the notificationList contains compact format of Notification(s), restore the Notification(s) in notificationList by using the data already available to the eIM.

-Forward the (restored) Notifications to the corresponding Notification Receiver(s).

-If the eIM Package Result contains profileDownloadTriggerResult or eimPackageError:

-Manage the eIM Packages pending for the eUICC.

-Return the sequence numbers of the eUICC Package Result and optionally Notifications that were processed (including discarded results) and/or forwarded above.

The eIM MAY perform additional operations, which are out of scope of this specification.

This function SHALL return one of the following:

-A 'Function execution status' with 'Executed-Success' indicating that the eIM Package Result has been successfully delivered.

-A 'Function execution status' indicating 'Failed' with a status code as defined in section 5.2.6 or a specific status code as defined in the following table.

Additional input data:

Input data name

Description

Type

No.

MOC

EuiccPackageResult

The result of eUICC Package processing

Binary

1

C⁽¹⁾

IpaEuiccDataResponse

The response containing requested IPA and/or eUICC data

Binary

1

C⁽¹⁾

RetrieveNotificationsListResponse

List of pending Notifications

Binary

1

C⁽²⁾

NOTE 1: Either one and only one of EuiccPackageResult or IpaEuiccDataResponse can be present.

NOTE 2: RetrieveNotificationsListResponse can be present if and only if EuiccPackageResults present.

17.: ProvideEimPackageResult Additional Input Data

Additional output data:

  ------------------------------------------------------------------------------------------------------------------------------------------------
  Output data name      Description                                                                                  Type        No.       MOC
  --------------------- -------------------------------------------------------------------------------------------- ----------- --------- -------
  EimAcknowledgements   Sequence number(s) of eUICC Package Result and/or Notification(s) acknowledged by the eIM.   Binary      1         O

  ------------------------------------------------------------------------------------------------------------------------------------------------

18.: ProvideEimPackageResult Additional Output Data

Specific Status Codes

Subject

Code

Subject

Reason

code

Reason

Description

19.: ProvideEimPackageResult Specific Status Codes

5.14.7 Function (ESipa): HandleNotification

Related Procedures: Profile Download and Installation, eIM Package Retrieval

Function Provider Entity: eIM

Description:

This function SHALL be called by the IPA to notify the eIM and/or SM-DP+ that a Profile has been successfully installed on the eUICC or that a profile has been successfully enabled, disabled, or deleted on the eUICC. This function MAY also be used to notify the eIM that a Profile has been successfully installed on the eUICC by sending either a ProfileInstallationResult Notification or a ProfileDownloadTriggerResult.

In the context of Indirect Profile Download and if the Notification is a ProfileInstallationResult, this function is correlated to a previous execution of an ESipa.GetBoundProfilePackage through a TransactionID delivered by the SM-DP+.

On reception of this function call, the eIM SHALL:

-If the function call contains a pendingNotification data object:

-If the pendingNotification contains compact format of Notification, restore the Notification by using the data already available to the eIM.

-Forward the (restored) Notification to the corresponding Notification Receiver.

-If the function call contains a provideEimPackageResult data object: process the eIM Package Result. For that, the eIM SHALL:

-If the eIM Package Result contains EuiccPackageResult:

-Verify the eUICC signature using PK.EUICC.ECDSA of the eUICC. If the signature is invalid, the eIM SHALL discard the input.

-Check if the sequence number of the EuiccPackageResult is greater than the expected sequence number of the eUICC. If not, the eIM SHALL discard the input.

-Manage the eIM Packages pending for the eUICC.

-Update the expected sequence number of the eUICC to the received sequence number.

-If the eIM Package Result contains IpaEuiccDataResponse:

-Store the received IPA and/or eUICC information for future use.

-If the eIM Package Result contains profileDownloadTriggerResult or eimPackageError:

-Manage the eIM Packages pending for the eUICC.

The eIM MAY perform additional operations, which are out of scope of this specification.

Additional Input Data:

Input data name

Description

Type

No.

MOC

pendingNotification

PendingNotification data object as defined in section 5.7.10 of SGP.22 extended with compactProfileInstallationResult and compactOtherSignedNotification (see structures below).

Binary⁽¹⁾

1

O

provideEimPackageResult

ProvideEimPackageResult as defined in section 6.3.2.7.

Binary^((2,3))

1

C

NOTE 1: pendingNotification SHALL be provided as an encoded PendingNotification data object.

NOTE 2: In the context of this function call, the provideEimPackageResult data object SHALL NOT contain ePRAndNotifications.

NOTE 3: Either only one of pendingNotification or provideEimPackageResult SHALL be present.

20.: HandleNotification Additional Input Data

Compact format of Notifications

This specification extends the pendingNotification data object defined in section 5.6.4 of SGP.22 [4] with compact formats according to the below ASN.1 structure. The compact format reduces the number of bytes transmitted over ESipa.

An IPA with IPA Capability minimizeEsipaBytes SHOULD re-encode ProfileInstallationResult and OtherSignedNotification into CompactProfileInstallationResult and CompactOtherSignedNotification, respectively, where the eUICC signature is kept unchanged.

Before calling the ES9+’.HandleNotification function, an eIM receiving compact format of Notifications SHALL restore the pendingNotification by using information already available at the eIM (e.g., StoreMetadataRequest (e.g., from BoundProfilePackage), serverSigned1, serverCertificate/smdpCertificate, euiccCertificate, and eumCertificate, etc.).

ASN.1 definitions
-- ASN1START

PendingNotification ::= CHOICE {

profileInstallationResult [55] ProfileInstallationResult, -- tag 'BF37'

otherSignedNotification OtherSignedNotification,

compactProfileInstallationResult [0] CompactProfileInstallationResult,

compactOtherSignedNotification [1] CompactOtherSignedNotification

}

ProfileInstallationResult ::= [55] SEQUENCE { -- Tag 'BF37'

profileInstallationResultData [39] ProfileInstallationResultData,

euiccSignPIR EuiccSignPIR

}

CompactProfileInstallationResult ::= SEQUENCE {

compactProfileInstallationResultData [0] CompactProfileInstallationResultData,

euiccSignPIR EuiccSignPIR

}

CompactProfileInstallationResultData ::= SEQUENCE {

transactionId [0] TransactionId, -- The TransactionID generated by the SM-DP+

seqNumber INTEGER,

iccidPresent BOOLEAN DEFAULT TRUE,

compactFinalResult [2] CHOICE {

compactSuccessResult CompactSuccessResult,

errorResult ErrorResult

}

}

CompactSuccessResult ::= SEQUENCE {

compactAid [APPLICATION 15] OCTET STRING (SIZE (2)), -- Byte 14 and 15 of ISD-P AID

simaResponse OCTET STRING OPTIONAL -- MUST be present if the simaResponse value (EUICCResponse) is different from the 9-byte value ‘30 07 A0 05 30 03 80 01 00’ representing success

}

CompactOtherSignedNotification ::= SEQUENCE {

tbsOtherNotification NotificationMetadata,

euiccNotificationSignature [APPLICATION 55] OCTET STRING -- eUICC signature of tbsOtherNotification, Tag '5F37'

}

-- ASN1STOP

5.14.8 Function (ESipa): CancelSession

Related Procedures: Profile Download and Installation

Function Provider Entity: eIM

Description:

This function SHALL be called by the IPA to request the cancellation of an on-going RSP session. This decision MAY originate from the eIM, or IPA based on where the failure occurred. The eIM MAY return error codes in ESipa.AuthenticateClient and ESipa.GetBoundProfilePackage that triggers IPA to cancel the session.

This function is correlated to a previous execution of an ESipa.AuthenticateClient or ESipa.GetBoundProfilePackage through a TransactionID delivered by the SM-DP+.

On reception of this function call, the eIM SHALL call the ES9+’.CancelSession function based on the received input data. The input parameters of this function are identical to the those of ES9+.CancelSession defined in section 5.6.5 of SGP.22 [4]. However, the cancelSessionResponse is extended according to the below ASN.1 structure where a compactCancelSessionResponseOk is added. An IPA with IPA Capability minimizeEsipaBytes SHOULD re-encode a cancelSessionResponse with cancelSessionResponseOk received from eUICC into a cancelSessionResponse with compactCancelSessionResponseOk in order to reduce the number of bytes to transmit to the eIM. Before calling the ES9+’.CancelSession function, an eIM that receives a cancelSessionResponse from an IPA with IPA Capability minimizeEsipaBytes SHALL restore the cancelSessionResponse prepared by the eUICC based on the received cancelSessionResponse and data already available to the eIM (transactionId (e.g., from serverSigned1) and serverCertificate/smdpCertificate).

Additional Input Data:

  -----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
  Input data name                                                                                    Description                                                                                                                                                                                                                                           Type           No.   MOC
  -------------------------------------------------------------------------------------------------- ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- -------------- ----- -----
  transactionId                                                                                      Transaction ID as generated by the SM-DP+ (section 3.1.1.4 of SGP.22 [4]).                                                                                                                                                                            Binary[1-16]   1     M

  cancelSessionResponse                                                                              CancelSessionResponse data object defined in section 5.7.14 of SGP.22 extended with compactCancelSessionResponseOk (see structure below). IPA retrieves authenticateServerResponse from the eUICC by calling "ES10b.CancelSession" (section 5.9.9).   Binary⁽¹⁾      1     M

  NOTE 1: cancelSessionResponse SHALL be provided as an encoded CancelSessionResponse data object.
  -----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

21.: CancelSession Additional Input Data

ASN.1 definitions
-- ASN1START

CancelSessionResponse ::= [65] CHOICE { -- Tag 'BF41'

cancelSessionResponseOk CancelSessionResponseOk,

cancelSessionResponseError INTEGER {invalidTransactionId(5), undefinedError(127)},

compactCancelSessionResponseOk CompactCancelSessionResponseOk

}

CompactCancelSessionResponseOk ::= SEQUENCE {

compactEuiccCancelSessionSigned CompactEuiccCancelSessionSigned, -- Compact version of euiccCancelSessionSigned

euiccCancelSessionSignature [APPLICATION 55] OCTET STRING -- tag 5F37 signature on euiccCancelSessionSigned

}

CompactEuiccCancelSessionSigned ::= SEQUENCE {

reason CancelSessionReason OPTIONAL

}

-- ASN1STOP

The eIM SHALL forward the status/error code of ES9+’.CancelSession as the status/error code of ESipa.CancelSession.

6 Interface Binding

This section defines how to use HTTP with TLS as the transport layer to exchange ES2+, ES9+, ES9+’, ES11, ES11’, ES12, and ESipa function requests and responses.

This section also defines how to use CoAP with DTLS as the transport layer to exchange ESipa function requests and responses.

For the ES2+, ES9+, ES9+’, ES11 and ES11’, the interface binding as described in section 6 of SGP.22 [4] SHALL be used; where for ES9+ and ES11, IPA plays the role of the LPA and for ES9+’ and ES11’ eIM plays the role of the LPA.

For ESipa, the interface binding when using HTTP with TLS and CoAP with DTLS are described in section 6.1 and section 6.2, respectively. This interface binding leverages either the ASN.1 function binding described in section 6.3 of this specification, or the JSON function binding described in section 6.4 of this specification. The ASN.1 function binding MAY also be leveraged by other protocols such as LwM2M (see Annex B) used in the communication between eIM and IPA.

6.1 ESipa interface binding over HTTP

The ESipa interface binding over HTTP SHALL follow the interface binding over HTTP in SGP.22 [4] section 6 relevant for the ES9+ interface with the following exceptions:

-TLS requirements SHALL follow section 2.6.3 in this document.

-"X-Admin-Protocol" header field SHALL be set to v2.1.0 in both HTTP request and HTTP response.

NOTE: this value provides interoperability with previous versions of SGP.22 [4].

-The ASN.1 message definition SHALL follow section 6.1.1 below replacing section 6.6.1 of SGP.22 [4] and the ASN.1 list of functions SHALL follow section 6.3 replacing section 6.6.2 of SGP.22 [4].

-A JSON binding SHALL be indicated by the value "application/json;charset=UTF-8", which also mandates UTF-8 encoding. The JSON message definition SHALL follow section 6.1.2 below.

6.1.1 ASN.1 message definition

The Function requester and the Function provider SHALL exchange the DER encoded ASN.1 objects in HTTP messages as follows.

HTTP Request SHALL have the following format:

HTTP POST gsma/rsp2/asn1 HTTP/1.1

Host: <Server Address>

User-Agent: <User Agent>

X-Admin-Protocol: gsma/rsp/v<x.y.z>

Content-Type: application/x-gsma-rsp-asn1

Content-Length: <Length of the ASN.1 EsipaMessageFromIpaToEim>

<ASN.1 EsipaMessageFromIpaToEim>

Any function execution request using ASN.1 binding SHALL be sent to the generic HTTP path 'gsma/rsp2/asn1'.

The body part of the HTTP POST request SHALL contain one EsipaMessageFromIpaToEim data object as defined in section 6.3.

HTTP Response SHALL have the following format:

HTTP/1.1 <HTTP Status Code>

X-Admin-Protocol: gsma/rsp/v<x.y.z>

Content-Type: application/x-gsma-rsp-asn1

Content-Length: <Length of the ASN.1 EsipaMessageFromEimToIpa>

<ASN.1 EsipaMessageFromEimToIpa>

The body part of the HTTP POST response SHALL contain one EsipaMessageFromEimToIpa data object as defined in section 6.3.

6.1.2 JSON message definition

The Function requester and the Function provider SHALL exchange the JSON objects in HTTP messages as follows.

HTTP Request SHALL have the following format:

HTTP POST <HTTP Path> HTTP/1.1

Host: <Server Address>

User-Agent: <User Agent>

X-Admin-Protocol: gsma/rsp/v<x.y.z>

Content-Type: application/json;charset=UTF-8

Content-Length: <Length of the JSON requestBody>

<JSON requestBody>

The <HTTP Path> is used to indicate which function execution is requested by the HTTP client. The list of defined <HTTP Path> and <JSON requestBody> are described in section 6.4.1.

HTTP Response SHALL have the following format:

HTTP/1.1 <HTTP Status Code>

X-Admin-Protocol: gsma/rsp/v<x.y.z>

Content-Type: application/json;charset=UTF-8

Content-Length: <Length of the JSON responseBody>

<JSON responseBody>

The list of defined <HTTP Path> and <JSON requestBody> are described in section 6.4.1.

6.2 ESipa interface binding over CoAP

The ESipa interface binding over CoAP SHALL follow the ESipa interface binding over HTTP described in section 6.1. The ASN.1 function binding SHALL be used. In the ASN.1 message binding in section 6.1.1, the HTTP headers SHALL be translated to CoAP options as described by RFC 7252 [7].

-The <HTTP Path> SHALL be converted to a sequence of corresponding Uri-Path options.

-The <Server Address> SHALL be converted to a Uri-Host option if necessary. If the server address is simply the IP address of the eIM server, this option SHALL be omitted.

-The <User Agent> SHALL NOT be included in the CoAP transport layer.

-The Content-Type SHALL be omitted. The content type to be used is determined by the Uri-Path options, and the response type SHALL be equivalent to the request type.

-Content-Length is not relevant to CoAP and SHALL be omitted. If the payload is too large to be sent in a single CoAP UDP packet, then block-wise CoAP SHALL be used as defined in RFC 7959 [12]. In this case the CoAP Request-Tag option SHALL be used as defined in RFC 9175 [13], in order to associate the separate blocks of a CoAP request together.

NOTE: It is RECOMMENDED to send CoAP/UDP messages in a single UDP Packet.

-The CoAP Echo Option SHALL be used to enable lightweight freshness verifications as defined in RFC 9175 [13]

6.3 ESipa function binding in ASN.1

This section presents the ASN.1 function binding for ESipa. The ASN.1 structures for ESipa messages between IPA and eIM, that are used in 6.1.1 and 6.2 respectively for the HTTP and CoAP interface bindings to select between ESipa functions, are presented in section 6.3.1. The request and response ASN.1 structures for each ESipa function are presented in sections 6.3.2 and 6.3.3. The ASN.1 structures in this section MAY be leveraged by other interface bindings, see for example Annex B.

Both eIM and IPAd SHALL support the ASN.1 encoding/decoding attribute "EXTENSIBILITY IMPLIED". This is useful when processing data definitions from a newer specification and to help for interoperability between entities of various vendors (to handle proprietary tag values).

6.3.1 ASN.1 structures for ESipa messages between IPA and eIM

The EsipaMessageFromIpaToEim and EsipaMessageFromEimToIpa ASN.1 structures that contain the ESipa function requests and responses are defined as follows:

ASN.1 definitions
-- ASN1START

EsipaMessageFromIpaToEim ::= CHOICE {

initiateAuthenticationRequestEsipa [57] InitiateAuthenticationRequestEsipa, -- Tag 'BF39'

authenticateClientRequestEsipa [59] AuthenticateClientRequestEsipa, -- Tag 'BF3B'

getBoundProfilePackageRequestEsipa [58] GetBoundProfilePackageRequestEsipa, -- Tag 'BF3A'

cancelSessionRequestEsipa [65] CancelSessionRequestEsipa, -- Tag 'BF41'

handleNotificationEsipa [61] HandleNotificationEsipa, -- Tag 'BF3D'

transferEimPackageResponse [78] TransferEimPackageResponse, -- Tag 'BF4E'

getEimPackageRequest [79] GetEimPackageRequest, -- Tag 'BF4F'

provideEimPackageResult [80] ProvideEimPackageResult -- Tag 'BF50'

}

EsipaMessageFromEimToIpa ::= CHOICE {

initiateAuthenticationResponseEsipa [57] InitiateAuthenticationResponseEsipa, -- Tag 'BF39'

authenticateClientResponseEsipa [59] AuthenticateClientResponseEsipa, -- Tag 'BF3B'

getBoundProfilePackageResponseEsipa [58] GetBoundProfilePackageResponseEsipa, -- Tag 'BF3A'

cancelSessionResponseEsipa [65] CancelSessionResponseEsipa, -- Tag 'BF41'

transferEimPackageRequest [78] TransferEimPackageRequest, -- Tag 'BF4E'

getEimPackageResponse [79] GetEimPackageResponse, -- Tag 'BF4F'

provideEimPackageResultResponse [80] ProvideEimPackageResultResponse -- Tag 'BF50'

}

-- ASN1STOP

6.3.2 ESipa functions provided by eIM

6.3.2.1 ESipa.InitiateAuthentication

The request and response structures of ESipa.InitiateAuthentication are defined as follows:

ASN.1 definitions
-- ASN1START

InitiateAuthenticationRequestEsipa ::= [57] SEQUENCE { -- Tag 'BF39'

euiccChallenge [1] Octet16, -- random eUICC challenge

smdpAddress [3] UTF8String OPTIONAL,

euiccInfo1 EUICCInfo1 OPTIONAL

}

InitiateAuthenticationResponseEsipa ::= [57] CHOICE { -- Tag 'BF39'

initiateAuthenticationOkEsipa InitiateAuthenticationOkEsipa,

initiateAuthenticationErrorEsipa INTEGER {

invalidDpAddress(1),

euiccVersionNotSupportedByDp(2),

ciPKIdNotSupported(3),

smdpAddressMismatch(50),

smdpOidMismatch(51)

}

}

InitiateAuthenticationOkEsipa ::= SEQUENCE {

transactionId [0] TransactionId OPTIONAL, -- The TransactionID generated by the SM-DP+

serverSigned1 ServerSigned1, -- Signed information

serverSignature1 [APPLICATION 55] OCTET STRING, -- Server Sign1, Tag '5F37'

euiccCiPKIdToBeUsed OCTET STRING, -- Key identifier (possibly truncated) of the CI Public Key to be used as required by ES10b.AuthenticateServer

serverCertificate Certificate,

matchingId UTF8String OPTIONAL,

ctxParams1 [2] CtxParams1 OPTIONAL

}

-- ASN1STOP

6.3.2.2 ESipa.AuthenticateClient

The request and response structures of ESipa.AuthenticateClient are defined as follows:

ASN.1 definitions
-- ASN1START

AuthenticateClientRequestEsipa ::= [59] SEQUENCE { -- Tag 'BF3B'

transactionId [0] TransactionId,

authenticateServerResponse [56] AuthenticateServerResponse -- This is the response from ES10b.AuthenticateServer, possibly in compact format

}

AuthenticateClientResponseEsipa ::= [59] CHOICE { -- Tag 'BF3B'

authenticateClientOkDPEsipa AuthenticateClientOkDPEsipa,

authenticateClientOkDSEsipa AuthenticateClientOkDSEsipa,

authenticateClientErrorEsipa INTEGER {

eumCertificateInvalid(1),

eumCertificateExpired(2),

euiccCertificateInvalid(3),

euiccCertificateExpired(4),

euiccSignatureInvalid(5),

matchingIdRefused(6),

eidMismatch(7),

noEligibleProfile(8),

ciPKUnknown(9),

invalidTransactionId(10),

insufficientMemory(11),

pprNotAllowed(50),

eventIdUnknown(56),

undefinedError(127)

}

}

AuthenticateClientOkDPEsipa ::= SEQUENCE {

transactionId [0] TransactionId OPTIONAL,

profileMetaData [37] StoreMetadataRequest OPTIONAL,

smdpSigned2 SmdpSigned2, -- Signed information

smdpSignature2 [APPLICATION 55] OCTET STRING, -- Tag '5F37'

smdpCertificate Certificate, -- CERT.DPpb.ECDSA

hashCc Octet32 OPTIONAL -- Hash of confirmation code

}

AuthenticateClientOkDSEsipa ::= SEQUENCE {

transactionId [0] TransactionId,

profileDownloadTrigger [84] ProfileDownloadTriggerRequest OPTIONAL -- Tag 'BF54'

}

-- ASN1STOP

6.3.2.3 ESipa.GetBoundProfilePackage

The request and response structures of ESipa.GetBoundProfilePackage are defined as follows:

ASN.1 definitions
-- ASN1START

GetBoundProfilePackageRequestEsipa ::= [58] SEQUENCE { -- Tag 'BF3A'

transactionId [0] TransactionId,

prepareDownloadResponse [33] PrepareDownloadResponse -- This is the response from ES10b.PrepareDownload, possibly in compact format

}

GetBoundProfilePackageResponseEsipa ::= [58] CHOICE { -- Tag 'BF3A'

getBoundProfilePackageOkEsipa GetBoundProfilePackageOkEsipa,

getBoundProfilePackageErrorEsipa INTEGER {

euiccSignatureInvalid(1),

confirmationCodeMissing(2),

confirmationCodeRefused(3),

confirmationCodeRetriesExceeded(4),

bppRebindingRefused(5),

downloadOrderExpired(6),

profileMetadataMismatch(50),

invalidTransactionId(95),

undefinedError(127)

}

}

GetBoundProfilePackageOkEsipa ::= SEQUENCE {

transactionId [0] TransactionId OPTIONAL,

boundProfilePackage [54] BoundProfilePackage

}

-- ASN1STOP

6.3.2.4 ESipa.HandleNotification

The request structure of ESipa.HandleNotification is defined as follows (there is no response structure defined):

ASN.1 definitions
-- ASN1START

HandleNotificationEsipa ::= [61] CHOICE { -- Tag 'BF3D'

pendingNotification PendingNotification, -- A Notification to be delivered to a Notification Receiver, possibly in compact format

provideEimPackageResult ProvideEimPackageResult

}

-- ASN1STOP

6.3.2.5 ESipa.CancelSession

The request and response structures of ESipa.CancelSession are defined as follows:

ASN.1 definitions
-- ASN1START

CancelSessionRequestEsipa ::= [65] SEQUENCE { -- Tag 'BF41'

transactionId TransactionId,

cancelSessionResponse CancelSessionResponse -- This is the response from ES10b. CancelSession function, possibly in compact format

}

CancelSessionResponseEsipa ::= [65] CHOICE { -- Tag 'BF41'

cancelSessionOk CancelSessionOk,

cancelSessionError INTEGER {

invalidTransactionId(1),

euiccSignatureInvalid(2),

undefinedError(127)

}

}

CancelSessionOk ::= SEQUENCE { -- This function has no output data

}

-- ASN1STOP

6.3.2.6 ESipa.GetEimPackage

The request and response structures of ESipa.GetEimPackage are defined as follows:

ASN.1 definitions
-- ASN1START

GetEimPackageRequest ::= [79] SEQUENCE { -- Tag 'BF4F'

eidValue [APPLICATION 26] Octet16, -- Tag '5A'

notifyStateChange [0] NULL OPTIONAL, -- Notification to the eIM that it should update its information about the eUICC (e.g. list of profiles, profile states...)

rPLMN [1] OCTET STRING (SIZE(3)) OPTIONAL -- MCC and MNC of the last registered PLMN, coded as defined in 3GPP TS 24.008 [22]

}

GetEimPackageResponse ::= [79] CHOICE { -- Tag 'BF4F'

euiccPackageRequest [81] EuiccPackageRequest, -- Tag 'BF51'

ipaEuiccDataRequest [82] IpaEuiccDataRequest, -- Tag 'BF52'

profileDownloadTriggerRequest [84] ProfileDownloadTriggerRequest, -- Tag 'BF54'

eimPackageError INTEGER {

noEimPackageAvailable(1),

undefinedError(127)

}

}

-- ASN1STOP

6.3.2.7 ESipa.ProvideEimPackageResult

The request and response structures of ESipa.ProvideEimPackageResult are defined as follows:

ASN.1 definitions
-- ASN1START

ProvideEimPackageResult ::= [80] CHOICE { -- Tag 'BF50'

euiccPackageResult [81] EuiccPackageResult, -- Tag 'BF51'

ePRAndNotifications SEQUENCE {

euiccPackageResult [81] EuiccPackageResult, -- Tag 'BF51'

notificationList [43] RetrieveNotificationsListResponse -- Tag 'BF2B'

},

ipaEuiccDataResponse [82] IpaEuiccDataResponse, -- Tag 'BF52'

profileDownloadTriggerResult [84] ProfileDownloadTriggerResult, -- Tag 'BF54'

eimPackageError INTEGER {

invalidPackageFormat(1),

unknownPackage(2),

undefinedError(127)

}

}

ProvideEimPackageResultResponse ::= [80] SEQUENCE { -- Tag 'BF50'

eimAcknowledgements [83] EimAcknowledgements OPTIONAL -- Tag 'BF53'

}

-- ASN1STOP

6.3.3 ESipa functions provided by IPA

6.3.3.1 ESipa.TransferEimPackage

The request and response structures of ESipa.TransferEimPackage are defined as follows:

ASN.1 definitions
-- ASN1START

TransferEimPackageRequest ::= [78] CHOICE { -- Tag 'BF4E'

euiccPackageRequest [81] EuiccPackageRequest, -- Tag 'BF51'

ipaEuiccDataRequest [82] IpaEuiccDataRequest, -- Tag 'BF52'

eimAcknowledgements [83] EimAcknowledgements, -- Tag 'BF53'

profileDownloadTriggerRequest [84] ProfileDownloadTriggerRequest -- Tag 'BF54'

}

TransferEimPackageResponse ::= [78] CHOICE { -- Tag 'BF4E'

euiccPackageResult [81] EuiccPackageResult, -- Tag 'BF51'

ePRAndNotifications SEQUENCE {

euiccPackageResult [81] EuiccPackageResult, -- Tag 'BF51'

notificationList [43] RetrieveNotificationsListResponse -- Tag 'BF2B'

},

ipaEuiccDataResponse [82] IpaEuiccDataResponse, -- Tag 'BF52'

eimPackageReceived NULL,

eimPackageError INTEGER {

invalidPackageFormat(1),

unknownPackage(2),

undefinedError(127)

}

}

-- ASN1STOP

6.4 ESipa function binding in JSON

"format": "base64": unless specified otherwise below, the value of a JSON field of this format SHALL contain the base64 coding defined in RFC 4648 [71] of the DER encoded ASN.1 data object (including its tag and length fields), referenced in "description".

NOTE In most of the cases, the ASN.1 data object is defined in ES10x request/responses. Otherwise, the 'description' of the base64 field references the section where the ASN.1 type is specified.

"pattern": "^[0-9,A-F]{n,m}$": specifies the hexadecimal representation of the data referred to in "description".

6.4.1 List of functions

  -----------------------------------------------------------------------------------
  Function                  Path                                       MXP
  ------------------------- ------------------------------------------ --------------
  InitiateAuthentication    /gsma/rsp2/esipa/initiateAuthentication    Synchronous

  AuthenticateClient        /gsma/rsp2/esipa/authenticateClient        Synchronous

  GetBoundProfilePackage    /gsma/rsp2/esipa/getBoundProfilePackage    Synchronous

  TransferEimPackage        /gsma/rsp2/esipa/transferEimPackage        Synchronous

  GetEimPackage             /gsma/rsp2/esipa/getEimPackage             Synchronous

  ProvideEimPackageResult   /gsma/rsp2/esipa/provideEimPackageResult   Synchronous

  HandleNotification        /gsma/rsp2/esipa/handleNotification        Notification

  CancelSession             /gsma/rsp2/esipa/cancelSession             Synchronous
  -----------------------------------------------------------------------------------

22.: List of functions

6.4.1.1 ESipa.InitiateAuthentication

Hereunder is the definition of the JSON schema for the <JSON requestBody> corresponding to the "ESipa.InitiateAuthentication" function:

{

"type": "object",

"properties": {

"euiccChallenge": {

"type": "string",

"format": "base64",

"description": "base64 encoding of the value field of the eUICC Challenge as defined in SGP.22 [4] (without tag and length fields)"

},

"euiccInfo1": {

"type": "string",

"format": "base64",

"description": "euiccinfo1 as defined in SGP.22 [4]"

},

"smdpAddress": {

"type": "string",

"description": "SM-DP+ Address as defined in SGP.22 [4]"

}

},

"required": ["euiccChallenge"]

}

Hereunder is the definition of the JSON schema for the <JSON responseBody> corresponding to the "ESipa.InitiateAuthentication" function:

{

"type": "object",

"properties": {

"transactionId": {

"type": "string",

"pattern": "^[0-9,A-F]{2,32}$",

"description": "TransactionID as defined in SGP.22 [4]"

},

"serverSigned1": {

"type": "string",

"format": "base64",

"description": "The data object as required by ES10b.AuthenticateServer"

},

"serverSignature1": {

"type": "string",

"format": "base64",

"description": "The signature as required by ES10b.AuthenticateServer"

},

"euiccCiPKIdToBeUsed": {

"type": "string",

"format": "base64",

"description": "The CI Public Key to be used as required by ES10b.AuthenticateServer"

},

"serverCertificate": {

"type": "string",

"format": "base64",

"description": "The server Certificate as required by ES10b.AuthenticateServer"

},

"matchingId": {

"type": "string",

"description": "MatchingID as defined in SGP.22 [4]"

},

"ctxParams1": {

"type": "string",

"format": "base64",

"description": "ctxParams1 as required by ES10b.AuthenticateServer"

}

},

"required": ["serverSigned1", "serverSignature1", "serverCertificate"]

}

NOTE: IPA is in charge of transcoding the transactionId.

6.4.1.2 ESipa.AuthenticateClient

Hereunder is the definition of the JSON schema for the <JSON requestBody> corresponding to the "ESipa.AuthenticateClient" function:

{

"type": "object",

"properties": {

"transactionId": {

"type": "string",

"pattern": "^[0-9,A-F]{2,32}$",

"description": "TransactionID as defined in SGP.22 [4]"

},

"authenticateServerResponse": {

"type": "string",

"format": "base64",

"description": "AuthenticateServerResponse as provided by ES10b.AuthenticateServer, possibly in compact format"

}

},

"required": ["transactionId", "authenticateServerResponse"]

}

Hereunder is the definition of the JSON schema for the <JSON responseBody> corresponding to the "ESipa.AuthenticateClient" function:

{

"type": "object",

"properties": {

"transactionId": {

"type": "string",

"pattern": "^[0-9,A-F]{2,32}$",

"description": "TransactionID as defined in SGP.22 [4]"

},

"profileMetadata": {

"type": "string",

"format": "base64",

"description": "StoreMetadataRequest as defined SGP.22 [4]"

},

"smdpSigned2": {

"type": "string",

"format": "base64",

"description": "SmdpSigned2 encoded data object"

},

"smdpSignature2": {

"type": "string",

"format": "base64",

"description": "SM-DP+ signature as required by ES10b.PrepareDownload"

},

"smdpCertificate": {

"type": "string",

"format": "base64",

"description": "The Certificate as required by ES10b.PrepareDownload"

},

"hashCc": {

"type": "string",

"format": "base64",

"description": "hashCc as required by ES10b.PrepareDownload"

}

},

"required" : [" smdpSigned2", "smdpSignature2", "smdpCertificate"]

}

6.4.1.3 ESipa.GetBoundProfilePackage

Hereunder is the definition of the JSON schema for the <JSON requestBody> corresponding to the "ESipa.GetBoundProfilePackage" function:

{

"type": "object",

"properties": {

"transactionId": {

"type": "string",

"pattern": "^[0-9,A-F]{2,32}$",

"description": "TransactionID as defined in SGP.22 [4]"

},

"prepareDownloadResponse": {

"type": "string",

"format": "base64",

"description": "PrepareDownloadResponse as provided by ES10b.PrepareDownload, possibly in compact format"

}

},

"required": ["transactionId", "prepareDownloadResponse"]

}

Hereunder is the definition of the JSON schema for the <JSON responseBody> corresponding to the "ESipa.GetBoundProfilePackage" function:

{

"type": "object",

"properties": {

"transactionId": {

"type": "string",

"pattern": "^[0-9,A-F]{2,32}$",

"description": "TransactionID as defined in SGP.22 [4]"

},

"boundProfilePackage": {

"type": "string",

"format": "base64",

"description": "Bound Profile Package required by ES10b.LoadBoundProfilePackage"

}

},

"required": ["transactionId", "boundProfilePackage"]

}

6.4.1.4 ESipa.TransferEimPackage

Hereunder is the definition of the JSON schema for the <JSON requestBody> corresponding to the "ESipa.TransferEimPackage" function:

{

"type": "object",

"oneOf": [

{

"properties": {

"euiccPackageRequest": {

"type": "string",

"format": "base64",

"description": "EuiccPackageRequest as defined in section 2.11.1.1.1"

}

},

"required": ["euiccPackageRequest"]

},{

"properties": {

"ipaEuiccDataRequest": {

"type": "string",

"format": "base64",

"description": "IpaEuiccDataRequest as defined in section 2.11.1.2"

}

},

"required": ["ipaEuiccDataRequest"]

},{

"properties": {

"eimAcknowledgements": {

"type": "string",

"format": "base64",

"description": "EimAcknowledgements as defined in section 2.11.1.4"

}

},

"required": ["eimAcknowledgements"]

},{

"properties": {

"profileDownloadTriggerRequest": {

"type": "string",

"format": "base64",

"description": "ProfileDownloadTriggerRequest as defined in section 2.11.2.3"

}

},

"required": ["profileDownloadTriggerRequest"]

}

]

}

Hereunder is the definition of the JSON schema for the <JSON responseBody> corresponding to the "ESipa.TransferEimPackage" function:

{

"type": "object",

"oneOf": [

{

"properties": {

"euiccPackageResult": {

"type": "string",

"format": "base64",

"description": "EuiccPackageResult as defined in section 2.11.2.1"

}

},

"required": ["euiccPackageResult"]

},{

"properties": {

"ePRAndNotifications": {

"type": "object",

"properties": {

"euiccPackageResult": {

"type": "string",

"format": "base64",

"description": "EuiccPackageResult as defined in section 2.11.2.1"

},

"notificationList": {

"type": "string",

"format": "base64",

"description": "RetrieveNotificationsListResponse as defined in SGP.22 [4] section 5.7.9"

}

},

"required": ["euiccPackageResult", "notificationList"]

}

},

"required": ["ePRAndNotifications"]

},{

"properties": {

"ipaEuiccDataResponse": {

"type": "string",

"format": "base64",

"description": "IpaEuiccDataResponse as defined in section 2.11.2.2"

}

},

"required": ["ipaEuiccDataResponse"]

},{

"properties": {

"eimPackageError": {

"type": "integer",

"description": "eimPackageError code as defined in section 6.3.3.1"

}

},

"required": ["eimPackageError"]

}

]

}

6.4.1.5 ESipa.GetEimPackage

Hereunder is the definition of the JSON schema for the <JSON requestBody> corresponding to the "ESipa.GetEimPackage" function:

{

"type": "object",

"properties": {

"eidValue": {

"type" : "string",

"pattern" : "^[0-9]{32}$",

"description" : "EID as described in SGP.22 [4]"

},

"notifyStateChange": {

"type" : "boolean",

"description" : "Notification to the eIM that it should update its information about the eUICC (e.g. list of profiles, profile states...)"

},

"rPlmn": {

"type" : "string",

"format" : "base64",

"description" : "MCC and MNC of the last registered PLMN, coded as defined in 3GPP TS 24.008 [22]"

}

},

"required": ["eidValue"]

}

Hereunder is the definition of the JSON schema for the <JSON responseBody> corresponding to the "ESipa.GetEimPackage" function:

{

"type": "object",

"oneOf": [

{

"properties": {

"euiccPackageRequest": {

"type": "string",

"format": "base64",

"description": "EuiccPackageRequest as defined in section 2.11.1.1.2"

}

},

"required": ["euiccPackageRequest"]

},{

"properties": {

"ipaEuiccDataRequest": {

"type": "string",

"format": "base64",

"description": "IpaEuiccDataRequest as defined in section 2.11.1.2"

}

},

"required": ["ipaEuiccDataRequest"]

},{

"properties": {

"profileDownloadTriggerRequest": {

"type": "string",

"format": "base64",

"description": "ProfileDownloadTriggerRequest as defined in section 2.11.2.3"

}

},

"required": ["profileDownloadTriggerRequest"]

},{

"properties": {

"eimPackageError": {

"type": "integer",

"description": "eimPackageError code as defined in section 6.3.2.6"

}

},

"required": ["eimPackageError"]

}

]

}

6.4.1.6 ESipa.ProvideEimPackageResult

Hereunder is the definition of the JSON schema for the <JSON requestBody> corresponding to the "ESipa.ProvideEimPackageResult" function:

{

"type": "object",

"properties": {

"provideEimPackageResult": {

"type": "string",

"format": "base64",

"description": "ProvideEimPackageResult as defined in section 6.3.2.7"

}

},

"required": ["provideEimPackageResult"]}

Hereunder is the definition of the JSON schema for the <JSON responseBody> corresponding to the "ESipa.ProvideEimPackageResult" function:

{

"type": "object",

"properties": {

"eimAcknowledgements": {

"type": "string",

"format": "base64",

"description": "EimAcknowledgements as defined in section 2.11.1.4"

}

},

"required": ["eimAcknowledgements"]

}

6.4.1.7 ESipa.HandleNotification

Hereunder is the definition of the JSON schema for the <JSON requestBody> corresponding to the "ESipa.HandleNotification" function:

{

"type" : "object",

"oneOf": [

{

"properties" : {

"pendingNotification" : {

"type" : "string",

"format" : "base64",

"description" : "PendingNotification as defined in section 5.14.7"

}

},

"required" : ["pendingNotification"]

},{

"properties": {

"provideEimPackageResult": {

"type": "string",

"format": "base64",

"description": "ProvideEimPackageResult as defined in section 6.3.2.7"

}

},

"required": ["provideEimPackageResult"]

}

]

}

6.4.1.8 ESipa.CancelSession

Hereunder is the definition of the JSON schema for the <JSON requestBody> corresponding to the "ESipa.CancelSession" function:

{

"type": "object",

"properties" : {

"transactionId" : {

"type" : "string",

"pattern" : "^[0-9,A-F]{2,32}$",

"description" : "TransactionID as defined in SGP.22 [4]"

},

"cancelSessionResponse" : {

"type" : "string",

"format" : "base64",

"description" : "CancelSessionResponse as provided by ES10b.CancelSession"

}

},

"required" : ["transactionId", "cancelSessionResponse"]

}

"ESipa.CancelSession" function has no <JSON responseBody>.

A IoT Device Requirements (Normative)

A.1 Functional IoT Device Requirements

Functional

IoT Device

Requirements

No.

Requirement

IoTDEV1

The IoT Device SHALL support the following proactive command:

REFRESH Command (At least mode 4 – “UICC Reset”), as defined in ETSI TS 102 223 [5].

23.: IoT Device requirements

B Mapping of procedures to IoT protocols (Informative)

B.1 LwM2M

In case of LwM2M implementation of the ESipa it is expected that the eIM is a component that is integrated into Device Management platform and the IPA is a component that is part of the Device Management Client functionality in the IoT Device. For efficient message transfer LwM2M 1.1 and higher protocol version is RECOMMENDED.

B.1.1 Secure connection

A secure connection needs to be ensured so that ESipa security requirements are fulfilled. Specifically, LwM2M unsecured mode is not used unless appropriate lower-layer provided security is used, that the LwM2M server is in the same security realm as the element terminating the lower-layer security between it and the IoT Device, and it is ensured that only elements within the same security realm can access the unsecured traffic.

B.1.2 LwM2M object

The following object is proposed to handle the ESipa implementation in LwM2M.

Object definition

  ----------------------------------------------------------------------------------------------
  Name                     Object ID                        Object Version   LWM2M Version
  ------------------------ -------------------------------- ---------------- -------------------
  eSIM IoT                 3443                             1.0              1.0

  Object URN                                                Instances        Mandatory

  urn:oma:lwm2m:ext:3443                                    Single           Optional
  ----------------------------------------------------------------------------------------------

24.: Object Definition

Resource definition

ID

Name

Operations

Instances

Mandatory

Type

Range or Enumeration

Units

Description

0

State

R

Single

Mandatory

Integer

Status

0 – ready to receive eIM message

1 – not able to receive eIM message

Note: In case value is >0 then writing to resource 2 SHALL NOT be possible

1

EID

R

Single

Mandatory

String

EID of the eUICC that is target of the object

2

eIM message

W

Single

Mandatory

Opaque

the message from eIM to IPA. The message SHALL be in the ASN.1 DER format defined in section 6.3.1

3

IPA message

R

Single

Mandatory

Opaque

The message from IPA to eIM. The message SHALL be in the ASN.1 DER format defined in section 6.3.1

4

Clear IPA message

E

Single

Mandatory

In case Send or Confirmable Notifications is not used to deliver IPA message then execution of this resource will confirm delivery of the IPA message and clear the resource 3.

25.: Resource Definition

B.1.3 Procedures

For purpose of simplification, the IPA in this section will represent LwM2M client integrating also IPA functionality and eIM will represent LwM2M server integrating also eIM functionality.

B.1.3.1 Transferring messages between eIM and IPA (LwM2M)

Following procedure is an example generic implementation of transfer of an eIM message to IPA and IPA message to eIM using LwM2M. This example uses functions introduced in LwM2M version 1.1.

Diagram source (PlantUML)
@startuml

hide footbox

skinparam sequenceMessageAlign center

skinparam sequenceArrowFontSize 11

skinparam noteFontSize 11

skinparam monochrome true

skinparam lifelinestrategy solid

participant "<b>eIM" as EIM

participant "<b>IPA" as IPA

participant "<b>eUICC" as E

rnote over EIM, IPA : [IPA is LwM2M-registered to eIM and secure connection is established]

EIM -> IPA : [1] Write eIM message to /x/0/2

IPA -> EIM : [2] Write success

IPA -> E : [3] Deliver the eIM message to the eUICC

E -> E : [4] Process the eIM message

E -> IPA : [5] Deliver the eIM message processing result to the IPA

IPA -> EIM : [6] Send IPA message /x/0/3

EIM -> IPA : [7] Send success

@enduml

[Graphical user interface, application Description automatically generated with medium confidence]

29.Transferring messages between eIM and IPA (LwM2M)

Start Conditions:

The LwM2M client in IPA is registered to the LwM2M server in eIM and secure connection between the client and the server is established.

Procedure:

1.The eIM sends Write request with the eIM message in resource /x/0/2

2.The IPA confirms delivery of the Write request

3.The IPA provides to the eUICC the message from eIM with provided parameters.

4.The eUICC processes the eIM message.

5.The eUICC returns the result of message processing to the IPA.

6.The IPA uses the Send request to deliver the IPA message in resource /x/0/3

7.The eIM confirms delivery of the Send message and the content of resource x/0/3 is cleared in the IPA

B.2 MQTT

In case of an MQTT implementation of the ESipa, it is expected that the eIM is a component that is integrated into a device management platform and the IPA is a component that is part of the device management client functionality in the IoT Device. For efficient message transfer MQTT v5.0 [23] or higher is RECOMMENDED.

NOTE: MQTT is running over TCP.

B.2.1 Mapping of MQTT Roles

It is expected that the eIM and the MQTT broker are located within the same hosting system and inside the same security realm. For the IPA to connect to the MQTT broker, the address of the eIM and MQTT broker MUST be the same.

Both the entity hosting the eIM and the IoT Device implementing the IPA will act as clients of the MQTT broker and both will be able to publish and subscribe to topics.

B.2.2 Secure connection

The security of the MQTTs connection between the IoT Device implementing the IPA and the MQTT broker is ensured by using TLS transport security with certificate authentication. The security of the MQTT application level uses the same certificate for authenticating the client to the MQTT broker. MQTT broker uses port 8883 as default MQTT secure port.

NOTE: MQTT v5.0 [23] uses TLS 1.2 as defined in RFC 5246 [8].

B.2.3 Description

The following topics are proposed to handle the ESipa implementation in MQTT. The topics are focused on transferring eIM Packages and eIM Package Results between eIM and IPA and direct Profile download is assumed.

  -------------------------------------------------------------------------------------------------------------------------
  Name          Topic                       Description
  ------------- --------------------------- -------------------------------------------------------------------------------
  eIM message   eim-message-to-ipa /{eid}   Topic used by the eIM to publish an EsipaMessageFromEimToIpa to an IoT Device

  IPA message   ipa-message-to-eim          Topic used by the IPA to publish an EsipaMessageFromIpaToEim to the eIM
  -------------------------------------------------------------------------------------------------------------------------

26.: eIM and IPA Message

eIM Message

Publisher: eIM

Subscriber: IPA of the matching eID

Usage: This topic is used by the eIM to publish the requests to the IPA. The IPA will be subscribed and receive all the requests in order to process them.

URL: /eim-message-to-ipa/{eid}

  ------------------------------------------------------------------------------------------------------------------------------
  Parameter                     Type     Description
  ----------------------------- -------- ---------------------------------------------------------------------------------------
  EsipaMessageFromEimToIpaeIM   Binary   EsipaMessageFromEimToIpa following the ASN.1 structure as described in section 6.3.1.

  ------------------------------------------------------------------------------------------------------------------------------

27.: EsipaMessageFromEimToIpaeIM

IPA message

Publisher: IPA

Subscriber: eIM

Usage: This topic is used by the IPA to publish the responses to the eIM requests. The eIM will be subscribed and receive all the responses from the processed requests.

URL: /ipa-message-to-eim

  ---------------------------------------------------------------------------------------------------------------------------
  Parameter                  Type     Description
  -------------------------- -------- ---------------------------------------------------------------------------------------
  EsipaMessageFromIpaToEim   Binary   EsipaMessageFromIpaToEim following the ASN.1 structure as described in section 6.3.1.

  ---------------------------------------------------------------------------------------------------------------------------

28.:EsipaMessageFromIpaToeIM

B.2.4 Procedures

Connection

Diagram source (PlantUML)
@startuml

hide footbox

skinparam sequenceMessageAlign center

skinparam sequenceArrowFontSize 11

skinparam noteFontSize 11

skinparam monochrome true

skinparam lifelinestrategy solid

participant "<b>eIM" as EIM

participant "<b>MQTT broker" as BROKER

participant "<b>IPA" as IPA

participant "<b>eUICC" as E

rnote over EIM, BROKER : [1] [TLS session establishment]

EIM -> BROKER: [2] Subscribe to /ipa-message-to-eim

EIM -> BROKER: [3] Subscribe to /eim-package-sync

rnote over IPA : [IoT Device internal trigger (e.g., power on, reconnection, etc.)]

alt IoT Device power on

IPA -> E: [4] Get eid

activate E

E --> IPA: eid

deactivate E

end

rnote over IPA, BROKER : [5] [TLS session establishment]

IPA -> BROKER: [6] Subscribe to /eim-message-to-ipa/{eid}

@enduml

[Diagram Description automatically generated with medium confidence]

30.Connection

1.Establish TLS session between the eIM and MQTT broker

2.eIM subscribes to the /ipa-message-to-eim topic to be able to receive IPA responses

3.eIM subscribes to the /eim-package-sync topic

4.IPA reads the eUICC EID

5.TLS session is established between the IPA and the MQTT broker

6.IPA subscribes to the /eim-message-to-ipa /<eid> to receive the eIM requests

Communication

Diagram source (PlantUML)
@startuml

hide footbox

skinparam sequenceMessageAlign center

skinparam sequenceArrowFontSize 11

skinparam noteFontSize 11

skinparam monochrome true

skinparam lifelinestrategy solid

participant "<b>eIM" as EIM

participant "<b>MQTT broker" as BROKER

participant "<b>IPA" as IPA

participant "<b>eUICC" as E

rnote over IPA: [IoT Device internal trigger]

IPA -> BROKER: [1] Publish /eim-package-sync

BROKER --> EIM: [1] Message arrived

EIM->EIM: [2] Register discovered device

rnote over IPA: [Operation to be sent to the IoT Device]

EIM->BROKER: [3]Publish /eim-message-to-ipa /<eid>

BROKER-->IPA: [4] Message arrived

IPA->E: [5] Received Request

E->E: [6] Process request

E-->IPA: [7] Response

IPA->BROKER: [8] Publish /ipa-message-to-eim

BROKER->EIM: [9] Message arrived

@enduml

[Diagram Description automatically generated]

31.Communication

1.IPA publishes in /eim-package-sync

2.eIM receives the published message

3.eIM registers that the IoT Device with received eid is available

4.eIM publishes the eimPackageRequest to /eim-message-to-ipa

5.The IPA receives the published request

6.The IPA forwards the message to the eUICC

7.The eUICC processes the request and prepares the eimPackageResponse

8.The eUICC sends the response to the IPA

9.The IPA publishes the response in /ipa-message-to-eim

10.The eIM receives the response

C Document Management (Informative)

C.1 Document History

Version

Date

CR

Approval Authority

Editor / Company

V1.0

19^(th) April

CR001R01 – Overview

CR002R01 – Scope

CR003R01 – Document Purpose

CR004R01 – Intended Audience

CR005R01 – Conventions

CR006R01 – General Architecture

CR007R00 – Roles

CR008R01 – Interfaces

CR0012R01 – eUICC Architecture diagram

CR0009R05 – eUICC Architecture

CR0010R03 - Security Overview

CR0014R00 - ESIMWG7_52_AP2 - LPA within SGP.22 vs IPA within SGP.32

CR0017R02 - Introduction of procedures

CR0018R01 – eUICC Initialisation

CR0024R04 - ESipa procedure (1/2): eIM Command Retrieval

CR0025R03 - ESipa procedure (2/2): eIM Command Injection

CR0015R09 - Direct Profile Download

CR0026R01 - Add PSMO generic description

CR0030R01 - Implementation of ESipa interface

CR0031R00 - Communication between EIM and IPA

CR0034R02 – Add definition of PSMO structures

CR0016R10 Indirect Profile Download Procedure

CR0023R03 CR_PSMO enable procedure

CR0035R02 Add generic PSMO Package download and execution

CR0037R00 Delete Event Registration Editor’s notes

CR0038R00 Removal of some editor's notes

CR0040R00 Remove continueonfailure

CR0042R01 Add PSMO Functions

CR0045R01 - REFRESH Mandatory for IoT Devices

CR0049R01 Introduction of the ES8+ Interface

CR0050R01 Introduction Certificate Revocation

CR0051R01 Indirect Profile Download functions

CR0011R07 – Esipa

CR0041R01 - eIM Configuration Description

CR0052R00 - Deletion of editor note in section 2.4.1

CR0060R01 - Add eIM Package Description

CR0032R03 - Disable Profile Procedure Pt1

CR0033R05 - Delete Profile Procedure Pt1

CR0043R01 - Function unsigned addition of eIM Configuration Data

CR0044R01 – Function unsigned wipe of all eIM Configuration Data

CR0046R01 - Signed eIM Configuration Procedure

CR0048R04 - Introduction of the Secure Connection Establishment

CR0053R03 - Indirect Profile Download Flow Additions

CR0056R01 - Correction of generic PSMO Package download and execution

CR0057R01 – Correction of PSMO enable procedure

CR0058R02 – Add eIM Configuration Operations to PSMO Package structure

CR0059R04 - LwM2M implementation of ESipa

CR0061R02 - Improve the security for PSMO Package download

CR0063R01 - Add IPA Capabilities

CR0065R00 - Editor’s note clean-up

CR0066R00 - Delete continueOnFailure Editor's note

CR0067R00 - Interface name correction

CR0071R00 - Removal of Editor's notes agreed by eSIMWG7

CR0072R00 - Editorial change to IPA capabilities

CR0073R01 - Editorial change to section "Secure Connection Establishment"

CR0054R03 – Indirect Profile Download Functions Additions

CR0055R03 – Indirect Profile Download Missing Functions

CR0074R01 – Add unsigned PSMO Package Result

CR0075R00 - Correction of diagram for Enable Procedure

CR0076R00 - Correction of diagram for generic PSMO Package Download and Execution Procedure

CR0077R01 - Resolution of editor’s note

CR0078R00 - Remove ISD-P AID from procedures

CR0079R02 – Loss of Connectivity After Disable

CR0080R00 – Clean-up of Definition of Terms

CR0081R00 – Restructuring of PSMO package

CR0082R00 – Rename PSMO Package into eUICC Package

CR0084R01 – Removal of section 2.5 and 2.8

CR0085R01 – ES2, ES6 and ES12 interfaces

Editorial corrections to Draft

CR0064R03 - Add support for eIM to request IPA and eUICC data

CR0086R01 - Rules for EimConfigurationData’s optional fields (ESIMWG7_61_AP22)

CR0090R01 - Further changes related to PSMO package becoming eUICC Package

CR0091R02 - Further changes in procedures related to PSMO package becoming eUICC Package

CR0092R00 - Restructuring sections in Section 3

CR0099R00 - Clarification Notification Handling Indirect Profile Download

CR0087R01 - LoadPSMOPackage change to Load eUICC Package

CR0089R00 - Reference status code section and removal of editor’s notes

CR0094R01 - Correcting ListEimResponse

CR104R00 - Diagram update in Delete procedure

CR0088R01 - Completion of sections 5.1 and 5.2

CR0101R02 - CoAP binding

CR0103R01 - Simplification of eIM Package transferring procedures

CR0105R00 - Correction of eUICC Package definition

CR0106R00 - ESIMWG7_62_AP5: Editorial Change Section 3.5 eIM Configuration

CR0107R01 - eIM Configuration Update Procedure

CR0108R02 - List eIM Procedure

CR0109R01 - LwM2M alignment with CoAP and HTTP binding

CR0112R00 - Correction of Roll-Back behaviour

CR0113R00 - Clean up editor note in section 2.12

CR0114R00 - Change from  Unsigned eIM Configuration to  Unsigned eCO

CR0093R03 – Security considerations of LwM2M-based ESipa

CR0097R03 – Add notification handling to generic eUICC Package download and execution flow

CR0100R03 – Clarification on certificate revocation

CR0110R02 – Interface binding

CR0111R02 – Adding MQTT as underlaying protocol

CR0115R01 – Correction of eUICC Package definition

CR0116R01 – eIM Certificate Editor’s note

CR0117R00 – Remove editor’s note in Section 5.9.1

CR0118R03 – Resolution of editor’s note in functions

CR0120R01 – RSP session error handling

CR0121R01 – Indirect profile download flow updates

CR0122R00 – Resolution of Editor’s Note in 2.10.2

CR0128R00 – LwM2M ESipa object id

CR0129R01 – CR on how eIM gets the eUICC Certificate

CR0130R01 – Addition of algorithms and eIM certificate description

CR0125R01 - Direct Profile Download additional changes

CR0131R01 - Add ProfileDownloadTriggerRequest in section 3.2.3.2

CR0132R01 – Fix references

CR0133R01 – Clarification to GetEUICCData function

CR0134R01 - Clarification to eCO

editorial modifications and bugs fixing

CR0123R04 - Structure of eIM Package for profile triggering

CR0124R01 - Cancel session procedure for indirect profile download

CR0136R01 - Add information on retrieval of RAT

CR0142R01 - Correction to Direct Profile Download

CR0062R01 - eUICC for IoT Specific Information

CR0127R01 - Introduction of section 3 clarifying IPAd and IPAe

CR0147R01 - Editorial Corrections to section 2.4.x and 2.6.1

CR0137R01 - Reworking Notifications in eIM Package retrieval

CR0138R00 - Changing ASN.1 type of rollbackFlag from Boolean to NULL

CR0139R03 - Clarifying eCO procedures and functions via ES10

CR0144R00 - Correction to several functions

CR0146R00 - Corrections to signed addition of eIM data

CR0161R00 - Remove CoAP Option Number

CR0145R01 - Completion of Definition for eIM Package in 1.5

CR0149R00 - Fixing minor editorial mistakes in Annex B.2

CR0157R00 - Add description to ES11’

CR0159R00 - Add definition and abbreviation of RAT

CR0162R00 - Editorial changes in interface binding section

CR0163R00 - Consistency of eIM Package response and eIM Package Result

CR0164R00 - Removal of redundant steps 5 and 6 in Direct Profile Download section 3.2.3.1 (AP ESIMWG7_63_1_AP01)

CR0119R04 - Clean-up of eUICC Package request and response

CR0126R03 - Reworking ES10 function to reset eIM Config Data

CR0135R03 - Clean-up of ASN.1 definitions

CR0151R02 - Clarification that ES10c is not supported

CR0152R01 - Clarification to the combinations of PSMOs in eUICCPackageRequest

CR0153R00 - Clarification to the mode of the REFRESH proactive command

CR0156R00 - Clarification that ASN.1 EXTENSIBILITY IMPLIED encoding can be used over ESipa

CR0158R00 - Clarification on certificate format

CR0165R02 - Clarifications for eIM certificate profile

CR0167R01 - Change to eUICCInfo2 for SGP.32

CR0168R00 - Editorial changes in Enable Profile procedure

CR0170R01 - Changes related to eIM Package Result and Notifications

CR0154R03 - Corrections to PSM procedures

CR0166R02 - Automatic enabling of profile using default SM-DP+

CR0171R01 - Editorial changes to clarify ESpsmo

CR0173R00 - Corrections in Annex B.2

CR0174R01 - Rename IPA capability eimActivationCodeParsing

CR0140R00 - JSON binding of ESipa interface

CR0155R06 - Addition of ES10b.ProfileRollBack Procedure

CR0160R03 - Interoperability in transferring eIM Package

CR0169R01 - Clarification of MQTT Security in MQTT

CR0175R00 - Add Notification handling related to automatic Profile enabling

CR0176R01 - Add configuration of automatic profile enabling via eIM and IPA

CR0177R00 - IPA accepting TLS certificates issued by Public CA

CR0178R00 - Update the reference to SGP.31 v1.1

CR0179R01 - Editorial Refinements for Section 1.5 (Part I)

CR0180R00 - Editorial Refinements for Section 1.5 (Part II)

CR0184R01 - Clarification of SM-DS procedures

CR0185R00 - About eIM Package Execution Model and Atomicity

CR0187R00 - Update eUICC Info 2

CR0188R01 - Add indirect Event retrieval procedure

CR0148R06 - ES10 interface to retrieve eIM Configuration Data

CR0172R05 - Add IPA Capability on connectivity

CR0181R00 - Miscellaneous editorial corrections

CR0183R01 - Guidelines on eIM ID encoding

CR0186R01 - eIM selection for Package Retrieval

CR0189R02 - eIM Connection capabilities

CR0190R04 - MQTT clarifications

CR0191R01 - Cleaning up GetEimPackage and TransferEimPackage

CR0193R02 - Several corrections to ASN.1

CR0194R02 - Clarification on SM-DS use

CR0195R00 - Clarification on Automatic Enable using SM-DS

CR0196R01 - Correction of Function Provider Role

CR0198R01 - eIM Config Data in ES10b.AddInitialEim

CR0182R01 - Editorial modifications to section 3.3.1

CR0200R04 - Update of eIM Package retrieval logic

CR0202R01 - ES10b.GetEID and ES10b.GetCerts

CR0203R00 - Clarifying X-Admin-Protocol

CR0204R00 - Add note on TLS/DTLS requirements for communication with eIM

CR0205R00 - listProfileInfo during a Profile state change

CR0206R00 - No ASN.1 extensibility for IPAe

CR0207R01 - SGP.32 ASN.1 module

CR0208R01 - Align automatic Profile enabling with SGP.31

CR0209R00 - Assign ASN1 tags

CR0210R02 Include UML diagram for Direct Profile Download

CR0211R01 Removing description on IPA behaviour in ESipa.GetEimPackage function description

CR0212R02 Add CiPKId to IpaEuiccDataRequest

CR0213R01 Unsigned EuiccPackageResult error code when eIM signature is invalid

CR0215R03 - Update to SGP32 ASN1 module definition

CR0219R01 – Cleaning up Definitions

CR0221R02 - Atomicity of eUICC Package

CR0192R06 - Adding ProfileDownloadTriggerResult

CR0201R05 - Extension of GetEimPackage input data

CR0220R01 - Add key selection for eUICC Package Result

CR0222R01 - Editorial separation of PSMO and Eco

CR0224R00 - Align ASN.1 module OID with SGP.22 v2.5

CR0225R04 - Editorial corrections

CR0226R00 - Adding optional field: eimFqdn to EimConfigurationData

CR0197R14 - Preventing from Replay Attacks

CR0227R02 - Miscellaneous Corrections

CR0229R01 - Editorial change adding the definition of RPLMN

CR0230R01 - Aligning eimFqdn with new chapter structure

CR0233R02 - Corrections for compact Notification format

CR0234R00 - Clarifications for ESipa.TransferEimPackage including NULL response

CR0235R04 - Add eIM TLSDTLS Certificate in eIM Configuration Data

CR0238R01 - Corrections for ProfileDownloadTriggerResult

CR0241R01 - Moving Section on eIM Config data

CR0232R05 - Corrections for HandleNotification to cover EimPackageResult

CR0236R03 Misc Corrections

CR0237R03 Add eUICC Package result and notification retrieval

CR0238R04 Corrections for ProfileDownloadTriggerResult

CR0242R01 Add ESep functions in dedicated section

CR0243R00 Editorial Fix to Algorithms and Parameters for eIM Signing Key

CR0244R01 Clarification Interoperable profile

CR0245R01 Clarification Initialisation procedure

ISAG

Gloria Trujillo, GSMA (Editor)

26 May 2023

SGP.32 v1.0.1

04 July 2023

Fix problems on the ASN.1 structure.

GSMA

Other Information

  -----------------------------------------------------------------------
  Type                     Description
  ------------------------ ----------------------------------------------
  Document Owner           eSIM Group

  Editor / Company         Gloria Trujillo, GSMA
  -----------------------------------------------------------------------

It is our intention to provide a quality product for your use. If you find any errors or omissions, please contact us with your comments. You may notify us at [email protected]

Your comments or suggestions & questions are always welcome.

© GSM Association. Converted automatically from the published DOCX; layout, figures and tables may differ from the original. The authoritative version is the original: https://www.gsma.com/esim/wp-content/uploads/2023/05/SGP.32-1.0.1.docx.